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