xref: /xnu-11215.41.3/bsd/netkey/keydb.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)

/*	$KAME: keydb.h,v 1.9 2000/02/22 14:06:41 itojun 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.
 */

#ifndef _NETKEY_KEYDB_H_
#define _NETKEY_KEYDB_H_
#include <sys/appleapiopts.h>

#ifdef BSD_KERNEL_PRIVATE

#include <netkey/key_var.h>

/* Security Association Index */
/* NOTE: Ensure to be same address family */
struct secasindex {
	struct sockaddr_storage src;    /* srouce address for SA */
	struct sockaddr_storage dst;    /* destination address for SA */
	u_int16_t proto;                /* IPPROTO_ESP or IPPROTO_AH */
	u_int8_t mode;                  /* mode of protocol, see ipsec.h */
	u_int32_t reqid;                /* reqid id who owned this SA */
	                                /* see IPSEC_MANUAL_REQID_MAX. */
	u_int ipsec_ifindex;
};

#define SECURITY_ASSOCIATION_ANY          0x0000
#define SECURITY_ASSOCIATION_PFKEY        0x0001
#define SECURITY_ASSOCIATION_CUSTOM_IPSEC 0x0010

/* Security Association Data Base */
struct secashead {
	LIST_ENTRY(secashead) chain;

	struct secasindex saidx;

	ifnet_t ipsec_if;
	u_int outgoing_if;
	u_int8_t dir;                   /* IPSEC_DIR_INBOUND or IPSEC_DIR_OUTBOUND */
	u_int8_t state;                 /* MATURE or DEAD. */
	LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX + 1];
	/* SA chain */
	/* The first of this list is newer SA */

	struct route_in6 sa_route;              /* route cache */

	uint16_t flags;
	u_int32_t use_count;
};

#define MAX_REPLAY_WINDOWS 4
#define PER_TC_REPLAY_WINDOW_RANGE ((1ULL << 32) / MAX_REPLAY_WINDOWS)
#define PER_TC_REPLAY_WINDOW_SN_SHIFT 30

/* Security Association */
struct secasvar {
	LIST_ENTRY(secasvar) chain;
	LIST_ENTRY(secasvar) spihash;
	int refcnt;                     /* reference count */
	u_int8_t state;                 /* Status of this Association */

	u_int8_t alg_auth;              /* Authentication Algorithm Identifier*/
	u_int8_t alg_enc;               /* Cipher Algorithm Identifier */
	u_int32_t spi;                  /* SPI Value, network byte order */
	u_int32_t flags;                /* holder for SADB_KEY_FLAGS */
	u_int16_t flags2;               /* holder for SADB_SA2_KEY_FLAGS */

	struct sadb_key *__sized_by(key_auth_len) key_auth;     /* Key for Authentication */
	struct sadb_key *__sized_by(key_enc_len) key_enc;       /* Key for Encryption */
	caddr_t __sized_by(ivlen) iv;                           /* Initialization Vector */
	void *__sized_by(schedlen_auth) sched_auth;             /* intermediate authentication key */
	void *__sized_by(schedlen_enc) sched_enc;               /* intermediate encryption key */
	uint32_t key_auth_len;
	uint32_t key_enc_len;
	size_t schedlen_auth;
	size_t schedlen_enc;
	u_int ivlen;                                            /* length of IV */

	struct secreplay *replay[MAX_REPLAY_WINDOWS]; /* replay prevention */

	u_int64_t created;              /* for lifetime */

	struct sadb_lifetime *lft_c;    /* CURRENT lifetime, it's constant. */
	struct sadb_lifetime *lft_h;    /* HARD lifetime */
	struct sadb_lifetime *lft_s;    /* SOFT lifetime */

	struct socket *so; /* Associated socket */

	u_int32_t seq;                  /* sequence number */
	pid_t pid;                      /* message's pid */

	struct secashead *sah;          /* back pointer to the secashead */

	/* Nat Traversal related bits */
	u_int64_t       natt_last_activity;
	u_int16_t       remote_ike_port;
	u_int16_t       natt_encapsulated_src_port;     /* network byte order */
	u_int16_t       natt_interval; /* Interval in seconds */
	u_int16_t       natt_offload_interval; /* Hardware Offload Interval in seconds */
	/*
	 * Globally unique flow identifier for the SA.
	 * Added on outgoing packets by the IPSec driver.
	 */
	uint32_t        flowid;

	u_int8_t        always_expire; /* Send expire/delete messages even if unused */
};

/* replay prevention */
struct secreplay {
	u_int8_t wsize;                          /* window size */
	u_int32_t count;                         /* used by sender/receiver */
	u_int32_t seq;                           /* used by sender */
	u_int32_t lastseq;                       /* used by sender/receiver */
	caddr_t __sized_by(wsize) bitmap;        /* used by receiver */
	int overflow;                            /* overflow flag */
};

/* socket table due to send PF_KEY messages. */
struct secreg {
	LIST_ENTRY(secreg) chain;

	struct socket *so;
};

#ifndef IPSEC_NONBLOCK_ACQUIRE
/* acquiring list table. */
struct secacq {
	LIST_ENTRY(secacq) chain;

	struct secasindex saidx;

	u_int32_t seq;          /* sequence number */
	u_int64_t created;      /* for lifetime */
	int count;              /* for lifetime */
};
#endif

/* Sensitivity Level Specification */
/* nothing */

#define SADB_KILL_INTERVAL      600     /* six seconds */

struct key_cb {
	int key_count;
	int any_count;
};

/* secpolicy */
extern struct secpolicy *keydb_newsecpolicy(void);
extern void keydb_delsecpolicy(struct secpolicy *);
/* secashead */
extern struct secashead *keydb_newsecashead(void);
// extern void keydb_delsecashead(struct secashead *);	// not used
/* secasvar */
// extern struct secasvar *keydb_newsecasvar(void);		// not used
// extern void keydb_refsecasvar(struct secasvar *);	// not used
// extern void keydb_freesecasvar(struct secasvar *);	// not used
/* secreplay */
extern struct secreplay *keydb_newsecreplay(u_int8_t);
extern void keydb_delsecreplay(struct secreplay *);
/* secreg */
// extern struct secreg *keydb_newsecreg(void);			// not used
// extern void keydb_delsecreg(struct secreg *);		// not used

#endif /* BSD_KERNEL_PRIVATE */

#endif /* _NETKEY_KEYDB_H_ */