master
1/*
2 * Copyright (c) 2008-2020 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/*
59 * Copyright (c) 1982, 1986, 1990, 1993
60 * The Regents of the University of California. All rights reserved.
61 *
62 * Redistribution and use in source and binary forms, with or without
63 * modification, are permitted provided that the following conditions
64 * are met:
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in the
69 * documentation and/or other materials provided with the distribution.
70 * 3. All advertising materials mentioning features or use of this software
71 * must display the following acknowledgement:
72 * This product includes software developed by the University of
73 * California, Berkeley and its contributors.
74 * 4. Neither the name of the University nor the names of its contributors
75 * may be used to endorse or promote products derived from this software
76 * without specific prior written permission.
77 *
78 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
79 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
80 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
81 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
82 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
83 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
84 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
85 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
86 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
87 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
88 * SUCH DAMAGE.
89 *
90 * @(#)in.h 8.3 (Berkeley) 1/3/94
91 */
92
93#ifndef __KAME_NETINET_IN_H_INCLUDED_
94#error "do not include netinet6/in6.h directly, include netinet/in.h. " \
95 " see RFC2553"
96#endif
97
98#ifndef _NETINET6_IN6_H_
99#define _NETINET6_IN6_H_
100#include <sys/appleapiopts.h>
101
102#include <sys/_types.h>
103#include <sys/_types/_sa_family_t.h>
104#include <sys/_types/_in_port_t.h>
105
106/*
107 * Identification of the network protocol stack
108 * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
109 * has the table of implementation/integration differences.
110 */
111#define __KAME__
112#define __KAME_VERSION "2009/apple-darwin"
113
114#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
115/*
116 * Local port number conventions:
117 *
118 * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
119 * unless a kernel is compiled with IPNOPRIVPORTS defined.
120 *
121 * When a user does a bind(2) or connect(2) with a port number of zero,
122 * a non-conflicting local port address is chosen.
123 *
124 * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
125 * that is settable by sysctl(3); net.inet.ip.anonportmin and
126 * net.inet.ip.anonportmax respectively.
127 *
128 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
129 * default assignment range.
130 *
131 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
132 *
133 * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
134 * and exists only for FreeBSD compatibility purposes.
135 *
136 * The value IP_PORTRANGE_LOW changes the range to the "low" are
137 * that is (by convention) restricted to privileged processes.
138 * This convention is based on "vouchsafe" principles only.
139 * It is only secure if you trust the remote host to restrict these ports.
140 * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
141 */
142
143#define IPV6PORT_RESERVED 1024
144#define IPV6PORT_ANONMIN 49152
145#define IPV6PORT_ANONMAX 65535
146#define IPV6PORT_RESERVEDMIN 600
147#define IPV6PORT_RESERVEDMAX (IPV6PORT_RESERVED-1)
148#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
149
150/*
151 * IPv6 address
152 */
153typedef struct in6_addr {
154 union {
155 __uint8_t __u6_addr8[16];
156 __uint16_t __u6_addr16[8];
157 __uint32_t __u6_addr32[4];
158 } __u6_addr; /* 128-bit IP6 address */
159} in6_addr_t;
160
161#define s6_addr __u6_addr.__u6_addr8
162
163#define INET6_ADDRSTRLEN 46
164
165/*
166 * Socket address for IPv6
167 */
168#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
169#define SIN6_LEN
170#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
171struct sockaddr_in6 {
172 __uint8_t sin6_len; /* length of this struct(sa_family_t) */
173 sa_family_t sin6_family; /* AF_INET6 (sa_family_t) */
174 in_port_t sin6_port; /* Transport layer port # (in_port_t) */
175 __uint32_t sin6_flowinfo; /* IP6 flow information */
176 struct in6_addr sin6_addr; /* IP6 address */
177 __uint32_t sin6_scope_id; /* scope zone index */
178};
179
180
181
182
183/*
184 * Definition of some useful macros to handle IP6 addresses
185 */
186#define IN6ADDR_ANY_INIT \
187 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
188 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
189#define IN6ADDR_LOOPBACK_INIT \
190 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
191 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
192#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
193#define IN6ADDR_NODELOCAL_ALLNODES_INIT \
194 {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
195 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
196#define IN6ADDR_INTFACELOCAL_ALLNODES_INIT \
197 {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
198 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
199#define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
200 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
201 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
202#define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
203 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
204 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
205#define IN6ADDR_LINKLOCAL_ALLV2ROUTERS_INIT \
206 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
207 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16 }}}
208#define IN6ADDR_V4MAPPED_INIT \
209 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
210 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
211#define IN6ADDR_MULTICAST_PREFIX IN6MASK8
212#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
213
214extern const struct in6_addr in6addr_any;
215extern const struct in6_addr in6addr_loopback;
216#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
217extern const struct in6_addr in6addr_nodelocal_allnodes;
218extern const struct in6_addr in6addr_linklocal_allnodes;
219extern const struct in6_addr in6addr_linklocal_allrouters;
220extern const struct in6_addr in6addr_linklocal_allv2routers;
221#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
222
223/*
224 * Equality
225 * NOTE: Some of kernel programming environment (for example, openbsd/sparc)
226 * does not supply memcmp(). For userland memcmp() is preferred as it is
227 * in ANSI standard.
228 */
229#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
230#define IN6_ARE_ADDR_EQUAL(a, b) \
231 (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof (struct in6_addr)) \
232 == 0)
233#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
234
235
236/*
237 * Unspecified
238 */
239#define IN6_IS_ADDR_UNSPECIFIED(a) \
240 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
241 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
242 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
243 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == 0))
244
245/*
246 * Loopback
247 */
248#define IN6_IS_ADDR_LOOPBACK(a) \
249 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
250 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
251 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
252 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == ntohl(1)))
253
254/*
255 * IPv4 compatible
256 */
257#define IN6_IS_ADDR_V4COMPAT(a) \
258 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
259 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
260 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
261 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != 0) && \
262 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != ntohl(1)))
263
264/*
265 * Mapped
266 */
267#define IN6_IS_ADDR_V4MAPPED(a) \
268 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
269 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
270 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == \
271 ntohl(0x0000ffff)))
272
273/*
274 * 6to4
275 */
276#define IN6_IS_ADDR_6TO4(x) (ntohs((x)->s6_addr16[0]) == 0x2002)
277
278/*
279 * KAME Scope Values
280 */
281
282#define __IPV6_ADDR_SCOPE_NODELOCAL 0x01
283#define __IPV6_ADDR_SCOPE_INTFACELOCAL 0x01
284#define __IPV6_ADDR_SCOPE_LINKLOCAL 0x02
285#define __IPV6_ADDR_SCOPE_SITELOCAL 0x05
286#define __IPV6_ADDR_SCOPE_ORGLOCAL 0x08 /* just used in this file */
287#define __IPV6_ADDR_SCOPE_GLOBAL 0x0e
288
289/*
290 * Unicast Scope
291 * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
292 */
293#define IN6_IS_ADDR_LINKLOCAL(a) \
294 (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0x80))
295#define IN6_IS_ADDR_SITELOCAL(a) \
296 (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0xc0))
297
298/*
299 * Multicast
300 */
301#define IN6_IS_ADDR_MULTICAST(a) ((a)->s6_addr[0] == 0xff)
302
303#define IPV6_ADDR_MC_FLAGS(a) ((a)->s6_addr[1] & 0xf0)
304
305#define IPV6_ADDR_MC_FLAGS_TRANSIENT 0x10
306#define IPV6_ADDR_MC_FLAGS_PREFIX 0x20
307#define IPV6_ADDR_MC_FLAGS_UNICAST_BASED (IPV6_ADDR_MC_FLAGS_TRANSIENT | IPV6_ADDR_MC_FLAGS_PREFIX)
308
309#define IN6_IS_ADDR_UNICAST_BASED_MULTICAST(a) \
310 (IN6_IS_ADDR_MULTICAST(a) && \
311 (IPV6_ADDR_MC_FLAGS(a) == IPV6_ADDR_MC_FLAGS_UNICAST_BASED))
312
313/*
314 * Unique Local IPv6 Unicast Addresses (per RFC 4193)
315 */
316#define IN6_IS_ADDR_UNIQUE_LOCAL(a) \
317 (((a)->s6_addr[0] == 0xfc) || ((a)->s6_addr[0] == 0xfd))
318
319#define __IPV6_ADDR_MC_SCOPE(a) ((a)->s6_addr[1] & 0x0f)
320
321/*
322 * Multicast Scope
323 */
324#define IN6_IS_ADDR_MC_NODELOCAL(a) \
325 (IN6_IS_ADDR_MULTICAST(a) && \
326 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
327#define IN6_IS_ADDR_MC_LINKLOCAL(a) \
328 (IN6_IS_ADDR_MULTICAST(a) && \
329 (IPV6_ADDR_MC_FLAGS(a) != IPV6_ADDR_MC_FLAGS_UNICAST_BASED) && \
330 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
331#define IN6_IS_ADDR_MC_SITELOCAL(a) \
332 (IN6_IS_ADDR_MULTICAST(a) && \
333 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
334#define IN6_IS_ADDR_MC_ORGLOCAL(a) \
335 (IN6_IS_ADDR_MULTICAST(a) && \
336 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
337#define IN6_IS_ADDR_MC_GLOBAL(a) \
338 (IN6_IS_ADDR_MULTICAST(a) && \
339 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
340
341
342/*
343 * Options for use with [gs]etsockopt at the IPV6 level.
344 * First word of comment is data type; bool is stored in int.
345 */
346/* no hdrincl */
347#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
348/*
349 * RFC 3542 define the following socket options in a manner incompatible
350 * with RFC 2292:
351 * IPV6_PKTINFO
352 * IPV6_HOPLIMIT
353 * IPV6_NEXTHOP
354 * IPV6_HOPOPTS
355 * IPV6_DSTOPTS
356 * IPV6_RTHDR
357 *
358 * To use the new IPv6 Sockets options introduced by RFC 3542
359 * the constant __APPLE_USE_RFC_3542 must be defined before
360 * including <netinet/in.h>
361 *
362 * To use the old IPv6 Sockets options from RFC 2292
363 * the constant __APPLE_USE_RFC_2292 must be defined before
364 * including <netinet/in.h>
365 *
366 * Note that eventually RFC 3542 is going to be the
367 * default and RFC 2292 will be obsolete.
368 */
369
370#if defined(__APPLE_USE_RFC_3542) && defined(__APPLE_USE_RFC_2292)
371#error "__APPLE_USE_RFC_3542 and __APPLE_USE_RFC_2292 cannot be both defined"
372#endif
373
374#if 0 /* the followings are relic in IPv4 and hence are disabled */
375#define IPV6_OPTIONS 1 /* buf/ip6_opts; set/get IP6 options */
376#define IPV6_RECVOPTS 5 /* bool; receive all IP6 opts w/dgram */
377#define IPV6_RECVRETOPTS 6 /* bool; receive IP6 opts for response */
378#define IPV6_RECVDSTADDR 7 /* bool; receive IP6 dst addr w/dgram */
379#define IPV6_RETOPTS 8 /* ip6_opts; set/get IP6 options */
380#endif /* 0 */
381#define IPV6_SOCKOPT_RESERVED1 3 /* reserved for future use */
382#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
383#define IPV6_UNICAST_HOPS 4 /* int; IP6 hops */
384#define IPV6_MULTICAST_IF 9 /* u_int; set/get IP6 multicast i/f */
385#define IPV6_MULTICAST_HOPS 10 /* int; set/get IP6 multicast hops */
386#define IPV6_MULTICAST_LOOP 11 /* u_int; set/get IP6 mcast loopback */
387#define IPV6_JOIN_GROUP 12 /* ip6_mreq; join a group membership */
388#define IPV6_LEAVE_GROUP 13 /* ip6_mreq; leave a group membership */
389
390#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
391#define IPV6_PORTRANGE 14 /* int; range to choose for unspec port */
392#define ICMP6_FILTER 18 /* icmp6_filter; icmp6 filter */
393#define IPV6_2292PKTINFO 19 /* bool; send/recv if, src/dst addr */
394#define IPV6_2292HOPLIMIT 20 /* bool; hop limit */
395#define IPV6_2292NEXTHOP 21 /* bool; next hop addr */
396#define IPV6_2292HOPOPTS 22 /* bool; hop-by-hop option */
397#define IPV6_2292DSTOPTS 23 /* bool; destinaion option */
398#define IPV6_2292RTHDR 24 /* ip6_rthdr: routing header */
399
400/* buf/cmsghdr; set/get IPv6 options [obsoleted by RFC3542] */
401#define IPV6_2292PKTOPTIONS 25
402
403#ifdef __APPLE_USE_RFC_2292
404#define IPV6_PKTINFO IPV6_2292PKTINFO
405#define IPV6_HOPLIMIT IPV6_2292HOPLIMIT
406#define IPV6_NEXTHOP IPV6_2292NEXTHOP
407#define IPV6_HOPOPTS IPV6_2292HOPOPTS
408#define IPV6_DSTOPTS IPV6_2292DSTOPTS
409#define IPV6_RTHDR IPV6_2292RTHDR
410#define IPV6_PKTOPTIONS IPV6_2292PKTOPTIONS
411#endif /* __APPLE_USE_RFC_2292 */
412
413#define IPV6_CHECKSUM 26 /* int; checksum offset for raw socket */
414#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
415#define IPV6_V6ONLY 27 /* bool; only bind INET6 at wildcard bind */
416#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
417#define IPV6_BINDV6ONLY IPV6_V6ONLY
418
419
420#if 1 /* IPSEC */
421#define IPV6_IPSEC_POLICY 28 /* struct; get/set security policy */
422#endif /* 1 */
423#define IPV6_FAITH 29 /* deprecated */
424
425#if 1 /* IPV6FIREWALL */
426#define IPV6_FW_ADD 30 /* add a firewall rule to chain */
427#define IPV6_FW_DEL 31 /* delete a firewall rule from chain */
428#define IPV6_FW_FLUSH 32 /* flush firewall rule chain */
429#define IPV6_FW_ZERO 33 /* clear single/all firewall counter(s) */
430#define IPV6_FW_GET 34 /* get entire firewall rule chain */
431#endif /* 1 */
432
433/*
434 * APPLE: NOTE the value of those 2 options is kept unchanged from
435 * previous version of darwin/OS X for binary compatibility reasons
436 * and differ from FreeBSD (values 57 and 61). See below.
437 */
438#define IPV6_RECVTCLASS 35 /* bool; recv traffic class values */
439#define IPV6_TCLASS 36 /* int; send traffic class value */
440
441#ifdef __APPLE_USE_RFC_3542
442/* new socket options introduced in RFC3542 */
443/*
444 * ip6_dest; send dst option before rthdr
445 * APPLE: Value purposely different than FreeBSD (35) to avoid
446 * collision with definition of IPV6_RECVTCLASS in previous
447 * darwin implementations
448 */
449#define IPV6_RTHDRDSTOPTS 57
450
451/*
452 * bool; recv if, dst addr
453 * APPLE: Value purposely different than FreeBSD(36) to avoid
454 * collision with definition of IPV6_TCLASS in previous
455 * darwin implementations
456 */
457#define IPV6_RECVPKTINFO 61
458
459#define IPV6_RECVHOPLIMIT 37 /* bool; recv hop limit */
460#define IPV6_RECVRTHDR 38 /* bool; recv routing header */
461#define IPV6_RECVHOPOPTS 39 /* bool; recv hop-by-hop option */
462#define IPV6_RECVDSTOPTS 40 /* bool; recv dst option after rthdr */
463
464#define IPV6_USE_MIN_MTU 42 /* bool; send packets at the minimum MTU */
465#define IPV6_RECVPATHMTU 43 /* bool; notify an according MTU */
466
467/*
468 * mtuinfo; get the current path MTU (sopt), 4 bytes int;
469 * MTU notification (cmsg)
470 */
471#define IPV6_PATHMTU 44
472
473#if 0 /* obsoleted during 2292bis -> 3542 */
474/* no data; ND reachability confirm (cmsg only/not in of RFC3542) */
475#define IPV6_REACHCONF 45
476#endif
477/* more new socket options introduced in RFC3542 */
478#define IPV6_3542PKTINFO 46 /* in6_pktinfo; send if, src addr */
479#define IPV6_3542HOPLIMIT 47 /* int; send hop limit */
480#define IPV6_3542NEXTHOP 48 /* sockaddr; next hop addr */
481#define IPV6_3542HOPOPTS 49 /* ip6_hbh; send hop-by-hop option */
482#define IPV6_3542DSTOPTS 50 /* ip6_dest; send dst option befor rthdr */
483#define IPV6_3542RTHDR 51 /* ip6_rthdr; send routing header */
484
485#define IPV6_PKTINFO IPV6_3542PKTINFO
486#define IPV6_HOPLIMIT IPV6_3542HOPLIMIT
487#define IPV6_NEXTHOP IPV6_3542NEXTHOP
488#define IPV6_HOPOPTS IPV6_3542HOPOPTS
489#define IPV6_DSTOPTS IPV6_3542DSTOPTS
490#define IPV6_RTHDR IPV6_3542RTHDR
491
492#define IPV6_AUTOFLOWLABEL 59 /* bool; attach flowlabel automagically */
493
494#define IPV6_DONTFRAG 62 /* bool; disable IPv6 fragmentation */
495
496/* int; prefer temporary addresses as the source address. */
497#define IPV6_PREFER_TEMPADDR 63
498
499/*
500 * The following option is private; do not use it from user applications.
501 * It is deliberately defined to the same value as IP_MSFILTER.
502 */
503#define IPV6_MSFILTER 74 /* struct __msfilterreq; */
504#endif /* __APPLE_USE_RFC_3542 */
505
506#define IPV6_BOUND_IF 125 /* int; set/get bound interface */
507
508/* to define items, should talk with KAME guys first, for *BSD compatibility */
509
510#define IPV6_RTHDR_LOOSE 0 /* this hop need not be a neighbor. */
511#define IPV6_RTHDR_STRICT 1 /* this hop must be a neighbor. */
512#define IPV6_RTHDR_TYPE_0 0 /* IPv6 routing header type 0 */
513
514/*
515 * Defaults and limits for options
516 */
517#define IPV6_DEFAULT_MULTICAST_HOPS 1 /* normally limit m'casts to 1 hop */
518#define IPV6_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
519
520/*
521 * The im6o_membership vector for each socket is now dynamically allocated at
522 * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
523 * according to a power-of-two increment.
524 */
525#define IPV6_MIN_MEMBERSHIPS 31
526#define IPV6_MAX_MEMBERSHIPS 4095
527
528/*
529 * Default resource limits for IPv6 multicast source filtering.
530 * These may be modified by sysctl.
531 */
532#define IPV6_MAX_GROUP_SRC_FILTER 512 /* sources per group */
533#define IPV6_MAX_SOCK_SRC_FILTER 128 /* sources per socket/group */
534
535/*
536 * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
537 */
538struct ipv6_mreq {
539 struct in6_addr ipv6mr_multiaddr;
540 unsigned int ipv6mr_interface;
541};
542
543/*
544 * IPV6_2292PKTINFO: Packet information(RFC2292 sec 5)
545 */
546struct in6_pktinfo {
547 struct in6_addr ipi6_addr; /* src/dst IPv6 address */
548 unsigned int ipi6_ifindex; /* send/recv interface index */
549};
550
551/*
552 * Control structure for IPV6_RECVPATHMTU socket option.
553 */
554struct ip6_mtuinfo {
555 struct sockaddr_in6 ip6m_addr; /* or sockaddr_storage? */
556 uint32_t ip6m_mtu;
557};
558
559/*
560 * Argument for IPV6_PORTRANGE:
561 * - which range to search when port is unspecified at bind() or connect()
562 */
563#define IPV6_PORTRANGE_DEFAULT 0 /* default range */
564#define IPV6_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
565#define IPV6_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
566
567/*
568 * Definitions for inet6 sysctl operations.
569 *
570 * Third level is protocol number.
571 * Fourth level is desired variable within that protocol.
572 */
573#define IPV6PROTO_MAXID (IPPROTO_PIM + 1) /* don't list to IPV6PROTO_MAX */
574
575/*
576 * Names for IP sysctl objects
577 */
578#define IPV6CTL_FORWARDING 1 /* act as router */
579#define IPV6CTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
580#define IPV6CTL_DEFHLIM 3 /* default Hop-Limit */
581#ifdef notyet
582#define IPV6CTL_DEFMTU 4 /* default MTU */
583#endif
584#define IPV6CTL_FORWSRCRT 5 /* forward source-routed dgrams */
585#define IPV6CTL_STATS 6 /* stats */
586#define IPV6CTL_MRTSTATS 7 /* multicast forwarding stats */
587#define IPV6CTL_MRTPROTO 8 /* multicast routing protocol */
588#define IPV6CTL_MAXFRAGPACKETS 9 /* max packets reassembly queue */
589#define IPV6CTL_SOURCECHECK 10 /* verify source route and intf */
590#define IPV6CTL_SOURCECHECK_LOGINT 11 /* minimume logging interval */
591#define IPV6CTL_ACCEPT_RTADV 12
592#define IPV6CTL_KEEPFAITH 13 /* deprecated */
593#define IPV6CTL_LOG_INTERVAL 14
594#define IPV6CTL_HDRNESTLIMIT 15
595#define IPV6CTL_DAD_COUNT 16
596#define IPV6CTL_AUTO_FLOWLABEL 17
597#define IPV6CTL_DEFMCASTHLIM 18
598#define IPV6CTL_GIF_HLIM 19 /* default HLIM for gif encap packet */
599#define IPV6CTL_KAME_VERSION 20
600#define IPV6CTL_USE_DEPRECATED 21 /* use deprec addr (RFC2462 5.5.4) */
601#define IPV6CTL_RR_PRUNE 22 /* walk timer for router renumbering */
602#if 0 /* obsolete */
603#define IPV6CTL_MAPPED_ADDR 23
604#endif
605#define IPV6CTL_V6ONLY 24
606#define IPV6CTL_RTEXPIRE 25 /* cloned route expiration time */
607#define IPV6CTL_RTMINEXPIRE 26 /* min value for expiration time */
608#define IPV6CTL_RTMAXCACHE 27 /* trigger level for dynamic expire */
609
610#define IPV6CTL_USETEMPADDR 32 /* use temporary addresses [RFC 4941] */
611#define IPV6CTL_TEMPPLTIME 33 /* preferred lifetime for tmpaddrs */
612#define IPV6CTL_TEMPVLTIME 34 /* valid lifetime for tmpaddrs */
613#define IPV6CTL_AUTO_LINKLOCAL 35 /* automatic link-local addr assign */
614#define IPV6CTL_RIP6STATS 36 /* raw_ip6 stats */
615#define IPV6CTL_PREFER_TEMPADDR 37 /* prefer temporary addr as src */
616#define IPV6CTL_ADDRCTLPOLICY 38 /* get/set address selection policy */
617#define IPV6CTL_USE_DEFAULTZONE 39 /* use default scope zone */
618
619#define IPV6CTL_MAXFRAGS 41 /* max fragments */
620#define IPV6CTL_MCAST_PMTU 44 /* enable pMTU discovery for mcast? */
621
622#define IPV6CTL_NEIGHBORGCTHRESH 46
623#define IPV6CTL_MAXIFPREFIXES 47
624#define IPV6CTL_MAXIFDEFROUTERS 48
625#define IPV6CTL_MAXDYNROUTES 49
626#define ICMPV6CTL_ND6_ONLINKNSRFC4861 50
627#define IPV6CTL_ULA_USETEMPADDR 51
628
629
630/* New entries should be added here from current IPV6CTL_MAXID value. */
631/* to define items, should talk with KAME guys first, for *BSD compatibility */
632#define IPV6CTL_MAXID 51
633
634__BEGIN_DECLS
635struct cmsghdr;
636
637extern int inet6_option_space(int);
638extern int inet6_option_init(void *, struct cmsghdr **, int);
639extern int inet6_option_append(struct cmsghdr *, const __uint8_t *, int, int);
640extern __uint8_t *inet6_option_alloc(struct cmsghdr *, int, int, int);
641extern int inet6_option_next(const struct cmsghdr *, __uint8_t **);
642extern int inet6_option_find(const struct cmsghdr *, __uint8_t **, int);
643
644extern size_t inet6_rthdr_space(int, int);
645extern struct cmsghdr *inet6_rthdr_init(void *, int);
646extern int inet6_rthdr_add(struct cmsghdr *, const struct in6_addr *,
647 unsigned int);
648extern int inet6_rthdr_lasthop(struct cmsghdr *, unsigned int);
649#if 0 /* not implemented yet */
650extern int inet6_rthdr_reverse(const struct cmsghdr *, struct cmsghdr *);
651#endif
652extern int inet6_rthdr_segments(const struct cmsghdr *);
653extern struct in6_addr *inet6_rthdr_getaddr(struct cmsghdr *, int);
654extern int inet6_rthdr_getflags(const struct cmsghdr *, int);
655
656extern int inet6_opt_init(void *, socklen_t);
657extern int inet6_opt_append(void *, socklen_t, int, __uint8_t, socklen_t,
658 __uint8_t, void **);
659extern int inet6_opt_finish(void *, socklen_t, int);
660extern int inet6_opt_set_val(void *, int, void *, socklen_t);
661
662extern int inet6_opt_next(void *, socklen_t, int, __uint8_t *, socklen_t *,
663 void **);
664extern int inet6_opt_find(void *, socklen_t, int, __uint8_t, socklen_t *,
665 void **);
666extern int inet6_opt_get_val(void *, int, void *, socklen_t);
667extern socklen_t inet6_rth_space(int, int);
668extern void *inet6_rth_init(void *, socklen_t, int, int);
669extern int inet6_rth_add(void *, const struct in6_addr *);
670extern int inet6_rth_reverse(const void *, void *);
671extern int inet6_rth_segments(const void *);
672extern struct in6_addr *inet6_rth_getaddr(const void *, int);
673
674__END_DECLS
675#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
676#endif /* !_NETINET6_IN6_H_ */