1
.\" This manpage has been automatically generated by docbook2man
2
.\" from a DocBook document. This tool can be found at:
3
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
4
.\" Please send any bug reports, improvements, comments, patches,
5
.\" etc. to Steve Cheng <steve@ggi-project.org>.
6
.TH "WPA_SUPPLICANT" "8" "22 February 2008" "" ""
9
wpa_supplicant \- Wi-Fi Protected Access client and IEEE 802.1X supplicant
12
\fBwpa_supplicant\fR [ \fB-BddfhKLqqtuvW\fR ] [ \fB-i\fIifname\fB\fR ] [ \fB-c\fIconfig file\fB\fR ] [ \fB-D\fIdriver\fB\fR ] [ \fB-P\fIPID_file\fB\fR ] [ \fB-f\fIoutput file\fB\fR ]
16
Wireless networks do not require physical access to the network equipment
17
in the same way as wired networks. This makes it easier for unauthorized
18
users to passively monitor a network and capture all transmitted frames.
19
In addition, unauthorized use of the network is much easier. In many cases,
20
this can happen even without user's explicit knowledge since the wireless
21
LAN adapter may have been configured to automatically join any available
24
Link-layer encryption can be used to provide a layer of security for
25
wireless networks. The original wireless LAN standard, IEEE 802.11,
26
included a simple encryption mechanism, WEP. However, that proved to
27
be flawed in many areas and network protected with WEP cannot be consider
28
secure. IEEE 802.1X authentication and frequently changed dynamic WEP keys
29
can be used to improve the network security, but even that has inherited
30
security issues due to the use of WEP for encryption. Wi-Fi Protected
31
Access and IEEE 802.11i amendment to the wireless LAN standard introduce
32
a much improvement mechanism for securing wireless networks. IEEE 802.11i
33
enabled networks that are using CCMP (encryption mechanism based on strong
34
cryptographic algorithm AES) can finally be called secure used for
35
applications which require efficient protection against unauthorized
38
\fBwpa_supplicant\fR is an implementation of
39
the WPA Supplicant component, i.e., the part that runs in the
40
client stations. It implements WPA key negotiation with a WPA
41
Authenticator and EAP authentication with Authentication
42
Server. In addition, it controls the roaming and IEEE 802.11
43
authentication/association of the wireless LAN driver.
45
\fBwpa_supplicant\fR is designed to be a
46
"daemon" program that runs in the background and acts as the
47
backend component controlling the wireless
48
connection. \fBwpa_supplicant\fR supports separate
49
frontend programs and an example text-based frontend,
50
\fBwpa_cli\fR, is included with
53
Before wpa_supplicant can do its work, the network interface
54
must be available. That means that the physical device must be
55
present and enabled, and the driver for the device must have be
56
loaded. The daemon will exit immediately if the device is not already
59
After \fBwpa_supplicant\fR has configured the
60
network device, higher level configuration such as DHCP may
61
proceed. There are a variety of ways to integrate wpa_supplicant
62
into a machine's networking scripts, a few of which are described
65
The following steps are used when associating with an AP
69
\fBwpa_supplicant\fR requests the kernel
70
driver to scan neighboring BSSes
73
\fBwpa_supplicant\fR selects a BSS based on
77
\fBwpa_supplicant\fR requests the kernel
78
driver to associate with the chosen BSS
81
If WPA-EAP: integrated IEEE 802.1X Supplicant
82
completes EAP authentication with the
83
authentication server (proxied by the Authenticator in the
87
If WPA-EAP: master key is received from the IEEE 802.1X
91
If WPA-PSK: \fBwpa_supplicant\fR uses PSK
92
as the master session key
95
\fBwpa_supplicant\fR completes WPA 4-Way
96
Handshake and Group Key Handshake with the Authenticator
100
\fBwpa_supplicant\fR configures encryption
101
keys for unicast and broadcast
104
normal data packets can be transmitted and received
105
.SH "SUPPORTED FEATURES"
107
Supported WPA/IEEE 802.11i features:
110
WPA-PSK ("WPA-Personal")
113
WPA with EAP (e.g., with RADIUS authentication server)
114
("WPA-Enterprise") Following authentication methods are
115
supported with an integrate IEEE 802.1X Supplicant:
124
EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1)
127
EAP-PEAP/TLS (both PEAPv0 and PEAPv1)
130
EAP-PEAP/GTC (both PEAPv0 and PEAPv1)
133
EAP-PEAP/OTP (both PEAPv0 and PEAPv1)
136
EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1)
139
EAP-TTLS/EAP-MD5-Challenge
148
EAP-TTLS/EAP-MSCHAPv2
178
LEAP (note: requires special support from
179
the driver for IEEE 802.11 authentication)
182
(following methods are supported, but since
183
they do not generate keying material, they cannot be used
184
with WPA or IEEE 802.1X WEP keying)
200
key management for CCMP, TKIP, WEP104, WEP40
203
RSN/WPA2 (IEEE 802.11i)
212
.SH "AVAILABLE DRIVERS"
214
The available drivers to specify with the -D option are:
217
(default) Host AP driver (Intersil Prism2/2.5/3).
218
(this can also be used with Linuxant DriverLoader).
221
Agere Systems Inc. driver (Hermes-I/Hermes-II).
224
MADWIFI 802.11 support (Atheros, etc.).
227
ATMEL AT76C5XXx (USB, PCMCIA).
230
Linux wireless extensions (generic).
236
Broadcom wl.o driver.
239
Intel ipw2100/2200 driver.
242
wpa_supplicant wired Ethernet driver
245
BSD 802.11 support (Atheros, etc.).
249
.SH "COMMAND LINE OPTIONS"
252
Optional bridge interface name.
255
Run daemon in the background.
258
Path to configuration file.
260
\fB-C ctrl_interface\fR
261
Path to ctrl_interface socket (only used if -c is not).
264
Interface to listen on.
267
Increase debugging verbosity (-dd even more).
270
Driver to use. See the available options below.
273
Log output to specified file instead of stdout.
275
\fB-g global ctrl_interface\fR
276
Path to global ctrl_interface socket.
279
Include keys (passwords, etc.) in debug output.
282
Include timestamp in debug messages.
285
Help. Show a usage message.
288
Show license (GPL and BSD).
297
Decrease debugging verbosity (-qq even less).
300
Enabled DBus control interface.
306
Wait for a control interface monitor before starting.
309
Start describing new interface.
312
In most common cases, \fBwpa_supplicant\fR is
318
wpa_supplicant -B -c/etc/wpa_supplicant.conf -iwlan0
322
This makes the process fork into background.
324
The easiest way to debug problems, and to get debug log for
325
bug reports, is to start \fBwpa_supplicant\fR on
326
foreground with debugging enabled:
331
wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
335
\fBwpa_supplicant\fR can control multiple
336
interfaces (radios) either by running one process for each
337
interface separately or by running just one process and list of
338
options at command line. Each interface is separated with -N
339
argument. As an example, following command would start
340
wpa_supplicant for two interfaces:
346
-c wpa1.conf -i wlan0 -D hostap -N \\
347
-c wpa2.conf -i ath0 -D madwifi
350
.SH "OS REQUIREMENTS"
352
Current hardware/software requirements:
355
Linux kernel 2.4.x or 2.6.x with Linux Wireless
356
Extensions v15 or newer
362
Microsoft Windows with WinPcap (at least WinXP, may work
364
.SH "SUPPORTED DRIVERS"
366
\fBHost AP driver for Prism2/2.5/3 (development snapshot/v0.2.x)\fR
367
(http://hostap.epitest.fi/) Driver needs to be set in
368
Managed mode ('iwconfig wlan0 mode managed'). Please note
369
that station firmware version needs to be 1.7.0 or newer to
372
\fBLinuxant DriverLoader\fR
373
(http://www.linuxant.com/driverloader/)
374
with Windows NDIS driver for your wlan card supporting WPA.
376
\fBAgere Systems Inc. Linux Driver\fR
377
(http://www.agere.com/support/drivers/) Please note
378
that the driver interface file (driver_hermes.c) and hardware
379
specific include files are not included in the wpa_supplicant
380
distribution. You will need to copy these from the source
381
package of the Agere driver.
383
\fBmadwifi driver for cards based on Atheros chip set (ar521x)\fR
384
(http://sourceforge.net/projects/madwifi/) Please
385
note that you will need to modify the wpa_supplicant .config
386
file to use the correct path for the madwifi driver root
387
directory (CFLAGS += -I../madwifi/wpa line in example
390
\fBATMEL AT76C5XXx driver for USB and PCMCIA cards\fR
391
(http://atmelwlandriver.sourceforge.net/).
393
\fBLinux ndiswrapper\fR
394
(http://ndiswrapper.sourceforge.net/) with Windows
397
\fBBroadcom wl.o driver\fR
398
This is a generic Linux driver for Broadcom IEEE
399
802.11a/g cards. However, it is proprietary driver that is
400
not publicly available except for couple of exceptions, mainly
401
Broadcom-based APs/wireless routers that use Linux. The driver
402
binary can be downloaded, e.g., from Linksys support site
403
(http://www.linksys.com/support/gpl.asp) for Linksys
404
WRT54G. The GPL tarball includes cross-compiler and the needed
405
header file, wlioctl.h, for compiling wpa_supplicant. This
406
driver support in wpa_supplicant is expected to work also with
407
other devices based on Broadcom driver (assuming the driver
408
includes client mode support).
410
\fB Intel ipw2100 driver\fR
411
(http://sourceforge.net/projects/ipw2100/)
413
\fBIntel ipw2200 driver\fR
414
(http://sourceforge.net/projects/ipw2200/)
416
\fBLinux wireless extensions\fR
417
In theory, any driver that supports Linux wireless
418
extensions can be used with IEEE 802.1X (i.e., not WPA) when
419
using ap_scan=0 option in configuration file.
421
\fBWired Ethernet drivers\fR
424
\fBBSD net80211 layer (e.g., Atheros driver)\fR
425
At the moment, this is for FreeBSD 6-CURRENT branch.
428
The current Windows port requires WinPcap
429
(http://winpcap.polito.it/). See README-Windows.txt for more
432
wpa_supplicant was designed to be portable for different
433
drivers and operating systems. Hopefully, support for more wlan
434
cards and OSes will be added in the future. See developer.txt for
435
more information about the design of wpa_supplicant and porting to
436
other drivers. One main goal is to add full WPA/WPA2 support to
437
Linux wireless extensions to allow new drivers to be supported
438
without having to implement new driver-specific interface code in
443
\fBwpa_supplicant\fR system consists of the following
446
\fB\fIwpa_supplicant.conf\fB \fR
447
the configuration file describing all networks that the
448
user wants the computer to connect to.
451
the program that directly interacts with the
456
client program that provides a high-level interface to the
457
functionality of the daemon.
460
a utility needed to construct
461
\fIwpa_supplicant.conf\fR files that include
465
First, make a configuration file, e.g.
466
\fI/etc/wpa_supplicant.conf\fR, that describes the networks
467
you are interested in. See \fBwpa_supplicant.conf\fR(5)
470
Once the configuration is ready, you can test whether the
471
configuration works by running \fBwpa_supplicant\fR
472
with following command to start it on foreground with debugging
478
wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -d
483
Assuming everything goes fine, you can start using following
484
command to start \fBwpa_supplicant\fR on background
490
wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B
495
Please note that if you included more than one driver
496
interface in the build time configuration (.config), you may need
497
to specify which interface to use by including -D<driver
498
name> option on the command line.
499
.SH "INTERFACE TO PCMCIA-CS/CARDMRG"
501
For example, following small changes to pcmcia-cs scripts
502
can be used to enable WPA support:
504
Add MODE="Managed" and WPA="y" to the network scheme in
505
\fI/etc/pcmcia/wireless.opts\fR\&.
507
Add the following block to the end of 'start' action handler
508
in \fI/etc/pcmcia/wireless\fR:
513
if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
514
/usr/local/bin/wpa_supplicant -B -c/etc/wpa_supplicant.conf -i$DEVICE
520
Add the following block to the end of 'stop' action handler
521
(may need to be separated from other actions) in
522
\fI/etc/pcmcia/wireless\fR:
527
if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
528
killall wpa_supplicant
534
This will make \fBcardmgr\fR start
535
\fBwpa_supplicant\fR when the card is plugged
539
\fBwpa_background\fR(8)
540
\fBwpa_supplicant.conf\fR(5)
542
\fBwpa_passphrase\fR(8)
545
wpa_supplicant is copyright (c) 2003-2007,
546
Jouni Malinen <j@w1.fi> and
550
This program is dual-licensed under both the GPL version 2
551
and BSD license. Either license may be used at your option.
added
removed
wpa_supplicant/doc/docbook/wpa_supplicant.8
