aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/definitions.h
blob: 3ad0b161410d10127b322924e8d1abff8ab5818d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
/**
 * @file definitions.h
 * 
 * @brief general purpose definitions and macros
 * 
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 * Copyright (C) 1998, 1999  D. Hugh Redelmeier. (Endian stuff)
 * 
 * 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 DEFINITIONS_H_
#define DEFINITIONS_H_



/* stolen from strongswan */
#if linux
# if defined(i386) && !defined(__i386__)
#  define __i386__ 1
#  define MYHACKFORTHIS 1
# endif
# include <endian.h>
# ifdef MYHACKFORTHIS
#  undef __i386__
#  undef MYHACKFORTHIS
# endif
#elif !(defined(BIG_ENDIAN) && defined(LITTLE_ENDIAN) && defined(BYTE_ORDER))
 /* we don't know how to do this, so we require the macros to be defined
  * with compiler flags:
  *    -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=BIG_ENDIAN
  * or -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=LITTLE_ENDIAN
  * Thse match the GNU definitions
  */
# include <sys/endian.h>
#endif

#ifndef BIG_ENDIAN
 #error "BIG_ENDIAN must be defined"
#endif

#ifndef LITTLE_ENDIAN
 #error "LITTLE_ENDIAN must be defined"
#endif

#ifndef BYTE_ORDER
 #error "BYTE_ORDER must be defined"
#endif


/**
 * @defgroup config
 * 
 * Configuration stuff.
 */

/**
 * @defgroup encoding
 * 
 * Classes used to encode and decode IKEv2 Messages.
 */

/**
 * @defgroup network
 * 
 * Low level network stuff.
 */
 
 /**
 * @defgroup payloads
 * 
 * Classes representing a specific IKEv2 Payload type.
 * 
 * @ingroup encoding
 */

/**
 * @defgroup sa
 * 
 * Security association with all helber classes.
 */


/**
 * @defgroup states
 *
 * Varius states in which an IKE SA can be.
 *
 * @ingroup sa
 */

/**
 * @defgroup queues
 * 
 * Different kind of queues.
 */
 
 /**
  * @defgroup jobs
  * 
  * Jobs used in job queue and event queue.
  * 
  * @ingroup queues
  */

/**
 * @defgroup testcases
 * 
 * Testcases used to test the different classes in seperate module tests.
 */

/**
 * @defgroup transforms
 * 
 * Transform algorithms of different kind.
 */
 
/**
 * @defgroup prfs
 * 
 * Pseudo random functions, generate a lot of pseudo
 * randomness using random numbers.
 * 
 * @ingroup transforms
 */

/**
 * @defgroup signers
 * 
 * Symmetric signing algorithms, used to ensure 
 * message integrity.
 * 
 * @ingroup transforms
 */

/**
 * @defgroup crypters
 * 
 * Symmetric encryption algorithms, used to en-
 * and decrypt.
 * 
 * @ingroup transforms
 */
 
/**
 * @defgroup hashers
 * 
 * Hashing algorithms.
 * 
 * Example for using hasher_t:
 * @code
 * chunk_t data;
 * chunk_t md5_hash;
 * u_int8_t sha1_hash[20];
 * 
 * hasher_t *hasher;
 * 
 * data.ptr = "string to hash";
 * data.len = strlen(data.ptr);
 * 
 * // use MD5, allocate hash
 * hasher = hasher_create(HASH_MD5);
 * hasher->allocate_hash(hasher, data, &hash);
 * hasher->destroy(hasher);
 * 
 * // use SHA1, hash in buffer
 * hasher = hasher_create(HASH_SHA1);
 * hasher->get_hash(hasher, data, &sha1_hash);
 * hasher->destroy(hasher);
 * @endcode
 * 
 * 
 * 
 * @ingroup transforms
 */
 
 /**
 * @defgroup utils
 * 
 * Generic helper classes.
 */
  
/**
 * @defgroup threads
 * 
 * Threaded classes, which will do their 
 * job alone.
 */
 
 

/**
 * macro gives back larger of two values
 */
#define max(x,y) (x > y ? x : y)


/**
 * macro gives back smaller of two values
 */
#define min(x,y) (x < y ? x : y)


/**
 * mapping entry which defines the end of a mapping_t array
 */
#define MAPPING_END (-1)

typedef struct mapping_t mapping_t;

/**
 * @brief mapping entry, where enum-to-string mappings are stored.
 */
struct mapping_t
{
	/**
	 * enumeration value
	 */
	int value;
	/**
	 * mapped string
	 */
	char *string;
};


/**
 * @brief find a mapping_string in the mapping[]
 * 
 * @param mappings		mappings array
 * @param value			enum-value to get the string from
 * 
 */
char *mapping_find(mapping_t *mappings, int value);


/**
 * Default random device used when no device is given.
 */
#define DEFAULT_RANDOM_DEVICE "/dev/random"

/**
 * Pseudo random device used when no device is given.
 */
#define DEFAULT_PSEUDO_RANDOM_DEVICE "/dev/urandom"


#endif /*DEFINITIONS_H_*/