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
67#ifndef DRIVERKIT
68#include <sys/appleapiopts.h>
69#include <stdint.h> /* uint(8|16|32)_t */
70
71#ifndef KERNEL
72#include <Availability.h>
73#endif
74
75#else
76#include <sys/_types.h>
77#include <sys/_types/_sa_family_t.h>
78#endif /* DRIVERKIT */
79
80#include <sys/_types/_in_addr_t.h>
81#include <sys/_types/_in_port_t.h>
82
83#ifndef DRIVERKIT
84/*
85 * POSIX 1003.1-2003
86 * "Inclusion of the <netinet/in.h> header may also make visible all
87 * symbols from <inttypes.h> and <sys/socket.h>".
88 */
89#include <sys/socket.h>
90#endif /* DRIVERKIT */
91
92/*
93 * The following two #includes insure htonl and family are defined
94 */
95#include <machine/endian.h>
96#include <sys/_endian.h>
97
98/*
99 * Constants and structures defined by the internet system,
100 * Per RFC 790, September 1981, and numerous additions.
101 */
102
103/*
104 * Protocols (RFC 1700)
105 */
106#define IPPROTO_IP 0 /* dummy for IP */
107#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
108#define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */
109#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
110#define IPPROTO_ICMP 1 /* control message protocol */
111#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
112#define IPPROTO_IGMP 2 /* group mgmt protocol */
113#define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
114#define IPPROTO_IPV4 4 /* IPv4 encapsulation */
115#define IPPROTO_IPIP IPPROTO_IPV4 /* for compatibility */
116#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
117#define IPPROTO_TCP 6 /* tcp */
118#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
119#define IPPROTO_ST 7 /* Stream protocol II */
120#define IPPROTO_EGP 8 /* exterior gateway protocol */
121#define IPPROTO_PIGP 9 /* private interior gateway */
122#define IPPROTO_RCCMON 10 /* BBN RCC Monitoring */
123#define IPPROTO_NVPII 11 /* network voice protocol*/
124#define IPPROTO_PUP 12 /* pup */
125#define IPPROTO_ARGUS 13 /* Argus */
126#define IPPROTO_EMCON 14 /* EMCON */
127#define IPPROTO_XNET 15 /* Cross Net Debugger */
128#define IPPROTO_CHAOS 16 /* Chaos*/
129#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
130#define IPPROTO_UDP 17 /* user datagram protocol */
131#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
132#define IPPROTO_MUX 18 /* Multiplexing */
133#define IPPROTO_MEAS 19 /* DCN Measurement Subsystems */
134#define IPPROTO_HMP 20 /* Host Monitoring */
135#define IPPROTO_PRM 21 /* Packet Radio Measurement */
136#define IPPROTO_IDP 22 /* xns idp */
137#define IPPROTO_TRUNK1 23 /* Trunk-1 */
138#define IPPROTO_TRUNK2 24 /* Trunk-2 */
139#define IPPROTO_LEAF1 25 /* Leaf-1 */
140#define IPPROTO_LEAF2 26 /* Leaf-2 */
141#define IPPROTO_RDP 27 /* Reliable Data */
142#define IPPROTO_IRTP 28 /* Reliable Transaction */
143#define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
144#define IPPROTO_BLT 30 /* Bulk Data Transfer */
145#define IPPROTO_NSP 31 /* Network Services */
146#define IPPROTO_INP 32 /* Merit Internodal */
147#define IPPROTO_SEP 33 /* Sequential Exchange */
148#define IPPROTO_3PC 34 /* Third Party Connect */
149#define IPPROTO_IDPR 35 /* InterDomain Policy Routing */
150#define IPPROTO_XTP 36 /* XTP */
151#define IPPROTO_DDP 37 /* Datagram Delivery */
152#define IPPROTO_CMTP 38 /* Control Message Transport */
153#define IPPROTO_TPXX 39 /* TP++ Transport */
154#define IPPROTO_IL 40 /* IL transport protocol */
155#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
156#define IPPROTO_IPV6 41 /* IP6 header */
157#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
158#define IPPROTO_SDRP 42 /* Source Demand Routing */
159#define IPPROTO_ROUTING 43 /* IP6 routing header */
160#define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
161#define IPPROTO_IDRP 45 /* InterDomain Routing*/
162#define IPPROTO_RSVP 46 /* resource reservation */
163#define IPPROTO_GRE 47 /* General Routing Encap. */
164#define IPPROTO_MHRP 48 /* Mobile Host Routing */
165#define IPPROTO_BHA 49 /* BHA */
166#define IPPROTO_ESP 50 /* IP6 Encap Sec. Payload */
167#define IPPROTO_AH 51 /* IP6 Auth Header */
168#define IPPROTO_INLSP 52 /* Integ. Net Layer Security */
169#define IPPROTO_SWIPE 53 /* IP with encryption */
170#define IPPROTO_NHRP 54 /* Next Hop Resolution */
171/* 55-57: Unassigned */
172#define IPPROTO_ICMPV6 58 /* ICMP6 */
173#define IPPROTO_NONE 59 /* IP6 no next header */
174#define IPPROTO_DSTOPTS 60 /* IP6 destination option */
175#define IPPROTO_AHIP 61 /* any host internal protocol */
176#define IPPROTO_CFTP 62 /* CFTP */
177#define IPPROTO_HELLO 63 /* "hello" routing protocol */
178#define IPPROTO_SATEXPAK 64 /* SATNET/Backroom EXPAK */
179#define IPPROTO_KRYPTOLAN 65 /* Kryptolan */
180#define IPPROTO_RVD 66 /* Remote Virtual Disk */
181#define IPPROTO_IPPC 67 /* Pluribus Packet Core */
182#define IPPROTO_ADFS 68 /* Any distributed FS */
183#define IPPROTO_SATMON 69 /* Satnet Monitoring */
184#define IPPROTO_VISA 70 /* VISA Protocol */
185#define IPPROTO_IPCV 71 /* Packet Core Utility */
186#define IPPROTO_CPNX 72 /* Comp. Prot. Net. Executive */
187#define IPPROTO_CPHB 73 /* Comp. Prot. HeartBeat */
188#define IPPROTO_WSN 74 /* Wang Span Network */
189#define IPPROTO_PVP 75 /* Packet Video Protocol */
190#define IPPROTO_BRSATMON 76 /* BackRoom SATNET Monitoring */
191#define IPPROTO_ND 77 /* Sun net disk proto (temp.) */
192#define IPPROTO_WBMON 78 /* WIDEBAND Monitoring */
193#define IPPROTO_WBEXPAK 79 /* WIDEBAND EXPAK */
194#define IPPROTO_EON 80 /* ISO cnlp */
195#define IPPROTO_VMTP 81 /* VMTP */
196#define IPPROTO_SVMTP 82 /* Secure VMTP */
197#define IPPROTO_VINES 83 /* Banyon VINES */
198#define IPPROTO_TTP 84 /* TTP */
199#define IPPROTO_IGP 85 /* NSFNET-IGP */
200#define IPPROTO_DGP 86 /* dissimilar gateway prot. */
201#define IPPROTO_TCF 87 /* TCF */
202#define IPPROTO_IGRP 88 /* Cisco/GXS IGRP */
203#define IPPROTO_OSPFIGP 89 /* OSPFIGP */
204#define IPPROTO_SRPC 90 /* Strite RPC protocol */
205#define IPPROTO_LARP 91 /* Locus Address Resoloution */
206#define IPPROTO_MTP 92 /* Multicast Transport */
207#define IPPROTO_AX25 93 /* AX.25 Frames */
208#define IPPROTO_IPEIP 94 /* IP encapsulated in IP */
209#define IPPROTO_MICP 95 /* Mobile Int.ing control */
210#define IPPROTO_SCCSP 96 /* Semaphore Comm. security */
211#define IPPROTO_ETHERIP 97 /* Ethernet IP encapsulation */
212#define IPPROTO_ENCAP 98 /* encapsulation header */
213#define IPPROTO_APES 99 /* any private encr. scheme */
214#define IPPROTO_GMTP 100 /* GMTP*/
215/* 101-252: Partly Unassigned */
216#define IPPROTO_PIM 103 /* Protocol Independent Mcast */
217#define IPPROTO_IPCOMP 108 /* payload compression (IPComp) */
218#define IPPROTO_PGM 113 /* PGM */
219#define IPPROTO_SCTP 132 /* SCTP */
220/* 253-254: Experimentation and testing; 255: Reserved (RFC3692) */
221/* BSD Private, local use, namespace incursion */
222#define IPPROTO_DIVERT 254 /* divert pseudo-protocol */
223#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
224#define IPPROTO_RAW 255 /* raw IP packet */
225
226#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
227#define IPPROTO_MAX 256
228
229/* last return value of *_input(), meaning "all job for this pkt is done". */
230#define IPPROTO_DONE 257
231#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
232
233/*
234 * Local port number conventions:
235 *
236 * When a user does a bind(2) or connect(2) with a port number of zero,
237 * a non-conflicting local port address is chosen.
238 * The default range is IPPORT_RESERVED through
239 * IPPORT_USERRESERVED, although that is settable by sysctl.
240 *
241 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
242 * default assignment range.
243 *
244 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
245 *
246 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
247 * into the "high" range. These are reserved for client outbound connections
248 * which do not want to be filtered by any firewalls.
249 *
250 * The value IP_PORTRANGE_LOW changes the range to the "low" are
251 * that is (by convention) restricted to privileged processes. This
252 * convention is based on "vouchsafe" principles only. It is only secure
253 * if you trust the remote host to restrict these ports.
254 *
255 * The default range of ports and the high range can be changed by
256 * sysctl(3). (net.inet.ip.port{hi,low}{first,last}_auto)
257 *
258 * Changing those values has bad security implications if you are
259 * using a a stateless firewall that is allowing packets outside of that
260 * range in order to allow transparent outgoing connections.
261 *
262 * Such a firewall configuration will generally depend on the use of these
263 * default values. If you change them, you may find your Security
264 * Administrator looking for you with a heavy object.
265 *
266 * For a slightly more orthodox text view on this:
267 *
268 * ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
269 *
270 * port numbers are divided into three ranges:
271 *
272 * 0 - 1023 Well Known Ports
273 * 1024 - 49151 Registered Ports
274 * 49152 - 65535 Dynamic and/or Private Ports
275 *
276 */
277
278#define __DARWIN_IPPORT_RESERVED 1024
279
280#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
281/*
282 * Ports < IPPORT_RESERVED are reserved for
283 * privileged processes (e.g. root). (IP_PORTRANGE_LOW)
284 * Ports > IPPORT_USERRESERVED are reserved
285 * for servers, not necessarily privileged. (IP_PORTRANGE_DEFAULT)
286 */
287#ifndef IPPORT_RESERVED
288#define IPPORT_RESERVED __DARWIN_IPPORT_RESERVED
289#endif
290#define IPPORT_USERRESERVED 5000
291
292/*
293 * Default local port range to use by setting IP_PORTRANGE_HIGH
294 */
295#define IPPORT_HIFIRSTAUTO 49152
296#define IPPORT_HILASTAUTO 65535
297
298/*
299 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
300 * but higher than IPPORT_RESERVEDSTART. Traditionally the start value was
301 * 512, but that conflicts with some well-known-services that firewalls may
302 * have a fit if we use.
303 */
304#define IPPORT_RESERVEDSTART 600
305#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
306
307/*
308 * Internet address (a structure for historical reasons)
309 */
310struct in_addr {
311 in_addr_t s_addr;
312};
313
314/*
315 * Definitions of bits in internet address integers.
316 * On subnets, the decomposition of addresses to host and net parts
317 * is done according to subnet mask, not the masks here.
318 */
319#define INADDR_ANY (u_int32_t)0x00000000
320#define INADDR_BROADCAST (u_int32_t)0xffffffff /* must be masked */
321
322#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
323#define IN_CLASSA(i) (((u_int32_t)(i) & 0x80000000) == 0)
324#define IN_CLASSA_NET 0xff000000
325#define IN_CLASSA_NSHIFT 24
326#define IN_CLASSA_HOST 0x00ffffff
327#define IN_CLASSA_MAX 128
328
329#define IN_CLASSB(i) (((u_int32_t)(i) & 0xc0000000) == 0x80000000)
330#define IN_CLASSB_NET 0xffff0000
331#define IN_CLASSB_NSHIFT 16
332#define IN_CLASSB_HOST 0x0000ffff
333#define IN_CLASSB_MAX 65536
334
335#define IN_CLASSC(i) (((u_int32_t)(i) & 0xe0000000) == 0xc0000000)
336#define IN_CLASSC_NET 0xffffff00
337#define IN_CLASSC_NSHIFT 8
338#define IN_CLASSC_HOST 0x000000ff
339
340#define IN_CLASSD(i) (((u_int32_t)(i) & 0xf0000000) == 0xe0000000)
341#define IN_CLASSD_NET 0xf0000000 /* These ones aren't really */
342#define IN_CLASSD_NSHIFT 28 /* net and host fields, but */
343#define IN_CLASSD_HOST 0x0fffffff /* routing needn't know. */
344#define IN_MULTICAST(i) IN_CLASSD(i)
345
346#define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
347#define IN_BADCLASS(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
348
349#define INADDR_LOOPBACK (u_int32_t)0x7f000001
350
351#ifndef KERNEL
352#define INADDR_NONE 0xffffffff /* -1 return */
353#endif
354
355#define INADDR_UNSPEC_GROUP (u_int32_t)0xe0000000 /* 224.0.0.0 */
356#define INADDR_ALLHOSTS_GROUP (u_int32_t)0xe0000001 /* 224.0.0.1 */
357#define INADDR_ALLRTRS_GROUP (u_int32_t)0xe0000002 /* 224.0.0.2 */
358#define INADDR_ALLRPTS_GROUP (u_int32_t)0xe0000016 /* 224.0.0.22, IGMPv3 */
359#define INADDR_CARP_GROUP (u_int32_t)0xe0000012 /* 224.0.0.18 */
360#define INADDR_PFSYNC_GROUP (u_int32_t)0xe00000f0 /* 224.0.0.240 */
361#define INADDR_ALLMDNS_GROUP (u_int32_t)0xe00000fb /* 224.0.0.251 */
362#define INADDR_MAX_LOCAL_GROUP (u_int32_t)0xe00000ff /* 224.0.0.255 */
363
364#ifdef __APPLE__
365#define IN_LINKLOCALNETNUM (u_int32_t)0xA9FE0000 /* 169.254.0.0 */
366#define IN_LINKLOCAL(i) (((u_int32_t)(i) & IN_CLASSB_NET) == IN_LINKLOCALNETNUM)
367#define IN_LOOPBACK(i) (((u_int32_t)(i) & 0xff000000) == 0x7f000000)
368#define IN_ZERONET(i) (((u_int32_t)(i) & 0xff000000) == 0)
369
370#define IN_PRIVATE(i) ((((u_int32_t)(i) & 0xff000000) == 0x0a000000) || \
371 (((u_int32_t)(i) & 0xfff00000) == 0xac100000) || \
372 (((u_int32_t)(i) & 0xffff0000) == 0xc0a80000))
373
374#define IN_LOCAL_GROUP(i) (((u_int32_t)(i) & 0xffffff00) == 0xe0000000)
375
376#define IN_ANY_LOCAL(i) (IN_LINKLOCAL(i) || IN_LOCAL_GROUP(i))
377#endif /* __APPLE__ */
378
379#define IN_LOOPBACKNET 127 /* official! */
380#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
381
382/*
383 * Socket address, internet style.
384 */
385struct sockaddr_in {
386 __uint8_t sin_len;
387 sa_family_t sin_family;
388 in_port_t sin_port;
389 struct in_addr sin_addr;
390 char sin_zero[8];
391};
392
393#define IN_ARE_ADDR_EQUAL(a, b) \
394 (bcmp(&(a)->s_addr, &(b)->s_addr, \
395 sizeof (struct in_addr)) == 0)
396
397#define INET_ADDRSTRLEN 16
398
399#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
400/*
401 * Structure used to describe IP options.
402 * Used to store options internally, to pass them to a process,
403 * or to restore options retrieved earlier.
404 * The ip_dst is used for the first-hop gateway when using a source route
405 * (this gets put into the header proper).
406 */
407struct ip_opts {
408 struct in_addr ip_dst; /* first hop, 0 w/o src rt */
409 char ip_opts[40]; /* actually variable in size */
410};
411
412/*
413 * Options for use with [gs]etsockopt at the IP level.
414 * First word of comment is data type; bool is stored in int.
415 */
416#define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
417#define IP_HDRINCL 2 /* int; header is included with data */
418#define IP_TOS 3 /* int; IP type of service and preced. */
419#define IP_TTL 4 /* int; IP time to live */
420#define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
421#define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
422#define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
423#define IP_RETOPTS 8 /* ip_opts; set/get IP options */
424#define IP_MULTICAST_IF 9 /* u_char; set/get IP multicast i/f */
425#define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
426#define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
427#define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
428#define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
429#define IP_MULTICAST_VIF 14 /* set/get IP mcast virt. iface */
430#define IP_RSVP_ON 15 /* enable RSVP in kernel */
431#define IP_RSVP_OFF 16 /* disable RSVP in kernel */
432#define IP_RSVP_VIF_ON 17 /* set RSVP per-vif socket */
433#define IP_RSVP_VIF_OFF 18 /* unset RSVP per-vif socket */
434#define IP_PORTRANGE 19 /* int; range to choose for unspec port */
435#define IP_RECVIF 20 /* bool; receive reception if w/dgram */
436/* for IPSEC */
437#define IP_IPSEC_POLICY 21 /* int; set/get security policy */
438#define IP_FAITH 22 /* deprecated */
439#ifdef __APPLE__
440#define IP_STRIPHDR 23 /* bool: drop receive of raw IP header */
441#endif
442#define IP_RECVTTL 24 /* bool; receive reception TTL w/dgram */
443#define IP_BOUND_IF 25 /* int; set/get bound interface */
444#define IP_PKTINFO 26 /* get pktinfo on recv socket, set src on sent dgram */
445#define IP_RECVPKTINFO IP_PKTINFO /* receive pktinfo w/dgram */
446#define IP_RECVTOS 27 /* bool; receive IP TOS w/dgram */
447#define IP_DONTFRAG 28 /* don't fragment packet */
448
449#define IP_FW_ADD 40 /* add a firewall rule to chain */
450#define IP_FW_DEL 41 /* delete a firewall rule from chain */
451#define IP_FW_FLUSH 42 /* flush firewall rule chain */
452#define IP_FW_ZERO 43 /* clear single/all firewall counter(s) */
453#define IP_FW_GET 44 /* get entire firewall rule chain */
454#define IP_FW_RESETLOG 45 /* reset logging counters */
455
456/* These older firewall socket option codes are maintained for backward compatibility. */
457#define IP_OLD_FW_ADD 50 /* add a firewall rule to chain */
458#define IP_OLD_FW_DEL 51 /* delete a firewall rule from chain */
459#define IP_OLD_FW_FLUSH 52 /* flush firewall rule chain */
460#define IP_OLD_FW_ZERO 53 /* clear single/all firewall counter(s) */
461#define IP_OLD_FW_GET 54 /* get entire firewall rule chain */
462#define IP_NAT__XXX 55 /* set/get NAT opts XXX Deprecated, do not use */
463#define IP_OLD_FW_RESETLOG 56 /* reset logging counters */
464
465#define IP_DUMMYNET_CONFIGURE 60 /* add/configure a dummynet pipe */
466#define IP_DUMMYNET_DEL 61 /* delete a dummynet pipe from chain */
467#define IP_DUMMYNET_FLUSH 62 /* flush dummynet */
468#define IP_DUMMYNET_GET 64 /* get entire dummynet pipes */
469
470#define IP_TRAFFIC_MGT_BACKGROUND 65 /* int*; get background IO flags; set background IO */
471#define IP_MULTICAST_IFINDEX 66 /* int*; set/get IP multicast i/f index */
472
473/* IPv4 Source Filter Multicast API [RFC3678] */
474#define IP_ADD_SOURCE_MEMBERSHIP 70 /* join a source-specific group */
475#define IP_DROP_SOURCE_MEMBERSHIP 71 /* drop a single source */
476#define IP_BLOCK_SOURCE 72 /* block a source */
477#define IP_UNBLOCK_SOURCE 73 /* unblock a source */
478
479/* The following option is private; do not use it from user applications. */
480#define IP_MSFILTER 74 /* set/get filter list */
481
482/* Protocol Independent Multicast API [RFC3678] */
483#define MCAST_JOIN_GROUP 80 /* join an any-source group */
484#define MCAST_LEAVE_GROUP 81 /* leave all sources for group */
485#define MCAST_JOIN_SOURCE_GROUP 82 /* join a source-specific group */
486#define MCAST_LEAVE_SOURCE_GROUP 83 /* leave a single source */
487#define MCAST_BLOCK_SOURCE 84 /* block a source */
488#define MCAST_UNBLOCK_SOURCE 85 /* unblock a source */
489
490#ifdef PRIVATE
491/* See in_private.h for additional options */
492#endif /* PRIVATE */
493
494/*
495 * Defaults and limits for options
496 */
497#define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
498#define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
499
500/*
501 * The imo_membership vector for each socket is now dynamically allocated at
502 * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
503 * according to a power-of-two increment.
504 */
505#define IP_MIN_MEMBERSHIPS 31
506#define IP_MAX_MEMBERSHIPS 4095
507
508/*
509 * Default resource limits for IPv4 multicast source filtering.
510 * These may be modified by sysctl.
511 */
512#define IP_MAX_GROUP_SRC_FILTER 512 /* sources per group */
513#define IP_MAX_SOCK_SRC_FILTER 128 /* sources per socket/group */
514#define IP_MAX_SOCK_MUTE_FILTER 128 /* XXX no longer used */
515
516#ifndef XNU_PLATFORM_DriverKit
517/*
518 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
519 */
520struct ip_mreq {
521 struct in_addr imr_multiaddr; /* IP multicast address of group */
522 struct in_addr imr_interface; /* local IP address of interface */
523};
524
525/*
526 * Modified argument structure for IP_MULTICAST_IF, obtained from Linux.
527 * This is used to specify an interface index for multicast sends, as
528 * the IPv4 legacy APIs do not support this (unless IP_SENDIF is available).
529 */
530struct ip_mreqn {
531 struct in_addr imr_multiaddr; /* IP multicast address of group */
532 struct in_addr imr_address; /* local IP address of interface */
533 int imr_ifindex; /* Interface index; cast to uint32_t */
534};
535
536#pragma pack(4)
537/*
538 * Argument structure for IPv4 Multicast Source Filter APIs. [RFC3678]
539 */
540struct ip_mreq_source {
541 struct in_addr imr_multiaddr; /* IP multicast address of group */
542 struct in_addr imr_sourceaddr; /* IP address of source */
543 struct in_addr imr_interface; /* local IP address of interface */
544};
545
546/*
547 * Argument structures for Protocol-Independent Multicast Source
548 * Filter APIs. [RFC3678]
549 */
550struct group_req {
551 uint32_t gr_interface; /* interface index */
552 struct sockaddr_storage gr_group; /* group address */
553};
554
555struct group_source_req {
556 uint32_t gsr_interface; /* interface index */
557 struct sockaddr_storage gsr_group; /* group address */
558 struct sockaddr_storage gsr_source; /* source address */
559};
560
561#ifndef __MSFILTERREQ_DEFINED
562#define __MSFILTERREQ_DEFINED
563/*
564 * The following structure is private; do not use it from user applications.
565 * It is used to communicate IP_MSFILTER/IPV6_MSFILTER information between
566 * the RFC 3678 libc functions and the kernel.
567 */
568struct __msfilterreq {
569 uint32_t msfr_ifindex; /* interface index */
570 uint32_t msfr_fmode; /* filter mode for group */
571 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
572 uint32_t __msfr_align;
573 struct sockaddr_storage msfr_group; /* group address */
574 struct sockaddr_storage *msfr_srcs;
575};
576
577#ifdef BSD_KERNEL_PRIVATE
578struct __msfilterreq32 {
579 uint32_t msfr_ifindex; /* interface index */
580 uint32_t msfr_fmode; /* filter mode for group */
581 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
582 uint32_t __msfr_align;
583 struct sockaddr_storage msfr_group; /* group address */
584 user32_addr_t msfr_srcs;
585};
586
587struct __msfilterreq64 {
588 uint32_t msfr_ifindex; /* interface index */
589 uint32_t msfr_fmode; /* filter mode for group */
590 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
591 uint32_t __msfr_align;
592 struct sockaddr_storage msfr_group; /* group address */
593 user64_addr_t msfr_srcs;
594};
595
596#endif /* BSD_KERNEL_PRIVATE */
597#endif /* __MSFILTERREQ_DEFINED */
598
599#pragma pack()
600struct sockaddr;
601
602#ifndef KERNEL
603/*
604 * Advanced (Full-state) APIs [RFC3678]
605 * The RFC specifies uint_t for the 6th argument to [sg]etsourcefilter().
606 * We use uint32_t here to be consistent.
607 */
608int setipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t,
609 uint32_t, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
610int getipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t *,
611 uint32_t *, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
612int setsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
613 uint32_t, uint32_t, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
614int getsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
615 uint32_t *, uint32_t *, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
616#endif
617#endif /* XNU_PLATFORM_DriverKit */
618
619/*
620 * Filter modes; also used to represent per-socket filter mode internally.
621 */
622#define MCAST_UNDEFINED 0 /* fmode: not yet defined */
623#define MCAST_INCLUDE 1 /* fmode: include these source(s) */
624#define MCAST_EXCLUDE 2 /* fmode: exclude these source(s) */
625
626/*
627 * Argument for IP_PORTRANGE:
628 * - which range to search when port is unspecified at bind() or connect()
629 */
630#define IP_PORTRANGE_DEFAULT 0 /* default range */
631#define IP_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
632#define IP_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
633
634
635/*
636 * IP_PKTINFO: Packet information (equivalent to RFC2292 sec 5 for IPv4)
637 * This structure is used for
638 *
639 * 1) Receiving ancilliary data about the datagram if IP_PKTINFO sockopt is
640 * set on the socket. In this case ipi_ifindex will contain the interface
641 * index the datagram was received on, ipi_addr is the IP address the
642 * datagram was received to.
643 *
644 * 2) Sending a datagram using a specific interface or IP source address.
645 * if ipi_ifindex is set to non-zero when in_pktinfo is passed as
646 * ancilliary data of type IP_PKTINFO, this will be used as the source
647 * interface to send the datagram from. If ipi_ifindex is null, ip_spec_dst
648 * will be used for the source address.
649 *
650 * Note: if IP_BOUND_IF is set on the socket, ipi_ifindex in the ancillary
651 * IP_PKTINFO option silently overrides the bound interface when it is
652 * specified during send time.
653 */
654struct in_pktinfo {
655 unsigned int ipi_ifindex; /* send/recv interface index */
656 struct in_addr ipi_spec_dst; /* Local address */
657 struct in_addr ipi_addr; /* IP Header dst address */
658};
659
660/*
661 * Definitions for inet sysctl operations.
662 *
663 * Third level is protocol number.
664 * Fourth level is desired variable within that protocol.
665 */
666#define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */
667
668/*
669 * Names for IP sysctl objects
670 */
671#define IPCTL_FORWARDING 1 /* act as router */
672#define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
673#define IPCTL_DEFTTL 3 /* default TTL */
674#ifdef notyet
675#define IPCTL_DEFMTU 4 /* default MTU */
676#endif
677#define IPCTL_RTEXPIRE 5 /* cloned route expiration time */
678#define IPCTL_RTMINEXPIRE 6 /* min value for expiration time */
679#define IPCTL_RTMAXCACHE 7 /* trigger level for dynamic expire */
680#define IPCTL_SOURCEROUTE 8 /* may perform source routes */
681#define IPCTL_DIRECTEDBROADCAST 9 /* may re-broadcast received packets */
682#define IPCTL_INTRQMAXLEN 10 /* max length of netisr queue */
683#define IPCTL_INTRQDROPS 11 /* number of netisr q drops */
684#define IPCTL_STATS 12 /* ipstat structure */
685#define IPCTL_ACCEPTSOURCEROUTE 13 /* may accept source routed packets */
686#define IPCTL_FASTFORWARDING 14 /* use fast IP forwarding code */
687#define IPCTL_KEEPFAITH 15 /* deprecated */
688#define IPCTL_GIF_TTL 16 /* default TTL for gif encap packet */
689#define IPCTL_MAXID 17
690
691#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
692
693/* INET6 stuff */
694#define __KAME_NETINET_IN_H_INCLUDED_
695#include <netinet6/in6.h>
696#undef __KAME_NETINET_IN_H_INCLUDED_
697
698#ifndef XNU_PLATFORM_DriverKit
699#ifdef KERNEL
700#define MAX_IPv4_STR_LEN 16
701#define MAX_IPv6_STR_LEN 64
702
703extern int inet_aton(const char *, struct in_addr *); /* in libkern */
704extern const char *inet_ntop(int, const void *, char *, socklen_t); /* in libkern*/
705#endif /* KERNEL */
706
707#ifndef KERNEL
708#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
709__BEGIN_DECLS
710int bindresvport(int, struct sockaddr_in *);
711struct sockaddr;
712int bindresvport_sa(int, struct sockaddr *);
713__END_DECLS
714#endif
715#endif /* !KERNEL */
716#endif /* XNU_PLATFORM_DriverKit */
717
718#ifdef PRIVATE
719#include <netinet/in_private.h>
720#endif /* PRIVATE */
721
722#endif /* _NETINET_IN_H_ */
723