2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (C) 2000 WIDE Project.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the project nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * $KAME: scope6.c,v 1.10 2000/07/24 13:29:31 itojun Exp $
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/malloc.h>
40 #include <sys/socket.h>
41 #include <sys/sockio.h>
42 #include <sys/systm.h>
43 #include <sys/queue.h>
44 #include <sys/sysctl.h>
45 #include <sys/syslog.h>
48 #include <net/if_var.h>
51 #include <netinet/in.h>
53 #include <netinet/ip6.h>
54 #include <netinet6/in6_var.h>
55 #include <netinet6/ip6_var.h>
56 #include <netinet6/scope6_var.h>
58 #ifdef ENABLE_DEFAULT_SCOPE
59 VNET_DEFINE(int, ip6_use_defzone) = 1;
61 VNET_DEFINE(int, ip6_use_defzone) = 0;
63 VNET_DEFINE(int, deembed_scopeid) = 1;
64 SYSCTL_DECL(_net_inet6_ip6);
65 SYSCTL_INT(_net_inet6_ip6, OID_AUTO, deembed_scopeid, CTLFLAG_VNET | CTLFLAG_RW,
66 &VNET_NAME(deembed_scopeid), 0,
67 "Extract embedded zone ID and set it to sin6_scope_id in sockaddr_in6.");
70 * The scope6_lock protects the global sid default stored in
73 static struct mtx scope6_lock;
74 #define SCOPE6_LOCK_INIT() mtx_init(&scope6_lock, "scope6_lock", NULL, MTX_DEF)
75 #define SCOPE6_LOCK() mtx_lock(&scope6_lock)
76 #define SCOPE6_UNLOCK() mtx_unlock(&scope6_lock)
77 #define SCOPE6_LOCK_ASSERT() mtx_assert(&scope6_lock, MA_OWNED)
79 static VNET_DEFINE(struct scope6_id, sid_default);
80 #define V_sid_default VNET(sid_default)
83 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->scope6_id)
85 static int scope6_get(struct ifnet *, struct scope6_id *);
86 static int scope6_set(struct ifnet *, struct scope6_id *);
92 bzero(&V_sid_default, sizeof(V_sid_default));
94 if (!IS_DEFAULT_VNET(curvnet))
101 scope6_ifattach(struct ifnet *ifp)
103 struct scope6_id *sid;
105 sid = malloc(sizeof(*sid), M_IFADDR, M_WAITOK | M_ZERO);
107 * XXX: IPV6_ADDR_SCOPE_xxx macros are not standard.
108 * Should we rather hardcode here?
110 sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = ifp->if_index;
111 sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = ifp->if_index;
116 scope6_ifdetach(struct scope6_id *sid)
123 scope6_ioctl(u_long cmd, caddr_t data, struct ifnet *ifp)
125 struct in6_ifreq *ifr;
127 if (ifp->if_afdata[AF_INET6] == NULL)
128 return (EPFNOSUPPORT);
130 ifr = (struct in6_ifreq *)data;
133 return (scope6_set(ifp,
134 (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
136 return (scope6_get(ifp,
137 (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
139 return (scope6_get_default(
140 (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
147 scope6_set(struct ifnet *ifp, struct scope6_id *idlist)
151 struct scope6_id *sid = NULL;
153 IF_AFDATA_WLOCK(ifp);
156 if (!sid) { /* paranoid? */
157 IF_AFDATA_WUNLOCK(ifp);
162 * XXX: We need more consistency checks of the relationship among
163 * scopes (e.g. an organization should be larger than a site).
167 * TODO(XXX): after setting, we should reflect the changes to
168 * interface addresses, routing table entries, PCB entries...
171 for (i = 0; i < 16; i++) {
172 if (idlist->s6id_list[i] &&
173 idlist->s6id_list[i] != sid->s6id_list[i]) {
175 * An interface zone ID must be the corresponding
176 * interface index by definition.
178 if (i == IPV6_ADDR_SCOPE_INTFACELOCAL &&
179 idlist->s6id_list[i] != ifp->if_index) {
180 IF_AFDATA_WUNLOCK(ifp);
184 if (i == IPV6_ADDR_SCOPE_LINKLOCAL &&
185 idlist->s6id_list[i] > V_if_index) {
187 * XXX: theoretically, there should be no
188 * relationship between link IDs and interface
189 * IDs, but we check the consistency for
190 * safety in later use.
192 IF_AFDATA_WUNLOCK(ifp);
197 * XXX: we must need lots of work in this case,
198 * but we simply set the new value in this initial
201 sid->s6id_list[i] = idlist->s6id_list[i];
204 IF_AFDATA_WUNLOCK(ifp);
210 scope6_get(struct ifnet *ifp, struct scope6_id *idlist)
212 struct scope6_id *sid;
214 /* We only need to lock the interface's afdata for SID() to work. */
215 IF_AFDATA_RLOCK(ifp);
217 if (sid == NULL) { /* paranoid? */
218 IF_AFDATA_RUNLOCK(ifp);
224 IF_AFDATA_RUNLOCK(ifp);
229 * Get a scope of the address. Node-local, link-local, site-local or global.
232 in6_addrscope(const struct in6_addr *addr)
235 if (IN6_IS_ADDR_MULTICAST(addr)) {
237 * Addresses with reserved value F must be treated as
238 * global multicast addresses.
240 if (IPV6_ADDR_MC_SCOPE(addr) == 0x0f)
241 return (IPV6_ADDR_SCOPE_GLOBAL);
242 return (IPV6_ADDR_MC_SCOPE(addr));
244 if (IN6_IS_ADDR_LINKLOCAL(addr) ||
245 IN6_IS_ADDR_LOOPBACK(addr))
246 return (IPV6_ADDR_SCOPE_LINKLOCAL);
247 if (IN6_IS_ADDR_SITELOCAL(addr))
248 return (IPV6_ADDR_SCOPE_SITELOCAL);
249 return (IPV6_ADDR_SCOPE_GLOBAL);
253 * ifp - note that this might be NULL
257 scope6_setdefault(struct ifnet *ifp)
261 * Currently, this function just sets the default "interfaces"
262 * and "links" according to the given interface.
263 * We might eventually have to separate the notion of "link" from
264 * "interface" and provide a user interface to set the default.
268 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] =
270 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] =
273 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = 0;
274 V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = 0;
280 scope6_get_default(struct scope6_id *idlist)
284 *idlist = V_sid_default;
291 scope6_addr2default(struct in6_addr *addr)
296 * special case: The loopback address should be considered as
297 * link-local, but there's no ambiguity in the syntax.
299 if (IN6_IS_ADDR_LOOPBACK(addr))
303 * XXX: 32-bit read is atomic on all our platforms, is it OK
307 id = V_sid_default.s6id_list[in6_addrscope(addr)];
313 * Validate the specified scope zone ID in the sin6_scope_id field. If the ID
314 * is unspecified (=0), needs to be specified, and the default zone ID can be
315 * used, the default value will be used.
316 * This routine then generates the kernel-internal form: if the address scope
317 * of is interface-local or link-local, embed the interface index in the
321 sa6_embedscope(struct sockaddr_in6 *sin6, int defaultok)
325 if ((zoneid = sin6->sin6_scope_id) == 0 && defaultok)
326 zoneid = scope6_addr2default(&sin6->sin6_addr);
329 (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
330 IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr))) {
332 * At this moment, we only check interface-local and
333 * link-local scope IDs, and use interface indices as the
334 * zone IDs assuming a one-to-one mapping between interfaces
337 if (V_if_index < zoneid || ifnet_byindex(zoneid) == NULL)
340 /* XXX assignment to 16bit from 32bit variable */
341 sin6->sin6_addr.s6_addr16[1] = htons(zoneid & 0xffff);
342 sin6->sin6_scope_id = 0;
349 * generate standard sockaddr_in6 from embedded form.
352 sa6_recoverscope(struct sockaddr_in6 *sin6)
354 char ip6buf[INET6_ADDRSTRLEN];
357 if (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
358 IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr)) {
360 * KAME assumption: link id == interface id
362 zoneid = ntohs(sin6->sin6_addr.s6_addr16[1]);
365 if (V_if_index < zoneid)
368 /* XXX: Disabled due to possible deadlock. */
369 if (!ifnet_byindex(zoneid))
372 if (sin6->sin6_scope_id != 0 &&
373 zoneid != sin6->sin6_scope_id) {
375 "%s: embedded scope mismatch: %s%%%d. "
376 "sin6_scope_id was overridden\n", __func__,
377 ip6_sprintf(ip6buf, &sin6->sin6_addr),
378 sin6->sin6_scope_id);
380 sin6->sin6_addr.s6_addr16[1] = 0;
381 sin6->sin6_scope_id = zoneid;
389 * Determine the appropriate scope zone ID for in6 and ifp. If ret_id is
390 * non NULL, it is set to the zone ID. If the zone ID needs to be embedded
391 * in the in6_addr structure, in6 will be modified.
393 * ret_id - unnecessary?
396 in6_setscope(struct in6_addr *in6, struct ifnet *ifp, u_int32_t *ret_id)
399 u_int32_t zoneid = 0;
400 struct scope6_id *sid;
403 * special case: the loopback address can only belong to a loopback
406 if (IN6_IS_ADDR_LOOPBACK(in6)) {
407 if (!(ifp->if_flags & IFF_LOOPBACK))
410 scope = in6_addrscope(in6);
411 if (scope == IPV6_ADDR_SCOPE_INTFACELOCAL ||
412 scope == IPV6_ADDR_SCOPE_LINKLOCAL) {
414 * Currently we use interface indices as the
415 * zone IDs for interface-local and link-local
418 zoneid = ifp->if_index;
419 in6->s6_addr16[1] = htons(zoneid & 0xffff); /* XXX */
420 } else if (scope != IPV6_ADDR_SCOPE_GLOBAL) {
421 IF_AFDATA_RLOCK(ifp);
423 zoneid = sid->s6id_list[scope];
424 IF_AFDATA_RUNLOCK(ifp);
435 * Just clear the embedded scope identifier. Return 0 if the original address
436 * is intact; return non 0 if the address is modified.
439 in6_clearscope(struct in6_addr *in6)
443 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) {
444 if (in6->s6_addr16[1] != 0)
446 in6->s6_addr16[1] = 0;
453 * Return the scope identifier or zero.
456 in6_getscope(struct in6_addr *in6)
459 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6))
460 return (in6->s6_addr16[1]);
466 * Return pointer to ifnet structure, corresponding to the zone id of
470 in6_getlinkifnet(uint32_t zoneid)
473 return (ifnet_byindex((u_short)zoneid));
477 * Return zone id for the specified scope.
480 in6_getscopezone(const struct ifnet *ifp, int scope)
483 if (scope == IPV6_ADDR_SCOPE_INTFACELOCAL ||
484 scope == IPV6_ADDR_SCOPE_LINKLOCAL)
485 return (ifp->if_index);
486 if (scope >= 0 && scope < IPV6_ADDR_SCOPES_COUNT)
487 return (SID(ifp)->s6id_list[scope]);
492 * Extracts scope from adddress @dst, stores cleared address
493 * inside @dst and zone inside @scopeid
496 in6_splitscope(const struct in6_addr *src, struct in6_addr *dst,
502 zoneid = ntohs(in6_getscope(dst));
508 * This function is for checking sockaddr_in6 structure passed
509 * from the application level (usually).
511 * sin6_scope_id should be set for link-local unicast, link-local and
512 * interface-local multicast addresses.
514 * If it is zero, then look into default zone ids. If default zone id is
515 * not set or disabled, then return error.
518 sa6_checkzone(struct sockaddr_in6 *sa6)
522 scope = in6_addrscope(&sa6->sin6_addr);
523 if (scope == IPV6_ADDR_SCOPE_GLOBAL)
524 return (sa6->sin6_scope_id ? EINVAL: 0);
525 if (IN6_IS_ADDR_MULTICAST(&sa6->sin6_addr) &&
526 scope != IPV6_ADDR_SCOPE_LINKLOCAL &&
527 scope != IPV6_ADDR_SCOPE_INTFACELOCAL) {
528 if (sa6->sin6_scope_id == 0 && V_ip6_use_defzone != 0)
529 sa6->sin6_scope_id = V_sid_default.s6id_list[scope];
533 * Since ::1 address always configured on the lo0, we can
534 * automatically set its zone id, when it is not specified.
535 * Return error, when specified zone id doesn't match with
538 if (IN6_IS_ADDR_LOOPBACK(&sa6->sin6_addr)) {
539 if (sa6->sin6_scope_id == 0)
540 sa6->sin6_scope_id = in6_getscopezone(V_loif, scope);
541 else if (sa6->sin6_scope_id != in6_getscopezone(V_loif, scope))
542 return (EADDRNOTAVAIL);
544 /* XXX: we can validate sin6_scope_id here */
545 if (sa6->sin6_scope_id != 0)
547 if (V_ip6_use_defzone != 0)
548 sa6->sin6_scope_id = V_sid_default.s6id_list[scope];
549 /* Return error if we can't determine zone id */
550 return (sa6->sin6_scope_id ? 0: EADDRNOTAVAIL);
554 * This function is similar to sa6_checkzone, but it uses given ifp
555 * to initialize sin6_scope_id.
558 sa6_checkzone_ifp(struct ifnet *ifp, struct sockaddr_in6 *sa6)
562 scope = in6_addrscope(&sa6->sin6_addr);
563 if (scope == IPV6_ADDR_SCOPE_LINKLOCAL ||
564 scope == IPV6_ADDR_SCOPE_INTFACELOCAL) {
565 if (sa6->sin6_scope_id == 0) {
566 sa6->sin6_scope_id = in6_getscopezone(ifp, scope);
568 } else if (sa6->sin6_scope_id != in6_getscopezone(ifp, scope))
569 return (EADDRNOTAVAIL);
571 return (sa6_checkzone(sa6));