xref: /freebsd/sys/netinet/icmp6.h (revision d5b0e70f7e04d971691517ce1304d86a1e367e2e)
1 /*	$FreeBSD$	*/
2 /*	$KAME: icmp6.h,v 1.46 2001/04/27 15:09:48 itojun Exp $	*/
3 
4 /*-
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the project nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 /*-
36  * Copyright (c) 1982, 1986, 1993
37  *	The Regents of the University of California.  All rights reserved.
38  *
39  * Redistribution and use in source and binary forms, with or without
40  * modification, are permitted provided that the following conditions
41  * are met:
42  * 1. Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  * 2. Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in the
46  *    documentation and/or other materials provided with the distribution.
47  * 3. Neither the name of the University nor the names of its contributors
48  *    may be used to endorse or promote products derived from this software
49  *    without specific prior written permission.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
61  * SUCH DAMAGE.
62  *
63  *	@(#)ip_icmp.h	8.1 (Berkeley) 6/10/93
64  */
65 
66 #ifndef _NETINET_ICMP6_H_
67 #define _NETINET_ICMP6_H_
68 
69 #define ICMPV6_PLD_MAXLEN	1232	/* IPV6_MMTU - sizeof(struct ip6_hdr)
70 					   - sizeof(struct icmp6_hdr) */
71 
72 struct icmp6_hdr {
73 	u_int8_t	icmp6_type;	/* type field */
74 	u_int8_t	icmp6_code;	/* code field */
75 	u_int16_t	icmp6_cksum;	/* checksum field */
76 	union {
77 		u_int32_t	icmp6_un_data32[1]; /* type-specific field */
78 		u_int16_t	icmp6_un_data16[2]; /* type-specific field */
79 		u_int8_t	icmp6_un_data8[4];  /* type-specific field */
80 	} icmp6_dataun;
81 } __packed;
82 
83 #define icmp6_data32	icmp6_dataun.icmp6_un_data32
84 #define icmp6_data16	icmp6_dataun.icmp6_un_data16
85 #define icmp6_data8	icmp6_dataun.icmp6_un_data8
86 #define icmp6_pptr	icmp6_data32[0]		/* parameter prob */
87 #define icmp6_mtu	icmp6_data32[0]		/* packet too big */
88 #define icmp6_id	icmp6_data16[0]		/* echo request/reply */
89 #define icmp6_seq	icmp6_data16[1]		/* echo request/reply */
90 #define icmp6_maxdelay	icmp6_data16[0]		/* mcast group membership */
91 
92 #define ICMP6_DST_UNREACH		1	/* dest unreachable, codes: */
93 #define ICMP6_PACKET_TOO_BIG		2	/* packet too big */
94 #define ICMP6_TIME_EXCEEDED		3	/* time exceeded, code: */
95 #define ICMP6_PARAM_PROB		4	/* ip6 header bad */
96 
97 #define ICMP6_ECHO_REQUEST		128	/* echo service */
98 #define ICMP6_ECHO_REPLY		129	/* echo reply */
99 #define MLD_LISTENER_QUERY		130 	/* multicast listener query */
100 #define MLD_LISTENER_REPORT		131	/* multicast listener report */
101 #define MLD_LISTENER_DONE		132	/* multicast listener done */
102 #define MLD_LISTENER_REDUCTION MLD_LISTENER_DONE /* RFC3542 definition */
103 
104 /* RFC2292 decls */
105 #define ICMP6_MEMBERSHIP_QUERY		130	/* group membership query */
106 #define ICMP6_MEMBERSHIP_REPORT		131	/* group membership report */
107 #define ICMP6_MEMBERSHIP_REDUCTION	132	/* group membership termination */
108 
109 #ifndef _KERNEL
110 /* the followings are for backward compatibility to old KAME apps. */
111 #define MLD6_LISTENER_QUERY	MLD_LISTENER_QUERY
112 #define MLD6_LISTENER_REPORT	MLD_LISTENER_REPORT
113 #define MLD6_LISTENER_DONE	MLD_LISTENER_DONE
114 #endif
115 
116 #define ND_ROUTER_SOLICIT		133	/* router solicitation */
117 #define ND_ROUTER_ADVERT		134	/* router advertisement */
118 #define ND_NEIGHBOR_SOLICIT		135	/* neighbor solicitation */
119 #define ND_NEIGHBOR_ADVERT		136	/* neighbor advertisement */
120 #define ND_REDIRECT			137	/* redirect */
121 
122 #define ICMP6_ROUTER_RENUMBERING	138	/* router renumbering */
123 
124 #define ICMP6_WRUREQUEST		139	/* who are you request */
125 #define ICMP6_WRUREPLY			140	/* who are you reply */
126 #define ICMP6_FQDN_QUERY		139	/* FQDN query */
127 #define ICMP6_FQDN_REPLY		140	/* FQDN reply */
128 #define ICMP6_NI_QUERY			139	/* node information request */
129 #define ICMP6_NI_REPLY			140	/* node information reply */
130 #define MLDV2_LISTENER_REPORT		143	/* RFC3810 listener report */
131 
132 /* The definitions below are experimental. TBA */
133 #define MLD_MTRACE_RESP			200	/* mtrace resp (to sender) */
134 #define MLD_MTRACE			201	/* mtrace messages */
135 
136 #ifndef _KERNEL
137 #define MLD6_MTRACE_RESP	MLD_MTRACE_RESP
138 #define MLD6_MTRACE		MLD_MTRACE
139 #endif
140 
141 #define ICMP6_MAXTYPE			201
142 
143 #define ICMP6_DST_UNREACH_NOROUTE	0	/* no route to destination */
144 #define ICMP6_DST_UNREACH_ADMIN	 	1	/* administratively prohibited */
145 #define ICMP6_DST_UNREACH_NOTNEIGHBOR	2	/* not a neighbor(obsolete) */
146 #define ICMP6_DST_UNREACH_BEYONDSCOPE	2	/* beyond scope of source address */
147 #define ICMP6_DST_UNREACH_ADDR		3	/* address unreachable */
148 #define ICMP6_DST_UNREACH_NOPORT	4	/* port unreachable */
149 #define ICMP6_DST_UNREACH_POLICY	5	/* failed ingress/egress policy */
150 #define ICMP6_DST_UNREACH_REJECT	6	/* Reject route to destination */
151 #define ICMP6_DST_UNREACH_SRCROUTE	7	/* Error in source routing header */
152 
153 #define ICMP6_TIME_EXCEED_TRANSIT 	0	/* ttl==0 in transit */
154 #define ICMP6_TIME_EXCEED_REASSEMBLY	1	/* ttl==0 in reass */
155 
156 #define ICMP6_PARAMPROB_HEADER 	 	0	/* erroneous header field */
157 #define ICMP6_PARAMPROB_NEXTHEADER	1	/* unrecognized next header */
158 #define ICMP6_PARAMPROB_OPTION		2	/* unrecognized option */
159 
160 #define ICMP6_INFOMSG_MASK		0x80	/* all informational messages */
161 
162 #define ICMP6_NI_SUBJ_IPV6	0	/* Query Subject is an IPv6 address */
163 #define ICMP6_NI_SUBJ_FQDN	1	/* Query Subject is a Domain name */
164 #define ICMP6_NI_SUBJ_IPV4	2	/* Query Subject is an IPv4 address */
165 
166 #define ICMP6_NI_SUCCESS	0	/* node information successful reply */
167 #define ICMP6_NI_REFUSED	1	/* node information request is refused */
168 #define ICMP6_NI_UNKNOWN	2	/* unknown Qtype */
169 
170 #define ICMP6_ROUTER_RENUMBERING_COMMAND  0	/* rr command */
171 #define ICMP6_ROUTER_RENUMBERING_RESULT   1	/* rr result */
172 #define ICMP6_ROUTER_RENUMBERING_SEQNUM_RESET   255	/* rr seq num reset */
173 
174 /* Used in kernel only */
175 #define ND_REDIRECT_ONLINK	0	/* redirect to an on-link node */
176 #define ND_REDIRECT_ROUTER	1	/* redirect to a better router */
177 
178 /*
179  * Multicast Listener Discovery
180  */
181 struct mld_hdr {
182 	struct icmp6_hdr	mld_icmp6_hdr;
183 	struct in6_addr		mld_addr; /* multicast address */
184 } __packed;
185 
186 /* definitions to provide backward compatibility to old KAME applications */
187 #ifndef _KERNEL
188 #define mld6_hdr	mld_hdr
189 #define mld6_type	mld_type
190 #define mld6_code	mld_code
191 #define mld6_cksum	mld_cksum
192 #define mld6_maxdelay	mld_maxdelay
193 #define mld6_reserved	mld_reserved
194 #define mld6_addr	mld_addr
195 #endif
196 
197 /* shortcut macro definitions */
198 #define mld_type	mld_icmp6_hdr.icmp6_type
199 #define mld_code	mld_icmp6_hdr.icmp6_code
200 #define mld_cksum	mld_icmp6_hdr.icmp6_cksum
201 #define mld_maxdelay	mld_icmp6_hdr.icmp6_data16[0]
202 #define mld_reserved	mld_icmp6_hdr.icmp6_data16[1]
203 #define mld_v2_reserved	mld_icmp6_hdr.icmp6_data16[0]
204 #define mld_v2_numrecs	mld_icmp6_hdr.icmp6_data16[1]
205 
206 /*
207  * Neighbor Discovery
208  */
209 
210 struct nd_router_solicit {	/* router solicitation */
211 	struct icmp6_hdr 	nd_rs_hdr;
212 	/* could be followed by options */
213 } __packed;
214 
215 #define nd_rs_type	nd_rs_hdr.icmp6_type
216 #define nd_rs_code	nd_rs_hdr.icmp6_code
217 #define nd_rs_cksum	nd_rs_hdr.icmp6_cksum
218 #define nd_rs_reserved	nd_rs_hdr.icmp6_data32[0]
219 
220 struct nd_router_advert {	/* router advertisement */
221 	struct icmp6_hdr	nd_ra_hdr;
222 	u_int32_t		nd_ra_reachable;	/* reachable time */
223 	u_int32_t		nd_ra_retransmit;	/* retransmit timer */
224 	/* could be followed by options */
225 } __packed;
226 
227 #define nd_ra_type		nd_ra_hdr.icmp6_type
228 #define nd_ra_code		nd_ra_hdr.icmp6_code
229 #define nd_ra_cksum		nd_ra_hdr.icmp6_cksum
230 #define nd_ra_curhoplimit	nd_ra_hdr.icmp6_data8[0]
231 #define nd_ra_flags_reserved	nd_ra_hdr.icmp6_data8[1]
232 #define ND_RA_FLAG_MANAGED	0x80
233 #define ND_RA_FLAG_OTHER	0x40
234 #define ND_RA_FLAG_HA		0x20
235 
236 /*
237  * Router preference values based on draft-draves-ipngwg-router-selection-01.
238  * These are non-standard definitions.
239  */
240 #define ND_RA_FLAG_RTPREF_MASK	0x18 /* 00011000 */
241 
242 #define ND_RA_FLAG_RTPREF_HIGH	0x08 /* 00001000 */
243 #define ND_RA_FLAG_RTPREF_MEDIUM	0x00 /* 00000000 */
244 #define ND_RA_FLAG_RTPREF_LOW	0x18 /* 00011000 */
245 #define ND_RA_FLAG_RTPREF_RSV	0x10 /* 00010000 */
246 
247 #ifdef EXPERIMENTAL
248 #define	ND_RA_FLAG_IPV6_ONLY	0x02 /* draft-ietf-6man-ipv6only-flag */
249 #endif
250 
251 #define nd_ra_router_lifetime	nd_ra_hdr.icmp6_data16[1]
252 
253 struct nd_neighbor_solicit {	/* neighbor solicitation */
254 	struct icmp6_hdr	nd_ns_hdr;
255 	struct in6_addr		nd_ns_target;	/*target address */
256 	/* could be followed by options */
257 } __packed;
258 
259 #define nd_ns_type		nd_ns_hdr.icmp6_type
260 #define nd_ns_code		nd_ns_hdr.icmp6_code
261 #define nd_ns_cksum		nd_ns_hdr.icmp6_cksum
262 #define nd_ns_reserved		nd_ns_hdr.icmp6_data32[0]
263 
264 struct nd_neighbor_advert {	/* neighbor advertisement */
265 	struct icmp6_hdr	nd_na_hdr;
266 	struct in6_addr		nd_na_target;	/* target address */
267 	/* could be followed by options */
268 } __packed;
269 
270 #define nd_na_type		nd_na_hdr.icmp6_type
271 #define nd_na_code		nd_na_hdr.icmp6_code
272 #define nd_na_cksum		nd_na_hdr.icmp6_cksum
273 #define nd_na_flags_reserved	nd_na_hdr.icmp6_data32[0]
274 #if BYTE_ORDER == BIG_ENDIAN
275 #define ND_NA_FLAG_ROUTER		0x80000000
276 #define ND_NA_FLAG_SOLICITED		0x40000000
277 #define ND_NA_FLAG_OVERRIDE		0x20000000
278 #else
279 #if BYTE_ORDER == LITTLE_ENDIAN
280 #define ND_NA_FLAG_ROUTER		0x80
281 #define ND_NA_FLAG_SOLICITED		0x40
282 #define ND_NA_FLAG_OVERRIDE		0x20
283 #endif
284 #endif
285 
286 struct nd_redirect {		/* redirect */
287 	struct icmp6_hdr	nd_rd_hdr;
288 	struct in6_addr		nd_rd_target;	/* target address */
289 	struct in6_addr		nd_rd_dst;	/* destination address */
290 	/* could be followed by options */
291 } __packed;
292 
293 #define nd_rd_type		nd_rd_hdr.icmp6_type
294 #define nd_rd_code		nd_rd_hdr.icmp6_code
295 #define nd_rd_cksum		nd_rd_hdr.icmp6_cksum
296 #define nd_rd_reserved		nd_rd_hdr.icmp6_data32[0]
297 
298 struct nd_opt_hdr {		/* Neighbor discovery option header */
299 	u_int8_t	nd_opt_type;
300 	u_int8_t	nd_opt_len;
301 	/* followed by option specific data*/
302 } __packed;
303 
304 #define ND_OPT_SOURCE_LINKADDR		1
305 #define ND_OPT_TARGET_LINKADDR		2
306 #define ND_OPT_PREFIX_INFORMATION	3
307 #define ND_OPT_REDIRECTED_HEADER	4
308 #define ND_OPT_MTU			5
309 #define ND_OPT_NONCE			14	/* RFC 3971 */
310 #define ND_OPT_ROUTE_INFO		24	/* RFC 4191 */
311 #define ND_OPT_RDNSS			25	/* RFC 6106 */
312 #define ND_OPT_DNSSL			31	/* RFC 6106 */
313 #define ND_OPT_MAX			31
314 
315 struct nd_opt_prefix_info {	/* prefix information */
316 	u_int8_t	nd_opt_pi_type;
317 	u_int8_t	nd_opt_pi_len;
318 	u_int8_t	nd_opt_pi_prefix_len;
319 	u_int8_t	nd_opt_pi_flags_reserved;
320 	u_int32_t	nd_opt_pi_valid_time;
321 	u_int32_t	nd_opt_pi_preferred_time;
322 	u_int32_t	nd_opt_pi_reserved2;
323 	struct in6_addr	nd_opt_pi_prefix;
324 } __packed;
325 
326 #define ND_OPT_PI_FLAG_ONLINK		0x80
327 #define ND_OPT_PI_FLAG_AUTO		0x40
328 
329 struct nd_opt_rd_hdr {		/* redirected header */
330 	u_int8_t	nd_opt_rh_type;
331 	u_int8_t	nd_opt_rh_len;
332 	u_int16_t	nd_opt_rh_reserved1;
333 	u_int32_t	nd_opt_rh_reserved2;
334 	/* followed by IP header and data */
335 } __packed;
336 
337 struct nd_opt_mtu {		/* MTU option */
338 	u_int8_t	nd_opt_mtu_type;
339 	u_int8_t	nd_opt_mtu_len;
340 	u_int16_t	nd_opt_mtu_reserved;
341 	u_int32_t	nd_opt_mtu_mtu;
342 } __packed;
343 
344 #define	ND_OPT_NONCE_LEN	((1 * 8) - 2)
345 #if ((ND_OPT_NONCE_LEN + 2) % 8) != 0
346 #error "(ND_OPT_NONCE_LEN + 2) must be a multiple of 8."
347 #endif
348 struct nd_opt_nonce {		/* nonce option */
349 	u_int8_t	nd_opt_nonce_type;
350 	u_int8_t	nd_opt_nonce_len;
351 	u_int8_t	nd_opt_nonce[ND_OPT_NONCE_LEN];
352 } __packed;
353 
354 struct nd_opt_route_info {	/* route info */
355 	u_int8_t	nd_opt_rti_type;
356 	u_int8_t	nd_opt_rti_len;
357 	u_int8_t	nd_opt_rti_prefixlen;
358 	u_int8_t	nd_opt_rti_flags;
359 	u_int32_t	nd_opt_rti_lifetime;
360 	/* prefix follows */
361 } __packed;
362 
363 struct nd_opt_rdnss {		/* RDNSS option (RFC 6106) */
364 	u_int8_t	nd_opt_rdnss_type;
365 	u_int8_t	nd_opt_rdnss_len;
366 	u_int16_t	nd_opt_rdnss_reserved;
367 	u_int32_t	nd_opt_rdnss_lifetime;
368 	/* followed by list of recursive DNS servers */
369 } __packed;
370 
371 struct nd_opt_dnssl {		/* DNSSL option (RFC 6106) */
372 	u_int8_t	nd_opt_dnssl_type;
373 	u_int8_t	nd_opt_dnssl_len;
374 	u_int16_t	nd_opt_dnssl_reserved;
375 	u_int32_t	nd_opt_dnssl_lifetime;
376 	/* followed by list of DNS search domains */
377 } __packed;
378 
379 /*
380  * icmp6 namelookup
381  */
382 
383 struct icmp6_namelookup {
384 	struct icmp6_hdr 	icmp6_nl_hdr;
385 	u_int8_t	icmp6_nl_nonce[8];
386 	int32_t		icmp6_nl_ttl;
387 #if 0
388 	u_int8_t	icmp6_nl_len;
389 	u_int8_t	icmp6_nl_name[3];
390 #endif
391 	/* could be followed by options */
392 } __packed;
393 
394 /*
395  * icmp6 node information
396  */
397 struct icmp6_nodeinfo {
398 	struct icmp6_hdr icmp6_ni_hdr;
399 	u_int8_t icmp6_ni_nonce[8];
400 	/* could be followed by reply data */
401 } __packed;
402 
403 #define ni_type		icmp6_ni_hdr.icmp6_type
404 #define ni_code		icmp6_ni_hdr.icmp6_code
405 #define ni_cksum	icmp6_ni_hdr.icmp6_cksum
406 #define ni_qtype	icmp6_ni_hdr.icmp6_data16[0]
407 #define ni_flags	icmp6_ni_hdr.icmp6_data16[1]
408 
409 #define NI_QTYPE_NOOP		0 /* NOOP  */
410 #define NI_QTYPE_SUPTYPES	1 /* Supported Qtypes */
411 #define NI_QTYPE_FQDN		2 /* FQDN (draft 04) */
412 #define NI_QTYPE_DNSNAME	2 /* DNS Name */
413 #define NI_QTYPE_NODEADDR	3 /* Node Addresses */
414 #define NI_QTYPE_IPV4ADDR	4 /* IPv4 Addresses */
415 
416 #if BYTE_ORDER == BIG_ENDIAN
417 #define NI_SUPTYPE_FLAG_COMPRESS	0x1
418 #define NI_FQDN_FLAG_VALIDTTL		0x1
419 #elif BYTE_ORDER == LITTLE_ENDIAN
420 #define NI_SUPTYPE_FLAG_COMPRESS	0x0100
421 #define NI_FQDN_FLAG_VALIDTTL		0x0100
422 #endif
423 
424 #ifdef NAME_LOOKUPS_04
425 #if BYTE_ORDER == BIG_ENDIAN
426 #define NI_NODEADDR_FLAG_LINKLOCAL	0x1
427 #define NI_NODEADDR_FLAG_SITELOCAL	0x2
428 #define NI_NODEADDR_FLAG_GLOBAL		0x4
429 #define NI_NODEADDR_FLAG_ALL		0x8
430 #define NI_NODEADDR_FLAG_TRUNCATE	0x10
431 #define NI_NODEADDR_FLAG_ANYCAST	0x20 /* just experimental. not in spec */
432 #elif BYTE_ORDER == LITTLE_ENDIAN
433 #define NI_NODEADDR_FLAG_LINKLOCAL	0x0100
434 #define NI_NODEADDR_FLAG_SITELOCAL	0x0200
435 #define NI_NODEADDR_FLAG_GLOBAL		0x0400
436 #define NI_NODEADDR_FLAG_ALL		0x0800
437 #define NI_NODEADDR_FLAG_TRUNCATE	0x1000
438 #define NI_NODEADDR_FLAG_ANYCAST	0x2000 /* just experimental. not in spec */
439 #endif
440 #else  /* draft-ietf-ipngwg-icmp-name-lookups-05 (and later?) */
441 #if BYTE_ORDER == BIG_ENDIAN
442 #define NI_NODEADDR_FLAG_TRUNCATE	0x1
443 #define NI_NODEADDR_FLAG_ALL		0x2
444 #define NI_NODEADDR_FLAG_COMPAT		0x4
445 #define NI_NODEADDR_FLAG_LINKLOCAL	0x8
446 #define NI_NODEADDR_FLAG_SITELOCAL	0x10
447 #define NI_NODEADDR_FLAG_GLOBAL		0x20
448 #define NI_NODEADDR_FLAG_ANYCAST	0x40 /* just experimental. not in spec */
449 #elif BYTE_ORDER == LITTLE_ENDIAN
450 #define NI_NODEADDR_FLAG_TRUNCATE	0x0100
451 #define NI_NODEADDR_FLAG_ALL		0x0200
452 #define NI_NODEADDR_FLAG_COMPAT		0x0400
453 #define NI_NODEADDR_FLAG_LINKLOCAL	0x0800
454 #define NI_NODEADDR_FLAG_SITELOCAL	0x1000
455 #define NI_NODEADDR_FLAG_GLOBAL		0x2000
456 #define NI_NODEADDR_FLAG_ANYCAST	0x4000 /* just experimental. not in spec */
457 #endif
458 #endif
459 
460 struct ni_reply_fqdn {
461 	u_int32_t ni_fqdn_ttl;	/* TTL */
462 	u_int8_t ni_fqdn_namelen; /* length in octets of the FQDN */
463 	u_int8_t ni_fqdn_name[3]; /* XXX: alignment */
464 } __packed;
465 
466 /*
467  * Router Renumbering. as router-renum-08.txt
468  */
469 struct icmp6_router_renum {	/* router renumbering header */
470 	struct icmp6_hdr	rr_hdr;
471 	u_int8_t	rr_segnum;
472 	u_int8_t	rr_flags;
473 	u_int16_t	rr_maxdelay;
474 	u_int32_t	rr_reserved;
475 } __packed;
476 
477 #define ICMP6_RR_FLAGS_TEST		0x80
478 #define ICMP6_RR_FLAGS_REQRESULT	0x40
479 #define ICMP6_RR_FLAGS_FORCEAPPLY	0x20
480 #define ICMP6_RR_FLAGS_SPECSITE		0x10
481 #define ICMP6_RR_FLAGS_PREVDONE		0x08
482 
483 #define rr_type		rr_hdr.icmp6_type
484 #define rr_code		rr_hdr.icmp6_code
485 #define rr_cksum	rr_hdr.icmp6_cksum
486 #define rr_seqnum 	rr_hdr.icmp6_data32[0]
487 
488 struct rr_pco_match {		/* match prefix part */
489 	u_int8_t	rpm_code;
490 	u_int8_t	rpm_len;
491 	u_int8_t	rpm_ordinal;
492 	u_int8_t	rpm_matchlen;
493 	u_int8_t	rpm_minlen;
494 	u_int8_t	rpm_maxlen;
495 	u_int16_t	rpm_reserved;
496 	struct	in6_addr	rpm_prefix;
497 } __packed;
498 
499 #define RPM_PCO_ADD		1
500 #define RPM_PCO_CHANGE		2
501 #define RPM_PCO_SETGLOBAL	3
502 #define RPM_PCO_MAX		4
503 
504 struct rr_pco_use {		/* use prefix part */
505 	u_int8_t	rpu_uselen;
506 	u_int8_t	rpu_keeplen;
507 	u_int8_t	rpu_ramask;
508 	u_int8_t	rpu_raflags;
509 	u_int32_t	rpu_vltime;
510 	u_int32_t	rpu_pltime;
511 	u_int32_t	rpu_flags;
512 	struct	in6_addr rpu_prefix;
513 } __packed;
514 #define ICMP6_RR_PCOUSE_RAFLAGS_ONLINK	0x80
515 #define ICMP6_RR_PCOUSE_RAFLAGS_AUTO	0x40
516 
517 #if BYTE_ORDER == BIG_ENDIAN
518 #define ICMP6_RR_PCOUSE_FLAGS_DECRVLTIME     0x80000000
519 #define ICMP6_RR_PCOUSE_FLAGS_DECRPLTIME     0x40000000
520 #elif BYTE_ORDER == LITTLE_ENDIAN
521 #define ICMP6_RR_PCOUSE_FLAGS_DECRVLTIME     0x80
522 #define ICMP6_RR_PCOUSE_FLAGS_DECRPLTIME     0x40
523 #endif
524 
525 struct rr_result {		/* router renumbering result message */
526 	u_int16_t	rrr_flags;
527 	u_int8_t	rrr_ordinal;
528 	u_int8_t	rrr_matchedlen;
529 	u_int32_t	rrr_ifid;
530 	struct	in6_addr rrr_prefix;
531 } __packed;
532 #if BYTE_ORDER == BIG_ENDIAN
533 #define ICMP6_RR_RESULT_FLAGS_OOB		0x0002
534 #define ICMP6_RR_RESULT_FLAGS_FORBIDDEN		0x0001
535 #elif BYTE_ORDER == LITTLE_ENDIAN
536 #define ICMP6_RR_RESULT_FLAGS_OOB		0x0200
537 #define ICMP6_RR_RESULT_FLAGS_FORBIDDEN		0x0100
538 #endif
539 
540 /*
541  * icmp6 filter structures.
542  */
543 
544 struct icmp6_filter {
545 	u_int32_t icmp6_filt[8];
546 };
547 
548 #ifdef _KERNEL
549 #define	ICMP6_FILTER_SETPASSALL(filterp) \
550 do {								\
551 	int i; u_char *p;					\
552 	p = (u_char *)filterp;					\
553 	for (i = 0; i < sizeof(struct icmp6_filter); i++)	\
554 		p[i] = 0xff;					\
555 } while (/*CONSTCOND*/ 0)
556 #define	ICMP6_FILTER_SETBLOCKALL(filterp) \
557 	bzero(filterp, sizeof(struct icmp6_filter))
558 #else /* _KERNEL */
559 #define	ICMP6_FILTER_SETPASSALL(filterp) \
560 	memset(filterp, 0xff, sizeof(struct icmp6_filter))
561 #define	ICMP6_FILTER_SETBLOCKALL(filterp) \
562 	memset(filterp, 0x00, sizeof(struct icmp6_filter))
563 #endif /* _KERNEL */
564 
565 #define	ICMP6_FILTER_SETPASS(type, filterp) \
566 	(((filterp)->icmp6_filt[(type) >> 5]) |= (1 << ((type) & 31)))
567 #define	ICMP6_FILTER_SETBLOCK(type, filterp) \
568 	(((filterp)->icmp6_filt[(type) >> 5]) &= ~(1 << ((type) & 31)))
569 #define	ICMP6_FILTER_WILLPASS(type, filterp) \
570 	((((filterp)->icmp6_filt[(type) >> 5]) & (1 << ((type) & 31))) != 0)
571 #define	ICMP6_FILTER_WILLBLOCK(type, filterp) \
572 	((((filterp)->icmp6_filt[(type) >> 5]) & (1 << ((type) & 31))) == 0)
573 
574 /*
575  * Variables related to this implementation
576  * of the internet control message protocol version 6.
577  */
578 struct icmp6errstat {
579 	uint64_t icp6errs_dst_unreach_noroute;
580 	uint64_t icp6errs_dst_unreach_admin;
581 	uint64_t icp6errs_dst_unreach_beyondscope;
582 	uint64_t icp6errs_dst_unreach_addr;
583 	uint64_t icp6errs_dst_unreach_noport;
584 	uint64_t icp6errs_packet_too_big;
585 	uint64_t icp6errs_time_exceed_transit;
586 	uint64_t icp6errs_time_exceed_reassembly;
587 	uint64_t icp6errs_paramprob_header;
588 	uint64_t icp6errs_paramprob_nextheader;
589 	uint64_t icp6errs_paramprob_option;
590 	uint64_t icp6errs_redirect; /* we regard redirect as an error here */
591 	uint64_t icp6errs_unknown;
592 };
593 
594 struct icmp6stat {
595 /* statistics related to icmp6 packets generated */
596 	uint64_t icp6s_error;		/* # of calls to icmp6_error */
597 	uint64_t icp6s_canterror;	/* no error 'cuz old was icmp */
598 	uint64_t icp6s_toofreq;		/* no error 'cuz rate limitation */
599 	uint64_t icp6s_outhist[256];
600 /* statistics related to input message processed */
601 	uint64_t icp6s_badcode;		/* icmp6_code out of range */
602 	uint64_t icp6s_tooshort;	/* packet < sizeof(struct icmp6_hdr) */
603 	uint64_t icp6s_checksum;	/* bad checksum */
604 	uint64_t icp6s_badlen;		/* calculated bound mismatch */
605 	uint64_t icp6s_dropped;		/* # of packets dropped waiting for a resolution */
606 	/*
607 	 * number of responses: this member is inherited from netinet code, but
608 	 * for netinet6 code, it is already available in icp6s_outhist[].
609 	 */
610 	uint64_t icp6s_reflect;
611 	uint64_t icp6s_inhist[256];
612 	uint64_t icp6s_nd_toomanyopt;	/* too many ND options */
613 	struct icmp6errstat icp6s_outerrhist;
614 #define icp6s_odst_unreach_noroute \
615 	icp6s_outerrhist.icp6errs_dst_unreach_noroute
616 #define icp6s_odst_unreach_admin icp6s_outerrhist.icp6errs_dst_unreach_admin
617 #define icp6s_odst_unreach_beyondscope \
618 	icp6s_outerrhist.icp6errs_dst_unreach_beyondscope
619 #define icp6s_odst_unreach_addr icp6s_outerrhist.icp6errs_dst_unreach_addr
620 #define icp6s_odst_unreach_noport icp6s_outerrhist.icp6errs_dst_unreach_noport
621 #define icp6s_opacket_too_big icp6s_outerrhist.icp6errs_packet_too_big
622 #define icp6s_otime_exceed_transit \
623 	icp6s_outerrhist.icp6errs_time_exceed_transit
624 #define icp6s_otime_exceed_reassembly \
625 	icp6s_outerrhist.icp6errs_time_exceed_reassembly
626 #define icp6s_oparamprob_header icp6s_outerrhist.icp6errs_paramprob_header
627 #define icp6s_oparamprob_nextheader \
628 	icp6s_outerrhist.icp6errs_paramprob_nextheader
629 #define icp6s_oparamprob_option icp6s_outerrhist.icp6errs_paramprob_option
630 #define icp6s_oredirect icp6s_outerrhist.icp6errs_redirect
631 #define icp6s_ounknown icp6s_outerrhist.icp6errs_unknown
632 	uint64_t icp6s_pmtuchg;		/* path MTU changes */
633 	uint64_t icp6s_nd_badopt;	/* bad ND options */
634 	uint64_t icp6s_badns;		/* bad neighbor solicitation */
635 	uint64_t icp6s_badna;		/* bad neighbor advertisement */
636 	uint64_t icp6s_badrs;		/* bad router solicitation */
637 	uint64_t icp6s_badra;		/* bad router advertisement */
638 	uint64_t icp6s_badredirect;	/* bad redirect message */
639 	uint64_t icp6s_overflowdefrtr;	/* Too many default routers. */
640 	uint64_t icp6s_overflowprfx;	/* Too many prefixes. */
641 	uint64_t icp6s_overflownndp;	/* Too many neighbour entries. */
642 	uint64_t icp6s_overflowredirect;/* Too many redirects. */
643 	uint64_t icp6s_invlhlim;	/* Invalid hop limit. */
644 	uint64_t icp6s_spare[32];
645 };
646 
647 #ifdef _KERNEL
648 #include <sys/counter.h>
649 
650 VNET_PCPUSTAT_DECLARE(struct icmp6stat, icmp6stat);
651 /*
652  * In-kernel consumers can use these accessor macros directly to update
653  * stats.
654  */
655 #define	ICMP6STAT_ADD(name, val)	\
656     VNET_PCPUSTAT_ADD(struct icmp6stat, icmp6stat, name, (val))
657 #define	ICMP6STAT_INC(name)		ICMP6STAT_ADD(name, 1)
658 
659 /*
660  * Kernel module consumers must use this accessor macro.
661  */
662 void	kmod_icmp6stat_inc(int statnum);
663 #define	KMOD_ICMP6STAT_INC(name)	\
664     kmod_icmp6stat_inc(offsetof(struct icmp6stat, name) / sizeof(uint64_t))
665 #endif
666 
667 /*
668  * Names for ICMP sysctl objects
669  */
670 #define ICMPV6CTL_STATS		1
671 #define ICMPV6CTL_REDIRACCEPT	2	/* accept/process redirects */
672 #define ICMPV6CTL_REDIRTIMEOUT	3	/* redirect cache time */
673 #if 0	/*obsoleted*/
674 #define ICMPV6CTL_ERRRATELIMIT	5	/* ICMPv6 error rate limitation */
675 #endif
676 #define ICMPV6CTL_ND6_PRUNE	6
677 #define ICMPV6CTL_ND6_DELAY	8
678 #define ICMPV6CTL_ND6_UMAXTRIES	9
679 #define ICMPV6CTL_ND6_MMAXTRIES		10
680 #define ICMPV6CTL_ND6_USELOOPBACK	11
681 /*#define ICMPV6CTL_ND6_PROXYALL	12	obsoleted, do not reuse here */
682 #define ICMPV6CTL_NODEINFO	13
683 #define ICMPV6CTL_ERRPPSLIMIT	14	/* ICMPv6 error pps limitation */
684 #define ICMPV6CTL_ND6_MAXNUDHINT	15
685 #define ICMPV6CTL_MTUDISC_HIWAT	16
686 #define ICMPV6CTL_MTUDISC_LOWAT	17
687 #define ICMPV6CTL_ND6_DEBUG	18
688 #define ICMPV6CTL_ND6_DRLIST	19
689 #define ICMPV6CTL_ND6_PRLIST	20
690 #define ICMPV6CTL_MLD_MAXSRCFILTER	21
691 #define ICMPV6CTL_MLD_SOMAXSRC	22
692 #define ICMPV6CTL_MLD_VERSION	23
693 #define ICMPV6CTL_ND6_MAXQLEN	24
694 #define ICMPV6CTL_NODEINFO_OLDMCPREFIX	25
695 #define ICMPV6CTL_MAXID		26
696 
697 #ifdef _KERNEL
698 # ifdef __STDC__
699 struct	nhop_object;
700 struct	rttimer;
701 struct	in6_multi;
702 # endif
703 void	icmp6_paramerror(struct mbuf *, int);
704 int	icmp6_errmap(const struct icmp6_hdr *);
705 void	icmp6_error(struct mbuf *, int, int, int);
706 void	icmp6_error2(struct mbuf *, int, int, int, struct ifnet *);
707 int	icmp6_input(struct mbuf **, int *, int);
708 void	icmp6_prepare(struct mbuf *);
709 void	icmp6_redirect_input(struct mbuf *, int);
710 void	icmp6_redirect_output(struct mbuf *, struct nhop_object *);
711 int	icmp6_ratelimit(const struct in6_addr *, const int, const int);
712 
713 struct	ip6ctlparam;
714 void	icmp6_mtudisc_update(struct ip6ctlparam *, int);
715 
716 /* XXX: is this the right place for these macros? */
717 #define icmp6_ifstat_inc(ifp, tag) \
718 do {								\
719 	if (ifp)						\
720 		counter_u64_add(((struct in6_ifextra *)		\
721 		    ((ifp)->if_afdata[AF_INET6]))->icmp6_ifstat[\
722 		    offsetof(struct icmp6_ifstat, tag) / sizeof(uint64_t)], 1);\
723 } while (/*CONSTCOND*/ 0)
724 
725 #define icmp6_ifoutstat_inc(ifp, type, code) \
726 do { \
727 		icmp6_ifstat_inc(ifp, ifs6_out_msg); \
728  		if (type < ICMP6_INFOMSG_MASK) \
729  			icmp6_ifstat_inc(ifp, ifs6_out_error); \
730 		switch (type) { \
731 		 case ICMP6_DST_UNREACH: \
732 			 icmp6_ifstat_inc(ifp, ifs6_out_dstunreach); \
733 			 if (code == ICMP6_DST_UNREACH_ADMIN) \
734 				 icmp6_ifstat_inc(ifp, ifs6_out_adminprohib); \
735 			 break; \
736 		 case ICMP6_PACKET_TOO_BIG: \
737 			 icmp6_ifstat_inc(ifp, ifs6_out_pkttoobig); \
738 			 break; \
739 		 case ICMP6_TIME_EXCEEDED: \
740 			 icmp6_ifstat_inc(ifp, ifs6_out_timeexceed); \
741 			 break; \
742 		 case ICMP6_PARAM_PROB: \
743 			 icmp6_ifstat_inc(ifp, ifs6_out_paramprob); \
744 			 break; \
745 		 case ICMP6_ECHO_REQUEST: \
746 			 icmp6_ifstat_inc(ifp, ifs6_out_echo); \
747 			 break; \
748 		 case ICMP6_ECHO_REPLY: \
749 			 icmp6_ifstat_inc(ifp, ifs6_out_echoreply); \
750 			 break; \
751 		 case MLD_LISTENER_QUERY: \
752 			 icmp6_ifstat_inc(ifp, ifs6_out_mldquery); \
753 			 break; \
754 		 case MLD_LISTENER_REPORT: \
755 			 icmp6_ifstat_inc(ifp, ifs6_out_mldreport); \
756 			 break; \
757 		 case MLD_LISTENER_DONE: \
758 			 icmp6_ifstat_inc(ifp, ifs6_out_mlddone); \
759 			 break; \
760 		 case ND_ROUTER_SOLICIT: \
761 			 icmp6_ifstat_inc(ifp, ifs6_out_routersolicit); \
762 			 break; \
763 		 case ND_ROUTER_ADVERT: \
764 			 icmp6_ifstat_inc(ifp, ifs6_out_routeradvert); \
765 			 break; \
766 		 case ND_NEIGHBOR_SOLICIT: \
767 			 icmp6_ifstat_inc(ifp, ifs6_out_neighborsolicit); \
768 			 break; \
769 		 case ND_NEIGHBOR_ADVERT: \
770 			 icmp6_ifstat_inc(ifp, ifs6_out_neighboradvert); \
771 			 break; \
772 		 case ND_REDIRECT: \
773 			 icmp6_ifstat_inc(ifp, ifs6_out_redirect); \
774 			 break; \
775 		} \
776 } while (/*CONSTCOND*/ 0)
777 
778 VNET_DECLARE(int, icmp6_rediraccept);	/* accept/process redirects */
779 VNET_DECLARE(int, icmp6_redirtimeout);	/* cache time for redirect routes */
780 
781 #define	V_icmp6_rediraccept	VNET(icmp6_rediraccept)
782 #define	V_icmp6_redirtimeout	VNET(icmp6_redirtimeout)
783 
784 #define ICMP6_NODEINFO_FQDNOK		0x1
785 #define ICMP6_NODEINFO_NODEADDROK	0x2
786 #define ICMP6_NODEINFO_TMPADDROK	0x4
787 #define ICMP6_NODEINFO_GLOBALOK		0x8
788 #endif /* _KERNEL */
789 
790 #endif /* not _NETINET_ICMP6_H_ */
791