bsd/net/pfkeyv2.h

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