bsd/net/pfkeyv2.h

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