Add some additional IKEv1 notify types
[strongswan.git] / src / libcharon / encoding / payloads / notify_payload.h
1 /*
2 * Copyright (C) 2006-2008 Tobias Brunner
3 * Copyright (C) 2006 Daniel Roethlisberger
4 * Copyright (C) 2005-2006 Martin Willi
5 * Copyright (C) 2005 Jan Hutter
6 * Hochschule fuer Technik Rapperswil
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
17 */
18
19 /**
20 * @defgroup notify_payload notify_payload
21 * @{ @ingroup payloads
22 */
23
24 #ifndef NOTIFY_PAYLOAD_H_
25 #define NOTIFY_PAYLOAD_H_
26
27 typedef enum notify_type_t notify_type_t;
28 typedef struct notify_payload_t notify_payload_t;
29
30 #include <library.h>
31 #include <encoding/payloads/payload.h>
32 #include <encoding/payloads/proposal_substructure.h>
33 #include <utils/linked_list.h>
34
35 /**
36 * Notify message types for IKEv2, and a subset for IKEv1.
37 */
38 enum notify_type_t {
39 /* notify error messages */
40 UNSUPPORTED_CRITICAL_PAYLOAD = 1,
41 /* IKEv1 alias */
42 INVALID_PAYLOAD_TYPE = 1,
43 INVALID_IKE_SPI = 4,
44 INVALID_MAJOR_VERSION = 5,
45 INVALID_SYNTAX = 7,
46 /* IKEv1 alias */
47 INVALID_EXCHANGE_TYPE = 7,
48 INVALID_MESSAGE_ID = 9,
49 INVALID_SPI = 11,
50 NO_PROPOSAL_CHOSEN = 14,
51 /* IKEv1 only */
52 PAYLOAD_MALFORMED = 16,
53 INVALID_KE_PAYLOAD = 17,
54 /* IKEv1 alias */
55 INVALID_KEY_INFORMATION = 17,
56 /* IKEv1 only */
57 INVALID_ID_INFORMATION = 18,
58 INVALID_CERT_ENCODING = 19,
59 INVALID_CERTIFICATE = 20,
60 CERT_TYPE_UNSUPPORTED = 21,
61 INVALID_CERT_AUTHORITY = 22,
62 INVALID_HASH_INFORMATION = 23,
63 AUTHENTICATION_FAILED = 24,
64 SINGLE_PAIR_REQUIRED = 34,
65 NO_ADDITIONAL_SAS = 35,
66 INTERNAL_ADDRESS_FAILURE = 36,
67 FAILED_CP_REQUIRED = 37,
68 TS_UNACCEPTABLE = 38,
69 INVALID_SELECTORS = 39,
70 /* mobile extension, RFC 4555 */
71 UNACCEPTABLE_ADDRESSES = 40,
72 UNEXPECTED_NAT_DETECTED = 41,
73 /* mobile IPv6 bootstrapping, RFC 5026 */
74 USE_ASSIGNED_HoA = 42,
75 /* IKEv2 RFC 5996 */
76 TEMPORARY_FAILURE = 43,
77 CHILD_SA_NOT_FOUND = 44,
78
79 /* IKE-ME, private use */
80 ME_CONNECT_FAILED = 8192,
81
82 /* Windows error code */
83 MS_NOTIFY_STATUS = 12345,
84
85 /* notify status messages */
86 INITIAL_CONTACT = 16384,
87 SET_WINDOW_SIZE = 16385,
88 ADDITIONAL_TS_POSSIBLE = 16386,
89 IPCOMP_SUPPORTED = 16387,
90 NAT_DETECTION_SOURCE_IP = 16388,
91 NAT_DETECTION_DESTINATION_IP = 16389,
92 COOKIE = 16390,
93 USE_TRANSPORT_MODE = 16391,
94 HTTP_CERT_LOOKUP_SUPPORTED = 16392,
95 REKEY_SA = 16393,
96 ESP_TFC_PADDING_NOT_SUPPORTED = 16394,
97 NON_FIRST_FRAGMENTS_ALSO = 16395,
98 /* mobike extension, RFC4555 */
99 MOBIKE_SUPPORTED = 16396,
100 ADDITIONAL_IP4_ADDRESS = 16397,
101 ADDITIONAL_IP6_ADDRESS = 16398,
102 NO_ADDITIONAL_ADDRESSES = 16399,
103 UPDATE_SA_ADDRESSES = 16400,
104 COOKIE2 = 16401,
105 NO_NATS_ALLOWED = 16402,
106 /* repeated authentication extension, RFC4478 */
107 AUTH_LIFETIME = 16403,
108 /* multiple authentication exchanges, RFC 4739 */
109 MULTIPLE_AUTH_SUPPORTED = 16404,
110 ANOTHER_AUTH_FOLLOWS = 16405,
111 /* redirect mechanism, RFC 5685 */
112 REDIRECT_SUPPORTED = 16406,
113 REDIRECT = 16407,
114 REDIRECTED_FROM = 16408,
115 /* session resumption, RFC 5723 */
116 TICKET_LT_OPAQUE = 16409,
117 TICKET_REQUEST = 16410,
118 TICKET_ACK = 16411,
119 TICKET_NACK = 16412,
120 TICKET_OPAQUE = 16413,
121 /* IPv6 configuration, RFC 5739 */
122 LINK_ID = 16414,
123 /* wrapped esp, RFC 5840 */
124 USE_WESP_MODE = 16415,
125 /* robust header compression, RFC 5857 */
126 ROHC_SUPPORTED = 16416,
127 /* EAP-only authentication, RFC 5998 */
128 EAP_ONLY_AUTHENTICATION = 16417,
129 /* Childless initiation of IKEv2 SA, RFC 6023 */
130 CHILDLESS_IKEV2_SUPPORTED = 16418,
131 /* Quick crash detection for IKE, RFC 6290 */
132 QUICK_CRASH_DETECTION = 16419,
133 /* High availability of IKEv2/IPsec, RFC 6311 */
134 IKEV2_MESSAGE_ID_SYNC_SUPPORTED = 16420,
135 IKEV2_REPLAY_COUNTER_SYNC_SUPPORTED = 16421,
136 IKEV2_MESSAGE_ID_SYNC = 16422,
137 IPSEC_REPLAY_COUNTER_SYNC = 16423,
138 /* IKEv1 initial contact */
139 INITIAL_CONTACT_IKEV1 = 24578,
140 /* BEET mode, not even a draft yet. private use */
141 USE_BEET_MODE = 40961,
142 /* IKE-ME, private use */
143 ME_MEDIATION = 40962,
144 ME_ENDPOINT = 40963,
145 ME_CALLBACK = 40964,
146 ME_CONNECTID = 40965,
147 ME_CONNECTKEY = 40966,
148 ME_CONNECTAUTH = 40967,
149 ME_RESPONSE = 40968
150 };
151
152 /**
153 * enum name for notify_type_t.
154 */
155 extern enum_name_t *notify_type_names;
156
157 /**
158 * enum name for notify_type_t (shorter strings).
159 */
160 extern enum_name_t *notify_type_short_names;
161
162 /**
163 * Class representing an IKEv2-Notify Payload.
164 *
165 * The Notify Payload format is described in Draft section 3.10.
166 */
167 struct notify_payload_t {
168 /**
169 * The payload_t interface.
170 */
171 payload_t payload_interface;
172
173 /**
174 * Gets the protocol id of this payload.
175 *
176 * @return protocol id of this payload
177 */
178 u_int8_t (*get_protocol_id) (notify_payload_t *this);
179
180 /**
181 * Sets the protocol id of this payload.
182 *
183 * @param protocol_id protocol id to set
184 */
185 void (*set_protocol_id) (notify_payload_t *this, u_int8_t protocol_id);
186
187 /**
188 * Gets the notify message type of this payload.
189 *
190 * @return notify message type of this payload
191 */
192 notify_type_t (*get_notify_type) (notify_payload_t *this);
193
194 /**
195 * Sets notify message type of this payload.
196 *
197 * @param type notify message type to set
198 */
199 void (*set_notify_type) (notify_payload_t *this, notify_type_t type);
200
201 /**
202 * Returns the currently set spi of this payload.
203 *
204 * This is only valid for notifys with protocol AH|ESP
205 *
206 * @return SPI value
207 */
208 u_int32_t (*get_spi) (notify_payload_t *this);
209
210 /**
211 * Sets the spi of this payload.
212 *
213 * This is only valid for notifys with protocol AH|ESP
214 *
215 * @param spi SPI value
216 */
217 void (*set_spi) (notify_payload_t *this, u_int32_t spi);
218
219 /**
220 * Returns the currently set spi of this payload.
221 *
222 * This is only valid for notifys with protocol ISAKMP
223 *
224 * @return SPI value
225 */
226 chunk_t (*get_spi_data) (notify_payload_t *this);
227
228 /**
229 * Sets the spi of this payload.
230 *
231 * This is only valid for notifys with protocol ISAKMP
232 *
233 * @param spi SPI value
234 */
235 void (*set_spi_data) (notify_payload_t *this, chunk_t spi);
236
237 /**
238 * Returns the currently set notification data of payload.
239 *
240 * Returned data are not copied.
241 *
242 * @return chunk_t pointing to the value
243 */
244 chunk_t (*get_notification_data) (notify_payload_t *this);
245
246 /**
247 * Sets the notification data of this payload.
248 *
249 * @warning Value is getting copied.
250 *
251 * @param notification_data chunk_t pointing to the value to set
252 */
253 void (*set_notification_data) (notify_payload_t *this,
254 chunk_t notification_data);
255
256 /**
257 * Destroys an notify_payload_t object.
258 */
259 void (*destroy) (notify_payload_t *this);
260 };
261
262 /**
263 * Creates an empty notify_payload_t object
264 *
265 * @param type payload type, NOTIFY or NOTIFY_V1
266 * @return created notify_payload_t object
267 */
268 notify_payload_t *notify_payload_create(payload_type_t type);
269
270 /**
271 * Creates an notify_payload_t object of specific type for specific protocol id.
272 *
273 * @param type payload type, NOTIFY or NOTIFY_V1
274 * @param protocol protocol id (IKE, AH or ESP)
275 * @param type notify type (see notify_type_t)
276 * @return notify_payload_t object
277 */
278 notify_payload_t *notify_payload_create_from_protocol_and_type(
279 payload_type_t type, protocol_id_t protocol, notify_type_t notify);
280
281 #endif /** NOTIFY_PAYLOAD_H_ @}*/