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, CTLFLAG_RW, 0, "SPD cache");
513 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, maxentries,
514 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_maxentries), 0,
515 "Maximum number of entries in the SPD cache"
516 " (power of 2, 0 to disable)");
518 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, threshold,
519 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_threshold), 0,
520 "Number of SPs that make the SPD cache active");
522 #define __LIST_CHAINED(elm) \
523 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
525 MALLOC_DEFINE(M_IPSEC_SA, "secasvar", "ipsec security association");
526 MALLOC_DEFINE(M_IPSEC_SAH, "sahead", "ipsec sa head");
527 MALLOC_DEFINE(M_IPSEC_SP, "ipsecpolicy", "ipsec security policy");
528 MALLOC_DEFINE(M_IPSEC_SR, "ipsecrequest", "ipsec security request");
529 MALLOC_DEFINE(M_IPSEC_MISC, "ipsec-misc", "ipsec miscellaneous");
530 MALLOC_DEFINE(M_IPSEC_SAQ, "ipsec-saq", "ipsec sa acquire");
531 MALLOC_DEFINE(M_IPSEC_SAR, "ipsec-reg", "ipsec sa acquire");
532 MALLOC_DEFINE(M_IPSEC_SPDCACHE, "ipsec-spdcache", "ipsec SPD cache");
534 VNET_DEFINE_STATIC(uma_zone_t, key_lft_zone);
535 #define V_key_lft_zone VNET(key_lft_zone)
538 * set parameters into secpolicyindex buffer.
539 * Must allocate secpolicyindex buffer passed to this function.
541 #define KEY_SETSECSPIDX(_dir, s, d, ps, pd, ulp, idx) \
543 bzero((idx), sizeof(struct secpolicyindex)); \
544 (idx)->dir = (_dir); \
545 (idx)->prefs = (ps); \
546 (idx)->prefd = (pd); \
547 (idx)->ul_proto = (ulp); \
548 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
549 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
553 * set parameters into secasindex buffer.
554 * Must allocate secasindex buffer before calling this function.
556 #define KEY_SETSECASIDX(p, m, r, s, d, idx) \
558 bzero((idx), sizeof(struct secasindex)); \
559 (idx)->proto = (p); \
561 (idx)->reqid = (r); \
562 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
563 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
564 key_porttosaddr(&(idx)->src.sa, 0); \
565 key_porttosaddr(&(idx)->dst.sa, 0); \
570 u_long getspi_count; /* the avarage of count to try to get new SPI */
574 struct sadb_msg *msg;
575 struct sadb_ext *ext[SADB_EXT_MAX + 1];
576 int extoff[SADB_EXT_MAX + 1];
577 int extlen[SADB_EXT_MAX + 1];
580 static struct supported_ealgs {
582 const struct enc_xform *xform;
583 } supported_ealgs[] = {
584 { SADB_EALG_DESCBC, &enc_xform_des },
585 { SADB_EALG_3DESCBC, &enc_xform_3des },
586 { SADB_X_EALG_AES, &enc_xform_rijndael128 },
587 { SADB_X_EALG_BLOWFISHCBC, &enc_xform_blf },
588 { SADB_X_EALG_CAST128CBC, &enc_xform_cast5 },
589 { SADB_EALG_NULL, &enc_xform_null },
590 { SADB_X_EALG_CAMELLIACBC, &enc_xform_camellia },
591 { SADB_X_EALG_AESCTR, &enc_xform_aes_icm },
592 { SADB_X_EALG_AESGCM16, &enc_xform_aes_nist_gcm },
593 { SADB_X_EALG_AESGMAC, &enc_xform_aes_nist_gmac },
596 static struct supported_aalgs {
598 const struct auth_hash *xform;
599 } supported_aalgs[] = {
600 { SADB_X_AALG_NULL, &auth_hash_null },
601 { SADB_AALG_MD5HMAC, &auth_hash_hmac_md5 },
602 { SADB_AALG_SHA1HMAC, &auth_hash_hmac_sha1 },
603 { SADB_X_AALG_RIPEMD160HMAC, &auth_hash_hmac_ripemd_160 },
604 { SADB_X_AALG_MD5, &auth_hash_key_md5 },
605 { SADB_X_AALG_SHA, &auth_hash_key_sha1 },
606 { SADB_X_AALG_SHA2_256, &auth_hash_hmac_sha2_256 },
607 { SADB_X_AALG_SHA2_384, &auth_hash_hmac_sha2_384 },
608 { SADB_X_AALG_SHA2_512, &auth_hash_hmac_sha2_512 },
609 { SADB_X_AALG_AES128GMAC, &auth_hash_nist_gmac_aes_128 },
610 { SADB_X_AALG_AES192GMAC, &auth_hash_nist_gmac_aes_192 },
611 { SADB_X_AALG_AES256GMAC, &auth_hash_nist_gmac_aes_256 },
614 static struct supported_calgs {
616 const struct comp_algo *xform;
617 } supported_calgs[] = {
618 { SADB_X_CALG_DEFLATE, &comp_algo_deflate },
622 static struct callout key_timer;
625 static void key_unlink(struct secpolicy *);
626 static struct secpolicy *key_do_allocsp(struct secpolicyindex *spidx, u_int dir);
627 static struct secpolicy *key_getsp(struct secpolicyindex *);
628 static struct secpolicy *key_getspbyid(u_int32_t);
629 static struct mbuf *key_gather_mbuf(struct mbuf *,
630 const struct sadb_msghdr *, int, int, ...);
631 static int key_spdadd(struct socket *, struct mbuf *,
632 const struct sadb_msghdr *);
633 static uint32_t key_getnewspid(void);
634 static int key_spddelete(struct socket *, struct mbuf *,
635 const struct sadb_msghdr *);
636 static int key_spddelete2(struct socket *, struct mbuf *,
637 const struct sadb_msghdr *);
638 static int key_spdget(struct socket *, struct mbuf *,
639 const struct sadb_msghdr *);
640 static int key_spdflush(struct socket *, struct mbuf *,
641 const struct sadb_msghdr *);
642 static int key_spddump(struct socket *, struct mbuf *,
643 const struct sadb_msghdr *);
644 static struct mbuf *key_setdumpsp(struct secpolicy *,
645 u_int8_t, u_int32_t, u_int32_t);
646 static struct mbuf *key_sp2mbuf(struct secpolicy *);
647 static size_t key_getspreqmsglen(struct secpolicy *);
648 static int key_spdexpire(struct secpolicy *);
649 static struct secashead *key_newsah(struct secasindex *);
650 static void key_freesah(struct secashead **);
651 static void key_delsah(struct secashead *);
652 static struct secasvar *key_newsav(const struct sadb_msghdr *,
653 struct secasindex *, uint32_t, int *);
654 static void key_delsav(struct secasvar *);
655 static void key_unlinksav(struct secasvar *);
656 static struct secashead *key_getsah(struct secasindex *);
657 static int key_checkspidup(uint32_t);
658 static struct secasvar *key_getsavbyspi(uint32_t);
659 static int key_setnatt(struct secasvar *, const struct sadb_msghdr *);
660 static int key_setsaval(struct secasvar *, const struct sadb_msghdr *);
661 static int key_updatelifetimes(struct secasvar *, const struct sadb_msghdr *);
662 static int key_updateaddresses(struct socket *, struct mbuf *,
663 const struct sadb_msghdr *, struct secasvar *, struct secasindex *);
665 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
666 u_int8_t, u_int32_t, u_int32_t);
667 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
668 u_int32_t, pid_t, u_int16_t);
669 static struct mbuf *key_setsadbsa(struct secasvar *);
670 static struct mbuf *key_setsadbaddr(u_int16_t,
671 const struct sockaddr *, u_int8_t, u_int16_t);
672 static struct mbuf *key_setsadbxport(u_int16_t, u_int16_t);
673 static struct mbuf *key_setsadbxtype(u_int16_t);
674 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t);
675 static struct mbuf *key_setsadbxsareplay(u_int32_t);
676 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
677 u_int32_t, u_int32_t);
678 static struct seckey *key_dup_keymsg(const struct sadb_key *, size_t,
679 struct malloc_type *);
680 static struct seclifetime *key_dup_lifemsg(const struct sadb_lifetime *src,
681 struct malloc_type *);
683 /* flags for key_cmpsaidx() */
684 #define CMP_HEAD 1 /* protocol, addresses. */
685 #define CMP_MODE_REQID 2 /* additionally HEAD, reqid, mode. */
686 #define CMP_REQID 3 /* additionally HEAD, reaid. */
687 #define CMP_EXACTLY 4 /* all elements. */
688 static int key_cmpsaidx(const struct secasindex *,
689 const struct secasindex *, int);
690 static int key_cmpspidx_exactly(struct secpolicyindex *,
691 struct secpolicyindex *);
692 static int key_cmpspidx_withmask(struct secpolicyindex *,
693 struct secpolicyindex *);
694 static int key_bbcmp(const void *, const void *, u_int);
695 static uint8_t key_satype2proto(uint8_t);
696 static uint8_t key_proto2satype(uint8_t);
698 static int key_getspi(struct socket *, struct mbuf *,
699 const struct sadb_msghdr *);
700 static uint32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
701 static int key_update(struct socket *, struct mbuf *,
702 const struct sadb_msghdr *);
703 static int key_add(struct socket *, struct mbuf *,
704 const struct sadb_msghdr *);
705 static int key_setident(struct secashead *, const struct sadb_msghdr *);
706 static struct mbuf *key_getmsgbuf_x1(struct mbuf *,
707 const struct sadb_msghdr *);
708 static int key_delete(struct socket *, struct mbuf *,
709 const struct sadb_msghdr *);
710 static int key_delete_all(struct socket *, struct mbuf *,
711 const struct sadb_msghdr *, struct secasindex *);
712 static int key_get(struct socket *, struct mbuf *,
713 const struct sadb_msghdr *);
715 static void key_getcomb_setlifetime(struct sadb_comb *);
716 static struct mbuf *key_getcomb_ealg(void);
717 static struct mbuf *key_getcomb_ah(void);
718 static struct mbuf *key_getcomb_ipcomp(void);
719 static struct mbuf *key_getprop(const struct secasindex *);
721 static int key_acquire(const struct secasindex *, struct secpolicy *);
722 static uint32_t key_newacq(const struct secasindex *, int *);
723 static uint32_t key_getacq(const struct secasindex *, int *);
724 static int key_acqdone(const struct secasindex *, uint32_t);
725 static int key_acqreset(uint32_t);
726 static struct secspacq *key_newspacq(struct secpolicyindex *);
727 static struct secspacq *key_getspacq(struct secpolicyindex *);
728 static int key_acquire2(struct socket *, struct mbuf *,
729 const struct sadb_msghdr *);
730 static int key_register(struct socket *, struct mbuf *,
731 const struct sadb_msghdr *);
732 static int key_expire(struct secasvar *, int);
733 static int key_flush(struct socket *, struct mbuf *,
734 const struct sadb_msghdr *);
735 static int key_dump(struct socket *, struct mbuf *,
736 const struct sadb_msghdr *);
737 static int key_promisc(struct socket *, struct mbuf *,
738 const struct sadb_msghdr *);
739 static int key_senderror(struct socket *, struct mbuf *, int);
740 static int key_validate_ext(const struct sadb_ext *, int);
741 static int key_align(struct mbuf *, struct sadb_msghdr *);
742 static struct mbuf *key_setlifetime(struct seclifetime *, uint16_t);
743 static struct mbuf *key_setkey(struct seckey *, uint16_t);
745 static void spdcache_init(void);
746 static void spdcache_clear(void);
747 static struct spdcache_entry *spdcache_entry_alloc(
748 const struct secpolicyindex *spidx,
749 struct secpolicy *policy);
750 static void spdcache_entry_free(struct spdcache_entry *entry);
752 static void spdcache_destroy(void);
755 #define DBG_IPSEC_INITREF(t, p) do { \
756 refcount_init(&(p)->refcnt, 1); \
758 printf("%s: Initialize refcnt %s(%p) = %u\n", \
759 __func__, #t, (p), (p)->refcnt)); \
761 #define DBG_IPSEC_ADDREF(t, p) do { \
762 refcount_acquire(&(p)->refcnt); \
764 printf("%s: Acquire refcnt %s(%p) -> %u\n", \
765 __func__, #t, (p), (p)->refcnt)); \
767 #define DBG_IPSEC_DELREF(t, p) do { \
769 printf("%s: Release refcnt %s(%p) -> %u\n", \
770 __func__, #t, (p), (p)->refcnt - 1)); \
771 refcount_release(&(p)->refcnt); \
774 #define IPSEC_INITREF(t, p) refcount_init(&(p)->refcnt, 1)
775 #define IPSEC_ADDREF(t, p) refcount_acquire(&(p)->refcnt)
776 #define IPSEC_DELREF(t, p) refcount_release(&(p)->refcnt)
778 #define SP_INITREF(p) IPSEC_INITREF(SP, p)
779 #define SP_ADDREF(p) IPSEC_ADDREF(SP, p)
780 #define SP_DELREF(p) IPSEC_DELREF(SP, p)
782 #define SAH_INITREF(p) IPSEC_INITREF(SAH, p)
783 #define SAH_ADDREF(p) IPSEC_ADDREF(SAH, p)
784 #define SAH_DELREF(p) IPSEC_DELREF(SAH, p)
786 #define SAV_INITREF(p) IPSEC_INITREF(SAV, p)
787 #define SAV_ADDREF(p) IPSEC_ADDREF(SAV, p)
788 #define SAV_DELREF(p) IPSEC_DELREF(SAV, p)
791 * Update the refcnt while holding the SPTREE lock.
794 key_addref(struct secpolicy *sp)
801 * Return 0 when there are known to be no SP's for the specified
802 * direction. Otherwise return 1. This is used by IPsec code
803 * to optimize performance.
806 key_havesp(u_int dir)
809 return (dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND ?
810 TAILQ_FIRST(&V_sptree[dir]) != NULL : 1);
813 /* %%% IPsec policy management */
815 * Return current SPDB generation.
832 key_checksockaddrs(struct sockaddr *src, struct sockaddr *dst)
836 if (src->sa_family != dst->sa_family)
839 if (src->sa_len != dst->sa_len)
841 switch (src->sa_family) {
844 if (src->sa_len != sizeof(struct sockaddr_in))
850 if (src->sa_len != sizeof(struct sockaddr_in6))
855 return (EAFNOSUPPORT);
861 key_do_allocsp(struct secpolicyindex *spidx, u_int dir)
863 SPTREE_RLOCK_TRACKER;
864 struct secpolicy *sp;
866 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
867 IPSEC_ASSERT(dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND,
868 ("invalid direction %u", dir));
871 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
872 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
883 * allocating a SP for OUTBOUND or INBOUND packet.
884 * Must call key_freesp() later.
885 * OUT: NULL: not found
886 * others: found and return the pointer.
889 key_allocsp(struct secpolicyindex *spidx, u_int dir)
891 struct spdcache_entry *entry, *lastentry, *tmpentry;
892 struct secpolicy *sp;
896 if (!SPDCACHE_ACTIVE()) {
897 sp = key_do_allocsp(spidx, dir);
901 hashv = SPDCACHE_HASHVAL(spidx);
902 SPDCACHE_LOCK(hashv);
904 LIST_FOREACH_SAFE(entry, &V_spdcachehashtbl[hashv], chain, tmpentry) {
905 /* Removed outdated entries */
906 if (entry->sp != NULL &&
907 entry->sp->state == IPSEC_SPSTATE_DEAD) {
908 LIST_REMOVE(entry, chain);
909 spdcache_entry_free(entry);
914 if (!key_cmpspidx_exactly(&entry->spidx, spidx)) {
920 if (entry->sp != NULL)
923 /* IPSECSTAT_INC(ips_spdcache_hits); */
925 SPDCACHE_UNLOCK(hashv);
929 /* IPSECSTAT_INC(ips_spdcache_misses); */
931 sp = key_do_allocsp(spidx, dir);
932 entry = spdcache_entry_alloc(spidx, sp);
934 if (nb_entries >= SPDCACHE_MAX_ENTRIES_PER_HASH) {
935 LIST_REMOVE(lastentry, chain);
936 spdcache_entry_free(lastentry);
939 LIST_INSERT_HEAD(&V_spdcachehashtbl[hashv], entry, chain);
942 SPDCACHE_UNLOCK(hashv);
945 if (sp != NULL) { /* found a SPD entry */
946 sp->lastused = time_second;
948 printf("%s: return SP(%p)\n", __func__, sp));
949 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
952 printf("%s: lookup failed for ", __func__);
953 kdebug_secpolicyindex(spidx, NULL));
959 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
960 * or should be signed by MD5 signature.
961 * We don't use key_allocsa() for such lookups, because we don't know SPI.
962 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
963 * signed packet. We use SADB only as storage for password.
964 * OUT: positive: corresponding SA for given saidx found.
968 key_allocsa_tcpmd5(struct secasindex *saidx)
970 SAHTREE_RLOCK_TRACKER;
971 struct secashead *sah;
972 struct secasvar *sav;
974 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
975 ("unexpected security protocol %u", saidx->proto));
976 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
977 ("unexpected mode %u", saidx->mode));
980 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
982 printf("%s: checking SAH\n", __func__);
983 kdebug_secash(sah, " "));
984 if (sah->saidx.proto != IPPROTO_TCP)
986 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
987 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
991 if (V_key_preferred_oldsa)
992 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
994 sav = TAILQ_FIRST(&sah->savtree_alive);
1003 printf("%s: return SA(%p)\n", __func__, sav));
1004 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1007 printf("%s: SA not found\n", __func__));
1008 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1014 * Allocating an SA entry for an *OUTBOUND* packet.
1015 * OUT: positive: corresponding SA for given saidx found.
1016 * NULL: SA not found, but will be acquired, check *error
1017 * for acquiring status.
1020 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
1023 SAHTREE_RLOCK_TRACKER;
1024 struct secashead *sah;
1025 struct secasvar *sav;
1027 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
1028 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
1029 saidx->mode == IPSEC_MODE_TUNNEL,
1030 ("unexpected policy %u", saidx->mode));
1033 * We check new SA in the IPsec request because a different
1034 * SA may be involved each time this request is checked, either
1035 * because new SAs are being configured, or this request is
1036 * associated with an unconnected datagram socket, or this request
1037 * is associated with a system default policy.
1040 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
1042 printf("%s: checking SAH\n", __func__);
1043 kdebug_secash(sah, " "));
1044 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
1050 * Allocate the oldest SA available according to
1051 * draft-jenkins-ipsec-rekeying-03.
1053 if (V_key_preferred_oldsa)
1054 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1056 sav = TAILQ_FIRST(&sah->savtree_alive);
1066 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
1068 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1069 return (sav); /* return referenced SA */
1072 /* there is no SA */
1073 *error = key_acquire(saidx, sp);
1075 ipseclog((LOG_DEBUG,
1076 "%s: error %d returned from key_acquire()\n",
1079 printf("%s: acquire SA for SP(%p), error %d\n",
1080 __func__, sp, *error));
1081 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1086 * allocating a usable SA entry for a *INBOUND* packet.
1087 * Must call key_freesav() later.
1088 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
1089 * NULL: not found, or error occurred.
1091 * According to RFC 2401 SA is uniquely identified by a triple SPI,
1092 * destination address, and security protocol. But according to RFC 4301,
1093 * SPI by itself suffices to specify an SA.
1095 * Note that, however, we do need to keep source address in IPsec SA.
1096 * IKE specification and PF_KEY specification do assume that we
1097 * keep source address in IPsec SA. We see a tricky situation here.
1100 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
1102 SAHTREE_RLOCK_TRACKER;
1103 struct secasvar *sav;
1105 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
1106 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
1110 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
1111 if (sav->spi == spi)
1115 * We use single SPI namespace for all protocols, so it is
1116 * impossible to have SPI duplicates in the SAVHASH.
1119 if (sav->state != SADB_SASTATE_LARVAL &&
1120 sav->sah->saidx.proto == proto &&
1121 key_sockaddrcmp(&dst->sa,
1122 &sav->sah->saidx.dst.sa, 0) == 0)
1131 char buf[IPSEC_ADDRSTRLEN];
1132 printf("%s: SA not found for spi %u proto %u dst %s\n",
1133 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1137 printf("%s: return SA(%p)\n", __func__, sav));
1138 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1144 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1147 SAHTREE_RLOCK_TRACKER;
1148 struct secasindex saidx;
1149 struct secashead *sah;
1150 struct secasvar *sav;
1152 IPSEC_ASSERT(src != NULL, ("null src address"));
1153 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1155 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1160 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1161 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1163 if (proto != sah->saidx.proto)
1165 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1167 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1169 /* XXXAE: is key_preferred_oldsa reasonably?*/
1170 if (V_key_preferred_oldsa)
1171 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1173 sav = TAILQ_FIRST(&sah->savtree_alive);
1181 printf("%s: return SA(%p)\n", __func__, sav));
1183 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1188 * Must be called after calling key_allocsp().
1191 key_freesp(struct secpolicy **spp)
1193 struct secpolicy *sp = *spp;
1195 IPSEC_ASSERT(sp != NULL, ("null sp"));
1196 if (SP_DELREF(sp) == 0)
1200 printf("%s: last reference to SP(%p)\n", __func__, sp));
1201 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1204 while (sp->tcount > 0)
1205 ipsec_delisr(sp->req[--sp->tcount]);
1206 free(sp, M_IPSEC_SP);
1210 key_unlink(struct secpolicy *sp)
1213 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1214 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1215 ("invalid direction %u", sp->spidx.dir));
1216 SPTREE_UNLOCK_ASSERT();
1219 printf("%s: SP(%p)\n", __func__, sp));
1221 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1222 /* SP is already unlinked */
1226 sp->state = IPSEC_SPSTATE_DEAD;
1227 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1229 LIST_REMOVE(sp, idhash);
1232 if (SPDCACHE_ENABLED())
1238 * insert a secpolicy into the SP database. Lower priorities first
1241 key_insertsp(struct secpolicy *newsp)
1243 struct secpolicy *sp;
1245 SPTREE_WLOCK_ASSERT();
1246 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1247 if (newsp->priority < sp->priority) {
1248 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1252 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1254 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1255 newsp->state = IPSEC_SPSTATE_ALIVE;
1261 * Insert a bunch of VTI secpolicies into the SPDB.
1262 * We keep VTI policies in the separate list due to following reasons:
1263 * 1) they should be immutable to user's or some deamon's attempts to
1264 * delete. The only way delete such policies - destroy or unconfigure
1265 * corresponding virtual inteface.
1266 * 2) such policies have traffic selector that matches all traffic per
1268 * Since all VTI policies have the same priority, we don't care about
1272 key_register_ifnet(struct secpolicy **spp, u_int count)
1279 * First of try to acquire id for each SP.
1281 for (i = 0; i < count; i++) {
1282 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1283 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1284 ("invalid direction %u", spp[i]->spidx.dir));
1286 if ((spp[i]->id = key_getnewspid()) == 0) {
1291 for (i = 0; i < count; i++) {
1292 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1295 * NOTE: despite the fact that we keep VTI SP in the
1296 * separate list, SPHASH contains policies from both
1297 * sources. Thus SADB_X_SPDGET will correctly return
1298 * SP by id, because it uses SPHASH for lookups.
1300 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1301 spp[i]->state = IPSEC_SPSTATE_IFNET;
1305 * Notify user processes about new SP.
1307 for (i = 0; i < count; i++) {
1308 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1310 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1316 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1322 for (i = 0; i < count; i++) {
1323 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1324 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1325 ("invalid direction %u", spp[i]->spidx.dir));
1327 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1329 spp[i]->state = IPSEC_SPSTATE_DEAD;
1330 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1333 LIST_REMOVE(spp[i], idhash);
1336 if (SPDCACHE_ENABLED())
1339 for (i = 0; i < count; i++) {
1340 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1342 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1347 * Must be called after calling key_allocsa().
1348 * This function is called by key_freesp() to free some SA allocated
1352 key_freesav(struct secasvar **psav)
1354 struct secasvar *sav = *psav;
1356 IPSEC_ASSERT(sav != NULL, ("null sav"));
1357 if (SAV_DELREF(sav) == 0)
1361 printf("%s: last reference to SA(%p)\n", __func__, sav));
1368 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1369 * Expect that SA has extra reference due to lookup.
1370 * Release this references, also release SAH reference after unlink.
1373 key_unlinksav(struct secasvar *sav)
1375 struct secashead *sah;
1378 printf("%s: SA(%p)\n", __func__, sav));
1380 SAHTREE_UNLOCK_ASSERT();
1382 if (sav->state == SADB_SASTATE_DEAD) {
1383 /* SA is already unlinked */
1387 /* Unlink from SAH */
1388 if (sav->state == SADB_SASTATE_LARVAL)
1389 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1391 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1392 /* Unlink from SPI hash */
1393 LIST_REMOVE(sav, spihash);
1394 sav->state = SADB_SASTATE_DEAD;
1398 /* Since we are unlinked, release reference to SAH */
1402 /* %%% SPD management */
1405 * OUT: NULL : not found
1406 * others : found, pointer to a SP.
1408 static struct secpolicy *
1409 key_getsp(struct secpolicyindex *spidx)
1411 SPTREE_RLOCK_TRACKER;
1412 struct secpolicy *sp;
1414 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1417 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1418 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1430 * OUT: NULL : not found
1431 * others : found, pointer to referenced SP.
1433 static struct secpolicy *
1434 key_getspbyid(uint32_t id)
1436 SPTREE_RLOCK_TRACKER;
1437 struct secpolicy *sp;
1440 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1453 struct secpolicy *sp;
1455 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1461 struct ipsecrequest *
1465 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1466 M_NOWAIT | M_ZERO));
1470 ipsec_delisr(struct ipsecrequest *p)
1473 free(p, M_IPSEC_SR);
1477 * create secpolicy structure from sadb_x_policy structure.
1478 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1479 * are not set, so must be set properly later.
1482 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1484 struct secpolicy *newsp;
1486 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1487 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1489 if (len != PFKEY_EXTLEN(xpl0)) {
1490 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1495 if ((newsp = key_newsp()) == NULL) {
1500 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1501 newsp->policy = xpl0->sadb_x_policy_type;
1502 newsp->priority = xpl0->sadb_x_policy_priority;
1506 switch (xpl0->sadb_x_policy_type) {
1507 case IPSEC_POLICY_DISCARD:
1508 case IPSEC_POLICY_NONE:
1509 case IPSEC_POLICY_ENTRUST:
1510 case IPSEC_POLICY_BYPASS:
1513 case IPSEC_POLICY_IPSEC:
1515 struct sadb_x_ipsecrequest *xisr;
1516 struct ipsecrequest *isr;
1519 /* validity check */
1520 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1521 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1528 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1529 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1533 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1534 xisr->sadb_x_ipsecrequest_len > tlen) {
1535 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1536 "length.\n", __func__));
1542 if (newsp->tcount >= IPSEC_MAXREQ) {
1543 ipseclog((LOG_DEBUG,
1544 "%s: too many ipsecrequests.\n",
1551 /* allocate request buffer */
1552 /* NB: data structure is zero'd */
1553 isr = ipsec_newisr();
1555 ipseclog((LOG_DEBUG,
1556 "%s: No more memory.\n", __func__));
1562 newsp->req[newsp->tcount++] = isr;
1565 switch (xisr->sadb_x_ipsecrequest_proto) {
1568 case IPPROTO_IPCOMP:
1571 ipseclog((LOG_DEBUG,
1572 "%s: invalid proto type=%u\n", __func__,
1573 xisr->sadb_x_ipsecrequest_proto));
1575 *error = EPROTONOSUPPORT;
1579 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1581 switch (xisr->sadb_x_ipsecrequest_mode) {
1582 case IPSEC_MODE_TRANSPORT:
1583 case IPSEC_MODE_TUNNEL:
1585 case IPSEC_MODE_ANY:
1587 ipseclog((LOG_DEBUG,
1588 "%s: invalid mode=%u\n", __func__,
1589 xisr->sadb_x_ipsecrequest_mode));
1594 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1596 switch (xisr->sadb_x_ipsecrequest_level) {
1597 case IPSEC_LEVEL_DEFAULT:
1598 case IPSEC_LEVEL_USE:
1599 case IPSEC_LEVEL_REQUIRE:
1601 case IPSEC_LEVEL_UNIQUE:
1602 /* validity check */
1604 * If range violation of reqid, kernel will
1605 * update it, don't refuse it.
1607 if (xisr->sadb_x_ipsecrequest_reqid
1608 > IPSEC_MANUAL_REQID_MAX) {
1609 ipseclog((LOG_DEBUG,
1610 "%s: reqid=%d range "
1611 "violation, updated by kernel.\n",
1613 xisr->sadb_x_ipsecrequest_reqid));
1614 xisr->sadb_x_ipsecrequest_reqid = 0;
1617 /* allocate new reqid id if reqid is zero. */
1618 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1620 if ((reqid = key_newreqid()) == 0) {
1625 isr->saidx.reqid = reqid;
1626 xisr->sadb_x_ipsecrequest_reqid = reqid;
1628 /* set it for manual keying. */
1630 xisr->sadb_x_ipsecrequest_reqid;
1635 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1637 xisr->sadb_x_ipsecrequest_level));
1642 isr->level = xisr->sadb_x_ipsecrequest_level;
1644 /* set IP addresses if there */
1645 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1646 struct sockaddr *paddr;
1648 len = tlen - sizeof(*xisr);
1649 paddr = (struct sockaddr *)(xisr + 1);
1650 /* validity check */
1651 if (len < sizeof(struct sockaddr) ||
1652 len < 2 * paddr->sa_len ||
1653 paddr->sa_len > sizeof(isr->saidx.src)) {
1654 ipseclog((LOG_DEBUG, "%s: invalid "
1655 "request address length.\n",
1662 * Request length should be enough to keep
1663 * source and destination addresses.
1665 if (xisr->sadb_x_ipsecrequest_len <
1666 sizeof(*xisr) + 2 * paddr->sa_len) {
1667 ipseclog((LOG_DEBUG, "%s: invalid "
1668 "ipsecrequest length.\n",
1674 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1675 paddr = (struct sockaddr *)((caddr_t)paddr +
1678 /* validity check */
1679 if (paddr->sa_len !=
1680 isr->saidx.src.sa.sa_len) {
1681 ipseclog((LOG_DEBUG, "%s: invalid "
1682 "request address length.\n",
1688 /* AF family should match */
1689 if (paddr->sa_family !=
1690 isr->saidx.src.sa.sa_family) {
1691 ipseclog((LOG_DEBUG, "%s: address "
1692 "family doesn't match.\n",
1698 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1701 * Addresses for TUNNEL mode requests are
1704 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1705 ipseclog((LOG_DEBUG, "%s: missing "
1706 "request addresses.\n", __func__));
1712 tlen -= xisr->sadb_x_ipsecrequest_len;
1714 /* validity check */
1716 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1723 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1724 + xisr->sadb_x_ipsecrequest_len);
1726 /* XXXAE: LARVAL SP */
1727 if (newsp->tcount < 1) {
1728 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1729 "not found.\n", __func__));
1737 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1750 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1752 if (auto_reqid == ~0)
1753 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1757 /* XXX should be unique check */
1758 return (auto_reqid);
1762 * copy secpolicy struct to sadb_x_policy structure indicated.
1764 static struct mbuf *
1765 key_sp2mbuf(struct secpolicy *sp)
1770 tlen = key_getspreqmsglen(sp);
1771 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1776 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1784 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1786 struct sadb_x_ipsecrequest *xisr;
1787 struct sadb_x_policy *xpl;
1788 struct ipsecrequest *isr;
1793 IPSEC_ASSERT(sp != NULL, ("null policy"));
1795 xlen = sizeof(*xpl);
1800 bzero(request, *len);
1801 xpl = (struct sadb_x_policy *)request;
1802 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1803 xpl->sadb_x_policy_type = sp->policy;
1804 xpl->sadb_x_policy_dir = sp->spidx.dir;
1805 xpl->sadb_x_policy_id = sp->id;
1806 xpl->sadb_x_policy_priority = sp->priority;
1807 switch (sp->state) {
1808 case IPSEC_SPSTATE_IFNET:
1809 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1811 case IPSEC_SPSTATE_PCB:
1812 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1815 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1818 /* if is the policy for ipsec ? */
1819 if (sp->policy == IPSEC_POLICY_IPSEC) {
1820 p = (caddr_t)xpl + sizeof(*xpl);
1821 for (i = 0; i < sp->tcount; i++) {
1823 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1824 isr->saidx.src.sa.sa_len +
1825 isr->saidx.dst.sa.sa_len);
1829 /* Calculate needed size */
1832 xisr = (struct sadb_x_ipsecrequest *)p;
1833 xisr->sadb_x_ipsecrequest_len = ilen;
1834 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1835 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1836 xisr->sadb_x_ipsecrequest_level = isr->level;
1837 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1840 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1841 p += isr->saidx.src.sa.sa_len;
1842 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1843 p += isr->saidx.dst.sa.sa_len;
1846 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1850 *len = sizeof(*xpl);
1854 /* m will not be freed nor modified */
1855 static struct mbuf *
1856 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1857 int ndeep, int nitem, ...)
1862 struct mbuf *result = NULL, *n;
1865 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1866 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1868 va_start(ap, nitem);
1869 for (i = 0; i < nitem; i++) {
1870 idx = va_arg(ap, int);
1871 if (idx < 0 || idx > SADB_EXT_MAX)
1873 /* don't attempt to pull empty extension */
1874 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1876 if (idx != SADB_EXT_RESERVED &&
1877 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1880 if (idx == SADB_EXT_RESERVED) {
1881 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1883 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1885 MGETHDR(n, M_NOWAIT, MT_DATA);
1890 m_copydata(m, 0, sizeof(struct sadb_msg),
1892 } else if (i < ndeep) {
1893 len = mhp->extlen[idx];
1894 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1899 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1902 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1915 if ((result->m_flags & M_PKTHDR) != 0) {
1916 result->m_pkthdr.len = 0;
1917 for (n = result; n; n = n->m_next)
1918 result->m_pkthdr.len += n->m_len;
1930 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1931 * add an entry to SP database, when received
1932 * <base, address(SD), (lifetime(H),) policy>
1934 * Adding to SP database,
1936 * <base, address(SD), (lifetime(H),) policy>
1937 * to the socket which was send.
1939 * SPDADD set a unique policy entry.
1940 * SPDSETIDX like SPDADD without a part of policy requests.
1941 * SPDUPDATE replace a unique policy entry.
1943 * XXXAE: serialize this in PF_KEY to avoid races.
1944 * m will always be freed.
1947 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1949 struct secpolicyindex spidx;
1950 struct sadb_address *src0, *dst0;
1951 struct sadb_x_policy *xpl0, *xpl;
1952 struct sadb_lifetime *lft = NULL;
1953 struct secpolicy *newsp;
1956 IPSEC_ASSERT(so != NULL, ("null socket"));
1957 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1958 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1959 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1961 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1962 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1963 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1964 ipseclog((LOG_DEBUG,
1965 "%s: invalid message: missing required header.\n",
1967 return key_senderror(so, m, EINVAL);
1969 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1970 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1971 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1972 ipseclog((LOG_DEBUG,
1973 "%s: invalid message: wrong header size.\n", __func__));
1974 return key_senderror(so, m, EINVAL);
1976 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1977 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1978 ipseclog((LOG_DEBUG,
1979 "%s: invalid message: wrong header size.\n",
1981 return key_senderror(so, m, EINVAL);
1983 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1986 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1987 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1988 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1990 /* check the direciton */
1991 switch (xpl0->sadb_x_policy_dir) {
1992 case IPSEC_DIR_INBOUND:
1993 case IPSEC_DIR_OUTBOUND:
1996 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
1997 return key_senderror(so, m, EINVAL);
1999 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
2000 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2001 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2002 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2003 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2004 return key_senderror(so, m, EINVAL);
2007 /* policy requests are mandatory when action is ipsec. */
2008 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
2009 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2010 ipseclog((LOG_DEBUG,
2011 "%s: policy requests required.\n", __func__));
2012 return key_senderror(so, m, EINVAL);
2015 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
2016 (struct sockaddr *)(dst0 + 1));
2018 src0->sadb_address_proto != dst0->sadb_address_proto) {
2019 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2020 return key_senderror(so, m, error);
2023 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2026 src0->sadb_address_prefixlen,
2027 dst0->sadb_address_prefixlen,
2028 src0->sadb_address_proto,
2030 /* Checking there is SP already or not. */
2031 newsp = key_getsp(&spidx);
2032 if (newsp != NULL) {
2033 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2035 printf("%s: unlink SP(%p) for SPDUPDATE\n",
2037 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2042 ipseclog((LOG_DEBUG,
2043 "%s: a SP entry exists already.\n", __func__));
2044 return (key_senderror(so, m, EEXIST));
2048 /* allocate new SP entry */
2049 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2050 return key_senderror(so, m, error);
2053 newsp->lastused = newsp->created = time_second;
2054 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
2055 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
2056 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
2058 /* XXXAE: there is race between key_getsp() and key_insertsp() */
2060 if ((newsp->id = key_getnewspid()) == 0) {
2063 return key_senderror(so, m, ENOBUFS);
2065 key_insertsp(newsp);
2067 if (SPDCACHE_ENABLED())
2071 printf("%s: SP(%p)\n", __func__, newsp));
2072 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2075 struct mbuf *n, *mpolicy;
2076 struct sadb_msg *newmsg;
2079 /* create new sadb_msg to reply. */
2081 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
2082 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
2083 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2085 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
2087 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2090 return key_senderror(so, m, ENOBUFS);
2092 if (n->m_len < sizeof(*newmsg)) {
2093 n = m_pullup(n, sizeof(*newmsg));
2095 return key_senderror(so, m, ENOBUFS);
2097 newmsg = mtod(n, struct sadb_msg *);
2098 newmsg->sadb_msg_errno = 0;
2099 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2102 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2103 sizeof(*xpl), &off);
2104 if (mpolicy == NULL) {
2105 /* n is already freed */
2106 return key_senderror(so, m, ENOBUFS);
2108 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
2109 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2111 return key_senderror(so, m, EINVAL);
2113 xpl->sadb_x_policy_id = newsp->id;
2116 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2121 * get new policy id.
2127 key_getnewspid(void)
2129 struct secpolicy *sp;
2131 int count = V_key_spi_trycnt; /* XXX */
2133 SPTREE_WLOCK_ASSERT();
2135 if (V_policy_id == ~0) /* overflowed */
2136 newid = V_policy_id = 1;
2138 newid = ++V_policy_id;
2139 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2140 if (sp->id == newid)
2146 if (count == 0 || newid == 0) {
2147 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2155 * SADB_SPDDELETE processing
2157 * <base, address(SD), policy(*)>
2158 * from the user(?), and set SADB_SASTATE_DEAD,
2160 * <base, address(SD), policy(*)>
2162 * policy(*) including direction of policy.
2164 * m will always be freed.
2167 key_spddelete(struct socket *so, struct mbuf *m,
2168 const struct sadb_msghdr *mhp)
2170 struct secpolicyindex spidx;
2171 struct sadb_address *src0, *dst0;
2172 struct sadb_x_policy *xpl0;
2173 struct secpolicy *sp;
2175 IPSEC_ASSERT(so != NULL, ("null so"));
2176 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2177 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2178 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2180 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2181 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2182 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2183 ipseclog((LOG_DEBUG,
2184 "%s: invalid message: missing required header.\n",
2186 return key_senderror(so, m, EINVAL);
2188 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2189 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2190 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2191 ipseclog((LOG_DEBUG,
2192 "%s: invalid message: wrong header size.\n", __func__));
2193 return key_senderror(so, m, EINVAL);
2196 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2197 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2198 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2200 /* check the direciton */
2201 switch (xpl0->sadb_x_policy_dir) {
2202 case IPSEC_DIR_INBOUND:
2203 case IPSEC_DIR_OUTBOUND:
2206 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2207 return key_senderror(so, m, EINVAL);
2209 /* Only DISCARD, NONE and IPSEC are allowed */
2210 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2211 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2212 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2213 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2214 return key_senderror(so, m, EINVAL);
2216 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2217 (struct sockaddr *)(dst0 + 1)) != 0 ||
2218 src0->sadb_address_proto != dst0->sadb_address_proto) {
2219 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2220 return key_senderror(so, m, EINVAL);
2223 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2226 src0->sadb_address_prefixlen,
2227 dst0->sadb_address_prefixlen,
2228 src0->sadb_address_proto,
2231 /* Is there SP in SPD ? */
2232 if ((sp = key_getsp(&spidx)) == NULL) {
2233 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2234 return key_senderror(so, m, EINVAL);
2237 /* save policy id to buffer to be returned. */
2238 xpl0->sadb_x_policy_id = sp->id;
2241 printf("%s: SP(%p)\n", __func__, sp));
2242 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2248 struct sadb_msg *newmsg;
2250 /* create new sadb_msg to reply. */
2251 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2252 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2254 return key_senderror(so, m, ENOBUFS);
2256 newmsg = mtod(n, struct sadb_msg *);
2257 newmsg->sadb_msg_errno = 0;
2258 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2261 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2266 * SADB_SPDDELETE2 processing
2269 * from the user(?), and set SADB_SASTATE_DEAD,
2273 * policy(*) including direction of policy.
2275 * m will always be freed.
2278 key_spddelete2(struct socket *so, struct mbuf *m,
2279 const struct sadb_msghdr *mhp)
2281 struct secpolicy *sp;
2284 IPSEC_ASSERT(so != NULL, ("null socket"));
2285 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2286 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2287 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2289 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2290 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2291 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2293 return key_senderror(so, m, EINVAL);
2296 id = ((struct sadb_x_policy *)
2297 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2299 /* Is there SP in SPD ? */
2300 if ((sp = key_getspbyid(id)) == NULL) {
2301 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2303 return key_senderror(so, m, EINVAL);
2307 printf("%s: SP(%p)\n", __func__, sp));
2308 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2310 if (sp->state != IPSEC_SPSTATE_DEAD) {
2311 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2314 return (key_senderror(so, m, EACCES));
2319 struct mbuf *n, *nn;
2320 struct sadb_msg *newmsg;
2323 /* create new sadb_msg to reply. */
2324 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2326 MGETHDR(n, M_NOWAIT, MT_DATA);
2327 if (n && len > MHLEN) {
2328 if (!(MCLGET(n, M_NOWAIT))) {
2334 return key_senderror(so, m, ENOBUFS);
2340 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2341 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2343 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2346 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2347 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2350 return key_senderror(so, m, ENOBUFS);
2353 n->m_pkthdr.len = 0;
2354 for (nn = n; nn; nn = nn->m_next)
2355 n->m_pkthdr.len += nn->m_len;
2357 newmsg = mtod(n, struct sadb_msg *);
2358 newmsg->sadb_msg_errno = 0;
2359 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2362 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2367 * SADB_X_SPDGET processing
2372 * <base, address(SD), policy>
2374 * policy(*) including direction of policy.
2376 * m will always be freed.
2379 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2381 struct secpolicy *sp;
2385 IPSEC_ASSERT(so != NULL, ("null socket"));
2386 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2387 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2388 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2390 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2391 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2392 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2394 return key_senderror(so, m, EINVAL);
2397 id = ((struct sadb_x_policy *)
2398 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2400 /* Is there SP in SPD ? */
2401 if ((sp = key_getspbyid(id)) == NULL) {
2402 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2404 return key_senderror(so, m, ENOENT);
2407 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2408 mhp->msg->sadb_msg_pid);
2412 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2414 return key_senderror(so, m, ENOBUFS);
2418 * SADB_X_SPDACQUIRE processing.
2419 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2422 * to KMD, and expect to receive
2423 * <base> with SADB_X_SPDACQUIRE if error occurred,
2426 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2427 * policy(*) is without policy requests.
2430 * others: error number
2433 key_spdacquire(struct secpolicy *sp)
2435 struct mbuf *result = NULL, *m;
2436 struct secspacq *newspacq;
2438 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2439 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2440 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2441 ("policy not IPSEC %u", sp->policy));
2443 /* Get an entry to check whether sent message or not. */
2444 newspacq = key_getspacq(&sp->spidx);
2445 if (newspacq != NULL) {
2446 if (V_key_blockacq_count < newspacq->count) {
2447 /* reset counter and do send message. */
2448 newspacq->count = 0;
2450 /* increment counter and do nothing. */
2457 /* make new entry for blocking to send SADB_ACQUIRE. */
2458 newspacq = key_newspacq(&sp->spidx);
2459 if (newspacq == NULL)
2463 /* create new sadb_msg to reply. */
2464 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2470 result->m_pkthdr.len = 0;
2471 for (m = result; m; m = m->m_next)
2472 result->m_pkthdr.len += m->m_len;
2474 mtod(result, struct sadb_msg *)->sadb_msg_len =
2475 PFKEY_UNIT64(result->m_pkthdr.len);
2477 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2481 * SADB_SPDFLUSH processing
2484 * from the user, and free all entries in secpctree.
2488 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2490 * m will always be freed.
2493 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2495 struct secpolicy_queue drainq;
2496 struct sadb_msg *newmsg;
2497 struct secpolicy *sp, *nextsp;
2500 IPSEC_ASSERT(so != NULL, ("null socket"));
2501 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2502 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2503 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2505 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2506 return key_senderror(so, m, EINVAL);
2508 TAILQ_INIT(&drainq);
2510 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2511 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2514 * We need to set state to DEAD for each policy to be sure,
2515 * that another thread won't try to unlink it.
2516 * Also remove SP from sphash.
2518 TAILQ_FOREACH(sp, &drainq, chain) {
2519 sp->state = IPSEC_SPSTATE_DEAD;
2520 LIST_REMOVE(sp, idhash);
2525 if (SPDCACHE_ENABLED())
2527 sp = TAILQ_FIRST(&drainq);
2528 while (sp != NULL) {
2529 nextsp = TAILQ_NEXT(sp, chain);
2534 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2535 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2536 return key_senderror(so, m, ENOBUFS);
2542 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2543 newmsg = mtod(m, struct sadb_msg *);
2544 newmsg->sadb_msg_errno = 0;
2545 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2547 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2551 key_satype2scopemask(uint8_t satype)
2554 if (satype == IPSEC_POLICYSCOPE_ANY)
2559 * SADB_SPDDUMP processing
2562 * from the user, and dump all SP leaves and send,
2567 * sadb_msg_satype is considered as mask of policy scopes.
2568 * m will always be freed.
2571 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2573 SPTREE_RLOCK_TRACKER;
2574 struct secpolicy *sp;
2579 IPSEC_ASSERT(so != NULL, ("null socket"));
2580 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2581 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2582 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2584 /* search SPD entry and get buffer size. */
2586 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2588 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2589 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2590 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2593 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2594 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2601 return key_senderror(so, m, ENOENT);
2604 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2605 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2606 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2608 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2609 mhp->msg->sadb_msg_pid);
2612 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2615 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2616 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2618 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2619 mhp->msg->sadb_msg_pid);
2622 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2632 static struct mbuf *
2633 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2636 struct mbuf *result = NULL, *m;
2637 struct seclifetime lt;
2639 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2644 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2645 &sp->spidx.src.sa, sp->spidx.prefs,
2646 sp->spidx.ul_proto);
2651 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2652 &sp->spidx.dst.sa, sp->spidx.prefd,
2653 sp->spidx.ul_proto);
2658 m = key_sp2mbuf(sp);
2664 lt.addtime=sp->created;
2665 lt.usetime= sp->lastused;
2666 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2671 lt.addtime=sp->lifetime;
2672 lt.usetime= sp->validtime;
2673 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2679 if ((result->m_flags & M_PKTHDR) == 0)
2682 if (result->m_len < sizeof(struct sadb_msg)) {
2683 result = m_pullup(result, sizeof(struct sadb_msg));
2688 result->m_pkthdr.len = 0;
2689 for (m = result; m; m = m->m_next)
2690 result->m_pkthdr.len += m->m_len;
2692 mtod(result, struct sadb_msg *)->sadb_msg_len =
2693 PFKEY_UNIT64(result->m_pkthdr.len);
2702 * get PFKEY message length for security policy and request.
2705 key_getspreqmsglen(struct secpolicy *sp)
2710 tlen = sizeof(struct sadb_x_policy);
2711 /* if is the policy for ipsec ? */
2712 if (sp->policy != IPSEC_POLICY_IPSEC)
2715 /* get length of ipsec requests */
2716 for (i = 0; i < sp->tcount; i++) {
2717 len = sizeof(struct sadb_x_ipsecrequest)
2718 + sp->req[i]->saidx.src.sa.sa_len
2719 + sp->req[i]->saidx.dst.sa.sa_len;
2721 tlen += PFKEY_ALIGN8(len);
2727 * SADB_SPDEXPIRE processing
2729 * <base, address(SD), lifetime(CH), policy>
2733 * others : error number
2736 key_spdexpire(struct secpolicy *sp)
2738 struct sadb_lifetime *lt;
2739 struct mbuf *result = NULL, *m;
2740 int len, error = -1;
2742 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2745 printf("%s: SP(%p)\n", __func__, sp));
2746 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2748 /* set msg header */
2749 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2756 /* create lifetime extension (current and hard) */
2757 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2758 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2765 bzero(mtod(m, caddr_t), len);
2766 lt = mtod(m, struct sadb_lifetime *);
2767 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2768 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2769 lt->sadb_lifetime_allocations = 0;
2770 lt->sadb_lifetime_bytes = 0;
2771 lt->sadb_lifetime_addtime = sp->created;
2772 lt->sadb_lifetime_usetime = sp->lastused;
2773 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2774 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2775 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2776 lt->sadb_lifetime_allocations = 0;
2777 lt->sadb_lifetime_bytes = 0;
2778 lt->sadb_lifetime_addtime = sp->lifetime;
2779 lt->sadb_lifetime_usetime = sp->validtime;
2782 /* set sadb_address for source */
2783 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2785 sp->spidx.prefs, sp->spidx.ul_proto);
2792 /* set sadb_address for destination */
2793 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2795 sp->spidx.prefd, sp->spidx.ul_proto);
2803 m = key_sp2mbuf(sp);
2810 if ((result->m_flags & M_PKTHDR) == 0) {
2815 if (result->m_len < sizeof(struct sadb_msg)) {
2816 result = m_pullup(result, sizeof(struct sadb_msg));
2817 if (result == NULL) {
2823 result->m_pkthdr.len = 0;
2824 for (m = result; m; m = m->m_next)
2825 result->m_pkthdr.len += m->m_len;
2827 mtod(result, struct sadb_msg *)->sadb_msg_len =
2828 PFKEY_UNIT64(result->m_pkthdr.len);
2830 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2838 /* %%% SAD management */
2840 * allocating and initialize new SA head.
2841 * OUT: NULL : failure due to the lack of memory.
2842 * others : pointer to new SA head.
2844 static struct secashead *
2845 key_newsah(struct secasindex *saidx)
2847 struct secashead *sah;
2849 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2852 PFKEYSTAT_INC(in_nomem);
2855 TAILQ_INIT(&sah->savtree_larval);
2856 TAILQ_INIT(&sah->savtree_alive);
2857 sah->saidx = *saidx;
2858 sah->state = SADB_SASTATE_DEAD;
2862 printf("%s: SAH(%p)\n", __func__, sah));
2863 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2868 key_freesah(struct secashead **psah)
2870 struct secashead *sah = *psah;
2872 if (SAH_DELREF(sah) == 0)
2876 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2877 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2884 key_delsah(struct secashead *sah)
2886 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2887 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2888 ("Attempt to free non DEAD SAH %p", sah));
2889 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2890 ("Attempt to free SAH %p with LARVAL SA", sah));
2891 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2892 ("Attempt to free SAH %p with ALIVE SA", sah));
2894 free(sah, M_IPSEC_SAH);
2898 * allocating a new SA for key_add() and key_getspi() call,
2899 * and copy the values of mhp into new buffer.
2900 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2901 * For SADB_ADD create and initialize SA with MATURE state.
2903 * others : pointer to new secasvar.
2905 static struct secasvar *
2906 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2907 uint32_t spi, int *errp)
2909 struct secashead *sah;
2910 struct secasvar *sav;
2913 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2914 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2915 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2916 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2920 /* check SPI value */
2921 switch (saidx->proto) {
2925 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2926 * 1-255 reserved by IANA for future use,
2927 * 0 for implementation specific, local use.
2929 if (ntohl(spi) <= 255) {
2930 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2931 __func__, ntohl(spi)));
2938 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2943 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2945 if (sav->lock == NULL) {
2949 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2950 sav->lft_c = uma_zalloc_pcpu(V_key_lft_zone, M_NOWAIT);
2951 if (sav->lft_c == NULL) {
2955 counter_u64_zero(sav->lft_c_allocations);
2956 counter_u64_zero(sav->lft_c_bytes);
2959 sav->seq = mhp->msg->sadb_msg_seq;
2960 sav->state = SADB_SASTATE_LARVAL;
2961 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2964 sah = key_getsah(saidx);
2966 /* create a new SA index */
2967 sah = key_newsah(saidx);
2969 ipseclog((LOG_DEBUG,
2970 "%s: No more memory.\n", __func__));
2979 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2980 sav->created = time_second;
2981 } else if (sav->state == SADB_SASTATE_LARVAL) {
2983 * Do not call key_setsaval() second time in case
2984 * of `goto again`. We will have MATURE state.
2986 *errp = key_setsaval(sav, mhp);
2989 sav->state = SADB_SASTATE_MATURE;
2994 * Check that existing SAH wasn't unlinked.
2995 * Since we didn't hold the SAHTREE lock, it is possible,
2996 * that callout handler or key_flush() or key_delete() could
2999 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
3001 key_freesah(&sah); /* reference from key_getsah() */
3006 * Add new SAH into SADB.
3008 * XXXAE: we can serialize key_add and key_getspi calls, so
3009 * several threads will not fight in the race.
3010 * Otherwise we should check under SAHTREE lock, that this
3011 * SAH would not added twice.
3013 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
3014 /* Add new SAH into hash by addresses */
3015 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
3016 /* Now we are linked in the chain */
3017 sah->state = SADB_SASTATE_MATURE;
3019 * SAV references this new SAH.
3020 * In case of existing SAH we reuse reference
3021 * from key_getsah().
3025 /* Link SAV with SAH */
3026 if (sav->state == SADB_SASTATE_MATURE)
3027 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
3029 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
3030 /* Add SAV into SPI hash */
3031 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
3033 *errp = 0; /* success */
3037 if (sav->lock != NULL) {
3038 mtx_destroy(sav->lock);
3039 free(sav->lock, M_IPSEC_MISC);
3041 if (sav->lft_c != NULL)
3042 uma_zfree_pcpu(V_key_lft_zone, sav->lft_c);
3043 free(sav, M_IPSEC_SA), sav = NULL;
3047 if (*errp == ENOBUFS) {
3048 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3050 PFKEYSTAT_INC(in_nomem);
3057 * free() SA variable entry.
3060 key_cleansav(struct secasvar *sav)
3063 if (sav->natt != NULL) {
3064 free(sav->natt, M_IPSEC_MISC);
3067 if (sav->flags & SADB_X_EXT_F_CLONED)
3070 * Cleanup xform state. Note that zeroize'ing causes the
3071 * keys to be cleared; otherwise we must do it ourself.
3073 if (sav->tdb_xform != NULL) {
3074 sav->tdb_xform->xf_zeroize(sav);
3075 sav->tdb_xform = NULL;
3077 if (sav->key_auth != NULL)
3078 bzero(sav->key_auth->key_data, _KEYLEN(sav->key_auth));
3079 if (sav->key_enc != NULL)
3080 bzero(sav->key_enc->key_data, _KEYLEN(sav->key_enc));
3082 if (sav->key_auth != NULL) {
3083 if (sav->key_auth->key_data != NULL)
3084 free(sav->key_auth->key_data, M_IPSEC_MISC);
3085 free(sav->key_auth, M_IPSEC_MISC);
3086 sav->key_auth = NULL;
3088 if (sav->key_enc != NULL) {
3089 if (sav->key_enc->key_data != NULL)
3090 free(sav->key_enc->key_data, M_IPSEC_MISC);
3091 free(sav->key_enc, M_IPSEC_MISC);
3092 sav->key_enc = NULL;
3094 if (sav->replay != NULL) {
3095 if (sav->replay->bitmap != NULL)
3096 free(sav->replay->bitmap, M_IPSEC_MISC);
3097 free(sav->replay, M_IPSEC_MISC);
3100 if (sav->lft_h != NULL) {
3101 free(sav->lft_h, M_IPSEC_MISC);
3104 if (sav->lft_s != NULL) {
3105 free(sav->lft_s, M_IPSEC_MISC);
3111 * free() SA variable entry.
3114 key_delsav(struct secasvar *sav)
3116 IPSEC_ASSERT(sav != NULL, ("null sav"));
3117 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
3118 ("attempt to free non DEAD SA %p", sav));
3119 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
3123 * SA must be unlinked from the chain and hashtbl.
3124 * If SA was cloned, we leave all fields untouched,
3125 * except NAT-T config.
3128 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
3129 mtx_destroy(sav->lock);
3130 free(sav->lock, M_IPSEC_MISC);
3131 uma_zfree(V_key_lft_zone, sav->lft_c);
3133 free(sav, M_IPSEC_SA);
3140 * others : found, referenced pointer to a SAH.
3142 static struct secashead *
3143 key_getsah(struct secasindex *saidx)
3145 SAHTREE_RLOCK_TRACKER;
3146 struct secashead *sah;
3149 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3150 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3160 * Check not to be duplicated SPI.
3163 * 1 : found SA with given SPI.
3166 key_checkspidup(uint32_t spi)
3168 SAHTREE_RLOCK_TRACKER;
3169 struct secasvar *sav;
3171 /* Assume SPI is in network byte order */
3173 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3174 if (sav->spi == spi)
3178 return (sav != NULL);
3185 * others : found, referenced pointer to a SA.
3187 static struct secasvar *
3188 key_getsavbyspi(uint32_t spi)
3190 SAHTREE_RLOCK_TRACKER;
3191 struct secasvar *sav;
3193 /* Assume SPI is in network byte order */
3195 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3196 if (sav->spi != spi)
3206 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3208 struct seclifetime *lft_h, *lft_s, *tmp;
3210 /* Lifetime extension is optional, check that it is present. */
3211 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3212 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3214 * In case of SADB_UPDATE we may need to change
3215 * existing lifetimes.
3217 if (sav->state == SADB_SASTATE_MATURE) {
3218 lft_h = lft_s = NULL;
3223 /* Both HARD and SOFT extensions must present */
3224 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3225 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3226 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3227 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3228 ipseclog((LOG_DEBUG,
3229 "%s: invalid message: missing required header.\n",
3233 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3234 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3235 ipseclog((LOG_DEBUG,
3236 "%s: invalid message: wrong header size.\n", __func__));
3239 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3240 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3241 if (lft_h == NULL) {
3242 PFKEYSTAT_INC(in_nomem);
3243 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3246 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3247 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3248 if (lft_s == NULL) {
3249 PFKEYSTAT_INC(in_nomem);
3250 free(lft_h, M_IPSEC_MISC);
3251 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3255 if (sav->state != SADB_SASTATE_LARVAL) {
3257 * key_update() holds reference to this SA,
3258 * so it won't be deleted in meanwhile.
3268 SECASVAR_UNLOCK(sav);
3270 free(lft_h, M_IPSEC_MISC);
3272 free(lft_s, M_IPSEC_MISC);
3275 /* We can update lifetime without holding a lock */
3276 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3277 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3284 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3285 * You must update these if need. Expects only LARVAL SAs.
3290 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3292 const struct sadb_sa *sa0;
3293 const struct sadb_key *key0;
3298 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3299 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3300 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3301 ("Attempt to update non LARVAL SA"));
3304 error = key_setident(sav->sah, mhp);
3309 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3310 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3314 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3315 sav->alg_auth = sa0->sadb_sa_auth;
3316 sav->alg_enc = sa0->sadb_sa_encrypt;
3317 sav->flags = sa0->sadb_sa_flags;
3318 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3319 ipseclog((LOG_DEBUG,
3320 "%s: invalid sa_flags 0x%08x.\n", __func__,
3326 /* Optional replay window */
3328 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3329 replay = sa0->sadb_sa_replay;
3330 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3331 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3335 replay = ((const struct sadb_x_sa_replay *)
3336 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3338 if (replay > UINT32_MAX - 32) {
3339 ipseclog((LOG_DEBUG,
3340 "%s: replay window too big.\n", __func__));
3345 replay = (replay + 7) >> 3;
3348 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3350 if (sav->replay == NULL) {
3351 PFKEYSTAT_INC(in_nomem);
3352 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3359 /* number of 32b blocks to be allocated */
3360 uint32_t bitmap_size;
3363 * - the allocated replay window size must be
3365 * - use an extra 32b block as a redundant window.
3368 while (replay + 4 > bitmap_size)
3370 bitmap_size = bitmap_size / 4;
3372 sav->replay->bitmap = malloc(
3373 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3375 if (sav->replay->bitmap == NULL) {
3376 PFKEYSTAT_INC(in_nomem);
3377 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3382 sav->replay->bitmap_size = bitmap_size;
3383 sav->replay->wsize = replay;
3387 /* Authentication keys */
3388 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3389 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3394 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3395 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3396 switch (mhp->msg->sadb_msg_satype) {
3397 case SADB_SATYPE_AH:
3398 case SADB_SATYPE_ESP:
3399 case SADB_X_SATYPE_TCPSIGNATURE:
3400 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3401 sav->alg_auth != SADB_X_AALG_NULL)
3404 case SADB_X_SATYPE_IPCOMP:
3410 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3415 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3416 if (sav->key_auth == NULL ) {
3417 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3419 PFKEYSTAT_INC(in_nomem);
3425 /* Encryption key */
3426 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3427 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3432 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3433 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3434 switch (mhp->msg->sadb_msg_satype) {
3435 case SADB_SATYPE_ESP:
3436 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3437 sav->alg_enc != SADB_EALG_NULL) {
3441 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3442 if (sav->key_enc == NULL) {
3443 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3445 PFKEYSTAT_INC(in_nomem);
3450 case SADB_X_SATYPE_IPCOMP:
3451 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3453 sav->key_enc = NULL; /*just in case*/
3455 case SADB_SATYPE_AH:
3456 case SADB_X_SATYPE_TCPSIGNATURE:
3462 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3470 switch (mhp->msg->sadb_msg_satype) {
3471 case SADB_SATYPE_AH:
3472 if (sav->flags & SADB_X_EXT_DERIV) {
3473 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3474 "given to AH SA.\n", __func__));
3478 if (sav->alg_enc != SADB_EALG_NONE) {
3479 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3480 "mismated.\n", __func__));
3484 error = xform_init(sav, XF_AH);
3486 case SADB_SATYPE_ESP:
3487 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3488 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3489 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3490 "given to old-esp.\n", __func__));
3494 error = xform_init(sav, XF_ESP);
3496 case SADB_X_SATYPE_IPCOMP:
3497 if (sav->alg_auth != SADB_AALG_NONE) {
3498 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3499 "mismated.\n", __func__));
3503 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3504 ntohl(sav->spi) >= 0x10000) {
3505 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3510 error = xform_init(sav, XF_IPCOMP);
3512 case SADB_X_SATYPE_TCPSIGNATURE:
3513 if (sav->alg_enc != SADB_EALG_NONE) {
3514 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3515 "mismated.\n", __func__));
3519 error = xform_init(sav, XF_TCPSIGNATURE);
3522 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3523 error = EPROTONOSUPPORT;
3527 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3528 __func__, mhp->msg->sadb_msg_satype));
3532 /* Handle NAT-T headers */
3533 error = key_setnatt(sav, mhp);
3537 /* Initialize lifetime for CURRENT */
3539 sav->created = time_second;
3541 /* lifetimes for HARD and SOFT */
3542 error = key_updatelifetimes(sav, mhp);
3551 * subroutine for SADB_GET and SADB_DUMP.
3553 static struct mbuf *
3554 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3555 uint32_t seq, uint32_t pid)
3557 struct seclifetime lft_c;
3558 struct mbuf *result = NULL, *tres = NULL, *m;
3559 int i, dumporder[] = {
3560 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3561 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3562 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3563 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3564 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3565 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3566 SADB_EXT_SENSITIVITY,
3567 SADB_X_EXT_NAT_T_TYPE,
3568 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3569 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3570 SADB_X_EXT_NAT_T_FRAG,
3572 uint32_t replay_count;
3574 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3579 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3581 switch (dumporder[i]) {
3583 m = key_setsadbsa(sav);
3588 case SADB_X_EXT_SA2:
3590 replay_count = sav->replay ? sav->replay->count : 0;
3591 SECASVAR_UNLOCK(sav);
3592 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3593 sav->sah->saidx.reqid);
3598 case SADB_X_EXT_SA_REPLAY:
3599 if (sav->replay == NULL ||
3600 sav->replay->wsize <= UINT8_MAX)
3603 m = key_setsadbxsareplay(sav->replay->wsize);
3608 case SADB_EXT_ADDRESS_SRC:
3609 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3610 &sav->sah->saidx.src.sa,
3611 FULLMASK, IPSEC_ULPROTO_ANY);
3616 case SADB_EXT_ADDRESS_DST:
3617 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3618 &sav->sah->saidx.dst.sa,
3619 FULLMASK, IPSEC_ULPROTO_ANY);
3624 case SADB_EXT_KEY_AUTH:
3627 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3632 case SADB_EXT_KEY_ENCRYPT:
3635 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3640 case SADB_EXT_LIFETIME_CURRENT:
3641 lft_c.addtime = sav->created;
3642 lft_c.allocations = (uint32_t)counter_u64_fetch(
3643 sav->lft_c_allocations);
3644 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3645 lft_c.usetime = sav->firstused;
3646 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3651 case SADB_EXT_LIFETIME_HARD:
3654 m = key_setlifetime(sav->lft_h,
3655 SADB_EXT_LIFETIME_HARD);
3660 case SADB_EXT_LIFETIME_SOFT:
3663 m = key_setlifetime(sav->lft_s,
3664 SADB_EXT_LIFETIME_SOFT);
3670 case SADB_X_EXT_NAT_T_TYPE:
3671 if (sav->natt == NULL)
3673 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3678 case SADB_X_EXT_NAT_T_DPORT:
3679 if (sav->natt == NULL)
3681 m = key_setsadbxport(sav->natt->dport,
3682 SADB_X_EXT_NAT_T_DPORT);
3687 case SADB_X_EXT_NAT_T_SPORT:
3688 if (sav->natt == NULL)
3690 m = key_setsadbxport(sav->natt->sport,
3691 SADB_X_EXT_NAT_T_SPORT);
3696 case SADB_X_EXT_NAT_T_OAI:
3697 if (sav->natt == NULL ||
3698 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3700 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3701 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3705 case SADB_X_EXT_NAT_T_OAR:
3706 if (sav->natt == NULL ||
3707 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3709 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3710 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3714 case SADB_X_EXT_NAT_T_FRAG:
3715 /* We do not (yet) support those. */
3718 case SADB_EXT_ADDRESS_PROXY:
3719 case SADB_EXT_IDENTITY_SRC:
3720 case SADB_EXT_IDENTITY_DST:
3721 /* XXX: should we brought from SPD ? */
3722 case SADB_EXT_SENSITIVITY:
3734 m_cat(result, tres);
3736 if (result->m_len < sizeof(struct sadb_msg)) {
3737 result = m_pullup(result, sizeof(struct sadb_msg));
3742 result->m_pkthdr.len = 0;
3743 for (m = result; m; m = m->m_next)
3744 result->m_pkthdr.len += m->m_len;
3746 mtod(result, struct sadb_msg *)->sadb_msg_len =
3747 PFKEY_UNIT64(result->m_pkthdr.len);
3758 * set data into sadb_msg.
3760 static struct mbuf *
3761 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3762 pid_t pid, u_int16_t reserved)
3768 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3771 MGETHDR(m, M_NOWAIT, MT_DATA);
3772 if (m && len > MHLEN) {
3773 if (!(MCLGET(m, M_NOWAIT))) {
3780 m->m_pkthdr.len = m->m_len = len;
3783 p = mtod(m, struct sadb_msg *);
3786 p->sadb_msg_version = PF_KEY_V2;
3787 p->sadb_msg_type = type;
3788 p->sadb_msg_errno = 0;
3789 p->sadb_msg_satype = satype;
3790 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3791 p->sadb_msg_reserved = reserved;
3792 p->sadb_msg_seq = seq;
3793 p->sadb_msg_pid = (u_int32_t)pid;
3799 * copy secasvar data into sadb_address.
3801 static struct mbuf *
3802 key_setsadbsa(struct secasvar *sav)
3808 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3809 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3814 p = mtod(m, struct sadb_sa *);
3816 p->sadb_sa_len = PFKEY_UNIT64(len);
3817 p->sadb_sa_exttype = SADB_EXT_SA;
3818 p->sadb_sa_spi = sav->spi;
3819 p->sadb_sa_replay = sav->replay ?
3820 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3821 sav->replay->wsize): 0;
3822 p->sadb_sa_state = sav->state;
3823 p->sadb_sa_auth = sav->alg_auth;
3824 p->sadb_sa_encrypt = sav->alg_enc;
3825 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3830 * set data into sadb_address.
3832 static struct mbuf *
3833 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3834 u_int8_t prefixlen, u_int16_t ul_proto)
3837 struct sadb_address *p;
3840 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3841 PFKEY_ALIGN8(saddr->sa_len);
3842 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3847 p = mtod(m, struct sadb_address *);
3850 p->sadb_address_len = PFKEY_UNIT64(len);
3851 p->sadb_address_exttype = exttype;
3852 p->sadb_address_proto = ul_proto;
3853 if (prefixlen == FULLMASK) {
3854 switch (saddr->sa_family) {
3856 prefixlen = sizeof(struct in_addr) << 3;
3859 prefixlen = sizeof(struct in6_addr) << 3;
3865 p->sadb_address_prefixlen = prefixlen;
3866 p->sadb_address_reserved = 0;
3869 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3876 * set data into sadb_x_sa2.
3878 static struct mbuf *
3879 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3882 struct sadb_x_sa2 *p;
3885 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3886 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3891 p = mtod(m, struct sadb_x_sa2 *);
3894 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3895 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3896 p->sadb_x_sa2_mode = mode;
3897 p->sadb_x_sa2_reserved1 = 0;
3898 p->sadb_x_sa2_reserved2 = 0;
3899 p->sadb_x_sa2_sequence = seq;
3900 p->sadb_x_sa2_reqid = reqid;
3906 * Set data into sadb_x_sa_replay.
3908 static struct mbuf *
3909 key_setsadbxsareplay(u_int32_t replay)
3912 struct sadb_x_sa_replay *p;
3915 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3916 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3921 p = mtod(m, struct sadb_x_sa_replay *);
3924 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3925 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3926 p->sadb_x_sa_replay_replay = (replay << 3);
3932 * Set a type in sadb_x_nat_t_type.
3934 static struct mbuf *
3935 key_setsadbxtype(u_int16_t type)
3939 struct sadb_x_nat_t_type *p;
3941 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3943 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3948 p = mtod(m, struct sadb_x_nat_t_type *);
3951 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3952 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3953 p->sadb_x_nat_t_type_type = type;
3958 * Set a port in sadb_x_nat_t_port.
3959 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3961 static struct mbuf *
3962 key_setsadbxport(u_int16_t port, u_int16_t type)
3966 struct sadb_x_nat_t_port *p;
3968 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3970 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3975 p = mtod(m, struct sadb_x_nat_t_port *);
3978 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3979 p->sadb_x_nat_t_port_exttype = type;
3980 p->sadb_x_nat_t_port_port = port;
3986 * Get port from sockaddr. Port is in network byte order.
3989 key_portfromsaddr(struct sockaddr *sa)
3992 switch (sa->sa_family) {
3995 return ((struct sockaddr_in *)sa)->sin_port;
3999 return ((struct sockaddr_in6 *)sa)->sin6_port;
4006 * Set port in struct sockaddr. Port is in network byte order.
4009 key_porttosaddr(struct sockaddr *sa, uint16_t port)
4012 switch (sa->sa_family) {
4015 ((struct sockaddr_in *)sa)->sin_port = port;
4020 ((struct sockaddr_in6 *)sa)->sin6_port = port;
4024 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
4025 __func__, sa->sa_family));
4031 * set data into sadb_x_policy
4033 static struct mbuf *
4034 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
4037 struct sadb_x_policy *p;
4040 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
4041 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
4046 p = mtod(m, struct sadb_x_policy *);
4049 p->sadb_x_policy_len = PFKEY_UNIT64(len);
4050 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
4051 p->sadb_x_policy_type = type;
4052 p->sadb_x_policy_dir = dir;
4053 p->sadb_x_policy_id = id;
4054 p->sadb_x_policy_priority = priority;
4060 /* Take a key message (sadb_key) from the socket and turn it into one
4061 * of the kernel's key structures (seckey).
4063 * IN: pointer to the src
4064 * OUT: NULL no more memory
4067 key_dup_keymsg(const struct sadb_key *src, size_t len,
4068 struct malloc_type *type)
4072 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4074 dst->bits = src->sadb_key_bits;
4075 dst->key_data = malloc(len, type, M_NOWAIT);
4076 if (dst->key_data != NULL) {
4077 bcopy((const char *)(src + 1), dst->key_data, len);
4079 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4085 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4092 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
4093 * turn it into one of the kernel's lifetime structures (seclifetime).
4095 * IN: pointer to the destination, source and malloc type
4096 * OUT: NULL, no more memory
4099 static struct seclifetime *
4100 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
4102 struct seclifetime *dst;
4104 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4106 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
4109 dst->allocations = src->sadb_lifetime_allocations;
4110 dst->bytes = src->sadb_lifetime_bytes;
4111 dst->addtime = src->sadb_lifetime_addtime;
4112 dst->usetime = src->sadb_lifetime_usetime;
4117 * compare two secasindex structure.
4118 * flag can specify to compare 2 saidxes.
4119 * compare two secasindex structure without both mode and reqid.
4120 * don't compare port.
4122 * saidx0: source, it can be in SAD.
4129 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4134 if (saidx0 == NULL && saidx1 == NULL)
4137 if (saidx0 == NULL || saidx1 == NULL)
4140 if (saidx0->proto != saidx1->proto)
4143 if (flag == CMP_EXACTLY) {
4144 if (saidx0->mode != saidx1->mode)
4146 if (saidx0->reqid != saidx1->reqid)
4148 if (bcmp(&saidx0->src, &saidx1->src,
4149 saidx0->src.sa.sa_len) != 0 ||
4150 bcmp(&saidx0->dst, &saidx1->dst,
4151 saidx0->dst.sa.sa_len) != 0)
4155 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4156 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4158 * If reqid of SPD is non-zero, unique SA is required.
4159 * The result must be of same reqid in this case.
4161 if (saidx1->reqid != 0 &&
4162 saidx0->reqid != saidx1->reqid)
4166 if (flag == CMP_MODE_REQID) {
4167 if (saidx0->mode != IPSEC_MODE_ANY
4168 && saidx0->mode != saidx1->mode)
4172 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4174 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4182 * compare two secindex structure exactly.
4184 * spidx0: source, it is often in SPD.
4185 * spidx1: object, it is often from PFKEY message.
4191 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4192 struct secpolicyindex *spidx1)
4195 if (spidx0 == NULL && spidx1 == NULL)
4198 if (spidx0 == NULL || spidx1 == NULL)
4201 if (spidx0->prefs != spidx1->prefs
4202 || spidx0->prefd != spidx1->prefd
4203 || spidx0->ul_proto != spidx1->ul_proto
4204 || spidx0->dir != spidx1->dir)
4207 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4208 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4212 * compare two secindex structure with mask.
4214 * spidx0: source, it is often in SPD.
4215 * spidx1: object, it is often from IP header.
4221 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4222 struct secpolicyindex *spidx1)
4225 if (spidx0 == NULL && spidx1 == NULL)
4228 if (spidx0 == NULL || spidx1 == NULL)
4231 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4232 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4233 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4234 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4237 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4238 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4239 && spidx0->ul_proto != spidx1->ul_proto)
4242 switch (spidx0->src.sa.sa_family) {
4244 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4245 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4247 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4248 &spidx1->src.sin.sin_addr, spidx0->prefs))
4252 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4253 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4256 * scope_id check. if sin6_scope_id is 0, we regard it
4257 * as a wildcard scope, which matches any scope zone ID.
4259 if (spidx0->src.sin6.sin6_scope_id &&
4260 spidx1->src.sin6.sin6_scope_id &&
4261 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4263 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4264 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4269 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4274 switch (spidx0->dst.sa.sa_family) {
4276 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4277 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4279 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4280 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4284 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4285 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4288 * scope_id check. if sin6_scope_id is 0, we regard it
4289 * as a wildcard scope, which matches any scope zone ID.
4291 if (spidx0->dst.sin6.sin6_scope_id &&
4292 spidx1->dst.sin6.sin6_scope_id &&
4293 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4295 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4296 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4301 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4306 /* XXX Do we check other field ? e.g. flowinfo */
4314 #define satosin(s) ((const struct sockaddr_in *)s)
4318 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4319 /* returns 0 on match */
4321 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4324 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4327 switch (sa1->sa_family) {
4330 if (sa1->sa_len != sizeof(struct sockaddr_in))
4332 if (satosin(sa1)->sin_addr.s_addr !=
4333 satosin(sa2)->sin_addr.s_addr) {
4336 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4342 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4343 return 1; /*EINVAL*/
4344 if (satosin6(sa1)->sin6_scope_id !=
4345 satosin6(sa2)->sin6_scope_id) {
4348 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4349 &satosin6(sa2)->sin6_addr)) {
4353 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4359 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4367 /* returns 0 on match */
4369 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4370 const struct sockaddr *sa2, size_t mask)
4372 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4375 switch (sa1->sa_family) {
4378 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4379 &satosin(sa2)->sin_addr, mask));
4383 if (satosin6(sa1)->sin6_scope_id !=
4384 satosin6(sa2)->sin6_scope_id)
4386 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4387 &satosin6(sa2)->sin6_addr, mask));
4396 * compare two buffers with mask.
4400 * bits: Number of bits to compare
4406 key_bbcmp(const void *a1, const void *a2, u_int bits)
4408 const unsigned char *p1 = a1;
4409 const unsigned char *p2 = a2;
4411 /* XXX: This could be considerably faster if we compare a word
4412 * at a time, but it is complicated on LSB Endian machines */
4414 /* Handle null pointers */
4415 if (p1 == NULL || p2 == NULL)
4425 u_int8_t mask = ~((1<<(8-bits))-1);
4426 if ((*p1 & mask) != (*p2 & mask))
4429 return 1; /* Match! */
4433 key_flush_spd(time_t now)
4435 SPTREE_RLOCK_TRACKER;
4436 struct secpolicy_list drainq;
4437 struct secpolicy *sp, *nextsp;
4442 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4443 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4444 if (sp->lifetime == 0 && sp->validtime == 0)
4446 if ((sp->lifetime &&
4447 now - sp->created > sp->lifetime) ||
4449 now - sp->lastused > sp->validtime)) {
4450 /* Hold extra reference to send SPDEXPIRE */
4452 LIST_INSERT_HEAD(&drainq, sp, drainq);
4457 if (LIST_EMPTY(&drainq))
4461 sp = LIST_FIRST(&drainq);
4462 while (sp != NULL) {
4463 nextsp = LIST_NEXT(sp, drainq);
4464 /* Check that SP is still linked */
4465 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4466 LIST_REMOVE(sp, drainq);
4467 key_freesp(&sp); /* release extra reference */
4471 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4473 LIST_REMOVE(sp, idhash);
4474 sp->state = IPSEC_SPSTATE_DEAD;
4479 if (SPDCACHE_ENABLED())
4482 sp = LIST_FIRST(&drainq);
4483 while (sp != NULL) {
4484 nextsp = LIST_NEXT(sp, drainq);
4486 key_freesp(&sp); /* release extra reference */
4487 key_freesp(&sp); /* release last reference */
4493 key_flush_sad(time_t now)
4495 SAHTREE_RLOCK_TRACKER;
4496 struct secashead_list emptyq;
4497 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4498 struct secashead *sah, *nextsah;
4499 struct secasvar *sav, *nextsav;
4502 LIST_INIT(&hexpireq);
4503 LIST_INIT(&sexpireq);
4507 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4508 /* Check for empty SAH */
4509 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4510 TAILQ_EMPTY(&sah->savtree_alive)) {
4512 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4515 /* Add all stale LARVAL SAs into drainq */
4516 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4517 if (now - sav->created < V_key_larval_lifetime)
4520 LIST_INSERT_HEAD(&drainq, sav, drainq);
4522 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4523 /* lifetimes aren't specified */
4524 if (sav->lft_h == NULL)
4528 * Check again with lock held, because it may
4529 * be updated by SADB_UPDATE.
4531 if (sav->lft_h == NULL) {
4532 SECASVAR_UNLOCK(sav);
4537 * HARD lifetimes MUST take precedence over SOFT
4538 * lifetimes, meaning if the HARD and SOFT lifetimes
4539 * are the same, the HARD lifetime will appear on the
4542 /* check HARD lifetime */
4543 if ((sav->lft_h->addtime != 0 &&
4544 now - sav->created > sav->lft_h->addtime) ||
4545 (sav->lft_h->usetime != 0 && sav->firstused &&
4546 now - sav->firstused > sav->lft_h->usetime) ||
4547 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4548 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4549 SECASVAR_UNLOCK(sav);
4551 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4554 /* check SOFT lifetime (only for MATURE SAs) */
4555 if (sav->state == SADB_SASTATE_MATURE && (
4556 (sav->lft_s->addtime != 0 &&
4557 now - sav->created > sav->lft_s->addtime) ||
4558 (sav->lft_s->usetime != 0 && sav->firstused &&
4559 now - sav->firstused > sav->lft_s->usetime) ||
4560 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4561 sav->lft_c_bytes) > sav->lft_s->bytes))) {
4562 SECASVAR_UNLOCK(sav);
4564 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4567 SECASVAR_UNLOCK(sav);
4572 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4573 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4578 /* Unlink stale LARVAL SAs */
4579 sav = LIST_FIRST(&drainq);
4580 while (sav != NULL) {
4581 nextsav = LIST_NEXT(sav, drainq);
4582 /* Check that SA is still LARVAL */
4583 if (sav->state != SADB_SASTATE_LARVAL) {
4584 LIST_REMOVE(sav, drainq);
4585 LIST_INSERT_HEAD(&freeq, sav, drainq);
4589 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4590 LIST_REMOVE(sav, spihash);
4591 sav->state = SADB_SASTATE_DEAD;
4594 /* Unlink all SAs with expired HARD lifetime */
4595 sav = LIST_FIRST(&hexpireq);
4596 while (sav != NULL) {
4597 nextsav = LIST_NEXT(sav, drainq);
4598 /* Check that SA is not unlinked */
4599 if (sav->state == SADB_SASTATE_DEAD) {
4600 LIST_REMOVE(sav, drainq);
4601 LIST_INSERT_HEAD(&freeq, sav, drainq);
4605 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4606 LIST_REMOVE(sav, spihash);
4607 sav->state = SADB_SASTATE_DEAD;
4610 /* Mark all SAs with expired SOFT lifetime as DYING */
4611 sav = LIST_FIRST(&sexpireq);
4612 while (sav != NULL) {
4613 nextsav = LIST_NEXT(sav, drainq);
4614 /* Check that SA is not unlinked */
4615 if (sav->state == SADB_SASTATE_DEAD) {
4616 LIST_REMOVE(sav, drainq);
4617 LIST_INSERT_HEAD(&freeq, sav, drainq);
4622 * NOTE: this doesn't change SA order in the chain.
4624 sav->state = SADB_SASTATE_DYING;
4627 /* Unlink empty SAHs */
4628 sah = LIST_FIRST(&emptyq);
4629 while (sah != NULL) {
4630 nextsah = LIST_NEXT(sah, drainq);
4631 /* Check that SAH is still empty and not unlinked */
4632 if (sah->state == SADB_SASTATE_DEAD ||
4633 !TAILQ_EMPTY(&sah->savtree_larval) ||
4634 !TAILQ_EMPTY(&sah->savtree_alive)) {
4635 LIST_REMOVE(sah, drainq);
4636 key_freesah(&sah); /* release extra reference */
4640 TAILQ_REMOVE(&V_sahtree, sah, chain);
4641 LIST_REMOVE(sah, addrhash);
4642 sah->state = SADB_SASTATE_DEAD;
4647 /* Send SPDEXPIRE messages */
4648 sav = LIST_FIRST(&hexpireq);
4649 while (sav != NULL) {
4650 nextsav = LIST_NEXT(sav, drainq);
4652 key_freesah(&sav->sah); /* release reference from SAV */
4653 key_freesav(&sav); /* release extra reference */
4654 key_freesav(&sav); /* release last reference */
4657 sav = LIST_FIRST(&sexpireq);
4658 while (sav != NULL) {
4659 nextsav = LIST_NEXT(sav, drainq);
4661 key_freesav(&sav); /* release extra reference */
4664 /* Free stale LARVAL SAs */
4665 sav = LIST_FIRST(&drainq);
4666 while (sav != NULL) {
4667 nextsav = LIST_NEXT(sav, drainq);
4668 key_freesah(&sav->sah); /* release reference from SAV */
4669 key_freesav(&sav); /* release extra reference */
4670 key_freesav(&sav); /* release last reference */
4673 /* Free SAs that were unlinked/changed by someone else */
4674 sav = LIST_FIRST(&freeq);
4675 while (sav != NULL) {
4676 nextsav = LIST_NEXT(sav, drainq);
4677 key_freesav(&sav); /* release extra reference */
4680 /* Free empty SAH */
4681 sah = LIST_FIRST(&emptyq);
4682 while (sah != NULL) {
4683 nextsah = LIST_NEXT(sah, drainq);
4684 key_freesah(&sah); /* release extra reference */
4685 key_freesah(&sah); /* release last reference */
4691 key_flush_acq(time_t now)
4693 struct secacq *acq, *nextacq;
4697 acq = LIST_FIRST(&V_acqtree);
4698 while (acq != NULL) {
4699 nextacq = LIST_NEXT(acq, chain);
4700 if (now - acq->created > V_key_blockacq_lifetime) {
4701 LIST_REMOVE(acq, chain);
4702 LIST_REMOVE(acq, addrhash);
4703 LIST_REMOVE(acq, seqhash);
4704 free(acq, M_IPSEC_SAQ);
4712 key_flush_spacq(time_t now)
4714 struct secspacq *acq, *nextacq;
4718 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4719 nextacq = LIST_NEXT(acq, chain);
4720 if (now - acq->created > V_key_blockacq_lifetime
4721 && __LIST_CHAINED(acq)) {
4722 LIST_REMOVE(acq, chain);
4723 free(acq, M_IPSEC_SAQ);
4731 * scanning SPD and SAD to check status for each entries,
4732 * and do to remove or to expire.
4733 * XXX: year 2038 problem may remain.
4736 key_timehandler(void *arg)
4738 VNET_ITERATOR_DECL(vnet_iter);
4739 time_t now = time_second;
4741 VNET_LIST_RLOCK_NOSLEEP();
4742 VNET_FOREACH(vnet_iter) {
4743 CURVNET_SET(vnet_iter);
4747 key_flush_spacq(now);
4750 VNET_LIST_RUNLOCK_NOSLEEP();
4752 #ifndef IPSEC_DEBUG2
4753 /* do exchange to tick time !! */
4754 callout_schedule(&key_timer, hz);
4755 #endif /* IPSEC_DEBUG2 */
4763 arc4random_buf(&value, sizeof(value));
4768 * map SADB_SATYPE_* to IPPROTO_*.
4769 * if satype == SADB_SATYPE then satype is mapped to ~0.
4771 * 0: invalid satype.
4774 key_satype2proto(uint8_t satype)
4777 case SADB_SATYPE_UNSPEC:
4778 return IPSEC_PROTO_ANY;
4779 case SADB_SATYPE_AH:
4781 case SADB_SATYPE_ESP:
4783 case SADB_X_SATYPE_IPCOMP:
4784 return IPPROTO_IPCOMP;
4785 case SADB_X_SATYPE_TCPSIGNATURE:
4794 * map IPPROTO_* to SADB_SATYPE_*
4796 * 0: invalid protocol type.
4799 key_proto2satype(uint8_t proto)
4803 return SADB_SATYPE_AH;
4805 return SADB_SATYPE_ESP;
4806 case IPPROTO_IPCOMP:
4807 return SADB_X_SATYPE_IPCOMP;
4809 return SADB_X_SATYPE_TCPSIGNATURE;
4818 * SADB_GETSPI processing is to receive
4819 * <base, (SA2), src address, dst address, (SPI range)>
4820 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4821 * tree with the status of LARVAL, and send
4822 * <base, SA(*), address(SD)>
4825 * IN: mhp: pointer to the pointer to each header.
4826 * OUT: NULL if fail.
4827 * other if success, return pointer to the message to send.
4830 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4832 struct secasindex saidx;
4833 struct sadb_address *src0, *dst0;
4834 struct secasvar *sav;
4835 uint32_t reqid, spi;
4837 uint8_t mode, proto;
4839 IPSEC_ASSERT(so != NULL, ("null socket"));
4840 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4841 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4842 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4844 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4845 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4846 #ifdef PFKEY_STRICT_CHECKS
4847 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4850 ipseclog((LOG_DEBUG,
4851 "%s: invalid message: missing required header.\n",
4856 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4857 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4858 #ifdef PFKEY_STRICT_CHECKS
4859 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4862 ipseclog((LOG_DEBUG,
4863 "%s: invalid message: wrong header size.\n", __func__));
4867 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4868 mode = IPSEC_MODE_ANY;
4871 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4872 ipseclog((LOG_DEBUG,
4873 "%s: invalid message: wrong header size.\n",
4878 mode = ((struct sadb_x_sa2 *)
4879 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4880 reqid = ((struct sadb_x_sa2 *)
4881 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4884 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4885 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4887 /* map satype to proto */
4888 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4889 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4894 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4895 (struct sockaddr *)(dst0 + 1));
4897 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4901 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4903 /* SPI allocation */
4904 spi = key_do_getnewspi(
4905 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4908 * Requested SPI or SPI range is not available or
4914 sav = key_newsav(mhp, &saidx, spi, &error);
4918 if (sav->seq != 0) {
4921 * If the SADB_GETSPI message is in response to a
4922 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4923 * MUST be the same as the SADB_ACQUIRE message.
4925 * XXXAE: However it doesn't definethe behaviour how to
4926 * check this and what to do if it doesn't match.
4927 * Also what we should do if it matches?
4929 * We can compare saidx used in SADB_ACQUIRE with saidx
4930 * used in SADB_GETSPI, but this probably can break
4931 * existing software. For now just warn if it doesn't match.
4933 * XXXAE: anyway it looks useless.
4935 key_acqdone(&saidx, sav->seq);
4938 printf("%s: SA(%p)\n", __func__, sav));
4939 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4942 struct mbuf *n, *nn;
4943 struct sadb_sa *m_sa;
4944 struct sadb_msg *newmsg;
4947 /* create new sadb_msg to reply. */
4948 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4949 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4951 MGETHDR(n, M_NOWAIT, MT_DATA);
4953 if (!(MCLGET(n, M_NOWAIT))) {
4967 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
4968 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
4970 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
4971 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
4972 m_sa->sadb_sa_exttype = SADB_EXT_SA;
4973 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
4974 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
4976 IPSEC_ASSERT(off == len,
4977 ("length inconsistency (off %u len %u)", off, len));
4979 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
4980 SADB_EXT_ADDRESS_DST);
4987 if (n->m_len < sizeof(struct sadb_msg)) {
4988 n = m_pullup(n, sizeof(struct sadb_msg));
4990 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
4993 n->m_pkthdr.len = 0;
4994 for (nn = n; nn; nn = nn->m_next)
4995 n->m_pkthdr.len += nn->m_len;
4997 newmsg = mtod(n, struct sadb_msg *);
4998 newmsg->sadb_msg_seq = sav->seq;
4999 newmsg->sadb_msg_errno = 0;
5000 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
5003 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
5007 return (key_senderror(so, m, error));
5011 * allocating new SPI
5012 * called by key_getspi().
5015 * others: success, SPI in network byte order.
5018 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
5020 uint32_t min, max, newspi, t;
5021 int count = V_key_spi_trycnt;
5023 /* set spi range to allocate */
5024 if (spirange != NULL) {
5025 min = spirange->sadb_spirange_min;
5026 max = spirange->sadb_spirange_max;
5028 min = V_key_spi_minval;
5029 max = V_key_spi_maxval;
5031 /* IPCOMP needs 2-byte SPI */
5032 if (saidx->proto == IPPROTO_IPCOMP) {
5038 t = min; min = max; max = t;
5043 if (!key_checkspidup(htonl(min))) {
5044 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
5049 count--; /* taking one cost. */
5056 /* when requesting to allocate spi ranged */
5058 /* generate pseudo-random SPI value ranged. */
5059 newspi = min + (key_random() % (max - min + 1));
5060 if (!key_checkspidup(htonl(newspi)))
5064 if (count == 0 || newspi == 0) {
5065 ipseclog((LOG_DEBUG,
5066 "%s: failed to allocate SPI.\n", __func__));
5072 keystat.getspi_count =
5073 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
5075 return (htonl(newspi));
5079 * Find TCP-MD5 SA with corresponding secasindex.
5080 * If not found, return NULL and fill SPI with usable value if needed.
5082 static struct secasvar *
5083 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
5085 SAHTREE_RLOCK_TRACKER;
5086 struct secashead *sah;
5087 struct secasvar *sav;
5089 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
5091 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5092 if (sah->saidx.proto != IPPROTO_TCP)
5094 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
5095 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
5099 if (V_key_preferred_oldsa)
5100 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
5102 sav = TAILQ_FIRST(&sah->savtree_alive);
5110 /* No SPI required */
5114 /* Check that SPI is unique */
5115 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5116 if (sav->spi == *spi)
5121 /* SPI is already unique */
5125 /* XXX: not optimal */
5126 *spi = key_do_getnewspi(NULL, saidx);
5131 key_updateaddresses(struct socket *so, struct mbuf *m,
5132 const struct sadb_msghdr *mhp, struct secasvar *sav,
5133 struct secasindex *saidx)
5135 struct sockaddr *newaddr;
5136 struct secashead *sah;
5137 struct secasvar *newsav, *tmp;
5141 /* Check that we need to change SAH */
5142 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5143 newaddr = (struct sockaddr *)(
5144 ((struct sadb_address *)
5145 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5146 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5147 key_porttosaddr(&saidx->src.sa, 0);
5149 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5150 newaddr = (struct sockaddr *)(
5151 ((struct sadb_address *)
5152 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5153 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5154 key_porttosaddr(&saidx->dst.sa, 0);
5156 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5157 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5158 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5160 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5165 sah = key_getsah(saidx);
5167 /* create a new SA index */
5168 sah = key_newsah(saidx);
5170 ipseclog((LOG_DEBUG,
5171 "%s: No more memory.\n", __func__));
5174 isnew = 2; /* SAH is new */
5176 isnew = 1; /* existing SAH is referenced */
5179 * src and dst addresses are still the same.
5180 * Do we want to change NAT-T config?
5182 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5183 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5184 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5185 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5186 ipseclog((LOG_DEBUG,
5187 "%s: invalid message: missing required header.\n",
5191 /* We hold reference to SA, thus SAH will be referenced too. */
5196 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5198 if (newsav == NULL) {
5199 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5204 /* Clone SA's content into newsav */
5205 SAV_INITREF(newsav);
5206 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5208 * We create new NAT-T config if it is needed.
5209 * Old NAT-T config will be freed by key_cleansav() when
5210 * last reference to SA will be released.
5212 newsav->natt = NULL;
5214 newsav->state = SADB_SASTATE_MATURE;
5215 error = key_setnatt(newsav, mhp);
5220 /* Check that SA is still alive */
5221 if (sav->state == SADB_SASTATE_DEAD) {
5222 /* SA was unlinked */
5228 /* Unlink SA from SAH and SPI hash */
5229 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5230 ("SA is already cloned"));
5231 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5232 sav->state == SADB_SASTATE_DYING,
5233 ("Wrong SA state %u\n", sav->state));
5234 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5235 LIST_REMOVE(sav, spihash);
5236 sav->state = SADB_SASTATE_DEAD;
5239 * Link new SA with SAH. Keep SAs ordered by
5240 * create time (newer are first).
5242 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5243 if (newsav->created > tmp->created) {
5244 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5249 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5251 /* Add new SA into SPI hash. */
5252 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5254 /* Add new SAH into SADB. */
5256 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5257 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5258 sah->state = SADB_SASTATE_MATURE;
5259 SAH_ADDREF(sah); /* newsav references new SAH */
5262 * isnew == 1 -> @sah was referenced by key_getsah().
5263 * isnew == 0 -> we use the same @sah, that was used by @sav,
5264 * and we use its reference for @newsav.
5267 /* XXX: replace cntr with pointer? */
5268 newsav->cntr = sav->cntr;
5269 sav->flags |= SADB_X_EXT_F_CLONED;
5270 SECASVAR_UNLOCK(sav);
5275 printf("%s: SA(%p) cloned into SA(%p)\n",
5276 __func__, sav, newsav));
5277 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5279 key_freesav(&sav); /* release last reference */
5281 /* set msg buf from mhp */
5282 n = key_getmsgbuf_x1(m, mhp);
5284 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5288 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5293 if (newsav != NULL) {
5294 if (newsav->natt != NULL)
5295 free(newsav->natt, M_IPSEC_MISC);
5296 free(newsav, M_IPSEC_SA);
5302 * SADB_UPDATE processing
5304 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5305 * key(AE), (identity(SD),) (sensitivity)>
5306 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5308 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5309 * (identity(SD),) (sensitivity)>
5312 * m will always be freed.
5315 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5317 struct secasindex saidx;
5318 struct sadb_address *src0, *dst0;
5319 struct sadb_sa *sa0;
5320 struct secasvar *sav;
5323 uint8_t mode, proto;
5325 IPSEC_ASSERT(so != NULL, ("null socket"));
5326 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5327 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5328 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5330 /* map satype to proto */
5331 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5332 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5334 return key_senderror(so, m, EINVAL);
5337 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5338 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5339 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5340 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5341 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5342 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5343 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5344 ipseclog((LOG_DEBUG,
5345 "%s: invalid message: missing required header.\n",
5347 return key_senderror(so, m, EINVAL);
5349 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5350 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5351 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5352 ipseclog((LOG_DEBUG,
5353 "%s: invalid message: wrong header size.\n", __func__));
5354 return key_senderror(so, m, EINVAL);
5356 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5357 mode = IPSEC_MODE_ANY;
5360 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5361 ipseclog((LOG_DEBUG,
5362 "%s: invalid message: wrong header size.\n",
5364 return key_senderror(so, m, EINVAL);
5366 mode = ((struct sadb_x_sa2 *)
5367 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5368 reqid = ((struct sadb_x_sa2 *)
5369 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5372 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5373 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5374 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5377 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5378 * SADB_UPDATE message.
5380 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5381 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5382 #ifdef PFKEY_STRICT_CHECKS
5383 return key_senderror(so, m, EINVAL);
5386 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5387 (struct sockaddr *)(dst0 + 1));
5389 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5390 return key_senderror(so, m, error);
5392 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5393 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5395 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5396 __func__, ntohl(sa0->sadb_sa_spi)));
5397 return key_senderror(so, m, EINVAL);
5400 * Check that SADB_UPDATE issued by the same process that did
5401 * SADB_GETSPI or SADB_ADD.
5403 if (sav->pid != mhp->msg->sadb_msg_pid) {
5404 ipseclog((LOG_DEBUG,
5405 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5406 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5408 return key_senderror(so, m, EINVAL);
5410 /* saidx should match with SA. */
5411 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5412 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u\n",
5413 __func__, ntohl(sav->spi)));
5415 return key_senderror(so, m, ESRCH);
5418 if (sav->state == SADB_SASTATE_LARVAL) {
5419 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5420 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5421 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5422 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5423 ipseclog((LOG_DEBUG,
5424 "%s: invalid message: missing required header.\n",
5427 return key_senderror(so, m, EINVAL);
5430 * We can set any values except src, dst and SPI.
5432 error = key_setsaval(sav, mhp);
5435 return (key_senderror(so, m, error));
5437 /* Change SA state to MATURE */
5439 if (sav->state != SADB_SASTATE_LARVAL) {
5440 /* SA was deleted or another thread made it MATURE. */
5443 return (key_senderror(so, m, ESRCH));
5446 * NOTE: we keep SAs in savtree_alive ordered by created
5447 * time. When SA's state changed from LARVAL to MATURE,
5448 * we update its created time in key_setsaval() and move
5449 * it into head of savtree_alive.
5451 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5452 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5453 sav->state = SADB_SASTATE_MATURE;
5457 * For DYING and MATURE SA we can change only state
5458 * and lifetimes. Report EINVAL if something else attempted
5461 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5462 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5464 return (key_senderror(so, m, EINVAL));
5466 error = key_updatelifetimes(sav, mhp);
5469 return (key_senderror(so, m, error));
5472 * This is FreeBSD extension to RFC2367.
5473 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5474 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5475 * SA addresses (for example to implement MOBIKE protocol
5476 * as described in RFC4555). Also we allow to change
5479 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5480 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5481 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5482 sav->natt != NULL) {
5483 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5486 return (key_senderror(so, m, error));
5489 /* Check that SA is still alive */
5491 if (sav->state == SADB_SASTATE_DEAD) {
5492 /* SA was unlinked */
5495 return (key_senderror(so, m, ESRCH));
5498 * NOTE: there is possible state moving from DYING to MATURE,
5499 * but this doesn't change created time, so we won't reorder
5502 sav->state = SADB_SASTATE_MATURE;
5506 printf("%s: SA(%p)\n", __func__, sav));
5507 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5513 /* set msg buf from mhp */
5514 n = key_getmsgbuf_x1(m, mhp);
5516 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5517 return key_senderror(so, m, ENOBUFS);
5521 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5526 * SADB_ADD processing
5527 * add an entry to SA database, when received
5528 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5529 * key(AE), (identity(SD),) (sensitivity)>
5532 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5533 * (identity(SD),) (sensitivity)>
5536 * IGNORE identity and sensitivity messages.
5538 * m will always be freed.
5541 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5543 struct secasindex saidx;
5544 struct sadb_address *src0, *dst0;
5545 struct sadb_sa *sa0;
5546 struct secasvar *sav;
5547 uint32_t reqid, spi;
5548 uint8_t mode, proto;
5551 IPSEC_ASSERT(so != NULL, ("null socket"));
5552 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5553 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5554 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5556 /* map satype to proto */
5557 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5558 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5560 return key_senderror(so, m, EINVAL);
5563 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5564 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5565 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5566 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5567 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5568 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5569 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5570 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5571 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5572 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5573 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5574 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5575 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5576 ipseclog((LOG_DEBUG,
5577 "%s: invalid message: missing required header.\n",
5579 return key_senderror(so, m, EINVAL);
5581 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5582 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5583 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5584 ipseclog((LOG_DEBUG,
5585 "%s: invalid message: wrong header size.\n", __func__));
5586 return key_senderror(so, m, EINVAL);
5588 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5589 mode = IPSEC_MODE_ANY;
5592 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5593 ipseclog((LOG_DEBUG,
5594 "%s: invalid message: wrong header size.\n",
5596 return key_senderror(so, m, EINVAL);
5598 mode = ((struct sadb_x_sa2 *)
5599 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5600 reqid = ((struct sadb_x_sa2 *)
5601 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5604 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5605 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5606 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5609 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5612 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5613 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5614 #ifdef PFKEY_STRICT_CHECKS
5615 return key_senderror(so, m, EINVAL);
5618 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5619 (struct sockaddr *)(dst0 + 1));
5621 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5622 return key_senderror(so, m, error);
5624 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5625 spi = sa0->sadb_sa_spi;
5627 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5629 * XXXAE: IPComp seems also doesn't use SPI.
5631 if (proto == IPPROTO_TCP) {
5632 sav = key_getsav_tcpmd5(&saidx, &spi);
5633 if (sav == NULL && spi == 0) {
5634 /* Failed to allocate SPI */
5635 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5637 return key_senderror(so, m, EEXIST);
5639 /* XXX: SPI that we report back can have another value */
5641 /* We can create new SA only if SPI is different. */
5642 sav = key_getsavbyspi(spi);
5646 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5647 return key_senderror(so, m, EEXIST);
5650 sav = key_newsav(mhp, &saidx, spi, &error);
5652 return key_senderror(so, m, error);
5654 printf("%s: return SA(%p)\n", __func__, sav));
5655 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5657 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5661 key_acqdone(&saidx, sav->seq);
5665 * Don't call key_freesav() on error here, as we would like to
5666 * keep the SA in the database.
5670 /* set msg buf from mhp */
5671 n = key_getmsgbuf_x1(m, mhp);
5673 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5674 return key_senderror(so, m, ENOBUFS);
5678 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5684 * IKEd may request the use ESP in UDP encapsulation when it detects the
5685 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5686 * parameters needed for encapsulation and decapsulation. These PF_KEY
5687 * extension headers are not standardized, so this comment addresses our
5689 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5690 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5691 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5692 * UDP header. We use these ports in UDP encapsulation procedure, also we
5693 * can check them in UDP decapsulation procedure.
5694 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5695 * responder. These addresses can be used for transport mode to adjust
5696 * checksum after decapsulation and decryption. Since original IP addresses
5697 * used by peer usually different (we detected presence of NAT), TCP/UDP
5698 * pseudo header checksum and IP header checksum was calculated using original
5699 * addresses. After decapsulation and decryption we need to adjust checksum
5700 * to have correct datagram.
5702 * We expect presence of NAT-T extension headers only in SADB_ADD and
5703 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5704 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5707 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5709 struct sadb_x_nat_t_port *port;
5710 struct sadb_x_nat_t_type *type;
5711 struct sadb_address *oai, *oar;
5712 struct sockaddr *sa;
5716 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5718 * Ignore NAT-T headers if sproto isn't ESP.
5720 if (sav->sah->saidx.proto != IPPROTO_ESP)
5723 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5724 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5725 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5726 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5727 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5728 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5729 ipseclog((LOG_DEBUG,
5730 "%s: invalid message: wrong header size.\n",
5737 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5738 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5739 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5740 __func__, type->sadb_x_nat_t_type_type));
5744 * Allocate storage for NAT-T config.
5745 * On error it will be released by key_cleansav().
5747 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5749 if (sav->natt == NULL) {
5750 PFKEYSTAT_INC(in_nomem);
5751 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5754 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5755 if (port->sadb_x_nat_t_port_port == 0) {
5756 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5760 sav->natt->sport = port->sadb_x_nat_t_port_port;
5761 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5762 if (port->sadb_x_nat_t_port_port == 0) {
5763 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5767 sav->natt->dport = port->sadb_x_nat_t_port_port;
5770 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5771 * and needed only for transport mode IPsec.
5772 * Usually NAT translates only one address, but it is possible,
5773 * that both addresses could be translated.
5774 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5776 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5777 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5778 ipseclog((LOG_DEBUG,
5779 "%s: invalid message: wrong header size.\n",
5783 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5786 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5787 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5788 ipseclog((LOG_DEBUG,
5789 "%s: invalid message: wrong header size.\n",
5793 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5797 /* Initialize addresses only for transport mode */
5798 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5801 /* Currently we support only AF_INET */
5802 sa = (struct sockaddr *)(oai + 1);
5803 if (sa->sa_family != AF_INET ||
5804 sa->sa_len != sizeof(struct sockaddr_in)) {
5805 ipseclog((LOG_DEBUG,
5806 "%s: wrong NAT-OAi header.\n",
5810 /* Ignore address if it the same */
5811 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5812 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5813 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5814 sav->natt->flags |= IPSEC_NATT_F_OAI;
5815 /* Calculate checksum delta */
5816 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5817 cksum = in_addword(cksum, ~addr >> 16);
5818 cksum = in_addword(cksum, ~addr & 0xffff);
5819 addr = sav->natt->oai.sin.sin_addr.s_addr;
5820 cksum = in_addword(cksum, addr >> 16);
5821 cksum = in_addword(cksum, addr & 0xffff);
5825 /* Currently we support only AF_INET */
5826 sa = (struct sockaddr *)(oar + 1);
5827 if (sa->sa_family != AF_INET ||
5828 sa->sa_len != sizeof(struct sockaddr_in)) {
5829 ipseclog((LOG_DEBUG,
5830 "%s: wrong NAT-OAr header.\n",
5834 /* Ignore address if it the same */
5835 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5836 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5837 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5838 sav->natt->flags |= IPSEC_NATT_F_OAR;
5839 /* Calculate checksum delta */
5840 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5841 cksum = in_addword(cksum, ~addr >> 16);
5842 cksum = in_addword(cksum, ~addr & 0xffff);
5843 addr = sav->natt->oar.sin.sin_addr.s_addr;
5844 cksum = in_addword(cksum, addr >> 16);
5845 cksum = in_addword(cksum, addr & 0xffff);
5848 sav->natt->cksum = cksum;
5854 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5856 const struct sadb_ident *idsrc, *iddst;
5858 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5859 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5860 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5862 /* don't make buffer if not there */
5863 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5864 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5870 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5871 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5872 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5876 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5877 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5879 /* validity check */
5880 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5881 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5885 switch (idsrc->sadb_ident_type) {
5886 case SADB_IDENTTYPE_PREFIX:
5887 case SADB_IDENTTYPE_FQDN:
5888 case SADB_IDENTTYPE_USERFQDN:
5890 /* XXX do nothing */
5896 /* make structure */
5897 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5898 if (sah->idents == NULL) {
5899 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5902 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5903 if (sah->identd == NULL) {
5904 free(sah->idents, M_IPSEC_MISC);
5906 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5909 sah->idents->type = idsrc->sadb_ident_type;
5910 sah->idents->id = idsrc->sadb_ident_id;
5912 sah->identd->type = iddst->sadb_ident_type;
5913 sah->identd->id = iddst->sadb_ident_id;
5919 * m will not be freed on return.
5920 * it is caller's responsibility to free the result.
5922 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5923 * from the request in defined order.
5925 static struct mbuf *
5926 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5930 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5931 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5932 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5934 /* create new sadb_msg to reply. */
5935 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5936 SADB_EXT_SA, SADB_X_EXT_SA2,
5937 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5938 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5939 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5940 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5941 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5942 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5943 SADB_X_EXT_NEW_ADDRESS_DST);
5947 if (n->m_len < sizeof(struct sadb_msg)) {
5948 n = m_pullup(n, sizeof(struct sadb_msg));
5952 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5953 mtod(n, struct sadb_msg *)->sadb_msg_len =
5954 PFKEY_UNIT64(n->m_pkthdr.len);
5960 * SADB_DELETE processing
5962 * <base, SA(*), address(SD)>
5963 * from the ikmpd, and set SADB_SASTATE_DEAD,
5965 * <base, SA(*), address(SD)>
5968 * m will always be freed.
5971 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5973 struct secasindex saidx;
5974 struct sadb_address *src0, *dst0;
5975 struct secasvar *sav;
5976 struct sadb_sa *sa0;
5979 IPSEC_ASSERT(so != NULL, ("null socket"));
5980 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5981 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5982 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5984 /* map satype to proto */
5985 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5986 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5988 return key_senderror(so, m, EINVAL);
5991 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5992 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5993 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5994 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5995 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
5997 return key_senderror(so, m, EINVAL);
6000 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
6001 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
6003 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6004 (struct sockaddr *)(dst0 + 1)) != 0) {
6005 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6006 return (key_senderror(so, m, EINVAL));
6008 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6009 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
6011 * Caller wants us to delete all non-LARVAL SAs
6012 * that match the src/dst. This is used during
6013 * IKE INITIAL-CONTACT.
6014 * XXXAE: this looks like some extension to RFC2367.
6016 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
6017 return (key_delete_all(so, m, mhp, &saidx));
6019 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
6020 ipseclog((LOG_DEBUG,
6021 "%s: invalid message: wrong header size.\n", __func__));
6022 return (key_senderror(so, m, EINVAL));
6024 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6025 if (proto == IPPROTO_TCP)
6026 sav = key_getsav_tcpmd5(&saidx, NULL);
6028 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6030 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
6031 __func__, ntohl(sa0->sadb_sa_spi)));
6032 return (key_senderror(so, m, ESRCH));
6034 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6035 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6036 __func__, ntohl(sav->spi)));
6038 return (key_senderror(so, m, ESRCH));
6041 printf("%s: SA(%p)\n", __func__, sav));
6042 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6048 struct sadb_msg *newmsg;
6050 /* create new sadb_msg to reply. */
6051 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
6052 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6054 return key_senderror(so, m, ENOBUFS);
6056 if (n->m_len < sizeof(struct sadb_msg)) {
6057 n = m_pullup(n, sizeof(struct sadb_msg));
6059 return key_senderror(so, m, ENOBUFS);
6061 newmsg = mtod(n, struct sadb_msg *);
6062 newmsg->sadb_msg_errno = 0;
6063 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6066 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6071 * delete all SAs for src/dst. Called from key_delete().
6074 key_delete_all(struct socket *so, struct mbuf *m,
6075 const struct sadb_msghdr *mhp, struct secasindex *saidx)
6077 struct secasvar_queue drainq;
6078 struct secashead *sah;
6079 struct secasvar *sav, *nextsav;
6081 TAILQ_INIT(&drainq);
6083 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
6084 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
6086 /* Move all ALIVE SAs into drainq */
6087 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6089 /* Unlink all queued SAs from SPI hash */
6090 TAILQ_FOREACH(sav, &drainq, chain) {
6091 sav->state = SADB_SASTATE_DEAD;
6092 LIST_REMOVE(sav, spihash);
6095 /* Now we can release reference for all SAs in drainq */
6096 sav = TAILQ_FIRST(&drainq);
6097 while (sav != NULL) {
6099 printf("%s: SA(%p)\n", __func__, sav));
6100 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6101 nextsav = TAILQ_NEXT(sav, chain);
6102 key_freesah(&sav->sah); /* release reference from SAV */
6103 key_freesav(&sav); /* release last reference */
6109 struct sadb_msg *newmsg;
6111 /* create new sadb_msg to reply. */
6112 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6113 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6115 return key_senderror(so, m, ENOBUFS);
6117 if (n->m_len < sizeof(struct sadb_msg)) {
6118 n = m_pullup(n, sizeof(struct sadb_msg));
6120 return key_senderror(so, m, ENOBUFS);
6122 newmsg = mtod(n, struct sadb_msg *);
6123 newmsg->sadb_msg_errno = 0;
6124 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6127 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6132 * Delete all alive SAs for corresponding xform.
6133 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6134 * here when xform disappears.
6137 key_delete_xform(const struct xformsw *xsp)
6139 struct secasvar_queue drainq;
6140 struct secashead *sah;
6141 struct secasvar *sav, *nextsav;
6143 TAILQ_INIT(&drainq);
6145 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6146 sav = TAILQ_FIRST(&sah->savtree_alive);
6149 if (sav->tdb_xform != xsp)
6152 * It is supposed that all SAs in the chain are related to
6155 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6157 /* Unlink all queued SAs from SPI hash */
6158 TAILQ_FOREACH(sav, &drainq, chain) {
6159 sav->state = SADB_SASTATE_DEAD;
6160 LIST_REMOVE(sav, spihash);
6164 /* Now we can release reference for all SAs in drainq */
6165 sav = TAILQ_FIRST(&drainq);
6166 while (sav != NULL) {
6168 printf("%s: SA(%p)\n", __func__, sav));
6169 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6170 nextsav = TAILQ_NEXT(sav, chain);
6171 key_freesah(&sav->sah); /* release reference from SAV */
6172 key_freesav(&sav); /* release last reference */
6178 * SADB_GET processing
6180 * <base, SA(*), address(SD)>
6181 * from the ikmpd, and get a SP and a SA to respond,
6183 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6184 * (identity(SD),) (sensitivity)>
6187 * m will always be freed.
6190 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6192 struct secasindex saidx;
6193 struct sadb_address *src0, *dst0;
6194 struct sadb_sa *sa0;
6195 struct secasvar *sav;
6198 IPSEC_ASSERT(so != NULL, ("null socket"));
6199 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6200 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6201 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6203 /* map satype to proto */
6204 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6205 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6207 return key_senderror(so, m, EINVAL);
6210 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6211 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6212 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6213 ipseclog((LOG_DEBUG,
6214 "%s: invalid message: missing required header.\n",
6216 return key_senderror(so, m, EINVAL);
6218 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6219 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6220 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6221 ipseclog((LOG_DEBUG,
6222 "%s: invalid message: wrong header size.\n", __func__));
6223 return key_senderror(so, m, EINVAL);
6226 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6227 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6228 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6230 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6231 (struct sockaddr *)(dst0 + 1)) != 0) {
6232 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6233 return key_senderror(so, m, EINVAL);
6235 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6237 if (proto == IPPROTO_TCP)
6238 sav = key_getsav_tcpmd5(&saidx, NULL);
6240 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6242 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6243 return key_senderror(so, m, ESRCH);
6245 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6246 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6247 __func__, ntohl(sa0->sadb_sa_spi)));
6249 return (key_senderror(so, m, ESRCH));
6256 /* map proto to satype */
6257 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6258 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6261 return key_senderror(so, m, EINVAL);
6264 /* create new sadb_msg to reply. */
6265 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6266 mhp->msg->sadb_msg_pid);
6270 return key_senderror(so, m, ENOBUFS);
6273 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6277 /* XXX make it sysctl-configurable? */
6279 key_getcomb_setlifetime(struct sadb_comb *comb)
6282 comb->sadb_comb_soft_allocations = 1;
6283 comb->sadb_comb_hard_allocations = 1;
6284 comb->sadb_comb_soft_bytes = 0;
6285 comb->sadb_comb_hard_bytes = 0;
6286 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6287 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6288 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6289 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6293 * XXX reorder combinations by preference
6294 * XXX no idea if the user wants ESP authentication or not
6296 static struct mbuf *
6297 key_getcomb_ealg(void)
6299 struct sadb_comb *comb;
6300 const struct enc_xform *algo;
6301 struct mbuf *result = NULL, *m, *n;
6305 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6308 for (i = 1; i <= SADB_EALG_MAX; i++) {
6309 algo = enc_algorithm_lookup(i);
6313 /* discard algorithms with key size smaller than system min */
6314 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6316 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6317 encmin = V_ipsec_esp_keymin;
6319 encmin = _BITS(algo->minkey);
6321 if (V_ipsec_esp_auth)
6322 m = key_getcomb_ah();
6324 IPSEC_ASSERT(l <= MLEN,
6325 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6326 MGET(m, M_NOWAIT, MT_DATA);
6331 bzero(mtod(m, caddr_t), m->m_len);
6338 for (n = m; n; n = n->m_next)
6340 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6342 for (off = 0; off < totlen; off += l) {
6343 n = m_pulldown(m, off, l, &o);
6345 /* m is already freed */
6348 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6349 bzero(comb, sizeof(*comb));
6350 key_getcomb_setlifetime(comb);
6351 comb->sadb_comb_encrypt = i;
6352 comb->sadb_comb_encrypt_minbits = encmin;
6353 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6371 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6375 *min = *max = ah->hashsize;
6376 if (ah->keysize == 0) {
6378 * Transform takes arbitrary key size but algorithm
6379 * key size is restricted. Enforce this here.
6382 case SADB_X_AALG_MD5: *min = *max = 16; break;
6383 case SADB_X_AALG_SHA: *min = *max = 20; break;
6384 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6385 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6386 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6387 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6389 DPRINTF(("%s: unknown AH algorithm %u\n",
6397 * XXX reorder combinations by preference
6399 static struct mbuf *
6402 const struct auth_hash *algo;
6403 struct sadb_comb *comb;
6405 u_int16_t minkeysize, maxkeysize;
6407 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6410 for (i = 1; i <= SADB_AALG_MAX; i++) {
6412 /* we prefer HMAC algorithms, not old algorithms */
6413 if (i != SADB_AALG_SHA1HMAC &&
6414 i != SADB_AALG_MD5HMAC &&
6415 i != SADB_X_AALG_SHA2_256 &&
6416 i != SADB_X_AALG_SHA2_384 &&
6417 i != SADB_X_AALG_SHA2_512)
6420 algo = auth_algorithm_lookup(i);
6423 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6424 /* discard algorithms with key size smaller than system min */
6425 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6429 IPSEC_ASSERT(l <= MLEN,
6430 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6431 MGET(m, M_NOWAIT, MT_DATA);
6438 M_PREPEND(m, l, M_NOWAIT);
6442 comb = mtod(m, struct sadb_comb *);
6443 bzero(comb, sizeof(*comb));
6444 key_getcomb_setlifetime(comb);
6445 comb->sadb_comb_auth = i;
6446 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6447 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6454 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6455 * XXX reorder combinations by preference
6457 static struct mbuf *
6458 key_getcomb_ipcomp()
6460 const struct comp_algo *algo;
6461 struct sadb_comb *comb;
6464 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6467 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6468 algo = comp_algorithm_lookup(i);
6473 IPSEC_ASSERT(l <= MLEN,
6474 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6475 MGET(m, M_NOWAIT, MT_DATA);
6482 M_PREPEND(m, l, M_NOWAIT);
6486 comb = mtod(m, struct sadb_comb *);
6487 bzero(comb, sizeof(*comb));
6488 key_getcomb_setlifetime(comb);
6489 comb->sadb_comb_encrypt = i;
6490 /* what should we set into sadb_comb_*_{min,max}bits? */
6497 * XXX no way to pass mode (transport/tunnel) to userland
6498 * XXX replay checking?
6499 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6501 static struct mbuf *
6502 key_getprop(const struct secasindex *saidx)
6504 struct sadb_prop *prop;
6506 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6509 switch (saidx->proto) {
6511 m = key_getcomb_ealg();
6514 m = key_getcomb_ah();
6516 case IPPROTO_IPCOMP:
6517 m = key_getcomb_ipcomp();
6525 M_PREPEND(m, l, M_NOWAIT);
6530 for (n = m; n; n = n->m_next)
6533 prop = mtod(m, struct sadb_prop *);
6534 bzero(prop, sizeof(*prop));
6535 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6536 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6537 prop->sadb_prop_replay = 32; /* XXX */
6543 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6545 * <base, SA, address(SD), (address(P)), x_policy,
6546 * (identity(SD),) (sensitivity,) proposal>
6547 * to KMD, and expect to receive
6548 * <base> with SADB_ACQUIRE if error occurred,
6550 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6551 * from KMD by PF_KEY.
6553 * XXX x_policy is outside of RFC2367 (KAME extension).
6554 * XXX sensitivity is not supported.
6555 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6556 * see comment for key_getcomb_ipcomp().
6560 * others: error number
6563 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6565 union sockaddr_union addr;
6566 struct mbuf *result, *m;
6570 uint8_t mask, satype;
6572 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6573 satype = key_proto2satype(saidx->proto);
6574 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6578 ul_proto = IPSEC_ULPROTO_ANY;
6580 /* Get seq number to check whether sending message or not. */
6581 seq = key_getacq(saidx, &error);
6585 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6593 * set sadb_address for saidx's.
6595 * Note that if sp is supplied, then we're being called from
6596 * key_allocsa_policy() and should supply port and protocol
6598 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6599 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6600 * XXXAE: it looks like we should save this info in the ACQ entry.
6602 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6603 sp->spidx.ul_proto == IPPROTO_UDP))
6604 ul_proto = sp->spidx.ul_proto;
6608 if (ul_proto != IPSEC_ULPROTO_ANY) {
6609 switch (sp->spidx.src.sa.sa_family) {
6611 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6612 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6613 mask = sp->spidx.prefs;
6617 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6618 addr.sin6.sin6_port =
6619 sp->spidx.src.sin6.sin6_port;
6620 mask = sp->spidx.prefs;
6627 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6636 if (ul_proto != IPSEC_ULPROTO_ANY) {
6637 switch (sp->spidx.dst.sa.sa_family) {
6639 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6640 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6641 mask = sp->spidx.prefd;
6645 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6646 addr.sin6.sin6_port =
6647 sp->spidx.dst.sin6.sin6_port;
6648 mask = sp->spidx.prefd;
6655 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6662 /* XXX proxy address (optional) */
6665 * Set sadb_x_policy. This is KAME extension to RFC2367.
6668 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6678 * Set sadb_x_sa2 extension if saidx->reqid is not zero.
6679 * This is FreeBSD extension to RFC2367.
6681 if (saidx->reqid != 0) {
6682 m = key_setsadbxsa2(saidx->mode, 0, saidx->reqid);
6689 /* XXX identity (optional) */
6691 if (idexttype && fqdn) {
6692 /* create identity extension (FQDN) */
6693 struct sadb_ident *id;
6696 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6697 id = (struct sadb_ident *)p;
6698 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6699 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6700 id->sadb_ident_exttype = idexttype;
6701 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6702 bcopy(fqdn, id + 1, fqdnlen);
6703 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6707 /* create identity extension (USERFQDN) */
6708 struct sadb_ident *id;
6712 /* +1 for terminating-NUL */
6713 userfqdnlen = strlen(userfqdn) + 1;
6716 id = (struct sadb_ident *)p;
6717 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6718 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6719 id->sadb_ident_exttype = idexttype;
6720 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6721 /* XXX is it correct? */
6722 if (curproc && curproc->p_cred)
6723 id->sadb_ident_id = curproc->p_cred->p_ruid;
6724 if (userfqdn && userfqdnlen)
6725 bcopy(userfqdn, id + 1, userfqdnlen);
6726 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6730 /* XXX sensitivity (optional) */
6732 /* create proposal/combination extension */
6733 m = key_getprop(saidx);
6736 * spec conformant: always attach proposal/combination extension,
6737 * the problem is that we have no way to attach it for ipcomp,
6738 * due to the way sadb_comb is declared in RFC2367.
6747 * outside of spec; make proposal/combination extension optional.
6753 if ((result->m_flags & M_PKTHDR) == 0) {
6758 if (result->m_len < sizeof(struct sadb_msg)) {
6759 result = m_pullup(result, sizeof(struct sadb_msg));
6760 if (result == NULL) {
6766 result->m_pkthdr.len = 0;
6767 for (m = result; m; m = m->m_next)
6768 result->m_pkthdr.len += m->m_len;
6770 mtod(result, struct sadb_msg *)->sadb_msg_len =
6771 PFKEY_UNIT64(result->m_pkthdr.len);
6774 printf("%s: SP(%p)\n", __func__, sp));
6775 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6777 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6786 key_newacq(const struct secasindex *saidx, int *perror)
6791 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6793 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6799 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6800 acq->created = time_second;
6803 /* add to acqtree */
6805 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6806 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6807 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6808 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6815 key_getacq(const struct secasindex *saidx, int *perror)
6821 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6822 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6823 if (acq->count > V_key_blockacq_count) {
6825 * Reset counter and send message.
6826 * Also reset created time to keep ACQ for
6829 acq->created = time_second;
6834 * Increment counter and do nothing.
6835 * We send SADB_ACQUIRE message only
6836 * for each V_key_blockacq_count packet.
6849 /* allocate new entry */
6850 return (key_newacq(saidx, perror));
6854 key_acqreset(uint32_t seq)
6859 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6860 if (acq->seq == seq) {
6862 acq->created = time_second;
6872 * Mark ACQ entry as stale to remove it in key_flush_acq().
6873 * Called after successful SADB_GETSPI message.
6876 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6881 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6882 if (acq->seq == seq)
6886 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6887 ipseclog((LOG_DEBUG,
6888 "%s: Mismatched saidx for ACQ %u\n", __func__, seq));
6894 ipseclog((LOG_DEBUG,
6895 "%s: ACQ %u is not found.\n", __func__, seq));
6903 static struct secspacq *
6904 key_newspacq(struct secpolicyindex *spidx)
6906 struct secspacq *acq;
6909 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6911 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6916 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6917 acq->created = time_second;
6920 /* add to spacqtree */
6922 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6928 static struct secspacq *
6929 key_getspacq(struct secpolicyindex *spidx)
6931 struct secspacq *acq;
6934 LIST_FOREACH(acq, &V_spacqtree, chain) {
6935 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6936 /* NB: return holding spacq_lock */
6946 * SADB_ACQUIRE processing,
6947 * in first situation, is receiving
6949 * from the ikmpd, and clear sequence of its secasvar entry.
6951 * In second situation, is receiving
6952 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6953 * from a user land process, and return
6954 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6957 * m will always be freed.
6960 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6962 SAHTREE_RLOCK_TRACKER;
6963 struct sadb_address *src0, *dst0;
6964 struct secasindex saidx;
6965 struct secashead *sah;
6968 uint8_t mode, proto;
6970 IPSEC_ASSERT(so != NULL, ("null socket"));
6971 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6972 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6973 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6976 * Error message from KMd.
6977 * We assume that if error was occurred in IKEd, the length of PFKEY
6978 * message is equal to the size of sadb_msg structure.
6979 * We do not raise error even if error occurred in this function.
6981 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
6982 /* check sequence number */
6983 if (mhp->msg->sadb_msg_seq == 0 ||
6984 mhp->msg->sadb_msg_errno == 0) {
6985 ipseclog((LOG_DEBUG, "%s: must specify sequence "
6986 "number and errno.\n", __func__));
6989 * IKEd reported that error occurred.
6990 * XXXAE: what it expects from the kernel?
6991 * Probably we should send SADB_ACQUIRE again?
6992 * If so, reset ACQ's state.
6993 * XXXAE: it looks useless.
6995 key_acqreset(mhp->msg->sadb_msg_seq);
7002 * This message is from user land.
7005 /* map satype to proto */
7006 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7007 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7009 return key_senderror(so, m, EINVAL);
7012 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
7013 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
7014 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
7015 ipseclog((LOG_DEBUG,
7016 "%s: invalid message: missing required header.\n",
7018 return key_senderror(so, m, EINVAL);
7020 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
7021 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
7022 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
7023 ipseclog((LOG_DEBUG,
7024 "%s: invalid message: wrong header size.\n", __func__));
7025 return key_senderror(so, m, EINVAL);
7028 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
7029 mode = IPSEC_MODE_ANY;
7032 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
7033 ipseclog((LOG_DEBUG,
7034 "%s: invalid message: wrong header size.\n",
7036 return key_senderror(so, m, EINVAL);
7038 mode = ((struct sadb_x_sa2 *)
7039 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7040 reqid = ((struct sadb_x_sa2 *)
7041 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7044 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7045 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7047 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
7048 (struct sockaddr *)(dst0 + 1));
7050 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
7051 return key_senderror(so, m, EINVAL);
7053 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
7055 /* get a SA index */
7057 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
7058 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
7063 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
7064 return key_senderror(so, m, EEXIST);
7067 error = key_acquire(&saidx, NULL);
7069 ipseclog((LOG_DEBUG,
7070 "%s: error %d returned from key_acquire()\n",
7072 return key_senderror(so, m, error);
7079 * SADB_REGISTER processing.
7080 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
7083 * from the ikmpd, and register a socket to send PF_KEY messages,
7087 * If socket is detached, must free from regnode.
7089 * m will always be freed.
7092 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7094 struct secreg *reg, *newreg = NULL;
7096 IPSEC_ASSERT(so != NULL, ("null socket"));
7097 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7098 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7099 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7101 /* check for invalid register message */
7102 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
7103 return key_senderror(so, m, EINVAL);
7105 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
7106 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
7109 /* check whether existing or not */
7111 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
7112 if (reg->so == so) {
7114 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
7116 return key_senderror(so, m, EEXIST);
7120 /* create regnode */
7121 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
7122 if (newreg == NULL) {
7124 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7125 return key_senderror(so, m, ENOBUFS);
7129 ((struct keycb *)sotorawcb(so))->kp_registered++;
7131 /* add regnode to regtree. */
7132 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7138 struct sadb_msg *newmsg;
7139 struct sadb_supported *sup;
7140 u_int len, alen, elen;
7143 struct sadb_alg *alg;
7145 /* create new sadb_msg to reply. */
7147 for (i = 1; i <= SADB_AALG_MAX; i++) {
7148 if (auth_algorithm_lookup(i))
7149 alen += sizeof(struct sadb_alg);
7152 alen += sizeof(struct sadb_supported);
7154 for (i = 1; i <= SADB_EALG_MAX; i++) {
7155 if (enc_algorithm_lookup(i))
7156 elen += sizeof(struct sadb_alg);
7159 elen += sizeof(struct sadb_supported);
7161 len = sizeof(struct sadb_msg) + alen + elen;
7164 return key_senderror(so, m, ENOBUFS);
7166 MGETHDR(n, M_NOWAIT, MT_DATA);
7167 if (n != NULL && len > MHLEN) {
7168 if (!(MCLGET(n, M_NOWAIT))) {
7174 return key_senderror(so, m, ENOBUFS);
7176 n->m_pkthdr.len = n->m_len = len;
7180 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7181 newmsg = mtod(n, struct sadb_msg *);
7182 newmsg->sadb_msg_errno = 0;
7183 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7184 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7186 /* for authentication algorithm */
7188 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7189 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7190 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7191 off += PFKEY_ALIGN8(sizeof(*sup));
7193 for (i = 1; i <= SADB_AALG_MAX; i++) {
7194 const struct auth_hash *aalgo;
7195 u_int16_t minkeysize, maxkeysize;
7197 aalgo = auth_algorithm_lookup(i);
7200 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7201 alg->sadb_alg_id = i;
7202 alg->sadb_alg_ivlen = 0;
7203 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7204 alg->sadb_alg_minbits = _BITS(minkeysize);
7205 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7206 off += PFKEY_ALIGN8(sizeof(*alg));
7210 /* for encryption algorithm */
7212 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7213 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7214 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7215 off += PFKEY_ALIGN8(sizeof(*sup));
7217 for (i = 1; i <= SADB_EALG_MAX; i++) {
7218 const struct enc_xform *ealgo;
7220 ealgo = enc_algorithm_lookup(i);
7223 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7224 alg->sadb_alg_id = i;
7225 alg->sadb_alg_ivlen = ealgo->ivsize;
7226 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7227 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7228 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7232 IPSEC_ASSERT(off == len,
7233 ("length assumption failed (off %u len %u)", off, len));
7236 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7241 * free secreg entry registered.
7242 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7245 key_freereg(struct socket *so)
7250 IPSEC_ASSERT(so != NULL, ("NULL so"));
7253 * check whether existing or not.
7254 * check all type of SA, because there is a potential that
7255 * one socket is registered to multiple type of SA.
7258 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7259 LIST_FOREACH(reg, &V_regtree[i], chain) {
7260 if (reg->so == so && __LIST_CHAINED(reg)) {
7261 LIST_REMOVE(reg, chain);
7262 free(reg, M_IPSEC_SAR);
7271 * SADB_EXPIRE processing
7273 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7275 * NOTE: We send only soft lifetime extension.
7278 * others : error number
7281 key_expire(struct secasvar *sav, int hard)
7283 struct mbuf *result = NULL, *m;
7284 struct sadb_lifetime *lt;
7285 uint32_t replay_count;
7289 IPSEC_ASSERT (sav != NULL, ("null sav"));
7290 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7293 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7294 sav, hard ? "hard": "soft"));
7295 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7296 /* set msg header */
7297 satype = key_proto2satype(sav->sah->saidx.proto);
7298 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7299 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7306 /* create SA extension */
7307 m = key_setsadbsa(sav);
7314 /* create SA extension */
7316 replay_count = sav->replay ? sav->replay->count : 0;
7317 SECASVAR_UNLOCK(sav);
7319 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7320 sav->sah->saidx.reqid);
7327 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7328 m = key_setsadbxsareplay(sav->replay->wsize);
7336 /* create lifetime extension (current and soft) */
7337 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7338 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7345 bzero(mtod(m, caddr_t), len);
7346 lt = mtod(m, struct sadb_lifetime *);
7347 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7348 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7349 lt->sadb_lifetime_allocations =
7350 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7351 lt->sadb_lifetime_bytes =
7352 counter_u64_fetch(sav->lft_c_bytes);
7353 lt->sadb_lifetime_addtime = sav->created;
7354 lt->sadb_lifetime_usetime = sav->firstused;
7355 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7356 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7358 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7359 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7360 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7361 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7362 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7364 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7365 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7366 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7367 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7368 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7372 /* set sadb_address for source */
7373 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7374 &sav->sah->saidx.src.sa,
7375 FULLMASK, IPSEC_ULPROTO_ANY);
7382 /* set sadb_address for destination */
7383 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7384 &sav->sah->saidx.dst.sa,
7385 FULLMASK, IPSEC_ULPROTO_ANY);
7393 * XXX-BZ Handle NAT-T extensions here.
7394 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7395 * this information, we report only significant SA fields.
7398 if ((result->m_flags & M_PKTHDR) == 0) {
7403 if (result->m_len < sizeof(struct sadb_msg)) {
7404 result = m_pullup(result, sizeof(struct sadb_msg));
7405 if (result == NULL) {
7411 result->m_pkthdr.len = 0;
7412 for (m = result; m; m = m->m_next)
7413 result->m_pkthdr.len += m->m_len;
7415 mtod(result, struct sadb_msg *)->sadb_msg_len =
7416 PFKEY_UNIT64(result->m_pkthdr.len);
7418 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7427 key_freesah_flushed(struct secashead_queue *flushq)
7429 struct secashead *sah, *nextsah;
7430 struct secasvar *sav, *nextsav;
7432 sah = TAILQ_FIRST(flushq);
7433 while (sah != NULL) {
7434 sav = TAILQ_FIRST(&sah->savtree_larval);
7435 while (sav != NULL) {
7436 nextsav = TAILQ_NEXT(sav, chain);
7437 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7438 key_freesav(&sav); /* release last reference */
7439 key_freesah(&sah); /* release reference from SAV */
7442 sav = TAILQ_FIRST(&sah->savtree_alive);
7443 while (sav != NULL) {
7444 nextsav = TAILQ_NEXT(sav, chain);
7445 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7446 key_freesav(&sav); /* release last reference */
7447 key_freesah(&sah); /* release reference from SAV */
7450 nextsah = TAILQ_NEXT(sah, chain);
7451 key_freesah(&sah); /* release last reference */
7457 * SADB_FLUSH processing
7460 * from the ikmpd, and free all entries in secastree.
7464 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7466 * m will always be freed.
7469 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7471 struct secashead_queue flushq;
7472 struct sadb_msg *newmsg;
7473 struct secashead *sah, *nextsah;
7474 struct secasvar *sav;
7478 IPSEC_ASSERT(so != NULL, ("null socket"));
7479 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7480 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7482 /* map satype to proto */
7483 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7484 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7486 return key_senderror(so, m, EINVAL);
7489 printf("%s: proto %u\n", __func__, proto));
7491 TAILQ_INIT(&flushq);
7492 if (proto == IPSEC_PROTO_ANY) {
7493 /* no SATYPE specified, i.e. flushing all SA. */
7495 /* Move all SAHs into flushq */
7496 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7497 /* Flush all buckets in SPI hash */
7498 for (i = 0; i < V_savhash_mask + 1; i++)
7499 LIST_INIT(&V_savhashtbl[i]);
7500 /* Flush all buckets in SAHADDRHASH */
7501 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7502 LIST_INIT(&V_sahaddrhashtbl[i]);
7503 /* Mark all SAHs as unlinked */
7504 TAILQ_FOREACH(sah, &flushq, chain) {
7505 sah->state = SADB_SASTATE_DEAD;
7507 * Callout handler makes its job using
7508 * RLOCK and drain queues. In case, when this
7509 * function will be called just before it
7510 * acquires WLOCK, we need to mark SAs as
7511 * unlinked to prevent second unlink.
7513 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7514 sav->state = SADB_SASTATE_DEAD;
7516 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7517 sav->state = SADB_SASTATE_DEAD;
7523 sah = TAILQ_FIRST(&V_sahtree);
7524 while (sah != NULL) {
7525 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7526 ("DEAD SAH %p in SADB_FLUSH", sah));
7527 nextsah = TAILQ_NEXT(sah, chain);
7528 if (sah->saidx.proto != proto) {
7532 sah->state = SADB_SASTATE_DEAD;
7533 TAILQ_REMOVE(&V_sahtree, sah, chain);
7534 LIST_REMOVE(sah, addrhash);
7535 /* Unlink all SAs from SPI hash */
7536 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7537 LIST_REMOVE(sav, spihash);
7538 sav->state = SADB_SASTATE_DEAD;
7540 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7541 LIST_REMOVE(sav, spihash);
7542 sav->state = SADB_SASTATE_DEAD;
7544 /* Add SAH into flushq */
7545 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7551 key_freesah_flushed(&flushq);
7552 /* Free all queued SAs and SAHs */
7553 if (m->m_len < sizeof(struct sadb_msg) ||
7554 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7555 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7556 return key_senderror(so, m, ENOBUFS);
7562 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7563 newmsg = mtod(m, struct sadb_msg *);
7564 newmsg->sadb_msg_errno = 0;
7565 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7567 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7571 * SADB_DUMP processing
7572 * dump all entries including status of DEAD in SAD.
7575 * from the ikmpd, and dump all secasvar leaves
7580 * m will always be freed.
7583 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7585 SAHTREE_RLOCK_TRACKER;
7586 struct secashead *sah;
7587 struct secasvar *sav;
7590 uint8_t proto, satype;
7592 IPSEC_ASSERT(so != NULL, ("null socket"));
7593 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7594 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7595 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7597 /* map satype to proto */
7598 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7599 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7601 return key_senderror(so, m, EINVAL);
7604 /* count sav entries to be sent to the userland. */
7607 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7608 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7609 proto != sah->saidx.proto)
7612 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7614 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7620 return key_senderror(so, m, ENOENT);
7623 /* send this to the userland, one at a time. */
7624 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7625 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7626 proto != sah->saidx.proto)
7629 /* map proto to satype */
7630 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7632 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7633 "SAD.\n", __func__));
7634 return key_senderror(so, m, EINVAL);
7636 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7637 n = key_setdumpsa(sav, SADB_DUMP, satype,
7638 --cnt, mhp->msg->sadb_msg_pid);
7641 return key_senderror(so, m, ENOBUFS);
7643 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7645 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7646 n = key_setdumpsa(sav, SADB_DUMP, satype,
7647 --cnt, mhp->msg->sadb_msg_pid);
7650 return key_senderror(so, m, ENOBUFS);
7652 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7660 * SADB_X_PROMISC processing
7662 * m will always be freed.
7665 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7669 IPSEC_ASSERT(so != NULL, ("null socket"));
7670 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7671 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7672 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7674 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7676 if (olen < sizeof(struct sadb_msg)) {
7678 return key_senderror(so, m, EINVAL);
7683 } else if (olen == sizeof(struct sadb_msg)) {
7684 /* enable/disable promisc mode */
7687 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7688 return key_senderror(so, m, EINVAL);
7689 mhp->msg->sadb_msg_errno = 0;
7690 switch (mhp->msg->sadb_msg_satype) {
7693 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7696 return key_senderror(so, m, EINVAL);
7699 /* send the original message back to everyone */
7700 mhp->msg->sadb_msg_errno = 0;
7701 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7703 /* send packet as is */
7705 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7707 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7708 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7712 static int (*key_typesw[])(struct socket *, struct mbuf *,
7713 const struct sadb_msghdr *) = {
7714 NULL, /* SADB_RESERVED */
7715 key_getspi, /* SADB_GETSPI */
7716 key_update, /* SADB_UPDATE */
7717 key_add, /* SADB_ADD */
7718 key_delete, /* SADB_DELETE */
7719 key_get, /* SADB_GET */
7720 key_acquire2, /* SADB_ACQUIRE */
7721 key_register, /* SADB_REGISTER */
7722 NULL, /* SADB_EXPIRE */
7723 key_flush, /* SADB_FLUSH */
7724 key_dump, /* SADB_DUMP */
7725 key_promisc, /* SADB_X_PROMISC */
7726 NULL, /* SADB_X_PCHANGE */
7727 key_spdadd, /* SADB_X_SPDUPDATE */
7728 key_spdadd, /* SADB_X_SPDADD */
7729 key_spddelete, /* SADB_X_SPDDELETE */
7730 key_spdget, /* SADB_X_SPDGET */
7731 NULL, /* SADB_X_SPDACQUIRE */
7732 key_spddump, /* SADB_X_SPDDUMP */
7733 key_spdflush, /* SADB_X_SPDFLUSH */
7734 key_spdadd, /* SADB_X_SPDSETIDX */
7735 NULL, /* SADB_X_SPDEXPIRE */
7736 key_spddelete2, /* SADB_X_SPDDELETE2 */
7740 * parse sadb_msg buffer to process PFKEYv2,
7741 * and create a data to response if needed.
7742 * I think to be dealed with mbuf directly.
7744 * msgp : pointer to pointer to a received buffer pulluped.
7745 * This is rewrited to response.
7746 * so : pointer to socket.
7748 * length for buffer to send to user process.
7751 key_parse(struct mbuf *m, struct socket *so)
7753 struct sadb_msg *msg;
7754 struct sadb_msghdr mh;
7759 IPSEC_ASSERT(so != NULL, ("null socket"));
7760 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7762 if (m->m_len < sizeof(struct sadb_msg)) {
7763 m = m_pullup(m, sizeof(struct sadb_msg));
7767 msg = mtod(m, struct sadb_msg *);
7768 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7769 target = KEY_SENDUP_ONE;
7771 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7772 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7773 PFKEYSTAT_INC(out_invlen);
7778 if (msg->sadb_msg_version != PF_KEY_V2) {
7779 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7780 __func__, msg->sadb_msg_version));
7781 PFKEYSTAT_INC(out_invver);
7786 if (msg->sadb_msg_type > SADB_MAX) {
7787 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7788 __func__, msg->sadb_msg_type));
7789 PFKEYSTAT_INC(out_invmsgtype);
7794 /* for old-fashioned code - should be nuked */
7795 if (m->m_pkthdr.len > MCLBYTES) {
7802 MGETHDR(n, M_NOWAIT, MT_DATA);
7803 if (n && m->m_pkthdr.len > MHLEN) {
7804 if (!(MCLGET(n, M_NOWAIT))) {
7813 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7814 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7820 /* align the mbuf chain so that extensions are in contiguous region. */
7821 error = key_align(m, &mh);
7827 /* We use satype as scope mask for spddump */
7828 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7829 switch (msg->sadb_msg_satype) {
7830 case IPSEC_POLICYSCOPE_ANY:
7831 case IPSEC_POLICYSCOPE_GLOBAL:
7832 case IPSEC_POLICYSCOPE_IFNET:
7833 case IPSEC_POLICYSCOPE_PCB:
7836 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7837 __func__, msg->sadb_msg_type));
7838 PFKEYSTAT_INC(out_invsatype);
7843 switch (msg->sadb_msg_satype) { /* check SA type */
7844 case SADB_SATYPE_UNSPEC:
7845 switch (msg->sadb_msg_type) {
7853 ipseclog((LOG_DEBUG, "%s: must specify satype "
7854 "when msg type=%u.\n", __func__,
7855 msg->sadb_msg_type));
7856 PFKEYSTAT_INC(out_invsatype);
7861 case SADB_SATYPE_AH:
7862 case SADB_SATYPE_ESP:
7863 case SADB_X_SATYPE_IPCOMP:
7864 case SADB_X_SATYPE_TCPSIGNATURE:
7865 switch (msg->sadb_msg_type) {
7867 case SADB_X_SPDDELETE:
7869 case SADB_X_SPDFLUSH:
7870 case SADB_X_SPDSETIDX:
7871 case SADB_X_SPDUPDATE:
7872 case SADB_X_SPDDELETE2:
7873 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7874 __func__, msg->sadb_msg_type));
7875 PFKEYSTAT_INC(out_invsatype);
7880 case SADB_SATYPE_RSVP:
7881 case SADB_SATYPE_OSPFV2:
7882 case SADB_SATYPE_RIPV2:
7883 case SADB_SATYPE_MIP:
7884 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7885 __func__, msg->sadb_msg_satype));
7886 PFKEYSTAT_INC(out_invsatype);
7889 case 1: /* XXX: What does it do? */
7890 if (msg->sadb_msg_type == SADB_X_PROMISC)
7894 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7895 __func__, msg->sadb_msg_satype));
7896 PFKEYSTAT_INC(out_invsatype);
7902 /* check field of upper layer protocol and address family */
7903 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7904 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7905 struct sadb_address *src0, *dst0;
7908 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7909 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7911 /* check upper layer protocol */
7912 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7913 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7914 "mismatched.\n", __func__));
7915 PFKEYSTAT_INC(out_invaddr);
7921 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7922 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7923 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7925 PFKEYSTAT_INC(out_invaddr);
7929 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7930 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7931 ipseclog((LOG_DEBUG, "%s: address struct size "
7932 "mismatched.\n", __func__));
7933 PFKEYSTAT_INC(out_invaddr);
7938 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7940 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7941 sizeof(struct sockaddr_in)) {
7942 PFKEYSTAT_INC(out_invaddr);
7948 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7949 sizeof(struct sockaddr_in6)) {
7950 PFKEYSTAT_INC(out_invaddr);
7956 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7958 PFKEYSTAT_INC(out_invaddr);
7959 error = EAFNOSUPPORT;
7963 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7965 plen = sizeof(struct in_addr) << 3;
7968 plen = sizeof(struct in6_addr) << 3;
7971 plen = 0; /*fool gcc*/
7975 /* check max prefix length */
7976 if (src0->sadb_address_prefixlen > plen ||
7977 dst0->sadb_address_prefixlen > plen) {
7978 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7980 PFKEYSTAT_INC(out_invaddr);
7986 * prefixlen == 0 is valid because there can be a case when
7987 * all addresses are matched.
7991 if (msg->sadb_msg_type >= nitems(key_typesw) ||
7992 key_typesw[msg->sadb_msg_type] == NULL) {
7993 PFKEYSTAT_INC(out_invmsgtype);
7998 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
8001 msg->sadb_msg_errno = error;
8002 return key_sendup_mbuf(so, m, target);
8006 key_senderror(struct socket *so, struct mbuf *m, int code)
8008 struct sadb_msg *msg;
8010 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8011 ("mbuf too small, len %u", m->m_len));
8013 msg = mtod(m, struct sadb_msg *);
8014 msg->sadb_msg_errno = code;
8015 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
8019 * set the pointer to each header into message buffer.
8020 * m will be freed on error.
8021 * XXX larger-than-MCLBYTES extension?
8024 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
8027 struct sadb_ext *ext;
8032 IPSEC_ASSERT(m != NULL, ("null mbuf"));
8033 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
8034 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8035 ("mbuf too small, len %u", m->m_len));
8038 bzero(mhp, sizeof(*mhp));
8040 mhp->msg = mtod(m, struct sadb_msg *);
8041 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
8043 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
8044 extlen = end; /*just in case extlen is not updated*/
8045 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
8046 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
8048 /* m is already freed */
8051 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8054 switch (ext->sadb_ext_type) {
8056 case SADB_EXT_ADDRESS_SRC:
8057 case SADB_EXT_ADDRESS_DST:
8058 case SADB_EXT_ADDRESS_PROXY:
8059 case SADB_EXT_LIFETIME_CURRENT:
8060 case SADB_EXT_LIFETIME_HARD:
8061 case SADB_EXT_LIFETIME_SOFT:
8062 case SADB_EXT_KEY_AUTH:
8063 case SADB_EXT_KEY_ENCRYPT:
8064 case SADB_EXT_IDENTITY_SRC:
8065 case SADB_EXT_IDENTITY_DST:
8066 case SADB_EXT_SENSITIVITY:
8067 case SADB_EXT_PROPOSAL:
8068 case SADB_EXT_SUPPORTED_AUTH:
8069 case SADB_EXT_SUPPORTED_ENCRYPT:
8070 case SADB_EXT_SPIRANGE:
8071 case SADB_X_EXT_POLICY:
8072 case SADB_X_EXT_SA2:
8073 case SADB_X_EXT_NAT_T_TYPE:
8074 case SADB_X_EXT_NAT_T_SPORT:
8075 case SADB_X_EXT_NAT_T_DPORT:
8076 case SADB_X_EXT_NAT_T_OAI:
8077 case SADB_X_EXT_NAT_T_OAR:
8078 case SADB_X_EXT_NAT_T_FRAG:
8079 case SADB_X_EXT_SA_REPLAY:
8080 case SADB_X_EXT_NEW_ADDRESS_SRC:
8081 case SADB_X_EXT_NEW_ADDRESS_DST:
8082 /* duplicate check */
8084 * XXX Are there duplication payloads of either
8085 * KEY_AUTH or KEY_ENCRYPT ?
8087 if (mhp->ext[ext->sadb_ext_type] != NULL) {
8088 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
8089 "%u\n", __func__, ext->sadb_ext_type));
8091 PFKEYSTAT_INC(out_dupext);
8096 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
8097 __func__, ext->sadb_ext_type));
8099 PFKEYSTAT_INC(out_invexttype);
8103 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
8105 if (key_validate_ext(ext, extlen)) {
8107 PFKEYSTAT_INC(out_invlen);
8111 n = m_pulldown(m, off, extlen, &toff);
8113 /* m is already freed */
8116 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8118 mhp->ext[ext->sadb_ext_type] = ext;
8119 mhp->extoff[ext->sadb_ext_type] = off;
8120 mhp->extlen[ext->sadb_ext_type] = extlen;
8125 PFKEYSTAT_INC(out_invlen);
8133 key_validate_ext(const struct sadb_ext *ext, int len)
8135 const struct sockaddr *sa;
8136 enum { NONE, ADDR } checktype = NONE;
8138 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8140 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8143 /* if it does not match minimum/maximum length, bail */
8144 if (ext->sadb_ext_type >= nitems(minsize) ||
8145 ext->sadb_ext_type >= nitems(maxsize))
8147 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8149 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8152 /* more checks based on sadb_ext_type XXX need more */
8153 switch (ext->sadb_ext_type) {
8154 case SADB_EXT_ADDRESS_SRC:
8155 case SADB_EXT_ADDRESS_DST:
8156 case SADB_EXT_ADDRESS_PROXY:
8157 case SADB_X_EXT_NAT_T_OAI:
8158 case SADB_X_EXT_NAT_T_OAR:
8159 case SADB_X_EXT_NEW_ADDRESS_SRC:
8160 case SADB_X_EXT_NEW_ADDRESS_DST:
8161 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8164 case SADB_EXT_IDENTITY_SRC:
8165 case SADB_EXT_IDENTITY_DST:
8166 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8167 SADB_X_IDENTTYPE_ADDR) {
8168 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8178 switch (checktype) {
8182 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8183 if (len < baselen + sal)
8185 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8198 TUNABLE_INT_FETCH("net.key.spdcache.maxentries",
8199 &V_key_spdcache_maxentries);
8200 TUNABLE_INT_FETCH("net.key.spdcache.threshold",
8201 &V_key_spdcache_threshold);
8203 if (V_key_spdcache_maxentries) {
8204 V_key_spdcache_maxentries = MAX(V_key_spdcache_maxentries,
8205 SPDCACHE_MAX_ENTRIES_PER_HASH);
8206 V_spdcachehashtbl = hashinit(V_key_spdcache_maxentries /
8207 SPDCACHE_MAX_ENTRIES_PER_HASH,
8208 M_IPSEC_SPDCACHE, &V_spdcachehash_mask);
8209 V_key_spdcache_maxentries = (V_spdcachehash_mask + 1)
8210 * SPDCACHE_MAX_ENTRIES_PER_HASH;
8212 V_spdcache_lock = malloc(sizeof(struct mtx) *
8213 (V_spdcachehash_mask + 1),
8214 M_IPSEC_SPDCACHE, M_WAITOK|M_ZERO);
8216 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8217 SPDCACHE_LOCK_INIT(i);
8221 struct spdcache_entry *
8222 spdcache_entry_alloc(const struct secpolicyindex *spidx, struct secpolicy *sp)
8224 struct spdcache_entry *entry;
8226 entry = malloc(sizeof(struct spdcache_entry),
8227 M_IPSEC_SPDCACHE, M_NOWAIT|M_ZERO);
8234 entry->spidx = *spidx;
8241 spdcache_entry_free(struct spdcache_entry *entry)
8244 if (entry->sp != NULL)
8245 key_freesp(&entry->sp);
8246 free(entry, M_IPSEC_SPDCACHE);
8250 spdcache_clear(void)
8252 struct spdcache_entry *entry;
8255 for (i = 0; i < V_spdcachehash_mask + 1; ++i) {
8257 while (!LIST_EMPTY(&V_spdcachehashtbl[i])) {
8258 entry = LIST_FIRST(&V_spdcachehashtbl[i]);
8259 LIST_REMOVE(entry, chain);
8260 spdcache_entry_free(entry);
8268 spdcache_destroy(void)
8272 if (SPDCACHE_ENABLED()) {
8274 hashdestroy(V_spdcachehashtbl, M_IPSEC_SPDCACHE, V_spdcachehash_mask);
8276 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8277 SPDCACHE_LOCK_DESTROY(i);
8279 free(V_spdcache_lock, M_IPSEC_SPDCACHE);
8288 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8289 TAILQ_INIT(&V_sptree[i]);
8290 TAILQ_INIT(&V_sptree_ifnet[i]);
8293 V_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8294 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8295 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8297 TAILQ_INIT(&V_sahtree);
8298 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8299 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8300 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8301 &V_sahaddrhash_mask);
8302 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8303 &V_acqaddrhash_mask);
8304 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8305 &V_acqseqhash_mask);
8309 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8310 LIST_INIT(&V_regtree[i]);
8312 LIST_INIT(&V_acqtree);
8313 LIST_INIT(&V_spacqtree);
8315 if (!IS_DEFAULT_VNET(curvnet))
8319 REGTREE_LOCK_INIT();
8320 SAHTREE_LOCK_INIT();
8324 #ifndef IPSEC_DEBUG2
8325 callout_init(&key_timer, 1);
8326 callout_reset(&key_timer, hz, key_timehandler, NULL);
8327 #endif /*IPSEC_DEBUG2*/
8329 /* initialize key statistics */
8330 keystat.getspi_count = 1;
8333 printf("IPsec: Initialized Security Association Processing.\n");
8340 struct secashead_queue sahdrainq;
8341 struct secpolicy_queue drainq;
8342 struct secpolicy *sp, *nextsp;
8343 struct secacq *acq, *nextacq;
8344 struct secspacq *spacq, *nextspacq;
8345 struct secashead *sah;
8346 struct secasvar *sav;
8351 * XXX: can we just call free() for each object without
8352 * walking through safe way with releasing references?
8354 TAILQ_INIT(&drainq);
8356 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8357 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8358 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8360 for (i = 0; i < V_sphash_mask + 1; i++)
8361 LIST_INIT(&V_sphashtbl[i]);
8365 sp = TAILQ_FIRST(&drainq);
8366 while (sp != NULL) {
8367 nextsp = TAILQ_NEXT(sp, chain);
8372 TAILQ_INIT(&sahdrainq);
8374 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8375 for (i = 0; i < V_savhash_mask + 1; i++)
8376 LIST_INIT(&V_savhashtbl[i]);
8377 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8378 LIST_INIT(&V_sahaddrhashtbl[i]);
8379 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8380 sah->state = SADB_SASTATE_DEAD;
8381 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8382 sav->state = SADB_SASTATE_DEAD;
8384 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8385 sav->state = SADB_SASTATE_DEAD;
8390 key_freesah_flushed(&sahdrainq);
8391 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8392 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8393 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8396 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8397 LIST_FOREACH(reg, &V_regtree[i], chain) {
8398 if (__LIST_CHAINED(reg)) {
8399 LIST_REMOVE(reg, chain);
8400 free(reg, M_IPSEC_SAR);
8408 acq = LIST_FIRST(&V_acqtree);
8409 while (acq != NULL) {
8410 nextacq = LIST_NEXT(acq, chain);
8411 LIST_REMOVE(acq, chain);
8412 free(acq, M_IPSEC_SAQ);
8415 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8416 LIST_INIT(&V_acqaddrhashtbl[i]);
8417 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8418 LIST_INIT(&V_acqseqhashtbl[i]);
8422 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8423 spacq = nextspacq) {
8424 nextspacq = LIST_NEXT(spacq, chain);
8425 if (__LIST_CHAINED(spacq)) {
8426 LIST_REMOVE(spacq, chain);
8427 free(spacq, M_IPSEC_SAQ);
8431 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8432 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8433 uma_zdestroy(V_key_lft_zone);
8435 if (!IS_DEFAULT_VNET(curvnet))
8437 #ifndef IPSEC_DEBUG2
8438 callout_drain(&key_timer);
8440 SPTREE_LOCK_DESTROY();
8441 REGTREE_LOCK_DESTROY();
8442 SAHTREE_LOCK_DESTROY();
8444 SPACQ_LOCK_DESTROY();
8448 /* record data transfer on SA, and update timestamps */
8450 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8452 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8453 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8456 * XXX Currently, there is a difference of bytes size
8457 * between inbound and outbound processing.
8459 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8462 * We use the number of packets as the unit of
8463 * allocations. We increment the variable
8464 * whenever {esp,ah}_{in,out}put is called.
8466 counter_u64_add(sav->lft_c_allocations, 1);
8469 * NOTE: We record CURRENT usetime by using wall clock,
8470 * in seconds. HARD and SOFT lifetime are measured by the time
8471 * difference (again in seconds) from usetime.
8475 * -----+-----+--------+---> t
8476 * <--------------> HARD
8479 if (sav->firstused == 0)
8480 sav->firstused = time_second;
8484 * Take one of the kernel's security keys and convert it into a PF_KEY
8485 * structure within an mbuf, suitable for sending up to a waiting
8486 * application in user land.
8489 * src: A pointer to a kernel security key.
8490 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8492 * a valid mbuf or NULL indicating an error
8496 static struct mbuf *
8497 key_setkey(struct seckey *src, uint16_t exttype)
8506 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8507 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8512 p = mtod(m, struct sadb_key *);
8514 p->sadb_key_len = PFKEY_UNIT64(len);
8515 p->sadb_key_exttype = exttype;
8516 p->sadb_key_bits = src->bits;
8517 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8523 * Take one of the kernel's lifetime data structures and convert it
8524 * into a PF_KEY structure within an mbuf, suitable for sending up to
8525 * a waiting application in user land.
8528 * src: A pointer to a kernel lifetime structure.
8529 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8530 * data structures for more information.
8532 * a valid mbuf or NULL indicating an error
8536 static struct mbuf *
8537 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8539 struct mbuf *m = NULL;
8540 struct sadb_lifetime *p;
8541 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8546 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8551 p = mtod(m, struct sadb_lifetime *);
8554 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8555 p->sadb_lifetime_exttype = exttype;
8556 p->sadb_lifetime_allocations = src->allocations;
8557 p->sadb_lifetime_bytes = src->bytes;
8558 p->sadb_lifetime_addtime = src->addtime;
8559 p->sadb_lifetime_usetime = src->usetime;
8565 const struct enc_xform *
8566 enc_algorithm_lookup(int alg)
8570 for (i = 0; i < nitems(supported_ealgs); i++)
8571 if (alg == supported_ealgs[i].sadb_alg)
8572 return (supported_ealgs[i].xform);
8576 const struct auth_hash *
8577 auth_algorithm_lookup(int alg)
8581 for (i = 0; i < nitems(supported_aalgs); i++)
8582 if (alg == supported_aalgs[i].sadb_alg)
8583 return (supported_aalgs[i].xform);
8587 const struct comp_algo *
8588 comp_algorithm_lookup(int alg)
8592 for (i = 0; i < nitems(supported_calgs); i++)
8593 if (alg == supported_calgs[i].sadb_alg)
8594 return (supported_calgs[i].xform);