7d99ce217fe86a0a0772e9bd72a74320732ea1fa
[strongswan.git] / src / pluto / constants.h
1 /* manifest constants
2 * Copyright (C) 1997 Angelos D. Keromytis.
3 * Copyright (C) 1998-2002 D. Hugh Redelmeier.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * RCSID $Id: constants.h,v 1.20 2006/02/28 19:13:33 as Exp $
16 */
17
18 #ifndef _CONSTANTS_H
19 #define _CONSTANTS_H
20
21 extern const char compile_time_interop_options[];
22
23 extern void init_constants(void);
24
25 /*
26 * NOTE:For debugging purposes, constants.c has tables to map numbers back to names.
27 * Any changes here should be reflected there.
28 */
29
30 #define elemsof(array) (sizeof(array) / sizeof(*(array))) /* number of elements in an array */
31
32 /* Many routines return only success or failure, but wish to describe
33 * the failure in a message. We use the convention that they return
34 * a NULL on success and a pointer to constant string on failure.
35 * The fact that the string is a constant is limiting, but it
36 * avoids storage management issues: the recipient is allowed to assume
37 * that the string will live "long enough" (usually forever).
38 * <freeswan.h> defines err_t for this return type.
39 */
40
41 typedef int bool;
42 #define FALSE 0
43 #define TRUE 1
44
45 #define NULL_FD (-1) /* NULL file descriptor */
46 #define dup_any(fd) ((fd) == NULL_FD? NULL_FD : dup(fd))
47 #define close_any(fd) { if ((fd) != NULL_FD) { close(fd); (fd) = NULL_FD; } }
48
49 #define BITS_PER_BYTE 8
50
51 #define streq(a, b) (strcmp((a), (b)) == 0) /* clearer shorthand */
52 #define strcaseeq(a, b) (strcasecmp((a), (b)) == 0) /* clearer shorthand */
53
54 /* set type with room for at least 64 elements for ALG opts (was 32 in stock FS) */
55
56 typedef unsigned long long lset_t;
57 #define LEMPTY 0ULL
58 #define LELEM(opt) (1ULL << (opt))
59 #define LRANGE(lwb, upb) LRANGES(LELEM(lwb), LELEM(upb))
60 #define LRANGES(first, last) (last - first + last)
61 #define LHAS(set, elem) ((LELEM(elem) & (set)) != LEMPTY)
62 #define LIN(subset, set) (((subset) & (set)) == (subset))
63 #define LDISJOINT(a, b) (((a) & (b)) == LEMPTY)
64
65 /* Control and lock pathnames */
66 #ifndef IPSEC_PIDDIR
67 # define IPSEC_PIDDIR "/var/run"
68 #endif
69 #ifndef DEFAULT_CTLBASE
70 # define DEFAULT_CTLBASE IPSEC_PIDDIR "/pluto"
71 #endif
72
73 #define CTL_SUFFIX ".ctl" /* for UNIX domain socket pathname */
74 #define LOCK_SUFFIX ".pid" /* for pluto's lock */
75 #define INFO_SUFFIX ".info" /* for UNIX domain socket for apps */
76
77 /* Routines to check and display values.
78 *
79 * An enum_names describes an enumeration.
80 * enum_name() returns the name of an enum value, or NULL if invalid.
81 * enum_show() is like enum_name, except it formats a numeric representation
82 * for any invalid value (in a static area!)
83 *
84 * bitnames() formats a display of a set of named bits (in a static area)
85 */
86
87 struct enum_names {
88 unsigned long en_first; /* first value in range */
89 unsigned long en_last; /* last value in range (inclusive) */
90 const char *const *en_names;
91 const struct enum_names *en_next_range; /* descriptor of next range */
92 };
93
94 typedef const struct enum_names enum_names;
95
96 extern const char *enum_name(enum_names *ed, unsigned long val);
97 extern const char *enum_show(enum_names *ed, unsigned long val);
98 extern int enum_search(enum_names *ed, const char *string);
99
100 extern bool testset(const char *const table[], lset_t val);
101 extern const char *bitnamesof(const char *const table[], lset_t val);
102
103 /* sparse_names is much like enum_names, except values are
104 * not known to be contiguous or ordered.
105 * The array of names is ended with one with the name sparse_end
106 * (this avoids having to reserve a value to signify the end).
107 * Often appropriate for enums defined by others.
108 */
109 struct sparse_name {
110 unsigned long val;
111 const char *const name;
112 };
113 typedef const struct sparse_name sparse_names[];
114
115 extern const char *sparse_name(sparse_names sd, unsigned long val);
116 extern const char *sparse_val_show(sparse_names sd, unsigned long val);
117 extern const char sparse_end[];
118
119 #define FULL_INET_ADDRESS_SIZE 6
120
121 /* Group parameters from draft-ietf-ike-01.txt section 6 */
122
123 #define MODP_GENERATOR "2"
124
125 #define MODP768_MODULUS \
126 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 " \
127 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD " \
128 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245 " \
129 "E485B576 625E7EC6 F44C42E9 A63A3620 FFFFFFFF FFFFFFFF"
130
131 #define MODP1024_MODULUS \
132 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 " \
133 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD " \
134 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245 " \
135 "E485B576 625E7EC6 F44C42E9 A637ED6B 0BFF5CB6 F406B7ED " \
136 "EE386BFB 5A899FA5 AE9F2411 7C4B1FE6 49286651 ECE65381 " \
137 "FFFFFFFF FFFFFFFF"
138
139 #define MODP1536_MODULUS \
140 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 " \
141 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD " \
142 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245 " \
143 "E485B576 625E7EC6 F44C42E9 A637ED6B 0BFF5CB6 F406B7ED " \
144 "EE386BFB 5A899FA5 AE9F2411 7C4B1FE6 49286651 ECE45B3D " \
145 "C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8 FD24CF5F " \
146 "83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D " \
147 "670C354E 4ABC9804 F1746C08 CA237327 FFFFFFFF FFFFFFFF "
148
149 /* draft-ietf-ipsec-ike-modp-groups-03.txt */
150 #define MODP2048_MODULUS \
151 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1" \
152 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD" \
153 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245" \
154 "E485B576 625E7EC6 F44C42E9 A637ED6B 0BFF5CB6 F406B7ED" \
155 "EE386BFB 5A899FA5 AE9F2411 7C4B1FE6 49286651 ECE45B3D" \
156 "C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8 FD24CF5F" \
157 "83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D" \
158 "670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B" \
159 "E39E772C 180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9" \
160 "DE2BCBF6 95581718 3995497C EA956AE5 15D22618 98FA0510" \
161 "15728E5A 8AACAA68 FFFFFFFF FFFFFFFF"
162
163 #define MODP3072_MODULUS \
164 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1" \
165 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD" \
166 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245" \
167 "E485B576 625E7EC6 F44C42E9 A637ED6B 0BFF5CB6 F406B7ED" \
168 "EE386BFB 5A899FA5 AE9F2411 7C4B1FE6 49286651 ECE45B3D" \
169 "C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8 FD24CF5F" \
170 "83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D" \
171 "670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B" \
172 "E39E772C 180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9" \
173 "DE2BCBF6 95581718 3995497C EA956AE5 15D22618 98FA0510" \
174 "15728E5A 8AAAC42D AD33170D 04507A33 A85521AB DF1CBA64" \
175 "ECFB8504 58DBEF0A 8AEA7157 5D060C7D B3970F85 A6E1E4C7" \
176 "ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226 1AD2EE6B" \
177 "F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C" \
178 "BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31" \
179 "43DB5BFC E0FD108E 4B82D120 A93AD2CA FFFFFFFF FFFFFFFF"
180
181 #define MODP4096_MODULUS \
182 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1" \
183 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD" \
184 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245" \
185 "E485B576 625E7EC6 F44C42E9 A637ED6B 0BFF5CB6 F406B7ED" \
186 "EE386BFB 5A899FA5 AE9F2411 7C4B1FE6 49286651 ECE45B3D" \
187 "C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8 FD24CF5F" \
188 "83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D" \
189 "670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B" \
190 "E39E772C 180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9" \
191 "DE2BCBF6 95581718 3995497C EA956AE5 15D22618 98FA0510" \
192 "15728E5A 8AAAC42D AD33170D 04507A33 A85521AB DF1CBA64" \
193 "ECFB8504 58DBEF0A 8AEA7157 5D060C7D B3970F85 A6E1E4C7" \
194 "ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226 1AD2EE6B" \
195 "F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C" \
196 "BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31" \
197 "43DB5BFC E0FD108E 4B82D120 A9210801 1A723C12 A787E6D7" \
198 "88719A10 BDBA5B26 99C32718 6AF4E23C 1A946834 B6150BDA" \
199 "2583E9CA 2AD44CE8 DBBBC2DB 04DE8EF9 2E8EFC14 1FBECAA6" \
200 "287C5947 4E6BC05D 99B2964F A090C3A2 233BA186 515BE7ED" \
201 "1F612970 CEE2D7AF B81BDD76 2170481C D0069127 D5B05AA9" \
202 "93B4EA98 8D8FDDC1 86FFB7DC 90A6C08F 4DF435C9 34063199" \
203 "FFFFFFFF FFFFFFFF"
204
205 /* copy&pasted from rfc3526: */
206 #define MODP6144_MODULUS \
207 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 29024E08" \
208 "8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD EF9519B3 CD3A431B" \
209 "302B0A6D F25F1437 4FE1356D 6D51C245 E485B576 625E7EC6 F44C42E9" \
210 "A637ED6B 0BFF5CB6 F406B7ED EE386BFB 5A899FA5 AE9F2411 7C4B1FE6" \
211 "49286651 ECE45B3D C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8" \
212 "FD24CF5F 83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D" \
213 "670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B E39E772C" \
214 "180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9 DE2BCBF6 95581718" \
215 "3995497C EA956AE5 15D22618 98FA0510 15728E5A 8AAAC42D AD33170D" \
216 "04507A33 A85521AB DF1CBA64 ECFB8504 58DBEF0A 8AEA7157 5D060C7D" \
217 "B3970F85 A6E1E4C7 ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226" \
218 "1AD2EE6B F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C" \
219 "BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31 43DB5BFC" \
220 "E0FD108E 4B82D120 A9210801 1A723C12 A787E6D7 88719A10 BDBA5B26" \
221 "99C32718 6AF4E23C 1A946834 B6150BDA 2583E9CA 2AD44CE8 DBBBC2DB" \
222 "04DE8EF9 2E8EFC14 1FBECAA6 287C5947 4E6BC05D 99B2964F A090C3A2" \
223 "233BA186 515BE7ED 1F612970 CEE2D7AF B81BDD76 2170481C D0069127" \
224 "D5B05AA9 93B4EA98 8D8FDDC1 86FFB7DC 90A6C08F 4DF435C9 34028492" \
225 "36C3FAB4 D27C7026 C1D4DCB2 602646DE C9751E76 3DBA37BD F8FF9406" \
226 "AD9E530E E5DB382F 413001AE B06A53ED 9027D831 179727B0 865A8918" \
227 "DA3EDBEB CF9B14ED 44CE6CBA CED4BB1B DB7F1447 E6CC254B 33205151" \
228 "2BD7AF42 6FB8F401 378CD2BF 5983CA01 C64B92EC F032EA15 D1721D03" \
229 "F482D7CE 6E74FEF6 D55E702F 46980C82 B5A84031 900B1C9E 59E7C97F" \
230 "BEC7E8F3 23A97A7E 36CC88BE 0F1D45B7 FF585AC5 4BD407B2 2B4154AA" \
231 "CC8F6D7E BF48E1D8 14CC5ED2 0F8037E0 A79715EE F29BE328 06A1D58B" \
232 "B7C5DA76 F550AA3D 8A1FBFF0 EB19CCB1 A313D55C DA56C9EC 2EF29632" \
233 "387FE8D7 6E3C0468 043E8F66 3F4860EE 12BF2D5B 0B7474D6 E694F91E" \
234 "6DCC4024 FFFFFFFF FFFFFFFF"
235
236 /* copy&pasted from rfc3526: */
237 #define MODP8192_MODULUS \
238 "FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1" \
239 "29024E08 8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD" \
240 "EF9519B3 CD3A431B 302B0A6D F25F1437 4FE1356D 6D51C245" \
241 "E485B576 625E7EC6 F44C42E9 A637ED6B 0BFF5CB6 F406B7ED" \
242 "EE386BFB 5A899FA5 AE9F2411 7C4B1FE6 49286651 ECE45B3D" \
243 "C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8 FD24CF5F" \
244 "83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D" \
245 "670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B" \
246 "E39E772C 180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9" \
247 "DE2BCBF6 95581718 3995497C EA956AE5 15D22618 98FA0510" \
248 "15728E5A 8AAAC42D AD33170D 04507A33 A85521AB DF1CBA64" \
249 "ECFB8504 58DBEF0A 8AEA7157 5D060C7D B3970F85 A6E1E4C7" \
250 "ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226 1AD2EE6B" \
251 "F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C" \
252 "BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31" \
253 "43DB5BFC E0FD108E 4B82D120 A9210801 1A723C12 A787E6D7" \
254 "88719A10 BDBA5B26 99C32718 6AF4E23C 1A946834 B6150BDA" \
255 "2583E9CA 2AD44CE8 DBBBC2DB 04DE8EF9 2E8EFC14 1FBECAA6" \
256 "287C5947 4E6BC05D 99B2964F A090C3A2 233BA186 515BE7ED" \
257 "1F612970 CEE2D7AF B81BDD76 2170481C D0069127 D5B05AA9" \
258 "93B4EA98 8D8FDDC1 86FFB7DC 90A6C08F 4DF435C9 34028492" \
259 "36C3FAB4 D27C7026 C1D4DCB2 602646DE C9751E76 3DBA37BD" \
260 "F8FF9406 AD9E530E E5DB382F 413001AE B06A53ED 9027D831" \
261 "179727B0 865A8918 DA3EDBEB CF9B14ED 44CE6CBA CED4BB1B" \
262 "DB7F1447 E6CC254B 33205151 2BD7AF42 6FB8F401 378CD2BF" \
263 "5983CA01 C64B92EC F032EA15 D1721D03 F482D7CE 6E74FEF6" \
264 "D55E702F 46980C82 B5A84031 900B1C9E 59E7C97F BEC7E8F3" \
265 "23A97A7E 36CC88BE 0F1D45B7 FF585AC5 4BD407B2 2B4154AA" \
266 "CC8F6D7E BF48E1D8 14CC5ED2 0F8037E0 A79715EE F29BE328" \
267 "06A1D58B B7C5DA76 F550AA3D 8A1FBFF0 EB19CCB1 A313D55C" \
268 "DA56C9EC 2EF29632 387FE8D7 6E3C0468 043E8F66 3F4860EE" \
269 "12BF2D5B 0B7474D6 E694F91E 6DBE1159 74A3926F 12FEE5E4" \
270 "38777CB6 A932DF8C D8BEC4D0 73B931BA 3BC832B6 8D9DD300" \
271 "741FA7BF 8AFC47ED 2576F693 6BA42466 3AAB639C 5AE4F568" \
272 "3423B474 2BF1C978 238F16CB E39D652D E3FDB8BE FC848AD9" \
273 "22222E04 A4037C07 13EB57A8 1A23F0C7 3473FC64 6CEA306B" \
274 "4BCBC886 2F8385DD FA9D4B7F A2C087E8 79683303 ED5BDD3A" \
275 "062B3CF5 B3A278A6 6D2A13F8 3F44F82D DF310EE0 74AB6A36" \
276 "4597E899 A0255DC1 64F31CC5 0846851D F9AB4819 5DED7EA1" \
277 "B1D510BD 7EE74D73 FAF36BC3 1ECFA268 359046F4 EB879F92" \
278 "4009438B 481C6CD7 889A002E D5EE382B C9190DA6 FC026E47" \
279 "9558E447 5677E9AA 9E3050E2 765694DF C81F56E8 80B96E71" \
280 "60C980DD 98EDD3DF FFFFFFFF FFFFFFFF"
281 #define LOCALSECRETSIZE (256 / BITS_PER_BYTE)
282
283 /* limits on nonce sizes. See RFC2409 "The internet key exchange (IKE)" 5 */
284 #define MINIMUM_NONCE_SIZE 8 /* bytes */
285 #define DEFAULT_NONCE_SIZE 16 /* bytes */
286 #define MAXIMUM_NONCE_SIZE 256 /* bytes */
287
288 #define COOKIE_SIZE 8
289 #define MAX_ISAKMP_SPI_SIZE 16
290
291 #define MD2_DIGEST_SIZE (128 / BITS_PER_BYTE) /* ought to be supplied by md2.h */
292 #define MD5_DIGEST_SIZE (128 / BITS_PER_BYTE) /* ought to be supplied by md5.h */
293 #define SHA1_DIGEST_SIZE (160 / BITS_PER_BYTE) /* ought to be supplied by sha1.h */
294
295 #define DES_CBC_BLOCK_SIZE (64 / BITS_PER_BYTE)
296
297 #define DSS_QBITS 160 /* bits in DSS's "q" (FIPS 186-1) */
298
299 /* to statically allocate IV, we need max of
300 * MD5_DIGEST_SIZE, SHA1_DIGEST_SIZE, and DES_CBC_BLOCK_SIZE.
301 * To avoid combinatorial explosion, we leave out DES_CBC_BLOCK_SIZE.
302 */
303 #define MAX_DIGEST_LEN_OLD (MD5_DIGEST_SIZE > SHA1_DIGEST_SIZE? MD5_DIGEST_SIZE : SHA1_DIGEST_SIZE)
304
305 /* for max: SHA2_512 */
306 #define MAX_DIGEST_LEN (512/BITS_PER_BYTE)
307
308 /* RFC 2404 "HMAC-SHA-1-96" section 3 */
309 #define HMAC_SHA1_KEY_LEN SHA1_DIGEST_SIZE
310
311 /* RFC 2403 "HMAC-MD5-96" section 3 */
312 #define HMAC_MD5_KEY_LEN MD5_DIGEST_SIZE
313
314 #define IKE_UDP_PORT 500
315
316 /* RFC 2560 OCSP - certificate status */
317
318 typedef enum {
319 CERT_GOOD = 0,
320 CERT_REVOKED = 1,
321 CERT_UNKNOWN = 2,
322 CERT_UNDEFINED = 3
323 } cert_status_t;
324
325 /* RFC 2459 CRL reason codes */
326
327 extern enum_names crl_reason_names;
328
329 typedef enum {
330 REASON_UNSPECIFIED = 0,
331 REASON_KEY_COMPROMISE = 1,
332 REASON_CA_COMPROMISE = 2,
333 REASON_AFFILIATION_CHANGED = 3,
334 REASON_SUPERSEDED = 4,
335 REASON_CESSATION_OF_OPERATON = 5,
336 REASON_CERTIFICATE_HOLD = 6,
337 REASON_REMOVE_FROM_CRL = 8
338 } crl_reason_t;
339
340 /* RFC 3706 Dead Peer Detection */
341
342 extern enum_names dpd_action_names;
343
344 typedef enum {
345 DPD_ACTION_NONE = 0,
346 DPD_ACTION_CLEAR = 1,
347 DPD_ACTION_HOLD = 2,
348 DPD_ACTION_RESTART = 3,
349 DPD_ACTION_UNKNOWN = 4
350 } dpd_action_t;
351
352 /* Timer events */
353
354 extern enum_names timer_event_names;
355
356 enum event_type {
357 EVENT_NULL, /* non-event */
358 EVENT_REINIT_SECRET, /* Refresh cookie secret */
359 #ifdef KLIPS
360 EVENT_SHUNT_SCAN, /* scan shunt eroutes known to kernel */
361 #endif
362 EVENT_SO_DISCARD, /* discard unfinished state object */
363 EVENT_RETRANSMIT, /* Retransmit packet */
364 EVENT_SA_REPLACE, /* SA replacement event */
365 EVENT_SA_REPLACE_IF_USED, /* SA replacement event */
366 EVENT_SA_EXPIRE, /* SA expiration event */
367 EVENT_NAT_T_KEEPALIVE, /* NAT Traversal Keepalive */
368 EVENT_DPD, /* dead peer detection */
369 EVENT_DPD_TIMEOUT, /* dead peer detection timeout */
370 EVENT_LOG_DAILY /* reset certain log events/stats */
371 };
372
373 #define EVENT_REINIT_SECRET_DELAY 3600 /* 1 hour */
374 #define EVENT_RETRANSMIT_DELAY_0 10 /* 10 seconds */
375
376 /* Misc. stuff */
377
378 #define MAXIMUM_RETRANSMISSIONS 2
379 #define MAXIMUM_RETRANSMISSIONS_INITIAL 20
380
381 #define MAX_INPUT_UDP_SIZE 65536
382 #define MAX_OUTPUT_UDP_SIZE 65536
383
384 /* Version numbers */
385
386 #define ISAKMP_MAJOR_VERSION 0x1
387 #define ISAKMP_MINOR_VERSION 0x0
388
389 extern enum_names version_names;
390
391 /* Domain of Interpretation */
392
393 extern enum_names doi_names;
394
395 #define ISAKMP_DOI_ISAKMP 0
396 #define ISAKMP_DOI_IPSEC 1
397
398 /* IPsec DOI things */
399
400 #define IPSEC_DOI_SITUATION_LENGTH 4
401 #define IPSEC_DOI_LDI_LENGTH 4
402 #define IPSEC_DOI_SPI_SIZE 4
403
404 /* SPI value 0 is invalid and values 1-255 are reserved to IANA.
405 * ESP: RFC 2402 2.4; AH: RFC 2406 2.1
406 * IPComp RFC 2393 substitutes a CPI in the place of an SPI.
407 * see also draft-shacham-ippcp-rfc2393bis-05.txt.
408 * We (FreeS/WAN) reserve 0x100 to 0xFFF for manual keying, so
409 * Pluto won't generate these values.
410 */
411 #define IPSEC_DOI_SPI_MIN 0x100
412 #define IPSEC_DOI_SPI_OUR_MIN 0x1000
413
414 /* debugging settings: a set of selections for reporting
415 * These would be more naturally situated in log.h,
416 * but they are shared with whack.
417 * IMPAIR_* actually change behaviour, usually badly,
418 * to aid in testing. Naturally, these are not included in ALL.
419 *
420 * NOTE: changes here must be done in concert with changes to DBGOPT_*
421 * in whack.c. A change to WHACK_MAGIC in whack.h will be required too.
422 */
423 #ifdef DEBUG
424 extern const char *const debug_bit_names[];
425 #endif
426
427 #define DBG_RAW LELEM(0) /* raw packet I/O */
428 #define DBG_CRYPT LELEM(1) /* encryption/decryption of messages */
429 #define DBG_PARSING LELEM(2) /* show decoding of messages */
430 #define DBG_EMITTING LELEM(3) /* show encoding of messages */
431 #define DBG_CONTROL LELEM(4) /* control flow within Pluto */
432 #define DBG_LIFECYCLE LELEM(5) /* SA lifecycle */
433 #define DBG_KLIPS LELEM(6) /* messages to KLIPS */
434 #define DBG_DNS LELEM(7) /* DNS activity */
435 #define DBG_NATT LELEM(8) /* NAT-T */
436 #define DBG_OPPO LELEM(9) /* opportunism */
437 #define DBG_CONTROLMORE LELEM(10) /* more detailed debugging */
438
439 #define DBG_PRIVATE LELEM(11) /* private information: DANGER! */
440
441 #define IMPAIR0 12 /* first bit for IMPAIR_* */
442
443 #define IMPAIR_DELAY_ADNS_KEY_ANSWER LELEM(IMPAIR0+0) /* sleep before answering */
444 #define IMPAIR_DELAY_ADNS_TXT_ANSWER LELEM(IMPAIR0+1) /* sleep before answering */
445 #define IMPAIR_BUST_MI2 LELEM(IMPAIR0+2) /* make MI2 really large */
446 #define IMPAIR_BUST_MR2 LELEM(IMPAIR0+3) /* make MI2 really large */
447
448 #define DBG_NONE 0 /* no options on, including impairments */
449 #define DBG_ALL LRANGES(DBG_RAW, DBG_CONTROLMORE) /* all logging options on EXCEPT DBG_PRIVATE */
450
451 /* State of exchanges
452 *
453 * The name of the state describes the last message sent, not the
454 * message currently being input or output (except during retry).
455 * In effect, the state represents the last completed action.
456 *
457 * Messages are named [MQ][IR]n where
458 * - M stands for Main Mode (Phase 1);
459 * Q stands for Quick Mode (Phase 2)
460 * - I stands for Initiator;
461 * R stands for Responder
462 * - n, a digit, stands for the number of the message
463 *
464 * It would be more convenient if each state accepted a message
465 * and produced one. This is the case for states at the start
466 * or end of an exchange. To fix this, we pretend that there are
467 * MR0 and QR0 messages before the MI1 and QR1 messages. Similarly,
468 * we pretend that there are MR4 and QR2 messages.
469 *
470 * STATE_MAIN_R0 and STATE_QUICK_R0 are intermediate states (not
471 * retained between messages) representing the state that accepts the
472 * first message of an exchange has been read but not processed.
473 *
474 * state_microcode state_microcode_table in demux.c describes
475 * other important details.
476 */
477
478 extern enum_names state_names;
479 extern const char *const state_story[];
480
481 enum state_kind {
482 STATE_UNDEFINED, /* 0 -- most likely accident */
483
484 /* Opportunism states: see "Opportunistic Encryption" 2.2 */
485
486 OPPO_ACQUIRE, /* got an ACQUIRE message for this pair */
487 OPPO_GW_DISCOVERED, /* got TXT specifying gateway */
488
489 /* IKE states */
490
491 STATE_MAIN_R0,
492 STATE_MAIN_I1,
493 STATE_MAIN_R1,
494 STATE_MAIN_I2,
495 STATE_MAIN_R2,
496 STATE_MAIN_I3,
497 STATE_MAIN_R3,
498 STATE_MAIN_I4,
499
500 STATE_QUICK_R0,
501 STATE_QUICK_I1,
502 STATE_QUICK_R1,
503 STATE_QUICK_I2,
504 STATE_QUICK_R2,
505
506 STATE_INFO,
507 STATE_INFO_PROTECTED,
508
509 /* XAUTH states */
510
511 STATE_XAUTH_I0, /* initiator state (client) */
512 STATE_XAUTH_R1, /* responder state (server) */
513 STATE_XAUTH_I1,
514 STATE_XAUTH_R2,
515 STATE_XAUTH_I2,
516 STATE_XAUTH_R3,
517
518
519 /* Mode Config pull states */
520
521 STATE_MODE_CFG_R0, /* responder state (server) */
522 STATE_MODE_CFG_I1, /* initiator state (client) */
523 STATE_MODE_CFG_R1,
524 STATE_MODE_CFG_I2,
525
526 /* Mode Config push states */
527
528 STATE_MODE_CFG_I0, /* initiator state (client) */
529 STATE_MODE_CFG_R3, /* responder state (server) */
530 STATE_MODE_CFG_I3,
531 STATE_MODE_CFG_R4,
532
533 STATE_IKE_ROOF
534 };
535
536 #define STATE_IKE_FLOOR STATE_MAIN_R0
537
538 #define PHASE1_INITIATOR_STATES (LELEM(STATE_MAIN_I1) | LELEM(STATE_MAIN_I2) \
539 | LELEM(STATE_MAIN_I3) | LELEM(STATE_MAIN_I4))
540 #define ISAKMP_SA_ESTABLISHED_STATES ( \
541 LELEM(STATE_MAIN_R3) | LELEM(STATE_MAIN_I4) \
542 | LELEM(STATE_XAUTH_R1) | LELEM(STATE_XAUTH_R2) | LELEM(STATE_XAUTH_R3) \
543 | LELEM(STATE_XAUTH_I1) | LELEM(STATE_XAUTH_I2) \
544 | LELEM(STATE_MODE_CFG_I1) | LELEM(STATE_MODE_CFG_R1) | LELEM(STATE_MODE_CFG_I2) \
545 | LELEM(STATE_MODE_CFG_R3) | LELEM(STATE_MODE_CFG_I3) | LELEM(STATE_MODE_CFG_R4))
546
547 #define IS_PHASE1(s) ((STATE_MAIN_R0 <= (s) && (s) <= STATE_MAIN_I4) \
548 || (STATE_XAUTH_I0 <= (s) && (s) <= STATE_XAUTH_R3) \
549 || (STATE_MODE_CFG_R0 <= (s) && (s) <= STATE_MODE_CFG_R4))
550
551 #define IS_QUICK(s) (STATE_QUICK_R0 <= (s) && (s) <= STATE_QUICK_R2)
552 #define IS_ISAKMP_ENCRYPTED(s) (STATE_MAIN_I2 <= (s))
553
554 #define IS_ISAKMP_SA_ESTABLISHED(s) ( \
555 (s) == STATE_MAIN_R3 \
556 || (s) == STATE_MAIN_I4 \
557 || (s) == STATE_XAUTH_R3 \
558 || (s) == STATE_XAUTH_I2 \
559 || (s) == STATE_MODE_CFG_R1 \
560 || (s) == STATE_MODE_CFG_I2 \
561 || (s) == STATE_MODE_CFG_I3 \
562 || (s) == STATE_MODE_CFG_R4)
563
564 #define IS_IPSEC_SA_ESTABLISHED(s) ((s) == STATE_QUICK_I2 || (s) == STATE_QUICK_R2)
565 #define IS_ONLY_INBOUND_IPSEC_SA_ESTABLISHED(s) ((s) == STATE_QUICK_R1)
566
567 /* kind of struct connection
568 * Ordered (mostly) by concreteness. Order is exploited.
569 */
570
571 extern enum_names connection_kind_names;
572
573 enum connection_kind {
574 CK_GROUP, /* policy group: instantiates to template */
575 CK_TEMPLATE, /* abstract connection, with wildcard */
576 CK_PERMANENT, /* normal connection */
577 CK_INSTANCE, /* instance of template, created for a particular attempt */
578 CK_GOING_AWAY /* instance being deleted -- don't delete again */
579 };
580
581
582 /* routing status.
583 * Note: routing ignores source address, but erouting does not!
584 * Note: a connection can only be routed if it is NEVER_NEGOTIATE
585 * or HAS_IPSEC_POLICY.
586 */
587
588 extern enum_names routing_story;
589
590 /* note that this is assumed to be ordered! */
591 enum routing_t {
592 RT_UNROUTED, /* unrouted */
593 RT_UNROUTED_HOLD, /* unrouted, but HOLD shunt installed */
594 RT_ROUTED_ECLIPSED, /* RT_ROUTED_PROSPECTIVE except bare HOLD or instance has eroute */
595 RT_ROUTED_PROSPECTIVE, /* routed, and prospective shunt installed */
596 RT_ROUTED_HOLD, /* routed, and HOLD shunt installed */
597 RT_ROUTED_FAILURE, /* routed, and failure-context shunt installed */
598 RT_ROUTED_TUNNEL, /* routed, and erouted to an IPSEC SA group */
599 RT_UNROUTED_KEYED /* keyed, but not routed, on purpose */
600 };
601
602 #define routed(rs) ((rs) > RT_UNROUTED_HOLD)
603 #define erouted(rs) ((rs) != RT_UNROUTED)
604 #define shunt_erouted(rs) (erouted(rs) && (rs) != RT_ROUTED_TUNNEL)
605
606 /* Payload types
607 * RFC2408 Internet Security Association and Key Management Protocol (ISAKMP)
608 * section 3.1
609 *
610 * RESERVED 14-127
611 * Private USE 128-255
612 */
613
614 extern enum_names payload_names;
615 extern const char *const payload_name[];
616
617 #define ISAKMP_NEXT_NONE 0 /* No other payload following */
618 #define ISAKMP_NEXT_SA 1 /* Security Association */
619 #define ISAKMP_NEXT_P 2 /* Proposal */
620 #define ISAKMP_NEXT_T 3 /* Transform */
621 #define ISAKMP_NEXT_KE 4 /* Key Exchange */
622 #define ISAKMP_NEXT_ID 5 /* Identification */
623 #define ISAKMP_NEXT_CERT 6 /* Certificate */
624 #define ISAKMP_NEXT_CR 7 /* Certificate Request */
625 #define ISAKMP_NEXT_HASH 8 /* Hash */
626 #define ISAKMP_NEXT_SIG 9 /* Signature */
627 #define ISAKMP_NEXT_NONCE 10 /* Nonce */
628 #define ISAKMP_NEXT_N 11 /* Notification */
629 #define ISAKMP_NEXT_D 12 /* Delete */
630 #define ISAKMP_NEXT_VID 13 /* Vendor ID */
631 #define ISAKMP_NEXT_ATTR 14 /* Mode config Attribute */
632
633 #define ISAKMP_NEXT_NATD_RFC 20 /* NAT-Traversal: NAT-D (rfc) */
634 #define ISAKMP_NEXT_NATOA_RFC 21 /* NAT-Traversal: NAT-OA (rfc) */
635 #define ISAKMP_NEXT_ROOF 22 /* roof on payload types */
636
637 #define ISAKMP_NEXT_NATD_DRAFTS 130 /* NAT-Traversal: NAT-D (drafts) */
638 #define ISAKMP_NEXT_NATOA_DRAFTS 131 /* NAT-Traversal: NAT-OA (drafts) */
639
640 /* These values are to be used within the Type field of an Attribute (14)
641 * ISAKMP payload.
642 */
643 #define ISAKMP_CFG_REQUEST 1
644 #define ISAKMP_CFG_REPLY 2
645 #define ISAKMP_CFG_SET 3
646 #define ISAKMP_CFG_ACK 4
647
648 extern enum_names attr_msg_type_names;
649
650 /* Mode Config attribute values */
651 #define INTERNAL_IP4_ADDRESS 1
652 #define INTERNAL_IP4_NETMASK 2
653 #define INTERNAL_IP4_DNS 3
654 #define INTERNAL_IP4_NBNS 4
655 #define INTERNAL_ADDRESS_EXPIRY 5
656 #define INTERNAL_IP4_DHCP 6
657 #define APPLICATION_VERSION 7
658 #define INTERNAL_IP6_ADDRESS 8
659 #define INTERNAL_IP6_NETMASK 9
660 #define INTERNAL_IP6_DNS 10
661 #define INTERNAL_IP6_NBNS 11
662 #define INTERNAL_IP6_DHCP 12
663 #define INTERNAL_IP4_SUBNET 13
664 #define SUPPORTED_ATTRIBUTES 14
665 #define INTERNAL_IP6_SUBNET 15
666
667 #define MODECFG_ROOF 16
668
669 extern enum_names modecfg_attr_names;
670 /* XAUTH attribute values */
671 #define XAUTH_TYPE 16520
672 #define XAUTH_USER_NAME 16521
673 #define XAUTH_USER_PASSWORD 16522
674 #define XAUTH_PASSCODE 16523
675 #define XAUTH_MESSAGE 16524
676 #define XAUTH_CHALLENGE 16525
677 #define XAUTH_DOMAIN 16526
678 #define XAUTH_STATUS 16527
679 #define XAUTH_NEXT_PIN 16528
680 #define XAUTH_ANSWER 16529
681
682 #define XAUTH_BASE XAUTH_TYPE
683
684 extern enum_names xauth_attr_names;
685
686 /* XAUTH authentication types */
687 #define XAUTH_TYPE_GENERIC 0
688 #define XAUTH_TYPE_CHAP 1
689 #define XAUTH_TYPE_OTP 2
690 #define XAUTH_TYPE_SKEY 3
691
692 extern enum_names xauth_type_names;
693
694 /* Exchange types
695 * RFC2408 "Internet Security Association and Key Management Protocol (ISAKMP)"
696 * section 3.1
697 *
698 * ISAKMP Future Use 6 - 31
699 * DOI Specific Use 32 - 239
700 * Private Use 240 - 255
701 *
702 * Note: draft-ietf-ipsec-dhless-enc-mode-00.txt Appendix A
703 * defines "DHless RSA Encryption" as 6.
704 */
705
706 extern enum_names exchange_names;
707
708 #define ISAKMP_XCHG_NONE 0
709 #define ISAKMP_XCHG_BASE 1
710 #define ISAKMP_XCHG_IDPROT 2 /* ID Protection */
711 #define ISAKMP_XCHG_AO 3 /* Authentication Only */
712 #define ISAKMP_XCHG_AGGR 4 /* Aggressive */
713 #define ISAKMP_XCHG_INFO 5 /* Informational */
714 #define ISAKMP_XCHG_MODE_CFG 6 /* Mode Config */
715
716 /* Extra exchange types, defined by Oakley
717 * RFC2409 "The Internet Key Exchange (IKE)", near end of Appendix A
718 */
719 #define ISAKMP_XCHG_QUICK 32 /* Oakley Quick Mode */
720 #define ISAKMP_XCHG_NGRP 33 /* Oakley New Group Mode */
721 /* added in draft-ietf-ipsec-ike-01.txt, near end of Appendix A */
722 #define ISAKMP_XCHG_ACK_INFO 34 /* Oakley Acknowledged Informational */
723
724 /* Flag bits */
725
726 extern const char *const flag_bit_names[];
727
728 #define ISAKMP_FLAG_ENCRYPTION 0x1
729 #define ISAKMP_FLAG_COMMIT 0x2
730
731 /* Situation definition for IPsec DOI */
732
733 extern const char *const sit_bit_names[];
734
735 #define SIT_IDENTITY_ONLY 0x01
736 #define SIT_SECRECY 0x02
737 #define SIT_INTEGRITY 0x04
738
739 /* Protocol IDs
740 * RFC2407 The Internet IP security Domain of Interpretation for ISAKMP 4.4.1
741 */
742
743 extern enum_names protocol_names;
744
745 #define PROTO_ISAKMP 1
746 #define PROTO_IPSEC_AH 2
747 #define PROTO_IPSEC_ESP 3
748 #define PROTO_IPCOMP 4
749
750 /* warning: trans_show uses enum_show, so same static buffer is used */
751 #define trans_show(p, t) \
752 ((p)==PROTO_IPSEC_AH ? enum_show(&ah_transformid_names, (t)) \
753 : (p)==PROTO_IPSEC_ESP ? enum_show(&esp_transformid_names, (t)) \
754 : (p)==PROTO_IPCOMP ? enum_show(&ipcomp_transformid_names, (t)) \
755 : "??")
756
757 /* many transform values are moved to freeswan/ipsec_policy.h */
758
759 extern enum_names isakmp_transformid_names;
760
761 #define KEY_IKE 1
762
763 extern enum_names ah_transformid_names;
764 extern enum_names esp_transformid_names;
765 extern enum_names ipcomp_transformid_names;
766
767 /* the following are from RFC 2393/draft-shacham-ippcp-rfc2393bis-05.txt 3.3 */
768 typedef u_int16_t cpi_t;
769 #define IPCOMP_CPI_SIZE 2
770 #define IPCOMP_FIRST_NEGOTIATED 256
771 #define IPCOMP_LAST_NEGOTIATED 61439
772
773 /* Identification type values
774 * RFC 2407 The Internet IP security Domain of Interpretation for ISAKMP 4.6.2.1
775 */
776
777 extern enum_names ident_names;
778 extern enum_names cert_type_names;
779 extern enum_names cert_policy_names;
780
781 typedef enum certpolicy {
782 CERT_ALWAYS_SEND = 0, /* the default */
783 CERT_SEND_IF_ASKED = 1,
784 CERT_NEVER_SEND = 2,
785
786 CERT_YES_SEND = 3, /* synonym for CERT_ALWAYS_SEND */
787 CERT_NO_SEND = 4 /* synonym for CERT_NEVER_SEND */
788 } certpolicy_t;
789
790 /* Policies for establishing an SA
791 *
792 * These are used to specify attributes (eg. encryption) and techniques
793 * (eg PFS) for an SA.
794 * Note: certain CD_ definitions in whack.c parallel these -- keep them
795 * in sync!
796 */
797
798 extern const char *const sa_policy_bit_names[];
799 extern const char *prettypolicy(lset_t policy);
800
801 /* ISAKMP auth techniques (none means never negotiate) */
802 #define POLICY_PSK LELEM(0)
803 #define POLICY_RSASIG LELEM(1)
804
805 #define POLICY_ISAKMP_SHIFT 0 /* log2(POLICY_PSK) */
806 #define POLICY_ID_AUTH_MASK (POLICY_PSK | POLICY_RSASIG | POLICY_XAUTH_PSK | POLICY_XAUTH_RSASIG)
807 #define POLICY_ISAKMP_MASK POLICY_ID_AUTH_MASK /* all so far */
808
809 /* Quick Mode (IPSEC) attributes */
810 #define POLICY_ENCRYPT LELEM(2) /* must be first of IPSEC policies */
811 #define POLICY_AUTHENTICATE LELEM(3) /* must be second */
812 #define POLICY_COMPRESS LELEM(4) /* must be third */
813 #define POLICY_TUNNEL LELEM(5)
814 #define POLICY_PFS LELEM(6)
815 #define POLICY_DISABLEARRIVALCHECK LELEM(7) /* supress tunnel egress address checking */
816
817 #define POLICY_IPSEC_SHIFT 2 /* log2(POLICY_ENCRYPT) */
818 #define POLICY_IPSEC_MASK LRANGES(POLICY_ENCRYPT, POLICY_DISABLEARRIVALCHECK)
819
820 /* shunt attributes: what to do when routed without tunnel (2 bits) */
821 #define POLICY_SHUNT_SHIFT 8 /* log2(POLICY_SHUNT_PASS) */
822 #define POLICY_SHUNT_MASK (03ul << POLICY_SHUNT_SHIFT)
823
824 #define POLICY_SHUNT_TRAP (0ul << POLICY_SHUNT_SHIFT) /* default: negotiate */
825 #define POLICY_SHUNT_PASS (1ul << POLICY_SHUNT_SHIFT)
826 #define POLICY_SHUNT_DROP (2ul << POLICY_SHUNT_SHIFT)
827 #define POLICY_SHUNT_REJECT (3ul << POLICY_SHUNT_SHIFT)
828
829 /* fail attributes: what to do with failed negotiation (2 bits) */
830
831 #define POLICY_FAIL_SHIFT 10 /* log2(POLICY_FAIL_PASS) */
832 #define POLICY_FAIL_MASK (03ul << POLICY_FAIL_SHIFT)
833
834 #define POLICY_FAIL_NONE (0ul << POLICY_FAIL_SHIFT) /* default */
835 #define POLICY_FAIL_PASS (1ul << POLICY_FAIL_SHIFT)
836 #define POLICY_FAIL_DROP (2ul << POLICY_FAIL_SHIFT)
837 #define POLICY_FAIL_REJECT (3ul << POLICY_FAIL_SHIFT)
838
839 /* connection policy
840 * Other policies could vary per state object. These live in connection.
841 */
842 #define POLICY_DONT_REKEY LELEM(12) /* don't rekey state either Phase */
843 #define POLICY_OPPO LELEM(13) /* is this opportunistic? */
844 #define POLICY_GROUP LELEM(14) /* is this a group template? */
845 #define POLICY_GROUTED LELEM(15) /* do we want this group routed? */
846 #define POLICY_UP LELEM(16) /* do we want this up? */
847 #define POLICY_MODECFG_PUSH LELEM(17) /* is modecfg pushed by server? */
848 #define POLICY_XAUTH_PSK LELEM(18) /* do we support XAUTH????PreShared? */
849 #define POLICY_XAUTH_RSASIG LELEM(19) /* do we support XAUTH????RSA? */
850 #define POLICY_XAUTH_SERVER LELEM(20) /* are we an XAUTH server? */
851 #define POLICY_DONT_REAUTH LELEM(21) /* don't reauthenticate on rekeying, IKEv2 only */
852 #define POLICY_BEET LELEM(22) /* bound end2end tunnel, IKEv2 */
853
854 /* Any IPsec policy? If not, a connection description
855 * is only for ISAKMP SA, not IPSEC SA. (A pun, I admit.)
856 * Note: a connection can only be routed if it is NEVER_NEGOTIATE
857 * or HAS_IPSEC_POLICY.
858 */
859 #define HAS_IPSEC_POLICY(p) (((p) & POLICY_IPSEC_MASK) != 0)
860
861 /* Don't allow negotiation? */
862 #define NEVER_NEGOTIATE(p) (LDISJOINT((p), POLICY_ID_AUTH_MASK))
863
864
865 /* Oakley transform attributes
866 * draft-ietf-ipsec-ike-01.txt appendix A
867 */
868
869 extern enum_names oakley_attr_names;
870 extern const char *const oakley_attr_bit_names[];
871
872 #define OAKLEY_ENCRYPTION_ALGORITHM 1
873 #define OAKLEY_HASH_ALGORITHM 2
874 #define OAKLEY_AUTHENTICATION_METHOD 3
875 #define OAKLEY_GROUP_DESCRIPTION 4
876 #define OAKLEY_GROUP_TYPE 5
877 #define OAKLEY_GROUP_PRIME 6 /* B/V */
878 #define OAKLEY_GROUP_GENERATOR_ONE 7 /* B/V */
879 #define OAKLEY_GROUP_GENERATOR_TWO 8 /* B/V */
880 #define OAKLEY_GROUP_CURVE_A 9 /* B/V */
881 #define OAKLEY_GROUP_CURVE_B 10 /* B/V */
882 #define OAKLEY_LIFE_TYPE 11
883 #define OAKLEY_LIFE_DURATION 12 /* B/V */
884 #define OAKLEY_PRF 13
885 #define OAKLEY_KEY_LENGTH 14
886 #define OAKLEY_FIELD_SIZE 15
887 #define OAKLEY_GROUP_ORDER 16 /* B/V */
888 #define OAKLEY_BLOCK_SIZE 17
889
890 /* for each Oakley attribute, which enum_names describes its values? */
891 extern enum_names *oakley_attr_val_descs[];
892
893 /* IPsec DOI attributes
894 * RFC2407 The Internet IP security Domain of Interpretation for ISAKMP 4.5
895 */
896
897 extern enum_names ipsec_attr_names;
898
899 #define SA_LIFE_TYPE 1
900 #define SA_LIFE_DURATION 2 /* B/V */
901 #define GROUP_DESCRIPTION 3
902 #define ENCAPSULATION_MODE 4
903 #define AUTH_ALGORITHM 5
904 #define KEY_LENGTH 6
905 #define KEY_ROUNDS 7
906 #define COMPRESS_DICT_SIZE 8
907 #define COMPRESS_PRIVATE_ALG 9 /* B/V */
908
909 /* for each IPsec attribute, which enum_names describes its values? */
910 extern enum_names *ipsec_attr_val_descs[];
911
912 /* SA Lifetime Type attribute
913 * RFC2407 The Internet IP security Domain of Interpretation for ISAKMP 4.5
914 * Default time specified in 4.5
915 *
916 * There are two defaults for IPSEC SA lifetime, SA_LIFE_DURATION_DEFAULT,
917 * and PLUTO_SA_LIFE_DURATION_DEFAULT.
918 * SA_LIFE_DURATION_DEFAULT is specified in RFC2407 "The Internet IP
919 * Security Domain of Interpretation for ISAKMP" 4.5. It applies when
920 * an ISAKMP negotiation does not explicitly specify a life duration.
921 * PLUTO_SA_LIFE_DURATION_DEFAULT is specified in pluto(8). It applies
922 * when a connection description does not specify --ipseclifetime.
923 * The value of SA_LIFE_DURATION_MAXIMUM is our local policy.
924 */
925
926 extern enum_names sa_lifetime_names;
927
928 #define SA_LIFE_TYPE_SECONDS 1
929 #define SA_LIFE_TYPE_KBYTES 2
930
931 #define SA_LIFE_DURATION_DEFAULT 28800 /* eight hours (RFC2407 4.5) */
932 #define PLUTO_SA_LIFE_DURATION_DEFAULT 3600 /* one hour (pluto(8)) */
933 #define SA_LIFE_DURATION_MAXIMUM 86400 /* one day */
934
935 #define SA_REPLACEMENT_MARGIN_DEFAULT 540 /* (IPSEC & IKE) nine minutes */
936 #define SA_REPLACEMENT_FUZZ_DEFAULT 100 /* (IPSEC & IKE) 100% of MARGIN */
937 #define SA_REPLACEMENT_RETRIES_DEFAULT 3 /* (IPSEC & IKE) */
938
939 #define SA_LIFE_DURATION_K_DEFAULT 0xFFFFFFFFlu
940
941 /* Encapsulation Mode attribute */
942
943 extern enum_names enc_mode_names;
944
945 #define ENCAPSULATION_MODE_UNSPECIFIED 0 /* not legal -- used internally */
946 #define ENCAPSULATION_MODE_TUNNEL 1
947 #define ENCAPSULATION_MODE_TRANSPORT 2
948
949 #define ENCAPSULATION_MODE_UDP_TUNNEL_RFC 3
950 #define ENCAPSULATION_MODE_UDP_TRANSPORT_RFC 4
951
952 #define ENCAPSULATION_MODE_UDP_TUNNEL_DRAFTS 61443
953 #define ENCAPSULATION_MODE_UDP_TRANSPORT_DRAFTS 61444
954
955 /* Auth Algorithm attribute */
956
957 extern enum_names auth_alg_names, extended_auth_alg_names;
958
959 #define AUTH_ALGORITHM_NONE 0 /* our private designation */
960 #define AUTH_ALGORITHM_HMAC_MD5 1
961 #define AUTH_ALGORITHM_HMAC_SHA1 2
962 #define AUTH_ALGORITHM_DES_MAC 3
963 #define AUTH_ALGORITHM_KPDK 4
964 #define AUTH_ALGORITHM_HMAC_SHA2_256 5
965 #define AUTH_ALGORITHM_HMAC_SHA2_384 6
966 #define AUTH_ALGORITHM_HMAC_SHA2_512 7
967 #define AUTH_ALGORITHM_HMAC_RIPEMD 8
968 #define AUTH_ALGORITHM_NULL 251
969
970 /* Oakley Lifetime Type attribute
971 * draft-ietf-ipsec-ike-01.txt appendix A
972 * As far as I can see, there is not specification for
973 * OAKLEY_ISAKMP_SA_LIFETIME_DEFAULT. This could lead to interop problems!
974 * For no particular reason, we chose three hours.
975 * The value of OAKLEY_ISAKMP_SA_LIFETIME_MAXIMUM is our local policy.
976 */
977 extern enum_names oakley_lifetime_names;
978
979 #define OAKLEY_LIFE_SECONDS 1
980 #define OAKLEY_LIFE_KILOBYTES 2
981
982 #define OAKLEY_ISAKMP_SA_LIFETIME_DEFAULT 10800 /* three hours */
983 #define OAKLEY_ISAKMP_SA_LIFETIME_MAXIMUM 86400 /* one day */
984
985 /* Oakley PRF attribute (none defined)
986 * draft-ietf-ipsec-ike-01.txt appendix A
987 */
988 extern enum_names oakley_prf_names;
989
990 /* HMAC (see rfc2104.txt) */
991
992 #define HMAC_IPAD 0x36
993 #define HMAC_OPAD 0x5C
994 #define HMAC_BUFSIZE 64
995
996 /* Oakley Encryption Algorithm attribute
997 * draft-ietf-ipsec-ike-01.txt appendix A
998 * and from http://www.isi.edu/in-notes/iana/assignments/ipsec-registry
999 */
1000
1001 extern enum_names oakley_enc_names;
1002
1003 #define OAKLEY_DES_CBC 1
1004 #define OAKLEY_IDEA_CBC 2
1005 #define OAKLEY_BLOWFISH_CBC 3
1006 #define OAKLEY_RC5_R16_B64_CBC 4
1007 #define OAKLEY_3DES_CBC 5
1008 #define OAKLEY_CAST_CBC 6
1009 #define OAKLEY_AES_CBC 7
1010
1011 #define OAKLEY_MARS_CBC 65001
1012 #define OAKLEY_RC6_CBC 65002
1013 #define OAKLEY_ID_65003 65003
1014 #define OAKLEY_SERPENT_CBC 65004
1015 #define OAKLEY_TWOFISH_CBC 65005
1016
1017 #define OAKLEY_TWOFISH_CBC_SSH 65289
1018
1019 #define OAKLEY_ENCRYPT_MAX 65535 /* pretty useless :) */
1020
1021 /* Oakley Hash Algorithm attribute
1022 * draft-ietf-ipsec-ike-01.txt appendix A
1023 * and from http://www.isi.edu/in-notes/iana/assignments/ipsec-registry
1024 */
1025
1026 extern enum_names oakley_hash_names;
1027
1028 #define OAKLEY_MD5 1
1029 #define OAKLEY_SHA 2
1030 #define OAKLEY_TIGER 3
1031 #define OAKLEY_SHA2_256 4
1032 #define OAKLEY_SHA2_384 5
1033 #define OAKLEY_SHA2_512 6
1034
1035 #define OAKLEY_HASH_MAX 7
1036
1037 /* Oakley Authentication Method attribute
1038 * draft-ietf-ipsec-ike-01.txt appendix A
1039 * Goofy Hybrid extensions from draft-ietf-ipsec-isakmp-hybrid-auth-05.txt
1040 * Goofy XAUTH extensions from draft-ietf-ipsec-isakmp-xauth-06.txt
1041 */
1042
1043 extern enum_names oakley_auth_names;
1044
1045 #define OAKLEY_PRESHARED_KEY 1
1046 #define OAKLEY_DSS_SIG 2
1047 #define OAKLEY_RSA_SIG 3
1048 #define OAKLEY_RSA_ENC 4
1049 #define OAKLEY_RSA_ENC_REV 5
1050 #define OAKLEY_ELGAMAL_ENC 6
1051 #define OAKLEY_ELGAMAL_ENC_REV 7
1052
1053 #define OAKLEY_AUTH_ROOF 8 /* roof on auth values THAT WE SUPPORT */
1054
1055 #define HybridInitRSA 64221
1056 #define HybridRespRSA 64222
1057 #define HybridInitDSS 64223
1058 #define HybridRespDSS 64224
1059
1060 #define XAUTHInitPreShared 65001
1061 #define XAUTHRespPreShared 65002
1062 #define XAUTHInitDSS 65003
1063 #define XAUTHRespDSS 65004
1064 #define XAUTHInitRSA 65005
1065 #define XAUTHRespRSA 65006
1066 #define XAUTHInitRSAEncryption 65007
1067 #define XAUTHRespRSAEncryption 65008
1068 #define XAUTHInitRSARevisedEncryption 65009
1069 #define XAUTHRespRSARevisedEncryption 65010
1070
1071 /* Oakley Group Description attribute
1072 * draft-ietf-ipsec-ike-01.txt appendix A
1073 */
1074 extern enum_names oakley_group_names;
1075
1076 #define OAKLEY_GROUP_MODP768 1
1077 #define OAKLEY_GROUP_MODP1024 2
1078 #define OAKLEY_GROUP_GP155 3
1079 #define OAKLEY_GROUP_GP185 4
1080 #define OAKLEY_GROUP_MODP1536 5
1081
1082 #define OAKLEY_GROUP_MODP2048 14
1083 #define OAKLEY_GROUP_MODP3072 15
1084 #define OAKLEY_GROUP_MODP4096 16
1085 #define OAKLEY_GROUP_MODP6144 17
1086 #define OAKLEY_GROUP_MODP8192 18
1087 /* you must also touch: constants.c, crypto.c */
1088
1089 /* Oakley Group Type attribute
1090 * draft-ietf-ipsec-ike-01.txt appendix A
1091 */
1092 extern enum_names oakley_group_type_names;
1093
1094 #define OAKLEY_GROUP_TYPE_MODP 1
1095 #define OAKLEY_GROUP_TYPE_ECP 2
1096 #define OAKLEY_GROUP_TYPE_EC2N 3
1097
1098
1099 /* Notify messages -- error types
1100 * See RFC2408 ISAKMP 3.14.1
1101 */
1102
1103 extern enum_names notification_names;
1104 extern enum_names ipsec_notification_names;
1105
1106 typedef enum {
1107 NOTHING_WRONG = 0, /* unofficial! */
1108
1109 INVALID_PAYLOAD_TYPE = 1,
1110 DOI_NOT_SUPPORTED = 2,
1111 SITUATION_NOT_SUPPORTED = 3,
1112 INVALID_COOKIE = 4,
1113 INVALID_MAJOR_VERSION = 5,
1114 INVALID_MINOR_VERSION = 6,
1115 INVALID_EXCHANGE_TYPE = 7,
1116 INVALID_FLAGS = 8,
1117 INVALID_MESSAGE_ID = 9,
1118 INVALID_PROTOCOL_ID = 10,
1119 INVALID_SPI = 11,
1120 INVALID_TRANSFORM_ID = 12,
1121 ATTRIBUTES_NOT_SUPPORTED = 13,
1122 NO_PROPOSAL_CHOSEN = 14,
1123 BAD_PROPOSAL_SYNTAX = 15,
1124 PAYLOAD_MALFORMED = 16,
1125 INVALID_KEY_INFORMATION = 17,
1126 INVALID_ID_INFORMATION = 18,
1127 INVALID_CERT_ENCODING = 19,
1128 INVALID_CERTIFICATE = 20,
1129 CERT_TYPE_UNSUPPORTED = 21,
1130 INVALID_CERT_AUTHORITY = 22,
1131 INVALID_HASH_INFORMATION = 23,
1132 AUTHENTICATION_FAILED = 24,
1133 INVALID_SIGNATURE = 25,
1134 ADDRESS_NOTIFICATION = 26,
1135 NOTIFY_SA_LIFETIME = 27,
1136 CERTIFICATE_UNAVAILABLE = 28,
1137 UNSUPPORTED_EXCHANGE_TYPE = 29,
1138 UNEQUAL_PAYLOAD_LENGTHS = 30,
1139
1140 /* ISAKMP status type */
1141 CONNECTED = 16384,
1142
1143 /* IPSEC DOI additions; status types (RFC2407 IPSEC DOI 4.6.3)
1144 * These must be sent under the protection of an ISAKMP SA.
1145 */
1146 IPSEC_RESPONDER_LIFETIME = 24576,
1147 IPSEC_REPLAY_STATUS = 24577,
1148 IPSEC_INITIAL_CONTACT = 24578,
1149
1150 /* RFC 3706 DPD */
1151 R_U_THERE = 36136,
1152 R_U_THERE_ACK = 36137
1153
1154 } notification_t;
1155
1156
1157 /* Public key algorithm number
1158 * Same numbering as used in DNSsec
1159 * See RFC 2535 DNSsec 3.2 The KEY Algorithm Number Specification.
1160 * Also found in BIND 8.2.2 include/isc/dst.h as DST algorithm codes.
1161 */
1162
1163 enum pubkey_alg
1164 {
1165 PUBKEY_ALG_RSA = 1,
1166 PUBKEY_ALG_DSA = 3,
1167 };
1168
1169 /* Limits on size of RSA moduli.
1170 * The upper bound matches that of DNSsec (see RFC 2537).
1171 * The lower bound must be more than 11 octets for certain
1172 * the encoding to work, but it must be much larger for any
1173 * real security. For now, we require 512 bits.
1174 */
1175
1176 #define RSA_MIN_OCTETS_RFC 12
1177
1178 #define RSA_MIN_OCTETS (512 / BITS_PER_BYTE)
1179 #define RSA_MIN_OCTETS_UGH "RSA modulus too small for security: less than 512 bits"
1180
1181 #define RSA_MAX_OCTETS (8192 / BITS_PER_BYTE)
1182 #define RSA_MAX_OCTETS_UGH "RSA modulus too large: more than 8192 bits"
1183
1184 /* Note: RFC 2537 encoding adds a few bytes. If you use a small
1185 * modulus like 3, the overhead is only 2 bytes
1186 */
1187 #define RSA_MAX_ENCODING_BYTES (RSA_MAX_OCTETS + 2)
1188
1189 /* socket address family info */
1190
1191 struct af_info
1192 {
1193 int af;
1194 const char *name;
1195 size_t ia_sz;
1196 size_t sa_sz;
1197 int mask_cnt;
1198 u_int8_t id_addr, id_subnet, id_range;
1199 const ip_address *any;
1200 const ip_subnet *none; /* 0.0.0.0/32 or IPv6 equivalent */
1201 const ip_subnet *all; /* 0.0.0.0/0 or IPv6 equivalent */
1202 };
1203
1204 extern const struct af_info
1205 af_inet4_info,
1206 af_inet6_info;
1207
1208 extern const struct af_info *aftoinfo(int af);
1209
1210 extern enum_names af_names;
1211
1212 #define subnetisaddr(sn, a) (subnetishost(sn) && addrinsubnet((a), (sn)))
1213 extern bool subnetisnone(const ip_subnet *sn);
1214
1215 /* BIND enumerated types */
1216
1217 extern enum_names
1218 rr_qtype_names,
1219 rr_type_names,
1220 rr_class_names;
1221
1222 /* How authenticated is info that might have come from DNS?
1223 * In order of increasing confidence.
1224 */
1225 enum dns_auth_level {
1226 DAL_UNSIGNED, /* AD in response, but no signature: no authentication */
1227 DAL_NOTSEC, /* no AD in response: authentication impossible */
1228 DAL_SIGNED, /* AD and signature in response: authentic */
1229 DAL_LOCAL /* locally provided (pretty good) */
1230 };
1231
1232 /*
1233 * define a macro for use in error messages
1234 */
1235
1236 #ifdef USE_KEYRR
1237 #define RRNAME "TXT or KEY"
1238 #else
1239 #define RRNAME "TXT"
1240 #endif
1241
1242 /* natt traversal types */
1243 extern const char *const natt_type_bitnames[];
1244
1245 #endif /* _CONSTANTS_H */