xref: /freebsd/sys/net/pfkeyv2.h (revision 63d1fd5970ec814904aa0f4580b10a0d302d08b2)
1 /*	$FreeBSD$	*/
2 /*	$KAME: pfkeyv2.h,v 1.37 2003/09/06 05:15:43 itojun Exp $	*/
3 
4 /*-
5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * This file has been derived rfc 2367,
35  * And added some flags of SADB_KEY_FLAGS_ as SADB_X_EXT_.
36  *	sakane@ydc.co.jp
37  */
38 
39 #ifndef _NET_PFKEYV2_H_
40 #define _NET_PFKEYV2_H_
41 
42 /*
43 This file defines structures and symbols for the PF_KEY Version 2
44 key management interface. It was written at the U.S. Naval Research
45 Laboratory. This file is in the public domain. The authors ask that
46 you leave this credit intact on any copies of this file.
47 */
48 #ifndef __PFKEY_V2_H
49 #define __PFKEY_V2_H 1
50 
51 #define PF_KEY_V2 2
52 #define PFKEYV2_REVISION        199806L
53 
54 #define SADB_RESERVED    0
55 #define SADB_GETSPI      1
56 #define SADB_UPDATE      2
57 #define SADB_ADD         3
58 #define SADB_DELETE      4
59 #define SADB_GET         5
60 #define SADB_ACQUIRE     6
61 #define SADB_REGISTER    7
62 #define SADB_EXPIRE      8
63 #define SADB_FLUSH       9
64 #define SADB_DUMP        10
65 #define SADB_X_PROMISC   11
66 #define SADB_X_PCHANGE   12
67 
68 #define SADB_X_SPDUPDATE  13
69 #define SADB_X_SPDADD     14
70 #define SADB_X_SPDDELETE  15	/* by policy index */
71 #define SADB_X_SPDGET     16
72 #define SADB_X_SPDACQUIRE 17
73 #define SADB_X_SPDDUMP    18
74 #define SADB_X_SPDFLUSH   19
75 #define SADB_X_SPDSETIDX  20
76 #define SADB_X_SPDEXPIRE  21
77 #define SADB_X_SPDDELETE2 22	/* by policy id */
78 #define SADB_MAX          22
79 
80 struct sadb_msg {
81   u_int8_t sadb_msg_version;
82   u_int8_t sadb_msg_type;
83   u_int8_t sadb_msg_errno;
84   u_int8_t sadb_msg_satype;
85   u_int16_t sadb_msg_len;
86   u_int16_t sadb_msg_reserved;
87   u_int32_t sadb_msg_seq;
88   u_int32_t sadb_msg_pid;
89 };
90 
91 struct sadb_ext {
92   u_int16_t sadb_ext_len;
93   u_int16_t sadb_ext_type;
94 };
95 
96 struct sadb_sa {
97   u_int16_t sadb_sa_len;
98   u_int16_t sadb_sa_exttype;
99   u_int32_t sadb_sa_spi;
100   u_int8_t sadb_sa_replay;
101   u_int8_t sadb_sa_state;
102   u_int8_t sadb_sa_auth;
103   u_int8_t sadb_sa_encrypt;
104   u_int32_t sadb_sa_flags;
105 };
106 
107 struct sadb_lifetime {
108   u_int16_t sadb_lifetime_len;
109   u_int16_t sadb_lifetime_exttype;
110   u_int32_t sadb_lifetime_allocations;
111   u_int64_t sadb_lifetime_bytes;
112   u_int64_t sadb_lifetime_addtime;
113   u_int64_t sadb_lifetime_usetime;
114 };
115 
116 struct sadb_address {
117   u_int16_t sadb_address_len;
118   u_int16_t sadb_address_exttype;
119   u_int8_t sadb_address_proto;
120   u_int8_t sadb_address_prefixlen;
121   u_int16_t sadb_address_reserved;
122 };
123 
124 struct sadb_key {
125   u_int16_t sadb_key_len;
126   u_int16_t sadb_key_exttype;
127   u_int16_t sadb_key_bits;
128   u_int16_t sadb_key_reserved;
129 };
130 
131 struct sadb_ident {
132   u_int16_t sadb_ident_len;
133   u_int16_t sadb_ident_exttype;
134   u_int16_t sadb_ident_type;
135   u_int16_t sadb_ident_reserved;
136   u_int64_t sadb_ident_id;
137 };
138 
139 struct sadb_sens {
140   u_int16_t sadb_sens_len;
141   u_int16_t sadb_sens_exttype;
142   u_int32_t sadb_sens_dpd;
143   u_int8_t sadb_sens_sens_level;
144   u_int8_t sadb_sens_sens_len;
145   u_int8_t sadb_sens_integ_level;
146   u_int8_t sadb_sens_integ_len;
147   u_int32_t sadb_sens_reserved;
148 };
149 
150 struct sadb_prop {
151   u_int16_t sadb_prop_len;
152   u_int16_t sadb_prop_exttype;
153   u_int8_t sadb_prop_replay;
154   u_int8_t sadb_prop_reserved[3];
155 };
156 
157 struct sadb_comb {
158   u_int8_t sadb_comb_auth;
159   u_int8_t sadb_comb_encrypt;
160   u_int16_t sadb_comb_flags;
161   u_int16_t sadb_comb_auth_minbits;
162   u_int16_t sadb_comb_auth_maxbits;
163   u_int16_t sadb_comb_encrypt_minbits;
164   u_int16_t sadb_comb_encrypt_maxbits;
165   u_int32_t sadb_comb_reserved;
166   u_int32_t sadb_comb_soft_allocations;
167   u_int32_t sadb_comb_hard_allocations;
168   u_int64_t sadb_comb_soft_bytes;
169   u_int64_t sadb_comb_hard_bytes;
170   u_int64_t sadb_comb_soft_addtime;
171   u_int64_t sadb_comb_hard_addtime;
172   u_int64_t sadb_comb_soft_usetime;
173   u_int64_t sadb_comb_hard_usetime;
174 };
175 
176 struct sadb_supported {
177   u_int16_t sadb_supported_len;
178   u_int16_t sadb_supported_exttype;
179   u_int32_t sadb_supported_reserved;
180 };
181 
182 struct sadb_alg {
183   u_int8_t sadb_alg_id;
184   u_int8_t sadb_alg_ivlen;
185   u_int16_t sadb_alg_minbits;
186   u_int16_t sadb_alg_maxbits;
187   u_int16_t sadb_alg_reserved;
188 };
189 
190 struct sadb_spirange {
191   u_int16_t sadb_spirange_len;
192   u_int16_t sadb_spirange_exttype;
193   u_int32_t sadb_spirange_min;
194   u_int32_t sadb_spirange_max;
195   u_int32_t sadb_spirange_reserved;
196 };
197 
198 struct sadb_x_kmprivate {
199   u_int16_t sadb_x_kmprivate_len;
200   u_int16_t sadb_x_kmprivate_exttype;
201   u_int32_t sadb_x_kmprivate_reserved;
202 };
203 
204 /*
205  * XXX Additional SA Extension.
206  * mode: tunnel or transport
207  * reqid: to make SA unique nevertheless the address pair of SA are same.
208  *        Mainly it's for VPN.
209  */
210 struct sadb_x_sa2 {
211   u_int16_t sadb_x_sa2_len;
212   u_int16_t sadb_x_sa2_exttype;
213   u_int8_t sadb_x_sa2_mode;
214   u_int8_t sadb_x_sa2_reserved1;
215   u_int16_t sadb_x_sa2_reserved2;
216   u_int32_t sadb_x_sa2_sequence;	/* lowermost 32bit of sequence number */
217   u_int32_t sadb_x_sa2_reqid;
218 };
219 
220 /* XXX Policy Extension */
221 struct sadb_x_policy {
222   u_int16_t sadb_x_policy_len;
223   u_int16_t sadb_x_policy_exttype;
224   u_int16_t sadb_x_policy_type;		/* See policy type of ipsec.h */
225   u_int8_t sadb_x_policy_dir;		/* direction, see ipsec.h */
226   u_int8_t sadb_x_policy_reserved;
227   u_int32_t sadb_x_policy_id;
228   u_int32_t sadb_x_policy_priority;
229 };
230 _Static_assert(sizeof(struct sadb_x_policy) == 16, "struct size mismatch");
231 
232 /*
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))
237  */
238 
239 /* XXX IPsec Policy Request Extension */
240 /*
241  * This structure is aligned 8 bytes.
242  */
243 struct sadb_x_ipsecrequest {
244   u_int16_t sadb_x_ipsecrequest_len;	/* structure length in 64 bits. */
245   u_int16_t sadb_x_ipsecrequest_proto;	/* See ipsec.h */
246   u_int8_t sadb_x_ipsecrequest_mode;	/* See IPSEC_MODE_XX in ipsec.h. */
247   u_int8_t sadb_x_ipsecrequest_level;	/* See IPSEC_LEVEL_XX in ipsec.h */
248   u_int16_t sadb_x_ipsecrequest_reqid;	/* See ipsec.h */
249 
250   /*
251    * followed by source IP address of SA, and immediately followed by
252    * destination IP address of SA.  These encoded into two of sockaddr
253    * structure without any padding.  Must set each sa_len exactly.
254    * Each of length of the sockaddr structure are not aligned to 64bits,
255    * but sum of x_request and addresses is aligned to 64bits.
256    */
257 };
258 
259 /* NAT-Traversal type, see RFC 3948 (and drafts). */
260 struct sadb_x_nat_t_type {
261   u_int16_t sadb_x_nat_t_type_len;
262   u_int16_t sadb_x_nat_t_type_exttype;
263   u_int8_t sadb_x_nat_t_type_type;
264   u_int8_t sadb_x_nat_t_type_reserved[3];
265 };
266 _Static_assert(sizeof(struct sadb_x_nat_t_type) == 8, "struct size mismatch");
267 
268 /* NAT-Traversal source or destination port. */
269 struct sadb_x_nat_t_port {
270   u_int16_t sadb_x_nat_t_port_len;
271   u_int16_t sadb_x_nat_t_port_exttype;
272   u_int16_t sadb_x_nat_t_port_port;
273   u_int16_t sadb_x_nat_t_port_reserved;
274 };
275 _Static_assert(sizeof(struct sadb_x_nat_t_port) == 8, "struct size mismatch");
276 
277 /* ESP fragmentation size. */
278 struct sadb_x_nat_t_frag {
279   u_int16_t sadb_x_nat_t_frag_len;
280   u_int16_t sadb_x_nat_t_frag_exttype;
281   u_int16_t sadb_x_nat_t_frag_fraglen;
282   u_int16_t sadb_x_nat_t_frag_reserved;
283 };
284 _Static_assert(sizeof(struct sadb_x_nat_t_frag) == 8, "struct size mismatch");
285 
286 /* Additional large replay window support
287  */
288 struct sadb_x_sa_replay {
289   u_int16_t sadb_x_sa_replay_len;
290   u_int16_t sadb_x_sa_replay_exttype;
291   u_int32_t sadb_x_sa_replay_replay;	/* in packets */
292 };
293 _Static_assert(sizeof(struct sadb_x_sa_replay) == 8, "struct size mismatch");
294 
295 #define SADB_EXT_RESERVED             0
296 #define SADB_EXT_SA                   1
297 #define SADB_EXT_LIFETIME_CURRENT     2
298 #define SADB_EXT_LIFETIME_HARD        3
299 #define SADB_EXT_LIFETIME_SOFT        4
300 #define SADB_EXT_ADDRESS_SRC          5
301 #define SADB_EXT_ADDRESS_DST          6
302 #define SADB_EXT_ADDRESS_PROXY        7
303 #define SADB_EXT_KEY_AUTH             8
304 #define SADB_EXT_KEY_ENCRYPT          9
305 #define SADB_EXT_IDENTITY_SRC         10
306 #define SADB_EXT_IDENTITY_DST         11
307 #define SADB_EXT_SENSITIVITY          12
308 #define SADB_EXT_PROPOSAL             13
309 #define SADB_EXT_SUPPORTED_AUTH       14
310 #define SADB_EXT_SUPPORTED_ENCRYPT    15
311 #define SADB_EXT_SPIRANGE             16
312 #define SADB_X_EXT_KMPRIVATE          17
313 #define SADB_X_EXT_POLICY             18
314 #define SADB_X_EXT_SA2                19
315 #define SADB_X_EXT_NAT_T_TYPE         20
316 #define SADB_X_EXT_NAT_T_SPORT        21
317 #define SADB_X_EXT_NAT_T_DPORT        22
318 #define SADB_X_EXT_NAT_T_OA           23	/* Deprecated. */
319 #define SADB_X_EXT_NAT_T_OAI          23	/* Peer's NAT_OA for src of SA. */
320 #define SADB_X_EXT_NAT_T_OAR          24	/* Peer's NAT_OA for dst of SA. */
321 #define SADB_X_EXT_NAT_T_FRAG         25	/* Manual MTU override. */
322 #define SADB_X_EXT_SA_REPLAY          26	/* Replay window override. */
323 #define SADB_EXT_MAX                  26
324 
325 #define SADB_SATYPE_UNSPEC	0
326 #define SADB_SATYPE_AH		2
327 #define SADB_SATYPE_ESP		3
328 #define SADB_SATYPE_RSVP	5
329 #define SADB_SATYPE_OSPFV2	6
330 #define SADB_SATYPE_RIPV2	7
331 #define SADB_SATYPE_MIP		8
332 #define SADB_X_SATYPE_IPCOMP	9
333 /*#define SADB_X_SATYPE_POLICY	10	obsolete, do not reuse */
334 #define SADB_X_SATYPE_TCPSIGNATURE	11
335 #define SADB_SATYPE_MAX		12
336 
337 #define SADB_SASTATE_LARVAL   0
338 #define SADB_SASTATE_MATURE   1
339 #define SADB_SASTATE_DYING    2
340 #define SADB_SASTATE_DEAD     3
341 #define SADB_SASTATE_MAX      3
342 
343 #define SADB_SAFLAGS_PFS      1
344 
345 /*
346  * Though some of these numbers (both _AALG and _EALG) appear to be
347  * IKEv2 numbers and others original IKE numbers, they have no meaning.
348  * These are constants that the various IKE daemons use to tell the kernel
349  * what cipher to use.
350  *
351  * Do not use these constants directly to decide which Transformation ID
352  * to send.  You are responsible for mapping them yourself.
353  */
354 #define SADB_AALG_NONE		0
355 #define SADB_AALG_MD5HMAC	2
356 #define SADB_AALG_SHA1HMAC	3
357 #define SADB_AALG_MAX		252
358 #define SADB_X_AALG_SHA2_256	5
359 #define SADB_X_AALG_SHA2_384	6
360 #define SADB_X_AALG_SHA2_512	7
361 #define SADB_X_AALG_RIPEMD160HMAC	8
362 #define SADB_X_AALG_AES_XCBC_MAC	9	/* RFC3566 */
363 #define SADB_X_AALG_AES128GMAC	11		/* RFC4543 + Errata1821 */
364 #define SADB_X_AALG_AES192GMAC	12
365 #define SADB_X_AALG_AES256GMAC	13
366 #define SADB_X_AALG_MD5		249	/* Keyed MD5 */
367 #define SADB_X_AALG_SHA		250	/* Keyed SHA */
368 #define SADB_X_AALG_NULL	251	/* null authentication */
369 #define SADB_X_AALG_TCP_MD5	252	/* Keyed TCP-MD5 (RFC2385) */
370 
371 #define SADB_EALG_NONE		0
372 #define SADB_EALG_DESCBC	2
373 #define SADB_EALG_3DESCBC	3
374 #define SADB_X_EALG_CAST128CBC	6
375 #define SADB_X_EALG_BLOWFISHCBC	7
376 #define SADB_EALG_NULL		11
377 #define SADB_X_EALG_RIJNDAELCBC	12
378 #define SADB_X_EALG_AES		12
379 #define SADB_X_EALG_AESCTR	13
380 #define SADB_X_EALG_AESGCM8	18	/* RFC4106 */
381 #define SADB_X_EALG_AESGCM12	19
382 #define SADB_X_EALG_AESGCM16	20
383 #define SADB_X_EALG_CAMELLIACBC	22
384 #define SADB_X_EALG_AESGMAC	23	/* RFC4543 + Errata1821 */
385 #define SADB_EALG_MAX		23	/* !!! keep updated !!! */
386 
387 /* private allocations - based on RFC2407/IANA assignment */
388 #define SADB_X_CALG_NONE	0
389 #define SADB_X_CALG_OUI		1
390 #define SADB_X_CALG_DEFLATE	2
391 #define SADB_X_CALG_LZS		3
392 #define SADB_X_CALG_MAX		4
393 
394 #define SADB_IDENTTYPE_RESERVED   0
395 #define SADB_IDENTTYPE_PREFIX     1
396 #define SADB_IDENTTYPE_FQDN       2
397 #define SADB_IDENTTYPE_USERFQDN   3
398 #define SADB_X_IDENTTYPE_ADDR     4
399 #define SADB_IDENTTYPE_MAX        4
400 
401 /* `flags' in sadb_sa structure holds followings */
402 #define SADB_X_EXT_NONE		0x0000	/* i.e. new format. */
403 #define SADB_X_EXT_OLD		0x0001	/* old format. */
404 
405 #define SADB_X_EXT_IV4B		0x0010	/* IV length of 4 bytes in use */
406 #define SADB_X_EXT_DERIV	0x0020	/* DES derived */
407 #define SADB_X_EXT_CYCSEQ	0x0040	/* allowing to cyclic sequence. */
408 
409 	/* three of followings are exclusive flags each them */
410 #define SADB_X_EXT_PSEQ		0x0000	/* sequencial padding for ESP */
411 #define SADB_X_EXT_PRAND	0x0100	/* random padding for ESP */
412 #define SADB_X_EXT_PZERO	0x0200	/* zero padding for ESP */
413 #define SADB_X_EXT_PMASK	0x0300	/* mask for padding flag */
414 
415 #if 1
416 #define SADB_X_EXT_RAWCPI	0x0080	/* use well known CPI (IPComp) */
417 #endif
418 
419 #define SADB_KEY_FLAGS_MAX	0x0fff
420 
421 /* SPI size for PF_KEYv2 */
422 #define PFKEY_SPI_SIZE	sizeof(u_int32_t)
423 
424 /* Identifier for menber of lifetime structure */
425 #define SADB_X_LIFETIME_ALLOCATIONS	0
426 #define SADB_X_LIFETIME_BYTES		1
427 #define SADB_X_LIFETIME_ADDTIME		2
428 #define SADB_X_LIFETIME_USETIME		3
429 
430 /* The rate for SOFT lifetime against HARD one. */
431 #define PFKEY_SOFT_LIFETIME_RATE	80
432 
433 /* Utilities */
434 #define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
435 #define	PFKEY_EXTLEN(msg) \
436 	PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len)
437 #define PFKEY_ADDR_PREFIX(ext) \
438 	(((struct sadb_address *)(ext))->sadb_address_prefixlen)
439 #define PFKEY_ADDR_PROTO(ext) \
440 	(((struct sadb_address *)(ext))->sadb_address_proto)
441 #define PFKEY_ADDR_SADDR(ext) \
442 	((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address)))
443 
444 /* in 64bits */
445 #define	PFKEY_UNUNIT64(a)	((a) << 3)
446 #define	PFKEY_UNIT64(a)		((a) >> 3)
447 
448 #endif /* __PFKEY_V2_H */
449 
450 #endif /* _NET_PFKEYV2_H_ */
451