xref: /freebsd/sys/netipsec/keydb.h (revision 4436b51dff5736e74da464946049ea6899a88938)
1 /*	$FreeBSD$	*/
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 
38 #include <netipsec/key_var.h>
39 
40 #ifndef _SOCKADDR_UNION_DEFINED
41 #define	_SOCKADDR_UNION_DEFINED
42 /*
43  * The union of all possible address formats we handle.
44  */
45 union sockaddr_union {
46 	struct sockaddr		sa;
47 	struct sockaddr_in	sin;
48 	struct sockaddr_in6	sin6;
49 };
50 #endif /* _SOCKADDR_UNION_DEFINED */
51 
52 /* Security Assocciation Index */
53 /* NOTE: Ensure to be same address family */
54 struct secasindex {
55 	union sockaddr_union src;	/* source address for SA */
56 	union sockaddr_union dst;	/* destination address for SA */
57 	u_int16_t proto;		/* IPPROTO_ESP or IPPROTO_AH */
58 	u_int8_t mode;			/* mode of protocol, see ipsec.h */
59 	u_int32_t reqid;		/* reqid id who owned this SA */
60 					/* see IPSEC_MANUAL_REQID_MAX. */
61 };
62 
63 /*
64  * In order to split out the keydb implementation from that of the
65  * PF_KEY sockets we need to define a few structures that while they
66  * may seem common are likely to diverge over time.
67  */
68 
69 /* sadb_identity */
70 struct secident {
71 	u_int16_t type;
72 	u_int64_t id;
73 };
74 
75 /* sadb_key */
76 struct seckey {
77 	u_int16_t bits;
78 	char *key_data;
79 };
80 
81 struct seclifetime {
82 	u_int32_t allocations;
83 	u_int64_t bytes;
84 	u_int64_t addtime;
85 	u_int64_t usetime;
86 };
87 
88 /* Security Association Data Base */
89 struct secashead {
90 	LIST_ENTRY(secashead) chain;
91 
92 	struct secasindex saidx;
93 
94 	struct secident *idents;	/* source identity */
95 	struct secident *identd;	/* destination identity */
96 					/* XXX I don't know how to use them. */
97 
98 	u_int8_t state;			/* MATURE or DEAD. */
99 	LIST_HEAD(_satree, secasvar) savtree[SADB_SASTATE_MAX+1];
100 					/* SA chain */
101 					/* The first of this list is newer SA */
102 };
103 
104 struct xformsw;
105 struct enc_xform;
106 struct auth_hash;
107 struct comp_algo;
108 
109 /* Security Association */
110 struct secasvar {
111 	LIST_ENTRY(secasvar) chain;
112 	struct mtx lock;		/* update/access lock */
113 
114 	u_int refcnt;			/* reference count */
115 	u_int8_t state;			/* Status of this Association */
116 
117 	u_int8_t alg_auth;		/* Authentication Algorithm Identifier*/
118 	u_int8_t alg_enc;		/* Cipher Algorithm Identifier */
119 	u_int8_t alg_comp;		/* Compression Algorithm Identifier */
120 	u_int32_t spi;			/* SPI Value, network byte order */
121 	u_int32_t flags;		/* holder for SADB_KEY_FLAGS */
122 
123 	struct seckey *key_auth;	/* Key for Authentication */
124 	struct seckey *key_enc;	        /* Key for Encryption */
125 	u_int ivlen;			/* length of IV */
126 	void *sched;			/* intermediate encryption key */
127 	size_t schedlen;
128 	uint64_t cntr;			/* counter for GCM and CTR */
129 
130 	struct secreplay *replay;	/* replay prevention */
131 	time_t created;			/* for lifetime */
132 
133 	struct seclifetime *lft_c;	/* CURRENT lifetime, it's constant. */
134 	struct seclifetime *lft_h;	/* HARD lifetime */
135 	struct seclifetime *lft_s;	/* SOFT lifetime */
136 
137 	u_int32_t seq;			/* sequence number */
138 	pid_t pid;			/* message's pid */
139 
140 	struct secashead *sah;		/* back pointer to the secashead */
141 
142 	/*
143 	 * NB: Fields with a tdb_ prefix are part of the "glue" used
144 	 *     to interface to the OpenBSD crypto support.  This was done
145 	 *     to distinguish this code from the mainline KAME code.
146 	 */
147 	struct xformsw *tdb_xform;	/* transform */
148 	struct enc_xform *tdb_encalgxform;	/* encoding algorithm */
149 	struct auth_hash *tdb_authalgxform;	/* authentication algorithm */
150 	struct comp_algo *tdb_compalgxform;	/* compression algorithm */
151 	u_int64_t tdb_cryptoid;		/* crypto session id */
152 
153 	/*
154 	 * NAT-Traversal.
155 	 */
156 	u_int16_t natt_type;		/* IKE/ESP-marker in output. */
157 	u_int16_t natt_esp_frag_len;	/* MTU for payload fragmentation. */
158 };
159 
160 #define	SECASVAR_LOCK_INIT(_sav) \
161 	mtx_init(&(_sav)->lock, "ipsec association", NULL, MTX_DEF)
162 #define	SECASVAR_LOCK(_sav)		mtx_lock(&(_sav)->lock)
163 #define	SECASVAR_UNLOCK(_sav)		mtx_unlock(&(_sav)->lock)
164 #define	SECASVAR_LOCK_DESTROY(_sav)	mtx_destroy(&(_sav)->lock)
165 #define	SECASVAR_LOCK_ASSERT(_sav)	mtx_assert(&(_sav)->lock, MA_OWNED)
166 #define	SAV_ISGCM(_sav)							\
167 			((_sav)->alg_enc == SADB_X_EALG_AESGCM8 ||	\
168 			(_sav)->alg_enc == SADB_X_EALG_AESGCM12 ||	\
169 			(_sav)->alg_enc == SADB_X_EALG_AESGCM16)
170 #define	SAV_ISCTR(_sav) ((_sav)->alg_enc == SADB_X_EALG_AESCTR)
171 #define SAV_ISCTRORGCM(_sav)	(SAV_ISCTR((_sav)) || SAV_ISGCM((_sav)))
172 
173 /* replay prevention */
174 struct secreplay {
175 	u_int32_t count;
176 	u_int wsize;		/* window size, i.g. 4 bytes */
177 	u_int32_t seq;		/* used by sender */
178 	u_int32_t lastseq;	/* used by receiver */
179 	caddr_t bitmap;		/* used by receiver */
180 	int overflow;		/* overflow flag */
181 };
182 
183 /* socket table due to send PF_KEY messages. */
184 struct secreg {
185 	LIST_ENTRY(secreg) chain;
186 
187 	struct socket *so;
188 };
189 
190 /* acquiring list table. */
191 struct secacq {
192 	LIST_ENTRY(secacq) chain;
193 
194 	struct secasindex saidx;
195 
196 	u_int32_t seq;		/* sequence number */
197 	time_t created;		/* for lifetime */
198 	int count;		/* for lifetime */
199 };
200 
201 /* Sensitivity Level Specification */
202 /* nothing */
203 
204 #define SADB_KILL_INTERVAL	600	/* six seconds */
205 
206 /* secpolicy */
207 extern struct secpolicy *keydb_newsecpolicy(void);
208 extern void keydb_delsecpolicy(struct secpolicy *);
209 /* secashead */
210 extern struct secashead *keydb_newsecashead(void);
211 extern void keydb_delsecashead(struct secashead *);
212 /* secasvar */
213 extern struct secasvar *keydb_newsecasvar(void);
214 extern void keydb_refsecasvar(struct secasvar *);
215 extern void keydb_freesecasvar(struct secasvar *);
216 /* secreplay */
217 extern struct secreplay *keydb_newsecreplay(size_t);
218 extern void keydb_delsecreplay(struct secreplay *);
219 /* secreg */
220 extern struct secreg *keydb_newsecreg(void);
221 extern void keydb_delsecreg(struct secreg *);
222 
223 #endif /* _KERNEL */
224 
225 #endif /* _NETIPSEC_KEYDB_H_ */
226