[apple/xnu.git] / bsd / net / pfkeyv2.h

/*
 * Copyright (c) 2000-2011 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*	$KAME: pfkeyv2.h,v 1.10 2000/03/22 07:04:20 sakane Exp $	*/

/*
 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * This file has been derived rfc 2367,
 * And added some flags of SADB_KEY_FLAGS_ as SADB_X_EXT_.
 *	sakane@ydc.co.jp
 */

#ifndef _NET_PFKEYV2_H_
#define _NET_PFKEYV2_H_
#include <sys/appleapiopts.h>
#include <net/if.h>

/*
This file defines structures and symbols for the PF_KEY Version 2
key management interface. It was written at the U.S. Naval Research
Laboratory. This file is in the public domain. The authors ask that
you leave this credit intact on any copies of this file.
*/
#ifndef __PFKEY_V2_H
#define __PFKEY_V2_H 1

#define PF_KEY_V2 2
#define PFKEYV2_REVISION        199806L

#define SADB_RESERVED    0
#define SADB_GETSPI      1
#define SADB_UPDATE      2
#define SADB_ADD         3
#define SADB_DELETE      4
#define SADB_GET         5
#define SADB_ACQUIRE     6
#define SADB_REGISTER    7
#define SADB_EXPIRE      8
#define SADB_FLUSH       9
#define SADB_DUMP        10
#define SADB_X_PROMISC   11
#define SADB_X_PCHANGE   12

#define SADB_X_SPDUPDATE  13
#define SADB_X_SPDADD     14
#define SADB_X_SPDDELETE  15	/* by policy index */
#define SADB_X_SPDGET     16
#define SADB_X_SPDACQUIRE 17
#define SADB_X_SPDDUMP    18
#define SADB_X_SPDFLUSH   19
#define SADB_X_SPDSETIDX  20
#define SADB_X_SPDEXPIRE  21
#define SADB_X_SPDDELETE2 22	/* by policy id */
#define SADB_GETSASTAT    23
#define SADB_X_SPDENABLE  24	/* by policy id */
#define SADB_X_SPDDISABLE 25	/* by policy id */
#define SADB_MIGRATE      26
#define SADB_MAX          26

struct sadb_msg {
  u_int8_t sadb_msg_version;
  u_int8_t sadb_msg_type;
  u_int8_t sadb_msg_errno;
  u_int8_t sadb_msg_satype;
  u_int16_t sadb_msg_len;
  u_int16_t sadb_msg_reserved;
  u_int32_t sadb_msg_seq;
  u_int32_t sadb_msg_pid;
};

struct sadb_ext {
  u_int16_t sadb_ext_len;
  u_int16_t sadb_ext_type;
};

struct sadb_sa {
  u_int16_t sadb_sa_len;
  u_int16_t sadb_sa_exttype;
  u_int32_t sadb_sa_spi;
  u_int8_t sadb_sa_replay;
  u_int8_t sadb_sa_state;
  u_int8_t sadb_sa_auth;
  u_int8_t sadb_sa_encrypt;
  u_int32_t sadb_sa_flags;
};

#ifdef PRIVATE
struct sadb_sa_2 {
	struct sadb_sa	sa;
	u_int16_t		sadb_sa_natt_port;
	union {
		u_int16_t		sadb_reserved0;
		u_int16_t		sadb_sa_natt_interval;
	};

	union {
		u_int32_t		sadb_reserved1;
		u_int16_t		sadb_sa_natt_offload_interval;
	};
};
#endif /* PRIVATE */

struct sadb_lifetime {
  u_int16_t sadb_lifetime_len;
  u_int16_t sadb_lifetime_exttype;
  u_int32_t sadb_lifetime_allocations;
  u_int64_t sadb_lifetime_bytes;
  u_int64_t sadb_lifetime_addtime;
  u_int64_t sadb_lifetime_usetime;
};

struct sadb_address {
  u_int16_t sadb_address_len;
  u_int16_t sadb_address_exttype;
  u_int8_t sadb_address_proto;
  u_int8_t sadb_address_prefixlen;
  u_int16_t sadb_address_reserved;
};

struct sadb_key {
  u_int16_t sadb_key_len;
  u_int16_t sadb_key_exttype;
  u_int16_t sadb_key_bits;
  u_int16_t sadb_key_reserved;
};

struct sadb_ident {
  u_int16_t sadb_ident_len;
  u_int16_t sadb_ident_exttype;
  u_int16_t sadb_ident_type;
  u_int16_t sadb_ident_reserved;
  u_int64_t sadb_ident_id;
};

struct sadb_sens {
  u_int16_t sadb_sens_len;
  u_int16_t sadb_sens_exttype;
  u_int32_t sadb_sens_dpd;
  u_int8_t sadb_sens_sens_level;
  u_int8_t sadb_sens_sens_len;
  u_int8_t sadb_sens_integ_level;
  u_int8_t sadb_sens_integ_len;
  u_int32_t sadb_sens_reserved;
};

struct sadb_prop {
  u_int16_t sadb_prop_len;
  u_int16_t sadb_prop_exttype;
  u_int8_t sadb_prop_replay;
  u_int8_t sadb_prop_reserved[3];
};

struct sadb_comb {
  u_int8_t sadb_comb_auth;
  u_int8_t sadb_comb_encrypt;
  u_int16_t sadb_comb_flags;
  u_int16_t sadb_comb_auth_minbits;
  u_int16_t sadb_comb_auth_maxbits;
  u_int16_t sadb_comb_encrypt_minbits;
  u_int16_t sadb_comb_encrypt_maxbits;
  u_int32_t sadb_comb_reserved;
  u_int32_t sadb_comb_soft_allocations;
  u_int32_t sadb_comb_hard_allocations;
  u_int64_t sadb_comb_soft_bytes;
  u_int64_t sadb_comb_hard_bytes;
  u_int64_t sadb_comb_soft_addtime;
  u_int64_t sadb_comb_hard_addtime;
  u_int64_t sadb_comb_soft_usetime;
  u_int64_t sadb_comb_hard_usetime;
};

struct sadb_supported {
  u_int16_t sadb_supported_len;
  u_int16_t sadb_supported_exttype;
  u_int32_t sadb_supported_reserved;
};

struct sadb_alg {
  u_int8_t sadb_alg_id;
  u_int8_t sadb_alg_ivlen;
  u_int16_t sadb_alg_minbits;
  u_int16_t sadb_alg_maxbits;
  u_int16_t sadb_alg_reserved;
};

struct sadb_spirange {
  u_int16_t sadb_spirange_len;
  u_int16_t sadb_spirange_exttype;
  u_int32_t sadb_spirange_min;
  u_int32_t sadb_spirange_max;
  u_int32_t sadb_spirange_reserved;
};

struct sadb_x_kmprivate {
  u_int16_t sadb_x_kmprivate_len;
  u_int16_t sadb_x_kmprivate_exttype;
  u_int32_t sadb_x_kmprivate_reserved;
};

/*
 * XXX Additional SA Extension.
 * mode: tunnel or transport
 * reqid: to make SA unique nevertheless the address pair of SA are same.
 *        Mainly it's for VPN.
 */
struct sadb_x_sa2 {
  u_int16_t sadb_x_sa2_len;
  u_int16_t sadb_x_sa2_exttype;
  u_int8_t sadb_x_sa2_mode;
  union {
    u_int8_t sadb_x_sa2_reserved1;
#ifdef PRIVATE
    u_int8_t sadb_x_sa2_alwaysexpire;
#endif
  };
  union {
    u_int16_t sadb_x_sa2_reserved2;
#ifdef PRIVATE
    u_int16_t sadb_x_sa2_flags;
#endif
  };
  u_int32_t sadb_x_sa2_sequence;
  u_int32_t sadb_x_sa2_reqid;
};

/* XXX Policy Extension */
/* sizeof(struct sadb_x_policy) == 16 */
struct sadb_x_policy {
  u_int16_t sadb_x_policy_len;
  u_int16_t sadb_x_policy_exttype;
  u_int16_t sadb_x_policy_type;		/* See policy type of ipsec.h */
  u_int8_t sadb_x_policy_dir;		/* direction, see ipsec.h */
  u_int8_t sadb_x_policy_reserved;
  u_int32_t sadb_x_policy_id;
  u_int32_t sadb_x_policy_reserved2;
};
/*
 * When policy_type == IPSEC, it is followed by some of
 * the ipsec policy request.
 * [total length of ipsec policy requests]
 *	= (sadb_x_policy_len * sizeof(uint64_t) - sizeof(struct sadb_x_policy))
 */
#ifdef PRIVATE
/* IPSec Interface Extension:
 * IPSec interface can be specified alone, or all three
 * of internal, outgoing, and IPSec interfaces must be
 * specified.
 */
struct sadb_x_ipsecif {
	u_int16_t sadb_x_ipsecif_len;
	u_int16_t sadb_x_ipsecif_exttype;
	char sadb_x_ipsecif_internal_if[IFXNAMSIZ]; /* Steal packets from this interface */
	char sadb_x_ipsecif_outgoing_if[IFXNAMSIZ]; /* Send packets out on this interface */
	char sadb_x_ipsecif_ipsec_if[IFXNAMSIZ];  /* Direct packets through ipsec interface */
	u_int16_t sadb_x_ipsecif_init_disabled; /* 0 or 1, flag to ignore policy */
	u_int16_t reserved;
};
#endif
/* XXX IPsec Policy Request Extension */
/*
 * This structure is aligned 8 bytes.
 */
struct sadb_x_ipsecrequest {
  u_int16_t sadb_x_ipsecrequest_len;	/* structure length aligned to 8 bytes.
					 * This value is true length of bytes.
					 * Not in units of 64 bits. */
  u_int16_t sadb_x_ipsecrequest_proto;	/* See ipsec.h */
  u_int8_t sadb_x_ipsecrequest_mode;	/* See IPSEC_MODE_XX in ipsec.h. */
  u_int8_t sadb_x_ipsecrequest_level;	/* See IPSEC_LEVEL_XX in ipsec.h */
  u_int16_t sadb_x_ipsecrequest_reqid;	/* See ipsec.h */

  /*
   * followed by source IP address of SA, and immediately followed by
   * destination IP address of SA.  These encoded into two of sockaddr
   * structure without any padding.  Must set each sa_len exactly.
   * Each of length of the sockaddr structure are not aligned to 64bits,
   * but sum of x_request and addresses is aligned to 64bits.
   */
};

struct sadb_session_id {
        u_int16_t            sadb_session_id_len;
        u_int16_t            sadb_session_id_exttype;
       /* [0] is an arbitrary handle that means something only for requester
        * [1] is a global session id for lookups in the kernel and racoon.
        */
        u_int64_t            sadb_session_id_v[2];
} __attribute__ ((aligned(8)));

struct sastat {
	u_int32_t            spi;		/* SPI Value, network byte order */
	u_int32_t            created;	        /* for lifetime */
	struct sadb_lifetime lft_c;	        /* CURRENT lifetime. */
}; // no need to align

struct sadb_sastat {
        u_int16_t            sadb_sastat_len;
        u_int16_t            sadb_sastat_exttype;
        u_int32_t            sadb_sastat_dir;
        u_int32_t            sadb_sastat_reserved;
        u_int32_t            sadb_sastat_list_len;
        /* list of struct sastat comes after */
} __attribute__ ((aligned(8)));

#define SADB_EXT_RESERVED             0
#define SADB_EXT_SA                   1
#define SADB_EXT_LIFETIME_CURRENT     2
#define SADB_EXT_LIFETIME_HARD        3
#define SADB_EXT_LIFETIME_SOFT        4
#define SADB_EXT_ADDRESS_SRC          5
#define SADB_EXT_ADDRESS_DST          6
#define SADB_EXT_ADDRESS_PROXY        7
#define SADB_EXT_KEY_AUTH             8
#define SADB_EXT_KEY_ENCRYPT          9
#define SADB_EXT_IDENTITY_SRC         10
#define SADB_EXT_IDENTITY_DST         11
#define SADB_EXT_SENSITIVITY          12
#define SADB_EXT_PROPOSAL             13
#define SADB_EXT_SUPPORTED_AUTH       14
#define SADB_EXT_SUPPORTED_ENCRYPT    15
#define SADB_EXT_SPIRANGE             16
#define SADB_X_EXT_KMPRIVATE          17
#define SADB_X_EXT_POLICY             18
#define SADB_X_EXT_SA2                19
#define SADB_EXT_SESSION_ID           20
#define SADB_EXT_SASTAT               21
#define SADB_X_EXT_IPSECIF            22
#define SADB_X_EXT_ADDR_RANGE_SRC_START 23
#define SADB_X_EXT_ADDR_RANGE_SRC_END   24
#define SADB_X_EXT_ADDR_RANGE_DST_START 25
#define SADB_X_EXT_ADDR_RANGE_DST_END   26
#define SADB_EXT_MIGRATE_ADDRESS_SRC  27
#define SADB_EXT_MIGRATE_ADDRESS_DST  28
#define SADB_X_EXT_MIGRATE_IPSECIF    29
#define SADB_EXT_MAX                  29

#define SADB_SATYPE_UNSPEC	0
#define SADB_SATYPE_AH		2
#define SADB_SATYPE_ESP		3
#define SADB_SATYPE_RSVP	5
#define SADB_SATYPE_OSPFV2	6
#define SADB_SATYPE_RIPV2	7
#define SADB_SATYPE_MIP		8
#define SADB_X_SATYPE_IPCOMP	9
#define SADB_X_SATYPE_POLICY	10
#define SADB_SATYPE_MAX		11

#define SADB_SASTATE_LARVAL   0
#define SADB_SASTATE_MATURE   1
#define SADB_SASTATE_DYING    2
#define SADB_SASTATE_DEAD     3
#define SADB_SASTATE_MAX      3

#define SADB_SAFLAGS_PFS      1

/* RFC2367 numbers - meets RFC2407 */
#define SADB_AALG_NONE		0
#define SADB_AALG_MD5HMAC	1	/*2*/
#define SADB_AALG_SHA1HMAC	2	/*3*/
#define SADB_AALG_MAX		8
/* private allocations - based on RFC2407/IANA assignment */
#define SADB_X_AALG_SHA2_256	6	/*5*/
#define SADB_X_AALG_SHA2_384	7	/*6*/
#define SADB_X_AALG_SHA2_512	8	/*7*/
/* private allocations should use 249-255 (RFC2407) */
#define SADB_X_AALG_MD5		3	/*249*/	/* Keyed MD5 */
#define SADB_X_AALG_SHA		4	/*250*/	/* Keyed SHA */
#define SADB_X_AALG_NULL	5	/*251*/	/* null authentication */

/* RFC2367 numbers - meets RFC2407 */
#define SADB_EALG_NONE		0
#define SADB_EALG_DESCBC	1	/*2*/
#define SADB_EALG_3DESCBC	2	/*3*/
#define SADB_EALG_NULL		3	/*11*/
#define SADB_EALG_MAX		12
/* private allocations - based on RFC2407/IANA assignment */
#define SADB_X_EALG_CAST128CBC	5	/*6*/
#define SADB_X_EALG_BLOWFISHCBC	4	/*7*/
#define SADB_X_EALG_RIJNDAELCBC	12
#define SADB_X_EALG_AESCBC      12
#define SADB_X_EALG_AES		12
#define SADB_X_EALG_AES_GCM     13
/* private allocations should use 249-255 (RFC2407) */

#if 1	/*nonstandard */
#define SADB_X_CALG_NONE	0
#define SADB_X_CALG_OUI		1
#define SADB_X_CALG_DEFLATE	2
#define SADB_X_CALG_LZS		3
#define SADB_X_CALG_MAX		4
#endif

#define SADB_IDENTTYPE_RESERVED   0
#define SADB_IDENTTYPE_PREFIX     1
#define SADB_IDENTTYPE_FQDN       2
#define SADB_IDENTTYPE_USERFQDN   3
#define SADB_X_IDENTTYPE_ADDR     4
#define SADB_IDENTTYPE_MAX        4

/* `flags' in sadb_sa structure holds followings */
#define SADB_X_EXT_NONE		0x0000	/* i.e. new format. */
#define SADB_X_EXT_OLD		0x0001	/* old format. */
#ifdef PRIVATE
#define SADB_X_EXT_NATT				0x0002	/* Use UDP encapsulation to traverse NAT */
#define SADB_X_EXT_NATT_KEEPALIVE	0x0004	/* Local node is behind NAT, send keepalives */
											/* Should only be set for outbound SAs */
#define SADB_X_EXT_NATT_MULTIPLEUSERS 0x0008	/* For use on VPN server - support multiple users 	*/

#endif /* PRIVATE */	

#define SADB_X_EXT_IV4B		0x0010	/* IV length of 4 bytes in use */
#define SADB_X_EXT_DERIV	0x0020	/* DES derived */
#define SADB_X_EXT_CYCSEQ	0x0040	/* allowing to cyclic sequence. */

	/* three of followings are exclusive flags each them */
#define SADB_X_EXT_PSEQ		0x0000	/* sequencial padding for ESP */
#define SADB_X_EXT_PRAND	0x0100	/* random padding for ESP */
#define SADB_X_EXT_PZERO	0x0200	/* zero padding for ESP */
#define SADB_X_EXT_PMASK	0x0300	/* mask for padding flag */

#ifdef PRIVATE
#define SADB_X_EXT_NATT_DETECTED_PEER 0x1000
#define SADB_X_EXT_ESP_KEEPALIVE      0x2000
#define SADB_X_EXT_PUNT_RX_KEEPALIVE  0x4000
#define SADB_X_EXT_NATT_KEEPALIVE_OFFLOAD  0x8000
#endif /* PRIVATE */	

#ifdef PRIVATE
#define NATT_KEEPALIVE_OFFLOAD_INTERVAL	0x1
#endif

#if 1
#define SADB_X_EXT_RAWCPI	0x0080	/* use well known CPI (IPComp) */
#endif

#define SADB_KEY_FLAGS_MAX	0x7fff

#ifdef PRIVATE
#define SADB_X_EXT_SA2_DELETE_ON_DETACH   0x0001
#endif

/* SPI size for PF_KEYv2 */
#define PFKEY_SPI_SIZE	sizeof(u_int32_t)

/* Identifier for menber of lifetime structure */
#define SADB_X_LIFETIME_ALLOCATIONS	0
#define SADB_X_LIFETIME_BYTES		1
#define SADB_X_LIFETIME_ADDTIME		2
#define SADB_X_LIFETIME_USETIME		3

/* The rate for SOFT lifetime against HARD one. */
#define PFKEY_SOFT_LIFETIME_RATE	80

/* Utilities */
#define PFKEY_ALIGN8(a) (1 + (((a) - 1) | (8 - 1)))
#define	PFKEY_EXTLEN(msg) \
	PFKEY_UNUNIT64(((struct sadb_ext *)(msg))->sadb_ext_len)
#define PFKEY_ADDR_PREFIX(ext) \
	(((struct sadb_address *)(ext))->sadb_address_prefixlen)
#define PFKEY_ADDR_PROTO(ext) \
	(((struct sadb_address *)(ext))->sadb_address_proto)
#define PFKEY_ADDR_SADDR(ext) \
	((struct sockaddr *)((caddr_t)(ext) + sizeof(struct sadb_address)))

/* in 64bits */
#define	PFKEY_UNUNIT64(a)	((a) << 3)
#define	PFKEY_UNIT64(a)		((a) >> 3)

#endif /* __PFKEY_V2_H */

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