bsd/net/pfkeyv2.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*      $KAME: pfkeyv2.h,v 1.10 2000/03/22 07:04:20 sakane 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 #include <sys/appleapiopts.h>
  62
  63 /*
  64 This file defines structures and symbols for the PF_KEY Version 2
  65 key management interface. It was written at the U.S. Naval Research
  66 Laboratory. This file is in the public domain. The authors ask that
  67 you leave this credit intact on any copies of this file.
  68 */
  69 #ifndef __PFKEY_V2_H
  70 #define __PFKEY_V2_H 1
  71
  72 #define PF_KEY_V2 2
  73 #define PFKEYV2_REVISION        199806L
  74
  75 #define SADB_RESERVED    0
  76 #define SADB_GETSPI      1
  77 #define SADB_UPDATE      2
  78 #define SADB_ADD         3
  79 #define SADB_DELETE      4
  80 #define SADB_GET         5
  81 #define SADB_ACQUIRE     6
  82 #define SADB_REGISTER    7
  83 #define SADB_EXPIRE      8
  84 #define SADB_FLUSH       9
  85 #define SADB_DUMP        10
  86 #define SADB_X_PROMISC   11
  87 #define SADB_X_PCHANGE   12
  88
  89 #define SADB_X_SPDUPDATE  13
  90 #define SADB_X_SPDADD     14
  91 #define SADB_X_SPDDELETE  15    /* by policy index */
  92 #define SADB_X_SPDGET     16
  93 #define SADB_X_SPDACQUIRE 17
  94 #define SADB_X_SPDDUMP    18
  95 #define SADB_X_SPDFLUSH   19
  96 #define SADB_X_SPDSETIDX  20
  97 #define SADB_X_SPDEXPIRE  21
  98 #define SADB_X_SPDDELETE2 22    /* by policy id */
  99 #define SADB_MAX          22
 100
 101 struct sadb_msg {
 102   u_int8_t sadb_msg_version;
 103   u_int8_t sadb_msg_type;
 104   u_int8_t sadb_msg_errno;
 105   u_int8_t sadb_msg_satype;
 106   u_int16_t sadb_msg_len;
 107   u_int16_t sadb_msg_reserved;
 108   u_int32_t sadb_msg_seq;
 109   u_int32_t sadb_msg_pid;
 110 };
 111
 112 struct sadb_ext {
 113   u_int16_t sadb_ext_len;
 114   u_int16_t sadb_ext_type;
 115 };
 116
 117 struct sadb_sa {
 118   u_int16_t sadb_sa_len;
 119   u_int16_t sadb_sa_exttype;
 120   u_int32_t sadb_sa_spi;
 121   u_int8_t sadb_sa_replay;
 122   u_int8_t sadb_sa_state;
 123   u_int8_t sadb_sa_auth;
 124   u_int8_t sadb_sa_encrypt;
 125   u_int32_t sadb_sa_flags;
 126 };
 127
 128 struct sadb_lifetime {
 129   u_int16_t sadb_lifetime_len;
 130   u_int16_t sadb_lifetime_exttype;
 131   u_int32_t sadb_lifetime_allocations;
 132   u_int64_t sadb_lifetime_bytes;
 133   u_int64_t sadb_lifetime_addtime;
 134   u_int64_t sadb_lifetime_usetime;
 135 };
 136
 137 struct sadb_address {
 138   u_int16_t sadb_address_len;
 139   u_int16_t sadb_address_exttype;
 140   u_int8_t sadb_address_proto;
 141   u_int8_t sadb_address_prefixlen;
 142   u_int16_t sadb_address_reserved;
 143 };
 144
 145 struct sadb_key {
 146   u_int16_t sadb_key_len;
 147   u_int16_t sadb_key_exttype;
 148   u_int16_t sadb_key_bits;
 149   u_int16_t sadb_key_reserved;
 150 };
 151
 152 struct sadb_ident {
 153   u_int16_t sadb_ident_len;
 154   u_int16_t sadb_ident_exttype;
 155   u_int16_t sadb_ident_type;
 156   u_int16_t sadb_ident_reserved;
 157   u_int64_t sadb_ident_id;
 158 };
 159
 160 struct sadb_sens {
 161   u_int16_t sadb_sens_len;
 162   u_int16_t sadb_sens_exttype;
 163   u_int32_t sadb_sens_dpd;
 164   u_int8_t sadb_sens_sens_level;
 165   u_int8_t sadb_sens_sens_len;
 166   u_int8_t sadb_sens_integ_level;
 167   u_int8_t sadb_sens_integ_len;
 168   u_int32_t sadb_sens_reserved;
 169 };
 170
 171 struct sadb_prop {
 172   u_int16_t sadb_prop_len;
 173   u_int16_t sadb_prop_exttype;
 174   u_int8_t sadb_prop_replay;
 175   u_int8_t sadb_prop_reserved[3];
 176 };
 177
 178 struct sadb_comb {
 179   u_int8_t sadb_comb_auth;
 180   u_int8_t sadb_comb_encrypt;
 181   u_int16_t sadb_comb_flags;
 182   u_int16_t sadb_comb_auth_minbits;
 183   u_int16_t sadb_comb_auth_maxbits;
 184   u_int16_t sadb_comb_encrypt_minbits;
 185   u_int16_t sadb_comb_encrypt_maxbits;
 186   u_int32_t sadb_comb_reserved;
 187   u_int32_t sadb_comb_soft_allocations;
 188   u_int32_t sadb_comb_hard_allocations;
 189   u_int64_t sadb_comb_soft_bytes;
 190   u_int64_t sadb_comb_hard_bytes;
 191   u_int64_t sadb_comb_soft_addtime;
 192   u_int64_t sadb_comb_hard_addtime;
 193   u_int64_t sadb_comb_soft_usetime;
 194   u_int64_t sadb_comb_hard_usetime;
 195 };
 196
 197 struct sadb_supported {
 198   u_int16_t sadb_supported_len;
 199   u_int16_t sadb_supported_exttype;
 200   u_int32_t sadb_supported_reserved;
 201 };
 202
 203 struct sadb_alg {
 204   u_int8_t sadb_alg_id;
 205   u_int8_t sadb_alg_ivlen;
 206   u_int16_t sadb_alg_minbits;
 207   u_int16_t sadb_alg_maxbits;
 208   u_int16_t sadb_alg_reserved;
 209 };
 210
 211 struct sadb_spirange {
 212   u_int16_t sadb_spirange_len;
 213   u_int16_t sadb_spirange_exttype;
 214   u_int32_t sadb_spirange_min;
 215   u_int32_t sadb_spirange_max;
 216   u_int32_t sadb_spirange_reserved;
 217 };
 218
 219 struct sadb_x_kmprivate {
 220   u_int16_t sadb_x_kmprivate_len;
 221   u_int16_t sadb_x_kmprivate_exttype;
 222   u_int32_t sadb_x_kmprivate_reserved;
 223 };
 224
 225 /*
 226  * XXX Additional SA Extension.
 227  * mode: tunnel or transport
 228  * reqid: to make SA unique nevertheless the address pair of SA are same.
 229  *        Mainly it's for VPN.
 230  */
 231 struct sadb_x_sa2 {
 232   u_int16_t sadb_x_sa2_len;
 233   u_int16_t sadb_x_sa2_exttype;
 234   u_int8_t sadb_x_sa2_mode;
 235   u_int8_t sadb_x_sa2_reserved1;
 236   u_int16_t sadb_x_sa2_reserved2;
 237   u_int32_t sadb_x_sa2_reserved3;
 238   u_int32_t sadb_x_sa2_reqid;
 239 };
 240
 241 /* XXX Policy Extension */
 242 /* sizeof(struct sadb_x_policy) == 16 */
 243 struct sadb_x_policy {
 244   u_int16_t sadb_x_policy_len;
 245   u_int16_t sadb_x_policy_exttype;
 246   u_int16_t sadb_x_policy_type;         /* See policy type of ipsec.h */
 247   u_int8_t sadb_x_policy_dir;           /* direction, see ipsec.h */
 248   u_int8_t sadb_x_policy_reserved;
 249   u_int32_t sadb_x_policy_id;
 250   u_int32_t sadb_x_policy_reserved2;
 251 };
 252 /*
 253  * When policy_type == IPSEC, it is followed by some of
 254  * the ipsec policy request.
 255  * [total length of ipsec policy requests]
 256  *      = (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy))
 257  */
 258
 259 /* XXX IPsec Policy Request Extension */
 260 /*
 261  * This structure is aligned 8 bytes.
 262  */
 263 struct sadb_x_ipsecrequest {
 264   u_int16_t sadb_x_ipsecrequest_len;    /* structure length aligned to 8 bytes.
 265                                          * This value is true length of bytes.
 266                                          * Not in units of 64 bits. */
 267   u_int16_t sadb_x_ipsecrequest_proto;  /* See ipsec.h */
 268   u_int8_t sadb_x_ipsecrequest_mode;    /* See IPSEC_MODE_XX in ipsec.h. */
 269   u_int8_t sadb_x_ipsecrequest_level;   /* See IPSEC_LEVEL_XX in ipsec.h */
 270   u_int16_t sadb_x_ipsecrequest_reqid;  /* See ipsec.h */
 271
 272   /*
 273    * followed by source IP address of SA, and immediately followed by
 274    * destination IP address of SA.  These encoded into two of sockaddr
 275    * structure without any padding.  Must set each sa_len exactly.
 276    * Each of length of the sockaddr structure are not aligned to 64bits,
 277    * but sum of x_request and addresses is aligned to 64bits.
 278    */
 279 };
 280
 281 #define SADB_EXT_RESERVED             0
 282 #define SADB_EXT_SA                   1
 283 #define SADB_EXT_LIFETIME_CURRENT     2
 284 #define SADB_EXT_LIFETIME_HARD        3
 285 #define SADB_EXT_LIFETIME_SOFT        4
 286 #define SADB_EXT_ADDRESS_SRC          5
 287 #define SADB_EXT_ADDRESS_DST          6
 288 #define SADB_EXT_ADDRESS_PROXY        7
 289 #define SADB_EXT_KEY_AUTH             8
 290 #define SADB_EXT_KEY_ENCRYPT          9
 291 #define SADB_EXT_IDENTITY_SRC         10
 292 #define SADB_EXT_IDENTITY_DST         11
 293 #define SADB_EXT_SENSITIVITY          12
 294 #define SADB_EXT_PROPOSAL             13
 295 #define SADB_EXT_SUPPORTED_AUTH       14
 296 #define SADB_EXT_SUPPORTED_ENCRYPT    15
 297 #define SADB_EXT_SPIRANGE             16
 298 #define SADB_X_EXT_KMPRIVATE          17
 299 #define SADB_X_EXT_POLICY             18
 300 #define SADB_X_EXT_SA2                19
 301 #define SADB_EXT_MAX                  19
 302
 303 #define SADB_SATYPE_UNSPEC      0
 304 #define SADB_SATYPE_AH          2
 305 #define SADB_SATYPE_ESP         3
 306 #define SADB_SATYPE_RSVP        5
 307 #define SADB_SATYPE_OSPFV2      6
 308 #define SADB_SATYPE_RIPV2       7
 309 #define SADB_SATYPE_MIP         8
 310 #define SADB_X_SATYPE_IPCOMP    9
 311 #define SADB_X_SATYPE_POLICY    10
 312 #define SADB_SATYPE_MAX         11
 313
 314 #define SADB_SASTATE_LARVAL   0
 315 #define SADB_SASTATE_MATURE   1
 316 #define SADB_SASTATE_DYING    2
 317 #define SADB_SASTATE_DEAD     3
 318 #define SADB_SASTATE_MAX      3
 319
 320 #define SADB_SAFLAGS_PFS      1
 321
 322 /* RFC2367 numbers - meets RFC2407 */
 323 #define SADB_AALG_NONE          0
 324 #define SADB_AALG_MD5HMAC       1       /*2*/
 325 #define SADB_AALG_SHA1HMAC      2       /*3*/
 326 #define SADB_AALG_MAX           8
 327 /* private allocations - based on RFC2407/IANA assignment */
 328 #define SADB_X_AALG_SHA2_256    6       /*5*/
 329 #define SADB_X_AALG_SHA2_384    7       /*6*/
 330 #define SADB_X_AALG_SHA2_512    8       /*7*/
 331 /* private allocations should use 249-255 (RFC2407) */
 332 #define SADB_X_AALG_MD5         3       /*249*/ /* Keyed MD5 */
 333 #define SADB_X_AALG_SHA         4       /*250*/ /* Keyed SHA */
 334 #define SADB_X_AALG_NULL        5       /*251*/ /* null authentication */
 335
 336 /* RFC2367 numbers - meets RFC2407 */
 337 #define SADB_EALG_NONE          0
 338 #define SADB_EALG_DESCBC        1       /*2*/
 339 #define SADB_EALG_3DESCBC       2       /*3*/
 340 #define SADB_EALG_NULL          3       /*11*/
 341 #define SADB_EALG_MAX           12
 342 /* private allocations - based on RFC2407/IANA assignment */
 343 #define SADB_X_EALG_CAST128CBC  5       /*6*/
 344 #define SADB_X_EALG_BLOWFISHCBC 4       /*7*/
 345 #define SADB_X_EALG_RIJNDAELCBC 12
 346 #define SADB_X_EALG_AES         12
 347 /* private allocations should use 249-255 (RFC2407) */
 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_ */