1/*-
2 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the project nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	$KAME: in6_src.c,v 1.132 2003/08/26 04:42:27 keiichi Exp $
30 */
31
32/*-
33 * Copyright (c) 1982, 1986, 1991, 1993
34 *	The Regents of the University of California.  All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 *    notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 *    notice, this list of conditions and the following disclaimer in the
43 *    documentation and/or other materials provided with the distribution.
44 * 4. Neither the name of the University nor the names of its contributors
45 *    may be used to endorse or promote products derived from this software
46 *    without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 *	@(#)in_pcb.c	8.2 (Berkeley) 1/4/94
61 */
62
63#include <sys/cdefs.h>
64__FBSDID("$FreeBSD$");
65
66#include "opt_inet.h"
67#include "opt_inet6.h"
68#include "opt_mpath.h"
69
70#include <sys/param.h>
71#include <sys/systm.h>
72#include <sys/lock.h>
73#include <sys/malloc.h>
74#include <sys/mbuf.h>
75#include <sys/priv.h>
76#include <sys/protosw.h>
77#include <sys/socket.h>
78#include <sys/socketvar.h>
79#include <sys/sockio.h>
80#include <sys/sysctl.h>
81#include <sys/errno.h>
82#include <sys/time.h>
83#include <sys/jail.h>
84#include <sys/kernel.h>
85#include <sys/sx.h>
86
87#include <net/if.h>
88#include <net/if_dl.h>
89#include <net/route.h>
90#include <net/if_llatbl.h>
91#ifdef RADIX_MPATH
92#include <net/radix_mpath.h>
93#endif
94
95#include <netinet/in.h>
96#include <netinet/in_var.h>
97#include <netinet/in_systm.h>
98#include <netinet/ip.h>
99#include <netinet/in_pcb.h>
100#include <netinet/ip_var.h>
101#include <netinet/udp.h>
102#include <netinet/udp_var.h>
103
104#include <netinet6/in6_var.h>
105#include <netinet/ip6.h>
106#include <netinet6/in6_pcb.h>
107#include <netinet6/ip6_var.h>
108#include <netinet6/scope6_var.h>
109#include <netinet6/nd6.h>
110
111static struct mtx addrsel_lock;
112#define	ADDRSEL_LOCK_INIT()	mtx_init(&addrsel_lock, "addrsel_lock", NULL, MTX_DEF)
113#define	ADDRSEL_LOCK()		mtx_lock(&addrsel_lock)
114#define	ADDRSEL_UNLOCK()	mtx_unlock(&addrsel_lock)
115#define	ADDRSEL_LOCK_ASSERT()	mtx_assert(&addrsel_lock, MA_OWNED)
116
117static struct sx addrsel_sxlock;
118#define	ADDRSEL_SXLOCK_INIT()	sx_init(&addrsel_sxlock, "addrsel_sxlock")
119#define	ADDRSEL_SLOCK()		sx_slock(&addrsel_sxlock)
120#define	ADDRSEL_SUNLOCK()	sx_sunlock(&addrsel_sxlock)
121#define	ADDRSEL_XLOCK()		sx_xlock(&addrsel_sxlock)
122#define	ADDRSEL_XUNLOCK()	sx_xunlock(&addrsel_sxlock)
123
124#define ADDR_LABEL_NOTAPP (-1)
125static VNET_DEFINE(struct in6_addrpolicy, defaultaddrpolicy);
126#define	V_defaultaddrpolicy		VNET(defaultaddrpolicy)
127
128VNET_DEFINE(int, ip6_prefer_tempaddr) = 0;
129
130static int selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
131	struct ip6_moptions *, struct route_in6 *, struct ifnet **,
132	struct rtentry **, int, u_int);
133static int in6_selectif(struct sockaddr_in6 *, struct ip6_pktopts *,
134	struct ip6_moptions *, struct route_in6 *ro, struct ifnet **,
135	struct ifnet *, u_int);
136
137static struct in6_addrpolicy *lookup_addrsel_policy(struct sockaddr_in6 *);
138
139static void init_policy_queue(void);
140static int add_addrsel_policyent(struct in6_addrpolicy *);
141static int delete_addrsel_policyent(struct in6_addrpolicy *);
142static int walk_addrsel_policy(int (*)(struct in6_addrpolicy *, void *),
143				    void *);
144static int dump_addrsel_policyent(struct in6_addrpolicy *, void *);
145static struct in6_addrpolicy *match_addrsel_policy(struct sockaddr_in6 *);
146
147/*
148 * Return an IPv6 address, which is the most appropriate for a given
149 * destination and user specified options.
150 * If necessary, this function lookups the routing table and returns
151 * an entry to the caller for later use.
152 */
153#define REPLACE(r) do {\
154	IP6STAT_INC(ip6s_sources_rule[(r)]); \
155	rule = (r);	\
156	/* { \
157	char ip6buf[INET6_ADDRSTRLEN], ip6b[INET6_ADDRSTRLEN]; \
158	printf("in6_selectsrc: replace %s with %s by %d\n", ia_best ? ip6_sprintf(ip6buf, &ia_best->ia_addr.sin6_addr) : "none", ip6_sprintf(ip6b, &ia->ia_addr.sin6_addr), (r)); \
159	} */ \
160	goto replace; \
161} while(0)
162#define NEXT(r) do {\
163	/* { \
164	char ip6buf[INET6_ADDRSTRLEN], ip6b[INET6_ADDRSTRLEN]; \
165	printf("in6_selectsrc: keep %s against %s by %d\n", ia_best ? ip6_sprintf(ip6buf, &ia_best->ia_addr.sin6_addr) : "none", ip6_sprintf(ip6b, &ia->ia_addr.sin6_addr), (r)); \
166	} */ \
167	goto next;		/* XXX: we can't use 'continue' here */ \
168} while(0)
169#define BREAK(r) do { \
170	IP6STAT_INC(ip6s_sources_rule[(r)]); \
171	rule = (r);	\
172	goto out;		/* XXX: we can't use 'break' here */ \
173} while(0)
174
175int
176in6_selectsrc(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
177    struct inpcb *inp, struct route_in6 *ro, struct ucred *cred,
178    struct ifnet **ifpp, struct in6_addr *srcp)
179{
180	struct in6_addr dst, tmp;
181	struct ifnet *ifp = NULL, *oifp = NULL;
182	struct in6_ifaddr *ia = NULL, *ia_best = NULL;
183	struct in6_pktinfo *pi = NULL;
184	int dst_scope = -1, best_scope = -1, best_matchlen = -1;
185	struct in6_addrpolicy *dst_policy = NULL, *best_policy = NULL;
186	u_int32_t odstzone;
187	int prefer_tempaddr;
188	int error, rule;
189	struct ip6_moptions *mopts;
190
191	KASSERT(srcp != NULL, ("%s: srcp is NULL", __func__));
192
193	dst = dstsock->sin6_addr; /* make a copy for local operation */
194	if (ifpp) {
195		/*
196		 * Save a possibly passed in ifp for in6_selectsrc. Only
197		 * neighbor discovery code should use this feature, where
198		 * we may know the interface but not the FIB number holding
199		 * the connected subnet in case someone deleted it from the
200		 * default FIB and we need to check the interface.
201		 */
202		if (*ifpp != NULL)
203			oifp = *ifpp;
204		*ifpp = NULL;
205	}
206
207	if (inp != NULL) {
208		INP_LOCK_ASSERT(inp);
209		mopts = inp->in6p_moptions;
210	} else {
211		mopts = NULL;
212	}
213
214	/*
215	 * If the source address is explicitly specified by the caller,
216	 * check if the requested source address is indeed a unicast address
217	 * assigned to the node, and can be used as the packet's source
218	 * address.  If everything is okay, use the address as source.
219	 */
220	if (opts && (pi = opts->ip6po_pktinfo) &&
221	    !IN6_IS_ADDR_UNSPECIFIED(&pi->ipi6_addr)) {
222		struct sockaddr_in6 srcsock;
223		struct in6_ifaddr *ia6;
224
225		/* get the outgoing interface */
226		if ((error = in6_selectif(dstsock, opts, mopts, ro, &ifp, oifp,
227		    (inp != NULL) ? inp->inp_inc.inc_fibnum : RT_DEFAULT_FIB))
228		    != 0)
229			return (error);
230
231		/*
232		 * determine the appropriate zone id of the source based on
233		 * the zone of the destination and the outgoing interface.
234		 * If the specified address is ambiguous wrt the scope zone,
235		 * the interface must be specified; otherwise, ifa_ifwithaddr()
236		 * will fail matching the address.
237		 */
238		bzero(&srcsock, sizeof(srcsock));
239		srcsock.sin6_family = AF_INET6;
240		srcsock.sin6_len = sizeof(srcsock);
241		srcsock.sin6_addr = pi->ipi6_addr;
242		if (ifp) {
243			error = in6_setscope(&srcsock.sin6_addr, ifp, NULL);
244			if (error)
245				return (error);
246		}
247		if (cred != NULL && (error = prison_local_ip6(cred,
248		    &srcsock.sin6_addr, (inp != NULL &&
249		    (inp->inp_flags & IN6P_IPV6_V6ONLY) != 0))) != 0)
250			return (error);
251
252		ia6 = (struct in6_ifaddr *)ifa_ifwithaddr(
253		    (struct sockaddr *)&srcsock);
254		if (ia6 == NULL ||
255		    (ia6->ia6_flags & (IN6_IFF_ANYCAST | IN6_IFF_NOTREADY))) {
256			if (ia6 != NULL)
257				ifa_free(&ia6->ia_ifa);
258			return (EADDRNOTAVAIL);
259		}
260		pi->ipi6_addr = srcsock.sin6_addr; /* XXX: this overrides pi */
261		if (ifpp)
262			*ifpp = ifp;
263		bcopy(&ia6->ia_addr.sin6_addr, srcp, sizeof(*srcp));
264		ifa_free(&ia6->ia_ifa);
265		return (0);
266	}
267
268	/*
269	 * Otherwise, if the socket has already bound the source, just use it.
270	 */
271	if (inp != NULL && !IN6_IS_ADDR_UNSPECIFIED(&inp->in6p_laddr)) {
272		if (cred != NULL &&
273		    (error = prison_local_ip6(cred, &inp->in6p_laddr,
274		    ((inp->inp_flags & IN6P_IPV6_V6ONLY) != 0))) != 0)
275			return (error);
276		bcopy(&inp->in6p_laddr, srcp, sizeof(*srcp));
277		return (0);
278	}
279
280	/*
281	 * Bypass source address selection and use the primary jail IP
282	 * if requested.
283	 */
284	if (cred != NULL && !prison_saddrsel_ip6(cred, srcp))
285		return (0);
286
287	/*
288	 * If the address is not specified, choose the best one based on
289	 * the outgoing interface and the destination address.
290	 */
291	/* get the outgoing interface */
292	if ((error = in6_selectif(dstsock, opts, mopts, ro, &ifp, oifp,
293	    (inp != NULL) ? inp->inp_inc.inc_fibnum : RT_DEFAULT_FIB)) != 0)
294		return (error);
295
296#ifdef DIAGNOSTIC
297	if (ifp == NULL)	/* this should not happen */
298		panic("in6_selectsrc: NULL ifp");
299#endif
300	error = in6_setscope(&dst, ifp, &odstzone);
301	if (error)
302		return (error);
303
304	rule = 0;
305	IN6_IFADDR_RLOCK();
306	TAILQ_FOREACH(ia, &V_in6_ifaddrhead, ia_link) {
307		int new_scope = -1, new_matchlen = -1;
308		struct in6_addrpolicy *new_policy = NULL;
309		u_int32_t srczone, osrczone, dstzone;
310		struct in6_addr src;
311		struct ifnet *ifp1 = ia->ia_ifp;
312
313		/*
314		 * We'll never take an address that breaks the scope zone
315		 * of the destination.  We also skip an address if its zone
316		 * does not contain the outgoing interface.
317		 * XXX: we should probably use sin6_scope_id here.
318		 */
319		if (in6_setscope(&dst, ifp1, &dstzone) ||
320		    odstzone != dstzone) {
321			continue;
322		}
323		src = ia->ia_addr.sin6_addr;
324		if (in6_setscope(&src, ifp, &osrczone) ||
325		    in6_setscope(&src, ifp1, &srczone) ||
326		    osrczone != srczone) {
327			continue;
328		}
329
330		/* avoid unusable addresses */
331		if ((ia->ia6_flags &
332		     (IN6_IFF_NOTREADY | IN6_IFF_ANYCAST | IN6_IFF_DETACHED))) {
333				continue;
334		}
335		if (!V_ip6_use_deprecated && IFA6_IS_DEPRECATED(ia))
336			continue;
337
338		/* If jailed only take addresses of the jail into account. */
339		if (cred != NULL &&
340		    prison_check_ip6(cred, &ia->ia_addr.sin6_addr) != 0)
341			continue;
342
343		/* Rule 1: Prefer same address */
344		if (IN6_ARE_ADDR_EQUAL(&dst, &ia->ia_addr.sin6_addr)) {
345			ia_best = ia;
346			BREAK(1); /* there should be no better candidate */
347		}
348
349		if (ia_best == NULL)
350			REPLACE(0);
351
352		/* Rule 2: Prefer appropriate scope */
353		if (dst_scope < 0)
354			dst_scope = in6_addrscope(&dst);
355		new_scope = in6_addrscope(&ia->ia_addr.sin6_addr);
356		if (IN6_ARE_SCOPE_CMP(best_scope, new_scope) < 0) {
357			if (IN6_ARE_SCOPE_CMP(best_scope, dst_scope) < 0)
358				REPLACE(2);
359			NEXT(2);
360		} else if (IN6_ARE_SCOPE_CMP(new_scope, best_scope) < 0) {
361			if (IN6_ARE_SCOPE_CMP(new_scope, dst_scope) < 0)
362				NEXT(2);
363			REPLACE(2);
364		}
365
366		/*
367		 * Rule 3: Avoid deprecated addresses.  Note that the case of
368		 * !ip6_use_deprecated is already rejected above.
369		 */
370		if (!IFA6_IS_DEPRECATED(ia_best) && IFA6_IS_DEPRECATED(ia))
371			NEXT(3);
372		if (IFA6_IS_DEPRECATED(ia_best) && !IFA6_IS_DEPRECATED(ia))
373			REPLACE(3);
374
375		/* Rule 4: Prefer home addresses */
376		/*
377		 * XXX: This is a TODO.  We should probably merge the MIP6
378		 * case above.
379		 */
380
381		/* Rule 5: Prefer outgoing interface */
382		if (!(ND_IFINFO(ifp)->flags & ND6_IFF_NO_PREFER_IFACE)) {
383			if (ia_best->ia_ifp == ifp && ia->ia_ifp != ifp)
384				NEXT(5);
385			if (ia_best->ia_ifp != ifp && ia->ia_ifp == ifp)
386				REPLACE(5);
387		}
388
389		/*
390		 * Rule 6: Prefer matching label
391		 * Note that best_policy should be non-NULL here.
392		 */
393		if (dst_policy == NULL)
394			dst_policy = lookup_addrsel_policy(dstsock);
395		if (dst_policy->label != ADDR_LABEL_NOTAPP) {
396			new_policy = lookup_addrsel_policy(&ia->ia_addr);
397			if (dst_policy->label == best_policy->label &&
398			    dst_policy->label != new_policy->label)
399				NEXT(6);
400			if (dst_policy->label != best_policy->label &&
401			    dst_policy->label == new_policy->label)
402				REPLACE(6);
403		}
404
405		/*
406		 * Rule 7: Prefer public addresses.
407		 * We allow users to reverse the logic by configuring
408		 * a sysctl variable, so that privacy conscious users can
409		 * always prefer temporary addresses.
410		 */
411		if (opts == NULL ||
412		    opts->ip6po_prefer_tempaddr == IP6PO_TEMPADDR_SYSTEM) {
413			prefer_tempaddr = V_ip6_prefer_tempaddr;
414		} else if (opts->ip6po_prefer_tempaddr ==
415		    IP6PO_TEMPADDR_NOTPREFER) {
416			prefer_tempaddr = 0;
417		} else
418			prefer_tempaddr = 1;
419		if (!(ia_best->ia6_flags & IN6_IFF_TEMPORARY) &&
420		    (ia->ia6_flags & IN6_IFF_TEMPORARY)) {
421			if (prefer_tempaddr)
422				REPLACE(7);
423			else
424				NEXT(7);
425		}
426		if ((ia_best->ia6_flags & IN6_IFF_TEMPORARY) &&
427		    !(ia->ia6_flags & IN6_IFF_TEMPORARY)) {
428			if (prefer_tempaddr)
429				NEXT(7);
430			else
431				REPLACE(7);
432		}
433
434		/*
435		 * Rule 8: prefer addresses on alive interfaces.
436		 * This is a KAME specific rule.
437		 */
438		if ((ia_best->ia_ifp->if_flags & IFF_UP) &&
439		    !(ia->ia_ifp->if_flags & IFF_UP))
440			NEXT(8);
441		if (!(ia_best->ia_ifp->if_flags & IFF_UP) &&
442		    (ia->ia_ifp->if_flags & IFF_UP))
443			REPLACE(8);
444
445		/*
446		 * Rule 14: Use longest matching prefix.
447		 * Note: in the address selection draft, this rule is
448		 * documented as "Rule 8".  However, since it is also
449		 * documented that this rule can be overridden, we assign
450		 * a large number so that it is easy to assign smaller numbers
451		 * to more preferred rules.
452		 */
453		new_matchlen = in6_matchlen(&ia->ia_addr.sin6_addr, &dst);
454		if (best_matchlen < new_matchlen)
455			REPLACE(14);
456		if (new_matchlen < best_matchlen)
457			NEXT(14);
458
459		/* Rule 15 is reserved. */
460
461		/*
462		 * Last resort: just keep the current candidate.
463		 * Or, do we need more rules?
464		 */
465		continue;
466
467	  replace:
468		ia_best = ia;
469		best_scope = (new_scope >= 0 ? new_scope :
470			      in6_addrscope(&ia_best->ia_addr.sin6_addr));
471		best_policy = (new_policy ? new_policy :
472			       lookup_addrsel_policy(&ia_best->ia_addr));
473		best_matchlen = (new_matchlen >= 0 ? new_matchlen :
474				 in6_matchlen(&ia_best->ia_addr.sin6_addr,
475					      &dst));
476
477	  next:
478		continue;
479
480	  out:
481		break;
482	}
483
484	if ((ia = ia_best) == NULL) {
485		IN6_IFADDR_RUNLOCK();
486		IP6STAT_INC(ip6s_sources_none);
487		return (EADDRNOTAVAIL);
488	}
489
490	/*
491	 * At this point at least one of the addresses belonged to the jail
492	 * but it could still be, that we want to further restrict it, e.g.
493	 * theoratically IN6_IS_ADDR_LOOPBACK.
494	 * It must not be IN6_IS_ADDR_UNSPECIFIED anymore.
495	 * prison_local_ip6() will fix an IN6_IS_ADDR_LOOPBACK but should
496	 * let all others previously selected pass.
497	 * Use tmp to not change ::1 on lo0 to the primary jail address.
498	 */
499	tmp = ia->ia_addr.sin6_addr;
500	if (cred != NULL && prison_local_ip6(cred, &tmp, (inp != NULL &&
501	    (inp->inp_flags & IN6P_IPV6_V6ONLY) != 0)) != 0) {
502		IN6_IFADDR_RUNLOCK();
503		IP6STAT_INC(ip6s_sources_none);
504		return (EADDRNOTAVAIL);
505	}
506
507	if (ifpp)
508		*ifpp = ifp;
509
510	bcopy(&tmp, srcp, sizeof(*srcp));
511	if (ia->ia_ifp == ifp)
512		IP6STAT_INC(ip6s_sources_sameif[best_scope]);
513	else
514		IP6STAT_INC(ip6s_sources_otherif[best_scope]);
515	if (dst_scope == best_scope)
516		IP6STAT_INC(ip6s_sources_samescope[best_scope]);
517	else
518		IP6STAT_INC(ip6s_sources_otherscope[best_scope]);
519	if (IFA6_IS_DEPRECATED(ia))
520		IP6STAT_INC(ip6s_sources_deprecated[best_scope]);
521	IN6_IFADDR_RUNLOCK();
522	return (0);
523}
524
525/*
526 * clone - meaningful only for bsdi and freebsd
527 */
528static int
529selectroute(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
530    struct ip6_moptions *mopts, struct route_in6 *ro,
531    struct ifnet **retifp, struct rtentry **retrt, int norouteok, u_int fibnum)
532{
533	int error = 0;
534	struct ifnet *ifp = NULL;
535	struct rtentry *rt = NULL;
536	struct sockaddr_in6 *sin6_next;
537	struct in6_pktinfo *pi = NULL;
538	struct in6_addr *dst = &dstsock->sin6_addr;
539#if 0
540	char ip6buf[INET6_ADDRSTRLEN];
541
542	if (dstsock->sin6_addr.s6_addr32[0] == 0 &&
543	    dstsock->sin6_addr.s6_addr32[1] == 0 &&
544	    !IN6_IS_ADDR_LOOPBACK(&dstsock->sin6_addr)) {
545		printf("in6_selectroute: strange destination %s\n",
546		       ip6_sprintf(ip6buf, &dstsock->sin6_addr));
547	} else {
548		printf("in6_selectroute: destination = %s%%%d\n",
549		       ip6_sprintf(ip6buf, &dstsock->sin6_addr),
550		       dstsock->sin6_scope_id); /* for debug */
551	}
552#endif
553
554	/* If the caller specify the outgoing interface explicitly, use it. */
555	if (opts && (pi = opts->ip6po_pktinfo) != NULL && pi->ipi6_ifindex) {
556		/* XXX boundary check is assumed to be already done. */
557		ifp = ifnet_byindex(pi->ipi6_ifindex);
558		if (ifp != NULL &&
559		    (norouteok || retrt == NULL ||
560		    IN6_IS_ADDR_MULTICAST(dst))) {
561			/*
562			 * we do not have to check or get the route for
563			 * multicast.
564			 */
565			goto done;
566		} else
567			goto getroute;
568	}
569
570	/*
571	 * If the destination address is a multicast address and the outgoing
572	 * interface for the address is specified by the caller, use it.
573	 */
574	if (IN6_IS_ADDR_MULTICAST(dst) &&
575	    mopts != NULL && (ifp = mopts->im6o_multicast_ifp) != NULL) {
576		goto done; /* we do not need a route for multicast. */
577	}
578
579  getroute:
580	/*
581	 * If the next hop address for the packet is specified by the caller,
582	 * use it as the gateway.
583	 */
584	if (opts && opts->ip6po_nexthop) {
585		struct route_in6 *ron;
586		struct llentry *la;
587
588		sin6_next = satosin6(opts->ip6po_nexthop);
589
590		/* at this moment, we only support AF_INET6 next hops */
591		if (sin6_next->sin6_family != AF_INET6) {
592			error = EAFNOSUPPORT; /* or should we proceed? */
593			goto done;
594		}
595
596		/*
597		 * If the next hop is an IPv6 address, then the node identified
598		 * by that address must be a neighbor of the sending host.
599		 */
600		ron = &opts->ip6po_nextroute;
601		/*
602		 * XXX what do we do here?
603		 * PLZ to be fixing
604		 */
605
606
607		if (ron->ro_rt == NULL) {
608			in6_rtalloc(ron, fibnum); /* multi path case? */
609			if (ron->ro_rt == NULL) {
610				if (ron->ro_rt) {
611					RTFREE(ron->ro_rt);
612					ron->ro_rt = NULL;
613				}
614				error = EHOSTUNREACH;
615				goto done;
616			}
617		}
618
619		rt = ron->ro_rt;
620		ifp = rt->rt_ifp;
621		IF_AFDATA_RLOCK(ifp);
622		la = lla_lookup(LLTABLE6(ifp), 0, (struct sockaddr *)&sin6_next->sin6_addr);
623		IF_AFDATA_RUNLOCK(ifp);
624		if (la != NULL)
625			LLE_RUNLOCK(la);
626		else {
627			error = EHOSTUNREACH;
628			goto done;
629		}
630#if 0
631		if ((ron->ro_rt &&
632		     (ron->ro_rt->rt_flags & (RTF_UP | RTF_LLINFO)) !=
633		     (RTF_UP | RTF_LLINFO)) ||
634		    !IN6_ARE_ADDR_EQUAL(&satosin6(&ron->ro_dst)->sin6_addr,
635		    &sin6_next->sin6_addr)) {
636			if (ron->ro_rt) {
637				RTFREE(ron->ro_rt);
638				ron->ro_rt = NULL;
639			}
640			*satosin6(&ron->ro_dst) = *sin6_next;
641		}
642		if (ron->ro_rt == NULL) {
643			in6_rtalloc(ron, fibnum); /* multi path case? */
644			if (ron->ro_rt == NULL ||
645			    !(ron->ro_rt->rt_flags & RTF_LLINFO)) {
646				if (ron->ro_rt) {
647					RTFREE(ron->ro_rt);
648					ron->ro_rt = NULL;
649				}
650				error = EHOSTUNREACH;
651				goto done;
652			}
653		}
654#endif
655
656		/*
657		 * When cloning is required, try to allocate a route to the
658		 * destination so that the caller can store path MTU
659		 * information.
660		 */
661		goto done;
662	}
663
664	/*
665	 * Use a cached route if it exists and is valid, else try to allocate
666	 * a new one.  Note that we should check the address family of the
667	 * cached destination, in case of sharing the cache with IPv4.
668	 */
669	if (ro) {
670		if (ro->ro_rt &&
671		    (!(ro->ro_rt->rt_flags & RTF_UP) ||
672		     ((struct sockaddr *)(&ro->ro_dst))->sa_family != AF_INET6 ||
673		     !IN6_ARE_ADDR_EQUAL(&satosin6(&ro->ro_dst)->sin6_addr,
674		     dst))) {
675			RTFREE(ro->ro_rt);
676			ro->ro_rt = (struct rtentry *)NULL;
677		}
678		if (ro->ro_rt == (struct rtentry *)NULL) {
679			struct sockaddr_in6 *sa6;
680
681			/* No route yet, so try to acquire one */
682			bzero(&ro->ro_dst, sizeof(struct sockaddr_in6));
683			sa6 = (struct sockaddr_in6 *)&ro->ro_dst;
684			*sa6 = *dstsock;
685			sa6->sin6_scope_id = 0;
686
687#ifdef RADIX_MPATH
688				rtalloc_mpath_fib((struct route *)ro,
689				    ntohl(sa6->sin6_addr.s6_addr32[3]), fibnum);
690#else
691				ro->ro_rt = in6_rtalloc1((struct sockaddr *)
692				    &ro->ro_dst, 0, 0UL, fibnum);
693				if (ro->ro_rt)
694					RT_UNLOCK(ro->ro_rt);
695#endif
696		}
697
698		/*
699		 * do not care about the result if we have the nexthop
700		 * explicitly specified.
701		 */
702		if (opts && opts->ip6po_nexthop)
703			goto done;
704
705		if (ro->ro_rt) {
706			ifp = ro->ro_rt->rt_ifp;
707
708			if (ifp == NULL) { /* can this really happen? */
709				RTFREE(ro->ro_rt);
710				ro->ro_rt = NULL;
711			}
712		}
713		if (ro->ro_rt == NULL)
714			error = EHOSTUNREACH;
715		rt = ro->ro_rt;
716
717		/*
718		 * Check if the outgoing interface conflicts with
719		 * the interface specified by ipi6_ifindex (if specified).
720		 * Note that loopback interface is always okay.
721		 * (this may happen when we are sending a packet to one of
722		 *  our own addresses.)
723		 */
724		if (ifp && opts && opts->ip6po_pktinfo &&
725		    opts->ip6po_pktinfo->ipi6_ifindex) {
726			if (!(ifp->if_flags & IFF_LOOPBACK) &&
727			    ifp->if_index !=
728			    opts->ip6po_pktinfo->ipi6_ifindex) {
729				error = EHOSTUNREACH;
730				goto done;
731			}
732		}
733	}
734
735  done:
736	if (ifp == NULL && rt == NULL) {
737		/*
738		 * This can happen if the caller did not pass a cached route
739		 * nor any other hints.  We treat this case an error.
740		 */
741		error = EHOSTUNREACH;
742	}
743	if (error == EHOSTUNREACH)
744		IP6STAT_INC(ip6s_noroute);
745
746	if (retifp != NULL) {
747		*retifp = ifp;
748
749		/*
750		 * Adjust the "outgoing" interface.  If we're going to loop
751		 * the packet back to ourselves, the ifp would be the loopback
752		 * interface. However, we'd rather know the interface associated
753		 * to the destination address (which should probably be one of
754		 * our own addresses.)
755		 */
756		if (rt) {
757			if ((rt->rt_ifp->if_flags & IFF_LOOPBACK) &&
758			    (rt->rt_gateway->sa_family == AF_LINK))
759				*retifp =
760					ifnet_byindex(((struct sockaddr_dl *)
761						       rt->rt_gateway)->sdl_index);
762		}
763	}
764
765	if (retrt != NULL)
766		*retrt = rt;	/* rt may be NULL */
767
768	return (error);
769}
770
771static int
772in6_selectif(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
773    struct ip6_moptions *mopts, struct route_in6 *ro, struct ifnet **retifp,
774    struct ifnet *oifp, u_int fibnum)
775{
776	int error;
777	struct route_in6 sro;
778	struct rtentry *rt = NULL;
779
780	KASSERT(retifp != NULL, ("%s: retifp is NULL", __func__));
781
782	if (ro == NULL) {
783		bzero(&sro, sizeof(sro));
784		ro = &sro;
785	}
786
787	if ((error = selectroute(dstsock, opts, mopts, ro, retifp,
788	    &rt, 1, fibnum)) != 0) {
789		if (ro == &sro && rt && rt == sro.ro_rt)
790			RTFREE(rt);
791		/* Help ND. See oifp comment in in6_selectsrc(). */
792		if (oifp != NULL && fibnum == RT_DEFAULT_FIB) {
793			*retifp = oifp;
794			error = 0;
795		}
796		return (error);
797	}
798
799	/*
800	 * do not use a rejected or black hole route.
801	 * XXX: this check should be done in the L2 output routine.
802	 * However, if we skipped this check here, we'd see the following
803	 * scenario:
804	 * - install a rejected route for a scoped address prefix
805	 *   (like fe80::/10)
806	 * - send a packet to a destination that matches the scoped prefix,
807	 *   with ambiguity about the scope zone.
808	 * - pick the outgoing interface from the route, and disambiguate the
809	 *   scope zone with the interface.
810	 * - ip6_output() would try to get another route with the "new"
811	 *   destination, which may be valid.
812	 * - we'd see no error on output.
813	 * Although this may not be very harmful, it should still be confusing.
814	 * We thus reject the case here.
815	 */
816	if (rt && (rt->rt_flags & (RTF_REJECT | RTF_BLACKHOLE))) {
817		int flags = (rt->rt_flags & RTF_HOST ? EHOSTUNREACH : ENETUNREACH);
818
819		if (ro == &sro && rt && rt == sro.ro_rt)
820			RTFREE(rt);
821		return (flags);
822	}
823
824	if (ro == &sro && rt && rt == sro.ro_rt)
825		RTFREE(rt);
826	return (0);
827}
828
829/*
830 * Public wrapper function to selectroute().
831 *
832 * XXX-BZ in6_selectroute() should and will grow the FIB argument. The
833 * in6_selectroute_fib() function is only there for backward compat on stable.
834 */
835int
836in6_selectroute(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
837    struct ip6_moptions *mopts, struct route_in6 *ro,
838    struct ifnet **retifp, struct rtentry **retrt)
839{
840
841	return (selectroute(dstsock, opts, mopts, ro, retifp,
842	    retrt, 0, RT_DEFAULT_FIB));
843}
844
845#ifndef BURN_BRIDGES
846int
847in6_selectroute_fib(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
848    struct ip6_moptions *mopts, struct route_in6 *ro,
849    struct ifnet **retifp, struct rtentry **retrt, u_int fibnum)
850{
851
852	return (selectroute(dstsock, opts, mopts, ro, retifp,
853	    retrt, 0, fibnum));
854}
855#endif
856
857/*
858 * Default hop limit selection. The precedence is as follows:
859 * 1. Hoplimit value specified via ioctl.
860 * 2. (If the outgoing interface is detected) the current
861 *     hop limit of the interface specified by router advertisement.
862 * 3. The system default hoplimit.
863 */
864int
865in6_selecthlim(struct inpcb *in6p, struct ifnet *ifp)
866{
867
868	if (in6p && in6p->in6p_hops >= 0)
869		return (in6p->in6p_hops);
870	else if (ifp)
871		return (ND_IFINFO(ifp)->chlim);
872	else if (in6p && !IN6_IS_ADDR_UNSPECIFIED(&in6p->in6p_faddr)) {
873		struct route_in6 ro6;
874		struct ifnet *lifp;
875
876		bzero(&ro6, sizeof(ro6));
877		ro6.ro_dst.sin6_family = AF_INET6;
878		ro6.ro_dst.sin6_len = sizeof(struct sockaddr_in6);
879		ro6.ro_dst.sin6_addr = in6p->in6p_faddr;
880		in6_rtalloc(&ro6, in6p->inp_inc.inc_fibnum);
881		if (ro6.ro_rt) {
882			lifp = ro6.ro_rt->rt_ifp;
883			RTFREE(ro6.ro_rt);
884			if (lifp)
885				return (ND_IFINFO(lifp)->chlim);
886		}
887	}
888	return (V_ip6_defhlim);
889}
890
891/*
892 * XXX: this is borrowed from in6_pcbbind(). If possible, we should
893 * share this function by all *bsd*...
894 */
895int
896in6_pcbsetport(struct in6_addr *laddr, struct inpcb *inp, struct ucred *cred)
897{
898	struct socket *so = inp->inp_socket;
899	u_int16_t lport = 0;
900	int error, lookupflags = 0;
901#ifdef INVARIANTS
902	struct inpcbinfo *pcbinfo = inp->inp_pcbinfo;
903#endif
904
905	INP_WLOCK_ASSERT(inp);
906	INP_HASH_WLOCK_ASSERT(pcbinfo);
907
908	error = prison_local_ip6(cred, laddr,
909	    ((inp->inp_flags & IN6P_IPV6_V6ONLY) != 0));
910	if (error)
911		return(error);
912
913	/* XXX: this is redundant when called from in6_pcbbind */
914	if ((so->so_options & (SO_REUSEADDR|SO_REUSEPORT)) == 0)
915		lookupflags = INPLOOKUP_WILDCARD;
916
917	inp->inp_flags |= INP_ANONPORT;
918
919	error = in_pcb_lport(inp, NULL, &lport, cred, lookupflags);
920	if (error != 0)
921		return (error);
922
923	inp->inp_lport = lport;
924	if (in_pcbinshash(inp) != 0) {
925		inp->in6p_laddr = in6addr_any;
926		inp->inp_lport = 0;
927		return (EAGAIN);
928	}
929
930	return (0);
931}
932
933void
934addrsel_policy_init(void)
935{
936
937	init_policy_queue();
938
939	/* initialize the "last resort" policy */
940	bzero(&V_defaultaddrpolicy, sizeof(V_defaultaddrpolicy));
941	V_defaultaddrpolicy.label = ADDR_LABEL_NOTAPP;
942
943	if (!IS_DEFAULT_VNET(curvnet))
944		return;
945
946	ADDRSEL_LOCK_INIT();
947	ADDRSEL_SXLOCK_INIT();
948}
949
950static struct in6_addrpolicy *
951lookup_addrsel_policy(struct sockaddr_in6 *key)
952{
953	struct in6_addrpolicy *match = NULL;
954
955	ADDRSEL_LOCK();
956	match = match_addrsel_policy(key);
957
958	if (match == NULL)
959		match = &V_defaultaddrpolicy;
960	else
961		match->use++;
962	ADDRSEL_UNLOCK();
963
964	return (match);
965}
966
967/*
968 * Subroutines to manage the address selection policy table via sysctl.
969 */
970struct walkarg {
971	struct sysctl_req *w_req;
972};
973
974static int in6_src_sysctl(SYSCTL_HANDLER_ARGS);
975SYSCTL_DECL(_net_inet6_ip6);
976static SYSCTL_NODE(_net_inet6_ip6, IPV6CTL_ADDRCTLPOLICY, addrctlpolicy,
977	CTLFLAG_RD, in6_src_sysctl, "");
978
979static int
980in6_src_sysctl(SYSCTL_HANDLER_ARGS)
981{
982	struct walkarg w;
983
984	if (req->newptr)
985		return EPERM;
986
987	bzero(&w, sizeof(w));
988	w.w_req = req;
989
990	return (walk_addrsel_policy(dump_addrsel_policyent, &w));
991}
992
993int
994in6_src_ioctl(u_long cmd, caddr_t data)
995{
996	int i;
997	struct in6_addrpolicy ent0;
998
999	if (cmd != SIOCAADDRCTL_POLICY && cmd != SIOCDADDRCTL_POLICY)
1000		return (EOPNOTSUPP); /* check for safety */
1001
1002	ent0 = *(struct in6_addrpolicy *)data;
1003
1004	if (ent0.label == ADDR_LABEL_NOTAPP)
1005		return (EINVAL);
1006	/* check if the prefix mask is consecutive. */
1007	if (in6_mask2len(&ent0.addrmask.sin6_addr, NULL) < 0)
1008		return (EINVAL);
1009	/* clear trailing garbages (if any) of the prefix address. */
1010	for (i = 0; i < 4; i++) {
1011		ent0.addr.sin6_addr.s6_addr32[i] &=
1012			ent0.addrmask.sin6_addr.s6_addr32[i];
1013	}
1014	ent0.use = 0;
1015
1016	switch (cmd) {
1017	case SIOCAADDRCTL_POLICY:
1018		return (add_addrsel_policyent(&ent0));
1019	case SIOCDADDRCTL_POLICY:
1020		return (delete_addrsel_policyent(&ent0));
1021	}
1022
1023	return (0);		/* XXX: compromise compilers */
1024}
1025
1026/*
1027 * The followings are implementation of the policy table using a
1028 * simple tail queue.
1029 * XXX such details should be hidden.
1030 * XXX implementation using binary tree should be more efficient.
1031 */
1032struct addrsel_policyent {
1033	TAILQ_ENTRY(addrsel_policyent) ape_entry;
1034	struct in6_addrpolicy ape_policy;
1035};
1036
1037TAILQ_HEAD(addrsel_policyhead, addrsel_policyent);
1038
1039static VNET_DEFINE(struct addrsel_policyhead, addrsel_policytab);
1040#define	V_addrsel_policytab		VNET(addrsel_policytab)
1041
1042static void
1043init_policy_queue(void)
1044{
1045
1046	TAILQ_INIT(&V_addrsel_policytab);
1047}
1048
1049static int
1050add_addrsel_policyent(struct in6_addrpolicy *newpolicy)
1051{
1052	struct addrsel_policyent *new, *pol;
1053
1054	new = malloc(sizeof(*new), M_IFADDR,
1055	       M_WAITOK);
1056	ADDRSEL_XLOCK();
1057	ADDRSEL_LOCK();
1058
1059	/* duplication check */
1060	TAILQ_FOREACH(pol, &V_addrsel_policytab, ape_entry) {
1061		if (IN6_ARE_ADDR_EQUAL(&newpolicy->addr.sin6_addr,
1062				       &pol->ape_policy.addr.sin6_addr) &&
1063		    IN6_ARE_ADDR_EQUAL(&newpolicy->addrmask.sin6_addr,
1064				       &pol->ape_policy.addrmask.sin6_addr)) {
1065			ADDRSEL_UNLOCK();
1066			ADDRSEL_XUNLOCK();
1067			free(new, M_IFADDR);
1068			return (EEXIST);	/* or override it? */
1069		}
1070	}
1071
1072	bzero(new, sizeof(*new));
1073
1074	/* XXX: should validate entry */
1075	new->ape_policy = *newpolicy;
1076
1077	TAILQ_INSERT_TAIL(&V_addrsel_policytab, new, ape_entry);
1078	ADDRSEL_UNLOCK();
1079	ADDRSEL_XUNLOCK();
1080
1081	return (0);
1082}
1083
1084static int
1085delete_addrsel_policyent(struct in6_addrpolicy *key)
1086{
1087	struct addrsel_policyent *pol;
1088
1089	ADDRSEL_XLOCK();
1090	ADDRSEL_LOCK();
1091
1092	/* search for the entry in the table */
1093	TAILQ_FOREACH(pol, &V_addrsel_policytab, ape_entry) {
1094		if (IN6_ARE_ADDR_EQUAL(&key->addr.sin6_addr,
1095		    &pol->ape_policy.addr.sin6_addr) &&
1096		    IN6_ARE_ADDR_EQUAL(&key->addrmask.sin6_addr,
1097		    &pol->ape_policy.addrmask.sin6_addr)) {
1098			break;
1099		}
1100	}
1101	if (pol == NULL) {
1102		ADDRSEL_UNLOCK();
1103		ADDRSEL_XUNLOCK();
1104		return (ESRCH);
1105	}
1106
1107	TAILQ_REMOVE(&V_addrsel_policytab, pol, ape_entry);
1108	ADDRSEL_UNLOCK();
1109	ADDRSEL_XUNLOCK();
1110	free(pol, M_IFADDR);
1111
1112	return (0);
1113}
1114
1115static int
1116walk_addrsel_policy(int (*callback)(struct in6_addrpolicy *, void *),
1117    void *w)
1118{
1119	struct addrsel_policyent *pol;
1120	int error = 0;
1121
1122	ADDRSEL_SLOCK();
1123	TAILQ_FOREACH(pol, &V_addrsel_policytab, ape_entry) {
1124		if ((error = (*callback)(&pol->ape_policy, w)) != 0) {
1125			ADDRSEL_SUNLOCK();
1126			return (error);
1127		}
1128	}
1129	ADDRSEL_SUNLOCK();
1130	return (error);
1131}
1132
1133static int
1134dump_addrsel_policyent(struct in6_addrpolicy *pol, void *arg)
1135{
1136	int error = 0;
1137	struct walkarg *w = arg;
1138
1139	error = SYSCTL_OUT(w->w_req, pol, sizeof(*pol));
1140
1141	return (error);
1142}
1143
1144static struct in6_addrpolicy *
1145match_addrsel_policy(struct sockaddr_in6 *key)
1146{
1147	struct addrsel_policyent *pent;
1148	struct in6_addrpolicy *bestpol = NULL, *pol;
1149	int matchlen, bestmatchlen = -1;
1150	u_char *mp, *ep, *k, *p, m;
1151
1152	TAILQ_FOREACH(pent, &V_addrsel_policytab, ape_entry) {
1153		matchlen = 0;
1154
1155		pol = &pent->ape_policy;
1156		mp = (u_char *)&pol->addrmask.sin6_addr;
1157		ep = mp + 16;	/* XXX: scope field? */
1158		k = (u_char *)&key->sin6_addr;
1159		p = (u_char *)&pol->addr.sin6_addr;
1160		for (; mp < ep && *mp; mp++, k++, p++) {
1161			m = *mp;
1162			if ((*k & m) != *p)
1163				goto next; /* not match */
1164			if (m == 0xff) /* short cut for a typical case */
1165				matchlen += 8;
1166			else {
1167				while (m >= 0x80) {
1168					matchlen++;
1169					m <<= 1;
1170				}
1171			}
1172		}
1173
1174		/* matched.  check if this is better than the current best. */
1175		if (bestpol == NULL ||
1176		    matchlen > bestmatchlen) {
1177			bestpol = pol;
1178			bestmatchlen = matchlen;
1179		}
1180
1181	  next:
1182		continue;
1183	}
1184
1185	return (bestpol);
1186}
1187