sys/net/pfkeyv2.h

   1 /*      $FreeBSD: src/sys/net/pfkeyv2.h,v 1.14.2.1 2007/12/07 08:45:28 gnn Exp $        */
   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 #ifndef _SYS_TYPES_H_
  43 #include <sys/types.h>
  44 #endif
  45
  46 /*
  47 This file defines structures and symbols for the PF_KEY Version 2
  48 key management interface. It was written at the U.S. Naval Research
  49 Laboratory. This file is in the public domain. The authors ask that
  50 you leave this credit intact on any copies of this file.
  51 */
  52 #ifndef __PFKEY_V2_H
  53 #define __PFKEY_V2_H 1
  54
  55 #define PF_KEY_V2 2
  56 #define PFKEYV2_REVISION        199806L
  57
  58 #define SADB_RESERVED    0
  59 #define SADB_GETSPI      1
  60 #define SADB_UPDATE      2
  61 #define SADB_ADD         3
  62 #define SADB_DELETE      4
  63 #define SADB_GET         5
  64 #define SADB_ACQUIRE     6
  65 #define SADB_REGISTER    7
  66 #define SADB_EXPIRE      8
  67 #define SADB_FLUSH       9
  68 #define SADB_DUMP        10
  69 #define SADB_X_PROMISC   11
  70 #define SADB_X_PCHANGE   12
  71
  72 #define SADB_X_SPDUPDATE  13
  73 #define SADB_X_SPDADD     14
  74 #define SADB_X_SPDDELETE  15    /* by policy index */
  75 #define SADB_X_SPDGET     16
  76 #define SADB_X_SPDACQUIRE 17
  77 #define SADB_X_SPDDUMP    18
  78 #define SADB_X_SPDFLUSH   19
  79 #define SADB_X_SPDSETIDX  20
  80 #define SADB_X_SPDEXPIRE  21
  81 #define SADB_X_SPDDELETE2 22    /* by policy id */
  82 #define SADB_MAX          22
  83
  84 struct sadb_msg {
  85   u_int8_t sadb_msg_version;
  86   u_int8_t sadb_msg_type;
  87   u_int8_t sadb_msg_errno;
  88   u_int8_t sadb_msg_satype;
  89   u_int16_t sadb_msg_len;
  90   u_int16_t sadb_msg_reserved;
  91   u_int32_t sadb_msg_seq;
  92   u_int32_t sadb_msg_pid;
  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
 143 struct sadb_sens {
 144   u_int16_t sadb_sens_len;
 145   u_int16_t sadb_sens_exttype;
 146   u_int32_t sadb_sens_dpd;
 147   u_int8_t sadb_sens_sens_level;
 148   u_int8_t sadb_sens_sens_len;
 149   u_int8_t sadb_sens_integ_level;
 150   u_int8_t sadb_sens_integ_len;
 151   u_int32_t sadb_sens_reserved;
 152 };
 153
 154 struct sadb_prop {
 155   u_int16_t sadb_prop_len;
 156   u_int16_t sadb_prop_exttype;
 157   u_int8_t sadb_prop_replay;
 158   u_int8_t sadb_prop_reserved[3];
 159 };
 160
 161 struct sadb_comb {
 162   u_int8_t sadb_comb_auth;
 163   u_int8_t sadb_comb_encrypt;
 164   u_int16_t sadb_comb_flags;
 165   u_int16_t sadb_comb_auth_minbits;
 166   u_int16_t sadb_comb_auth_maxbits;
 167   u_int16_t sadb_comb_encrypt_minbits;
 168   u_int16_t sadb_comb_encrypt_maxbits;
 169   u_int32_t sadb_comb_reserved;
 170   u_int32_t sadb_comb_soft_allocations;
 171   u_int32_t sadb_comb_hard_allocations;
 172   u_int64_t sadb_comb_soft_bytes;
 173   u_int64_t sadb_comb_hard_bytes;
 174   u_int64_t sadb_comb_soft_addtime;
 175   u_int64_t sadb_comb_hard_addtime;
 176   u_int64_t sadb_comb_soft_usetime;
 177   u_int64_t sadb_comb_hard_usetime;
 178 };
 179
 180 struct sadb_supported {
 181   u_int16_t sadb_supported_len;
 182   u_int16_t sadb_supported_exttype;
 183   u_int32_t sadb_supported_reserved;
 184 };
 185
 186 struct sadb_alg {
 187   u_int8_t sadb_alg_id;
 188   u_int8_t sadb_alg_ivlen;
 189   u_int16_t sadb_alg_minbits;
 190   u_int16_t sadb_alg_maxbits;
 191   u_int16_t sadb_alg_reserved;
 192 };
 193
 194 struct sadb_spirange {
 195   u_int16_t sadb_spirange_len;
 196   u_int16_t sadb_spirange_exttype;
 197   u_int32_t sadb_spirange_min;
 198   u_int32_t sadb_spirange_max;
 199   u_int32_t sadb_spirange_reserved;
 200 };
 201
 202 struct sadb_x_kmprivate {
 203   u_int16_t sadb_x_kmprivate_len;
 204   u_int16_t sadb_x_kmprivate_exttype;
 205   u_int32_t sadb_x_kmprivate_reserved;
 206 };
 207
 208 /*
 209  * XXX Additional SA Extension.
 210  * mode: tunnel or transport
 211  * reqid: to make SA unique nevertheless the address pair of SA are same.
 212  *        Mainly it's for VPN.
 213  */
 214 struct sadb_x_sa2 {
 215   u_int16_t sadb_x_sa2_len;
 216   u_int16_t sadb_x_sa2_exttype;
 217   u_int8_t sadb_x_sa2_mode;
 218   u_int8_t sadb_x_sa2_reserved1;
 219   u_int16_t sadb_x_sa2_reserved2;
 220   u_int32_t sadb_x_sa2_sequence;        /* lowermost 32bit of sequence number */
 221   u_int32_t sadb_x_sa2_reqid;
 222 };
 223
 224 /* XXX Policy Extension */
 225 /* sizeof(struct sadb_x_policy) == 16 */
 226 struct sadb_x_policy {
 227   u_int16_t sadb_x_policy_len;
 228   u_int16_t sadb_x_policy_exttype;
 229   u_int16_t sadb_x_policy_type;         /* See policy type of ipsec.h */
 230   u_int8_t sadb_x_policy_dir;           /* direction, see ipsec.h */
 231   u_int8_t sadb_x_policy_reserved;
 232   u_int32_t sadb_x_policy_id;
 233   u_int32_t sadb_x_policy_reserved2;
 234 };
 235 /*
 236  * When policy_type == IPSEC, it is followed by some of
 237  * the ipsec policy request.
 238  * [total length of ipsec policy requests]
 239  *      = (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy))
 240  */
 241
 242 /* XXX IPsec Policy Request Extension */
 243 /*
 244  * This structure is aligned 8 bytes.
 245  */
 246 struct sadb_x_ipsecrequest {
 247   u_int16_t sadb_x_ipsecrequest_len;    /* structure length in 64 bits. */
 248   u_int16_t sadb_x_ipsecrequest_proto;  /* See ipsec.h */
 249   u_int8_t sadb_x_ipsecrequest_mode;    /* See IPSEC_MODE_XX in ipsec.h. */
 250   u_int8_t sadb_x_ipsecrequest_level;   /* See IPSEC_LEVEL_XX in ipsec.h */
 251   u_int16_t sadb_x_ipsecrequest_reqid;  /* See ipsec.h */
 252
 253   /*
 254    * followed by source IP address of SA, and immediately followed by
 255    * destination IP address of SA.  These encoded into two of sockaddr
 256    * structure without any padding.  Must set each sa_len exactly.
 257    * Each of length of the sockaddr structure are not aligned to 64bits,
 258    * but sum of x_request and addresses is aligned to 64bits.
 259    */
 260 };
 261
 262 #define SADB_EXT_RESERVED             0
 263 #define SADB_EXT_SA                   1
 264 #define SADB_EXT_LIFETIME_CURRENT     2
 265 #define SADB_EXT_LIFETIME_HARD        3
 266 #define SADB_EXT_LIFETIME_SOFT        4
 267 #define SADB_EXT_ADDRESS_SRC          5
 268 #define SADB_EXT_ADDRESS_DST          6
 269 #define SADB_EXT_ADDRESS_PROXY        7
 270 #define SADB_EXT_KEY_AUTH             8
 271 #define SADB_EXT_KEY_ENCRYPT          9
 272 #define SADB_EXT_IDENTITY_SRC         10
 273 #define SADB_EXT_IDENTITY_DST         11
 274 #define SADB_EXT_SENSITIVITY          12
 275 #define SADB_EXT_PROPOSAL             13
 276 #define SADB_EXT_SUPPORTED_AUTH       14
 277 #define SADB_EXT_SUPPORTED_ENCRYPT    15
 278 #define SADB_EXT_SPIRANGE             16
 279 #define SADB_X_EXT_KMPRIVATE          17
 280 #define SADB_X_EXT_POLICY             18
 281 #define SADB_X_EXT_SA2                19
 282 #define SADB_EXT_MAX                  19
 283
 284 #define SADB_SATYPE_UNSPEC      0
 285 #define SADB_SATYPE_AH          2
 286 #define SADB_SATYPE_ESP         3
 287 #define SADB_SATYPE_RSVP        5
 288 #define SADB_SATYPE_OSPFV2      6
 289 #define SADB_SATYPE_RIPV2       7
 290 #define SADB_SATYPE_MIP         8
 291 #define SADB_X_SATYPE_IPCOMP    9
 292 /*#define SADB_X_SATYPE_POLICY  10      obsolete, do not reuse */
 293 #define SADB_X_SATYPE_TCPSIGNATURE      11
 294 #define SADB_SATYPE_MAX         12
 295
 296 #define SADB_SASTATE_LARVAL   0
 297 #define SADB_SASTATE_MATURE   1
 298 #define SADB_SASTATE_DYING    2
 299 #define SADB_SASTATE_DEAD     3
 300 #define SADB_SASTATE_MAX      3
 301
 302 #define SADB_SAFLAGS_PFS      1
 303
 304 /* RFC2367 numbers - meets RFC2407 */
 305 #define SADB_AALG_NONE          0
 306 #define SADB_AALG_MD5HMAC       2
 307 #define SADB_AALG_SHA1HMAC      3
 308 #define SADB_AALG_MAX           252
 309 /* private allocations - based on RFC2407/IANA assignment */
 310 #define SADB_X_AALG_SHA2_256    5
 311 #define SADB_X_AALG_SHA2_384    6
 312 #define SADB_X_AALG_SHA2_512    7
 313 #define SADB_X_AALG_RIPEMD160HMAC       8
 314 #define SADB_X_AALG_AES_XCBC_MAC        9       /* draft-ietf-ipsec-ciph-aes-xcbc-mac-04 */
 315 /* private allocations should use 249-255 (RFC2407) */
 316 #define SADB_X_AALG_MD5         249     /* Keyed MD5 */
 317 #define SADB_X_AALG_SHA         250     /* Keyed SHA */
 318 #define SADB_X_AALG_NULL        251     /* null authentication */
 319 #define SADB_X_AALG_TCP_MD5     252     /* Keyed TCP-MD5 (RFC2385) */
 320
 321 /* RFC2367 numbers - meets RFC2407 */
 322 #define SADB_EALG_NONE          0
 323 #define SADB_EALG_DESCBC        2
 324 #define SADB_EALG_3DESCBC       3
 325 #define SADB_EALG_NULL          11
 326 #define SADB_EALG_MAX           250
 327 /* private allocations - based on RFC2407/IANA assignment */
 328 #define SADB_X_EALG_CAST128CBC  6
 329 #define SADB_X_EALG_BLOWFISHCBC 7
 330 #define SADB_X_EALG_RIJNDAELCBC 12
 331 #define SADB_X_EALG_AES         12
 332 /* private allocations - based on RFC4312/IANA assignment */
 333 #define SADB_X_EALG_CAMELLIACBC 22
 334
 335 /* private allocations should use 249-255 (RFC2407) */
 336 #define SADB_X_EALG_SKIPJACK    249     /*250*/ /* for FAST_IPSEC */
 337 #define SADB_X_EALG_AESCTR      250     /*249*/ /* draft-ietf-ipsec-ciph-aes-ctr-03 */
 338
 339 /* private allocations - based on RFC2407/IANA assignment */
 340 #define SADB_X_CALG_NONE        0
 341 #define SADB_X_CALG_OUI         1
 342 #define SADB_X_CALG_DEFLATE     2
 343 #define SADB_X_CALG_LZS         3
 344 #define SADB_X_CALG_MAX         4
 345
 346 #define SADB_IDENTTYPE_RESERVED   0
 347 #define SADB_IDENTTYPE_PREFIX     1
 348 #define SADB_IDENTTYPE_FQDN       2
 349 #define SADB_IDENTTYPE_USERFQDN   3
 350 #define SADB_X_IDENTTYPE_ADDR     4
 351 #define SADB_IDENTTYPE_MAX        4
 352
 353 /* `flags' in sadb_sa structure holds followings */
 354 #define SADB_X_EXT_NONE         0x0000  /* i.e. new format. */
 355 #define SADB_X_EXT_OLD          0x0001  /* old format. */
 356
 357 #define SADB_X_EXT_IV4B         0x0010  /* IV length of 4 bytes in use */
 358 #define SADB_X_EXT_DERIV        0x0020  /* DES derived */
 359 #define SADB_X_EXT_CYCSEQ       0x0040  /* allowing to cyclic sequence. */
 360
 361         /* three of followings are exclusive flags each them */
 362 #define SADB_X_EXT_PSEQ         0x0000  /* sequencial padding for ESP */
 363 #define SADB_X_EXT_PRAND        0x0100  /* random padding for ESP */
 364 #define SADB_X_EXT_PZERO        0x0200  /* zero padding for ESP */
 365 #define SADB_X_EXT_PMASK        0x0300  /* mask for padding flag */
 366
 367 #if 1
 368 #define SADB_X_EXT_RAWCPI       0x0080  /* use well known CPI (IPComp) */
 369 #endif
 370
 371 #define SADB_KEY_FLAGS_MAX      0x0fff
 372
 373 /* SPI size for PF_KEYv2 */
 374 #define PFKEY_SPI_SIZE  sizeof(u_int32_t)
 375
 376 /* Identifier for menber of lifetime structure */
 377 #define SADB_X_LIFETIME_ALLOCATIONS     0
 378 #define SADB_X_LIFETIME_BYTES           1
 379 #define SADB_X_LIFETIME_ADDTIME         2
 380 #define SADB_X_LIFETIME_USETIME         3
 381
 382 /* The rate for SOFT lifetime against HARD one. */
 383 #define PFKEY_SOFT_LIFETIME_RATE        80
 384
 385 /* Utilities */
 386 #define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
 387 #define PFKEY_EXTLEN(msg) \
 388         PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len)
 389 #define PFKEY_ADDR_PREFIX(ext) \
 390         (((struct sadb_address *)(ext))->sadb_address_prefixlen)
 391 #define PFKEY_ADDR_PROTO(ext) \
 392         (((struct sadb_address *)(ext))->sadb_address_proto)
 393 #define PFKEY_ADDR_SADDR(ext) \
 394         ((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address)))
 395
 396 /* in 64bits */
 397 #define PFKEY_UNUNIT64(a)       ((a) << 3)
 398 #define PFKEY_UNIT64(a)         ((a) >> 3)
 399
 400 #endif /* __PFKEY_V2_H */
 401
 402 #endif /* _NET_PFKEYV2_H_ */