1251875Speter/*- 2251875Speter * Copyright (C) 2000 WIDE Project. 3251875Speter * All rights reserved. 4251875Speter * 5251875Speter * Redistribution and use in source and binary forms, with or without 6251875Speter * modification, are permitted provided that the following conditions 7251875Speter * are met: 8251875Speter * 1. Redistributions of source code must retain the above copyright 9251875Speter * notice, this list of conditions and the following disclaimer. 10251875Speter * 2. Redistributions in binary form must reproduce the above copyright 11251875Speter * notice, this list of conditions and the following disclaimer in the 12251875Speter * documentation and/or other materials provided with the distribution. 13251875Speter * 3. Neither the name of the project nor the names of its contributors 14251875Speter * may be used to endorse or promote products derived from this software 15251875Speter * without specific prior written permission. 16251875Speter * 17251875Speter * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 18251875Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19251875Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20251875Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 21251875Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22251875Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23251875Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24251875Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25251875Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26251875Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27251875Speter * SUCH DAMAGE. 28251875Speter * 29251875Speter * $KAME: scope6.c,v 1.10 2000/07/24 13:29:31 itojun Exp $ 30251875Speter */ 31251875Speter 32251875Speter#include <sys/cdefs.h> 33251875Speter__FBSDID("$FreeBSD$"); 34251875Speter 35251875Speter#include <sys/param.h> 36251875Speter#include <sys/malloc.h> 37251875Speter#include <sys/mbuf.h> 38251875Speter#include <sys/socket.h> 39251875Speter#include <sys/sockio.h> 40251875Speter#include <sys/systm.h> 41251875Speter#include <sys/queue.h> 42251875Speter#include <sys/sysctl.h> 43251875Speter#include <sys/syslog.h> 44251875Speter 45251875Speter#include <net/if.h> 46251875Speter#include <net/vnet.h> 47251875Speter 48251875Speter#include <netinet/in.h> 49251875Speter 50251875Speter#include <netinet/ip6.h> 51251875Speter#include <netinet6/in6_var.h> 52251875Speter#include <netinet6/ip6_var.h> 53289166Speter#include <netinet6/scope6_var.h> 54251875Speter 55251875Speter#ifdef ENABLE_DEFAULT_SCOPE 56251875SpeterVNET_DEFINE(int, ip6_use_defzone) = 1; 57251875Speter#else 58251875SpeterVNET_DEFINE(int, ip6_use_defzone) = 0; 59251875Speter#endif 60251875SpeterVNET_DEFINE(int, deembed_scopeid) = 1; 61251875SpeterSYSCTL_DECL(_net_inet6_ip6); 62251875SpeterSYSCTL_VNET_INT(_net_inet6_ip6, OID_AUTO, deembed_scopeid, CTLFLAG_RW, 63251875Speter &VNET_NAME(deembed_scopeid), 0, 64251875Speter "Extract embedded zone ID and set it to sin6_scope_id in sockaddr_in6."); 65251875Speter 66251875Speter/* 67251875Speter * The scope6_lock protects the global sid default stored in 68251875Speter * sid_default below. 69251875Speter */ 70251875Speterstatic struct mtx scope6_lock; 71251875Speter#define SCOPE6_LOCK_INIT() mtx_init(&scope6_lock, "scope6_lock", NULL, MTX_DEF) 72251875Speter#define SCOPE6_LOCK() mtx_lock(&scope6_lock) 73251875Speter#define SCOPE6_UNLOCK() mtx_unlock(&scope6_lock) 74251875Speter#define SCOPE6_LOCK_ASSERT() mtx_assert(&scope6_lock, MA_OWNED) 75251875Speter 76251875Speterstatic VNET_DEFINE(struct scope6_id, sid_default); 77251875Speter#define V_sid_default VNET(sid_default) 78251875Speter 79251875Speter#define SID(ifp) \ 80251875Speter (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->scope6_id) 81251875Speter 82251875Speterstatic int scope6_get(struct ifnet *, struct scope6_id *); 83251875Speterstatic int scope6_set(struct ifnet *, struct scope6_id *); 84251875Speter 85251875Spetervoid 86251875Speterscope6_init(void) 87251875Speter{ 88251875Speter 89251875Speter bzero(&V_sid_default, sizeof(V_sid_default)); 90251875Speter 91251875Speter if (!IS_DEFAULT_VNET(curvnet)) 92251875Speter return; 93251875Speter 94251875Speter SCOPE6_LOCK_INIT(); 95251875Speter} 96251875Speter 97251875Speterstruct scope6_id * 98251875Speterscope6_ifattach(struct ifnet *ifp) 99251875Speter{ 100251875Speter struct scope6_id *sid; 101251875Speter 102251875Speter sid = (struct scope6_id *)malloc(sizeof(*sid), M_IFADDR, M_WAITOK); 103251875Speter bzero(sid, sizeof(*sid)); 104251875Speter 105251875Speter /* 106251875Speter * XXX: IPV6_ADDR_SCOPE_xxx macros are not standard. 107251875Speter * Should we rather hardcode here? 108251875Speter */ 109251875Speter sid->s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = ifp->if_index; 110251875Speter sid->s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = ifp->if_index; 111251875Speter#ifdef MULTI_SCOPE 112251875Speter /* by default, we don't care about scope boundary for these scopes. */ 113251875Speter sid->s6id_list[IPV6_ADDR_SCOPE_SITELOCAL] = 1; 114251875Speter sid->s6id_list[IPV6_ADDR_SCOPE_ORGLOCAL] = 1; 115251875Speter#endif 116251875Speter 117251875Speter return sid; 118251875Speter} 119251875Speter 120251875Spetervoid 121251875Speterscope6_ifdetach(struct scope6_id *sid) 122251875Speter{ 123251875Speter 124251875Speter free(sid, M_IFADDR); 125251875Speter} 126251875Speter 127251875Speterint 128251875Speterscope6_ioctl(u_long cmd, caddr_t data, struct ifnet *ifp) 129251875Speter{ 130251875Speter struct in6_ifreq *ifr; 131251875Speter 132251875Speter if (ifp->if_afdata[AF_INET6] == NULL) 133251875Speter return (EPFNOSUPPORT); 134251875Speter 135251875Speter ifr = (struct in6_ifreq *)data; 136251875Speter switch (cmd) { 137251875Speter case SIOCSSCOPE6: 138251875Speter return (scope6_set(ifp, 139251875Speter (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id)); 140251875Speter case SIOCGSCOPE6: 141251875Speter return (scope6_get(ifp, 142251875Speter (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id)); 143251875Speter case SIOCGSCOPE6DEF: 144251875Speter return (scope6_get_default( 145251875Speter (struct scope6_id *)ifr->ifr_ifru.ifru_scope_id)); 146251875Speter default: 147251875Speter return (EOPNOTSUPP); 148251875Speter } 149251875Speter} 150251875Speter 151251875Speterstatic int 152251875Speterscope6_set(struct ifnet *ifp, struct scope6_id *idlist) 153251875Speter{ 154251875Speter int i; 155251875Speter int error = 0; 156251875Speter struct scope6_id *sid = NULL; 157251875Speter 158251875Speter IF_AFDATA_WLOCK(ifp); 159251875Speter sid = SID(ifp); 160251875Speter 161251875Speter if (!sid) { /* paranoid? */ 162251875Speter IF_AFDATA_WUNLOCK(ifp); 163251875Speter return (EINVAL); 164251875Speter } 165251875Speter 166251875Speter /* 167251875Speter * XXX: We need more consistency checks of the relationship among 168251875Speter * scopes (e.g. an organization should be larger than a site). 169251875Speter */ 170251875Speter 171251875Speter /* 172251875Speter * TODO(XXX): after setting, we should reflect the changes to 173251875Speter * interface addresses, routing table entries, PCB entries... 174251875Speter */ 175251875Speter 176251875Speter for (i = 0; i < 16; i++) { 177251875Speter if (idlist->s6id_list[i] && 178251875Speter idlist->s6id_list[i] != sid->s6id_list[i]) { 179251875Speter /* 180251875Speter * An interface zone ID must be the corresponding 181251875Speter * interface index by definition. 182251875Speter */ 183251875Speter if (i == IPV6_ADDR_SCOPE_INTFACELOCAL && 184251875Speter idlist->s6id_list[i] != ifp->if_index) { 185251875Speter IF_AFDATA_WUNLOCK(ifp); 186251875Speter return (EINVAL); 187251875Speter } 188251875Speter 189251875Speter if (i == IPV6_ADDR_SCOPE_LINKLOCAL && 190251875Speter idlist->s6id_list[i] > V_if_index) { 191251875Speter /* 192251875Speter * XXX: theoretically, there should be no 193251875Speter * relationship between link IDs and interface 194251875Speter * IDs, but we check the consistency for 195251875Speter * safety in later use. 196251875Speter */ 197251875Speter IF_AFDATA_WUNLOCK(ifp); 198251875Speter return (EINVAL); 199251875Speter } 200251875Speter 201251875Speter /* 202251875Speter * XXX: we must need lots of work in this case, 203251875Speter * but we simply set the new value in this initial 204251875Speter * implementation. 205251875Speter */ 206251875Speter sid->s6id_list[i] = idlist->s6id_list[i]; 207251875Speter } 208251875Speter } 209251875Speter IF_AFDATA_WUNLOCK(ifp); 210251875Speter 211251875Speter return (error); 212251875Speter} 213251875Speter 214251875Speterstatic int 215251875Speterscope6_get(struct ifnet *ifp, struct scope6_id *idlist) 216251875Speter{ 217251875Speter struct scope6_id *sid; 218251875Speter 219251875Speter /* We only need to lock the interface's afdata for SID() to work. */ 220251875Speter IF_AFDATA_RLOCK(ifp); 221251875Speter sid = SID(ifp); 222251875Speter if (sid == NULL) { /* paranoid? */ 223251875Speter IF_AFDATA_RUNLOCK(ifp); 224251875Speter return (EINVAL); 225251875Speter } 226251875Speter 227251875Speter *idlist = *sid; 228251875Speter 229251875Speter IF_AFDATA_RUNLOCK(ifp); 230251875Speter return (0); 231251875Speter} 232251875Speter 233251875Speter/* 234251875Speter * Get a scope of the address. Node-local, link-local, site-local or global. 235251875Speter */ 236251875Speterint 237251875Speterin6_addrscope(struct in6_addr *addr) 238251875Speter{ 239251875Speter int scope; 240251875Speter 241251875Speter if (addr->s6_addr[0] == 0xfe) { 242251875Speter scope = addr->s6_addr[1] & 0xc0; 243251875Speter 244251875Speter switch (scope) { 245251875Speter case 0x80: 246251875Speter return IPV6_ADDR_SCOPE_LINKLOCAL; 247251875Speter break; 248251875Speter case 0xc0: 249251875Speter return IPV6_ADDR_SCOPE_SITELOCAL; 250251875Speter break; 251251875Speter default: 252251875Speter return IPV6_ADDR_SCOPE_GLOBAL; /* just in case */ 253251875Speter break; 254251875Speter } 255251875Speter } 256251875Speter 257251875Speter 258251875Speter if (addr->s6_addr[0] == 0xff) { 259251875Speter scope = addr->s6_addr[1] & 0x0f; 260251875Speter 261251875Speter /* 262251875Speter * due to other scope such as reserved, 263251875Speter * return scope doesn't work. 264251875Speter */ 265251875Speter switch (scope) { 266251875Speter case IPV6_ADDR_SCOPE_INTFACELOCAL: 267251875Speter return IPV6_ADDR_SCOPE_INTFACELOCAL; 268251875Speter break; 269251875Speter case IPV6_ADDR_SCOPE_LINKLOCAL: 270251875Speter return IPV6_ADDR_SCOPE_LINKLOCAL; 271251875Speter break; 272251875Speter case IPV6_ADDR_SCOPE_SITELOCAL: 273251875Speter return IPV6_ADDR_SCOPE_SITELOCAL; 274251875Speter break; 275251875Speter default: 276251875Speter return IPV6_ADDR_SCOPE_GLOBAL; 277251875Speter break; 278251875Speter } 279251875Speter } 280251875Speter 281251875Speter /* 282251875Speter * Regard loopback and unspecified addresses as global, since 283251875Speter * they have no ambiguity. 284251875Speter */ 285251875Speter if (bcmp(&in6addr_loopback, addr, sizeof(*addr) - 1) == 0) { 286251875Speter if (addr->s6_addr[15] == 1) /* loopback */ 287251875Speter return IPV6_ADDR_SCOPE_LINKLOCAL; 288251875Speter if (addr->s6_addr[15] == 0) /* unspecified */ 289251875Speter return IPV6_ADDR_SCOPE_GLOBAL; /* XXX: correct? */ 290251875Speter } 291251875Speter 292251875Speter return IPV6_ADDR_SCOPE_GLOBAL; 293251875Speter} 294251875Speter 295251875Speter/* 296251875Speter * ifp - note that this might be NULL 297289166Speter */ 298251875Speter 299251875Spetervoid 300251875Speterscope6_setdefault(struct ifnet *ifp) 301251875Speter{ 302251875Speter 303289166Speter /* 304251875Speter * Currently, this function just sets the default "interfaces" 305251875Speter * and "links" according to the given interface. 306251875Speter * We might eventually have to separate the notion of "link" from 307251875Speter * "interface" and provide a user interface to set the default. 308251875Speter */ 309251875Speter SCOPE6_LOCK(); 310251875Speter if (ifp) { 311251875Speter V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = 312251875Speter ifp->if_index; 313251875Speter V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = 314251875Speter ifp->if_index; 315251875Speter } else { 316251875Speter V_sid_default.s6id_list[IPV6_ADDR_SCOPE_INTFACELOCAL] = 0; 317251875Speter V_sid_default.s6id_list[IPV6_ADDR_SCOPE_LINKLOCAL] = 0; 318251875Speter } 319251875Speter SCOPE6_UNLOCK(); 320251875Speter} 321251875Speter 322251875Speterint 323251875Speterscope6_get_default(struct scope6_id *idlist) 324251875Speter{ 325251875Speter 326251875Speter SCOPE6_LOCK(); 327251875Speter *idlist = V_sid_default; 328251875Speter SCOPE6_UNLOCK(); 329251875Speter 330251875Speter return (0); 331251875Speter} 332251875Speter 333251875Speteru_int32_t 334251875Speterscope6_addr2default(struct in6_addr *addr) 335251875Speter{ 336251875Speter u_int32_t id; 337251875Speter 338251875Speter /* 339251875Speter * special case: The loopback address should be considered as 340251875Speter * link-local, but there's no ambiguity in the syntax. 341251875Speter */ 342251875Speter if (IN6_IS_ADDR_LOOPBACK(addr)) 343251875Speter return (0); 344251875Speter 345251875Speter /* 346251875Speter * XXX: 32-bit read is atomic on all our platforms, is it OK 347251875Speter * not to lock here? 348251875Speter */ 349251875Speter SCOPE6_LOCK(); 350251875Speter id = V_sid_default.s6id_list[in6_addrscope(addr)]; 351251875Speter SCOPE6_UNLOCK(); 352251875Speter return (id); 353251875Speter} 354251875Speter 355251875Speter/* 356251875Speter * Validate the specified scope zone ID in the sin6_scope_id field. If the ID 357251875Speter * is unspecified (=0), needs to be specified, and the default zone ID can be 358251875Speter * used, the default value will be used. 359251875Speter * This routine then generates the kernel-internal form: if the address scope 360251875Speter * of is interface-local or link-local, embed the interface index in the 361251875Speter * address. 362251875Speter */ 363251875Speterint 364251875Spetersa6_embedscope(struct sockaddr_in6 *sin6, int defaultok) 365251875Speter{ 366251875Speter u_int32_t zoneid; 367251875Speter 368251875Speter if ((zoneid = sin6->sin6_scope_id) == 0 && defaultok) 369251875Speter zoneid = scope6_addr2default(&sin6->sin6_addr); 370251875Speter 371251875Speter if (zoneid != 0 && 372251875Speter (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) || 373251875Speter IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr))) { 374251875Speter /* 375251875Speter * At this moment, we only check interface-local and 376251875Speter * link-local scope IDs, and use interface indices as the 377251875Speter * zone IDs assuming a one-to-one mapping between interfaces 378251875Speter * and links. 379251875Speter */ 380251875Speter if (V_if_index < zoneid || ifnet_byindex(zoneid) == NULL) 381251875Speter return (ENXIO); 382251875Speter 383251875Speter /* XXX assignment to 16bit from 32bit variable */ 384251875Speter sin6->sin6_addr.s6_addr16[1] = htons(zoneid & 0xffff); 385251875Speter sin6->sin6_scope_id = 0; 386251875Speter } 387251875Speter 388251875Speter return 0; 389251875Speter} 390251875Speter 391251875Speter/* 392251875Speter * generate standard sockaddr_in6 from embedded form. 393251875Speter */ 394251875Speterint 395251875Spetersa6_recoverscope(struct sockaddr_in6 *sin6) 396251875Speter{ 397251875Speter char ip6buf[INET6_ADDRSTRLEN]; 398251875Speter u_int32_t zoneid; 399251875Speter 400251875Speter if (IN6_IS_SCOPE_LINKLOCAL(&sin6->sin6_addr) || 401251875Speter IN6_IS_ADDR_MC_INTFACELOCAL(&sin6->sin6_addr)) { 402251875Speter /* 403251875Speter * KAME assumption: link id == interface id 404251875Speter */ 405251875Speter zoneid = ntohs(sin6->sin6_addr.s6_addr16[1]); 406251875Speter if (zoneid) { 407251875Speter /* sanity check */ 408251875Speter if (V_if_index < zoneid) 409251875Speter return (ENXIO); 410251875Speter#if 0 411251875Speter /* XXX: Disabled due to possible deadlock. */ 412251875Speter if (!ifnet_byindex(zoneid)) 413289166Speter return (ENXIO); 414251875Speter#endif 415251875Speter if (sin6->sin6_scope_id != 0 && 416251875Speter zoneid != sin6->sin6_scope_id) { 417251875Speter log(LOG_NOTICE, 418251875Speter "%s: embedded scope mismatch: %s%%%d. " 419251875Speter "sin6_scope_id was overridden\n", __func__, 420251875Speter ip6_sprintf(ip6buf, &sin6->sin6_addr), 421251875Speter sin6->sin6_scope_id); 422251875Speter } 423251875Speter sin6->sin6_addr.s6_addr16[1] = 0; 424251875Speter sin6->sin6_scope_id = zoneid; 425251875Speter } 426251875Speter } 427251875Speter 428251875Speter return 0; 429251875Speter} 430251875Speter 431251875Speter/* 432251875Speter * Determine the appropriate scope zone ID for in6 and ifp. If ret_id is 433251875Speter * non NULL, it is set to the zone ID. If the zone ID needs to be embedded 434 * in the in6_addr structure, in6 will be modified. 435 * 436 * ret_id - unnecessary? 437 */ 438int 439in6_setscope(struct in6_addr *in6, struct ifnet *ifp, u_int32_t *ret_id) 440{ 441 int scope; 442 u_int32_t zoneid = 0; 443 struct scope6_id *sid; 444 445 /* 446 * special case: the loopback address can only belong to a loopback 447 * interface. 448 */ 449 if (IN6_IS_ADDR_LOOPBACK(in6)) { 450 if (!(ifp->if_flags & IFF_LOOPBACK)) 451 return (EINVAL); 452 } else { 453 scope = in6_addrscope(in6); 454 if (scope == IPV6_ADDR_SCOPE_INTFACELOCAL || 455 scope == IPV6_ADDR_SCOPE_LINKLOCAL) { 456 /* 457 * Currently we use interface indeces as the 458 * zone IDs for interface-local and link-local 459 * scopes. 460 */ 461 zoneid = ifp->if_index; 462 in6->s6_addr16[1] = htons(zoneid & 0xffff); /* XXX */ 463 } else if (scope != IPV6_ADDR_SCOPE_GLOBAL) { 464 IF_AFDATA_RLOCK(ifp); 465 sid = SID(ifp); 466 zoneid = sid->s6id_list[scope]; 467 IF_AFDATA_RUNLOCK(ifp); 468 } 469 } 470 471 if (ret_id != NULL) 472 *ret_id = zoneid; 473 474 return (0); 475} 476 477/* 478 * Just clear the embedded scope identifier. Return 0 if the original address 479 * is intact; return non 0 if the address is modified. 480 */ 481int 482in6_clearscope(struct in6_addr *in6) 483{ 484 int modified = 0; 485 486 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) { 487 if (in6->s6_addr16[1] != 0) 488 modified = 1; 489 in6->s6_addr16[1] = 0; 490 } 491 492 return (modified); 493} 494 495/* 496 * Return the scope identifier or zero. 497 */ 498uint16_t 499in6_getscope(struct in6_addr *in6) 500{ 501 502 if (IN6_IS_SCOPE_LINKLOCAL(in6) || IN6_IS_ADDR_MC_INTFACELOCAL(in6)) 503 return (in6->s6_addr16[1]); 504 505 return (0); 506} 507