1 //==========================================================================
3 // include/netinet/in.h
5 //==========================================================================
6 //####BSDCOPYRIGHTBEGIN####
8 // -------------------------------------------
10 // Portions of this software may have been derived from OpenBSD,
11 // FreeBSD or other sources, and are covered by the appropriate
12 // copyright disclaimers included herein.
14 // Portions created by Red Hat are
15 // Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
17 // -------------------------------------------
19 //####BSDCOPYRIGHTEND####
20 //==========================================================================
23 * Copyright (c) 1982, 1986, 1990, 1993
24 * The Regents of the University of California. All rights reserved.
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
29 * 1. Redistributions of source code must retain the above copyright
30 * notice, this list of conditions and the following disclaimer.
31 * 2. Redistributions in binary form must reproduce the above copyright
32 * notice, this list of conditions and the following disclaimer in the
33 * documentation and/or other materials provided with the distribution.
34 * 3. All advertising materials mentioning features or use of this software
35 * must display the following acknowledgement:
36 * This product includes software developed by the University of
37 * California, Berkeley and its contributors.
38 * 4. Neither the name of the University nor the names of its contributors
39 * may be used to endorse or promote products derived from this software
40 * without specific prior written permission.
42 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * @(#)in.h 8.3 (Berkeley) 1/3/94
55 * $FreeBSD: src/sys/netinet/in.h,v 1.48.2.2 2001/04/21 14:53:06 ume Exp $
58 #ifndef _NETINET_IN_H_
59 #define _NETINET_IN_H_
62 * Constants and structures defined by the internet system,
63 * Per RFC 790, September 1981, and numerous additions.
67 * Protocols (RFC 1700)
69 #define IPPROTO_IP 0 /* dummy for IP */
70 #define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */
71 #define IPPROTO_ICMP 1 /* control message protocol */
72 #define IPPROTO_IGMP 2 /* group mgmt protocol */
73 #define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
74 #define IPPROTO_IPV4 4 /* IPv4 encapsulation */
75 #define IPPROTO_IPIP IPPROTO_IPV4 /* for compatibility */
76 #define IPPROTO_TCP 6 /* tcp */
77 #define IPPROTO_ST 7 /* Stream protocol II */
78 #define IPPROTO_EGP 8 /* exterior gateway protocol */
79 #define IPPROTO_PIGP 9 /* private interior gateway */
80 #define IPPROTO_RCCMON 10 /* BBN RCC Monitoring */
81 #define IPPROTO_NVPII 11 /* network voice protocol*/
82 #define IPPROTO_PUP 12 /* pup */
83 #define IPPROTO_ARGUS 13 /* Argus */
84 #define IPPROTO_EMCON 14 /* EMCON */
85 #define IPPROTO_XNET 15 /* Cross Net Debugger */
86 #define IPPROTO_CHAOS 16 /* Chaos*/
87 #define IPPROTO_UDP 17 /* user datagram protocol */
88 #define IPPROTO_MUX 18 /* Multiplexing */
89 #define IPPROTO_MEAS 19 /* DCN Measurement Subsystems */
90 #define IPPROTO_HMP 20 /* Host Monitoring */
91 #define IPPROTO_PRM 21 /* Packet Radio Measurement */
92 #define IPPROTO_IDP 22 /* xns idp */
93 #define IPPROTO_TRUNK1 23 /* Trunk-1 */
94 #define IPPROTO_TRUNK2 24 /* Trunk-2 */
95 #define IPPROTO_LEAF1 25 /* Leaf-1 */
96 #define IPPROTO_LEAF2 26 /* Leaf-2 */
97 #define IPPROTO_RDP 27 /* Reliable Data */
98 #define IPPROTO_IRTP 28 /* Reliable Transaction */
99 #define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
100 #define IPPROTO_BLT 30 /* Bulk Data Transfer */
101 #define IPPROTO_NSP 31 /* Network Services */
102 #define IPPROTO_INP 32 /* Merit Internodal */
103 #define IPPROTO_SEP 33 /* Sequential Exchange */
104 #define IPPROTO_3PC 34 /* Third Party Connect */
105 #define IPPROTO_IDPR 35 /* InterDomain Policy Routing */
106 #define IPPROTO_XTP 36 /* XTP */
107 #define IPPROTO_DDP 37 /* Datagram Delivery */
108 #define IPPROTO_CMTP 38 /* Control Message Transport */
109 #define IPPROTO_TPXX 39 /* TP++ Transport */
110 #define IPPROTO_IL 40 /* IL transport protocol */
111 #define IPPROTO_IPV6 41 /* IP6 header */
112 #define IPPROTO_SDRP 42 /* Source Demand Routing */
113 #define IPPROTO_ROUTING 43 /* IP6 routing header */
114 #define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
115 #define IPPROTO_IDRP 45 /* InterDomain Routing*/
116 #define IPPROTO_RSVP 46 /* resource reservation */
117 #define IPPROTO_GRE 47 /* General Routing Encap. */
118 #define IPPROTO_MHRP 48 /* Mobile Host Routing */
119 #define IPPROTO_BHA 49 /* BHA */
120 #define IPPROTO_ESP 50 /* IP6 Encap Sec. Payload */
121 #define IPPROTO_AH 51 /* IP6 Auth Header */
122 #define IPPROTO_INLSP 52 /* Integ. Net Layer Security */
123 #define IPPROTO_SWIPE 53 /* IP with encryption */
124 #define IPPROTO_NHRP 54 /* Next Hop Resolution */
125 /* 55-57: Unassigned */
126 #define IPPROTO_ICMPV6 58 /* ICMP6 */
127 #define IPPROTO_NONE 59 /* IP6 no next header */
128 #define IPPROTO_DSTOPTS 60 /* IP6 destination option */
129 #define IPPROTO_AHIP 61 /* any host internal protocol */
130 #define IPPROTO_CFTP 62 /* CFTP */
131 #define IPPROTO_HELLO 63 /* "hello" routing protocol */
132 #define IPPROTO_SATEXPAK 64 /* SATNET/Backroom EXPAK */
133 #define IPPROTO_KRYPTOLAN 65 /* Kryptolan */
134 #define IPPROTO_RVD 66 /* Remote Virtual Disk */
135 #define IPPROTO_IPPC 67 /* Pluribus Packet Core */
136 #define IPPROTO_ADFS 68 /* Any distributed FS */
137 #define IPPROTO_SATMON 69 /* Satnet Monitoring */
138 #define IPPROTO_VISA 70 /* VISA Protocol */
139 #define IPPROTO_IPCV 71 /* Packet Core Utility */
140 #define IPPROTO_CPNX 72 /* Comp. Prot. Net. Executive */
141 #define IPPROTO_CPHB 73 /* Comp. Prot. HeartBeat */
142 #define IPPROTO_WSN 74 /* Wang Span Network */
143 #define IPPROTO_PVP 75 /* Packet Video Protocol */
144 #define IPPROTO_BRSATMON 76 /* BackRoom SATNET Monitoring */
145 #define IPPROTO_ND 77 /* Sun net disk proto (temp.) */
146 #define IPPROTO_WBMON 78 /* WIDEBAND Monitoring */
147 #define IPPROTO_WBEXPAK 79 /* WIDEBAND EXPAK */
148 #define IPPROTO_EON 80 /* ISO cnlp */
149 #define IPPROTO_VMTP 81 /* VMTP */
150 #define IPPROTO_SVMTP 82 /* Secure VMTP */
151 #define IPPROTO_VINES 83 /* Banyon VINES */
152 #define IPPROTO_TTP 84 /* TTP */
153 #define IPPROTO_IGP 85 /* NSFNET-IGP */
154 #define IPPROTO_DGP 86 /* dissimilar gateway prot. */
155 #define IPPROTO_TCF 87 /* TCF */
156 #define IPPROTO_IGRP 88 /* Cisco/GXS IGRP */
157 #define IPPROTO_OSPFIGP 89 /* OSPFIGP */
158 #define IPPROTO_SRPC 90 /* Strite RPC protocol */
159 #define IPPROTO_LARP 91 /* Locus Address Resoloution */
160 #define IPPROTO_MTP 92 /* Multicast Transport */
161 #define IPPROTO_AX25 93 /* AX.25 Frames */
162 #define IPPROTO_IPEIP 94 /* IP encapsulated in IP */
163 #define IPPROTO_MICP 95 /* Mobile Int.ing control */
164 #define IPPROTO_SCCSP 96 /* Semaphore Comm. security */
165 #define IPPROTO_ETHERIP 97 /* Ethernet IP encapsulation */
166 #define IPPROTO_ENCAP 98 /* encapsulation header */
167 #define IPPROTO_APES 99 /* any private encr. scheme */
168 #define IPPROTO_GMTP 100 /* GMTP*/
169 #define IPPROTO_IPCOMP 108 /* payload compression (IPComp) */
170 #define IPPROTO_PIM 103 /* Protocol Independent Mcast */
171 #define IPPROTO_PGM 113 /* PGM */
172 #define IPPROTO_SCTP 132 /* SCTP (RFC2960) */
173 /* 134-254: Partly Unassigned */
175 /* BSD Private, local use, namespace incursion */
176 #define IPPROTO_DIVERT 254 /* divert pseudo-protocol */
177 #define IPPROTO_RAW 255 /* raw IP packet */
178 #define IPPROTO_MAX 256
180 /* last return value of *_input(), meaning "all job for this pkt is done". */
181 #define IPPROTO_DONE 257
184 * Local port number conventions:
186 * When a user does a bind(2) or connect(2) with a port number of zero,
187 * a non-conflicting local port address is chosen.
188 * The default range is IPPORT_RESERVED through
189 * IPPORT_USERRESERVED, although that is settable by sysctl.
191 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
192 * default assignment range.
194 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
196 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
197 * into the "high" range. These are reserved for client outbound connections
198 * which do not want to be filtered by any firewalls.
200 * The value IP_PORTRANGE_LOW changes the range to the "low" are
201 * that is (by convention) restricted to privileged processes. This
202 * convention is based on "vouchsafe" principles only. It is only secure
203 * if you trust the remote host to restrict these ports.
205 * The default range of ports and the high range can be changed by
206 * sysctl(3). (net.inet.ip.port{hi,low}{first,last}_auto)
208 * Changing those values has bad security implications if you are
209 * using a a stateless firewall that is allowing packets outside of that
210 * range in order to allow transparent outgoing connections.
212 * Such a firewall configuration will generally depend on the use of these
213 * default values. If you change them, you may find your Security
214 * Administrator looking for you with a heavy object.
216 * For a slightly more orthodox text view on this:
218 * ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
220 * port numbers are divided into three ranges:
222 * 0 - 1023 Well Known Ports
223 * 1024 - 49151 Registered Ports
224 * 49152 - 65535 Dynamic and/or Private Ports
229 * Ports < IPPORT_RESERVED are reserved for
230 * privileged processes (e.g. root). (IP_PORTRANGE_LOW)
231 * Ports > IPPORT_USERRESERVED are reserved
232 * for servers, not necessarily privileged. (IP_PORTRANGE_DEFAULT)
234 #define IPPORT_RESERVED 1024
235 #define IPPORT_USERRESERVED 5000
238 * Default local port range to use by setting IP_PORTRANGE_HIGH
240 #define IPPORT_HIFIRSTAUTO 49152
241 #define IPPORT_HILASTAUTO 65535
244 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
245 * but higher than IPPORT_RESERVEDSTART. Traditionally the start value was
246 * 512, but that conflicts with some well-known-services that firewalls may
247 * have a fit if we use.
249 #define IPPORT_RESERVEDSTART 600
252 * Internet address (a structure for historical reasons)
259 * Definitions of bits in internet address integers.
260 * On subnets, the decomposition of addresses to host and net parts
261 * is done according to subnet mask, not the masks here.
263 #define IN_CLASSA(i) (((u_int32_t)(i) & 0x80000000) == 0)
264 #define IN_CLASSA_NET 0xff000000
265 #define IN_CLASSA_NSHIFT 24
266 #define IN_CLASSA_HOST 0x00ffffff
267 #define IN_CLASSA_MAX 128
269 #define IN_CLASSB(i) (((u_int32_t)(i) & 0xc0000000) == 0x80000000)
270 #define IN_CLASSB_NET 0xffff0000
271 #define IN_CLASSB_NSHIFT 16
272 #define IN_CLASSB_HOST 0x0000ffff
273 #define IN_CLASSB_MAX 65536
275 #define IN_CLASSC(i) (((u_int32_t)(i) & 0xe0000000) == 0xc0000000)
276 #define IN_CLASSC_NET 0xffffff00
277 #define IN_CLASSC_NSHIFT 8
278 #define IN_CLASSC_HOST 0x000000ff
280 #define IN_CLASSD(i) (((u_int32_t)(i) & 0xf0000000) == 0xe0000000)
281 #define IN_CLASSD_NET 0xf0000000 /* These ones aren't really */
282 #define IN_CLASSD_NSHIFT 28 /* net and host fields, but */
283 #define IN_CLASSD_HOST 0x0fffffff /* routing needn't know. */
284 #define IN_MULTICAST(i) IN_CLASSD(i)
286 #define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
287 #define IN_BADCLASS(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
289 #define INADDR_ANY (u_int32_t)0x00000000
290 #define INADDR_LOOPBACK (u_int32_t)0x7f000001
291 #define INADDR_BROADCAST (u_int32_t)0xffffffff /* must be masked */
292 #define INADDR_NONE 0xffffffff /* -1 return */
294 #define INADDR_UNSPEC_GROUP (u_int32_t)0xe0000000 /* 224.0.0.0 */
295 #define INADDR_ALLHOSTS_GROUP (u_int32_t)0xe0000001 /* 224.0.0.1 */
296 #define INADDR_ALLRTRS_GROUP (u_int32_t)0xe0000002 /* 224.0.0.2 */
297 #define INADDR_MAX_LOCAL_GROUP (u_int32_t)0xe00000ff /* 224.0.0.255 */
299 #define IN_LOOPBACKNET 127 /* official! */
302 * Socket address, internet style.
308 struct in_addr sin_addr;
312 #define INET_ADDRSTRLEN 16
315 * Structure used to describe IP options.
316 * Used to store options internally, to pass them to a process,
317 * or to restore options retrieved earlier.
318 * The ip_dst is used for the first-hop gateway when using a source route
319 * (this gets put into the header proper).
322 struct in_addr ip_dst; /* first hop, 0 w/o src rt */
323 #if defined(__cplusplus)
324 int8_t Ip_opts[40]; /* cannot have same name as class */
326 int8_t ip_opts[40]; /* actually variable in size */
331 * Options for use with [gs]etsockopt at the IP level.
332 * First word of comment is data type; bool is stored in int.
334 #define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
335 #define IP_HDRINCL 2 /* int; header is included with data */
336 #define IP_TOS 3 /* int; IP type of service and preced. */
337 #define IP_TTL 4 /* int; IP time to live */
338 #define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
339 #define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
340 #define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
341 #define IP_RETOPTS 8 /* ip_opts; set/get IP options */
342 #define IP_MULTICAST_IF 9 /* u_char; set/get IP multicast i/f */
343 #define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
344 #define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
345 #define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
346 #define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
347 #define IP_MULTICAST_VIF 14 /* set/get IP mcast virt. iface */
348 #define IP_RSVP_ON 15 /* enable RSVP in kernel */
349 #define IP_RSVP_OFF 16 /* disable RSVP in kernel */
350 #define IP_RSVP_VIF_ON 17 /* set RSVP per-vif socket */
351 #define IP_RSVP_VIF_OFF 18 /* unset RSVP per-vif socket */
352 #define IP_PORTRANGE 19 /* int; range to choose for unspec port */
353 #define IP_RECVIF 20 /* bool; receive reception if w/dgram */
355 #define IP_IPSEC_POLICY 21 /* int; set/get security policy */
356 #define IP_FAITH 22 /* bool; accept FAITH'ed connections */
358 #define IP_FW_ADD 50 /* add a firewall rule to chain */
359 #define IP_FW_DEL 51 /* delete a firewall rule from chain */
360 #define IP_FW_FLUSH 52 /* flush firewall rule chain */
361 #define IP_FW_ZERO 53 /* clear single/all firewall counter(s) */
362 #define IP_FW_GET 54 /* get entire firewall rule chain */
363 #define IP_FW_RESETLOG 55 /* reset logging counters */
365 #define IP_DUMMYNET_CONFIGURE 60 /* add/configure a dummynet pipe */
366 #define IP_DUMMYNET_DEL 61 /* delete a dummynet pipe from chain */
367 #define IP_DUMMYNET_FLUSH 62 /* flush dummynet */
368 #define IP_DUMMYNET_GET 64 /* get entire dummynet pipes */
371 * Defaults and limits for options
373 #define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
374 #define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
375 #define IP_MAX_MEMBERSHIPS 20 /* per socket */
378 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
381 struct in_addr imr_multiaddr; /* IP multicast address of group */
382 struct in_addr imr_interface; /* local IP address of interface */
386 * Argument for IP_PORTRANGE:
387 * - which range to search when port is unspecified at bind() or connect()
389 #define IP_PORTRANGE_DEFAULT 0 /* default range */
390 #define IP_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
391 #define IP_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
394 * Definitions for inet sysctl operations.
396 * Third level is protocol number.
397 * Fourth level is desired variable within that protocol.
399 #define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */
401 #define CTL_IPPROTO_NAMES { \
402 { "ip", CTLTYPE_NODE }, \
403 { "icmp", CTLTYPE_NODE }, \
404 { "igmp", CTLTYPE_NODE }, \
405 { "ggp", CTLTYPE_NODE }, \
408 { "tcp", CTLTYPE_NODE }, \
410 { "egp", CTLTYPE_NODE }, \
414 { "pup", CTLTYPE_NODE }, \
419 { "udp", CTLTYPE_NODE }, \
424 { "idp", CTLTYPE_NODE }, \
453 { "ipsec", CTLTYPE_NODE }, \
457 * Names for IP sysctl objects
459 #define IPCTL_FORWARDING 1 /* act as router */
460 #define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
461 #define IPCTL_DEFTTL 3 /* default TTL */
463 #define IPCTL_DEFMTU 4 /* default MTU */
465 #define IPCTL_RTEXPIRE 5 /* cloned route expiration time */
466 #define IPCTL_RTMINEXPIRE 6 /* min value for expiration time */
467 #define IPCTL_RTMAXCACHE 7 /* trigger level for dynamic expire */
468 #define IPCTL_SOURCEROUTE 8 /* may perform source routes */
469 #define IPCTL_DIRECTEDBROADCAST 9 /* may re-broadcast received packets */
470 #define IPCTL_INTRQMAXLEN 10 /* max length of netisr queue */
471 #define IPCTL_INTRQDROPS 11 /* number of netisr q drops */
472 #define IPCTL_STATS 12 /* ipstat structure */
473 #define IPCTL_ACCEPTSOURCEROUTE 13 /* may accept source routed packets */
474 #define IPCTL_FASTFORWARDING 14 /* use fast IP forwarding code */
475 #define IPCTL_KEEPFAITH 15 /* FAITH IPv4->IPv6 translater ctl */
476 #define IPCTL_GIF_TTL 16 /* default TTL for gif encap packet */
477 #define IPCTL_MAXID 17
479 #define IPCTL_NAMES { \
481 { "forwarding", CTLTYPE_INT }, \
482 { "redirect", CTLTYPE_INT }, \
483 { "ttl", CTLTYPE_INT }, \
484 { "mtu", CTLTYPE_INT }, \
485 { "rtexpire", CTLTYPE_INT }, \
486 { "rtminexpire", CTLTYPE_INT }, \
487 { "rtmaxcache", CTLTYPE_INT }, \
488 { "sourceroute", CTLTYPE_INT }, \
489 { "directed-broadcast", CTLTYPE_INT }, \
490 { "intr-queue-maxlen", CTLTYPE_INT }, \
491 { "intr-queue-drops", CTLTYPE_INT }, \
492 { "stats", CTLTYPE_STRUCT }, \
493 { "accept_sourceroute", CTLTYPE_INT }, \
494 { "fastforwarding", CTLTYPE_INT }, \
498 struct ifnet; struct mbuf; /* forward declarations for Standard C */
502 #define __KAME_NETINET_IN_H_INCLUDED_
503 #include <netinet6/in6.h>
504 #undef __KAME_NETINET_IN_H_INCLUDED_
511 int in_broadcast __P((struct in_addr, struct ifnet *));
512 int in_canforward __P((struct in_addr));
513 int in_cksum __P((struct mbuf *, int));
514 u_int in_cksum_hdr __P((const struct ip *));
515 u_short in_cksum_skip __P((struct mbuf *, int, int));
516 u_short in_pseudo __P((u_int32_t, u_int32_t, u_int32_t));
517 u_short in_addword __P((u_short, u_short));
518 int in_localaddr __P((struct in_addr));
519 char *inet_ntoa __P((struct in_addr));
520 char *inet_ntoa_r __P((struct in_addr, char *));