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