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" "02 December 2018" "" ""
   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-BddfhKLqqsTtuvW\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 \fBwext\fR
 221 Linux wireless extensions (generic).
 222 .TP
 223 \fBwired\fR
 224 wpa_supplicant wired Ethernet driver
 225 .TP
 226 \fBroboswitch\fR
 227 wpa_supplicant Broadcom switch driver
 228 .TP
 229 \fBbsd\fR
 230 BSD 802.11 support (Atheros, etc.).
 231 .TP
 232 \fBndis\fR
 233 Windows NDIS driver.
 234 .SH "COMMAND LINE OPTIONS"
 235 .PP
 236 Most command line options have global scope. Some are given per
 237 interface, and are only valid if at least one \fB-i\fR option
 238 is specified, otherwise they're ignored. Option groups for different
 239 interfaces must be separated by \fB-N\fR option.
 240 .TP
 241 \fB-b br_ifname\fR
 242 Optional bridge interface name. (Per interface)
 243 .TP
 244 \fB-B\fR
 245 Run daemon in the background.
 246 .TP
 247 \fB-c filename\fR
 248 Path to configuration file. (Per interface)
 249 .TP
 250 \fB-C ctrl_interface\fR
 251 Path to ctrl_interface socket (Per interface. Only used if
 252 \fB-c\fR is not).
 253 .TP
 254 \fB-i ifname\fR
 255 Interface to listen on. Multiple instances of this option can
 256 be present, one per interface, separated by \fB-N\fR
 257 option (see below).
 258 .TP
 259 \fB-d\fR
 260 Increase debugging verbosity (\fB-dd\fR even
 261 more).
 262 .TP
 263 \fB-D driver\fR
 264 Driver to use (can be multiple drivers: nl80211,wext).
 265 (Per interface, see the available options below.)
 266 .TP
 267 \fB-e entropy file\fR
 268 File for \fBwpa_supplicant\fR to use to
 269 maintain its internal entropy store in over restarts.
 270 .TP
 271 \fB-f output file\fR
 272 Log output to specified file instead of stdout. (This
 273 is only available if \fBwpa_supplicant\fR was
 274 built with the CONFIG_DEBUG_FILE
 275 option.)
 276 .TP
 277 \fB-g global ctrl_interface\fR
 278 Path to global ctrl_interface socket. If specified, interface
 279 definitions may be omitted.
 280 .TP
 281 \fB-K\fR
 282 Include keys (passwords, etc.) in debug output.
 283 .TP
 284 \fB-h\fR
 285 Help.  Show a usage message.
 286 .TP
 287 \fB-L\fR
 288 Show license (BSD).
 289 .TP
 290 \fB-o override driver\fR
 291 Override the driver parameter for new
 292 interfaces.
 293 .TP
 294 \fB-O override ctrl_interface\fR
 295 Override the ctrl_interface parameter for new
 296 interfaces.
 297 .TP
 298 \fB-p\fR
 299 Driver parameters. (Per interface)
 300 .TP
 301 \fB-P PID_file\fR
 302 Path to PID file.
 303 .TP
 304 \fB-q\fR
 305 Decrease debugging verbosity (\fB-qq\fR even
 306 less).
 307 .TP
 308 \fB-s\fR
 309 Log output to syslog instead of stdout. (This is only
 310 available if \fBwpa_supplicant\fR was built
 311 with the CONFIG_DEBUG_SYSLOG
 312 option.)
 313 .TP
 314 \fB-T\fR
 315 Log output to Linux tracing in addition to any other
 316 destinations. (This is only available
 317 if \fBwpa_supplicant\fR was built with
 318 the CONFIG_DEBUG_LINUX_TRACING
 319 option.)
 320 .TP
 321 \fB-t\fR
 322 Include timestamp in debug messages.
 323 .TP
 324 \fB-u\fR
 325 Enable DBus control interface. If enabled, interface
 326 definitions may be omitted. (This is only available
 327 if \fBwpa_supplicant\fR was built with
 328 the CONFIG_DBUS option.)
 329 .TP
 330 \fB-v\fR
 331 Show version.
 332 .TP
 333 \fB-W\fR
 334 Wait for a control interface monitor before starting.
 335 .TP
 336 \fB-N\fR
 337 Start describing new interface.
 338 .SH "EXAMPLES"
 339 .PP
 340 In most common cases, \fBwpa_supplicant\fR is
 341 started with:
 342 .sp
 343 .RS
 344
 345 .nf
 346 wpa_supplicant -B -c/etc/wpa_supplicant.conf -iwlan0
 347 .fi
 348 .RE
 349 .PP
 350 This makes the process fork into background.
 351 .PP
 352 The easiest way to debug problems, and to get debug log for
 353 bug reports, is to start \fBwpa_supplicant\fR on
 354 foreground with debugging enabled:
 355 .sp
 356 .RS
 357
 358 .nf
 359 wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
 360 .fi
 361 .RE
 362 .PP
 363 If the specific driver wrapper is not known beforehand, it is
 364 possible to specify multiple comma separated driver wrappers on the command
 365 line. \fBwpa_supplicant\fR will use the first driver
 366 wrapper that is able to initialize the interface.
 367 .sp
 368 .RS
 369
 370 .nf
 371 wpa_supplicant -Dnl80211,wext -c/etc/wpa_supplicant.conf -iwlan0
 372 .fi
 373 .RE
 374 .PP
 375 \fBwpa_supplicant\fR can control multiple
 376 interfaces (radios) either by running one process for each
 377 interface separately or by running just one process and list of
 378 options at command line. Each interface is separated with -N
 379 argument. As an example, following command would start
 380 wpa_supplicant for two interfaces:
 381 .sp
 382 .RS
 383
 384 .nf
 385 wpa_supplicant \\
 386         -c wpa1.conf -i wlan0 -D nl80211 -N \\
 387         -c wpa2.conf -i ath0 -D wext
 388 .fi
 389 .RE
 390 .SH "OS REQUIREMENTS"
 391 .PP
 392 Current hardware/software requirements:
 393 .TP 0.2i
 394 \(bu
 395 Linux kernel 2.4.x or 2.6.x with Linux Wireless
 396 Extensions v15 or newer
 397 .TP 0.2i
 398 \(bu
 399 FreeBSD 6-CURRENT
 400 .TP 0.2i
 401 \(bu
 402 Microsoft Windows with WinPcap (at least WinXP, may work
 403 with other versions)
 404 .SH "SUPPORTED DRIVERS"
 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.conf\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 \fBstart\fR
 498 action handler 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 -B -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 \fBstop\fR
 511 action handler (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.
 527 .SH "SEE ALSO"
 528 .PP
 529 \fBwpa_background\fR(8)
 530 \fBwpa_supplicant.conf\fR(5)
 531 \fBwpa_cli\fR(8)
 532 \fBwpa_passphrase\fR(8)
 533 .SH "LEGAL"
 534 .PP
 535 wpa_supplicant is copyright (c) 2003-2018,
 536 Jouni Malinen <j@w1.fi> and
 537 contributors.
 538 All Rights Reserved.
 539 .PP
 540 This program is licensed under the BSD license (the one with
 541 advertisement clause removed).