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