sys/net/pfkeyv2.h

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