www/wpa_supplicant/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3   <head>
   4     <title>Linux WPA Supplicant (IEEE 802.1X, WPA, WPA2, RSN, IEEE 802.11i)</title>
   5     <meta name="description" content="WPA Supplicant for Linux, BSD, and Windows (IEEE 802.1X, WPA, WPA2, RSN, IEEE 802.11i)">
   6     <meta name="keywords" content="WPA, WPA2, IEEE 802.11i, IEEE 802.1X, WPA Supplicant, wpa_supplicant, TKIP, CCMP, EAP-PEAP, EAP-TLS, EAP-TTLS, EAP-SIM, EAP-AKA, EAP-PSK, EAP-GTC, EAP-MSCHAPv2, EAP-MD5, EAP-FAST, EAP-PAX, EAP-IKEv2IEEE 802.1X Supplicant, IEEE 802.1aa, EAPOL, RSN, pre-authentication, PMKSA caching, BSD WPA Supplicant, FreeBSD WPA Supplicant, wireless, WinXP WPA Supplicant, EAP-TNC, TNCC, IF-IMC, IF-TNCCS, WPS">
   7     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   8   </head>
   9
  10   <body>
  11     <h2>Linux WPA/WPA2/IEEE 802.1X Supplicant</h2>
  12
  13 <p>wpa_supplicant is a WPA Supplicant for Linux, BSD, Mac OS X, and
  14 Windows with
  15 support for WPA and WPA2 (IEEE 802.11i / RSN). It is suitable for both
  16 desktop/laptop computers and embedded systems. Supplicant is the IEEE
  17 802.1X/WPA component that is used in the client stations. It
  18 implements key negotiation with a WPA Authenticator and it controls
  19 the roaming and IEEE 802.11 authentication/association of the wlan
  20 driver.</p>
  21
  22 <p>wpa_supplicant is designed to be a "daemon" program that runs in the
  23 background and acts as the backend component controlling the wireless
  24 connection. wpa_supplicant supports separate frontend programs and a
  25 text-based frontend (wpa_cli) and a GUI (wpa_gui) are included with
  26 wpa_supplicant.</p>
  27
  28 <p>wpa_supplicant uses a flexible build configuration that can be used
  29 to select which features are included. This allows minimal code size
  30 (from ca. 50 kB binary for WPA/WPA2-Personal and 130 kB binary for
  31 WPA/WPA2-Enterprise without debugging code to 450 kB with most
  32 features and full debugging support; these example sizes are from a
  33 build for x86 target).</p>
  34
  35
  36 <h4>Supported WPA/IEEE 802.11i features</h4>
  37
  38 <ul>
  39 <li>WPA-PSK ("WPA-Personal")</li>
  40 <li>WPA with EAP (e.g., with RADIUS authentication server) ("WPA-Enterprise")</li>
  41 <li>key management for CCMP, TKIP, WEP104, WEP40</li>
  42 <li>WPA and full IEEE 802.11i/RSN/WPA2</li>
  43 <li>RSN: PMKSA caching, pre-authentication</li>
  44 <li>IEEE 802.11r</li>
  45 <li>IEEE 802.11w</li>
  46 <li>Wi-Fi Protected Setup (WPS)</li>
  47 </ul>
  48
  49 <h4>Supported EAP methods (IEEE 802.1X Supplicant)</h4>
  50
  51 <ul>
  52 <li>EAP-TLS</li>
  53 <li>EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1)</li>
  54 <li>EAP-PEAP/TLS (both PEAPv0 and PEAPv1)</li>
  55 <li>EAP-PEAP/GTC (both PEAPv0 and PEAPv1)</li>
  56 <li>EAP-PEAP/OTP (both PEAPv0 and PEAPv1)</li>
  57 <li>EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1)</li>
  58 <li>EAP-TTLS/EAP-MD5-Challenge</li>
  59 <li>EAP-TTLS/EAP-GTC</li>
  60 <li>EAP-TTLS/EAP-OTP</li>
  61 <li>EAP-TTLS/EAP-MSCHAPv2</li>
  62 <li>EAP-TTLS/EAP-TLS</li>
  63 <li>EAP-TTLS/MSCHAPv2</li>
  64 <li>EAP-TTLS/MSCHAP</li>
  65 <li>EAP-TTLS/PAP</li>
  66 <li>EAP-TTLS/CHAP</li>
  67 <li>EAP-SIM</li>
  68 <li>EAP-AKA</li>
  69 <li>EAP-AKA'</li>
  70 <li>EAP-PSK</li>
  71 <li>EAP-FAST</li>
  72 <li>EAP-PAX</li>
  73 <li>EAP-SAKE</li>
  74 <li>EAP-IKEv2</li>
  75 <li>EAP-GPSK</li>
  76 <li>LEAP (note: requires special support from the driver)</li>
  77 </ul>
  78
  79 <p>Following methods are also supported, but since they do not generate keying
  80 material, they cannot be used with WPA or IEEE 802.1X WEP keying.</p>
  81
  82 <ul>
  83 <li>EAP-MD5-Challenge</li>
  84 <li>EAP-MSCHAPv2</li>
  85 <li>EAP-GTC</li>
  86 <li>EAP-OTP</li>
  87 <li>EAP-TNC (Trusted Network Connect; TNCC, IF-IMC, IF-T, IF-TNCCS)</li>
  88 </ul>
  89
  90 <p>More information about EAP methods and interoperability testing is
  91 available in <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/eap_testing.txt">eap_testing.txt</a>.</p>
  92
  93
  94 <h4>Supported TLS/crypto libraries</h4>
  95
  96 <ul>
  97 <li>OpenSSL (default)</li>
  98 <li>GnuTLS</li>
  99 </ul>
 100
 101 <h4>Internal TLS/crypto implementation (optional)</h4>
 102
 103 <ul>
 104 <li>can be used in place of an external TLS/crypto library</li>
 105 <li>TLSv1</li>
 106 <li>X.509 certificate processing</li>
 107 <li>PKCS #1</li>
 108 <li>ASN.1</li>
 109 <li>RSA</li>
 110 <li>bignum</li>
 111 <li>minimal size (ca. 50 kB binary, parts of which are already needed for WPA;
 112   TLSv1/X.509/ASN.1/RSA/bignum parts are about 25 kB on x86)</li>
 113 </ul>
 114
 115 <h4>Supported wireless cards/drivers</h4>
 116
 117 <ul>
 118 <li>Linux drivers that support Linux Wireless Extensions v19 or newer with
 119 WPA/WPA2 extensions</li>
 120 <li><a href="http://hostap.epitest.fi/">Host AP driver for Prism2/2.5/3</a> (WPA and WPA2)</li>
 121 <li><a href="http://www.linuxant.com/driverloader/">Linuxant DriverLoader</a> with Windows NDIS driver supporting WPA/WPA2</li>
 122 <li><a href="http://www.agere.com/support/drivers/">Agere Systems Inc. Linux Driver</a> (Hermes-I/Hermes-II chipset) (WPA, but not WPA2)</li>
 123 <li><a href="http://sourceforge.net/projects/madwifi/">madwifi (Atheros ar521x)</a></li>
 124 <li><a href="http://atmelwlandriver.sourceforge.net/">ATMEL AT76C5XXx</a></li>
 125 <li><a href="http://ndiswrapper.sourceforge.net/">Linux ndiswrapper</a></li>
 126 <li>Broadcom wl.o driver</li>
 127 <li><a href="http://sourceforge.net/projects/ipw2100/">Intel ipw2100</a></li>
 128 <li><a href="http://sourceforge.net/projects/ipw2200/">Intel ipw2200</a></li>
 129 <li>Wired Ethernet drivers</li>
 130 <li>BSD net80211 layer (e.g., Atheros driver) (FreeBSD 6-CURRENT and NetBSD current)</li>
 131 <li>Windows NDIS drivers (Windows; at least XP and 2000, others not tested)</li>
 132 </ul>
 133
 134 <p>wpa_supplicant was designed to be portable for different drivers and
 135 operating systems. Hopefully, support for more wlan cards and OSes will be
 136 added in the future. See <a href="devel/">developers' documentation</a>
 137 for more information about the design of wpa_supplicant and porting to
 138 other drivers.</p>
 139
 140 <h3><a name="download">Download</a></h3>
 141
 142 <p>
 143 <b>wpa_supplicant</b><br>
 144 Copyright (c) 2003-2009, Jouni Malinen &lt;j@w1.fi&gt;
 145 and contributors.
 146 </p>
 147
 148 <p>
 149 This program is free software; you can redistribute it and/or modify
 150 it under the terms of the GNU General Public License version 2 as
 151 published by the Free Software Foundation. See
 152 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=COPYING">COPYING</a>
 153 for more details.
 154 </p>
 155
 156 <p>Alternatively, this software may be distributed, used, and modified
 157 under the terms of BSD license. See <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/README">README</a>
 158 for more details.</p>
 159
 160 <p>
 161 <b>Please see
 162 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/README">README</a>
 163 for the current documentation.</b><br>
 164 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/README-Windows.txt">README-Windows.txt</a>
 165 has some more information about the Windows port of wpa_supplicant.</p>
 166
 167
 168 <ul>
 169 <li><a href="../releases.html">Release graph</a></li>
 170 <li>Latest stable release:
 171 <ul>
 172 <li><a href="../releases/wpa_supplicant-0.6.8.tar.gz">wpa_supplicant-0.6.8.tar.gz</a> (source code for all versions)</li>
 173 <li><a href="../releases/wpa_supplicant-0.6.8.exe">wpa_supplicant-0.6.8.exe</a> (binary installer for Windows)</li>
 174 <li><a href="../releases/wpa_supplicant-windows-bin-0.6.8.zip">wpa_supplicant-windows-bin-0.6.8.zip</a> (binaries for Windows)</li>
 175 <li><a href="qt4/wpa_gui-qt433-windows-dll.zip">wpa_gui-qt433-windows-dll.zip</a> (Qt4 libraries from wpa_gui/Windows)</li>
 176 </ul>
 177 <li>Older stable release:
 178 <ul>
 179 <li><a href="../releases/wpa_supplicant-0.5.11.tar.gz">wpa_supplicant-0.5.11.tar.gz</a></li>
 180 <li><a href="../releases/wpa_supplicant-windows-bin-0.5.11.zip">wpa_supplicant-windows-bin-0.5.11.zip</a> (binaries for Windows)</li>
 181 </ul>
 182 <!--
 183 <li>Latest development release:
 184 <ul>
 185 <li><a href="../releases/wpa_supplicant-0.7.0.tar.gz">wpa_supplicant-0.7.0.tar.gz</a> (source code for all versions)</li>
 186 <li><a href="../releases/wpa_supplicant-0.7.0.exe">wpa_supplicant-0.7.0.exe</a> (binary installer for Windows)</li>
 187 <li><a href="../releases/wpa_supplicant-windows-bin-0.7.0.zip">wpa_supplicant-windows-bin-0.7.0.zip</a> (binaries for Windows)</li>
 188 </ul>
 189 -->
 190 <li>ChangeLog:
 191 <ul>
 192 <li><a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/ChangeLog">development branch</a></li>
 193 <li><a href="/gitweb/gitweb.cgi?p=hostap-06.git;a=blob_plain;f=wpa_supplicant/ChangeLog">stable branch</a></li>
 194 </ul>
 195 <li><a href="../releases/">Old releases</a></li>
 196 <li><a href="http://lists.shmoo.com/mailman/listinfo/hostap">Mailing list</a></li>
 197 <li><a href="http://lists.shmoo.com/pipermail/hostap/">New mailing list archives</a></li>
 198 <li><a href="/gitweb/gitweb.cgi">Web interface to GIT repository (0.6.x and newer)</a></li>
 199 <li><a href="/cgi-bin/viewcvs.cgi/hostap/">Web interface to CVS repository (0.5.x and older)</a></li>
 200 <li><a href="../releases/snapshots/">Snapshot releases from all active branches</a>
 201 <li><a href="../cvs.html">GIT and read-only anonymous CVS access (pserver)</a></li>
 202 <li><a href="../bugz/">Bug and feature request tracking</a></li>
 203 <li><a href="devel/">Developers' documentation for wpa_supplicant 0.6.x</a></li>
 204 <li><a href="wpa_gui.html">wpa_gui screenshots</a></li>
 205 </ul>
 206
 207 <h3>WPA</h3>
 208
 209 <p>The original security mechanism of IEEE 802.11 standard was not
 210 designed to be strong and has proven to be insufficient for most
 211 networks that require some kind of security. Task group I (Security)
 212 of <a href="http://www.ieee802.org/11/">IEEE 802.11 working group</a>
 213 has worked to address the flaws of the base standard and in
 214 practice completed its work in May 2004. The IEEE 802.11i amendment to
 215 the IEEE 802.11 standard was approved in June 2004 and published in
 216 July 2004.</p>
 217
 218 <p><a href="http://www.wi-fi.org/">Wi-Fi Alliance</a> used a draft
 219 version of the IEEE 802.11i work (draft 3.0) to define a subset of the
 220 security enhancements that can be implemented with existing wlan
 221 hardware. This is called Wi-Fi Protected Access (WPA). This has
 222 now become a mandatory component of interoperability testing and
 223 certification done by Wi-Fi Alliance. Wi-Fi has
 224 <a href="http://www.wi-fi.org/OpenSection/protected_access.asp">information
 225 about WPA</a> at its web site.</p>
 226
 227 <p>IEEE 802.11 standard defined wired equivalent privacy (WEP) algorithm
 228 for protecting wireless networks. WEP uses RC4 with 40-bit keys,
 229 24-bit initialization vector (IV), and CRC32 to protect against packet
 230 forgery. All these choices have proven to be insufficient: key space is
 231 too small against current attacks, RC4 key scheduling is insufficient
 232 (beginning of the pseudorandom stream should be skipped), IV space is
 233 too small and IV reuse makes attacks easier, there is no replay
 234 protection, and non-keyed authentication does not protect against bit
 235 flipping packet data.</p>
 236
 237 <p>WPA is an intermediate solution for the security issues. It uses
 238 Temporal Key Integrity Protocol (TKIP) to replace WEP. TKIP is a
 239 compromise on strong security and possibility to use existing
 240 hardware. It still uses RC4 for the encryption like WEP, but with
 241 per-packet RC4 keys. In addition, it implements replay protection,
 242 keyed packet authentication mechanism (Michael MIC).</p>
 243
 244 <p>Keys can be managed using two different mechanisms. WPA can either use
 245 an external authentication server (e.g., RADIUS) and EAP just like
 246 IEEE 802.1X is using or pre-shared keys without need for additional
 247 servers. Wi-Fi calls these "WPA-Enterprise" and "WPA-Personal",
 248 respectively. Both mechanisms will generate a master session key for
 249 the Authenticator (AP) and Supplicant (client station).</p>
 250
 251 <p>WPA implements a new key handshake (4-Way Handshake and Group Key
 252 Handshake) for generating and exchanging data encryption keys between
 253 the Authenticator and Supplicant. This handshake is also used to
 254 verify that both Authenticator and Supplicant know the master session
 255 key. These handshakes are identical regardless of the selected key
 256 management mechanism (only the method for generating master session
 257 key changes).</p>
 258
 259
 260 <h3>IEEE 802.11i / RSN / WPA2</h3>
 261
 262 <p>The design for parts of IEEE 802.11i that were not included in WPA
 263 has finished (May 2004) and this amendment to IEEE 802.11 was approved
 264 in June 2004. Wi-Fi Alliance is using the final IEEE 802.11i as a new
 265 version of WPA called WPA2. This included, e.g., support for more
 266 robust encryption algorithm (CCMP: AES in Counter mode with CBC-MAC)
 267 to replace TKIP, optimizations for handoff (reduced number of messages
 268 in initial key handshake, pre-authentication, and PMKSA caching).</p>
 269
 270 <h3>Using wpa_supplicant</h3>
 271
 272 <p>Following steps are used when associating with an AP using WPA:<p>
 273 <ul>
 274 <li>wpa_supplicant requests the kernel driver to scan neighboring BSSes</li>
 275 <li>wpa_supplicant selects a BSS based on its configuration</li>
 276 <li>wpa_supplicant requests the kernel driver to associate with the chosen
 277   BSS</li>
 278 <li>if WPA-EAP: integrated IEEE 802.1X Supplicant completes EAP
 279   authentication with the authentication server (proxied by the
 280   Authenticator in the AP)</li>
 281 <li>If WPA-EAP: master key is received from the IEEE 802.1X Supplicant</li>
 282 <li>If WPA-PSK: wpa_supplicant uses PSK as the master session key</li>
 283 <li>wpa_supplicant completes WPA 4-Way Handshake and Group Key Handshake
 284   with the Authenticator (AP). WPA2 has integrated the initial Group Key
 285   Handshake into the 4-Way Handshake.</li>
 286 <li>wpa_supplicant configures encryption keys for unicast and broadcast</li>
 287 <li>normal data packets can be transmitted and received</li>
 288 </ul>
 289
 290 <h4>Configuration file</h4>
 291
 292 <p>wpa_supplicant is configured using a text file that lists all accepted
 293 networks and security policies, including pre-shared keys. See
 294 example configuration file,
 295 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/wpa_supplicant.conf">wpa_supplicant.conf</a>,
 296 for detailed information about the configuration format and supported
 297 fields. In addition, simpler example configurations are available for
 298 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/examples/plaintext.conf">plaintext</a>,
 299 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/examples/wep.conf">static WEP</a>,
 300 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/examples/ieee8021x.conf">IEEE 802.1X with dynamic WEP (EAP-PEAP/MSCHAPv2)</a>,
 301 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/examples/wpa-psk-tkip.conf">WPA-PSK/TKIP</a>, and
 302 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/examples/wpa2-eap-ccmp.conf">WPA2-EAP/CCMP (EAP-TLS)</a>.
 303 In addition, wpa_supplicant can use OpenSSL engine to avoid need for
 304 exposing private keys in the file system. This can be used for EAP-TLS
 305 authentication with smartcards and TPM tokens.
 306 <a href="/gitweb/gitweb.cgi?p=hostap.git;a=blob_plain;f=wpa_supplicant/examples/openCryptoki.conf">Example configuration for using openCryptoki</a>
 307 shows an example network block and related parameters for EAP-TLS
 308 authentication using PKCS#11 TPM token.
 309 </p>
 310
 311 <h3>Feedback, comments, mailing list</h3>
 312
 313 <p>
 314 Any comments, reports on success/failure, ideas for further
 315 improvement, feature requests, etc. are welcome at j@w1.fi.
 316 Please note, that I often receive more email than I have time to answer.
 317 Unfortunately, some messages may not get a reply, but I'll try to go
 318 through my mail whenever time permits.
 319 </p>
 320
 321 <p>Host AP mailing list can also be used for topics related to
 322 wpa_supplicant. Since this list has a broader audience, your likelyhood
 323 of getting responses is higher. This list is recommended for general
 324 questions about wpa_supplicant and its development. In addition, I
 325 will send release notes to it whenever a new version is available.
 326 </p>
 327
 328 <p>
 329 The mailing list information and web archive is at <a
 330 href="http://lists.shmoo.com/mailman/listinfo/hostap">http://lists.shmoo.com/mailman/listinfo/hostap</a>.
 331 Messages to hostap@shmoo.com will be delivered to the
 332 subscribers. Please note, that due to large number of spam and virus
 333 messages sent to the list address, the list is configured to accept
 334 messages only from subscribed addresses. Messages from unsubscribed addresses
 335 may be accepted manually, but their delivery will be delayed.
 336 </p>
 337
 338 <p>
 339 If you want to make sure your bug report of feature request does not
 340 get lost, please report it through the bug tracking system as
 341 <a href="../bugz/enter_bug.cgi">a new
 342 bug/feature request</a>.
 343 </p>
 344
 345     <hr>
 346     <div>
 347     <address><a href="mailto:j@w1.fi">Jouni Malinen</a></address>
 348 <!-- Created: Sat May 22 21:41:58 PDT 2004 -->
 349 <!-- hhmts start -->
 350 Last modified: Sun Feb 15 20:12:44 EET 2009
 351 <!-- hhmts end -->
 352     </div>
 353   </body>
 354 </html>