- code cleaned up
[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 * Classes implementing configuration related things.
67 */
68
69 /**
70 * @defgroup encoding
71 *
72 * Classes used to encode and decode IKEv2 messages.
73 */
74
75 /**
76 * @defgroup network
77 *
78 * Classes for network relevant stuff.
79 */
80
81 /**
82 * @defgroup payloads
83 *
84 * Classes representing specific IKEv2 payloads.
85 *
86 * @ingroup encoding
87 */
88
89 /**
90 * @defgroup sa
91 *
92 * Security association and helper 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 rsa
132 *
133 * RSA public key algorithm.
134 *
135 * @ingroup transforms
136 */
137
138 /**
139 * @defgroup prfs
140 *
141 * Pseudo random functions.
142 *
143 * @ingroup transforms
144 */
145
146 /**
147 * @defgroup signers
148 *
149 * Symmetric signing algorithms, used to ensure message integrity.
150 *
151 * @ingroup transforms
152 */
153
154 /**
155 * @defgroup crypters
156 *
157 * Symmetric encryption algorithms, used to encrypt and decrypt.
158 *
159 * @ingroup transforms
160 */
161
162 /**
163 * @defgroup hashers
164 *
165 * Hashing algorithms.
166 *
167 * @ingroup transforms
168 */
169
170 /**
171 * @defgroup utils
172 *
173 * Generic helper classes.
174 */
175
176 /**
177 * @defgroup threads
178 *
179 * Threaded classes, which will do their job alone.
180 */
181
182 /**
183 * Macro gives back larger of two values.
184 */
185 #define max(x,y) (x > y ? x : y)
186
187 /**
188 * Macro gives back smaller of two values.
189 */
190 #define min(x,y) (x < y ? x : y)
191
192 /**
193 * Papping entry which defines the end of a mapping_t array.
194 */
195 #define MAPPING_END (-1)
196
197
198 typedef struct mapping_t mapping_t;
199
200 /**
201 * @brief Mapping entry, where enum-to-string mappings are stored.
202 */
203 struct mapping_t
204 {
205 /**
206 * Enumeration value.
207 */
208 int value;
209
210 /**
211 * Mapped string.
212 */
213 char *string;
214 };
215
216
217 /**
218 * @brief Find a mapping_string in the mapping[].
219 *
220 * @param mappings mappings array
221 * @param value enum-value to get the string from
222 *
223 */
224 char *mapping_find(mapping_t *mappings, int value);
225
226
227 /**
228 * Default random device used when no device is given.
229 */
230 #define DEFAULT_RANDOM_DEVICE "/dev/random"
231
232 /**
233 * Pseudo random device used when no device is given.
234 */
235 #define DEFAULT_PSEUDO_RANDOM_DEVICE "/dev/urandom"
236
237
238 #endif /*DEFINITIONS_H_*/