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 3, 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 an 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 When both
 198 .Nm
 199 interface and the existing member interfaces do not have one,
 200 adding an interface with IPv6 addresses as a new member interface is allowed.
 201 These means only one interface in the link-local scope zone where the
 202 .Nm
 203 interface forms can have link-local scoped IPv6 addresses.
 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 .Ed
 218 .Sh SPANNING TREE
 219 The
 220 .Nm
 221 driver implements the Rapid Spanning Tree Protocol (RSTP or 802.1w) with
 222 backwards compatibility with the legacy Spanning Tree Protocol (STP).
 223 Spanning Tree is used to detect and remove loops in a network topology.
 224 .Pp
 225 RSTP provides faster spanning tree convergence than legacy STP, the protocol
 226 will exchange information with neighbouring switches to quickly transition to
 227 forwarding without creating loops.
 228 .Pp
 229 The code will default to RSTP mode but will downgrade any port connected to a
 230 legacy STP network so is fully backward compatible.
 231 A bridge can be forced to operate in STP mode without rapid state transitions
 232 via the
 233 .Va proto
 234 command in
 235 .Xr ifconfig 8 .
 236 .Pp
 237 The bridge can log STP port changes to
 238 .Xr syslog 3
 239 by enabling the
 240 .Va net.link.bridge.log_stp
 241 variable using
 242 .Xr sysctl 8 .
 243 .Pp
 244 .Sh PACKET FILTERING
 245 Packet filtering can be used with any firewall package that hooks in via the
 246 .Xr pfil 9
 247 framework.
 248 When filtering is enabled, bridged packets will pass through the filter
 249 inbound on the originating interface, on the bridge interface and outbound on
 250 the appropriate interfaces.
 251 Either stage can be disabled.
 252 The filtering behaviour can be controlled using
 253 .Xr sysctl 8 :
 254 .Bl -tag -width ".Va net.link.bridge.pfil_onlyip"
 255 .It Va net.link.bridge.pfil_onlyip
 256 Controls the handling of non-IP packets which are not passed to
 257 .Xr pfil 9 .
 258 Set to
 259 .Li 1
 260 to only allow IP packets to pass (subject to firewall rules), set to
 261 .Li 0
 262 to unconditionally pass all non-IP Ethernet frames.
 263 .It Va net.link.bridge.pfil_member
 264 Set to
 265 .Li 1
 266 to enable filtering on the incoming and outgoing member interfaces, set
 267 to
 268 .Li 0
 269 to disable it.
 270 .It Va net.link.bridge.pfil_bridge
 271 Set to
 272 .Li 1
 273 to enable filtering on the bridge interface, set
 274 to
 275 .Li 0
 276 to disable it.
 277 .It Va net.link.bridge.pfil_local_phys
 278 Set to
 279 .Li 1
 280 to additionally filter on the physical interface for locally destined packets.
 281 Set to
 282 .Li 0
 283 to disable this feature.
 284 .It Va net.link.bridge.ipfw
 285 Set to
 286 .Li 1
 287 to enable layer2 filtering with
 288 .Xr ipfirewall 4 ,
 289 set to
 290 .Li 0
 291 to disable it.
 292 This needs to be enabled for
 293 .Xr dummynet 4
 294 support.
 295 When
 296 .Va ipfw
 297 is enabled,
 298 .Va pfil_bridge
 299 and
 300 .Va pfil_member
 301 will be disabled so that IPFW
 302 is not run twice; these can be re-enabled if desired.
 303 .It Va net.link.bridge.ipfw_arp
 304 Set to
 305 .Li 1
 306 to enable layer2 ARP filtering with
 307 .Xr ipfirewall 4 ,
 308 set to
 309 .Li 0
 310 to disable it.
 311 Requires
 312 .Va ipfw
 313 to be enabled.
 314 .El
 315 .Pp
 316 ARP and REVARP packets are forwarded without being filtered and others
 317 that are not IP nor IPv6 packets are not forwarded when
 318 .Va pfil_onlyip
 319 is enabled.
 320 IPFW can filter Ethernet types using
 321 .Cm mac-type
 322 so all packets are passed to
 323 the filter for processing.
 324 .Pp
 325 The packets originating from the bridging host will be seen by
 326 the filter on the interface that is looked up in the routing
 327 table.
 328 .Pp
 329 The packets destined to the bridging host will be seen by the filter
 330 on the interface with the MAC address equal to the packet's destination
 331 MAC.
 332 There are situations when some of the bridge members are sharing
 333 the same MAC address (for example the
 334 .Xr vlan 4
 335 interfaces: they are currently sharing the
 336 MAC address of the parent physical interface).
 337 It is not possible to distinguish between these interfaces using
 338 their MAC address, excluding the case when the packet's destination
 339 MAC address is equal to the MAC address of the interface on which
 340 the packet was entered to the system.
 341 In this case the filter will see the incoming packet on this
 342 interface.
 343 In all other cases the interface seen by the packet filter is chosen
 344 from the list of bridge members with the same MAC address and the
 345 result strongly depends on the member addition sequence and the
 346 actual implementation of
 347 .Nm .
 348 It is not recommended to rely on the order chosen by the current
 349 .Nm
 350 implementation: it can be changed in the future.
 351 .Pp
 352 The previous paragraph is best illustrated with the following
 353 pictures.
 354 Let
 355 .Bl -bullet
 356 .It
 357 the MAC address of the incoming packet's destination is
 358 .Nm nn:nn:nn:nn:nn:nn ,
 359 .It
 360 the interface on which packet entered the system is
 361 .Nm ifX ,
 362 .It
 363 .Nm ifX
 364 MAC address is
 365 .Nm xx:xx:xx:xx:xx:xx ,
 366 .It
 367 there are possibly other bridge members with the same MAC address
 368 .Nm xx:xx:xx:xx:xx:xx ,
 369 .It
 370 the bridge has more than one interface that are sharing the
 371 same MAC address
 372 .Nm yy:yy:yy:yy:yy:yy ;
 373 we will call them
 374 .Nm vlanY1 ,
 375 .Nm vlanY2 ,
 376 etc.
 377 .El
 378 .Pp
 379 Then if the MAC address
 380 .Nm nn:nn:nn:nn:nn:nn
 381 is equal to the
 382 .Nm xx:xx:xx:xx:xx:xx
 383 then the filter will see the packet on the interface
 384 .Nm ifX
 385 no matter if there are any other bridge members carrying the same
 386 MAC address.
 387 But if the MAC address
 388 .Nm nn:nn:nn:nn:nn:nn
 389 is equal to the
 390 .Nm yy:yy:yy:yy:yy:yy
 391 then the interface that will be seen by the filter is one of the
 392 .Nm vlanYn .
 393 It is not possible to predict the name of the actual interface
 394 without the knowledge of the system state and the
 395 .Nm
 396 implementation details.
 397 .Pp
 398 This problem arises for any bridge members that are sharing the same
 399 MAC address, not only to the
 400 .Xr vlan 4
 401 ones: they we taken just as the example of such situation.
 402 So if one wants the filter the locally destined packets based on
 403 their interface name, one should be aware of this implication.
 404 The described situation will appear at least on the filtering bridges
 405 that are doing IP-forwarding; in some of such cases it is better
 406 to assign the IP address only to the
 407 .Nm
 408 interface and not to the bridge members.
 409 Enabling
 410 .Va net.link.bridge.pfil_local_phys
 411 will let you do the additional filtering on the physical interface.
 412 .Sh EXAMPLES
 413 The following when placed in the file
 414 .Pa /etc/rc.conf
 415 will cause a bridge called
 416 .Dq Li bridge0
 417 to be created, and will add the interfaces
 418 .Dq Li wlan0
 419 and
 420 .Dq Li fxp0
 421 to the bridge, and then enable packet forwarding.
 422 Such a configuration could be used to implement a simple
 423 802.11-to-Ethernet bridge (assuming the 802.11 interface is
 424 in ad-hoc mode).
 425 .Bd -literal -offset indent
 426 cloned_interfaces="bridge0"
 427 ifconfig_bridge0="addm wlan0 addm fxp0 up"
 428 .Ed
 429 .Pp
 430 For the bridge to forward packets all member interfaces and the bridge need
 431 to be up.
 432 The above example would also require:
 433 .Bd -literal -offset indent
 434 create_args_wlan0="wlanmode hostap"
 435 ifconfig_wlan0="up ssid my_ap mode 11g"
 436 ifconfig_fxp0="up"
 437 .Ed
 438 .Pp
 439 Consider a system with two 4-port Ethernet boards.
 440 The following will cause a bridge consisting of all 8 ports with Rapid Spanning
 441 Tree enabled to be created:
 442 .Bd -literal -offset indent
 443 ifconfig bridge0 create
 444 ifconfig bridge0 \e
 445     addm fxp0 stp fxp0 \e
 446     addm fxp1 stp fxp1 \e
 447     addm fxp2 stp fxp2 \e
 448     addm fxp3 stp fxp3 \e
 449     addm fxp4 stp fxp4 \e
 450     addm fxp5 stp fxp5 \e
 451     addm fxp6 stp fxp6 \e
 452     addm fxp7 stp fxp7 \e
 453     up
 454 .Ed
 455 .Pp
 456 The bridge can be used as a regular host interface at the same time as bridging
 457 between its member ports.
 458 In this example, the bridge connects em0 and em1, and will receive its IP
 459 address through DHCP:
 460 .Bd -literal -offset indent
 461 cloned_interfaces="bridge0"
 462 ifconfig_bridge0="addm em0 addm em1 DHCP"
 463 ifconfig_em0="up"
 464 ifconfig_em1="up"
 465 .Ed
 466 .Pp
 467 The bridge can tunnel Ethernet across an IP internet using the EtherIP
 468 protocol.
 469 This can be combined with
 470 .Xr ipsec 4
 471 to provide an encrypted connection.
 472 Create a
 473 .Xr gif 4
 474 interface and set the local and remote IP addresses for the
 475 tunnel, these are reversed on the remote bridge.
 476 .Bd -literal -offset indent
 477 ifconfig gif0 create
 478 ifconfig gif0 tunnel 1.2.3.4 5.6.7.8 up
 479 ifconfig bridge0 create
 480 ifconfig bridge0 addm fxp0 addm gif0 up
 481 .Ed
 482 .Pp
 483 Note that
 484 .Fx
 485 6.1, 6.2, 6.3, 7.0, 7.1, and 7.2 have a bug in the EtherIP protocol.
 486 For more details and workaround, see
 487 .Xr gif 4
 488 manual page.
 489 .Sh SEE ALSO
 490 .Xr gif 4 ,
 491 .Xr ipf 4 ,
 492 .Xr ipfw 4 ,
 493 .Xr pf 4 ,
 494 .Xr ifconfig 8
 495 .Sh HISTORY
 496 The
 497 .Nm
 498 driver first appeared in
 499 .Fx 6.0 .
 500 .Sh AUTHORS
 501 .An -nosplit
 502 The
 503 .Nm bridge
 504 driver was originally written by
 505 .An Jason L. Wright
 506 .Aq jason@thought.net
 507 as part of an undergraduate independent study at the University of
 508 North Carolina at Greensboro.
 509 .Pp
 510 This version of the
 511 .Nm
 512 driver has been heavily modified from the original version by
 513 .An Jason R. Thorpe
 514 .Aq thorpej@wasabisystems.com .
 515 .Pp
 516 Rapid Spanning Tree Protocol (RSTP) support was added by
 517 .An Andrew Thompson
 518 .Aq thompsa@FreeBSD.org .
 519 .Sh BUGS
 520 The
 521 .Nm
 522 driver currently supports only Ethernet and Ethernet-like (e.g., 802.11)
 523 network devices, with exactly the same interface MTU size as the bridge device.