bsd/net/pfkeyv2.h

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