portalgo.c revision 1.5 1 1.5 pooka /* $NetBSD: portalgo.c,v 1.5 2013/06/01 11:01:48 pooka Exp $ */
2 1.1 christos
3 1.1 christos /*
4 1.1 christos * Copyright 2011 Vlad Balan
5 1.1 christos *
6 1.1 christos * Written by Vlad Balan for the NetBSD Foundation.
7 1.1 christos *
8 1.1 christos * Redistribution and use in source and binary forms, with or without
9 1.1 christos * modification, are permitted provided that the following conditions
10 1.1 christos * are met:
11 1.1 christos * 1. Redistributions of source code must retain the above copyright
12 1.1 christos * notice, this list of conditions and the following disclaimer.
13 1.1 christos * 2. Redistributions in binary form must reproduce the above copyright
14 1.1 christos * notice, this list of conditions and the following disclaimer in the
15 1.1 christos * documentation and/or other materials provided with the distribution.
16 1.1 christos *
17 1.1 christos * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 1.1 christos * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 1.1 christos * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 1.1 christos * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 1.1 christos * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 1.1 christos * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 1.1 christos * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 1.1 christos * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 1.1 christos * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 1.1 christos * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 1.1 christos * SUCH DAMAGE.
28 1.1 christos *
29 1.1 christos */
30 1.1 christos
31 1.1 christos /*
32 1.1 christos * see:
33 1.1 christos * RFC 6056 Recommendations for Transport-Protocol Port Randomization
34 1.1 christos */
35 1.1 christos
36 1.1 christos #include <sys/cdefs.h>
37 1.5 pooka __KERNEL_RCSID(0, "$NetBSD: portalgo.c,v 1.5 2013/06/01 11:01:48 pooka Exp $");
38 1.1 christos
39 1.1 christos #include "opt_inet.h"
40 1.1 christos
41 1.1 christos #include <sys/param.h>
42 1.1 christos #include <sys/errno.h>
43 1.1 christos #include <sys/kauth.h>
44 1.1 christos #include <sys/uidinfo.h>
45 1.1 christos #include <sys/domain.h>
46 1.1 christos #include <sys/md5.h>
47 1.1 christos #include <sys/cprng.h>
48 1.3 christos #include <sys/bitops.h>
49 1.1 christos
50 1.1 christos #include <net/if.h>
51 1.1 christos #include <net/route.h>
52 1.1 christos
53 1.1 christos #include <netinet/in.h>
54 1.1 christos #include <netinet/in_systm.h>
55 1.1 christos #include <netinet/ip.h>
56 1.1 christos #include <netinet/in_pcb.h>
57 1.1 christos #include <netinet/in_var.h>
58 1.1 christos #include <netinet/ip_var.h>
59 1.1 christos
60 1.1 christos #ifdef INET6
61 1.1 christos #include <netinet/ip6.h>
62 1.1 christos #include <netinet6/ip6_var.h>
63 1.1 christos #include <netinet6/in6_pcb.h>
64 1.1 christos #endif
65 1.1 christos
66 1.1 christos #include <netinet/tcp_vtw.h>
67 1.1 christos
68 1.1 christos #include "portalgo.h"
69 1.1 christos
70 1.1 christos #define NPROTO 2
71 1.1 christos #define PORTALGO_TCP 0
72 1.1 christos #define PORTALGO_UDP 1
73 1.1 christos
74 1.1 christos #define NAF 2
75 1.1 christos #define PORTALGO_IPV4 0
76 1.1 christos #define PORTALGO_IPV6 1
77 1.1 christos
78 1.1 christos #define NRANGES 2
79 1.1 christos #define PORTALGO_LOWPORT 0
80 1.1 christos #define PORTALGO_HIGHPORT 1
81 1.1 christos
82 1.1 christos #if PORTALGO_DEBUG
83 1.1 christos static bool portalgo_debug = true;
84 1.1 christos #define DPRINTF if (portalgo_debug) printf
85 1.1 christos #else
86 1.1 christos #define DPRINTF while (/*CONSTCOND*/0) printf
87 1.1 christos #endif
88 1.1 christos
89 1.5 pooka #ifndef PORTALGO_INET4_DEFAULT
90 1.5 pooka #define PORTALGO_INET4_DEFAULT PORTALGO_BSD
91 1.5 pooka #endif
92 1.5 pooka #ifndef PORTALGO_INET6_DEFAULT
93 1.5 pooka #define PORTALGO_INET6_DEFAULT PORTALGO_BSD
94 1.5 pooka #endif
95 1.5 pooka
96 1.4 christos typedef __BITMAP_TYPE(, uint32_t, 0x10000) bitmap;
97 1.1 christos #ifdef INET
98 1.5 pooka static int inet4_portalgo = PORTALGO_INET4_DEFAULT;
99 1.4 christos static bitmap inet4_reserve;
100 1.1 christos #endif
101 1.1 christos #ifdef INET6
102 1.5 pooka static int inet6_portalgo = PORTALGO_INET6_DEFAULT;
103 1.4 christos static bitmap inet6_reserve;
104 1.1 christos #endif
105 1.1 christos
106 1.1 christos typedef struct {
107 1.1 christos const char *name;
108 1.1 christos int (*func)(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
109 1.1 christos } portalgo_algorithm_t;
110 1.1 christos
111 1.1 christos static int algo_bsd(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
112 1.1 christos static int algo_random_start(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
113 1.1 christos static int algo_random_pick(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
114 1.1 christos static int algo_hash(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
115 1.1 christos static int algo_doublehash(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
116 1.1 christos static int algo_randinc(int, uint16_t *, struct inpcb_hdr *, kauth_cred_t);
117 1.1 christos
118 1.1 christos static const portalgo_algorithm_t algos[] = {
119 1.1 christos {
120 1.1 christos .name = "bsd",
121 1.1 christos .func = algo_bsd
122 1.1 christos },
123 1.1 christos {
124 1.1 christos .name = "random_start",
125 1.1 christos .func = algo_random_start
126 1.1 christos },
127 1.1 christos {
128 1.1 christos .name = "random_pick",
129 1.1 christos .func = algo_random_pick
130 1.1 christos },
131 1.1 christos {
132 1.1 christos .name = "hash",
133 1.1 christos .func = algo_hash
134 1.1 christos },
135 1.1 christos {
136 1.1 christos .name = "doublehash",
137 1.1 christos .func = algo_doublehash
138 1.1 christos },
139 1.1 christos {
140 1.1 christos .name = "randinc",
141 1.1 christos .func = algo_randinc
142 1.1 christos }
143 1.1 christos };
144 1.1 christos
145 1.1 christos #define NALGOS __arraycount(algos)
146 1.1 christos
147 1.1 christos static uint16_t portalgo_next_ephemeral[NPROTO][NAF][NRANGES][NALGOS];
148 1.1 christos
149 1.1 christos /*
150 1.1 christos * Access the pcb and copy the values of the last port and the ends of
151 1.1 christos * the port range.
152 1.1 christos */
153 1.1 christos static int
154 1.1 christos pcb_getports(struct inpcb_hdr *inp_hdr, uint16_t *lastport,
155 1.1 christos uint16_t *mymin, uint16_t *mymax, uint16_t **pnext_ephemeral, int algo)
156 1.1 christos {
157 1.1 christos struct inpcbtable * const table = inp_hdr->inph_table;
158 1.1 christos struct socket *so;
159 1.1 christos int portalgo_proto;
160 1.1 christos int portalgo_af;
161 1.1 christos int portalgo_range;
162 1.1 christos
163 1.1 christos so = inp_hdr->inph_socket;
164 1.1 christos switch (so->so_type) {
165 1.1 christos case SOCK_DGRAM: /* UDP or DCCP */
166 1.1 christos portalgo_proto = PORTALGO_UDP;
167 1.1 christos break;
168 1.1 christos case SOCK_STREAM: /* TCP or SCTP */
169 1.1 christos portalgo_proto = PORTALGO_TCP;
170 1.1 christos break;
171 1.1 christos default:
172 1.1 christos return EPFNOSUPPORT;
173 1.1 christos }
174 1.1 christos
175 1.1 christos switch (inp_hdr->inph_af) {
176 1.1 christos #ifdef INET
177 1.1 christos case AF_INET: {
178 1.1 christos struct inpcb *inp = (struct inpcb *)(void *)inp_hdr;
179 1.1 christos
180 1.1 christos portalgo_af = PORTALGO_IPV4;
181 1.1 christos if (inp->inp_flags & INP_LOWPORT) {
182 1.1 christos *mymin = lowportmin;
183 1.1 christos *mymax = lowportmax;
184 1.1 christos *lastport = table->inpt_lastlow;
185 1.1 christos portalgo_range = PORTALGO_LOWPORT;
186 1.1 christos } else {
187 1.1 christos *mymin = anonportmin;
188 1.1 christos *mymax = anonportmax;
189 1.1 christos *lastport = table->inpt_lastport;
190 1.1 christos portalgo_range = PORTALGO_HIGHPORT;
191 1.1 christos }
192 1.1 christos break;
193 1.1 christos }
194 1.1 christos #endif
195 1.1 christos #ifdef INET6
196 1.1 christos case AF_INET6: {
197 1.1 christos struct in6pcb *in6p = (struct in6pcb *)(void *)inp_hdr;
198 1.1 christos
199 1.1 christos portalgo_af = PORTALGO_IPV6;
200 1.1 christos if (in6p->in6p_flags & IN6P_LOWPORT) {
201 1.1 christos *mymin = ip6_lowportmin;
202 1.1 christos *mymax = ip6_lowportmax;
203 1.1 christos *lastport = table->inpt_lastlow;
204 1.1 christos portalgo_range = PORTALGO_LOWPORT;
205 1.1 christos } else {
206 1.1 christos *mymin = ip6_anonportmin;
207 1.1 christos *mymax = ip6_anonportmax;
208 1.1 christos *lastport = table->inpt_lastport;
209 1.1 christos portalgo_range = PORTALGO_HIGHPORT;
210 1.1 christos }
211 1.1 christos break;
212 1.1 christos }
213 1.1 christos #endif
214 1.1 christos default:
215 1.1 christos return EAFNOSUPPORT;
216 1.1 christos }
217 1.1 christos
218 1.1 christos if (*mymin > *mymax) { /* sanity check */
219 1.1 christos u_int16_t swp;
220 1.1 christos
221 1.1 christos swp = *mymin;
222 1.1 christos *mymin = *mymax;
223 1.1 christos *mymax = swp;
224 1.1 christos }
225 1.1 christos
226 1.1 christos DPRINTF("%s mymin:%d mymax:%d lastport:%d\n", __func__,
227 1.1 christos *mymin, *mymax, *lastport);
228 1.1 christos
229 1.1 christos *pnext_ephemeral = &portalgo_next_ephemeral[portalgo_proto]
230 1.1 christos [portalgo_af][portalgo_range][algo];
231 1.1 christos
232 1.1 christos DPRINTF("%s portalgo_proto:%d portalgo_af:%d portalgo_range:%d\n",
233 1.1 christos __func__, portalgo_proto, portalgo_af, portalgo_range);
234 1.1 christos return 0;
235 1.1 christos }
236 1.1 christos
237 1.1 christos /*
238 1.1 christos * Check whether the port picked by the port randomizer is available
239 1.1 christos * and whether KAUTH approves of our choice. This part of the code
240 1.1 christos * shamelessly copied from in_pcb.c.
241 1.1 christos */
242 1.1 christos static bool
243 1.1 christos check_suitable_port(uint16_t port, struct inpcb_hdr *inp_hdr, kauth_cred_t cred)
244 1.1 christos {
245 1.1 christos struct inpcbtable * const table = inp_hdr->inph_table;
246 1.1 christos #ifdef INET
247 1.1 christos vestigial_inpcb_t vestigial;
248 1.1 christos #endif
249 1.1 christos int error;
250 1.1 christos #ifdef INET6
251 1.1 christos struct socket *so;
252 1.1 christos int wild = 0;
253 1.1 christos #endif
254 1.1 christos
255 1.1 christos DPRINTF("%s called for argument %d\n", __func__, port);
256 1.1 christos
257 1.1 christos switch (inp_hdr->inph_af) {
258 1.1 christos #ifdef INET
259 1.1 christos case AF_INET: { /* IPv4 */
260 1.1 christos struct inpcb *inp = (struct inpcb *)(void *)inp_hdr;
261 1.1 christos struct inpcb *pcb;
262 1.1 christos struct sockaddr_in sin;
263 1.1 christos
264 1.4 christos if (__BITMAP_ISSET(port, &inet4_reserve))
265 1.2 christos return false;
266 1.2 christos
267 1.1 christos sin.sin_addr = inp->inp_laddr;
268 1.1 christos pcb = in_pcblookup_port(table, sin.sin_addr, htons(port), 1,
269 1.1 christos &vestigial);
270 1.1 christos
271 1.1 christos DPRINTF("%s in_pcblookup_port returned %p and "
272 1.1 christos "vestigial.valid %d\n",
273 1.1 christos __func__, pcb, vestigial.valid);
274 1.1 christos
275 1.1 christos if ((!pcb) && (!vestigial.valid)) {
276 1.1 christos enum kauth_network_req req;
277 1.1 christos
278 1.1 christos /* We have a free port. Check with the secmodel. */
279 1.1 christos if (inp->inp_flags & INP_LOWPORT) {
280 1.1 christos #ifndef IPNOPRIVPORTS
281 1.1 christos req = KAUTH_REQ_NETWORK_BIND_PRIVPORT;
282 1.1 christos #else
283 1.1 christos req = KAUTH_REQ_NETWORK_BIND_PORT;
284 1.1 christos #endif
285 1.1 christos } else
286 1.1 christos req = KAUTH_REQ_NETWORK_BIND_PORT;
287 1.1 christos
288 1.1 christos sin.sin_port = port;
289 1.1 christos error = kauth_authorize_network(cred,
290 1.1 christos KAUTH_NETWORK_BIND,
291 1.1 christos req, inp->inp_socket, &sin, NULL);
292 1.1 christos DPRINTF("%s kauth_authorize_network returned %d\n",
293 1.1 christos __func__, error);
294 1.1 christos
295 1.1 christos if (error == 0) {
296 1.1 christos DPRINTF("%s port approved\n", __func__);
297 1.1 christos return true; /* KAUTH agrees */
298 1.1 christos }
299 1.1 christos }
300 1.1 christos break;
301 1.1 christos }
302 1.1 christos #endif
303 1.1 christos #ifdef INET6
304 1.1 christos case AF_INET6: { /* IPv6 */
305 1.1 christos struct in6pcb *in6p = (struct in6pcb *)(void *)inp_hdr;
306 1.1 christos struct sockaddr_in6 sin6;
307 1.1 christos void *t;
308 1.1 christos
309 1.4 christos if (__BITMAP_ISSET(port, &inet6_reserve))
310 1.2 christos return false;
311 1.2 christos
312 1.1 christos sin6.sin6_addr = in6p->in6p_laddr;
313 1.1 christos so = in6p->in6p_socket;
314 1.1 christos
315 1.1 christos /* XXX: this is redundant when called from in6_pcbbind */
316 1.1 christos if ((so->so_options & (SO_REUSEADDR|SO_REUSEPORT)) == 0 &&
317 1.1 christos ((so->so_proto->pr_flags & PR_CONNREQUIRED) == 0 ||
318 1.1 christos (so->so_options & SO_ACCEPTCONN) == 0))
319 1.1 christos wild = 1;
320 1.1 christos
321 1.1 christos #ifdef INET
322 1.1 christos if (IN6_IS_ADDR_V4MAPPED(&sin6.sin6_addr)) {
323 1.1 christos t = in_pcblookup_port(table,
324 1.1 christos *(struct in_addr *)&sin6.sin6_addr.s6_addr32[3],
325 1.1 christos htons(port), wild, &vestigial);
326 1.1 christos if (!t && vestigial.valid) {
327 1.1 christos DPRINTF("%s in_pcblookup_port returned "
328 1.1 christos "a result\n", __func__);
329 1.1 christos return false;
330 1.1 christos }
331 1.1 christos } else
332 1.1 christos #endif
333 1.1 christos {
334 1.1 christos t = in6_pcblookup_port(table, &sin6.sin6_addr,
335 1.1 christos htons(port), wild, &vestigial);
336 1.1 christos if (!t && vestigial.valid) {
337 1.1 christos DPRINTF("%s in6_pcblookup_port returned "
338 1.1 christos "a result\n", __func__);
339 1.1 christos return false;
340 1.1 christos }
341 1.1 christos }
342 1.1 christos if (t == NULL) {
343 1.1 christos enum kauth_network_req req;
344 1.1 christos
345 1.1 christos /* We have a free port. Check with the secmodel. */
346 1.1 christos if (in6p->in6p_flags & IN6P_LOWPORT) {
347 1.1 christos #ifndef IPNOPRIVPORTS
348 1.1 christos req = KAUTH_REQ_NETWORK_BIND_PRIVPORT;
349 1.1 christos #else
350 1.1 christos req = KAUTH_REQ_NETWORK_BIND_PORT;
351 1.1 christos #endif
352 1.1 christos } else {
353 1.1 christos req = KAUTH_REQ_NETWORK_BIND_PORT;
354 1.1 christos }
355 1.1 christos
356 1.1 christos sin6.sin6_port = port;
357 1.1 christos error = kauth_authorize_network(cred,
358 1.1 christos KAUTH_NETWORK_BIND, req, so, &sin6, NULL);
359 1.1 christos if (error) {
360 1.1 christos /* Secmodel says no. Keep looking. */
361 1.1 christos DPRINTF("%s secmodel says no\n", __func__);
362 1.1 christos return false;
363 1.1 christos }
364 1.1 christos DPRINTF("%s port approved\n", __func__);
365 1.1 christos return true;
366 1.1 christos }
367 1.1 christos break;
368 1.1 christos }
369 1.1 christos #endif
370 1.1 christos default:
371 1.1 christos DPRINTF("%s unknown address family\n", __func__);
372 1.1 christos return false;
373 1.1 christos }
374 1.1 christos return false;
375 1.1 christos }
376 1.1 christos
377 1.1 christos /* This is the default BSD algorithm, as described in RFC 6056 */
378 1.1 christos static int
379 1.1 christos algo_bsd(int algo, uint16_t *port, struct inpcb_hdr *inp_hdr, kauth_cred_t cred)
380 1.1 christos {
381 1.1 christos uint16_t count;
382 1.1 christos uint16_t mymin, mymax, lastport;
383 1.1 christos uint16_t *next_ephemeral;
384 1.1 christos int error;
385 1.1 christos
386 1.1 christos DPRINTF("%s called\n", __func__);
387 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin, &mymax,
388 1.1 christos &next_ephemeral, algo);
389 1.1 christos if (error)
390 1.1 christos return error;
391 1.1 christos count = mymax - mymin + 1;
392 1.1 christos do {
393 1.1 christos uint16_t myport = *next_ephemeral;
394 1.1 christos
395 1.1 christos if (myport < mymin || mymax < myport)
396 1.1 christos myport = mymax;
397 1.1 christos *next_ephemeral = myport - 1;
398 1.1 christos if (check_suitable_port(myport, inp_hdr, cred)) {
399 1.1 christos *port = myport;
400 1.1 christos DPRINTF("%s returning port %d\n", __func__, *port);
401 1.1 christos return 0;
402 1.1 christos }
403 1.1 christos count--;
404 1.1 christos } while (count > 0);
405 1.1 christos
406 1.1 christos DPRINTF("%s returning EAGAIN\n", __func__);
407 1.1 christos return EAGAIN;
408 1.1 christos }
409 1.1 christos
410 1.1 christos /*
411 1.1 christos * The straightforward algorithm that calls random() in order to
412 1.1 christos * compute the increment to the next port number.
413 1.1 christos */
414 1.1 christos static int
415 1.1 christos algo_random_start(int algo, uint16_t *port, struct inpcb_hdr *inp_hdr,
416 1.1 christos kauth_cred_t cred)
417 1.1 christos {
418 1.1 christos uint16_t count, num_ephemeral;
419 1.1 christos uint16_t mymin, mymax, lastport;
420 1.1 christos uint16_t *next_ephemeral;
421 1.1 christos int error;
422 1.1 christos
423 1.1 christos DPRINTF("%s called\n", __func__);
424 1.1 christos
425 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin, &mymax,
426 1.1 christos &next_ephemeral, algo);
427 1.1 christos if (error)
428 1.1 christos return error;
429 1.1 christos
430 1.1 christos num_ephemeral = mymax - mymin + 1;
431 1.1 christos
432 1.1 christos DPRINTF("num_ephemeral: %u\n", num_ephemeral);
433 1.1 christos
434 1.1 christos *next_ephemeral = mymin + (cprng_fast32() % num_ephemeral);
435 1.1 christos
436 1.1 christos DPRINTF("next_ephemeral initially: %u\n", *next_ephemeral);
437 1.1 christos
438 1.1 christos count = num_ephemeral;
439 1.1 christos
440 1.1 christos do {
441 1.1 christos if (check_suitable_port(*next_ephemeral, inp_hdr, cred)) {
442 1.1 christos *port = *next_ephemeral;
443 1.1 christos DPRINTF("%s returning port %d\n", __func__, *port);
444 1.1 christos return 0;
445 1.1 christos }
446 1.1 christos if (*next_ephemeral == mymax) {
447 1.1 christos *next_ephemeral = mymin;
448 1.1 christos } else
449 1.1 christos (*next_ephemeral)++;
450 1.1 christos
451 1.1 christos count--;
452 1.1 christos
453 1.1 christos
454 1.1 christos DPRINTF("next_ephemeral: %u count: %u\n", *next_ephemeral,
455 1.1 christos count);
456 1.1 christos
457 1.1 christos } while (count > 0);
458 1.1 christos
459 1.1 christos DPRINTF("%s returning EINVAL\n", __func__);
460 1.1 christos
461 1.1 christos return EINVAL;
462 1.1 christos }
463 1.1 christos
464 1.1 christos /*
465 1.1 christos * Since there is no state kept on the ports tried, we might actually
466 1.1 christos * give up before exhausting the free ports.
467 1.1 christos */
468 1.1 christos static int
469 1.1 christos algo_random_pick(int algo, uint16_t *port, struct inpcb_hdr *inp_hdr,
470 1.1 christos kauth_cred_t cred)
471 1.1 christos {
472 1.1 christos uint16_t count, num_ephemeral;
473 1.1 christos uint16_t mymin, mymax, lastport;
474 1.1 christos uint16_t *next_ephemeral;
475 1.1 christos int error;
476 1.1 christos
477 1.1 christos DPRINTF("%s called\n", __func__);
478 1.1 christos
479 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin, &mymax,
480 1.1 christos &next_ephemeral, algo);
481 1.1 christos if (error)
482 1.1 christos return error;
483 1.1 christos
484 1.1 christos num_ephemeral = mymax - mymin + 1;
485 1.1 christos
486 1.1 christos DPRINTF("num_ephemeral: %u\n", num_ephemeral);
487 1.1 christos *next_ephemeral = mymin + (cprng_fast32() % num_ephemeral);
488 1.1 christos
489 1.1 christos DPRINTF("next_ephemeral initially: %u\n", *next_ephemeral);
490 1.1 christos
491 1.1 christos count = num_ephemeral;
492 1.1 christos
493 1.1 christos do {
494 1.1 christos if (check_suitable_port(*next_ephemeral, inp_hdr, cred)) {
495 1.1 christos *port = *next_ephemeral;
496 1.1 christos DPRINTF("%s returning port %d\n", __func__, *port);
497 1.1 christos return 0;
498 1.1 christos }
499 1.1 christos *next_ephemeral = mymin +
500 1.1 christos (cprng_fast32() % num_ephemeral);
501 1.1 christos
502 1.1 christos count--;
503 1.1 christos
504 1.1 christos DPRINTF("next_ephemeral: %u count: %u\n",
505 1.1 christos *next_ephemeral, count);
506 1.1 christos } while (count > 0);
507 1.1 christos
508 1.1 christos DPRINTF("%s returning EINVAL\n", __func__);
509 1.1 christos
510 1.1 christos return EINVAL;
511 1.1 christos }
512 1.1 christos
513 1.1 christos /* This is the implementation from FreeBSD, with tweaks */
514 1.1 christos static uint16_t
515 1.1 christos Fhash(const struct inpcb_hdr *inp_hdr)
516 1.1 christos {
517 1.1 christos MD5_CTX f_ctx;
518 1.1 christos uint32_t Ff[4];
519 1.1 christos uint32_t secret_f[4];
520 1.1 christos uint32_t offset;
521 1.1 christos uint16_t soffset[2];
522 1.1 christos
523 1.1 christos cprng_fast(secret_f, sizeof(secret_f));
524 1.1 christos
525 1.1 christos MD5Init(&f_ctx);
526 1.1 christos switch (inp_hdr->inph_af) {
527 1.1 christos #ifdef INET
528 1.1 christos case AF_INET: {
529 1.1 christos const struct inpcb *inp =
530 1.1 christos (const struct inpcb *)(const void *)inp_hdr;
531 1.1 christos MD5Update(&f_ctx, (const u_char *)&inp->inp_laddr,
532 1.1 christos sizeof(inp->inp_laddr));
533 1.1 christos MD5Update(&f_ctx, (const u_char *)&inp->inp_faddr,
534 1.1 christos sizeof(inp->inp_faddr));
535 1.1 christos MD5Update(&f_ctx, (const u_char *)&inp->inp_fport,
536 1.1 christos sizeof(inp->inp_fport));
537 1.1 christos break;
538 1.1 christos }
539 1.1 christos #endif
540 1.1 christos #ifdef INET6
541 1.1 christos case AF_INET6: {
542 1.1 christos const struct in6pcb *in6p =
543 1.1 christos (const struct in6pcb *)(const void *)inp_hdr;
544 1.1 christos MD5Update(&f_ctx, (const u_char *)&in6p->in6p_laddr,
545 1.1 christos sizeof(in6p->in6p_laddr));
546 1.1 christos MD5Update(&f_ctx, (const u_char *)&in6p->in6p_faddr,
547 1.1 christos sizeof(in6p->in6p_faddr));
548 1.1 christos MD5Update(&f_ctx, (const u_char *)&in6p->in6p_fport,
549 1.1 christos sizeof(in6p->in6p_fport));
550 1.1 christos break;
551 1.1 christos }
552 1.1 christos #endif
553 1.1 christos default:
554 1.1 christos break;
555 1.1 christos }
556 1.1 christos MD5Update(&f_ctx, (const u_char *)secret_f, sizeof(secret_f));
557 1.1 christos MD5Final((u_char *)&Ff, &f_ctx);
558 1.1 christos
559 1.1 christos offset = (Ff[0] ^ Ff[1]) ^ (Ff[2] ^ Ff[3]);
560 1.1 christos
561 1.1 christos memcpy(&soffset, &offset, sizeof(soffset));
562 1.1 christos
563 1.1 christos return soffset[0] ^ soffset[1];
564 1.1 christos }
565 1.1 christos
566 1.1 christos /*
567 1.1 christos * Checks whether the tuple is complete. If not, marks the pcb for
568 1.1 christos * late binding.
569 1.1 christos */
570 1.1 christos static bool
571 1.1 christos iscompletetuple(struct inpcb_hdr *inp_hdr)
572 1.1 christos {
573 1.1 christos #ifdef INET6
574 1.1 christos struct in6pcb *in6p;
575 1.1 christos #endif
576 1.1 christos
577 1.1 christos switch (inp_hdr->inph_af) {
578 1.1 christos #ifdef INET
579 1.1 christos case AF_INET: {
580 1.1 christos struct inpcb *inp = (struct inpcb *)(void *)inp_hdr;
581 1.1 christos if (inp->inp_fport == 0 || in_nullhost(inp->inp_faddr)) {
582 1.1 christos DPRINTF("%s fport or faddr missing, delaying port "
583 1.1 christos "to connect/send\n", __func__);
584 1.1 christos inp->inp_bindportonsend = true;
585 1.1 christos return false;
586 1.1 christos } else {
587 1.1 christos inp->inp_bindportonsend = false;
588 1.1 christos }
589 1.1 christos break;
590 1.1 christos }
591 1.1 christos #endif
592 1.1 christos #ifdef INET6
593 1.1 christos case AF_INET6: {
594 1.1 christos in6p = (struct in6pcb *)(void *)inp_hdr;
595 1.1 christos if (in6p->in6p_fport == 0 || memcmp(&in6p->in6p_faddr,
596 1.1 christos &in6addr_any, sizeof(in6p->in6p_faddr)) == 0) {
597 1.1 christos DPRINTF("%s fport or faddr missing, delaying port "
598 1.1 christos "to connect/send\n", __func__);
599 1.1 christos in6p->in6p_bindportonsend = true;
600 1.1 christos return false;
601 1.1 christos } else {
602 1.1 christos in6p->in6p_bindportonsend = false;
603 1.1 christos }
604 1.1 christos break;
605 1.1 christos }
606 1.1 christos #endif
607 1.1 christos default:
608 1.1 christos DPRINTF("%s incorrect address family\n", __func__);
609 1.1 christos return false;
610 1.1 christos }
611 1.1 christos
612 1.1 christos return true;
613 1.1 christos }
614 1.1 christos
615 1.1 christos static int
616 1.1 christos algo_hash(int algo, uint16_t *port, struct inpcb_hdr *inp_hdr,
617 1.1 christos kauth_cred_t cred)
618 1.1 christos {
619 1.1 christos uint16_t count, num_ephemeral;
620 1.1 christos uint16_t mymin, mymax, lastport;
621 1.1 christos uint16_t *next_ephemeral;
622 1.1 christos uint16_t offset, myport;
623 1.1 christos int error;
624 1.1 christos
625 1.1 christos DPRINTF("%s called\n", __func__);
626 1.1 christos
627 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin, &mymax,
628 1.1 christos &next_ephemeral, algo);
629 1.1 christos if (error)
630 1.1 christos return error;
631 1.1 christos
632 1.1 christos if (!iscompletetuple(inp_hdr)) {
633 1.1 christos *port = 0;
634 1.1 christos return 0;
635 1.1 christos }
636 1.1 christos
637 1.1 christos /* Ephemeral port selection function */
638 1.1 christos num_ephemeral = mymax - mymin + 1;
639 1.1 christos
640 1.1 christos DPRINTF("num_ephemeral: %d\n", num_ephemeral);
641 1.1 christos
642 1.1 christos offset = Fhash(inp_hdr);
643 1.1 christos
644 1.1 christos count = num_ephemeral;
645 1.1 christos do {
646 1.1 christos myport = mymin + (*next_ephemeral + offset)
647 1.1 christos % num_ephemeral;
648 1.1 christos
649 1.1 christos (*next_ephemeral)++;
650 1.1 christos
651 1.1 christos if (check_suitable_port(myport, inp_hdr, cred)) {
652 1.1 christos *port = myport;
653 1.1 christos DPRINTF("%s returning port %d\n", __func__, *port);
654 1.1 christos return 0;
655 1.1 christos }
656 1.1 christos count--;
657 1.1 christos } while (count > 0);
658 1.1 christos
659 1.1 christos DPRINTF("%s returning EINVAL\n", __func__);
660 1.1 christos
661 1.1 christos return EINVAL;
662 1.1 christos }
663 1.1 christos
664 1.1 christos static int
665 1.1 christos algo_doublehash(int algo, uint16_t *port, struct inpcb_hdr *inp_hdr,
666 1.1 christos kauth_cred_t cred)
667 1.1 christos {
668 1.1 christos uint16_t count, num_ephemeral;
669 1.1 christos uint16_t mymin, mymax, lastport;
670 1.1 christos uint16_t *next_ephemeral;
671 1.1 christos uint16_t offset, myport;
672 1.1 christos static uint16_t dhtable[8];
673 1.1 christos size_t idx;
674 1.1 christos int error;
675 1.1 christos
676 1.1 christos DPRINTF("%s called\n", __func__);
677 1.1 christos
678 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin, &mymax,
679 1.1 christos &next_ephemeral, algo);
680 1.1 christos if (error)
681 1.1 christos return error;
682 1.1 christos
683 1.1 christos if (!iscompletetuple(inp_hdr)) {
684 1.1 christos *port = 0;
685 1.1 christos return 0;
686 1.1 christos }
687 1.1 christos /* first time initialization */
688 1.1 christos if (dhtable[0] == 0)
689 1.1 christos for (size_t i = 0; i < __arraycount(dhtable); i++)
690 1.1 christos dhtable[i] = random() & 0xffff;
691 1.1 christos
692 1.1 christos /* Ephemeral port selection function */
693 1.1 christos num_ephemeral = mymax - mymin + 1;
694 1.1 christos offset = Fhash(inp_hdr);
695 1.1 christos idx = Fhash(inp_hdr) % __arraycount(dhtable); /* G */
696 1.1 christos count = num_ephemeral;
697 1.1 christos
698 1.1 christos do {
699 1.1 christos myport = mymin + (offset + dhtable[idx])
700 1.1 christos % num_ephemeral;
701 1.1 christos dhtable[idx]++;
702 1.1 christos
703 1.1 christos if (check_suitable_port(myport, inp_hdr, cred)) {
704 1.1 christos *port = myport;
705 1.1 christos DPRINTF("%s returning port %d\n", __func__, *port);
706 1.1 christos return 0;
707 1.1 christos }
708 1.1 christos count--;
709 1.1 christos
710 1.1 christos } while (count > 0);
711 1.1 christos
712 1.1 christos DPRINTF("%s returning EINVAL\n", __func__);
713 1.1 christos
714 1.1 christos return EINVAL;
715 1.1 christos }
716 1.1 christos
717 1.1 christos static int
718 1.1 christos algo_randinc(int algo, uint16_t *port, struct inpcb_hdr *inp_hdr,
719 1.1 christos kauth_cred_t cred)
720 1.1 christos {
721 1.1 christos static const uint16_t N = 500; /* Determines the trade-off */
722 1.1 christos uint16_t count, num_ephemeral;
723 1.1 christos uint16_t mymin, mymax, lastport;
724 1.1 christos uint16_t *next_ephemeral;
725 1.1 christos uint16_t myport;
726 1.1 christos int error;
727 1.1 christos
728 1.1 christos DPRINTF("%s called\n", __func__);
729 1.1 christos
730 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin, &mymax,
731 1.1 christos &next_ephemeral, algo);
732 1.1 christos if (error)
733 1.1 christos return error;
734 1.1 christos
735 1.1 christos if (*next_ephemeral == 0)
736 1.1 christos *next_ephemeral = cprng_fast32() & 0xffff;
737 1.1 christos
738 1.1 christos /* Ephemeral port selection function */
739 1.1 christos num_ephemeral = mymax - mymin + 1;
740 1.1 christos
741 1.1 christos count = num_ephemeral;
742 1.1 christos do {
743 1.1 christos *next_ephemeral = *next_ephemeral +
744 1.1 christos (cprng_fast32() % N) + 1;
745 1.1 christos myport = mymin +
746 1.1 christos (*next_ephemeral % num_ephemeral);
747 1.1 christos
748 1.1 christos if (check_suitable_port(myport, inp_hdr, cred)) {
749 1.1 christos *port = myport;
750 1.1 christos DPRINTF("%s returning port %d\n", __func__, *port);
751 1.1 christos return 0;
752 1.1 christos }
753 1.1 christos count--;
754 1.1 christos } while (count > 0);
755 1.1 christos
756 1.1 christos return EINVAL;
757 1.1 christos }
758 1.1 christos
759 1.1 christos /* The generic function called in order to pick a port. */
760 1.1 christos int
761 1.1 christos portalgo_randport(uint16_t *port, struct inpcb_hdr *inp_hdr, kauth_cred_t cred)
762 1.1 christos {
763 1.1 christos int algo, error;
764 1.1 christos uint16_t lport;
765 1.1 christos int default_algo;
766 1.1 christos
767 1.1 christos DPRINTF("%s called\n", __func__);
768 1.1 christos
769 1.1 christos if (inp_hdr->inph_portalgo == PORTALGO_DEFAULT) {
770 1.1 christos switch (inp_hdr->inph_af) {
771 1.1 christos #ifdef INET
772 1.1 christos case AF_INET:
773 1.1 christos default_algo = inet4_portalgo;
774 1.1 christos break;
775 1.1 christos #endif
776 1.1 christos #ifdef INET6
777 1.1 christos case AF_INET6:
778 1.1 christos default_algo = inet6_portalgo;
779 1.1 christos break;
780 1.1 christos #endif
781 1.1 christos default:
782 1.1 christos return EINVAL;
783 1.1 christos }
784 1.1 christos
785 1.1 christos if (default_algo == PORTALGO_DEFAULT)
786 1.1 christos algo = PORTALGO_BSD;
787 1.1 christos else
788 1.1 christos algo = default_algo;
789 1.1 christos }
790 1.1 christos else /* socket specifies the algorithm */
791 1.1 christos algo = inp_hdr->inph_portalgo;
792 1.1 christos
793 1.1 christos KASSERT(algo >= 0);
794 1.1 christos KASSERT(algo < NALGOS);
795 1.1 christos
796 1.1 christos switch (inp_hdr->inph_af) {
797 1.1 christos #ifdef INET
798 1.1 christos case AF_INET: {
799 1.1 christos struct inpcb *inp = (struct inpcb *)(void *)inp_hdr;
800 1.1 christos DPRINTF("local addr: %s\n", inet_ntoa(inp->inp_laddr));
801 1.1 christos DPRINTF("local port: %d\n", inp->inp_lport);
802 1.1 christos DPRINTF("foreign addr: %s\n", inet_ntoa(inp->inp_faddr));
803 1.1 christos DPRINTF("foreign port: %d\n", inp->inp_fport);
804 1.1 christos break;
805 1.1 christos }
806 1.1 christos #endif
807 1.1 christos #ifdef INET6
808 1.1 christos case AF_INET6: {
809 1.1 christos struct in6pcb *in6p = (struct in6pcb *)(void *)inp_hdr;
810 1.1 christos
811 1.1 christos DPRINTF("local addr: %s\n", ip6_sprintf(&in6p->in6p_laddr));
812 1.1 christos DPRINTF("local port: %d\n", in6p->in6p_lport);
813 1.1 christos DPRINTF("foreign addr: %s\n", ip6_sprintf(&in6p->in6p_faddr));
814 1.1 christos DPRINTF("foreign port: %d\n", in6p->in6p_fport);
815 1.1 christos break;
816 1.1 christos }
817 1.1 christos #endif
818 1.1 christos default:
819 1.1 christos break;
820 1.1 christos }
821 1.1 christos
822 1.1 christos DPRINTF("%s portalgo = %d\n", __func__, algo);
823 1.1 christos
824 1.1 christos error = (*algos[algo].func)(algo, &lport, inp_hdr, cred);
825 1.1 christos if (error == 0) {
826 1.1 christos *port = lport;
827 1.1 christos } else if (error != EAGAIN) {
828 1.1 christos uint16_t lastport, mymin, mymax, *pnext_ephemeral;
829 1.1 christos
830 1.1 christos error = pcb_getports(inp_hdr, &lastport, &mymin,
831 1.1 christos &mymax, &pnext_ephemeral, algo);
832 1.1 christos if (error)
833 1.1 christos return error;
834 1.1 christos *port = lastport - 1;
835 1.1 christos }
836 1.1 christos return error;
837 1.1 christos }
838 1.1 christos
839 1.1 christos /* Sets the algorithm to be used globally */
840 1.1 christos static int
841 1.1 christos portalgo_algo_name_select(const char *name, int *algo)
842 1.1 christos {
843 1.1 christos size_t ai;
844 1.1 christos
845 1.1 christos DPRINTF("%s called\n", __func__);
846 1.1 christos
847 1.1 christos for (ai = 0; ai < NALGOS; ai++)
848 1.1 christos if (strcmp(algos[ai].name, name) == 0) {
849 1.1 christos DPRINTF("%s: found idx %zu\n", __func__, ai);
850 1.1 christos *algo = ai;
851 1.1 christos return 0;
852 1.1 christos }
853 1.1 christos return EINVAL;
854 1.1 christos }
855 1.1 christos
856 1.1 christos /* Sets the algorithm to be used by the pcb inp. */
857 1.1 christos int
858 1.1 christos portalgo_algo_index_select(struct inpcb_hdr *inp, int algo)
859 1.1 christos {
860 1.1 christos
861 1.1 christos DPRINTF("%s called with algo %d for pcb %p\n", __func__, algo, inp );
862 1.1 christos
863 1.1 christos if ((algo < 0 || algo >= NALGOS) &&
864 1.1 christos (algo != PORTALGO_DEFAULT))
865 1.1 christos return EINVAL;
866 1.1 christos
867 1.1 christos inp->inph_portalgo = algo;
868 1.1 christos return 0;
869 1.1 christos }
870 1.1 christos
871 1.1 christos /*
872 1.1 christos * The sysctl hook that is supposed to check that we are picking one
873 1.2 christos * of the valid algorithms.
874 1.1 christos */
875 1.1 christos static int
876 1.2 christos sysctl_portalgo_selected(SYSCTLFN_ARGS, int *algo)
877 1.1 christos {
878 1.1 christos struct sysctlnode node;
879 1.1 christos int error;
880 1.1 christos char newalgo[PORTALGO_MAXLEN];
881 1.1 christos
882 1.1 christos DPRINTF("%s called\n", __func__);
883 1.1 christos
884 1.1 christos strlcpy(newalgo, algos[*algo].name, sizeof(newalgo));
885 1.1 christos
886 1.1 christos node = *rnode;
887 1.1 christos node.sysctl_data = newalgo;
888 1.1 christos node.sysctl_size = sizeof(newalgo);
889 1.1 christos
890 1.1 christos error = sysctl_lookup(SYSCTLFN_CALL(&node));
891 1.1 christos
892 1.1 christos DPRINTF("newalgo: %s\n", newalgo);
893 1.1 christos
894 1.1 christos if (error || newp == NULL ||
895 1.1 christos strncmp(newalgo, algos[*algo].name, sizeof(newalgo)) == 0)
896 1.1 christos return error;
897 1.1 christos
898 1.1 christos #ifdef KAUTH_NETWORK_SOCKET_PORT_RANDOMIZE
899 1.1 christos if (l != NULL && (error = kauth_authorize_system(l->l_cred,
900 1.1 christos KAUTH_NETWORK_SOCKET, KAUTH_NETWORK_SOCKET_PORT_RANDOMIZE, newname,
901 1.1 christos NULL, NULL)) != 0)
902 1.1 christos return error;
903 1.1 christos #endif
904 1.1 christos
905 1.1 christos mutex_enter(softnet_lock);
906 1.1 christos error = portalgo_algo_name_select(newalgo, algo);
907 1.1 christos mutex_exit(softnet_lock);
908 1.1 christos return error;
909 1.1 christos }
910 1.1 christos
911 1.2 christos static int
912 1.4 christos sysctl_portalgo_reserve(SYSCTLFN_ARGS, bitmap *bt)
913 1.2 christos {
914 1.2 christos struct sysctlnode node;
915 1.2 christos int error;
916 1.2 christos
917 1.2 christos DPRINTF("%s called\n", __func__);
918 1.2 christos
919 1.2 christos node = *rnode;
920 1.2 christos node.sysctl_data = bt;
921 1.2 christos node.sysctl_size = sizeof(*bt);
922 1.2 christos
923 1.2 christos error = sysctl_lookup(SYSCTLFN_CALL(&node));
924 1.2 christos
925 1.2 christos if (error || newp == NULL)
926 1.2 christos return error;
927 1.2 christos
928 1.2 christos #ifdef KAUTH_NETWORK_SOCKET_PORT_RESERVE
929 1.2 christos if (l != NULL && (error = kauth_authorize_system(l->l_cred,
930 1.2 christos KAUTH_NETWORK_SOCKET, KAUTH_NETWORK_SOCKET_PORT_RESERVE, bt,
931 1.2 christos NULL, NULL)) != 0)
932 1.2 christos return error;
933 1.2 christos #endif
934 1.2 christos return error;
935 1.2 christos }
936 1.2 christos
937 1.2 christos #ifdef INET
938 1.1 christos /*
939 1.1 christos * The sysctl hook that is supposed to check that we are picking one
940 1.1 christos * of the valid algorithms.
941 1.1 christos */
942 1.1 christos int
943 1.2 christos sysctl_portalgo_selected4(SYSCTLFN_ARGS)
944 1.2 christos {
945 1.2 christos
946 1.2 christos return sysctl_portalgo_selected(SYSCTLFN_CALL(rnode), &inet4_portalgo);
947 1.2 christos }
948 1.2 christos
949 1.2 christos int
950 1.2 christos sysctl_portalgo_reserve4(SYSCTLFN_ARGS)
951 1.1 christos {
952 1.1 christos
953 1.4 christos return sysctl_portalgo_reserve(SYSCTLFN_CALL(rnode), &inet4_reserve);
954 1.1 christos }
955 1.2 christos #endif
956 1.1 christos
957 1.1 christos #ifdef INET6
958 1.1 christos int
959 1.1 christos sysctl_portalgo_selected6(SYSCTLFN_ARGS)
960 1.1 christos {
961 1.1 christos
962 1.2 christos return sysctl_portalgo_selected(SYSCTLFN_CALL(rnode), &inet6_portalgo);
963 1.2 christos }
964 1.2 christos
965 1.2 christos int
966 1.2 christos sysctl_portalgo_reserve6(SYSCTLFN_ARGS)
967 1.2 christos {
968 1.4 christos return sysctl_portalgo_reserve(SYSCTLFN_CALL(rnode), &inet6_reserve);
969 1.1 christos }
970 1.1 christos #endif
971 1.1 christos
972 1.1 christos /*
973 1.1 christos * The sysctl hook that returns the available
974 1.1 christos * algorithms.
975 1.1 christos */
976 1.1 christos int
977 1.1 christos sysctl_portalgo_available(SYSCTLFN_ARGS)
978 1.1 christos {
979 1.1 christos size_t ai, len = 0;
980 1.1 christos struct sysctlnode node;
981 1.1 christos char availalgo[NALGOS * PORTALGO_MAXLEN];
982 1.1 christos
983 1.1 christos DPRINTF("%s called\n", __func__);
984 1.1 christos
985 1.1 christos availalgo[0] = '\0';
986 1.1 christos
987 1.1 christos for (ai = 0; ai < NALGOS; ai++) {
988 1.1 christos len = strlcat(availalgo, algos[ai].name, sizeof(availalgo));
989 1.1 christos if (ai < NALGOS - 1)
990 1.1 christos strlcat(availalgo, " ", sizeof(availalgo));
991 1.1 christos }
992 1.1 christos
993 1.1 christos DPRINTF("available algos: %s\n", availalgo);
994 1.1 christos
995 1.1 christos node = *rnode;
996 1.1 christos node.sysctl_data = availalgo;
997 1.1 christos node.sysctl_size = len;
998 1.1 christos
999 1.1 christos return sysctl_lookup(SYSCTLFN_CALL(&node));
1000 1.1 christos }
1001