1 /*
2 * Copyright (c) 2008-2021 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29 /* $FreeBSD: src/sys/netkey/key.c,v 1.16.2.13 2002/07/24 18:17:40 ume Exp $ */
30 /* $KAME: key.c,v 1.191 2001/06/27 10:46:49 sakane Exp $ */
31
32 /*
33 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. Neither the name of the project nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 */
60
61 /*
62 * This code is referd to RFC 2367
63 */
64
65 #include <machine/endian.h>
66 #include <sys/types.h>
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/mbuf.h>
71 #include <sys/domain.h>
72 #include <sys/protosw.h>
73 #include <sys/malloc.h>
74 #include <sys/socket.h>
75 #include <sys/socketvar.h>
76 #include <sys/sysctl.h>
77 #include <sys/errno.h>
78 #include <sys/proc.h>
79 #include <sys/queue.h>
80 #include <sys/syslog.h>
81 #include <sys/mcache.h>
82
83 #include <kern/locks.h>
84
85 #include <net/if.h>
86 #include <net/route.h>
87 #include <net/raw_cb.h>
88
89 #include <netinet/in.h>
90 #include <netinet/in_systm.h>
91 #include <netinet/ip.h>
92 #include <netinet/in_var.h>
93
94 #include <netinet/ip6.h>
95 #include <netinet6/in6_var.h>
96 #include <netinet6/ip6_var.h>
97
98 #include <net/pfkeyv2.h>
99 #include <netkey/keydb.h>
100 #include <netkey/key.h>
101 #include <netkey/keysock.h>
102 #include <netkey/key_debug.h>
103 #include <stdarg.h>
104 #include <libkern/crypto/rand.h>
105
106 #include <netinet6/ipsec.h>
107 #include <netinet6/ipsec6.h>
108 #include <netinet6/ah.h>
109 #include <netinet6/ah6.h>
110 #if IPSEC_ESP
111 #include <netinet6/esp.h>
112 #include <netinet6/esp6.h>
113 #endif
114
115
116 /* randomness */
117 #include <sys/random.h>
118
119 #include <net/net_osdep.h>
120
121 #if SKYWALK
122 #include <skywalk/namespace/flowidns.h>
123 #endif /* SKYWALK */
124
125 #define FULLMASK 0xff
126
127 static LCK_GRP_DECLARE(sadb_mutex_grp, "sadb");
128 LCK_MTX_DECLARE(sadb_mutex_data, &sadb_mutex_grp);
129
130 /*
131 * Note on SA reference counting:
132 * - SAs that are not in DEAD state will have (total external reference + 1)
133 * following value in reference count field. they cannot be freed and are
134 * referenced from SA header.
135 * - SAs that are in DEAD state will have (total external reference)
136 * in reference count field. they are ready to be freed. reference from
137 * SA header will be removed in key_delsav(), when the reference count
138 * field hits 0 (= no external reference other than from SA header.
139 */
140
141 u_int32_t key_debug_level = 0; //### our sysctl is not dynamic
142 static int key_timehandler_running = 0;
143 static u_int key_spi_trycnt = 1000;
144 static u_int32_t key_spi_minval = 0x100;
145 static u_int32_t key_spi_maxval = 0x0fffffff; /* XXX */
146 static u_int32_t policy_id = 0;
147 static u_int key_int_random = 60; /*interval to initialize randseed,1(m)*/
148 static u_int key_larval_lifetime = 30; /* interval to expire acquiring, 30(s)*/
149 static int key_blockacq_count = 10; /* counter for blocking SADB_ACQUIRE.*/
150 static int key_blockacq_lifetime = 20; /* lifetime for blocking SADB_ACQUIRE.*/
151 static int key_preferred_oldsa = 0; /* preferred old sa rather than new sa.*/
152 __private_extern__ int natt_keepalive_interval = 20; /* interval between natt keepalives.*/
153 static u_int32_t ipsec_policy_count = 0;
154 static u_int32_t ipsec_sav_count = 0;
155
156 static u_int32_t acq_seq = 0;
157 static int key_tick_init_random = 0;
158 static u_int64_t up_time = 0;
159 __private_extern__ u_int64_t natt_now = 0;
160
161 static LIST_HEAD(_sptree, secpolicy) sptree[IPSEC_DIR_MAX]; /* SPD */
162 static LIST_HEAD(_sahtree, secashead) sahtree; /* SAD */
163 static LIST_HEAD(_regtree, secreg) regtree[SADB_SATYPE_MAX + 1];
164 static LIST_HEAD(_custom_sahtree, secashead) custom_sahtree;
165 /* registed list */
166
167 #define SPIHASHSIZE 128
168 #define SPIHASH(x) (((x) ^ ((x) >> 16)) % SPIHASHSIZE)
169 static LIST_HEAD(_spihash, secasvar) spihash[SPIHASHSIZE];
170
171 #ifndef IPSEC_NONBLOCK_ACQUIRE
172 static LIST_HEAD(_acqtree, secacq) acqtree; /* acquiring list */
173 #endif
174 static LIST_HEAD(_spacqtree, secspacq) spacqtree; /* SP acquiring list */
175
176 struct key_cb key_cb;
177
178 /* search order for SAs */
179 static const u_int saorder_state_valid_prefer_old[] = {
180 SADB_SASTATE_DYING, SADB_SASTATE_MATURE,
181 };
182 static const u_int saorder_state_valid_prefer_new[] = {
183 SADB_SASTATE_MATURE, SADB_SASTATE_DYING,
184 };
185 static const u_int saorder_state_alive[] = {
186 /* except DEAD */
187 SADB_SASTATE_MATURE, SADB_SASTATE_DYING, SADB_SASTATE_LARVAL
188 };
189 static const u_int saorder_state_any[] = {
190 SADB_SASTATE_MATURE, SADB_SASTATE_DYING,
191 SADB_SASTATE_LARVAL, SADB_SASTATE_DEAD
192 };
193
194 static const int minsize[] = {
195 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
196 sizeof(struct sadb_sa), /* SADB_EXT_SA */
197 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
198 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
199 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
200 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_SRC */
201 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_DST */
202 sizeof(struct sadb_address), /* SADB_EXT_ADDRESS_PROXY */
203 sizeof(struct sadb_key), /* SADB_EXT_KEY_AUTH */
204 sizeof(struct sadb_key), /* SADB_EXT_KEY_ENCRYPT */
205 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_SRC */
206 sizeof(struct sadb_ident), /* SADB_EXT_IDENTITY_DST */
207 sizeof(struct sadb_sens), /* SADB_EXT_SENSITIVITY */
208 sizeof(struct sadb_prop), /* SADB_EXT_PROPOSAL */
209 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_AUTH */
210 sizeof(struct sadb_supported), /* SADB_EXT_SUPPORTED_ENCRYPT */
211 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
212 0, /* SADB_X_EXT_KMPRIVATE */
213 sizeof(struct sadb_x_policy), /* SADB_X_EXT_POLICY */
214 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
215 sizeof(struct sadb_session_id), /* SADB_EXT_SESSION_ID */
216 sizeof(struct sadb_sastat), /* SADB_EXT_SASTAT */
217 sizeof(struct sadb_x_ipsecif), /* SADB_X_EXT_IPSECIF */
218 sizeof(struct sadb_address), /* SADB_X_EXT_ADDR_RANGE_SRC_START */
219 sizeof(struct sadb_address), /* SADB_X_EXT_ADDR_RANGE_SRC_END */
220 sizeof(struct sadb_address), /* SADB_X_EXT_ADDR_RANGE_DST_START */
221 sizeof(struct sadb_address), /* SADB_X_EXT_ADDR_RANGE_DST_END */
222 sizeof(struct sadb_address), /* SADB_EXT_MIGRATE_ADDRESS_SRC */
223 sizeof(struct sadb_address), /* SADB_EXT_MIGRATE_ADDRESS_DST */
224 sizeof(struct sadb_x_ipsecif), /* SADB_X_EXT_MIGRATE_IPSECIF */
225 };
226 static const int maxsize[] = {
227 sizeof(struct sadb_msg), /* SADB_EXT_RESERVED */
228 sizeof(struct sadb_sa_2), /* SADB_EXT_SA */
229 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_CURRENT */
230 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_HARD */
231 sizeof(struct sadb_lifetime), /* SADB_EXT_LIFETIME_SOFT */
232 0, /* SADB_EXT_ADDRESS_SRC */
233 0, /* SADB_EXT_ADDRESS_DST */
234 0, /* SADB_EXT_ADDRESS_PROXY */
235 0, /* SADB_EXT_KEY_AUTH */
236 0, /* SADB_EXT_KEY_ENCRYPT */
237 0, /* SADB_EXT_IDENTITY_SRC */
238 0, /* SADB_EXT_IDENTITY_DST */
239 0, /* SADB_EXT_SENSITIVITY */
240 0, /* SADB_EXT_PROPOSAL */
241 0, /* SADB_EXT_SUPPORTED_AUTH */
242 0, /* SADB_EXT_SUPPORTED_ENCRYPT */
243 sizeof(struct sadb_spirange), /* SADB_EXT_SPIRANGE */
244 0, /* SADB_X_EXT_KMPRIVATE */
245 0, /* SADB_X_EXT_POLICY */
246 sizeof(struct sadb_x_sa2), /* SADB_X_SA2 */
247 0, /* SADB_EXT_SESSION_ID */
248 0, /* SADB_EXT_SASTAT */
249 sizeof(struct sadb_x_ipsecif), /* SADB_X_EXT_IPSECIF */
250 0, /* SADB_X_EXT_ADDR_RANGE_SRC_START */
251 0, /* SADB_X_EXT_ADDR_RANGE_SRC_END */
252 0, /* SADB_X_EXT_ADDR_RANGE_DST_START */
253 0, /* SADB_X_EXT_ADDR_RANGE_DST_END */
254 0, /* SADB_EXT_MIGRATE_ADDRESS_SRC */
255 0, /* SADB_EXT_MIGRATE_ADDRESS_DST */
256 sizeof(struct sadb_x_ipsecif), /* SADB_X_EXT_MIGRATE_IPSECIF */
257 };
258
259 static int ipsec_esp_keymin = 256;
260 static int ipsec_esp_auth = 0;
261 static int ipsec_ah_keymin = 128;
262
263 SYSCTL_DECL(_net_key);
264 /* Thread safe: no accumulated state */
265 SYSCTL_INT(_net_key, KEYCTL_DEBUG_LEVEL, debug, CTLFLAG_RW | CTLFLAG_LOCKED, \
266 &key_debug_level, 0, "");
267
268
269 /* max count of trial for the decision of spi value */
270 SYSCTL_INT(_net_key, KEYCTL_SPI_TRY, spi_trycnt, CTLFLAG_RW | CTLFLAG_LOCKED, \
271 &key_spi_trycnt, 0, "");
272
273 /* minimum spi value to allocate automatically. */
274 SYSCTL_INT(_net_key, KEYCTL_SPI_MIN_VALUE, spi_minval, CTLFLAG_RW | CTLFLAG_LOCKED, \
275 &key_spi_minval, 0, "");
276
277 /* maximun spi value to allocate automatically. */
278 SYSCTL_INT(_net_key, KEYCTL_SPI_MAX_VALUE, spi_maxval, CTLFLAG_RW | CTLFLAG_LOCKED, \
279 &key_spi_maxval, 0, "");
280
281 /* interval to initialize randseed */
282 SYSCTL_INT(_net_key, KEYCTL_RANDOM_INT, int_random, CTLFLAG_RW | CTLFLAG_LOCKED, \
283 &key_int_random, 0, "");
284
285 /* lifetime for larval SA; thread safe due to > compare */
286 SYSCTL_INT(_net_key, KEYCTL_LARVAL_LIFETIME, larval_lifetime, CTLFLAG_RW | CTLFLAG_LOCKED, \
287 &key_larval_lifetime, 0, "");
288
289 /* counter for blocking to send SADB_ACQUIRE to IKEd */
290 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_COUNT, blockacq_count, CTLFLAG_RW | CTLFLAG_LOCKED, \
291 &key_blockacq_count, 0, "");
292
293 /* lifetime for blocking to send SADB_ACQUIRE to IKEd: Thread safe, > compare */
294 SYSCTL_INT(_net_key, KEYCTL_BLOCKACQ_LIFETIME, blockacq_lifetime, CTLFLAG_RW | CTLFLAG_LOCKED, \
295 &key_blockacq_lifetime, 0, "");
296
297 /* ESP auth */
298 SYSCTL_INT(_net_key, KEYCTL_ESP_AUTH, esp_auth, CTLFLAG_RW | CTLFLAG_LOCKED, \
299 &ipsec_esp_auth, 0, "");
300
301 /* minimum ESP key length */
302 SYSCTL_INT(_net_key, KEYCTL_ESP_KEYMIN, esp_keymin, CTLFLAG_RW | CTLFLAG_LOCKED, \
303 &ipsec_esp_keymin, 0, "");
304
305 /* minimum AH key length */
306 SYSCTL_INT(_net_key, KEYCTL_AH_KEYMIN, ah_keymin, CTLFLAG_RW | CTLFLAG_LOCKED, \
307 &ipsec_ah_keymin, 0, "");
308
309 /* perfered old SA rather than new SA */
310 SYSCTL_INT(_net_key, KEYCTL_PREFERED_OLDSA, prefered_oldsa, CTLFLAG_RW | CTLFLAG_LOCKED, \
311 &key_preferred_oldsa, 0, "");
312
313 /* time between NATT keepalives in seconds, 0 disabled */
314 SYSCTL_INT(_net_key, KEYCTL_NATT_KEEPALIVE_INTERVAL, natt_keepalive_interval, CTLFLAG_RW | CTLFLAG_LOCKED, \
315 &natt_keepalive_interval, 0, "");
316
317 /* PF_KEY statistics */
318 SYSCTL_STRUCT(_net_key, KEYCTL_PFKEYSTAT, pfkeystat, CTLFLAG_RD | CTLFLAG_LOCKED, \
319 &pfkeystat, pfkeystat, "");
320
321 #ifndef LIST_FOREACH
322 #define LIST_FOREACH(elm, head, field) \
323 for (elm = LIST_FIRST(head); elm; elm = LIST_NEXT(elm, field))
324 #endif
325 #define __LIST_CHAINED(elm) \
326 (!((elm)->chain.le_next == NULL && (elm)->chain.le_prev == NULL))
327 #define LIST_INSERT_TAIL(head, elm, type, field) \
328 do {\
329 struct type *curelm = LIST_FIRST(head); \
330 if (curelm == NULL) {\
331 LIST_INSERT_HEAD(head, elm, field); \
332 } else { \
333 while (LIST_NEXT(curelm, field)) \
334 curelm = LIST_NEXT(curelm, field);\
335 LIST_INSERT_AFTER(curelm, elm, field);\
336 }\
337 } while (0)
338
339 #define KEY_CHKSASTATE(head, sav, name) \
340 do { \
341 if ((head) != (sav)) { \
342 ipseclog((LOG_DEBUG, "%s: state mismatched (TREE=%d SA=%d)\n", \
343 (name), (head), (sav))); \
344 continue; \
345 } \
346 } while (0)
347
348 #define KEY_CHKSPDIR(head, sp, name) \
349 do { \
350 if ((head) != (sp)) { \
351 ipseclog((LOG_DEBUG, "%s: direction mismatched (TREE=%d SP=%d), " \
352 "anyway continue.\n", \
353 (name), (head), (sp))); \
354 } \
355 } while (0)
356
357 /*
358 * set parameters into secpolicyindex buffer.
359 * Must allocate secpolicyindex buffer passed to this function.
360 */
361 #define KEY_SETSECSPIDX(_dir, s, d, ps, pd, ulp, ifp, s_s, s_e, d_s, d_e, idx) \
362 do { \
363 bzero((idx), sizeof(struct secpolicyindex)); \
364 (idx)->dir = (_dir); \
365 (idx)->prefs = (ps); \
366 (idx)->prefd = (pd); \
367 (idx)->ul_proto = (ulp); \
368 (idx)->internal_if = (ifp); \
369 if (s) bcopy((s), &(idx)->src, ((struct sockaddr *)(s))->sa_len); \
370 if (d) bcopy((d), &(idx)->dst, ((struct sockaddr *)(d))->sa_len); \
371 if (s_s) bcopy((s_s), &(idx)->src_range.start, ((struct sockaddr *)(s_s))->sa_len); \
372 if (s_e) bcopy((s_e), &(idx)->src_range.end, ((struct sockaddr *)(s_e))->sa_len); \
373 if (d_s) bcopy((d_s), &(idx)->dst_range.start, ((struct sockaddr *)(d_s))->sa_len); \
374 if (d_e) bcopy((d_e), &(idx)->dst_range.end, ((struct sockaddr *)(d_e))->sa_len); \
375 } while (0)
376
377 /*
378 * set parameters into secasindex buffer.
379 * Must allocate secasindex buffer before calling this function.
380 */
381 #define KEY_SETSECASIDX(p, m, r, s, d, ifi, idx) \
382 do { \
383 bzero((idx), sizeof(struct secasindex)); \
384 (idx)->proto = (p); \
385 (idx)->mode = (m); \
386 (idx)->reqid = (r); \
387 bcopy((s), &(idx)->src, ((const struct sockaddr *)(s))->sa_len); \
388 bcopy((d), &(idx)->dst, ((const struct sockaddr *)(d))->sa_len); \
389 (idx)->ipsec_ifindex = (ifi); \
390 } while (0)
391
392 /* key statistics */
393 struct _keystat {
394 u_int32_t getspi_count; /* the avarage of count to try to get new SPI */
395 } keystat;
396
397 struct sadb_msghdr {
398 struct sadb_msg *msg;
399 struct sadb_ext *ext[SADB_EXT_MAX + 1];
400 int extoff[SADB_EXT_MAX + 1];
401 int extlen[SADB_EXT_MAX + 1];
402 };
403
404 static struct secpolicy *__key_getspbyid(u_int32_t id);
405 static struct secasvar *key_do_allocsa_policy(struct secashead *, u_int, u_int16_t);
406 static int key_do_get_translated_port(struct secashead *, struct secasvar *, u_int);
407 static void key_delsp(struct secpolicy *);
408 static struct secpolicy *key_getsp(struct secpolicyindex *);
409 static u_int16_t key_newreqid(void);
410 static struct mbuf *key_gather_mbuf(struct mbuf *,
411 const struct sadb_msghdr *, int, int, int *);
412 static int key_spdadd(struct socket *, struct mbuf *,
413 const struct sadb_msghdr *);
414 static u_int32_t key_getnewspid(void);
415 static int key_spddelete(struct socket *, struct mbuf *,
416 const struct sadb_msghdr *);
417 static int key_spddelete2(struct socket *, struct mbuf *,
418 const struct sadb_msghdr *);
419 static int key_spdenable(struct socket *, struct mbuf *,
420 const struct sadb_msghdr *);
421 static int key_spddisable(struct socket *, struct mbuf *,
422 const struct sadb_msghdr *);
423 static int key_spdget(struct socket *, struct mbuf *,
424 const struct sadb_msghdr *);
425 static int key_spdflush(struct socket *, struct mbuf *,
426 const struct sadb_msghdr *);
427 static int key_spddump(struct socket *, struct mbuf *,
428 const struct sadb_msghdr *);
429 static struct mbuf *key_setdumpsp(struct secpolicy *,
430 u_int8_t, u_int32_t, u_int32_t);
431 static u_int key_getspreqmsglen(struct secpolicy *);
432 static int key_spdexpire(struct secpolicy *);
433 static struct secashead *key_newsah(struct secasindex *, ifnet_t, u_int, u_int8_t, u_int16_t);
434 static struct secasvar *key_newsav(struct mbuf *,
435 const struct sadb_msghdr *, struct secashead *, int *,
436 struct socket *);
437 static struct secashead *key_getsah(struct secasindex *, u_int16_t);
438 static struct secasvar *key_checkspidup(struct secasindex *, u_int32_t);
439 static void key_setspi __P((struct secasvar *, u_int32_t));
440 static struct secasvar *key_getsavbyspi(struct secashead *, u_int32_t);
441 static int key_setsaval(struct secasvar *, struct mbuf *,
442 const struct sadb_msghdr *);
443 static int key_mature(struct secasvar *);
444 static struct mbuf *key_setdumpsa(struct secasvar *, u_int8_t,
445 u_int8_t, u_int32_t, u_int32_t);
446 static struct mbuf *key_setsadbmsg(u_int8_t, u_int16_t, u_int8_t,
447 u_int32_t, pid_t, u_int16_t);
448 static struct mbuf *key_setsadbsa(struct secasvar *);
449 static struct mbuf *key_setsadbaddr(u_int16_t,
450 struct sockaddr *, size_t, u_int8_t);
451 static struct mbuf *key_setsadbipsecif(ifnet_t, ifnet_t, ifnet_t, u_int8_t);
452 static struct mbuf *key_setsadbxsa2(u_int8_t, u_int32_t, u_int32_t, u_int16_t);
453 static struct mbuf *key_setsadbxpolicy(u_int16_t, u_int8_t,
454 u_int32_t);
455 static void *key_newbuf(const void *, u_int);
456 static int key_ismyaddr6(struct sockaddr_in6 *);
457 static void key_update_natt_keepalive_timestamp(struct secasvar *, struct secasvar *);
458
459 /* flags for key_cmpsaidx() */
460 #define CMP_HEAD 0x1 /* protocol, addresses. */
461 #define CMP_PORT 0x2 /* additionally HEAD, reqid, mode. */
462 #define CMP_REQID 0x4 /* additionally HEAD, reqid. */
463 #define CMP_MODE 0x8 /* additionally mode. */
464 #define CMP_EXACTLY 0xF /* all elements. */
465 static int key_cmpsaidx(struct secasindex *, struct secasindex *, int);
466
467 static int key_cmpspidx_exactly(struct secpolicyindex *,
468 struct secpolicyindex *);
469 static int key_cmpspidx_withmask(struct secpolicyindex *,
470 struct secpolicyindex *);
471 static int key_sockaddrcmp(struct sockaddr *, struct sockaddr *, int);
472 static int key_is_addr_in_range(struct sockaddr_storage *, struct secpolicyaddrrange *);
473 static int key_bbcmp(caddr_t, caddr_t, u_int);
474 static void key_srandom(void);
475 static u_int8_t key_satype2proto(u_int8_t);
476 static u_int8_t key_proto2satype(u_int16_t);
477
478 static int key_getspi(struct socket *, struct mbuf *,
479 const struct sadb_msghdr *);
480 static u_int32_t key_do_getnewspi(struct sadb_spirange *, struct secasindex *);
481 static int key_update(struct socket *, struct mbuf *,
482 const struct sadb_msghdr *);
483 static int key_add(struct socket *, struct mbuf *, const struct sadb_msghdr *);
484 static struct mbuf *key_getmsgbuf_x1(struct mbuf *, const struct sadb_msghdr *);
485 static int key_delete(struct socket *, struct mbuf *,
486 const struct sadb_msghdr *);
487 static int key_get(struct socket *, struct mbuf *, const struct sadb_msghdr *);
488
489 static void key_getcomb_setlifetime(struct sadb_comb *);
490 #if IPSEC_ESP
491 static struct mbuf *key_getcomb_esp(void);
492 #endif
493 static struct mbuf *key_getcomb_ah(void);
494 static struct mbuf *key_getprop(const struct secasindex *);
495
496 static int key_acquire(struct secasindex *, struct secpolicy *);
497 #ifndef IPSEC_NONBLOCK_ACQUIRE
498 static struct secacq *key_newacq(struct secasindex *);
499 static struct secacq *key_getacq(struct secasindex *);
500 static struct secacq *key_getacqbyseq(u_int32_t);
501 #endif
502 static struct secspacq *key_newspacq(struct secpolicyindex *);
503 static struct secspacq *key_getspacq(struct secpolicyindex *);
504 static int key_acquire2(struct socket *, struct mbuf *,
505 const struct sadb_msghdr *);
506 static int key_register(struct socket *, struct mbuf *,
507 const struct sadb_msghdr *);
508 static int key_expire(struct secasvar *);
509 static int key_flush(struct socket *, struct mbuf *,
510 const struct sadb_msghdr *);
511 static int key_dump(struct socket *, struct mbuf *, const struct sadb_msghdr *);
512 static int key_promisc(struct socket *, struct mbuf *,
513 const struct sadb_msghdr *);
514 static int key_senderror(struct socket *, struct mbuf *, int);
515 static int key_validate_ext(const struct sadb_ext *, int);
516 static int key_align(struct mbuf *, struct sadb_msghdr *);
517 static struct mbuf *key_alloc_mbuf(int);
518 static int key_getsastat(struct socket *, struct mbuf *, const struct sadb_msghdr *);
519 static int key_migrate(struct socket *, struct mbuf *, const struct sadb_msghdr *);
520 static void bzero_keys(const struct sadb_msghdr *);
521
522 extern int ipsec_bypass;
523 extern int esp_udp_encap_port;
524 int ipsec_send_natt_keepalive(struct secasvar *sav);
525 bool ipsec_fill_offload_frame(ifnet_t ifp, struct secasvar *sav, struct ifnet_keepalive_offload_frame *frame, size_t frame_data_offset);
526
527 void key_init(struct protosw *, struct domain *);
528
529 static void
key_get_flowid(struct secasvar * sav)530 key_get_flowid(struct secasvar *sav)
531 {
532 #if SKYWALK
533 struct flowidns_flow_key fk;
534 struct secashead *sah = sav->sah;
535
536 if ((sah->dir != IPSEC_DIR_OUTBOUND) && (sah->dir != IPSEC_DIR_ANY)) {
537 return;
538 }
539
540 bzero(&fk, sizeof(fk));
541 ASSERT(sah->saidx.src.ss_family == sah->saidx.dst.ss_family);
542 switch (sah->saidx.src.ss_family) {
543 case AF_INET:
544 ASSERT(sah->saidx.src.ss_len == sizeof(struct sockaddr_in));
545 ASSERT(sah->saidx.dst.ss_len == sizeof(struct sockaddr_in));
546 fk.ffk_laddr_v4 =
547 ((struct sockaddr_in *)&(sah->saidx.src))->sin_addr;
548 fk.ffk_raddr_v4 =
549 ((struct sockaddr_in *)&(sah->saidx.dst))->sin_addr;
550 break;
551
552 case AF_INET6:
553 ASSERT(sah->saidx.src.ss_len == sizeof(struct sockaddr_in6));
554 ASSERT(sah->saidx.dst.ss_len == sizeof(struct sockaddr_in6));
555 fk.ffk_laddr_v6 =
556 ((struct sockaddr_in6 *)&(sah->saidx.src))->sin6_addr;
557 fk.ffk_raddr_v6 =
558 ((struct sockaddr_in6 *)&(sah->saidx.dst))->sin6_addr;
559 break;
560
561 default:
562 VERIFY(0);
563 break;
564 }
565
566 ASSERT(sav->spi != 0);
567 fk.ffk_spi = sav->spi;;
568 fk.ffk_af = sah->saidx.src.ss_family;
569 fk.ffk_proto = (uint8_t)(sah->saidx.proto);
570
571 flowidns_allocate_flowid(FLOWIDNS_DOMAIN_IPSEC, &fk, &sav->flowid);
572 #else /* !SKYWALK */
573 sav->flowid = 0;
574 #endif /* !SKYWALK */
575 }
576
577 static void
key_release_flowid(struct secasvar * sav)578 key_release_flowid(struct secasvar *sav)
579 {
580 #if SKYWALK
581 if (sav->flowid != 0) {
582 flowidns_release_flowid(sav->flowid);
583 sav->flowid = 0;
584 }
585 #else /* !SKYWALK */
586 VERIFY(sav->flowid == 0);
587 #endif /* !SKYWALK */
588 }
589
590 /*
591 * PF_KEY init
592 * setup locks, and then init timer and associated data
593 */
594 void
key_init(struct protosw * pp,struct domain * dp __unused)595 key_init(struct protosw *pp, struct domain *dp __unused)
596 {
597 static int key_initialized = 0;
598 int i;
599
600 VERIFY((pp->pr_flags & (PR_INITIALIZED | PR_ATTACHED)) == PR_ATTACHED);
601
602 _CASSERT(PFKEY_ALIGN8(sizeof(struct sadb_msg)) <= _MHLEN);
603 _CASSERT(MAX_REPLAY_WINDOWS == MBUF_TC_MAX);
604
605 if (key_initialized) {
606 return;
607 }
608 key_initialized = 1;
609
610 for (i = 0; i < SPIHASHSIZE; i++) {
611 LIST_INIT(&spihash[i]);
612 }
613
614 bzero((caddr_t)&key_cb, sizeof(key_cb));
615
616 for (i = 0; i < IPSEC_DIR_MAX; i++) {
617 LIST_INIT(&sptree[i]);
618 }
619 ipsec_policy_count = 0;
620
621 LIST_INIT(&sahtree);
622 LIST_INIT(&custom_sahtree);
623
624 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
625 LIST_INIT(®tree[i]);
626 }
627 ipsec_sav_count = 0;
628
629 #ifndef IPSEC_NONBLOCK_ACQUIRE
630 LIST_INIT(&acqtree);
631 #endif
632 LIST_INIT(&spacqtree);
633
634 /* system default */
635 #if INET
636 ip4_def_policy.policy = IPSEC_POLICY_NONE;
637 ip4_def_policy.refcnt++; /*never reclaim this*/
638 #endif
639 ip6_def_policy.policy = IPSEC_POLICY_NONE;
640 ip6_def_policy.refcnt++; /*never reclaim this*/
641
642 key_timehandler_running = 0;
643
644 /* initialize key statistics */
645 keystat.getspi_count = 1;
646
647 esp_init();
648 #ifndef __APPLE__
649 printf("IPsec: Initialized Security Association Processing.\n");
650 #endif
651 }
652
653 static void
key_start_timehandler(void)654 key_start_timehandler(void)
655 {
656 /* must be called while locked */
657 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
658 if (key_timehandler_running == 0) {
659 key_timehandler_running = 1;
660 (void)timeout((void *)key_timehandler, (void *)0, hz);
661 }
662
663 /* Turn off the ipsec bypass */
664 if (ipsec_bypass != 0) {
665 ipsec_bypass = 0;
666 }
667 }
668
669 /* %%% IPsec policy management */
670 /*
671 * allocating a SP for OUTBOUND or INBOUND packet.
672 * Must call key_freesp() later.
673 * OUT: NULL: not found
674 * others: found and return the pointer.
675 */
676 struct secpolicy *
key_allocsp(struct secpolicyindex * spidx,u_int dir)677 key_allocsp(
678 struct secpolicyindex *spidx,
679 u_int dir)
680 {
681 struct secpolicy *sp;
682 struct timeval tv;
683
684 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
685 /* sanity check */
686 if (spidx == NULL) {
687 panic("key_allocsp: NULL pointer is passed.");
688 }
689
690 /* check direction */
691 switch (dir) {
692 case IPSEC_DIR_INBOUND:
693 case IPSEC_DIR_OUTBOUND:
694 break;
695 default:
696 panic("key_allocsp: Invalid direction is passed.");
697 }
698
699 /* get a SP entry */
700 KEYDEBUG(KEYDEBUG_IPSEC_DATA,
701 printf("*** objects\n");
702 kdebug_secpolicyindex(spidx));
703
704 lck_mtx_lock(sadb_mutex);
705 LIST_FOREACH(sp, &sptree[dir], chain) {
706 KEYDEBUG(KEYDEBUG_IPSEC_DATA,
707 printf("*** in SPD\n");
708 kdebug_secpolicyindex(&sp->spidx));
709
710 if (sp->state == IPSEC_SPSTATE_DEAD) {
711 continue;
712 }
713
714 /* If the policy is disabled, skip */
715 if (sp->disabled > 0) {
716 continue;
717 }
718
719 /* If the incoming spidx specifies bound if,
720 * ignore unbound policies*/
721 if (spidx->internal_if != NULL
722 && (sp->spidx.internal_if == NULL || sp->ipsec_if == NULL)) {
723 continue;
724 }
725
726 if (key_cmpspidx_withmask(&sp->spidx, spidx)) {
727 goto found;
728 }
729 }
730 lck_mtx_unlock(sadb_mutex);
731 return NULL;
732
733 found:
734
735 /* found a SPD entry */
736 microtime(&tv);
737 sp->lastused = tv.tv_sec;
738 sp->refcnt++;
739 lck_mtx_unlock(sadb_mutex);
740
741 /* sanity check */
742 KEY_CHKSPDIR(sp->spidx.dir, dir, "key_allocsp");
743 KEYDEBUG(KEYDEBUG_IPSEC_STAMP,
744 printf("DP key_allocsp cause refcnt++:%d SP:0x%llx\n",
745 sp->refcnt, (uint64_t)VM_KERNEL_ADDRPERM(sp)));
746 return sp;
747 }
748
749 /*
750 * return a policy that matches this particular inbound packet.
751 * XXX slow
752 */
753 struct secpolicy *
key_gettunnel(struct sockaddr * osrc,struct sockaddr * odst,struct sockaddr * isrc,struct sockaddr * idst)754 key_gettunnel(
755 struct sockaddr *osrc,
756 struct sockaddr *odst,
757 struct sockaddr *isrc,
758 struct sockaddr *idst)
759 {
760 struct secpolicy *sp;
761 const int dir = IPSEC_DIR_INBOUND;
762 struct timeval tv;
763 struct ipsecrequest *r1, *r2, *p;
764 struct sockaddr *os, *od, *is, *id;
765 struct secpolicyindex spidx;
766
767 if (isrc->sa_family != idst->sa_family) {
768 ipseclog((LOG_ERR, "protocol family mismatched %d != %d\n.",
769 isrc->sa_family, idst->sa_family));
770 return NULL;
771 }
772
773 lck_mtx_lock(sadb_mutex);
774 LIST_FOREACH(sp, &sptree[dir], chain) {
775 if (sp->state == IPSEC_SPSTATE_DEAD) {
776 continue;
777 }
778
779 r1 = r2 = NULL;
780 for (p = sp->req; p; p = p->next) {
781 if (p->saidx.mode != IPSEC_MODE_TUNNEL) {
782 continue;
783 }
784
785 r1 = r2;
786 r2 = p;
787
788 if (!r1) {
789 /* here we look at address matches only */
790 spidx = sp->spidx;
791 if (isrc->sa_len > sizeof(spidx.src) ||
792 idst->sa_len > sizeof(spidx.dst)) {
793 continue;
794 }
795 bcopy(isrc, &spidx.src, isrc->sa_len);
796 bcopy(idst, &spidx.dst, idst->sa_len);
797 if (!key_cmpspidx_withmask(&sp->spidx, &spidx)) {
798 continue;
799 }
800 } else {
801 is = (struct sockaddr *)&r1->saidx.src;
802 id = (struct sockaddr *)&r1->saidx.dst;
803 if (key_sockaddrcmp(is, isrc, 0) ||
804 key_sockaddrcmp(id, idst, 0)) {
805 continue;
806 }
807 }
808
809 os = (struct sockaddr *)&r2->saidx.src;
810 od = (struct sockaddr *)&r2->saidx.dst;
811 if (key_sockaddrcmp(os, osrc, 0) ||
812 key_sockaddrcmp(od, odst, 0)) {
813 continue;
814 }
815
816 goto found;
817 }
818 }
819 lck_mtx_unlock(sadb_mutex);
820 return NULL;
821
822 found:
823 microtime(&tv);
824 sp->lastused = tv.tv_sec;
825 sp->refcnt++;
826 lck_mtx_unlock(sadb_mutex);
827 return sp;
828 }
829
830 struct secasvar *
key_alloc_outbound_sav_for_interface(ifnet_t interface,int family,struct sockaddr * src,struct sockaddr * dst)831 key_alloc_outbound_sav_for_interface(ifnet_t interface, int family,
832 struct sockaddr *src,
833 struct sockaddr *dst)
834 {
835 struct secashead *sah;
836 struct secasvar *sav;
837 u_int stateidx;
838 u_int state;
839 const u_int *saorder_state_valid;
840 int arraysize;
841 struct sockaddr_in *sin;
842 u_int16_t dstport;
843 bool strict = true;
844
845 if (interface == NULL) {
846 return NULL;
847 }
848
849 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
850
851 lck_mtx_lock(sadb_mutex);
852
853 do {
854 LIST_FOREACH(sah, &sahtree, chain) {
855 if (sah->state == SADB_SASTATE_DEAD) {
856 continue;
857 }
858 if (sah->ipsec_if == interface &&
859 (family == AF_INET6 || family == AF_INET) &&
860 sah->dir == IPSEC_DIR_OUTBOUND) {
861 if (strict &&
862 sah->saidx.mode == IPSEC_MODE_TRANSPORT &&
863 src != NULL && dst != NULL) {
864 // Validate addresses for transport mode
865 if (key_sockaddrcmp((struct sockaddr *)&sah->saidx.src, src, 0) != 0) {
866 // Source doesn't match
867 continue;
868 }
869
870 if (key_sockaddrcmp((struct sockaddr *)&sah->saidx.dst, dst, 0) != 0) {
871 // Destination doesn't match
872 continue;
873 }
874 }
875
876 /* This SAH is linked to the IPsec interface, and the right family. We found it! */
877 if (key_preferred_oldsa) {
878 saorder_state_valid = saorder_state_valid_prefer_old;
879 arraysize = _ARRAYLEN(saorder_state_valid_prefer_old);
880 } else {
881 saorder_state_valid = saorder_state_valid_prefer_new;
882 arraysize = _ARRAYLEN(saorder_state_valid_prefer_new);
883 }
884
885 sin = (struct sockaddr_in *)&sah->saidx.dst;
886 dstport = sin->sin_port;
887 if (sah->saidx.mode == IPSEC_MODE_TRANSPORT) {
888 sin->sin_port = IPSEC_PORT_ANY;
889 }
890
891 for (stateidx = 0; stateidx < arraysize; stateidx++) {
892 state = saorder_state_valid[stateidx];
893 sav = key_do_allocsa_policy(sah, state, dstport);
894 if (sav != NULL) {
895 lck_mtx_unlock(sadb_mutex);
896 return sav;
897 }
898 }
899
900 break;
901 }
902 }
903 if (strict) {
904 // If we didn't find anything, try again without strict
905 strict = false;
906 } else {
907 // We already were on the second try, bail
908 break;
909 }
910 } while (true);
911
912 lck_mtx_unlock(sadb_mutex);
913 return NULL;
914 }
915
916 /*
917 * allocating an SA entry for an *OUTBOUND* packet.
918 * checking each request entries in SP, and acquire an SA if need.
919 * OUT: 0: there are valid requests.
920 * ENOENT: policy may be valid, but SA with REQUIRE is on acquiring.
921 */
922 int
key_checkrequest(struct ipsecrequest * isr,struct secasindex * saidx,struct secasvar ** sav)923 key_checkrequest(
924 struct ipsecrequest *isr,
925 struct secasindex *saidx,
926 struct secasvar **sav)
927 {
928 u_int level;
929 int error;
930 struct sockaddr_in *sin;
931
932 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
933
934 *sav = NULL;
935
936 /* sanity check */
937 if (isr == NULL || saidx == NULL) {
938 panic("key_checkrequest: NULL pointer is passed.");
939 }
940
941 /* check mode */
942 switch (saidx->mode) {
943 case IPSEC_MODE_TRANSPORT:
944 case IPSEC_MODE_TUNNEL:
945 break;
946 case IPSEC_MODE_ANY:
947 default:
948 panic("key_checkrequest: Invalid policy defined.");
949 }
950
951 /* get current level */
952 level = ipsec_get_reqlevel(isr);
953
954
955 /*
956 * key_allocsa_policy should allocate the oldest SA available.
957 * See key_do_allocsa_policy(), and draft-jenkins-ipsec-rekeying-03.txt.
958 */
959 if (*sav == NULL) {
960 *sav = key_allocsa_policy(saidx);
961 }
962
963 /* When there is SA. */
964 if (*sav != NULL) {
965 return 0;
966 }
967
968 /* There is no SA.
969 *
970 * Remove dst port - used for special natt support - don't call
971 * key_acquire with it.
972 */
973 if (saidx->mode == IPSEC_MODE_TRANSPORT) {
974 sin = (struct sockaddr_in *)&saidx->dst;
975 sin->sin_port = IPSEC_PORT_ANY;
976 }
977 if ((error = key_acquire(saidx, isr->sp)) != 0) {
978 /* XXX What should I do ? */
979 ipseclog((LOG_DEBUG, "key_checkrequest: error %d returned "
980 "from key_acquire.\n", error));
981 return error;
982 }
983
984 return level == IPSEC_LEVEL_REQUIRE ? ENOENT : 0;
985 }
986
987 /*
988 * allocating a SA for policy entry from SAD.
989 * NOTE: searching SAD of aliving state.
990 * OUT: NULL: not found.
991 * others: found and return the pointer.
992 */
993 u_int32_t sah_search_calls = 0;
994 u_int32_t sah_search_count = 0;
995 struct secasvar *
key_allocsa_policy(struct secasindex * saidx)996 key_allocsa_policy(
997 struct secasindex *saidx)
998 {
999 struct secashead *sah;
1000 struct secasvar *sav;
1001 u_int stateidx, state;
1002 const u_int *saorder_state_valid;
1003 int arraysize;
1004 struct sockaddr_in *sin;
1005 u_int16_t dstport;
1006
1007 lck_mtx_lock(sadb_mutex);
1008 sah_search_calls++;
1009 LIST_FOREACH(sah, &sahtree, chain) {
1010 sah_search_count++;
1011 if (sah->state == SADB_SASTATE_DEAD) {
1012 continue;
1013 }
1014 if (key_cmpsaidx(&sah->saidx, saidx, CMP_MODE | CMP_REQID)) {
1015 goto found;
1016 }
1017 }
1018 lck_mtx_unlock(sadb_mutex);
1019 return NULL;
1020
1021 found:
1022
1023 /*
1024 * search a valid state list for outbound packet.
1025 * This search order is important.
1026 */
1027 if (key_preferred_oldsa) {
1028 saorder_state_valid = saorder_state_valid_prefer_old;
1029 arraysize = _ARRAYLEN(saorder_state_valid_prefer_old);
1030 } else {
1031 saorder_state_valid = saorder_state_valid_prefer_new;
1032 arraysize = _ARRAYLEN(saorder_state_valid_prefer_new);
1033 }
1034
1035
1036 sin = (struct sockaddr_in *)&saidx->dst;
1037 dstport = sin->sin_port;
1038 if (saidx->mode == IPSEC_MODE_TRANSPORT) {
1039 sin->sin_port = IPSEC_PORT_ANY;
1040 }
1041
1042 for (stateidx = 0; stateidx < arraysize; stateidx++) {
1043 state = saorder_state_valid[stateidx];
1044
1045 sav = key_do_allocsa_policy(sah, state, dstport);
1046 if (sav != NULL) {
1047 lck_mtx_unlock(sadb_mutex);
1048 return sav;
1049 }
1050 }
1051 lck_mtx_unlock(sadb_mutex);
1052 return NULL;
1053 }
1054
1055 static void
key_send_delete(struct secasvar * sav)1056 key_send_delete(struct secasvar *sav)
1057 {
1058 struct mbuf *m, *result;
1059 u_int8_t satype;
1060
1061 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
1062
1063 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
1064 panic("key_do_allocsa_policy: invalid proto is passed.");
1065 }
1066
1067 m = key_setsadbmsg(SADB_DELETE, 0,
1068 satype, 0, 0, (u_int16_t)(sav->refcnt - 1));
1069 if (!m) {
1070 goto msgfail;
1071 }
1072 result = m;
1073
1074 /* set sadb_address for saidx's. */
1075 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
1076 (struct sockaddr *)&sav->sah->saidx.src,
1077 sav->sah->saidx.src.ss_len << 3,
1078 IPSEC_ULPROTO_ANY);
1079 if (!m) {
1080 goto msgfail;
1081 }
1082 m_cat(result, m);
1083
1084 /* set sadb_address for saidx's. */
1085 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
1086 (struct sockaddr *)&sav->sah->saidx.dst,
1087 sav->sah->saidx.src.ss_len << 3,
1088 IPSEC_ULPROTO_ANY);
1089 if (!m) {
1090 goto msgfail;
1091 }
1092 m_cat(result, m);
1093
1094 /* create SA extension */
1095 m = key_setsadbsa(sav);
1096 if (!m) {
1097 goto msgfail;
1098 }
1099 m_cat(result, m);
1100
1101 if (result->m_len < sizeof(struct sadb_msg)) {
1102 result = m_pullup(result,
1103 sizeof(struct sadb_msg));
1104 if (result == NULL) {
1105 goto msgfail;
1106 }
1107 }
1108
1109 result->m_pkthdr.len = 0;
1110 for (m = result; m; m = m->m_next) {
1111 result->m_pkthdr.len += m->m_len;
1112 }
1113
1114 VERIFY(PFKEY_UNIT64(result->m_pkthdr.len) <= UINT16_MAX);
1115 mtod(result, struct sadb_msg *)->sadb_msg_len =
1116 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
1117
1118 if (key_sendup_mbuf(NULL, result,
1119 KEY_SENDUP_REGISTERED)) {
1120 goto msgfail;
1121 }
1122 msgfail:
1123 key_freesav(sav, KEY_SADB_LOCKED);
1124 }
1125
1126 /*
1127 * searching SAD with direction, protocol, mode and state.
1128 * called by key_allocsa_policy().
1129 * OUT:
1130 * NULL : not found
1131 * others : found, pointer to a SA.
1132 */
1133 static struct secasvar *
key_do_allocsa_policy(struct secashead * sah,u_int state,u_int16_t dstport)1134 key_do_allocsa_policy(
1135 struct secashead *sah,
1136 u_int state,
1137 u_int16_t dstport)
1138 {
1139 struct secasvar *sav, *nextsav, *candidate, *natt_candidate, *no_natt_candidate, *d;
1140
1141 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1142
1143 /* initialize */
1144 candidate = NULL;
1145 natt_candidate = NULL;
1146 no_natt_candidate = NULL;
1147
1148 for (sav = LIST_FIRST(&sah->savtree[state]);
1149 sav != NULL;
1150 sav = nextsav) {
1151 nextsav = LIST_NEXT(sav, chain);
1152
1153 /* sanity check */
1154 KEY_CHKSASTATE(sav->state, state, "key_do_allocsa_policy");
1155
1156 if (sah->saidx.mode == IPSEC_MODE_TUNNEL && dstport &&
1157 ((sav->flags & SADB_X_EXT_NATT) != 0) &&
1158 ntohs(dstport) != sav->remote_ike_port) {
1159 continue;
1160 }
1161
1162 if (sah->saidx.mode == IPSEC_MODE_TRANSPORT &&
1163 ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0) &&
1164 ntohs(dstport) != sav->remote_ike_port) {
1165 continue; /* skip this one - not a match - or not UDP */
1166 }
1167 if ((sah->saidx.mode == IPSEC_MODE_TUNNEL &&
1168 ((sav->flags & SADB_X_EXT_NATT) != 0)) ||
1169 (sah->saidx.mode == IPSEC_MODE_TRANSPORT &&
1170 ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0))) {
1171 if (natt_candidate == NULL) {
1172 natt_candidate = sav;
1173 continue;
1174 } else {
1175 candidate = natt_candidate;
1176 }
1177 } else {
1178 if (no_natt_candidate == NULL) {
1179 no_natt_candidate = sav;
1180 continue;
1181 } else {
1182 candidate = no_natt_candidate;
1183 }
1184 }
1185
1186 /* Which SA is the better ? */
1187
1188 /* sanity check 2 */
1189 if (candidate->lft_c == NULL || sav->lft_c == NULL) {
1190 panic("key_do_allocsa_policy: "
1191 "lifetime_current is NULL.\n");
1192 }
1193
1194 /* What the best method is to compare ? */
1195 if (key_preferred_oldsa) {
1196 if (candidate->lft_c->sadb_lifetime_addtime >
1197 sav->lft_c->sadb_lifetime_addtime) {
1198 if ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0) {
1199 natt_candidate = sav;
1200 } else {
1201 no_natt_candidate = sav;
1202 }
1203 }
1204 continue;
1205 /*NOTREACHED*/
1206 }
1207
1208 /* prefered new sa rather than old sa */
1209 if (candidate->lft_c->sadb_lifetime_addtime <
1210 sav->lft_c->sadb_lifetime_addtime) {
1211 d = candidate;
1212 if ((sah->saidx.mode == IPSEC_MODE_TUNNEL &&
1213 ((sav->flags & SADB_X_EXT_NATT) != 0)) ||
1214 (sah->saidx.mode == IPSEC_MODE_TRANSPORT &&
1215 ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0))) {
1216 natt_candidate = sav;
1217 } else {
1218 no_natt_candidate = sav;
1219 }
1220 } else {
1221 d = sav;
1222 }
1223
1224 /*
1225 * prepared to delete the SA when there is more
1226 * suitable candidate and the lifetime of the SA is not
1227 * permanent.
1228 */
1229 if (d->lft_c->sadb_lifetime_addtime != 0) {
1230 key_send_delete(d);
1231 }
1232 }
1233
1234 /* choose latest if both types present */
1235 if (natt_candidate == NULL) {
1236 candidate = no_natt_candidate;
1237 } else if (no_natt_candidate == NULL) {
1238 candidate = natt_candidate;
1239 } else if (sah->saidx.mode == IPSEC_MODE_TUNNEL && dstport) {
1240 candidate = natt_candidate;
1241 } else if (natt_candidate->lft_c->sadb_lifetime_addtime >
1242 no_natt_candidate->lft_c->sadb_lifetime_addtime) {
1243 candidate = natt_candidate;
1244 } else {
1245 candidate = no_natt_candidate;
1246 }
1247
1248 if (candidate) {
1249 candidate->refcnt++;
1250 KEYDEBUG(KEYDEBUG_IPSEC_STAMP,
1251 printf("DP allocsa_policy cause "
1252 "refcnt++:%d SA:0x%llx\n", candidate->refcnt,
1253 (uint64_t)VM_KERNEL_ADDRPERM(candidate)));
1254 }
1255 return candidate;
1256 }
1257
1258 /*
1259 * allocating a SA entry for a *INBOUND* packet.
1260 * Must call key_freesav() later.
1261 * OUT: positive: pointer to a sav.
1262 * NULL: not found, or error occurred.
1263 *
1264 * In the comparison, source address will be ignored for RFC2401 conformance.
1265 * To quote, from section 4.1:
1266 * A security association is uniquely identified by a triple consisting
1267 * of a Security Parameter Index (SPI), an IP Destination Address, and a
1268 * security protocol (AH or ESP) identifier.
1269 * Note that, however, we do need to keep source address in IPsec SA.
1270 * IKE specification and PF_KEY specification do assume that we
1271 * keep source address in IPsec SA. We see a tricky situation here.
1272 */
1273 struct secasvar *
key_allocsa(u_int family,caddr_t src,caddr_t dst,uint32_t dst_ifscope,u_int proto,u_int32_t spi)1274 key_allocsa(
1275 u_int family,
1276 caddr_t src,
1277 caddr_t dst,
1278 uint32_t dst_ifscope,
1279 u_int proto,
1280 u_int32_t spi)
1281 {
1282 return key_allocsa_extended(family, src, dst, dst_ifscope, proto, spi, NULL);
1283 }
1284
1285 struct secasvar *
key_allocsa_extended(u_int family,caddr_t src,caddr_t dst,uint32_t dst_ifscope,u_int proto,u_int32_t spi,ifnet_t interface)1286 key_allocsa_extended(u_int family,
1287 caddr_t src,
1288 caddr_t dst,
1289 uint32_t dst_ifscope,
1290 u_int proto,
1291 u_int32_t spi,
1292 ifnet_t interface)
1293 {
1294 struct secasvar *sav, *match;
1295 u_int stateidx, state, tmpidx, matchidx;
1296 union sockaddr_in_4_6 dst_address = {};
1297 const u_int *saorder_state_valid;
1298 int arraysize;
1299 bool dst_ll_address = false;
1300
1301 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
1302
1303 /* sanity check */
1304 if (src == NULL || dst == NULL) {
1305 panic("key_allocsa: NULL pointer is passed.");
1306 }
1307
1308 /*
1309 * when both systems employ similar strategy to use a SA.
1310 * the search order is important even in the inbound case.
1311 */
1312 if (key_preferred_oldsa) {
1313 saorder_state_valid = saorder_state_valid_prefer_old;
1314 arraysize = _ARRAYLEN(saorder_state_valid_prefer_old);
1315 } else {
1316 saorder_state_valid = saorder_state_valid_prefer_new;
1317 arraysize = _ARRAYLEN(saorder_state_valid_prefer_new);
1318 }
1319
1320 /* check dst address */
1321 switch (family) {
1322 case AF_INET:
1323 dst_address.sin.sin_family = AF_INET;
1324 dst_address.sin.sin_len = sizeof(dst_address.sin);
1325 memcpy(&dst_address.sin.sin_addr, dst, sizeof(dst_address.sin.sin_addr));
1326 break;
1327 case AF_INET6:
1328 dst_address.sin6.sin6_family = AF_INET6;
1329 dst_address.sin6.sin6_len = sizeof(dst_address.sin6);
1330 memcpy(&dst_address.sin6.sin6_addr, dst, sizeof(dst_address.sin6.sin6_addr));
1331 if (IN6_IS_SCOPE_LINKLOCAL(&dst_address.sin6.sin6_addr)) {
1332 dst_ll_address = true;
1333 /* kame fake scopeid */
1334 dst_address.sin6.sin6_scope_id = dst_ifscope;
1335 if (in6_embedded_scope) {
1336 in6_verify_ifscope(&dst_address.sin6.sin6_addr, dst_address.sin6.sin6_scope_id);
1337 dst_address.sin6.sin6_scope_id =
1338 ntohs(dst_address.sin6.sin6_addr.s6_addr16[1]);
1339 dst_address.sin6.sin6_addr.s6_addr16[1] = 0;
1340 }
1341 }
1342 break;
1343 default:
1344 ipseclog((LOG_DEBUG, "key_allocsa: "
1345 "unknown address family=%d.\n", family));
1346 return NULL;
1347 }
1348
1349
1350 /*
1351 * searching SAD.
1352 * XXX: to be checked internal IP header somewhere. Also when
1353 * IPsec tunnel packet is received. But ESP tunnel mode is
1354 * encrypted so we can't check internal IP header.
1355 */
1356 /*
1357 * search a valid state list for inbound packet.
1358 * the search order is not important.
1359 */
1360 match = NULL;
1361 matchidx = arraysize;
1362 lck_mtx_lock(sadb_mutex);
1363 LIST_FOREACH(sav, &spihash[SPIHASH(spi)], spihash) {
1364 if (sav->spi != spi) {
1365 continue;
1366 }
1367 if (interface != NULL &&
1368 sav->sah->ipsec_if != interface) {
1369 continue;
1370 }
1371 if (proto != sav->sah->saidx.proto) {
1372 continue;
1373 }
1374 if (family != sav->sah->saidx.src.ss_family ||
1375 family != sav->sah->saidx.dst.ss_family) {
1376 continue;
1377 }
1378 tmpidx = arraysize;
1379 for (stateidx = 0; stateidx < matchidx; stateidx++) {
1380 state = saorder_state_valid[stateidx];
1381 if (sav->state == state) {
1382 tmpidx = stateidx;
1383 break;
1384 }
1385 }
1386 if (tmpidx >= matchidx) {
1387 continue;
1388 }
1389
1390 struct sockaddr_in6 tmp_sah_dst = {};
1391 struct sockaddr *sah_dst = (struct sockaddr *)&sav->sah->saidx.dst;
1392 if (dst_ll_address) {
1393 if (!IN6_IS_SCOPE_LINKLOCAL(&(__DECONST(struct sockaddr_in6 *, sah_dst))->sin6_addr)) {
1394 continue;
1395 } else {
1396 tmp_sah_dst.sin6_family = AF_INET6;
1397 tmp_sah_dst.sin6_len = sizeof(tmp_sah_dst);
1398 memcpy(&tmp_sah_dst.sin6_addr, &(__DECONST(struct sockaddr_in6 *, sah_dst))->sin6_addr, sizeof(tmp_sah_dst.sin6_addr));
1399 tmp_sah_dst.sin6_scope_id = sav->sah->outgoing_if;
1400 sah_dst = (struct sockaddr *)&tmp_sah_dst;
1401 }
1402 }
1403
1404 if (key_sockaddrcmp(SA(&dst_address.sa), sah_dst, 0) != 0) {
1405 continue;
1406 }
1407
1408 match = sav;
1409 matchidx = tmpidx;
1410 }
1411 if (match) {
1412 goto found;
1413 }
1414
1415 /* not found */
1416 lck_mtx_unlock(sadb_mutex);
1417 return NULL;
1418
1419 found:
1420 match->refcnt++;
1421 lck_mtx_unlock(sadb_mutex);
1422 KEYDEBUG(KEYDEBUG_IPSEC_STAMP,
1423 printf("DP allocsa cause refcnt++:%d SA:0x%llx\n",
1424 match->refcnt, (uint64_t)VM_KERNEL_ADDRPERM(match)));
1425 return match;
1426 }
1427
1428 /*
1429 * This function checks whether a UDP packet with a random local port
1430 * and a remote port of 4500 matches an SA in the kernel. If does match,
1431 * send the packet to the ESP engine. If not, send the packet to the UDP protocol.
1432 */
1433 bool
key_checksa_present(u_int family,caddr_t local_addr,caddr_t remote_addr,u_int16_t local_port,u_int16_t remote_port,uint32_t source_ifscope,uint32_t remote_ifscope)1434 key_checksa_present(u_int family,
1435 caddr_t local_addr,
1436 caddr_t remote_addr,
1437 u_int16_t local_port,
1438 u_int16_t remote_port,
1439 uint32_t source_ifscope,
1440 uint32_t remote_ifscope)
1441 {
1442 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
1443
1444 /* sanity check */
1445 if (local_addr == NULL || remote_addr == NULL) {
1446 panic("key_allocsa: NULL pointer is passed.");
1447 }
1448
1449 /*
1450 * searching SAD.
1451 * XXX: to be checked internal IP header somewhere. Also when
1452 * IPsec tunnel packet is received. But ESP tunnel mode is
1453 * encrypted so we can't check internal IP header.
1454 */
1455 /*
1456 * search a valid state list for inbound packet.
1457 * the search order is not important.
1458 */
1459 struct secashead *sah = NULL;
1460 bool found_sa = false;
1461
1462 lck_mtx_lock(sadb_mutex);
1463 LIST_FOREACH(sah, &sahtree, chain) {
1464 if (sah->state == SADB_SASTATE_DEAD) {
1465 continue;
1466 }
1467
1468 if (sah->dir != IPSEC_DIR_OUTBOUND) {
1469 continue;
1470 }
1471
1472 if (family != sah->saidx.src.ss_family) {
1473 continue;
1474 }
1475
1476 struct sockaddr_in src_in = {};
1477 struct sockaddr_in6 src_in6 = {};
1478
1479 /* check src address */
1480 switch (family) {
1481 case AF_INET:
1482 src_in.sin_family = AF_INET;
1483 src_in.sin_len = sizeof(src_in);
1484 memcpy(&src_in.sin_addr, local_addr, sizeof(src_in.sin_addr));
1485 if (key_sockaddrcmp((struct sockaddr*)&src_in,
1486 (struct sockaddr *)&sah->saidx.src, 0) != 0) {
1487 continue;
1488 }
1489 break;
1490 case AF_INET6:
1491 src_in6.sin6_family = AF_INET6;
1492 src_in6.sin6_len = sizeof(src_in6);
1493 memcpy(&src_in6.sin6_addr, local_addr, sizeof(src_in6.sin6_addr));
1494 if (IN6_IS_SCOPE_LINKLOCAL(&src_in6.sin6_addr)) {
1495 /* kame fake scopeid */
1496 src_in6.sin6_scope_id = source_ifscope;
1497 if (in6_embedded_scope) {
1498 in6_verify_ifscope(&src_in6.sin6_addr, src_in6.sin6_scope_id);
1499 src_in6.sin6_scope_id =
1500 ntohs(src_in6.sin6_addr.s6_addr16[1]);
1501 src_in6.sin6_addr.s6_addr16[1] = 0;
1502 }
1503 }
1504 if (key_sockaddrcmp((struct sockaddr*)&src_in6,
1505 (struct sockaddr *)&sah->saidx.src, 0) != 0) {
1506 continue;
1507 }
1508 break;
1509 default:
1510 ipseclog((LOG_DEBUG, "key_checksa_present: "
1511 "unknown address family=%d.\n",
1512 family));
1513 continue;
1514 }
1515
1516 struct sockaddr_in dest_in = {};
1517 struct sockaddr_in6 dest_in6 = {};
1518
1519 /* check dst address */
1520 switch (family) {
1521 case AF_INET:
1522 dest_in.sin_family = AF_INET;
1523 dest_in.sin_len = sizeof(dest_in);
1524 memcpy(&dest_in.sin_addr, remote_addr, sizeof(dest_in.sin_addr));
1525 if (key_sockaddrcmp((struct sockaddr*)&dest_in,
1526 (struct sockaddr *)&sah->saidx.dst, 0) != 0) {
1527 continue;
1528 }
1529
1530 break;
1531 case AF_INET6:
1532 dest_in6.sin6_family = AF_INET6;
1533 dest_in6.sin6_len = sizeof(dest_in6);
1534 memcpy(&dest_in6.sin6_addr, remote_addr, sizeof(dest_in6.sin6_addr));
1535 if (IN6_IS_SCOPE_LINKLOCAL(&dest_in6.sin6_addr)) {
1536 /* kame fake scopeid */
1537 dest_in6.sin6_scope_id = remote_ifscope;
1538 if (in6_embedded_scope) {
1539 in6_verify_ifscope(&dest_in6.sin6_addr, dest_in6.sin6_scope_id);
1540 dest_in6.sin6_scope_id = ntohs(dest_in6.sin6_addr.s6_addr16[1]);
1541 dest_in6.sin6_addr.s6_addr16[1] = 0;
1542 }
1543 }
1544 if (key_sockaddrcmp((struct sockaddr*)&dest_in6,
1545 (struct sockaddr *)&sah->saidx.dst, 0) != 0) {
1546 continue;
1547 }
1548
1549 break;
1550 default:
1551 ipseclog((LOG_DEBUG, "key_checksa_present: "
1552 "unknown address family=%d.\n", family));
1553 continue;
1554 }
1555
1556 struct secasvar *nextsav = NULL;
1557 for (u_int stateidx = 0; stateidx < _ARRAYLEN(saorder_state_alive); stateidx++) {
1558 u_int state = saorder_state_alive[stateidx];
1559 for (struct secasvar *sav = LIST_FIRST(&sah->savtree[state]); sav != NULL; sav = nextsav) {
1560 nextsav = LIST_NEXT(sav, chain);
1561 /* sanity check */
1562 if (sav->state != state) {
1563 ipseclog((LOG_DEBUG, "key_checksa_present: "
1564 "invalid sav->state "
1565 "(state: %d SA: %d)\n",
1566 state, sav->state));
1567 continue;
1568 }
1569
1570 if (sav->remote_ike_port != ntohs(remote_port)) {
1571 continue;
1572 }
1573
1574 if (sav->natt_encapsulated_src_port != local_port) {
1575 continue;
1576 }
1577 found_sa = true;
1578 break;
1579 }
1580 }
1581 }
1582
1583 /* not found */
1584 lck_mtx_unlock(sadb_mutex);
1585 return found_sa;
1586 }
1587
1588 u_int16_t
key_natt_get_translated_port(struct secasvar * outsav)1589 key_natt_get_translated_port(
1590 struct secasvar *outsav)
1591 {
1592 struct secasindex saidx;
1593 struct secashead *sah;
1594 u_int stateidx, state;
1595 const u_int *saorder_state_valid;
1596 int arraysize;
1597
1598 /* get sa for incoming */
1599 saidx.mode = outsav->sah->saidx.mode;
1600 saidx.reqid = 0;
1601 saidx.proto = outsav->sah->saidx.proto;
1602 bcopy(&outsav->sah->saidx.src, &saidx.dst, sizeof(struct sockaddr_in));
1603 bcopy(&outsav->sah->saidx.dst, &saidx.src, sizeof(struct sockaddr_in));
1604
1605 lck_mtx_lock(sadb_mutex);
1606 LIST_FOREACH(sah, &sahtree, chain) {
1607 if (sah->state == SADB_SASTATE_DEAD) {
1608 continue;
1609 }
1610 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE)) {
1611 goto found;
1612 }
1613 }
1614 lck_mtx_unlock(sadb_mutex);
1615 return 0;
1616
1617 found:
1618 /*
1619 * Found sah - now go thru list of SAs and find
1620 * matching remote ike port. If found - set
1621 * sav->natt_encapsulated_src_port and return the port.
1622 */
1623 /*
1624 * search a valid state list for outbound packet.
1625 * This search order is important.
1626 */
1627 if (key_preferred_oldsa) {
1628 saorder_state_valid = saorder_state_valid_prefer_old;
1629 arraysize = _ARRAYLEN(saorder_state_valid_prefer_old);
1630 } else {
1631 saorder_state_valid = saorder_state_valid_prefer_new;
1632 arraysize = _ARRAYLEN(saorder_state_valid_prefer_new);
1633 }
1634
1635 for (stateidx = 0; stateidx < arraysize; stateidx++) {
1636 state = saorder_state_valid[stateidx];
1637 if (key_do_get_translated_port(sah, outsav, state)) {
1638 lck_mtx_unlock(sadb_mutex);
1639 return outsav->natt_encapsulated_src_port;
1640 }
1641 }
1642 lck_mtx_unlock(sadb_mutex);
1643 return 0;
1644 }
1645
1646 static int
key_do_get_translated_port(struct secashead * sah,struct secasvar * outsav,u_int state)1647 key_do_get_translated_port(
1648 struct secashead *sah,
1649 struct secasvar *outsav,
1650 u_int state)
1651 {
1652 struct secasvar *currsav, *nextsav, *candidate;
1653
1654
1655 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1656
1657 /* initilize */
1658 candidate = NULL;
1659
1660 for (currsav = LIST_FIRST(&sah->savtree[state]);
1661 currsav != NULL;
1662 currsav = nextsav) {
1663 nextsav = LIST_NEXT(currsav, chain);
1664
1665 /* sanity check */
1666 KEY_CHKSASTATE(currsav->state, state, "key_do_get_translated_port");
1667
1668 if ((currsav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) == 0 ||
1669 currsav->remote_ike_port != outsav->remote_ike_port) {
1670 continue;
1671 }
1672
1673 if (candidate == NULL) {
1674 candidate = currsav;
1675 continue;
1676 }
1677
1678 /* Which SA is the better ? */
1679
1680 /* sanity check 2 */
1681 if (candidate->lft_c == NULL || currsav->lft_c == NULL) {
1682 panic("key_do_get_translated_port: "
1683 "lifetime_current is NULL.\n");
1684 }
1685
1686 /* What the best method is to compare ? */
1687 if (key_preferred_oldsa) {
1688 if (candidate->lft_c->sadb_lifetime_addtime >
1689 currsav->lft_c->sadb_lifetime_addtime) {
1690 candidate = currsav;
1691 }
1692 continue;
1693 /*NOTREACHED*/
1694 }
1695
1696 /* prefered new sa rather than old sa */
1697 if (candidate->lft_c->sadb_lifetime_addtime <
1698 currsav->lft_c->sadb_lifetime_addtime) {
1699 candidate = currsav;
1700 }
1701 }
1702
1703 if (candidate) {
1704 outsav->natt_encapsulated_src_port = candidate->natt_encapsulated_src_port;
1705 return 1;
1706 }
1707
1708 return 0;
1709 }
1710
1711 /*
1712 * Must be called after calling key_allocsp().
1713 */
1714 void
key_freesp(struct secpolicy * sp,int locked)1715 key_freesp(
1716 struct secpolicy *sp,
1717 int locked)
1718 {
1719 /* sanity check */
1720 if (sp == NULL) {
1721 panic("key_freesp: NULL pointer is passed.");
1722 }
1723
1724 if (!locked) {
1725 lck_mtx_lock(sadb_mutex);
1726 } else {
1727 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1728 }
1729 sp->refcnt--;
1730 KEYDEBUG(KEYDEBUG_IPSEC_STAMP,
1731 printf("DP freesp cause refcnt--:%d SP:0x%llx\n",
1732 sp->refcnt, (uint64_t)VM_KERNEL_ADDRPERM(sp)));
1733
1734 if (sp->refcnt == 0) {
1735 key_delsp(sp);
1736 }
1737 if (!locked) {
1738 lck_mtx_unlock(sadb_mutex);
1739 }
1740 return;
1741 }
1742
1743 /*
1744 * Must be called after calling key_allocsa().
1745 * This function is called by key_freesp() to free some SA allocated
1746 * for a policy.
1747 */
1748 void
key_freesav(struct secasvar * sav,int locked)1749 key_freesav(
1750 struct secasvar *sav,
1751 int locked)
1752 {
1753 /* sanity check */
1754 if (sav == NULL) {
1755 panic("key_freesav: NULL pointer is passed.");
1756 }
1757
1758 if (!locked) {
1759 lck_mtx_lock(sadb_mutex);
1760 } else {
1761 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1762 }
1763 sav->refcnt--;
1764 KEYDEBUG(KEYDEBUG_IPSEC_STAMP,
1765 printf("DP freesav cause refcnt--:%d SA:0x%llx SPI %u\n",
1766 sav->refcnt, (uint64_t)VM_KERNEL_ADDRPERM(sav),
1767 (u_int32_t)ntohl(sav->spi)));
1768
1769 if (sav->refcnt == 0) {
1770 key_delsav(sav);
1771 }
1772 if (!locked) {
1773 lck_mtx_unlock(sadb_mutex);
1774 }
1775 return;
1776 }
1777
1778 /* %%% SPD management */
1779 /*
1780 * free security policy entry.
1781 */
1782 static void
key_delsp(struct secpolicy * sp)1783 key_delsp(
1784 struct secpolicy *sp)
1785 {
1786 /* sanity check */
1787 if (sp == NULL) {
1788 panic("key_delsp: NULL pointer is passed.");
1789 }
1790
1791 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1792 sp->state = IPSEC_SPSTATE_DEAD;
1793
1794 if (sp->refcnt > 0) {
1795 return; /* can't free */
1796 }
1797 /* remove from SP index */
1798 if (__LIST_CHAINED(sp)) {
1799 LIST_REMOVE(sp, chain);
1800 ipsec_policy_count--;
1801 }
1802
1803 if (sp->spidx.internal_if) {
1804 ifnet_release(sp->spidx.internal_if);
1805 sp->spidx.internal_if = NULL;
1806 }
1807
1808 if (sp->ipsec_if) {
1809 ifnet_release(sp->ipsec_if);
1810 sp->ipsec_if = NULL;
1811 }
1812
1813 if (sp->outgoing_if) {
1814 ifnet_release(sp->outgoing_if);
1815 sp->outgoing_if = NULL;
1816 }
1817
1818 {
1819 struct ipsecrequest *isr = sp->req, *nextisr;
1820
1821 while (isr != NULL) {
1822 nextisr = isr->next;
1823 kfree_type(struct ipsecrequest, isr);
1824 isr = nextisr;
1825 }
1826 }
1827 keydb_delsecpolicy(sp);
1828
1829 return;
1830 }
1831
1832 /*
1833 * search SPD
1834 * OUT: NULL : not found
1835 * others : found, pointer to a SP.
1836 */
1837 static struct secpolicy *
key_getsp(struct secpolicyindex * spidx)1838 key_getsp(
1839 struct secpolicyindex *spidx)
1840 {
1841 struct secpolicy *sp;
1842
1843 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1844
1845 /* sanity check */
1846 if (spidx == NULL) {
1847 panic("key_getsp: NULL pointer is passed.");
1848 }
1849
1850 LIST_FOREACH(sp, &sptree[spidx->dir], chain) {
1851 if (sp->state == IPSEC_SPSTATE_DEAD) {
1852 continue;
1853 }
1854 if (key_cmpspidx_exactly(spidx, &sp->spidx)) {
1855 sp->refcnt++;
1856 return sp;
1857 }
1858 }
1859
1860 return NULL;
1861 }
1862
1863 /*
1864 * get SP by index.
1865 * OUT: NULL : not found
1866 * others : found, pointer to a SP.
1867 */
1868 struct secpolicy *
key_getspbyid(u_int32_t id)1869 key_getspbyid(
1870 u_int32_t id)
1871 {
1872 struct secpolicy *sp;
1873
1874 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
1875
1876 lck_mtx_lock(sadb_mutex);
1877 sp = __key_getspbyid(id);
1878 lck_mtx_unlock(sadb_mutex);
1879
1880 return sp;
1881 }
1882
1883 static struct secpolicy *
__key_getspbyid(u_int32_t id)1884 __key_getspbyid(u_int32_t id)
1885 {
1886 struct secpolicy *sp;
1887
1888 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
1889
1890 LIST_FOREACH(sp, &sptree[IPSEC_DIR_INBOUND], chain) {
1891 if (sp->state == IPSEC_SPSTATE_DEAD) {
1892 continue;
1893 }
1894 if (sp->id == id) {
1895 sp->refcnt++;
1896 return sp;
1897 }
1898 }
1899
1900 LIST_FOREACH(sp, &sptree[IPSEC_DIR_OUTBOUND], chain) {
1901 if (sp->state == IPSEC_SPSTATE_DEAD) {
1902 continue;
1903 }
1904 if (sp->id == id) {
1905 sp->refcnt++;
1906 return sp;
1907 }
1908 }
1909
1910 return NULL;
1911 }
1912
1913 struct secpolicy *
key_newsp(void)1914 key_newsp(void)
1915 {
1916 struct secpolicy *newsp = NULL;
1917
1918 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
1919 newsp = keydb_newsecpolicy();
1920 if (!newsp) {
1921 return newsp;
1922 }
1923
1924 newsp->refcnt = 1;
1925 newsp->req = NULL;
1926
1927 return newsp;
1928 }
1929
1930 /*
1931 * create secpolicy structure from sadb_x_policy structure.
1932 * NOTE: `state', `secpolicyindex' in secpolicy structure are not set,
1933 * so must be set properly later.
1934 */
1935 struct secpolicy *
key_msg2sp(struct sadb_x_policy * xpl0,size_t len,int * error)1936 key_msg2sp(
1937 struct sadb_x_policy *xpl0,
1938 size_t len,
1939 int *error)
1940 {
1941 struct secpolicy *newsp;
1942
1943 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
1944
1945 /* sanity check */
1946 if (xpl0 == NULL) {
1947 panic("key_msg2sp: NULL pointer was passed.");
1948 }
1949 if (len < sizeof(*xpl0)) {
1950 panic("key_msg2sp: invalid length.");
1951 }
1952 if (len != PFKEY_EXTLEN(xpl0)) {
1953 ipseclog((LOG_DEBUG, "key_msg2sp: Invalid msg length.\n"));
1954 *error = EINVAL;
1955 return NULL;
1956 }
1957
1958 if ((newsp = key_newsp()) == NULL) {
1959 *error = ENOBUFS;
1960 return NULL;
1961 }
1962
1963 newsp->spidx.dir = xpl0->sadb_x_policy_dir;
1964 newsp->policy = xpl0->sadb_x_policy_type;
1965
1966 /* check policy */
1967 switch (xpl0->sadb_x_policy_type) {
1968 case IPSEC_POLICY_DISCARD:
1969 case IPSEC_POLICY_GENERATE:
1970 case IPSEC_POLICY_NONE:
1971 case IPSEC_POLICY_ENTRUST:
1972 case IPSEC_POLICY_BYPASS:
1973 newsp->req = NULL;
1974 break;
1975
1976 case IPSEC_POLICY_IPSEC:
1977 {
1978 int tlen;
1979 struct sadb_x_ipsecrequest *xisr;
1980 struct ipsecrequest **p_isr = &newsp->req;
1981
1982 /* validity check */
1983 if (PFKEY_EXTLEN(xpl0) < sizeof(*xpl0)) {
1984 ipseclog((LOG_DEBUG,
1985 "key_msg2sp: Invalid msg length.\n"));
1986 key_freesp(newsp, KEY_SADB_UNLOCKED);
1987 *error = EINVAL;
1988 return NULL;
1989 }
1990
1991 tlen = PFKEY_EXTLEN(xpl0) - sizeof(*xpl0);
1992 xisr = (struct sadb_x_ipsecrequest *)(xpl0 + 1);
1993
1994 while (tlen > 0) {
1995 if (tlen < sizeof(*xisr)) {
1996 ipseclog((LOG_DEBUG, "key_msg2sp: "
1997 "invalid ipsecrequest.\n"));
1998 key_freesp(newsp, KEY_SADB_UNLOCKED);
1999 *error = EINVAL;
2000 return NULL;
2001 }
2002
2003 /* length check */
2004 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr)) {
2005 ipseclog((LOG_DEBUG, "key_msg2sp: "
2006 "invalid ipsecrequest length.\n"));
2007 key_freesp(newsp, KEY_SADB_UNLOCKED);
2008 *error = EINVAL;
2009 return NULL;
2010 }
2011
2012 /* allocate request buffer */
2013 *p_isr = kalloc_type(struct ipsecrequest,
2014 Z_WAITOK_ZERO_NOFAIL);
2015
2016 switch (xisr->sadb_x_ipsecrequest_proto) {
2017 case IPPROTO_ESP:
2018 case IPPROTO_AH:
2019 break;
2020 default:
2021 ipseclog((LOG_DEBUG,
2022 "key_msg2sp: invalid proto type=%u\n",
2023 xisr->sadb_x_ipsecrequest_proto));
2024 key_freesp(newsp, KEY_SADB_UNLOCKED);
2025 *error = EPROTONOSUPPORT;
2026 return NULL;
2027 }
2028 (*p_isr)->saidx.proto = xisr->sadb_x_ipsecrequest_proto;
2029
2030 switch (xisr->sadb_x_ipsecrequest_mode) {
2031 case IPSEC_MODE_TRANSPORT:
2032 case IPSEC_MODE_TUNNEL:
2033 break;
2034 case IPSEC_MODE_ANY:
2035 default:
2036 ipseclog((LOG_DEBUG,
2037 "key_msg2sp: invalid mode=%u\n",
2038 xisr->sadb_x_ipsecrequest_mode));
2039 key_freesp(newsp, KEY_SADB_UNLOCKED);
2040 *error = EINVAL;
2041 return NULL;
2042 }
2043 (*p_isr)->saidx.mode = xisr->sadb_x_ipsecrequest_mode;
2044
2045 switch (xisr->sadb_x_ipsecrequest_level) {
2046 case IPSEC_LEVEL_DEFAULT:
2047 case IPSEC_LEVEL_USE:
2048 case IPSEC_LEVEL_REQUIRE:
2049 break;
2050 case IPSEC_LEVEL_UNIQUE:
2051 /* validity check */
2052 /*
2053 * If range violation of reqid, kernel will
2054 * update it, don't refuse it.
2055 */
2056 if (xisr->sadb_x_ipsecrequest_reqid
2057 > IPSEC_MANUAL_REQID_MAX) {
2058 ipseclog((LOG_DEBUG,
2059 "key_msg2sp: reqid=%d range "
2060 "violation, updated by kernel.\n",
2061 xisr->sadb_x_ipsecrequest_reqid));
2062 xisr->sadb_x_ipsecrequest_reqid = 0;
2063 }
2064
2065 /* allocate new reqid id if reqid is zero. */
2066 if (xisr->sadb_x_ipsecrequest_reqid == 0) {
2067 u_int16_t reqid;
2068 if ((reqid = key_newreqid()) == 0) {
2069 key_freesp(newsp, KEY_SADB_UNLOCKED);
2070 *error = ENOBUFS;
2071 return NULL;
2072 }
2073 (*p_isr)->saidx.reqid = reqid;
2074 xisr->sadb_x_ipsecrequest_reqid = reqid;
2075 } else {
2076 /* set it for manual keying. */
2077 (*p_isr)->saidx.reqid =
2078 xisr->sadb_x_ipsecrequest_reqid;
2079 }
2080 break;
2081
2082 default:
2083 ipseclog((LOG_DEBUG, "key_msg2sp: invalid level=%u\n",
2084 xisr->sadb_x_ipsecrequest_level));
2085 key_freesp(newsp, KEY_SADB_UNLOCKED);
2086 *error = EINVAL;
2087 return NULL;
2088 }
2089 (*p_isr)->level = xisr->sadb_x_ipsecrequest_level;
2090
2091 /* set IP addresses if there */
2092 if (xisr->sadb_x_ipsecrequest_len > sizeof(*xisr)) {
2093 struct sockaddr *paddr;
2094
2095 if (tlen < xisr->sadb_x_ipsecrequest_len) {
2096 ipseclog((LOG_DEBUG, "key_msg2sp: invalid request "
2097 "address length.\n"));
2098 key_freesp(newsp, KEY_SADB_UNLOCKED);
2099 *error = EINVAL;
2100 return NULL;
2101 }
2102
2103 paddr = (struct sockaddr *)(xisr + 1);
2104 uint8_t src_len = paddr->sa_len;
2105
2106 /* +sizeof(uint8_t) for dst_len below */
2107 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) + src_len + sizeof(uint8_t)) {
2108 ipseclog((LOG_DEBUG, "key_msg2sp: invalid request "
2109 "invalid source address length.\n"));
2110 key_freesp(newsp, KEY_SADB_UNLOCKED);
2111 *error = EINVAL;
2112 return NULL;
2113 }
2114
2115 /* validity check */
2116 if (paddr->sa_len
2117 > sizeof((*p_isr)->saidx.src)) {
2118 ipseclog((LOG_DEBUG, "key_msg2sp: invalid request "
2119 "address length.\n"));
2120 key_freesp(newsp, KEY_SADB_UNLOCKED);
2121 *error = EINVAL;
2122 return NULL;
2123 }
2124
2125 bcopy(paddr, &(*p_isr)->saidx.src,
2126 MIN(paddr->sa_len, sizeof((*p_isr)->saidx.src)));
2127
2128 paddr = (struct sockaddr *)((caddr_t)paddr + paddr->sa_len);
2129 uint8_t dst_len = paddr->sa_len;
2130
2131 if (xisr->sadb_x_ipsecrequest_len < sizeof(*xisr) + src_len + dst_len) {
2132 ipseclog((LOG_DEBUG, "key_msg2sp: invalid request "
2133 "invalid dest address length.\n"));
2134 key_freesp(newsp, KEY_SADB_UNLOCKED);
2135 *error = EINVAL;
2136 return NULL;
2137 }
2138
2139 /* validity check */
2140 if (paddr->sa_len
2141 > sizeof((*p_isr)->saidx.dst)) {
2142 ipseclog((LOG_DEBUG, "key_msg2sp: invalid request "
2143 "address length.\n"));
2144 key_freesp(newsp, KEY_SADB_UNLOCKED);
2145 *error = EINVAL;
2146 return NULL;
2147 }
2148
2149 bcopy(paddr, &(*p_isr)->saidx.dst,
2150 MIN(paddr->sa_len, sizeof((*p_isr)->saidx.dst)));
2151 }
2152
2153 (*p_isr)->sp = newsp;
2154
2155 /* initialization for the next. */
2156 p_isr = &(*p_isr)->next;
2157 tlen -= xisr->sadb_x_ipsecrequest_len;
2158
2159 /* validity check */
2160 if (tlen < 0) {
2161 ipseclog((LOG_DEBUG, "key_msg2sp: becoming tlen < 0.\n"));
2162 key_freesp(newsp, KEY_SADB_UNLOCKED);
2163 *error = EINVAL;
2164 return NULL;
2165 }
2166
2167 xisr = (struct sadb_x_ipsecrequest *)(void *)
2168 ((caddr_t)xisr + xisr->sadb_x_ipsecrequest_len);
2169 }
2170 }
2171 break;
2172 default:
2173 ipseclog((LOG_DEBUG, "key_msg2sp: invalid policy type.\n"));
2174 key_freesp(newsp, KEY_SADB_UNLOCKED);
2175 *error = EINVAL;
2176 return NULL;
2177 }
2178
2179 *error = 0;
2180 return newsp;
2181 }
2182
2183 static u_int16_t
key_newreqid(void)2184 key_newreqid(void)
2185 {
2186 lck_mtx_lock(sadb_mutex);
2187 static u_int16_t auto_reqid = IPSEC_MANUAL_REQID_MAX + 1;
2188 int done = 0;
2189
2190 /* The reqid must be limited to 16 bits because the PF_KEY message format only uses
2191 * 16 bits for this field. Once it becomes larger than 16 bits - ipsec fails to
2192 * work anymore. Changing the PF_KEY message format would introduce compatibility
2193 * issues. This code now tests to see if the tentative reqid is in use */
2194
2195 while (!done) {
2196 struct secpolicy *sp;
2197 struct ipsecrequest *isr;
2198 int dir;
2199
2200 auto_reqid = (auto_reqid == 0xFFFF
2201 ? IPSEC_MANUAL_REQID_MAX + 1 : auto_reqid + 1);
2202
2203 /* check for uniqueness */
2204 done = 1;
2205 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
2206 LIST_FOREACH(sp, &sptree[dir], chain) {
2207 for (isr = sp->req; isr != NULL; isr = isr->next) {
2208 if (isr->saidx.reqid == auto_reqid) {
2209 done = 0;
2210 break;
2211 }
2212 }
2213 if (done == 0) {
2214 break;
2215 }
2216 }
2217 if (done == 0) {
2218 break;
2219 }
2220 }
2221 }
2222
2223 lck_mtx_unlock(sadb_mutex);
2224 return auto_reqid;
2225 }
2226
2227 /*
2228 * copy secpolicy struct to sadb_x_policy structure indicated.
2229 */
2230 struct mbuf *
key_sp2msg(struct secpolicy * sp)2231 key_sp2msg(
2232 struct secpolicy *sp)
2233 {
2234 struct sadb_x_policy *xpl;
2235 u_int tlen;
2236 caddr_t p;
2237 struct mbuf *m;
2238
2239 /* sanity check. */
2240 if (sp == NULL) {
2241 panic("key_sp2msg: NULL pointer was passed.");
2242 }
2243
2244 tlen = key_getspreqmsglen(sp);
2245 if (PFKEY_UNIT64(tlen) > UINT16_MAX) {
2246 ipseclog((LOG_ERR, "key_getspreqmsglen returned length %u\n",
2247 tlen));
2248 return NULL;
2249 }
2250
2251 m = key_alloc_mbuf(tlen);
2252 if (!m || m->m_next) { /*XXX*/
2253 if (m) {
2254 m_freem(m);
2255 }
2256 return NULL;
2257 }
2258
2259 m->m_len = tlen;
2260 m->m_next = NULL;
2261 xpl = mtod(m, struct sadb_x_policy *);
2262 bzero(xpl, tlen);
2263
2264 xpl->sadb_x_policy_len = (u_int16_t)PFKEY_UNIT64(tlen);
2265 xpl->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
2266 xpl->sadb_x_policy_type = (u_int16_t)sp->policy;
2267 xpl->sadb_x_policy_dir = sp->spidx.dir;
2268 xpl->sadb_x_policy_id = sp->id;
2269 p = (caddr_t)xpl + sizeof(*xpl);
2270
2271 /* if is the policy for ipsec ? */
2272 if (sp->policy == IPSEC_POLICY_IPSEC) {
2273 struct sadb_x_ipsecrequest *xisr;
2274 struct ipsecrequest *isr;
2275
2276 for (isr = sp->req; isr != NULL; isr = isr->next) {
2277 xisr = (struct sadb_x_ipsecrequest *)(void *)p;
2278
2279 xisr->sadb_x_ipsecrequest_proto = isr->saidx.proto;
2280 xisr->sadb_x_ipsecrequest_mode = isr->saidx.mode;
2281 xisr->sadb_x_ipsecrequest_level = (u_int8_t)isr->level;
2282 xisr->sadb_x_ipsecrequest_reqid = (u_int16_t)isr->saidx.reqid;
2283
2284 p += sizeof(*xisr);
2285 bcopy(&isr->saidx.src, p, isr->saidx.src.ss_len);
2286 p += isr->saidx.src.ss_len;
2287 bcopy(&isr->saidx.dst, p, isr->saidx.dst.ss_len);
2288 p += isr->saidx.src.ss_len;
2289
2290 xisr->sadb_x_ipsecrequest_len =
2291 PFKEY_ALIGN8(sizeof(*xisr)
2292 + isr->saidx.src.ss_len
2293 + isr->saidx.dst.ss_len);
2294 }
2295 }
2296
2297 return m;
2298 }
2299
2300 /* m will not be freed nor modified */
2301 static struct mbuf *
key_gather_mbuf(struct mbuf * m,const struct sadb_msghdr * mhp,int ndeep,int nitem,int * items)2302 key_gather_mbuf(struct mbuf *m, const struct sadb_msghdr *mhp,
2303 int ndeep, int nitem, int *items)
2304 {
2305 int idx;
2306 int i;
2307 struct mbuf *result = NULL, *n;
2308 int len;
2309
2310 if (m == NULL || mhp == NULL) {
2311 panic("null pointer passed to key_gather");
2312 }
2313
2314 for (i = 0; i < nitem; i++) {
2315 idx = items[i];
2316 if (idx < 0 || idx > SADB_EXT_MAX) {
2317 goto fail;
2318 }
2319 /* don't attempt to pull empty extension */
2320 if (idx == SADB_EXT_RESERVED && mhp->msg == NULL) {
2321 continue;
2322 }
2323 if (idx != SADB_EXT_RESERVED &&
2324 (mhp->ext[idx] == NULL || mhp->extlen[idx] == 0)) {
2325 continue;
2326 }
2327
2328 if (idx == SADB_EXT_RESERVED) {
2329 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
2330 MGETHDR(n, M_WAITOK, MT_DATA); // sadb_msg len < MHLEN - enforced by _CASSERT
2331 if (!n) {
2332 goto fail;
2333 }
2334 n->m_len = len;
2335 n->m_next = NULL;
2336 m_copydata(m, 0, sizeof(struct sadb_msg),
2337 mtod(n, caddr_t));
2338 } else if (i < ndeep) {
2339 len = mhp->extlen[idx];
2340 n = key_alloc_mbuf(len);
2341 if (!n || n->m_next) { /*XXX*/
2342 if (n) {
2343 m_freem(n);
2344 }
2345 goto fail;
2346 }
2347 m_copydata(m, mhp->extoff[idx], mhp->extlen[idx],
2348 mtod(n, caddr_t));
2349 } else {
2350 n = m_copym(m, mhp->extoff[idx], mhp->extlen[idx],
2351 M_WAITOK);
2352 }
2353 if (n == NULL) {
2354 goto fail;
2355 }
2356
2357 if (result) {
2358 m_cat(result, n);
2359 } else {
2360 result = n;
2361 }
2362 }
2363
2364 if ((result->m_flags & M_PKTHDR) != 0) {
2365 result->m_pkthdr.len = 0;
2366 for (n = result; n; n = n->m_next) {
2367 result->m_pkthdr.len += n->m_len;
2368 }
2369 }
2370
2371 return result;
2372
2373 fail:
2374 m_freem(result);
2375 return NULL;
2376 }
2377
2378 /*
2379 * SADB_X_SPDADD, SADB_X_SPDSETIDX or SADB_X_SPDUPDATE processing
2380 * add a entry to SP database, when received
2381 * <base, address(SD), (lifetime(H),) policy>
2382 * from the user(?).
2383 * Adding to SP database,
2384 * and send
2385 * <base, address(SD), (lifetime(H),) policy>
2386 * to the socket which was send.
2387 *
2388 * SPDADD set a unique policy entry.
2389 * SPDSETIDX like SPDADD without a part of policy requests.
2390 * SPDUPDATE replace a unique policy entry.
2391 *
2392 * m will always be freed.
2393 */
2394 static int
key_spdadd(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)2395 key_spdadd(
2396 struct socket *so,
2397 struct mbuf *m,
2398 const struct sadb_msghdr *mhp)
2399 {
2400 struct sadb_address *src0, *dst0, *src1 = NULL, *dst1 = NULL;
2401 struct sadb_x_policy *xpl0, *xpl;
2402 struct sadb_lifetime *lft = NULL;
2403 struct secpolicyindex spidx;
2404 struct secpolicy *newsp;
2405 struct timeval tv;
2406 ifnet_t internal_if = NULL;
2407 char *outgoing_if = NULL;
2408 char *ipsec_if = NULL;
2409 struct sadb_x_ipsecif *ipsecifopts = NULL;
2410 int error;
2411 int use_src_range = 0;
2412 int use_dst_range = 0;
2413 int init_disabled = 0;
2414 int address_family, address_len;
2415
2416 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
2417
2418 /* sanity check */
2419 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
2420 panic("key_spdadd: NULL pointer is passed.");
2421 }
2422
2423 if (mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_START] != NULL && mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_END] != NULL) {
2424 use_src_range = 1;
2425 }
2426 if (mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_START] != NULL && mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_END] != NULL) {
2427 use_dst_range = 1;
2428 }
2429
2430 if ((!use_src_range && mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL) ||
2431 (!use_dst_range && mhp->ext[SADB_EXT_ADDRESS_DST] == NULL) ||
2432 mhp->ext[SADB_X_EXT_POLICY] == NULL) {
2433 ipseclog((LOG_DEBUG, "key_spdadd: invalid message is passed.\n"));
2434 return key_senderror(so, m, EINVAL);
2435 }
2436 if ((use_src_range && (mhp->extlen[SADB_X_EXT_ADDR_RANGE_SRC_START] < sizeof(struct sadb_address)
2437 || mhp->extlen[SADB_X_EXT_ADDR_RANGE_SRC_END] < sizeof(struct sadb_address))) ||
2438 (!use_src_range && mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address)) ||
2439 (use_dst_range && (mhp->extlen[SADB_X_EXT_ADDR_RANGE_DST_START] < sizeof(struct sadb_address)
2440 || mhp->extlen[SADB_X_EXT_ADDR_RANGE_DST_END] < sizeof(struct sadb_address))) ||
2441 (!use_dst_range && mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) ||
2442 mhp->extlen[SADB_X_EXT_POLICY] < sizeof(struct sadb_x_policy)) {
2443 ipseclog((LOG_DEBUG, "key_spdadd: invalid message is passed.\n"));
2444 return key_senderror(so, m, EINVAL);
2445 }
2446 if (mhp->ext[SADB_EXT_LIFETIME_HARD] != NULL) {
2447 if (mhp->extlen[SADB_EXT_LIFETIME_HARD]
2448 < sizeof(struct sadb_lifetime)) {
2449 ipseclog((LOG_DEBUG, "key_spdadd: invalid message is passed.\n"));
2450 return key_senderror(so, m, EINVAL);
2451 }
2452 lft = (struct sadb_lifetime *)
2453 (void *)mhp->ext[SADB_EXT_LIFETIME_HARD];
2454 }
2455 if (mhp->ext[SADB_X_EXT_IPSECIF] != NULL) {
2456 if (mhp->extlen[SADB_X_EXT_IPSECIF] < sizeof(struct sadb_x_ipsecif)) {
2457 ipseclog((LOG_DEBUG, "key_spdadd: invalid message is passed.\n"));
2458 return key_senderror(so, m, EINVAL);
2459 }
2460 }
2461
2462 if (use_src_range) {
2463 src0 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_START];
2464 src1 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_END];
2465 } else {
2466 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2467 }
2468 if (use_dst_range) {
2469 dst0 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_START];
2470 dst1 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_END];
2471 } else {
2472 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2473 }
2474 xpl0 = (struct sadb_x_policy *)(void *)mhp->ext[SADB_X_EXT_POLICY];
2475 ipsecifopts = (struct sadb_x_ipsecif *)(void *)mhp->ext[SADB_X_EXT_IPSECIF];
2476
2477 /* check addresses */
2478 address_family = ((struct sockaddr *)(src0 + 1))->sa_family;
2479 address_len = ((struct sockaddr *)(src0 + 1))->sa_len;
2480 if (use_src_range) {
2481 if (((struct sockaddr *)(src1 + 1))->sa_family != address_family ||
2482 ((struct sockaddr *)(src1 + 1))->sa_len != address_len) {
2483 return key_senderror(so, m, EINVAL);
2484 }
2485 }
2486 if (((struct sockaddr *)(dst0 + 1))->sa_family != address_family ||
2487 ((struct sockaddr *)(dst0 + 1))->sa_len != address_len) {
2488 return key_senderror(so, m, EINVAL);
2489 }
2490 if (use_dst_range) {
2491 if (((struct sockaddr *)(dst1 + 1))->sa_family != address_family ||
2492 ((struct sockaddr *)(dst1 + 1))->sa_len != address_len) {
2493 return key_senderror(so, m, EINVAL);
2494 }
2495 }
2496
2497 /* checking the direction. */
2498 switch (xpl0->sadb_x_policy_dir) {
2499 case IPSEC_DIR_INBOUND:
2500 case IPSEC_DIR_OUTBOUND:
2501 break;
2502 default:
2503 ipseclog((LOG_DEBUG, "key_spdadd: Invalid SP direction.\n"));
2504 return key_senderror(so, m, EINVAL);
2505 }
2506
2507 /* check policy */
2508 /* key_spdadd() accepts DISCARD, NONE and IPSEC. */
2509 if (xpl0->sadb_x_policy_type == IPSEC_POLICY_ENTRUST
2510 || xpl0->sadb_x_policy_type == IPSEC_POLICY_BYPASS) {
2511 ipseclog((LOG_DEBUG, "key_spdadd: Invalid policy type.\n"));
2512 return key_senderror(so, m, EINVAL);
2513 }
2514
2515 /* policy requests are mandatory when action is ipsec. */
2516 if (mhp->msg->sadb_msg_type != SADB_X_SPDSETIDX
2517 && xpl0->sadb_x_policy_type == IPSEC_POLICY_IPSEC
2518 && mhp->extlen[SADB_X_EXT_POLICY] <= sizeof(*xpl0)) {
2519 ipseclog((LOG_DEBUG, "key_spdadd: some policy requests part required.\n"));
2520 return key_senderror(so, m, EINVAL);
2521 }
2522
2523 /* Process interfaces */
2524 if (ipsecifopts != NULL) {
2525 ipsecifopts->sadb_x_ipsecif_internal_if[IFXNAMSIZ - 1] = '\0';
2526 ipsecifopts->sadb_x_ipsecif_outgoing_if[IFXNAMSIZ - 1] = '\0';
2527 ipsecifopts->sadb_x_ipsecif_ipsec_if[IFXNAMSIZ - 1] = '\0';
2528
2529 if (ipsecifopts->sadb_x_ipsecif_internal_if[0]) {
2530 ifnet_find_by_name(ipsecifopts->sadb_x_ipsecif_internal_if, &internal_if);
2531 }
2532 if (ipsecifopts->sadb_x_ipsecif_outgoing_if[0]) {
2533 outgoing_if = ipsecifopts->sadb_x_ipsecif_outgoing_if;
2534 }
2535 if (ipsecifopts->sadb_x_ipsecif_ipsec_if[0]) {
2536 ipsec_if = ipsecifopts->sadb_x_ipsecif_ipsec_if;
2537 }
2538 init_disabled = ipsecifopts->sadb_x_ipsecif_init_disabled;
2539 }
2540
2541 /* make secindex */
2542 /* XXX boundary check against sa_len */
2543 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2544 src0 + 1,
2545 dst0 + 1,
2546 src0->sadb_address_prefixlen,
2547 dst0->sadb_address_prefixlen,
2548 src0->sadb_address_proto,
2549 internal_if,
2550 use_src_range ? src0 + 1 : NULL,
2551 use_src_range ? src1 + 1 : NULL,
2552 use_dst_range ? dst0 + 1 : NULL,
2553 use_dst_range ? dst1 + 1 : NULL,
2554 &spidx);
2555
2556 /*
2557 * checking there is SP already or not.
2558 * SPDUPDATE doesn't depend on whether there is a SP or not.
2559 * If the type is either SPDADD or SPDSETIDX AND a SP is found,
2560 * then error.
2561 */
2562 lck_mtx_lock(sadb_mutex);
2563 newsp = key_getsp(&spidx);
2564 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2565 if (newsp) {
2566 newsp->state = IPSEC_SPSTATE_DEAD;
2567 key_freesp(newsp, KEY_SADB_LOCKED);
2568 }
2569 } else {
2570 if (newsp != NULL) {
2571 key_freesp(newsp, KEY_SADB_LOCKED);
2572 ipseclog((LOG_DEBUG, "key_spdadd: a SP entry exists already.\n"));
2573 lck_mtx_unlock(sadb_mutex);
2574 if (internal_if) {
2575 ifnet_release(internal_if);
2576 internal_if = NULL;
2577 }
2578 return key_senderror(so, m, EEXIST);
2579 }
2580 }
2581 lck_mtx_unlock(sadb_mutex);
2582
2583 /* allocation new SP entry */
2584 if ((newsp = key_msg2sp(xpl0, PFKEY_EXTLEN(xpl0), &error)) == NULL) {
2585 if (internal_if) {
2586 ifnet_release(internal_if);
2587 internal_if = NULL;
2588 }
2589 return key_senderror(so, m, error);
2590 }
2591
2592 if ((newsp->id = key_getnewspid()) == 0) {
2593 keydb_delsecpolicy(newsp);
2594 if (internal_if) {
2595 ifnet_release(internal_if);
2596 internal_if = NULL;
2597 }
2598 return key_senderror(so, m, ENOBUFS);
2599 }
2600
2601 /* XXX boundary check against sa_len */
2602 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2603 src0 + 1,
2604 dst0 + 1,
2605 src0->sadb_address_prefixlen,
2606 dst0->sadb_address_prefixlen,
2607 src0->sadb_address_proto,
2608 internal_if,
2609 use_src_range ? src0 + 1 : NULL,
2610 use_src_range ? src1 + 1 : NULL,
2611 use_dst_range ? dst0 + 1 : NULL,
2612 use_dst_range ? dst1 + 1 : NULL,
2613 &newsp->spidx);
2614
2615 #if 1
2616 /*
2617 * allow IPv6 over IPv4 or IPv4 over IPv6 tunnels using ESP -
2618 * otherwise reject if inner and outer address families not equal
2619 */
2620 if (newsp->req && newsp->req->saidx.src.ss_family) {
2621 struct sockaddr *sa;
2622 sa = (struct sockaddr *)(src0 + 1);
2623 if (sa->sa_family != newsp->req->saidx.src.ss_family) {
2624 if (newsp->req->saidx.mode != IPSEC_MODE_TUNNEL || newsp->req->saidx.proto != IPPROTO_ESP) {
2625 keydb_delsecpolicy(newsp);
2626 if (internal_if) {
2627 ifnet_release(internal_if);
2628 internal_if = NULL;
2629 }
2630 return key_senderror(so, m, EINVAL);
2631 }
2632 }
2633 }
2634 if (newsp->req && newsp->req->saidx.dst.ss_family) {
2635 struct sockaddr *sa;
2636 sa = (struct sockaddr *)(dst0 + 1);
2637 if (sa->sa_family != newsp->req->saidx.dst.ss_family) {
2638 if (newsp->req->saidx.mode != IPSEC_MODE_TUNNEL || newsp->req->saidx.proto != IPPROTO_ESP) {
2639 keydb_delsecpolicy(newsp);
2640 if (internal_if) {
2641 ifnet_release(internal_if);
2642 internal_if = NULL;
2643 }
2644 return key_senderror(so, m, EINVAL);
2645 }
2646 }
2647 }
2648 #endif
2649
2650 microtime(&tv);
2651 newsp->created = tv.tv_sec;
2652 newsp->lastused = tv.tv_sec;
2653 newsp->lifetime = (long)(lft ? lft->sadb_lifetime_addtime : 0);
2654 newsp->validtime = (long)(lft ? lft->sadb_lifetime_usetime : 0);
2655
2656 if (outgoing_if != NULL) {
2657 ifnet_find_by_name(outgoing_if, &newsp->outgoing_if);
2658 }
2659 if (ipsec_if != NULL) {
2660 ifnet_find_by_name(ipsec_if, &newsp->ipsec_if);
2661 }
2662 if (init_disabled > 0) {
2663 newsp->disabled = 1;
2664 }
2665
2666 newsp->refcnt = 1; /* do not reclaim until I say I do */
2667 newsp->state = IPSEC_SPSTATE_ALIVE;
2668 lck_mtx_lock(sadb_mutex);
2669 /*
2670 * policies of type generate should be at the end of the SPD
2671 * because they function as default discard policies
2672 * Don't start timehandler for generate policies
2673 */
2674 if (newsp->policy == IPSEC_POLICY_GENERATE) {
2675 LIST_INSERT_TAIL(&sptree[newsp->spidx.dir], newsp, secpolicy, chain);
2676 } else { /* XXX until we have policy ordering in the kernel */
2677 struct secpolicy *tmpsp;
2678
2679 LIST_FOREACH(tmpsp, &sptree[newsp->spidx.dir], chain)
2680 if (tmpsp->policy == IPSEC_POLICY_GENERATE) {
2681 break;
2682 }
2683 if (tmpsp) {
2684 LIST_INSERT_BEFORE(tmpsp, newsp, chain);
2685 } else {
2686 LIST_INSERT_TAIL(&sptree[newsp->spidx.dir], newsp, secpolicy, chain);
2687 }
2688 key_start_timehandler();
2689 }
2690
2691 ipsec_policy_count++;
2692 /* Turn off the ipsec bypass */
2693 if (ipsec_bypass != 0) {
2694 ipsec_bypass = 0;
2695 }
2696
2697 /* delete the entry in spacqtree */
2698 if (mhp->msg->sadb_msg_type == SADB_X_SPDUPDATE) {
2699 struct secspacq *spacq;
2700 if ((spacq = key_getspacq(&spidx)) != NULL) {
2701 /* reset counter in order to deletion by timehandler. */
2702 microtime(&tv);
2703 spacq->created = tv.tv_sec;
2704 spacq->count = 0;
2705 }
2706 }
2707 lck_mtx_unlock(sadb_mutex);
2708
2709 {
2710 struct mbuf *n, *mpolicy;
2711 struct sadb_msg *newmsg;
2712 int off;
2713
2714 /* create new sadb_msg to reply. */
2715 if (lft) {
2716 int mbufItems[] = {SADB_EXT_RESERVED, SADB_X_EXT_POLICY,
2717 SADB_EXT_LIFETIME_HARD, SADB_EXT_ADDRESS_SRC,
2718 SADB_EXT_ADDRESS_DST, SADB_X_EXT_ADDR_RANGE_SRC_START, SADB_X_EXT_ADDR_RANGE_SRC_END,
2719 SADB_X_EXT_ADDR_RANGE_DST_START, SADB_X_EXT_ADDR_RANGE_DST_END};
2720 n = key_gather_mbuf(m, mhp, 2, sizeof(mbufItems) / sizeof(int), mbufItems);
2721 } else {
2722 int mbufItems[] = {SADB_EXT_RESERVED, SADB_X_EXT_POLICY,
2723 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
2724 SADB_X_EXT_ADDR_RANGE_SRC_START, SADB_X_EXT_ADDR_RANGE_SRC_END,
2725 SADB_X_EXT_ADDR_RANGE_DST_START, SADB_X_EXT_ADDR_RANGE_DST_END};
2726 n = key_gather_mbuf(m, mhp, 2, sizeof(mbufItems) / sizeof(int), mbufItems);
2727 }
2728 if (!n) {
2729 return key_senderror(so, m, ENOBUFS);
2730 }
2731
2732 if (n->m_len < sizeof(*newmsg)) {
2733 n = m_pullup(n, sizeof(*newmsg));
2734 if (!n) {
2735 return key_senderror(so, m, ENOBUFS);
2736 }
2737 }
2738 newmsg = mtod(n, struct sadb_msg *);
2739 newmsg->sadb_msg_errno = 0;
2740
2741 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
2742 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
2743
2744 off = 0;
2745 mpolicy = m_pulldown(n, PFKEY_ALIGN8(sizeof(struct sadb_msg)),
2746 sizeof(*xpl), &off);
2747 if (mpolicy == NULL) {
2748 /* n is already freed */
2749 return key_senderror(so, m, ENOBUFS);
2750 }
2751 xpl = (struct sadb_x_policy *)(void *)(mtod(mpolicy, caddr_t) + off);
2752 if (xpl->sadb_x_policy_exttype != SADB_X_EXT_POLICY) {
2753 m_freem(n);
2754 return key_senderror(so, m, EINVAL);
2755 }
2756 xpl->sadb_x_policy_id = newsp->id;
2757
2758 m_freem(m);
2759 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2760 }
2761 }
2762
2763 /*
2764 * get new policy id.
2765 * OUT:
2766 * 0: failure.
2767 * others: success.
2768 */
2769 static u_int32_t
key_getnewspid(void)2770 key_getnewspid(void)
2771 {
2772 u_int32_t newid = 0;
2773 int count = key_spi_trycnt; /* XXX */
2774 struct secpolicy *sp;
2775
2776 /* when requesting to allocate spi ranged */
2777 lck_mtx_lock(sadb_mutex);
2778 while (count--) {
2779 newid = (policy_id = (policy_id == ~0 ? 1 : policy_id + 1));
2780
2781 if ((sp = __key_getspbyid(newid)) == NULL) {
2782 break;
2783 }
2784
2785 key_freesp(sp, KEY_SADB_LOCKED);
2786 }
2787 lck_mtx_unlock(sadb_mutex);
2788 if (count == 0 || newid == 0) {
2789 ipseclog((LOG_DEBUG, "key_getnewspid: to allocate policy id is failed.\n"));
2790 return 0;
2791 }
2792
2793 return newid;
2794 }
2795
2796 /*
2797 * SADB_SPDDELETE processing
2798 * receive
2799 * <base, address(SD), policy(*)>
2800 * from the user(?), and set SADB_SASTATE_DEAD,
2801 * and send,
2802 * <base, address(SD), policy(*)>
2803 * to the ikmpd.
2804 * policy(*) including direction of policy.
2805 *
2806 * m will always be freed.
2807 */
2808 static int
key_spddelete(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)2809 key_spddelete(
2810 struct socket *so,
2811 struct mbuf *m,
2812 const struct sadb_msghdr *mhp)
2813 {
2814 struct sadb_address *src0, *dst0, *src1 = NULL, *dst1 = NULL;
2815 struct sadb_x_policy *xpl0;
2816 struct secpolicyindex spidx;
2817 struct secpolicy *sp;
2818 ifnet_t internal_if = NULL;
2819 struct sadb_x_ipsecif *ipsecifopts = NULL;
2820 int use_src_range = 0;
2821 int use_dst_range = 0;
2822
2823 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
2824
2825 /* sanity check */
2826 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
2827 panic("key_spddelete: NULL pointer is passed.");
2828 }
2829
2830 if (mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_START] != NULL && mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_END] != NULL) {
2831 use_src_range = 1;
2832 }
2833 if (mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_START] != NULL && mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_END] != NULL) {
2834 use_dst_range = 1;
2835 }
2836
2837 if ((!use_src_range && mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL) ||
2838 (!use_dst_range && mhp->ext[SADB_EXT_ADDRESS_DST] == NULL) ||
2839 mhp->ext[SADB_X_EXT_POLICY] == NULL) {
2840 ipseclog((LOG_DEBUG, "key_spddelete: invalid message is passed.\n"));
2841 return key_senderror(so, m, EINVAL);
2842 }
2843 if ((use_src_range && (mhp->extlen[SADB_X_EXT_ADDR_RANGE_SRC_START] < sizeof(struct sadb_address)
2844 || mhp->extlen[SADB_X_EXT_ADDR_RANGE_SRC_END] < sizeof(struct sadb_address))) ||
2845 (!use_src_range && mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address)) ||
2846 (use_dst_range && (mhp->extlen[SADB_X_EXT_ADDR_RANGE_DST_START] < sizeof(struct sadb_address)
2847 || mhp->extlen[SADB_X_EXT_ADDR_RANGE_DST_END] < sizeof(struct sadb_address))) ||
2848 (!use_dst_range && mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) ||
2849 mhp->extlen[SADB_X_EXT_POLICY] < sizeof(struct sadb_x_policy)) {
2850 ipseclog((LOG_DEBUG, "key_spddelete: invalid message is passed.\n"));
2851 return key_senderror(so, m, EINVAL);
2852 }
2853
2854 if (use_src_range) {
2855 src0 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_START];
2856 src1 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_SRC_END];
2857 } else {
2858 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
2859 }
2860 if (use_dst_range) {
2861 dst0 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_START];
2862 dst1 = (struct sadb_address *)mhp->ext[SADB_X_EXT_ADDR_RANGE_DST_END];
2863 } else {
2864 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
2865 }
2866 xpl0 = (struct sadb_x_policy *)(void *)mhp->ext[SADB_X_EXT_POLICY];
2867 ipsecifopts = (struct sadb_x_ipsecif *)(void *)mhp->ext[SADB_X_EXT_IPSECIF];
2868
2869 /* checking the direction. */
2870 switch (xpl0->sadb_x_policy_dir) {
2871 case IPSEC_DIR_INBOUND:
2872 case IPSEC_DIR_OUTBOUND:
2873 break;
2874 default:
2875 ipseclog((LOG_DEBUG, "key_spddelete: Invalid SP direction.\n"));
2876 return key_senderror(so, m, EINVAL);
2877 }
2878
2879 /* Process interfaces */
2880 if (ipsecifopts != NULL) {
2881 ipsecifopts->sadb_x_ipsecif_internal_if[IFXNAMSIZ - 1] = '\0';
2882 ipsecifopts->sadb_x_ipsecif_outgoing_if[IFXNAMSIZ - 1] = '\0';
2883 ipsecifopts->sadb_x_ipsecif_ipsec_if[IFXNAMSIZ - 1] = '\0';
2884
2885 if (ipsecifopts->sadb_x_ipsecif_internal_if[0]) {
2886 ifnet_find_by_name(ipsecifopts->sadb_x_ipsecif_internal_if, &internal_if);
2887 }
2888 }
2889
2890 /* make secindex */
2891 /* XXX boundary check against sa_len */
2892 KEY_SETSECSPIDX(xpl0->sadb_x_policy_dir,
2893 src0 + 1,
2894 dst0 + 1,
2895 src0->sadb_address_prefixlen,
2896 dst0->sadb_address_prefixlen,
2897 src0->sadb_address_proto,
2898 internal_if,
2899 use_src_range ? src0 + 1 : NULL,
2900 use_src_range ? src1 + 1 : NULL,
2901 use_dst_range ? dst0 + 1 : NULL,
2902 use_dst_range ? dst1 + 1 : NULL,
2903 &spidx);
2904
2905 /* Is there SP in SPD ? */
2906 lck_mtx_lock(sadb_mutex);
2907 if ((sp = key_getsp(&spidx)) == NULL) {
2908 ipseclog((LOG_DEBUG, "key_spddelete: no SP found.\n"));
2909 lck_mtx_unlock(sadb_mutex);
2910 if (internal_if) {
2911 ifnet_release(internal_if);
2912 internal_if = NULL;
2913 }
2914 return key_senderror(so, m, EINVAL);
2915 }
2916
2917 if (internal_if) {
2918 ifnet_release(internal_if);
2919 internal_if = NULL;
2920 }
2921
2922 /* save policy id to buffer to be returned. */
2923 xpl0->sadb_x_policy_id = sp->id;
2924
2925 sp->state = IPSEC_SPSTATE_DEAD;
2926 key_freesp(sp, KEY_SADB_LOCKED);
2927 lck_mtx_unlock(sadb_mutex);
2928
2929
2930 {
2931 struct mbuf *n;
2932 struct sadb_msg *newmsg;
2933 int mbufItems[] = {SADB_EXT_RESERVED, SADB_X_EXT_POLICY,
2934 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST,
2935 SADB_X_EXT_ADDR_RANGE_SRC_START, SADB_X_EXT_ADDR_RANGE_SRC_END,
2936 SADB_X_EXT_ADDR_RANGE_DST_START, SADB_X_EXT_ADDR_RANGE_DST_END};
2937
2938 /* create new sadb_msg to reply. */
2939 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
2940 if (!n) {
2941 return key_senderror(so, m, ENOBUFS);
2942 }
2943
2944 newmsg = mtod(n, struct sadb_msg *);
2945 newmsg->sadb_msg_errno = 0;
2946 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
2947 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
2948
2949 m_freem(m);
2950 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
2951 }
2952 }
2953
2954 /*
2955 * SADB_SPDDELETE2 processing
2956 * receive
2957 * <base, policy(*)>
2958 * from the user(?), and set SADB_SASTATE_DEAD,
2959 * and send,
2960 * <base, policy(*)>
2961 * to the ikmpd.
2962 * policy(*) including direction of policy.
2963 *
2964 * m will always be freed.
2965 */
2966 static int
key_spddelete2(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)2967 key_spddelete2(
2968 struct socket *so,
2969 struct mbuf *m,
2970 const struct sadb_msghdr *mhp)
2971 {
2972 u_int32_t id;
2973 struct secpolicy *sp;
2974
2975 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
2976
2977 /* sanity check */
2978 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
2979 panic("key_spddelete2: NULL pointer is passed.");
2980 }
2981
2982 if (mhp->ext[SADB_X_EXT_POLICY] == NULL ||
2983 mhp->extlen[SADB_X_EXT_POLICY] < sizeof(struct sadb_x_policy)) {
2984 ipseclog((LOG_DEBUG, "key_spddelete2: invalid message is passed.\n"));
2985 key_senderror(so, m, EINVAL);
2986 return 0;
2987 }
2988
2989 id = ((struct sadb_x_policy *)
2990 (void *)mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
2991
2992 /* Is there SP in SPD ? */
2993 lck_mtx_lock(sadb_mutex);
2994 if ((sp = __key_getspbyid(id)) == NULL) {
2995 lck_mtx_unlock(sadb_mutex);
2996 ipseclog((LOG_DEBUG, "key_spddelete2: no SP found id:%u.\n", id));
2997 return key_senderror(so, m, EINVAL);
2998 }
2999
3000 sp->state = IPSEC_SPSTATE_DEAD;
3001 key_freesp(sp, KEY_SADB_LOCKED);
3002 lck_mtx_unlock(sadb_mutex);
3003
3004 {
3005 struct mbuf *n, *nn;
3006 struct sadb_msg *newmsg;
3007 int off, len;
3008
3009 /* create new sadb_msg to reply. */
3010 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3011
3012 if (len > MCLBYTES) {
3013 return key_senderror(so, m, ENOBUFS);
3014 }
3015 MGETHDR(n, M_WAITOK, MT_DATA);
3016 if (n && len > MHLEN) {
3017 MCLGET(n, M_WAITOK);
3018 if ((n->m_flags & M_EXT) == 0) {
3019 m_freem(n);
3020 n = NULL;
3021 }
3022 }
3023 if (!n) {
3024 return key_senderror(so, m, ENOBUFS);
3025 }
3026
3027 n->m_len = len;
3028 n->m_next = NULL;
3029 off = 0;
3030
3031 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
3032 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
3033
3034 #if DIAGNOSTIC
3035 if (off != len) {
3036 panic("length inconsistency in key_spddelete2");
3037 }
3038 #endif
3039
3040 n->m_next = m_copym(m, mhp->extoff[SADB_X_EXT_POLICY],
3041 mhp->extlen[SADB_X_EXT_POLICY], M_WAITOK);
3042 if (!n->m_next) {
3043 m_freem(n);
3044 return key_senderror(so, m, ENOBUFS);
3045 }
3046
3047 n->m_pkthdr.len = 0;
3048 for (nn = n; nn; nn = nn->m_next) {
3049 n->m_pkthdr.len += nn->m_len;
3050 }
3051
3052 newmsg = mtod(n, struct sadb_msg *);
3053 newmsg->sadb_msg_errno = 0;
3054 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
3055 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
3056
3057 m_freem(m);
3058 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
3059 }
3060 }
3061
3062 static int
key_spdenable(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)3063 key_spdenable(
3064 struct socket *so,
3065 struct mbuf *m,
3066 const struct sadb_msghdr *mhp)
3067 {
3068 u_int32_t id;
3069 struct secpolicy *sp;
3070
3071 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
3072
3073 /* sanity check */
3074 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
3075 panic("key_spdenable: NULL pointer is passed.");
3076 }
3077
3078 if (mhp->ext[SADB_X_EXT_POLICY] == NULL ||
3079 mhp->extlen[SADB_X_EXT_POLICY] < sizeof(struct sadb_x_policy)) {
3080 ipseclog((LOG_DEBUG, "key_spdenable: invalid message is passed.\n"));
3081 key_senderror(so, m, EINVAL);
3082 return 0;
3083 }
3084
3085 id = ((struct sadb_x_policy *)
3086 (void *)mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
3087
3088 /* Is there SP in SPD ? */
3089 lck_mtx_lock(sadb_mutex);
3090 if ((sp = __key_getspbyid(id)) == NULL) {
3091 lck_mtx_unlock(sadb_mutex);
3092 ipseclog((LOG_DEBUG, "key_spdenable: no SP found id:%u.\n", id));
3093 return key_senderror(so, m, EINVAL);
3094 }
3095
3096 sp->disabled = 0;
3097 key_freesp(sp, KEY_SADB_LOCKED);
3098 lck_mtx_unlock(sadb_mutex);
3099
3100 {
3101 struct mbuf *n;
3102 struct sadb_msg *newmsg;
3103 int mbufItems[] = {SADB_EXT_RESERVED, SADB_X_EXT_POLICY};
3104
3105 /* create new sadb_msg to reply. */
3106 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
3107 if (!n) {
3108 return key_senderror(so, m, ENOBUFS);
3109 }
3110
3111 if (n->m_len < sizeof(struct sadb_msg)) {
3112 n = m_pullup(n, sizeof(struct sadb_msg));
3113 if (n == NULL) {
3114 return key_senderror(so, m, ENOBUFS);
3115 }
3116 }
3117 newmsg = mtod(n, struct sadb_msg *);
3118 newmsg->sadb_msg_errno = 0;
3119 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
3120 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
3121
3122 m_freem(m);
3123 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
3124 }
3125 }
3126
3127 static int
key_spddisable(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)3128 key_spddisable(
3129 struct socket *so,
3130 struct mbuf *m,
3131 const struct sadb_msghdr *mhp)
3132 {
3133 u_int32_t id;
3134 struct secpolicy *sp;
3135
3136 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
3137
3138 /* sanity check */
3139 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
3140 panic("key_spddisable: NULL pointer is passed.");
3141 }
3142
3143 if (mhp->ext[SADB_X_EXT_POLICY] == NULL ||
3144 mhp->extlen[SADB_X_EXT_POLICY] < sizeof(struct sadb_x_policy)) {
3145 ipseclog((LOG_DEBUG, "key_spddisable: invalid message is passed.\n"));
3146 key_senderror(so, m, EINVAL);
3147 return 0;
3148 }
3149
3150 id = ((struct sadb_x_policy *)
3151 (void *)mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
3152
3153 /* Is there SP in SPD ? */
3154 lck_mtx_lock(sadb_mutex);
3155 if ((sp = __key_getspbyid(id)) == NULL) {
3156 lck_mtx_unlock(sadb_mutex);
3157 ipseclog((LOG_DEBUG, "key_spddisable: no SP found id:%u.\n", id));
3158 return key_senderror(so, m, EINVAL);
3159 }
3160
3161 sp->disabled = 1;
3162 key_freesp(sp, KEY_SADB_LOCKED);
3163 lck_mtx_unlock(sadb_mutex);
3164
3165 {
3166 struct mbuf *n;
3167 struct sadb_msg *newmsg;
3168 int mbufItems[] = {SADB_EXT_RESERVED, SADB_X_EXT_POLICY};
3169
3170 /* create new sadb_msg to reply. */
3171 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
3172 if (!n) {
3173 return key_senderror(so, m, ENOBUFS);
3174 }
3175
3176 if (n->m_len < sizeof(struct sadb_msg)) {
3177 n = m_pullup(n, sizeof(struct sadb_msg));
3178 if (n == NULL) {
3179 return key_senderror(so, m, ENOBUFS);
3180 }
3181 }
3182 newmsg = mtod(n, struct sadb_msg *);
3183 newmsg->sadb_msg_errno = 0;
3184 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
3185 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
3186
3187 m_freem(m);
3188 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
3189 }
3190 }
3191
3192 /*
3193 * SADB_X_GET processing
3194 * receive
3195 * <base, policy(*)>
3196 * from the user(?),
3197 * and send,
3198 * <base, address(SD), policy>
3199 * to the ikmpd.
3200 * policy(*) including direction of policy.
3201 *
3202 * m will always be freed.
3203 */
3204 static int
key_spdget(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)3205 key_spdget(
3206 struct socket *so,
3207 struct mbuf *m,
3208 const struct sadb_msghdr *mhp)
3209 {
3210 u_int32_t id;
3211 struct secpolicy *sp;
3212 struct mbuf *n;
3213
3214 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
3215
3216 /* sanity check */
3217 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
3218 panic("key_spdget: NULL pointer is passed.");
3219 }
3220
3221 if (mhp->ext[SADB_X_EXT_POLICY] == NULL ||
3222 mhp->extlen[SADB_X_EXT_POLICY] < sizeof(struct sadb_x_policy)) {
3223 ipseclog((LOG_DEBUG, "key_spdget: invalid message is passed.\n"));
3224 return key_senderror(so, m, EINVAL);
3225 }
3226
3227 id = ((struct sadb_x_policy *)
3228 (void *)mhp->ext[SADB_X_EXT_POLICY])->sadb_x_policy_id;
3229
3230 /* Is there SP in SPD ? */
3231 lck_mtx_lock(sadb_mutex);
3232 if ((sp = __key_getspbyid(id)) == NULL) {
3233 ipseclog((LOG_DEBUG, "key_spdget: no SP found id:%u.\n", id));
3234 lck_mtx_unlock(sadb_mutex);
3235 return key_senderror(so, m, ENOENT);
3236 }
3237 lck_mtx_unlock(sadb_mutex);
3238 n = key_setdumpsp(sp, SADB_X_SPDGET, 0, mhp->msg->sadb_msg_pid);
3239 key_freesp(sp, KEY_SADB_UNLOCKED);
3240 if (n != NULL) {
3241 m_freem(m);
3242 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
3243 } else {
3244 return key_senderror(so, m, ENOBUFS);
3245 }
3246 }
3247
3248 /*
3249 * SADB_X_SPDACQUIRE processing.
3250 * Acquire policy and SA(s) for a *OUTBOUND* packet.
3251 * send
3252 * <base, policy(*)>
3253 * to KMD, and expect to receive
3254 * <base> with SADB_X_SPDACQUIRE if error occurred,
3255 * or
3256 * <base, policy>
3257 * with SADB_X_SPDUPDATE from KMD by PF_KEY.
3258 * policy(*) is without policy requests.
3259 *
3260 * 0 : succeed
3261 * others: error number
3262 */
3263 int
key_spdacquire(struct secpolicy * sp)3264 key_spdacquire(
3265 struct secpolicy *sp)
3266 {
3267 struct mbuf *result = NULL, *m;
3268 struct secspacq *newspacq;
3269 int error;
3270
3271 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
3272
3273 /* sanity check */
3274 if (sp == NULL) {
3275 panic("key_spdacquire: NULL pointer is passed.");
3276 }
3277 if (sp->req != NULL) {
3278 panic("key_spdacquire: called but there is request.");
3279 }
3280 if (sp->policy != IPSEC_POLICY_IPSEC) {
3281 panic("key_spdacquire: policy mismathed. IPsec is expected.");
3282 }
3283
3284 /* get a entry to check whether sent message or not. */
3285 lck_mtx_lock(sadb_mutex);
3286 sp->refcnt++;
3287 if ((newspacq = key_getspacq(&sp->spidx)) != NULL) {
3288 key_freesp(sp, KEY_SADB_LOCKED);
3289 if (key_blockacq_count < newspacq->count) {
3290 /* reset counter and do send message. */
3291 newspacq->count = 0;
3292 } else {
3293 /* increment counter and do nothing. */
3294 newspacq->count++;
3295 lck_mtx_unlock(sadb_mutex);
3296 return 0;
3297 }
3298 } else {
3299 /* make new entry for blocking to send SADB_ACQUIRE. */
3300 if ((newspacq = key_newspacq(&sp->spidx)) == NULL) {
3301 key_freesp(sp, KEY_SADB_LOCKED);
3302 lck_mtx_unlock(sadb_mutex);
3303 return ENOBUFS;
3304 }
3305 key_freesp(sp, KEY_SADB_LOCKED);
3306 /* add to acqtree */
3307 LIST_INSERT_HEAD(&spacqtree, newspacq, chain);
3308 key_start_timehandler();
3309 }
3310 lck_mtx_unlock(sadb_mutex);
3311 /* create new sadb_msg to reply. */
3312 m = key_setsadbmsg(SADB_X_SPDACQUIRE, 0, 0, 0, 0, 0);
3313 if (!m) {
3314 error = ENOBUFS;
3315 goto fail;
3316 }
3317 result = m;
3318
3319 result->m_pkthdr.len = 0;
3320 for (m = result; m; m = m->m_next) {
3321 result->m_pkthdr.len += m->m_len;
3322 }
3323
3324 VERIFY(PFKEY_UNIT64(result->m_pkthdr.len) <= UINT16_MAX);
3325 mtod(result, struct sadb_msg *)->sadb_msg_len =
3326 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
3327
3328 return key_sendup_mbuf(NULL, m, KEY_SENDUP_REGISTERED);
3329
3330 fail:
3331 if (result) {
3332 m_freem(result);
3333 }
3334 return error;
3335 }
3336
3337 /*
3338 * SADB_SPDFLUSH processing
3339 * receive
3340 * <base>
3341 * from the user, and free all entries in secpctree.
3342 * and send,
3343 * <base>
3344 * to the user.
3345 * NOTE: what to do is only marking SADB_SASTATE_DEAD.
3346 *
3347 * m will always be freed.
3348 */
3349 static int
key_spdflush(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)3350 key_spdflush(
3351 struct socket *so,
3352 struct mbuf *m,
3353 const struct sadb_msghdr *mhp)
3354 {
3355 struct sadb_msg *newmsg;
3356 struct secpolicy *sp;
3357 u_int dir;
3358
3359 /* sanity check */
3360 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
3361 panic("key_spdflush: NULL pointer is passed.");
3362 }
3363
3364 if (m->m_len != PFKEY_ALIGN8(sizeof(struct sadb_msg))) {
3365 return key_senderror(so, m, EINVAL);
3366 }
3367
3368 lck_mtx_lock(sadb_mutex);
3369 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
3370 LIST_FOREACH(sp, &sptree[dir], chain) {
3371 sp->state = IPSEC_SPSTATE_DEAD;
3372 }
3373 }
3374 lck_mtx_unlock(sadb_mutex);
3375
3376 if (sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
3377 ipseclog((LOG_DEBUG, "key_spdflush: No more memory.\n"));
3378 return key_senderror(so, m, ENOBUFS);
3379 }
3380
3381 if (m->m_next) {
3382 m_freem(m->m_next);
3383 }
3384 m->m_next = NULL;
3385 m->m_pkthdr.len = m->m_len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
3386 newmsg = mtod(m, struct sadb_msg *);
3387 newmsg->sadb_msg_errno = 0;
3388 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(m->m_pkthdr.len);
3389
3390 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
3391 }
3392
3393 /*
3394 * SADB_SPDDUMP processing
3395 * receive
3396 * <base>
3397 * from the user, and dump all SP leaves
3398 * and send,
3399 * <base> .....
3400 * to the ikmpd.
3401 *
3402 * m will always be freed.
3403 */
3404
3405 static int
key_spddump(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)3406 key_spddump(
3407 struct socket *so,
3408 struct mbuf *m,
3409 const struct sadb_msghdr *mhp)
3410 {
3411 struct secpolicy *sp, **spbuf = NULL, **sp_ptr;
3412 u_int32_t cnt = 0, bufcount = 0;
3413 u_int dir;
3414 struct mbuf *n;
3415 int error = 0;
3416
3417 /* sanity check */
3418 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
3419 panic("key_spddump: NULL pointer is passed.");
3420 }
3421
3422 if ((bufcount = ipsec_policy_count) == 0) {
3423 error = ENOENT;
3424 goto end;
3425 }
3426
3427 if (os_add_overflow(bufcount, 256, &bufcount)) {
3428 ipseclog((LOG_DEBUG, "key_spddump: bufcount overflow, ipsec policy count %u.\n", ipsec_policy_count));
3429 bufcount = ipsec_policy_count;
3430 }
3431
3432 spbuf = kalloc_type(struct secpolicy *, bufcount, Z_WAITOK);
3433 if (spbuf == NULL) {
3434 ipseclog((LOG_DEBUG, "key_spddump: No more memory.\n"));
3435 error = ENOMEM;
3436 goto end;
3437 }
3438 lck_mtx_lock(sadb_mutex);
3439 /* search SPD entry, make list. */
3440 sp_ptr = spbuf;
3441 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
3442 LIST_FOREACH(sp, &sptree[dir], chain) {
3443 if (cnt == bufcount) {
3444 break; /* buffer full */
3445 }
3446 *sp_ptr++ = sp;
3447 sp->refcnt++;
3448 cnt++;
3449 }
3450 }
3451 lck_mtx_unlock(sadb_mutex);
3452
3453 if (cnt == 0) {
3454 error = ENOENT;
3455 goto end;
3456 }
3457
3458 sp_ptr = spbuf;
3459 while (cnt) {
3460 --cnt;
3461 n = key_setdumpsp(*sp_ptr++, SADB_X_SPDDUMP, cnt,
3462 mhp->msg->sadb_msg_pid);
3463
3464 if (n) {
3465 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
3466 }
3467 }
3468
3469 lck_mtx_lock(sadb_mutex);
3470 while (sp_ptr > spbuf) {
3471 key_freesp(*(--sp_ptr), KEY_SADB_LOCKED);
3472 }
3473 lck_mtx_unlock(sadb_mutex);
3474
3475 end:
3476 kfree_type(struct secpolicy *, bufcount, spbuf);
3477 if (error) {
3478 return key_senderror(so, m, error);
3479 }
3480
3481 m_freem(m);
3482 return 0;
3483 }
3484
3485 static struct mbuf *
key_setdumpsp(struct secpolicy * sp,u_int8_t msg_type,u_int32_t seq,u_int32_t pid)3486 key_setdumpsp(
3487 struct secpolicy *sp,
3488 u_int8_t msg_type,
3489 u_int32_t seq,
3490 u_int32_t pid)
3491 {
3492 struct mbuf *result = NULL, *m;
3493
3494 m = key_setsadbmsg(msg_type, 0, SADB_SATYPE_UNSPEC, seq, pid, (u_int16_t)sp->refcnt);
3495 if (!m) {
3496 goto fail;
3497 }
3498 result = m;
3499
3500 if (sp->spidx.src_range.start.ss_len > 0) {
3501 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_SRC_START,
3502 (struct sockaddr *)&sp->spidx.src_range.start, sp->spidx.prefs,
3503 sp->spidx.ul_proto);
3504 if (!m) {
3505 goto fail;
3506 }
3507 m_cat(result, m);
3508
3509 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_SRC_END,
3510 (struct sockaddr *)&sp->spidx.src_range.end, sp->spidx.prefs,
3511 sp->spidx.ul_proto);
3512 if (!m) {
3513 goto fail;
3514 }
3515 m_cat(result, m);
3516 } else {
3517 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3518 (struct sockaddr *)&sp->spidx.src, sp->spidx.prefs,
3519 sp->spidx.ul_proto);
3520 if (!m) {
3521 goto fail;
3522 }
3523 m_cat(result, m);
3524 }
3525
3526 if (sp->spidx.dst_range.start.ss_len > 0) {
3527 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_DST_START,
3528 (struct sockaddr *)&sp->spidx.dst_range.start, sp->spidx.prefd,
3529 sp->spidx.ul_proto);
3530 if (!m) {
3531 goto fail;
3532 }
3533 m_cat(result, m);
3534
3535 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_DST_END,
3536 (struct sockaddr *)&sp->spidx.dst_range.end, sp->spidx.prefd,
3537 sp->spidx.ul_proto);
3538 if (!m) {
3539 goto fail;
3540 }
3541 m_cat(result, m);
3542 } else {
3543 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3544 (struct sockaddr *)&sp->spidx.dst, sp->spidx.prefd,
3545 sp->spidx.ul_proto);
3546 if (!m) {
3547 goto fail;
3548 }
3549 m_cat(result, m);
3550 }
3551
3552 if (sp->spidx.internal_if || sp->outgoing_if || sp->ipsec_if || sp->disabled) {
3553 m = key_setsadbipsecif(sp->spidx.internal_if, sp->outgoing_if, sp->ipsec_if, sp->disabled);
3554 if (!m) {
3555 goto fail;
3556 }
3557 m_cat(result, m);
3558 }
3559
3560 m = key_sp2msg(sp);
3561 if (!m) {
3562 goto fail;
3563 }
3564 m_cat(result, m);
3565
3566 if ((result->m_flags & M_PKTHDR) == 0) {
3567 goto fail;
3568 }
3569
3570 if (result->m_len < sizeof(struct sadb_msg)) {
3571 result = m_pullup(result, sizeof(struct sadb_msg));
3572 if (result == NULL) {
3573 goto fail;
3574 }
3575 }
3576
3577 result->m_pkthdr.len = 0;
3578 for (m = result; m; m = m->m_next) {
3579 result->m_pkthdr.len += m->m_len;
3580 }
3581
3582 if (PFKEY_UNIT64(result->m_pkthdr.len) >= UINT16_MAX) {
3583 ipseclog((LOG_DEBUG, "key_setdumpsp: packet header length > UINT16_MAX\n"));
3584 goto fail;
3585 }
3586
3587 mtod(result, struct sadb_msg *)->sadb_msg_len =
3588 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
3589
3590 return result;
3591
3592 fail:
3593 m_freem(result);
3594 return NULL;
3595 }
3596
3597 /*
3598 * get PFKEY message length for security policy and request.
3599 */
3600 static u_int
key_getspreqmsglen(struct secpolicy * sp)3601 key_getspreqmsglen(
3602 struct secpolicy *sp)
3603 {
3604 u_int tlen;
3605
3606 tlen = sizeof(struct sadb_x_policy);
3607
3608 /* if is the policy for ipsec ? */
3609 if (sp->policy != IPSEC_POLICY_IPSEC) {
3610 return tlen;
3611 }
3612
3613 /* get length of ipsec requests */
3614 {
3615 struct ipsecrequest *isr;
3616 int len;
3617
3618 for (isr = sp->req; isr != NULL; isr = isr->next) {
3619 len = sizeof(struct sadb_x_ipsecrequest)
3620 + isr->saidx.src.ss_len
3621 + isr->saidx.dst.ss_len;
3622
3623 tlen += PFKEY_ALIGN8(len);
3624 }
3625 }
3626
3627 return tlen;
3628 }
3629
3630 /*
3631 * SADB_SPDEXPIRE processing
3632 * send
3633 * <base, address(SD), lifetime(CH), policy>
3634 * to KMD by PF_KEY.
3635 *
3636 * OUT: 0 : succeed
3637 * others : error number
3638 */
3639 static int
key_spdexpire(struct secpolicy * sp)3640 key_spdexpire(
3641 struct secpolicy *sp)
3642 {
3643 struct mbuf *result = NULL, *m;
3644 int len;
3645 int error = EINVAL;
3646 struct sadb_lifetime *lt;
3647
3648 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
3649
3650 /* sanity check */
3651 if (sp == NULL) {
3652 panic("key_spdexpire: NULL pointer is passed.");
3653 }
3654
3655 /* set msg header */
3656 m = key_setsadbmsg(SADB_X_SPDEXPIRE, 0, 0, 0, 0, 0);
3657 if (!m) {
3658 error = ENOBUFS;
3659 goto fail;
3660 }
3661 result = m;
3662
3663 /* create lifetime extension (current and hard) */
3664 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
3665 m = key_alloc_mbuf(len);
3666 if (!m || m->m_next) { /*XXX*/
3667 if (m) {
3668 m_freem(m);
3669 }
3670 error = ENOBUFS;
3671 goto fail;
3672 }
3673 bzero(mtod(m, caddr_t), len);
3674 lt = mtod(m, struct sadb_lifetime *);
3675 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
3676 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
3677 lt->sadb_lifetime_allocations = 0;
3678 lt->sadb_lifetime_bytes = 0;
3679 lt->sadb_lifetime_addtime = sp->created;
3680 lt->sadb_lifetime_usetime = sp->lastused;
3681 lt = (struct sadb_lifetime *)(void *)(mtod(m, caddr_t) + len / 2);
3682 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
3683 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_HARD;
3684 lt->sadb_lifetime_allocations = 0;
3685 lt->sadb_lifetime_bytes = 0;
3686 lt->sadb_lifetime_addtime = sp->lifetime;
3687 lt->sadb_lifetime_usetime = sp->validtime;
3688 m_cat(result, m);
3689
3690 /* set sadb_address(es) for source */
3691 if (sp->spidx.src_range.start.ss_len > 0) {
3692 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_SRC_START,
3693 (struct sockaddr *)&sp->spidx.src_range.start, sp->spidx.prefs,
3694 sp->spidx.ul_proto);
3695 if (!m) {
3696 error = ENOBUFS;
3697 goto fail;
3698 }
3699 m_cat(result, m);
3700
3701 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_SRC_END,
3702 (struct sockaddr *)&sp->spidx.src_range.end, sp->spidx.prefs,
3703 sp->spidx.ul_proto);
3704 if (!m) {
3705 error = ENOBUFS;
3706 goto fail;
3707 }
3708 m_cat(result, m);
3709 } else {
3710 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
3711 (struct sockaddr *)&sp->spidx.src, sp->spidx.prefs,
3712 sp->spidx.ul_proto);
3713 if (!m) {
3714 error = ENOBUFS;
3715 goto fail;
3716 }
3717 m_cat(result, m);
3718 }
3719
3720 /* set sadb_address(es) for dest */
3721 if (sp->spidx.dst_range.start.ss_len > 0) {
3722 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_DST_START,
3723 (struct sockaddr *)&sp->spidx.dst_range.start, sp->spidx.prefd,
3724 sp->spidx.ul_proto);
3725 if (!m) {
3726 error = ENOBUFS;
3727 goto fail;
3728 }
3729 m_cat(result, m);
3730
3731 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_DST_END,
3732 (struct sockaddr *)&sp->spidx.dst_range.end, sp->spidx.prefd,
3733 sp->spidx.ul_proto);
3734 if (!m) {
3735 error = ENOBUFS;
3736 goto fail;
3737 }
3738 m_cat(result, m);
3739 } else {
3740 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
3741 (struct sockaddr *)&sp->spidx.dst, sp->spidx.prefd,
3742 sp->spidx.ul_proto);
3743 if (!m) {
3744 error = ENOBUFS;
3745 goto fail;
3746 }
3747 m_cat(result, m);
3748 }
3749
3750 /* set secpolicy */
3751 m = key_sp2msg(sp);
3752 if (!m) {
3753 error = ENOBUFS;
3754 goto fail;
3755 }
3756 m_cat(result, m);
3757
3758 if ((result->m_flags & M_PKTHDR) == 0) {
3759 error = EINVAL;
3760 goto fail;
3761 }
3762
3763 if (result->m_len < sizeof(struct sadb_msg)) {
3764 result = m_pullup(result, sizeof(struct sadb_msg));
3765 if (result == NULL) {
3766 error = ENOBUFS;
3767 goto fail;
3768 }
3769 }
3770
3771 result->m_pkthdr.len = 0;
3772 for (m = result; m; m = m->m_next) {
3773 result->m_pkthdr.len += m->m_len;
3774 }
3775
3776 if (PFKEY_UNIT64(result->m_pkthdr.len) >= UINT16_MAX) {
3777 ipseclog((LOG_DEBUG, "key_setdumpsp: packet header length > UINT16_MAX\n"));
3778 goto fail;
3779 }
3780
3781 mtod(result, struct sadb_msg *)->sadb_msg_len =
3782 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
3783
3784 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
3785
3786 fail:
3787 if (result) {
3788 m_freem(result);
3789 }
3790 return error;
3791 }
3792
3793 /* %%% SAD management */
3794 /*
3795 * allocating a memory for new SA head, and copy from the values of mhp.
3796 * OUT: NULL : failure due to the lack of memory.
3797 * others : pointer to new SA head.
3798 */
3799 static struct secashead *
key_newsah(struct secasindex * saidx,ifnet_t ipsec_if,u_int outgoing_if,u_int8_t dir,u_int16_t flags)3800 key_newsah(struct secasindex *saidx,
3801 ifnet_t ipsec_if,
3802 u_int outgoing_if,
3803 u_int8_t dir,
3804 u_int16_t flags)
3805 {
3806 struct secashead *newsah;
3807
3808 /* sanity check */
3809 if (saidx == NULL) {
3810 panic("key_newsaidx: NULL pointer is passed.");
3811 }
3812
3813 VERIFY(flags == SECURITY_ASSOCIATION_PFKEY || flags == SECURITY_ASSOCIATION_CUSTOM_IPSEC);
3814
3815 newsah = keydb_newsecashead();
3816 if (newsah == NULL) {
3817 return NULL;
3818 }
3819
3820 bcopy(saidx, &newsah->saidx, sizeof(newsah->saidx));
3821
3822 /* remove the ports */
3823 switch (saidx->src.ss_family) {
3824 case AF_INET:
3825 ((struct sockaddr_in *)(&newsah->saidx.src))->sin_port = IPSEC_PORT_ANY;
3826 break;
3827 case AF_INET6:
3828 ((struct sockaddr_in6 *)(&newsah->saidx.src))->sin6_port = IPSEC_PORT_ANY;
3829 break;
3830 default:
3831 break;
3832 }
3833 switch (saidx->dst.ss_family) {
3834 case AF_INET:
3835 ((struct sockaddr_in *)(&newsah->saidx.dst))->sin_port = IPSEC_PORT_ANY;
3836 break;
3837 case AF_INET6:
3838 ((struct sockaddr_in6 *)(&newsah->saidx.dst))->sin6_port = IPSEC_PORT_ANY;
3839 break;
3840 default:
3841 break;
3842 }
3843
3844 newsah->outgoing_if = outgoing_if;
3845 if (ipsec_if) {
3846 ifnet_reference(ipsec_if);
3847 newsah->ipsec_if = ipsec_if;
3848 }
3849 newsah->dir = dir;
3850 /* add to saidxtree */
3851 newsah->state = SADB_SASTATE_MATURE;
3852 newsah->flags = flags;
3853
3854 if (flags == SECURITY_ASSOCIATION_PFKEY) {
3855 LIST_INSERT_HEAD(&sahtree, newsah, chain);
3856 } else {
3857 LIST_INSERT_HEAD(&custom_sahtree, newsah, chain);
3858 }
3859 key_start_timehandler();
3860
3861 return newsah;
3862 }
3863
3864 /*
3865 * delete SA index and all SA registered.
3866 */
3867 void
key_delsah(struct secashead * sah)3868 key_delsah(
3869 struct secashead *sah)
3870 {
3871 struct secasvar *sav, *nextsav;
3872 u_int stateidx, state;
3873 int zombie = 0;
3874
3875 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
3876
3877 /* sanity check */
3878 if (sah == NULL) {
3879 panic("key_delsah: NULL pointer is passed.");
3880 }
3881
3882 if (sah->use_count > 0) {
3883 return;
3884 }
3885
3886 /* searching all SA registered in the secindex. */
3887 for (stateidx = 0;
3888 stateidx < _ARRAYLEN(saorder_state_any);
3889 stateidx++) {
3890 state = saorder_state_any[stateidx];
3891 for (sav = (struct secasvar *)LIST_FIRST(&sah->savtree[state]);
3892 sav != NULL;
3893 sav = nextsav) {
3894 nextsav = LIST_NEXT(sav, chain);
3895
3896 if (sav->refcnt > 0) {
3897 /* give up to delete this sa */
3898 zombie++;
3899 continue;
3900 }
3901
3902 /* sanity check */
3903 KEY_CHKSASTATE(state, sav->state, "key_delsah");
3904
3905 key_freesav(sav, KEY_SADB_LOCKED);
3906
3907 /* remove back pointer */
3908 sav->sah = NULL;
3909 sav = NULL;
3910 }
3911 }
3912
3913 /* don't delete sah only if there are savs. */
3914 if (zombie) {
3915 return;
3916 }
3917
3918 ROUTE_RELEASE(&sah->sa_route);
3919
3920 if (sah->ipsec_if) {
3921 ifnet_release(sah->ipsec_if);
3922 sah->ipsec_if = NULL;
3923 }
3924
3925 /* remove from tree of SA index */
3926 if (__LIST_CHAINED(sah)) {
3927 LIST_REMOVE(sah, chain);
3928 }
3929
3930 kfree_type(struct secashead, sah);
3931 }
3932
3933 /*
3934 * allocating a new SA with LARVAL state. key_add() and key_getspi() call,
3935 * and copy the values of mhp into new buffer.
3936 * When SAD message type is GETSPI:
3937 * to set sequence number from acq_seq++,
3938 * to set zero to SPI.
3939 * not to call key_setsava().
3940 * OUT: NULL : fail
3941 * others : pointer to new secasvar.
3942 *
3943 * does not modify mbuf. does not free mbuf on error.
3944 */
3945 static struct secasvar *
key_newsav(struct mbuf * m,const struct sadb_msghdr * mhp,struct secashead * sah,int * errp,struct socket * so)3946 key_newsav(
3947 struct mbuf *m,
3948 const struct sadb_msghdr *mhp,
3949 struct secashead *sah,
3950 int *errp,
3951 struct socket *so)
3952 {
3953 struct secasvar *newsav;
3954 const struct sadb_sa *xsa;
3955
3956 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
3957
3958 /* sanity check */
3959 if (m == NULL || mhp == NULL || mhp->msg == NULL || sah == NULL) {
3960 panic("key_newsa: NULL pointer is passed.");
3961 }
3962
3963 newsav = kalloc_type(struct secasvar, Z_NOWAIT_ZERO);
3964 if (newsav == NULL) {
3965 lck_mtx_unlock(sadb_mutex);
3966 newsav = kalloc_type(struct secasvar, Z_WAITOK_ZERO_NOFAIL);
3967 lck_mtx_lock(sadb_mutex);
3968 }
3969
3970 switch (mhp->msg->sadb_msg_type) {
3971 case SADB_GETSPI:
3972 key_setspi(newsav, 0);
3973 newsav->seq = mhp->msg->sadb_msg_seq;
3974 break;
3975
3976 case SADB_ADD:
3977 /* sanity check */
3978 if (mhp->ext[SADB_EXT_SA] == NULL) {
3979 key_delsav(newsav);
3980 ipseclog((LOG_DEBUG, "key_newsa: invalid message is passed.\n"));
3981 *errp = EINVAL;
3982 return NULL;
3983 }
3984 xsa = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
3985 key_setspi(newsav, xsa->sadb_sa_spi);
3986 newsav->seq = mhp->msg->sadb_msg_seq;
3987 break;
3988 default:
3989 key_delsav(newsav);
3990 *errp = EINVAL;
3991 return NULL;
3992 }
3993
3994 if (mhp->ext[SADB_X_EXT_SA2] != NULL) {
3995 if (((struct sadb_x_sa2 *)(void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_alwaysexpire) {
3996 newsav->always_expire = 1;
3997 }
3998 newsav->flags2 = ((struct sadb_x_sa2 *)(void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_flags;
3999 if (newsav->flags2 & SADB_X_EXT_SA2_DELETE_ON_DETACH) {
4000 newsav->so = so;
4001 }
4002 }
4003
4004 /* copy sav values */
4005 if (mhp->msg->sadb_msg_type != SADB_GETSPI) {
4006 *errp = key_setsaval(newsav, m, mhp);
4007 if (*errp) {
4008 key_delsav(newsav);
4009 return NULL;
4010 }
4011 } else {
4012 /* For get SPI, if has a hard lifetime, apply */
4013 const struct sadb_lifetime *lft0;
4014 struct timeval tv;
4015
4016 lft0 = (struct sadb_lifetime *)(void *)mhp->ext[SADB_EXT_LIFETIME_HARD];
4017 if (lft0 != NULL) {
4018 /* make lifetime for CURRENT */
4019 newsav->lft_c = kalloc_type(struct sadb_lifetime, Z_NOWAIT);
4020 if (newsav->lft_c == NULL) {
4021 lck_mtx_unlock(sadb_mutex);
4022 newsav->lft_c = kalloc_type(struct sadb_lifetime,
4023 Z_WAITOK | Z_NOFAIL);
4024 lck_mtx_lock(sadb_mutex);
4025 }
4026
4027 microtime(&tv);
4028
4029 newsav->lft_c->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
4030 newsav->lft_c->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
4031 newsav->lft_c->sadb_lifetime_allocations = 0;
4032 newsav->lft_c->sadb_lifetime_bytes = 0;
4033 newsav->lft_c->sadb_lifetime_addtime = tv.tv_sec;
4034 newsav->lft_c->sadb_lifetime_usetime = 0;
4035
4036 if (mhp->extlen[SADB_EXT_LIFETIME_HARD] < sizeof(*lft0)) {
4037 ipseclog((LOG_DEBUG, "key_newsa: invalid hard lifetime ext len.\n"));
4038 key_delsav(newsav);
4039 *errp = EINVAL;
4040 return NULL;
4041 }
4042 newsav->lft_h = key_newbuf(lft0, sizeof(*lft0));
4043 }
4044 }
4045
4046 /* reset created */
4047 {
4048 struct timeval tv;
4049 microtime(&tv);
4050 newsav->created = tv.tv_sec;
4051 }
4052
4053 newsav->pid = mhp->msg->sadb_msg_pid;
4054
4055 /* add to satree */
4056 newsav->sah = sah;
4057 newsav->refcnt = 1;
4058 newsav->state = SADB_SASTATE_LARVAL;
4059 LIST_INSERT_TAIL(&sah->savtree[SADB_SASTATE_LARVAL], newsav,
4060 secasvar, chain);
4061 ipsec_sav_count++;
4062 ipsec_monitor_sleep_wake();
4063
4064 return newsav;
4065 }
4066
4067 static int
key_migratesav(struct secasvar * sav,struct secashead * newsah)4068 key_migratesav(struct secasvar *sav,
4069 struct secashead *newsah)
4070 {
4071 if (sav == NULL || newsah == NULL || sav->state != SADB_SASTATE_MATURE) {
4072 return EINVAL;
4073 }
4074
4075 /* remove from SA header */
4076 if (__LIST_CHAINED(sav)) {
4077 LIST_REMOVE(sav, chain);
4078 }
4079
4080 sav->sah = newsah;
4081 LIST_INSERT_TAIL(&newsah->savtree[SADB_SASTATE_MATURE], sav, secasvar, chain);
4082 return 0;
4083 }
4084
4085 static void
key_reset_sav(struct secasvar * sav)4086 key_reset_sav(struct secasvar *sav)
4087 {
4088 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4089
4090 /* sanity check */
4091 if (sav == NULL) {
4092 panic("key_delsav: NULL pointer is passed.");
4093 }
4094
4095 sav->remote_ike_port = 0;
4096 sav->natt_encapsulated_src_port = 0;
4097
4098 if (sav->key_auth != NULL) {
4099 bzero(_KEYBUF(sav->key_auth), _KEYLEN(sav->key_auth));
4100 kfree_data(sav->key_auth, PFKEY_UNUNIT64(sav->key_auth->sadb_key_len));
4101 sav->key_auth = NULL;
4102 }
4103 if (sav->key_enc != NULL) {
4104 bzero(_KEYBUF(sav->key_enc), _KEYLEN(sav->key_enc));
4105 kfree_data(sav->key_enc, PFKEY_UNUNIT64(sav->key_enc->sadb_key_len));
4106 sav->key_enc = NULL;
4107 }
4108 if (sav->sched) {
4109 bzero(sav->sched, sav->schedlen);
4110 kfree_data(sav->sched, sav->schedlen);
4111 sav->sched = NULL;
4112 sav->schedlen = 0;
4113 }
4114
4115 for (int i = 0; i < MAX_REPLAY_WINDOWS; i++) {
4116 if (sav->replay[i] != NULL) {
4117 keydb_delsecreplay(sav->replay[i]);
4118 sav->replay[i] = NULL;
4119 }
4120 }
4121 if (sav->lft_c != NULL) {
4122 kfree_type(struct sadb_lifetime, sav->lft_c);
4123 sav->lft_c = NULL;
4124 }
4125 if (sav->lft_h != NULL) {
4126 kfree_data(sav->lft_h, sizeof(*sav->lft_h));
4127 sav->lft_h = NULL;
4128 }
4129 if (sav->lft_s != NULL) {
4130 kfree_data(sav->lft_s, sizeof(*sav->lft_h));
4131 sav->lft_s = NULL;
4132 }
4133 if (sav->iv != NULL) {
4134 kfree_data(sav->iv, sav->ivlen);
4135 sav->iv = NULL;
4136 }
4137 key_release_flowid(sav);
4138 return;
4139 }
4140
4141 /*
4142 * free() SA variable entry.
4143 */
4144 void
key_delsav(struct secasvar * sav)4145 key_delsav(
4146 struct secasvar *sav)
4147 {
4148 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4149
4150 /* sanity check */
4151 if (sav == NULL) {
4152 panic("key_delsav: NULL pointer is passed.");
4153 }
4154
4155 if (sav->refcnt > 0) {
4156 return; /* can't free */
4157 }
4158 /* remove from SA header */
4159 if (__LIST_CHAINED(sav)) {
4160 LIST_REMOVE(sav, chain);
4161 ipsec_sav_count--;
4162 }
4163
4164 if (sav->spihash.le_prev || sav->spihash.le_next) {
4165 LIST_REMOVE(sav, spihash);
4166 }
4167
4168 key_reset_sav(sav);
4169
4170 kfree_type(struct secasvar, sav);
4171 }
4172
4173 /*
4174 * search SAD.
4175 * OUT:
4176 * NULL : not found
4177 * others : found, pointer to a SA.
4178 */
4179 static struct secashead *
key_getsah(struct secasindex * saidx,u_int16_t flags)4180 key_getsah(struct secasindex *saidx, u_int16_t flags)
4181 {
4182 struct secashead *sah;
4183
4184 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4185
4186 if ((flags & SECURITY_ASSOCIATION_ANY) == SECURITY_ASSOCIATION_ANY ||
4187 (flags & SECURITY_ASSOCIATION_PFKEY) == SECURITY_ASSOCIATION_PFKEY) {
4188 LIST_FOREACH(sah, &sahtree, chain) {
4189 if (sah->state == SADB_SASTATE_DEAD) {
4190 continue;
4191 }
4192 if (key_cmpsaidx(&sah->saidx, saidx, CMP_REQID)) {
4193 return sah;
4194 }
4195 }
4196 }
4197
4198 if ((flags & SECURITY_ASSOCIATION_ANY) == SECURITY_ASSOCIATION_ANY ||
4199 (flags & SECURITY_ASSOCIATION_PFKEY) == SECURITY_ASSOCIATION_CUSTOM_IPSEC) {
4200 LIST_FOREACH(sah, &custom_sahtree, chain) {
4201 if (sah->state == SADB_SASTATE_DEAD) {
4202 continue;
4203 }
4204 if (key_cmpsaidx(&sah->saidx, saidx, 0)) {
4205 return sah;
4206 }
4207 }
4208 }
4209
4210 return NULL;
4211 }
4212
4213 struct secashead *
key_newsah2(struct secasindex * saidx,u_int8_t dir)4214 key_newsah2(struct secasindex *saidx,
4215 u_int8_t dir)
4216 {
4217 struct secashead *sah;
4218
4219 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4220
4221 sah = key_getsah(saidx, SECURITY_ASSOCIATION_ANY);
4222 if (!sah) {
4223 return key_newsah(saidx, NULL, 0, dir, SECURITY_ASSOCIATION_PFKEY);
4224 }
4225 return sah;
4226 }
4227
4228 /*
4229 * check not to be duplicated SPI.
4230 * NOTE: this function is too slow due to searching all SAD.
4231 * OUT:
4232 * NULL : not found
4233 * others : found, pointer to a SA.
4234 */
4235 static struct secasvar *
key_checkspidup(struct secasindex * saidx,u_int32_t spi)4236 key_checkspidup(
4237 struct secasindex *saidx,
4238 u_int32_t spi)
4239 {
4240 struct secasvar *sav;
4241 u_int stateidx, state;
4242
4243 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4244
4245 /* check address family */
4246 if (saidx->src.ss_family != saidx->dst.ss_family) {
4247 ipseclog((LOG_DEBUG, "key_checkspidup: address family mismatched.\n"));
4248 return NULL;
4249 }
4250
4251 /* check all SAD */
4252 LIST_FOREACH(sav, &spihash[SPIHASH(spi)], spihash) {
4253 if (sav->spi != spi) {
4254 continue;
4255 }
4256 for (stateidx = 0;
4257 stateidx < _ARRAYLEN(saorder_state_alive);
4258 stateidx++) {
4259 state = saorder_state_alive[stateidx];
4260 if (sav->state == state &&
4261 key_ismyaddr((struct sockaddr *)&sav->sah->saidx.dst)) {
4262 return sav;
4263 }
4264 }
4265 }
4266
4267 return NULL;
4268 }
4269
4270 static void
key_setspi(struct secasvar * sav,u_int32_t spi)4271 key_setspi(
4272 struct secasvar *sav,
4273 u_int32_t spi)
4274 {
4275 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4276 sav->spi = spi;
4277 if (sav->spihash.le_prev || sav->spihash.le_next) {
4278 LIST_REMOVE(sav, spihash);
4279 }
4280 LIST_INSERT_HEAD(&spihash[SPIHASH(spi)], sav, spihash);
4281 }
4282
4283
4284 /*
4285 * search SAD litmited alive SA, protocol, SPI.
4286 * OUT:
4287 * NULL : not found
4288 * others : found, pointer to a SA.
4289 */
4290 static struct secasvar *
key_getsavbyspi(struct secashead * sah,u_int32_t spi)4291 key_getsavbyspi(
4292 struct secashead *sah,
4293 u_int32_t spi)
4294 {
4295 struct secasvar *sav, *match;
4296 u_int stateidx, state, matchidx;
4297
4298 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4299 match = NULL;
4300 matchidx = _ARRAYLEN(saorder_state_alive);
4301 LIST_FOREACH(sav, &spihash[SPIHASH(spi)], spihash) {
4302 if (sav->spi != spi) {
4303 continue;
4304 }
4305 if (sav->sah != sah) {
4306 continue;
4307 }
4308 for (stateidx = 0; stateidx < matchidx; stateidx++) {
4309 state = saorder_state_alive[stateidx];
4310 if (sav->state == state) {
4311 match = sav;
4312 matchidx = stateidx;
4313 break;
4314 }
4315 }
4316 }
4317
4318 return match;
4319 }
4320
4321 /*
4322 * copy SA values from PF_KEY message except *SPI, SEQ, PID, STATE and TYPE*.
4323 * You must update these if need.
4324 * OUT: 0: success.
4325 * !0: failure.
4326 *
4327 * does not modify mbuf. does not free mbuf on error.
4328 */
4329 static int
key_setsaval(struct secasvar * sav,struct mbuf * m,const struct sadb_msghdr * mhp)4330 key_setsaval(
4331 struct secasvar *sav,
4332 struct mbuf *m,
4333 const struct sadb_msghdr *mhp)
4334 {
4335 #if IPSEC_ESP
4336 const struct esp_algorithm *algo;
4337 #endif
4338 int error = 0;
4339 struct timeval tv;
4340
4341 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4342
4343 /* sanity check */
4344 if (m == NULL || mhp == NULL || mhp->msg == NULL) {
4345 panic("key_setsaval: NULL pointer is passed.");
4346 }
4347
4348 /* initialization */
4349 key_reset_sav(sav);
4350 sav->natt_last_activity = natt_now;
4351
4352 /* SA */
4353 if (mhp->ext[SADB_EXT_SA] != NULL) {
4354 const struct sadb_sa *sa0;
4355
4356 sa0 = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
4357 if (mhp->extlen[SADB_EXT_SA] < sizeof(*sa0)) {
4358 ipseclog((LOG_DEBUG, "key_setsaval: invalid message size.\n"));
4359 error = EINVAL;
4360 goto fail;
4361 }
4362
4363 sav->alg_auth = sa0->sadb_sa_auth;
4364 sav->alg_enc = sa0->sadb_sa_encrypt;
4365 sav->flags = sa0->sadb_sa_flags;
4366
4367 /*
4368 * Verify that a nat-traversal port was specified if
4369 * the nat-traversal flag is set.
4370 */
4371 if ((sav->flags & SADB_X_EXT_NATT) != 0) {
4372 if (mhp->extlen[SADB_EXT_SA] < sizeof(struct sadb_sa_2) ||
4373 ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_port == 0) {
4374 ipseclog((LOG_DEBUG, "key_setsaval: natt port not set.\n"));
4375 error = EINVAL;
4376 goto fail;
4377 }
4378 sav->natt_encapsulated_src_port = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_src_port;
4379 sav->remote_ike_port = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_port;
4380 sav->natt_interval = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_interval;
4381 sav->natt_offload_interval = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_offload_interval;
4382 }
4383
4384 /*
4385 * Verify if SADB_X_EXT_NATT_MULTIPLEUSERS flag is set that
4386 * SADB_X_EXT_NATT is set and SADB_X_EXT_NATT_KEEPALIVE is not
4387 * set (we're not behind nat) - otherwise clear it.
4388 */
4389 if ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0) {
4390 if ((sav->flags & SADB_X_EXT_NATT) == 0 ||
4391 (sav->flags & SADB_X_EXT_NATT_KEEPALIVE) != 0) {
4392 sav->flags &= ~SADB_X_EXT_NATT_MULTIPLEUSERS;
4393 }
4394 }
4395
4396 /* replay window */
4397 if ((sa0->sadb_sa_flags & SADB_X_EXT_OLD) == 0) {
4398 if ((sav->flags2 & SADB_X_EXT_SA2_SEQ_PER_TRAFFIC_CLASS) ==
4399 SADB_X_EXT_SA2_SEQ_PER_TRAFFIC_CLASS) {
4400 const uint32_t range =
4401 (1ULL << (sizeof(((struct secreplay *)0)->seq) * 8)) / MAX_REPLAY_WINDOWS;
4402 for (int i = 0; i < MAX_REPLAY_WINDOWS; i++) {
4403 sav->replay[i] = keydb_newsecreplay(sa0->sadb_sa_replay);
4404 if (sav->replay[i] == NULL) {
4405 ipseclog((LOG_DEBUG, "key_setsaval: No more memory.\n"));
4406 error = ENOBUFS;
4407 goto fail;
4408 }
4409 /* Allowed range for sequence per traffic class */
4410 sav->replay[i]->seq = i * range;
4411 sav->replay[i]->lastseq = ((i + 1) * range) - 1;
4412 }
4413 } else {
4414 sav->replay[0] = keydb_newsecreplay(sa0->sadb_sa_replay);
4415 if (sav->replay[0] == NULL) {
4416 ipseclog((LOG_DEBUG, "key_setsaval: No more memory.\n"));
4417 error = ENOBUFS;
4418 goto fail;
4419 }
4420 sav->replay[0]->lastseq = ~0;
4421 }
4422 }
4423 }
4424
4425 /* Authentication keys */
4426 if (mhp->ext[SADB_EXT_KEY_AUTH] != NULL) {
4427 const struct sadb_key *key0;
4428 int len;
4429
4430 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_AUTH];
4431 len = mhp->extlen[SADB_EXT_KEY_AUTH];
4432
4433 const size_t max_length = PFKEY_ALIGN8(sizeof(*key0)) +
4434 PFKEY_ALIGN8(IPSEC_KEY_AUTH_MAX_BYTES);
4435 assert(max_length < KALLOC_SAFE_ALLOC_SIZE);
4436
4437 error = 0;
4438 if ((len < sizeof(*key0)) || (len > max_length)) {
4439 ipseclog((LOG_DEBUG, "key_setsaval: invalid auth key ext len. len = %d\n", len));
4440 error = EINVAL;
4441 goto fail;
4442 }
4443 switch (mhp->msg->sadb_msg_satype) {
4444 case SADB_SATYPE_AH:
4445 case SADB_SATYPE_ESP:
4446 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
4447 sav->alg_auth != SADB_X_AALG_NULL) {
4448 error = EINVAL;
4449 }
4450 break;
4451 default:
4452 error = EINVAL;
4453 break;
4454 }
4455 if (error) {
4456 ipseclog((LOG_DEBUG, "key_setsaval: invalid key_auth values.\n"));
4457 goto fail;
4458 }
4459
4460 sav->key_auth = (struct sadb_key *)key_newbuf(key0, len);
4461 }
4462
4463 /* Encryption key */
4464 if (mhp->ext[SADB_EXT_KEY_ENCRYPT] != NULL) {
4465 const struct sadb_key *key0;
4466 int len;
4467
4468 key0 = (const struct sadb_key *)mhp->ext[SADB_EXT_KEY_ENCRYPT];
4469 len = mhp->extlen[SADB_EXT_KEY_ENCRYPT];
4470
4471 const size_t max_length = PFKEY_ALIGN8(sizeof(*key0)) +
4472 PFKEY_ALIGN8(IPSEC_KEY_ENCRYPT_MAX_BYTES);
4473 assert(max_length < KALLOC_SAFE_ALLOC_SIZE);
4474
4475 error = 0;
4476 if ((len < sizeof(*key0)) || (len > max_length)) {
4477 ipseclog((LOG_DEBUG, "key_setsaval: invalid encryption key ext len. len = %d\n", len));
4478 error = EINVAL;
4479 goto fail;
4480 }
4481 switch (mhp->msg->sadb_msg_satype) {
4482 case SADB_SATYPE_ESP:
4483 if (len == PFKEY_ALIGN8(sizeof(struct sadb_key)) &&
4484 sav->alg_enc != SADB_EALG_NULL) {
4485 ipseclog((LOG_DEBUG, "key_setsaval: invalid ESP algorithm.\n"));
4486 error = EINVAL;
4487 break;
4488 }
4489 sav->key_enc = (struct sadb_key *)key_newbuf(key0, len);
4490 break;
4491 case SADB_SATYPE_AH:
4492 default:
4493 error = EINVAL;
4494 break;
4495 }
4496 if (error) {
4497 ipseclog((LOG_DEBUG, "key_setsaval: invalid key_enc value.\n"));
4498 goto fail;
4499 }
4500 }
4501
4502 /* set iv */
4503 sav->ivlen = 0;
4504
4505 switch (mhp->msg->sadb_msg_satype) {
4506 case SADB_SATYPE_ESP:
4507 #if IPSEC_ESP
4508 algo = esp_algorithm_lookup(sav->alg_enc);
4509 if (algo && algo->ivlen) {
4510 sav->ivlen = (*algo->ivlen)(algo, sav);
4511 }
4512 if (sav->ivlen == 0) {
4513 break;
4514 }
4515 sav->iv = (caddr_t) kalloc_data(sav->ivlen, Z_NOWAIT);
4516 if (sav->iv == 0) {
4517 lck_mtx_unlock(sadb_mutex);
4518 sav->iv = (caddr_t) kalloc_data(sav->ivlen, Z_WAITOK);
4519 lck_mtx_lock(sadb_mutex);
4520 if (sav->iv == 0) {
4521 ipseclog((LOG_DEBUG, "key_setsaval: No more memory.\n"));
4522 error = ENOBUFS;
4523 goto fail;
4524 }
4525 }
4526
4527 /* initialize IV with random bytes */
4528 key_randomfill(sav->iv, sav->ivlen);
4529 #endif
4530 break;
4531 case SADB_SATYPE_AH:
4532 break;
4533 default:
4534 ipseclog((LOG_DEBUG, "key_setsaval: invalid SA type.\n"));
4535 error = EINVAL;
4536 goto fail;
4537 }
4538
4539 /* reset created */
4540 microtime(&tv);
4541 sav->created = tv.tv_sec;
4542
4543 /* make lifetime for CURRENT */
4544 sav->lft_c = kalloc_type(struct sadb_lifetime, Z_NOWAIT);
4545 if (sav->lft_c == NULL) {
4546 lck_mtx_unlock(sadb_mutex);
4547 sav->lft_c = kalloc_type(struct sadb_lifetime,
4548 Z_WAITOK | Z_NOFAIL);
4549 lck_mtx_lock(sadb_mutex);
4550 }
4551
4552 microtime(&tv);
4553
4554 sav->lft_c->sadb_lifetime_len =
4555 PFKEY_UNIT64(sizeof(struct sadb_lifetime));
4556 sav->lft_c->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
4557 sav->lft_c->sadb_lifetime_allocations = 0;
4558 sav->lft_c->sadb_lifetime_bytes = 0;
4559 sav->lft_c->sadb_lifetime_addtime = tv.tv_sec;
4560 sav->lft_c->sadb_lifetime_usetime = 0;
4561
4562 /* lifetimes for HARD and SOFT */
4563 {
4564 const struct sadb_lifetime *lft0;
4565
4566 lft0 = (struct sadb_lifetime *)
4567 (void *)mhp->ext[SADB_EXT_LIFETIME_HARD];
4568 if (lft0 != NULL) {
4569 if (mhp->extlen[SADB_EXT_LIFETIME_HARD] < sizeof(*lft0)) {
4570 ipseclog((LOG_DEBUG, "key_setsaval: invalid hard lifetime ext len.\n"));
4571 error = EINVAL;
4572 goto fail;
4573 }
4574 sav->lft_h = (struct sadb_lifetime *)key_newbuf(lft0, sizeof(*lft0));
4575 /* to be initialize ? */
4576 }
4577
4578 lft0 = (struct sadb_lifetime *)
4579 (void *)mhp->ext[SADB_EXT_LIFETIME_SOFT];
4580 if (lft0 != NULL) {
4581 if (mhp->extlen[SADB_EXT_LIFETIME_SOFT] < sizeof(*lft0)) {
4582 ipseclog((LOG_DEBUG, "key_setsaval: invalid soft lifetime ext len.\n"));
4583 error = EINVAL;
4584 goto fail;
4585 }
4586 sav->lft_s = (struct sadb_lifetime *)key_newbuf(lft0, sizeof(*lft0));
4587 /* to be initialize ? */
4588 }
4589 }
4590
4591 return 0;
4592
4593 fail:
4594 key_reset_sav(sav);
4595 return error;
4596 }
4597
4598 /*
4599 * validation with a secasvar entry, and set SADB_SATYPE_MATURE.
4600 * OUT: 0: valid
4601 * other: errno
4602 */
4603 static int
key_mature(struct secasvar * sav)4604 key_mature(
4605 struct secasvar *sav)
4606 {
4607 int mature;
4608 int checkmask = 0; /* 2^0: ealg 2^1: aalg 2^2: calg */
4609 int mustmask = 0; /* 2^0: ealg 2^1: aalg 2^2: calg */
4610
4611 mature = 0;
4612
4613 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
4614
4615 /* check SPI value */
4616 switch (sav->sah->saidx.proto) {
4617 case IPPROTO_ESP:
4618 case IPPROTO_AH:
4619
4620 /* No reason to test if this is >= 0, because ntohl(sav->spi) is unsigned. */
4621 if (ntohl(sav->spi) <= 255) {
4622 ipseclog((LOG_DEBUG,
4623 "key_mature: illegal range of SPI %u.\n",
4624 (u_int32_t)ntohl(sav->spi)));
4625 return EINVAL;
4626 }
4627 break;
4628 }
4629
4630 /* check satype */
4631 switch (sav->sah->saidx.proto) {
4632 case IPPROTO_ESP:
4633 /* check flags */
4634 if ((sav->flags & SADB_X_EXT_OLD)
4635 && (sav->flags & SADB_X_EXT_DERIV)) {
4636 ipseclog((LOG_DEBUG, "key_mature: "
4637 "invalid flag (derived) given to old-esp.\n"));
4638 return EINVAL;
4639 }
4640 if (sav->alg_auth == SADB_AALG_NONE) {
4641 checkmask = 1;
4642 } else {
4643 checkmask = 3;
4644 }
4645 mustmask = 1;
4646 break;
4647 case IPPROTO_AH:
4648 /* check flags */
4649 if (sav->flags & SADB_X_EXT_DERIV) {
4650 ipseclog((LOG_DEBUG, "key_mature: "
4651 "invalid flag (derived) given to AH SA.\n"));
4652 return EINVAL;
4653 }
4654 if (sav->alg_enc != SADB_EALG_NONE) {
4655 ipseclog((LOG_DEBUG, "key_mature: "
4656 "protocol and algorithm mismated.\n"));
4657 return EINVAL;
4658 }
4659 checkmask = 2;
4660 mustmask = 2;
4661 break;
4662 default:
4663 ipseclog((LOG_DEBUG, "key_mature: Invalid satype.\n"));
4664 return EPROTONOSUPPORT;
4665 }
4666
4667 /* check authentication algorithm */
4668 if ((checkmask & 2) != 0) {
4669 const struct ah_algorithm *algo;
4670 int keylen;
4671
4672 algo = ah_algorithm_lookup(sav->alg_auth);
4673 if (!algo) {
4674 ipseclog((LOG_DEBUG, "key_mature: "
4675 "unknown authentication algorithm.\n"));
4676 return EINVAL;
4677 }
4678
4679 /* algorithm-dependent check */
4680 if (sav->key_auth) {
4681 keylen = sav->key_auth->sadb_key_bits;
4682 } else {
4683 keylen = 0;
4684 }
4685 if (keylen < algo->keymin || algo->keymax < keylen) {
4686 ipseclog((LOG_DEBUG,
4687 "key_mature: invalid AH key length %d "
4688 "(%d-%d allowed)\n",
4689 keylen, algo->keymin, algo->keymax));
4690 return EINVAL;
4691 }
4692
4693 if (algo->mature) {
4694 if ((*algo->mature)(sav)) {
4695 /* message generated in per-algorithm function*/
4696 return EINVAL;
4697 } else {
4698 mature = SADB_SATYPE_AH;
4699 }
4700 }
4701
4702 if ((mustmask & 2) != 0 && mature != SADB_SATYPE_AH) {
4703 ipseclog((LOG_DEBUG, "key_mature: no satisfy algorithm for AH\n"));
4704 return EINVAL;
4705 }
4706 }
4707
4708 /* check encryption algorithm */
4709 if ((checkmask & 1) != 0) {
4710 #if IPSEC_ESP
4711 const struct esp_algorithm *algo;
4712 int keylen;
4713
4714 algo = esp_algorithm_lookup(sav->alg_enc);
4715 if (!algo) {
4716 ipseclog((LOG_DEBUG, "key_mature: unknown encryption algorithm.\n"));
4717 return EINVAL;
4718 }
4719
4720 /* algorithm-dependent check */
4721 if (sav->key_enc) {
4722 keylen = sav->key_enc->sadb_key_bits;
4723 } else {
4724 keylen = 0;
4725 }
4726 if (keylen < algo->keymin || algo->keymax < keylen) {
4727 ipseclog((LOG_DEBUG,
4728 "key_mature: invalid ESP key length %d "
4729 "(%d-%d allowed)\n",
4730 keylen, algo->keymin, algo->keymax));
4731 return EINVAL;
4732 }
4733
4734 if (algo->mature) {
4735 if ((*algo->mature)(sav)) {
4736 /* message generated in per-algorithm function*/
4737 return EINVAL;
4738 } else {
4739 mature = SADB_SATYPE_ESP;
4740 }
4741 }
4742
4743 if ((mustmask & 1) != 0 && mature != SADB_SATYPE_ESP) {
4744 ipseclog((LOG_DEBUG, "key_mature: no satisfy algorithm for ESP\n"));
4745 return EINVAL;
4746 }
4747 #else /*IPSEC_ESP*/
4748 ipseclog((LOG_DEBUG, "key_mature: ESP not supported in this configuration\n"));
4749 return EINVAL;
4750 #endif
4751 }
4752
4753 key_sa_chgstate(sav, SADB_SASTATE_MATURE);
4754
4755 return 0;
4756 }
4757
4758 /*
4759 * subroutine for SADB_GET and SADB_DUMP.
4760 */
4761 static struct mbuf *
key_setdumpsa(struct secasvar * sav,u_int8_t type,u_int8_t satype,u_int32_t seq,u_int32_t pid)4762 key_setdumpsa(
4763 struct secasvar *sav,
4764 u_int8_t type,
4765 u_int8_t satype,
4766 u_int32_t seq,
4767 u_int32_t pid)
4768 {
4769 struct mbuf *result = NULL, *tres = NULL, *m;
4770 int l = 0;
4771 int i;
4772 void *p;
4773 int dumporder[] = {
4774 SADB_EXT_SA, SADB_X_EXT_SA2,
4775 SADB_EXT_LIFETIME_HARD, SADB_EXT_LIFETIME_SOFT,
4776 SADB_EXT_LIFETIME_CURRENT, SADB_EXT_ADDRESS_SRC,
4777 SADB_EXT_ADDRESS_DST, SADB_EXT_ADDRESS_PROXY, SADB_EXT_KEY_AUTH,
4778 SADB_EXT_KEY_ENCRYPT, SADB_EXT_IDENTITY_SRC,
4779 SADB_EXT_IDENTITY_DST, SADB_EXT_SENSITIVITY,
4780 };
4781
4782 m = key_setsadbmsg(type, 0, satype, seq, pid, (u_int16_t)sav->refcnt);
4783 if (m == NULL) {
4784 goto fail;
4785 }
4786 result = m;
4787
4788 for (i = sizeof(dumporder) / sizeof(dumporder[0]) - 1; i >= 0; i--) {
4789 m = NULL;
4790 p = NULL;
4791 switch (dumporder[i]) {
4792 case SADB_EXT_SA:
4793 m = key_setsadbsa(sav);
4794 if (!m) {
4795 goto fail;
4796 }
4797 break;
4798
4799 case SADB_X_EXT_SA2:
4800 m = key_setsadbxsa2(sav->sah->saidx.mode,
4801 sav->replay[0] ? sav->replay[0]->count : 0,
4802 sav->sah->saidx.reqid,
4803 sav->flags2);
4804 if (!m) {
4805 goto fail;
4806 }
4807 break;
4808
4809 case SADB_EXT_ADDRESS_SRC:
4810 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
4811 (struct sockaddr *)&sav->sah->saidx.src,
4812 FULLMASK, IPSEC_ULPROTO_ANY);
4813 if (!m) {
4814 goto fail;
4815 }
4816 break;
4817
4818 case SADB_EXT_ADDRESS_DST:
4819 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
4820 (struct sockaddr *)&sav->sah->saidx.dst,
4821 FULLMASK, IPSEC_ULPROTO_ANY);
4822 if (!m) {
4823 goto fail;
4824 }
4825 break;
4826
4827 case SADB_EXT_KEY_AUTH:
4828 if (!sav->key_auth) {
4829 continue;
4830 }
4831 l = PFKEY_UNUNIT64(sav->key_auth->sadb_key_len);
4832 p = sav->key_auth;
4833 break;
4834
4835 case SADB_EXT_KEY_ENCRYPT:
4836 if (!sav->key_enc) {
4837 continue;
4838 }
4839 l = PFKEY_UNUNIT64(sav->key_enc->sadb_key_len);
4840 p = sav->key_enc;
4841 break;
4842
4843 case SADB_EXT_LIFETIME_CURRENT:
4844 if (!sav->lft_c) {
4845 continue;
4846 }
4847 l = PFKEY_UNUNIT64(((struct sadb_ext *)sav->lft_c)->sadb_ext_len);
4848 p = sav->lft_c;
4849 break;
4850
4851 case SADB_EXT_LIFETIME_HARD:
4852 if (!sav->lft_h) {
4853 continue;
4854 }
4855 l = PFKEY_UNUNIT64(((struct sadb_ext *)sav->lft_h)->sadb_ext_len);
4856 p = sav->lft_h;
4857 break;
4858
4859 case SADB_EXT_LIFETIME_SOFT:
4860 if (!sav->lft_s) {
4861 continue;
4862 }
4863 l = PFKEY_UNUNIT64(((struct sadb_ext *)sav->lft_s)->sadb_ext_len);
4864 p = sav->lft_s;
4865 break;
4866
4867 case SADB_EXT_ADDRESS_PROXY:
4868 case SADB_EXT_IDENTITY_SRC:
4869 case SADB_EXT_IDENTITY_DST:
4870 /* XXX: should we brought from SPD ? */
4871 case SADB_EXT_SENSITIVITY:
4872 default:
4873 continue;
4874 }
4875
4876 if ((!m && !p) || (m && p)) {
4877 goto fail;
4878 }
4879 if (p && tres) {
4880 M_PREPEND(tres, l, M_WAITOK, 1);
4881 if (!tres) {
4882 goto fail;
4883 }
4884 bcopy(p, mtod(tres, caddr_t), l);
4885 continue;
4886 }
4887 if (p) {
4888 m = key_alloc_mbuf(l);
4889 if (!m) {
4890 goto fail;
4891 }
4892 m_copyback(m, 0, l, p);
4893 }
4894
4895 if (tres) {
4896 m_cat(m, tres);
4897 }
4898 tres = m;
4899 }
4900
4901 m_cat(result, tres);
4902
4903 if (sav->sah && (sav->sah->outgoing_if || sav->sah->ipsec_if)) {
4904 m = key_setsadbipsecif(NULL, ifindex2ifnet[sav->sah->outgoing_if], sav->sah->ipsec_if, 0);
4905 if (!m) {
4906 goto fail;
4907 }
4908 m_cat(result, m);
4909 }
4910
4911 if (result->m_len < sizeof(struct sadb_msg)) {
4912 result = m_pullup(result, sizeof(struct sadb_msg));
4913 if (result == NULL) {
4914 goto fail;
4915 }
4916 }
4917
4918 result->m_pkthdr.len = 0;
4919 for (m = result; m; m = m->m_next) {
4920 result->m_pkthdr.len += m->m_len;
4921 }
4922
4923 VERIFY(PFKEY_UNIT64(result->m_pkthdr.len) <= UINT16_MAX);
4924 mtod(result, struct sadb_msg *)->sadb_msg_len =
4925 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
4926
4927 return result;
4928
4929 fail:
4930 m_freem(result);
4931 m_freem(tres);
4932 return NULL;
4933 }
4934
4935 /*
4936 * set data into sadb_msg.
4937 */
4938 static struct mbuf *
key_setsadbmsg(u_int8_t type,u_int16_t tlen,u_int8_t satype,u_int32_t seq,pid_t pid,u_int16_t reserved)4939 key_setsadbmsg(
4940 u_int8_t type,
4941 u_int16_t tlen,
4942 u_int8_t satype,
4943 u_int32_t seq,
4944 pid_t pid,
4945 u_int16_t reserved)
4946 {
4947 struct mbuf *m;
4948 struct sadb_msg *p;
4949 int len;
4950
4951 len = PFKEY_ALIGN8(sizeof(struct sadb_msg));
4952 if (len > MCLBYTES) {
4953 return NULL;
4954 }
4955 MGETHDR(m, M_DONTWAIT, MT_DATA);
4956 if (m && len > MHLEN) {
4957 MCLGET(m, M_DONTWAIT);
4958 if ((m->m_flags & M_EXT) == 0) {
4959 m_freem(m);
4960 m = NULL;
4961 }
4962 }
4963 if (!m) {
4964 return NULL;
4965 }
4966 m->m_pkthdr.len = m->m_len = len;
4967 m->m_next = NULL;
4968
4969 p = mtod(m, struct sadb_msg *);
4970
4971 bzero(p, len);
4972 p->sadb_msg_version = PF_KEY_V2;
4973 p->sadb_msg_type = type;
4974 p->sadb_msg_errno = 0;
4975 p->sadb_msg_satype = satype;
4976 p->sadb_msg_len = PFKEY_UNIT64(tlen);
4977 p->sadb_msg_reserved = reserved;
4978 p->sadb_msg_seq = seq;
4979 p->sadb_msg_pid = (u_int32_t)pid;
4980
4981 return m;
4982 }
4983
4984 /*
4985 * copy secasvar data into sadb_address.
4986 */
4987 static struct mbuf *
key_setsadbsa(struct secasvar * sav)4988 key_setsadbsa(
4989 struct secasvar *sav)
4990 {
4991 struct mbuf *m;
4992 struct sadb_sa *p;
4993 u_int16_t len;
4994
4995 len = PFKEY_ALIGN8(sizeof(struct sadb_sa));
4996 m = key_alloc_mbuf(len);
4997 if (!m || m->m_next) { /*XXX*/
4998 if (m) {
4999 m_freem(m);
5000 }
5001 return NULL;
5002 }
5003
5004 p = mtod(m, struct sadb_sa *);
5005
5006 bzero(p, len);
5007 p->sadb_sa_len = PFKEY_UNIT64(len);
5008 p->sadb_sa_exttype = SADB_EXT_SA;
5009 p->sadb_sa_spi = sav->spi;
5010 p->sadb_sa_replay = (sav->replay[0] != NULL ? sav->replay[0]->wsize : 0);
5011 p->sadb_sa_state = sav->state;
5012 p->sadb_sa_auth = sav->alg_auth;
5013 p->sadb_sa_encrypt = sav->alg_enc;
5014 p->sadb_sa_flags = sav->flags;
5015
5016 return m;
5017 }
5018
5019 /*
5020 * set data into sadb_address.
5021 */
5022 static struct mbuf *
key_setsadbaddr(u_int16_t exttype,struct sockaddr * saddr,size_t prefixlen,u_int8_t ul_proto)5023 key_setsadbaddr(
5024 u_int16_t exttype,
5025 struct sockaddr *saddr,
5026 size_t prefixlen,
5027 u_int8_t ul_proto)
5028 {
5029 struct mbuf *m;
5030 struct sadb_address *p;
5031 u_int16_t len;
5032
5033 len = PFKEY_ALIGN8(sizeof(struct sadb_address)) +
5034 PFKEY_ALIGN8(saddr->sa_len);
5035 m = key_alloc_mbuf(len);
5036 if (!m || m->m_next) { /*XXX*/
5037 if (m) {
5038 m_freem(m);
5039 }
5040 return NULL;
5041 }
5042
5043 p = mtod(m, struct sadb_address *);
5044
5045 bzero(p, len);
5046 p->sadb_address_len = PFKEY_UNIT64(len);
5047 p->sadb_address_exttype = exttype;
5048 p->sadb_address_proto = ul_proto;
5049 if (prefixlen == FULLMASK) {
5050 switch (saddr->sa_family) {
5051 case AF_INET:
5052 prefixlen = sizeof(struct in_addr) << 3;
5053 break;
5054 case AF_INET6:
5055 prefixlen = sizeof(struct in6_addr) << 3;
5056 break;
5057 default:
5058 ; /*XXX*/
5059 }
5060 }
5061 if (prefixlen >= UINT8_MAX) {
5062 ipseclog((LOG_ERR, "key_setsadbaddr: bad prefix length %zu", prefixlen));
5063 m_freem(m);
5064 return NULL;
5065 }
5066 p->sadb_address_prefixlen = (u_int8_t)prefixlen;
5067 p->sadb_address_reserved = 0;
5068
5069 bcopy(saddr,
5070 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(struct sadb_address)),
5071 saddr->sa_len);
5072
5073 return m;
5074 }
5075
5076 static struct mbuf *
key_setsadbipsecif(ifnet_t internal_if,ifnet_t outgoing_if,ifnet_t ipsec_if,u_int8_t init_disabled)5077 key_setsadbipsecif(ifnet_t internal_if,
5078 ifnet_t outgoing_if,
5079 ifnet_t ipsec_if,
5080 u_int8_t init_disabled)
5081 {
5082 struct mbuf *m;
5083 struct sadb_x_ipsecif *p;
5084 u_int16_t len;
5085
5086 len = PFKEY_ALIGN8(sizeof(struct sadb_x_ipsecif));
5087 m = key_alloc_mbuf(len);
5088 if (!m || m->m_next) { /*XXX*/
5089 if (m) {
5090 m_freem(m);
5091 }
5092 return NULL;
5093 }
5094
5095 p = mtod(m, struct sadb_x_ipsecif *);
5096
5097 bzero(p, len);
5098 p->sadb_x_ipsecif_len = PFKEY_UNIT64(len);
5099 p->sadb_x_ipsecif_exttype = SADB_X_EXT_IPSECIF;
5100
5101 if (internal_if && internal_if->if_xname) {
5102 strlcpy(p->sadb_x_ipsecif_internal_if, internal_if->if_xname, IFXNAMSIZ);
5103 }
5104 if (outgoing_if && outgoing_if->if_xname) {
5105 strlcpy(p->sadb_x_ipsecif_outgoing_if, outgoing_if->if_xname, IFXNAMSIZ);
5106 }
5107 if (ipsec_if && ipsec_if->if_xname) {
5108 strlcpy(p->sadb_x_ipsecif_ipsec_if, ipsec_if->if_xname, IFXNAMSIZ);
5109 }
5110
5111 p->sadb_x_ipsecif_init_disabled = init_disabled;
5112
5113 return m;
5114 }
5115
5116 /*
5117 * set data into sadb_session_id
5118 */
5119 static struct mbuf *
key_setsadbsession_id(u_int64_t session_ids[])5120 key_setsadbsession_id(u_int64_t session_ids[])
5121 {
5122 struct mbuf *m;
5123 struct sadb_session_id *p;
5124 u_int16_t len;
5125
5126 len = PFKEY_ALIGN8(sizeof(*p));
5127 m = key_alloc_mbuf(len);
5128 if (!m || m->m_next) { /*XXX*/
5129 if (m) {
5130 m_freem(m);
5131 }
5132 return NULL;
5133 }
5134
5135 p = mtod(m, __typeof__(p));
5136
5137 bzero(p, len);
5138 p->sadb_session_id_len = PFKEY_UNIT64(len);
5139 p->sadb_session_id_exttype = SADB_EXT_SESSION_ID;
5140 p->sadb_session_id_v[0] = session_ids[0];
5141 p->sadb_session_id_v[1] = session_ids[1];
5142
5143 return m;
5144 }
5145
5146 /*
5147 * copy stats data into sadb_sastat type.
5148 */
5149 static struct mbuf *
key_setsadbsastat(u_int32_t dir,struct sastat * stats,u_int32_t max_stats)5150 key_setsadbsastat(u_int32_t dir,
5151 struct sastat *stats,
5152 u_int32_t max_stats)
5153 {
5154 struct mbuf *m;
5155 struct sadb_sastat *p;
5156 size_t list_len, len;
5157
5158 if (!stats) {
5159 return NULL;
5160 }
5161
5162 list_len = sizeof(*stats) * max_stats;
5163 len = PFKEY_ALIGN8(sizeof(*p)) + PFKEY_ALIGN8(list_len);
5164 if (PFKEY_UNIT64(len) >= UINT16_MAX) {
5165 ipseclog((LOG_ERR, "key_setsadbsastat: length is too big: %zu\n", len));
5166 return NULL;
5167 }
5168
5169 m = key_alloc_mbuf((int)len);
5170 if (!m || m->m_next) { /*XXX*/
5171 if (m) {
5172 m_freem(m);
5173 }
5174 return NULL;
5175 }
5176
5177 p = mtod(m, __typeof__(p));
5178
5179 bzero(p, len);
5180 p->sadb_sastat_len = (u_int16_t)PFKEY_UNIT64(len);
5181 p->sadb_sastat_exttype = SADB_EXT_SASTAT;
5182 p->sadb_sastat_dir = dir;
5183 p->sadb_sastat_list_len = max_stats;
5184 if (list_len) {
5185 bcopy(stats,
5186 mtod(m, caddr_t) + PFKEY_ALIGN8(sizeof(*p)),
5187 list_len);
5188 }
5189
5190 return m;
5191 }
5192
5193 /*
5194 * set data into sadb_x_sa2.
5195 */
5196 static struct mbuf *
key_setsadbxsa2(u_int8_t mode,u_int32_t seq,u_int32_t reqid,u_int16_t flags)5197 key_setsadbxsa2(
5198 u_int8_t mode,
5199 u_int32_t seq,
5200 u_int32_t reqid,
5201 u_int16_t flags)
5202 {
5203 struct mbuf *m;
5204 struct sadb_x_sa2 *p;
5205 u_int16_t len;
5206
5207 len = PFKEY_ALIGN8(sizeof(struct sadb_x_sa2));
5208 m = key_alloc_mbuf(len);
5209 if (!m || m->m_next) { /*XXX*/
5210 if (m) {
5211 m_freem(m);
5212 }
5213 return NULL;
5214 }
5215
5216 p = mtod(m, struct sadb_x_sa2 *);
5217
5218 bzero(p, len);
5219 p->sadb_x_sa2_len = PFKEY_UNIT64(len);
5220 p->sadb_x_sa2_exttype = SADB_X_EXT_SA2;
5221 p->sadb_x_sa2_mode = mode;
5222 p->sadb_x_sa2_reserved1 = 0;
5223 p->sadb_x_sa2_reserved2 = 0;
5224 p->sadb_x_sa2_sequence = seq;
5225 p->sadb_x_sa2_reqid = reqid;
5226 p->sadb_x_sa2_flags = flags;
5227
5228 return m;
5229 }
5230
5231 /*
5232 * set data into sadb_x_policy
5233 */
5234 static struct mbuf *
key_setsadbxpolicy(u_int16_t type,u_int8_t dir,u_int32_t id)5235 key_setsadbxpolicy(
5236 u_int16_t type,
5237 u_int8_t dir,
5238 u_int32_t id)
5239 {
5240 struct mbuf *m;
5241 struct sadb_x_policy *p;
5242 u_int16_t len;
5243
5244 len = PFKEY_ALIGN8(sizeof(struct sadb_x_policy));
5245 m = key_alloc_mbuf(len);
5246 if (!m || m->m_next) { /*XXX*/
5247 if (m) {
5248 m_freem(m);
5249 }
5250 return NULL;
5251 }
5252
5253 p = mtod(m, struct sadb_x_policy *);
5254
5255 bzero(p, len);
5256 p->sadb_x_policy_len = PFKEY_UNIT64(len);
5257 p->sadb_x_policy_exttype = SADB_X_EXT_POLICY;
5258 p->sadb_x_policy_type = type;
5259 p->sadb_x_policy_dir = dir;
5260 p->sadb_x_policy_id = id;
5261
5262 return m;
5263 }
5264
5265 /* %%% utilities */
5266 /*
5267 * copy a buffer into the new buffer allocated.
5268 */
5269 static void *
key_newbuf(const void * src,u_int len)5270 key_newbuf(
5271 const void *src,
5272 u_int len)
5273 {
5274 caddr_t new;
5275
5276 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
5277 new = kalloc_data(len, Z_NOWAIT);
5278 if (new == NULL) {
5279 lck_mtx_unlock(sadb_mutex);
5280 new = kalloc_data(len, Z_WAITOK | Z_NOFAIL);
5281 lck_mtx_lock(sadb_mutex);
5282 }
5283 bcopy(src, new, len);
5284
5285 return new;
5286 }
5287
5288 /* compare my own address
5289 * OUT: 1: true, i.e. my address.
5290 * 0: false
5291 */
5292 int
key_ismyaddr(struct sockaddr * sa)5293 key_ismyaddr(
5294 struct sockaddr *sa)
5295 {
5296 #if INET
5297 struct sockaddr_in *sin;
5298 struct in_ifaddr *ia;
5299 #endif
5300
5301 /* sanity check */
5302 if (sa == NULL) {
5303 panic("key_ismyaddr: NULL pointer is passed.");
5304 }
5305
5306 switch (sa->sa_family) {
5307 #if INET
5308 case AF_INET:
5309 lck_rw_lock_shared(&in_ifaddr_rwlock);
5310 sin = (struct sockaddr_in *)(void *)sa;
5311 for (ia = in_ifaddrhead.tqh_first; ia;
5312 ia = ia->ia_link.tqe_next) {
5313 IFA_LOCK_SPIN(&ia->ia_ifa);
5314 if (sin->sin_family == ia->ia_addr.sin_family &&
5315 sin->sin_len == ia->ia_addr.sin_len &&
5316 sin->sin_addr.s_addr == ia->ia_addr.sin_addr.s_addr) {
5317 IFA_UNLOCK(&ia->ia_ifa);
5318 lck_rw_done(&in_ifaddr_rwlock);
5319 return 1;
5320 }
5321 IFA_UNLOCK(&ia->ia_ifa);
5322 }
5323 lck_rw_done(&in_ifaddr_rwlock);
5324 break;
5325 #endif
5326 case AF_INET6:
5327 return key_ismyaddr6((struct sockaddr_in6 *)(void *)sa);
5328 }
5329
5330 return 0;
5331 }
5332
5333 /*
5334 * compare my own address for IPv6.
5335 * 1: ours
5336 * 0: other
5337 * NOTE: derived ip6_input() in KAME. This is necessary to modify more.
5338 */
5339 #include <netinet6/in6_var.h>
5340
5341 static int
key_ismyaddr6(struct sockaddr_in6 * sin6)5342 key_ismyaddr6(
5343 struct sockaddr_in6 *sin6)
5344 {
5345 struct in6_ifaddr *ia;
5346 struct in6_multi *in6m;
5347
5348 lck_rw_lock_shared(&in6_ifaddr_rwlock);
5349 TAILQ_FOREACH(ia, &in6_ifaddrhead, ia6_link) {
5350 IFA_LOCK(&ia->ia_ifa);
5351 if (key_sockaddrcmp((struct sockaddr *)&sin6,
5352 (struct sockaddr *)&ia->ia_addr, 0) == 0) {
5353 IFA_UNLOCK(&ia->ia_ifa);
5354 lck_rw_done(&in6_ifaddr_rwlock);
5355 return 1;
5356 }
5357 IFA_UNLOCK(&ia->ia_ifa);
5358
5359 /*
5360 * XXX Multicast
5361 * XXX why do we care about multlicast here while we don't care
5362 * about IPv4 multicast??
5363 * XXX scope
5364 */
5365 in6m = NULL;
5366 in6_multihead_lock_shared();
5367 IN6_LOOKUP_MULTI(&sin6->sin6_addr, ia->ia_ifp, in6m);
5368 in6_multihead_lock_done();
5369 if (in6m != NULL) {
5370 lck_rw_done(&in6_ifaddr_rwlock);
5371 IN6M_REMREF(in6m);
5372 return 1;
5373 }
5374 }
5375 lck_rw_done(&in6_ifaddr_rwlock);
5376
5377 /* loopback, just for safety */
5378 if (IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr)) {
5379 return 1;
5380 }
5381
5382 return 0;
5383 }
5384
5385 /*
5386 * compare two secasindex structure.
5387 * flag can specify to compare 2 saidxes.
5388 * compare two secasindex structure without both mode and reqid.
5389 * don't compare port.
5390 * IN:
5391 * saidx0: source, it can be in SAD.
5392 * saidx1: object.
5393 * OUT:
5394 * 1 : equal
5395 * 0 : not equal
5396 */
5397 static int
key_cmpsaidx(struct secasindex * saidx0,struct secasindex * saidx1,int flag)5398 key_cmpsaidx(
5399 struct secasindex *saidx0,
5400 struct secasindex *saidx1,
5401 int flag)
5402 {
5403 /* sanity */
5404 if (saidx0 == NULL && saidx1 == NULL) {
5405 return 1;
5406 }
5407
5408 if (saidx0 == NULL || saidx1 == NULL) {
5409 return 0;
5410 }
5411
5412 if (saidx0->ipsec_ifindex != 0 && saidx0->ipsec_ifindex != saidx1->ipsec_ifindex) {
5413 return 0;
5414 }
5415
5416 if (saidx0->proto != saidx1->proto) {
5417 return 0;
5418 }
5419
5420 if (flag == CMP_EXACTLY) {
5421 if (saidx0->mode != saidx1->mode) {
5422 return 0;
5423 }
5424 if (saidx0->reqid != saidx1->reqid) {
5425 return 0;
5426 }
5427 if (bcmp(&saidx0->src, &saidx1->src, saidx0->src.ss_len) != 0 ||
5428 bcmp(&saidx0->dst, &saidx1->dst, saidx0->dst.ss_len) != 0) {
5429 return 0;
5430 }
5431 } else {
5432 /* CMP_MODE_REQID, CMP_REQID, CMP_HEAD */
5433 if (flag & CMP_REQID) {
5434 /*
5435 * If reqid of SPD is non-zero, unique SA is required.
5436 * The result must be of same reqid in this case.
5437 */
5438 if (saidx1->reqid != 0 && saidx0->reqid != saidx1->reqid) {
5439 return 0;
5440 }
5441 }
5442
5443 if (flag & CMP_MODE) {
5444 if (saidx0->mode != IPSEC_MODE_ANY
5445 && saidx0->mode != saidx1->mode) {
5446 return 0;
5447 }
5448 }
5449
5450 if (key_sockaddrcmp((struct sockaddr *)&saidx0->src,
5451 (struct sockaddr *)&saidx1->src, flag & CMP_PORT ? 1 : 0) != 0) {
5452 return 0;
5453 }
5454 if (key_sockaddrcmp((struct sockaddr *)&saidx0->dst,
5455 (struct sockaddr *)&saidx1->dst, flag & CMP_PORT ? 1 : 0) != 0) {
5456 return 0;
5457 }
5458 }
5459
5460 return 1;
5461 }
5462
5463 /*
5464 * compare two secindex structure exactly.
5465 * IN:
5466 * spidx0: source, it is often in SPD.
5467 * spidx1: object, it is often from PFKEY message.
5468 * OUT:
5469 * 1 : equal
5470 * 0 : not equal
5471 */
5472 static int
key_cmpspidx_exactly(struct secpolicyindex * spidx0,struct secpolicyindex * spidx1)5473 key_cmpspidx_exactly(
5474 struct secpolicyindex *spidx0,
5475 struct secpolicyindex *spidx1)
5476 {
5477 /* sanity */
5478 if (spidx0 == NULL && spidx1 == NULL) {
5479 return 1;
5480 }
5481
5482 if (spidx0 == NULL || spidx1 == NULL) {
5483 return 0;
5484 }
5485
5486 if (spidx0->prefs != spidx1->prefs
5487 || spidx0->prefd != spidx1->prefd
5488 || spidx0->ul_proto != spidx1->ul_proto
5489 || spidx0->internal_if != spidx1->internal_if) {
5490 return 0;
5491 }
5492
5493 if (key_sockaddrcmp((struct sockaddr *)&spidx0->src,
5494 (struct sockaddr *)&spidx1->src, 1) != 0) {
5495 return 0;
5496 }
5497 if (key_sockaddrcmp((struct sockaddr *)&spidx0->dst,
5498 (struct sockaddr *)&spidx1->dst, 1) != 0) {
5499 return 0;
5500 }
5501
5502 if (key_sockaddrcmp((struct sockaddr *)&spidx0->src_range.start,
5503 (struct sockaddr *)&spidx1->src_range.start, 1) != 0) {
5504 return 0;
5505 }
5506 if (key_sockaddrcmp((struct sockaddr *)&spidx0->src_range.end,
5507 (struct sockaddr *)&spidx1->src_range.end, 1) != 0) {
5508 return 0;
5509 }
5510 if (key_sockaddrcmp((struct sockaddr *)&spidx0->dst_range.start,
5511 (struct sockaddr *)&spidx1->dst_range.start, 1) != 0) {
5512 return 0;
5513 }
5514 if (key_sockaddrcmp((struct sockaddr *)&spidx0->dst_range.end,
5515 (struct sockaddr *)&spidx1->dst_range.end, 1) != 0) {
5516 return 0;
5517 }
5518
5519 return 1;
5520 }
5521
5522 /*
5523 * compare two secindex structure with mask.
5524 * IN:
5525 * spidx0: source, it is often in SPD.
5526 * spidx1: object, it is often from IP header.
5527 * OUT:
5528 * 1 : equal
5529 * 0 : not equal
5530 */
5531 static int
key_cmpspidx_withmask(struct secpolicyindex * spidx0,struct secpolicyindex * spidx1)5532 key_cmpspidx_withmask(
5533 struct secpolicyindex *spidx0,
5534 struct secpolicyindex *spidx1)
5535 {
5536 int spidx0_src_is_range = 0;
5537 int spidx0_dst_is_range = 0;
5538
5539 /* sanity */
5540 if (spidx0 == NULL && spidx1 == NULL) {
5541 return 1;
5542 }
5543
5544 if (spidx0 == NULL || spidx1 == NULL) {
5545 return 0;
5546 }
5547
5548 if (spidx0->src_range.start.ss_len > 0) {
5549 spidx0_src_is_range = 1;
5550 }
5551
5552 if (spidx0->dst_range.start.ss_len > 0) {
5553 spidx0_dst_is_range = 1;
5554 }
5555
5556 if ((spidx0_src_is_range ? spidx0->src_range.start.ss_family : spidx0->src.ss_family) != spidx1->src.ss_family ||
5557 (spidx0_dst_is_range ? spidx0->dst_range.start.ss_family : spidx0->dst.ss_family) != spidx1->dst.ss_family ||
5558 (spidx0_src_is_range ? spidx0->src_range.start.ss_len : spidx0->src.ss_len) != spidx1->src.ss_len ||
5559 (spidx0_dst_is_range ? spidx0->dst_range.start.ss_len : spidx0->dst.ss_len) != spidx1->dst.ss_len) {
5560 return 0;
5561 }
5562
5563 /* if spidx.ul_proto == IPSEC_ULPROTO_ANY, ignore. */
5564 if (spidx0->ul_proto != (u_int16_t)IPSEC_ULPROTO_ANY
5565 && spidx0->ul_proto != spidx1->ul_proto) {
5566 return 0;
5567 }
5568
5569 /* If spidx1 specifies interface, ignore src addr */
5570 if (spidx1->internal_if != NULL) {
5571 if (spidx0->internal_if == NULL
5572 || spidx0->internal_if != spidx1->internal_if) {
5573 return 0;
5574 }
5575
5576 /* Still check ports */
5577 switch (spidx0->src.ss_family) {
5578 case AF_INET:
5579 if (spidx0_src_is_range &&
5580 (satosin(&spidx1->src)->sin_port < satosin(&spidx0->src_range.start)->sin_port
5581 || satosin(&spidx1->src)->sin_port > satosin(&spidx0->src_range.end)->sin_port)) {
5582 return 0;
5583 } else if (satosin(&spidx0->src)->sin_port != IPSEC_PORT_ANY
5584 && satosin(&spidx0->src)->sin_port !=
5585 satosin(&spidx1->src)->sin_port) {
5586 return 0;
5587 }
5588 break;
5589 case AF_INET6:
5590 if (spidx0_src_is_range &&
5591 (satosin6(&spidx1->src)->sin6_port < satosin6(&spidx0->src_range.start)->sin6_port
5592 || satosin6(&spidx1->src)->sin6_port > satosin6(&spidx0->src_range.end)->sin6_port)) {
5593 return 0;
5594 } else if (satosin6(&spidx0->src)->sin6_port != IPSEC_PORT_ANY
5595 && satosin6(&spidx0->src)->sin6_port !=
5596 satosin6(&spidx1->src)->sin6_port) {
5597 return 0;
5598 }
5599 break;
5600 default:
5601 break;
5602 }
5603 } else if (spidx0_src_is_range) {
5604 if (!key_is_addr_in_range(&spidx1->src, &spidx0->src_range)) {
5605 return 0;
5606 }
5607 } else {
5608 switch (spidx0->src.ss_family) {
5609 case AF_INET:
5610 if (satosin(&spidx0->src)->sin_port != IPSEC_PORT_ANY
5611 && satosin(&spidx0->src)->sin_port !=
5612 satosin(&spidx1->src)->sin_port) {
5613 return 0;
5614 }
5615 if (!key_bbcmp((caddr_t)&satosin(&spidx0->src)->sin_addr,
5616 (caddr_t)&satosin(&spidx1->src)->sin_addr, spidx0->prefs)) {
5617 return 0;
5618 }
5619 break;
5620 case AF_INET6:
5621 if (satosin6(&spidx0->src)->sin6_port != IPSEC_PORT_ANY
5622 && satosin6(&spidx0->src)->sin6_port !=
5623 satosin6(&spidx1->src)->sin6_port) {
5624 return 0;
5625 }
5626 /*
5627 * scope_id check. if sin6_scope_id is 0, we regard it
5628 * as a wildcard scope, which matches any scope zone ID.
5629 */
5630 if (satosin6(&spidx0->src)->sin6_scope_id &&
5631 satosin6(&spidx1->src)->sin6_scope_id &&
5632 satosin6(&spidx0->src)->sin6_scope_id !=
5633 satosin6(&spidx1->src)->sin6_scope_id) {
5634 return 0;
5635 }
5636 if (!key_bbcmp((caddr_t)&satosin6(&spidx0->src)->sin6_addr,
5637 (caddr_t)&satosin6(&spidx1->src)->sin6_addr, spidx0->prefs)) {
5638 return 0;
5639 }
5640 break;
5641 default:
5642 /* XXX */
5643 if (bcmp(&spidx0->src, &spidx1->src, spidx0->src.ss_len) != 0) {
5644 return 0;
5645 }
5646 break;
5647 }
5648 }
5649
5650 if (spidx0_dst_is_range) {
5651 if (!key_is_addr_in_range(&spidx1->dst, &spidx0->dst_range)) {
5652 return 0;
5653 }
5654 } else {
5655 switch (spidx0->dst.ss_family) {
5656 case AF_INET:
5657 if (satosin(&spidx0->dst)->sin_port != IPSEC_PORT_ANY
5658 && satosin(&spidx0->dst)->sin_port !=
5659 satosin(&spidx1->dst)->sin_port) {
5660 return 0;
5661 }
5662 if (!key_bbcmp((caddr_t)&satosin(&spidx0->dst)->sin_addr,
5663 (caddr_t)&satosin(&spidx1->dst)->sin_addr, spidx0->prefd)) {
5664 return 0;
5665 }
5666 break;
5667 case AF_INET6:
5668 if (satosin6(&spidx0->dst)->sin6_port != IPSEC_PORT_ANY
5669 && satosin6(&spidx0->dst)->sin6_port !=
5670 satosin6(&spidx1->dst)->sin6_port) {
5671 return 0;
5672 }
5673 /*
5674 * scope_id check. if sin6_scope_id is 0, we regard it
5675 * as a wildcard scope, which matches any scope zone ID.
5676 */
5677 if (satosin6(&spidx0->src)->sin6_scope_id &&
5678 satosin6(&spidx1->src)->sin6_scope_id &&
5679 satosin6(&spidx0->dst)->sin6_scope_id !=
5680 satosin6(&spidx1->dst)->sin6_scope_id) {
5681 return 0;
5682 }
5683 if (!key_bbcmp((caddr_t)&satosin6(&spidx0->dst)->sin6_addr,
5684 (caddr_t)&satosin6(&spidx1->dst)->sin6_addr, spidx0->prefd)) {
5685 return 0;
5686 }
5687 break;
5688 default:
5689 /* XXX */
5690 if (bcmp(&spidx0->dst, &spidx1->dst, spidx0->dst.ss_len) != 0) {
5691 return 0;
5692 }
5693 break;
5694 }
5695 }
5696
5697 /* XXX Do we check other field ? e.g. flowinfo */
5698
5699 return 1;
5700 }
5701
5702 static int
key_is_addr_in_range(struct sockaddr_storage * addr,struct secpolicyaddrrange * addr_range)5703 key_is_addr_in_range(struct sockaddr_storage *addr, struct secpolicyaddrrange *addr_range)
5704 {
5705 int cmp = 0;
5706
5707 if (addr == NULL || addr_range == NULL) {
5708 return 0;
5709 }
5710
5711 /* Must be greater than or equal to start */
5712 cmp = key_sockaddrcmp((struct sockaddr *)addr, (struct sockaddr *)&addr_range->start, 1);
5713 if (cmp != 0 && cmp != 1) {
5714 return 0;
5715 }
5716
5717 /* Must be less than or equal to end */
5718 cmp = key_sockaddrcmp((struct sockaddr *)addr, (struct sockaddr *)&addr_range->end, 1);
5719 if (cmp != 0 && cmp != -1) {
5720 return 0;
5721 }
5722
5723 return 1;
5724 }
5725
5726 /*
5727 * Return values:
5728 * -1: sa1 < sa2
5729 * 0: sa1 == sa2
5730 * 1: sa1 > sa2
5731 * 2: Not comparable or error
5732 */
5733 static int
key_sockaddrcmp(struct sockaddr * sa1,struct sockaddr * sa2,int port)5734 key_sockaddrcmp(
5735 struct sockaddr *sa1,
5736 struct sockaddr *sa2,
5737 int port)
5738 {
5739 int result = 0;
5740 int port_result = 0;
5741
5742 if (sa1->sa_family != sa2->sa_family || sa1->sa_len != sa2->sa_len) {
5743 return 2;
5744 }
5745
5746 if (sa1->sa_len == 0) {
5747 return 0;
5748 }
5749
5750 switch (sa1->sa_family) {
5751 case AF_INET:
5752 if (sa1->sa_len != sizeof(struct sockaddr_in)) {
5753 return 2;
5754 }
5755
5756 result = memcmp(&satosin(sa1)->sin_addr.s_addr, &satosin(sa2)->sin_addr.s_addr, sizeof(satosin(sa1)->sin_addr.s_addr));
5757
5758 if (port) {
5759 if (satosin(sa1)->sin_port < satosin(sa2)->sin_port) {
5760 port_result = -1;
5761 } else if (satosin(sa1)->sin_port > satosin(sa2)->sin_port) {
5762 port_result = 1;
5763 }
5764
5765 if (result == 0) {
5766 result = port_result;
5767 } else if ((result > 0 && port_result < 0) || (result < 0 && port_result > 0)) {
5768 return 2;
5769 }
5770 }
5771
5772 break;
5773 case AF_INET6:
5774 if (sa1->sa_len != sizeof(struct sockaddr_in6)) {
5775 return 2; /*EINVAL*/
5776 }
5777 if (satosin6(sa1)->sin6_scope_id !=
5778 satosin6(sa2)->sin6_scope_id) {
5779 return 2;
5780 }
5781
5782 result = memcmp(&satosin6(sa1)->sin6_addr.s6_addr[0], &satosin6(sa2)->sin6_addr.s6_addr[0], sizeof(struct in6_addr));
5783
5784 if (port) {
5785 if (satosin6(sa1)->sin6_port < satosin6(sa2)->sin6_port) {
5786 port_result = -1;
5787 } else if (satosin6(sa1)->sin6_port > satosin6(sa2)->sin6_port) {
5788 port_result = 1;
5789 }
5790
5791 if (result == 0) {
5792 result = port_result;
5793 } else if ((result > 0 && port_result < 0) || (result < 0 && port_result > 0)) {
5794 return 2;
5795 }
5796 }
5797
5798 break;
5799 default:
5800 result = memcmp(sa1, sa2, sa1->sa_len);
5801 break;
5802 }
5803
5804 if (result < 0) {
5805 result = -1;
5806 } else if (result > 0) {
5807 result = 1;
5808 }
5809
5810 return result;
5811 }
5812
5813 /*
5814 * compare two buffers with mask.
5815 * IN:
5816 * addr1: source
5817 * addr2: object
5818 * bits: Number of bits to compare
5819 * OUT:
5820 * 1 : equal
5821 * 0 : not equal
5822 */
5823 static int
key_bbcmp(caddr_t p1,caddr_t p2,u_int bits)5824 key_bbcmp(
5825 caddr_t p1,
5826 caddr_t p2,
5827 u_int bits)
5828 {
5829 u_int8_t mask;
5830
5831 /* XXX: This could be considerably faster if we compare a word
5832 * at a time, but it is complicated on LSB Endian machines */
5833
5834 /* Handle null pointers */
5835 if (p1 == NULL || p2 == NULL) {
5836 return p1 == p2;
5837 }
5838
5839 while (bits >= 8) {
5840 if (*p1++ != *p2++) {
5841 return 0;
5842 }
5843 bits -= 8;
5844 }
5845
5846 if (bits > 0) {
5847 mask = (u_int8_t)(~((1 << (8 - bits)) - 1));
5848 if ((*p1 & mask) != (*p2 & mask)) {
5849 return 0;
5850 }
5851 }
5852 return 1; /* Match! */
5853 }
5854
5855 /*
5856 * time handler.
5857 * scanning SPD and SAD to check status for each entries,
5858 * and do to remove or to expire.
5859 * XXX: year 2038 problem may remain.
5860 */
5861 int key_timehandler_debug = 0;
5862 u_int32_t spd_count = 0, sah_count = 0, dead_sah_count = 0, empty_sah_count = 0, larval_sav_count = 0, mature_sav_count = 0, dying_sav_count = 0, dead_sav_count = 0;
5863 u_int64_t total_sav_count = 0;
5864 void
key_timehandler(void)5865 key_timehandler(void)
5866 {
5867 u_int dir;
5868 struct timeval tv;
5869 struct secpolicy **spbuf = NULL, **spptr = NULL;
5870 struct secasvar **savexbuf = NULL, **savexptr = NULL;
5871 struct secasvar **savkabuf = NULL, **savkaptr = NULL;
5872 u_int32_t spbufcount = 0, savbufcount = 0, spcount = 0, savexcount = 0, savkacount = 0, cnt;
5873 int stop_handler = 1; /* stop the timehandler */
5874
5875 microtime(&tv);
5876
5877 /* pre-allocate buffers before taking the lock */
5878 /* if allocation failures occur - portions of the processing will be skipped */
5879 if ((spbufcount = ipsec_policy_count) != 0) {
5880 if (os_add_overflow(spbufcount, 256, &spbufcount)) {
5881 ipseclog((LOG_DEBUG, "key_timehandler: spbufcount overflow, ipsec policy count %u.\n", ipsec_policy_count));
5882 spbufcount = ipsec_policy_count;
5883 }
5884
5885 spbuf = kalloc_type(struct secpolicy *, spbufcount, Z_WAITOK);
5886 if (spbuf) {
5887 spptr = spbuf;
5888 }
5889 }
5890 if ((savbufcount = ipsec_sav_count) != 0) {
5891 if (os_add_overflow(savbufcount, 512, &savbufcount)) {
5892 ipseclog((LOG_DEBUG, "key_timehandler: savbufcount overflow, ipsec sa count %u.\n", ipsec_sav_count));
5893 savbufcount = ipsec_sav_count;
5894 }
5895 savexbuf = kalloc_type(struct secasvar *, savbufcount, Z_WAITOK);
5896 if (savexbuf) {
5897 savexptr = savexbuf;
5898 }
5899 savkabuf = kalloc_type(struct secasvar *, savbufcount, Z_WAITOK);
5900 if (savkabuf) {
5901 savkaptr = savkabuf;
5902 }
5903 }
5904 lck_mtx_lock(sadb_mutex);
5905 /* SPD */
5906 if (spbuf) {
5907 struct secpolicy *sp, *nextsp;
5908
5909 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
5910 for (sp = LIST_FIRST(&sptree[dir]);
5911 sp != NULL;
5912 sp = nextsp) {
5913 /* don't prevent timehandler from stopping for generate policy */
5914 if (sp->policy != IPSEC_POLICY_GENERATE) {
5915 stop_handler = 0;
5916 }
5917 spd_count++;
5918 nextsp = LIST_NEXT(sp, chain);
5919
5920 if (sp->state == IPSEC_SPSTATE_DEAD) {
5921 key_freesp(sp, KEY_SADB_LOCKED);
5922 continue;
5923 }
5924
5925 if (sp->lifetime == 0 && sp->validtime == 0) {
5926 continue;
5927 }
5928 if (spbuf && spcount < spbufcount) {
5929 /* the deletion will occur next time */
5930 if ((sp->lifetime
5931 && tv.tv_sec - sp->created > sp->lifetime)
5932 || (sp->validtime
5933 && tv.tv_sec - sp->lastused > sp->validtime)) {
5934 //key_spdexpire(sp);
5935 sp->state = IPSEC_SPSTATE_DEAD;
5936 sp->refcnt++;
5937 *spptr++ = sp;
5938 spcount++;
5939 }
5940 }
5941 }
5942 }
5943 }
5944
5945 /* SAD */
5946 {
5947 struct secashead *sah, *nextsah;
5948 struct secasvar *sav, *nextsav;
5949
5950 for (sah = LIST_FIRST(&sahtree);
5951 sah != NULL;
5952 sah = nextsah) {
5953 sah_count++;
5954 nextsah = LIST_NEXT(sah, chain);
5955
5956 /* if sah has been dead, then delete it and process next sah. */
5957 if (sah->state == SADB_SASTATE_DEAD) {
5958 key_delsah(sah);
5959 dead_sah_count++;
5960 continue;
5961 }
5962
5963 if (LIST_FIRST(&sah->savtree[SADB_SASTATE_LARVAL]) == NULL &&
5964 LIST_FIRST(&sah->savtree[SADB_SASTATE_MATURE]) == NULL &&
5965 LIST_FIRST(&sah->savtree[SADB_SASTATE_DYING]) == NULL &&
5966 LIST_FIRST(&sah->savtree[SADB_SASTATE_DEAD]) == NULL) {
5967 key_delsah(sah);
5968 empty_sah_count++;
5969 continue;
5970 }
5971
5972 if (savbufcount == 0) {
5973 continue;
5974 }
5975
5976 stop_handler = 0;
5977
5978 /* if LARVAL entry doesn't become MATURE, delete it. */
5979 for (sav = LIST_FIRST(&sah->savtree[SADB_SASTATE_LARVAL]);
5980 sav != NULL;
5981 sav = nextsav) {
5982 larval_sav_count++;
5983 total_sav_count++;
5984 nextsav = LIST_NEXT(sav, chain);
5985
5986 if (sav->lft_h != NULL) {
5987 /* If a hard lifetime is defined for the LARVAL SA, use it */
5988 if (sav->lft_h->sadb_lifetime_addtime != 0
5989 && tv.tv_sec - sav->created > sav->lft_h->sadb_lifetime_addtime) {
5990 if (sav->always_expire) {
5991 key_send_delete(sav);
5992 sav = NULL;
5993 } else {
5994 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
5995 key_freesav(sav, KEY_SADB_LOCKED);
5996 sav = NULL;
5997 }
5998 }
5999 } else {
6000 if (tv.tv_sec - sav->created > key_larval_lifetime) {
6001 key_freesav(sav, KEY_SADB_LOCKED);
6002 }
6003 }
6004 }
6005
6006 /*
6007 * If this is a NAT traversal SA with no activity,
6008 * we need to send a keep alive.
6009 *
6010 * Performed outside of the loop before so we will
6011 * only ever send one keepalive. The first SA on
6012 * the list is the one that will be used for sending
6013 * traffic, so this is the one we use for determining
6014 * when to send the keepalive.
6015 */
6016 if (savkabuf && savkacount < savbufcount) {
6017 sav = LIST_FIRST(&sah->savtree[SADB_SASTATE_MATURE]); //%%% should we check dying list if this is empty???
6018 if (sav && (natt_keepalive_interval || sav->natt_interval) &&
6019 (sav->flags & (SADB_X_EXT_NATT_KEEPALIVE | SADB_X_EXT_ESP_KEEPALIVE)) != 0) {
6020 sav->refcnt++;
6021 *savkaptr++ = sav;
6022 savkacount++;
6023 }
6024 }
6025
6026 /*
6027 * check MATURE entry to start to send expire message
6028 * whether or not.
6029 */
6030 for (sav = LIST_FIRST(&sah->savtree[SADB_SASTATE_MATURE]);
6031 sav != NULL;
6032 sav = nextsav) {
6033 mature_sav_count++;
6034 total_sav_count++;
6035 nextsav = LIST_NEXT(sav, chain);
6036
6037 /* we don't need to check. */
6038 if (sav->lft_s == NULL) {
6039 continue;
6040 }
6041
6042 /* sanity check */
6043 if (sav->lft_c == NULL) {
6044 ipseclog((LOG_DEBUG, "key_timehandler: "
6045 "There is no CURRENT time, why?\n"));
6046 continue;
6047 }
6048
6049 /* check SOFT lifetime */
6050 if (sav->lft_s->sadb_lifetime_addtime != 0
6051 && tv.tv_sec - sav->created > sav->lft_s->sadb_lifetime_addtime) {
6052 /*
6053 * If always_expire is set, expire. Otherwise,
6054 * if the SA has not been used, delete immediately.
6055 */
6056 if (sav->lft_c->sadb_lifetime_usetime == 0
6057 && sav->always_expire == 0) {
6058 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
6059 key_freesav(sav, KEY_SADB_LOCKED);
6060 sav = NULL;
6061 } else if (savexbuf && savexcount < savbufcount) {
6062 key_sa_chgstate(sav, SADB_SASTATE_DYING);
6063 sav->refcnt++;
6064 *savexptr++ = sav;
6065 savexcount++;
6066 }
6067 }
6068 /* check SOFT lifetime by bytes */
6069 /*
6070 * XXX I don't know the way to delete this SA
6071 * when new SA is installed. Caution when it's
6072 * installed too big lifetime by time.
6073 */
6074 else if (savexbuf && savexcount < savbufcount
6075 && sav->lft_s->sadb_lifetime_bytes != 0
6076 && sav->lft_s->sadb_lifetime_bytes < sav->lft_c->sadb_lifetime_bytes) {
6077 /*
6078 * XXX If we keep to send expire
6079 * message in the status of
6080 * DYING. Do remove below code.
6081 */
6082 //key_expire(sav);
6083 key_sa_chgstate(sav, SADB_SASTATE_DYING);
6084 sav->refcnt++;
6085 *savexptr++ = sav;
6086 savexcount++;
6087 }
6088 }
6089
6090 /* check DYING entry to change status to DEAD. */
6091 for (sav = LIST_FIRST(&sah->savtree[SADB_SASTATE_DYING]);
6092 sav != NULL;
6093 sav = nextsav) {
6094 dying_sav_count++;
6095 total_sav_count++;
6096 nextsav = LIST_NEXT(sav, chain);
6097
6098 /* we don't need to check. */
6099 if (sav->lft_h == NULL) {
6100 continue;
6101 }
6102
6103 /* sanity check */
6104 if (sav->lft_c == NULL) {
6105 ipseclog((LOG_DEBUG, "key_timehandler: "
6106 "There is no CURRENT time, why?\n"));
6107 continue;
6108 }
6109
6110 if (sav->lft_h->sadb_lifetime_addtime != 0
6111 && tv.tv_sec - sav->created > sav->lft_h->sadb_lifetime_addtime) {
6112 if (sav->always_expire) {
6113 key_send_delete(sav);
6114 sav = NULL;
6115 } else {
6116 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
6117 key_freesav(sav, KEY_SADB_LOCKED);
6118 sav = NULL;
6119 }
6120 }
6121 /* check HARD lifetime by bytes */
6122 else if (sav->lft_h->sadb_lifetime_bytes != 0
6123 && sav->lft_h->sadb_lifetime_bytes < sav->lft_c->sadb_lifetime_bytes) {
6124 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
6125 key_freesav(sav, KEY_SADB_LOCKED);
6126 sav = NULL;
6127 }
6128 }
6129
6130 /* delete entry in DEAD */
6131 for (sav = LIST_FIRST(&sah->savtree[SADB_SASTATE_DEAD]);
6132 sav != NULL;
6133 sav = nextsav) {
6134 dead_sav_count++;
6135 total_sav_count++;
6136 nextsav = LIST_NEXT(sav, chain);
6137
6138 /* sanity check */
6139 if (sav->state != SADB_SASTATE_DEAD) {
6140 ipseclog((LOG_DEBUG, "key_timehandler: "
6141 "invalid sav->state "
6142 "(queue: %d SA: %d): "
6143 "kill it anyway\n",
6144 SADB_SASTATE_DEAD, sav->state));
6145 }
6146
6147 /*
6148 * do not call key_freesav() here.
6149 * sav should already be freed, and sav->refcnt
6150 * shows other references to sav
6151 * (such as from SPD).
6152 */
6153 }
6154 }
6155 }
6156
6157 if (++key_timehandler_debug >= 300) {
6158 if (key_debug_level) {
6159 printf("%s: total stats for %u calls\n", __FUNCTION__, key_timehandler_debug);
6160 printf("%s: walked %u SPDs\n", __FUNCTION__, spd_count);
6161 printf("%s: walked %llu SAs: LARVAL SAs %u, MATURE SAs %u, DYING SAs %u, DEAD SAs %u\n", __FUNCTION__,
6162 total_sav_count, larval_sav_count, mature_sav_count, dying_sav_count, dead_sav_count);
6163 printf("%s: walked %u SAHs: DEAD SAHs %u, EMPTY SAHs %u\n", __FUNCTION__,
6164 sah_count, dead_sah_count, empty_sah_count);
6165 if (sah_search_calls) {
6166 printf("%s: SAH search cost %d iters per call\n", __FUNCTION__,
6167 (sah_search_count / sah_search_calls));
6168 }
6169 }
6170 spd_count = 0;
6171 sah_count = 0;
6172 dead_sah_count = 0;
6173 empty_sah_count = 0;
6174 larval_sav_count = 0;
6175 mature_sav_count = 0;
6176 dying_sav_count = 0;
6177 dead_sav_count = 0;
6178 total_sav_count = 0;
6179 sah_search_count = 0;
6180 sah_search_calls = 0;
6181 key_timehandler_debug = 0;
6182 }
6183 #ifndef IPSEC_NONBLOCK_ACQUIRE
6184 /* ACQ tree */
6185 {
6186 struct secacq *acq, *nextacq;
6187
6188 for (acq = LIST_FIRST(&acqtree);
6189 acq != NULL;
6190 acq = nextacq) {
6191 stop_handler = 0;
6192 nextacq = LIST_NEXT(acq, chain);
6193
6194 if (tv.tv_sec - acq->created > key_blockacq_lifetime
6195 && __LIST_CHAINED(acq)) {
6196 LIST_REMOVE(acq, chain);
6197 kfree_type(struct secacq, acq);
6198 }
6199 }
6200 }
6201 #endif
6202
6203 /* SP ACQ tree */
6204 {
6205 struct secspacq *acq, *nextacq;
6206
6207 for (acq = LIST_FIRST(&spacqtree);
6208 acq != NULL;
6209 acq = nextacq) {
6210 stop_handler = 0;
6211 nextacq = LIST_NEXT(acq, chain);
6212
6213 if (tv.tv_sec - acq->created > key_blockacq_lifetime
6214 && __LIST_CHAINED(acq)) {
6215 LIST_REMOVE(acq, chain);
6216 struct secacq *secacq_p = (struct secacq *)acq;
6217 kfree_type(struct secacq, secacq_p);
6218 }
6219 }
6220 }
6221
6222 /* initialize random seed */
6223 if (key_tick_init_random++ > key_int_random) {
6224 key_tick_init_random = 0;
6225 key_srandom();
6226 }
6227
6228 uint64_t acc_sleep_time = 0;
6229 absolutetime_to_nanoseconds(mach_absolutetime_asleep, &acc_sleep_time);
6230 natt_now = ++up_time + (acc_sleep_time / NSEC_PER_SEC);
6231
6232 lck_mtx_unlock(sadb_mutex);
6233
6234 /* send messages outside of sadb_mutex */
6235 if (spbuf && spcount > 0) {
6236 cnt = spcount;
6237 while (cnt--) {
6238 key_spdexpire(*(--spptr));
6239 }
6240 }
6241 if (savkabuf && savkacount > 0) {
6242 struct secasvar **savkaptr_sav = savkaptr;
6243 u_int32_t cnt_send = savkacount;
6244
6245 while (cnt_send--) {
6246 if (ipsec_send_natt_keepalive(*(--savkaptr))) {
6247 // <rdar://6768487> iterate (all over again) and update timestamps
6248 struct secasvar **savkaptr_update = savkaptr_sav;
6249 u_int32_t cnt_update = savkacount;
6250 while (cnt_update--) {
6251 key_update_natt_keepalive_timestamp(*savkaptr,
6252 *(--savkaptr_update));
6253 }
6254 }
6255 }
6256 }
6257 if (savexbuf && savexcount > 0) {
6258 cnt = savexcount;
6259 while (cnt--) {
6260 key_expire(*(--savexptr));
6261 }
6262 }
6263
6264 /* decrement ref counts and free buffers */
6265 lck_mtx_lock(sadb_mutex);
6266 if (spbuf) {
6267 while (spcount--) {
6268 key_freesp(*spptr++, KEY_SADB_LOCKED);
6269 }
6270 kfree_type(struct secpolicy *, spbufcount, spbuf);
6271 }
6272 if (savkabuf) {
6273 while (savkacount--) {
6274 key_freesav(*savkaptr++, KEY_SADB_LOCKED);
6275 }
6276 kfree_type(struct secasvar *, savbufcount, savkabuf);
6277 }
6278 if (savexbuf) {
6279 while (savexcount--) {
6280 key_freesav(*savexptr++, KEY_SADB_LOCKED);
6281 }
6282 kfree_type(struct secasvar *, savbufcount, savexbuf);
6283 }
6284
6285 if (stop_handler) {
6286 key_timehandler_running = 0;
6287 /* Turn on the ipsec bypass */
6288 ipsec_bypass = 1;
6289 } else {
6290 /* do exchange to tick time !! */
6291 (void)timeout((void *)key_timehandler, (void *)0, hz);
6292 }
6293
6294 lck_mtx_unlock(sadb_mutex);
6295 return;
6296 }
6297
6298 /*
6299 * to initialize a seed for random()
6300 */
6301 static void
key_srandom(void)6302 key_srandom(void)
6303 {
6304 #ifdef __APPLE__
6305 /* Our PRNG is based on Yarrow and doesn't need to be seeded */
6306 random();
6307 #else
6308 struct timeval tv;
6309
6310 microtime(&tv);
6311
6312 srandom(tv.tv_usec);
6313 #endif
6314
6315 return;
6316 }
6317
6318 u_int32_t
key_random(void)6319 key_random(void)
6320 {
6321 u_int32_t value;
6322
6323 key_randomfill(&value, sizeof(value));
6324 return value;
6325 }
6326
6327 void
key_randomfill(void * p,size_t l)6328 key_randomfill(
6329 void *p,
6330 size_t l)
6331 {
6332 #ifdef __APPLE__
6333 cc_rand_generate(p, l);
6334 #else
6335 size_t n;
6336 u_int32_t v;
6337 static int warn = 1;
6338
6339 n = 0;
6340 n = (size_t)read_random(p, (u_int)l);
6341 /* last resort */
6342 while (n < l) {
6343 v = random();
6344 bcopy(&v, (u_int8_t *)p + n,
6345 l - n < sizeof(v) ? l - n : sizeof(v));
6346 n += sizeof(v);
6347
6348 if (warn) {
6349 printf("WARNING: pseudo-random number generator "
6350 "used for IPsec processing\n");
6351 warn = 0;
6352 }
6353 }
6354 #endif
6355 }
6356
6357 /*
6358 * map SADB_SATYPE_* to IPPROTO_*.
6359 * if satype == SADB_SATYPE then satype is mapped to ~0.
6360 * OUT:
6361 * 0: invalid satype.
6362 */
6363 static u_int8_t
key_satype2proto(u_int8_t satype)6364 key_satype2proto(
6365 u_int8_t satype)
6366 {
6367 switch (satype) {
6368 case SADB_SATYPE_UNSPEC:
6369 return IPSEC_PROTO_ANY;
6370 case SADB_SATYPE_AH:
6371 return IPPROTO_AH;
6372 case SADB_SATYPE_ESP:
6373 return IPPROTO_ESP;
6374 default:
6375 return 0;
6376 }
6377 /* NOTREACHED */
6378 }
6379
6380 /*
6381 * map IPPROTO_* to SADB_SATYPE_*
6382 * OUT:
6383 * 0: invalid protocol type.
6384 */
6385 static u_int8_t
key_proto2satype(u_int16_t proto)6386 key_proto2satype(
6387 u_int16_t proto)
6388 {
6389 switch (proto) {
6390 case IPPROTO_AH:
6391 return SADB_SATYPE_AH;
6392 case IPPROTO_ESP:
6393 return SADB_SATYPE_ESP;
6394 default:
6395 return 0;
6396 }
6397 /* NOTREACHED */
6398 }
6399
6400 static ifnet_t
key_get_ipsec_if_from_message(const struct sadb_msghdr * mhp,int message_type)6401 key_get_ipsec_if_from_message(const struct sadb_msghdr *mhp, int message_type)
6402 {
6403 struct sadb_x_ipsecif *ipsecifopts = NULL;
6404 ifnet_t ipsec_if = NULL;
6405
6406 ipsecifopts = (struct sadb_x_ipsecif *)(void *)mhp->ext[message_type];
6407 if (ipsecifopts != NULL) {
6408 if (ipsecifopts->sadb_x_ipsecif_ipsec_if[0]) {
6409 ipsecifopts->sadb_x_ipsecif_ipsec_if[IFXNAMSIZ - 1] = '\0';
6410 ifnet_find_by_name(ipsecifopts->sadb_x_ipsecif_ipsec_if, &ipsec_if);
6411 }
6412 }
6413
6414 return ipsec_if;
6415 }
6416
6417 static u_int
key_get_outgoing_ifindex_from_message(const struct sadb_msghdr * mhp,int message_type)6418 key_get_outgoing_ifindex_from_message(const struct sadb_msghdr *mhp, int message_type)
6419 {
6420 struct sadb_x_ipsecif *ipsecifopts = NULL;
6421 ifnet_t outgoing_if = NULL;
6422
6423 ipsecifopts = (struct sadb_x_ipsecif *)(void *)mhp->ext[message_type];
6424 if (ipsecifopts != NULL) {
6425 if (ipsecifopts->sadb_x_ipsecif_outgoing_if[0]) {
6426 ipsecifopts->sadb_x_ipsecif_outgoing_if[IFXNAMSIZ - 1] = '\0';
6427 ifnet_find_by_name(ipsecifopts->sadb_x_ipsecif_outgoing_if, &outgoing_if);
6428 }
6429 }
6430
6431 u_int outgoing_if_index = 0;
6432 if (outgoing_if != NULL) {
6433 outgoing_if_index = outgoing_if->if_index;
6434 ifnet_release(outgoing_if);
6435 }
6436
6437 return outgoing_if_index;
6438 }
6439
6440 /* %%% PF_KEY */
6441 /*
6442 * SADB_GETSPI processing is to receive
6443 * <base, (SA2), src address, dst address, (SPI range)>
6444 * from the IKMPd, to assign a unique spi value, to hang on the INBOUND
6445 * tree with the status of LARVAL, and send
6446 * <base, SA(*), address(SD)>
6447 * to the IKMPd.
6448 *
6449 * IN: mhp: pointer to the pointer to each header.
6450 * OUT: NULL if fail.
6451 * other if success, return pointer to the message to send.
6452 */
6453 static int
key_getspi(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)6454 key_getspi(
6455 struct socket *so,
6456 struct mbuf *m,
6457 const struct sadb_msghdr *mhp)
6458 {
6459 struct sadb_address *src0, *dst0;
6460 struct secasindex saidx;
6461 struct secashead *newsah;
6462 struct secasvar *newsav;
6463 ifnet_t ipsec_if = NULL;
6464 u_int8_t proto;
6465 u_int32_t spi;
6466 u_int8_t mode;
6467 u_int32_t reqid;
6468 int error;
6469
6470 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
6471
6472 /* sanity check */
6473 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
6474 panic("key_getspi: NULL pointer is passed.");
6475 }
6476
6477 if (mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
6478 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL) {
6479 ipseclog((LOG_DEBUG, "key_getspi: invalid message is passed.\n"));
6480 return key_senderror(so, m, EINVAL);
6481 }
6482 if (mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
6483 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) {
6484 ipseclog((LOG_DEBUG, "key_getspi: invalid message is passed.\n"));
6485 return key_senderror(so, m, EINVAL);
6486 }
6487 if (mhp->ext[SADB_X_EXT_SA2] != NULL) {
6488 mode = ((struct sadb_x_sa2 *)
6489 (void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
6490 reqid = ((struct sadb_x_sa2 *)
6491 (void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
6492 } else {
6493 mode = IPSEC_MODE_ANY;
6494 reqid = 0;
6495 }
6496
6497 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
6498 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
6499
6500 /* map satype to proto */
6501 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6502 ipseclog((LOG_DEBUG, "key_getspi: invalid satype is passed.\n"));
6503 return key_senderror(so, m, EINVAL);
6504 }
6505
6506 /* make sure if port number is zero. */
6507 switch (((struct sockaddr *)(src0 + 1))->sa_family) {
6508 case AF_INET:
6509 if (((struct sockaddr *)(src0 + 1))->sa_len !=
6510 sizeof(struct sockaddr_in)) {
6511 return key_senderror(so, m, EINVAL);
6512 }
6513 ((struct sockaddr_in *)(void *)(src0 + 1))->sin_port = 0;
6514 break;
6515 case AF_INET6:
6516 if (((struct sockaddr *)(src0 + 1))->sa_len !=
6517 sizeof(struct sockaddr_in6)) {
6518 return key_senderror(so, m, EINVAL);
6519 }
6520 ((struct sockaddr_in6 *)(void *)(src0 + 1))->sin6_port = 0;
6521 break;
6522 default:
6523 ; /*???*/
6524 }
6525 switch (((struct sockaddr *)(dst0 + 1))->sa_family) {
6526 case AF_INET:
6527 if (((struct sockaddr *)(dst0 + 1))->sa_len !=
6528 sizeof(struct sockaddr_in)) {
6529 return key_senderror(so, m, EINVAL);
6530 }
6531 ((struct sockaddr_in *)(void *)(dst0 + 1))->sin_port = 0;
6532 break;
6533 case AF_INET6:
6534 if (((struct sockaddr *)(dst0 + 1))->sa_len !=
6535 sizeof(struct sockaddr_in6)) {
6536 return key_senderror(so, m, EINVAL);
6537 }
6538 ((struct sockaddr_in6 *)(void *)(dst0 + 1))->sin6_port = 0;
6539 break;
6540 default:
6541 ; /*???*/
6542 }
6543
6544 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
6545
6546 /* XXX boundary check against sa_len */
6547 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, ipsec_if ? ipsec_if->if_index : 0, &saidx);
6548
6549 lck_mtx_lock(sadb_mutex);
6550
6551 /* SPI allocation */
6552 spi = key_do_getnewspi((struct sadb_spirange *)
6553 (void *)mhp->ext[SADB_EXT_SPIRANGE], &saidx);
6554 if (spi == 0) {
6555 lck_mtx_unlock(sadb_mutex);
6556 if (ipsec_if != NULL) {
6557 ifnet_release(ipsec_if);
6558 }
6559 return key_senderror(so, m, EINVAL);
6560 }
6561
6562 /* get a SA index */
6563 if ((newsah = key_getsah(&saidx, SECURITY_ASSOCIATION_ANY)) == NULL) {
6564 /* create a new SA index: key_addspi is always used for inbound spi */
6565 if ((newsah = key_newsah(&saidx, ipsec_if, key_get_outgoing_ifindex_from_message(mhp, SADB_X_EXT_IPSECIF), IPSEC_DIR_INBOUND, SECURITY_ASSOCIATION_PFKEY)) == NULL) {
6566 lck_mtx_unlock(sadb_mutex);
6567 if (ipsec_if != NULL) {
6568 ifnet_release(ipsec_if);
6569 }
6570 ipseclog((LOG_DEBUG, "key_getspi: No more memory.\n"));
6571 return key_senderror(so, m, ENOBUFS);
6572 }
6573 }
6574
6575 if (ipsec_if != NULL) {
6576 ifnet_release(ipsec_if);
6577 ipsec_if = NULL;
6578 }
6579
6580 // Increment use count, since key_newsav() could release sadb_mutex lock
6581 newsah->use_count++;
6582
6583 if ((newsah->flags & SECURITY_ASSOCIATION_CUSTOM_IPSEC) == SECURITY_ASSOCIATION_CUSTOM_IPSEC) {
6584 newsah->use_count--;
6585 lck_mtx_unlock(sadb_mutex);
6586 ipseclog((LOG_ERR, "key_getspi: custom ipsec exists\n"));
6587 return key_senderror(so, m, EEXIST);
6588 }
6589
6590 /* get a new SA */
6591 /* XXX rewrite */
6592 newsav = key_newsav(m, mhp, newsah, &error, so);
6593 if (newsav == NULL) {
6594 /* XXX don't free new SA index allocated in above. */
6595 newsah->use_count--;
6596 lck_mtx_unlock(sadb_mutex);
6597 return key_senderror(so, m, error);
6598 }
6599
6600 if (newsah->state == SADB_SASTATE_DEAD) {
6601 newsah->use_count--;
6602 key_sa_chgstate(newsav, SADB_SASTATE_DEAD);
6603 key_freesav(newsav, KEY_SADB_LOCKED);
6604 lck_mtx_unlock(sadb_mutex);
6605 ipseclog((LOG_ERR, "key_getspi: security association head is dead\n"));
6606 return key_senderror(so, m, EINVAL);
6607 }
6608
6609 /* set spi */
6610 key_setspi(newsav, htonl(spi));
6611
6612 #ifndef IPSEC_NONBLOCK_ACQUIRE
6613 /* delete the entry in acqtree */
6614 if (mhp->msg->sadb_msg_seq != 0) {
6615 struct secacq *acq;
6616 if ((acq = key_getacqbyseq(mhp->msg->sadb_msg_seq)) != NULL) {
6617 /* reset counter in order to deletion by timehandler. */
6618 struct timeval tv;
6619 microtime(&tv);
6620 acq->created = tv.tv_sec;
6621 acq->count = 0;
6622 }
6623 }
6624 #endif
6625 newsah->use_count--;
6626 u_int32_t newsav_seq = newsav->seq;
6627 lck_mtx_unlock(sadb_mutex);
6628
6629 {
6630 struct mbuf *n, *nn;
6631 struct sadb_sa *m_sa;
6632 struct sadb_msg *newmsg;
6633 int off, len;
6634
6635 /* create new sadb_msg to reply. */
6636 len = PFKEY_ALIGN8(sizeof(struct sadb_msg)) +
6637 PFKEY_ALIGN8(sizeof(struct sadb_sa));
6638 if (len > MCLBYTES) {
6639 return key_senderror(so, m, ENOBUFS);
6640 }
6641
6642 MGETHDR(n, M_WAITOK, MT_DATA);
6643 if (n && len > MHLEN) {
6644 MCLGET(n, M_WAITOK);
6645 if ((n->m_flags & M_EXT) == 0) {
6646 m_freem(n);
6647 n = NULL;
6648 }
6649 }
6650 if (!n) {
6651 return key_senderror(so, m, ENOBUFS);
6652 }
6653
6654 n->m_len = len;
6655 n->m_next = NULL;
6656 off = 0;
6657
6658 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
6659 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
6660
6661 m_sa = (struct sadb_sa *)(void *)(mtod(n, caddr_t) + off);
6662 memset(m_sa, 0, PFKEY_ALIGN8(sizeof(struct sadb_sa)));
6663 m_sa->sadb_sa_len = PFKEY_UNIT64(sizeof(struct sadb_sa));
6664 m_sa->sadb_sa_exttype = SADB_EXT_SA;
6665 m_sa->sadb_sa_spi = htonl(spi);
6666 off += PFKEY_ALIGN8(sizeof(struct sadb_sa));
6667
6668 #if DIAGNOSTIC
6669 if (off != len) {
6670 panic("length inconsistency in key_getspi");
6671 }
6672 #endif
6673 {
6674 int mbufItems[] = {SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST};
6675 n->m_next = key_gather_mbuf(m, mhp, 0, sizeof(mbufItems) / sizeof(int), mbufItems);
6676 if (!n->m_next) {
6677 m_freem(n);
6678 return key_senderror(so, m, ENOBUFS);
6679 }
6680 }
6681
6682 if (n->m_len < sizeof(struct sadb_msg)) {
6683 n = m_pullup(n, sizeof(struct sadb_msg));
6684 if (n == NULL) {
6685 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
6686 }
6687 }
6688
6689 n->m_pkthdr.len = 0;
6690 for (nn = n; nn; nn = nn->m_next) {
6691 n->m_pkthdr.len += nn->m_len;
6692 }
6693
6694 newmsg = mtod(n, struct sadb_msg *);
6695 newmsg->sadb_msg_seq = newsav_seq;
6696 newmsg->sadb_msg_errno = 0;
6697 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
6698 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
6699
6700 m_freem(m);
6701 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
6702 }
6703 }
6704
6705 /*
6706 * allocating new SPI
6707 * called by key_getspi().
6708 * OUT:
6709 * 0: failure.
6710 * others: success.
6711 */
6712 static u_int32_t
key_do_getnewspi(struct sadb_spirange * spirange,struct secasindex * saidx)6713 key_do_getnewspi(
6714 struct sadb_spirange *spirange,
6715 struct secasindex *saidx)
6716 {
6717 u_int32_t newspi;
6718 u_int32_t keymin, keymax;
6719 int count = key_spi_trycnt;
6720
6721 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
6722
6723 /* set spi range to allocate */
6724 if (spirange != NULL) {
6725 keymin = spirange->sadb_spirange_min;
6726 keymax = spirange->sadb_spirange_max;
6727 } else {
6728 keymin = key_spi_minval;
6729 keymax = key_spi_maxval;
6730 }
6731 if (keymin == keymax) {
6732 if (key_checkspidup(saidx, keymin) != NULL) {
6733 ipseclog((LOG_DEBUG, "key_do_getnewspi: SPI %u exists already.\n", keymin));
6734 return 0;
6735 }
6736
6737 count--; /* taking one cost. */
6738 newspi = keymin;
6739 } else {
6740 u_int32_t range = keymax - keymin + 1; /* overflow value of zero means full range */
6741
6742 /* init SPI */
6743 newspi = 0;
6744
6745 /* when requesting to allocate spi ranged */
6746 while (count--) {
6747 u_int32_t rand_val = key_random();
6748
6749 /* generate pseudo-random SPI value ranged. */
6750 newspi = (range == 0 ? rand_val : keymin + (rand_val % range));
6751
6752 if (key_checkspidup(saidx, newspi) == NULL) {
6753 break;
6754 }
6755 }
6756
6757 if (count == 0 || newspi == 0) {
6758 ipseclog((LOG_DEBUG, "key_do_getnewspi: to allocate spi is failed.\n"));
6759 return 0;
6760 }
6761 }
6762
6763 /* statistics */
6764 keystat.getspi_count =
6765 (keystat.getspi_count + key_spi_trycnt - count) / 2;
6766
6767 return newspi;
6768 }
6769
6770 /*
6771 * SADB_UPDATE processing
6772 * receive
6773 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
6774 * key(AE), (identity(SD),) (sensitivity)>
6775 * from the ikmpd, and update a secasvar entry whose status is SADB_SASTATE_LARVAL.
6776 * and send
6777 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
6778 * (identity(SD),) (sensitivity)>
6779 * to the ikmpd.
6780 *
6781 * m will always be freed.
6782 */
6783 static int
key_update(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)6784 key_update(
6785 struct socket *so,
6786 struct mbuf *m,
6787 const struct sadb_msghdr *mhp)
6788 {
6789 struct sadb_sa *sa0 = NULL;
6790 struct sadb_address *src0 = NULL, *dst0 = NULL;
6791 ifnet_t ipsec_if = NULL;
6792 struct secasindex saidx;
6793 struct secashead *sah = NULL;
6794 struct secasvar *sav = NULL;
6795 u_int8_t proto;
6796 u_int8_t mode;
6797 u_int32_t reqid;
6798 u_int16_t flags2;
6799 int error;
6800
6801 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
6802
6803 /* sanity check */
6804 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
6805 panic("key_update: NULL pointer is passed.");
6806 }
6807
6808 /* map satype to proto */
6809 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6810 ipseclog((LOG_DEBUG, "key_update: invalid satype is passed.\n"));
6811 bzero_keys(mhp);
6812 return key_senderror(so, m, EINVAL);
6813 }
6814
6815 if (mhp->ext[SADB_EXT_SA] == NULL ||
6816 mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
6817 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL ||
6818 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
6819 mhp->ext[SADB_EXT_KEY_ENCRYPT] == NULL) ||
6820 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
6821 mhp->ext[SADB_EXT_KEY_AUTH] == NULL) ||
6822 (mhp->ext[SADB_EXT_LIFETIME_HARD] != NULL &&
6823 mhp->ext[SADB_EXT_LIFETIME_SOFT] == NULL) ||
6824 (mhp->ext[SADB_EXT_LIFETIME_HARD] == NULL &&
6825 mhp->ext[SADB_EXT_LIFETIME_SOFT] != NULL)) {
6826 ipseclog((LOG_DEBUG, "key_update: invalid message is passed.\n"));
6827 bzero_keys(mhp);
6828 return key_senderror(so, m, EINVAL);
6829 }
6830 if (mhp->extlen[SADB_EXT_SA] < sizeof(struct sadb_sa) ||
6831 mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
6832 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) {
6833 ipseclog((LOG_DEBUG, "key_update: invalid message is passed.\n"));
6834 bzero_keys(mhp);
6835 return key_senderror(so, m, EINVAL);
6836 }
6837 if (mhp->ext[SADB_X_EXT_SA2] != NULL) {
6838 mode = ((struct sadb_x_sa2 *)
6839 (void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
6840 reqid = ((struct sadb_x_sa2 *)
6841 (void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
6842 flags2 = ((struct sadb_x_sa2 *)(void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_flags;
6843 } else {
6844 mode = IPSEC_MODE_ANY;
6845 reqid = 0;
6846 flags2 = 0;
6847 }
6848 /* XXX boundary checking for other extensions */
6849
6850 sa0 = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
6851 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
6852 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
6853 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
6854
6855 u_int ipsec_if_index = 0;
6856 if (ipsec_if != NULL) {
6857 ipsec_if_index = ipsec_if->if_index;
6858 ifnet_release(ipsec_if);
6859 ipsec_if = NULL;
6860 }
6861
6862 /* XXX boundary check against sa_len */
6863 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, ipsec_if_index, &saidx);
6864
6865 lck_mtx_lock(sadb_mutex);
6866
6867 /* get a SA header */
6868 if ((sah = key_getsah(&saidx, SECURITY_ASSOCIATION_PFKEY)) == NULL) {
6869 lck_mtx_unlock(sadb_mutex);
6870 ipseclog((LOG_DEBUG, "key_update: no SA index found.\n"));
6871 bzero_keys(mhp);
6872 return key_senderror(so, m, ENOENT);
6873 }
6874
6875 // Increment use count, since key_setsaval() could release sadb_mutex lock
6876 sah->use_count++;
6877
6878 if ((sav = key_getsavbyspi(sah, sa0->sadb_sa_spi)) == NULL) {
6879 ipseclog((LOG_DEBUG,
6880 "key_update: no such a SA found (spi:%u)\n",
6881 (u_int32_t)ntohl(sa0->sadb_sa_spi)));
6882 error = EINVAL;
6883 goto fail;
6884 }
6885
6886 // Increment reference count, since key_setsaval() could release sadb_mutex lock
6887 sav->refcnt++;
6888
6889 /* validity check */
6890 if (sav->sah->saidx.proto != proto) {
6891 ipseclog((LOG_DEBUG,
6892 "key_update: protocol mismatched (DB=%u param=%u)\n",
6893 sav->sah->saidx.proto, proto));
6894 error = EINVAL;
6895 goto fail;
6896 }
6897
6898 if (sav->pid != mhp->msg->sadb_msg_pid) {
6899 ipseclog((LOG_DEBUG,
6900 "key_update: pid mismatched (DB:%u param:%u)\n",
6901 sav->pid, mhp->msg->sadb_msg_pid));
6902 error = EINVAL;
6903 goto fail;
6904 }
6905
6906 /* copy sav values */
6907 sav->flags2 = flags2;
6908 if (flags2 & SADB_X_EXT_SA2_DELETE_ON_DETACH) {
6909 sav->so = so;
6910 }
6911
6912 error = key_setsaval(sav, m, mhp);
6913 if (error) {
6914 goto fail;
6915 }
6916
6917 if (sah->state == SADB_SASTATE_DEAD) {
6918 ipseclog((LOG_ERR,
6919 "key_update: security association head is dead\n"));
6920 error = EINVAL;
6921 goto fail;
6922 }
6923
6924 /*
6925 * Verify if SADB_X_EXT_NATT_MULTIPLEUSERS flag is set that
6926 * this SA is for transport mode - otherwise clear it.
6927 */
6928 if ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0 &&
6929 (sav->sah->saidx.mode != IPSEC_MODE_TRANSPORT ||
6930 sav->sah->saidx.src.ss_family != AF_INET)) {
6931 sav->flags &= ~SADB_X_EXT_NATT_MULTIPLEUSERS;
6932 }
6933
6934 /* check SA values to be mature. */
6935 if ((error = key_mature(sav)) != 0) {
6936 goto fail;
6937 }
6938
6939 key_freesav(sav, KEY_SADB_LOCKED);
6940 sah->use_count--;
6941 lck_mtx_unlock(sadb_mutex);
6942
6943 {
6944 struct mbuf *n;
6945
6946 /* set msg buf from mhp */
6947 n = key_getmsgbuf_x1(m, mhp);
6948 if (n == NULL) {
6949 ipseclog((LOG_DEBUG, "key_update: No more memory.\n"));
6950 return key_senderror(so, m, ENOBUFS);
6951 }
6952
6953 bzero_keys(mhp);
6954 m_freem(m);
6955 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
6956 }
6957 fail:
6958 if (sav != NULL) {
6959 key_freesav(sav, KEY_SADB_LOCKED);
6960 }
6961 if (sah != NULL) {
6962 sah->use_count--;
6963 }
6964
6965 lck_mtx_unlock(sadb_mutex);
6966 bzero_keys(mhp);
6967 return key_senderror(so, m, error);
6968 }
6969
6970 static int
key_migrate(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)6971 key_migrate(struct socket *so,
6972 struct mbuf *m,
6973 const struct sadb_msghdr *mhp)
6974 {
6975 struct sadb_sa *sa0 = NULL;
6976 struct sadb_address *src0 = NULL;
6977 struct sadb_address *dst0 = NULL;
6978 struct sadb_address *src1 = NULL;
6979 struct sadb_address *dst1 = NULL;
6980 ifnet_t ipsec_if0 = NULL;
6981 ifnet_t ipsec_if1 = NULL;
6982 struct secasindex saidx0;
6983 struct secasindex saidx1;
6984 struct secashead *sah = NULL;
6985 struct secashead *newsah = NULL;
6986 struct secasvar *sav = NULL;
6987 u_int8_t proto;
6988
6989 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
6990
6991 /* sanity check */
6992 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
6993 panic("key_migrate: NULL pointer is passed.");
6994 }
6995
6996 /* map satype to proto */
6997 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
6998 ipseclog((LOG_DEBUG, "key_migrate: invalid satype is passed.\n"));
6999 return key_senderror(so, m, EINVAL);
7000 }
7001
7002 if (mhp->ext[SADB_EXT_SA] == NULL ||
7003 mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
7004 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL ||
7005 mhp->ext[SADB_EXT_MIGRATE_ADDRESS_SRC] == NULL ||
7006 mhp->ext[SADB_EXT_MIGRATE_ADDRESS_DST] == NULL) {
7007 ipseclog((LOG_DEBUG, "key_migrate: invalid message is passed.\n"));
7008 return key_senderror(so, m, EINVAL);
7009 }
7010
7011 if (mhp->extlen[SADB_EXT_SA] < sizeof(struct sadb_sa) ||
7012 mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
7013 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address) ||
7014 mhp->extlen[SADB_EXT_MIGRATE_ADDRESS_SRC] < sizeof(struct sadb_address) ||
7015 mhp->extlen[SADB_EXT_MIGRATE_ADDRESS_DST] < sizeof(struct sadb_address)) {
7016 ipseclog((LOG_DEBUG, "key_migrate: invalid message is passed.\n"));
7017 return key_senderror(so, m, EINVAL);
7018 }
7019
7020 lck_mtx_lock(sadb_mutex);
7021
7022 sa0 = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
7023 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
7024 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
7025 src1 = (struct sadb_address *)(mhp->ext[SADB_EXT_MIGRATE_ADDRESS_SRC]);
7026 dst1 = (struct sadb_address *)(mhp->ext[SADB_EXT_MIGRATE_ADDRESS_DST]);
7027 ipsec_if0 = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
7028 ipsec_if1 = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_MIGRATE_IPSECIF);
7029
7030 u_int ipsec_if0_index = 0;
7031 if (ipsec_if0 != NULL) {
7032 ipsec_if0_index = ipsec_if0->if_index;
7033 ifnet_release(ipsec_if0);
7034 ipsec_if0 = NULL;
7035 }
7036
7037 /* Find existing SAH and SAV */
7038 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, ipsec_if0_index, &saidx0);
7039
7040 LIST_FOREACH(sah, &sahtree, chain) {
7041 if (sah->state != SADB_SASTATE_MATURE) {
7042 continue;
7043 }
7044 if (key_cmpsaidx(&sah->saidx, &saidx0, CMP_HEAD) == 0) {
7045 continue;
7046 }
7047
7048 sav = key_getsavbyspi(sah, sa0->sadb_sa_spi);
7049 if (sav && sav->state == SADB_SASTATE_MATURE) {
7050 break;
7051 }
7052 }
7053 if (sah == NULL) {
7054 lck_mtx_unlock(sadb_mutex);
7055 if (ipsec_if1 != NULL) {
7056 ifnet_release(ipsec_if1);
7057 }
7058 ipseclog((LOG_DEBUG, "key_migrate: no mature SAH found.\n"));
7059 return key_senderror(so, m, ENOENT);
7060 }
7061
7062 if (sav == NULL) {
7063 lck_mtx_unlock(sadb_mutex);
7064 if (ipsec_if1 != NULL) {
7065 ifnet_release(ipsec_if1);
7066 }
7067 ipseclog((LOG_DEBUG, "key_migrate: no SA found.\n"));
7068 return key_senderror(so, m, ENOENT);
7069 }
7070
7071 /* Find or create new SAH */
7072 KEY_SETSECASIDX(proto, sah->saidx.mode, sah->saidx.reqid, src1 + 1, dst1 + 1, ipsec_if1 ? ipsec_if1->if_index : 0, &saidx1);
7073
7074 if ((newsah = key_getsah(&saidx1, SECURITY_ASSOCIATION_ANY)) == NULL) {
7075 if ((newsah = key_newsah(&saidx1, ipsec_if1, key_get_outgoing_ifindex_from_message(mhp, SADB_X_EXT_MIGRATE_IPSECIF), sah->dir, SECURITY_ASSOCIATION_PFKEY)) == NULL) {
7076 lck_mtx_unlock(sadb_mutex);
7077 if (ipsec_if1 != NULL) {
7078 ifnet_release(ipsec_if1);
7079 }
7080 ipseclog((LOG_DEBUG, "key_migrate: No more memory.\n"));
7081 return key_senderror(so, m, ENOBUFS);
7082 }
7083 }
7084
7085 if (ipsec_if1 != NULL) {
7086 ifnet_release(ipsec_if1);
7087 ipsec_if1 = NULL;
7088 }
7089
7090 if ((newsah->flags & SECURITY_ASSOCIATION_CUSTOM_IPSEC) == SECURITY_ASSOCIATION_CUSTOM_IPSEC) {
7091 lck_mtx_unlock(sadb_mutex);
7092 ipseclog((LOG_ERR, "key_migrate: custom ipsec exists\n"));
7093 return key_senderror(so, m, EEXIST);
7094 }
7095
7096 /* Migrate SAV in to new SAH */
7097 if (key_migratesav(sav, newsah) != 0) {
7098 lck_mtx_unlock(sadb_mutex);
7099 ipseclog((LOG_DEBUG, "key_migrate: Failed to migrate SA to new SAH.\n"));
7100 return key_senderror(so, m, EINVAL);
7101 }
7102
7103 /* Reset NAT values */
7104 sav->flags = sa0->sadb_sa_flags;
7105 sav->natt_encapsulated_src_port = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_src_port;
7106 sav->remote_ike_port = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_port;
7107 sav->natt_interval = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_interval;
7108 sav->natt_offload_interval = ((const struct sadb_sa_2*)(sa0))->sadb_sa_natt_offload_interval;
7109 sav->natt_last_activity = natt_now;
7110
7111 /*
7112 * Verify if SADB_X_EXT_NATT_MULTIPLEUSERS flag is set that
7113 * SADB_X_EXT_NATT is set and SADB_X_EXT_NATT_KEEPALIVE is not
7114 * set (we're not behind nat) - otherwise clear it.
7115 */
7116 if ((sav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0) {
7117 if ((sav->flags & SADB_X_EXT_NATT) == 0 ||
7118 (sav->flags & SADB_X_EXT_NATT_KEEPALIVE) != 0) {
7119 sav->flags &= ~SADB_X_EXT_NATT_MULTIPLEUSERS;
7120 }
7121 }
7122
7123 lck_mtx_unlock(sadb_mutex);
7124 {
7125 struct mbuf *n;
7126 struct sadb_msg *newmsg;
7127 int mbufItems[] = {SADB_EXT_RESERVED, SADB_EXT_SA,
7128 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST, SADB_X_EXT_IPSECIF,
7129 SADB_EXT_MIGRATE_ADDRESS_SRC, SADB_EXT_MIGRATE_ADDRESS_DST, SADB_X_EXT_MIGRATE_IPSECIF};
7130
7131 /* create new sadb_msg to reply. */
7132 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
7133 if (!n) {
7134 return key_senderror(so, m, ENOBUFS);
7135 }
7136
7137 if (n->m_len < sizeof(struct sadb_msg)) {
7138 n = m_pullup(n, sizeof(struct sadb_msg));
7139 if (n == NULL) {
7140 return key_senderror(so, m, ENOBUFS);
7141 }
7142 }
7143 newmsg = mtod(n, struct sadb_msg *);
7144 newmsg->sadb_msg_errno = 0;
7145 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
7146 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
7147
7148 m_freem(m);
7149 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
7150 }
7151 }
7152
7153 /*
7154 * SADB_ADD processing
7155 * add a entry to SA database, when received
7156 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
7157 * key(AE), (identity(SD),) (sensitivity)>
7158 * from the ikmpd,
7159 * and send
7160 * <base, SA, (SA2), (lifetime(HSC),) address(SD), (address(P),)
7161 * (identity(SD),) (sensitivity)>
7162 * to the ikmpd.
7163 *
7164 * IGNORE identity and sensitivity messages.
7165 *
7166 * m will always be freed.
7167 */
7168 static int
key_add(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)7169 key_add(
7170 struct socket *so,
7171 struct mbuf *m,
7172 const struct sadb_msghdr *mhp)
7173 {
7174 struct sadb_sa *sa0 = NULL;
7175 struct sadb_address *src0 = NULL, *dst0 = NULL;
7176 ifnet_t ipsec_if = NULL;
7177 struct secasindex saidx;
7178 struct secashead *newsah = NULL;
7179 struct secasvar *newsav = NULL;
7180 u_int8_t proto;
7181 u_int8_t mode;
7182 u_int32_t reqid;
7183 int error;
7184
7185 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
7186
7187 /* sanity check */
7188 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
7189 panic("key_add: NULL pointer is passed.");
7190 }
7191
7192 /* map satype to proto */
7193 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7194 ipseclog((LOG_DEBUG, "key_add: invalid satype is passed.\n"));
7195 bzero_keys(mhp);
7196 return key_senderror(so, m, EINVAL);
7197 }
7198
7199 if (mhp->ext[SADB_EXT_SA] == NULL ||
7200 mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
7201 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL ||
7202 (mhp->msg->sadb_msg_satype == SADB_SATYPE_ESP &&
7203 mhp->ext[SADB_EXT_KEY_ENCRYPT] == NULL) ||
7204 (mhp->msg->sadb_msg_satype == SADB_SATYPE_AH &&
7205 mhp->ext[SADB_EXT_KEY_AUTH] == NULL) ||
7206 (mhp->ext[SADB_EXT_LIFETIME_HARD] != NULL &&
7207 mhp->ext[SADB_EXT_LIFETIME_SOFT] == NULL) ||
7208 (mhp->ext[SADB_EXT_LIFETIME_HARD] == NULL &&
7209 mhp->ext[SADB_EXT_LIFETIME_SOFT] != NULL)) {
7210 ipseclog((LOG_DEBUG, "key_add: invalid message is passed.\n"));
7211 bzero_keys(mhp);
7212 return key_senderror(so, m, EINVAL);
7213 }
7214 if (mhp->extlen[SADB_EXT_SA] < sizeof(struct sadb_sa) ||
7215 mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
7216 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) {
7217 /* XXX need more */
7218 ipseclog((LOG_DEBUG, "key_add: invalid message is passed.\n"));
7219 bzero_keys(mhp);
7220 return key_senderror(so, m, EINVAL);
7221 }
7222 if (mhp->ext[SADB_X_EXT_SA2] != NULL) {
7223 mode = ((struct sadb_x_sa2 *)
7224 (void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_mode;
7225 reqid = ((struct sadb_x_sa2 *)
7226 (void *)mhp->ext[SADB_X_EXT_SA2])->sadb_x_sa2_reqid;
7227 } else {
7228 mode = IPSEC_MODE_ANY;
7229 reqid = 0;
7230 }
7231
7232 sa0 = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
7233 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7234 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7235 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
7236
7237 /* XXX boundary check against sa_len */
7238 KEY_SETSECASIDX(proto, mode, reqid, src0 + 1, dst0 + 1, ipsec_if ? ipsec_if->if_index : 0, &saidx);
7239
7240 lck_mtx_lock(sadb_mutex);
7241
7242 /* get a SA header */
7243 if ((newsah = key_getsah(&saidx, SECURITY_ASSOCIATION_ANY)) == NULL) {
7244 /* create a new SA header: key_addspi is always used for outbound spi */
7245 if ((newsah = key_newsah(&saidx, ipsec_if, key_get_outgoing_ifindex_from_message(mhp, SADB_X_EXT_IPSECIF), IPSEC_DIR_OUTBOUND, SECURITY_ASSOCIATION_PFKEY)) == NULL) {
7246 ipseclog((LOG_DEBUG, "key_add: No more memory.\n"));
7247 error = ENOBUFS;
7248 goto fail;
7249 }
7250 }
7251
7252 if (ipsec_if != NULL) {
7253 ifnet_release(ipsec_if);
7254 ipsec_if = NULL;
7255 }
7256
7257 // Increment use count, since key_newsav() could release sadb_mutex lock
7258 newsah->use_count++;
7259
7260 if ((newsah->flags & SECURITY_ASSOCIATION_CUSTOM_IPSEC) == SECURITY_ASSOCIATION_CUSTOM_IPSEC) {
7261 ipseclog((LOG_ERR, "key_add: custom ipsec exists\n"));
7262 error = EEXIST;
7263 goto fail;
7264 }
7265
7266 /* create new SA entry. */
7267 /* We can create new SA only if SPI is different. */
7268 if (key_getsavbyspi(newsah, sa0->sadb_sa_spi)) {
7269 ipseclog((LOG_DEBUG, "key_add: SA already exists.\n"));
7270 error = EEXIST;
7271 goto fail;
7272 }
7273 newsav = key_newsav(m, mhp, newsah, &error, so);
7274 if (newsav == NULL) {
7275 goto fail;
7276 }
7277
7278 if (newsah->state == SADB_SASTATE_DEAD) {
7279 ipseclog((LOG_ERR, "key_add: security association head is dead\n"));
7280 error = EINVAL;
7281 goto fail;
7282 }
7283
7284 /*
7285 * Verify if SADB_X_EXT_NATT_MULTIPLEUSERS flag is set that
7286 * this SA is for transport mode - otherwise clear it.
7287 */
7288 if ((newsav->flags & SADB_X_EXT_NATT_MULTIPLEUSERS) != 0 &&
7289 (newsah->saidx.mode != IPSEC_MODE_TRANSPORT ||
7290 newsah->saidx.dst.ss_family != AF_INET)) {
7291 newsav->flags &= ~SADB_X_EXT_NATT_MULTIPLEUSERS;
7292 }
7293
7294 /* check SA values to be mature. */
7295 if ((error = key_mature(newsav)) != 0) {
7296 goto fail;
7297 }
7298
7299 key_get_flowid(newsav);
7300
7301 newsah->use_count--;
7302 lck_mtx_unlock(sadb_mutex);
7303
7304 /*
7305 * don't call key_freesav() here, as we would like to keep the SA
7306 * in the database on success.
7307 */
7308
7309 {
7310 struct mbuf *n;
7311
7312 /* set msg buf from mhp */
7313 n = key_getmsgbuf_x1(m, mhp);
7314 if (n == NULL) {
7315 ipseclog((LOG_DEBUG, "key_update: No more memory.\n"));
7316 bzero_keys(mhp);
7317 return key_senderror(so, m, ENOBUFS);
7318 }
7319
7320 // mh.ext points to the mbuf content.
7321 // Zero out Encryption and Integrity keys if present.
7322 bzero_keys(mhp);
7323 m_freem(m);
7324 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
7325 }
7326 fail:
7327 if (newsav != NULL) {
7328 key_sa_chgstate(newsav, SADB_SASTATE_DEAD);
7329 key_freesav(newsav, KEY_SADB_LOCKED);
7330 }
7331 if (newsah != NULL) {
7332 newsah->use_count--;
7333 }
7334 lck_mtx_unlock(sadb_mutex);
7335 if (ipsec_if != NULL) {
7336 ifnet_release(ipsec_if);
7337 }
7338 bzero_keys(mhp);
7339 return key_senderror(so, m, error);
7340 }
7341
7342 /*
7343 * m will not be freed on return.
7344 * it is caller's responsibility to free the result.
7345 */
7346 static struct mbuf *
key_getmsgbuf_x1(struct mbuf * m,const struct sadb_msghdr * mhp)7347 key_getmsgbuf_x1(
7348 struct mbuf *m,
7349 const struct sadb_msghdr *mhp)
7350 {
7351 struct mbuf *n;
7352 int mbufItems[] = {SADB_EXT_RESERVED, SADB_EXT_SA,
7353 SADB_X_EXT_SA2, SADB_EXT_ADDRESS_SRC,
7354 SADB_EXT_ADDRESS_DST, SADB_EXT_LIFETIME_HARD,
7355 SADB_EXT_LIFETIME_SOFT, SADB_EXT_IDENTITY_SRC,
7356 SADB_EXT_IDENTITY_DST};
7357
7358 /* sanity check */
7359 if (m == NULL || mhp == NULL || mhp->msg == NULL) {
7360 panic("key_getmsgbuf_x1: NULL pointer is passed.");
7361 }
7362
7363 /* create new sadb_msg to reply. */
7364 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
7365 if (!n) {
7366 return NULL;
7367 }
7368
7369 if (n->m_len < sizeof(struct sadb_msg)) {
7370 n = m_pullup(n, sizeof(struct sadb_msg));
7371 if (n == NULL) {
7372 return NULL;
7373 }
7374 }
7375 mtod(n, struct sadb_msg *)->sadb_msg_errno = 0;
7376 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
7377 mtod(n, struct sadb_msg *)->sadb_msg_len =
7378 (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
7379
7380 return n;
7381 }
7382
7383 static int key_delete_all(struct socket *, struct mbuf *,
7384 const struct sadb_msghdr *, u_int16_t);
7385
7386 /*
7387 * SADB_DELETE processing
7388 * receive
7389 * <base, SA(*), address(SD)>
7390 * from the ikmpd, and set SADB_SASTATE_DEAD,
7391 * and send,
7392 * <base, SA(*), address(SD)>
7393 * to the ikmpd.
7394 *
7395 * m will always be freed.
7396 */
7397 static int
key_delete(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)7398 key_delete(
7399 struct socket *so,
7400 struct mbuf *m,
7401 const struct sadb_msghdr *mhp)
7402 {
7403 struct sadb_sa *sa0;
7404 struct sadb_address *src0, *dst0;
7405 ifnet_t ipsec_if = NULL;
7406 struct secasindex saidx;
7407 struct secashead *sah;
7408 struct secasvar *sav = NULL;
7409 u_int16_t proto;
7410
7411 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
7412
7413 /* sanity check */
7414 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
7415 panic("key_delete: NULL pointer is passed.");
7416 }
7417
7418 /* map satype to proto */
7419 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7420 ipseclog((LOG_DEBUG, "key_delete: invalid satype is passed.\n"));
7421 return key_senderror(so, m, EINVAL);
7422 }
7423
7424 if (mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
7425 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL) {
7426 ipseclog((LOG_DEBUG, "key_delete: invalid message is passed.\n"));
7427 return key_senderror(so, m, EINVAL);
7428 }
7429
7430 if (mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
7431 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) {
7432 ipseclog((LOG_DEBUG, "key_delete: invalid message is passed.\n"));
7433 return key_senderror(so, m, EINVAL);
7434 }
7435
7436 lck_mtx_lock(sadb_mutex);
7437
7438 if (mhp->ext[SADB_EXT_SA] == NULL) {
7439 /*
7440 * Caller wants us to delete all non-LARVAL SAs
7441 * that match the src/dst. This is used during
7442 * IKE INITIAL-CONTACT.
7443 */
7444 ipseclog((LOG_DEBUG, "key_delete: doing delete all.\n"));
7445 /* key_delete_all will unlock sadb_mutex */
7446 return key_delete_all(so, m, mhp, proto);
7447 } else if (mhp->extlen[SADB_EXT_SA] < sizeof(struct sadb_sa)) {
7448 lck_mtx_unlock(sadb_mutex);
7449 ipseclog((LOG_DEBUG, "key_delete: invalid message is passed.\n"));
7450 return key_senderror(so, m, EINVAL);
7451 }
7452
7453 sa0 = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
7454 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
7455 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
7456 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
7457
7458 u_int ipsec_if_index = 0;
7459 if (ipsec_if != NULL) {
7460 ipsec_if_index = ipsec_if->if_index;
7461 ifnet_release(ipsec_if);
7462 ipsec_if = NULL;
7463 }
7464
7465 /* XXX boundary check against sa_len */
7466 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, ipsec_if_index, &saidx);
7467
7468
7469 /* get a SA header */
7470 LIST_FOREACH(sah, &sahtree, chain) {
7471 if (sah->state == SADB_SASTATE_DEAD) {
7472 continue;
7473 }
7474 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_HEAD) == 0) {
7475 continue;
7476 }
7477
7478 /* get a SA with SPI. */
7479 sav = key_getsavbyspi(sah, sa0->sadb_sa_spi);
7480 if (sav) {
7481 break;
7482 }
7483 }
7484 if (sah == NULL) {
7485 lck_mtx_unlock(sadb_mutex);
7486 ipseclog((LOG_DEBUG, "key_delete: no SA found.\n"));
7487 return key_senderror(so, m, ENOENT);
7488 }
7489
7490 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
7491 key_freesav(sav, KEY_SADB_LOCKED);
7492
7493 lck_mtx_unlock(sadb_mutex);
7494 sav = NULL;
7495
7496 {
7497 struct mbuf *n;
7498 struct sadb_msg *newmsg;
7499 int mbufItems[] = {SADB_EXT_RESERVED, SADB_EXT_SA,
7500 SADB_EXT_ADDRESS_SRC, SADB_EXT_ADDRESS_DST};
7501
7502 /* create new sadb_msg to reply. */
7503 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
7504 if (!n) {
7505 return key_senderror(so, m, ENOBUFS);
7506 }
7507
7508 if (n->m_len < sizeof(struct sadb_msg)) {
7509 n = m_pullup(n, sizeof(struct sadb_msg));
7510 if (n == NULL) {
7511 return key_senderror(so, m, ENOBUFS);
7512 }
7513 }
7514 newmsg = mtod(n, struct sadb_msg *);
7515 newmsg->sadb_msg_errno = 0;
7516 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
7517 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
7518
7519 m_freem(m);
7520 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
7521 }
7522 }
7523
7524 /*
7525 * delete all SAs for src/dst. Called from key_delete().
7526 */
7527 static int
key_delete_all(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp,u_int16_t proto)7528 key_delete_all(
7529 struct socket *so,
7530 struct mbuf *m,
7531 const struct sadb_msghdr *mhp,
7532 u_int16_t proto)
7533 {
7534 struct sadb_address *src0, *dst0;
7535 ifnet_t ipsec_if = NULL;
7536 struct secasindex saidx;
7537 struct secashead *sah;
7538 struct secasvar *sav, *nextsav;
7539 u_int stateidx, state;
7540
7541 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
7542
7543 src0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_SRC]);
7544 dst0 = (struct sadb_address *)(mhp->ext[SADB_EXT_ADDRESS_DST]);
7545 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
7546
7547 u_int ipsec_if_index = 0;
7548 if (ipsec_if != NULL) {
7549 ipsec_if_index = ipsec_if->if_index;
7550 ifnet_release(ipsec_if);
7551 ipsec_if = NULL;
7552 }
7553
7554 /* XXX boundary check against sa_len */
7555 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, ipsec_if_index, &saidx);
7556
7557 LIST_FOREACH(sah, &sahtree, chain) {
7558 if (sah->state == SADB_SASTATE_DEAD) {
7559 continue;
7560 }
7561 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_HEAD) == 0) {
7562 continue;
7563 }
7564
7565 /* Delete all non-LARVAL SAs. */
7566 for (stateidx = 0;
7567 stateidx < _ARRAYLEN(saorder_state_alive);
7568 stateidx++) {
7569 state = saorder_state_alive[stateidx];
7570 if (state == SADB_SASTATE_LARVAL) {
7571 continue;
7572 }
7573 for (sav = LIST_FIRST(&sah->savtree[state]);
7574 sav != NULL; sav = nextsav) {
7575 nextsav = LIST_NEXT(sav, chain);
7576 /* sanity check */
7577 if (sav->state != state) {
7578 ipseclog((LOG_DEBUG, "key_delete_all: "
7579 "invalid sav->state "
7580 "(queue: %d SA: %d)\n",
7581 state, sav->state));
7582 continue;
7583 }
7584
7585 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
7586 key_freesav(sav, KEY_SADB_LOCKED);
7587 }
7588 }
7589 }
7590 lck_mtx_unlock(sadb_mutex);
7591
7592 {
7593 struct mbuf *n;
7594 struct sadb_msg *newmsg;
7595 int mbufItems[] = {SADB_EXT_RESERVED, SADB_EXT_ADDRESS_SRC,
7596 SADB_EXT_ADDRESS_DST};
7597
7598 /* create new sadb_msg to reply. */
7599 n = key_gather_mbuf(m, mhp, 1, sizeof(mbufItems) / sizeof(int), mbufItems);
7600 if (!n) {
7601 return key_senderror(so, m, ENOBUFS);
7602 }
7603
7604 if (n->m_len < sizeof(struct sadb_msg)) {
7605 n = m_pullup(n, sizeof(struct sadb_msg));
7606 if (n == NULL) {
7607 return key_senderror(so, m, ENOBUFS);
7608 }
7609 }
7610 newmsg = mtod(n, struct sadb_msg *);
7611 newmsg->sadb_msg_errno = 0;
7612 VERIFY(PFKEY_UNIT64(n->m_pkthdr.len) <= UINT16_MAX);
7613 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(n->m_pkthdr.len);
7614
7615 m_freem(m);
7616 return key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
7617 }
7618 }
7619
7620 /*
7621 * SADB_GET processing
7622 * receive
7623 * <base, SA(*), address(SD)>
7624 * from the ikmpd, and get a SP and a SA to respond,
7625 * and send,
7626 * <base, SA, (lifetime(HSC),) address(SD), (address(P),) key(AE),
7627 * (identity(SD),) (sensitivity)>
7628 * to the ikmpd.
7629 *
7630 * m will always be freed.
7631 */
7632 static int
key_get(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)7633 key_get(
7634 struct socket *so,
7635 struct mbuf *m,
7636 const struct sadb_msghdr *mhp)
7637 {
7638 struct sadb_sa *sa0;
7639 struct sadb_address *src0, *dst0;
7640 ifnet_t ipsec_if = NULL;
7641 struct secasindex saidx;
7642 struct secashead *sah;
7643 struct secasvar *sav = NULL;
7644 u_int16_t proto;
7645
7646 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
7647
7648 /* sanity check */
7649 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
7650 panic("key_get: NULL pointer is passed.");
7651 }
7652
7653 /* map satype to proto */
7654 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
7655 ipseclog((LOG_DEBUG, "key_get: invalid satype is passed.\n"));
7656 return key_senderror(so, m, EINVAL);
7657 }
7658
7659 if (mhp->ext[SADB_EXT_SA] == NULL ||
7660 mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
7661 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL) {
7662 ipseclog((LOG_DEBUG, "key_get: invalid message is passed.\n"));
7663 return key_senderror(so, m, EINVAL);
7664 }
7665 if (mhp->extlen[SADB_EXT_SA] < sizeof(struct sadb_sa) ||
7666 mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
7667 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address)) {
7668 ipseclog((LOG_DEBUG, "key_get: invalid message is passed.\n"));
7669 return key_senderror(so, m, EINVAL);
7670 }
7671
7672 sa0 = (struct sadb_sa *)(void *)mhp->ext[SADB_EXT_SA];
7673 src0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
7674 dst0 = (struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
7675 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
7676
7677 u_int ipsec_if_index = 0;
7678 if (ipsec_if != NULL) {
7679 ipsec_if_index = ipsec_if->if_index;
7680 ifnet_release(ipsec_if);
7681 ipsec_if = NULL;
7682 }
7683
7684 /* XXX boundary check against sa_len */
7685 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, ipsec_if_index, &saidx);
7686
7687 lck_mtx_lock(sadb_mutex);
7688
7689 /* get a SA header */
7690 LIST_FOREACH(sah, &sahtree, chain) {
7691 if (sah->state == SADB_SASTATE_DEAD) {
7692 continue;
7693 }
7694 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_HEAD) == 0) {
7695 continue;
7696 }
7697
7698 /* get a SA with SPI. */
7699 sav = key_getsavbyspi(sah, sa0->sadb_sa_spi);
7700 if (sav) {
7701 break;
7702 }
7703 }
7704 if (sah == NULL) {
7705 lck_mtx_unlock(sadb_mutex);
7706 ipseclog((LOG_DEBUG, "key_get: no SA found.\n"));
7707 return key_senderror(so, m, ENOENT);
7708 }
7709
7710 {
7711 struct mbuf *n;
7712 u_int8_t satype;
7713
7714 /* map proto to satype */
7715 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
7716 lck_mtx_unlock(sadb_mutex);
7717 ipseclog((LOG_DEBUG, "key_get: there was invalid proto in SAD.\n"));
7718 return key_senderror(so, m, EINVAL);
7719 }
7720 lck_mtx_unlock(sadb_mutex);
7721
7722 /* create new sadb_msg to reply. */
7723 n = key_setdumpsa(sav, SADB_GET, satype, mhp->msg->sadb_msg_seq,
7724 mhp->msg->sadb_msg_pid);
7725
7726
7727
7728 if (!n) {
7729 return key_senderror(so, m, ENOBUFS);
7730 }
7731
7732 m_freem(m);
7733 return key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
7734 }
7735 }
7736
7737 /*
7738 * get SA stats by spi.
7739 * OUT: -1 : not found
7740 * 0 : found, arg pointer to a SA stats is updated.
7741 */
7742 static int
key_getsastatbyspi_one(u_int32_t spi,struct sastat * stat)7743 key_getsastatbyspi_one(u_int32_t spi,
7744 struct sastat *stat)
7745 {
7746 struct secashead *sah;
7747 struct secasvar *sav = NULL;
7748
7749 if ((void *)stat == NULL) {
7750 return -1;
7751 }
7752
7753 lck_mtx_lock(sadb_mutex);
7754
7755 /* get a SA header */
7756 LIST_FOREACH(sah, &sahtree, chain) {
7757 if (sah->state == SADB_SASTATE_DEAD) {
7758 continue;
7759 }
7760
7761 /* get a SA with SPI. */
7762 sav = key_getsavbyspi(sah, spi);
7763 if (sav) {
7764 stat->spi = sav->spi;
7765 stat->created = (u_int32_t)sav->created;
7766 if (sav->lft_c) {
7767 bcopy(sav->lft_c, &stat->lft_c, sizeof(stat->lft_c));
7768 } else {
7769 bzero(&stat->lft_c, sizeof(stat->lft_c));
7770 }
7771 lck_mtx_unlock(sadb_mutex);
7772 return 0;
7773 }
7774 }
7775
7776 lck_mtx_unlock(sadb_mutex);
7777
7778 return -1;
7779 }
7780
7781 /*
7782 * get SA stats collection by indices.
7783 * OUT: -1 : not found
7784 * 0 : found, arg pointers to a SA stats and 'maximum stats' are updated.
7785 */
7786 static int
key_getsastatbyspi(struct sastat * stat_arg,u_int32_t max_stat_arg,struct sastat * stat_res,u_int64_t stat_res_size,u_int32_t * max_stat_res)7787 key_getsastatbyspi(struct sastat *stat_arg,
7788 u_int32_t max_stat_arg,
7789 struct sastat *stat_res,
7790 u_int64_t stat_res_size,
7791 u_int32_t *max_stat_res)
7792 {
7793 u_int32_t cur, found = 0;
7794
7795 if (stat_arg == NULL ||
7796 stat_res == NULL ||
7797 max_stat_res == NULL) {
7798 return -1;
7799 }
7800
7801 u_int64_t max_stats = stat_res_size / (sizeof(struct sastat));
7802 max_stats = ((max_stat_arg <= max_stats) ? max_stat_arg : max_stats);
7803
7804 for (cur = 0; cur < max_stats; cur++) {
7805 if (key_getsastatbyspi_one(stat_arg[cur].spi,
7806 &stat_res[found]) == 0) {
7807 found++;
7808 }
7809 }
7810 *max_stat_res = found;
7811
7812 if (found) {
7813 return 0;
7814 }
7815 return -1;
7816 }
7817
7818 /* XXX make it sysctl-configurable? */
7819 static void
key_getcomb_setlifetime(struct sadb_comb * comb)7820 key_getcomb_setlifetime(
7821 struct sadb_comb *comb)
7822 {
7823 comb->sadb_comb_soft_allocations = 1;
7824 comb->sadb_comb_hard_allocations = 1;
7825 comb->sadb_comb_soft_bytes = 0;
7826 comb->sadb_comb_hard_bytes = 0;
7827 comb->sadb_comb_hard_addtime = 86400; /* 1 day */
7828 comb->sadb_comb_soft_addtime = comb->sadb_comb_soft_addtime * 80 / 100;
7829 comb->sadb_comb_soft_usetime = 28800; /* 8 hours */
7830 comb->sadb_comb_hard_usetime = comb->sadb_comb_hard_usetime * 80 / 100;
7831 }
7832
7833 #if IPSEC_ESP
7834 /*
7835 * XXX reorder combinations by preference
7836 * XXX no idea if the user wants ESP authentication or not
7837 */
7838 static struct mbuf *
key_getcomb_esp(void)7839 key_getcomb_esp(void)
7840 {
7841 struct sadb_comb *comb;
7842 const struct esp_algorithm *algo;
7843 struct mbuf *result = NULL, *m, *n;
7844 u_int16_t encmin;
7845 int off, o;
7846 int totlen;
7847 u_int8_t i;
7848 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
7849
7850 m = NULL;
7851 for (i = 1; i <= SADB_EALG_MAX; i++) {
7852 algo = esp_algorithm_lookup(i);
7853 if (!algo) {
7854 continue;
7855 }
7856
7857 if (algo->keymax < ipsec_esp_keymin) {
7858 continue;
7859 }
7860 if (algo->keymin < ipsec_esp_keymin) {
7861 encmin = (u_int16_t)ipsec_esp_keymin;
7862 } else {
7863 encmin = algo->keymin;
7864 }
7865
7866 if (ipsec_esp_auth) {
7867 m = key_getcomb_ah();
7868 } else {
7869 #if DIAGNOSTIC
7870 if (l > MLEN) {
7871 panic("assumption failed in key_getcomb_esp");
7872 }
7873 #endif
7874 MGET(m, M_WAITOK, MT_DATA);
7875 if (m) {
7876 M_ALIGN(m, l);
7877 m->m_len = l;
7878 m->m_next = NULL;
7879 bzero(mtod(m, caddr_t), m->m_len);
7880 }
7881 }
7882 if (!m) {
7883 goto fail;
7884 }
7885
7886 totlen = 0;
7887 for (n = m; n; n = n->m_next) {
7888 totlen += n->m_len;
7889 }
7890 #if DIAGNOSTIC
7891 if (totlen % l) {
7892 panic("assumption failed in key_getcomb_esp");
7893 }
7894 #endif
7895
7896 for (off = 0; off < totlen; off += l) {
7897 n = m_pulldown(m, off, l, &o);
7898 if (!n) {
7899 /* m is already freed */
7900 goto fail;
7901 }
7902 comb = (struct sadb_comb *)
7903 (void *)(mtod(n, caddr_t) + o);
7904 bzero(comb, sizeof(*comb));
7905 key_getcomb_setlifetime(comb);
7906 comb->sadb_comb_encrypt = i;
7907 comb->sadb_comb_encrypt_minbits = encmin;
7908 comb->sadb_comb_encrypt_maxbits = algo->keymax;
7909 }
7910
7911 if (!result) {
7912 result = m;
7913 } else {
7914 m_cat(result, m);
7915 }
7916 }
7917
7918 return result;
7919
7920 fail:
7921 if (result) {
7922 m_freem(result);
7923 }
7924 return NULL;
7925 }
7926 #endif
7927
7928 /*
7929 * XXX reorder combinations by preference
7930 */
7931 static struct mbuf *
key_getcomb_ah(void)7932 key_getcomb_ah(void)
7933 {
7934 struct sadb_comb *comb;
7935 const struct ah_algorithm *algo;
7936 struct mbuf *m;
7937 u_int16_t keymin;
7938 u_int8_t i;
7939 const int l = PFKEY_ALIGN8(sizeof(struct sadb_comb));
7940
7941 m = NULL;
7942 for (i = 1; i <= SADB_AALG_MAX; i++) {
7943 #if 1
7944 /* we prefer HMAC algorithms, not old algorithms */
7945 if (i != SADB_AALG_SHA1HMAC && i != SADB_AALG_MD5HMAC) {
7946 continue;
7947 }
7948 #endif
7949 algo = ah_algorithm_lookup(i);
7950 if (!algo) {
7951 continue;
7952 }
7953
7954 if (algo->keymax < ipsec_ah_keymin) {
7955 continue;
7956 }
7957 if (algo->keymin < ipsec_ah_keymin) {
7958 keymin = (u_int16_t)ipsec_ah_keymin;
7959 } else {
7960 keymin = algo->keymin;
7961 }
7962
7963 if (!m) {
7964 #if DIAGNOSTIC
7965 if (l > MLEN) {
7966 panic("assumption failed in key_getcomb_ah");
7967 }
7968 #endif
7969 MGET(m, M_WAITOK, MT_DATA);
7970 if (m) {
7971 M_ALIGN(m, l);
7972 m->m_len = l;
7973 m->m_next = NULL;
7974 }
7975 } else {
7976 M_PREPEND(m, l, M_WAITOK, 1);
7977 }
7978 if (!m) {
7979 return NULL;
7980 }
7981
7982 comb = mtod(m, struct sadb_comb *);
7983 bzero(comb, sizeof(*comb));
7984 key_getcomb_setlifetime(comb);
7985 comb->sadb_comb_auth = i;
7986 comb->sadb_comb_auth_minbits = keymin;
7987 comb->sadb_comb_auth_maxbits = algo->keymax;
7988 }
7989
7990 return m;
7991 }
7992
7993 /*
7994 * XXX no way to pass mode (transport/tunnel) to userland
7995 * XXX replay checking?
7996 * XXX sysctl interface to ipsec_{ah,esp}_keymin
7997 */
7998 static struct mbuf *
key_getprop(const struct secasindex * saidx)7999 key_getprop(
8000 const struct secasindex *saidx)
8001 {
8002 struct sadb_prop *prop;
8003 struct mbuf *m, *n;
8004 const int l = PFKEY_ALIGN8(sizeof(struct sadb_prop));
8005 int totlen;
8006
8007 switch (saidx->proto) {
8008 #if IPSEC_ESP
8009 case IPPROTO_ESP:
8010 m = key_getcomb_esp();
8011 break;
8012 #endif
8013 case IPPROTO_AH:
8014 m = key_getcomb_ah();
8015 break;
8016 default:
8017 return NULL;
8018 }
8019
8020 if (!m) {
8021 return NULL;
8022 }
8023 M_PREPEND(m, l, M_WAITOK, 1);
8024 if (!m) {
8025 return NULL;
8026 }
8027
8028 totlen = 0;
8029 for (n = m; n; n = n->m_next) {
8030 totlen += n->m_len;
8031 }
8032
8033 prop = mtod(m, struct sadb_prop *);
8034 bzero(prop, sizeof(*prop));
8035 VERIFY(totlen <= UINT16_MAX);
8036 prop->sadb_prop_len = (u_int16_t)PFKEY_UNIT64(totlen);
8037 prop->sadb_prop_exttype = SADB_EXT_PROPOSAL;
8038 prop->sadb_prop_replay = 32; /* XXX */
8039
8040 return m;
8041 }
8042
8043 /*
8044 * SADB_ACQUIRE processing called by key_checkrequest() and key_acquire2().
8045 * send
8046 * <base, SA, address(SD), (address(P)), x_policy,
8047 * (identity(SD),) (sensitivity,) proposal>
8048 * to KMD, and expect to receive
8049 * <base> with SADB_ACQUIRE if error occurred,
8050 * or
8051 * <base, src address, dst address, (SPI range)> with SADB_GETSPI
8052 * from KMD by PF_KEY.
8053 *
8054 * XXX x_policy is outside of RFC2367 (KAME extension).
8055 * XXX sensitivity is not supported.
8056 *
8057 * OUT:
8058 * 0 : succeed
8059 * others: error number
8060 */
8061 static int
key_acquire(struct secasindex * saidx,struct secpolicy * sp)8062 key_acquire(
8063 struct secasindex *saidx,
8064 struct secpolicy *sp)
8065 {
8066 struct mbuf *result = NULL, *m;
8067 #ifndef IPSEC_NONBLOCK_ACQUIRE
8068 struct secacq *newacq;
8069 #endif
8070 u_int8_t satype;
8071 int error = -1;
8072 u_int32_t seq;
8073
8074 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
8075
8076 /* sanity check */
8077 if (saidx == NULL) {
8078 panic("key_acquire: NULL pointer is passed.");
8079 }
8080 if ((satype = key_proto2satype(saidx->proto)) == 0) {
8081 panic("key_acquire: invalid proto is passed.");
8082 }
8083
8084 #ifndef IPSEC_NONBLOCK_ACQUIRE
8085 /*
8086 * We never do anything about acquirng SA. There is anather
8087 * solution that kernel blocks to send SADB_ACQUIRE message until
8088 * getting something message from IKEd. In later case, to be
8089 * managed with ACQUIRING list.
8090 */
8091 /* get a entry to check whether sending message or not. */
8092 lck_mtx_lock(sadb_mutex);
8093 if ((newacq = key_getacq(saidx)) != NULL) {
8094 if (key_blockacq_count < newacq->count) {
8095 /* reset counter and do send message. */
8096 newacq->count = 0;
8097 } else {
8098 /* increment counter and do nothing. */
8099 newacq->count++;
8100 lck_mtx_unlock(sadb_mutex);
8101 return 0;
8102 }
8103 } else {
8104 /* make new entry for blocking to send SADB_ACQUIRE. */
8105 if ((newacq = key_newacq(saidx)) == NULL) {
8106 lck_mtx_unlock(sadb_mutex);
8107 return ENOBUFS;
8108 }
8109
8110 /* add to acqtree */
8111 LIST_INSERT_HEAD(&acqtree, newacq, chain);
8112 key_start_timehandler();
8113 }
8114 seq = newacq->seq;
8115 lck_mtx_unlock(sadb_mutex);
8116
8117 #else
8118 seq = (acq_seq = (acq_seq == ~0 ? 1 : ++acq_seq));
8119 #endif
8120 m = key_setsadbmsg(SADB_ACQUIRE, 0, satype, seq, 0, 0);
8121 if (!m) {
8122 error = ENOBUFS;
8123 goto fail;
8124 }
8125 result = m;
8126
8127 /* set sadb_address for saidx's. */
8128 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
8129 (struct sockaddr *)&saidx->src, FULLMASK, IPSEC_ULPROTO_ANY);
8130 if (!m) {
8131 error = ENOBUFS;
8132 goto fail;
8133 }
8134 m_cat(result, m);
8135
8136 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
8137 (struct sockaddr *)&saidx->dst, FULLMASK, IPSEC_ULPROTO_ANY);
8138 if (!m) {
8139 error = ENOBUFS;
8140 goto fail;
8141 }
8142 m_cat(result, m);
8143
8144 /* XXX proxy address (optional) */
8145
8146 /* set sadb_x_policy */
8147 if (sp) {
8148 m = key_setsadbxpolicy((u_int16_t)sp->policy, sp->spidx.dir, sp->id);
8149 if (!m) {
8150 error = ENOBUFS;
8151 goto fail;
8152 }
8153 m_cat(result, m);
8154 }
8155
8156 /* XXX sensitivity (optional) */
8157
8158 /* create proposal/combination extension */
8159 m = key_getprop(saidx);
8160 /*
8161 * outside of spec; make proposal/combination extension optional.
8162 */
8163 if (m) {
8164 m_cat(result, m);
8165 }
8166
8167 if ((result->m_flags & M_PKTHDR) == 0) {
8168 error = EINVAL;
8169 goto fail;
8170 }
8171
8172 if (result->m_len < sizeof(struct sadb_msg)) {
8173 result = m_pullup(result, sizeof(struct sadb_msg));
8174 if (result == NULL) {
8175 error = ENOBUFS;
8176 goto fail;
8177 }
8178 }
8179
8180 result->m_pkthdr.len = 0;
8181 for (m = result; m; m = m->m_next) {
8182 result->m_pkthdr.len += m->m_len;
8183 }
8184
8185 VERIFY(PFKEY_UNIT64(result->m_pkthdr.len) <= UINT16_MAX);
8186 mtod(result, struct sadb_msg *)->sadb_msg_len =
8187 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
8188
8189 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
8190
8191 fail:
8192 if (result) {
8193 m_freem(result);
8194 }
8195 return error;
8196 }
8197
8198 #ifndef IPSEC_NONBLOCK_ACQUIRE
8199 static struct secacq *
key_newacq(struct secasindex * saidx)8200 key_newacq(
8201 struct secasindex *saidx)
8202 {
8203 struct secacq *newacq;
8204 struct timeval tv;
8205
8206 /* get new entry */
8207 newacq = kalloc_type(struct secacq, Z_NOWAIT_ZERO);
8208 if (newacq == NULL) {
8209 lck_mtx_unlock(sadb_mutex);
8210 newacq = kalloc_type(struct secacq, Z_WAITOK_ZERO_NOFAIL);
8211 lck_mtx_lock(sadb_mutex);
8212 }
8213
8214 /* copy secindex */
8215 bcopy(saidx, &newacq->saidx, sizeof(newacq->saidx));
8216 newacq->seq = (acq_seq == ~0 ? 1 : ++acq_seq);
8217 microtime(&tv);
8218 newacq->created = tv.tv_sec;
8219
8220 return newacq;
8221 }
8222
8223 static struct secacq *
key_getacq(struct secasindex * saidx)8224 key_getacq(
8225 struct secasindex *saidx)
8226 {
8227 struct secacq *acq;
8228
8229 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
8230
8231 LIST_FOREACH(acq, &acqtree, chain) {
8232 if (key_cmpsaidx(saidx, &acq->saidx, CMP_EXACTLY)) {
8233 return acq;
8234 }
8235 }
8236
8237 return NULL;
8238 }
8239
8240 static struct secacq *
key_getacqbyseq(u_int32_t seq)8241 key_getacqbyseq(
8242 u_int32_t seq)
8243 {
8244 struct secacq *acq;
8245
8246 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
8247
8248 LIST_FOREACH(acq, &acqtree, chain) {
8249 if (acq->seq == seq) {
8250 return acq;
8251 }
8252 }
8253
8254 return NULL;
8255 }
8256 #endif
8257
8258 static struct secspacq *
key_newspacq(struct secpolicyindex * spidx)8259 key_newspacq(
8260 struct secpolicyindex *spidx)
8261 {
8262 struct secspacq *acq;
8263 struct timeval tv;
8264
8265 /* get new entry */
8266 acq = kalloc_type(struct secspacq, Z_NOWAIT_ZERO);
8267 if (acq == NULL) {
8268 lck_mtx_unlock(sadb_mutex);
8269 acq = kalloc_type(struct secspacq, Z_WAITOK_ZERO_NOFAIL);
8270 lck_mtx_lock(sadb_mutex);
8271 }
8272
8273 /* copy secindex */
8274 bcopy(spidx, &acq->spidx, sizeof(acq->spidx));
8275 microtime(&tv);
8276 acq->created = tv.tv_sec;
8277
8278 return acq;
8279 }
8280
8281 static struct secspacq *
key_getspacq(struct secpolicyindex * spidx)8282 key_getspacq(
8283 struct secpolicyindex *spidx)
8284 {
8285 struct secspacq *acq;
8286
8287 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
8288
8289 LIST_FOREACH(acq, &spacqtree, chain) {
8290 if (key_cmpspidx_exactly(spidx, &acq->spidx)) {
8291 return acq;
8292 }
8293 }
8294
8295 return NULL;
8296 }
8297
8298 /*
8299 * SADB_ACQUIRE processing,
8300 * in first situation, is receiving
8301 * <base>
8302 * from the ikmpd, and clear sequence of its secasvar entry.
8303 *
8304 * In second situation, is receiving
8305 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
8306 * from a user land process, and return
8307 * <base, address(SD), (address(P),) (identity(SD),) (sensitivity,) proposal>
8308 * to the socket.
8309 *
8310 * m will always be freed.
8311 */
8312 static int
key_acquire2(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)8313 key_acquire2(
8314 struct socket *so,
8315 struct mbuf *m,
8316 const struct sadb_msghdr *mhp)
8317 {
8318 const struct sadb_address *src0, *dst0;
8319 ifnet_t ipsec_if = NULL;
8320 struct secasindex saidx;
8321 struct secashead *sah;
8322 u_int16_t proto;
8323 int error;
8324
8325
8326 /* sanity check */
8327 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
8328 panic("key_acquire2: NULL pointer is passed.");
8329 }
8330
8331 /*
8332 * Error message from KMd.
8333 * We assume that if error was occurred in IKEd, the length of PFKEY
8334 * message is equal to the size of sadb_msg structure.
8335 * We do not raise error even if error occurred in this function.
8336 */
8337 lck_mtx_lock(sadb_mutex);
8338
8339 if (mhp->msg->sadb_msg_len == PFKEY_UNIT64(sizeof(struct sadb_msg))) {
8340 #ifndef IPSEC_NONBLOCK_ACQUIRE
8341 struct secacq *acq;
8342 struct timeval tv;
8343
8344 /* check sequence number */
8345 if (mhp->msg->sadb_msg_seq == 0) {
8346 lck_mtx_unlock(sadb_mutex);
8347 ipseclog((LOG_DEBUG, "key_acquire2: must specify sequence number.\n"));
8348 m_freem(m);
8349 return 0;
8350 }
8351
8352 if ((acq = key_getacqbyseq(mhp->msg->sadb_msg_seq)) == NULL) {
8353 /*
8354 * the specified larval SA is already gone, or we got
8355 * a bogus sequence number. we can silently ignore it.
8356 */
8357 lck_mtx_unlock(sadb_mutex);
8358 m_freem(m);
8359 return 0;
8360 }
8361
8362 /* reset acq counter in order to deletion by timehander. */
8363 microtime(&tv);
8364 acq->created = tv.tv_sec;
8365 acq->count = 0;
8366 #endif
8367 lck_mtx_unlock(sadb_mutex);
8368 m_freem(m);
8369 return 0;
8370 }
8371
8372 /*
8373 * This message is from user land.
8374 */
8375
8376 /* map satype to proto */
8377 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
8378 lck_mtx_unlock(sadb_mutex);
8379 ipseclog((LOG_DEBUG, "key_acquire2: invalid satype is passed.\n"));
8380 return key_senderror(so, m, EINVAL);
8381 }
8382
8383 if (mhp->ext[SADB_EXT_ADDRESS_SRC] == NULL ||
8384 mhp->ext[SADB_EXT_ADDRESS_DST] == NULL ||
8385 mhp->ext[SADB_EXT_PROPOSAL] == NULL) {
8386 /* error */
8387 lck_mtx_unlock(sadb_mutex);
8388 ipseclog((LOG_DEBUG, "key_acquire2: invalid message is passed.\n"));
8389 return key_senderror(so, m, EINVAL);
8390 }
8391 if (mhp->extlen[SADB_EXT_ADDRESS_SRC] < sizeof(struct sadb_address) ||
8392 mhp->extlen[SADB_EXT_ADDRESS_DST] < sizeof(struct sadb_address) ||
8393 mhp->extlen[SADB_EXT_PROPOSAL] < sizeof(struct sadb_prop)) {
8394 /* error */
8395 lck_mtx_unlock(sadb_mutex);
8396 ipseclog((LOG_DEBUG, "key_acquire2: invalid message is passed.\n"));
8397 return key_senderror(so, m, EINVAL);
8398 }
8399
8400 src0 = (const struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_SRC];
8401 dst0 = (const struct sadb_address *)mhp->ext[SADB_EXT_ADDRESS_DST];
8402 ipsec_if = key_get_ipsec_if_from_message(mhp, SADB_X_EXT_IPSECIF);
8403
8404 u_int ipsec_if_index = 0;
8405 if (ipsec_if != NULL) {
8406 ipsec_if_index = ipsec_if->if_index;
8407 ifnet_release(ipsec_if);
8408 ipsec_if = NULL;
8409 }
8410
8411 /* XXX boundary check against sa_len */
8412 /* cast warnings */
8413 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, src0 + 1, dst0 + 1, ipsec_if_index, &saidx);
8414
8415 /* get a SA index */
8416 LIST_FOREACH(sah, &sahtree, chain) {
8417 if (sah->state == SADB_SASTATE_DEAD) {
8418 continue;
8419 }
8420 if (key_cmpsaidx(&sah->saidx, &saidx, CMP_MODE | CMP_REQID)) {
8421 break;
8422 }
8423 }
8424 if (sah != NULL) {
8425 lck_mtx_unlock(sadb_mutex);
8426 ipseclog((LOG_DEBUG, "key_acquire2: a SA exists already.\n"));
8427 return key_senderror(so, m, EEXIST);
8428 }
8429 lck_mtx_unlock(sadb_mutex);
8430 error = key_acquire(&saidx, NULL);
8431 if (error != 0) {
8432 ipseclog((LOG_DEBUG, "key_acquire2: error %d returned "
8433 "from key_acquire.\n", mhp->msg->sadb_msg_errno));
8434 return key_senderror(so, m, error);
8435 }
8436
8437 return key_sendup_mbuf(so, m, KEY_SENDUP_REGISTERED);
8438 }
8439
8440 /*
8441 * SADB_REGISTER processing.
8442 * If SATYPE_UNSPEC has been passed as satype, only return sadb_supported.
8443 * receive
8444 * <base>
8445 * from the ikmpd, and register a socket to send PF_KEY messages,
8446 * and send
8447 * <base, supported>
8448 * to KMD by PF_KEY.
8449 * If socket is detached, must free from regnode.
8450 *
8451 * m will always be freed.
8452 */
8453 static int
key_register(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)8454 key_register(
8455 struct socket *so,
8456 struct mbuf *m,
8457 const struct sadb_msghdr *mhp)
8458 {
8459 struct secreg *reg, *newreg = 0;
8460
8461 /* sanity check */
8462 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
8463 panic("key_register: NULL pointer is passed.");
8464 }
8465
8466 /* check for invalid register message */
8467 if (mhp->msg->sadb_msg_satype >= sizeof(regtree) / sizeof(regtree[0])) {
8468 return key_senderror(so, m, EINVAL);
8469 }
8470
8471 /* When SATYPE_UNSPEC is specified, only return sadb_supported. */
8472 if (mhp->msg->sadb_msg_satype == SADB_SATYPE_UNSPEC) {
8473 goto setmsg;
8474 }
8475
8476 /* create regnode */
8477 newreg = kalloc_type(struct secreg, Z_WAITOK_ZERO_NOFAIL);
8478
8479 lck_mtx_lock(sadb_mutex);
8480 /* check whether existing or not */
8481 LIST_FOREACH(reg, ®tree[mhp->msg->sadb_msg_satype], chain) {
8482 if (reg->so == so) {
8483 lck_mtx_unlock(sadb_mutex);
8484 ipseclog((LOG_DEBUG, "key_register: socket exists already.\n"));
8485 kfree_type(struct secreg, newreg);
8486 return key_senderror(so, m, EEXIST);
8487 }
8488 }
8489
8490 socket_lock(so, 1);
8491 newreg->so = so;
8492 ((struct keycb *)sotorawcb(so))->kp_registered++;
8493 socket_unlock(so, 1);
8494
8495 /* add regnode to regtree. */
8496 LIST_INSERT_HEAD(®tree[mhp->msg->sadb_msg_satype], newreg, chain);
8497 lck_mtx_unlock(sadb_mutex);
8498 setmsg:
8499 {
8500 struct mbuf *n;
8501 struct sadb_msg *newmsg;
8502 struct sadb_supported *sup;
8503 u_int16_t len, alen, elen;
8504 int off;
8505 u_int8_t i;
8506 struct sadb_alg *alg;
8507
8508 /* create new sadb_msg to reply. */
8509 alen = 0;
8510 for (i = 1; i <= SADB_AALG_MAX; i++) {
8511 if (ah_algorithm_lookup(i)) {
8512 alen += sizeof(struct sadb_alg);
8513 }
8514 }
8515 if (alen) {
8516 alen += sizeof(struct sadb_supported);
8517 }
8518 elen = 0;
8519 #if IPSEC_ESP
8520 for (i = 1; i <= SADB_EALG_MAX; i++) {
8521 if (esp_algorithm_lookup(i)) {
8522 elen += sizeof(struct sadb_alg);
8523 }
8524 }
8525 if (elen) {
8526 elen += sizeof(struct sadb_supported);
8527 }
8528 #endif
8529
8530 len = sizeof(struct sadb_msg) + alen + elen;
8531
8532 if (len > MCLBYTES) {
8533 return key_senderror(so, m, ENOBUFS);
8534 }
8535
8536 MGETHDR(n, M_WAITOK, MT_DATA);
8537 if (n && len > MHLEN) {
8538 MCLGET(n, M_WAITOK);
8539 if ((n->m_flags & M_EXT) == 0) {
8540 m_freem(n);
8541 n = NULL;
8542 }
8543 }
8544 if (!n) {
8545 return key_senderror(so, m, ENOBUFS);
8546 }
8547
8548 n->m_pkthdr.len = n->m_len = len;
8549 n->m_next = NULL;
8550 off = 0;
8551
8552 m_copydata(m, 0, sizeof(struct sadb_msg), mtod(n, caddr_t) + off);
8553 newmsg = mtod(n, struct sadb_msg *);
8554 newmsg->sadb_msg_errno = 0;
8555 VERIFY(PFKEY_UNIT64(len) <= UINT16_MAX);
8556 newmsg->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(len);
8557 off += PFKEY_ALIGN8(sizeof(struct sadb_msg));
8558
8559 /* for authentication algorithm */
8560 if (alen) {
8561 sup = (struct sadb_supported *)(void *)(mtod(n, caddr_t) + off);
8562 sup->sadb_supported_len = (u_int16_t)PFKEY_UNIT64(alen);
8563 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_AUTH;
8564 off += PFKEY_ALIGN8(sizeof(*sup));
8565
8566 for (i = 1; i <= SADB_AALG_MAX; i++) {
8567 const struct ah_algorithm *aalgo;
8568
8569 aalgo = ah_algorithm_lookup(i);
8570 if (!aalgo) {
8571 continue;
8572 }
8573 alg = (struct sadb_alg *)
8574 (void *)(mtod(n, caddr_t) + off);
8575 alg->sadb_alg_id = i;
8576 alg->sadb_alg_ivlen = 0;
8577 alg->sadb_alg_minbits = aalgo->keymin;
8578 alg->sadb_alg_maxbits = aalgo->keymax;
8579 off += PFKEY_ALIGN8(sizeof(*alg));
8580 }
8581 }
8582
8583 #if IPSEC_ESP
8584 /* for encryption algorithm */
8585 if (elen) {
8586 sup = (struct sadb_supported *)(void *)(mtod(n, caddr_t) + off);
8587 sup->sadb_supported_len = PFKEY_UNIT64(elen);
8588 sup->sadb_supported_exttype = SADB_EXT_SUPPORTED_ENCRYPT;
8589 off += PFKEY_ALIGN8(sizeof(*sup));
8590
8591 for (i = 1; i <= SADB_EALG_MAX; i++) {
8592 const struct esp_algorithm *ealgo;
8593
8594 ealgo = esp_algorithm_lookup(i);
8595 if (!ealgo) {
8596 continue;
8597 }
8598 alg = (struct sadb_alg *)
8599 (void *)(mtod(n, caddr_t) + off);
8600 alg->sadb_alg_id = i;
8601 if (ealgo && ealgo->ivlen) {
8602 /*
8603 * give NULL to get the value preferred by
8604 * algorithm XXX SADB_X_EXT_DERIV ?
8605 */
8606 VERIFY((*ealgo->ivlen)(ealgo, NULL) <= UINT8_MAX);
8607 alg->sadb_alg_ivlen =
8608 (u_int8_t)((*ealgo->ivlen)(ealgo, NULL));
8609 } else {
8610 alg->sadb_alg_ivlen = 0;
8611 }
8612 alg->sadb_alg_minbits = ealgo->keymin;
8613 alg->sadb_alg_maxbits = ealgo->keymax;
8614 off += PFKEY_ALIGN8(sizeof(struct sadb_alg));
8615 }
8616 }
8617 #endif
8618
8619 #if DIAGNOSTIC
8620 if (off != len) {
8621 panic("length assumption failed in key_register");
8622 }
8623 #endif
8624
8625 m_freem(m);
8626 return key_sendup_mbuf(so, n, KEY_SENDUP_REGISTERED);
8627 }
8628 }
8629
8630 static void
key_delete_all_for_socket(struct socket * so)8631 key_delete_all_for_socket(struct socket *so)
8632 {
8633 struct secashead *sah, *nextsah;
8634 struct secasvar *sav, *nextsav;
8635 u_int stateidx;
8636 u_int state;
8637
8638 for (sah = LIST_FIRST(&sahtree);
8639 sah != NULL;
8640 sah = nextsah) {
8641 nextsah = LIST_NEXT(sah, chain);
8642 for (stateidx = 0; stateidx < _ARRAYLEN(saorder_state_alive); stateidx++) {
8643 state = saorder_state_any[stateidx];
8644 for (sav = LIST_FIRST(&sah->savtree[state]); sav != NULL; sav = nextsav) {
8645 nextsav = LIST_NEXT(sav, chain);
8646 if (sav->flags2 & SADB_X_EXT_SA2_DELETE_ON_DETACH &&
8647 sav->so == so) {
8648 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
8649 key_freesav(sav, KEY_SADB_LOCKED);
8650 }
8651 }
8652 }
8653 }
8654 }
8655
8656 /*
8657 * free secreg entry registered.
8658 * XXX: I want to do free a socket marked done SADB_RESIGER to socket.
8659 */
8660 void
key_freereg(struct socket * so)8661 key_freereg(
8662 struct socket *so)
8663 {
8664 struct secreg *reg;
8665 int i;
8666
8667 /* sanity check */
8668 if (so == NULL) {
8669 panic("key_freereg: NULL pointer is passed.");
8670 }
8671
8672 /*
8673 * check whether existing or not.
8674 * check all type of SA, because there is a potential that
8675 * one socket is registered to multiple type of SA.
8676 */
8677 lck_mtx_lock(sadb_mutex);
8678 key_delete_all_for_socket(so);
8679 for (i = 0; i <= SADB_SATYPE_MAX; i++) {
8680 LIST_FOREACH(reg, ®tree[i], chain) {
8681 if (reg->so == so
8682 && __LIST_CHAINED(reg)) {
8683 LIST_REMOVE(reg, chain);
8684 kfree_type(struct secreg, reg);
8685 break;
8686 }
8687 }
8688 }
8689 lck_mtx_unlock(sadb_mutex);
8690 return;
8691 }
8692
8693 /*
8694 * SADB_EXPIRE processing
8695 * send
8696 * <base, SA, SA2, lifetime(C and one of HS), address(SD)>
8697 * to KMD by PF_KEY.
8698 * NOTE: We send only soft lifetime extension.
8699 *
8700 * OUT: 0 : succeed
8701 * others : error number
8702 */
8703 static int
key_expire(struct secasvar * sav)8704 key_expire(
8705 struct secasvar *sav)
8706 {
8707 u_int8_t satype;
8708 struct mbuf *result = NULL, *m;
8709 int len;
8710 int error = -1;
8711 struct sadb_lifetime *lt;
8712
8713 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
8714
8715 /* sanity check */
8716 if (sav == NULL) {
8717 panic("key_expire: NULL pointer is passed.");
8718 }
8719 if (sav->sah == NULL) {
8720 panic("key_expire: Why was SA index in SA NULL.");
8721 }
8722 if ((satype = key_proto2satype(sav->sah->saidx.proto)) == 0) {
8723 panic("key_expire: invalid proto is passed.");
8724 }
8725
8726 /* set msg header */
8727 m = key_setsadbmsg(SADB_EXPIRE, 0, satype, sav->seq, 0, (u_int16_t)sav->refcnt);
8728 if (!m) {
8729 error = ENOBUFS;
8730 goto fail;
8731 }
8732 result = m;
8733
8734 /* create SA extension */
8735 m = key_setsadbsa(sav);
8736 if (!m) {
8737 error = ENOBUFS;
8738 goto fail;
8739 }
8740 m_cat(result, m);
8741
8742 /* create SA extension */
8743 m = key_setsadbxsa2(sav->sah->saidx.mode,
8744 sav->replay[0] ? sav->replay[0]->count : 0,
8745 sav->sah->saidx.reqid,
8746 sav->flags2);
8747 if (!m) {
8748 error = ENOBUFS;
8749 goto fail;
8750 }
8751 m_cat(result, m);
8752
8753 /* create lifetime extension (current and soft) */
8754 len = PFKEY_ALIGN8(sizeof(*lt)) * 2;
8755 m = key_alloc_mbuf(len);
8756 if (!m || m->m_next) { /*XXX*/
8757 if (m) {
8758 m_freem(m);
8759 }
8760 error = ENOBUFS;
8761 goto fail;
8762 }
8763 bzero(mtod(m, caddr_t), len);
8764 lt = mtod(m, struct sadb_lifetime *);
8765 lt->sadb_lifetime_len = PFKEY_UNIT64(sizeof(struct sadb_lifetime));
8766 lt->sadb_lifetime_exttype = SADB_EXT_LIFETIME_CURRENT;
8767 lt->sadb_lifetime_allocations = sav->lft_c->sadb_lifetime_allocations;
8768 lt->sadb_lifetime_bytes = sav->lft_c->sadb_lifetime_bytes;
8769 lt->sadb_lifetime_addtime = sav->lft_c->sadb_lifetime_addtime;
8770 lt->sadb_lifetime_usetime = sav->lft_c->sadb_lifetime_usetime;
8771 lt = (struct sadb_lifetime *)(void *)(mtod(m, caddr_t) + len / 2);
8772 bcopy(sav->lft_s, lt, sizeof(*lt));
8773 m_cat(result, m);
8774
8775 /* set sadb_address for source */
8776 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
8777 (struct sockaddr *)&sav->sah->saidx.src,
8778 FULLMASK, IPSEC_ULPROTO_ANY);
8779 if (!m) {
8780 error = ENOBUFS;
8781 goto fail;
8782 }
8783 m_cat(result, m);
8784
8785 /* set sadb_address for destination */
8786 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
8787 (struct sockaddr *)&sav->sah->saidx.dst,
8788 FULLMASK, IPSEC_ULPROTO_ANY);
8789 if (!m) {
8790 error = ENOBUFS;
8791 goto fail;
8792 }
8793 m_cat(result, m);
8794
8795 if ((result->m_flags & M_PKTHDR) == 0) {
8796 error = EINVAL;
8797 goto fail;
8798 }
8799
8800 if (result->m_len < sizeof(struct sadb_msg)) {
8801 result = m_pullup(result, sizeof(struct sadb_msg));
8802 if (result == NULL) {
8803 error = ENOBUFS;
8804 goto fail;
8805 }
8806 }
8807
8808 result->m_pkthdr.len = 0;
8809 for (m = result; m; m = m->m_next) {
8810 result->m_pkthdr.len += m->m_len;
8811 }
8812
8813 VERIFY(PFKEY_UNIT64(result->m_pkthdr.len) <= UINT16_MAX);
8814 mtod(result, struct sadb_msg *)->sadb_msg_len =
8815 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
8816
8817 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
8818
8819 fail:
8820 if (result) {
8821 m_freem(result);
8822 }
8823 return error;
8824 }
8825
8826 /*
8827 * SADB_FLUSH processing
8828 * receive
8829 * <base>
8830 * from the ikmpd, and free all entries in secastree.
8831 * and send,
8832 * <base>
8833 * to the ikmpd.
8834 * NOTE: to do is only marking SADB_SASTATE_DEAD.
8835 *
8836 * m will always be freed.
8837 */
8838 static int
key_flush(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)8839 key_flush(
8840 struct socket *so,
8841 struct mbuf *m,
8842 const struct sadb_msghdr *mhp)
8843 {
8844 struct sadb_msg *newmsg;
8845 struct secashead *sah, *nextsah;
8846 struct secasvar *sav, *nextsav;
8847 u_int16_t proto;
8848 u_int state;
8849 u_int stateidx;
8850
8851 /* sanity check */
8852 if (so == NULL || mhp == NULL || mhp->msg == NULL) {
8853 panic("key_flush: NULL pointer is passed.");
8854 }
8855
8856 /* map satype to proto */
8857 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
8858 ipseclog((LOG_DEBUG, "key_flush: invalid satype is passed.\n"));
8859 return key_senderror(so, m, EINVAL);
8860 }
8861
8862 lck_mtx_lock(sadb_mutex);
8863
8864 /* no SATYPE specified, i.e. flushing all SA. */
8865 for (sah = LIST_FIRST(&sahtree);
8866 sah != NULL;
8867 sah = nextsah) {
8868 nextsah = LIST_NEXT(sah, chain);
8869
8870 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC
8871 && proto != sah->saidx.proto) {
8872 continue;
8873 }
8874
8875 for (stateidx = 0;
8876 stateidx < _ARRAYLEN(saorder_state_alive);
8877 stateidx++) {
8878 state = saorder_state_any[stateidx];
8879 for (sav = LIST_FIRST(&sah->savtree[state]);
8880 sav != NULL;
8881 sav = nextsav) {
8882 nextsav = LIST_NEXT(sav, chain);
8883
8884 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
8885 key_freesav(sav, KEY_SADB_LOCKED);
8886 }
8887 }
8888
8889 sah->state = SADB_SASTATE_DEAD;
8890 }
8891 lck_mtx_unlock(sadb_mutex);
8892
8893 if (m->m_len < sizeof(struct sadb_msg) ||
8894 sizeof(struct sadb_msg) > m->m_len + M_TRAILINGSPACE(m)) {
8895 ipseclog((LOG_DEBUG, "key_flush: No more memory.\n"));
8896 return key_senderror(so, m, ENOBUFS);
8897 }
8898
8899 if (m->m_next) {
8900 m_freem(m->m_next);
8901 }
8902 m->m_next = NULL;
8903 m->m_pkthdr.len = m->m_len = sizeof(struct sadb_msg);
8904 newmsg = mtod(m, struct sadb_msg *);
8905 newmsg->sadb_msg_errno = 0;
8906 VERIFY(PFKEY_UNIT64(m->m_pkthdr.len) <= UINT16_MAX);
8907 newmsg->sadb_msg_len = (uint16_t)PFKEY_UNIT64(m->m_pkthdr.len);
8908
8909 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
8910 }
8911
8912 /*
8913 * SADB_DUMP processing
8914 * dump all entries including status of DEAD in SAD.
8915 * receive
8916 * <base>
8917 * from the ikmpd, and dump all secasvar leaves
8918 * and send,
8919 * <base> .....
8920 * to the ikmpd.
8921 *
8922 * m will always be freed.
8923 */
8924
8925 struct sav_dump_elem {
8926 struct secasvar *sav;
8927 u_int8_t satype;
8928 };
8929
8930 static int
key_dump(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)8931 key_dump(
8932 struct socket *so,
8933 struct mbuf *m,
8934 const struct sadb_msghdr *mhp)
8935 {
8936 struct secashead *sah;
8937 struct secasvar *sav;
8938 struct sav_dump_elem *savbuf = NULL, *elem_ptr;
8939 u_int32_t bufcount = 0, cnt = 0, cnt2 = 0;
8940 u_int16_t proto;
8941 u_int stateidx;
8942 u_int8_t satype;
8943 u_int state;
8944 struct mbuf *n;
8945 int error = 0;
8946
8947 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
8948
8949 /* sanity check */
8950 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
8951 panic("key_dump: NULL pointer is passed.");
8952 }
8953
8954 /* map satype to proto */
8955 if ((proto = key_satype2proto(mhp->msg->sadb_msg_satype)) == 0) {
8956 ipseclog((LOG_DEBUG, "key_dump: invalid satype is passed.\n"));
8957 return key_senderror(so, m, EINVAL);
8958 }
8959
8960 if ((bufcount = ipsec_sav_count) == 0) {
8961 error = ENOENT;
8962 goto end;
8963 }
8964
8965 if (os_add_overflow(bufcount, 512, &bufcount)) {
8966 ipseclog((LOG_DEBUG, "key_dump: bufcount overflow, ipsec sa count %u.\n", ipsec_sav_count));
8967 bufcount = ipsec_sav_count;
8968 }
8969
8970 savbuf = kalloc_type(struct sav_dump_elem, bufcount, Z_WAITOK);
8971 if (savbuf == NULL) {
8972 ipseclog((LOG_DEBUG, "key_dump: No more memory.\n"));
8973 error = ENOMEM;
8974 goto end;
8975 }
8976
8977 /* count sav entries to be sent to the userland. */
8978 lck_mtx_lock(sadb_mutex);
8979 elem_ptr = savbuf;
8980 LIST_FOREACH(sah, &sahtree, chain) {
8981 if (mhp->msg->sadb_msg_satype != SADB_SATYPE_UNSPEC
8982 && proto != sah->saidx.proto) {
8983 continue;
8984 }
8985
8986 /* map proto to satype */
8987 if ((satype = key_proto2satype(sah->saidx.proto)) == 0) {
8988 lck_mtx_unlock(sadb_mutex);
8989 ipseclog((LOG_DEBUG, "key_dump: there was invalid proto in SAD.\n"));
8990 error = EINVAL;
8991 goto end;
8992 }
8993
8994 for (stateidx = 0;
8995 stateidx < _ARRAYLEN(saorder_state_any);
8996 stateidx++) {
8997 state = saorder_state_any[stateidx];
8998 LIST_FOREACH(sav, &sah->savtree[state], chain) {
8999 if (cnt == bufcount) {
9000 break; /* out of buffer space */
9001 }
9002 elem_ptr->sav = sav;
9003 elem_ptr->satype = satype;
9004 sav->refcnt++;
9005 elem_ptr++;
9006 cnt++;
9007 }
9008 }
9009 }
9010 lck_mtx_unlock(sadb_mutex);
9011
9012 if (cnt == 0) {
9013 error = ENOENT;
9014 goto end;
9015 }
9016
9017 /* send this to the userland, one at a time. */
9018 elem_ptr = savbuf;
9019 cnt2 = cnt;
9020 while (cnt2) {
9021 n = key_setdumpsa(elem_ptr->sav, SADB_DUMP, elem_ptr->satype,
9022 --cnt2, mhp->msg->sadb_msg_pid);
9023
9024 if (!n) {
9025 error = ENOBUFS;
9026 goto end;
9027 }
9028
9029 key_sendup_mbuf(so, n, KEY_SENDUP_ONE);
9030 elem_ptr++;
9031 }
9032
9033 end:
9034 if (savbuf) {
9035 if (cnt) {
9036 elem_ptr = savbuf;
9037 lck_mtx_lock(sadb_mutex);
9038 while (cnt--) {
9039 key_freesav((elem_ptr++)->sav, KEY_SADB_LOCKED);
9040 }
9041 lck_mtx_unlock(sadb_mutex);
9042 }
9043 kfree_type(struct sav_dump_elem, bufcount, savbuf);
9044 }
9045
9046 if (error) {
9047 return key_senderror(so, m, error);
9048 }
9049
9050 m_freem(m);
9051 return 0;
9052 }
9053
9054 /*
9055 * SADB_X_PROMISC processing
9056 *
9057 * m will always be freed.
9058 */
9059 static int
key_promisc(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)9060 key_promisc(
9061 struct socket *so,
9062 struct mbuf *m,
9063 const struct sadb_msghdr *mhp)
9064 {
9065 int olen;
9066
9067 /* sanity check */
9068 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
9069 panic("key_promisc: NULL pointer is passed.");
9070 }
9071
9072 olen = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
9073
9074 if (olen < sizeof(struct sadb_msg)) {
9075 #if 1
9076 return key_senderror(so, m, EINVAL);
9077 #else
9078 m_freem(m);
9079 return 0;
9080 #endif
9081 } else if (olen == sizeof(struct sadb_msg)) {
9082 /* enable/disable promisc mode */
9083 struct keycb *kp;
9084
9085 socket_lock(so, 1);
9086 if ((kp = (struct keycb *)sotorawcb(so)) == NULL) {
9087 return key_senderror(so, m, EINVAL);
9088 }
9089 mhp->msg->sadb_msg_errno = 0;
9090 switch (mhp->msg->sadb_msg_satype) {
9091 case 0:
9092 case 1:
9093 kp->kp_promisc = mhp->msg->sadb_msg_satype;
9094 break;
9095 default:
9096 socket_unlock(so, 1);
9097 return key_senderror(so, m, EINVAL);
9098 }
9099 socket_unlock(so, 1);
9100
9101 /* send the original message back to everyone */
9102 mhp->msg->sadb_msg_errno = 0;
9103 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
9104 } else {
9105 /* send packet as is */
9106
9107 m_adj(m, PFKEY_ALIGN8(sizeof(struct sadb_msg)));
9108
9109 /* TODO: if sadb_msg_seq is specified, send to specific pid */
9110 return key_sendup_mbuf(so, m, KEY_SENDUP_ALL);
9111 }
9112 }
9113
9114 static int(*const key_typesw[])(struct socket *, struct mbuf *,
9115 const struct sadb_msghdr *) = {
9116 NULL, /* SADB_RESERVED */
9117 key_getspi, /* SADB_GETSPI */
9118 key_update, /* SADB_UPDATE */
9119 key_add, /* SADB_ADD */
9120 key_delete, /* SADB_DELETE */
9121 key_get, /* SADB_GET */
9122 key_acquire2, /* SADB_ACQUIRE */
9123 key_register, /* SADB_REGISTER */
9124 NULL, /* SADB_EXPIRE */
9125 key_flush, /* SADB_FLUSH */
9126 key_dump, /* SADB_DUMP */
9127 key_promisc, /* SADB_X_PROMISC */
9128 NULL, /* SADB_X_PCHANGE */
9129 key_spdadd, /* SADB_X_SPDUPDATE */
9130 key_spdadd, /* SADB_X_SPDADD */
9131 key_spddelete, /* SADB_X_SPDDELETE */
9132 key_spdget, /* SADB_X_SPDGET */
9133 NULL, /* SADB_X_SPDACQUIRE */
9134 key_spddump, /* SADB_X_SPDDUMP */
9135 key_spdflush, /* SADB_X_SPDFLUSH */
9136 key_spdadd, /* SADB_X_SPDSETIDX */
9137 NULL, /* SADB_X_SPDEXPIRE */
9138 key_spddelete2, /* SADB_X_SPDDELETE2 */
9139 key_getsastat, /* SADB_GETSASTAT */
9140 key_spdenable, /* SADB_X_SPDENABLE */
9141 key_spddisable, /* SADB_X_SPDDISABLE */
9142 key_migrate, /* SADB_MIGRATE */
9143 };
9144
9145 static void
bzero_mbuf(struct mbuf * m)9146 bzero_mbuf(struct mbuf *m)
9147 {
9148 struct mbuf *mptr = m;
9149 struct sadb_msg *msg = NULL;
9150 int offset = 0;
9151
9152 if (!mptr) {
9153 return;
9154 }
9155
9156 if (mptr->m_len >= sizeof(struct sadb_msg)) {
9157 msg = mtod(mptr, struct sadb_msg *);
9158 if (msg->sadb_msg_type != SADB_ADD &&
9159 msg->sadb_msg_type != SADB_UPDATE) {
9160 return;
9161 }
9162 offset = sizeof(struct sadb_msg);
9163 }
9164 bzero(mptr->m_data + offset, mptr->m_len - offset);
9165 mptr = mptr->m_next;
9166 while (mptr != NULL) {
9167 bzero(mptr->m_data, mptr->m_len);
9168 mptr = mptr->m_next;
9169 }
9170 }
9171
9172 static void
bzero_keys(const struct sadb_msghdr * mh)9173 bzero_keys(const struct sadb_msghdr *mh)
9174 {
9175 int extlen = 0;
9176 int offset = 0;
9177
9178 if (!mh) {
9179 return;
9180 }
9181 offset = sizeof(struct sadb_key);
9182
9183 if (mh->ext[SADB_EXT_KEY_ENCRYPT]) {
9184 struct sadb_key *key = (struct sadb_key*)mh->ext[SADB_EXT_KEY_ENCRYPT];
9185 extlen = key->sadb_key_bits >> 3;
9186
9187 if (mh->extlen[SADB_EXT_KEY_ENCRYPT] >= offset + extlen) {
9188 bzero((uint8_t *)mh->ext[SADB_EXT_KEY_ENCRYPT] + offset, extlen);
9189 } else {
9190 bzero(mh->ext[SADB_EXT_KEY_ENCRYPT], mh->extlen[SADB_EXT_KEY_ENCRYPT]);
9191 }
9192 }
9193 if (mh->ext[SADB_EXT_KEY_AUTH]) {
9194 struct sadb_key *key = (struct sadb_key*)mh->ext[SADB_EXT_KEY_AUTH];
9195 extlen = key->sadb_key_bits >> 3;
9196
9197 if (mh->extlen[SADB_EXT_KEY_AUTH] >= offset + extlen) {
9198 bzero((uint8_t *)mh->ext[SADB_EXT_KEY_AUTH] + offset, extlen);
9199 } else {
9200 bzero(mh->ext[SADB_EXT_KEY_AUTH], mh->extlen[SADB_EXT_KEY_AUTH]);
9201 }
9202 }
9203 }
9204
9205 static int
key_validate_address_pair(struct sadb_address * src0,struct sadb_address * dst0)9206 key_validate_address_pair(struct sadb_address *src0,
9207 struct sadb_address *dst0)
9208 {
9209 u_int plen = 0;
9210
9211 /* check upper layer protocol */
9212 if (src0->sadb_address_proto != dst0->sadb_address_proto) {
9213 ipseclog((LOG_DEBUG, "key_parse: upper layer protocol mismatched.\n"));
9214 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9215 return EINVAL;
9216 }
9217
9218 /* check family */
9219 if (PFKEY_ADDR_SADDR(src0)->sa_family !=
9220 PFKEY_ADDR_SADDR(dst0)->sa_family) {
9221 ipseclog((LOG_DEBUG, "key_parse: address family mismatched.\n"));
9222 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9223 return EINVAL;
9224 }
9225 if (PFKEY_ADDR_SADDR(src0)->sa_len !=
9226 PFKEY_ADDR_SADDR(dst0)->sa_len) {
9227 ipseclog((LOG_DEBUG,
9228 "key_parse: address struct size mismatched.\n"));
9229 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9230 return EINVAL;
9231 }
9232
9233 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
9234 case AF_INET:
9235 if (PFKEY_ADDR_SADDR(src0)->sa_len != sizeof(struct sockaddr_in)) {
9236 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9237 return EINVAL;
9238 }
9239 break;
9240 case AF_INET6:
9241 if (PFKEY_ADDR_SADDR(src0)->sa_len != sizeof(struct sockaddr_in6)) {
9242 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9243 return EINVAL;
9244 }
9245 break;
9246 default:
9247 ipseclog((LOG_DEBUG,
9248 "key_parse: unsupported address family.\n"));
9249 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9250 return EAFNOSUPPORT;
9251 }
9252
9253 switch (PFKEY_ADDR_SADDR(src0)->sa_family) {
9254 case AF_INET:
9255 plen = sizeof(struct in_addr) << 3;
9256 break;
9257 case AF_INET6:
9258 plen = sizeof(struct in6_addr) << 3;
9259 break;
9260 default:
9261 plen = 0; /*fool gcc*/
9262 break;
9263 }
9264
9265 /* check max prefix length */
9266 if (src0->sadb_address_prefixlen > plen ||
9267 dst0->sadb_address_prefixlen > plen) {
9268 ipseclog((LOG_DEBUG,
9269 "key_parse: illegal prefixlen.\n"));
9270 PFKEY_STAT_INCREMENT(pfkeystat.out_invaddr);
9271 return EINVAL;
9272 }
9273
9274 /*
9275 * prefixlen == 0 is valid because there can be a case when
9276 * all addresses are matched.
9277 */
9278 return 0;
9279 }
9280
9281 /*
9282 * parse sadb_msg buffer to process PFKEYv2,
9283 * and create a data to response if needed.
9284 * I think to be dealed with mbuf directly.
9285 * IN:
9286 * msgp : pointer to pointer to a received buffer pulluped.
9287 * This is rewrited to response.
9288 * so : pointer to socket.
9289 * OUT:
9290 * length for buffer to send to user process.
9291 */
9292 int
key_parse(struct mbuf * m,struct socket * so)9293 key_parse(
9294 struct mbuf *m,
9295 struct socket *so)
9296 {
9297 struct sadb_msg *msg;
9298 struct sadb_msghdr mh;
9299 u_int orglen;
9300 int error;
9301 int target;
9302 Boolean keyAligned = FALSE;
9303
9304 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
9305
9306 /* sanity check */
9307 if (m == NULL || so == NULL) {
9308 panic("key_parse: NULL pointer is passed.");
9309 }
9310
9311 #if 0 /*kdebug_sadb assumes msg in linear buffer*/
9312 KEYDEBUG(KEYDEBUG_KEY_DUMP,
9313 ipseclog((LOG_DEBUG, "key_parse: passed sadb_msg\n"));
9314 kdebug_sadb(msg));
9315 #endif
9316
9317 if (m->m_len < sizeof(struct sadb_msg)) {
9318 m = m_pullup(m, sizeof(struct sadb_msg));
9319 if (!m) {
9320 return ENOBUFS;
9321 }
9322 }
9323 msg = mtod(m, struct sadb_msg *);
9324 orglen = PFKEY_UNUNIT64(msg->sadb_msg_len);
9325 target = KEY_SENDUP_ONE;
9326
9327 if ((m->m_flags & M_PKTHDR) == 0 ||
9328 m->m_pkthdr.len != orglen) {
9329 ipseclog((LOG_DEBUG, "key_parse: invalid message length.\n"));
9330 PFKEY_STAT_INCREMENT(pfkeystat.out_invlen);
9331 error = EINVAL;
9332 goto senderror;
9333 }
9334
9335 if (msg->sadb_msg_version != PF_KEY_V2) {
9336 ipseclog((LOG_DEBUG,
9337 "key_parse: PF_KEY version %u is mismatched.\n",
9338 msg->sadb_msg_version));
9339 PFKEY_STAT_INCREMENT(pfkeystat.out_invver);
9340 error = EINVAL;
9341 goto senderror;
9342 }
9343
9344 if (msg->sadb_msg_type > SADB_MAX) {
9345 ipseclog((LOG_DEBUG, "key_parse: invalid type %u is passed.\n",
9346 msg->sadb_msg_type));
9347 PFKEY_STAT_INCREMENT(pfkeystat.out_invmsgtype);
9348 error = EINVAL;
9349 goto senderror;
9350 }
9351
9352 /* for old-fashioned code - should be nuked */
9353 if (m->m_pkthdr.len > MCLBYTES) {
9354 m_freem(m);
9355 return ENOBUFS;
9356 }
9357 if (m->m_next) {
9358 struct mbuf *n;
9359
9360 MGETHDR(n, M_WAITOK, MT_DATA);
9361 if (n && m->m_pkthdr.len > MHLEN) {
9362 MCLGET(n, M_WAITOK);
9363 if ((n->m_flags & M_EXT) == 0) {
9364 m_free(n);
9365 n = NULL;
9366 }
9367 }
9368 if (!n) {
9369 bzero_mbuf(m);
9370 m_freem(m);
9371 return ENOBUFS;
9372 }
9373 m_copydata(m, 0, m->m_pkthdr.len, mtod(n, caddr_t));
9374 n->m_pkthdr.len = n->m_len = m->m_pkthdr.len;
9375 n->m_next = NULL;
9376 bzero_mbuf(m);
9377 m_freem(m);
9378 m = n;
9379 }
9380
9381 /* align the mbuf chain so that extensions are in contiguous region. */
9382 error = key_align(m, &mh);
9383 if (error) {
9384 return error;
9385 }
9386
9387 if (m->m_next) { /*XXX*/
9388 bzero_mbuf(m);
9389 m_freem(m);
9390 return ENOBUFS;
9391 }
9392
9393 keyAligned = TRUE;
9394 msg = mh.msg;
9395
9396 /* check SA type */
9397 switch (msg->sadb_msg_satype) {
9398 case SADB_SATYPE_UNSPEC:
9399 switch (msg->sadb_msg_type) {
9400 case SADB_GETSPI:
9401 case SADB_UPDATE:
9402 case SADB_ADD:
9403 case SADB_DELETE:
9404 case SADB_GET:
9405 case SADB_ACQUIRE:
9406 case SADB_EXPIRE:
9407 ipseclog((LOG_DEBUG, "key_parse: must specify satype "
9408 "when msg type=%u.\n", msg->sadb_msg_type));
9409 PFKEY_STAT_INCREMENT(pfkeystat.out_invsatype);
9410 error = EINVAL;
9411 goto senderror;
9412 }
9413 break;
9414 case SADB_SATYPE_AH:
9415 case SADB_SATYPE_ESP:
9416 switch (msg->sadb_msg_type) {
9417 case SADB_X_SPDADD:
9418 case SADB_X_SPDDELETE:
9419 case SADB_X_SPDGET:
9420 case SADB_X_SPDDUMP:
9421 case SADB_X_SPDFLUSH:
9422 case SADB_X_SPDSETIDX:
9423 case SADB_X_SPDUPDATE:
9424 case SADB_X_SPDDELETE2:
9425 case SADB_X_SPDENABLE:
9426 case SADB_X_SPDDISABLE:
9427 ipseclog((LOG_DEBUG, "key_parse: illegal satype=%u\n",
9428 msg->sadb_msg_type));
9429 PFKEY_STAT_INCREMENT(pfkeystat.out_invsatype);
9430 error = EINVAL;
9431 goto senderror;
9432 }
9433 break;
9434 case SADB_SATYPE_RSVP:
9435 case SADB_SATYPE_OSPFV2:
9436 case SADB_SATYPE_RIPV2:
9437 case SADB_SATYPE_MIP:
9438 ipseclog((LOG_DEBUG, "key_parse: type %u isn't supported.\n",
9439 msg->sadb_msg_satype));
9440 PFKEY_STAT_INCREMENT(pfkeystat.out_invsatype);
9441 error = EOPNOTSUPP;
9442 goto senderror;
9443 case 1: /* XXX: What does it do? */
9444 if (msg->sadb_msg_type == SADB_X_PROMISC) {
9445 break;
9446 }
9447 OS_FALLTHROUGH;
9448 default:
9449 ipseclog((LOG_DEBUG, "key_parse: invalid type %u is passed.\n",
9450 msg->sadb_msg_satype));
9451 PFKEY_STAT_INCREMENT(pfkeystat.out_invsatype);
9452 error = EINVAL;
9453 goto senderror;
9454 }
9455
9456 /* Validate address fields for matching families, lengths, etc. */
9457 void *src0 = mh.ext[SADB_EXT_ADDRESS_SRC];
9458 void *dst0 = mh.ext[SADB_EXT_ADDRESS_DST];
9459 if (mh.ext[SADB_X_EXT_ADDR_RANGE_SRC_START] != NULL &&
9460 mh.ext[SADB_X_EXT_ADDR_RANGE_SRC_END] != NULL) {
9461 error = key_validate_address_pair((struct sadb_address *)(mh.ext[SADB_X_EXT_ADDR_RANGE_SRC_START]),
9462 (struct sadb_address *)(mh.ext[SADB_X_EXT_ADDR_RANGE_SRC_END]));
9463 if (error != 0) {
9464 goto senderror;
9465 }
9466
9467 if (src0 == NULL) {
9468 src0 = mh.ext[SADB_X_EXT_ADDR_RANGE_SRC_START];
9469 }
9470 }
9471 if (mh.ext[SADB_X_EXT_ADDR_RANGE_DST_START] != NULL &&
9472 mh.ext[SADB_X_EXT_ADDR_RANGE_DST_END] != NULL) {
9473 error = key_validate_address_pair((struct sadb_address *)(mh.ext[SADB_X_EXT_ADDR_RANGE_DST_START]),
9474 (struct sadb_address *)(mh.ext[SADB_X_EXT_ADDR_RANGE_DST_END]));
9475 if (error != 0) {
9476 goto senderror;
9477 }
9478
9479 if (dst0 == NULL) {
9480 dst0 = mh.ext[SADB_X_EXT_ADDR_RANGE_DST_START];
9481 }
9482 }
9483 if (src0 != NULL && dst0 != NULL) {
9484 error = key_validate_address_pair((struct sadb_address *)(src0),
9485 (struct sadb_address *)(dst0));
9486 if (error != 0) {
9487 goto senderror;
9488 }
9489 }
9490
9491 void *migrate_src = mh.ext[SADB_EXT_MIGRATE_ADDRESS_SRC];
9492 void *migrate_dst = mh.ext[SADB_EXT_MIGRATE_ADDRESS_DST];
9493 if (migrate_src != NULL && migrate_dst != NULL) {
9494 error = key_validate_address_pair((struct sadb_address *)(migrate_src),
9495 (struct sadb_address *)(migrate_dst));
9496 if (error != 0) {
9497 goto senderror;
9498 }
9499 }
9500
9501 if (msg->sadb_msg_type >= sizeof(key_typesw) / sizeof(key_typesw[0]) ||
9502 key_typesw[msg->sadb_msg_type] == NULL) {
9503 PFKEY_STAT_INCREMENT(pfkeystat.out_invmsgtype);
9504 error = EINVAL;
9505 goto senderror;
9506 }
9507
9508 error = (*key_typesw[msg->sadb_msg_type])(so, m, &mh);
9509
9510 return error;
9511
9512 senderror:
9513 if (keyAligned) {
9514 bzero_keys(&mh);
9515 } else {
9516 bzero_mbuf(m);
9517 }
9518 msg->sadb_msg_errno = (u_int8_t)error;
9519 return key_sendup_mbuf(so, m, target);
9520 }
9521
9522 static int
key_senderror(struct socket * so,struct mbuf * m,int code)9523 key_senderror(
9524 struct socket *so,
9525 struct mbuf *m,
9526 int code)
9527 {
9528 struct sadb_msg *msg;
9529
9530 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
9531
9532 if (m->m_len < sizeof(struct sadb_msg)) {
9533 panic("invalid mbuf passed to key_senderror");
9534 }
9535
9536 msg = mtod(m, struct sadb_msg *);
9537 msg->sadb_msg_errno = (u_int8_t)code;
9538 return key_sendup_mbuf(so, m, KEY_SENDUP_ONE);
9539 }
9540
9541 /*
9542 * set the pointer to each header into message buffer.
9543 * m will be freed on error.
9544 * XXX larger-than-MCLBYTES extension?
9545 */
9546 static int
key_align(struct mbuf * m,struct sadb_msghdr * mhp)9547 key_align(
9548 struct mbuf *m,
9549 struct sadb_msghdr *mhp)
9550 {
9551 struct mbuf *n;
9552 struct sadb_ext *ext;
9553 size_t end;
9554 int off, extlen;
9555 int toff;
9556
9557 /* sanity check */
9558 if (m == NULL || mhp == NULL) {
9559 panic("key_align: NULL pointer is passed.");
9560 }
9561 if (m->m_len < sizeof(struct sadb_msg)) {
9562 panic("invalid mbuf passed to key_align");
9563 }
9564
9565 /* initialize */
9566 bzero(mhp, sizeof(*mhp));
9567
9568 mhp->msg = mtod(m, struct sadb_msg *);
9569 mhp->ext[0] = (struct sadb_ext *)mhp->msg; /*XXX backward compat */
9570
9571 end = PFKEY_UNUNIT64(mhp->msg->sadb_msg_len);
9572 extlen = (int)end; /*just in case extlen is not updated*/
9573 for (off = sizeof(struct sadb_msg); off < end; off += extlen) {
9574 n = m_pulldown(m, off, sizeof(struct sadb_ext), &toff);
9575 if (!n) {
9576 /* m is already freed */
9577 return ENOBUFS;
9578 }
9579 ext = (struct sadb_ext *)(void *)(mtod(n, caddr_t) + toff);
9580
9581 /* set pointer */
9582 switch (ext->sadb_ext_type) {
9583 case SADB_EXT_SA:
9584 case SADB_EXT_ADDRESS_SRC:
9585 case SADB_EXT_ADDRESS_DST:
9586 case SADB_EXT_ADDRESS_PROXY:
9587 case SADB_EXT_LIFETIME_CURRENT:
9588 case SADB_EXT_LIFETIME_HARD:
9589 case SADB_EXT_LIFETIME_SOFT:
9590 case SADB_EXT_KEY_AUTH:
9591 case SADB_EXT_KEY_ENCRYPT:
9592 case SADB_EXT_IDENTITY_SRC:
9593 case SADB_EXT_IDENTITY_DST:
9594 case SADB_EXT_SENSITIVITY:
9595 case SADB_EXT_PROPOSAL:
9596 case SADB_EXT_SUPPORTED_AUTH:
9597 case SADB_EXT_SUPPORTED_ENCRYPT:
9598 case SADB_EXT_SPIRANGE:
9599 case SADB_X_EXT_POLICY:
9600 case SADB_X_EXT_SA2:
9601 case SADB_EXT_SESSION_ID:
9602 case SADB_EXT_SASTAT:
9603 case SADB_X_EXT_IPSECIF:
9604 case SADB_X_EXT_ADDR_RANGE_SRC_START:
9605 case SADB_X_EXT_ADDR_RANGE_SRC_END:
9606 case SADB_X_EXT_ADDR_RANGE_DST_START:
9607 case SADB_X_EXT_ADDR_RANGE_DST_END:
9608 case SADB_EXT_MIGRATE_ADDRESS_SRC:
9609 case SADB_EXT_MIGRATE_ADDRESS_DST:
9610 case SADB_X_EXT_MIGRATE_IPSECIF:
9611 /* duplicate check */
9612 /*
9613 * XXX Are there duplication payloads of either
9614 * KEY_AUTH or KEY_ENCRYPT ?
9615 */
9616 if (mhp->ext[ext->sadb_ext_type] != NULL) {
9617 ipseclog((LOG_DEBUG,
9618 "key_align: duplicate ext_type %u "
9619 "is passed.\n", ext->sadb_ext_type));
9620 bzero_mbuf(m);
9621 m_freem(m);
9622 PFKEY_STAT_INCREMENT(pfkeystat.out_dupext);
9623 return EINVAL;
9624 }
9625 break;
9626 default:
9627 ipseclog((LOG_DEBUG,
9628 "key_align: invalid ext_type %u is passed.\n",
9629 ext->sadb_ext_type));
9630 bzero_mbuf(m);
9631 m_freem(m);
9632 PFKEY_STAT_INCREMENT(pfkeystat.out_invexttype);
9633 return EINVAL;
9634 }
9635
9636 extlen = PFKEY_UNUNIT64(ext->sadb_ext_len);
9637 if (off + extlen > end) {
9638 ipseclog((LOG_DEBUG,
9639 "key_align: ext type %u invalid ext length %d "
9640 "offset %d sadb message total len %zu is passed.\n",
9641 ext->sadb_ext_type, extlen, off, end));
9642 bzero_mbuf(m);
9643 m_freem(m);
9644 PFKEY_STAT_INCREMENT(pfkeystat.out_invlen);
9645 return EINVAL;
9646 }
9647
9648 if (key_validate_ext(ext, extlen)) {
9649 bzero_mbuf(m);
9650 m_freem(m);
9651 PFKEY_STAT_INCREMENT(pfkeystat.out_invlen);
9652 return EINVAL;
9653 }
9654
9655 n = m_pulldown(m, off, extlen, &toff);
9656 if (!n) {
9657 /* m is already freed */
9658 return ENOBUFS;
9659 }
9660 ext = (struct sadb_ext *)(void *)(mtod(n, caddr_t) + toff);
9661
9662 mhp->ext[ext->sadb_ext_type] = ext;
9663 mhp->extoff[ext->sadb_ext_type] = off;
9664 mhp->extlen[ext->sadb_ext_type] = extlen;
9665 }
9666
9667 if (off != end) {
9668 bzero_mbuf(m);
9669 m_freem(m);
9670 PFKEY_STAT_INCREMENT(pfkeystat.out_invlen);
9671 return EINVAL;
9672 }
9673
9674 return 0;
9675 }
9676
9677 static int
key_validate_ext(const struct sadb_ext * ext,int len)9678 key_validate_ext(
9679 const struct sadb_ext *ext,
9680 int len)
9681 {
9682 struct sockaddr *sa;
9683 enum { NONE, ADDR } checktype = NONE;
9684 int baselen = 0;
9685 const int sal = offsetof(struct sockaddr, sa_len) + sizeof(sa->sa_len);
9686
9687 if (len != PFKEY_UNUNIT64(ext->sadb_ext_len)) {
9688 return EINVAL;
9689 }
9690
9691 /* if it does not match minimum/maximum length, bail */
9692 if (ext->sadb_ext_type >= sizeof(minsize) / sizeof(minsize[0]) ||
9693 ext->sadb_ext_type >= sizeof(maxsize) / sizeof(maxsize[0])) {
9694 return EINVAL;
9695 }
9696 if (!minsize[ext->sadb_ext_type] || len < minsize[ext->sadb_ext_type]) {
9697 return EINVAL;
9698 }
9699 if (maxsize[ext->sadb_ext_type] && len > maxsize[ext->sadb_ext_type]) {
9700 return EINVAL;
9701 }
9702
9703 /* more checks based on sadb_ext_type XXX need more */
9704 switch (ext->sadb_ext_type) {
9705 case SADB_EXT_ADDRESS_SRC:
9706 case SADB_EXT_ADDRESS_DST:
9707 case SADB_EXT_ADDRESS_PROXY:
9708 case SADB_X_EXT_ADDR_RANGE_SRC_START:
9709 case SADB_X_EXT_ADDR_RANGE_SRC_END:
9710 case SADB_X_EXT_ADDR_RANGE_DST_START:
9711 case SADB_X_EXT_ADDR_RANGE_DST_END:
9712 case SADB_EXT_MIGRATE_ADDRESS_SRC:
9713 case SADB_EXT_MIGRATE_ADDRESS_DST:
9714 baselen = PFKEY_ALIGN8(sizeof(struct sadb_address));
9715 checktype = ADDR;
9716 break;
9717 case SADB_EXT_IDENTITY_SRC:
9718 case SADB_EXT_IDENTITY_DST:
9719 if (((struct sadb_ident *)(uintptr_t)(size_t)ext)->
9720 sadb_ident_type == SADB_X_IDENTTYPE_ADDR) {
9721 baselen = PFKEY_ALIGN8(sizeof(struct sadb_ident));
9722 checktype = ADDR;
9723 } else {
9724 checktype = NONE;
9725 }
9726 break;
9727 default:
9728 checktype = NONE;
9729 break;
9730 }
9731
9732 switch (checktype) {
9733 case NONE:
9734 break;
9735 case ADDR:
9736 sa = (struct sockaddr *)((caddr_t)(uintptr_t)ext + baselen);
9737
9738 if (len < baselen + sal) {
9739 return EINVAL;
9740 }
9741 if (baselen + PFKEY_ALIGN8(sa->sa_len) != len) {
9742 return EINVAL;
9743 }
9744 break;
9745 }
9746
9747 /* check key bits length */
9748 if (ext->sadb_ext_type == SADB_EXT_KEY_AUTH ||
9749 ext->sadb_ext_type == SADB_EXT_KEY_ENCRYPT) {
9750 struct sadb_key *key = (struct sadb_key *)(uintptr_t)ext;
9751 if (len < (sizeof(struct sadb_key) + _KEYLEN(key))) {
9752 return EINVAL;
9753 }
9754 }
9755
9756 return 0;
9757 }
9758
9759 /*
9760 * XXX: maybe This function is called after INBOUND IPsec processing.
9761 *
9762 * Special check for tunnel-mode packets.
9763 * We must make some checks for consistency between inner and outer IP header.
9764 *
9765 * xxx more checks to be provided
9766 */
9767 int
key_checktunnelsanity(struct secasvar * sav,__unused u_int family,__unused caddr_t src,__unused caddr_t dst)9768 key_checktunnelsanity(
9769 struct secasvar *sav,
9770 __unused u_int family,
9771 __unused caddr_t src,
9772 __unused caddr_t dst)
9773 {
9774 /* sanity check */
9775 if (sav->sah == NULL) {
9776 panic("sav->sah == NULL at key_checktunnelsanity");
9777 }
9778
9779 /* XXX: check inner IP header */
9780
9781 return 1;
9782 }
9783
9784 /* record data transfer on SA, and update timestamps */
9785 void
key_sa_recordxfer(struct secasvar * sav,struct mbuf * m)9786 key_sa_recordxfer(
9787 struct secasvar *sav,
9788 struct mbuf *m)
9789 {
9790 if (!sav) {
9791 panic("key_sa_recordxfer called with sav == NULL");
9792 }
9793 if (!m) {
9794 panic("key_sa_recordxfer called with m == NULL");
9795 }
9796 if (!sav->lft_c) {
9797 return;
9798 }
9799
9800 lck_mtx_lock(sadb_mutex);
9801 /*
9802 * XXX Currently, there is a difference of bytes size
9803 * between inbound and outbound processing.
9804 */
9805 sav->lft_c->sadb_lifetime_bytes += m->m_pkthdr.len;
9806 /* to check bytes lifetime is done in key_timehandler(). */
9807
9808 /*
9809 * We use the number of packets as the unit of
9810 * sadb_lifetime_allocations. We increment the variable
9811 * whenever {esp,ah}_{in,out}put is called.
9812 */
9813 sav->lft_c->sadb_lifetime_allocations++;
9814 /* XXX check for expires? */
9815
9816 /*
9817 * NOTE: We record CURRENT sadb_lifetime_usetime by using wall clock,
9818 * in seconds. HARD and SOFT lifetime are measured by the time
9819 * difference (again in seconds) from sadb_lifetime_usetime.
9820 *
9821 * usetime
9822 * v expire expire
9823 * -----+-----+--------+---> t
9824 * <--------------> HARD
9825 * <-----> SOFT
9826 */
9827 {
9828 struct timeval tv;
9829 microtime(&tv);
9830 sav->lft_c->sadb_lifetime_usetime = tv.tv_sec;
9831 /* XXX check for expires? */
9832 }
9833 lck_mtx_unlock(sadb_mutex);
9834
9835 return;
9836 }
9837
9838 /* dumb version */
9839 void
key_sa_routechange(struct sockaddr * dst)9840 key_sa_routechange(
9841 struct sockaddr *dst)
9842 {
9843 struct secashead *sah;
9844 struct route *ro;
9845
9846 lck_mtx_lock(sadb_mutex);
9847 LIST_FOREACH(sah, &sahtree, chain) {
9848 ro = (struct route *)&sah->sa_route;
9849 if (ro->ro_rt && dst->sa_len == ro->ro_dst.sa_len
9850 && bcmp(dst, &ro->ro_dst, dst->sa_len) == 0) {
9851 ROUTE_RELEASE(ro);
9852 }
9853 }
9854 lck_mtx_unlock(sadb_mutex);
9855
9856 return;
9857 }
9858
9859 void
key_sa_chgstate(struct secasvar * sav,u_int8_t state)9860 key_sa_chgstate(
9861 struct secasvar *sav,
9862 u_int8_t state)
9863 {
9864 if (sav == NULL) {
9865 panic("key_sa_chgstate called with sav == NULL");
9866 }
9867
9868 if (sav->state == state) {
9869 return;
9870 }
9871
9872 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_OWNED);
9873
9874 if (__LIST_CHAINED(sav)) {
9875 LIST_REMOVE(sav, chain);
9876 }
9877
9878 sav->state = state;
9879 LIST_INSERT_HEAD(&sav->sah->savtree[state], sav, chain);
9880 }
9881
9882 void
key_sa_stir_iv(struct secasvar * sav)9883 key_sa_stir_iv(
9884 struct secasvar *sav)
9885 {
9886 lck_mtx_lock(sadb_mutex);
9887 if (!sav->iv) {
9888 panic("key_sa_stir_iv called with sav == NULL");
9889 }
9890 key_randomfill(sav->iv, sav->ivlen);
9891 lck_mtx_unlock(sadb_mutex);
9892 }
9893
9894 /* XXX too much? */
9895 static struct mbuf *
key_alloc_mbuf(int l)9896 key_alloc_mbuf(
9897 int l)
9898 {
9899 struct mbuf *m = NULL, *n;
9900 int len, t;
9901
9902 len = l;
9903 while (len > 0) {
9904 MGET(n, M_DONTWAIT, MT_DATA);
9905 if (n && len > MLEN) {
9906 MCLGET(n, M_DONTWAIT);
9907 }
9908 if (!n) {
9909 m_freem(m);
9910 return NULL;
9911 }
9912
9913 n->m_next = NULL;
9914 n->m_len = 0;
9915 n->m_len = (int)M_TRAILINGSPACE(n);
9916 /* use the bottom of mbuf, hoping we can prepend afterwards */
9917 if (n->m_len > len) {
9918 t = (n->m_len - len) & ~(sizeof(long) - 1);
9919 n->m_data += t;
9920 n->m_len = len;
9921 }
9922
9923 len -= n->m_len;
9924
9925 if (m) {
9926 m_cat(m, n);
9927 } else {
9928 m = n;
9929 }
9930 }
9931
9932 return m;
9933 }
9934
9935 static struct mbuf *
key_setdumpsastats(u_int32_t dir,struct sastat * stats,u_int32_t max_stats,u_int64_t session_ids[],u_int32_t seq,u_int32_t pid)9936 key_setdumpsastats(u_int32_t dir,
9937 struct sastat *stats,
9938 u_int32_t max_stats,
9939 u_int64_t session_ids[],
9940 u_int32_t seq,
9941 u_int32_t pid)
9942 {
9943 struct mbuf *result = NULL, *m = NULL;
9944
9945 m = key_setsadbmsg(SADB_GETSASTAT, 0, 0, seq, pid, 0);
9946 if (!m) {
9947 goto fail;
9948 }
9949 result = m;
9950
9951 m = key_setsadbsession_id(session_ids);
9952 if (!m) {
9953 goto fail;
9954 }
9955 m_cat(result, m);
9956
9957 m = key_setsadbsastat(dir,
9958 stats,
9959 max_stats);
9960 if (!m) {
9961 goto fail;
9962 }
9963 m_cat(result, m);
9964
9965 if ((result->m_flags & M_PKTHDR) == 0) {
9966 goto fail;
9967 }
9968
9969 if (result->m_len < sizeof(struct sadb_msg)) {
9970 result = m_pullup(result, sizeof(struct sadb_msg));
9971 if (result == NULL) {
9972 goto fail;
9973 }
9974 }
9975
9976 result->m_pkthdr.len = 0;
9977 for (m = result; m; m = m->m_next) {
9978 result->m_pkthdr.len += m->m_len;
9979 }
9980
9981 if (PFKEY_UNIT64(result->m_pkthdr.len) > UINT16_MAX) {
9982 ipseclog((LOG_ERR, "key_setdumpsastats: length too nbug: %u", result->m_pkthdr.len));
9983 goto fail;
9984 }
9985
9986 mtod(result, struct sadb_msg *)->sadb_msg_len =
9987 (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
9988
9989 return result;
9990
9991 fail:
9992 if (result) {
9993 m_freem(result);
9994 }
9995 return NULL;
9996 }
9997
9998 /*
9999 * SADB_GETSASTAT processing
10000 * dump all stats for matching entries in SAD.
10001 *
10002 * m will always be freed.
10003 */
10004
10005 static int
key_getsastat(struct socket * so,struct mbuf * m,const struct sadb_msghdr * mhp)10006 key_getsastat(struct socket *so,
10007 struct mbuf *m,
10008 const struct sadb_msghdr *mhp)
10009 {
10010 struct sadb_session_id *session_id;
10011 size_t bufsize = 0;
10012 u_int32_t arg_count, res_count;
10013 struct sadb_sastat *sa_stats_arg;
10014 struct sastat *sa_stats_sav = NULL;
10015 struct mbuf *n;
10016 int error = 0;
10017
10018 /* sanity check */
10019 if (so == NULL || m == NULL || mhp == NULL || mhp->msg == NULL) {
10020 panic("%s: NULL pointer is passed.", __FUNCTION__);
10021 }
10022
10023 if (mhp->ext[SADB_EXT_SESSION_ID] == NULL) {
10024 printf("%s: invalid message is passed. missing session-id.\n", __FUNCTION__);
10025 return key_senderror(so, m, EINVAL);
10026 }
10027 if (mhp->extlen[SADB_EXT_SESSION_ID] < sizeof(struct sadb_session_id)) {
10028 printf("%s: invalid message is passed. short session-id.\n", __FUNCTION__);
10029 return key_senderror(so, m, EINVAL);
10030 }
10031 if (mhp->ext[SADB_EXT_SASTAT] == NULL) {
10032 printf("%s: invalid message is passed. missing stat args.\n", __FUNCTION__);
10033 return key_senderror(so, m, EINVAL);
10034 }
10035 if (mhp->extlen[SADB_EXT_SASTAT] < sizeof(*sa_stats_arg)) {
10036 printf("%s: invalid message is passed. short stat args.\n", __FUNCTION__);
10037 return key_senderror(so, m, EINVAL);
10038 }
10039
10040 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
10041
10042 // exit early if there are no active SAs
10043 if (ipsec_sav_count == 0) {
10044 printf("%s: No active SAs.\n", __FUNCTION__);
10045 error = ENOENT;
10046 goto end;
10047 }
10048
10049 if (os_mul_overflow(ipsec_sav_count + 1, sizeof(*sa_stats_sav), &bufsize)) {
10050 panic("key_getsastat bufsize requested memory overflow %u", ipsec_sav_count);
10051 }
10052
10053 sa_stats_sav = (__typeof__(sa_stats_sav))kalloc_data(bufsize, Z_WAITOK | Z_ZERO);
10054 if (sa_stats_sav == NULL) {
10055 printf("%s: No more memory.\n", __FUNCTION__);
10056 error = ENOMEM;
10057 goto end;
10058 }
10059
10060 sa_stats_arg = (__typeof__(sa_stats_arg))
10061 (void *)mhp->ext[SADB_EXT_SASTAT];
10062 arg_count = sa_stats_arg->sadb_sastat_list_len;
10063 // exit early if there are no requested SAs
10064 if (arg_count == 0) {
10065 printf("%s: No SAs requested.\n", __FUNCTION__);
10066 error = ENOENT;
10067 goto end;
10068 }
10069 if (PFKEY_UNUNIT64(sa_stats_arg->sadb_sastat_len) < (sizeof(*sa_stats_arg) +
10070 (arg_count * sizeof(struct sastat)))) {
10071 printf("%s: invalid message is passed. sa stat extlen shorter than requested stat length.\n", __FUNCTION__);
10072 error = EINVAL;
10073 goto end;
10074 }
10075
10076 res_count = 0;
10077
10078 if (key_getsastatbyspi((struct sastat *)(sa_stats_arg + 1),
10079 arg_count,
10080 sa_stats_sav,
10081 bufsize,
10082 &res_count)) {
10083 printf("%s: Error finding SAs.\n", __FUNCTION__);
10084 error = ENOENT;
10085 goto end;
10086 }
10087 if (!res_count) {
10088 printf("%s: No SAs found.\n", __FUNCTION__);
10089 error = ENOENT;
10090 goto end;
10091 }
10092
10093 session_id = (__typeof__(session_id))
10094 (void *)mhp->ext[SADB_EXT_SESSION_ID];
10095
10096 /* send this to the userland. */
10097 n = key_setdumpsastats(sa_stats_arg->sadb_sastat_dir,
10098 sa_stats_sav,
10099 res_count,
10100 session_id->sadb_session_id_v,
10101 mhp->msg->sadb_msg_seq,
10102 mhp->msg->sadb_msg_pid);
10103 if (!n) {
10104 printf("%s: No bufs to dump stats.\n", __FUNCTION__);
10105 error = ENOBUFS;
10106 goto end;
10107 }
10108
10109 key_sendup_mbuf(so, n, KEY_SENDUP_ALL);
10110 end:
10111 if (sa_stats_sav) {
10112 kfree_data(sa_stats_sav, bufsize);
10113 }
10114
10115 if (error) {
10116 return key_senderror(so, m, error);
10117 }
10118
10119 m_freem(m);
10120 return 0;
10121 }
10122
10123 static void
key_update_natt_keepalive_timestamp(struct secasvar * sav_sent,struct secasvar * sav_update)10124 key_update_natt_keepalive_timestamp(struct secasvar *sav_sent,
10125 struct secasvar *sav_update)
10126 {
10127 struct secasindex saidx_swap_sent_addr;
10128
10129 // exit early if two SAs are identical, or if sav_update is current
10130 if (sav_sent == sav_update ||
10131 sav_update->natt_last_activity == natt_now) {
10132 return;
10133 }
10134
10135 // assuming that (sav_update->remote_ike_port != 0 && (esp_udp_encap_port & 0xFFFF) != 0)
10136
10137 bzero(&saidx_swap_sent_addr, sizeof(saidx_swap_sent_addr));
10138 memcpy(&saidx_swap_sent_addr.src, &sav_sent->sah->saidx.dst, sizeof(saidx_swap_sent_addr.src));
10139 memcpy(&saidx_swap_sent_addr.dst, &sav_sent->sah->saidx.src, sizeof(saidx_swap_sent_addr.dst));
10140 saidx_swap_sent_addr.proto = sav_sent->sah->saidx.proto;
10141 saidx_swap_sent_addr.mode = sav_sent->sah->saidx.mode;
10142 // we ignore reqid for split-tunnel setups
10143
10144 if (key_cmpsaidx(&sav_sent->sah->saidx, &sav_update->sah->saidx, CMP_MODE | CMP_PORT) ||
10145 key_cmpsaidx(&saidx_swap_sent_addr, &sav_update->sah->saidx, CMP_MODE | CMP_PORT)) {
10146 sav_update->natt_last_activity = natt_now;
10147 }
10148 }
10149
10150 static int
key_send_delsp(struct secpolicy * sp)10151 key_send_delsp(struct secpolicy *sp)
10152 {
10153 struct mbuf *result = NULL, *m;
10154
10155 if (sp == NULL) {
10156 goto fail;
10157 }
10158
10159 /* set msg header */
10160 m = key_setsadbmsg(SADB_X_SPDDELETE, 0, 0, 0, 0, 0);
10161 if (!m) {
10162 goto fail;
10163 }
10164 result = m;
10165
10166 /* set sadb_address(es) for source */
10167 if (sp->spidx.src_range.start.ss_len > 0) {
10168 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_SRC_START,
10169 (struct sockaddr *)&sp->spidx.src_range.start, sp->spidx.prefs,
10170 sp->spidx.ul_proto);
10171 if (!m) {
10172 goto fail;
10173 }
10174 m_cat(result, m);
10175
10176 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_SRC_END,
10177 (struct sockaddr *)&sp->spidx.src_range.end, sp->spidx.prefs,
10178 sp->spidx.ul_proto);
10179 if (!m) {
10180 goto fail;
10181 }
10182 m_cat(result, m);
10183 } else {
10184 m = key_setsadbaddr(SADB_EXT_ADDRESS_SRC,
10185 (struct sockaddr *)&sp->spidx.src, sp->spidx.prefs,
10186 sp->spidx.ul_proto);
10187 if (!m) {
10188 goto fail;
10189 }
10190 m_cat(result, m);
10191 }
10192
10193 /* set sadb_address(es) for destination */
10194 if (sp->spidx.dst_range.start.ss_len > 0) {
10195 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_DST_START,
10196 (struct sockaddr *)&sp->spidx.dst_range.start, sp->spidx.prefd,
10197 sp->spidx.ul_proto);
10198 if (!m) {
10199 goto fail;
10200 }
10201 m_cat(result, m);
10202
10203 m = key_setsadbaddr(SADB_X_EXT_ADDR_RANGE_DST_END,
10204 (struct sockaddr *)&sp->spidx.dst_range.end, sp->spidx.prefd,
10205 sp->spidx.ul_proto);
10206 if (!m) {
10207 goto fail;
10208 }
10209 m_cat(result, m);
10210 } else {
10211 m = key_setsadbaddr(SADB_EXT_ADDRESS_DST,
10212 (struct sockaddr *)&sp->spidx.dst, sp->spidx.prefd,
10213 sp->spidx.ul_proto);
10214 if (!m) {
10215 goto fail;
10216 }
10217 m_cat(result, m);
10218 }
10219
10220 /* set secpolicy */
10221 m = key_sp2msg(sp);
10222 if (!m) {
10223 goto fail;
10224 }
10225 m_cat(result, m);
10226
10227 if ((result->m_flags & M_PKTHDR) == 0) {
10228 goto fail;
10229 }
10230
10231 if (result->m_len < sizeof(struct sadb_msg)) {
10232 result = m_pullup(result, sizeof(struct sadb_msg));
10233 if (result == NULL) {
10234 goto fail;
10235 }
10236 }
10237
10238 result->m_pkthdr.len = 0;
10239 for (m = result; m; m = m->m_next) {
10240 result->m_pkthdr.len += m->m_len;
10241 }
10242
10243 if (PFKEY_UNIT64(result->m_pkthdr.len) >= UINT16_MAX) {
10244 ipseclog((LOG_ERR, "key_send_delsp: length too big: %d", result->m_pkthdr.len));
10245 goto fail;
10246 }
10247
10248 mtod(result, struct sadb_msg *)->sadb_msg_len = (u_int16_t)PFKEY_UNIT64(result->m_pkthdr.len);
10249
10250 return key_sendup_mbuf(NULL, result, KEY_SENDUP_REGISTERED);
10251
10252 fail:
10253 if (result) {
10254 m_free(result);
10255 }
10256 return -1;
10257 }
10258
10259 void
key_delsp_for_ipsec_if(ifnet_t ipsec_if)10260 key_delsp_for_ipsec_if(ifnet_t ipsec_if)
10261 {
10262 struct secashead *sah;
10263 struct secasvar *sav, *nextsav;
10264 u_int stateidx;
10265 u_int state;
10266 struct secpolicy *sp, *nextsp;
10267 int dir;
10268
10269 if (ipsec_if == NULL) {
10270 return;
10271 }
10272
10273 LCK_MTX_ASSERT(sadb_mutex, LCK_MTX_ASSERT_NOTOWNED);
10274
10275 lck_mtx_lock(sadb_mutex);
10276
10277 for (dir = 0; dir < IPSEC_DIR_MAX; dir++) {
10278 for (sp = LIST_FIRST(&sptree[dir]);
10279 sp != NULL;
10280 sp = nextsp) {
10281 nextsp = LIST_NEXT(sp, chain);
10282
10283 if (sp->ipsec_if == ipsec_if) {
10284 ifnet_release(sp->ipsec_if);
10285 sp->ipsec_if = NULL;
10286
10287 key_send_delsp(sp);
10288
10289 sp->state = IPSEC_SPSTATE_DEAD;
10290 key_freesp(sp, KEY_SADB_LOCKED);
10291 }
10292 }
10293 }
10294
10295 LIST_FOREACH(sah, &sahtree, chain) {
10296 if (sah->ipsec_if == ipsec_if) {
10297 /* This SAH is linked to the IPsec interface. It now needs to close. */
10298 ifnet_release(sah->ipsec_if);
10299 sah->ipsec_if = NULL;
10300
10301 for (stateidx = 0; stateidx < _ARRAYLEN(saorder_state_alive); stateidx++) {
10302 state = saorder_state_any[stateidx];
10303 for (sav = LIST_FIRST(&sah->savtree[state]); sav != NULL; sav = nextsav) {
10304 nextsav = LIST_NEXT(sav, chain);
10305
10306 key_sa_chgstate(sav, SADB_SASTATE_DEAD);
10307 key_freesav(sav, KEY_SADB_LOCKED);
10308 }
10309 }
10310
10311 sah->state = SADB_SASTATE_DEAD;
10312 }
10313 }
10314
10315 lck_mtx_unlock(sadb_mutex);
10316 }
10317
10318 __private_extern__ u_int32_t
key_fill_offload_frames_for_savs(ifnet_t ifp,struct ifnet_keepalive_offload_frame * frames_array,u_int32_t frames_array_count,size_t frame_data_offset)10319 key_fill_offload_frames_for_savs(ifnet_t ifp,
10320 struct ifnet_keepalive_offload_frame *frames_array,
10321 u_int32_t frames_array_count,
10322 size_t frame_data_offset)
10323 {
10324 struct secashead *sah = NULL;
10325 struct secasvar *sav = NULL;
10326 struct ifnet_keepalive_offload_frame *frame = frames_array;
10327 u_int32_t frame_index = 0;
10328
10329 if (frame == NULL || frames_array_count == 0) {
10330 return frame_index;
10331 }
10332
10333 lck_mtx_lock(sadb_mutex);
10334 LIST_FOREACH(sah, &sahtree, chain) {
10335 LIST_FOREACH(sav, &sah->savtree[SADB_SASTATE_MATURE], chain) {
10336 if (ipsec_fill_offload_frame(ifp, sav, frame, frame_data_offset)) {
10337 frame_index++;
10338 if (frame_index >= frames_array_count) {
10339 lck_mtx_unlock(sadb_mutex);
10340 return frame_index;
10341 }
10342 frame = &(frames_array[frame_index]);
10343 }
10344 }
10345 }
10346 lck_mtx_unlock(sadb_mutex);
10347
10348 return frame_index;
10349 }
10350
10351 #pragma mark Custom IPsec
10352
10353 __private_extern__ bool
key_custom_ipsec_token_is_valid(void * ipsec_token)10354 key_custom_ipsec_token_is_valid(void *ipsec_token)
10355 {
10356 if (ipsec_token == NULL) {
10357 return false;
10358 }
10359
10360 struct secashead *sah = (struct secashead *)ipsec_token;
10361
10362 return (sah->flags & SECURITY_ASSOCIATION_CUSTOM_IPSEC) == SECURITY_ASSOCIATION_CUSTOM_IPSEC;
10363 }
10364
10365 __private_extern__ int
key_reserve_custom_ipsec(void ** ipsec_token,union sockaddr_in_4_6 * src,union sockaddr_in_4_6 * dst,u_int8_t proto)10366 key_reserve_custom_ipsec(void **ipsec_token, union sockaddr_in_4_6 *src, union sockaddr_in_4_6 *dst,
10367 u_int8_t proto)
10368 {
10369 if (src == NULL || dst == NULL) {
10370 ipseclog((LOG_ERR, "register custom ipsec: invalid address\n"));
10371 return EINVAL;
10372 }
10373
10374 if (src->sa.sa_family != dst->sa.sa_family) {
10375 ipseclog((LOG_ERR, "register custom ipsec: address family mismatched\n"));
10376 return EINVAL;
10377 }
10378
10379 if (src->sa.sa_len != dst->sa.sa_len) {
10380 ipseclog((LOG_ERR, "register custom ipsec: address struct size mismatched\n"));
10381 return EINVAL;
10382 }
10383
10384 if (ipsec_token == NULL) {
10385 ipseclog((LOG_ERR, "register custom ipsec: invalid ipsec token\n"));
10386 return EINVAL;
10387 }
10388
10389 switch (src->sa.sa_family) {
10390 case AF_INET:
10391 if (src->sa.sa_len != sizeof(struct sockaddr_in)) {
10392 ipseclog((LOG_ERR, "register custom esp: invalid address length\n"));
10393 return EINVAL;
10394 }
10395 break;
10396 case AF_INET6:
10397 if (src->sa.sa_len != sizeof(struct sockaddr_in6)) {
10398 ipseclog((LOG_ERR, "register custom esp: invalid address length\n"));
10399 return EINVAL;
10400 }
10401 break;
10402 default:
10403 ipseclog((LOG_ERR, "register custom esp: invalid address length\n"));
10404 return EAFNOSUPPORT;
10405 }
10406
10407 if (proto != IPPROTO_ESP && proto != IPPROTO_AH) {
10408 ipseclog((LOG_ERR, "register custom esp: invalid proto %u\n", proto));
10409 return EINVAL;
10410 }
10411
10412 struct secasindex saidx = {};
10413 KEY_SETSECASIDX(proto, IPSEC_MODE_ANY, 0, &src->sa, &dst->sa, 0, &saidx);
10414
10415 lck_mtx_lock(sadb_mutex);
10416
10417 struct secashead *sah = NULL;
10418 if ((sah = key_getsah(&saidx, SECURITY_ASSOCIATION_ANY)) != NULL) {
10419 lck_mtx_unlock(sadb_mutex);
10420 ipseclog((LOG_ERR, "register custom esp: SA exists\n"));
10421 return EEXIST;
10422 }
10423
10424 if ((sah = key_newsah(&saidx, NULL, 0, IPSEC_DIR_ANY, SECURITY_ASSOCIATION_CUSTOM_IPSEC)) == NULL) {
10425 lck_mtx_unlock(sadb_mutex);
10426 ipseclog((LOG_DEBUG, "register custom esp: No more memory.\n"));
10427 return ENOBUFS;
10428 }
10429
10430 *ipsec_token = (void *)sah;
10431
10432 lck_mtx_unlock(sadb_mutex);
10433 return 0;
10434 }
10435
10436 __private_extern__ void
key_release_custom_ipsec(void ** ipsec_token)10437 key_release_custom_ipsec(void **ipsec_token)
10438 {
10439 struct secashead *sah = *ipsec_token;
10440 VERIFY(sah != NULL);
10441
10442 lck_mtx_lock(sadb_mutex);
10443
10444 VERIFY((sah->flags & SECURITY_ASSOCIATION_CUSTOM_IPSEC) == SECURITY_ASSOCIATION_CUSTOM_IPSEC);
10445
10446 bool sa_present = true;
10447 if (LIST_FIRST(&sah->savtree[SADB_SASTATE_LARVAL]) == NULL &&
10448 LIST_FIRST(&sah->savtree[SADB_SASTATE_MATURE]) == NULL &&
10449 LIST_FIRST(&sah->savtree[SADB_SASTATE_DYING]) == NULL &&
10450 LIST_FIRST(&sah->savtree[SADB_SASTATE_DEAD]) == NULL) {
10451 sa_present = false;
10452 }
10453 VERIFY(sa_present == false);
10454
10455 key_delsah(sah);
10456
10457 lck_mtx_unlock(sadb_mutex);
10458
10459 *ipsec_token = NULL;
10460 return;
10461 }
10462