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" "08 February 2006" "" ""
   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-BddehLqqvw\fR ] [ \fB-i\fIifname\fB\fR ] [ \fB-c\fIconfig file\fB\fR ] [ \fB-D\fIdriver\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-D driver\fR
 264 Driver to use.  See the available options below.
 265 .TP
 266 \fB-d\fR
 267 Increase debugging verbosity (-dd even more).
 268 .TP
 269 \fB-K\fR
 270 Include keys (passwords, etc.) in debug output.
 271 .TP
 272 \fB-t\fR
 273 Include timestamp in debug messages.
 274 .TP
 275 \fB-e\fR
 276 Use external IEEE 802.1X Supplicant (e.g.,
 277 \fBxsupplicant\fR) (this disables the internal
 278 Supplicant).
 279 .TP
 280 \fB-h\fR
 281 Help.  Show a usage message.
 282 .TP
 283 \fB-L\fR
 284 Show license (GPL and BSD).
 285 .TP
 286 \fB-q\fR
 287 Decrease debugging verbosity (-qq even less).
 288 .TP
 289 \fB-v\fR
 290 Show version.
 291 .TP
 292 \fB-w\fR
 293 wait for interface to be added, if needed.  normally,
 294 \fBwpa_supplicant\fR will exit if the interface
 295 is not there yet.
 296 .TP
 297 \fB-N\fR
 298 Start describing new interface.
 299 .SH "EXAMPLES"
 300 .PP
 301 In most common cases, \fBwpa_supplicant\fR is
 302 started with:
 303 .sp
 304 .RS
 305
 306 .nf
 307 wpa_supplicant -Bw -c/etc/wpa_supplicant.conf -iwlan0
 308 .fi
 309 .RE
 310 .PP
 311 This makes the process fork into background and wait for the wlan0
 312 interface if it is not available at startup time.
 313 .PP
 314 The easiest way to debug problems, and to get debug log for
 315 bug reports, is to start \fBwpa_supplicant\fR on
 316 foreground with debugging enabled:
 317 .sp
 318 .RS
 319
 320 .nf
 321 wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
 322 .fi
 323 .RE
 324 .PP
 325 \fBwpa_supplicant\fR can control multiple
 326 interfaces (radios) either by running one process for each
 327 interface separately or by running just one process and list of
 328 options at command line. Each interface is separated with -N
 329 argument. As an example, following command would start
 330 wpa_supplicant for two interfaces:
 331 .sp
 332 .RS
 333
 334 .nf
 335 wpa_supplicant \\
 336         -c wpa1.conf -i wlan0 -D hostap -N \\
 337         -c wpa2.conf -i ath0 -D madwifi
 338 .fi
 339 .RE
 340 .SH "OS REQUIREMENTS"
 341 .PP
 342 Current hardware/software requirements:
 343 .TP 0.2i
 344 \(bu
 345 Linux kernel 2.4.x or 2.6.x with Linux Wireless
 346 Extensions v15 or newer
 347 .TP 0.2i
 348 \(bu
 349 FreeBSD 6-CURRENT
 350 .TP 0.2i
 351 \(bu
 352 Microsoft Windows with WinPcap (at least WinXP, may work
 353 with other versions)
 354 .SH "SUPPORTED DRIVERS"
 355 .TP
 356 \fBHost AP driver for Prism2/2.5/3 (development snapshot/v0.2.x)\fR
 357 (http://hostap.epitest.fi/) Driver needs to be set in
 358 Managed mode ('iwconfig wlan0 mode managed').  Please note
 359 that station firmware version needs to be 1.7.0 or newer to
 360 work in WPA mode.
 361 .TP
 362 \fBLinuxant DriverLoader\fR
 363 (http://www.linuxant.com/driverloader/)
 364 with Windows NDIS driver for your wlan card supporting WPA.
 365 .TP
 366 \fBAgere Systems Inc. Linux Driver\fR
 367 (http://www.agere.com/support/drivers/) Please note
 368 that the driver interface file (driver_hermes.c) and hardware
 369 specific include files are not included in the wpa_supplicant
 370 distribution. You will need to copy these from the source
 371 package of the Agere driver.
 372 .TP
 373 \fBmadwifi driver for cards based on Atheros chip set (ar521x)\fR
 374 (http://sourceforge.net/projects/madwifi/) Please
 375 note that you will need to modify the wpa_supplicant .config
 376 file to use the correct path for the madwifi driver root
 377 directory (CFLAGS += -I../madwifi/wpa line in example
 378 defconfig).
 379 .TP
 380 \fBATMEL AT76C5XXx driver for USB and PCMCIA cards\fR
 381 (http://atmelwlandriver.sourceforge.net/).
 382 .TP
 383 \fBLinux ndiswrapper\fR
 384 (http://ndiswrapper.sourceforge.net/) with Windows
 385 NDIS driver.
 386 .TP
 387 \fBBroadcom wl.o driver\fR
 388 This is a generic Linux driver for Broadcom IEEE
 389 802.11a/g cards.  However, it is proprietary driver that is
 390 not publicly available except for couple of exceptions, mainly
 391 Broadcom-based APs/wireless routers that use Linux. The driver
 392 binary can be downloaded, e.g., from Linksys support site
 393 (http://www.linksys.com/support/gpl.asp) for Linksys
 394 WRT54G. The GPL tarball includes cross-compiler and the needed
 395 header file, wlioctl.h, for compiling wpa_supplicant.  This
 396 driver support in wpa_supplicant is expected to work also with
 397 other devices based on Broadcom driver (assuming the driver
 398 includes client mode support).
 399 .TP
 400 \fB Intel ipw2100 driver\fR
 401 (http://sourceforge.net/projects/ipw2100/)
 402 .TP
 403 \fBIntel ipw2200 driver\fR
 404 (http://sourceforge.net/projects/ipw2200/)
 405 .TP
 406 \fBLinux wireless extensions\fR
 407 In theory, any driver that supports Linux wireless
 408 extensions can be used with IEEE 802.1X (i.e., not WPA) when
 409 using ap_scan=0 option in configuration file.
 410 .TP
 411 \fBWired Ethernet drivers\fR
 412 Use ap_scan=0.
 413 .TP
 414 \fBBSD net80211 layer (e.g., Atheros driver)\fR
 415 At the moment, this is for FreeBSD 6-CURRENT branch.
 416 .TP
 417 \fBWindows NDIS\fR
 418 The current Windows port requires WinPcap
 419 (http://winpcap.polito.it/).  See README-Windows.txt for more
 420 information.
 421 .PP
 422 wpa_supplicant was designed to be portable for different
 423 drivers and operating systems. Hopefully, support for more wlan
 424 cards and OSes will be added in the future. See developer.txt for
 425 more information about the design of wpa_supplicant and porting to
 426 other drivers. One main goal is to add full WPA/WPA2 support to
 427 Linux wireless extensions to allow new drivers to be supported
 428 without having to implement new driver-specific interface code in
 429 wpa_supplicant.
 430 .SH "ARCHITECTURE"
 431 .PP
 432 The
 433 \fBwpa_supplicant\fR system consists of the following
 434 components:
 435 .TP
 436 \fB\fIwpa_supplicant.conf\fB \fR
 437 the configuration file describing all networks that the
 438 user wants the computer to connect to.
 439 .TP
 440 \fBwpa_supplicant\fR
 441 the program that directly interacts with the
 442 network interface.
 443 .TP
 444 \fBwpa_cli\fR
 445 the
 446 client program that provides a high-level interface to the
 447 functionality of the daemon.
 448 .TP
 449 \fBwpa_passphrase\fR
 450 a utility needed to construct
 451 \fIwpa_supplicant.conf\fR files that include
 452 encrypted passwords.
 453 .SH "QUICK START"
 454 .PP
 455 First, make a configuration file, e.g.
 456 \fI/etc/wpa_supplicant.conf\fR, that describes the networks
 457 you are interested in.  See \fBwpa_supplicant\fR(5)
 458 for details.
 459 .PP
 460 Once the configuration is ready, you can test whether the
 461 configuration works by running \fBwpa_supplicant\fR
 462 with following command to start it on foreground with debugging
 463 enabled:
 464 .sp
 465 .RS
 466
 467 .nf
 468 wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -d
 469
 470 .fi
 471 .RE
 472 .PP
 473 Assuming everything goes fine, you can start using following
 474 command to start \fBwpa_supplicant\fR on background
 475 without debugging:
 476 .sp
 477 .RS
 478
 479 .nf
 480 wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B
 481
 482 .fi
 483 .RE
 484 .PP
 485 Please note that if you included more than one driver
 486 interface in the build time configuration (.config), you may need
 487 to specify which interface to use by including -D<driver
 488 name> option on the command line.
 489 .SH "INTERFACE TO PCMCIA-CS/CARDMRG"
 490 .PP
 491 For example, following small changes to pcmcia-cs scripts
 492 can be used to enable WPA support:
 493 .PP
 494 Add MODE="Managed" and WPA="y" to the network scheme in
 495 \fI/etc/pcmcia/wireless.opts\fR\&.
 496 .PP
 497 Add the following block to the end of 'start' action handler
 498 in \fI/etc/pcmcia/wireless\fR:
 499 .sp
 500 .RS
 501
 502 .nf
 503 if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
 504     /usr/local/bin/wpa_supplicant -Bw -c/etc/wpa_supplicant.conf -i$DEVICE
 505 fi
 506
 507 .fi
 508 .RE
 509 .PP
 510 Add the following block to the end of 'stop' action handler
 511 (may need to be separated from other actions) in
 512 \fI/etc/pcmcia/wireless\fR:
 513 .sp
 514 .RS
 515
 516 .nf
 517 if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
 518     killall wpa_supplicant
 519 fi
 520
 521 .fi
 522 .RE
 523 .PP
 524 This will make \fBcardmgr\fR start
 525 \fBwpa_supplicant\fR when the card is plugged
 526 in. \fBwpa_supplicant\fR will wait until the
 527 interface is set up--either when a static IP address is configured
 528 or when DHCP client is started--and will then negotiate keys with
 529 the AP.
 530 .SH "SEE ALSO"
 531 .PP
 532 \fBwpa_background\fR(8)
 533 \fBwpa_supplicant.conf\fR(5)
 534 \fBwpa_cli\fR(8)
 535 \fBwpa_passphrase\fR(8)
 536 .SH "LEGAL"
 537 .PP
 538 wpa_supplicant is copyright (c) 2003-2005,
 539 Jouni Malinen <jkmaline@cc.hut.fi> and
 540 contributors.
 541 All Rights Reserved.
 542 .PP
 543 This program is dual-licensed under both the GPL version 2
 544 and BSD license. Either license may be used at your option.