WPS 2.0: Add tool for testing protocol extensibility
[libeap.git] / wpa_supplicant / wpa_supplicant.conf
1 ##### Example wpa_supplicant configuration file ###############################
2 #
3 # This file describes configuration file format and lists all available option.
4 # Please also take a look at simpler configuration examples in 'examples'
5 # subdirectory.
6 #
7 # Empty lines and lines starting with # are ignored
8
9 # NOTE! This file may contain password information and should probably be made
10 # readable only by root user on multiuser systems.
11
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.
15
16 # Whether to allow wpa_supplicant to update (overwrite) configuration
17 #
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
23 # it.
24 #update_config=1
25
26 # global configuration (shared by all network blocks)
27 #
28 # Parameters for the control interface. If this is specified, wpa_supplicant
29 # will open a control interface that is available for external programs to
30 # manage wpa_supplicant. The meaning of this string depends on which control
31 # interface mechanism is used. For all cases, the existance of this parameter
32 # in configuration is used to determine whether the control interface is
33 # enabled.
34 #
35 # For UNIX domain sockets (default on Linux and BSD): This is a directory that
36 # will be created for UNIX domain sockets for listening to requests from
37 # external programs (CLI/GUI, etc.) for status information and configuration.
38 # The socket file will be named based on the interface name, so multiple
39 # wpa_supplicant processes can be run at the same time if more than one
40 # interface is used.
41 # /var/run/wpa_supplicant is the recommended directory for sockets and by
42 # default, wpa_cli will use it when trying to connect with wpa_supplicant.
43 #
44 # Access control for the control interface can be configured by setting the
45 # directory to allow only members of a group to use sockets. This way, it is
46 # possible to run wpa_supplicant as root (since it needs to change network
47 # configuration and open raw sockets) and still allow GUI/CLI components to be
48 # run as non-root users. However, since the control interface can be used to
49 # change the network configuration, this access needs to be protected in many
50 # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
51 # want to allow non-root users to use the control interface, add a new group
52 # and change this value to match with that group. Add users that should have
53 # control interface access to this group. If this variable is commented out or
54 # not included in the configuration file, group will not be changed from the
55 # value it got by default when the directory or socket was created.
56 #
57 # When configuring both the directory and group, use following format:
58 # DIR=/var/run/wpa_supplicant GROUP=wheel
59 # DIR=/var/run/wpa_supplicant GROUP=0
60 # (group can be either group name or gid)
61 #
62 # For UDP connections (default on Windows): The value will be ignored. This
63 # variable is just used to select that the control interface is to be created.
64 # The value can be set to, e.g., udp (ctrl_interface=udp)
65 #
66 # For Windows Named Pipe: This value can be used to set the security descriptor
67 # for controlling access to the control interface. Security descriptor can be
68 # set using Security Descriptor String Format (see http://msdn.microsoft.com/
69 # library/default.asp?url=/library/en-us/secauthz/security/
70 # security_descriptor_string_format.asp). The descriptor string needs to be
71 # prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
72 # DACL (which will reject all connections). See README-Windows.txt for more
73 # information about SDDL string format.
74 #
75 ctrl_interface=/var/run/wpa_supplicant
76
77 # IEEE 802.1X/EAPOL version
78 # wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
79 # EAPOL version 2. However, there are many APs that do not handle the new
80 # version number correctly (they seem to drop the frames completely). In order
81 # to make wpa_supplicant interoperate with these APs, the version number is set
82 # to 1 by default. This configuration value can be used to set it to the new
83 # version (2).
84 eapol_version=1
85
86 # AP scanning/selection
87 # By default, wpa_supplicant requests driver to perform AP scanning and then
88 # uses the scan results to select a suitable AP. Another alternative is to
89 # allow the driver to take care of AP scanning and selection and use
90 # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
91 # information from the driver.
92 # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
93 #    the currently enabled networks are found, a new network (IBSS or AP mode
94 #    operation) may be initialized (if configured) (default)
95 # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
96 #    parameters (e.g., WPA IE generation); this mode can also be used with
97 #    non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
98 #    APs (i.e., external program needs to control association). This mode must
99 #    also be used when using wired Ethernet drivers.
100 # 2: like 0, but associate with APs using security policy and SSID (but not
101 #    BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
102 #    enable operation with hidden SSIDs and optimized roaming; in this mode,
103 #    the network blocks in the configuration file are tried one by one until
104 #    the driver reports successful association; each network block should have
105 #    explicit security policy (i.e., only one option in the lists) for
106 #    key_mgmt, pairwise, group, proto variables
107 # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
108 # created immediately regardless of scan results. ap_scan=1 mode will first try
109 # to scan for existing networks and only if no matches with the enabled
110 # networks are found, a new IBSS or AP mode network is created.
111 ap_scan=1
112
113 # EAP fast re-authentication
114 # By default, fast re-authentication is enabled for all EAP methods that
115 # support it. This variable can be used to disable fast re-authentication.
116 # Normally, there is no need to disable this.
117 fast_reauth=1
118
119 # OpenSSL Engine support
120 # These options can be used to load OpenSSL engines.
121 # The two engines that are supported currently are shown below:
122 # They are both from the opensc project (http://www.opensc.org/)
123 # By default no engines are loaded.
124 # make the opensc engine available
125 #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
126 # make the pkcs11 engine available
127 #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
128 # configure the path to the pkcs11 module required by the pkcs11 engine
129 #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
130
131 # Dynamic EAP methods
132 # If EAP methods were built dynamically as shared object files, they need to be
133 # loaded here before being used in the network blocks. By default, EAP methods
134 # are included statically in the build, so these lines are not needed
135 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
136 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
137
138 # Driver interface parameters
139 # This field can be used to configure arbitrary driver interace parameters. The
140 # format is specific to the selected driver interface. This field is not used
141 # in most cases.
142 #driver_param="field=value"
143
144 # Country code
145 # The ISO/IEC alpha2 country code for the country in which this device is
146 # currently operating.
147 #country=US
148
149 # Maximum lifetime for PMKSA in seconds; default 43200
150 #dot11RSNAConfigPMKLifetime=43200
151 # Threshold for reauthentication (percentage of PMK lifetime); default 70
152 #dot11RSNAConfigPMKReauthThreshold=70
153 # Timeout for security association negotiation in seconds; default 60
154 #dot11RSNAConfigSATimeout=60
155
156 # Wi-Fi Protected Setup (WPS) parameters
157
158 # Universally Unique IDentifier (UUID; see RFC 4122) of the device
159 # If not configured, UUID will be generated based on the local MAC address.
160 #uuid=12345678-9abc-def0-1234-56789abcdef0
161
162 # Device Name
163 # User-friendly description of device; up to 32 octets encoded in UTF-8
164 #device_name=Wireless Client
165
166 # Manufacturer
167 # The manufacturer of the device (up to 64 ASCII characters)
168 #manufacturer=Company
169
170 # Model Name
171 # Model of the device (up to 32 ASCII characters)
172 #model_name=cmodel
173
174 # Model Number
175 # Additional device description (up to 32 ASCII characters)
176 #model_number=123
177
178 # Serial Number
179 # Serial number of the device (up to 32 characters)
180 #serial_number=12345
181
182 # Primary Device Type
183 # Used format: <categ>-<OUI>-<subcateg>
184 # categ = Category as an integer value
185 # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
186 #       default WPS OUI
187 # subcateg = OUI-specific Sub Category as an integer value
188 # Examples:
189 #   1-0050F204-1 (Computer / PC)
190 #   1-0050F204-2 (Computer / Server)
191 #   5-0050F204-1 (Storage / NAS)
192 #   6-0050F204-1 (Network Infrastructure / AP)
193 #device_type=1-0050F204-1
194
195 # OS Version
196 # 4-octet operating system version number (hex string)
197 #os_version=01020300
198
199 # Config Methods
200 # List of the supported configuration methods
201 # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
202 #       nfc_interface push_button keypad virtual_display physical_display
203 #       virtual_push_button physical_push_button
204 #config_methods=label virtual_display virtual_push_button keypad
205
206 # Credential processing
207 #   0 = process received credentials internally (default)
208 #   1 = do not process received credentials; just pass them over ctrl_iface to
209 #       external program(s)
210 #   2 = process received credentials internally and pass them over ctrl_iface
211 #       to external program(s)
212 #wps_cred_processing=0
213
214 # Maximum number of BSS entries to keep in memory
215 # Default: 200
216 # This can be used to limit memory use on the BSS entries (cached scan
217 # results). A larger value may be needed in environments that have huge number
218 # of APs when using ap_scan=1 mode.
219 #bss_max_count=200
220
221
222 # filter_ssids - SSID-based scan result filtering
223 # 0 = do not filter scan results (default)
224 # 1 = only include configured SSIDs in scan results/BSS table
225 #filter_ssids=0
226
227
228 # network block
229 #
230 # Each network (usually AP's sharing the same SSID) is configured as a separate
231 # block in this configuration file. The network blocks are in preference order
232 # (the first match is used).
233 #
234 # network block fields:
235 #
236 # disabled:
237 #       0 = this network can be used (default)
238 #       1 = this network block is disabled (can be enabled through ctrl_iface,
239 #           e.g., with wpa_cli or wpa_gui)
240 #
241 # id_str: Network identifier string for external scripts. This value is passed
242 #       to external action script through wpa_cli as WPA_ID_STR environment
243 #       variable to make it easier to do network specific configuration.
244 #
245 # ssid: SSID (mandatory); either as an ASCII string with double quotation or
246 #       as hex string; network name
247 #
248 # scan_ssid:
249 #       0 = do not scan this SSID with specific Probe Request frames (default)
250 #       1 = scan with SSID-specific Probe Request frames (this can be used to
251 #           find APs that do not accept broadcast SSID or use multiple SSIDs;
252 #           this will add latency to scanning, so enable this only when needed)
253 #
254 # bssid: BSSID (optional); if set, this network block is used only when
255 #       associating with the AP using the configured BSSID
256 #
257 # priority: priority group (integer)
258 # By default, all networks will get same priority group (0). If some of the
259 # networks are more desirable, this field can be used to change the order in
260 # which wpa_supplicant goes through the networks when selecting a BSS. The
261 # priority groups will be iterated in decreasing priority (i.e., the larger the
262 # priority value, the sooner the network is matched against the scan results).
263 # Within each priority group, networks will be selected based on security
264 # policy, signal strength, etc.
265 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
266 # using this priority to select the order for scanning. Instead, they try the
267 # networks in the order that used in the configuration file.
268 #
269 # mode: IEEE 802.11 operation mode
270 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
271 # 1 = IBSS (ad-hoc, peer-to-peer)
272 # 2 = AP (access point)
273 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
274 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
275 # following network block options:
276 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
277 # both), and psk must also be set.
278 #
279 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
280 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
281 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
282 # In addition, this value is only used by the station that creates the IBSS. If
283 # an IBSS network with the configured SSID is already present, the frequency of
284 # the network will be used instead of this configured value.
285 #
286 # scan_freq: List of frequencies to scan
287 # Space-separated list of frequencies in MHz to scan when searching for this
288 # BSS. If the subset of channels used by the network is known, this option can
289 # be used to optimize scanning to not occur on channels that the network does
290 # not use. Example: scan_freq=2412 2437 2462
291 #
292 # freq_list: Array of allowed frequencies
293 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
294 # set, scan results that do not match any of the specified frequencies are not
295 # considered when selecting a BSS.
296 #
297 # proto: list of accepted protocols
298 # WPA = WPA/IEEE 802.11i/D3.0
299 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
300 # If not set, this defaults to: WPA RSN
301 #
302 # key_mgmt: list of accepted authenticated key management protocols
303 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
304 # WPA-EAP = WPA using EAP authentication
305 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
306 #       generated WEP keys
307 # NONE = WPA is not used; plaintext or static WEP could be used
308 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
309 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
310 # If not set, this defaults to: WPA-PSK WPA-EAP
311 #
312 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
313 # OPEN = Open System authentication (required for WPA/WPA2)
314 # SHARED = Shared Key authentication (requires static WEP keys)
315 # LEAP = LEAP/Network EAP (only used with LEAP)
316 # If not set, automatic selection is used (Open System with LEAP enabled if
317 # LEAP is allowed as one of the EAP methods).
318 #
319 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
320 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
321 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
322 # NONE = Use only Group Keys (deprecated, should not be included if APs support
323 #       pairwise keys)
324 # If not set, this defaults to: CCMP TKIP
325 #
326 # group: list of accepted group (broadcast/multicast) ciphers for WPA
327 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
328 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
329 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
330 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
331 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
332 #
333 # psk: WPA preshared key; 256-bit pre-shared key
334 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
335 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
336 # generated using the passphrase and SSID). ASCII passphrase must be between
337 # 8 and 63 characters (inclusive).
338 # This field is not needed, if WPA-EAP is used.
339 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
340 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
341 # startup and reconfiguration time can be optimized by generating the PSK only
342 # only when the passphrase or SSID has actually changed.
343 #
344 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
345 # Dynamic WEP key required for non-WPA mode
346 # bit0 (1): require dynamically generated unicast WEP key
347 # bit1 (2): require dynamically generated broadcast WEP key
348 #       (3 = require both keys; default)
349 # Note: When using wired authentication, eapol_flags must be set to 0 for the
350 # authentication to be completed successfully.
351 #
352 # mixed_cell: This option can be used to configure whether so called mixed
353 # cells, i.e., networks that use both plaintext and encryption in the same
354 # SSID, are allowed when selecting a BSS form scan results.
355 # 0 = disabled (default)
356 # 1 = enabled
357 #
358 # proactive_key_caching:
359 # Enable/disable opportunistic PMKSA caching for WPA2.
360 # 0 = disabled (default)
361 # 1 = enabled
362 #
363 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
364 # hex without quotation, e.g., 0102030405)
365 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
366 #
367 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
368 # allowed. This is only used with RSN/WPA2.
369 # 0 = disabled (default)
370 # 1 = enabled
371 #peerkey=1
372 #
373 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
374 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
375 #
376 # Following fields are only used with internal EAP implementation.
377 # eap: space-separated list of accepted EAP methods
378 #       MD5 = EAP-MD5 (unsecure and does not generate keying material ->
379 #                       cannot be used with WPA; to be used as a Phase 2 method
380 #                       with EAP-PEAP or EAP-TTLS)
381 #       MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
382 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
383 #       OTP = EAP-OTP (cannot be used separately with WPA; to be used
384 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
385 #       GTC = EAP-GTC (cannot be used separately with WPA; to be used
386 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
387 #       TLS = EAP-TLS (client and server certificate)
388 #       PEAP = EAP-PEAP (with tunnelled EAP authentication)
389 #       TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
390 #                        authentication)
391 #       If not set, all compiled in methods are allowed.
392 #
393 # identity: Identity string for EAP
394 #       This field is also used to configure user NAI for
395 #       EAP-PSK/PAX/SAKE/GPSK.
396 # anonymous_identity: Anonymous identity string for EAP (to be used as the
397 #       unencrypted identity with EAP types that support different tunnelled
398 #       identity, e.g., EAP-TTLS)
399 # password: Password string for EAP. This field can include either the
400 #       plaintext password (using ASCII or hex string) or a NtPasswordHash
401 #       (16-byte MD4 hash of password) in hash:<32 hex digits> format.
402 #       NtPasswordHash can only be used when the password is for MSCHAPv2 or
403 #       MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
404 #       EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
405 #       PSK) is also configured using this field. For EAP-GPSK, this is a
406 #       variable length PSK.
407 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
408 #       or more trusted CA certificates. If ca_cert and ca_path are not
409 #       included, server certificate will not be verified. This is insecure and
410 #       a trusted CA certificate should always be configured when using
411 #       EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
412 #       change when wpa_supplicant is run in the background.
413 #
414 #       Alternatively, this can be used to only perform matching of the server
415 #       certificate (SHA-256 hash of the DER encoded X.509 certificate). In
416 #       this case, the possible CA certificates in the server certificate chain
417 #       are ignored and only the server certificate is verified. This is
418 #       configured with the following format:
419 #       hash:://server/sha256/cert_hash_in_hex
420 #       For example: "hash://server/sha256/
421 #       5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
422 #
423 #       On Windows, trusted CA certificates can be loaded from the system
424 #       certificate store by setting this to cert_store://<name>, e.g.,
425 #       ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
426 #       Note that when running wpa_supplicant as an application, the user
427 #       certificate store (My user account) is used, whereas computer store
428 #       (Computer account) is used when running wpasvc as a service.
429 # ca_path: Directory path for CA certificate files (PEM). This path may
430 #       contain multiple CA certificates in OpenSSL format. Common use for this
431 #       is to point to system trusted CA list which is often installed into
432 #       directory like /etc/ssl/certs. If configured, these certificates are
433 #       added to the list of trusted CAs. ca_cert may also be included in that
434 #       case, but it is not required.
435 # client_cert: File path to client certificate file (PEM/DER)
436 #       Full path should be used since working directory may change when
437 #       wpa_supplicant is run in the background.
438 #       Alternatively, a named configuration blob can be used by setting this
439 #       to blob://<blob name>.
440 # private_key: File path to client private key file (PEM/DER/PFX)
441 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
442 #       commented out. Both the private key and certificate will be read from
443 #       the PKCS#12 file in this case. Full path should be used since working
444 #       directory may change when wpa_supplicant is run in the background.
445 #       Windows certificate store can be used by leaving client_cert out and
446 #       configuring private_key in one of the following formats:
447 #       cert://substring_to_match
448 #       hash://certificate_thumbprint_in_hex
449 #       for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
450 #       Note that when running wpa_supplicant as an application, the user
451 #       certificate store (My user account) is used, whereas computer store
452 #       (Computer account) is used when running wpasvc as a service.
453 #       Alternatively, a named configuration blob can be used by setting this
454 #       to blob://<blob name>.
455 # private_key_passwd: Password for private key file (if left out, this will be
456 #       asked through control interface)
457 # dh_file: File path to DH/DSA parameters file (in PEM format)
458 #       This is an optional configuration file for setting parameters for an
459 #       ephemeral DH key exchange. In most cases, the default RSA
460 #       authentication does not use this configuration. However, it is possible
461 #       setup RSA to use ephemeral DH key exchange. In addition, ciphers with
462 #       DSA keys always use ephemeral DH keys. This can be used to achieve
463 #       forward secrecy. If the file is in DSA parameters format, it will be
464 #       automatically converted into DH params.
465 # subject_match: Substring to be matched against the subject of the
466 #       authentication server certificate. If this string is set, the server
467 #       sertificate is only accepted if it contains this string in the subject.
468 #       The subject string is in following format:
469 #       /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
470 # altsubject_match: Semicolon separated string of entries to be matched against
471 #       the alternative subject name of the authentication server certificate.
472 #       If this string is set, the server sertificate is only accepted if it
473 #       contains one of the entries in an alternative subject name extension.
474 #       altSubjectName string is in following format: TYPE:VALUE
475 #       Example: EMAIL:server@example.com
476 #       Example: DNS:server.example.com;DNS:server2.example.com
477 #       Following types are supported: EMAIL, DNS, URI
478 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
479 #       (string with field-value pairs, e.g., "peapver=0" or
480 #       "peapver=1 peaplabel=1")
481 #       'peapver' can be used to force which PEAP version (0 or 1) is used.
482 #       'peaplabel=1' can be used to force new label, "client PEAP encryption",
483 #       to be used during key derivation when PEAPv1 or newer. Most existing
484 #       PEAPv1 implementation seem to be using the old label, "client EAP
485 #       encryption", and wpa_supplicant is now using that as the default value.
486 #       Some servers, e.g., Radiator, may require peaplabel=1 configuration to
487 #       interoperate with PEAPv1; see eap_testing.txt for more details.
488 #       'peap_outer_success=0' can be used to terminate PEAP authentication on
489 #       tunneled EAP-Success. This is required with some RADIUS servers that
490 #       implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
491 #       Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
492 #       include_tls_length=1 can be used to force wpa_supplicant to include
493 #       TLS Message Length field in all TLS messages even if they are not
494 #       fragmented.
495 #       sim_min_num_chal=3 can be used to configure EAP-SIM to require three
496 #       challenges (by default, it accepts 2 or 3)
497 #       result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
498 #       protected result indication.
499 #       'crypto_binding' option can be used to control PEAPv0 cryptobinding
500 #       behavior:
501 #        * 0 = do not use cryptobinding (default)
502 #        * 1 = use cryptobinding if server supports it
503 #        * 2 = require cryptobinding
504 #       EAP-WSC (WPS) uses following options: pin=<Device Password> or
505 #       pbc=1.
506 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
507 #       (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
508 #       "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
509 # Following certificate/private key fields are used in inner Phase2
510 # authentication when using EAP-TTLS or EAP-PEAP.
511 # ca_cert2: File path to CA certificate file. This file can have one or more
512 #       trusted CA certificates. If ca_cert2 and ca_path2 are not included,
513 #       server certificate will not be verified. This is insecure and a trusted
514 #       CA certificate should always be configured.
515 # ca_path2: Directory path for CA certificate files (PEM)
516 # client_cert2: File path to client certificate file
517 # private_key2: File path to client private key file
518 # private_key2_passwd: Password for private key file
519 # dh_file2: File path to DH/DSA parameters file (in PEM format)
520 # subject_match2: Substring to be matched against the subject of the
521 #       authentication server certificate.
522 # altsubject_match2: Substring to be matched against the alternative subject
523 #       name of the authentication server certificate.
524 #
525 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
526 #       This value limits the fragment size for EAP methods that support
527 #       fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
528 #       small enough to make the EAP messages fit in MTU of the network
529 #       interface used for EAPOL. The default value is suitable for most
530 #       cases.
531 #
532 # EAP-FAST variables:
533 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
534 #       to create this file and write updates to it when PAC is being
535 #       provisioned or refreshed. Full path to the file should be used since
536 #       working directory may change when wpa_supplicant is run in the
537 #       background. Alternatively, a named configuration blob can be used by
538 #       setting this to blob://<blob name>
539 # phase1: fast_provisioning option can be used to enable in-line provisioning
540 #         of EAP-FAST credentials (PAC):
541 #         0 = disabled,
542 #         1 = allow unauthenticated provisioning,
543 #         2 = allow authenticated provisioning,
544 #         3 = allow both unauthenticated and authenticated provisioning
545 #       fast_max_pac_list_len=<num> option can be used to set the maximum
546 #               number of PAC entries to store in a PAC list (default: 10)
547 #       fast_pac_format=binary option can be used to select binary format for
548 #               storing PAC entries in order to save some space (the default
549 #               text format uses about 2.5 times the size of minimal binary
550 #               format)
551 #
552 # wpa_supplicant supports number of "EAP workarounds" to work around
553 # interoperability issues with incorrectly behaving authentication servers.
554 # These are enabled by default because some of the issues are present in large
555 # number of authentication servers. Strict EAP conformance mode can be
556 # configured by disabling workarounds with eap_workaround=0.
557
558 # Example blocks:
559
560 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
561 network={
562         ssid="simple"
563         psk="very secret passphrase"
564         priority=5
565 }
566
567 # Same as previous, but request SSID-specific scanning (for APs that reject
568 # broadcast SSID)
569 network={
570         ssid="second ssid"
571         scan_ssid=1
572         psk="very secret passphrase"
573         priority=2
574 }
575
576 # Only WPA-PSK is used. Any valid cipher combination is accepted.
577 network={
578         ssid="example"
579         proto=WPA
580         key_mgmt=WPA-PSK
581         pairwise=CCMP TKIP
582         group=CCMP TKIP WEP104 WEP40
583         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
584         priority=2
585 }
586
587 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
588 network={
589         ssid="example"
590         proto=WPA
591         key_mgmt=WPA-PSK
592         pairwise=TKIP
593         group=TKIP
594         psk="not so secure passphrase"
595         wpa_ptk_rekey=600
596 }
597
598 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
599 # or WEP40 as the group cipher will not be accepted.
600 network={
601         ssid="example"
602         proto=RSN
603         key_mgmt=WPA-EAP
604         pairwise=CCMP TKIP
605         group=CCMP TKIP
606         eap=TLS
607         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"
612         priority=1
613 }
614
615 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
616 # (e.g., Radiator)
617 network={
618         ssid="example"
619         key_mgmt=WPA-EAP
620         eap=PEAP
621         identity="user@example.com"
622         password="foobar"
623         ca_cert="/etc/cert/ca.pem"
624         phase1="peaplabel=1"
625         phase2="auth=MSCHAPV2"
626         priority=10
627 }
628
629 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
630 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
631 network={
632         ssid="example"
633         key_mgmt=WPA-EAP
634         eap=TTLS
635         identity="user@example.com"
636         anonymous_identity="anonymous@example.com"
637         password="foobar"
638         ca_cert="/etc/cert/ca.pem"
639         priority=2
640 }
641
642 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
643 # use. Real identity is sent only within an encrypted TLS tunnel.
644 network={
645         ssid="example"
646         key_mgmt=WPA-EAP
647         eap=TTLS
648         identity="user@example.com"
649         anonymous_identity="anonymous@example.com"
650         password="foobar"
651         ca_cert="/etc/cert/ca.pem"
652         phase2="auth=MSCHAPV2"
653 }
654
655 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
656 # authentication.
657 network={
658         ssid="example"
659         key_mgmt=WPA-EAP
660         eap=TTLS
661         # Phase1 / outer authentication
662         anonymous_identity="anonymous@example.com"
663         ca_cert="/etc/cert/ca.pem"
664         # Phase 2 / inner authentication
665         phase2="autheap=TLS"
666         ca_cert2="/etc/cert/ca2.pem"
667         client_cert2="/etc/cer/user.pem"
668         private_key2="/etc/cer/user.prv"
669         private_key2_passwd="password"
670         priority=2
671 }
672
673 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
674 # group cipher.
675 network={
676         ssid="example"
677         bssid=00:11:22:33:44:55
678         proto=WPA RSN
679         key_mgmt=WPA-PSK WPA-EAP
680         pairwise=CCMP
681         group=CCMP
682         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
683 }
684
685 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
686 # and all valid ciphers.
687 network={
688         ssid=00010203
689         psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
690 }
691
692
693 # EAP-SIM with a GSM SIM or USIM
694 network={
695         ssid="eap-sim-test"
696         key_mgmt=WPA-EAP
697         eap=SIM
698         pin="1234"
699         pcsc=""
700 }
701
702
703 # EAP-PSK
704 network={
705         ssid="eap-psk-test"
706         key_mgmt=WPA-EAP
707         eap=PSK
708         anonymous_identity="eap_psk_user"
709         password=06b4be19da289f475aa46a33cb793029
710         identity="eap_psk_user@example.com"
711 }
712
713
714 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
715 # EAP-TLS for authentication and key generation; require both unicast and
716 # broadcast WEP keys.
717 network={
718         ssid="1x-test"
719         key_mgmt=IEEE8021X
720         eap=TLS
721         identity="user@example.com"
722         ca_cert="/etc/cert/ca.pem"
723         client_cert="/etc/cert/user.pem"
724         private_key="/etc/cert/user.prv"
725         private_key_passwd="password"
726         eapol_flags=3
727 }
728
729
730 # LEAP with dynamic WEP keys
731 network={
732         ssid="leap-example"
733         key_mgmt=IEEE8021X
734         eap=LEAP
735         identity="user"
736         password="foobar"
737 }
738
739 # EAP-IKEv2 using shared secrets for both server and peer authentication
740 network={
741         ssid="ikev2-example"
742         key_mgmt=WPA-EAP
743         eap=IKEV2
744         identity="user"
745         password="foobar"
746 }
747
748 # EAP-FAST with WPA (WPA or WPA2)
749 network={
750         ssid="eap-fast-test"
751         key_mgmt=WPA-EAP
752         eap=FAST
753         anonymous_identity="FAST-000102030405"
754         identity="username"
755         password="password"
756         phase1="fast_provisioning=1"
757         pac_file="/etc/wpa_supplicant.eap-fast-pac"
758 }
759
760 network={
761         ssid="eap-fast-test"
762         key_mgmt=WPA-EAP
763         eap=FAST
764         anonymous_identity="FAST-000102030405"
765         identity="username"
766         password="password"
767         phase1="fast_provisioning=1"
768         pac_file="blob://eap-fast-pac"
769 }
770
771 # Plaintext connection (no WPA, no IEEE 802.1X)
772 network={
773         ssid="plaintext-test"
774         key_mgmt=NONE
775 }
776
777
778 # Shared WEP key connection (no WPA, no IEEE 802.1X)
779 network={
780         ssid="static-wep-test"
781         key_mgmt=NONE
782         wep_key0="abcde"
783         wep_key1=0102030405
784         wep_key2="1234567890123"
785         wep_tx_keyidx=0
786         priority=5
787 }
788
789
790 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
791 # IEEE 802.11 authentication
792 network={
793         ssid="static-wep-test2"
794         key_mgmt=NONE
795         wep_key0="abcde"
796         wep_key1=0102030405
797         wep_key2="1234567890123"
798         wep_tx_keyidx=0
799         priority=5
800         auth_alg=SHARED
801 }
802
803
804 # IBSS/ad-hoc network with WPA-None/TKIP.
805 network={
806         ssid="test adhoc"
807         mode=1
808         frequency=2412
809         proto=WPA
810         key_mgmt=WPA-NONE
811         pairwise=NONE
812         group=TKIP
813         psk="secret passphrase"
814 }
815
816
817 # Catch all example that allows more or less all configuration modes
818 network={
819         ssid="example"
820         scan_ssid=1
821         key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
822         pairwise=CCMP TKIP
823         group=CCMP TKIP WEP104 WEP40
824         psk="very secret passphrase"
825         eap=TTLS PEAP TLS
826         identity="user@example.com"
827         password="foobar"
828         ca_cert="/etc/cert/ca.pem"
829         client_cert="/etc/cert/user.pem"
830         private_key="/etc/cert/user.prv"
831         private_key_passwd="password"
832         phase1="peaplabel=0"
833 }
834
835 # Example of EAP-TLS with smartcard (openssl engine)
836 network={
837         ssid="example"
838         key_mgmt=WPA-EAP
839         eap=TLS
840         proto=RSN
841         pairwise=CCMP TKIP
842         group=CCMP TKIP
843         identity="user@example.com"
844         ca_cert="/etc/cert/ca.pem"
845         client_cert="/etc/cert/user.pem"
846
847         engine=1
848
849         # The engine configured here must be available. Look at
850         # OpenSSL engine support in the global section.
851         # The key available through the engine must be the private key
852         # matching the client certificate configured above.
853
854         # use the opensc engine
855         #engine_id="opensc"
856         #key_id="45"
857
858         # use the pkcs11 engine
859         engine_id="pkcs11"
860         key_id="id_45"
861
862         # Optional PIN configuration; this can be left out and PIN will be
863         # asked through the control interface
864         pin="1234"
865 }
866
867 # Example configuration showing how to use an inlined blob as a CA certificate
868 # data instead of using external file
869 network={
870         ssid="example"
871         key_mgmt=WPA-EAP
872         eap=TTLS
873         identity="user@example.com"
874         anonymous_identity="anonymous@example.com"
875         password="foobar"
876         ca_cert="blob://exampleblob"
877         priority=20
878 }
879
880 blob-base64-exampleblob={
881 SGVsbG8gV29ybGQhCg==
882 }
883
884
885 # Wildcard match for SSID (plaintext APs only). This example select any
886 # open AP regardless of its SSID.
887 network={
888         key_mgmt=NONE
889 }