packages/net/bsd_tcpip/v2_0/include/net/pfkeyv2.h

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