2 /* $KAME: key.c,v 1.191 2001/06/27 10:46:49 sakane Exp $ */
5 * SPDX-License-Identifier: BSD-3-Clause
7 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the project nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * This code is referd to RFC 2367
40 #include "opt_inet6.h"
41 #include "opt_ipsec.h"
43 #include <sys/types.h>
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/fnv_hash.h>
49 #include <sys/mutex.h>
51 #include <sys/domain.h>
52 #include <sys/protosw.h>
53 #include <sys/malloc.h>
54 #include <sys/rmlock.h>
55 #include <sys/socket.h>
56 #include <sys/socketvar.h>
57 #include <sys/sysctl.h>
58 #include <sys/errno.h>
60 #include <sys/queue.h>
61 #include <sys/refcount.h>
62 #include <sys/syslog.h>
67 #include <net/if_var.h>
69 #include <net/raw_cb.h>
71 #include <netinet/in.h>
72 #include <netinet/in_systm.h>
73 #include <netinet/ip.h>
74 #include <netinet/in_var.h>
75 #include <netinet/udp.h>
78 #include <netinet/ip6.h>
79 #include <netinet6/in6_var.h>
80 #include <netinet6/ip6_var.h>
83 #include <net/pfkeyv2.h>
84 #include <netipsec/keydb.h>
85 #include <netipsec/key.h>
86 #include <netipsec/keysock.h>
87 #include <netipsec/key_debug.h>
89 #include <netipsec/ipsec.h>
91 #include <netipsec/ipsec6.h>
94 #include <netipsec/xform.h>
95 #include <machine/in_cksum.h>
96 #include <machine/stdarg.h>
99 #include <sys/random.h>
101 #define FULLMASK 0xff
102 #define _BITS(bytes) ((bytes) << 3)
105 * Note on SA reference counting:
106 * - SAs that are not in DEAD state will have (total external reference + 1)
107 * following value in reference count field. they cannot be freed and are
108 * referenced from SA header.
109 * - SAs that are in DEAD state will have (total external reference)
110 * in reference count field. they are ready to be freed. reference from
111 * SA header will be removed in key_delsav(), when the reference count
112 * field hits 0 (= no external reference other than from SA header.
115 VNET_DEFINE(u_int32_t, key_debug_level) = 0;
116 VNET_DEFINE_STATIC(u_int, key_spi_trycnt) = 1000;
117 VNET_DEFINE_STATIC(u_int32_t, key_spi_minval) = 0x100;
118 VNET_DEFINE_STATIC(u_int32_t, key_spi_maxval) = 0x0fffffff; /* XXX */
119 VNET_DEFINE_STATIC(u_int32_t, policy_id) = 0;
120 /*interval to initialize randseed,1(m)*/
121 VNET_DEFINE_STATIC(u_int, key_int_random) = 60;
122 /* interval to expire acquiring, 30(s)*/
123 VNET_DEFINE_STATIC(u_int, key_larval_lifetime) = 30;
124 /* counter for blocking SADB_ACQUIRE.*/
125 VNET_DEFINE_STATIC(int, key_blockacq_count) = 10;
126 /* lifetime for blocking SADB_ACQUIRE.*/
127 VNET_DEFINE_STATIC(int, key_blockacq_lifetime) = 20;
128 /* preferred old sa rather than new sa.*/
129 VNET_DEFINE_STATIC(int, key_preferred_oldsa) = 1;
130 #define V_key_spi_trycnt VNET(key_spi_trycnt)
131 #define V_key_spi_minval VNET(key_spi_minval)
132 #define V_key_spi_maxval VNET(key_spi_maxval)
133 #define V_policy_id VNET(policy_id)
134 #define V_key_int_random VNET(key_int_random)
135 #define V_key_larval_lifetime VNET(key_larval_lifetime)
136 #define V_key_blockacq_count VNET(key_blockacq_count)
137 #define V_key_blockacq_lifetime VNET(key_blockacq_lifetime)
138 #define V_key_preferred_oldsa VNET(key_preferred_oldsa)
140 VNET_DEFINE_STATIC(u_int32_t, acq_seq) = 0;
141 #define V_acq_seq VNET(acq_seq)
143 VNET_DEFINE_STATIC(uint32_t, sp_genid) = 0;
144 #define V_sp_genid VNET(sp_genid)
147 TAILQ_HEAD(secpolicy_queue, secpolicy);
148 LIST_HEAD(secpolicy_list, secpolicy);
149 VNET_DEFINE_STATIC(struct secpolicy_queue, sptree[IPSEC_DIR_MAX]);
150 VNET_DEFINE_STATIC(struct secpolicy_queue, sptree_ifnet[IPSEC_DIR_MAX]);
151 static struct rmlock sptree_lock;
152 #define V_sptree VNET(sptree)
153 #define V_sptree_ifnet VNET(sptree_ifnet)
154 #define SPTREE_LOCK_INIT() rm_init(&sptree_lock, "sptree")
155 #define SPTREE_LOCK_DESTROY() rm_destroy(&sptree_lock)
156 #define SPTREE_RLOCK_TRACKER struct rm_priotracker sptree_tracker
157 #define SPTREE_RLOCK() rm_rlock(&sptree_lock, &sptree_tracker)
158 #define SPTREE_RUNLOCK() rm_runlock(&sptree_lock, &sptree_tracker)
159 #define SPTREE_RLOCK_ASSERT() rm_assert(&sptree_lock, RA_RLOCKED)
160 #define SPTREE_WLOCK() rm_wlock(&sptree_lock)
161 #define SPTREE_WUNLOCK() rm_wunlock(&sptree_lock)
162 #define SPTREE_WLOCK_ASSERT() rm_assert(&sptree_lock, RA_WLOCKED)
163 #define SPTREE_UNLOCK_ASSERT() rm_assert(&sptree_lock, RA_UNLOCKED)
165 /* Hash table for lookup SP using unique id */
166 VNET_DEFINE_STATIC(struct secpolicy_list *, sphashtbl);
167 VNET_DEFINE_STATIC(u_long, sphash_mask);
168 #define V_sphashtbl VNET(sphashtbl)
169 #define V_sphash_mask VNET(sphash_mask)
171 #define SPHASH_NHASH_LOG2 7
172 #define SPHASH_NHASH (1 << SPHASH_NHASH_LOG2)
173 #define SPHASH_HASHVAL(id) (key_u32hash(id) & V_sphash_mask)
174 #define SPHASH_HASH(id) &V_sphashtbl[SPHASH_HASHVAL(id)]
177 struct spdcache_entry {
178 struct secpolicyindex spidx; /* secpolicyindex */
179 struct secpolicy *sp; /* cached policy to be used */
181 LIST_ENTRY(spdcache_entry) chain;
183 LIST_HEAD(spdcache_entry_list, spdcache_entry);
185 #define SPDCACHE_MAX_ENTRIES_PER_HASH 8
187 VNET_DEFINE_STATIC(u_int, key_spdcache_maxentries) = 0;
188 #define V_key_spdcache_maxentries VNET(key_spdcache_maxentries)
189 VNET_DEFINE_STATIC(u_int, key_spdcache_threshold) = 32;
190 #define V_key_spdcache_threshold VNET(key_spdcache_threshold)
191 VNET_DEFINE_STATIC(unsigned long, spd_size) = 0;
192 #define V_spd_size VNET(spd_size)
194 #define SPDCACHE_ENABLED() (V_key_spdcache_maxentries != 0)
195 #define SPDCACHE_ACTIVE() \
196 (SPDCACHE_ENABLED() && V_spd_size >= V_key_spdcache_threshold)
198 VNET_DEFINE_STATIC(struct spdcache_entry_list *, spdcachehashtbl);
199 VNET_DEFINE_STATIC(u_long, spdcachehash_mask);
200 #define V_spdcachehashtbl VNET(spdcachehashtbl)
201 #define V_spdcachehash_mask VNET(spdcachehash_mask)
203 #define SPDCACHE_HASHVAL(idx) \
204 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->ul_proto) & \
207 /* Each cache line is protected by a mutex */
208 VNET_DEFINE_STATIC(struct mtx *, spdcache_lock);
209 #define V_spdcache_lock VNET(spdcache_lock)
211 #define SPDCACHE_LOCK_INIT(a) \
212 mtx_init(&V_spdcache_lock[a], "spdcache", \
213 "fast ipsec SPD cache", MTX_DEF|MTX_DUPOK)
214 #define SPDCACHE_LOCK_DESTROY(a) mtx_destroy(&V_spdcache_lock[a])
215 #define SPDCACHE_LOCK(a) mtx_lock(&V_spdcache_lock[a]);
216 #define SPDCACHE_UNLOCK(a) mtx_unlock(&V_spdcache_lock[a]);
219 TAILQ_HEAD(secashead_queue, secashead);
220 LIST_HEAD(secashead_list, secashead);
221 VNET_DEFINE_STATIC(struct secashead_queue, sahtree);
222 static struct rmlock sahtree_lock;
223 #define V_sahtree VNET(sahtree)
224 #define SAHTREE_LOCK_INIT() rm_init(&sahtree_lock, "sahtree")
225 #define SAHTREE_LOCK_DESTROY() rm_destroy(&sahtree_lock)
226 #define SAHTREE_RLOCK_TRACKER struct rm_priotracker sahtree_tracker
227 #define SAHTREE_RLOCK() rm_rlock(&sahtree_lock, &sahtree_tracker)
228 #define SAHTREE_RUNLOCK() rm_runlock(&sahtree_lock, &sahtree_tracker)
229 #define SAHTREE_RLOCK_ASSERT() rm_assert(&sahtree_lock, RA_RLOCKED)
230 #define SAHTREE_WLOCK() rm_wlock(&sahtree_lock)
231 #define SAHTREE_WUNLOCK() rm_wunlock(&sahtree_lock)
232 #define SAHTREE_WLOCK_ASSERT() rm_assert(&sahtree_lock, RA_WLOCKED)
233 #define SAHTREE_UNLOCK_ASSERT() rm_assert(&sahtree_lock, RA_UNLOCKED)
235 /* Hash table for lookup in SAD using SA addresses */
236 VNET_DEFINE_STATIC(struct secashead_list *, sahaddrhashtbl);
237 VNET_DEFINE_STATIC(u_long, sahaddrhash_mask);
238 #define V_sahaddrhashtbl VNET(sahaddrhashtbl)
239 #define V_sahaddrhash_mask VNET(sahaddrhash_mask)
241 #define SAHHASH_NHASH_LOG2 7
242 #define SAHHASH_NHASH (1 << SAHHASH_NHASH_LOG2)
243 #define SAHADDRHASH_HASHVAL(idx) \
244 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->proto) & \
246 #define SAHADDRHASH_HASH(saidx) \
247 &V_sahaddrhashtbl[SAHADDRHASH_HASHVAL(saidx)]
249 /* Hash table for lookup in SAD using SPI */
250 LIST_HEAD(secasvar_list, secasvar);
251 VNET_DEFINE_STATIC(struct secasvar_list *, savhashtbl);
252 VNET_DEFINE_STATIC(u_long, savhash_mask);
253 #define V_savhashtbl VNET(savhashtbl)
254 #define V_savhash_mask VNET(savhash_mask)
255 #define SAVHASH_NHASH_LOG2 7
256 #define SAVHASH_NHASH (1 << SAVHASH_NHASH_LOG2)
257 #define SAVHASH_HASHVAL(spi) (key_u32hash(spi) & V_savhash_mask)
258 #define SAVHASH_HASH(spi) &V_savhashtbl[SAVHASH_HASHVAL(spi)]
261 key_addrprotohash(const union sockaddr_union *src,
262 const union sockaddr_union *dst, const uint8_t *proto)
266 hval = fnv_32_buf(proto, sizeof(*proto),
268 switch (dst->sa.sa_family) {
271 hval = fnv_32_buf(&src->sin.sin_addr,
272 sizeof(in_addr_t), hval);
273 hval = fnv_32_buf(&dst->sin.sin_addr,
274 sizeof(in_addr_t), hval);
279 hval = fnv_32_buf(&src->sin6.sin6_addr,
280 sizeof(struct in6_addr), hval);
281 hval = fnv_32_buf(&dst->sin6.sin6_addr,
282 sizeof(struct in6_addr), hval);
287 ipseclog((LOG_DEBUG, "%s: unknown address family %d\n",
288 __func__, dst->sa.sa_family));
294 key_u32hash(uint32_t val)
297 return (fnv_32_buf(&val, sizeof(val), FNV1_32_INIT));
301 VNET_DEFINE_STATIC(LIST_HEAD(_regtree, secreg), regtree[SADB_SATYPE_MAX + 1]);
302 #define V_regtree VNET(regtree)
303 static struct mtx regtree_lock;
304 #define REGTREE_LOCK_INIT() \
305 mtx_init(®tree_lock, "regtree", "fast ipsec regtree", MTX_DEF)
306 #define REGTREE_LOCK_DESTROY() mtx_destroy(®tree_lock)
307 #define REGTREE_LOCK() mtx_lock(®tree_lock)
308 #define REGTREE_UNLOCK() mtx_unlock(®tree_lock)
309 #define REGTREE_LOCK_ASSERT() mtx_assert(®tree_lock, MA_OWNED)
312 LIST_HEAD(secacq_list, secacq);
313 VNET_DEFINE_STATIC(struct secacq_list, acqtree);
314 #define V_acqtree VNET(acqtree)
315 static struct mtx acq_lock;
316 #define ACQ_LOCK_INIT() \
317 mtx_init(&acq_lock, "acqtree", "ipsec SA acquiring list", MTX_DEF)
318 #define ACQ_LOCK_DESTROY() mtx_destroy(&acq_lock)
319 #define ACQ_LOCK() mtx_lock(&acq_lock)
320 #define ACQ_UNLOCK() mtx_unlock(&acq_lock)
321 #define ACQ_LOCK_ASSERT() mtx_assert(&acq_lock, MA_OWNED)
323 /* Hash table for lookup in ACQ list using SA addresses */
324 VNET_DEFINE_STATIC(struct secacq_list *, acqaddrhashtbl);
325 VNET_DEFINE_STATIC(u_long, acqaddrhash_mask);
326 #define V_acqaddrhashtbl VNET(acqaddrhashtbl)
327 #define V_acqaddrhash_mask VNET(acqaddrhash_mask)
329 /* Hash table for lookup in ACQ list using SEQ number */
330 VNET_DEFINE_STATIC(struct secacq_list *, acqseqhashtbl);
331 VNET_DEFINE_STATIC(u_long, acqseqhash_mask);
332 #define V_acqseqhashtbl VNET(acqseqhashtbl)
333 #define V_acqseqhash_mask VNET(acqseqhash_mask)
335 #define ACQHASH_NHASH_LOG2 7
336 #define ACQHASH_NHASH (1 << ACQHASH_NHASH_LOG2)
337 #define ACQADDRHASH_HASHVAL(idx) \
338 (key_addrprotohash(&(idx)->src, &(idx)->dst, &(idx)->proto) & \
340 #define ACQSEQHASH_HASHVAL(seq) \
341 (key_u32hash(seq) & V_acqseqhash_mask)
342 #define ACQADDRHASH_HASH(saidx) \
343 &V_acqaddrhashtbl[ACQADDRHASH_HASHVAL(saidx)]
344 #define ACQSEQHASH_HASH(seq) \
345 &V_acqseqhashtbl[ACQSEQHASH_HASHVAL(seq)]
346 /* SP acquiring list */
347 VNET_DEFINE_STATIC(LIST_HEAD(_spacqtree, secspacq), spacqtree);
348 #define V_spacqtree VNET(spacqtree)
349 static struct mtx spacq_lock;
350 #define SPACQ_LOCK_INIT() \
351 mtx_init(&spacq_lock, "spacqtree", \
352 "fast ipsec security policy acquire list", MTX_DEF)
353 #define SPACQ_LOCK_DESTROY() mtx_destroy(&spacq_lock)
354 #define SPACQ_LOCK() mtx_lock(&spacq_lock)
355 #define SPACQ_UNLOCK() mtx_unlock(&spacq_lock)
356 #define SPACQ_LOCK_ASSERT() mtx_assert(&spacq_lock, MA_OWNED)
358 static const int minsize[] = {
359 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
360 sizeof(struct sadb_sa), /* SADB_EXT_SA */
361 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
362 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
363 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
364 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_SRC */
365 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_DST */
366 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_PROXY */
367 sizeof(struct sadb_key), /* SADB_EXT_KEY_AUTH */
368 sizeof(struct sadb_key), /* SADB_EXT_KEY_ENCRYPT */
369 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_SRC */
370 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_DST */
371 sizeof(struct sadb_sens), /* SADB_EXT_SENSITIVITY */
372 sizeof(struct sadb_prop), /* SADB_EXT_PROPOSAL */
373 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_AUTH */
374 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_ENCRYPT */
375 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
376 0, /* SADB_X_EXT_KMPRIVATE */
377 sizeof(struct sadb_x_policy), /* SADB_X_EXT_POLICY */
378 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
379 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
380 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
381 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
382 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAI */
383 sizeof(struct sadb_address), /* SADB_X_EXT_NAT_T_OAR */
384 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
385 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
386 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_SRC */
387 sizeof(struct sadb_address), /* SADB_X_EXT_NEW_ADDRESS_DST */
389 _Static_assert(sizeof(minsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
391 static const int maxsize[] = {
392 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
393 sizeof(struct sadb_sa), /* SADB_EXT_SA */
394 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
395 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
396 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
397 0, /* SADB_EXT_ADDRESS_SRC */
398 0, /* SADB_EXT_ADDRESS_DST */
399 0, /* SADB_EXT_ADDRESS_PROXY */
400 0, /* SADB_EXT_KEY_AUTH */
401 0, /* SADB_EXT_KEY_ENCRYPT */
402 0, /* SADB_EXT_IDENTITY_SRC */
403 0, /* SADB_EXT_IDENTITY_DST */
404 0, /* SADB_EXT_SENSITIVITY */
405 0, /* SADB_EXT_PROPOSAL */
406 0, /* SADB_EXT_SUPPORTED_AUTH */
407 0, /* SADB_EXT_SUPPORTED_ENCRYPT */
408 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
409 0, /* SADB_X_EXT_KMPRIVATE */
410 0, /* SADB_X_EXT_POLICY */
411 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
412 sizeof(struct sadb_x_nat_t_type),/* SADB_X_EXT_NAT_T_TYPE */
413 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_SPORT */
414 sizeof(struct sadb_x_nat_t_port),/* SADB_X_EXT_NAT_T_DPORT */
415 0, /* SADB_X_EXT_NAT_T_OAI */
416 0, /* SADB_X_EXT_NAT_T_OAR */
417 sizeof(struct sadb_x_nat_t_frag),/* SADB_X_EXT_NAT_T_FRAG */
418 sizeof(struct sadb_x_sa_replay), /* SADB_X_EXT_SA_REPLAY */
419 0, /* SADB_X_EXT_NEW_ADDRESS_SRC */
420 0, /* SADB_X_EXT_NEW_ADDRESS_DST */
422 _Static_assert(sizeof(maxsize)/sizeof(int) == SADB_EXT_MAX + 1, "minsize size mismatch");
425 * Internal values for SA flags:
426 * SADB_X_EXT_F_CLONED means that SA was cloned by key_updateaddresses,
427 * thus we will not free the most of SA content in key_delsav().
429 #define SADB_X_EXT_F_CLONED 0x80000000
431 #define SADB_CHECKLEN(_mhp, _ext) \
432 ((_mhp)->extlen[(_ext)] < minsize[(_ext)] || (maxsize[(_ext)] != 0 && \
433 ((_mhp)->extlen[(_ext)] > maxsize[(_ext)])))
434 #define SADB_CHECKHDR(_mhp, _ext) ((_mhp)->ext[(_ext)] == NULL)
436 VNET_DEFINE_STATIC(int, ipsec_esp_keymin) = 256;
437 VNET_DEFINE_STATIC(int, ipsec_esp_auth) = 0;
438 VNET_DEFINE_STATIC(int, ipsec_ah_keymin) = 128;
440 #define V_ipsec_esp_keymin VNET(ipsec_esp_keymin)
441 #define V_ipsec_esp_auth VNET(ipsec_esp_auth)
442 #define V_ipsec_ah_keymin VNET(ipsec_ah_keymin)
445 VNET_DEFINE(int, ipsec_debug) = 1;
447 VNET_DEFINE(int, ipsec_debug) = 0;
451 SYSCTL_DECL(_net_inet_ipsec);
452 SYSCTL_INT(_net_inet_ipsec, IPSECCTL_DEBUG, debug,
453 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
454 "Enable IPsec debugging output when set.");
457 SYSCTL_DECL(_net_inet6_ipsec6);
458 SYSCTL_INT(_net_inet6_ipsec6, IPSECCTL_DEBUG, debug,
459 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
460 "Enable IPsec debugging output when set.");
463 SYSCTL_DECL(_net_key);
464 SYSCTL_INT(_net_key, KEYCTL_DEBUG_LEVEL, debug,
465 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_debug_level), 0, "");
467 /* max count of trial for the decision of spi value */
468 SYSCTL_INT(_net_key, KEYCTL_SPI_TRY, spi_trycnt,
469 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_trycnt), 0, "");
471 /* minimum spi value to allocate automatically. */
472 SYSCTL_INT(_net_key, KEYCTL_SPI_MIN_VALUE, spi_minval,
473 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_minval), 0, "");
475 /* maximun spi value to allocate automatically. */
476 SYSCTL_INT(_net_key, KEYCTL_SPI_MAX_VALUE, spi_maxval,
477 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_maxval), 0, "");
479 /* interval to initialize randseed */
480 SYSCTL_INT(_net_key, KEYCTL_RANDOM_INT, int_random,
481 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_int_random), 0, "");
483 /* lifetime for larval SA */
484 SYSCTL_INT(_net_key, KEYCTL_LARVAL_LIFETIME, larval_lifetime,
485 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_larval_lifetime), 0, "");
487 /* counter for blocking to send SADB_ACQUIRE to IKEd */
488 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_COUNT, blockacq_count,
489 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_count), 0, "");
491 /* lifetime for blocking to send SADB_ACQUIRE to IKEd */
492 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_LIFETIME, blockacq_lifetime,
493 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_lifetime), 0, "");
496 SYSCTL_INT(_net_key, KEYCTL_ESP_AUTH, esp_auth,
497 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_auth), 0, "");
499 /* minimum ESP key length */
500 SYSCTL_INT(_net_key, KEYCTL_ESP_KEYMIN, esp_keymin,
501 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_keymin), 0, "");
503 /* minimum AH key length */
504 SYSCTL_INT(_net_key, KEYCTL_AH_KEYMIN, ah_keymin,
505 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_ah_keymin), 0, "");
507 /* perfered old SA rather than new SA */
508 SYSCTL_INT(_net_key, KEYCTL_PREFERED_OLDSA, preferred_oldsa,
509 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_preferred_oldsa), 0, "");
511 static SYSCTL_NODE(_net_key, OID_AUTO, spdcache,
512 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
515 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, maxentries,
516 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_maxentries), 0,
517 "Maximum number of entries in the SPD cache"
518 " (power of 2, 0 to disable)");
520 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, threshold,
521 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_threshold), 0,
522 "Number of SPs that make the SPD cache active");
524 #define __LIST_CHAINED(elm) \
525 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
527 MALLOC_DEFINE(M_IPSEC_SA, "secasvar", "ipsec security association");
528 MALLOC_DEFINE(M_IPSEC_SAH, "sahead", "ipsec sa head");
529 MALLOC_DEFINE(M_IPSEC_SP, "ipsecpolicy", "ipsec security policy");
530 MALLOC_DEFINE(M_IPSEC_SR, "ipsecrequest", "ipsec security request");
531 MALLOC_DEFINE(M_IPSEC_MISC, "ipsec-misc", "ipsec miscellaneous");
532 MALLOC_DEFINE(M_IPSEC_SAQ, "ipsec-saq", "ipsec sa acquire");
533 MALLOC_DEFINE(M_IPSEC_SAR, "ipsec-reg", "ipsec sa acquire");
534 MALLOC_DEFINE(M_IPSEC_SPDCACHE, "ipsec-spdcache", "ipsec SPD cache");
536 VNET_DEFINE_STATIC(uma_zone_t, key_lft_zone);
537 #define V_key_lft_zone VNET(key_lft_zone)
540 * set parameters into secpolicyindex buffer.
541 * Must allocate secpolicyindex buffer passed to this function.
543 #define KEY_SETSECSPIDX(_dir, s, d, ps, pd, ulp, idx) \
545 bzero((idx), sizeof(struct secpolicyindex)); \
546 (idx)->dir = (_dir); \
547 (idx)->prefs = (ps); \
548 (idx)->prefd = (pd); \
549 (idx)->ul_proto = (ulp); \
550 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
551 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
555 * set parameters into secasindex buffer.
556 * Must allocate secasindex buffer before calling this function.
558 #define KEY_SETSECASIDX(p, m, r, s, d, idx) \
560 bzero((idx), sizeof(struct secasindex)); \
561 (idx)->proto = (p); \
563 (idx)->reqid = (r); \
564 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
565 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
566 key_porttosaddr(&(idx)->src.sa, 0); \
567 key_porttosaddr(&(idx)->dst.sa, 0); \
572 u_long getspi_count; /* the avarage of count to try to get new SPI */
576 struct sadb_msg *msg;
577 struct sadb_ext *ext[SADB_EXT_MAX + 1];
578 int extoff[SADB_EXT_MAX + 1];
579 int extlen[SADB_EXT_MAX + 1];
582 static struct supported_ealgs {
584 const struct enc_xform *xform;
585 } supported_ealgs[] = {
586 { SADB_EALG_DESCBC, &enc_xform_des },
587 { SADB_EALG_3DESCBC, &enc_xform_3des },
588 { SADB_X_EALG_AES, &enc_xform_rijndael128 },
589 { SADB_X_EALG_BLOWFISHCBC, &enc_xform_blf },
590 { SADB_X_EALG_CAST128CBC, &enc_xform_cast5 },
591 { SADB_EALG_NULL, &enc_xform_null },
592 { SADB_X_EALG_CAMELLIACBC, &enc_xform_camellia },
593 { SADB_X_EALG_AESCTR, &enc_xform_aes_icm },
594 { SADB_X_EALG_AESGCM16, &enc_xform_aes_nist_gcm },
595 { SADB_X_EALG_AESGMAC, &enc_xform_aes_nist_gmac },
598 static struct supported_aalgs {
600 const struct auth_hash *xform;
601 } supported_aalgs[] = {
602 { SADB_X_AALG_NULL, &auth_hash_null },
603 { SADB_AALG_MD5HMAC, &auth_hash_hmac_md5 },
604 { SADB_AALG_SHA1HMAC, &auth_hash_hmac_sha1 },
605 { SADB_X_AALG_RIPEMD160HMAC, &auth_hash_hmac_ripemd_160 },
606 { SADB_X_AALG_MD5, &auth_hash_key_md5 },
607 { SADB_X_AALG_SHA, &auth_hash_key_sha1 },
608 { SADB_X_AALG_SHA2_256, &auth_hash_hmac_sha2_256 },
609 { SADB_X_AALG_SHA2_384, &auth_hash_hmac_sha2_384 },
610 { SADB_X_AALG_SHA2_512, &auth_hash_hmac_sha2_512 },
611 { SADB_X_AALG_AES128GMAC, &auth_hash_nist_gmac_aes_128 },
612 { SADB_X_AALG_AES192GMAC, &auth_hash_nist_gmac_aes_192 },
613 { SADB_X_AALG_AES256GMAC, &auth_hash_nist_gmac_aes_256 },
616 static struct supported_calgs {
618 const struct comp_algo *xform;
619 } supported_calgs[] = {
620 { SADB_X_CALG_DEFLATE, &comp_algo_deflate },
624 static struct callout key_timer;
627 static void key_unlink(struct secpolicy *);
628 static struct secpolicy *key_do_allocsp(struct secpolicyindex *spidx, u_int dir);
629 static struct secpolicy *key_getsp(struct secpolicyindex *);
630 static struct secpolicy *key_getspbyid(u_int32_t);
631 static struct mbuf *key_gather_mbuf(struct mbuf *,
632 const struct sadb_msghdr *, int, int, ...);
633 static int key_spdadd(struct socket *, struct mbuf *,
634 const struct sadb_msghdr *);
635 static uint32_t key_getnewspid(void);
636 static int key_spddelete(struct socket *, struct mbuf *,
637 const struct sadb_msghdr *);
638 static int key_spddelete2(struct socket *, struct mbuf *,
639 const struct sadb_msghdr *);
640 static int key_spdget(struct socket *, struct mbuf *,
641 const struct sadb_msghdr *);
642 static int key_spdflush(struct socket *, struct mbuf *,
643 const struct sadb_msghdr *);
644 static int key_spddump(struct socket *, struct mbuf *,
645 const struct sadb_msghdr *);
646 static struct mbuf *key_setdumpsp(struct secpolicy *,
647 u_int8_t, u_int32_t, u_int32_t);
648 static struct mbuf *key_sp2mbuf(struct secpolicy *);
649 static size_t key_getspreqmsglen(struct secpolicy *);
650 static int key_spdexpire(struct secpolicy *);
651 static struct secashead *key_newsah(struct secasindex *);
652 static void key_freesah(struct secashead **);
653 static void key_delsah(struct secashead *);
654 static struct secasvar *key_newsav(const struct sadb_msghdr *,
655 struct secasindex *, uint32_t, int *);
656 static void key_delsav(struct secasvar *);
657 static void key_unlinksav(struct secasvar *);
658 static struct secashead *key_getsah(struct secasindex *);
659 static int key_checkspidup(uint32_t);
660 static struct secasvar *key_getsavbyspi(uint32_t);
661 static int key_setnatt(struct secasvar *, const struct sadb_msghdr *);
662 static int key_setsaval(struct secasvar *, const struct sadb_msghdr *);
663 static int key_updatelifetimes(struct secasvar *, const struct sadb_msghdr *);
664 static int key_updateaddresses(struct socket *, struct mbuf *,
665 const struct sadb_msghdr *, struct secasvar *, struct secasindex *);
667 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
668 u_int8_t, u_int32_t, u_int32_t);
669 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
670 u_int32_t, pid_t, u_int16_t);
671 static struct mbuf *key_setsadbsa(struct secasvar *);
672 static struct mbuf *key_setsadbaddr(u_int16_t,
673 const struct sockaddr *, u_int8_t, u_int16_t);
674 static struct mbuf *key_setsadbxport(u_int16_t, u_int16_t);
675 static struct mbuf *key_setsadbxtype(u_int16_t);
676 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t);
677 static struct mbuf *key_setsadbxsareplay(u_int32_t);
678 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
679 u_int32_t, u_int32_t);
680 static struct seckey *key_dup_keymsg(const struct sadb_key *, size_t,
681 struct malloc_type *);
682 static struct seclifetime *key_dup_lifemsg(const struct sadb_lifetime *src,
683 struct malloc_type *);
685 /* flags for key_cmpsaidx() */
686 #define CMP_HEAD 1 /* protocol, addresses. */
687 #define CMP_MODE_REQID 2 /* additionally HEAD, reqid, mode. */
688 #define CMP_REQID 3 /* additionally HEAD, reaid. */
689 #define CMP_EXACTLY 4 /* all elements. */
690 static int key_cmpsaidx(const struct secasindex *,
691 const struct secasindex *, int);
692 static int key_cmpspidx_exactly(struct secpolicyindex *,
693 struct secpolicyindex *);
694 static int key_cmpspidx_withmask(struct secpolicyindex *,
695 struct secpolicyindex *);
696 static int key_bbcmp(const void *, const void *, u_int);
697 static uint8_t key_satype2proto(uint8_t);
698 static uint8_t key_proto2satype(uint8_t);
700 static int key_getspi(struct socket *, struct mbuf *,
701 const struct sadb_msghdr *);
702 static uint32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
703 static int key_update(struct socket *, struct mbuf *,
704 const struct sadb_msghdr *);
705 static int key_add(struct socket *, struct mbuf *,
706 const struct sadb_msghdr *);
707 static int key_setident(struct secashead *, const struct sadb_msghdr *);
708 static struct mbuf *key_getmsgbuf_x1(struct mbuf *,
709 const struct sadb_msghdr *);
710 static int key_delete(struct socket *, struct mbuf *,
711 const struct sadb_msghdr *);
712 static int key_delete_all(struct socket *, struct mbuf *,
713 const struct sadb_msghdr *, struct secasindex *);
714 static int key_get(struct socket *, struct mbuf *,
715 const struct sadb_msghdr *);
717 static void key_getcomb_setlifetime(struct sadb_comb *);
718 static struct mbuf *key_getcomb_ealg(void);
719 static struct mbuf *key_getcomb_ah(void);
720 static struct mbuf *key_getcomb_ipcomp(void);
721 static struct mbuf *key_getprop(const struct secasindex *);
723 static int key_acquire(const struct secasindex *, struct secpolicy *);
724 static uint32_t key_newacq(const struct secasindex *, int *);
725 static uint32_t key_getacq(const struct secasindex *, int *);
726 static int key_acqdone(const struct secasindex *, uint32_t);
727 static int key_acqreset(uint32_t);
728 static struct secspacq *key_newspacq(struct secpolicyindex *);
729 static struct secspacq *key_getspacq(struct secpolicyindex *);
730 static int key_acquire2(struct socket *, struct mbuf *,
731 const struct sadb_msghdr *);
732 static int key_register(struct socket *, struct mbuf *,
733 const struct sadb_msghdr *);
734 static int key_expire(struct secasvar *, int);
735 static int key_flush(struct socket *, struct mbuf *,
736 const struct sadb_msghdr *);
737 static int key_dump(struct socket *, struct mbuf *,
738 const struct sadb_msghdr *);
739 static int key_promisc(struct socket *, struct mbuf *,
740 const struct sadb_msghdr *);
741 static int key_senderror(struct socket *, struct mbuf *, int);
742 static int key_validate_ext(const struct sadb_ext *, int);
743 static int key_align(struct mbuf *, struct sadb_msghdr *);
744 static struct mbuf *key_setlifetime(struct seclifetime *, uint16_t);
745 static struct mbuf *key_setkey(struct seckey *, uint16_t);
747 static void spdcache_init(void);
748 static void spdcache_clear(void);
749 static struct spdcache_entry *spdcache_entry_alloc(
750 const struct secpolicyindex *spidx,
751 struct secpolicy *policy);
752 static void spdcache_entry_free(struct spdcache_entry *entry);
754 static void spdcache_destroy(void);
757 #define DBG_IPSEC_INITREF(t, p) do { \
758 refcount_init(&(p)->refcnt, 1); \
760 printf("%s: Initialize refcnt %s(%p) = %u\n", \
761 __func__, #t, (p), (p)->refcnt)); \
763 #define DBG_IPSEC_ADDREF(t, p) do { \
764 refcount_acquire(&(p)->refcnt); \
766 printf("%s: Acquire refcnt %s(%p) -> %u\n", \
767 __func__, #t, (p), (p)->refcnt)); \
769 #define DBG_IPSEC_DELREF(t, p) do { \
771 printf("%s: Release refcnt %s(%p) -> %u\n", \
772 __func__, #t, (p), (p)->refcnt - 1)); \
773 refcount_release(&(p)->refcnt); \
776 #define IPSEC_INITREF(t, p) refcount_init(&(p)->refcnt, 1)
777 #define IPSEC_ADDREF(t, p) refcount_acquire(&(p)->refcnt)
778 #define IPSEC_DELREF(t, p) refcount_release(&(p)->refcnt)
780 #define SP_INITREF(p) IPSEC_INITREF(SP, p)
781 #define SP_ADDREF(p) IPSEC_ADDREF(SP, p)
782 #define SP_DELREF(p) IPSEC_DELREF(SP, p)
784 #define SAH_INITREF(p) IPSEC_INITREF(SAH, p)
785 #define SAH_ADDREF(p) IPSEC_ADDREF(SAH, p)
786 #define SAH_DELREF(p) IPSEC_DELREF(SAH, p)
788 #define SAV_INITREF(p) IPSEC_INITREF(SAV, p)
789 #define SAV_ADDREF(p) IPSEC_ADDREF(SAV, p)
790 #define SAV_DELREF(p) IPSEC_DELREF(SAV, p)
793 * Update the refcnt while holding the SPTREE lock.
796 key_addref(struct secpolicy *sp)
803 * Return 0 when there are known to be no SP's for the specified
804 * direction. Otherwise return 1. This is used by IPsec code
805 * to optimize performance.
808 key_havesp(u_int dir)
811 return (dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND ?
812 TAILQ_FIRST(&V_sptree[dir]) != NULL : 1);
815 /* %%% IPsec policy management */
817 * Return current SPDB generation.
834 key_checksockaddrs(struct sockaddr *src, struct sockaddr *dst)
838 if (src->sa_family != dst->sa_family)
841 if (src->sa_len != dst->sa_len)
843 switch (src->sa_family) {
846 if (src->sa_len != sizeof(struct sockaddr_in))
852 if (src->sa_len != sizeof(struct sockaddr_in6))
857 return (EAFNOSUPPORT);
863 key_do_allocsp(struct secpolicyindex *spidx, u_int dir)
865 SPTREE_RLOCK_TRACKER;
866 struct secpolicy *sp;
868 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
869 IPSEC_ASSERT(dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND,
870 ("invalid direction %u", dir));
873 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
874 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
885 * allocating a SP for OUTBOUND or INBOUND packet.
886 * Must call key_freesp() later.
887 * OUT: NULL: not found
888 * others: found and return the pointer.
891 key_allocsp(struct secpolicyindex *spidx, u_int dir)
893 struct spdcache_entry *entry, *lastentry, *tmpentry;
894 struct secpolicy *sp;
898 if (!SPDCACHE_ACTIVE()) {
899 sp = key_do_allocsp(spidx, dir);
903 hashv = SPDCACHE_HASHVAL(spidx);
904 SPDCACHE_LOCK(hashv);
906 LIST_FOREACH_SAFE(entry, &V_spdcachehashtbl[hashv], chain, tmpentry) {
907 /* Removed outdated entries */
908 if (entry->sp != NULL &&
909 entry->sp->state == IPSEC_SPSTATE_DEAD) {
910 LIST_REMOVE(entry, chain);
911 spdcache_entry_free(entry);
916 if (!key_cmpspidx_exactly(&entry->spidx, spidx)) {
922 if (entry->sp != NULL)
925 /* IPSECSTAT_INC(ips_spdcache_hits); */
927 SPDCACHE_UNLOCK(hashv);
931 /* IPSECSTAT_INC(ips_spdcache_misses); */
933 sp = key_do_allocsp(spidx, dir);
934 entry = spdcache_entry_alloc(spidx, sp);
936 if (nb_entries >= SPDCACHE_MAX_ENTRIES_PER_HASH) {
937 LIST_REMOVE(lastentry, chain);
938 spdcache_entry_free(lastentry);
941 LIST_INSERT_HEAD(&V_spdcachehashtbl[hashv], entry, chain);
944 SPDCACHE_UNLOCK(hashv);
947 if (sp != NULL) { /* found a SPD entry */
948 sp->lastused = time_second;
950 printf("%s: return SP(%p)\n", __func__, sp));
951 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
954 printf("%s: lookup failed for ", __func__);
955 kdebug_secpolicyindex(spidx, NULL));
961 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
962 * or should be signed by MD5 signature.
963 * We don't use key_allocsa() for such lookups, because we don't know SPI.
964 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
965 * signed packet. We use SADB only as storage for password.
966 * OUT: positive: corresponding SA for given saidx found.
970 key_allocsa_tcpmd5(struct secasindex *saidx)
972 SAHTREE_RLOCK_TRACKER;
973 struct secashead *sah;
974 struct secasvar *sav;
976 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
977 ("unexpected security protocol %u", saidx->proto));
978 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
979 ("unexpected mode %u", saidx->mode));
982 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
984 printf("%s: checking SAH\n", __func__);
985 kdebug_secash(sah, " "));
986 if (sah->saidx.proto != IPPROTO_TCP)
988 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
989 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
993 if (V_key_preferred_oldsa)
994 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
996 sav = TAILQ_FIRST(&sah->savtree_alive);
1005 printf("%s: return SA(%p)\n", __func__, sav));
1006 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1009 printf("%s: SA not found\n", __func__));
1010 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1016 * Allocating an SA entry for an *OUTBOUND* packet.
1017 * OUT: positive: corresponding SA for given saidx found.
1018 * NULL: SA not found, but will be acquired, check *error
1019 * for acquiring status.
1022 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
1025 SAHTREE_RLOCK_TRACKER;
1026 struct secashead *sah;
1027 struct secasvar *sav;
1029 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
1030 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
1031 saidx->mode == IPSEC_MODE_TUNNEL,
1032 ("unexpected policy %u", saidx->mode));
1035 * We check new SA in the IPsec request because a different
1036 * SA may be involved each time this request is checked, either
1037 * because new SAs are being configured, or this request is
1038 * associated with an unconnected datagram socket, or this request
1039 * is associated with a system default policy.
1042 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
1044 printf("%s: checking SAH\n", __func__);
1045 kdebug_secash(sah, " "));
1046 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
1052 * Allocate the oldest SA available according to
1053 * draft-jenkins-ipsec-rekeying-03.
1055 if (V_key_preferred_oldsa)
1056 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1058 sav = TAILQ_FIRST(&sah->savtree_alive);
1068 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
1070 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1071 return (sav); /* return referenced SA */
1074 /* there is no SA */
1075 *error = key_acquire(saidx, sp);
1077 ipseclog((LOG_DEBUG,
1078 "%s: error %d returned from key_acquire()\n",
1081 printf("%s: acquire SA for SP(%p), error %d\n",
1082 __func__, sp, *error));
1083 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1088 * allocating a usable SA entry for a *INBOUND* packet.
1089 * Must call key_freesav() later.
1090 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
1091 * NULL: not found, or error occurred.
1093 * According to RFC 2401 SA is uniquely identified by a triple SPI,
1094 * destination address, and security protocol. But according to RFC 4301,
1095 * SPI by itself suffices to specify an SA.
1097 * Note that, however, we do need to keep source address in IPsec SA.
1098 * IKE specification and PF_KEY specification do assume that we
1099 * keep source address in IPsec SA. We see a tricky situation here.
1102 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
1104 SAHTREE_RLOCK_TRACKER;
1105 struct secasvar *sav;
1107 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
1108 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
1112 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
1113 if (sav->spi == spi)
1117 * We use single SPI namespace for all protocols, so it is
1118 * impossible to have SPI duplicates in the SAVHASH.
1121 if (sav->state != SADB_SASTATE_LARVAL &&
1122 sav->sah->saidx.proto == proto &&
1123 key_sockaddrcmp(&dst->sa,
1124 &sav->sah->saidx.dst.sa, 0) == 0)
1133 char buf[IPSEC_ADDRSTRLEN];
1134 printf("%s: SA not found for spi %u proto %u dst %s\n",
1135 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1139 printf("%s: return SA(%p)\n", __func__, sav));
1140 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1146 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1149 SAHTREE_RLOCK_TRACKER;
1150 struct secasindex saidx;
1151 struct secashead *sah;
1152 struct secasvar *sav;
1154 IPSEC_ASSERT(src != NULL, ("null src address"));
1155 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1157 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1162 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1163 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1165 if (proto != sah->saidx.proto)
1167 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1169 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1171 /* XXXAE: is key_preferred_oldsa reasonably?*/
1172 if (V_key_preferred_oldsa)
1173 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1175 sav = TAILQ_FIRST(&sah->savtree_alive);
1183 printf("%s: return SA(%p)\n", __func__, sav));
1185 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1190 * Must be called after calling key_allocsp().
1193 key_freesp(struct secpolicy **spp)
1195 struct secpolicy *sp = *spp;
1197 IPSEC_ASSERT(sp != NULL, ("null sp"));
1198 if (SP_DELREF(sp) == 0)
1202 printf("%s: last reference to SP(%p)\n", __func__, sp));
1203 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1206 while (sp->tcount > 0)
1207 ipsec_delisr(sp->req[--sp->tcount]);
1208 free(sp, M_IPSEC_SP);
1212 key_unlink(struct secpolicy *sp)
1215 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1216 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1217 ("invalid direction %u", sp->spidx.dir));
1218 SPTREE_UNLOCK_ASSERT();
1221 printf("%s: SP(%p)\n", __func__, sp));
1223 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1224 /* SP is already unlinked */
1228 sp->state = IPSEC_SPSTATE_DEAD;
1229 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1231 LIST_REMOVE(sp, idhash);
1234 if (SPDCACHE_ENABLED())
1240 * insert a secpolicy into the SP database. Lower priorities first
1243 key_insertsp(struct secpolicy *newsp)
1245 struct secpolicy *sp;
1247 SPTREE_WLOCK_ASSERT();
1248 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1249 if (newsp->priority < sp->priority) {
1250 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1254 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1256 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1257 newsp->state = IPSEC_SPSTATE_ALIVE;
1263 * Insert a bunch of VTI secpolicies into the SPDB.
1264 * We keep VTI policies in the separate list due to following reasons:
1265 * 1) they should be immutable to user's or some deamon's attempts to
1266 * delete. The only way delete such policies - destroy or unconfigure
1267 * corresponding virtual inteface.
1268 * 2) such policies have traffic selector that matches all traffic per
1270 * Since all VTI policies have the same priority, we don't care about
1274 key_register_ifnet(struct secpolicy **spp, u_int count)
1281 * First of try to acquire id for each SP.
1283 for (i = 0; i < count; i++) {
1284 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1285 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1286 ("invalid direction %u", spp[i]->spidx.dir));
1288 if ((spp[i]->id = key_getnewspid()) == 0) {
1293 for (i = 0; i < count; i++) {
1294 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1297 * NOTE: despite the fact that we keep VTI SP in the
1298 * separate list, SPHASH contains policies from both
1299 * sources. Thus SADB_X_SPDGET will correctly return
1300 * SP by id, because it uses SPHASH for lookups.
1302 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1303 spp[i]->state = IPSEC_SPSTATE_IFNET;
1307 * Notify user processes about new SP.
1309 for (i = 0; i < count; i++) {
1310 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1312 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1318 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1324 for (i = 0; i < count; i++) {
1325 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1326 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1327 ("invalid direction %u", spp[i]->spidx.dir));
1329 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1331 spp[i]->state = IPSEC_SPSTATE_DEAD;
1332 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1335 LIST_REMOVE(spp[i], idhash);
1338 if (SPDCACHE_ENABLED())
1341 for (i = 0; i < count; i++) {
1342 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1344 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1349 * Must be called after calling key_allocsa().
1350 * This function is called by key_freesp() to free some SA allocated
1354 key_freesav(struct secasvar **psav)
1356 struct secasvar *sav = *psav;
1358 IPSEC_ASSERT(sav != NULL, ("null sav"));
1359 if (SAV_DELREF(sav) == 0)
1363 printf("%s: last reference to SA(%p)\n", __func__, sav));
1370 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1371 * Expect that SA has extra reference due to lookup.
1372 * Release this references, also release SAH reference after unlink.
1375 key_unlinksav(struct secasvar *sav)
1377 struct secashead *sah;
1380 printf("%s: SA(%p)\n", __func__, sav));
1382 SAHTREE_UNLOCK_ASSERT();
1384 if (sav->state == SADB_SASTATE_DEAD) {
1385 /* SA is already unlinked */
1389 /* Unlink from SAH */
1390 if (sav->state == SADB_SASTATE_LARVAL)
1391 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1393 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1394 /* Unlink from SPI hash */
1395 LIST_REMOVE(sav, spihash);
1396 sav->state = SADB_SASTATE_DEAD;
1400 /* Since we are unlinked, release reference to SAH */
1404 /* %%% SPD management */
1407 * OUT: NULL : not found
1408 * others : found, pointer to a SP.
1410 static struct secpolicy *
1411 key_getsp(struct secpolicyindex *spidx)
1413 SPTREE_RLOCK_TRACKER;
1414 struct secpolicy *sp;
1416 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1419 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1420 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1432 * OUT: NULL : not found
1433 * others : found, pointer to referenced SP.
1435 static struct secpolicy *
1436 key_getspbyid(uint32_t id)
1438 SPTREE_RLOCK_TRACKER;
1439 struct secpolicy *sp;
1442 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1455 struct secpolicy *sp;
1457 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1463 struct ipsecrequest *
1467 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1468 M_NOWAIT | M_ZERO));
1472 ipsec_delisr(struct ipsecrequest *p)
1475 free(p, M_IPSEC_SR);
1479 * create secpolicy structure from sadb_x_policy structure.
1480 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1481 * are not set, so must be set properly later.
1484 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1486 struct secpolicy *newsp;
1488 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1489 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1491 if (len != PFKEY_EXTLEN(xpl0)) {
1492 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1497 if ((newsp = key_newsp()) == NULL) {
1502 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1503 newsp->policy = xpl0->sadb_x_policy_type;
1504 newsp->priority = xpl0->sadb_x_policy_priority;
1508 switch (xpl0->sadb_x_policy_type) {
1509 case IPSEC_POLICY_DISCARD:
1510 case IPSEC_POLICY_NONE:
1511 case IPSEC_POLICY_ENTRUST:
1512 case IPSEC_POLICY_BYPASS:
1515 case IPSEC_POLICY_IPSEC:
1517 struct sadb_x_ipsecrequest *xisr;
1518 struct ipsecrequest *isr;
1521 /* validity check */
1522 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1523 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1530 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1531 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1535 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1536 xisr->sadb_x_ipsecrequest_len > tlen) {
1537 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1538 "length.\n", __func__));
1544 if (newsp->tcount >= IPSEC_MAXREQ) {
1545 ipseclog((LOG_DEBUG,
1546 "%s: too many ipsecrequests.\n",
1553 /* allocate request buffer */
1554 /* NB: data structure is zero'd */
1555 isr = ipsec_newisr();
1557 ipseclog((LOG_DEBUG,
1558 "%s: No more memory.\n", __func__));
1564 newsp->req[newsp->tcount++] = isr;
1567 switch (xisr->sadb_x_ipsecrequest_proto) {
1570 case IPPROTO_IPCOMP:
1573 ipseclog((LOG_DEBUG,
1574 "%s: invalid proto type=%u\n", __func__,
1575 xisr->sadb_x_ipsecrequest_proto));
1577 *error = EPROTONOSUPPORT;
1581 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1583 switch (xisr->sadb_x_ipsecrequest_mode) {
1584 case IPSEC_MODE_TRANSPORT:
1585 case IPSEC_MODE_TUNNEL:
1587 case IPSEC_MODE_ANY:
1589 ipseclog((LOG_DEBUG,
1590 "%s: invalid mode=%u\n", __func__,
1591 xisr->sadb_x_ipsecrequest_mode));
1596 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1598 switch (xisr->sadb_x_ipsecrequest_level) {
1599 case IPSEC_LEVEL_DEFAULT:
1600 case IPSEC_LEVEL_USE:
1601 case IPSEC_LEVEL_REQUIRE:
1603 case IPSEC_LEVEL_UNIQUE:
1604 /* validity check */
1606 * If range violation of reqid, kernel will
1607 * update it, don't refuse it.
1609 if (xisr->sadb_x_ipsecrequest_reqid
1610 > IPSEC_MANUAL_REQID_MAX) {
1611 ipseclog((LOG_DEBUG,
1612 "%s: reqid=%d range "
1613 "violation, updated by kernel.\n",
1615 xisr->sadb_x_ipsecrequest_reqid));
1616 xisr->sadb_x_ipsecrequest_reqid = 0;
1619 /* allocate new reqid id if reqid is zero. */
1620 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1622 if ((reqid = key_newreqid()) == 0) {
1627 isr->saidx.reqid = reqid;
1628 xisr->sadb_x_ipsecrequest_reqid = reqid;
1630 /* set it for manual keying. */
1632 xisr->sadb_x_ipsecrequest_reqid;
1637 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1639 xisr->sadb_x_ipsecrequest_level));
1644 isr->level = xisr->sadb_x_ipsecrequest_level;
1646 /* set IP addresses if there */
1647 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1648 struct sockaddr *paddr;
1650 len = tlen - sizeof(*xisr);
1651 paddr = (struct sockaddr *)(xisr + 1);
1652 /* validity check */
1653 if (len < sizeof(struct sockaddr) ||
1654 len < 2 * paddr->sa_len ||
1655 paddr->sa_len > sizeof(isr->saidx.src)) {
1656 ipseclog((LOG_DEBUG, "%s: invalid "
1657 "request address length.\n",
1664 * Request length should be enough to keep
1665 * source and destination addresses.
1667 if (xisr->sadb_x_ipsecrequest_len <
1668 sizeof(*xisr) + 2 * paddr->sa_len) {
1669 ipseclog((LOG_DEBUG, "%s: invalid "
1670 "ipsecrequest length.\n",
1676 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1677 paddr = (struct sockaddr *)((caddr_t)paddr +
1680 /* validity check */
1681 if (paddr->sa_len !=
1682 isr->saidx.src.sa.sa_len) {
1683 ipseclog((LOG_DEBUG, "%s: invalid "
1684 "request address length.\n",
1690 /* AF family should match */
1691 if (paddr->sa_family !=
1692 isr->saidx.src.sa.sa_family) {
1693 ipseclog((LOG_DEBUG, "%s: address "
1694 "family doesn't match.\n",
1700 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1703 * Addresses for TUNNEL mode requests are
1706 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1707 ipseclog((LOG_DEBUG, "%s: missing "
1708 "request addresses.\n", __func__));
1714 tlen -= xisr->sadb_x_ipsecrequest_len;
1716 /* validity check */
1718 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1725 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1726 + xisr->sadb_x_ipsecrequest_len);
1728 /* XXXAE: LARVAL SP */
1729 if (newsp->tcount < 1) {
1730 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1731 "not found.\n", __func__));
1739 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1752 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1754 if (auto_reqid == ~0)
1755 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1759 /* XXX should be unique check */
1760 return (auto_reqid);
1764 * copy secpolicy struct to sadb_x_policy structure indicated.
1766 static struct mbuf *
1767 key_sp2mbuf(struct secpolicy *sp)
1772 tlen = key_getspreqmsglen(sp);
1773 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1778 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1786 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1788 struct sadb_x_ipsecrequest *xisr;
1789 struct sadb_x_policy *xpl;
1790 struct ipsecrequest *isr;
1795 IPSEC_ASSERT(sp != NULL, ("null policy"));
1797 xlen = sizeof(*xpl);
1802 bzero(request, *len);
1803 xpl = (struct sadb_x_policy *)request;
1804 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1805 xpl->sadb_x_policy_type = sp->policy;
1806 xpl->sadb_x_policy_dir = sp->spidx.dir;
1807 xpl->sadb_x_policy_id = sp->id;
1808 xpl->sadb_x_policy_priority = sp->priority;
1809 switch (sp->state) {
1810 case IPSEC_SPSTATE_IFNET:
1811 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1813 case IPSEC_SPSTATE_PCB:
1814 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1817 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1820 /* if is the policy for ipsec ? */
1821 if (sp->policy == IPSEC_POLICY_IPSEC) {
1822 p = (caddr_t)xpl + sizeof(*xpl);
1823 for (i = 0; i < sp->tcount; i++) {
1825 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1826 isr->saidx.src.sa.sa_len +
1827 isr->saidx.dst.sa.sa_len);
1831 /* Calculate needed size */
1834 xisr = (struct sadb_x_ipsecrequest *)p;
1835 xisr->sadb_x_ipsecrequest_len = ilen;
1836 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1837 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1838 xisr->sadb_x_ipsecrequest_level = isr->level;
1839 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1842 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1843 p += isr->saidx.src.sa.sa_len;
1844 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1845 p += isr->saidx.dst.sa.sa_len;
1848 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1852 *len = sizeof(*xpl);
1856 /* m will not be freed nor modified */
1857 static struct mbuf *
1858 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1859 int ndeep, int nitem, ...)
1864 struct mbuf *result = NULL, *n;
1867 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1868 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1870 va_start(ap, nitem);
1871 for (i = 0; i < nitem; i++) {
1872 idx = va_arg(ap, int);
1873 if (idx < 0 || idx > SADB_EXT_MAX)
1875 /* don't attempt to pull empty extension */
1876 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1878 if (idx != SADB_EXT_RESERVED &&
1879 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1882 if (idx == SADB_EXT_RESERVED) {
1883 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1885 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1887 MGETHDR(n, M_NOWAIT, MT_DATA);
1892 m_copydata(m, 0, sizeof(struct sadb_msg),
1894 } else if (i < ndeep) {
1895 len = mhp->extlen[idx];
1896 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1901 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1904 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1917 if ((result->m_flags & M_PKTHDR) != 0) {
1918 result->m_pkthdr.len = 0;
1919 for (n = result; n; n = n->m_next)
1920 result->m_pkthdr.len += n->m_len;
1932 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1933 * add an entry to SP database, when received
1934 * <base, address(SD), (lifetime(H),) policy>
1936 * Adding to SP database,
1938 * <base, address(SD), (lifetime(H),) policy>
1939 * to the socket which was send.
1941 * SPDADD set a unique policy entry.
1942 * SPDSETIDX like SPDADD without a part of policy requests.
1943 * SPDUPDATE replace a unique policy entry.
1945 * XXXAE: serialize this in PF_KEY to avoid races.
1946 * m will always be freed.
1949 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1951 struct secpolicyindex spidx;
1952 struct sadb_address *src0, *dst0;
1953 struct sadb_x_policy *xpl0, *xpl;
1954 struct sadb_lifetime *lft = NULL;
1955 struct secpolicy *newsp;
1958 IPSEC_ASSERT(so != NULL, ("null socket"));
1959 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1960 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1961 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1963 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1964 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1965 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1966 ipseclog((LOG_DEBUG,
1967 "%s: invalid message: missing required header.\n",
1969 return key_senderror(so, m, EINVAL);
1971 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1972 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1973 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1974 ipseclog((LOG_DEBUG,
1975 "%s: invalid message: wrong header size.\n", __func__));
1976 return key_senderror(so, m, EINVAL);
1978 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1979 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1980 ipseclog((LOG_DEBUG,
1981 "%s: invalid message: wrong header size.\n",
1983 return key_senderror(so, m, EINVAL);
1985 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1988 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1989 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1990 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1992 /* check the direciton */
1993 switch (xpl0->sadb_x_policy_dir) {
1994 case IPSEC_DIR_INBOUND:
1995 case IPSEC_DIR_OUTBOUND:
1998 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
1999 return key_senderror(so, m, EINVAL);
2001 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
2002 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2003 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2004 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2005 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2006 return key_senderror(so, m, EINVAL);
2009 /* policy requests are mandatory when action is ipsec. */
2010 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
2011 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2012 ipseclog((LOG_DEBUG,
2013 "%s: policy requests required.\n", __func__));
2014 return key_senderror(so, m, EINVAL);
2017 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
2018 (struct sockaddr *)(dst0 + 1));
2020 src0->sadb_address_proto != dst0->sadb_address_proto) {
2021 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2022 return key_senderror(so, m, error);
2025 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2028 src0->sadb_address_prefixlen,
2029 dst0->sadb_address_prefixlen,
2030 src0->sadb_address_proto,
2032 /* Checking there is SP already or not. */
2033 newsp = key_getsp(&spidx);
2034 if (newsp != NULL) {
2035 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2037 printf("%s: unlink SP(%p) for SPDUPDATE\n",
2039 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2044 ipseclog((LOG_DEBUG,
2045 "%s: a SP entry exists already.\n", __func__));
2046 return (key_senderror(so, m, EEXIST));
2050 /* allocate new SP entry */
2051 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2052 return key_senderror(so, m, error);
2055 newsp->lastused = newsp->created = time_second;
2056 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
2057 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
2058 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
2060 /* XXXAE: there is race between key_getsp() and key_insertsp() */
2062 if ((newsp->id = key_getnewspid()) == 0) {
2065 return key_senderror(so, m, ENOBUFS);
2067 key_insertsp(newsp);
2069 if (SPDCACHE_ENABLED())
2073 printf("%s: SP(%p)\n", __func__, newsp));
2074 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2077 struct mbuf *n, *mpolicy;
2078 struct sadb_msg *newmsg;
2081 /* create new sadb_msg to reply. */
2083 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
2084 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
2085 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2087 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
2089 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2092 return key_senderror(so, m, ENOBUFS);
2094 if (n->m_len < sizeof(*newmsg)) {
2095 n = m_pullup(n, sizeof(*newmsg));
2097 return key_senderror(so, m, ENOBUFS);
2099 newmsg = mtod(n, struct sadb_msg *);
2100 newmsg->sadb_msg_errno = 0;
2101 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2104 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2105 sizeof(*xpl), &off);
2106 if (mpolicy == NULL) {
2107 /* n is already freed */
2108 return key_senderror(so, m, ENOBUFS);
2110 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
2111 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2113 return key_senderror(so, m, EINVAL);
2115 xpl->sadb_x_policy_id = newsp->id;
2118 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2123 * get new policy id.
2129 key_getnewspid(void)
2131 struct secpolicy *sp;
2133 int count = V_key_spi_trycnt; /* XXX */
2135 SPTREE_WLOCK_ASSERT();
2137 if (V_policy_id == ~0) /* overflowed */
2138 newid = V_policy_id = 1;
2140 newid = ++V_policy_id;
2141 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2142 if (sp->id == newid)
2148 if (count == 0 || newid == 0) {
2149 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2157 * SADB_SPDDELETE processing
2159 * <base, address(SD), policy(*)>
2160 * from the user(?), and set SADB_SASTATE_DEAD,
2162 * <base, address(SD), policy(*)>
2164 * policy(*) including direction of policy.
2166 * m will always be freed.
2169 key_spddelete(struct socket *so, struct mbuf *m,
2170 const struct sadb_msghdr *mhp)
2172 struct secpolicyindex spidx;
2173 struct sadb_address *src0, *dst0;
2174 struct sadb_x_policy *xpl0;
2175 struct secpolicy *sp;
2177 IPSEC_ASSERT(so != NULL, ("null so"));
2178 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2179 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2180 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2182 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2183 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2184 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2185 ipseclog((LOG_DEBUG,
2186 "%s: invalid message: missing required header.\n",
2188 return key_senderror(so, m, EINVAL);
2190 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2191 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2192 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2193 ipseclog((LOG_DEBUG,
2194 "%s: invalid message: wrong header size.\n", __func__));
2195 return key_senderror(so, m, EINVAL);
2198 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2199 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2200 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2202 /* check the direciton */
2203 switch (xpl0->sadb_x_policy_dir) {
2204 case IPSEC_DIR_INBOUND:
2205 case IPSEC_DIR_OUTBOUND:
2208 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2209 return key_senderror(so, m, EINVAL);
2211 /* Only DISCARD, NONE and IPSEC are allowed */
2212 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2213 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2214 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2215 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2216 return key_senderror(so, m, EINVAL);
2218 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2219 (struct sockaddr *)(dst0 + 1)) != 0 ||
2220 src0->sadb_address_proto != dst0->sadb_address_proto) {
2221 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2222 return key_senderror(so, m, EINVAL);
2225 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2228 src0->sadb_address_prefixlen,
2229 dst0->sadb_address_prefixlen,
2230 src0->sadb_address_proto,
2233 /* Is there SP in SPD ? */
2234 if ((sp = key_getsp(&spidx)) == NULL) {
2235 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2236 return key_senderror(so, m, EINVAL);
2239 /* save policy id to buffer to be returned. */
2240 xpl0->sadb_x_policy_id = sp->id;
2243 printf("%s: SP(%p)\n", __func__, sp));
2244 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2250 struct sadb_msg *newmsg;
2252 /* create new sadb_msg to reply. */
2253 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2254 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2256 return key_senderror(so, m, ENOBUFS);
2258 newmsg = mtod(n, struct sadb_msg *);
2259 newmsg->sadb_msg_errno = 0;
2260 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2263 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2268 * SADB_SPDDELETE2 processing
2271 * from the user(?), and set SADB_SASTATE_DEAD,
2275 * policy(*) including direction of policy.
2277 * m will always be freed.
2280 key_spddelete2(struct socket *so, struct mbuf *m,
2281 const struct sadb_msghdr *mhp)
2283 struct secpolicy *sp;
2286 IPSEC_ASSERT(so != NULL, ("null socket"));
2287 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2288 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2289 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2291 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2292 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2293 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2295 return key_senderror(so, m, EINVAL);
2298 id = ((struct sadb_x_policy *)
2299 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2301 /* Is there SP in SPD ? */
2302 if ((sp = key_getspbyid(id)) == NULL) {
2303 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2305 return key_senderror(so, m, EINVAL);
2309 printf("%s: SP(%p)\n", __func__, sp));
2310 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2312 if (sp->state != IPSEC_SPSTATE_DEAD) {
2313 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2316 return (key_senderror(so, m, EACCES));
2321 struct mbuf *n, *nn;
2322 struct sadb_msg *newmsg;
2325 /* create new sadb_msg to reply. */
2326 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2328 MGETHDR(n, M_NOWAIT, MT_DATA);
2329 if (n && len > MHLEN) {
2330 if (!(MCLGET(n, M_NOWAIT))) {
2336 return key_senderror(so, m, ENOBUFS);
2342 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2343 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2345 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2348 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2349 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2352 return key_senderror(so, m, ENOBUFS);
2355 n->m_pkthdr.len = 0;
2356 for (nn = n; nn; nn = nn->m_next)
2357 n->m_pkthdr.len += nn->m_len;
2359 newmsg = mtod(n, struct sadb_msg *);
2360 newmsg->sadb_msg_errno = 0;
2361 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2364 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2369 * SADB_X_SPDGET processing
2374 * <base, address(SD), policy>
2376 * policy(*) including direction of policy.
2378 * m will always be freed.
2381 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2383 struct secpolicy *sp;
2387 IPSEC_ASSERT(so != NULL, ("null socket"));
2388 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2389 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2390 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2392 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2393 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2394 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2396 return key_senderror(so, m, EINVAL);
2399 id = ((struct sadb_x_policy *)
2400 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2402 /* Is there SP in SPD ? */
2403 if ((sp = key_getspbyid(id)) == NULL) {
2404 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2406 return key_senderror(so, m, ENOENT);
2409 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2410 mhp->msg->sadb_msg_pid);
2414 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2416 return key_senderror(so, m, ENOBUFS);
2420 * SADB_X_SPDACQUIRE processing.
2421 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2424 * to KMD, and expect to receive
2425 * <base> with SADB_X_SPDACQUIRE if error occurred,
2428 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2429 * policy(*) is without policy requests.
2432 * others: error number
2435 key_spdacquire(struct secpolicy *sp)
2437 struct mbuf *result = NULL, *m;
2438 struct secspacq *newspacq;
2440 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2441 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2442 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2443 ("policy not IPSEC %u", sp->policy));
2445 /* Get an entry to check whether sent message or not. */
2446 newspacq = key_getspacq(&sp->spidx);
2447 if (newspacq != NULL) {
2448 if (V_key_blockacq_count < newspacq->count) {
2449 /* reset counter and do send message. */
2450 newspacq->count = 0;
2452 /* increment counter and do nothing. */
2459 /* make new entry for blocking to send SADB_ACQUIRE. */
2460 newspacq = key_newspacq(&sp->spidx);
2461 if (newspacq == NULL)
2465 /* create new sadb_msg to reply. */
2466 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2472 result->m_pkthdr.len = 0;
2473 for (m = result; m; m = m->m_next)
2474 result->m_pkthdr.len += m->m_len;
2476 mtod(result, struct sadb_msg *)->sadb_msg_len =
2477 PFKEY_UNIT64(result->m_pkthdr.len);
2479 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2483 * SADB_SPDFLUSH processing
2486 * from the user, and free all entries in secpctree.
2490 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2492 * m will always be freed.
2495 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2497 struct secpolicy_queue drainq;
2498 struct sadb_msg *newmsg;
2499 struct secpolicy *sp, *nextsp;
2502 IPSEC_ASSERT(so != NULL, ("null socket"));
2503 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2504 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2505 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2507 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2508 return key_senderror(so, m, EINVAL);
2510 TAILQ_INIT(&drainq);
2512 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2513 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2516 * We need to set state to DEAD for each policy to be sure,
2517 * that another thread won't try to unlink it.
2518 * Also remove SP from sphash.
2520 TAILQ_FOREACH(sp, &drainq, chain) {
2521 sp->state = IPSEC_SPSTATE_DEAD;
2522 LIST_REMOVE(sp, idhash);
2527 if (SPDCACHE_ENABLED())
2529 sp = TAILQ_FIRST(&drainq);
2530 while (sp != NULL) {
2531 nextsp = TAILQ_NEXT(sp, chain);
2536 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2537 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2538 return key_senderror(so, m, ENOBUFS);
2544 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2545 newmsg = mtod(m, struct sadb_msg *);
2546 newmsg->sadb_msg_errno = 0;
2547 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2549 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2553 key_satype2scopemask(uint8_t satype)
2556 if (satype == IPSEC_POLICYSCOPE_ANY)
2561 * SADB_SPDDUMP processing
2564 * from the user, and dump all SP leaves and send,
2569 * sadb_msg_satype is considered as mask of policy scopes.
2570 * m will always be freed.
2573 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2575 SPTREE_RLOCK_TRACKER;
2576 struct secpolicy *sp;
2581 IPSEC_ASSERT(so != NULL, ("null socket"));
2582 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2583 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2584 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2586 /* search SPD entry and get buffer size. */
2588 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2590 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2591 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2592 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2595 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2596 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2603 return key_senderror(so, m, ENOENT);
2606 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2607 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2608 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2610 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2611 mhp->msg->sadb_msg_pid);
2614 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2617 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2618 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2620 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2621 mhp->msg->sadb_msg_pid);
2624 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2634 static struct mbuf *
2635 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2638 struct mbuf *result = NULL, *m;
2639 struct seclifetime lt;
2641 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2646 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2647 &sp->spidx.src.sa, sp->spidx.prefs,
2648 sp->spidx.ul_proto);
2653 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2654 &sp->spidx.dst.sa, sp->spidx.prefd,
2655 sp->spidx.ul_proto);
2660 m = key_sp2mbuf(sp);
2666 lt.addtime=sp->created;
2667 lt.usetime= sp->lastused;
2668 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2673 lt.addtime=sp->lifetime;
2674 lt.usetime= sp->validtime;
2675 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2681 if ((result->m_flags & M_PKTHDR) == 0)
2684 if (result->m_len < sizeof(struct sadb_msg)) {
2685 result = m_pullup(result, sizeof(struct sadb_msg));
2690 result->m_pkthdr.len = 0;
2691 for (m = result; m; m = m->m_next)
2692 result->m_pkthdr.len += m->m_len;
2694 mtod(result, struct sadb_msg *)->sadb_msg_len =
2695 PFKEY_UNIT64(result->m_pkthdr.len);
2704 * get PFKEY message length for security policy and request.
2707 key_getspreqmsglen(struct secpolicy *sp)
2712 tlen = sizeof(struct sadb_x_policy);
2713 /* if is the policy for ipsec ? */
2714 if (sp->policy != IPSEC_POLICY_IPSEC)
2717 /* get length of ipsec requests */
2718 for (i = 0; i < sp->tcount; i++) {
2719 len = sizeof(struct sadb_x_ipsecrequest)
2720 + sp->req[i]->saidx.src.sa.sa_len
2721 + sp->req[i]->saidx.dst.sa.sa_len;
2723 tlen += PFKEY_ALIGN8(len);
2729 * SADB_SPDEXPIRE processing
2731 * <base, address(SD), lifetime(CH), policy>
2735 * others : error number
2738 key_spdexpire(struct secpolicy *sp)
2740 struct sadb_lifetime *lt;
2741 struct mbuf *result = NULL, *m;
2742 int len, error = -1;
2744 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2747 printf("%s: SP(%p)\n", __func__, sp));
2748 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2750 /* set msg header */
2751 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2758 /* create lifetime extension (current and hard) */
2759 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2760 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2767 bzero(mtod(m, caddr_t), len);
2768 lt = mtod(m, struct sadb_lifetime *);
2769 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2770 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2771 lt->sadb_lifetime_allocations = 0;
2772 lt->sadb_lifetime_bytes = 0;
2773 lt->sadb_lifetime_addtime = sp->created;
2774 lt->sadb_lifetime_usetime = sp->lastused;
2775 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2776 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2777 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2778 lt->sadb_lifetime_allocations = 0;
2779 lt->sadb_lifetime_bytes = 0;
2780 lt->sadb_lifetime_addtime = sp->lifetime;
2781 lt->sadb_lifetime_usetime = sp->validtime;
2784 /* set sadb_address for source */
2785 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2787 sp->spidx.prefs, sp->spidx.ul_proto);
2794 /* set sadb_address for destination */
2795 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2797 sp->spidx.prefd, sp->spidx.ul_proto);
2805 m = key_sp2mbuf(sp);
2812 if ((result->m_flags & M_PKTHDR) == 0) {
2817 if (result->m_len < sizeof(struct sadb_msg)) {
2818 result = m_pullup(result, sizeof(struct sadb_msg));
2819 if (result == NULL) {
2825 result->m_pkthdr.len = 0;
2826 for (m = result; m; m = m->m_next)
2827 result->m_pkthdr.len += m->m_len;
2829 mtod(result, struct sadb_msg *)->sadb_msg_len =
2830 PFKEY_UNIT64(result->m_pkthdr.len);
2832 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2840 /* %%% SAD management */
2842 * allocating and initialize new SA head.
2843 * OUT: NULL : failure due to the lack of memory.
2844 * others : pointer to new SA head.
2846 static struct secashead *
2847 key_newsah(struct secasindex *saidx)
2849 struct secashead *sah;
2851 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2854 PFKEYSTAT_INC(in_nomem);
2857 TAILQ_INIT(&sah->savtree_larval);
2858 TAILQ_INIT(&sah->savtree_alive);
2859 sah->saidx = *saidx;
2860 sah->state = SADB_SASTATE_DEAD;
2864 printf("%s: SAH(%p)\n", __func__, sah));
2865 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2870 key_freesah(struct secashead **psah)
2872 struct secashead *sah = *psah;
2874 if (SAH_DELREF(sah) == 0)
2878 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2879 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2886 key_delsah(struct secashead *sah)
2888 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2889 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2890 ("Attempt to free non DEAD SAH %p", sah));
2891 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2892 ("Attempt to free SAH %p with LARVAL SA", sah));
2893 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2894 ("Attempt to free SAH %p with ALIVE SA", sah));
2896 free(sah, M_IPSEC_SAH);
2900 * allocating a new SA for key_add() and key_getspi() call,
2901 * and copy the values of mhp into new buffer.
2902 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2903 * For SADB_ADD create and initialize SA with MATURE state.
2905 * others : pointer to new secasvar.
2907 static struct secasvar *
2908 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2909 uint32_t spi, int *errp)
2911 struct secashead *sah;
2912 struct secasvar *sav;
2915 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2916 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2917 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2918 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2922 /* check SPI value */
2923 switch (saidx->proto) {
2927 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2928 * 1-255 reserved by IANA for future use,
2929 * 0 for implementation specific, local use.
2931 if (ntohl(spi) <= 255) {
2932 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2933 __func__, ntohl(spi)));
2940 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2945 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2947 if (sav->lock == NULL) {
2951 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2952 sav->lft_c = uma_zalloc_pcpu(V_key_lft_zone, M_NOWAIT);
2953 if (sav->lft_c == NULL) {
2957 counter_u64_zero(sav->lft_c_allocations);
2958 counter_u64_zero(sav->lft_c_bytes);
2961 sav->seq = mhp->msg->sadb_msg_seq;
2962 sav->state = SADB_SASTATE_LARVAL;
2963 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2966 sah = key_getsah(saidx);
2968 /* create a new SA index */
2969 sah = key_newsah(saidx);
2971 ipseclog((LOG_DEBUG,
2972 "%s: No more memory.\n", __func__));
2981 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2982 sav->created = time_second;
2983 } else if (sav->state == SADB_SASTATE_LARVAL) {
2985 * Do not call key_setsaval() second time in case
2986 * of `goto again`. We will have MATURE state.
2988 *errp = key_setsaval(sav, mhp);
2991 sav->state = SADB_SASTATE_MATURE;
2996 * Check that existing SAH wasn't unlinked.
2997 * Since we didn't hold the SAHTREE lock, it is possible,
2998 * that callout handler or key_flush() or key_delete() could
3001 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
3003 key_freesah(&sah); /* reference from key_getsah() */
3008 * Add new SAH into SADB.
3010 * XXXAE: we can serialize key_add and key_getspi calls, so
3011 * several threads will not fight in the race.
3012 * Otherwise we should check under SAHTREE lock, that this
3013 * SAH would not added twice.
3015 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
3016 /* Add new SAH into hash by addresses */
3017 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
3018 /* Now we are linked in the chain */
3019 sah->state = SADB_SASTATE_MATURE;
3021 * SAV references this new SAH.
3022 * In case of existing SAH we reuse reference
3023 * from key_getsah().
3027 /* Link SAV with SAH */
3028 if (sav->state == SADB_SASTATE_MATURE)
3029 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
3031 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
3032 /* Add SAV into SPI hash */
3033 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
3035 *errp = 0; /* success */
3039 if (sav->lock != NULL) {
3040 mtx_destroy(sav->lock);
3041 free(sav->lock, M_IPSEC_MISC);
3043 if (sav->lft_c != NULL)
3044 uma_zfree_pcpu(V_key_lft_zone, sav->lft_c);
3045 free(sav, M_IPSEC_SA), sav = NULL;
3049 if (*errp == ENOBUFS) {
3050 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3052 PFKEYSTAT_INC(in_nomem);
3059 * free() SA variable entry.
3062 key_cleansav(struct secasvar *sav)
3065 if (sav->natt != NULL) {
3066 free(sav->natt, M_IPSEC_MISC);
3069 if (sav->flags & SADB_X_EXT_F_CLONED)
3072 * Cleanup xform state. Note that zeroize'ing causes the
3073 * keys to be cleared; otherwise we must do it ourself.
3075 if (sav->tdb_xform != NULL) {
3076 sav->tdb_xform->xf_zeroize(sav);
3077 sav->tdb_xform = NULL;
3079 if (sav->key_auth != NULL)
3080 bzero(sav->key_auth->key_data, _KEYLEN(sav->key_auth));
3081 if (sav->key_enc != NULL)
3082 bzero(sav->key_enc->key_data, _KEYLEN(sav->key_enc));
3084 if (sav->key_auth != NULL) {
3085 if (sav->key_auth->key_data != NULL)
3086 free(sav->key_auth->key_data, M_IPSEC_MISC);
3087 free(sav->key_auth, M_IPSEC_MISC);
3088 sav->key_auth = NULL;
3090 if (sav->key_enc != NULL) {
3091 if (sav->key_enc->key_data != NULL)
3092 free(sav->key_enc->key_data, M_IPSEC_MISC);
3093 free(sav->key_enc, M_IPSEC_MISC);
3094 sav->key_enc = NULL;
3096 if (sav->replay != NULL) {
3097 if (sav->replay->bitmap != NULL)
3098 free(sav->replay->bitmap, M_IPSEC_MISC);
3099 free(sav->replay, M_IPSEC_MISC);
3102 if (sav->lft_h != NULL) {
3103 free(sav->lft_h, M_IPSEC_MISC);
3106 if (sav->lft_s != NULL) {
3107 free(sav->lft_s, M_IPSEC_MISC);
3113 * free() SA variable entry.
3116 key_delsav(struct secasvar *sav)
3118 IPSEC_ASSERT(sav != NULL, ("null sav"));
3119 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
3120 ("attempt to free non DEAD SA %p", sav));
3121 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
3125 * SA must be unlinked from the chain and hashtbl.
3126 * If SA was cloned, we leave all fields untouched,
3127 * except NAT-T config.
3130 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
3131 mtx_destroy(sav->lock);
3132 free(sav->lock, M_IPSEC_MISC);
3133 uma_zfree_pcpu(V_key_lft_zone, sav->lft_c);
3135 free(sav, M_IPSEC_SA);
3142 * others : found, referenced pointer to a SAH.
3144 static struct secashead *
3145 key_getsah(struct secasindex *saidx)
3147 SAHTREE_RLOCK_TRACKER;
3148 struct secashead *sah;
3151 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3152 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3162 * Check not to be duplicated SPI.
3165 * 1 : found SA with given SPI.
3168 key_checkspidup(uint32_t spi)
3170 SAHTREE_RLOCK_TRACKER;
3171 struct secasvar *sav;
3173 /* Assume SPI is in network byte order */
3175 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3176 if (sav->spi == spi)
3180 return (sav != NULL);
3187 * others : found, referenced pointer to a SA.
3189 static struct secasvar *
3190 key_getsavbyspi(uint32_t spi)
3192 SAHTREE_RLOCK_TRACKER;
3193 struct secasvar *sav;
3195 /* Assume SPI is in network byte order */
3197 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3198 if (sav->spi != spi)
3208 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3210 struct seclifetime *lft_h, *lft_s, *tmp;
3212 /* Lifetime extension is optional, check that it is present. */
3213 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3214 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3216 * In case of SADB_UPDATE we may need to change
3217 * existing lifetimes.
3219 if (sav->state == SADB_SASTATE_MATURE) {
3220 lft_h = lft_s = NULL;
3225 /* Both HARD and SOFT extensions must present */
3226 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3227 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3228 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3229 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3230 ipseclog((LOG_DEBUG,
3231 "%s: invalid message: missing required header.\n",
3235 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3236 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3237 ipseclog((LOG_DEBUG,
3238 "%s: invalid message: wrong header size.\n", __func__));
3241 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3242 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3243 if (lft_h == NULL) {
3244 PFKEYSTAT_INC(in_nomem);
3245 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3248 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3249 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3250 if (lft_s == NULL) {
3251 PFKEYSTAT_INC(in_nomem);
3252 free(lft_h, M_IPSEC_MISC);
3253 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3257 if (sav->state != SADB_SASTATE_LARVAL) {
3259 * key_update() holds reference to this SA,
3260 * so it won't be deleted in meanwhile.
3270 SECASVAR_UNLOCK(sav);
3272 free(lft_h, M_IPSEC_MISC);
3274 free(lft_s, M_IPSEC_MISC);
3277 /* We can update lifetime without holding a lock */
3278 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3279 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3286 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3287 * You must update these if need. Expects only LARVAL SAs.
3292 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3294 const struct sadb_sa *sa0;
3295 const struct sadb_key *key0;
3300 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3301 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3302 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3303 ("Attempt to update non LARVAL SA"));
3306 error = key_setident(sav->sah, mhp);
3311 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3312 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3316 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3317 sav->alg_auth = sa0->sadb_sa_auth;
3318 sav->alg_enc = sa0->sadb_sa_encrypt;
3319 sav->flags = sa0->sadb_sa_flags;
3320 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3321 ipseclog((LOG_DEBUG,
3322 "%s: invalid sa_flags 0x%08x.\n", __func__,
3328 /* Optional replay window */
3330 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3331 replay = sa0->sadb_sa_replay;
3332 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3333 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3337 replay = ((const struct sadb_x_sa_replay *)
3338 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3340 if (replay > UINT32_MAX - 32) {
3341 ipseclog((LOG_DEBUG,
3342 "%s: replay window too big.\n", __func__));
3347 replay = (replay + 7) >> 3;
3350 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3352 if (sav->replay == NULL) {
3353 PFKEYSTAT_INC(in_nomem);
3354 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3361 /* number of 32b blocks to be allocated */
3362 uint32_t bitmap_size;
3365 * - the allocated replay window size must be
3367 * - use an extra 32b block as a redundant window.
3370 while (replay + 4 > bitmap_size)
3372 bitmap_size = bitmap_size / 4;
3374 sav->replay->bitmap = malloc(
3375 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3377 if (sav->replay->bitmap == NULL) {
3378 PFKEYSTAT_INC(in_nomem);
3379 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3384 sav->replay->bitmap_size = bitmap_size;
3385 sav->replay->wsize = replay;
3389 /* Authentication keys */
3390 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3391 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3396 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3397 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3398 switch (mhp->msg->sadb_msg_satype) {
3399 case SADB_SATYPE_AH:
3400 case SADB_SATYPE_ESP:
3401 case SADB_X_SATYPE_TCPSIGNATURE:
3402 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3403 sav->alg_auth != SADB_X_AALG_NULL)
3406 case SADB_X_SATYPE_IPCOMP:
3412 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3417 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3418 if (sav->key_auth == NULL ) {
3419 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3421 PFKEYSTAT_INC(in_nomem);
3427 /* Encryption key */
3428 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3429 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3434 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3435 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3436 switch (mhp->msg->sadb_msg_satype) {
3437 case SADB_SATYPE_ESP:
3438 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3439 sav->alg_enc != SADB_EALG_NULL) {
3443 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3444 if (sav->key_enc == NULL) {
3445 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3447 PFKEYSTAT_INC(in_nomem);
3452 case SADB_X_SATYPE_IPCOMP:
3453 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3455 sav->key_enc = NULL; /*just in case*/
3457 case SADB_SATYPE_AH:
3458 case SADB_X_SATYPE_TCPSIGNATURE:
3464 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3472 switch (mhp->msg->sadb_msg_satype) {
3473 case SADB_SATYPE_AH:
3474 if (sav->flags & SADB_X_EXT_DERIV) {
3475 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3476 "given to AH SA.\n", __func__));
3480 if (sav->alg_enc != SADB_EALG_NONE) {
3481 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3482 "mismated.\n", __func__));
3486 error = xform_init(sav, XF_AH);
3488 case SADB_SATYPE_ESP:
3489 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3490 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3491 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3492 "given to old-esp.\n", __func__));
3496 error = xform_init(sav, XF_ESP);
3498 case SADB_X_SATYPE_IPCOMP:
3499 if (sav->alg_auth != SADB_AALG_NONE) {
3500 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3501 "mismated.\n", __func__));
3505 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3506 ntohl(sav->spi) >= 0x10000) {
3507 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3512 error = xform_init(sav, XF_IPCOMP);
3514 case SADB_X_SATYPE_TCPSIGNATURE:
3515 if (sav->alg_enc != SADB_EALG_NONE) {
3516 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3517 "mismated.\n", __func__));
3521 error = xform_init(sav, XF_TCPSIGNATURE);
3524 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3525 error = EPROTONOSUPPORT;
3529 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3530 __func__, mhp->msg->sadb_msg_satype));
3534 /* Handle NAT-T headers */
3535 error = key_setnatt(sav, mhp);
3539 /* Initialize lifetime for CURRENT */
3541 sav->created = time_second;
3543 /* lifetimes for HARD and SOFT */
3544 error = key_updatelifetimes(sav, mhp);
3553 * subroutine for SADB_GET and SADB_DUMP.
3555 static struct mbuf *
3556 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3557 uint32_t seq, uint32_t pid)
3559 struct seclifetime lft_c;
3560 struct mbuf *result = NULL, *tres = NULL, *m;
3561 int i, dumporder[] = {
3562 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3563 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3564 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3565 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3566 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3567 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3568 SADB_EXT_SENSITIVITY,
3569 SADB_X_EXT_NAT_T_TYPE,
3570 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3571 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3572 SADB_X_EXT_NAT_T_FRAG,
3574 uint32_t replay_count;
3576 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3581 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3583 switch (dumporder[i]) {
3585 m = key_setsadbsa(sav);
3590 case SADB_X_EXT_SA2:
3592 replay_count = sav->replay ? sav->replay->count : 0;
3593 SECASVAR_UNLOCK(sav);
3594 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3595 sav->sah->saidx.reqid);
3600 case SADB_X_EXT_SA_REPLAY:
3601 if (sav->replay == NULL ||
3602 sav->replay->wsize <= UINT8_MAX)
3605 m = key_setsadbxsareplay(sav->replay->wsize);
3610 case SADB_EXT_ADDRESS_SRC:
3611 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3612 &sav->sah->saidx.src.sa,
3613 FULLMASK, IPSEC_ULPROTO_ANY);
3618 case SADB_EXT_ADDRESS_DST:
3619 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3620 &sav->sah->saidx.dst.sa,
3621 FULLMASK, IPSEC_ULPROTO_ANY);
3626 case SADB_EXT_KEY_AUTH:
3629 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3634 case SADB_EXT_KEY_ENCRYPT:
3637 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3642 case SADB_EXT_LIFETIME_CURRENT:
3643 lft_c.addtime = sav->created;
3644 lft_c.allocations = (uint32_t)counter_u64_fetch(
3645 sav->lft_c_allocations);
3646 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3647 lft_c.usetime = sav->firstused;
3648 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3653 case SADB_EXT_LIFETIME_HARD:
3656 m = key_setlifetime(sav->lft_h,
3657 SADB_EXT_LIFETIME_HARD);
3662 case SADB_EXT_LIFETIME_SOFT:
3665 m = key_setlifetime(sav->lft_s,
3666 SADB_EXT_LIFETIME_SOFT);
3672 case SADB_X_EXT_NAT_T_TYPE:
3673 if (sav->natt == NULL)
3675 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3680 case SADB_X_EXT_NAT_T_DPORT:
3681 if (sav->natt == NULL)
3683 m = key_setsadbxport(sav->natt->dport,
3684 SADB_X_EXT_NAT_T_DPORT);
3689 case SADB_X_EXT_NAT_T_SPORT:
3690 if (sav->natt == NULL)
3692 m = key_setsadbxport(sav->natt->sport,
3693 SADB_X_EXT_NAT_T_SPORT);
3698 case SADB_X_EXT_NAT_T_OAI:
3699 if (sav->natt == NULL ||
3700 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3702 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3703 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3707 case SADB_X_EXT_NAT_T_OAR:
3708 if (sav->natt == NULL ||
3709 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3711 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3712 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3716 case SADB_X_EXT_NAT_T_FRAG:
3717 /* We do not (yet) support those. */
3720 case SADB_EXT_ADDRESS_PROXY:
3721 case SADB_EXT_IDENTITY_SRC:
3722 case SADB_EXT_IDENTITY_DST:
3723 /* XXX: should we brought from SPD ? */
3724 case SADB_EXT_SENSITIVITY:
3736 m_cat(result, tres);
3738 if (result->m_len < sizeof(struct sadb_msg)) {
3739 result = m_pullup(result, sizeof(struct sadb_msg));
3744 result->m_pkthdr.len = 0;
3745 for (m = result; m; m = m->m_next)
3746 result->m_pkthdr.len += m->m_len;
3748 mtod(result, struct sadb_msg *)->sadb_msg_len =
3749 PFKEY_UNIT64(result->m_pkthdr.len);
3760 * set data into sadb_msg.
3762 static struct mbuf *
3763 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3764 pid_t pid, u_int16_t reserved)
3770 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3773 MGETHDR(m, M_NOWAIT, MT_DATA);
3774 if (m && len > MHLEN) {
3775 if (!(MCLGET(m, M_NOWAIT))) {
3782 m->m_pkthdr.len = m->m_len = len;
3785 p = mtod(m, struct sadb_msg *);
3788 p->sadb_msg_version = PF_KEY_V2;
3789 p->sadb_msg_type = type;
3790 p->sadb_msg_errno = 0;
3791 p->sadb_msg_satype = satype;
3792 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3793 p->sadb_msg_reserved = reserved;
3794 p->sadb_msg_seq = seq;
3795 p->sadb_msg_pid = (u_int32_t)pid;
3801 * copy secasvar data into sadb_address.
3803 static struct mbuf *
3804 key_setsadbsa(struct secasvar *sav)
3810 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3811 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3816 p = mtod(m, struct sadb_sa *);
3818 p->sadb_sa_len = PFKEY_UNIT64(len);
3819 p->sadb_sa_exttype = SADB_EXT_SA;
3820 p->sadb_sa_spi = sav->spi;
3821 p->sadb_sa_replay = sav->replay ?
3822 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3823 sav->replay->wsize): 0;
3824 p->sadb_sa_state = sav->state;
3825 p->sadb_sa_auth = sav->alg_auth;
3826 p->sadb_sa_encrypt = sav->alg_enc;
3827 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3832 * set data into sadb_address.
3834 static struct mbuf *
3835 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3836 u_int8_t prefixlen, u_int16_t ul_proto)
3839 struct sadb_address *p;
3842 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3843 PFKEY_ALIGN8(saddr->sa_len);
3844 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3849 p = mtod(m, struct sadb_address *);
3852 p->sadb_address_len = PFKEY_UNIT64(len);
3853 p->sadb_address_exttype = exttype;
3854 p->sadb_address_proto = ul_proto;
3855 if (prefixlen == FULLMASK) {
3856 switch (saddr->sa_family) {
3858 prefixlen = sizeof(struct in_addr) << 3;
3861 prefixlen = sizeof(struct in6_addr) << 3;
3867 p->sadb_address_prefixlen = prefixlen;
3868 p->sadb_address_reserved = 0;
3871 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3878 * set data into sadb_x_sa2.
3880 static struct mbuf *
3881 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3884 struct sadb_x_sa2 *p;
3887 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3888 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3893 p = mtod(m, struct sadb_x_sa2 *);
3896 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3897 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3898 p->sadb_x_sa2_mode = mode;
3899 p->sadb_x_sa2_reserved1 = 0;
3900 p->sadb_x_sa2_reserved2 = 0;
3901 p->sadb_x_sa2_sequence = seq;
3902 p->sadb_x_sa2_reqid = reqid;
3908 * Set data into sadb_x_sa_replay.
3910 static struct mbuf *
3911 key_setsadbxsareplay(u_int32_t replay)
3914 struct sadb_x_sa_replay *p;
3917 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3918 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3923 p = mtod(m, struct sadb_x_sa_replay *);
3926 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3927 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3928 p->sadb_x_sa_replay_replay = (replay << 3);
3934 * Set a type in sadb_x_nat_t_type.
3936 static struct mbuf *
3937 key_setsadbxtype(u_int16_t type)
3941 struct sadb_x_nat_t_type *p;
3943 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3945 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3950 p = mtod(m, struct sadb_x_nat_t_type *);
3953 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3954 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3955 p->sadb_x_nat_t_type_type = type;
3960 * Set a port in sadb_x_nat_t_port.
3961 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3963 static struct mbuf *
3964 key_setsadbxport(u_int16_t port, u_int16_t type)
3968 struct sadb_x_nat_t_port *p;
3970 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3972 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3977 p = mtod(m, struct sadb_x_nat_t_port *);
3980 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3981 p->sadb_x_nat_t_port_exttype = type;
3982 p->sadb_x_nat_t_port_port = port;
3988 * Get port from sockaddr. Port is in network byte order.
3991 key_portfromsaddr(struct sockaddr *sa)
3994 switch (sa->sa_family) {
3997 return ((struct sockaddr_in *)sa)->sin_port;
4001 return ((struct sockaddr_in6 *)sa)->sin6_port;
4008 * Set port in struct sockaddr. Port is in network byte order.
4011 key_porttosaddr(struct sockaddr *sa, uint16_t port)
4014 switch (sa->sa_family) {
4017 ((struct sockaddr_in *)sa)->sin_port = port;
4022 ((struct sockaddr_in6 *)sa)->sin6_port = port;
4026 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
4027 __func__, sa->sa_family));
4033 * set data into sadb_x_policy
4035 static struct mbuf *
4036 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
4039 struct sadb_x_policy *p;
4042 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
4043 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
4048 p = mtod(m, struct sadb_x_policy *);
4051 p->sadb_x_policy_len = PFKEY_UNIT64(len);
4052 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
4053 p->sadb_x_policy_type = type;
4054 p->sadb_x_policy_dir = dir;
4055 p->sadb_x_policy_id = id;
4056 p->sadb_x_policy_priority = priority;
4062 /* Take a key message (sadb_key) from the socket and turn it into one
4063 * of the kernel's key structures (seckey).
4065 * IN: pointer to the src
4066 * OUT: NULL no more memory
4069 key_dup_keymsg(const struct sadb_key *src, size_t len,
4070 struct malloc_type *type)
4074 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4076 dst->bits = src->sadb_key_bits;
4077 dst->key_data = malloc(len, type, M_NOWAIT);
4078 if (dst->key_data != NULL) {
4079 bcopy((const char *)(src + 1), dst->key_data, len);
4081 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4087 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4094 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
4095 * turn it into one of the kernel's lifetime structures (seclifetime).
4097 * IN: pointer to the destination, source and malloc type
4098 * OUT: NULL, no more memory
4101 static struct seclifetime *
4102 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
4104 struct seclifetime *dst;
4106 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4108 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
4111 dst->allocations = src->sadb_lifetime_allocations;
4112 dst->bytes = src->sadb_lifetime_bytes;
4113 dst->addtime = src->sadb_lifetime_addtime;
4114 dst->usetime = src->sadb_lifetime_usetime;
4119 * compare two secasindex structure.
4120 * flag can specify to compare 2 saidxes.
4121 * compare two secasindex structure without both mode and reqid.
4122 * don't compare port.
4124 * saidx0: source, it can be in SAD.
4131 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4136 if (saidx0 == NULL && saidx1 == NULL)
4139 if (saidx0 == NULL || saidx1 == NULL)
4142 if (saidx0->proto != saidx1->proto)
4145 if (flag == CMP_EXACTLY) {
4146 if (saidx0->mode != saidx1->mode)
4148 if (saidx0->reqid != saidx1->reqid)
4150 if (bcmp(&saidx0->src, &saidx1->src,
4151 saidx0->src.sa.sa_len) != 0 ||
4152 bcmp(&saidx0->dst, &saidx1->dst,
4153 saidx0->dst.sa.sa_len) != 0)
4157 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4158 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4160 * If reqid of SPD is non-zero, unique SA is required.
4161 * The result must be of same reqid in this case.
4163 if (saidx1->reqid != 0 &&
4164 saidx0->reqid != saidx1->reqid)
4168 if (flag == CMP_MODE_REQID) {
4169 if (saidx0->mode != IPSEC_MODE_ANY
4170 && saidx0->mode != saidx1->mode)
4174 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4176 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4184 * compare two secindex structure exactly.
4186 * spidx0: source, it is often in SPD.
4187 * spidx1: object, it is often from PFKEY message.
4193 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4194 struct secpolicyindex *spidx1)
4197 if (spidx0 == NULL && spidx1 == NULL)
4200 if (spidx0 == NULL || spidx1 == NULL)
4203 if (spidx0->prefs != spidx1->prefs
4204 || spidx0->prefd != spidx1->prefd
4205 || spidx0->ul_proto != spidx1->ul_proto
4206 || spidx0->dir != spidx1->dir)
4209 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4210 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4214 * compare two secindex structure with mask.
4216 * spidx0: source, it is often in SPD.
4217 * spidx1: object, it is often from IP header.
4223 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4224 struct secpolicyindex *spidx1)
4227 if (spidx0 == NULL && spidx1 == NULL)
4230 if (spidx0 == NULL || spidx1 == NULL)
4233 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4234 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4235 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4236 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4239 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4240 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4241 && spidx0->ul_proto != spidx1->ul_proto)
4244 switch (spidx0->src.sa.sa_family) {
4246 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4247 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4249 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4250 &spidx1->src.sin.sin_addr, spidx0->prefs))
4254 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4255 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4258 * scope_id check. if sin6_scope_id is 0, we regard it
4259 * as a wildcard scope, which matches any scope zone ID.
4261 if (spidx0->src.sin6.sin6_scope_id &&
4262 spidx1->src.sin6.sin6_scope_id &&
4263 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4265 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4266 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4271 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4276 switch (spidx0->dst.sa.sa_family) {
4278 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4279 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4281 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4282 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4286 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4287 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4290 * scope_id check. if sin6_scope_id is 0, we regard it
4291 * as a wildcard scope, which matches any scope zone ID.
4293 if (spidx0->dst.sin6.sin6_scope_id &&
4294 spidx1->dst.sin6.sin6_scope_id &&
4295 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4297 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4298 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4303 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4308 /* XXX Do we check other field ? e.g. flowinfo */
4316 #define satosin(s) ((const struct sockaddr_in *)s)
4320 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4321 /* returns 0 on match */
4323 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4326 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4329 switch (sa1->sa_family) {
4332 if (sa1->sa_len != sizeof(struct sockaddr_in))
4334 if (satosin(sa1)->sin_addr.s_addr !=
4335 satosin(sa2)->sin_addr.s_addr) {
4338 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4344 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4345 return 1; /*EINVAL*/
4346 if (satosin6(sa1)->sin6_scope_id !=
4347 satosin6(sa2)->sin6_scope_id) {
4350 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4351 &satosin6(sa2)->sin6_addr)) {
4355 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4361 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4369 /* returns 0 on match */
4371 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4372 const struct sockaddr *sa2, size_t mask)
4374 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4377 switch (sa1->sa_family) {
4380 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4381 &satosin(sa2)->sin_addr, mask));
4385 if (satosin6(sa1)->sin6_scope_id !=
4386 satosin6(sa2)->sin6_scope_id)
4388 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4389 &satosin6(sa2)->sin6_addr, mask));
4398 * compare two buffers with mask.
4402 * bits: Number of bits to compare
4408 key_bbcmp(const void *a1, const void *a2, u_int bits)
4410 const unsigned char *p1 = a1;
4411 const unsigned char *p2 = a2;
4413 /* XXX: This could be considerably faster if we compare a word
4414 * at a time, but it is complicated on LSB Endian machines */
4416 /* Handle null pointers */
4417 if (p1 == NULL || p2 == NULL)
4427 u_int8_t mask = ~((1<<(8-bits))-1);
4428 if ((*p1 & mask) != (*p2 & mask))
4431 return 1; /* Match! */
4435 key_flush_spd(time_t now)
4437 SPTREE_RLOCK_TRACKER;
4438 struct secpolicy_list drainq;
4439 struct secpolicy *sp, *nextsp;
4444 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4445 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4446 if (sp->lifetime == 0 && sp->validtime == 0)
4448 if ((sp->lifetime &&
4449 now - sp->created > sp->lifetime) ||
4451 now - sp->lastused > sp->validtime)) {
4452 /* Hold extra reference to send SPDEXPIRE */
4454 LIST_INSERT_HEAD(&drainq, sp, drainq);
4459 if (LIST_EMPTY(&drainq))
4463 sp = LIST_FIRST(&drainq);
4464 while (sp != NULL) {
4465 nextsp = LIST_NEXT(sp, drainq);
4466 /* Check that SP is still linked */
4467 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4468 LIST_REMOVE(sp, drainq);
4469 key_freesp(&sp); /* release extra reference */
4473 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4475 LIST_REMOVE(sp, idhash);
4476 sp->state = IPSEC_SPSTATE_DEAD;
4481 if (SPDCACHE_ENABLED())
4484 sp = LIST_FIRST(&drainq);
4485 while (sp != NULL) {
4486 nextsp = LIST_NEXT(sp, drainq);
4488 key_freesp(&sp); /* release extra reference */
4489 key_freesp(&sp); /* release last reference */
4495 key_flush_sad(time_t now)
4497 SAHTREE_RLOCK_TRACKER;
4498 struct secashead_list emptyq;
4499 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4500 struct secashead *sah, *nextsah;
4501 struct secasvar *sav, *nextsav;
4504 LIST_INIT(&hexpireq);
4505 LIST_INIT(&sexpireq);
4509 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4510 /* Check for empty SAH */
4511 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4512 TAILQ_EMPTY(&sah->savtree_alive)) {
4514 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4517 /* Add all stale LARVAL SAs into drainq */
4518 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4519 if (now - sav->created < V_key_larval_lifetime)
4522 LIST_INSERT_HEAD(&drainq, sav, drainq);
4524 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4525 /* lifetimes aren't specified */
4526 if (sav->lft_h == NULL)
4530 * Check again with lock held, because it may
4531 * be updated by SADB_UPDATE.
4533 if (sav->lft_h == NULL) {
4534 SECASVAR_UNLOCK(sav);
4539 * HARD lifetimes MUST take precedence over SOFT
4540 * lifetimes, meaning if the HARD and SOFT lifetimes
4541 * are the same, the HARD lifetime will appear on the
4544 /* check HARD lifetime */
4545 if ((sav->lft_h->addtime != 0 &&
4546 now - sav->created > sav->lft_h->addtime) ||
4547 (sav->lft_h->usetime != 0 && sav->firstused &&
4548 now - sav->firstused > sav->lft_h->usetime) ||
4549 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4550 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4551 SECASVAR_UNLOCK(sav);
4553 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4556 /* check SOFT lifetime (only for MATURE SAs) */
4557 if (sav->state == SADB_SASTATE_MATURE && (
4558 (sav->lft_s->addtime != 0 &&
4559 now - sav->created > sav->lft_s->addtime) ||
4560 (sav->lft_s->usetime != 0 && sav->firstused &&
4561 now - sav->firstused > sav->lft_s->usetime) ||
4562 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4563 sav->lft_c_bytes) > sav->lft_s->bytes))) {
4564 SECASVAR_UNLOCK(sav);
4566 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4569 SECASVAR_UNLOCK(sav);
4574 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4575 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4580 /* Unlink stale LARVAL SAs */
4581 sav = LIST_FIRST(&drainq);
4582 while (sav != NULL) {
4583 nextsav = LIST_NEXT(sav, drainq);
4584 /* Check that SA is still LARVAL */
4585 if (sav->state != SADB_SASTATE_LARVAL) {
4586 LIST_REMOVE(sav, drainq);
4587 LIST_INSERT_HEAD(&freeq, sav, drainq);
4591 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4592 LIST_REMOVE(sav, spihash);
4593 sav->state = SADB_SASTATE_DEAD;
4596 /* Unlink all SAs with expired HARD lifetime */
4597 sav = LIST_FIRST(&hexpireq);
4598 while (sav != NULL) {
4599 nextsav = LIST_NEXT(sav, drainq);
4600 /* Check that SA is not unlinked */
4601 if (sav->state == SADB_SASTATE_DEAD) {
4602 LIST_REMOVE(sav, drainq);
4603 LIST_INSERT_HEAD(&freeq, sav, drainq);
4607 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4608 LIST_REMOVE(sav, spihash);
4609 sav->state = SADB_SASTATE_DEAD;
4612 /* Mark all SAs with expired SOFT lifetime as DYING */
4613 sav = LIST_FIRST(&sexpireq);
4614 while (sav != NULL) {
4615 nextsav = LIST_NEXT(sav, drainq);
4616 /* Check that SA is not unlinked */
4617 if (sav->state == SADB_SASTATE_DEAD) {
4618 LIST_REMOVE(sav, drainq);
4619 LIST_INSERT_HEAD(&freeq, sav, drainq);
4624 * NOTE: this doesn't change SA order in the chain.
4626 sav->state = SADB_SASTATE_DYING;
4629 /* Unlink empty SAHs */
4630 sah = LIST_FIRST(&emptyq);
4631 while (sah != NULL) {
4632 nextsah = LIST_NEXT(sah, drainq);
4633 /* Check that SAH is still empty and not unlinked */
4634 if (sah->state == SADB_SASTATE_DEAD ||
4635 !TAILQ_EMPTY(&sah->savtree_larval) ||
4636 !TAILQ_EMPTY(&sah->savtree_alive)) {
4637 LIST_REMOVE(sah, drainq);
4638 key_freesah(&sah); /* release extra reference */
4642 TAILQ_REMOVE(&V_sahtree, sah, chain);
4643 LIST_REMOVE(sah, addrhash);
4644 sah->state = SADB_SASTATE_DEAD;
4649 /* Send SPDEXPIRE messages */
4650 sav = LIST_FIRST(&hexpireq);
4651 while (sav != NULL) {
4652 nextsav = LIST_NEXT(sav, drainq);
4654 key_freesah(&sav->sah); /* release reference from SAV */
4655 key_freesav(&sav); /* release extra reference */
4656 key_freesav(&sav); /* release last reference */
4659 sav = LIST_FIRST(&sexpireq);
4660 while (sav != NULL) {
4661 nextsav = LIST_NEXT(sav, drainq);
4663 key_freesav(&sav); /* release extra reference */
4666 /* Free stale LARVAL SAs */
4667 sav = LIST_FIRST(&drainq);
4668 while (sav != NULL) {
4669 nextsav = LIST_NEXT(sav, drainq);
4670 key_freesah(&sav->sah); /* release reference from SAV */
4671 key_freesav(&sav); /* release extra reference */
4672 key_freesav(&sav); /* release last reference */
4675 /* Free SAs that were unlinked/changed by someone else */
4676 sav = LIST_FIRST(&freeq);
4677 while (sav != NULL) {
4678 nextsav = LIST_NEXT(sav, drainq);
4679 key_freesav(&sav); /* release extra reference */
4682 /* Free empty SAH */
4683 sah = LIST_FIRST(&emptyq);
4684 while (sah != NULL) {
4685 nextsah = LIST_NEXT(sah, drainq);
4686 key_freesah(&sah); /* release extra reference */
4687 key_freesah(&sah); /* release last reference */
4693 key_flush_acq(time_t now)
4695 struct secacq *acq, *nextacq;
4699 acq = LIST_FIRST(&V_acqtree);
4700 while (acq != NULL) {
4701 nextacq = LIST_NEXT(acq, chain);
4702 if (now - acq->created > V_key_blockacq_lifetime) {
4703 LIST_REMOVE(acq, chain);
4704 LIST_REMOVE(acq, addrhash);
4705 LIST_REMOVE(acq, seqhash);
4706 free(acq, M_IPSEC_SAQ);
4714 key_flush_spacq(time_t now)
4716 struct secspacq *acq, *nextacq;
4720 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4721 nextacq = LIST_NEXT(acq, chain);
4722 if (now - acq->created > V_key_blockacq_lifetime
4723 && __LIST_CHAINED(acq)) {
4724 LIST_REMOVE(acq, chain);
4725 free(acq, M_IPSEC_SAQ);
4733 * scanning SPD and SAD to check status for each entries,
4734 * and do to remove or to expire.
4735 * XXX: year 2038 problem may remain.
4738 key_timehandler(void *arg)
4740 VNET_ITERATOR_DECL(vnet_iter);
4741 time_t now = time_second;
4743 VNET_LIST_RLOCK_NOSLEEP();
4744 VNET_FOREACH(vnet_iter) {
4745 CURVNET_SET(vnet_iter);
4749 key_flush_spacq(now);
4752 VNET_LIST_RUNLOCK_NOSLEEP();
4754 #ifndef IPSEC_DEBUG2
4755 /* do exchange to tick time !! */
4756 callout_schedule(&key_timer, hz);
4757 #endif /* IPSEC_DEBUG2 */
4765 arc4random_buf(&value, sizeof(value));
4770 * map SADB_SATYPE_* to IPPROTO_*.
4771 * if satype == SADB_SATYPE then satype is mapped to ~0.
4773 * 0: invalid satype.
4776 key_satype2proto(uint8_t satype)
4779 case SADB_SATYPE_UNSPEC:
4780 return IPSEC_PROTO_ANY;
4781 case SADB_SATYPE_AH:
4783 case SADB_SATYPE_ESP:
4785 case SADB_X_SATYPE_IPCOMP:
4786 return IPPROTO_IPCOMP;
4787 case SADB_X_SATYPE_TCPSIGNATURE:
4796 * map IPPROTO_* to SADB_SATYPE_*
4798 * 0: invalid protocol type.
4801 key_proto2satype(uint8_t proto)
4805 return SADB_SATYPE_AH;
4807 return SADB_SATYPE_ESP;
4808 case IPPROTO_IPCOMP:
4809 return SADB_X_SATYPE_IPCOMP;
4811 return SADB_X_SATYPE_TCPSIGNATURE;
4820 * SADB_GETSPI processing is to receive
4821 * <base, (SA2), src address, dst address, (SPI range)>
4822 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4823 * tree with the status of LARVAL, and send
4824 * <base, SA(*), address(SD)>
4827 * IN: mhp: pointer to the pointer to each header.
4828 * OUT: NULL if fail.
4829 * other if success, return pointer to the message to send.
4832 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4834 struct secasindex saidx;
4835 struct sadb_address *src0, *dst0;
4836 struct secasvar *sav;
4837 uint32_t reqid, spi;
4839 uint8_t mode, proto;
4841 IPSEC_ASSERT(so != NULL, ("null socket"));
4842 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4843 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4844 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4846 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4847 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4848 #ifdef PFKEY_STRICT_CHECKS
4849 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4852 ipseclog((LOG_DEBUG,
4853 "%s: invalid message: missing required header.\n",
4858 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4859 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4860 #ifdef PFKEY_STRICT_CHECKS
4861 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4864 ipseclog((LOG_DEBUG,
4865 "%s: invalid message: wrong header size.\n", __func__));
4869 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4870 mode = IPSEC_MODE_ANY;
4873 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4874 ipseclog((LOG_DEBUG,
4875 "%s: invalid message: wrong header size.\n",
4880 mode = ((struct sadb_x_sa2 *)
4881 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4882 reqid = ((struct sadb_x_sa2 *)
4883 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4886 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4887 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4889 /* map satype to proto */
4890 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4891 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4896 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4897 (struct sockaddr *)(dst0 + 1));
4899 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4903 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4905 /* SPI allocation */
4906 spi = key_do_getnewspi(
4907 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4910 * Requested SPI or SPI range is not available or
4916 sav = key_newsav(mhp, &saidx, spi, &error);
4920 if (sav->seq != 0) {
4923 * If the SADB_GETSPI message is in response to a
4924 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4925 * MUST be the same as the SADB_ACQUIRE message.
4927 * XXXAE: However it doesn't definethe behaviour how to
4928 * check this and what to do if it doesn't match.
4929 * Also what we should do if it matches?
4931 * We can compare saidx used in SADB_ACQUIRE with saidx
4932 * used in SADB_GETSPI, but this probably can break
4933 * existing software. For now just warn if it doesn't match.
4935 * XXXAE: anyway it looks useless.
4937 key_acqdone(&saidx, sav->seq);
4940 printf("%s: SA(%p)\n", __func__, sav));
4941 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4944 struct mbuf *n, *nn;
4945 struct sadb_sa *m_sa;
4946 struct sadb_msg *newmsg;
4949 /* create new sadb_msg to reply. */
4950 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4951 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4953 MGETHDR(n, M_NOWAIT, MT_DATA);
4955 if (!(MCLGET(n, M_NOWAIT))) {
4969 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
4970 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
4972 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
4973 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
4974 m_sa->sadb_sa_exttype = SADB_EXT_SA;
4975 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
4976 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
4978 IPSEC_ASSERT(off == len,
4979 ("length inconsistency (off %u len %u)", off, len));
4981 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
4982 SADB_EXT_ADDRESS_DST);
4989 if (n->m_len < sizeof(struct sadb_msg)) {
4990 n = m_pullup(n, sizeof(struct sadb_msg));
4992 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
4995 n->m_pkthdr.len = 0;
4996 for (nn = n; nn; nn = nn->m_next)
4997 n->m_pkthdr.len += nn->m_len;
4999 newmsg = mtod(n, struct sadb_msg *);
5000 newmsg->sadb_msg_seq = sav->seq;
5001 newmsg->sadb_msg_errno = 0;
5002 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
5005 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
5009 return (key_senderror(so, m, error));
5013 * allocating new SPI
5014 * called by key_getspi().
5017 * others: success, SPI in network byte order.
5020 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
5022 uint32_t min, max, newspi, t;
5023 int count = V_key_spi_trycnt;
5025 /* set spi range to allocate */
5026 if (spirange != NULL) {
5027 min = spirange->sadb_spirange_min;
5028 max = spirange->sadb_spirange_max;
5030 min = V_key_spi_minval;
5031 max = V_key_spi_maxval;
5033 /* IPCOMP needs 2-byte SPI */
5034 if (saidx->proto == IPPROTO_IPCOMP) {
5040 t = min; min = max; max = t;
5045 if (!key_checkspidup(htonl(min))) {
5046 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
5051 count--; /* taking one cost. */
5058 /* when requesting to allocate spi ranged */
5060 /* generate pseudo-random SPI value ranged. */
5061 newspi = min + (key_random() % (max - min + 1));
5062 if (!key_checkspidup(htonl(newspi)))
5066 if (count == 0 || newspi == 0) {
5067 ipseclog((LOG_DEBUG,
5068 "%s: failed to allocate SPI.\n", __func__));
5074 keystat.getspi_count =
5075 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
5077 return (htonl(newspi));
5081 * Find TCP-MD5 SA with corresponding secasindex.
5082 * If not found, return NULL and fill SPI with usable value if needed.
5084 static struct secasvar *
5085 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
5087 SAHTREE_RLOCK_TRACKER;
5088 struct secashead *sah;
5089 struct secasvar *sav;
5091 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
5093 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5094 if (sah->saidx.proto != IPPROTO_TCP)
5096 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
5097 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
5101 if (V_key_preferred_oldsa)
5102 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
5104 sav = TAILQ_FIRST(&sah->savtree_alive);
5112 /* No SPI required */
5116 /* Check that SPI is unique */
5117 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5118 if (sav->spi == *spi)
5123 /* SPI is already unique */
5127 /* XXX: not optimal */
5128 *spi = key_do_getnewspi(NULL, saidx);
5133 key_updateaddresses(struct socket *so, struct mbuf *m,
5134 const struct sadb_msghdr *mhp, struct secasvar *sav,
5135 struct secasindex *saidx)
5137 struct sockaddr *newaddr;
5138 struct secashead *sah;
5139 struct secasvar *newsav, *tmp;
5143 /* Check that we need to change SAH */
5144 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5145 newaddr = (struct sockaddr *)(
5146 ((struct sadb_address *)
5147 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5148 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5149 key_porttosaddr(&saidx->src.sa, 0);
5151 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5152 newaddr = (struct sockaddr *)(
5153 ((struct sadb_address *)
5154 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5155 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5156 key_porttosaddr(&saidx->dst.sa, 0);
5158 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5159 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5160 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5162 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5167 sah = key_getsah(saidx);
5169 /* create a new SA index */
5170 sah = key_newsah(saidx);
5172 ipseclog((LOG_DEBUG,
5173 "%s: No more memory.\n", __func__));
5176 isnew = 2; /* SAH is new */
5178 isnew = 1; /* existing SAH is referenced */
5181 * src and dst addresses are still the same.
5182 * Do we want to change NAT-T config?
5184 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5185 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5186 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5187 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5188 ipseclog((LOG_DEBUG,
5189 "%s: invalid message: missing required header.\n",
5193 /* We hold reference to SA, thus SAH will be referenced too. */
5198 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5200 if (newsav == NULL) {
5201 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5206 /* Clone SA's content into newsav */
5207 SAV_INITREF(newsav);
5208 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5210 * We create new NAT-T config if it is needed.
5211 * Old NAT-T config will be freed by key_cleansav() when
5212 * last reference to SA will be released.
5214 newsav->natt = NULL;
5216 newsav->state = SADB_SASTATE_MATURE;
5217 error = key_setnatt(newsav, mhp);
5222 /* Check that SA is still alive */
5223 if (sav->state == SADB_SASTATE_DEAD) {
5224 /* SA was unlinked */
5230 /* Unlink SA from SAH and SPI hash */
5231 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5232 ("SA is already cloned"));
5233 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5234 sav->state == SADB_SASTATE_DYING,
5235 ("Wrong SA state %u\n", sav->state));
5236 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5237 LIST_REMOVE(sav, spihash);
5238 sav->state = SADB_SASTATE_DEAD;
5241 * Link new SA with SAH. Keep SAs ordered by
5242 * create time (newer are first).
5244 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5245 if (newsav->created > tmp->created) {
5246 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5251 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5253 /* Add new SA into SPI hash. */
5254 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5256 /* Add new SAH into SADB. */
5258 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5259 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5260 sah->state = SADB_SASTATE_MATURE;
5261 SAH_ADDREF(sah); /* newsav references new SAH */
5264 * isnew == 1 -> @sah was referenced by key_getsah().
5265 * isnew == 0 -> we use the same @sah, that was used by @sav,
5266 * and we use its reference for @newsav.
5269 /* XXX: replace cntr with pointer? */
5270 newsav->cntr = sav->cntr;
5271 sav->flags |= SADB_X_EXT_F_CLONED;
5272 SECASVAR_UNLOCK(sav);
5277 printf("%s: SA(%p) cloned into SA(%p)\n",
5278 __func__, sav, newsav));
5279 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5281 key_freesav(&sav); /* release last reference */
5283 /* set msg buf from mhp */
5284 n = key_getmsgbuf_x1(m, mhp);
5286 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5290 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5295 if (newsav != NULL) {
5296 if (newsav->natt != NULL)
5297 free(newsav->natt, M_IPSEC_MISC);
5298 free(newsav, M_IPSEC_SA);
5304 * SADB_UPDATE processing
5306 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5307 * key(AE), (identity(SD),) (sensitivity)>
5308 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5310 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5311 * (identity(SD),) (sensitivity)>
5314 * m will always be freed.
5317 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5319 struct secasindex saidx;
5320 struct sadb_address *src0, *dst0;
5321 struct sadb_sa *sa0;
5322 struct secasvar *sav;
5325 uint8_t mode, proto;
5327 IPSEC_ASSERT(so != NULL, ("null socket"));
5328 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5329 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5330 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5332 /* map satype to proto */
5333 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5334 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5336 return key_senderror(so, m, EINVAL);
5339 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5340 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5341 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5342 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5343 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5344 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5345 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5346 ipseclog((LOG_DEBUG,
5347 "%s: invalid message: missing required header.\n",
5349 return key_senderror(so, m, EINVAL);
5351 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5352 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5353 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5354 ipseclog((LOG_DEBUG,
5355 "%s: invalid message: wrong header size.\n", __func__));
5356 return key_senderror(so, m, EINVAL);
5358 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5359 mode = IPSEC_MODE_ANY;
5362 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5363 ipseclog((LOG_DEBUG,
5364 "%s: invalid message: wrong header size.\n",
5366 return key_senderror(so, m, EINVAL);
5368 mode = ((struct sadb_x_sa2 *)
5369 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5370 reqid = ((struct sadb_x_sa2 *)
5371 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5374 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5375 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5376 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5379 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5380 * SADB_UPDATE message.
5382 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5383 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5384 #ifdef PFKEY_STRICT_CHECKS
5385 return key_senderror(so, m, EINVAL);
5388 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5389 (struct sockaddr *)(dst0 + 1));
5391 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5392 return key_senderror(so, m, error);
5394 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5395 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5397 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5398 __func__, ntohl(sa0->sadb_sa_spi)));
5399 return key_senderror(so, m, EINVAL);
5402 * Check that SADB_UPDATE issued by the same process that did
5403 * SADB_GETSPI or SADB_ADD.
5405 if (sav->pid != mhp->msg->sadb_msg_pid) {
5406 ipseclog((LOG_DEBUG,
5407 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5408 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5410 return key_senderror(so, m, EINVAL);
5412 /* saidx should match with SA. */
5413 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5414 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u\n",
5415 __func__, ntohl(sav->spi)));
5417 return key_senderror(so, m, ESRCH);
5420 if (sav->state == SADB_SASTATE_LARVAL) {
5421 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5422 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5423 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5424 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5425 ipseclog((LOG_DEBUG,
5426 "%s: invalid message: missing required header.\n",
5429 return key_senderror(so, m, EINVAL);
5432 * We can set any values except src, dst and SPI.
5434 error = key_setsaval(sav, mhp);
5437 return (key_senderror(so, m, error));
5439 /* Change SA state to MATURE */
5441 if (sav->state != SADB_SASTATE_LARVAL) {
5442 /* SA was deleted or another thread made it MATURE. */
5445 return (key_senderror(so, m, ESRCH));
5448 * NOTE: we keep SAs in savtree_alive ordered by created
5449 * time. When SA's state changed from LARVAL to MATURE,
5450 * we update its created time in key_setsaval() and move
5451 * it into head of savtree_alive.
5453 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5454 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5455 sav->state = SADB_SASTATE_MATURE;
5459 * For DYING and MATURE SA we can change only state
5460 * and lifetimes. Report EINVAL if something else attempted
5463 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5464 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5466 return (key_senderror(so, m, EINVAL));
5468 error = key_updatelifetimes(sav, mhp);
5471 return (key_senderror(so, m, error));
5474 * This is FreeBSD extension to RFC2367.
5475 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5476 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5477 * SA addresses (for example to implement MOBIKE protocol
5478 * as described in RFC4555). Also we allow to change
5481 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5482 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5483 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5484 sav->natt != NULL) {
5485 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5488 return (key_senderror(so, m, error));
5491 /* Check that SA is still alive */
5493 if (sav->state == SADB_SASTATE_DEAD) {
5494 /* SA was unlinked */
5497 return (key_senderror(so, m, ESRCH));
5500 * NOTE: there is possible state moving from DYING to MATURE,
5501 * but this doesn't change created time, so we won't reorder
5504 sav->state = SADB_SASTATE_MATURE;
5508 printf("%s: SA(%p)\n", __func__, sav));
5509 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5515 /* set msg buf from mhp */
5516 n = key_getmsgbuf_x1(m, mhp);
5518 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5519 return key_senderror(so, m, ENOBUFS);
5523 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5528 * SADB_ADD processing
5529 * add an entry to SA database, when received
5530 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5531 * key(AE), (identity(SD),) (sensitivity)>
5534 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5535 * (identity(SD),) (sensitivity)>
5538 * IGNORE identity and sensitivity messages.
5540 * m will always be freed.
5543 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5545 struct secasindex saidx;
5546 struct sadb_address *src0, *dst0;
5547 struct sadb_sa *sa0;
5548 struct secasvar *sav;
5549 uint32_t reqid, spi;
5550 uint8_t mode, proto;
5553 IPSEC_ASSERT(so != NULL, ("null socket"));
5554 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5555 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5556 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5558 /* map satype to proto */
5559 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5560 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5562 return key_senderror(so, m, EINVAL);
5565 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5566 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5567 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5568 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5569 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5570 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5571 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5572 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5573 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5574 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5575 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5576 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5577 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5578 ipseclog((LOG_DEBUG,
5579 "%s: invalid message: missing required header.\n",
5581 return key_senderror(so, m, EINVAL);
5583 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5584 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5585 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5586 ipseclog((LOG_DEBUG,
5587 "%s: invalid message: wrong header size.\n", __func__));
5588 return key_senderror(so, m, EINVAL);
5590 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5591 mode = IPSEC_MODE_ANY;
5594 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5595 ipseclog((LOG_DEBUG,
5596 "%s: invalid message: wrong header size.\n",
5598 return key_senderror(so, m, EINVAL);
5600 mode = ((struct sadb_x_sa2 *)
5601 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5602 reqid = ((struct sadb_x_sa2 *)
5603 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5606 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5607 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5608 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5611 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5614 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5615 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5616 #ifdef PFKEY_STRICT_CHECKS
5617 return key_senderror(so, m, EINVAL);
5620 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5621 (struct sockaddr *)(dst0 + 1));
5623 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5624 return key_senderror(so, m, error);
5626 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5627 spi = sa0->sadb_sa_spi;
5629 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5631 * XXXAE: IPComp seems also doesn't use SPI.
5633 if (proto == IPPROTO_TCP) {
5634 sav = key_getsav_tcpmd5(&saidx, &spi);
5635 if (sav == NULL && spi == 0) {
5636 /* Failed to allocate SPI */
5637 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5639 return key_senderror(so, m, EEXIST);
5641 /* XXX: SPI that we report back can have another value */
5643 /* We can create new SA only if SPI is different. */
5644 sav = key_getsavbyspi(spi);
5648 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5649 return key_senderror(so, m, EEXIST);
5652 sav = key_newsav(mhp, &saidx, spi, &error);
5654 return key_senderror(so, m, error);
5656 printf("%s: return SA(%p)\n", __func__, sav));
5657 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5659 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5663 key_acqdone(&saidx, sav->seq);
5667 * Don't call key_freesav() on error here, as we would like to
5668 * keep the SA in the database.
5672 /* set msg buf from mhp */
5673 n = key_getmsgbuf_x1(m, mhp);
5675 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5676 return key_senderror(so, m, ENOBUFS);
5680 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5686 * IKEd may request the use ESP in UDP encapsulation when it detects the
5687 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5688 * parameters needed for encapsulation and decapsulation. These PF_KEY
5689 * extension headers are not standardized, so this comment addresses our
5691 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5692 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5693 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5694 * UDP header. We use these ports in UDP encapsulation procedure, also we
5695 * can check them in UDP decapsulation procedure.
5696 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5697 * responder. These addresses can be used for transport mode to adjust
5698 * checksum after decapsulation and decryption. Since original IP addresses
5699 * used by peer usually different (we detected presence of NAT), TCP/UDP
5700 * pseudo header checksum and IP header checksum was calculated using original
5701 * addresses. After decapsulation and decryption we need to adjust checksum
5702 * to have correct datagram.
5704 * We expect presence of NAT-T extension headers only in SADB_ADD and
5705 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5706 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5709 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5711 struct sadb_x_nat_t_port *port;
5712 struct sadb_x_nat_t_type *type;
5713 struct sadb_address *oai, *oar;
5714 struct sockaddr *sa;
5718 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5720 * Ignore NAT-T headers if sproto isn't ESP.
5722 if (sav->sah->saidx.proto != IPPROTO_ESP)
5725 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5726 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5727 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5728 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5729 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5730 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5731 ipseclog((LOG_DEBUG,
5732 "%s: invalid message: wrong header size.\n",
5739 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5740 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5741 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5742 __func__, type->sadb_x_nat_t_type_type));
5746 * Allocate storage for NAT-T config.
5747 * On error it will be released by key_cleansav().
5749 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5751 if (sav->natt == NULL) {
5752 PFKEYSTAT_INC(in_nomem);
5753 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5756 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5757 if (port->sadb_x_nat_t_port_port == 0) {
5758 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5762 sav->natt->sport = port->sadb_x_nat_t_port_port;
5763 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5764 if (port->sadb_x_nat_t_port_port == 0) {
5765 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5769 sav->natt->dport = port->sadb_x_nat_t_port_port;
5772 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5773 * and needed only for transport mode IPsec.
5774 * Usually NAT translates only one address, but it is possible,
5775 * that both addresses could be translated.
5776 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5778 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5779 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5780 ipseclog((LOG_DEBUG,
5781 "%s: invalid message: wrong header size.\n",
5785 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5788 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5789 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5790 ipseclog((LOG_DEBUG,
5791 "%s: invalid message: wrong header size.\n",
5795 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5799 /* Initialize addresses only for transport mode */
5800 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5803 /* Currently we support only AF_INET */
5804 sa = (struct sockaddr *)(oai + 1);
5805 if (sa->sa_family != AF_INET ||
5806 sa->sa_len != sizeof(struct sockaddr_in)) {
5807 ipseclog((LOG_DEBUG,
5808 "%s: wrong NAT-OAi header.\n",
5812 /* Ignore address if it the same */
5813 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5814 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5815 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5816 sav->natt->flags |= IPSEC_NATT_F_OAI;
5817 /* Calculate checksum delta */
5818 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5819 cksum = in_addword(cksum, ~addr >> 16);
5820 cksum = in_addword(cksum, ~addr & 0xffff);
5821 addr = sav->natt->oai.sin.sin_addr.s_addr;
5822 cksum = in_addword(cksum, addr >> 16);
5823 cksum = in_addword(cksum, addr & 0xffff);
5827 /* Currently we support only AF_INET */
5828 sa = (struct sockaddr *)(oar + 1);
5829 if (sa->sa_family != AF_INET ||
5830 sa->sa_len != sizeof(struct sockaddr_in)) {
5831 ipseclog((LOG_DEBUG,
5832 "%s: wrong NAT-OAr header.\n",
5836 /* Ignore address if it the same */
5837 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5838 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5839 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5840 sav->natt->flags |= IPSEC_NATT_F_OAR;
5841 /* Calculate checksum delta */
5842 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5843 cksum = in_addword(cksum, ~addr >> 16);
5844 cksum = in_addword(cksum, ~addr & 0xffff);
5845 addr = sav->natt->oar.sin.sin_addr.s_addr;
5846 cksum = in_addword(cksum, addr >> 16);
5847 cksum = in_addword(cksum, addr & 0xffff);
5850 sav->natt->cksum = cksum;
5856 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5858 const struct sadb_ident *idsrc, *iddst;
5860 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5861 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5862 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5864 /* don't make buffer if not there */
5865 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5866 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5872 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5873 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5874 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5878 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5879 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5881 /* validity check */
5882 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5883 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5887 switch (idsrc->sadb_ident_type) {
5888 case SADB_IDENTTYPE_PREFIX:
5889 case SADB_IDENTTYPE_FQDN:
5890 case SADB_IDENTTYPE_USERFQDN:
5892 /* XXX do nothing */
5898 /* make structure */
5899 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5900 if (sah->idents == NULL) {
5901 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5904 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5905 if (sah->identd == NULL) {
5906 free(sah->idents, M_IPSEC_MISC);
5908 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5911 sah->idents->type = idsrc->sadb_ident_type;
5912 sah->idents->id = idsrc->sadb_ident_id;
5914 sah->identd->type = iddst->sadb_ident_type;
5915 sah->identd->id = iddst->sadb_ident_id;
5921 * m will not be freed on return.
5922 * it is caller's responsibility to free the result.
5924 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5925 * from the request in defined order.
5927 static struct mbuf *
5928 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5932 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5933 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5934 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5936 /* create new sadb_msg to reply. */
5937 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5938 SADB_EXT_SA, SADB_X_EXT_SA2,
5939 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5940 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5941 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5942 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5943 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5944 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5945 SADB_X_EXT_NEW_ADDRESS_DST);
5949 if (n->m_len < sizeof(struct sadb_msg)) {
5950 n = m_pullup(n, sizeof(struct sadb_msg));
5954 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5955 mtod(n, struct sadb_msg *)->sadb_msg_len =
5956 PFKEY_UNIT64(n->m_pkthdr.len);
5962 * SADB_DELETE processing
5964 * <base, SA(*), address(SD)>
5965 * from the ikmpd, and set SADB_SASTATE_DEAD,
5967 * <base, SA(*), address(SD)>
5970 * m will always be freed.
5973 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5975 struct secasindex saidx;
5976 struct sadb_address *src0, *dst0;
5977 struct secasvar *sav;
5978 struct sadb_sa *sa0;
5981 IPSEC_ASSERT(so != NULL, ("null socket"));
5982 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5983 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5984 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5986 /* map satype to proto */
5987 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5988 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5990 return key_senderror(so, m, EINVAL);
5993 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5994 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5995 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5996 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5997 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
5999 return key_senderror(so, m, EINVAL);
6002 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
6003 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
6005 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6006 (struct sockaddr *)(dst0 + 1)) != 0) {
6007 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6008 return (key_senderror(so, m, EINVAL));
6010 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6011 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
6013 * Caller wants us to delete all non-LARVAL SAs
6014 * that match the src/dst. This is used during
6015 * IKE INITIAL-CONTACT.
6016 * XXXAE: this looks like some extension to RFC2367.
6018 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
6019 return (key_delete_all(so, m, mhp, &saidx));
6021 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
6022 ipseclog((LOG_DEBUG,
6023 "%s: invalid message: wrong header size.\n", __func__));
6024 return (key_senderror(so, m, EINVAL));
6026 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6027 if (proto == IPPROTO_TCP)
6028 sav = key_getsav_tcpmd5(&saidx, NULL);
6030 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6032 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
6033 __func__, ntohl(sa0->sadb_sa_spi)));
6034 return (key_senderror(so, m, ESRCH));
6036 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6037 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6038 __func__, ntohl(sav->spi)));
6040 return (key_senderror(so, m, ESRCH));
6043 printf("%s: SA(%p)\n", __func__, sav));
6044 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6050 struct sadb_msg *newmsg;
6052 /* create new sadb_msg to reply. */
6053 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
6054 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6056 return key_senderror(so, m, ENOBUFS);
6058 if (n->m_len < sizeof(struct sadb_msg)) {
6059 n = m_pullup(n, sizeof(struct sadb_msg));
6061 return key_senderror(so, m, ENOBUFS);
6063 newmsg = mtod(n, struct sadb_msg *);
6064 newmsg->sadb_msg_errno = 0;
6065 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6068 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6073 * delete all SAs for src/dst. Called from key_delete().
6076 key_delete_all(struct socket *so, struct mbuf *m,
6077 const struct sadb_msghdr *mhp, struct secasindex *saidx)
6079 struct secasvar_queue drainq;
6080 struct secashead *sah;
6081 struct secasvar *sav, *nextsav;
6083 TAILQ_INIT(&drainq);
6085 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
6086 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
6088 /* Move all ALIVE SAs into drainq */
6089 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6091 /* Unlink all queued SAs from SPI hash */
6092 TAILQ_FOREACH(sav, &drainq, chain) {
6093 sav->state = SADB_SASTATE_DEAD;
6094 LIST_REMOVE(sav, spihash);
6097 /* Now we can release reference for all SAs in drainq */
6098 sav = TAILQ_FIRST(&drainq);
6099 while (sav != NULL) {
6101 printf("%s: SA(%p)\n", __func__, sav));
6102 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6103 nextsav = TAILQ_NEXT(sav, chain);
6104 key_freesah(&sav->sah); /* release reference from SAV */
6105 key_freesav(&sav); /* release last reference */
6111 struct sadb_msg *newmsg;
6113 /* create new sadb_msg to reply. */
6114 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6115 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6117 return key_senderror(so, m, ENOBUFS);
6119 if (n->m_len < sizeof(struct sadb_msg)) {
6120 n = m_pullup(n, sizeof(struct sadb_msg));
6122 return key_senderror(so, m, ENOBUFS);
6124 newmsg = mtod(n, struct sadb_msg *);
6125 newmsg->sadb_msg_errno = 0;
6126 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6129 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6134 * Delete all alive SAs for corresponding xform.
6135 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6136 * here when xform disappears.
6139 key_delete_xform(const struct xformsw *xsp)
6141 struct secasvar_queue drainq;
6142 struct secashead *sah;
6143 struct secasvar *sav, *nextsav;
6145 TAILQ_INIT(&drainq);
6147 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6148 sav = TAILQ_FIRST(&sah->savtree_alive);
6151 if (sav->tdb_xform != xsp)
6154 * It is supposed that all SAs in the chain are related to
6157 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6159 /* Unlink all queued SAs from SPI hash */
6160 TAILQ_FOREACH(sav, &drainq, chain) {
6161 sav->state = SADB_SASTATE_DEAD;
6162 LIST_REMOVE(sav, spihash);
6166 /* Now we can release reference for all SAs in drainq */
6167 sav = TAILQ_FIRST(&drainq);
6168 while (sav != NULL) {
6170 printf("%s: SA(%p)\n", __func__, sav));
6171 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6172 nextsav = TAILQ_NEXT(sav, chain);
6173 key_freesah(&sav->sah); /* release reference from SAV */
6174 key_freesav(&sav); /* release last reference */
6180 * SADB_GET processing
6182 * <base, SA(*), address(SD)>
6183 * from the ikmpd, and get a SP and a SA to respond,
6185 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6186 * (identity(SD),) (sensitivity)>
6189 * m will always be freed.
6192 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6194 struct secasindex saidx;
6195 struct sadb_address *src0, *dst0;
6196 struct sadb_sa *sa0;
6197 struct secasvar *sav;
6200 IPSEC_ASSERT(so != NULL, ("null socket"));
6201 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6202 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6203 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6205 /* map satype to proto */
6206 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6207 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6209 return key_senderror(so, m, EINVAL);
6212 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6213 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6214 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6215 ipseclog((LOG_DEBUG,
6216 "%s: invalid message: missing required header.\n",
6218 return key_senderror(so, m, EINVAL);
6220 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6221 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6222 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6223 ipseclog((LOG_DEBUG,
6224 "%s: invalid message: wrong header size.\n", __func__));
6225 return key_senderror(so, m, EINVAL);
6228 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6229 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6230 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6232 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6233 (struct sockaddr *)(dst0 + 1)) != 0) {
6234 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6235 return key_senderror(so, m, EINVAL);
6237 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6239 if (proto == IPPROTO_TCP)
6240 sav = key_getsav_tcpmd5(&saidx, NULL);
6242 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6244 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6245 return key_senderror(so, m, ESRCH);
6247 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6248 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6249 __func__, ntohl(sa0->sadb_sa_spi)));
6251 return (key_senderror(so, m, ESRCH));
6258 /* map proto to satype */
6259 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6260 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6263 return key_senderror(so, m, EINVAL);
6266 /* create new sadb_msg to reply. */
6267 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6268 mhp->msg->sadb_msg_pid);
6272 return key_senderror(so, m, ENOBUFS);
6275 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6279 /* XXX make it sysctl-configurable? */
6281 key_getcomb_setlifetime(struct sadb_comb *comb)
6284 comb->sadb_comb_soft_allocations = 1;
6285 comb->sadb_comb_hard_allocations = 1;
6286 comb->sadb_comb_soft_bytes = 0;
6287 comb->sadb_comb_hard_bytes = 0;
6288 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6289 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6290 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6291 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6295 * XXX reorder combinations by preference
6296 * XXX no idea if the user wants ESP authentication or not
6298 static struct mbuf *
6299 key_getcomb_ealg(void)
6301 struct sadb_comb *comb;
6302 const struct enc_xform *algo;
6303 struct mbuf *result = NULL, *m, *n;
6307 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6310 for (i = 1; i <= SADB_EALG_MAX; i++) {
6311 algo = enc_algorithm_lookup(i);
6315 /* discard algorithms with key size smaller than system min */
6316 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6318 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6319 encmin = V_ipsec_esp_keymin;
6321 encmin = _BITS(algo->minkey);
6323 if (V_ipsec_esp_auth)
6324 m = key_getcomb_ah();
6326 IPSEC_ASSERT(l <= MLEN,
6327 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6328 MGET(m, M_NOWAIT, MT_DATA);
6333 bzero(mtod(m, caddr_t), m->m_len);
6340 for (n = m; n; n = n->m_next)
6342 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6344 for (off = 0; off < totlen; off += l) {
6345 n = m_pulldown(m, off, l, &o);
6347 /* m is already freed */
6350 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6351 bzero(comb, sizeof(*comb));
6352 key_getcomb_setlifetime(comb);
6353 comb->sadb_comb_encrypt = i;
6354 comb->sadb_comb_encrypt_minbits = encmin;
6355 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6373 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6377 *min = *max = ah->hashsize;
6378 if (ah->keysize == 0) {
6380 * Transform takes arbitrary key size but algorithm
6381 * key size is restricted. Enforce this here.
6384 case SADB_X_AALG_MD5: *min = *max = 16; break;
6385 case SADB_X_AALG_SHA: *min = *max = 20; break;
6386 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6387 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6388 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6389 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6391 DPRINTF(("%s: unknown AH algorithm %u\n",
6399 * XXX reorder combinations by preference
6401 static struct mbuf *
6404 const struct auth_hash *algo;
6405 struct sadb_comb *comb;
6407 u_int16_t minkeysize, maxkeysize;
6409 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6412 for (i = 1; i <= SADB_AALG_MAX; i++) {
6414 /* we prefer HMAC algorithms, not old algorithms */
6415 if (i != SADB_AALG_SHA1HMAC &&
6416 i != SADB_AALG_MD5HMAC &&
6417 i != SADB_X_AALG_SHA2_256 &&
6418 i != SADB_X_AALG_SHA2_384 &&
6419 i != SADB_X_AALG_SHA2_512)
6422 algo = auth_algorithm_lookup(i);
6425 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6426 /* discard algorithms with key size smaller than system min */
6427 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6431 IPSEC_ASSERT(l <= MLEN,
6432 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6433 MGET(m, M_NOWAIT, MT_DATA);
6440 M_PREPEND(m, l, M_NOWAIT);
6444 comb = mtod(m, struct sadb_comb *);
6445 bzero(comb, sizeof(*comb));
6446 key_getcomb_setlifetime(comb);
6447 comb->sadb_comb_auth = i;
6448 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6449 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6456 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6457 * XXX reorder combinations by preference
6459 static struct mbuf *
6460 key_getcomb_ipcomp()
6462 const struct comp_algo *algo;
6463 struct sadb_comb *comb;
6466 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6469 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6470 algo = comp_algorithm_lookup(i);
6475 IPSEC_ASSERT(l <= MLEN,
6476 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6477 MGET(m, M_NOWAIT, MT_DATA);
6484 M_PREPEND(m, l, M_NOWAIT);
6488 comb = mtod(m, struct sadb_comb *);
6489 bzero(comb, sizeof(*comb));
6490 key_getcomb_setlifetime(comb);
6491 comb->sadb_comb_encrypt = i;
6492 /* what should we set into sadb_comb_*_{min,max}bits? */
6499 * XXX no way to pass mode (transport/tunnel) to userland
6500 * XXX replay checking?
6501 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6503 static struct mbuf *
6504 key_getprop(const struct secasindex *saidx)
6506 struct sadb_prop *prop;
6508 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6511 switch (saidx->proto) {
6513 m = key_getcomb_ealg();
6516 m = key_getcomb_ah();
6518 case IPPROTO_IPCOMP:
6519 m = key_getcomb_ipcomp();
6527 M_PREPEND(m, l, M_NOWAIT);
6532 for (n = m; n; n = n->m_next)
6535 prop = mtod(m, struct sadb_prop *);
6536 bzero(prop, sizeof(*prop));
6537 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6538 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6539 prop->sadb_prop_replay = 32; /* XXX */
6545 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6547 * <base, SA, address(SD), (address(P)), x_policy,
6548 * (identity(SD),) (sensitivity,) proposal>
6549 * to KMD, and expect to receive
6550 * <base> with SADB_ACQUIRE if error occurred,
6552 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6553 * from KMD by PF_KEY.
6555 * XXX x_policy is outside of RFC2367 (KAME extension).
6556 * XXX sensitivity is not supported.
6557 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6558 * see comment for key_getcomb_ipcomp().
6562 * others: error number
6565 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6567 union sockaddr_union addr;
6568 struct mbuf *result, *m;
6572 uint8_t mask, satype;
6574 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6575 satype = key_proto2satype(saidx->proto);
6576 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6580 ul_proto = IPSEC_ULPROTO_ANY;
6582 /* Get seq number to check whether sending message or not. */
6583 seq = key_getacq(saidx, &error);
6587 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6595 * set sadb_address for saidx's.
6597 * Note that if sp is supplied, then we're being called from
6598 * key_allocsa_policy() and should supply port and protocol
6600 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6601 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6602 * XXXAE: it looks like we should save this info in the ACQ entry.
6604 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6605 sp->spidx.ul_proto == IPPROTO_UDP))
6606 ul_proto = sp->spidx.ul_proto;
6610 if (ul_proto != IPSEC_ULPROTO_ANY) {
6611 switch (sp->spidx.src.sa.sa_family) {
6613 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6614 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6615 mask = sp->spidx.prefs;
6619 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6620 addr.sin6.sin6_port =
6621 sp->spidx.src.sin6.sin6_port;
6622 mask = sp->spidx.prefs;
6629 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6638 if (ul_proto != IPSEC_ULPROTO_ANY) {
6639 switch (sp->spidx.dst.sa.sa_family) {
6641 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6642 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6643 mask = sp->spidx.prefd;
6647 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6648 addr.sin6.sin6_port =
6649 sp->spidx.dst.sin6.sin6_port;
6650 mask = sp->spidx.prefd;
6657 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6664 /* XXX proxy address (optional) */
6667 * Set sadb_x_policy. This is KAME extension to RFC2367.
6670 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6680 * Set sadb_x_sa2 extension if saidx->reqid is not zero.
6681 * This is FreeBSD extension to RFC2367.
6683 if (saidx->reqid != 0) {
6684 m = key_setsadbxsa2(saidx->mode, 0, saidx->reqid);
6691 /* XXX identity (optional) */
6693 if (idexttype && fqdn) {
6694 /* create identity extension (FQDN) */
6695 struct sadb_ident *id;
6698 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6699 id = (struct sadb_ident *)p;
6700 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6701 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6702 id->sadb_ident_exttype = idexttype;
6703 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6704 bcopy(fqdn, id + 1, fqdnlen);
6705 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6709 /* create identity extension (USERFQDN) */
6710 struct sadb_ident *id;
6714 /* +1 for terminating-NUL */
6715 userfqdnlen = strlen(userfqdn) + 1;
6718 id = (struct sadb_ident *)p;
6719 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6720 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6721 id->sadb_ident_exttype = idexttype;
6722 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6723 /* XXX is it correct? */
6724 if (curproc && curproc->p_cred)
6725 id->sadb_ident_id = curproc->p_cred->p_ruid;
6726 if (userfqdn && userfqdnlen)
6727 bcopy(userfqdn, id + 1, userfqdnlen);
6728 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6732 /* XXX sensitivity (optional) */
6734 /* create proposal/combination extension */
6735 m = key_getprop(saidx);
6738 * spec conformant: always attach proposal/combination extension,
6739 * the problem is that we have no way to attach it for ipcomp,
6740 * due to the way sadb_comb is declared in RFC2367.
6749 * outside of spec; make proposal/combination extension optional.
6755 if ((result->m_flags & M_PKTHDR) == 0) {
6760 if (result->m_len < sizeof(struct sadb_msg)) {
6761 result = m_pullup(result, sizeof(struct sadb_msg));
6762 if (result == NULL) {
6768 result->m_pkthdr.len = 0;
6769 for (m = result; m; m = m->m_next)
6770 result->m_pkthdr.len += m->m_len;
6772 mtod(result, struct sadb_msg *)->sadb_msg_len =
6773 PFKEY_UNIT64(result->m_pkthdr.len);
6776 printf("%s: SP(%p)\n", __func__, sp));
6777 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6779 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6788 key_newacq(const struct secasindex *saidx, int *perror)
6793 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6795 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6801 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6802 acq->created = time_second;
6805 /* add to acqtree */
6807 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6808 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6809 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6810 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6817 key_getacq(const struct secasindex *saidx, int *perror)
6823 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6824 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6825 if (acq->count > V_key_blockacq_count) {
6827 * Reset counter and send message.
6828 * Also reset created time to keep ACQ for
6831 acq->created = time_second;
6836 * Increment counter and do nothing.
6837 * We send SADB_ACQUIRE message only
6838 * for each V_key_blockacq_count packet.
6851 /* allocate new entry */
6852 return (key_newacq(saidx, perror));
6856 key_acqreset(uint32_t seq)
6861 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6862 if (acq->seq == seq) {
6864 acq->created = time_second;
6874 * Mark ACQ entry as stale to remove it in key_flush_acq().
6875 * Called after successful SADB_GETSPI message.
6878 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6883 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6884 if (acq->seq == seq)
6888 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6889 ipseclog((LOG_DEBUG,
6890 "%s: Mismatched saidx for ACQ %u\n", __func__, seq));
6896 ipseclog((LOG_DEBUG,
6897 "%s: ACQ %u is not found.\n", __func__, seq));
6905 static struct secspacq *
6906 key_newspacq(struct secpolicyindex *spidx)
6908 struct secspacq *acq;
6911 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6913 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6918 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6919 acq->created = time_second;
6922 /* add to spacqtree */
6924 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6930 static struct secspacq *
6931 key_getspacq(struct secpolicyindex *spidx)
6933 struct secspacq *acq;
6936 LIST_FOREACH(acq, &V_spacqtree, chain) {
6937 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6938 /* NB: return holding spacq_lock */
6948 * SADB_ACQUIRE processing,
6949 * in first situation, is receiving
6951 * from the ikmpd, and clear sequence of its secasvar entry.
6953 * In second situation, is receiving
6954 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6955 * from a user land process, and return
6956 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6959 * m will always be freed.
6962 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6964 SAHTREE_RLOCK_TRACKER;
6965 struct sadb_address *src0, *dst0;
6966 struct secasindex saidx;
6967 struct secashead *sah;
6970 uint8_t mode, proto;
6972 IPSEC_ASSERT(so != NULL, ("null socket"));
6973 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6974 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6975 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6978 * Error message from KMd.
6979 * We assume that if error was occurred in IKEd, the length of PFKEY
6980 * message is equal to the size of sadb_msg structure.
6981 * We do not raise error even if error occurred in this function.
6983 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
6984 /* check sequence number */
6985 if (mhp->msg->sadb_msg_seq == 0 ||
6986 mhp->msg->sadb_msg_errno == 0) {
6987 ipseclog((LOG_DEBUG, "%s: must specify sequence "
6988 "number and errno.\n", __func__));
6991 * IKEd reported that error occurred.
6992 * XXXAE: what it expects from the kernel?
6993 * Probably we should send SADB_ACQUIRE again?
6994 * If so, reset ACQ's state.
6995 * XXXAE: it looks useless.
6997 key_acqreset(mhp->msg->sadb_msg_seq);
7004 * This message is from user land.
7007 /* map satype to proto */
7008 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7009 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7011 return key_senderror(so, m, EINVAL);
7014 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
7015 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
7016 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
7017 ipseclog((LOG_DEBUG,
7018 "%s: invalid message: missing required header.\n",
7020 return key_senderror(so, m, EINVAL);
7022 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
7023 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
7024 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
7025 ipseclog((LOG_DEBUG,
7026 "%s: invalid message: wrong header size.\n", __func__));
7027 return key_senderror(so, m, EINVAL);
7030 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
7031 mode = IPSEC_MODE_ANY;
7034 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
7035 ipseclog((LOG_DEBUG,
7036 "%s: invalid message: wrong header size.\n",
7038 return key_senderror(so, m, EINVAL);
7040 mode = ((struct sadb_x_sa2 *)
7041 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7042 reqid = ((struct sadb_x_sa2 *)
7043 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7046 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7047 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7049 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
7050 (struct sockaddr *)(dst0 + 1));
7052 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
7053 return key_senderror(so, m, EINVAL);
7055 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
7057 /* get a SA index */
7059 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
7060 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
7065 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
7066 return key_senderror(so, m, EEXIST);
7069 error = key_acquire(&saidx, NULL);
7071 ipseclog((LOG_DEBUG,
7072 "%s: error %d returned from key_acquire()\n",
7074 return key_senderror(so, m, error);
7081 * SADB_REGISTER processing.
7082 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
7085 * from the ikmpd, and register a socket to send PF_KEY messages,
7089 * If socket is detached, must free from regnode.
7091 * m will always be freed.
7094 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7096 struct secreg *reg, *newreg = NULL;
7098 IPSEC_ASSERT(so != NULL, ("null socket"));
7099 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7100 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7101 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7103 /* check for invalid register message */
7104 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
7105 return key_senderror(so, m, EINVAL);
7107 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
7108 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
7111 /* check whether existing or not */
7113 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
7114 if (reg->so == so) {
7116 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
7118 return key_senderror(so, m, EEXIST);
7122 /* create regnode */
7123 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
7124 if (newreg == NULL) {
7126 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7127 return key_senderror(so, m, ENOBUFS);
7131 ((struct keycb *)sotorawcb(so))->kp_registered++;
7133 /* add regnode to regtree. */
7134 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7140 struct sadb_msg *newmsg;
7141 struct sadb_supported *sup;
7142 u_int len, alen, elen;
7145 struct sadb_alg *alg;
7147 /* create new sadb_msg to reply. */
7149 for (i = 1; i <= SADB_AALG_MAX; i++) {
7150 if (auth_algorithm_lookup(i))
7151 alen += sizeof(struct sadb_alg);
7154 alen += sizeof(struct sadb_supported);
7156 for (i = 1; i <= SADB_EALG_MAX; i++) {
7157 if (enc_algorithm_lookup(i))
7158 elen += sizeof(struct sadb_alg);
7161 elen += sizeof(struct sadb_supported);
7163 len = sizeof(struct sadb_msg) + alen + elen;
7166 return key_senderror(so, m, ENOBUFS);
7168 MGETHDR(n, M_NOWAIT, MT_DATA);
7169 if (n != NULL && len > MHLEN) {
7170 if (!(MCLGET(n, M_NOWAIT))) {
7176 return key_senderror(so, m, ENOBUFS);
7178 n->m_pkthdr.len = n->m_len = len;
7182 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7183 newmsg = mtod(n, struct sadb_msg *);
7184 newmsg->sadb_msg_errno = 0;
7185 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7186 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7188 /* for authentication algorithm */
7190 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7191 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7192 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7193 off += PFKEY_ALIGN8(sizeof(*sup));
7195 for (i = 1; i <= SADB_AALG_MAX; i++) {
7196 const struct auth_hash *aalgo;
7197 u_int16_t minkeysize, maxkeysize;
7199 aalgo = auth_algorithm_lookup(i);
7202 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7203 alg->sadb_alg_id = i;
7204 alg->sadb_alg_ivlen = 0;
7205 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7206 alg->sadb_alg_minbits = _BITS(minkeysize);
7207 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7208 off += PFKEY_ALIGN8(sizeof(*alg));
7212 /* for encryption algorithm */
7214 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7215 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7216 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7217 off += PFKEY_ALIGN8(sizeof(*sup));
7219 for (i = 1; i <= SADB_EALG_MAX; i++) {
7220 const struct enc_xform *ealgo;
7222 ealgo = enc_algorithm_lookup(i);
7225 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7226 alg->sadb_alg_id = i;
7227 alg->sadb_alg_ivlen = ealgo->ivsize;
7228 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7229 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7230 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7234 IPSEC_ASSERT(off == len,
7235 ("length assumption failed (off %u len %u)", off, len));
7238 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7243 * free secreg entry registered.
7244 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7247 key_freereg(struct socket *so)
7252 IPSEC_ASSERT(so != NULL, ("NULL so"));
7255 * check whether existing or not.
7256 * check all type of SA, because there is a potential that
7257 * one socket is registered to multiple type of SA.
7260 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7261 LIST_FOREACH(reg, &V_regtree[i], chain) {
7262 if (reg->so == so && __LIST_CHAINED(reg)) {
7263 LIST_REMOVE(reg, chain);
7264 free(reg, M_IPSEC_SAR);
7273 * SADB_EXPIRE processing
7275 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7277 * NOTE: We send only soft lifetime extension.
7280 * others : error number
7283 key_expire(struct secasvar *sav, int hard)
7285 struct mbuf *result = NULL, *m;
7286 struct sadb_lifetime *lt;
7287 uint32_t replay_count;
7291 IPSEC_ASSERT (sav != NULL, ("null sav"));
7292 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7295 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7296 sav, hard ? "hard": "soft"));
7297 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7298 /* set msg header */
7299 satype = key_proto2satype(sav->sah->saidx.proto);
7300 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7301 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7308 /* create SA extension */
7309 m = key_setsadbsa(sav);
7316 /* create SA extension */
7318 replay_count = sav->replay ? sav->replay->count : 0;
7319 SECASVAR_UNLOCK(sav);
7321 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7322 sav->sah->saidx.reqid);
7329 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7330 m = key_setsadbxsareplay(sav->replay->wsize);
7338 /* create lifetime extension (current and soft) */
7339 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7340 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7347 bzero(mtod(m, caddr_t), len);
7348 lt = mtod(m, struct sadb_lifetime *);
7349 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7350 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7351 lt->sadb_lifetime_allocations =
7352 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7353 lt->sadb_lifetime_bytes =
7354 counter_u64_fetch(sav->lft_c_bytes);
7355 lt->sadb_lifetime_addtime = sav->created;
7356 lt->sadb_lifetime_usetime = sav->firstused;
7357 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7358 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7360 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7361 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7362 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7363 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7364 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7366 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7367 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7368 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7369 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7370 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7374 /* set sadb_address for source */
7375 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7376 &sav->sah->saidx.src.sa,
7377 FULLMASK, IPSEC_ULPROTO_ANY);
7384 /* set sadb_address for destination */
7385 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7386 &sav->sah->saidx.dst.sa,
7387 FULLMASK, IPSEC_ULPROTO_ANY);
7395 * XXX-BZ Handle NAT-T extensions here.
7396 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7397 * this information, we report only significant SA fields.
7400 if ((result->m_flags & M_PKTHDR) == 0) {
7405 if (result->m_len < sizeof(struct sadb_msg)) {
7406 result = m_pullup(result, sizeof(struct sadb_msg));
7407 if (result == NULL) {
7413 result->m_pkthdr.len = 0;
7414 for (m = result; m; m = m->m_next)
7415 result->m_pkthdr.len += m->m_len;
7417 mtod(result, struct sadb_msg *)->sadb_msg_len =
7418 PFKEY_UNIT64(result->m_pkthdr.len);
7420 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7429 key_freesah_flushed(struct secashead_queue *flushq)
7431 struct secashead *sah, *nextsah;
7432 struct secasvar *sav, *nextsav;
7434 sah = TAILQ_FIRST(flushq);
7435 while (sah != NULL) {
7436 sav = TAILQ_FIRST(&sah->savtree_larval);
7437 while (sav != NULL) {
7438 nextsav = TAILQ_NEXT(sav, chain);
7439 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7440 key_freesav(&sav); /* release last reference */
7441 key_freesah(&sah); /* release reference from SAV */
7444 sav = TAILQ_FIRST(&sah->savtree_alive);
7445 while (sav != NULL) {
7446 nextsav = TAILQ_NEXT(sav, chain);
7447 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7448 key_freesav(&sav); /* release last reference */
7449 key_freesah(&sah); /* release reference from SAV */
7452 nextsah = TAILQ_NEXT(sah, chain);
7453 key_freesah(&sah); /* release last reference */
7459 * SADB_FLUSH processing
7462 * from the ikmpd, and free all entries in secastree.
7466 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7468 * m will always be freed.
7471 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7473 struct secashead_queue flushq;
7474 struct sadb_msg *newmsg;
7475 struct secashead *sah, *nextsah;
7476 struct secasvar *sav;
7480 IPSEC_ASSERT(so != NULL, ("null socket"));
7481 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7482 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7484 /* map satype to proto */
7485 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7486 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7488 return key_senderror(so, m, EINVAL);
7491 printf("%s: proto %u\n", __func__, proto));
7493 TAILQ_INIT(&flushq);
7494 if (proto == IPSEC_PROTO_ANY) {
7495 /* no SATYPE specified, i.e. flushing all SA. */
7497 /* Move all SAHs into flushq */
7498 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7499 /* Flush all buckets in SPI hash */
7500 for (i = 0; i < V_savhash_mask + 1; i++)
7501 LIST_INIT(&V_savhashtbl[i]);
7502 /* Flush all buckets in SAHADDRHASH */
7503 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7504 LIST_INIT(&V_sahaddrhashtbl[i]);
7505 /* Mark all SAHs as unlinked */
7506 TAILQ_FOREACH(sah, &flushq, chain) {
7507 sah->state = SADB_SASTATE_DEAD;
7509 * Callout handler makes its job using
7510 * RLOCK and drain queues. In case, when this
7511 * function will be called just before it
7512 * acquires WLOCK, we need to mark SAs as
7513 * unlinked to prevent second unlink.
7515 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7516 sav->state = SADB_SASTATE_DEAD;
7518 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7519 sav->state = SADB_SASTATE_DEAD;
7525 sah = TAILQ_FIRST(&V_sahtree);
7526 while (sah != NULL) {
7527 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7528 ("DEAD SAH %p in SADB_FLUSH", sah));
7529 nextsah = TAILQ_NEXT(sah, chain);
7530 if (sah->saidx.proto != proto) {
7534 sah->state = SADB_SASTATE_DEAD;
7535 TAILQ_REMOVE(&V_sahtree, sah, chain);
7536 LIST_REMOVE(sah, addrhash);
7537 /* Unlink all SAs from SPI hash */
7538 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7539 LIST_REMOVE(sav, spihash);
7540 sav->state = SADB_SASTATE_DEAD;
7542 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7543 LIST_REMOVE(sav, spihash);
7544 sav->state = SADB_SASTATE_DEAD;
7546 /* Add SAH into flushq */
7547 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7553 key_freesah_flushed(&flushq);
7554 /* Free all queued SAs and SAHs */
7555 if (m->m_len < sizeof(struct sadb_msg) ||
7556 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7557 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7558 return key_senderror(so, m, ENOBUFS);
7564 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7565 newmsg = mtod(m, struct sadb_msg *);
7566 newmsg->sadb_msg_errno = 0;
7567 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7569 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7573 * SADB_DUMP processing
7574 * dump all entries including status of DEAD in SAD.
7577 * from the ikmpd, and dump all secasvar leaves
7582 * m will always be freed.
7585 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7587 SAHTREE_RLOCK_TRACKER;
7588 struct secashead *sah;
7589 struct secasvar *sav;
7592 uint8_t proto, satype;
7594 IPSEC_ASSERT(so != NULL, ("null socket"));
7595 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7596 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7597 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7599 /* map satype to proto */
7600 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7601 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7603 return key_senderror(so, m, EINVAL);
7606 /* count sav entries to be sent to the userland. */
7609 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7610 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7611 proto != sah->saidx.proto)
7614 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7616 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7622 return key_senderror(so, m, ENOENT);
7625 /* send this to the userland, one at a time. */
7626 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7627 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7628 proto != sah->saidx.proto)
7631 /* map proto to satype */
7632 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7634 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7635 "SAD.\n", __func__));
7636 return key_senderror(so, m, EINVAL);
7638 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7639 n = key_setdumpsa(sav, SADB_DUMP, satype,
7640 --cnt, mhp->msg->sadb_msg_pid);
7643 return key_senderror(so, m, ENOBUFS);
7645 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7647 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7648 n = key_setdumpsa(sav, SADB_DUMP, satype,
7649 --cnt, mhp->msg->sadb_msg_pid);
7652 return key_senderror(so, m, ENOBUFS);
7654 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7662 * SADB_X_PROMISC processing
7664 * m will always be freed.
7667 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7671 IPSEC_ASSERT(so != NULL, ("null socket"));
7672 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7673 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7674 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7676 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7678 if (olen < sizeof(struct sadb_msg)) {
7680 return key_senderror(so, m, EINVAL);
7685 } else if (olen == sizeof(struct sadb_msg)) {
7686 /* enable/disable promisc mode */
7689 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7690 return key_senderror(so, m, EINVAL);
7691 mhp->msg->sadb_msg_errno = 0;
7692 switch (mhp->msg->sadb_msg_satype) {
7695 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7698 return key_senderror(so, m, EINVAL);
7701 /* send the original message back to everyone */
7702 mhp->msg->sadb_msg_errno = 0;
7703 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7705 /* send packet as is */
7707 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7709 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7710 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7714 static int (*key_typesw[])(struct socket *, struct mbuf *,
7715 const struct sadb_msghdr *) = {
7716 NULL, /* SADB_RESERVED */
7717 key_getspi, /* SADB_GETSPI */
7718 key_update, /* SADB_UPDATE */
7719 key_add, /* SADB_ADD */
7720 key_delete, /* SADB_DELETE */
7721 key_get, /* SADB_GET */
7722 key_acquire2, /* SADB_ACQUIRE */
7723 key_register, /* SADB_REGISTER */
7724 NULL, /* SADB_EXPIRE */
7725 key_flush, /* SADB_FLUSH */
7726 key_dump, /* SADB_DUMP */
7727 key_promisc, /* SADB_X_PROMISC */
7728 NULL, /* SADB_X_PCHANGE */
7729 key_spdadd, /* SADB_X_SPDUPDATE */
7730 key_spdadd, /* SADB_X_SPDADD */
7731 key_spddelete, /* SADB_X_SPDDELETE */
7732 key_spdget, /* SADB_X_SPDGET */
7733 NULL, /* SADB_X_SPDACQUIRE */
7734 key_spddump, /* SADB_X_SPDDUMP */
7735 key_spdflush, /* SADB_X_SPDFLUSH */
7736 key_spdadd, /* SADB_X_SPDSETIDX */
7737 NULL, /* SADB_X_SPDEXPIRE */
7738 key_spddelete2, /* SADB_X_SPDDELETE2 */
7742 * parse sadb_msg buffer to process PFKEYv2,
7743 * and create a data to response if needed.
7744 * I think to be dealed with mbuf directly.
7746 * msgp : pointer to pointer to a received buffer pulluped.
7747 * This is rewrited to response.
7748 * so : pointer to socket.
7750 * length for buffer to send to user process.
7753 key_parse(struct mbuf *m, struct socket *so)
7755 struct sadb_msg *msg;
7756 struct sadb_msghdr mh;
7761 IPSEC_ASSERT(so != NULL, ("null socket"));
7762 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7764 if (m->m_len < sizeof(struct sadb_msg)) {
7765 m = m_pullup(m, sizeof(struct sadb_msg));
7769 msg = mtod(m, struct sadb_msg *);
7770 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7771 target = KEY_SENDUP_ONE;
7773 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7774 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7775 PFKEYSTAT_INC(out_invlen);
7780 if (msg->sadb_msg_version != PF_KEY_V2) {
7781 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7782 __func__, msg->sadb_msg_version));
7783 PFKEYSTAT_INC(out_invver);
7788 if (msg->sadb_msg_type > SADB_MAX) {
7789 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7790 __func__, msg->sadb_msg_type));
7791 PFKEYSTAT_INC(out_invmsgtype);
7796 /* for old-fashioned code - should be nuked */
7797 if (m->m_pkthdr.len > MCLBYTES) {
7804 MGETHDR(n, M_NOWAIT, MT_DATA);
7805 if (n && m->m_pkthdr.len > MHLEN) {
7806 if (!(MCLGET(n, M_NOWAIT))) {
7815 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7816 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7822 /* align the mbuf chain so that extensions are in contiguous region. */
7823 error = key_align(m, &mh);
7829 /* We use satype as scope mask for spddump */
7830 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7831 switch (msg->sadb_msg_satype) {
7832 case IPSEC_POLICYSCOPE_ANY:
7833 case IPSEC_POLICYSCOPE_GLOBAL:
7834 case IPSEC_POLICYSCOPE_IFNET:
7835 case IPSEC_POLICYSCOPE_PCB:
7838 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7839 __func__, msg->sadb_msg_type));
7840 PFKEYSTAT_INC(out_invsatype);
7845 switch (msg->sadb_msg_satype) { /* check SA type */
7846 case SADB_SATYPE_UNSPEC:
7847 switch (msg->sadb_msg_type) {
7855 ipseclog((LOG_DEBUG, "%s: must specify satype "
7856 "when msg type=%u.\n", __func__,
7857 msg->sadb_msg_type));
7858 PFKEYSTAT_INC(out_invsatype);
7863 case SADB_SATYPE_AH:
7864 case SADB_SATYPE_ESP:
7865 case SADB_X_SATYPE_IPCOMP:
7866 case SADB_X_SATYPE_TCPSIGNATURE:
7867 switch (msg->sadb_msg_type) {
7869 case SADB_X_SPDDELETE:
7871 case SADB_X_SPDFLUSH:
7872 case SADB_X_SPDSETIDX:
7873 case SADB_X_SPDUPDATE:
7874 case SADB_X_SPDDELETE2:
7875 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7876 __func__, msg->sadb_msg_type));
7877 PFKEYSTAT_INC(out_invsatype);
7882 case SADB_SATYPE_RSVP:
7883 case SADB_SATYPE_OSPFV2:
7884 case SADB_SATYPE_RIPV2:
7885 case SADB_SATYPE_MIP:
7886 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7887 __func__, msg->sadb_msg_satype));
7888 PFKEYSTAT_INC(out_invsatype);
7891 case 1: /* XXX: What does it do? */
7892 if (msg->sadb_msg_type == SADB_X_PROMISC)
7896 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7897 __func__, msg->sadb_msg_satype));
7898 PFKEYSTAT_INC(out_invsatype);
7904 /* check field of upper layer protocol and address family */
7905 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7906 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7907 struct sadb_address *src0, *dst0;
7910 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7911 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7913 /* check upper layer protocol */
7914 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7915 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7916 "mismatched.\n", __func__));
7917 PFKEYSTAT_INC(out_invaddr);
7923 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7924 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7925 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7927 PFKEYSTAT_INC(out_invaddr);
7931 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7932 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7933 ipseclog((LOG_DEBUG, "%s: address struct size "
7934 "mismatched.\n", __func__));
7935 PFKEYSTAT_INC(out_invaddr);
7940 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7942 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7943 sizeof(struct sockaddr_in)) {
7944 PFKEYSTAT_INC(out_invaddr);
7950 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7951 sizeof(struct sockaddr_in6)) {
7952 PFKEYSTAT_INC(out_invaddr);
7958 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7960 PFKEYSTAT_INC(out_invaddr);
7961 error = EAFNOSUPPORT;
7965 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7967 plen = sizeof(struct in_addr) << 3;
7970 plen = sizeof(struct in6_addr) << 3;
7973 plen = 0; /*fool gcc*/
7977 /* check max prefix length */
7978 if (src0->sadb_address_prefixlen > plen ||
7979 dst0->sadb_address_prefixlen > plen) {
7980 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7982 PFKEYSTAT_INC(out_invaddr);
7988 * prefixlen == 0 is valid because there can be a case when
7989 * all addresses are matched.
7993 if (msg->sadb_msg_type >= nitems(key_typesw) ||
7994 key_typesw[msg->sadb_msg_type] == NULL) {
7995 PFKEYSTAT_INC(out_invmsgtype);
8000 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
8003 msg->sadb_msg_errno = error;
8004 return key_sendup_mbuf(so, m, target);
8008 key_senderror(struct socket *so, struct mbuf *m, int code)
8010 struct sadb_msg *msg;
8012 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8013 ("mbuf too small, len %u", m->m_len));
8015 msg = mtod(m, struct sadb_msg *);
8016 msg->sadb_msg_errno = code;
8017 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
8021 * set the pointer to each header into message buffer.
8022 * m will be freed on error.
8023 * XXX larger-than-MCLBYTES extension?
8026 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
8029 struct sadb_ext *ext;
8034 IPSEC_ASSERT(m != NULL, ("null mbuf"));
8035 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
8036 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8037 ("mbuf too small, len %u", m->m_len));
8040 bzero(mhp, sizeof(*mhp));
8042 mhp->msg = mtod(m, struct sadb_msg *);
8043 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
8045 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
8046 extlen = end; /*just in case extlen is not updated*/
8047 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
8048 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
8050 /* m is already freed */
8053 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8056 switch (ext->sadb_ext_type) {
8058 case SADB_EXT_ADDRESS_SRC:
8059 case SADB_EXT_ADDRESS_DST:
8060 case SADB_EXT_ADDRESS_PROXY:
8061 case SADB_EXT_LIFETIME_CURRENT:
8062 case SADB_EXT_LIFETIME_HARD:
8063 case SADB_EXT_LIFETIME_SOFT:
8064 case SADB_EXT_KEY_AUTH:
8065 case SADB_EXT_KEY_ENCRYPT:
8066 case SADB_EXT_IDENTITY_SRC:
8067 case SADB_EXT_IDENTITY_DST:
8068 case SADB_EXT_SENSITIVITY:
8069 case SADB_EXT_PROPOSAL:
8070 case SADB_EXT_SUPPORTED_AUTH:
8071 case SADB_EXT_SUPPORTED_ENCRYPT:
8072 case SADB_EXT_SPIRANGE:
8073 case SADB_X_EXT_POLICY:
8074 case SADB_X_EXT_SA2:
8075 case SADB_X_EXT_NAT_T_TYPE:
8076 case SADB_X_EXT_NAT_T_SPORT:
8077 case SADB_X_EXT_NAT_T_DPORT:
8078 case SADB_X_EXT_NAT_T_OAI:
8079 case SADB_X_EXT_NAT_T_OAR:
8080 case SADB_X_EXT_NAT_T_FRAG:
8081 case SADB_X_EXT_SA_REPLAY:
8082 case SADB_X_EXT_NEW_ADDRESS_SRC:
8083 case SADB_X_EXT_NEW_ADDRESS_DST:
8084 /* duplicate check */
8086 * XXX Are there duplication payloads of either
8087 * KEY_AUTH or KEY_ENCRYPT ?
8089 if (mhp->ext[ext->sadb_ext_type] != NULL) {
8090 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
8091 "%u\n", __func__, ext->sadb_ext_type));
8093 PFKEYSTAT_INC(out_dupext);
8098 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
8099 __func__, ext->sadb_ext_type));
8101 PFKEYSTAT_INC(out_invexttype);
8105 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
8107 if (key_validate_ext(ext, extlen)) {
8109 PFKEYSTAT_INC(out_invlen);
8113 n = m_pulldown(m, off, extlen, &toff);
8115 /* m is already freed */
8118 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8120 mhp->ext[ext->sadb_ext_type] = ext;
8121 mhp->extoff[ext->sadb_ext_type] = off;
8122 mhp->extlen[ext->sadb_ext_type] = extlen;
8127 PFKEYSTAT_INC(out_invlen);
8135 key_validate_ext(const struct sadb_ext *ext, int len)
8137 const struct sockaddr *sa;
8138 enum { NONE, ADDR } checktype = NONE;
8140 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8142 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8145 /* if it does not match minimum/maximum length, bail */
8146 if (ext->sadb_ext_type >= nitems(minsize) ||
8147 ext->sadb_ext_type >= nitems(maxsize))
8149 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8151 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8154 /* more checks based on sadb_ext_type XXX need more */
8155 switch (ext->sadb_ext_type) {
8156 case SADB_EXT_ADDRESS_SRC:
8157 case SADB_EXT_ADDRESS_DST:
8158 case SADB_EXT_ADDRESS_PROXY:
8159 case SADB_X_EXT_NAT_T_OAI:
8160 case SADB_X_EXT_NAT_T_OAR:
8161 case SADB_X_EXT_NEW_ADDRESS_SRC:
8162 case SADB_X_EXT_NEW_ADDRESS_DST:
8163 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8166 case SADB_EXT_IDENTITY_SRC:
8167 case SADB_EXT_IDENTITY_DST:
8168 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8169 SADB_X_IDENTTYPE_ADDR) {
8170 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8180 switch (checktype) {
8184 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8185 if (len < baselen + sal)
8187 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8200 TUNABLE_INT_FETCH("net.key.spdcache.maxentries",
8201 &V_key_spdcache_maxentries);
8202 TUNABLE_INT_FETCH("net.key.spdcache.threshold",
8203 &V_key_spdcache_threshold);
8205 if (V_key_spdcache_maxentries) {
8206 V_key_spdcache_maxentries = MAX(V_key_spdcache_maxentries,
8207 SPDCACHE_MAX_ENTRIES_PER_HASH);
8208 V_spdcachehashtbl = hashinit(V_key_spdcache_maxentries /
8209 SPDCACHE_MAX_ENTRIES_PER_HASH,
8210 M_IPSEC_SPDCACHE, &V_spdcachehash_mask);
8211 V_key_spdcache_maxentries = (V_spdcachehash_mask + 1)
8212 * SPDCACHE_MAX_ENTRIES_PER_HASH;
8214 V_spdcache_lock = malloc(sizeof(struct mtx) *
8215 (V_spdcachehash_mask + 1),
8216 M_IPSEC_SPDCACHE, M_WAITOK|M_ZERO);
8218 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8219 SPDCACHE_LOCK_INIT(i);
8223 struct spdcache_entry *
8224 spdcache_entry_alloc(const struct secpolicyindex *spidx, struct secpolicy *sp)
8226 struct spdcache_entry *entry;
8228 entry = malloc(sizeof(struct spdcache_entry),
8229 M_IPSEC_SPDCACHE, M_NOWAIT|M_ZERO);
8236 entry->spidx = *spidx;
8243 spdcache_entry_free(struct spdcache_entry *entry)
8246 if (entry->sp != NULL)
8247 key_freesp(&entry->sp);
8248 free(entry, M_IPSEC_SPDCACHE);
8252 spdcache_clear(void)
8254 struct spdcache_entry *entry;
8257 for (i = 0; i < V_spdcachehash_mask + 1; ++i) {
8259 while (!LIST_EMPTY(&V_spdcachehashtbl[i])) {
8260 entry = LIST_FIRST(&V_spdcachehashtbl[i]);
8261 LIST_REMOVE(entry, chain);
8262 spdcache_entry_free(entry);
8270 spdcache_destroy(void)
8274 if (SPDCACHE_ENABLED()) {
8276 hashdestroy(V_spdcachehashtbl, M_IPSEC_SPDCACHE, V_spdcachehash_mask);
8278 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8279 SPDCACHE_LOCK_DESTROY(i);
8281 free(V_spdcache_lock, M_IPSEC_SPDCACHE);
8290 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8291 TAILQ_INIT(&V_sptree[i]);
8292 TAILQ_INIT(&V_sptree_ifnet[i]);
8295 V_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8296 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8297 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8299 TAILQ_INIT(&V_sahtree);
8300 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8301 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8302 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8303 &V_sahaddrhash_mask);
8304 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8305 &V_acqaddrhash_mask);
8306 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8307 &V_acqseqhash_mask);
8311 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8312 LIST_INIT(&V_regtree[i]);
8314 LIST_INIT(&V_acqtree);
8315 LIST_INIT(&V_spacqtree);
8317 if (!IS_DEFAULT_VNET(curvnet))
8321 REGTREE_LOCK_INIT();
8322 SAHTREE_LOCK_INIT();
8326 #ifndef IPSEC_DEBUG2
8327 callout_init(&key_timer, 1);
8328 callout_reset(&key_timer, hz, key_timehandler, NULL);
8329 #endif /*IPSEC_DEBUG2*/
8331 /* initialize key statistics */
8332 keystat.getspi_count = 1;
8335 printf("IPsec: Initialized Security Association Processing.\n");
8342 struct secashead_queue sahdrainq;
8343 struct secpolicy_queue drainq;
8344 struct secpolicy *sp, *nextsp;
8345 struct secacq *acq, *nextacq;
8346 struct secspacq *spacq, *nextspacq;
8347 struct secashead *sah;
8348 struct secasvar *sav;
8353 * XXX: can we just call free() for each object without
8354 * walking through safe way with releasing references?
8356 TAILQ_INIT(&drainq);
8358 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8359 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8360 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8362 for (i = 0; i < V_sphash_mask + 1; i++)
8363 LIST_INIT(&V_sphashtbl[i]);
8367 sp = TAILQ_FIRST(&drainq);
8368 while (sp != NULL) {
8369 nextsp = TAILQ_NEXT(sp, chain);
8374 TAILQ_INIT(&sahdrainq);
8376 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8377 for (i = 0; i < V_savhash_mask + 1; i++)
8378 LIST_INIT(&V_savhashtbl[i]);
8379 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8380 LIST_INIT(&V_sahaddrhashtbl[i]);
8381 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8382 sah->state = SADB_SASTATE_DEAD;
8383 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8384 sav->state = SADB_SASTATE_DEAD;
8386 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8387 sav->state = SADB_SASTATE_DEAD;
8392 key_freesah_flushed(&sahdrainq);
8393 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8394 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8395 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8398 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8399 LIST_FOREACH(reg, &V_regtree[i], chain) {
8400 if (__LIST_CHAINED(reg)) {
8401 LIST_REMOVE(reg, chain);
8402 free(reg, M_IPSEC_SAR);
8410 acq = LIST_FIRST(&V_acqtree);
8411 while (acq != NULL) {
8412 nextacq = LIST_NEXT(acq, chain);
8413 LIST_REMOVE(acq, chain);
8414 free(acq, M_IPSEC_SAQ);
8417 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8418 LIST_INIT(&V_acqaddrhashtbl[i]);
8419 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8420 LIST_INIT(&V_acqseqhashtbl[i]);
8424 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8425 spacq = nextspacq) {
8426 nextspacq = LIST_NEXT(spacq, chain);
8427 if (__LIST_CHAINED(spacq)) {
8428 LIST_REMOVE(spacq, chain);
8429 free(spacq, M_IPSEC_SAQ);
8433 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8434 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8435 uma_zdestroy(V_key_lft_zone);
8437 if (!IS_DEFAULT_VNET(curvnet))
8439 #ifndef IPSEC_DEBUG2
8440 callout_drain(&key_timer);
8442 SPTREE_LOCK_DESTROY();
8443 REGTREE_LOCK_DESTROY();
8444 SAHTREE_LOCK_DESTROY();
8446 SPACQ_LOCK_DESTROY();
8450 /* record data transfer on SA, and update timestamps */
8452 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8454 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8455 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8458 * XXX Currently, there is a difference of bytes size
8459 * between inbound and outbound processing.
8461 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8464 * We use the number of packets as the unit of
8465 * allocations. We increment the variable
8466 * whenever {esp,ah}_{in,out}put is called.
8468 counter_u64_add(sav->lft_c_allocations, 1);
8471 * NOTE: We record CURRENT usetime by using wall clock,
8472 * in seconds. HARD and SOFT lifetime are measured by the time
8473 * difference (again in seconds) from usetime.
8477 * -----+-----+--------+---> t
8478 * <--------------> HARD
8481 if (sav->firstused == 0)
8482 sav->firstused = time_second;
8486 * Take one of the kernel's security keys and convert it into a PF_KEY
8487 * structure within an mbuf, suitable for sending up to a waiting
8488 * application in user land.
8491 * src: A pointer to a kernel security key.
8492 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8494 * a valid mbuf or NULL indicating an error
8498 static struct mbuf *
8499 key_setkey(struct seckey *src, uint16_t exttype)
8508 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8509 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8514 p = mtod(m, struct sadb_key *);
8516 p->sadb_key_len = PFKEY_UNIT64(len);
8517 p->sadb_key_exttype = exttype;
8518 p->sadb_key_bits = src->bits;
8519 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8525 * Take one of the kernel's lifetime data structures and convert it
8526 * into a PF_KEY structure within an mbuf, suitable for sending up to
8527 * a waiting application in user land.
8530 * src: A pointer to a kernel lifetime structure.
8531 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8532 * data structures for more information.
8534 * a valid mbuf or NULL indicating an error
8538 static struct mbuf *
8539 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8541 struct mbuf *m = NULL;
8542 struct sadb_lifetime *p;
8543 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8548 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8553 p = mtod(m, struct sadb_lifetime *);
8556 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8557 p->sadb_lifetime_exttype = exttype;
8558 p->sadb_lifetime_allocations = src->allocations;
8559 p->sadb_lifetime_bytes = src->bytes;
8560 p->sadb_lifetime_addtime = src->addtime;
8561 p->sadb_lifetime_usetime = src->usetime;
8567 const struct enc_xform *
8568 enc_algorithm_lookup(int alg)
8572 for (i = 0; i < nitems(supported_ealgs); i++)
8573 if (alg == supported_ealgs[i].sadb_alg)
8574 return (supported_ealgs[i].xform);
8578 const struct auth_hash *
8579 auth_algorithm_lookup(int alg)
8583 for (i = 0; i < nitems(supported_aalgs); i++)
8584 if (alg == supported_aalgs[i].sadb_alg)
8585 return (supported_aalgs[i].xform);
8589 const struct comp_algo *
8590 comp_algorithm_lookup(int alg)
8594 for (i = 0; i < nitems(supported_calgs); i++)
8595 if (alg == supported_calgs[i].sadb_alg)
8596 return (supported_calgs[i].xform);