xref: /freebsd/sys/netinet6/mld6.c (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
1 /*
2  * Copyright (C) 1998 WIDE Project.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the project nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 /*
33  * Copyright (c) 1988 Stephen Deering.
34  * Copyright (c) 1992, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * This code is derived from software contributed to Berkeley by
38  * Stephen Deering of Stanford University.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  * 1. Redistributions of source code must retain the above copyright
44  *    notice, this list of conditions and the following disclaimer.
45  * 2. Redistributions in binary form must reproduce the above copyright
46  *    notice, this list of conditions and the following disclaimer in the
47  *    documentation and/or other materials provided with the distribution.
48  * 3. All advertising materials mentioning features or use of this software
49  *    must display the following acknowledgement:
50  *	This product includes software developed by the University of
51  *	California, Berkeley and its contributors.
52  * 4. Neither the name of the University nor the names of its contributors
53  *    may be used to endorse or promote products derived from this software
54  *    without specific prior written permission.
55  *
56  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
57  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
58  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
59  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
60  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
61  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
62  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
64  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
65  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66  * SUCH DAMAGE.
67  *
68  *	@(#)igmp.c	8.1 (Berkeley) 7/19/93
69  */
70 
71 #include "opt_ipsec.h"
72 
73 #include <sys/param.h>
74 #include <sys/systm.h>
75 #include <sys/mbuf.h>
76 #include <sys/socket.h>
77 #include <sys/protosw.h>
78 #include <sys/syslog.h>
79 
80 #include <net/if.h>
81 
82 #include <netinet/in.h>
83 #include <netinet/in_var.h>
84 #include <netinet6/in6.h>
85 #include <netinet6/ip6.h>
86 #include <netinet6/ip6_var.h>
87 #include <netinet6/icmp6.h>
88 #include <netinet6/mld6_var.h>
89 
90 #include <net/net_osdep.h>
91 
92 /*
93  * Protocol constants
94  */
95 
96 /* denotes that the MLD max response delay field specifies time in milliseconds */
97 #define	MLD6_TIMER_SCALE	1000
98 /*
99  * time between repetitions of a node's initial report of interest in a
100  * multicast address(in seconds)
101  */
102 #define	MLD6_UNSOLICITED_REPORT_INTERVAL	10
103 
104 static struct	ip6_pktopts ip6_opts;
105 static int	mld6_timers_are_running;
106 /* XXX: These are necessary for KAME's link-local hack */
107 static struct	in6_addr mld6_all_nodes_linklocal =
108 			IN6ADDR_LINKLOCAL_ALLNODES_INIT;
109 static struct	in6_addr mld6_all_routers_linklocal =
110 			IN6ADDR_LINKLOCAL_ALLROUTERS_INIT;
111 
112 static void	mld6_sendpkt __P((struct in6_multi *, int,
113 				  const struct in6_addr *));
114 
115 void
116 mld6_init()
117 {
118 	static u_int8_t hbh_buf[8];
119 	struct ip6_hbh *hbh = (struct ip6_hbh *)hbh_buf;
120 	u_int16_t rtalert_code = htons((u_int16_t)IP6OPT_RTALERT_MLD);
121 
122 	mld6_timers_are_running = 0;
123 
124 	/* ip6h_nxt will be fill in later */
125 	hbh->ip6h_len = 0;	/* (8 >> 3) - 1*/
126 
127 	/* XXX: grotty hard coding... */
128 	hbh_buf[2] = IP6OPT_PADN;	/* 2 byte padding */
129 	hbh_buf[3] = 0;
130 	hbh_buf[4] = IP6OPT_RTALERT;
131 	hbh_buf[5] = IP6OPT_RTALERT_LEN - 2;
132 	bcopy((caddr_t)&rtalert_code, &hbh_buf[6], sizeof(u_int16_t));
133 
134 	ip6_opts.ip6po_hbh = hbh;
135 	/* We will specify the hoplimit by a multicast option. */
136 	ip6_opts.ip6po_hlim = -1;
137 }
138 
139 void
140 mld6_start_listening(in6m)
141 	struct in6_multi *in6m;
142 {
143 	int s = splnet();
144 
145 	/*
146 	 * (draft-ietf-ipngwg-mld, page 10)
147 	 * The node never sends a Report or Done for the link-scope all-nodes
148 	 * address.
149 	 * MLD messages are never sent for multicast addresses whose scope is 0
150 	 * (reserved) or 1 (node-local).
151 	 */
152 	mld6_all_nodes_linklocal.s6_addr16[1] =
153 		htons(in6m->in6m_ifp->if_index); /* XXX */
154 	if (IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr, &mld6_all_nodes_linklocal) ||
155 	    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) < IPV6_ADDR_SCOPE_LINKLOCAL) {
156 		in6m->in6m_timer = 0;
157 		in6m->in6m_state = MLD6_OTHERLISTENER;
158 	} else {
159 		mld6_sendpkt(in6m, MLD6_LISTENER_REPORT, NULL);
160 		in6m->in6m_timer = MLD6_RANDOM_DELAY(
161 			MLD6_UNSOLICITED_REPORT_INTERVAL * PR_FASTHZ);
162 		in6m->in6m_state = MLD6_IREPORTEDLAST;
163 		mld6_timers_are_running = 1;
164 	}
165 	splx(s);
166 }
167 
168 void
169 mld6_stop_listening(in6m)
170 	struct in6_multi *in6m;
171 {
172 	mld6_all_nodes_linklocal.s6_addr16[1] =
173 		htons(in6m->in6m_ifp->if_index); /* XXX */
174 	mld6_all_routers_linklocal.s6_addr16[1] =
175 		htons(in6m->in6m_ifp->if_index); /* XXX: necessary when mrouting */
176 
177 	if (in6m->in6m_state == MLD6_IREPORTEDLAST &&
178 	    (!IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr, &mld6_all_nodes_linklocal)) &&
179 	    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) > IPV6_ADDR_SCOPE_NODELOCAL)
180 		mld6_sendpkt(in6m, MLD6_LISTENER_DONE,
181 			     &mld6_all_routers_linklocal);
182 }
183 
184 void
185 mld6_input(m, off)
186 	struct mbuf *m;
187 	int off;
188 {
189 	struct ip6_hdr *ip6 = mtod(m, struct ip6_hdr *);
190 	struct mld6_hdr *mldh = (struct mld6_hdr *)(mtod(m, caddr_t) + off);
191 	struct ifnet *ifp = m->m_pkthdr.rcvif;
192 	struct in6_multi *in6m;
193 	struct in6_ifaddr *ia;
194 	struct ifmultiaddr *ifma;
195 	int timer;		/* timer value in the MLD query header */
196 
197 	/* source address validation */
198 	if (!IN6_IS_ADDR_LINKLOCAL(&ip6->ip6_src)) {
199 		log(LOG_ERR,
200 		    "mld6_input: src %s is not link-local\n",
201 		    ip6_sprintf(&ip6->ip6_src));
202 		/*
203 		 * spec(draft-ietf-ipngwg-mld) does not explicitly
204 		 * specify to discard the packet from a non link-local
205 		 * source address. But we believe it's expected to do so.
206 		 */
207 		return;
208 	}
209 
210 	/*
211 	 * In the MLD6 specification, there are 3 states and a flag.
212 	 *
213 	 * In Non-Listener state, we simply don't have a membership record.
214 	 * In Delaying Listener state, our timer is running (in6m->in6m_timer)
215 	 * In Idle Listener state, our timer is not running (in6m->in6m_timer==0)
216 	 *
217 	 * The flag is in6m->in6m_state, it is set to MLD6_OTHERLISTENER if
218 	 * we have heard a report from another member, or MLD6_IREPORTEDLAST
219 	 * if we sent the last report.
220 	 */
221 	switch(mldh->mld6_type) {
222 	case MLD6_LISTENER_QUERY:
223 		if (ifp->if_flags & IFF_LOOPBACK)
224 			break;
225 
226 		if (!IN6_IS_ADDR_UNSPECIFIED(&mldh->mld6_addr) &&
227 		!IN6_IS_ADDR_MULTICAST(&mldh->mld6_addr))
228 			break;	/* print error or log stat? */
229 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
230 			mldh->mld6_addr.s6_addr16[1] =
231 				htons(ifp->if_index); /* XXX */
232 
233 		/*
234 		* - Start the timers in all of our membership records
235 		*   that the query applies to for the interface on
236 		*   which the query arrived excl. those that belong
237 		*   to the "all-nodes" group (ff02::1).
238 		* - Restart any timer that is already running but has
239 		*   A value longer than the requested timeout.
240 		* - Use the value specified in the query message as
241 		*   the maximum timeout.
242 		*/
243 		IFP_TO_IA6(ifp, ia);
244 		if (ia == NULL)
245 			break;
246 
247 		/*
248 		* XXX: System timer resolution is too low to handle Max
249 		* Response Delay, so set 1 to the internal timer even if
250 		* the calculated value equals to zero when Max Response
251 		* Delay is positive.
252 		*/
253 		timer = ntohs(mldh->mld6_maxdelay)*PR_FASTHZ/MLD6_TIMER_SCALE;
254 		if (timer == 0 && mldh->mld6_maxdelay)
255 			timer = 1;
256 		mld6_all_nodes_linklocal.s6_addr16[1] =
257 			htons(ifp->if_index); /* XXX */
258 
259 		LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link)
260 		{
261 			if (ifma->ifma_addr->sa_family != AF_INET6)
262 				continue;
263 			in6m = (struct in6_multi *)ifma->ifma_protospec;
264 			if (IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr,
265 					&mld6_all_nodes_linklocal) ||
266 			    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) <
267 			    IPV6_ADDR_SCOPE_LINKLOCAL)
268 				continue;
269 
270 			if (IN6_IS_ADDR_UNSPECIFIED(&mldh->mld6_addr) ||
271 			    IN6_ARE_ADDR_EQUAL(&mldh->mld6_addr,
272 						&in6m->in6m_addr))
273 			{
274 				if (timer == 0) {
275 					/* send a report immediately */
276 					mld6_sendpkt(in6m, MLD6_LISTENER_REPORT,
277 						NULL);
278 					in6m->in6m_timer = 0; /* reset timer */
279 					in6m->in6m_state = MLD6_IREPORTEDLAST;
280 				} else if (in6m->in6m_timer == 0 || /*idle state*/
281 					in6m->in6m_timer > timer) {
282 					in6m->in6m_timer =
283 						MLD6_RANDOM_DELAY(timer);
284 					mld6_timers_are_running = 1;
285 				}
286 			}
287 		}
288 
289 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
290 			mldh->mld6_addr.s6_addr16[1] = 0; /* XXX */
291 		break;
292 	case MLD6_LISTENER_REPORT:
293 		/*
294 		* For fast leave to work, we have to know that we are the
295 		* last person to send a report for this group.  Reports
296 		* can potentially get looped back if we are a multicast
297 		* router, so discard reports sourced by me.
298 		* Note that it is impossible to check IFF_LOOPBACK flag of
299 		* ifp for this purpose, since ip6_mloopback pass the physical
300 		* interface to looutput.
301 		*/
302 		if (m->m_flags & M_LOOP) /* XXX: grotty flag, but efficient */
303 			break;
304 
305 		if (!IN6_IS_ADDR_MULTICAST(&mldh->mld6_addr))
306 			break;
307 
308 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
309 			mldh->mld6_addr.s6_addr16[1] =
310 				htons(ifp->if_index); /* XXX */
311 		/*
312 		* If we belong to the group being reported, stop
313 		* our timer for that group.
314 		*/
315 		IN6_LOOKUP_MULTI(mldh->mld6_addr, ifp, in6m);
316 		if (in6m) {
317 			in6m->in6m_timer = 0; /* transit to idle state */
318 			in6m->in6m_state = MLD6_OTHERLISTENER; /* clear flag */
319 		}
320 
321 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
322 			mldh->mld6_addr.s6_addr16[1] = 0; /* XXX */
323 		break;
324 	default:		/* this is impossible */
325 		log(LOG_ERR, "mld6_input: illegal type(%d)", mldh->mld6_type);
326 		break;
327 	}
328 }
329 
330 void
331 mld6_fasttimeo()
332 {
333 	register struct in6_multi *in6m;
334 	struct in6_multistep step;
335 	int s;
336 
337 	/*
338 	 * Quick check to see if any work needs to be done, in order
339 	 * to minimize the overhead of fasttimo processing.
340 	 */
341 	if (!mld6_timers_are_running)
342 		return;
343 
344 	s = splnet();
345 	mld6_timers_are_running = 0;
346 	IN6_FIRST_MULTI(step, in6m);
347 	while (in6m != NULL) {
348 		if (in6m->in6m_timer == 0) {
349 			/* do nothing */
350 		} else if (--in6m->in6m_timer == 0) {
351 			mld6_sendpkt(in6m, MLD6_LISTENER_REPORT, NULL);
352 			in6m->in6m_state = MLD6_IREPORTEDLAST;
353 		} else {
354 			mld6_timers_are_running = 1;
355 		}
356 		IN6_NEXT_MULTI(step, in6m);
357 	}
358 	splx(s);
359 }
360 
361 static void
362 mld6_sendpkt(in6m, type, dst)
363 	struct in6_multi *in6m;
364 	int type;
365 	const struct in6_addr *dst;
366 {
367 	struct mbuf *mh, *md;
368 	struct mld6_hdr *mldh;
369 	struct ip6_hdr *ip6;
370 	struct ip6_moptions im6o;
371 	struct in6_ifaddr *ia;
372 	struct ifnet *ifp = in6m->in6m_ifp;
373 	struct ifnet *outif = NULL;
374 
375 	/*
376 	 * At first, find a link local address on the outgoing interface
377 	 * to use as the source address of the MLD packet.
378 	 */
379 	if ((ia = in6ifa_ifpforlinklocal(ifp)) == NULL)
380 		return;
381 
382 	/*
383 	 * Allocate mbufs to store ip6 header and MLD header.
384 	 * We allocate 2 mbufs and make chain in advance because
385 	 * it is more convenient when inserting the hop-by-hop option later.
386 	 */
387 	MGETHDR(mh, M_DONTWAIT, MT_HEADER);
388 	if (mh == NULL)
389 		return;
390 	MGET(md, M_DONTWAIT, MT_DATA);
391 	if (md == NULL) {
392 		m_free(mh);
393 		return;
394 	}
395 	mh->m_next = md;
396 	mh->m_pkthdr.len = sizeof(struct ip6_hdr) + sizeof(struct mld6_hdr);
397 	mh->m_len = sizeof(struct ip6_hdr);
398 	MH_ALIGN(mh, sizeof(struct ip6_hdr));
399 
400 	/* fill in the ip6 header */
401 	ip6 = mtod(mh, struct ip6_hdr *);
402 	ip6->ip6_flow = 0;
403 	ip6->ip6_vfc = IPV6_VERSION;
404 	/* ip6_plen will be set later */
405 	ip6->ip6_nxt = IPPROTO_ICMPV6;
406 	/* ip6_hlim will be set by im6o.im6o_multicast_hlim */
407 	ip6->ip6_src = ia->ia_addr.sin6_addr;
408 	ip6->ip6_dst = dst ? *dst : in6m->in6m_addr;
409 
410 	/* fill in the MLD header */
411 	md->m_len = sizeof(struct mld6_hdr);
412 	mldh = mtod(md, struct mld6_hdr *);
413 	mldh->mld6_type = type;
414 	mldh->mld6_code = 0;
415 	mldh->mld6_cksum = 0;
416 	/* XXX: we assume the function will not be called for query messages */
417 	mldh->mld6_maxdelay = 0;
418 	mldh->mld6_reserved = 0;
419 	mldh->mld6_addr = in6m->in6m_addr;
420 	if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
421 		mldh->mld6_addr.s6_addr16[1] = 0; /* XXX */
422 	mldh->mld6_cksum = in6_cksum(mh, IPPROTO_ICMPV6, sizeof(struct ip6_hdr),
423 				     sizeof(struct mld6_hdr));
424 
425 	/* construct multicast option */
426 	bzero(&im6o, sizeof(im6o));
427 	im6o.im6o_multicast_ifp = ifp;
428 	im6o.im6o_multicast_hlim = 1;
429 
430 	/*
431 	 * Request loopback of the report if we are acting as a multicast
432 	 * router, so that the process-level routing daemon can hear it.
433 	 */
434 	im6o.im6o_multicast_loop = 0;
435 
436 	/* increment output statictics */
437 	icmp6stat.icp6s_outhist[type]++;
438 
439 	ip6_output(mh, &ip6_opts, NULL, 0, &im6o, &outif);
440 	if (outif) {
441 		icmp6_ifstat_inc(outif, ifs6_out_msg);
442 		switch(type) {
443 		 case MLD6_LISTENER_QUERY:
444 			 icmp6_ifstat_inc(outif, ifs6_out_mldquery);
445 			 break;
446 		 case MLD6_LISTENER_REPORT:
447 			 icmp6_ifstat_inc(outif, ifs6_out_mldreport);
448 			 break;
449 		 case MLD6_LISTENER_DONE:
450 			 icmp6_ifstat_inc(outif, ifs6_out_mlddone);
451 			 break;
452 		}
453 	}
454 }
455