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