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