share/man/man4/wlan.4

   1 .\"
   2 .\" Copyright (c) 2003 Tom Rhodes
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/wlan.4,v 1.23 2010/01/14 09:38:23 roam Exp $
  27 .\"
  28 .Dd May 10, 2011
  29 .Dt WLAN 4
  30 .Os
  31 .Sh NAME
  32 .Nm wlan
  33 .Nd generic 802.11 link-layer support
  34 .Sh SYNOPSIS
  35 .Cd "device wlan"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 module provides generic code to support 802.11 drivers.
  40 Where a device does not directly support 802.11 functionality
  41 this layer fills in.
  42 The
  43 .Nm
  44 module is required by all native 802.11 drivers as well as the
  45 .Xr ndis 4
  46 support.
  47 .Pp
  48 .Nm
  49 supports multi-mode devices capable of
  50 operating in both 2.4GHz and 5GHz bands and supports numerous
  51 802.11 standards: 802.11a, 802.11b, 802.11g, 802.11n, and 802.11s (Draft 3.0).
  52 The WPA, 802.11i, and 802.1x security protocols are supported
  53 through a combination of in-kernel code and user-mode applications.
  54 The WME/WMM multi-media protocols are supported entirely within
  55 the
  56 .Nm
  57 module but require a suitably capable hardware device.
  58 Likewise the 802.11h specification is supported only by suitably
  59 capable devices.
  60 .Pp
  61 Drivers provide 802.11 functionality through
  62 .Nm
  63 interfaces that are created at runtime using interface cloning.
  64 This is done with the
  65 .Xr ifconfig 8
  66 .Cm create
  67 command or using the
  68 .Va wlans_IFX
  69 variable in
  70 .Xr rc.conf 5 .
  71 Some drivers support the creation of multiple
  72 .Nm
  73 interfaces that share the same underlying device;
  74 this is the way by which ``multi-bss support'' is provided but it
  75 can also be used to create WDS links and other interesting applications.
  76 .Pp
  77 There are several types of
  78 .Nm
  79 interfaces that may be created:
  80 .Bl -tag -width monitor
  81 .It Cm sta
  82 A client station in an infrastructure bss
  83 (i.e. one that associates to an access point).
  84 .It Cm hostap
  85 An access point in an infrastructure bss.
  86 .It Cm mesh
  87 A mesh station in an MBSS network.
  88 .It Cm adhoc
  89 A station in an IBSS network.
  90 .It Cm ahdemo
  91 A station operating in ``adhoc demo mode''.
  92 This is essentially an IBSS station that does not use management
  93 frames (e.g. no beacons are transmitted).
  94 An
  95 .Cm ahdemo
  96 interface is especially useful for applications that want to transmit
  97 and receive raw 802.11 packets.
  98 .It Cm monitor
  99 An interface used exclusively for capturing 802.11 frames.
 100 In particular this specified to have read-only properties
 101 which enables it to be operated on frequencies where one
 102 would otherwise not be allowed.
 103 .It Cm wds
 104 A station that passes 4-address 802.11 traffic for the purpose
 105 of tunneling traffic over a wireless link.
 106 Typically this station would share the same MAC address as a
 107 .Cm hostap
 108 interface.
 109 It may be possible to create
 110 .Cm wds
 111 interfaces without a companion
 112 .Cm hostap
 113 interface but that is not guaranteed; one may need to create a
 114 .Cm hostap
 115 interface that does not send beacon frames before
 116 .Cm wds
 117 interfaces may be created.
 118 .El
 119 .Pp
 120 Note that an interface's type cannot be changed once it is created.
 121 .Pp
 122 .Nm
 123 defines several mechanisms by which plugin modules may
 124 be used to extend its' functionality.
 125 Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
 126 as standalone modules (if not statically configured into a system)
 127 that register with
 128 .Nm .
 129 Similarly there is an authenticator framework for defining 802.11
 130 authentication services and a framework for integrating access
 131 control mechanisms specific to the 802.11 protocol.
 132 .\".Sh EXAMPLES
 133 .\"Join an existing BSS network (i.e., connect to an access point):
 134 .\".Pp
 135 .\".Dl "ifconfig iface 192.168.0.20/24"
 136 .\".Pp
 137 .\"Join a specific BSS network with network name
 138 .\".Dq Li my_net :
 139 .\".Pp
 140 .\".Dl "ifconfig iface 192.168.0.20/24 ssid my_net"
 141 .\".Pp
 142 .\"Join a specific BSS network with 64 bit WEP encryption:
 143 .\".Bd -literal -offset indent
 144 .\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
 145 .\"        wepkey 0x1234567890 weptxkey 1
 146 .\".Ed
 147 .\".Pp
 148 .\"Join a specific BSS network with 128 bit WEP encryption:
 149 .\".Bd -literal -offset indent
 150 .\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
 151 .\"        wepkey 0x01020304050607080910111213 weptxkey 1
 152 .\".Ed
 153 .\".Pp
 154 .\"Join/create an 802.11b IBSS network:
 155 .\".Bd -literal -offset indent
 156 .\"ifconfig iface 192.168.0.20/24 ssid my_net mediaopt adhoc
 157 .\".Ed
 158 .\".Pp
 159 .\"To debug a network setup, you may wish to enable interface debugging:
 160 .\".Bd -literal -offset indent
 161 .\"ifconfig iface down debug up
 162 .\".Ed
 163 .\".Pp
 164 .\"To disable debugging, you may simply use:
 165 .\".Bd -literal -offset indent
 166 .\"ifconfig iface down -debug up
 167 .\".Ed
 168 .\".Pp
 169 .\"Create an 802.11g host-based access point:
 170 .\".Bd -literal -offset indent
 171 .\"ifconfig iface 192.168.0.20/24 ssid my_net mode 11g mediaopt hostap
 172 .\".Ed
 173 .\".Pp
 174 .\"Create an 802.11a host-based access point with WEP enabled:
 175 .\".Bd -literal -offset indent
 176 .\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
 177 .\"     wepkey 0x1234567890 weptxkey 1 mode 11a mediaopt hostap
 178 .\".Ed
 179 .\".Pp
 180 .\"Create a host-based wireless bridge to fxp0:
 181 .\".Bd -literal -offset indent
 182 .\"ifconfig iface up ssid my_net media DS/11Mbps mediaopt hostap
 183 .\"sysctl net.inet.ip.check_interface=0
 184 .\"ifconfig bridge0 create
 185 .\"ifconfig bridge0 addm iface1 addm iface2 up
 186 .\".Ed
 187 .\".Pp
 188 .\"This will give you the same functionality as an access point.
 189 .Sh DEBUGGING
 190 If the
 191 .Dv IEEE80211_DEBUG
 192 option is included in the kernel configuration,
 193 debugging controls are available using:
 194 .Pp
 195 .Dl "sysctl net.wlan.X.debug=mask"
 196 .Pp
 197 where
 198 .Ar X
 199 is the number of the
 200 .Nm
 201 instance and mask is a bit-or of control bits that determine which
 202 debugging messages to enable.
 203 For example,
 204 .Pp
 205 .Dl "sysctl net.wlan.0.debug=0x00200000"
 206 .Pp
 207 enables debugging messages related to scanning for an access point,
 208 adhoc neighbor, or an unoccupied channel when operation as an access point.
 209 The
 210 .Xr wlandebug 8
 211 tool provides a more user-friendly mechanism for doing the same thing.
 212 Note that
 213 .Pp
 214 .Dl "sysctl net.wlan.debug=mask"
 215 .Pp
 216 defines the initial value of the debugging flags for each cloned
 217 .Nm
 218 interface; this is useful to enable debug messages during interface creation.
 219 .Sh COMPATIBILITY
 220 The module name of
 221 .Nm
 222 was used to be compatible with
 223 .Nx .
 224 .Pp
 225 Mesh stations follow the 802.11s Draft 3.0 specification which is
 226 not ratified and subject to change.
 227 Beware that this specification is incompatible with earlier drafts;
 228 and stations implementing earlier drafts (e.g. Linux)
 229 may not interoperate.
 230 .Sh SEE ALSO
 231 .\".Xr acx 4 ,
 232 .Xr an 4 ,
 233 .Xr ath 4 ,
 234 .\".Xr bwi 4 ,
 235 .Xr bwn 4 ,
 236 .\".Xr ipw 4 ,
 237 .Xr iwi 4 ,
 238 .\".Xr iwl 4 ,
 239 .Xr iwn 4 ,
 240 .\".Xr malo 4 ,
 241 .Xr netintro 4 ,
 242 .Xr ral 4 ,
 243 .\".Xr rtw 4 ,
 244 .Xr rum 4 ,
 245 .Xr run 4 ,
 246 .\".Xr uath 4 ,
 247 .\".Xr upgt 4 ,
 248 .\".Xr ural 4 ,
 249 .\".Xr urtw 4 ,
 250 .Xr urtwn 4 ,
 251 .Xr wi 4 ,
 252 .Xr wlan_acl 4 ,
 253 .Xr wlan_amrr 4 ,
 254 .Xr wlan_ccmp 4 ,
 255 .Xr wlan_tkip 4 ,
 256 .Xr wlan_wep 4 ,
 257 .Xr wlan_xauth 4 ,
 258 .Xr wpi 4
 259 .\".Xr zyd 4
 260 .Sh STANDARDS
 261 More information can be found in the IEEE 802.11 Standards.
 262 .Sh HISTORY
 263 The
 264 .Nm
 265 driver first appeared in
 266 .Fx 5.0 .
 267 .Sh AUTHORS
 268 .An -nosplit
 269 .An Atsushi Onoe
 270 is the author of the original
 271 .Nx
 272 software from which this work began.
 273 .An Sam Leffler
 274 brought the code into
 275 .Fx
 276 and then rewrote it to support multi-mode devices,
 277 802.11g, 802.11n, WPA/802.11i, WME, multi-bss, and
 278 add the extensible frameworks
 279 for cryptographic, authentication, and access control plugins.
 280 This manual page was written by
 281 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org .