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 static VNET_DEFINE(u_int, key_spi_trycnt) = 1000;
117 static VNET_DEFINE(u_int32_t, key_spi_minval) = 0x100;
118 static VNET_DEFINE(u_int32_t, key_spi_maxval) = 0x0fffffff; /* XXX */
119 static VNET_DEFINE(u_int32_t, policy_id) = 0;
120 /*interval to initialize randseed,1(m)*/
121 static VNET_DEFINE(u_int, key_int_random) = 60;
122 /* interval to expire acquiring, 30(s)*/
123 static VNET_DEFINE(u_int, key_larval_lifetime) = 30;
124 /* counter for blocking SADB_ACQUIRE.*/
125 static VNET_DEFINE(int, key_blockacq_count) = 10;
126 /* lifetime for blocking SADB_ACQUIRE.*/
127 static VNET_DEFINE(int, key_blockacq_lifetime) = 20;
128 /* preferred old sa rather than new sa.*/
129 static VNET_DEFINE(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 static VNET_DEFINE(u_int32_t, acq_seq) = 0;
141 #define V_acq_seq VNET(acq_seq)
143 static VNET_DEFINE(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 static VNET_DEFINE(struct secpolicy_queue, sptree[IPSEC_DIR_MAX]);
150 static VNET_DEFINE(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 static VNET_DEFINE(struct secpolicy_list *, sphashtbl);
167 static VNET_DEFINE(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 static VNET_DEFINE(u_int, key_spdcache_maxentries) = 0;
188 #define V_key_spdcache_maxentries VNET(key_spdcache_maxentries)
189 static VNET_DEFINE(u_int, key_spdcache_threshold) = 32;
190 #define V_key_spdcache_threshold VNET(key_spdcache_threshold)
191 static VNET_DEFINE(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 static VNET_DEFINE(struct spdcache_entry_list *, spdcachehashtbl);
199 static VNET_DEFINE(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 static VNET_DEFINE(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 static VNET_DEFINE(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 static VNET_DEFINE(struct secashead_list *, sahaddrhashtbl);
237 static VNET_DEFINE(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 static VNET_DEFINE(struct secasvar_list *, savhashtbl);
252 static VNET_DEFINE(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",
288 __func__, dst->sa.sa_family));
294 key_u32hash(uint32_t val)
297 return (fnv_32_buf(&val, sizeof(val), FNV1_32_INIT));
301 static VNET_DEFINE(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 static VNET_DEFINE(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 static VNET_DEFINE(struct secacq_list *, acqaddrhashtbl);
325 static VNET_DEFINE(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 static VNET_DEFINE(struct secacq_list *, acqseqhashtbl);
331 static VNET_DEFINE(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 static VNET_DEFINE(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 static VNET_DEFINE(int, ipsec_esp_keymin) = 256;
437 static VNET_DEFINE(int, ipsec_esp_auth) = 0;
438 static VNET_DEFINE(int, ipsec_ah_keymin) = 128;
440 #define V_ipsec_esp_keymin VNET(ipsec_esp_keymin)
441 #define V_ipsec_esp_auth VNET(ipsec_esp_auth)
442 #define V_ipsec_ah_keymin VNET(ipsec_ah_keymin)
445 VNET_DEFINE(int, ipsec_debug) = 1;
447 VNET_DEFINE(int, ipsec_debug) = 0;
451 SYSCTL_DECL(_net_inet_ipsec);
452 SYSCTL_INT(_net_inet_ipsec, IPSECCTL_DEBUG, debug,
453 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
454 "Enable IPsec debugging output when set.");
457 SYSCTL_DECL(_net_inet6_ipsec6);
458 SYSCTL_INT(_net_inet6_ipsec6, IPSECCTL_DEBUG, debug,
459 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_debug), 0,
460 "Enable IPsec debugging output when set.");
463 SYSCTL_DECL(_net_key);
464 SYSCTL_INT(_net_key, KEYCTL_DEBUG_LEVEL, debug,
465 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_debug_level), 0, "");
467 /* max count of trial for the decision of spi value */
468 SYSCTL_INT(_net_key, KEYCTL_SPI_TRY, spi_trycnt,
469 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_trycnt), 0, "");
471 /* minimum spi value to allocate automatically. */
472 SYSCTL_INT(_net_key, KEYCTL_SPI_MIN_VALUE, spi_minval,
473 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_minval), 0, "");
475 /* maximun spi value to allocate automatically. */
476 SYSCTL_INT(_net_key, KEYCTL_SPI_MAX_VALUE, spi_maxval,
477 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_spi_maxval), 0, "");
479 /* interval to initialize randseed */
480 SYSCTL_INT(_net_key, KEYCTL_RANDOM_INT, int_random,
481 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_int_random), 0, "");
483 /* lifetime for larval SA */
484 SYSCTL_INT(_net_key, KEYCTL_LARVAL_LIFETIME, larval_lifetime,
485 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_larval_lifetime), 0, "");
487 /* counter for blocking to send SADB_ACQUIRE to IKEd */
488 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_COUNT, blockacq_count,
489 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_count), 0, "");
491 /* lifetime for blocking to send SADB_ACQUIRE to IKEd */
492 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_LIFETIME, blockacq_lifetime,
493 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_blockacq_lifetime), 0, "");
496 SYSCTL_INT(_net_key, KEYCTL_ESP_AUTH, esp_auth,
497 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_auth), 0, "");
499 /* minimum ESP key length */
500 SYSCTL_INT(_net_key, KEYCTL_ESP_KEYMIN, esp_keymin,
501 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_esp_keymin), 0, "");
503 /* minimum AH key length */
504 SYSCTL_INT(_net_key, KEYCTL_AH_KEYMIN, ah_keymin,
505 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipsec_ah_keymin), 0, "");
507 /* perfered old SA rather than new SA */
508 SYSCTL_INT(_net_key, KEYCTL_PREFERED_OLDSA, preferred_oldsa,
509 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(key_preferred_oldsa), 0, "");
511 static SYSCTL_NODE(_net_key, OID_AUTO, spdcache, CTLFLAG_RW, 0, "SPD cache");
513 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, maxentries,
514 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_maxentries), 0,
515 "Maximum number of entries in the SPD cache"
516 " (power of 2, 0 to disable)");
518 SYSCTL_UINT(_net_key_spdcache, OID_AUTO, threshold,
519 CTLFLAG_VNET | CTLFLAG_RDTUN, &VNET_NAME(key_spdcache_threshold), 0,
520 "Number of SPs that make the SPD cache active");
522 #define __LIST_CHAINED(elm) \
523 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
525 MALLOC_DEFINE(M_IPSEC_SA, "secasvar", "ipsec security association");
526 MALLOC_DEFINE(M_IPSEC_SAH, "sahead", "ipsec sa head");
527 MALLOC_DEFINE(M_IPSEC_SP, "ipsecpolicy", "ipsec security policy");
528 MALLOC_DEFINE(M_IPSEC_SR, "ipsecrequest", "ipsec security request");
529 MALLOC_DEFINE(M_IPSEC_MISC, "ipsec-misc", "ipsec miscellaneous");
530 MALLOC_DEFINE(M_IPSEC_SAQ, "ipsec-saq", "ipsec sa acquire");
531 MALLOC_DEFINE(M_IPSEC_SAR, "ipsec-reg", "ipsec sa acquire");
532 MALLOC_DEFINE(M_IPSEC_SPDCACHE, "ipsec-spdcache", "ipsec SPD cache");
534 static VNET_DEFINE(uma_zone_t, key_lft_zone);
535 #define V_key_lft_zone VNET(key_lft_zone)
537 static LIST_HEAD(xforms_list, xformsw) xforms = LIST_HEAD_INITIALIZER();
538 static struct mtx xforms_lock;
539 #define XFORMS_LOCK_INIT() \
540 mtx_init(&xforms_lock, "xforms_list", "IPsec transforms list", MTX_DEF)
541 #define XFORMS_LOCK_DESTROY() mtx_destroy(&xforms_lock)
542 #define XFORMS_LOCK() mtx_lock(&xforms_lock)
543 #define XFORMS_UNLOCK() mtx_unlock(&xforms_lock)
546 * set parameters into secpolicyindex buffer.
547 * Must allocate secpolicyindex buffer passed to this function.
549 #define KEY_SETSECSPIDX(_dir, s, d, ps, pd, ulp, idx) \
551 bzero((idx), sizeof(struct secpolicyindex)); \
552 (idx)->dir = (_dir); \
553 (idx)->prefs = (ps); \
554 (idx)->prefd = (pd); \
555 (idx)->ul_proto = (ulp); \
556 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
557 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
561 * set parameters into secasindex buffer.
562 * Must allocate secasindex buffer before calling this function.
564 #define KEY_SETSECASIDX(p, m, r, s, d, idx) \
566 bzero((idx), sizeof(struct secasindex)); \
567 (idx)->proto = (p); \
569 (idx)->reqid = (r); \
570 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
571 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
572 key_porttosaddr(&(idx)->src.sa, 0); \
573 key_porttosaddr(&(idx)->dst.sa, 0); \
578 u_long getspi_count; /* the avarage of count to try to get new SPI */
582 struct sadb_msg *msg;
583 struct sadb_ext *ext[SADB_EXT_MAX + 1];
584 int extoff[SADB_EXT_MAX + 1];
585 int extlen[SADB_EXT_MAX + 1];
588 static struct supported_ealgs {
590 const struct enc_xform *xform;
591 } supported_ealgs[] = {
592 { SADB_EALG_DESCBC, &enc_xform_des },
593 { SADB_EALG_3DESCBC, &enc_xform_3des },
594 { SADB_X_EALG_AES, &enc_xform_rijndael128 },
595 { SADB_X_EALG_BLOWFISHCBC, &enc_xform_blf },
596 { SADB_X_EALG_CAST128CBC, &enc_xform_cast5 },
597 { SADB_EALG_NULL, &enc_xform_null },
598 { SADB_X_EALG_CAMELLIACBC, &enc_xform_camellia },
599 { SADB_X_EALG_AESCTR, &enc_xform_aes_icm },
600 { SADB_X_EALG_AESGCM16, &enc_xform_aes_nist_gcm },
601 { SADB_X_EALG_AESGMAC, &enc_xform_aes_nist_gmac },
604 static struct supported_aalgs {
606 const struct auth_hash *xform;
607 } supported_aalgs[] = {
608 { SADB_X_AALG_NULL, &auth_hash_null },
609 { SADB_AALG_MD5HMAC, &auth_hash_hmac_md5 },
610 { SADB_AALG_SHA1HMAC, &auth_hash_hmac_sha1 },
611 { SADB_X_AALG_RIPEMD160HMAC, &auth_hash_hmac_ripemd_160 },
612 { SADB_X_AALG_MD5, &auth_hash_key_md5 },
613 { SADB_X_AALG_SHA, &auth_hash_key_sha1 },
614 { SADB_X_AALG_SHA2_256, &auth_hash_hmac_sha2_256 },
615 { SADB_X_AALG_SHA2_384, &auth_hash_hmac_sha2_384 },
616 { SADB_X_AALG_SHA2_512, &auth_hash_hmac_sha2_512 },
617 { SADB_X_AALG_AES128GMAC, &auth_hash_nist_gmac_aes_128 },
618 { SADB_X_AALG_AES192GMAC, &auth_hash_nist_gmac_aes_192 },
619 { SADB_X_AALG_AES256GMAC, &auth_hash_nist_gmac_aes_256 },
622 static struct supported_calgs {
624 const struct comp_algo *xform;
625 } supported_calgs[] = {
626 { SADB_X_CALG_DEFLATE, &comp_algo_deflate },
630 static struct callout key_timer;
633 static void key_unlink(struct secpolicy *);
634 static struct secpolicy *key_do_allocsp(struct secpolicyindex *spidx, u_int dir);
635 static struct secpolicy *key_getsp(struct secpolicyindex *);
636 static struct secpolicy *key_getspbyid(u_int32_t);
637 static struct mbuf *key_gather_mbuf(struct mbuf *,
638 const struct sadb_msghdr *, int, int, ...);
639 static int key_spdadd(struct socket *, struct mbuf *,
640 const struct sadb_msghdr *);
641 static uint32_t key_getnewspid(void);
642 static int key_spddelete(struct socket *, struct mbuf *,
643 const struct sadb_msghdr *);
644 static int key_spddelete2(struct socket *, struct mbuf *,
645 const struct sadb_msghdr *);
646 static int key_spdget(struct socket *, struct mbuf *,
647 const struct sadb_msghdr *);
648 static int key_spdflush(struct socket *, struct mbuf *,
649 const struct sadb_msghdr *);
650 static int key_spddump(struct socket *, struct mbuf *,
651 const struct sadb_msghdr *);
652 static struct mbuf *key_setdumpsp(struct secpolicy *,
653 u_int8_t, u_int32_t, u_int32_t);
654 static struct mbuf *key_sp2mbuf(struct secpolicy *);
655 static size_t key_getspreqmsglen(struct secpolicy *);
656 static int key_spdexpire(struct secpolicy *);
657 static struct secashead *key_newsah(struct secasindex *);
658 static void key_freesah(struct secashead **);
659 static void key_delsah(struct secashead *);
660 static struct secasvar *key_newsav(const struct sadb_msghdr *,
661 struct secasindex *, uint32_t, int *);
662 static void key_delsav(struct secasvar *);
663 static void key_unlinksav(struct secasvar *);
664 static struct secashead *key_getsah(struct secasindex *);
665 static int key_checkspidup(uint32_t);
666 static struct secasvar *key_getsavbyspi(uint32_t);
667 static int key_setnatt(struct secasvar *, const struct sadb_msghdr *);
668 static int key_setsaval(struct secasvar *, const struct sadb_msghdr *);
669 static int key_updatelifetimes(struct secasvar *, const struct sadb_msghdr *);
670 static int key_updateaddresses(struct socket *, struct mbuf *,
671 const struct sadb_msghdr *, struct secasvar *, struct secasindex *);
673 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
674 u_int8_t, u_int32_t, u_int32_t);
675 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
676 u_int32_t, pid_t, u_int16_t);
677 static struct mbuf *key_setsadbsa(struct secasvar *);
678 static struct mbuf *key_setsadbaddr(u_int16_t,
679 const struct sockaddr *, u_int8_t, u_int16_t);
680 static struct mbuf *key_setsadbxport(u_int16_t, u_int16_t);
681 static struct mbuf *key_setsadbxtype(u_int16_t);
682 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t);
683 static struct mbuf *key_setsadbxsareplay(u_int32_t);
684 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
685 u_int32_t, u_int32_t);
686 static struct seckey *key_dup_keymsg(const struct sadb_key *, size_t,
687 struct malloc_type *);
688 static struct seclifetime *key_dup_lifemsg(const struct sadb_lifetime *src,
689 struct malloc_type *);
691 /* flags for key_cmpsaidx() */
692 #define CMP_HEAD 1 /* protocol, addresses. */
693 #define CMP_MODE_REQID 2 /* additionally HEAD, reqid, mode. */
694 #define CMP_REQID 3 /* additionally HEAD, reaid. */
695 #define CMP_EXACTLY 4 /* all elements. */
696 static int key_cmpsaidx(const struct secasindex *,
697 const struct secasindex *, int);
698 static int key_cmpspidx_exactly(struct secpolicyindex *,
699 struct secpolicyindex *);
700 static int key_cmpspidx_withmask(struct secpolicyindex *,
701 struct secpolicyindex *);
702 static int key_bbcmp(const void *, const void *, u_int);
703 static uint8_t key_satype2proto(uint8_t);
704 static uint8_t key_proto2satype(uint8_t);
706 static int key_getspi(struct socket *, struct mbuf *,
707 const struct sadb_msghdr *);
708 static uint32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
709 static int key_update(struct socket *, struct mbuf *,
710 const struct sadb_msghdr *);
711 static int key_add(struct socket *, struct mbuf *,
712 const struct sadb_msghdr *);
713 static int key_setident(struct secashead *, const struct sadb_msghdr *);
714 static struct mbuf *key_getmsgbuf_x1(struct mbuf *,
715 const struct sadb_msghdr *);
716 static int key_delete(struct socket *, struct mbuf *,
717 const struct sadb_msghdr *);
718 static int key_delete_all(struct socket *, struct mbuf *,
719 const struct sadb_msghdr *, struct secasindex *);
720 static void key_delete_xform(const struct xformsw *);
721 static int key_get(struct socket *, struct mbuf *,
722 const struct sadb_msghdr *);
724 static void key_getcomb_setlifetime(struct sadb_comb *);
725 static struct mbuf *key_getcomb_ealg(void);
726 static struct mbuf *key_getcomb_ah(void);
727 static struct mbuf *key_getcomb_ipcomp(void);
728 static struct mbuf *key_getprop(const struct secasindex *);
730 static int key_acquire(const struct secasindex *, struct secpolicy *);
731 static uint32_t key_newacq(const struct secasindex *, int *);
732 static uint32_t key_getacq(const struct secasindex *, int *);
733 static int key_acqdone(const struct secasindex *, uint32_t);
734 static int key_acqreset(uint32_t);
735 static struct secspacq *key_newspacq(struct secpolicyindex *);
736 static struct secspacq *key_getspacq(struct secpolicyindex *);
737 static int key_acquire2(struct socket *, struct mbuf *,
738 const struct sadb_msghdr *);
739 static int key_register(struct socket *, struct mbuf *,
740 const struct sadb_msghdr *);
741 static int key_expire(struct secasvar *, int);
742 static int key_flush(struct socket *, struct mbuf *,
743 const struct sadb_msghdr *);
744 static int key_dump(struct socket *, struct mbuf *,
745 const struct sadb_msghdr *);
746 static int key_promisc(struct socket *, struct mbuf *,
747 const struct sadb_msghdr *);
748 static int key_senderror(struct socket *, struct mbuf *, int);
749 static int key_validate_ext(const struct sadb_ext *, int);
750 static int key_align(struct mbuf *, struct sadb_msghdr *);
751 static struct mbuf *key_setlifetime(struct seclifetime *, uint16_t);
752 static struct mbuf *key_setkey(struct seckey *, uint16_t);
753 static int xform_init(struct secasvar *, u_short);
755 static void spdcache_init(void);
756 static void spdcache_clear(void);
757 static struct spdcache_entry *spdcache_entry_alloc(
758 const struct secpolicyindex *spidx,
759 struct secpolicy *policy);
760 static void spdcache_entry_free(struct spdcache_entry *entry);
761 static void spdcache_destroy(void);
764 #define DBG_IPSEC_INITREF(t, p) do { \
765 refcount_init(&(p)->refcnt, 1); \
767 printf("%s: Initialize refcnt %s(%p) = %u\n", \
768 __func__, #t, (p), (p)->refcnt)); \
770 #define DBG_IPSEC_ADDREF(t, p) do { \
771 refcount_acquire(&(p)->refcnt); \
773 printf("%s: Acquire refcnt %s(%p) -> %u\n", \
774 __func__, #t, (p), (p)->refcnt)); \
776 #define DBG_IPSEC_DELREF(t, p) do { \
778 printf("%s: Release refcnt %s(%p) -> %u\n", \
779 __func__, #t, (p), (p)->refcnt - 1)); \
780 refcount_release(&(p)->refcnt); \
783 #define IPSEC_INITREF(t, p) refcount_init(&(p)->refcnt, 1)
784 #define IPSEC_ADDREF(t, p) refcount_acquire(&(p)->refcnt)
785 #define IPSEC_DELREF(t, p) refcount_release(&(p)->refcnt)
787 #define SP_INITREF(p) IPSEC_INITREF(SP, p)
788 #define SP_ADDREF(p) IPSEC_ADDREF(SP, p)
789 #define SP_DELREF(p) IPSEC_DELREF(SP, p)
791 #define SAH_INITREF(p) IPSEC_INITREF(SAH, p)
792 #define SAH_ADDREF(p) IPSEC_ADDREF(SAH, p)
793 #define SAH_DELREF(p) IPSEC_DELREF(SAH, p)
795 #define SAV_INITREF(p) IPSEC_INITREF(SAV, p)
796 #define SAV_ADDREF(p) IPSEC_ADDREF(SAV, p)
797 #define SAV_DELREF(p) IPSEC_DELREF(SAV, p)
800 * Update the refcnt while holding the SPTREE lock.
803 key_addref(struct secpolicy *sp)
810 * Return 0 when there are known to be no SP's for the specified
811 * direction. Otherwise return 1. This is used by IPsec code
812 * to optimize performance.
815 key_havesp(u_int dir)
818 return (dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND ?
819 TAILQ_FIRST(&V_sptree[dir]) != NULL : 1);
822 /* %%% IPsec policy management */
824 * Return current SPDB generation.
841 key_checksockaddrs(struct sockaddr *src, struct sockaddr *dst)
845 if (src->sa_family != dst->sa_family)
848 if (src->sa_len != dst->sa_len)
850 switch (src->sa_family) {
853 if (src->sa_len != sizeof(struct sockaddr_in))
859 if (src->sa_len != sizeof(struct sockaddr_in6))
864 return (EAFNOSUPPORT);
870 key_do_allocsp(struct secpolicyindex *spidx, u_int dir)
872 SPTREE_RLOCK_TRACKER;
873 struct secpolicy *sp;
875 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
876 IPSEC_ASSERT(dir == IPSEC_DIR_INBOUND || dir == IPSEC_DIR_OUTBOUND,
877 ("invalid direction %u", dir));
880 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
881 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
892 * allocating a SP for OUTBOUND or INBOUND packet.
893 * Must call key_freesp() later.
894 * OUT: NULL: not found
895 * others: found and return the pointer.
898 key_allocsp(struct secpolicyindex *spidx, u_int dir)
900 struct spdcache_entry *entry, *lastentry, *tmpentry;
901 struct secpolicy *sp;
905 if (!SPDCACHE_ACTIVE()) {
906 sp = key_do_allocsp(spidx, dir);
910 hashv = SPDCACHE_HASHVAL(spidx);
911 SPDCACHE_LOCK(hashv);
913 LIST_FOREACH_SAFE(entry, &V_spdcachehashtbl[hashv], chain, tmpentry) {
914 /* Removed outdated entries */
915 if (entry->sp != NULL &&
916 entry->sp->state == IPSEC_SPSTATE_DEAD) {
917 LIST_REMOVE(entry, chain);
918 spdcache_entry_free(entry);
923 if (!key_cmpspidx_exactly(&entry->spidx, spidx)) {
929 if (entry->sp != NULL)
932 IPSECSTAT_INC(ips_spdcache_hits);
934 SPDCACHE_UNLOCK(hashv);
938 IPSECSTAT_INC(ips_spdcache_misses);
940 sp = key_do_allocsp(spidx, dir);
941 entry = spdcache_entry_alloc(spidx, sp);
943 if (nb_entries >= SPDCACHE_MAX_ENTRIES_PER_HASH) {
944 LIST_REMOVE(lastentry, chain);
945 spdcache_entry_free(lastentry);
948 LIST_INSERT_HEAD(&V_spdcachehashtbl[hashv], entry, chain);
951 SPDCACHE_UNLOCK(hashv);
954 if (sp != NULL) { /* found a SPD entry */
955 sp->lastused = time_second;
957 printf("%s: return SP(%p)\n", __func__, sp));
958 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
961 printf("%s: lookup failed for ", __func__);
962 kdebug_secpolicyindex(spidx, NULL));
968 * Allocating an SA entry for an *INBOUND* or *OUTBOUND* TCP packet, signed
969 * or should be signed by MD5 signature.
970 * We don't use key_allocsa() for such lookups, because we don't know SPI.
971 * Unlike ESP and AH protocols, SPI isn't transmitted in the TCP header with
972 * signed packet. We use SADB only as storage for password.
973 * OUT: positive: corresponding SA for given saidx found.
977 key_allocsa_tcpmd5(struct secasindex *saidx)
979 SAHTREE_RLOCK_TRACKER;
980 struct secashead *sah;
981 struct secasvar *sav;
983 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP,
984 ("unexpected security protocol %u", saidx->proto));
985 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TCPMD5,
986 ("unexpected mode %u", saidx->mode));
989 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
991 printf("%s: checking SAH\n", __func__);
992 kdebug_secash(sah, " "));
993 if (sah->saidx.proto != IPPROTO_TCP)
995 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
996 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
1000 if (V_key_preferred_oldsa)
1001 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1003 sav = TAILQ_FIRST(&sah->savtree_alive);
1012 printf("%s: return SA(%p)\n", __func__, sav));
1013 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1016 printf("%s: SA not found\n", __func__));
1017 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1023 * Allocating an SA entry for an *OUTBOUND* packet.
1024 * OUT: positive: corresponding SA for given saidx found.
1025 * NULL: SA not found, but will be acquired, check *error
1026 * for acquiring status.
1029 key_allocsa_policy(struct secpolicy *sp, const struct secasindex *saidx,
1032 SAHTREE_RLOCK_TRACKER;
1033 struct secashead *sah;
1034 struct secasvar *sav;
1036 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
1037 IPSEC_ASSERT(saidx->mode == IPSEC_MODE_TRANSPORT ||
1038 saidx->mode == IPSEC_MODE_TUNNEL,
1039 ("unexpected policy %u", saidx->mode));
1042 * We check new SA in the IPsec request because a different
1043 * SA may be involved each time this request is checked, either
1044 * because new SAs are being configured, or this request is
1045 * associated with an unconnected datagram socket, or this request
1046 * is associated with a system default policy.
1049 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
1051 printf("%s: checking SAH\n", __func__);
1052 kdebug_secash(sah, " "));
1053 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID))
1059 * Allocate the oldest SA available according to
1060 * draft-jenkins-ipsec-rekeying-03.
1062 if (V_key_preferred_oldsa)
1063 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1065 sav = TAILQ_FIRST(&sah->savtree_alive);
1075 printf("%s: chosen SA(%p) for SP(%p)\n", __func__,
1077 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1078 return (sav); /* return referenced SA */
1081 /* there is no SA */
1082 *error = key_acquire(saidx, sp);
1084 ipseclog((LOG_DEBUG,
1085 "%s: error %d returned from key_acquire()\n",
1088 printf("%s: acquire SA for SP(%p), error %d\n",
1089 __func__, sp, *error));
1090 KEYDBG(IPSEC_DATA, kdebug_secasindex(saidx, NULL));
1095 * allocating a usable SA entry for a *INBOUND* packet.
1096 * Must call key_freesav() later.
1097 * OUT: positive: pointer to a usable sav (i.e. MATURE or DYING state).
1098 * NULL: not found, or error occurred.
1100 * According to RFC 2401 SA is uniquely identified by a triple SPI,
1101 * destination address, and security protocol. But according to RFC 4301,
1102 * SPI by itself suffices to specify an SA.
1104 * Note that, however, we do need to keep source address in IPsec SA.
1105 * IKE specification and PF_KEY specification do assume that we
1106 * keep source address in IPsec SA. We see a tricky situation here.
1109 key_allocsa(union sockaddr_union *dst, uint8_t proto, uint32_t spi)
1111 SAHTREE_RLOCK_TRACKER;
1112 struct secasvar *sav;
1114 IPSEC_ASSERT(proto == IPPROTO_ESP || proto == IPPROTO_AH ||
1115 proto == IPPROTO_IPCOMP, ("unexpected security protocol %u",
1119 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
1120 if (sav->spi == spi)
1124 * We use single SPI namespace for all protocols, so it is
1125 * impossible to have SPI duplicates in the SAVHASH.
1128 if (sav->state != SADB_SASTATE_LARVAL &&
1129 sav->sah->saidx.proto == proto &&
1130 key_sockaddrcmp(&dst->sa,
1131 &sav->sah->saidx.dst.sa, 0) == 0)
1140 char buf[IPSEC_ADDRSTRLEN];
1141 printf("%s: SA not found for spi %u proto %u dst %s\n",
1142 __func__, ntohl(spi), proto, ipsec_address(dst, buf,
1146 printf("%s: return SA(%p)\n", __func__, sav));
1147 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1153 key_allocsa_tunnel(union sockaddr_union *src, union sockaddr_union *dst,
1156 SAHTREE_RLOCK_TRACKER;
1157 struct secasindex saidx;
1158 struct secashead *sah;
1159 struct secasvar *sav;
1161 IPSEC_ASSERT(src != NULL, ("null src address"));
1162 IPSEC_ASSERT(dst != NULL, ("null dst address"));
1164 KEY_SETSECASIDX(proto, IPSEC_MODE_TUNNEL, 0, &src->sa,
1169 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
1170 if (IPSEC_MODE_TUNNEL != sah->saidx.mode)
1172 if (proto != sah->saidx.proto)
1174 if (key_sockaddrcmp(&src->sa, &sah->saidx.src.sa, 0) != 0)
1176 if (key_sockaddrcmp(&dst->sa, &sah->saidx.dst.sa, 0) != 0)
1178 /* XXXAE: is key_preferred_oldsa reasonably?*/
1179 if (V_key_preferred_oldsa)
1180 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
1182 sav = TAILQ_FIRST(&sah->savtree_alive);
1190 printf("%s: return SA(%p)\n", __func__, sav));
1192 KEYDBG(IPSEC_DATA, kdebug_secasv(sav));
1197 * Must be called after calling key_allocsp().
1200 key_freesp(struct secpolicy **spp)
1202 struct secpolicy *sp = *spp;
1204 IPSEC_ASSERT(sp != NULL, ("null sp"));
1205 if (SP_DELREF(sp) == 0)
1209 printf("%s: last reference to SP(%p)\n", __func__, sp));
1210 KEYDBG(IPSEC_DATA, kdebug_secpolicy(sp));
1213 while (sp->tcount > 0)
1214 ipsec_delisr(sp->req[--sp->tcount]);
1215 free(sp, M_IPSEC_SP);
1219 key_unlink(struct secpolicy *sp)
1222 IPSEC_ASSERT(sp->spidx.dir == IPSEC_DIR_INBOUND ||
1223 sp->spidx.dir == IPSEC_DIR_OUTBOUND,
1224 ("invalid direction %u", sp->spidx.dir));
1225 SPTREE_UNLOCK_ASSERT();
1228 printf("%s: SP(%p)\n", __func__, sp));
1230 if (sp->state != IPSEC_SPSTATE_ALIVE) {
1231 /* SP is already unlinked */
1235 sp->state = IPSEC_SPSTATE_DEAD;
1236 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
1238 LIST_REMOVE(sp, idhash);
1241 if (SPDCACHE_ENABLED())
1247 * insert a secpolicy into the SP database. Lower priorities first
1250 key_insertsp(struct secpolicy *newsp)
1252 struct secpolicy *sp;
1254 SPTREE_WLOCK_ASSERT();
1255 TAILQ_FOREACH(sp, &V_sptree[newsp->spidx.dir], chain) {
1256 if (newsp->priority < sp->priority) {
1257 TAILQ_INSERT_BEFORE(sp, newsp, chain);
1261 TAILQ_INSERT_TAIL(&V_sptree[newsp->spidx.dir], newsp, chain);
1263 LIST_INSERT_HEAD(SPHASH_HASH(newsp->id), newsp, idhash);
1264 newsp->state = IPSEC_SPSTATE_ALIVE;
1270 * Insert a bunch of VTI secpolicies into the SPDB.
1271 * We keep VTI policies in the separate list due to following reasons:
1272 * 1) they should be immutable to user's or some deamon's attempts to
1273 * delete. The only way delete such policies - destroy or unconfigure
1274 * corresponding virtual inteface.
1275 * 2) such policies have traffic selector that matches all traffic per
1277 * Since all VTI policies have the same priority, we don't care about
1281 key_register_ifnet(struct secpolicy **spp, u_int count)
1288 * First of try to acquire id for each SP.
1290 for (i = 0; i < count; i++) {
1291 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1292 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1293 ("invalid direction %u", spp[i]->spidx.dir));
1295 if ((spp[i]->id = key_getnewspid()) == 0) {
1300 for (i = 0; i < count; i++) {
1301 TAILQ_INSERT_TAIL(&V_sptree_ifnet[spp[i]->spidx.dir],
1304 * NOTE: despite the fact that we keep VTI SP in the
1305 * separate list, SPHASH contains policies from both
1306 * sources. Thus SADB_X_SPDGET will correctly return
1307 * SP by id, because it uses SPHASH for lookups.
1309 LIST_INSERT_HEAD(SPHASH_HASH(spp[i]->id), spp[i], idhash);
1310 spp[i]->state = IPSEC_SPSTATE_IFNET;
1314 * Notify user processes about new SP.
1316 for (i = 0; i < count; i++) {
1317 m = key_setdumpsp(spp[i], SADB_X_SPDADD, 0, 0);
1319 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1325 key_unregister_ifnet(struct secpolicy **spp, u_int count)
1331 for (i = 0; i < count; i++) {
1332 IPSEC_ASSERT(spp[i]->spidx.dir == IPSEC_DIR_INBOUND ||
1333 spp[i]->spidx.dir == IPSEC_DIR_OUTBOUND,
1334 ("invalid direction %u", spp[i]->spidx.dir));
1336 if (spp[i]->state != IPSEC_SPSTATE_IFNET)
1338 spp[i]->state = IPSEC_SPSTATE_DEAD;
1339 TAILQ_REMOVE(&V_sptree_ifnet[spp[i]->spidx.dir],
1342 LIST_REMOVE(spp[i], idhash);
1345 if (SPDCACHE_ENABLED())
1348 for (i = 0; i < count; i++) {
1349 m = key_setdumpsp(spp[i], SADB_X_SPDDELETE, 0, 0);
1351 key_sendup_mbuf(NULL, m, KEY_SENDUP_ALL);
1356 * Must be called after calling key_allocsa().
1357 * This function is called by key_freesp() to free some SA allocated
1361 key_freesav(struct secasvar **psav)
1363 struct secasvar *sav = *psav;
1365 IPSEC_ASSERT(sav != NULL, ("null sav"));
1366 if (SAV_DELREF(sav) == 0)
1370 printf("%s: last reference to SA(%p)\n", __func__, sav));
1377 * Unlink SA from SAH and SPI hash under SAHTREE_WLOCK.
1378 * Expect that SA has extra reference due to lookup.
1379 * Release this references, also release SAH reference after unlink.
1382 key_unlinksav(struct secasvar *sav)
1384 struct secashead *sah;
1387 printf("%s: SA(%p)\n", __func__, sav));
1389 SAHTREE_UNLOCK_ASSERT();
1391 if (sav->state == SADB_SASTATE_DEAD) {
1392 /* SA is already unlinked */
1396 /* Unlink from SAH */
1397 if (sav->state == SADB_SASTATE_LARVAL)
1398 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
1400 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
1401 /* Unlink from SPI hash */
1402 LIST_REMOVE(sav, spihash);
1403 sav->state = SADB_SASTATE_DEAD;
1407 /* Since we are unlinked, release reference to SAH */
1411 /* %%% SPD management */
1414 * OUT: NULL : not found
1415 * others : found, pointer to a SP.
1417 static struct secpolicy *
1418 key_getsp(struct secpolicyindex *spidx)
1420 SPTREE_RLOCK_TRACKER;
1421 struct secpolicy *sp;
1423 IPSEC_ASSERT(spidx != NULL, ("null spidx"));
1426 TAILQ_FOREACH(sp, &V_sptree[spidx->dir], chain) {
1427 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1439 * OUT: NULL : not found
1440 * others : found, pointer to referenced SP.
1442 static struct secpolicy *
1443 key_getspbyid(uint32_t id)
1445 SPTREE_RLOCK_TRACKER;
1446 struct secpolicy *sp;
1449 LIST_FOREACH(sp, SPHASH_HASH(id), idhash) {
1462 struct secpolicy *sp;
1464 sp = malloc(sizeof(*sp), M_IPSEC_SP, M_NOWAIT | M_ZERO);
1470 struct ipsecrequest *
1474 return (malloc(sizeof(struct ipsecrequest), M_IPSEC_SR,
1475 M_NOWAIT | M_ZERO));
1479 ipsec_delisr(struct ipsecrequest *p)
1482 free(p, M_IPSEC_SR);
1486 * create secpolicy structure from sadb_x_policy structure.
1487 * NOTE: `state', `secpolicyindex' and 'id' in secpolicy structure
1488 * are not set, so must be set properly later.
1491 key_msg2sp(struct sadb_x_policy *xpl0, size_t len, int *error)
1493 struct secpolicy *newsp;
1495 IPSEC_ASSERT(xpl0 != NULL, ("null xpl0"));
1496 IPSEC_ASSERT(len >= sizeof(*xpl0), ("policy too short: %zu", len));
1498 if (len != PFKEY_EXTLEN(xpl0)) {
1499 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n", __func__));
1504 if ((newsp = key_newsp()) == NULL) {
1509 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1510 newsp->policy = xpl0->sadb_x_policy_type;
1511 newsp->priority = xpl0->sadb_x_policy_priority;
1515 switch (xpl0->sadb_x_policy_type) {
1516 case IPSEC_POLICY_DISCARD:
1517 case IPSEC_POLICY_NONE:
1518 case IPSEC_POLICY_ENTRUST:
1519 case IPSEC_POLICY_BYPASS:
1522 case IPSEC_POLICY_IPSEC:
1524 struct sadb_x_ipsecrequest *xisr;
1525 struct ipsecrequest *isr;
1528 /* validity check */
1529 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1530 ipseclog((LOG_DEBUG, "%s: Invalid msg length.\n",
1537 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1538 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1542 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) ||
1543 xisr->sadb_x_ipsecrequest_len > tlen) {
1544 ipseclog((LOG_DEBUG, "%s: invalid ipsecrequest "
1545 "length.\n", __func__));
1551 if (newsp->tcount >= IPSEC_MAXREQ) {
1552 ipseclog((LOG_DEBUG,
1553 "%s: too many ipsecrequests.\n",
1560 /* allocate request buffer */
1561 /* NB: data structure is zero'd */
1562 isr = ipsec_newisr();
1564 ipseclog((LOG_DEBUG,
1565 "%s: No more memory.\n", __func__));
1571 newsp->req[newsp->tcount++] = isr;
1574 switch (xisr->sadb_x_ipsecrequest_proto) {
1577 case IPPROTO_IPCOMP:
1580 ipseclog((LOG_DEBUG,
1581 "%s: invalid proto type=%u\n", __func__,
1582 xisr->sadb_x_ipsecrequest_proto));
1584 *error = EPROTONOSUPPORT;
1588 (uint8_t)xisr->sadb_x_ipsecrequest_proto;
1590 switch (xisr->sadb_x_ipsecrequest_mode) {
1591 case IPSEC_MODE_TRANSPORT:
1592 case IPSEC_MODE_TUNNEL:
1594 case IPSEC_MODE_ANY:
1596 ipseclog((LOG_DEBUG,
1597 "%s: invalid mode=%u\n", __func__,
1598 xisr->sadb_x_ipsecrequest_mode));
1603 isr->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
1605 switch (xisr->sadb_x_ipsecrequest_level) {
1606 case IPSEC_LEVEL_DEFAULT:
1607 case IPSEC_LEVEL_USE:
1608 case IPSEC_LEVEL_REQUIRE:
1610 case IPSEC_LEVEL_UNIQUE:
1611 /* validity check */
1613 * If range violation of reqid, kernel will
1614 * update it, don't refuse it.
1616 if (xisr->sadb_x_ipsecrequest_reqid
1617 > IPSEC_MANUAL_REQID_MAX) {
1618 ipseclog((LOG_DEBUG,
1619 "%s: reqid=%d range "
1620 "violation, updated by kernel.\n",
1622 xisr->sadb_x_ipsecrequest_reqid));
1623 xisr->sadb_x_ipsecrequest_reqid = 0;
1626 /* allocate new reqid id if reqid is zero. */
1627 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
1629 if ((reqid = key_newreqid()) == 0) {
1634 isr->saidx.reqid = reqid;
1635 xisr->sadb_x_ipsecrequest_reqid = reqid;
1637 /* set it for manual keying. */
1639 xisr->sadb_x_ipsecrequest_reqid;
1644 ipseclog((LOG_DEBUG, "%s: invalid level=%u\n",
1646 xisr->sadb_x_ipsecrequest_level));
1651 isr->level = xisr->sadb_x_ipsecrequest_level;
1653 /* set IP addresses if there */
1654 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
1655 struct sockaddr *paddr;
1657 len = tlen - sizeof(*xisr);
1658 paddr = (struct sockaddr *)(xisr + 1);
1659 /* validity check */
1660 if (len < sizeof(struct sockaddr) ||
1661 len < 2 * paddr->sa_len ||
1662 paddr->sa_len > sizeof(isr->saidx.src)) {
1663 ipseclog((LOG_DEBUG, "%s: invalid "
1664 "request address length.\n",
1671 * Request length should be enough to keep
1672 * source and destination addresses.
1674 if (xisr->sadb_x_ipsecrequest_len <
1675 sizeof(*xisr) + 2 * paddr->sa_len) {
1676 ipseclog((LOG_DEBUG, "%s: invalid "
1677 "ipsecrequest length.\n",
1683 bcopy(paddr, &isr->saidx.src, paddr->sa_len);
1684 paddr = (struct sockaddr *)((caddr_t)paddr +
1687 /* validity check */
1688 if (paddr->sa_len !=
1689 isr->saidx.src.sa.sa_len) {
1690 ipseclog((LOG_DEBUG, "%s: invalid "
1691 "request address length.\n",
1697 /* AF family should match */
1698 if (paddr->sa_family !=
1699 isr->saidx.src.sa.sa_family) {
1700 ipseclog((LOG_DEBUG, "%s: address "
1701 "family doesn't match.\n",
1707 bcopy(paddr, &isr->saidx.dst, paddr->sa_len);
1710 * Addresses for TUNNEL mode requests are
1713 if (isr->saidx.mode == IPSEC_MODE_TUNNEL) {
1714 ipseclog((LOG_DEBUG, "%s: missing "
1715 "request addresses.\n", __func__));
1721 tlen -= xisr->sadb_x_ipsecrequest_len;
1723 /* validity check */
1725 ipseclog((LOG_DEBUG, "%s: becoming tlen < 0.\n",
1732 xisr = (struct sadb_x_ipsecrequest *)((caddr_t)xisr
1733 + xisr->sadb_x_ipsecrequest_len);
1735 /* XXXAE: LARVAL SP */
1736 if (newsp->tcount < 1) {
1737 ipseclog((LOG_DEBUG, "%s: valid IPSEC transforms "
1738 "not found.\n", __func__));
1746 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
1759 static uint32_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1761 if (auto_reqid == ~0)
1762 auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
1766 /* XXX should be unique check */
1767 return (auto_reqid);
1771 * copy secpolicy struct to sadb_x_policy structure indicated.
1773 static struct mbuf *
1774 key_sp2mbuf(struct secpolicy *sp)
1779 tlen = key_getspreqmsglen(sp);
1780 m = m_get2(tlen, M_NOWAIT, MT_DATA, 0);
1785 if (key_sp2msg(sp, m->m_data, &tlen) != 0) {
1793 key_sp2msg(struct secpolicy *sp, void *request, size_t *len)
1795 struct sadb_x_ipsecrequest *xisr;
1796 struct sadb_x_policy *xpl;
1797 struct ipsecrequest *isr;
1802 IPSEC_ASSERT(sp != NULL, ("null policy"));
1804 xlen = sizeof(*xpl);
1809 bzero(request, *len);
1810 xpl = (struct sadb_x_policy *)request;
1811 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
1812 xpl->sadb_x_policy_type = sp->policy;
1813 xpl->sadb_x_policy_dir = sp->spidx.dir;
1814 xpl->sadb_x_policy_id = sp->id;
1815 xpl->sadb_x_policy_priority = sp->priority;
1816 switch (sp->state) {
1817 case IPSEC_SPSTATE_IFNET:
1818 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_IFNET;
1820 case IPSEC_SPSTATE_PCB:
1821 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_PCB;
1824 xpl->sadb_x_policy_scope = IPSEC_POLICYSCOPE_GLOBAL;
1827 /* if is the policy for ipsec ? */
1828 if (sp->policy == IPSEC_POLICY_IPSEC) {
1829 p = (caddr_t)xpl + sizeof(*xpl);
1830 for (i = 0; i < sp->tcount; i++) {
1832 ilen = PFKEY_ALIGN8(sizeof(*xisr) +
1833 isr->saidx.src.sa.sa_len +
1834 isr->saidx.dst.sa.sa_len);
1838 /* Calculate needed size */
1841 xisr = (struct sadb_x_ipsecrequest *)p;
1842 xisr->sadb_x_ipsecrequest_len = ilen;
1843 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
1844 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
1845 xisr->sadb_x_ipsecrequest_level = isr->level;
1846 xisr->sadb_x_ipsecrequest_reqid = isr->saidx.reqid;
1849 bcopy(&isr->saidx.src, p, isr->saidx.src.sa.sa_len);
1850 p += isr->saidx.src.sa.sa_len;
1851 bcopy(&isr->saidx.dst, p, isr->saidx.dst.sa.sa_len);
1852 p += isr->saidx.dst.sa.sa_len;
1855 xpl->sadb_x_policy_len = PFKEY_UNIT64(xlen);
1859 *len = sizeof(*xpl);
1863 /* m will not be freed nor modified */
1864 static struct mbuf *
1865 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
1866 int ndeep, int nitem, ...)
1871 struct mbuf *result = NULL, *n;
1874 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1875 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1877 va_start(ap, nitem);
1878 for (i = 0; i < nitem; i++) {
1879 idx = va_arg(ap, int);
1880 if (idx < 0 || idx > SADB_EXT_MAX)
1882 /* don't attempt to pull empty extension */
1883 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL)
1885 if (idx != SADB_EXT_RESERVED &&
1886 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0))
1889 if (idx == SADB_EXT_RESERVED) {
1890 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
1892 IPSEC_ASSERT(len <= MHLEN, ("header too big %u", len));
1894 MGETHDR(n, M_NOWAIT, MT_DATA);
1899 m_copydata(m, 0, sizeof(struct sadb_msg),
1901 } else if (i < ndeep) {
1902 len = mhp->extlen[idx];
1903 n = m_get2(len, M_NOWAIT, MT_DATA, 0);
1908 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
1911 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
1924 if ((result->m_flags & M_PKTHDR) != 0) {
1925 result->m_pkthdr.len = 0;
1926 for (n = result; n; n = n->m_next)
1927 result->m_pkthdr.len += n->m_len;
1939 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
1940 * add an entry to SP database, when received
1941 * <base, address(SD), (lifetime(H),) policy>
1943 * Adding to SP database,
1945 * <base, address(SD), (lifetime(H),) policy>
1946 * to the socket which was send.
1948 * SPDADD set a unique policy entry.
1949 * SPDSETIDX like SPDADD without a part of policy requests.
1950 * SPDUPDATE replace a unique policy entry.
1952 * XXXAE: serialize this in PF_KEY to avoid races.
1953 * m will always be freed.
1956 key_spdadd(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
1958 struct secpolicyindex spidx;
1959 struct sadb_address *src0, *dst0;
1960 struct sadb_x_policy *xpl0, *xpl;
1961 struct sadb_lifetime *lft = NULL;
1962 struct secpolicy *newsp;
1965 IPSEC_ASSERT(so != NULL, ("null socket"));
1966 IPSEC_ASSERT(m != NULL, ("null mbuf"));
1967 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
1968 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
1970 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
1971 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
1972 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
1973 ipseclog((LOG_DEBUG,
1974 "%s: invalid message: missing required header.\n",
1976 return key_senderror(so, m, EINVAL);
1978 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
1979 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
1980 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
1981 ipseclog((LOG_DEBUG,
1982 "%s: invalid message: wrong header size.\n", __func__));
1983 return key_senderror(so, m, EINVAL);
1985 if (!SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD)) {
1986 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD)) {
1987 ipseclog((LOG_DEBUG,
1988 "%s: invalid message: wrong header size.\n",
1990 return key_senderror(so, m, EINVAL);
1992 lft = (struct sadb_lifetime *)mhp->ext[SADB_EXT_LIFETIME_HARD];
1995 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
1996 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
1997 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
1999 /* check the direciton */
2000 switch (xpl0->sadb_x_policy_dir) {
2001 case IPSEC_DIR_INBOUND:
2002 case IPSEC_DIR_OUTBOUND:
2005 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2006 return key_senderror(so, m, EINVAL);
2008 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
2009 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2010 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2011 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2012 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2013 return key_senderror(so, m, EINVAL);
2016 /* policy requests are mandatory when action is ipsec. */
2017 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC &&
2018 mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2019 ipseclog((LOG_DEBUG,
2020 "%s: policy requests required.\n", __func__));
2021 return key_senderror(so, m, EINVAL);
2024 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
2025 (struct sockaddr *)(dst0 + 1));
2027 src0->sadb_address_proto != dst0->sadb_address_proto) {
2028 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2029 return key_senderror(so, m, error);
2032 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2035 src0->sadb_address_prefixlen,
2036 dst0->sadb_address_prefixlen,
2037 src0->sadb_address_proto,
2039 /* Checking there is SP already or not. */
2040 newsp = key_getsp(&spidx);
2041 if (newsp != NULL) {
2042 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2044 printf("%s: unlink SP(%p) for SPDUPDATE\n",
2046 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2051 ipseclog((LOG_DEBUG, "%s: a SP entry exists already.",
2053 return (key_senderror(so, m, EEXIST));
2057 /* allocate new SP entry */
2058 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2059 return key_senderror(so, m, error);
2062 newsp->lastused = newsp->created = time_second;
2063 newsp->lifetime = lft ? lft->sadb_lifetime_addtime : 0;
2064 newsp->validtime = lft ? lft->sadb_lifetime_usetime : 0;
2065 bcopy(&spidx, &newsp->spidx, sizeof(spidx));
2067 /* XXXAE: there is race between key_getsp() and key_insertsp() */
2069 if ((newsp->id = key_getnewspid()) == 0) {
2072 return key_senderror(so, m, ENOBUFS);
2074 key_insertsp(newsp);
2076 if (SPDCACHE_ENABLED())
2080 printf("%s: SP(%p)\n", __func__, newsp));
2081 KEYDBG(KEY_DATA, kdebug_secpolicy(newsp));
2084 struct mbuf *n, *mpolicy;
2085 struct sadb_msg *newmsg;
2088 /* create new sadb_msg to reply. */
2090 n = key_gather_mbuf(m, mhp, 2, 5, SADB_EXT_RESERVED,
2091 SADB_X_EXT_POLICY, SADB_EXT_LIFETIME_HARD,
2092 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2094 n = key_gather_mbuf(m, mhp, 2, 4, SADB_EXT_RESERVED,
2096 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2099 return key_senderror(so, m, ENOBUFS);
2101 if (n->m_len < sizeof(*newmsg)) {
2102 n = m_pullup(n, sizeof(*newmsg));
2104 return key_senderror(so, m, ENOBUFS);
2106 newmsg = mtod(n, struct sadb_msg *);
2107 newmsg->sadb_msg_errno = 0;
2108 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2111 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2112 sizeof(*xpl), &off);
2113 if (mpolicy == NULL) {
2114 /* n is already freed */
2115 return key_senderror(so, m, ENOBUFS);
2117 xpl = (struct sadb_x_policy *)(mtod(mpolicy, caddr_t) + off);
2118 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2120 return key_senderror(so, m, EINVAL);
2122 xpl->sadb_x_policy_id = newsp->id;
2125 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2130 * get new policy id.
2136 key_getnewspid(void)
2138 struct secpolicy *sp;
2140 int count = V_key_spi_trycnt; /* XXX */
2142 SPTREE_WLOCK_ASSERT();
2144 if (V_policy_id == ~0) /* overflowed */
2145 newid = V_policy_id = 1;
2147 newid = ++V_policy_id;
2148 LIST_FOREACH(sp, SPHASH_HASH(newid), idhash) {
2149 if (sp->id == newid)
2155 if (count == 0 || newid == 0) {
2156 ipseclog((LOG_DEBUG, "%s: failed to allocate policy id.\n",
2164 * SADB_SPDDELETE processing
2166 * <base, address(SD), policy(*)>
2167 * from the user(?), and set SADB_SASTATE_DEAD,
2169 * <base, address(SD), policy(*)>
2171 * policy(*) including direction of policy.
2173 * m will always be freed.
2176 key_spddelete(struct socket *so, struct mbuf *m,
2177 const struct sadb_msghdr *mhp)
2179 struct secpolicyindex spidx;
2180 struct sadb_address *src0, *dst0;
2181 struct sadb_x_policy *xpl0;
2182 struct secpolicy *sp;
2184 IPSEC_ASSERT(so != NULL, ("null so"));
2185 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2186 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2187 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2189 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
2190 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
2191 SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY)) {
2192 ipseclog((LOG_DEBUG,
2193 "%s: invalid message: missing required header.\n",
2195 return key_senderror(so, m, EINVAL);
2197 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
2198 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
2199 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2200 ipseclog((LOG_DEBUG,
2201 "%s: invalid message: wrong header size.\n", __func__));
2202 return key_senderror(so, m, EINVAL);
2205 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2206 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2207 xpl0 = (struct sadb_x_policy *)mhp->ext[SADB_X_EXT_POLICY];
2209 /* check the direciton */
2210 switch (xpl0->sadb_x_policy_dir) {
2211 case IPSEC_DIR_INBOUND:
2212 case IPSEC_DIR_OUTBOUND:
2215 ipseclog((LOG_DEBUG, "%s: invalid SP direction.\n", __func__));
2216 return key_senderror(so, m, EINVAL);
2218 /* Only DISCARD, NONE and IPSEC are allowed */
2219 if (xpl0->sadb_x_policy_type != IPSEC_POLICY_DISCARD &&
2220 xpl0->sadb_x_policy_type != IPSEC_POLICY_NONE &&
2221 xpl0->sadb_x_policy_type != IPSEC_POLICY_IPSEC) {
2222 ipseclog((LOG_DEBUG, "%s: invalid policy type.\n", __func__));
2223 return key_senderror(so, m, EINVAL);
2225 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
2226 (struct sockaddr *)(dst0 + 1)) != 0 ||
2227 src0->sadb_address_proto != dst0->sadb_address_proto) {
2228 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
2229 return key_senderror(so, m, EINVAL);
2232 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2235 src0->sadb_address_prefixlen,
2236 dst0->sadb_address_prefixlen,
2237 src0->sadb_address_proto,
2240 /* Is there SP in SPD ? */
2241 if ((sp = key_getsp(&spidx)) == NULL) {
2242 ipseclog((LOG_DEBUG, "%s: no SP found.\n", __func__));
2243 return key_senderror(so, m, EINVAL);
2246 /* save policy id to buffer to be returned. */
2247 xpl0->sadb_x_policy_id = sp->id;
2250 printf("%s: SP(%p)\n", __func__, sp));
2251 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2257 struct sadb_msg *newmsg;
2259 /* create new sadb_msg to reply. */
2260 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
2261 SADB_X_EXT_POLICY, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
2263 return key_senderror(so, m, ENOBUFS);
2265 newmsg = mtod(n, struct sadb_msg *);
2266 newmsg->sadb_msg_errno = 0;
2267 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2270 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2275 * SADB_SPDDELETE2 processing
2278 * from the user(?), and set SADB_SASTATE_DEAD,
2282 * policy(*) including direction of policy.
2284 * m will always be freed.
2287 key_spddelete2(struct socket *so, struct mbuf *m,
2288 const struct sadb_msghdr *mhp)
2290 struct secpolicy *sp;
2293 IPSEC_ASSERT(so != NULL, ("null socket"));
2294 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2295 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2296 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2298 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2299 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2300 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2302 return key_senderror(so, m, EINVAL);
2305 id = ((struct sadb_x_policy *)
2306 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2308 /* Is there SP in SPD ? */
2309 if ((sp = key_getspbyid(id)) == NULL) {
2310 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2312 return key_senderror(so, m, EINVAL);
2316 printf("%s: SP(%p)\n", __func__, sp));
2317 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2319 if (sp->state != IPSEC_SPSTATE_DEAD) {
2320 ipseclog((LOG_DEBUG, "%s: failed to delete SP with id %u.\n",
2323 return (key_senderror(so, m, EACCES));
2328 struct mbuf *n, *nn;
2329 struct sadb_msg *newmsg;
2332 /* create new sadb_msg to reply. */
2333 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2335 MGETHDR(n, M_NOWAIT, MT_DATA);
2336 if (n && len > MHLEN) {
2337 if (!(MCLGET(n, M_NOWAIT))) {
2343 return key_senderror(so, m, ENOBUFS);
2349 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
2350 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
2352 IPSEC_ASSERT(off == len, ("length inconsistency (off %u len %u)",
2355 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
2356 mhp->extlen[SADB_X_EXT_POLICY], M_NOWAIT);
2359 return key_senderror(so, m, ENOBUFS);
2362 n->m_pkthdr.len = 0;
2363 for (nn = n; nn; nn = nn->m_next)
2364 n->m_pkthdr.len += nn->m_len;
2366 newmsg = mtod(n, struct sadb_msg *);
2367 newmsg->sadb_msg_errno = 0;
2368 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
2371 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2376 * SADB_X_SPDGET processing
2381 * <base, address(SD), policy>
2383 * policy(*) including direction of policy.
2385 * m will always be freed.
2388 key_spdget(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2390 struct secpolicy *sp;
2394 IPSEC_ASSERT(so != NULL, ("null socket"));
2395 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2396 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2397 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2399 if (SADB_CHECKHDR(mhp, SADB_X_EXT_POLICY) ||
2400 SADB_CHECKLEN(mhp, SADB_X_EXT_POLICY)) {
2401 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
2403 return key_senderror(so, m, EINVAL);
2406 id = ((struct sadb_x_policy *)
2407 mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2409 /* Is there SP in SPD ? */
2410 if ((sp = key_getspbyid(id)) == NULL) {
2411 ipseclog((LOG_DEBUG, "%s: no SP found for id %u.\n",
2413 return key_senderror(so, m, ENOENT);
2416 n = key_setdumpsp(sp, SADB_X_SPDGET, mhp->msg->sadb_msg_seq,
2417 mhp->msg->sadb_msg_pid);
2421 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2423 return key_senderror(so, m, ENOBUFS);
2427 * SADB_X_SPDACQUIRE processing.
2428 * Acquire policy and SA(s) for a *OUTBOUND* packet.
2431 * to KMD, and expect to receive
2432 * <base> with SADB_X_SPDACQUIRE if error occurred,
2435 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
2436 * policy(*) is without policy requests.
2439 * others: error number
2442 key_spdacquire(struct secpolicy *sp)
2444 struct mbuf *result = NULL, *m;
2445 struct secspacq *newspacq;
2447 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2448 IPSEC_ASSERT(sp->req == NULL, ("policy exists"));
2449 IPSEC_ASSERT(sp->policy == IPSEC_POLICY_IPSEC,
2450 ("policy not IPSEC %u", sp->policy));
2452 /* Get an entry to check whether sent message or not. */
2453 newspacq = key_getspacq(&sp->spidx);
2454 if (newspacq != NULL) {
2455 if (V_key_blockacq_count < newspacq->count) {
2456 /* reset counter and do send message. */
2457 newspacq->count = 0;
2459 /* increment counter and do nothing. */
2466 /* make new entry for blocking to send SADB_ACQUIRE. */
2467 newspacq = key_newspacq(&sp->spidx);
2468 if (newspacq == NULL)
2472 /* create new sadb_msg to reply. */
2473 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
2479 result->m_pkthdr.len = 0;
2480 for (m = result; m; m = m->m_next)
2481 result->m_pkthdr.len += m->m_len;
2483 mtod(result, struct sadb_msg *)->sadb_msg_len =
2484 PFKEY_UNIT64(result->m_pkthdr.len);
2486 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
2490 * SADB_SPDFLUSH processing
2493 * from the user, and free all entries in secpctree.
2497 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
2499 * m will always be freed.
2502 key_spdflush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2504 struct secpolicy_queue drainq;
2505 struct sadb_msg *newmsg;
2506 struct secpolicy *sp, *nextsp;
2509 IPSEC_ASSERT(so != NULL, ("null socket"));
2510 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2511 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2512 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2514 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg)))
2515 return key_senderror(so, m, EINVAL);
2517 TAILQ_INIT(&drainq);
2519 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2520 TAILQ_CONCAT(&drainq, &V_sptree[dir], chain);
2523 * We need to set state to DEAD for each policy to be sure,
2524 * that another thread won't try to unlink it.
2525 * Also remove SP from sphash.
2527 TAILQ_FOREACH(sp, &drainq, chain) {
2528 sp->state = IPSEC_SPSTATE_DEAD;
2529 LIST_REMOVE(sp, idhash);
2534 if (SPDCACHE_ENABLED())
2536 sp = TAILQ_FIRST(&drainq);
2537 while (sp != NULL) {
2538 nextsp = TAILQ_NEXT(sp, chain);
2543 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
2544 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
2545 return key_senderror(so, m, ENOBUFS);
2551 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2552 newmsg = mtod(m, struct sadb_msg *);
2553 newmsg->sadb_msg_errno = 0;
2554 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
2556 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
2560 key_satype2scopemask(uint8_t satype)
2563 if (satype == IPSEC_POLICYSCOPE_ANY)
2568 * SADB_SPDDUMP processing
2571 * from the user, and dump all SP leaves and send,
2576 * sadb_msg_satype is considered as mask of policy scopes.
2577 * m will always be freed.
2580 key_spddump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
2582 SPTREE_RLOCK_TRACKER;
2583 struct secpolicy *sp;
2588 IPSEC_ASSERT(so != NULL, ("null socket"));
2589 IPSEC_ASSERT(m != NULL, ("null mbuf"));
2590 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2591 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2593 /* search SPD entry and get buffer size. */
2595 scope = key_satype2scopemask(mhp->msg->sadb_msg_satype);
2597 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2598 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2599 TAILQ_FOREACH(sp, &V_sptree[dir], chain)
2602 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2603 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain)
2610 return key_senderror(so, m, ENOENT);
2613 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2614 if (scope & IPSEC_POLICYSCOPE_GLOBAL) {
2615 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
2617 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2618 mhp->msg->sadb_msg_pid);
2621 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2624 if (scope & IPSEC_POLICYSCOPE_IFNET) {
2625 TAILQ_FOREACH(sp, &V_sptree_ifnet[dir], chain) {
2627 n = key_setdumpsp(sp, SADB_X_SPDDUMP, cnt,
2628 mhp->msg->sadb_msg_pid);
2631 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
2641 static struct mbuf *
2642 key_setdumpsp(struct secpolicy *sp, u_int8_t type, u_int32_t seq,
2645 struct mbuf *result = NULL, *m;
2646 struct seclifetime lt;
2648 m = key_setsadbmsg(type, 0, SADB_SATYPE_UNSPEC, seq, pid, sp->refcnt);
2653 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2654 &sp->spidx.src.sa, sp->spidx.prefs,
2655 sp->spidx.ul_proto);
2660 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2661 &sp->spidx.dst.sa, sp->spidx.prefd,
2662 sp->spidx.ul_proto);
2667 m = key_sp2mbuf(sp);
2673 lt.addtime=sp->created;
2674 lt.usetime= sp->lastused;
2675 m = key_setlifetime(<, SADB_EXT_LIFETIME_CURRENT);
2680 lt.addtime=sp->lifetime;
2681 lt.usetime= sp->validtime;
2682 m = key_setlifetime(<, SADB_EXT_LIFETIME_HARD);
2688 if ((result->m_flags & M_PKTHDR) == 0)
2691 if (result->m_len < sizeof(struct sadb_msg)) {
2692 result = m_pullup(result, sizeof(struct sadb_msg));
2697 result->m_pkthdr.len = 0;
2698 for (m = result; m; m = m->m_next)
2699 result->m_pkthdr.len += m->m_len;
2701 mtod(result, struct sadb_msg *)->sadb_msg_len =
2702 PFKEY_UNIT64(result->m_pkthdr.len);
2711 * get PFKEY message length for security policy and request.
2714 key_getspreqmsglen(struct secpolicy *sp)
2719 tlen = sizeof(struct sadb_x_policy);
2720 /* if is the policy for ipsec ? */
2721 if (sp->policy != IPSEC_POLICY_IPSEC)
2724 /* get length of ipsec requests */
2725 for (i = 0; i < sp->tcount; i++) {
2726 len = sizeof(struct sadb_x_ipsecrequest)
2727 + sp->req[i]->saidx.src.sa.sa_len
2728 + sp->req[i]->saidx.dst.sa.sa_len;
2730 tlen += PFKEY_ALIGN8(len);
2736 * SADB_SPDEXPIRE processing
2738 * <base, address(SD), lifetime(CH), policy>
2742 * others : error number
2745 key_spdexpire(struct secpolicy *sp)
2747 struct sadb_lifetime *lt;
2748 struct mbuf *result = NULL, *m;
2749 int len, error = -1;
2751 IPSEC_ASSERT(sp != NULL, ("null secpolicy"));
2754 printf("%s: SP(%p)\n", __func__, sp));
2755 KEYDBG(KEY_DATA, kdebug_secpolicy(sp));
2757 /* set msg header */
2758 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
2765 /* create lifetime extension (current and hard) */
2766 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
2767 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
2774 bzero(mtod(m, caddr_t), len);
2775 lt = mtod(m, struct sadb_lifetime *);
2776 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2777 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
2778 lt->sadb_lifetime_allocations = 0;
2779 lt->sadb_lifetime_bytes = 0;
2780 lt->sadb_lifetime_addtime = sp->created;
2781 lt->sadb_lifetime_usetime = sp->lastused;
2782 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
2783 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
2784 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
2785 lt->sadb_lifetime_allocations = 0;
2786 lt->sadb_lifetime_bytes = 0;
2787 lt->sadb_lifetime_addtime = sp->lifetime;
2788 lt->sadb_lifetime_usetime = sp->validtime;
2791 /* set sadb_address for source */
2792 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
2794 sp->spidx.prefs, sp->spidx.ul_proto);
2801 /* set sadb_address for destination */
2802 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
2804 sp->spidx.prefd, sp->spidx.ul_proto);
2812 m = key_sp2mbuf(sp);
2819 if ((result->m_flags & M_PKTHDR) == 0) {
2824 if (result->m_len < sizeof(struct sadb_msg)) {
2825 result = m_pullup(result, sizeof(struct sadb_msg));
2826 if (result == NULL) {
2832 result->m_pkthdr.len = 0;
2833 for (m = result; m; m = m->m_next)
2834 result->m_pkthdr.len += m->m_len;
2836 mtod(result, struct sadb_msg *)->sadb_msg_len =
2837 PFKEY_UNIT64(result->m_pkthdr.len);
2839 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
2847 /* %%% SAD management */
2849 * allocating and initialize new SA head.
2850 * OUT: NULL : failure due to the lack of memory.
2851 * others : pointer to new SA head.
2853 static struct secashead *
2854 key_newsah(struct secasindex *saidx)
2856 struct secashead *sah;
2858 sah = malloc(sizeof(struct secashead), M_IPSEC_SAH,
2861 PFKEYSTAT_INC(in_nomem);
2864 TAILQ_INIT(&sah->savtree_larval);
2865 TAILQ_INIT(&sah->savtree_alive);
2866 sah->saidx = *saidx;
2867 sah->state = SADB_SASTATE_DEAD;
2871 printf("%s: SAH(%p)\n", __func__, sah));
2872 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2877 key_freesah(struct secashead **psah)
2879 struct secashead *sah = *psah;
2881 if (SAH_DELREF(sah) == 0)
2885 printf("%s: last reference to SAH(%p)\n", __func__, sah));
2886 KEYDBG(KEY_DATA, kdebug_secash(sah, NULL));
2893 key_delsah(struct secashead *sah)
2895 IPSEC_ASSERT(sah != NULL, ("NULL sah"));
2896 IPSEC_ASSERT(sah->state == SADB_SASTATE_DEAD,
2897 ("Attempt to free non DEAD SAH %p", sah));
2898 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_larval),
2899 ("Attempt to free SAH %p with LARVAL SA", sah));
2900 IPSEC_ASSERT(TAILQ_EMPTY(&sah->savtree_alive),
2901 ("Attempt to free SAH %p with ALIVE SA", sah));
2903 free(sah, M_IPSEC_SAH);
2907 * allocating a new SA for key_add() and key_getspi() call,
2908 * and copy the values of mhp into new buffer.
2909 * When SAD message type is SADB_GETSPI set SA state to LARVAL.
2910 * For SADB_ADD create and initialize SA with MATURE state.
2912 * others : pointer to new secasvar.
2914 static struct secasvar *
2915 key_newsav(const struct sadb_msghdr *mhp, struct secasindex *saidx,
2916 uint32_t spi, int *errp)
2918 struct secashead *sah;
2919 struct secasvar *sav;
2922 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
2923 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
2924 IPSEC_ASSERT(mhp->msg->sadb_msg_type == SADB_GETSPI ||
2925 mhp->msg->sadb_msg_type == SADB_ADD, ("wrong message type"));
2929 /* check SPI value */
2930 switch (saidx->proto) {
2934 * RFC 4302, 2.4. Security Parameters Index (SPI), SPI values
2935 * 1-255 reserved by IANA for future use,
2936 * 0 for implementation specific, local use.
2938 if (ntohl(spi) <= 255) {
2939 ipseclog((LOG_DEBUG, "%s: illegal range of SPI %u.\n",
2940 __func__, ntohl(spi)));
2947 sav = malloc(sizeof(struct secasvar), M_IPSEC_SA, M_NOWAIT | M_ZERO);
2952 sav->lock = malloc(sizeof(struct mtx), M_IPSEC_MISC,
2954 if (sav->lock == NULL) {
2958 mtx_init(sav->lock, "ipsec association", NULL, MTX_DEF);
2959 sav->lft_c = uma_zalloc(V_key_lft_zone, M_NOWAIT);
2960 if (sav->lft_c == NULL) {
2964 counter_u64_zero(sav->lft_c_allocations);
2965 counter_u64_zero(sav->lft_c_bytes);
2968 sav->seq = mhp->msg->sadb_msg_seq;
2969 sav->state = SADB_SASTATE_LARVAL;
2970 sav->pid = (pid_t)mhp->msg->sadb_msg_pid;
2973 sah = key_getsah(saidx);
2975 /* create a new SA index */
2976 sah = key_newsah(saidx);
2978 ipseclog((LOG_DEBUG,
2979 "%s: No more memory.\n", __func__));
2988 if (mhp->msg->sadb_msg_type == SADB_GETSPI) {
2989 sav->created = time_second;
2990 } else if (sav->state == SADB_SASTATE_LARVAL) {
2992 * Do not call key_setsaval() second time in case
2993 * of `goto again`. We will have MATURE state.
2995 *errp = key_setsaval(sav, mhp);
2998 sav->state = SADB_SASTATE_MATURE;
3003 * Check that existing SAH wasn't unlinked.
3004 * Since we didn't hold the SAHTREE lock, it is possible,
3005 * that callout handler or key_flush() or key_delete() could
3008 if (isnew == 0 && sah->state == SADB_SASTATE_DEAD) {
3010 key_freesah(&sah); /* reference from key_getsah() */
3015 * Add new SAH into SADB.
3017 * XXXAE: we can serialize key_add and key_getspi calls, so
3018 * several threads will not fight in the race.
3019 * Otherwise we should check under SAHTREE lock, that this
3020 * SAH would not added twice.
3022 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
3023 /* Add new SAH into hash by addresses */
3024 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
3025 /* Now we are linked in the chain */
3026 sah->state = SADB_SASTATE_MATURE;
3028 * SAV references this new SAH.
3029 * In case of existing SAH we reuse reference
3030 * from key_getsah().
3034 /* Link SAV with SAH */
3035 if (sav->state == SADB_SASTATE_MATURE)
3036 TAILQ_INSERT_HEAD(&sah->savtree_alive, sav, chain);
3038 TAILQ_INSERT_HEAD(&sah->savtree_larval, sav, chain);
3039 /* Add SAV into SPI hash */
3040 LIST_INSERT_HEAD(SAVHASH_HASH(sav->spi), sav, spihash);
3042 *errp = 0; /* success */
3046 if (sav->lock != NULL) {
3047 mtx_destroy(sav->lock);
3048 free(sav->lock, M_IPSEC_MISC);
3050 if (sav->lft_c != NULL)
3051 uma_zfree(V_key_lft_zone, sav->lft_c);
3052 free(sav, M_IPSEC_SA), sav = NULL;
3056 if (*errp == ENOBUFS) {
3057 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3059 PFKEYSTAT_INC(in_nomem);
3066 * free() SA variable entry.
3069 key_cleansav(struct secasvar *sav)
3072 if (sav->natt != NULL) {
3073 free(sav->natt, M_IPSEC_MISC);
3076 if (sav->flags & SADB_X_EXT_F_CLONED)
3079 * Cleanup xform state. Note that zeroize'ing causes the
3080 * keys to be cleared; otherwise we must do it ourself.
3082 if (sav->tdb_xform != NULL) {
3083 sav->tdb_xform->xf_zeroize(sav);
3084 sav->tdb_xform = NULL;
3086 if (sav->key_auth != NULL)
3087 bzero(sav->key_auth->key_data, _KEYLEN(sav->key_auth));
3088 if (sav->key_enc != NULL)
3089 bzero(sav->key_enc->key_data, _KEYLEN(sav->key_enc));
3091 if (sav->key_auth != NULL) {
3092 if (sav->key_auth->key_data != NULL)
3093 free(sav->key_auth->key_data, M_IPSEC_MISC);
3094 free(sav->key_auth, M_IPSEC_MISC);
3095 sav->key_auth = NULL;
3097 if (sav->key_enc != NULL) {
3098 if (sav->key_enc->key_data != NULL)
3099 free(sav->key_enc->key_data, M_IPSEC_MISC);
3100 free(sav->key_enc, M_IPSEC_MISC);
3101 sav->key_enc = NULL;
3103 if (sav->replay != NULL) {
3104 if (sav->replay->bitmap != NULL)
3105 free(sav->replay->bitmap, M_IPSEC_MISC);
3106 free(sav->replay, M_IPSEC_MISC);
3109 if (sav->lft_h != NULL) {
3110 free(sav->lft_h, M_IPSEC_MISC);
3113 if (sav->lft_s != NULL) {
3114 free(sav->lft_s, M_IPSEC_MISC);
3120 * free() SA variable entry.
3123 key_delsav(struct secasvar *sav)
3125 IPSEC_ASSERT(sav != NULL, ("null sav"));
3126 IPSEC_ASSERT(sav->state == SADB_SASTATE_DEAD,
3127 ("attempt to free non DEAD SA %p", sav));
3128 IPSEC_ASSERT(sav->refcnt == 0, ("reference count %u > 0",
3132 * SA must be unlinked from the chain and hashtbl.
3133 * If SA was cloned, we leave all fields untouched,
3134 * except NAT-T config.
3137 if ((sav->flags & SADB_X_EXT_F_CLONED) == 0) {
3138 mtx_destroy(sav->lock);
3139 free(sav->lock, M_IPSEC_MISC);
3140 uma_zfree(V_key_lft_zone, sav->lft_c);
3142 free(sav, M_IPSEC_SA);
3149 * others : found, referenced pointer to a SAH.
3151 static struct secashead *
3152 key_getsah(struct secasindex *saidx)
3154 SAHTREE_RLOCK_TRACKER;
3155 struct secashead *sah;
3158 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
3159 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE_REQID) != 0) {
3169 * Check not to be duplicated SPI.
3172 * 1 : found SA with given SPI.
3175 key_checkspidup(uint32_t spi)
3177 SAHTREE_RLOCK_TRACKER;
3178 struct secasvar *sav;
3180 /* Assume SPI is in network byte order */
3182 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3183 if (sav->spi == spi)
3187 return (sav != NULL);
3194 * others : found, referenced pointer to a SA.
3196 static struct secasvar *
3197 key_getsavbyspi(uint32_t spi)
3199 SAHTREE_RLOCK_TRACKER;
3200 struct secasvar *sav;
3202 /* Assume SPI is in network byte order */
3204 LIST_FOREACH(sav, SAVHASH_HASH(spi), spihash) {
3205 if (sav->spi != spi)
3215 key_updatelifetimes(struct secasvar *sav, const struct sadb_msghdr *mhp)
3217 struct seclifetime *lft_h, *lft_s, *tmp;
3219 /* Lifetime extension is optional, check that it is present. */
3220 if (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3221 SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) {
3223 * In case of SADB_UPDATE we may need to change
3224 * existing lifetimes.
3226 if (sav->state == SADB_SASTATE_MATURE) {
3227 lft_h = lft_s = NULL;
3232 /* Both HARD and SOFT extensions must present */
3233 if ((SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
3234 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
3235 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
3236 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
3237 ipseclog((LOG_DEBUG,
3238 "%s: invalid message: missing required header.\n",
3242 if (SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_HARD) ||
3243 SADB_CHECKLEN(mhp, SADB_EXT_LIFETIME_SOFT)) {
3244 ipseclog((LOG_DEBUG,
3245 "%s: invalid message: wrong header size.\n", __func__));
3248 lft_h = key_dup_lifemsg((const struct sadb_lifetime *)
3249 mhp->ext[SADB_EXT_LIFETIME_HARD], M_IPSEC_MISC);
3250 if (lft_h == NULL) {
3251 PFKEYSTAT_INC(in_nomem);
3252 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3255 lft_s = key_dup_lifemsg((const struct sadb_lifetime *)
3256 mhp->ext[SADB_EXT_LIFETIME_SOFT], M_IPSEC_MISC);
3257 if (lft_s == NULL) {
3258 PFKEYSTAT_INC(in_nomem);
3259 free(lft_h, M_IPSEC_MISC);
3260 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
3264 if (sav->state != SADB_SASTATE_LARVAL) {
3266 * key_update() holds reference to this SA,
3267 * so it won't be deleted in meanwhile.
3277 SECASVAR_UNLOCK(sav);
3279 free(lft_h, M_IPSEC_MISC);
3281 free(lft_s, M_IPSEC_MISC);
3284 /* We can update lifetime without holding a lock */
3285 IPSEC_ASSERT(sav->lft_h == NULL, ("lft_h is already initialized\n"));
3286 IPSEC_ASSERT(sav->lft_s == NULL, ("lft_s is already initialized\n"));
3293 * copy SA values from PF_KEY message except *SPI, SEQ, PID and TYPE*.
3294 * You must update these if need. Expects only LARVAL SAs.
3299 key_setsaval(struct secasvar *sav, const struct sadb_msghdr *mhp)
3301 const struct sadb_sa *sa0;
3302 const struct sadb_key *key0;
3307 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
3308 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
3309 IPSEC_ASSERT(sav->state == SADB_SASTATE_LARVAL,
3310 ("Attempt to update non LARVAL SA"));
3313 error = key_setident(sav->sah, mhp);
3318 if (!SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
3319 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
3323 sa0 = (const struct sadb_sa *)mhp->ext[SADB_EXT_SA];
3324 sav->alg_auth = sa0->sadb_sa_auth;
3325 sav->alg_enc = sa0->sadb_sa_encrypt;
3326 sav->flags = sa0->sadb_sa_flags;
3327 if ((sav->flags & SADB_KEY_FLAGS_MAX) != sav->flags) {
3328 ipseclog((LOG_DEBUG,
3329 "%s: invalid sa_flags 0x%08x.\n", __func__,
3335 /* Optional replay window */
3337 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0)
3338 replay = sa0->sadb_sa_replay;
3339 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_SA_REPLAY)) {
3340 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA_REPLAY)) {
3344 replay = ((const struct sadb_x_sa_replay *)
3345 mhp->ext[SADB_X_EXT_SA_REPLAY])->sadb_x_sa_replay_replay;
3347 if (replay > UINT32_MAX - 32) {
3348 ipseclog((LOG_DEBUG,
3349 "%s: replay window too big.\n", __func__));
3354 replay = (replay + 7) >> 3;
3357 sav->replay = malloc(sizeof(struct secreplay), M_IPSEC_MISC,
3359 if (sav->replay == NULL) {
3360 PFKEYSTAT_INC(in_nomem);
3361 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3368 /* number of 32b blocks to be allocated */
3369 uint32_t bitmap_size;
3372 * - the allocated replay window size must be
3374 * - use an extra 32b block as a redundant window.
3377 while (replay + 4 > bitmap_size)
3379 bitmap_size = bitmap_size / 4;
3381 sav->replay->bitmap = malloc(
3382 bitmap_size * sizeof(uint32_t), M_IPSEC_MISC,
3384 if (sav->replay->bitmap == NULL) {
3385 PFKEYSTAT_INC(in_nomem);
3386 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3391 sav->replay->bitmap_size = bitmap_size;
3392 sav->replay->wsize = replay;
3396 /* Authentication keys */
3397 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
3398 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH)) {
3403 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
3404 len = mhp->extlen[SADB_EXT_KEY_AUTH];
3405 switch (mhp->msg->sadb_msg_satype) {
3406 case SADB_SATYPE_AH:
3407 case SADB_SATYPE_ESP:
3408 case SADB_X_SATYPE_TCPSIGNATURE:
3409 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3410 sav->alg_auth != SADB_X_AALG_NULL)
3413 case SADB_X_SATYPE_IPCOMP:
3419 ipseclog((LOG_DEBUG, "%s: invalid key_auth values.\n",
3424 sav->key_auth = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3425 if (sav->key_auth == NULL ) {
3426 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3428 PFKEYSTAT_INC(in_nomem);
3434 /* Encryption key */
3435 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) {
3436 if (SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT)) {
3441 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
3442 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
3443 switch (mhp->msg->sadb_msg_satype) {
3444 case SADB_SATYPE_ESP:
3445 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
3446 sav->alg_enc != SADB_EALG_NULL) {
3450 sav->key_enc = key_dup_keymsg(key0, len, M_IPSEC_MISC);
3451 if (sav->key_enc == NULL) {
3452 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
3454 PFKEYSTAT_INC(in_nomem);
3459 case SADB_X_SATYPE_IPCOMP:
3460 if (len != PFKEY_ALIGN8(sizeof(struct sadb_key)))
3462 sav->key_enc = NULL; /*just in case*/
3464 case SADB_SATYPE_AH:
3465 case SADB_X_SATYPE_TCPSIGNATURE:
3471 ipseclog((LOG_DEBUG, "%s: invalid key_enc value.\n",
3479 switch (mhp->msg->sadb_msg_satype) {
3480 case SADB_SATYPE_AH:
3481 if (sav->flags & SADB_X_EXT_DERIV) {
3482 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3483 "given to AH SA.\n", __func__));
3487 if (sav->alg_enc != SADB_EALG_NONE) {
3488 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3489 "mismated.\n", __func__));
3493 error = xform_init(sav, XF_AH);
3495 case SADB_SATYPE_ESP:
3496 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) ==
3497 (SADB_X_EXT_OLD | SADB_X_EXT_DERIV)) {
3498 ipseclog((LOG_DEBUG, "%s: invalid flag (derived) "
3499 "given to old-esp.\n", __func__));
3503 error = xform_init(sav, XF_ESP);
3505 case SADB_X_SATYPE_IPCOMP:
3506 if (sav->alg_auth != SADB_AALG_NONE) {
3507 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3508 "mismated.\n", __func__));
3512 if ((sav->flags & SADB_X_EXT_RAWCPI) == 0 &&
3513 ntohl(sav->spi) >= 0x10000) {
3514 ipseclog((LOG_DEBUG, "%s: invalid cpi for IPComp.\n",
3519 error = xform_init(sav, XF_IPCOMP);
3521 case SADB_X_SATYPE_TCPSIGNATURE:
3522 if (sav->alg_enc != SADB_EALG_NONE) {
3523 ipseclog((LOG_DEBUG, "%s: protocol and algorithm "
3524 "mismated.\n", __func__));
3528 error = xform_init(sav, XF_TCPSIGNATURE);
3531 ipseclog((LOG_DEBUG, "%s: Invalid satype.\n", __func__));
3532 error = EPROTONOSUPPORT;
3536 ipseclog((LOG_DEBUG, "%s: unable to initialize SA type %u.\n",
3537 __func__, mhp->msg->sadb_msg_satype));
3541 /* Handle NAT-T headers */
3542 error = key_setnatt(sav, mhp);
3546 /* Initialize lifetime for CURRENT */
3548 sav->created = time_second;
3550 /* lifetimes for HARD and SOFT */
3551 error = key_updatelifetimes(sav, mhp);
3560 * subroutine for SADB_GET and SADB_DUMP.
3562 static struct mbuf *
3563 key_setdumpsa(struct secasvar *sav, uint8_t type, uint8_t satype,
3564 uint32_t seq, uint32_t pid)
3566 struct seclifetime lft_c;
3567 struct mbuf *result = NULL, *tres = NULL, *m;
3568 int i, dumporder[] = {
3569 SADB_EXT_SA, SADB_X_EXT_SA2, SADB_X_EXT_SA_REPLAY,
3570 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
3571 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
3572 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY,
3573 SADB_EXT_KEY_AUTH, SADB_EXT_KEY_ENCRYPT,
3574 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
3575 SADB_EXT_SENSITIVITY,
3576 SADB_X_EXT_NAT_T_TYPE,
3577 SADB_X_EXT_NAT_T_SPORT, SADB_X_EXT_NAT_T_DPORT,
3578 SADB_X_EXT_NAT_T_OAI, SADB_X_EXT_NAT_T_OAR,
3579 SADB_X_EXT_NAT_T_FRAG,
3581 uint32_t replay_count;
3583 m = key_setsadbmsg(type, 0, satype, seq, pid, sav->refcnt);
3588 for (i = nitems(dumporder) - 1; i >= 0; i--) {
3590 switch (dumporder[i]) {
3592 m = key_setsadbsa(sav);
3597 case SADB_X_EXT_SA2:
3599 replay_count = sav->replay ? sav->replay->count : 0;
3600 SECASVAR_UNLOCK(sav);
3601 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
3602 sav->sah->saidx.reqid);
3607 case SADB_X_EXT_SA_REPLAY:
3608 if (sav->replay == NULL ||
3609 sav->replay->wsize <= UINT8_MAX)
3612 m = key_setsadbxsareplay(sav->replay->wsize);
3617 case SADB_EXT_ADDRESS_SRC:
3618 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3619 &sav->sah->saidx.src.sa,
3620 FULLMASK, IPSEC_ULPROTO_ANY);
3625 case SADB_EXT_ADDRESS_DST:
3626 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3627 &sav->sah->saidx.dst.sa,
3628 FULLMASK, IPSEC_ULPROTO_ANY);
3633 case SADB_EXT_KEY_AUTH:
3636 m = key_setkey(sav->key_auth, SADB_EXT_KEY_AUTH);
3641 case SADB_EXT_KEY_ENCRYPT:
3644 m = key_setkey(sav->key_enc, SADB_EXT_KEY_ENCRYPT);
3649 case SADB_EXT_LIFETIME_CURRENT:
3650 lft_c.addtime = sav->created;
3651 lft_c.allocations = (uint32_t)counter_u64_fetch(
3652 sav->lft_c_allocations);
3653 lft_c.bytes = counter_u64_fetch(sav->lft_c_bytes);
3654 lft_c.usetime = sav->firstused;
3655 m = key_setlifetime(&lft_c, SADB_EXT_LIFETIME_CURRENT);
3660 case SADB_EXT_LIFETIME_HARD:
3663 m = key_setlifetime(sav->lft_h,
3664 SADB_EXT_LIFETIME_HARD);
3669 case SADB_EXT_LIFETIME_SOFT:
3672 m = key_setlifetime(sav->lft_s,
3673 SADB_EXT_LIFETIME_SOFT);
3679 case SADB_X_EXT_NAT_T_TYPE:
3680 if (sav->natt == NULL)
3682 m = key_setsadbxtype(UDP_ENCAP_ESPINUDP);
3687 case SADB_X_EXT_NAT_T_DPORT:
3688 if (sav->natt == NULL)
3690 m = key_setsadbxport(sav->natt->dport,
3691 SADB_X_EXT_NAT_T_DPORT);
3696 case SADB_X_EXT_NAT_T_SPORT:
3697 if (sav->natt == NULL)
3699 m = key_setsadbxport(sav->natt->sport,
3700 SADB_X_EXT_NAT_T_SPORT);
3705 case SADB_X_EXT_NAT_T_OAI:
3706 if (sav->natt == NULL ||
3707 (sav->natt->flags & IPSEC_NATT_F_OAI) == 0)
3709 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAI,
3710 &sav->natt->oai.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3714 case SADB_X_EXT_NAT_T_OAR:
3715 if (sav->natt == NULL ||
3716 (sav->natt->flags & IPSEC_NATT_F_OAR) == 0)
3718 m = key_setsadbaddr(SADB_X_EXT_NAT_T_OAR,
3719 &sav->natt->oar.sa, FULLMASK, IPSEC_ULPROTO_ANY);
3723 case SADB_X_EXT_NAT_T_FRAG:
3724 /* We do not (yet) support those. */
3727 case SADB_EXT_ADDRESS_PROXY:
3728 case SADB_EXT_IDENTITY_SRC:
3729 case SADB_EXT_IDENTITY_DST:
3730 /* XXX: should we brought from SPD ? */
3731 case SADB_EXT_SENSITIVITY:
3743 m_cat(result, tres);
3745 if (result->m_len < sizeof(struct sadb_msg)) {
3746 result = m_pullup(result, sizeof(struct sadb_msg));
3751 result->m_pkthdr.len = 0;
3752 for (m = result; m; m = m->m_next)
3753 result->m_pkthdr.len += m->m_len;
3755 mtod(result, struct sadb_msg *)->sadb_msg_len =
3756 PFKEY_UNIT64(result->m_pkthdr.len);
3767 * set data into sadb_msg.
3769 static struct mbuf *
3770 key_setsadbmsg(u_int8_t type, u_int16_t tlen, u_int8_t satype, u_int32_t seq,
3771 pid_t pid, u_int16_t reserved)
3777 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3780 MGETHDR(m, M_NOWAIT, MT_DATA);
3781 if (m && len > MHLEN) {
3782 if (!(MCLGET(m, M_NOWAIT))) {
3789 m->m_pkthdr.len = m->m_len = len;
3792 p = mtod(m, struct sadb_msg *);
3795 p->sadb_msg_version = PF_KEY_V2;
3796 p->sadb_msg_type = type;
3797 p->sadb_msg_errno = 0;
3798 p->sadb_msg_satype = satype;
3799 p->sadb_msg_len = PFKEY_UNIT64(tlen);
3800 p->sadb_msg_reserved = reserved;
3801 p->sadb_msg_seq = seq;
3802 p->sadb_msg_pid = (u_int32_t)pid;
3808 * copy secasvar data into sadb_address.
3810 static struct mbuf *
3811 key_setsadbsa(struct secasvar *sav)
3817 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
3818 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3823 p = mtod(m, struct sadb_sa *);
3825 p->sadb_sa_len = PFKEY_UNIT64(len);
3826 p->sadb_sa_exttype = SADB_EXT_SA;
3827 p->sadb_sa_spi = sav->spi;
3828 p->sadb_sa_replay = sav->replay ?
3829 (sav->replay->wsize > UINT8_MAX ? UINT8_MAX :
3830 sav->replay->wsize): 0;
3831 p->sadb_sa_state = sav->state;
3832 p->sadb_sa_auth = sav->alg_auth;
3833 p->sadb_sa_encrypt = sav->alg_enc;
3834 p->sadb_sa_flags = sav->flags & SADB_KEY_FLAGS_MAX;
3839 * set data into sadb_address.
3841 static struct mbuf *
3842 key_setsadbaddr(u_int16_t exttype, const struct sockaddr *saddr,
3843 u_int8_t prefixlen, u_int16_t ul_proto)
3846 struct sadb_address *p;
3849 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
3850 PFKEY_ALIGN8(saddr->sa_len);
3851 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3856 p = mtod(m, struct sadb_address *);
3859 p->sadb_address_len = PFKEY_UNIT64(len);
3860 p->sadb_address_exttype = exttype;
3861 p->sadb_address_proto = ul_proto;
3862 if (prefixlen == FULLMASK) {
3863 switch (saddr->sa_family) {
3865 prefixlen = sizeof(struct in_addr) << 3;
3868 prefixlen = sizeof(struct in6_addr) << 3;
3874 p->sadb_address_prefixlen = prefixlen;
3875 p->sadb_address_reserved = 0;
3878 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
3885 * set data into sadb_x_sa2.
3887 static struct mbuf *
3888 key_setsadbxsa2(u_int8_t mode, u_int32_t seq, u_int32_t reqid)
3891 struct sadb_x_sa2 *p;
3894 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
3895 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3900 p = mtod(m, struct sadb_x_sa2 *);
3903 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
3904 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
3905 p->sadb_x_sa2_mode = mode;
3906 p->sadb_x_sa2_reserved1 = 0;
3907 p->sadb_x_sa2_reserved2 = 0;
3908 p->sadb_x_sa2_sequence = seq;
3909 p->sadb_x_sa2_reqid = reqid;
3915 * Set data into sadb_x_sa_replay.
3917 static struct mbuf *
3918 key_setsadbxsareplay(u_int32_t replay)
3921 struct sadb_x_sa_replay *p;
3924 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa_replay));
3925 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3930 p = mtod(m, struct sadb_x_sa_replay *);
3933 p->sadb_x_sa_replay_len = PFKEY_UNIT64(len);
3934 p->sadb_x_sa_replay_exttype = SADB_X_EXT_SA_REPLAY;
3935 p->sadb_x_sa_replay_replay = (replay << 3);
3941 * Set a type in sadb_x_nat_t_type.
3943 static struct mbuf *
3944 key_setsadbxtype(u_int16_t type)
3948 struct sadb_x_nat_t_type *p;
3950 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_type));
3952 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3957 p = mtod(m, struct sadb_x_nat_t_type *);
3960 p->sadb_x_nat_t_type_len = PFKEY_UNIT64(len);
3961 p->sadb_x_nat_t_type_exttype = SADB_X_EXT_NAT_T_TYPE;
3962 p->sadb_x_nat_t_type_type = type;
3967 * Set a port in sadb_x_nat_t_port.
3968 * In contrast to default RFC 2367 behaviour, port is in network byte order.
3970 static struct mbuf *
3971 key_setsadbxport(u_int16_t port, u_int16_t type)
3975 struct sadb_x_nat_t_port *p;
3977 len = PFKEY_ALIGN8(sizeof(struct sadb_x_nat_t_port));
3979 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
3984 p = mtod(m, struct sadb_x_nat_t_port *);
3987 p->sadb_x_nat_t_port_len = PFKEY_UNIT64(len);
3988 p->sadb_x_nat_t_port_exttype = type;
3989 p->sadb_x_nat_t_port_port = port;
3995 * Get port from sockaddr. Port is in network byte order.
3998 key_portfromsaddr(struct sockaddr *sa)
4001 switch (sa->sa_family) {
4004 return ((struct sockaddr_in *)sa)->sin_port;
4008 return ((struct sockaddr_in6 *)sa)->sin6_port;
4015 * Set port in struct sockaddr. Port is in network byte order.
4018 key_porttosaddr(struct sockaddr *sa, uint16_t port)
4021 switch (sa->sa_family) {
4024 ((struct sockaddr_in *)sa)->sin_port = port;
4029 ((struct sockaddr_in6 *)sa)->sin6_port = port;
4033 ipseclog((LOG_DEBUG, "%s: unexpected address family %d.\n",
4034 __func__, sa->sa_family));
4040 * set data into sadb_x_policy
4042 static struct mbuf *
4043 key_setsadbxpolicy(u_int16_t type, u_int8_t dir, u_int32_t id, u_int32_t priority)
4046 struct sadb_x_policy *p;
4049 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
4050 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
4055 p = mtod(m, struct sadb_x_policy *);
4058 p->sadb_x_policy_len = PFKEY_UNIT64(len);
4059 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
4060 p->sadb_x_policy_type = type;
4061 p->sadb_x_policy_dir = dir;
4062 p->sadb_x_policy_id = id;
4063 p->sadb_x_policy_priority = priority;
4069 /* Take a key message (sadb_key) from the socket and turn it into one
4070 * of the kernel's key structures (seckey).
4072 * IN: pointer to the src
4073 * OUT: NULL no more memory
4076 key_dup_keymsg(const struct sadb_key *src, size_t len,
4077 struct malloc_type *type)
4081 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4083 dst->bits = src->sadb_key_bits;
4084 dst->key_data = malloc(len, type, M_NOWAIT);
4085 if (dst->key_data != NULL) {
4086 bcopy((const char *)(src + 1), dst->key_data, len);
4088 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4094 ipseclog((LOG_DEBUG, "%s: No more memory.\n",
4101 /* Take a lifetime message (sadb_lifetime) passed in on a socket and
4102 * turn it into one of the kernel's lifetime structures (seclifetime).
4104 * IN: pointer to the destination, source and malloc type
4105 * OUT: NULL, no more memory
4108 static struct seclifetime *
4109 key_dup_lifemsg(const struct sadb_lifetime *src, struct malloc_type *type)
4111 struct seclifetime *dst;
4113 dst = malloc(sizeof(*dst), type, M_NOWAIT);
4115 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
4118 dst->allocations = src->sadb_lifetime_allocations;
4119 dst->bytes = src->sadb_lifetime_bytes;
4120 dst->addtime = src->sadb_lifetime_addtime;
4121 dst->usetime = src->sadb_lifetime_usetime;
4126 * compare two secasindex structure.
4127 * flag can specify to compare 2 saidxes.
4128 * compare two secasindex structure without both mode and reqid.
4129 * don't compare port.
4131 * saidx0: source, it can be in SAD.
4138 key_cmpsaidx(const struct secasindex *saidx0, const struct secasindex *saidx1,
4143 if (saidx0 == NULL && saidx1 == NULL)
4146 if (saidx0 == NULL || saidx1 == NULL)
4149 if (saidx0->proto != saidx1->proto)
4152 if (flag == CMP_EXACTLY) {
4153 if (saidx0->mode != saidx1->mode)
4155 if (saidx0->reqid != saidx1->reqid)
4157 if (bcmp(&saidx0->src, &saidx1->src,
4158 saidx0->src.sa.sa_len) != 0 ||
4159 bcmp(&saidx0->dst, &saidx1->dst,
4160 saidx0->dst.sa.sa_len) != 0)
4164 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
4165 if (flag == CMP_MODE_REQID || flag == CMP_REQID) {
4167 * If reqid of SPD is non-zero, unique SA is required.
4168 * The result must be of same reqid in this case.
4170 if (saidx1->reqid != 0 &&
4171 saidx0->reqid != saidx1->reqid)
4175 if (flag == CMP_MODE_REQID) {
4176 if (saidx0->mode != IPSEC_MODE_ANY
4177 && saidx0->mode != saidx1->mode)
4181 if (key_sockaddrcmp(&saidx0->src.sa, &saidx1->src.sa, 0) != 0)
4183 if (key_sockaddrcmp(&saidx0->dst.sa, &saidx1->dst.sa, 0) != 0)
4191 * compare two secindex structure exactly.
4193 * spidx0: source, it is often in SPD.
4194 * spidx1: object, it is often from PFKEY message.
4200 key_cmpspidx_exactly(struct secpolicyindex *spidx0,
4201 struct secpolicyindex *spidx1)
4204 if (spidx0 == NULL && spidx1 == NULL)
4207 if (spidx0 == NULL || spidx1 == NULL)
4210 if (spidx0->prefs != spidx1->prefs
4211 || spidx0->prefd != spidx1->prefd
4212 || spidx0->ul_proto != spidx1->ul_proto
4213 || spidx0->dir != spidx1->dir)
4216 return key_sockaddrcmp(&spidx0->src.sa, &spidx1->src.sa, 1) == 0 &&
4217 key_sockaddrcmp(&spidx0->dst.sa, &spidx1->dst.sa, 1) == 0;
4221 * compare two secindex structure with mask.
4223 * spidx0: source, it is often in SPD.
4224 * spidx1: object, it is often from IP header.
4230 key_cmpspidx_withmask(struct secpolicyindex *spidx0,
4231 struct secpolicyindex *spidx1)
4234 if (spidx0 == NULL && spidx1 == NULL)
4237 if (spidx0 == NULL || spidx1 == NULL)
4240 if (spidx0->src.sa.sa_family != spidx1->src.sa.sa_family ||
4241 spidx0->dst.sa.sa_family != spidx1->dst.sa.sa_family ||
4242 spidx0->src.sa.sa_len != spidx1->src.sa.sa_len ||
4243 spidx0->dst.sa.sa_len != spidx1->dst.sa.sa_len)
4246 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
4247 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
4248 && spidx0->ul_proto != spidx1->ul_proto)
4251 switch (spidx0->src.sa.sa_family) {
4253 if (spidx0->src.sin.sin_port != IPSEC_PORT_ANY
4254 && spidx0->src.sin.sin_port != spidx1->src.sin.sin_port)
4256 if (!key_bbcmp(&spidx0->src.sin.sin_addr,
4257 &spidx1->src.sin.sin_addr, spidx0->prefs))
4261 if (spidx0->src.sin6.sin6_port != IPSEC_PORT_ANY
4262 && spidx0->src.sin6.sin6_port != spidx1->src.sin6.sin6_port)
4265 * scope_id check. if sin6_scope_id is 0, we regard it
4266 * as a wildcard scope, which matches any scope zone ID.
4268 if (spidx0->src.sin6.sin6_scope_id &&
4269 spidx1->src.sin6.sin6_scope_id &&
4270 spidx0->src.sin6.sin6_scope_id != spidx1->src.sin6.sin6_scope_id)
4272 if (!key_bbcmp(&spidx0->src.sin6.sin6_addr,
4273 &spidx1->src.sin6.sin6_addr, spidx0->prefs))
4278 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.sa.sa_len) != 0)
4283 switch (spidx0->dst.sa.sa_family) {
4285 if (spidx0->dst.sin.sin_port != IPSEC_PORT_ANY
4286 && spidx0->dst.sin.sin_port != spidx1->dst.sin.sin_port)
4288 if (!key_bbcmp(&spidx0->dst.sin.sin_addr,
4289 &spidx1->dst.sin.sin_addr, spidx0->prefd))
4293 if (spidx0->dst.sin6.sin6_port != IPSEC_PORT_ANY
4294 && spidx0->dst.sin6.sin6_port != spidx1->dst.sin6.sin6_port)
4297 * scope_id check. if sin6_scope_id is 0, we regard it
4298 * as a wildcard scope, which matches any scope zone ID.
4300 if (spidx0->dst.sin6.sin6_scope_id &&
4301 spidx1->dst.sin6.sin6_scope_id &&
4302 spidx0->dst.sin6.sin6_scope_id != spidx1->dst.sin6.sin6_scope_id)
4304 if (!key_bbcmp(&spidx0->dst.sin6.sin6_addr,
4305 &spidx1->dst.sin6.sin6_addr, spidx0->prefd))
4310 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.sa.sa_len) != 0)
4315 /* XXX Do we check other field ? e.g. flowinfo */
4323 #define satosin(s) ((const struct sockaddr_in *)s)
4327 #define satosin6(s) ((const struct sockaddr_in6 *)s)
4328 /* returns 0 on match */
4330 key_sockaddrcmp(const struct sockaddr *sa1, const struct sockaddr *sa2,
4333 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4336 switch (sa1->sa_family) {
4339 if (sa1->sa_len != sizeof(struct sockaddr_in))
4341 if (satosin(sa1)->sin_addr.s_addr !=
4342 satosin(sa2)->sin_addr.s_addr) {
4345 if (port && satosin(sa1)->sin_port != satosin(sa2)->sin_port)
4351 if (sa1->sa_len != sizeof(struct sockaddr_in6))
4352 return 1; /*EINVAL*/
4353 if (satosin6(sa1)->sin6_scope_id !=
4354 satosin6(sa2)->sin6_scope_id) {
4357 if (!IN6_ARE_ADDR_EQUAL(&satosin6(sa1)->sin6_addr,
4358 &satosin6(sa2)->sin6_addr)) {
4362 satosin6(sa1)->sin6_port != satosin6(sa2)->sin6_port) {
4368 if (bcmp(sa1, sa2, sa1->sa_len) != 0)
4376 /* returns 0 on match */
4378 key_sockaddrcmp_withmask(const struct sockaddr *sa1,
4379 const struct sockaddr *sa2, size_t mask)
4381 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len)
4384 switch (sa1->sa_family) {
4387 return (!key_bbcmp(&satosin(sa1)->sin_addr,
4388 &satosin(sa2)->sin_addr, mask));
4392 if (satosin6(sa1)->sin6_scope_id !=
4393 satosin6(sa2)->sin6_scope_id)
4395 return (!key_bbcmp(&satosin6(sa1)->sin6_addr,
4396 &satosin6(sa2)->sin6_addr, mask));
4405 * compare two buffers with mask.
4409 * bits: Number of bits to compare
4415 key_bbcmp(const void *a1, const void *a2, u_int bits)
4417 const unsigned char *p1 = a1;
4418 const unsigned char *p2 = a2;
4420 /* XXX: This could be considerably faster if we compare a word
4421 * at a time, but it is complicated on LSB Endian machines */
4423 /* Handle null pointers */
4424 if (p1 == NULL || p2 == NULL)
4434 u_int8_t mask = ~((1<<(8-bits))-1);
4435 if ((*p1 & mask) != (*p2 & mask))
4438 return 1; /* Match! */
4442 key_flush_spd(time_t now)
4444 SPTREE_RLOCK_TRACKER;
4445 struct secpolicy_list drainq;
4446 struct secpolicy *sp, *nextsp;
4451 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
4452 TAILQ_FOREACH(sp, &V_sptree[dir], chain) {
4453 if (sp->lifetime == 0 && sp->validtime == 0)
4455 if ((sp->lifetime &&
4456 now - sp->created > sp->lifetime) ||
4458 now - sp->lastused > sp->validtime)) {
4459 /* Hold extra reference to send SPDEXPIRE */
4461 LIST_INSERT_HEAD(&drainq, sp, drainq);
4466 if (LIST_EMPTY(&drainq))
4470 sp = LIST_FIRST(&drainq);
4471 while (sp != NULL) {
4472 nextsp = LIST_NEXT(sp, drainq);
4473 /* Check that SP is still linked */
4474 if (sp->state != IPSEC_SPSTATE_ALIVE) {
4475 LIST_REMOVE(sp, drainq);
4476 key_freesp(&sp); /* release extra reference */
4480 TAILQ_REMOVE(&V_sptree[sp->spidx.dir], sp, chain);
4482 LIST_REMOVE(sp, idhash);
4483 sp->state = IPSEC_SPSTATE_DEAD;
4488 if (SPDCACHE_ENABLED())
4491 sp = LIST_FIRST(&drainq);
4492 while (sp != NULL) {
4493 nextsp = LIST_NEXT(sp, drainq);
4495 key_freesp(&sp); /* release extra reference */
4496 key_freesp(&sp); /* release last reference */
4502 key_flush_sad(time_t now)
4504 SAHTREE_RLOCK_TRACKER;
4505 struct secashead_list emptyq;
4506 struct secasvar_list drainq, hexpireq, sexpireq, freeq;
4507 struct secashead *sah, *nextsah;
4508 struct secasvar *sav, *nextsav;
4511 LIST_INIT(&hexpireq);
4512 LIST_INIT(&sexpireq);
4516 TAILQ_FOREACH(sah, &V_sahtree, chain) {
4517 /* Check for empty SAH */
4518 if (TAILQ_EMPTY(&sah->savtree_larval) &&
4519 TAILQ_EMPTY(&sah->savtree_alive)) {
4521 LIST_INSERT_HEAD(&emptyq, sah, drainq);
4524 /* Add all stale LARVAL SAs into drainq */
4525 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
4526 if (now - sav->created < V_key_larval_lifetime)
4529 LIST_INSERT_HEAD(&drainq, sav, drainq);
4531 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
4532 /* lifetimes aren't specified */
4533 if (sav->lft_h == NULL)
4537 * Check again with lock held, because it may
4538 * be updated by SADB_UPDATE.
4540 if (sav->lft_h == NULL) {
4541 SECASVAR_UNLOCK(sav);
4546 * HARD lifetimes MUST take precedence over SOFT
4547 * lifetimes, meaning if the HARD and SOFT lifetimes
4548 * are the same, the HARD lifetime will appear on the
4551 /* check HARD lifetime */
4552 if ((sav->lft_h->addtime != 0 &&
4553 now - sav->created > sav->lft_h->addtime) ||
4554 (sav->lft_h->usetime != 0 && sav->firstused &&
4555 now - sav->firstused > sav->lft_h->usetime) ||
4556 (sav->lft_h->bytes != 0 && counter_u64_fetch(
4557 sav->lft_c_bytes) > sav->lft_h->bytes)) {
4558 SECASVAR_UNLOCK(sav);
4560 LIST_INSERT_HEAD(&hexpireq, sav, drainq);
4563 /* check SOFT lifetime (only for MATURE SAs) */
4564 if (sav->state == SADB_SASTATE_MATURE && (
4565 (sav->lft_s->addtime != 0 &&
4566 now - sav->created > sav->lft_s->addtime) ||
4567 (sav->lft_s->usetime != 0 && sav->firstused &&
4568 now - sav->firstused > sav->lft_s->usetime) ||
4569 (sav->lft_s->bytes != 0 && counter_u64_fetch(
4570 sav->lft_c_bytes) > sav->lft_s->bytes))) {
4571 SECASVAR_UNLOCK(sav);
4573 LIST_INSERT_HEAD(&sexpireq, sav, drainq);
4576 SECASVAR_UNLOCK(sav);
4581 if (LIST_EMPTY(&emptyq) && LIST_EMPTY(&drainq) &&
4582 LIST_EMPTY(&hexpireq) && LIST_EMPTY(&sexpireq))
4587 /* Unlink stale LARVAL SAs */
4588 sav = LIST_FIRST(&drainq);
4589 while (sav != NULL) {
4590 nextsav = LIST_NEXT(sav, drainq);
4591 /* Check that SA is still LARVAL */
4592 if (sav->state != SADB_SASTATE_LARVAL) {
4593 LIST_REMOVE(sav, drainq);
4594 LIST_INSERT_HEAD(&freeq, sav, drainq);
4598 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
4599 LIST_REMOVE(sav, spihash);
4600 sav->state = SADB_SASTATE_DEAD;
4603 /* Unlink all SAs with expired HARD lifetime */
4604 sav = LIST_FIRST(&hexpireq);
4605 while (sav != NULL) {
4606 nextsav = LIST_NEXT(sav, drainq);
4607 /* Check that SA is not unlinked */
4608 if (sav->state == SADB_SASTATE_DEAD) {
4609 LIST_REMOVE(sav, drainq);
4610 LIST_INSERT_HEAD(&freeq, sav, drainq);
4614 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
4615 LIST_REMOVE(sav, spihash);
4616 sav->state = SADB_SASTATE_DEAD;
4619 /* Mark all SAs with expired SOFT lifetime as DYING */
4620 sav = LIST_FIRST(&sexpireq);
4621 while (sav != NULL) {
4622 nextsav = LIST_NEXT(sav, drainq);
4623 /* Check that SA is not unlinked */
4624 if (sav->state == SADB_SASTATE_DEAD) {
4625 LIST_REMOVE(sav, drainq);
4626 LIST_INSERT_HEAD(&freeq, sav, drainq);
4631 * NOTE: this doesn't change SA order in the chain.
4633 sav->state = SADB_SASTATE_DYING;
4636 /* Unlink empty SAHs */
4637 sah = LIST_FIRST(&emptyq);
4638 while (sah != NULL) {
4639 nextsah = LIST_NEXT(sah, drainq);
4640 /* Check that SAH is still empty and not unlinked */
4641 if (sah->state == SADB_SASTATE_DEAD ||
4642 !TAILQ_EMPTY(&sah->savtree_larval) ||
4643 !TAILQ_EMPTY(&sah->savtree_alive)) {
4644 LIST_REMOVE(sah, drainq);
4645 key_freesah(&sah); /* release extra reference */
4649 TAILQ_REMOVE(&V_sahtree, sah, chain);
4650 LIST_REMOVE(sah, addrhash);
4651 sah->state = SADB_SASTATE_DEAD;
4656 /* Send SPDEXPIRE messages */
4657 sav = LIST_FIRST(&hexpireq);
4658 while (sav != NULL) {
4659 nextsav = LIST_NEXT(sav, drainq);
4661 key_freesah(&sav->sah); /* release reference from SAV */
4662 key_freesav(&sav); /* release extra reference */
4663 key_freesav(&sav); /* release last reference */
4666 sav = LIST_FIRST(&sexpireq);
4667 while (sav != NULL) {
4668 nextsav = LIST_NEXT(sav, drainq);
4670 key_freesav(&sav); /* release extra reference */
4673 /* Free stale LARVAL SAs */
4674 sav = LIST_FIRST(&drainq);
4675 while (sav != NULL) {
4676 nextsav = LIST_NEXT(sav, drainq);
4677 key_freesah(&sav->sah); /* release reference from SAV */
4678 key_freesav(&sav); /* release extra reference */
4679 key_freesav(&sav); /* release last reference */
4682 /* Free SAs that were unlinked/changed by someone else */
4683 sav = LIST_FIRST(&freeq);
4684 while (sav != NULL) {
4685 nextsav = LIST_NEXT(sav, drainq);
4686 key_freesav(&sav); /* release extra reference */
4689 /* Free empty SAH */
4690 sah = LIST_FIRST(&emptyq);
4691 while (sah != NULL) {
4692 nextsah = LIST_NEXT(sah, drainq);
4693 key_freesah(&sah); /* release extra reference */
4694 key_freesah(&sah); /* release last reference */
4700 key_flush_acq(time_t now)
4702 struct secacq *acq, *nextacq;
4706 acq = LIST_FIRST(&V_acqtree);
4707 while (acq != NULL) {
4708 nextacq = LIST_NEXT(acq, chain);
4709 if (now - acq->created > V_key_blockacq_lifetime) {
4710 LIST_REMOVE(acq, chain);
4711 LIST_REMOVE(acq, addrhash);
4712 LIST_REMOVE(acq, seqhash);
4713 free(acq, M_IPSEC_SAQ);
4721 key_flush_spacq(time_t now)
4723 struct secspacq *acq, *nextacq;
4727 for (acq = LIST_FIRST(&V_spacqtree); acq != NULL; acq = nextacq) {
4728 nextacq = LIST_NEXT(acq, chain);
4729 if (now - acq->created > V_key_blockacq_lifetime
4730 && __LIST_CHAINED(acq)) {
4731 LIST_REMOVE(acq, chain);
4732 free(acq, M_IPSEC_SAQ);
4740 * scanning SPD and SAD to check status for each entries,
4741 * and do to remove or to expire.
4742 * XXX: year 2038 problem may remain.
4745 key_timehandler(void *arg)
4747 VNET_ITERATOR_DECL(vnet_iter);
4748 time_t now = time_second;
4750 VNET_LIST_RLOCK_NOSLEEP();
4751 VNET_FOREACH(vnet_iter) {
4752 CURVNET_SET(vnet_iter);
4756 key_flush_spacq(now);
4759 VNET_LIST_RUNLOCK_NOSLEEP();
4761 #ifndef IPSEC_DEBUG2
4762 /* do exchange to tick time !! */
4763 callout_schedule(&key_timer, hz);
4764 #endif /* IPSEC_DEBUG2 */
4772 key_randomfill(&value, sizeof(value));
4777 key_randomfill(void *p, size_t l)
4781 static int warn = 1;
4784 n = (size_t)read_random(p, (u_int)l);
4788 bcopy(&v, (u_int8_t *)p + n,
4789 l - n < sizeof(v) ? l - n : sizeof(v));
4793 printf("WARNING: pseudo-random number generator "
4794 "used for IPsec processing\n");
4801 * map SADB_SATYPE_* to IPPROTO_*.
4802 * if satype == SADB_SATYPE then satype is mapped to ~0.
4804 * 0: invalid satype.
4807 key_satype2proto(uint8_t satype)
4810 case SADB_SATYPE_UNSPEC:
4811 return IPSEC_PROTO_ANY;
4812 case SADB_SATYPE_AH:
4814 case SADB_SATYPE_ESP:
4816 case SADB_X_SATYPE_IPCOMP:
4817 return IPPROTO_IPCOMP;
4818 case SADB_X_SATYPE_TCPSIGNATURE:
4827 * map IPPROTO_* to SADB_SATYPE_*
4829 * 0: invalid protocol type.
4832 key_proto2satype(uint8_t proto)
4836 return SADB_SATYPE_AH;
4838 return SADB_SATYPE_ESP;
4839 case IPPROTO_IPCOMP:
4840 return SADB_X_SATYPE_IPCOMP;
4842 return SADB_X_SATYPE_TCPSIGNATURE;
4851 * SADB_GETSPI processing is to receive
4852 * <base, (SA2), src address, dst address, (SPI range)>
4853 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
4854 * tree with the status of LARVAL, and send
4855 * <base, SA(*), address(SD)>
4858 * IN: mhp: pointer to the pointer to each header.
4859 * OUT: NULL if fail.
4860 * other if success, return pointer to the message to send.
4863 key_getspi(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
4865 struct secasindex saidx;
4866 struct sadb_address *src0, *dst0;
4867 struct secasvar *sav;
4868 uint32_t reqid, spi;
4870 uint8_t mode, proto;
4872 IPSEC_ASSERT(so != NULL, ("null socket"));
4873 IPSEC_ASSERT(m != NULL, ("null mbuf"));
4874 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
4875 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
4877 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
4878 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)
4879 #ifdef PFKEY_STRICT_CHECKS
4880 || SADB_CHECKHDR(mhp, SADB_EXT_SPIRANGE)
4883 ipseclog((LOG_DEBUG,
4884 "%s: invalid message: missing required header.\n",
4889 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
4890 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)
4891 #ifdef PFKEY_STRICT_CHECKS
4892 || SADB_CHECKLEN(mhp, SADB_EXT_SPIRANGE)
4895 ipseclog((LOG_DEBUG,
4896 "%s: invalid message: wrong header size.\n", __func__));
4900 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
4901 mode = IPSEC_MODE_ANY;
4904 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
4905 ipseclog((LOG_DEBUG,
4906 "%s: invalid message: wrong header size.\n",
4911 mode = ((struct sadb_x_sa2 *)
4912 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
4913 reqid = ((struct sadb_x_sa2 *)
4914 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
4917 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
4918 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
4920 /* map satype to proto */
4921 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
4922 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
4927 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
4928 (struct sockaddr *)(dst0 + 1));
4930 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
4934 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
4936 /* SPI allocation */
4937 spi = key_do_getnewspi(
4938 (struct sadb_spirange *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
4941 * Requested SPI or SPI range is not available or
4947 sav = key_newsav(mhp, &saidx, spi, &error);
4951 if (sav->seq != 0) {
4954 * If the SADB_GETSPI message is in response to a
4955 * kernel-generated SADB_ACQUIRE, the sadb_msg_seq
4956 * MUST be the same as the SADB_ACQUIRE message.
4958 * XXXAE: However it doesn't definethe behaviour how to
4959 * check this and what to do if it doesn't match.
4960 * Also what we should do if it matches?
4962 * We can compare saidx used in SADB_ACQUIRE with saidx
4963 * used in SADB_GETSPI, but this probably can break
4964 * existing software. For now just warn if it doesn't match.
4966 * XXXAE: anyway it looks useless.
4968 key_acqdone(&saidx, sav->seq);
4971 printf("%s: SA(%p)\n", __func__, sav));
4972 KEYDBG(KEY_DATA, kdebug_secasv(sav));
4975 struct mbuf *n, *nn;
4976 struct sadb_sa *m_sa;
4977 struct sadb_msg *newmsg;
4980 /* create new sadb_msg to reply. */
4981 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
4982 PFKEY_ALIGN8(sizeof(struct sadb_sa));
4984 MGETHDR(n, M_NOWAIT, MT_DATA);
4986 if (!(MCLGET(n, M_NOWAIT))) {
5000 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
5001 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
5003 m_sa = (struct sadb_sa *)(mtod(n, caddr_t) + off);
5004 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
5005 m_sa->sadb_sa_exttype = SADB_EXT_SA;
5006 m_sa->sadb_sa_spi = spi; /* SPI is already in network byte order */
5007 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
5009 IPSEC_ASSERT(off == len,
5010 ("length inconsistency (off %u len %u)", off, len));
5012 n->m_next = key_gather_mbuf(m, mhp, 0, 2, SADB_EXT_ADDRESS_SRC,
5013 SADB_EXT_ADDRESS_DST);
5020 if (n->m_len < sizeof(struct sadb_msg)) {
5021 n = m_pullup(n, sizeof(struct sadb_msg));
5023 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
5026 n->m_pkthdr.len = 0;
5027 for (nn = n; nn; nn = nn->m_next)
5028 n->m_pkthdr.len += nn->m_len;
5030 newmsg = mtod(n, struct sadb_msg *);
5031 newmsg->sadb_msg_seq = sav->seq;
5032 newmsg->sadb_msg_errno = 0;
5033 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
5036 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
5040 return (key_senderror(so, m, error));
5044 * allocating new SPI
5045 * called by key_getspi().
5048 * others: success, SPI in network byte order.
5051 key_do_getnewspi(struct sadb_spirange *spirange, struct secasindex *saidx)
5053 uint32_t min, max, newspi, t;
5054 int count = V_key_spi_trycnt;
5056 /* set spi range to allocate */
5057 if (spirange != NULL) {
5058 min = spirange->sadb_spirange_min;
5059 max = spirange->sadb_spirange_max;
5061 min = V_key_spi_minval;
5062 max = V_key_spi_maxval;
5064 /* IPCOMP needs 2-byte SPI */
5065 if (saidx->proto == IPPROTO_IPCOMP) {
5071 t = min; min = max; max = t;
5076 if (!key_checkspidup(htonl(min))) {
5077 ipseclog((LOG_DEBUG, "%s: SPI %u exists already.\n",
5082 count--; /* taking one cost. */
5089 /* when requesting to allocate spi ranged */
5091 /* generate pseudo-random SPI value ranged. */
5092 newspi = min + (key_random() % (max - min + 1));
5093 if (!key_checkspidup(htonl(newspi)))
5097 if (count == 0 || newspi == 0) {
5098 ipseclog((LOG_DEBUG,
5099 "%s: failed to allocate SPI.\n", __func__));
5105 keystat.getspi_count =
5106 (keystat.getspi_count + V_key_spi_trycnt - count) / 2;
5108 return (htonl(newspi));
5112 * Find TCP-MD5 SA with corresponding secasindex.
5113 * If not found, return NULL and fill SPI with usable value if needed.
5115 static struct secasvar *
5116 key_getsav_tcpmd5(struct secasindex *saidx, uint32_t *spi)
5118 SAHTREE_RLOCK_TRACKER;
5119 struct secashead *sah;
5120 struct secasvar *sav;
5122 IPSEC_ASSERT(saidx->proto == IPPROTO_TCP, ("wrong proto"));
5124 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
5125 if (sah->saidx.proto != IPPROTO_TCP)
5127 if (!key_sockaddrcmp(&saidx->dst.sa, &sah->saidx.dst.sa, 0) &&
5128 !key_sockaddrcmp(&saidx->src.sa, &sah->saidx.src.sa, 0))
5132 if (V_key_preferred_oldsa)
5133 sav = TAILQ_LAST(&sah->savtree_alive, secasvar_queue);
5135 sav = TAILQ_FIRST(&sah->savtree_alive);
5143 /* No SPI required */
5147 /* Check that SPI is unique */
5148 LIST_FOREACH(sav, SAVHASH_HASH(*spi), spihash) {
5149 if (sav->spi == *spi)
5154 /* SPI is already unique */
5158 /* XXX: not optimal */
5159 *spi = key_do_getnewspi(NULL, saidx);
5164 key_updateaddresses(struct socket *so, struct mbuf *m,
5165 const struct sadb_msghdr *mhp, struct secasvar *sav,
5166 struct secasindex *saidx)
5168 struct sockaddr *newaddr;
5169 struct secashead *sah;
5170 struct secasvar *newsav, *tmp;
5174 /* Check that we need to change SAH */
5175 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC)) {
5176 newaddr = (struct sockaddr *)(
5177 ((struct sadb_address *)
5178 mhp->ext[SADB_X_EXT_NEW_ADDRESS_SRC]) + 1);
5179 bcopy(newaddr, &saidx->src, newaddr->sa_len);
5180 key_porttosaddr(&saidx->src.sa, 0);
5182 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5183 newaddr = (struct sockaddr *)(
5184 ((struct sadb_address *)
5185 mhp->ext[SADB_X_EXT_NEW_ADDRESS_DST]) + 1);
5186 bcopy(newaddr, &saidx->dst, newaddr->sa_len);
5187 key_porttosaddr(&saidx->dst.sa, 0);
5189 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5190 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST)) {
5191 error = key_checksockaddrs(&saidx->src.sa, &saidx->dst.sa);
5193 ipseclog((LOG_DEBUG, "%s: invalid new sockaddr.\n",
5198 sah = key_getsah(saidx);
5200 /* create a new SA index */
5201 sah = key_newsah(saidx);
5203 ipseclog((LOG_DEBUG,
5204 "%s: No more memory.\n", __func__));
5207 isnew = 2; /* SAH is new */
5209 isnew = 1; /* existing SAH is referenced */
5212 * src and dst addresses are still the same.
5213 * Do we want to change NAT-T config?
5215 if (sav->sah->saidx.proto != IPPROTO_ESP ||
5216 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5217 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5218 SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5219 ipseclog((LOG_DEBUG,
5220 "%s: invalid message: missing required header.\n",
5224 /* We hold reference to SA, thus SAH will be referenced too. */
5229 newsav = malloc(sizeof(struct secasvar), M_IPSEC_SA,
5231 if (newsav == NULL) {
5232 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5237 /* Clone SA's content into newsav */
5238 SAV_INITREF(newsav);
5239 bcopy(sav, newsav, offsetof(struct secasvar, chain));
5241 * We create new NAT-T config if it is needed.
5242 * Old NAT-T config will be freed by key_cleansav() when
5243 * last reference to SA will be released.
5245 newsav->natt = NULL;
5247 newsav->state = SADB_SASTATE_MATURE;
5248 error = key_setnatt(newsav, mhp);
5253 /* Check that SA is still alive */
5254 if (sav->state == SADB_SASTATE_DEAD) {
5255 /* SA was unlinked */
5261 /* Unlink SA from SAH and SPI hash */
5262 IPSEC_ASSERT((sav->flags & SADB_X_EXT_F_CLONED) == 0,
5263 ("SA is already cloned"));
5264 IPSEC_ASSERT(sav->state == SADB_SASTATE_MATURE ||
5265 sav->state == SADB_SASTATE_DYING,
5266 ("Wrong SA state %u\n", sav->state));
5267 TAILQ_REMOVE(&sav->sah->savtree_alive, sav, chain);
5268 LIST_REMOVE(sav, spihash);
5269 sav->state = SADB_SASTATE_DEAD;
5272 * Link new SA with SAH. Keep SAs ordered by
5273 * create time (newer are first).
5275 TAILQ_FOREACH(tmp, &sah->savtree_alive, chain) {
5276 if (newsav->created > tmp->created) {
5277 TAILQ_INSERT_BEFORE(tmp, newsav, chain);
5282 TAILQ_INSERT_TAIL(&sah->savtree_alive, newsav, chain);
5284 /* Add new SA into SPI hash. */
5285 LIST_INSERT_HEAD(SAVHASH_HASH(newsav->spi), newsav, spihash);
5287 /* Add new SAH into SADB. */
5289 TAILQ_INSERT_HEAD(&V_sahtree, sah, chain);
5290 LIST_INSERT_HEAD(SAHADDRHASH_HASH(saidx), sah, addrhash);
5291 sah->state = SADB_SASTATE_MATURE;
5292 SAH_ADDREF(sah); /* newsav references new SAH */
5295 * isnew == 1 -> @sah was referenced by key_getsah().
5296 * isnew == 0 -> we use the same @sah, that was used by @sav,
5297 * and we use its reference for @newsav.
5300 /* XXX: replace cntr with pointer? */
5301 newsav->cntr = sav->cntr;
5302 sav->flags |= SADB_X_EXT_F_CLONED;
5303 SECASVAR_UNLOCK(sav);
5308 printf("%s: SA(%p) cloned into SA(%p)\n",
5309 __func__, sav, newsav));
5310 KEYDBG(KEY_DATA, kdebug_secasv(newsav));
5312 key_freesav(&sav); /* release last reference */
5314 /* set msg buf from mhp */
5315 n = key_getmsgbuf_x1(m, mhp);
5317 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5321 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5326 if (newsav != NULL) {
5327 if (newsav->natt != NULL)
5328 free(newsav->natt, M_IPSEC_MISC);
5329 free(newsav, M_IPSEC_SA);
5335 * SADB_UPDATE processing
5337 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5338 * key(AE), (identity(SD),) (sensitivity)>
5339 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
5341 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5342 * (identity(SD),) (sensitivity)>
5345 * m will always be freed.
5348 key_update(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5350 struct secasindex saidx;
5351 struct sadb_address *src0, *dst0;
5352 struct sadb_sa *sa0;
5353 struct secasvar *sav;
5356 uint8_t mode, proto;
5358 IPSEC_ASSERT(so != NULL, ("null socket"));
5359 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5360 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5361 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5363 /* map satype to proto */
5364 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5365 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5367 return key_senderror(so, m, EINVAL);
5370 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5371 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5372 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5373 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5374 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5375 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5376 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5377 ipseclog((LOG_DEBUG,
5378 "%s: invalid message: missing required header.\n",
5380 return key_senderror(so, m, EINVAL);
5382 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5383 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5384 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5385 ipseclog((LOG_DEBUG,
5386 "%s: invalid message: wrong header size.\n", __func__));
5387 return key_senderror(so, m, EINVAL);
5389 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5390 mode = IPSEC_MODE_ANY;
5393 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5394 ipseclog((LOG_DEBUG,
5395 "%s: invalid message: wrong header size.\n",
5397 return key_senderror(so, m, EINVAL);
5399 mode = ((struct sadb_x_sa2 *)
5400 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5401 reqid = ((struct sadb_x_sa2 *)
5402 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5405 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5406 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
5407 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
5410 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5411 * SADB_UPDATE message.
5413 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5414 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5415 #ifdef PFKEY_STRICT_CHECKS
5416 return key_senderror(so, m, EINVAL);
5419 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5420 (struct sockaddr *)(dst0 + 1));
5422 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5423 return key_senderror(so, m, error);
5425 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5426 sav = key_getsavbyspi(sa0->sadb_sa_spi);
5428 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u\n",
5429 __func__, ntohl(sa0->sadb_sa_spi)));
5430 return key_senderror(so, m, EINVAL);
5433 * Check that SADB_UPDATE issued by the same process that did
5434 * SADB_GETSPI or SADB_ADD.
5436 if (sav->pid != mhp->msg->sadb_msg_pid) {
5437 ipseclog((LOG_DEBUG,
5438 "%s: pid mismatched (SPI %u, pid %u vs. %u)\n", __func__,
5439 ntohl(sav->spi), sav->pid, mhp->msg->sadb_msg_pid));
5441 return key_senderror(so, m, EINVAL);
5443 /* saidx should match with SA. */
5444 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_MODE_REQID) == 0) {
5445 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u",
5446 __func__, ntohl(sav->spi)));
5448 return key_senderror(so, m, ESRCH);
5451 if (sav->state == SADB_SASTATE_LARVAL) {
5452 if ((mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
5453 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT)) ||
5454 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
5455 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH))) {
5456 ipseclog((LOG_DEBUG,
5457 "%s: invalid message: missing required header.\n",
5460 return key_senderror(so, m, EINVAL);
5463 * We can set any values except src, dst and SPI.
5465 error = key_setsaval(sav, mhp);
5468 return (key_senderror(so, m, error));
5470 /* Change SA state to MATURE */
5472 if (sav->state != SADB_SASTATE_LARVAL) {
5473 /* SA was deleted or another thread made it MATURE. */
5476 return (key_senderror(so, m, ESRCH));
5479 * NOTE: we keep SAs in savtree_alive ordered by created
5480 * time. When SA's state changed from LARVAL to MATURE,
5481 * we update its created time in key_setsaval() and move
5482 * it into head of savtree_alive.
5484 TAILQ_REMOVE(&sav->sah->savtree_larval, sav, chain);
5485 TAILQ_INSERT_HEAD(&sav->sah->savtree_alive, sav, chain);
5486 sav->state = SADB_SASTATE_MATURE;
5490 * For DYING and MATURE SA we can change only state
5491 * and lifetimes. Report EINVAL if something else attempted
5494 if (!SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5495 !SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH)) {
5497 return (key_senderror(so, m, EINVAL));
5499 error = key_updatelifetimes(sav, mhp);
5502 return (key_senderror(so, m, error));
5505 * This is FreeBSD extension to RFC2367.
5506 * IKEd can specify SADB_X_EXT_NEW_ADDRESS_SRC and/or
5507 * SADB_X_EXT_NEW_ADDRESS_DST when it wants to change
5508 * SA addresses (for example to implement MOBIKE protocol
5509 * as described in RFC4555). Also we allow to change
5512 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_SRC) ||
5513 !SADB_CHECKHDR(mhp, SADB_X_EXT_NEW_ADDRESS_DST) ||
5514 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5515 sav->natt != NULL) {
5516 error = key_updateaddresses(so, m, mhp, sav, &saidx);
5519 return (key_senderror(so, m, error));
5522 /* Check that SA is still alive */
5524 if (sav->state == SADB_SASTATE_DEAD) {
5525 /* SA was unlinked */
5528 return (key_senderror(so, m, ESRCH));
5531 * NOTE: there is possible state moving from DYING to MATURE,
5532 * but this doesn't change created time, so we won't reorder
5535 sav->state = SADB_SASTATE_MATURE;
5539 printf("%s: SA(%p)\n", __func__, sav));
5540 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5546 /* set msg buf from mhp */
5547 n = key_getmsgbuf_x1(m, mhp);
5549 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5550 return key_senderror(so, m, ENOBUFS);
5554 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5559 * SADB_ADD processing
5560 * add an entry to SA database, when received
5561 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5562 * key(AE), (identity(SD),) (sensitivity)>
5565 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
5566 * (identity(SD),) (sensitivity)>
5569 * IGNORE identity and sensitivity messages.
5571 * m will always be freed.
5574 key_add(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
5576 struct secasindex saidx;
5577 struct sadb_address *src0, *dst0;
5578 struct sadb_sa *sa0;
5579 struct secasvar *sav;
5580 uint32_t reqid, spi;
5581 uint8_t mode, proto;
5584 IPSEC_ASSERT(so != NULL, ("null socket"));
5585 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5586 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5587 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5589 /* map satype to proto */
5590 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
5591 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
5593 return key_senderror(so, m, EINVAL);
5596 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
5597 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
5598 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
5599 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP && (
5600 SADB_CHECKHDR(mhp, SADB_EXT_KEY_ENCRYPT) ||
5601 SADB_CHECKLEN(mhp, SADB_EXT_KEY_ENCRYPT))) ||
5602 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH && (
5603 SADB_CHECKHDR(mhp, SADB_EXT_KEY_AUTH) ||
5604 SADB_CHECKLEN(mhp, SADB_EXT_KEY_AUTH))) ||
5605 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD) &&
5606 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT)) ||
5607 (SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_SOFT) &&
5608 !SADB_CHECKHDR(mhp, SADB_EXT_LIFETIME_HARD))) {
5609 ipseclog((LOG_DEBUG,
5610 "%s: invalid message: missing required header.\n",
5612 return key_senderror(so, m, EINVAL);
5614 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
5615 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
5616 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
5617 ipseclog((LOG_DEBUG,
5618 "%s: invalid message: wrong header size.\n", __func__));
5619 return key_senderror(so, m, EINVAL);
5621 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
5622 mode = IPSEC_MODE_ANY;
5625 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
5626 ipseclog((LOG_DEBUG,
5627 "%s: invalid message: wrong header size.\n",
5629 return key_senderror(so, m, EINVAL);
5631 mode = ((struct sadb_x_sa2 *)
5632 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
5633 reqid = ((struct sadb_x_sa2 *)
5634 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
5637 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
5638 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
5639 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
5642 * Only SADB_SASTATE_MATURE SAs may be submitted in an
5645 if (sa0->sadb_sa_state != SADB_SASTATE_MATURE) {
5646 ipseclog((LOG_DEBUG, "%s: invalid state.\n", __func__));
5647 #ifdef PFKEY_STRICT_CHECKS
5648 return key_senderror(so, m, EINVAL);
5651 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
5652 (struct sockaddr *)(dst0 + 1));
5654 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
5655 return key_senderror(so, m, error);
5657 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
5658 spi = sa0->sadb_sa_spi;
5660 * For TCP-MD5 SAs we don't use SPI. Check the uniqueness using
5662 * XXXAE: IPComp seems also doesn't use SPI.
5664 if (proto == IPPROTO_TCP) {
5665 sav = key_getsav_tcpmd5(&saidx, &spi);
5666 if (sav == NULL && spi == 0) {
5667 /* Failed to allocate SPI */
5668 ipseclog((LOG_DEBUG, "%s: SA already exists.\n",
5670 return key_senderror(so, m, EEXIST);
5672 /* XXX: SPI that we report back can have another value */
5674 /* We can create new SA only if SPI is different. */
5675 sav = key_getsavbyspi(spi);
5679 ipseclog((LOG_DEBUG, "%s: SA already exists.\n", __func__));
5680 return key_senderror(so, m, EEXIST);
5683 sav = key_newsav(mhp, &saidx, spi, &error);
5685 return key_senderror(so, m, error);
5687 printf("%s: return SA(%p)\n", __func__, sav));
5688 KEYDBG(KEY_DATA, kdebug_secasv(sav));
5690 * If SADB_ADD was in response to SADB_ACQUIRE, we need to schedule
5694 key_acqdone(&saidx, sav->seq);
5698 * Don't call key_freesav() on error here, as we would like to
5699 * keep the SA in the database.
5703 /* set msg buf from mhp */
5704 n = key_getmsgbuf_x1(m, mhp);
5706 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5707 return key_senderror(so, m, ENOBUFS);
5711 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
5717 * IKEd may request the use ESP in UDP encapsulation when it detects the
5718 * presence of NAT. It uses NAT-T extension headers for such SAs to specify
5719 * parameters needed for encapsulation and decapsulation. These PF_KEY
5720 * extension headers are not standardized, so this comment addresses our
5722 * SADB_X_EXT_NAT_T_TYPE specifies type of encapsulation, we support only
5723 * UDP_ENCAP_ESPINUDP as described in RFC3948.
5724 * SADB_X_EXT_NAT_T_SPORT/DPORT specifies source and destination ports for
5725 * UDP header. We use these ports in UDP encapsulation procedure, also we
5726 * can check them in UDP decapsulation procedure.
5727 * SADB_X_EXT_NAT_T_OA[IR] specifies original address of initiator or
5728 * responder. These addresses can be used for transport mode to adjust
5729 * checksum after decapsulation and decryption. Since original IP addresses
5730 * used by peer usually different (we detected presence of NAT), TCP/UDP
5731 * pseudo header checksum and IP header checksum was calculated using original
5732 * addresses. After decapsulation and decryption we need to adjust checksum
5733 * to have correct datagram.
5735 * We expect presence of NAT-T extension headers only in SADB_ADD and
5736 * SADB_UPDATE messages. We report NAT-T extension headers in replies
5737 * to SADB_ADD, SADB_UPDATE, SADB_GET, and SADB_DUMP messages.
5740 key_setnatt(struct secasvar *sav, const struct sadb_msghdr *mhp)
5742 struct sadb_x_nat_t_port *port;
5743 struct sadb_x_nat_t_type *type;
5744 struct sadb_address *oai, *oar;
5745 struct sockaddr *sa;
5749 IPSEC_ASSERT(sav->natt == NULL, ("natt is already initialized"));
5751 * Ignore NAT-T headers if sproto isn't ESP.
5753 if (sav->sah->saidx.proto != IPPROTO_ESP)
5756 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_TYPE) &&
5757 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_SPORT) &&
5758 !SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5759 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_TYPE) ||
5760 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_SPORT) ||
5761 SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_DPORT)) {
5762 ipseclog((LOG_DEBUG,
5763 "%s: invalid message: wrong header size.\n",
5770 type = (struct sadb_x_nat_t_type *)mhp->ext[SADB_X_EXT_NAT_T_TYPE];
5771 if (type->sadb_x_nat_t_type_type != UDP_ENCAP_ESPINUDP) {
5772 ipseclog((LOG_DEBUG, "%s: unsupported NAT-T type %u.\n",
5773 __func__, type->sadb_x_nat_t_type_type));
5777 * Allocate storage for NAT-T config.
5778 * On error it will be released by key_cleansav().
5780 sav->natt = malloc(sizeof(struct secnatt), M_IPSEC_MISC,
5782 if (sav->natt == NULL) {
5783 PFKEYSTAT_INC(in_nomem);
5784 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5787 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_SPORT];
5788 if (port->sadb_x_nat_t_port_port == 0) {
5789 ipseclog((LOG_DEBUG, "%s: invalid NAT-T sport specified.\n",
5793 sav->natt->sport = port->sadb_x_nat_t_port_port;
5794 port = (struct sadb_x_nat_t_port *)mhp->ext[SADB_X_EXT_NAT_T_DPORT];
5795 if (port->sadb_x_nat_t_port_port == 0) {
5796 ipseclog((LOG_DEBUG, "%s: invalid NAT-T dport specified.\n",
5800 sav->natt->dport = port->sadb_x_nat_t_port_port;
5803 * SADB_X_EXT_NAT_T_OAI and SADB_X_EXT_NAT_T_OAR are optional
5804 * and needed only for transport mode IPsec.
5805 * Usually NAT translates only one address, but it is possible,
5806 * that both addresses could be translated.
5807 * NOTE: Value of SADB_X_EXT_NAT_T_OAI is equal to SADB_X_EXT_NAT_T_OA.
5809 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAI)) {
5810 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAI)) {
5811 ipseclog((LOG_DEBUG,
5812 "%s: invalid message: wrong header size.\n",
5816 oai = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAI];
5819 if (!SADB_CHECKHDR(mhp, SADB_X_EXT_NAT_T_OAR)) {
5820 if (SADB_CHECKLEN(mhp, SADB_X_EXT_NAT_T_OAR)) {
5821 ipseclog((LOG_DEBUG,
5822 "%s: invalid message: wrong header size.\n",
5826 oar = (struct sadb_address *)mhp->ext[SADB_X_EXT_NAT_T_OAR];
5830 /* Initialize addresses only for transport mode */
5831 if (sav->sah->saidx.mode != IPSEC_MODE_TUNNEL) {
5834 /* Currently we support only AF_INET */
5835 sa = (struct sockaddr *)(oai + 1);
5836 if (sa->sa_family != AF_INET ||
5837 sa->sa_len != sizeof(struct sockaddr_in)) {
5838 ipseclog((LOG_DEBUG,
5839 "%s: wrong NAT-OAi header.\n",
5843 /* Ignore address if it the same */
5844 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5845 sav->sah->saidx.src.sin.sin_addr.s_addr) {
5846 bcopy(sa, &sav->natt->oai.sa, sa->sa_len);
5847 sav->natt->flags |= IPSEC_NATT_F_OAI;
5848 /* Calculate checksum delta */
5849 addr = sav->sah->saidx.src.sin.sin_addr.s_addr;
5850 cksum = in_addword(cksum, ~addr >> 16);
5851 cksum = in_addword(cksum, ~addr & 0xffff);
5852 addr = sav->natt->oai.sin.sin_addr.s_addr;
5853 cksum = in_addword(cksum, addr >> 16);
5854 cksum = in_addword(cksum, addr & 0xffff);
5858 /* Currently we support only AF_INET */
5859 sa = (struct sockaddr *)(oar + 1);
5860 if (sa->sa_family != AF_INET ||
5861 sa->sa_len != sizeof(struct sockaddr_in)) {
5862 ipseclog((LOG_DEBUG,
5863 "%s: wrong NAT-OAr header.\n",
5867 /* Ignore address if it the same */
5868 if (((struct sockaddr_in *)sa)->sin_addr.s_addr !=
5869 sav->sah->saidx.dst.sin.sin_addr.s_addr) {
5870 bcopy(sa, &sav->natt->oar.sa, sa->sa_len);
5871 sav->natt->flags |= IPSEC_NATT_F_OAR;
5872 /* Calculate checksum delta */
5873 addr = sav->sah->saidx.dst.sin.sin_addr.s_addr;
5874 cksum = in_addword(cksum, ~addr >> 16);
5875 cksum = in_addword(cksum, ~addr & 0xffff);
5876 addr = sav->natt->oar.sin.sin_addr.s_addr;
5877 cksum = in_addword(cksum, addr >> 16);
5878 cksum = in_addword(cksum, addr & 0xffff);
5881 sav->natt->cksum = cksum;
5887 key_setident(struct secashead *sah, const struct sadb_msghdr *mhp)
5889 const struct sadb_ident *idsrc, *iddst;
5891 IPSEC_ASSERT(sah != NULL, ("null secashead"));
5892 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5893 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5895 /* don't make buffer if not there */
5896 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) &&
5897 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5903 if (SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_SRC) ||
5904 SADB_CHECKHDR(mhp, SADB_EXT_IDENTITY_DST)) {
5905 ipseclog((LOG_DEBUG, "%s: invalid identity.\n", __func__));
5909 idsrc = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_SRC];
5910 iddst = (const struct sadb_ident *)mhp->ext[SADB_EXT_IDENTITY_DST];
5912 /* validity check */
5913 if (idsrc->sadb_ident_type != iddst->sadb_ident_type) {
5914 ipseclog((LOG_DEBUG, "%s: ident type mismatch.\n", __func__));
5918 switch (idsrc->sadb_ident_type) {
5919 case SADB_IDENTTYPE_PREFIX:
5920 case SADB_IDENTTYPE_FQDN:
5921 case SADB_IDENTTYPE_USERFQDN:
5923 /* XXX do nothing */
5929 /* make structure */
5930 sah->idents = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5931 if (sah->idents == NULL) {
5932 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5935 sah->identd = malloc(sizeof(struct secident), M_IPSEC_MISC, M_NOWAIT);
5936 if (sah->identd == NULL) {
5937 free(sah->idents, M_IPSEC_MISC);
5939 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
5942 sah->idents->type = idsrc->sadb_ident_type;
5943 sah->idents->id = idsrc->sadb_ident_id;
5945 sah->identd->type = iddst->sadb_ident_type;
5946 sah->identd->id = iddst->sadb_ident_id;
5952 * m will not be freed on return.
5953 * it is caller's responsibility to free the result.
5955 * Called from SADB_ADD and SADB_UPDATE. Reply will contain headers
5956 * from the request in defined order.
5958 static struct mbuf *
5959 key_getmsgbuf_x1(struct mbuf *m, const struct sadb_msghdr *mhp)
5963 IPSEC_ASSERT(m != NULL, ("null mbuf"));
5964 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
5965 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
5967 /* create new sadb_msg to reply. */
5968 n = key_gather_mbuf(m, mhp, 1, 16, SADB_EXT_RESERVED,
5969 SADB_EXT_SA, SADB_X_EXT_SA2,
5970 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
5971 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
5972 SADB_EXT_IDENTITY_SRC, SADB_EXT_IDENTITY_DST,
5973 SADB_X_EXT_NAT_T_TYPE, SADB_X_EXT_NAT_T_SPORT,
5974 SADB_X_EXT_NAT_T_DPORT, SADB_X_EXT_NAT_T_OAI,
5975 SADB_X_EXT_NAT_T_OAR, SADB_X_EXT_NEW_ADDRESS_SRC,
5976 SADB_X_EXT_NEW_ADDRESS_DST);
5980 if (n->m_len < sizeof(struct sadb_msg)) {
5981 n = m_pullup(n, sizeof(struct sadb_msg));
5985 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
5986 mtod(n, struct sadb_msg *)->sadb_msg_len =
5987 PFKEY_UNIT64(n->m_pkthdr.len);
5993 * SADB_DELETE processing
5995 * <base, SA(*), address(SD)>
5996 * from the ikmpd, and set SADB_SASTATE_DEAD,
5998 * <base, SA(*), address(SD)>
6001 * m will always be freed.
6004 key_delete(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6006 struct secasindex saidx;
6007 struct sadb_address *src0, *dst0;
6008 struct secasvar *sav;
6009 struct sadb_sa *sa0;
6012 IPSEC_ASSERT(so != NULL, ("null socket"));
6013 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6014 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6015 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6017 /* map satype to proto */
6018 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6019 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6021 return key_senderror(so, m, EINVAL);
6024 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6025 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
6026 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6027 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6028 ipseclog((LOG_DEBUG, "%s: invalid message is passed.\n",
6030 return key_senderror(so, m, EINVAL);
6033 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
6034 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
6036 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6037 (struct sockaddr *)(dst0 + 1)) != 0) {
6038 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6039 return (key_senderror(so, m, EINVAL));
6041 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6042 if (SADB_CHECKHDR(mhp, SADB_EXT_SA)) {
6044 * Caller wants us to delete all non-LARVAL SAs
6045 * that match the src/dst. This is used during
6046 * IKE INITIAL-CONTACT.
6047 * XXXAE: this looks like some extension to RFC2367.
6049 ipseclog((LOG_DEBUG, "%s: doing delete all.\n", __func__));
6050 return (key_delete_all(so, m, mhp, &saidx));
6052 if (SADB_CHECKLEN(mhp, SADB_EXT_SA)) {
6053 ipseclog((LOG_DEBUG,
6054 "%s: invalid message: wrong header size.\n", __func__));
6055 return (key_senderror(so, m, EINVAL));
6057 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6058 if (proto == IPPROTO_TCP)
6059 sav = key_getsav_tcpmd5(&saidx, NULL);
6061 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6063 ipseclog((LOG_DEBUG, "%s: no SA found for SPI %u.\n",
6064 __func__, ntohl(sa0->sadb_sa_spi)));
6065 return (key_senderror(so, m, ESRCH));
6067 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6068 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6069 __func__, ntohl(sav->spi)));
6071 return (key_senderror(so, m, ESRCH));
6074 printf("%s: SA(%p)\n", __func__, sav));
6075 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6081 struct sadb_msg *newmsg;
6083 /* create new sadb_msg to reply. */
6084 n = key_gather_mbuf(m, mhp, 1, 4, SADB_EXT_RESERVED,
6085 SADB_EXT_SA, SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6087 return key_senderror(so, m, ENOBUFS);
6089 if (n->m_len < sizeof(struct sadb_msg)) {
6090 n = m_pullup(n, sizeof(struct sadb_msg));
6092 return key_senderror(so, m, ENOBUFS);
6094 newmsg = mtod(n, struct sadb_msg *);
6095 newmsg->sadb_msg_errno = 0;
6096 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6099 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6104 * delete all SAs for src/dst. Called from key_delete().
6107 key_delete_all(struct socket *so, struct mbuf *m,
6108 const struct sadb_msghdr *mhp, struct secasindex *saidx)
6110 struct secasvar_queue drainq;
6111 struct secashead *sah;
6112 struct secasvar *sav, *nextsav;
6114 TAILQ_INIT(&drainq);
6116 LIST_FOREACH(sah, SAHADDRHASH_HASH(saidx), addrhash) {
6117 if (key_cmpsaidx(&sah->saidx, saidx, CMP_HEAD) == 0)
6119 /* Move all ALIVE SAs into drainq */
6120 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6122 /* Unlink all queued SAs from SPI hash */
6123 TAILQ_FOREACH(sav, &drainq, chain) {
6124 sav->state = SADB_SASTATE_DEAD;
6125 LIST_REMOVE(sav, spihash);
6128 /* Now we can release reference for all SAs in drainq */
6129 sav = TAILQ_FIRST(&drainq);
6130 while (sav != NULL) {
6132 printf("%s: SA(%p)\n", __func__, sav));
6133 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6134 nextsav = TAILQ_NEXT(sav, chain);
6135 key_freesah(&sav->sah); /* release reference from SAV */
6136 key_freesav(&sav); /* release last reference */
6142 struct sadb_msg *newmsg;
6144 /* create new sadb_msg to reply. */
6145 n = key_gather_mbuf(m, mhp, 1, 3, SADB_EXT_RESERVED,
6146 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST);
6148 return key_senderror(so, m, ENOBUFS);
6150 if (n->m_len < sizeof(struct sadb_msg)) {
6151 n = m_pullup(n, sizeof(struct sadb_msg));
6153 return key_senderror(so, m, ENOBUFS);
6155 newmsg = mtod(n, struct sadb_msg *);
6156 newmsg->sadb_msg_errno = 0;
6157 newmsg->sadb_msg_len = PFKEY_UNIT64(n->m_pkthdr.len);
6160 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6165 * Delete all alive SAs for corresponding xform.
6166 * Larval SAs have not initialized tdb_xform, so it is safe to leave them
6167 * here when xform disappears.
6170 key_delete_xform(const struct xformsw *xsp)
6172 struct secasvar_queue drainq;
6173 struct secashead *sah;
6174 struct secasvar *sav, *nextsav;
6176 TAILQ_INIT(&drainq);
6178 TAILQ_FOREACH(sah, &V_sahtree, chain) {
6179 sav = TAILQ_FIRST(&sah->savtree_alive);
6182 if (sav->tdb_xform != xsp)
6185 * It is supposed that all SAs in the chain are related to
6188 TAILQ_CONCAT(&drainq, &sah->savtree_alive, chain);
6190 /* Unlink all queued SAs from SPI hash */
6191 TAILQ_FOREACH(sav, &drainq, chain) {
6192 sav->state = SADB_SASTATE_DEAD;
6193 LIST_REMOVE(sav, spihash);
6197 /* Now we can release reference for all SAs in drainq */
6198 sav = TAILQ_FIRST(&drainq);
6199 while (sav != NULL) {
6201 printf("%s: SA(%p)\n", __func__, sav));
6202 KEYDBG(KEY_DATA, kdebug_secasv(sav));
6203 nextsav = TAILQ_NEXT(sav, chain);
6204 key_freesah(&sav->sah); /* release reference from SAV */
6205 key_freesav(&sav); /* release last reference */
6211 * SADB_GET processing
6213 * <base, SA(*), address(SD)>
6214 * from the ikmpd, and get a SP and a SA to respond,
6216 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
6217 * (identity(SD),) (sensitivity)>
6220 * m will always be freed.
6223 key_get(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6225 struct secasindex saidx;
6226 struct sadb_address *src0, *dst0;
6227 struct sadb_sa *sa0;
6228 struct secasvar *sav;
6231 IPSEC_ASSERT(so != NULL, ("null socket"));
6232 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6233 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6234 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6236 /* map satype to proto */
6237 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6238 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
6240 return key_senderror(so, m, EINVAL);
6243 if (SADB_CHECKHDR(mhp, SADB_EXT_SA) ||
6244 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
6245 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST)) {
6246 ipseclog((LOG_DEBUG,
6247 "%s: invalid message: missing required header.\n",
6249 return key_senderror(so, m, EINVAL);
6251 if (SADB_CHECKLEN(mhp, SADB_EXT_SA) ||
6252 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
6253 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST)) {
6254 ipseclog((LOG_DEBUG,
6255 "%s: invalid message: wrong header size.\n", __func__));
6256 return key_senderror(so, m, EINVAL);
6259 sa0 = (struct sadb_sa *)mhp->ext[SADB_EXT_SA];
6260 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
6261 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
6263 if (key_checksockaddrs((struct sockaddr *)(src0 + 1),
6264 (struct sockaddr *)(dst0 + 1)) != 0) {
6265 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
6266 return key_senderror(so, m, EINVAL);
6268 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, &saidx);
6270 if (proto == IPPROTO_TCP)
6271 sav = key_getsav_tcpmd5(&saidx, NULL);
6273 sav = key_getsavbyspi(sa0->sadb_sa_spi);
6275 ipseclog((LOG_DEBUG, "%s: no SA found.\n", __func__));
6276 return key_senderror(so, m, ESRCH);
6278 if (key_cmpsaidx(&sav->sah->saidx, &saidx, CMP_HEAD) == 0) {
6279 ipseclog((LOG_DEBUG, "%s: saidx mismatched for SPI %u.\n",
6280 __func__, ntohl(sa0->sadb_sa_spi)));
6282 return (key_senderror(so, m, ESRCH));
6289 /* map proto to satype */
6290 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
6291 ipseclog((LOG_DEBUG, "%s: there was invalid proto in SAD.\n",
6294 return key_senderror(so, m, EINVAL);
6297 /* create new sadb_msg to reply. */
6298 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
6299 mhp->msg->sadb_msg_pid);
6303 return key_senderror(so, m, ENOBUFS);
6306 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6310 /* XXX make it sysctl-configurable? */
6312 key_getcomb_setlifetime(struct sadb_comb *comb)
6315 comb->sadb_comb_soft_allocations = 1;
6316 comb->sadb_comb_hard_allocations = 1;
6317 comb->sadb_comb_soft_bytes = 0;
6318 comb->sadb_comb_hard_bytes = 0;
6319 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
6320 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
6321 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
6322 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
6326 * XXX reorder combinations by preference
6327 * XXX no idea if the user wants ESP authentication or not
6329 static struct mbuf *
6330 key_getcomb_ealg(void)
6332 struct sadb_comb *comb;
6333 const struct enc_xform *algo;
6334 struct mbuf *result = NULL, *m, *n;
6338 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6341 for (i = 1; i <= SADB_EALG_MAX; i++) {
6342 algo = enc_algorithm_lookup(i);
6346 /* discard algorithms with key size smaller than system min */
6347 if (_BITS(algo->maxkey) < V_ipsec_esp_keymin)
6349 if (_BITS(algo->minkey) < V_ipsec_esp_keymin)
6350 encmin = V_ipsec_esp_keymin;
6352 encmin = _BITS(algo->minkey);
6354 if (V_ipsec_esp_auth)
6355 m = key_getcomb_ah();
6357 IPSEC_ASSERT(l <= MLEN,
6358 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6359 MGET(m, M_NOWAIT, MT_DATA);
6364 bzero(mtod(m, caddr_t), m->m_len);
6371 for (n = m; n; n = n->m_next)
6373 IPSEC_ASSERT((totlen % l) == 0, ("totlen=%u, l=%u", totlen, l));
6375 for (off = 0; off < totlen; off += l) {
6376 n = m_pulldown(m, off, l, &o);
6378 /* m is already freed */
6381 comb = (struct sadb_comb *)(mtod(n, caddr_t) + o);
6382 bzero(comb, sizeof(*comb));
6383 key_getcomb_setlifetime(comb);
6384 comb->sadb_comb_encrypt = i;
6385 comb->sadb_comb_encrypt_minbits = encmin;
6386 comb->sadb_comb_encrypt_maxbits = _BITS(algo->maxkey);
6404 key_getsizes_ah(const struct auth_hash *ah, int alg, u_int16_t* min,
6408 *min = *max = ah->hashsize;
6409 if (ah->keysize == 0) {
6411 * Transform takes arbitrary key size but algorithm
6412 * key size is restricted. Enforce this here.
6415 case SADB_X_AALG_MD5: *min = *max = 16; break;
6416 case SADB_X_AALG_SHA: *min = *max = 20; break;
6417 case SADB_X_AALG_NULL: *min = 1; *max = 256; break;
6418 case SADB_X_AALG_SHA2_256: *min = *max = 32; break;
6419 case SADB_X_AALG_SHA2_384: *min = *max = 48; break;
6420 case SADB_X_AALG_SHA2_512: *min = *max = 64; break;
6422 DPRINTF(("%s: unknown AH algorithm %u\n",
6430 * XXX reorder combinations by preference
6432 static struct mbuf *
6435 const struct auth_hash *algo;
6436 struct sadb_comb *comb;
6438 u_int16_t minkeysize, maxkeysize;
6440 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6443 for (i = 1; i <= SADB_AALG_MAX; i++) {
6445 /* we prefer HMAC algorithms, not old algorithms */
6446 if (i != SADB_AALG_SHA1HMAC &&
6447 i != SADB_AALG_MD5HMAC &&
6448 i != SADB_X_AALG_SHA2_256 &&
6449 i != SADB_X_AALG_SHA2_384 &&
6450 i != SADB_X_AALG_SHA2_512)
6453 algo = auth_algorithm_lookup(i);
6456 key_getsizes_ah(algo, i, &minkeysize, &maxkeysize);
6457 /* discard algorithms with key size smaller than system min */
6458 if (_BITS(minkeysize) < V_ipsec_ah_keymin)
6462 IPSEC_ASSERT(l <= MLEN,
6463 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6464 MGET(m, M_NOWAIT, MT_DATA);
6471 M_PREPEND(m, l, M_NOWAIT);
6475 comb = mtod(m, struct sadb_comb *);
6476 bzero(comb, sizeof(*comb));
6477 key_getcomb_setlifetime(comb);
6478 comb->sadb_comb_auth = i;
6479 comb->sadb_comb_auth_minbits = _BITS(minkeysize);
6480 comb->sadb_comb_auth_maxbits = _BITS(maxkeysize);
6487 * not really an official behavior. discussed in pf_key@inner.net in Sep2000.
6488 * XXX reorder combinations by preference
6490 static struct mbuf *
6491 key_getcomb_ipcomp()
6493 const struct comp_algo *algo;
6494 struct sadb_comb *comb;
6497 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
6500 for (i = 1; i <= SADB_X_CALG_MAX; i++) {
6501 algo = comp_algorithm_lookup(i);
6506 IPSEC_ASSERT(l <= MLEN,
6507 ("l=%u > MLEN=%lu", l, (u_long) MLEN));
6508 MGET(m, M_NOWAIT, MT_DATA);
6515 M_PREPEND(m, l, M_NOWAIT);
6519 comb = mtod(m, struct sadb_comb *);
6520 bzero(comb, sizeof(*comb));
6521 key_getcomb_setlifetime(comb);
6522 comb->sadb_comb_encrypt = i;
6523 /* what should we set into sadb_comb_*_{min,max}bits? */
6530 * XXX no way to pass mode (transport/tunnel) to userland
6531 * XXX replay checking?
6532 * XXX sysctl interface to ipsec_{ah,esp}_keymin
6534 static struct mbuf *
6535 key_getprop(const struct secasindex *saidx)
6537 struct sadb_prop *prop;
6539 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
6542 switch (saidx->proto) {
6544 m = key_getcomb_ealg();
6547 m = key_getcomb_ah();
6549 case IPPROTO_IPCOMP:
6550 m = key_getcomb_ipcomp();
6558 M_PREPEND(m, l, M_NOWAIT);
6563 for (n = m; n; n = n->m_next)
6566 prop = mtod(m, struct sadb_prop *);
6567 bzero(prop, sizeof(*prop));
6568 prop->sadb_prop_len = PFKEY_UNIT64(totlen);
6569 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
6570 prop->sadb_prop_replay = 32; /* XXX */
6576 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
6578 * <base, SA, address(SD), (address(P)), x_policy,
6579 * (identity(SD),) (sensitivity,) proposal>
6580 * to KMD, and expect to receive
6581 * <base> with SADB_ACQUIRE if error occurred,
6583 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
6584 * from KMD by PF_KEY.
6586 * XXX x_policy is outside of RFC2367 (KAME extension).
6587 * XXX sensitivity is not supported.
6588 * XXX for ipcomp, RFC2367 does not define how to fill in proposal.
6589 * see comment for key_getcomb_ipcomp().
6593 * others: error number
6596 key_acquire(const struct secasindex *saidx, struct secpolicy *sp)
6598 union sockaddr_union addr;
6599 struct mbuf *result, *m;
6603 uint8_t mask, satype;
6605 IPSEC_ASSERT(saidx != NULL, ("null saidx"));
6606 satype = key_proto2satype(saidx->proto);
6607 IPSEC_ASSERT(satype != 0, ("null satype, protocol %u", saidx->proto));
6611 ul_proto = IPSEC_ULPROTO_ANY;
6613 /* Get seq number to check whether sending message or not. */
6614 seq = key_getacq(saidx, &error);
6618 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
6626 * set sadb_address for saidx's.
6628 * Note that if sp is supplied, then we're being called from
6629 * key_allocsa_policy() and should supply port and protocol
6631 * XXXAE: why only TCP and UDP? ICMP and SCTP looks applicable too.
6632 * XXXAE: probably we can handle this in the ipsec[46]_allocsa().
6633 * XXXAE: it looks like we should save this info in the ACQ entry.
6635 if (sp != NULL && (sp->spidx.ul_proto == IPPROTO_TCP ||
6636 sp->spidx.ul_proto == IPPROTO_UDP))
6637 ul_proto = sp->spidx.ul_proto;
6641 if (ul_proto != IPSEC_ULPROTO_ANY) {
6642 switch (sp->spidx.src.sa.sa_family) {
6644 if (sp->spidx.src.sin.sin_port != IPSEC_PORT_ANY) {
6645 addr.sin.sin_port = sp->spidx.src.sin.sin_port;
6646 mask = sp->spidx.prefs;
6650 if (sp->spidx.src.sin6.sin6_port != IPSEC_PORT_ANY) {
6651 addr.sin6.sin6_port =
6652 sp->spidx.src.sin6.sin6_port;
6653 mask = sp->spidx.prefs;
6660 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC, &addr.sa, mask, ul_proto);
6669 if (ul_proto != IPSEC_ULPROTO_ANY) {
6670 switch (sp->spidx.dst.sa.sa_family) {
6672 if (sp->spidx.dst.sin.sin_port != IPSEC_PORT_ANY) {
6673 addr.sin.sin_port = sp->spidx.dst.sin.sin_port;
6674 mask = sp->spidx.prefd;
6678 if (sp->spidx.dst.sin6.sin6_port != IPSEC_PORT_ANY) {
6679 addr.sin6.sin6_port =
6680 sp->spidx.dst.sin6.sin6_port;
6681 mask = sp->spidx.prefd;
6688 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST, &addr.sa, mask, ul_proto);
6695 /* XXX proxy address (optional) */
6697 /* set sadb_x_policy */
6699 m = key_setsadbxpolicy(sp->policy, sp->spidx.dir, sp->id,
6708 /* XXX identity (optional) */
6710 if (idexttype && fqdn) {
6711 /* create identity extension (FQDN) */
6712 struct sadb_ident *id;
6715 fqdnlen = strlen(fqdn) + 1; /* +1 for terminating-NUL */
6716 id = (struct sadb_ident *)p;
6717 bzero(id, sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6718 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(fqdnlen));
6719 id->sadb_ident_exttype = idexttype;
6720 id->sadb_ident_type = SADB_IDENTTYPE_FQDN;
6721 bcopy(fqdn, id + 1, fqdnlen);
6722 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(fqdnlen);
6726 /* create identity extension (USERFQDN) */
6727 struct sadb_ident *id;
6731 /* +1 for terminating-NUL */
6732 userfqdnlen = strlen(userfqdn) + 1;
6735 id = (struct sadb_ident *)p;
6736 bzero(id, sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6737 id->sadb_ident_len = PFKEY_UNIT64(sizeof(*id) + PFKEY_ALIGN8(userfqdnlen));
6738 id->sadb_ident_exttype = idexttype;
6739 id->sadb_ident_type = SADB_IDENTTYPE_USERFQDN;
6740 /* XXX is it correct? */
6741 if (curproc && curproc->p_cred)
6742 id->sadb_ident_id = curproc->p_cred->p_ruid;
6743 if (userfqdn && userfqdnlen)
6744 bcopy(userfqdn, id + 1, userfqdnlen);
6745 p += sizeof(struct sadb_ident) + PFKEY_ALIGN8(userfqdnlen);
6749 /* XXX sensitivity (optional) */
6751 /* create proposal/combination extension */
6752 m = key_getprop(saidx);
6755 * spec conformant: always attach proposal/combination extension,
6756 * the problem is that we have no way to attach it for ipcomp,
6757 * due to the way sadb_comb is declared in RFC2367.
6766 * outside of spec; make proposal/combination extension optional.
6772 if ((result->m_flags & M_PKTHDR) == 0) {
6777 if (result->m_len < sizeof(struct sadb_msg)) {
6778 result = m_pullup(result, sizeof(struct sadb_msg));
6779 if (result == NULL) {
6785 result->m_pkthdr.len = 0;
6786 for (m = result; m; m = m->m_next)
6787 result->m_pkthdr.len += m->m_len;
6789 mtod(result, struct sadb_msg *)->sadb_msg_len =
6790 PFKEY_UNIT64(result->m_pkthdr.len);
6793 printf("%s: SP(%p)\n", __func__, sp));
6794 KEYDBG(KEY_DATA, kdebug_secasindex(saidx, NULL));
6796 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
6805 key_newacq(const struct secasindex *saidx, int *perror)
6810 acq = malloc(sizeof(*acq), M_IPSEC_SAQ, M_NOWAIT | M_ZERO);
6812 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6818 bcopy(saidx, &acq->saidx, sizeof(acq->saidx));
6819 acq->created = time_second;
6822 /* add to acqtree */
6824 seq = acq->seq = (V_acq_seq == ~0 ? 1 : ++V_acq_seq);
6825 LIST_INSERT_HEAD(&V_acqtree, acq, chain);
6826 LIST_INSERT_HEAD(ACQADDRHASH_HASH(saidx), acq, addrhash);
6827 LIST_INSERT_HEAD(ACQSEQHASH_HASH(seq), acq, seqhash);
6834 key_getacq(const struct secasindex *saidx, int *perror)
6840 LIST_FOREACH(acq, ACQADDRHASH_HASH(saidx), addrhash) {
6841 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY)) {
6842 if (acq->count > V_key_blockacq_count) {
6844 * Reset counter and send message.
6845 * Also reset created time to keep ACQ for
6848 acq->created = time_second;
6853 * Increment counter and do nothing.
6854 * We send SADB_ACQUIRE message only
6855 * for each V_key_blockacq_count packet.
6868 /* allocate new entry */
6869 return (key_newacq(saidx, perror));
6873 key_acqreset(uint32_t seq)
6878 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6879 if (acq->seq == seq) {
6881 acq->created = time_second;
6891 * Mark ACQ entry as stale to remove it in key_flush_acq().
6892 * Called after successful SADB_GETSPI message.
6895 key_acqdone(const struct secasindex *saidx, uint32_t seq)
6900 LIST_FOREACH(acq, ACQSEQHASH_HASH(seq), seqhash) {
6901 if (acq->seq == seq)
6905 if (key_cmpsaidx(&acq->saidx, saidx, CMP_EXACTLY) == 0) {
6906 ipseclog((LOG_DEBUG,
6907 "%s: Mismatched saidx for ACQ %u", __func__, seq));
6913 ipseclog((LOG_DEBUG,
6914 "%s: ACQ %u is not found.", __func__, seq));
6922 static struct secspacq *
6923 key_newspacq(struct secpolicyindex *spidx)
6925 struct secspacq *acq;
6928 acq = malloc(sizeof(struct secspacq), M_IPSEC_SAQ, M_NOWAIT|M_ZERO);
6930 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
6935 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
6936 acq->created = time_second;
6939 /* add to spacqtree */
6941 LIST_INSERT_HEAD(&V_spacqtree, acq, chain);
6947 static struct secspacq *
6948 key_getspacq(struct secpolicyindex *spidx)
6950 struct secspacq *acq;
6953 LIST_FOREACH(acq, &V_spacqtree, chain) {
6954 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
6955 /* NB: return holding spacq_lock */
6965 * SADB_ACQUIRE processing,
6966 * in first situation, is receiving
6968 * from the ikmpd, and clear sequence of its secasvar entry.
6970 * In second situation, is receiving
6971 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6972 * from a user land process, and return
6973 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
6976 * m will always be freed.
6979 key_acquire2(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
6981 SAHTREE_RLOCK_TRACKER;
6982 struct sadb_address *src0, *dst0;
6983 struct secasindex saidx;
6984 struct secashead *sah;
6987 uint8_t mode, proto;
6989 IPSEC_ASSERT(so != NULL, ("null socket"));
6990 IPSEC_ASSERT(m != NULL, ("null mbuf"));
6991 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
6992 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
6995 * Error message from KMd.
6996 * We assume that if error was occurred in IKEd, the length of PFKEY
6997 * message is equal to the size of sadb_msg structure.
6998 * We do not raise error even if error occurred in this function.
7000 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
7001 /* check sequence number */
7002 if (mhp->msg->sadb_msg_seq == 0 ||
7003 mhp->msg->sadb_msg_errno == 0) {
7004 ipseclog((LOG_DEBUG, "%s: must specify sequence "
7005 "number and errno.\n", __func__));
7008 * IKEd reported that error occurred.
7009 * XXXAE: what it expects from the kernel?
7010 * Probably we should send SADB_ACQUIRE again?
7011 * If so, reset ACQ's state.
7012 * XXXAE: it looks useless.
7014 key_acqreset(mhp->msg->sadb_msg_seq);
7021 * This message is from user land.
7024 /* map satype to proto */
7025 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7026 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7028 return key_senderror(so, m, EINVAL);
7031 if (SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_SRC) ||
7032 SADB_CHECKHDR(mhp, SADB_EXT_ADDRESS_DST) ||
7033 SADB_CHECKHDR(mhp, SADB_EXT_PROPOSAL)) {
7034 ipseclog((LOG_DEBUG,
7035 "%s: invalid message: missing required header.\n",
7037 return key_senderror(so, m, EINVAL);
7039 if (SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_SRC) ||
7040 SADB_CHECKLEN(mhp, SADB_EXT_ADDRESS_DST) ||
7041 SADB_CHECKLEN(mhp, SADB_EXT_PROPOSAL)) {
7042 ipseclog((LOG_DEBUG,
7043 "%s: invalid message: wrong header size.\n", __func__));
7044 return key_senderror(so, m, EINVAL);
7047 if (SADB_CHECKHDR(mhp, SADB_X_EXT_SA2)) {
7048 mode = IPSEC_MODE_ANY;
7051 if (SADB_CHECKLEN(mhp, SADB_X_EXT_SA2)) {
7052 ipseclog((LOG_DEBUG,
7053 "%s: invalid message: wrong header size.\n",
7055 return key_senderror(so, m, EINVAL);
7057 mode = ((struct sadb_x_sa2 *)
7058 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7059 reqid = ((struct sadb_x_sa2 *)
7060 mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7063 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7064 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7066 error = key_checksockaddrs((struct sockaddr *)(src0 + 1),
7067 (struct sockaddr *)(dst0 + 1));
7069 ipseclog((LOG_DEBUG, "%s: invalid sockaddr.\n", __func__));
7070 return key_senderror(so, m, EINVAL);
7072 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, &saidx);
7074 /* get a SA index */
7076 LIST_FOREACH(sah, SAHADDRHASH_HASH(&saidx), addrhash) {
7077 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE_REQID))
7082 ipseclog((LOG_DEBUG, "%s: a SA exists already.\n", __func__));
7083 return key_senderror(so, m, EEXIST);
7086 error = key_acquire(&saidx, NULL);
7088 ipseclog((LOG_DEBUG,
7089 "%s: error %d returned from key_acquire()\n",
7091 return key_senderror(so, m, error);
7098 * SADB_REGISTER processing.
7099 * If SATYPE_UNSPEC has been passed as satype, only return sabd_supported.
7102 * from the ikmpd, and register a socket to send PF_KEY messages,
7106 * If socket is detached, must free from regnode.
7108 * m will always be freed.
7111 key_register(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7113 struct secreg *reg, *newreg = NULL;
7115 IPSEC_ASSERT(so != NULL, ("null socket"));
7116 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7117 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7118 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7120 /* check for invalid register message */
7121 if (mhp->msg->sadb_msg_satype >= sizeof(V_regtree)/sizeof(V_regtree[0]))
7122 return key_senderror(so, m, EINVAL);
7124 /* When SATYPE_UNSPEC is specified, only return sabd_supported. */
7125 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC)
7128 /* check whether existing or not */
7130 LIST_FOREACH(reg, &V_regtree[mhp->msg->sadb_msg_satype], chain) {
7131 if (reg->so == so) {
7133 ipseclog((LOG_DEBUG, "%s: socket exists already.\n",
7135 return key_senderror(so, m, EEXIST);
7139 /* create regnode */
7140 newreg = malloc(sizeof(struct secreg), M_IPSEC_SAR, M_NOWAIT|M_ZERO);
7141 if (newreg == NULL) {
7143 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7144 return key_senderror(so, m, ENOBUFS);
7148 ((struct keycb *)sotorawcb(so))->kp_registered++;
7150 /* add regnode to regtree. */
7151 LIST_INSERT_HEAD(&V_regtree[mhp->msg->sadb_msg_satype], newreg, chain);
7157 struct sadb_msg *newmsg;
7158 struct sadb_supported *sup;
7159 u_int len, alen, elen;
7162 struct sadb_alg *alg;
7164 /* create new sadb_msg to reply. */
7166 for (i = 1; i <= SADB_AALG_MAX; i++) {
7167 if (auth_algorithm_lookup(i))
7168 alen += sizeof(struct sadb_alg);
7171 alen += sizeof(struct sadb_supported);
7173 for (i = 1; i <= SADB_EALG_MAX; i++) {
7174 if (enc_algorithm_lookup(i))
7175 elen += sizeof(struct sadb_alg);
7178 elen += sizeof(struct sadb_supported);
7180 len = sizeof(struct sadb_msg) + alen + elen;
7183 return key_senderror(so, m, ENOBUFS);
7185 MGETHDR(n, M_NOWAIT, MT_DATA);
7187 if (!(MCLGET(n, M_NOWAIT))) {
7193 return key_senderror(so, m, ENOBUFS);
7195 n->m_pkthdr.len = n->m_len = len;
7199 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
7200 newmsg = mtod(n, struct sadb_msg *);
7201 newmsg->sadb_msg_errno = 0;
7202 newmsg->sadb_msg_len = PFKEY_UNIT64(len);
7203 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
7205 /* for authentication algorithm */
7207 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7208 sup->sadb_supported_len = PFKEY_UNIT64(alen);
7209 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
7210 off += PFKEY_ALIGN8(sizeof(*sup));
7212 for (i = 1; i <= SADB_AALG_MAX; i++) {
7213 const struct auth_hash *aalgo;
7214 u_int16_t minkeysize, maxkeysize;
7216 aalgo = auth_algorithm_lookup(i);
7219 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7220 alg->sadb_alg_id = i;
7221 alg->sadb_alg_ivlen = 0;
7222 key_getsizes_ah(aalgo, i, &minkeysize, &maxkeysize);
7223 alg->sadb_alg_minbits = _BITS(minkeysize);
7224 alg->sadb_alg_maxbits = _BITS(maxkeysize);
7225 off += PFKEY_ALIGN8(sizeof(*alg));
7229 /* for encryption algorithm */
7231 sup = (struct sadb_supported *)(mtod(n, caddr_t) + off);
7232 sup->sadb_supported_len = PFKEY_UNIT64(elen);
7233 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
7234 off += PFKEY_ALIGN8(sizeof(*sup));
7236 for (i = 1; i <= SADB_EALG_MAX; i++) {
7237 const struct enc_xform *ealgo;
7239 ealgo = enc_algorithm_lookup(i);
7242 alg = (struct sadb_alg *)(mtod(n, caddr_t) + off);
7243 alg->sadb_alg_id = i;
7244 alg->sadb_alg_ivlen = ealgo->ivsize;
7245 alg->sadb_alg_minbits = _BITS(ealgo->minkey);
7246 alg->sadb_alg_maxbits = _BITS(ealgo->maxkey);
7247 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
7251 IPSEC_ASSERT(off == len,
7252 ("length assumption failed (off %u len %u)", off, len));
7255 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
7260 * free secreg entry registered.
7261 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
7264 key_freereg(struct socket *so)
7269 IPSEC_ASSERT(so != NULL, ("NULL so"));
7272 * check whether existing or not.
7273 * check all type of SA, because there is a potential that
7274 * one socket is registered to multiple type of SA.
7277 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
7278 LIST_FOREACH(reg, &V_regtree[i], chain) {
7279 if (reg->so == so && __LIST_CHAINED(reg)) {
7280 LIST_REMOVE(reg, chain);
7281 free(reg, M_IPSEC_SAR);
7290 * SADB_EXPIRE processing
7292 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
7294 * NOTE: We send only soft lifetime extension.
7297 * others : error number
7300 key_expire(struct secasvar *sav, int hard)
7302 struct mbuf *result = NULL, *m;
7303 struct sadb_lifetime *lt;
7304 uint32_t replay_count;
7308 IPSEC_ASSERT (sav != NULL, ("null sav"));
7309 IPSEC_ASSERT (sav->sah != NULL, ("null sa header"));
7312 printf("%s: SA(%p) expired %s lifetime\n", __func__,
7313 sav, hard ? "hard": "soft"));
7314 KEYDBG(KEY_DATA, kdebug_secasv(sav));
7315 /* set msg header */
7316 satype = key_proto2satype(sav->sah->saidx.proto);
7317 IPSEC_ASSERT(satype != 0, ("invalid proto, satype %u", satype));
7318 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, sav->refcnt);
7325 /* create SA extension */
7326 m = key_setsadbsa(sav);
7333 /* create SA extension */
7335 replay_count = sav->replay ? sav->replay->count : 0;
7336 SECASVAR_UNLOCK(sav);
7338 m = key_setsadbxsa2(sav->sah->saidx.mode, replay_count,
7339 sav->sah->saidx.reqid);
7346 if (sav->replay && sav->replay->wsize > UINT8_MAX) {
7347 m = key_setsadbxsareplay(sav->replay->wsize);
7355 /* create lifetime extension (current and soft) */
7356 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
7357 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
7364 bzero(mtod(m, caddr_t), len);
7365 lt = mtod(m, struct sadb_lifetime *);
7366 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7367 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
7368 lt->sadb_lifetime_allocations =
7369 (uint32_t)counter_u64_fetch(sav->lft_c_allocations);
7370 lt->sadb_lifetime_bytes =
7371 counter_u64_fetch(sav->lft_c_bytes);
7372 lt->sadb_lifetime_addtime = sav->created;
7373 lt->sadb_lifetime_usetime = sav->firstused;
7374 lt = (struct sadb_lifetime *)(mtod(m, caddr_t) + len / 2);
7375 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
7377 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
7378 lt->sadb_lifetime_allocations = sav->lft_h->allocations;
7379 lt->sadb_lifetime_bytes = sav->lft_h->bytes;
7380 lt->sadb_lifetime_addtime = sav->lft_h->addtime;
7381 lt->sadb_lifetime_usetime = sav->lft_h->usetime;
7383 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_SOFT;
7384 lt->sadb_lifetime_allocations = sav->lft_s->allocations;
7385 lt->sadb_lifetime_bytes = sav->lft_s->bytes;
7386 lt->sadb_lifetime_addtime = sav->lft_s->addtime;
7387 lt->sadb_lifetime_usetime = sav->lft_s->usetime;
7391 /* set sadb_address for source */
7392 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
7393 &sav->sah->saidx.src.sa,
7394 FULLMASK, IPSEC_ULPROTO_ANY);
7401 /* set sadb_address for destination */
7402 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
7403 &sav->sah->saidx.dst.sa,
7404 FULLMASK, IPSEC_ULPROTO_ANY);
7412 * XXX-BZ Handle NAT-T extensions here.
7413 * XXXAE: it doesn't seem quite useful. IKEs should not depend on
7414 * this information, we report only significant SA fields.
7417 if ((result->m_flags & M_PKTHDR) == 0) {
7422 if (result->m_len < sizeof(struct sadb_msg)) {
7423 result = m_pullup(result, sizeof(struct sadb_msg));
7424 if (result == NULL) {
7430 result->m_pkthdr.len = 0;
7431 for (m = result; m; m = m->m_next)
7432 result->m_pkthdr.len += m->m_len;
7434 mtod(result, struct sadb_msg *)->sadb_msg_len =
7435 PFKEY_UNIT64(result->m_pkthdr.len);
7437 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
7446 key_freesah_flushed(struct secashead_queue *flushq)
7448 struct secashead *sah, *nextsah;
7449 struct secasvar *sav, *nextsav;
7451 sah = TAILQ_FIRST(flushq);
7452 while (sah != NULL) {
7453 sav = TAILQ_FIRST(&sah->savtree_larval);
7454 while (sav != NULL) {
7455 nextsav = TAILQ_NEXT(sav, chain);
7456 TAILQ_REMOVE(&sah->savtree_larval, sav, chain);
7457 key_freesav(&sav); /* release last reference */
7458 key_freesah(&sah); /* release reference from SAV */
7461 sav = TAILQ_FIRST(&sah->savtree_alive);
7462 while (sav != NULL) {
7463 nextsav = TAILQ_NEXT(sav, chain);
7464 TAILQ_REMOVE(&sah->savtree_alive, sav, chain);
7465 key_freesav(&sav); /* release last reference */
7466 key_freesah(&sah); /* release reference from SAV */
7469 nextsah = TAILQ_NEXT(sah, chain);
7470 key_freesah(&sah); /* release last reference */
7476 * SADB_FLUSH processing
7479 * from the ikmpd, and free all entries in secastree.
7483 * NOTE: to do is only marking SADB_SASTATE_DEAD.
7485 * m will always be freed.
7488 key_flush(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7490 struct secashead_queue flushq;
7491 struct sadb_msg *newmsg;
7492 struct secashead *sah, *nextsah;
7493 struct secasvar *sav;
7497 IPSEC_ASSERT(so != NULL, ("null socket"));
7498 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7499 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7501 /* map satype to proto */
7502 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7503 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7505 return key_senderror(so, m, EINVAL);
7508 printf("%s: proto %u\n", __func__, proto));
7510 TAILQ_INIT(&flushq);
7511 if (proto == IPSEC_PROTO_ANY) {
7512 /* no SATYPE specified, i.e. flushing all SA. */
7514 /* Move all SAHs into flushq */
7515 TAILQ_CONCAT(&flushq, &V_sahtree, chain);
7516 /* Flush all buckets in SPI hash */
7517 for (i = 0; i < V_savhash_mask + 1; i++)
7518 LIST_INIT(&V_savhashtbl[i]);
7519 /* Flush all buckets in SAHADDRHASH */
7520 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
7521 LIST_INIT(&V_sahaddrhashtbl[i]);
7522 /* Mark all SAHs as unlinked */
7523 TAILQ_FOREACH(sah, &flushq, chain) {
7524 sah->state = SADB_SASTATE_DEAD;
7526 * Callout handler makes its job using
7527 * RLOCK and drain queues. In case, when this
7528 * function will be called just before it
7529 * acquires WLOCK, we need to mark SAs as
7530 * unlinked to prevent second unlink.
7532 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7533 sav->state = SADB_SASTATE_DEAD;
7535 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7536 sav->state = SADB_SASTATE_DEAD;
7542 sah = TAILQ_FIRST(&V_sahtree);
7543 while (sah != NULL) {
7544 IPSEC_ASSERT(sah->state != SADB_SASTATE_DEAD,
7545 ("DEAD SAH %p in SADB_FLUSH", sah));
7546 nextsah = TAILQ_NEXT(sah, chain);
7547 if (sah->saidx.proto != proto) {
7551 sah->state = SADB_SASTATE_DEAD;
7552 TAILQ_REMOVE(&V_sahtree, sah, chain);
7553 LIST_REMOVE(sah, addrhash);
7554 /* Unlink all SAs from SPI hash */
7555 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7556 LIST_REMOVE(sav, spihash);
7557 sav->state = SADB_SASTATE_DEAD;
7559 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7560 LIST_REMOVE(sav, spihash);
7561 sav->state = SADB_SASTATE_DEAD;
7563 /* Add SAH into flushq */
7564 TAILQ_INSERT_HEAD(&flushq, sah, chain);
7570 key_freesah_flushed(&flushq);
7571 /* Free all queued SAs and SAHs */
7572 if (m->m_len < sizeof(struct sadb_msg) ||
7573 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
7574 ipseclog((LOG_DEBUG, "%s: No more memory.\n", __func__));
7575 return key_senderror(so, m, ENOBUFS);
7581 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
7582 newmsg = mtod(m, struct sadb_msg *);
7583 newmsg->sadb_msg_errno = 0;
7584 newmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
7586 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7590 * SADB_DUMP processing
7591 * dump all entries including status of DEAD in SAD.
7594 * from the ikmpd, and dump all secasvar leaves
7599 * m will always be freed.
7602 key_dump(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7604 SAHTREE_RLOCK_TRACKER;
7605 struct secashead *sah;
7606 struct secasvar *sav;
7609 uint8_t proto, satype;
7611 IPSEC_ASSERT(so != NULL, ("null socket"));
7612 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7613 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7614 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7616 /* map satype to proto */
7617 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7618 ipseclog((LOG_DEBUG, "%s: invalid satype is passed.\n",
7620 return key_senderror(so, m, EINVAL);
7623 /* count sav entries to be sent to the userland. */
7626 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7627 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7628 proto != sah->saidx.proto)
7631 TAILQ_FOREACH(sav, &sah->savtree_larval, chain)
7633 TAILQ_FOREACH(sav, &sah->savtree_alive, chain)
7639 return key_senderror(so, m, ENOENT);
7642 /* send this to the userland, one at a time. */
7643 TAILQ_FOREACH(sah, &V_sahtree, chain) {
7644 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC &&
7645 proto != sah->saidx.proto)
7648 /* map proto to satype */
7649 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7651 ipseclog((LOG_DEBUG, "%s: there was invalid proto in "
7652 "SAD.\n", __func__));
7653 return key_senderror(so, m, EINVAL);
7655 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
7656 n = key_setdumpsa(sav, SADB_DUMP, satype,
7657 --cnt, mhp->msg->sadb_msg_pid);
7660 return key_senderror(so, m, ENOBUFS);
7662 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7664 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
7665 n = key_setdumpsa(sav, SADB_DUMP, satype,
7666 --cnt, mhp->msg->sadb_msg_pid);
7669 return key_senderror(so, m, ENOBUFS);
7671 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7679 * SADB_X_PROMISC processing
7681 * m will always be freed.
7684 key_promisc(struct socket *so, struct mbuf *m, const struct sadb_msghdr *mhp)
7688 IPSEC_ASSERT(so != NULL, ("null socket"));
7689 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7690 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
7691 IPSEC_ASSERT(mhp->msg != NULL, ("null msg"));
7693 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
7695 if (olen < sizeof(struct sadb_msg)) {
7697 return key_senderror(so, m, EINVAL);
7702 } else if (olen == sizeof(struct sadb_msg)) {
7703 /* enable/disable promisc mode */
7706 if ((kp = (struct keycb *)sotorawcb(so)) == NULL)
7707 return key_senderror(so, m, EINVAL);
7708 mhp->msg->sadb_msg_errno = 0;
7709 switch (mhp->msg->sadb_msg_satype) {
7712 kp->kp_promisc = mhp->msg->sadb_msg_satype;
7715 return key_senderror(so, m, EINVAL);
7718 /* send the original message back to everyone */
7719 mhp->msg->sadb_msg_errno = 0;
7720 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7722 /* send packet as is */
7724 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
7726 /* TODO: if sadb_msg_seq is specified, send to specific pid */
7727 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
7731 static int (*key_typesw[])(struct socket *, struct mbuf *,
7732 const struct sadb_msghdr *) = {
7733 NULL, /* SADB_RESERVED */
7734 key_getspi, /* SADB_GETSPI */
7735 key_update, /* SADB_UPDATE */
7736 key_add, /* SADB_ADD */
7737 key_delete, /* SADB_DELETE */
7738 key_get, /* SADB_GET */
7739 key_acquire2, /* SADB_ACQUIRE */
7740 key_register, /* SADB_REGISTER */
7741 NULL, /* SADB_EXPIRE */
7742 key_flush, /* SADB_FLUSH */
7743 key_dump, /* SADB_DUMP */
7744 key_promisc, /* SADB_X_PROMISC */
7745 NULL, /* SADB_X_PCHANGE */
7746 key_spdadd, /* SADB_X_SPDUPDATE */
7747 key_spdadd, /* SADB_X_SPDADD */
7748 key_spddelete, /* SADB_X_SPDDELETE */
7749 key_spdget, /* SADB_X_SPDGET */
7750 NULL, /* SADB_X_SPDACQUIRE */
7751 key_spddump, /* SADB_X_SPDDUMP */
7752 key_spdflush, /* SADB_X_SPDFLUSH */
7753 key_spdadd, /* SADB_X_SPDSETIDX */
7754 NULL, /* SADB_X_SPDEXPIRE */
7755 key_spddelete2, /* SADB_X_SPDDELETE2 */
7759 * parse sadb_msg buffer to process PFKEYv2,
7760 * and create a data to response if needed.
7761 * I think to be dealed with mbuf directly.
7763 * msgp : pointer to pointer to a received buffer pulluped.
7764 * This is rewrited to response.
7765 * so : pointer to socket.
7767 * length for buffer to send to user process.
7770 key_parse(struct mbuf *m, struct socket *so)
7772 struct sadb_msg *msg;
7773 struct sadb_msghdr mh;
7778 IPSEC_ASSERT(so != NULL, ("null socket"));
7779 IPSEC_ASSERT(m != NULL, ("null mbuf"));
7781 if (m->m_len < sizeof(struct sadb_msg)) {
7782 m = m_pullup(m, sizeof(struct sadb_msg));
7786 msg = mtod(m, struct sadb_msg *);
7787 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
7788 target = KEY_SENDUP_ONE;
7790 if ((m->m_flags & M_PKTHDR) == 0 || m->m_pkthdr.len != orglen) {
7791 ipseclog((LOG_DEBUG, "%s: invalid message length.\n",__func__));
7792 PFKEYSTAT_INC(out_invlen);
7797 if (msg->sadb_msg_version != PF_KEY_V2) {
7798 ipseclog((LOG_DEBUG, "%s: PF_KEY version %u is mismatched.\n",
7799 __func__, msg->sadb_msg_version));
7800 PFKEYSTAT_INC(out_invver);
7805 if (msg->sadb_msg_type > SADB_MAX) {
7806 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7807 __func__, msg->sadb_msg_type));
7808 PFKEYSTAT_INC(out_invmsgtype);
7813 /* for old-fashioned code - should be nuked */
7814 if (m->m_pkthdr.len > MCLBYTES) {
7821 MGETHDR(n, M_NOWAIT, MT_DATA);
7822 if (n && m->m_pkthdr.len > MHLEN) {
7823 if (!(MCLGET(n, M_NOWAIT))) {
7832 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
7833 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
7839 /* align the mbuf chain so that extensions are in contiguous region. */
7840 error = key_align(m, &mh);
7846 /* We use satype as scope mask for spddump */
7847 if (msg->sadb_msg_type == SADB_X_SPDDUMP) {
7848 switch (msg->sadb_msg_satype) {
7849 case IPSEC_POLICYSCOPE_ANY:
7850 case IPSEC_POLICYSCOPE_GLOBAL:
7851 case IPSEC_POLICYSCOPE_IFNET:
7852 case IPSEC_POLICYSCOPE_PCB:
7855 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7856 __func__, msg->sadb_msg_type));
7857 PFKEYSTAT_INC(out_invsatype);
7862 switch (msg->sadb_msg_satype) { /* check SA type */
7863 case SADB_SATYPE_UNSPEC:
7864 switch (msg->sadb_msg_type) {
7872 ipseclog((LOG_DEBUG, "%s: must specify satype "
7873 "when msg type=%u.\n", __func__,
7874 msg->sadb_msg_type));
7875 PFKEYSTAT_INC(out_invsatype);
7880 case SADB_SATYPE_AH:
7881 case SADB_SATYPE_ESP:
7882 case SADB_X_SATYPE_IPCOMP:
7883 case SADB_X_SATYPE_TCPSIGNATURE:
7884 switch (msg->sadb_msg_type) {
7886 case SADB_X_SPDDELETE:
7888 case SADB_X_SPDFLUSH:
7889 case SADB_X_SPDSETIDX:
7890 case SADB_X_SPDUPDATE:
7891 case SADB_X_SPDDELETE2:
7892 ipseclog((LOG_DEBUG, "%s: illegal satype=%u\n",
7893 __func__, msg->sadb_msg_type));
7894 PFKEYSTAT_INC(out_invsatype);
7899 case SADB_SATYPE_RSVP:
7900 case SADB_SATYPE_OSPFV2:
7901 case SADB_SATYPE_RIPV2:
7902 case SADB_SATYPE_MIP:
7903 ipseclog((LOG_DEBUG, "%s: type %u isn't supported.\n",
7904 __func__, msg->sadb_msg_satype));
7905 PFKEYSTAT_INC(out_invsatype);
7908 case 1: /* XXX: What does it do? */
7909 if (msg->sadb_msg_type == SADB_X_PROMISC)
7913 ipseclog((LOG_DEBUG, "%s: invalid type %u is passed.\n",
7914 __func__, msg->sadb_msg_satype));
7915 PFKEYSTAT_INC(out_invsatype);
7921 /* check field of upper layer protocol and address family */
7922 if (mh.ext[SADB_EXT_ADDRESS_SRC] != NULL
7923 && mh.ext[SADB_EXT_ADDRESS_DST] != NULL) {
7924 struct sadb_address *src0, *dst0;
7927 src0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_SRC]);
7928 dst0 = (struct sadb_address *)(mh.ext[SADB_EXT_ADDRESS_DST]);
7930 /* check upper layer protocol */
7931 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
7932 ipseclog((LOG_DEBUG, "%s: upper layer protocol "
7933 "mismatched.\n", __func__));
7934 PFKEYSTAT_INC(out_invaddr);
7940 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
7941 PFKEY_ADDR_SADDR(dst0)->sa_family) {
7942 ipseclog((LOG_DEBUG, "%s: address family mismatched.\n",
7944 PFKEYSTAT_INC(out_invaddr);
7948 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7949 PFKEY_ADDR_SADDR(dst0)->sa_len) {
7950 ipseclog((LOG_DEBUG, "%s: address struct size "
7951 "mismatched.\n", __func__));
7952 PFKEYSTAT_INC(out_invaddr);
7957 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7959 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7960 sizeof(struct sockaddr_in)) {
7961 PFKEYSTAT_INC(out_invaddr);
7967 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
7968 sizeof(struct sockaddr_in6)) {
7969 PFKEYSTAT_INC(out_invaddr);
7975 ipseclog((LOG_DEBUG, "%s: unsupported address family\n",
7977 PFKEYSTAT_INC(out_invaddr);
7978 error = EAFNOSUPPORT;
7982 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
7984 plen = sizeof(struct in_addr) << 3;
7987 plen = sizeof(struct in6_addr) << 3;
7990 plen = 0; /*fool gcc*/
7994 /* check max prefix length */
7995 if (src0->sadb_address_prefixlen > plen ||
7996 dst0->sadb_address_prefixlen > plen) {
7997 ipseclog((LOG_DEBUG, "%s: illegal prefixlen.\n",
7999 PFKEYSTAT_INC(out_invaddr);
8005 * prefixlen == 0 is valid because there can be a case when
8006 * all addresses are matched.
8010 if (msg->sadb_msg_type >= nitems(key_typesw) ||
8011 key_typesw[msg->sadb_msg_type] == NULL) {
8012 PFKEYSTAT_INC(out_invmsgtype);
8017 return (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
8020 msg->sadb_msg_errno = error;
8021 return key_sendup_mbuf(so, m, target);
8025 key_senderror(struct socket *so, struct mbuf *m, int code)
8027 struct sadb_msg *msg;
8029 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8030 ("mbuf too small, len %u", m->m_len));
8032 msg = mtod(m, struct sadb_msg *);
8033 msg->sadb_msg_errno = code;
8034 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
8038 * set the pointer to each header into message buffer.
8039 * m will be freed on error.
8040 * XXX larger-than-MCLBYTES extension?
8043 key_align(struct mbuf *m, struct sadb_msghdr *mhp)
8046 struct sadb_ext *ext;
8051 IPSEC_ASSERT(m != NULL, ("null mbuf"));
8052 IPSEC_ASSERT(mhp != NULL, ("null msghdr"));
8053 IPSEC_ASSERT(m->m_len >= sizeof(struct sadb_msg),
8054 ("mbuf too small, len %u", m->m_len));
8057 bzero(mhp, sizeof(*mhp));
8059 mhp->msg = mtod(m, struct sadb_msg *);
8060 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
8062 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
8063 extlen = end; /*just in case extlen is not updated*/
8064 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
8065 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
8067 /* m is already freed */
8070 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8073 switch (ext->sadb_ext_type) {
8075 case SADB_EXT_ADDRESS_SRC:
8076 case SADB_EXT_ADDRESS_DST:
8077 case SADB_EXT_ADDRESS_PROXY:
8078 case SADB_EXT_LIFETIME_CURRENT:
8079 case SADB_EXT_LIFETIME_HARD:
8080 case SADB_EXT_LIFETIME_SOFT:
8081 case SADB_EXT_KEY_AUTH:
8082 case SADB_EXT_KEY_ENCRYPT:
8083 case SADB_EXT_IDENTITY_SRC:
8084 case SADB_EXT_IDENTITY_DST:
8085 case SADB_EXT_SENSITIVITY:
8086 case SADB_EXT_PROPOSAL:
8087 case SADB_EXT_SUPPORTED_AUTH:
8088 case SADB_EXT_SUPPORTED_ENCRYPT:
8089 case SADB_EXT_SPIRANGE:
8090 case SADB_X_EXT_POLICY:
8091 case SADB_X_EXT_SA2:
8092 case SADB_X_EXT_NAT_T_TYPE:
8093 case SADB_X_EXT_NAT_T_SPORT:
8094 case SADB_X_EXT_NAT_T_DPORT:
8095 case SADB_X_EXT_NAT_T_OAI:
8096 case SADB_X_EXT_NAT_T_OAR:
8097 case SADB_X_EXT_NAT_T_FRAG:
8098 case SADB_X_EXT_SA_REPLAY:
8099 case SADB_X_EXT_NEW_ADDRESS_SRC:
8100 case SADB_X_EXT_NEW_ADDRESS_DST:
8101 /* duplicate check */
8103 * XXX Are there duplication payloads of either
8104 * KEY_AUTH or KEY_ENCRYPT ?
8106 if (mhp->ext[ext->sadb_ext_type] != NULL) {
8107 ipseclog((LOG_DEBUG, "%s: duplicate ext_type "
8108 "%u\n", __func__, ext->sadb_ext_type));
8110 PFKEYSTAT_INC(out_dupext);
8115 ipseclog((LOG_DEBUG, "%s: invalid ext_type %u\n",
8116 __func__, ext->sadb_ext_type));
8118 PFKEYSTAT_INC(out_invexttype);
8122 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
8124 if (key_validate_ext(ext, extlen)) {
8126 PFKEYSTAT_INC(out_invlen);
8130 n = m_pulldown(m, off, extlen, &toff);
8132 /* m is already freed */
8135 ext = (struct sadb_ext *)(mtod(n, caddr_t) + toff);
8137 mhp->ext[ext->sadb_ext_type] = ext;
8138 mhp->extoff[ext->sadb_ext_type] = off;
8139 mhp->extlen[ext->sadb_ext_type] = extlen;
8144 PFKEYSTAT_INC(out_invlen);
8152 key_validate_ext(const struct sadb_ext *ext, int len)
8154 const struct sockaddr *sa;
8155 enum { NONE, ADDR } checktype = NONE;
8157 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
8159 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len))
8162 /* if it does not match minimum/maximum length, bail */
8163 if (ext->sadb_ext_type >= nitems(minsize) ||
8164 ext->sadb_ext_type >= nitems(maxsize))
8166 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type])
8168 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type])
8171 /* more checks based on sadb_ext_type XXX need more */
8172 switch (ext->sadb_ext_type) {
8173 case SADB_EXT_ADDRESS_SRC:
8174 case SADB_EXT_ADDRESS_DST:
8175 case SADB_EXT_ADDRESS_PROXY:
8176 case SADB_X_EXT_NAT_T_OAI:
8177 case SADB_X_EXT_NAT_T_OAR:
8178 case SADB_X_EXT_NEW_ADDRESS_SRC:
8179 case SADB_X_EXT_NEW_ADDRESS_DST:
8180 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
8183 case SADB_EXT_IDENTITY_SRC:
8184 case SADB_EXT_IDENTITY_DST:
8185 if (((const struct sadb_ident *)ext)->sadb_ident_type ==
8186 SADB_X_IDENTTYPE_ADDR) {
8187 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
8197 switch (checktype) {
8201 sa = (const struct sockaddr *)(((const u_int8_t*)ext)+baselen);
8202 if (len < baselen + sal)
8204 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len)
8217 TUNABLE_INT_FETCH("net.key.spdcache.maxentries",
8218 &V_key_spdcache_maxentries);
8219 TUNABLE_INT_FETCH("net.key.spdcache.threshold",
8220 &V_key_spdcache_threshold);
8222 if (V_key_spdcache_maxentries) {
8223 V_key_spdcache_maxentries = MAX(V_key_spdcache_maxentries,
8224 SPDCACHE_MAX_ENTRIES_PER_HASH);
8225 V_spdcachehashtbl = hashinit(V_key_spdcache_maxentries /
8226 SPDCACHE_MAX_ENTRIES_PER_HASH,
8227 M_IPSEC_SPDCACHE, &V_spdcachehash_mask);
8228 V_key_spdcache_maxentries = (V_spdcachehash_mask + 1)
8229 * SPDCACHE_MAX_ENTRIES_PER_HASH;
8231 V_spdcache_lock = malloc(sizeof(struct mtx) *
8232 (V_spdcachehash_mask + 1),
8233 M_IPSEC_SPDCACHE, M_WAITOK|M_ZERO);
8235 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8236 SPDCACHE_LOCK_INIT(i);
8240 struct spdcache_entry *
8241 spdcache_entry_alloc(const struct secpolicyindex *spidx, struct secpolicy *sp)
8243 struct spdcache_entry *entry;
8245 entry = malloc(sizeof(struct spdcache_entry),
8246 M_IPSEC_SPDCACHE, M_NOWAIT|M_ZERO);
8253 entry->spidx = *spidx;
8260 spdcache_entry_free(struct spdcache_entry *entry)
8263 if (entry->sp != NULL)
8264 key_freesp(&entry->sp);
8265 free(entry, M_IPSEC_SPDCACHE);
8269 spdcache_clear(void)
8271 struct spdcache_entry *entry;
8274 for (i = 0; i < V_spdcachehash_mask + 1; ++i) {
8276 while (!LIST_EMPTY(&V_spdcachehashtbl[i])) {
8277 entry = LIST_FIRST(&V_spdcachehashtbl[i]);
8278 LIST_REMOVE(entry, chain);
8279 spdcache_entry_free(entry);
8286 spdcache_destroy(void)
8290 if (SPDCACHE_ENABLED()) {
8292 hashdestroy(V_spdcachehashtbl, M_IPSEC_SPDCACHE, V_spdcachehash_mask);
8294 for (i = 0; i < V_spdcachehash_mask + 1; ++i)
8295 SPDCACHE_LOCK_DESTROY(i);
8297 free(V_spdcache_lock, M_IPSEC_SPDCACHE);
8306 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8307 TAILQ_INIT(&V_sptree[i]);
8308 TAILQ_INIT(&V_sptree_ifnet[i]);
8311 V_key_lft_zone = uma_zcreate("IPsec SA lft_c",
8312 sizeof(uint64_t) * 2, NULL, NULL, NULL, NULL,
8313 UMA_ALIGN_PTR, UMA_ZONE_PCPU);
8315 TAILQ_INIT(&V_sahtree);
8316 V_sphashtbl = hashinit(SPHASH_NHASH, M_IPSEC_SP, &V_sphash_mask);
8317 V_savhashtbl = hashinit(SAVHASH_NHASH, M_IPSEC_SA, &V_savhash_mask);
8318 V_sahaddrhashtbl = hashinit(SAHHASH_NHASH, M_IPSEC_SAH,
8319 &V_sahaddrhash_mask);
8320 V_acqaddrhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8321 &V_acqaddrhash_mask);
8322 V_acqseqhashtbl = hashinit(ACQHASH_NHASH, M_IPSEC_SAQ,
8323 &V_acqseqhash_mask);
8327 for (i = 0; i <= SADB_SATYPE_MAX; i++)
8328 LIST_INIT(&V_regtree[i]);
8330 LIST_INIT(&V_acqtree);
8331 LIST_INIT(&V_spacqtree);
8333 if (!IS_DEFAULT_VNET(curvnet))
8338 REGTREE_LOCK_INIT();
8339 SAHTREE_LOCK_INIT();
8343 #ifndef IPSEC_DEBUG2
8344 callout_init(&key_timer, 1);
8345 callout_reset(&key_timer, hz, key_timehandler, NULL);
8346 #endif /*IPSEC_DEBUG2*/
8348 /* initialize key statistics */
8349 keystat.getspi_count = 1;
8352 printf("IPsec: Initialized Security Association Processing.\n");
8359 struct secashead_queue sahdrainq;
8360 struct secpolicy_queue drainq;
8361 struct secpolicy *sp, *nextsp;
8362 struct secacq *acq, *nextacq;
8363 struct secspacq *spacq, *nextspacq;
8364 struct secashead *sah;
8365 struct secasvar *sav;
8370 * XXX: can we just call free() for each object without
8371 * walking through safe way with releasing references?
8373 TAILQ_INIT(&drainq);
8375 for (i = 0; i < IPSEC_DIR_MAX; i++) {
8376 TAILQ_CONCAT(&drainq, &V_sptree[i], chain);
8377 TAILQ_CONCAT(&drainq, &V_sptree_ifnet[i], chain);
8379 for (i = 0; i < V_sphash_mask + 1; i++)
8380 LIST_INIT(&V_sphashtbl[i]);
8384 sp = TAILQ_FIRST(&drainq);
8385 while (sp != NULL) {
8386 nextsp = TAILQ_NEXT(sp, chain);
8391 TAILQ_INIT(&sahdrainq);
8393 TAILQ_CONCAT(&sahdrainq, &V_sahtree, chain);
8394 for (i = 0; i < V_savhash_mask + 1; i++)
8395 LIST_INIT(&V_savhashtbl[i]);
8396 for (i = 0; i < V_sahaddrhash_mask + 1; i++)
8397 LIST_INIT(&V_sahaddrhashtbl[i]);
8398 TAILQ_FOREACH(sah, &sahdrainq, chain) {
8399 sah->state = SADB_SASTATE_DEAD;
8400 TAILQ_FOREACH(sav, &sah->savtree_larval, chain) {
8401 sav->state = SADB_SASTATE_DEAD;
8403 TAILQ_FOREACH(sav, &sah->savtree_alive, chain) {
8404 sav->state = SADB_SASTATE_DEAD;
8409 key_freesah_flushed(&sahdrainq);
8410 hashdestroy(V_sphashtbl, M_IPSEC_SP, V_sphash_mask);
8411 hashdestroy(V_savhashtbl, M_IPSEC_SA, V_savhash_mask);
8412 hashdestroy(V_sahaddrhashtbl, M_IPSEC_SAH, V_sahaddrhash_mask);
8415 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8416 LIST_FOREACH(reg, &V_regtree[i], chain) {
8417 if (__LIST_CHAINED(reg)) {
8418 LIST_REMOVE(reg, chain);
8419 free(reg, M_IPSEC_SAR);
8427 acq = LIST_FIRST(&V_acqtree);
8428 while (acq != NULL) {
8429 nextacq = LIST_NEXT(acq, chain);
8430 LIST_REMOVE(acq, chain);
8431 free(acq, M_IPSEC_SAQ);
8434 for (i = 0; i < V_acqaddrhash_mask + 1; i++)
8435 LIST_INIT(&V_acqaddrhashtbl[i]);
8436 for (i = 0; i < V_acqseqhash_mask + 1; i++)
8437 LIST_INIT(&V_acqseqhashtbl[i]);
8441 for (spacq = LIST_FIRST(&V_spacqtree); spacq != NULL;
8442 spacq = nextspacq) {
8443 nextspacq = LIST_NEXT(spacq, chain);
8444 if (__LIST_CHAINED(spacq)) {
8445 LIST_REMOVE(spacq, chain);
8446 free(spacq, M_IPSEC_SAQ);
8450 hashdestroy(V_acqaddrhashtbl, M_IPSEC_SAQ, V_acqaddrhash_mask);
8451 hashdestroy(V_acqseqhashtbl, M_IPSEC_SAQ, V_acqseqhash_mask);
8452 uma_zdestroy(V_key_lft_zone);
8454 if (!IS_DEFAULT_VNET(curvnet))
8456 #ifndef IPSEC_DEBUG2
8457 callout_drain(&key_timer);
8459 XFORMS_LOCK_DESTROY();
8460 SPTREE_LOCK_DESTROY();
8461 REGTREE_LOCK_DESTROY();
8462 SAHTREE_LOCK_DESTROY();
8464 SPACQ_LOCK_DESTROY();
8468 /* record data transfer on SA, and update timestamps */
8470 key_sa_recordxfer(struct secasvar *sav, struct mbuf *m)
8472 IPSEC_ASSERT(sav != NULL, ("Null secasvar"));
8473 IPSEC_ASSERT(m != NULL, ("Null mbuf"));
8476 * XXX Currently, there is a difference of bytes size
8477 * between inbound and outbound processing.
8479 counter_u64_add(sav->lft_c_bytes, m->m_pkthdr.len);
8482 * We use the number of packets as the unit of
8483 * allocations. We increment the variable
8484 * whenever {esp,ah}_{in,out}put is called.
8486 counter_u64_add(sav->lft_c_allocations, 1);
8489 * NOTE: We record CURRENT usetime by using wall clock,
8490 * in seconds. HARD and SOFT lifetime are measured by the time
8491 * difference (again in seconds) from usetime.
8495 * -----+-----+--------+---> t
8496 * <--------------> HARD
8499 if (sav->firstused == 0)
8500 sav->firstused = time_second;
8504 * Take one of the kernel's security keys and convert it into a PF_KEY
8505 * structure within an mbuf, suitable for sending up to a waiting
8506 * application in user land.
8509 * src: A pointer to a kernel security key.
8510 * exttype: Which type of key this is. Refer to the PF_KEY data structures.
8512 * a valid mbuf or NULL indicating an error
8516 static struct mbuf *
8517 key_setkey(struct seckey *src, uint16_t exttype)
8526 len = PFKEY_ALIGN8(sizeof(struct sadb_key) + _KEYLEN(src));
8527 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8532 p = mtod(m, struct sadb_key *);
8534 p->sadb_key_len = PFKEY_UNIT64(len);
8535 p->sadb_key_exttype = exttype;
8536 p->sadb_key_bits = src->bits;
8537 bcopy(src->key_data, _KEYBUF(p), _KEYLEN(src));
8543 * Take one of the kernel's lifetime data structures and convert it
8544 * into a PF_KEY structure within an mbuf, suitable for sending up to
8545 * a waiting application in user land.
8548 * src: A pointer to a kernel lifetime structure.
8549 * exttype: Which type of lifetime this is. Refer to the PF_KEY
8550 * data structures for more information.
8552 * a valid mbuf or NULL indicating an error
8556 static struct mbuf *
8557 key_setlifetime(struct seclifetime *src, uint16_t exttype)
8559 struct mbuf *m = NULL;
8560 struct sadb_lifetime *p;
8561 int len = PFKEY_ALIGN8(sizeof(struct sadb_lifetime));
8566 m = m_get2(len, M_NOWAIT, MT_DATA, 0);
8571 p = mtod(m, struct sadb_lifetime *);
8574 p->sadb_lifetime_len = PFKEY_UNIT64(len);
8575 p->sadb_lifetime_exttype = exttype;
8576 p->sadb_lifetime_allocations = src->allocations;
8577 p->sadb_lifetime_bytes = src->bytes;
8578 p->sadb_lifetime_addtime = src->addtime;
8579 p->sadb_lifetime_usetime = src->usetime;
8585 const struct enc_xform *
8586 enc_algorithm_lookup(int alg)
8590 for (i = 0; i < nitems(supported_ealgs); i++)
8591 if (alg == supported_ealgs[i].sadb_alg)
8592 return (supported_ealgs[i].xform);
8596 const struct auth_hash *
8597 auth_algorithm_lookup(int alg)
8601 for (i = 0; i < nitems(supported_aalgs); i++)
8602 if (alg == supported_aalgs[i].sadb_alg)
8603 return (supported_aalgs[i].xform);
8607 const struct comp_algo *
8608 comp_algorithm_lookup(int alg)
8612 for (i = 0; i < nitems(supported_calgs); i++)
8613 if (alg == supported_calgs[i].sadb_alg)
8614 return (supported_calgs[i].xform);
8619 * Register a transform.
8622 xform_register(struct xformsw* xsp)
8624 struct xformsw *entry;
8627 LIST_FOREACH(entry, &xforms, chain) {
8628 if (entry->xf_type == xsp->xf_type) {
8633 LIST_INSERT_HEAD(&xforms, xsp, chain);
8639 xform_attach(void *data)
8641 struct xformsw *xsp = (struct xformsw *)data;
8643 if (xform_register(xsp) != 0)
8644 printf("%s: failed to register %s xform\n", __func__,
8649 xform_detach(void *data)
8651 struct xformsw *xsp = (struct xformsw *)data;
8654 LIST_REMOVE(xsp, chain);
8657 /* Delete all SAs related to this xform. */
8658 key_delete_xform(xsp);
8662 * Initialize transform support in an sav.
8665 xform_init(struct secasvar *sav, u_short xftype)
8667 struct xformsw *entry;
8670 IPSEC_ASSERT(sav->tdb_xform == NULL,
8671 ("tdb_xform is already initialized"));
8675 LIST_FOREACH(entry, &xforms, chain) {
8676 if (entry->xf_type == xftype) {
8677 ret = (*entry->xf_init)(sav, entry);