| blob | 92266815f7c419086cc408eab20ccf2637ce9777 |
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" "10 August 2008" "" ""
8 .SH NAME
9 wpa_supplicant \- Wi-Fi Protected Access client and IEEE 802.1X supplicant
10 .SH SYNOPSIS
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 ]
14 .SH "OVERVIEW"
15 .PP
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
22 network.
23 .PP
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
36 access.
37 .PP
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.
44 .PP
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
51 wpa_supplicant.
52 .PP
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
57 available.
58 .PP
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
63 in sections below.
64 .PP
65 The following steps are used when associating with an AP
66 using WPA:
67 .TP 0.2i
68 \(bu
69 \fBwpa_supplicant\fR requests the kernel
70 driver to scan neighboring BSSes
71 .TP 0.2i
72 \(bu
73 \fBwpa_supplicant\fR selects a BSS based on
74 its configuration
75 .TP 0.2i
76 \(bu
77 \fBwpa_supplicant\fR requests the kernel
78 driver to associate with the chosen BSS
79 .TP 0.2i
80 \(bu
81 If WPA-EAP: integrated IEEE 802.1X Supplicant
82 completes EAP authentication with the
83 authentication server (proxied by the Authenticator in the
84 AP)
85 .TP 0.2i
86 \(bu
87 If WPA-EAP: master key is received from the IEEE 802.1X
88 Supplicant
89 .TP 0.2i
90 \(bu
91 If WPA-PSK: \fBwpa_supplicant\fR uses PSK
92 as the master session key
93 .TP 0.2i
94 \(bu
95 \fBwpa_supplicant\fR completes WPA 4-Way
96 Handshake and Group Key Handshake with the Authenticator
97 (AP)
98 .TP 0.2i
99 \(bu
100 \fBwpa_supplicant\fR configures encryption
101 keys for unicast and broadcast
102 .TP 0.2i
103 \(bu
104 normal data packets can be transmitted and received
105 .SH "SUPPORTED FEATURES"
106 .PP
107 Supported WPA/IEEE 802.11i features:
108 .TP 0.2i
109 \(bu
110 WPA-PSK ("WPA-Personal")
111 .TP 0.2i
112 \(bu
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:
116 .RS
117 .TP 0.2i
118 \(bu
119 EAP-TLS
120 .RE
121 .RS
122 .TP 0.2i
123 \(bu
124 EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1)
125 .TP 0.2i
126 \(bu
127 EAP-PEAP/TLS (both PEAPv0 and PEAPv1)
128 .TP 0.2i
129 \(bu
130 EAP-PEAP/GTC (both PEAPv0 and PEAPv1)
131 .TP 0.2i
132 \(bu
133 EAP-PEAP/OTP (both PEAPv0 and PEAPv1)
134 .TP 0.2i
135 \(bu
136 EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1)
137 .TP 0.2i
138 \(bu
139 EAP-TTLS/EAP-MD5-Challenge
140 .TP 0.2i
141 \(bu
142 EAP-TTLS/EAP-GTC
143 .TP 0.2i
144 \(bu
145 EAP-TTLS/EAP-OTP
146 .TP 0.2i
147 \(bu
148 EAP-TTLS/EAP-MSCHAPv2
149 .TP 0.2i
150 \(bu
151 EAP-TTLS/EAP-TLS
152 .TP 0.2i
153 \(bu
154 EAP-TTLS/MSCHAPv2
155 .TP 0.2i
156 \(bu
157 EAP-TTLS/MSCHAP
158 .TP 0.2i
159 \(bu
160 EAP-TTLS/PAP
161 .TP 0.2i
162 \(bu
163 EAP-TTLS/CHAP
164 .TP 0.2i
165 \(bu
166 EAP-SIM
167 .TP 0.2i
168 \(bu
169 EAP-AKA
170 .TP 0.2i
171 \(bu
172 EAP-PSK
173 .TP 0.2i
174 \(bu
175 EAP-PAX
176 .TP 0.2i
177 \(bu
178 LEAP (note: requires special support from
179 the driver for IEEE 802.11 authentication)
180 .TP 0.2i
181 \(bu
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)
185 .TP 0.2i
186 \(bu
187 EAP-MD5-Challenge
188 .TP 0.2i
189 \(bu
190 EAP-MSCHAPv2
191 .TP 0.2i
192 \(bu
193 EAP-GTC
194 .TP 0.2i
195 \(bu
196 EAP-OTP
197 .RE
198 .TP 0.2i
199 \(bu
200 key management for CCMP, TKIP, WEP104, WEP40
201 .TP 0.2i
202 \(bu
203 RSN/WPA2 (IEEE 802.11i)
204 .RS
205 .TP 0.2i
206 \(bu
207 pre-authentication
208 .TP 0.2i
209 \(bu
210 PMKSA caching
211 .RE
212 .SH "AVAILABLE DRIVERS"
213 .PP
214 A summary of available driver backends is below. Support for each
215 of the driver backends is chosen at wpa_supplicant compile time. For a
216 list of supported driver backends that may be used with the -D option on
217 your system, refer to the help output of wpa_supplicant
218 (\fBwpa_supplicant -h\fR).
219 .TP
220 \fBhostap\fR
221 (default) Host AP driver (Intersil Prism2/2.5/3).
222 (this can also be used with Linuxant DriverLoader).
223 .TP
224 \fBhermes\fR
225 Agere Systems Inc. driver (Hermes-I/Hermes-II).
226 .TP
227 \fBmadwifi\fR
228 MADWIFI 802.11 support (Atheros, etc.).
229 .TP
230 \fBatmel\fR
231 ATMEL AT76C5XXx (USB, PCMCIA).
232 .TP
233 \fBwext\fR
234 Linux wireless extensions (generic).
235 .TP
236 \fBndiswrapper\fR
237 Linux ndiswrapper.
238 .TP
239 \fBbroadcom\fR
240 Broadcom wl.o driver.
241 .TP
242 \fBipw\fR
243 Intel ipw2100/2200 driver.
244 .TP
245 \fBwired\fR
246 wpa_supplicant wired Ethernet driver
247 .TP
248 \fBbsd\fR
249 BSD 802.11 support (Atheros, etc.).
250 .TP
251 \fBndis\fR
252 Windows NDIS driver.
253 .SH "COMMAND LINE OPTIONS"
254 .PP
255 Most command line options have global scope. Some are given per
256 interface, and are only valid if at least one \fB-i\fR option
257 is specified, otherwise they're ignored. Option groups for different
258 interfaces must be separated by \fB-N\fR option.
259 .TP
260 \fB-b br_ifname\fR
261 Optional bridge interface name. (Per interface)
262 .TP
263 \fB-B\fR
264 Run daemon in the background.
265 .TP
266 \fB-c filename\fR
267 Path to configuration file. (Per interface)
268 .TP
269 \fB-C ctrl_interface\fR
270 Path to ctrl_interface socket (Per interface. Only used if
271 \fB-c\fR is not).
272 .TP
273 \fB-i ifname\fR
274 Interface to listen on. Multiple instances of this option can
275 be present, one per interface, separated by \fB-N\fR
276 option (see below).
277 .TP
278 \fB-d\fR
279 Increase debugging verbosity (\fB-dd\fR even
280 more).
281 .TP
282 \fB-D driver\fR
283 Driver to use. (Per interface, see the available options
284 below.)
285 .TP
286 \fB-f output file\fR
287 Log output to specified file instead of stdout.
288 .TP
289 \fB-g global ctrl_interface\fR
290 Path to global ctrl_interface socket. If specified, interface
291 definitions may be omitted.
292 .TP
293 \fB-K\fR
294 Include keys (passwords, etc.) in debug output.
295 .TP
296 \fB-t\fR
297 Include timestamp in debug messages.
298 .TP
299 \fB-h\fR
300 Help. Show a usage message.
301 .TP
302 \fB-L\fR
303 Show license (GPL and BSD).
304 .TP
305 \fB-p\fR
306 Driver parameters. (Per interface)
307 .TP
308 \fB-P PID_file\fR
309 Path to PID file.
310 .TP
311 \fB-q\fR
312 Decrease debugging verbosity (\fB-qq\fR even
313 less).
314 .TP
315 \fB-u\fR
316 Enabled DBus control interface. If enabled, interface
317 definitions may be omitted.
318 .TP
319 \fB-v\fR
320 Show version.
321 .TP
322 \fB-W\fR
323 Wait for a control interface monitor before starting.
324 .TP
325 \fB-N\fR
326 Start describing new interface.
327 .SH "EXAMPLES"
328 .PP
329 In most common cases, \fBwpa_supplicant\fR is
330 started with:
331 .sp
332 .RS
334 .nf
335 wpa_supplicant -B -c/etc/wpa_supplicant.conf -iwlan0
336 .fi
337 .RE
338 .PP
339 This makes the process fork into background.
340 .PP
341 The easiest way to debug problems, and to get debug log for
342 bug reports, is to start \fBwpa_supplicant\fR on
343 foreground with debugging enabled:
344 .sp
345 .RS
347 .nf
348 wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
349 .fi
350 .RE
351 .PP
352 \fBwpa_supplicant\fR can control multiple
353 interfaces (radios) either by running one process for each
354 interface separately or by running just one process and list of
355 options at command line. Each interface is separated with -N
356 argument. As an example, following command would start
357 wpa_supplicant for two interfaces:
358 .sp
359 .RS
361 .nf
362 wpa_supplicant \\
363 -c wpa1.conf -i wlan0 -D hostap -N \\
364 -c wpa2.conf -i ath0 -D madwifi
365 .fi
366 .RE
367 .SH "OS REQUIREMENTS"
368 .PP
369 Current hardware/software requirements:
370 .TP 0.2i
371 \(bu
372 Linux kernel 2.4.x or 2.6.x with Linux Wireless
373 Extensions v15 or newer
374 .TP 0.2i
375 \(bu
376 FreeBSD 6-CURRENT
377 .TP 0.2i
378 \(bu
379 Microsoft Windows with WinPcap (at least WinXP, may work
380 with other versions)
381 .SH "SUPPORTED DRIVERS"
382 .TP
383 \fBHost AP driver for Prism2/2.5/3 (development snapshot/v0.2.x)\fR
384 (http://hostap.epitest.fi/) Driver needs to be set in
385 Managed mode (\fBiwconfig wlan0 mode managed\fR).
386 Please note that station firmware version needs to be 1.7.0 or
387 newer to work in WPA mode.
388 .TP
389 \fBLinuxant DriverLoader\fR
390 (http://www.linuxant.com/driverloader/)
391 with Windows NDIS driver for your wlan card supporting WPA.
392 .TP
393 \fBAgere Systems Inc. Linux Driver\fR
394 (http://www.agere.com/support/drivers/) Please note
395 that the driver interface file (driver_hermes.c) and hardware
396 specific include files are not included in the wpa_supplicant
397 distribution. You will need to copy these from the source
398 package of the Agere driver.
399 .TP
400 \fBmadwifi driver for cards based on Atheros chip set (ar521x)\fR
401 (http://sourceforge.net/projects/madwifi/) Please
402 note that you will need to modify the wpa_supplicant .config
403 file to use the correct path for the madwifi driver root
404 directory (CFLAGS += -I../madwifi/wpa line in example
405 defconfig).
406 .TP
407 \fBATMEL AT76C5XXx driver for USB and PCMCIA cards\fR
408 (http://atmelwlandriver.sourceforge.net/).
409 .TP
410 \fBLinux ndiswrapper\fR
411 (http://ndiswrapper.sourceforge.net/) with Windows
412 NDIS driver.
413 .TP
414 \fBBroadcom wl.o driver\fR
415 This is a generic Linux driver for Broadcom IEEE
416 802.11a/g cards. However, it is proprietary driver that is
417 not publicly available except for couple of exceptions, mainly
418 Broadcom-based APs/wireless routers that use Linux. The driver
419 binary can be downloaded, e.g., from Linksys support site
420 (http://www.linksys.com/support/gpl.asp) for Linksys
421 WRT54G. The GPL tarball includes cross-compiler and the needed
422 header file, wlioctl.h, for compiling wpa_supplicant. This
423 driver support in wpa_supplicant is expected to work also with
424 other devices based on Broadcom driver (assuming the driver
425 includes client mode support).
426 .TP
427 \fB Intel ipw2100 driver\fR
428 (http://sourceforge.net/projects/ipw2100/)
429 .TP
430 \fBIntel ipw2200 driver\fR
431 (http://sourceforge.net/projects/ipw2200/)
432 .TP
433 \fBLinux wireless extensions\fR
434 In theory, any driver that supports Linux wireless
435 extensions can be used with IEEE 802.1X (i.e., not WPA) when
436 using ap_scan=0 option in configuration file.
437 .TP
438 \fBWired Ethernet drivers\fR
439 Use ap_scan=0.
440 .TP
441 \fBBSD net80211 layer (e.g., Atheros driver)\fR
442 At the moment, this is for FreeBSD 6-CURRENT branch.
443 .TP
444 \fBWindows NDIS\fR
445 The current Windows port requires WinPcap
446 (http://winpcap.polito.it/). See README-Windows.txt for more
447 information.
448 .PP
449 wpa_supplicant was designed to be portable for different
450 drivers and operating systems. Hopefully, support for more wlan
451 cards and OSes will be added in the future. See developer.txt for
452 more information about the design of wpa_supplicant and porting to
453 other drivers. One main goal is to add full WPA/WPA2 support to
454 Linux wireless extensions to allow new drivers to be supported
455 without having to implement new driver-specific interface code in
456 wpa_supplicant.
457 .SH "ARCHITECTURE"
458 .PP
459 The
460 \fBwpa_supplicant\fR system consists of the following
461 components:
462 .TP
463 \fB\fIwpa_supplicant.conf\fB \fR
464 the configuration file describing all networks that the
465 user wants the computer to connect to.
466 .TP
467 \fBwpa_supplicant\fR
468 the program that directly interacts with the
469 network interface.
470 .TP
471 \fBwpa_cli\fR
472 the
473 client program that provides a high-level interface to the
474 functionality of the daemon.
475 .TP
476 \fBwpa_passphrase\fR
477 a utility needed to construct
478 \fIwpa_supplicant.conf\fR files that include
479 encrypted passwords.
480 .SH "QUICK START"
481 .PP
482 First, make a configuration file, e.g.
483 \fI/etc/wpa_supplicant.conf\fR, that describes the networks
484 you are interested in. See \fBwpa_supplicant.conf\fR(5)
485 for details.
486 .PP
487 Once the configuration is ready, you can test whether the
488 configuration works by running \fBwpa_supplicant\fR
489 with following command to start it on foreground with debugging
490 enabled:
491 .sp
492 .RS
494 .nf
495 wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -d
497 .fi
498 .RE
499 .PP
500 Assuming everything goes fine, you can start using following
501 command to start \fBwpa_supplicant\fR on background
502 without debugging:
503 .sp
504 .RS
506 .nf
507 wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B
509 .fi
510 .RE
511 .PP
512 Please note that if you included more than one driver
513 interface in the build time configuration (.config), you may need
514 to specify which interface to use by including -D<driver
515 name> option on the command line.
516 .SH "INTERFACE TO PCMCIA-CS/CARDMRG"
517 .PP
518 For example, following small changes to pcmcia-cs scripts
519 can be used to enable WPA support:
520 .PP
521 Add MODE="Managed" and WPA="y" to the network scheme in
522 \fI/etc/pcmcia/wireless.opts\fR\&.
523 .PP
524 Add the following block to the end of \fBstart\fR
525 action handler in \fI/etc/pcmcia/wireless\fR:
526 .sp
527 .RS
529 .nf
530 if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
531 /usr/local/bin/wpa_supplicant -B -c/etc/wpa_supplicant.conf -i$DEVICE
532 fi
534 .fi
535 .RE
536 .PP
537 Add the following block to the end of \fBstop\fR
538 action handler (may need to be separated from other actions) in
539 \fI/etc/pcmcia/wireless\fR:
540 .sp
541 .RS
543 .nf
544 if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
545 killall wpa_supplicant
546 fi
548 .fi
549 .RE
550 .PP
551 This will make \fBcardmgr\fR start
552 \fBwpa_supplicant\fR when the card is plugged
553 in.
554 .SH "SEE ALSO"
555 .PP
556 \fBwpa_background\fR(8)
557 \fBwpa_supplicant.conf\fR(5)
558 \fBwpa_cli\fR(8)
559 \fBwpa_passphrase\fR(8)
560 .SH "LEGAL"
561 .PP
562 wpa_supplicant is copyright (c) 2003-2007,
563 Jouni Malinen <j@w1.fi> and
564 contributors.
565 All Rights Reserved.
566 .PP
567 This program is dual-licensed under both the GPL version 2
568 and BSD license. Either license may be used at your option.