1 .\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dt WPA_SUPPLICANT.CONF 5
31 .Nm wpa_supplicant.conf
32 .Nd configuration file for
37 utility is an implementation of the WPA Supplicant component,
38 i.e., the part that runs in the client stations.
39 It implements WPA key negotiation with a WPA Authenticator
40 and EAP authentication with Authentication Server using
41 configuration information stored in a text file.
43 The configuration file consists of optional global parameter
44 settings and one or more network blocks, e.g.\&
45 one for each used SSID.
49 will automatically select the best network based on the order of
50 the network blocks in the configuration file, network security level
51 (WPA/WPA2 is preferred), and signal strength.
52 Comments are indicated with the
54 character; all text to the
55 end of the line will be ignored.
57 Default parameters used by
59 may be overridden by specifying
63 in the configuration file (note no spaces are allowed).
64 Values with embedded spaces must be enclosed in quote marks.
66 The following parameters are recognized:
67 .Bl -tag -width indent
69 The pathname of the directory in which
73 domain socket files for communication
74 with frontend programs such as
76 .It Va ctrl_interface_group
77 A group name or group ID to use in setting protection on the
78 control interface file.
79 This can be set to allow non-root users to access the
80 control interface files.
81 If no group is specified, the group ID of the control interface
82 is not modified and will, typically, be the
83 group ID of the directory in which the socket is created.
85 The IEEE 802.1x/EAPOL protocol version to use; either 1 (default) or 2.
89 is implemented according to IEEE 802-1X-REV-d8 which defines
90 EAPOL version to be 2.
91 However, some access points do not work when presented with
92 this version so by default
94 will announce that it is using EAPOL version 1.
95 If version 2 must be announced for correct operation with an
96 access point, this value may be set to 2.
98 Access point scanning and selection control; one of 0, 1 (default), or 2.
99 Only setting 1 should be used with the
101 module; the other settings are for use on other operating systems.
103 EAP fast re-authentication; either 1 (default) or 0.
104 Control fast re-authentication support in EAP methods that support it.
107 Each potential network/access point should have a
109 that describes how to identify it and how to set up security.
110 When multiple network blocks are listed in a configuration file,
111 the highest priority one is selected for use or, if multiple networks
112 with the same priority are identified, the first one listed in the
113 configuration file is used.
115 A network block description is of the form:
116 .Bd -literal -offset indent
126 The block specification contains one or more parameters
127 from the following list:
128 .Bl -tag -width indent
129 .It Va ssid No (required)
130 Network name (as announced by the access point).
133 or hex string enclosed in quotation marks.
135 SSID scan technique; 0 (default) or 1.
136 Technique 0 scans for the SSID using a broadcast Probe Request
137 frame while 1 uses a directed Probe Request frame.
138 Access points that cloak themselves by not broadcasting their SSID
139 require technique 1, but beware that this scheme can cause scanning
140 to take longer to complete.
142 Network BSSID (typically the MAC address of the access point).
144 The priority of a network when selecting among multiple networks;
145 a higher value means a network is more desirable.
146 By default networks have priority 0.
147 When multiple networks with the same priority are considered
148 for selection, other information such as security policy and
149 signal strength are used to select one.
151 IEEE 802.11 operation mode; either 0 (infrastructure, default) or 1 (IBSS).
152 Note that IBSS (adhoc) mode can only be used with
156 (plaintext and static WEP).
158 List of acceptable protocols; one or more of:
167 If not set this defaults to
170 List of acceptable key management protocols; one or more of:
172 (WPA pre-shared key),
174 (WPA using EAP authentication),
176 (IEEE 802.1x using EAP authentication and,
177 optionally, dynamically generated WEP keys),
179 (plaintext or static WEP keys).
180 If not set this defaults to
181 .Qq Li "WPA-PSK WPA-EAP" .
183 List of allowed IEEE 802.11 authentication algorithms; one or more of:
185 (Open System authentication, required for WPA/WPA2),
187 (Shared Key authentication),
190 If not set automatic selection is used (Open System with LEAP
191 enabled if LEAP is allowed as one of the EAP methods).
193 List of acceptable pairwise (unicast) ciphers for WPA; one or more of:
195 (AES in Counter mode with CBC-MAC, RFC 3610, IEEE 802.11i/D7.0),
197 (Temporal Key Integrity Protocol, IEEE 802.11i/D7.0),
200 If not set this defaults to
203 List of acceptable group (multicast) ciphers for WPA; one or more of:
205 (AES in Counter mode with CBC-MAC, RFC 3610, IEEE 802.11i/D7.0),
207 (Temporal Key Integrity Protocol, IEEE 802.11i/D7.0),
209 (WEP with 104-bit key),
211 (WEP with 40-bit key).
212 If not set this defaults to
213 .Qq Li "CCMP TKIP WEP104 WEP40" .
215 WPA preshared key used in WPA-PSK mode.
216 The key is specified as 64 hex digits or as
221 passphrases are dynamically converted to a 256-bit key at runtime
222 using the network SSID, or they can be statically converted at
223 configuration time using
228 Dynamic WEP key usage for non-WPA mode, specified as a bit field.
229 Bit 0 (1) forces dynamically generated unicast WEP keys to be used.
230 Bit 1 (2) forces dynamically generated broadcast WEP keys to be used.
231 By default this is set to 3 (use both).
233 List of acceptable EAP methods; one or more of:
235 (EAP-MD5, cannot be used with WPA,
236 used only as a Phase 2 method with EAP-PEAP or EAP-TTLS),
238 (EAP-MSCHAPV2, cannot be used with WPA;
239 used only as a Phase 2 method with EAP-PEAP or EAP-TTLS),
241 (EAP-OTP, cannot be used with WPA;
242 used only as a Phase 2 metod with EAP-PEAP or EAP-TTLS),
244 (EAP-GTC, cannot be used with WPA;
245 used only as a Phase 2 metod with EAP-PEAP or EAP-TTLS),
247 (EAP-TLS, client and server certificate),
249 (EAP-PEAP, with tunneled EAP authentication),
251 (EAP-TTLS, with tunneled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 authentication).
252 If not set this defaults to all available methods compiled in to
253 .Xr wpa_supplicant 8 .
256 is compiled with EAP support; see
259 .Va NO_WPA_SUPPLICANT_EAPOL
260 configuration variable that can be used to disable EAP support.
262 Identity string for EAP.
263 .It Va anonymous_identity
264 Anonymous identity string for EAP (to be used as the unencrypted identity
265 with EAP types that support different tunneled identities; e.g.\& EAP-TTLS).
267 Configure whether networks that allow both plaintext and encryption
268 are allowed when selecting a BSS from the scan results.
269 By default this is set to 0 (disabled).
271 Password string for EAP.
273 Pathname to CA certificate file.
274 This file can have one or more trusted CA certificates.
277 is not included, server certificates will not be verified (not recommended).
279 Pathname to client certificate file (PEM/DER).
281 Pathname to a client private key file (PEM/DER/PFX).
282 When a PKCS#12/PFX file is used, then
284 should not be specified as both the private key and certificate will be
285 read from PKCS#12 file.
286 .It Va private_key_passwd
287 Password for any private key file.
289 Pathname to a file holding DH/DSA parameters (in PEM format).
290 This file holds parameters for an ephemeral DH key exchange.
291 In most cases, the default RSA authentication does not use this configuration.
292 However, it is possible to set up RSA to use an ephemeral DH key exchange.
293 In addition, ciphers with
294 DSA keys always use ephemeral DH keys.
295 This can be used to achieve forward secrecy.
298 is in DSA parameters format, it will be automatically converted
301 Substring to be matched against the subject of the
302 authentication server certificate.
303 If this string is set, the server
304 certificate is only accepted if it contains this string in the subject.
305 The subject string is in following format:
307 .Dl "/C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com"
309 Phase1 (outer authentication, i.e., TLS tunnel) parameters
310 (string with field-value pairs, e.g.,
313 .Qq Li "peapver=1 peaplabel=1" ) .
316 can be used to force which PEAP version (0 or 1) is used.
318 can be used to force new label,
319 .Dq "client PEAP encryption" ,
320 to be used during key derivation when PEAPv1 or newer.
321 Most existing PEAPv1 implementations seem to be using the old label,
322 .Dq Li "client EAP encryption" ,
325 is now using that as the
331 configuration to interoperate with PEAPv1; see
334 .It Li peap_outer_success=0
335 can be used to terminate PEAP authentication on
336 tunneled EAP-Success.
337 This is required with some RADIUS servers that
339 .Pa draft-josefsson-pppext-eap-tls-eap-05.txt
341 .Tn Lucent NavisRadius v4.4.0
345 .It Li include_tls_length=1
349 TLS Message Length field in all TLS messages even if they are not
351 .It Li sim_min_num_chal=3
352 can be used to configure EAP-SIM to require three
353 challenges (by default, it accepts 2 or 3)
354 .It Li fast_provisioning=1
355 option enables in-line provisioning of EAP-FAST
359 phase2: Phase2 (inner authentication with TLS tunnel) parameters
360 (string with field-value pairs, e.g.,
361 .Qq Li "auth=MSCHAPV2"
363 .Qq Li "autheap=MSCHAPV2 autheap=MD5"
368 but for EAP inner Phase 2.
372 but for EAP inner Phase 2.
376 but for EAP inner Phase 2.
377 .It Va private_key2_passwd
379 .Va private_key_passwd
380 but for EAP inner Phase 2.
384 but for EAP inner Phase 2.
385 .It Va subject_match2
388 but for EAP inner Phase 2.
390 16-byte pre-shared key in hex format for use with EAP-PSK.
392 User NAI for use with EAP-PSK.
394 Authentication Server NAI for use with EAP-PSK.
396 Pathname to the file to use for PAC entries with EAP-FAST.
400 must be able to create this file and write updates to it when
401 PAC is being provisioned or refreshed.
402 .It Va eap_workaround
403 Enable/disable EAP workarounds for various interoperability issues
404 with misbehaving authentication servers.
405 By default these workarounds are enabled.
406 String EAP conformance can be configured by setting this to 0.
409 Some EAP authentication methods require use of certificates.
410 EAP-TLS uses both server- and client-side certificates,
411 whereas EAP-PEAP and EAP-TTLS only require a server-side certificate.
412 When a client certificate is used, a matching private key file must
413 also be included in configuration.
414 If the private key uses a passphrase, this
415 has to be configured in the
418 .Va private_key_passwd .
423 supports X.509 certificates in PEM and DER formats.
424 User certificate and private key can be included in the same file.
426 If the user certificate and private key is received in PKCS#12/PFX
427 format, they need to be converted to a suitable PEM/DER format for
429 .Xr wpa_supplicant 8 .
430 This can be done using the
432 program, e.g.\& with the following commands:
434 # convert client certificate and private key to PEM format
435 openssl pkcs12 -in example.pfx -out user.pem -clcerts
436 # convert CA certificate (if included in PFX file) to PEM format
437 openssl pkcs12 -in example.pfx -out ca.pem -cacerts -nokeys
440 WPA-Personal (PSK) as a home network and WPA-Enterprise with EAP-TLS
443 # allow frontend (e.g., wpa_cli) to be used by all users in 'wheel' group
444 ctrl_interface=/var/run/wpa_supplicant
445 ctrl_interface_group=wheel
447 # home network; allow all valid ciphers
452 psk="very secret passphrase"
455 # work network; use EAP-TLS with WPA; allow only CCMP and TKIP ciphers
463 identity="user@example.com"
464 ca_cert="/etc/cert/ca.pem"
465 client_cert="/etc/cert/user.pem"
466 private_key="/etc/cert/user.prv"
467 private_key_passwd="password"
471 WPA-RADIUS/EAP-PEAP/MSCHAPv2 with RADIUS servers that use old peaplabel
472 (e.g., Funk Odyssey and SBR, Meetinghouse Aegis, Interlink RAD-Series):
474 ctrl_interface=/var/run/wpa_supplicant
475 ctrl_interface_group=wheel
481 identity="user@example.com"
483 ca_cert="/etc/cert/ca.pem"
485 phase2="auth=MSCHAPV2"
489 EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
491 Real identity is sent only within an encrypted TLS tunnel.
493 ctrl_interface=/var/run/wpa_supplicant
494 ctrl_interface_group=wheel
500 identity="user@example.com"
501 anonymous_identity="anonymous@example.com"
503 ca_cert="/etc/cert/ca.pem"
508 Traditional WEP configuration with 104 bit key specified in hexadecimal.
509 Note the WEP key is not quoted.
511 ctrl_interface=/var/run/wpa_supplicant
512 ctrl_interface_group=wheel
518 wep_key0=42FEEDDEAFBABEDEAFBEEFAA55
522 .Bl -tag -width ".Pa /usr/share/examples/etc/wpa_supplicant.conf" -compact
523 .It Pa /etc/wpa_supplicant.conf
524 .It Pa /usr/share/examples/etc/wpa_supplicant.conf
528 .Xr wpa_passphrase 8 ,
535 functionality first appeared in
538 This manual page is derived from the
541 .Pa wpa_supplicant.conf
544 distribution provided by
545 .An Jouni Malinen Aq jkmaline@cc.hut.fi .