share/man/man4/bridge.4

   1 .\"     $NetBSD: bridge.4,v 1.5 2004/01/31 20:14:11 jdc Exp $
   2 .\"
   3 .\" Copyright 2001 Wasabi Systems, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Written by Jason R. Thorpe for Wasabi Systems, Inc.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed for the NetBSD Project by
  19 .\"     Wasabi Systems, Inc.
  20 .\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
  21 .\"    or promote products derived from this software without specific prior
  22 .\"    written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  26 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
  28 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34 .\" POSSIBILITY OF SUCH DAMAGE.
  35 .\"
  36 .\" $FreeBSD$
  37 .\"
  38 .Dd July 27, 2013
  39 .Dt IF_BRIDGE 4
  40 .Os
  41 .Sh NAME
  42 .Nm if_bridge
  43 .Nd network bridge device
  44 .Sh SYNOPSIS
  45 To compile this driver into the kernel,
  46 place the following line in your
  47 kernel configuration file:
  48 .Bd -ragged -offset indent
  49 .Cd "device if_bridge"
  50 .Ed
  51 .Pp
  52 Alternatively, to load the driver as a
  53 module at boot time, place the following lines in
  54 .Xr loader.conf 5 :
  55 .Bd -literal -offset indent
  56 if_bridge_load="YES"
  57 bridgestp_load="YES"
  58 .Ed
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 driver creates a logical link between two or more IEEE 802 networks
  63 that use the same (or
  64 .Dq "similar enough" )
  65 framing format.
  66 For example, it is possible to bridge Ethernet and 802.11 networks together,
  67 but it is not possible to bridge Ethernet and Token Ring together.
  68 .Pp
  69 Each
  70 .Nm
  71 interface is created at runtime using interface cloning.
  72 This is
  73 most easily done with the
  74 .Xr ifconfig 8
  75 .Cm create
  76 command or using the
  77 .Va cloned_interfaces
  78 variable in
  79 .Xr rc.conf 5 .
  80 .Pp
  81 The
  82 .Nm
  83 interface randomly chooses a link (MAC) address in the range reserved for
  84 locally administered addresses when it is created.
  85 This address is guaranteed to be unique
  86 .Em only
  87 across all
  88 .Nm
  89 interfaces on the local machine.
  90 Thus you can theoretically have two bridges on the different machines with
  91 the same link addresses.
  92 The address can be changed by assigning the desired link address using
  93 .Xr ifconfig 8 .
  94 .Pp
  95 If
  96 .Xr sysctl 8
  97 node
  98 .Va net.link.bridge.inherit_mac
  99 has non-zero value, newly created bridge will inherit MAC address
 100 from its first member instead of choosing random link-level address.
 101 This will provide more predictable bridge MAC without any
 102 additional configuration, but currently this feature is known
 103 to break some L2 protocols, for example PPPoE that is provided
 104 by
 105 .Xr ng_pppoe 4
 106 and
 107 .Xr ppp 8 .
 108 Now this feature is considered as experimental and is turned off
 109 by-default.
 110 .Pp
 111 A bridge can be used to provide several services, such as a simple
 112 802.11-to-Ethernet bridge for wireless hosts, and traffic isolation.
 113 .Pp
 114 A bridge works like a switch, forwarding traffic from one interface
 115 to another.
 116 Multicast and broadcast packets are always forwarded to all
 117 interfaces that are part of the bridge.
 118 For unicast traffic, the bridge learns which MAC addresses are associated
 119 with which interfaces and will forward the traffic selectively.
 120 .Pp
 121 All the bridged member interfaces need to be up in order to pass network traffic.
 122 These can be enabled using
 123 .Xr ifconfig 8
 124 or
 125 .Va ifconfig_ Ns Ao Ar interface Ac Ns Li ="up"
 126 in
 127 .Xr rc.conf 5 .
 128 .Pp
 129 The MTU of the first member interface to be added is used as the bridge MTU.
 130 All additional members are required to have exactly the same value.
 131 .Pp
 132 The TXCSUM capability is disabled for any interface added to the bridge, and it
 133 is restored when the interface is removed again.
 134 .Pp
 135 The bridge supports
 136 .Dq monitor mode ,
 137 where the packets are discarded after
 138 .Xr bpf 4
 139 processing, and are not processed or forwarded further.
 140 This can be used to multiplex the input of two or more interfaces into a single
 141 .Xr bpf 4
 142 stream.
 143 This is useful for reconstructing the traffic for network taps
 144 that transmit the RX/TX signals out through two separate interfaces.
 145 .Sh IPV6 SUPPORT
 146 .Nm
 147 supports the
 148 .Li AF_INET6
 149 address family on bridge interfaces.
 150 The following
 151 .Xr rc.conf 5
 152 variable configures an IPv6 link-local address on
 153 .Li bridge0
 154 interface:
 155 .Bd -literal -offset indent
 156 ifconfig_bridge0_ipv6="up"
 157 .Ed
 158 .Pp
 159 or in a more explicit manner:
 160 .Bd -literal -offset indent
 161 ifconfig_bridge0_ipv6="inet6 auto_linklocal"
 162 .Ed
 163 .Pp
 164 However, the
 165 .Li AF_INET6
 166 address family has a concept of scope zone.
 167 Bridging multiple interfaces change the zone configuration because
 168 multiple links are merged to each other and form a new single link
 169 while the member interfaces still work individually.
 170 This means each member interface still has a separate link-local scope
 171 zone and the
 172 .Nm
 173 interface has another single,
 174 aggregated link-local scope zone at the same time.
 175 This situation is clearly against the description
 176 .Qq zones of the same scope cannot overlap
 177 in Section 5,
 178 RFC 4007.
 179 Although it works in most cases,
 180 it can cause some conterintuitive or undesirable behavior in some
 181 edge cases when both of the
 182 .Nm
 183 interface and one of the member interface have an IPv6 address
 184 and applications use both of them.
 185 .Pp
 186 To prevent this situation,
 187 .Nm
 188 checks whether a link-local scoped IPv6 address is configured on
 189 a member interface to be added and the
 190 .Nm
 191 interface.
 192 When the
 193 .Nm
 194 interface has IPv6 addresses,
 195 IPv6 addresses on the member interface will be automatically removed
 196 before the interface is added.
 197 .Pp
 198 This behavior can be disabled by setting
 199 .Xr sysctl 8
 200 variable
 201 .Va net.link.bridge.allow_llz_overlap
 202 to
 203 .Li 1 .
 204 .Pp
 205 Note that
 206 .Li ACCEPT_RTADV
 207 and
 208 .Li AUTO_LINKLOCAL
 209 interface flag are not enabled by default on
 210 .Nm
 211 interface even when
 212 .Va net.inet6.ip6.accept_rtadv
 213 and/or
 214 .Va net.inet6.ip6.auto_linklocal
 215 is set to
 216 .Li 1 .
 217 .Sh SPANNING TREE
 218 The
 219 .Nm
 220 driver implements the Rapid Spanning Tree Protocol (RSTP or 802.1w) with
 221 backwards compatibility with the legacy Spanning Tree Protocol (STP).
 222 Spanning Tree is used to detect and remove loops in a network topology.
 223 .Pp
 224 RSTP provides faster spanning tree convergence than legacy STP, the protocol
 225 will exchange information with neighbouring switches to quickly transition to
 226 forwarding without creating loops.
 227 .Pp
 228 The code will default to RSTP mode but will downgrade any port connected to a
 229 legacy STP network so is fully backward compatible.
 230 A bridge can be forced to operate in STP mode without rapid state transitions
 231 via the
 232 .Va proto
 233 command in
 234 .Xr ifconfig 8 .
 235 .Pp
 236 The bridge can log STP port changes to
 237 .Xr syslog 3
 238 by enabling the
 239 .Va net.link.bridge.log_stp
 240 variable using
 241 .Xr sysctl 8 .
 242 .Sh PACKET FILTERING
 243 Packet filtering can be used with any firewall package that hooks in via the
 244 .Xr pfil 9
 245 framework.
 246 When filtering is enabled, bridged packets will pass through the filter
 247 inbound on the originating interface, on the bridge interface and outbound on
 248 the appropriate interfaces.
 249 Either stage can be disabled.
 250 The filtering behaviour can be controlled using
 251 .Xr sysctl 8 :
 252 .Bl -tag -width ".Va net.link.bridge.pfil_onlyip"
 253 .It Va net.link.bridge.pfil_onlyip
 254 Controls the handling of non-IP packets which are not passed to
 255 .Xr pfil 9 .
 256 Set to
 257 .Li 1
 258 to only allow IP packets to pass (subject to firewall rules), set to
 259 .Li 0
 260 to unconditionally pass all non-IP Ethernet frames.
 261 .It Va net.link.bridge.pfil_member
 262 Set to
 263 .Li 1
 264 to enable filtering on the incoming and outgoing member interfaces, set
 265 to
 266 .Li 0
 267 to disable it.
 268 .It Va net.link.bridge.pfil_bridge
 269 Set to
 270 .Li 1
 271 to enable filtering on the bridge interface, set
 272 to
 273 .Li 0
 274 to disable it.
 275 .It Va net.link.bridge.pfil_local_phys
 276 Set to
 277 .Li 1
 278 to additionally filter on the physical interface for locally destined packets.
 279 Set to
 280 .Li 0
 281 to disable this feature.
 282 .It Va net.link.bridge.ipfw
 283 Set to
 284 .Li 1
 285 to enable layer2 filtering with
 286 .Xr ipfirewall 4 ,
 287 set to
 288 .Li 0
 289 to disable it.
 290 This needs to be enabled for
 291 .Xr dummynet 4
 292 support.
 293 When
 294 .Va ipfw
 295 is enabled,
 296 .Va pfil_bridge
 297 and
 298 .Va pfil_member
 299 will be disabled so that IPFW
 300 is not run twice; these can be re-enabled if desired.
 301 .It Va net.link.bridge.ipfw_arp
 302 Set to
 303 .Li 1
 304 to enable layer2 ARP filtering with
 305 .Xr ipfirewall 4 ,
 306 set to
 307 .Li 0
 308 to disable it.
 309 Requires
 310 .Va ipfw
 311 to be enabled.
 312 .El
 313 .Pp
 314 ARP and REVARP packets are forwarded without being filtered and others
 315 that are not IP nor IPv6 packets are not forwarded when
 316 .Va pfil_onlyip
 317 is enabled.
 318 IPFW can filter Ethernet types using
 319 .Cm mac-type
 320 so all packets are passed to
 321 the filter for processing.
 322 .Pp
 323 The packets originating from the bridging host will be seen by
 324 the filter on the interface that is looked up in the routing
 325 table.
 326 .Pp
 327 The packets destined to the bridging host will be seen by the filter
 328 on the interface with the MAC address equal to the packet's destination
 329 MAC.
 330 There are situations when some of the bridge members are sharing
 331 the same MAC address (for example the
 332 .Xr vlan 4
 333 interfaces: they are currently sharing the
 334 MAC address of the parent physical interface).
 335 It is not possible to distinguish between these interfaces using
 336 their MAC address, excluding the case when the packet's destination
 337 MAC address is equal to the MAC address of the interface on which
 338 the packet was entered to the system.
 339 In this case the filter will see the incoming packet on this
 340 interface.
 341 In all other cases the interface seen by the packet filter is chosen
 342 from the list of bridge members with the same MAC address and the
 343 result strongly depends on the member addition sequence and the
 344 actual implementation of
 345 .Nm .
 346 It is not recommended to rely on the order chosen by the current
 347 .Nm
 348 implementation: it can be changed in the future.
 349 .Pp
 350 The previous paragraph is best illustrated with the following
 351 pictures.
 352 Let
 353 .Bl -bullet
 354 .It
 355 the MAC address of the incoming packet's destination is
 356 .Nm nn:nn:nn:nn:nn:nn ,
 357 .It
 358 the interface on which packet entered the system is
 359 .Nm ifX ,
 360 .It
 361 .Nm ifX
 362 MAC address is
 363 .Nm xx:xx:xx:xx:xx:xx ,
 364 .It
 365 there are possibly other bridge members with the same MAC address
 366 .Nm xx:xx:xx:xx:xx:xx ,
 367 .It
 368 the bridge has more than one interface that are sharing the
 369 same MAC address
 370 .Nm yy:yy:yy:yy:yy:yy ;
 371 we will call them
 372 .Nm vlanY1 ,
 373 .Nm vlanY2 ,
 374 etc.
 375 .El
 376 .Pp
 377 Then if the MAC address
 378 .Nm nn:nn:nn:nn:nn:nn
 379 is equal to the
 380 .Nm xx:xx:xx:xx:xx:xx
 381 then the filter will see the packet on the interface
 382 .Nm ifX
 383 no matter if there are any other bridge members carrying the same
 384 MAC address.
 385 But if the MAC address
 386 .Nm nn:nn:nn:nn:nn:nn
 387 is equal to the
 388 .Nm yy:yy:yy:yy:yy:yy
 389 then the interface that will be seen by the filter is one of the
 390 .Nm vlanYn .
 391 It is not possible to predict the name of the actual interface
 392 without the knowledge of the system state and the
 393 .Nm
 394 implementation details.
 395 .Pp
 396 This problem arises for any bridge members that are sharing the same
 397 MAC address, not only to the
 398 .Xr vlan 4
 399 ones: they we taken just as the example of such situation.
 400 So if one wants the filter the locally destined packets based on
 401 their interface name, one should be aware of this implication.
 402 The described situation will appear at least on the filtering bridges
 403 that are doing IP-forwarding; in some of such cases it is better
 404 to assign the IP address only to the
 405 .Nm
 406 interface and not to the bridge members.
 407 Enabling
 408 .Va net.link.bridge.pfil_local_phys
 409 will let you do the additional filtering on the physical interface.
 410 .Sh EXAMPLES
 411 The following when placed in the file
 412 .Pa /etc/rc.conf
 413 will cause a bridge called
 414 .Dq Li bridge0
 415 to be created, and will add the interfaces
 416 .Dq Li wlan0
 417 and
 418 .Dq Li fxp0
 419 to the bridge, and then enable packet forwarding.
 420 Such a configuration could be used to implement a simple
 421 802.11-to-Ethernet bridge (assuming the 802.11 interface is
 422 in ad-hoc mode).
 423 .Bd -literal -offset indent
 424 cloned_interfaces="bridge0"
 425 ifconfig_bridge0="addm wlan0 addm fxp0 up"
 426 .Ed
 427 .Pp
 428 For the bridge to forward packets all member interfaces and the bridge need
 429 to be up.
 430 The above example would also require:
 431 .Bd -literal -offset indent
 432 create_args_wlan0="wlanmode hostap"
 433 ifconfig_wlan0="up ssid my_ap mode 11g"
 434 ifconfig_fxp0="up"
 435 .Ed
 436 .Pp
 437 Consider a system with two 4-port Ethernet boards.
 438 The following will cause a bridge consisting of all 8 ports with Rapid Spanning
 439 Tree enabled to be created:
 440 .Bd -literal -offset indent
 441 ifconfig bridge0 create
 442 ifconfig bridge0 \e
 443     addm fxp0 stp fxp0 \e
 444     addm fxp1 stp fxp1 \e
 445     addm fxp2 stp fxp2 \e
 446     addm fxp3 stp fxp3 \e
 447     addm fxp4 stp fxp4 \e
 448     addm fxp5 stp fxp5 \e
 449     addm fxp6 stp fxp6 \e
 450     addm fxp7 stp fxp7 \e
 451     up
 452 .Ed
 453 .Pp
 454 The bridge can be used as a regular host interface at the same time as bridging
 455 between its member ports.
 456 In this example, the bridge connects em0 and em1, and will receive its IP
 457 address through DHCP:
 458 .Bd -literal -offset indent
 459 cloned_interfaces="bridge0"
 460 ifconfig_bridge0="addm em0 addm em1 DHCP"
 461 ifconfig_em0="up"
 462 ifconfig_em1="up"
 463 .Ed
 464 .Pp
 465 The bridge can tunnel Ethernet across an IP internet using the EtherIP
 466 protocol.
 467 This can be combined with
 468 .Xr ipsec 4
 469 to provide an encrypted connection.
 470 Create a
 471 .Xr gif 4
 472 interface and set the local and remote IP addresses for the
 473 tunnel, these are reversed on the remote bridge.
 474 .Bd -literal -offset indent
 475 ifconfig gif0 create
 476 ifconfig gif0 tunnel 1.2.3.4 5.6.7.8 up
 477 ifconfig bridge0 create
 478 ifconfig bridge0 addm fxp0 addm gif0 up
 479 .Ed
 480 .Pp
 481 Note that
 482 .Fx
 483 6.1, 6.2, 6.3, 7.0, 7.1, and 7.2 have a bug in the EtherIP protocol.
 484 For more details and workaround, see
 485 .Xr gif 4
 486 manual page.
 487 .Sh SEE ALSO
 488 .Xr gif 4 ,
 489 .Xr ipf 4 ,
 490 .Xr ipfw 4 ,
 491 .Xr pf 4 ,
 492 .Xr ifconfig 8
 493 .Sh HISTORY
 494 The
 495 .Nm
 496 driver first appeared in
 497 .Fx 6.0 .
 498 .Sh AUTHORS
 499 .An -nosplit
 500 The
 501 .Nm bridge
 502 driver was originally written by
 503 .An Jason L. Wright
 504 .Aq jason@thought.net
 505 as part of an undergraduate independent study at the University of
 506 North Carolina at Greensboro.
 507 .Pp
 508 This version of the
 509 .Nm
 510 driver has been heavily modified from the original version by
 511 .An Jason R. Thorpe
 512 .Aq thorpej@wasabisystems.com .
 513 .Pp
 514 Rapid Spanning Tree Protocol (RSTP) support was added by
 515 .An Andrew Thompson
 516 .Aq thompsa@FreeBSD.org .
 517 .Sh BUGS
 518 The
 519 .Nm
 520 driver currently supports only Ethernet and Ethernet-like (e.g., 802.11)
 521 network devices, with exactly the same interface MTU size as the bridge device.