3ad0b161410d10127b322924e8d1abff8ab5818d
[strongswan.git] / Source / charon / definitions.h
1 /**
2 * @file definitions.h
3 *
4 * @brief general purpose definitions and macros
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 * Copyright (C) 1998, 1999 D. Hugh Redelmeier. (Endian stuff)
12 *
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
20 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 * for more details.
22 */
23
24 #ifndef DEFINITIONS_H_
25 #define DEFINITIONS_H_
26
27
28
29 /* stolen from strongswan */
30 #if linux
31 # if defined(i386) && !defined(__i386__)
32 # define __i386__ 1
33 # define MYHACKFORTHIS 1
34 # endif
35 # include <endian.h>
36 # ifdef MYHACKFORTHIS
37 # undef __i386__
38 # undef MYHACKFORTHIS
39 # endif
40 #elif !(defined(BIG_ENDIAN) && defined(LITTLE_ENDIAN) && defined(BYTE_ORDER))
41 /* we don't know how to do this, so we require the macros to be defined
42 * with compiler flags:
43 * -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=BIG_ENDIAN
44 * or -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=LITTLE_ENDIAN
45 * Thse match the GNU definitions
46 */
47 # include <sys/endian.h>
48 #endif
49
50 #ifndef BIG_ENDIAN
51 #error "BIG_ENDIAN must be defined"
52 #endif
53
54 #ifndef LITTLE_ENDIAN
55 #error "LITTLE_ENDIAN must be defined"
56 #endif
57
58 #ifndef BYTE_ORDER
59 #error "BYTE_ORDER must be defined"
60 #endif
61
62
63 /**
64 * @defgroup config
65 *
66 * Configuration stuff.
67 */
68
69 /**
70 * @defgroup encoding
71 *
72 * Classes used to encode and decode IKEv2 Messages.
73 */
74
75 /**
76 * @defgroup network
77 *
78 * Low level network stuff.
79 */
80
81 /**
82 * @defgroup payloads
83 *
84 * Classes representing a specific IKEv2 Payload type.
85 *
86 * @ingroup encoding
87 */
88
89 /**
90 * @defgroup sa
91 *
92 * Security association with all helber classes.
93 */
94
95
96 /**
97 * @defgroup states
98 *
99 * Varius states in which an IKE SA can be.
100 *
101 * @ingroup sa
102 */
103
104 /**
105 * @defgroup queues
106 *
107 * Different kind of queues.
108 */
109
110 /**
111 * @defgroup jobs
112 *
113 * Jobs used in job queue and event queue.
114 *
115 * @ingroup queues
116 */
117
118 /**
119 * @defgroup testcases
120 *
121 * Testcases used to test the different classes in seperate module tests.
122 */
123
124 /**
125 * @defgroup transforms
126 *
127 * Transform algorithms of different kind.
128 */
129
130 /**
131 * @defgroup prfs
132 *
133 * Pseudo random functions, generate a lot of pseudo
134 * randomness using random numbers.
135 *
136 * @ingroup transforms
137 */
138
139 /**
140 * @defgroup signers
141 *
142 * Symmetric signing algorithms, used to ensure
143 * message integrity.
144 *
145 * @ingroup transforms
146 */
147
148 /**
149 * @defgroup crypters
150 *
151 * Symmetric encryption algorithms, used to en-
152 * and decrypt.
153 *
154 * @ingroup transforms
155 */
156
157 /**
158 * @defgroup hashers
159 *
160 * Hashing algorithms.
161 *
162 * Example for using hasher_t:
163 * @code
164 * chunk_t data;
165 * chunk_t md5_hash;
166 * u_int8_t sha1_hash[20];
167 *
168 * hasher_t *hasher;
169 *
170 * data.ptr = "string to hash";
171 * data.len = strlen(data.ptr);
172 *
173 * // use MD5, allocate hash
174 * hasher = hasher_create(HASH_MD5);
175 * hasher->allocate_hash(hasher, data, &hash);
176 * hasher->destroy(hasher);
177 *
178 * // use SHA1, hash in buffer
179 * hasher = hasher_create(HASH_SHA1);
180 * hasher->get_hash(hasher, data, &sha1_hash);
181 * hasher->destroy(hasher);
182 * @endcode
183 *
184 *
185 *
186 * @ingroup transforms
187 */
188
189 /**
190 * @defgroup utils
191 *
192 * Generic helper classes.
193 */
194
195 /**
196 * @defgroup threads
197 *
198 * Threaded classes, which will do their
199 * job alone.
200 */
201
202
203
204 /**
205 * macro gives back larger of two values
206 */
207 #define max(x,y) (x > y ? x : y)
208
209
210 /**
211 * macro gives back smaller of two values
212 */
213 #define min(x,y) (x < y ? x : y)
214
215
216 /**
217 * mapping entry which defines the end of a mapping_t array
218 */
219 #define MAPPING_END (-1)
220
221 typedef struct mapping_t mapping_t;
222
223 /**
224 * @brief mapping entry, where enum-to-string mappings are stored.
225 */
226 struct mapping_t
227 {
228 /**
229 * enumeration value
230 */
231 int value;
232 /**
233 * mapped string
234 */
235 char *string;
236 };
237
238
239 /**
240 * @brief find a mapping_string in the mapping[]
241 *
242 * @param mappings mappings array
243 * @param value enum-value to get the string from
244 *
245 */
246 char *mapping_find(mapping_t *mappings, int value);
247
248
249 /**
250 * Default random device used when no device is given.
251 */
252 #define DEFAULT_RANDOM_DEVICE "/dev/random"
253
254 /**
255 * Pseudo random device used when no device is given.
256 */
257 #define DEFAULT_PSEUDO_RANDOM_DEVICE "/dev/urandom"
258
259
260 #endif /*DEFINITIONS_H_*/