1.\" Copyright (c) 1983, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" From: @(#)inet.4 8.1 (Berkeley) 6/5/93 29.\" $FreeBSD$ 30.\" 31.Dd July 14, 2022 32.Dt INET 4 33.Os 34.Sh NAME 35.Nm inet 36.Nd Internet protocol family 37.Sh SYNOPSIS 38.In sys/types.h 39.In netinet/in.h 40.Sh DESCRIPTION 41The Internet protocol family is a collection of protocols 42layered atop the 43.Em Internet Protocol 44.Pq Tn IP 45transport layer, and utilizing the Internet address format. 46The Internet family provides protocol support for the 47.Dv SOCK_STREAM , SOCK_DGRAM , 48and 49.Dv SOCK_RAW 50socket types; the 51.Dv SOCK_RAW 52interface provides access to the 53.Tn IP 54protocol. 55.Sh ADDRESSING 56Internet addresses are four byte quantities, stored in 57network standard format (on little endian machines, such as the 58.Tn alpha , 59.Tn amd64 60and 61.Tn i386 62these are word and byte reversed). 63The include file 64.In netinet/in.h 65defines this address 66as a discriminated union. 67.Pp 68Sockets bound to the Internet protocol family utilize 69the following addressing structure, 70.Bd -literal -offset indent 71struct sockaddr_in { 72 uint8_t sin_len; 73 sa_family_t sin_family; 74 in_port_t sin_port; 75 struct in_addr sin_addr; 76 char sin_zero[8]; 77}; 78.Ed 79.Pp 80Sockets may be created with the local address 81.Dv INADDR_ANY 82to affect 83.Dq wildcard 84matching on incoming messages. 85The address in a 86.Xr connect 2 87or 88.Xr sendto 2 89call may be given as 90.Dv INADDR_ANY 91to mean 92.Dq this host . 93The distinguished address 94.Dv INADDR_BROADCAST 95is allowed as a shorthand for the broadcast address on the primary 96network if the first network configured supports broadcast. 97.Sh PROTOCOLS 98The Internet protocol family is comprised of 99the 100.Tn IP 101network protocol, Internet Control 102Message Protocol 103.Pq Tn ICMP , 104Internet Group Management Protocol 105.Pq Tn IGMP , 106Transmission Control 107Protocol 108.Pq Tn TCP , 109and User Datagram Protocol 110.Pq Tn UDP . 111.Tn TCP 112is used to support the 113.Dv SOCK_STREAM 114abstraction while 115.Tn UDP 116is used to support the 117.Dv SOCK_DGRAM 118abstraction. 119A raw interface to 120.Tn IP 121is available 122by creating an Internet socket of type 123.Dv SOCK_RAW . 124The 125.Tn ICMP 126message protocol is accessible from a raw socket. 127.Pp 128The 129.Nm 130address on an interface consist of the address itself, the 131netmask, either broadcast address in case of a broadcast 132interface or peers address in case of point-to-point interface. 133The following 134.Xr ioctl 2 135commands are provided for a datagram socket in the Internet domain: 136.Pp 137.Bl -tag -width ".Dv SIOCGIFBRDADDR" -offset indent -compact 138.It Dv SIOCAIFADDR 139Add address to an interface. 140The command requires 141.Ft struct in_aliasreq 142as argument. 143.It Dv SIOCDIFADDR 144Delete address from an interface. 145The command requires 146.Ft struct ifreq 147as argument. 148.It Dv SIOCGIFADDR 149.It Dv SIOCGIFBRDADDR 150.It Dv SIOCGIFDSTADDR 151.It Dv SIOCGIFNETMASK 152Return address information from interface. 153The returned value is in 154.Ft struct ifreq . 155This way of address information retrieval is obsoleted, a 156preferred way is to use 157.Xr getifaddrs 3 158API. 159.El 160.Ss MIB Variables 161In addition to the variables supported by the transport protocols in 162.Va net.inet 163(for which the respective manual pages may be consulted), 164there are a number of general variables implemented in the 165.Va net.inet.ip 166branch of the 167.Xr sysctl 3 168MIB. 169The following general variables are defined: 170.Bl -tag -width ".Va accept_sourceroute" 171.It Va forwarding 172Boolean: enable/disable forwarding of IP packets. 173Defaults to off. 174.It Va redirect 175Boolean: enable/disable sending of ICMP redirects in response to 176.Tn IP 177packets for which a better, and for the sender directly reachable, route 178and next hop is known. 179Defaults to on. 180.It Va ttl 181Integer: default time-to-live 182.Pq Dq TTL 183to use for outgoing 184.Tn IP 185packets. 186.It Va accept_sourceroute 187Boolean: enable/disable accepting of source-routed IP packets (default false). 188.It Va sourceroute 189Boolean: enable/disable forwarding of source-routed IP packets (default false). 190.It Va process_options 191Integer: control IP options processing. 192By setting this variable to 0, all IP options in the incoming packets 193will be ignored, and the packets will be passed unmodified. 194By setting to 1, IP options in the incoming packets will be processed 195accordingly. 196By setting to 2, an 197.Tn ICMP 198.Dq "prohibited by filter" 199message will be sent back in response to incoming packets with IP options. 200Default is 1. 201This 202.Xr sysctl 8 203variable affects packets destined for a local host as well as packets 204forwarded to some other host. 205.It Va rfc1122_strong_es 206Boolean: in non-forwarding mode 207.Pq forwarding is disabled 208partially implement the Strong End System model per RFC1122. 209If a packet with destination address that is local arrives on a different 210interface than the interface the address belongs to, the packet would be 211silently dropped. 212Enabling this option may break certain setups, e.g. having an alias address(es) 213on loopback that are expected to be reachable by outside traffic. 214Enabling some other network features, e.g. 215.Xr carp 4 216or destination address rewriting 217.Xr pfil 4 218filters may override and bypass this check. 219Disabled by default. 220.It Va source_address_validation 221Boolean: perform source address validation for packets destined for the local 222host. 223Consider this as following Section 3.2 of RFC3704/BCP84, where we treat local 224host as our own infrastructure. 225This has no effect on packets to be forwarded, so don't consider it as 226anti-spoof feature for a router. 227Enabled by default. 228.It Va rfc6864 229Boolean: control IP IDs generation behaviour. 230True value enables RFC6864 support, which specifies that IP ID field of 231.Em atomic 232datagrams can be set to any value. 233The 234.Fx implementation sets it to zero. 235Enabled by default. 236.It Va random_id 237Boolean: control IP IDs generation behaviour. 238Setting this 239.Xr sysctl 8 240to 1 causes the ID field in 241.Em non-atomic 242IP datagrams (or all IP datagrams, if 243.Va rfc6864 244is disabled) to be randomized instead of incremented by 1 with each packet 245generated. 246This closes a minor information leak which allows remote observers to 247determine the rate of packet generation on the machine by watching the 248counter. 249At the same time, on high-speed links, it can decrease the ID reuse 250cycle greatly. 251Default is 0 (sequential IP IDs). 252IPv6 flow IDs and fragment IDs are always random. 253.It Va maxfrags 254Integer: maximum number of fragments the host will accept and simultaneously 255hold across all reassembly queues in all VNETs. 256If set to 0, reassembly is disabled. 257If set to -1, this limit is not applied. 258This limit is recalculated when the number of mbuf clusters is changed. 259This is a global limit. 260.It Va maxfragpackets 261Integer: maximum number of fragmented packets the host will accept and 262simultaneously hold in the reassembly queue for a particular VNET. 2630 means that the host will not accept any fragmented packets for that VNET. 264\-1 means that the host will not apply this limit for that VNET. 265This limit is recalculated when the number of mbuf clusters is changed. 266This is a per-VNET limit. 267.It Va maxfragbucketsize 268Integer: maximum number of reassembly queues per bucket. 269Fragmented packets are hashed to buckets. 270Each bucket has a list of reassembly queues. 271The system must compare the incoming packets to the existing reassembly queues 272in the bucket to find a matching reassembly queue. 273To preserve system resources, the system limits the number of reassembly 274queues allowed in each bucket. 275This limit is recalculated when the number of mbuf clusters is changed or 276when the value of 277.Va maxfragpackets 278changes. 279This is a per-VNET limit. 280.It Va maxfragsperpacket 281Integer: maximum number of fragments the host will accept and hold 282in the reassembly queue for a packet. 2830 means that the host will not accept any fragmented packets for the VNET. 284This is a per-VNET limit. 285.It Va allow_net0 286Boolean: allow experimental use of addresses in 0.0.0.0/8 as endpoints, 287and allow forwarding of packets with these addresses. 288.It Va allow_net240 289Boolean: allow experimental use of addresses in 240.0.0.0/4 as endpoints, 290and allow forwarding of packets with these addresses. 291.It Va loopback_prefixlen 292Integer: prefix length of the address space reserved for loopback purposes. 293The default is 8, meaning that 127.0.0.0/8 is reserved for loopback, 294and cannot be sent, received, or forwarded on a non-loopback interface. 295Use of other values is experimental. 296.El 297.Sh SEE ALSO 298.Xr ioctl 2 , 299.Xr socket 2 , 300.Xr getifaddrs 3 , 301.Xr sysctl 3 , 302.Xr icmp 4 , 303.Xr intro 4 , 304.Xr ip 4 , 305.Xr ipfirewall 4 , 306.Xr route 4 , 307.Xr tcp 4 , 308.Xr udp 4 , 309.Xr pfil 9 310.Rs 311.%T "An Introductory 4.3 BSD Interprocess Communication Tutorial" 312.%B PS1 313.%N 7 314.Re 315.Rs 316.%T "An Advanced 4.3 BSD Interprocess Communication Tutorial" 317.%B PS1 318.%N 8 319.Re 320.Sh HISTORY 321The 322.Nm 323protocol interface appeared in 324.Bx 4.2 . 325The 326.Dq protocol cloning 327code appeared in 328.Fx 2.1 . 329.Sh CAVEATS 330The Internet protocol support is subject to change as 331the Internet protocols develop. 332Users should not depend 333on details of the current implementation, but rather 334the services exported. 335