Home | History | Annotate | Line # | Download | only in net
pfkeyv2.h revision 1.22
      1 /*	$NetBSD: pfkeyv2.h,v 1.22 2005/06/28 15:33:27 christos Exp $	*/
      2 /*	$KAME: pfkeyv2.h,v 1.36 2003/07/25 09:33:37 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 (at) 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	/* not yet */
     77 #define SADB_X_SPDDELETE2 22	/* by policy id */
     78 #define SADB_X_NAT_T_NEW_MAPPING 23
     79 #define SADB_MAX          23
     80 
     81 struct sadb_msg {
     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;
     90 };
     91 
     92 struct sadb_ext {
     93   u_int16_t sadb_ext_len;
     94   u_int16_t sadb_ext_type;
     95 };
     96 
     97 struct sadb_sa {
     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;
    106 };
    107 
    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;
    115 };
    116 
    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;
    123 };
    124 
    125 struct sadb_key {
    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;
    130 };
    131 
    132 struct sadb_ident {
    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;
    138 };
    139 
    140 struct sadb_sens {
    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;
    149 };
    150 
    151 struct sadb_prop {
    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];
    156 };
    157 
    158 struct sadb_comb {
    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;
    175 };
    176 
    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;
    181 };
    182 
    183 struct sadb_alg {
    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;
    189 };
    190 
    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;
    197 };
    198 
    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;
    203 };
    204 
    205 /*
    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.
    210  */
    211 struct sadb_x_sa2 {
    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;		/* topmost 16bits are always 0 */
    219 };
    220 
    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;
    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 draft-ietf-ipsec-udp-encaps-06 */
    260 /* sizeof(struct sadb_x_nat_t_type) == 8 */
    261 struct sadb_x_nat_t_type {
    262   u_int16_t sadb_x_nat_t_type_len;
    263   u_int16_t sadb_x_nat_t_type_exttype;
    264   u_int8_t sadb_x_nat_t_type_type;
    265   u_int8_t sadb_x_nat_t_type_reserved[3];
    266 };
    267 
    268 /* NAT traversal source or destination port */
    269 /* sizeof(struct sadb_x_nat_t_port) == 8 */
    270 struct sadb_x_nat_t_port {
    271   u_int16_t sadb_x_nat_t_port_len;
    272   u_int16_t sadb_x_nat_t_port_exttype;
    273   u_int16_t sadb_x_nat_t_port_port;
    274   u_int16_t sadb_x_nat_t_port_reserved;
    275 };
    276 
    277 /* ESP fragmentation size */
    278 /* sizeof(struct sadb_x_nat_t_frag) == 8 */
    279 struct sadb_x_nat_t_frag {
    280   u_int16_t sadb_x_nat_t_frag_len;
    281   u_int16_t sadb_x_nat_t_frag_exttype;
    282   u_int16_t sadb_x_nat_t_frag_fraglen;
    283   u_int16_t sadb_x_nat_t_frag_reserved;
    284 };
    285 
    286 
    287 #define SADB_EXT_RESERVED             0
    288 #define SADB_EXT_SA                   1
    289 #define SADB_EXT_LIFETIME_CURRENT     2
    290 #define SADB_EXT_LIFETIME_HARD        3
    291 #define SADB_EXT_LIFETIME_SOFT        4
    292 #define SADB_EXT_ADDRESS_SRC          5
    293 #define SADB_EXT_ADDRESS_DST          6
    294 #define SADB_EXT_ADDRESS_PROXY        7
    295 #define SADB_EXT_KEY_AUTH             8
    296 #define SADB_EXT_KEY_ENCRYPT          9
    297 #define SADB_EXT_IDENTITY_SRC         10
    298 #define SADB_EXT_IDENTITY_DST         11
    299 #define SADB_EXT_SENSITIVITY          12
    300 #define SADB_EXT_PROPOSAL             13
    301 #define SADB_EXT_SUPPORTED_AUTH       14
    302 #define SADB_EXT_SUPPORTED_ENCRYPT    15
    303 #define SADB_EXT_SPIRANGE             16
    304 #define SADB_X_EXT_KMPRIVATE          17
    305 #define SADB_X_EXT_POLICY             18
    306 #define SADB_X_EXT_SA2                19
    307 #define SADB_X_EXT_NAT_T_TYPE         20
    308 #define SADB_X_EXT_NAT_T_SPORT        21
    309 #define SADB_X_EXT_NAT_T_DPORT        22
    310 #define SADB_X_EXT_NAT_T_OA           23
    311 #define SADB_X_EXT_NAT_T_FRAG	      24
    312 #define SADB_EXT_MAX                  24
    313 
    314 #define SADB_SATYPE_UNSPEC	0
    315 #define SADB_SATYPE_AH		2
    316 #define SADB_SATYPE_ESP		3
    317 #define SADB_SATYPE_RSVP	5
    318 #define SADB_SATYPE_OSPFV2	6
    319 #define SADB_SATYPE_RIPV2	7
    320 #define SADB_SATYPE_MIP		8
    321 #define SADB_X_SATYPE_IPCOMP	9
    322 /*#define SADB_X_SATYPE_POLICY	10	obsolete, do not reuse */
    323 #define SADB_X_SATYPE_TCPSIGNATURE	11
    324 #define SADB_SATYPE_MAX		12
    325 
    326 #define SADB_SASTATE_LARVAL   0
    327 #define SADB_SASTATE_MATURE   1
    328 #define SADB_SASTATE_DYING    2
    329 #define SADB_SASTATE_DEAD     3
    330 #define SADB_SASTATE_MAX      3
    331 
    332 #define SADB_SAFLAGS_PFS      1
    333 
    334 /* RFC2367 numbers - meets RFC2407 */
    335 #define SADB_AALG_NONE		0
    336 #define SADB_AALG_MD5HMAC	2
    337 #define SADB_AALG_SHA1HMAC	3
    338 #define SADB_AALG_MAX		251
    339 /* private allocations - based on RFC2407/IANA assignment */
    340 #define SADB_X_AALG_SHA2_256	5
    341 #define SADB_X_AALG_SHA2_384	6
    342 #define SADB_X_AALG_SHA2_512	7
    343 #define SADB_X_AALG_RIPEMD160HMAC 8
    344 #define SADB_X_AALG_AES_XCBC_MAC 9 /* draft-ietf-ipsec-ciph-aes-xcbc-mac-04 */
    345 /* private allocations should use 249-255 (RFC2407) */
    346 #define SADB_X_AALG_MD5		249	/* Keyed MD5 */
    347 #define SADB_X_AALG_SHA		250	/* Keyed SHA */
    348 #define SADB_X_AALG_NULL	251	/* null authentication */
    349 #define SADB_X_AALG_TCP_MD5	252	/* Keyed TCP-MD5 (RFC2385) */
    350 
    351 /* RFC2367 numbers - meets RFC2407 */
    352 #define SADB_EALG_NONE		0
    353 #define SADB_EALG_DESCBC	2
    354 #define SADB_EALG_3DESCBC	3
    355 #define SADB_EALG_NULL		11
    356 #define SADB_EALG_MAX		250
    357 /* private allocations - based on RFC2407/IANA assignment */
    358 #define SADB_X_EALG_CAST128CBC	6
    359 #define SADB_X_EALG_BLOWFISHCBC	7
    360 #define SADB_X_EALG_RIJNDAELCBC	12
    361 #define SADB_X_EALG_AES		12
    362 #define SADB_X_EALG_AESCTR	13
    363 /* private allocations should use 249-255 (RFC2407) */
    364 #define SADB_X_EALG_SKIPJACK    250
    365 
    366 /* private allocations - based on RFC2407/IANA assignment */
    367 #define SADB_X_CALG_NONE	0
    368 #define SADB_X_CALG_OUI		1
    369 #define SADB_X_CALG_DEFLATE	2
    370 #define SADB_X_CALG_LZS		3
    371 #define SADB_X_CALG_MAX		4
    372 
    373 #define SADB_IDENTTYPE_RESERVED   0
    374 #define SADB_IDENTTYPE_PREFIX     1
    375 #define SADB_IDENTTYPE_FQDN       2
    376 #define SADB_IDENTTYPE_USERFQDN   3
    377 #define SADB_X_IDENTTYPE_ADDR     4
    378 #define SADB_IDENTTYPE_MAX        4
    379 
    380 /* `flags' in sadb_sa structure holds followings */
    381 #define SADB_X_EXT_NONE		0x0000	/* i.e. new format. */
    382 #define SADB_X_EXT_OLD		0x0001	/* old format. */
    383 
    384 #define SADB_X_EXT_IV4B		0x0010	/* IV length of 4 bytes in use */
    385 #define SADB_X_EXT_DERIV	0x0020	/* DES derived */
    386 #define SADB_X_EXT_CYCSEQ	0x0040	/* allowing to cyclic sequence. */
    387 
    388 	/* three of followings are exclusive flags each them */
    389 #define SADB_X_EXT_PSEQ		0x0000	/* sequencial padding for ESP */
    390 #define SADB_X_EXT_PRAND	0x0100	/* random padding for ESP */
    391 #define SADB_X_EXT_PZERO	0x0200	/* zero padding for ESP */
    392 #define SADB_X_EXT_PMASK	0x0300	/* mask for padding flag */
    393 
    394 #if 1
    395 #define SADB_X_EXT_RAWCPI	0x0080	/* use well known CPI (IPComp) */
    396 #endif
    397 
    398 #define SADB_KEY_FLAGS_MAX	0x0fff
    399 
    400 /* SPI size for PF_KEYv2 */
    401 #define PFKEY_SPI_SIZE	sizeof(u_int32_t)
    402 
    403 /* Identifier for menber of lifetime structure */
    404 #define SADB_X_LIFETIME_ALLOCATIONS	0
    405 #define SADB_X_LIFETIME_BYTES		1
    406 #define SADB_X_LIFETIME_ADDTIME		2
    407 #define SADB_X_LIFETIME_USETIME		3
    408 
    409 /* The rate for SOFT lifetime against HARD one. */
    410 #define PFKEY_SOFT_LIFETIME_RATE	80
    411 
    412 /* Utilities */
    413 #define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
    414 #define	PFKEY_EXTLEN(msg) \
    415 	PFKEY_UNUNIT64(((struct sadb_ext *)(void *)(msg))->sadb_ext_len)
    416 #define PFKEY_ADDR_PREFIX(ext) \
    417 	(((struct sadb_address *)(void *)(ext))->sadb_address_prefixlen)
    418 #define PFKEY_ADDR_PROTO(ext) \
    419 	(((struct sadb_address *)(void *)(ext))->sadb_address_proto)
    420 #define PFKEY_ADDR_SADDR(ext) \
    421 	((struct sockaddr *)(void *)((char *)(void *)(ext) + \
    422 	sizeof(struct sadb_address)))
    423 
    424 /* in 64bits */
    425 #define	PFKEY_UNUNIT64(a)	((a) << 3)
    426 #define	PFKEY_UNIT64(a)		((a) >> 3)
    427 
    428 #endif /* __PFKEY_V2_H */
    429 
    430 #endif /* _NET_PFKEYV2_H_ */
    431