1 ##### Example wpa_supplicant configuration file ###############################
2 # Empty lines and lines starting with # are ignored
4 # NOTE! This file may contain password information and should probably be made
5 # readable only by root user on multiuser systems.
7 # global configuration (shared by all network blocks)
9 # Interface for separate control program. If this is specified, wpa_supplicant
10 # will create this directory and a UNIX domain socket for listening to requests
11 # from external programs (CLI/GUI, etc.) for status information and
12 # configuration. The socket file will be named based on the interface name, so
13 # multiple wpa_supplicant processes can be run at the same time if more than
14 # one interface is used.
15 # /var/run/wpa_supplicant is the recommended directory for sockets and by
16 # default, wpa_cli will use it when trying to connect with wpa_supplicant.
17 ctrl_interface=/var/run/wpa_supplicant
19 # Access control for the control interface can be configured by setting the
20 # directory to allow only members of a group to use sockets. This way, it is
21 # possible to run wpa_supplicant as root (since it needs to change network
22 # configuration and open raw sockets) and still allow GUI/CLI components to be
23 # run as non-root users. However, since the control interface can be used to
24 # change the network configuration, this access needs to be protected in many
25 # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
26 # want to allow non-root users to use the control interface, add a new group
27 # and change this value to match with that group. Add users that should have
28 # control interface access to this group. If this variable is commented out or
29 # not included in the configuration file, group will not be changed from the
30 # value it got by default when the directory or socket was created.
32 # This variable can be a group name or gid.
33 #ctrl_interface_group=wheel
34 ctrl_interface_group=0
36 # IEEE 802.1X/EAPOL version
37 # wpa_supplicant was implemented based on IEEE 802-1X-REV-d8 which defines
38 # EAPOL version 2. However, there are many APs that do not handle the new
39 # version number correctly (they seem to drop the frames completely). In order
40 # to make wpa_supplicant interoperate with these APs, the version number is set
41 # to 1 by default. This configuration value can be used to set it to the new
45 # AP scanning/selection
46 # By default, wpa_supplicant requests driver to perform AP scanning and then
47 # uses the scan results to select a suitable AP. Another alternative is to
48 # allow the driver to take care of AP scanning and selection and use
49 # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
50 # information from the driver.
51 # 1: wpa_supplicant initiates scanning and AP selection
52 # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
53 # parameters (e.g., WPA IE generation); this mode can also be used with
54 # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
55 # APs (i.e., external program needs to control association)
56 # 2: like 0, but associate with APs using security policy and SSID (but not
57 # BSSID); this can be used, e.g., with ndiswrapper and NDIS driver to
58 # enable operation with hidden SSIDs and optimized roaming; in this mode,
59 # only the first network block in the configuration file is used and this
60 # configuration should have explicit security policy (i.e., only one option
61 # in the lists) for key_mgmt, pairwise, group, proto variables
64 # EAP fast re-authentication
65 # By default, fast re-authentication is enabled for all EAP methods that
66 # support it. This variable can be used to disable fast re-authentication.
67 # Normally, there is no need to disable this.
72 # Each network (usually AP's sharing the same SSID) is configured as a separate
73 # block in this configuration file. The network blocks are in preference order
74 # (the first match is used).
76 # network block fields:
78 # ssid: SSID (mandatory); either as an ASCII string with double quotation or
79 # as hex string; network name
82 # 0 = do not scan this SSID with specific Probe Request frames (default)
83 # 1 = scan with SSID-specific Probe Request frames (this can be used to
84 # find APs that do not accept broadcast SSID or use multiple SSIDs;
85 # this will add latency to scanning, so enable this only when needed)
87 # bssid: BSSID (optional); if set, this network block is used only when
88 # associating with the AP using the configured BSSID
90 # priority: priority group (integer)
91 # By default, all networks will get same priority group (0). If some of the
92 # networks are more desirable, this field can be used to change the order in
93 # which wpa_supplicant goes through the networks when selecting a BSS. The
94 # priority groups will be iterated in decreasing priority (i.e., the larger the
95 # priority value, the sooner the network is matched against the scan results).
96 # Within each priority group, networks will be selected based on security
97 # policy, signal strength, etc.
98 # Please note that AP scanning with scan_ssid=1 is not using this priority to
99 # select the order for scanning. Instead, it uses the order the networks are in
100 # the configuration file.
102 # mode: IEEE 802.11 operation mode
103 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
104 # 1 = IBSS (ad-hoc, peer-to-peer)
105 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
106 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In addition, ap_scan has
107 # to be set to 2 for IBSS. WPA-None requires following network block options:
108 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
109 # both), and psk must also be set.
111 # proto: list of accepted protocols
112 # WPA = WPA/IEEE 802.11i/D3.0
113 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
114 # If not set, this defaults to: WPA RSN
116 # key_mgmt: list of accepted authenticated key management protocols
117 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
118 # WPA-EAP = WPA using EAP authentication (this can use an external
119 # program, e.g., Xsupplicant, for IEEE 802.1X EAP Authentication
120 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
122 # NONE = WPA is not used; plaintext or static WEP could be used
123 # If not set, this defaults to: WPA-PSK WPA-EAP
125 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
126 # OPEN = Open System authentication (required for WPA/WPA2)
127 # SHARED = Shared Key authentication (requires static WEP keys)
128 # LEAP = LEAP/Network EAP (only used with LEAP)
129 # If not set, automatic selection is used (Open System with LEAP enabled if
130 # LEAP is allowed as one of the EAP methods).
132 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
133 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
134 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
135 # NONE = Use only Group Keys (deprecated, should not be included if APs support
137 # If not set, this defaults to: CCMP TKIP
139 # group: list of accepted group (broadcast/multicast) ciphers for WPA
140 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
141 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
142 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
143 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
144 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
146 # psk: WPA preshared key; 256-bit pre-shared key
147 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
148 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
149 # generated using the passphrase and SSID). ASCII passphrase must be between
150 # 8 and 63 characters (inclusive).
151 # This field is not needed, if WPA-EAP is used.
152 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
153 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
154 # startup and reconfiguration time can be optimized by generating the PSK only
155 # only when the passphrase or SSID has actually changed.
157 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
158 # Dynamic WEP key require for non-WPA mode
159 # bit0 (1): require dynamically generated unicast WEP key
160 # bit1 (2): require dynamically generated broadcast WEP key
161 # (3 = require both keys; default)
163 # Following fields are only used with internal EAP implementation.
164 # eap: space-separated list of accepted EAP methods
165 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
166 # cannot be used with WPA; to be used as a Phase 2 method
167 # with EAP-PEAP or EAP-TTLS)
168 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
169 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
170 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
171 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
172 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
173 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
174 # TLS = EAP-TLS (client and server certificate)
175 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
176 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
178 # If not set, all compiled in methods are allowed.
180 # identity: Identity string for EAP
181 # anonymous_identity: Anonymous identity string for EAP (to be used as the
182 # unencrypted identity with EAP types that support different tunnelled
183 # identity, e.g., EAP-TTLS)
184 # password: Password string for EAP
185 # ca_cert: File path to CA certificate file. This file can have one or more
186 # trusted CA certificates. If ca_cert is not included, server certificate
187 # will not be verified. This is insecure and the CA file should always be
189 # client_cert: File path to client certificate file (PEM/DER)
190 # private_key: File path to client private key file (PEM/DER/PFX)
191 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
192 # commented out. Both the private key and certificate will be read from
193 # the PKCS#12 file in this case.
194 # private_key_passwd: Password for private key file
195 # dh_file: File path to DH/DSA parameters file (in PEM format)
196 # This is an optional configuration file for setting parameters for an
197 # ephemeral DH key exchange. In most cases, the default RSA
198 # authentication does not use this configuration. However, it is possible
199 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
200 # DSA keys always use ephemeral DH keys. This can be used to achieve
201 # forward secrecy. If the file is in DSA parameters format, it will be
202 # automatically converted into DH params.
203 # subject_match: Substring to be matched against the subject of the
204 # authentication server certificate. If this string is set, the server
205 # sertificate is only accepted if it contains this string in the subject.
206 # The subject string is in following format:
207 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
208 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
209 # (string with field-value pairs, e.g., "peapver=0" or
210 # "peapver=1 peaplabel=1")
211 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
212 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
213 # to be used during key derivation when PEAPv1 or newer. Most existing
214 # PEAPv1 implementation seem to be using the old label, "client EAP
215 # encryption", and wpa_supplicant is now using that as the default value.
216 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
217 # interoperate with PEAPv1; see eap_testing.txt for more details.
218 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
219 # tunneled EAP-Success. This is required with some RADIUS servers that
220 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
221 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
222 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
223 # challenges (by default, it accepts 2 or 3)
224 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
225 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
226 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
227 # Following certificate/private key fields are used in inner Phase2
228 # authentication when using EAP-TTLS or EAP-PEAP.
229 # ca_cert2: File path to CA certificate file. This file can have one or more
230 # trusted CA certificates. If ca_cert2 is not included, server
231 # certificate will not be verified. This is insecure and the CA file
232 # should always be configured.
233 # client_cert2: File path to client certificate file
234 # private_key2: File path to client private key file
235 # private_key2_passwd: Password for private key file
236 # dh_file2: File path to DH/DSA parameters file (in PEM format)
237 # subject_match2: Substring to be matched against the subject of the
238 # authentication server certificate.
241 # eappsk: 16-byte (128-bit, 32 hex digits) pre-shared key in hex format
243 # server_nai: authentication server NAI
245 # EAP-FAST variables:
246 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
247 # to create this file and write updates to it when PAC is being
248 # provisioned or refreshed.
249 # phase1: fast_provisioning=1 option enables in-line provisioning of EAP-FAST
252 # wpa_supplicant supports number of "EAP workarounds" to work around
253 # interoperability issues with incorrectly behaving authentication servers.
254 # These are enabled by default because some of the issues are present in large
255 # number of authentication servers. Strict EAP conformance mode can be
256 # configured by disabling workarounds with eap_workaround=0.
260 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
263 psk="very secret passphrase"
267 # Same as previous, but request SSID-specific scanning (for APs that reject
272 psk="very secret passphrase"
276 # Only WPA-PSK is used. Any valid cipher combination is accepted.
282 group=CCMP TKIP WEP104 WEP40
283 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
287 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
288 # or WEP40 as the group cipher will not be accepted.
296 identity="user@example.com"
297 ca_cert="/etc/cert/ca.pem"
298 client_cert="/etc/cert/user.pem"
299 private_key="/etc/cert/user.prv"
300 private_key_passwd="password"
304 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
310 identity="user@example.com"
312 ca_cert="/etc/cert/ca.pem"
314 phase2="auth=MSCHAPV2"
318 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
319 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
324 identity="user@example.com"
325 anonymous_identity="anonymous@example.com"
327 ca_cert="/etc/cert/ca.pem"
331 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
332 # use. Real identity is sent only within an encrypted TLS tunnel.
337 identity="user@example.com"
338 anonymous_identity="anonymous@example.com"
340 ca_cert="/etc/cert/ca.pem"
341 phase2="auth=MSCHAPV2"
344 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
350 # Phase1 / outer authentication
351 anonymous_identity="anonymous@example.com"
352 ca_cert="/etc/cert/ca.pem"
353 # Phase 2 / inner authentication
355 ca_cert2="/etc/cert/ca2.pem"
356 client_cert2="/etc/cer/user.pem"
357 private_key2="/etc/cer/user.prv"
358 private_key2_passwd="password"
362 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
366 bssid=00:11:22:33:44:55
368 key_mgmt=WPA-PSK WPA-EAP
371 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
374 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
375 # and all valid ciphers.
378 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
382 # EAP-SIM with a GSM SIM or USIM
397 identity="eap_psk_user"
398 eappsk=06b4be19da289f475aa46a33cb793029
399 nai="eap_psk_user@example.com"
400 server_nai="as@example.com"
404 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
405 # EAP-TLS for authentication and key generation; require both unicast and
406 # broadcast WEP keys.
411 identity="user@example.com"
412 ca_cert="/etc/cert/ca.pem"
413 client_cert="/etc/cert/user.pem"
414 private_key="/etc/cert/user.prv"
415 private_key_passwd="password"
420 # LEAP with dynamic WEP keys
429 # EAP-FAST with WPA (WPA or WPA2)
434 anonymous_identity="FAST-000102030405"
437 phase1="fast_provisioning=1"
438 pac_file="/etc/wpa_supplicant.eap-fast-pac"
441 # Plaintext connection (no WPA, no IEEE 802.1X)
443 ssid="plaintext-test"
448 # Shared WEP key connection (no WPA, no IEEE 802.1X)
450 ssid="static-wep-test"
454 wep_key2="1234567890123"
460 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
461 # IEEE 802.11 authentication
463 ssid="static-wep-test2"
467 wep_key2="1234567890123"
474 # IBSS/ad-hoc network with WPA-None/TKIP.
482 psk="secret passphrase"
486 # Catch all example that allows more or less all configuration modes
490 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
492 group=CCMP TKIP WEP104 WEP40
493 psk="very secret passphrase"
495 identity="user@example.com"
497 ca_cert="/etc/cert/ca.pem"
498 client_cert="/etc/cert/user.pem"
499 private_key="/etc/cert/user.prv"
500 private_key_passwd="password"