2 /* $KAME: key.c,v 1.191 2001/06/27 10:46:49 sakane Exp $ */
5 * SPDX-License-Identifier: BSD-3-Clause
7 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the project nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * This code is referd to RFC 2367
40 #include "opt_inet6.h"
41 #include "opt_ipsec.h"
43 #include <sys/types.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/fnv_hash.h>
49 #include <sys/mutex.h>
51 #include <sys/domain.h>
52 #include <sys/protosw.h>
53 #include <sys/malloc.h>
54 #include <sys/rmlock.h>
55 #include <sys/socket.h>
56 #include <sys/socketvar.h>
57 #include <sys/sysctl.h>
58 #include <sys/errno.h>
60 #include <sys/queue.h>
61 #include <sys/refcount.h>
62 #include <sys/syslog.h>
67 #include <net/if_var.h>
69 #include <net/raw_cb.h>
71 #include <netinet/in.h>
72 #include <netinet/in_systm.h>
73 #include <netinet/ip.h>
74 #include <netinet/in_var.h>
75 #include <netinet/udp.h>
78 #include <netinet/ip6.h>
79 #include <netinet6/in6_var.h>
80 #include <netinet6/ip6_var.h>
83 #include <net/pfkeyv2.h>
84 #include <netipsec/keydb.h>
85 #include <netipsec/key.h>
86 #include <netipsec/keysock.h>
87 #include <netipsec/key_debug.h>
89 #include <netipsec/ipsec.h>
91 #include <netipsec/ipsec6.h>
94 #include <netipsec/xform.h>
95 #include <machine/in_cksum.h>
96 #include <machine/stdarg.h>
99 #include <sys/random.h>
101 #define FULLMASK 0xff
102 #define _BITS(bytes) ((bytes) << 3)
105 * Note on SA reference counting:
106 * - SAs that are not in DEAD state will have (total external reference + 1)
107 * following value in reference count field. they cannot be freed and are
108 * referenced from SA header.
109 * - SAs that are in DEAD state will have (total external reference)
110 * in reference count field. they are ready to be freed. reference from
111 * SA header will be removed in key_delsav(), when the reference count
112 * field hits 0 (= no external reference other than from SA header.
115 VNET_DEFINE(u_int32_t, key_debug_level) = 0;
116 static VNET_DEFINE(u_int, key_spi_trycnt) = 1000;
117 static VNET_DEFINE(u_int32_t, key_spi_minval) = 0x100;
118 static VNET_DEFINE(u_int32_t, key_spi_maxval) = 0x0fffffff; /* XXX */
119 static VNET_DEFINE(u_int32_t, policy_id) = 0;
120 /*interval to initialize randseed,1(m)*/
121 static VNET_DEFINE(u_int, key_int_random) = 60;
122 /* interval to expire acquiring, 30(s)*/
123 static VNET_DEFINE(u_int, key_larval_lifetime) = 30;
124 /* counter for blocking SADB_ACQUIRE.*/
125 static VNET_DEFINE(int, key_blockacq_count) = 10;
126 /* lifetime for blocking SADB_ACQUIRE.*/
127 static VNET_DEFINE(int, key_blockacq_lifetime) = 20;
128 /* preferred old sa rather than new sa.*/
129 static VNET_DEFINE(int, key_preferred_oldsa) = 1;
130 #define V_key_spi_trycnt VNET(key_spi_trycnt)
131 #define V_key_spi_minval VNET(key_spi_minval)
132 #define V_key_spi_maxval VNET(key_spi_maxval)
133 #define V_policy_id VNET(policy_id)
134 #define V_key_int_random VNET(key_int_random)
135 #define V_key_larval_lifetime VNET(key_larval_lifetime)
136 #define V_key_blockacq_count VNET(key_blockacq_count)
137 #define V_key_blockacq_lifetime VNET(key_blockacq_lifetime)
138 #define V_key_preferred_oldsa VNET(key_preferred_oldsa)
140 static VNET_DEFINE(u_int32_t, acq_seq) = 0;
141 #define V_acq_seq VNET(acq_seq)
143 static VNET_DEFINE(uint32_t, sp_genid) = 0;
144 #define V_sp_genid VNET(sp_genid)
147 TAILQ_HEAD(secpolicy_queue, secpolicy);
148 LIST_HEAD(secpolicy_list, secpolicy);
149 static VNET_DEFINE(struct secpolicy_queue, sptree[IPSEC_DIR_MAX]);
150 static VNET_DEFINE(struct secpolicy_queue, sptree_ifnet[IPSEC_DIR_MAX]);
151 static struct rmlock sptree_lock;
152 #define V_sptree VNET(sptree)
153 #define V_sptree_ifnet VNET(sptree_ifnet)
154 #define SPTREE_LOCK_INIT() rm_init(&sptree_lock, "sptree")
155 #define SPTREE_LOCK_DESTROY() rm_destroy(&sptree_lock)
156 #define SPTREE_RLOCK_TRACKER struct rm_priotracker sptree_tracker
157 #define SPTREE_RLOCK() rm_rlock(&sptree_lock, &sptree_tracker)
158 #define SPTREE_RUNLOCK() rm_runlock(&sptree_lock, &sptree_tracker)
159 #define SPTREE_RLOCK_ASSERT() rm_assert(&sptree_lock, RA_RLOCKED)
160 #define SPTREE_WLOCK() rm_wlock(&sptree_lock)
161 #define SPTREE_WUNLOCK() rm_wunlock(&sptree_lock)
162 #define SPTREE_WLOCK_ASSERT() rm_assert(&sptree_lock, RA_WLOCKED)
163 #define SPTREE_UNLOCK_ASSERT() rm_assert(&sptree_lock, RA_UNLOCKED)
165 /* Hash table for lookup SP using unique id */
166 static VNET_DEFINE(struct secpolicy_list *, sphashtbl);
167 static VNET_DEFINE(u_long, sphash_mask);
168 #define V_sphashtbl VNET(sphashtbl)
169 #define V_sphash_mask VNET(sphash_mask)
171 #define SPHASH_NHASH_LOG2 7
172 #define SPHASH_NHASH (1 << SPHASH_NHASH_LOG2)
173 #define SPHASH_HASHVAL(id) (key_u32hash(id) & V_sphash_mask)
174 #define SPHASH_HASH(id) &V_sphashtbl[SPHASH_HASHVAL(id)]
177 TAILQ_HEAD(secashead_queue, secashead);
178 LIST_HEAD(secashead_list, secashead);
179 static VNET_DEFINE(struct secashead_queue, sahtree);
180 static struct rmlock sahtree_lock;
181 #define V_sahtree VNET(sahtree)
182 #define SAHTREE_LOCK_INIT() rm_init(&sahtree_lock, "sahtree")
183 #define SAHTREE_LOCK_DESTROY() rm_destroy(&sahtree_lock)
184 #define SAHTREE_RLOCK_TRACKER struct rm_priotracker sahtree_tracker
185 #define SAHTREE_RLOCK() rm_rlock(&sahtree_lock, &sahtree_tracker)
186 #define SAHTREE_RUNLOCK() rm_runlock(&sahtree_lock, &sahtree_tracker)
187 #define SAHTREE_RLOCK_ASSERT() rm_assert(&sahtree_lock, RA_RLOCKED)
188 #define SAHTREE_WLOCK() rm_wlock(&sahtree_lock)
189 #define SAHTREE_WUNLOCK() rm_wunlock(&sahtree_lock)
190 #define SAHTREE_WLOCK_ASSERT() rm_assert(&sahtree_lock, RA_WLOCKED)
191 #define SAHTREE_UNLOCK_ASSERT() rm_assert(&sahtree_lock, RA_UNLOCKED)
193 /* Hash table for lookup in SAD using SA addresses */
194 static VNET_DEFINE(struct secashead_list *, sahaddrhashtbl);
195 static VNET_DEFINE(u_long, sahaddrhash_mask);
196 #define V_sahaddrhashtbl VNET(sahaddrhashtbl)
197 #define V_sahaddrhash_mask VNET(sahaddrhash_mask)
199 #define SAHHASH_NHASH_LOG2 7
200 #define SAHHASH_NHASH (1 << SAHHASH_NHASH_LOG2)
201 #define SAHADDRHASH_HASHVAL(saidx) \
202 (key_saidxhash(saidx) & V_sahaddrhash_mask)
203 #define SAHADDRHASH_HASH(saidx) \
204 &V_sahaddrhashtbl[SAHADDRHASH_HASHVAL(saidx)]
206 /* Hash table for lookup in SAD using SPI */
207 LIST_HEAD(secasvar_list, secasvar);
208 static VNET_DEFINE(struct secasvar_list *, savhashtbl);
209 static VNET_DEFINE(u_long, savhash_mask);
210 #define V_savhashtbl VNET(savhashtbl)
211 #define V_savhash_mask VNET(savhash_mask)
212 #define SAVHASH_NHASH_LOG2 7
213 #define SAVHASH_NHASH (1 << SAVHASH_NHASH_LOG2)
214 #define SAVHASH_HASHVAL(spi) (key_u32hash(spi) & V_savhash_mask)
215 #define SAVHASH_HASH(spi) &V_savhashtbl[SAVHASH_HASHVAL(spi)]
218 key_saidxhash(const struct secasindex *saidx)
222 hval = fnv_32_buf(&saidx->proto, sizeof(saidx->proto),
224 switch (saidx->dst.sa.sa_family) {
227 hval = fnv_32_buf(&saidx->src.sin.sin_addr,
228 sizeof(in_addr_t), hval);
229 hval = fnv_32_buf(&saidx->dst.sin.sin_addr,
230 sizeof(in_addr_t), hval);
235 hval = fnv_32_buf(&saidx->src.sin6.sin6_addr,
236 sizeof(struct in6_addr), hval);
237 hval = fnv_32_buf(&saidx->dst.sin6.sin6_addr,
238 sizeof(struct in6_addr), hval);
243 ipseclog((LOG_DEBUG, "%s: unknown address family %d",
244 __func__, saidx->dst.sa.sa_family));
250 key_u32hash(uint32_t val)
253 return (fnv_32_buf(&val, sizeof(val), FNV1_32_INIT));
257 static VNET_DEFINE(LIST_HEAD(_regtree, secreg), regtree[SADB_SATYPE_MAX + 1]);
258 #define V_regtree VNET(regtree)
259 static struct mtx regtree_lock;
260 #define REGTREE_LOCK_INIT() \
261 mtx_init(®tree_lock, "regtree", "fast ipsec regtree", MTX_DEF)
262 #define REGTREE_LOCK_DESTROY() mtx_destroy(®tree_lock)
263 #define REGTREE_LOCK() mtx_lock(®tree_lock)
264 #define REGTREE_UNLOCK() mtx_unlock(®tree_lock)
265 #define REGTREE_LOCK_ASSERT() mtx_assert(®tree_lock, MA_OWNED)
268 LIST_HEAD(secacq_list, secacq);
269 static VNET_DEFINE(struct secacq_list, acqtree);
270 #define V_acqtree VNET(acqtree)
271 static struct mtx acq_lock;
272 #define ACQ_LOCK_INIT() \
273 mtx_init(&acq_lock, "acqtree", "ipsec SA acquiring list", MTX_DEF)
274 #define ACQ_LOCK_DESTROY() mtx_destroy(&acq_lock)
275 #define ACQ_LOCK() mtx_lock(&acq_lock)
276 #define ACQ_UNLOCK() mtx_unlock(&acq_lock)
277 #define ACQ_LOCK_ASSERT() mtx_assert(&acq_lock, MA_OWNED)
279 /* Hash table for lookup in ACQ list using SA addresses */
280 static VNET_DEFINE(struct secacq_list *, acqaddrhashtbl);
281 static VNET_DEFINE(u_long, acqaddrhash_mask);
282 #define V_acqaddrhashtbl VNET(acqaddrhashtbl)
283 #define V_acqaddrhash_mask VNET(acqaddrhash_mask)
285 /* Hash table for lookup in ACQ list using SEQ number */
286 static VNET_DEFINE(struct secacq_list *, acqseqhashtbl);
287 static VNET_DEFINE(u_long, acqseqhash_mask);
288 #define V_acqseqhashtbl VNET(acqseqhashtbl)
289 #define V_acqseqhash_mask VNET(acqseqhash_mask)
291 #define ACQHASH_NHASH_LOG2 7
292 #define ACQHASH_NHASH (1 << ACQHASH_NHASH_LOG2)
293 #define ACQADDRHASH_HASHVAL(saidx) \
294 (key_saidxhash(saidx) & V_acqaddrhash_mask)
295 #define ACQSEQHASH_HASHVAL(seq) \
296 (key_u32hash(seq) & V_acqseqhash_mask)
297 #define ACQADDRHASH_HASH(saidx) \
298 &V_acqaddrhashtbl[ACQADDRHASH_HASHVAL(saidx)]
299 #define ACQSEQHASH_HASH(seq) \
300 &V_acqseqhashtbl[ACQSEQHASH_HASHVAL(seq)]
301 /* SP acquiring list */
302 static VNET_DEFINE(LIST_HEAD(_spacqtree, secspacq), spacqtree);
303 #define V_spacqtree VNET(spacqtree)
304 static struct mtx spacq_lock;
305 #define SPACQ_LOCK_INIT() \
306 mtx_init(&spacq_lock, "spacqtree", \
307 "fast ipsec security policy acquire list", MTX_DEF)
308 #define SPACQ_LOCK_DESTROY() mtx_destroy(&spacq_lock)
309 #define SPACQ_LOCK() mtx_lock(&spacq_lock)
310 #define SPACQ_UNLOCK() mtx_unlock(&spacq_lock)
311 #define SPACQ_LOCK_ASSERT() mtx_assert(&spacq_lock, MA_OWNED)
313 static const int minsize[] = {
314 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
315 sizeof(struct sadb_sa), /* SADB_EXT_SA */
316 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
317 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
318 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
319 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_SRC */
320 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_DST */
321 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_PROXY */
322 sizeof(struct sadb_key), /* SADB_EXT_KEY_AUTH */
323 sizeof(struct sadb_key), /* SADB_EXT_KEY_ENCRYPT */
324 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_SRC */
325 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_DST */
326 sizeof(struct sadb_sens), /* SADB_EXT_SENSITIVITY */
327 sizeof(struct sadb_prop), /* SADB_EXT_PROPOSAL */
328 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_AUTH */
329 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_ENCRYPT */
330 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
331 0, /* SADB_X_EXT_KMPRIVATE */
332 sizeof(struct sadb_x_policy), /* SADB_X_EXT_POLICY */
333 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
334 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
335 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
336 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
337 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAI */
338 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAR */
339 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
340 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
341 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_SRC */
342 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_DST */
344 _Static_assert(sizeof(minsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
346 static const int maxsize[] = {
347 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
348 sizeof(struct sadb_sa), /* SADB_EXT_SA */
349 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
350 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
351 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
352 0, /* SADB_EXT_ADDRESS_SRC */
353 0, /* SADB_EXT_ADDRESS_DST */
354 0, /* SADB_EXT_ADDRESS_PROXY */
355 0, /* SADB_EXT_KEY_AUTH */
356 0, /* SADB_EXT_KEY_ENCRYPT */
357 0, /* SADB_EXT_IDENTITY_SRC */
358 0, /* SADB_EXT_IDENTITY_DST */
359 0, /* SADB_EXT_SENSITIVITY */
360 0, /* SADB_EXT_PROPOSAL */
361 0, /* SADB_EXT_SUPPORTED_AUTH */
362 0, /* SADB_EXT_SUPPORTED_ENCRYPT */
363 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
364 0, /* SADB_X_EXT_KMPRIVATE */
365 0, /* SADB_X_EXT_POLICY */
366 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
367 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
368 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
369 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
370 0, /* SADB_X_EXT_NAT_T_OAI */
371 0, /* SADB_X_EXT_NAT_T_OAR */
372 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
373 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
374 0, /* SADB_X_EXT_NEW_ADDRESS_SRC */
375 0, /* SADB_X_EXT_NEW_ADDRESS_DST */
377 _Static_assert(sizeof(maxsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
380 * Internal values for SA flags:
381 * SADB_X_EXT_F_CLONED means that SA was cloned by key_updateaddresses,
382 * thus we will not free the most of SA content in key_delsav().
384 #define SADB_X_EXT_F_CLONED 0x80000000
386 #define SADB_CHECKLEN(_mhp, _ext) \
387 ((_mhp)->extlen[(_ext)] < minsize[(_ext)] || (maxsize[(_ext)] != 0 && \
388 ((_mhp)->extlen[(_ext)] > maxsize[(_ext)])))
389 #define SADB_CHECKHDR(_mhp, _ext) ((_mhp)->ext[(_ext)] == NULL)
391 static VNET_DEFINE(int, ipsec_esp_keymin) = 256;
392 static VNET_DEFINE(int, ipsec_esp_auth) = 0;
393 static VNET_DEFINE(int, ipsec_ah_keymin) = 128;
395 #define V_ipsec_esp_keymin VNET(ipsec_esp_keymin)
396 #define V_ipsec_esp_auth VNET(ipsec_esp_auth)
397 #define V_ipsec_ah_keymin VNET(ipsec_ah_keymin)
400 VNET_DEFINE(int, ipsec_debug) = 1;
402 VNET_DEFINE(int, ipsec_debug) = 0;
406 SYSCTL_DECL(_net_inet_ipsec);
407 SYSCTL_INT(_net_inet_ipsec, IPSECCTL_DEBUG, debug,
408 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
409 "Enable IPsec debugging output when set.");
412 SYSCTL_DECL(_net_inet6_ipsec6);
413 SYSCTL_INT(_net_inet6_ipsec6, IPSECCTL_DEBUG, debug,
414 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
415 "Enable IPsec debugging output when set.");
418 SYSCTL_DECL(_net_key);
419 SYSCTL_INT(_net_key, KEYCTL_DEBUG_LEVEL, debug,
420 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_debug_level), 0, "");
422 /* max count of trial for the decision of spi value */
423 SYSCTL_INT(_net_key, KEYCTL_SPI_TRY, spi_trycnt,
424 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_trycnt), 0, "");
426 /* minimum spi value to allocate automatically. */
427 SYSCTL_INT(_net_key, KEYCTL_SPI_MIN_VALUE, spi_minval,
428 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_minval), 0, "");
430 /* maximun spi value to allocate automatically. */
431 SYSCTL_INT(_net_key, KEYCTL_SPI_MAX_VALUE, spi_maxval,
432 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_maxval), 0, "");
434 /* interval to initialize randseed */
435 SYSCTL_INT(_net_key, KEYCTL_RANDOM_INT, int_random,
436 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_int_random), 0, "");
438 /* lifetime for larval SA */
439 SYSCTL_INT(_net_key, KEYCTL_LARVAL_LIFETIME, larval_lifetime,
440 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_larval_lifetime), 0, "");
442 /* counter for blocking to send SADB_ACQUIRE to IKEd */
443 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_COUNT, blockacq_count,
444 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_count), 0, "");
446 /* lifetime for blocking to send SADB_ACQUIRE to IKEd */
447 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_LIFETIME, blockacq_lifetime,
448 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_lifetime), 0, "");
451 SYSCTL_INT(_net_key, KEYCTL_ESP_AUTH, esp_auth,
452 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_auth), 0, "");
454 /* minimum ESP key length */
455 SYSCTL_INT(_net_key, KEYCTL_ESP_KEYMIN, esp_keymin,
456 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_keymin), 0, "");
458 /* minimum AH key length */
459 SYSCTL_INT(_net_key, KEYCTL_AH_KEYMIN, ah_keymin,
460 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_ah_keymin), 0, "");
462 /* perfered old SA rather than new SA */
463 SYSCTL_INT(_net_key, KEYCTL_PREFERED_OLDSA, preferred_oldsa,
464 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_preferred_oldsa), 0, "");
466 #define __LIST_CHAINED(elm) \
467 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
469 MALLOC_DEFINE(M_IPSEC_SA, "secasvar", "ipsec security association");
470 MALLOC_DEFINE(M_IPSEC_SAH, "sahead", "ipsec sa head");
471 MALLOC_DEFINE(M_IPSEC_SP, "ipsecpolicy", "ipsec security policy");
472 MALLOC_DEFINE(M_IPSEC_SR, "ipsecrequest", "ipsec security request");
473 MALLOC_DEFINE(M_IPSEC_MISC, "ipsec-misc", "ipsec miscellaneous");
474 MALLOC_DEFINE(M_IPSEC_SAQ, "ipsec-saq", "ipsec sa acquire");
475 MALLOC_DEFINE(M_IPSEC_SAR, "ipsec-reg", "ipsec sa acquire");
477 static VNET_DEFINE(uma_zone_t, key_lft_zone);
478 #define V_key_lft_zone VNET(key_lft_zone)
480 static LIST_HEAD(xforms_list, xformsw) xforms = LIST_HEAD_INITIALIZER();
481 static struct mtx xforms_lock;
482 #define XFORMS_LOCK_INIT() \
483 mtx_init(&xforms_lock, "xforms_list", "IPsec transforms list", MTX_DEF)
484 #define XFORMS_LOCK_DESTROY() mtx_destroy(&xforms_lock)
485 #define XFORMS_LOCK() mtx_lock(&xforms_lock)
486 #define XFORMS_UNLOCK() mtx_unlock(&xforms_lock)
489 * set parameters into secpolicyindex buffer.
490 * Must allocate secpolicyindex buffer passed to this function.
492 #define KEY_SETSECSPIDX(_dir, s, d, ps, pd, ulp, idx) \
494 bzero((idx), sizeof(struct secpolicyindex)); \
495 (idx)->dir = (_dir); \
496 (idx)->prefs = (ps); \
497 (idx)->prefd = (pd); \
498 (idx)->ul_proto = (ulp); \
499 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
500 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
504 * set parameters into secasindex buffer.
505 * Must allocate secasindex buffer before calling this function.
507 #define KEY_SETSECASIDX(p, m, r, s, d, idx) \
509 bzero((idx), sizeof(struct secasindex)); \
510 (idx)->proto = (p); \
512 (idx)->reqid = (r); \
513 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
514 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
515 key_porttosaddr(&(idx)->src.sa, 0); \
516 key_porttosaddr(&(idx)->dst.sa, 0); \
521 u_long getspi_count; /* the avarage of count to try to get new SPI */
525 struct sadb_msg *msg;
526 struct sadb_ext *ext[SADB_EXT_MAX + 1];
527 int extoff[SADB_EXT_MAX + 1];
528 int extlen[SADB_EXT_MAX + 1];
531 static struct supported_ealgs {
533 const struct enc_xform *xform;
534 } supported_ealgs[] = {
535 { SADB_EALG_DESCBC, &enc_xform_des },
536 { SADB_EALG_3DESCBC, &enc_xform_3des },
537 { SADB_X_EALG_AES, &enc_xform_rijndael128 },
538 { SADB_X_EALG_BLOWFISHCBC, &enc_xform_blf },
539 { SADB_X_EALG_CAST128CBC, &enc_xform_cast5 },
540 { SADB_EALG_NULL, &enc_xform_null },
541 { SADB_X_EALG_CAMELLIACBC, &enc_xform_camellia },
542 { SADB_X_EALG_AESCTR, &enc_xform_aes_icm },
543 { SADB_X_EALG_AESGCM16, &enc_xform_aes_nist_gcm },
544 { SADB_X_EALG_AESGMAC, &enc_xform_aes_nist_gmac },
547 static struct supported_aalgs {
549 const struct auth_hash *xform;
550 } supported_aalgs[] = {
551 { SADB_X_AALG_NULL, &auth_hash_null },
552 { SADB_AALG_MD5HMAC, &auth_hash_hmac_md5 },
553 { SADB_AALG_SHA1HMAC, &auth_hash_hmac_sha1 },
554 { SADB_X_AALG_RIPEMD160HMAC, &auth_hash_hmac_ripemd_160 },
555 { SADB_X_AALG_MD5, &auth_hash_key_md5 },
556 { SADB_X_AALG_SHA, &auth_hash_key_sha1 },
557 { SADB_X_AALG_SHA2_256, &auth_hash_hmac_sha2_256 },
558 { SADB_X_AALG_SHA2_384, &auth_hash_hmac_sha2_384 },
559 { SADB_X_AALG_SHA2_512, &auth_hash_hmac_sha2_512 },
560 { SADB_X_AALG_AES128GMAC, &auth_hash_nist_gmac_aes_128 },
561 { SADB_X_AALG_AES192GMAC, &auth_hash_nist_gmac_aes_192 },
562 { SADB_X_AALG_AES256GMAC, &auth_hash_nist_gmac_aes_256 },
565 static struct supported_calgs {
567 const struct comp_algo *xform;
568 } supported_calgs[] = {
569 { SADB_X_CALG_DEFLATE, &comp_algo_deflate },
573 static struct callout key_timer;
576 static void key_unlink(struct secpolicy *);
577 static struct secpolicy *key_getsp(struct secpolicyindex *);
578 static struct secpolicy *key_getspbyid(u_int32_t);
579 static struct mbuf *key_gather_mbuf(struct mbuf *,
580 const struct sadb_msghdr *, int, int, ...);
581 static int key_spdadd(struct socket *, struct mbuf *,
582 const struct sadb_msghdr *);
583 static uint32_t key_getnewspid(void);
584 static int key_spddelete(struct socket *, struct mbuf *,
585 const struct sadb_msghdr *);
586 static int key_spddelete2(struct socket *, struct mbuf *,
587 const struct sadb_msghdr *);
588 static int key_spdget(struct socket *, struct mbuf *,
589 const struct sadb_msghdr *);
590 static int key_spdflush(struct socket *, struct mbuf *,
591 const struct sadb_msghdr *);
592 static int key_spddump(struct socket *, struct mbuf *,
593 const struct sadb_msghdr *);
594 static struct mbuf *key_setdumpsp(struct secpolicy *,
595 u_int8_t, u_int32_t, u_int32_t);
596 static struct mbuf *key_sp2mbuf(struct secpolicy *);
597 static size_t key_getspreqmsglen(struct secpolicy *);
598 static int key_spdexpire(struct secpolicy *);
599 static struct secashead *key_newsah(struct secasindex *);
600 static void key_freesah(struct secashead **);
601 static void key_delsah(struct secashead *);
602 static struct secasvar *key_newsav(const struct sadb_msghdr *,
603 struct secasindex *, uint32_t, int *);
604 static void key_delsav(struct secasvar *);
605 static void key_unlinksav(struct secasvar *);
606 static struct secashead *key_getsah(struct secasindex *);
607 static int key_checkspidup(uint32_t);
608 static struct secasvar *key_getsavbyspi(uint32_t);
609 static int key_setnatt(struct secasvar *, const struct sadb_msghdr *);
610 static int key_setsaval(struct secasvar *, const struct sadb_msghdr *);
611 static int key_updatelifetimes(struct secasvar *, const struct sadb_msghdr *);
612 static int key_updateaddresses(struct socket *, struct mbuf *,
613 const struct sadb_msghdr *, struct secasvar *, struct secasindex *);
615 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
616 u_int8_t, u_int32_t, u_int32_t);
617 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
618 u_int32_t, pid_t, u_int16_t);
619 static struct mbuf *key_setsadbsa(struct secasvar *);
620 static struct mbuf *key_setsadbaddr(u_int16_t,
621 const struct sockaddr *, u_int8_t, u_int16_t);
622 static struct mbuf *key_setsadbxport(u_int16_t, u_int16_t);
623 static struct mbuf *key_setsadbxtype(u_int16_t);
624 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t);
625 static struct mbuf *key_setsadbxsareplay(u_int32_t);
626 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
627 u_int32_t, u_int32_t);
628 static struct seckey *key_dup_keymsg(const struct sadb_key *, size_t,
629 struct malloc_type *);
630 static struct seclifetime *key_dup_lifemsg(const struct sadb_lifetime *src,
631 struct malloc_type *);
633 /* flags for key_cmpsaidx() */
634 #define CMP_HEAD 1 /* protocol, addresses. */
635 #define CMP_MODE_REQID 2 /* additionally HEAD, reqid, mode. */
636 #define CMP_REQID 3 /* additionally HEAD, reaid. */
637 #define CMP_EXACTLY 4 /* all elements. */
638 static int key_cmpsaidx(const struct secasindex *,
639 const struct secasindex *, int);
640 static int key_cmpspidx_exactly(struct secpolicyindex *,
641 struct secpolicyindex *);
642 static int key_cmpspidx_withmask(struct secpolicyindex *,
643 struct secpolicyindex *);
644 static int key_bbcmp(const void *, const void *, u_int);
645 static uint8_t key_satype2proto(uint8_t);
646 static uint8_t key_proto2satype(uint8_t);
648 static int key_getspi(struct socket *, struct mbuf *,
649 const struct sadb_msghdr *);
650 static uint32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
651 static int key_update(struct socket *, struct mbuf *,
652 const struct sadb_msghdr *);
653 static int key_add(struct socket *, struct mbuf *,
654 const struct sadb_msghdr *);
655 static int key_setident(struct secashead *, const struct sadb_msghdr *);
656 static struct mbuf *key_getmsgbuf_x1(struct mbuf *,
657 const struct sadb_msghdr *);
658 static int key_delete(struct socket *, struct mbuf *,
659 const struct sadb_msghdr *);
660 static int key_delete_all(struct socket *, struct mbuf *,
661 const struct sadb_msghdr *, struct secasindex *);
662 static void key_delete_xform(const struct xformsw *);
663 static int key_get(struct socket *, struct mbuf *,
664 const struct sadb_msghdr *);
666 static void key_getcomb_setlifetime(struct sadb_comb *);
667 static struct mbuf *key_getcomb_ealg(void);
668 static struct mbuf *key_getcomb_ah(void);
669 static struct mbuf *key_getcomb_ipcomp(void);
670 static struct mbuf *key_getprop(const struct secasindex *);
672 static int key_acquire(const struct secasindex *, struct secpolicy *);
673 static uint32_t key_newacq(const struct secasindex *, int *);
674 static uint32_t key_getacq(const struct secasindex *, int *);
675 static int key_acqdone(const struct secasindex *, uint32_t);
676 static int key_acqreset(uint32_t);
677 static struct secspacq *key_newspacq(struct secpolicyindex *);
678 static struct secspacq *key_getspacq(struct secpolicyindex *);
679 static int key_acquire2(struct socket *, struct mbuf *,
680 const struct sadb_msghdr *);
681 static int key_register(struct socket *, struct mbuf *,
682 const struct sadb_msghdr *);
683 static int key_expire(struct secasvar *, int);
684 static int key_flush(struct socket *, struct mbuf *,
685 const struct sadb_msghdr *);
686 static int key_dump(struct socket *, struct mbuf *,
687 const struct sadb_msghdr *);
688 static int key_promisc(struct socket *, struct mbuf *,
689 const struct sadb_msghdr *);
690 static int key_senderror(struct socket *, struct mbuf *, int);
691 static int key_validate_ext(const struct sadb_ext *, int);
692 static int key_align(struct mbuf *, struct sadb_msghdr *);
693 static struct mbuf *key_setlifetime(struct seclifetime *, uint16_t);
694 static struct mbuf *key_setkey(struct seckey *, uint16_t);
695 static int xform_init(struct secasvar *, u_short);
697 #define DBG_IPSEC_INITREF(t, p) do { \
698 refcount_init(&(p)->refcnt, 1); \
700 printf("%s: Initialize refcnt %s(%p) = %u\n", \
701 __func__, #t, (p), (p)->refcnt)); \
703 #define DBG_IPSEC_ADDREF(t, p) do { \
704 refcount_acquire(&(p)->refcnt); \
706 printf("%s: Acquire refcnt %s(%p) -> %u\n", \
707 __func__, #t, (p), (p)->refcnt)); \
709 #define DBG_IPSEC_DELREF(t, p) do { \
711 printf("%s: Release refcnt %s(%p) -> %u\n", \
712 __func__, #t, (p), (p)->refcnt - 1)); \
713 refcount_release(&(p)->refcnt); \
716 #define IPSEC_INITREF(t, p) refcount_init(&(p)->refcnt, 1)
717 #define IPSEC_ADDREF(t, p) refcount_acquire(&(p)->refcnt)
718 #define IPSEC_DELREF(t, p) refcount_release(&(p)->refcnt)
720 #define SP_INITREF(p) IPSEC_INITREF(SP, p)
721 #define SP_ADDREF(p) IPSEC_ADDREF(SP, p)
722 #define SP_DELREF(p) IPSEC_DELREF(SP, p)
724 #define SAH_INITREF(p) IPSEC_INITREF(SAH, p)
725 #define SAH_ADDREF(p) IPSEC_ADDREF(SAH, p)
726 #define SAH_DELREF(p) IPSEC_DELREF(SAH, p)
728 #define SAV_INITREF(p) IPSEC_INITREF(SAV, p)
729 #define SAV_ADDREF(p) IPSEC_ADDREF(SAV, p)
730 #define SAV_DELREF(p) IPSEC_DELREF(SAV, p)
733 * Update the refcnt while holding the SPTREE lock.
736 key_addref(struct secpolicy *sp)
743 * Return 0 when there are known to be no SP's for the specified
744 * direction. Otherwise return 1. This is used by IPsec code
745 * to optimize performance.
748 key_havesp(u_int dir)
751 return (dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND ?
752 TAILQ_FIRST(&V_sptree[dir]) != NULL : 1);
755 /* %%% IPsec policy management */
757 * Return current SPDB generation.
774 key_checksockaddrs(struct sockaddr *src, struct sockaddr *dst)
778 if (src->sa_family != dst->sa_family)
781 if (src->sa_len != dst->sa_len)
783 switch (src->sa_family) {
786 if (src->sa_len != sizeof(struct sockaddr_in))
792 if (src->sa_len != sizeof(struct sockaddr_in6))
797 return (EAFNOSUPPORT);
803 * allocating a SP for OUTBOUND or INBOUND packet.
804 * Must call key_freesp() later.
805 * OUT: NULL: not found
806 * others: found and return the pointer.
809 key_allocsp(struct secpolicyindex *spidx, u_int dir)
811 SPTREE_RLOCK_TRACKER;
812 struct secpolicy *sp;
814 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
815 IPSEC_ASSERT(dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND,
816 ("invalid direction %u", dir));
819 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
820 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
827 if (sp != NULL) { /* found a SPD entry */
828 sp->lastused = time_second;
830 printf("%s: return SP(%p)\n", __func__, sp));
831 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
834 printf("%s: lookup failed for ", __func__);
835 kdebug_secpolicyindex(spidx, NULL));
841 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
842 * or should be signed by MD5 signature.
843 * We don't use key_allocsa() for such lookups, because we don't know SPI.
844 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
845 * signed packet. We use SADB only as storage for password.
846 * OUT: positive: corresponding SA for given saidx found.
850 key_allocsa_tcpmd5(struct secasindex *saidx)
852 SAHTREE_RLOCK_TRACKER;
853 struct secashead *sah;
854 struct secasvar *sav;
856 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
857 ("unexpected security protocol %u", saidx->proto));
858 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
859 ("unexpected mode %u", saidx->mode));
862 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
864 printf("%s: checking SAH\n", __func__);
865 kdebug_secash(sah, " "));
866 if (sah->saidx.proto != IPPROTO_TCP)
868 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
869 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
873 if (V_key_preferred_oldsa)
874 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
876 sav = TAILQ_FIRST(&sah->savtree_alive);
885 printf("%s: return SA(%p)\n", __func__, sav));
886 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
889 printf("%s: SA not found\n", __func__));
890 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
896 * Allocating an SA entry for an *OUTBOUND* packet.
897 * OUT: positive: corresponding SA for given saidx found.
898 * NULL: SA not found, but will be acquired, check *error
899 * for acquiring status.
902 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
905 SAHTREE_RLOCK_TRACKER;
906 struct secashead *sah;
907 struct secasvar *sav;
909 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
910 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
911 saidx->mode == IPSEC_MODE_TUNNEL,
912 ("unexpected policy %u", saidx->mode));
915 * We check new SA in the IPsec request because a different
916 * SA may be involved each time this request is checked, either
917 * because new SAs are being configured, or this request is
918 * associated with an unconnected datagram socket, or this request
919 * is associated with a system default policy.
922 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
924 printf("%s: checking SAH\n", __func__);
925 kdebug_secash(sah, " "));
926 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
932 * Allocate the oldest SA available according to
933 * draft-jenkins-ipsec-rekeying-03.
935 if (V_key_preferred_oldsa)
936 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
938 sav = TAILQ_FIRST(&sah->savtree_alive);
948 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
950 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
951 return (sav); /* return referenced SA */
955 *error = key_acquire(saidx, sp);
958 "%s: error %d returned from key_acquire()\n",
961 printf("%s: acquire SA for SP(%p), error %d\n",
962 __func__, sp, *error));
963 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
968 * allocating a usable SA entry for a *INBOUND* packet.
969 * Must call key_freesav() later.
970 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
971 * NULL: not found, or error occurred.
973 * According to RFC 2401 SA is uniquely identified by a triple SPI,
974 * destination address, and security protocol. But according to RFC 4301,
975 * SPI by itself suffices to specify an SA.
977 * Note that, however, we do need to keep source address in IPsec SA.
978 * IKE specification and PF_KEY specification do assume that we
979 * keep source address in IPsec SA. We see a tricky situation here.
982 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
984 SAHTREE_RLOCK_TRACKER;
985 struct secasvar *sav;
987 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
988 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
992 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
997 * We use single SPI namespace for all protocols, so it is
998 * impossible to have SPI duplicates in the SAVHASH.
1001 if (sav->state != SADB_SASTATE_LARVAL &&
1002 sav->sah->saidx.proto == proto &&
1003 key_sockaddrcmp(&dst->sa,
1004 &sav->sah->saidx.dst.sa, 0) == 0)
1013 char buf[IPSEC_ADDRSTRLEN];
1014 printf("%s: SA not found for spi %u proto %u dst %s\n",
1015 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1019 printf("%s: return SA(%p)\n", __func__, sav));
1020 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1026 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1029 SAHTREE_RLOCK_TRACKER;
1030 struct secasindex saidx;
1031 struct secashead *sah;
1032 struct secasvar *sav;
1034 IPSEC_ASSERT(src != NULL, ("null src address"));
1035 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1037 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1042 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1043 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1045 if (proto != sah->saidx.proto)
1047 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1049 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1051 /* XXXAE: is key_preferred_oldsa reasonably?*/
1052 if (V_key_preferred_oldsa)
1053 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1055 sav = TAILQ_FIRST(&sah->savtree_alive);
1063 printf("%s: return SA(%p)\n", __func__, sav));
1065 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1070 * Must be called after calling key_allocsp().
1073 key_freesp(struct secpolicy **spp)
1075 struct secpolicy *sp = *spp;
1077 IPSEC_ASSERT(sp != NULL, ("null sp"));
1078 if (SP_DELREF(sp) == 0)
1082 printf("%s: last reference to SP(%p)\n", __func__, sp));
1083 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1086 while (sp->tcount > 0)
1087 ipsec_delisr(sp->req[--sp->tcount]);
1088 free(sp, M_IPSEC_SP);
1092 key_unlink(struct secpolicy *sp)
1095 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1096 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1097 ("invalid direction %u", sp->spidx.dir));
1098 SPTREE_UNLOCK_ASSERT();
1101 printf("%s: SP(%p)\n", __func__, sp));
1103 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1104 /* SP is already unlinked */
1108 sp->state = IPSEC_SPSTATE_DEAD;
1109 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1110 LIST_REMOVE(sp, idhash);
1117 * insert a secpolicy into the SP database. Lower priorities first
1120 key_insertsp(struct secpolicy *newsp)
1122 struct secpolicy *sp;
1124 SPTREE_WLOCK_ASSERT();
1125 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1126 if (newsp->priority < sp->priority) {
1127 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1131 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1133 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1134 newsp->state = IPSEC_SPSTATE_ALIVE;
1139 * Insert a bunch of VTI secpolicies into the SPDB.
1140 * We keep VTI policies in the separate list due to following reasons:
1141 * 1) they should be immutable to user's or some deamon's attempts to
1142 * delete. The only way delete such policies - destroy or unconfigure
1143 * corresponding virtual inteface.
1144 * 2) such policies have traffic selector that matches all traffic per
1146 * Since all VTI policies have the same priority, we don't care about
1150 key_register_ifnet(struct secpolicy **spp, u_int count)
1157 * First of try to acquire id for each SP.
1159 for (i = 0; i < count; i++) {
1160 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1161 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1162 ("invalid direction %u", spp[i]->spidx.dir));
1164 if ((spp[i]->id = key_getnewspid()) == 0) {
1169 for (i = 0; i < count; i++) {
1170 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1173 * NOTE: despite the fact that we keep VTI SP in the
1174 * separate list, SPHASH contains policies from both
1175 * sources. Thus SADB_X_SPDGET will correctly return
1176 * SP by id, because it uses SPHASH for lookups.
1178 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1179 spp[i]->state = IPSEC_SPSTATE_IFNET;
1183 * Notify user processes about new SP.
1185 for (i = 0; i < count; i++) {
1186 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1188 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1194 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1200 for (i = 0; i < count; i++) {
1201 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1202 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1203 ("invalid direction %u", spp[i]->spidx.dir));
1205 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1207 spp[i]->state = IPSEC_SPSTATE_DEAD;
1208 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1210 LIST_REMOVE(spp[i], idhash);
1214 for (i = 0; i < count; i++) {
1215 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1217 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1222 * Must be called after calling key_allocsa().
1223 * This function is called by key_freesp() to free some SA allocated
1227 key_freesav(struct secasvar **psav)
1229 struct secasvar *sav = *psav;
1231 IPSEC_ASSERT(sav != NULL, ("null sav"));
1232 if (SAV_DELREF(sav) == 0)
1236 printf("%s: last reference to SA(%p)\n", __func__, sav));
1243 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1244 * Expect that SA has extra reference due to lookup.
1245 * Release this references, also release SAH reference after unlink.
1248 key_unlinksav(struct secasvar *sav)
1250 struct secashead *sah;
1253 printf("%s: SA(%p)\n", __func__, sav));
1255 SAHTREE_UNLOCK_ASSERT();
1257 if (sav->state == SADB_SASTATE_DEAD) {
1258 /* SA is already unlinked */
1262 /* Unlink from SAH */
1263 if (sav->state == SADB_SASTATE_LARVAL)
1264 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1266 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1267 /* Unlink from SPI hash */
1268 LIST_REMOVE(sav, spihash);
1269 sav->state = SADB_SASTATE_DEAD;
1273 /* Since we are unlinked, release reference to SAH */
1277 /* %%% SPD management */
1280 * OUT: NULL : not found
1281 * others : found, pointer to a SP.
1283 static struct secpolicy *
1284 key_getsp(struct secpolicyindex *spidx)
1286 SPTREE_RLOCK_TRACKER;
1287 struct secpolicy *sp;
1289 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1292 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1293 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1305 * OUT: NULL : not found
1306 * others : found, pointer to referenced SP.
1308 static struct secpolicy *
1309 key_getspbyid(uint32_t id)
1311 SPTREE_RLOCK_TRACKER;
1312 struct secpolicy *sp;
1315 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1328 struct secpolicy *sp;
1330 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1336 struct ipsecrequest *
1340 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1341 M_NOWAIT | M_ZERO));
1345 ipsec_delisr(struct ipsecrequest *p)
1348 free(p, M_IPSEC_SR);
1352 * create secpolicy structure from sadb_x_policy structure.
1353 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1354 * are not set, so must be set properly later.
1357 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1359 struct secpolicy *newsp;
1361 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1362 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1364 if (len != PFKEY_EXTLEN(xpl0)) {
1365 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1370 if ((newsp = key_newsp()) == NULL) {
1375 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1376 newsp->policy = xpl0->sadb_x_policy_type;
1377 newsp->priority = xpl0->sadb_x_policy_priority;
1381 switch (xpl0->sadb_x_policy_type) {
1382 case IPSEC_POLICY_DISCARD:
1383 case IPSEC_POLICY_NONE:
1384 case IPSEC_POLICY_ENTRUST:
1385 case IPSEC_POLICY_BYPASS:
1388 case IPSEC_POLICY_IPSEC:
1390 struct sadb_x_ipsecrequest *xisr;
1391 struct ipsecrequest *isr;
1394 /* validity check */
1395 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1396 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1403 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1404 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1408 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1409 xisr->sadb_x_ipsecrequest_len > tlen) {
1410 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1411 "length.\n", __func__));
1417 if (newsp->tcount >= IPSEC_MAXREQ) {
1418 ipseclog((LOG_DEBUG,
1419 "%s: too many ipsecrequests.\n",
1426 /* allocate request buffer */
1427 /* NB: data structure is zero'd */
1428 isr = ipsec_newisr();
1430 ipseclog((LOG_DEBUG,
1431 "%s: No more memory.\n", __func__));
1437 newsp->req[newsp->tcount++] = isr;
1440 switch (xisr->sadb_x_ipsecrequest_proto) {
1443 case IPPROTO_IPCOMP:
1446 ipseclog((LOG_DEBUG,
1447 "%s: invalid proto type=%u\n", __func__,
1448 xisr->sadb_x_ipsecrequest_proto));
1450 *error = EPROTONOSUPPORT;
1454 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1456 switch (xisr->sadb_x_ipsecrequest_mode) {
1457 case IPSEC_MODE_TRANSPORT:
1458 case IPSEC_MODE_TUNNEL:
1460 case IPSEC_MODE_ANY:
1462 ipseclog((LOG_DEBUG,
1463 "%s: invalid mode=%u\n", __func__,
1464 xisr->sadb_x_ipsecrequest_mode));
1469 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1471 switch (xisr->sadb_x_ipsecrequest_level) {
1472 case IPSEC_LEVEL_DEFAULT:
1473 case IPSEC_LEVEL_USE:
1474 case IPSEC_LEVEL_REQUIRE:
1476 case IPSEC_LEVEL_UNIQUE:
1477 /* validity check */
1479 * If range violation of reqid, kernel will
1480 * update it, don't refuse it.
1482 if (xisr->sadb_x_ipsecrequest_reqid
1483 > IPSEC_MANUAL_REQID_MAX) {
1484 ipseclog((LOG_DEBUG,
1485 "%s: reqid=%d range "
1486 "violation, updated by kernel.\n",
1488 xisr->sadb_x_ipsecrequest_reqid));
1489 xisr->sadb_x_ipsecrequest_reqid = 0;
1492 /* allocate new reqid id if reqid is zero. */
1493 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1495 if ((reqid = key_newreqid()) == 0) {
1500 isr->saidx.reqid = reqid;
1501 xisr->sadb_x_ipsecrequest_reqid = reqid;
1503 /* set it for manual keying. */
1505 xisr->sadb_x_ipsecrequest_reqid;
1510 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1512 xisr->sadb_x_ipsecrequest_level));
1517 isr->level = xisr->sadb_x_ipsecrequest_level;
1519 /* set IP addresses if there */
1520 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1521 struct sockaddr *paddr;
1523 len = tlen - sizeof(*xisr);
1524 paddr = (struct sockaddr *)(xisr + 1);
1525 /* validity check */
1526 if (len < sizeof(struct sockaddr) ||
1527 len < 2 * paddr->sa_len ||
1528 paddr->sa_len > sizeof(isr->saidx.src)) {
1529 ipseclog((LOG_DEBUG, "%s: invalid "
1530 "request address length.\n",
1537 * Request length should be enough to keep
1538 * source and destination addresses.
1540 if (xisr->sadb_x_ipsecrequest_len <
1541 sizeof(*xisr) + 2 * paddr->sa_len) {
1542 ipseclog((LOG_DEBUG, "%s: invalid "
1543 "ipsecrequest length.\n",
1549 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1550 paddr = (struct sockaddr *)((caddr_t)paddr +
1553 /* validity check */
1554 if (paddr->sa_len !=
1555 isr->saidx.src.sa.sa_len) {
1556 ipseclog((LOG_DEBUG, "%s: invalid "
1557 "request address length.\n",
1563 /* AF family should match */
1564 if (paddr->sa_family !=
1565 isr->saidx.src.sa.sa_family) {
1566 ipseclog((LOG_DEBUG, "%s: address "
1567 "family doesn't match.\n",
1573 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1576 * Addresses for TUNNEL mode requests are
1579 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1580 ipseclog((LOG_DEBUG, "%s: missing "
1581 "request addresses.\n", __func__));
1587 tlen -= xisr->sadb_x_ipsecrequest_len;
1589 /* validity check */
1591 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1598 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1599 + xisr->sadb_x_ipsecrequest_len);
1601 /* XXXAE: LARVAL SP */
1602 if (newsp->tcount < 1) {
1603 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1604 "not found.\n", __func__));
1612 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1625 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1627 if (auto_reqid == ~0)
1628 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1632 /* XXX should be unique check */
1633 return (auto_reqid);
1637 * copy secpolicy struct to sadb_x_policy structure indicated.
1639 static struct mbuf *
1640 key_sp2mbuf(struct secpolicy *sp)
1645 tlen = key_getspreqmsglen(sp);
1646 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1651 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1659 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1661 struct sadb_x_ipsecrequest *xisr;
1662 struct sadb_x_policy *xpl;
1663 struct ipsecrequest *isr;
1668 IPSEC_ASSERT(sp != NULL, ("null policy"));
1670 xlen = sizeof(*xpl);
1675 bzero(request, *len);
1676 xpl = (struct sadb_x_policy *)request;
1677 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1678 xpl->sadb_x_policy_type = sp->policy;
1679 xpl->sadb_x_policy_dir = sp->spidx.dir;
1680 xpl->sadb_x_policy_id = sp->id;
1681 xpl->sadb_x_policy_priority = sp->priority;
1682 switch (sp->state) {
1683 case IPSEC_SPSTATE_IFNET:
1684 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1686 case IPSEC_SPSTATE_PCB:
1687 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1690 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1693 /* if is the policy for ipsec ? */
1694 if (sp->policy == IPSEC_POLICY_IPSEC) {
1695 p = (caddr_t)xpl + sizeof(*xpl);
1696 for (i = 0; i < sp->tcount; i++) {
1698 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1699 isr->saidx.src.sa.sa_len +
1700 isr->saidx.dst.sa.sa_len);
1704 /* Calculate needed size */
1707 xisr = (struct sadb_x_ipsecrequest *)p;
1708 xisr->sadb_x_ipsecrequest_len = ilen;
1709 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1710 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1711 xisr->sadb_x_ipsecrequest_level = isr->level;
1712 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1715 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1716 p += isr->saidx.src.sa.sa_len;
1717 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1718 p += isr->saidx.dst.sa.sa_len;
1721 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1725 *len = sizeof(*xpl);
1729 /* m will not be freed nor modified */
1730 static struct mbuf *
1731 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1732 int ndeep, int nitem, ...)
1737 struct mbuf *result = NULL, *n;
1740 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1741 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1743 va_start(ap, nitem);
1744 for (i = 0; i < nitem; i++) {
1745 idx = va_arg(ap, int);
1746 if (idx < 0 || idx > SADB_EXT_MAX)
1748 /* don't attempt to pull empty extension */
1749 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1751 if (idx != SADB_EXT_RESERVED &&
1752 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1755 if (idx == SADB_EXT_RESERVED) {
1756 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1758 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1760 MGETHDR(n, M_NOWAIT, MT_DATA);
1765 m_copydata(m, 0, sizeof(struct sadb_msg),
1767 } else if (i < ndeep) {
1768 len = mhp->extlen[idx];
1769 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1774 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1777 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1790 if ((result->m_flags & M_PKTHDR) != 0) {
1791 result->m_pkthdr.len = 0;
1792 for (n = result; n; n = n->m_next)
1793 result->m_pkthdr.len += n->m_len;
1805 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1806 * add an entry to SP database, when received
1807 * <base, address(SD), (lifetime(H),) policy>
1809 * Adding to SP database,
1811 * <base, address(SD), (lifetime(H),) policy>
1812 * to the socket which was send.
1814 * SPDADD set a unique policy entry.
1815 * SPDSETIDX like SPDADD without a part of policy requests.
1816 * SPDUPDATE replace a unique policy entry.
1818 * XXXAE: serialize this in PF_KEY to avoid races.
1819 * m will always be freed.
1822 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1824 struct secpolicyindex spidx;
1825 struct sadb_address *src0, *dst0;
1826 struct sadb_x_policy *xpl0, *xpl;
1827 struct sadb_lifetime *lft = NULL;
1828 struct secpolicy *newsp;
1831 IPSEC_ASSERT(so != NULL, ("null socket"));
1832 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1833 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1834 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1836 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1837 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1838 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1839 ipseclog((LOG_DEBUG,
1840 "%s: invalid message: missing required header.\n",
1842 return key_senderror(so, m, EINVAL);
1844 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1845 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1846 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1847 ipseclog((LOG_DEBUG,
1848 "%s: invalid message: wrong header size.\n", __func__));
1849 return key_senderror(so, m, EINVAL);
1851 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1852 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1853 ipseclog((LOG_DEBUG,
1854 "%s: invalid message: wrong header size.\n",
1856 return key_senderror(so, m, EINVAL);
1858 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1861 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1862 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1863 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1865 /* check the direciton */
1866 switch (xpl0->sadb_x_policy_dir) {
1867 case IPSEC_DIR_INBOUND:
1868 case IPSEC_DIR_OUTBOUND:
1871 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
1872 return key_senderror(so, m, EINVAL);
1874 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
1875 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
1876 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
1877 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
1878 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1879 return key_senderror(so, m, EINVAL);
1882 /* policy requests are mandatory when action is ipsec. */
1883 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
1884 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
1885 ipseclog((LOG_DEBUG,
1886 "%s: policy requests required.\n", __func__));
1887 return key_senderror(so, m, EINVAL);
1890 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
1891 (struct sockaddr *)(dst0 + 1));
1893 src0->sadb_address_proto != dst0->sadb_address_proto) {
1894 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
1895 return key_senderror(so, m, error);
1898 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
1901 src0->sadb_address_prefixlen,
1902 dst0->sadb_address_prefixlen,
1903 src0->sadb_address_proto,
1905 /* Checking there is SP already or not. */
1906 newsp = key_getsp(&spidx);
1907 if (newsp != NULL) {
1908 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
1910 printf("%s: unlink SP(%p) for SPDUPDATE\n",
1912 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
1917 ipseclog((LOG_DEBUG, "%s: a SP entry exists already.",
1919 return (key_senderror(so, m, EEXIST));
1923 /* allocate new SP entry */
1924 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
1925 return key_senderror(so, m, error);
1928 newsp->lastused = newsp->created = time_second;
1929 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
1930 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
1931 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
1933 /* XXXAE: there is race between key_getsp() and key_insertsp() */
1935 if ((newsp->id = key_getnewspid()) == 0) {
1938 return key_senderror(so, m, ENOBUFS);
1940 key_insertsp(newsp);
1944 printf("%s: SP(%p)\n", __func__, newsp));
1945 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
1948 struct mbuf *n, *mpolicy;
1949 struct sadb_msg *newmsg;
1952 /* create new sadb_msg to reply. */
1954 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
1955 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
1956 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
1958 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
1960 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
1963 return key_senderror(so, m, ENOBUFS);
1965 if (n->m_len < sizeof(*newmsg)) {
1966 n = m_pullup(n, sizeof(*newmsg));
1968 return key_senderror(so, m, ENOBUFS);
1970 newmsg = mtod(n, struct sadb_msg *);
1971 newmsg->sadb_msg_errno = 0;
1972 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
1975 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
1976 sizeof(*xpl), &off);
1977 if (mpolicy == NULL) {
1978 /* n is already freed */
1979 return key_senderror(so, m, ENOBUFS);
1981 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
1982 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
1984 return key_senderror(so, m, EINVAL);
1986 xpl->sadb_x_policy_id = newsp->id;
1989 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
1994 * get new policy id.
2000 key_getnewspid(void)
2002 struct secpolicy *sp;
2004 int count = V_key_spi_trycnt; /* XXX */
2006 SPTREE_WLOCK_ASSERT();
2008 if (V_policy_id == ~0) /* overflowed */
2009 newid = V_policy_id = 1;
2011 newid = ++V_policy_id;
2012 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2013 if (sp->id == newid)
2019 if (count == 0 || newid == 0) {
2020 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2028 * SADB_SPDDELETE processing
2030 * <base, address(SD), policy(*)>
2031 * from the user(?), and set SADB_SASTATE_DEAD,
2033 * <base, address(SD), policy(*)>
2035 * policy(*) including direction of policy.
2037 * m will always be freed.
2040 key_spddelete(struct socket *so, struct mbuf *m,
2041 const struct sadb_msghdr *mhp)
2043 struct secpolicyindex spidx;
2044 struct sadb_address *src0, *dst0;
2045 struct sadb_x_policy *xpl0;
2046 struct secpolicy *sp;
2048 IPSEC_ASSERT(so != NULL, ("null so"));
2049 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2050 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2051 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2053 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2054 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2055 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2056 ipseclog((LOG_DEBUG,
2057 "%s: invalid message: missing required header.\n",
2059 return key_senderror(so, m, EINVAL);
2061 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2062 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2063 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2064 ipseclog((LOG_DEBUG,
2065 "%s: invalid message: wrong header size.\n", __func__));
2066 return key_senderror(so, m, EINVAL);
2069 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2070 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2071 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2073 /* check the direciton */
2074 switch (xpl0->sadb_x_policy_dir) {
2075 case IPSEC_DIR_INBOUND:
2076 case IPSEC_DIR_OUTBOUND:
2079 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2080 return key_senderror(so, m, EINVAL);
2082 /* Only DISCARD, NONE and IPSEC are allowed */
2083 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2084 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2085 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2086 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2087 return key_senderror(so, m, EINVAL);
2089 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2090 (struct sockaddr *)(dst0 + 1)) != 0 ||
2091 src0->sadb_address_proto != dst0->sadb_address_proto) {
2092 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2093 return key_senderror(so, m, EINVAL);
2096 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2099 src0->sadb_address_prefixlen,
2100 dst0->sadb_address_prefixlen,
2101 src0->sadb_address_proto,
2104 /* Is there SP in SPD ? */
2105 if ((sp = key_getsp(&spidx)) == NULL) {
2106 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2107 return key_senderror(so, m, EINVAL);
2110 /* save policy id to buffer to be returned. */
2111 xpl0->sadb_x_policy_id = sp->id;
2114 printf("%s: SP(%p)\n", __func__, sp));
2115 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2121 struct sadb_msg *newmsg;
2123 /* create new sadb_msg to reply. */
2124 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2125 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2127 return key_senderror(so, m, ENOBUFS);
2129 newmsg = mtod(n, struct sadb_msg *);
2130 newmsg->sadb_msg_errno = 0;
2131 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2134 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2139 * SADB_SPDDELETE2 processing
2142 * from the user(?), and set SADB_SASTATE_DEAD,
2146 * policy(*) including direction of policy.
2148 * m will always be freed.
2151 key_spddelete2(struct socket *so, struct mbuf *m,
2152 const struct sadb_msghdr *mhp)
2154 struct secpolicy *sp;
2157 IPSEC_ASSERT(so != NULL, ("null socket"));
2158 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2159 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2160 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2162 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2163 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2164 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2166 return key_senderror(so, m, EINVAL);
2169 id = ((struct sadb_x_policy *)
2170 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2172 /* Is there SP in SPD ? */
2173 if ((sp = key_getspbyid(id)) == NULL) {
2174 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2176 return key_senderror(so, m, EINVAL);
2180 printf("%s: SP(%p)\n", __func__, sp));
2181 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2183 if (sp->state != IPSEC_SPSTATE_DEAD) {
2184 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2187 return (key_senderror(so, m, EACCES));
2192 struct mbuf *n, *nn;
2193 struct sadb_msg *newmsg;
2196 /* create new sadb_msg to reply. */
2197 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2199 MGETHDR(n, M_NOWAIT, MT_DATA);
2200 if (n && len > MHLEN) {
2201 if (!(MCLGET(n, M_NOWAIT))) {
2207 return key_senderror(so, m, ENOBUFS);
2213 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2214 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2216 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2219 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2220 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2223 return key_senderror(so, m, ENOBUFS);
2226 n->m_pkthdr.len = 0;
2227 for (nn = n; nn; nn = nn->m_next)
2228 n->m_pkthdr.len += nn->m_len;
2230 newmsg = mtod(n, struct sadb_msg *);
2231 newmsg->sadb_msg_errno = 0;
2232 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2235 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2240 * SADB_X_SPDGET processing
2245 * <base, address(SD), policy>
2247 * policy(*) including direction of policy.
2249 * m will always be freed.
2252 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2254 struct secpolicy *sp;
2258 IPSEC_ASSERT(so != NULL, ("null socket"));
2259 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2260 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2261 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2263 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2264 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2265 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2267 return key_senderror(so, m, EINVAL);
2270 id = ((struct sadb_x_policy *)
2271 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2273 /* Is there SP in SPD ? */
2274 if ((sp = key_getspbyid(id)) == NULL) {
2275 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2277 return key_senderror(so, m, ENOENT);
2280 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2281 mhp->msg->sadb_msg_pid);
2285 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2287 return key_senderror(so, m, ENOBUFS);
2291 * SADB_X_SPDACQUIRE processing.
2292 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2295 * to KMD, and expect to receive
2296 * <base> with SADB_X_SPDACQUIRE if error occurred,
2299 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2300 * policy(*) is without policy requests.
2303 * others: error number
2306 key_spdacquire(struct secpolicy *sp)
2308 struct mbuf *result = NULL, *m;
2309 struct secspacq *newspacq;
2311 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2312 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2313 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2314 ("policy not IPSEC %u", sp->policy));
2316 /* Get an entry to check whether sent message or not. */
2317 newspacq = key_getspacq(&sp->spidx);
2318 if (newspacq != NULL) {
2319 if (V_key_blockacq_count < newspacq->count) {
2320 /* reset counter and do send message. */
2321 newspacq->count = 0;
2323 /* increment counter and do nothing. */
2330 /* make new entry for blocking to send SADB_ACQUIRE. */
2331 newspacq = key_newspacq(&sp->spidx);
2332 if (newspacq == NULL)
2336 /* create new sadb_msg to reply. */
2337 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2343 result->m_pkthdr.len = 0;
2344 for (m = result; m; m = m->m_next)
2345 result->m_pkthdr.len += m->m_len;
2347 mtod(result, struct sadb_msg *)->sadb_msg_len =
2348 PFKEY_UNIT64(result->m_pkthdr.len);
2350 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2354 * SADB_SPDFLUSH processing
2357 * from the user, and free all entries in secpctree.
2361 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2363 * m will always be freed.
2366 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2368 struct secpolicy_queue drainq;
2369 struct sadb_msg *newmsg;
2370 struct secpolicy *sp, *nextsp;
2373 IPSEC_ASSERT(so != NULL, ("null socket"));
2374 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2375 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2376 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2378 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2379 return key_senderror(so, m, EINVAL);
2381 TAILQ_INIT(&drainq);
2383 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2384 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2387 * We need to set state to DEAD for each policy to be sure,
2388 * that another thread won't try to unlink it.
2389 * Also remove SP from sphash.
2391 TAILQ_FOREACH(sp, &drainq, chain) {
2392 sp->state = IPSEC_SPSTATE_DEAD;
2393 LIST_REMOVE(sp, idhash);
2397 sp = TAILQ_FIRST(&drainq);
2398 while (sp != NULL) {
2399 nextsp = TAILQ_NEXT(sp, chain);
2404 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2405 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2406 return key_senderror(so, m, ENOBUFS);
2412 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2413 newmsg = mtod(m, struct sadb_msg *);
2414 newmsg->sadb_msg_errno = 0;
2415 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2417 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2421 key_satype2scopemask(uint8_t satype)
2424 if (satype == IPSEC_POLICYSCOPE_ANY)
2429 * SADB_SPDDUMP processing
2432 * from the user, and dump all SP leaves and send,
2437 * sadb_msg_satype is considered as mask of policy scopes.
2438 * m will always be freed.
2441 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2443 SPTREE_RLOCK_TRACKER;
2444 struct secpolicy *sp;
2449 IPSEC_ASSERT(so != NULL, ("null socket"));
2450 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2451 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2452 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2454 /* search SPD entry and get buffer size. */
2456 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2458 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2459 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2460 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2463 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2464 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2471 return key_senderror(so, m, ENOENT);
2474 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2475 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2476 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2478 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2479 mhp->msg->sadb_msg_pid);
2482 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2485 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2486 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2488 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2489 mhp->msg->sadb_msg_pid);
2492 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2502 static struct mbuf *
2503 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2506 struct mbuf *result = NULL, *m;
2507 struct seclifetime lt;
2509 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2514 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2515 &sp->spidx.src.sa, sp->spidx.prefs,
2516 sp->spidx.ul_proto);
2521 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2522 &sp->spidx.dst.sa, sp->spidx.prefd,
2523 sp->spidx.ul_proto);
2528 m = key_sp2mbuf(sp);
2534 lt.addtime=sp->created;
2535 lt.usetime= sp->lastused;
2536 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2541 lt.addtime=sp->lifetime;
2542 lt.usetime= sp->validtime;
2543 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2549 if ((result->m_flags & M_PKTHDR) == 0)
2552 if (result->m_len < sizeof(struct sadb_msg)) {
2553 result = m_pullup(result, sizeof(struct sadb_msg));
2558 result->m_pkthdr.len = 0;
2559 for (m = result; m; m = m->m_next)
2560 result->m_pkthdr.len += m->m_len;
2562 mtod(result, struct sadb_msg *)->sadb_msg_len =
2563 PFKEY_UNIT64(result->m_pkthdr.len);
2572 * get PFKEY message length for security policy and request.
2575 key_getspreqmsglen(struct secpolicy *sp)
2580 tlen = sizeof(struct sadb_x_policy);
2581 /* if is the policy for ipsec ? */
2582 if (sp->policy != IPSEC_POLICY_IPSEC)
2585 /* get length of ipsec requests */
2586 for (i = 0; i < sp->tcount; i++) {
2587 len = sizeof(struct sadb_x_ipsecrequest)
2588 + sp->req[i]->saidx.src.sa.sa_len
2589 + sp->req[i]->saidx.dst.sa.sa_len;
2591 tlen += PFKEY_ALIGN8(len);
2597 * SADB_SPDEXPIRE processing
2599 * <base, address(SD), lifetime(CH), policy>
2603 * others : error number
2606 key_spdexpire(struct secpolicy *sp)
2608 struct sadb_lifetime *lt;
2609 struct mbuf *result = NULL, *m;
2610 int len, error = -1;
2612 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2615 printf("%s: SP(%p)\n", __func__, sp));
2616 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2618 /* set msg header */
2619 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2626 /* create lifetime extension (current and hard) */
2627 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2628 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2635 bzero(mtod(m, caddr_t), len);
2636 lt = mtod(m, struct sadb_lifetime *);
2637 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2638 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2639 lt->sadb_lifetime_allocations = 0;
2640 lt->sadb_lifetime_bytes = 0;
2641 lt->sadb_lifetime_addtime = sp->created;
2642 lt->sadb_lifetime_usetime = sp->lastused;
2643 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2644 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2645 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2646 lt->sadb_lifetime_allocations = 0;
2647 lt->sadb_lifetime_bytes = 0;
2648 lt->sadb_lifetime_addtime = sp->lifetime;
2649 lt->sadb_lifetime_usetime = sp->validtime;
2652 /* set sadb_address for source */
2653 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2655 sp->spidx.prefs, sp->spidx.ul_proto);
2662 /* set sadb_address for destination */
2663 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2665 sp->spidx.prefd, sp->spidx.ul_proto);
2673 m = key_sp2mbuf(sp);
2680 if ((result->m_flags & M_PKTHDR) == 0) {
2685 if (result->m_len < sizeof(struct sadb_msg)) {
2686 result = m_pullup(result, sizeof(struct sadb_msg));
2687 if (result == NULL) {
2693 result->m_pkthdr.len = 0;
2694 for (m = result; m; m = m->m_next)
2695 result->m_pkthdr.len += m->m_len;
2697 mtod(result, struct sadb_msg *)->sadb_msg_len =
2698 PFKEY_UNIT64(result->m_pkthdr.len);
2700 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2708 /* %%% SAD management */
2710 * allocating and initialize new SA head.
2711 * OUT: NULL : failure due to the lack of memory.
2712 * others : pointer to new SA head.
2714 static struct secashead *
2715 key_newsah(struct secasindex *saidx)
2717 struct secashead *sah;
2719 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2722 PFKEYSTAT_INC(in_nomem);
2725 TAILQ_INIT(&sah->savtree_larval);
2726 TAILQ_INIT(&sah->savtree_alive);
2727 sah->saidx = *saidx;
2728 sah->state = SADB_SASTATE_DEAD;
2732 printf("%s: SAH(%p)\n", __func__, sah));
2733 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2738 key_freesah(struct secashead **psah)
2740 struct secashead *sah = *psah;
2742 if (SAH_DELREF(sah) == 0)
2746 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2747 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2754 key_delsah(struct secashead *sah)
2756 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2757 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2758 ("Attempt to free non DEAD SAH %p", sah));
2759 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2760 ("Attempt to free SAH %p with LARVAL SA", sah));
2761 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2762 ("Attempt to free SAH %p with ALIVE SA", sah));
2764 free(sah, M_IPSEC_SAH);
2768 * allocating a new SA for key_add() and key_getspi() call,
2769 * and copy the values of mhp into new buffer.
2770 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2771 * For SADB_ADD create and initialize SA with MATURE state.
2773 * others : pointer to new secasvar.
2775 static struct secasvar *
2776 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2777 uint32_t spi, int *errp)
2779 struct secashead *sah;
2780 struct secasvar *sav;
2783 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2784 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2785 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2786 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2790 /* check SPI value */
2791 switch (saidx->proto) {
2795 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2796 * 1-255 reserved by IANA for future use,
2797 * 0 for implementation specific, local use.
2799 if (ntohl(spi) <= 255) {
2800 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2801 __func__, ntohl(spi)));
2808 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2813 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2815 if (sav->lock == NULL) {
2819 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2820 sav->lft_c = uma_zalloc(V_key_lft_zone, M_NOWAIT);
2821 if (sav->lft_c == NULL) {
2825 counter_u64_zero(sav->lft_c_allocations);
2826 counter_u64_zero(sav->lft_c_bytes);
2829 sav->seq = mhp->msg->sadb_msg_seq;
2830 sav->state = SADB_SASTATE_LARVAL;
2831 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2834 sah = key_getsah(saidx);
2836 /* create a new SA index */
2837 sah = key_newsah(saidx);
2839 ipseclog((LOG_DEBUG,
2840 "%s: No more memory.\n", __func__));
2849 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2850 sav->created = time_second;
2851 } else if (sav->state == SADB_SASTATE_LARVAL) {
2853 * Do not call key_setsaval() second time in case
2854 * of `goto again`. We will have MATURE state.
2856 *errp = key_setsaval(sav, mhp);
2859 sav->state = SADB_SASTATE_MATURE;
2864 * Check that existing SAH wasn't unlinked.
2865 * Since we didn't hold the SAHTREE lock, it is possible,
2866 * that callout handler or key_flush() or key_delete() could
2869 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
2871 key_freesah(&sah); /* reference from key_getsah() */
2876 * Add new SAH into SADB.
2878 * XXXAE: we can serialize key_add and key_getspi calls, so
2879 * several threads will not fight in the race.
2880 * Otherwise we should check under SAHTREE lock, that this
2881 * SAH would not added twice.
2883 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
2884 /* Add new SAH into hash by addresses */
2885 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
2886 /* Now we are linked in the chain */
2887 sah->state = SADB_SASTATE_MATURE;
2889 * SAV references this new SAH.
2890 * In case of existing SAH we reuse reference
2891 * from key_getsah().
2895 /* Link SAV with SAH */
2896 if (sav->state == SADB_SASTATE_MATURE)
2897 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
2899 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
2900 /* Add SAV into SPI hash */
2901 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
2903 *errp = 0; /* success */
2907 if (sav->lock != NULL) {
2908 mtx_destroy(sav->lock);
2909 free(sav->lock, M_IPSEC_MISC);
2911 if (sav->lft_c != NULL)
2912 uma_zfree(V_key_lft_zone, sav->lft_c);
2913 free(sav, M_IPSEC_SA), sav = NULL;
2917 if (*errp == ENOBUFS) {
2918 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
2920 PFKEYSTAT_INC(in_nomem);
2927 * free() SA variable entry.
2930 key_cleansav(struct secasvar *sav)
2933 if (sav->natt != NULL) {
2934 free(sav->natt, M_IPSEC_MISC);
2937 if (sav->flags & SADB_X_EXT_F_CLONED)
2940 * Cleanup xform state. Note that zeroize'ing causes the
2941 * keys to be cleared; otherwise we must do it ourself.
2943 if (sav->tdb_xform != NULL) {
2944 sav->tdb_xform->xf_zeroize(sav);
2945 sav->tdb_xform = NULL;
2947 if (sav->key_auth != NULL)
2948 bzero(sav->key_auth->key_data, _KEYLEN(sav->key_auth));
2949 if (sav->key_enc != NULL)
2950 bzero(sav->key_enc->key_data, _KEYLEN(sav->key_enc));
2952 if (sav->key_auth != NULL) {
2953 if (sav->key_auth->key_data != NULL)
2954 free(sav->key_auth->key_data, M_IPSEC_MISC);
2955 free(sav->key_auth, M_IPSEC_MISC);
2956 sav->key_auth = NULL;
2958 if (sav->key_enc != NULL) {
2959 if (sav->key_enc->key_data != NULL)
2960 free(sav->key_enc->key_data, M_IPSEC_MISC);
2961 free(sav->key_enc, M_IPSEC_MISC);
2962 sav->key_enc = NULL;
2964 if (sav->replay != NULL) {
2965 if (sav->replay->bitmap != NULL)
2966 free(sav->replay->bitmap, M_IPSEC_MISC);
2967 free(sav->replay, M_IPSEC_MISC);
2970 if (sav->lft_h != NULL) {
2971 free(sav->lft_h, M_IPSEC_MISC);
2974 if (sav->lft_s != NULL) {
2975 free(sav->lft_s, M_IPSEC_MISC);
2981 * free() SA variable entry.
2984 key_delsav(struct secasvar *sav)
2986 IPSEC_ASSERT(sav != NULL, ("null sav"));
2987 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
2988 ("attempt to free non DEAD SA %p", sav));
2989 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
2993 * SA must be unlinked from the chain and hashtbl.
2994 * If SA was cloned, we leave all fields untouched,
2995 * except NAT-T config.
2998 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
2999 mtx_destroy(sav->lock);
3000 free(sav->lock, M_IPSEC_MISC);
3001 uma_zfree(V_key_lft_zone, sav->lft_c);
3003 free(sav, M_IPSEC_SA);
3010 * others : found, referenced pointer to a SAH.
3012 static struct secashead *
3013 key_getsah(struct secasindex *saidx)
3015 SAHTREE_RLOCK_TRACKER;
3016 struct secashead *sah;
3019 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3020 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3030 * Check not to be duplicated SPI.
3033 * 1 : found SA with given SPI.
3036 key_checkspidup(uint32_t spi)
3038 SAHTREE_RLOCK_TRACKER;
3039 struct secasvar *sav;
3041 /* Assume SPI is in network byte order */
3043 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3044 if (sav->spi == spi)
3048 return (sav != NULL);
3055 * others : found, referenced pointer to a SA.
3057 static struct secasvar *
3058 key_getsavbyspi(uint32_t spi)
3060 SAHTREE_RLOCK_TRACKER;
3061 struct secasvar *sav;
3063 /* Assume SPI is in network byte order */
3065 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3066 if (sav->spi != spi)
3076 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3078 struct seclifetime *lft_h, *lft_s, *tmp;
3080 /* Lifetime extension is optional, check that it is present. */
3081 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3082 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3084 * In case of SADB_UPDATE we may need to change
3085 * existing lifetimes.
3087 if (sav->state == SADB_SASTATE_MATURE) {
3088 lft_h = lft_s = NULL;
3093 /* Both HARD and SOFT extensions must present */
3094 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3095 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3096 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3097 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3098 ipseclog((LOG_DEBUG,
3099 "%s: invalid message: missing required header.\n",
3103 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3104 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3105 ipseclog((LOG_DEBUG,
3106 "%s: invalid message: wrong header size.\n", __func__));
3109 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3110 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3111 if (lft_h == NULL) {
3112 PFKEYSTAT_INC(in_nomem);
3113 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3116 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3117 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3118 if (lft_s == NULL) {
3119 PFKEYSTAT_INC(in_nomem);
3120 free(lft_h, M_IPSEC_MISC);
3121 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3125 if (sav->state != SADB_SASTATE_LARVAL) {
3127 * key_update() holds reference to this SA,
3128 * so it won't be deleted in meanwhile.
3138 SECASVAR_UNLOCK(sav);
3140 free(lft_h, M_IPSEC_MISC);
3142 free(lft_s, M_IPSEC_MISC);
3145 /* We can update lifetime without holding a lock */
3146 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3147 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3154 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3155 * You must update these if need. Expects only LARVAL SAs.
3160 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3162 const struct sadb_sa *sa0;
3163 const struct sadb_key *key0;
3168 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3169 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3170 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3171 ("Attempt to update non LARVAL SA"));
3174 error = key_setident(sav->sah, mhp);
3179 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3180 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3184 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3185 sav->alg_auth = sa0->sadb_sa_auth;
3186 sav->alg_enc = sa0->sadb_sa_encrypt;
3187 sav->flags = sa0->sadb_sa_flags;
3188 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3189 ipseclog((LOG_DEBUG,
3190 "%s: invalid sa_flags 0x%08x.\n", __func__,
3196 /* Optional replay window */
3198 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3199 replay = sa0->sadb_sa_replay;
3200 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3201 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3205 replay = ((const struct sadb_x_sa_replay *)
3206 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3208 if (replay > UINT32_MAX - 32) {
3209 ipseclog((LOG_DEBUG,
3210 "%s: replay window too big.\n", __func__));
3215 replay = (replay + 7) >> 3;
3218 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3220 if (sav->replay == NULL) {
3221 PFKEYSTAT_INC(in_nomem);
3222 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3229 /* number of 32b blocks to be allocated */
3230 uint32_t bitmap_size;
3233 * - the allocated replay window size must be
3235 * - use an extra 32b block as a redundant window.
3238 while (replay + 4 > bitmap_size)
3240 bitmap_size = bitmap_size / 4;
3242 sav->replay->bitmap = malloc(
3243 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3245 if (sav->replay->bitmap == NULL) {
3246 PFKEYSTAT_INC(in_nomem);
3247 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3252 sav->replay->bitmap_size = bitmap_size;
3253 sav->replay->wsize = replay;
3257 /* Authentication keys */
3258 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3259 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3264 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3265 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3266 switch (mhp->msg->sadb_msg_satype) {
3267 case SADB_SATYPE_AH:
3268 case SADB_SATYPE_ESP:
3269 case SADB_X_SATYPE_TCPSIGNATURE:
3270 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3271 sav->alg_auth != SADB_X_AALG_NULL)
3274 case SADB_X_SATYPE_IPCOMP:
3280 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3285 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3286 if (sav->key_auth == NULL ) {
3287 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3289 PFKEYSTAT_INC(in_nomem);
3295 /* Encryption key */
3296 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3297 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3302 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3303 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3304 switch (mhp->msg->sadb_msg_satype) {
3305 case SADB_SATYPE_ESP:
3306 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3307 sav->alg_enc != SADB_EALG_NULL) {
3311 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3312 if (sav->key_enc == NULL) {
3313 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3315 PFKEYSTAT_INC(in_nomem);
3320 case SADB_X_SATYPE_IPCOMP:
3321 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3323 sav->key_enc = NULL; /*just in case*/
3325 case SADB_SATYPE_AH:
3326 case SADB_X_SATYPE_TCPSIGNATURE:
3332 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3340 switch (mhp->msg->sadb_msg_satype) {
3341 case SADB_SATYPE_AH:
3342 if (sav->flags & SADB_X_EXT_DERIV) {
3343 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3344 "given to AH SA.\n", __func__));
3348 if (sav->alg_enc != SADB_EALG_NONE) {
3349 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3350 "mismated.\n", __func__));
3354 error = xform_init(sav, XF_AH);
3356 case SADB_SATYPE_ESP:
3357 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3358 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3359 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3360 "given to old-esp.\n", __func__));
3364 error = xform_init(sav, XF_ESP);
3366 case SADB_X_SATYPE_IPCOMP:
3367 if (sav->alg_auth != SADB_AALG_NONE) {
3368 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3369 "mismated.\n", __func__));
3373 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3374 ntohl(sav->spi) >= 0x10000) {
3375 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3380 error = xform_init(sav, XF_IPCOMP);
3382 case SADB_X_SATYPE_TCPSIGNATURE:
3383 if (sav->alg_enc != SADB_EALG_NONE) {
3384 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3385 "mismated.\n", __func__));
3389 error = xform_init(sav, XF_TCPSIGNATURE);
3392 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3393 error = EPROTONOSUPPORT;
3397 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3398 __func__, mhp->msg->sadb_msg_satype));
3402 /* Handle NAT-T headers */
3403 error = key_setnatt(sav, mhp);
3407 /* Initialize lifetime for CURRENT */
3409 sav->created = time_second;
3411 /* lifetimes for HARD and SOFT */
3412 error = key_updatelifetimes(sav, mhp);
3421 * subroutine for SADB_GET and SADB_DUMP.
3423 static struct mbuf *
3424 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3425 uint32_t seq, uint32_t pid)
3427 struct seclifetime lft_c;
3428 struct mbuf *result = NULL, *tres = NULL, *m;
3429 int i, dumporder[] = {
3430 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3431 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3432 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3433 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3434 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3435 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3436 SADB_EXT_SENSITIVITY,
3437 SADB_X_EXT_NAT_T_TYPE,
3438 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3439 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3440 SADB_X_EXT_NAT_T_FRAG,
3442 uint32_t replay_count;
3444 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3449 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3451 switch (dumporder[i]) {
3453 m = key_setsadbsa(sav);
3458 case SADB_X_EXT_SA2:
3460 replay_count = sav->replay ? sav->replay->count : 0;
3461 SECASVAR_UNLOCK(sav);
3462 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3463 sav->sah->saidx.reqid);
3468 case SADB_X_EXT_SA_REPLAY:
3469 if (sav->replay == NULL ||
3470 sav->replay->wsize <= UINT8_MAX)
3473 m = key_setsadbxsareplay(sav->replay->wsize);
3478 case SADB_EXT_ADDRESS_SRC:
3479 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3480 &sav->sah->saidx.src.sa,
3481 FULLMASK, IPSEC_ULPROTO_ANY);
3486 case SADB_EXT_ADDRESS_DST:
3487 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3488 &sav->sah->saidx.dst.sa,
3489 FULLMASK, IPSEC_ULPROTO_ANY);
3494 case SADB_EXT_KEY_AUTH:
3497 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3502 case SADB_EXT_KEY_ENCRYPT:
3505 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3510 case SADB_EXT_LIFETIME_CURRENT:
3511 lft_c.addtime = sav->created;
3512 lft_c.allocations = (uint32_t)counter_u64_fetch(
3513 sav->lft_c_allocations);
3514 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3515 lft_c.usetime = sav->firstused;
3516 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3521 case SADB_EXT_LIFETIME_HARD:
3524 m = key_setlifetime(sav->lft_h,
3525 SADB_EXT_LIFETIME_HARD);
3530 case SADB_EXT_LIFETIME_SOFT:
3533 m = key_setlifetime(sav->lft_s,
3534 SADB_EXT_LIFETIME_SOFT);
3540 case SADB_X_EXT_NAT_T_TYPE:
3541 if (sav->natt == NULL)
3543 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3548 case SADB_X_EXT_NAT_T_DPORT:
3549 if (sav->natt == NULL)
3551 m = key_setsadbxport(sav->natt->dport,
3552 SADB_X_EXT_NAT_T_DPORT);
3557 case SADB_X_EXT_NAT_T_SPORT:
3558 if (sav->natt == NULL)
3560 m = key_setsadbxport(sav->natt->sport,
3561 SADB_X_EXT_NAT_T_SPORT);
3566 case SADB_X_EXT_NAT_T_OAI:
3567 if (sav->natt == NULL ||
3568 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3570 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3571 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3575 case SADB_X_EXT_NAT_T_OAR:
3576 if (sav->natt == NULL ||
3577 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3579 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3580 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3584 case SADB_X_EXT_NAT_T_FRAG:
3585 /* We do not (yet) support those. */
3588 case SADB_EXT_ADDRESS_PROXY:
3589 case SADB_EXT_IDENTITY_SRC:
3590 case SADB_EXT_IDENTITY_DST:
3591 /* XXX: should we brought from SPD ? */
3592 case SADB_EXT_SENSITIVITY:
3604 m_cat(result, tres);
3606 if (result->m_len < sizeof(struct sadb_msg)) {
3607 result = m_pullup(result, sizeof(struct sadb_msg));
3612 result->m_pkthdr.len = 0;
3613 for (m = result; m; m = m->m_next)
3614 result->m_pkthdr.len += m->m_len;
3616 mtod(result, struct sadb_msg *)->sadb_msg_len =
3617 PFKEY_UNIT64(result->m_pkthdr.len);
3628 * set data into sadb_msg.
3630 static struct mbuf *
3631 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3632 pid_t pid, u_int16_t reserved)
3638 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3641 MGETHDR(m, M_NOWAIT, MT_DATA);
3642 if (m && len > MHLEN) {
3643 if (!(MCLGET(m, M_NOWAIT))) {
3650 m->m_pkthdr.len = m->m_len = len;
3653 p = mtod(m, struct sadb_msg *);
3656 p->sadb_msg_version = PF_KEY_V2;
3657 p->sadb_msg_type = type;
3658 p->sadb_msg_errno = 0;
3659 p->sadb_msg_satype = satype;
3660 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3661 p->sadb_msg_reserved = reserved;
3662 p->sadb_msg_seq = seq;
3663 p->sadb_msg_pid = (u_int32_t)pid;
3669 * copy secasvar data into sadb_address.
3671 static struct mbuf *
3672 key_setsadbsa(struct secasvar *sav)
3678 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3679 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3684 p = mtod(m, struct sadb_sa *);
3686 p->sadb_sa_len = PFKEY_UNIT64(len);
3687 p->sadb_sa_exttype = SADB_EXT_SA;
3688 p->sadb_sa_spi = sav->spi;
3689 p->sadb_sa_replay = sav->replay ?
3690 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3691 sav->replay->wsize): 0;
3692 p->sadb_sa_state = sav->state;
3693 p->sadb_sa_auth = sav->alg_auth;
3694 p->sadb_sa_encrypt = sav->alg_enc;
3695 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3700 * set data into sadb_address.
3702 static struct mbuf *
3703 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3704 u_int8_t prefixlen, u_int16_t ul_proto)
3707 struct sadb_address *p;
3710 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3711 PFKEY_ALIGN8(saddr->sa_len);
3712 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3717 p = mtod(m, struct sadb_address *);
3720 p->sadb_address_len = PFKEY_UNIT64(len);
3721 p->sadb_address_exttype = exttype;
3722 p->sadb_address_proto = ul_proto;
3723 if (prefixlen == FULLMASK) {
3724 switch (saddr->sa_family) {
3726 prefixlen = sizeof(struct in_addr) << 3;
3729 prefixlen = sizeof(struct in6_addr) << 3;
3735 p->sadb_address_prefixlen = prefixlen;
3736 p->sadb_address_reserved = 0;
3739 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3746 * set data into sadb_x_sa2.
3748 static struct mbuf *
3749 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3752 struct sadb_x_sa2 *p;
3755 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3756 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3761 p = mtod(m, struct sadb_x_sa2 *);
3764 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3765 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3766 p->sadb_x_sa2_mode = mode;
3767 p->sadb_x_sa2_reserved1 = 0;
3768 p->sadb_x_sa2_reserved2 = 0;
3769 p->sadb_x_sa2_sequence = seq;
3770 p->sadb_x_sa2_reqid = reqid;
3776 * Set data into sadb_x_sa_replay.
3778 static struct mbuf *
3779 key_setsadbxsareplay(u_int32_t replay)
3782 struct sadb_x_sa_replay *p;
3785 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3786 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3791 p = mtod(m, struct sadb_x_sa_replay *);
3794 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3795 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3796 p->sadb_x_sa_replay_replay = (replay << 3);
3802 * Set a type in sadb_x_nat_t_type.
3804 static struct mbuf *
3805 key_setsadbxtype(u_int16_t type)
3809 struct sadb_x_nat_t_type *p;
3811 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3813 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3818 p = mtod(m, struct sadb_x_nat_t_type *);
3821 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3822 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3823 p->sadb_x_nat_t_type_type = type;
3828 * Set a port in sadb_x_nat_t_port.
3829 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3831 static struct mbuf *
3832 key_setsadbxport(u_int16_t port, u_int16_t type)
3836 struct sadb_x_nat_t_port *p;
3838 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3840 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3845 p = mtod(m, struct sadb_x_nat_t_port *);
3848 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3849 p->sadb_x_nat_t_port_exttype = type;
3850 p->sadb_x_nat_t_port_port = port;
3856 * Get port from sockaddr. Port is in network byte order.
3859 key_portfromsaddr(struct sockaddr *sa)
3862 switch (sa->sa_family) {
3865 return ((struct sockaddr_in *)sa)->sin_port;
3869 return ((struct sockaddr_in6 *)sa)->sin6_port;
3876 * Set port in struct sockaddr. Port is in network byte order.
3879 key_porttosaddr(struct sockaddr *sa, uint16_t port)
3882 switch (sa->sa_family) {
3885 ((struct sockaddr_in *)sa)->sin_port = port;
3890 ((struct sockaddr_in6 *)sa)->sin6_port = port;
3894 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
3895 __func__, sa->sa_family));
3901 * set data into sadb_x_policy
3903 static struct mbuf *
3904 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
3907 struct sadb_x_policy *p;
3910 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
3911 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3916 p = mtod(m, struct sadb_x_policy *);
3919 p->sadb_x_policy_len = PFKEY_UNIT64(len);
3920 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
3921 p->sadb_x_policy_type = type;
3922 p->sadb_x_policy_dir = dir;
3923 p->sadb_x_policy_id = id;
3924 p->sadb_x_policy_priority = priority;
3930 /* Take a key message (sadb_key) from the socket and turn it into one
3931 * of the kernel's key structures (seckey).
3933 * IN: pointer to the src
3934 * OUT: NULL no more memory
3937 key_dup_keymsg(const struct sadb_key *src, size_t len,
3938 struct malloc_type *type)
3942 dst = malloc(sizeof(*dst), type, M_NOWAIT);
3944 dst->bits = src->sadb_key_bits;
3945 dst->key_data = malloc(len, type, M_NOWAIT);
3946 if (dst->key_data != NULL) {
3947 bcopy((const char *)(src + 1), dst->key_data, len);
3949 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3955 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3962 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
3963 * turn it into one of the kernel's lifetime structures (seclifetime).
3965 * IN: pointer to the destination, source and malloc type
3966 * OUT: NULL, no more memory
3969 static struct seclifetime *
3970 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
3972 struct seclifetime *dst;
3974 dst = malloc(sizeof(*dst), type, M_NOWAIT);
3976 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3979 dst->allocations = src->sadb_lifetime_allocations;
3980 dst->bytes = src->sadb_lifetime_bytes;
3981 dst->addtime = src->sadb_lifetime_addtime;
3982 dst->usetime = src->sadb_lifetime_usetime;
3987 * compare two secasindex structure.
3988 * flag can specify to compare 2 saidxes.
3989 * compare two secasindex structure without both mode and reqid.
3990 * don't compare port.
3992 * saidx0: source, it can be in SAD.
3999 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4004 if (saidx0 == NULL && saidx1 == NULL)
4007 if (saidx0 == NULL || saidx1 == NULL)
4010 if (saidx0->proto != saidx1->proto)
4013 if (flag == CMP_EXACTLY) {
4014 if (saidx0->mode != saidx1->mode)
4016 if (saidx0->reqid != saidx1->reqid)
4018 if (bcmp(&saidx0->src, &saidx1->src,
4019 saidx0->src.sa.sa_len) != 0 ||
4020 bcmp(&saidx0->dst, &saidx1->dst,
4021 saidx0->dst.sa.sa_len) != 0)
4025 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4026 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4028 * If reqid of SPD is non-zero, unique SA is required.
4029 * The result must be of same reqid in this case.
4031 if (saidx1->reqid != 0 &&
4032 saidx0->reqid != saidx1->reqid)
4036 if (flag == CMP_MODE_REQID) {
4037 if (saidx0->mode != IPSEC_MODE_ANY
4038 && saidx0->mode != saidx1->mode)
4042 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4044 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4052 * compare two secindex structure exactly.
4054 * spidx0: source, it is often in SPD.
4055 * spidx1: object, it is often from PFKEY message.
4061 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4062 struct secpolicyindex *spidx1)
4065 if (spidx0 == NULL && spidx1 == NULL)
4068 if (spidx0 == NULL || spidx1 == NULL)
4071 if (spidx0->prefs != spidx1->prefs
4072 || spidx0->prefd != spidx1->prefd
4073 || spidx0->ul_proto != spidx1->ul_proto)
4076 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4077 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4081 * compare two secindex structure with mask.
4083 * spidx0: source, it is often in SPD.
4084 * spidx1: object, it is often from IP header.
4090 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4091 struct secpolicyindex *spidx1)
4094 if (spidx0 == NULL && spidx1 == NULL)
4097 if (spidx0 == NULL || spidx1 == NULL)
4100 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4101 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4102 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4103 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4106 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4107 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4108 && spidx0->ul_proto != spidx1->ul_proto)
4111 switch (spidx0->src.sa.sa_family) {
4113 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4114 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4116 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4117 &spidx1->src.sin.sin_addr, spidx0->prefs))
4121 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4122 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4125 * scope_id check. if sin6_scope_id is 0, we regard it
4126 * as a wildcard scope, which matches any scope zone ID.
4128 if (spidx0->src.sin6.sin6_scope_id &&
4129 spidx1->src.sin6.sin6_scope_id &&
4130 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4132 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4133 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4138 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4143 switch (spidx0->dst.sa.sa_family) {
4145 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4146 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4148 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4149 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4153 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4154 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4157 * scope_id check. if sin6_scope_id is 0, we regard it
4158 * as a wildcard scope, which matches any scope zone ID.
4160 if (spidx0->dst.sin6.sin6_scope_id &&
4161 spidx1->dst.sin6.sin6_scope_id &&
4162 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4164 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4165 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4170 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4175 /* XXX Do we check other field ? e.g. flowinfo */
4183 #define satosin(s) ((const struct sockaddr_in *)s)
4187 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4188 /* returns 0 on match */
4190 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4193 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4196 switch (sa1->sa_family) {
4199 if (sa1->sa_len != sizeof(struct sockaddr_in))
4201 if (satosin(sa1)->sin_addr.s_addr !=
4202 satosin(sa2)->sin_addr.s_addr) {
4205 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4211 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4212 return 1; /*EINVAL*/
4213 if (satosin6(sa1)->sin6_scope_id !=
4214 satosin6(sa2)->sin6_scope_id) {
4217 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4218 &satosin6(sa2)->sin6_addr)) {
4222 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4228 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4236 /* returns 0 on match */
4238 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4239 const struct sockaddr *sa2, size_t mask)
4241 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4244 switch (sa1->sa_family) {
4247 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4248 &satosin(sa2)->sin_addr, mask));
4252 if (satosin6(sa1)->sin6_scope_id !=
4253 satosin6(sa2)->sin6_scope_id)
4255 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4256 &satosin6(sa2)->sin6_addr, mask));
4265 * compare two buffers with mask.
4269 * bits: Number of bits to compare
4275 key_bbcmp(const void *a1, const void *a2, u_int bits)
4277 const unsigned char *p1 = a1;
4278 const unsigned char *p2 = a2;
4280 /* XXX: This could be considerably faster if we compare a word
4281 * at a time, but it is complicated on LSB Endian machines */
4283 /* Handle null pointers */
4284 if (p1 == NULL || p2 == NULL)
4294 u_int8_t mask = ~((1<<(8-bits))-1);
4295 if ((*p1 & mask) != (*p2 & mask))
4298 return 1; /* Match! */
4302 key_flush_spd(time_t now)
4304 SPTREE_RLOCK_TRACKER;
4305 struct secpolicy_list drainq;
4306 struct secpolicy *sp, *nextsp;
4311 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4312 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4313 if (sp->lifetime == 0 && sp->validtime == 0)
4315 if ((sp->lifetime &&
4316 now - sp->created > sp->lifetime) ||
4318 now - sp->lastused > sp->validtime)) {
4319 /* Hold extra reference to send SPDEXPIRE */
4321 LIST_INSERT_HEAD(&drainq, sp, drainq);
4326 if (LIST_EMPTY(&drainq))
4330 sp = LIST_FIRST(&drainq);
4331 while (sp != NULL) {
4332 nextsp = LIST_NEXT(sp, drainq);
4333 /* Check that SP is still linked */
4334 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4335 LIST_REMOVE(sp, drainq);
4336 key_freesp(&sp); /* release extra reference */
4340 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4341 LIST_REMOVE(sp, idhash);
4342 sp->state = IPSEC_SPSTATE_DEAD;
4348 sp = LIST_FIRST(&drainq);
4349 while (sp != NULL) {
4350 nextsp = LIST_NEXT(sp, drainq);
4352 key_freesp(&sp); /* release extra reference */
4353 key_freesp(&sp); /* release last reference */
4359 key_flush_sad(time_t now)
4361 SAHTREE_RLOCK_TRACKER;
4362 struct secashead_list emptyq;
4363 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4364 struct secashead *sah, *nextsah;
4365 struct secasvar *sav, *nextsav;
4368 LIST_INIT(&hexpireq);
4369 LIST_INIT(&sexpireq);
4373 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4374 /* Check for empty SAH */
4375 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4376 TAILQ_EMPTY(&sah->savtree_alive)) {
4378 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4381 /* Add all stale LARVAL SAs into drainq */
4382 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4383 if (now - sav->created < V_key_larval_lifetime)
4386 LIST_INSERT_HEAD(&drainq, sav, drainq);
4388 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4389 /* lifetimes aren't specified */
4390 if (sav->lft_h == NULL)
4394 * Check again with lock held, because it may
4395 * be updated by SADB_UPDATE.
4397 if (sav->lft_h == NULL) {
4398 SECASVAR_UNLOCK(sav);
4403 * HARD lifetimes MUST take precedence over SOFT
4404 * lifetimes, meaning if the HARD and SOFT lifetimes
4405 * are the same, the HARD lifetime will appear on the
4408 /* check HARD lifetime */
4409 if ((sav->lft_h->addtime != 0 &&
4410 now - sav->created > sav->lft_h->addtime) ||
4411 (sav->lft_h->usetime != 0 && sav->firstused &&
4412 now - sav->firstused > sav->lft_h->usetime) ||
4413 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4414 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4415 SECASVAR_UNLOCK(sav);
4417 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4420 /* check SOFT lifetime (only for MATURE SAs) */
4421 if (sav->state == SADB_SASTATE_MATURE && (
4422 (sav->lft_s->addtime != 0 &&
4423 now - sav->created > sav->lft_s->addtime) ||
4424 (sav->lft_s->usetime != 0 && sav->firstused &&
4425 now - sav->firstused > sav->lft_s->usetime) ||
4426 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4427 sav->lft_c_bytes) > sav->lft_s->bytes))) {
4428 SECASVAR_UNLOCK(sav);
4430 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4433 SECASVAR_UNLOCK(sav);
4438 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4439 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4444 /* Unlink stale LARVAL SAs */
4445 sav = LIST_FIRST(&drainq);
4446 while (sav != NULL) {
4447 nextsav = LIST_NEXT(sav, drainq);
4448 /* Check that SA is still LARVAL */
4449 if (sav->state != SADB_SASTATE_LARVAL) {
4450 LIST_REMOVE(sav, drainq);
4451 LIST_INSERT_HEAD(&freeq, sav, drainq);
4455 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4456 LIST_REMOVE(sav, spihash);
4457 sav->state = SADB_SASTATE_DEAD;
4460 /* Unlink all SAs with expired HARD lifetime */
4461 sav = LIST_FIRST(&hexpireq);
4462 while (sav != NULL) {
4463 nextsav = LIST_NEXT(sav, drainq);
4464 /* Check that SA is not unlinked */
4465 if (sav->state == SADB_SASTATE_DEAD) {
4466 LIST_REMOVE(sav, drainq);
4467 LIST_INSERT_HEAD(&freeq, sav, drainq);
4471 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4472 LIST_REMOVE(sav, spihash);
4473 sav->state = SADB_SASTATE_DEAD;
4476 /* Mark all SAs with expired SOFT lifetime as DYING */
4477 sav = LIST_FIRST(&sexpireq);
4478 while (sav != NULL) {
4479 nextsav = LIST_NEXT(sav, drainq);
4480 /* Check that SA is not unlinked */
4481 if (sav->state == SADB_SASTATE_DEAD) {
4482 LIST_REMOVE(sav, drainq);
4483 LIST_INSERT_HEAD(&freeq, sav, drainq);
4488 * NOTE: this doesn't change SA order in the chain.
4490 sav->state = SADB_SASTATE_DYING;
4493 /* Unlink empty SAHs */
4494 sah = LIST_FIRST(&emptyq);
4495 while (sah != NULL) {
4496 nextsah = LIST_NEXT(sah, drainq);
4497 /* Check that SAH is still empty and not unlinked */
4498 if (sah->state == SADB_SASTATE_DEAD ||
4499 !TAILQ_EMPTY(&sah->savtree_larval) ||
4500 !TAILQ_EMPTY(&sah->savtree_alive)) {
4501 LIST_REMOVE(sah, drainq);
4502 key_freesah(&sah); /* release extra reference */
4506 TAILQ_REMOVE(&V_sahtree, sah, chain);
4507 LIST_REMOVE(sah, addrhash);
4508 sah->state = SADB_SASTATE_DEAD;
4513 /* Send SPDEXPIRE messages */
4514 sav = LIST_FIRST(&hexpireq);
4515 while (sav != NULL) {
4516 nextsav = LIST_NEXT(sav, drainq);
4518 key_freesah(&sav->sah); /* release reference from SAV */
4519 key_freesav(&sav); /* release extra reference */
4520 key_freesav(&sav); /* release last reference */
4523 sav = LIST_FIRST(&sexpireq);
4524 while (sav != NULL) {
4525 nextsav = LIST_NEXT(sav, drainq);
4527 key_freesav(&sav); /* release extra reference */
4530 /* Free stale LARVAL SAs */
4531 sav = LIST_FIRST(&drainq);
4532 while (sav != NULL) {
4533 nextsav = LIST_NEXT(sav, drainq);
4534 key_freesah(&sav->sah); /* release reference from SAV */
4535 key_freesav(&sav); /* release extra reference */
4536 key_freesav(&sav); /* release last reference */
4539 /* Free SAs that were unlinked/changed by someone else */
4540 sav = LIST_FIRST(&freeq);
4541 while (sav != NULL) {
4542 nextsav = LIST_NEXT(sav, drainq);
4543 key_freesav(&sav); /* release extra reference */
4546 /* Free empty SAH */
4547 sah = LIST_FIRST(&emptyq);
4548 while (sah != NULL) {
4549 nextsah = LIST_NEXT(sah, drainq);
4550 key_freesah(&sah); /* release extra reference */
4551 key_freesah(&sah); /* release last reference */
4557 key_flush_acq(time_t now)
4559 struct secacq *acq, *nextacq;
4563 acq = LIST_FIRST(&V_acqtree);
4564 while (acq != NULL) {
4565 nextacq = LIST_NEXT(acq, chain);
4566 if (now - acq->created > V_key_blockacq_lifetime) {
4567 LIST_REMOVE(acq, chain);
4568 LIST_REMOVE(acq, addrhash);
4569 LIST_REMOVE(acq, seqhash);
4570 free(acq, M_IPSEC_SAQ);
4578 key_flush_spacq(time_t now)
4580 struct secspacq *acq, *nextacq;
4584 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4585 nextacq = LIST_NEXT(acq, chain);
4586 if (now - acq->created > V_key_blockacq_lifetime
4587 && __LIST_CHAINED(acq)) {
4588 LIST_REMOVE(acq, chain);
4589 free(acq, M_IPSEC_SAQ);
4597 * scanning SPD and SAD to check status for each entries,
4598 * and do to remove or to expire.
4599 * XXX: year 2038 problem may remain.
4602 key_timehandler(void *arg)
4604 VNET_ITERATOR_DECL(vnet_iter);
4605 time_t now = time_second;
4607 VNET_LIST_RLOCK_NOSLEEP();
4608 VNET_FOREACH(vnet_iter) {
4609 CURVNET_SET(vnet_iter);
4613 key_flush_spacq(now);
4616 VNET_LIST_RUNLOCK_NOSLEEP();
4618 #ifndef IPSEC_DEBUG2
4619 /* do exchange to tick time !! */
4620 callout_schedule(&key_timer, hz);
4621 #endif /* IPSEC_DEBUG2 */
4629 key_randomfill(&value, sizeof(value));
4634 key_randomfill(void *p, size_t l)
4638 static int warn = 1;
4641 n = (size_t)read_random(p, (u_int)l);
4645 bcopy(&v, (u_int8_t *)p + n,
4646 l - n < sizeof(v) ? l - n : sizeof(v));
4650 printf("WARNING: pseudo-random number generator "
4651 "used for IPsec processing\n");
4658 * map SADB_SATYPE_* to IPPROTO_*.
4659 * if satype == SADB_SATYPE then satype is mapped to ~0.
4661 * 0: invalid satype.
4664 key_satype2proto(uint8_t satype)
4667 case SADB_SATYPE_UNSPEC:
4668 return IPSEC_PROTO_ANY;
4669 case SADB_SATYPE_AH:
4671 case SADB_SATYPE_ESP:
4673 case SADB_X_SATYPE_IPCOMP:
4674 return IPPROTO_IPCOMP;
4675 case SADB_X_SATYPE_TCPSIGNATURE:
4684 * map IPPROTO_* to SADB_SATYPE_*
4686 * 0: invalid protocol type.
4689 key_proto2satype(uint8_t proto)
4693 return SADB_SATYPE_AH;
4695 return SADB_SATYPE_ESP;
4696 case IPPROTO_IPCOMP:
4697 return SADB_X_SATYPE_IPCOMP;
4699 return SADB_X_SATYPE_TCPSIGNATURE;
4708 * SADB_GETSPI processing is to receive
4709 * <base, (SA2), src address, dst address, (SPI range)>
4710 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4711 * tree with the status of LARVAL, and send
4712 * <base, SA(*), address(SD)>
4715 * IN: mhp: pointer to the pointer to each header.
4716 * OUT: NULL if fail.
4717 * other if success, return pointer to the message to send.
4720 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4722 struct secasindex saidx;
4723 struct sadb_address *src0, *dst0;
4724 struct secasvar *sav;
4725 uint32_t reqid, spi;
4727 uint8_t mode, proto;
4729 IPSEC_ASSERT(so != NULL, ("null socket"));
4730 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4731 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4732 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4734 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4735 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4736 #ifdef PFKEY_STRICT_CHECKS
4737 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4740 ipseclog((LOG_DEBUG,
4741 "%s: invalid message: missing required header.\n",
4746 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4747 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4748 #ifdef PFKEY_STRICT_CHECKS
4749 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4752 ipseclog((LOG_DEBUG,
4753 "%s: invalid message: wrong header size.\n", __func__));
4757 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4758 mode = IPSEC_MODE_ANY;
4761 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4762 ipseclog((LOG_DEBUG,
4763 "%s: invalid message: wrong header size.\n",
4768 mode = ((struct sadb_x_sa2 *)
4769 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4770 reqid = ((struct sadb_x_sa2 *)
4771 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4774 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4775 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4777 /* map satype to proto */
4778 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4779 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4784 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4785 (struct sockaddr *)(dst0 + 1));
4787 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4791 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4793 /* SPI allocation */
4794 spi = key_do_getnewspi(
4795 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4798 * Requested SPI or SPI range is not available or
4804 sav = key_newsav(mhp, &saidx, spi, &error);
4808 if (sav->seq != 0) {
4811 * If the SADB_GETSPI message is in response to a
4812 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4813 * MUST be the same as the SADB_ACQUIRE message.
4815 * XXXAE: However it doesn't definethe behaviour how to
4816 * check this and what to do if it doesn't match.
4817 * Also what we should do if it matches?
4819 * We can compare saidx used in SADB_ACQUIRE with saidx
4820 * used in SADB_GETSPI, but this probably can break
4821 * existing software. For now just warn if it doesn't match.
4823 * XXXAE: anyway it looks useless.
4825 key_acqdone(&saidx, sav->seq);
4828 printf("%s: SA(%p)\n", __func__, sav));
4829 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4832 struct mbuf *n, *nn;
4833 struct sadb_sa *m_sa;
4834 struct sadb_msg *newmsg;
4837 /* create new sadb_msg to reply. */
4838 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4839 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4841 MGETHDR(n, M_NOWAIT, MT_DATA);
4843 if (!(MCLGET(n, M_NOWAIT))) {
4857 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
4858 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
4860 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
4861 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
4862 m_sa->sadb_sa_exttype = SADB_EXT_SA;
4863 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
4864 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
4866 IPSEC_ASSERT(off == len,
4867 ("length inconsistency (off %u len %u)", off, len));
4869 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
4870 SADB_EXT_ADDRESS_DST);
4877 if (n->m_len < sizeof(struct sadb_msg)) {
4878 n = m_pullup(n, sizeof(struct sadb_msg));
4880 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
4883 n->m_pkthdr.len = 0;
4884 for (nn = n; nn; nn = nn->m_next)
4885 n->m_pkthdr.len += nn->m_len;
4887 newmsg = mtod(n, struct sadb_msg *);
4888 newmsg->sadb_msg_seq = sav->seq;
4889 newmsg->sadb_msg_errno = 0;
4890 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
4893 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
4897 return (key_senderror(so, m, error));
4901 * allocating new SPI
4902 * called by key_getspi().
4905 * others: success, SPI in network byte order.
4908 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
4910 uint32_t min, max, newspi, t;
4911 int count = V_key_spi_trycnt;
4913 /* set spi range to allocate */
4914 if (spirange != NULL) {
4915 min = spirange->sadb_spirange_min;
4916 max = spirange->sadb_spirange_max;
4918 min = V_key_spi_minval;
4919 max = V_key_spi_maxval;
4921 /* IPCOMP needs 2-byte SPI */
4922 if (saidx->proto == IPPROTO_IPCOMP) {
4928 t = min; min = max; max = t;
4933 if (!key_checkspidup(htonl(min))) {
4934 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
4939 count--; /* taking one cost. */
4946 /* when requesting to allocate spi ranged */
4948 /* generate pseudo-random SPI value ranged. */
4949 newspi = min + (key_random() % (max - min + 1));
4950 if (!key_checkspidup(htonl(newspi)))
4954 if (count == 0 || newspi == 0) {
4955 ipseclog((LOG_DEBUG,
4956 "%s: failed to allocate SPI.\n", __func__));
4962 keystat.getspi_count =
4963 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
4965 return (htonl(newspi));
4969 * Find TCP-MD5 SA with corresponding secasindex.
4970 * If not found, return NULL and fill SPI with usable value if needed.
4972 static struct secasvar *
4973 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
4975 SAHTREE_RLOCK_TRACKER;
4976 struct secashead *sah;
4977 struct secasvar *sav;
4979 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
4981 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
4982 if (sah->saidx.proto != IPPROTO_TCP)
4984 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
4985 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
4989 if (V_key_preferred_oldsa)
4990 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
4992 sav = TAILQ_FIRST(&sah->savtree_alive);
5000 /* No SPI required */
5004 /* Check that SPI is unique */
5005 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5006 if (sav->spi == *spi)
5011 /* SPI is already unique */
5015 /* XXX: not optimal */
5016 *spi = key_do_getnewspi(NULL, saidx);
5021 key_updateaddresses(struct socket *so, struct mbuf *m,
5022 const struct sadb_msghdr *mhp, struct secasvar *sav,
5023 struct secasindex *saidx)
5025 struct sockaddr *newaddr;
5026 struct secashead *sah;
5027 struct secasvar *newsav, *tmp;
5031 /* Check that we need to change SAH */
5032 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5033 newaddr = (struct sockaddr *)(
5034 ((struct sadb_address *)
5035 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5036 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5037 key_porttosaddr(&saidx->src.sa, 0);
5039 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5040 newaddr = (struct sockaddr *)(
5041 ((struct sadb_address *)
5042 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5043 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5044 key_porttosaddr(&saidx->dst.sa, 0);
5046 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5047 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5048 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5050 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5055 sah = key_getsah(saidx);
5057 /* create a new SA index */
5058 sah = key_newsah(saidx);
5060 ipseclog((LOG_DEBUG,
5061 "%s: No more memory.\n", __func__));
5064 isnew = 2; /* SAH is new */
5066 isnew = 1; /* existing SAH is referenced */
5069 * src and dst addresses are still the same.
5070 * Do we want to change NAT-T config?
5072 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5073 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5074 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5075 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5076 ipseclog((LOG_DEBUG,
5077 "%s: invalid message: missing required header.\n",
5081 /* We hold reference to SA, thus SAH will be referenced too. */
5086 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5088 if (newsav == NULL) {
5089 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5094 /* Clone SA's content into newsav */
5095 SAV_INITREF(newsav);
5096 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5098 * We create new NAT-T config if it is needed.
5099 * Old NAT-T config will be freed by key_cleansav() when
5100 * last reference to SA will be released.
5102 newsav->natt = NULL;
5104 newsav->state = SADB_SASTATE_MATURE;
5105 error = key_setnatt(newsav, mhp);
5110 /* Check that SA is still alive */
5111 if (sav->state == SADB_SASTATE_DEAD) {
5112 /* SA was unlinked */
5118 /* Unlink SA from SAH and SPI hash */
5119 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5120 ("SA is already cloned"));
5121 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5122 sav->state == SADB_SASTATE_DYING,
5123 ("Wrong SA state %u\n", sav->state));
5124 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5125 LIST_REMOVE(sav, spihash);
5126 sav->state = SADB_SASTATE_DEAD;
5129 * Link new SA with SAH. Keep SAs ordered by
5130 * create time (newer are first).
5132 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5133 if (newsav->created > tmp->created) {
5134 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5139 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5141 /* Add new SA into SPI hash. */
5142 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5144 /* Add new SAH into SADB. */
5146 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5147 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5148 sah->state = SADB_SASTATE_MATURE;
5149 SAH_ADDREF(sah); /* newsav references new SAH */
5152 * isnew == 1 -> @sah was referenced by key_getsah().
5153 * isnew == 0 -> we use the same @sah, that was used by @sav,
5154 * and we use its reference for @newsav.
5157 /* XXX: replace cntr with pointer? */
5158 newsav->cntr = sav->cntr;
5159 sav->flags |= SADB_X_EXT_F_CLONED;
5160 SECASVAR_UNLOCK(sav);
5165 printf("%s: SA(%p) cloned into SA(%p)\n",
5166 __func__, sav, newsav));
5167 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5169 key_freesav(&sav); /* release last reference */
5171 /* set msg buf from mhp */
5172 n = key_getmsgbuf_x1(m, mhp);
5174 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5178 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5183 if (newsav != NULL) {
5184 if (newsav->natt != NULL)
5185 free(newsav->natt, M_IPSEC_MISC);
5186 free(newsav, M_IPSEC_SA);
5192 * SADB_UPDATE processing
5194 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5195 * key(AE), (identity(SD),) (sensitivity)>
5196 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5198 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5199 * (identity(SD),) (sensitivity)>
5202 * m will always be freed.
5205 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5207 struct secasindex saidx;
5208 struct sadb_address *src0, *dst0;
5209 struct sadb_sa *sa0;
5210 struct secasvar *sav;
5213 uint8_t mode, proto;
5215 IPSEC_ASSERT(so != NULL, ("null socket"));
5216 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5217 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5218 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5220 /* map satype to proto */
5221 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5222 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5224 return key_senderror(so, m, EINVAL);
5227 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5228 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5229 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5230 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5231 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5232 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5233 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5234 ipseclog((LOG_DEBUG,
5235 "%s: invalid message: missing required header.\n",
5237 return key_senderror(so, m, EINVAL);
5239 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5240 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5241 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5242 ipseclog((LOG_DEBUG,
5243 "%s: invalid message: wrong header size.\n", __func__));
5244 return key_senderror(so, m, EINVAL);
5246 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5247 mode = IPSEC_MODE_ANY;
5250 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5251 ipseclog((LOG_DEBUG,
5252 "%s: invalid message: wrong header size.\n",
5254 return key_senderror(so, m, EINVAL);
5256 mode = ((struct sadb_x_sa2 *)
5257 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5258 reqid = ((struct sadb_x_sa2 *)
5259 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5262 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5263 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5264 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5267 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5268 * SADB_UPDATE message.
5270 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5271 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5272 #ifdef PFKEY_STRICT_CHECKS
5273 return key_senderror(so, m, EINVAL);
5276 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5277 (struct sockaddr *)(dst0 + 1));
5279 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5280 return key_senderror(so, m, error);
5282 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5283 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5285 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5286 __func__, ntohl(sa0->sadb_sa_spi)));
5287 return key_senderror(so, m, EINVAL);
5290 * Check that SADB_UPDATE issued by the same process that did
5291 * SADB_GETSPI or SADB_ADD.
5293 if (sav->pid != mhp->msg->sadb_msg_pid) {
5294 ipseclog((LOG_DEBUG,
5295 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5296 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5298 return key_senderror(so, m, EINVAL);
5300 /* saidx should match with SA. */
5301 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5302 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u",
5303 __func__, ntohl(sav->spi)));
5305 return key_senderror(so, m, ESRCH);
5308 if (sav->state == SADB_SASTATE_LARVAL) {
5309 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5310 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5311 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5312 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5313 ipseclog((LOG_DEBUG,
5314 "%s: invalid message: missing required header.\n",
5317 return key_senderror(so, m, EINVAL);
5320 * We can set any values except src, dst and SPI.
5322 error = key_setsaval(sav, mhp);
5325 return (key_senderror(so, m, error));
5327 /* Change SA state to MATURE */
5329 if (sav->state != SADB_SASTATE_LARVAL) {
5330 /* SA was deleted or another thread made it MATURE. */
5333 return (key_senderror(so, m, ESRCH));
5336 * NOTE: we keep SAs in savtree_alive ordered by created
5337 * time. When SA's state changed from LARVAL to MATURE,
5338 * we update its created time in key_setsaval() and move
5339 * it into head of savtree_alive.
5341 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5342 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5343 sav->state = SADB_SASTATE_MATURE;
5347 * For DYING and MATURE SA we can change only state
5348 * and lifetimes. Report EINVAL if something else attempted
5351 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5352 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5354 return (key_senderror(so, m, EINVAL));
5356 error = key_updatelifetimes(sav, mhp);
5359 return (key_senderror(so, m, error));
5362 * This is FreeBSD extension to RFC2367.
5363 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5364 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5365 * SA addresses (for example to implement MOBIKE protocol
5366 * as described in RFC4555). Also we allow to change
5369 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5370 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5371 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5372 sav->natt != NULL) {
5373 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5376 return (key_senderror(so, m, error));
5379 /* Check that SA is still alive */
5381 if (sav->state == SADB_SASTATE_DEAD) {
5382 /* SA was unlinked */
5385 return (key_senderror(so, m, ESRCH));
5388 * NOTE: there is possible state moving from DYING to MATURE,
5389 * but this doesn't change created time, so we won't reorder
5392 sav->state = SADB_SASTATE_MATURE;
5396 printf("%s: SA(%p)\n", __func__, sav));
5397 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5403 /* set msg buf from mhp */
5404 n = key_getmsgbuf_x1(m, mhp);
5406 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5407 return key_senderror(so, m, ENOBUFS);
5411 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5416 * SADB_ADD processing
5417 * add an entry to SA database, when received
5418 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5419 * key(AE), (identity(SD),) (sensitivity)>
5422 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5423 * (identity(SD),) (sensitivity)>
5426 * IGNORE identity and sensitivity messages.
5428 * m will always be freed.
5431 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5433 struct secasindex saidx;
5434 struct sadb_address *src0, *dst0;
5435 struct sadb_sa *sa0;
5436 struct secasvar *sav;
5437 uint32_t reqid, spi;
5438 uint8_t mode, proto;
5441 IPSEC_ASSERT(so != NULL, ("null socket"));
5442 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5443 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5444 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5446 /* map satype to proto */
5447 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5448 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5450 return key_senderror(so, m, EINVAL);
5453 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5454 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5455 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5456 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5457 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5458 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5459 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5460 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5461 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5462 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5463 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5464 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5465 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5466 ipseclog((LOG_DEBUG,
5467 "%s: invalid message: missing required header.\n",
5469 return key_senderror(so, m, EINVAL);
5471 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5472 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5473 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5474 ipseclog((LOG_DEBUG,
5475 "%s: invalid message: wrong header size.\n", __func__));
5476 return key_senderror(so, m, EINVAL);
5478 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5479 mode = IPSEC_MODE_ANY;
5482 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5483 ipseclog((LOG_DEBUG,
5484 "%s: invalid message: wrong header size.\n",
5486 return key_senderror(so, m, EINVAL);
5488 mode = ((struct sadb_x_sa2 *)
5489 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5490 reqid = ((struct sadb_x_sa2 *)
5491 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5494 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5495 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5496 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5499 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5502 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5503 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5504 #ifdef PFKEY_STRICT_CHECKS
5505 return key_senderror(so, m, EINVAL);
5508 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5509 (struct sockaddr *)(dst0 + 1));
5511 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5512 return key_senderror(so, m, error);
5514 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5515 spi = sa0->sadb_sa_spi;
5517 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5519 * XXXAE: IPComp seems also doesn't use SPI.
5521 if (proto == IPPROTO_TCP) {
5522 sav = key_getsav_tcpmd5(&saidx, &spi);
5523 if (sav == NULL && spi == 0) {
5524 /* Failed to allocate SPI */
5525 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5527 return key_senderror(so, m, EEXIST);
5529 /* XXX: SPI that we report back can have another value */
5531 /* We can create new SA only if SPI is different. */
5532 sav = key_getsavbyspi(spi);
5536 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5537 return key_senderror(so, m, EEXIST);
5540 sav = key_newsav(mhp, &saidx, spi, &error);
5542 return key_senderror(so, m, error);
5544 printf("%s: return SA(%p)\n", __func__, sav));
5545 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5547 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5551 key_acqdone(&saidx, sav->seq);
5555 * Don't call key_freesav() on error here, as we would like to
5556 * keep the SA in the database.
5560 /* set msg buf from mhp */
5561 n = key_getmsgbuf_x1(m, mhp);
5563 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5564 return key_senderror(so, m, ENOBUFS);
5568 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5574 * IKEd may request the use ESP in UDP encapsulation when it detects the
5575 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5576 * parameters needed for encapsulation and decapsulation. These PF_KEY
5577 * extension headers are not standardized, so this comment addresses our
5579 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5580 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5581 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5582 * UDP header. We use these ports in UDP encapsulation procedure, also we
5583 * can check them in UDP decapsulation procedure.
5584 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5585 * responder. These addresses can be used for transport mode to adjust
5586 * checksum after decapsulation and decryption. Since original IP addresses
5587 * used by peer usually different (we detected presence of NAT), TCP/UDP
5588 * pseudo header checksum and IP header checksum was calculated using original
5589 * addresses. After decapsulation and decryption we need to adjust checksum
5590 * to have correct datagram.
5592 * We expect presence of NAT-T extension headers only in SADB_ADD and
5593 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5594 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5597 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5599 struct sadb_x_nat_t_port *port;
5600 struct sadb_x_nat_t_type *type;
5601 struct sadb_address *oai, *oar;
5602 struct sockaddr *sa;
5606 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5608 * Ignore NAT-T headers if sproto isn't ESP.
5610 if (sav->sah->saidx.proto != IPPROTO_ESP)
5613 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5614 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5615 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5616 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5617 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5618 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5619 ipseclog((LOG_DEBUG,
5620 "%s: invalid message: wrong header size.\n",
5627 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5628 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5629 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5630 __func__, type->sadb_x_nat_t_type_type));
5634 * Allocate storage for NAT-T config.
5635 * On error it will be released by key_cleansav().
5637 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5639 if (sav->natt == NULL) {
5640 PFKEYSTAT_INC(in_nomem);
5641 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5644 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5645 if (port->sadb_x_nat_t_port_port == 0) {
5646 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5650 sav->natt->sport = port->sadb_x_nat_t_port_port;
5651 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5652 if (port->sadb_x_nat_t_port_port == 0) {
5653 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5657 sav->natt->dport = port->sadb_x_nat_t_port_port;
5660 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5661 * and needed only for transport mode IPsec.
5662 * Usually NAT translates only one address, but it is possible,
5663 * that both addresses could be translated.
5664 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5666 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5667 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5668 ipseclog((LOG_DEBUG,
5669 "%s: invalid message: wrong header size.\n",
5673 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5676 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5677 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5678 ipseclog((LOG_DEBUG,
5679 "%s: invalid message: wrong header size.\n",
5683 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5687 /* Initialize addresses only for transport mode */
5688 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5691 /* Currently we support only AF_INET */
5692 sa = (struct sockaddr *)(oai + 1);
5693 if (sa->sa_family != AF_INET ||
5694 sa->sa_len != sizeof(struct sockaddr_in)) {
5695 ipseclog((LOG_DEBUG,
5696 "%s: wrong NAT-OAi header.\n",
5700 /* Ignore address if it the same */
5701 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5702 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5703 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5704 sav->natt->flags |= IPSEC_NATT_F_OAI;
5705 /* Calculate checksum delta */
5706 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5707 cksum = in_addword(cksum, ~addr >> 16);
5708 cksum = in_addword(cksum, ~addr & 0xffff);
5709 addr = sav->natt->oai.sin.sin_addr.s_addr;
5710 cksum = in_addword(cksum, addr >> 16);
5711 cksum = in_addword(cksum, addr & 0xffff);
5715 /* Currently we support only AF_INET */
5716 sa = (struct sockaddr *)(oar + 1);
5717 if (sa->sa_family != AF_INET ||
5718 sa->sa_len != sizeof(struct sockaddr_in)) {
5719 ipseclog((LOG_DEBUG,
5720 "%s: wrong NAT-OAr header.\n",
5724 /* Ignore address if it the same */
5725 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5726 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5727 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5728 sav->natt->flags |= IPSEC_NATT_F_OAR;
5729 /* Calculate checksum delta */
5730 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5731 cksum = in_addword(cksum, ~addr >> 16);
5732 cksum = in_addword(cksum, ~addr & 0xffff);
5733 addr = sav->natt->oar.sin.sin_addr.s_addr;
5734 cksum = in_addword(cksum, addr >> 16);
5735 cksum = in_addword(cksum, addr & 0xffff);
5738 sav->natt->cksum = cksum;
5744 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5746 const struct sadb_ident *idsrc, *iddst;
5748 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5749 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5750 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5752 /* don't make buffer if not there */
5753 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5754 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5760 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5761 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5762 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5766 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5767 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5769 /* validity check */
5770 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5771 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5775 switch (idsrc->sadb_ident_type) {
5776 case SADB_IDENTTYPE_PREFIX:
5777 case SADB_IDENTTYPE_FQDN:
5778 case SADB_IDENTTYPE_USERFQDN:
5780 /* XXX do nothing */
5786 /* make structure */
5787 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5788 if (sah->idents == NULL) {
5789 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5792 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5793 if (sah->identd == NULL) {
5794 free(sah->idents, M_IPSEC_MISC);
5796 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5799 sah->idents->type = idsrc->sadb_ident_type;
5800 sah->idents->id = idsrc->sadb_ident_id;
5802 sah->identd->type = iddst->sadb_ident_type;
5803 sah->identd->id = iddst->sadb_ident_id;
5809 * m will not be freed on return.
5810 * it is caller's responsibility to free the result.
5812 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5813 * from the request in defined order.
5815 static struct mbuf *
5816 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5820 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5821 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5822 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5824 /* create new sadb_msg to reply. */
5825 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5826 SADB_EXT_SA, SADB_X_EXT_SA2,
5827 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5828 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5829 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5830 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5831 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5832 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5833 SADB_X_EXT_NEW_ADDRESS_DST);
5837 if (n->m_len < sizeof(struct sadb_msg)) {
5838 n = m_pullup(n, sizeof(struct sadb_msg));
5842 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5843 mtod(n, struct sadb_msg *)->sadb_msg_len =
5844 PFKEY_UNIT64(n->m_pkthdr.len);
5850 * SADB_DELETE processing
5852 * <base, SA(*), address(SD)>
5853 * from the ikmpd, and set SADB_SASTATE_DEAD,
5855 * <base, SA(*), address(SD)>
5858 * m will always be freed.
5861 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5863 struct secasindex saidx;
5864 struct sadb_address *src0, *dst0;
5865 struct secasvar *sav;
5866 struct sadb_sa *sa0;
5869 IPSEC_ASSERT(so != NULL, ("null socket"));
5870 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5871 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5872 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5874 /* map satype to proto */
5875 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5876 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5878 return key_senderror(so, m, EINVAL);
5881 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5882 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5883 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5884 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5885 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
5887 return key_senderror(so, m, EINVAL);
5890 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5891 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5893 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
5894 (struct sockaddr *)(dst0 + 1)) != 0) {
5895 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5896 return (key_senderror(so, m, EINVAL));
5898 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
5899 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
5901 * Caller wants us to delete all non-LARVAL SAs
5902 * that match the src/dst. This is used during
5903 * IKE INITIAL-CONTACT.
5904 * XXXAE: this looks like some extension to RFC2367.
5906 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
5907 return (key_delete_all(so, m, mhp, &saidx));
5909 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
5910 ipseclog((LOG_DEBUG,
5911 "%s: invalid message: wrong header size.\n", __func__));
5912 return (key_senderror(so, m, EINVAL));
5914 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5915 if (proto == IPPROTO_TCP)
5916 sav = key_getsav_tcpmd5(&saidx, NULL);
5918 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5920 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
5921 __func__, ntohl(sa0->sadb_sa_spi)));
5922 return (key_senderror(so, m, ESRCH));
5924 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
5925 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
5926 __func__, ntohl(sav->spi)));
5928 return (key_senderror(so, m, ESRCH));
5931 printf("%s: SA(%p)\n", __func__, sav));
5932 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5938 struct sadb_msg *newmsg;
5940 /* create new sadb_msg to reply. */
5941 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
5942 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
5944 return key_senderror(so, m, ENOBUFS);
5946 if (n->m_len < sizeof(struct sadb_msg)) {
5947 n = m_pullup(n, sizeof(struct sadb_msg));
5949 return key_senderror(so, m, ENOBUFS);
5951 newmsg = mtod(n, struct sadb_msg *);
5952 newmsg->sadb_msg_errno = 0;
5953 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
5956 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5961 * delete all SAs for src/dst. Called from key_delete().
5964 key_delete_all(struct socket *so, struct mbuf *m,
5965 const struct sadb_msghdr *mhp, struct secasindex *saidx)
5967 struct secasvar_queue drainq;
5968 struct secashead *sah;
5969 struct secasvar *sav, *nextsav;
5971 TAILQ_INIT(&drainq);
5973 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5974 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
5976 /* Move all ALIVE SAs into drainq */
5977 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
5979 /* Unlink all queued SAs from SPI hash */
5980 TAILQ_FOREACH(sav, &drainq, chain) {
5981 sav->state = SADB_SASTATE_DEAD;
5982 LIST_REMOVE(sav, spihash);
5985 /* Now we can release reference for all SAs in drainq */
5986 sav = TAILQ_FIRST(&drainq);
5987 while (sav != NULL) {
5989 printf("%s: SA(%p)\n", __func__, sav));
5990 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5991 nextsav = TAILQ_NEXT(sav, chain);
5992 key_freesah(&sav->sah); /* release reference from SAV */
5993 key_freesav(&sav); /* release last reference */
5999 struct sadb_msg *newmsg;
6001 /* create new sadb_msg to reply. */
6002 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6003 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6005 return key_senderror(so, m, ENOBUFS);
6007 if (n->m_len < sizeof(struct sadb_msg)) {
6008 n = m_pullup(n, sizeof(struct sadb_msg));
6010 return key_senderror(so, m, ENOBUFS);
6012 newmsg = mtod(n, struct sadb_msg *);
6013 newmsg->sadb_msg_errno = 0;
6014 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6017 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6022 * Delete all alive SAs for corresponding xform.
6023 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6024 * here when xform disappears.
6027 key_delete_xform(const struct xformsw *xsp)
6029 struct secasvar_queue drainq;
6030 struct secashead *sah;
6031 struct secasvar *sav, *nextsav;
6033 TAILQ_INIT(&drainq);
6035 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6036 sav = TAILQ_FIRST(&sah->savtree_alive);
6039 if (sav->tdb_xform != xsp)
6042 * It is supposed that all SAs in the chain are related to
6045 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6047 /* Unlink all queued SAs from SPI hash */
6048 TAILQ_FOREACH(sav, &drainq, chain) {
6049 sav->state = SADB_SASTATE_DEAD;
6050 LIST_REMOVE(sav, spihash);
6054 /* Now we can release reference for all SAs in drainq */
6055 sav = TAILQ_FIRST(&drainq);
6056 while (sav != NULL) {
6058 printf("%s: SA(%p)\n", __func__, sav));
6059 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6060 nextsav = TAILQ_NEXT(sav, chain);
6061 key_freesah(&sav->sah); /* release reference from SAV */
6062 key_freesav(&sav); /* release last reference */
6068 * SADB_GET processing
6070 * <base, SA(*), address(SD)>
6071 * from the ikmpd, and get a SP and a SA to respond,
6073 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6074 * (identity(SD),) (sensitivity)>
6077 * m will always be freed.
6080 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6082 struct secasindex saidx;
6083 struct sadb_address *src0, *dst0;
6084 struct sadb_sa *sa0;
6085 struct secasvar *sav;
6088 IPSEC_ASSERT(so != NULL, ("null socket"));
6089 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6090 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6091 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6093 /* map satype to proto */
6094 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6095 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6097 return key_senderror(so, m, EINVAL);
6100 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6101 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6102 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6103 ipseclog((LOG_DEBUG,
6104 "%s: invalid message: missing required header.\n",
6106 return key_senderror(so, m, EINVAL);
6108 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6109 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6110 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6111 ipseclog((LOG_DEBUG,
6112 "%s: invalid message: wrong header size.\n", __func__));
6113 return key_senderror(so, m, EINVAL);
6116 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6117 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6118 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6120 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6121 (struct sockaddr *)(dst0 + 1)) != 0) {
6122 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6123 return key_senderror(so, m, EINVAL);
6125 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6127 if (proto == IPPROTO_TCP)
6128 sav = key_getsav_tcpmd5(&saidx, NULL);
6130 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6132 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6133 return key_senderror(so, m, ESRCH);
6135 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6136 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6137 __func__, ntohl(sa0->sadb_sa_spi)));
6139 return (key_senderror(so, m, ESRCH));
6146 /* map proto to satype */
6147 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6148 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6151 return key_senderror(so, m, EINVAL);
6154 /* create new sadb_msg to reply. */
6155 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6156 mhp->msg->sadb_msg_pid);
6160 return key_senderror(so, m, ENOBUFS);
6163 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6167 /* XXX make it sysctl-configurable? */
6169 key_getcomb_setlifetime(struct sadb_comb *comb)
6172 comb->sadb_comb_soft_allocations = 1;
6173 comb->sadb_comb_hard_allocations = 1;
6174 comb->sadb_comb_soft_bytes = 0;
6175 comb->sadb_comb_hard_bytes = 0;
6176 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6177 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6178 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6179 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6183 * XXX reorder combinations by preference
6184 * XXX no idea if the user wants ESP authentication or not
6186 static struct mbuf *
6187 key_getcomb_ealg(void)
6189 struct sadb_comb *comb;
6190 const struct enc_xform *algo;
6191 struct mbuf *result = NULL, *m, *n;
6195 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6198 for (i = 1; i <= SADB_EALG_MAX; i++) {
6199 algo = enc_algorithm_lookup(i);
6203 /* discard algorithms with key size smaller than system min */
6204 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6206 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6207 encmin = V_ipsec_esp_keymin;
6209 encmin = _BITS(algo->minkey);
6211 if (V_ipsec_esp_auth)
6212 m = key_getcomb_ah();
6214 IPSEC_ASSERT(l <= MLEN,
6215 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6216 MGET(m, M_NOWAIT, MT_DATA);
6221 bzero(mtod(m, caddr_t), m->m_len);
6228 for (n = m; n; n = n->m_next)
6230 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6232 for (off = 0; off < totlen; off += l) {
6233 n = m_pulldown(m, off, l, &o);
6235 /* m is already freed */
6238 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6239 bzero(comb, sizeof(*comb));
6240 key_getcomb_setlifetime(comb);
6241 comb->sadb_comb_encrypt = i;
6242 comb->sadb_comb_encrypt_minbits = encmin;
6243 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6261 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6265 *min = *max = ah->hashsize;
6266 if (ah->keysize == 0) {
6268 * Transform takes arbitrary key size but algorithm
6269 * key size is restricted. Enforce this here.
6272 case SADB_X_AALG_MD5: *min = *max = 16; break;
6273 case SADB_X_AALG_SHA: *min = *max = 20; break;
6274 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6275 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6276 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6277 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6279 DPRINTF(("%s: unknown AH algorithm %u\n",
6287 * XXX reorder combinations by preference
6289 static struct mbuf *
6292 const struct auth_hash *algo;
6293 struct sadb_comb *comb;
6295 u_int16_t minkeysize, maxkeysize;
6297 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6300 for (i = 1; i <= SADB_AALG_MAX; i++) {
6302 /* we prefer HMAC algorithms, not old algorithms */
6303 if (i != SADB_AALG_SHA1HMAC &&
6304 i != SADB_AALG_MD5HMAC &&
6305 i != SADB_X_AALG_SHA2_256 &&
6306 i != SADB_X_AALG_SHA2_384 &&
6307 i != SADB_X_AALG_SHA2_512)
6310 algo = auth_algorithm_lookup(i);
6313 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6314 /* discard algorithms with key size smaller than system min */
6315 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6319 IPSEC_ASSERT(l <= MLEN,
6320 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6321 MGET(m, M_NOWAIT, MT_DATA);
6328 M_PREPEND(m, l, M_NOWAIT);
6332 comb = mtod(m, struct sadb_comb *);
6333 bzero(comb, sizeof(*comb));
6334 key_getcomb_setlifetime(comb);
6335 comb->sadb_comb_auth = i;
6336 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6337 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6344 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6345 * XXX reorder combinations by preference
6347 static struct mbuf *
6348 key_getcomb_ipcomp()
6350 const struct comp_algo *algo;
6351 struct sadb_comb *comb;
6354 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6357 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6358 algo = comp_algorithm_lookup(i);
6363 IPSEC_ASSERT(l <= MLEN,
6364 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6365 MGET(m, M_NOWAIT, MT_DATA);
6372 M_PREPEND(m, l, M_NOWAIT);
6376 comb = mtod(m, struct sadb_comb *);
6377 bzero(comb, sizeof(*comb));
6378 key_getcomb_setlifetime(comb);
6379 comb->sadb_comb_encrypt = i;
6380 /* what should we set into sadb_comb_*_{min,max}bits? */
6387 * XXX no way to pass mode (transport/tunnel) to userland
6388 * XXX replay checking?
6389 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6391 static struct mbuf *
6392 key_getprop(const struct secasindex *saidx)
6394 struct sadb_prop *prop;
6396 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6399 switch (saidx->proto) {
6401 m = key_getcomb_ealg();
6404 m = key_getcomb_ah();
6406 case IPPROTO_IPCOMP:
6407 m = key_getcomb_ipcomp();
6415 M_PREPEND(m, l, M_NOWAIT);
6420 for (n = m; n; n = n->m_next)
6423 prop = mtod(m, struct sadb_prop *);
6424 bzero(prop, sizeof(*prop));
6425 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6426 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6427 prop->sadb_prop_replay = 32; /* XXX */
6433 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6435 * <base, SA, address(SD), (address(P)), x_policy,
6436 * (identity(SD),) (sensitivity,) proposal>
6437 * to KMD, and expect to receive
6438 * <base> with SADB_ACQUIRE if error occurred,
6440 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6441 * from KMD by PF_KEY.
6443 * XXX x_policy is outside of RFC2367 (KAME extension).
6444 * XXX sensitivity is not supported.
6445 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6446 * see comment for key_getcomb_ipcomp().
6450 * others: error number
6453 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6455 union sockaddr_union addr;
6456 struct mbuf *result, *m;
6460 uint8_t mask, satype;
6462 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6463 satype = key_proto2satype(saidx->proto);
6464 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6468 ul_proto = IPSEC_ULPROTO_ANY;
6470 /* Get seq number to check whether sending message or not. */
6471 seq = key_getacq(saidx, &error);
6475 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6483 * set sadb_address for saidx's.
6485 * Note that if sp is supplied, then we're being called from
6486 * key_allocsa_policy() and should supply port and protocol
6488 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6489 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6490 * XXXAE: it looks like we should save this info in the ACQ entry.
6492 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6493 sp->spidx.ul_proto == IPPROTO_UDP))
6494 ul_proto = sp->spidx.ul_proto;
6498 if (ul_proto != IPSEC_ULPROTO_ANY) {
6499 switch (sp->spidx.src.sa.sa_family) {
6501 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6502 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6503 mask = sp->spidx.prefs;
6507 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6508 addr.sin6.sin6_port =
6509 sp->spidx.src.sin6.sin6_port;
6510 mask = sp->spidx.prefs;
6517 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6526 if (ul_proto != IPSEC_ULPROTO_ANY) {
6527 switch (sp->spidx.dst.sa.sa_family) {
6529 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6530 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6531 mask = sp->spidx.prefd;
6535 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6536 addr.sin6.sin6_port =
6537 sp->spidx.dst.sin6.sin6_port;
6538 mask = sp->spidx.prefd;
6545 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6552 /* XXX proxy address (optional) */
6554 /* set sadb_x_policy */
6556 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6565 /* XXX identity (optional) */
6567 if (idexttype && fqdn) {
6568 /* create identity extension (FQDN) */
6569 struct sadb_ident *id;
6572 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6573 id = (struct sadb_ident *)p;
6574 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6575 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6576 id->sadb_ident_exttype = idexttype;
6577 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6578 bcopy(fqdn, id + 1, fqdnlen);
6579 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6583 /* create identity extension (USERFQDN) */
6584 struct sadb_ident *id;
6588 /* +1 for terminating-NUL */
6589 userfqdnlen = strlen(userfqdn) + 1;
6592 id = (struct sadb_ident *)p;
6593 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6594 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6595 id->sadb_ident_exttype = idexttype;
6596 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6597 /* XXX is it correct? */
6598 if (curproc && curproc->p_cred)
6599 id->sadb_ident_id = curproc->p_cred->p_ruid;
6600 if (userfqdn && userfqdnlen)
6601 bcopy(userfqdn, id + 1, userfqdnlen);
6602 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6606 /* XXX sensitivity (optional) */
6608 /* create proposal/combination extension */
6609 m = key_getprop(saidx);
6612 * spec conformant: always attach proposal/combination extension,
6613 * the problem is that we have no way to attach it for ipcomp,
6614 * due to the way sadb_comb is declared in RFC2367.
6623 * outside of spec; make proposal/combination extension optional.
6629 if ((result->m_flags & M_PKTHDR) == 0) {
6634 if (result->m_len < sizeof(struct sadb_msg)) {
6635 result = m_pullup(result, sizeof(struct sadb_msg));
6636 if (result == NULL) {
6642 result->m_pkthdr.len = 0;
6643 for (m = result; m; m = m->m_next)
6644 result->m_pkthdr.len += m->m_len;
6646 mtod(result, struct sadb_msg *)->sadb_msg_len =
6647 PFKEY_UNIT64(result->m_pkthdr.len);
6650 printf("%s: SP(%p)\n", __func__, sp));
6651 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6653 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6662 key_newacq(const struct secasindex *saidx, int *perror)
6667 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6669 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6675 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6676 acq->created = time_second;
6679 /* add to acqtree */
6681 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6682 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6683 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6684 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6691 key_getacq(const struct secasindex *saidx, int *perror)
6697 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6698 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6699 if (acq->count > V_key_blockacq_count) {
6701 * Reset counter and send message.
6702 * Also reset created time to keep ACQ for
6705 acq->created = time_second;
6710 * Increment counter and do nothing.
6711 * We send SADB_ACQUIRE message only
6712 * for each V_key_blockacq_count packet.
6725 /* allocate new entry */
6726 return (key_newacq(saidx, perror));
6730 key_acqreset(uint32_t seq)
6735 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6736 if (acq->seq == seq) {
6738 acq->created = time_second;
6748 * Mark ACQ entry as stale to remove it in key_flush_acq().
6749 * Called after successful SADB_GETSPI message.
6752 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6757 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6758 if (acq->seq == seq)
6762 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6763 ipseclog((LOG_DEBUG,
6764 "%s: Mismatched saidx for ACQ %u", __func__, seq));
6770 ipseclog((LOG_DEBUG,
6771 "%s: ACQ %u is not found.", __func__, seq));
6779 static struct secspacq *
6780 key_newspacq(struct secpolicyindex *spidx)
6782 struct secspacq *acq;
6785 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6787 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6792 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6793 acq->created = time_second;
6796 /* add to spacqtree */
6798 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6804 static struct secspacq *
6805 key_getspacq(struct secpolicyindex *spidx)
6807 struct secspacq *acq;
6810 LIST_FOREACH(acq, &V_spacqtree, chain) {
6811 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6812 /* NB: return holding spacq_lock */
6822 * SADB_ACQUIRE processing,
6823 * in first situation, is receiving
6825 * from the ikmpd, and clear sequence of its secasvar entry.
6827 * In second situation, is receiving
6828 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6829 * from a user land process, and return
6830 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6833 * m will always be freed.
6836 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6838 SAHTREE_RLOCK_TRACKER;
6839 struct sadb_address *src0, *dst0;
6840 struct secasindex saidx;
6841 struct secashead *sah;
6844 uint8_t mode, proto;
6846 IPSEC_ASSERT(so != NULL, ("null socket"));
6847 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6848 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6849 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6852 * Error message from KMd.
6853 * We assume that if error was occurred in IKEd, the length of PFKEY
6854 * message is equal to the size of sadb_msg structure.
6855 * We do not raise error even if error occurred in this function.
6857 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
6858 /* check sequence number */
6859 if (mhp->msg->sadb_msg_seq == 0 ||
6860 mhp->msg->sadb_msg_errno == 0) {
6861 ipseclog((LOG_DEBUG, "%s: must specify sequence "
6862 "number and errno.\n", __func__));
6865 * IKEd reported that error occurred.
6866 * XXXAE: what it expects from the kernel?
6867 * Probably we should send SADB_ACQUIRE again?
6868 * If so, reset ACQ's state.
6869 * XXXAE: it looks useless.
6871 key_acqreset(mhp->msg->sadb_msg_seq);
6878 * This message is from user land.
6881 /* map satype to proto */
6882 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6883 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6885 return key_senderror(so, m, EINVAL);
6888 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6889 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
6890 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
6891 ipseclog((LOG_DEBUG,
6892 "%s: invalid message: missing required header.\n",
6894 return key_senderror(so, m, EINVAL);
6896 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6897 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
6898 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
6899 ipseclog((LOG_DEBUG,
6900 "%s: invalid message: wrong header size.\n", __func__));
6901 return key_senderror(so, m, EINVAL);
6904 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
6905 mode = IPSEC_MODE_ANY;
6908 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
6909 ipseclog((LOG_DEBUG,
6910 "%s: invalid message: wrong header size.\n",
6912 return key_senderror(so, m, EINVAL);
6914 mode = ((struct sadb_x_sa2 *)
6915 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
6916 reqid = ((struct sadb_x_sa2 *)
6917 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
6920 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6921 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6923 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
6924 (struct sockaddr *)(dst0 + 1));
6926 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6927 return key_senderror(so, m, EINVAL);
6929 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
6931 /* get a SA index */
6933 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
6934 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
6939 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
6940 return key_senderror(so, m, EEXIST);
6943 error = key_acquire(&saidx, NULL);
6945 ipseclog((LOG_DEBUG,
6946 "%s: error %d returned from key_acquire()\n",
6948 return key_senderror(so, m, error);
6955 * SADB_REGISTER processing.
6956 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
6959 * from the ikmpd, and register a socket to send PF_KEY messages,
6963 * If socket is detached, must free from regnode.
6965 * m will always be freed.
6968 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6970 struct secreg *reg, *newreg = NULL;
6972 IPSEC_ASSERT(so != NULL, ("null socket"));
6973 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6974 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6975 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6977 /* check for invalid register message */
6978 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
6979 return key_senderror(so, m, EINVAL);
6981 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
6982 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
6985 /* check whether existing or not */
6987 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
6988 if (reg->so == so) {
6990 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
6992 return key_senderror(so, m, EEXIST);
6996 /* create regnode */
6997 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
6998 if (newreg == NULL) {
7000 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7001 return key_senderror(so, m, ENOBUFS);
7005 ((struct keycb *)sotorawcb(so))->kp_registered++;
7007 /* add regnode to regtree. */
7008 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7014 struct sadb_msg *newmsg;
7015 struct sadb_supported *sup;
7016 u_int len, alen, elen;
7019 struct sadb_alg *alg;
7021 /* create new sadb_msg to reply. */
7023 for (i = 1; i <= SADB_AALG_MAX; i++) {
7024 if (auth_algorithm_lookup(i))
7025 alen += sizeof(struct sadb_alg);
7028 alen += sizeof(struct sadb_supported);
7030 for (i = 1; i <= SADB_EALG_MAX; i++) {
7031 if (enc_algorithm_lookup(i))
7032 elen += sizeof(struct sadb_alg);
7035 elen += sizeof(struct sadb_supported);
7037 len = sizeof(struct sadb_msg) + alen + elen;
7040 return key_senderror(so, m, ENOBUFS);
7042 MGETHDR(n, M_NOWAIT, MT_DATA);
7044 if (!(MCLGET(n, M_NOWAIT))) {
7050 return key_senderror(so, m, ENOBUFS);
7052 n->m_pkthdr.len = n->m_len = len;
7056 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7057 newmsg = mtod(n, struct sadb_msg *);
7058 newmsg->sadb_msg_errno = 0;
7059 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7060 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7062 /* for authentication algorithm */
7064 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7065 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7066 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7067 off += PFKEY_ALIGN8(sizeof(*sup));
7069 for (i = 1; i <= SADB_AALG_MAX; i++) {
7070 const struct auth_hash *aalgo;
7071 u_int16_t minkeysize, maxkeysize;
7073 aalgo = auth_algorithm_lookup(i);
7076 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7077 alg->sadb_alg_id = i;
7078 alg->sadb_alg_ivlen = 0;
7079 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7080 alg->sadb_alg_minbits = _BITS(minkeysize);
7081 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7082 off += PFKEY_ALIGN8(sizeof(*alg));
7086 /* for encryption algorithm */
7088 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7089 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7090 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7091 off += PFKEY_ALIGN8(sizeof(*sup));
7093 for (i = 1; i <= SADB_EALG_MAX; i++) {
7094 const struct enc_xform *ealgo;
7096 ealgo = enc_algorithm_lookup(i);
7099 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7100 alg->sadb_alg_id = i;
7101 alg->sadb_alg_ivlen = ealgo->ivsize;
7102 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7103 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7104 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7108 IPSEC_ASSERT(off == len,
7109 ("length assumption failed (off %u len %u)", off, len));
7112 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7117 * free secreg entry registered.
7118 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7121 key_freereg(struct socket *so)
7126 IPSEC_ASSERT(so != NULL, ("NULL so"));
7129 * check whether existing or not.
7130 * check all type of SA, because there is a potential that
7131 * one socket is registered to multiple type of SA.
7134 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7135 LIST_FOREACH(reg, &V_regtree[i], chain) {
7136 if (reg->so == so && __LIST_CHAINED(reg)) {
7137 LIST_REMOVE(reg, chain);
7138 free(reg, M_IPSEC_SAR);
7147 * SADB_EXPIRE processing
7149 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7151 * NOTE: We send only soft lifetime extension.
7154 * others : error number
7157 key_expire(struct secasvar *sav, int hard)
7159 struct mbuf *result = NULL, *m;
7160 struct sadb_lifetime *lt;
7161 uint32_t replay_count;
7165 IPSEC_ASSERT (sav != NULL, ("null sav"));
7166 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7169 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7170 sav, hard ? "hard": "soft"));
7171 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7172 /* set msg header */
7173 satype = key_proto2satype(sav->sah->saidx.proto);
7174 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7175 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7182 /* create SA extension */
7183 m = key_setsadbsa(sav);
7190 /* create SA extension */
7192 replay_count = sav->replay ? sav->replay->count : 0;
7193 SECASVAR_UNLOCK(sav);
7195 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7196 sav->sah->saidx.reqid);
7203 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7204 m = key_setsadbxsareplay(sav->replay->wsize);
7212 /* create lifetime extension (current and soft) */
7213 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7214 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7221 bzero(mtod(m, caddr_t), len);
7222 lt = mtod(m, struct sadb_lifetime *);
7223 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7224 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7225 lt->sadb_lifetime_allocations =
7226 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7227 lt->sadb_lifetime_bytes =
7228 counter_u64_fetch(sav->lft_c_bytes);
7229 lt->sadb_lifetime_addtime = sav->created;
7230 lt->sadb_lifetime_usetime = sav->firstused;
7231 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7232 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7234 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7235 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7236 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7237 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7238 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7240 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7241 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7242 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7243 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7244 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7248 /* set sadb_address for source */
7249 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7250 &sav->sah->saidx.src.sa,
7251 FULLMASK, IPSEC_ULPROTO_ANY);
7258 /* set sadb_address for destination */
7259 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7260 &sav->sah->saidx.dst.sa,
7261 FULLMASK, IPSEC_ULPROTO_ANY);
7269 * XXX-BZ Handle NAT-T extensions here.
7270 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7271 * this information, we report only significant SA fields.
7274 if ((result->m_flags & M_PKTHDR) == 0) {
7279 if (result->m_len < sizeof(struct sadb_msg)) {
7280 result = m_pullup(result, sizeof(struct sadb_msg));
7281 if (result == NULL) {
7287 result->m_pkthdr.len = 0;
7288 for (m = result; m; m = m->m_next)
7289 result->m_pkthdr.len += m->m_len;
7291 mtod(result, struct sadb_msg *)->sadb_msg_len =
7292 PFKEY_UNIT64(result->m_pkthdr.len);
7294 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7303 key_freesah_flushed(struct secashead_queue *flushq)
7305 struct secashead *sah, *nextsah;
7306 struct secasvar *sav, *nextsav;
7308 sah = TAILQ_FIRST(flushq);
7309 while (sah != NULL) {
7310 sav = TAILQ_FIRST(&sah->savtree_larval);
7311 while (sav != NULL) {
7312 nextsav = TAILQ_NEXT(sav, chain);
7313 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7314 key_freesav(&sav); /* release last reference */
7315 key_freesah(&sah); /* release reference from SAV */
7318 sav = TAILQ_FIRST(&sah->savtree_alive);
7319 while (sav != NULL) {
7320 nextsav = TAILQ_NEXT(sav, chain);
7321 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7322 key_freesav(&sav); /* release last reference */
7323 key_freesah(&sah); /* release reference from SAV */
7326 nextsah = TAILQ_NEXT(sah, chain);
7327 key_freesah(&sah); /* release last reference */
7333 * SADB_FLUSH processing
7336 * from the ikmpd, and free all entries in secastree.
7340 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7342 * m will always be freed.
7345 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7347 struct secashead_queue flushq;
7348 struct sadb_msg *newmsg;
7349 struct secashead *sah, *nextsah;
7350 struct secasvar *sav;
7354 IPSEC_ASSERT(so != NULL, ("null socket"));
7355 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7356 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7358 /* map satype to proto */
7359 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7360 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7362 return key_senderror(so, m, EINVAL);
7365 printf("%s: proto %u\n", __func__, proto));
7367 TAILQ_INIT(&flushq);
7368 if (proto == IPSEC_PROTO_ANY) {
7369 /* no SATYPE specified, i.e. flushing all SA. */
7371 /* Move all SAHs into flushq */
7372 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7373 /* Flush all buckets in SPI hash */
7374 for (i = 0; i < V_savhash_mask + 1; i++)
7375 LIST_INIT(&V_savhashtbl[i]);
7376 /* Flush all buckets in SAHADDRHASH */
7377 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7378 LIST_INIT(&V_sahaddrhashtbl[i]);
7379 /* Mark all SAHs as unlinked */
7380 TAILQ_FOREACH(sah, &flushq, chain) {
7381 sah->state = SADB_SASTATE_DEAD;
7383 * Callout handler makes its job using
7384 * RLOCK and drain queues. In case, when this
7385 * function will be called just before it
7386 * acquires WLOCK, we need to mark SAs as
7387 * unlinked to prevent second unlink.
7389 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7390 sav->state = SADB_SASTATE_DEAD;
7392 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7393 sav->state = SADB_SASTATE_DEAD;
7399 sah = TAILQ_FIRST(&V_sahtree);
7400 while (sah != NULL) {
7401 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7402 ("DEAD SAH %p in SADB_FLUSH", sah));
7403 nextsah = TAILQ_NEXT(sah, chain);
7404 if (sah->saidx.proto != proto) {
7408 sah->state = SADB_SASTATE_DEAD;
7409 TAILQ_REMOVE(&V_sahtree, sah, chain);
7410 LIST_REMOVE(sah, addrhash);
7411 /* Unlink all SAs from SPI hash */
7412 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7413 LIST_REMOVE(sav, spihash);
7414 sav->state = SADB_SASTATE_DEAD;
7416 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7417 LIST_REMOVE(sav, spihash);
7418 sav->state = SADB_SASTATE_DEAD;
7420 /* Add SAH into flushq */
7421 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7427 key_freesah_flushed(&flushq);
7428 /* Free all queued SAs and SAHs */
7429 if (m->m_len < sizeof(struct sadb_msg) ||
7430 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7431 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7432 return key_senderror(so, m, ENOBUFS);
7438 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7439 newmsg = mtod(m, struct sadb_msg *);
7440 newmsg->sadb_msg_errno = 0;
7441 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7443 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7447 * SADB_DUMP processing
7448 * dump all entries including status of DEAD in SAD.
7451 * from the ikmpd, and dump all secasvar leaves
7456 * m will always be freed.
7459 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7461 SAHTREE_RLOCK_TRACKER;
7462 struct secashead *sah;
7463 struct secasvar *sav;
7466 uint8_t proto, satype;
7468 IPSEC_ASSERT(so != NULL, ("null socket"));
7469 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7470 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7471 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7473 /* map satype to proto */
7474 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7475 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7477 return key_senderror(so, m, EINVAL);
7480 /* count sav entries to be sent to the userland. */
7483 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7484 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7485 proto != sah->saidx.proto)
7488 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7490 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7496 return key_senderror(so, m, ENOENT);
7499 /* send this to the userland, one at a time. */
7500 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7501 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7502 proto != sah->saidx.proto)
7505 /* map proto to satype */
7506 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7508 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7509 "SAD.\n", __func__));
7510 return key_senderror(so, m, EINVAL);
7512 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7513 n = key_setdumpsa(sav, SADB_DUMP, satype,
7514 --cnt, mhp->msg->sadb_msg_pid);
7517 return key_senderror(so, m, ENOBUFS);
7519 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7521 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7522 n = key_setdumpsa(sav, SADB_DUMP, satype,
7523 --cnt, mhp->msg->sadb_msg_pid);
7526 return key_senderror(so, m, ENOBUFS);
7528 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7536 * SADB_X_PROMISC processing
7538 * m will always be freed.
7541 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7545 IPSEC_ASSERT(so != NULL, ("null socket"));
7546 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7547 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7548 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7550 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7552 if (olen < sizeof(struct sadb_msg)) {
7554 return key_senderror(so, m, EINVAL);
7559 } else if (olen == sizeof(struct sadb_msg)) {
7560 /* enable/disable promisc mode */
7563 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7564 return key_senderror(so, m, EINVAL);
7565 mhp->msg->sadb_msg_errno = 0;
7566 switch (mhp->msg->sadb_msg_satype) {
7569 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7572 return key_senderror(so, m, EINVAL);
7575 /* send the original message back to everyone */
7576 mhp->msg->sadb_msg_errno = 0;
7577 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7579 /* send packet as is */
7581 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7583 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7584 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7588 static int (*key_typesw[])(struct socket *, struct mbuf *,
7589 const struct sadb_msghdr *) = {
7590 NULL, /* SADB_RESERVED */
7591 key_getspi, /* SADB_GETSPI */
7592 key_update, /* SADB_UPDATE */
7593 key_add, /* SADB_ADD */
7594 key_delete, /* SADB_DELETE */
7595 key_get, /* SADB_GET */
7596 key_acquire2, /* SADB_ACQUIRE */
7597 key_register, /* SADB_REGISTER */
7598 NULL, /* SADB_EXPIRE */
7599 key_flush, /* SADB_FLUSH */
7600 key_dump, /* SADB_DUMP */
7601 key_promisc, /* SADB_X_PROMISC */
7602 NULL, /* SADB_X_PCHANGE */
7603 key_spdadd, /* SADB_X_SPDUPDATE */
7604 key_spdadd, /* SADB_X_SPDADD */
7605 key_spddelete, /* SADB_X_SPDDELETE */
7606 key_spdget, /* SADB_X_SPDGET */
7607 NULL, /* SADB_X_SPDACQUIRE */
7608 key_spddump, /* SADB_X_SPDDUMP */
7609 key_spdflush, /* SADB_X_SPDFLUSH */
7610 key_spdadd, /* SADB_X_SPDSETIDX */
7611 NULL, /* SADB_X_SPDEXPIRE */
7612 key_spddelete2, /* SADB_X_SPDDELETE2 */
7616 * parse sadb_msg buffer to process PFKEYv2,
7617 * and create a data to response if needed.
7618 * I think to be dealed with mbuf directly.
7620 * msgp : pointer to pointer to a received buffer pulluped.
7621 * This is rewrited to response.
7622 * so : pointer to socket.
7624 * length for buffer to send to user process.
7627 key_parse(struct mbuf *m, struct socket *so)
7629 struct sadb_msg *msg;
7630 struct sadb_msghdr mh;
7635 IPSEC_ASSERT(so != NULL, ("null socket"));
7636 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7638 if (m->m_len < sizeof(struct sadb_msg)) {
7639 m = m_pullup(m, sizeof(struct sadb_msg));
7643 msg = mtod(m, struct sadb_msg *);
7644 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7645 target = KEY_SENDUP_ONE;
7647 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7648 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7649 PFKEYSTAT_INC(out_invlen);
7654 if (msg->sadb_msg_version != PF_KEY_V2) {
7655 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7656 __func__, msg->sadb_msg_version));
7657 PFKEYSTAT_INC(out_invver);
7662 if (msg->sadb_msg_type > SADB_MAX) {
7663 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7664 __func__, msg->sadb_msg_type));
7665 PFKEYSTAT_INC(out_invmsgtype);
7670 /* for old-fashioned code - should be nuked */
7671 if (m->m_pkthdr.len > MCLBYTES) {
7678 MGETHDR(n, M_NOWAIT, MT_DATA);
7679 if (n && m->m_pkthdr.len > MHLEN) {
7680 if (!(MCLGET(n, M_NOWAIT))) {
7689 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7690 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7696 /* align the mbuf chain so that extensions are in contiguous region. */
7697 error = key_align(m, &mh);
7703 /* We use satype as scope mask for spddump */
7704 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7705 switch (msg->sadb_msg_satype) {
7706 case IPSEC_POLICYSCOPE_ANY:
7707 case IPSEC_POLICYSCOPE_GLOBAL:
7708 case IPSEC_POLICYSCOPE_IFNET:
7709 case IPSEC_POLICYSCOPE_PCB:
7712 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7713 __func__, msg->sadb_msg_type));
7714 PFKEYSTAT_INC(out_invsatype);
7719 switch (msg->sadb_msg_satype) { /* check SA type */
7720 case SADB_SATYPE_UNSPEC:
7721 switch (msg->sadb_msg_type) {
7729 ipseclog((LOG_DEBUG, "%s: must specify satype "
7730 "when msg type=%u.\n", __func__,
7731 msg->sadb_msg_type));
7732 PFKEYSTAT_INC(out_invsatype);
7737 case SADB_SATYPE_AH:
7738 case SADB_SATYPE_ESP:
7739 case SADB_X_SATYPE_IPCOMP:
7740 case SADB_X_SATYPE_TCPSIGNATURE:
7741 switch (msg->sadb_msg_type) {
7743 case SADB_X_SPDDELETE:
7745 case SADB_X_SPDFLUSH:
7746 case SADB_X_SPDSETIDX:
7747 case SADB_X_SPDUPDATE:
7748 case SADB_X_SPDDELETE2:
7749 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7750 __func__, msg->sadb_msg_type));
7751 PFKEYSTAT_INC(out_invsatype);
7756 case SADB_SATYPE_RSVP:
7757 case SADB_SATYPE_OSPFV2:
7758 case SADB_SATYPE_RIPV2:
7759 case SADB_SATYPE_MIP:
7760 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7761 __func__, msg->sadb_msg_satype));
7762 PFKEYSTAT_INC(out_invsatype);
7765 case 1: /* XXX: What does it do? */
7766 if (msg->sadb_msg_type == SADB_X_PROMISC)
7770 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7771 __func__, msg->sadb_msg_satype));
7772 PFKEYSTAT_INC(out_invsatype);
7778 /* check field of upper layer protocol and address family */
7779 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7780 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7781 struct sadb_address *src0, *dst0;
7784 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7785 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7787 /* check upper layer protocol */
7788 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7789 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7790 "mismatched.\n", __func__));
7791 PFKEYSTAT_INC(out_invaddr);
7797 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7798 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7799 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7801 PFKEYSTAT_INC(out_invaddr);
7805 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7806 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7807 ipseclog((LOG_DEBUG, "%s: address struct size "
7808 "mismatched.\n", __func__));
7809 PFKEYSTAT_INC(out_invaddr);
7814 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7816 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7817 sizeof(struct sockaddr_in)) {
7818 PFKEYSTAT_INC(out_invaddr);
7824 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7825 sizeof(struct sockaddr_in6)) {
7826 PFKEYSTAT_INC(out_invaddr);
7832 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7834 PFKEYSTAT_INC(out_invaddr);
7835 error = EAFNOSUPPORT;
7839 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7841 plen = sizeof(struct in_addr) << 3;
7844 plen = sizeof(struct in6_addr) << 3;
7847 plen = 0; /*fool gcc*/
7851 /* check max prefix length */
7852 if (src0->sadb_address_prefixlen > plen ||
7853 dst0->sadb_address_prefixlen > plen) {
7854 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7856 PFKEYSTAT_INC(out_invaddr);
7862 * prefixlen == 0 is valid because there can be a case when
7863 * all addresses are matched.
7867 if (msg->sadb_msg_type >= nitems(key_typesw) ||
7868 key_typesw[msg->sadb_msg_type] == NULL) {
7869 PFKEYSTAT_INC(out_invmsgtype);
7874 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
7877 msg->sadb_msg_errno = error;
7878 return key_sendup_mbuf(so, m, target);
7882 key_senderror(struct socket *so, struct mbuf *m, int code)
7884 struct sadb_msg *msg;
7886 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
7887 ("mbuf too small, len %u", m->m_len));
7889 msg = mtod(m, struct sadb_msg *);
7890 msg->sadb_msg_errno = code;
7891 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
7895 * set the pointer to each header into message buffer.
7896 * m will be freed on error.
7897 * XXX larger-than-MCLBYTES extension?
7900 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
7903 struct sadb_ext *ext;
7908 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7909 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7910 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
7911 ("mbuf too small, len %u", m->m_len));
7914 bzero(mhp, sizeof(*mhp));
7916 mhp->msg = mtod(m, struct sadb_msg *);
7917 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
7919 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7920 extlen = end; /*just in case extlen is not updated*/
7921 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
7922 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
7924 /* m is already freed */
7927 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
7930 switch (ext->sadb_ext_type) {
7932 case SADB_EXT_ADDRESS_SRC:
7933 case SADB_EXT_ADDRESS_DST:
7934 case SADB_EXT_ADDRESS_PROXY:
7935 case SADB_EXT_LIFETIME_CURRENT:
7936 case SADB_EXT_LIFETIME_HARD:
7937 case SADB_EXT_LIFETIME_SOFT:
7938 case SADB_EXT_KEY_AUTH:
7939 case SADB_EXT_KEY_ENCRYPT:
7940 case SADB_EXT_IDENTITY_SRC:
7941 case SADB_EXT_IDENTITY_DST:
7942 case SADB_EXT_SENSITIVITY:
7943 case SADB_EXT_PROPOSAL:
7944 case SADB_EXT_SUPPORTED_AUTH:
7945 case SADB_EXT_SUPPORTED_ENCRYPT:
7946 case SADB_EXT_SPIRANGE:
7947 case SADB_X_EXT_POLICY:
7948 case SADB_X_EXT_SA2:
7949 case SADB_X_EXT_NAT_T_TYPE:
7950 case SADB_X_EXT_NAT_T_SPORT:
7951 case SADB_X_EXT_NAT_T_DPORT:
7952 case SADB_X_EXT_NAT_T_OAI:
7953 case SADB_X_EXT_NAT_T_OAR:
7954 case SADB_X_EXT_NAT_T_FRAG:
7955 case SADB_X_EXT_SA_REPLAY:
7956 case SADB_X_EXT_NEW_ADDRESS_SRC:
7957 case SADB_X_EXT_NEW_ADDRESS_DST:
7958 /* duplicate check */
7960 * XXX Are there duplication payloads of either
7961 * KEY_AUTH or KEY_ENCRYPT ?
7963 if (mhp->ext[ext->sadb_ext_type] != NULL) {
7964 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
7965 "%u\n", __func__, ext->sadb_ext_type));
7967 PFKEYSTAT_INC(out_dupext);
7972 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
7973 __func__, ext->sadb_ext_type));
7975 PFKEYSTAT_INC(out_invexttype);
7979 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
7981 if (key_validate_ext(ext, extlen)) {
7983 PFKEYSTAT_INC(out_invlen);
7987 n = m_pulldown(m, off, extlen, &toff);
7989 /* m is already freed */
7992 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
7994 mhp->ext[ext->sadb_ext_type] = ext;
7995 mhp->extoff[ext->sadb_ext_type] = off;
7996 mhp->extlen[ext->sadb_ext_type] = extlen;
8001 PFKEYSTAT_INC(out_invlen);
8009 key_validate_ext(const struct sadb_ext *ext, int len)
8011 const struct sockaddr *sa;
8012 enum { NONE, ADDR } checktype = NONE;
8014 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8016 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8019 /* if it does not match minimum/maximum length, bail */
8020 if (ext->sadb_ext_type >= nitems(minsize) ||
8021 ext->sadb_ext_type >= nitems(maxsize))
8023 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8025 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8028 /* more checks based on sadb_ext_type XXX need more */
8029 switch (ext->sadb_ext_type) {
8030 case SADB_EXT_ADDRESS_SRC:
8031 case SADB_EXT_ADDRESS_DST:
8032 case SADB_EXT_ADDRESS_PROXY:
8033 case SADB_X_EXT_NAT_T_OAI:
8034 case SADB_X_EXT_NAT_T_OAR:
8035 case SADB_X_EXT_NEW_ADDRESS_SRC:
8036 case SADB_X_EXT_NEW_ADDRESS_DST:
8037 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8040 case SADB_EXT_IDENTITY_SRC:
8041 case SADB_EXT_IDENTITY_DST:
8042 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8043 SADB_X_IDENTTYPE_ADDR) {
8044 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8054 switch (checktype) {
8058 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8059 if (len < baselen + sal)
8061 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8074 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8075 TAILQ_INIT(&V_sptree[i]);
8076 TAILQ_INIT(&V_sptree_ifnet[i]);
8079 V_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8080 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8081 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8083 TAILQ_INIT(&V_sahtree);
8084 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8085 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8086 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8087 &V_sahaddrhash_mask);
8088 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8089 &V_acqaddrhash_mask);
8090 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8091 &V_acqseqhash_mask);
8093 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8094 LIST_INIT(&V_regtree[i]);
8096 LIST_INIT(&V_acqtree);
8097 LIST_INIT(&V_spacqtree);
8099 if (!IS_DEFAULT_VNET(curvnet))
8104 REGTREE_LOCK_INIT();
8105 SAHTREE_LOCK_INIT();
8109 #ifndef IPSEC_DEBUG2
8110 callout_init(&key_timer, 1);
8111 callout_reset(&key_timer, hz, key_timehandler, NULL);
8112 #endif /*IPSEC_DEBUG2*/
8114 /* initialize key statistics */
8115 keystat.getspi_count = 1;
8118 printf("IPsec: Initialized Security Association Processing.\n");
8125 struct secashead_queue sahdrainq;
8126 struct secpolicy_queue drainq;
8127 struct secpolicy *sp, *nextsp;
8128 struct secacq *acq, *nextacq;
8129 struct secspacq *spacq, *nextspacq;
8130 struct secashead *sah;
8131 struct secasvar *sav;
8136 * XXX: can we just call free() for each object without
8137 * walking through safe way with releasing references?
8139 TAILQ_INIT(&drainq);
8141 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8142 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8143 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8145 for (i = 0; i < V_sphash_mask + 1; i++)
8146 LIST_INIT(&V_sphashtbl[i]);
8149 sp = TAILQ_FIRST(&drainq);
8150 while (sp != NULL) {
8151 nextsp = TAILQ_NEXT(sp, chain);
8156 TAILQ_INIT(&sahdrainq);
8158 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8159 for (i = 0; i < V_savhash_mask + 1; i++)
8160 LIST_INIT(&V_savhashtbl[i]);
8161 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8162 LIST_INIT(&V_sahaddrhashtbl[i]);
8163 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8164 sah->state = SADB_SASTATE_DEAD;
8165 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8166 sav->state = SADB_SASTATE_DEAD;
8168 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8169 sav->state = SADB_SASTATE_DEAD;
8174 key_freesah_flushed(&sahdrainq);
8175 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8176 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8177 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8180 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8181 LIST_FOREACH(reg, &V_regtree[i], chain) {
8182 if (__LIST_CHAINED(reg)) {
8183 LIST_REMOVE(reg, chain);
8184 free(reg, M_IPSEC_SAR);
8192 acq = LIST_FIRST(&V_acqtree);
8193 while (acq != NULL) {
8194 nextacq = LIST_NEXT(acq, chain);
8195 LIST_REMOVE(acq, chain);
8196 free(acq, M_IPSEC_SAQ);
8199 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8200 LIST_INIT(&V_acqaddrhashtbl[i]);
8201 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8202 LIST_INIT(&V_acqseqhashtbl[i]);
8206 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8207 spacq = nextspacq) {
8208 nextspacq = LIST_NEXT(spacq, chain);
8209 if (__LIST_CHAINED(spacq)) {
8210 LIST_REMOVE(spacq, chain);
8211 free(spacq, M_IPSEC_SAQ);
8215 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8216 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8217 uma_zdestroy(V_key_lft_zone);
8219 if (!IS_DEFAULT_VNET(curvnet))
8221 #ifndef IPSEC_DEBUG2
8222 callout_drain(&key_timer);
8224 XFORMS_LOCK_DESTROY();
8225 SPTREE_LOCK_DESTROY();
8226 REGTREE_LOCK_DESTROY();
8227 SAHTREE_LOCK_DESTROY();
8229 SPACQ_LOCK_DESTROY();
8233 /* record data transfer on SA, and update timestamps */
8235 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8237 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8238 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8241 * XXX Currently, there is a difference of bytes size
8242 * between inbound and outbound processing.
8244 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8247 * We use the number of packets as the unit of
8248 * allocations. We increment the variable
8249 * whenever {esp,ah}_{in,out}put is called.
8251 counter_u64_add(sav->lft_c_allocations, 1);
8254 * NOTE: We record CURRENT usetime by using wall clock,
8255 * in seconds. HARD and SOFT lifetime are measured by the time
8256 * difference (again in seconds) from usetime.
8260 * -----+-----+--------+---> t
8261 * <--------------> HARD
8264 if (sav->firstused == 0)
8265 sav->firstused = time_second;
8269 * Take one of the kernel's security keys and convert it into a PF_KEY
8270 * structure within an mbuf, suitable for sending up to a waiting
8271 * application in user land.
8274 * src: A pointer to a kernel security key.
8275 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8277 * a valid mbuf or NULL indicating an error
8281 static struct mbuf *
8282 key_setkey(struct seckey *src, uint16_t exttype)
8291 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8292 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8297 p = mtod(m, struct sadb_key *);
8299 p->sadb_key_len = PFKEY_UNIT64(len);
8300 p->sadb_key_exttype = exttype;
8301 p->sadb_key_bits = src->bits;
8302 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8308 * Take one of the kernel's lifetime data structures and convert it
8309 * into a PF_KEY structure within an mbuf, suitable for sending up to
8310 * a waiting application in user land.
8313 * src: A pointer to a kernel lifetime structure.
8314 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8315 * data structures for more information.
8317 * a valid mbuf or NULL indicating an error
8321 static struct mbuf *
8322 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8324 struct mbuf *m = NULL;
8325 struct sadb_lifetime *p;
8326 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8331 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8336 p = mtod(m, struct sadb_lifetime *);
8339 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8340 p->sadb_lifetime_exttype = exttype;
8341 p->sadb_lifetime_allocations = src->allocations;
8342 p->sadb_lifetime_bytes = src->bytes;
8343 p->sadb_lifetime_addtime = src->addtime;
8344 p->sadb_lifetime_usetime = src->usetime;
8350 const struct enc_xform *
8351 enc_algorithm_lookup(int alg)
8355 for (i = 0; i < nitems(supported_ealgs); i++)
8356 if (alg == supported_ealgs[i].sadb_alg)
8357 return (supported_ealgs[i].xform);
8361 const struct auth_hash *
8362 auth_algorithm_lookup(int alg)
8366 for (i = 0; i < nitems(supported_aalgs); i++)
8367 if (alg == supported_aalgs[i].sadb_alg)
8368 return (supported_aalgs[i].xform);
8372 const struct comp_algo *
8373 comp_algorithm_lookup(int alg)
8377 for (i = 0; i < nitems(supported_calgs); i++)
8378 if (alg == supported_calgs[i].sadb_alg)
8379 return (supported_calgs[i].xform);
8384 * Register a transform.
8387 xform_register(struct xformsw* xsp)
8389 struct xformsw *entry;
8392 LIST_FOREACH(entry, &xforms, chain) {
8393 if (entry->xf_type == xsp->xf_type) {
8398 LIST_INSERT_HEAD(&xforms, xsp, chain);
8404 xform_attach(void *data)
8406 struct xformsw *xsp = (struct xformsw *)data;
8408 if (xform_register(xsp) != 0)
8409 printf("%s: failed to register %s xform\n", __func__,
8414 xform_detach(void *data)
8416 struct xformsw *xsp = (struct xformsw *)data;
8419 LIST_REMOVE(xsp, chain);
8422 /* Delete all SAs related to this xform. */
8423 key_delete_xform(xsp);
8427 * Initialize transform support in an sav.
8430 xform_init(struct secasvar *sav, u_short xftype)
8432 struct xformsw *entry;
8435 IPSEC_ASSERT(sav->tdb_xform == NULL,
8436 ("tdb_xform is already initialized"));
8440 LIST_FOREACH(entry, &xforms, chain) {
8441 if (entry->xf_type == xftype) {
8442 ret = (*entry->xf_init)(sav, entry);