1/*
2 * Copyright (c) 2003-2013 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29/*
30 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
31 * All rights reserved.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
35 * are met:
36 * 1. Redistributions of source code must retain the above copyright
37 *    notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 *    notice, this list of conditions and the following disclaimer in the
40 *    documentation and/or other materials provided with the distribution.
41 * 3. Neither the name of the project nor the names of its contributors
42 *    may be used to endorse or promote products derived from this software
43 *    without specific prior written permission.
44 *
45 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55 * SUCH DAMAGE.
56 */
57
58#include <sys/param.h>
59#include <sys/systm.h>
60#include <sys/malloc.h>
61#include <sys/socket.h>
62#include <sys/socketvar.h>
63#include <sys/sockio.h>
64#include <sys/kernel.h>
65#include <sys/syslog.h>
66#include <libkern/crypto/sha1.h>
67#include <libkern/OSAtomic.h>
68#include <kern/lock.h>
69
70#include <net/if.h>
71#include <net/if_dl.h>
72#include <net/if_types.h>
73#include <net/route.h>
74#include <net/kpi_protocol.h>
75
76#include <netinet/in.h>
77#include <netinet/in_var.h>
78#include <netinet/if_ether.h>
79#include <netinet/in_pcb.h>
80#include <netinet/icmp6.h>
81
82#include <netinet/ip6.h>
83#include <netinet6/ip6_var.h>
84#include <netinet6/in6_var.h>
85#include <netinet6/in6_pcb.h>
86#include <netinet6/in6_ifattach.h>
87#include <netinet6/ip6_var.h>
88#include <netinet6/nd6.h>
89#include <netinet6/scope6_var.h>
90
91#include <net/net_osdep.h>
92#include <dev/random/randomdev.h>
93
94u_int32_t in6_maxmtu = 0;
95extern lck_mtx_t *nd6_mutex;
96
97#if IP6_AUTO_LINKLOCAL
98int ip6_auto_linklocal = IP6_AUTO_LINKLOCAL;
99#else
100int ip6_auto_linklocal = 1;	/* enable by default */
101#endif
102
103extern struct inpcbinfo udbinfo;
104extern struct inpcbinfo ripcbinfo;
105
106static const unsigned int in6_extra_size = sizeof(struct in6_ifextra);
107static const unsigned int in6_extra_bufsize = in6_extra_size +
108    sizeof(void *) + sizeof(uint64_t);
109
110static int get_rand_iid(struct ifnet *, struct in6_addr *);
111static int in6_generate_tmp_iid(u_int8_t *, const u_int8_t *, u_int8_t *);
112static int in6_select_iid_from_all_hw(struct ifnet *, struct ifnet *,
113    struct in6_addr *);
114static int in6_ifattach_linklocal(struct ifnet *, struct in6_aliasreq *);
115static int in6_ifattach_loopback(struct ifnet *);
116
117/*
118 * Generate a last-resort interface identifier, when the machine has no
119 * IEEE802/EUI64 address sources.
120 * The goal here is to get an interface identifier that is
121 * (1) random enough and (2) does not change across reboot.
122 * We currently use SHA1(hostname) for it.
123 *
124 * in6 - upper 64bits are preserved
125 */
126static int
127get_rand_iid(
128	__unused struct ifnet *ifp,
129	struct in6_addr *in6)	/* upper 64bits are preserved */
130{
131	SHA1_CTX ctxt;
132	u_int8_t digest[SHA1_RESULTLEN];
133	int hostnlen	= strlen(hostname);
134
135	/* generate 8 bytes of pseudo-random value. */
136	bzero(&ctxt, sizeof (ctxt));
137	SHA1Init(&ctxt);
138	SHA1Update(&ctxt, hostname, hostnlen);
139	SHA1Final(digest, &ctxt);
140
141	/* assumes sizeof (digest) > sizeof (iid) */
142	bcopy(digest, &in6->s6_addr[8], 8);
143
144	/* make sure to set "u" bit to local, and "g" bit to individual. */
145	in6->s6_addr[8] &= ~ND6_EUI64_GBIT;	/* g bit to "individual" */
146	in6->s6_addr[8] |= ND6_EUI64_UBIT;	/* u bit to "local" */
147
148	/* convert EUI64 into IPv6 interface identifier */
149	ND6_EUI64_TO_IFID(in6);
150
151	return (0);
152}
153
154static int
155in6_generate_tmp_iid(
156	u_int8_t *seed0,
157	const u_int8_t *seed1,
158	u_int8_t *ret)
159{
160	SHA1_CTX ctxt;
161	u_int8_t seed[16], nullbuf[8], digest[SHA1_RESULTLEN];
162	u_int32_t val32;
163	struct timeval tv;
164
165	/* If there's no history, start with a random seed. */
166	bzero(nullbuf, sizeof (nullbuf));
167	if (bcmp(nullbuf, seed0, sizeof (nullbuf)) == 0) {
168		int i;
169
170		for (i = 0; i < 2; i++) {
171			getmicrotime(&tv);
172			val32 = RandomULong() ^ tv.tv_usec;
173			bcopy(&val32, seed + sizeof (val32) * i,
174			    sizeof (val32));
175		}
176	} else {
177		bcopy(seed0, seed, 8);
178	}
179
180	/* copy the right-most 64-bits of the given address */
181	/* XXX assumption on the size of IFID */
182	bcopy(seed1, &seed[8], 8);
183
184	if (0) {		/* for debugging purposes only */
185		int i;
186
187		printf("%s: new randomized ID from: ", __func__);
188		for (i = 0; i < 16; i++)
189			printf("%02x", seed[i]);
190		printf(" ");
191	}
192
193	/* generate 16 bytes of pseudo-random value. */
194	bzero(&ctxt, sizeof (ctxt));
195	SHA1Init(&ctxt);
196	SHA1Update(&ctxt, seed, sizeof (seed));
197	SHA1Final(digest, &ctxt);
198
199	/*
200	 * RFC 4941 3.2.1. (3)
201	 * Take the left-most 64-bits of the SHA1 digest and set bit 6 (the
202	 * left-most bit is numbered 0) to zero.
203	 */
204	bcopy(digest, ret, 8);
205	ret[0] &= ~ND6_EUI64_UBIT;
206
207	/*
208	 * XXX: we'd like to ensure that the generated value is not zero
209	 * for simplicity.  If the caclculated digest happens to be zero,
210	 * use a random non-zero value as the last resort.
211	 */
212	if (bcmp(nullbuf, ret, sizeof (nullbuf)) == 0) {
213		nd6log((LOG_INFO,
214		    "%s: computed SHA1 value is zero.\n", __func__));
215
216		getmicrotime(&tv);
217		val32 = random() ^ tv.tv_usec;
218		val32 = 1 + (val32 % (0xffffffff - 1));
219	}
220
221	/*
222	 * RFC 4941 3.2.1. (4)
223	 * Take the next 64-bits of the SHA1 digest and save them in
224	 * stable storage as the history value to be used in the next
225	 * iteration of the algorithm.
226	 */
227	bcopy(&digest[8], seed0, 8);
228
229	if (0) {		/* for debugging purposes only */
230		int i;
231
232		printf("to: ");
233		for (i = 0; i < 16; i++)
234			printf("%02x", digest[i]);
235		printf("\n");
236	}
237
238	return (0);
239}
240
241/*
242 * Get interface identifier for the specified interface using the method in
243 * Appendix A of RFC 4291.
244 *
245 * XXX assumes single sockaddr_dl (AF_LINK address) per an interface
246 *
247 * in6 - upper 64bits are preserved
248 */
249int
250in6_iid_from_hw(struct ifnet *ifp, struct in6_addr *in6)
251{
252	struct ifaddr *ifa = NULL;
253	struct sockaddr_dl *sdl;
254	u_int8_t *addr;
255	size_t addrlen;
256	static u_int8_t allzero[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
257	static u_int8_t allone[8] =
258		{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
259	int err = -1;
260
261	/* Why doesn't this code use ifnet_addrs? */
262	ifnet_lock_shared(ifp);
263	ifa = ifp->if_lladdr;
264	sdl = (struct sockaddr_dl *)(void *)ifa->ifa_addr;
265	if (sdl->sdl_alen == 0) {
266		ifnet_lock_done(ifp);
267		return (-1);
268	}
269	IFA_ADDREF(ifa);	/* for this routine */
270	ifnet_lock_done(ifp);
271
272	IFA_LOCK(ifa);
273	addr = (u_int8_t *) LLADDR(sdl);
274	addrlen = sdl->sdl_alen;
275
276	/* get EUI64 */
277	switch (ifp->if_type) {
278	case IFT_ETHER:
279	case IFT_FDDI:
280	case IFT_ISO88025:
281	case IFT_ATM:
282	case IFT_IEEE1394:
283	case IFT_L2VLAN:
284	case IFT_IEEE8023ADLAG:
285#if IFT_IEEE80211
286	case IFT_IEEE80211:
287#endif
288	case IFT_BRIDGE:
289		/* IEEE802/EUI64 cases - what others? */
290		/* IEEE1394 uses 16byte length address starting with EUI64 */
291		if (addrlen > 8)
292			addrlen = 8;
293
294		/* look at IEEE802/EUI64 only */
295		if (addrlen != 8 && addrlen != 6)
296			goto done;
297
298		/*
299		 * check for invalid MAC address - on bsdi, we see it a lot
300		 * since wildboar configures all-zero MAC on pccard before
301		 * card insertion.
302		 */
303		if (bcmp(addr, allzero, addrlen) == 0)
304			goto done;
305		if (bcmp(addr, allone, addrlen) == 0)
306			goto done;
307
308		/* make EUI64 address */
309		if (addrlen == 8)
310			bcopy(addr, &in6->s6_addr[8], 8);
311		else if (addrlen == 6) {
312			in6->s6_addr[8] = addr[0];
313			in6->s6_addr[9] = addr[1];
314			in6->s6_addr[10] = addr[2];
315			in6->s6_addr[11] = 0xff;
316			in6->s6_addr[12] = 0xfe;
317			in6->s6_addr[13] = addr[3];
318			in6->s6_addr[14] = addr[4];
319			in6->s6_addr[15] = addr[5];
320		}
321		break;
322
323	case IFT_ARCNET:
324		if (addrlen != 1)
325			goto done;
326		if (!addr[0])
327			goto done;
328
329		bzero(&in6->s6_addr[8], 8);
330		in6->s6_addr[15] = addr[0];
331
332		/*
333		 * due to insufficient bitwidth, we mark it local.
334		 */
335		in6->s6_addr[8] &= ~ND6_EUI64_GBIT;	/* g to "individual" */
336		in6->s6_addr[8] |= ND6_EUI64_UBIT;	/* u to "local" */
337		break;
338
339	case IFT_GIF:
340#if IFT_STF
341	case IFT_STF:
342#endif
343		/*
344		 * RFC2893 says: "SHOULD use IPv4 address as IID source".
345		 * however, IPv4 address is not very suitable as unique
346		 * identifier source (can be renumbered).
347		 * we don't do this.
348		 */
349		goto done;
350
351	case IFT_CELLULAR:
352		goto done;
353
354	default:
355		goto done;
356	}
357
358	/* sanity check: g bit must not indicate "group" */
359	if (ND6_EUI64_GROUP(in6))
360		goto done;
361
362	/* convert EUI64 into IPv6 interface identifier */
363	ND6_EUI64_TO_IFID(in6);
364
365	/*
366	 * sanity check: iid must not be all zero, avoid conflict with
367	 * subnet router anycast
368	 */
369	if ((in6->s6_addr[8] & ~(ND6_EUI64_GBIT | ND6_EUI64_UBIT)) == 0x00 &&
370	    bcmp(&in6->s6_addr[9], allzero, 7) == 0) {
371		goto done;
372	}
373
374	err = 0;	/* found */
375
376done:
377	/* This must not be the last reference to the lladdr */
378	if (IFA_REMREF_LOCKED(ifa) == NULL) {
379		panic("%s: unexpected (missing) refcnt ifa=%p", __func__, ifa);
380		/* NOTREACHED */
381	}
382	IFA_UNLOCK(ifa);
383	return (err);
384}
385
386/*
387 * Get interface identifier for the specified interface using the method in
388 * Appendix A of RFC 4291.  If it is not available on ifp0, borrow interface
389 * identifier from other information sources.
390 *
391 * ifp     - primary EUI64 source
392 * altifp  - secondary EUI64 source
393 * in6     - IPv6 address to output IID
394 */
395static int
396in6_select_iid_from_all_hw(
397	struct ifnet *ifp0,
398	struct ifnet *altifp,	/* secondary EUI64 source */
399	struct in6_addr *in6)
400{
401	struct ifnet *ifp;
402
403	/* first, try to get it from the interface itself */
404	if (in6_iid_from_hw(ifp0, in6) == 0) {
405		nd6log((LOG_DEBUG, "%s: IID derived from HW interface.\n",
406		    if_name(ifp0)));
407		goto success;
408	}
409
410	/* try secondary EUI64 source. this basically is for ATM PVC */
411	if (altifp && in6_iid_from_hw(altifp, in6) == 0) {
412		nd6log((LOG_DEBUG, "%s: IID from alterate HW interface %s.\n",
413		    if_name(ifp0), if_name(altifp)));
414		goto success;
415	}
416
417	/* next, try to get it from some other hardware interface */
418	ifnet_head_lock_shared();
419	TAILQ_FOREACH(ifp, &ifnet_head, if_list) {
420		if (ifp == ifp0)
421			continue;
422		if (in6_iid_from_hw(ifp, in6) != 0)
423			continue;
424
425		/*
426		 * to borrow IID from other interface, IID needs to be
427		 * globally unique
428		 */
429		if (ND6_IFID_UNIVERSAL(in6)) {
430			nd6log((LOG_DEBUG, "%s: borrowed IID from %s\n",
431			    if_name(ifp0), if_name(ifp)));
432			ifnet_head_done();
433			goto success;
434		}
435	}
436	ifnet_head_done();
437
438	/* last resort: get from random number source */
439	if (get_rand_iid(ifp, in6) == 0) {
440		nd6log((LOG_DEBUG, "%s: IID from PRNG.\n", if_name(ifp0)));
441		goto success;
442	}
443
444	printf("%s: failed to get interface identifier\n", if_name(ifp0));
445	return (-1);
446
447success:
448	nd6log((LOG_INFO, "%s: IID: "
449		"%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
450		if_name(ifp0),
451		in6->s6_addr[8], in6->s6_addr[9],
452		in6->s6_addr[10], in6->s6_addr[11],
453		in6->s6_addr[12], in6->s6_addr[13],
454		in6->s6_addr[14], in6->s6_addr[15]));
455	return (0);
456}
457
458static int
459in6_ifattach_linklocal(struct ifnet *ifp, struct in6_aliasreq *ifra)
460{
461	struct in6_ifaddr *ia;
462	struct nd_prefix pr0, *pr;
463	int i, error;
464
465	VERIFY(ifra != NULL);
466
467	proto_plumb(PF_INET6, ifp);
468
469	error = in6_update_ifa(ifp, ifra, IN6_IFAUPDATE_DADDELAY, &ia);
470	if (error != 0) {
471		/*
472		 * XXX: When the interface does not support IPv6, this call
473		 * would fail in the SIOCSIFADDR ioctl.  I believe the
474		 * notification is rather confusing in this case, so just
475		 * suppress it.  (jinmei@kame.net 20010130)
476		 */
477		if (error != EAFNOSUPPORT)
478			nd6log((LOG_NOTICE, "%s: failed to "
479			    "configure a link-local address on %s "
480			    "(errno=%d)\n",
481			    __func__, if_name(ifp), error));
482		return (EADDRNOTAVAIL);
483	}
484	VERIFY(ia != NULL);
485
486	/*
487	 * Make the link-local prefix (fe80::%link/64) as on-link.
488	 * Since we'd like to manage prefixes separately from addresses,
489	 * we make an ND6 prefix structure for the link-local prefix,
490	 * and add it to the prefix list as a never-expire prefix.
491	 * XXX: this change might affect some existing code base...
492	 */
493	bzero(&pr0, sizeof (pr0));
494	lck_mtx_init(&pr0.ndpr_lock, ifa_mtx_grp, ifa_mtx_attr);
495	pr0.ndpr_ifp = ifp;
496	/* this should be 64 at this moment. */
497	pr0.ndpr_plen = in6_mask2len(&ifra->ifra_prefixmask.sin6_addr, NULL);
498	pr0.ndpr_mask = ifra->ifra_prefixmask.sin6_addr;
499	pr0.ndpr_prefix = ifra->ifra_addr;
500	/* apply the mask for safety. (nd6_prelist_add will apply it again) */
501	for (i = 0; i < 4; i++) {
502		pr0.ndpr_prefix.sin6_addr.s6_addr32[i] &=
503			in6mask64.s6_addr32[i];
504	}
505	/*
506	 * Initialize parameters.  The link-local prefix must always be
507	 * on-link, and its lifetimes never expire.
508	 */
509	pr0.ndpr_raf_onlink = 1;
510	pr0.ndpr_raf_auto = 1;	/* probably meaningless */
511	pr0.ndpr_vltime = ND6_INFINITE_LIFETIME;
512	pr0.ndpr_pltime = ND6_INFINITE_LIFETIME;
513	pr0.ndpr_stateflags |= NDPRF_STATIC;
514	/*
515	 * Since there is no other link-local addresses, nd6_prefix_lookup()
516	 * probably returns NULL.  However, we cannot always expect the result.
517	 * For example, if we first remove the (only) existing link-local
518	 * address, and then reconfigure another one, the prefix is still
519	 * valid with referring to the old link-local address.
520	 */
521	if ((pr = nd6_prefix_lookup(&pr0)) == NULL) {
522		if ((error = nd6_prelist_add(&pr0, NULL, &pr, TRUE)) != 0) {
523			IFA_REMREF(&ia->ia_ifa);
524			lck_mtx_destroy(&pr0.ndpr_lock, ifa_mtx_grp);
525			return (error);
526		}
527	}
528
529	in6_post_msg(ifp, KEV_INET6_NEW_LL_ADDR, ia);
530	IFA_REMREF(&ia->ia_ifa);
531
532	/* Drop use count held above during lookup/add */
533	if (pr != NULL)
534		NDPR_REMREF(pr);
535
536	lck_mtx_destroy(&pr0.ndpr_lock, ifa_mtx_grp);
537	return (0);
538}
539
540static int
541in6_ifattach_loopback(
542	struct ifnet *ifp)	/* must be IFT_LOOP */
543{
544	struct in6_aliasreq ifra;
545	struct in6_ifaddr *ia;
546	int error;
547
548	bzero(&ifra, sizeof (ifra));
549
550	/*
551	 * in6_update_ifa() does not use ifra_name, but we accurately set it
552	 * for safety.
553	 */
554	strncpy(ifra.ifra_name, if_name(ifp), sizeof (ifra.ifra_name));
555
556	ifra.ifra_prefixmask.sin6_len = sizeof (struct sockaddr_in6);
557	ifra.ifra_prefixmask.sin6_family = AF_INET6;
558	ifra.ifra_prefixmask.sin6_addr = in6mask128;
559
560	/*
561	 * Always initialize ia_dstaddr (= broadcast address) to loopback
562	 * address.  Follows IPv4 practice - see in_ifinit().
563	 */
564	ifra.ifra_dstaddr.sin6_len = sizeof (struct sockaddr_in6);
565	ifra.ifra_dstaddr.sin6_family = AF_INET6;
566	ifra.ifra_dstaddr.sin6_addr = in6addr_loopback;
567
568	ifra.ifra_addr.sin6_len = sizeof (struct sockaddr_in6);
569	ifra.ifra_addr.sin6_family = AF_INET6;
570	ifra.ifra_addr.sin6_addr = in6addr_loopback;
571
572	/* the loopback  address should NEVER expire. */
573	ifra.ifra_lifetime.ia6t_vltime = ND6_INFINITE_LIFETIME;
574	ifra.ifra_lifetime.ia6t_pltime = ND6_INFINITE_LIFETIME;
575
576	/* we don't need to perform DAD on loopback interfaces. */
577	ifra.ifra_flags |= IN6_IFF_NODAD;
578
579	/* skip registration to the prefix list. XXX should be temporary. */
580	ifra.ifra_flags |= IN6_IFF_NOPFX;
581
582	/* add the new interface address */
583	error = in6_update_ifa(ifp, &ifra, 0, &ia);
584	if (error != 0) {
585		nd6log((LOG_ERR,
586		    "%s: failed to configure loopback address %s (error=%d)\n",
587		    __func__, if_name(ifp), error));
588		VERIFY(ia == NULL);
589		return (EADDRNOTAVAIL);
590	}
591
592	VERIFY(ia != NULL);
593	IFA_REMREF(&ia->ia_ifa);
594	return (0);
595}
596
597/*
598 * compute NI group address, based on the current hostname setting.
599 * see RFC 4620.
600 *
601 * when ifp == NULL, the caller is responsible for filling scopeid.
602 */
603int
604in6_nigroup(
605	struct ifnet *ifp,
606	const char *name,
607	int namelen,
608	struct in6_addr *in6)
609{
610	const char *p;
611	u_char *q;
612	SHA1_CTX ctxt;
613	u_int8_t digest[SHA1_RESULTLEN];
614	char l;
615	char n[64];	/* a single label must not exceed 63 chars */
616
617	if (!namelen || !name)
618		return (-1);
619
620	p = name;
621	while (p && *p && *p != '.' && p - name < namelen)
622		p++;
623	if (p - name > sizeof (n) - 1)
624		return (-1);	/* label too long */
625	l = p - name;
626	strncpy(n, name, l);
627	n[(int)l] = '\0';
628	for (q = (u_char *) n; *q; q++) {
629		if ('A' <= *q && *q <= 'Z')
630			*q = *q - 'A' + 'a';
631	}
632
633	/* generate 16 bytes of pseudo-random value. */
634	bzero(&ctxt, sizeof (ctxt));
635	SHA1Init(&ctxt);
636	SHA1Update(&ctxt, &l, sizeof (l));
637	SHA1Update(&ctxt, n, l);
638	SHA1Final(digest, &ctxt);
639
640	bzero(in6, sizeof (*in6));
641	in6->s6_addr16[0] = IPV6_ADDR_INT16_MLL;
642	in6->s6_addr8[11] = 2;
643	in6->s6_addr8[12] = 0xff;
644	/* copy first 3 bytes of prefix into address */
645	bcopy(digest, &in6->s6_addr8[13], 3);
646	if (in6_setscope(in6, ifp, NULL))
647		return (-1); /* XXX: should not fail */
648
649	return (0);
650}
651
652int
653in6_domifattach(struct ifnet *ifp)
654{
655	int error;
656
657	VERIFY(ifp != NULL);
658
659	error = proto_plumb(PF_INET6, ifp);
660	if (error != 0) {
661		if (error != EEXIST)
662			log(LOG_ERR, "%s: proto_plumb returned %d if=%s\n",
663			    __func__, error, if_name(ifp));
664	} else {
665		error = in6_ifattach_prelim(ifp);
666		if (error != 0) {
667			int errorx;
668
669			log(LOG_ERR,
670			    "%s: in6_ifattach_prelim returned %d if=%s%d\n",
671			    __func__, error, ifp->if_name, ifp->if_unit);
672
673			errorx = proto_unplumb(PF_INET6, ifp);
674			if (errorx != 0) /* XXX should not fail */
675				log(LOG_ERR,
676				    "%s: proto_unplumb returned %d if=%s%d\n",
677				    __func__, errorx, ifp->if_name,
678				    ifp->if_unit);
679		}
680	}
681
682	return (error);
683}
684
685int
686in6_ifattach_prelim(struct ifnet *ifp)
687{
688	struct in6_ifextra *ext;
689	void **pbuf, *base;
690	int error = 0;
691
692	VERIFY(ifp != NULL);
693
694	/* quirks based on interface type */
695	switch (ifp->if_type) {
696#if IFT_STF
697	case IFT_STF:
698		/*
699		 * 6to4 interface is a very special kind of beast.
700		 * no multicast, no linklocal.  RFC2529 specifies how to make
701		 * linklocals for 6to4 interface, but there's no use and
702		 * it is rather harmful to have one.
703		 */
704		goto skipmcast;
705#endif
706	default:
707		break;
708	}
709
710	/*
711	 * IPv6 requires multicast capability at the interface.
712	 *   (previously, this was a silent error.)
713	 */
714	if ((ifp->if_flags & IFF_MULTICAST) == 0) {
715		nd6log((LOG_INFO, "in6_ifattach: ",
716		    "%s is not multicast capable, IPv6 not enabled\n",
717		    if_name(ifp)));
718		return (EINVAL);
719	}
720
721#if IFT_STF
722skipmcast:
723#endif
724
725	if (ifp->if_inet6data == NULL) {
726		ext = (struct in6_ifextra *)_MALLOC(in6_extra_size, M_IFADDR,
727		    M_WAITOK|M_ZERO);
728		if (!ext)
729			return (ENOMEM);
730		base = (void *)P2ROUNDUP((intptr_t)ext + sizeof(uint64_t),
731		    sizeof(uint64_t));
732		VERIFY(((intptr_t)base + in6_extra_size) <=
733		    ((intptr_t)ext + in6_extra_bufsize));
734		pbuf = (void **)((intptr_t)base - sizeof(void *));
735		*pbuf = ext;
736		ifp->if_inet6data = base;
737		VERIFY(IS_P2ALIGNED(ifp->if_inet6data, sizeof(uint64_t)));
738	} else {
739		/*
740		 * Since the structure is never freed, we need to zero out
741		 * some of its members. We avoid zeroing out the scope6
742		 * structure on purpose because other threads might be
743		 * using its contents.
744		 */
745		bzero(&IN6_IFEXTRA(ifp)->icmp6_ifstat,
746		    sizeof(IN6_IFEXTRA(ifp)->icmp6_ifstat));
747		bzero(&IN6_IFEXTRA(ifp)->in6_ifstat,
748		    sizeof(IN6_IFEXTRA(ifp)->in6_ifstat));
749	}
750
751	/* initialize NDP variables */
752	if ((error = nd6_ifattach(ifp)) != 0)
753		return (error);
754
755	scope6_ifattach(ifp);
756
757	/* initialize loopback interface address */
758	if ((ifp->if_flags & IFF_LOOPBACK) != 0) {
759		error = in6_ifattach_loopback(ifp);
760		if (error != 0) {
761			log(LOG_ERR, "%s: in6_ifattach_loopback returned %d\n",
762			    __func__, error, ifp->if_name,
763			    ifp->if_unit);
764			return (error);
765		}
766	}
767
768	/* update dynamically. */
769	if (in6_maxmtu < ifp->if_mtu)
770		in6_maxmtu = ifp->if_mtu;
771
772	VERIFY(error == 0);
773	return (0);
774}
775
776int
777in6_ifattach_aliasreq(struct ifnet *ifp, struct ifnet *altifp,
778    struct in6_aliasreq *ifra0)
779{
780	int error;
781	struct in6_ifaddr *ia6;
782	struct in6_aliasreq ifra;
783
784	error = in6_ifattach_prelim(ifp);
785	if (error != 0)
786		return (error);
787
788	if (!ip6_auto_linklocal)
789		return (0);
790
791	/* assign a link-local address, only if there isn't one here already. */
792	ia6 = in6ifa_ifpforlinklocal(ifp, 0);
793	if (ia6 != NULL) {
794		IFA_REMREF(&ia6->ia_ifa);
795		return (0);
796	}
797
798	bzero(&ifra, sizeof (ifra));
799
800	/*
801	 * in6_update_ifa() does not use ifra_name, but we accurately set it
802	 * for safety.
803	 */
804	strncpy(ifra.ifra_name, if_name(ifp), sizeof (ifra.ifra_name));
805
806	/* Initialize the IPv6 interface address in our in6_aliasreq block */
807	if ((ifp->if_eflags & IFEF_NOAUTOIPV6LL) != 0 && ifra0 != NULL) {
808		/* interface provided both addresses for us */
809		struct sockaddr_in6 *sin6 = &ifra.ifra_addr;
810		struct in6_addr *in6 = &sin6->sin6_addr;
811		boolean_t ok = TRUE;
812
813		bcopy(&ifra0->ifra_addr, sin6, sizeof (struct sockaddr_in6));
814
815		if (sin6->sin6_family != AF_INET6 || sin6->sin6_port != 0)
816			ok = FALSE;
817		if (ok && (in6->s6_addr16[0] != htons(0xfe80)))
818			ok = FALSE;
819		if (ok) {
820			if (sin6->sin6_scope_id == 0 && in6->s6_addr16[1] == 0)
821				in6->s6_addr16[1] = htons(ifp->if_index);
822			else if (sin6->sin6_scope_id != 0 &&
823			    sin6->sin6_scope_id != ifp->if_index)
824				ok = FALSE;
825			else if (in6->s6_addr16[1] != 0 &&
826			    ntohs(in6->s6_addr16[1]) != ifp->if_index)
827				ok = FALSE;
828		}
829		if (ok && (in6->s6_addr32[1] != 0))
830			ok = FALSE;
831		if (!ok)
832			return (EINVAL);
833	} else {
834		ifra.ifra_addr.sin6_family = AF_INET6;
835		ifra.ifra_addr.sin6_len = sizeof (struct sockaddr_in6);
836		ifra.ifra_addr.sin6_addr.s6_addr16[0] = htons(0xfe80);
837		ifra.ifra_addr.sin6_addr.s6_addr16[1] = htons(ifp->if_index);
838		ifra.ifra_addr.sin6_addr.s6_addr32[1] = 0;
839		if ((ifp->if_flags & IFF_LOOPBACK) != 0) {
840			ifra.ifra_addr.sin6_addr.s6_addr32[2] = 0;
841			ifra.ifra_addr.sin6_addr.s6_addr32[3] = htonl(1);
842		} else {
843			if (in6_select_iid_from_all_hw(ifp, altifp,
844			    &ifra.ifra_addr.sin6_addr) != 0) {
845				nd6log((LOG_ERR, "%s: no IID available\n",
846				    if_name(ifp)));
847				return (EADDRNOTAVAIL);
848			}
849		}
850	}
851
852	if (in6_setscope(&ifra.ifra_addr.sin6_addr, ifp, NULL))
853		return (EADDRNOTAVAIL);
854
855	/* Set the prefix mask */
856	ifra.ifra_prefixmask.sin6_len = sizeof (struct sockaddr_in6);
857	ifra.ifra_prefixmask.sin6_family = AF_INET6;
858	ifra.ifra_prefixmask.sin6_addr = in6mask64;
859
860	/* link-local addresses should NEVER expire. */
861	ifra.ifra_lifetime.ia6t_vltime = ND6_INFINITE_LIFETIME;
862	ifra.ifra_lifetime.ia6t_pltime = ND6_INFINITE_LIFETIME;
863
864	/* Attach the link-local address */
865	if (in6_ifattach_linklocal(ifp, &ifra) != 0) {
866		nd6log((LOG_INFO,
867		    "%s: %s could not attach link-local address.\n",
868		    __func__, if_name(ifp)));
869		/* NB: not an error */
870	}
871
872	return (0);
873}
874
875int
876in6_ifattach_llstartreq(struct ifnet *ifp, struct in6_llstartreq *llsr)
877{
878	struct in6_aliasreq ifra;
879	struct in6_ifaddr *ia6;
880	struct nd_ifinfo *ndi;
881	int error;
882
883	VERIFY(llsr != NULL);
884
885	error = in6_ifattach_prelim(ifp);
886	if (error != 0)
887		return (error);
888
889	if (!ip6_auto_linklocal || (ifp->if_eflags & IFEF_NOAUTOIPV6LL) != 0)
890		return (0);
891
892	if (nd6_send_opstate == ND6_SEND_OPMODE_DISABLED)
893		return (ENXIO);
894
895	lck_rw_lock_shared(nd_if_rwlock);
896	ndi = ND_IFINFO(ifp);
897	VERIFY(ndi != NULL && ndi->initialized);
898	if ((ndi->flags & ND6_IFF_INSECURE) != 0) {
899		lck_rw_done(nd_if_rwlock);
900		return (ENXIO);
901	}
902	lck_rw_done(nd_if_rwlock);
903
904	/* assign a link-local address, only if there isn't one here already. */
905	ia6 = in6ifa_ifpforlinklocal(ifp, 0);
906	if (ia6 != NULL) {
907		IFA_REMREF(&ia6->ia_ifa);
908		return (0);
909	}
910
911	bzero(&ifra, sizeof (ifra));
912	strncpy(ifra.ifra_name, if_name(ifp), sizeof (ifra.ifra_name));
913
914	ifra.ifra_addr.sin6_family = AF_INET6;
915	ifra.ifra_addr.sin6_len = sizeof (struct sockaddr_in6);
916	ifra.ifra_addr.sin6_addr.s6_addr16[0] = htons(0xfe80);
917	ifra.ifra_addr.sin6_addr.s6_addr16[1] = htons(ifp->if_index);
918	ifra.ifra_addr.sin6_addr.s6_addr32[1] = 0;
919	ifra.ifra_flags = IN6_IFF_SECURED;
920
921	in6_cga_node_lock();
922	if (in6_cga_generate(&llsr->llsr_cgaprep, 0,
923	    &ifra.ifra_addr.sin6_addr)) {
924		in6_cga_node_unlock();
925		return (EADDRNOTAVAIL);
926	}
927	in6_cga_node_unlock();
928
929	if (in6_setscope(&ifra.ifra_addr.sin6_addr, ifp, NULL))
930		return (EADDRNOTAVAIL);
931
932	/* Set the prefix mask */
933	ifra.ifra_prefixmask.sin6_len = sizeof (struct sockaddr_in6);
934	ifra.ifra_prefixmask.sin6_family = AF_INET6;
935	ifra.ifra_prefixmask.sin6_addr = in6mask64;
936
937	/*
938	 * link-local addresses should NEVER expire, but cryptographic
939	 * ones may have finite preferred lifetime [if it's important to
940	 * keep them from being used by applications as persistent device
941	 * identifiers].
942	 */
943	ifra.ifra_lifetime.ia6t_vltime = ND6_INFINITE_LIFETIME;
944	ifra.ifra_lifetime.ia6t_pltime = llsr->llsr_lifetime.ia6t_pltime;
945
946	/* Attach the link-local address */
947	if (in6_ifattach_linklocal(ifp, &ifra) != 0) {
948		/* NB: not an error */
949		nd6log((LOG_INFO,
950		    "%s: %s could not attach link-local address.\n",
951		    __func__, if_name(ifp)));
952	}
953
954	VERIFY(error == 0);
955	return (error);
956}
957
958/*
959 * NOTE: in6_ifdetach() does not support loopback if at this moment.
960 */
961void
962in6_ifdetach(struct ifnet *ifp)
963{
964	struct in6_ifaddr *ia, *oia;
965	struct ifaddr *ifa;
966	struct rtentry *rt;
967	struct sockaddr_in6 sin6;
968	struct in6_multi_mship *imm;
969	int unlinked;
970
971	lck_mtx_assert(nd6_mutex, LCK_MTX_ASSERT_NOTOWNED);
972
973	/* remove neighbor management table */
974	nd6_purge(ifp);
975
976	/* nuke any of IPv6 addresses we have */
977	lck_rw_lock_exclusive(&in6_ifaddr_rwlock);
978	ia = in6_ifaddrs;
979	while (ia != NULL) {
980		if (ia->ia_ifa.ifa_ifp != ifp) {
981			ia = ia->ia_next;
982			continue;
983		}
984		IFA_ADDREF(&ia->ia_ifa);	/* for us */
985		lck_rw_done(&in6_ifaddr_rwlock);
986		in6_purgeaddr(&ia->ia_ifa);
987		IFA_REMREF(&ia->ia_ifa);	/* for us */
988		lck_rw_lock_exclusive(&in6_ifaddr_rwlock);
989		/*
990		 * Purging the address caused in6_ifaddr_rwlock
991		 * to be dropped and reacquired;
992		 * therefore search again from the beginning
993		 * of in6_ifaddrs list.
994		 */
995		ia = in6_ifaddrs;
996	}
997	lck_rw_done(&in6_ifaddr_rwlock);
998
999	ifnet_lock_exclusive(ifp);
1000
1001	/* undo everything done by in6_ifattach(), just in case */
1002	ifa = TAILQ_FIRST(&ifp->if_addrlist);
1003	while (ifa != NULL) {
1004		IFA_LOCK(ifa);
1005		if (ifa->ifa_addr->sa_family != AF_INET6 ||
1006		    !IN6_IS_ADDR_LINKLOCAL(&satosin6(&ifa->ifa_addr)->
1007		    sin6_addr)) {
1008			IFA_UNLOCK(ifa);
1009			ifa = TAILQ_NEXT(ifa, ifa_list);
1010			continue;
1011		}
1012
1013		ia = (struct in6_ifaddr *)ifa;
1014
1015		/* hold a reference for this routine */
1016		IFA_ADDREF_LOCKED(ifa);
1017		/* remove from the linked list */
1018		if_detach_ifa(ifp, ifa);
1019		IFA_UNLOCK(ifa);
1020
1021		/*
1022		 * Leaving the multicast group(s) may involve freeing the
1023		 * link address multicast structure(s) for the interface,
1024		 * which is protected by ifnet lock.  To avoid violating
1025		 * lock ordering, we must drop ifnet lock before doing so.
1026		 * The ifa won't go away since we held a refcnt above.
1027		 */
1028		ifnet_lock_done(ifp);
1029
1030		/*
1031		 * We have to do this work manually here instead of calling
1032		 * in6_purgeaddr() since in6_purgeaddr() uses the RTM_HOST flag.
1033		 */
1034
1035		/*
1036		 * leave from multicast groups we have joined for the interface
1037		 */
1038		IFA_LOCK(ifa);
1039		while ((imm = ia->ia6_memberships.lh_first) != NULL) {
1040			LIST_REMOVE(imm, i6mm_chain);
1041			IFA_UNLOCK(ifa);
1042			in6_leavegroup(imm);
1043			IFA_LOCK(ifa);
1044		}
1045
1046		/* remove from the routing table */
1047		if (ia->ia_flags & IFA_ROUTE) {
1048			IFA_UNLOCK(ifa);
1049			rt = rtalloc1((struct sockaddr *)&ia->ia_addr, 0, 0);
1050			if (rt != NULL) {
1051				(void) rtrequest(RTM_DELETE,
1052					(struct sockaddr *)&ia->ia_addr,
1053					(struct sockaddr *)&ia->ia_addr,
1054					(struct sockaddr *)&ia->ia_prefixmask,
1055					rt->rt_flags, (struct rtentry **)0);
1056				rtfree(rt);
1057			}
1058		} else {
1059			IFA_UNLOCK(ifa);
1060		}
1061
1062		/* also remove from the IPv6 address chain(itojun&jinmei) */
1063		unlinked = 1;
1064		oia = ia;
1065		lck_rw_lock_exclusive(&in6_ifaddr_rwlock);
1066		if (oia == (ia = in6_ifaddrs)) {
1067			in6_ifaddrs = ia->ia_next;
1068		} else {
1069			while (ia->ia_next && (ia->ia_next != oia))
1070				ia = ia->ia_next;
1071			if (ia->ia_next) {
1072				ia->ia_next = oia->ia_next;
1073			} else {
1074				nd6log((LOG_ERR,
1075				    "%s: didn't unlink in6ifaddr from "
1076				    "list\n", if_name(ifp)));
1077				unlinked = 0;
1078			}
1079		}
1080		lck_rw_done(&in6_ifaddr_rwlock);
1081
1082		ifa = &oia->ia_ifa;
1083		/*
1084		 * release another refcnt for the link from in6_ifaddrs.
1085		 * Do this only if it's not already unlinked in the event
1086		 * that we lost the race, since in6_ifaddr_rwlock was
1087		 * momentarily dropped above.
1088		 */
1089		if (unlinked)
1090			IFA_REMREF(ifa);
1091		/* release reference held for this routine */
1092		IFA_REMREF(ifa);
1093
1094		/*
1095		 * This is suboptimal, but since we dropped ifnet lock above
1096		 * the list might have changed.  Repeat the search from the
1097		 * beginning until we find the first eligible IPv6 address.
1098		 */
1099		ifnet_lock_exclusive(ifp);
1100		ifa = TAILQ_FIRST(&ifp->if_addrlist);
1101	}
1102	ifnet_lock_done(ifp);
1103
1104	/* invalidate route caches */
1105	routegenid_inet6_update();
1106
1107	/*
1108	 * remove neighbor management table.  we call it twice just to make
1109	 * sure we nuke everything.  maybe we need just one call.
1110	 * XXX: since the first call did not release addresses, some prefixes
1111	 * might remain.  We should call nd6_purge() again to release the
1112	 * prefixes after removing all addresses above.
1113	 * (Or can we just delay calling nd6_purge until at this point?)
1114	 */
1115	nd6_purge(ifp);
1116
1117	/* remove route to link-local allnodes multicast (ff02::1) */
1118	bzero(&sin6, sizeof (sin6));
1119	sin6.sin6_len = sizeof (struct sockaddr_in6);
1120	sin6.sin6_family = AF_INET6;
1121	sin6.sin6_addr = in6addr_linklocal_allnodes;
1122	sin6.sin6_addr.s6_addr16[1] = htons(ifp->if_index);
1123	rt = rtalloc1((struct sockaddr *)&sin6, 0, 0);
1124	if (rt != NULL) {
1125		RT_LOCK(rt);
1126		if (rt->rt_ifp == ifp) {
1127			/*
1128			 * Prevent another thread from modifying rt_key,
1129			 * rt_gateway via rt_setgate() after the rt_lock
1130			 * is dropped by marking the route as defunct.
1131			 */
1132			rt->rt_flags |= RTF_CONDEMNED;
1133			RT_UNLOCK(rt);
1134			(void) rtrequest(RTM_DELETE, rt_key(rt), rt->rt_gateway,
1135			    rt_mask(rt), rt->rt_flags, 0);
1136		} else {
1137			RT_UNLOCK(rt);
1138		}
1139		rtfree(rt);
1140	}
1141}
1142
1143void
1144in6_iid_mktmp(struct ifnet *ifp, u_int8_t *retbuf, const u_int8_t *baseid,
1145    int generate)
1146{
1147	u_int8_t nullbuf[8];
1148	struct nd_ifinfo *ndi;
1149
1150	lck_rw_lock_shared(nd_if_rwlock);
1151	ndi = ND_IFINFO(ifp);
1152	VERIFY(ndi != NULL && ndi->initialized);
1153	lck_mtx_lock(&ndi->lock);
1154	bzero(nullbuf, sizeof (nullbuf));
1155	if (bcmp(ndi->randomid, nullbuf, sizeof (nullbuf)) == 0) {
1156		/* we've never created a random ID.  Create a new one. */
1157		generate = 1;
1158	}
1159
1160	if (generate) {
1161		bcopy(baseid, ndi->randomseed1, sizeof (ndi->randomseed1));
1162
1163		/* in6_generate_tmp_iid will update seedn and buf */
1164		(void) in6_generate_tmp_iid(ndi->randomseed0, ndi->randomseed1,
1165		    ndi->randomid);
1166	}
1167
1168	bcopy(ndi->randomid, retbuf, 8);
1169	lck_mtx_unlock(&ndi->lock);
1170	lck_rw_done(nd_if_rwlock);
1171}
1172
1173void
1174in6_tmpaddrtimer(void *arg)
1175{
1176#pragma unused(arg)
1177	int i;
1178	struct nd_ifinfo *ndi;
1179	u_int8_t nullbuf[8];
1180
1181	timeout(in6_tmpaddrtimer, (caddr_t)0, (ip6_temp_preferred_lifetime -
1182	    ip6_desync_factor - ip6_temp_regen_advance) * hz);
1183
1184	lck_rw_lock_shared(nd_if_rwlock);
1185	bzero(nullbuf, sizeof (nullbuf));
1186	for (i = 1; i < if_index + 1; i++) {
1187		if (!nd_ifinfo || i >= nd_ifinfo_indexlim)
1188			break;
1189		ndi = &nd_ifinfo[i];
1190		if (!ndi->initialized)
1191			continue;
1192		lck_mtx_lock(&ndi->lock);
1193		if (bcmp(ndi->randomid, nullbuf, sizeof (nullbuf)) != 0) {
1194			/*
1195			 * We've been generating a random ID on this interface.
1196			 * Create a new one.
1197			 */
1198			(void) in6_generate_tmp_iid(ndi->randomseed0,
1199			    ndi->randomseed1, ndi->randomid);
1200		}
1201		lck_mtx_unlock(&ndi->lock);
1202	}
1203	lck_rw_done(nd_if_rwlock);
1204}
1205