1/*	$FreeBSD: stable/11/sys/netipsec/keydb.h 315514 2017-03-18 22:04:20Z ae $	*/
2/*	$KAME: keydb.h,v 1.14 2000/08/02 17:58:26 sakane Exp $	*/
3
4/*-
5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the project nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 */
32
33#ifndef _NETIPSEC_KEYDB_H_
34#define _NETIPSEC_KEYDB_H_
35
36#ifdef _KERNEL
37#include <sys/counter.h>
38#include <sys/lock.h>
39#include <sys/mutex.h>
40
41#include <netipsec/key_var.h>
42
43#ifndef _SOCKADDR_UNION_DEFINED
44#define	_SOCKADDR_UNION_DEFINED
45/*
46 * The union of all possible address formats we handle.
47 */
48union sockaddr_union {
49	struct sockaddr		sa;
50	struct sockaddr_in	sin;
51	struct sockaddr_in6	sin6;
52};
53#endif /* _SOCKADDR_UNION_DEFINED */
54
55/* Security Assocciation Index */
56/* NOTE: Ensure to be same address family */
57struct secasindex {
58	union sockaddr_union src;	/* source address for SA */
59	union sockaddr_union dst;	/* destination address for SA */
60	uint8_t proto;			/* IPPROTO_ESP or IPPROTO_AH */
61	uint8_t mode;			/* mode of protocol, see ipsec.h */
62	uint32_t reqid;			/* reqid id who owned this SA */
63					/* see IPSEC_MANUAL_REQID_MAX. */
64};
65
66/*
67 * In order to split out the keydb implementation from that of the
68 * PF_KEY sockets we need to define a few structures that while they
69 * may seem common are likely to diverge over time.
70 */
71
72/* sadb_identity */
73struct secident {
74	u_int16_t type;
75	u_int64_t id;
76};
77
78/* sadb_key */
79struct seckey {
80	u_int16_t bits;
81	char *key_data;
82};
83
84struct seclifetime {
85	u_int32_t allocations;
86	u_int64_t bytes;
87	u_int64_t addtime;
88	u_int64_t usetime;
89};
90
91struct secnatt {
92	union sockaddr_union oai;	/* original addresses of initiator */
93	union sockaddr_union oar;	/* original address of responder */
94	uint16_t sport;			/* source port */
95	uint16_t dport;			/* destination port */
96	uint16_t cksum;			/* checksum delta */
97	uint16_t flags;
98#define	IPSEC_NATT_F_OAI	0x0001
99#define	IPSEC_NATT_F_OAR	0x0002
100};
101
102/* Security Association Data Base */
103TAILQ_HEAD(secasvar_queue, secasvar);
104struct secashead {
105	TAILQ_ENTRY(secashead) chain;
106	LIST_ENTRY(secashead) addrhash;	/* hash by sproto+src+dst addresses */
107	LIST_ENTRY(secashead) drainq;	/* used ONLY by flush callout */
108
109	struct secasindex saidx;
110
111	struct secident *idents;	/* source identity */
112	struct secident *identd;	/* destination identity */
113					/* XXX I don't know how to use them. */
114
115	volatile u_int refcnt;		/* reference count */
116	uint8_t state;			/* MATURE or DEAD. */
117	struct secasvar_queue savtree_alive;	/* MATURE and DYING SA */
118	struct secasvar_queue savtree_larval;	/* LARVAL SA */
119};
120
121struct xformsw;
122struct enc_xform;
123struct auth_hash;
124struct comp_algo;
125
126/*
127 * Security Association
128 *
129 * For INBOUND packets we do SA lookup using SPI, thus only SPIHASH is used.
130 * For OUTBOUND packets there may be several SA suitable for packet.
131 * We use key_preferred_oldsa variable to choose better SA. First of we do
132 * lookup for suitable SAH using packet's saidx. Then we use SAH's savtree
133 * to search better candidate. The newer SA (by created time) are placed
134 * in the beginning of the savtree list. There is no preference between
135 * DYING and MATURE.
136 *
137 * NB: Fields with a tdb_ prefix are part of the "glue" used
138 *     to interface to the OpenBSD crypto support.  This was done
139 *     to distinguish this code from the mainline KAME code.
140 * NB: Fields are sorted on the basis of the frequency of changes, i.e.
141 *     constants and unchangeable fields are going first.
142 * NB: if you want to change this structure, check that this will not break
143 *     key_updateaddresses().
144 */
145struct secasvar {
146	uint32_t spi;			/* SPI Value, network byte order */
147	uint32_t flags;			/* holder for SADB_KEY_FLAGS */
148	uint32_t seq;			/* sequence number */
149	pid_t pid;			/* message's pid */
150	u_int ivlen;			/* length of IV */
151
152	struct secashead *sah;		/* back pointer to the secashead */
153	struct seckey *key_auth;	/* Key for Authentication */
154	struct seckey *key_enc;	        /* Key for Encryption */
155	struct secreplay *replay;	/* replay prevention */
156	struct secnatt *natt;		/* NAT-T config */
157	struct mtx *lock;		/* update/access lock */
158
159	const struct xformsw *tdb_xform;	/* transform */
160	const struct enc_xform *tdb_encalgxform;/* encoding algorithm */
161	const struct auth_hash *tdb_authalgxform;/* authentication algorithm */
162	const struct comp_algo *tdb_compalgxform;/* compression algorithm */
163	uint64_t tdb_cryptoid;		/* crypto session id */
164
165	uint8_t alg_auth;		/* Authentication Algorithm Identifier*/
166	uint8_t alg_enc;		/* Cipher Algorithm Identifier */
167	uint8_t alg_comp;		/* Compression Algorithm Identifier */
168	uint8_t state;			/* Status of this SA (pfkeyv2.h) */
169
170	counter_u64_t lft_c;		/* CURRENT lifetime */
171#define	lft_c_allocations	lft_c
172#define	lft_c_bytes		lft_c + 1
173	struct seclifetime *lft_h;	/* HARD lifetime */
174	struct seclifetime *lft_s;	/* SOFT lifetime */
175
176	uint64_t created;		/* time when SA was created */
177	uint64_t firstused;		/* time when SA was first used */
178
179	TAILQ_ENTRY(secasvar) chain;
180	LIST_ENTRY(secasvar) spihash;
181	LIST_ENTRY(secasvar) drainq;	/* used ONLY by flush callout */
182
183	uint64_t cntr;			/* counter for GCM and CTR */
184	volatile u_int refcnt;		/* reference count */
185};
186
187#define	SECASVAR_LOCK(_sav)		mtx_lock((_sav)->lock)
188#define	SECASVAR_UNLOCK(_sav)		mtx_unlock((_sav)->lock)
189#define	SECASVAR_LOCK_ASSERT(_sav)	mtx_assert((_sav)->lock, MA_OWNED)
190#define	SAV_ISGCM(_sav)							\
191			((_sav)->alg_enc == SADB_X_EALG_AESGCM8 ||	\
192			(_sav)->alg_enc == SADB_X_EALG_AESGCM12 ||	\
193			(_sav)->alg_enc == SADB_X_EALG_AESGCM16)
194#define	SAV_ISCTR(_sav) ((_sav)->alg_enc == SADB_X_EALG_AESCTR)
195#define SAV_ISCTRORGCM(_sav)	(SAV_ISCTR((_sav)) || SAV_ISGCM((_sav)))
196
197/* Replay prevention, protected by SECASVAR_LOCK:
198 *  (m) locked by mtx
199 *  (c) read only except during creation / free
200 */
201struct secreplay {
202	u_int32_t count;	/* (m) */
203	u_int wsize;		/* (c) window size, i.g. 4 bytes */
204	u_int32_t seq;		/* (m) used by sender */
205	u_int32_t lastseq;	/* (m) used by receiver */
206	u_int32_t *bitmap;	/* (m) used by receiver */
207	u_int bitmap_size;	/* (c) size of the bitmap array */
208	int overflow;		/* (m) overflow flag */
209};
210
211/* socket table due to send PF_KEY messages. */
212struct secreg {
213	LIST_ENTRY(secreg) chain;
214
215	struct socket *so;
216};
217
218/* acquiring list table. */
219struct secacq {
220	LIST_ENTRY(secacq) chain;
221	LIST_ENTRY(secacq) addrhash;
222	LIST_ENTRY(secacq) seqhash;
223
224	struct secasindex saidx;
225	uint32_t seq;		/* sequence number */
226	time_t created;		/* for lifetime */
227	int count;		/* for lifetime */
228};
229
230/* Sensitivity Level Specification */
231/* nothing */
232
233#define SADB_KILL_INTERVAL	600	/* six seconds */
234
235/* secpolicy */
236extern struct secpolicy *keydb_newsecpolicy(void);
237extern void keydb_delsecpolicy(struct secpolicy *);
238/* secashead */
239extern struct secashead *keydb_newsecashead(void);
240extern void keydb_delsecashead(struct secashead *);
241/* secasvar */
242extern struct secasvar *keydb_newsecasvar(void);
243extern void keydb_refsecasvar(struct secasvar *);
244extern void keydb_freesecasvar(struct secasvar *);
245/* secreplay */
246extern struct secreplay *keydb_newsecreplay(size_t);
247extern void keydb_delsecreplay(struct secreplay *);
248/* secreg */
249extern struct secreg *keydb_newsecreg(void);
250extern void keydb_delsecreg(struct secreg *);
251
252#endif /* _KERNEL */
253
254#endif /* _NETIPSEC_KEYDB_H_ */
255