- added verify function to all payload types
[strongswan.git] / Source / charon / payloads / ike_header.c
1 /**
2 * @file ike_header.c
3 *
4 * @brief Declaration of the class ike_header_t.
5 *
6 * An object of this type represents an ike header and is used to
7 * generate and parse ike headers.
8 *
9 */
10
11 /*
12 * Copyright (C) 2005 Jan Hutter, Martin Willi
13 * Hochschule fuer Technik Rapperswil
14 *
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by the
17 * Free Software Foundation; either version 2 of the License, or (at your
18 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
19 *
20 * This program is distributed in the hope that it will be useful, but
21 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
22 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23 * for more details.
24 */
25
26 /* offsetof macro */
27 #include <stddef.h>
28
29 #include "ike_header.h"
30
31 #include "encodings.h"
32 #include "../utils/allocator.h"
33
34 typedef struct private_ike_header_s private_ike_header_t;
35
36 struct private_ike_header_s {
37 /**
38 * public interface
39 */
40 ike_header_t public;
41
42 /**
43 * SPI of the initiator
44 */
45 u_int64_t initiator_spi;
46 /**
47 * SPI of the responder
48 */
49 u_int64_t responder_spi;
50 /**
51 * next payload type
52 */
53 u_int8_t next_payload;
54 /**
55 * IKE major version
56 */
57 u_int8_t maj_version;
58
59 /**
60 * IKE minor version
61 */
62 u_int8_t min_version;
63
64 /**
65 * Exchange type
66 */
67 u_int8_t exchange_type;
68
69 /**
70 * Flags of the Message
71 *
72 */
73 struct {
74 /**
75 * Sender is initiator of the associated IKE_SA_INIT-Exchange
76 */
77 bool initiator;
78 /**
79 * is protocol supporting higher version?
80 */
81 bool version;
82 /**
83 * TRUE, if this is a response, FALSE if its a Request
84 */
85 bool response;
86 } flags;
87 /**
88 * Associated Message-ID
89 */
90 u_int32_t message_id;
91 /**
92 * Length of the whole IKEv2-Message (header and all payloads)
93 */
94 u_int32_t length;
95 };
96
97 /**
98 * mappings used to get strings for exchange_type_t
99 */
100 mapping_t exchange_type_m[] = {
101 {EXCHANGE_TYPE_UNDEFINED, "EXCHANGE_TYPE_UNDEFINED"},
102 {IKE_SA_INIT, "IKE_SA_INIT"},
103 {IKE_AUTH, "IKE_AUTH"},
104 {CREATE_CHILD_SA, "CREATE_CHILD_SA"},
105 {INFORMATIONAL, "INFORMATIONAL"}
106 };
107
108
109 /**
110 * Encoding rules to parse or generate a IKEv2-Header
111 *
112 * The defined offsets are the positions in a object of type
113 * ike_header_t.
114 *
115 */
116 encoding_rule_t ike_header_encodings[] = {
117 /* 8 Byte SPI, stored in the field initiator_spi */
118 { U_INT_64, offsetof(private_ike_header_t, initiator_spi) },
119 /* 8 Byte SPI, stored in the field responder_spi */
120 { U_INT_64, offsetof(private_ike_header_t, responder_spi) },
121 /* 1 Byte next payload type, stored in the field next_payload */
122 { U_INT_8, offsetof(private_ike_header_t, next_payload) },
123 /* 4 Bit major version, stored in the field maj_version */
124 { U_INT_4, offsetof(private_ike_header_t, maj_version) },
125 /* 4 Bit minor version, stored in the field min_version */
126 { U_INT_4, offsetof(private_ike_header_t, min_version) },
127 /* 8 Bit for the exchange type */
128 { U_INT_8, offsetof(private_ike_header_t, exchange_type) },
129 /* 2 Bit reserved bits, nowhere stored */
130 { RESERVED_BIT, 0 },
131 { RESERVED_BIT, 0 },
132 /* 3 Bit flags, stored in the fields response, version and initiator */
133 { FLAG, offsetof(private_ike_header_t, flags.response) },
134 { FLAG, offsetof(private_ike_header_t, flags.version) },
135 { FLAG, offsetof(private_ike_header_t, flags.initiator) },
136 /* 3 Bit reserved bits, nowhere stored */
137 { RESERVED_BIT, 0 },
138 { RESERVED_BIT, 0 },
139 { RESERVED_BIT, 0 },
140 /* 4 Byte message id, stored in the field message_id */
141 { U_INT_32, offsetof(private_ike_header_t, message_id) },
142 /* 4 Byte length fied, stored in the field length */
143 { HEADER_LENGTH, offsetof(private_ike_header_t, length) }
144 };
145
146
147 /* 1 2 3
148 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
149 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
150 ! IKE_SA Initiator's SPI !
151 ! !
152 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
153 ! IKE_SA Responder's SPI !
154 ! !
155 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
156 ! Next Payload ! MjVer ! MnVer ! Exchange Type ! Flags !
157 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
158 ! Message ID !
159 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
160 ! Length !
161 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
162 */
163
164
165 /**
166 * Implements payload_t's verify function.
167 * See #payload_s.verify for description.
168 */
169 static status_t verify(private_ike_header_t *this)
170 {
171 if ((this->exchange_type < IKE_SA_INIT) || (this->exchange_type > INFORMATIONAL))
172 {
173 /* unsupported exchange type */
174 return FAILED;
175 }
176 if ((this->initiator_spi == 0) && (this->responder_spi != 0))
177 {
178 /* initiator spi not set */
179 return FAILED;
180 }
181
182 /* verification of version is not done in here */
183
184 return SUCCESS;
185 }
186
187 /**
188 * Implements payload_t's set_next_type function.
189 * See #payload_s.set_next_type for description.
190 */
191 static status_t set_next_type(payload_t *this,payload_type_t type)
192 {
193 ((private_ike_header_t *)this)->next_payload = type;
194 return SUCCESS;
195 }
196 /**
197 * Implements ike_header_t's get_initiator_spi fuction.
198 * See #ike_header_t.get_initiator_spi for description.
199 */
200 static u_int64_t get_initiator_spi(private_ike_header_t *this)
201 {
202 return this->initiator_spi;
203 }
204
205 /**
206 * Implements ike_header_t's set_initiator_spi fuction.
207 * See #ike_header_t.set_initiator_spi for description.
208 */
209 static void set_initiator_spi(private_ike_header_t *this, u_int64_t initiator_spi)
210 {
211 this->initiator_spi = initiator_spi;
212 }
213
214 /**
215 * Implements ike_header_t's get_responder_spi fuction.
216 * See #ike_header_t.get_responder_spi for description.
217 */
218 static u_int64_t get_responder_spi(private_ike_header_t *this)
219 {
220 return this->responder_spi;
221 }
222
223 /**
224 * Implements ike_header_t's set_responder_spi fuction.
225 * See #ike_header_t.set_responder_spi for description.
226 */
227 static void set_responder_spi(private_ike_header_t *this, u_int64_t responder_spi)
228 {
229 this->responder_spi = responder_spi;
230 }
231
232 /**
233 * Implements ike_header_t's get_maj_version fuction.
234 * See #ike_header_t.get_maj_version for description.
235 */
236 static u_int8_t get_maj_version(private_ike_header_t *this)
237 {
238 return this->maj_version;
239 }
240
241 /**
242 * Implements ike_header_t's get_min_version fuction.
243 * See #ike_header_t.get_min_version for description.
244 */
245 static u_int8_t get_min_version(private_ike_header_t *this)
246 {
247 return this->min_version;
248 }
249
250 /**
251 * Implements ike_header_t's get_response_flag fuction.
252 * See #ike_header_t.get_response_flag for description.
253 */
254 static bool get_response_flag(private_ike_header_t *this)
255 {
256 return this->flags.response;
257 }
258
259 /**
260 * Implements ike_header_t's set_response_flag fuction.
261 * See #ike_header_t.set_response_flag for description.
262 */
263 static void set_response_flag(private_ike_header_t *this, bool response)
264 {
265 this->flags.response = response;
266 }
267
268 /**
269 * Implements ike_header_t's get_version_flag fuction.
270 * See #ike_header_t.get_version_flag for description.
271 */
272 static bool get_version_flag(private_ike_header_t *this)
273 {
274 return this->flags.version;
275 }
276
277 /**
278 * Implements ike_header_t's get_initiator_flag fuction.
279 * See #ike_header_t.get_initiator_flag for description.
280 */
281 static bool get_initiator_flag(private_ike_header_t *this)
282 {
283 return this->flags.initiator;
284 }
285
286 /**
287 * Implements ike_header_t's set_initiator_flag fuction.
288 * See #ike_header_t.set_initiator_flag for description.
289 */
290 static void set_initiator_flag(private_ike_header_t *this, bool initiator)
291 {
292 this->flags.initiator = initiator;
293 }
294
295 /**
296 * Implements ike_header_t's get_exchange_type function
297 * See #ike_header_t.get_exchange_type for description.
298 */
299 static u_int8_t get_exchange_type(private_ike_header_t *this)
300 {
301 return this->exchange_type;
302 }
303
304 /**
305 * Implements ike_header_t's set_exchange_type function.
306 * See #ike_header_t.set_exchange_type for description.
307 */
308 static void set_exchange_type(private_ike_header_t *this, u_int8_t exchange_type)
309 {
310 this->exchange_type = exchange_type;
311 }
312
313 /**
314 * Implements ike_header_t's get_message_id function.
315 * See #ike_header_t.get_message_id for description.
316 */
317 static u_int32_t get_message_id(private_ike_header_t *this)
318 {
319 return this->message_id;
320 }
321
322 /**
323 * Implements ike_header_t's set_message_id function.
324 * See #ike_header_t.set_message_id for description.
325 */
326 static void set_message_id(private_ike_header_t *this, u_int32_t message_id)
327 {
328 this->message_id = message_id;
329 }
330
331 /**
332 * Implements payload_t's and ike_header_t's destroy function.
333 * See #payload_s.destroy or ike_header_s.destroy for description.
334 */
335 static status_t destroy(ike_header_t *this)
336 {
337 allocator_free(this);
338
339 return SUCCESS;
340 }
341
342 /**
343 * Implements payload_t's get_encoding_rules function.
344 * See #payload_s.get_encoding_rules for description.
345 */
346 static status_t get_encoding_rules(payload_t *this, encoding_rule_t **rules, size_t *rule_count)
347 {
348 *rules = ike_header_encodings;
349 *rule_count = sizeof(ike_header_encodings) / sizeof(encoding_rule_t);
350
351 return SUCCESS;
352 }
353
354 /**
355 * Implements payload_t's get_type function.
356 * See #payload_s.get_type for description.
357 */
358 static payload_type_t get_type(payload_t *this)
359 {
360 return HEADER;
361 }
362
363 /**
364 * Implements payload_t's get_next_type function.
365 * See #payload_s.get_next_type for description.
366 */
367 static payload_type_t get_next_type(payload_t *this)
368 {
369 return (((private_ike_header_t*)this)->next_payload);
370 }
371
372 /**
373 * Implements payload_t's get_length function.
374 * See #payload_s.get_length for description.
375 */
376 static size_t get_length(payload_t *this)
377 {
378 return (((private_ike_header_t*)this)->length);
379 }
380
381 /*
382 * Described in header
383 */
384 ike_header_t *ike_header_create()
385 {
386 private_ike_header_t *this = allocator_alloc_thing(private_ike_header_t);
387 if (this == NULL)
388 {
389 return NULL;
390 }
391
392 this->public.payload_interface.verify = (status_t (*) (payload_t *))verify;
393 this->public.payload_interface.get_encoding_rules = get_encoding_rules;
394 this->public.payload_interface.get_length = get_length;
395 this->public.payload_interface.get_next_type = get_next_type;
396 this->public.payload_interface.set_next_type = set_next_type;
397 this->public.payload_interface.get_type = get_type;
398 this->public.payload_interface.destroy = (status_t (*) (payload_t *))destroy;
399 this->public.destroy = destroy;
400
401 this->public.get_initiator_spi = (u_int64_t (*) (ike_header_t*))get_initiator_spi;
402 this->public.set_initiator_spi = (void (*) (ike_header_t*,u_int64_t))set_initiator_spi;
403 this->public.get_responder_spi = (u_int64_t (*) (ike_header_t*))get_responder_spi;
404 this->public.set_responder_spi = (void (*) (ike_header_t *,u_int64_t))set_responder_spi;
405 this->public.get_maj_version = (u_int8_t (*) (ike_header_t*))get_maj_version;
406 this->public.get_min_version = (u_int8_t (*) (ike_header_t*))get_min_version;
407 this->public.get_response_flag = (bool (*) (ike_header_t*))get_response_flag;
408 this->public.set_response_flag = (void (*) (ike_header_t*,bool))set_response_flag;
409 this->public.get_version_flag = (bool (*) (ike_header_t*))get_version_flag;
410 this->public.get_initiator_flag = (bool (*) (ike_header_t*))get_initiator_flag;
411 this->public.set_initiator_flag = (void (*) (ike_header_t*,bool))set_initiator_flag;
412 this->public.get_exchange_type = (u_int8_t (*) (ike_header_t*))get_exchange_type;
413 this->public.set_exchange_type = (void (*) (ike_header_t*,u_int8_t))set_exchange_type;
414 this->public.get_message_id = (u_int32_t (*) (ike_header_t*))get_message_id;
415 this->public.set_message_id = (void (*) (ike_header_t*,u_int32_t))set_message_id;
416
417 /* set default values of the fields */
418 this->initiator_spi = 0;
419 this->responder_spi = 0;
420 this->next_payload = 0;
421 this->maj_version = IKE_MAJOR_VERSION;
422 this->min_version = IKE_MINOR_VERSION;
423 this->exchange_type = EXCHANGE_TYPE_UNDEFINED;
424 this->flags.initiator = TRUE;
425 this->flags.version = HIGHER_VERSION_SUPPORTED_FLAG;
426 this->flags.response = FALSE;
427 this->message_id = 0;
428 this->length = IKE_HEADER_LENGTH;
429
430
431 return (ike_header_t*)this;
432 }
433
434