usr.sbin/arp/arp.4

   1 .\" Copyright (c) 1985, 1986, 1988, 1994
   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 .\" 4. 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 .\"     @(#)arp4.4      6.5 (Berkeley) 4/18/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 7, 2016
  32 .Dt ARP 4
  33 .Os
  34 .Sh NAME
  35 .Nm arp
  36 .Nd Address Resolution Protocol
  37 .Sh SYNOPSIS
  38 .Cd "device ether"
  39 .Sh DESCRIPTION
  40 The Address Resolution Protocol (ARP) is used to dynamically
  41 map between Protocol Addresses (such as IP addresses) and
  42 Local Network Addresses (such as Ethernet addresses).
  43 This implementation maps IP addresses to Ethernet,
  44 ARCnet,
  45 or Token Ring addresses.
  46 It is used by all the Ethernet interface drivers.
  47 .Pp
  48 ARP caches Internet-Ethernet address mappings.
  49 When an interface requests a mapping for an address not in the cache,
  50 ARP queues the message which requires the mapping and broadcasts
  51 a message on the associated network requesting the address mapping.
  52 If a response is provided, the new mapping is cached and any pending
  53 message is transmitted.
  54 ARP will queue at most one packet while waiting for a response to a
  55 mapping request;
  56 only the most recently ``transmitted'' packet is kept.
  57 If the target host does not respond after several requests,
  58 the host is considered to be down allowing an error to be returned to
  59 transmission attempts.
  60 Further demand for this mapping causes ARP request retransmissions, that
  61 are ratelimited to one packet per second.
  62 The error is
  63 .Er EHOSTDOWN
  64 for a non-responding destination host, and
  65 .Er EHOSTUNREACH
  66 for a non-responding router.
  67 .Pp
  68 The ARP cache is stored in the system routing table as
  69 dynamically-created host routes.
  70 The route to a directly-attached Ethernet network is installed as a
  71 .Dq cloning
  72 route (one with the
  73 .Li RTF_CLONING
  74 flag set),
  75 causing routes to individual hosts on that network to be created on
  76 demand.
  77 These routes time out periodically (normally 20 minutes after validated;
  78 entries are not validated when not in use).
  79 .Pp
  80 ARP entries may be added, deleted or changed with the
  81 .Xr arp 8
  82 utility.
  83 Manually-added entries may be temporary or permanent,
  84 and may be
  85 .Dq published ,
  86 in which case the system will respond to ARP requests for that host
  87 as if it were the target of the request.
  88 .Pp
  89 In the past,
  90 ARP was used to negotiate the use of a trailer encapsulation.
  91 This is no longer supported.
  92 .Pp
  93 ARP watches passively for hosts impersonating the local host (i.e., a host
  94 which responds to an ARP mapping request for the local host's address).
  95 .Pp
  96 Proxy ARP is a feature whereby the local host will respond to requests
  97 for addresses other than itself, with its own address.
  98 Normally, proxy ARP in
  99 .Fx
 100 is set up on a host-by-host basis using the
 101 .Xr arp 8
 102 utility, by adding an entry for each host inside a given subnet for
 103 which proxying of ARP requests is desired.
 104 However, the
 105 .Dq "proxy all"
 106 feature causes the local host to act as a proxy for
 107 .Em all
 108 hosts reachable through some other network interface,
 109 different from the one the request came in from.
 110 It may be enabled by setting the
 111 .Xr sysctl 8
 112 MIB variable
 113 .Va net.link.ether.inet.proxyall
 114 to 1.
 115 .Sh MIB Variables
 116 The ARP protocol implements a number of configurable variables in
 117 .Va net.link.ether.inet
 118 branch
 119 of the
 120 .Xr sysctl 3
 121 MIB.
 122 .Bl -tag -width "log_arp_permanent_modify"
 123 .It Va allow_multicast
 124 Install ARP entries with the multicast bit set in the hardware address.
 125 Installing such entries is an RFC 1812 violation, but some proprietary load
 126 balancing techniques require routers to do so.
 127 Turned off by default.
 128 .It Va garp_rexmit_count
 129 Retransmit gratuitous ARP (GARP) packets when an IPv4 address is added to an
 130 interface.
 131 A GARP is always transmitted when an IPv4 address is added to an interface.
 132 A non-zero value causes the GARP packet to be retransmitted the stated number
 133 of times.
 134 The interval between retransmissions is doubled each time, so the
 135 retransmission intervals are: {1, 2, 4, 8, 16, ...} (seconds).
 136 The default value of zero means only the initial GARP is sent; no
 137 additional GARP packets are retransmitted.
 138 The maximum value is sixteen.
 139 .Pp
 140 The default behavior of a single GARP packet is usually sufficient.
 141 However, a single GARP might be dropped or lost in some circumstances.
 142 This is particularly harmful when a shared address is passed between cluster
 143 nodes.
 144 Neighbors on the network link might then work with a stale ARP cache and send
 145 packets destined for that address to the node that previously owned the
 146 address, which might not respond.
 147 .It Va log_arp_movements
 148 Log movements of IP addresses from one hardware address to another.
 149 See
 150 .Sx DIAGNOSTICS
 151 below.
 152 Turned on by default.
 153 .It Va log_arp_permanent_modify
 154 Log attempts by a remote host to modify a permanent ARP entry.
 155 See
 156 .Sx DIAGNOSTICS
 157 below.
 158 Turned on by default.
 159 .It Va log_arp_wrong_iface
 160 Log attempts to insert an ARP entry on an interface when the IP network to
 161 which the address belongs is connected to another interface.
 162 See
 163 .Sx DIAGNOSTICS
 164 below.
 165 Turned on by default.
 166 .It Va max_log_per_second
 167 Limit the number of remotely triggered logging events to a configured value per
 168 second.
 169 Default is 1 log message per second.
 170 .It Va max_age
 171 How long an ARP entry is held in the cache until it needs to be refreshed.
 172 Default is 1200 seconds.
 173 .It Va maxhold
 174 How many packets to hold in the per-entry output queue while the entry
 175 is being resolved.
 176 Default is one packet.
 177 .It Va maxtries
 178 Number of retransmits before a host is considered down and an error is
 179 returned.
 180 Default is 5 tries.
 181 .It Va proxyall
 182 Enables ARP proxying.
 183 Turned off by default.
 184 .It Va useloopback
 185 If an ARP entry is added for local address, force the traffic to go through
 186 the loopback interface.
 187 Turned on by default.
 188 .It Va wait
 189 Lifetime of an incomplete ARP entry.
 190 Default is 20 seconds.
 191 .El
 192 .Sh DIAGNOSTICS
 193 .Bl -diag
 194 .It "arp: %x:%x:%x:%x:%x:%x is using my IP address %d.%d.%d.%d on %s!"
 195 ARP has discovered another host on the local network which responds to
 196 mapping requests for its own Internet address with a different Ethernet
 197 address, generally indicating that two hosts are attempting to use the
 198 same Internet address.
 199 .It "arp: link address is broadcast for IP address %d.%d.%d.%d!"
 200 ARP requested information for a host, and received an answer indicating
 201 that the host's ethernet address is the ethernet broadcast address.
 202 This indicates a misconfigured or broken device.
 203 .It "arp: %d.%d.%d.%d moved from %x:%x:%x:%x:%x:%x to %x:%x:%x:%x:%x:%x on %s"
 204 ARP had a cached value for the ethernet address of the referenced host,
 205 but received a reply indicating that the host is at a new address.
 206 This can happen normally when host hardware addresses change,
 207 or when a mobile node arrives or leaves the local subnet.
 208 It can also indicate a problem with proxy ARP.
 209 This message can only be issued if the sysctl
 210 .Va net.link.ether.inet.log_arp_movements
 211 is set to 1, which is the system's default behaviour.
 212 .It "arpresolve: can't allocate llinfo for %d.%d.%d.%d"
 213 The route for the referenced host points to a device upon which ARP is
 214 required, but ARP was unable to allocate a routing table entry in which
 215 to store the host's MAC address.
 216 This usually points to a misconfigured routing table.
 217 It can also occur if the kernel cannot allocate memory.
 218 .It "arp: %d.%d.%d.%d is on if0 but got reply from %x:%x:%x:%x:%x:%x on if1"
 219 Physical connections exist to the same logical IP network on both if0 and if1.
 220 It can also occur if an entry already exists in the ARP cache for the IP
 221 address above, and the cable has been disconnected from if0, then reconnected
 222 to if1.
 223 This message can only be issued if the sysctl
 224 .Va net.link.ether.inet.log_arp_wrong_iface
 225 is set to 1, which is the system's default behaviour.
 226 .It "arp: %x:%x:%x:%x:%x:%x attempts to modify permanent entry for %d.%d.%d.%d on %s"
 227 ARP has received an ARP reply that attempts to overwrite a permanent
 228 entry in the local ARP table.
 229 This error will only be logged if the sysctl
 230 .Va net.link.ether.inet.log_arp_permanent_modify
 231 is set to 1, which is the system's default behaviour.
 232 .It "arp: %x:%x:%x:%x:%x:%x is multicast"
 233 Kernel refused to install an entry with multicast hardware address.
 234 If you really want such addresses being installed, set the sysctl
 235 .Va net.link.ether.inet.allow_multicast
 236 to a positive value.
 237 .El
 238 .Sh SEE ALSO
 239 .Xr inet 4 ,
 240 .Xr route 4 ,
 241 .Xr arp 8 ,
 242 .Xr ifconfig 8 ,
 243 .Xr route 8 ,
 244 .Xr sysctl 8
 245 .Rs
 246 .%A Plummer, D.
 247 .%B "An Ethernet Address Resolution Protocol"
 248 .%T RFC826
 249 .Re
 250 .Rs
 251 .%A Leffler, S.J.
 252 .%A Karels, M.J.
 253 .%B "Trailer Encapsulations"
 254 .%T RFC893
 255 .Re