Removed strayed code fragment
[strongswan.git] / src / charon / 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 * Representating one or more transform substructures.
224 *
225 * The offset points to a linked_list_t pointer.
226 *
227 * When generating the transform_substructure_t objects are stored
228 * in the pointed linked_list.
229 *
230 * When parsing the parsed transform_substructure_t objects have
231 * to be stored in the pointed linked_list.
232 */
233 TRANSFORMS,
234
235 /**
236 * Representating one or more Attributes of a transform substructure.
237 *
238 * The offset points to a linked_list_t pointer.
239 *
240 * When generating the transform_attribute_t objects are stored
241 * in the pointed linked_list.
242 *
243 * When parsing the parsed transform_attribute_t objects have
244 * to be stored in the pointed linked_list.
245 */
246 TRANSFORM_ATTRIBUTES,
247
248 /**
249 * Representating one or more Attributes of a configuration payload.
250 *
251 * The offset points to a linked_list_t pointer.
252 *
253 * When generating the configuration_attribute_t objects are stored
254 * in the pointed linked_list.
255 *
256 * When parsing the parsed configuration_attribute_t objects have
257 * to be stored in the pointed linked_list.
258 */
259 CONFIGURATION_ATTRIBUTES,
260
261 /**
262 *
263 * When generating the content of the chunkt pointing to
264 * is written.
265 *
266 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
267 */
268 CONFIGURATION_ATTRIBUTE_VALUE,
269
270 /**
271 * Representing a 1 Bit flag specifying the format of a transform attribute.
272 *
273 * When generation, the next bit is set to 1 if the associated value
274 * in the data struct is TRUE, 0 otherwise. The current write position
275 * is moved 1 bit forward afterwards.
276 *
277 * When parsing, the next bit is read and stored in the associated data
278 * struct. 0 means FALSE, 1 means TRUE, The current read pointer
279 * is moved 1 bit forward afterwards.
280 */
281 ATTRIBUTE_FORMAT,
282 /**
283 * Representing a 15 Bit unsigned int value used as attribute type
284 * in an attribute transform.
285 *
286 *
287 * When generating it must be changed from host to network order.
288 * The value is read from the associated data struct.
289 * The current write position is moved 15 bit forward afterwards.
290 *
291 * When parsing it must be changed from network to host order.
292 * The value is written to the associated data struct.
293 * The current read pointer is moved 15 bit forward afterwards.
294 */
295 ATTRIBUTE_TYPE,
296
297 /**
298 * Depending on the field of type ATTRIBUTE_FORMAT
299 * this field contains the length or the value of an transform attribute.
300 * Its stored in a 16 unsigned integer field.
301 *
302 * When generating it must be changed from host to network order.
303 * The value is read from the associated data struct.
304 * The current write position is moved 16 bit forward afterwards.
305 *
306 * When parsing it must be changed from network to host order.
307 * The value is written to the associated data struct.
308 * The current read pointer is moved 16 bit forward afterwards.
309 */
310 ATTRIBUTE_LENGTH_OR_VALUE,
311
312 /**
313 * This field contains the length or the value of an configuration attribute.
314 * Its stored in a 16 unsigned integer field.
315 *
316 * When generating it must be changed from host to network order.
317 * The value is read from the associated data struct.
318 * The current write position is moved 16 bit forward afterwards.
319 *
320 * When parsing it must be changed from network to host order.
321 * The value is written to the associated data struct.
322 * The current read pointer is moved 16 bit forward afterwards.
323 */
324 CONFIGURATION_ATTRIBUTE_LENGTH,
325
326 /**
327 * Depending on the field of type ATTRIBUTE_FORMAT
328 * this field is available or missing and so parsed/generated
329 * or not parsed/not generated.
330 *
331 * When generating the content of the chunkt pointing to
332 * is written.
333 *
334 * When parsing SPI_SIZE bytes are read and written into the chunk pointing to.
335 */
336 ATTRIBUTE_VALUE,
337
338 /**
339 * Representating one or more Traffic selectors of a TS payload.
340 *
341 * The offset points to a linked_list_t pointer.
342 *
343 * When generating the traffic_selector_substructure_t objects are stored
344 * in the pointed linked_list.
345 *
346 * When parsing the parsed traffic_selector_substructure_t objects have
347 * to be stored in the pointed linked_list.
348 */
349 TRAFFIC_SELECTORS,
350
351 /**
352 * Representating a Traffic selector type field.
353 *
354 * When generating it must be changed from host to network order.
355 * The value is read from the associated data struct.
356 * The current write position is moved 16 bit forward afterwards.
357 *
358 * When parsing it must be changed from network to host order.
359 * The value is written to the associated data struct.
360 * The current read pointer is moved 16 bit forward afterwards.
361 */
362 TS_TYPE,
363
364 /**
365 * Representating an address field in a traffic selector.
366 *
367 * Depending on the last field of type TS_TYPE
368 * this field is either 4 or 16 byte long.
369 *
370 * When generating the content of the chunkt pointing to
371 * is written.
372 *
373 * When parsing 4 or 16 bytes are read and written into the chunk pointing to.
374 */
375 ADDRESS,
376
377 /**
378 * Representating a Nonce Data field.
379 *
380 * When generating the content of the chunkt pointing to
381 * is written.
382 *
383 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
384 */
385 NONCE_DATA,
386
387 /**
388 * Representating a ID Data field.
389 *
390 * When generating the content of the chunkt pointing to
391 * is written.
392 *
393 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
394 */
395 ID_DATA,
396
397 /**
398 * Representating a AUTH Data field.
399 *
400 * When generating the content of the chunkt pointing to
401 * is written.
402 *
403 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
404 */
405 AUTH_DATA,
406
407 /**
408 * Representating a CERT Data field.
409 *
410 * When generating the content of the chunkt pointing to
411 * is written.
412 *
413 * When parsing (Payload Length - 5) bytes are read and written into the chunk pointing to.
414 */
415 CERT_DATA,
416
417 /**
418 * Representating a CERTREQ Data field.
419 *
420 * When generating the content of the chunkt pointing to
421 * is written.
422 *
423 * When parsing (Payload Length - 5) bytes are read and written into the chunk pointing to.
424 */
425 CERTREQ_DATA,
426
427 /**
428 * Representating an EAP message field.
429 *
430 * When generating the content of the chunkt pointing to
431 * is written.
432 *
433 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
434 */
435 EAP_DATA,
436
437 /**
438 * Representating the SPIS field in a DELETE payload.
439 *
440 * When generating the content of the chunkt pointing to
441 * is written.
442 *
443 * When parsing (Payload Length - 8) bytes are read and written into the chunk pointing to.
444 */
445 SPIS,
446
447 /**
448 * Representating the VID DATA field in a VENDOR ID payload.
449 *
450 * When generating the content of the chunkt pointing to
451 * is written.
452 *
453 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
454 */
455 VID_DATA,
456
457 /**
458 * Representating the DATA of an unknown payload.
459 *
460 * When generating the content of the chunkt pointing to
461 * is written.
462 *
463 * When parsing (Payload Length - 4) bytes are read and written into the chunk pointing to.
464 */
465 UNKNOWN_DATA,
466
467 /**
468 * Representating an IKE_SPI field in an IKEv2 Header.
469 *
470 * When generating the value of the u_int64_t pointing to
471 * is written (host and networ order is not changed).
472 *
473 * When parsing 8 bytes are read and written into the u_int64_t pointing to.
474 */
475 IKE_SPI,
476
477 /**
478 * Representing the encrypted data body of a encryption payload.
479 */
480 ENCRYPTED_DATA,
481 };
482
483 /**
484 * enum name for encoding_type_t
485 */
486 extern enum_name_t *encoding_type_names;
487
488 /**
489 * Rule how to en-/decode a payload field.
490 *
491 * An encoding rule is a mapping of a specific encoding type to
492 * a location in the data struct where the current field is stored to
493 * or read from.
494 * This rules are used by parser and generator.
495 */
496 struct encoding_rule_t {
497
498 /**
499 * Encoding type.
500 */
501 encoding_type_t type;
502
503 /**
504 * Offset in the data struct.
505 *
506 * When parsing, data are written to this offset of the
507 * data struct.
508 *
509 * When generating, data are read from this offset in the
510 * data struct.
511 */
512 u_int32_t offset;
513 };
514
515 #endif /** ENCODINGS_H_ @}*/