2 * Copyright (c) 1982, 1986, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
33 * @(#)in.h 8.3 (Berkeley) 1/3/94
34 * $FreeBSD: src/sys/netinet/in.h,v 1.48.2.9 2002/12/01 14:03:10 sobomax Exp $
35 * $DragonFly: src/sys/netinet/in.h,v 1.3 2003/06/25 03:56:04 dillon Exp $
38 #ifndef _NETINET_IN_H_
39 #define _NETINET_IN_H_
42 * Constants and structures defined by the internet system,
43 * Per RFC 790, September 1981, and numerous additions.
47 * Protocols (RFC 1700)
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 /* IPv4 encapsulation */
55 #define IPPROTO_IPIP IPPROTO_IPV4 /* for compatibility */
56 #define IPPROTO_TCP 6 /* tcp */
57 #define IPPROTO_ST 7 /* Stream protocol II */
58 #define IPPROTO_EGP 8 /* exterior gateway protocol */
59 #define IPPROTO_PIGP 9 /* private interior gateway */
60 #define IPPROTO_RCCMON 10 /* BBN RCC Monitoring */
61 #define IPPROTO_NVPII 11 /* network voice protocol*/
62 #define IPPROTO_PUP 12 /* pup */
63 #define IPPROTO_ARGUS 13 /* Argus */
64 #define IPPROTO_EMCON 14 /* EMCON */
65 #define IPPROTO_XNET 15 /* Cross Net Debugger */
66 #define IPPROTO_CHAOS 16 /* Chaos*/
67 #define IPPROTO_UDP 17 /* user datagram protocol */
68 #define IPPROTO_MUX 18 /* Multiplexing */
69 #define IPPROTO_MEAS 19 /* DCN Measurement Subsystems */
70 #define IPPROTO_HMP 20 /* Host Monitoring */
71 #define IPPROTO_PRM 21 /* Packet Radio Measurement */
72 #define IPPROTO_IDP 22 /* xns idp */
73 #define IPPROTO_TRUNK1 23 /* Trunk-1 */
74 #define IPPROTO_TRUNK2 24 /* Trunk-2 */
75 #define IPPROTO_LEAF1 25 /* Leaf-1 */
76 #define IPPROTO_LEAF2 26 /* Leaf-2 */
77 #define IPPROTO_RDP 27 /* Reliable Data */
78 #define IPPROTO_IRTP 28 /* Reliable Transaction */
79 #define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
80 #define IPPROTO_BLT 30 /* Bulk Data Transfer */
81 #define IPPROTO_NSP 31 /* Network Services */
82 #define IPPROTO_INP 32 /* Merit Internodal */
83 #define IPPROTO_SEP 33 /* Sequential Exchange */
84 #define IPPROTO_3PC 34 /* Third Party Connect */
85 #define IPPROTO_IDPR 35 /* InterDomain Policy Routing */
86 #define IPPROTO_XTP 36 /* XTP */
87 #define IPPROTO_DDP 37 /* Datagram Delivery */
88 #define IPPROTO_CMTP 38 /* Control Message Transport */
89 #define IPPROTO_TPXX 39 /* TP++ Transport */
90 #define IPPROTO_IL 40 /* IL transport protocol */
91 #define IPPROTO_IPV6 41 /* IP6 header */
92 #define IPPROTO_SDRP 42 /* Source Demand Routing */
93 #define IPPROTO_ROUTING 43 /* IP6 routing header */
94 #define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
95 #define IPPROTO_IDRP 45 /* InterDomain Routing*/
96 #define IPPROTO_RSVP 46 /* resource reservation */
97 #define IPPROTO_GRE 47 /* General Routing Encap. */
98 #define IPPROTO_MHRP 48 /* Mobile Host Routing */
99 #define IPPROTO_BHA 49 /* BHA */
100 #define IPPROTO_ESP 50 /* IP6 Encap Sec. Payload */
101 #define IPPROTO_AH 51 /* IP6 Auth Header */
102 #define IPPROTO_INLSP 52 /* Integ. Net Layer Security */
103 #define IPPROTO_SWIPE 53 /* IP with encryption */
104 #define IPPROTO_NHRP 54 /* Next Hop Resolution */
105 #define IPPROTO_MOBILE 55 /* IP Mobility */
106 #define IPPROTO_TLSP 56 /* Transport Layer Security */
107 #define IPPROTO_SKIP 57 /* SKIP */
108 #define IPPROTO_ICMPV6 58 /* ICMP6 */
109 #define IPPROTO_NONE 59 /* IP6 no next header */
110 #define IPPROTO_DSTOPTS 60 /* IP6 destination option */
111 #define IPPROTO_AHIP 61 /* any host internal protocol */
112 #define IPPROTO_CFTP 62 /* CFTP */
113 #define IPPROTO_HELLO 63 /* "hello" routing protocol */
114 #define IPPROTO_SATEXPAK 64 /* SATNET/Backroom EXPAK */
115 #define IPPROTO_KRYPTOLAN 65 /* Kryptolan */
116 #define IPPROTO_RVD 66 /* Remote Virtual Disk */
117 #define IPPROTO_IPPC 67 /* Pluribus Packet Core */
118 #define IPPROTO_ADFS 68 /* Any distributed FS */
119 #define IPPROTO_SATMON 69 /* Satnet Monitoring */
120 #define IPPROTO_VISA 70 /* VISA Protocol */
121 #define IPPROTO_IPCV 71 /* Packet Core Utility */
122 #define IPPROTO_CPNX 72 /* Comp. Prot. Net. Executive */
123 #define IPPROTO_CPHB 73 /* Comp. Prot. HeartBeat */
124 #define IPPROTO_WSN 74 /* Wang Span Network */
125 #define IPPROTO_PVP 75 /* Packet Video Protocol */
126 #define IPPROTO_BRSATMON 76 /* BackRoom SATNET Monitoring */
127 #define IPPROTO_ND 77 /* Sun net disk proto (temp.) */
128 #define IPPROTO_WBMON 78 /* WIDEBAND Monitoring */
129 #define IPPROTO_WBEXPAK 79 /* WIDEBAND EXPAK */
130 #define IPPROTO_EON 80 /* ISO cnlp */
131 #define IPPROTO_VMTP 81 /* VMTP */
132 #define IPPROTO_SVMTP 82 /* Secure VMTP */
133 #define IPPROTO_VINES 83 /* Banyon VINES */
134 #define IPPROTO_TTP 84 /* TTP */
135 #define IPPROTO_IGP 85 /* NSFNET-IGP */
136 #define IPPROTO_DGP 86 /* dissimilar gateway prot. */
137 #define IPPROTO_TCF 87 /* TCF */
138 #define IPPROTO_IGRP 88 /* Cisco/GXS IGRP */
139 #define IPPROTO_OSPFIGP 89 /* OSPFIGP */
140 #define IPPROTO_SRPC 90 /* Strite RPC protocol */
141 #define IPPROTO_LARP 91 /* Locus Address Resoloution */
142 #define IPPROTO_MTP 92 /* Multicast Transport */
143 #define IPPROTO_AX25 93 /* AX.25 Frames */
144 #define IPPROTO_IPEIP 94 /* IP encapsulated in IP */
145 #define IPPROTO_MICP 95 /* Mobile Int.ing control */
146 #define IPPROTO_SCCSP 96 /* Semaphore Comm. security */
147 #define IPPROTO_ETHERIP 97 /* Ethernet IP encapsulation */
148 #define IPPROTO_ENCAP 98 /* encapsulation header */
149 #define IPPROTO_APES 99 /* any private encr. scheme */
150 #define IPPROTO_GMTP 100 /* GMTP*/
151 #define IPPROTO_IPCOMP 108 /* payload compression (IPComp) */
152 /* 101-254: Partly Unassigned */
153 #define IPPROTO_PIM 103 /* Protocol Independent Mcast */
154 #define IPPROTO_PGM 113 /* PGM */
156 /* BSD Private, local use, namespace incursion */
157 #define IPPROTO_DIVERT 254 /* divert pseudo-protocol */
158 #define IPPROTO_RAW 255 /* raw IP packet */
159 #define IPPROTO_MAX 256
161 /* last return value of *_input(), meaning "all job for this pkt is done". */
162 #define IPPROTO_DONE 257
165 * Local port number conventions:
167 * When a user does a bind(2) or connect(2) with a port number of zero,
168 * a non-conflicting local port address is chosen.
169 * The default range is IPPORT_RESERVED through
170 * IPPORT_USERRESERVED, although that is settable by sysctl.
172 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
173 * default assignment range.
175 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
177 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
178 * into the "high" range. These are reserved for client outbound connections
179 * which do not want to be filtered by any firewalls.
181 * The value IP_PORTRANGE_LOW changes the range to the "low" are
182 * that is (by convention) restricted to privileged processes. This
183 * convention is based on "vouchsafe" principles only. It is only secure
184 * if you trust the remote host to restrict these ports.
186 * The default range of ports and the high range can be changed by
187 * sysctl(3). (net.inet.ip.port{hi,low}{first,last}_auto)
189 * Changing those values has bad security implications if you are
190 * using a a stateless firewall that is allowing packets outside of that
191 * range in order to allow transparent outgoing connections.
193 * Such a firewall configuration will generally depend on the use of these
194 * default values. If you change them, you may find your Security
195 * Administrator looking for you with a heavy object.
197 * For a slightly more orthodox text view on this:
199 * ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
201 * port numbers are divided into three ranges:
203 * 0 - 1023 Well Known Ports
204 * 1024 - 49151 Registered Ports
205 * 49152 - 65535 Dynamic and/or Private Ports
210 * Ports < IPPORT_RESERVED are reserved for
211 * privileged processes (e.g. root). (IP_PORTRANGE_LOW)
212 * Ports > IPPORT_USERRESERVED are reserved
213 * for servers, not necessarily privileged. (IP_PORTRANGE_DEFAULT)
215 #define IPPORT_RESERVED 1024
216 #define IPPORT_USERRESERVED 5000
219 * Default local port range to use by setting IP_PORTRANGE_HIGH
221 #define IPPORT_HIFIRSTAUTO 49152
222 #define IPPORT_HILASTAUTO 65535
225 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
226 * but higher than IPPORT_RESERVEDSTART. Traditionally the start value was
227 * 512, but that conflicts with some well-known-services that firewalls may
228 * have a fit if we use.
230 #define IPPORT_RESERVEDSTART 600
233 * Internet address (a structure for historical reasons)
240 * Definitions of bits in internet address integers.
241 * On subnets, the decomposition of addresses to host and net parts
242 * is done according to subnet mask, not the masks here.
244 #define IN_CLASSA(i) (((u_int32_t)(i) & 0x80000000) == 0)
245 #define IN_CLASSA_NET 0xff000000
246 #define IN_CLASSA_NSHIFT 24
247 #define IN_CLASSA_HOST 0x00ffffff
248 #define IN_CLASSA_MAX 128
250 #define IN_CLASSB(i) (((u_int32_t)(i) & 0xc0000000) == 0x80000000)
251 #define IN_CLASSB_NET 0xffff0000
252 #define IN_CLASSB_NSHIFT 16
253 #define IN_CLASSB_HOST 0x0000ffff
254 #define IN_CLASSB_MAX 65536
256 #define IN_CLASSC(i) (((u_int32_t)(i) & 0xe0000000) == 0xc0000000)
257 #define IN_CLASSC_NET 0xffffff00
258 #define IN_CLASSC_NSHIFT 8
259 #define IN_CLASSC_HOST 0x000000ff
261 #define IN_CLASSD(i) (((u_int32_t)(i) & 0xf0000000) == 0xe0000000)
262 #define IN_CLASSD_NET 0xf0000000 /* These ones aren't really */
263 #define IN_CLASSD_NSHIFT 28 /* net and host fields, but */
264 #define IN_CLASSD_HOST 0x0fffffff /* routing needn't know. */
265 #define IN_MULTICAST(i) IN_CLASSD(i)
267 #define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
268 #define IN_BADCLASS(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
270 #define INADDR_ANY (u_int32_t)0x00000000
271 #define INADDR_LOOPBACK (u_int32_t)0x7f000001
272 #define INADDR_BROADCAST (u_int32_t)0xffffffff /* must be masked */
274 #define INADDR_NONE 0xffffffff /* -1 return */
277 #define INADDR_UNSPEC_GROUP (u_int32_t)0xe0000000 /* 224.0.0.0 */
278 #define INADDR_ALLHOSTS_GROUP (u_int32_t)0xe0000001 /* 224.0.0.1 */
279 #define INADDR_ALLRTRS_GROUP (u_int32_t)0xe0000002 /* 224.0.0.2 */
280 #define INADDR_MAX_LOCAL_GROUP (u_int32_t)0xe00000ff /* 224.0.0.255 */
282 #define IN_LOOPBACKNET 127 /* official! */
285 * Socket address, internet style.
291 struct in_addr sin_addr;
295 #define INET_ADDRSTRLEN 16
298 * Options for use with [gs]etsockopt at the IP level.
299 * First word of comment is data type; bool is stored in int.
301 #define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
302 #define IP_HDRINCL 2 /* int; header is included with data */
303 #define IP_TOS 3 /* int; IP type of service and preced. */
304 #define IP_TTL 4 /* int; IP time to live */
305 #define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
306 #define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
307 #define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
308 #define IP_RETOPTS 8 /* ip_opts; set/get IP options */
309 #define IP_MULTICAST_IF 9 /* u_char; set/get IP multicast i/f */
310 #define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
311 #define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
312 #define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
313 #define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
314 #define IP_MULTICAST_VIF 14 /* set/get IP mcast virt. iface */
315 #define IP_RSVP_ON 15 /* enable RSVP in kernel */
316 #define IP_RSVP_OFF 16 /* disable RSVP in kernel */
317 #define IP_RSVP_VIF_ON 17 /* set RSVP per-vif socket */
318 #define IP_RSVP_VIF_OFF 18 /* unset RSVP per-vif socket */
319 #define IP_PORTRANGE 19 /* int; range to choose for unspec port */
320 #define IP_RECVIF 20 /* bool; receive reception if w/dgram */
322 #define IP_IPSEC_POLICY 21 /* int; set/get security policy */
323 #define IP_FAITH 22 /* bool; accept FAITH'ed connections */
325 #define IP_FW_ADD 50 /* add a firewall rule to chain */
326 #define IP_FW_DEL 51 /* delete a firewall rule from chain */
327 #define IP_FW_FLUSH 52 /* flush firewall rule chain */
328 #define IP_FW_ZERO 53 /* clear single/all firewall counter(s) */
329 #define IP_FW_GET 54 /* get entire firewall rule chain */
330 #define IP_FW_RESETLOG 55 /* reset logging counters */
332 #define IP_DUMMYNET_CONFIGURE 60 /* add/configure a dummynet pipe */
333 #define IP_DUMMYNET_DEL 61 /* delete a dummynet pipe from chain */
334 #define IP_DUMMYNET_FLUSH 62 /* flush dummynet */
335 #define IP_DUMMYNET_GET 64 /* get entire dummynet pipes */
338 * Defaults and limits for options
340 #define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
341 #define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
342 #define IP_MAX_MEMBERSHIPS 20 /* per socket */
345 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
348 struct in_addr imr_multiaddr; /* IP multicast address of group */
349 struct in_addr imr_interface; /* local IP address of interface */
353 * Argument for IP_PORTRANGE:
354 * - which range to search when port is unspecified at bind() or connect()
356 #define IP_PORTRANGE_DEFAULT 0 /* default range */
357 #define IP_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
358 #define IP_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
361 * Definitions for inet sysctl operations.
363 * Third level is protocol number.
364 * Fourth level is desired variable within that protocol.
366 #define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */
368 #define CTL_IPPROTO_NAMES { \
369 { "ip", CTLTYPE_NODE }, \
370 { "icmp", CTLTYPE_NODE }, \
371 { "igmp", CTLTYPE_NODE }, \
372 { "ggp", CTLTYPE_NODE }, \
375 { "tcp", CTLTYPE_NODE }, \
377 { "egp", CTLTYPE_NODE }, \
381 { "pup", CTLTYPE_NODE }, \
386 { "udp", CTLTYPE_NODE }, \
391 { "idp", CTLTYPE_NODE }, \
420 { "ipsec", CTLTYPE_NODE }, \
424 * Names for IP sysctl objects
426 #define IPCTL_FORWARDING 1 /* act as router */
427 #define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
428 #define IPCTL_DEFTTL 3 /* default TTL */
430 #define IPCTL_DEFMTU 4 /* default MTU */
432 #define IPCTL_RTEXPIRE 5 /* cloned route expiration time */
433 #define IPCTL_RTMINEXPIRE 6 /* min value for expiration time */
434 #define IPCTL_RTMAXCACHE 7 /* trigger level for dynamic expire */
435 #define IPCTL_SOURCEROUTE 8 /* may perform source routes */
436 #define IPCTL_DIRECTEDBROADCAST 9 /* may re-broadcast received packets */
437 #define IPCTL_INTRQMAXLEN 10 /* max length of netisr queue */
438 #define IPCTL_INTRQDROPS 11 /* number of netisr q drops */
439 #define IPCTL_STATS 12 /* ipstat structure */
440 #define IPCTL_ACCEPTSOURCEROUTE 13 /* may accept source routed packets */
441 #define IPCTL_FASTFORWARDING 14 /* use fast IP forwarding code */
442 #define IPCTL_KEEPFAITH 15 /* FAITH IPv4->IPv6 translater ctl */
443 #define IPCTL_GIF_TTL 16 /* default TTL for gif encap packet */
444 #define IPCTL_MAXID 17
446 #define IPCTL_NAMES { \
448 { "forwarding", CTLTYPE_INT }, \
449 { "redirect", CTLTYPE_INT }, \
450 { "ttl", CTLTYPE_INT }, \
451 { "mtu", CTLTYPE_INT }, \
452 { "rtexpire", CTLTYPE_INT }, \
453 { "rtminexpire", CTLTYPE_INT }, \
454 { "rtmaxcache", CTLTYPE_INT }, \
455 { "sourceroute", CTLTYPE_INT }, \
456 { "directed-broadcast", CTLTYPE_INT }, \
457 { "intr-queue-maxlen", CTLTYPE_INT }, \
458 { "intr-queue-drops", CTLTYPE_INT }, \
459 { "stats", CTLTYPE_STRUCT }, \
460 { "accept_sourceroute", CTLTYPE_INT }, \
461 { "fastforwarding", CTLTYPE_INT }, \
465 struct ifnet; struct mbuf; /* forward declarations for Standard C */
469 #define __KAME_NETINET_IN_H_INCLUDED_
470 #include <netinet6/in6.h>
471 #undef __KAME_NETINET_IN_H_INCLUDED_
477 int in_broadcast __P((struct in_addr, struct ifnet *));
478 int in_canforward __P((struct in_addr));
479 int in_cksum __P((struct mbuf *, int));
480 int in_localaddr __P((struct in_addr));
481 char *inet_ntoa __P((struct in_addr)); /* in libkern */
483 int prison_ip __P((struct thread *td, int flag, u_int32_t *ip));
484 void prison_remote_ip __P((struct thread *td, int flag, u_int32_t *ip));
486 #define in_hosteq(s, t) ((s).s_addr == (t).s_addr)
487 #define in_nullhost(x) ((x).s_addr == INADDR_ANY)
489 #define satosin(sa) ((struct sockaddr_in *)(sa))
490 #define sintosa(sin) ((struct sockaddr *)(sin))
491 #define ifatoia(ifa) ((struct in_ifaddr *)(ifa))