- defined basic encoding types of ike-header and ike-payload fields
This commit is contained in:
Jan Hutter
parent
4acf505acd
commit
bb53258a0e
1 changed files with 196 additions and 0 deletions
196
Source/charon/encodings.h
Normal file
196
Source/charon/encodings.h
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
/**
|
||||
* @file encodings.h
|
||||
*
|
||||
* @brief Type definitions for parser and generator
|
||||
* Also, Payload types are defined here.
|
||||
*
|
||||
* Header is parsed like a payload and gets its one payload_id
|
||||
* from PRIVATE USE space. Also the substructures get their own
|
||||
* payload_id from PRIVATE_USE space
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2005 Jan Hutter, Martin Willi
|
||||
* Hochschule fuer Technik Rapperswil
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the
|
||||
* Free Software Foundation; either version 2 of the License, or (at your
|
||||
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
* for more details.
|
||||
*/
|
||||
|
||||
#ifndef ENCODINGS_H_
|
||||
#define ENCODINGS_H_
|
||||
|
||||
#include <freeswan.h>
|
||||
#include <pluto/constants.h>
|
||||
#include <pluto/defs.h>
|
||||
|
||||
/**
|
||||
* @brief All different kinds of encoding types.
|
||||
*
|
||||
* Each field of an IKEv2-Message (in header or payload)
|
||||
* which has to be parsed or generated differently has its own
|
||||
* enum value.
|
||||
*/
|
||||
typedef enum encoding_e encoding_t;
|
||||
|
||||
enum encoding_e{
|
||||
/**
|
||||
* Representing a 4 Bit unsigned int value
|
||||
*
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 4 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 4 bit forward afterwards.
|
||||
*/
|
||||
U_INT_4,
|
||||
/**
|
||||
* Representing a 8 Bit unsigned int value
|
||||
*
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 8 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 8 bit forward afterwards.
|
||||
*/
|
||||
U_INT_8,
|
||||
/**
|
||||
* Representing a 16 Bit unsigned int value
|
||||
*
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 16 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 16 bit forward afterwards.
|
||||
*/
|
||||
U_INT_16,
|
||||
/**
|
||||
* Representing a 32 Bit unsigned int value
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 32 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 32 bit forward afterwards.
|
||||
*/
|
||||
|
||||
U_INT_32,
|
||||
/**
|
||||
* Representing a 64 Bit unsigned int value
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 64 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 64 bit forward afterwards.
|
||||
*/
|
||||
U_INT_64,
|
||||
/**
|
||||
* @brief represents a RESERVED_BIT used in FLAG-Bytes
|
||||
*
|
||||
* When generating, the next bit is set to zero and the current write
|
||||
* position is moved one bit forward.
|
||||
* No value is read from the associated data struct.
|
||||
* The current write position is moved 1 bit forward afterwards.
|
||||
*
|
||||
* When parsing, the current read pointer is moved one bit forward.
|
||||
* No value is written to the associated data struct.
|
||||
* The current read pointer is moved 1 bit forward afterwards.
|
||||
*/
|
||||
RESERVED_BIT,
|
||||
/**
|
||||
* @brief represents a RESERVED_BYTE
|
||||
*
|
||||
* When generating, the next byte is set to zero and the current write
|
||||
* position is moved one byte forward.
|
||||
* No value is read from the associated data struct.
|
||||
* The current write position is moved 1 byte forward afterwards.
|
||||
*
|
||||
* When parsing, the current read pointer is moved one byte forward.
|
||||
* No value is written to the associated data struct.
|
||||
* The current read pointer is moved 1 byte forward afterwards.
|
||||
*/
|
||||
RESERVED_BYTE,
|
||||
/**
|
||||
* Representing a 1 Bit flag.
|
||||
*
|
||||
* When generation, the next bit is set to 1 if the associated value
|
||||
* in the data struct is TRUE, 0 otherwise. The current write position
|
||||
* is moved 1 bit forward afterwards.
|
||||
*
|
||||
* When parsing, the next bit is read and stored in the associated data
|
||||
* struct. 0 means FALSE, 1 means TRUE, The current read pointer
|
||||
* is moved 1 bit forward afterwards
|
||||
*/
|
||||
FLAG,
|
||||
/**
|
||||
* Representating a length field
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 32 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 32 bit forward afterwards.
|
||||
*/
|
||||
LENGTH,
|
||||
/**
|
||||
* Representating a spi size field
|
||||
*
|
||||
* When generating it must be changed from host to network order.
|
||||
* The value is read from the associated data struct.
|
||||
* The current write position is moved 32 bit forward afterwards.
|
||||
*
|
||||
* When parsing it must be changed from network to host order.
|
||||
* The value is written to the associated data struct.
|
||||
* The current read pointer is moved 32 bit forward afterwards.
|
||||
*/
|
||||
SPI_SIZE
|
||||
};
|
||||
|
||||
/**
|
||||
* An encoding rule is a mapping of a specific encoding type to
|
||||
* a location in the data struct where the current field is stored to
|
||||
* or read from.
|
||||
*
|
||||
* For examples see directory encodings/
|
||||
*
|
||||
* This rules are used by parser and generator
|
||||
*/
|
||||
typedef struct encoding_rule_s encoding_rule_t;
|
||||
|
||||
struct encoding_rule_s{
|
||||
/**
|
||||
* Encoding type
|
||||
*/
|
||||
encoding_t type;
|
||||
/**
|
||||
* Offset in the data struct
|
||||
*/
|
||||
u_int32_t offset;
|
||||
};
|
||||
|
||||
#endif /*ENCODINGS_H_*/
|
||||
Loading…
Reference in a new issue