]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - sys/netinet6/in6_src.c
MFC r269306:
[FreeBSD/stable/10.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/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
111 static 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
117 static 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)
125 static VNET_DEFINE(struct in6_addrpolicy, defaultaddrpolicy);
126 #define V_defaultaddrpolicy             VNET(defaultaddrpolicy)
127
128 VNET_DEFINE(int, ip6_prefer_tempaddr) = 0;
129
130 static int selectroute(struct sockaddr_in6 *, struct ip6_pktopts *,
131         struct ip6_moptions *, struct route_in6 *, struct ifnet **,
132         struct rtentry **, int, u_int);
133 static 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
137 static struct in6_addrpolicy *lookup_addrsel_policy(struct sockaddr_in6 *);
138
139 static void init_policy_queue(void);
140 static int add_addrsel_policyent(struct in6_addrpolicy *);
141 static int delete_addrsel_policyent(struct in6_addrpolicy *);
142 static int walk_addrsel_policy(int (*)(struct in6_addrpolicy *, void *),
143         void *);
144 static int dump_addrsel_policyent(struct in6_addrpolicy *, void *);
145 static 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
175 int
176 in6_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 9: prefer address with better virtual status.
447                  */
448                 if (ifa_preferred(&ia_best->ia_ifa, &ia->ia_ifa))
449                         REPLACE(9);
450
451                 /*
452                  * Rule 14: Use longest matching prefix.
453                  * Note: in the address selection draft, this rule is
454                  * documented as "Rule 8".  However, since it is also
455                  * documented that this rule can be overridden, we assign
456                  * a large number so that it is easy to assign smaller numbers
457                  * to more preferred rules.
458                  */
459                 new_matchlen = in6_matchlen(&ia->ia_addr.sin6_addr, &dst);
460                 if (best_matchlen < new_matchlen)
461                         REPLACE(14);
462                 if (new_matchlen < best_matchlen)
463                         NEXT(14);
464
465                 /* Rule 15 is reserved. */
466
467                 /*
468                  * Last resort: just keep the current candidate.
469                  * Or, do we need more rules?
470                  */
471                 continue;
472
473           replace:
474                 ia_best = ia;
475                 best_scope = (new_scope >= 0 ? new_scope :
476                               in6_addrscope(&ia_best->ia_addr.sin6_addr));
477                 best_policy = (new_policy ? new_policy :
478                                lookup_addrsel_policy(&ia_best->ia_addr));
479                 best_matchlen = (new_matchlen >= 0 ? new_matchlen :
480                                  in6_matchlen(&ia_best->ia_addr.sin6_addr,
481                                               &dst));
482
483           next:
484                 continue;
485
486           out:
487                 break;
488         }
489
490         if ((ia = ia_best) == NULL) {
491                 IN6_IFADDR_RUNLOCK();
492                 IP6STAT_INC(ip6s_sources_none);
493                 return (EADDRNOTAVAIL);
494         }
495
496         /*
497          * At this point at least one of the addresses belonged to the jail
498          * but it could still be, that we want to further restrict it, e.g.
499          * theoratically IN6_IS_ADDR_LOOPBACK.
500          * It must not be IN6_IS_ADDR_UNSPECIFIED anymore.
501          * prison_local_ip6() will fix an IN6_IS_ADDR_LOOPBACK but should
502          * let all others previously selected pass.
503          * Use tmp to not change ::1 on lo0 to the primary jail address.
504          */
505         tmp = ia->ia_addr.sin6_addr;
506         if (cred != NULL && prison_local_ip6(cred, &tmp, (inp != NULL &&
507             (inp->inp_flags & IN6P_IPV6_V6ONLY) != 0)) != 0) {
508                 IN6_IFADDR_RUNLOCK();
509                 IP6STAT_INC(ip6s_sources_none);
510                 return (EADDRNOTAVAIL);
511         }
512
513         if (ifpp)
514                 *ifpp = ifp;
515
516         bcopy(&tmp, srcp, sizeof(*srcp));
517         if (ia->ia_ifp == ifp)
518                 IP6STAT_INC(ip6s_sources_sameif[best_scope]);
519         else
520                 IP6STAT_INC(ip6s_sources_otherif[best_scope]);
521         if (dst_scope == best_scope)
522                 IP6STAT_INC(ip6s_sources_samescope[best_scope]);
523         else
524                 IP6STAT_INC(ip6s_sources_otherscope[best_scope]);
525         if (IFA6_IS_DEPRECATED(ia))
526                 IP6STAT_INC(ip6s_sources_deprecated[best_scope]);
527         IN6_IFADDR_RUNLOCK();
528         return (0);
529 }
530
531 /*
532  * clone - meaningful only for bsdi and freebsd
533  */
534 static int
535 selectroute(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
536     struct ip6_moptions *mopts, struct route_in6 *ro,
537     struct ifnet **retifp, struct rtentry **retrt, int norouteok, u_int fibnum)
538 {
539         int error = 0;
540         struct ifnet *ifp = NULL;
541         struct rtentry *rt = NULL;
542         struct sockaddr_in6 *sin6_next;
543         struct in6_pktinfo *pi = NULL;
544         struct in6_addr *dst = &dstsock->sin6_addr;
545 #if 0
546         char ip6buf[INET6_ADDRSTRLEN];
547
548         if (dstsock->sin6_addr.s6_addr32[0] == 0 &&
549             dstsock->sin6_addr.s6_addr32[1] == 0 &&
550             !IN6_IS_ADDR_LOOPBACK(&dstsock->sin6_addr)) {
551                 printf("in6_selectroute: strange destination %s\n",
552                        ip6_sprintf(ip6buf, &dstsock->sin6_addr));
553         } else {
554                 printf("in6_selectroute: destination = %s%%%d\n",
555                        ip6_sprintf(ip6buf, &dstsock->sin6_addr),
556                        dstsock->sin6_scope_id); /* for debug */
557         }
558 #endif
559
560         /* If the caller specify the outgoing interface explicitly, use it. */
561         if (opts && (pi = opts->ip6po_pktinfo) != NULL && pi->ipi6_ifindex) {
562                 /* XXX boundary check is assumed to be already done. */
563                 ifp = ifnet_byindex(pi->ipi6_ifindex);
564                 if (ifp != NULL &&
565                     (norouteok || retrt == NULL ||
566                     IN6_IS_ADDR_MULTICAST(dst))) {
567                         /*
568                          * we do not have to check or get the route for
569                          * multicast.
570                          */
571                         goto done;
572                 } else
573                         goto getroute;
574         }
575
576         /*
577          * If the destination address is a multicast address and the outgoing
578          * interface for the address is specified by the caller, use it.
579          */
580         if (IN6_IS_ADDR_MULTICAST(dst) &&
581             mopts != NULL && (ifp = mopts->im6o_multicast_ifp) != NULL) {
582                 goto done; /* we do not need a route for multicast. */
583         }
584
585   getroute:
586         /*
587          * If the next hop address for the packet is specified by the caller,
588          * use it as the gateway.
589          */
590         if (opts && opts->ip6po_nexthop) {
591                 struct route_in6 *ron;
592                 struct llentry *la;
593             
594                 sin6_next = satosin6(opts->ip6po_nexthop);
595                 
596                 /* at this moment, we only support AF_INET6 next hops */
597                 if (sin6_next->sin6_family != AF_INET6) {
598                         error = EAFNOSUPPORT; /* or should we proceed? */
599                         goto done;
600                 }
601
602                 /*
603                  * If the next hop is an IPv6 address, then the node identified
604                  * by that address must be a neighbor of the sending host.
605                  */
606                 ron = &opts->ip6po_nextroute;
607                 /*
608                  * XXX what do we do here?
609                  * PLZ to be fixing
610                  */
611
612
613                 if (ron->ro_rt == NULL) {
614                         in6_rtalloc(ron, fibnum); /* multi path case? */
615                         if (ron->ro_rt == NULL) {
616                                 /* XXX-BZ WT.? */
617                                 if (ron->ro_rt) {
618                                         RTFREE(ron->ro_rt);
619                                         ron->ro_rt = NULL;
620                                 }
621                                 error = EHOSTUNREACH;
622                                 goto done;
623                         } 
624                 }
625
626                 rt = ron->ro_rt;
627                 ifp = rt->rt_ifp;
628                 IF_AFDATA_RLOCK(ifp);
629                 la = lla_lookup(LLTABLE6(ifp), 0, (struct sockaddr *)&sin6_next->sin6_addr);
630                 IF_AFDATA_RUNLOCK(ifp);
631                 if (la != NULL) 
632                         LLE_RUNLOCK(la);
633                 else {
634                         error = EHOSTUNREACH;
635                         goto done;
636                 }
637 #if 0
638                 if ((ron->ro_rt &&
639                      (ron->ro_rt->rt_flags & (RTF_UP | RTF_LLINFO)) !=
640                      (RTF_UP | RTF_LLINFO)) ||
641                     !IN6_ARE_ADDR_EQUAL(&satosin6(&ron->ro_dst)->sin6_addr,
642                     &sin6_next->sin6_addr)) {
643                         if (ron->ro_rt) {
644                                 RTFREE(ron->ro_rt);
645                                 ron->ro_rt = NULL;
646                         }
647                         *satosin6(&ron->ro_dst) = *sin6_next;
648                 }
649                 if (ron->ro_rt == NULL) {
650                         in6_rtalloc(ron, fibnum); /* multi path case? */
651                         if (ron->ro_rt == NULL ||
652                             !(ron->ro_rt->rt_flags & RTF_LLINFO)) {
653                                 if (ron->ro_rt) {
654                                         RTFREE(ron->ro_rt);
655                                         ron->ro_rt = NULL;
656                                 }
657                                 error = EHOSTUNREACH;
658                                 goto done;
659                         }
660                 }
661 #endif
662
663                 /*
664                  * When cloning is required, try to allocate a route to the
665                  * destination so that the caller can store path MTU
666                  * information.
667                  */
668                 goto done;
669         }
670
671         /*
672          * Use a cached route if it exists and is valid, else try to allocate
673          * a new one.  Note that we should check the address family of the
674          * cached destination, in case of sharing the cache with IPv4.
675          */
676         if (ro) {
677                 if (ro->ro_rt &&
678                     (!(ro->ro_rt->rt_flags & RTF_UP) ||
679                      ((struct sockaddr *)(&ro->ro_dst))->sa_family != AF_INET6 ||
680                      !IN6_ARE_ADDR_EQUAL(&satosin6(&ro->ro_dst)->sin6_addr,
681                      dst))) {
682                         RTFREE(ro->ro_rt);
683                         ro->ro_rt = (struct rtentry *)NULL;
684                 }
685                 if (ro->ro_rt == (struct rtentry *)NULL) {
686                         struct sockaddr_in6 *sa6;
687
688                         /* No route yet, so try to acquire one */
689                         bzero(&ro->ro_dst, sizeof(struct sockaddr_in6));
690                         sa6 = (struct sockaddr_in6 *)&ro->ro_dst;
691                         *sa6 = *dstsock;
692                         sa6->sin6_scope_id = 0;
693
694 #ifdef RADIX_MPATH
695                                 rtalloc_mpath_fib((struct route *)ro,
696                                     ntohl(sa6->sin6_addr.s6_addr32[3]), fibnum);
697 #else                   
698                                 ro->ro_rt = in6_rtalloc1((struct sockaddr *)
699                                     &ro->ro_dst, 0, 0UL, fibnum);
700                                 if (ro->ro_rt)
701                                         RT_UNLOCK(ro->ro_rt);
702 #endif
703                 }
704                                 
705                 /*
706                  * do not care about the result if we have the nexthop
707                  * explicitly specified.
708                  */
709                 if (opts && opts->ip6po_nexthop)
710                         goto done;
711
712                 if (ro->ro_rt) {
713                         ifp = ro->ro_rt->rt_ifp;
714
715                         if (ifp == NULL) { /* can this really happen? */
716                                 RTFREE(ro->ro_rt);
717                                 ro->ro_rt = NULL;
718                         }
719                 }
720                 if (ro->ro_rt == NULL)
721                         error = EHOSTUNREACH;
722                 rt = ro->ro_rt;
723
724                 /*
725                  * Check if the outgoing interface conflicts with
726                  * the interface specified by ipi6_ifindex (if specified).
727                  * Note that loopback interface is always okay.
728                  * (this may happen when we are sending a packet to one of
729                  *  our own addresses.)
730                  */
731                 if (ifp && opts && opts->ip6po_pktinfo &&
732                     opts->ip6po_pktinfo->ipi6_ifindex) {
733                         if (!(ifp->if_flags & IFF_LOOPBACK) &&
734                             ifp->if_index !=
735                             opts->ip6po_pktinfo->ipi6_ifindex) {
736                                 error = EHOSTUNREACH;
737                                 goto done;
738                         }
739                 }
740         }
741
742   done:
743         if (ifp == NULL && rt == NULL) {
744                 /*
745                  * This can happen if the caller did not pass a cached route
746                  * nor any other hints.  We treat this case an error.
747                  */
748                 error = EHOSTUNREACH;
749         }
750         if (error == EHOSTUNREACH)
751                 IP6STAT_INC(ip6s_noroute);
752
753         if (retifp != NULL) {
754                 *retifp = ifp;
755
756                 /*
757                  * Adjust the "outgoing" interface.  If we're going to loop 
758                  * the packet back to ourselves, the ifp would be the loopback 
759                  * interface. However, we'd rather know the interface associated 
760                  * to the destination address (which should probably be one of 
761                  * our own addresses.)
762                  */
763                 if (rt) {
764                         if ((rt->rt_ifp->if_flags & IFF_LOOPBACK) &&
765                             (rt->rt_gateway->sa_family == AF_LINK))
766                                 *retifp = 
767                                         ifnet_byindex(((struct sockaddr_dl *)
768                                                        rt->rt_gateway)->sdl_index);
769                 }
770         }
771
772         if (retrt != NULL)
773                 *retrt = rt;    /* rt may be NULL */
774
775         return (error);
776 }
777
778 static int
779 in6_selectif(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
780     struct ip6_moptions *mopts, struct route_in6 *ro, struct ifnet **retifp,
781     struct ifnet *oifp, u_int fibnum)
782 {
783         int error;
784         struct route_in6 sro;
785         struct rtentry *rt = NULL;
786
787         KASSERT(retifp != NULL, ("%s: retifp is NULL", __func__));
788
789         if (ro == NULL) {
790                 bzero(&sro, sizeof(sro));
791                 ro = &sro;
792         }
793
794         if ((error = selectroute(dstsock, opts, mopts, ro, retifp,
795             &rt, 1, fibnum)) != 0) {
796                 if (ro == &sro && rt && rt == sro.ro_rt)
797                         RTFREE(rt);
798                 /* Help ND. See oifp comment in in6_selectsrc(). */
799                 if (oifp != NULL && fibnum == RT_DEFAULT_FIB) {
800                         *retifp = oifp;
801                         error = 0;
802                 }
803                 return (error);
804         }
805
806         /*
807          * do not use a rejected or black hole route.
808          * XXX: this check should be done in the L2 output routine.
809          * However, if we skipped this check here, we'd see the following
810          * scenario:
811          * - install a rejected route for a scoped address prefix
812          *   (like fe80::/10)
813          * - send a packet to a destination that matches the scoped prefix,
814          *   with ambiguity about the scope zone.
815          * - pick the outgoing interface from the route, and disambiguate the
816          *   scope zone with the interface.
817          * - ip6_output() would try to get another route with the "new"
818          *   destination, which may be valid.
819          * - we'd see no error on output.
820          * Although this may not be very harmful, it should still be confusing.
821          * We thus reject the case here.
822          */
823         if (rt && (rt->rt_flags & (RTF_REJECT | RTF_BLACKHOLE))) {
824                 int flags = (rt->rt_flags & RTF_HOST ? EHOSTUNREACH : ENETUNREACH);
825
826                 if (ro == &sro && rt && rt == sro.ro_rt)
827                         RTFREE(rt);
828                 return (flags);
829         }
830
831         if (ro == &sro && rt && rt == sro.ro_rt)
832                 RTFREE(rt);
833         return (0);
834 }
835
836 /*
837  * Public wrapper function to selectroute().
838  *
839  * XXX-BZ in6_selectroute() should and will grow the FIB argument. The
840  * in6_selectroute_fib() function is only there for backward compat on stable.
841  */
842 int
843 in6_selectroute(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
844     struct ip6_moptions *mopts, struct route_in6 *ro,
845     struct ifnet **retifp, struct rtentry **retrt)
846 {
847
848         return (selectroute(dstsock, opts, mopts, ro, retifp,
849             retrt, 0, RT_DEFAULT_FIB));
850 }
851
852 #ifndef BURN_BRIDGES
853 int
854 in6_selectroute_fib(struct sockaddr_in6 *dstsock, struct ip6_pktopts *opts,
855     struct ip6_moptions *mopts, struct route_in6 *ro,
856     struct ifnet **retifp, struct rtentry **retrt, u_int fibnum)
857 {
858
859         return (selectroute(dstsock, opts, mopts, ro, retifp,
860             retrt, 0, fibnum));
861 }
862 #endif
863
864 /*
865  * Default hop limit selection. The precedence is as follows:
866  * 1. Hoplimit value specified via ioctl.
867  * 2. (If the outgoing interface is detected) the current
868  *     hop limit of the interface specified by router advertisement.
869  * 3. The system default hoplimit.
870  */
871 int
872 in6_selecthlim(struct inpcb *in6p, struct ifnet *ifp)
873 {
874
875         if (in6p && in6p->in6p_hops >= 0)
876                 return (in6p->in6p_hops);
877         else if (ifp)
878                 return (ND_IFINFO(ifp)->chlim);
879         else if (in6p && !IN6_IS_ADDR_UNSPECIFIED(&in6p->in6p_faddr)) {
880                 struct route_in6 ro6;
881                 struct ifnet *lifp;
882
883                 bzero(&ro6, sizeof(ro6));
884                 ro6.ro_dst.sin6_family = AF_INET6;
885                 ro6.ro_dst.sin6_len = sizeof(struct sockaddr_in6);
886                 ro6.ro_dst.sin6_addr = in6p->in6p_faddr;
887                 in6_rtalloc(&ro6, in6p->inp_inc.inc_fibnum);
888                 if (ro6.ro_rt) {
889                         lifp = ro6.ro_rt->rt_ifp;
890                         RTFREE(ro6.ro_rt);
891                         if (lifp)
892                                 return (ND_IFINFO(lifp)->chlim);
893                 }
894         }
895         return (V_ip6_defhlim);
896 }
897
898 /*
899  * XXX: this is borrowed from in6_pcbbind(). If possible, we should
900  * share this function by all *bsd*...
901  */
902 int
903 in6_pcbsetport(struct in6_addr *laddr, struct inpcb *inp, struct ucred *cred)
904 {
905         struct socket *so = inp->inp_socket;
906         u_int16_t lport = 0;
907         int error, lookupflags = 0;
908 #ifdef INVARIANTS
909         struct inpcbinfo *pcbinfo = inp->inp_pcbinfo;
910 #endif
911
912         INP_WLOCK_ASSERT(inp);
913         INP_HASH_WLOCK_ASSERT(pcbinfo);
914
915         error = prison_local_ip6(cred, laddr,
916             ((inp->inp_flags & IN6P_IPV6_V6ONLY) != 0));
917         if (error)
918                 return(error);
919
920         /* XXX: this is redundant when called from in6_pcbbind */
921         if ((so->so_options & (SO_REUSEADDR|SO_REUSEPORT)) == 0)
922                 lookupflags = INPLOOKUP_WILDCARD;
923
924         inp->inp_flags |= INP_ANONPORT;
925
926         error = in_pcb_lport(inp, NULL, &lport, cred, lookupflags);
927         if (error != 0)
928                 return (error);
929
930         inp->inp_lport = lport;
931         if (in_pcbinshash(inp) != 0) {
932                 inp->in6p_laddr = in6addr_any;
933                 inp->inp_lport = 0;
934                 return (EAGAIN);
935         }
936
937         return (0);
938 }
939
940 void
941 addrsel_policy_init(void)
942 {
943
944         init_policy_queue();
945
946         /* initialize the "last resort" policy */
947         bzero(&V_defaultaddrpolicy, sizeof(V_defaultaddrpolicy));
948         V_defaultaddrpolicy.label = ADDR_LABEL_NOTAPP;
949
950         if (!IS_DEFAULT_VNET(curvnet))
951                 return;
952
953         ADDRSEL_LOCK_INIT();
954         ADDRSEL_SXLOCK_INIT();
955 }
956
957 static struct in6_addrpolicy *
958 lookup_addrsel_policy(struct sockaddr_in6 *key)
959 {
960         struct in6_addrpolicy *match = NULL;
961
962         ADDRSEL_LOCK();
963         match = match_addrsel_policy(key);
964
965         if (match == NULL)
966                 match = &V_defaultaddrpolicy;
967         else
968                 match->use++;
969         ADDRSEL_UNLOCK();
970
971         return (match);
972 }
973
974 /*
975  * Subroutines to manage the address selection policy table via sysctl.
976  */
977 struct walkarg {
978         struct sysctl_req *w_req;
979 };
980
981 static int in6_src_sysctl(SYSCTL_HANDLER_ARGS);
982 SYSCTL_DECL(_net_inet6_ip6);
983 static SYSCTL_NODE(_net_inet6_ip6, IPV6CTL_ADDRCTLPOLICY, addrctlpolicy,
984         CTLFLAG_RD, in6_src_sysctl, "");
985
986 static int
987 in6_src_sysctl(SYSCTL_HANDLER_ARGS)
988 {
989         struct walkarg w;
990
991         if (req->newptr)
992                 return EPERM;
993
994         bzero(&w, sizeof(w));
995         w.w_req = req;
996
997         return (walk_addrsel_policy(dump_addrsel_policyent, &w));
998 }
999
1000 int
1001 in6_src_ioctl(u_long cmd, caddr_t data)
1002 {
1003         int i;
1004         struct in6_addrpolicy ent0;
1005
1006         if (cmd != SIOCAADDRCTL_POLICY && cmd != SIOCDADDRCTL_POLICY)
1007                 return (EOPNOTSUPP); /* check for safety */
1008
1009         ent0 = *(struct in6_addrpolicy *)data;
1010
1011         if (ent0.label == ADDR_LABEL_NOTAPP)
1012                 return (EINVAL);
1013         /* check if the prefix mask is consecutive. */
1014         if (in6_mask2len(&ent0.addrmask.sin6_addr, NULL) < 0)
1015                 return (EINVAL);
1016         /* clear trailing garbages (if any) of the prefix address. */
1017         for (i = 0; i < 4; i++) {
1018                 ent0.addr.sin6_addr.s6_addr32[i] &=
1019                         ent0.addrmask.sin6_addr.s6_addr32[i];
1020         }
1021         ent0.use = 0;
1022
1023         switch (cmd) {
1024         case SIOCAADDRCTL_POLICY:
1025                 return (add_addrsel_policyent(&ent0));
1026         case SIOCDADDRCTL_POLICY:
1027                 return (delete_addrsel_policyent(&ent0));
1028         }
1029
1030         return (0);             /* XXX: compromise compilers */
1031 }
1032
1033 /*
1034  * The followings are implementation of the policy table using a
1035  * simple tail queue.
1036  * XXX such details should be hidden.
1037  * XXX implementation using binary tree should be more efficient.
1038  */
1039 struct addrsel_policyent {
1040         TAILQ_ENTRY(addrsel_policyent) ape_entry;
1041         struct in6_addrpolicy ape_policy;
1042 };
1043
1044 TAILQ_HEAD(addrsel_policyhead, addrsel_policyent);
1045
1046 static VNET_DEFINE(struct addrsel_policyhead, addrsel_policytab);
1047 #define V_addrsel_policytab             VNET(addrsel_policytab)
1048
1049 static void
1050 init_policy_queue(void)
1051 {
1052
1053         TAILQ_INIT(&V_addrsel_policytab);
1054 }
1055
1056 static int
1057 add_addrsel_policyent(struct in6_addrpolicy *newpolicy)
1058 {
1059         struct addrsel_policyent *new, *pol;
1060
1061         new = malloc(sizeof(*new), M_IFADDR,
1062                M_WAITOK);
1063         ADDRSEL_XLOCK();
1064         ADDRSEL_LOCK();
1065
1066         /* duplication check */
1067         TAILQ_FOREACH(pol, &V_addrsel_policytab, ape_entry) {
1068                 if (IN6_ARE_ADDR_EQUAL(&newpolicy->addr.sin6_addr,
1069                                        &pol->ape_policy.addr.sin6_addr) &&
1070                     IN6_ARE_ADDR_EQUAL(&newpolicy->addrmask.sin6_addr,
1071                                        &pol->ape_policy.addrmask.sin6_addr)) {
1072                         ADDRSEL_UNLOCK();
1073                         ADDRSEL_XUNLOCK();
1074                         free(new, M_IFADDR);
1075                         return (EEXIST);        /* or override it? */
1076                 }
1077         }
1078
1079         bzero(new, sizeof(*new));
1080
1081         /* XXX: should validate entry */
1082         new->ape_policy = *newpolicy;
1083
1084         TAILQ_INSERT_TAIL(&V_addrsel_policytab, new, ape_entry);
1085         ADDRSEL_UNLOCK();
1086         ADDRSEL_XUNLOCK();
1087
1088         return (0);
1089 }
1090
1091 static int
1092 delete_addrsel_policyent(struct in6_addrpolicy *key)
1093 {
1094         struct addrsel_policyent *pol;
1095
1096         ADDRSEL_XLOCK();
1097         ADDRSEL_LOCK();
1098
1099         /* search for the entry in the table */
1100         TAILQ_FOREACH(pol, &V_addrsel_policytab, ape_entry) {
1101                 if (IN6_ARE_ADDR_EQUAL(&key->addr.sin6_addr,
1102                     &pol->ape_policy.addr.sin6_addr) &&
1103                     IN6_ARE_ADDR_EQUAL(&key->addrmask.sin6_addr,
1104                     &pol->ape_policy.addrmask.sin6_addr)) {
1105                         break;
1106                 }
1107         }
1108         if (pol == NULL) {
1109                 ADDRSEL_UNLOCK();
1110                 ADDRSEL_XUNLOCK();
1111                 return (ESRCH);
1112         }
1113
1114         TAILQ_REMOVE(&V_addrsel_policytab, pol, ape_entry);
1115         ADDRSEL_UNLOCK();
1116         ADDRSEL_XUNLOCK();
1117         free(pol, M_IFADDR);
1118
1119         return (0);
1120 }
1121
1122 static int
1123 walk_addrsel_policy(int (*callback)(struct in6_addrpolicy *, void *), void *w)
1124 {
1125         struct addrsel_policyent *pol;
1126         int error = 0;
1127
1128         ADDRSEL_SLOCK();
1129         TAILQ_FOREACH(pol, &V_addrsel_policytab, ape_entry) {
1130                 if ((error = (*callback)(&pol->ape_policy, w)) != 0) {
1131                         ADDRSEL_SUNLOCK();
1132                         return (error);
1133                 }
1134         }
1135         ADDRSEL_SUNLOCK();
1136         return (error);
1137 }
1138
1139 static int
1140 dump_addrsel_policyent(struct in6_addrpolicy *pol, void *arg)
1141 {
1142         int error = 0;
1143         struct walkarg *w = arg;
1144
1145         error = SYSCTL_OUT(w->w_req, pol, sizeof(*pol));
1146
1147         return (error);
1148 }
1149
1150 static struct in6_addrpolicy *
1151 match_addrsel_policy(struct sockaddr_in6 *key)
1152 {
1153         struct addrsel_policyent *pent;
1154         struct in6_addrpolicy *bestpol = NULL, *pol;
1155         int matchlen, bestmatchlen = -1;
1156         u_char *mp, *ep, *k, *p, m;
1157
1158         TAILQ_FOREACH(pent, &V_addrsel_policytab, ape_entry) {
1159                 matchlen = 0;
1160
1161                 pol = &pent->ape_policy;
1162                 mp = (u_char *)&pol->addrmask.sin6_addr;
1163                 ep = mp + 16;   /* XXX: scope field? */
1164                 k = (u_char *)&key->sin6_addr;
1165                 p = (u_char *)&pol->addr.sin6_addr;
1166                 for (; mp < ep && *mp; mp++, k++, p++) {
1167                         m = *mp;
1168                         if ((*k & m) != *p)
1169                                 goto next; /* not match */
1170                         if (m == 0xff) /* short cut for a typical case */
1171                                 matchlen += 8;
1172                         else {
1173                                 while (m >= 0x80) {
1174                                         matchlen++;
1175                                         m <<= 1;
1176                                 }
1177                         }
1178                 }
1179
1180                 /* matched.  check if this is better than the current best. */
1181                 if (bestpol == NULL ||
1182                     matchlen > bestmatchlen) {
1183                         bestpol = pol;
1184                         bestmatchlen = matchlen;
1185                 }
1186
1187           next:
1188                 continue;
1189         }
1190
1191         return (bestpol);
1192 }