2 /* $KAME: key.c,v 1.191 2001/06/27 10:46:49 sakane Exp $ */
5 * SPDX-License-Identifier: BSD-3-Clause
7 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the project nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * This code is referd to RFC 2367
40 #include "opt_inet6.h"
41 #include "opt_ipsec.h"
43 #include <sys/types.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/fnv_hash.h>
49 #include <sys/mutex.h>
51 #include <sys/domain.h>
52 #include <sys/protosw.h>
53 #include <sys/malloc.h>
54 #include <sys/rmlock.h>
55 #include <sys/socket.h>
56 #include <sys/socketvar.h>
57 #include <sys/sysctl.h>
58 #include <sys/errno.h>
60 #include <sys/queue.h>
61 #include <sys/refcount.h>
62 #include <sys/syslog.h>
67 #include <net/if_var.h>
69 #include <net/raw_cb.h>
71 #include <netinet/in.h>
72 #include <netinet/in_systm.h>
73 #include <netinet/ip.h>
74 #include <netinet/in_var.h>
75 #include <netinet/udp.h>
78 #include <netinet/ip6.h>
79 #include <netinet6/in6_var.h>
80 #include <netinet6/ip6_var.h>
83 #include <net/pfkeyv2.h>
84 #include <netipsec/keydb.h>
85 #include <netipsec/key.h>
86 #include <netipsec/keysock.h>
87 #include <netipsec/key_debug.h>
89 #include <netipsec/ipsec.h>
91 #include <netipsec/ipsec6.h>
94 #include <netipsec/xform.h>
95 #include <machine/in_cksum.h>
96 #include <machine/stdarg.h>
99 #include <sys/random.h>
101 #define FULLMASK 0xff
102 #define _BITS(bytes) ((bytes) << 3)
105 * Note on SA reference counting:
106 * - SAs that are not in DEAD state will have (total external reference + 1)
107 * following value in reference count field. they cannot be freed and are
108 * referenced from SA header.
109 * - SAs that are in DEAD state will have (total external reference)
110 * in reference count field. they are ready to be freed. reference from
111 * SA header will be removed in key_delsav(), when the reference count
112 * field hits 0 (= no external reference other than from SA header.
115 VNET_DEFINE(u_int32_t, key_debug_level) = 0;
116 VNET_DEFINE_STATIC(u_int, key_spi_trycnt) = 1000;
117 VNET_DEFINE_STATIC(u_int32_t, key_spi_minval) = 0x100;
118 VNET_DEFINE_STATIC(u_int32_t, key_spi_maxval) = 0x0fffffff; /* XXX */
119 VNET_DEFINE_STATIC(u_int32_t, policy_id) = 0;
120 /*interval to initialize randseed,1(m)*/
121 VNET_DEFINE_STATIC(u_int, key_int_random) = 60;
122 /* interval to expire acquiring, 30(s)*/
123 VNET_DEFINE_STATIC(u_int, key_larval_lifetime) = 30;
124 /* counter for blocking SADB_ACQUIRE.*/
125 VNET_DEFINE_STATIC(int, key_blockacq_count) = 10;
126 /* lifetime for blocking SADB_ACQUIRE.*/
127 VNET_DEFINE_STATIC(int, key_blockacq_lifetime) = 20;
128 /* preferred old sa rather than new sa.*/
129 VNET_DEFINE_STATIC(int, key_preferred_oldsa) = 1;
130 #define V_key_spi_trycnt VNET(key_spi_trycnt)
131 #define V_key_spi_minval VNET(key_spi_minval)
132 #define V_key_spi_maxval VNET(key_spi_maxval)
133 #define V_policy_id VNET(policy_id)
134 #define V_key_int_random VNET(key_int_random)
135 #define V_key_larval_lifetime VNET(key_larval_lifetime)
136 #define V_key_blockacq_count VNET(key_blockacq_count)
137 #define V_key_blockacq_lifetime VNET(key_blockacq_lifetime)
138 #define V_key_preferred_oldsa VNET(key_preferred_oldsa)
140 VNET_DEFINE_STATIC(u_int32_t, acq_seq) = 0;
141 #define V_acq_seq VNET(acq_seq)
143 VNET_DEFINE_STATIC(uint32_t, sp_genid) = 0;
144 #define V_sp_genid VNET(sp_genid)
147 TAILQ_HEAD(secpolicy_queue, secpolicy);
148 LIST_HEAD(secpolicy_list, secpolicy);
149 VNET_DEFINE_STATIC(struct secpolicy_queue, sptree[IPSEC_DIR_MAX]);
150 VNET_DEFINE_STATIC(struct secpolicy_queue, sptree_ifnet[IPSEC_DIR_MAX]);
151 static struct rmlock sptree_lock;
152 #define V_sptree VNET(sptree)
153 #define V_sptree_ifnet VNET(sptree_ifnet)
154 #define SPTREE_LOCK_INIT() rm_init(&sptree_lock, "sptree")
155 #define SPTREE_LOCK_DESTROY() rm_destroy(&sptree_lock)
156 #define SPTREE_RLOCK_TRACKER struct rm_priotracker sptree_tracker
157 #define SPTREE_RLOCK() rm_rlock(&sptree_lock, &sptree_tracker)
158 #define SPTREE_RUNLOCK() rm_runlock(&sptree_lock, &sptree_tracker)
159 #define SPTREE_RLOCK_ASSERT() rm_assert(&sptree_lock, RA_RLOCKED)
160 #define SPTREE_WLOCK() rm_wlock(&sptree_lock)
161 #define SPTREE_WUNLOCK() rm_wunlock(&sptree_lock)
162 #define SPTREE_WLOCK_ASSERT() rm_assert(&sptree_lock, RA_WLOCKED)
163 #define SPTREE_UNLOCK_ASSERT() rm_assert(&sptree_lock, RA_UNLOCKED)
165 /* Hash table for lookup SP using unique id */
166 VNET_DEFINE_STATIC(struct secpolicy_list *, sphashtbl);
167 VNET_DEFINE_STATIC(u_long, sphash_mask);
168 #define V_sphashtbl VNET(sphashtbl)
169 #define V_sphash_mask VNET(sphash_mask)
171 #define SPHASH_NHASH_LOG2 7
172 #define SPHASH_NHASH (1 << SPHASH_NHASH_LOG2)
173 #define SPHASH_HASHVAL(id) (key_u32hash(id) & V_sphash_mask)
174 #define SPHASH_HASH(id) &V_sphashtbl[SPHASH_HASHVAL(id)]
177 struct spdcache_entry {
178 struct secpolicyindex spidx; /* secpolicyindex */
179 struct secpolicy *sp; /* cached policy to be used */
181 LIST_ENTRY(spdcache_entry) chain;
183 LIST_HEAD(spdcache_entry_list, spdcache_entry);
185 #define SPDCACHE_MAX_ENTRIES_PER_HASH 8
187 VNET_DEFINE_STATIC(u_int, key_spdcache_maxentries) = 0;
188 #define V_key_spdcache_maxentries VNET(key_spdcache_maxentries)
189 VNET_DEFINE_STATIC(u_int, key_spdcache_threshold) = 32;
190 #define V_key_spdcache_threshold VNET(key_spdcache_threshold)
191 VNET_DEFINE_STATIC(unsigned long, spd_size) = 0;
192 #define V_spd_size VNET(spd_size)
194 #define SPDCACHE_ENABLED() (V_key_spdcache_maxentries != 0)
195 #define SPDCACHE_ACTIVE() \
196 (SPDCACHE_ENABLED() && V_spd_size >= V_key_spdcache_threshold)
198 VNET_DEFINE_STATIC(struct spdcache_entry_list *, spdcachehashtbl);
199 VNET_DEFINE_STATIC(u_long, spdcachehash_mask);
200 #define V_spdcachehashtbl VNET(spdcachehashtbl)
201 #define V_spdcachehash_mask VNET(spdcachehash_mask)
203 #define SPDCACHE_HASHVAL(idx) \
204 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->ul_proto) & \
207 /* Each cache line is protected by a mutex */
208 VNET_DEFINE_STATIC(struct mtx *, spdcache_lock);
209 #define V_spdcache_lock VNET(spdcache_lock)
211 #define SPDCACHE_LOCK_INIT(a) \
212 mtx_init(&V_spdcache_lock[a], "spdcache", \
213 "fast ipsec SPD cache", MTX_DEF|MTX_DUPOK)
214 #define SPDCACHE_LOCK_DESTROY(a) mtx_destroy(&V_spdcache_lock[a])
215 #define SPDCACHE_LOCK(a) mtx_lock(&V_spdcache_lock[a]);
216 #define SPDCACHE_UNLOCK(a) mtx_unlock(&V_spdcache_lock[a]);
219 TAILQ_HEAD(secashead_queue, secashead);
220 LIST_HEAD(secashead_list, secashead);
221 VNET_DEFINE_STATIC(struct secashead_queue, sahtree);
222 static struct rmlock sahtree_lock;
223 #define V_sahtree VNET(sahtree)
224 #define SAHTREE_LOCK_INIT() rm_init(&sahtree_lock, "sahtree")
225 #define SAHTREE_LOCK_DESTROY() rm_destroy(&sahtree_lock)
226 #define SAHTREE_RLOCK_TRACKER struct rm_priotracker sahtree_tracker
227 #define SAHTREE_RLOCK() rm_rlock(&sahtree_lock, &sahtree_tracker)
228 #define SAHTREE_RUNLOCK() rm_runlock(&sahtree_lock, &sahtree_tracker)
229 #define SAHTREE_RLOCK_ASSERT() rm_assert(&sahtree_lock, RA_RLOCKED)
230 #define SAHTREE_WLOCK() rm_wlock(&sahtree_lock)
231 #define SAHTREE_WUNLOCK() rm_wunlock(&sahtree_lock)
232 #define SAHTREE_WLOCK_ASSERT() rm_assert(&sahtree_lock, RA_WLOCKED)
233 #define SAHTREE_UNLOCK_ASSERT() rm_assert(&sahtree_lock, RA_UNLOCKED)
235 /* Hash table for lookup in SAD using SA addresses */
236 VNET_DEFINE_STATIC(struct secashead_list *, sahaddrhashtbl);
237 VNET_DEFINE_STATIC(u_long, sahaddrhash_mask);
238 #define V_sahaddrhashtbl VNET(sahaddrhashtbl)
239 #define V_sahaddrhash_mask VNET(sahaddrhash_mask)
241 #define SAHHASH_NHASH_LOG2 7
242 #define SAHHASH_NHASH (1 << SAHHASH_NHASH_LOG2)
243 #define SAHADDRHASH_HASHVAL(idx) \
244 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->proto) & \
246 #define SAHADDRHASH_HASH(saidx) \
247 &V_sahaddrhashtbl[SAHADDRHASH_HASHVAL(saidx)]
249 /* Hash table for lookup in SAD using SPI */
250 LIST_HEAD(secasvar_list, secasvar);
251 VNET_DEFINE_STATIC(struct secasvar_list *, savhashtbl);
252 VNET_DEFINE_STATIC(u_long, savhash_mask);
253 #define V_savhashtbl VNET(savhashtbl)
254 #define V_savhash_mask VNET(savhash_mask)
255 #define SAVHASH_NHASH_LOG2 7
256 #define SAVHASH_NHASH (1 << SAVHASH_NHASH_LOG2)
257 #define SAVHASH_HASHVAL(spi) (key_u32hash(spi) & V_savhash_mask)
258 #define SAVHASH_HASH(spi) &V_savhashtbl[SAVHASH_HASHVAL(spi)]
261 key_addrprotohash(const union sockaddr_union *src,
262 const union sockaddr_union *dst, const uint8_t *proto)
266 hval = fnv_32_buf(proto, sizeof(*proto),
268 switch (dst->sa.sa_family) {
271 hval = fnv_32_buf(&src->sin.sin_addr,
272 sizeof(in_addr_t), hval);
273 hval = fnv_32_buf(&dst->sin.sin_addr,
274 sizeof(in_addr_t), hval);
279 hval = fnv_32_buf(&src->sin6.sin6_addr,
280 sizeof(struct in6_addr), hval);
281 hval = fnv_32_buf(&dst->sin6.sin6_addr,
282 sizeof(struct in6_addr), hval);
287 ipseclog((LOG_DEBUG, "%s: unknown address family %d\n",
288 __func__, dst->sa.sa_family));
294 key_u32hash(uint32_t val)
297 return (fnv_32_buf(&val, sizeof(val), FNV1_32_INIT));
301 VNET_DEFINE_STATIC(LIST_HEAD(_regtree, secreg), regtree[SADB_SATYPE_MAX + 1]);
302 #define V_regtree VNET(regtree)
303 static struct mtx regtree_lock;
304 #define REGTREE_LOCK_INIT() \
305 mtx_init(®tree_lock, "regtree", "fast ipsec regtree", MTX_DEF)
306 #define REGTREE_LOCK_DESTROY() mtx_destroy(®tree_lock)
307 #define REGTREE_LOCK() mtx_lock(®tree_lock)
308 #define REGTREE_UNLOCK() mtx_unlock(®tree_lock)
309 #define REGTREE_LOCK_ASSERT() mtx_assert(®tree_lock, MA_OWNED)
312 LIST_HEAD(secacq_list, secacq);
313 VNET_DEFINE_STATIC(struct secacq_list, acqtree);
314 #define V_acqtree VNET(acqtree)
315 static struct mtx acq_lock;
316 #define ACQ_LOCK_INIT() \
317 mtx_init(&acq_lock, "acqtree", "ipsec SA acquiring list", MTX_DEF)
318 #define ACQ_LOCK_DESTROY() mtx_destroy(&acq_lock)
319 #define ACQ_LOCK() mtx_lock(&acq_lock)
320 #define ACQ_UNLOCK() mtx_unlock(&acq_lock)
321 #define ACQ_LOCK_ASSERT() mtx_assert(&acq_lock, MA_OWNED)
323 /* Hash table for lookup in ACQ list using SA addresses */
324 VNET_DEFINE_STATIC(struct secacq_list *, acqaddrhashtbl);
325 VNET_DEFINE_STATIC(u_long, acqaddrhash_mask);
326 #define V_acqaddrhashtbl VNET(acqaddrhashtbl)
327 #define V_acqaddrhash_mask VNET(acqaddrhash_mask)
329 /* Hash table for lookup in ACQ list using SEQ number */
330 VNET_DEFINE_STATIC(struct secacq_list *, acqseqhashtbl);
331 VNET_DEFINE_STATIC(u_long, acqseqhash_mask);
332 #define V_acqseqhashtbl VNET(acqseqhashtbl)
333 #define V_acqseqhash_mask VNET(acqseqhash_mask)
335 #define ACQHASH_NHASH_LOG2 7
336 #define ACQHASH_NHASH (1 << ACQHASH_NHASH_LOG2)
337 #define ACQADDRHASH_HASHVAL(idx) \
338 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->proto) & \
340 #define ACQSEQHASH_HASHVAL(seq) \
341 (key_u32hash(seq) & V_acqseqhash_mask)
342 #define ACQADDRHASH_HASH(saidx) \
343 &V_acqaddrhashtbl[ACQADDRHASH_HASHVAL(saidx)]
344 #define ACQSEQHASH_HASH(seq) \
345 &V_acqseqhashtbl[ACQSEQHASH_HASHVAL(seq)]
346 /* SP acquiring list */
347 VNET_DEFINE_STATIC(LIST_HEAD(_spacqtree, secspacq), spacqtree);
348 #define V_spacqtree VNET(spacqtree)
349 static struct mtx spacq_lock;
350 #define SPACQ_LOCK_INIT() \
351 mtx_init(&spacq_lock, "spacqtree", \
352 "fast ipsec security policy acquire list", MTX_DEF)
353 #define SPACQ_LOCK_DESTROY() mtx_destroy(&spacq_lock)
354 #define SPACQ_LOCK() mtx_lock(&spacq_lock)
355 #define SPACQ_UNLOCK() mtx_unlock(&spacq_lock)
356 #define SPACQ_LOCK_ASSERT() mtx_assert(&spacq_lock, MA_OWNED)
358 static const int minsize[] = {
359 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
360 sizeof(struct sadb_sa), /* SADB_EXT_SA */
361 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
362 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
363 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
364 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_SRC */
365 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_DST */
366 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_PROXY */
367 sizeof(struct sadb_key), /* SADB_EXT_KEY_AUTH */
368 sizeof(struct sadb_key), /* SADB_EXT_KEY_ENCRYPT */
369 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_SRC */
370 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_DST */
371 sizeof(struct sadb_sens), /* SADB_EXT_SENSITIVITY */
372 sizeof(struct sadb_prop), /* SADB_EXT_PROPOSAL */
373 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_AUTH */
374 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_ENCRYPT */
375 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
376 0, /* SADB_X_EXT_KMPRIVATE */
377 sizeof(struct sadb_x_policy), /* SADB_X_EXT_POLICY */
378 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
379 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
380 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
381 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
382 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAI */
383 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAR */
384 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
385 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
386 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_SRC */
387 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_DST */
389 _Static_assert(sizeof(minsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
391 static const int maxsize[] = {
392 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
393 sizeof(struct sadb_sa), /* SADB_EXT_SA */
394 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
395 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
396 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
397 0, /* SADB_EXT_ADDRESS_SRC */
398 0, /* SADB_EXT_ADDRESS_DST */
399 0, /* SADB_EXT_ADDRESS_PROXY */
400 0, /* SADB_EXT_KEY_AUTH */
401 0, /* SADB_EXT_KEY_ENCRYPT */
402 0, /* SADB_EXT_IDENTITY_SRC */
403 0, /* SADB_EXT_IDENTITY_DST */
404 0, /* SADB_EXT_SENSITIVITY */
405 0, /* SADB_EXT_PROPOSAL */
406 0, /* SADB_EXT_SUPPORTED_AUTH */
407 0, /* SADB_EXT_SUPPORTED_ENCRYPT */
408 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
409 0, /* SADB_X_EXT_KMPRIVATE */
410 0, /* SADB_X_EXT_POLICY */
411 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
412 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
413 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
414 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
415 0, /* SADB_X_EXT_NAT_T_OAI */
416 0, /* SADB_X_EXT_NAT_T_OAR */
417 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
418 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
419 0, /* SADB_X_EXT_NEW_ADDRESS_SRC */
420 0, /* SADB_X_EXT_NEW_ADDRESS_DST */
422 _Static_assert(sizeof(maxsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
425 * Internal values for SA flags:
426 * SADB_X_EXT_F_CLONED means that SA was cloned by key_updateaddresses,
427 * thus we will not free the most of SA content in key_delsav().
429 #define SADB_X_EXT_F_CLONED 0x80000000
431 #define SADB_CHECKLEN(_mhp, _ext) \
432 ((_mhp)->extlen[(_ext)] < minsize[(_ext)] || (maxsize[(_ext)] != 0 && \
433 ((_mhp)->extlen[(_ext)] > maxsize[(_ext)])))
434 #define SADB_CHECKHDR(_mhp, _ext) ((_mhp)->ext[(_ext)] == NULL)
436 VNET_DEFINE_STATIC(int, ipsec_esp_keymin) = 256;
437 VNET_DEFINE_STATIC(int, ipsec_esp_auth) = 0;
438 VNET_DEFINE_STATIC(int, ipsec_ah_keymin) = 128;
440 #define V_ipsec_esp_keymin VNET(ipsec_esp_keymin)
441 #define V_ipsec_esp_auth VNET(ipsec_esp_auth)
442 #define V_ipsec_ah_keymin VNET(ipsec_ah_keymin)
445 VNET_DEFINE(int, ipsec_debug) = 1;
447 VNET_DEFINE(int, ipsec_debug) = 0;
451 SYSCTL_DECL(_net_inet_ipsec);
452 SYSCTL_INT(_net_inet_ipsec, IPSECCTL_DEBUG, debug,
453 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
454 "Enable IPsec debugging output when set.");
457 SYSCTL_DECL(_net_inet6_ipsec6);
458 SYSCTL_INT(_net_inet6_ipsec6, IPSECCTL_DEBUG, debug,
459 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
460 "Enable IPsec debugging output when set.");
463 SYSCTL_DECL(_net_key);
464 SYSCTL_INT(_net_key, KEYCTL_DEBUG_LEVEL, debug,
465 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_debug_level), 0, "");
467 /* max count of trial for the decision of spi value */
468 SYSCTL_INT(_net_key, KEYCTL_SPI_TRY, spi_trycnt,
469 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_trycnt), 0, "");
471 /* minimum spi value to allocate automatically. */
472 SYSCTL_INT(_net_key, KEYCTL_SPI_MIN_VALUE, spi_minval,
473 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_minval), 0, "");
475 /* maximun spi value to allocate automatically. */
476 SYSCTL_INT(_net_key, KEYCTL_SPI_MAX_VALUE, spi_maxval,
477 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_maxval), 0, "");
479 /* interval to initialize randseed */
480 SYSCTL_INT(_net_key, KEYCTL_RANDOM_INT, int_random,
481 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_int_random), 0, "");
483 /* lifetime for larval SA */
484 SYSCTL_INT(_net_key, KEYCTL_LARVAL_LIFETIME, larval_lifetime,
485 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_larval_lifetime), 0, "");
487 /* counter for blocking to send SADB_ACQUIRE to IKEd */
488 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_COUNT, blockacq_count,
489 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_count), 0, "");
491 /* lifetime for blocking to send SADB_ACQUIRE to IKEd */
492 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_LIFETIME, blockacq_lifetime,
493 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_lifetime), 0, "");
496 SYSCTL_INT(_net_key, KEYCTL_ESP_AUTH, esp_auth,
497 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_auth), 0, "");
499 /* minimum ESP key length */
500 SYSCTL_INT(_net_key, KEYCTL_ESP_KEYMIN, esp_keymin,
501 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_keymin), 0, "");
503 /* minimum AH key length */
504 SYSCTL_INT(_net_key, KEYCTL_AH_KEYMIN, ah_keymin,
505 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_ah_keymin), 0, "");
507 /* perfered old SA rather than new SA */
508 SYSCTL_INT(_net_key, KEYCTL_PREFERED_OLDSA, preferred_oldsa,
509 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_preferred_oldsa), 0, "");
511 static SYSCTL_NODE(_net_key, OID_AUTO, spdcache,
512 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
515 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, maxentries,
516 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_maxentries), 0,
517 "Maximum number of entries in the SPD cache"
518 " (power of 2, 0 to disable)");
520 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, threshold,
521 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_threshold), 0,
522 "Number of SPs that make the SPD cache active");
524 #define __LIST_CHAINED(elm) \
525 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
527 MALLOC_DEFINE(M_IPSEC_SA, "secasvar", "ipsec security association");
528 MALLOC_DEFINE(M_IPSEC_SAH, "sahead", "ipsec sa head");
529 MALLOC_DEFINE(M_IPSEC_SP, "ipsecpolicy", "ipsec security policy");
530 MALLOC_DEFINE(M_IPSEC_SR, "ipsecrequest", "ipsec security request");
531 MALLOC_DEFINE(M_IPSEC_MISC, "ipsec-misc", "ipsec miscellaneous");
532 MALLOC_DEFINE(M_IPSEC_SAQ, "ipsec-saq", "ipsec sa acquire");
533 MALLOC_DEFINE(M_IPSEC_SAR, "ipsec-reg", "ipsec sa acquire");
534 MALLOC_DEFINE(M_IPSEC_SPDCACHE, "ipsec-spdcache", "ipsec SPD cache");
536 VNET_DEFINE_STATIC(uma_zone_t, key_lft_zone);
537 #define V_key_lft_zone VNET(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)) {
876 * allocating a SP for OUTBOUND or INBOUND packet.
877 * Must call key_freesp() later.
878 * OUT: NULL: not found
879 * others: found and return the pointer.
882 key_allocsp(struct secpolicyindex *spidx, u_int dir)
884 struct spdcache_entry *entry, *lastentry, *tmpentry;
885 struct secpolicy *sp;
889 if (!SPDCACHE_ACTIVE()) {
890 sp = key_do_allocsp(spidx, dir);
894 hashv = SPDCACHE_HASHVAL(spidx);
895 SPDCACHE_LOCK(hashv);
897 LIST_FOREACH_SAFE(entry, &V_spdcachehashtbl[hashv], chain, tmpentry) {
898 /* Removed outdated entries */
899 if (entry->sp != NULL &&
900 entry->sp->state == IPSEC_SPSTATE_DEAD) {
901 LIST_REMOVE(entry, chain);
902 spdcache_entry_free(entry);
907 if (!key_cmpspidx_exactly(&entry->spidx, spidx)) {
913 if (entry->sp != NULL)
916 /* IPSECSTAT_INC(ips_spdcache_hits); */
918 SPDCACHE_UNLOCK(hashv);
922 /* IPSECSTAT_INC(ips_spdcache_misses); */
924 sp = key_do_allocsp(spidx, dir);
925 entry = spdcache_entry_alloc(spidx, sp);
927 if (nb_entries >= SPDCACHE_MAX_ENTRIES_PER_HASH) {
928 LIST_REMOVE(lastentry, chain);
929 spdcache_entry_free(lastentry);
932 LIST_INSERT_HEAD(&V_spdcachehashtbl[hashv], entry, chain);
935 SPDCACHE_UNLOCK(hashv);
938 if (sp != NULL) { /* found a SPD entry */
939 sp->lastused = time_second;
941 printf("%s: return SP(%p)\n", __func__, sp));
942 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
945 printf("%s: lookup failed for ", __func__);
946 kdebug_secpolicyindex(spidx, NULL));
952 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
953 * or should be signed by MD5 signature.
954 * We don't use key_allocsa() for such lookups, because we don't know SPI.
955 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
956 * signed packet. We use SADB only as storage for password.
957 * OUT: positive: corresponding SA for given saidx found.
961 key_allocsa_tcpmd5(struct secasindex *saidx)
963 SAHTREE_RLOCK_TRACKER;
964 struct secashead *sah;
965 struct secasvar *sav;
967 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
968 ("unexpected security protocol %u", saidx->proto));
969 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
970 ("unexpected mode %u", saidx->mode));
973 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
975 printf("%s: checking SAH\n", __func__);
976 kdebug_secash(sah, " "));
977 if (sah->saidx.proto != IPPROTO_TCP)
979 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
980 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
984 if (V_key_preferred_oldsa)
985 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
987 sav = TAILQ_FIRST(&sah->savtree_alive);
996 printf("%s: return SA(%p)\n", __func__, sav));
997 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1000 printf("%s: SA not found\n", __func__));
1001 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1007 * Allocating an SA entry for an *OUTBOUND* packet.
1008 * OUT: positive: corresponding SA for given saidx found.
1009 * NULL: SA not found, but will be acquired, check *error
1010 * for acquiring status.
1013 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
1016 SAHTREE_RLOCK_TRACKER;
1017 struct secashead *sah;
1018 struct secasvar *sav;
1020 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
1021 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
1022 saidx->mode == IPSEC_MODE_TUNNEL,
1023 ("unexpected policy %u", saidx->mode));
1026 * We check new SA in the IPsec request because a different
1027 * SA may be involved each time this request is checked, either
1028 * because new SAs are being configured, or this request is
1029 * associated with an unconnected datagram socket, or this request
1030 * is associated with a system default policy.
1033 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
1035 printf("%s: checking SAH\n", __func__);
1036 kdebug_secash(sah, " "));
1037 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
1043 * Allocate the oldest SA available according to
1044 * draft-jenkins-ipsec-rekeying-03.
1046 if (V_key_preferred_oldsa)
1047 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1049 sav = TAILQ_FIRST(&sah->savtree_alive);
1059 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
1061 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1062 return (sav); /* return referenced SA */
1065 /* there is no SA */
1066 *error = key_acquire(saidx, sp);
1068 ipseclog((LOG_DEBUG,
1069 "%s: error %d returned from key_acquire()\n",
1072 printf("%s: acquire SA for SP(%p), error %d\n",
1073 __func__, sp, *error));
1074 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1079 * allocating a usable SA entry for a *INBOUND* packet.
1080 * Must call key_freesav() later.
1081 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
1082 * NULL: not found, or error occurred.
1084 * According to RFC 2401 SA is uniquely identified by a triple SPI,
1085 * destination address, and security protocol. But according to RFC 4301,
1086 * SPI by itself suffices to specify an SA.
1088 * Note that, however, we do need to keep source address in IPsec SA.
1089 * IKE specification and PF_KEY specification do assume that we
1090 * keep source address in IPsec SA. We see a tricky situation here.
1093 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
1095 SAHTREE_RLOCK_TRACKER;
1096 struct secasvar *sav;
1098 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
1099 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
1103 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
1104 if (sav->spi == spi)
1108 * We use single SPI namespace for all protocols, so it is
1109 * impossible to have SPI duplicates in the SAVHASH.
1112 if (sav->state != SADB_SASTATE_LARVAL &&
1113 sav->sah->saidx.proto == proto &&
1114 key_sockaddrcmp(&dst->sa,
1115 &sav->sah->saidx.dst.sa, 0) == 0)
1124 char buf[IPSEC_ADDRSTRLEN];
1125 printf("%s: SA not found for spi %u proto %u dst %s\n",
1126 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1130 printf("%s: return SA(%p)\n", __func__, sav));
1131 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1137 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1140 SAHTREE_RLOCK_TRACKER;
1141 struct secasindex saidx;
1142 struct secashead *sah;
1143 struct secasvar *sav;
1145 IPSEC_ASSERT(src != NULL, ("null src address"));
1146 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1148 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1153 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1154 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1156 if (proto != sah->saidx.proto)
1158 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1160 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1162 /* XXXAE: is key_preferred_oldsa reasonably?*/
1163 if (V_key_preferred_oldsa)
1164 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1166 sav = TAILQ_FIRST(&sah->savtree_alive);
1174 printf("%s: return SA(%p)\n", __func__, sav));
1176 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1181 * Must be called after calling key_allocsp().
1184 key_freesp(struct secpolicy **spp)
1186 struct secpolicy *sp = *spp;
1188 IPSEC_ASSERT(sp != NULL, ("null sp"));
1189 if (SP_DELREF(sp) == 0)
1193 printf("%s: last reference to SP(%p)\n", __func__, sp));
1194 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1197 while (sp->tcount > 0)
1198 ipsec_delisr(sp->req[--sp->tcount]);
1199 free(sp, M_IPSEC_SP);
1203 key_unlink(struct secpolicy *sp)
1206 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1207 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1208 ("invalid direction %u", sp->spidx.dir));
1209 SPTREE_UNLOCK_ASSERT();
1212 printf("%s: SP(%p)\n", __func__, sp));
1214 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1215 /* SP is already unlinked */
1219 sp->state = IPSEC_SPSTATE_DEAD;
1220 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1222 LIST_REMOVE(sp, idhash);
1225 if (SPDCACHE_ENABLED())
1231 * insert a secpolicy into the SP database. Lower priorities first
1234 key_insertsp(struct secpolicy *newsp)
1236 struct secpolicy *sp;
1238 SPTREE_WLOCK_ASSERT();
1239 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1240 if (newsp->priority < sp->priority) {
1241 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1245 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1247 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1248 newsp->state = IPSEC_SPSTATE_ALIVE;
1254 * Insert a bunch of VTI secpolicies into the SPDB.
1255 * We keep VTI policies in the separate list due to following reasons:
1256 * 1) they should be immutable to user's or some deamon's attempts to
1257 * delete. The only way delete such policies - destroy or unconfigure
1258 * corresponding virtual inteface.
1259 * 2) such policies have traffic selector that matches all traffic per
1261 * Since all VTI policies have the same priority, we don't care about
1265 key_register_ifnet(struct secpolicy **spp, u_int count)
1272 * First of try to acquire id for each SP.
1274 for (i = 0; i < count; i++) {
1275 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1276 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1277 ("invalid direction %u", spp[i]->spidx.dir));
1279 if ((spp[i]->id = key_getnewspid()) == 0) {
1284 for (i = 0; i < count; i++) {
1285 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1288 * NOTE: despite the fact that we keep VTI SP in the
1289 * separate list, SPHASH contains policies from both
1290 * sources. Thus SADB_X_SPDGET will correctly return
1291 * SP by id, because it uses SPHASH for lookups.
1293 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1294 spp[i]->state = IPSEC_SPSTATE_IFNET;
1298 * Notify user processes about new SP.
1300 for (i = 0; i < count; i++) {
1301 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1303 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1309 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1315 for (i = 0; i < count; i++) {
1316 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1317 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1318 ("invalid direction %u", spp[i]->spidx.dir));
1320 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1322 spp[i]->state = IPSEC_SPSTATE_DEAD;
1323 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1326 LIST_REMOVE(spp[i], idhash);
1329 if (SPDCACHE_ENABLED())
1332 for (i = 0; i < count; i++) {
1333 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1335 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1340 * Must be called after calling key_allocsa().
1341 * This function is called by key_freesp() to free some SA allocated
1345 key_freesav(struct secasvar **psav)
1347 struct secasvar *sav = *psav;
1349 IPSEC_ASSERT(sav != NULL, ("null sav"));
1350 if (SAV_DELREF(sav) == 0)
1354 printf("%s: last reference to SA(%p)\n", __func__, sav));
1361 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1362 * Expect that SA has extra reference due to lookup.
1363 * Release this references, also release SAH reference after unlink.
1366 key_unlinksav(struct secasvar *sav)
1368 struct secashead *sah;
1371 printf("%s: SA(%p)\n", __func__, sav));
1373 SAHTREE_UNLOCK_ASSERT();
1375 if (sav->state == SADB_SASTATE_DEAD) {
1376 /* SA is already unlinked */
1380 /* Unlink from SAH */
1381 if (sav->state == SADB_SASTATE_LARVAL)
1382 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1384 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1385 /* Unlink from SPI hash */
1386 LIST_REMOVE(sav, spihash);
1387 sav->state = SADB_SASTATE_DEAD;
1391 /* Since we are unlinked, release reference to SAH */
1395 /* %%% SPD management */
1398 * OUT: NULL : not found
1399 * others : found, pointer to a SP.
1401 static struct secpolicy *
1402 key_getsp(struct secpolicyindex *spidx)
1404 SPTREE_RLOCK_TRACKER;
1405 struct secpolicy *sp;
1407 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1410 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1411 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1423 * OUT: NULL : not found
1424 * others : found, pointer to referenced SP.
1426 static struct secpolicy *
1427 key_getspbyid(uint32_t id)
1429 SPTREE_RLOCK_TRACKER;
1430 struct secpolicy *sp;
1433 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1446 struct secpolicy *sp;
1448 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1454 struct ipsecrequest *
1458 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1459 M_NOWAIT | M_ZERO));
1463 ipsec_delisr(struct ipsecrequest *p)
1466 free(p, M_IPSEC_SR);
1470 * create secpolicy structure from sadb_x_policy structure.
1471 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1472 * are not set, so must be set properly later.
1475 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1477 struct secpolicy *newsp;
1479 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1480 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1482 if (len != PFKEY_EXTLEN(xpl0)) {
1483 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1488 if ((newsp = key_newsp()) == NULL) {
1493 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1494 newsp->policy = xpl0->sadb_x_policy_type;
1495 newsp->priority = xpl0->sadb_x_policy_priority;
1499 switch (xpl0->sadb_x_policy_type) {
1500 case IPSEC_POLICY_DISCARD:
1501 case IPSEC_POLICY_NONE:
1502 case IPSEC_POLICY_ENTRUST:
1503 case IPSEC_POLICY_BYPASS:
1506 case IPSEC_POLICY_IPSEC:
1508 struct sadb_x_ipsecrequest *xisr;
1509 struct ipsecrequest *isr;
1512 /* validity check */
1513 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1514 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1521 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1522 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1526 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1527 xisr->sadb_x_ipsecrequest_len > tlen) {
1528 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1529 "length.\n", __func__));
1535 if (newsp->tcount >= IPSEC_MAXREQ) {
1536 ipseclog((LOG_DEBUG,
1537 "%s: too many ipsecrequests.\n",
1544 /* allocate request buffer */
1545 /* NB: data structure is zero'd */
1546 isr = ipsec_newisr();
1548 ipseclog((LOG_DEBUG,
1549 "%s: No more memory.\n", __func__));
1555 newsp->req[newsp->tcount++] = isr;
1558 switch (xisr->sadb_x_ipsecrequest_proto) {
1561 case IPPROTO_IPCOMP:
1564 ipseclog((LOG_DEBUG,
1565 "%s: invalid proto type=%u\n", __func__,
1566 xisr->sadb_x_ipsecrequest_proto));
1568 *error = EPROTONOSUPPORT;
1572 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1574 switch (xisr->sadb_x_ipsecrequest_mode) {
1575 case IPSEC_MODE_TRANSPORT:
1576 case IPSEC_MODE_TUNNEL:
1578 case IPSEC_MODE_ANY:
1580 ipseclog((LOG_DEBUG,
1581 "%s: invalid mode=%u\n", __func__,
1582 xisr->sadb_x_ipsecrequest_mode));
1587 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1589 switch (xisr->sadb_x_ipsecrequest_level) {
1590 case IPSEC_LEVEL_DEFAULT:
1591 case IPSEC_LEVEL_USE:
1592 case IPSEC_LEVEL_REQUIRE:
1594 case IPSEC_LEVEL_UNIQUE:
1595 /* validity check */
1597 * If range violation of reqid, kernel will
1598 * update it, don't refuse it.
1600 if (xisr->sadb_x_ipsecrequest_reqid
1601 > IPSEC_MANUAL_REQID_MAX) {
1602 ipseclog((LOG_DEBUG,
1603 "%s: reqid=%d range "
1604 "violation, updated by kernel.\n",
1606 xisr->sadb_x_ipsecrequest_reqid));
1607 xisr->sadb_x_ipsecrequest_reqid = 0;
1610 /* allocate new reqid id if reqid is zero. */
1611 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1613 if ((reqid = key_newreqid()) == 0) {
1618 isr->saidx.reqid = reqid;
1619 xisr->sadb_x_ipsecrequest_reqid = reqid;
1621 /* set it for manual keying. */
1623 xisr->sadb_x_ipsecrequest_reqid;
1628 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1630 xisr->sadb_x_ipsecrequest_level));
1635 isr->level = xisr->sadb_x_ipsecrequest_level;
1637 /* set IP addresses if there */
1638 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1639 struct sockaddr *paddr;
1641 len = tlen - sizeof(*xisr);
1642 paddr = (struct sockaddr *)(xisr + 1);
1643 /* validity check */
1644 if (len < sizeof(struct sockaddr) ||
1645 len < 2 * paddr->sa_len ||
1646 paddr->sa_len > sizeof(isr->saidx.src)) {
1647 ipseclog((LOG_DEBUG, "%s: invalid "
1648 "request address length.\n",
1655 * Request length should be enough to keep
1656 * source and destination addresses.
1658 if (xisr->sadb_x_ipsecrequest_len <
1659 sizeof(*xisr) + 2 * paddr->sa_len) {
1660 ipseclog((LOG_DEBUG, "%s: invalid "
1661 "ipsecrequest length.\n",
1667 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1668 paddr = (struct sockaddr *)((caddr_t)paddr +
1671 /* validity check */
1672 if (paddr->sa_len !=
1673 isr->saidx.src.sa.sa_len) {
1674 ipseclog((LOG_DEBUG, "%s: invalid "
1675 "request address length.\n",
1681 /* AF family should match */
1682 if (paddr->sa_family !=
1683 isr->saidx.src.sa.sa_family) {
1684 ipseclog((LOG_DEBUG, "%s: address "
1685 "family doesn't match.\n",
1691 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1694 * Addresses for TUNNEL mode requests are
1697 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1698 ipseclog((LOG_DEBUG, "%s: missing "
1699 "request addresses.\n", __func__));
1705 tlen -= xisr->sadb_x_ipsecrequest_len;
1707 /* validity check */
1709 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1716 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1717 + xisr->sadb_x_ipsecrequest_len);
1719 /* XXXAE: LARVAL SP */
1720 if (newsp->tcount < 1) {
1721 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1722 "not found.\n", __func__));
1730 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1743 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1745 if (auto_reqid == ~0)
1746 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1750 /* XXX should be unique check */
1751 return (auto_reqid);
1755 * copy secpolicy struct to sadb_x_policy structure indicated.
1757 static struct mbuf *
1758 key_sp2mbuf(struct secpolicy *sp)
1763 tlen = key_getspreqmsglen(sp);
1764 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1769 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1777 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1779 struct sadb_x_ipsecrequest *xisr;
1780 struct sadb_x_policy *xpl;
1781 struct ipsecrequest *isr;
1786 IPSEC_ASSERT(sp != NULL, ("null policy"));
1788 xlen = sizeof(*xpl);
1793 bzero(request, *len);
1794 xpl = (struct sadb_x_policy *)request;
1795 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1796 xpl->sadb_x_policy_type = sp->policy;
1797 xpl->sadb_x_policy_dir = sp->spidx.dir;
1798 xpl->sadb_x_policy_id = sp->id;
1799 xpl->sadb_x_policy_priority = sp->priority;
1800 switch (sp->state) {
1801 case IPSEC_SPSTATE_IFNET:
1802 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1804 case IPSEC_SPSTATE_PCB:
1805 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1808 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1811 /* if is the policy for ipsec ? */
1812 if (sp->policy == IPSEC_POLICY_IPSEC) {
1813 p = (caddr_t)xpl + sizeof(*xpl);
1814 for (i = 0; i < sp->tcount; i++) {
1816 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1817 isr->saidx.src.sa.sa_len +
1818 isr->saidx.dst.sa.sa_len);
1822 /* Calculate needed size */
1825 xisr = (struct sadb_x_ipsecrequest *)p;
1826 xisr->sadb_x_ipsecrequest_len = ilen;
1827 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1828 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1829 xisr->sadb_x_ipsecrequest_level = isr->level;
1830 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1833 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1834 p += isr->saidx.src.sa.sa_len;
1835 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1836 p += isr->saidx.dst.sa.sa_len;
1839 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1843 *len = sizeof(*xpl);
1847 /* m will not be freed nor modified */
1848 static struct mbuf *
1849 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1850 int ndeep, int nitem, ...)
1855 struct mbuf *result = NULL, *n;
1858 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1859 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1861 va_start(ap, nitem);
1862 for (i = 0; i < nitem; i++) {
1863 idx = va_arg(ap, int);
1864 if (idx < 0 || idx > SADB_EXT_MAX)
1866 /* don't attempt to pull empty extension */
1867 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1869 if (idx != SADB_EXT_RESERVED &&
1870 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1873 if (idx == SADB_EXT_RESERVED) {
1874 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1876 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1878 MGETHDR(n, M_NOWAIT, MT_DATA);
1883 m_copydata(m, 0, sizeof(struct sadb_msg),
1885 } else if (i < ndeep) {
1886 len = mhp->extlen[idx];
1887 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1892 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1895 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1908 if ((result->m_flags & M_PKTHDR) != 0) {
1909 result->m_pkthdr.len = 0;
1910 for (n = result; n; n = n->m_next)
1911 result->m_pkthdr.len += n->m_len;
1923 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1924 * add an entry to SP database, when received
1925 * <base, address(SD), (lifetime(H),) policy>
1927 * Adding to SP database,
1929 * <base, address(SD), (lifetime(H),) policy>
1930 * to the socket which was send.
1932 * SPDADD set a unique policy entry.
1933 * SPDSETIDX like SPDADD without a part of policy requests.
1934 * SPDUPDATE replace a unique policy entry.
1936 * XXXAE: serialize this in PF_KEY to avoid races.
1937 * m will always be freed.
1940 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1942 struct secpolicyindex spidx;
1943 struct sadb_address *src0, *dst0;
1944 struct sadb_x_policy *xpl0, *xpl;
1945 struct sadb_lifetime *lft = NULL;
1946 struct secpolicy *newsp;
1949 IPSEC_ASSERT(so != NULL, ("null socket"));
1950 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1951 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1952 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1954 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1955 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1956 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1957 ipseclog((LOG_DEBUG,
1958 "%s: invalid message: missing required header.\n",
1960 return key_senderror(so, m, EINVAL);
1962 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1963 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1964 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1965 ipseclog((LOG_DEBUG,
1966 "%s: invalid message: wrong header size.\n", __func__));
1967 return key_senderror(so, m, EINVAL);
1969 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1970 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1971 ipseclog((LOG_DEBUG,
1972 "%s: invalid message: wrong header size.\n",
1974 return key_senderror(so, m, EINVAL);
1976 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1979 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1980 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1981 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1983 /* check the direciton */
1984 switch (xpl0->sadb_x_policy_dir) {
1985 case IPSEC_DIR_INBOUND:
1986 case IPSEC_DIR_OUTBOUND:
1989 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
1990 return key_senderror(so, m, EINVAL);
1992 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
1993 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
1994 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
1995 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
1996 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1997 return key_senderror(so, m, EINVAL);
2000 /* policy requests are mandatory when action is ipsec. */
2001 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
2002 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2003 ipseclog((LOG_DEBUG,
2004 "%s: policy requests required.\n", __func__));
2005 return key_senderror(so, m, EINVAL);
2008 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
2009 (struct sockaddr *)(dst0 + 1));
2011 src0->sadb_address_proto != dst0->sadb_address_proto) {
2012 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2013 return key_senderror(so, m, error);
2016 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2019 src0->sadb_address_prefixlen,
2020 dst0->sadb_address_prefixlen,
2021 src0->sadb_address_proto,
2023 /* Checking there is SP already or not. */
2024 newsp = key_getsp(&spidx);
2025 if (newsp != NULL) {
2026 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2028 printf("%s: unlink SP(%p) for SPDUPDATE\n",
2030 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2035 ipseclog((LOG_DEBUG,
2036 "%s: a SP entry exists already.\n", __func__));
2037 return (key_senderror(so, m, EEXIST));
2041 /* allocate new SP entry */
2042 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2043 return key_senderror(so, m, error);
2046 newsp->lastused = newsp->created = time_second;
2047 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
2048 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
2049 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
2051 /* XXXAE: there is race between key_getsp() and key_insertsp() */
2053 if ((newsp->id = key_getnewspid()) == 0) {
2056 return key_senderror(so, m, ENOBUFS);
2058 key_insertsp(newsp);
2060 if (SPDCACHE_ENABLED())
2064 printf("%s: SP(%p)\n", __func__, newsp));
2065 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2068 struct mbuf *n, *mpolicy;
2069 struct sadb_msg *newmsg;
2072 /* create new sadb_msg to reply. */
2074 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
2075 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
2076 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2078 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
2080 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2083 return key_senderror(so, m, ENOBUFS);
2085 if (n->m_len < sizeof(*newmsg)) {
2086 n = m_pullup(n, sizeof(*newmsg));
2088 return key_senderror(so, m, ENOBUFS);
2090 newmsg = mtod(n, struct sadb_msg *);
2091 newmsg->sadb_msg_errno = 0;
2092 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2095 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2096 sizeof(*xpl), &off);
2097 if (mpolicy == NULL) {
2098 /* n is already freed */
2099 return key_senderror(so, m, ENOBUFS);
2101 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
2102 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2104 return key_senderror(so, m, EINVAL);
2106 xpl->sadb_x_policy_id = newsp->id;
2109 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2114 * get new policy id.
2120 key_getnewspid(void)
2122 struct secpolicy *sp;
2124 int count = V_key_spi_trycnt; /* XXX */
2126 SPTREE_WLOCK_ASSERT();
2128 if (V_policy_id == ~0) /* overflowed */
2129 newid = V_policy_id = 1;
2131 newid = ++V_policy_id;
2132 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2133 if (sp->id == newid)
2139 if (count == 0 || newid == 0) {
2140 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2148 * SADB_SPDDELETE processing
2150 * <base, address(SD), policy(*)>
2151 * from the user(?), and set SADB_SASTATE_DEAD,
2153 * <base, address(SD), policy(*)>
2155 * policy(*) including direction of policy.
2157 * m will always be freed.
2160 key_spddelete(struct socket *so, struct mbuf *m,
2161 const struct sadb_msghdr *mhp)
2163 struct secpolicyindex spidx;
2164 struct sadb_address *src0, *dst0;
2165 struct sadb_x_policy *xpl0;
2166 struct secpolicy *sp;
2168 IPSEC_ASSERT(so != NULL, ("null so"));
2169 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2170 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2171 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2173 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2174 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2175 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2176 ipseclog((LOG_DEBUG,
2177 "%s: invalid message: missing required header.\n",
2179 return key_senderror(so, m, EINVAL);
2181 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2182 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2183 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2184 ipseclog((LOG_DEBUG,
2185 "%s: invalid message: wrong header size.\n", __func__));
2186 return key_senderror(so, m, EINVAL);
2189 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2190 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2191 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2193 /* check the direciton */
2194 switch (xpl0->sadb_x_policy_dir) {
2195 case IPSEC_DIR_INBOUND:
2196 case IPSEC_DIR_OUTBOUND:
2199 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2200 return key_senderror(so, m, EINVAL);
2202 /* Only DISCARD, NONE and IPSEC are allowed */
2203 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2204 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2205 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2206 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2207 return key_senderror(so, m, EINVAL);
2209 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2210 (struct sockaddr *)(dst0 + 1)) != 0 ||
2211 src0->sadb_address_proto != dst0->sadb_address_proto) {
2212 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2213 return key_senderror(so, m, EINVAL);
2216 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2219 src0->sadb_address_prefixlen,
2220 dst0->sadb_address_prefixlen,
2221 src0->sadb_address_proto,
2224 /* Is there SP in SPD ? */
2225 if ((sp = key_getsp(&spidx)) == NULL) {
2226 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2227 return key_senderror(so, m, EINVAL);
2230 /* save policy id to buffer to be returned. */
2231 xpl0->sadb_x_policy_id = sp->id;
2234 printf("%s: SP(%p)\n", __func__, sp));
2235 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2241 struct sadb_msg *newmsg;
2243 /* create new sadb_msg to reply. */
2244 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2245 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2247 return key_senderror(so, m, ENOBUFS);
2249 newmsg = mtod(n, struct sadb_msg *);
2250 newmsg->sadb_msg_errno = 0;
2251 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2254 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2259 * SADB_SPDDELETE2 processing
2262 * from the user(?), and set SADB_SASTATE_DEAD,
2266 * policy(*) including direction of policy.
2268 * m will always be freed.
2271 key_spddelete2(struct socket *so, struct mbuf *m,
2272 const struct sadb_msghdr *mhp)
2274 struct secpolicy *sp;
2277 IPSEC_ASSERT(so != NULL, ("null socket"));
2278 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2279 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2280 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2282 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2283 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2284 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2286 return key_senderror(so, m, EINVAL);
2289 id = ((struct sadb_x_policy *)
2290 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2292 /* Is there SP in SPD ? */
2293 if ((sp = key_getspbyid(id)) == NULL) {
2294 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2296 return key_senderror(so, m, EINVAL);
2300 printf("%s: SP(%p)\n", __func__, sp));
2301 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2303 if (sp->state != IPSEC_SPSTATE_DEAD) {
2304 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2307 return (key_senderror(so, m, EACCES));
2312 struct mbuf *n, *nn;
2313 struct sadb_msg *newmsg;
2316 /* create new sadb_msg to reply. */
2317 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2319 MGETHDR(n, M_NOWAIT, MT_DATA);
2320 if (n && len > MHLEN) {
2321 if (!(MCLGET(n, M_NOWAIT))) {
2327 return key_senderror(so, m, ENOBUFS);
2333 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2334 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2336 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2339 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2340 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2343 return key_senderror(so, m, ENOBUFS);
2346 n->m_pkthdr.len = 0;
2347 for (nn = n; nn; nn = nn->m_next)
2348 n->m_pkthdr.len += nn->m_len;
2350 newmsg = mtod(n, struct sadb_msg *);
2351 newmsg->sadb_msg_errno = 0;
2352 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2355 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2360 * SADB_X_SPDGET processing
2365 * <base, address(SD), policy>
2367 * policy(*) including direction of policy.
2369 * m will always be freed.
2372 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2374 struct secpolicy *sp;
2378 IPSEC_ASSERT(so != NULL, ("null socket"));
2379 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2380 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2381 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2383 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2384 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2385 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2387 return key_senderror(so, m, EINVAL);
2390 id = ((struct sadb_x_policy *)
2391 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2393 /* Is there SP in SPD ? */
2394 if ((sp = key_getspbyid(id)) == NULL) {
2395 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2397 return key_senderror(so, m, ENOENT);
2400 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2401 mhp->msg->sadb_msg_pid);
2405 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2407 return key_senderror(so, m, ENOBUFS);
2411 * SADB_X_SPDACQUIRE processing.
2412 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2415 * to KMD, and expect to receive
2416 * <base> with SADB_X_SPDACQUIRE if error occurred,
2419 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2420 * policy(*) is without policy requests.
2423 * others: error number
2426 key_spdacquire(struct secpolicy *sp)
2428 struct mbuf *result = NULL, *m;
2429 struct secspacq *newspacq;
2431 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2432 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2433 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2434 ("policy not IPSEC %u", sp->policy));
2436 /* Get an entry to check whether sent message or not. */
2437 newspacq = key_getspacq(&sp->spidx);
2438 if (newspacq != NULL) {
2439 if (V_key_blockacq_count < newspacq->count) {
2440 /* reset counter and do send message. */
2441 newspacq->count = 0;
2443 /* increment counter and do nothing. */
2450 /* make new entry for blocking to send SADB_ACQUIRE. */
2451 newspacq = key_newspacq(&sp->spidx);
2452 if (newspacq == NULL)
2456 /* create new sadb_msg to reply. */
2457 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2463 result->m_pkthdr.len = 0;
2464 for (m = result; m; m = m->m_next)
2465 result->m_pkthdr.len += m->m_len;
2467 mtod(result, struct sadb_msg *)->sadb_msg_len =
2468 PFKEY_UNIT64(result->m_pkthdr.len);
2470 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2474 * SADB_SPDFLUSH processing
2477 * from the user, and free all entries in secpctree.
2481 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2483 * m will always be freed.
2486 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2488 struct secpolicy_queue drainq;
2489 struct sadb_msg *newmsg;
2490 struct secpolicy *sp, *nextsp;
2493 IPSEC_ASSERT(so != NULL, ("null socket"));
2494 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2495 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2496 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2498 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2499 return key_senderror(so, m, EINVAL);
2501 TAILQ_INIT(&drainq);
2503 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2504 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2507 * We need to set state to DEAD for each policy to be sure,
2508 * that another thread won't try to unlink it.
2509 * Also remove SP from sphash.
2511 TAILQ_FOREACH(sp, &drainq, chain) {
2512 sp->state = IPSEC_SPSTATE_DEAD;
2513 LIST_REMOVE(sp, idhash);
2518 if (SPDCACHE_ENABLED())
2520 sp = TAILQ_FIRST(&drainq);
2521 while (sp != NULL) {
2522 nextsp = TAILQ_NEXT(sp, chain);
2527 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2528 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2529 return key_senderror(so, m, ENOBUFS);
2535 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2536 newmsg = mtod(m, struct sadb_msg *);
2537 newmsg->sadb_msg_errno = 0;
2538 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2540 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2544 key_satype2scopemask(uint8_t satype)
2547 if (satype == IPSEC_POLICYSCOPE_ANY)
2552 * SADB_SPDDUMP processing
2555 * from the user, and dump all SP leaves and send,
2560 * sadb_msg_satype is considered as mask of policy scopes.
2561 * m will always be freed.
2564 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2566 SPTREE_RLOCK_TRACKER;
2567 struct secpolicy *sp;
2572 IPSEC_ASSERT(so != NULL, ("null socket"));
2573 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2574 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2575 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2577 /* search SPD entry and get buffer size. */
2579 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2581 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2582 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2583 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2586 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2587 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2594 return key_senderror(so, m, ENOENT);
2597 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2598 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2599 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2601 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2602 mhp->msg->sadb_msg_pid);
2605 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2608 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2609 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2611 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2612 mhp->msg->sadb_msg_pid);
2615 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2625 static struct mbuf *
2626 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2629 struct mbuf *result = NULL, *m;
2630 struct seclifetime lt;
2632 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2637 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2638 &sp->spidx.src.sa, sp->spidx.prefs,
2639 sp->spidx.ul_proto);
2644 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2645 &sp->spidx.dst.sa, sp->spidx.prefd,
2646 sp->spidx.ul_proto);
2651 m = key_sp2mbuf(sp);
2657 lt.addtime=sp->created;
2658 lt.usetime= sp->lastused;
2659 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2664 lt.addtime=sp->lifetime;
2665 lt.usetime= sp->validtime;
2666 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2672 if ((result->m_flags & M_PKTHDR) == 0)
2675 if (result->m_len < sizeof(struct sadb_msg)) {
2676 result = m_pullup(result, sizeof(struct sadb_msg));
2681 result->m_pkthdr.len = 0;
2682 for (m = result; m; m = m->m_next)
2683 result->m_pkthdr.len += m->m_len;
2685 mtod(result, struct sadb_msg *)->sadb_msg_len =
2686 PFKEY_UNIT64(result->m_pkthdr.len);
2695 * get PFKEY message length for security policy and request.
2698 key_getspreqmsglen(struct secpolicy *sp)
2703 tlen = sizeof(struct sadb_x_policy);
2704 /* if is the policy for ipsec ? */
2705 if (sp->policy != IPSEC_POLICY_IPSEC)
2708 /* get length of ipsec requests */
2709 for (i = 0; i < sp->tcount; i++) {
2710 len = sizeof(struct sadb_x_ipsecrequest)
2711 + sp->req[i]->saidx.src.sa.sa_len
2712 + sp->req[i]->saidx.dst.sa.sa_len;
2714 tlen += PFKEY_ALIGN8(len);
2720 * SADB_SPDEXPIRE processing
2722 * <base, address(SD), lifetime(CH), policy>
2726 * others : error number
2729 key_spdexpire(struct secpolicy *sp)
2731 struct sadb_lifetime *lt;
2732 struct mbuf *result = NULL, *m;
2733 int len, error = -1;
2735 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2738 printf("%s: SP(%p)\n", __func__, sp));
2739 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2741 /* set msg header */
2742 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2749 /* create lifetime extension (current and hard) */
2750 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2751 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2758 bzero(mtod(m, caddr_t), len);
2759 lt = mtod(m, struct sadb_lifetime *);
2760 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2761 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2762 lt->sadb_lifetime_allocations = 0;
2763 lt->sadb_lifetime_bytes = 0;
2764 lt->sadb_lifetime_addtime = sp->created;
2765 lt->sadb_lifetime_usetime = sp->lastused;
2766 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2767 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2768 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2769 lt->sadb_lifetime_allocations = 0;
2770 lt->sadb_lifetime_bytes = 0;
2771 lt->sadb_lifetime_addtime = sp->lifetime;
2772 lt->sadb_lifetime_usetime = sp->validtime;
2775 /* set sadb_address for source */
2776 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2778 sp->spidx.prefs, sp->spidx.ul_proto);
2785 /* set sadb_address for destination */
2786 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2788 sp->spidx.prefd, sp->spidx.ul_proto);
2796 m = key_sp2mbuf(sp);
2803 if ((result->m_flags & M_PKTHDR) == 0) {
2808 if (result->m_len < sizeof(struct sadb_msg)) {
2809 result = m_pullup(result, sizeof(struct sadb_msg));
2810 if (result == NULL) {
2816 result->m_pkthdr.len = 0;
2817 for (m = result; m; m = m->m_next)
2818 result->m_pkthdr.len += m->m_len;
2820 mtod(result, struct sadb_msg *)->sadb_msg_len =
2821 PFKEY_UNIT64(result->m_pkthdr.len);
2823 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2831 /* %%% SAD management */
2833 * allocating and initialize new SA head.
2834 * OUT: NULL : failure due to the lack of memory.
2835 * others : pointer to new SA head.
2837 static struct secashead *
2838 key_newsah(struct secasindex *saidx)
2840 struct secashead *sah;
2842 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2845 PFKEYSTAT_INC(in_nomem);
2848 TAILQ_INIT(&sah->savtree_larval);
2849 TAILQ_INIT(&sah->savtree_alive);
2850 sah->saidx = *saidx;
2851 sah->state = SADB_SASTATE_DEAD;
2855 printf("%s: SAH(%p)\n", __func__, sah));
2856 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2861 key_freesah(struct secashead **psah)
2863 struct secashead *sah = *psah;
2865 if (SAH_DELREF(sah) == 0)
2869 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2870 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2877 key_delsah(struct secashead *sah)
2879 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2880 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2881 ("Attempt to free non DEAD SAH %p", sah));
2882 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2883 ("Attempt to free SAH %p with LARVAL SA", sah));
2884 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2885 ("Attempt to free SAH %p with ALIVE SA", sah));
2887 free(sah, M_IPSEC_SAH);
2891 * allocating a new SA for key_add() and key_getspi() call,
2892 * and copy the values of mhp into new buffer.
2893 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2894 * For SADB_ADD create and initialize SA with MATURE state.
2896 * others : pointer to new secasvar.
2898 static struct secasvar *
2899 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2900 uint32_t spi, int *errp)
2902 struct secashead *sah;
2903 struct secasvar *sav;
2906 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2907 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2908 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2909 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2913 /* check SPI value */
2914 switch (saidx->proto) {
2918 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2919 * 1-255 reserved by IANA for future use,
2920 * 0 for implementation specific, local use.
2922 if (ntohl(spi) <= 255) {
2923 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2924 __func__, ntohl(spi)));
2931 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2936 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2938 if (sav->lock == NULL) {
2942 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2943 sav->lft_c = uma_zalloc_pcpu(V_key_lft_zone, M_NOWAIT);
2944 if (sav->lft_c == NULL) {
2948 counter_u64_zero(sav->lft_c_allocations);
2949 counter_u64_zero(sav->lft_c_bytes);
2952 sav->seq = mhp->msg->sadb_msg_seq;
2953 sav->state = SADB_SASTATE_LARVAL;
2954 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2957 sah = key_getsah(saidx);
2959 /* create a new SA index */
2960 sah = key_newsah(saidx);
2962 ipseclog((LOG_DEBUG,
2963 "%s: No more memory.\n", __func__));
2972 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2973 sav->created = time_second;
2974 } else if (sav->state == SADB_SASTATE_LARVAL) {
2976 * Do not call key_setsaval() second time in case
2977 * of `goto again`. We will have MATURE state.
2979 *errp = key_setsaval(sav, mhp);
2982 sav->state = SADB_SASTATE_MATURE;
2987 * Check that existing SAH wasn't unlinked.
2988 * Since we didn't hold the SAHTREE lock, it is possible,
2989 * that callout handler or key_flush() or key_delete() could
2992 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
2994 key_freesah(&sah); /* reference from key_getsah() */
2999 * Add new SAH into SADB.
3001 * XXXAE: we can serialize key_add and key_getspi calls, so
3002 * several threads will not fight in the race.
3003 * Otherwise we should check under SAHTREE lock, that this
3004 * SAH would not added twice.
3006 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
3007 /* Add new SAH into hash by addresses */
3008 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
3009 /* Now we are linked in the chain */
3010 sah->state = SADB_SASTATE_MATURE;
3012 * SAV references this new SAH.
3013 * In case of existing SAH we reuse reference
3014 * from key_getsah().
3018 /* Link SAV with SAH */
3019 if (sav->state == SADB_SASTATE_MATURE)
3020 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
3022 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
3023 /* Add SAV into SPI hash */
3024 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
3026 *errp = 0; /* success */
3030 if (sav->lock != NULL) {
3031 mtx_destroy(sav->lock);
3032 free(sav->lock, M_IPSEC_MISC);
3034 if (sav->lft_c != NULL)
3035 uma_zfree_pcpu(V_key_lft_zone, sav->lft_c);
3036 free(sav, M_IPSEC_SA), sav = NULL;
3040 if (*errp == ENOBUFS) {
3041 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3043 PFKEYSTAT_INC(in_nomem);
3050 * free() SA variable entry.
3053 key_cleansav(struct secasvar *sav)
3056 if (sav->natt != NULL) {
3057 free(sav->natt, M_IPSEC_MISC);
3060 if (sav->flags & SADB_X_EXT_F_CLONED)
3063 * Cleanup xform state. Note that zeroize'ing causes the
3064 * keys to be cleared; otherwise we must do it ourself.
3066 if (sav->tdb_xform != NULL) {
3067 sav->tdb_xform->xf_zeroize(sav);
3068 sav->tdb_xform = NULL;
3070 if (sav->key_auth != NULL)
3071 bzero(sav->key_auth->key_data, _KEYLEN(sav->key_auth));
3072 if (sav->key_enc != NULL)
3073 bzero(sav->key_enc->key_data, _KEYLEN(sav->key_enc));
3075 if (sav->key_auth != NULL) {
3076 if (sav->key_auth->key_data != NULL)
3077 free(sav->key_auth->key_data, M_IPSEC_MISC);
3078 free(sav->key_auth, M_IPSEC_MISC);
3079 sav->key_auth = NULL;
3081 if (sav->key_enc != NULL) {
3082 if (sav->key_enc->key_data != NULL)
3083 free(sav->key_enc->key_data, M_IPSEC_MISC);
3084 free(sav->key_enc, M_IPSEC_MISC);
3085 sav->key_enc = NULL;
3087 if (sav->replay != NULL) {
3088 if (sav->replay->bitmap != NULL)
3089 free(sav->replay->bitmap, M_IPSEC_MISC);
3090 free(sav->replay, M_IPSEC_MISC);
3093 if (sav->lft_h != NULL) {
3094 free(sav->lft_h, M_IPSEC_MISC);
3097 if (sav->lft_s != NULL) {
3098 free(sav->lft_s, M_IPSEC_MISC);
3104 * free() SA variable entry.
3107 key_delsav(struct secasvar *sav)
3109 IPSEC_ASSERT(sav != NULL, ("null sav"));
3110 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
3111 ("attempt to free non DEAD SA %p", sav));
3112 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
3116 * SA must be unlinked from the chain and hashtbl.
3117 * If SA was cloned, we leave all fields untouched,
3118 * except NAT-T config.
3121 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
3122 mtx_destroy(sav->lock);
3123 free(sav->lock, M_IPSEC_MISC);
3124 uma_zfree_pcpu(V_key_lft_zone, sav->lft_c);
3126 free(sav, M_IPSEC_SA);
3133 * others : found, referenced pointer to a SAH.
3135 static struct secashead *
3136 key_getsah(struct secasindex *saidx)
3138 SAHTREE_RLOCK_TRACKER;
3139 struct secashead *sah;
3142 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3143 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3153 * Check not to be duplicated SPI.
3156 * 1 : found SA with given SPI.
3159 key_checkspidup(uint32_t spi)
3161 SAHTREE_RLOCK_TRACKER;
3162 struct secasvar *sav;
3164 /* Assume SPI is in network byte order */
3166 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3167 if (sav->spi == spi)
3171 return (sav != NULL);
3178 * others : found, referenced pointer to a SA.
3180 static struct secasvar *
3181 key_getsavbyspi(uint32_t spi)
3183 SAHTREE_RLOCK_TRACKER;
3184 struct secasvar *sav;
3186 /* Assume SPI is in network byte order */
3188 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3189 if (sav->spi != spi)
3199 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3201 struct seclifetime *lft_h, *lft_s, *tmp;
3203 /* Lifetime extension is optional, check that it is present. */
3204 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3205 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3207 * In case of SADB_UPDATE we may need to change
3208 * existing lifetimes.
3210 if (sav->state == SADB_SASTATE_MATURE) {
3211 lft_h = lft_s = NULL;
3216 /* Both HARD and SOFT extensions must present */
3217 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3218 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3219 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3220 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3221 ipseclog((LOG_DEBUG,
3222 "%s: invalid message: missing required header.\n",
3226 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3227 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3228 ipseclog((LOG_DEBUG,
3229 "%s: invalid message: wrong header size.\n", __func__));
3232 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3233 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3234 if (lft_h == NULL) {
3235 PFKEYSTAT_INC(in_nomem);
3236 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3239 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3240 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3241 if (lft_s == NULL) {
3242 PFKEYSTAT_INC(in_nomem);
3243 free(lft_h, M_IPSEC_MISC);
3244 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3248 if (sav->state != SADB_SASTATE_LARVAL) {
3250 * key_update() holds reference to this SA,
3251 * so it won't be deleted in meanwhile.
3261 SECASVAR_UNLOCK(sav);
3263 free(lft_h, M_IPSEC_MISC);
3265 free(lft_s, M_IPSEC_MISC);
3268 /* We can update lifetime without holding a lock */
3269 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3270 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3277 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3278 * You must update these if need. Expects only LARVAL SAs.
3283 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3285 const struct sadb_sa *sa0;
3286 const struct sadb_key *key0;
3291 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3292 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3293 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3294 ("Attempt to update non LARVAL SA"));
3297 error = key_setident(sav->sah, mhp);
3302 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3303 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3307 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3308 sav->alg_auth = sa0->sadb_sa_auth;
3309 sav->alg_enc = sa0->sadb_sa_encrypt;
3310 sav->flags = sa0->sadb_sa_flags;
3311 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3312 ipseclog((LOG_DEBUG,
3313 "%s: invalid sa_flags 0x%08x.\n", __func__,
3319 /* Optional replay window */
3321 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3322 replay = sa0->sadb_sa_replay;
3323 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3324 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3328 replay = ((const struct sadb_x_sa_replay *)
3329 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3331 if (replay > UINT32_MAX - 32) {
3332 ipseclog((LOG_DEBUG,
3333 "%s: replay window too big.\n", __func__));
3338 replay = (replay + 7) >> 3;
3341 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3343 if (sav->replay == NULL) {
3344 PFKEYSTAT_INC(in_nomem);
3345 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3352 /* number of 32b blocks to be allocated */
3353 uint32_t bitmap_size;
3356 * - the allocated replay window size must be
3358 * - use an extra 32b block as a redundant window.
3361 while (replay + 4 > bitmap_size)
3363 bitmap_size = bitmap_size / 4;
3365 sav->replay->bitmap = malloc(
3366 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3368 if (sav->replay->bitmap == NULL) {
3369 PFKEYSTAT_INC(in_nomem);
3370 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3375 sav->replay->bitmap_size = bitmap_size;
3376 sav->replay->wsize = replay;
3380 /* Authentication keys */
3381 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3382 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3387 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3388 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3389 switch (mhp->msg->sadb_msg_satype) {
3390 case SADB_SATYPE_AH:
3391 case SADB_SATYPE_ESP:
3392 case SADB_X_SATYPE_TCPSIGNATURE:
3393 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3394 sav->alg_auth != SADB_X_AALG_NULL)
3397 case SADB_X_SATYPE_IPCOMP:
3403 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3408 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3409 if (sav->key_auth == NULL ) {
3410 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3412 PFKEYSTAT_INC(in_nomem);
3418 /* Encryption key */
3419 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3420 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3425 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3426 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3427 switch (mhp->msg->sadb_msg_satype) {
3428 case SADB_SATYPE_ESP:
3429 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3430 sav->alg_enc != SADB_EALG_NULL) {
3434 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3435 if (sav->key_enc == NULL) {
3436 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3438 PFKEYSTAT_INC(in_nomem);
3443 case SADB_X_SATYPE_IPCOMP:
3444 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3446 sav->key_enc = NULL; /*just in case*/
3448 case SADB_SATYPE_AH:
3449 case SADB_X_SATYPE_TCPSIGNATURE:
3455 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3463 switch (mhp->msg->sadb_msg_satype) {
3464 case SADB_SATYPE_AH:
3465 if (sav->flags & SADB_X_EXT_DERIV) {
3466 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3467 "given to AH SA.\n", __func__));
3471 if (sav->alg_enc != SADB_EALG_NONE) {
3472 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3473 "mismated.\n", __func__));
3477 error = xform_init(sav, XF_AH);
3479 case SADB_SATYPE_ESP:
3480 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3481 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3482 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3483 "given to old-esp.\n", __func__));
3487 error = xform_init(sav, XF_ESP);
3489 case SADB_X_SATYPE_IPCOMP:
3490 if (sav->alg_auth != SADB_AALG_NONE) {
3491 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3492 "mismated.\n", __func__));
3496 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3497 ntohl(sav->spi) >= 0x10000) {
3498 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3503 error = xform_init(sav, XF_IPCOMP);
3505 case SADB_X_SATYPE_TCPSIGNATURE:
3506 if (sav->alg_enc != SADB_EALG_NONE) {
3507 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3508 "mismated.\n", __func__));
3512 error = xform_init(sav, XF_TCPSIGNATURE);
3515 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3516 error = EPROTONOSUPPORT;
3520 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3521 __func__, mhp->msg->sadb_msg_satype));
3525 /* Handle NAT-T headers */
3526 error = key_setnatt(sav, mhp);
3530 /* Initialize lifetime for CURRENT */
3532 sav->created = time_second;
3534 /* lifetimes for HARD and SOFT */
3535 error = key_updatelifetimes(sav, mhp);
3544 * subroutine for SADB_GET and SADB_DUMP.
3546 static struct mbuf *
3547 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3548 uint32_t seq, uint32_t pid)
3550 struct seclifetime lft_c;
3551 struct mbuf *result = NULL, *tres = NULL, *m;
3552 int i, dumporder[] = {
3553 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3554 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3555 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3556 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3557 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3558 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3559 SADB_EXT_SENSITIVITY,
3560 SADB_X_EXT_NAT_T_TYPE,
3561 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3562 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3563 SADB_X_EXT_NAT_T_FRAG,
3565 uint32_t replay_count;
3567 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3572 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3574 switch (dumporder[i]) {
3576 m = key_setsadbsa(sav);
3581 case SADB_X_EXT_SA2:
3583 replay_count = sav->replay ? sav->replay->count : 0;
3584 SECASVAR_UNLOCK(sav);
3585 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3586 sav->sah->saidx.reqid);
3591 case SADB_X_EXT_SA_REPLAY:
3592 if (sav->replay == NULL ||
3593 sav->replay->wsize <= UINT8_MAX)
3596 m = key_setsadbxsareplay(sav->replay->wsize);
3601 case SADB_EXT_ADDRESS_SRC:
3602 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3603 &sav->sah->saidx.src.sa,
3604 FULLMASK, IPSEC_ULPROTO_ANY);
3609 case SADB_EXT_ADDRESS_DST:
3610 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3611 &sav->sah->saidx.dst.sa,
3612 FULLMASK, IPSEC_ULPROTO_ANY);
3617 case SADB_EXT_KEY_AUTH:
3620 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3625 case SADB_EXT_KEY_ENCRYPT:
3628 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3633 case SADB_EXT_LIFETIME_CURRENT:
3634 lft_c.addtime = sav->created;
3635 lft_c.allocations = (uint32_t)counter_u64_fetch(
3636 sav->lft_c_allocations);
3637 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3638 lft_c.usetime = sav->firstused;
3639 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3644 case SADB_EXT_LIFETIME_HARD:
3647 m = key_setlifetime(sav->lft_h,
3648 SADB_EXT_LIFETIME_HARD);
3653 case SADB_EXT_LIFETIME_SOFT:
3656 m = key_setlifetime(sav->lft_s,
3657 SADB_EXT_LIFETIME_SOFT);
3663 case SADB_X_EXT_NAT_T_TYPE:
3664 if (sav->natt == NULL)
3666 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3671 case SADB_X_EXT_NAT_T_DPORT:
3672 if (sav->natt == NULL)
3674 m = key_setsadbxport(sav->natt->dport,
3675 SADB_X_EXT_NAT_T_DPORT);
3680 case SADB_X_EXT_NAT_T_SPORT:
3681 if (sav->natt == NULL)
3683 m = key_setsadbxport(sav->natt->sport,
3684 SADB_X_EXT_NAT_T_SPORT);
3689 case SADB_X_EXT_NAT_T_OAI:
3690 if (sav->natt == NULL ||
3691 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3693 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3694 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3698 case SADB_X_EXT_NAT_T_OAR:
3699 if (sav->natt == NULL ||
3700 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3702 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3703 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3707 case SADB_X_EXT_NAT_T_FRAG:
3708 /* We do not (yet) support those. */
3711 case SADB_EXT_ADDRESS_PROXY:
3712 case SADB_EXT_IDENTITY_SRC:
3713 case SADB_EXT_IDENTITY_DST:
3714 /* XXX: should we brought from SPD ? */
3715 case SADB_EXT_SENSITIVITY:
3727 m_cat(result, tres);
3729 if (result->m_len < sizeof(struct sadb_msg)) {
3730 result = m_pullup(result, sizeof(struct sadb_msg));
3735 result->m_pkthdr.len = 0;
3736 for (m = result; m; m = m->m_next)
3737 result->m_pkthdr.len += m->m_len;
3739 mtod(result, struct sadb_msg *)->sadb_msg_len =
3740 PFKEY_UNIT64(result->m_pkthdr.len);
3751 * set data into sadb_msg.
3753 static struct mbuf *
3754 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3755 pid_t pid, u_int16_t reserved)
3761 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3764 MGETHDR(m, M_NOWAIT, MT_DATA);
3765 if (m && len > MHLEN) {
3766 if (!(MCLGET(m, M_NOWAIT))) {
3773 m->m_pkthdr.len = m->m_len = len;
3776 p = mtod(m, struct sadb_msg *);
3779 p->sadb_msg_version = PF_KEY_V2;
3780 p->sadb_msg_type = type;
3781 p->sadb_msg_errno = 0;
3782 p->sadb_msg_satype = satype;
3783 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3784 p->sadb_msg_reserved = reserved;
3785 p->sadb_msg_seq = seq;
3786 p->sadb_msg_pid = (u_int32_t)pid;
3792 * copy secasvar data into sadb_address.
3794 static struct mbuf *
3795 key_setsadbsa(struct secasvar *sav)
3801 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3802 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3807 p = mtod(m, struct sadb_sa *);
3809 p->sadb_sa_len = PFKEY_UNIT64(len);
3810 p->sadb_sa_exttype = SADB_EXT_SA;
3811 p->sadb_sa_spi = sav->spi;
3812 p->sadb_sa_replay = sav->replay ?
3813 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3814 sav->replay->wsize): 0;
3815 p->sadb_sa_state = sav->state;
3816 p->sadb_sa_auth = sav->alg_auth;
3817 p->sadb_sa_encrypt = sav->alg_enc;
3818 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3823 * set data into sadb_address.
3825 static struct mbuf *
3826 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3827 u_int8_t prefixlen, u_int16_t ul_proto)
3830 struct sadb_address *p;
3833 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3834 PFKEY_ALIGN8(saddr->sa_len);
3835 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3840 p = mtod(m, struct sadb_address *);
3843 p->sadb_address_len = PFKEY_UNIT64(len);
3844 p->sadb_address_exttype = exttype;
3845 p->sadb_address_proto = ul_proto;
3846 if (prefixlen == FULLMASK) {
3847 switch (saddr->sa_family) {
3849 prefixlen = sizeof(struct in_addr) << 3;
3852 prefixlen = sizeof(struct in6_addr) << 3;
3858 p->sadb_address_prefixlen = prefixlen;
3859 p->sadb_address_reserved = 0;
3862 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3869 * set data into sadb_x_sa2.
3871 static struct mbuf *
3872 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3875 struct sadb_x_sa2 *p;
3878 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3879 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3884 p = mtod(m, struct sadb_x_sa2 *);
3887 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3888 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3889 p->sadb_x_sa2_mode = mode;
3890 p->sadb_x_sa2_reserved1 = 0;
3891 p->sadb_x_sa2_reserved2 = 0;
3892 p->sadb_x_sa2_sequence = seq;
3893 p->sadb_x_sa2_reqid = reqid;
3899 * Set data into sadb_x_sa_replay.
3901 static struct mbuf *
3902 key_setsadbxsareplay(u_int32_t replay)
3905 struct sadb_x_sa_replay *p;
3908 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3909 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3914 p = mtod(m, struct sadb_x_sa_replay *);
3917 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3918 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3919 p->sadb_x_sa_replay_replay = (replay << 3);
3925 * Set a type in sadb_x_nat_t_type.
3927 static struct mbuf *
3928 key_setsadbxtype(u_int16_t type)
3932 struct sadb_x_nat_t_type *p;
3934 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3936 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3941 p = mtod(m, struct sadb_x_nat_t_type *);
3944 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3945 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3946 p->sadb_x_nat_t_type_type = type;
3951 * Set a port in sadb_x_nat_t_port.
3952 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3954 static struct mbuf *
3955 key_setsadbxport(u_int16_t port, u_int16_t type)
3959 struct sadb_x_nat_t_port *p;
3961 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3963 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3968 p = mtod(m, struct sadb_x_nat_t_port *);
3971 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3972 p->sadb_x_nat_t_port_exttype = type;
3973 p->sadb_x_nat_t_port_port = port;
3979 * Get port from sockaddr. Port is in network byte order.
3982 key_portfromsaddr(struct sockaddr *sa)
3985 switch (sa->sa_family) {
3988 return ((struct sockaddr_in *)sa)->sin_port;
3992 return ((struct sockaddr_in6 *)sa)->sin6_port;
3999 * Set port in struct sockaddr. Port is in network byte order.
4002 key_porttosaddr(struct sockaddr *sa, uint16_t port)
4005 switch (sa->sa_family) {
4008 ((struct sockaddr_in *)sa)->sin_port = port;
4013 ((struct sockaddr_in6 *)sa)->sin6_port = port;
4017 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
4018 __func__, sa->sa_family));
4024 * set data into sadb_x_policy
4026 static struct mbuf *
4027 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
4030 struct sadb_x_policy *p;
4033 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
4034 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
4039 p = mtod(m, struct sadb_x_policy *);
4042 p->sadb_x_policy_len = PFKEY_UNIT64(len);
4043 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
4044 p->sadb_x_policy_type = type;
4045 p->sadb_x_policy_dir = dir;
4046 p->sadb_x_policy_id = id;
4047 p->sadb_x_policy_priority = priority;
4053 /* Take a key message (sadb_key) from the socket and turn it into one
4054 * of the kernel's key structures (seckey).
4056 * IN: pointer to the src
4057 * OUT: NULL no more memory
4060 key_dup_keymsg(const struct sadb_key *src, size_t len,
4061 struct malloc_type *type)
4065 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4067 dst->bits = src->sadb_key_bits;
4068 dst->key_data = malloc(len, type, M_NOWAIT);
4069 if (dst->key_data != NULL) {
4070 bcopy((const char *)(src + 1), dst->key_data, len);
4072 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4078 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4085 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
4086 * turn it into one of the kernel's lifetime structures (seclifetime).
4088 * IN: pointer to the destination, source and malloc type
4089 * OUT: NULL, no more memory
4092 static struct seclifetime *
4093 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
4095 struct seclifetime *dst;
4097 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4099 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
4102 dst->allocations = src->sadb_lifetime_allocations;
4103 dst->bytes = src->sadb_lifetime_bytes;
4104 dst->addtime = src->sadb_lifetime_addtime;
4105 dst->usetime = src->sadb_lifetime_usetime;
4110 * compare two secasindex structure.
4111 * flag can specify to compare 2 saidxes.
4112 * compare two secasindex structure without both mode and reqid.
4113 * don't compare port.
4115 * saidx0: source, it can be in SAD.
4122 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4127 if (saidx0 == NULL && saidx1 == NULL)
4130 if (saidx0 == NULL || saidx1 == NULL)
4133 if (saidx0->proto != saidx1->proto)
4136 if (flag == CMP_EXACTLY) {
4137 if (saidx0->mode != saidx1->mode)
4139 if (saidx0->reqid != saidx1->reqid)
4141 if (bcmp(&saidx0->src, &saidx1->src,
4142 saidx0->src.sa.sa_len) != 0 ||
4143 bcmp(&saidx0->dst, &saidx1->dst,
4144 saidx0->dst.sa.sa_len) != 0)
4148 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4149 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4151 * If reqid of SPD is non-zero, unique SA is required.
4152 * The result must be of same reqid in this case.
4154 if (saidx1->reqid != 0 &&
4155 saidx0->reqid != saidx1->reqid)
4159 if (flag == CMP_MODE_REQID) {
4160 if (saidx0->mode != IPSEC_MODE_ANY
4161 && saidx0->mode != saidx1->mode)
4165 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4167 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4175 * compare two secindex structure exactly.
4177 * spidx0: source, it is often in SPD.
4178 * spidx1: object, it is often from PFKEY message.
4184 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4185 struct secpolicyindex *spidx1)
4188 if (spidx0 == NULL && spidx1 == NULL)
4191 if (spidx0 == NULL || spidx1 == NULL)
4194 if (spidx0->prefs != spidx1->prefs
4195 || spidx0->prefd != spidx1->prefd
4196 || spidx0->ul_proto != spidx1->ul_proto
4197 || spidx0->dir != spidx1->dir)
4200 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4201 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4205 * compare two secindex structure with mask.
4207 * spidx0: source, it is often in SPD.
4208 * spidx1: object, it is often from IP header.
4214 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4215 struct secpolicyindex *spidx1)
4218 if (spidx0 == NULL && spidx1 == NULL)
4221 if (spidx0 == NULL || spidx1 == NULL)
4224 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4225 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4226 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4227 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4230 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4231 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4232 && spidx0->ul_proto != spidx1->ul_proto)
4235 switch (spidx0->src.sa.sa_family) {
4237 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4238 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4240 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4241 &spidx1->src.sin.sin_addr, spidx0->prefs))
4245 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4246 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4249 * scope_id check. if sin6_scope_id is 0, we regard it
4250 * as a wildcard scope, which matches any scope zone ID.
4252 if (spidx0->src.sin6.sin6_scope_id &&
4253 spidx1->src.sin6.sin6_scope_id &&
4254 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4256 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4257 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4262 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4267 switch (spidx0->dst.sa.sa_family) {
4269 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4270 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4272 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4273 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4277 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4278 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4281 * scope_id check. if sin6_scope_id is 0, we regard it
4282 * as a wildcard scope, which matches any scope zone ID.
4284 if (spidx0->dst.sin6.sin6_scope_id &&
4285 spidx1->dst.sin6.sin6_scope_id &&
4286 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4288 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4289 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4294 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4299 /* XXX Do we check other field ? e.g. flowinfo */
4307 #define satosin(s) ((const struct sockaddr_in *)s)
4311 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4312 /* returns 0 on match */
4314 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4317 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4320 switch (sa1->sa_family) {
4323 if (sa1->sa_len != sizeof(struct sockaddr_in))
4325 if (satosin(sa1)->sin_addr.s_addr !=
4326 satosin(sa2)->sin_addr.s_addr) {
4329 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4335 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4336 return 1; /*EINVAL*/
4337 if (satosin6(sa1)->sin6_scope_id !=
4338 satosin6(sa2)->sin6_scope_id) {
4341 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4342 &satosin6(sa2)->sin6_addr)) {
4346 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4352 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4360 /* returns 0 on match */
4362 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4363 const struct sockaddr *sa2, size_t mask)
4365 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4368 switch (sa1->sa_family) {
4371 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4372 &satosin(sa2)->sin_addr, mask));
4376 if (satosin6(sa1)->sin6_scope_id !=
4377 satosin6(sa2)->sin6_scope_id)
4379 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4380 &satosin6(sa2)->sin6_addr, mask));
4389 * compare two buffers with mask.
4393 * bits: Number of bits to compare
4399 key_bbcmp(const void *a1, const void *a2, u_int bits)
4401 const unsigned char *p1 = a1;
4402 const unsigned char *p2 = a2;
4404 /* XXX: This could be considerably faster if we compare a word
4405 * at a time, but it is complicated on LSB Endian machines */
4407 /* Handle null pointers */
4408 if (p1 == NULL || p2 == NULL)
4418 u_int8_t mask = ~((1<<(8-bits))-1);
4419 if ((*p1 & mask) != (*p2 & mask))
4422 return 1; /* Match! */
4426 key_flush_spd(time_t now)
4428 SPTREE_RLOCK_TRACKER;
4429 struct secpolicy_list drainq;
4430 struct secpolicy *sp, *nextsp;
4435 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4436 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4437 if (sp->lifetime == 0 && sp->validtime == 0)
4439 if ((sp->lifetime &&
4440 now - sp->created > sp->lifetime) ||
4442 now - sp->lastused > sp->validtime)) {
4443 /* Hold extra reference to send SPDEXPIRE */
4445 LIST_INSERT_HEAD(&drainq, sp, drainq);
4450 if (LIST_EMPTY(&drainq))
4454 sp = LIST_FIRST(&drainq);
4455 while (sp != NULL) {
4456 nextsp = LIST_NEXT(sp, drainq);
4457 /* Check that SP is still linked */
4458 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4459 LIST_REMOVE(sp, drainq);
4460 key_freesp(&sp); /* release extra reference */
4464 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4466 LIST_REMOVE(sp, idhash);
4467 sp->state = IPSEC_SPSTATE_DEAD;
4472 if (SPDCACHE_ENABLED())
4475 sp = LIST_FIRST(&drainq);
4476 while (sp != NULL) {
4477 nextsp = LIST_NEXT(sp, drainq);
4479 key_freesp(&sp); /* release extra reference */
4480 key_freesp(&sp); /* release last reference */
4486 key_flush_sad(time_t now)
4488 SAHTREE_RLOCK_TRACKER;
4489 struct secashead_list emptyq;
4490 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4491 struct secashead *sah, *nextsah;
4492 struct secasvar *sav, *nextsav;
4495 LIST_INIT(&hexpireq);
4496 LIST_INIT(&sexpireq);
4500 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4501 /* Check for empty SAH */
4502 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4503 TAILQ_EMPTY(&sah->savtree_alive)) {
4505 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4508 /* Add all stale LARVAL SAs into drainq */
4509 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4510 if (now - sav->created < V_key_larval_lifetime)
4513 LIST_INSERT_HEAD(&drainq, sav, drainq);
4515 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4516 /* lifetimes aren't specified */
4517 if (sav->lft_h == NULL)
4521 * Check again with lock held, because it may
4522 * be updated by SADB_UPDATE.
4524 if (sav->lft_h == NULL) {
4525 SECASVAR_UNLOCK(sav);
4530 * HARD lifetimes MUST take precedence over SOFT
4531 * lifetimes, meaning if the HARD and SOFT lifetimes
4532 * are the same, the HARD lifetime will appear on the
4535 /* check HARD lifetime */
4536 if ((sav->lft_h->addtime != 0 &&
4537 now - sav->created > sav->lft_h->addtime) ||
4538 (sav->lft_h->usetime != 0 && sav->firstused &&
4539 now - sav->firstused > sav->lft_h->usetime) ||
4540 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4541 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4542 SECASVAR_UNLOCK(sav);
4544 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4547 /* check SOFT lifetime (only for MATURE SAs) */
4548 if (sav->state == SADB_SASTATE_MATURE && (
4549 (sav->lft_s->addtime != 0 &&
4550 now - sav->created > sav->lft_s->addtime) ||
4551 (sav->lft_s->usetime != 0 && sav->firstused &&
4552 now - sav->firstused > sav->lft_s->usetime) ||
4553 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4554 sav->lft_c_bytes) > sav->lft_s->bytes))) {
4555 SECASVAR_UNLOCK(sav);
4557 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4560 SECASVAR_UNLOCK(sav);
4565 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4566 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4571 /* Unlink stale LARVAL SAs */
4572 sav = LIST_FIRST(&drainq);
4573 while (sav != NULL) {
4574 nextsav = LIST_NEXT(sav, drainq);
4575 /* Check that SA is still LARVAL */
4576 if (sav->state != SADB_SASTATE_LARVAL) {
4577 LIST_REMOVE(sav, drainq);
4578 LIST_INSERT_HEAD(&freeq, sav, drainq);
4582 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4583 LIST_REMOVE(sav, spihash);
4584 sav->state = SADB_SASTATE_DEAD;
4587 /* Unlink all SAs with expired HARD lifetime */
4588 sav = LIST_FIRST(&hexpireq);
4589 while (sav != NULL) {
4590 nextsav = LIST_NEXT(sav, drainq);
4591 /* Check that SA is not unlinked */
4592 if (sav->state == SADB_SASTATE_DEAD) {
4593 LIST_REMOVE(sav, drainq);
4594 LIST_INSERT_HEAD(&freeq, sav, drainq);
4598 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4599 LIST_REMOVE(sav, spihash);
4600 sav->state = SADB_SASTATE_DEAD;
4603 /* Mark all SAs with expired SOFT lifetime as DYING */
4604 sav = LIST_FIRST(&sexpireq);
4605 while (sav != NULL) {
4606 nextsav = LIST_NEXT(sav, drainq);
4607 /* Check that SA is not unlinked */
4608 if (sav->state == SADB_SASTATE_DEAD) {
4609 LIST_REMOVE(sav, drainq);
4610 LIST_INSERT_HEAD(&freeq, sav, drainq);
4615 * NOTE: this doesn't change SA order in the chain.
4617 sav->state = SADB_SASTATE_DYING;
4620 /* Unlink empty SAHs */
4621 sah = LIST_FIRST(&emptyq);
4622 while (sah != NULL) {
4623 nextsah = LIST_NEXT(sah, drainq);
4624 /* Check that SAH is still empty and not unlinked */
4625 if (sah->state == SADB_SASTATE_DEAD ||
4626 !TAILQ_EMPTY(&sah->savtree_larval) ||
4627 !TAILQ_EMPTY(&sah->savtree_alive)) {
4628 LIST_REMOVE(sah, drainq);
4629 key_freesah(&sah); /* release extra reference */
4633 TAILQ_REMOVE(&V_sahtree, sah, chain);
4634 LIST_REMOVE(sah, addrhash);
4635 sah->state = SADB_SASTATE_DEAD;
4640 /* Send SPDEXPIRE messages */
4641 sav = LIST_FIRST(&hexpireq);
4642 while (sav != NULL) {
4643 nextsav = LIST_NEXT(sav, drainq);
4645 key_freesah(&sav->sah); /* release reference from SAV */
4646 key_freesav(&sav); /* release extra reference */
4647 key_freesav(&sav); /* release last reference */
4650 sav = LIST_FIRST(&sexpireq);
4651 while (sav != NULL) {
4652 nextsav = LIST_NEXT(sav, drainq);
4654 key_freesav(&sav); /* release extra reference */
4657 /* Free stale LARVAL SAs */
4658 sav = LIST_FIRST(&drainq);
4659 while (sav != NULL) {
4660 nextsav = LIST_NEXT(sav, drainq);
4661 key_freesah(&sav->sah); /* release reference from SAV */
4662 key_freesav(&sav); /* release extra reference */
4663 key_freesav(&sav); /* release last reference */
4666 /* Free SAs that were unlinked/changed by someone else */
4667 sav = LIST_FIRST(&freeq);
4668 while (sav != NULL) {
4669 nextsav = LIST_NEXT(sav, drainq);
4670 key_freesav(&sav); /* release extra reference */
4673 /* Free empty SAH */
4674 sah = LIST_FIRST(&emptyq);
4675 while (sah != NULL) {
4676 nextsah = LIST_NEXT(sah, drainq);
4677 key_freesah(&sah); /* release extra reference */
4678 key_freesah(&sah); /* release last reference */
4684 key_flush_acq(time_t now)
4686 struct secacq *acq, *nextacq;
4690 acq = LIST_FIRST(&V_acqtree);
4691 while (acq != NULL) {
4692 nextacq = LIST_NEXT(acq, chain);
4693 if (now - acq->created > V_key_blockacq_lifetime) {
4694 LIST_REMOVE(acq, chain);
4695 LIST_REMOVE(acq, addrhash);
4696 LIST_REMOVE(acq, seqhash);
4697 free(acq, M_IPSEC_SAQ);
4705 key_flush_spacq(time_t now)
4707 struct secspacq *acq, *nextacq;
4711 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4712 nextacq = LIST_NEXT(acq, chain);
4713 if (now - acq->created > V_key_blockacq_lifetime
4714 && __LIST_CHAINED(acq)) {
4715 LIST_REMOVE(acq, chain);
4716 free(acq, M_IPSEC_SAQ);
4724 * scanning SPD and SAD to check status for each entries,
4725 * and do to remove or to expire.
4726 * XXX: year 2038 problem may remain.
4729 key_timehandler(void *arg)
4731 VNET_ITERATOR_DECL(vnet_iter);
4732 time_t now = time_second;
4734 VNET_LIST_RLOCK_NOSLEEP();
4735 VNET_FOREACH(vnet_iter) {
4736 CURVNET_SET(vnet_iter);
4740 key_flush_spacq(now);
4743 VNET_LIST_RUNLOCK_NOSLEEP();
4745 #ifndef IPSEC_DEBUG2
4746 /* do exchange to tick time !! */
4747 callout_schedule(&key_timer, hz);
4748 #endif /* IPSEC_DEBUG2 */
4756 arc4random_buf(&value, sizeof(value));
4761 * map SADB_SATYPE_* to IPPROTO_*.
4762 * if satype == SADB_SATYPE then satype is mapped to ~0.
4764 * 0: invalid satype.
4767 key_satype2proto(uint8_t satype)
4770 case SADB_SATYPE_UNSPEC:
4771 return IPSEC_PROTO_ANY;
4772 case SADB_SATYPE_AH:
4774 case SADB_SATYPE_ESP:
4776 case SADB_X_SATYPE_IPCOMP:
4777 return IPPROTO_IPCOMP;
4778 case SADB_X_SATYPE_TCPSIGNATURE:
4787 * map IPPROTO_* to SADB_SATYPE_*
4789 * 0: invalid protocol type.
4792 key_proto2satype(uint8_t proto)
4796 return SADB_SATYPE_AH;
4798 return SADB_SATYPE_ESP;
4799 case IPPROTO_IPCOMP:
4800 return SADB_X_SATYPE_IPCOMP;
4802 return SADB_X_SATYPE_TCPSIGNATURE;
4811 * SADB_GETSPI processing is to receive
4812 * <base, (SA2), src address, dst address, (SPI range)>
4813 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4814 * tree with the status of LARVAL, and send
4815 * <base, SA(*), address(SD)>
4818 * IN: mhp: pointer to the pointer to each header.
4819 * OUT: NULL if fail.
4820 * other if success, return pointer to the message to send.
4823 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4825 struct secasindex saidx;
4826 struct sadb_address *src0, *dst0;
4827 struct secasvar *sav;
4828 uint32_t reqid, spi;
4830 uint8_t mode, proto;
4832 IPSEC_ASSERT(so != NULL, ("null socket"));
4833 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4834 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4835 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4837 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4838 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4839 #ifdef PFKEY_STRICT_CHECKS
4840 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4843 ipseclog((LOG_DEBUG,
4844 "%s: invalid message: missing required header.\n",
4849 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4850 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4851 #ifdef PFKEY_STRICT_CHECKS
4852 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4855 ipseclog((LOG_DEBUG,
4856 "%s: invalid message: wrong header size.\n", __func__));
4860 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4861 mode = IPSEC_MODE_ANY;
4864 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4865 ipseclog((LOG_DEBUG,
4866 "%s: invalid message: wrong header size.\n",
4871 mode = ((struct sadb_x_sa2 *)
4872 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4873 reqid = ((struct sadb_x_sa2 *)
4874 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4877 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4878 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4880 /* map satype to proto */
4881 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4882 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4887 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4888 (struct sockaddr *)(dst0 + 1));
4890 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4894 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4896 /* SPI allocation */
4897 spi = key_do_getnewspi(
4898 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4901 * Requested SPI or SPI range is not available or
4907 sav = key_newsav(mhp, &saidx, spi, &error);
4911 if (sav->seq != 0) {
4914 * If the SADB_GETSPI message is in response to a
4915 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4916 * MUST be the same as the SADB_ACQUIRE message.
4918 * XXXAE: However it doesn't definethe behaviour how to
4919 * check this and what to do if it doesn't match.
4920 * Also what we should do if it matches?
4922 * We can compare saidx used in SADB_ACQUIRE with saidx
4923 * used in SADB_GETSPI, but this probably can break
4924 * existing software. For now just warn if it doesn't match.
4926 * XXXAE: anyway it looks useless.
4928 key_acqdone(&saidx, sav->seq);
4931 printf("%s: SA(%p)\n", __func__, sav));
4932 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4935 struct mbuf *n, *nn;
4936 struct sadb_sa *m_sa;
4937 struct sadb_msg *newmsg;
4940 /* create new sadb_msg to reply. */
4941 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4942 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4944 MGETHDR(n, M_NOWAIT, MT_DATA);
4946 if (!(MCLGET(n, M_NOWAIT))) {
4960 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
4961 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
4963 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
4964 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
4965 m_sa->sadb_sa_exttype = SADB_EXT_SA;
4966 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
4967 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
4969 IPSEC_ASSERT(off == len,
4970 ("length inconsistency (off %u len %u)", off, len));
4972 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
4973 SADB_EXT_ADDRESS_DST);
4980 if (n->m_len < sizeof(struct sadb_msg)) {
4981 n = m_pullup(n, sizeof(struct sadb_msg));
4983 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
4986 n->m_pkthdr.len = 0;
4987 for (nn = n; nn; nn = nn->m_next)
4988 n->m_pkthdr.len += nn->m_len;
4990 newmsg = mtod(n, struct sadb_msg *);
4991 newmsg->sadb_msg_seq = sav->seq;
4992 newmsg->sadb_msg_errno = 0;
4993 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
4996 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
5000 return (key_senderror(so, m, error));
5004 * allocating new SPI
5005 * called by key_getspi().
5008 * others: success, SPI in network byte order.
5011 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
5013 uint32_t min, max, newspi, t;
5014 int count = V_key_spi_trycnt;
5016 /* set spi range to allocate */
5017 if (spirange != NULL) {
5018 min = spirange->sadb_spirange_min;
5019 max = spirange->sadb_spirange_max;
5021 min = V_key_spi_minval;
5022 max = V_key_spi_maxval;
5024 /* IPCOMP needs 2-byte SPI */
5025 if (saidx->proto == IPPROTO_IPCOMP) {
5031 t = min; min = max; max = t;
5036 if (!key_checkspidup(htonl(min))) {
5037 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
5042 count--; /* taking one cost. */
5049 /* when requesting to allocate spi ranged */
5051 /* generate pseudo-random SPI value ranged. */
5052 newspi = min + (key_random() % (max - min + 1));
5053 if (!key_checkspidup(htonl(newspi)))
5057 if (count == 0 || newspi == 0) {
5058 ipseclog((LOG_DEBUG,
5059 "%s: failed to allocate SPI.\n", __func__));
5065 keystat.getspi_count =
5066 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
5068 return (htonl(newspi));
5072 * Find TCP-MD5 SA with corresponding secasindex.
5073 * If not found, return NULL and fill SPI with usable value if needed.
5075 static struct secasvar *
5076 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
5078 SAHTREE_RLOCK_TRACKER;
5079 struct secashead *sah;
5080 struct secasvar *sav;
5082 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
5084 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5085 if (sah->saidx.proto != IPPROTO_TCP)
5087 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
5088 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
5092 if (V_key_preferred_oldsa)
5093 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
5095 sav = TAILQ_FIRST(&sah->savtree_alive);
5103 /* No SPI required */
5107 /* Check that SPI is unique */
5108 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5109 if (sav->spi == *spi)
5114 /* SPI is already unique */
5118 /* XXX: not optimal */
5119 *spi = key_do_getnewspi(NULL, saidx);
5124 key_updateaddresses(struct socket *so, struct mbuf *m,
5125 const struct sadb_msghdr *mhp, struct secasvar *sav,
5126 struct secasindex *saidx)
5128 struct sockaddr *newaddr;
5129 struct secashead *sah;
5130 struct secasvar *newsav, *tmp;
5134 /* Check that we need to change SAH */
5135 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5136 newaddr = (struct sockaddr *)(
5137 ((struct sadb_address *)
5138 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5139 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5140 key_porttosaddr(&saidx->src.sa, 0);
5142 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5143 newaddr = (struct sockaddr *)(
5144 ((struct sadb_address *)
5145 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5146 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5147 key_porttosaddr(&saidx->dst.sa, 0);
5149 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5150 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5151 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5153 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5158 sah = key_getsah(saidx);
5160 /* create a new SA index */
5161 sah = key_newsah(saidx);
5163 ipseclog((LOG_DEBUG,
5164 "%s: No more memory.\n", __func__));
5167 isnew = 2; /* SAH is new */
5169 isnew = 1; /* existing SAH is referenced */
5172 * src and dst addresses are still the same.
5173 * Do we want to change NAT-T config?
5175 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5176 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5177 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5178 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5179 ipseclog((LOG_DEBUG,
5180 "%s: invalid message: missing required header.\n",
5184 /* We hold reference to SA, thus SAH will be referenced too. */
5189 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5191 if (newsav == NULL) {
5192 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5197 /* Clone SA's content into newsav */
5198 SAV_INITREF(newsav);
5199 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5201 * We create new NAT-T config if it is needed.
5202 * Old NAT-T config will be freed by key_cleansav() when
5203 * last reference to SA will be released.
5205 newsav->natt = NULL;
5207 newsav->state = SADB_SASTATE_MATURE;
5208 error = key_setnatt(newsav, mhp);
5213 /* Check that SA is still alive */
5214 if (sav->state == SADB_SASTATE_DEAD) {
5215 /* SA was unlinked */
5221 /* Unlink SA from SAH and SPI hash */
5222 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5223 ("SA is already cloned"));
5224 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5225 sav->state == SADB_SASTATE_DYING,
5226 ("Wrong SA state %u\n", sav->state));
5227 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5228 LIST_REMOVE(sav, spihash);
5229 sav->state = SADB_SASTATE_DEAD;
5232 * Link new SA with SAH. Keep SAs ordered by
5233 * create time (newer are first).
5235 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5236 if (newsav->created > tmp->created) {
5237 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5242 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5244 /* Add new SA into SPI hash. */
5245 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5247 /* Add new SAH into SADB. */
5249 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5250 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5251 sah->state = SADB_SASTATE_MATURE;
5252 SAH_ADDREF(sah); /* newsav references new SAH */
5255 * isnew == 1 -> @sah was referenced by key_getsah().
5256 * isnew == 0 -> we use the same @sah, that was used by @sav,
5257 * and we use its reference for @newsav.
5260 /* XXX: replace cntr with pointer? */
5261 newsav->cntr = sav->cntr;
5262 sav->flags |= SADB_X_EXT_F_CLONED;
5263 SECASVAR_UNLOCK(sav);
5268 printf("%s: SA(%p) cloned into SA(%p)\n",
5269 __func__, sav, newsav));
5270 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5272 key_freesav(&sav); /* release last reference */
5274 /* set msg buf from mhp */
5275 n = key_getmsgbuf_x1(m, mhp);
5277 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5281 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5286 if (newsav != NULL) {
5287 if (newsav->natt != NULL)
5288 free(newsav->natt, M_IPSEC_MISC);
5289 free(newsav, M_IPSEC_SA);
5295 * SADB_UPDATE processing
5297 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5298 * key(AE), (identity(SD),) (sensitivity)>
5299 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5301 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5302 * (identity(SD),) (sensitivity)>
5305 * m will always be freed.
5308 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5310 struct secasindex saidx;
5311 struct sadb_address *src0, *dst0;
5312 struct sadb_sa *sa0;
5313 struct secasvar *sav;
5316 uint8_t mode, proto;
5318 IPSEC_ASSERT(so != NULL, ("null socket"));
5319 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5320 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5321 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5323 /* map satype to proto */
5324 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5325 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5327 return key_senderror(so, m, EINVAL);
5330 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5331 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5332 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5333 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5334 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5335 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5336 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5337 ipseclog((LOG_DEBUG,
5338 "%s: invalid message: missing required header.\n",
5340 return key_senderror(so, m, EINVAL);
5342 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5343 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5344 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5345 ipseclog((LOG_DEBUG,
5346 "%s: invalid message: wrong header size.\n", __func__));
5347 return key_senderror(so, m, EINVAL);
5349 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5350 mode = IPSEC_MODE_ANY;
5353 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5354 ipseclog((LOG_DEBUG,
5355 "%s: invalid message: wrong header size.\n",
5357 return key_senderror(so, m, EINVAL);
5359 mode = ((struct sadb_x_sa2 *)
5360 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5361 reqid = ((struct sadb_x_sa2 *)
5362 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5365 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5366 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5367 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5370 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5371 * SADB_UPDATE message.
5373 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5374 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5375 #ifdef PFKEY_STRICT_CHECKS
5376 return key_senderror(so, m, EINVAL);
5379 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5380 (struct sockaddr *)(dst0 + 1));
5382 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5383 return key_senderror(so, m, error);
5385 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5386 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5388 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5389 __func__, ntohl(sa0->sadb_sa_spi)));
5390 return key_senderror(so, m, EINVAL);
5393 * Check that SADB_UPDATE issued by the same process that did
5394 * SADB_GETSPI or SADB_ADD.
5396 if (sav->pid != mhp->msg->sadb_msg_pid) {
5397 ipseclog((LOG_DEBUG,
5398 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5399 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5401 return key_senderror(so, m, EINVAL);
5403 /* saidx should match with SA. */
5404 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5405 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u\n",
5406 __func__, ntohl(sav->spi)));
5408 return key_senderror(so, m, ESRCH);
5411 if (sav->state == SADB_SASTATE_LARVAL) {
5412 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5413 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5414 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5415 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5416 ipseclog((LOG_DEBUG,
5417 "%s: invalid message: missing required header.\n",
5420 return key_senderror(so, m, EINVAL);
5423 * We can set any values except src, dst and SPI.
5425 error = key_setsaval(sav, mhp);
5428 return (key_senderror(so, m, error));
5430 /* Change SA state to MATURE */
5432 if (sav->state != SADB_SASTATE_LARVAL) {
5433 /* SA was deleted or another thread made it MATURE. */
5436 return (key_senderror(so, m, ESRCH));
5439 * NOTE: we keep SAs in savtree_alive ordered by created
5440 * time. When SA's state changed from LARVAL to MATURE,
5441 * we update its created time in key_setsaval() and move
5442 * it into head of savtree_alive.
5444 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5445 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5446 sav->state = SADB_SASTATE_MATURE;
5450 * For DYING and MATURE SA we can change only state
5451 * and lifetimes. Report EINVAL if something else attempted
5454 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5455 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5457 return (key_senderror(so, m, EINVAL));
5459 error = key_updatelifetimes(sav, mhp);
5462 return (key_senderror(so, m, error));
5465 * This is FreeBSD extension to RFC2367.
5466 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5467 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5468 * SA addresses (for example to implement MOBIKE protocol
5469 * as described in RFC4555). Also we allow to change
5472 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5473 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5474 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5475 sav->natt != NULL) {
5476 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5479 return (key_senderror(so, m, error));
5482 /* Check that SA is still alive */
5484 if (sav->state == SADB_SASTATE_DEAD) {
5485 /* SA was unlinked */
5488 return (key_senderror(so, m, ESRCH));
5491 * NOTE: there is possible state moving from DYING to MATURE,
5492 * but this doesn't change created time, so we won't reorder
5495 sav->state = SADB_SASTATE_MATURE;
5499 printf("%s: SA(%p)\n", __func__, sav));
5500 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5506 /* set msg buf from mhp */
5507 n = key_getmsgbuf_x1(m, mhp);
5509 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5510 return key_senderror(so, m, ENOBUFS);
5514 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5519 * SADB_ADD processing
5520 * add an entry to SA database, when received
5521 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5522 * key(AE), (identity(SD),) (sensitivity)>
5525 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5526 * (identity(SD),) (sensitivity)>
5529 * IGNORE identity and sensitivity messages.
5531 * m will always be freed.
5534 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5536 struct secasindex saidx;
5537 struct sadb_address *src0, *dst0;
5538 struct sadb_sa *sa0;
5539 struct secasvar *sav;
5540 uint32_t reqid, spi;
5541 uint8_t mode, proto;
5544 IPSEC_ASSERT(so != NULL, ("null socket"));
5545 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5546 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5547 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5549 /* map satype to proto */
5550 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5551 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5553 return key_senderror(so, m, EINVAL);
5556 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5557 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5558 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5559 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5560 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5561 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5562 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5563 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5564 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5565 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5566 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5567 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5568 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5569 ipseclog((LOG_DEBUG,
5570 "%s: invalid message: missing required header.\n",
5572 return key_senderror(so, m, EINVAL);
5574 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5575 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5576 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5577 ipseclog((LOG_DEBUG,
5578 "%s: invalid message: wrong header size.\n", __func__));
5579 return key_senderror(so, m, EINVAL);
5581 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5582 mode = IPSEC_MODE_ANY;
5585 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5586 ipseclog((LOG_DEBUG,
5587 "%s: invalid message: wrong header size.\n",
5589 return key_senderror(so, m, EINVAL);
5591 mode = ((struct sadb_x_sa2 *)
5592 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5593 reqid = ((struct sadb_x_sa2 *)
5594 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5597 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5598 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5599 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5602 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5605 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5606 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5607 #ifdef PFKEY_STRICT_CHECKS
5608 return key_senderror(so, m, EINVAL);
5611 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5612 (struct sockaddr *)(dst0 + 1));
5614 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5615 return key_senderror(so, m, error);
5617 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5618 spi = sa0->sadb_sa_spi;
5620 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5622 * XXXAE: IPComp seems also doesn't use SPI.
5624 if (proto == IPPROTO_TCP) {
5625 sav = key_getsav_tcpmd5(&saidx, &spi);
5626 if (sav == NULL && spi == 0) {
5627 /* Failed to allocate SPI */
5628 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5630 return key_senderror(so, m, EEXIST);
5632 /* XXX: SPI that we report back can have another value */
5634 /* We can create new SA only if SPI is different. */
5635 sav = key_getsavbyspi(spi);
5639 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5640 return key_senderror(so, m, EEXIST);
5643 sav = key_newsav(mhp, &saidx, spi, &error);
5645 return key_senderror(so, m, error);
5647 printf("%s: return SA(%p)\n", __func__, sav));
5648 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5650 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5654 key_acqdone(&saidx, sav->seq);
5658 * Don't call key_freesav() on error here, as we would like to
5659 * keep the SA in the database.
5663 /* set msg buf from mhp */
5664 n = key_getmsgbuf_x1(m, mhp);
5666 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5667 return key_senderror(so, m, ENOBUFS);
5671 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5677 * IKEd may request the use ESP in UDP encapsulation when it detects the
5678 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5679 * parameters needed for encapsulation and decapsulation. These PF_KEY
5680 * extension headers are not standardized, so this comment addresses our
5682 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5683 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5684 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5685 * UDP header. We use these ports in UDP encapsulation procedure, also we
5686 * can check them in UDP decapsulation procedure.
5687 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5688 * responder. These addresses can be used for transport mode to adjust
5689 * checksum after decapsulation and decryption. Since original IP addresses
5690 * used by peer usually different (we detected presence of NAT), TCP/UDP
5691 * pseudo header checksum and IP header checksum was calculated using original
5692 * addresses. After decapsulation and decryption we need to adjust checksum
5693 * to have correct datagram.
5695 * We expect presence of NAT-T extension headers only in SADB_ADD and
5696 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5697 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5700 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5702 struct sadb_x_nat_t_port *port;
5703 struct sadb_x_nat_t_type *type;
5704 struct sadb_address *oai, *oar;
5705 struct sockaddr *sa;
5709 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5711 * Ignore NAT-T headers if sproto isn't ESP.
5713 if (sav->sah->saidx.proto != IPPROTO_ESP)
5716 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5717 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5718 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5719 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5720 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5721 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5722 ipseclog((LOG_DEBUG,
5723 "%s: invalid message: wrong header size.\n",
5730 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5731 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5732 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5733 __func__, type->sadb_x_nat_t_type_type));
5737 * Allocate storage for NAT-T config.
5738 * On error it will be released by key_cleansav().
5740 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5742 if (sav->natt == NULL) {
5743 PFKEYSTAT_INC(in_nomem);
5744 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5747 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5748 if (port->sadb_x_nat_t_port_port == 0) {
5749 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5753 sav->natt->sport = port->sadb_x_nat_t_port_port;
5754 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5755 if (port->sadb_x_nat_t_port_port == 0) {
5756 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5760 sav->natt->dport = port->sadb_x_nat_t_port_port;
5763 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5764 * and needed only for transport mode IPsec.
5765 * Usually NAT translates only one address, but it is possible,
5766 * that both addresses could be translated.
5767 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5769 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5770 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5771 ipseclog((LOG_DEBUG,
5772 "%s: invalid message: wrong header size.\n",
5776 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5779 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5780 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5781 ipseclog((LOG_DEBUG,
5782 "%s: invalid message: wrong header size.\n",
5786 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5790 /* Initialize addresses only for transport mode */
5791 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5794 /* Currently we support only AF_INET */
5795 sa = (struct sockaddr *)(oai + 1);
5796 if (sa->sa_family != AF_INET ||
5797 sa->sa_len != sizeof(struct sockaddr_in)) {
5798 ipseclog((LOG_DEBUG,
5799 "%s: wrong NAT-OAi header.\n",
5803 /* Ignore address if it the same */
5804 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5805 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5806 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5807 sav->natt->flags |= IPSEC_NATT_F_OAI;
5808 /* Calculate checksum delta */
5809 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5810 cksum = in_addword(cksum, ~addr >> 16);
5811 cksum = in_addword(cksum, ~addr & 0xffff);
5812 addr = sav->natt->oai.sin.sin_addr.s_addr;
5813 cksum = in_addword(cksum, addr >> 16);
5814 cksum = in_addword(cksum, addr & 0xffff);
5818 /* Currently we support only AF_INET */
5819 sa = (struct sockaddr *)(oar + 1);
5820 if (sa->sa_family != AF_INET ||
5821 sa->sa_len != sizeof(struct sockaddr_in)) {
5822 ipseclog((LOG_DEBUG,
5823 "%s: wrong NAT-OAr header.\n",
5827 /* Ignore address if it the same */
5828 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5829 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5830 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5831 sav->natt->flags |= IPSEC_NATT_F_OAR;
5832 /* Calculate checksum delta */
5833 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5834 cksum = in_addword(cksum, ~addr >> 16);
5835 cksum = in_addword(cksum, ~addr & 0xffff);
5836 addr = sav->natt->oar.sin.sin_addr.s_addr;
5837 cksum = in_addword(cksum, addr >> 16);
5838 cksum = in_addword(cksum, addr & 0xffff);
5841 sav->natt->cksum = cksum;
5847 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5849 const struct sadb_ident *idsrc, *iddst;
5851 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5852 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5853 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5855 /* don't make buffer if not there */
5856 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5857 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5863 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5864 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5865 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5869 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5870 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5872 /* validity check */
5873 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5874 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5878 switch (idsrc->sadb_ident_type) {
5879 case SADB_IDENTTYPE_PREFIX:
5880 case SADB_IDENTTYPE_FQDN:
5881 case SADB_IDENTTYPE_USERFQDN:
5883 /* XXX do nothing */
5889 /* make structure */
5890 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5891 if (sah->idents == NULL) {
5892 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5895 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5896 if (sah->identd == NULL) {
5897 free(sah->idents, M_IPSEC_MISC);
5899 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5902 sah->idents->type = idsrc->sadb_ident_type;
5903 sah->idents->id = idsrc->sadb_ident_id;
5905 sah->identd->type = iddst->sadb_ident_type;
5906 sah->identd->id = iddst->sadb_ident_id;
5912 * m will not be freed on return.
5913 * it is caller's responsibility to free the result.
5915 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5916 * from the request in defined order.
5918 static struct mbuf *
5919 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5923 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5924 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5925 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5927 /* create new sadb_msg to reply. */
5928 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5929 SADB_EXT_SA, SADB_X_EXT_SA2,
5930 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5931 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5932 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5933 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5934 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5935 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5936 SADB_X_EXT_NEW_ADDRESS_DST);
5940 if (n->m_len < sizeof(struct sadb_msg)) {
5941 n = m_pullup(n, sizeof(struct sadb_msg));
5945 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5946 mtod(n, struct sadb_msg *)->sadb_msg_len =
5947 PFKEY_UNIT64(n->m_pkthdr.len);
5953 * SADB_DELETE processing
5955 * <base, SA(*), address(SD)>
5956 * from the ikmpd, and set SADB_SASTATE_DEAD,
5958 * <base, SA(*), address(SD)>
5961 * m will always be freed.
5964 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5966 struct secasindex saidx;
5967 struct sadb_address *src0, *dst0;
5968 struct secasvar *sav;
5969 struct sadb_sa *sa0;
5972 IPSEC_ASSERT(so != NULL, ("null socket"));
5973 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5974 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5975 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5977 /* map satype to proto */
5978 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5979 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5981 return key_senderror(so, m, EINVAL);
5984 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5985 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5986 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5987 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5988 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
5990 return key_senderror(so, m, EINVAL);
5993 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5994 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5996 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
5997 (struct sockaddr *)(dst0 + 1)) != 0) {
5998 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5999 return (key_senderror(so, m, EINVAL));
6001 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6002 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
6004 * Caller wants us to delete all non-LARVAL SAs
6005 * that match the src/dst. This is used during
6006 * IKE INITIAL-CONTACT.
6007 * XXXAE: this looks like some extension to RFC2367.
6009 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
6010 return (key_delete_all(so, m, mhp, &saidx));
6012 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
6013 ipseclog((LOG_DEBUG,
6014 "%s: invalid message: wrong header size.\n", __func__));
6015 return (key_senderror(so, m, EINVAL));
6017 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6018 if (proto == IPPROTO_TCP)
6019 sav = key_getsav_tcpmd5(&saidx, NULL);
6021 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6023 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
6024 __func__, ntohl(sa0->sadb_sa_spi)));
6025 return (key_senderror(so, m, ESRCH));
6027 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6028 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6029 __func__, ntohl(sav->spi)));
6031 return (key_senderror(so, m, ESRCH));
6034 printf("%s: SA(%p)\n", __func__, sav));
6035 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6041 struct sadb_msg *newmsg;
6043 /* create new sadb_msg to reply. */
6044 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
6045 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6047 return key_senderror(so, m, ENOBUFS);
6049 if (n->m_len < sizeof(struct sadb_msg)) {
6050 n = m_pullup(n, sizeof(struct sadb_msg));
6052 return key_senderror(so, m, ENOBUFS);
6054 newmsg = mtod(n, struct sadb_msg *);
6055 newmsg->sadb_msg_errno = 0;
6056 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6059 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6064 * delete all SAs for src/dst. Called from key_delete().
6067 key_delete_all(struct socket *so, struct mbuf *m,
6068 const struct sadb_msghdr *mhp, struct secasindex *saidx)
6070 struct secasvar_queue drainq;
6071 struct secashead *sah;
6072 struct secasvar *sav, *nextsav;
6074 TAILQ_INIT(&drainq);
6076 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
6077 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
6079 /* Move all ALIVE SAs into drainq */
6080 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6082 /* Unlink all queued SAs from SPI hash */
6083 TAILQ_FOREACH(sav, &drainq, chain) {
6084 sav->state = SADB_SASTATE_DEAD;
6085 LIST_REMOVE(sav, spihash);
6088 /* Now we can release reference for all SAs in drainq */
6089 sav = TAILQ_FIRST(&drainq);
6090 while (sav != NULL) {
6092 printf("%s: SA(%p)\n", __func__, sav));
6093 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6094 nextsav = TAILQ_NEXT(sav, chain);
6095 key_freesah(&sav->sah); /* release reference from SAV */
6096 key_freesav(&sav); /* release last reference */
6102 struct sadb_msg *newmsg;
6104 /* create new sadb_msg to reply. */
6105 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6106 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6108 return key_senderror(so, m, ENOBUFS);
6110 if (n->m_len < sizeof(struct sadb_msg)) {
6111 n = m_pullup(n, sizeof(struct sadb_msg));
6113 return key_senderror(so, m, ENOBUFS);
6115 newmsg = mtod(n, struct sadb_msg *);
6116 newmsg->sadb_msg_errno = 0;
6117 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6120 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6125 * Delete all alive SAs for corresponding xform.
6126 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6127 * here when xform disappears.
6130 key_delete_xform(const struct xformsw *xsp)
6132 struct secasvar_queue drainq;
6133 struct secashead *sah;
6134 struct secasvar *sav, *nextsav;
6136 TAILQ_INIT(&drainq);
6138 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6139 sav = TAILQ_FIRST(&sah->savtree_alive);
6142 if (sav->tdb_xform != xsp)
6145 * It is supposed that all SAs in the chain are related to
6148 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6150 /* Unlink all queued SAs from SPI hash */
6151 TAILQ_FOREACH(sav, &drainq, chain) {
6152 sav->state = SADB_SASTATE_DEAD;
6153 LIST_REMOVE(sav, spihash);
6157 /* Now we can release reference for all SAs in drainq */
6158 sav = TAILQ_FIRST(&drainq);
6159 while (sav != NULL) {
6161 printf("%s: SA(%p)\n", __func__, sav));
6162 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6163 nextsav = TAILQ_NEXT(sav, chain);
6164 key_freesah(&sav->sah); /* release reference from SAV */
6165 key_freesav(&sav); /* release last reference */
6171 * SADB_GET processing
6173 * <base, SA(*), address(SD)>
6174 * from the ikmpd, and get a SP and a SA to respond,
6176 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6177 * (identity(SD),) (sensitivity)>
6180 * m will always be freed.
6183 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6185 struct secasindex saidx;
6186 struct sadb_address *src0, *dst0;
6187 struct sadb_sa *sa0;
6188 struct secasvar *sav;
6191 IPSEC_ASSERT(so != NULL, ("null socket"));
6192 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6193 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6194 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6196 /* map satype to proto */
6197 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6198 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6200 return key_senderror(so, m, EINVAL);
6203 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6204 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6205 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6206 ipseclog((LOG_DEBUG,
6207 "%s: invalid message: missing required header.\n",
6209 return key_senderror(so, m, EINVAL);
6211 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6212 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6213 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6214 ipseclog((LOG_DEBUG,
6215 "%s: invalid message: wrong header size.\n", __func__));
6216 return key_senderror(so, m, EINVAL);
6219 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6220 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6221 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6223 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6224 (struct sockaddr *)(dst0 + 1)) != 0) {
6225 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6226 return key_senderror(so, m, EINVAL);
6228 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6230 if (proto == IPPROTO_TCP)
6231 sav = key_getsav_tcpmd5(&saidx, NULL);
6233 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6235 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6236 return key_senderror(so, m, ESRCH);
6238 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6239 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6240 __func__, ntohl(sa0->sadb_sa_spi)));
6242 return (key_senderror(so, m, ESRCH));
6249 /* map proto to satype */
6250 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6251 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6254 return key_senderror(so, m, EINVAL);
6257 /* create new sadb_msg to reply. */
6258 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6259 mhp->msg->sadb_msg_pid);
6263 return key_senderror(so, m, ENOBUFS);
6266 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6270 /* XXX make it sysctl-configurable? */
6272 key_getcomb_setlifetime(struct sadb_comb *comb)
6275 comb->sadb_comb_soft_allocations = 1;
6276 comb->sadb_comb_hard_allocations = 1;
6277 comb->sadb_comb_soft_bytes = 0;
6278 comb->sadb_comb_hard_bytes = 0;
6279 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6280 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6281 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6282 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6286 * XXX reorder combinations by preference
6287 * XXX no idea if the user wants ESP authentication or not
6289 static struct mbuf *
6290 key_getcomb_ealg(void)
6292 struct sadb_comb *comb;
6293 const struct enc_xform *algo;
6294 struct mbuf *result = NULL, *m, *n;
6298 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6301 for (i = 1; i <= SADB_EALG_MAX; i++) {
6302 algo = enc_algorithm_lookup(i);
6306 /* discard algorithms with key size smaller than system min */
6307 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6309 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6310 encmin = V_ipsec_esp_keymin;
6312 encmin = _BITS(algo->minkey);
6314 if (V_ipsec_esp_auth)
6315 m = key_getcomb_ah();
6317 IPSEC_ASSERT(l <= MLEN,
6318 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6319 MGET(m, M_NOWAIT, MT_DATA);
6324 bzero(mtod(m, caddr_t), m->m_len);
6331 for (n = m; n; n = n->m_next)
6333 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6335 for (off = 0; off < totlen; off += l) {
6336 n = m_pulldown(m, off, l, &o);
6338 /* m is already freed */
6341 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6342 bzero(comb, sizeof(*comb));
6343 key_getcomb_setlifetime(comb);
6344 comb->sadb_comb_encrypt = i;
6345 comb->sadb_comb_encrypt_minbits = encmin;
6346 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6364 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6368 *min = *max = ah->hashsize;
6369 if (ah->keysize == 0) {
6371 * Transform takes arbitrary key size but algorithm
6372 * key size is restricted. Enforce this here.
6375 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6376 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6377 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6378 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6380 DPRINTF(("%s: unknown AH algorithm %u\n",
6388 * XXX reorder combinations by preference
6390 static struct mbuf *
6393 const struct auth_hash *algo;
6394 struct sadb_comb *comb;
6396 u_int16_t minkeysize, maxkeysize;
6398 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6401 for (i = 1; i <= SADB_AALG_MAX; i++) {
6403 /* we prefer HMAC algorithms, not old algorithms */
6404 if (i != SADB_AALG_SHA1HMAC &&
6405 i != SADB_X_AALG_SHA2_256 &&
6406 i != SADB_X_AALG_SHA2_384 &&
6407 i != SADB_X_AALG_SHA2_512)
6410 algo = auth_algorithm_lookup(i);
6413 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6414 /* discard algorithms with key size smaller than system min */
6415 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6419 IPSEC_ASSERT(l <= MLEN,
6420 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6421 MGET(m, M_NOWAIT, MT_DATA);
6428 M_PREPEND(m, l, M_NOWAIT);
6432 comb = mtod(m, struct sadb_comb *);
6433 bzero(comb, sizeof(*comb));
6434 key_getcomb_setlifetime(comb);
6435 comb->sadb_comb_auth = i;
6436 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6437 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6444 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6445 * XXX reorder combinations by preference
6447 static struct mbuf *
6448 key_getcomb_ipcomp()
6450 const struct comp_algo *algo;
6451 struct sadb_comb *comb;
6454 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6457 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6458 algo = comp_algorithm_lookup(i);
6463 IPSEC_ASSERT(l <= MLEN,
6464 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6465 MGET(m, M_NOWAIT, MT_DATA);
6472 M_PREPEND(m, l, M_NOWAIT);
6476 comb = mtod(m, struct sadb_comb *);
6477 bzero(comb, sizeof(*comb));
6478 key_getcomb_setlifetime(comb);
6479 comb->sadb_comb_encrypt = i;
6480 /* what should we set into sadb_comb_*_{min,max}bits? */
6487 * XXX no way to pass mode (transport/tunnel) to userland
6488 * XXX replay checking?
6489 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6491 static struct mbuf *
6492 key_getprop(const struct secasindex *saidx)
6494 struct sadb_prop *prop;
6496 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6499 switch (saidx->proto) {
6501 m = key_getcomb_ealg();
6504 m = key_getcomb_ah();
6506 case IPPROTO_IPCOMP:
6507 m = key_getcomb_ipcomp();
6515 M_PREPEND(m, l, M_NOWAIT);
6520 for (n = m; n; n = n->m_next)
6523 prop = mtod(m, struct sadb_prop *);
6524 bzero(prop, sizeof(*prop));
6525 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6526 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6527 prop->sadb_prop_replay = 32; /* XXX */
6533 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6535 * <base, SA, address(SD), (address(P)), x_policy,
6536 * (identity(SD),) (sensitivity,) proposal>
6537 * to KMD, and expect to receive
6538 * <base> with SADB_ACQUIRE if error occurred,
6540 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6541 * from KMD by PF_KEY.
6543 * XXX x_policy is outside of RFC2367 (KAME extension).
6544 * XXX sensitivity is not supported.
6545 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6546 * see comment for key_getcomb_ipcomp().
6550 * others: error number
6553 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6555 union sockaddr_union addr;
6556 struct mbuf *result, *m;
6560 uint8_t mask, satype;
6562 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6563 satype = key_proto2satype(saidx->proto);
6564 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6568 ul_proto = IPSEC_ULPROTO_ANY;
6570 /* Get seq number to check whether sending message or not. */
6571 seq = key_getacq(saidx, &error);
6575 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6583 * set sadb_address for saidx's.
6585 * Note that if sp is supplied, then we're being called from
6586 * key_allocsa_policy() and should supply port and protocol
6588 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6589 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6590 * XXXAE: it looks like we should save this info in the ACQ entry.
6592 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6593 sp->spidx.ul_proto == IPPROTO_UDP))
6594 ul_proto = sp->spidx.ul_proto;
6598 if (ul_proto != IPSEC_ULPROTO_ANY) {
6599 switch (sp->spidx.src.sa.sa_family) {
6601 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6602 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6603 mask = sp->spidx.prefs;
6607 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6608 addr.sin6.sin6_port =
6609 sp->spidx.src.sin6.sin6_port;
6610 mask = sp->spidx.prefs;
6617 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6626 if (ul_proto != IPSEC_ULPROTO_ANY) {
6627 switch (sp->spidx.dst.sa.sa_family) {
6629 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6630 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6631 mask = sp->spidx.prefd;
6635 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6636 addr.sin6.sin6_port =
6637 sp->spidx.dst.sin6.sin6_port;
6638 mask = sp->spidx.prefd;
6645 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6652 /* XXX proxy address (optional) */
6655 * Set sadb_x_policy. This is KAME extension to RFC2367.
6658 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6668 * Set sadb_x_sa2 extension if saidx->reqid is not zero.
6669 * This is FreeBSD extension to RFC2367.
6671 if (saidx->reqid != 0) {
6672 m = key_setsadbxsa2(saidx->mode, 0, saidx->reqid);
6679 /* XXX identity (optional) */
6681 if (idexttype && fqdn) {
6682 /* create identity extension (FQDN) */
6683 struct sadb_ident *id;
6686 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6687 id = (struct sadb_ident *)p;
6688 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6689 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6690 id->sadb_ident_exttype = idexttype;
6691 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6692 bcopy(fqdn, id + 1, fqdnlen);
6693 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6697 /* create identity extension (USERFQDN) */
6698 struct sadb_ident *id;
6702 /* +1 for terminating-NUL */
6703 userfqdnlen = strlen(userfqdn) + 1;
6706 id = (struct sadb_ident *)p;
6707 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6708 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6709 id->sadb_ident_exttype = idexttype;
6710 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6711 /* XXX is it correct? */
6712 if (curproc && curproc->p_cred)
6713 id->sadb_ident_id = curproc->p_cred->p_ruid;
6714 if (userfqdn && userfqdnlen)
6715 bcopy(userfqdn, id + 1, userfqdnlen);
6716 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6720 /* XXX sensitivity (optional) */
6722 /* create proposal/combination extension */
6723 m = key_getprop(saidx);
6726 * spec conformant: always attach proposal/combination extension,
6727 * the problem is that we have no way to attach it for ipcomp,
6728 * due to the way sadb_comb is declared in RFC2367.
6737 * outside of spec; make proposal/combination extension optional.
6743 if ((result->m_flags & M_PKTHDR) == 0) {
6748 if (result->m_len < sizeof(struct sadb_msg)) {
6749 result = m_pullup(result, sizeof(struct sadb_msg));
6750 if (result == NULL) {
6756 result->m_pkthdr.len = 0;
6757 for (m = result; m; m = m->m_next)
6758 result->m_pkthdr.len += m->m_len;
6760 mtod(result, struct sadb_msg *)->sadb_msg_len =
6761 PFKEY_UNIT64(result->m_pkthdr.len);
6764 printf("%s: SP(%p)\n", __func__, sp));
6765 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6767 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6776 key_newacq(const struct secasindex *saidx, int *perror)
6781 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6783 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6789 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6790 acq->created = time_second;
6793 /* add to acqtree */
6795 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6796 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6797 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6798 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6805 key_getacq(const struct secasindex *saidx, int *perror)
6811 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6812 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6813 if (acq->count > V_key_blockacq_count) {
6815 * Reset counter and send message.
6816 * Also reset created time to keep ACQ for
6819 acq->created = time_second;
6824 * Increment counter and do nothing.
6825 * We send SADB_ACQUIRE message only
6826 * for each V_key_blockacq_count packet.
6839 /* allocate new entry */
6840 return (key_newacq(saidx, perror));
6844 key_acqreset(uint32_t seq)
6849 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6850 if (acq->seq == seq) {
6852 acq->created = time_second;
6862 * Mark ACQ entry as stale to remove it in key_flush_acq().
6863 * Called after successful SADB_GETSPI message.
6866 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6871 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6872 if (acq->seq == seq)
6876 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6877 ipseclog((LOG_DEBUG,
6878 "%s: Mismatched saidx for ACQ %u\n", __func__, seq));
6884 ipseclog((LOG_DEBUG,
6885 "%s: ACQ %u is not found.\n", __func__, seq));
6893 static struct secspacq *
6894 key_newspacq(struct secpolicyindex *spidx)
6896 struct secspacq *acq;
6899 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6901 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6906 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6907 acq->created = time_second;
6910 /* add to spacqtree */
6912 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6918 static struct secspacq *
6919 key_getspacq(struct secpolicyindex *spidx)
6921 struct secspacq *acq;
6924 LIST_FOREACH(acq, &V_spacqtree, chain) {
6925 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6926 /* NB: return holding spacq_lock */
6936 * SADB_ACQUIRE processing,
6937 * in first situation, is receiving
6939 * from the ikmpd, and clear sequence of its secasvar entry.
6941 * In second situation, is receiving
6942 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6943 * from a user land process, and return
6944 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6947 * m will always be freed.
6950 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6952 SAHTREE_RLOCK_TRACKER;
6953 struct sadb_address *src0, *dst0;
6954 struct secasindex saidx;
6955 struct secashead *sah;
6958 uint8_t mode, proto;
6960 IPSEC_ASSERT(so != NULL, ("null socket"));
6961 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6962 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6963 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6966 * Error message from KMd.
6967 * We assume that if error was occurred in IKEd, the length of PFKEY
6968 * message is equal to the size of sadb_msg structure.
6969 * We do not raise error even if error occurred in this function.
6971 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
6972 /* check sequence number */
6973 if (mhp->msg->sadb_msg_seq == 0 ||
6974 mhp->msg->sadb_msg_errno == 0) {
6975 ipseclog((LOG_DEBUG, "%s: must specify sequence "
6976 "number and errno.\n", __func__));
6979 * IKEd reported that error occurred.
6980 * XXXAE: what it expects from the kernel?
6981 * Probably we should send SADB_ACQUIRE again?
6982 * If so, reset ACQ's state.
6983 * XXXAE: it looks useless.
6985 key_acqreset(mhp->msg->sadb_msg_seq);
6992 * This message is from user land.
6995 /* map satype to proto */
6996 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6997 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6999 return key_senderror(so, m, EINVAL);
7002 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
7003 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
7004 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
7005 ipseclog((LOG_DEBUG,
7006 "%s: invalid message: missing required header.\n",
7008 return key_senderror(so, m, EINVAL);
7010 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
7011 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
7012 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
7013 ipseclog((LOG_DEBUG,
7014 "%s: invalid message: wrong header size.\n", __func__));
7015 return key_senderror(so, m, EINVAL);
7018 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
7019 mode = IPSEC_MODE_ANY;
7022 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
7023 ipseclog((LOG_DEBUG,
7024 "%s: invalid message: wrong header size.\n",
7026 return key_senderror(so, m, EINVAL);
7028 mode = ((struct sadb_x_sa2 *)
7029 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7030 reqid = ((struct sadb_x_sa2 *)
7031 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7034 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7035 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7037 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
7038 (struct sockaddr *)(dst0 + 1));
7040 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
7041 return key_senderror(so, m, EINVAL);
7043 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
7045 /* get a SA index */
7047 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
7048 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
7053 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
7054 return key_senderror(so, m, EEXIST);
7057 error = key_acquire(&saidx, NULL);
7059 ipseclog((LOG_DEBUG,
7060 "%s: error %d returned from key_acquire()\n",
7062 return key_senderror(so, m, error);
7069 * SADB_REGISTER processing.
7070 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
7073 * from the ikmpd, and register a socket to send PF_KEY messages,
7077 * If socket is detached, must free from regnode.
7079 * m will always be freed.
7082 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7084 struct secreg *reg, *newreg = NULL;
7086 IPSEC_ASSERT(so != NULL, ("null socket"));
7087 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7088 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7089 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7091 /* check for invalid register message */
7092 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
7093 return key_senderror(so, m, EINVAL);
7095 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
7096 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
7099 /* check whether existing or not */
7101 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
7102 if (reg->so == so) {
7104 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
7106 return key_senderror(so, m, EEXIST);
7110 /* create regnode */
7111 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
7112 if (newreg == NULL) {
7114 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7115 return key_senderror(so, m, ENOBUFS);
7119 ((struct keycb *)sotorawcb(so))->kp_registered++;
7121 /* add regnode to regtree. */
7122 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7128 struct sadb_msg *newmsg;
7129 struct sadb_supported *sup;
7130 u_int len, alen, elen;
7133 struct sadb_alg *alg;
7135 /* create new sadb_msg to reply. */
7137 for (i = 1; i <= SADB_AALG_MAX; i++) {
7138 if (auth_algorithm_lookup(i))
7139 alen += sizeof(struct sadb_alg);
7142 alen += sizeof(struct sadb_supported);
7144 for (i = 1; i <= SADB_EALG_MAX; i++) {
7145 if (enc_algorithm_lookup(i))
7146 elen += sizeof(struct sadb_alg);
7149 elen += sizeof(struct sadb_supported);
7151 len = sizeof(struct sadb_msg) + alen + elen;
7154 return key_senderror(so, m, ENOBUFS);
7156 MGETHDR(n, M_NOWAIT, MT_DATA);
7157 if (n != NULL && len > MHLEN) {
7158 if (!(MCLGET(n, M_NOWAIT))) {
7164 return key_senderror(so, m, ENOBUFS);
7166 n->m_pkthdr.len = n->m_len = len;
7170 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7171 newmsg = mtod(n, struct sadb_msg *);
7172 newmsg->sadb_msg_errno = 0;
7173 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7174 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7176 /* for authentication algorithm */
7178 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7179 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7180 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7181 off += PFKEY_ALIGN8(sizeof(*sup));
7183 for (i = 1; i <= SADB_AALG_MAX; i++) {
7184 const struct auth_hash *aalgo;
7185 u_int16_t minkeysize, maxkeysize;
7187 aalgo = auth_algorithm_lookup(i);
7190 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7191 alg->sadb_alg_id = i;
7192 alg->sadb_alg_ivlen = 0;
7193 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7194 alg->sadb_alg_minbits = _BITS(minkeysize);
7195 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7196 off += PFKEY_ALIGN8(sizeof(*alg));
7200 /* for encryption algorithm */
7202 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7203 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7204 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7205 off += PFKEY_ALIGN8(sizeof(*sup));
7207 for (i = 1; i <= SADB_EALG_MAX; i++) {
7208 const struct enc_xform *ealgo;
7210 ealgo = enc_algorithm_lookup(i);
7213 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7214 alg->sadb_alg_id = i;
7215 alg->sadb_alg_ivlen = ealgo->ivsize;
7216 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7217 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7218 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7222 IPSEC_ASSERT(off == len,
7223 ("length assumption failed (off %u len %u)", off, len));
7226 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7231 * free secreg entry registered.
7232 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7235 key_freereg(struct socket *so)
7240 IPSEC_ASSERT(so != NULL, ("NULL so"));
7243 * check whether existing or not.
7244 * check all type of SA, because there is a potential that
7245 * one socket is registered to multiple type of SA.
7248 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7249 LIST_FOREACH(reg, &V_regtree[i], chain) {
7250 if (reg->so == so && __LIST_CHAINED(reg)) {
7251 LIST_REMOVE(reg, chain);
7252 free(reg, M_IPSEC_SAR);
7261 * SADB_EXPIRE processing
7263 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7265 * NOTE: We send only soft lifetime extension.
7268 * others : error number
7271 key_expire(struct secasvar *sav, int hard)
7273 struct mbuf *result = NULL, *m;
7274 struct sadb_lifetime *lt;
7275 uint32_t replay_count;
7279 IPSEC_ASSERT (sav != NULL, ("null sav"));
7280 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7283 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7284 sav, hard ? "hard": "soft"));
7285 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7286 /* set msg header */
7287 satype = key_proto2satype(sav->sah->saidx.proto);
7288 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7289 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7296 /* create SA extension */
7297 m = key_setsadbsa(sav);
7304 /* create SA extension */
7306 replay_count = sav->replay ? sav->replay->count : 0;
7307 SECASVAR_UNLOCK(sav);
7309 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7310 sav->sah->saidx.reqid);
7317 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7318 m = key_setsadbxsareplay(sav->replay->wsize);
7326 /* create lifetime extension (current and soft) */
7327 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7328 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7335 bzero(mtod(m, caddr_t), len);
7336 lt = mtod(m, struct sadb_lifetime *);
7337 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7338 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7339 lt->sadb_lifetime_allocations =
7340 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7341 lt->sadb_lifetime_bytes =
7342 counter_u64_fetch(sav->lft_c_bytes);
7343 lt->sadb_lifetime_addtime = sav->created;
7344 lt->sadb_lifetime_usetime = sav->firstused;
7345 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7346 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7348 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7349 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7350 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7351 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7352 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7354 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7355 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7356 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7357 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7358 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7362 /* set sadb_address for source */
7363 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7364 &sav->sah->saidx.src.sa,
7365 FULLMASK, IPSEC_ULPROTO_ANY);
7372 /* set sadb_address for destination */
7373 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7374 &sav->sah->saidx.dst.sa,
7375 FULLMASK, IPSEC_ULPROTO_ANY);
7383 * XXX-BZ Handle NAT-T extensions here.
7384 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7385 * this information, we report only significant SA fields.
7388 if ((result->m_flags & M_PKTHDR) == 0) {
7393 if (result->m_len < sizeof(struct sadb_msg)) {
7394 result = m_pullup(result, sizeof(struct sadb_msg));
7395 if (result == NULL) {
7401 result->m_pkthdr.len = 0;
7402 for (m = result; m; m = m->m_next)
7403 result->m_pkthdr.len += m->m_len;
7405 mtod(result, struct sadb_msg *)->sadb_msg_len =
7406 PFKEY_UNIT64(result->m_pkthdr.len);
7408 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7417 key_freesah_flushed(struct secashead_queue *flushq)
7419 struct secashead *sah, *nextsah;
7420 struct secasvar *sav, *nextsav;
7422 sah = TAILQ_FIRST(flushq);
7423 while (sah != NULL) {
7424 sav = TAILQ_FIRST(&sah->savtree_larval);
7425 while (sav != NULL) {
7426 nextsav = TAILQ_NEXT(sav, chain);
7427 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7428 key_freesav(&sav); /* release last reference */
7429 key_freesah(&sah); /* release reference from SAV */
7432 sav = TAILQ_FIRST(&sah->savtree_alive);
7433 while (sav != NULL) {
7434 nextsav = TAILQ_NEXT(sav, chain);
7435 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7436 key_freesav(&sav); /* release last reference */
7437 key_freesah(&sah); /* release reference from SAV */
7440 nextsah = TAILQ_NEXT(sah, chain);
7441 key_freesah(&sah); /* release last reference */
7447 * SADB_FLUSH processing
7450 * from the ikmpd, and free all entries in secastree.
7454 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7456 * m will always be freed.
7459 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7461 struct secashead_queue flushq;
7462 struct sadb_msg *newmsg;
7463 struct secashead *sah, *nextsah;
7464 struct secasvar *sav;
7468 IPSEC_ASSERT(so != NULL, ("null socket"));
7469 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7470 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7472 /* map satype to proto */
7473 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7474 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7476 return key_senderror(so, m, EINVAL);
7479 printf("%s: proto %u\n", __func__, proto));
7481 TAILQ_INIT(&flushq);
7482 if (proto == IPSEC_PROTO_ANY) {
7483 /* no SATYPE specified, i.e. flushing all SA. */
7485 /* Move all SAHs into flushq */
7486 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7487 /* Flush all buckets in SPI hash */
7488 for (i = 0; i < V_savhash_mask + 1; i++)
7489 LIST_INIT(&V_savhashtbl[i]);
7490 /* Flush all buckets in SAHADDRHASH */
7491 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7492 LIST_INIT(&V_sahaddrhashtbl[i]);
7493 /* Mark all SAHs as unlinked */
7494 TAILQ_FOREACH(sah, &flushq, chain) {
7495 sah->state = SADB_SASTATE_DEAD;
7497 * Callout handler makes its job using
7498 * RLOCK and drain queues. In case, when this
7499 * function will be called just before it
7500 * acquires WLOCK, we need to mark SAs as
7501 * unlinked to prevent second unlink.
7503 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7504 sav->state = SADB_SASTATE_DEAD;
7506 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7507 sav->state = SADB_SASTATE_DEAD;
7513 sah = TAILQ_FIRST(&V_sahtree);
7514 while (sah != NULL) {
7515 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7516 ("DEAD SAH %p in SADB_FLUSH", sah));
7517 nextsah = TAILQ_NEXT(sah, chain);
7518 if (sah->saidx.proto != proto) {
7522 sah->state = SADB_SASTATE_DEAD;
7523 TAILQ_REMOVE(&V_sahtree, sah, chain);
7524 LIST_REMOVE(sah, addrhash);
7525 /* Unlink all SAs from SPI hash */
7526 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7527 LIST_REMOVE(sav, spihash);
7528 sav->state = SADB_SASTATE_DEAD;
7530 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7531 LIST_REMOVE(sav, spihash);
7532 sav->state = SADB_SASTATE_DEAD;
7534 /* Add SAH into flushq */
7535 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7541 key_freesah_flushed(&flushq);
7542 /* Free all queued SAs and SAHs */
7543 if (m->m_len < sizeof(struct sadb_msg) ||
7544 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7545 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7546 return key_senderror(so, m, ENOBUFS);
7552 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7553 newmsg = mtod(m, struct sadb_msg *);
7554 newmsg->sadb_msg_errno = 0;
7555 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7557 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7561 * SADB_DUMP processing
7562 * dump all entries including status of DEAD in SAD.
7565 * from the ikmpd, and dump all secasvar leaves
7570 * m will always be freed.
7573 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7575 SAHTREE_RLOCK_TRACKER;
7576 struct secashead *sah;
7577 struct secasvar *sav;
7580 uint8_t proto, satype;
7582 IPSEC_ASSERT(so != NULL, ("null socket"));
7583 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7584 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7585 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7587 /* map satype to proto */
7588 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7589 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7591 return key_senderror(so, m, EINVAL);
7594 /* count sav entries to be sent to the userland. */
7597 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7598 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7599 proto != sah->saidx.proto)
7602 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7604 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7610 return key_senderror(so, m, ENOENT);
7613 /* send this to the userland, one at a time. */
7614 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7615 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7616 proto != sah->saidx.proto)
7619 /* map proto to satype */
7620 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7622 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7623 "SAD.\n", __func__));
7624 return key_senderror(so, m, EINVAL);
7626 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7627 n = key_setdumpsa(sav, SADB_DUMP, satype,
7628 --cnt, mhp->msg->sadb_msg_pid);
7631 return key_senderror(so, m, ENOBUFS);
7633 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7635 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7636 n = key_setdumpsa(sav, SADB_DUMP, satype,
7637 --cnt, mhp->msg->sadb_msg_pid);
7640 return key_senderror(so, m, ENOBUFS);
7642 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7650 * SADB_X_PROMISC processing
7652 * m will always be freed.
7655 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7659 IPSEC_ASSERT(so != NULL, ("null socket"));
7660 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7661 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7662 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7664 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7666 if (olen < sizeof(struct sadb_msg)) {
7668 return key_senderror(so, m, EINVAL);
7673 } else if (olen == sizeof(struct sadb_msg)) {
7674 /* enable/disable promisc mode */
7677 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7678 return key_senderror(so, m, EINVAL);
7679 mhp->msg->sadb_msg_errno = 0;
7680 switch (mhp->msg->sadb_msg_satype) {
7683 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7686 return key_senderror(so, m, EINVAL);
7689 /* send the original message back to everyone */
7690 mhp->msg->sadb_msg_errno = 0;
7691 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7693 /* send packet as is */
7695 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7697 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7698 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7702 static int (*key_typesw[])(struct socket *, struct mbuf *,
7703 const struct sadb_msghdr *) = {
7704 NULL, /* SADB_RESERVED */
7705 key_getspi, /* SADB_GETSPI */
7706 key_update, /* SADB_UPDATE */
7707 key_add, /* SADB_ADD */
7708 key_delete, /* SADB_DELETE */
7709 key_get, /* SADB_GET */
7710 key_acquire2, /* SADB_ACQUIRE */
7711 key_register, /* SADB_REGISTER */
7712 NULL, /* SADB_EXPIRE */
7713 key_flush, /* SADB_FLUSH */
7714 key_dump, /* SADB_DUMP */
7715 key_promisc, /* SADB_X_PROMISC */
7716 NULL, /* SADB_X_PCHANGE */
7717 key_spdadd, /* SADB_X_SPDUPDATE */
7718 key_spdadd, /* SADB_X_SPDADD */
7719 key_spddelete, /* SADB_X_SPDDELETE */
7720 key_spdget, /* SADB_X_SPDGET */
7721 NULL, /* SADB_X_SPDACQUIRE */
7722 key_spddump, /* SADB_X_SPDDUMP */
7723 key_spdflush, /* SADB_X_SPDFLUSH */
7724 key_spdadd, /* SADB_X_SPDSETIDX */
7725 NULL, /* SADB_X_SPDEXPIRE */
7726 key_spddelete2, /* SADB_X_SPDDELETE2 */
7730 * parse sadb_msg buffer to process PFKEYv2,
7731 * and create a data to response if needed.
7732 * I think to be dealed with mbuf directly.
7734 * msgp : pointer to pointer to a received buffer pulluped.
7735 * This is rewrited to response.
7736 * so : pointer to socket.
7738 * length for buffer to send to user process.
7741 key_parse(struct mbuf *m, struct socket *so)
7743 struct sadb_msg *msg;
7744 struct sadb_msghdr mh;
7749 IPSEC_ASSERT(so != NULL, ("null socket"));
7750 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7752 if (m->m_len < sizeof(struct sadb_msg)) {
7753 m = m_pullup(m, sizeof(struct sadb_msg));
7757 msg = mtod(m, struct sadb_msg *);
7758 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7759 target = KEY_SENDUP_ONE;
7761 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7762 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7763 PFKEYSTAT_INC(out_invlen);
7768 if (msg->sadb_msg_version != PF_KEY_V2) {
7769 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7770 __func__, msg->sadb_msg_version));
7771 PFKEYSTAT_INC(out_invver);
7776 if (msg->sadb_msg_type > SADB_MAX) {
7777 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7778 __func__, msg->sadb_msg_type));
7779 PFKEYSTAT_INC(out_invmsgtype);
7784 /* for old-fashioned code - should be nuked */
7785 if (m->m_pkthdr.len > MCLBYTES) {
7792 MGETHDR(n, M_NOWAIT, MT_DATA);
7793 if (n && m->m_pkthdr.len > MHLEN) {
7794 if (!(MCLGET(n, M_NOWAIT))) {
7803 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7804 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7810 /* align the mbuf chain so that extensions are in contiguous region. */
7811 error = key_align(m, &mh);
7817 /* We use satype as scope mask for spddump */
7818 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7819 switch (msg->sadb_msg_satype) {
7820 case IPSEC_POLICYSCOPE_ANY:
7821 case IPSEC_POLICYSCOPE_GLOBAL:
7822 case IPSEC_POLICYSCOPE_IFNET:
7823 case IPSEC_POLICYSCOPE_PCB:
7826 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7827 __func__, msg->sadb_msg_type));
7828 PFKEYSTAT_INC(out_invsatype);
7833 switch (msg->sadb_msg_satype) { /* check SA type */
7834 case SADB_SATYPE_UNSPEC:
7835 switch (msg->sadb_msg_type) {
7843 ipseclog((LOG_DEBUG, "%s: must specify satype "
7844 "when msg type=%u.\n", __func__,
7845 msg->sadb_msg_type));
7846 PFKEYSTAT_INC(out_invsatype);
7851 case SADB_SATYPE_AH:
7852 case SADB_SATYPE_ESP:
7853 case SADB_X_SATYPE_IPCOMP:
7854 case SADB_X_SATYPE_TCPSIGNATURE:
7855 switch (msg->sadb_msg_type) {
7857 case SADB_X_SPDDELETE:
7859 case SADB_X_SPDFLUSH:
7860 case SADB_X_SPDSETIDX:
7861 case SADB_X_SPDUPDATE:
7862 case SADB_X_SPDDELETE2:
7863 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7864 __func__, msg->sadb_msg_type));
7865 PFKEYSTAT_INC(out_invsatype);
7870 case SADB_SATYPE_RSVP:
7871 case SADB_SATYPE_OSPFV2:
7872 case SADB_SATYPE_RIPV2:
7873 case SADB_SATYPE_MIP:
7874 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7875 __func__, msg->sadb_msg_satype));
7876 PFKEYSTAT_INC(out_invsatype);
7879 case 1: /* XXX: What does it do? */
7880 if (msg->sadb_msg_type == SADB_X_PROMISC)
7884 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7885 __func__, msg->sadb_msg_satype));
7886 PFKEYSTAT_INC(out_invsatype);
7892 /* check field of upper layer protocol and address family */
7893 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7894 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7895 struct sadb_address *src0, *dst0;
7898 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7899 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7901 /* check upper layer protocol */
7902 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7903 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7904 "mismatched.\n", __func__));
7905 PFKEYSTAT_INC(out_invaddr);
7911 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7912 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7913 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7915 PFKEYSTAT_INC(out_invaddr);
7919 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7920 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7921 ipseclog((LOG_DEBUG, "%s: address struct size "
7922 "mismatched.\n", __func__));
7923 PFKEYSTAT_INC(out_invaddr);
7928 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7930 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7931 sizeof(struct sockaddr_in)) {
7932 PFKEYSTAT_INC(out_invaddr);
7938 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7939 sizeof(struct sockaddr_in6)) {
7940 PFKEYSTAT_INC(out_invaddr);
7946 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7948 PFKEYSTAT_INC(out_invaddr);
7949 error = EAFNOSUPPORT;
7953 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7955 plen = sizeof(struct in_addr) << 3;
7958 plen = sizeof(struct in6_addr) << 3;
7961 plen = 0; /*fool gcc*/
7965 /* check max prefix length */
7966 if (src0->sadb_address_prefixlen > plen ||
7967 dst0->sadb_address_prefixlen > plen) {
7968 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7970 PFKEYSTAT_INC(out_invaddr);
7976 * prefixlen == 0 is valid because there can be a case when
7977 * all addresses are matched.
7981 if (msg->sadb_msg_type >= nitems(key_typesw) ||
7982 key_typesw[msg->sadb_msg_type] == NULL) {
7983 PFKEYSTAT_INC(out_invmsgtype);
7988 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
7991 msg->sadb_msg_errno = error;
7992 return key_sendup_mbuf(so, m, target);
7996 key_senderror(struct socket *so, struct mbuf *m, int code)
7998 struct sadb_msg *msg;
8000 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8001 ("mbuf too small, len %u", m->m_len));
8003 msg = mtod(m, struct sadb_msg *);
8004 msg->sadb_msg_errno = code;
8005 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
8009 * set the pointer to each header into message buffer.
8010 * m will be freed on error.
8011 * XXX larger-than-MCLBYTES extension?
8014 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
8017 struct sadb_ext *ext;
8022 IPSEC_ASSERT(m != NULL, ("null mbuf"));
8023 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
8024 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8025 ("mbuf too small, len %u", m->m_len));
8028 bzero(mhp, sizeof(*mhp));
8030 mhp->msg = mtod(m, struct sadb_msg *);
8031 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
8033 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
8034 extlen = end; /*just in case extlen is not updated*/
8035 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
8036 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
8038 /* m is already freed */
8041 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8044 switch (ext->sadb_ext_type) {
8046 case SADB_EXT_ADDRESS_SRC:
8047 case SADB_EXT_ADDRESS_DST:
8048 case SADB_EXT_ADDRESS_PROXY:
8049 case SADB_EXT_LIFETIME_CURRENT:
8050 case SADB_EXT_LIFETIME_HARD:
8051 case SADB_EXT_LIFETIME_SOFT:
8052 case SADB_EXT_KEY_AUTH:
8053 case SADB_EXT_KEY_ENCRYPT:
8054 case SADB_EXT_IDENTITY_SRC:
8055 case SADB_EXT_IDENTITY_DST:
8056 case SADB_EXT_SENSITIVITY:
8057 case SADB_EXT_PROPOSAL:
8058 case SADB_EXT_SUPPORTED_AUTH:
8059 case SADB_EXT_SUPPORTED_ENCRYPT:
8060 case SADB_EXT_SPIRANGE:
8061 case SADB_X_EXT_POLICY:
8062 case SADB_X_EXT_SA2:
8063 case SADB_X_EXT_NAT_T_TYPE:
8064 case SADB_X_EXT_NAT_T_SPORT:
8065 case SADB_X_EXT_NAT_T_DPORT:
8066 case SADB_X_EXT_NAT_T_OAI:
8067 case SADB_X_EXT_NAT_T_OAR:
8068 case SADB_X_EXT_NAT_T_FRAG:
8069 case SADB_X_EXT_SA_REPLAY:
8070 case SADB_X_EXT_NEW_ADDRESS_SRC:
8071 case SADB_X_EXT_NEW_ADDRESS_DST:
8072 /* duplicate check */
8074 * XXX Are there duplication payloads of either
8075 * KEY_AUTH or KEY_ENCRYPT ?
8077 if (mhp->ext[ext->sadb_ext_type] != NULL) {
8078 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
8079 "%u\n", __func__, ext->sadb_ext_type));
8081 PFKEYSTAT_INC(out_dupext);
8086 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
8087 __func__, ext->sadb_ext_type));
8089 PFKEYSTAT_INC(out_invexttype);
8093 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
8095 if (key_validate_ext(ext, extlen)) {
8097 PFKEYSTAT_INC(out_invlen);
8101 n = m_pulldown(m, off, extlen, &toff);
8103 /* m is already freed */
8106 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8108 mhp->ext[ext->sadb_ext_type] = ext;
8109 mhp->extoff[ext->sadb_ext_type] = off;
8110 mhp->extlen[ext->sadb_ext_type] = extlen;
8115 PFKEYSTAT_INC(out_invlen);
8123 key_validate_ext(const struct sadb_ext *ext, int len)
8125 const struct sockaddr *sa;
8126 enum { NONE, ADDR } checktype = NONE;
8128 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8130 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8133 /* if it does not match minimum/maximum length, bail */
8134 if (ext->sadb_ext_type >= nitems(minsize) ||
8135 ext->sadb_ext_type >= nitems(maxsize))
8137 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8139 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8142 /* more checks based on sadb_ext_type XXX need more */
8143 switch (ext->sadb_ext_type) {
8144 case SADB_EXT_ADDRESS_SRC:
8145 case SADB_EXT_ADDRESS_DST:
8146 case SADB_EXT_ADDRESS_PROXY:
8147 case SADB_X_EXT_NAT_T_OAI:
8148 case SADB_X_EXT_NAT_T_OAR:
8149 case SADB_X_EXT_NEW_ADDRESS_SRC:
8150 case SADB_X_EXT_NEW_ADDRESS_DST:
8151 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8154 case SADB_EXT_IDENTITY_SRC:
8155 case SADB_EXT_IDENTITY_DST:
8156 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8157 SADB_X_IDENTTYPE_ADDR) {
8158 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8168 switch (checktype) {
8172 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8173 if (len < baselen + sal)
8175 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8188 TUNABLE_INT_FETCH("net.key.spdcache.maxentries",
8189 &V_key_spdcache_maxentries);
8190 TUNABLE_INT_FETCH("net.key.spdcache.threshold",
8191 &V_key_spdcache_threshold);
8193 if (V_key_spdcache_maxentries) {
8194 V_key_spdcache_maxentries = MAX(V_key_spdcache_maxentries,
8195 SPDCACHE_MAX_ENTRIES_PER_HASH);
8196 V_spdcachehashtbl = hashinit(V_key_spdcache_maxentries /
8197 SPDCACHE_MAX_ENTRIES_PER_HASH,
8198 M_IPSEC_SPDCACHE, &V_spdcachehash_mask);
8199 V_key_spdcache_maxentries = (V_spdcachehash_mask + 1)
8200 * SPDCACHE_MAX_ENTRIES_PER_HASH;
8202 V_spdcache_lock = malloc(sizeof(struct mtx) *
8203 (V_spdcachehash_mask + 1),
8204 M_IPSEC_SPDCACHE, M_WAITOK|M_ZERO);
8206 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8207 SPDCACHE_LOCK_INIT(i);
8211 struct spdcache_entry *
8212 spdcache_entry_alloc(const struct secpolicyindex *spidx, struct secpolicy *sp)
8214 struct spdcache_entry *entry;
8216 entry = malloc(sizeof(struct spdcache_entry),
8217 M_IPSEC_SPDCACHE, M_NOWAIT|M_ZERO);
8224 entry->spidx = *spidx;
8231 spdcache_entry_free(struct spdcache_entry *entry)
8234 if (entry->sp != NULL)
8235 key_freesp(&entry->sp);
8236 free(entry, M_IPSEC_SPDCACHE);
8240 spdcache_clear(void)
8242 struct spdcache_entry *entry;
8245 for (i = 0; i < V_spdcachehash_mask + 1; ++i) {
8247 while (!LIST_EMPTY(&V_spdcachehashtbl[i])) {
8248 entry = LIST_FIRST(&V_spdcachehashtbl[i]);
8249 LIST_REMOVE(entry, chain);
8250 spdcache_entry_free(entry);
8258 spdcache_destroy(void)
8262 if (SPDCACHE_ENABLED()) {
8264 hashdestroy(V_spdcachehashtbl, M_IPSEC_SPDCACHE, V_spdcachehash_mask);
8266 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8267 SPDCACHE_LOCK_DESTROY(i);
8269 free(V_spdcache_lock, M_IPSEC_SPDCACHE);
8278 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8279 TAILQ_INIT(&V_sptree[i]);
8280 TAILQ_INIT(&V_sptree_ifnet[i]);
8283 V_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8284 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8285 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8287 TAILQ_INIT(&V_sahtree);
8288 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8289 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8290 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8291 &V_sahaddrhash_mask);
8292 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8293 &V_acqaddrhash_mask);
8294 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8295 &V_acqseqhash_mask);
8299 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8300 LIST_INIT(&V_regtree[i]);
8302 LIST_INIT(&V_acqtree);
8303 LIST_INIT(&V_spacqtree);
8305 if (!IS_DEFAULT_VNET(curvnet))
8309 REGTREE_LOCK_INIT();
8310 SAHTREE_LOCK_INIT();
8314 #ifndef IPSEC_DEBUG2
8315 callout_init(&key_timer, 1);
8316 callout_reset(&key_timer, hz, key_timehandler, NULL);
8317 #endif /*IPSEC_DEBUG2*/
8319 /* initialize key statistics */
8320 keystat.getspi_count = 1;
8323 printf("IPsec: Initialized Security Association Processing.\n");
8330 struct secashead_queue sahdrainq;
8331 struct secpolicy_queue drainq;
8332 struct secpolicy *sp, *nextsp;
8333 struct secacq *acq, *nextacq;
8334 struct secspacq *spacq, *nextspacq;
8335 struct secashead *sah;
8336 struct secasvar *sav;
8341 * XXX: can we just call free() for each object without
8342 * walking through safe way with releasing references?
8344 TAILQ_INIT(&drainq);
8346 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8347 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8348 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8350 for (i = 0; i < V_sphash_mask + 1; i++)
8351 LIST_INIT(&V_sphashtbl[i]);
8355 sp = TAILQ_FIRST(&drainq);
8356 while (sp != NULL) {
8357 nextsp = TAILQ_NEXT(sp, chain);
8362 TAILQ_INIT(&sahdrainq);
8364 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8365 for (i = 0; i < V_savhash_mask + 1; i++)
8366 LIST_INIT(&V_savhashtbl[i]);
8367 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8368 LIST_INIT(&V_sahaddrhashtbl[i]);
8369 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8370 sah->state = SADB_SASTATE_DEAD;
8371 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8372 sav->state = SADB_SASTATE_DEAD;
8374 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8375 sav->state = SADB_SASTATE_DEAD;
8380 key_freesah_flushed(&sahdrainq);
8381 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8382 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8383 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8386 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8387 LIST_FOREACH(reg, &V_regtree[i], chain) {
8388 if (__LIST_CHAINED(reg)) {
8389 LIST_REMOVE(reg, chain);
8390 free(reg, M_IPSEC_SAR);
8398 acq = LIST_FIRST(&V_acqtree);
8399 while (acq != NULL) {
8400 nextacq = LIST_NEXT(acq, chain);
8401 LIST_REMOVE(acq, chain);
8402 free(acq, M_IPSEC_SAQ);
8405 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8406 LIST_INIT(&V_acqaddrhashtbl[i]);
8407 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8408 LIST_INIT(&V_acqseqhashtbl[i]);
8412 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8413 spacq = nextspacq) {
8414 nextspacq = LIST_NEXT(spacq, chain);
8415 if (__LIST_CHAINED(spacq)) {
8416 LIST_REMOVE(spacq, chain);
8417 free(spacq, M_IPSEC_SAQ);
8421 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8422 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8423 uma_zdestroy(V_key_lft_zone);
8425 if (!IS_DEFAULT_VNET(curvnet))
8427 #ifndef IPSEC_DEBUG2
8428 callout_drain(&key_timer);
8430 SPTREE_LOCK_DESTROY();
8431 REGTREE_LOCK_DESTROY();
8432 SAHTREE_LOCK_DESTROY();
8434 SPACQ_LOCK_DESTROY();
8438 /* record data transfer on SA, and update timestamps */
8440 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8442 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8443 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8446 * XXX Currently, there is a difference of bytes size
8447 * between inbound and outbound processing.
8449 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8452 * We use the number of packets as the unit of
8453 * allocations. We increment the variable
8454 * whenever {esp,ah}_{in,out}put is called.
8456 counter_u64_add(sav->lft_c_allocations, 1);
8459 * NOTE: We record CURRENT usetime by using wall clock,
8460 * in seconds. HARD and SOFT lifetime are measured by the time
8461 * difference (again in seconds) from usetime.
8465 * -----+-----+--------+---> t
8466 * <--------------> HARD
8469 if (sav->firstused == 0)
8470 sav->firstused = time_second;
8474 * Take one of the kernel's security keys and convert it into a PF_KEY
8475 * structure within an mbuf, suitable for sending up to a waiting
8476 * application in user land.
8479 * src: A pointer to a kernel security key.
8480 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8482 * a valid mbuf or NULL indicating an error
8486 static struct mbuf *
8487 key_setkey(struct seckey *src, uint16_t exttype)
8496 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8497 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8502 p = mtod(m, struct sadb_key *);
8504 p->sadb_key_len = PFKEY_UNIT64(len);
8505 p->sadb_key_exttype = exttype;
8506 p->sadb_key_bits = src->bits;
8507 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8513 * Take one of the kernel's lifetime data structures and convert it
8514 * into a PF_KEY structure within an mbuf, suitable for sending up to
8515 * a waiting application in user land.
8518 * src: A pointer to a kernel lifetime structure.
8519 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8520 * data structures for more information.
8522 * a valid mbuf or NULL indicating an error
8526 static struct mbuf *
8527 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8529 struct mbuf *m = NULL;
8530 struct sadb_lifetime *p;
8531 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8536 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8541 p = mtod(m, struct sadb_lifetime *);
8544 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8545 p->sadb_lifetime_exttype = exttype;
8546 p->sadb_lifetime_allocations = src->allocations;
8547 p->sadb_lifetime_bytes = src->bytes;
8548 p->sadb_lifetime_addtime = src->addtime;
8549 p->sadb_lifetime_usetime = src->usetime;
8555 const struct enc_xform *
8556 enc_algorithm_lookup(int alg)
8560 for (i = 0; i < nitems(supported_ealgs); i++)
8561 if (alg == supported_ealgs[i].sadb_alg)
8562 return (supported_ealgs[i].xform);
8566 const struct auth_hash *
8567 auth_algorithm_lookup(int alg)
8571 for (i = 0; i < nitems(supported_aalgs); i++)
8572 if (alg == supported_aalgs[i].sadb_alg)
8573 return (supported_aalgs[i].xform);
8577 const struct comp_algo *
8578 comp_algorithm_lookup(int alg)
8582 for (i = 0; i < nitems(supported_calgs); i++)
8583 if (alg == supported_calgs[i].sadb_alg)
8584 return (supported_calgs[i].xform);