1/*
2 * Copyright (c) 2000-2018 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 * Copyright (c) 1982, 1986, 1990, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * @(#)in.h 8.3 (Berkeley) 1/3/94
61 * $FreeBSD: src/sys/netinet/in.h,v 1.48.2.2 2001/04/21 14:53:06 ume Exp $
62 */
63
64#ifndef _NETINET_IN_H_
65#define _NETINET_IN_H_
66#include <sys/appleapiopts.h>
67#include <sys/_types.h>
68#include <stdint.h> /* uint(8|16|32)_t */
69
70#ifndef KERNEL
71#include <Availability.h>
72#endif
73
74#include <sys/_types/_in_addr_t.h>
75
76#include <sys/_types/_in_port_t.h>
77
78/*
79 * POSIX 1003.1-2003
80 * "Inclusion of the <netinet/in.h> header may also make visible all
81 * symbols from <inttypes.h> and <sys/socket.h>".
82 */
83#include <sys/socket.h>
84
85/*
86 * The following two #includes insure htonl and family are defined
87 */
88#include <machine/endian.h>
89#include <sys/_endian.h>
90
91/*
92 * Constants and structures defined by the internet system,
93 * Per RFC 790, September 1981, and numerous additions.
94 */
95
96/*
97 * Protocols (RFC 1700)
98 */
99#define IPPROTO_IP 0 /* dummy for IP */
100#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
101#define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */
102#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
103#define IPPROTO_ICMP 1 /* control message protocol */
104#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
105#define IPPROTO_IGMP 2 /* group mgmt protocol */
106#define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
107#define IPPROTO_IPV4 4 /* IPv4 encapsulation */
108#define IPPROTO_IPIP IPPROTO_IPV4 /* for compatibility */
109#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
110#define IPPROTO_TCP 6 /* tcp */
111#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
112#define IPPROTO_ST 7 /* Stream protocol II */
113#define IPPROTO_EGP 8 /* exterior gateway protocol */
114#define IPPROTO_PIGP 9 /* private interior gateway */
115#define IPPROTO_RCCMON 10 /* BBN RCC Monitoring */
116#define IPPROTO_NVPII 11 /* network voice protocol*/
117#define IPPROTO_PUP 12 /* pup */
118#define IPPROTO_ARGUS 13 /* Argus */
119#define IPPROTO_EMCON 14 /* EMCON */
120#define IPPROTO_XNET 15 /* Cross Net Debugger */
121#define IPPROTO_CHAOS 16 /* Chaos*/
122#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
123#define IPPROTO_UDP 17 /* user datagram protocol */
124#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
125#define IPPROTO_MUX 18 /* Multiplexing */
126#define IPPROTO_MEAS 19 /* DCN Measurement Subsystems */
127#define IPPROTO_HMP 20 /* Host Monitoring */
128#define IPPROTO_PRM 21 /* Packet Radio Measurement */
129#define IPPROTO_IDP 22 /* xns idp */
130#define IPPROTO_TRUNK1 23 /* Trunk-1 */
131#define IPPROTO_TRUNK2 24 /* Trunk-2 */
132#define IPPROTO_LEAF1 25 /* Leaf-1 */
133#define IPPROTO_LEAF2 26 /* Leaf-2 */
134#define IPPROTO_RDP 27 /* Reliable Data */
135#define IPPROTO_IRTP 28 /* Reliable Transaction */
136#define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
137#define IPPROTO_BLT 30 /* Bulk Data Transfer */
138#define IPPROTO_NSP 31 /* Network Services */
139#define IPPROTO_INP 32 /* Merit Internodal */
140#define IPPROTO_SEP 33 /* Sequential Exchange */
141#define IPPROTO_3PC 34 /* Third Party Connect */
142#define IPPROTO_IDPR 35 /* InterDomain Policy Routing */
143#define IPPROTO_XTP 36 /* XTP */
144#define IPPROTO_DDP 37 /* Datagram Delivery */
145#define IPPROTO_CMTP 38 /* Control Message Transport */
146#define IPPROTO_TPXX 39 /* TP++ Transport */
147#define IPPROTO_IL 40 /* IL transport protocol */
148#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
149#define IPPROTO_IPV6 41 /* IP6 header */
150#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
151#define IPPROTO_SDRP 42 /* Source Demand Routing */
152#define IPPROTO_ROUTING 43 /* IP6 routing header */
153#define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
154#define IPPROTO_IDRP 45 /* InterDomain Routing*/
155#define IPPROTO_RSVP 46 /* resource reservation */
156#define IPPROTO_GRE 47 /* General Routing Encap. */
157#define IPPROTO_MHRP 48 /* Mobile Host Routing */
158#define IPPROTO_BHA 49 /* BHA */
159#define IPPROTO_ESP 50 /* IP6 Encap Sec. Payload */
160#define IPPROTO_AH 51 /* IP6 Auth Header */
161#define IPPROTO_INLSP 52 /* Integ. Net Layer Security */
162#define IPPROTO_SWIPE 53 /* IP with encryption */
163#define IPPROTO_NHRP 54 /* Next Hop Resolution */
164/* 55-57: Unassigned */
165#define IPPROTO_ICMPV6 58 /* ICMP6 */
166#define IPPROTO_NONE 59 /* IP6 no next header */
167#define IPPROTO_DSTOPTS 60 /* IP6 destination option */
168#define IPPROTO_AHIP 61 /* any host internal protocol */
169#define IPPROTO_CFTP 62 /* CFTP */
170#define IPPROTO_HELLO 63 /* "hello" routing protocol */
171#define IPPROTO_SATEXPAK 64 /* SATNET/Backroom EXPAK */
172#define IPPROTO_KRYPTOLAN 65 /* Kryptolan */
173#define IPPROTO_RVD 66 /* Remote Virtual Disk */
174#define IPPROTO_IPPC 67 /* Pluribus Packet Core */
175#define IPPROTO_ADFS 68 /* Any distributed FS */
176#define IPPROTO_SATMON 69 /* Satnet Monitoring */
177#define IPPROTO_VISA 70 /* VISA Protocol */
178#define IPPROTO_IPCV 71 /* Packet Core Utility */
179#define IPPROTO_CPNX 72 /* Comp. Prot. Net. Executive */
180#define IPPROTO_CPHB 73 /* Comp. Prot. HeartBeat */
181#define IPPROTO_WSN 74 /* Wang Span Network */
182#define IPPROTO_PVP 75 /* Packet Video Protocol */
183#define IPPROTO_BRSATMON 76 /* BackRoom SATNET Monitoring */
184#define IPPROTO_ND 77 /* Sun net disk proto (temp.) */
185#define IPPROTO_WBMON 78 /* WIDEBAND Monitoring */
186#define IPPROTO_WBEXPAK 79 /* WIDEBAND EXPAK */
187#define IPPROTO_EON 80 /* ISO cnlp */
188#define IPPROTO_VMTP 81 /* VMTP */
189#define IPPROTO_SVMTP 82 /* Secure VMTP */
190#define IPPROTO_VINES 83 /* Banyon VINES */
191#define IPPROTO_TTP 84 /* TTP */
192#define IPPROTO_IGP 85 /* NSFNET-IGP */
193#define IPPROTO_DGP 86 /* dissimilar gateway prot. */
194#define IPPROTO_TCF 87 /* TCF */
195#define IPPROTO_IGRP 88 /* Cisco/GXS IGRP */
196#define IPPROTO_OSPFIGP 89 /* OSPFIGP */
197#define IPPROTO_SRPC 90 /* Strite RPC protocol */
198#define IPPROTO_LARP 91 /* Locus Address Resoloution */
199#define IPPROTO_MTP 92 /* Multicast Transport */
200#define IPPROTO_AX25 93 /* AX.25 Frames */
201#define IPPROTO_IPEIP 94 /* IP encapsulated in IP */
202#define IPPROTO_MICP 95 /* Mobile Int.ing control */
203#define IPPROTO_SCCSP 96 /* Semaphore Comm. security */
204#define IPPROTO_ETHERIP 97 /* Ethernet IP encapsulation */
205#define IPPROTO_ENCAP 98 /* encapsulation header */
206#define IPPROTO_APES 99 /* any private encr. scheme */
207#define IPPROTO_GMTP 100 /* GMTP*/
208/* 101-254: Partly Unassigned */
209#define IPPROTO_PIM 103 /* Protocol Independent Mcast */
210#define IPPROTO_IPCOMP 108 /* payload compression (IPComp) */
211#define IPPROTO_PGM 113 /* PGM */
212#define IPPROTO_SCTP 132 /* SCTP */
213/* 255: Reserved */
214/* BSD Private, local use, namespace incursion */
215#define IPPROTO_DIVERT 254 /* divert pseudo-protocol */
216#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
217#define IPPROTO_RAW 255 /* raw IP packet */
218
219#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
220#define IPPROTO_MAX 256
221
222/* last return value of *_input(), meaning "all job for this pkt is done". */
223#define IPPROTO_DONE 257
224#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
225
226/*
227 * Local port number conventions:
228 *
229 * When a user does a bind(2) or connect(2) with a port number of zero,
230 * a non-conflicting local port address is chosen.
231 * The default range is IPPORT_RESERVED through
232 * IPPORT_USERRESERVED, although that is settable by sysctl.
233 *
234 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
235 * default assignment range.
236 *
237 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
238 *
239 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
240 * into the "high" range. These are reserved for client outbound connections
241 * which do not want to be filtered by any firewalls.
242 *
243 * The value IP_PORTRANGE_LOW changes the range to the "low" are
244 * that is (by convention) restricted to privileged processes. This
245 * convention is based on "vouchsafe" principles only. It is only secure
246 * if you trust the remote host to restrict these ports.
247 *
248 * The default range of ports and the high range can be changed by
249 * sysctl(3). (net.inet.ip.port{hi,low}{first,last}_auto)
250 *
251 * Changing those values has bad security implications if you are
252 * using a a stateless firewall that is allowing packets outside of that
253 * range in order to allow transparent outgoing connections.
254 *
255 * Such a firewall configuration will generally depend on the use of these
256 * default values. If you change them, you may find your Security
257 * Administrator looking for you with a heavy object.
258 *
259 * For a slightly more orthodox text view on this:
260 *
261 * ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
262 *
263 * port numbers are divided into three ranges:
264 *
265 * 0 - 1023 Well Known Ports
266 * 1024 - 49151 Registered Ports
267 * 49152 - 65535 Dynamic and/or Private Ports
268 *
269 */
270
271#define __DARWIN_IPPORT_RESERVED 1024
272
273#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
274/*
275 * Ports < IPPORT_RESERVED are reserved for
276 * privileged processes (e.g. root). (IP_PORTRANGE_LOW)
277 * Ports > IPPORT_USERRESERVED are reserved
278 * for servers, not necessarily privileged. (IP_PORTRANGE_DEFAULT)
279 */
280#ifndef IPPORT_RESERVED
281#define IPPORT_RESERVED __DARWIN_IPPORT_RESERVED
282#endif
283#define IPPORT_USERRESERVED 5000
284
285/*
286 * Default local port range to use by setting IP_PORTRANGE_HIGH
287 */
288#define IPPORT_HIFIRSTAUTO 49152
289#define IPPORT_HILASTAUTO 65535
290
291/*
292 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
293 * but higher than IPPORT_RESERVEDSTART. Traditionally the start value was
294 * 512, but that conflicts with some well-known-services that firewalls may
295 * have a fit if we use.
296 */
297#define IPPORT_RESERVEDSTART 600
298#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
299
300/*
301 * Internet address (a structure for historical reasons)
302 */
303struct in_addr {
304 in_addr_t s_addr;
305};
306
307/*
308 * Definitions of bits in internet address integers.
309 * On subnets, the decomposition of addresses to host and net parts
310 * is done according to subnet mask, not the masks here.
311 */
312#define INADDR_ANY (u_int32_t)0x00000000
313#define INADDR_BROADCAST (u_int32_t)0xffffffff /* must be masked */
314
315#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
316#define IN_CLASSA(i) (((u_int32_t)(i) & 0x80000000) == 0)
317#define IN_CLASSA_NET 0xff000000
318#define IN_CLASSA_NSHIFT 24
319#define IN_CLASSA_HOST 0x00ffffff
320#define IN_CLASSA_MAX 128
321
322#define IN_CLASSB(i) (((u_int32_t)(i) & 0xc0000000) == 0x80000000)
323#define IN_CLASSB_NET 0xffff0000
324#define IN_CLASSB_NSHIFT 16
325#define IN_CLASSB_HOST 0x0000ffff
326#define IN_CLASSB_MAX 65536
327
328#define IN_CLASSC(i) (((u_int32_t)(i) & 0xe0000000) == 0xc0000000)
329#define IN_CLASSC_NET 0xffffff00
330#define IN_CLASSC_NSHIFT 8
331#define IN_CLASSC_HOST 0x000000ff
332
333#define IN_CLASSD(i) (((u_int32_t)(i) & 0xf0000000) == 0xe0000000)
334#define IN_CLASSD_NET 0xf0000000 /* These ones aren't really */
335#define IN_CLASSD_NSHIFT 28 /* net and host fields, but */
336#define IN_CLASSD_HOST 0x0fffffff /* routing needn't know. */
337#define IN_MULTICAST(i) IN_CLASSD(i)
338
339#define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
340#define IN_BADCLASS(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
341
342#define INADDR_LOOPBACK (u_int32_t)0x7f000001
343
344#ifndef KERNEL
345#define INADDR_NONE 0xffffffff /* -1 return */
346#endif
347
348#define INADDR_UNSPEC_GROUP (u_int32_t)0xe0000000 /* 224.0.0.0 */
349#define INADDR_ALLHOSTS_GROUP (u_int32_t)0xe0000001 /* 224.0.0.1 */
350#define INADDR_ALLRTRS_GROUP (u_int32_t)0xe0000002 /* 224.0.0.2 */
351#define INADDR_ALLRPTS_GROUP (u_int32_t)0xe0000016 /* 224.0.0.22, IGMPv3 */
352#define INADDR_CARP_GROUP (u_int32_t)0xe0000012 /* 224.0.0.18 */
353#define INADDR_PFSYNC_GROUP (u_int32_t)0xe00000f0 /* 224.0.0.240 */
354#define INADDR_ALLMDNS_GROUP (u_int32_t)0xe00000fb /* 224.0.0.251 */
355#define INADDR_MAX_LOCAL_GROUP (u_int32_t)0xe00000ff /* 224.0.0.255 */
356
357#ifdef __APPLE__
358#define IN_LINKLOCALNETNUM (u_int32_t)0xA9FE0000 /* 169.254.0.0 */
359#define IN_LINKLOCAL(i) (((u_int32_t)(i) & IN_CLASSB_NET) == IN_LINKLOCALNETNUM)
360#define IN_LOOPBACK(i) (((u_int32_t)(i) & 0xff000000) == 0x7f000000)
361#define IN_ZERONET(i) (((u_int32_t)(i) & 0xff000000) == 0)
362
363#define IN_PRIVATE(i) ((((u_int32_t)(i) & 0xff000000) == 0x0a000000) || \
364 (((u_int32_t)(i) & 0xfff00000) == 0xac100000) || \
365 (((u_int32_t)(i) & 0xffff0000) == 0xc0a80000))
366
367#ifdef PRIVATE
368#define IN_SHARED_ADDRESS_SPACE(i) ((((u_int32_t)(i)) & (u_int32_t)0xffc00000) \
369 == (u_int32_t)0x64400000)
370
371#define IN_DS_LITE(i) ((((u_int32_t)(i)) & (u_int32_t)0xfffffff8) == (u_int32_t)0xc0000000)
372
373#define IN_6TO4_RELAY_ANYCAST(i) ((((u_int32_t)(i)) & (u_int32_t)IN_CLASSC_NET) == (u_int32_t)0xc0586300)
374#endif
375
376#define IN_LOCAL_GROUP(i) (((u_int32_t)(i) & 0xffffff00) == 0xe0000000)
377
378#define IN_ANY_LOCAL(i) (IN_LINKLOCAL(i) || IN_LOCAL_GROUP(i))
379#endif /* __APPLE__ */
380
381#define IN_LOOPBACKNET 127 /* official! */
382#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
383
384/*
385 * Socket address, internet style.
386 */
387struct sockaddr_in {
388 __uint8_t sin_len;
389 sa_family_t sin_family;
390 in_port_t sin_port;
391 struct in_addr sin_addr;
392 char sin_zero[8];
393};
394
395#define IN_ARE_ADDR_EQUAL(a, b) \
396 (bcmp(&(a)->s_addr, &(b)->s_addr, \
397 sizeof (struct in_addr)) == 0)
398
399#ifdef PRIVATE
400/*
401 * sockaddr_in with scope ID field; this is used internally to keep
402 * track of scoped route entries in the routing table. The fact that
403 * such a value is embedded in the structure is an artifact of the
404 * current implementation which could change in future.
405 */
406struct sockaddr_inifscope {
407 __uint8_t sin_len;
408 sa_family_t sin_family;
409 in_port_t sin_port;
410 struct in_addr sin_addr;
411 /*
412 * To avoid possible conflict with an overlaid sockaddr_inarp
413 * having sin_other set to SIN_PROXY, we use the first 4-bytes
414 * of sin_zero since sin_srcaddr is one of the unused fields
415 * in sockaddr_inarp.
416 */
417 union {
418 char sin_zero[8];
419 struct {
420 __uint32_t ifscope;
421 } _in_index;
422 } un;
423#define sin_scope_id un._in_index.ifscope
424};
425
426#endif /* PRIVATE */
427
428#define INET_ADDRSTRLEN 16
429
430#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
431/*
432 * Structure used to describe IP options.
433 * Used to store options internally, to pass them to a process,
434 * or to restore options retrieved earlier.
435 * The ip_dst is used for the first-hop gateway when using a source route
436 * (this gets put into the header proper).
437 */
438struct ip_opts {
439 struct in_addr ip_dst; /* first hop, 0 w/o src rt */
440 char ip_opts[40]; /* actually variable in size */
441};
442
443/*
444 * Options for use with [gs]etsockopt at the IP level.
445 * First word of comment is data type; bool is stored in int.
446 */
447#define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
448#define IP_HDRINCL 2 /* int; header is included with data */
449#define IP_TOS 3 /* int; IP type of service and preced. */
450#define IP_TTL 4 /* int; IP time to live */
451#define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
452#define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
453#define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
454#define IP_RETOPTS 8 /* ip_opts; set/get IP options */
455#define IP_MULTICAST_IF 9 /* u_char; set/get IP multicast i/f */
456#define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
457#define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
458#define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
459#define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
460#define IP_MULTICAST_VIF 14 /* set/get IP mcast virt. iface */
461#define IP_RSVP_ON 15 /* enable RSVP in kernel */
462#define IP_RSVP_OFF 16 /* disable RSVP in kernel */
463#define IP_RSVP_VIF_ON 17 /* set RSVP per-vif socket */
464#define IP_RSVP_VIF_OFF 18 /* unset RSVP per-vif socket */
465#define IP_PORTRANGE 19 /* int; range to choose for unspec port */
466#define IP_RECVIF 20 /* bool; receive reception if w/dgram */
467/* for IPSEC */
468#define IP_IPSEC_POLICY 21 /* int; set/get security policy */
469#define IP_FAITH 22 /* deprecated */
470#ifdef __APPLE__
471#define IP_STRIPHDR 23 /* bool: drop receive of raw IP header */
472#endif
473#define IP_RECVTTL 24 /* bool; receive reception TTL w/dgram */
474#define IP_BOUND_IF 25 /* int; set/get bound interface */
475#define IP_PKTINFO 26 /* get pktinfo on recv socket, set src on sent dgram */
476#define IP_RECVPKTINFO IP_PKTINFO /* receive pktinfo w/dgram */
477#define IP_RECVTOS 27 /* bool; receive IP TOS w/dgram */
478
479#define IP_FW_ADD 40 /* add a firewall rule to chain */
480#define IP_FW_DEL 41 /* delete a firewall rule from chain */
481#define IP_FW_FLUSH 42 /* flush firewall rule chain */
482#define IP_FW_ZERO 43 /* clear single/all firewall counter(s) */
483#define IP_FW_GET 44 /* get entire firewall rule chain */
484#define IP_FW_RESETLOG 45 /* reset logging counters */
485
486/* These older firewall socket option codes are maintained for backward compatibility. */
487#define IP_OLD_FW_ADD 50 /* add a firewall rule to chain */
488#define IP_OLD_FW_DEL 51 /* delete a firewall rule from chain */
489#define IP_OLD_FW_FLUSH 52 /* flush firewall rule chain */
490#define IP_OLD_FW_ZERO 53 /* clear single/all firewall counter(s) */
491#define IP_OLD_FW_GET 54 /* get entire firewall rule chain */
492#define IP_NAT__XXX 55 /* set/get NAT opts XXX Deprecated, do not use */
493#define IP_OLD_FW_RESETLOG 56 /* reset logging counters */
494
495#define IP_DUMMYNET_CONFIGURE 60 /* add/configure a dummynet pipe */
496#define IP_DUMMYNET_DEL 61 /* delete a dummynet pipe from chain */
497#define IP_DUMMYNET_FLUSH 62 /* flush dummynet */
498#define IP_DUMMYNET_GET 64 /* get entire dummynet pipes */
499
500#define IP_TRAFFIC_MGT_BACKGROUND 65 /* int*; get background IO flags; set background IO */
501#define IP_MULTICAST_IFINDEX 66 /* int*; set/get IP multicast i/f index */
502
503/* IPv4 Source Filter Multicast API [RFC3678] */
504#define IP_ADD_SOURCE_MEMBERSHIP 70 /* join a source-specific group */
505#define IP_DROP_SOURCE_MEMBERSHIP 71 /* drop a single source */
506#define IP_BLOCK_SOURCE 72 /* block a source */
507#define IP_UNBLOCK_SOURCE 73 /* unblock a source */
508
509/* The following option is private; do not use it from user applications. */
510#define IP_MSFILTER 74 /* set/get filter list */
511
512/* Protocol Independent Multicast API [RFC3678] */
513#define MCAST_JOIN_GROUP 80 /* join an any-source group */
514#define MCAST_LEAVE_GROUP 81 /* leave all sources for group */
515#define MCAST_JOIN_SOURCE_GROUP 82 /* join a source-specific group */
516#define MCAST_LEAVE_SOURCE_GROUP 83 /* leave a single source */
517#define MCAST_BLOCK_SOURCE 84 /* block a source */
518#define MCAST_UNBLOCK_SOURCE 85 /* unblock a source */
519
520#ifdef PRIVATE
521#define IP_FORCE_OUT_IFP 69 /* not implemented; use IP_BOUND_IF instead */
522#define IP_NO_IFT_CELLULAR 6969 /* for internal use only */
523#define IP_NO_IFT_PDP IP_NO_IFT_CELLULAR /* deprecated */
524#define IP_OUT_IF 9696 /* for internal use only */
525#endif /* PRIVATE */
526
527/*
528 * Defaults and limits for options
529 */
530#define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
531#define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
532
533/*
534 * The imo_membership vector for each socket is now dynamically allocated at
535 * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
536 * according to a power-of-two increment.
537 */
538#define IP_MIN_MEMBERSHIPS 31
539#define IP_MAX_MEMBERSHIPS 4095
540
541/*
542 * Default resource limits for IPv4 multicast source filtering.
543 * These may be modified by sysctl.
544 */
545#define IP_MAX_GROUP_SRC_FILTER 512 /* sources per group */
546#define IP_MAX_SOCK_SRC_FILTER 128 /* sources per socket/group */
547#define IP_MAX_SOCK_MUTE_FILTER 128 /* XXX no longer used */
548
549/*
550 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
551 */
552struct ip_mreq {
553 struct in_addr imr_multiaddr; /* IP multicast address of group */
554 struct in_addr imr_interface; /* local IP address of interface */
555};
556
557/*
558 * Modified argument structure for IP_MULTICAST_IF, obtained from Linux.
559 * This is used to specify an interface index for multicast sends, as
560 * the IPv4 legacy APIs do not support this (unless IP_SENDIF is available).
561 */
562struct ip_mreqn {
563 struct in_addr imr_multiaddr; /* IP multicast address of group */
564 struct in_addr imr_address; /* local IP address of interface */
565 int imr_ifindex; /* Interface index; cast to uint32_t */
566};
567
568#pragma pack(4)
569/*
570 * Argument structure for IPv4 Multicast Source Filter APIs. [RFC3678]
571 */
572struct ip_mreq_source {
573 struct in_addr imr_multiaddr; /* IP multicast address of group */
574 struct in_addr imr_sourceaddr; /* IP address of source */
575 struct in_addr imr_interface; /* local IP address of interface */
576};
577
578/*
579 * Argument structures for Protocol-Independent Multicast Source
580 * Filter APIs. [RFC3678]
581 */
582struct group_req {
583 uint32_t gr_interface; /* interface index */
584 struct sockaddr_storage gr_group; /* group address */
585};
586
587struct group_source_req {
588 uint32_t gsr_interface; /* interface index */
589 struct sockaddr_storage gsr_group; /* group address */
590 struct sockaddr_storage gsr_source; /* source address */
591};
592
593#ifndef __MSFILTERREQ_DEFINED
594#define __MSFILTERREQ_DEFINED
595/*
596 * The following structure is private; do not use it from user applications.
597 * It is used to communicate IP_MSFILTER/IPV6_MSFILTER information between
598 * the RFC 3678 libc functions and the kernel.
599 */
600struct __msfilterreq {
601 uint32_t msfr_ifindex; /* interface index */
602 uint32_t msfr_fmode; /* filter mode for group */
603 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
604 uint32_t __msfr_align;
605 struct sockaddr_storage msfr_group; /* group address */
606 struct sockaddr_storage *msfr_srcs;
607};
608
609#ifdef BSD_KERNEL_PRIVATE
610struct __msfilterreq32 {
611 uint32_t msfr_ifindex; /* interface index */
612 uint32_t msfr_fmode; /* filter mode for group */
613 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
614 uint32_t __msfr_align;
615 struct sockaddr_storage msfr_group; /* group address */
616 user32_addr_t msfr_srcs;
617};
618
619struct __msfilterreq64 {
620 uint32_t msfr_ifindex; /* interface index */
621 uint32_t msfr_fmode; /* filter mode for group */
622 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
623 uint32_t __msfr_align;
624 struct sockaddr_storage msfr_group; /* group address */
625 user64_addr_t msfr_srcs;
626};
627#endif /* BSD_KERNEL_PRIVATE */
628#endif /* __MSFILTERREQ_DEFINED */
629
630#pragma pack()
631struct sockaddr;
632
633#ifndef KERNEL
634/*
635 * Advanced (Full-state) APIs [RFC3678]
636 * The RFC specifies uint_t for the 6th argument to [sg]etsourcefilter().
637 * We use uint32_t here to be consistent.
638 */
639int setipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t,
640 uint32_t, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
641int getipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t *,
642 uint32_t *, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
643int setsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
644 uint32_t, uint32_t, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
645int getsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
646 uint32_t *, uint32_t *, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
647#endif
648
649/*
650 * Filter modes; also used to represent per-socket filter mode internally.
651 */
652#define MCAST_UNDEFINED 0 /* fmode: not yet defined */
653#define MCAST_INCLUDE 1 /* fmode: include these source(s) */
654#define MCAST_EXCLUDE 2 /* fmode: exclude these source(s) */
655
656/*
657 * Argument for IP_PORTRANGE:
658 * - which range to search when port is unspecified at bind() or connect()
659 */
660#define IP_PORTRANGE_DEFAULT 0 /* default range */
661#define IP_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
662#define IP_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
663
664
665/*
666 * IP_PKTINFO: Packet information (equivalent to RFC2292 sec 5 for IPv4)
667 * This structure is used for
668 *
669 * 1) Receiving ancilliary data about the datagram if IP_PKTINFO sockopt is
670 * set on the socket. In this case ipi_ifindex will contain the interface
671 * index the datagram was received on, ipi_addr is the IP address the
672 * datagram was received to.
673 *
674 * 2) Sending a datagram using a specific interface or IP source address.
675 * if ipi_ifindex is set to non-zero when in_pktinfo is passed as
676 * ancilliary data of type IP_PKTINFO, this will be used as the source
677 * interface to send the datagram from. If ipi_ifindex is null, ip_spec_dst
678 * will be used for the source address.
679 *
680 * Note: if IP_BOUND_IF is set on the socket, ipi_ifindex in the ancillary
681 * IP_PKTINFO option silently overrides the bound interface when it is
682 * specified during send time.
683 */
684struct in_pktinfo {
685 unsigned int ipi_ifindex; /* send/recv interface index */
686 struct in_addr ipi_spec_dst; /* Local address */
687 struct in_addr ipi_addr; /* IP Header dst address */
688};
689
690/*
691 * Definitions for inet sysctl operations.
692 *
693 * Third level is protocol number.
694 * Fourth level is desired variable within that protocol.
695 */
696#define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */
697
698#ifdef BSD_KERNEL_PRIVATE
699#define CTL_IPPROTO_NAMES { \
700 { "ip", CTLTYPE_NODE }, \
701 { "icmp", CTLTYPE_NODE }, \
702 { "igmp", CTLTYPE_NODE }, \
703 { "ggp", CTLTYPE_NODE }, \
704 { 0, 0 }, \
705 { 0, 0 }, \
706 { "tcp", CTLTYPE_NODE }, \
707 { 0, 0 }, \
708 { "egp", CTLTYPE_NODE }, \
709 { 0, 0 }, \
710 { 0, 0 }, \
711 { 0, 0 }, \
712 { "pup", CTLTYPE_NODE }, \
713 { 0, 0 }, \
714 { 0, 0 }, \
715 { 0, 0 }, \
716 { 0, 0 }, \
717 { "udp", CTLTYPE_NODE }, \
718 { 0, 0 }, \
719 { 0, 0 }, \
720 { 0, 0 }, \
721 { 0, 0 }, \
722 { "idp", CTLTYPE_NODE }, \
723 { 0, 0 }, \
724 { 0, 0 }, \
725 { 0, 0 }, \
726 { 0, 0 }, \
727 { 0, 0 }, \
728 { 0, 0 }, \
729 { 0, 0 }, \
730 { 0, 0 }, \
731 { 0, 0 }, \
732 { 0, 0 }, \
733 { 0, 0 }, \
734 { 0, 0 }, \
735 { 0, 0 }, \
736 { 0, 0 }, \
737 { 0, 0 }, \
738 { 0, 0 }, \
739 { 0, 0 }, \
740 { 0, 0 }, \
741 { 0, 0 }, \
742 { 0, 0 }, \
743 { 0, 0 }, \
744 { 0, 0 }, \
745 { 0, 0 }, \
746 { 0, 0 }, \
747 { 0, 0 }, \
748 { 0, 0 }, \
749 { 0, 0 }, \
750 { 0, 0 }, \
751 { "ipsec", CTLTYPE_NODE }, \
752}
753#endif /* BSD_KERNEL_PRIVATE */
754
755/*
756 * Names for IP sysctl objects
757 */
758#define IPCTL_FORWARDING 1 /* act as router */
759#define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
760#define IPCTL_DEFTTL 3 /* default TTL */
761#ifdef notyet
762#define IPCTL_DEFMTU 4 /* default MTU */
763#endif
764#define IPCTL_RTEXPIRE 5 /* cloned route expiration time */
765#define IPCTL_RTMINEXPIRE 6 /* min value for expiration time */
766#define IPCTL_RTMAXCACHE 7 /* trigger level for dynamic expire */
767#define IPCTL_SOURCEROUTE 8 /* may perform source routes */
768#define IPCTL_DIRECTEDBROADCAST 9 /* may re-broadcast received packets */
769#define IPCTL_INTRQMAXLEN 10 /* max length of netisr queue */
770#define IPCTL_INTRQDROPS 11 /* number of netisr q drops */
771#define IPCTL_STATS 12 /* ipstat structure */
772#define IPCTL_ACCEPTSOURCEROUTE 13 /* may accept source routed packets */
773#define IPCTL_FASTFORWARDING 14 /* use fast IP forwarding code */
774#define IPCTL_KEEPFAITH 15 /* deprecated */
775#define IPCTL_GIF_TTL 16 /* default TTL for gif encap packet */
776#define IPCTL_MAXID 17
777
778#ifdef BSD_KERNEL_PRIVATE
779
780#define IPCTL_NAMES { \
781 { 0, 0 }, \
782 { "forwarding", CTLTYPE_INT }, \
783 { "redirect", CTLTYPE_INT }, \
784 { "ttl", CTLTYPE_INT }, \
785 { "mtu", CTLTYPE_INT }, \
786 { "rtexpire", CTLTYPE_INT }, \
787 { "rtminexpire", CTLTYPE_INT }, \
788 { "rtmaxcache", CTLTYPE_INT }, \
789 { "sourceroute", CTLTYPE_INT }, \
790 { "directed-broadcast", CTLTYPE_INT }, \
791 { "intr-queue-maxlen", CTLTYPE_INT }, \
792 { "intr-queue-drops", CTLTYPE_INT }, \
793 { "stats", CTLTYPE_STRUCT }, \
794 { "accept_sourceroute", CTLTYPE_INT }, \
795 { "fastforwarding", CTLTYPE_INT }, \
796 { "keepfaith", CTLTYPE_INT }, \
797 { "gifttl", CTLTYPE_INT }, \
798}
799#endif /* BSD_KERNEL_PRIVATE */
800#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
801
802/* INET6 stuff */
803#define __KAME_NETINET_IN_H_INCLUDED_
804#include <netinet6/in6.h>
805#undef __KAME_NETINET_IN_H_INCLUDED_
806
807#ifdef PRIVATE
808/*
809 * Minimal sized structure to hold an IPv4 or IPv6 socket address
810 * as sockaddr_storage can waste memory
811 */
812union sockaddr_in_4_6 {
813 struct sockaddr sa;
814 struct sockaddr_in sin;
815 struct sockaddr_in6 sin6;
816};
817
818#define CLAT46_HDR_EXPANSION_OVERHD (sizeof(struct ip6_hdr) - sizeof(struct ip))
819
820/*
821 * Recommended DiffServ Code Point values
822 */
823
824#define _DSCP_DF 0 /* RFC 2474 */
825
826#define _DSCP_CS0 0 /* RFC 2474 */
827#define _DSCP_CS1 8 /* RFC 2474 */
828#define _DSCP_CS2 16 /* RFC 2474 */
829#define _DSCP_CS3 24 /* RFC 2474 */
830#define _DSCP_CS4 32 /* RFC 2474 */
831#define _DSCP_CS5 40 /* RFC 2474 */
832#define _DSCP_CS6 48 /* RFC 2474 */
833#define _DSCP_CS7 56 /* RFC 2474 */
834
835#define _DSCP_EF 46 /* RFC 2474 */
836#define _DSCP_VA 44 /* RFC 5865 */
837
838#define _DSCP_AF11 10 /* RFC 2597 */
839#define _DSCP_AF12 12 /* RFC 2597 */
840#define _DSCP_AF13 14 /* RFC 2597 */
841#define _DSCP_AF21 18 /* RFC 2597 */
842#define _DSCP_AF22 20 /* RFC 2597 */
843#define _DSCP_AF23 22 /* RFC 2597 */
844#define _DSCP_AF31 26 /* RFC 2597 */
845#define _DSCP_AF32 28 /* RFC 2597 */
846#define _DSCP_AF33 30 /* RFC 2597 */
847#define _DSCP_AF41 34 /* RFC 2597 */
848#define _DSCP_AF42 36 /* RFC 2597 */
849#define _DSCP_AF43 38 /* RFC 2597 */
850
851#define _DSCP_52 52 /* Wi-Fi WMM Certification: Sigma */
852
853#define _MAX_DSCP 63 /* coded on 6 bits */
854
855#endif /* PRIVATE */
856
857#ifdef KERNEL
858#ifdef BSD_KERNEL_PRIVATE
859#include <mach/boolean.h>
860
861struct ip;
862struct ifnet;
863struct mbuf;
864
865extern boolean_t in_broadcast(struct in_addr, struct ifnet *);
866extern boolean_t in_canforward(struct in_addr);
867extern u_int32_t in_netof(struct in_addr);
868
869extern uint32_t os_cpu_in_cksum_mbuf(struct mbuf *m, int len, int off,
870 uint32_t initial_sum);
871
872extern uint16_t inet_cksum(struct mbuf *, uint32_t, uint32_t, uint32_t);
873extern uint16_t inet_cksum_buffer(const void *, uint32_t, uint32_t, uint32_t);
874extern uint16_t in_addword(uint16_t, uint16_t);
875extern uint16_t in_pseudo(uint32_t, uint32_t, uint32_t);
876extern uint16_t in_pseudo64(uint64_t, uint64_t, uint64_t);
877extern uint16_t in_cksum_hdr_opt(const struct ip *);
878extern uint16_t ip_cksum_hdr_dir(struct mbuf *, uint32_t, int);
879extern uint16_t ip_cksum_hdr_dir_buffer(const void *, uint32_t, uint32_t, int);
880extern uint32_t in_finalize_cksum(struct mbuf *, uint32_t, uint32_t);
881extern uint16_t b_sum16(const void *buf, int len);
882#if DEBUG || DEVELOPMENT
883extern uint32_t in_cksum_mbuf_ref(struct mbuf *, int, int, uint32_t);
884#endif /* DEBUG || DEVELOPMENT */
885
886extern int in_getconninfo(struct socket *, sae_connid_t, uint32_t *,
887 uint32_t *, int32_t *, user_addr_t, socklen_t *, user_addr_t, socklen_t *,
888 uint32_t *, user_addr_t, uint32_t *);
889extern struct in_ifaddr * inifa_ifpwithflag(struct ifnet *, uint32_t);
890extern struct in_ifaddr * inifa_ifpclatv4(struct ifnet *);
891
892#define in_cksum(_m, _l) \
893 inet_cksum(_m, 0, 0, _l)
894#define in_cksum_buffer(_b, _l) \
895 inet_cksum_buffer(_b, 0, 0, _l)
896#define ip_cksum_hdr_in(_m, _l) \
897 ip_cksum_hdr_dir(_m, _l, 0)
898#define ip_cksum_hdr_out(_m, _l) \
899 ip_cksum_hdr_dir(_m, _l, 1)
900
901#define in_cksum_hdr(_ip) \
902 (~b_sum16(_ip, sizeof (struct ip)) & 0xffff)
903
904#define in_cksum_offset(_m, _o) \
905 ((void) in_finalize_cksum(_m, _o, CSUM_DELAY_IP))
906#define in_delayed_cksum(_m) \
907 ((void) in_finalize_cksum(_m, 0, CSUM_DELAY_DATA))
908#define in_delayed_cksum_offset(_m, _o) \
909 ((void) in_finalize_cksum(_m, _o, CSUM_DELAY_DATA))
910
911#define in_hosteq(s, t) ((s).s_addr == (t).s_addr)
912#define in_nullhost(x) ((x).s_addr == INADDR_ANY)
913#define in_allhosts(x) ((x).s_addr == htonl(INADDR_ALLHOSTS_GROUP))
914
915#define SIN(s) ((struct sockaddr_in *)(void *)s)
916#define satosin(sa) SIN(sa)
917#define sintosa(sin) ((struct sockaddr *)(void *)(sin))
918#define SINIFSCOPE(s) ((struct sockaddr_inifscope *)(void *)(s))
919#endif /* BSD_KERNEL_PRIVATE */
920
921#ifdef KERNEL_PRIVATE
922/* exported for ApplicationFirewall */
923extern int in_localaddr(struct in_addr);
924extern int inaddr_local(struct in_addr);
925
926extern char *inet_ntoa(struct in_addr);
927extern char *inet_ntoa_r(struct in_addr ina, char *buf,
928 size_t buflen);
929extern int inet_pton(int af, const char *, void *);
930#endif /* KERNEL_PRIVATE */
931
932#define MAX_IPv4_STR_LEN 16
933#define MAX_IPv6_STR_LEN 64
934
935extern int inet_aton(const char *, struct in_addr *); /* in libkern */
936extern const char *inet_ntop(int, const void *, char *, socklen_t); /* in libkern*/
937#endif /* KERNEL */
938
939#ifndef KERNEL
940#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
941__BEGIN_DECLS
942int bindresvport(int, struct sockaddr_in *);
943struct sockaddr;
944int bindresvport_sa(int, struct sockaddr *);
945__END_DECLS
946#endif
947#endif /* !KERNEL */
948#endif /* _NETINET_IN_H_ */
949