man/man4/wlan.4

.\"
.\" Copyright (c) 2003 Tom Rhodes
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/man/man4/wlan.4,v 1.23 2010/01/14 09:38:23 roam Exp $
.\"
.Dd May 10, 2011
.Dt WLAN 4
.Os
.Sh NAME
.Nm wlan
.Nd generic 802.11 link-layer support
.Sh SYNOPSIS
.Cd "device wlan"
.Sh DESCRIPTION
The
.Nm
module provides generic code to support 802.11 drivers.
Where a device does not directly support 802.11 functionality
this layer fills in.
The
.Nm
module is required by all native 802.11 drivers as well as the
.Xr ndis 4
support.
.Pp
.Nm
supports multi-mode devices capable of
operating in both 2.4GHz and 5GHz bands and supports numerous
802.11 standards: 802.11a, 802.11b, 802.11g, 802.11n, and 802.11s (Draft 3.0).
The WPA, 802.11i, and 802.1x security protocols are supported
through a combination of in-kernel code and user-mode applications.
The WME/WMM multi-media protocols are supported entirely within
the
.Nm
module but require a suitably capable hardware device.
Likewise the 802.11h specification is supported only by suitably
capable devices.
.Pp
Drivers provide 802.11 functionality through
.Nm
interfaces that are created at runtime using interface cloning.
This is done with the
.Xr ifconfig 8
.Cm create
command or using the
.Va wlans_IFX
variable in
.Xr rc.conf 5 .
Some drivers support the creation of multiple
.Nm
interfaces that share the same underlying device;
this is the way by which ``multi-bss support'' is provided but it
can also be used to create WDS links and other interesting applications.
.Pp
There are several types of
.Nm
interfaces that may be created:
.Bl -tag -width monitor
.It Cm sta
A client station in an infrastructure bss
(i.e. one that associates to an access point).
.It Cm hostap
An access point in an infrastructure bss.
.It Cm mesh
A mesh station in an MBSS network.
.It Cm adhoc
A station in an IBSS network.
.It Cm ahdemo
A station operating in ``adhoc demo mode''.
This is essentially an IBSS station that does not use management
frames (e.g. no beacons are transmitted).
An
.Cm ahdemo
interface is especially useful for applications that want to transmit
and receive raw 802.11 packets.
.It Cm monitor
An interface used exclusively for capturing 802.11 frames.
In particular this specified to have read-only properties
which enables it to be operated on frequencies where one
would otherwise not be allowed.
.It Cm wds
A station that passes 4-address 802.11 traffic for the purpose
of tunneling traffic over a wireless link.
Typically this station would share the same MAC address as a
.Cm hostap
interface.
It may be possible to create
.Cm wds
interfaces without a companion
.Cm hostap
interface but that is not guaranteed; one may need to create a
.Cm hostap
interface that does not send beacon frames before
.Cm wds
interfaces may be created.
.El
.Pp
Note that an interface's type cannot be changed once it is created.
.Pp
.Nm
defines several mechanisms by which plugin modules may
be used to extend its' functionality.
Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
as standalone modules (if not statically configured into a system)
that register with
.Nm .
Similarly there is an authenticator framework for defining 802.11
authentication services and a framework for integrating access
control mechanisms specific to the 802.11 protocol.
.\".Sh EXAMPLES
.\"Join an existing BSS network (i.e., connect to an access point):
.\".Pp
.\".Dl "ifconfig iface 192.168.0.20/24"
.\".Pp
.\"Join a specific BSS network with network name
.\".Dq Li my_net :
.\".Pp
.\".Dl "ifconfig iface 192.168.0.20/24 ssid my_net"
.\".Pp
.\"Join a specific BSS network with 64 bit WEP encryption:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
.\"        wepkey 0x1234567890 weptxkey 1
.\".Ed
.\".Pp
.\"Join a specific BSS network with 128 bit WEP encryption:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
.\"        wepkey 0x01020304050607080910111213 weptxkey 1
.\".Ed
.\".Pp
.\"Join/create an 802.11b IBSS network:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net mediaopt adhoc
.\".Ed
.\".Pp
.\"To debug a network setup, you may wish to enable interface debugging:
.\".Bd -literal -offset indent
.\"ifconfig iface down debug up
.\".Ed
.\".Pp
.\"To disable debugging, you may simply use:
.\".Bd -literal -offset indent
.\"ifconfig iface down -debug up
.\".Ed
.\".Pp
.\"Create an 802.11g host-based access point:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net mode 11g mediaopt hostap
.\".Ed
.\".Pp
.\"Create an 802.11a host-based access point with WEP enabled:
.\".Bd -literal -offset indent
.\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
.\"	wepkey 0x1234567890 weptxkey 1 mode 11a mediaopt hostap
.\".Ed
.\".Pp
.\"Create a host-based wireless bridge to fxp0:
.\".Bd -literal -offset indent
.\"ifconfig iface up ssid my_net media DS/11Mbps mediaopt hostap
.\"sysctl net.inet.ip.check_interface=0
.\"ifconfig bridge0 create
.\"ifconfig bridge0 addm iface1 addm iface2 up
.\".Ed
.\".Pp
.\"This will give you the same functionality as an access point.
.Sh DEBUGGING
If the
.Dv IEEE80211_DEBUG
option is included in the kernel configuration,
debugging controls are available using:
.Pp
.Dl "sysctl net.wlan.X.debug=mask"
.Pp
where
.Ar X
is the number of the
.Nm
instance and mask is a bit-or of control bits that determine which
debugging messages to enable.
For example,
.Pp
.Dl "sysctl net.wlan.0.debug=0x00200000"
.Pp
enables debugging messages related to scanning for an access point,
adhoc neighbor, or an unoccupied channel when operation as an access point.
The
.Xr wlandebug 8
tool provides a more user-friendly mechanism for doing the same thing.
Note that
.Pp
.Dl "sysctl net.wlan.debug=mask"
.Pp
defines the initial value of the debugging flags for each cloned
.Nm
interface; this is useful to enable debug messages during interface creation.
.Sh COMPATIBILITY
The module name of
.Nm
was used to be compatible with
.Nx .
.Pp
Mesh stations follow the 802.11s Draft 3.0 specification which is
not ratified and subject to change.
Beware that this specification is incompatible with earlier drafts;
and stations implementing earlier drafts (e.g. Linux)
may not interoperate.
.Sh SEE ALSO
.\".Xr acx 4 ,
.Xr an 4 ,
.Xr ath 4 ,
.\".Xr bwi 4 ,
.Xr bwn 4 ,
.\".Xr ipw 4 ,
.Xr iwi 4 ,
.\".Xr iwl 4 ,
.Xr iwn 4 ,
.\".Xr malo 4 ,
.Xr netintro 4 ,
.Xr ral 4 ,
.\".Xr rtw 4 ,
.Xr rum 4 ,
.Xr run 4 ,
.\".Xr uath 4 ,
.\".Xr upgt 4 ,
.\".Xr ural 4 ,
.\".Xr urtw 4 ,
.Xr urtwn 4 ,
.Xr wi 4 ,
.Xr wlan_acl 4 ,
.Xr wlan_amrr 4 ,
.Xr wlan_ccmp 4 ,
.Xr wlan_tkip 4 ,
.Xr wlan_wep 4 ,
.Xr wlan_xauth 4 ,
.Xr wpi 4
.\".Xr zyd 4
.Sh STANDARDS
More information can be found in the IEEE 802.11 Standards.
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 5.0 .
.Sh AUTHORS
.An -nosplit
.An Atsushi Onoe
is the author of the original
.Nx
software from which this work began.
.An Sam Leffler
brought the code into
.Fx
and then rewrote it to support multi-mode devices,
802.11g, 802.11n, WPA/802.11i, WME, multi-bss, and
add the extensible frameworks
for cryptographic, authentication, and access control plugins.
This manual page was written by
.An Tom Rhodes Aq Mt trhodes@FreeBSD.org .