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 June 14, 2004
  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 If the
 117 .Dv IP_RECVDSTADDR
 118 option is enabled on a
 119 .Dv SOCK_DGRAM
 120 socket,
 121 the
 122 .Xr recvmsg 2
 123 call will return the destination
 124 .Tn IP
 125 address for a
 126 .Tn UDP
 127 datagram.
 128 The
 129 .Vt msg_control
 130 field in the
 131 .Vt msghdr
 132 structure points to a buffer
 133 that contains a
 134 .Vt cmsghdr
 135 structure followed by the
 136 .Tn IP
 137 address.
 138 The
 139 .Vt cmsghdr
 140 fields have the following values:
 141 .Bd -literal
 142 cmsg_len = sizeof(struct in_addr)
 143 cmsg_level = IPPROTO_IP
 144 cmsg_type = IP_RECVDSTADDR
 145 .Ed
 146 .Pp
 147 The source address to be used for outgoing
 148 .Tn UDP
 149 datagrams on a socket that is not bound to a specific
 150 .Tn IP
 151 address can be specified as ancillary data with a type code of
 152 .Dv IP_SENDSRCADDR .
 153 The msg_control field in the msghdr structure should point to a buffer
 154 that contains a
 155 .Vt cmsghdr
 156 structure followed by the
 157 .Tn IP
 158 address.
 159 The cmsghdr fields should have the following values:
 160 .Bd -literal
 161 cmsg_len = sizeof(struct in_addr)
 162 cmsg_level = IPPROTO_IP
 163 cmsg_type = IP_SENDSRCADDR
 164 .Ed
 165 .Pp
 166 For convenience,
 167 .Dv IP_SENDSRCADDR
 168 is defined to have the same value as
 169 .Dv IP_RECVDSTADDR ,
 170 so the
 171 .Dv IP_RECVDSTADDR
 172 control message from
 173 .Xr recvmsg 2
 174 can be used directly as a control message for
 175 .Xr sendmsg 2 .
 176 .Pp
 177 If the
 178 .Dv IP_ONESBCAST
 179 option is enabled on a
 180 .Dv SOCK_DGRAM
 181 or a
 182 .Dv SOCK_RAW
 183 socket, the destination address of outgoing
 184 broadcast datagrams on that socket will be forced
 185 to the undirected broadcast address,
 186 .Dv INADDR_BROADCAST ,
 187 before transmission.
 188 This is in contrast to the default behavior of the
 189 system, which is to transmit undirected broadcasts
 190 via the first network interface with the
 191 .Dv IFF_BROADCAST flag set.
 192 .Pp
 193 This option allows applications to choose which
 194 interface is used to transmit an undirected broadcast
 195 datagram.
 196 For example, the following code would force an
 197 undirected broadcast to be transmitted via the interface
 198 configured with the broadcast address 192.168.2.255:
 199 .Bd -literal
 200 char msg[512];
 201 struct sockaddr_in sin;
 202 u_char onesbcast = 1;   /* 0 = disable (default), 1 = enable */
 203
 204 setsockopt(s, IPPROTO_IP, IP_ONESBCAST, &onesbcast, sizeof(onesbcast));
 205 sin.sin_addr.s_addr = inet_addr("192.168.2.255");
 206 sin.sin_port = htons(1234);
 207 sendto(s, msg, sizeof(msg), 0, &sin, sizeof(sin));
 208 .Ed
 209 .Pp
 210 It is the application's responsibility to set the
 211 .Dv IP_TTL option
 212 to an appropriate value in order to prevent broadcast storms.
 213 The application must have sufficient credentials to set the
 214 .Dv SO_BROADCAST
 215 socket level option, otherwise the
 216 .Dv IP_ONESBCAST option has no effect.
 217 .Pp
 218 If the
 219 .Dv IP_RECVTTL
 220 option is enabled on a
 221 .Dv SOCK_DGRAM
 222 socket, the
 223 .Xr recvmsg 2
 224 call will return the
 225 .Tn IP
 226 .Tn TTL
 227 (time to live) field for a
 228 .Tn UDP
 229 datagram.
 230 The msg_control field in the msghdr structure points to a buffer
 231 that contains a cmsghdr structure followed by the
 232 .Tn TTL .
 233 The cmsghdr fields have the following values:
 234 .Bd -literal
 235 cmsg_len = sizeof(u_char)
 236 cmsg_level = IPPROTO_IP
 237 cmsg_type = IP_RECVTTL
 238 .Ed
 239 .Pp
 240 If the
 241 .Dv IP_RECVIF
 242 option is enabled on a
 243 .Dv SOCK_DGRAM
 244 socket, the
 245 .Xr recvmsg 2
 246 call returns a
 247 .Vt "struct sockaddr_dl"
 248 corresponding to the interface on which the
 249 packet was received.
 250 The
 251 .Va msg_control
 252 field in the
 253 .Vt msghdr
 254 structure points to a buffer that contains a
 255 .Vt cmsghdr
 256 structure followed by the
 257 .Vt "struct sockaddr_dl" .
 258 The
 259 .Vt cmsghdr
 260 fields have the following values:
 261 .Bd -literal
 262 cmsg_len = sizeof(struct sockaddr_dl)
 263 cmsg_level = IPPROTO_IP
 264 cmsg_type = IP_RECVIF
 265 .Ed
 266 .Pp
 267 .Dv IP_PORTRANGE
 268 may be used to set the port range used for selecting a local port number
 269 on a socket with an unspecified (zero) port number.
 270 It has the following
 271 possible values:
 272 .Bl -tag -width IP_PORTRANGE_DEFAULT
 273 .It Dv IP_PORTRANGE_DEFAULT
 274 use the default range of values, normally
 275 .Dv IPPORT_HIFIRSTAUTO
 276 through
 277 .Dv IPPORT_HILASTAUTO .
 278 This is adjustable through the sysctl setting:
 279 .Va net.inet.ip.portrange.first
 280 and
 281 .Va net.inet.ip.portrange.last .
 282 .It Dv IP_PORTRANGE_HIGH
 283 use a high range of values, normally
 284 .Dv IPPORT_HIFIRSTAUTO
 285 and
 286 .Dv IPPORT_HILASTAUTO .
 287 This is adjustable through the sysctl setting:
 288 .Va net.inet.ip.portrange.hifirst
 289 and
 290 .Va net.inet.ip.portrange.hilast .
 291 .It Dv IP_PORTRANGE_LOW
 292 use a low range of ports, which are normally restricted to
 293 privileged processes on
 294 .Ux
 295 systems.
 296 The range is normally from
 297 .Dv IPPORT_RESERVED
 298 \- 1 down to
 299 .Li IPPORT_RESERVEDSTART
 300 in descending order.
 301 This is adjustable through the sysctl setting:
 302 .Va net.inet.ip.portrange.lowfirst
 303 and
 304 .Va net.inet.ip.portrange.lowlast .
 305 .El
 306 .Pp
 307 The range of privileged ports which only may be opened by
 308 root-owned processes may be modified by the
 309 .Va net.inet.ip.portrange.reservedlow
 310 and
 311 .Va net.inet.ip.portrange.reservedhigh
 312 sysctl settings.
 313 The values default to the traditional range,
 314 0 through
 315 .Dv IPPORT_RESERVED
 316 \- 1
 317 (0 through 1023), respectively.
 318 Note that these settings do not affect and are not accounted for in the
 319 use or calculation of the other
 320 .Va net.inet.ip.portrange
 321 values above.
 322 Changing these values departs from
 323 .Ux
 324 tradition and has security
 325 consequences that the administrator should carefully evaluate before
 326 modifying these settings.
 327 .Pp
 328 Ports are allocated at random within the specified port range in order
 329 to increase the difficulty of random spoofing attacks.
 330 In scenarios such as benchmarking, this behavior may be undesirable.
 331 In these cases,
 332 .Va net.inet.ip.portrange.randomized
 333 can be used to toggle randomization off.
 334 .Ss "Multicast Options"
 335 .Pp
 336 .Tn IP
 337 multicasting is supported only on
 338 .Dv AF_INET
 339 sockets of type
 340 .Dv SOCK_DGRAM
 341 and
 342 .Dv SOCK_RAW ,
 343 and only on networks where the interface
 344 driver supports multicasting.
 345 .Pp
 346 The
 347 .Dv IP_MULTICAST_TTL
 348 option changes the time-to-live (TTL)
 349 for outgoing multicast datagrams
 350 in order to control the scope of the multicasts:
 351 .Bd -literal
 352 u_char ttl;     /* range: 0 to 255, default = 1 */
 353 setsockopt(s, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl));
 354 .Ed
 355 .Pp
 356 Datagrams with a TTL of 1 are not forwarded beyond the local network.
 357 Multicast datagrams with a TTL of 0 will not be transmitted on any network,
 358 but may be delivered locally if the sending host belongs to the destination
 359 group and if multicast loopback has not been disabled on the sending socket
 360 (see below).
 361 Multicast datagrams with TTL greater than 1 may be forwarded
 362 to other networks if a multicast router is attached to the local network.
 363 .Pp
 364 For hosts with multiple interfaces, each multicast transmission is
 365 sent from the primary network interface.
 366 The
 367 .Dv IP_MULTICAST_IF
 368 option overrides the default for
 369 subsequent transmissions from a given socket:
 370 .Bd -literal
 371 struct in_addr addr;
 372 setsockopt(s, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr));
 373 .Ed
 374 .Pp
 375 where "addr" is the local
 376 .Tn IP
 377 address of the desired interface or
 378 .Dv INADDR_ANY
 379 to specify the default interface.
 380 An interface's local IP address and multicast capability can
 381 be obtained via the
 382 .Dv SIOCGIFCONF
 383 and
 384 .Dv SIOCGIFFLAGS
 385 ioctls.
 386 Normal applications should not need to use this option.
 387 .Pp
 388 If a multicast datagram is sent to a group to which the sending host itself
 389 belongs (on the outgoing interface), a copy of the datagram is, by default,
 390 looped back by the IP layer for local delivery.
 391 The
 392 .Dv IP_MULTICAST_LOOP
 393 option gives the sender explicit control
 394 over whether or not subsequent datagrams are looped back:
 395 .Bd -literal
 396 u_char loop;    /* 0 = disable, 1 = enable (default) */
 397 setsockopt(s, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop));
 398 .Ed
 399 .Pp
 400 This option
 401 improves performance for applications that may have no more than one
 402 instance on a single host (such as a router daemon), by eliminating
 403 the overhead of receiving their own transmissions.
 404 It should generally not
 405 be used by applications for which there may be more than one instance on a
 406 single host (such as a conferencing program) or for which the sender does
 407 not belong to the destination group (such as a time querying program).
 408 .Pp
 409 A multicast datagram sent with an initial TTL greater than 1 may be delivered
 410 to the sending host on a different interface from that on which it was sent,
 411 if the host belongs to the destination group on that other interface.
 412 The loopback control option has no effect on such delivery.
 413 .Pp
 414 A host must become a member of a multicast group before it can receive
 415 datagrams sent to the group.
 416 To join a multicast group, use the
 417 .Dv IP_ADD_MEMBERSHIP
 418 option:
 419 .Bd -literal
 420 struct ip_mreq mreq;
 421 setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq));
 422 .Ed
 423 .Pp
 424 where
 425 .Fa mreq
 426 is the following structure:
 427 .Bd -literal
 428 struct ip_mreq {
 429     struct in_addr imr_multiaddr; /* IP multicast address of group */
 430     struct in_addr imr_interface; /* local IP address of interface */
 431 }
 432 .Ed
 433 .Pp
 434 .Va imr_interface
 435 should be set to
 436 .Dv INADDR_ANY
 437 to choose the default multicast interface,
 438 or the
 439 .Tn IP
 440 address of a particular multicast-capable interface if
 441 the host is multihomed.
 442 Since
 443 .Fx 4.4 ,
 444 if the
 445 .Va imr_interface
 446 member is within the network range
 447 .Li 0.0.0.0/8 ,
 448 it is treated as an interface index in the system interface MIB,
 449 as per the RIP Version 2 MIB Extension (RFC-1724).
 450 .Pp
 451 Membership is associated with a single interface;
 452 programs running on multihomed hosts may need to
 453 join the same group on more than one interface.
 454 Up to
 455 .Dv IP_MAX_MEMBERSHIPS
 456 (currently 20) memberships may be added on a
 457 single socket.
 458 .Pp
 459 To drop a membership, use:
 460 .Bd -literal
 461 struct ip_mreq mreq;
 462 setsockopt(s, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq));
 463 .Ed
 464 .Pp
 465 where
 466 .Fa mreq
 467 contains the same values as used to add the membership.
 468 Memberships are dropped when the socket is closed or the process exits.
 469 .\"-----------------------
 470 .Ss "Raw IP Sockets"
 471 .Pp
 472 Raw
 473 .Tn IP
 474 sockets are connectionless,
 475 and are normally used with the
 476 .Xr sendto 2
 477 and
 478 .Xr recvfrom 2
 479 calls, though the
 480 .Xr connect 2
 481 call may also be used to fix the destination for future
 482 packets (in which case the
 483 .Xr read 2
 484 or
 485 .Xr recv 2
 486 and
 487 .Xr write 2
 488 or
 489 .Xr send 2
 490 system calls may be used).
 491 .Pp
 492 If
 493 .Fa proto
 494 is 0, the default protocol
 495 .Dv IPPROTO_RAW
 496 is used for outgoing
 497 packets, and only incoming packets destined for that protocol
 498 are received.
 499 If
 500 .Fa proto
 501 is non-zero, that protocol number will be used on outgoing packets
 502 and to filter incoming packets.
 503 .Pp
 504 Outgoing packets automatically have an
 505 .Tn IP
 506 header prepended to
 507 them (based on the destination address and the protocol
 508 number the socket is created with),
 509 unless the
 510 .Dv IP_HDRINCL
 511 option has been set.
 512 Incoming packets are received with
 513 .Tn IP
 514 header and options intact.
 515 .Pp
 516 .Dv IP_HDRINCL
 517 indicates the complete IP header is included with the data
 518 and may be used only with the
 519 .Dv SOCK_RAW
 520 type.
 521 .Bd -literal
 522 #include <netinet/in_systm.h>
 523 #include <netinet/ip.h>
 524
 525 int hincl = 1;                  /* 1 = on, 0 = off */
 526 setsockopt(s, IPPROTO_IP, IP_HDRINCL, &hincl, sizeof(hincl));
 527 .Ed
 528 .Pp
 529 Unlike previous
 530 .Bx
 531 releases, the program must set all
 532 the fields of the IP header, including the following:
 533 .Bd -literal
 534 ip->ip_v = IPVERSION;
 535 ip->ip_hl = hlen >> 2;
 536 ip->ip_id = 0;  /* 0 means kernel set appropriate value */
 537 ip->ip_off = offset;
 538 .Ed
 539 .Pp
 540 The
 541 .Va ip_len
 542 and
 543 .Va ip_off
 544 fields
 545 .Em must
 546 be provided in host byte order .
 547 All other fields must be provided in network byte order.
 548 See
 549 .Xr byteorder 4
 550 for more information on network byte order.
 551 If the
 552 .Va ip_id
 553 field is set to 0 then the kernel will choose an
 554 appropriate value.
 555 If the header source address is set to
 556 .Dv INADDR_ANY ,
 557 the kernel will choose an appropriate address.
 558 .Sh ERRORS
 559 A socket operation may fail with one of the following errors returned:
 560 .Bl -tag -width Er
 561 .It Bq Er EISCONN
 562 when trying to establish a connection on a socket which
 563 already has one, or when trying to send a datagram with the destination
 564 address specified and the socket is already connected;
 565 .It Bq Er ENOTCONN
 566 when trying to send a datagram, but
 567 no destination address is specified, and the socket hasn't been
 568 connected;
 569 .It Bq Er ENOBUFS
 570 when the system runs out of memory for
 571 an internal data structure;
 572 .It Bq Er EADDRNOTAVAIL
 573 when an attempt is made to create a
 574 socket with a network address for which no network interface
 575 exists.
 576 .It Bq Er EACCES
 577 when an attempt is made to create
 578 a raw IP socket by a non-privileged process.
 579 .El
 580 .Pp
 581 The following errors specific to
 582 .Tn IP
 583 may occur when setting or getting
 584 .Tn IP
 585 options:
 586 .Bl -tag -width Er
 587 .It Bq Er EINVAL
 588 An unknown socket option name was given.
 589 .It Bq Er EINVAL
 590 The IP option field was improperly formed;
 591 an option field was shorter than the minimum value
 592 or longer than the option buffer provided.
 593 .El
 594 .Pp
 595 The following errors may occur when attempting to send
 596 .Tn IP
 597 datagrams via a
 598 .Dq raw socket
 599 with the
 600 .Dv IP_HDRINCL
 601 option set:
 602 .Bl -tag -width Er
 603 .It Bq Er EINVAL
 604 The user-supplied
 605 .Va ip_len
 606 field was not equal to the length of the datagram written to the socket.
 607 .El
 608 .Sh SEE ALSO
 609 .Xr getsockopt 2 ,
 610 .Xr recv 2 ,
 611 .Xr send 2 ,
 612 .Xr byteorder 4 ,
 613 .Xr icmp 4 ,
 614 .Xr inet 4 ,
 615 .Xr intro 4
 616 .Sh HISTORY
 617 The
 618 .Nm
 619 protocol appeared in
 620 .Bx 4.2 .