1 /* $FreeBSD: src/sys/net/pfkeyv2.h,v 1.4.2.5 2003/01/31 23:21:01 sam Exp $ */
2 /* $DragonFly: src/sys/net/pfkeyv2.h,v 1.2 2003/06/17 04:28:48 dillon Exp $ */
3 /* $KAME: pfkeyv2.h,v 1.26 2001/06/27 10:49:49 sakane Exp $ */
6 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the project nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * This file has been derived rfc 2367,
36 * And added some flags of SADB_KEY_FLAGS_ as SADB_X_EXT_.
40 #ifndef _NET_PFKEYV2_H_
41 #define _NET_PFKEYV2_H_
44 This file defines structures and symbols for the PF_KEY Version 2
45 key management interface. It was written at the U.S. Naval Research
46 Laboratory. This file is in the public domain. The authors ask that
47 you leave this credit intact on any copies of this file.
50 #define __PFKEY_V2_H 1
53 #define PFKEYV2_REVISION 199806L
55 #define SADB_RESERVED 0
61 #define SADB_ACQUIRE 6
62 #define SADB_REGISTER 7
66 #define SADB_X_PROMISC 11
67 #define SADB_X_PCHANGE 12
69 #define SADB_X_SPDUPDATE 13
70 #define SADB_X_SPDADD 14
71 #define SADB_X_SPDDELETE 15 /* by policy index */
72 #define SADB_X_SPDGET 16
73 #define SADB_X_SPDACQUIRE 17
74 #define SADB_X_SPDDUMP 18
75 #define SADB_X_SPDFLUSH 19
76 #define SADB_X_SPDSETIDX 20
77 #define SADB_X_SPDEXPIRE 21
78 #define SADB_X_SPDDELETE2 22 /* by policy id */
82 u_int8_t sadb_msg_version;
83 u_int8_t sadb_msg_type;
84 u_int8_t sadb_msg_errno;
85 u_int8_t sadb_msg_satype;
86 u_int16_t sadb_msg_len;
87 u_int16_t sadb_msg_reserved;
88 u_int32_t sadb_msg_seq;
89 u_int32_t sadb_msg_pid;
93 u_int16_t sadb_ext_len;
94 u_int16_t sadb_ext_type;
98 u_int16_t sadb_sa_len;
99 u_int16_t sadb_sa_exttype;
100 u_int32_t sadb_sa_spi;
101 u_int8_t sadb_sa_replay;
102 u_int8_t sadb_sa_state;
103 u_int8_t sadb_sa_auth;
104 u_int8_t sadb_sa_encrypt;
105 u_int32_t sadb_sa_flags;
108 struct sadb_lifetime {
109 u_int16_t sadb_lifetime_len;
110 u_int16_t sadb_lifetime_exttype;
111 u_int32_t sadb_lifetime_allocations;
112 u_int64_t sadb_lifetime_bytes;
113 u_int64_t sadb_lifetime_addtime;
114 u_int64_t sadb_lifetime_usetime;
117 struct sadb_address {
118 u_int16_t sadb_address_len;
119 u_int16_t sadb_address_exttype;
120 u_int8_t sadb_address_proto;
121 u_int8_t sadb_address_prefixlen;
122 u_int16_t sadb_address_reserved;
126 u_int16_t sadb_key_len;
127 u_int16_t sadb_key_exttype;
128 u_int16_t sadb_key_bits;
129 u_int16_t sadb_key_reserved;
133 u_int16_t sadb_ident_len;
134 u_int16_t sadb_ident_exttype;
135 u_int16_t sadb_ident_type;
136 u_int16_t sadb_ident_reserved;
137 u_int64_t sadb_ident_id;
141 u_int16_t sadb_sens_len;
142 u_int16_t sadb_sens_exttype;
143 u_int32_t sadb_sens_dpd;
144 u_int8_t sadb_sens_sens_level;
145 u_int8_t sadb_sens_sens_len;
146 u_int8_t sadb_sens_integ_level;
147 u_int8_t sadb_sens_integ_len;
148 u_int32_t sadb_sens_reserved;
152 u_int16_t sadb_prop_len;
153 u_int16_t sadb_prop_exttype;
154 u_int8_t sadb_prop_replay;
155 u_int8_t sadb_prop_reserved[3];
159 u_int8_t sadb_comb_auth;
160 u_int8_t sadb_comb_encrypt;
161 u_int16_t sadb_comb_flags;
162 u_int16_t sadb_comb_auth_minbits;
163 u_int16_t sadb_comb_auth_maxbits;
164 u_int16_t sadb_comb_encrypt_minbits;
165 u_int16_t sadb_comb_encrypt_maxbits;
166 u_int32_t sadb_comb_reserved;
167 u_int32_t sadb_comb_soft_allocations;
168 u_int32_t sadb_comb_hard_allocations;
169 u_int64_t sadb_comb_soft_bytes;
170 u_int64_t sadb_comb_hard_bytes;
171 u_int64_t sadb_comb_soft_addtime;
172 u_int64_t sadb_comb_hard_addtime;
173 u_int64_t sadb_comb_soft_usetime;
174 u_int64_t sadb_comb_hard_usetime;
177 struct sadb_supported {
178 u_int16_t sadb_supported_len;
179 u_int16_t sadb_supported_exttype;
180 u_int32_t sadb_supported_reserved;
184 u_int8_t sadb_alg_id;
185 u_int8_t sadb_alg_ivlen;
186 u_int16_t sadb_alg_minbits;
187 u_int16_t sadb_alg_maxbits;
188 u_int16_t sadb_alg_reserved;
191 struct sadb_spirange {
192 u_int16_t sadb_spirange_len;
193 u_int16_t sadb_spirange_exttype;
194 u_int32_t sadb_spirange_min;
195 u_int32_t sadb_spirange_max;
196 u_int32_t sadb_spirange_reserved;
199 struct sadb_x_kmprivate {
200 u_int16_t sadb_x_kmprivate_len;
201 u_int16_t sadb_x_kmprivate_exttype;
202 u_int32_t sadb_x_kmprivate_reserved;
206 * XXX Additional SA Extension.
207 * mode: tunnel or transport
208 * reqid: to make SA unique nevertheless the address pair of SA are same.
209 * Mainly it's for VPN.
212 u_int16_t sadb_x_sa2_len;
213 u_int16_t sadb_x_sa2_exttype;
214 u_int8_t sadb_x_sa2_mode;
215 u_int8_t sadb_x_sa2_reserved1;
216 u_int16_t sadb_x_sa2_reserved2;
217 u_int32_t sadb_x_sa2_sequence;
218 u_int32_t sadb_x_sa2_reqid;
221 /* XXX Policy Extension */
222 /* sizeof(struct sadb_x_policy) == 16 */
223 struct sadb_x_policy {
224 u_int16_t sadb_x_policy_len;
225 u_int16_t sadb_x_policy_exttype;
226 u_int16_t sadb_x_policy_type; /* See policy type of ipsec.h */
227 u_int8_t sadb_x_policy_dir; /* direction, see ipsec.h */
228 u_int8_t sadb_x_policy_reserved;
229 u_int32_t sadb_x_policy_id;
230 u_int32_t sadb_x_policy_reserved2;
233 * When policy_type == IPSEC, it is followed by some of
234 * the ipsec policy request.
235 * [total length of ipsec policy requests]
236 * = (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy))
239 /* XXX IPsec Policy Request Extension */
241 * This structure is aligned 8 bytes.
243 struct sadb_x_ipsecrequest {
244 u_int16_t sadb_x_ipsecrequest_len; /* structure length aligned to 8 bytes.
245 * This value is true length of bytes.
246 * Not in units of 64 bits. */
247 u_int16_t sadb_x_ipsecrequest_proto; /* See ipsec.h */
248 u_int8_t sadb_x_ipsecrequest_mode; /* See IPSEC_MODE_XX in ipsec.h. */
249 u_int8_t sadb_x_ipsecrequest_level; /* See IPSEC_LEVEL_XX in ipsec.h */
250 u_int16_t sadb_x_ipsecrequest_reqid; /* See ipsec.h */
253 * followed by source IP address of SA, and immediately followed by
254 * destination IP address of SA. These encoded into two of sockaddr
255 * structure without any padding. Must set each sa_len exactly.
256 * Each of length of the sockaddr structure are not aligned to 64bits,
257 * but sum of x_request and addresses is aligned to 64bits.
261 #define SADB_EXT_RESERVED 0
262 #define SADB_EXT_SA 1
263 #define SADB_EXT_LIFETIME_CURRENT 2
264 #define SADB_EXT_LIFETIME_HARD 3
265 #define SADB_EXT_LIFETIME_SOFT 4
266 #define SADB_EXT_ADDRESS_SRC 5
267 #define SADB_EXT_ADDRESS_DST 6
268 #define SADB_EXT_ADDRESS_PROXY 7
269 #define SADB_EXT_KEY_AUTH 8
270 #define SADB_EXT_KEY_ENCRYPT 9
271 #define SADB_EXT_IDENTITY_SRC 10
272 #define SADB_EXT_IDENTITY_DST 11
273 #define SADB_EXT_SENSITIVITY 12
274 #define SADB_EXT_PROPOSAL 13
275 #define SADB_EXT_SUPPORTED_AUTH 14
276 #define SADB_EXT_SUPPORTED_ENCRYPT 15
277 #define SADB_EXT_SPIRANGE 16
278 #define SADB_X_EXT_KMPRIVATE 17
279 #define SADB_X_EXT_POLICY 18
280 #define SADB_X_EXT_SA2 19
281 #define SADB_EXT_MAX 19
283 #define SADB_SATYPE_UNSPEC 0
284 #define SADB_SATYPE_AH 2
285 #define SADB_SATYPE_ESP 3
286 #define SADB_SATYPE_RSVP 5
287 #define SADB_SATYPE_OSPFV2 6
288 #define SADB_SATYPE_RIPV2 7
289 #define SADB_SATYPE_MIP 8
290 #define SADB_X_SATYPE_IPCOMP 9
291 #define SADB_X_SATYPE_POLICY 10
292 #define SADB_SATYPE_MAX 11
294 #define SADB_SASTATE_LARVAL 0
295 #define SADB_SASTATE_MATURE 1
296 #define SADB_SASTATE_DYING 2
297 #define SADB_SASTATE_DEAD 3
298 #define SADB_SASTATE_MAX 3
300 #define SADB_SAFLAGS_PFS 1
302 /* RFC2367 numbers - meets RFC2407 */
303 #define SADB_AALG_NONE 0
304 #define SADB_AALG_MD5HMAC 1 /*2*/
305 #define SADB_AALG_SHA1HMAC 2 /*3*/
306 #define SADB_AALG_MAX 8
307 /* private allocations - based on RFC2407/IANA assignment */
308 #define SADB_X_AALG_SHA2_256 6 /*5*/
309 #define SADB_X_AALG_SHA2_384 7 /*6*/
310 #define SADB_X_AALG_SHA2_512 8 /*7*/
311 #define SADB_X_AALG_RIPEMD160HMAC 9 /*8*/
312 /* private allocations should use 249-255 (RFC2407) */
313 #define SADB_X_AALG_MD5 3 /*249*/ /* Keyed MD5 */
314 #define SADB_X_AALG_SHA 4 /*250*/ /* Keyed SHA */
315 #define SADB_X_AALG_NULL 5 /*251*/ /* null authentication */
317 /* RFC2367 numbers - meets RFC2407 */
318 #define SADB_EALG_NONE 0
319 #define SADB_EALG_DESCBC 1 /*2*/
320 #define SADB_EALG_3DESCBC 2 /*3*/
321 #define SADB_EALG_NULL 3 /*11*/
322 #define SADB_EALG_MAX 12
323 /* private allocations - based on RFC2407/IANA assignment */
324 #define SADB_X_EALG_CAST128CBC 5 /*6*/
325 #define SADB_X_EALG_BLOWFISHCBC 4 /*7*/
326 #define SADB_X_EALG_RIJNDAELCBC 12
327 #define SADB_X_EALG_AES 12
328 /* private allocations should use 249-255 (RFC2407) */
329 #define SADB_X_EALG_SKIPJACK 249
331 #if 1 /*nonstandard */
332 #define SADB_X_CALG_NONE 0
333 #define SADB_X_CALG_OUI 1
334 #define SADB_X_CALG_DEFLATE 2
335 #define SADB_X_CALG_LZS 3
336 #define SADB_X_CALG_MAX 4
339 #define SADB_IDENTTYPE_RESERVED 0
340 #define SADB_IDENTTYPE_PREFIX 1
341 #define SADB_IDENTTYPE_FQDN 2
342 #define SADB_IDENTTYPE_USERFQDN 3
343 #define SADB_X_IDENTTYPE_ADDR 4
344 #define SADB_IDENTTYPE_MAX 4
346 /* `flags' in sadb_sa structure holds followings */
347 #define SADB_X_EXT_NONE 0x0000 /* i.e. new format. */
348 #define SADB_X_EXT_OLD 0x0001 /* old format. */
350 #define SADB_X_EXT_IV4B 0x0010 /* IV length of 4 bytes in use */
351 #define SADB_X_EXT_DERIV 0x0020 /* DES derived */
352 #define SADB_X_EXT_CYCSEQ 0x0040 /* allowing to cyclic sequence. */
354 /* three of followings are exclusive flags each them */
355 #define SADB_X_EXT_PSEQ 0x0000 /* sequencial padding for ESP */
356 #define SADB_X_EXT_PRAND 0x0100 /* random padding for ESP */
357 #define SADB_X_EXT_PZERO 0x0200 /* zero padding for ESP */
358 #define SADB_X_EXT_PMASK 0x0300 /* mask for padding flag */
361 #define SADB_X_EXT_RAWCPI 0x0080 /* use well known CPI (IPComp) */
364 #define SADB_KEY_FLAGS_MAX 0x0fff
366 /* SPI size for PF_KEYv2 */
367 #define PFKEY_SPI_SIZE sizeof(u_int32_t)
369 /* Identifier for menber of lifetime structure */
370 #define SADB_X_LIFETIME_ALLOCATIONS 0
371 #define SADB_X_LIFETIME_BYTES 1
372 #define SADB_X_LIFETIME_ADDTIME 2
373 #define SADB_X_LIFETIME_USETIME 3
375 /* The rate for SOFT lifetime against HARD one. */
376 #define PFKEY_SOFT_LIFETIME_RATE 80
379 #define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
380 #define PFKEY_EXTLEN(msg) \
381 PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len)
382 #define PFKEY_ADDR_PREFIX(ext) \
383 (((struct sadb_address *)(ext))->sadb_address_prefixlen)
384 #define PFKEY_ADDR_PROTO(ext) \
385 (((struct sadb_address *)(ext))->sadb_address_proto)
386 #define PFKEY_ADDR_SADDR(ext) \
387 ((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address)))
390 #define PFKEY_UNUNIT64(a) ((a) << 3)
391 #define PFKEY_UNIT64(a) ((a) >> 3)
393 #endif /* __PFKEY_V2_H */
395 #endif /* _NET_PFKEYV2_H_ */