]> git.saurik.com Git - apple/xnu.git/blob - bsd/net/pfkeyv2.h
xnu-2782.1.97.tar.gz
[apple/xnu.git] / bsd / net / pfkeyv2.h
1 /*
2 * Copyright (c) 2000-2011 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /* $KAME: pfkeyv2.h,v 1.10 2000/03/22 07:04:20 sakane Exp $ */
29
30 /*
31 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
32 * All rights reserved.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
36 * are met:
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. Neither the name of the project nor the names of its contributors
43 * may be used to endorse or promote products derived from this software
44 * without specific prior written permission.
45 *
46 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 * SUCH DAMAGE.
57 */
58
59 /*
60 * This file has been derived rfc 2367,
61 * And added some flags of SADB_KEY_FLAGS_ as SADB_X_EXT_.
62 * sakane@ydc.co.jp
63 */
64
65 #ifndef _NET_PFKEYV2_H_
66 #define _NET_PFKEYV2_H_
67 #include <sys/appleapiopts.h>
68 #include <net/if.h>
69
70 /*
71 This file defines structures and symbols for the PF_KEY Version 2
72 key management interface. It was written at the U.S. Naval Research
73 Laboratory. This file is in the public domain. The authors ask that
74 you leave this credit intact on any copies of this file.
75 */
76 #ifndef __PFKEY_V2_H
77 #define __PFKEY_V2_H 1
78
79 #define PF_KEY_V2 2
80 #define PFKEYV2_REVISION 199806L
81
82 #define SADB_RESERVED 0
83 #define SADB_GETSPI 1
84 #define SADB_UPDATE 2
85 #define SADB_ADD 3
86 #define SADB_DELETE 4
87 #define SADB_GET 5
88 #define SADB_ACQUIRE 6
89 #define SADB_REGISTER 7
90 #define SADB_EXPIRE 8
91 #define SADB_FLUSH 9
92 #define SADB_DUMP 10
93 #define SADB_X_PROMISC 11
94 #define SADB_X_PCHANGE 12
95
96 #define SADB_X_SPDUPDATE 13
97 #define SADB_X_SPDADD 14
98 #define SADB_X_SPDDELETE 15 /* by policy index */
99 #define SADB_X_SPDGET 16
100 #define SADB_X_SPDACQUIRE 17
101 #define SADB_X_SPDDUMP 18
102 #define SADB_X_SPDFLUSH 19
103 #define SADB_X_SPDSETIDX 20
104 #define SADB_X_SPDEXPIRE 21
105 #define SADB_X_SPDDELETE2 22 /* by policy id */
106 #define SADB_GETSASTAT 23
107 #define SADB_X_SPDENABLE 24 /* by policy id */
108 #define SADB_X_SPDDISABLE 25 /* by policy id */
109 #define SADB_MAX 25
110
111 struct sadb_msg {
112 u_int8_t sadb_msg_version;
113 u_int8_t sadb_msg_type;
114 u_int8_t sadb_msg_errno;
115 u_int8_t sadb_msg_satype;
116 u_int16_t sadb_msg_len;
117 u_int16_t sadb_msg_reserved;
118 u_int32_t sadb_msg_seq;
119 u_int32_t sadb_msg_pid;
120 };
121
122 struct sadb_ext {
123 u_int16_t sadb_ext_len;
124 u_int16_t sadb_ext_type;
125 };
126
127 struct sadb_sa {
128 u_int16_t sadb_sa_len;
129 u_int16_t sadb_sa_exttype;
130 u_int32_t sadb_sa_spi;
131 u_int8_t sadb_sa_replay;
132 u_int8_t sadb_sa_state;
133 u_int8_t sadb_sa_auth;
134 u_int8_t sadb_sa_encrypt;
135 u_int32_t sadb_sa_flags;
136 };
137
138 #ifdef PRIVATE
139 struct sadb_sa_2 {
140 struct sadb_sa sa;
141 u_int16_t sadb_sa_natt_port;
142 union {
143 u_int16_t sadb_reserved0;
144 u_int16_t sadb_sa_natt_interval;
145 };
146 u_int32_t sadb_reserved1;
147 };
148 #endif /* PRIVATE */
149
150 struct sadb_lifetime {
151 u_int16_t sadb_lifetime_len;
152 u_int16_t sadb_lifetime_exttype;
153 u_int32_t sadb_lifetime_allocations;
154 u_int64_t sadb_lifetime_bytes;
155 u_int64_t sadb_lifetime_addtime;
156 u_int64_t sadb_lifetime_usetime;
157 };
158
159 struct sadb_address {
160 u_int16_t sadb_address_len;
161 u_int16_t sadb_address_exttype;
162 u_int8_t sadb_address_proto;
163 u_int8_t sadb_address_prefixlen;
164 u_int16_t sadb_address_reserved;
165 };
166
167 struct sadb_key {
168 u_int16_t sadb_key_len;
169 u_int16_t sadb_key_exttype;
170 u_int16_t sadb_key_bits;
171 u_int16_t sadb_key_reserved;
172 };
173
174 struct sadb_ident {
175 u_int16_t sadb_ident_len;
176 u_int16_t sadb_ident_exttype;
177 u_int16_t sadb_ident_type;
178 u_int16_t sadb_ident_reserved;
179 u_int64_t sadb_ident_id;
180 };
181
182 struct sadb_sens {
183 u_int16_t sadb_sens_len;
184 u_int16_t sadb_sens_exttype;
185 u_int32_t sadb_sens_dpd;
186 u_int8_t sadb_sens_sens_level;
187 u_int8_t sadb_sens_sens_len;
188 u_int8_t sadb_sens_integ_level;
189 u_int8_t sadb_sens_integ_len;
190 u_int32_t sadb_sens_reserved;
191 };
192
193 struct sadb_prop {
194 u_int16_t sadb_prop_len;
195 u_int16_t sadb_prop_exttype;
196 u_int8_t sadb_prop_replay;
197 u_int8_t sadb_prop_reserved[3];
198 };
199
200 struct sadb_comb {
201 u_int8_t sadb_comb_auth;
202 u_int8_t sadb_comb_encrypt;
203 u_int16_t sadb_comb_flags;
204 u_int16_t sadb_comb_auth_minbits;
205 u_int16_t sadb_comb_auth_maxbits;
206 u_int16_t sadb_comb_encrypt_minbits;
207 u_int16_t sadb_comb_encrypt_maxbits;
208 u_int32_t sadb_comb_reserved;
209 u_int32_t sadb_comb_soft_allocations;
210 u_int32_t sadb_comb_hard_allocations;
211 u_int64_t sadb_comb_soft_bytes;
212 u_int64_t sadb_comb_hard_bytes;
213 u_int64_t sadb_comb_soft_addtime;
214 u_int64_t sadb_comb_hard_addtime;
215 u_int64_t sadb_comb_soft_usetime;
216 u_int64_t sadb_comb_hard_usetime;
217 };
218
219 struct sadb_supported {
220 u_int16_t sadb_supported_len;
221 u_int16_t sadb_supported_exttype;
222 u_int32_t sadb_supported_reserved;
223 };
224
225 struct sadb_alg {
226 u_int8_t sadb_alg_id;
227 u_int8_t sadb_alg_ivlen;
228 u_int16_t sadb_alg_minbits;
229 u_int16_t sadb_alg_maxbits;
230 u_int16_t sadb_alg_reserved;
231 };
232
233 struct sadb_spirange {
234 u_int16_t sadb_spirange_len;
235 u_int16_t sadb_spirange_exttype;
236 u_int32_t sadb_spirange_min;
237 u_int32_t sadb_spirange_max;
238 u_int32_t sadb_spirange_reserved;
239 };
240
241 struct sadb_x_kmprivate {
242 u_int16_t sadb_x_kmprivate_len;
243 u_int16_t sadb_x_kmprivate_exttype;
244 u_int32_t sadb_x_kmprivate_reserved;
245 };
246
247 /*
248 * XXX Additional SA Extension.
249 * mode: tunnel or transport
250 * reqid: to make SA unique nevertheless the address pair of SA are same.
251 * Mainly it's for VPN.
252 */
253 struct sadb_x_sa2 {
254 u_int16_t sadb_x_sa2_len;
255 u_int16_t sadb_x_sa2_exttype;
256 u_int8_t sadb_x_sa2_mode;
257 union {
258 u_int8_t sadb_x_sa2_reserved1;
259 #ifdef PRIVATE
260 u_int8_t sadb_x_sa2_alwaysexpire;
261 #endif
262 };
263 union {
264 u_int16_t sadb_x_sa2_reserved2;
265 #ifdef PRIVATE
266 u_int16_t sadb_x_sa2_flags;
267 #endif
268 };
269 u_int32_t sadb_x_sa2_sequence;
270 u_int32_t sadb_x_sa2_reqid;
271 };
272
273 /* XXX Policy Extension */
274 /* sizeof(struct sadb_x_policy) == 16 */
275 struct sadb_x_policy {
276 u_int16_t sadb_x_policy_len;
277 u_int16_t sadb_x_policy_exttype;
278 u_int16_t sadb_x_policy_type; /* See policy type of ipsec.h */
279 u_int8_t sadb_x_policy_dir; /* direction, see ipsec.h */
280 u_int8_t sadb_x_policy_reserved;
281 u_int32_t sadb_x_policy_id;
282 u_int32_t sadb_x_policy_reserved2;
283 };
284 /*
285 * When policy_type == IPSEC, it is followed by some of
286 * the ipsec policy request.
287 * [total length of ipsec policy requests]
288 * = (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy))
289 */
290 #ifdef PRIVATE
291 /* IPSec Interface Extension:
292 * IPSec interface can be specified alone, or all three
293 * of internal, outgoing, and IPSec interfaces must be
294 * specified.
295 */
296 struct sadb_x_ipsecif {
297 u_int16_t sadb_x_ipsecif_len;
298 u_int16_t sadb_x_ipsecif_exttype;
299 char sadb_x_ipsecif_internal_if[IFXNAMSIZ]; /* Steal packets from this interface */
300 char sadb_x_ipsecif_outgoing_if[IFXNAMSIZ]; /* Send packets out on this interface */
301 char sadb_x_ipsecif_ipsec_if[IFXNAMSIZ]; /* Direct packets through ipsec interface */
302 u_int16_t sadb_x_ipsecif_init_disabled; /* 0 or 1, flag to ignore policy */
303 u_int16_t reserved;
304 };
305 #endif
306 /* XXX IPsec Policy Request Extension */
307 /*
308 * This structure is aligned 8 bytes.
309 */
310 struct sadb_x_ipsecrequest {
311 u_int16_t sadb_x_ipsecrequest_len; /* structure length aligned to 8 bytes.
312 * This value is true length of bytes.
313 * Not in units of 64 bits. */
314 u_int16_t sadb_x_ipsecrequest_proto; /* See ipsec.h */
315 u_int8_t sadb_x_ipsecrequest_mode; /* See IPSEC_MODE_XX in ipsec.h. */
316 u_int8_t sadb_x_ipsecrequest_level; /* See IPSEC_LEVEL_XX in ipsec.h */
317 u_int16_t sadb_x_ipsecrequest_reqid; /* See ipsec.h */
318
319 /*
320 * followed by source IP address of SA, and immediately followed by
321 * destination IP address of SA. These encoded into two of sockaddr
322 * structure without any padding. Must set each sa_len exactly.
323 * Each of length of the sockaddr structure are not aligned to 64bits,
324 * but sum of x_request and addresses is aligned to 64bits.
325 */
326 };
327
328 struct sadb_session_id {
329 u_int16_t sadb_session_id_len;
330 u_int16_t sadb_session_id_exttype;
331 /* [0] is an arbitrary handle that means something only for requester
332 * [1] is a global session id for lookups in the kernel and racoon.
333 */
334 u_int64_t sadb_session_id_v[2];
335 } __attribute__ ((aligned(8)));
336
337 struct sastat {
338 u_int32_t spi; /* SPI Value, network byte order */
339 u_int32_t created; /* for lifetime */
340 struct sadb_lifetime lft_c; /* CURRENT lifetime. */
341 }; // no need to align
342
343 struct sadb_sastat {
344 u_int16_t sadb_sastat_len;
345 u_int16_t sadb_sastat_exttype;
346 u_int32_t sadb_sastat_dir;
347 u_int32_t sadb_sastat_reserved;
348 u_int32_t sadb_sastat_list_len;
349 /* list of struct sastat comes after */
350 } __attribute__ ((aligned(8)));
351
352 #define SADB_EXT_RESERVED 0
353 #define SADB_EXT_SA 1
354 #define SADB_EXT_LIFETIME_CURRENT 2
355 #define SADB_EXT_LIFETIME_HARD 3
356 #define SADB_EXT_LIFETIME_SOFT 4
357 #define SADB_EXT_ADDRESS_SRC 5
358 #define SADB_EXT_ADDRESS_DST 6
359 #define SADB_EXT_ADDRESS_PROXY 7
360 #define SADB_EXT_KEY_AUTH 8
361 #define SADB_EXT_KEY_ENCRYPT 9
362 #define SADB_EXT_IDENTITY_SRC 10
363 #define SADB_EXT_IDENTITY_DST 11
364 #define SADB_EXT_SENSITIVITY 12
365 #define SADB_EXT_PROPOSAL 13
366 #define SADB_EXT_SUPPORTED_AUTH 14
367 #define SADB_EXT_SUPPORTED_ENCRYPT 15
368 #define SADB_EXT_SPIRANGE 16
369 #define SADB_X_EXT_KMPRIVATE 17
370 #define SADB_X_EXT_POLICY 18
371 #define SADB_X_EXT_SA2 19
372 #define SADB_EXT_SESSION_ID 20
373 #define SADB_EXT_SASTAT 21
374 #define SADB_X_EXT_IPSECIF 22
375 #define SADB_X_EXT_ADDR_RANGE_SRC_START 23
376 #define SADB_X_EXT_ADDR_RANGE_SRC_END 24
377 #define SADB_X_EXT_ADDR_RANGE_DST_START 25
378 #define SADB_X_EXT_ADDR_RANGE_DST_END 26
379 #define SADB_EXT_MAX 26
380
381 #define SADB_SATYPE_UNSPEC 0
382 #define SADB_SATYPE_AH 2
383 #define SADB_SATYPE_ESP 3
384 #define SADB_SATYPE_RSVP 5
385 #define SADB_SATYPE_OSPFV2 6
386 #define SADB_SATYPE_RIPV2 7
387 #define SADB_SATYPE_MIP 8
388 #define SADB_X_SATYPE_IPCOMP 9
389 #define SADB_X_SATYPE_POLICY 10
390 #define SADB_SATYPE_MAX 11
391
392 #define SADB_SASTATE_LARVAL 0
393 #define SADB_SASTATE_MATURE 1
394 #define SADB_SASTATE_DYING 2
395 #define SADB_SASTATE_DEAD 3
396 #define SADB_SASTATE_MAX 3
397
398 #define SADB_SAFLAGS_PFS 1
399
400 /* RFC2367 numbers - meets RFC2407 */
401 #define SADB_AALG_NONE 0
402 #define SADB_AALG_MD5HMAC 1 /*2*/
403 #define SADB_AALG_SHA1HMAC 2 /*3*/
404 #define SADB_AALG_MAX 8
405 /* private allocations - based on RFC2407/IANA assignment */
406 #define SADB_X_AALG_SHA2_256 6 /*5*/
407 #define SADB_X_AALG_SHA2_384 7 /*6*/
408 #define SADB_X_AALG_SHA2_512 8 /*7*/
409 /* private allocations should use 249-255 (RFC2407) */
410 #define SADB_X_AALG_MD5 3 /*249*/ /* Keyed MD5 */
411 #define SADB_X_AALG_SHA 4 /*250*/ /* Keyed SHA */
412 #define SADB_X_AALG_NULL 5 /*251*/ /* null authentication */
413
414 /* RFC2367 numbers - meets RFC2407 */
415 #define SADB_EALG_NONE 0
416 #define SADB_EALG_DESCBC 1 /*2*/
417 #define SADB_EALG_3DESCBC 2 /*3*/
418 #define SADB_EALG_NULL 3 /*11*/
419 #define SADB_EALG_MAX 12
420 /* private allocations - based on RFC2407/IANA assignment */
421 #define SADB_X_EALG_CAST128CBC 5 /*6*/
422 #define SADB_X_EALG_BLOWFISHCBC 4 /*7*/
423 #define SADB_X_EALG_RIJNDAELCBC 12
424 #define SADB_X_EALG_AESCBC 12
425 #define SADB_X_EALG_AES 12
426 /* private allocations should use 249-255 (RFC2407) */
427
428 #if 1 /*nonstandard */
429 #define SADB_X_CALG_NONE 0
430 #define SADB_X_CALG_OUI 1
431 #define SADB_X_CALG_DEFLATE 2
432 #define SADB_X_CALG_LZS 3
433 #define SADB_X_CALG_MAX 4
434 #endif
435
436 #define SADB_IDENTTYPE_RESERVED 0
437 #define SADB_IDENTTYPE_PREFIX 1
438 #define SADB_IDENTTYPE_FQDN 2
439 #define SADB_IDENTTYPE_USERFQDN 3
440 #define SADB_X_IDENTTYPE_ADDR 4
441 #define SADB_IDENTTYPE_MAX 4
442
443 /* `flags' in sadb_sa structure holds followings */
444 #define SADB_X_EXT_NONE 0x0000 /* i.e. new format. */
445 #define SADB_X_EXT_OLD 0x0001 /* old format. */
446 #ifdef PRIVATE
447 #define SADB_X_EXT_NATT 0x0002 /* Use UDP encapsulation to traverse NAT */
448 #define SADB_X_EXT_NATT_KEEPALIVE 0x0004 /* Local node is behind NAT, send keepalives */
449 /* Should only be set for outbound SAs */
450 #define SADB_X_EXT_NATT_MULTIPLEUSERS 0x0008 /* For use on VPN server - support multiple users */
451
452 #endif /* PRIVATE */
453
454 #define SADB_X_EXT_IV4B 0x0010 /* IV length of 4 bytes in use */
455 #define SADB_X_EXT_DERIV 0x0020 /* DES derived */
456 #define SADB_X_EXT_CYCSEQ 0x0040 /* allowing to cyclic sequence. */
457
458 /* three of followings are exclusive flags each them */
459 #define SADB_X_EXT_PSEQ 0x0000 /* sequencial padding for ESP */
460 #define SADB_X_EXT_PRAND 0x0100 /* random padding for ESP */
461 #define SADB_X_EXT_PZERO 0x0200 /* zero padding for ESP */
462 #define SADB_X_EXT_PMASK 0x0300 /* mask for padding flag */
463
464 #ifdef PRIVATE
465 #define SADB_X_EXT_NATT_DETECTED_PEER 0x1000
466 #define SADB_X_EXT_ESP_KEEPALIVE 0x2000
467 #define SADB_X_EXT_PUNT_RX_KEEPALIVE 0x4000
468 #define SADB_X_EXT_NATT_KEEPALIVE_OFFLOAD 0x8000
469 #endif /* PRIVATE */
470
471 #if 1
472 #define SADB_X_EXT_RAWCPI 0x0080 /* use well known CPI (IPComp) */
473 #endif
474
475 #define SADB_KEY_FLAGS_MAX 0x7fff
476
477 #ifdef PRIVATE
478 #define SADB_X_EXT_SA2_DELETE_ON_DETACH 0x0001
479 #endif
480
481 /* SPI size for PF_KEYv2 */
482 #define PFKEY_SPI_SIZE sizeof(u_int32_t)
483
484 /* Identifier for menber of lifetime structure */
485 #define SADB_X_LIFETIME_ALLOCATIONS 0
486 #define SADB_X_LIFETIME_BYTES 1
487 #define SADB_X_LIFETIME_ADDTIME 2
488 #define SADB_X_LIFETIME_USETIME 3
489
490 /* The rate for SOFT lifetime against HARD one. */
491 #define PFKEY_SOFT_LIFETIME_RATE 80
492
493 /* Utilities */
494 #define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
495 #define PFKEY_EXTLEN(msg) \
496 PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len)
497 #define PFKEY_ADDR_PREFIX(ext) \
498 (((struct sadb_address *)(ext))->sadb_address_prefixlen)
499 #define PFKEY_ADDR_PROTO(ext) \
500 (((struct sadb_address *)(ext))->sadb_address_proto)
501 #define PFKEY_ADDR_SADDR(ext) \
502 ((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address)))
503
504 /* in 64bits */
505 #define PFKEY_UNUNIT64(a) ((a) << 3)
506 #define PFKEY_UNIT64(a) ((a) >> 3)
507
508 #endif /* __PFKEY_V2_H */
509
510 #endif /* _NET_PFKEYV2_H_ */