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)
104 #define UINT32_80PCT 0xcccccccc
106 * Note on SA reference counting:
107 * - SAs that are not in DEAD state will have (total external reference + 1)
108 * following value in reference count field. they cannot be freed and are
109 * referenced from SA header.
110 * - SAs that are in DEAD state will have (total external reference)
111 * in reference count field. they are ready to be freed. reference from
112 * SA header will be removed in key_delsav(), when the reference count
113 * field hits 0 (= no external reference other than from SA header.
116 VNET_DEFINE(u_int32_t, key_debug_level) = 0;
117 VNET_DEFINE_STATIC(u_int, key_spi_trycnt) = 1000;
118 VNET_DEFINE_STATIC(u_int32_t, key_spi_minval) = 0x100;
119 VNET_DEFINE_STATIC(u_int32_t, key_spi_maxval) = 0x0fffffff; /* XXX */
120 VNET_DEFINE_STATIC(u_int32_t, policy_id) = 0;
121 /*interval to initialize randseed,1(m)*/
122 VNET_DEFINE_STATIC(u_int, key_int_random) = 60;
123 /* interval to expire acquiring, 30(s)*/
124 VNET_DEFINE_STATIC(u_int, key_larval_lifetime) = 30;
125 /* counter for blocking SADB_ACQUIRE.*/
126 VNET_DEFINE_STATIC(int, key_blockacq_count) = 10;
127 /* lifetime for blocking SADB_ACQUIRE.*/
128 VNET_DEFINE_STATIC(int, key_blockacq_lifetime) = 20;
129 /* preferred old sa rather than new sa.*/
130 VNET_DEFINE_STATIC(int, key_preferred_oldsa) = 1;
131 #define V_key_spi_trycnt VNET(key_spi_trycnt)
132 #define V_key_spi_minval VNET(key_spi_minval)
133 #define V_key_spi_maxval VNET(key_spi_maxval)
134 #define V_policy_id VNET(policy_id)
135 #define V_key_int_random VNET(key_int_random)
136 #define V_key_larval_lifetime VNET(key_larval_lifetime)
137 #define V_key_blockacq_count VNET(key_blockacq_count)
138 #define V_key_blockacq_lifetime VNET(key_blockacq_lifetime)
139 #define V_key_preferred_oldsa VNET(key_preferred_oldsa)
141 VNET_DEFINE_STATIC(u_int32_t, acq_seq) = 0;
142 #define V_acq_seq VNET(acq_seq)
144 VNET_DEFINE_STATIC(uint32_t, sp_genid) = 0;
145 #define V_sp_genid VNET(sp_genid)
148 TAILQ_HEAD(secpolicy_queue, secpolicy);
149 LIST_HEAD(secpolicy_list, secpolicy);
150 VNET_DEFINE_STATIC(struct secpolicy_queue, sptree[IPSEC_DIR_MAX]);
151 VNET_DEFINE_STATIC(struct secpolicy_queue, sptree_ifnet[IPSEC_DIR_MAX]);
152 static struct rmlock sptree_lock;
153 #define V_sptree VNET(sptree)
154 #define V_sptree_ifnet VNET(sptree_ifnet)
155 #define SPTREE_LOCK_INIT() rm_init(&sptree_lock, "sptree")
156 #define SPTREE_LOCK_DESTROY() rm_destroy(&sptree_lock)
157 #define SPTREE_RLOCK_TRACKER struct rm_priotracker sptree_tracker
158 #define SPTREE_RLOCK() rm_rlock(&sptree_lock, &sptree_tracker)
159 #define SPTREE_RUNLOCK() rm_runlock(&sptree_lock, &sptree_tracker)
160 #define SPTREE_RLOCK_ASSERT() rm_assert(&sptree_lock, RA_RLOCKED)
161 #define SPTREE_WLOCK() rm_wlock(&sptree_lock)
162 #define SPTREE_WUNLOCK() rm_wunlock(&sptree_lock)
163 #define SPTREE_WLOCK_ASSERT() rm_assert(&sptree_lock, RA_WLOCKED)
164 #define SPTREE_UNLOCK_ASSERT() rm_assert(&sptree_lock, RA_UNLOCKED)
166 /* Hash table for lookup SP using unique id */
167 VNET_DEFINE_STATIC(struct secpolicy_list *, sphashtbl);
168 VNET_DEFINE_STATIC(u_long, sphash_mask);
169 #define V_sphashtbl VNET(sphashtbl)
170 #define V_sphash_mask VNET(sphash_mask)
172 #define SPHASH_NHASH_LOG2 7
173 #define SPHASH_NHASH (1 << SPHASH_NHASH_LOG2)
174 #define SPHASH_HASHVAL(id) (key_u32hash(id) & V_sphash_mask)
175 #define SPHASH_HASH(id) &V_sphashtbl[SPHASH_HASHVAL(id)]
178 struct spdcache_entry {
179 struct secpolicyindex spidx; /* secpolicyindex */
180 struct secpolicy *sp; /* cached policy to be used */
182 LIST_ENTRY(spdcache_entry) chain;
184 LIST_HEAD(spdcache_entry_list, spdcache_entry);
186 #define SPDCACHE_MAX_ENTRIES_PER_HASH 8
188 VNET_DEFINE_STATIC(u_int, key_spdcache_maxentries) = 0;
189 #define V_key_spdcache_maxentries VNET(key_spdcache_maxentries)
190 VNET_DEFINE_STATIC(u_int, key_spdcache_threshold) = 32;
191 #define V_key_spdcache_threshold VNET(key_spdcache_threshold)
192 VNET_DEFINE_STATIC(unsigned long, spd_size) = 0;
193 #define V_spd_size VNET(spd_size)
195 #define SPDCACHE_ENABLED() (V_key_spdcache_maxentries != 0)
196 #define SPDCACHE_ACTIVE() \
197 (SPDCACHE_ENABLED() && V_spd_size >= V_key_spdcache_threshold)
199 VNET_DEFINE_STATIC(struct spdcache_entry_list *, spdcachehashtbl);
200 VNET_DEFINE_STATIC(u_long, spdcachehash_mask);
201 #define V_spdcachehashtbl VNET(spdcachehashtbl)
202 #define V_spdcachehash_mask VNET(spdcachehash_mask)
204 #define SPDCACHE_HASHVAL(idx) \
205 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->ul_proto) & \
208 /* Each cache line is protected by a mutex */
209 VNET_DEFINE_STATIC(struct mtx *, spdcache_lock);
210 #define V_spdcache_lock VNET(spdcache_lock)
212 #define SPDCACHE_LOCK_INIT(a) \
213 mtx_init(&V_spdcache_lock[a], "spdcache", \
214 "fast ipsec SPD cache", MTX_DEF|MTX_DUPOK)
215 #define SPDCACHE_LOCK_DESTROY(a) mtx_destroy(&V_spdcache_lock[a])
216 #define SPDCACHE_LOCK(a) mtx_lock(&V_spdcache_lock[a]);
217 #define SPDCACHE_UNLOCK(a) mtx_unlock(&V_spdcache_lock[a]);
220 TAILQ_HEAD(secashead_queue, secashead);
221 LIST_HEAD(secashead_list, secashead);
222 VNET_DEFINE_STATIC(struct secashead_queue, sahtree);
223 static struct rmlock sahtree_lock;
224 #define V_sahtree VNET(sahtree)
225 #define SAHTREE_LOCK_INIT() rm_init(&sahtree_lock, "sahtree")
226 #define SAHTREE_LOCK_DESTROY() rm_destroy(&sahtree_lock)
227 #define SAHTREE_RLOCK_TRACKER struct rm_priotracker sahtree_tracker
228 #define SAHTREE_RLOCK() rm_rlock(&sahtree_lock, &sahtree_tracker)
229 #define SAHTREE_RUNLOCK() rm_runlock(&sahtree_lock, &sahtree_tracker)
230 #define SAHTREE_RLOCK_ASSERT() rm_assert(&sahtree_lock, RA_RLOCKED)
231 #define SAHTREE_WLOCK() rm_wlock(&sahtree_lock)
232 #define SAHTREE_WUNLOCK() rm_wunlock(&sahtree_lock)
233 #define SAHTREE_WLOCK_ASSERT() rm_assert(&sahtree_lock, RA_WLOCKED)
234 #define SAHTREE_UNLOCK_ASSERT() rm_assert(&sahtree_lock, RA_UNLOCKED)
236 /* Hash table for lookup in SAD using SA addresses */
237 VNET_DEFINE_STATIC(struct secashead_list *, sahaddrhashtbl);
238 VNET_DEFINE_STATIC(u_long, sahaddrhash_mask);
239 #define V_sahaddrhashtbl VNET(sahaddrhashtbl)
240 #define V_sahaddrhash_mask VNET(sahaddrhash_mask)
242 #define SAHHASH_NHASH_LOG2 7
243 #define SAHHASH_NHASH (1 << SAHHASH_NHASH_LOG2)
244 #define SAHADDRHASH_HASHVAL(idx) \
245 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->proto) & \
247 #define SAHADDRHASH_HASH(saidx) \
248 &V_sahaddrhashtbl[SAHADDRHASH_HASHVAL(saidx)]
250 /* Hash table for lookup in SAD using SPI */
251 LIST_HEAD(secasvar_list, secasvar);
252 VNET_DEFINE_STATIC(struct secasvar_list *, savhashtbl);
253 VNET_DEFINE_STATIC(u_long, savhash_mask);
254 #define V_savhashtbl VNET(savhashtbl)
255 #define V_savhash_mask VNET(savhash_mask)
256 #define SAVHASH_NHASH_LOG2 7
257 #define SAVHASH_NHASH (1 << SAVHASH_NHASH_LOG2)
258 #define SAVHASH_HASHVAL(spi) (key_u32hash(spi) & V_savhash_mask)
259 #define SAVHASH_HASH(spi) &V_savhashtbl[SAVHASH_HASHVAL(spi)]
262 key_addrprotohash(const union sockaddr_union *src,
263 const union sockaddr_union *dst, const uint8_t *proto)
267 hval = fnv_32_buf(proto, sizeof(*proto),
269 switch (dst->sa.sa_family) {
272 hval = fnv_32_buf(&src->sin.sin_addr,
273 sizeof(in_addr_t), hval);
274 hval = fnv_32_buf(&dst->sin.sin_addr,
275 sizeof(in_addr_t), hval);
280 hval = fnv_32_buf(&src->sin6.sin6_addr,
281 sizeof(struct in6_addr), hval);
282 hval = fnv_32_buf(&dst->sin6.sin6_addr,
283 sizeof(struct in6_addr), hval);
288 ipseclog((LOG_DEBUG, "%s: unknown address family %d\n",
289 __func__, dst->sa.sa_family));
295 key_u32hash(uint32_t val)
298 return (fnv_32_buf(&val, sizeof(val), FNV1_32_INIT));
302 VNET_DEFINE_STATIC(LIST_HEAD(_regtree, secreg), regtree[SADB_SATYPE_MAX + 1]);
303 #define V_regtree VNET(regtree)
304 static struct mtx regtree_lock;
305 #define REGTREE_LOCK_INIT() \
306 mtx_init(®tree_lock, "regtree", "fast ipsec regtree", MTX_DEF)
307 #define REGTREE_LOCK_DESTROY() mtx_destroy(®tree_lock)
308 #define REGTREE_LOCK() mtx_lock(®tree_lock)
309 #define REGTREE_UNLOCK() mtx_unlock(®tree_lock)
310 #define REGTREE_LOCK_ASSERT() mtx_assert(®tree_lock, MA_OWNED)
313 LIST_HEAD(secacq_list, secacq);
314 VNET_DEFINE_STATIC(struct secacq_list, acqtree);
315 #define V_acqtree VNET(acqtree)
316 static struct mtx acq_lock;
317 #define ACQ_LOCK_INIT() \
318 mtx_init(&acq_lock, "acqtree", "ipsec SA acquiring list", MTX_DEF)
319 #define ACQ_LOCK_DESTROY() mtx_destroy(&acq_lock)
320 #define ACQ_LOCK() mtx_lock(&acq_lock)
321 #define ACQ_UNLOCK() mtx_unlock(&acq_lock)
322 #define ACQ_LOCK_ASSERT() mtx_assert(&acq_lock, MA_OWNED)
324 /* Hash table for lookup in ACQ list using SA addresses */
325 VNET_DEFINE_STATIC(struct secacq_list *, acqaddrhashtbl);
326 VNET_DEFINE_STATIC(u_long, acqaddrhash_mask);
327 #define V_acqaddrhashtbl VNET(acqaddrhashtbl)
328 #define V_acqaddrhash_mask VNET(acqaddrhash_mask)
330 /* Hash table for lookup in ACQ list using SEQ number */
331 VNET_DEFINE_STATIC(struct secacq_list *, acqseqhashtbl);
332 VNET_DEFINE_STATIC(u_long, acqseqhash_mask);
333 #define V_acqseqhashtbl VNET(acqseqhashtbl)
334 #define V_acqseqhash_mask VNET(acqseqhash_mask)
336 #define ACQHASH_NHASH_LOG2 7
337 #define ACQHASH_NHASH (1 << ACQHASH_NHASH_LOG2)
338 #define ACQADDRHASH_HASHVAL(idx) \
339 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->proto) & \
341 #define ACQSEQHASH_HASHVAL(seq) \
342 (key_u32hash(seq) & V_acqseqhash_mask)
343 #define ACQADDRHASH_HASH(saidx) \
344 &V_acqaddrhashtbl[ACQADDRHASH_HASHVAL(saidx)]
345 #define ACQSEQHASH_HASH(seq) \
346 &V_acqseqhashtbl[ACQSEQHASH_HASHVAL(seq)]
347 /* SP acquiring list */
348 VNET_DEFINE_STATIC(LIST_HEAD(_spacqtree, secspacq), spacqtree);
349 #define V_spacqtree VNET(spacqtree)
350 static struct mtx spacq_lock;
351 #define SPACQ_LOCK_INIT() \
352 mtx_init(&spacq_lock, "spacqtree", \
353 "fast ipsec security policy acquire list", MTX_DEF)
354 #define SPACQ_LOCK_DESTROY() mtx_destroy(&spacq_lock)
355 #define SPACQ_LOCK() mtx_lock(&spacq_lock)
356 #define SPACQ_UNLOCK() mtx_unlock(&spacq_lock)
357 #define SPACQ_LOCK_ASSERT() mtx_assert(&spacq_lock, MA_OWNED)
359 static const int minsize[] = {
360 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
361 sizeof(struct sadb_sa), /* SADB_EXT_SA */
362 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
363 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
364 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
365 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_SRC */
366 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_DST */
367 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_PROXY */
368 sizeof(struct sadb_key), /* SADB_EXT_KEY_AUTH */
369 sizeof(struct sadb_key), /* SADB_EXT_KEY_ENCRYPT */
370 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_SRC */
371 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_DST */
372 sizeof(struct sadb_sens), /* SADB_EXT_SENSITIVITY */
373 sizeof(struct sadb_prop), /* SADB_EXT_PROPOSAL */
374 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_AUTH */
375 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_ENCRYPT */
376 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
377 0, /* SADB_X_EXT_KMPRIVATE */
378 sizeof(struct sadb_x_policy), /* SADB_X_EXT_POLICY */
379 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
380 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
381 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
382 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
383 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAI */
384 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAR */
385 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
386 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
387 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_SRC */
388 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_DST */
390 _Static_assert(sizeof(minsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
392 static const int maxsize[] = {
393 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
394 sizeof(struct sadb_sa), /* SADB_EXT_SA */
395 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
396 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
397 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
398 0, /* SADB_EXT_ADDRESS_SRC */
399 0, /* SADB_EXT_ADDRESS_DST */
400 0, /* SADB_EXT_ADDRESS_PROXY */
401 0, /* SADB_EXT_KEY_AUTH */
402 0, /* SADB_EXT_KEY_ENCRYPT */
403 0, /* SADB_EXT_IDENTITY_SRC */
404 0, /* SADB_EXT_IDENTITY_DST */
405 0, /* SADB_EXT_SENSITIVITY */
406 0, /* SADB_EXT_PROPOSAL */
407 0, /* SADB_EXT_SUPPORTED_AUTH */
408 0, /* SADB_EXT_SUPPORTED_ENCRYPT */
409 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
410 0, /* SADB_X_EXT_KMPRIVATE */
411 0, /* SADB_X_EXT_POLICY */
412 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
413 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
414 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
415 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
416 0, /* SADB_X_EXT_NAT_T_OAI */
417 0, /* SADB_X_EXT_NAT_T_OAR */
418 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
419 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
420 0, /* SADB_X_EXT_NEW_ADDRESS_SRC */
421 0, /* SADB_X_EXT_NEW_ADDRESS_DST */
423 _Static_assert(sizeof(maxsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
426 * Internal values for SA flags:
427 * SADB_X_EXT_F_CLONED means that SA was cloned by key_updateaddresses,
428 * thus we will not free the most of SA content in key_delsav().
430 #define SADB_X_EXT_F_CLONED 0x80000000
432 #define SADB_CHECKLEN(_mhp, _ext) \
433 ((_mhp)->extlen[(_ext)] < minsize[(_ext)] || (maxsize[(_ext)] != 0 && \
434 ((_mhp)->extlen[(_ext)] > maxsize[(_ext)])))
435 #define SADB_CHECKHDR(_mhp, _ext) ((_mhp)->ext[(_ext)] == NULL)
437 VNET_DEFINE_STATIC(int, ipsec_esp_keymin) = 256;
438 VNET_DEFINE_STATIC(int, ipsec_esp_auth) = 0;
439 VNET_DEFINE_STATIC(int, ipsec_ah_keymin) = 128;
441 #define V_ipsec_esp_keymin VNET(ipsec_esp_keymin)
442 #define V_ipsec_esp_auth VNET(ipsec_esp_auth)
443 #define V_ipsec_ah_keymin VNET(ipsec_ah_keymin)
446 VNET_DEFINE(int, ipsec_debug) = 1;
448 VNET_DEFINE(int, ipsec_debug) = 0;
452 SYSCTL_DECL(_net_inet_ipsec);
453 SYSCTL_INT(_net_inet_ipsec, IPSECCTL_DEBUG, debug,
454 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
455 "Enable IPsec debugging output when set.");
458 SYSCTL_DECL(_net_inet6_ipsec6);
459 SYSCTL_INT(_net_inet6_ipsec6, IPSECCTL_DEBUG, debug,
460 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
461 "Enable IPsec debugging output when set.");
464 SYSCTL_DECL(_net_key);
465 SYSCTL_INT(_net_key, KEYCTL_DEBUG_LEVEL, debug,
466 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_debug_level), 0, "");
468 /* max count of trial for the decision of spi value */
469 SYSCTL_INT(_net_key, KEYCTL_SPI_TRY, spi_trycnt,
470 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_trycnt), 0, "");
472 /* minimum spi value to allocate automatically. */
473 SYSCTL_INT(_net_key, KEYCTL_SPI_MIN_VALUE, spi_minval,
474 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_minval), 0, "");
476 /* maximun spi value to allocate automatically. */
477 SYSCTL_INT(_net_key, KEYCTL_SPI_MAX_VALUE, spi_maxval,
478 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_maxval), 0, "");
480 /* interval to initialize randseed */
481 SYSCTL_INT(_net_key, KEYCTL_RANDOM_INT, int_random,
482 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_int_random), 0, "");
484 /* lifetime for larval SA */
485 SYSCTL_INT(_net_key, KEYCTL_LARVAL_LIFETIME, larval_lifetime,
486 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_larval_lifetime), 0, "");
488 /* counter for blocking to send SADB_ACQUIRE to IKEd */
489 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_COUNT, blockacq_count,
490 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_count), 0, "");
492 /* lifetime for blocking to send SADB_ACQUIRE to IKEd */
493 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_LIFETIME, blockacq_lifetime,
494 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_lifetime), 0, "");
497 SYSCTL_INT(_net_key, KEYCTL_ESP_AUTH, esp_auth,
498 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_auth), 0, "");
500 /* minimum ESP key length */
501 SYSCTL_INT(_net_key, KEYCTL_ESP_KEYMIN, esp_keymin,
502 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_keymin), 0, "");
504 /* minimum AH key length */
505 SYSCTL_INT(_net_key, KEYCTL_AH_KEYMIN, ah_keymin,
506 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_ah_keymin), 0, "");
508 /* perfered old SA rather than new SA */
509 SYSCTL_INT(_net_key, KEYCTL_PREFERED_OLDSA, preferred_oldsa,
510 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_preferred_oldsa), 0, "");
512 static SYSCTL_NODE(_net_key, OID_AUTO, spdcache,
513 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
516 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, maxentries,
517 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_maxentries), 0,
518 "Maximum number of entries in the SPD cache"
519 " (power of 2, 0 to disable)");
521 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, threshold,
522 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_threshold), 0,
523 "Number of SPs that make the SPD cache active");
525 #define __LIST_CHAINED(elm) \
526 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
528 MALLOC_DEFINE(M_IPSEC_SA, "secasvar", "ipsec security association");
529 MALLOC_DEFINE(M_IPSEC_SAH, "sahead", "ipsec sa head");
530 MALLOC_DEFINE(M_IPSEC_SP, "ipsecpolicy", "ipsec security policy");
531 MALLOC_DEFINE(M_IPSEC_SR, "ipsecrequest", "ipsec security request");
532 MALLOC_DEFINE(M_IPSEC_MISC, "ipsec-misc", "ipsec miscellaneous");
533 MALLOC_DEFINE(M_IPSEC_SAQ, "ipsec-saq", "ipsec sa acquire");
534 MALLOC_DEFINE(M_IPSEC_SAR, "ipsec-reg", "ipsec sa acquire");
535 MALLOC_DEFINE(M_IPSEC_SPDCACHE, "ipsec-spdcache", "ipsec SPD cache");
537 static uma_zone_t __read_mostly ipsec_key_lft_zone;
540 * set parameters into secpolicyindex buffer.
541 * Must allocate secpolicyindex buffer passed to this function.
543 #define KEY_SETSECSPIDX(_dir, s, d, ps, pd, ulp, idx) \
545 bzero((idx), sizeof(struct secpolicyindex)); \
546 (idx)->dir = (_dir); \
547 (idx)->prefs = (ps); \
548 (idx)->prefd = (pd); \
549 (idx)->ul_proto = (ulp); \
550 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
551 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
555 * set parameters into secasindex buffer.
556 * Must allocate secasindex buffer before calling this function.
558 #define KEY_SETSECASIDX(p, m, r, s, d, idx) \
560 bzero((idx), sizeof(struct secasindex)); \
561 (idx)->proto = (p); \
563 (idx)->reqid = (r); \
564 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
565 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
566 key_porttosaddr(&(idx)->src.sa, 0); \
567 key_porttosaddr(&(idx)->dst.sa, 0); \
572 u_long getspi_count; /* the avarage of count to try to get new SPI */
576 struct sadb_msg *msg;
577 struct sadb_ext *ext[SADB_EXT_MAX + 1];
578 int extoff[SADB_EXT_MAX + 1];
579 int extlen[SADB_EXT_MAX + 1];
582 static struct supported_ealgs {
584 const struct enc_xform *xform;
585 } supported_ealgs[] = {
586 { SADB_X_EALG_AES, &enc_xform_rijndael128 },
587 { SADB_EALG_NULL, &enc_xform_null },
588 { SADB_X_EALG_AESCTR, &enc_xform_aes_icm },
589 { SADB_X_EALG_AESGCM16, &enc_xform_aes_nist_gcm },
590 { SADB_X_EALG_AESGMAC, &enc_xform_aes_nist_gmac },
593 static struct supported_aalgs {
595 const struct auth_hash *xform;
596 } supported_aalgs[] = {
597 { SADB_X_AALG_NULL, &auth_hash_null },
598 { SADB_AALG_SHA1HMAC, &auth_hash_hmac_sha1 },
599 { SADB_X_AALG_SHA2_256, &auth_hash_hmac_sha2_256 },
600 { SADB_X_AALG_SHA2_384, &auth_hash_hmac_sha2_384 },
601 { SADB_X_AALG_SHA2_512, &auth_hash_hmac_sha2_512 },
602 { SADB_X_AALG_AES128GMAC, &auth_hash_nist_gmac_aes_128 },
603 { SADB_X_AALG_AES192GMAC, &auth_hash_nist_gmac_aes_192 },
604 { SADB_X_AALG_AES256GMAC, &auth_hash_nist_gmac_aes_256 },
607 static struct supported_calgs {
609 const struct comp_algo *xform;
610 } supported_calgs[] = {
611 { SADB_X_CALG_DEFLATE, &comp_algo_deflate },
615 static struct callout key_timer;
618 static void key_unlink(struct secpolicy *);
619 static void key_detach(struct secpolicy *);
620 static struct secpolicy *key_do_allocsp(struct secpolicyindex *spidx, u_int dir);
621 static struct secpolicy *key_getsp(struct secpolicyindex *);
622 static struct secpolicy *key_getspbyid(u_int32_t);
623 static struct mbuf *key_gather_mbuf(struct mbuf *,
624 const struct sadb_msghdr *, int, int, ...);
625 static int key_spdadd(struct socket *, struct mbuf *,
626 const struct sadb_msghdr *);
627 static uint32_t key_getnewspid(void);
628 static int key_spddelete(struct socket *, struct mbuf *,
629 const struct sadb_msghdr *);
630 static int key_spddelete2(struct socket *, struct mbuf *,
631 const struct sadb_msghdr *);
632 static int key_spdget(struct socket *, struct mbuf *,
633 const struct sadb_msghdr *);
634 static int key_spdflush(struct socket *, struct mbuf *,
635 const struct sadb_msghdr *);
636 static int key_spddump(struct socket *, struct mbuf *,
637 const struct sadb_msghdr *);
638 static struct mbuf *key_setdumpsp(struct secpolicy *,
639 u_int8_t, u_int32_t, u_int32_t);
640 static struct mbuf *key_sp2mbuf(struct secpolicy *);
641 static size_t key_getspreqmsglen(struct secpolicy *);
642 static int key_spdexpire(struct secpolicy *);
643 static struct secashead *key_newsah(struct secasindex *);
644 static void key_freesah(struct secashead **);
645 static void key_delsah(struct secashead *);
646 static struct secasvar *key_newsav(const struct sadb_msghdr *,
647 struct secasindex *, uint32_t, int *);
648 static void key_delsav(struct secasvar *);
649 static void key_unlinksav(struct secasvar *);
650 static struct secashead *key_getsah(struct secasindex *);
651 static int key_checkspidup(uint32_t);
652 static struct secasvar *key_getsavbyspi(uint32_t);
653 static int key_setnatt(struct secasvar *, const struct sadb_msghdr *);
654 static int key_setsaval(struct secasvar *, const struct sadb_msghdr *);
655 static int key_updatelifetimes(struct secasvar *, const struct sadb_msghdr *);
656 static int key_updateaddresses(struct socket *, struct mbuf *,
657 const struct sadb_msghdr *, struct secasvar *, struct secasindex *);
659 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
660 u_int8_t, u_int32_t, u_int32_t);
661 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
662 u_int32_t, pid_t, u_int16_t);
663 static struct mbuf *key_setsadbsa(struct secasvar *);
664 static struct mbuf *key_setsadbaddr(u_int16_t,
665 const struct sockaddr *, u_int8_t, u_int16_t);
666 static struct mbuf *key_setsadbxport(u_int16_t, u_int16_t);
667 static struct mbuf *key_setsadbxtype(u_int16_t);
668 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t);
669 static struct mbuf *key_setsadbxsareplay(u_int32_t);
670 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
671 u_int32_t, u_int32_t);
672 static struct seckey *key_dup_keymsg(const struct sadb_key *, size_t,
673 struct malloc_type *);
674 static struct seclifetime *key_dup_lifemsg(const struct sadb_lifetime *src,
675 struct malloc_type *);
677 /* flags for key_cmpsaidx() */
678 #define CMP_HEAD 1 /* protocol, addresses. */
679 #define CMP_MODE_REQID 2 /* additionally HEAD, reqid, mode. */
680 #define CMP_REQID 3 /* additionally HEAD, reaid. */
681 #define CMP_EXACTLY 4 /* all elements. */
682 static int key_cmpsaidx(const struct secasindex *,
683 const struct secasindex *, int);
684 static int key_cmpspidx_exactly(struct secpolicyindex *,
685 struct secpolicyindex *);
686 static int key_cmpspidx_withmask(struct secpolicyindex *,
687 struct secpolicyindex *);
688 static int key_bbcmp(const void *, const void *, u_int);
689 static uint8_t key_satype2proto(uint8_t);
690 static uint8_t key_proto2satype(uint8_t);
692 static int key_getspi(struct socket *, struct mbuf *,
693 const struct sadb_msghdr *);
694 static uint32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
695 static int key_update(struct socket *, struct mbuf *,
696 const struct sadb_msghdr *);
697 static int key_add(struct socket *, struct mbuf *,
698 const struct sadb_msghdr *);
699 static int key_setident(struct secashead *, const struct sadb_msghdr *);
700 static struct mbuf *key_getmsgbuf_x1(struct mbuf *,
701 const struct sadb_msghdr *);
702 static int key_delete(struct socket *, struct mbuf *,
703 const struct sadb_msghdr *);
704 static int key_delete_all(struct socket *, struct mbuf *,
705 const struct sadb_msghdr *, struct secasindex *);
706 static int key_get(struct socket *, struct mbuf *,
707 const struct sadb_msghdr *);
709 static void key_getcomb_setlifetime(struct sadb_comb *);
710 static struct mbuf *key_getcomb_ealg(void);
711 static struct mbuf *key_getcomb_ah(void);
712 static struct mbuf *key_getcomb_ipcomp(void);
713 static struct mbuf *key_getprop(const struct secasindex *);
715 static int key_acquire(const struct secasindex *, struct secpolicy *);
716 static uint32_t key_newacq(const struct secasindex *, int *);
717 static uint32_t key_getacq(const struct secasindex *, int *);
718 static int key_acqdone(const struct secasindex *, uint32_t);
719 static int key_acqreset(uint32_t);
720 static struct secspacq *key_newspacq(struct secpolicyindex *);
721 static struct secspacq *key_getspacq(struct secpolicyindex *);
722 static int key_acquire2(struct socket *, struct mbuf *,
723 const struct sadb_msghdr *);
724 static int key_register(struct socket *, struct mbuf *,
725 const struct sadb_msghdr *);
726 static int key_expire(struct secasvar *, int);
727 static int key_flush(struct socket *, struct mbuf *,
728 const struct sadb_msghdr *);
729 static int key_dump(struct socket *, struct mbuf *,
730 const struct sadb_msghdr *);
731 static int key_promisc(struct socket *, struct mbuf *,
732 const struct sadb_msghdr *);
733 static int key_senderror(struct socket *, struct mbuf *, int);
734 static int key_validate_ext(const struct sadb_ext *, int);
735 static int key_align(struct mbuf *, struct sadb_msghdr *);
736 static struct mbuf *key_setlifetime(struct seclifetime *, uint16_t);
737 static struct mbuf *key_setkey(struct seckey *, uint16_t);
739 static void spdcache_init(void);
740 static void spdcache_clear(void);
741 static struct spdcache_entry *spdcache_entry_alloc(
742 const struct secpolicyindex *spidx,
743 struct secpolicy *policy);
744 static void spdcache_entry_free(struct spdcache_entry *entry);
746 static void spdcache_destroy(void);
749 #define DBG_IPSEC_INITREF(t, p) do { \
750 refcount_init(&(p)->refcnt, 1); \
752 printf("%s: Initialize refcnt %s(%p) = %u\n", \
753 __func__, #t, (p), (p)->refcnt)); \
755 #define DBG_IPSEC_ADDREF(t, p) do { \
756 refcount_acquire(&(p)->refcnt); \
758 printf("%s: Acquire refcnt %s(%p) -> %u\n", \
759 __func__, #t, (p), (p)->refcnt)); \
761 #define DBG_IPSEC_DELREF(t, p) do { \
763 printf("%s: Release refcnt %s(%p) -> %u\n", \
764 __func__, #t, (p), (p)->refcnt - 1)); \
765 refcount_release(&(p)->refcnt); \
768 #define IPSEC_INITREF(t, p) refcount_init(&(p)->refcnt, 1)
769 #define IPSEC_ADDREF(t, p) refcount_acquire(&(p)->refcnt)
770 #define IPSEC_DELREF(t, p) refcount_release(&(p)->refcnt)
772 #define SP_INITREF(p) IPSEC_INITREF(SP, p)
773 #define SP_ADDREF(p) IPSEC_ADDREF(SP, p)
774 #define SP_DELREF(p) IPSEC_DELREF(SP, p)
776 #define SAH_INITREF(p) IPSEC_INITREF(SAH, p)
777 #define SAH_ADDREF(p) IPSEC_ADDREF(SAH, p)
778 #define SAH_DELREF(p) IPSEC_DELREF(SAH, p)
780 #define SAV_INITREF(p) IPSEC_INITREF(SAV, p)
781 #define SAV_ADDREF(p) IPSEC_ADDREF(SAV, p)
782 #define SAV_DELREF(p) IPSEC_DELREF(SAV, p)
785 * Update the refcnt while holding the SPTREE lock.
788 key_addref(struct secpolicy *sp)
795 * Return 0 when there are known to be no SP's for the specified
796 * direction. Otherwise return 1. This is used by IPsec code
797 * to optimize performance.
800 key_havesp(u_int dir)
803 return (dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND ?
804 TAILQ_FIRST(&V_sptree[dir]) != NULL : 1);
807 /* %%% IPsec policy management */
809 * Return current SPDB generation.
826 key_checksockaddrs(struct sockaddr *src, struct sockaddr *dst)
830 if (src->sa_family != dst->sa_family)
833 if (src->sa_len != dst->sa_len)
835 switch (src->sa_family) {
838 if (src->sa_len != sizeof(struct sockaddr_in))
844 if (src->sa_len != sizeof(struct sockaddr_in6))
849 return (EAFNOSUPPORT);
855 key_do_allocsp(struct secpolicyindex *spidx, u_int dir)
857 SPTREE_RLOCK_TRACKER;
858 struct secpolicy *sp;
860 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
861 IPSEC_ASSERT(dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND,
862 ("invalid direction %u", dir));
865 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
866 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
876 * allocating a SP for OUTBOUND or INBOUND packet.
877 * Must call key_freesp() later.
878 * OUT: NULL: not found
879 * others: found and return the pointer.
882 key_allocsp(struct secpolicyindex *spidx, u_int dir)
884 struct spdcache_entry *entry, *lastentry, *tmpentry;
885 struct secpolicy *sp;
889 if (!SPDCACHE_ACTIVE()) {
890 sp = key_do_allocsp(spidx, dir);
894 hashv = SPDCACHE_HASHVAL(spidx);
895 SPDCACHE_LOCK(hashv);
897 LIST_FOREACH_SAFE(entry, &V_spdcachehashtbl[hashv], chain, tmpentry) {
898 /* Removed outdated entries */
899 if (entry->sp != NULL &&
900 entry->sp->state == IPSEC_SPSTATE_DEAD) {
901 LIST_REMOVE(entry, chain);
902 spdcache_entry_free(entry);
907 if (!key_cmpspidx_exactly(&entry->spidx, spidx)) {
913 if (entry->sp != NULL)
916 /* IPSECSTAT_INC(ips_spdcache_hits); */
918 SPDCACHE_UNLOCK(hashv);
922 /* IPSECSTAT_INC(ips_spdcache_misses); */
924 sp = key_do_allocsp(spidx, dir);
925 entry = spdcache_entry_alloc(spidx, sp);
927 if (nb_entries >= SPDCACHE_MAX_ENTRIES_PER_HASH) {
928 LIST_REMOVE(lastentry, chain);
929 spdcache_entry_free(lastentry);
932 LIST_INSERT_HEAD(&V_spdcachehashtbl[hashv], entry, chain);
935 SPDCACHE_UNLOCK(hashv);
938 if (sp != NULL) { /* found a SPD entry */
939 sp->lastused = time_second;
941 printf("%s: return SP(%p)\n", __func__, sp));
942 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
945 printf("%s: lookup failed for ", __func__);
946 kdebug_secpolicyindex(spidx, NULL));
952 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
953 * or should be signed by MD5 signature.
954 * We don't use key_allocsa() for such lookups, because we don't know SPI.
955 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
956 * signed packet. We use SADB only as storage for password.
957 * OUT: positive: corresponding SA for given saidx found.
961 key_allocsa_tcpmd5(struct secasindex *saidx)
963 SAHTREE_RLOCK_TRACKER;
964 struct secashead *sah;
965 struct secasvar *sav;
967 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
968 ("unexpected security protocol %u", saidx->proto));
969 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
970 ("unexpected mode %u", saidx->mode));
973 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
975 printf("%s: checking SAH\n", __func__);
976 kdebug_secash(sah, " "));
977 if (sah->saidx.proto != IPPROTO_TCP)
979 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
980 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
984 if (V_key_preferred_oldsa)
985 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
987 sav = TAILQ_FIRST(&sah->savtree_alive);
996 printf("%s: return SA(%p)\n", __func__, sav));
997 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1000 printf("%s: SA not found\n", __func__));
1001 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1007 * Allocating an SA entry for an *OUTBOUND* packet.
1008 * OUT: positive: corresponding SA for given saidx found.
1009 * NULL: SA not found, but will be acquired, check *error
1010 * for acquiring status.
1013 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
1016 SAHTREE_RLOCK_TRACKER;
1017 struct secashead *sah;
1018 struct secasvar *sav;
1020 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
1021 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
1022 saidx->mode == IPSEC_MODE_TUNNEL,
1023 ("unexpected policy %u", saidx->mode));
1026 * We check new SA in the IPsec request because a different
1027 * SA may be involved each time this request is checked, either
1028 * because new SAs are being configured, or this request is
1029 * associated with an unconnected datagram socket, or this request
1030 * is associated with a system default policy.
1033 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
1035 printf("%s: checking SAH\n", __func__);
1036 kdebug_secash(sah, " "));
1037 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
1042 * Allocate the oldest SA available according to
1043 * draft-jenkins-ipsec-rekeying-03.
1045 if (V_key_preferred_oldsa)
1046 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1048 sav = TAILQ_FIRST(&sah->savtree_alive);
1058 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
1060 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1061 return (sav); /* return referenced SA */
1064 /* there is no SA */
1065 *error = key_acquire(saidx, sp);
1067 ipseclog((LOG_DEBUG,
1068 "%s: error %d returned from key_acquire()\n",
1071 printf("%s: acquire SA for SP(%p), error %d\n",
1072 __func__, sp, *error));
1073 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1078 * allocating a usable SA entry for a *INBOUND* packet.
1079 * Must call key_freesav() later.
1080 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
1081 * NULL: not found, or error occurred.
1083 * According to RFC 2401 SA is uniquely identified by a triple SPI,
1084 * destination address, and security protocol. But according to RFC 4301,
1085 * SPI by itself suffices to specify an SA.
1087 * Note that, however, we do need to keep source address in IPsec SA.
1088 * IKE specification and PF_KEY specification do assume that we
1089 * keep source address in IPsec SA. We see a tricky situation here.
1092 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
1094 SAHTREE_RLOCK_TRACKER;
1095 struct secasvar *sav;
1097 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
1098 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
1102 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
1103 if (sav->spi == spi)
1107 * We use single SPI namespace for all protocols, so it is
1108 * impossible to have SPI duplicates in the SAVHASH.
1111 if (sav->state != SADB_SASTATE_LARVAL &&
1112 sav->sah->saidx.proto == proto &&
1113 key_sockaddrcmp(&dst->sa,
1114 &sav->sah->saidx.dst.sa, 0) == 0)
1123 char buf[IPSEC_ADDRSTRLEN];
1124 printf("%s: SA not found for spi %u proto %u dst %s\n",
1125 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1129 printf("%s: return SA(%p)\n", __func__, sav));
1130 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1136 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1139 SAHTREE_RLOCK_TRACKER;
1140 struct secasindex saidx;
1141 struct secashead *sah;
1142 struct secasvar *sav;
1144 IPSEC_ASSERT(src != NULL, ("null src address"));
1145 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1147 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1152 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1153 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1155 if (proto != sah->saidx.proto)
1157 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1159 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1161 /* XXXAE: is key_preferred_oldsa reasonably?*/
1162 if (V_key_preferred_oldsa)
1163 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1165 sav = TAILQ_FIRST(&sah->savtree_alive);
1173 printf("%s: return SA(%p)\n", __func__, sav));
1175 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1180 * Must be called after calling key_allocsp().
1183 key_freesp(struct secpolicy **spp)
1185 struct secpolicy *sp = *spp;
1187 IPSEC_ASSERT(sp != NULL, ("null sp"));
1188 if (SP_DELREF(sp) == 0)
1192 printf("%s: last reference to SP(%p)\n", __func__, sp));
1193 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1196 while (sp->tcount > 0)
1197 ipsec_delisr(sp->req[--sp->tcount]);
1198 free(sp, M_IPSEC_SP);
1202 key_unlink(struct secpolicy *sp)
1207 if (SPDCACHE_ENABLED())
1213 key_detach(struct secpolicy *sp)
1215 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1216 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1217 ("invalid direction %u", sp->spidx.dir));
1218 SPTREE_WLOCK_ASSERT();
1221 printf("%s: SP(%p)\n", __func__, sp));
1222 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1223 /* SP is already unlinked */
1226 sp->state = IPSEC_SPSTATE_DEAD;
1227 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1229 LIST_REMOVE(sp, idhash);
1234 * insert a secpolicy into the SP database. Lower priorities first
1237 key_insertsp(struct secpolicy *newsp)
1239 struct secpolicy *sp;
1241 SPTREE_WLOCK_ASSERT();
1242 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1243 if (newsp->priority < sp->priority) {
1244 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1248 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1250 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1251 newsp->state = IPSEC_SPSTATE_ALIVE;
1257 * Insert a bunch of VTI secpolicies into the SPDB.
1258 * We keep VTI policies in the separate list due to following reasons:
1259 * 1) they should be immutable to user's or some deamon's attempts to
1260 * delete. The only way delete such policies - destroy or unconfigure
1261 * corresponding virtual inteface.
1262 * 2) such policies have traffic selector that matches all traffic per
1264 * Since all VTI policies have the same priority, we don't care about
1268 key_register_ifnet(struct secpolicy **spp, u_int count)
1275 * First of try to acquire id for each SP.
1277 for (i = 0; i < count; i++) {
1278 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1279 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1280 ("invalid direction %u", spp[i]->spidx.dir));
1282 if ((spp[i]->id = key_getnewspid()) == 0) {
1287 for (i = 0; i < count; i++) {
1288 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1291 * NOTE: despite the fact that we keep VTI SP in the
1292 * separate list, SPHASH contains policies from both
1293 * sources. Thus SADB_X_SPDGET will correctly return
1294 * SP by id, because it uses SPHASH for lookups.
1296 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1297 spp[i]->state = IPSEC_SPSTATE_IFNET;
1301 * Notify user processes about new SP.
1303 for (i = 0; i < count; i++) {
1304 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1306 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1312 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1318 for (i = 0; i < count; i++) {
1319 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1320 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1321 ("invalid direction %u", spp[i]->spidx.dir));
1323 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1325 spp[i]->state = IPSEC_SPSTATE_DEAD;
1326 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1329 LIST_REMOVE(spp[i], idhash);
1332 if (SPDCACHE_ENABLED())
1335 for (i = 0; i < count; i++) {
1336 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1338 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1343 * Must be called after calling key_allocsa().
1344 * This function is called by key_freesp() to free some SA allocated
1348 key_freesav(struct secasvar **psav)
1350 struct secasvar *sav = *psav;
1352 IPSEC_ASSERT(sav != NULL, ("null sav"));
1353 if (SAV_DELREF(sav) == 0)
1357 printf("%s: last reference to SA(%p)\n", __func__, sav));
1364 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1365 * Expect that SA has extra reference due to lookup.
1366 * Release this references, also release SAH reference after unlink.
1369 key_unlinksav(struct secasvar *sav)
1371 struct secashead *sah;
1374 printf("%s: SA(%p)\n", __func__, sav));
1376 SAHTREE_UNLOCK_ASSERT();
1378 if (sav->state == SADB_SASTATE_DEAD) {
1379 /* SA is already unlinked */
1383 /* Unlink from SAH */
1384 if (sav->state == SADB_SASTATE_LARVAL)
1385 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1387 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1388 /* Unlink from SPI hash */
1389 LIST_REMOVE(sav, spihash);
1390 sav->state = SADB_SASTATE_DEAD;
1394 /* Since we are unlinked, release reference to SAH */
1398 /* %%% SPD management */
1401 * OUT: NULL : not found
1402 * others : found, pointer to a SP.
1404 static struct secpolicy *
1405 key_getsp(struct secpolicyindex *spidx)
1407 SPTREE_RLOCK_TRACKER;
1408 struct secpolicy *sp;
1410 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1413 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1414 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1426 * OUT: NULL : not found
1427 * others : found, pointer to referenced SP.
1429 static struct secpolicy *
1430 key_getspbyid(uint32_t id)
1432 SPTREE_RLOCK_TRACKER;
1433 struct secpolicy *sp;
1436 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1449 struct secpolicy *sp;
1451 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1457 struct ipsecrequest *
1461 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1462 M_NOWAIT | M_ZERO));
1466 ipsec_delisr(struct ipsecrequest *p)
1469 free(p, M_IPSEC_SR);
1473 * create secpolicy structure from sadb_x_policy structure.
1474 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1475 * are not set, so must be set properly later.
1478 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1480 struct secpolicy *newsp;
1482 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1483 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1485 if (len != PFKEY_EXTLEN(xpl0)) {
1486 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1491 if ((newsp = key_newsp()) == NULL) {
1496 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1497 newsp->policy = xpl0->sadb_x_policy_type;
1498 newsp->priority = xpl0->sadb_x_policy_priority;
1502 switch (xpl0->sadb_x_policy_type) {
1503 case IPSEC_POLICY_DISCARD:
1504 case IPSEC_POLICY_NONE:
1505 case IPSEC_POLICY_ENTRUST:
1506 case IPSEC_POLICY_BYPASS:
1509 case IPSEC_POLICY_IPSEC:
1511 struct sadb_x_ipsecrequest *xisr;
1512 struct ipsecrequest *isr;
1515 /* validity check */
1516 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1517 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1524 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1525 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1529 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1530 xisr->sadb_x_ipsecrequest_len > tlen) {
1531 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1532 "length.\n", __func__));
1538 if (newsp->tcount >= IPSEC_MAXREQ) {
1539 ipseclog((LOG_DEBUG,
1540 "%s: too many ipsecrequests.\n",
1547 /* allocate request buffer */
1548 /* NB: data structure is zero'd */
1549 isr = ipsec_newisr();
1551 ipseclog((LOG_DEBUG,
1552 "%s: No more memory.\n", __func__));
1558 newsp->req[newsp->tcount++] = isr;
1561 switch (xisr->sadb_x_ipsecrequest_proto) {
1564 case IPPROTO_IPCOMP:
1567 ipseclog((LOG_DEBUG,
1568 "%s: invalid proto type=%u\n", __func__,
1569 xisr->sadb_x_ipsecrequest_proto));
1571 *error = EPROTONOSUPPORT;
1575 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1577 switch (xisr->sadb_x_ipsecrequest_mode) {
1578 case IPSEC_MODE_TRANSPORT:
1579 case IPSEC_MODE_TUNNEL:
1581 case IPSEC_MODE_ANY:
1583 ipseclog((LOG_DEBUG,
1584 "%s: invalid mode=%u\n", __func__,
1585 xisr->sadb_x_ipsecrequest_mode));
1590 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1592 switch (xisr->sadb_x_ipsecrequest_level) {
1593 case IPSEC_LEVEL_DEFAULT:
1594 case IPSEC_LEVEL_USE:
1595 case IPSEC_LEVEL_REQUIRE:
1597 case IPSEC_LEVEL_UNIQUE:
1598 /* validity check */
1600 * If range violation of reqid, kernel will
1601 * update it, don't refuse it.
1603 if (xisr->sadb_x_ipsecrequest_reqid
1604 > IPSEC_MANUAL_REQID_MAX) {
1605 ipseclog((LOG_DEBUG,
1606 "%s: reqid=%d range "
1607 "violation, updated by kernel.\n",
1609 xisr->sadb_x_ipsecrequest_reqid));
1610 xisr->sadb_x_ipsecrequest_reqid = 0;
1613 /* allocate new reqid id if reqid is zero. */
1614 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1616 if ((reqid = key_newreqid()) == 0) {
1621 isr->saidx.reqid = reqid;
1622 xisr->sadb_x_ipsecrequest_reqid = reqid;
1624 /* set it for manual keying. */
1626 xisr->sadb_x_ipsecrequest_reqid;
1631 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1633 xisr->sadb_x_ipsecrequest_level));
1638 isr->level = xisr->sadb_x_ipsecrequest_level;
1640 /* set IP addresses if there */
1641 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1642 struct sockaddr *paddr;
1644 len = tlen - sizeof(*xisr);
1645 paddr = (struct sockaddr *)(xisr + 1);
1646 /* validity check */
1647 if (len < sizeof(struct sockaddr) ||
1648 len < 2 * paddr->sa_len ||
1649 paddr->sa_len > sizeof(isr->saidx.src)) {
1650 ipseclog((LOG_DEBUG, "%s: invalid "
1651 "request address length.\n",
1658 * Request length should be enough to keep
1659 * source and destination addresses.
1661 if (xisr->sadb_x_ipsecrequest_len <
1662 sizeof(*xisr) + 2 * paddr->sa_len) {
1663 ipseclog((LOG_DEBUG, "%s: invalid "
1664 "ipsecrequest length.\n",
1670 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1671 paddr = (struct sockaddr *)((caddr_t)paddr +
1674 /* validity check */
1675 if (paddr->sa_len !=
1676 isr->saidx.src.sa.sa_len) {
1677 ipseclog((LOG_DEBUG, "%s: invalid "
1678 "request address length.\n",
1684 /* AF family should match */
1685 if (paddr->sa_family !=
1686 isr->saidx.src.sa.sa_family) {
1687 ipseclog((LOG_DEBUG, "%s: address "
1688 "family doesn't match.\n",
1694 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1697 * Addresses for TUNNEL mode requests are
1700 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1701 ipseclog((LOG_DEBUG, "%s: missing "
1702 "request addresses.\n", __func__));
1708 tlen -= xisr->sadb_x_ipsecrequest_len;
1710 /* validity check */
1712 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1719 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1720 + xisr->sadb_x_ipsecrequest_len);
1722 /* XXXAE: LARVAL SP */
1723 if (newsp->tcount < 1) {
1724 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1725 "not found.\n", __func__));
1733 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1746 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1748 if (auto_reqid == ~0)
1749 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1753 /* XXX should be unique check */
1754 return (auto_reqid);
1758 * copy secpolicy struct to sadb_x_policy structure indicated.
1760 static struct mbuf *
1761 key_sp2mbuf(struct secpolicy *sp)
1766 tlen = key_getspreqmsglen(sp);
1767 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1772 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1780 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1782 struct sadb_x_ipsecrequest *xisr;
1783 struct sadb_x_policy *xpl;
1784 struct ipsecrequest *isr;
1789 IPSEC_ASSERT(sp != NULL, ("null policy"));
1791 xlen = sizeof(*xpl);
1796 bzero(request, *len);
1797 xpl = (struct sadb_x_policy *)request;
1798 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1799 xpl->sadb_x_policy_type = sp->policy;
1800 xpl->sadb_x_policy_dir = sp->spidx.dir;
1801 xpl->sadb_x_policy_id = sp->id;
1802 xpl->sadb_x_policy_priority = sp->priority;
1803 switch (sp->state) {
1804 case IPSEC_SPSTATE_IFNET:
1805 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1807 case IPSEC_SPSTATE_PCB:
1808 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1811 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1814 /* if is the policy for ipsec ? */
1815 if (sp->policy == IPSEC_POLICY_IPSEC) {
1816 p = (caddr_t)xpl + sizeof(*xpl);
1817 for (i = 0; i < sp->tcount; i++) {
1819 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1820 isr->saidx.src.sa.sa_len +
1821 isr->saidx.dst.sa.sa_len);
1825 /* Calculate needed size */
1828 xisr = (struct sadb_x_ipsecrequest *)p;
1829 xisr->sadb_x_ipsecrequest_len = ilen;
1830 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1831 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1832 xisr->sadb_x_ipsecrequest_level = isr->level;
1833 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1836 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1837 p += isr->saidx.src.sa.sa_len;
1838 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1839 p += isr->saidx.dst.sa.sa_len;
1842 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1846 *len = sizeof(*xpl);
1850 /* m will not be freed nor modified */
1851 static struct mbuf *
1852 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1853 int ndeep, int nitem, ...)
1858 struct mbuf *result = NULL, *n;
1861 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1862 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1864 va_start(ap, nitem);
1865 for (i = 0; i < nitem; i++) {
1866 idx = va_arg(ap, int);
1867 if (idx < 0 || idx > SADB_EXT_MAX)
1869 /* don't attempt to pull empty extension */
1870 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1872 if (idx != SADB_EXT_RESERVED &&
1873 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1876 if (idx == SADB_EXT_RESERVED) {
1877 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1879 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1881 MGETHDR(n, M_NOWAIT, MT_DATA);
1886 m_copydata(m, 0, sizeof(struct sadb_msg),
1888 } else if (i < ndeep) {
1889 len = mhp->extlen[idx];
1890 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1895 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1898 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1911 if ((result->m_flags & M_PKTHDR) != 0) {
1912 result->m_pkthdr.len = 0;
1913 for (n = result; n; n = n->m_next)
1914 result->m_pkthdr.len += n->m_len;
1926 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1927 * add an entry to SP database, when received
1928 * <base, address(SD), (lifetime(H),) policy>
1930 * Adding to SP database,
1932 * <base, address(SD), (lifetime(H),) policy>
1933 * to the socket which was send.
1935 * SPDADD set a unique policy entry.
1936 * SPDSETIDX like SPDADD without a part of policy requests.
1937 * SPDUPDATE replace a unique policy entry.
1939 * XXXAE: serialize this in PF_KEY to avoid races.
1940 * m will always be freed.
1943 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1945 struct secpolicyindex spidx;
1946 struct sadb_address *src0, *dst0;
1947 struct sadb_x_policy *xpl0, *xpl;
1948 struct sadb_lifetime *lft = NULL;
1949 struct secpolicy *newsp, *oldsp;
1952 IPSEC_ASSERT(so != NULL, ("null socket"));
1953 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1954 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1955 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1957 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1958 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1959 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1960 ipseclog((LOG_DEBUG,
1961 "%s: invalid message: missing required header.\n",
1963 return key_senderror(so, m, EINVAL);
1965 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1966 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1967 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1968 ipseclog((LOG_DEBUG,
1969 "%s: invalid message: wrong header size.\n", __func__));
1970 return key_senderror(so, m, EINVAL);
1972 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1973 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1974 ipseclog((LOG_DEBUG,
1975 "%s: invalid message: wrong header size.\n",
1977 return key_senderror(so, m, EINVAL);
1979 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1982 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1983 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1984 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1986 /* check the direciton */
1987 switch (xpl0->sadb_x_policy_dir) {
1988 case IPSEC_DIR_INBOUND:
1989 case IPSEC_DIR_OUTBOUND:
1992 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
1993 return key_senderror(so, m, EINVAL);
1995 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
1996 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
1997 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
1998 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
1999 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2000 return key_senderror(so, m, EINVAL);
2003 /* policy requests are mandatory when action is ipsec. */
2004 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
2005 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2006 ipseclog((LOG_DEBUG,
2007 "%s: policy requests required.\n", __func__));
2008 return key_senderror(so, m, EINVAL);
2011 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
2012 (struct sockaddr *)(dst0 + 1));
2014 src0->sadb_address_proto != dst0->sadb_address_proto) {
2015 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2016 return key_senderror(so, m, error);
2019 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2022 src0->sadb_address_prefixlen,
2023 dst0->sadb_address_prefixlen,
2024 src0->sadb_address_proto,
2026 /* Checking there is SP already or not. */
2027 oldsp = key_getsp(&spidx);
2028 if (oldsp != NULL) {
2029 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2031 printf("%s: unlink SP(%p) for SPDUPDATE\n",
2033 KEYDBG(KEY_DATA, kdebug_secpolicy(oldsp));
2036 ipseclog((LOG_DEBUG,
2037 "%s: a SP entry exists already.\n", __func__));
2038 return (key_senderror(so, m, EEXIST));
2042 /* allocate new SP entry */
2043 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2044 if (oldsp != NULL) {
2046 key_freesp(&oldsp); /* second for our reference */
2048 return key_senderror(so, m, error);
2051 newsp->lastused = newsp->created = time_second;
2052 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
2053 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
2054 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
2057 if ((newsp->id = key_getnewspid()) == 0) {
2061 if (oldsp != NULL) {
2062 key_freesp(&oldsp); /* first for key_detach */
2063 IPSEC_ASSERT(oldsp != NULL, ("null oldsp: refcount bug"));
2064 key_freesp(&oldsp); /* second for our reference */
2065 if (SPDCACHE_ENABLED()) /* refresh cache because of key_detach */
2069 return key_senderror(so, m, ENOBUFS);
2073 key_insertsp(newsp);
2075 if (oldsp != NULL) {
2076 key_freesp(&oldsp); /* first for key_detach */
2077 IPSEC_ASSERT(oldsp != NULL, ("null oldsp: refcount bug"));
2078 key_freesp(&oldsp); /* second for our reference */
2080 if (SPDCACHE_ENABLED())
2083 printf("%s: SP(%p)\n", __func__, newsp));
2084 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2087 struct mbuf *n, *mpolicy;
2088 struct sadb_msg *newmsg;
2091 /* create new sadb_msg to reply. */
2093 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
2094 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
2095 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2097 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
2099 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2102 return key_senderror(so, m, ENOBUFS);
2104 if (n->m_len < sizeof(*newmsg)) {
2105 n = m_pullup(n, sizeof(*newmsg));
2107 return key_senderror(so, m, ENOBUFS);
2109 newmsg = mtod(n, struct sadb_msg *);
2110 newmsg->sadb_msg_errno = 0;
2111 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2114 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2115 sizeof(*xpl), &off);
2116 if (mpolicy == NULL) {
2117 /* n is already freed */
2118 return key_senderror(so, m, ENOBUFS);
2120 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
2121 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2123 return key_senderror(so, m, EINVAL);
2125 xpl->sadb_x_policy_id = newsp->id;
2128 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2133 * get new policy id.
2139 key_getnewspid(void)
2141 struct secpolicy *sp;
2143 int count = V_key_spi_trycnt; /* XXX */
2145 SPTREE_WLOCK_ASSERT();
2147 if (V_policy_id == ~0) /* overflowed */
2148 newid = V_policy_id = 1;
2150 newid = ++V_policy_id;
2151 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2152 if (sp->id == newid)
2158 if (count == 0 || newid == 0) {
2159 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2167 * SADB_SPDDELETE processing
2169 * <base, address(SD), policy(*)>
2170 * from the user(?), and set SADB_SASTATE_DEAD,
2172 * <base, address(SD), policy(*)>
2174 * policy(*) including direction of policy.
2176 * m will always be freed.
2179 key_spddelete(struct socket *so, struct mbuf *m,
2180 const struct sadb_msghdr *mhp)
2182 struct secpolicyindex spidx;
2183 struct sadb_address *src0, *dst0;
2184 struct sadb_x_policy *xpl0;
2185 struct secpolicy *sp;
2187 IPSEC_ASSERT(so != NULL, ("null so"));
2188 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2189 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2190 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2192 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2193 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2194 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2195 ipseclog((LOG_DEBUG,
2196 "%s: invalid message: missing required header.\n",
2198 return key_senderror(so, m, EINVAL);
2200 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2201 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2202 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2203 ipseclog((LOG_DEBUG,
2204 "%s: invalid message: wrong header size.\n", __func__));
2205 return key_senderror(so, m, EINVAL);
2208 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2209 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2210 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2212 /* check the direciton */
2213 switch (xpl0->sadb_x_policy_dir) {
2214 case IPSEC_DIR_INBOUND:
2215 case IPSEC_DIR_OUTBOUND:
2218 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2219 return key_senderror(so, m, EINVAL);
2221 /* Only DISCARD, NONE and IPSEC are allowed */
2222 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2223 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2224 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2225 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2226 return key_senderror(so, m, EINVAL);
2228 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2229 (struct sockaddr *)(dst0 + 1)) != 0 ||
2230 src0->sadb_address_proto != dst0->sadb_address_proto) {
2231 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2232 return key_senderror(so, m, EINVAL);
2235 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2238 src0->sadb_address_prefixlen,
2239 dst0->sadb_address_prefixlen,
2240 src0->sadb_address_proto,
2243 /* Is there SP in SPD ? */
2244 if ((sp = key_getsp(&spidx)) == NULL) {
2245 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2246 return key_senderror(so, m, EINVAL);
2249 /* save policy id to buffer to be returned. */
2250 xpl0->sadb_x_policy_id = sp->id;
2253 printf("%s: SP(%p)\n", __func__, sp));
2254 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2260 struct sadb_msg *newmsg;
2262 /* create new sadb_msg to reply. */
2263 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2264 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2266 return key_senderror(so, m, ENOBUFS);
2268 newmsg = mtod(n, struct sadb_msg *);
2269 newmsg->sadb_msg_errno = 0;
2270 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2273 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2278 * SADB_SPDDELETE2 processing
2281 * from the user(?), and set SADB_SASTATE_DEAD,
2285 * policy(*) including direction of policy.
2287 * m will always be freed.
2290 key_spddelete2(struct socket *so, struct mbuf *m,
2291 const struct sadb_msghdr *mhp)
2293 struct secpolicy *sp;
2296 IPSEC_ASSERT(so != NULL, ("null socket"));
2297 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2298 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2299 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2301 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2302 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2303 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2305 return key_senderror(so, m, EINVAL);
2308 id = ((struct sadb_x_policy *)
2309 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2311 /* Is there SP in SPD ? */
2312 if ((sp = key_getspbyid(id)) == NULL) {
2313 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2315 return key_senderror(so, m, EINVAL);
2319 printf("%s: SP(%p)\n", __func__, sp));
2320 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2322 if (sp->state != IPSEC_SPSTATE_DEAD) {
2323 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2326 return (key_senderror(so, m, EACCES));
2331 struct mbuf *n, *nn;
2332 struct sadb_msg *newmsg;
2335 /* create new sadb_msg to reply. */
2336 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2338 MGETHDR(n, M_NOWAIT, MT_DATA);
2339 if (n && len > MHLEN) {
2340 if (!(MCLGET(n, M_NOWAIT))) {
2346 return key_senderror(so, m, ENOBUFS);
2352 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2353 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2355 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2358 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2359 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2362 return key_senderror(so, m, ENOBUFS);
2365 n->m_pkthdr.len = 0;
2366 for (nn = n; nn; nn = nn->m_next)
2367 n->m_pkthdr.len += nn->m_len;
2369 newmsg = mtod(n, struct sadb_msg *);
2370 newmsg->sadb_msg_errno = 0;
2371 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2374 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2379 * SADB_X_SPDGET processing
2384 * <base, address(SD), policy>
2386 * policy(*) including direction of policy.
2388 * m will always be freed.
2391 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2393 struct secpolicy *sp;
2397 IPSEC_ASSERT(so != NULL, ("null socket"));
2398 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2399 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2400 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2402 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2403 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2404 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2406 return key_senderror(so, m, EINVAL);
2409 id = ((struct sadb_x_policy *)
2410 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2412 /* Is there SP in SPD ? */
2413 if ((sp = key_getspbyid(id)) == NULL) {
2414 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2416 return key_senderror(so, m, ENOENT);
2419 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2420 mhp->msg->sadb_msg_pid);
2424 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2426 return key_senderror(so, m, ENOBUFS);
2430 * SADB_X_SPDACQUIRE processing.
2431 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2434 * to KMD, and expect to receive
2435 * <base> with SADB_X_SPDACQUIRE if error occurred,
2438 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2439 * policy(*) is without policy requests.
2442 * others: error number
2445 key_spdacquire(struct secpolicy *sp)
2447 struct mbuf *result = NULL, *m;
2448 struct secspacq *newspacq;
2450 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2451 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2452 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2453 ("policy not IPSEC %u", sp->policy));
2455 /* Get an entry to check whether sent message or not. */
2456 newspacq = key_getspacq(&sp->spidx);
2457 if (newspacq != NULL) {
2458 if (V_key_blockacq_count < newspacq->count) {
2459 /* reset counter and do send message. */
2460 newspacq->count = 0;
2462 /* increment counter and do nothing. */
2469 /* make new entry for blocking to send SADB_ACQUIRE. */
2470 newspacq = key_newspacq(&sp->spidx);
2471 if (newspacq == NULL)
2475 /* create new sadb_msg to reply. */
2476 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2482 result->m_pkthdr.len = 0;
2483 for (m = result; m; m = m->m_next)
2484 result->m_pkthdr.len += m->m_len;
2486 mtod(result, struct sadb_msg *)->sadb_msg_len =
2487 PFKEY_UNIT64(result->m_pkthdr.len);
2489 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2493 * SADB_SPDFLUSH processing
2496 * from the user, and free all entries in secpctree.
2500 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2502 * m will always be freed.
2505 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2507 struct secpolicy_queue drainq;
2508 struct sadb_msg *newmsg;
2509 struct secpolicy *sp, *nextsp;
2512 IPSEC_ASSERT(so != NULL, ("null socket"));
2513 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2514 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2515 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2517 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2518 return key_senderror(so, m, EINVAL);
2520 TAILQ_INIT(&drainq);
2522 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2523 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2526 * We need to set state to DEAD for each policy to be sure,
2527 * that another thread won't try to unlink it.
2528 * Also remove SP from sphash.
2530 TAILQ_FOREACH(sp, &drainq, chain) {
2531 sp->state = IPSEC_SPSTATE_DEAD;
2532 LIST_REMOVE(sp, idhash);
2537 if (SPDCACHE_ENABLED())
2539 sp = TAILQ_FIRST(&drainq);
2540 while (sp != NULL) {
2541 nextsp = TAILQ_NEXT(sp, chain);
2546 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2547 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2548 return key_senderror(so, m, ENOBUFS);
2554 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2555 newmsg = mtod(m, struct sadb_msg *);
2556 newmsg->sadb_msg_errno = 0;
2557 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2559 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2563 key_satype2scopemask(uint8_t satype)
2566 if (satype == IPSEC_POLICYSCOPE_ANY)
2571 * SADB_SPDDUMP processing
2574 * from the user, and dump all SP leaves and send,
2579 * sadb_msg_satype is considered as mask of policy scopes.
2580 * m will always be freed.
2583 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2585 SPTREE_RLOCK_TRACKER;
2586 struct secpolicy *sp;
2591 IPSEC_ASSERT(so != NULL, ("null socket"));
2592 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2593 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2594 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2596 /* search SPD entry and get buffer size. */
2598 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2600 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2601 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2602 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2605 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2606 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2613 return key_senderror(so, m, ENOENT);
2616 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2617 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2618 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2620 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2621 mhp->msg->sadb_msg_pid);
2624 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2627 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2628 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2630 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2631 mhp->msg->sadb_msg_pid);
2634 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2644 static struct mbuf *
2645 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2648 struct mbuf *result = NULL, *m;
2649 struct seclifetime lt;
2651 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2656 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2657 &sp->spidx.src.sa, sp->spidx.prefs,
2658 sp->spidx.ul_proto);
2663 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2664 &sp->spidx.dst.sa, sp->spidx.prefd,
2665 sp->spidx.ul_proto);
2670 m = key_sp2mbuf(sp);
2676 lt.addtime=sp->created;
2677 lt.usetime= sp->lastused;
2678 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2683 lt.addtime=sp->lifetime;
2684 lt.usetime= sp->validtime;
2685 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2691 if ((result->m_flags & M_PKTHDR) == 0)
2694 if (result->m_len < sizeof(struct sadb_msg)) {
2695 result = m_pullup(result, sizeof(struct sadb_msg));
2700 result->m_pkthdr.len = 0;
2701 for (m = result; m; m = m->m_next)
2702 result->m_pkthdr.len += m->m_len;
2704 mtod(result, struct sadb_msg *)->sadb_msg_len =
2705 PFKEY_UNIT64(result->m_pkthdr.len);
2714 * get PFKEY message length for security policy and request.
2717 key_getspreqmsglen(struct secpolicy *sp)
2722 tlen = sizeof(struct sadb_x_policy);
2723 /* if is the policy for ipsec ? */
2724 if (sp->policy != IPSEC_POLICY_IPSEC)
2727 /* get length of ipsec requests */
2728 for (i = 0; i < sp->tcount; i++) {
2729 len = sizeof(struct sadb_x_ipsecrequest)
2730 + sp->req[i]->saidx.src.sa.sa_len
2731 + sp->req[i]->saidx.dst.sa.sa_len;
2733 tlen += PFKEY_ALIGN8(len);
2739 * SADB_SPDEXPIRE processing
2741 * <base, address(SD), lifetime(CH), policy>
2745 * others : error number
2748 key_spdexpire(struct secpolicy *sp)
2750 struct sadb_lifetime *lt;
2751 struct mbuf *result = NULL, *m;
2752 int len, error = -1;
2754 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2757 printf("%s: SP(%p)\n", __func__, sp));
2758 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2760 /* set msg header */
2761 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2768 /* create lifetime extension (current and hard) */
2769 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2770 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2777 bzero(mtod(m, caddr_t), len);
2778 lt = mtod(m, struct sadb_lifetime *);
2779 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2780 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2781 lt->sadb_lifetime_allocations = 0;
2782 lt->sadb_lifetime_bytes = 0;
2783 lt->sadb_lifetime_addtime = sp->created;
2784 lt->sadb_lifetime_usetime = sp->lastused;
2785 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2786 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2787 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2788 lt->sadb_lifetime_allocations = 0;
2789 lt->sadb_lifetime_bytes = 0;
2790 lt->sadb_lifetime_addtime = sp->lifetime;
2791 lt->sadb_lifetime_usetime = sp->validtime;
2794 /* set sadb_address for source */
2795 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2797 sp->spidx.prefs, sp->spidx.ul_proto);
2804 /* set sadb_address for destination */
2805 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2807 sp->spidx.prefd, sp->spidx.ul_proto);
2815 m = key_sp2mbuf(sp);
2822 if ((result->m_flags & M_PKTHDR) == 0) {
2827 if (result->m_len < sizeof(struct sadb_msg)) {
2828 result = m_pullup(result, sizeof(struct sadb_msg));
2829 if (result == NULL) {
2835 result->m_pkthdr.len = 0;
2836 for (m = result; m; m = m->m_next)
2837 result->m_pkthdr.len += m->m_len;
2839 mtod(result, struct sadb_msg *)->sadb_msg_len =
2840 PFKEY_UNIT64(result->m_pkthdr.len);
2842 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2850 /* %%% SAD management */
2852 * allocating and initialize new SA head.
2853 * OUT: NULL : failure due to the lack of memory.
2854 * others : pointer to new SA head.
2856 static struct secashead *
2857 key_newsah(struct secasindex *saidx)
2859 struct secashead *sah;
2861 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2864 PFKEYSTAT_INC(in_nomem);
2867 TAILQ_INIT(&sah->savtree_larval);
2868 TAILQ_INIT(&sah->savtree_alive);
2869 sah->saidx = *saidx;
2870 sah->state = SADB_SASTATE_DEAD;
2874 printf("%s: SAH(%p)\n", __func__, sah));
2875 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2880 key_freesah(struct secashead **psah)
2882 struct secashead *sah = *psah;
2884 if (SAH_DELREF(sah) == 0)
2888 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2889 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2896 key_delsah(struct secashead *sah)
2898 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2899 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2900 ("Attempt to free non DEAD SAH %p", sah));
2901 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2902 ("Attempt to free SAH %p with LARVAL SA", sah));
2903 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2904 ("Attempt to free SAH %p with ALIVE SA", sah));
2906 free(sah, M_IPSEC_SAH);
2910 * allocating a new SA for key_add() and key_getspi() call,
2911 * and copy the values of mhp into new buffer.
2912 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2913 * For SADB_ADD create and initialize SA with MATURE state.
2915 * others : pointer to new secasvar.
2917 static struct secasvar *
2918 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2919 uint32_t spi, int *errp)
2921 struct secashead *sah;
2922 struct secasvar *sav;
2925 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2926 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2927 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2928 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2932 /* check SPI value */
2933 switch (saidx->proto) {
2937 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2938 * 1-255 reserved by IANA for future use,
2939 * 0 for implementation specific, local use.
2941 if (ntohl(spi) <= 255) {
2942 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2943 __func__, ntohl(spi)));
2950 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2955 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2957 if (sav->lock == NULL) {
2961 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2962 sav->lft_c = uma_zalloc_pcpu(ipsec_key_lft_zone, M_NOWAIT | M_ZERO);
2963 if (sav->lft_c == NULL) {
2969 sav->seq = mhp->msg->sadb_msg_seq;
2970 sav->state = SADB_SASTATE_LARVAL;
2971 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2974 sah = key_getsah(saidx);
2976 /* create a new SA index */
2977 sah = key_newsah(saidx);
2979 ipseclog((LOG_DEBUG,
2980 "%s: No more memory.\n", __func__));
2989 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2990 sav->created = time_second;
2991 } else if (sav->state == SADB_SASTATE_LARVAL) {
2993 * Do not call key_setsaval() second time in case
2994 * of `goto again`. We will have MATURE state.
2996 *errp = key_setsaval(sav, mhp);
2999 sav->state = SADB_SASTATE_MATURE;
3004 * Check that existing SAH wasn't unlinked.
3005 * Since we didn't hold the SAHTREE lock, it is possible,
3006 * that callout handler or key_flush() or key_delete() could
3009 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
3011 key_freesah(&sah); /* reference from key_getsah() */
3016 * Add new SAH into SADB.
3018 * XXXAE: we can serialize key_add and key_getspi calls, so
3019 * several threads will not fight in the race.
3020 * Otherwise we should check under SAHTREE lock, that this
3021 * SAH would not added twice.
3023 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
3024 /* Add new SAH into hash by addresses */
3025 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
3026 /* Now we are linked in the chain */
3027 sah->state = SADB_SASTATE_MATURE;
3029 * SAV references this new SAH.
3030 * In case of existing SAH we reuse reference
3031 * from key_getsah().
3035 /* Link SAV with SAH */
3036 if (sav->state == SADB_SASTATE_MATURE)
3037 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
3039 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
3040 /* Add SAV into SPI hash */
3041 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
3043 *errp = 0; /* success */
3047 if (sav->lock != NULL) {
3048 mtx_destroy(sav->lock);
3049 free(sav->lock, M_IPSEC_MISC);
3051 if (sav->lft_c != NULL)
3052 uma_zfree_pcpu(ipsec_key_lft_zone, sav->lft_c);
3053 free(sav, M_IPSEC_SA), sav = NULL;
3057 if (*errp == ENOBUFS) {
3058 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3060 PFKEYSTAT_INC(in_nomem);
3067 * free() SA variable entry.
3070 key_cleansav(struct secasvar *sav)
3073 if (sav->natt != NULL) {
3074 free(sav->natt, M_IPSEC_MISC);
3077 if (sav->flags & SADB_X_EXT_F_CLONED)
3079 if (sav->tdb_xform != NULL) {
3080 sav->tdb_xform->xf_cleanup(sav);
3081 sav->tdb_xform = NULL;
3083 if (sav->key_auth != NULL) {
3084 zfree(sav->key_auth->key_data, M_IPSEC_MISC);
3085 free(sav->key_auth, M_IPSEC_MISC);
3086 sav->key_auth = NULL;
3088 if (sav->key_enc != NULL) {
3089 zfree(sav->key_enc->key_data, M_IPSEC_MISC);
3090 free(sav->key_enc, M_IPSEC_MISC);
3091 sav->key_enc = NULL;
3093 if (sav->replay != NULL) {
3094 if (sav->replay->bitmap != NULL)
3095 free(sav->replay->bitmap, M_IPSEC_MISC);
3096 free(sav->replay, M_IPSEC_MISC);
3099 if (sav->lft_h != NULL) {
3100 free(sav->lft_h, M_IPSEC_MISC);
3103 if (sav->lft_s != NULL) {
3104 free(sav->lft_s, M_IPSEC_MISC);
3110 * free() SA variable entry.
3113 key_delsav(struct secasvar *sav)
3115 IPSEC_ASSERT(sav != NULL, ("null sav"));
3116 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
3117 ("attempt to free non DEAD SA %p", sav));
3118 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
3122 * SA must be unlinked from the chain and hashtbl.
3123 * If SA was cloned, we leave all fields untouched,
3124 * except NAT-T config.
3127 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
3128 mtx_destroy(sav->lock);
3129 free(sav->lock, M_IPSEC_MISC);
3130 uma_zfree_pcpu(ipsec_key_lft_zone, sav->lft_c);
3132 free(sav, M_IPSEC_SA);
3139 * others : found, referenced pointer to a SAH.
3141 static struct secashead *
3142 key_getsah(struct secasindex *saidx)
3144 SAHTREE_RLOCK_TRACKER;
3145 struct secashead *sah;
3148 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3149 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3159 * Check not to be duplicated SPI.
3162 * 1 : found SA with given SPI.
3165 key_checkspidup(uint32_t spi)
3167 SAHTREE_RLOCK_TRACKER;
3168 struct secasvar *sav;
3170 /* Assume SPI is in network byte order */
3172 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3173 if (sav->spi == spi)
3177 return (sav != NULL);
3184 * others : found, referenced pointer to a SA.
3186 static struct secasvar *
3187 key_getsavbyspi(uint32_t spi)
3189 SAHTREE_RLOCK_TRACKER;
3190 struct secasvar *sav;
3192 /* Assume SPI is in network byte order */
3194 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3195 if (sav->spi != spi)
3205 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3207 struct seclifetime *lft_h, *lft_s, *tmp;
3209 /* Lifetime extension is optional, check that it is present. */
3210 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3211 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3213 * In case of SADB_UPDATE we may need to change
3214 * existing lifetimes.
3216 if (sav->state == SADB_SASTATE_MATURE) {
3217 lft_h = lft_s = NULL;
3222 /* Both HARD and SOFT extensions must present */
3223 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3224 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3225 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3226 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3227 ipseclog((LOG_DEBUG,
3228 "%s: invalid message: missing required header.\n",
3232 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3233 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3234 ipseclog((LOG_DEBUG,
3235 "%s: invalid message: wrong header size.\n", __func__));
3238 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3239 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3240 if (lft_h == NULL) {
3241 PFKEYSTAT_INC(in_nomem);
3242 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3245 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3246 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3247 if (lft_s == NULL) {
3248 PFKEYSTAT_INC(in_nomem);
3249 free(lft_h, M_IPSEC_MISC);
3250 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3254 if (sav->state != SADB_SASTATE_LARVAL) {
3256 * key_update() holds reference to this SA,
3257 * so it won't be deleted in meanwhile.
3267 SECASVAR_UNLOCK(sav);
3269 free(lft_h, M_IPSEC_MISC);
3271 free(lft_s, M_IPSEC_MISC);
3274 /* We can update lifetime without holding a lock */
3275 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3276 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3283 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3284 * You must update these if need. Expects only LARVAL SAs.
3289 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3291 const struct sadb_sa *sa0;
3292 const struct sadb_key *key0;
3297 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3298 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3299 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3300 ("Attempt to update non LARVAL SA"));
3303 error = key_setident(sav->sah, mhp);
3308 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3309 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3313 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3314 sav->alg_auth = sa0->sadb_sa_auth;
3315 sav->alg_enc = sa0->sadb_sa_encrypt;
3316 sav->flags = sa0->sadb_sa_flags;
3317 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3318 ipseclog((LOG_DEBUG,
3319 "%s: invalid sa_flags 0x%08x.\n", __func__,
3325 /* Optional replay window */
3327 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3328 replay = sa0->sadb_sa_replay;
3329 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3330 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3334 replay = ((const struct sadb_x_sa_replay *)
3335 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3337 if (replay > UINT32_MAX - 32) {
3338 ipseclog((LOG_DEBUG,
3339 "%s: replay window too big.\n", __func__));
3344 replay = (replay + 7) >> 3;
3347 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3349 if (sav->replay == NULL) {
3350 PFKEYSTAT_INC(in_nomem);
3351 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3358 /* number of 32b blocks to be allocated */
3359 uint32_t bitmap_size;
3362 * - the allocated replay window size must be
3364 * - use an extra 32b block as a redundant window.
3367 while (replay + 4 > bitmap_size)
3369 bitmap_size = bitmap_size / 4;
3371 sav->replay->bitmap = malloc(
3372 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3374 if (sav->replay->bitmap == NULL) {
3375 PFKEYSTAT_INC(in_nomem);
3376 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3381 sav->replay->bitmap_size = bitmap_size;
3382 sav->replay->wsize = replay;
3386 /* Authentication keys */
3387 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3388 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3393 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3394 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3395 switch (mhp->msg->sadb_msg_satype) {
3396 case SADB_SATYPE_AH:
3397 case SADB_SATYPE_ESP:
3398 case SADB_X_SATYPE_TCPSIGNATURE:
3399 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3400 sav->alg_auth != SADB_X_AALG_NULL)
3403 case SADB_X_SATYPE_IPCOMP:
3409 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3414 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3415 if (sav->key_auth == NULL ) {
3416 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3418 PFKEYSTAT_INC(in_nomem);
3424 /* Encryption key */
3425 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3426 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3431 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3432 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3433 switch (mhp->msg->sadb_msg_satype) {
3434 case SADB_SATYPE_ESP:
3435 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3436 sav->alg_enc != SADB_EALG_NULL) {
3440 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3441 if (sav->key_enc == NULL) {
3442 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3444 PFKEYSTAT_INC(in_nomem);
3449 case SADB_X_SATYPE_IPCOMP:
3450 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3452 sav->key_enc = NULL; /*just in case*/
3454 case SADB_SATYPE_AH:
3455 case SADB_X_SATYPE_TCPSIGNATURE:
3461 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3469 switch (mhp->msg->sadb_msg_satype) {
3470 case SADB_SATYPE_AH:
3471 if (sav->flags & SADB_X_EXT_DERIV) {
3472 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3473 "given to AH SA.\n", __func__));
3477 if (sav->alg_enc != SADB_EALG_NONE) {
3478 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3479 "mismated.\n", __func__));
3483 error = xform_init(sav, XF_AH);
3485 case SADB_SATYPE_ESP:
3486 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3487 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3488 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3489 "given to old-esp.\n", __func__));
3493 error = xform_init(sav, XF_ESP);
3495 case SADB_X_SATYPE_IPCOMP:
3496 if (sav->alg_auth != SADB_AALG_NONE) {
3497 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3498 "mismated.\n", __func__));
3502 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3503 ntohl(sav->spi) >= 0x10000) {
3504 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3509 error = xform_init(sav, XF_IPCOMP);
3511 case SADB_X_SATYPE_TCPSIGNATURE:
3512 if (sav->alg_enc != SADB_EALG_NONE) {
3513 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3514 "mismated.\n", __func__));
3518 error = xform_init(sav, XF_TCPSIGNATURE);
3521 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3522 error = EPROTONOSUPPORT;
3526 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3527 __func__, mhp->msg->sadb_msg_satype));
3531 /* Handle NAT-T headers */
3532 error = key_setnatt(sav, mhp);
3536 /* Initialize lifetime for CURRENT */
3538 sav->created = time_second;
3540 /* lifetimes for HARD and SOFT */
3541 error = key_updatelifetimes(sav, mhp);
3550 * subroutine for SADB_GET and SADB_DUMP.
3552 static struct mbuf *
3553 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3554 uint32_t seq, uint32_t pid)
3556 struct seclifetime lft_c;
3557 struct mbuf *result = NULL, *tres = NULL, *m;
3558 int i, dumporder[] = {
3559 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3560 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3561 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3562 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3563 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3564 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3565 SADB_EXT_SENSITIVITY,
3566 SADB_X_EXT_NAT_T_TYPE,
3567 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3568 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3569 SADB_X_EXT_NAT_T_FRAG,
3571 uint32_t replay_count;
3573 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3578 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3580 switch (dumporder[i]) {
3582 m = key_setsadbsa(sav);
3587 case SADB_X_EXT_SA2:
3589 replay_count = sav->replay ? sav->replay->count : 0;
3590 SECASVAR_UNLOCK(sav);
3591 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3592 sav->sah->saidx.reqid);
3597 case SADB_X_EXT_SA_REPLAY:
3598 if (sav->replay == NULL ||
3599 sav->replay->wsize <= UINT8_MAX)
3602 m = key_setsadbxsareplay(sav->replay->wsize);
3607 case SADB_EXT_ADDRESS_SRC:
3608 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3609 &sav->sah->saidx.src.sa,
3610 FULLMASK, IPSEC_ULPROTO_ANY);
3615 case SADB_EXT_ADDRESS_DST:
3616 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3617 &sav->sah->saidx.dst.sa,
3618 FULLMASK, IPSEC_ULPROTO_ANY);
3623 case SADB_EXT_KEY_AUTH:
3626 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3631 case SADB_EXT_KEY_ENCRYPT:
3634 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3639 case SADB_EXT_LIFETIME_CURRENT:
3640 lft_c.addtime = sav->created;
3641 lft_c.allocations = (uint32_t)counter_u64_fetch(
3642 sav->lft_c_allocations);
3643 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3644 lft_c.usetime = sav->firstused;
3645 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3650 case SADB_EXT_LIFETIME_HARD:
3653 m = key_setlifetime(sav->lft_h,
3654 SADB_EXT_LIFETIME_HARD);
3659 case SADB_EXT_LIFETIME_SOFT:
3662 m = key_setlifetime(sav->lft_s,
3663 SADB_EXT_LIFETIME_SOFT);
3669 case SADB_X_EXT_NAT_T_TYPE:
3670 if (sav->natt == NULL)
3672 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3677 case SADB_X_EXT_NAT_T_DPORT:
3678 if (sav->natt == NULL)
3680 m = key_setsadbxport(sav->natt->dport,
3681 SADB_X_EXT_NAT_T_DPORT);
3686 case SADB_X_EXT_NAT_T_SPORT:
3687 if (sav->natt == NULL)
3689 m = key_setsadbxport(sav->natt->sport,
3690 SADB_X_EXT_NAT_T_SPORT);
3695 case SADB_X_EXT_NAT_T_OAI:
3696 if (sav->natt == NULL ||
3697 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3699 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3700 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3704 case SADB_X_EXT_NAT_T_OAR:
3705 if (sav->natt == NULL ||
3706 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3708 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3709 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3713 case SADB_X_EXT_NAT_T_FRAG:
3714 /* We do not (yet) support those. */
3717 case SADB_EXT_ADDRESS_PROXY:
3718 case SADB_EXT_IDENTITY_SRC:
3719 case SADB_EXT_IDENTITY_DST:
3720 /* XXX: should we brought from SPD ? */
3721 case SADB_EXT_SENSITIVITY:
3733 m_cat(result, tres);
3735 if (result->m_len < sizeof(struct sadb_msg)) {
3736 result = m_pullup(result, sizeof(struct sadb_msg));
3741 result->m_pkthdr.len = 0;
3742 for (m = result; m; m = m->m_next)
3743 result->m_pkthdr.len += m->m_len;
3745 mtod(result, struct sadb_msg *)->sadb_msg_len =
3746 PFKEY_UNIT64(result->m_pkthdr.len);
3757 * set data into sadb_msg.
3759 static struct mbuf *
3760 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3761 pid_t pid, u_int16_t reserved)
3767 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3770 MGETHDR(m, M_NOWAIT, MT_DATA);
3771 if (m && len > MHLEN) {
3772 if (!(MCLGET(m, M_NOWAIT))) {
3779 m->m_pkthdr.len = m->m_len = len;
3782 p = mtod(m, struct sadb_msg *);
3785 p->sadb_msg_version = PF_KEY_V2;
3786 p->sadb_msg_type = type;
3787 p->sadb_msg_errno = 0;
3788 p->sadb_msg_satype = satype;
3789 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3790 p->sadb_msg_reserved = reserved;
3791 p->sadb_msg_seq = seq;
3792 p->sadb_msg_pid = (u_int32_t)pid;
3798 * copy secasvar data into sadb_address.
3800 static struct mbuf *
3801 key_setsadbsa(struct secasvar *sav)
3807 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3808 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3813 p = mtod(m, struct sadb_sa *);
3815 p->sadb_sa_len = PFKEY_UNIT64(len);
3816 p->sadb_sa_exttype = SADB_EXT_SA;
3817 p->sadb_sa_spi = sav->spi;
3818 p->sadb_sa_replay = sav->replay ?
3819 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3820 sav->replay->wsize): 0;
3821 p->sadb_sa_state = sav->state;
3822 p->sadb_sa_auth = sav->alg_auth;
3823 p->sadb_sa_encrypt = sav->alg_enc;
3824 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3829 * set data into sadb_address.
3831 static struct mbuf *
3832 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3833 u_int8_t prefixlen, u_int16_t ul_proto)
3836 struct sadb_address *p;
3839 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3840 PFKEY_ALIGN8(saddr->sa_len);
3841 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3846 p = mtod(m, struct sadb_address *);
3849 p->sadb_address_len = PFKEY_UNIT64(len);
3850 p->sadb_address_exttype = exttype;
3851 p->sadb_address_proto = ul_proto;
3852 if (prefixlen == FULLMASK) {
3853 switch (saddr->sa_family) {
3855 prefixlen = sizeof(struct in_addr) << 3;
3858 prefixlen = sizeof(struct in6_addr) << 3;
3864 p->sadb_address_prefixlen = prefixlen;
3865 p->sadb_address_reserved = 0;
3868 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3875 * set data into sadb_x_sa2.
3877 static struct mbuf *
3878 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3881 struct sadb_x_sa2 *p;
3884 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3885 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3890 p = mtod(m, struct sadb_x_sa2 *);
3893 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3894 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3895 p->sadb_x_sa2_mode = mode;
3896 p->sadb_x_sa2_reserved1 = 0;
3897 p->sadb_x_sa2_reserved2 = 0;
3898 p->sadb_x_sa2_sequence = seq;
3899 p->sadb_x_sa2_reqid = reqid;
3905 * Set data into sadb_x_sa_replay.
3907 static struct mbuf *
3908 key_setsadbxsareplay(u_int32_t replay)
3911 struct sadb_x_sa_replay *p;
3914 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3915 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3920 p = mtod(m, struct sadb_x_sa_replay *);
3923 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3924 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3925 p->sadb_x_sa_replay_replay = (replay << 3);
3931 * Set a type in sadb_x_nat_t_type.
3933 static struct mbuf *
3934 key_setsadbxtype(u_int16_t type)
3938 struct sadb_x_nat_t_type *p;
3940 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3942 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3947 p = mtod(m, struct sadb_x_nat_t_type *);
3950 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3951 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3952 p->sadb_x_nat_t_type_type = type;
3957 * Set a port in sadb_x_nat_t_port.
3958 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3960 static struct mbuf *
3961 key_setsadbxport(u_int16_t port, u_int16_t type)
3965 struct sadb_x_nat_t_port *p;
3967 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3969 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3974 p = mtod(m, struct sadb_x_nat_t_port *);
3977 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3978 p->sadb_x_nat_t_port_exttype = type;
3979 p->sadb_x_nat_t_port_port = port;
3985 * Get port from sockaddr. Port is in network byte order.
3988 key_portfromsaddr(struct sockaddr *sa)
3991 switch (sa->sa_family) {
3994 return ((struct sockaddr_in *)sa)->sin_port;
3998 return ((struct sockaddr_in6 *)sa)->sin6_port;
4005 * Set port in struct sockaddr. Port is in network byte order.
4008 key_porttosaddr(struct sockaddr *sa, uint16_t port)
4011 switch (sa->sa_family) {
4014 ((struct sockaddr_in *)sa)->sin_port = port;
4019 ((struct sockaddr_in6 *)sa)->sin6_port = port;
4023 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
4024 __func__, sa->sa_family));
4030 * set data into sadb_x_policy
4032 static struct mbuf *
4033 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
4036 struct sadb_x_policy *p;
4039 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
4040 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
4045 p = mtod(m, struct sadb_x_policy *);
4048 p->sadb_x_policy_len = PFKEY_UNIT64(len);
4049 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
4050 p->sadb_x_policy_type = type;
4051 p->sadb_x_policy_dir = dir;
4052 p->sadb_x_policy_id = id;
4053 p->sadb_x_policy_priority = priority;
4059 /* Take a key message (sadb_key) from the socket and turn it into one
4060 * of the kernel's key structures (seckey).
4062 * IN: pointer to the src
4063 * OUT: NULL no more memory
4066 key_dup_keymsg(const struct sadb_key *src, size_t len,
4067 struct malloc_type *type)
4071 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4073 dst->bits = src->sadb_key_bits;
4074 dst->key_data = malloc(len, type, M_NOWAIT);
4075 if (dst->key_data != NULL) {
4076 bcopy((const char *)(src + 1), dst->key_data, len);
4078 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4084 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4090 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
4091 * turn it into one of the kernel's lifetime structures (seclifetime).
4093 * IN: pointer to the destination, source and malloc type
4094 * OUT: NULL, no more memory
4097 static struct seclifetime *
4098 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
4100 struct seclifetime *dst;
4102 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4104 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
4107 dst->allocations = src->sadb_lifetime_allocations;
4108 dst->bytes = src->sadb_lifetime_bytes;
4109 dst->addtime = src->sadb_lifetime_addtime;
4110 dst->usetime = src->sadb_lifetime_usetime;
4115 * compare two secasindex structure.
4116 * flag can specify to compare 2 saidxes.
4117 * compare two secasindex structure without both mode and reqid.
4118 * don't compare port.
4120 * saidx0: source, it can be in SAD.
4127 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4132 if (saidx0 == NULL && saidx1 == NULL)
4135 if (saidx0 == NULL || saidx1 == NULL)
4138 if (saidx0->proto != saidx1->proto)
4141 if (flag == CMP_EXACTLY) {
4142 if (saidx0->mode != saidx1->mode)
4144 if (saidx0->reqid != saidx1->reqid)
4146 if (bcmp(&saidx0->src, &saidx1->src,
4147 saidx0->src.sa.sa_len) != 0 ||
4148 bcmp(&saidx0->dst, &saidx1->dst,
4149 saidx0->dst.sa.sa_len) != 0)
4152 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4153 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4155 * If reqid of SPD is non-zero, unique SA is required.
4156 * The result must be of same reqid in this case.
4158 if (saidx1->reqid != 0 &&
4159 saidx0->reqid != saidx1->reqid)
4163 if (flag == CMP_MODE_REQID) {
4164 if (saidx0->mode != IPSEC_MODE_ANY
4165 && saidx0->mode != saidx1->mode)
4169 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4171 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4179 * compare two secindex structure exactly.
4181 * spidx0: source, it is often in SPD.
4182 * spidx1: object, it is often from PFKEY message.
4188 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4189 struct secpolicyindex *spidx1)
4192 if (spidx0 == NULL && spidx1 == NULL)
4195 if (spidx0 == NULL || spidx1 == NULL)
4198 if (spidx0->prefs != spidx1->prefs
4199 || spidx0->prefd != spidx1->prefd
4200 || spidx0->ul_proto != spidx1->ul_proto
4201 || spidx0->dir != spidx1->dir)
4204 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4205 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4209 * compare two secindex structure with mask.
4211 * spidx0: source, it is often in SPD.
4212 * spidx1: object, it is often from IP header.
4218 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4219 struct secpolicyindex *spidx1)
4222 if (spidx0 == NULL && spidx1 == NULL)
4225 if (spidx0 == NULL || spidx1 == NULL)
4228 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4229 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4230 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4231 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4234 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4235 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4236 && spidx0->ul_proto != spidx1->ul_proto)
4239 switch (spidx0->src.sa.sa_family) {
4241 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4242 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4244 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4245 &spidx1->src.sin.sin_addr, spidx0->prefs))
4249 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4250 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4253 * scope_id check. if sin6_scope_id is 0, we regard it
4254 * as a wildcard scope, which matches any scope zone ID.
4256 if (spidx0->src.sin6.sin6_scope_id &&
4257 spidx1->src.sin6.sin6_scope_id &&
4258 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4260 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4261 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4266 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4271 switch (spidx0->dst.sa.sa_family) {
4273 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4274 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4276 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4277 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4281 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4282 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4285 * scope_id check. if sin6_scope_id is 0, we regard it
4286 * as a wildcard scope, which matches any scope zone ID.
4288 if (spidx0->dst.sin6.sin6_scope_id &&
4289 spidx1->dst.sin6.sin6_scope_id &&
4290 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4292 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4293 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4298 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4303 /* XXX Do we check other field ? e.g. flowinfo */
4311 #define satosin(s) ((const struct sockaddr_in *)s)
4315 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4316 /* returns 0 on match */
4318 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4321 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4324 switch (sa1->sa_family) {
4327 if (sa1->sa_len != sizeof(struct sockaddr_in))
4329 if (satosin(sa1)->sin_addr.s_addr !=
4330 satosin(sa2)->sin_addr.s_addr) {
4333 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4339 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4340 return 1; /*EINVAL*/
4341 if (satosin6(sa1)->sin6_scope_id !=
4342 satosin6(sa2)->sin6_scope_id) {
4345 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4346 &satosin6(sa2)->sin6_addr)) {
4350 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4356 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4364 /* returns 0 on match */
4366 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4367 const struct sockaddr *sa2, size_t mask)
4369 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4372 switch (sa1->sa_family) {
4375 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4376 &satosin(sa2)->sin_addr, mask));
4380 if (satosin6(sa1)->sin6_scope_id !=
4381 satosin6(sa2)->sin6_scope_id)
4383 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4384 &satosin6(sa2)->sin6_addr, mask));
4393 * compare two buffers with mask.
4397 * bits: Number of bits to compare
4403 key_bbcmp(const void *a1, const void *a2, u_int bits)
4405 const unsigned char *p1 = a1;
4406 const unsigned char *p2 = a2;
4408 /* XXX: This could be considerably faster if we compare a word
4409 * at a time, but it is complicated on LSB Endian machines */
4411 /* Handle null pointers */
4412 if (p1 == NULL || p2 == NULL)
4422 u_int8_t mask = ~((1<<(8-bits))-1);
4423 if ((*p1 & mask) != (*p2 & mask))
4426 return 1; /* Match! */
4430 key_flush_spd(time_t now)
4432 SPTREE_RLOCK_TRACKER;
4433 struct secpolicy_list drainq;
4434 struct secpolicy *sp, *nextsp;
4439 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4440 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4441 if (sp->lifetime == 0 && sp->validtime == 0)
4443 if ((sp->lifetime &&
4444 now - sp->created > sp->lifetime) ||
4446 now - sp->lastused > sp->validtime)) {
4447 /* Hold extra reference to send SPDEXPIRE */
4449 LIST_INSERT_HEAD(&drainq, sp, drainq);
4454 if (LIST_EMPTY(&drainq))
4458 sp = LIST_FIRST(&drainq);
4459 while (sp != NULL) {
4460 nextsp = LIST_NEXT(sp, drainq);
4461 /* Check that SP is still linked */
4462 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4463 LIST_REMOVE(sp, drainq);
4464 key_freesp(&sp); /* release extra reference */
4468 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4470 LIST_REMOVE(sp, idhash);
4471 sp->state = IPSEC_SPSTATE_DEAD;
4476 if (SPDCACHE_ENABLED())
4479 sp = LIST_FIRST(&drainq);
4480 while (sp != NULL) {
4481 nextsp = LIST_NEXT(sp, drainq);
4483 key_freesp(&sp); /* release extra reference */
4484 key_freesp(&sp); /* release last reference */
4490 key_flush_sad(time_t now)
4492 SAHTREE_RLOCK_TRACKER;
4493 struct secashead_list emptyq;
4494 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4495 struct secashead *sah, *nextsah;
4496 struct secasvar *sav, *nextsav;
4499 LIST_INIT(&hexpireq);
4500 LIST_INIT(&sexpireq);
4504 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4505 /* Check for empty SAH */
4506 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4507 TAILQ_EMPTY(&sah->savtree_alive)) {
4509 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4512 /* Add all stale LARVAL SAs into drainq */
4513 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4514 if (now - sav->created < V_key_larval_lifetime)
4517 LIST_INSERT_HEAD(&drainq, sav, drainq);
4519 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4520 /* lifetimes aren't specified */
4521 if (sav->lft_h == NULL)
4525 * Check again with lock held, because it may
4526 * be updated by SADB_UPDATE.
4528 if (sav->lft_h == NULL) {
4529 SECASVAR_UNLOCK(sav);
4534 * HARD lifetimes MUST take precedence over SOFT
4535 * lifetimes, meaning if the HARD and SOFT lifetimes
4536 * are the same, the HARD lifetime will appear on the
4539 /* check HARD lifetime */
4540 if ((sav->lft_h->addtime != 0 &&
4541 now - sav->created > sav->lft_h->addtime) ||
4542 (sav->lft_h->usetime != 0 && sav->firstused &&
4543 now - sav->firstused > sav->lft_h->usetime) ||
4544 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4545 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4546 SECASVAR_UNLOCK(sav);
4548 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4551 /* check SOFT lifetime (only for MATURE SAs) */
4552 if (sav->state == SADB_SASTATE_MATURE && (
4553 (sav->lft_s->addtime != 0 &&
4554 now - sav->created > sav->lft_s->addtime) ||
4555 (sav->lft_s->usetime != 0 && sav->firstused &&
4556 now - sav->firstused > sav->lft_s->usetime) ||
4557 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4558 sav->lft_c_bytes) > sav->lft_s->bytes) ||
4559 (!(sav->flags & SADB_X_SAFLAGS_ESN) &&
4560 (sav->replay != NULL) && (
4561 (sav->replay->count > UINT32_80PCT) ||
4562 (sav->replay->last > UINT32_80PCT))))) {
4563 SECASVAR_UNLOCK(sav);
4565 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4568 SECASVAR_UNLOCK(sav);
4573 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4574 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4579 /* Unlink stale LARVAL SAs */
4580 sav = LIST_FIRST(&drainq);
4581 while (sav != NULL) {
4582 nextsav = LIST_NEXT(sav, drainq);
4583 /* Check that SA is still LARVAL */
4584 if (sav->state != SADB_SASTATE_LARVAL) {
4585 LIST_REMOVE(sav, drainq);
4586 LIST_INSERT_HEAD(&freeq, sav, drainq);
4590 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4591 LIST_REMOVE(sav, spihash);
4592 sav->state = SADB_SASTATE_DEAD;
4595 /* Unlink all SAs with expired HARD lifetime */
4596 sav = LIST_FIRST(&hexpireq);
4597 while (sav != NULL) {
4598 nextsav = LIST_NEXT(sav, drainq);
4599 /* Check that SA is not unlinked */
4600 if (sav->state == SADB_SASTATE_DEAD) {
4601 LIST_REMOVE(sav, drainq);
4602 LIST_INSERT_HEAD(&freeq, sav, drainq);
4606 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4607 LIST_REMOVE(sav, spihash);
4608 sav->state = SADB_SASTATE_DEAD;
4611 /* Mark all SAs with expired SOFT lifetime as DYING */
4612 sav = LIST_FIRST(&sexpireq);
4613 while (sav != NULL) {
4614 nextsav = LIST_NEXT(sav, drainq);
4615 /* Check that SA is not unlinked */
4616 if (sav->state == SADB_SASTATE_DEAD) {
4617 LIST_REMOVE(sav, drainq);
4618 LIST_INSERT_HEAD(&freeq, sav, drainq);
4623 * NOTE: this doesn't change SA order in the chain.
4625 sav->state = SADB_SASTATE_DYING;
4628 /* Unlink empty SAHs */
4629 sah = LIST_FIRST(&emptyq);
4630 while (sah != NULL) {
4631 nextsah = LIST_NEXT(sah, drainq);
4632 /* Check that SAH is still empty and not unlinked */
4633 if (sah->state == SADB_SASTATE_DEAD ||
4634 !TAILQ_EMPTY(&sah->savtree_larval) ||
4635 !TAILQ_EMPTY(&sah->savtree_alive)) {
4636 LIST_REMOVE(sah, drainq);
4637 key_freesah(&sah); /* release extra reference */
4641 TAILQ_REMOVE(&V_sahtree, sah, chain);
4642 LIST_REMOVE(sah, addrhash);
4643 sah->state = SADB_SASTATE_DEAD;
4648 /* Send SPDEXPIRE messages */
4649 sav = LIST_FIRST(&hexpireq);
4650 while (sav != NULL) {
4651 nextsav = LIST_NEXT(sav, drainq);
4653 key_freesah(&sav->sah); /* release reference from SAV */
4654 key_freesav(&sav); /* release extra reference */
4655 key_freesav(&sav); /* release last reference */
4658 sav = LIST_FIRST(&sexpireq);
4659 while (sav != NULL) {
4660 nextsav = LIST_NEXT(sav, drainq);
4662 key_freesav(&sav); /* release extra reference */
4665 /* Free stale LARVAL SAs */
4666 sav = LIST_FIRST(&drainq);
4667 while (sav != NULL) {
4668 nextsav = LIST_NEXT(sav, drainq);
4669 key_freesah(&sav->sah); /* release reference from SAV */
4670 key_freesav(&sav); /* release extra reference */
4671 key_freesav(&sav); /* release last reference */
4674 /* Free SAs that were unlinked/changed by someone else */
4675 sav = LIST_FIRST(&freeq);
4676 while (sav != NULL) {
4677 nextsav = LIST_NEXT(sav, drainq);
4678 key_freesav(&sav); /* release extra reference */
4681 /* Free empty SAH */
4682 sah = LIST_FIRST(&emptyq);
4683 while (sah != NULL) {
4684 nextsah = LIST_NEXT(sah, drainq);
4685 key_freesah(&sah); /* release extra reference */
4686 key_freesah(&sah); /* release last reference */
4692 key_flush_acq(time_t now)
4694 struct secacq *acq, *nextacq;
4698 acq = LIST_FIRST(&V_acqtree);
4699 while (acq != NULL) {
4700 nextacq = LIST_NEXT(acq, chain);
4701 if (now - acq->created > V_key_blockacq_lifetime) {
4702 LIST_REMOVE(acq, chain);
4703 LIST_REMOVE(acq, addrhash);
4704 LIST_REMOVE(acq, seqhash);
4705 free(acq, M_IPSEC_SAQ);
4713 key_flush_spacq(time_t now)
4715 struct secspacq *acq, *nextacq;
4719 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4720 nextacq = LIST_NEXT(acq, chain);
4721 if (now - acq->created > V_key_blockacq_lifetime
4722 && __LIST_CHAINED(acq)) {
4723 LIST_REMOVE(acq, chain);
4724 free(acq, M_IPSEC_SAQ);
4732 * scanning SPD and SAD to check status for each entries,
4733 * and do to remove or to expire.
4734 * XXX: year 2038 problem may remain.
4737 key_timehandler(void *arg)
4739 VNET_ITERATOR_DECL(vnet_iter);
4740 time_t now = time_second;
4742 VNET_LIST_RLOCK_NOSLEEP();
4743 VNET_FOREACH(vnet_iter) {
4744 CURVNET_SET(vnet_iter);
4748 key_flush_spacq(now);
4751 VNET_LIST_RUNLOCK_NOSLEEP();
4753 #ifndef IPSEC_DEBUG2
4754 /* do exchange to tick time !! */
4755 callout_schedule(&key_timer, hz);
4756 #endif /* IPSEC_DEBUG2 */
4764 arc4random_buf(&value, sizeof(value));
4769 * map SADB_SATYPE_* to IPPROTO_*.
4770 * if satype == SADB_SATYPE then satype is mapped to ~0.
4772 * 0: invalid satype.
4775 key_satype2proto(uint8_t satype)
4778 case SADB_SATYPE_UNSPEC:
4779 return IPSEC_PROTO_ANY;
4780 case SADB_SATYPE_AH:
4782 case SADB_SATYPE_ESP:
4784 case SADB_X_SATYPE_IPCOMP:
4785 return IPPROTO_IPCOMP;
4786 case SADB_X_SATYPE_TCPSIGNATURE:
4795 * map IPPROTO_* to SADB_SATYPE_*
4797 * 0: invalid protocol type.
4800 key_proto2satype(uint8_t proto)
4804 return SADB_SATYPE_AH;
4806 return SADB_SATYPE_ESP;
4807 case IPPROTO_IPCOMP:
4808 return SADB_X_SATYPE_IPCOMP;
4810 return SADB_X_SATYPE_TCPSIGNATURE;
4819 * SADB_GETSPI processing is to receive
4820 * <base, (SA2), src address, dst address, (SPI range)>
4821 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4822 * tree with the status of LARVAL, and send
4823 * <base, SA(*), address(SD)>
4826 * IN: mhp: pointer to the pointer to each header.
4827 * OUT: NULL if fail.
4828 * other if success, return pointer to the message to send.
4831 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4833 struct secasindex saidx;
4834 struct sadb_address *src0, *dst0;
4835 struct secasvar *sav;
4836 uint32_t reqid, spi;
4838 uint8_t mode, proto;
4840 IPSEC_ASSERT(so != NULL, ("null socket"));
4841 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4842 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4843 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4845 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4846 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4847 #ifdef PFKEY_STRICT_CHECKS
4848 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4851 ipseclog((LOG_DEBUG,
4852 "%s: invalid message: missing required header.\n",
4857 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4858 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4859 #ifdef PFKEY_STRICT_CHECKS
4860 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4863 ipseclog((LOG_DEBUG,
4864 "%s: invalid message: wrong header size.\n", __func__));
4868 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4869 mode = IPSEC_MODE_ANY;
4872 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4873 ipseclog((LOG_DEBUG,
4874 "%s: invalid message: wrong header size.\n",
4879 mode = ((struct sadb_x_sa2 *)
4880 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4881 reqid = ((struct sadb_x_sa2 *)
4882 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4885 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4886 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4888 /* map satype to proto */
4889 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4890 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4895 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4896 (struct sockaddr *)(dst0 + 1));
4898 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4902 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4904 /* SPI allocation */
4905 spi = key_do_getnewspi(
4906 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4909 * Requested SPI or SPI range is not available or
4915 sav = key_newsav(mhp, &saidx, spi, &error);
4919 if (sav->seq != 0) {
4922 * If the SADB_GETSPI message is in response to a
4923 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4924 * MUST be the same as the SADB_ACQUIRE message.
4926 * XXXAE: However it doesn't definethe behaviour how to
4927 * check this and what to do if it doesn't match.
4928 * Also what we should do if it matches?
4930 * We can compare saidx used in SADB_ACQUIRE with saidx
4931 * used in SADB_GETSPI, but this probably can break
4932 * existing software. For now just warn if it doesn't match.
4934 * XXXAE: anyway it looks useless.
4936 key_acqdone(&saidx, sav->seq);
4939 printf("%s: SA(%p)\n", __func__, sav));
4940 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4943 struct mbuf *n, *nn;
4944 struct sadb_sa *m_sa;
4945 struct sadb_msg *newmsg;
4948 /* create new sadb_msg to reply. */
4949 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4950 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4952 MGETHDR(n, M_NOWAIT, MT_DATA);
4954 if (!(MCLGET(n, M_NOWAIT))) {
4968 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
4969 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
4971 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
4972 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
4973 m_sa->sadb_sa_exttype = SADB_EXT_SA;
4974 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
4975 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
4977 IPSEC_ASSERT(off == len,
4978 ("length inconsistency (off %u len %u)", off, len));
4980 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
4981 SADB_EXT_ADDRESS_DST);
4988 if (n->m_len < sizeof(struct sadb_msg)) {
4989 n = m_pullup(n, sizeof(struct sadb_msg));
4991 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
4994 n->m_pkthdr.len = 0;
4995 for (nn = n; nn; nn = nn->m_next)
4996 n->m_pkthdr.len += nn->m_len;
4998 newmsg = mtod(n, struct sadb_msg *);
4999 newmsg->sadb_msg_seq = sav->seq;
5000 newmsg->sadb_msg_errno = 0;
5001 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
5004 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
5008 return (key_senderror(so, m, error));
5012 * allocating new SPI
5013 * called by key_getspi().
5016 * others: success, SPI in network byte order.
5019 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
5021 uint32_t min, max, newspi, t;
5022 int count = V_key_spi_trycnt;
5024 /* set spi range to allocate */
5025 if (spirange != NULL) {
5026 min = spirange->sadb_spirange_min;
5027 max = spirange->sadb_spirange_max;
5029 min = V_key_spi_minval;
5030 max = V_key_spi_maxval;
5032 /* IPCOMP needs 2-byte SPI */
5033 if (saidx->proto == IPPROTO_IPCOMP) {
5039 t = min; min = max; max = t;
5044 if (!key_checkspidup(htonl(min))) {
5045 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
5050 count--; /* taking one cost. */
5056 /* when requesting to allocate spi ranged */
5058 /* generate pseudo-random SPI value ranged. */
5059 newspi = min + (key_random() % (max - min + 1));
5060 if (!key_checkspidup(htonl(newspi)))
5064 if (count == 0 || newspi == 0) {
5065 ipseclog((LOG_DEBUG,
5066 "%s: failed to allocate SPI.\n", __func__));
5072 keystat.getspi_count =
5073 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
5075 return (htonl(newspi));
5079 * Find TCP-MD5 SA with corresponding secasindex.
5080 * If not found, return NULL and fill SPI with usable value if needed.
5082 static struct secasvar *
5083 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
5085 SAHTREE_RLOCK_TRACKER;
5086 struct secashead *sah;
5087 struct secasvar *sav;
5089 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
5091 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5092 if (sah->saidx.proto != IPPROTO_TCP)
5094 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
5095 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
5099 if (V_key_preferred_oldsa)
5100 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
5102 sav = TAILQ_FIRST(&sah->savtree_alive);
5110 /* No SPI required */
5114 /* Check that SPI is unique */
5115 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5116 if (sav->spi == *spi)
5121 /* SPI is already unique */
5125 /* XXX: not optimal */
5126 *spi = key_do_getnewspi(NULL, saidx);
5131 key_updateaddresses(struct socket *so, struct mbuf *m,
5132 const struct sadb_msghdr *mhp, struct secasvar *sav,
5133 struct secasindex *saidx)
5135 struct sockaddr *newaddr;
5136 struct secashead *sah;
5137 struct secasvar *newsav, *tmp;
5141 /* Check that we need to change SAH */
5142 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5143 newaddr = (struct sockaddr *)(
5144 ((struct sadb_address *)
5145 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5146 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5147 key_porttosaddr(&saidx->src.sa, 0);
5149 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5150 newaddr = (struct sockaddr *)(
5151 ((struct sadb_address *)
5152 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5153 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5154 key_porttosaddr(&saidx->dst.sa, 0);
5156 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5157 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5158 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5160 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5165 sah = key_getsah(saidx);
5167 /* create a new SA index */
5168 sah = key_newsah(saidx);
5170 ipseclog((LOG_DEBUG,
5171 "%s: No more memory.\n", __func__));
5174 isnew = 2; /* SAH is new */
5176 isnew = 1; /* existing SAH is referenced */
5179 * src and dst addresses are still the same.
5180 * Do we want to change NAT-T config?
5182 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5183 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5184 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5185 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5186 ipseclog((LOG_DEBUG,
5187 "%s: invalid message: missing required header.\n",
5191 /* We hold reference to SA, thus SAH will be referenced too. */
5196 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5198 if (newsav == NULL) {
5199 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5204 /* Clone SA's content into newsav */
5205 SAV_INITREF(newsav);
5206 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5208 * We create new NAT-T config if it is needed.
5209 * Old NAT-T config will be freed by key_cleansav() when
5210 * last reference to SA will be released.
5212 newsav->natt = NULL;
5214 newsav->state = SADB_SASTATE_MATURE;
5215 error = key_setnatt(newsav, mhp);
5220 /* Check that SA is still alive */
5221 if (sav->state == SADB_SASTATE_DEAD) {
5222 /* SA was unlinked */
5228 /* Unlink SA from SAH and SPI hash */
5229 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5230 ("SA is already cloned"));
5231 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5232 sav->state == SADB_SASTATE_DYING,
5233 ("Wrong SA state %u\n", sav->state));
5234 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5235 LIST_REMOVE(sav, spihash);
5236 sav->state = SADB_SASTATE_DEAD;
5239 * Link new SA with SAH. Keep SAs ordered by
5240 * create time (newer are first).
5242 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5243 if (newsav->created > tmp->created) {
5244 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5249 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5251 /* Add new SA into SPI hash. */
5252 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5254 /* Add new SAH into SADB. */
5256 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5257 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5258 sah->state = SADB_SASTATE_MATURE;
5259 SAH_ADDREF(sah); /* newsav references new SAH */
5262 * isnew == 1 -> @sah was referenced by key_getsah().
5263 * isnew == 0 -> we use the same @sah, that was used by @sav,
5264 * and we use its reference for @newsav.
5267 /* XXX: replace cntr with pointer? */
5268 newsav->cntr = sav->cntr;
5269 sav->flags |= SADB_X_EXT_F_CLONED;
5270 SECASVAR_UNLOCK(sav);
5275 printf("%s: SA(%p) cloned into SA(%p)\n",
5276 __func__, sav, newsav));
5277 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5279 key_freesav(&sav); /* release last reference */
5281 /* set msg buf from mhp */
5282 n = key_getmsgbuf_x1(m, mhp);
5284 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5288 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5293 if (newsav != NULL) {
5294 if (newsav->natt != NULL)
5295 free(newsav->natt, M_IPSEC_MISC);
5296 free(newsav, M_IPSEC_SA);
5302 * SADB_UPDATE processing
5304 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5305 * key(AE), (identity(SD),) (sensitivity)>
5306 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5308 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5309 * (identity(SD),) (sensitivity)>
5312 * m will always be freed.
5315 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5317 struct secasindex saidx;
5318 struct sadb_address *src0, *dst0;
5319 struct sadb_sa *sa0;
5320 struct secasvar *sav;
5323 uint8_t mode, proto;
5325 IPSEC_ASSERT(so != NULL, ("null socket"));
5326 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5327 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5328 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5330 /* map satype to proto */
5331 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5332 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5334 return key_senderror(so, m, EINVAL);
5337 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5338 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5339 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5340 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5341 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5342 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5343 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5344 ipseclog((LOG_DEBUG,
5345 "%s: invalid message: missing required header.\n",
5347 return key_senderror(so, m, EINVAL);
5349 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5350 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5351 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5352 ipseclog((LOG_DEBUG,
5353 "%s: invalid message: wrong header size.\n", __func__));
5354 return key_senderror(so, m, EINVAL);
5356 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5357 mode = IPSEC_MODE_ANY;
5360 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5361 ipseclog((LOG_DEBUG,
5362 "%s: invalid message: wrong header size.\n",
5364 return key_senderror(so, m, EINVAL);
5366 mode = ((struct sadb_x_sa2 *)
5367 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5368 reqid = ((struct sadb_x_sa2 *)
5369 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5372 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5373 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5374 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5377 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5378 * SADB_UPDATE message.
5380 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5381 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5382 #ifdef PFKEY_STRICT_CHECKS
5383 return key_senderror(so, m, EINVAL);
5386 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5387 (struct sockaddr *)(dst0 + 1));
5389 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5390 return key_senderror(so, m, error);
5392 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5393 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5395 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5396 __func__, ntohl(sa0->sadb_sa_spi)));
5397 return key_senderror(so, m, EINVAL);
5400 * Check that SADB_UPDATE issued by the same process that did
5401 * SADB_GETSPI or SADB_ADD.
5403 if (sav->pid != mhp->msg->sadb_msg_pid) {
5404 ipseclog((LOG_DEBUG,
5405 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5406 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5408 return key_senderror(so, m, EINVAL);
5410 /* saidx should match with SA. */
5411 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5412 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u\n",
5413 __func__, ntohl(sav->spi)));
5415 return key_senderror(so, m, ESRCH);
5418 if (sav->state == SADB_SASTATE_LARVAL) {
5419 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5420 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5421 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5422 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5423 ipseclog((LOG_DEBUG,
5424 "%s: invalid message: missing required header.\n",
5427 return key_senderror(so, m, EINVAL);
5430 * We can set any values except src, dst and SPI.
5432 error = key_setsaval(sav, mhp);
5435 return (key_senderror(so, m, error));
5437 /* Change SA state to MATURE */
5439 if (sav->state != SADB_SASTATE_LARVAL) {
5440 /* SA was deleted or another thread made it MATURE. */
5443 return (key_senderror(so, m, ESRCH));
5446 * NOTE: we keep SAs in savtree_alive ordered by created
5447 * time. When SA's state changed from LARVAL to MATURE,
5448 * we update its created time in key_setsaval() and move
5449 * it into head of savtree_alive.
5451 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5452 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5453 sav->state = SADB_SASTATE_MATURE;
5457 * For DYING and MATURE SA we can change only state
5458 * and lifetimes. Report EINVAL if something else attempted
5461 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5462 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5464 return (key_senderror(so, m, EINVAL));
5466 error = key_updatelifetimes(sav, mhp);
5469 return (key_senderror(so, m, error));
5472 * This is FreeBSD extension to RFC2367.
5473 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5474 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5475 * SA addresses (for example to implement MOBIKE protocol
5476 * as described in RFC4555). Also we allow to change
5479 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5480 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5481 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5482 sav->natt != NULL) {
5483 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5486 return (key_senderror(so, m, error));
5489 /* Check that SA is still alive */
5491 if (sav->state == SADB_SASTATE_DEAD) {
5492 /* SA was unlinked */
5495 return (key_senderror(so, m, ESRCH));
5498 * NOTE: there is possible state moving from DYING to MATURE,
5499 * but this doesn't change created time, so we won't reorder
5502 sav->state = SADB_SASTATE_MATURE;
5506 printf("%s: SA(%p)\n", __func__, sav));
5507 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5513 /* set msg buf from mhp */
5514 n = key_getmsgbuf_x1(m, mhp);
5516 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5517 return key_senderror(so, m, ENOBUFS);
5521 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5526 * SADB_ADD processing
5527 * add an entry to SA database, when received
5528 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5529 * key(AE), (identity(SD),) (sensitivity)>
5532 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5533 * (identity(SD),) (sensitivity)>
5536 * IGNORE identity and sensitivity messages.
5538 * m will always be freed.
5541 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5543 struct secasindex saidx;
5544 struct sadb_address *src0, *dst0;
5545 struct sadb_sa *sa0;
5546 struct secasvar *sav;
5547 uint32_t reqid, spi;
5548 uint8_t mode, proto;
5551 IPSEC_ASSERT(so != NULL, ("null socket"));
5552 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5553 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5554 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5556 /* map satype to proto */
5557 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5558 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5560 return key_senderror(so, m, EINVAL);
5563 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5564 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5565 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5566 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5567 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5568 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5569 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5570 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5571 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5572 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5573 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5574 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5575 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5576 ipseclog((LOG_DEBUG,
5577 "%s: invalid message: missing required header.\n",
5579 return key_senderror(so, m, EINVAL);
5581 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5582 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5583 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5584 ipseclog((LOG_DEBUG,
5585 "%s: invalid message: wrong header size.\n", __func__));
5586 return key_senderror(so, m, EINVAL);
5588 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5589 mode = IPSEC_MODE_ANY;
5592 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5593 ipseclog((LOG_DEBUG,
5594 "%s: invalid message: wrong header size.\n",
5596 return key_senderror(so, m, EINVAL);
5598 mode = ((struct sadb_x_sa2 *)
5599 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5600 reqid = ((struct sadb_x_sa2 *)
5601 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5604 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5605 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5606 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5609 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5612 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5613 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5614 #ifdef PFKEY_STRICT_CHECKS
5615 return key_senderror(so, m, EINVAL);
5618 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5619 (struct sockaddr *)(dst0 + 1));
5621 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5622 return key_senderror(so, m, error);
5624 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5625 spi = sa0->sadb_sa_spi;
5627 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5629 * XXXAE: IPComp seems also doesn't use SPI.
5631 if (proto == IPPROTO_TCP) {
5632 sav = key_getsav_tcpmd5(&saidx, &spi);
5633 if (sav == NULL && spi == 0) {
5634 /* Failed to allocate SPI */
5635 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5637 return key_senderror(so, m, EEXIST);
5639 /* XXX: SPI that we report back can have another value */
5641 /* We can create new SA only if SPI is different. */
5642 sav = key_getsavbyspi(spi);
5646 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5647 return key_senderror(so, m, EEXIST);
5650 sav = key_newsav(mhp, &saidx, spi, &error);
5652 return key_senderror(so, m, error);
5654 printf("%s: return SA(%p)\n", __func__, sav));
5655 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5657 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5661 key_acqdone(&saidx, sav->seq);
5665 * Don't call key_freesav() on error here, as we would like to
5666 * keep the SA in the database.
5670 /* set msg buf from mhp */
5671 n = key_getmsgbuf_x1(m, mhp);
5673 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5674 return key_senderror(so, m, ENOBUFS);
5678 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5684 * IKEd may request the use ESP in UDP encapsulation when it detects the
5685 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5686 * parameters needed for encapsulation and decapsulation. These PF_KEY
5687 * extension headers are not standardized, so this comment addresses our
5689 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5690 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5691 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5692 * UDP header. We use these ports in UDP encapsulation procedure, also we
5693 * can check them in UDP decapsulation procedure.
5694 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5695 * responder. These addresses can be used for transport mode to adjust
5696 * checksum after decapsulation and decryption. Since original IP addresses
5697 * used by peer usually different (we detected presence of NAT), TCP/UDP
5698 * pseudo header checksum and IP header checksum was calculated using original
5699 * addresses. After decapsulation and decryption we need to adjust checksum
5700 * to have correct datagram.
5702 * We expect presence of NAT-T extension headers only in SADB_ADD and
5703 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5704 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5707 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5709 struct sadb_x_nat_t_port *port;
5710 struct sadb_x_nat_t_type *type;
5711 struct sadb_address *oai, *oar;
5712 struct sockaddr *sa;
5716 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5718 * Ignore NAT-T headers if sproto isn't ESP.
5720 if (sav->sah->saidx.proto != IPPROTO_ESP)
5723 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5724 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5725 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5726 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5727 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5728 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5729 ipseclog((LOG_DEBUG,
5730 "%s: invalid message: wrong header size.\n",
5737 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5738 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5739 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5740 __func__, type->sadb_x_nat_t_type_type));
5744 * Allocate storage for NAT-T config.
5745 * On error it will be released by key_cleansav().
5747 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5749 if (sav->natt == NULL) {
5750 PFKEYSTAT_INC(in_nomem);
5751 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5754 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5755 if (port->sadb_x_nat_t_port_port == 0) {
5756 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5760 sav->natt->sport = port->sadb_x_nat_t_port_port;
5761 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5762 if (port->sadb_x_nat_t_port_port == 0) {
5763 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5767 sav->natt->dport = port->sadb_x_nat_t_port_port;
5770 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5771 * and needed only for transport mode IPsec.
5772 * Usually NAT translates only one address, but it is possible,
5773 * that both addresses could be translated.
5774 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5776 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5777 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5778 ipseclog((LOG_DEBUG,
5779 "%s: invalid message: wrong header size.\n",
5783 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5786 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5787 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5788 ipseclog((LOG_DEBUG,
5789 "%s: invalid message: wrong header size.\n",
5793 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5797 /* Initialize addresses only for transport mode */
5798 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5801 /* Currently we support only AF_INET */
5802 sa = (struct sockaddr *)(oai + 1);
5803 if (sa->sa_family != AF_INET ||
5804 sa->sa_len != sizeof(struct sockaddr_in)) {
5805 ipseclog((LOG_DEBUG,
5806 "%s: wrong NAT-OAi header.\n",
5810 /* Ignore address if it the same */
5811 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5812 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5813 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5814 sav->natt->flags |= IPSEC_NATT_F_OAI;
5815 /* Calculate checksum delta */
5816 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5817 cksum = in_addword(cksum, ~addr >> 16);
5818 cksum = in_addword(cksum, ~addr & 0xffff);
5819 addr = sav->natt->oai.sin.sin_addr.s_addr;
5820 cksum = in_addword(cksum, addr >> 16);
5821 cksum = in_addword(cksum, addr & 0xffff);
5825 /* Currently we support only AF_INET */
5826 sa = (struct sockaddr *)(oar + 1);
5827 if (sa->sa_family != AF_INET ||
5828 sa->sa_len != sizeof(struct sockaddr_in)) {
5829 ipseclog((LOG_DEBUG,
5830 "%s: wrong NAT-OAr header.\n",
5834 /* Ignore address if it the same */
5835 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5836 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5837 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5838 sav->natt->flags |= IPSEC_NATT_F_OAR;
5839 /* Calculate checksum delta */
5840 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5841 cksum = in_addword(cksum, ~addr >> 16);
5842 cksum = in_addword(cksum, ~addr & 0xffff);
5843 addr = sav->natt->oar.sin.sin_addr.s_addr;
5844 cksum = in_addword(cksum, addr >> 16);
5845 cksum = in_addword(cksum, addr & 0xffff);
5848 sav->natt->cksum = cksum;
5854 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5856 const struct sadb_ident *idsrc, *iddst;
5858 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5859 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5860 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5862 /* don't make buffer if not there */
5863 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5864 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5870 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5871 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5872 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5876 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5877 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5879 /* validity check */
5880 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5881 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5885 switch (idsrc->sadb_ident_type) {
5886 case SADB_IDENTTYPE_PREFIX:
5887 case SADB_IDENTTYPE_FQDN:
5888 case SADB_IDENTTYPE_USERFQDN:
5890 /* XXX do nothing */
5896 /* make structure */
5897 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5898 if (sah->idents == NULL) {
5899 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5902 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5903 if (sah->identd == NULL) {
5904 free(sah->idents, M_IPSEC_MISC);
5906 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5909 sah->idents->type = idsrc->sadb_ident_type;
5910 sah->idents->id = idsrc->sadb_ident_id;
5912 sah->identd->type = iddst->sadb_ident_type;
5913 sah->identd->id = iddst->sadb_ident_id;
5919 * m will not be freed on return.
5920 * it is caller's responsibility to free the result.
5922 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5923 * from the request in defined order.
5925 static struct mbuf *
5926 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5930 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5931 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5932 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5934 /* create new sadb_msg to reply. */
5935 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5936 SADB_EXT_SA, SADB_X_EXT_SA2,
5937 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5938 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5939 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5940 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5941 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5942 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5943 SADB_X_EXT_NEW_ADDRESS_DST);
5947 if (n->m_len < sizeof(struct sadb_msg)) {
5948 n = m_pullup(n, sizeof(struct sadb_msg));
5952 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5953 mtod(n, struct sadb_msg *)->sadb_msg_len =
5954 PFKEY_UNIT64(n->m_pkthdr.len);
5960 * SADB_DELETE processing
5962 * <base, SA(*), address(SD)>
5963 * from the ikmpd, and set SADB_SASTATE_DEAD,
5965 * <base, SA(*), address(SD)>
5968 * m will always be freed.
5971 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5973 struct secasindex saidx;
5974 struct sadb_address *src0, *dst0;
5975 struct secasvar *sav;
5976 struct sadb_sa *sa0;
5979 IPSEC_ASSERT(so != NULL, ("null socket"));
5980 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5981 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5982 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5984 /* map satype to proto */
5985 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5986 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5988 return key_senderror(so, m, EINVAL);
5991 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5992 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5993 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5994 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5995 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
5997 return key_senderror(so, m, EINVAL);
6000 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
6001 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
6003 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6004 (struct sockaddr *)(dst0 + 1)) != 0) {
6005 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6006 return (key_senderror(so, m, EINVAL));
6008 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6009 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
6011 * Caller wants us to delete all non-LARVAL SAs
6012 * that match the src/dst. This is used during
6013 * IKE INITIAL-CONTACT.
6014 * XXXAE: this looks like some extension to RFC2367.
6016 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
6017 return (key_delete_all(so, m, mhp, &saidx));
6019 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
6020 ipseclog((LOG_DEBUG,
6021 "%s: invalid message: wrong header size.\n", __func__));
6022 return (key_senderror(so, m, EINVAL));
6024 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6025 if (proto == IPPROTO_TCP)
6026 sav = key_getsav_tcpmd5(&saidx, NULL);
6028 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6030 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
6031 __func__, ntohl(sa0->sadb_sa_spi)));
6032 return (key_senderror(so, m, ESRCH));
6034 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6035 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6036 __func__, ntohl(sav->spi)));
6038 return (key_senderror(so, m, ESRCH));
6041 printf("%s: SA(%p)\n", __func__, sav));
6042 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6048 struct sadb_msg *newmsg;
6050 /* create new sadb_msg to reply. */
6051 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
6052 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6054 return key_senderror(so, m, ENOBUFS);
6056 if (n->m_len < sizeof(struct sadb_msg)) {
6057 n = m_pullup(n, sizeof(struct sadb_msg));
6059 return key_senderror(so, m, ENOBUFS);
6061 newmsg = mtod(n, struct sadb_msg *);
6062 newmsg->sadb_msg_errno = 0;
6063 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6066 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6071 * delete all SAs for src/dst. Called from key_delete().
6074 key_delete_all(struct socket *so, struct mbuf *m,
6075 const struct sadb_msghdr *mhp, struct secasindex *saidx)
6077 struct secasvar_queue drainq;
6078 struct secashead *sah;
6079 struct secasvar *sav, *nextsav;
6081 TAILQ_INIT(&drainq);
6083 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
6084 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
6086 /* Move all ALIVE SAs into drainq */
6087 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6089 /* Unlink all queued SAs from SPI hash */
6090 TAILQ_FOREACH(sav, &drainq, chain) {
6091 sav->state = SADB_SASTATE_DEAD;
6092 LIST_REMOVE(sav, spihash);
6095 /* Now we can release reference for all SAs in drainq */
6096 sav = TAILQ_FIRST(&drainq);
6097 while (sav != NULL) {
6099 printf("%s: SA(%p)\n", __func__, sav));
6100 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6101 nextsav = TAILQ_NEXT(sav, chain);
6102 key_freesah(&sav->sah); /* release reference from SAV */
6103 key_freesav(&sav); /* release last reference */
6109 struct sadb_msg *newmsg;
6111 /* create new sadb_msg to reply. */
6112 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6113 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6115 return key_senderror(so, m, ENOBUFS);
6117 if (n->m_len < sizeof(struct sadb_msg)) {
6118 n = m_pullup(n, sizeof(struct sadb_msg));
6120 return key_senderror(so, m, ENOBUFS);
6122 newmsg = mtod(n, struct sadb_msg *);
6123 newmsg->sadb_msg_errno = 0;
6124 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6127 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6132 * Delete all alive SAs for corresponding xform.
6133 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6134 * here when xform disappears.
6137 key_delete_xform(const struct xformsw *xsp)
6139 struct secasvar_queue drainq;
6140 struct secashead *sah;
6141 struct secasvar *sav, *nextsav;
6143 TAILQ_INIT(&drainq);
6145 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6146 sav = TAILQ_FIRST(&sah->savtree_alive);
6149 if (sav->tdb_xform != xsp)
6152 * It is supposed that all SAs in the chain are related to
6155 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6157 /* Unlink all queued SAs from SPI hash */
6158 TAILQ_FOREACH(sav, &drainq, chain) {
6159 sav->state = SADB_SASTATE_DEAD;
6160 LIST_REMOVE(sav, spihash);
6164 /* Now we can release reference for all SAs in drainq */
6165 sav = TAILQ_FIRST(&drainq);
6166 while (sav != NULL) {
6168 printf("%s: SA(%p)\n", __func__, sav));
6169 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6170 nextsav = TAILQ_NEXT(sav, chain);
6171 key_freesah(&sav->sah); /* release reference from SAV */
6172 key_freesav(&sav); /* release last reference */
6178 * SADB_GET processing
6180 * <base, SA(*), address(SD)>
6181 * from the ikmpd, and get a SP and a SA to respond,
6183 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6184 * (identity(SD),) (sensitivity)>
6187 * m will always be freed.
6190 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6192 struct secasindex saidx;
6193 struct sadb_address *src0, *dst0;
6194 struct sadb_sa *sa0;
6195 struct secasvar *sav;
6198 IPSEC_ASSERT(so != NULL, ("null socket"));
6199 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6200 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6201 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6203 /* map satype to proto */
6204 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6205 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6207 return key_senderror(so, m, EINVAL);
6210 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6211 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6212 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6213 ipseclog((LOG_DEBUG,
6214 "%s: invalid message: missing required header.\n",
6216 return key_senderror(so, m, EINVAL);
6218 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6219 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6220 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6221 ipseclog((LOG_DEBUG,
6222 "%s: invalid message: wrong header size.\n", __func__));
6223 return key_senderror(so, m, EINVAL);
6226 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6227 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6228 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6230 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6231 (struct sockaddr *)(dst0 + 1)) != 0) {
6232 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6233 return key_senderror(so, m, EINVAL);
6235 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6237 if (proto == IPPROTO_TCP)
6238 sav = key_getsav_tcpmd5(&saidx, NULL);
6240 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6242 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6243 return key_senderror(so, m, ESRCH);
6245 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6246 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6247 __func__, ntohl(sa0->sadb_sa_spi)));
6249 return (key_senderror(so, m, ESRCH));
6256 /* map proto to satype */
6257 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6258 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6261 return key_senderror(so, m, EINVAL);
6264 /* create new sadb_msg to reply. */
6265 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6266 mhp->msg->sadb_msg_pid);
6270 return key_senderror(so, m, ENOBUFS);
6273 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6277 /* XXX make it sysctl-configurable? */
6279 key_getcomb_setlifetime(struct sadb_comb *comb)
6282 comb->sadb_comb_soft_allocations = 1;
6283 comb->sadb_comb_hard_allocations = 1;
6284 comb->sadb_comb_soft_bytes = 0;
6285 comb->sadb_comb_hard_bytes = 0;
6286 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6287 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6288 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6289 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6293 * XXX reorder combinations by preference
6294 * XXX no idea if the user wants ESP authentication or not
6296 static struct mbuf *
6297 key_getcomb_ealg(void)
6299 struct sadb_comb *comb;
6300 const struct enc_xform *algo;
6301 struct mbuf *result = NULL, *m, *n;
6305 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6308 for (i = 1; i <= SADB_EALG_MAX; i++) {
6309 algo = enc_algorithm_lookup(i);
6313 /* discard algorithms with key size smaller than system min */
6314 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6316 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6317 encmin = V_ipsec_esp_keymin;
6319 encmin = _BITS(algo->minkey);
6321 if (V_ipsec_esp_auth)
6322 m = key_getcomb_ah();
6324 IPSEC_ASSERT(l <= MLEN,
6325 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6326 MGET(m, M_NOWAIT, MT_DATA);
6331 bzero(mtod(m, caddr_t), m->m_len);
6338 for (n = m; n; n = n->m_next)
6340 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6342 for (off = 0; off < totlen; off += l) {
6343 n = m_pulldown(m, off, l, &o);
6345 /* m is already freed */
6348 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6349 bzero(comb, sizeof(*comb));
6350 key_getcomb_setlifetime(comb);
6351 comb->sadb_comb_encrypt = i;
6352 comb->sadb_comb_encrypt_minbits = encmin;
6353 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6371 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6375 *min = *max = ah->hashsize;
6376 if (ah->keysize == 0) {
6378 * Transform takes arbitrary key size but algorithm
6379 * key size is restricted. Enforce this here.
6382 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6383 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6384 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6385 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6387 DPRINTF(("%s: unknown AH algorithm %u\n",
6395 * XXX reorder combinations by preference
6397 static struct mbuf *
6400 const struct auth_hash *algo;
6401 struct sadb_comb *comb;
6403 u_int16_t minkeysize, maxkeysize;
6405 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6408 for (i = 1; i <= SADB_AALG_MAX; i++) {
6410 /* we prefer HMAC algorithms, not old algorithms */
6411 if (i != SADB_AALG_SHA1HMAC &&
6412 i != SADB_X_AALG_SHA2_256 &&
6413 i != SADB_X_AALG_SHA2_384 &&
6414 i != SADB_X_AALG_SHA2_512)
6417 algo = auth_algorithm_lookup(i);
6420 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6421 /* discard algorithms with key size smaller than system min */
6422 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6426 IPSEC_ASSERT(l <= MLEN,
6427 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6428 MGET(m, M_NOWAIT, MT_DATA);
6435 M_PREPEND(m, l, M_NOWAIT);
6439 comb = mtod(m, struct sadb_comb *);
6440 bzero(comb, sizeof(*comb));
6441 key_getcomb_setlifetime(comb);
6442 comb->sadb_comb_auth = i;
6443 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6444 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6451 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6452 * XXX reorder combinations by preference
6454 static struct mbuf *
6455 key_getcomb_ipcomp()
6457 const struct comp_algo *algo;
6458 struct sadb_comb *comb;
6461 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6464 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6465 algo = comp_algorithm_lookup(i);
6470 IPSEC_ASSERT(l <= MLEN,
6471 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6472 MGET(m, M_NOWAIT, MT_DATA);
6479 M_PREPEND(m, l, M_NOWAIT);
6483 comb = mtod(m, struct sadb_comb *);
6484 bzero(comb, sizeof(*comb));
6485 key_getcomb_setlifetime(comb);
6486 comb->sadb_comb_encrypt = i;
6487 /* what should we set into sadb_comb_*_{min,max}bits? */
6494 * XXX no way to pass mode (transport/tunnel) to userland
6495 * XXX replay checking?
6496 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6498 static struct mbuf *
6499 key_getprop(const struct secasindex *saidx)
6501 struct sadb_prop *prop;
6503 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6506 switch (saidx->proto) {
6508 m = key_getcomb_ealg();
6511 m = key_getcomb_ah();
6513 case IPPROTO_IPCOMP:
6514 m = key_getcomb_ipcomp();
6522 M_PREPEND(m, l, M_NOWAIT);
6527 for (n = m; n; n = n->m_next)
6530 prop = mtod(m, struct sadb_prop *);
6531 bzero(prop, sizeof(*prop));
6532 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6533 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6534 prop->sadb_prop_replay = 32; /* XXX */
6540 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6542 * <base, SA, address(SD), (address(P)), x_policy,
6543 * (identity(SD),) (sensitivity,) proposal>
6544 * to KMD, and expect to receive
6545 * <base> with SADB_ACQUIRE if error occurred,
6547 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6548 * from KMD by PF_KEY.
6550 * XXX x_policy is outside of RFC2367 (KAME extension).
6551 * XXX sensitivity is not supported.
6552 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6553 * see comment for key_getcomb_ipcomp().
6557 * others: error number
6560 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6562 union sockaddr_union addr;
6563 struct mbuf *result, *m;
6567 uint8_t mask, satype;
6569 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6570 satype = key_proto2satype(saidx->proto);
6571 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6575 ul_proto = IPSEC_ULPROTO_ANY;
6577 /* Get seq number to check whether sending message or not. */
6578 seq = key_getacq(saidx, &error);
6582 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6590 * set sadb_address for saidx's.
6592 * Note that if sp is supplied, then we're being called from
6593 * key_allocsa_policy() and should supply port and protocol
6595 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6596 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6597 * XXXAE: it looks like we should save this info in the ACQ entry.
6599 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6600 sp->spidx.ul_proto == IPPROTO_UDP))
6601 ul_proto = sp->spidx.ul_proto;
6605 if (ul_proto != IPSEC_ULPROTO_ANY) {
6606 switch (sp->spidx.src.sa.sa_family) {
6608 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6609 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6610 mask = sp->spidx.prefs;
6614 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6615 addr.sin6.sin6_port =
6616 sp->spidx.src.sin6.sin6_port;
6617 mask = sp->spidx.prefs;
6624 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6633 if (ul_proto != IPSEC_ULPROTO_ANY) {
6634 switch (sp->spidx.dst.sa.sa_family) {
6636 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6637 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6638 mask = sp->spidx.prefd;
6642 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6643 addr.sin6.sin6_port =
6644 sp->spidx.dst.sin6.sin6_port;
6645 mask = sp->spidx.prefd;
6652 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6659 /* XXX proxy address (optional) */
6662 * Set sadb_x_policy. This is KAME extension to RFC2367.
6665 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6675 * Set sadb_x_sa2 extension if saidx->reqid is not zero.
6676 * This is FreeBSD extension to RFC2367.
6678 if (saidx->reqid != 0) {
6679 m = key_setsadbxsa2(saidx->mode, 0, saidx->reqid);
6686 /* XXX identity (optional) */
6688 if (idexttype && fqdn) {
6689 /* create identity extension (FQDN) */
6690 struct sadb_ident *id;
6693 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6694 id = (struct sadb_ident *)p;
6695 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6696 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6697 id->sadb_ident_exttype = idexttype;
6698 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6699 bcopy(fqdn, id + 1, fqdnlen);
6700 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6704 /* create identity extension (USERFQDN) */
6705 struct sadb_ident *id;
6709 /* +1 for terminating-NUL */
6710 userfqdnlen = strlen(userfqdn) + 1;
6713 id = (struct sadb_ident *)p;
6714 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6715 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6716 id->sadb_ident_exttype = idexttype;
6717 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6718 /* XXX is it correct? */
6719 if (curproc && curproc->p_cred)
6720 id->sadb_ident_id = curproc->p_cred->p_ruid;
6721 if (userfqdn && userfqdnlen)
6722 bcopy(userfqdn, id + 1, userfqdnlen);
6723 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6727 /* XXX sensitivity (optional) */
6729 /* create proposal/combination extension */
6730 m = key_getprop(saidx);
6733 * spec conformant: always attach proposal/combination extension,
6734 * the problem is that we have no way to attach it for ipcomp,
6735 * due to the way sadb_comb is declared in RFC2367.
6744 * outside of spec; make proposal/combination extension optional.
6750 if ((result->m_flags & M_PKTHDR) == 0) {
6755 if (result->m_len < sizeof(struct sadb_msg)) {
6756 result = m_pullup(result, sizeof(struct sadb_msg));
6757 if (result == NULL) {
6763 result->m_pkthdr.len = 0;
6764 for (m = result; m; m = m->m_next)
6765 result->m_pkthdr.len += m->m_len;
6767 mtod(result, struct sadb_msg *)->sadb_msg_len =
6768 PFKEY_UNIT64(result->m_pkthdr.len);
6771 printf("%s: SP(%p)\n", __func__, sp));
6772 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6774 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6783 key_newacq(const struct secasindex *saidx, int *perror)
6788 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6790 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6796 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6797 acq->created = time_second;
6800 /* add to acqtree */
6802 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6803 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6804 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6805 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6812 key_getacq(const struct secasindex *saidx, int *perror)
6818 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6819 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6820 if (acq->count > V_key_blockacq_count) {
6822 * Reset counter and send message.
6823 * Also reset created time to keep ACQ for
6826 acq->created = time_second;
6831 * Increment counter and do nothing.
6832 * We send SADB_ACQUIRE message only
6833 * for each V_key_blockacq_count packet.
6846 /* allocate new entry */
6847 return (key_newacq(saidx, perror));
6851 key_acqreset(uint32_t seq)
6856 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6857 if (acq->seq == seq) {
6859 acq->created = time_second;
6869 * Mark ACQ entry as stale to remove it in key_flush_acq().
6870 * Called after successful SADB_GETSPI message.
6873 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6878 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6879 if (acq->seq == seq)
6883 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6884 ipseclog((LOG_DEBUG,
6885 "%s: Mismatched saidx for ACQ %u\n", __func__, seq));
6891 ipseclog((LOG_DEBUG,
6892 "%s: ACQ %u is not found.\n", __func__, seq));
6900 static struct secspacq *
6901 key_newspacq(struct secpolicyindex *spidx)
6903 struct secspacq *acq;
6906 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6908 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6913 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6914 acq->created = time_second;
6917 /* add to spacqtree */
6919 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6925 static struct secspacq *
6926 key_getspacq(struct secpolicyindex *spidx)
6928 struct secspacq *acq;
6931 LIST_FOREACH(acq, &V_spacqtree, chain) {
6932 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6933 /* NB: return holding spacq_lock */
6943 * SADB_ACQUIRE processing,
6944 * in first situation, is receiving
6946 * from the ikmpd, and clear sequence of its secasvar entry.
6948 * In second situation, is receiving
6949 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6950 * from a user land process, and return
6951 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6954 * m will always be freed.
6957 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6959 SAHTREE_RLOCK_TRACKER;
6960 struct sadb_address *src0, *dst0;
6961 struct secasindex saidx;
6962 struct secashead *sah;
6965 uint8_t mode, proto;
6967 IPSEC_ASSERT(so != NULL, ("null socket"));
6968 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6969 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6970 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6973 * Error message from KMd.
6974 * We assume that if error was occurred in IKEd, the length of PFKEY
6975 * message is equal to the size of sadb_msg structure.
6976 * We do not raise error even if error occurred in this function.
6978 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
6979 /* check sequence number */
6980 if (mhp->msg->sadb_msg_seq == 0 ||
6981 mhp->msg->sadb_msg_errno == 0) {
6982 ipseclog((LOG_DEBUG, "%s: must specify sequence "
6983 "number and errno.\n", __func__));
6986 * IKEd reported that error occurred.
6987 * XXXAE: what it expects from the kernel?
6988 * Probably we should send SADB_ACQUIRE again?
6989 * If so, reset ACQ's state.
6990 * XXXAE: it looks useless.
6992 key_acqreset(mhp->msg->sadb_msg_seq);
6999 * This message is from user land.
7002 /* map satype to proto */
7003 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7004 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7006 return key_senderror(so, m, EINVAL);
7009 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
7010 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
7011 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
7012 ipseclog((LOG_DEBUG,
7013 "%s: invalid message: missing required header.\n",
7015 return key_senderror(so, m, EINVAL);
7017 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
7018 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
7019 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
7020 ipseclog((LOG_DEBUG,
7021 "%s: invalid message: wrong header size.\n", __func__));
7022 return key_senderror(so, m, EINVAL);
7025 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
7026 mode = IPSEC_MODE_ANY;
7029 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
7030 ipseclog((LOG_DEBUG,
7031 "%s: invalid message: wrong header size.\n",
7033 return key_senderror(so, m, EINVAL);
7035 mode = ((struct sadb_x_sa2 *)
7036 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7037 reqid = ((struct sadb_x_sa2 *)
7038 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7041 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7042 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7044 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
7045 (struct sockaddr *)(dst0 + 1));
7047 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
7048 return key_senderror(so, m, EINVAL);
7050 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
7052 /* get a SA index */
7054 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
7055 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
7060 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
7061 return key_senderror(so, m, EEXIST);
7064 error = key_acquire(&saidx, NULL);
7066 ipseclog((LOG_DEBUG,
7067 "%s: error %d returned from key_acquire()\n",
7069 return key_senderror(so, m, error);
7076 * SADB_REGISTER processing.
7077 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
7080 * from the ikmpd, and register a socket to send PF_KEY messages,
7084 * If socket is detached, must free from regnode.
7086 * m will always be freed.
7089 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7091 struct secreg *reg, *newreg = NULL;
7093 IPSEC_ASSERT(so != NULL, ("null socket"));
7094 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7095 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7096 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7098 /* check for invalid register message */
7099 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
7100 return key_senderror(so, m, EINVAL);
7102 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
7103 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
7106 /* check whether existing or not */
7108 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
7109 if (reg->so == so) {
7111 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
7113 return key_senderror(so, m, EEXIST);
7117 /* create regnode */
7118 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
7119 if (newreg == NULL) {
7121 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7122 return key_senderror(so, m, ENOBUFS);
7126 ((struct keycb *)sotorawcb(so))->kp_registered++;
7128 /* add regnode to regtree. */
7129 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7135 struct sadb_msg *newmsg;
7136 struct sadb_supported *sup;
7137 u_int len, alen, elen;
7140 struct sadb_alg *alg;
7142 /* create new sadb_msg to reply. */
7144 for (i = 1; i <= SADB_AALG_MAX; i++) {
7145 if (auth_algorithm_lookup(i))
7146 alen += sizeof(struct sadb_alg);
7149 alen += sizeof(struct sadb_supported);
7151 for (i = 1; i <= SADB_EALG_MAX; i++) {
7152 if (enc_algorithm_lookup(i))
7153 elen += sizeof(struct sadb_alg);
7156 elen += sizeof(struct sadb_supported);
7158 len = sizeof(struct sadb_msg) + alen + elen;
7161 return key_senderror(so, m, ENOBUFS);
7163 MGETHDR(n, M_NOWAIT, MT_DATA);
7164 if (n != NULL && len > MHLEN) {
7165 if (!(MCLGET(n, M_NOWAIT))) {
7171 return key_senderror(so, m, ENOBUFS);
7173 n->m_pkthdr.len = n->m_len = len;
7177 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7178 newmsg = mtod(n, struct sadb_msg *);
7179 newmsg->sadb_msg_errno = 0;
7180 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7181 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7183 /* for authentication algorithm */
7185 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7186 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7187 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7188 off += PFKEY_ALIGN8(sizeof(*sup));
7190 for (i = 1; i <= SADB_AALG_MAX; i++) {
7191 const struct auth_hash *aalgo;
7192 u_int16_t minkeysize, maxkeysize;
7194 aalgo = auth_algorithm_lookup(i);
7197 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7198 alg->sadb_alg_id = i;
7199 alg->sadb_alg_ivlen = 0;
7200 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7201 alg->sadb_alg_minbits = _BITS(minkeysize);
7202 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7203 off += PFKEY_ALIGN8(sizeof(*alg));
7207 /* for encryption algorithm */
7209 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7210 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7211 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7212 off += PFKEY_ALIGN8(sizeof(*sup));
7214 for (i = 1; i <= SADB_EALG_MAX; i++) {
7215 const struct enc_xform *ealgo;
7217 ealgo = enc_algorithm_lookup(i);
7220 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7221 alg->sadb_alg_id = i;
7222 alg->sadb_alg_ivlen = ealgo->ivsize;
7223 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7224 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7225 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7229 IPSEC_ASSERT(off == len,
7230 ("length assumption failed (off %u len %u)", off, len));
7233 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7238 * free secreg entry registered.
7239 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7242 key_freereg(struct socket *so)
7247 IPSEC_ASSERT(so != NULL, ("NULL so"));
7250 * check whether existing or not.
7251 * check all type of SA, because there is a potential that
7252 * one socket is registered to multiple type of SA.
7255 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7256 LIST_FOREACH(reg, &V_regtree[i], chain) {
7257 if (reg->so == so && __LIST_CHAINED(reg)) {
7258 LIST_REMOVE(reg, chain);
7259 free(reg, M_IPSEC_SAR);
7268 * SADB_EXPIRE processing
7270 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7272 * NOTE: We send only soft lifetime extension.
7275 * others : error number
7278 key_expire(struct secasvar *sav, int hard)
7280 struct mbuf *result = NULL, *m;
7281 struct sadb_lifetime *lt;
7282 uint32_t replay_count;
7286 IPSEC_ASSERT (sav != NULL, ("null sav"));
7287 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7290 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7291 sav, hard ? "hard": "soft"));
7292 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7293 /* set msg header */
7294 satype = key_proto2satype(sav->sah->saidx.proto);
7295 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7296 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7303 /* create SA extension */
7304 m = key_setsadbsa(sav);
7311 /* create SA extension */
7313 replay_count = sav->replay ? sav->replay->count : 0;
7314 SECASVAR_UNLOCK(sav);
7316 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7317 sav->sah->saidx.reqid);
7324 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7325 m = key_setsadbxsareplay(sav->replay->wsize);
7333 /* create lifetime extension (current and soft) */
7334 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7335 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7342 bzero(mtod(m, caddr_t), len);
7343 lt = mtod(m, struct sadb_lifetime *);
7344 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7345 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7346 lt->sadb_lifetime_allocations =
7347 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7348 lt->sadb_lifetime_bytes =
7349 counter_u64_fetch(sav->lft_c_bytes);
7350 lt->sadb_lifetime_addtime = sav->created;
7351 lt->sadb_lifetime_usetime = sav->firstused;
7352 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7353 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7355 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7356 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7357 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7358 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7359 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7361 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7362 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7363 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7364 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7365 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7369 /* set sadb_address for source */
7370 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7371 &sav->sah->saidx.src.sa,
7372 FULLMASK, IPSEC_ULPROTO_ANY);
7379 /* set sadb_address for destination */
7380 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7381 &sav->sah->saidx.dst.sa,
7382 FULLMASK, IPSEC_ULPROTO_ANY);
7390 * XXX-BZ Handle NAT-T extensions here.
7391 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7392 * this information, we report only significant SA fields.
7395 if ((result->m_flags & M_PKTHDR) == 0) {
7400 if (result->m_len < sizeof(struct sadb_msg)) {
7401 result = m_pullup(result, sizeof(struct sadb_msg));
7402 if (result == NULL) {
7408 result->m_pkthdr.len = 0;
7409 for (m = result; m; m = m->m_next)
7410 result->m_pkthdr.len += m->m_len;
7412 mtod(result, struct sadb_msg *)->sadb_msg_len =
7413 PFKEY_UNIT64(result->m_pkthdr.len);
7415 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7424 key_freesah_flushed(struct secashead_queue *flushq)
7426 struct secashead *sah, *nextsah;
7427 struct secasvar *sav, *nextsav;
7429 sah = TAILQ_FIRST(flushq);
7430 while (sah != NULL) {
7431 sav = TAILQ_FIRST(&sah->savtree_larval);
7432 while (sav != NULL) {
7433 nextsav = TAILQ_NEXT(sav, chain);
7434 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7435 key_freesav(&sav); /* release last reference */
7436 key_freesah(&sah); /* release reference from SAV */
7439 sav = TAILQ_FIRST(&sah->savtree_alive);
7440 while (sav != NULL) {
7441 nextsav = TAILQ_NEXT(sav, chain);
7442 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7443 key_freesav(&sav); /* release last reference */
7444 key_freesah(&sah); /* release reference from SAV */
7447 nextsah = TAILQ_NEXT(sah, chain);
7448 key_freesah(&sah); /* release last reference */
7454 * SADB_FLUSH processing
7457 * from the ikmpd, and free all entries in secastree.
7461 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7463 * m will always be freed.
7466 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7468 struct secashead_queue flushq;
7469 struct sadb_msg *newmsg;
7470 struct secashead *sah, *nextsah;
7471 struct secasvar *sav;
7475 IPSEC_ASSERT(so != NULL, ("null socket"));
7476 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7477 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7479 /* map satype to proto */
7480 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7481 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7483 return key_senderror(so, m, EINVAL);
7486 printf("%s: proto %u\n", __func__, proto));
7488 TAILQ_INIT(&flushq);
7489 if (proto == IPSEC_PROTO_ANY) {
7490 /* no SATYPE specified, i.e. flushing all SA. */
7492 /* Move all SAHs into flushq */
7493 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7494 /* Flush all buckets in SPI hash */
7495 for (i = 0; i < V_savhash_mask + 1; i++)
7496 LIST_INIT(&V_savhashtbl[i]);
7497 /* Flush all buckets in SAHADDRHASH */
7498 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7499 LIST_INIT(&V_sahaddrhashtbl[i]);
7500 /* Mark all SAHs as unlinked */
7501 TAILQ_FOREACH(sah, &flushq, chain) {
7502 sah->state = SADB_SASTATE_DEAD;
7504 * Callout handler makes its job using
7505 * RLOCK and drain queues. In case, when this
7506 * function will be called just before it
7507 * acquires WLOCK, we need to mark SAs as
7508 * unlinked to prevent second unlink.
7510 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7511 sav->state = SADB_SASTATE_DEAD;
7513 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7514 sav->state = SADB_SASTATE_DEAD;
7520 sah = TAILQ_FIRST(&V_sahtree);
7521 while (sah != NULL) {
7522 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7523 ("DEAD SAH %p in SADB_FLUSH", sah));
7524 nextsah = TAILQ_NEXT(sah, chain);
7525 if (sah->saidx.proto != proto) {
7529 sah->state = SADB_SASTATE_DEAD;
7530 TAILQ_REMOVE(&V_sahtree, sah, chain);
7531 LIST_REMOVE(sah, addrhash);
7532 /* Unlink all SAs from SPI hash */
7533 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7534 LIST_REMOVE(sav, spihash);
7535 sav->state = SADB_SASTATE_DEAD;
7537 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7538 LIST_REMOVE(sav, spihash);
7539 sav->state = SADB_SASTATE_DEAD;
7541 /* Add SAH into flushq */
7542 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7548 key_freesah_flushed(&flushq);
7549 /* Free all queued SAs and SAHs */
7550 if (m->m_len < sizeof(struct sadb_msg) ||
7551 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7552 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7553 return key_senderror(so, m, ENOBUFS);
7559 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7560 newmsg = mtod(m, struct sadb_msg *);
7561 newmsg->sadb_msg_errno = 0;
7562 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7564 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7568 * SADB_DUMP processing
7569 * dump all entries including status of DEAD in SAD.
7572 * from the ikmpd, and dump all secasvar leaves
7577 * m will always be freed.
7580 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7582 SAHTREE_RLOCK_TRACKER;
7583 struct secashead *sah;
7584 struct secasvar *sav;
7587 uint8_t proto, satype;
7589 IPSEC_ASSERT(so != NULL, ("null socket"));
7590 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7591 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7592 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7594 /* map satype to proto */
7595 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7596 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7598 return key_senderror(so, m, EINVAL);
7601 /* count sav entries to be sent to the userland. */
7604 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7605 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7606 proto != sah->saidx.proto)
7609 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7611 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7617 return key_senderror(so, m, ENOENT);
7620 /* send this to the userland, one at a time. */
7621 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7622 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7623 proto != sah->saidx.proto)
7626 /* map proto to satype */
7627 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7629 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7630 "SAD.\n", __func__));
7631 return key_senderror(so, m, EINVAL);
7633 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7634 n = key_setdumpsa(sav, SADB_DUMP, satype,
7635 --cnt, mhp->msg->sadb_msg_pid);
7638 return key_senderror(so, m, ENOBUFS);
7640 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7642 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7643 n = key_setdumpsa(sav, SADB_DUMP, satype,
7644 --cnt, mhp->msg->sadb_msg_pid);
7647 return key_senderror(so, m, ENOBUFS);
7649 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7657 * SADB_X_PROMISC processing
7659 * m will always be freed.
7662 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7666 IPSEC_ASSERT(so != NULL, ("null socket"));
7667 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7668 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7669 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7671 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7673 if (olen < sizeof(struct sadb_msg)) {
7675 return key_senderror(so, m, EINVAL);
7680 } else if (olen == sizeof(struct sadb_msg)) {
7681 /* enable/disable promisc mode */
7684 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7685 return key_senderror(so, m, EINVAL);
7686 mhp->msg->sadb_msg_errno = 0;
7687 switch (mhp->msg->sadb_msg_satype) {
7690 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7693 return key_senderror(so, m, EINVAL);
7696 /* send the original message back to everyone */
7697 mhp->msg->sadb_msg_errno = 0;
7698 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7700 /* send packet as is */
7702 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7704 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7705 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7709 static int (*key_typesw[])(struct socket *, struct mbuf *,
7710 const struct sadb_msghdr *) = {
7711 NULL, /* SADB_RESERVED */
7712 key_getspi, /* SADB_GETSPI */
7713 key_update, /* SADB_UPDATE */
7714 key_add, /* SADB_ADD */
7715 key_delete, /* SADB_DELETE */
7716 key_get, /* SADB_GET */
7717 key_acquire2, /* SADB_ACQUIRE */
7718 key_register, /* SADB_REGISTER */
7719 NULL, /* SADB_EXPIRE */
7720 key_flush, /* SADB_FLUSH */
7721 key_dump, /* SADB_DUMP */
7722 key_promisc, /* SADB_X_PROMISC */
7723 NULL, /* SADB_X_PCHANGE */
7724 key_spdadd, /* SADB_X_SPDUPDATE */
7725 key_spdadd, /* SADB_X_SPDADD */
7726 key_spddelete, /* SADB_X_SPDDELETE */
7727 key_spdget, /* SADB_X_SPDGET */
7728 NULL, /* SADB_X_SPDACQUIRE */
7729 key_spddump, /* SADB_X_SPDDUMP */
7730 key_spdflush, /* SADB_X_SPDFLUSH */
7731 key_spdadd, /* SADB_X_SPDSETIDX */
7732 NULL, /* SADB_X_SPDEXPIRE */
7733 key_spddelete2, /* SADB_X_SPDDELETE2 */
7737 * parse sadb_msg buffer to process PFKEYv2,
7738 * and create a data to response if needed.
7739 * I think to be dealed with mbuf directly.
7741 * msgp : pointer to pointer to a received buffer pulluped.
7742 * This is rewrited to response.
7743 * so : pointer to socket.
7745 * length for buffer to send to user process.
7748 key_parse(struct mbuf *m, struct socket *so)
7750 struct sadb_msg *msg;
7751 struct sadb_msghdr mh;
7756 IPSEC_ASSERT(so != NULL, ("null socket"));
7757 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7759 if (m->m_len < sizeof(struct sadb_msg)) {
7760 m = m_pullup(m, sizeof(struct sadb_msg));
7764 msg = mtod(m, struct sadb_msg *);
7765 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7766 target = KEY_SENDUP_ONE;
7768 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7769 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7770 PFKEYSTAT_INC(out_invlen);
7775 if (msg->sadb_msg_version != PF_KEY_V2) {
7776 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7777 __func__, msg->sadb_msg_version));
7778 PFKEYSTAT_INC(out_invver);
7783 if (msg->sadb_msg_type > SADB_MAX) {
7784 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7785 __func__, msg->sadb_msg_type));
7786 PFKEYSTAT_INC(out_invmsgtype);
7791 /* for old-fashioned code - should be nuked */
7792 if (m->m_pkthdr.len > MCLBYTES) {
7799 MGETHDR(n, M_NOWAIT, MT_DATA);
7800 if (n && m->m_pkthdr.len > MHLEN) {
7801 if (!(MCLGET(n, M_NOWAIT))) {
7810 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7811 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7817 /* align the mbuf chain so that extensions are in contiguous region. */
7818 error = key_align(m, &mh);
7824 /* We use satype as scope mask for spddump */
7825 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7826 switch (msg->sadb_msg_satype) {
7827 case IPSEC_POLICYSCOPE_ANY:
7828 case IPSEC_POLICYSCOPE_GLOBAL:
7829 case IPSEC_POLICYSCOPE_IFNET:
7830 case IPSEC_POLICYSCOPE_PCB:
7833 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7834 __func__, msg->sadb_msg_type));
7835 PFKEYSTAT_INC(out_invsatype);
7840 switch (msg->sadb_msg_satype) { /* check SA type */
7841 case SADB_SATYPE_UNSPEC:
7842 switch (msg->sadb_msg_type) {
7850 ipseclog((LOG_DEBUG, "%s: must specify satype "
7851 "when msg type=%u.\n", __func__,
7852 msg->sadb_msg_type));
7853 PFKEYSTAT_INC(out_invsatype);
7858 case SADB_SATYPE_AH:
7859 case SADB_SATYPE_ESP:
7860 case SADB_X_SATYPE_IPCOMP:
7861 case SADB_X_SATYPE_TCPSIGNATURE:
7862 switch (msg->sadb_msg_type) {
7864 case SADB_X_SPDDELETE:
7866 case SADB_X_SPDFLUSH:
7867 case SADB_X_SPDSETIDX:
7868 case SADB_X_SPDUPDATE:
7869 case SADB_X_SPDDELETE2:
7870 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7871 __func__, msg->sadb_msg_type));
7872 PFKEYSTAT_INC(out_invsatype);
7877 case SADB_SATYPE_RSVP:
7878 case SADB_SATYPE_OSPFV2:
7879 case SADB_SATYPE_RIPV2:
7880 case SADB_SATYPE_MIP:
7881 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7882 __func__, msg->sadb_msg_satype));
7883 PFKEYSTAT_INC(out_invsatype);
7886 case 1: /* XXX: What does it do? */
7887 if (msg->sadb_msg_type == SADB_X_PROMISC)
7891 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7892 __func__, msg->sadb_msg_satype));
7893 PFKEYSTAT_INC(out_invsatype);
7899 /* check field of upper layer protocol and address family */
7900 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7901 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7902 struct sadb_address *src0, *dst0;
7905 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7906 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7908 /* check upper layer protocol */
7909 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7910 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7911 "mismatched.\n", __func__));
7912 PFKEYSTAT_INC(out_invaddr);
7918 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7919 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7920 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7922 PFKEYSTAT_INC(out_invaddr);
7926 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7927 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7928 ipseclog((LOG_DEBUG, "%s: address struct size "
7929 "mismatched.\n", __func__));
7930 PFKEYSTAT_INC(out_invaddr);
7935 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7937 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7938 sizeof(struct sockaddr_in)) {
7939 PFKEYSTAT_INC(out_invaddr);
7945 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7946 sizeof(struct sockaddr_in6)) {
7947 PFKEYSTAT_INC(out_invaddr);
7953 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7955 PFKEYSTAT_INC(out_invaddr);
7956 error = EAFNOSUPPORT;
7960 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7962 plen = sizeof(struct in_addr) << 3;
7965 plen = sizeof(struct in6_addr) << 3;
7968 plen = 0; /*fool gcc*/
7972 /* check max prefix length */
7973 if (src0->sadb_address_prefixlen > plen ||
7974 dst0->sadb_address_prefixlen > plen) {
7975 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7977 PFKEYSTAT_INC(out_invaddr);
7983 * prefixlen == 0 is valid because there can be a case when
7984 * all addresses are matched.
7988 if (msg->sadb_msg_type >= nitems(key_typesw) ||
7989 key_typesw[msg->sadb_msg_type] == NULL) {
7990 PFKEYSTAT_INC(out_invmsgtype);
7995 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
7998 msg->sadb_msg_errno = error;
7999 return key_sendup_mbuf(so, m, target);
8003 key_senderror(struct socket *so, struct mbuf *m, int code)
8005 struct sadb_msg *msg;
8007 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8008 ("mbuf too small, len %u", m->m_len));
8010 msg = mtod(m, struct sadb_msg *);
8011 msg->sadb_msg_errno = code;
8012 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
8016 * set the pointer to each header into message buffer.
8017 * m will be freed on error.
8018 * XXX larger-than-MCLBYTES extension?
8021 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
8024 struct sadb_ext *ext;
8029 IPSEC_ASSERT(m != NULL, ("null mbuf"));
8030 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
8031 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8032 ("mbuf too small, len %u", m->m_len));
8035 bzero(mhp, sizeof(*mhp));
8037 mhp->msg = mtod(m, struct sadb_msg *);
8038 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
8040 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
8041 extlen = end; /*just in case extlen is not updated*/
8042 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
8043 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
8045 /* m is already freed */
8048 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8051 switch (ext->sadb_ext_type) {
8053 case SADB_EXT_ADDRESS_SRC:
8054 case SADB_EXT_ADDRESS_DST:
8055 case SADB_EXT_ADDRESS_PROXY:
8056 case SADB_EXT_LIFETIME_CURRENT:
8057 case SADB_EXT_LIFETIME_HARD:
8058 case SADB_EXT_LIFETIME_SOFT:
8059 case SADB_EXT_KEY_AUTH:
8060 case SADB_EXT_KEY_ENCRYPT:
8061 case SADB_EXT_IDENTITY_SRC:
8062 case SADB_EXT_IDENTITY_DST:
8063 case SADB_EXT_SENSITIVITY:
8064 case SADB_EXT_PROPOSAL:
8065 case SADB_EXT_SUPPORTED_AUTH:
8066 case SADB_EXT_SUPPORTED_ENCRYPT:
8067 case SADB_EXT_SPIRANGE:
8068 case SADB_X_EXT_POLICY:
8069 case SADB_X_EXT_SA2:
8070 case SADB_X_EXT_NAT_T_TYPE:
8071 case SADB_X_EXT_NAT_T_SPORT:
8072 case SADB_X_EXT_NAT_T_DPORT:
8073 case SADB_X_EXT_NAT_T_OAI:
8074 case SADB_X_EXT_NAT_T_OAR:
8075 case SADB_X_EXT_NAT_T_FRAG:
8076 case SADB_X_EXT_SA_REPLAY:
8077 case SADB_X_EXT_NEW_ADDRESS_SRC:
8078 case SADB_X_EXT_NEW_ADDRESS_DST:
8079 /* duplicate check */
8081 * XXX Are there duplication payloads of either
8082 * KEY_AUTH or KEY_ENCRYPT ?
8084 if (mhp->ext[ext->sadb_ext_type] != NULL) {
8085 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
8086 "%u\n", __func__, ext->sadb_ext_type));
8088 PFKEYSTAT_INC(out_dupext);
8093 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
8094 __func__, ext->sadb_ext_type));
8096 PFKEYSTAT_INC(out_invexttype);
8100 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
8102 if (key_validate_ext(ext, extlen)) {
8104 PFKEYSTAT_INC(out_invlen);
8108 n = m_pulldown(m, off, extlen, &toff);
8110 /* m is already freed */
8113 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8115 mhp->ext[ext->sadb_ext_type] = ext;
8116 mhp->extoff[ext->sadb_ext_type] = off;
8117 mhp->extlen[ext->sadb_ext_type] = extlen;
8122 PFKEYSTAT_INC(out_invlen);
8130 key_validate_ext(const struct sadb_ext *ext, int len)
8132 const struct sockaddr *sa;
8133 enum { NONE, ADDR } checktype = NONE;
8135 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8137 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8140 /* if it does not match minimum/maximum length, bail */
8141 if (ext->sadb_ext_type >= nitems(minsize) ||
8142 ext->sadb_ext_type >= nitems(maxsize))
8144 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8146 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8149 /* more checks based on sadb_ext_type XXX need more */
8150 switch (ext->sadb_ext_type) {
8151 case SADB_EXT_ADDRESS_SRC:
8152 case SADB_EXT_ADDRESS_DST:
8153 case SADB_EXT_ADDRESS_PROXY:
8154 case SADB_X_EXT_NAT_T_OAI:
8155 case SADB_X_EXT_NAT_T_OAR:
8156 case SADB_X_EXT_NEW_ADDRESS_SRC:
8157 case SADB_X_EXT_NEW_ADDRESS_DST:
8158 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8161 case SADB_EXT_IDENTITY_SRC:
8162 case SADB_EXT_IDENTITY_DST:
8163 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8164 SADB_X_IDENTTYPE_ADDR) {
8165 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8175 switch (checktype) {
8179 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8180 if (len < baselen + sal)
8182 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8195 TUNABLE_INT_FETCH("net.key.spdcache.maxentries",
8196 &V_key_spdcache_maxentries);
8197 TUNABLE_INT_FETCH("net.key.spdcache.threshold",
8198 &V_key_spdcache_threshold);
8200 if (V_key_spdcache_maxentries) {
8201 V_key_spdcache_maxentries = MAX(V_key_spdcache_maxentries,
8202 SPDCACHE_MAX_ENTRIES_PER_HASH);
8203 V_spdcachehashtbl = hashinit(V_key_spdcache_maxentries /
8204 SPDCACHE_MAX_ENTRIES_PER_HASH,
8205 M_IPSEC_SPDCACHE, &V_spdcachehash_mask);
8206 V_key_spdcache_maxentries = (V_spdcachehash_mask + 1)
8207 * SPDCACHE_MAX_ENTRIES_PER_HASH;
8209 V_spdcache_lock = malloc(sizeof(struct mtx) *
8210 (V_spdcachehash_mask + 1),
8211 M_IPSEC_SPDCACHE, M_WAITOK|M_ZERO);
8213 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8214 SPDCACHE_LOCK_INIT(i);
8218 struct spdcache_entry *
8219 spdcache_entry_alloc(const struct secpolicyindex *spidx, struct secpolicy *sp)
8221 struct spdcache_entry *entry;
8223 entry = malloc(sizeof(struct spdcache_entry),
8224 M_IPSEC_SPDCACHE, M_NOWAIT|M_ZERO);
8231 entry->spidx = *spidx;
8238 spdcache_entry_free(struct spdcache_entry *entry)
8241 if (entry->sp != NULL)
8242 key_freesp(&entry->sp);
8243 free(entry, M_IPSEC_SPDCACHE);
8247 spdcache_clear(void)
8249 struct spdcache_entry *entry;
8252 for (i = 0; i < V_spdcachehash_mask + 1; ++i) {
8254 while (!LIST_EMPTY(&V_spdcachehashtbl[i])) {
8255 entry = LIST_FIRST(&V_spdcachehashtbl[i]);
8256 LIST_REMOVE(entry, chain);
8257 spdcache_entry_free(entry);
8265 spdcache_destroy(void)
8269 if (SPDCACHE_ENABLED()) {
8271 hashdestroy(V_spdcachehashtbl, M_IPSEC_SPDCACHE, V_spdcachehash_mask);
8273 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8274 SPDCACHE_LOCK_DESTROY(i);
8276 free(V_spdcache_lock, M_IPSEC_SPDCACHE);
8285 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8286 TAILQ_INIT(&V_sptree[i]);
8287 TAILQ_INIT(&V_sptree_ifnet[i]);
8290 TAILQ_INIT(&V_sahtree);
8291 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8292 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8293 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8294 &V_sahaddrhash_mask);
8295 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8296 &V_acqaddrhash_mask);
8297 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8298 &V_acqseqhash_mask);
8302 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8303 LIST_INIT(&V_regtree[i]);
8305 LIST_INIT(&V_acqtree);
8306 LIST_INIT(&V_spacqtree);
8308 if (!IS_DEFAULT_VNET(curvnet))
8311 ipsec_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8312 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8313 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8316 REGTREE_LOCK_INIT();
8317 SAHTREE_LOCK_INIT();
8321 #ifndef IPSEC_DEBUG2
8322 callout_init(&key_timer, 1);
8323 callout_reset(&key_timer, hz, key_timehandler, NULL);
8324 #endif /*IPSEC_DEBUG2*/
8326 /* initialize key statistics */
8327 keystat.getspi_count = 1;
8330 printf("IPsec: Initialized Security Association Processing.\n");
8337 struct secashead_queue sahdrainq;
8338 struct secpolicy_queue drainq;
8339 struct secpolicy *sp, *nextsp;
8340 struct secacq *acq, *nextacq;
8341 struct secspacq *spacq, *nextspacq;
8342 struct secashead *sah;
8343 struct secasvar *sav;
8348 * XXX: can we just call free() for each object without
8349 * walking through safe way with releasing references?
8351 TAILQ_INIT(&drainq);
8353 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8354 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8355 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8357 for (i = 0; i < V_sphash_mask + 1; i++)
8358 LIST_INIT(&V_sphashtbl[i]);
8362 sp = TAILQ_FIRST(&drainq);
8363 while (sp != NULL) {
8364 nextsp = TAILQ_NEXT(sp, chain);
8369 TAILQ_INIT(&sahdrainq);
8371 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8372 for (i = 0; i < V_savhash_mask + 1; i++)
8373 LIST_INIT(&V_savhashtbl[i]);
8374 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8375 LIST_INIT(&V_sahaddrhashtbl[i]);
8376 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8377 sah->state = SADB_SASTATE_DEAD;
8378 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8379 sav->state = SADB_SASTATE_DEAD;
8381 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8382 sav->state = SADB_SASTATE_DEAD;
8387 key_freesah_flushed(&sahdrainq);
8388 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8389 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8390 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8393 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8394 LIST_FOREACH(reg, &V_regtree[i], chain) {
8395 if (__LIST_CHAINED(reg)) {
8396 LIST_REMOVE(reg, chain);
8397 free(reg, M_IPSEC_SAR);
8405 acq = LIST_FIRST(&V_acqtree);
8406 while (acq != NULL) {
8407 nextacq = LIST_NEXT(acq, chain);
8408 LIST_REMOVE(acq, chain);
8409 free(acq, M_IPSEC_SAQ);
8412 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8413 LIST_INIT(&V_acqaddrhashtbl[i]);
8414 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8415 LIST_INIT(&V_acqseqhashtbl[i]);
8419 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8420 spacq = nextspacq) {
8421 nextspacq = LIST_NEXT(spacq, chain);
8422 if (__LIST_CHAINED(spacq)) {
8423 LIST_REMOVE(spacq, chain);
8424 free(spacq, M_IPSEC_SAQ);
8428 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8429 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8431 if (!IS_DEFAULT_VNET(curvnet))
8434 uma_zdestroy(ipsec_key_lft_zone);
8436 #ifndef IPSEC_DEBUG2
8437 callout_drain(&key_timer);
8439 SPTREE_LOCK_DESTROY();
8440 REGTREE_LOCK_DESTROY();
8441 SAHTREE_LOCK_DESTROY();
8443 SPACQ_LOCK_DESTROY();
8447 /* record data transfer on SA, and update timestamps */
8449 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8451 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8452 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8455 * XXX Currently, there is a difference of bytes size
8456 * between inbound and outbound processing.
8458 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8461 * We use the number of packets as the unit of
8462 * allocations. We increment the variable
8463 * whenever {esp,ah}_{in,out}put is called.
8465 counter_u64_add(sav->lft_c_allocations, 1);
8468 * NOTE: We record CURRENT usetime by using wall clock,
8469 * in seconds. HARD and SOFT lifetime are measured by the time
8470 * difference (again in seconds) from usetime.
8474 * -----+-----+--------+---> t
8475 * <--------------> HARD
8478 if (sav->firstused == 0)
8479 sav->firstused = time_second;
8483 * Take one of the kernel's security keys and convert it into a PF_KEY
8484 * structure within an mbuf, suitable for sending up to a waiting
8485 * application in user land.
8488 * src: A pointer to a kernel security key.
8489 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8491 * a valid mbuf or NULL indicating an error
8495 static struct mbuf *
8496 key_setkey(struct seckey *src, uint16_t exttype)
8505 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8506 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8511 p = mtod(m, struct sadb_key *);
8513 p->sadb_key_len = PFKEY_UNIT64(len);
8514 p->sadb_key_exttype = exttype;
8515 p->sadb_key_bits = src->bits;
8516 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8522 * Take one of the kernel's lifetime data structures and convert it
8523 * into a PF_KEY structure within an mbuf, suitable for sending up to
8524 * a waiting application in user land.
8527 * src: A pointer to a kernel lifetime structure.
8528 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8529 * data structures for more information.
8531 * a valid mbuf or NULL indicating an error
8535 static struct mbuf *
8536 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8538 struct mbuf *m = NULL;
8539 struct sadb_lifetime *p;
8540 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8545 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8550 p = mtod(m, struct sadb_lifetime *);
8553 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8554 p->sadb_lifetime_exttype = exttype;
8555 p->sadb_lifetime_allocations = src->allocations;
8556 p->sadb_lifetime_bytes = src->bytes;
8557 p->sadb_lifetime_addtime = src->addtime;
8558 p->sadb_lifetime_usetime = src->usetime;
8564 const struct enc_xform *
8565 enc_algorithm_lookup(int alg)
8569 for (i = 0; i < nitems(supported_ealgs); i++)
8570 if (alg == supported_ealgs[i].sadb_alg)
8571 return (supported_ealgs[i].xform);
8575 const struct auth_hash *
8576 auth_algorithm_lookup(int alg)
8580 for (i = 0; i < nitems(supported_aalgs); i++)
8581 if (alg == supported_aalgs[i].sadb_alg)
8582 return (supported_aalgs[i].xform);
8586 const struct comp_algo *
8587 comp_algorithm_lookup(int alg)
8591 for (i = 0; i < nitems(supported_calgs); i++)
8592 if (alg == supported_calgs[i].sadb_alg)
8593 return (supported_calgs[i].xform);