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