Home | History | Annotate | Line # | Download | only in net
pfkeyv2.h revision 1.4
      1 /*	$NetBSD: pfkeyv2.h,v 1.4 2000/02/09 03:27:29 itojun Exp $	*/
      2 
      3 /*
      4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. Neither the name of the project nor the names of its contributors
     16  *    may be used to endorse or promote products derived from this software
     17  *    without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
     23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29  * SUCH DAMAGE.
     30  */
     31 
     32 /* KAME Id: keyv2.h,v 1.14 2000/01/29 06:21:03 itojun Exp */
     33 
     34 /*
     35  * This file has been derived rfc 2367,
     36  * And added some flags of SADB_KEY_FLAGS_ as SADB_X_EXT_.
     37  *	sakane (at) ydc.co.jp
     38  */
     39 
     40 #ifndef _NET_PFKEYV2_H_
     41 #define _NET_PFKEYV2_H_
     42 
     43 /*
     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.
     48 */
     49 #ifndef __PFKEY_V2_H
     50 #define __PFKEY_V2_H 1
     51 
     52 #define PF_KEY_V2 2
     53 #define PFKEYV2_REVISION        199806L
     54 
     55 #define SADB_RESERVED    0
     56 #define SADB_GETSPI      1
     57 #define SADB_UPDATE      2
     58 #define SADB_ADD         3
     59 #define SADB_DELETE      4
     60 #define SADB_GET         5
     61 #define SADB_ACQUIRE     6
     62 #define SADB_REGISTER    7
     63 #define SADB_EXPIRE      8
     64 #define SADB_FLUSH       9
     65 #define SADB_DUMP        10
     66 #define SADB_X_PROMISC   11
     67 #define SADB_X_PCHANGE   12
     68 
     69 #define SADB_X_SPDUPDATE  13	/* not yet */
     70 #define SADB_X_SPDADD     14
     71 #define SADB_X_SPDDELETE  15
     72 #define SADB_X_SPDGET     16	/* not yet */
     73 #define SADB_X_SPDACQUIRE 17	/* not yet */
     74 #define SADB_X_SPDDUMP    18
     75 #define SADB_X_SPDFLUSH   19
     76 #define SADB_X_SPDSETIDX  20	/* add only SPD selector */
     77 #define SADB_X_SPDEXPIRE  21	/* not yet */
     78 #define SADB_MAX          21
     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_int8_t sadb_msg_mode;	/* XXX */
     87   u_int8_t sadb_msg_reserved1;
     88   u_int32_t sadb_msg_seq;
     89   u_int32_t sadb_msg_pid;
     90   u_int32_t sadb_msg_reqid;	/* XXX */
     91   				/* when policy mng, value is zero. */
     92   u_int32_t sadb_msg_reserved2;
     93 };
     94 
     95 struct sadb_ext {
     96   u_int16_t sadb_ext_len;
     97   u_int16_t sadb_ext_type;
     98 };
     99 
    100 struct sadb_sa {
    101   u_int16_t sadb_sa_len;
    102   u_int16_t sadb_sa_exttype;
    103   u_int32_t sadb_sa_spi;
    104   u_int8_t sadb_sa_replay;
    105   u_int8_t sadb_sa_state;
    106   u_int8_t sadb_sa_auth;
    107   u_int8_t sadb_sa_encrypt;
    108   u_int32_t sadb_sa_flags;
    109 };
    110 
    111 struct sadb_lifetime {
    112   u_int16_t sadb_lifetime_len;
    113   u_int16_t sadb_lifetime_exttype;
    114   u_int32_t sadb_lifetime_allocations;
    115   u_int64_t sadb_lifetime_bytes;
    116   u_int64_t sadb_lifetime_addtime;
    117   u_int64_t sadb_lifetime_usetime;
    118 };
    119 
    120 struct sadb_address {
    121   u_int16_t sadb_address_len;
    122   u_int16_t sadb_address_exttype;
    123   u_int8_t sadb_address_proto;
    124   u_int8_t sadb_address_prefixlen;
    125   u_int16_t sadb_address_reserved;
    126 };
    127 
    128 struct sadb_key {
    129   u_int16_t sadb_key_len;
    130   u_int16_t sadb_key_exttype;
    131   u_int16_t sadb_key_bits;
    132   u_int16_t sadb_key_reserved;
    133 };
    134 
    135 struct sadb_ident {
    136   u_int16_t sadb_ident_len;
    137   u_int16_t sadb_ident_exttype;
    138   u_int16_t sadb_ident_type;
    139   u_int16_t sadb_ident_reserved;
    140   u_int64_t sadb_ident_id;
    141 };
    142 /* in order to use to divide sadb_ident.sadb_ident_id */
    143 union sadb_x_ident_id {
    144   u_int64_t sadb_x_ident_id;
    145   struct _sadb_x_ident_id_addr {
    146     u_int16_t prefix;
    147     u_int16_t ul_proto;
    148     u_int32_t reserved;
    149   } sadb_x_ident_id_addr;
    150 };
    151 
    152 struct sadb_sens {
    153   u_int16_t sadb_sens_len;
    154   u_int16_t sadb_sens_exttype;
    155   u_int32_t sadb_sens_dpd;
    156   u_int8_t sadb_sens_sens_level;
    157   u_int8_t sadb_sens_sens_len;
    158   u_int8_t sadb_sens_integ_level;
    159   u_int8_t sadb_sens_integ_len;
    160   u_int32_t sadb_sens_reserved;
    161 };
    162 
    163 struct sadb_prop {
    164   u_int16_t sadb_prop_len;
    165   u_int16_t sadb_prop_exttype;
    166   u_int8_t sadb_prop_replay;
    167   u_int8_t sadb_prop_reserved[3];
    168 };
    169 
    170 struct sadb_comb {
    171   u_int8_t sadb_comb_auth;
    172   u_int8_t sadb_comb_encrypt;
    173   u_int16_t sadb_comb_flags;
    174   u_int16_t sadb_comb_auth_minbits;
    175   u_int16_t sadb_comb_auth_maxbits;
    176   u_int16_t sadb_comb_encrypt_minbits;
    177   u_int16_t sadb_comb_encrypt_maxbits;
    178   u_int32_t sadb_comb_reserved;
    179   u_int32_t sadb_comb_soft_allocations;
    180   u_int32_t sadb_comb_hard_allocations;
    181   u_int64_t sadb_comb_soft_bytes;
    182   u_int64_t sadb_comb_hard_bytes;
    183   u_int64_t sadb_comb_soft_addtime;
    184   u_int64_t sadb_comb_hard_addtime;
    185   u_int64_t sadb_comb_soft_usetime;
    186   u_int64_t sadb_comb_hard_usetime;
    187 };
    188 
    189 struct sadb_supported {
    190   u_int16_t sadb_supported_len;
    191   u_int16_t sadb_supported_exttype;
    192   u_int32_t sadb_supported_reserved;
    193 };
    194 
    195 struct sadb_alg {
    196   u_int8_t sadb_alg_id;
    197   u_int8_t sadb_alg_ivlen;
    198   u_int16_t sadb_alg_minbits;
    199   u_int16_t sadb_alg_maxbits;
    200   u_int16_t sadb_alg_reserved;
    201 };
    202 
    203 struct sadb_spirange {
    204   u_int16_t sadb_spirange_len;
    205   u_int16_t sadb_spirange_exttype;
    206   u_int32_t sadb_spirange_min;
    207   u_int32_t sadb_spirange_max;
    208   u_int32_t sadb_spirange_reserved;
    209 };
    210 
    211 struct sadb_x_kmprivate {
    212   u_int16_t sadb_x_kmprivate_len;
    213   u_int16_t sadb_x_kmprivate_exttype;
    214   u_int32_t sadb_x_kmprivate_reserved;
    215 };
    216 
    217 /* XXX Policy Extension */
    218 /* sizeof(struct sadb_x_policy) == 8 */
    219 struct sadb_x_policy {
    220   u_int16_t sadb_x_policy_len;
    221   u_int16_t sadb_x_policy_exttype;
    222   u_int16_t sadb_x_policy_type;		/* See policy type of ipsec.h */
    223   u_int8_t sadb_x_policy_dir;		/* direction, see ipsec.h */
    224   u_int8_t sadb_x_policy_reserved;
    225 };
    226 /*
    227  * When policy_type == IPSEC, it is followed by some of
    228  * the ipsec policy request.
    229  * [total length of ipsec policy requests]
    230  *	= (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy))
    231  */
    232 
    233 /* XXX IPsec Policy Request Extension */
    234 /*
    235  * This structure is aligned 8 bytes.
    236  */
    237 struct sadb_x_ipsecrequest {
    238   u_int16_t sadb_x_ipsecrequest_len;	/* structure length aligned to 8 bytes.
    239 					 * This value is true length of bytes.
    240 					 * Not in units of 64 bits. */
    241   u_int16_t sadb_x_ipsecrequest_proto;	/* See ipsec.h */
    242   u_int8_t sadb_x_ipsecrequest_mode;	/* See IPSEC_MODE_XX in ipsec.h. */
    243   u_int8_t sadb_x_ipsecrequest_level;	/* See IPSEC_LEVEL_XX in ipsec.h */
    244   u_int16_t sadb_x_ipsecrequest_reqid;	/* See ipsec.h */
    245 
    246   /*
    247    * followed by source IP address of SA, and immediately followed by
    248    * destination IP address of SA.  These encoded into two of sockaddr
    249    * structure without any padding.  Must set each sa_len exactly.
    250    * Each of length of the sockaddr structure are not aligned to 64bits,
    251    * but sum of x_request and addresses is aligned to 64bits.
    252    */
    253 };
    254 
    255 #define SADB_EXT_RESERVED             0
    256 #define SADB_EXT_SA                   1
    257 #define SADB_EXT_LIFETIME_CURRENT     2
    258 #define SADB_EXT_LIFETIME_HARD        3
    259 #define SADB_EXT_LIFETIME_SOFT        4
    260 #define SADB_EXT_ADDRESS_SRC          5
    261 #define SADB_EXT_ADDRESS_DST          6
    262 #define SADB_EXT_ADDRESS_PROXY        7
    263 #define SADB_EXT_KEY_AUTH             8
    264 #define SADB_EXT_KEY_ENCRYPT          9
    265 #define SADB_EXT_IDENTITY_SRC         10
    266 #define SADB_EXT_IDENTITY_DST         11
    267 #define SADB_EXT_SENSITIVITY          12
    268 #define SADB_EXT_PROPOSAL             13
    269 #define SADB_EXT_SUPPORTED_AUTH       14
    270 #define SADB_EXT_SUPPORTED_ENCRYPT    15
    271 #define SADB_EXT_SPIRANGE             16
    272 #define SADB_X_EXT_KMPRIVATE          17
    273 #define SADB_X_EXT_POLICY             18
    274 #define SADB_EXT_MAX                  18
    275 
    276 #define SADB_SATYPE_UNSPEC	0
    277 #define SADB_SATYPE_AH		2
    278 #define SADB_SATYPE_ESP		3
    279 #define SADB_SATYPE_RSVP	5
    280 #define SADB_SATYPE_OSPFV2	6
    281 #define SADB_SATYPE_RIPV2	7
    282 #define SADB_SATYPE_MIP		8
    283 #define SADB_X_SATYPE_IPCOMP	9
    284 #define SADB_SATYPE_MAX		9
    285 
    286 #define SADB_SASTATE_LARVAL   0
    287 #define SADB_SASTATE_MATURE   1
    288 #define SADB_SASTATE_DYING    2
    289 #define SADB_SASTATE_DEAD     3
    290 #define SADB_SASTATE_MAX      3
    291 
    292 #define SADB_SAFLAGS_PFS      1
    293 
    294 #define SADB_AALG_NONE          0
    295 #define SADB_AALG_MD5HMAC       1	/* 2 */
    296 #define SADB_AALG_SHA1HMAC      2	/* 3 */
    297 #define SADB_AALG_MD5           3       /* Keyed MD5 */
    298 #define SADB_AALG_SHA           4       /* Keyed SHA */
    299 #define SADB_AALG_NULL          5       /* null authentication */
    300 #define SADB_AALG_MAX           6
    301 
    302 #define SADB_EALG_NONE          0
    303 #define SADB_EALG_DESCBC        1	/* 2 */
    304 #define SADB_EALG_3DESCBC       2	/* 3 */
    305 #define SADB_EALG_NULL          3	/* 11 */
    306 #define SADB_EALG_BLOWFISHCBC   4
    307 #define SADB_EALG_CAST128CBC    5
    308 #if 0
    309 #define SADB_EALG_RC5CBC        6
    310 #define SADB_EALG_MAX           7
    311 #else
    312 #define SADB_EALG_MAX           6
    313 #endif
    314 
    315 #if 1	/*nonstandard */
    316 #define SADB_X_CALG_NONE	0
    317 #define SADB_X_CALG_OUI		1
    318 #define SADB_X_CALG_DEFLATE	2
    319 #define SADB_X_CALG_LZS		3
    320 #define SADB_X_CALG_MAX		4
    321 #endif
    322 
    323 #define SADB_IDENTTYPE_RESERVED   0
    324 #define SADB_IDENTTYPE_PREFIX     1
    325 #define SADB_IDENTTYPE_FQDN       2
    326 #define SADB_IDENTTYPE_USERFQDN   3
    327 #define SADB_X_IDENTTYPE_ADDR     4
    328 #define SADB_IDENTTYPE_MAX        4
    329 
    330 /* `flags' in sadb_sa structure holds followings */
    331 #define SADB_X_EXT_NONE		0x0000	/* i.e. new format. */
    332 #define SADB_X_EXT_OLD		0x0001	/* old format. */
    333 
    334 #define SADB_X_EXT_IV4B		0x0010	/* IV length of 4 bytes in use */
    335 #define SADB_X_EXT_DERIV	0x0020	/* DES derived */
    336 #define SADB_X_EXT_CYCSEQ	0x0040	/* allowing to cyclic sequence. */
    337 
    338 	/* three of followings are exclusive flags each them */
    339 #define SADB_X_EXT_PSEQ		0x0000	/* sequencial padding for ESP */
    340 #define SADB_X_EXT_PRAND	0x0100	/* random padding for ESP */
    341 #define SADB_X_EXT_PZERO	0x0200	/* zero padding for ESP */
    342 #define SADB_X_EXT_PMASK	0x0300	/* mask for padding flag */
    343 
    344 #if 1
    345 #define SADB_X_EXT_RAWCPI	0x0080	/* use well known CPI (IPComp) */
    346 #endif
    347 
    348 #define SADB_KEY_FLAGS_MAX	0x0fff
    349 
    350 /* SPI size for PF_KEYv2 */
    351 #define PFKEY_SPI_SIZE	sizeof(u_int32_t)
    352 
    353 /* Identifier for menber of lifetime structure */
    354 #define SADB_X_LIFETIME_ALLOCATIONS	0
    355 #define SADB_X_LIFETIME_BYTES		1
    356 #define SADB_X_LIFETIME_ADDTIME		2
    357 #define SADB_X_LIFETIME_USETIME		3
    358 
    359 /* The rate for SOFT lifetime against HARD one. */
    360 #define PFKEY_SOFT_LIFETIME_RATE	80
    361 
    362 /* Utilities */
    363 #define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
    364 #define	PFKEY_EXTLEN(msg) \
    365 	PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len)
    366 #define PFKEY_ADDR_PREFIX(ext) \
    367 	(((struct sadb_address *)(ext))->sadb_address_prefixlen)
    368 #define PFKEY_ADDR_PROTO(ext) \
    369 	(((struct sadb_address *)(ext))->sadb_address_proto)
    370 #define PFKEY_ADDR_SADDR(ext) \
    371 	((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address)))
    372 
    373 #if 1
    374 /* in 64bits */
    375 #define	PFKEY_UNUNIT64(a)	((a) << 3)
    376 #define	PFKEY_UNIT64(a)		((a) >> 3)
    377 #else
    378 #define	PFKEY_UNUNIT64(a)	(a)
    379 #define	PFKEY_UNIT64(a)		(a)
    380 #endif
    381 
    382 #ifndef _KERNEL
    383 extern void pfkey_sadump __P((struct sadb_msg *));
    384 extern void pfkey_spdump __P((struct sadb_msg *));
    385 
    386 struct sockaddr;
    387 int ipsec_check_keylen __P((u_int, u_int, u_int));
    388 u_int pfkey_set_softrate __P((u_int, u_int));
    389 u_int pfkey_get_softrate __P((u_int));
    390 int pfkey_send_getspi __P((int, u_int, u_int, struct sockaddr *,
    391 	struct sockaddr *, u_int32_t, u_int32_t, u_int32_t, u_int32_t));
    392 int pfkey_send_update __P((int, u_int, u_int, struct sockaddr *,
    393 	struct sockaddr *, u_int32_t, u_int32_t, u_int,
    394 	caddr_t, u_int, u_int, u_int, u_int, u_int, u_int32_t, u_int64_t,
    395 	u_int64_t, u_int64_t, u_int32_t));
    396 int pfkey_send_add __P((int, u_int, u_int, struct sockaddr *,
    397 	struct sockaddr *, u_int32_t, u_int32_t, u_int,
    398 	caddr_t, u_int, u_int, u_int, u_int, u_int, u_int32_t, u_int64_t,
    399 	u_int64_t, u_int64_t, u_int32_t));
    400 int pfkey_send_delete __P((int, u_int, u_int,
    401 	struct sockaddr *, struct sockaddr *, u_int32_t));
    402 int pfkey_send_get __P((int, u_int, u_int,
    403 	struct sockaddr *, struct sockaddr *, u_int32_t));
    404 int pfkey_send_register __P((int, u_int));
    405 int pfkey_recv_register __P((int));
    406 int pfkey_send_flush __P((int, u_int));
    407 int pfkey_send_dump __P((int, u_int));
    408 int pfkey_send_promisc_toggle __P((int, int));
    409 int pfkey_send_spdadd __P((int, struct sockaddr *, u_int,
    410 	struct sockaddr *, u_int, u_int, caddr_t, int, u_int32_t));
    411 int pfkey_send_spddelete __P((int, struct sockaddr *, u_int,
    412 	struct sockaddr *, u_int, u_int, u_int32_t));
    413 int pfkey_send_spdflush __P((int));
    414 int pfkey_send_spddump __P((int));
    415 
    416 int pfkey_open __P((void));
    417 void pfkey_close __P((int));
    418 struct sadb_msg *pfkey_recv __P((int));
    419 int pfkey_send __P((int, struct sadb_msg *, int));
    420 int pfkey_align __P((struct sadb_msg *, caddr_t *));
    421 int pfkey_check __P((caddr_t *));
    422 
    423 #endif /*!_KERNEL*/
    424 
    425 #endif /* __PFKEY_V2_H */
    426 
    427 #endif /* _NET_PFKEYV2_H_ */
    428