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