share/man/man4/ip.4

   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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)ip.4        8.2 (Berkeley) 11/30/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd September 26, 2005
  36 .Dt IP 4
  37 .Os
  38 .Sh NAME
  39 .Nm ip
  40 .Nd Internet Protocol
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/socket.h
  44 .In netinet/in.h
  45 .Ft int
  46 .Fn socket AF_INET SOCK_RAW proto
  47 .Sh DESCRIPTION
  48 .Tn IP
  49 is the transport layer protocol used
  50 by the Internet protocol family.
  51 Options may be set at the
  52 .Tn IP
  53 level
  54 when using higher-level protocols that are based on
  55 .Tn IP
  56 (such as
  57 .Tn TCP
  58 and
  59 .Tn UDP ) .
  60 It may also be accessed
  61 through a
  62 .Dq raw socket
  63 when developing new protocols, or
  64 special-purpose applications.
  65 .Pp
  66 There are several
  67 .Tn IP-level
  68 .Xr setsockopt 2
  69 and
  70 .Xr getsockopt 2
  71 options.
  72 .Dv IP_OPTIONS
  73 may be used to provide
  74 .Tn IP
  75 options to be transmitted in the
  76 .Tn IP
  77 header of each outgoing packet
  78 or to examine the header options on incoming packets.
  79 .Tn IP
  80 options may be used with any socket type in the Internet family.
  81 The format of
  82 .Tn IP
  83 options to be sent is that specified by the
  84 .Tn IP
  85 protocol specification (RFC-791), with one exception:
  86 the list of addresses for Source Route options must include the first-hop
  87 gateway at the beginning of the list of gateways.
  88 The first-hop gateway address will be extracted from the option list
  89 and the size adjusted accordingly before use.
  90 To disable previously specified options,
  91 use a zero-length buffer:
  92 .Bd -literal
  93 setsockopt(s, IPPROTO_IP, IP_OPTIONS, NULL, 0);
  94 .Ed
  95 .Pp
  96 .Dv IP_TOS
  97 and
  98 .Dv IP_TTL
  99 may be used to set the type-of-service and time-to-live
 100 fields in the
 101 .Tn IP
 102 header for
 103 .Dv SOCK_STREAM , SOCK_DGRAM ,
 104 and certain types of
 105 .Dv SOCK_RAW
 106 sockets.
 107 For example,
 108 .Bd -literal
 109 int tos = IPTOS_LOWDELAY;       /* see <netinet/ip.h> */
 110 setsockopt(s, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
 111
 112 int ttl = 60;                   /* max = 255 */
 113 setsockopt(s, IPPROTO_IP, IP_TTL, &ttl, sizeof(ttl));
 114 .Ed
 115 .Pp
 116 .Dv IP_MINTTL
 117 may be used to set the minimum acceptable TTL a packet must have when
 118 received on a socket.
 119 All packets with a lower TTL are silently dropped.
 120 This option is only really useful when set to 255, preventing packets
 121 from outside the directly connected networks reaching local listeners
 122 on sockets.
 123 .Pp
 124 .Dv IP_DONTFRAG
 125 may be used to set the Don't Fragment flag on IP packets.
 126 Currently this option is respected only on
 127 .Xr udp 4
 128 and raw
 129 .Xr ip 4
 130 sockets, unless the
 131 .Dv IP_HDRINCL
 132 option has been set.
 133 On
 134 .Xr tcp 4
 135 sockets, the Don't Fragment flag is controlled by the Path
 136 MTU Discovery option.
 137 Sending a packet larger than the MTU size of the egress interface,
 138 determined by the destination address, returns an
 139 .Er EMSGSIZE
 140 error.
 141 .Pp
 142 If the
 143 .Dv IP_RECVDSTADDR
 144 option is enabled on a
 145 .Dv SOCK_DGRAM
 146 socket,
 147 the
 148 .Xr recvmsg 2
 149 call will return the destination
 150 .Tn IP
 151 address for a
 152 .Tn UDP
 153 datagram.
 154 The
 155 .Vt msg_control
 156 field in the
 157 .Vt msghdr
 158 structure points to a buffer
 159 that contains a
 160 .Vt cmsghdr
 161 structure followed by the
 162 .Tn IP
 163 address.
 164 The
 165 .Vt cmsghdr
 166 fields have the following values:
 167 .Bd -literal
 168 cmsg_len = sizeof(struct in_addr)
 169 cmsg_level = IPPROTO_IP
 170 cmsg_type = IP_RECVDSTADDR
 171 .Ed
 172 .Pp
 173 The source address to be used for outgoing
 174 .Tn UDP
 175 datagrams on a socket that is not bound to a specific
 176 .Tn IP
 177 address can be specified as ancillary data with a type code of
 178 .Dv IP_SENDSRCADDR .
 179 The msg_control field in the msghdr structure should point to a buffer
 180 that contains a
 181 .Vt cmsghdr
 182 structure followed by the
 183 .Tn IP
 184 address.
 185 The cmsghdr fields should have the following values:
 186 .Bd -literal
 187 cmsg_len = sizeof(struct in_addr)
 188 cmsg_level = IPPROTO_IP
 189 cmsg_type = IP_SENDSRCADDR
 190 .Ed
 191 .Pp
 192 For convenience,
 193 .Dv IP_SENDSRCADDR
 194 is defined to have the same value as
 195 .Dv IP_RECVDSTADDR ,
 196 so the
 197 .Dv IP_RECVDSTADDR
 198 control message from
 199 .Xr recvmsg 2
 200 can be used directly as a control message for
 201 .Xr sendmsg 2 .
 202 .Pp
 203 If the
 204 .Dv IP_ONESBCAST
 205 option is enabled on a
 206 .Dv SOCK_DGRAM
 207 or a
 208 .Dv SOCK_RAW
 209 socket, the destination address of outgoing
 210 broadcast datagrams on that socket will be forced
 211 to the undirected broadcast address,
 212 .Dv INADDR_BROADCAST ,
 213 before transmission.
 214 This is in contrast to the default behavior of the
 215 system, which is to transmit undirected broadcasts
 216 via the first network interface with the
 217 .Dv IFF_BROADCAST flag set.
 218 .Pp
 219 This option allows applications to choose which
 220 interface is used to transmit an undirected broadcast
 221 datagram.
 222 For example, the following code would force an
 223 undirected broadcast to be transmitted via the interface
 224 configured with the broadcast address 192.168.2.255:
 225 .Bd -literal
 226 char msg[512];
 227 struct sockaddr_in sin;
 228 u_char onesbcast = 1;   /* 0 = disable (default), 1 = enable */
 229
 230 setsockopt(s, IPPROTO_IP, IP_ONESBCAST, &onesbcast, sizeof(onesbcast));
 231 sin.sin_addr.s_addr = inet_addr("192.168.2.255");
 232 sin.sin_port = htons(1234);
 233 sendto(s, msg, sizeof(msg), 0, &sin, sizeof(sin));
 234 .Ed
 235 .Pp
 236 It is the application's responsibility to set the
 237 .Dv IP_TTL option
 238 to an appropriate value in order to prevent broadcast storms.
 239 The application must have sufficient credentials to set the
 240 .Dv SO_BROADCAST
 241 socket level option, otherwise the
 242 .Dv IP_ONESBCAST option has no effect.
 243 .Pp
 244 If the
 245 .Dv IP_RECVTTL
 246 option is enabled on a
 247 .Dv SOCK_DGRAM
 248 socket, the
 249 .Xr recvmsg 2
 250 call will return the
 251 .Tn IP
 252 .Tn TTL
 253 (time to live) field for a
 254 .Tn UDP
 255 datagram.
 256 The msg_control field in the msghdr structure points to a buffer
 257 that contains a cmsghdr structure followed by the
 258 .Tn TTL .
 259 The cmsghdr fields have the following values:
 260 .Bd -literal
 261 cmsg_len = sizeof(u_char)
 262 cmsg_level = IPPROTO_IP
 263 cmsg_type = IP_RECVTTL
 264 .Ed
 265 .Pp
 266 If the
 267 .Dv IP_RECVIF
 268 option is enabled on a
 269 .Dv SOCK_DGRAM
 270 socket, the
 271 .Xr recvmsg 2
 272 call returns a
 273 .Vt "struct sockaddr_dl"
 274 corresponding to the interface on which the
 275 packet was received.
 276 The
 277 .Va msg_control
 278 field in the
 279 .Vt msghdr
 280 structure points to a buffer that contains a
 281 .Vt cmsghdr
 282 structure followed by the
 283 .Vt "struct sockaddr_dl" .
 284 The
 285 .Vt cmsghdr
 286 fields have the following values:
 287 .Bd -literal
 288 cmsg_len = sizeof(struct sockaddr_dl)
 289 cmsg_level = IPPROTO_IP
 290 cmsg_type = IP_RECVIF
 291 .Ed
 292 .Pp
 293 .Dv IP_PORTRANGE
 294 may be used to set the port range used for selecting a local port number
 295 on a socket with an unspecified (zero) port number.
 296 It has the following
 297 possible values:
 298 .Bl -tag -width IP_PORTRANGE_DEFAULT
 299 .It Dv IP_PORTRANGE_DEFAULT
 300 use the default range of values, normally
 301 .Dv IPPORT_HIFIRSTAUTO
 302 through
 303 .Dv IPPORT_HILASTAUTO .
 304 This is adjustable through the sysctl setting:
 305 .Va net.inet.ip.portrange.first
 306 and
 307 .Va net.inet.ip.portrange.last .
 308 .It Dv IP_PORTRANGE_HIGH
 309 use a high range of values, normally
 310 .Dv IPPORT_HIFIRSTAUTO
 311 and
 312 .Dv IPPORT_HILASTAUTO .
 313 This is adjustable through the sysctl setting:
 314 .Va net.inet.ip.portrange.hifirst
 315 and
 316 .Va net.inet.ip.portrange.hilast .
 317 .It Dv IP_PORTRANGE_LOW
 318 use a low range of ports, which are normally restricted to
 319 privileged processes on
 320 .Ux
 321 systems.
 322 The range is normally from
 323 .Dv IPPORT_RESERVED
 324 \- 1 down to
 325 .Li IPPORT_RESERVEDSTART
 326 in descending order.
 327 This is adjustable through the sysctl setting:
 328 .Va net.inet.ip.portrange.lowfirst
 329 and
 330 .Va net.inet.ip.portrange.lowlast .
 331 .El
 332 .Pp
 333 The range of privileged ports which only may be opened by
 334 root-owned processes may be modified by the
 335 .Va net.inet.ip.portrange.reservedlow
 336 and
 337 .Va net.inet.ip.portrange.reservedhigh
 338 sysctl settings.
 339 The values default to the traditional range,
 340 0 through
 341 .Dv IPPORT_RESERVED
 342 \- 1
 343 (0 through 1023), respectively.
 344 Note that these settings do not affect and are not accounted for in the
 345 use or calculation of the other
 346 .Va net.inet.ip.portrange
 347 values above.
 348 Changing these values departs from
 349 .Ux
 350 tradition and has security
 351 consequences that the administrator should carefully evaluate before
 352 modifying these settings.
 353 .Pp
 354 Ports are allocated at random within the specified port range in order
 355 to increase the difficulty of random spoofing attacks.
 356 In scenarios such as benchmarking, this behavior may be undesirable.
 357 In these cases,
 358 .Va net.inet.ip.portrange.randomized
 359 can be used to toggle randomization off.
 360 If more than
 361 .Va net.inet.ip.portrange.randomcps
 362 ports have been allocated in the last second, then return to sequential
 363 port allocation.
 364 Return to random allocation only once the current port allocation rate
 365 drops below
 366 .Va net.inet.ip.portrange.randomcps
 367 for at least
 368 .Va net.inet.ip.portrange.randomtime
 369 seconds.
 370 The default values for
 371 .Va net.inet.ip.portrange.randomcps
 372 and
 373 .Va net.inet.ip.portrange.randomtime
 374 are 10 port allocations per second and 45 seconds correspondingly.
 375 .Ss "Multicast Options"
 376 .Pp
 377 .Tn IP
 378 multicasting is supported only on
 379 .Dv AF_INET
 380 sockets of type
 381 .Dv SOCK_DGRAM
 382 and
 383 .Dv SOCK_RAW ,
 384 and only on networks where the interface
 385 driver supports multicasting.
 386 .Pp
 387 The
 388 .Dv IP_MULTICAST_TTL
 389 option changes the time-to-live (TTL)
 390 for outgoing multicast datagrams
 391 in order to control the scope of the multicasts:
 392 .Bd -literal
 393 u_char ttl;     /* range: 0 to 255, default = 1 */
 394 setsockopt(s, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl));
 395 .Ed
 396 .Pp
 397 Datagrams with a TTL of 1 are not forwarded beyond the local network.
 398 Multicast datagrams with a TTL of 0 will not be transmitted on any network,
 399 but may be delivered locally if the sending host belongs to the destination
 400 group and if multicast loopback has not been disabled on the sending socket
 401 (see below).
 402 Multicast datagrams with TTL greater than 1 may be forwarded
 403 to other networks if a multicast router is attached to the local network.
 404 .Pp
 405 For hosts with multiple interfaces, each multicast transmission is
 406 sent from the primary network interface.
 407 The
 408 .Dv IP_MULTICAST_IF
 409 option overrides the default for
 410 subsequent transmissions from a given socket:
 411 .Bd -literal
 412 struct in_addr addr;
 413 setsockopt(s, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr));
 414 .Ed
 415 .Pp
 416 where "addr" is the local
 417 .Tn IP
 418 address of the desired interface or
 419 .Dv INADDR_ANY
 420 to specify the default interface.
 421 An interface's local IP address and multicast capability can
 422 be obtained via the
 423 .Dv SIOCGIFCONF
 424 and
 425 .Dv SIOCGIFFLAGS
 426 ioctls.
 427 Normal applications should not need to use this option.
 428 .Pp
 429 If a multicast datagram is sent to a group to which the sending host itself
 430 belongs (on the outgoing interface), a copy of the datagram is, by default,
 431 looped back by the IP layer for local delivery.
 432 The
 433 .Dv IP_MULTICAST_LOOP
 434 option gives the sender explicit control
 435 over whether or not subsequent datagrams are looped back:
 436 .Bd -literal
 437 u_char loop;    /* 0 = disable, 1 = enable (default) */
 438 setsockopt(s, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop));
 439 .Ed
 440 .Pp
 441 This option
 442 improves performance for applications that may have no more than one
 443 instance on a single host (such as a router daemon), by eliminating
 444 the overhead of receiving their own transmissions.
 445 It should generally not
 446 be used by applications for which there may be more than one instance on a
 447 single host (such as a conferencing program) or for which the sender does
 448 not belong to the destination group (such as a time querying program).
 449 .Pp
 450 A multicast datagram sent with an initial TTL greater than 1 may be delivered
 451 to the sending host on a different interface from that on which it was sent,
 452 if the host belongs to the destination group on that other interface.
 453 The loopback control option has no effect on such delivery.
 454 .Pp
 455 A host must become a member of a multicast group before it can receive
 456 datagrams sent to the group.
 457 To join a multicast group, use the
 458 .Dv IP_ADD_MEMBERSHIP
 459 option:
 460 .Bd -literal
 461 struct ip_mreq mreq;
 462 setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq));
 463 .Ed
 464 .Pp
 465 where
 466 .Fa mreq
 467 is the following structure:
 468 .Bd -literal
 469 struct ip_mreq {
 470     struct in_addr imr_multiaddr; /* IP multicast address of group */
 471     struct in_addr imr_interface; /* local IP address of interface */
 472 }
 473 .Ed
 474 .Pp
 475 .Va imr_interface
 476 should be set to
 477 .Dv INADDR_ANY
 478 to choose the default multicast interface,
 479 or the
 480 .Tn IP
 481 address of a particular multicast-capable interface if
 482 the host is multihomed.
 483 Since
 484 .Fx 4.4 ,
 485 if the
 486 .Va imr_interface
 487 member is within the network range
 488 .Li 0.0.0.0/8 ,
 489 it is treated as an interface index in the system interface MIB,
 490 as per the RIP Version 2 MIB Extension (RFC-1724).
 491 .Pp
 492 Membership is associated with a single interface;
 493 programs running on multihomed hosts may need to
 494 join the same group on more than one interface.
 495 Up to
 496 .Dv IP_MAX_MEMBERSHIPS
 497 (currently 20) memberships may be added on a
 498 single socket.
 499 .Pp
 500 To drop a membership, use:
 501 .Bd -literal
 502 struct ip_mreq mreq;
 503 setsockopt(s, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq));
 504 .Ed
 505 .Pp
 506 where
 507 .Fa mreq
 508 contains the same values as used to add the membership.
 509 Memberships are dropped when the socket is closed or the process exits.
 510 .\"-----------------------
 511 .Ss "Raw IP Sockets"
 512 .Pp
 513 Raw
 514 .Tn IP
 515 sockets are connectionless,
 516 and are normally used with the
 517 .Xr sendto 2
 518 and
 519 .Xr recvfrom 2
 520 calls, though the
 521 .Xr connect 2
 522 call may also be used to fix the destination for future
 523 packets (in which case the
 524 .Xr read 2
 525 or
 526 .Xr recv 2
 527 and
 528 .Xr write 2
 529 or
 530 .Xr send 2
 531 system calls may be used).
 532 .Pp
 533 If
 534 .Fa proto
 535 is 0, the default protocol
 536 .Dv IPPROTO_RAW
 537 is used for outgoing
 538 packets, and only incoming packets destined for that protocol
 539 are received.
 540 If
 541 .Fa proto
 542 is non-zero, that protocol number will be used on outgoing packets
 543 and to filter incoming packets.
 544 .Pp
 545 Outgoing packets automatically have an
 546 .Tn IP
 547 header prepended to
 548 them (based on the destination address and the protocol
 549 number the socket is created with),
 550 unless the
 551 .Dv IP_HDRINCL
 552 option has been set.
 553 Incoming packets are received with
 554 .Tn IP
 555 header and options intact.
 556 .Pp
 557 .Dv IP_HDRINCL
 558 indicates the complete IP header is included with the data
 559 and may be used only with the
 560 .Dv SOCK_RAW
 561 type.
 562 .Bd -literal
 563 #include <netinet/in_systm.h>
 564 #include <netinet/ip.h>
 565
 566 int hincl = 1;                  /* 1 = on, 0 = off */
 567 setsockopt(s, IPPROTO_IP, IP_HDRINCL, &hincl, sizeof(hincl));
 568 .Ed
 569 .Pp
 570 Unlike previous
 571 .Bx
 572 releases, the program must set all
 573 the fields of the IP header, including the following:
 574 .Bd -literal
 575 ip->ip_v = IPVERSION;
 576 ip->ip_hl = hlen >> 2;
 577 ip->ip_id = 0;  /* 0 means kernel set appropriate value */
 578 ip->ip_off = offset;
 579 .Ed
 580 .Pp
 581 The
 582 .Va ip_len
 583 and
 584 .Va ip_off
 585 fields
 586 .Em must
 587 be provided in host byte order .
 588 All other fields must be provided in network byte order.
 589 See
 590 .Xr byteorder 3
 591 for more information on network byte order.
 592 If the
 593 .Va ip_id
 594 field is set to 0 then the kernel will choose an
 595 appropriate value.
 596 If the header source address is set to
 597 .Dv INADDR_ANY ,
 598 the kernel will choose an appropriate address.
 599 .Sh ERRORS
 600 A socket operation may fail with one of the following errors returned:
 601 .Bl -tag -width Er
 602 .It Bq Er EISCONN
 603 when trying to establish a connection on a socket which
 604 already has one, or when trying to send a datagram with the destination
 605 address specified and the socket is already connected;
 606 .It Bq Er ENOTCONN
 607 when trying to send a datagram, but
 608 no destination address is specified, and the socket has not been
 609 connected;
 610 .It Bq Er ENOBUFS
 611 when the system runs out of memory for
 612 an internal data structure;
 613 .It Bq Er EADDRNOTAVAIL
 614 when an attempt is made to create a
 615 socket with a network address for which no network interface
 616 exists.
 617 .It Bq Er EACCES
 618 when an attempt is made to create
 619 a raw IP socket by a non-privileged process.
 620 .El
 621 .Pp
 622 The following errors specific to
 623 .Tn IP
 624 may occur when setting or getting
 625 .Tn IP
 626 options:
 627 .Bl -tag -width Er
 628 .It Bq Er EINVAL
 629 An unknown socket option name was given.
 630 .It Bq Er EINVAL
 631 The IP option field was improperly formed;
 632 an option field was shorter than the minimum value
 633 or longer than the option buffer provided.
 634 .El
 635 .Pp
 636 The following errors may occur when attempting to send
 637 .Tn IP
 638 datagrams via a
 639 .Dq raw socket
 640 with the
 641 .Dv IP_HDRINCL
 642 option set:
 643 .Bl -tag -width Er
 644 .It Bq Er EINVAL
 645 The user-supplied
 646 .Va ip_len
 647 field was not equal to the length of the datagram written to the socket.
 648 .El
 649 .Sh SEE ALSO
 650 .Xr getsockopt 2 ,
 651 .Xr recv 2 ,
 652 .Xr send 2 ,
 653 .Xr byteorder 3 ,
 654 .Xr icmp 4 ,
 655 .Xr inet 4 ,
 656 .Xr intro 4
 657 .Sh HISTORY
 658 The
 659 .Nm
 660 protocol appeared in
 661 .Bx 4.2 .