1 ##### Example wpa_supplicant configuration file ###############################
3 # This file describes configuration file format and lists all available option.
4 # Please also take a look at simpler configuration examples in 'examples'
7 # Empty lines and lines starting with # are ignored
9 # NOTE! This file may contain password information and should probably be made
10 # readable only by root user on multiuser systems.
12 # Note: All file paths in this configuration file should use full (absolute,
13 # not relative to working directory) path in order to allow working directory
14 # to be changed. This can happen if wpa_supplicant is run in the background.
16 # Whether to allow wpa_supplicant to update (overwrite) configuration
18 # This option can be used to allow wpa_supplicant to overwrite configuration
19 # file whenever configuration is changed (e.g., new network block is added with
20 # wpa_cli or wpa_gui, or a password is changed). This is required for
21 # wpa_cli/wpa_gui to be able to store the configuration changes permanently.
22 # Please note that overwriting configuration file will remove the comments from
26 # global configuration (shared by all network blocks)
28 # Interface for separate control program. If this is specified, wpa_supplicant
29 # will create this directory and a UNIX domain socket for listening to requests
30 # from external programs (CLI/GUI, etc.) for status information and
31 # configuration. The socket file will be named based on the interface name, so
32 # multiple wpa_supplicant processes can be run at the same time if more than
33 # one interface is used.
34 # /var/run/wpa_supplicant is the recommended directory for sockets and by
35 # default, wpa_cli will use it when trying to connect with wpa_supplicant.
36 ctrl_interface=/var/run/wpa_supplicant
38 # Access control for the control interface can be configured by setting the
39 # directory to allow only members of a group to use sockets. This way, it is
40 # possible to run wpa_supplicant as root (since it needs to change network
41 # configuration and open raw sockets) and still allow GUI/CLI components to be
42 # run as non-root users. However, since the control interface can be used to
43 # change the network configuration, this access needs to be protected in many
44 # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
45 # want to allow non-root users to use the control interface, add a new group
46 # and change this value to match with that group. Add users that should have
47 # control interface access to this group. If this variable is commented out or
48 # not included in the configuration file, group will not be changed from the
49 # value it got by default when the directory or socket was created.
51 # This variable can be a group name or gid.
52 #ctrl_interface_group=wheel
53 ctrl_interface_group=0
55 # IEEE 802.1X/EAPOL version
56 # wpa_supplicant was implemented based on IEEE 802-1X-REV-d8 which defines
57 # EAPOL version 2. However, there are many APs that do not handle the new
58 # version number correctly (they seem to drop the frames completely). In order
59 # to make wpa_supplicant interoperate with these APs, the version number is set
60 # to 1 by default. This configuration value can be used to set it to the new
64 # AP scanning/selection
65 # By default, wpa_supplicant requests driver to perform AP scanning and then
66 # uses the scan results to select a suitable AP. Another alternative is to
67 # allow the driver to take care of AP scanning and selection and use
68 # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
69 # information from the driver.
70 # 1: wpa_supplicant initiates scanning and AP selection
71 # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
72 # parameters (e.g., WPA IE generation); this mode can also be used with
73 # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
74 # APs (i.e., external program needs to control association). This mode must
75 # also be used when using wired Ethernet drivers.
76 # 2: like 0, but associate with APs using security policy and SSID (but not
77 # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
78 # enable operation with hidden SSIDs and optimized roaming; in this mode,
79 # the network blocks in the configuration file are tried one by one until
80 # the driver reports successful association; each network block should have
81 # explicit security policy (i.e., only one option in the lists) for
82 # key_mgmt, pairwise, group, proto variables
85 # EAP fast re-authentication
86 # By default, fast re-authentication is enabled for all EAP methods that
87 # support it. This variable can be used to disable fast re-authentication.
88 # Normally, there is no need to disable this.
91 # OpenSSL Engine support
92 # These options can be used to load OpenSSL engines.
93 # The two engines that are supported currently are shown below:
94 # They are both from the opensc project (http://www.opensc.org/)
95 # By default no engines are loaded.
96 # make the opensc engine available
97 opensc_engine_path=/usr/lib/opensc/engine_opensc.so
98 # make the pkcs11 engine available
99 pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
100 # configure the path to the pkcs11 module required by the pkcs11 engine
101 pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
103 # Driver interface parameters
104 # This field can be used to configure arbitrary driver interace parameters. The
105 # format is specific to the selected driver interface. This field is not used
107 #driver_param="field=value"
109 # Maximum lifetime for PMKSA in seconds; default 43200
110 #dot11RSNAConfigPMKLifetime=43200
111 # Threshold for reauthentication (percentage of PMK lifetime); default 70
112 #dot11RSNAConfigPMKReauthThreshold=70
113 # Timeout for security association negotiation in seconds; default 60
114 #dot11RSNAConfigSATimeout=60
118 # Each network (usually AP's sharing the same SSID) is configured as a separate
119 # block in this configuration file. The network blocks are in preference order
120 # (the first match is used).
122 # network block fields:
125 # 0 = this network can be used (default)
126 # 1 = this network block is disabled (can be enabled through ctrl_iface,
127 # e.g., with wpa_cli or wpa_gui)
129 # ssid: SSID (mandatory); either as an ASCII string with double quotation or
130 # as hex string; network name
133 # 0 = do not scan this SSID with specific Probe Request frames (default)
134 # 1 = scan with SSID-specific Probe Request frames (this can be used to
135 # find APs that do not accept broadcast SSID or use multiple SSIDs;
136 # this will add latency to scanning, so enable this only when needed)
138 # bssid: BSSID (optional); if set, this network block is used only when
139 # associating with the AP using the configured BSSID
141 # priority: priority group (integer)
142 # By default, all networks will get same priority group (0). If some of the
143 # networks are more desirable, this field can be used to change the order in
144 # which wpa_supplicant goes through the networks when selecting a BSS. The
145 # priority groups will be iterated in decreasing priority (i.e., the larger the
146 # priority value, the sooner the network is matched against the scan results).
147 # Within each priority group, networks will be selected based on security
148 # policy, signal strength, etc.
149 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
150 # using this priority to select the order for scanning. Instead, they try the
151 # networks in the order that used in the configuration file.
153 # mode: IEEE 802.11 operation mode
154 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
155 # 1 = IBSS (ad-hoc, peer-to-peer)
156 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
157 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In addition, ap_scan has
158 # to be set to 2 for IBSS. WPA-None requires following network block options:
159 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
160 # both), and psk must also be set.
162 # proto: list of accepted protocols
163 # WPA = WPA/IEEE 802.11i/D3.0
164 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
165 # If not set, this defaults to: WPA RSN
167 # key_mgmt: list of accepted authenticated key management protocols
168 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
169 # WPA-EAP = WPA using EAP authentication (this can use an external
170 # program, e.g., Xsupplicant, for IEEE 802.1X EAP Authentication
171 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
173 # NONE = WPA is not used; plaintext or static WEP could be used
174 # If not set, this defaults to: WPA-PSK WPA-EAP
176 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
177 # OPEN = Open System authentication (required for WPA/WPA2)
178 # SHARED = Shared Key authentication (requires static WEP keys)
179 # LEAP = LEAP/Network EAP (only used with LEAP)
180 # If not set, automatic selection is used (Open System with LEAP enabled if
181 # LEAP is allowed as one of the EAP methods).
183 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
184 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
185 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
186 # NONE = Use only Group Keys (deprecated, should not be included if APs support
188 # If not set, this defaults to: CCMP TKIP
190 # group: list of accepted group (broadcast/multicast) ciphers for WPA
191 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
192 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
193 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
194 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
195 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
197 # psk: WPA preshared key; 256-bit pre-shared key
198 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
199 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
200 # generated using the passphrase and SSID). ASCII passphrase must be between
201 # 8 and 63 characters (inclusive).
202 # This field is not needed, if WPA-EAP is used.
203 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
204 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
205 # startup and reconfiguration time can be optimized by generating the PSK only
206 # only when the passphrase or SSID has actually changed.
208 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
209 # Dynamic WEP key required for non-WPA mode
210 # bit0 (1): require dynamically generated unicast WEP key
211 # bit1 (2): require dynamically generated broadcast WEP key
212 # (3 = require both keys; default)
213 # Note: When using wired authentication, eapol_flags must be set to 0 for the
214 # authentication to be completed successfully.
216 # proactive_key_caching:
217 # Enable/disable opportunistic PMKSA caching for WPA2.
218 # 0 = disabled (default)
221 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
222 # hex without quotation, e.g., 0102030405)
223 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
225 # Following fields are only used with internal EAP implementation.
226 # eap: space-separated list of accepted EAP methods
227 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
228 # cannot be used with WPA; to be used as a Phase 2 method
229 # with EAP-PEAP or EAP-TTLS)
230 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
231 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
232 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
233 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
234 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
235 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
236 # TLS = EAP-TLS (client and server certificate)
237 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
238 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
240 # If not set, all compiled in methods are allowed.
242 # identity: Identity string for EAP
243 # anonymous_identity: Anonymous identity string for EAP (to be used as the
244 # unencrypted identity with EAP types that support different tunnelled
245 # identity, e.g., EAP-TTLS)
246 # password: Password string for EAP
247 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
248 # or more trusted CA certificates. If ca_cert and ca_path are not
249 # included, server certificate will not be verified. This is insecure and
250 # a trusted CA certificate should always be configured when using
251 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
252 # change when wpa_supplicant is run in the background.
253 # On Windows, trusted CA certificates can be loaded from the system
254 # certificate store by setting this to cert_store://<name>, e.g.,
255 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
256 # ca_path: Directory path for CA certificate files (PEM). This path may
257 # contain multiple CA certificates in OpenSSL format. Common use for this
258 # is to point to system trusted CA list which is often installed into
259 # directory like /etc/ssl/certs. If configured, these certificates are
260 # added to the list of trusted CAs. ca_cert may also be included in that
261 # case, but it is not required.
262 # client_cert: File path to client certificate file (PEM/DER)
263 # Full path should be used since working directory may change when
264 # wpa_supplicant is run in the background.
265 # Alternatively, a named configuration blob can be used by setting this
266 # to blob://<blob name>.
267 # private_key: File path to client private key file (PEM/DER/PFX)
268 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
269 # commented out. Both the private key and certificate will be read from
270 # the PKCS#12 file in this case. Full path should be used since working
271 # directory may change when wpa_supplicant is run in the background.
272 # Windows certificate store can be used by leaving client_cert out and
273 # configuring private_key in one of the following formats:
274 # cert://substring_to_match
275 # hash://certificate_thumbprint_in_hex
276 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
277 # Alternatively, a named configuration blob can be used by setting this
278 # to blob://<blob name>.
279 # private_key_passwd: Password for private key file (if left out, this will be
280 # asked through control interface)
281 # dh_file: File path to DH/DSA parameters file (in PEM format)
282 # This is an optional configuration file for setting parameters for an
283 # ephemeral DH key exchange. In most cases, the default RSA
284 # authentication does not use this configuration. However, it is possible
285 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
286 # DSA keys always use ephemeral DH keys. This can be used to achieve
287 # forward secrecy. If the file is in DSA parameters format, it will be
288 # automatically converted into DH params.
289 # subject_match: Substring to be matched against the subject of the
290 # authentication server certificate. If this string is set, the server
291 # sertificate is only accepted if it contains this string in the subject.
292 # The subject string is in following format:
293 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
294 # altsubject_match: Substring to be matched against the alternative subject
295 # name of the authentication server certificate. If this string is set,
296 # the server sertificate is only accepted if it contains this string in
297 # an alternative subject name extension.
298 # altSubjectName string is in following format: TYPE:VALUE
299 # Example: DNS:server.example.com
300 # Following types are supported: EMAIL, DNS, URI
301 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
302 # (string with field-value pairs, e.g., "peapver=0" or
303 # "peapver=1 peaplabel=1")
304 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
305 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
306 # to be used during key derivation when PEAPv1 or newer. Most existing
307 # PEAPv1 implementation seem to be using the old label, "client EAP
308 # encryption", and wpa_supplicant is now using that as the default value.
309 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
310 # interoperate with PEAPv1; see eap_testing.txt for more details.
311 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
312 # tunneled EAP-Success. This is required with some RADIUS servers that
313 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
314 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
315 # include_tls_length=1 can be used to force wpa_supplicant to include
316 # TLS Message Length field in all TLS messages even if they are not
318 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
319 # challenges (by default, it accepts 2 or 3)
320 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
321 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
322 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
323 # Following certificate/private key fields are used in inner Phase2
324 # authentication when using EAP-TTLS or EAP-PEAP.
325 # ca_cert2: File path to CA certificate file. This file can have one or more
326 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
327 # server certificate will not be verified. This is insecure and a trusted
328 # CA certificate should always be configured.
329 # ca_path2: Directory path for CA certificate files (PEM)
330 # client_cert2: File path to client certificate file
331 # private_key2: File path to client private key file
332 # private_key2_passwd: Password for private key file
333 # dh_file2: File path to DH/DSA parameters file (in PEM format)
334 # subject_match2: Substring to be matched against the subject of the
335 # authentication server certificate.
336 # altsubject_match2: Substring to be matched against the alternative subject
337 # name of the authentication server certificate.
340 # eappsk: 16-byte (128-bit, 32 hex digits) pre-shared key in hex format
343 # EAP-FAST variables:
344 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
345 # to create this file and write updates to it when PAC is being
346 # provisioned or refreshed. Full path to the file should be used since
347 # working directory may change when wpa_supplicant is run in the
348 # background. Alternatively, a named configuration blob can be used by
349 # setting this to blob://<blob name>
350 # phase1: fast_provisioning=1 option enables in-line provisioning of EAP-FAST
353 # wpa_supplicant supports number of "EAP workarounds" to work around
354 # interoperability issues with incorrectly behaving authentication servers.
355 # These are enabled by default because some of the issues are present in large
356 # number of authentication servers. Strict EAP conformance mode can be
357 # configured by disabling workarounds with eap_workaround=0.
361 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
364 psk="very secret passphrase"
368 # Same as previous, but request SSID-specific scanning (for APs that reject
373 psk="very secret passphrase"
377 # Only WPA-PSK is used. Any valid cipher combination is accepted.
383 group=CCMP TKIP WEP104 WEP40
384 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
388 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
389 # or WEP40 as the group cipher will not be accepted.
397 identity="user@example.com"
398 ca_cert="/etc/cert/ca.pem"
399 client_cert="/etc/cert/user.pem"
400 private_key="/etc/cert/user.prv"
401 private_key_passwd="password"
405 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
411 identity="user@example.com"
413 ca_cert="/etc/cert/ca.pem"
415 phase2="auth=MSCHAPV2"
419 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
420 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
425 identity="user@example.com"
426 anonymous_identity="anonymous@example.com"
428 ca_cert="/etc/cert/ca.pem"
432 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
433 # use. Real identity is sent only within an encrypted TLS tunnel.
438 identity="user@example.com"
439 anonymous_identity="anonymous@example.com"
441 ca_cert="/etc/cert/ca.pem"
442 phase2="auth=MSCHAPV2"
445 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
451 # Phase1 / outer authentication
452 anonymous_identity="anonymous@example.com"
453 ca_cert="/etc/cert/ca.pem"
454 # Phase 2 / inner authentication
456 ca_cert2="/etc/cert/ca2.pem"
457 client_cert2="/etc/cer/user.pem"
458 private_key2="/etc/cer/user.prv"
459 private_key2_passwd="password"
463 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
467 bssid=00:11:22:33:44:55
469 key_mgmt=WPA-PSK WPA-EAP
472 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
475 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
476 # and all valid ciphers.
479 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
483 # EAP-SIM with a GSM SIM or USIM
498 identity="eap_psk_user"
499 eappsk=06b4be19da289f475aa46a33cb793029
500 nai="eap_psk_user@example.com"
504 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
505 # EAP-TLS for authentication and key generation; require both unicast and
506 # broadcast WEP keys.
511 identity="user@example.com"
512 ca_cert="/etc/cert/ca.pem"
513 client_cert="/etc/cert/user.pem"
514 private_key="/etc/cert/user.prv"
515 private_key_passwd="password"
520 # LEAP with dynamic WEP keys
529 # EAP-FAST with WPA (WPA or WPA2)
534 anonymous_identity="FAST-000102030405"
537 phase1="fast_provisioning=1"
538 pac_file="/etc/wpa_supplicant.eap-fast-pac"
545 anonymous_identity="FAST-000102030405"
548 phase1="fast_provisioning=1"
549 pac_file="blob://eap-fast-pac"
552 # Plaintext connection (no WPA, no IEEE 802.1X)
554 ssid="plaintext-test"
559 # Shared WEP key connection (no WPA, no IEEE 802.1X)
561 ssid="static-wep-test"
565 wep_key2="1234567890123"
571 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
572 # IEEE 802.11 authentication
574 ssid="static-wep-test2"
578 wep_key2="1234567890123"
585 # IBSS/ad-hoc network with WPA-None/TKIP.
593 psk="secret passphrase"
597 # Catch all example that allows more or less all configuration modes
601 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
603 group=CCMP TKIP WEP104 WEP40
604 psk="very secret passphrase"
606 identity="user@example.com"
608 ca_cert="/etc/cert/ca.pem"
609 client_cert="/etc/cert/user.pem"
610 private_key="/etc/cert/user.prv"
611 private_key_passwd="password"
615 # Example of EAP-TLS with smartcard (openssl engine)
623 identity="user@example.com"
624 ca_cert="/etc/cert/ca.pem"
625 client_cert="/etc/cert/user.pem"
629 # The engine configured here must be available. Look at
630 # OpenSSL engine support in the global section.
631 # The key available through the engine must be the private key
632 # matching the client certificate configured above.
634 # use the opensc engine
638 # use the pkcs11 engine
642 # Optional PIN configuration; this can be left out and PIN will be
643 # asked through the control interface
647 # Example configuration showing how to use an inlined blob as a CA certificate
648 # data instead of using external file
653 identity="user@example.com"
654 anonymous_identity="anonymous@example.com"
656 ca_cert="blob://exampleblob"
660 blob-base64-exampleblob={