in.h revision 15026
1/*
2 * Copyright (c) 1982, 1986, 1990, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)in.h	8.3 (Berkeley) 1/3/94
34 * $Id: in.h,v 1.16 1996/03/14 16:59:18 fenner Exp $
35 */
36
37#ifndef _NETINET_IN_H_
38#define _NETINET_IN_H_
39
40/*
41 * Constants and structures defined by the internet system,
42 * Per RFC 790, September 1981, and numerous additions.
43 */
44
45/*
46 * Protocols
47 */
48#define	IPPROTO_IP		0		/* dummy for IP */
49#define	IPPROTO_ICMP		1		/* control message protocol */
50#define	IPPROTO_IGMP		2		/* group mgmt protocol */
51#define	IPPROTO_GGP		3		/* gateway^2 (deprecated) */
52#define IPPROTO_IPIP		4 		/* IP encapsulation in IP */
53#define	IPPROTO_TCP		6		/* tcp */
54#define	IPPROTO_EGP		8		/* exterior gateway protocol */
55#define	IPPROTO_PUP		12		/* pup */
56#define	IPPROTO_UDP		17		/* user datagram protocol */
57#define	IPPROTO_IDP		22		/* xns idp */
58#define	IPPROTO_TP		29 		/* tp-4 w/ class negotiation */
59#define IPPROTO_RSVP		46 		/* resource reservation */
60#define	IPPROTO_EON		80		/* ISO cnlp */
61#define	IPPROTO_ENCAP		98		/* encapsulation header */
62
63#define	IPPROTO_RAW		255		/* raw IP packet */
64#define	IPPROTO_MAX		256
65
66
67/*
68 * Local port number conventions:
69 *
70 * When a user does a bind(2) or connect(2) with a port number of zero,
71 * a non-conflicting local port address is chosen.
72 * The default range is IPPORT_RESERVED through
73 * IPPORT_USERRESERVED, although that is settable by sysctl.
74 *
75 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
76 * default assignment range.
77 *
78 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
79 *
80 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
81 * into the "high" range.  These are reserved for client outbound connections
82 * which do not want to be filtered by any firewalls.
83 *
84 * The value IP_PORTRANGE_LOW changes the range to the "low" are
85 * that is (by convention) restricted to privileged processes.  This
86 * convention is based on "vouchsafe" principles only.  It is only secure
87 * if you trust the remote host to restrict these ports.
88 *
89 * The default range of ports and the high range can be changed by
90 * sysctl(3).  (net.inet.ip.port{hi}{first,last}_auto)
91 *
92 * Changing those values has bad security implications if you are
93 * using a a stateless firewall that is allowing packets outside of that
94 * range in order to allow transparent outgoing connections.
95 *
96 * Such a firewall configuration will generally depend on the use of these
97 * default values.  If you change them, you may find your Security
98 * Administrator looking for you with a heavy object.
99 */
100
101/*
102 * Ports < IPPORT_RESERVED are reserved for
103 * privileged processes (e.g. root).         (IP_PORTRANGE_LOW)
104 * Ports > IPPORT_USERRESERVED are reserved
105 * for servers, not necessarily privileged.  (IP_PORTRANGE_DEFAULT)
106 */
107#define	IPPORT_RESERVED		1024
108#define	IPPORT_USERRESERVED	5000
109
110/*
111 * Default local port range to use by setting IP_PORTRANGE_HIGH
112 */
113#define	IPPORT_HIFIRSTAUTO	40000
114#define	IPPORT_HILASTAUTO	44999
115
116/*
117 * Internet address (a structure for historical reasons)
118 */
119struct in_addr {
120	u_long s_addr;
121};
122
123/*
124 * Definitions of bits in internet address integers.
125 * On subnets, the decomposition of addresses to host and net parts
126 * is done according to subnet mask, not the masks here.
127 */
128#define	IN_CLASSA(i)		(((long)(i) & 0x80000000) == 0)
129#define	IN_CLASSA_NET		0xff000000
130#define	IN_CLASSA_NSHIFT	24
131#define	IN_CLASSA_HOST		0x00ffffff
132#define	IN_CLASSA_MAX		128
133
134#define	IN_CLASSB(i)		(((long)(i) & 0xc0000000) == 0x80000000)
135#define	IN_CLASSB_NET		0xffff0000
136#define	IN_CLASSB_NSHIFT	16
137#define	IN_CLASSB_HOST		0x0000ffff
138#define	IN_CLASSB_MAX		65536
139
140#define	IN_CLASSC(i)		(((long)(i) & 0xe0000000) == 0xc0000000)
141#define	IN_CLASSC_NET		0xffffff00
142#define	IN_CLASSC_NSHIFT	8
143#define	IN_CLASSC_HOST		0x000000ff
144
145#define	IN_CLASSD(i)		(((long)(i) & 0xf0000000) == 0xe0000000)
146#define	IN_CLASSD_NET		0xf0000000	/* These ones aren't really */
147#define	IN_CLASSD_NSHIFT	28		/* net and host fields, but */
148#define	IN_CLASSD_HOST		0x0fffffff	/* routing needn't know.    */
149#define	IN_MULTICAST(i)		IN_CLASSD(i)
150
151#define	IN_EXPERIMENTAL(i)	(((long)(i) & 0xf0000000) == 0xf0000000)
152#define	IN_BADCLASS(i)		(((long)(i) & 0xf0000000) == 0xf0000000)
153
154#define	INADDR_ANY		(u_long)0x00000000
155#define	INADDR_BROADCAST	(u_long)0xffffffff	/* must be masked */
156#ifndef KERNEL
157#define	INADDR_NONE		0xffffffff		/* -1 return */
158#endif
159
160#define	INADDR_UNSPEC_GROUP	(u_long)0xe0000000	/* 224.0.0.0 */
161#define	INADDR_ALLHOSTS_GROUP	(u_long)0xe0000001	/* 224.0.0.1 */
162#define	INADDR_ALLRTRS_GROUP	(u_long)0xe0000002	/* 224.0.0.2 */
163#define	INADDR_MAX_LOCAL_GROUP	(u_long)0xe00000ff	/* 224.0.0.255 */
164
165#define	IN_LOOPBACKNET		127			/* official! */
166
167/*
168 * Socket address, internet style.
169 */
170struct sockaddr_in {
171	u_char	sin_len;
172	u_char	sin_family;
173	u_short	sin_port;
174	struct	in_addr sin_addr;
175	char	sin_zero[8];
176};
177
178/*
179 * Structure used to describe IP options.
180 * Used to store options internally, to pass them to a process,
181 * or to restore options retrieved earlier.
182 * The ip_dst is used for the first-hop gateway when using a source route
183 * (this gets put into the header proper).
184 */
185struct ip_opts {
186	struct	in_addr ip_dst;		/* first hop, 0 w/o src rt */
187	char	ip_opts[40];		/* actually variable in size */
188};
189
190/*
191 * Options for use with [gs]etsockopt at the IP level.
192 * First word of comment is data type; bool is stored in int.
193 */
194#define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
195#define	IP_HDRINCL		2    /* int; header is included with data */
196#define	IP_TOS			3    /* int; IP type of service and preced. */
197#define	IP_TTL			4    /* int; IP time to live */
198#define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
199#define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
200#define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
201#define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
202#define	IP_MULTICAST_IF		9    /* u_char; set/get IP multicast i/f  */
203#define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
204#define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
205#define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
206#define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
207#define IP_MULTICAST_VIF	14   /* set/get IP mcast virt. iface */
208#define IP_RSVP_ON		15   /* enable RSVP in kernel */
209#define IP_RSVP_OFF		16   /* disable RSVP in kernel */
210#define IP_RSVP_VIF_ON		17   /* set RSVP per-vif socket */
211#define IP_RSVP_VIF_OFF		18   /* unset RSVP per-vif socket */
212#define IP_PORTRANGE		19   /* int; range to choose for unspec port */
213
214/*
215 * Defaults and limits for options
216 */
217#define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
218#define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
219#define	IP_MAX_MEMBERSHIPS	20	/* per socket */
220
221/*
222 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
223 */
224struct ip_mreq {
225	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
226	struct	in_addr imr_interface;	/* local IP address of interface */
227};
228
229/*
230 * Argument for IP_PORTRANGE:
231 * - which range to search when port is unspecified at bind() or connect()
232 */
233#define	IP_PORTRANGE_DEFAULT	0	/* default range */
234#define	IP_PORTRANGE_HIGH	1	/* "high" - request firewall bypass */
235#define	IP_PORTRANGE_LOW	2	/* "low" - vouchsafe security */
236
237/*
238 * Definitions for inet sysctl operations.
239 *
240 * Third level is protocol number.
241 * Fourth level is desired variable within that protocol.
242 */
243#define	IPPROTO_MAXID	(IPPROTO_IDP + 1)	/* don't list to IPPROTO_MAX */
244
245#define	CTL_IPPROTO_NAMES { \
246	{ "ip", CTLTYPE_NODE }, \
247	{ "icmp", CTLTYPE_NODE }, \
248	{ "igmp", CTLTYPE_NODE }, \
249	{ "ggp", CTLTYPE_NODE }, \
250	{ 0, 0 }, \
251	{ 0, 0 }, \
252	{ "tcp", CTLTYPE_NODE }, \
253	{ 0, 0 }, \
254	{ "egp", CTLTYPE_NODE }, \
255	{ 0, 0 }, \
256	{ 0, 0 }, \
257	{ 0, 0 }, \
258	{ "pup", CTLTYPE_NODE }, \
259	{ 0, 0 }, \
260	{ 0, 0 }, \
261	{ 0, 0 }, \
262	{ 0, 0 }, \
263	{ "udp", CTLTYPE_NODE }, \
264	{ 0, 0 }, \
265	{ 0, 0 }, \
266	{ 0, 0 }, \
267	{ 0, 0 }, \
268	{ "idp", CTLTYPE_NODE }, \
269}
270
271/*
272 * Names for IP sysctl objects
273 */
274#define	IPCTL_FORWARDING	1	/* act as router */
275#define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
276#define	IPCTL_DEFTTL		3	/* default TTL */
277#ifdef notyet
278#define	IPCTL_DEFMTU		4	/* default MTU */
279#endif
280#define IPCTL_RTEXPIRE		5	/* cloned route expiration time */
281#define IPCTL_RTMINEXPIRE	6	/* min value for expiration time */
282#define IPCTL_RTMAXCACHE	7	/* trigger level for dynamic expire */
283#define	IPCTL_SOURCEROUTE	8	/* may perform source routes */
284#define	IPCTL_DIRECTEDBROADCAST	9	/* may re-broadcast received packets */
285#define IPCTL_INTRQMAXLEN	10	/* max length of netisr queue */
286#define IPCTL_INTRQDROPS	11	/* number of netisr q drops */
287#define	IPCTL_MAXID		12
288
289#define	IPCTL_NAMES { \
290	{ 0, 0 }, \
291	{ "forwarding", CTLTYPE_INT }, \
292	{ "redirect", CTLTYPE_INT }, \
293	{ "ttl", CTLTYPE_INT }, \
294	{ "mtu", CTLTYPE_INT }, \
295	{ "rtexpire", CTLTYPE_INT }, \
296	{ "rtminexpire", CTLTYPE_INT }, \
297	{ "rtmaxcache", CTLTYPE_INT }, \
298	{ "sourceroute", CTLTYPE_INT }, \
299 	{ "directed-broadcast", CTLTYPE_INT }, \
300	{ "intr-queue-maxlen", CTLTYPE_INT }, \
301	{ "intr-queue-drops", CTLTYPE_INT }, \
302}
303
304
305#ifdef KERNEL
306struct ifnet; struct mbuf;	/* forward declarations for Standard C */
307
308int	 in_broadcast __P((struct in_addr, struct ifnet *));
309int	 in_canforward __P((struct in_addr));
310int	 in_cksum __P((struct mbuf *, int));
311int	 in_localaddr __P((struct in_addr));
312char 	*inet_ntoa __P((struct in_addr)); /* in libkern */
313
314/* Firewall hooks */
315struct ip;
316typedef  int ip_fw_chk_t __P((struct ip**, int, struct ifnet*, int, struct mbuf**));
317typedef  int ip_fw_ctl_t __P((int, struct mbuf**));
318extern ip_fw_chk_t *ip_fw_chk_ptr;
319extern ip_fw_ctl_t *ip_fw_ctl_ptr;
320#endif /* KERNEL */
321
322#endif
323