added support for transport mode and (experimental!) BEET mode
[strongswan.git] / src / charon / encoding / payloads / notify_payload.h
1 /**
2 * @file notify_payload.h
3 *
4 * @brief Interface of notify_payload_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
10 * Copyright (C) 2005-2006 Martin Willi
11 * Copyright (C) 2005 Jan Hutter
12 * Hochschule fuer Technik Rapperswil
13 *
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2 of the License, or (at your
17 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
18 *
19 * This program is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
21 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 * for more details.
23 */
24
25
26 #ifndef NOTIFY_PAYLOAD_H_
27 #define NOTIFY_PAYLOAD_H_
28
29 typedef enum notify_type_t notify_type_t;
30 typedef struct notify_payload_t notify_payload_t;
31
32 #include <library.h>
33 #include <encoding/payloads/payload.h>
34 #include <encoding/payloads/proposal_substructure.h>
35 #include <utils/linked_list.h>
36
37 /**
38 * Notify payload length in bytes without any spi and notification data.
39 *
40 * @ingroup payloads
41 */
42 #define NOTIFY_PAYLOAD_HEADER_LENGTH 8
43
44 /**
45 * @brief Notify message types.
46 *
47 * See IKEv2 RFC 3.10.1.
48 *
49 * @ingroup payloads
50 */
51 enum notify_type_t {
52 /* notify error messages */
53 UNSUPPORTED_CRITICAL_PAYLOAD = 1,
54 INVALID_IKE_SPI = 4,
55 INVALID_MAJOR_VERSION = 5,
56 INVALID_SYNTAX = 7,
57 INVALID_MESSAGE_ID = 9,
58 INVALID_SPI = 11,
59 NO_PROPOSAL_CHOSEN = 14,
60 INVALID_KE_PAYLOAD = 17,
61 AUTHENTICATION_FAILED = 24,
62 SINGLE_PAIR_REQUIRED = 34,
63 NO_ADDITIONAL_SAS = 35,
64 INTERNAL_ADDRESS_FAILURE = 36,
65 FAILED_CP_REQUIRED = 37,
66 TS_UNACCEPTABLE = 38,
67 INVALID_SELECTORS = 39,
68 /* notify status messages */
69 INITIAL_CONTACT = 16384,
70 SET_WINDOW_SIZE = 16385,
71 ADDITIONAL_TS_POSSIBLE = 16386,
72 IPCOMP_SUPPORTED = 16387,
73 NAT_DETECTION_SOURCE_IP = 16388,
74 NAT_DETECTION_DESTINATION_IP = 16389,
75 COOKIE = 16390,
76 USE_TRANSPORT_MODE = 16391,
77 HTTP_CERT_LOOKUP_SUPPORTED = 16392,
78 REKEY_SA = 16393,
79 ESP_TFC_PADDING_NOT_SUPPORTED = 16394,
80 NON_FIRST_FRAGMENTS_ALSO = 16395,
81 /* mobike extension, RFC4555 */
82 MOBIKE_SUPPORTED = 16396,
83 ADDITIONAL_IP4_ADDRESS = 16397,
84 ADDITIONAL_IP6_ADDRESS = 16398,
85 NO_ADDITIONAL_ADDRESSES = 16399,
86 UPDATE_SA_ADDRESSES = 16400,
87 COOKIE2 = 16401,
88 NO_NATS_ALLOWED = 16402,
89 /* repeated authentication extension, RFC4478 */
90 AUTH_LIFETIME = 16403,
91 /* BEET mode, not even a draft yet. private use */
92 USE_BEET_MODE = 40960,
93 };
94
95 /**
96 * enum name for notify_type_t.
97 *
98 * @ingroup payloads
99 */
100 extern enum_name_t *notify_type_names;
101
102 /**
103 * @brief Class representing an IKEv2-Notify Payload.
104 *
105 * The Notify Payload format is described in Draft section 3.10.
106 *
107 * @b Constructors:
108 * - notify_payload_create()
109 * - notify_payload_create_from_protocol_and_type()
110 *
111 * @todo Build specified constructor/getter for notify's
112 *
113 * @ingroup payloads
114 */
115 struct notify_payload_t {
116 /**
117 * The payload_t interface.
118 */
119 payload_t payload_interface;
120
121 /**
122 * @brief Gets the protocol id of this payload.
123 *
124 * @param this calling notify_payload_t object
125 * @return protocol id of this payload
126 */
127 u_int8_t (*get_protocol_id) (notify_payload_t *this);
128
129 /**
130 * @brief Sets the protocol id of this payload.
131 *
132 * @param this calling notify_payload_t object
133 * @param protocol_id protocol id to set
134 */
135 void (*set_protocol_id) (notify_payload_t *this, u_int8_t protocol_id);
136
137 /**
138 * @brief Gets the notify message type of this payload.
139 *
140 * @param this calling notify_payload_t object
141 * @return notify message type of this payload
142 */
143 notify_type_t (*get_notify_type) (notify_payload_t *this);
144
145 /**
146 * @brief Sets notify message type of this payload.
147 *
148 * @param this calling notify_payload_t object
149 * @param type notify message type to set
150 */
151 void (*set_notify_type) (notify_payload_t *this, notify_type_t type);
152
153 /**
154 * @brief Returns the currently set spi of this payload.
155 *
156 * This is only valid for notifys with protocol AH|ESP
157 *
158 * @param this calling notify_payload_t object
159 * @return SPI value
160 */
161 u_int32_t (*get_spi) (notify_payload_t *this);
162
163 /**
164 * @brief Sets the spi of this payload.
165 *
166 * This is only valid for notifys with protocol AH|ESP
167 *
168 * @param this calling notify_payload_t object
169 * @param spi SPI value
170 */
171 void (*set_spi) (notify_payload_t *this, u_int32_t spi);
172
173 /**
174 * @brief Returns the currently set notification data of payload.
175 *
176 * @warning Returned data are not copied.
177 *
178 * @param this calling notify_payload_t object
179 * @return chunk_t pointing to the value
180 */
181 chunk_t (*get_notification_data) (notify_payload_t *this);
182
183 /**
184 * @brief Sets the notification data of this payload.
185 *
186 * @warning Value is getting copied.
187 *
188 * @param this calling notify_payload_t object
189 * @param notification_data chunk_t pointing to the value to set
190 */
191 void (*set_notification_data) (notify_payload_t *this, chunk_t notification_data);
192
193 /**
194 * @brief Destroys an notify_payload_t object.
195 *
196 * @param this notify_payload_t object to destroy
197 */
198 void (*destroy) (notify_payload_t *this);
199 };
200
201 /**
202 * @brief Creates an empty notify_payload_t object
203 *
204 * @return created notify_payload_t object
205 *
206 * @ingroup payloads
207 */
208 notify_payload_t *notify_payload_create(void);
209
210 /**
211 * @brief Creates an notify_payload_t object of specific type for specific protocol id.
212 *
213 * @param protocol_id protocol id (IKE, AH or ESP)
214 * @param type notify type (see notify_type_t)
215 * @return notify_payload_t object
216 *
217 * @ingroup payloads
218 */
219 notify_payload_t *notify_payload_create_from_protocol_and_type(protocol_id_t protocol_id, notify_type_t type);
220
221
222 #endif /*NOTIFY_PAYLOAD_H_*/