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