contrib/wpa_supplicant/doc/docbook/wpa_supplicant.8

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