scope6.c revision 1.23 1 1.23 maxv /* $NetBSD: scope6.c,v 1.23 2020/06/16 17:12:18 maxv Exp $ */
2 1.1 rpaulo /* $KAME$ */
3 1.1 rpaulo
4 1.19 maxv /*
5 1.1 rpaulo * Copyright (C) 2000 WIDE Project.
6 1.1 rpaulo * All rights reserved.
7 1.1 rpaulo *
8 1.1 rpaulo * Redistribution and use in source and binary forms, with or without
9 1.1 rpaulo * modification, are permitted provided that the following conditions
10 1.1 rpaulo * are met:
11 1.1 rpaulo * 1. Redistributions of source code must retain the above copyright
12 1.1 rpaulo * notice, this list of conditions and the following disclaimer.
13 1.1 rpaulo * 2. Redistributions in binary form must reproduce the above copyright
14 1.1 rpaulo * notice, this list of conditions and the following disclaimer in the
15 1.1 rpaulo * documentation and/or other materials provided with the distribution.
16 1.1 rpaulo * 3. Neither the name of the project nor the names of its contributors
17 1.1 rpaulo * may be used to endorse or promote products derived from this software
18 1.1 rpaulo * without specific prior written permission.
19 1.1 rpaulo *
20 1.1 rpaulo * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 1.1 rpaulo * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 1.1 rpaulo * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 1.1 rpaulo * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 1.1 rpaulo * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 1.1 rpaulo * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 1.1 rpaulo * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 1.1 rpaulo * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 1.1 rpaulo * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 1.1 rpaulo * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 1.1 rpaulo * SUCH DAMAGE.
31 1.1 rpaulo */
32 1.1 rpaulo
33 1.6 lukem #include <sys/cdefs.h>
34 1.23 maxv __KERNEL_RCSID(0, "$NetBSD: scope6.c,v 1.23 2020/06/16 17:12:18 maxv Exp $");
35 1.6 lukem
36 1.1 rpaulo #include <sys/param.h>
37 1.1 rpaulo #include <sys/malloc.h>
38 1.1 rpaulo #include <sys/mbuf.h>
39 1.1 rpaulo #include <sys/socket.h>
40 1.1 rpaulo #include <sys/systm.h>
41 1.1 rpaulo #include <sys/queue.h>
42 1.1 rpaulo #include <sys/syslog.h>
43 1.1 rpaulo
44 1.1 rpaulo #include <net/if.h>
45 1.1 rpaulo
46 1.1 rpaulo #include <netinet/in.h>
47 1.1 rpaulo
48 1.1 rpaulo #include <netinet6/in6_var.h>
49 1.1 rpaulo #include <netinet6/scope6_var.h>
50 1.1 rpaulo
51 1.1 rpaulo #ifdef ENABLE_DEFAULT_SCOPE
52 1.1 rpaulo int ip6_use_defzone = 1;
53 1.1 rpaulo #else
54 1.1 rpaulo int ip6_use_defzone = 0;
55 1.1 rpaulo #endif
56 1.1 rpaulo
57 1.1 rpaulo static struct scope6_id sid_default;
58 1.1 rpaulo #define SID(ifp) \
59 1.15 christos ((ifp)->if_afdata[AF_INET6] == NULL ? NULL : \
60 1.15 christos ((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->scope6_id)
61 1.1 rpaulo
62 1.1 rpaulo void
63 1.7 cegger scope6_init(void)
64 1.1 rpaulo {
65 1.1 rpaulo
66 1.2 rpaulo memset(&sid_default, 0, sizeof(sid_default));
67 1.1 rpaulo }
68 1.1 rpaulo
69 1.1 rpaulo struct scope6_id *
70 1.1 rpaulo scope6_ifattach(struct ifnet *ifp)
71 1.1 rpaulo {
72 1.1 rpaulo struct scope6_id *sid;
73 1.1 rpaulo
74 1.19 maxv sid = malloc(sizeof(*sid), M_IFADDR, M_WAITOK | M_ZERO);
75 1.1 rpaulo
76 1.1 rpaulo /*
77 1.1 rpaulo * XXX: IPV6_ADDR_SCOPE_xxx macros are not standard.
78 1.1 rpaulo * Should we rather hardcode here?
79 1.1 rpaulo */
80 1.1 rpaulo sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = ifp->if_index;
81 1.1 rpaulo sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = ifp->if_index;
82 1.1 rpaulo #ifdef MULTI_SCOPE
83 1.1 rpaulo /* by default, we don't care about scope boundary for these scopes. */
84 1.1 rpaulo sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL] = 1;
85 1.1 rpaulo sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL] = 1;
86 1.1 rpaulo #endif
87 1.1 rpaulo
88 1.1 rpaulo return sid;
89 1.1 rpaulo }
90 1.1 rpaulo
91 1.1 rpaulo void
92 1.1 rpaulo scope6_ifdetach(struct scope6_id *sid)
93 1.1 rpaulo {
94 1.1 rpaulo
95 1.1 rpaulo free(sid, M_IFADDR);
96 1.1 rpaulo }
97 1.1 rpaulo
98 1.1 rpaulo /*
99 1.1 rpaulo * Get a scope of the address. Interface-local, link-local, site-local
100 1.1 rpaulo * or global.
101 1.1 rpaulo */
102 1.1 rpaulo int
103 1.5 dyoung in6_addrscope(const struct in6_addr *addr)
104 1.1 rpaulo {
105 1.1 rpaulo int scope;
106 1.1 rpaulo
107 1.1 rpaulo if (addr->s6_addr[0] == 0xfe) {
108 1.1 rpaulo scope = addr->s6_addr[1] & 0xc0;
109 1.1 rpaulo
110 1.1 rpaulo switch (scope) {
111 1.1 rpaulo case 0x80:
112 1.1 rpaulo return IPV6_ADDR_SCOPE_LINKLOCAL;
113 1.1 rpaulo case 0xc0:
114 1.1 rpaulo return IPV6_ADDR_SCOPE_SITELOCAL;
115 1.1 rpaulo default:
116 1.1 rpaulo return IPV6_ADDR_SCOPE_GLOBAL; /* just in case */
117 1.1 rpaulo }
118 1.1 rpaulo }
119 1.1 rpaulo
120 1.1 rpaulo if (addr->s6_addr[0] == 0xff) {
121 1.1 rpaulo scope = addr->s6_addr[1] & 0x0f;
122 1.1 rpaulo
123 1.1 rpaulo /*
124 1.1 rpaulo * due to other scope such as reserved,
125 1.1 rpaulo * return scope doesn't work.
126 1.1 rpaulo */
127 1.1 rpaulo switch (scope) {
128 1.1 rpaulo case IPV6_ADDR_SCOPE_INTFACELOCAL:
129 1.1 rpaulo return IPV6_ADDR_SCOPE_INTFACELOCAL;
130 1.1 rpaulo case IPV6_ADDR_SCOPE_LINKLOCAL:
131 1.1 rpaulo return IPV6_ADDR_SCOPE_LINKLOCAL;
132 1.1 rpaulo case IPV6_ADDR_SCOPE_SITELOCAL:
133 1.1 rpaulo return IPV6_ADDR_SCOPE_SITELOCAL;
134 1.1 rpaulo default:
135 1.1 rpaulo return IPV6_ADDR_SCOPE_GLOBAL;
136 1.1 rpaulo }
137 1.1 rpaulo }
138 1.1 rpaulo
139 1.5 dyoung if (memcmp(&in6addr_loopback, addr, sizeof(*addr) - 1) == 0) {
140 1.1 rpaulo if (addr->s6_addr[15] == 1) /* loopback */
141 1.1 rpaulo return IPV6_ADDR_SCOPE_LINKLOCAL;
142 1.1 rpaulo if (addr->s6_addr[15] == 0) {
143 1.1 rpaulo /*
144 1.1 rpaulo * Regard the unspecified addresses as global,
145 1.1 rpaulo * since it has no ambiguity.
146 1.1 rpaulo * XXX: not sure if it's correct...
147 1.1 rpaulo */
148 1.1 rpaulo return IPV6_ADDR_SCOPE_GLOBAL;
149 1.1 rpaulo }
150 1.1 rpaulo }
151 1.1 rpaulo
152 1.1 rpaulo return IPV6_ADDR_SCOPE_GLOBAL;
153 1.1 rpaulo }
154 1.1 rpaulo
155 1.1 rpaulo uint32_t
156 1.5 dyoung scope6_addr2default(const struct in6_addr *addr)
157 1.1 rpaulo {
158 1.1 rpaulo uint32_t id;
159 1.1 rpaulo
160 1.1 rpaulo /*
161 1.1 rpaulo * special case: The loopback address should be considered as
162 1.1 rpaulo * link-local, but there's no ambiguity in the syntax.
163 1.1 rpaulo */
164 1.1 rpaulo if (IN6_IS_ADDR_LOOPBACK(addr))
165 1.19 maxv return 0;
166 1.1 rpaulo
167 1.1 rpaulo /*
168 1.1 rpaulo * XXX: 32-bit read is atomic on all our platforms, is it OK
169 1.1 rpaulo * not to lock here?
170 1.1 rpaulo */
171 1.1 rpaulo id = sid_default.s6id_list[in6_addrscope(addr)];
172 1.1 rpaulo
173 1.19 maxv return id;
174 1.1 rpaulo }
175 1.1 rpaulo
176 1.1 rpaulo /*
177 1.1 rpaulo * Validate the specified scope zone ID in the sin6_scope_id field. If the ID
178 1.1 rpaulo * is unspecified (=0), needs to be specified, and the default zone ID can be
179 1.1 rpaulo * used, the default value will be used.
180 1.1 rpaulo * This routine then generates the kernel-internal form: if the address scope
181 1.1 rpaulo * of is interface-local or link-local, embed the interface index in the
182 1.1 rpaulo * address.
183 1.1 rpaulo */
184 1.1 rpaulo int
185 1.1 rpaulo sa6_embedscope(struct sockaddr_in6 *sin6, int defaultok)
186 1.1 rpaulo {
187 1.1 rpaulo struct ifnet *ifp;
188 1.1 rpaulo uint32_t zoneid;
189 1.1 rpaulo
190 1.1 rpaulo if ((zoneid = sin6->sin6_scope_id) == 0 && defaultok)
191 1.1 rpaulo zoneid = scope6_addr2default(&sin6->sin6_addr);
192 1.1 rpaulo
193 1.1 rpaulo if (zoneid != 0 &&
194 1.1 rpaulo (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
195 1.1 rpaulo IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr))) {
196 1.14 ozaki int s;
197 1.1 rpaulo /*
198 1.1 rpaulo * At this moment, we only check interface-local and
199 1.1 rpaulo * link-local scope IDs, and use interface indices as the
200 1.1 rpaulo * zone IDs assuming a one-to-one mapping between interfaces
201 1.1 rpaulo * and links.
202 1.1 rpaulo */
203 1.14 ozaki s = pserialize_read_enter();
204 1.9 rmind ifp = if_byindex(zoneid);
205 1.14 ozaki if (ifp == NULL) {
206 1.14 ozaki pserialize_read_exit(s);
207 1.19 maxv return ENXIO;
208 1.14 ozaki }
209 1.14 ozaki pserialize_read_exit(s);
210 1.1 rpaulo
211 1.1 rpaulo /* XXX assignment to 16bit from 32bit variable */
212 1.1 rpaulo sin6->sin6_addr.s6_addr16[1] = htons(zoneid & 0xffff);
213 1.1 rpaulo
214 1.1 rpaulo sin6->sin6_scope_id = 0;
215 1.1 rpaulo }
216 1.1 rpaulo
217 1.1 rpaulo return 0;
218 1.1 rpaulo }
219 1.1 rpaulo
220 1.8 dyoung struct sockaddr *
221 1.8 dyoung sockaddr_in6_externalize(struct sockaddr *dst, socklen_t socklen,
222 1.8 dyoung const struct sockaddr *src)
223 1.8 dyoung {
224 1.8 dyoung struct sockaddr_in6 *sin6;
225 1.8 dyoung
226 1.8 dyoung sin6 = satosin6(sockaddr_copy(dst, socklen, src));
227 1.8 dyoung
228 1.8 dyoung if (sin6 == NULL || sa6_recoverscope(sin6) != 0)
229 1.8 dyoung return NULL;
230 1.8 dyoung
231 1.8 dyoung return dst;
232 1.8 dyoung }
233 1.8 dyoung
234 1.1 rpaulo /*
235 1.1 rpaulo * generate standard sockaddr_in6 from embedded form.
236 1.1 rpaulo */
237 1.1 rpaulo int
238 1.1 rpaulo sa6_recoverscope(struct sockaddr_in6 *sin6)
239 1.1 rpaulo {
240 1.1 rpaulo uint32_t zoneid;
241 1.16 ryo char ip6buf[INET6_ADDRSTRLEN];
242 1.1 rpaulo
243 1.1 rpaulo if (sin6->sin6_scope_id != 0) {
244 1.1 rpaulo log(LOG_NOTICE,
245 1.18 christos "%s: assumption failure (non 0 ID): %s%%%d\n", __func__,
246 1.17 christos IN6_PRINT(ip6buf, &sin6->sin6_addr), sin6->sin6_scope_id);
247 1.1 rpaulo /* XXX: proceed anyway... */
248 1.1 rpaulo }
249 1.1 rpaulo if (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) ||
250 1.1 rpaulo IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr)) {
251 1.1 rpaulo /*
252 1.1 rpaulo * KAME assumption: link id == interface id
253 1.1 rpaulo */
254 1.1 rpaulo zoneid = ntohs(sin6->sin6_addr.s6_addr16[1]);
255 1.1 rpaulo if (zoneid) {
256 1.14 ozaki int s = pserialize_read_enter();
257 1.14 ozaki if (!if_byindex(zoneid)) {
258 1.14 ozaki pserialize_read_exit(s);
259 1.19 maxv return ENXIO;
260 1.14 ozaki }
261 1.14 ozaki pserialize_read_exit(s);
262 1.1 rpaulo sin6->sin6_addr.s6_addr16[1] = 0;
263 1.1 rpaulo sin6->sin6_scope_id = zoneid;
264 1.1 rpaulo }
265 1.1 rpaulo }
266 1.1 rpaulo
267 1.1 rpaulo return 0;
268 1.1 rpaulo }
269 1.1 rpaulo
270 1.5 dyoung int
271 1.5 dyoung in6_setzoneid(struct in6_addr *in6, uint32_t zoneid)
272 1.5 dyoung {
273 1.5 dyoung if (IN6_IS_SCOPE_EMBEDDABLE(in6))
274 1.5 dyoung in6->s6_addr16[1] = htons(zoneid & 0xffff); /* XXX */
275 1.5 dyoung
276 1.5 dyoung return 0;
277 1.5 dyoung }
278 1.5 dyoung
279 1.1 rpaulo /*
280 1.1 rpaulo * Determine the appropriate scope zone ID for in6 and ifp. If ret_id is
281 1.1 rpaulo * non NULL, it is set to the zone ID. If the zone ID needs to be embedded
282 1.19 maxv * in the in6_addr structure, in6 will be modified.
283 1.1 rpaulo */
284 1.1 rpaulo int
285 1.5 dyoung in6_setscope(struct in6_addr *in6, const struct ifnet *ifp, uint32_t *ret_id)
286 1.1 rpaulo {
287 1.1 rpaulo int scope;
288 1.1 rpaulo uint32_t zoneid = 0;
289 1.5 dyoung const struct scope6_id *sid = SID(ifp);
290 1.1 rpaulo
291 1.18 christos if (sid == NULL) {
292 1.18 christos log(LOG_NOTICE, "%s: no scope id for %s\n", __func__,
293 1.18 christos if_name(ifp));
294 1.15 christos return EINVAL;
295 1.18 christos }
296 1.1 rpaulo
297 1.1 rpaulo /*
298 1.1 rpaulo * special case: the loopback address can only belong to a loopback
299 1.1 rpaulo * interface.
300 1.1 rpaulo */
301 1.1 rpaulo if (IN6_IS_ADDR_LOOPBACK(in6)) {
302 1.18 christos if (!(ifp->if_flags & IFF_LOOPBACK)) {
303 1.18 christos char ip6buf[INET6_ADDRSTRLEN];
304 1.18 christos log(LOG_NOTICE, "%s: can't set scope for not loopback "
305 1.18 christos "interface %s and loopback address %s\n",
306 1.18 christos __func__, if_name(ifp), IN6_PRINT(ip6buf, in6));
307 1.18 christos return EINVAL;
308 1.18 christos } else {
309 1.1 rpaulo if (ret_id != NULL)
310 1.1 rpaulo *ret_id = 0; /* there's no ambiguity */
311 1.18 christos return 0;
312 1.1 rpaulo }
313 1.1 rpaulo }
314 1.1 rpaulo
315 1.1 rpaulo scope = in6_addrscope(in6);
316 1.1 rpaulo
317 1.1 rpaulo switch (scope) {
318 1.1 rpaulo case IPV6_ADDR_SCOPE_INTFACELOCAL: /* should be interface index */
319 1.1 rpaulo zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL];
320 1.1 rpaulo break;
321 1.1 rpaulo
322 1.1 rpaulo case IPV6_ADDR_SCOPE_LINKLOCAL:
323 1.1 rpaulo zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL];
324 1.1 rpaulo break;
325 1.1 rpaulo
326 1.1 rpaulo case IPV6_ADDR_SCOPE_SITELOCAL:
327 1.1 rpaulo zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL];
328 1.1 rpaulo break;
329 1.1 rpaulo
330 1.1 rpaulo case IPV6_ADDR_SCOPE_ORGLOCAL:
331 1.1 rpaulo zoneid = sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL];
332 1.1 rpaulo break;
333 1.1 rpaulo
334 1.1 rpaulo default:
335 1.1 rpaulo zoneid = 0; /* XXX: treat as global. */
336 1.1 rpaulo break;
337 1.1 rpaulo }
338 1.1 rpaulo
339 1.1 rpaulo if (ret_id != NULL)
340 1.1 rpaulo *ret_id = zoneid;
341 1.1 rpaulo
342 1.5 dyoung return in6_setzoneid(in6, zoneid);
343 1.1 rpaulo }
344 1.1 rpaulo
345 1.11 christos const char *
346 1.11 christos in6_getscopename(const struct in6_addr *addr)
347 1.11 christos {
348 1.11 christos switch (in6_addrscope(addr)) {
349 1.19 maxv case IPV6_ADDR_SCOPE_INTFACELOCAL:
350 1.19 maxv return "interface";
351 1.11 christos #if IPV6_ADDR_SCOPE_INTFACELOCAL != IPV6_ADDR_SCOPE_NODELOCAL
352 1.19 maxv case IPV6_ADDR_SCOPE_NODELOCAL:
353 1.19 maxv return "node";
354 1.11 christos #endif
355 1.19 maxv case IPV6_ADDR_SCOPE_LINKLOCAL:
356 1.19 maxv return "link";
357 1.19 maxv case IPV6_ADDR_SCOPE_SITELOCAL:
358 1.19 maxv return "site";
359 1.19 maxv case IPV6_ADDR_SCOPE_ORGLOCAL:
360 1.19 maxv return "organization";
361 1.19 maxv case IPV6_ADDR_SCOPE_GLOBAL:
362 1.19 maxv return "global";
363 1.19 maxv default:
364 1.19 maxv return "unknown";
365 1.11 christos }
366 1.11 christos }
367 1.11 christos
368 1.1 rpaulo /*
369 1.1 rpaulo * Just clear the embedded scope identifier. Return 0 if the original address
370 1.1 rpaulo * is intact; return non 0 if the address is modified.
371 1.1 rpaulo */
372 1.1 rpaulo int
373 1.1 rpaulo in6_clearscope(struct in6_addr *in6)
374 1.1 rpaulo {
375 1.1 rpaulo int modified = 0;
376 1.1 rpaulo
377 1.1 rpaulo if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) {
378 1.1 rpaulo if (in6->s6_addr16[1] != 0)
379 1.1 rpaulo modified = 1;
380 1.1 rpaulo in6->s6_addr16[1] = 0;
381 1.1 rpaulo }
382 1.1 rpaulo
383 1.19 maxv return modified;
384 1.1 rpaulo }
385