xref: /freebsd/sys/netinet6/scope6.c (revision 41874e85d6edda0cebdc84cb279c8de5cf88ba38)
1caf43b02SWarner Losh /*-
2686cdd19SJun-ichiro itojun Hagino  * Copyright (C) 2000 WIDE Project.
3686cdd19SJun-ichiro itojun Hagino  * All rights reserved.
4686cdd19SJun-ichiro itojun Hagino  *
5686cdd19SJun-ichiro itojun Hagino  * Redistribution and use in source and binary forms, with or without
6686cdd19SJun-ichiro itojun Hagino  * modification, are permitted provided that the following conditions
7686cdd19SJun-ichiro itojun Hagino  * are met:
8686cdd19SJun-ichiro itojun Hagino  * 1. Redistributions of source code must retain the above copyright
9686cdd19SJun-ichiro itojun Hagino  *    notice, this list of conditions and the following disclaimer.
10686cdd19SJun-ichiro itojun Hagino  * 2. Redistributions in binary form must reproduce the above copyright
11686cdd19SJun-ichiro itojun Hagino  *    notice, this list of conditions and the following disclaimer in the
12686cdd19SJun-ichiro itojun Hagino  *    documentation and/or other materials provided with the distribution.
13686cdd19SJun-ichiro itojun Hagino  * 3. Neither the name of the project nor the names of its contributors
14686cdd19SJun-ichiro itojun Hagino  *    may be used to endorse or promote products derived from this software
15686cdd19SJun-ichiro itojun Hagino  *    without specific prior written permission.
16686cdd19SJun-ichiro itojun Hagino  *
17686cdd19SJun-ichiro itojun Hagino  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18686cdd19SJun-ichiro itojun Hagino  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19686cdd19SJun-ichiro itojun Hagino  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20686cdd19SJun-ichiro itojun Hagino  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21686cdd19SJun-ichiro itojun Hagino  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22686cdd19SJun-ichiro itojun Hagino  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23686cdd19SJun-ichiro itojun Hagino  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24686cdd19SJun-ichiro itojun Hagino  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25686cdd19SJun-ichiro itojun Hagino  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26686cdd19SJun-ichiro itojun Hagino  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27686cdd19SJun-ichiro itojun Hagino  * SUCH DAMAGE.
28b48287a3SDavid E. O'Brien  *
29b48287a3SDavid E. O'Brien  *	$KAME: scope6.c,v 1.10 2000/07/24 13:29:31 itojun Exp $
30686cdd19SJun-ichiro itojun Hagino  */
31686cdd19SJun-ichiro itojun Hagino 
32b48287a3SDavid E. O'Brien #include <sys/cdefs.h>
33b48287a3SDavid E. O'Brien __FBSDID("$FreeBSD$");
34b48287a3SDavid E. O'Brien 
35686cdd19SJun-ichiro itojun Hagino #include <sys/param.h>
36686cdd19SJun-ichiro itojun Hagino #include <sys/malloc.h>
37686cdd19SJun-ichiro itojun Hagino #include <sys/mbuf.h>
38686cdd19SJun-ichiro itojun Hagino #include <sys/socket.h>
395fc26322SMark Johnston #include <sys/sockio.h>
40686cdd19SJun-ichiro itojun Hagino #include <sys/systm.h>
4133841545SHajimu UMEMOTO #include <sys/queue.h>
420bebb544SHiroki Sato #include <sys/sysctl.h>
43a1f7e5f8SHajimu UMEMOTO #include <sys/syslog.h>
44686cdd19SJun-ichiro itojun Hagino 
45686cdd19SJun-ichiro itojun Hagino #include <net/if.h>
4676039bc8SGleb Smirnoff #include <net/if_var.h>
474b79449eSBjoern A. Zeeb #include <net/vnet.h>
48686cdd19SJun-ichiro itojun Hagino 
49686cdd19SJun-ichiro itojun Hagino #include <netinet/in.h>
50686cdd19SJun-ichiro itojun Hagino 
514b79449eSBjoern A. Zeeb #include <netinet/ip6.h>
52686cdd19SJun-ichiro itojun Hagino #include <netinet6/in6_var.h>
53eddfbb76SRobert Watson #include <netinet6/ip6_var.h>
54686cdd19SJun-ichiro itojun Hagino #include <netinet6/scope6_var.h>
55686cdd19SJun-ichiro itojun Hagino 
5682cea7e6SBjoern A. Zeeb #ifdef ENABLE_DEFAULT_SCOPE
5782cea7e6SBjoern A. Zeeb VNET_DEFINE(int, ip6_use_defzone) = 1;
5882cea7e6SBjoern A. Zeeb #else
5982cea7e6SBjoern A. Zeeb VNET_DEFINE(int, ip6_use_defzone) = 0;
6082cea7e6SBjoern A. Zeeb #endif
610bebb544SHiroki Sato VNET_DEFINE(int, deembed_scopeid) = 1;
620bebb544SHiroki Sato SYSCTL_DECL(_net_inet6_ip6);
630bebb544SHiroki Sato SYSCTL_VNET_INT(_net_inet6_ip6, OID_AUTO, deembed_scopeid, CTLFLAG_RW,
640bebb544SHiroki Sato     &VNET_NAME(deembed_scopeid), 0,
650bebb544SHiroki Sato     "Extract embedded zone ID and set it to sin6_scope_id in sockaddr_in6.");
66a1f7e5f8SHajimu UMEMOTO 
671ab976cbSHajimu UMEMOTO /*
68026e67b6SGeorge V. Neville-Neil  * The scope6_lock protects the global sid default stored in
69026e67b6SGeorge V. Neville-Neil  * sid_default below.
701ab976cbSHajimu UMEMOTO  */
711ab976cbSHajimu UMEMOTO static struct mtx scope6_lock;
721ab976cbSHajimu UMEMOTO #define	SCOPE6_LOCK_INIT()	mtx_init(&scope6_lock, "scope6_lock", NULL, MTX_DEF)
731ab976cbSHajimu UMEMOTO #define	SCOPE6_LOCK()		mtx_lock(&scope6_lock)
741ab976cbSHajimu UMEMOTO #define	SCOPE6_UNLOCK()		mtx_unlock(&scope6_lock)
751ab976cbSHajimu UMEMOTO #define	SCOPE6_LOCK_ASSERT()	mtx_assert(&scope6_lock, MA_OWNED)
761ab976cbSHajimu UMEMOTO 
773e288e62SDimitry Andric static VNET_DEFINE(struct scope6_id, sid_default);
781e77c105SRobert Watson #define	V_sid_default			VNET(sid_default)
7944e33a07SMarko Zec 
8031b1bfe1SHajimu UMEMOTO #define SID(ifp) \
8131b1bfe1SHajimu UMEMOTO 	(((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->scope6_id)
82686cdd19SJun-ichiro itojun Hagino 
835fc26322SMark Johnston static int	scope6_get(struct ifnet *, struct scope6_id *);
845fc26322SMark Johnston static int	scope6_set(struct ifnet *, struct scope6_id *);
855fc26322SMark Johnston 
86686cdd19SJun-ichiro itojun Hagino void
871272577eSXin LI scope6_init(void)
8831b1bfe1SHajimu UMEMOTO {
8931b1bfe1SHajimu UMEMOTO 
90603724d3SBjoern A. Zeeb 	bzero(&V_sid_default, sizeof(V_sid_default));
911ed81b73SMarko Zec 
921ed81b73SMarko Zec 	if (!IS_DEFAULT_VNET(curvnet))
931ed81b73SMarko Zec 		return;
941ed81b73SMarko Zec 
951ed81b73SMarko Zec 	SCOPE6_LOCK_INIT();
9631b1bfe1SHajimu UMEMOTO }
9731b1bfe1SHajimu UMEMOTO 
9831b1bfe1SHajimu UMEMOTO struct scope6_id *
991272577eSXin LI scope6_ifattach(struct ifnet *ifp)
100686cdd19SJun-ichiro itojun Hagino {
10131b1bfe1SHajimu UMEMOTO 	struct scope6_id *sid;
102686cdd19SJun-ichiro itojun Hagino 
10331b1bfe1SHajimu UMEMOTO 	sid = (struct scope6_id *)malloc(sizeof(*sid), M_IFADDR, M_WAITOK);
10431b1bfe1SHajimu UMEMOTO 	bzero(sid, sizeof(*sid));
105686cdd19SJun-ichiro itojun Hagino 
106686cdd19SJun-ichiro itojun Hagino 	/*
107686cdd19SJun-ichiro itojun Hagino 	 * XXX: IPV6_ADDR_SCOPE_xxx macros are not standard.
108686cdd19SJun-ichiro itojun Hagino 	 * Should we rather hardcode here?
109686cdd19SJun-ichiro itojun Hagino 	 */
1109a4f9608SHajimu UMEMOTO 	sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = ifp->if_index;
11131b1bfe1SHajimu UMEMOTO 	sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = ifp->if_index;
112686cdd19SJun-ichiro itojun Hagino #ifdef MULTI_SCOPE
113686cdd19SJun-ichiro itojun Hagino 	/* by default, we don't care about scope boundary for these scopes. */
11431b1bfe1SHajimu UMEMOTO 	sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL] = 1;
11531b1bfe1SHajimu UMEMOTO 	sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL] = 1;
116686cdd19SJun-ichiro itojun Hagino #endif
117686cdd19SJun-ichiro itojun Hagino 
11831b1bfe1SHajimu UMEMOTO 	return sid;
11931b1bfe1SHajimu UMEMOTO }
12031b1bfe1SHajimu UMEMOTO 
12131b1bfe1SHajimu UMEMOTO void
1221272577eSXin LI scope6_ifdetach(struct scope6_id *sid)
12331b1bfe1SHajimu UMEMOTO {
12431b1bfe1SHajimu UMEMOTO 
12531b1bfe1SHajimu UMEMOTO 	free(sid, M_IFADDR);
126686cdd19SJun-ichiro itojun Hagino }
127686cdd19SJun-ichiro itojun Hagino 
128686cdd19SJun-ichiro itojun Hagino int
1295fc26322SMark Johnston scope6_ioctl(u_long cmd, caddr_t data, struct ifnet *ifp)
1305fc26322SMark Johnston {
1315fc26322SMark Johnston 	struct in6_ifreq *ifr;
1325fc26322SMark Johnston 
1335fc26322SMark Johnston 	if (ifp->if_afdata[AF_INET6] == NULL)
1345fc26322SMark Johnston 		return (EPFNOSUPPORT);
1355fc26322SMark Johnston 
1365fc26322SMark Johnston 	ifr = (struct in6_ifreq *)data;
1375fc26322SMark Johnston 	switch (cmd) {
1385fc26322SMark Johnston 	case SIOCSSCOPE6:
1395fc26322SMark Johnston 		return (scope6_set(ifp,
1405fc26322SMark Johnston 		    (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
1415fc26322SMark Johnston 	case SIOCGSCOPE6:
1425fc26322SMark Johnston 		return (scope6_get(ifp,
1435fc26322SMark Johnston 		    (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
1445fc26322SMark Johnston 	case SIOCGSCOPE6DEF:
1455fc26322SMark Johnston 		return (scope6_get_default(
1465fc26322SMark Johnston 		    (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id));
1475fc26322SMark Johnston 	default:
1485fc26322SMark Johnston 		return (EOPNOTSUPP);
1495fc26322SMark Johnston 	}
1505fc26322SMark Johnston }
1515fc26322SMark Johnston 
1525fc26322SMark Johnston static int
1531272577eSXin LI scope6_set(struct ifnet *ifp, struct scope6_id *idlist)
154686cdd19SJun-ichiro itojun Hagino {
155026e67b6SGeorge V. Neville-Neil 	int i;
156686cdd19SJun-ichiro itojun Hagino 	int error = 0;
157026e67b6SGeorge V. Neville-Neil 	struct scope6_id *sid = NULL;
158686cdd19SJun-ichiro itojun Hagino 
1595cf7ec13SAndrey V. Elsukov 	IF_AFDATA_WLOCK(ifp);
160026e67b6SGeorge V. Neville-Neil 	sid = SID(ifp);
161026e67b6SGeorge V. Neville-Neil 
162026e67b6SGeorge V. Neville-Neil 	if (!sid) {	/* paranoid? */
1635cf7ec13SAndrey V. Elsukov 		IF_AFDATA_WUNLOCK(ifp);
164686cdd19SJun-ichiro itojun Hagino 		return (EINVAL);
165026e67b6SGeorge V. Neville-Neil 	}
166686cdd19SJun-ichiro itojun Hagino 
167686cdd19SJun-ichiro itojun Hagino 	/*
168686cdd19SJun-ichiro itojun Hagino 	 * XXX: We need more consistency checks of the relationship among
169686cdd19SJun-ichiro itojun Hagino 	 * scopes (e.g. an organization should be larger than a site).
170686cdd19SJun-ichiro itojun Hagino 	 */
171686cdd19SJun-ichiro itojun Hagino 
172686cdd19SJun-ichiro itojun Hagino 	/*
173686cdd19SJun-ichiro itojun Hagino 	 * TODO(XXX): after setting, we should reflect the changes to
174686cdd19SJun-ichiro itojun Hagino 	 * interface addresses, routing table entries, PCB entries...
175686cdd19SJun-ichiro itojun Hagino 	 */
176686cdd19SJun-ichiro itojun Hagino 
177686cdd19SJun-ichiro itojun Hagino 	for (i = 0; i < 16; i++) {
17831b1bfe1SHajimu UMEMOTO 		if (idlist->s6id_list[i] &&
17931b1bfe1SHajimu UMEMOTO 		    idlist->s6id_list[i] != sid->s6id_list[i]) {
1809a4f9608SHajimu UMEMOTO 			/*
1819a4f9608SHajimu UMEMOTO 			 * An interface zone ID must be the corresponding
1829a4f9608SHajimu UMEMOTO 			 * interface index by definition.
1839a4f9608SHajimu UMEMOTO 			 */
1849a4f9608SHajimu UMEMOTO 			if (i == IPV6_ADDR_SCOPE_INTFACELOCAL &&
1859a4f9608SHajimu UMEMOTO 			    idlist->s6id_list[i] != ifp->if_index) {
1865cf7ec13SAndrey V. Elsukov 				IF_AFDATA_WUNLOCK(ifp);
1879a4f9608SHajimu UMEMOTO 				return (EINVAL);
1889a4f9608SHajimu UMEMOTO 			}
1899a4f9608SHajimu UMEMOTO 
190686cdd19SJun-ichiro itojun Hagino 			if (i == IPV6_ADDR_SCOPE_LINKLOCAL &&
191603724d3SBjoern A. Zeeb 			    idlist->s6id_list[i] > V_if_index) {
192686cdd19SJun-ichiro itojun Hagino 				/*
193686cdd19SJun-ichiro itojun Hagino 				 * XXX: theoretically, there should be no
194686cdd19SJun-ichiro itojun Hagino 				 * relationship between link IDs and interface
195686cdd19SJun-ichiro itojun Hagino 				 * IDs, but we check the consistency for
196686cdd19SJun-ichiro itojun Hagino 				 * safety in later use.
197686cdd19SJun-ichiro itojun Hagino 				 */
1985cf7ec13SAndrey V. Elsukov 				IF_AFDATA_WUNLOCK(ifp);
199686cdd19SJun-ichiro itojun Hagino 				return (EINVAL);
200686cdd19SJun-ichiro itojun Hagino 			}
201686cdd19SJun-ichiro itojun Hagino 
202686cdd19SJun-ichiro itojun Hagino 			/*
203686cdd19SJun-ichiro itojun Hagino 			 * XXX: we must need lots of work in this case,
204686cdd19SJun-ichiro itojun Hagino 			 * but we simply set the new value in this initial
205686cdd19SJun-ichiro itojun Hagino 			 * implementation.
206686cdd19SJun-ichiro itojun Hagino 			 */
20731b1bfe1SHajimu UMEMOTO 			sid->s6id_list[i] = idlist->s6id_list[i];
208686cdd19SJun-ichiro itojun Hagino 		}
209686cdd19SJun-ichiro itojun Hagino 	}
2105cf7ec13SAndrey V. Elsukov 	IF_AFDATA_WUNLOCK(ifp);
211686cdd19SJun-ichiro itojun Hagino 
212686cdd19SJun-ichiro itojun Hagino 	return (error);
213686cdd19SJun-ichiro itojun Hagino }
214686cdd19SJun-ichiro itojun Hagino 
2155fc26322SMark Johnston static int
2161272577eSXin LI scope6_get(struct ifnet *ifp, struct scope6_id *idlist)
217686cdd19SJun-ichiro itojun Hagino {
2185cf7ec13SAndrey V. Elsukov 	struct scope6_id *sid;
21931b1bfe1SHajimu UMEMOTO 
2205cf7ec13SAndrey V. Elsukov 	/* We only need to lock the interface's afdata for SID() to work. */
2215cf7ec13SAndrey V. Elsukov 	IF_AFDATA_RLOCK(ifp);
2225cf7ec13SAndrey V. Elsukov 	sid = SID(ifp);
223026e67b6SGeorge V. Neville-Neil 	if (sid == NULL) {	/* paranoid? */
2245cf7ec13SAndrey V. Elsukov 		IF_AFDATA_RUNLOCK(ifp);
225686cdd19SJun-ichiro itojun Hagino 		return (EINVAL);
226026e67b6SGeorge V. Neville-Neil 	}
227686cdd19SJun-ichiro itojun Hagino 
22831b1bfe1SHajimu UMEMOTO 	*idlist = *sid;
229686cdd19SJun-ichiro itojun Hagino 
2305cf7ec13SAndrey V. Elsukov 	IF_AFDATA_RUNLOCK(ifp);
231686cdd19SJun-ichiro itojun Hagino 	return (0);
232686cdd19SJun-ichiro itojun Hagino }
233686cdd19SJun-ichiro itojun Hagino 
234686cdd19SJun-ichiro itojun Hagino /*
235686cdd19SJun-ichiro itojun Hagino  * Get a scope of the address. Node-local, link-local, site-local or global.
236686cdd19SJun-ichiro itojun Hagino  */
237686cdd19SJun-ichiro itojun Hagino int
238573791d0SAndrey V. Elsukov in6_addrscope(const struct in6_addr *addr)
239686cdd19SJun-ichiro itojun Hagino {
240686cdd19SJun-ichiro itojun Hagino 
241573791d0SAndrey V. Elsukov 	if (IN6_IS_ADDR_MULTICAST(addr)) {
242686cdd19SJun-ichiro itojun Hagino 		/*
243573791d0SAndrey V. Elsukov 		 * Addresses with reserved value F must be treated as
244573791d0SAndrey V. Elsukov 		 * global multicast addresses.
245686cdd19SJun-ichiro itojun Hagino 		 */
246573791d0SAndrey V. Elsukov 		if (IPV6_ADDR_MC_SCOPE(addr) == 0x0f)
247573791d0SAndrey V. Elsukov 			return (IPV6_ADDR_SCOPE_GLOBAL);
248573791d0SAndrey V. Elsukov 		return (IPV6_ADDR_MC_SCOPE(addr));
249686cdd19SJun-ichiro itojun Hagino 	}
250573791d0SAndrey V. Elsukov 	if (IN6_IS_ADDR_LINKLOCAL(addr) ||
251573791d0SAndrey V. Elsukov 	    IN6_IS_ADDR_LOOPBACK(addr))
252573791d0SAndrey V. Elsukov 		return (IPV6_ADDR_SCOPE_LINKLOCAL);
253573791d0SAndrey V. Elsukov 	if (IN6_IS_ADDR_SITELOCAL(addr))
254573791d0SAndrey V. Elsukov 		return (IPV6_ADDR_SCOPE_SITELOCAL);
255573791d0SAndrey V. Elsukov 	return (IPV6_ADDR_SCOPE_GLOBAL);
256686cdd19SJun-ichiro itojun Hagino }
257686cdd19SJun-ichiro itojun Hagino 
2581272577eSXin LI /*
2591272577eSXin LI  * ifp - note that this might be NULL
2601272577eSXin LI  */
2611272577eSXin LI 
262686cdd19SJun-ichiro itojun Hagino void
2631272577eSXin LI scope6_setdefault(struct ifnet *ifp)
264686cdd19SJun-ichiro itojun Hagino {
2658b615593SMarko Zec 
266686cdd19SJun-ichiro itojun Hagino 	/*
267026e67b6SGeorge V. Neville-Neil 	 * Currently, this function just sets the default "interfaces"
26831b1bfe1SHajimu UMEMOTO 	 * and "links" according to the given interface.
269686cdd19SJun-ichiro itojun Hagino 	 * We might eventually have to separate the notion of "link" from
270686cdd19SJun-ichiro itojun Hagino 	 * "interface" and provide a user interface to set the default.
271686cdd19SJun-ichiro itojun Hagino 	 */
2721ab976cbSHajimu UMEMOTO 	SCOPE6_LOCK();
273686cdd19SJun-ichiro itojun Hagino 	if (ifp) {
274603724d3SBjoern A. Zeeb 		V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] =
27531b1bfe1SHajimu UMEMOTO 			ifp->if_index;
276603724d3SBjoern A. Zeeb 		V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] =
277686cdd19SJun-ichiro itojun Hagino 			ifp->if_index;
27807eb2995SHajimu UMEMOTO 	} else {
279603724d3SBjoern A. Zeeb 		V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = 0;
280603724d3SBjoern A. Zeeb 		V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = 0;
281686cdd19SJun-ichiro itojun Hagino 	}
2821ab976cbSHajimu UMEMOTO 	SCOPE6_UNLOCK();
28307eb2995SHajimu UMEMOTO }
284686cdd19SJun-ichiro itojun Hagino 
285686cdd19SJun-ichiro itojun Hagino int
2861272577eSXin LI scope6_get_default(struct scope6_id *idlist)
287686cdd19SJun-ichiro itojun Hagino {
2881ab976cbSHajimu UMEMOTO 
2891ab976cbSHajimu UMEMOTO 	SCOPE6_LOCK();
290603724d3SBjoern A. Zeeb 	*idlist = V_sid_default;
2911ab976cbSHajimu UMEMOTO 	SCOPE6_UNLOCK();
292686cdd19SJun-ichiro itojun Hagino 
293686cdd19SJun-ichiro itojun Hagino 	return (0);
294686cdd19SJun-ichiro itojun Hagino }
295686cdd19SJun-ichiro itojun Hagino 
296686cdd19SJun-ichiro itojun Hagino u_int32_t
2971272577eSXin LI scope6_addr2default(struct in6_addr *addr)
298686cdd19SJun-ichiro itojun Hagino {
2991ab976cbSHajimu UMEMOTO 	u_int32_t id;
3001ab976cbSHajimu UMEMOTO 
30131b1bfe1SHajimu UMEMOTO 	/*
30231b1bfe1SHajimu UMEMOTO 	 * special case: The loopback address should be considered as
30331b1bfe1SHajimu UMEMOTO 	 * link-local, but there's no ambiguity in the syntax.
30431b1bfe1SHajimu UMEMOTO 	 */
30531b1bfe1SHajimu UMEMOTO 	if (IN6_IS_ADDR_LOOPBACK(addr))
30631b1bfe1SHajimu UMEMOTO 		return (0);
30731b1bfe1SHajimu UMEMOTO 
3081ab976cbSHajimu UMEMOTO 	/*
3091ab976cbSHajimu UMEMOTO 	 * XXX: 32-bit read is atomic on all our platforms, is it OK
3101ab976cbSHajimu UMEMOTO 	 * not to lock here?
3111ab976cbSHajimu UMEMOTO 	 */
3121ab976cbSHajimu UMEMOTO 	SCOPE6_LOCK();
313603724d3SBjoern A. Zeeb 	id = V_sid_default.s6id_list[in6_addrscope(addr)];
3141ab976cbSHajimu UMEMOTO 	SCOPE6_UNLOCK();
3151ab976cbSHajimu UMEMOTO 	return (id);
316686cdd19SJun-ichiro itojun Hagino }
317a1f7e5f8SHajimu UMEMOTO 
318a1f7e5f8SHajimu UMEMOTO /*
319a1f7e5f8SHajimu UMEMOTO  * Validate the specified scope zone ID in the sin6_scope_id field.  If the ID
320a1f7e5f8SHajimu UMEMOTO  * is unspecified (=0), needs to be specified, and the default zone ID can be
321a1f7e5f8SHajimu UMEMOTO  * used, the default value will be used.
322a1f7e5f8SHajimu UMEMOTO  * This routine then generates the kernel-internal form: if the address scope
323a1f7e5f8SHajimu UMEMOTO  * of is interface-local or link-local, embed the interface index in the
324a1f7e5f8SHajimu UMEMOTO  * address.
325a1f7e5f8SHajimu UMEMOTO  */
326a1f7e5f8SHajimu UMEMOTO int
3271272577eSXin LI sa6_embedscope(struct sockaddr_in6 *sin6, int defaultok)
328a1f7e5f8SHajimu UMEMOTO {
329a1f7e5f8SHajimu UMEMOTO 	u_int32_t zoneid;
330a1f7e5f8SHajimu UMEMOTO 
331a1f7e5f8SHajimu UMEMOTO 	if ((zoneid = sin6->sin6_scope_id) == 0 && defaultok)
332a1f7e5f8SHajimu UMEMOTO 		zoneid = scope6_addr2default(&sin6->sin6_addr);
333a1f7e5f8SHajimu UMEMOTO 
334a1f7e5f8SHajimu UMEMOTO 	if (zoneid != 0 &&
335a1f7e5f8SHajimu UMEMOTO 	    (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
336a1f7e5f8SHajimu UMEMOTO 	    IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr))) {
337a1f7e5f8SHajimu UMEMOTO 		/*
338a1f7e5f8SHajimu UMEMOTO 		 * At this moment, we only check interface-local and
339a1f7e5f8SHajimu UMEMOTO 		 * link-local scope IDs, and use interface indices as the
340a1f7e5f8SHajimu UMEMOTO 		 * zone IDs assuming a one-to-one mapping between interfaces
341a1f7e5f8SHajimu UMEMOTO 		 * and links.
342a1f7e5f8SHajimu UMEMOTO 		 */
3436e9a5a5eSAndrey V. Elsukov 		if (V_if_index < zoneid || ifnet_byindex(zoneid) == NULL)
344a1f7e5f8SHajimu UMEMOTO 			return (ENXIO);
345a1f7e5f8SHajimu UMEMOTO 
346a1f7e5f8SHajimu UMEMOTO 		/* XXX assignment to 16bit from 32bit variable */
347a1f7e5f8SHajimu UMEMOTO 		sin6->sin6_addr.s6_addr16[1] = htons(zoneid & 0xffff);
348a1f7e5f8SHajimu UMEMOTO 		sin6->sin6_scope_id = 0;
349a1f7e5f8SHajimu UMEMOTO 	}
350a1f7e5f8SHajimu UMEMOTO 
351a1f7e5f8SHajimu UMEMOTO 	return 0;
352a1f7e5f8SHajimu UMEMOTO }
353a1f7e5f8SHajimu UMEMOTO 
354a1f7e5f8SHajimu UMEMOTO /*
355a1f7e5f8SHajimu UMEMOTO  * generate standard sockaddr_in6 from embedded form.
356a1f7e5f8SHajimu UMEMOTO  */
357a1f7e5f8SHajimu UMEMOTO int
3581272577eSXin LI sa6_recoverscope(struct sockaddr_in6 *sin6)
359a1f7e5f8SHajimu UMEMOTO {
3601d54aa3bSBjoern A. Zeeb 	char ip6buf[INET6_ADDRSTRLEN];
361a1f7e5f8SHajimu UMEMOTO 	u_int32_t zoneid;
362a1f7e5f8SHajimu UMEMOTO 
363a1f7e5f8SHajimu UMEMOTO 	if (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
364a1f7e5f8SHajimu UMEMOTO 	    IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr)) {
365a1f7e5f8SHajimu UMEMOTO 		/*
366a1f7e5f8SHajimu UMEMOTO 		 * KAME assumption: link id == interface id
367a1f7e5f8SHajimu UMEMOTO 		 */
368a1f7e5f8SHajimu UMEMOTO 		zoneid = ntohs(sin6->sin6_addr.s6_addr16[1]);
369a1f7e5f8SHajimu UMEMOTO 		if (zoneid) {
370a1f7e5f8SHajimu UMEMOTO 			/* sanity check */
371f0624013SAndrey V. Elsukov 			if (V_if_index < zoneid)
372a1f7e5f8SHajimu UMEMOTO 				return (ENXIO);
3730bebb544SHiroki Sato #if 0
3740bebb544SHiroki Sato 			/* XXX: Disabled due to possible deadlock. */
375a1f7e5f8SHajimu UMEMOTO 			if (!ifnet_byindex(zoneid))
376a1f7e5f8SHajimu UMEMOTO 				return (ENXIO);
3770bebb544SHiroki Sato #endif
3783829d135SHiroki Sato 			if (sin6->sin6_scope_id != 0 &&
3793829d135SHiroki Sato 			    zoneid != sin6->sin6_scope_id) {
3803829d135SHiroki Sato 				log(LOG_NOTICE,
3813829d135SHiroki Sato 				    "%s: embedded scope mismatch: %s%%%d. "
3823829d135SHiroki Sato 				    "sin6_scope_id was overridden.", __func__,
3833829d135SHiroki Sato 				    ip6_sprintf(ip6buf, &sin6->sin6_addr),
3843829d135SHiroki Sato 				    sin6->sin6_scope_id);
3853829d135SHiroki Sato 			}
386a1f7e5f8SHajimu UMEMOTO 			sin6->sin6_addr.s6_addr16[1] = 0;
387a1f7e5f8SHajimu UMEMOTO 			sin6->sin6_scope_id = zoneid;
388a1f7e5f8SHajimu UMEMOTO 		}
389a1f7e5f8SHajimu UMEMOTO 	}
390a1f7e5f8SHajimu UMEMOTO 
391a1f7e5f8SHajimu UMEMOTO 	return 0;
392a1f7e5f8SHajimu UMEMOTO }
393a1f7e5f8SHajimu UMEMOTO 
394a1f7e5f8SHajimu UMEMOTO /*
395a1f7e5f8SHajimu UMEMOTO  * Determine the appropriate scope zone ID for in6 and ifp.  If ret_id is
396a1f7e5f8SHajimu UMEMOTO  * non NULL, it is set to the zone ID.  If the zone ID needs to be embedded
397a1f7e5f8SHajimu UMEMOTO  * in the in6_addr structure, in6 will be modified.
3981272577eSXin LI  *
3991272577eSXin LI  * ret_id - unnecessary?
400a1f7e5f8SHajimu UMEMOTO  */
401a1f7e5f8SHajimu UMEMOTO int
4021272577eSXin LI in6_setscope(struct in6_addr *in6, struct ifnet *ifp, u_int32_t *ret_id)
403a1f7e5f8SHajimu UMEMOTO {
404a1f7e5f8SHajimu UMEMOTO 	int scope;
405a1f7e5f8SHajimu UMEMOTO 	u_int32_t zoneid = 0;
406a7734b4bSHajimu UMEMOTO 	struct scope6_id *sid;
407a7734b4bSHajimu UMEMOTO 
40878c235c9SAndrey V. Elsukov 	/*
40978c235c9SAndrey V. Elsukov 	 * special case: the loopback address can only belong to a loopback
41078c235c9SAndrey V. Elsukov 	 * interface.
41178c235c9SAndrey V. Elsukov 	 */
41278c235c9SAndrey V. Elsukov 	if (IN6_IS_ADDR_LOOPBACK(in6)) {
4133ea87cb5SAndrey V. Elsukov 		if (!(ifp->if_flags & IFF_LOOPBACK))
41478c235c9SAndrey V. Elsukov 			return (EINVAL);
41578c235c9SAndrey V. Elsukov 	} else {
416a1f7e5f8SHajimu UMEMOTO 		scope = in6_addrscope(in6);
4173ea87cb5SAndrey V. Elsukov 		if (scope == IPV6_ADDR_SCOPE_INTFACELOCAL ||
4183ea87cb5SAndrey V. Elsukov 		    scope == IPV6_ADDR_SCOPE_LINKLOCAL) {
4193ea87cb5SAndrey V. Elsukov 			/*
4203ea87cb5SAndrey V. Elsukov 			 * Currently we use interface indeces as the
4213ea87cb5SAndrey V. Elsukov 			 * zone IDs for interface-local and link-local
4223ea87cb5SAndrey V. Elsukov 			 * scopes.
4233ea87cb5SAndrey V. Elsukov 			 */
4243ea87cb5SAndrey V. Elsukov 			zoneid = ifp->if_index;
4253ea87cb5SAndrey V. Elsukov 			in6->s6_addr16[1] = htons(zoneid & 0xffff); /* XXX */
4263ea87cb5SAndrey V. Elsukov 		} else if (scope != IPV6_ADDR_SCOPE_GLOBAL) {
4273ea87cb5SAndrey V. Elsukov 			IF_AFDATA_RLOCK(ifp);
4283ea87cb5SAndrey V. Elsukov 			sid = SID(ifp);
4293ea87cb5SAndrey V. Elsukov 			zoneid = sid->s6id_list[scope];
4305cf7ec13SAndrey V. Elsukov 			IF_AFDATA_RUNLOCK(ifp);
4313ea87cb5SAndrey V. Elsukov 		}
4323ea87cb5SAndrey V. Elsukov 	}
433a1f7e5f8SHajimu UMEMOTO 
434a1f7e5f8SHajimu UMEMOTO 	if (ret_id != NULL)
435a1f7e5f8SHajimu UMEMOTO 		*ret_id = zoneid;
436a1f7e5f8SHajimu UMEMOTO 
437a1f7e5f8SHajimu UMEMOTO 	return (0);
438a1f7e5f8SHajimu UMEMOTO }
439a1f7e5f8SHajimu UMEMOTO 
440a1f7e5f8SHajimu UMEMOTO /*
441a1f7e5f8SHajimu UMEMOTO  * Just clear the embedded scope identifier.  Return 0 if the original address
442a1f7e5f8SHajimu UMEMOTO  * is intact; return non 0 if the address is modified.
443a1f7e5f8SHajimu UMEMOTO  */
444a1f7e5f8SHajimu UMEMOTO int
4451272577eSXin LI in6_clearscope(struct in6_addr *in6)
446a1f7e5f8SHajimu UMEMOTO {
447a1f7e5f8SHajimu UMEMOTO 	int modified = 0;
448a1f7e5f8SHajimu UMEMOTO 
449a1f7e5f8SHajimu UMEMOTO 	if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) {
450a1f7e5f8SHajimu UMEMOTO 		if (in6->s6_addr16[1] != 0)
451a1f7e5f8SHajimu UMEMOTO 			modified = 1;
452a1f7e5f8SHajimu UMEMOTO 		in6->s6_addr16[1] = 0;
453a1f7e5f8SHajimu UMEMOTO 	}
454a1f7e5f8SHajimu UMEMOTO 
455a1f7e5f8SHajimu UMEMOTO 	return (modified);
456a1f7e5f8SHajimu UMEMOTO }
4570edc703aSBjoern A. Zeeb 
4580edc703aSBjoern A. Zeeb /*
4590edc703aSBjoern A. Zeeb  * Return the scope identifier or zero.
4600edc703aSBjoern A. Zeeb  */
4610edc703aSBjoern A. Zeeb uint16_t
4620edc703aSBjoern A. Zeeb in6_getscope(struct in6_addr *in6)
4630edc703aSBjoern A. Zeeb {
4640edc703aSBjoern A. Zeeb 
4650edc703aSBjoern A. Zeeb 	if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6))
4660edc703aSBjoern A. Zeeb 		return (in6->s6_addr16[1]);
4670edc703aSBjoern A. Zeeb 
4680edc703aSBjoern A. Zeeb 	return (0);
4690edc703aSBjoern A. Zeeb }
470*41874e85SAndrey V. Elsukov 
471*41874e85SAndrey V. Elsukov /*
472*41874e85SAndrey V. Elsukov  * Return pointer to ifnet structure, corresponding to the zone id of
473*41874e85SAndrey V. Elsukov  * link-local scope.
474*41874e85SAndrey V. Elsukov  */
475*41874e85SAndrey V. Elsukov struct ifnet*
476*41874e85SAndrey V. Elsukov in6_getlinkifnet(uint32_t zoneid)
477*41874e85SAndrey V. Elsukov {
478*41874e85SAndrey V. Elsukov 
479*41874e85SAndrey V. Elsukov 	return (ifnet_byindex((u_short)zoneid));
480*41874e85SAndrey V. Elsukov }
481*41874e85SAndrey V. Elsukov 
482*41874e85SAndrey V. Elsukov /*
483*41874e85SAndrey V. Elsukov  * Return zone id for the specified scope.
484*41874e85SAndrey V. Elsukov  */
485*41874e85SAndrey V. Elsukov uint32_t
486*41874e85SAndrey V. Elsukov in6_getscopezone(const struct ifnet *ifp, int scope)
487*41874e85SAndrey V. Elsukov {
488*41874e85SAndrey V. Elsukov 
489*41874e85SAndrey V. Elsukov 	if (scope == IPV6_ADDR_SCOPE_INTFACELOCAL ||
490*41874e85SAndrey V. Elsukov 	    scope == IPV6_ADDR_SCOPE_LINKLOCAL)
491*41874e85SAndrey V. Elsukov 		return (ifp->if_index);
492*41874e85SAndrey V. Elsukov 	if (scope >= 0 && scope < IPV6_ADDR_SCOPES_COUNT)
493*41874e85SAndrey V. Elsukov 		return (SID(ifp)->s6id_list[scope]);
494*41874e85SAndrey V. Elsukov 	return (0);
495*41874e85SAndrey V. Elsukov }
496*41874e85SAndrey V. Elsukov 
497*41874e85SAndrey V. Elsukov /*
498*41874e85SAndrey V. Elsukov  * This function is for checking sockaddr_in6 structure passed
499*41874e85SAndrey V. Elsukov  * from the application level (usually).
500*41874e85SAndrey V. Elsukov  *
501*41874e85SAndrey V. Elsukov  * sin6_scope_id should be set for link-local unicast, link-local and
502*41874e85SAndrey V. Elsukov  * interface-local  multicast addresses.
503*41874e85SAndrey V. Elsukov  *
504*41874e85SAndrey V. Elsukov  * If it is zero, then look into default zone ids. If default zone id is
505*41874e85SAndrey V. Elsukov  * not set or disabled, then return error.
506*41874e85SAndrey V. Elsukov  */
507*41874e85SAndrey V. Elsukov int
508*41874e85SAndrey V. Elsukov sa6_checkzone(struct sockaddr_in6 *sa6)
509*41874e85SAndrey V. Elsukov {
510*41874e85SAndrey V. Elsukov 	int scope;
511*41874e85SAndrey V. Elsukov 
512*41874e85SAndrey V. Elsukov 	scope = in6_addrscope(&sa6->sin6_addr);
513*41874e85SAndrey V. Elsukov 	if (scope == IPV6_ADDR_SCOPE_GLOBAL)
514*41874e85SAndrey V. Elsukov 		return (sa6->sin6_scope_id ? EINVAL: 0);
515*41874e85SAndrey V. Elsukov 	if (IN6_IS_ADDR_MULTICAST(&sa6->sin6_addr) &&
516*41874e85SAndrey V. Elsukov 	    scope != IPV6_ADDR_SCOPE_LINKLOCAL &&
517*41874e85SAndrey V. Elsukov 	    scope != IPV6_ADDR_SCOPE_INTFACELOCAL) {
518*41874e85SAndrey V. Elsukov 		if (sa6->sin6_scope_id == 0 && V_ip6_use_defzone != 0)
519*41874e85SAndrey V. Elsukov 			sa6->sin6_scope_id = V_sid_default.s6id_list[scope];
520*41874e85SAndrey V. Elsukov 		return (0);
521*41874e85SAndrey V. Elsukov 	}
522*41874e85SAndrey V. Elsukov 	/*
523*41874e85SAndrey V. Elsukov 	 * Since ::1 address always configured on the lo0, we can
524*41874e85SAndrey V. Elsukov 	 * automatically set its zone id, when it is not specified.
525*41874e85SAndrey V. Elsukov 	 * Return error, when specified zone id doesn't match with
526*41874e85SAndrey V. Elsukov 	 * actual value.
527*41874e85SAndrey V. Elsukov 	 */
528*41874e85SAndrey V. Elsukov 	if (IN6_IS_ADDR_LOOPBACK(&sa6->sin6_addr)) {
529*41874e85SAndrey V. Elsukov 		if (sa6->sin6_scope_id == 0)
530*41874e85SAndrey V. Elsukov 			sa6->sin6_scope_id = in6_getscopezone(V_loif, scope);
531*41874e85SAndrey V. Elsukov 		else if (sa6->sin6_scope_id != in6_getscopezone(V_loif, scope))
532*41874e85SAndrey V. Elsukov 			return (EADDRNOTAVAIL);
533*41874e85SAndrey V. Elsukov 	}
534*41874e85SAndrey V. Elsukov 	/* XXX: we can validate sin6_scope_id here */
535*41874e85SAndrey V. Elsukov 	if (sa6->sin6_scope_id != 0)
536*41874e85SAndrey V. Elsukov 		return (0);
537*41874e85SAndrey V. Elsukov 	if (V_ip6_use_defzone != 0)
538*41874e85SAndrey V. Elsukov 		sa6->sin6_scope_id = V_sid_default.s6id_list[scope];
539*41874e85SAndrey V. Elsukov 	/* Return error if we can't determine zone id */
540*41874e85SAndrey V. Elsukov 	return (sa6->sin6_scope_id ? 0: EADDRNOTAVAIL);
541*41874e85SAndrey V. Elsukov }
542*41874e85SAndrey V. Elsukov 
543*41874e85SAndrey V. Elsukov 
544