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