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