xref: /freebsd/sys/netinet/in.h (revision 2ad872c5794e4c26fdf6ed219ad3f09ca0d5304a)
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.37 1998/08/23 03:07:14 wollman 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 (RFC 1700)
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_ST		7		/* Stream protocol II */
55 #define	IPPROTO_EGP		8		/* exterior gateway protocol */
56 #define	IPPROTO_PIGP		9		/* private interior gateway */
57 #define	IPPROTO_RCCMON		10		/* BBN RCC Monitoring */
58 #define	IPPROTO_NVPII		11		/* network voice protocol*/
59 #define	IPPROTO_PUP		12		/* pup */
60 #define	IPPROTO_ARGUS		13		/* Argus */
61 #define	IPPROTO_EMCON		14		/* EMCON */
62 #define	IPPROTO_XNET		15		/* Cross Net Debugger */
63 #define	IPPROTO_CHAOS		16		/* Chaos*/
64 #define	IPPROTO_UDP		17		/* user datagram protocol */
65 #define	IPPROTO_MUX		18		/* Multiplexing */
66 #define	IPPROTO_MEAS		19		/* DCN Measurement Subsystems */
67 #define	IPPROTO_HMP		20		/* Host Monitoring */
68 #define	IPPROTO_PRM		21		/* Packet Radio Measurement */
69 #define	IPPROTO_IDP		22		/* xns idp */
70 #define	IPPROTO_TRUNK1		23		/* Trunk-1 */
71 #define	IPPROTO_TRUNK2		24		/* Trunk-2 */
72 #define	IPPROTO_LEAF1		25		/* Leaf-1 */
73 #define	IPPROTO_LEAF2		26		/* Leaf-2 */
74 #define	IPPROTO_RDP		27		/* Reliable Data */
75 #define	IPPROTO_IRTP		28		/* Reliable Transaction */
76 #define	IPPROTO_TP		29 		/* tp-4 w/ class negotiation */
77 #define	IPPROTO_BLT		30		/* Bulk Data Transfer */
78 #define	IPPROTO_NSP		31		/* Network Services */
79 #define	IPPROTO_INP		32		/* Merit Internodal */
80 #define	IPPROTO_SEP		33		/* Sequential Exchange */
81 #define	IPPROTO_3PC		34		/* Third Party Connect */
82 #define	IPPROTO_IDPR		35		/* InterDomain Policy Routing */
83 #define	IPPROTO_XTP		36		/* XTP */
84 #define	IPPROTO_DDP		37		/* Datagram Delivery */
85 #define	IPPROTO_CMTP		38		/* Control Message Transport */
86 #define	IPPROTO_TPXX		39		/* TP++ Transport */
87 #define	IPPROTO_IL		40		/* IL transport protocol */
88 #define	IPPROTO_SIP		41		/* Simple Internet Protocol */
89 #define	IPPROTO_SDRP		42		/* Source Demand Routing */
90 #define	IPPROTO_SIPSR		43		/* SIP Source Route */
91 #define	IPPROTO_SIPFRAG		44		/* SIP Fragment */
92 #define	IPPROTO_IDRP		45		/* InterDomain Routing*/
93 #define IPPROTO_RSVP		46 		/* resource reservation */
94 #define	IPPROTO_GRE		47		/* General Routing Encap. */
95 #define	IPPROTO_MHRP		48		/* Mobile Host Routing */
96 #define	IPPROTO_BHA		49		/* BHA */
97 #define	IPPROTO_ESP		50		/* SIPP Encap Sec. Payload */
98 #define	IPPROTO_AH		51		/* SIPP Auth Header */
99 #define	IPPROTO_INLSP		52		/* Integ. Net Layer Security */
100 #define	IPPROTO_SWIPE		53		/* IP with encryption */
101 #define	IPPROTO_NHRP		54		/* Next Hop Resolution */
102 /* 55-60: Unassigned */
103 #define	IPPROTO_AHIP		61		/* any host internal protocol */
104 #define	IPPROTO_CFTP		62		/* CFTP */
105 #define	IPPROTO_HELLO		63		/* "hello" routing protocol */
106 #define	IPPROTO_SATEXPAK	64		/* SATNET/Backroom EXPAK */
107 #define	IPPROTO_KRYPTOLAN	65		/* Kryptolan */
108 #define	IPPROTO_RVD		66		/* Remote Virtual Disk */
109 #define	IPPROTO_IPPC		67		/* Pluribus Packet Core */
110 #define	IPPROTO_ADFS		68		/* Any distributed FS */
111 #define	IPPROTO_SATMON		69		/* Satnet Monitoring */
112 #define	IPPROTO_VISA		70		/* VISA Protocol */
113 #define	IPPROTO_IPCV		71		/* Packet Core Utility */
114 #define	IPPROTO_CPNX		72		/* Comp. Prot. Net. Executive */
115 #define	IPPROTO_CPHB		73		/* Comp. Prot. HeartBeat */
116 #define	IPPROTO_WSN		74		/* Wang Span Network */
117 #define	IPPROTO_PVP		75		/* Packet Video Protocol */
118 #define	IPPROTO_BRSATMON	76		/* BackRoom SATNET Monitoring */
119 #define	IPPROTO_ND		77		/* Sun net disk proto (temp.) */
120 #define	IPPROTO_WBMON		78		/* WIDEBAND Monitoring */
121 #define	IPPROTO_WBEXPAK		79		/* WIDEBAND EXPAK */
122 #define	IPPROTO_EON		80		/* ISO cnlp */
123 #define	IPPROTO_VMTP		81		/* VMTP */
124 #define	IPPROTO_SVMTP		82		/* Secure VMTP */
125 #define	IPPROTO_VINES		83		/* Banyon VINES */
126 #define	IPPROTO_TTP		84		/* TTP */
127 #define	IPPROTO_IGP		85		/* NSFNET-IGP */
128 #define	IPPROTO_DGP		86		/* dissimilar gateway prot. */
129 #define	IPPROTO_TCF		87		/* TCF */
130 #define	IPPROTO_IGRP		88		/* Cisco/GXS IGRP */
131 #define	IPPROTO_OSPFIGP		89		/* OSPFIGP */
132 #define	IPPROTO_SRPC		90		/* Strite RPC protocol */
133 #define	IPPROTO_LARP		91		/* Locus Address Resoloution */
134 #define	IPPROTO_MTP		92		/* Multicast Transport */
135 #define	IPPROTO_AX25		93		/* AX.25 Frames */
136 #define	IPPROTO_IPEIP		94		/* IP encapsulated in IP */
137 #define	IPPROTO_MICP		95		/* Mobile Int.ing control */
138 #define	IPPROTO_SCCSP		96		/* Semaphore Comm. security */
139 #define	IPPROTO_ETHERIP		97		/* Ethernet IP encapsulation */
140 #define	IPPROTO_ENCAP		98		/* encapsulation header */
141 #define	IPPROTO_APES		99		/* any private encr. scheme */
142 #define	IPPROTO_GMTP		100		/* GMTP*/
143 /* 101-254: Unassigned */
144 /* 255: Reserved */
145 /* BSD Private, local use, namespace incursion */
146 #define	IPPROTO_DIVERT		254		/* divert pseudo-protocol */
147 #define	IPPROTO_RAW		255		/* raw IP packet */
148 #define	IPPROTO_MAX		256
149 
150 
151 /*
152  * Local port number conventions:
153  *
154  * When a user does a bind(2) or connect(2) with a port number of zero,
155  * a non-conflicting local port address is chosen.
156  * The default range is IPPORT_RESERVED through
157  * IPPORT_USERRESERVED, although that is settable by sysctl.
158  *
159  * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
160  * default assignment range.
161  *
162  * The value IP_PORTRANGE_DEFAULT causes the default behavior.
163  *
164  * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
165  * into the "high" range.  These are reserved for client outbound connections
166  * which do not want to be filtered by any firewalls.
167  *
168  * The value IP_PORTRANGE_LOW changes the range to the "low" are
169  * that is (by convention) restricted to privileged processes.  This
170  * convention is based on "vouchsafe" principles only.  It is only secure
171  * if you trust the remote host to restrict these ports.
172  *
173  * The default range of ports and the high range can be changed by
174  * sysctl(3).  (net.inet.ip.port{hi,low}{first,last}_auto)
175  *
176  * Changing those values has bad security implications if you are
177  * using a a stateless firewall that is allowing packets outside of that
178  * range in order to allow transparent outgoing connections.
179  *
180  * Such a firewall configuration will generally depend on the use of these
181  * default values.  If you change them, you may find your Security
182  * Administrator looking for you with a heavy object.
183  *
184  * For a slightly more orthodox text view on this:
185  *
186  *            ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
187  *
188  *    port numbers are divided into three ranges:
189  *
190  *                0 -  1023 Well Known Ports
191  *             1024 - 49151 Registered Ports
192  *            49152 - 65535 Dynamic and/or Private Ports
193  *
194  */
195 
196 /*
197  * Ports < IPPORT_RESERVED are reserved for
198  * privileged processes (e.g. root).         (IP_PORTRANGE_LOW)
199  * Ports > IPPORT_USERRESERVED are reserved
200  * for servers, not necessarily privileged.  (IP_PORTRANGE_DEFAULT)
201  */
202 #define	IPPORT_RESERVED		1024
203 #define	IPPORT_USERRESERVED	5000
204 
205 /*
206  * Default local port range to use by setting IP_PORTRANGE_HIGH
207  */
208 #define	IPPORT_HIFIRSTAUTO	49152
209 #define	IPPORT_HILASTAUTO	65535
210 
211 /*
212  * Scanning for a free reserved port return a value below IPPORT_RESERVED,
213  * but higher than IPPORT_RESERVEDSTART.  Traditionally the start value was
214  * 512, but that conflicts with some well-known-services that firewalls may
215  * have a fit if we use.
216  */
217 #define IPPORT_RESERVEDSTART	600
218 
219 /*
220  * Internet address (a structure for historical reasons)
221  */
222 struct in_addr {
223 	u_int32_t s_addr;
224 };
225 
226 /*
227  * Definitions of bits in internet address integers.
228  * On subnets, the decomposition of addresses to host and net parts
229  * is done according to subnet mask, not the masks here.
230  */
231 #define	IN_CLASSA(i)		(((u_int32_t)(i) & 0x80000000) == 0)
232 #define	IN_CLASSA_NET		0xff000000
233 #define	IN_CLASSA_NSHIFT	24
234 #define	IN_CLASSA_HOST		0x00ffffff
235 #define	IN_CLASSA_MAX		128
236 
237 #define	IN_CLASSB(i)		(((u_int32_t)(i) & 0xc0000000) == 0x80000000)
238 #define	IN_CLASSB_NET		0xffff0000
239 #define	IN_CLASSB_NSHIFT	16
240 #define	IN_CLASSB_HOST		0x0000ffff
241 #define	IN_CLASSB_MAX		65536
242 
243 #define	IN_CLASSC(i)		(((u_int32_t)(i) & 0xe0000000) == 0xc0000000)
244 #define	IN_CLASSC_NET		0xffffff00
245 #define	IN_CLASSC_NSHIFT	8
246 #define	IN_CLASSC_HOST		0x000000ff
247 
248 #define	IN_CLASSD(i)		(((u_int32_t)(i) & 0xf0000000) == 0xe0000000)
249 #define	IN_CLASSD_NET		0xf0000000	/* These ones aren't really */
250 #define	IN_CLASSD_NSHIFT	28		/* net and host fields, but */
251 #define	IN_CLASSD_HOST		0x0fffffff	/* routing needn't know.    */
252 #define	IN_MULTICAST(i)		IN_CLASSD(i)
253 
254 #define	IN_EXPERIMENTAL(i)	(((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
255 #define	IN_BADCLASS(i)		(((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
256 
257 #define	INADDR_ANY		(u_int32_t)0x00000000
258 #define	INADDR_LOOPBACK		(u_int32_t)0x7f000001
259 #define	INADDR_BROADCAST	(u_int32_t)0xffffffff	/* must be masked */
260 #ifndef KERNEL
261 #define	INADDR_NONE		0xffffffff		/* -1 return */
262 #endif
263 
264 #define	INADDR_UNSPEC_GROUP	(u_int32_t)0xe0000000	/* 224.0.0.0 */
265 #define	INADDR_ALLHOSTS_GROUP	(u_int32_t)0xe0000001	/* 224.0.0.1 */
266 #define	INADDR_ALLRTRS_GROUP	(u_int32_t)0xe0000002	/* 224.0.0.2 */
267 #define	INADDR_MAX_LOCAL_GROUP	(u_int32_t)0xe00000ff	/* 224.0.0.255 */
268 
269 #define	IN_LOOPBACKNET		127			/* official! */
270 
271 /*
272  * Socket address, internet style.
273  */
274 struct sockaddr_in {
275 	u_char	sin_len;
276 	u_char	sin_family;
277 	u_short	sin_port;
278 	struct	in_addr sin_addr;
279 	char	sin_zero[8];
280 };
281 
282 /*
283  * Structure used to describe IP options.
284  * Used to store options internally, to pass them to a process,
285  * or to restore options retrieved earlier.
286  * The ip_dst is used for the first-hop gateway when using a source route
287  * (this gets put into the header proper).
288  */
289 struct ip_opts {
290 	struct	in_addr ip_dst;		/* first hop, 0 w/o src rt */
291 	char	ip_opts[40];		/* actually variable in size */
292 };
293 
294 /*
295  * Options for use with [gs]etsockopt at the IP level.
296  * First word of comment is data type; bool is stored in int.
297  */
298 #define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
299 #define	IP_HDRINCL		2    /* int; header is included with data */
300 #define	IP_TOS			3    /* int; IP type of service and preced. */
301 #define	IP_TTL			4    /* int; IP time to live */
302 #define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
303 #define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
304 #define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
305 #define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
306 #define	IP_MULTICAST_IF		9    /* u_char; set/get IP multicast i/f  */
307 #define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
308 #define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
309 #define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
310 #define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
311 #define IP_MULTICAST_VIF	14   /* set/get IP mcast virt. iface */
312 #define IP_RSVP_ON		15   /* enable RSVP in kernel */
313 #define IP_RSVP_OFF		16   /* disable RSVP in kernel */
314 #define IP_RSVP_VIF_ON		17   /* set RSVP per-vif socket */
315 #define IP_RSVP_VIF_OFF		18   /* unset RSVP per-vif socket */
316 #define IP_PORTRANGE		19   /* int; range to choose for unspec port */
317 #define	IP_RECVIF		20   /* bool; receive reception if w/dgram */
318 
319 #define IP_FW_ADD     		50   /* add a firewall rule to chain */
320 #define IP_FW_DEL    		51   /* delete a firewall rule from chain */
321 #define IP_FW_FLUSH   		52   /* flush firewall rule chain */
322 #define IP_FW_ZERO    		53   /* clear single/all firewall counter(s) */
323 #define IP_FW_GET     		54   /* get entire firewall rule chain */
324 #define IP_NAT			55   /* set/get NAT opts */
325 
326 #define	IP_DUMMYNET_CONFIGURE	60   /* add/configure a dummynet pipe */
327 #define	IP_DUMMYNET_DEL		61   /* delete a dummynet pipe from chain */
328 #define	IP_DUMMYNET_FLUSH	62   /* flush dummynet */
329 #define	IP_DUMMYNET_GET		64   /* get entire dummynet pipes */
330 
331 /*
332  * Defaults and limits for options
333  */
334 #define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
335 #define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
336 #define	IP_MAX_MEMBERSHIPS	20	/* per socket */
337 
338 /*
339  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
340  */
341 struct ip_mreq {
342 	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
343 	struct	in_addr imr_interface;	/* local IP address of interface */
344 };
345 
346 /*
347  * Argument for IP_PORTRANGE:
348  * - which range to search when port is unspecified at bind() or connect()
349  */
350 #define	IP_PORTRANGE_DEFAULT	0	/* default range */
351 #define	IP_PORTRANGE_HIGH	1	/* "high" - request firewall bypass */
352 #define	IP_PORTRANGE_LOW	2	/* "low" - vouchsafe security */
353 
354 /*
355  * Definitions for inet sysctl operations.
356  *
357  * Third level is protocol number.
358  * Fourth level is desired variable within that protocol.
359  */
360 #define	IPPROTO_MAXID	(IPPROTO_IDP + 1)	/* don't list to IPPROTO_MAX */
361 
362 #define	CTL_IPPROTO_NAMES { \
363 	{ "ip", CTLTYPE_NODE }, \
364 	{ "icmp", CTLTYPE_NODE }, \
365 	{ "igmp", CTLTYPE_NODE }, \
366 	{ "ggp", CTLTYPE_NODE }, \
367 	{ 0, 0 }, \
368 	{ 0, 0 }, \
369 	{ "tcp", CTLTYPE_NODE }, \
370 	{ 0, 0 }, \
371 	{ "egp", CTLTYPE_NODE }, \
372 	{ 0, 0 }, \
373 	{ 0, 0 }, \
374 	{ 0, 0 }, \
375 	{ "pup", CTLTYPE_NODE }, \
376 	{ 0, 0 }, \
377 	{ 0, 0 }, \
378 	{ 0, 0 }, \
379 	{ 0, 0 }, \
380 	{ "udp", CTLTYPE_NODE }, \
381 	{ 0, 0 }, \
382 	{ 0, 0 }, \
383 	{ 0, 0 }, \
384 	{ 0, 0 }, \
385 	{ "idp", CTLTYPE_NODE }, \
386 }
387 
388 /*
389  * Names for IP sysctl objects
390  */
391 #define	IPCTL_FORWARDING	1	/* act as router */
392 #define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
393 #define	IPCTL_DEFTTL		3	/* default TTL */
394 #ifdef notyet
395 #define	IPCTL_DEFMTU		4	/* default MTU */
396 #endif
397 #define IPCTL_RTEXPIRE		5	/* cloned route expiration time */
398 #define IPCTL_RTMINEXPIRE	6	/* min value for expiration time */
399 #define IPCTL_RTMAXCACHE	7	/* trigger level for dynamic expire */
400 #define	IPCTL_SOURCEROUTE	8	/* may perform source routes */
401 #define	IPCTL_DIRECTEDBROADCAST	9	/* may re-broadcast received packets */
402 #define IPCTL_INTRQMAXLEN	10	/* max length of netisr queue */
403 #define IPCTL_INTRQDROPS	11	/* number of netisr q drops */
404 #define	IPCTL_STATS		12	/* ipstat structure */
405 #define	IPCTL_ACCEPTSOURCEROUTE	13	/* may accept source routed packets */
406 #define IPCTL_FASTFORWARDING	14	/* use fast IP forwarding code */
407 #define	IPCTL_MAXID		15
408 
409 #define	IPCTL_NAMES { \
410 	{ 0, 0 }, \
411 	{ "forwarding", CTLTYPE_INT }, \
412 	{ "redirect", CTLTYPE_INT }, \
413 	{ "ttl", CTLTYPE_INT }, \
414 	{ "mtu", CTLTYPE_INT }, \
415 	{ "rtexpire", CTLTYPE_INT }, \
416 	{ "rtminexpire", CTLTYPE_INT }, \
417 	{ "rtmaxcache", CTLTYPE_INT }, \
418 	{ "sourceroute", CTLTYPE_INT }, \
419  	{ "directed-broadcast", CTLTYPE_INT }, \
420 	{ "intr-queue-maxlen", CTLTYPE_INT }, \
421 	{ "intr-queue-drops", CTLTYPE_INT }, \
422 	{ "stats", CTLTYPE_STRUCT }, \
423 	{ "accept_sourceroute", CTLTYPE_INT }, \
424 	{ "fastforwarding", CTLTYPE_INT }, \
425 }
426 
427 
428 #ifdef KERNEL
429 struct ifnet; struct mbuf;	/* forward declarations for Standard C */
430 
431 int	 in_broadcast __P((struct in_addr, struct ifnet *));
432 int	 in_canforward __P((struct in_addr));
433 int	 in_cksum __P((struct mbuf *, int));
434 int	 in_localaddr __P((struct in_addr));
435 char 	*inet_ntoa __P((struct in_addr)); /* in libkern */
436 
437 #endif /* KERNEL */
438 
439 #endif
440