Extend sa_payload for IKEv1 support
[strongswan.git] / src / libcharon / encoding / payloads / encodings.h
1 /*
2 * Copyright (C) 2005-2006 Martin Willi
3 * Copyright (C) 2005 Jan Hutter
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 /**
18 * @defgroup encodings encodings
19 * @{ @ingroup payloads
20 */
21
22 #ifndef ENCODINGS_H_
23 #define ENCODINGS_H_
24
25 typedef enum encoding_type_t encoding_type_t;
26 typedef struct encoding_rule_t encoding_rule_t;
27
28 #include <library.h>
29
30 /**
31 * All different kinds of encoding types.
32 *
33 * Each field of an IKEv2-Message (in header or payload)
34 * which has to be parsed or generated differently has its own
35 * type defined here.
36 *
37 * Header is parsed like a payload and gets its one payload_id
38 * from PRIVATE USE space. Also the substructures
39 * of specific payload types get their own payload_id
40 * from PRIVATE_USE space. See IKEv2-Draft for more informations.
41 */
42 enum encoding_type_t {
43
44 /**
45 * Representing a 4 Bit unsigned int value.
46 *
47 *
48 * When generating it must be changed from host to network order.
49 * The value is read from the associated data struct.
50 * The current write position is moved 4 bit forward afterwards.
51 *
52 * When parsing it must be changed from network to host order.
53 * The value is written to the associated data struct.
54 * The current read pointer is moved 4 bit forward afterwards.
55 */
56 U_INT_4,
57
58 /**
59 * Representing a 8 Bit unsigned int value.
60 *
61 *
62 * When generating it must be changed from host to network order.
63 * The value is read from the associated data struct.
64 * The current write position is moved 8 bit forward afterwards.
65 *
66 * When parsing it must be changed from network to host order.
67 * The value is written to the associated data struct.
68 * The current read pointer is moved 8 bit forward afterwards.
69 */
70 U_INT_8,
71
72 /**
73 * Representing a 16 Bit unsigned int value.
74 *
75 *
76 * When generating it must be changed from host to network order.
77 * The value is read from the associated data struct.
78 * The current write position is moved 16 bit forward afterwards.
79 *
80 * When parsing it must be changed from network to host order.
81 * The value is written to the associated data struct.
82 * The current read pointer is moved 16 bit forward afterwards.
83 */
84 U_INT_16,
85
86 /**
87 * Representing a 32 Bit unsigned int value.
88 *
89 * When generating it must be changed from host to network order.
90 * The value is read from the associated data struct.
91 * The current write position is moved 32 bit forward afterwards.
92 *
93 * When parsing it must be changed from network to host order.
94 * The value is written to the associated data struct.
95 * The current read pointer is moved 32 bit forward afterwards.
96 */
97 U_INT_32,
98
99 /**
100 * represents a RESERVED_BIT used in FLAG-Bytes.
101 *
102 * When generating, the next bit is set to zero and the current write
103 * position is moved one bit forward.
104 * No value is read from the associated data struct.
105 * The current write position is moved 1 bit forward afterwards.
106 *
107 * When parsing, the current read pointer is moved one bit forward.
108 * No value is written to the associated data struct.
109 * The current read pointer is moved 1 bit forward afterwards.
110 */
111 RESERVED_BIT,
112
113 /**
114 * represents a RESERVED_BYTE.
115 *
116 * When generating, the next byte is set to zero and the current write
117 * position is moved one byte forward.
118 * No value is read from the associated data struct.
119 * The current write position is moved 1 byte forward afterwards.
120 *
121 * When parsing, the current read pointer is moved one byte forward.
122 * No value is written to the associated data struct.
123 * The current read pointer is moved 1 byte forward afterwards.
124 */
125 RESERVED_BYTE,
126
127 /**
128 * Representing a 1 Bit flag.
129 *
130 * When generation, the next bit is set to 1 if the associated value
131 * in the data struct is TRUE, 0 otherwise. The current write position
132 * is moved 1 bit forward afterwards.
133 *
134 * When parsing, the next bit is read and stored in the associated data
135 * struct. 0 means FALSE, 1 means TRUE, The current read pointer
136 * is moved 1 bit forward afterwards
137 */
138 FLAG,
139
140 /**
141 * Representating a length field of a payload.
142 *
143 * When generating it must be changed from host to network order.
144 * The value is read from the associated data struct.
145 * The current write position is moved 16 bit forward afterwards.
146 *
147 * When parsing it must be changed from network to host order.
148 * The value is written to the associated data struct.
149 * The current read pointer is moved 16 bit forward afterwards.
150 */
151 PAYLOAD_LENGTH,
152
153 /**
154 * Representating a length field of a header.
155 *
156 * When generating it must be changed from host to network order.
157 * The value is read from the associated data struct.
158 * The current write position is moved 32 bit forward afterwards.
159 *
160 * When parsing it must be changed from network to host order.
161 * The value is written to the associated data struct.
162 * The current read pointer is moved 32 bit forward afterwards.
163 */
164 HEADER_LENGTH,
165
166 /**
167 * Representating a spi size field.
168 *
169 * When generating it must be changed from host to network order.
170 * The value is read from the associated data struct.
171 * The current write position is moved 8 bit forward afterwards.
172 *
173 * When parsing it must be changed from network to host order.
174 * The value is written to the associated data struct.
175 * The current read pointer is moved 8 bit forward afterwards.
176 */
177 SPI_SIZE,
178
179 /**
180 * Representating a spi field.
181 *
182 * When generating the content of the chunkt pointing to
183 * is written.
184 *
185 * When parsing SPI_SIZE bytes are read and written into the chunk pointing to.
186 */
187 SPI,
188
189 /**
190 * Representating a Key Exchange Data field.
191 *
192 * When generating the content of the chunkt pointing to
193 * is written.
194 *
195 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
196 */
197 KEY_EXCHANGE_DATA,
198
199 /**
200 * Representating a Notification field.
201 *
202 * When generating the content of the chunkt pointing to
203 * is written.
204 *
205 * When parsing (Payload Length - spi size - 8) bytes are read and written into the chunk pointing to.
206 */
207 NOTIFICATION_DATA,
208
209 /**
210 * Representating one or more proposal substructures.
211 *
212 * The offset points to a linked_list_t pointer.
213 *
214 * When generating the proposal_substructure_t objects are stored
215 * in the pointed linked_list.
216 *
217 * When parsing the parsed proposal_substructure_t objects have
218 * to be stored in the pointed linked_list.
219 */
220 PROPOSALS,
221
222 /**
223 * Same as PROPOSALS, but for IKEv1 in a SECURITY_ASSOCIATION_V1
224 */
225 PROPOSALS_V1,
226
227 /**
228 * Representating one or more transform substructures.
229 *
230 * The offset points to a linked_list_t pointer.
231 *
232 * When generating the transform_substructure_t objects are stored
233 * in the pointed linked_list.
234 *
235 * When parsing the parsed transform_substructure_t objects have
236 * to be stored in the pointed linked_list.
237 */
238 TRANSFORMS,
239
240 /**
241 * Representating one or more Attributes of a transform substructure.
242 *
243 * The offset points to a linked_list_t pointer.
244 *
245 * When generating the transform_attribute_t objects are stored
246 * in the pointed linked_list.
247 *
248 * When parsing the parsed transform_attribute_t objects have
249 * to be stored in the pointed linked_list.
250 */
251 TRANSFORM_ATTRIBUTES,
252
253 /**
254 * Representating one or more Attributes of a configuration payload.
255 *
256 * The offset points to a linked_list_t pointer.
257 *
258 * When generating the configuration_attribute_t objects are stored
259 * in the pointed linked_list.
260 *
261 * When parsing the parsed configuration_attribute_t objects have
262 * to be stored in the pointed linked_list.
263 */
264 CONFIGURATION_ATTRIBUTES,
265
266 /**
267 *
268 * When generating the content of the chunkt pointing to
269 * is written.
270 *
271 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
272 */
273 CONFIGURATION_ATTRIBUTE_VALUE,
274
275 /**
276 * Representing a 1 Bit flag specifying the format of a transform attribute.
277 *
278 * When generation, the next bit is set to 1 if the associated value
279 * in the data struct is TRUE, 0 otherwise. The current write position
280 * is moved 1 bit forward afterwards.
281 *
282 * When parsing, the next bit is read and stored in the associated data
283 * struct. 0 means FALSE, 1 means TRUE, The current read pointer
284 * is moved 1 bit forward afterwards.
285 */
286 ATTRIBUTE_FORMAT,
287 /**
288 * Representing a 15 Bit unsigned int value used as attribute type
289 * in an attribute transform.
290 *
291 *
292 * When generating it must be changed from host to network order.
293 * The value is read from the associated data struct.
294 * The current write position is moved 15 bit forward afterwards.
295 *
296 * When parsing it must be changed from network to host order.
297 * The value is written to the associated data struct.
298 * The current read pointer is moved 15 bit forward afterwards.
299 */
300 ATTRIBUTE_TYPE,
301
302 /**
303 * Depending on the field of type ATTRIBUTE_FORMAT
304 * this field contains the length or the value of an transform attribute.
305 * Its stored in a 16 unsigned integer field.
306 *
307 * When generating it must be changed from host to network order.
308 * The value is read from the associated data struct.
309 * The current write position is moved 16 bit forward afterwards.
310 *
311 * When parsing it must be changed from network to host order.
312 * The value is written to the associated data struct.
313 * The current read pointer is moved 16 bit forward afterwards.
314 */
315 ATTRIBUTE_LENGTH_OR_VALUE,
316
317 /**
318 * This field contains the length or the value of an configuration attribute.
319 * Its stored in a 16 unsigned integer field.
320 *
321 * When generating it must be changed from host to network order.
322 * The value is read from the associated data struct.
323 * The current write position is moved 16 bit forward afterwards.
324 *
325 * When parsing it must be changed from network to host order.
326 * The value is written to the associated data struct.
327 * The current read pointer is moved 16 bit forward afterwards.
328 */
329 CONFIGURATION_ATTRIBUTE_LENGTH,
330
331 /**
332 * Depending on the field of type ATTRIBUTE_FORMAT
333 * this field is available or missing and so parsed/generated
334 * or not parsed/not generated.
335 *
336 * When generating the content of the chunkt pointing to
337 * is written.
338 *
339 * When parsing SPI_SIZE bytes are read and written into the chunk pointing to.
340 */
341 ATTRIBUTE_VALUE,
342
343 /**
344 * Representating one or more Traffic selectors of a TS payload.
345 *
346 * The offset points to a linked_list_t pointer.
347 *
348 * When generating the traffic_selector_substructure_t objects are stored
349 * in the pointed linked_list.
350 *
351 * When parsing the parsed traffic_selector_substructure_t objects have
352 * to be stored in the pointed linked_list.
353 */
354 TRAFFIC_SELECTORS,
355
356 /**
357 * Representating a Traffic selector type field.
358 *
359 * When generating it must be changed from host to network order.
360 * The value is read from the associated data struct.
361 * The current write position is moved 16 bit forward afterwards.
362 *
363 * When parsing it must be changed from network to host order.
364 * The value is written to the associated data struct.
365 * The current read pointer is moved 16 bit forward afterwards.
366 */
367 TS_TYPE,
368
369 /**
370 * Representating an address field in a traffic selector.
371 *
372 * Depending on the last field of type TS_TYPE
373 * this field is either 4 or 16 byte long.
374 *
375 * When generating the content of the chunkt pointing to
376 * is written.
377 *
378 * When parsing 4 or 16 bytes are read and written into the chunk pointing to.
379 */
380 ADDRESS,
381
382 /**
383 * Representating a Nonce Data field.
384 *
385 * When generating the content of the chunkt pointing to
386 * is written.
387 *
388 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
389 */
390 NONCE_DATA,
391
392 /**
393 * Representating a ID Data field.
394 *
395 * When generating the content of the chunkt pointing to
396 * is written.
397 *
398 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
399 */
400 ID_DATA,
401
402 /**
403 * Representating a AUTH Data field.
404 *
405 * When generating the content of the chunkt pointing to
406 * is written.
407 *
408 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
409 */
410 AUTH_DATA,
411
412 /**
413 * Representating a CERT Data field.
414 *
415 * When generating the content of the chunkt pointing to
416 * is written.
417 *
418 * When parsing (Payload Length - 5) bytes are read and written into the chunk pointing to.
419 */
420 CERT_DATA,
421
422 /**
423 * Representating a CERTREQ Data field.
424 *
425 * When generating the content of the chunkt pointing to
426 * is written.
427 *
428 * When parsing (Payload Length - 5) bytes are read and written into the chunk pointing to.
429 */
430 CERTREQ_DATA,
431
432 /**
433 * Representating an EAP message field.
434 *
435 * When generating the content of the chunkt pointing to
436 * is written.
437 *
438 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
439 */
440 EAP_DATA,
441
442 /**
443 * Representating the SPIS field in a DELETE payload.
444 *
445 * When generating the content of the chunkt pointing to
446 * is written.
447 *
448 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
449 */
450 SPIS,
451
452 /**
453 * Representating the VID DATA field in a VENDOR ID payload.
454 *
455 * When generating the content of the chunkt pointing to
456 * is written.
457 *
458 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
459 */
460 VID_DATA,
461
462 /**
463 * Representating the DATA of an unknown payload.
464 *
465 * When generating the content of the chunkt pointing to
466 * is written.
467 *
468 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
469 */
470 UNKNOWN_DATA,
471
472 /**
473 * Representating an IKE_SPI field in an IKEv2 Header.
474 *
475 * When generating the value of the u_int64_t pointing to
476 * is written (host and networ order is not changed).
477 *
478 * When parsing 8 bytes are read and written into the u_int64_t pointing to.
479 */
480 IKE_SPI,
481
482 /**
483 * Representing the encrypted data body of a encryption payload.
484 */
485 ENCRYPTED_DATA,
486 };
487
488 /**
489 * enum name for encoding_type_t
490 */
491 extern enum_name_t *encoding_type_names;
492
493 /**
494 * Rule how to en-/decode a payload field.
495 *
496 * An encoding rule is a mapping of a specific encoding type to
497 * a location in the data struct where the current field is stored to
498 * or read from.
499 * This rules are used by parser and generator.
500 */
501 struct encoding_rule_t {
502
503 /**
504 * Encoding type.
505 */
506 encoding_type_t type;
507
508 /**
509 * Offset in the data struct.
510 *
511 * When parsing, data are written to this offset of the
512 * data struct.
513 *
514 * When generating, data are read from this offset in the
515 * data struct.
516 */
517 u_int32_t offset;
518 };
519
520 #endif /** ENCODINGS_H_ @}*/