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 struct secpolicy *key_do_allocsp(struct secpolicyindex *spidx, u_int dir);
620 static struct secpolicy *key_getsp(struct secpolicyindex *);
621 static struct secpolicy *key_getspbyid(u_int32_t);
622 static struct mbuf *key_gather_mbuf(struct mbuf *,
623 const struct sadb_msghdr *, int, int, ...);
624 static int key_spdadd(struct socket *, struct mbuf *,
625 const struct sadb_msghdr *);
626 static uint32_t key_getnewspid(void);
627 static int key_spddelete(struct socket *, struct mbuf *,
628 const struct sadb_msghdr *);
629 static int key_spddelete2(struct socket *, struct mbuf *,
630 const struct sadb_msghdr *);
631 static int key_spdget(struct socket *, struct mbuf *,
632 const struct sadb_msghdr *);
633 static int key_spdflush(struct socket *, struct mbuf *,
634 const struct sadb_msghdr *);
635 static int key_spddump(struct socket *, struct mbuf *,
636 const struct sadb_msghdr *);
637 static struct mbuf *key_setdumpsp(struct secpolicy *,
638 u_int8_t, u_int32_t, u_int32_t);
639 static struct mbuf *key_sp2mbuf(struct secpolicy *);
640 static size_t key_getspreqmsglen(struct secpolicy *);
641 static int key_spdexpire(struct secpolicy *);
642 static struct secashead *key_newsah(struct secasindex *);
643 static void key_freesah(struct secashead **);
644 static void key_delsah(struct secashead *);
645 static struct secasvar *key_newsav(const struct sadb_msghdr *,
646 struct secasindex *, uint32_t, int *);
647 static void key_delsav(struct secasvar *);
648 static void key_unlinksav(struct secasvar *);
649 static struct secashead *key_getsah(struct secasindex *);
650 static int key_checkspidup(uint32_t);
651 static struct secasvar *key_getsavbyspi(uint32_t);
652 static int key_setnatt(struct secasvar *, const struct sadb_msghdr *);
653 static int key_setsaval(struct secasvar *, const struct sadb_msghdr *);
654 static int key_updatelifetimes(struct secasvar *, const struct sadb_msghdr *);
655 static int key_updateaddresses(struct socket *, struct mbuf *,
656 const struct sadb_msghdr *, struct secasvar *, struct secasindex *);
658 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
659 u_int8_t, u_int32_t, u_int32_t);
660 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
661 u_int32_t, pid_t, u_int16_t);
662 static struct mbuf *key_setsadbsa(struct secasvar *);
663 static struct mbuf *key_setsadbaddr(u_int16_t,
664 const struct sockaddr *, u_int8_t, u_int16_t);
665 static struct mbuf *key_setsadbxport(u_int16_t, u_int16_t);
666 static struct mbuf *key_setsadbxtype(u_int16_t);
667 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t);
668 static struct mbuf *key_setsadbxsareplay(u_int32_t);
669 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
670 u_int32_t, u_int32_t);
671 static struct seckey *key_dup_keymsg(const struct sadb_key *, size_t,
672 struct malloc_type *);
673 static struct seclifetime *key_dup_lifemsg(const struct sadb_lifetime *src,
674 struct malloc_type *);
676 /* flags for key_cmpsaidx() */
677 #define CMP_HEAD 1 /* protocol, addresses. */
678 #define CMP_MODE_REQID 2 /* additionally HEAD, reqid, mode. */
679 #define CMP_REQID 3 /* additionally HEAD, reaid. */
680 #define CMP_EXACTLY 4 /* all elements. */
681 static int key_cmpsaidx(const struct secasindex *,
682 const struct secasindex *, int);
683 static int key_cmpspidx_exactly(struct secpolicyindex *,
684 struct secpolicyindex *);
685 static int key_cmpspidx_withmask(struct secpolicyindex *,
686 struct secpolicyindex *);
687 static int key_bbcmp(const void *, const void *, u_int);
688 static uint8_t key_satype2proto(uint8_t);
689 static uint8_t key_proto2satype(uint8_t);
691 static int key_getspi(struct socket *, struct mbuf *,
692 const struct sadb_msghdr *);
693 static uint32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
694 static int key_update(struct socket *, struct mbuf *,
695 const struct sadb_msghdr *);
696 static int key_add(struct socket *, struct mbuf *,
697 const struct sadb_msghdr *);
698 static int key_setident(struct secashead *, const struct sadb_msghdr *);
699 static struct mbuf *key_getmsgbuf_x1(struct mbuf *,
700 const struct sadb_msghdr *);
701 static int key_delete(struct socket *, struct mbuf *,
702 const struct sadb_msghdr *);
703 static int key_delete_all(struct socket *, struct mbuf *,
704 const struct sadb_msghdr *, struct secasindex *);
705 static int key_get(struct socket *, struct mbuf *,
706 const struct sadb_msghdr *);
708 static void key_getcomb_setlifetime(struct sadb_comb *);
709 static struct mbuf *key_getcomb_ealg(void);
710 static struct mbuf *key_getcomb_ah(void);
711 static struct mbuf *key_getcomb_ipcomp(void);
712 static struct mbuf *key_getprop(const struct secasindex *);
714 static int key_acquire(const struct secasindex *, struct secpolicy *);
715 static uint32_t key_newacq(const struct secasindex *, int *);
716 static uint32_t key_getacq(const struct secasindex *, int *);
717 static int key_acqdone(const struct secasindex *, uint32_t);
718 static int key_acqreset(uint32_t);
719 static struct secspacq *key_newspacq(struct secpolicyindex *);
720 static struct secspacq *key_getspacq(struct secpolicyindex *);
721 static int key_acquire2(struct socket *, struct mbuf *,
722 const struct sadb_msghdr *);
723 static int key_register(struct socket *, struct mbuf *,
724 const struct sadb_msghdr *);
725 static int key_expire(struct secasvar *, int);
726 static int key_flush(struct socket *, struct mbuf *,
727 const struct sadb_msghdr *);
728 static int key_dump(struct socket *, struct mbuf *,
729 const struct sadb_msghdr *);
730 static int key_promisc(struct socket *, struct mbuf *,
731 const struct sadb_msghdr *);
732 static int key_senderror(struct socket *, struct mbuf *, int);
733 static int key_validate_ext(const struct sadb_ext *, int);
734 static int key_align(struct mbuf *, struct sadb_msghdr *);
735 static struct mbuf *key_setlifetime(struct seclifetime *, uint16_t);
736 static struct mbuf *key_setkey(struct seckey *, uint16_t);
738 static void spdcache_init(void);
739 static void spdcache_clear(void);
740 static struct spdcache_entry *spdcache_entry_alloc(
741 const struct secpolicyindex *spidx,
742 struct secpolicy *policy);
743 static void spdcache_entry_free(struct spdcache_entry *entry);
745 static void spdcache_destroy(void);
748 #define DBG_IPSEC_INITREF(t, p) do { \
749 refcount_init(&(p)->refcnt, 1); \
751 printf("%s: Initialize refcnt %s(%p) = %u\n", \
752 __func__, #t, (p), (p)->refcnt)); \
754 #define DBG_IPSEC_ADDREF(t, p) do { \
755 refcount_acquire(&(p)->refcnt); \
757 printf("%s: Acquire refcnt %s(%p) -> %u\n", \
758 __func__, #t, (p), (p)->refcnt)); \
760 #define DBG_IPSEC_DELREF(t, p) do { \
762 printf("%s: Release refcnt %s(%p) -> %u\n", \
763 __func__, #t, (p), (p)->refcnt - 1)); \
764 refcount_release(&(p)->refcnt); \
767 #define IPSEC_INITREF(t, p) refcount_init(&(p)->refcnt, 1)
768 #define IPSEC_ADDREF(t, p) refcount_acquire(&(p)->refcnt)
769 #define IPSEC_DELREF(t, p) refcount_release(&(p)->refcnt)
771 #define SP_INITREF(p) IPSEC_INITREF(SP, p)
772 #define SP_ADDREF(p) IPSEC_ADDREF(SP, p)
773 #define SP_DELREF(p) IPSEC_DELREF(SP, p)
775 #define SAH_INITREF(p) IPSEC_INITREF(SAH, p)
776 #define SAH_ADDREF(p) IPSEC_ADDREF(SAH, p)
777 #define SAH_DELREF(p) IPSEC_DELREF(SAH, p)
779 #define SAV_INITREF(p) IPSEC_INITREF(SAV, p)
780 #define SAV_ADDREF(p) IPSEC_ADDREF(SAV, p)
781 #define SAV_DELREF(p) IPSEC_DELREF(SAV, p)
784 * Update the refcnt while holding the SPTREE lock.
787 key_addref(struct secpolicy *sp)
794 * Return 0 when there are known to be no SP's for the specified
795 * direction. Otherwise return 1. This is used by IPsec code
796 * to optimize performance.
799 key_havesp(u_int dir)
802 return (dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND ?
803 TAILQ_FIRST(&V_sptree[dir]) != NULL : 1);
806 /* %%% IPsec policy management */
808 * Return current SPDB generation.
825 key_checksockaddrs(struct sockaddr *src, struct sockaddr *dst)
829 if (src->sa_family != dst->sa_family)
832 if (src->sa_len != dst->sa_len)
834 switch (src->sa_family) {
837 if (src->sa_len != sizeof(struct sockaddr_in))
843 if (src->sa_len != sizeof(struct sockaddr_in6))
848 return (EAFNOSUPPORT);
854 key_do_allocsp(struct secpolicyindex *spidx, u_int dir)
856 SPTREE_RLOCK_TRACKER;
857 struct secpolicy *sp;
859 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
860 IPSEC_ASSERT(dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND,
861 ("invalid direction %u", dir));
864 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
865 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
875 * allocating a SP for OUTBOUND or INBOUND packet.
876 * Must call key_freesp() later.
877 * OUT: NULL: not found
878 * others: found and return the pointer.
881 key_allocsp(struct secpolicyindex *spidx, u_int dir)
883 struct spdcache_entry *entry, *lastentry, *tmpentry;
884 struct secpolicy *sp;
888 if (!SPDCACHE_ACTIVE()) {
889 sp = key_do_allocsp(spidx, dir);
893 hashv = SPDCACHE_HASHVAL(spidx);
894 SPDCACHE_LOCK(hashv);
896 LIST_FOREACH_SAFE(entry, &V_spdcachehashtbl[hashv], chain, tmpentry) {
897 /* Removed outdated entries */
898 if (entry->sp != NULL &&
899 entry->sp->state == IPSEC_SPSTATE_DEAD) {
900 LIST_REMOVE(entry, chain);
901 spdcache_entry_free(entry);
906 if (!key_cmpspidx_exactly(&entry->spidx, spidx)) {
912 if (entry->sp != NULL)
915 /* IPSECSTAT_INC(ips_spdcache_hits); */
917 SPDCACHE_UNLOCK(hashv);
921 /* IPSECSTAT_INC(ips_spdcache_misses); */
923 sp = key_do_allocsp(spidx, dir);
924 entry = spdcache_entry_alloc(spidx, sp);
926 if (nb_entries >= SPDCACHE_MAX_ENTRIES_PER_HASH) {
927 LIST_REMOVE(lastentry, chain);
928 spdcache_entry_free(lastentry);
931 LIST_INSERT_HEAD(&V_spdcachehashtbl[hashv], entry, chain);
934 SPDCACHE_UNLOCK(hashv);
937 if (sp != NULL) { /* found a SPD entry */
938 sp->lastused = time_second;
940 printf("%s: return SP(%p)\n", __func__, sp));
941 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
944 printf("%s: lookup failed for ", __func__);
945 kdebug_secpolicyindex(spidx, NULL));
951 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
952 * or should be signed by MD5 signature.
953 * We don't use key_allocsa() for such lookups, because we don't know SPI.
954 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
955 * signed packet. We use SADB only as storage for password.
956 * OUT: positive: corresponding SA for given saidx found.
960 key_allocsa_tcpmd5(struct secasindex *saidx)
962 SAHTREE_RLOCK_TRACKER;
963 struct secashead *sah;
964 struct secasvar *sav;
966 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
967 ("unexpected security protocol %u", saidx->proto));
968 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
969 ("unexpected mode %u", saidx->mode));
972 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
974 printf("%s: checking SAH\n", __func__);
975 kdebug_secash(sah, " "));
976 if (sah->saidx.proto != IPPROTO_TCP)
978 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
979 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
983 if (V_key_preferred_oldsa)
984 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
986 sav = TAILQ_FIRST(&sah->savtree_alive);
995 printf("%s: return SA(%p)\n", __func__, sav));
996 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
999 printf("%s: SA not found\n", __func__));
1000 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1006 * Allocating an SA entry for an *OUTBOUND* packet.
1007 * OUT: positive: corresponding SA for given saidx found.
1008 * NULL: SA not found, but will be acquired, check *error
1009 * for acquiring status.
1012 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
1015 SAHTREE_RLOCK_TRACKER;
1016 struct secashead *sah;
1017 struct secasvar *sav;
1019 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
1020 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
1021 saidx->mode == IPSEC_MODE_TUNNEL,
1022 ("unexpected policy %u", saidx->mode));
1025 * We check new SA in the IPsec request because a different
1026 * SA may be involved each time this request is checked, either
1027 * because new SAs are being configured, or this request is
1028 * associated with an unconnected datagram socket, or this request
1029 * is associated with a system default policy.
1032 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
1034 printf("%s: checking SAH\n", __func__);
1035 kdebug_secash(sah, " "));
1036 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
1041 * Allocate the oldest SA available according to
1042 * draft-jenkins-ipsec-rekeying-03.
1044 if (V_key_preferred_oldsa)
1045 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1047 sav = TAILQ_FIRST(&sah->savtree_alive);
1057 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
1059 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1060 return (sav); /* return referenced SA */
1063 /* there is no SA */
1064 *error = key_acquire(saidx, sp);
1066 ipseclog((LOG_DEBUG,
1067 "%s: error %d returned from key_acquire()\n",
1070 printf("%s: acquire SA for SP(%p), error %d\n",
1071 __func__, sp, *error));
1072 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1077 * allocating a usable SA entry for a *INBOUND* packet.
1078 * Must call key_freesav() later.
1079 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
1080 * NULL: not found, or error occurred.
1082 * According to RFC 2401 SA is uniquely identified by a triple SPI,
1083 * destination address, and security protocol. But according to RFC 4301,
1084 * SPI by itself suffices to specify an SA.
1086 * Note that, however, we do need to keep source address in IPsec SA.
1087 * IKE specification and PF_KEY specification do assume that we
1088 * keep source address in IPsec SA. We see a tricky situation here.
1091 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
1093 SAHTREE_RLOCK_TRACKER;
1094 struct secasvar *sav;
1096 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
1097 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
1101 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
1102 if (sav->spi == spi)
1106 * We use single SPI namespace for all protocols, so it is
1107 * impossible to have SPI duplicates in the SAVHASH.
1110 if (sav->state != SADB_SASTATE_LARVAL &&
1111 sav->sah->saidx.proto == proto &&
1112 key_sockaddrcmp(&dst->sa,
1113 &sav->sah->saidx.dst.sa, 0) == 0)
1122 char buf[IPSEC_ADDRSTRLEN];
1123 printf("%s: SA not found for spi %u proto %u dst %s\n",
1124 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1128 printf("%s: return SA(%p)\n", __func__, sav));
1129 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1135 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1138 SAHTREE_RLOCK_TRACKER;
1139 struct secasindex saidx;
1140 struct secashead *sah;
1141 struct secasvar *sav;
1143 IPSEC_ASSERT(src != NULL, ("null src address"));
1144 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1146 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1151 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1152 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1154 if (proto != sah->saidx.proto)
1156 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1158 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1160 /* XXXAE: is key_preferred_oldsa reasonably?*/
1161 if (V_key_preferred_oldsa)
1162 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1164 sav = TAILQ_FIRST(&sah->savtree_alive);
1172 printf("%s: return SA(%p)\n", __func__, sav));
1174 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1179 * Must be called after calling key_allocsp().
1182 key_freesp(struct secpolicy **spp)
1184 struct secpolicy *sp = *spp;
1186 IPSEC_ASSERT(sp != NULL, ("null sp"));
1187 if (SP_DELREF(sp) == 0)
1191 printf("%s: last reference to SP(%p)\n", __func__, sp));
1192 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1195 while (sp->tcount > 0)
1196 ipsec_delisr(sp->req[--sp->tcount]);
1197 free(sp, M_IPSEC_SP);
1201 key_unlink(struct secpolicy *sp)
1204 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1205 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1206 ("invalid direction %u", sp->spidx.dir));
1207 SPTREE_UNLOCK_ASSERT();
1210 printf("%s: SP(%p)\n", __func__, sp));
1212 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1213 /* SP is already unlinked */
1217 sp->state = IPSEC_SPSTATE_DEAD;
1218 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1220 LIST_REMOVE(sp, idhash);
1223 if (SPDCACHE_ENABLED())
1229 * insert a secpolicy into the SP database. Lower priorities first
1232 key_insertsp(struct secpolicy *newsp)
1234 struct secpolicy *sp;
1236 SPTREE_WLOCK_ASSERT();
1237 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1238 if (newsp->priority < sp->priority) {
1239 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1243 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1245 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1246 newsp->state = IPSEC_SPSTATE_ALIVE;
1252 * Insert a bunch of VTI secpolicies into the SPDB.
1253 * We keep VTI policies in the separate list due to following reasons:
1254 * 1) they should be immutable to user's or some deamon's attempts to
1255 * delete. The only way delete such policies - destroy or unconfigure
1256 * corresponding virtual inteface.
1257 * 2) such policies have traffic selector that matches all traffic per
1259 * Since all VTI policies have the same priority, we don't care about
1263 key_register_ifnet(struct secpolicy **spp, u_int count)
1270 * First of try to acquire id for each SP.
1272 for (i = 0; i < count; i++) {
1273 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1274 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1275 ("invalid direction %u", spp[i]->spidx.dir));
1277 if ((spp[i]->id = key_getnewspid()) == 0) {
1282 for (i = 0; i < count; i++) {
1283 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1286 * NOTE: despite the fact that we keep VTI SP in the
1287 * separate list, SPHASH contains policies from both
1288 * sources. Thus SADB_X_SPDGET will correctly return
1289 * SP by id, because it uses SPHASH for lookups.
1291 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1292 spp[i]->state = IPSEC_SPSTATE_IFNET;
1296 * Notify user processes about new SP.
1298 for (i = 0; i < count; i++) {
1299 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1301 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1307 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1313 for (i = 0; i < count; i++) {
1314 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1315 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1316 ("invalid direction %u", spp[i]->spidx.dir));
1318 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1320 spp[i]->state = IPSEC_SPSTATE_DEAD;
1321 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1324 LIST_REMOVE(spp[i], idhash);
1327 if (SPDCACHE_ENABLED())
1330 for (i = 0; i < count; i++) {
1331 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1333 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1338 * Must be called after calling key_allocsa().
1339 * This function is called by key_freesp() to free some SA allocated
1343 key_freesav(struct secasvar **psav)
1345 struct secasvar *sav = *psav;
1347 IPSEC_ASSERT(sav != NULL, ("null sav"));
1348 if (SAV_DELREF(sav) == 0)
1352 printf("%s: last reference to SA(%p)\n", __func__, sav));
1359 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1360 * Expect that SA has extra reference due to lookup.
1361 * Release this references, also release SAH reference after unlink.
1364 key_unlinksav(struct secasvar *sav)
1366 struct secashead *sah;
1369 printf("%s: SA(%p)\n", __func__, sav));
1371 SAHTREE_UNLOCK_ASSERT();
1373 if (sav->state == SADB_SASTATE_DEAD) {
1374 /* SA is already unlinked */
1378 /* Unlink from SAH */
1379 if (sav->state == SADB_SASTATE_LARVAL)
1380 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1382 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1383 /* Unlink from SPI hash */
1384 LIST_REMOVE(sav, spihash);
1385 sav->state = SADB_SASTATE_DEAD;
1389 /* Since we are unlinked, release reference to SAH */
1393 /* %%% SPD management */
1396 * OUT: NULL : not found
1397 * others : found, pointer to a SP.
1399 static struct secpolicy *
1400 key_getsp(struct secpolicyindex *spidx)
1402 SPTREE_RLOCK_TRACKER;
1403 struct secpolicy *sp;
1405 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1408 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1409 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1421 * OUT: NULL : not found
1422 * others : found, pointer to referenced SP.
1424 static struct secpolicy *
1425 key_getspbyid(uint32_t id)
1427 SPTREE_RLOCK_TRACKER;
1428 struct secpolicy *sp;
1431 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1444 struct secpolicy *sp;
1446 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1452 struct ipsecrequest *
1456 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1457 M_NOWAIT | M_ZERO));
1461 ipsec_delisr(struct ipsecrequest *p)
1464 free(p, M_IPSEC_SR);
1468 * create secpolicy structure from sadb_x_policy structure.
1469 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1470 * are not set, so must be set properly later.
1473 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1475 struct secpolicy *newsp;
1477 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1478 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1480 if (len != PFKEY_EXTLEN(xpl0)) {
1481 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1486 if ((newsp = key_newsp()) == NULL) {
1491 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1492 newsp->policy = xpl0->sadb_x_policy_type;
1493 newsp->priority = xpl0->sadb_x_policy_priority;
1497 switch (xpl0->sadb_x_policy_type) {
1498 case IPSEC_POLICY_DISCARD:
1499 case IPSEC_POLICY_NONE:
1500 case IPSEC_POLICY_ENTRUST:
1501 case IPSEC_POLICY_BYPASS:
1504 case IPSEC_POLICY_IPSEC:
1506 struct sadb_x_ipsecrequest *xisr;
1507 struct ipsecrequest *isr;
1510 /* validity check */
1511 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1512 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1519 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1520 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1524 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1525 xisr->sadb_x_ipsecrequest_len > tlen) {
1526 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1527 "length.\n", __func__));
1533 if (newsp->tcount >= IPSEC_MAXREQ) {
1534 ipseclog((LOG_DEBUG,
1535 "%s: too many ipsecrequests.\n",
1542 /* allocate request buffer */
1543 /* NB: data structure is zero'd */
1544 isr = ipsec_newisr();
1546 ipseclog((LOG_DEBUG,
1547 "%s: No more memory.\n", __func__));
1553 newsp->req[newsp->tcount++] = isr;
1556 switch (xisr->sadb_x_ipsecrequest_proto) {
1559 case IPPROTO_IPCOMP:
1562 ipseclog((LOG_DEBUG,
1563 "%s: invalid proto type=%u\n", __func__,
1564 xisr->sadb_x_ipsecrequest_proto));
1566 *error = EPROTONOSUPPORT;
1570 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1572 switch (xisr->sadb_x_ipsecrequest_mode) {
1573 case IPSEC_MODE_TRANSPORT:
1574 case IPSEC_MODE_TUNNEL:
1576 case IPSEC_MODE_ANY:
1578 ipseclog((LOG_DEBUG,
1579 "%s: invalid mode=%u\n", __func__,
1580 xisr->sadb_x_ipsecrequest_mode));
1585 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1587 switch (xisr->sadb_x_ipsecrequest_level) {
1588 case IPSEC_LEVEL_DEFAULT:
1589 case IPSEC_LEVEL_USE:
1590 case IPSEC_LEVEL_REQUIRE:
1592 case IPSEC_LEVEL_UNIQUE:
1593 /* validity check */
1595 * If range violation of reqid, kernel will
1596 * update it, don't refuse it.
1598 if (xisr->sadb_x_ipsecrequest_reqid
1599 > IPSEC_MANUAL_REQID_MAX) {
1600 ipseclog((LOG_DEBUG,
1601 "%s: reqid=%d range "
1602 "violation, updated by kernel.\n",
1604 xisr->sadb_x_ipsecrequest_reqid));
1605 xisr->sadb_x_ipsecrequest_reqid = 0;
1608 /* allocate new reqid id if reqid is zero. */
1609 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1611 if ((reqid = key_newreqid()) == 0) {
1616 isr->saidx.reqid = reqid;
1617 xisr->sadb_x_ipsecrequest_reqid = reqid;
1619 /* set it for manual keying. */
1621 xisr->sadb_x_ipsecrequest_reqid;
1626 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1628 xisr->sadb_x_ipsecrequest_level));
1633 isr->level = xisr->sadb_x_ipsecrequest_level;
1635 /* set IP addresses if there */
1636 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1637 struct sockaddr *paddr;
1639 len = tlen - sizeof(*xisr);
1640 paddr = (struct sockaddr *)(xisr + 1);
1641 /* validity check */
1642 if (len < sizeof(struct sockaddr) ||
1643 len < 2 * paddr->sa_len ||
1644 paddr->sa_len > sizeof(isr->saidx.src)) {
1645 ipseclog((LOG_DEBUG, "%s: invalid "
1646 "request address length.\n",
1653 * Request length should be enough to keep
1654 * source and destination addresses.
1656 if (xisr->sadb_x_ipsecrequest_len <
1657 sizeof(*xisr) + 2 * paddr->sa_len) {
1658 ipseclog((LOG_DEBUG, "%s: invalid "
1659 "ipsecrequest length.\n",
1665 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1666 paddr = (struct sockaddr *)((caddr_t)paddr +
1669 /* validity check */
1670 if (paddr->sa_len !=
1671 isr->saidx.src.sa.sa_len) {
1672 ipseclog((LOG_DEBUG, "%s: invalid "
1673 "request address length.\n",
1679 /* AF family should match */
1680 if (paddr->sa_family !=
1681 isr->saidx.src.sa.sa_family) {
1682 ipseclog((LOG_DEBUG, "%s: address "
1683 "family doesn't match.\n",
1689 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1692 * Addresses for TUNNEL mode requests are
1695 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1696 ipseclog((LOG_DEBUG, "%s: missing "
1697 "request addresses.\n", __func__));
1703 tlen -= xisr->sadb_x_ipsecrequest_len;
1705 /* validity check */
1707 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1714 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1715 + xisr->sadb_x_ipsecrequest_len);
1717 /* XXXAE: LARVAL SP */
1718 if (newsp->tcount < 1) {
1719 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1720 "not found.\n", __func__));
1728 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1741 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1743 if (auto_reqid == ~0)
1744 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1748 /* XXX should be unique check */
1749 return (auto_reqid);
1753 * copy secpolicy struct to sadb_x_policy structure indicated.
1755 static struct mbuf *
1756 key_sp2mbuf(struct secpolicy *sp)
1761 tlen = key_getspreqmsglen(sp);
1762 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1767 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1775 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1777 struct sadb_x_ipsecrequest *xisr;
1778 struct sadb_x_policy *xpl;
1779 struct ipsecrequest *isr;
1784 IPSEC_ASSERT(sp != NULL, ("null policy"));
1786 xlen = sizeof(*xpl);
1791 bzero(request, *len);
1792 xpl = (struct sadb_x_policy *)request;
1793 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1794 xpl->sadb_x_policy_type = sp->policy;
1795 xpl->sadb_x_policy_dir = sp->spidx.dir;
1796 xpl->sadb_x_policy_id = sp->id;
1797 xpl->sadb_x_policy_priority = sp->priority;
1798 switch (sp->state) {
1799 case IPSEC_SPSTATE_IFNET:
1800 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1802 case IPSEC_SPSTATE_PCB:
1803 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1806 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1809 /* if is the policy for ipsec ? */
1810 if (sp->policy == IPSEC_POLICY_IPSEC) {
1811 p = (caddr_t)xpl + sizeof(*xpl);
1812 for (i = 0; i < sp->tcount; i++) {
1814 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1815 isr->saidx.src.sa.sa_len +
1816 isr->saidx.dst.sa.sa_len);
1820 /* Calculate needed size */
1823 xisr = (struct sadb_x_ipsecrequest *)p;
1824 xisr->sadb_x_ipsecrequest_len = ilen;
1825 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1826 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1827 xisr->sadb_x_ipsecrequest_level = isr->level;
1828 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1831 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1832 p += isr->saidx.src.sa.sa_len;
1833 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1834 p += isr->saidx.dst.sa.sa_len;
1837 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1841 *len = sizeof(*xpl);
1845 /* m will not be freed nor modified */
1846 static struct mbuf *
1847 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1848 int ndeep, int nitem, ...)
1853 struct mbuf *result = NULL, *n;
1856 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1857 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1859 va_start(ap, nitem);
1860 for (i = 0; i < nitem; i++) {
1861 idx = va_arg(ap, int);
1862 if (idx < 0 || idx > SADB_EXT_MAX)
1864 /* don't attempt to pull empty extension */
1865 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1867 if (idx != SADB_EXT_RESERVED &&
1868 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1871 if (idx == SADB_EXT_RESERVED) {
1872 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1874 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1876 MGETHDR(n, M_NOWAIT, MT_DATA);
1881 m_copydata(m, 0, sizeof(struct sadb_msg),
1883 } else if (i < ndeep) {
1884 len = mhp->extlen[idx];
1885 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1890 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1893 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1906 if ((result->m_flags & M_PKTHDR) != 0) {
1907 result->m_pkthdr.len = 0;
1908 for (n = result; n; n = n->m_next)
1909 result->m_pkthdr.len += n->m_len;
1921 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1922 * add an entry to SP database, when received
1923 * <base, address(SD), (lifetime(H),) policy>
1925 * Adding to SP database,
1927 * <base, address(SD), (lifetime(H),) policy>
1928 * to the socket which was send.
1930 * SPDADD set a unique policy entry.
1931 * SPDSETIDX like SPDADD without a part of policy requests.
1932 * SPDUPDATE replace a unique policy entry.
1934 * XXXAE: serialize this in PF_KEY to avoid races.
1935 * m will always be freed.
1938 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1940 struct secpolicyindex spidx;
1941 struct sadb_address *src0, *dst0;
1942 struct sadb_x_policy *xpl0, *xpl;
1943 struct sadb_lifetime *lft = NULL;
1944 struct secpolicy *newsp;
1947 IPSEC_ASSERT(so != NULL, ("null socket"));
1948 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1949 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1950 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1952 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1953 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1954 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1955 ipseclog((LOG_DEBUG,
1956 "%s: invalid message: missing required header.\n",
1958 return key_senderror(so, m, EINVAL);
1960 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1961 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1962 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1963 ipseclog((LOG_DEBUG,
1964 "%s: invalid message: wrong header size.\n", __func__));
1965 return key_senderror(so, m, EINVAL);
1967 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1968 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1969 ipseclog((LOG_DEBUG,
1970 "%s: invalid message: wrong header size.\n",
1972 return key_senderror(so, m, EINVAL);
1974 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1977 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1978 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1979 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1981 /* check the direciton */
1982 switch (xpl0->sadb_x_policy_dir) {
1983 case IPSEC_DIR_INBOUND:
1984 case IPSEC_DIR_OUTBOUND:
1987 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
1988 return key_senderror(so, m, EINVAL);
1990 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
1991 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
1992 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
1993 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
1994 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1995 return key_senderror(so, m, EINVAL);
1998 /* policy requests are mandatory when action is ipsec. */
1999 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
2000 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2001 ipseclog((LOG_DEBUG,
2002 "%s: policy requests required.\n", __func__));
2003 return key_senderror(so, m, EINVAL);
2006 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
2007 (struct sockaddr *)(dst0 + 1));
2009 src0->sadb_address_proto != dst0->sadb_address_proto) {
2010 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2011 return key_senderror(so, m, error);
2014 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2017 src0->sadb_address_prefixlen,
2018 dst0->sadb_address_prefixlen,
2019 src0->sadb_address_proto,
2021 /* Checking there is SP already or not. */
2022 newsp = key_getsp(&spidx);
2023 if (newsp != NULL) {
2024 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2026 printf("%s: unlink SP(%p) for SPDUPDATE\n",
2028 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2033 ipseclog((LOG_DEBUG,
2034 "%s: a SP entry exists already.\n", __func__));
2035 return (key_senderror(so, m, EEXIST));
2039 /* allocate new SP entry */
2040 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2041 return key_senderror(so, m, error);
2044 newsp->lastused = newsp->created = time_second;
2045 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
2046 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
2047 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
2049 /* XXXAE: there is race between key_getsp() and key_insertsp() */
2051 if ((newsp->id = key_getnewspid()) == 0) {
2054 return key_senderror(so, m, ENOBUFS);
2056 key_insertsp(newsp);
2058 if (SPDCACHE_ENABLED())
2062 printf("%s: SP(%p)\n", __func__, newsp));
2063 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2066 struct mbuf *n, *mpolicy;
2067 struct sadb_msg *newmsg;
2070 /* create new sadb_msg to reply. */
2072 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
2073 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
2074 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2076 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
2078 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2081 return key_senderror(so, m, ENOBUFS);
2083 if (n->m_len < sizeof(*newmsg)) {
2084 n = m_pullup(n, sizeof(*newmsg));
2086 return key_senderror(so, m, ENOBUFS);
2088 newmsg = mtod(n, struct sadb_msg *);
2089 newmsg->sadb_msg_errno = 0;
2090 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2093 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2094 sizeof(*xpl), &off);
2095 if (mpolicy == NULL) {
2096 /* n is already freed */
2097 return key_senderror(so, m, ENOBUFS);
2099 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
2100 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2102 return key_senderror(so, m, EINVAL);
2104 xpl->sadb_x_policy_id = newsp->id;
2107 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2112 * get new policy id.
2118 key_getnewspid(void)
2120 struct secpolicy *sp;
2122 int count = V_key_spi_trycnt; /* XXX */
2124 SPTREE_WLOCK_ASSERT();
2126 if (V_policy_id == ~0) /* overflowed */
2127 newid = V_policy_id = 1;
2129 newid = ++V_policy_id;
2130 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2131 if (sp->id == newid)
2137 if (count == 0 || newid == 0) {
2138 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2146 * SADB_SPDDELETE processing
2148 * <base, address(SD), policy(*)>
2149 * from the user(?), and set SADB_SASTATE_DEAD,
2151 * <base, address(SD), policy(*)>
2153 * policy(*) including direction of policy.
2155 * m will always be freed.
2158 key_spddelete(struct socket *so, struct mbuf *m,
2159 const struct sadb_msghdr *mhp)
2161 struct secpolicyindex spidx;
2162 struct sadb_address *src0, *dst0;
2163 struct sadb_x_policy *xpl0;
2164 struct secpolicy *sp;
2166 IPSEC_ASSERT(so != NULL, ("null so"));
2167 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2168 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2169 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2171 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2172 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2173 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2174 ipseclog((LOG_DEBUG,
2175 "%s: invalid message: missing required header.\n",
2177 return key_senderror(so, m, EINVAL);
2179 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2180 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2181 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2182 ipseclog((LOG_DEBUG,
2183 "%s: invalid message: wrong header size.\n", __func__));
2184 return key_senderror(so, m, EINVAL);
2187 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2188 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2189 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2191 /* check the direciton */
2192 switch (xpl0->sadb_x_policy_dir) {
2193 case IPSEC_DIR_INBOUND:
2194 case IPSEC_DIR_OUTBOUND:
2197 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2198 return key_senderror(so, m, EINVAL);
2200 /* Only DISCARD, NONE and IPSEC are allowed */
2201 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2202 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2203 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2204 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2205 return key_senderror(so, m, EINVAL);
2207 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2208 (struct sockaddr *)(dst0 + 1)) != 0 ||
2209 src0->sadb_address_proto != dst0->sadb_address_proto) {
2210 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2211 return key_senderror(so, m, EINVAL);
2214 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2217 src0->sadb_address_prefixlen,
2218 dst0->sadb_address_prefixlen,
2219 src0->sadb_address_proto,
2222 /* Is there SP in SPD ? */
2223 if ((sp = key_getsp(&spidx)) == NULL) {
2224 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2225 return key_senderror(so, m, EINVAL);
2228 /* save policy id to buffer to be returned. */
2229 xpl0->sadb_x_policy_id = sp->id;
2232 printf("%s: SP(%p)\n", __func__, sp));
2233 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2239 struct sadb_msg *newmsg;
2241 /* create new sadb_msg to reply. */
2242 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2243 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2245 return key_senderror(so, m, ENOBUFS);
2247 newmsg = mtod(n, struct sadb_msg *);
2248 newmsg->sadb_msg_errno = 0;
2249 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2252 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2257 * SADB_SPDDELETE2 processing
2260 * from the user(?), and set SADB_SASTATE_DEAD,
2264 * policy(*) including direction of policy.
2266 * m will always be freed.
2269 key_spddelete2(struct socket *so, struct mbuf *m,
2270 const struct sadb_msghdr *mhp)
2272 struct secpolicy *sp;
2275 IPSEC_ASSERT(so != NULL, ("null socket"));
2276 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2277 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2278 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2280 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2281 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2282 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2284 return key_senderror(so, m, EINVAL);
2287 id = ((struct sadb_x_policy *)
2288 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2290 /* Is there SP in SPD ? */
2291 if ((sp = key_getspbyid(id)) == NULL) {
2292 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2294 return key_senderror(so, m, EINVAL);
2298 printf("%s: SP(%p)\n", __func__, sp));
2299 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2301 if (sp->state != IPSEC_SPSTATE_DEAD) {
2302 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2305 return (key_senderror(so, m, EACCES));
2310 struct mbuf *n, *nn;
2311 struct sadb_msg *newmsg;
2314 /* create new sadb_msg to reply. */
2315 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2317 MGETHDR(n, M_NOWAIT, MT_DATA);
2318 if (n && len > MHLEN) {
2319 if (!(MCLGET(n, M_NOWAIT))) {
2325 return key_senderror(so, m, ENOBUFS);
2331 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2332 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2334 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2337 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2338 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2341 return key_senderror(so, m, ENOBUFS);
2344 n->m_pkthdr.len = 0;
2345 for (nn = n; nn; nn = nn->m_next)
2346 n->m_pkthdr.len += nn->m_len;
2348 newmsg = mtod(n, struct sadb_msg *);
2349 newmsg->sadb_msg_errno = 0;
2350 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2353 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2358 * SADB_X_SPDGET processing
2363 * <base, address(SD), policy>
2365 * policy(*) including direction of policy.
2367 * m will always be freed.
2370 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2372 struct secpolicy *sp;
2376 IPSEC_ASSERT(so != NULL, ("null socket"));
2377 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2378 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2379 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2381 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2382 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2383 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2385 return key_senderror(so, m, EINVAL);
2388 id = ((struct sadb_x_policy *)
2389 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2391 /* Is there SP in SPD ? */
2392 if ((sp = key_getspbyid(id)) == NULL) {
2393 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2395 return key_senderror(so, m, ENOENT);
2398 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2399 mhp->msg->sadb_msg_pid);
2403 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2405 return key_senderror(so, m, ENOBUFS);
2409 * SADB_X_SPDACQUIRE processing.
2410 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2413 * to KMD, and expect to receive
2414 * <base> with SADB_X_SPDACQUIRE if error occurred,
2417 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2418 * policy(*) is without policy requests.
2421 * others: error number
2424 key_spdacquire(struct secpolicy *sp)
2426 struct mbuf *result = NULL, *m;
2427 struct secspacq *newspacq;
2429 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2430 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2431 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2432 ("policy not IPSEC %u", sp->policy));
2434 /* Get an entry to check whether sent message or not. */
2435 newspacq = key_getspacq(&sp->spidx);
2436 if (newspacq != NULL) {
2437 if (V_key_blockacq_count < newspacq->count) {
2438 /* reset counter and do send message. */
2439 newspacq->count = 0;
2441 /* increment counter and do nothing. */
2448 /* make new entry for blocking to send SADB_ACQUIRE. */
2449 newspacq = key_newspacq(&sp->spidx);
2450 if (newspacq == NULL)
2454 /* create new sadb_msg to reply. */
2455 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2461 result->m_pkthdr.len = 0;
2462 for (m = result; m; m = m->m_next)
2463 result->m_pkthdr.len += m->m_len;
2465 mtod(result, struct sadb_msg *)->sadb_msg_len =
2466 PFKEY_UNIT64(result->m_pkthdr.len);
2468 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2472 * SADB_SPDFLUSH processing
2475 * from the user, and free all entries in secpctree.
2479 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2481 * m will always be freed.
2484 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2486 struct secpolicy_queue drainq;
2487 struct sadb_msg *newmsg;
2488 struct secpolicy *sp, *nextsp;
2491 IPSEC_ASSERT(so != NULL, ("null socket"));
2492 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2493 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2494 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2496 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2497 return key_senderror(so, m, EINVAL);
2499 TAILQ_INIT(&drainq);
2501 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2502 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2505 * We need to set state to DEAD for each policy to be sure,
2506 * that another thread won't try to unlink it.
2507 * Also remove SP from sphash.
2509 TAILQ_FOREACH(sp, &drainq, chain) {
2510 sp->state = IPSEC_SPSTATE_DEAD;
2511 LIST_REMOVE(sp, idhash);
2516 if (SPDCACHE_ENABLED())
2518 sp = TAILQ_FIRST(&drainq);
2519 while (sp != NULL) {
2520 nextsp = TAILQ_NEXT(sp, chain);
2525 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2526 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2527 return key_senderror(so, m, ENOBUFS);
2533 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2534 newmsg = mtod(m, struct sadb_msg *);
2535 newmsg->sadb_msg_errno = 0;
2536 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2538 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2542 key_satype2scopemask(uint8_t satype)
2545 if (satype == IPSEC_POLICYSCOPE_ANY)
2550 * SADB_SPDDUMP processing
2553 * from the user, and dump all SP leaves and send,
2558 * sadb_msg_satype is considered as mask of policy scopes.
2559 * m will always be freed.
2562 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2564 SPTREE_RLOCK_TRACKER;
2565 struct secpolicy *sp;
2570 IPSEC_ASSERT(so != NULL, ("null socket"));
2571 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2572 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2573 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2575 /* search SPD entry and get buffer size. */
2577 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2579 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2580 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2581 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2584 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2585 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2592 return key_senderror(so, m, ENOENT);
2595 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2596 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2597 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2599 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2600 mhp->msg->sadb_msg_pid);
2603 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2606 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2607 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2609 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2610 mhp->msg->sadb_msg_pid);
2613 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2623 static struct mbuf *
2624 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2627 struct mbuf *result = NULL, *m;
2628 struct seclifetime lt;
2630 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2635 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2636 &sp->spidx.src.sa, sp->spidx.prefs,
2637 sp->spidx.ul_proto);
2642 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2643 &sp->spidx.dst.sa, sp->spidx.prefd,
2644 sp->spidx.ul_proto);
2649 m = key_sp2mbuf(sp);
2655 lt.addtime=sp->created;
2656 lt.usetime= sp->lastused;
2657 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2662 lt.addtime=sp->lifetime;
2663 lt.usetime= sp->validtime;
2664 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2670 if ((result->m_flags & M_PKTHDR) == 0)
2673 if (result->m_len < sizeof(struct sadb_msg)) {
2674 result = m_pullup(result, sizeof(struct sadb_msg));
2679 result->m_pkthdr.len = 0;
2680 for (m = result; m; m = m->m_next)
2681 result->m_pkthdr.len += m->m_len;
2683 mtod(result, struct sadb_msg *)->sadb_msg_len =
2684 PFKEY_UNIT64(result->m_pkthdr.len);
2693 * get PFKEY message length for security policy and request.
2696 key_getspreqmsglen(struct secpolicy *sp)
2701 tlen = sizeof(struct sadb_x_policy);
2702 /* if is the policy for ipsec ? */
2703 if (sp->policy != IPSEC_POLICY_IPSEC)
2706 /* get length of ipsec requests */
2707 for (i = 0; i < sp->tcount; i++) {
2708 len = sizeof(struct sadb_x_ipsecrequest)
2709 + sp->req[i]->saidx.src.sa.sa_len
2710 + sp->req[i]->saidx.dst.sa.sa_len;
2712 tlen += PFKEY_ALIGN8(len);
2718 * SADB_SPDEXPIRE processing
2720 * <base, address(SD), lifetime(CH), policy>
2724 * others : error number
2727 key_spdexpire(struct secpolicy *sp)
2729 struct sadb_lifetime *lt;
2730 struct mbuf *result = NULL, *m;
2731 int len, error = -1;
2733 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2736 printf("%s: SP(%p)\n", __func__, sp));
2737 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2739 /* set msg header */
2740 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2747 /* create lifetime extension (current and hard) */
2748 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2749 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2756 bzero(mtod(m, caddr_t), len);
2757 lt = mtod(m, struct sadb_lifetime *);
2758 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2759 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2760 lt->sadb_lifetime_allocations = 0;
2761 lt->sadb_lifetime_bytes = 0;
2762 lt->sadb_lifetime_addtime = sp->created;
2763 lt->sadb_lifetime_usetime = sp->lastused;
2764 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2765 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2766 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2767 lt->sadb_lifetime_allocations = 0;
2768 lt->sadb_lifetime_bytes = 0;
2769 lt->sadb_lifetime_addtime = sp->lifetime;
2770 lt->sadb_lifetime_usetime = sp->validtime;
2773 /* set sadb_address for source */
2774 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2776 sp->spidx.prefs, sp->spidx.ul_proto);
2783 /* set sadb_address for destination */
2784 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2786 sp->spidx.prefd, sp->spidx.ul_proto);
2794 m = key_sp2mbuf(sp);
2801 if ((result->m_flags & M_PKTHDR) == 0) {
2806 if (result->m_len < sizeof(struct sadb_msg)) {
2807 result = m_pullup(result, sizeof(struct sadb_msg));
2808 if (result == NULL) {
2814 result->m_pkthdr.len = 0;
2815 for (m = result; m; m = m->m_next)
2816 result->m_pkthdr.len += m->m_len;
2818 mtod(result, struct sadb_msg *)->sadb_msg_len =
2819 PFKEY_UNIT64(result->m_pkthdr.len);
2821 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2829 /* %%% SAD management */
2831 * allocating and initialize new SA head.
2832 * OUT: NULL : failure due to the lack of memory.
2833 * others : pointer to new SA head.
2835 static struct secashead *
2836 key_newsah(struct secasindex *saidx)
2838 struct secashead *sah;
2840 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2843 PFKEYSTAT_INC(in_nomem);
2846 TAILQ_INIT(&sah->savtree_larval);
2847 TAILQ_INIT(&sah->savtree_alive);
2848 sah->saidx = *saidx;
2849 sah->state = SADB_SASTATE_DEAD;
2853 printf("%s: SAH(%p)\n", __func__, sah));
2854 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2859 key_freesah(struct secashead **psah)
2861 struct secashead *sah = *psah;
2863 if (SAH_DELREF(sah) == 0)
2867 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2868 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2875 key_delsah(struct secashead *sah)
2877 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2878 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2879 ("Attempt to free non DEAD SAH %p", sah));
2880 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2881 ("Attempt to free SAH %p with LARVAL SA", sah));
2882 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2883 ("Attempt to free SAH %p with ALIVE SA", sah));
2885 free(sah, M_IPSEC_SAH);
2889 * allocating a new SA for key_add() and key_getspi() call,
2890 * and copy the values of mhp into new buffer.
2891 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2892 * For SADB_ADD create and initialize SA with MATURE state.
2894 * others : pointer to new secasvar.
2896 static struct secasvar *
2897 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2898 uint32_t spi, int *errp)
2900 struct secashead *sah;
2901 struct secasvar *sav;
2904 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2905 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2906 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2907 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2911 /* check SPI value */
2912 switch (saidx->proto) {
2916 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2917 * 1-255 reserved by IANA for future use,
2918 * 0 for implementation specific, local use.
2920 if (ntohl(spi) <= 255) {
2921 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2922 __func__, ntohl(spi)));
2929 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2934 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2936 if (sav->lock == NULL) {
2940 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2941 sav->lft_c = uma_zalloc_pcpu(ipsec_key_lft_zone, M_NOWAIT | M_ZERO);
2942 if (sav->lft_c == NULL) {
2948 sav->seq = mhp->msg->sadb_msg_seq;
2949 sav->state = SADB_SASTATE_LARVAL;
2950 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2953 sah = key_getsah(saidx);
2955 /* create a new SA index */
2956 sah = key_newsah(saidx);
2958 ipseclog((LOG_DEBUG,
2959 "%s: No more memory.\n", __func__));
2968 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2969 sav->created = time_second;
2970 } else if (sav->state == SADB_SASTATE_LARVAL) {
2972 * Do not call key_setsaval() second time in case
2973 * of `goto again`. We will have MATURE state.
2975 *errp = key_setsaval(sav, mhp);
2978 sav->state = SADB_SASTATE_MATURE;
2983 * Check that existing SAH wasn't unlinked.
2984 * Since we didn't hold the SAHTREE lock, it is possible,
2985 * that callout handler or key_flush() or key_delete() could
2988 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
2990 key_freesah(&sah); /* reference from key_getsah() */
2995 * Add new SAH into SADB.
2997 * XXXAE: we can serialize key_add and key_getspi calls, so
2998 * several threads will not fight in the race.
2999 * Otherwise we should check under SAHTREE lock, that this
3000 * SAH would not added twice.
3002 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
3003 /* Add new SAH into hash by addresses */
3004 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
3005 /* Now we are linked in the chain */
3006 sah->state = SADB_SASTATE_MATURE;
3008 * SAV references this new SAH.
3009 * In case of existing SAH we reuse reference
3010 * from key_getsah().
3014 /* Link SAV with SAH */
3015 if (sav->state == SADB_SASTATE_MATURE)
3016 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
3018 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
3019 /* Add SAV into SPI hash */
3020 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
3022 *errp = 0; /* success */
3026 if (sav->lock != NULL) {
3027 mtx_destroy(sav->lock);
3028 free(sav->lock, M_IPSEC_MISC);
3030 if (sav->lft_c != NULL)
3031 uma_zfree_pcpu(ipsec_key_lft_zone, sav->lft_c);
3032 free(sav, M_IPSEC_SA), sav = NULL;
3036 if (*errp == ENOBUFS) {
3037 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3039 PFKEYSTAT_INC(in_nomem);
3046 * free() SA variable entry.
3049 key_cleansav(struct secasvar *sav)
3052 if (sav->natt != NULL) {
3053 free(sav->natt, M_IPSEC_MISC);
3056 if (sav->flags & SADB_X_EXT_F_CLONED)
3058 if (sav->tdb_xform != NULL) {
3059 sav->tdb_xform->xf_cleanup(sav);
3060 sav->tdb_xform = NULL;
3062 if (sav->key_auth != NULL) {
3063 zfree(sav->key_auth->key_data, M_IPSEC_MISC);
3064 free(sav->key_auth, M_IPSEC_MISC);
3065 sav->key_auth = NULL;
3067 if (sav->key_enc != NULL) {
3068 zfree(sav->key_enc->key_data, M_IPSEC_MISC);
3069 free(sav->key_enc, M_IPSEC_MISC);
3070 sav->key_enc = NULL;
3072 if (sav->replay != NULL) {
3073 if (sav->replay->bitmap != NULL)
3074 free(sav->replay->bitmap, M_IPSEC_MISC);
3075 free(sav->replay, M_IPSEC_MISC);
3078 if (sav->lft_h != NULL) {
3079 free(sav->lft_h, M_IPSEC_MISC);
3082 if (sav->lft_s != NULL) {
3083 free(sav->lft_s, M_IPSEC_MISC);
3089 * free() SA variable entry.
3092 key_delsav(struct secasvar *sav)
3094 IPSEC_ASSERT(sav != NULL, ("null sav"));
3095 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
3096 ("attempt to free non DEAD SA %p", sav));
3097 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
3101 * SA must be unlinked from the chain and hashtbl.
3102 * If SA was cloned, we leave all fields untouched,
3103 * except NAT-T config.
3106 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
3107 mtx_destroy(sav->lock);
3108 free(sav->lock, M_IPSEC_MISC);
3109 uma_zfree_pcpu(ipsec_key_lft_zone, sav->lft_c);
3111 free(sav, M_IPSEC_SA);
3118 * others : found, referenced pointer to a SAH.
3120 static struct secashead *
3121 key_getsah(struct secasindex *saidx)
3123 SAHTREE_RLOCK_TRACKER;
3124 struct secashead *sah;
3127 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3128 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3138 * Check not to be duplicated SPI.
3141 * 1 : found SA with given SPI.
3144 key_checkspidup(uint32_t spi)
3146 SAHTREE_RLOCK_TRACKER;
3147 struct secasvar *sav;
3149 /* Assume SPI is in network byte order */
3151 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3152 if (sav->spi == spi)
3156 return (sav != NULL);
3163 * others : found, referenced pointer to a SA.
3165 static struct secasvar *
3166 key_getsavbyspi(uint32_t spi)
3168 SAHTREE_RLOCK_TRACKER;
3169 struct secasvar *sav;
3171 /* Assume SPI is in network byte order */
3173 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3174 if (sav->spi != spi)
3184 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3186 struct seclifetime *lft_h, *lft_s, *tmp;
3188 /* Lifetime extension is optional, check that it is present. */
3189 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3190 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3192 * In case of SADB_UPDATE we may need to change
3193 * existing lifetimes.
3195 if (sav->state == SADB_SASTATE_MATURE) {
3196 lft_h = lft_s = NULL;
3201 /* Both HARD and SOFT extensions must present */
3202 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3203 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3204 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3205 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3206 ipseclog((LOG_DEBUG,
3207 "%s: invalid message: missing required header.\n",
3211 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3212 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3213 ipseclog((LOG_DEBUG,
3214 "%s: invalid message: wrong header size.\n", __func__));
3217 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3218 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3219 if (lft_h == NULL) {
3220 PFKEYSTAT_INC(in_nomem);
3221 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3224 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3225 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3226 if (lft_s == NULL) {
3227 PFKEYSTAT_INC(in_nomem);
3228 free(lft_h, M_IPSEC_MISC);
3229 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3233 if (sav->state != SADB_SASTATE_LARVAL) {
3235 * key_update() holds reference to this SA,
3236 * so it won't be deleted in meanwhile.
3246 SECASVAR_UNLOCK(sav);
3248 free(lft_h, M_IPSEC_MISC);
3250 free(lft_s, M_IPSEC_MISC);
3253 /* We can update lifetime without holding a lock */
3254 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3255 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3262 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3263 * You must update these if need. Expects only LARVAL SAs.
3268 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3270 const struct sadb_sa *sa0;
3271 const struct sadb_key *key0;
3276 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3277 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3278 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3279 ("Attempt to update non LARVAL SA"));
3282 error = key_setident(sav->sah, mhp);
3287 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3288 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3292 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3293 sav->alg_auth = sa0->sadb_sa_auth;
3294 sav->alg_enc = sa0->sadb_sa_encrypt;
3295 sav->flags = sa0->sadb_sa_flags;
3296 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3297 ipseclog((LOG_DEBUG,
3298 "%s: invalid sa_flags 0x%08x.\n", __func__,
3304 /* Optional replay window */
3306 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3307 replay = sa0->sadb_sa_replay;
3308 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3309 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3313 replay = ((const struct sadb_x_sa_replay *)
3314 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3316 if (replay > UINT32_MAX - 32) {
3317 ipseclog((LOG_DEBUG,
3318 "%s: replay window too big.\n", __func__));
3323 replay = (replay + 7) >> 3;
3326 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3328 if (sav->replay == NULL) {
3329 PFKEYSTAT_INC(in_nomem);
3330 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3337 /* number of 32b blocks to be allocated */
3338 uint32_t bitmap_size;
3341 * - the allocated replay window size must be
3343 * - use an extra 32b block as a redundant window.
3346 while (replay + 4 > bitmap_size)
3348 bitmap_size = bitmap_size / 4;
3350 sav->replay->bitmap = malloc(
3351 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3353 if (sav->replay->bitmap == NULL) {
3354 PFKEYSTAT_INC(in_nomem);
3355 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3360 sav->replay->bitmap_size = bitmap_size;
3361 sav->replay->wsize = replay;
3365 /* Authentication keys */
3366 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3367 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3372 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3373 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3374 switch (mhp->msg->sadb_msg_satype) {
3375 case SADB_SATYPE_AH:
3376 case SADB_SATYPE_ESP:
3377 case SADB_X_SATYPE_TCPSIGNATURE:
3378 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3379 sav->alg_auth != SADB_X_AALG_NULL)
3382 case SADB_X_SATYPE_IPCOMP:
3388 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3393 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3394 if (sav->key_auth == NULL ) {
3395 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3397 PFKEYSTAT_INC(in_nomem);
3403 /* Encryption key */
3404 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3405 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3410 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3411 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3412 switch (mhp->msg->sadb_msg_satype) {
3413 case SADB_SATYPE_ESP:
3414 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3415 sav->alg_enc != SADB_EALG_NULL) {
3419 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3420 if (sav->key_enc == NULL) {
3421 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3423 PFKEYSTAT_INC(in_nomem);
3428 case SADB_X_SATYPE_IPCOMP:
3429 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3431 sav->key_enc = NULL; /*just in case*/
3433 case SADB_SATYPE_AH:
3434 case SADB_X_SATYPE_TCPSIGNATURE:
3440 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3448 switch (mhp->msg->sadb_msg_satype) {
3449 case SADB_SATYPE_AH:
3450 if (sav->flags & SADB_X_EXT_DERIV) {
3451 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3452 "given to AH SA.\n", __func__));
3456 if (sav->alg_enc != SADB_EALG_NONE) {
3457 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3458 "mismated.\n", __func__));
3462 error = xform_init(sav, XF_AH);
3464 case SADB_SATYPE_ESP:
3465 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3466 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3467 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3468 "given to old-esp.\n", __func__));
3472 error = xform_init(sav, XF_ESP);
3474 case SADB_X_SATYPE_IPCOMP:
3475 if (sav->alg_auth != SADB_AALG_NONE) {
3476 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3477 "mismated.\n", __func__));
3481 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3482 ntohl(sav->spi) >= 0x10000) {
3483 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3488 error = xform_init(sav, XF_IPCOMP);
3490 case SADB_X_SATYPE_TCPSIGNATURE:
3491 if (sav->alg_enc != SADB_EALG_NONE) {
3492 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3493 "mismated.\n", __func__));
3497 error = xform_init(sav, XF_TCPSIGNATURE);
3500 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3501 error = EPROTONOSUPPORT;
3505 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3506 __func__, mhp->msg->sadb_msg_satype));
3510 /* Handle NAT-T headers */
3511 error = key_setnatt(sav, mhp);
3515 /* Initialize lifetime for CURRENT */
3517 sav->created = time_second;
3519 /* lifetimes for HARD and SOFT */
3520 error = key_updatelifetimes(sav, mhp);
3529 * subroutine for SADB_GET and SADB_DUMP.
3531 static struct mbuf *
3532 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3533 uint32_t seq, uint32_t pid)
3535 struct seclifetime lft_c;
3536 struct mbuf *result = NULL, *tres = NULL, *m;
3537 int i, dumporder[] = {
3538 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3539 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3540 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3541 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3542 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3543 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3544 SADB_EXT_SENSITIVITY,
3545 SADB_X_EXT_NAT_T_TYPE,
3546 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3547 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3548 SADB_X_EXT_NAT_T_FRAG,
3550 uint32_t replay_count;
3552 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3557 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3559 switch (dumporder[i]) {
3561 m = key_setsadbsa(sav);
3566 case SADB_X_EXT_SA2:
3568 replay_count = sav->replay ? sav->replay->count : 0;
3569 SECASVAR_UNLOCK(sav);
3570 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3571 sav->sah->saidx.reqid);
3576 case SADB_X_EXT_SA_REPLAY:
3577 if (sav->replay == NULL ||
3578 sav->replay->wsize <= UINT8_MAX)
3581 m = key_setsadbxsareplay(sav->replay->wsize);
3586 case SADB_EXT_ADDRESS_SRC:
3587 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3588 &sav->sah->saidx.src.sa,
3589 FULLMASK, IPSEC_ULPROTO_ANY);
3594 case SADB_EXT_ADDRESS_DST:
3595 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3596 &sav->sah->saidx.dst.sa,
3597 FULLMASK, IPSEC_ULPROTO_ANY);
3602 case SADB_EXT_KEY_AUTH:
3605 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3610 case SADB_EXT_KEY_ENCRYPT:
3613 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3618 case SADB_EXT_LIFETIME_CURRENT:
3619 lft_c.addtime = sav->created;
3620 lft_c.allocations = (uint32_t)counter_u64_fetch(
3621 sav->lft_c_allocations);
3622 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3623 lft_c.usetime = sav->firstused;
3624 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3629 case SADB_EXT_LIFETIME_HARD:
3632 m = key_setlifetime(sav->lft_h,
3633 SADB_EXT_LIFETIME_HARD);
3638 case SADB_EXT_LIFETIME_SOFT:
3641 m = key_setlifetime(sav->lft_s,
3642 SADB_EXT_LIFETIME_SOFT);
3648 case SADB_X_EXT_NAT_T_TYPE:
3649 if (sav->natt == NULL)
3651 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3656 case SADB_X_EXT_NAT_T_DPORT:
3657 if (sav->natt == NULL)
3659 m = key_setsadbxport(sav->natt->dport,
3660 SADB_X_EXT_NAT_T_DPORT);
3665 case SADB_X_EXT_NAT_T_SPORT:
3666 if (sav->natt == NULL)
3668 m = key_setsadbxport(sav->natt->sport,
3669 SADB_X_EXT_NAT_T_SPORT);
3674 case SADB_X_EXT_NAT_T_OAI:
3675 if (sav->natt == NULL ||
3676 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3678 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3679 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3683 case SADB_X_EXT_NAT_T_OAR:
3684 if (sav->natt == NULL ||
3685 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3687 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3688 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3692 case SADB_X_EXT_NAT_T_FRAG:
3693 /* We do not (yet) support those. */
3696 case SADB_EXT_ADDRESS_PROXY:
3697 case SADB_EXT_IDENTITY_SRC:
3698 case SADB_EXT_IDENTITY_DST:
3699 /* XXX: should we brought from SPD ? */
3700 case SADB_EXT_SENSITIVITY:
3712 m_cat(result, tres);
3714 if (result->m_len < sizeof(struct sadb_msg)) {
3715 result = m_pullup(result, sizeof(struct sadb_msg));
3720 result->m_pkthdr.len = 0;
3721 for (m = result; m; m = m->m_next)
3722 result->m_pkthdr.len += m->m_len;
3724 mtod(result, struct sadb_msg *)->sadb_msg_len =
3725 PFKEY_UNIT64(result->m_pkthdr.len);
3736 * set data into sadb_msg.
3738 static struct mbuf *
3739 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3740 pid_t pid, u_int16_t reserved)
3746 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3749 MGETHDR(m, M_NOWAIT, MT_DATA);
3750 if (m && len > MHLEN) {
3751 if (!(MCLGET(m, M_NOWAIT))) {
3758 m->m_pkthdr.len = m->m_len = len;
3761 p = mtod(m, struct sadb_msg *);
3764 p->sadb_msg_version = PF_KEY_V2;
3765 p->sadb_msg_type = type;
3766 p->sadb_msg_errno = 0;
3767 p->sadb_msg_satype = satype;
3768 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3769 p->sadb_msg_reserved = reserved;
3770 p->sadb_msg_seq = seq;
3771 p->sadb_msg_pid = (u_int32_t)pid;
3777 * copy secasvar data into sadb_address.
3779 static struct mbuf *
3780 key_setsadbsa(struct secasvar *sav)
3786 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3787 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3792 p = mtod(m, struct sadb_sa *);
3794 p->sadb_sa_len = PFKEY_UNIT64(len);
3795 p->sadb_sa_exttype = SADB_EXT_SA;
3796 p->sadb_sa_spi = sav->spi;
3797 p->sadb_sa_replay = sav->replay ?
3798 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3799 sav->replay->wsize): 0;
3800 p->sadb_sa_state = sav->state;
3801 p->sadb_sa_auth = sav->alg_auth;
3802 p->sadb_sa_encrypt = sav->alg_enc;
3803 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3808 * set data into sadb_address.
3810 static struct mbuf *
3811 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3812 u_int8_t prefixlen, u_int16_t ul_proto)
3815 struct sadb_address *p;
3818 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3819 PFKEY_ALIGN8(saddr->sa_len);
3820 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3825 p = mtod(m, struct sadb_address *);
3828 p->sadb_address_len = PFKEY_UNIT64(len);
3829 p->sadb_address_exttype = exttype;
3830 p->sadb_address_proto = ul_proto;
3831 if (prefixlen == FULLMASK) {
3832 switch (saddr->sa_family) {
3834 prefixlen = sizeof(struct in_addr) << 3;
3837 prefixlen = sizeof(struct in6_addr) << 3;
3843 p->sadb_address_prefixlen = prefixlen;
3844 p->sadb_address_reserved = 0;
3847 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3854 * set data into sadb_x_sa2.
3856 static struct mbuf *
3857 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3860 struct sadb_x_sa2 *p;
3863 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3864 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3869 p = mtod(m, struct sadb_x_sa2 *);
3872 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3873 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3874 p->sadb_x_sa2_mode = mode;
3875 p->sadb_x_sa2_reserved1 = 0;
3876 p->sadb_x_sa2_reserved2 = 0;
3877 p->sadb_x_sa2_sequence = seq;
3878 p->sadb_x_sa2_reqid = reqid;
3884 * Set data into sadb_x_sa_replay.
3886 static struct mbuf *
3887 key_setsadbxsareplay(u_int32_t replay)
3890 struct sadb_x_sa_replay *p;
3893 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3894 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3899 p = mtod(m, struct sadb_x_sa_replay *);
3902 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3903 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3904 p->sadb_x_sa_replay_replay = (replay << 3);
3910 * Set a type in sadb_x_nat_t_type.
3912 static struct mbuf *
3913 key_setsadbxtype(u_int16_t type)
3917 struct sadb_x_nat_t_type *p;
3919 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3921 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3926 p = mtod(m, struct sadb_x_nat_t_type *);
3929 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3930 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3931 p->sadb_x_nat_t_type_type = type;
3936 * Set a port in sadb_x_nat_t_port.
3937 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3939 static struct mbuf *
3940 key_setsadbxport(u_int16_t port, u_int16_t type)
3944 struct sadb_x_nat_t_port *p;
3946 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3948 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3953 p = mtod(m, struct sadb_x_nat_t_port *);
3956 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3957 p->sadb_x_nat_t_port_exttype = type;
3958 p->sadb_x_nat_t_port_port = port;
3964 * Get port from sockaddr. Port is in network byte order.
3967 key_portfromsaddr(struct sockaddr *sa)
3970 switch (sa->sa_family) {
3973 return ((struct sockaddr_in *)sa)->sin_port;
3977 return ((struct sockaddr_in6 *)sa)->sin6_port;
3984 * Set port in struct sockaddr. Port is in network byte order.
3987 key_porttosaddr(struct sockaddr *sa, uint16_t port)
3990 switch (sa->sa_family) {
3993 ((struct sockaddr_in *)sa)->sin_port = port;
3998 ((struct sockaddr_in6 *)sa)->sin6_port = port;
4002 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
4003 __func__, sa->sa_family));
4009 * set data into sadb_x_policy
4011 static struct mbuf *
4012 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
4015 struct sadb_x_policy *p;
4018 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
4019 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
4024 p = mtod(m, struct sadb_x_policy *);
4027 p->sadb_x_policy_len = PFKEY_UNIT64(len);
4028 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
4029 p->sadb_x_policy_type = type;
4030 p->sadb_x_policy_dir = dir;
4031 p->sadb_x_policy_id = id;
4032 p->sadb_x_policy_priority = priority;
4038 /* Take a key message (sadb_key) from the socket and turn it into one
4039 * of the kernel's key structures (seckey).
4041 * IN: pointer to the src
4042 * OUT: NULL no more memory
4045 key_dup_keymsg(const struct sadb_key *src, size_t len,
4046 struct malloc_type *type)
4050 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4052 dst->bits = src->sadb_key_bits;
4053 dst->key_data = malloc(len, type, M_NOWAIT);
4054 if (dst->key_data != NULL) {
4055 bcopy((const char *)(src + 1), dst->key_data, len);
4057 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4063 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4069 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
4070 * turn it into one of the kernel's lifetime structures (seclifetime).
4072 * IN: pointer to the destination, source and malloc type
4073 * OUT: NULL, no more memory
4076 static struct seclifetime *
4077 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
4079 struct seclifetime *dst;
4081 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4083 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
4086 dst->allocations = src->sadb_lifetime_allocations;
4087 dst->bytes = src->sadb_lifetime_bytes;
4088 dst->addtime = src->sadb_lifetime_addtime;
4089 dst->usetime = src->sadb_lifetime_usetime;
4094 * compare two secasindex structure.
4095 * flag can specify to compare 2 saidxes.
4096 * compare two secasindex structure without both mode and reqid.
4097 * don't compare port.
4099 * saidx0: source, it can be in SAD.
4106 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4111 if (saidx0 == NULL && saidx1 == NULL)
4114 if (saidx0 == NULL || saidx1 == NULL)
4117 if (saidx0->proto != saidx1->proto)
4120 if (flag == CMP_EXACTLY) {
4121 if (saidx0->mode != saidx1->mode)
4123 if (saidx0->reqid != saidx1->reqid)
4125 if (bcmp(&saidx0->src, &saidx1->src,
4126 saidx0->src.sa.sa_len) != 0 ||
4127 bcmp(&saidx0->dst, &saidx1->dst,
4128 saidx0->dst.sa.sa_len) != 0)
4131 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4132 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4134 * If reqid of SPD is non-zero, unique SA is required.
4135 * The result must be of same reqid in this case.
4137 if (saidx1->reqid != 0 &&
4138 saidx0->reqid != saidx1->reqid)
4142 if (flag == CMP_MODE_REQID) {
4143 if (saidx0->mode != IPSEC_MODE_ANY
4144 && saidx0->mode != saidx1->mode)
4148 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4150 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4158 * compare two secindex structure exactly.
4160 * spidx0: source, it is often in SPD.
4161 * spidx1: object, it is often from PFKEY message.
4167 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4168 struct secpolicyindex *spidx1)
4171 if (spidx0 == NULL && spidx1 == NULL)
4174 if (spidx0 == NULL || spidx1 == NULL)
4177 if (spidx0->prefs != spidx1->prefs
4178 || spidx0->prefd != spidx1->prefd
4179 || spidx0->ul_proto != spidx1->ul_proto
4180 || spidx0->dir != spidx1->dir)
4183 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4184 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4188 * compare two secindex structure with mask.
4190 * spidx0: source, it is often in SPD.
4191 * spidx1: object, it is often from IP header.
4197 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4198 struct secpolicyindex *spidx1)
4201 if (spidx0 == NULL && spidx1 == NULL)
4204 if (spidx0 == NULL || spidx1 == NULL)
4207 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4208 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4209 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4210 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4213 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4214 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4215 && spidx0->ul_proto != spidx1->ul_proto)
4218 switch (spidx0->src.sa.sa_family) {
4220 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4221 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4223 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4224 &spidx1->src.sin.sin_addr, spidx0->prefs))
4228 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4229 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4232 * scope_id check. if sin6_scope_id is 0, we regard it
4233 * as a wildcard scope, which matches any scope zone ID.
4235 if (spidx0->src.sin6.sin6_scope_id &&
4236 spidx1->src.sin6.sin6_scope_id &&
4237 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4239 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4240 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4245 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4250 switch (spidx0->dst.sa.sa_family) {
4252 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4253 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4255 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4256 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4260 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4261 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4264 * scope_id check. if sin6_scope_id is 0, we regard it
4265 * as a wildcard scope, which matches any scope zone ID.
4267 if (spidx0->dst.sin6.sin6_scope_id &&
4268 spidx1->dst.sin6.sin6_scope_id &&
4269 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4271 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4272 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4277 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4282 /* XXX Do we check other field ? e.g. flowinfo */
4290 #define satosin(s) ((const struct sockaddr_in *)s)
4294 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4295 /* returns 0 on match */
4297 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4300 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4303 switch (sa1->sa_family) {
4306 if (sa1->sa_len != sizeof(struct sockaddr_in))
4308 if (satosin(sa1)->sin_addr.s_addr !=
4309 satosin(sa2)->sin_addr.s_addr) {
4312 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4318 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4319 return 1; /*EINVAL*/
4320 if (satosin6(sa1)->sin6_scope_id !=
4321 satosin6(sa2)->sin6_scope_id) {
4324 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4325 &satosin6(sa2)->sin6_addr)) {
4329 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4335 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4343 /* returns 0 on match */
4345 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4346 const struct sockaddr *sa2, size_t mask)
4348 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4351 switch (sa1->sa_family) {
4354 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4355 &satosin(sa2)->sin_addr, mask));
4359 if (satosin6(sa1)->sin6_scope_id !=
4360 satosin6(sa2)->sin6_scope_id)
4362 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4363 &satosin6(sa2)->sin6_addr, mask));
4372 * compare two buffers with mask.
4376 * bits: Number of bits to compare
4382 key_bbcmp(const void *a1, const void *a2, u_int bits)
4384 const unsigned char *p1 = a1;
4385 const unsigned char *p2 = a2;
4387 /* XXX: This could be considerably faster if we compare a word
4388 * at a time, but it is complicated on LSB Endian machines */
4390 /* Handle null pointers */
4391 if (p1 == NULL || p2 == NULL)
4401 u_int8_t mask = ~((1<<(8-bits))-1);
4402 if ((*p1 & mask) != (*p2 & mask))
4405 return 1; /* Match! */
4409 key_flush_spd(time_t now)
4411 SPTREE_RLOCK_TRACKER;
4412 struct secpolicy_list drainq;
4413 struct secpolicy *sp, *nextsp;
4418 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4419 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4420 if (sp->lifetime == 0 && sp->validtime == 0)
4422 if ((sp->lifetime &&
4423 now - sp->created > sp->lifetime) ||
4425 now - sp->lastused > sp->validtime)) {
4426 /* Hold extra reference to send SPDEXPIRE */
4428 LIST_INSERT_HEAD(&drainq, sp, drainq);
4433 if (LIST_EMPTY(&drainq))
4437 sp = LIST_FIRST(&drainq);
4438 while (sp != NULL) {
4439 nextsp = LIST_NEXT(sp, drainq);
4440 /* Check that SP is still linked */
4441 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4442 LIST_REMOVE(sp, drainq);
4443 key_freesp(&sp); /* release extra reference */
4447 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4449 LIST_REMOVE(sp, idhash);
4450 sp->state = IPSEC_SPSTATE_DEAD;
4455 if (SPDCACHE_ENABLED())
4458 sp = LIST_FIRST(&drainq);
4459 while (sp != NULL) {
4460 nextsp = LIST_NEXT(sp, drainq);
4462 key_freesp(&sp); /* release extra reference */
4463 key_freesp(&sp); /* release last reference */
4469 key_flush_sad(time_t now)
4471 SAHTREE_RLOCK_TRACKER;
4472 struct secashead_list emptyq;
4473 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4474 struct secashead *sah, *nextsah;
4475 struct secasvar *sav, *nextsav;
4478 LIST_INIT(&hexpireq);
4479 LIST_INIT(&sexpireq);
4483 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4484 /* Check for empty SAH */
4485 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4486 TAILQ_EMPTY(&sah->savtree_alive)) {
4488 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4491 /* Add all stale LARVAL SAs into drainq */
4492 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4493 if (now - sav->created < V_key_larval_lifetime)
4496 LIST_INSERT_HEAD(&drainq, sav, drainq);
4498 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4499 /* lifetimes aren't specified */
4500 if (sav->lft_h == NULL)
4504 * Check again with lock held, because it may
4505 * be updated by SADB_UPDATE.
4507 if (sav->lft_h == NULL) {
4508 SECASVAR_UNLOCK(sav);
4513 * HARD lifetimes MUST take precedence over SOFT
4514 * lifetimes, meaning if the HARD and SOFT lifetimes
4515 * are the same, the HARD lifetime will appear on the
4518 /* check HARD lifetime */
4519 if ((sav->lft_h->addtime != 0 &&
4520 now - sav->created > sav->lft_h->addtime) ||
4521 (sav->lft_h->usetime != 0 && sav->firstused &&
4522 now - sav->firstused > sav->lft_h->usetime) ||
4523 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4524 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4525 SECASVAR_UNLOCK(sav);
4527 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4530 /* check SOFT lifetime (only for MATURE SAs) */
4531 if (sav->state == SADB_SASTATE_MATURE && (
4532 (sav->lft_s->addtime != 0 &&
4533 now - sav->created > sav->lft_s->addtime) ||
4534 (sav->lft_s->usetime != 0 && sav->firstused &&
4535 now - sav->firstused > sav->lft_s->usetime) ||
4536 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4537 sav->lft_c_bytes) > sav->lft_s->bytes) ||
4538 (!(sav->flags & SADB_X_SAFLAGS_ESN) &&
4539 (sav->replay != NULL) && (
4540 (sav->replay->count > UINT32_80PCT) ||
4541 (sav->replay->last > UINT32_80PCT))))) {
4542 SECASVAR_UNLOCK(sav);
4544 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4547 SECASVAR_UNLOCK(sav);
4552 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4553 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4558 /* Unlink stale LARVAL SAs */
4559 sav = LIST_FIRST(&drainq);
4560 while (sav != NULL) {
4561 nextsav = LIST_NEXT(sav, drainq);
4562 /* Check that SA is still LARVAL */
4563 if (sav->state != SADB_SASTATE_LARVAL) {
4564 LIST_REMOVE(sav, drainq);
4565 LIST_INSERT_HEAD(&freeq, sav, drainq);
4569 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4570 LIST_REMOVE(sav, spihash);
4571 sav->state = SADB_SASTATE_DEAD;
4574 /* Unlink all SAs with expired HARD lifetime */
4575 sav = LIST_FIRST(&hexpireq);
4576 while (sav != NULL) {
4577 nextsav = LIST_NEXT(sav, drainq);
4578 /* Check that SA is not unlinked */
4579 if (sav->state == SADB_SASTATE_DEAD) {
4580 LIST_REMOVE(sav, drainq);
4581 LIST_INSERT_HEAD(&freeq, sav, drainq);
4585 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4586 LIST_REMOVE(sav, spihash);
4587 sav->state = SADB_SASTATE_DEAD;
4590 /* Mark all SAs with expired SOFT lifetime as DYING */
4591 sav = LIST_FIRST(&sexpireq);
4592 while (sav != NULL) {
4593 nextsav = LIST_NEXT(sav, drainq);
4594 /* Check that SA is not unlinked */
4595 if (sav->state == SADB_SASTATE_DEAD) {
4596 LIST_REMOVE(sav, drainq);
4597 LIST_INSERT_HEAD(&freeq, sav, drainq);
4602 * NOTE: this doesn't change SA order in the chain.
4604 sav->state = SADB_SASTATE_DYING;
4607 /* Unlink empty SAHs */
4608 sah = LIST_FIRST(&emptyq);
4609 while (sah != NULL) {
4610 nextsah = LIST_NEXT(sah, drainq);
4611 /* Check that SAH is still empty and not unlinked */
4612 if (sah->state == SADB_SASTATE_DEAD ||
4613 !TAILQ_EMPTY(&sah->savtree_larval) ||
4614 !TAILQ_EMPTY(&sah->savtree_alive)) {
4615 LIST_REMOVE(sah, drainq);
4616 key_freesah(&sah); /* release extra reference */
4620 TAILQ_REMOVE(&V_sahtree, sah, chain);
4621 LIST_REMOVE(sah, addrhash);
4622 sah->state = SADB_SASTATE_DEAD;
4627 /* Send SPDEXPIRE messages */
4628 sav = LIST_FIRST(&hexpireq);
4629 while (sav != NULL) {
4630 nextsav = LIST_NEXT(sav, drainq);
4632 key_freesah(&sav->sah); /* release reference from SAV */
4633 key_freesav(&sav); /* release extra reference */
4634 key_freesav(&sav); /* release last reference */
4637 sav = LIST_FIRST(&sexpireq);
4638 while (sav != NULL) {
4639 nextsav = LIST_NEXT(sav, drainq);
4641 key_freesav(&sav); /* release extra reference */
4644 /* Free stale LARVAL SAs */
4645 sav = LIST_FIRST(&drainq);
4646 while (sav != NULL) {
4647 nextsav = LIST_NEXT(sav, drainq);
4648 key_freesah(&sav->sah); /* release reference from SAV */
4649 key_freesav(&sav); /* release extra reference */
4650 key_freesav(&sav); /* release last reference */
4653 /* Free SAs that were unlinked/changed by someone else */
4654 sav = LIST_FIRST(&freeq);
4655 while (sav != NULL) {
4656 nextsav = LIST_NEXT(sav, drainq);
4657 key_freesav(&sav); /* release extra reference */
4660 /* Free empty SAH */
4661 sah = LIST_FIRST(&emptyq);
4662 while (sah != NULL) {
4663 nextsah = LIST_NEXT(sah, drainq);
4664 key_freesah(&sah); /* release extra reference */
4665 key_freesah(&sah); /* release last reference */
4671 key_flush_acq(time_t now)
4673 struct secacq *acq, *nextacq;
4677 acq = LIST_FIRST(&V_acqtree);
4678 while (acq != NULL) {
4679 nextacq = LIST_NEXT(acq, chain);
4680 if (now - acq->created > V_key_blockacq_lifetime) {
4681 LIST_REMOVE(acq, chain);
4682 LIST_REMOVE(acq, addrhash);
4683 LIST_REMOVE(acq, seqhash);
4684 free(acq, M_IPSEC_SAQ);
4692 key_flush_spacq(time_t now)
4694 struct secspacq *acq, *nextacq;
4698 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4699 nextacq = LIST_NEXT(acq, chain);
4700 if (now - acq->created > V_key_blockacq_lifetime
4701 && __LIST_CHAINED(acq)) {
4702 LIST_REMOVE(acq, chain);
4703 free(acq, M_IPSEC_SAQ);
4711 * scanning SPD and SAD to check status for each entries,
4712 * and do to remove or to expire.
4713 * XXX: year 2038 problem may remain.
4716 key_timehandler(void *arg)
4718 VNET_ITERATOR_DECL(vnet_iter);
4719 time_t now = time_second;
4721 VNET_LIST_RLOCK_NOSLEEP();
4722 VNET_FOREACH(vnet_iter) {
4723 CURVNET_SET(vnet_iter);
4727 key_flush_spacq(now);
4730 VNET_LIST_RUNLOCK_NOSLEEP();
4732 #ifndef IPSEC_DEBUG2
4733 /* do exchange to tick time !! */
4734 callout_schedule(&key_timer, hz);
4735 #endif /* IPSEC_DEBUG2 */
4743 arc4random_buf(&value, sizeof(value));
4748 * map SADB_SATYPE_* to IPPROTO_*.
4749 * if satype == SADB_SATYPE then satype is mapped to ~0.
4751 * 0: invalid satype.
4754 key_satype2proto(uint8_t satype)
4757 case SADB_SATYPE_UNSPEC:
4758 return IPSEC_PROTO_ANY;
4759 case SADB_SATYPE_AH:
4761 case SADB_SATYPE_ESP:
4763 case SADB_X_SATYPE_IPCOMP:
4764 return IPPROTO_IPCOMP;
4765 case SADB_X_SATYPE_TCPSIGNATURE:
4774 * map IPPROTO_* to SADB_SATYPE_*
4776 * 0: invalid protocol type.
4779 key_proto2satype(uint8_t proto)
4783 return SADB_SATYPE_AH;
4785 return SADB_SATYPE_ESP;
4786 case IPPROTO_IPCOMP:
4787 return SADB_X_SATYPE_IPCOMP;
4789 return SADB_X_SATYPE_TCPSIGNATURE;
4798 * SADB_GETSPI processing is to receive
4799 * <base, (SA2), src address, dst address, (SPI range)>
4800 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4801 * tree with the status of LARVAL, and send
4802 * <base, SA(*), address(SD)>
4805 * IN: mhp: pointer to the pointer to each header.
4806 * OUT: NULL if fail.
4807 * other if success, return pointer to the message to send.
4810 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4812 struct secasindex saidx;
4813 struct sadb_address *src0, *dst0;
4814 struct secasvar *sav;
4815 uint32_t reqid, spi;
4817 uint8_t mode, proto;
4819 IPSEC_ASSERT(so != NULL, ("null socket"));
4820 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4821 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4822 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4824 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4825 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4826 #ifdef PFKEY_STRICT_CHECKS
4827 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4830 ipseclog((LOG_DEBUG,
4831 "%s: invalid message: missing required header.\n",
4836 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4837 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4838 #ifdef PFKEY_STRICT_CHECKS
4839 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4842 ipseclog((LOG_DEBUG,
4843 "%s: invalid message: wrong header size.\n", __func__));
4847 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4848 mode = IPSEC_MODE_ANY;
4851 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4852 ipseclog((LOG_DEBUG,
4853 "%s: invalid message: wrong header size.\n",
4858 mode = ((struct sadb_x_sa2 *)
4859 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4860 reqid = ((struct sadb_x_sa2 *)
4861 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4864 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4865 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4867 /* map satype to proto */
4868 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4869 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4874 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4875 (struct sockaddr *)(dst0 + 1));
4877 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4881 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4883 /* SPI allocation */
4884 spi = key_do_getnewspi(
4885 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4888 * Requested SPI or SPI range is not available or
4894 sav = key_newsav(mhp, &saidx, spi, &error);
4898 if (sav->seq != 0) {
4901 * If the SADB_GETSPI message is in response to a
4902 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4903 * MUST be the same as the SADB_ACQUIRE message.
4905 * XXXAE: However it doesn't definethe behaviour how to
4906 * check this and what to do if it doesn't match.
4907 * Also what we should do if it matches?
4909 * We can compare saidx used in SADB_ACQUIRE with saidx
4910 * used in SADB_GETSPI, but this probably can break
4911 * existing software. For now just warn if it doesn't match.
4913 * XXXAE: anyway it looks useless.
4915 key_acqdone(&saidx, sav->seq);
4918 printf("%s: SA(%p)\n", __func__, sav));
4919 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4922 struct mbuf *n, *nn;
4923 struct sadb_sa *m_sa;
4924 struct sadb_msg *newmsg;
4927 /* create new sadb_msg to reply. */
4928 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4929 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4931 MGETHDR(n, M_NOWAIT, MT_DATA);
4933 if (!(MCLGET(n, M_NOWAIT))) {
4947 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
4948 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
4950 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
4951 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
4952 m_sa->sadb_sa_exttype = SADB_EXT_SA;
4953 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
4954 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
4956 IPSEC_ASSERT(off == len,
4957 ("length inconsistency (off %u len %u)", off, len));
4959 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
4960 SADB_EXT_ADDRESS_DST);
4967 if (n->m_len < sizeof(struct sadb_msg)) {
4968 n = m_pullup(n, sizeof(struct sadb_msg));
4970 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
4973 n->m_pkthdr.len = 0;
4974 for (nn = n; nn; nn = nn->m_next)
4975 n->m_pkthdr.len += nn->m_len;
4977 newmsg = mtod(n, struct sadb_msg *);
4978 newmsg->sadb_msg_seq = sav->seq;
4979 newmsg->sadb_msg_errno = 0;
4980 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
4983 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
4987 return (key_senderror(so, m, error));
4991 * allocating new SPI
4992 * called by key_getspi().
4995 * others: success, SPI in network byte order.
4998 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
5000 uint32_t min, max, newspi, t;
5001 int count = V_key_spi_trycnt;
5003 /* set spi range to allocate */
5004 if (spirange != NULL) {
5005 min = spirange->sadb_spirange_min;
5006 max = spirange->sadb_spirange_max;
5008 min = V_key_spi_minval;
5009 max = V_key_spi_maxval;
5011 /* IPCOMP needs 2-byte SPI */
5012 if (saidx->proto == IPPROTO_IPCOMP) {
5018 t = min; min = max; max = t;
5023 if (!key_checkspidup(htonl(min))) {
5024 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
5029 count--; /* taking one cost. */
5035 /* when requesting to allocate spi ranged */
5037 /* generate pseudo-random SPI value ranged. */
5038 newspi = min + (key_random() % (max - min + 1));
5039 if (!key_checkspidup(htonl(newspi)))
5043 if (count == 0 || newspi == 0) {
5044 ipseclog((LOG_DEBUG,
5045 "%s: failed to allocate SPI.\n", __func__));
5051 keystat.getspi_count =
5052 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
5054 return (htonl(newspi));
5058 * Find TCP-MD5 SA with corresponding secasindex.
5059 * If not found, return NULL and fill SPI with usable value if needed.
5061 static struct secasvar *
5062 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
5064 SAHTREE_RLOCK_TRACKER;
5065 struct secashead *sah;
5066 struct secasvar *sav;
5068 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
5070 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5071 if (sah->saidx.proto != IPPROTO_TCP)
5073 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
5074 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
5078 if (V_key_preferred_oldsa)
5079 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
5081 sav = TAILQ_FIRST(&sah->savtree_alive);
5089 /* No SPI required */
5093 /* Check that SPI is unique */
5094 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5095 if (sav->spi == *spi)
5100 /* SPI is already unique */
5104 /* XXX: not optimal */
5105 *spi = key_do_getnewspi(NULL, saidx);
5110 key_updateaddresses(struct socket *so, struct mbuf *m,
5111 const struct sadb_msghdr *mhp, struct secasvar *sav,
5112 struct secasindex *saidx)
5114 struct sockaddr *newaddr;
5115 struct secashead *sah;
5116 struct secasvar *newsav, *tmp;
5120 /* Check that we need to change SAH */
5121 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5122 newaddr = (struct sockaddr *)(
5123 ((struct sadb_address *)
5124 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5125 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5126 key_porttosaddr(&saidx->src.sa, 0);
5128 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5129 newaddr = (struct sockaddr *)(
5130 ((struct sadb_address *)
5131 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5132 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5133 key_porttosaddr(&saidx->dst.sa, 0);
5135 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5136 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5137 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5139 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5144 sah = key_getsah(saidx);
5146 /* create a new SA index */
5147 sah = key_newsah(saidx);
5149 ipseclog((LOG_DEBUG,
5150 "%s: No more memory.\n", __func__));
5153 isnew = 2; /* SAH is new */
5155 isnew = 1; /* existing SAH is referenced */
5158 * src and dst addresses are still the same.
5159 * Do we want to change NAT-T config?
5161 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5162 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5163 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5164 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5165 ipseclog((LOG_DEBUG,
5166 "%s: invalid message: missing required header.\n",
5170 /* We hold reference to SA, thus SAH will be referenced too. */
5175 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5177 if (newsav == NULL) {
5178 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5183 /* Clone SA's content into newsav */
5184 SAV_INITREF(newsav);
5185 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5187 * We create new NAT-T config if it is needed.
5188 * Old NAT-T config will be freed by key_cleansav() when
5189 * last reference to SA will be released.
5191 newsav->natt = NULL;
5193 newsav->state = SADB_SASTATE_MATURE;
5194 error = key_setnatt(newsav, mhp);
5199 /* Check that SA is still alive */
5200 if (sav->state == SADB_SASTATE_DEAD) {
5201 /* SA was unlinked */
5207 /* Unlink SA from SAH and SPI hash */
5208 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5209 ("SA is already cloned"));
5210 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5211 sav->state == SADB_SASTATE_DYING,
5212 ("Wrong SA state %u\n", sav->state));
5213 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5214 LIST_REMOVE(sav, spihash);
5215 sav->state = SADB_SASTATE_DEAD;
5218 * Link new SA with SAH. Keep SAs ordered by
5219 * create time (newer are first).
5221 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5222 if (newsav->created > tmp->created) {
5223 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5228 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5230 /* Add new SA into SPI hash. */
5231 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5233 /* Add new SAH into SADB. */
5235 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5236 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5237 sah->state = SADB_SASTATE_MATURE;
5238 SAH_ADDREF(sah); /* newsav references new SAH */
5241 * isnew == 1 -> @sah was referenced by key_getsah().
5242 * isnew == 0 -> we use the same @sah, that was used by @sav,
5243 * and we use its reference for @newsav.
5246 /* XXX: replace cntr with pointer? */
5247 newsav->cntr = sav->cntr;
5248 sav->flags |= SADB_X_EXT_F_CLONED;
5249 SECASVAR_UNLOCK(sav);
5254 printf("%s: SA(%p) cloned into SA(%p)\n",
5255 __func__, sav, newsav));
5256 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5258 key_freesav(&sav); /* release last reference */
5260 /* set msg buf from mhp */
5261 n = key_getmsgbuf_x1(m, mhp);
5263 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5267 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5272 if (newsav != NULL) {
5273 if (newsav->natt != NULL)
5274 free(newsav->natt, M_IPSEC_MISC);
5275 free(newsav, M_IPSEC_SA);
5281 * SADB_UPDATE processing
5283 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5284 * key(AE), (identity(SD),) (sensitivity)>
5285 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5287 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5288 * (identity(SD),) (sensitivity)>
5291 * m will always be freed.
5294 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5296 struct secasindex saidx;
5297 struct sadb_address *src0, *dst0;
5298 struct sadb_sa *sa0;
5299 struct secasvar *sav;
5302 uint8_t mode, proto;
5304 IPSEC_ASSERT(so != NULL, ("null socket"));
5305 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5306 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5307 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5309 /* map satype to proto */
5310 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5311 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5313 return key_senderror(so, m, EINVAL);
5316 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5317 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5318 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5319 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5320 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5321 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5322 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5323 ipseclog((LOG_DEBUG,
5324 "%s: invalid message: missing required header.\n",
5326 return key_senderror(so, m, EINVAL);
5328 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5329 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5330 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5331 ipseclog((LOG_DEBUG,
5332 "%s: invalid message: wrong header size.\n", __func__));
5333 return key_senderror(so, m, EINVAL);
5335 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5336 mode = IPSEC_MODE_ANY;
5339 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5340 ipseclog((LOG_DEBUG,
5341 "%s: invalid message: wrong header size.\n",
5343 return key_senderror(so, m, EINVAL);
5345 mode = ((struct sadb_x_sa2 *)
5346 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5347 reqid = ((struct sadb_x_sa2 *)
5348 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5351 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5352 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5353 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5356 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5357 * SADB_UPDATE message.
5359 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5360 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5361 #ifdef PFKEY_STRICT_CHECKS
5362 return key_senderror(so, m, EINVAL);
5365 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5366 (struct sockaddr *)(dst0 + 1));
5368 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5369 return key_senderror(so, m, error);
5371 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5372 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5374 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5375 __func__, ntohl(sa0->sadb_sa_spi)));
5376 return key_senderror(so, m, EINVAL);
5379 * Check that SADB_UPDATE issued by the same process that did
5380 * SADB_GETSPI or SADB_ADD.
5382 if (sav->pid != mhp->msg->sadb_msg_pid) {
5383 ipseclog((LOG_DEBUG,
5384 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5385 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5387 return key_senderror(so, m, EINVAL);
5389 /* saidx should match with SA. */
5390 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5391 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u\n",
5392 __func__, ntohl(sav->spi)));
5394 return key_senderror(so, m, ESRCH);
5397 if (sav->state == SADB_SASTATE_LARVAL) {
5398 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5399 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5400 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5401 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5402 ipseclog((LOG_DEBUG,
5403 "%s: invalid message: missing required header.\n",
5406 return key_senderror(so, m, EINVAL);
5409 * We can set any values except src, dst and SPI.
5411 error = key_setsaval(sav, mhp);
5414 return (key_senderror(so, m, error));
5416 /* Change SA state to MATURE */
5418 if (sav->state != SADB_SASTATE_LARVAL) {
5419 /* SA was deleted or another thread made it MATURE. */
5422 return (key_senderror(so, m, ESRCH));
5425 * NOTE: we keep SAs in savtree_alive ordered by created
5426 * time. When SA's state changed from LARVAL to MATURE,
5427 * we update its created time in key_setsaval() and move
5428 * it into head of savtree_alive.
5430 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5431 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5432 sav->state = SADB_SASTATE_MATURE;
5436 * For DYING and MATURE SA we can change only state
5437 * and lifetimes. Report EINVAL if something else attempted
5440 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5441 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5443 return (key_senderror(so, m, EINVAL));
5445 error = key_updatelifetimes(sav, mhp);
5448 return (key_senderror(so, m, error));
5451 * This is FreeBSD extension to RFC2367.
5452 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5453 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5454 * SA addresses (for example to implement MOBIKE protocol
5455 * as described in RFC4555). Also we allow to change
5458 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5459 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5460 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5461 sav->natt != NULL) {
5462 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5465 return (key_senderror(so, m, error));
5468 /* Check that SA is still alive */
5470 if (sav->state == SADB_SASTATE_DEAD) {
5471 /* SA was unlinked */
5474 return (key_senderror(so, m, ESRCH));
5477 * NOTE: there is possible state moving from DYING to MATURE,
5478 * but this doesn't change created time, so we won't reorder
5481 sav->state = SADB_SASTATE_MATURE;
5485 printf("%s: SA(%p)\n", __func__, sav));
5486 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5492 /* set msg buf from mhp */
5493 n = key_getmsgbuf_x1(m, mhp);
5495 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5496 return key_senderror(so, m, ENOBUFS);
5500 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5505 * SADB_ADD processing
5506 * add an entry to SA database, when received
5507 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5508 * key(AE), (identity(SD),) (sensitivity)>
5511 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5512 * (identity(SD),) (sensitivity)>
5515 * IGNORE identity and sensitivity messages.
5517 * m will always be freed.
5520 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5522 struct secasindex saidx;
5523 struct sadb_address *src0, *dst0;
5524 struct sadb_sa *sa0;
5525 struct secasvar *sav;
5526 uint32_t reqid, spi;
5527 uint8_t mode, proto;
5530 IPSEC_ASSERT(so != NULL, ("null socket"));
5531 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5532 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5533 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5535 /* map satype to proto */
5536 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5537 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5539 return key_senderror(so, m, EINVAL);
5542 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5543 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5544 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5545 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5546 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5547 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5548 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5549 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5550 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5551 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5552 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5553 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5554 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5555 ipseclog((LOG_DEBUG,
5556 "%s: invalid message: missing required header.\n",
5558 return key_senderror(so, m, EINVAL);
5560 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5561 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5562 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5563 ipseclog((LOG_DEBUG,
5564 "%s: invalid message: wrong header size.\n", __func__));
5565 return key_senderror(so, m, EINVAL);
5567 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5568 mode = IPSEC_MODE_ANY;
5571 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5572 ipseclog((LOG_DEBUG,
5573 "%s: invalid message: wrong header size.\n",
5575 return key_senderror(so, m, EINVAL);
5577 mode = ((struct sadb_x_sa2 *)
5578 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5579 reqid = ((struct sadb_x_sa2 *)
5580 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5583 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5584 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5585 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5588 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5591 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5592 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5593 #ifdef PFKEY_STRICT_CHECKS
5594 return key_senderror(so, m, EINVAL);
5597 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5598 (struct sockaddr *)(dst0 + 1));
5600 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5601 return key_senderror(so, m, error);
5603 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5604 spi = sa0->sadb_sa_spi;
5606 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5608 * XXXAE: IPComp seems also doesn't use SPI.
5610 if (proto == IPPROTO_TCP) {
5611 sav = key_getsav_tcpmd5(&saidx, &spi);
5612 if (sav == NULL && spi == 0) {
5613 /* Failed to allocate SPI */
5614 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5616 return key_senderror(so, m, EEXIST);
5618 /* XXX: SPI that we report back can have another value */
5620 /* We can create new SA only if SPI is different. */
5621 sav = key_getsavbyspi(spi);
5625 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5626 return key_senderror(so, m, EEXIST);
5629 sav = key_newsav(mhp, &saidx, spi, &error);
5631 return key_senderror(so, m, error);
5633 printf("%s: return SA(%p)\n", __func__, sav));
5634 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5636 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5640 key_acqdone(&saidx, sav->seq);
5644 * Don't call key_freesav() on error here, as we would like to
5645 * keep the SA in the database.
5649 /* set msg buf from mhp */
5650 n = key_getmsgbuf_x1(m, mhp);
5652 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5653 return key_senderror(so, m, ENOBUFS);
5657 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5663 * IKEd may request the use ESP in UDP encapsulation when it detects the
5664 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5665 * parameters needed for encapsulation and decapsulation. These PF_KEY
5666 * extension headers are not standardized, so this comment addresses our
5668 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5669 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5670 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5671 * UDP header. We use these ports in UDP encapsulation procedure, also we
5672 * can check them in UDP decapsulation procedure.
5673 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5674 * responder. These addresses can be used for transport mode to adjust
5675 * checksum after decapsulation and decryption. Since original IP addresses
5676 * used by peer usually different (we detected presence of NAT), TCP/UDP
5677 * pseudo header checksum and IP header checksum was calculated using original
5678 * addresses. After decapsulation and decryption we need to adjust checksum
5679 * to have correct datagram.
5681 * We expect presence of NAT-T extension headers only in SADB_ADD and
5682 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5683 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5686 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5688 struct sadb_x_nat_t_port *port;
5689 struct sadb_x_nat_t_type *type;
5690 struct sadb_address *oai, *oar;
5691 struct sockaddr *sa;
5695 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5697 * Ignore NAT-T headers if sproto isn't ESP.
5699 if (sav->sah->saidx.proto != IPPROTO_ESP)
5702 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5703 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5704 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5705 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5706 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5707 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5708 ipseclog((LOG_DEBUG,
5709 "%s: invalid message: wrong header size.\n",
5716 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5717 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5718 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5719 __func__, type->sadb_x_nat_t_type_type));
5723 * Allocate storage for NAT-T config.
5724 * On error it will be released by key_cleansav().
5726 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5728 if (sav->natt == NULL) {
5729 PFKEYSTAT_INC(in_nomem);
5730 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5733 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5734 if (port->sadb_x_nat_t_port_port == 0) {
5735 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5739 sav->natt->sport = port->sadb_x_nat_t_port_port;
5740 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5741 if (port->sadb_x_nat_t_port_port == 0) {
5742 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5746 sav->natt->dport = port->sadb_x_nat_t_port_port;
5749 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5750 * and needed only for transport mode IPsec.
5751 * Usually NAT translates only one address, but it is possible,
5752 * that both addresses could be translated.
5753 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5755 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5756 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5757 ipseclog((LOG_DEBUG,
5758 "%s: invalid message: wrong header size.\n",
5762 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5765 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5766 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5767 ipseclog((LOG_DEBUG,
5768 "%s: invalid message: wrong header size.\n",
5772 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5776 /* Initialize addresses only for transport mode */
5777 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5780 /* Currently we support only AF_INET */
5781 sa = (struct sockaddr *)(oai + 1);
5782 if (sa->sa_family != AF_INET ||
5783 sa->sa_len != sizeof(struct sockaddr_in)) {
5784 ipseclog((LOG_DEBUG,
5785 "%s: wrong NAT-OAi header.\n",
5789 /* Ignore address if it the same */
5790 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5791 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5792 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5793 sav->natt->flags |= IPSEC_NATT_F_OAI;
5794 /* Calculate checksum delta */
5795 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5796 cksum = in_addword(cksum, ~addr >> 16);
5797 cksum = in_addword(cksum, ~addr & 0xffff);
5798 addr = sav->natt->oai.sin.sin_addr.s_addr;
5799 cksum = in_addword(cksum, addr >> 16);
5800 cksum = in_addword(cksum, addr & 0xffff);
5804 /* Currently we support only AF_INET */
5805 sa = (struct sockaddr *)(oar + 1);
5806 if (sa->sa_family != AF_INET ||
5807 sa->sa_len != sizeof(struct sockaddr_in)) {
5808 ipseclog((LOG_DEBUG,
5809 "%s: wrong NAT-OAr header.\n",
5813 /* Ignore address if it the same */
5814 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5815 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5816 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5817 sav->natt->flags |= IPSEC_NATT_F_OAR;
5818 /* Calculate checksum delta */
5819 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5820 cksum = in_addword(cksum, ~addr >> 16);
5821 cksum = in_addword(cksum, ~addr & 0xffff);
5822 addr = sav->natt->oar.sin.sin_addr.s_addr;
5823 cksum = in_addword(cksum, addr >> 16);
5824 cksum = in_addword(cksum, addr & 0xffff);
5827 sav->natt->cksum = cksum;
5833 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5835 const struct sadb_ident *idsrc, *iddst;
5837 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5838 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5839 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5841 /* don't make buffer if not there */
5842 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5843 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5849 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5850 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5851 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5855 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5856 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5858 /* validity check */
5859 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5860 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5864 switch (idsrc->sadb_ident_type) {
5865 case SADB_IDENTTYPE_PREFIX:
5866 case SADB_IDENTTYPE_FQDN:
5867 case SADB_IDENTTYPE_USERFQDN:
5869 /* XXX do nothing */
5875 /* make structure */
5876 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5877 if (sah->idents == NULL) {
5878 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5881 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5882 if (sah->identd == NULL) {
5883 free(sah->idents, M_IPSEC_MISC);
5885 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5888 sah->idents->type = idsrc->sadb_ident_type;
5889 sah->idents->id = idsrc->sadb_ident_id;
5891 sah->identd->type = iddst->sadb_ident_type;
5892 sah->identd->id = iddst->sadb_ident_id;
5898 * m will not be freed on return.
5899 * it is caller's responsibility to free the result.
5901 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5902 * from the request in defined order.
5904 static struct mbuf *
5905 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5909 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5910 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5911 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5913 /* create new sadb_msg to reply. */
5914 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5915 SADB_EXT_SA, SADB_X_EXT_SA2,
5916 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5917 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5918 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5919 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5920 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5921 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5922 SADB_X_EXT_NEW_ADDRESS_DST);
5926 if (n->m_len < sizeof(struct sadb_msg)) {
5927 n = m_pullup(n, sizeof(struct sadb_msg));
5931 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5932 mtod(n, struct sadb_msg *)->sadb_msg_len =
5933 PFKEY_UNIT64(n->m_pkthdr.len);
5939 * SADB_DELETE processing
5941 * <base, SA(*), address(SD)>
5942 * from the ikmpd, and set SADB_SASTATE_DEAD,
5944 * <base, SA(*), address(SD)>
5947 * m will always be freed.
5950 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5952 struct secasindex saidx;
5953 struct sadb_address *src0, *dst0;
5954 struct secasvar *sav;
5955 struct sadb_sa *sa0;
5958 IPSEC_ASSERT(so != NULL, ("null socket"));
5959 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5960 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5961 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5963 /* map satype to proto */
5964 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5965 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5967 return key_senderror(so, m, EINVAL);
5970 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5971 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5972 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5973 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5974 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
5976 return key_senderror(so, m, EINVAL);
5979 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5980 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5982 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
5983 (struct sockaddr *)(dst0 + 1)) != 0) {
5984 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5985 return (key_senderror(so, m, EINVAL));
5987 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
5988 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
5990 * Caller wants us to delete all non-LARVAL SAs
5991 * that match the src/dst. This is used during
5992 * IKE INITIAL-CONTACT.
5993 * XXXAE: this looks like some extension to RFC2367.
5995 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
5996 return (key_delete_all(so, m, mhp, &saidx));
5998 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
5999 ipseclog((LOG_DEBUG,
6000 "%s: invalid message: wrong header size.\n", __func__));
6001 return (key_senderror(so, m, EINVAL));
6003 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6004 if (proto == IPPROTO_TCP)
6005 sav = key_getsav_tcpmd5(&saidx, NULL);
6007 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6009 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
6010 __func__, ntohl(sa0->sadb_sa_spi)));
6011 return (key_senderror(so, m, ESRCH));
6013 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6014 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6015 __func__, ntohl(sav->spi)));
6017 return (key_senderror(so, m, ESRCH));
6020 printf("%s: SA(%p)\n", __func__, sav));
6021 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6027 struct sadb_msg *newmsg;
6029 /* create new sadb_msg to reply. */
6030 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
6031 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6033 return key_senderror(so, m, ENOBUFS);
6035 if (n->m_len < sizeof(struct sadb_msg)) {
6036 n = m_pullup(n, sizeof(struct sadb_msg));
6038 return key_senderror(so, m, ENOBUFS);
6040 newmsg = mtod(n, struct sadb_msg *);
6041 newmsg->sadb_msg_errno = 0;
6042 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6045 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6050 * delete all SAs for src/dst. Called from key_delete().
6053 key_delete_all(struct socket *so, struct mbuf *m,
6054 const struct sadb_msghdr *mhp, struct secasindex *saidx)
6056 struct secasvar_queue drainq;
6057 struct secashead *sah;
6058 struct secasvar *sav, *nextsav;
6060 TAILQ_INIT(&drainq);
6062 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
6063 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
6065 /* Move all ALIVE SAs into drainq */
6066 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6068 /* Unlink all queued SAs from SPI hash */
6069 TAILQ_FOREACH(sav, &drainq, chain) {
6070 sav->state = SADB_SASTATE_DEAD;
6071 LIST_REMOVE(sav, spihash);
6074 /* Now we can release reference for all SAs in drainq */
6075 sav = TAILQ_FIRST(&drainq);
6076 while (sav != NULL) {
6078 printf("%s: SA(%p)\n", __func__, sav));
6079 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6080 nextsav = TAILQ_NEXT(sav, chain);
6081 key_freesah(&sav->sah); /* release reference from SAV */
6082 key_freesav(&sav); /* release last reference */
6088 struct sadb_msg *newmsg;
6090 /* create new sadb_msg to reply. */
6091 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6092 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6094 return key_senderror(so, m, ENOBUFS);
6096 if (n->m_len < sizeof(struct sadb_msg)) {
6097 n = m_pullup(n, sizeof(struct sadb_msg));
6099 return key_senderror(so, m, ENOBUFS);
6101 newmsg = mtod(n, struct sadb_msg *);
6102 newmsg->sadb_msg_errno = 0;
6103 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6106 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6111 * Delete all alive SAs for corresponding xform.
6112 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6113 * here when xform disappears.
6116 key_delete_xform(const struct xformsw *xsp)
6118 struct secasvar_queue drainq;
6119 struct secashead *sah;
6120 struct secasvar *sav, *nextsav;
6122 TAILQ_INIT(&drainq);
6124 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6125 sav = TAILQ_FIRST(&sah->savtree_alive);
6128 if (sav->tdb_xform != xsp)
6131 * It is supposed that all SAs in the chain are related to
6134 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6136 /* Unlink all queued SAs from SPI hash */
6137 TAILQ_FOREACH(sav, &drainq, chain) {
6138 sav->state = SADB_SASTATE_DEAD;
6139 LIST_REMOVE(sav, spihash);
6143 /* Now we can release reference for all SAs in drainq */
6144 sav = TAILQ_FIRST(&drainq);
6145 while (sav != NULL) {
6147 printf("%s: SA(%p)\n", __func__, sav));
6148 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6149 nextsav = TAILQ_NEXT(sav, chain);
6150 key_freesah(&sav->sah); /* release reference from SAV */
6151 key_freesav(&sav); /* release last reference */
6157 * SADB_GET processing
6159 * <base, SA(*), address(SD)>
6160 * from the ikmpd, and get a SP and a SA to respond,
6162 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6163 * (identity(SD),) (sensitivity)>
6166 * m will always be freed.
6169 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6171 struct secasindex saidx;
6172 struct sadb_address *src0, *dst0;
6173 struct sadb_sa *sa0;
6174 struct secasvar *sav;
6177 IPSEC_ASSERT(so != NULL, ("null socket"));
6178 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6179 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6180 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6182 /* map satype to proto */
6183 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6184 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6186 return key_senderror(so, m, EINVAL);
6189 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6190 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6191 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6192 ipseclog((LOG_DEBUG,
6193 "%s: invalid message: missing required header.\n",
6195 return key_senderror(so, m, EINVAL);
6197 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6198 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6199 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6200 ipseclog((LOG_DEBUG,
6201 "%s: invalid message: wrong header size.\n", __func__));
6202 return key_senderror(so, m, EINVAL);
6205 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6206 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6207 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6209 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6210 (struct sockaddr *)(dst0 + 1)) != 0) {
6211 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6212 return key_senderror(so, m, EINVAL);
6214 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6216 if (proto == IPPROTO_TCP)
6217 sav = key_getsav_tcpmd5(&saidx, NULL);
6219 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6221 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6222 return key_senderror(so, m, ESRCH);
6224 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6225 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6226 __func__, ntohl(sa0->sadb_sa_spi)));
6228 return (key_senderror(so, m, ESRCH));
6235 /* map proto to satype */
6236 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6237 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6240 return key_senderror(so, m, EINVAL);
6243 /* create new sadb_msg to reply. */
6244 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6245 mhp->msg->sadb_msg_pid);
6249 return key_senderror(so, m, ENOBUFS);
6252 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6256 /* XXX make it sysctl-configurable? */
6258 key_getcomb_setlifetime(struct sadb_comb *comb)
6261 comb->sadb_comb_soft_allocations = 1;
6262 comb->sadb_comb_hard_allocations = 1;
6263 comb->sadb_comb_soft_bytes = 0;
6264 comb->sadb_comb_hard_bytes = 0;
6265 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6266 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6267 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6268 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6272 * XXX reorder combinations by preference
6273 * XXX no idea if the user wants ESP authentication or not
6275 static struct mbuf *
6276 key_getcomb_ealg(void)
6278 struct sadb_comb *comb;
6279 const struct enc_xform *algo;
6280 struct mbuf *result = NULL, *m, *n;
6284 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6287 for (i = 1; i <= SADB_EALG_MAX; i++) {
6288 algo = enc_algorithm_lookup(i);
6292 /* discard algorithms with key size smaller than system min */
6293 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6295 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6296 encmin = V_ipsec_esp_keymin;
6298 encmin = _BITS(algo->minkey);
6300 if (V_ipsec_esp_auth)
6301 m = key_getcomb_ah();
6303 IPSEC_ASSERT(l <= MLEN,
6304 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6305 MGET(m, M_NOWAIT, MT_DATA);
6310 bzero(mtod(m, caddr_t), m->m_len);
6317 for (n = m; n; n = n->m_next)
6319 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6321 for (off = 0; off < totlen; off += l) {
6322 n = m_pulldown(m, off, l, &o);
6324 /* m is already freed */
6327 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6328 bzero(comb, sizeof(*comb));
6329 key_getcomb_setlifetime(comb);
6330 comb->sadb_comb_encrypt = i;
6331 comb->sadb_comb_encrypt_minbits = encmin;
6332 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6350 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6354 *min = *max = ah->hashsize;
6355 if (ah->keysize == 0) {
6357 * Transform takes arbitrary key size but algorithm
6358 * key size is restricted. Enforce this here.
6361 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6362 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6363 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6364 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6366 DPRINTF(("%s: unknown AH algorithm %u\n",
6374 * XXX reorder combinations by preference
6376 static struct mbuf *
6379 const struct auth_hash *algo;
6380 struct sadb_comb *comb;
6382 u_int16_t minkeysize, maxkeysize;
6384 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6387 for (i = 1; i <= SADB_AALG_MAX; i++) {
6389 /* we prefer HMAC algorithms, not old algorithms */
6390 if (i != SADB_AALG_SHA1HMAC &&
6391 i != SADB_X_AALG_SHA2_256 &&
6392 i != SADB_X_AALG_SHA2_384 &&
6393 i != SADB_X_AALG_SHA2_512)
6396 algo = auth_algorithm_lookup(i);
6399 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6400 /* discard algorithms with key size smaller than system min */
6401 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6405 IPSEC_ASSERT(l <= MLEN,
6406 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6407 MGET(m, M_NOWAIT, MT_DATA);
6414 M_PREPEND(m, l, M_NOWAIT);
6418 comb = mtod(m, struct sadb_comb *);
6419 bzero(comb, sizeof(*comb));
6420 key_getcomb_setlifetime(comb);
6421 comb->sadb_comb_auth = i;
6422 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6423 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6430 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6431 * XXX reorder combinations by preference
6433 static struct mbuf *
6434 key_getcomb_ipcomp()
6436 const struct comp_algo *algo;
6437 struct sadb_comb *comb;
6440 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6443 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6444 algo = comp_algorithm_lookup(i);
6449 IPSEC_ASSERT(l <= MLEN,
6450 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6451 MGET(m, M_NOWAIT, MT_DATA);
6458 M_PREPEND(m, l, M_NOWAIT);
6462 comb = mtod(m, struct sadb_comb *);
6463 bzero(comb, sizeof(*comb));
6464 key_getcomb_setlifetime(comb);
6465 comb->sadb_comb_encrypt = i;
6466 /* what should we set into sadb_comb_*_{min,max}bits? */
6473 * XXX no way to pass mode (transport/tunnel) to userland
6474 * XXX replay checking?
6475 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6477 static struct mbuf *
6478 key_getprop(const struct secasindex *saidx)
6480 struct sadb_prop *prop;
6482 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6485 switch (saidx->proto) {
6487 m = key_getcomb_ealg();
6490 m = key_getcomb_ah();
6492 case IPPROTO_IPCOMP:
6493 m = key_getcomb_ipcomp();
6501 M_PREPEND(m, l, M_NOWAIT);
6506 for (n = m; n; n = n->m_next)
6509 prop = mtod(m, struct sadb_prop *);
6510 bzero(prop, sizeof(*prop));
6511 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6512 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6513 prop->sadb_prop_replay = 32; /* XXX */
6519 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6521 * <base, SA, address(SD), (address(P)), x_policy,
6522 * (identity(SD),) (sensitivity,) proposal>
6523 * to KMD, and expect to receive
6524 * <base> with SADB_ACQUIRE if error occurred,
6526 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6527 * from KMD by PF_KEY.
6529 * XXX x_policy is outside of RFC2367 (KAME extension).
6530 * XXX sensitivity is not supported.
6531 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6532 * see comment for key_getcomb_ipcomp().
6536 * others: error number
6539 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6541 union sockaddr_union addr;
6542 struct mbuf *result, *m;
6546 uint8_t mask, satype;
6548 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6549 satype = key_proto2satype(saidx->proto);
6550 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6554 ul_proto = IPSEC_ULPROTO_ANY;
6556 /* Get seq number to check whether sending message or not. */
6557 seq = key_getacq(saidx, &error);
6561 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6569 * set sadb_address for saidx's.
6571 * Note that if sp is supplied, then we're being called from
6572 * key_allocsa_policy() and should supply port and protocol
6574 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6575 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6576 * XXXAE: it looks like we should save this info in the ACQ entry.
6578 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6579 sp->spidx.ul_proto == IPPROTO_UDP))
6580 ul_proto = sp->spidx.ul_proto;
6584 if (ul_proto != IPSEC_ULPROTO_ANY) {
6585 switch (sp->spidx.src.sa.sa_family) {
6587 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6588 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6589 mask = sp->spidx.prefs;
6593 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6594 addr.sin6.sin6_port =
6595 sp->spidx.src.sin6.sin6_port;
6596 mask = sp->spidx.prefs;
6603 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6612 if (ul_proto != IPSEC_ULPROTO_ANY) {
6613 switch (sp->spidx.dst.sa.sa_family) {
6615 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6616 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6617 mask = sp->spidx.prefd;
6621 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6622 addr.sin6.sin6_port =
6623 sp->spidx.dst.sin6.sin6_port;
6624 mask = sp->spidx.prefd;
6631 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6638 /* XXX proxy address (optional) */
6641 * Set sadb_x_policy. This is KAME extension to RFC2367.
6644 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6654 * Set sadb_x_sa2 extension if saidx->reqid is not zero.
6655 * This is FreeBSD extension to RFC2367.
6657 if (saidx->reqid != 0) {
6658 m = key_setsadbxsa2(saidx->mode, 0, saidx->reqid);
6665 /* XXX identity (optional) */
6667 if (idexttype && fqdn) {
6668 /* create identity extension (FQDN) */
6669 struct sadb_ident *id;
6672 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6673 id = (struct sadb_ident *)p;
6674 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6675 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6676 id->sadb_ident_exttype = idexttype;
6677 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6678 bcopy(fqdn, id + 1, fqdnlen);
6679 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6683 /* create identity extension (USERFQDN) */
6684 struct sadb_ident *id;
6688 /* +1 for terminating-NUL */
6689 userfqdnlen = strlen(userfqdn) + 1;
6692 id = (struct sadb_ident *)p;
6693 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6694 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6695 id->sadb_ident_exttype = idexttype;
6696 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6697 /* XXX is it correct? */
6698 if (curproc && curproc->p_cred)
6699 id->sadb_ident_id = curproc->p_cred->p_ruid;
6700 if (userfqdn && userfqdnlen)
6701 bcopy(userfqdn, id + 1, userfqdnlen);
6702 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6706 /* XXX sensitivity (optional) */
6708 /* create proposal/combination extension */
6709 m = key_getprop(saidx);
6712 * spec conformant: always attach proposal/combination extension,
6713 * the problem is that we have no way to attach it for ipcomp,
6714 * due to the way sadb_comb is declared in RFC2367.
6723 * outside of spec; make proposal/combination extension optional.
6729 if ((result->m_flags & M_PKTHDR) == 0) {
6734 if (result->m_len < sizeof(struct sadb_msg)) {
6735 result = m_pullup(result, sizeof(struct sadb_msg));
6736 if (result == NULL) {
6742 result->m_pkthdr.len = 0;
6743 for (m = result; m; m = m->m_next)
6744 result->m_pkthdr.len += m->m_len;
6746 mtod(result, struct sadb_msg *)->sadb_msg_len =
6747 PFKEY_UNIT64(result->m_pkthdr.len);
6750 printf("%s: SP(%p)\n", __func__, sp));
6751 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6753 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6762 key_newacq(const struct secasindex *saidx, int *perror)
6767 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6769 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6775 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6776 acq->created = time_second;
6779 /* add to acqtree */
6781 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6782 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6783 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6784 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6791 key_getacq(const struct secasindex *saidx, int *perror)
6797 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6798 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6799 if (acq->count > V_key_blockacq_count) {
6801 * Reset counter and send message.
6802 * Also reset created time to keep ACQ for
6805 acq->created = time_second;
6810 * Increment counter and do nothing.
6811 * We send SADB_ACQUIRE message only
6812 * for each V_key_blockacq_count packet.
6825 /* allocate new entry */
6826 return (key_newacq(saidx, perror));
6830 key_acqreset(uint32_t seq)
6835 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6836 if (acq->seq == seq) {
6838 acq->created = time_second;
6848 * Mark ACQ entry as stale to remove it in key_flush_acq().
6849 * Called after successful SADB_GETSPI message.
6852 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6857 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6858 if (acq->seq == seq)
6862 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6863 ipseclog((LOG_DEBUG,
6864 "%s: Mismatched saidx for ACQ %u\n", __func__, seq));
6870 ipseclog((LOG_DEBUG,
6871 "%s: ACQ %u is not found.\n", __func__, seq));
6879 static struct secspacq *
6880 key_newspacq(struct secpolicyindex *spidx)
6882 struct secspacq *acq;
6885 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6887 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6892 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6893 acq->created = time_second;
6896 /* add to spacqtree */
6898 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6904 static struct secspacq *
6905 key_getspacq(struct secpolicyindex *spidx)
6907 struct secspacq *acq;
6910 LIST_FOREACH(acq, &V_spacqtree, chain) {
6911 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6912 /* NB: return holding spacq_lock */
6922 * SADB_ACQUIRE processing,
6923 * in first situation, is receiving
6925 * from the ikmpd, and clear sequence of its secasvar entry.
6927 * In second situation, is receiving
6928 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6929 * from a user land process, and return
6930 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6933 * m will always be freed.
6936 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6938 SAHTREE_RLOCK_TRACKER;
6939 struct sadb_address *src0, *dst0;
6940 struct secasindex saidx;
6941 struct secashead *sah;
6944 uint8_t mode, proto;
6946 IPSEC_ASSERT(so != NULL, ("null socket"));
6947 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6948 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6949 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6952 * Error message from KMd.
6953 * We assume that if error was occurred in IKEd, the length of PFKEY
6954 * message is equal to the size of sadb_msg structure.
6955 * We do not raise error even if error occurred in this function.
6957 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
6958 /* check sequence number */
6959 if (mhp->msg->sadb_msg_seq == 0 ||
6960 mhp->msg->sadb_msg_errno == 0) {
6961 ipseclog((LOG_DEBUG, "%s: must specify sequence "
6962 "number and errno.\n", __func__));
6965 * IKEd reported that error occurred.
6966 * XXXAE: what it expects from the kernel?
6967 * Probably we should send SADB_ACQUIRE again?
6968 * If so, reset ACQ's state.
6969 * XXXAE: it looks useless.
6971 key_acqreset(mhp->msg->sadb_msg_seq);
6978 * This message is from user land.
6981 /* map satype to proto */
6982 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6983 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6985 return key_senderror(so, m, EINVAL);
6988 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6989 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
6990 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
6991 ipseclog((LOG_DEBUG,
6992 "%s: invalid message: missing required header.\n",
6994 return key_senderror(so, m, EINVAL);
6996 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6997 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
6998 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
6999 ipseclog((LOG_DEBUG,
7000 "%s: invalid message: wrong header size.\n", __func__));
7001 return key_senderror(so, m, EINVAL);
7004 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
7005 mode = IPSEC_MODE_ANY;
7008 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
7009 ipseclog((LOG_DEBUG,
7010 "%s: invalid message: wrong header size.\n",
7012 return key_senderror(so, m, EINVAL);
7014 mode = ((struct sadb_x_sa2 *)
7015 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7016 reqid = ((struct sadb_x_sa2 *)
7017 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7020 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7021 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7023 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
7024 (struct sockaddr *)(dst0 + 1));
7026 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
7027 return key_senderror(so, m, EINVAL);
7029 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
7031 /* get a SA index */
7033 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
7034 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
7039 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
7040 return key_senderror(so, m, EEXIST);
7043 error = key_acquire(&saidx, NULL);
7045 ipseclog((LOG_DEBUG,
7046 "%s: error %d returned from key_acquire()\n",
7048 return key_senderror(so, m, error);
7055 * SADB_REGISTER processing.
7056 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
7059 * from the ikmpd, and register a socket to send PF_KEY messages,
7063 * If socket is detached, must free from regnode.
7065 * m will always be freed.
7068 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7070 struct secreg *reg, *newreg = NULL;
7072 IPSEC_ASSERT(so != NULL, ("null socket"));
7073 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7074 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7075 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7077 /* check for invalid register message */
7078 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
7079 return key_senderror(so, m, EINVAL);
7081 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
7082 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
7085 /* check whether existing or not */
7087 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
7088 if (reg->so == so) {
7090 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
7092 return key_senderror(so, m, EEXIST);
7096 /* create regnode */
7097 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
7098 if (newreg == NULL) {
7100 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7101 return key_senderror(so, m, ENOBUFS);
7105 ((struct keycb *)sotorawcb(so))->kp_registered++;
7107 /* add regnode to regtree. */
7108 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7114 struct sadb_msg *newmsg;
7115 struct sadb_supported *sup;
7116 u_int len, alen, elen;
7119 struct sadb_alg *alg;
7121 /* create new sadb_msg to reply. */
7123 for (i = 1; i <= SADB_AALG_MAX; i++) {
7124 if (auth_algorithm_lookup(i))
7125 alen += sizeof(struct sadb_alg);
7128 alen += sizeof(struct sadb_supported);
7130 for (i = 1; i <= SADB_EALG_MAX; i++) {
7131 if (enc_algorithm_lookup(i))
7132 elen += sizeof(struct sadb_alg);
7135 elen += sizeof(struct sadb_supported);
7137 len = sizeof(struct sadb_msg) + alen + elen;
7140 return key_senderror(so, m, ENOBUFS);
7142 MGETHDR(n, M_NOWAIT, MT_DATA);
7143 if (n != NULL && len > MHLEN) {
7144 if (!(MCLGET(n, M_NOWAIT))) {
7150 return key_senderror(so, m, ENOBUFS);
7152 n->m_pkthdr.len = n->m_len = len;
7156 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7157 newmsg = mtod(n, struct sadb_msg *);
7158 newmsg->sadb_msg_errno = 0;
7159 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7160 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7162 /* for authentication algorithm */
7164 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7165 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7166 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7167 off += PFKEY_ALIGN8(sizeof(*sup));
7169 for (i = 1; i <= SADB_AALG_MAX; i++) {
7170 const struct auth_hash *aalgo;
7171 u_int16_t minkeysize, maxkeysize;
7173 aalgo = auth_algorithm_lookup(i);
7176 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7177 alg->sadb_alg_id = i;
7178 alg->sadb_alg_ivlen = 0;
7179 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7180 alg->sadb_alg_minbits = _BITS(minkeysize);
7181 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7182 off += PFKEY_ALIGN8(sizeof(*alg));
7186 /* for encryption algorithm */
7188 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7189 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7190 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7191 off += PFKEY_ALIGN8(sizeof(*sup));
7193 for (i = 1; i <= SADB_EALG_MAX; i++) {
7194 const struct enc_xform *ealgo;
7196 ealgo = enc_algorithm_lookup(i);
7199 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7200 alg->sadb_alg_id = i;
7201 alg->sadb_alg_ivlen = ealgo->ivsize;
7202 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7203 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7204 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7208 IPSEC_ASSERT(off == len,
7209 ("length assumption failed (off %u len %u)", off, len));
7212 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7217 * free secreg entry registered.
7218 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7221 key_freereg(struct socket *so)
7226 IPSEC_ASSERT(so != NULL, ("NULL so"));
7229 * check whether existing or not.
7230 * check all type of SA, because there is a potential that
7231 * one socket is registered to multiple type of SA.
7234 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7235 LIST_FOREACH(reg, &V_regtree[i], chain) {
7236 if (reg->so == so && __LIST_CHAINED(reg)) {
7237 LIST_REMOVE(reg, chain);
7238 free(reg, M_IPSEC_SAR);
7247 * SADB_EXPIRE processing
7249 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7251 * NOTE: We send only soft lifetime extension.
7254 * others : error number
7257 key_expire(struct secasvar *sav, int hard)
7259 struct mbuf *result = NULL, *m;
7260 struct sadb_lifetime *lt;
7261 uint32_t replay_count;
7265 IPSEC_ASSERT (sav != NULL, ("null sav"));
7266 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7269 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7270 sav, hard ? "hard": "soft"));
7271 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7272 /* set msg header */
7273 satype = key_proto2satype(sav->sah->saidx.proto);
7274 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7275 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7282 /* create SA extension */
7283 m = key_setsadbsa(sav);
7290 /* create SA extension */
7292 replay_count = sav->replay ? sav->replay->count : 0;
7293 SECASVAR_UNLOCK(sav);
7295 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7296 sav->sah->saidx.reqid);
7303 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7304 m = key_setsadbxsareplay(sav->replay->wsize);
7312 /* create lifetime extension (current and soft) */
7313 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7314 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7321 bzero(mtod(m, caddr_t), len);
7322 lt = mtod(m, struct sadb_lifetime *);
7323 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7324 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7325 lt->sadb_lifetime_allocations =
7326 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7327 lt->sadb_lifetime_bytes =
7328 counter_u64_fetch(sav->lft_c_bytes);
7329 lt->sadb_lifetime_addtime = sav->created;
7330 lt->sadb_lifetime_usetime = sav->firstused;
7331 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7332 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7334 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7335 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7336 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7337 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7338 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7340 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7341 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7342 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7343 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7344 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7348 /* set sadb_address for source */
7349 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7350 &sav->sah->saidx.src.sa,
7351 FULLMASK, IPSEC_ULPROTO_ANY);
7358 /* set sadb_address for destination */
7359 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7360 &sav->sah->saidx.dst.sa,
7361 FULLMASK, IPSEC_ULPROTO_ANY);
7369 * XXX-BZ Handle NAT-T extensions here.
7370 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7371 * this information, we report only significant SA fields.
7374 if ((result->m_flags & M_PKTHDR) == 0) {
7379 if (result->m_len < sizeof(struct sadb_msg)) {
7380 result = m_pullup(result, sizeof(struct sadb_msg));
7381 if (result == NULL) {
7387 result->m_pkthdr.len = 0;
7388 for (m = result; m; m = m->m_next)
7389 result->m_pkthdr.len += m->m_len;
7391 mtod(result, struct sadb_msg *)->sadb_msg_len =
7392 PFKEY_UNIT64(result->m_pkthdr.len);
7394 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7403 key_freesah_flushed(struct secashead_queue *flushq)
7405 struct secashead *sah, *nextsah;
7406 struct secasvar *sav, *nextsav;
7408 sah = TAILQ_FIRST(flushq);
7409 while (sah != NULL) {
7410 sav = TAILQ_FIRST(&sah->savtree_larval);
7411 while (sav != NULL) {
7412 nextsav = TAILQ_NEXT(sav, chain);
7413 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7414 key_freesav(&sav); /* release last reference */
7415 key_freesah(&sah); /* release reference from SAV */
7418 sav = TAILQ_FIRST(&sah->savtree_alive);
7419 while (sav != NULL) {
7420 nextsav = TAILQ_NEXT(sav, chain);
7421 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7422 key_freesav(&sav); /* release last reference */
7423 key_freesah(&sah); /* release reference from SAV */
7426 nextsah = TAILQ_NEXT(sah, chain);
7427 key_freesah(&sah); /* release last reference */
7433 * SADB_FLUSH processing
7436 * from the ikmpd, and free all entries in secastree.
7440 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7442 * m will always be freed.
7445 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7447 struct secashead_queue flushq;
7448 struct sadb_msg *newmsg;
7449 struct secashead *sah, *nextsah;
7450 struct secasvar *sav;
7454 IPSEC_ASSERT(so != NULL, ("null socket"));
7455 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7456 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7458 /* map satype to proto */
7459 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7460 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7462 return key_senderror(so, m, EINVAL);
7465 printf("%s: proto %u\n", __func__, proto));
7467 TAILQ_INIT(&flushq);
7468 if (proto == IPSEC_PROTO_ANY) {
7469 /* no SATYPE specified, i.e. flushing all SA. */
7471 /* Move all SAHs into flushq */
7472 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7473 /* Flush all buckets in SPI hash */
7474 for (i = 0; i < V_savhash_mask + 1; i++)
7475 LIST_INIT(&V_savhashtbl[i]);
7476 /* Flush all buckets in SAHADDRHASH */
7477 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7478 LIST_INIT(&V_sahaddrhashtbl[i]);
7479 /* Mark all SAHs as unlinked */
7480 TAILQ_FOREACH(sah, &flushq, chain) {
7481 sah->state = SADB_SASTATE_DEAD;
7483 * Callout handler makes its job using
7484 * RLOCK and drain queues. In case, when this
7485 * function will be called just before it
7486 * acquires WLOCK, we need to mark SAs as
7487 * unlinked to prevent second unlink.
7489 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7490 sav->state = SADB_SASTATE_DEAD;
7492 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7493 sav->state = SADB_SASTATE_DEAD;
7499 sah = TAILQ_FIRST(&V_sahtree);
7500 while (sah != NULL) {
7501 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7502 ("DEAD SAH %p in SADB_FLUSH", sah));
7503 nextsah = TAILQ_NEXT(sah, chain);
7504 if (sah->saidx.proto != proto) {
7508 sah->state = SADB_SASTATE_DEAD;
7509 TAILQ_REMOVE(&V_sahtree, sah, chain);
7510 LIST_REMOVE(sah, addrhash);
7511 /* Unlink all SAs from SPI hash */
7512 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7513 LIST_REMOVE(sav, spihash);
7514 sav->state = SADB_SASTATE_DEAD;
7516 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7517 LIST_REMOVE(sav, spihash);
7518 sav->state = SADB_SASTATE_DEAD;
7520 /* Add SAH into flushq */
7521 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7527 key_freesah_flushed(&flushq);
7528 /* Free all queued SAs and SAHs */
7529 if (m->m_len < sizeof(struct sadb_msg) ||
7530 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7531 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7532 return key_senderror(so, m, ENOBUFS);
7538 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7539 newmsg = mtod(m, struct sadb_msg *);
7540 newmsg->sadb_msg_errno = 0;
7541 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7543 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7547 * SADB_DUMP processing
7548 * dump all entries including status of DEAD in SAD.
7551 * from the ikmpd, and dump all secasvar leaves
7556 * m will always be freed.
7559 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7561 SAHTREE_RLOCK_TRACKER;
7562 struct secashead *sah;
7563 struct secasvar *sav;
7566 uint8_t proto, satype;
7568 IPSEC_ASSERT(so != NULL, ("null socket"));
7569 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7570 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7571 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7573 /* map satype to proto */
7574 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7575 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7577 return key_senderror(so, m, EINVAL);
7580 /* count sav entries to be sent to the userland. */
7583 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7584 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7585 proto != sah->saidx.proto)
7588 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7590 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7596 return key_senderror(so, m, ENOENT);
7599 /* send this to the userland, one at a time. */
7600 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7601 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7602 proto != sah->saidx.proto)
7605 /* map proto to satype */
7606 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7608 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7609 "SAD.\n", __func__));
7610 return key_senderror(so, m, EINVAL);
7612 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7613 n = key_setdumpsa(sav, SADB_DUMP, satype,
7614 --cnt, mhp->msg->sadb_msg_pid);
7617 return key_senderror(so, m, ENOBUFS);
7619 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7621 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7622 n = key_setdumpsa(sav, SADB_DUMP, satype,
7623 --cnt, mhp->msg->sadb_msg_pid);
7626 return key_senderror(so, m, ENOBUFS);
7628 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7636 * SADB_X_PROMISC processing
7638 * m will always be freed.
7641 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7645 IPSEC_ASSERT(so != NULL, ("null socket"));
7646 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7647 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7648 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7650 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7652 if (olen < sizeof(struct sadb_msg)) {
7654 return key_senderror(so, m, EINVAL);
7659 } else if (olen == sizeof(struct sadb_msg)) {
7660 /* enable/disable promisc mode */
7663 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7664 return key_senderror(so, m, EINVAL);
7665 mhp->msg->sadb_msg_errno = 0;
7666 switch (mhp->msg->sadb_msg_satype) {
7669 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7672 return key_senderror(so, m, EINVAL);
7675 /* send the original message back to everyone */
7676 mhp->msg->sadb_msg_errno = 0;
7677 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7679 /* send packet as is */
7681 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7683 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7684 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7688 static int (*key_typesw[])(struct socket *, struct mbuf *,
7689 const struct sadb_msghdr *) = {
7690 NULL, /* SADB_RESERVED */
7691 key_getspi, /* SADB_GETSPI */
7692 key_update, /* SADB_UPDATE */
7693 key_add, /* SADB_ADD */
7694 key_delete, /* SADB_DELETE */
7695 key_get, /* SADB_GET */
7696 key_acquire2, /* SADB_ACQUIRE */
7697 key_register, /* SADB_REGISTER */
7698 NULL, /* SADB_EXPIRE */
7699 key_flush, /* SADB_FLUSH */
7700 key_dump, /* SADB_DUMP */
7701 key_promisc, /* SADB_X_PROMISC */
7702 NULL, /* SADB_X_PCHANGE */
7703 key_spdadd, /* SADB_X_SPDUPDATE */
7704 key_spdadd, /* SADB_X_SPDADD */
7705 key_spddelete, /* SADB_X_SPDDELETE */
7706 key_spdget, /* SADB_X_SPDGET */
7707 NULL, /* SADB_X_SPDACQUIRE */
7708 key_spddump, /* SADB_X_SPDDUMP */
7709 key_spdflush, /* SADB_X_SPDFLUSH */
7710 key_spdadd, /* SADB_X_SPDSETIDX */
7711 NULL, /* SADB_X_SPDEXPIRE */
7712 key_spddelete2, /* SADB_X_SPDDELETE2 */
7716 * parse sadb_msg buffer to process PFKEYv2,
7717 * and create a data to response if needed.
7718 * I think to be dealed with mbuf directly.
7720 * msgp : pointer to pointer to a received buffer pulluped.
7721 * This is rewrited to response.
7722 * so : pointer to socket.
7724 * length for buffer to send to user process.
7727 key_parse(struct mbuf *m, struct socket *so)
7729 struct sadb_msg *msg;
7730 struct sadb_msghdr mh;
7735 IPSEC_ASSERT(so != NULL, ("null socket"));
7736 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7738 if (m->m_len < sizeof(struct sadb_msg)) {
7739 m = m_pullup(m, sizeof(struct sadb_msg));
7743 msg = mtod(m, struct sadb_msg *);
7744 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7745 target = KEY_SENDUP_ONE;
7747 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7748 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7749 PFKEYSTAT_INC(out_invlen);
7754 if (msg->sadb_msg_version != PF_KEY_V2) {
7755 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7756 __func__, msg->sadb_msg_version));
7757 PFKEYSTAT_INC(out_invver);
7762 if (msg->sadb_msg_type > SADB_MAX) {
7763 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7764 __func__, msg->sadb_msg_type));
7765 PFKEYSTAT_INC(out_invmsgtype);
7770 /* for old-fashioned code - should be nuked */
7771 if (m->m_pkthdr.len > MCLBYTES) {
7778 MGETHDR(n, M_NOWAIT, MT_DATA);
7779 if (n && m->m_pkthdr.len > MHLEN) {
7780 if (!(MCLGET(n, M_NOWAIT))) {
7789 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7790 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7796 /* align the mbuf chain so that extensions are in contiguous region. */
7797 error = key_align(m, &mh);
7803 /* We use satype as scope mask for spddump */
7804 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7805 switch (msg->sadb_msg_satype) {
7806 case IPSEC_POLICYSCOPE_ANY:
7807 case IPSEC_POLICYSCOPE_GLOBAL:
7808 case IPSEC_POLICYSCOPE_IFNET:
7809 case IPSEC_POLICYSCOPE_PCB:
7812 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7813 __func__, msg->sadb_msg_type));
7814 PFKEYSTAT_INC(out_invsatype);
7819 switch (msg->sadb_msg_satype) { /* check SA type */
7820 case SADB_SATYPE_UNSPEC:
7821 switch (msg->sadb_msg_type) {
7829 ipseclog((LOG_DEBUG, "%s: must specify satype "
7830 "when msg type=%u.\n", __func__,
7831 msg->sadb_msg_type));
7832 PFKEYSTAT_INC(out_invsatype);
7837 case SADB_SATYPE_AH:
7838 case SADB_SATYPE_ESP:
7839 case SADB_X_SATYPE_IPCOMP:
7840 case SADB_X_SATYPE_TCPSIGNATURE:
7841 switch (msg->sadb_msg_type) {
7843 case SADB_X_SPDDELETE:
7845 case SADB_X_SPDFLUSH:
7846 case SADB_X_SPDSETIDX:
7847 case SADB_X_SPDUPDATE:
7848 case SADB_X_SPDDELETE2:
7849 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7850 __func__, msg->sadb_msg_type));
7851 PFKEYSTAT_INC(out_invsatype);
7856 case SADB_SATYPE_RSVP:
7857 case SADB_SATYPE_OSPFV2:
7858 case SADB_SATYPE_RIPV2:
7859 case SADB_SATYPE_MIP:
7860 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7861 __func__, msg->sadb_msg_satype));
7862 PFKEYSTAT_INC(out_invsatype);
7865 case 1: /* XXX: What does it do? */
7866 if (msg->sadb_msg_type == SADB_X_PROMISC)
7870 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7871 __func__, msg->sadb_msg_satype));
7872 PFKEYSTAT_INC(out_invsatype);
7878 /* check field of upper layer protocol and address family */
7879 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7880 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7881 struct sadb_address *src0, *dst0;
7884 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7885 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7887 /* check upper layer protocol */
7888 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7889 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7890 "mismatched.\n", __func__));
7891 PFKEYSTAT_INC(out_invaddr);
7897 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7898 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7899 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7901 PFKEYSTAT_INC(out_invaddr);
7905 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7906 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7907 ipseclog((LOG_DEBUG, "%s: address struct size "
7908 "mismatched.\n", __func__));
7909 PFKEYSTAT_INC(out_invaddr);
7914 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7916 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7917 sizeof(struct sockaddr_in)) {
7918 PFKEYSTAT_INC(out_invaddr);
7924 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7925 sizeof(struct sockaddr_in6)) {
7926 PFKEYSTAT_INC(out_invaddr);
7932 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7934 PFKEYSTAT_INC(out_invaddr);
7935 error = EAFNOSUPPORT;
7939 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7941 plen = sizeof(struct in_addr) << 3;
7944 plen = sizeof(struct in6_addr) << 3;
7947 plen = 0; /*fool gcc*/
7951 /* check max prefix length */
7952 if (src0->sadb_address_prefixlen > plen ||
7953 dst0->sadb_address_prefixlen > plen) {
7954 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7956 PFKEYSTAT_INC(out_invaddr);
7962 * prefixlen == 0 is valid because there can be a case when
7963 * all addresses are matched.
7967 if (msg->sadb_msg_type >= nitems(key_typesw) ||
7968 key_typesw[msg->sadb_msg_type] == NULL) {
7969 PFKEYSTAT_INC(out_invmsgtype);
7974 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
7977 msg->sadb_msg_errno = error;
7978 return key_sendup_mbuf(so, m, target);
7982 key_senderror(struct socket *so, struct mbuf *m, int code)
7984 struct sadb_msg *msg;
7986 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
7987 ("mbuf too small, len %u", m->m_len));
7989 msg = mtod(m, struct sadb_msg *);
7990 msg->sadb_msg_errno = code;
7991 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
7995 * set the pointer to each header into message buffer.
7996 * m will be freed on error.
7997 * XXX larger-than-MCLBYTES extension?
8000 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
8003 struct sadb_ext *ext;
8008 IPSEC_ASSERT(m != NULL, ("null mbuf"));
8009 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
8010 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8011 ("mbuf too small, len %u", m->m_len));
8014 bzero(mhp, sizeof(*mhp));
8016 mhp->msg = mtod(m, struct sadb_msg *);
8017 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
8019 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
8020 extlen = end; /*just in case extlen is not updated*/
8021 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
8022 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
8024 /* m is already freed */
8027 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8030 switch (ext->sadb_ext_type) {
8032 case SADB_EXT_ADDRESS_SRC:
8033 case SADB_EXT_ADDRESS_DST:
8034 case SADB_EXT_ADDRESS_PROXY:
8035 case SADB_EXT_LIFETIME_CURRENT:
8036 case SADB_EXT_LIFETIME_HARD:
8037 case SADB_EXT_LIFETIME_SOFT:
8038 case SADB_EXT_KEY_AUTH:
8039 case SADB_EXT_KEY_ENCRYPT:
8040 case SADB_EXT_IDENTITY_SRC:
8041 case SADB_EXT_IDENTITY_DST:
8042 case SADB_EXT_SENSITIVITY:
8043 case SADB_EXT_PROPOSAL:
8044 case SADB_EXT_SUPPORTED_AUTH:
8045 case SADB_EXT_SUPPORTED_ENCRYPT:
8046 case SADB_EXT_SPIRANGE:
8047 case SADB_X_EXT_POLICY:
8048 case SADB_X_EXT_SA2:
8049 case SADB_X_EXT_NAT_T_TYPE:
8050 case SADB_X_EXT_NAT_T_SPORT:
8051 case SADB_X_EXT_NAT_T_DPORT:
8052 case SADB_X_EXT_NAT_T_OAI:
8053 case SADB_X_EXT_NAT_T_OAR:
8054 case SADB_X_EXT_NAT_T_FRAG:
8055 case SADB_X_EXT_SA_REPLAY:
8056 case SADB_X_EXT_NEW_ADDRESS_SRC:
8057 case SADB_X_EXT_NEW_ADDRESS_DST:
8058 /* duplicate check */
8060 * XXX Are there duplication payloads of either
8061 * KEY_AUTH or KEY_ENCRYPT ?
8063 if (mhp->ext[ext->sadb_ext_type] != NULL) {
8064 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
8065 "%u\n", __func__, ext->sadb_ext_type));
8067 PFKEYSTAT_INC(out_dupext);
8072 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
8073 __func__, ext->sadb_ext_type));
8075 PFKEYSTAT_INC(out_invexttype);
8079 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
8081 if (key_validate_ext(ext, extlen)) {
8083 PFKEYSTAT_INC(out_invlen);
8087 n = m_pulldown(m, off, extlen, &toff);
8089 /* m is already freed */
8092 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8094 mhp->ext[ext->sadb_ext_type] = ext;
8095 mhp->extoff[ext->sadb_ext_type] = off;
8096 mhp->extlen[ext->sadb_ext_type] = extlen;
8101 PFKEYSTAT_INC(out_invlen);
8109 key_validate_ext(const struct sadb_ext *ext, int len)
8111 const struct sockaddr *sa;
8112 enum { NONE, ADDR } checktype = NONE;
8114 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8116 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8119 /* if it does not match minimum/maximum length, bail */
8120 if (ext->sadb_ext_type >= nitems(minsize) ||
8121 ext->sadb_ext_type >= nitems(maxsize))
8123 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8125 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8128 /* more checks based on sadb_ext_type XXX need more */
8129 switch (ext->sadb_ext_type) {
8130 case SADB_EXT_ADDRESS_SRC:
8131 case SADB_EXT_ADDRESS_DST:
8132 case SADB_EXT_ADDRESS_PROXY:
8133 case SADB_X_EXT_NAT_T_OAI:
8134 case SADB_X_EXT_NAT_T_OAR:
8135 case SADB_X_EXT_NEW_ADDRESS_SRC:
8136 case SADB_X_EXT_NEW_ADDRESS_DST:
8137 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8140 case SADB_EXT_IDENTITY_SRC:
8141 case SADB_EXT_IDENTITY_DST:
8142 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8143 SADB_X_IDENTTYPE_ADDR) {
8144 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8154 switch (checktype) {
8158 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8159 if (len < baselen + sal)
8161 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8174 TUNABLE_INT_FETCH("net.key.spdcache.maxentries",
8175 &V_key_spdcache_maxentries);
8176 TUNABLE_INT_FETCH("net.key.spdcache.threshold",
8177 &V_key_spdcache_threshold);
8179 if (V_key_spdcache_maxentries) {
8180 V_key_spdcache_maxentries = MAX(V_key_spdcache_maxentries,
8181 SPDCACHE_MAX_ENTRIES_PER_HASH);
8182 V_spdcachehashtbl = hashinit(V_key_spdcache_maxentries /
8183 SPDCACHE_MAX_ENTRIES_PER_HASH,
8184 M_IPSEC_SPDCACHE, &V_spdcachehash_mask);
8185 V_key_spdcache_maxentries = (V_spdcachehash_mask + 1)
8186 * SPDCACHE_MAX_ENTRIES_PER_HASH;
8188 V_spdcache_lock = malloc(sizeof(struct mtx) *
8189 (V_spdcachehash_mask + 1),
8190 M_IPSEC_SPDCACHE, M_WAITOK|M_ZERO);
8192 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8193 SPDCACHE_LOCK_INIT(i);
8197 struct spdcache_entry *
8198 spdcache_entry_alloc(const struct secpolicyindex *spidx, struct secpolicy *sp)
8200 struct spdcache_entry *entry;
8202 entry = malloc(sizeof(struct spdcache_entry),
8203 M_IPSEC_SPDCACHE, M_NOWAIT|M_ZERO);
8210 entry->spidx = *spidx;
8217 spdcache_entry_free(struct spdcache_entry *entry)
8220 if (entry->sp != NULL)
8221 key_freesp(&entry->sp);
8222 free(entry, M_IPSEC_SPDCACHE);
8226 spdcache_clear(void)
8228 struct spdcache_entry *entry;
8231 for (i = 0; i < V_spdcachehash_mask + 1; ++i) {
8233 while (!LIST_EMPTY(&V_spdcachehashtbl[i])) {
8234 entry = LIST_FIRST(&V_spdcachehashtbl[i]);
8235 LIST_REMOVE(entry, chain);
8236 spdcache_entry_free(entry);
8244 spdcache_destroy(void)
8248 if (SPDCACHE_ENABLED()) {
8250 hashdestroy(V_spdcachehashtbl, M_IPSEC_SPDCACHE, V_spdcachehash_mask);
8252 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8253 SPDCACHE_LOCK_DESTROY(i);
8255 free(V_spdcache_lock, M_IPSEC_SPDCACHE);
8264 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8265 TAILQ_INIT(&V_sptree[i]);
8266 TAILQ_INIT(&V_sptree_ifnet[i]);
8269 TAILQ_INIT(&V_sahtree);
8270 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8271 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8272 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8273 &V_sahaddrhash_mask);
8274 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8275 &V_acqaddrhash_mask);
8276 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8277 &V_acqseqhash_mask);
8281 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8282 LIST_INIT(&V_regtree[i]);
8284 LIST_INIT(&V_acqtree);
8285 LIST_INIT(&V_spacqtree);
8287 if (!IS_DEFAULT_VNET(curvnet))
8290 ipsec_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8291 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8292 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8295 REGTREE_LOCK_INIT();
8296 SAHTREE_LOCK_INIT();
8300 #ifndef IPSEC_DEBUG2
8301 callout_init(&key_timer, 1);
8302 callout_reset(&key_timer, hz, key_timehandler, NULL);
8303 #endif /*IPSEC_DEBUG2*/
8305 /* initialize key statistics */
8306 keystat.getspi_count = 1;
8309 printf("IPsec: Initialized Security Association Processing.\n");
8316 struct secashead_queue sahdrainq;
8317 struct secpolicy_queue drainq;
8318 struct secpolicy *sp, *nextsp;
8319 struct secacq *acq, *nextacq;
8320 struct secspacq *spacq, *nextspacq;
8321 struct secashead *sah;
8322 struct secasvar *sav;
8327 * XXX: can we just call free() for each object without
8328 * walking through safe way with releasing references?
8330 TAILQ_INIT(&drainq);
8332 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8333 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8334 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8336 for (i = 0; i < V_sphash_mask + 1; i++)
8337 LIST_INIT(&V_sphashtbl[i]);
8341 sp = TAILQ_FIRST(&drainq);
8342 while (sp != NULL) {
8343 nextsp = TAILQ_NEXT(sp, chain);
8348 TAILQ_INIT(&sahdrainq);
8350 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8351 for (i = 0; i < V_savhash_mask + 1; i++)
8352 LIST_INIT(&V_savhashtbl[i]);
8353 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8354 LIST_INIT(&V_sahaddrhashtbl[i]);
8355 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8356 sah->state = SADB_SASTATE_DEAD;
8357 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8358 sav->state = SADB_SASTATE_DEAD;
8360 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8361 sav->state = SADB_SASTATE_DEAD;
8366 key_freesah_flushed(&sahdrainq);
8367 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8368 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8369 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8372 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8373 LIST_FOREACH(reg, &V_regtree[i], chain) {
8374 if (__LIST_CHAINED(reg)) {
8375 LIST_REMOVE(reg, chain);
8376 free(reg, M_IPSEC_SAR);
8384 acq = LIST_FIRST(&V_acqtree);
8385 while (acq != NULL) {
8386 nextacq = LIST_NEXT(acq, chain);
8387 LIST_REMOVE(acq, chain);
8388 free(acq, M_IPSEC_SAQ);
8391 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8392 LIST_INIT(&V_acqaddrhashtbl[i]);
8393 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8394 LIST_INIT(&V_acqseqhashtbl[i]);
8398 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8399 spacq = nextspacq) {
8400 nextspacq = LIST_NEXT(spacq, chain);
8401 if (__LIST_CHAINED(spacq)) {
8402 LIST_REMOVE(spacq, chain);
8403 free(spacq, M_IPSEC_SAQ);
8407 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8408 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8410 if (!IS_DEFAULT_VNET(curvnet))
8413 uma_zdestroy(ipsec_key_lft_zone);
8415 #ifndef IPSEC_DEBUG2
8416 callout_drain(&key_timer);
8418 SPTREE_LOCK_DESTROY();
8419 REGTREE_LOCK_DESTROY();
8420 SAHTREE_LOCK_DESTROY();
8422 SPACQ_LOCK_DESTROY();
8426 /* record data transfer on SA, and update timestamps */
8428 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8430 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8431 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8434 * XXX Currently, there is a difference of bytes size
8435 * between inbound and outbound processing.
8437 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8440 * We use the number of packets as the unit of
8441 * allocations. We increment the variable
8442 * whenever {esp,ah}_{in,out}put is called.
8444 counter_u64_add(sav->lft_c_allocations, 1);
8447 * NOTE: We record CURRENT usetime by using wall clock,
8448 * in seconds. HARD and SOFT lifetime are measured by the time
8449 * difference (again in seconds) from usetime.
8453 * -----+-----+--------+---> t
8454 * <--------------> HARD
8457 if (sav->firstused == 0)
8458 sav->firstused = time_second;
8462 * Take one of the kernel's security keys and convert it into a PF_KEY
8463 * structure within an mbuf, suitable for sending up to a waiting
8464 * application in user land.
8467 * src: A pointer to a kernel security key.
8468 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8470 * a valid mbuf or NULL indicating an error
8474 static struct mbuf *
8475 key_setkey(struct seckey *src, uint16_t exttype)
8484 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8485 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8490 p = mtod(m, struct sadb_key *);
8492 p->sadb_key_len = PFKEY_UNIT64(len);
8493 p->sadb_key_exttype = exttype;
8494 p->sadb_key_bits = src->bits;
8495 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8501 * Take one of the kernel's lifetime data structures and convert it
8502 * into a PF_KEY structure within an mbuf, suitable for sending up to
8503 * a waiting application in user land.
8506 * src: A pointer to a kernel lifetime structure.
8507 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8508 * data structures for more information.
8510 * a valid mbuf or NULL indicating an error
8514 static struct mbuf *
8515 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8517 struct mbuf *m = NULL;
8518 struct sadb_lifetime *p;
8519 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8524 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8529 p = mtod(m, struct sadb_lifetime *);
8532 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8533 p->sadb_lifetime_exttype = exttype;
8534 p->sadb_lifetime_allocations = src->allocations;
8535 p->sadb_lifetime_bytes = src->bytes;
8536 p->sadb_lifetime_addtime = src->addtime;
8537 p->sadb_lifetime_usetime = src->usetime;
8543 const struct enc_xform *
8544 enc_algorithm_lookup(int alg)
8548 for (i = 0; i < nitems(supported_ealgs); i++)
8549 if (alg == supported_ealgs[i].sadb_alg)
8550 return (supported_ealgs[i].xform);
8554 const struct auth_hash *
8555 auth_algorithm_lookup(int alg)
8559 for (i = 0; i < nitems(supported_aalgs); i++)
8560 if (alg == supported_aalgs[i].sadb_alg)
8561 return (supported_aalgs[i].xform);
8565 const struct comp_algo *
8566 comp_algorithm_lookup(int alg)
8570 for (i = 0; i < nitems(supported_calgs); i++)
8571 if (alg == supported_calgs[i].sadb_alg)
8572 return (supported_calgs[i].xform);