xref: /netbsd-src/sys/netinet/in.h (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1 /*	$NetBSD: in.h,v 1.48 2000/06/26 15:48:19 kleink Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)in.h	8.3 (Berkeley) 1/3/94
36  */
37 
38 /*
39  * Constants and structures defined by the internet system,
40  * Per RFC 790, September 1981, and numerous additions.
41  */
42 
43 #ifndef _NETINET_IN_H_
44 #define	_NETINET_IN_H_
45 
46 #include <sys/ansi.h>
47 
48 #ifndef sa_family_t
49 typedef __sa_family_t	sa_family_t;
50 #define sa_family_t	sa_family_t
51 #endif
52 
53 /*
54  * Protocols
55  */
56 #define	IPPROTO_IP		0		/* dummy for IP */
57 #define IPPROTO_HOPOPTS		0		/* IP6 hop-by-hop options */
58 #define	IPPROTO_ICMP		1		/* control message protocol */
59 #define	IPPROTO_IGMP		2		/* group mgmt protocol */
60 #define	IPPROTO_GGP		3		/* gateway^2 (deprecated) */
61 #define IPPROTO_IPV4		4 		/* IP header */
62 #define	IPPROTO_IPIP		4		/* IP inside IP */
63 #define	IPPROTO_TCP		6		/* tcp */
64 #define	IPPROTO_EGP		8		/* exterior gateway protocol */
65 #define	IPPROTO_PUP		12		/* pup */
66 #define	IPPROTO_UDP		17		/* user datagram protocol */
67 #define	IPPROTO_IDP		22		/* xns idp */
68 #define	IPPROTO_TP		29 		/* tp-4 w/ class negotiation */
69 #define IPPROTO_IPV6		41		/* IP6 header */
70 #define IPPROTO_ROUTING		43		/* IP6 routing header */
71 #define IPPROTO_FRAGMENT	44		/* IP6 fragmentation header */
72 #define IPPROTO_RSVP		46		/* resource reservation */
73 #define IPPROTO_GRE		47		/* GRE encaps RFC 1701 */
74 #define	IPPROTO_ESP		50 		/* encap. security payload */
75 #define	IPPROTO_AH		51 		/* authentication header */
76 #define IPPROTO_MOBILE		55		/* IP Mobility RFC 2004 */
77 #define IPPROTO_IPV6_ICMP	58		/* IPv6 ICMP */
78 #define IPPROTO_ICMPV6		58		/* ICMP6 */
79 #define IPPROTO_NONE		59		/* IP6 no next header */
80 #define IPPROTO_DSTOPTS		60		/* IP6 destination option */
81 #define	IPPROTO_EON		80		/* ISO cnlp */
82 #define	IPPROTO_ENCAP		98		/* encapsulation header */
83 #define IPPROTO_PIM		103		/* Protocol indep. multicast */
84 #define IPPROTO_IPCOMP		108		/* IP Payload Comp. Protocol */
85 
86 #define	IPPROTO_RAW		255		/* raw IP packet */
87 #define	IPPROTO_MAX		256
88 
89 /* last return value of *_input(), meaning "all job for this pkt is done".  */
90 #define	IPPROTO_DONE		257
91 
92 
93 /*
94  * Local port number conventions:
95  *
96  * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
97  * unless a kernel is compiled with IPNOPRIVPORTS defined.
98  *
99  * When a user does a bind(2) or connect(2) with a port number of zero,
100  * a non-conflicting local port address is chosen.
101  *
102  * The default range is IPPORT_ANONMIX to IPPORT_ANONMAX, although
103  * that is settable by sysctl(3); net.inet.ip.anonportmin and
104  * net.inet.ip.anonportmax respectively.
105  *
106  * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
107  * default assignment range.
108  *
109  * The value IP_PORTRANGE_DEFAULT causes the default behavior.
110  *
111  * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
112  * and exists only for FreeBSD compatibility purposes.
113  *
114  * The value IP_PORTRANGE_LOW changes the range to the "low" are
115  * that is (by convention) restricted to privileged processes.
116  * This convention is based on "vouchsafe" principles only.
117  * It is only secure if you trust the remote host to restrict these ports.
118  * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
119  */
120 
121 #define	IPPORT_RESERVED		1024
122 #define	IPPORT_ANONMIN		49152
123 #define	IPPORT_ANONMAX		65535
124 #define	IPPORT_RESERVEDMIN	600
125 #define	IPPORT_RESERVEDMAX	(IPPORT_RESERVED-1)
126 
127 /*
128  * Internet address (a structure for historical reasons)
129  */
130 struct in_addr {
131 	u_int32_t s_addr;
132 } __attribute__((__packed__));
133 
134 /*
135  * Definitions of bits in internet address integers.
136  * On subnets, the decomposition of addresses to host and net parts
137  * is done according to subnet mask, not the masks here.
138  *
139  * By byte-swapping the constants, we avoid ever having to byte-swap IP
140  * addresses inside the kernel.  Unfortunately, user-level programs rely
141  * on these macros not doing byte-swapping.
142  */
143 #ifdef _KERNEL
144 #define	__IPADDR(x)	((u_int32_t) htonl((u_int32_t)(x)))
145 #else
146 #define	__IPADDR(x)	((u_int32_t)(x))
147 #endif
148 
149 #define	IN_CLASSA(i)		(((u_int32_t)(i) & __IPADDR(0x80000000)) == \
150 				 __IPADDR(0x00000000))
151 #define	IN_CLASSA_NET		__IPADDR(0xff000000)
152 #define	IN_CLASSA_NSHIFT	24
153 #define	IN_CLASSA_HOST		__IPADDR(0x00ffffff)
154 #define	IN_CLASSA_MAX		128
155 
156 #define	IN_CLASSB(i)		(((u_int32_t)(i) & __IPADDR(0xc0000000)) == \
157 				 __IPADDR(0x80000000))
158 #define	IN_CLASSB_NET		__IPADDR(0xffff0000)
159 #define	IN_CLASSB_NSHIFT	16
160 #define	IN_CLASSB_HOST		__IPADDR(0x0000ffff)
161 #define	IN_CLASSB_MAX		65536
162 
163 #define	IN_CLASSC(i)		(((u_int32_t)(i) & __IPADDR(0xe0000000)) == \
164 				 __IPADDR(0xc0000000))
165 #define	IN_CLASSC_NET		__IPADDR(0xffffff00)
166 #define	IN_CLASSC_NSHIFT	8
167 #define	IN_CLASSC_HOST		__IPADDR(0x000000ff)
168 
169 #define	IN_CLASSD(i)		(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
170 				 __IPADDR(0xe0000000))
171 /* These ones aren't really net and host fields, but routing needn't know. */
172 #define	IN_CLASSD_NET		__IPADDR(0xf0000000)
173 #define	IN_CLASSD_NSHIFT	28
174 #define	IN_CLASSD_HOST		__IPADDR(0x0fffffff)
175 #define	IN_MULTICAST(i)		IN_CLASSD(i)
176 
177 #define	IN_EXPERIMENTAL(i)	(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
178 				 __IPADDR(0xf0000000))
179 #define	IN_BADCLASS(i)		(((u_int32_t)(i) & __IPADDR(0xf0000000)) == \
180 				 __IPADDR(0xf0000000))
181 
182 #define	IN_LOCAL_GROUP(i)	(((u_int32_t)(i) & __IPADDR(0xffffff00)) == \
183 				 __IPADDR(0xe0000000))
184 
185 #define	INADDR_ANY		__IPADDR(0x00000000)
186 #define	INADDR_LOOPBACK		__IPADDR(0x7f000001)
187 #define	INADDR_BROADCAST	__IPADDR(0xffffffff)	/* must be masked */
188 #ifndef _KERNEL
189 #define	INADDR_NONE		__IPADDR(0xffffffff)	/* -1 return */
190 #endif
191 
192 #define	INADDR_UNSPEC_GROUP	__IPADDR(0xe0000000)	/* 224.0.0.0 */
193 #define	INADDR_ALLHOSTS_GROUP	__IPADDR(0xe0000001)	/* 224.0.0.1 */
194 #define	INADDR_ALLRTRS_GROUP	__IPADDR(0xe0000002)	/* 224.0.0.2 */
195 #define	INADDR_MAX_LOCAL_GROUP	__IPADDR(0xe00000ff)	/* 224.0.0.255 */
196 
197 #define	IN_LOOPBACKNET		127			/* official! */
198 
199 /*
200  * Socket address, internet style.
201  */
202 struct sockaddr_in {
203 	u_int8_t	sin_len;
204 	sa_family_t	sin_family;
205 	u_int16_t	sin_port;
206 	struct in_addr	sin_addr;
207 	int8_t		sin_zero[8];
208 };
209 
210 #define INET_ADDRSTRLEN                 16
211 
212 /*
213  * Structure used to describe IP options.
214  * Used to store options internally, to pass them to a process,
215  * or to restore options retrieved earlier.
216  * The ip_dst is used for the first-hop gateway when using a source route
217  * (this gets put into the header proper).
218  */
219 struct ip_opts {
220 	struct in_addr	ip_dst;		/* first hop, 0 w/o src rt */
221 	int8_t		ip_opts[40];	/* actually variable in size */
222 };
223 
224 /*
225  * Options for use with [gs]etsockopt at the IP level.
226  * First word of comment is data type; bool is stored in int.
227  */
228 #define	IP_OPTIONS		1    /* buf/ip_opts; set/get IP options */
229 #define	IP_HDRINCL		2    /* int; header is included with data */
230 #define	IP_TOS			3    /* int; IP type of service and preced. */
231 #define	IP_TTL			4    /* int; IP time to live */
232 #define	IP_RECVOPTS		5    /* bool; receive all IP opts w/dgram */
233 #define	IP_RECVRETOPTS		6    /* bool; receive IP opts for response */
234 #define	IP_RECVDSTADDR		7    /* bool; receive IP dst addr w/dgram */
235 #define	IP_RETOPTS		8    /* ip_opts; set/get IP options */
236 #define	IP_MULTICAST_IF		9    /* in_addr; set/get IP multicast i/f  */
237 #define	IP_MULTICAST_TTL	10   /* u_char; set/get IP multicast ttl */
238 #define	IP_MULTICAST_LOOP	11   /* u_char; set/get IP multicast loopback */
239 #define	IP_ADD_MEMBERSHIP	12   /* ip_mreq; add an IP group membership */
240 #define	IP_DROP_MEMBERSHIP	13   /* ip_mreq; drop an IP group membership */
241 #define IP_PORTRANGE		19   /* int; range to use for ephemeral port */
242 #define	IP_RECVIF		20   /* bool; receive reception if w/dgram */
243 #define	IP_ERRORMTU		21   /* int; get MTU of last xmit = EMSGSIZE */
244 #if 1 /*IPSEC*/
245 #define IP_IPSEC_POLICY		22 /* struct; get/set security policy */
246 #endif
247 
248 /*
249  * Defaults and limits for options
250  */
251 #define	IP_DEFAULT_MULTICAST_TTL  1	/* normally limit m'casts to 1 hop  */
252 #define	IP_DEFAULT_MULTICAST_LOOP 1	/* normally hear sends if a member  */
253 #define	IP_MAX_MEMBERSHIPS	20	/* per socket; must fit in one mbuf */
254 
255 /*
256  * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
257  */
258 struct ip_mreq {
259 	struct	in_addr imr_multiaddr;	/* IP multicast address of group */
260 	struct	in_addr imr_interface;	/* local IP address of interface */
261 };
262 
263 /*
264  * Argument for IP_PORTRANGE:
265  * - which range to search when port is unspecified at bind() or connect()
266  */
267 #define	IP_PORTRANGE_DEFAULT	0	/* default range */
268 #define	IP_PORTRANGE_HIGH	1	/* same as DEFAULT (FreeBSD compat) */
269 #define	IP_PORTRANGE_LOW	2	/* use privileged range */
270 
271 #if !defined(_XOPEN_SOURCE)
272 /*
273  * Definitions for inet sysctl operations.
274  *
275  * Third level is protocol number.
276  * Fourth level is desired variable within that protocol.
277  */
278 #define	IPPROTO_MAXID	(IPPROTO_AH + 1)	/* don't list to IPPROTO_MAX */
279 
280 #define	CTL_IPPROTO_NAMES { \
281 	{ "ip", CTLTYPE_NODE }, \
282 	{ "icmp", CTLTYPE_NODE }, \
283 	{ "igmp", CTLTYPE_NODE }, \
284 	{ "ggp", CTLTYPE_NODE }, \
285 	{ 0, 0 }, \
286 	{ 0, 0 }, \
287 	{ "tcp", CTLTYPE_NODE }, \
288 	{ 0, 0 }, \
289 	{ "egp", CTLTYPE_NODE }, \
290 	{ 0, 0 }, \
291 	{ 0, 0 }, \
292 	{ 0, 0 }, \
293 	{ "pup", CTLTYPE_NODE }, \
294 	{ 0, 0 }, \
295 	{ 0, 0 }, \
296 	{ 0, 0 }, \
297 	{ 0, 0 }, \
298 	{ "udp", CTLTYPE_NODE }, \
299 	{ 0, 0 }, \
300 	{ 0, 0 }, \
301 	{ 0, 0 }, \
302 	{ 0, 0 }, \
303 	{ "idp", CTLTYPE_NODE }, \
304 	{ 0, 0 }, \
305 	{ 0, 0 }, \
306 	{ 0, 0 }, \
307 	{ 0, 0 }, \
308 	{ 0, 0 }, \
309 	{ 0, 0 }, \
310 	{ 0, 0 }, \
311 	{ 0, 0 }, \
312 	{ 0, 0 }, \
313 	{ 0, 0 }, \
314 	{ 0, 0 }, \
315 	{ 0, 0 }, \
316 	{ 0, 0 }, \
317 	{ 0, 0 }, \
318 	{ 0, 0 }, \
319 	{ 0, 0 }, \
320 	{ 0, 0 }, \
321 	{ 0, 0 }, \
322 	{ 0, 0 }, \
323 	{ 0, 0 }, \
324 	{ 0, 0 }, \
325 	{ 0, 0 }, \
326 	{ 0, 0 }, \
327 	{ 0, 0 }, \
328 	{ 0, 0 }, \
329 	{ 0, 0 }, \
330 	{ 0, 0 }, \
331 	{ 0, 0 }, \
332 	{ "ipsec", CTLTYPE_NODE }, \
333 }
334 
335 /*
336  * Names for IP sysctl objects
337  */
338 #define	IPCTL_FORWARDING	1	/* act as router */
339 #define	IPCTL_SENDREDIRECTS	2	/* may send redirects when forwarding */
340 #define	IPCTL_DEFTTL		3	/* default TTL */
341 #ifdef notyet
342 #define	IPCTL_DEFMTU		4	/* default MTU */
343 #endif
344 #define	IPCTL_FORWSRCRT		5	/* forward source-routed packets */
345 #define	IPCTL_DIRECTEDBCAST	6	/* default broadcast behavior */
346 #define	IPCTL_ALLOWSRCRT	7	/* allow/drop all source-routed pkts */
347 #define	IPCTL_SUBNETSARELOCAL	8	/* treat subnets as local addresses */
348 #define	IPCTL_MTUDISC		9	/* allow path MTU discovery */
349 #define	IPCTL_ANONPORTMIN      10	/* minimum ephemeral port */
350 #define	IPCTL_ANONPORTMAX      11	/* maximum ephemeral port */
351 #define	IPCTL_MTUDISCTIMEOUT   12	/* allow path MTU discovery */
352 #define	IPCTL_MAXFLOWS         13	/* maximum ip flows allowed */
353 #define	IPCTL_HOSTZEROBROADCAST 14	/* is host zero a broadcast addr? */
354 #define IPCTL_GIF_TTL 	       15	/* default TTL for gif encap packet */
355 #define	IPCTL_MAXID	       16
356 
357 #define	IPCTL_NAMES { \
358 	{ 0, 0 }, \
359 	{ "forwarding", CTLTYPE_INT }, \
360 	{ "redirect", CTLTYPE_INT }, \
361 	{ "ttl", CTLTYPE_INT }, \
362 	{ "mtu", CTLTYPE_INT }, \
363 	{ "forwsrcrt", CTLTYPE_INT }, \
364 	{ "directed-broadcast", CTLTYPE_INT }, \
365 	{ "allowsrcrt", CTLTYPE_INT }, \
366 	{ "subnetsarelocal", CTLTYPE_INT }, \
367 	{ "mtudisc", CTLTYPE_INT }, \
368 	{ "anonportmin", CTLTYPE_INT }, \
369 	{ "anonportmax", CTLTYPE_INT }, \
370 	{ "mtudisctimeout", CTLTYPE_INT }, \
371 	{ "maxflows", CTLTYPE_INT }, \
372 	{ "hostzerobroadcast", CTLTYPE_INT }, \
373 	{ "gifttl", CTLTYPE_INT }, \
374 }
375 #endif /* !_XOPEN_SOURCE */
376 
377 /* INET6 stuff */
378 #define __KAME_NETINET_IN_H_INCLUDED_
379 #include <netinet6/in6.h>
380 #undef __KAME_NETINET_IN_H_INCLUDED_
381 
382 #ifdef _KERNEL
383 extern	struct in_addr zeroin_addr;
384 extern	u_char	ip_protox[];
385 
386 int	in_broadcast __P((struct in_addr, struct ifnet *));
387 int	in_canforward __P((struct in_addr));
388 int	in_cksum __P((struct mbuf *, int));
389 int	in4_cksum __P((struct mbuf *, u_int8_t, int, int));
390 int	in_localaddr __P((struct in_addr));
391 void	in_socktrim __P((struct sockaddr_in *));
392 
393 #define	in_hosteq(s,t)	((s).s_addr == (t).s_addr)
394 #define	in_nullhost(x)	((x).s_addr == INADDR_ANY)
395 
396 #define	satosin(sa)	((struct sockaddr_in *)(sa))
397 #define	sintosa(sin)	((struct sockaddr *)(sin))
398 #define	ifatoia(ifa)	((struct in_ifaddr *)(ifa))
399 #endif /* _KERNEL */
400 
401 #endif /* !_NETINET_IN_H_ */
402