1/* 2 * Copyright (c) 2000-2011 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#include <net/if.h> 69 70/* 71This file defines structures and symbols for the PF_KEY Version 2 72key management interface. It was written at the U.S. Naval Research 73Laboratory. This file is in the public domain. The authors ask that 74you leave this credit intact on any copies of this file. 75*/ 76#ifndef __PFKEY_V2_H 77#define __PFKEY_V2_H 1 78 79#define PF_KEY_V2 2 80#define PFKEYV2_REVISION 199806L 81 82#define SADB_RESERVED 0 83#define SADB_GETSPI 1 84#define SADB_UPDATE 2 85#define SADB_ADD 3 86#define SADB_DELETE 4 87#define SADB_GET 5 88#define SADB_ACQUIRE 6 89#define SADB_REGISTER 7 90#define SADB_EXPIRE 8 91#define SADB_FLUSH 9 92#define SADB_DUMP 10 93#define SADB_X_PROMISC 11 94#define SADB_X_PCHANGE 12 95 96#define SADB_X_SPDUPDATE 13 97#define SADB_X_SPDADD 14 98#define SADB_X_SPDDELETE 15 /* by policy index */ 99#define SADB_X_SPDGET 16 100#define SADB_X_SPDACQUIRE 17 101#define SADB_X_SPDDUMP 18 102#define SADB_X_SPDFLUSH 19 103#define SADB_X_SPDSETIDX 20 104#define SADB_X_SPDEXPIRE 21 105#define SADB_X_SPDDELETE2 22 /* by policy id */ 106#define SADB_GETSASTAT 23 107#define SADB_X_SPDENABLE 24 /* by policy id */ 108#define SADB_X_SPDDISABLE 25 /* by policy id */ 109#define SADB_MAX 25 110 111struct sadb_msg { 112 u_int8_t sadb_msg_version; 113 u_int8_t sadb_msg_type; 114 u_int8_t sadb_msg_errno; 115 u_int8_t sadb_msg_satype; 116 u_int16_t sadb_msg_len; 117 u_int16_t sadb_msg_reserved; 118 u_int32_t sadb_msg_seq; 119 u_int32_t sadb_msg_pid; 120}; 121 122struct sadb_ext { 123 u_int16_t sadb_ext_len; 124 u_int16_t sadb_ext_type; 125}; 126 127struct sadb_sa { 128 u_int16_t sadb_sa_len; 129 u_int16_t sadb_sa_exttype; 130 u_int32_t sadb_sa_spi; 131 u_int8_t sadb_sa_replay; 132 u_int8_t sadb_sa_state; 133 u_int8_t sadb_sa_auth; 134 u_int8_t sadb_sa_encrypt; 135 u_int32_t sadb_sa_flags; 136}; 137 138#ifdef PRIVATE 139struct sadb_sa_2 { 140 struct sadb_sa sa; 141 u_int16_t sadb_sa_natt_port; 142 u_int16_t sadb_reserved0; 143 u_int32_t sadb_reserved1; 144}; 145#endif /* PRIVATE */ 146 147struct sadb_lifetime { 148 u_int16_t sadb_lifetime_len; 149 u_int16_t sadb_lifetime_exttype; 150 u_int32_t sadb_lifetime_allocations; 151 u_int64_t sadb_lifetime_bytes; 152 u_int64_t sadb_lifetime_addtime; 153 u_int64_t sadb_lifetime_usetime; 154}; 155 156struct sadb_address { 157 u_int16_t sadb_address_len; 158 u_int16_t sadb_address_exttype; 159 u_int8_t sadb_address_proto; 160 u_int8_t sadb_address_prefixlen; 161 u_int16_t sadb_address_reserved; 162}; 163 164struct sadb_key { 165 u_int16_t sadb_key_len; 166 u_int16_t sadb_key_exttype; 167 u_int16_t sadb_key_bits; 168 u_int16_t sadb_key_reserved; 169}; 170 171struct sadb_ident { 172 u_int16_t sadb_ident_len; 173 u_int16_t sadb_ident_exttype; 174 u_int16_t sadb_ident_type; 175 u_int16_t sadb_ident_reserved; 176 u_int64_t sadb_ident_id; 177}; 178 179struct sadb_sens { 180 u_int16_t sadb_sens_len; 181 u_int16_t sadb_sens_exttype; 182 u_int32_t sadb_sens_dpd; 183 u_int8_t sadb_sens_sens_level; 184 u_int8_t sadb_sens_sens_len; 185 u_int8_t sadb_sens_integ_level; 186 u_int8_t sadb_sens_integ_len; 187 u_int32_t sadb_sens_reserved; 188}; 189 190struct sadb_prop { 191 u_int16_t sadb_prop_len; 192 u_int16_t sadb_prop_exttype; 193 u_int8_t sadb_prop_replay; 194 u_int8_t sadb_prop_reserved[3]; 195}; 196 197struct sadb_comb { 198 u_int8_t sadb_comb_auth; 199 u_int8_t sadb_comb_encrypt; 200 u_int16_t sadb_comb_flags; 201 u_int16_t sadb_comb_auth_minbits; 202 u_int16_t sadb_comb_auth_maxbits; 203 u_int16_t sadb_comb_encrypt_minbits; 204 u_int16_t sadb_comb_encrypt_maxbits; 205 u_int32_t sadb_comb_reserved; 206 u_int32_t sadb_comb_soft_allocations; 207 u_int32_t sadb_comb_hard_allocations; 208 u_int64_t sadb_comb_soft_bytes; 209 u_int64_t sadb_comb_hard_bytes; 210 u_int64_t sadb_comb_soft_addtime; 211 u_int64_t sadb_comb_hard_addtime; 212 u_int64_t sadb_comb_soft_usetime; 213 u_int64_t sadb_comb_hard_usetime; 214}; 215 216struct sadb_supported { 217 u_int16_t sadb_supported_len; 218 u_int16_t sadb_supported_exttype; 219 u_int32_t sadb_supported_reserved; 220}; 221 222struct sadb_alg { 223 u_int8_t sadb_alg_id; 224 u_int8_t sadb_alg_ivlen; 225 u_int16_t sadb_alg_minbits; 226 u_int16_t sadb_alg_maxbits; 227 u_int16_t sadb_alg_reserved; 228}; 229 230struct sadb_spirange { 231 u_int16_t sadb_spirange_len; 232 u_int16_t sadb_spirange_exttype; 233 u_int32_t sadb_spirange_min; 234 u_int32_t sadb_spirange_max; 235 u_int32_t sadb_spirange_reserved; 236}; 237 238struct sadb_x_kmprivate { 239 u_int16_t sadb_x_kmprivate_len; 240 u_int16_t sadb_x_kmprivate_exttype; 241 u_int32_t sadb_x_kmprivate_reserved; 242}; 243 244/* 245 * XXX Additional SA Extension. 246 * mode: tunnel or transport 247 * reqid: to make SA unique nevertheless the address pair of SA are same. 248 * Mainly it's for VPN. 249 */ 250struct sadb_x_sa2 { 251 u_int16_t sadb_x_sa2_len; 252 u_int16_t sadb_x_sa2_exttype; 253 u_int8_t sadb_x_sa2_mode; 254 union { 255 u_int8_t sadb_x_sa2_reserved1; 256#ifdef PRIVATE 257 u_int8_t sadb_x_sa2_alwaysexpire; 258#endif 259 }; 260 u_int16_t sadb_x_sa2_reserved2; 261 u_int32_t sadb_x_sa2_sequence; 262 u_int32_t sadb_x_sa2_reqid; 263}; 264 265/* XXX Policy Extension */ 266/* sizeof(struct sadb_x_policy) == 16 */ 267struct sadb_x_policy { 268 u_int16_t sadb_x_policy_len; 269 u_int16_t sadb_x_policy_exttype; 270 u_int16_t sadb_x_policy_type; /* See policy type of ipsec.h */ 271 u_int8_t sadb_x_policy_dir; /* direction, see ipsec.h */ 272 u_int8_t sadb_x_policy_reserved; 273 u_int32_t sadb_x_policy_id; 274 u_int32_t sadb_x_policy_reserved2; 275}; 276/* 277 * When policy_type == IPSEC, it is followed by some of 278 * the ipsec policy request. 279 * [total length of ipsec policy requests] 280 * = (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy)) 281 */ 282#ifdef PRIVATE 283/* IPSec Interface Extension: 284 * IPSec interface can be specified alone, or all three 285 * of internal, outgoing, and IPSec interfaces must be 286 * specified. 287 */ 288struct sadb_x_ipsecif { 289 u_int16_t sadb_x_ipsecif_len; 290 u_int16_t sadb_x_ipsecif_exttype; 291 char sadb_x_ipsecif_internal_if[IFXNAMSIZ]; /* Steal packets from this interface */ 292 char sadb_x_ipsecif_outgoing_if[IFXNAMSIZ]; /* Send packets out on this interface */ 293 char sadb_x_ipsecif_ipsec_if[IFXNAMSIZ]; /* Direct packets through ipsec interface */ 294 u_int16_t sadb_x_ipsecif_init_disabled; /* 0 or 1, flag to ignore policy */ 295 u_int16_t reserved; 296}; 297#endif 298/* XXX IPsec Policy Request Extension */ 299/* 300 * This structure is aligned 8 bytes. 301 */ 302struct sadb_x_ipsecrequest { 303 u_int16_t sadb_x_ipsecrequest_len; /* structure length aligned to 8 bytes. 304 * This value is true length of bytes. 305 * Not in units of 64 bits. */ 306 u_int16_t sadb_x_ipsecrequest_proto; /* See ipsec.h */ 307 u_int8_t sadb_x_ipsecrequest_mode; /* See IPSEC_MODE_XX in ipsec.h. */ 308 u_int8_t sadb_x_ipsecrequest_level; /* See IPSEC_LEVEL_XX in ipsec.h */ 309 u_int16_t sadb_x_ipsecrequest_reqid; /* See ipsec.h */ 310 311 /* 312 * followed by source IP address of SA, and immediately followed by 313 * destination IP address of SA. These encoded into two of sockaddr 314 * structure without any padding. Must set each sa_len exactly. 315 * Each of length of the sockaddr structure are not aligned to 64bits, 316 * but sum of x_request and addresses is aligned to 64bits. 317 */ 318}; 319 320struct sadb_session_id { 321 u_int16_t sadb_session_id_len; 322 u_int16_t sadb_session_id_exttype; 323 /* [0] is an arbitrary handle that means something only for requester 324 * [1] is a global session id for lookups in the kernel and racoon. 325 */ 326 u_int64_t sadb_session_id_v[2]; 327} __attribute__ ((aligned(8))); 328 329struct sastat { 330 u_int32_t spi; /* SPI Value, network byte order */ 331 u_int32_t created; /* for lifetime */ 332 struct sadb_lifetime lft_c; /* CURRENT lifetime. */ 333}; // no need to align 334 335struct sadb_sastat { 336 u_int16_t sadb_sastat_len; 337 u_int16_t sadb_sastat_exttype; 338 u_int32_t sadb_sastat_dir; 339 u_int32_t sadb_sastat_reserved; 340 u_int32_t sadb_sastat_list_len; 341 /* list of struct sastat comes after */ 342} __attribute__ ((aligned(8))); 343 344#define SADB_EXT_RESERVED 0 345#define SADB_EXT_SA 1 346#define SADB_EXT_LIFETIME_CURRENT 2 347#define SADB_EXT_LIFETIME_HARD 3 348#define SADB_EXT_LIFETIME_SOFT 4 349#define SADB_EXT_ADDRESS_SRC 5 350#define SADB_EXT_ADDRESS_DST 6 351#define SADB_EXT_ADDRESS_PROXY 7 352#define SADB_EXT_KEY_AUTH 8 353#define SADB_EXT_KEY_ENCRYPT 9 354#define SADB_EXT_IDENTITY_SRC 10 355#define SADB_EXT_IDENTITY_DST 11 356#define SADB_EXT_SENSITIVITY 12 357#define SADB_EXT_PROPOSAL 13 358#define SADB_EXT_SUPPORTED_AUTH 14 359#define SADB_EXT_SUPPORTED_ENCRYPT 15 360#define SADB_EXT_SPIRANGE 16 361#define SADB_X_EXT_KMPRIVATE 17 362#define SADB_X_EXT_POLICY 18 363#define SADB_X_EXT_SA2 19 364#define SADB_EXT_SESSION_ID 20 365#define SADB_EXT_SASTAT 21 366#define SADB_X_EXT_IPSECIF 22 367#define SADB_X_EXT_ADDR_RANGE_SRC_START 23 368#define SADB_X_EXT_ADDR_RANGE_SRC_END 24 369#define SADB_X_EXT_ADDR_RANGE_DST_START 25 370#define SADB_X_EXT_ADDR_RANGE_DST_END 26 371#define SADB_EXT_MAX 26 372 373#define SADB_SATYPE_UNSPEC 0 374#define SADB_SATYPE_AH 2 375#define SADB_SATYPE_ESP 3 376#define SADB_SATYPE_RSVP 5 377#define SADB_SATYPE_OSPFV2 6 378#define SADB_SATYPE_RIPV2 7 379#define SADB_SATYPE_MIP 8 380#define SADB_X_SATYPE_IPCOMP 9 381#define SADB_X_SATYPE_POLICY 10 382#define SADB_SATYPE_MAX 11 383 384#define SADB_SASTATE_LARVAL 0 385#define SADB_SASTATE_MATURE 1 386#define SADB_SASTATE_DYING 2 387#define SADB_SASTATE_DEAD 3 388#define SADB_SASTATE_MAX 3 389 390#define SADB_SAFLAGS_PFS 1 391 392/* RFC2367 numbers - meets RFC2407 */ 393#define SADB_AALG_NONE 0 394#define SADB_AALG_MD5HMAC 1 /*2*/ 395#define SADB_AALG_SHA1HMAC 2 /*3*/ 396#define SADB_AALG_MAX 8 397/* private allocations - based on RFC2407/IANA assignment */ 398#define SADB_X_AALG_SHA2_256 6 /*5*/ 399#define SADB_X_AALG_SHA2_384 7 /*6*/ 400#define SADB_X_AALG_SHA2_512 8 /*7*/ 401/* private allocations should use 249-255 (RFC2407) */ 402#define SADB_X_AALG_MD5 3 /*249*/ /* Keyed MD5 */ 403#define SADB_X_AALG_SHA 4 /*250*/ /* Keyed SHA */ 404#define SADB_X_AALG_NULL 5 /*251*/ /* null authentication */ 405 406/* RFC2367 numbers - meets RFC2407 */ 407#define SADB_EALG_NONE 0 408#define SADB_EALG_DESCBC 1 /*2*/ 409#define SADB_EALG_3DESCBC 2 /*3*/ 410#define SADB_EALG_NULL 3 /*11*/ 411#define SADB_EALG_MAX 12 412/* private allocations - based on RFC2407/IANA assignment */ 413#define SADB_X_EALG_CAST128CBC 5 /*6*/ 414#define SADB_X_EALG_BLOWFISHCBC 4 /*7*/ 415#define SADB_X_EALG_RIJNDAELCBC 12 416#define SADB_X_EALG_AESCBC 12 417#define SADB_X_EALG_AES 12 418/* private allocations should use 249-255 (RFC2407) */ 419 420#if 1 /*nonstandard */ 421#define SADB_X_CALG_NONE 0 422#define SADB_X_CALG_OUI 1 423#define SADB_X_CALG_DEFLATE 2 424#define SADB_X_CALG_LZS 3 425#define SADB_X_CALG_MAX 4 426#endif 427 428#define SADB_IDENTTYPE_RESERVED 0 429#define SADB_IDENTTYPE_PREFIX 1 430#define SADB_IDENTTYPE_FQDN 2 431#define SADB_IDENTTYPE_USERFQDN 3 432#define SADB_X_IDENTTYPE_ADDR 4 433#define SADB_IDENTTYPE_MAX 4 434 435/* `flags' in sadb_sa structure holds followings */ 436#define SADB_X_EXT_NONE 0x0000 /* i.e. new format. */ 437#define SADB_X_EXT_OLD 0x0001 /* old format. */ 438#ifdef PRIVATE 439#define SADB_X_EXT_NATT 0x0002 /* Use UDP encapsulation to traverse NAT */ 440#define SADB_X_EXT_NATT_KEEPALIVE 0x0004 /* Local node is behind NAT, send keepalives */ 441 /* Should only be set for outbound SAs */ 442#define SADB_X_EXT_NATT_MULTIPLEUSERS 0x0008 /* For use on VPN server - support multiple users */ 443 444#endif /* PRIVATE */ 445 446#define SADB_X_EXT_IV4B 0x0010 /* IV length of 4 bytes in use */ 447#define SADB_X_EXT_DERIV 0x0020 /* DES derived */ 448#define SADB_X_EXT_CYCSEQ 0x0040 /* allowing to cyclic sequence. */ 449 450 /* three of followings are exclusive flags each them */ 451#define SADB_X_EXT_PSEQ 0x0000 /* sequencial padding for ESP */ 452#define SADB_X_EXT_PRAND 0x0100 /* random padding for ESP */ 453#define SADB_X_EXT_PZERO 0x0200 /* zero padding for ESP */ 454#define SADB_X_EXT_PMASK 0x0300 /* mask for padding flag */ 455 456#ifdef PRIVATE 457#define SADB_X_EXT_NATT_DETECTED_PEER 0x1000 458#define SADB_X_EXT_ESP_KEEPALIVE 0x2000 459#define SADB_X_EXT_PUNT_RX_KEEPALIVE 0x4000 460#endif /* PRIVATE */ 461 462#if 1 463#define SADB_X_EXT_RAWCPI 0x0080 /* use well known CPI (IPComp) */ 464#endif 465 466#define SADB_KEY_FLAGS_MAX 0x0fff 467 468/* SPI size for PF_KEYv2 */ 469#define PFKEY_SPI_SIZE sizeof(u_int32_t) 470 471/* Identifier for menber of lifetime structure */ 472#define SADB_X_LIFETIME_ALLOCATIONS 0 473#define SADB_X_LIFETIME_BYTES 1 474#define SADB_X_LIFETIME_ADDTIME 2 475#define SADB_X_LIFETIME_USETIME 3 476 477/* The rate for SOFT lifetime against HARD one. */ 478#define PFKEY_SOFT_LIFETIME_RATE 80 479 480/* Utilities */ 481#define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1))) 482#define PFKEY_EXTLEN(msg) \ 483 PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len) 484#define PFKEY_ADDR_PREFIX(ext) \ 485 (((struct sadb_address *)(ext))->sadb_address_prefixlen) 486#define PFKEY_ADDR_PROTO(ext) \ 487 (((struct sadb_address *)(ext))->sadb_address_proto) 488#define PFKEY_ADDR_SADDR(ext) \ 489 ((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address))) 490 491/* in 64bits */ 492#define PFKEY_UNUNIT64(a) ((a) << 3) 493#define PFKEY_UNIT64(a) ((a) >> 3) 494 495#endif /* __PFKEY_V2_H */ 496 497#endif /* _NET_PFKEYV2_H_ */ 498