Interworking: Update configuration file documentation for credentials
[mech_eap.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 existence 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 # For WSC 1.0:
205 #config_methods=label display push_button keypad
206 # For WSC 2.0:
207 #config_methods=label virtual_display virtual_push_button keypad
208
209 # Credential processing
210 #   0 = process received credentials internally (default)
211 #   1 = do not process received credentials; just pass them over ctrl_iface to
212 #       external program(s)
213 #   2 = process received credentials internally and pass them over ctrl_iface
214 #       to external program(s)
215 #wps_cred_processing=0
216
217 # Maximum number of BSS entries to keep in memory
218 # Default: 200
219 # This can be used to limit memory use on the BSS entries (cached scan
220 # results). A larger value may be needed in environments that have huge number
221 # of APs when using ap_scan=1 mode.
222 #bss_max_count=200
223
224
225 # filter_ssids - SSID-based scan result filtering
226 # 0 = do not filter scan results (default)
227 # 1 = only include configured SSIDs in scan results/BSS table
228 #filter_ssids=0
229
230
231 # Interworking (IEEE 802.11u)
232
233 # Enable Interworking
234 # interworking=1
235
236 # Homogenous ESS identifier
237 # If this is set, scans will be used to request response only from BSSes
238 # belonging to the specified Homogeneous ESS. This is used only if interworking
239 # is enabled.
240 # hessid=00:11:22:33:44:55
241
242 # credential block
243 #
244 # Each credential used for automatic network selection is configured as a set
245 # of parameters that are compared to the information advertised by the APs when
246 # interworking_select and interworking_connect commands are used.
247 #
248 # credential fields:
249 #
250 # priority: Priority group
251 #       By default, all networks and credentials get the same priority group
252 #       (0). This field can be used to give higher priority for credentials
253 #       (and similarly in struct wpa_ssid for network blocks) to change the
254 #       Interworking automatic networking selection behavior. The matching
255 #       network (based on either an enabled network block or a credential)
256 #       with the highest priority value will be selected.
257 #
258 # realm: Home Realm for Interworking
259 #
260 # username: Username for Interworking network selection
261 #
262 # password: Password for Interworking network selection
263 #
264 # ca_cert: CA certificate for Interworking network selection
265 #
266 # client_cert: File path to client certificate file (PEM/DER)
267 #       This field is used with Interworking networking selection for a case
268 #       where client certificate/private key is used for authentication
269 #       (EAP-TLS). Full path to the file should be used since working
270 #       directory may change when wpa_supplicant is run in the background.
271 #
272 #       Alternatively, a named configuration blob can be used by setting
273 #       this to blob://blob_name.
274 #
275 # private_key: File path to client private key file (PEM/DER/PFX)
276 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
277 #       commented out. Both the private key and certificate will be read
278 #       from the PKCS#12 file in this case. Full path to the file should be
279 #       used since working directory may change when wpa_supplicant is run
280 #       in the background.
281 #
282 #       Windows certificate store can be used by leaving client_cert out and
283 #       configuring private_key in one of the following formats:
284 #
285 #       cert://substring_to_match
286 #
287 #       hash://certificate_thumbprint_in_hex
288 #
289 #       For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
290 #
291 #       Note that when running wpa_supplicant as an application, the user
292 #       certificate store (My user account) is used, whereas computer store
293 #       (Computer account) is used when running wpasvc as a service.
294 #
295 #       Alternatively, a named configuration blob can be used by setting
296 #       this to blob://blob_name.
297 #
298 # private_key_passwd: Password for private key file
299 #
300 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
301 #
302 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
303 #       format
304 #
305 # domain: Home service provider FQDN
306 #       This is used to compare against the Domain Name List to figure out
307 #       whether the AP is operated by the Home SP.
308 #
309 # for example:
310 #
311 #cred={
312 #       realm="example.com"
313 #       username="user@example.com"
314 #       password="password"
315 #       ca_cert="/etc/wpa_supplicant/ca.pem"
316 #       domain="example.com"
317 #}
318 #
319 #cred={
320 #       imsi="310026-000000000"
321 #       milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82
322 #}
323
324 # network block
325 #
326 # Each network (usually AP's sharing the same SSID) is configured as a separate
327 # block in this configuration file. The network blocks are in preference order
328 # (the first match is used).
329 #
330 # network block fields:
331 #
332 # disabled:
333 #       0 = this network can be used (default)
334 #       1 = this network block is disabled (can be enabled through ctrl_iface,
335 #           e.g., with wpa_cli or wpa_gui)
336 #
337 # id_str: Network identifier string for external scripts. This value is passed
338 #       to external action script through wpa_cli as WPA_ID_STR environment
339 #       variable to make it easier to do network specific configuration.
340 #
341 # ssid: SSID (mandatory); either as an ASCII string with double quotation or
342 #       as hex string; network name
343 #
344 # scan_ssid:
345 #       0 = do not scan this SSID with specific Probe Request frames (default)
346 #       1 = scan with SSID-specific Probe Request frames (this can be used to
347 #           find APs that do not accept broadcast SSID or use multiple SSIDs;
348 #           this will add latency to scanning, so enable this only when needed)
349 #
350 # bssid: BSSID (optional); if set, this network block is used only when
351 #       associating with the AP using the configured BSSID
352 #
353 # priority: priority group (integer)
354 # By default, all networks will get same priority group (0). If some of the
355 # networks are more desirable, this field can be used to change the order in
356 # which wpa_supplicant goes through the networks when selecting a BSS. The
357 # priority groups will be iterated in decreasing priority (i.e., the larger the
358 # priority value, the sooner the network is matched against the scan results).
359 # Within each priority group, networks will be selected based on security
360 # policy, signal strength, etc.
361 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
362 # using this priority to select the order for scanning. Instead, they try the
363 # networks in the order that used in the configuration file.
364 #
365 # mode: IEEE 802.11 operation mode
366 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
367 # 1 = IBSS (ad-hoc, peer-to-peer)
368 # 2 = AP (access point)
369 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
370 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
371 # following network block options:
372 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
373 # both), and psk must also be set.
374 #
375 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
376 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
377 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
378 # In addition, this value is only used by the station that creates the IBSS. If
379 # an IBSS network with the configured SSID is already present, the frequency of
380 # the network will be used instead of this configured value.
381 #
382 # scan_freq: List of frequencies to scan
383 # Space-separated list of frequencies in MHz to scan when searching for this
384 # BSS. If the subset of channels used by the network is known, this option can
385 # be used to optimize scanning to not occur on channels that the network does
386 # not use. Example: scan_freq=2412 2437 2462
387 #
388 # freq_list: Array of allowed frequencies
389 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
390 # set, scan results that do not match any of the specified frequencies are not
391 # considered when selecting a BSS.
392 #
393 # proto: list of accepted protocols
394 # WPA = WPA/IEEE 802.11i/D3.0
395 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
396 # If not set, this defaults to: WPA RSN
397 #
398 # key_mgmt: list of accepted authenticated key management protocols
399 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
400 # WPA-EAP = WPA using EAP authentication
401 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
402 #       generated WEP keys
403 # NONE = WPA is not used; plaintext or static WEP could be used
404 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
405 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
406 # If not set, this defaults to: WPA-PSK WPA-EAP
407 #
408 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
409 # OPEN = Open System authentication (required for WPA/WPA2)
410 # SHARED = Shared Key authentication (requires static WEP keys)
411 # LEAP = LEAP/Network EAP (only used with LEAP)
412 # If not set, automatic selection is used (Open System with LEAP enabled if
413 # LEAP is allowed as one of the EAP methods).
414 #
415 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
416 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
417 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
418 # NONE = Use only Group Keys (deprecated, should not be included if APs support
419 #       pairwise keys)
420 # If not set, this defaults to: CCMP TKIP
421 #
422 # group: list of accepted group (broadcast/multicast) ciphers for WPA
423 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
424 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
425 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
426 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
427 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
428 #
429 # psk: WPA preshared key; 256-bit pre-shared key
430 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
431 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
432 # generated using the passphrase and SSID). ASCII passphrase must be between
433 # 8 and 63 characters (inclusive).
434 # This field is not needed, if WPA-EAP is used.
435 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
436 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
437 # startup and reconfiguration time can be optimized by generating the PSK only
438 # only when the passphrase or SSID has actually changed.
439 #
440 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
441 # Dynamic WEP key required for non-WPA mode
442 # bit0 (1): require dynamically generated unicast WEP key
443 # bit1 (2): require dynamically generated broadcast WEP key
444 #       (3 = require both keys; default)
445 # Note: When using wired authentication, eapol_flags must be set to 0 for the
446 # authentication to be completed successfully.
447 #
448 # mixed_cell: This option can be used to configure whether so called mixed
449 # cells, i.e., networks that use both plaintext and encryption in the same
450 # SSID, are allowed when selecting a BSS from scan results.
451 # 0 = disabled (default)
452 # 1 = enabled
453 #
454 # proactive_key_caching:
455 # Enable/disable opportunistic PMKSA caching for WPA2.
456 # 0 = disabled (default)
457 # 1 = enabled
458 #
459 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
460 # hex without quotation, e.g., 0102030405)
461 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
462 #
463 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
464 # allowed. This is only used with RSN/WPA2.
465 # 0 = disabled (default)
466 # 1 = enabled
467 #peerkey=1
468 #
469 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
470 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
471 #
472 # Following fields are only used with internal EAP implementation.
473 # eap: space-separated list of accepted EAP methods
474 #       MD5 = EAP-MD5 (unsecure and does not generate keying material ->
475 #                       cannot be used with WPA; to be used as a Phase 2 method
476 #                       with EAP-PEAP or EAP-TTLS)
477 #       MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
478 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
479 #       OTP = EAP-OTP (cannot be used separately with WPA; to be used
480 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
481 #       GTC = EAP-GTC (cannot be used separately with WPA; to be used
482 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
483 #       TLS = EAP-TLS (client and server certificate)
484 #       PEAP = EAP-PEAP (with tunnelled EAP authentication)
485 #       TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
486 #                        authentication)
487 #       If not set, all compiled in methods are allowed.
488 #
489 # identity: Identity string for EAP
490 #       This field is also used to configure user NAI for
491 #       EAP-PSK/PAX/SAKE/GPSK.
492 # anonymous_identity: Anonymous identity string for EAP (to be used as the
493 #       unencrypted identity with EAP types that support different tunnelled
494 #       identity, e.g., EAP-TTLS)
495 # password: Password string for EAP. This field can include either the
496 #       plaintext password (using ASCII or hex string) or a NtPasswordHash
497 #       (16-byte MD4 hash of password) in hash:<32 hex digits> format.
498 #       NtPasswordHash can only be used when the password is for MSCHAPv2 or
499 #       MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
500 #       EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
501 #       PSK) is also configured using this field. For EAP-GPSK, this is a
502 #       variable length PSK.
503 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
504 #       or more trusted CA certificates. If ca_cert and ca_path are not
505 #       included, server certificate will not be verified. This is insecure and
506 #       a trusted CA certificate should always be configured when using
507 #       EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
508 #       change when wpa_supplicant is run in the background.
509 #
510 #       Alternatively, this can be used to only perform matching of the server
511 #       certificate (SHA-256 hash of the DER encoded X.509 certificate). In
512 #       this case, the possible CA certificates in the server certificate chain
513 #       are ignored and only the server certificate is verified. This is
514 #       configured with the following format:
515 #       hash:://server/sha256/cert_hash_in_hex
516 #       For example: "hash://server/sha256/
517 #       5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
518 #
519 #       On Windows, trusted CA certificates can be loaded from the system
520 #       certificate store by setting this to cert_store://<name>, e.g.,
521 #       ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
522 #       Note that when running wpa_supplicant as an application, the user
523 #       certificate store (My user account) is used, whereas computer store
524 #       (Computer account) is used when running wpasvc as a service.
525 # ca_path: Directory path for CA certificate files (PEM). This path may
526 #       contain multiple CA certificates in OpenSSL format. Common use for this
527 #       is to point to system trusted CA list which is often installed into
528 #       directory like /etc/ssl/certs. If configured, these certificates are
529 #       added to the list of trusted CAs. ca_cert may also be included in that
530 #       case, but it is not required.
531 # client_cert: File path to client certificate file (PEM/DER)
532 #       Full path should be used since working directory may change when
533 #       wpa_supplicant is run in the background.
534 #       Alternatively, a named configuration blob can be used by setting this
535 #       to blob://<blob name>.
536 # private_key: File path to client private key file (PEM/DER/PFX)
537 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
538 #       commented out. Both the private key and certificate will be read from
539 #       the PKCS#12 file in this case. Full path should be used since working
540 #       directory may change when wpa_supplicant is run in the background.
541 #       Windows certificate store can be used by leaving client_cert out and
542 #       configuring private_key in one of the following formats:
543 #       cert://substring_to_match
544 #       hash://certificate_thumbprint_in_hex
545 #       for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
546 #       Note that when running wpa_supplicant as an application, the user
547 #       certificate store (My user account) is used, whereas computer store
548 #       (Computer account) is used when running wpasvc as a service.
549 #       Alternatively, a named configuration blob can be used by setting this
550 #       to blob://<blob name>.
551 # private_key_passwd: Password for private key file (if left out, this will be
552 #       asked through control interface)
553 # dh_file: File path to DH/DSA parameters file (in PEM format)
554 #       This is an optional configuration file for setting parameters for an
555 #       ephemeral DH key exchange. In most cases, the default RSA
556 #       authentication does not use this configuration. However, it is possible
557 #       setup RSA to use ephemeral DH key exchange. In addition, ciphers with
558 #       DSA keys always use ephemeral DH keys. This can be used to achieve
559 #       forward secrecy. If the file is in DSA parameters format, it will be
560 #       automatically converted into DH params.
561 # subject_match: Substring to be matched against the subject of the
562 #       authentication server certificate. If this string is set, the server
563 #       sertificate is only accepted if it contains this string in the subject.
564 #       The subject string is in following format:
565 #       /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
566 # altsubject_match: Semicolon separated string of entries to be matched against
567 #       the alternative subject name of the authentication server certificate.
568 #       If this string is set, the server sertificate is only accepted if it
569 #       contains one of the entries in an alternative subject name extension.
570 #       altSubjectName string is in following format: TYPE:VALUE
571 #       Example: EMAIL:server@example.com
572 #       Example: DNS:server.example.com;DNS:server2.example.com
573 #       Following types are supported: EMAIL, DNS, URI
574 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
575 #       (string with field-value pairs, e.g., "peapver=0" or
576 #       "peapver=1 peaplabel=1")
577 #       'peapver' can be used to force which PEAP version (0 or 1) is used.
578 #       'peaplabel=1' can be used to force new label, "client PEAP encryption",
579 #       to be used during key derivation when PEAPv1 or newer. Most existing
580 #       PEAPv1 implementation seem to be using the old label, "client EAP
581 #       encryption", and wpa_supplicant is now using that as the default value.
582 #       Some servers, e.g., Radiator, may require peaplabel=1 configuration to
583 #       interoperate with PEAPv1; see eap_testing.txt for more details.
584 #       'peap_outer_success=0' can be used to terminate PEAP authentication on
585 #       tunneled EAP-Success. This is required with some RADIUS servers that
586 #       implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
587 #       Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
588 #       include_tls_length=1 can be used to force wpa_supplicant to include
589 #       TLS Message Length field in all TLS messages even if they are not
590 #       fragmented.
591 #       sim_min_num_chal=3 can be used to configure EAP-SIM to require three
592 #       challenges (by default, it accepts 2 or 3)
593 #       result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
594 #       protected result indication.
595 #       'crypto_binding' option can be used to control PEAPv0 cryptobinding
596 #       behavior:
597 #        * 0 = do not use cryptobinding (default)
598 #        * 1 = use cryptobinding if server supports it
599 #        * 2 = require cryptobinding
600 #       EAP-WSC (WPS) uses following options: pin=<Device Password> or
601 #       pbc=1.
602 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
603 #       (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
604 #       "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
605 # Following certificate/private key fields are used in inner Phase2
606 # authentication when using EAP-TTLS or EAP-PEAP.
607 # ca_cert2: File path to CA certificate file. This file can have one or more
608 #       trusted CA certificates. If ca_cert2 and ca_path2 are not included,
609 #       server certificate will not be verified. This is insecure and a trusted
610 #       CA certificate should always be configured.
611 # ca_path2: Directory path for CA certificate files (PEM)
612 # client_cert2: File path to client certificate file
613 # private_key2: File path to client private key file
614 # private_key2_passwd: Password for private key file
615 # dh_file2: File path to DH/DSA parameters file (in PEM format)
616 # subject_match2: Substring to be matched against the subject of the
617 #       authentication server certificate.
618 # altsubject_match2: Substring to be matched against the alternative subject
619 #       name of the authentication server certificate.
620 #
621 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
622 #       This value limits the fragment size for EAP methods that support
623 #       fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
624 #       small enough to make the EAP messages fit in MTU of the network
625 #       interface used for EAPOL. The default value is suitable for most
626 #       cases.
627 #
628 # EAP-FAST variables:
629 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
630 #       to create this file and write updates to it when PAC is being
631 #       provisioned or refreshed. Full path to the file should be used since
632 #       working directory may change when wpa_supplicant is run in the
633 #       background. Alternatively, a named configuration blob can be used by
634 #       setting this to blob://<blob name>
635 # phase1: fast_provisioning option can be used to enable in-line provisioning
636 #         of EAP-FAST credentials (PAC):
637 #         0 = disabled,
638 #         1 = allow unauthenticated provisioning,
639 #         2 = allow authenticated provisioning,
640 #         3 = allow both unauthenticated and authenticated provisioning
641 #       fast_max_pac_list_len=<num> option can be used to set the maximum
642 #               number of PAC entries to store in a PAC list (default: 10)
643 #       fast_pac_format=binary option can be used to select binary format for
644 #               storing PAC entries in order to save some space (the default
645 #               text format uses about 2.5 times the size of minimal binary
646 #               format)
647 #
648 # wpa_supplicant supports number of "EAP workarounds" to work around
649 # interoperability issues with incorrectly behaving authentication servers.
650 # These are enabled by default because some of the issues are present in large
651 # number of authentication servers. Strict EAP conformance mode can be
652 # configured by disabling workarounds with eap_workaround=0.
653
654 # Example blocks:
655
656 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
657 network={
658         ssid="simple"
659         psk="very secret passphrase"
660         priority=5
661 }
662
663 # Same as previous, but request SSID-specific scanning (for APs that reject
664 # broadcast SSID)
665 network={
666         ssid="second ssid"
667         scan_ssid=1
668         psk="very secret passphrase"
669         priority=2
670 }
671
672 # Only WPA-PSK is used. Any valid cipher combination is accepted.
673 network={
674         ssid="example"
675         proto=WPA
676         key_mgmt=WPA-PSK
677         pairwise=CCMP TKIP
678         group=CCMP TKIP WEP104 WEP40
679         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
680         priority=2
681 }
682
683 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
684 network={
685         ssid="example"
686         proto=WPA
687         key_mgmt=WPA-PSK
688         pairwise=TKIP
689         group=TKIP
690         psk="not so secure passphrase"
691         wpa_ptk_rekey=600
692 }
693
694 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
695 # or WEP40 as the group cipher will not be accepted.
696 network={
697         ssid="example"
698         proto=RSN
699         key_mgmt=WPA-EAP
700         pairwise=CCMP TKIP
701         group=CCMP TKIP
702         eap=TLS
703         identity="user@example.com"
704         ca_cert="/etc/cert/ca.pem"
705         client_cert="/etc/cert/user.pem"
706         private_key="/etc/cert/user.prv"
707         private_key_passwd="password"
708         priority=1
709 }
710
711 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
712 # (e.g., Radiator)
713 network={
714         ssid="example"
715         key_mgmt=WPA-EAP
716         eap=PEAP
717         identity="user@example.com"
718         password="foobar"
719         ca_cert="/etc/cert/ca.pem"
720         phase1="peaplabel=1"
721         phase2="auth=MSCHAPV2"
722         priority=10
723 }
724
725 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
726 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
727 network={
728         ssid="example"
729         key_mgmt=WPA-EAP
730         eap=TTLS
731         identity="user@example.com"
732         anonymous_identity="anonymous@example.com"
733         password="foobar"
734         ca_cert="/etc/cert/ca.pem"
735         priority=2
736 }
737
738 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
739 # use. Real identity is sent only within an encrypted TLS tunnel.
740 network={
741         ssid="example"
742         key_mgmt=WPA-EAP
743         eap=TTLS
744         identity="user@example.com"
745         anonymous_identity="anonymous@example.com"
746         password="foobar"
747         ca_cert="/etc/cert/ca.pem"
748         phase2="auth=MSCHAPV2"
749 }
750
751 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
752 # authentication.
753 network={
754         ssid="example"
755         key_mgmt=WPA-EAP
756         eap=TTLS
757         # Phase1 / outer authentication
758         anonymous_identity="anonymous@example.com"
759         ca_cert="/etc/cert/ca.pem"
760         # Phase 2 / inner authentication
761         phase2="autheap=TLS"
762         ca_cert2="/etc/cert/ca2.pem"
763         client_cert2="/etc/cer/user.pem"
764         private_key2="/etc/cer/user.prv"
765         private_key2_passwd="password"
766         priority=2
767 }
768
769 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
770 # group cipher.
771 network={
772         ssid="example"
773         bssid=00:11:22:33:44:55
774         proto=WPA RSN
775         key_mgmt=WPA-PSK WPA-EAP
776         pairwise=CCMP
777         group=CCMP
778         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
779 }
780
781 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
782 # and all valid ciphers.
783 network={
784         ssid=00010203
785         psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
786 }
787
788
789 # EAP-SIM with a GSM SIM or USIM
790 network={
791         ssid="eap-sim-test"
792         key_mgmt=WPA-EAP
793         eap=SIM
794         pin="1234"
795         pcsc=""
796 }
797
798
799 # EAP-PSK
800 network={
801         ssid="eap-psk-test"
802         key_mgmt=WPA-EAP
803         eap=PSK
804         anonymous_identity="eap_psk_user"
805         password=06b4be19da289f475aa46a33cb793029
806         identity="eap_psk_user@example.com"
807 }
808
809
810 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
811 # EAP-TLS for authentication and key generation; require both unicast and
812 # broadcast WEP keys.
813 network={
814         ssid="1x-test"
815         key_mgmt=IEEE8021X
816         eap=TLS
817         identity="user@example.com"
818         ca_cert="/etc/cert/ca.pem"
819         client_cert="/etc/cert/user.pem"
820         private_key="/etc/cert/user.prv"
821         private_key_passwd="password"
822         eapol_flags=3
823 }
824
825
826 # LEAP with dynamic WEP keys
827 network={
828         ssid="leap-example"
829         key_mgmt=IEEE8021X
830         eap=LEAP
831         identity="user"
832         password="foobar"
833 }
834
835 # EAP-IKEv2 using shared secrets for both server and peer authentication
836 network={
837         ssid="ikev2-example"
838         key_mgmt=WPA-EAP
839         eap=IKEV2
840         identity="user"
841         password="foobar"
842 }
843
844 # EAP-FAST with WPA (WPA or WPA2)
845 network={
846         ssid="eap-fast-test"
847         key_mgmt=WPA-EAP
848         eap=FAST
849         anonymous_identity="FAST-000102030405"
850         identity="username"
851         password="password"
852         phase1="fast_provisioning=1"
853         pac_file="/etc/wpa_supplicant.eap-fast-pac"
854 }
855
856 network={
857         ssid="eap-fast-test"
858         key_mgmt=WPA-EAP
859         eap=FAST
860         anonymous_identity="FAST-000102030405"
861         identity="username"
862         password="password"
863         phase1="fast_provisioning=1"
864         pac_file="blob://eap-fast-pac"
865 }
866
867 # Plaintext connection (no WPA, no IEEE 802.1X)
868 network={
869         ssid="plaintext-test"
870         key_mgmt=NONE
871 }
872
873
874 # Shared WEP key connection (no WPA, no IEEE 802.1X)
875 network={
876         ssid="static-wep-test"
877         key_mgmt=NONE
878         wep_key0="abcde"
879         wep_key1=0102030405
880         wep_key2="1234567890123"
881         wep_tx_keyidx=0
882         priority=5
883 }
884
885
886 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
887 # IEEE 802.11 authentication
888 network={
889         ssid="static-wep-test2"
890         key_mgmt=NONE
891         wep_key0="abcde"
892         wep_key1=0102030405
893         wep_key2="1234567890123"
894         wep_tx_keyidx=0
895         priority=5
896         auth_alg=SHARED
897 }
898
899
900 # IBSS/ad-hoc network with WPA-None/TKIP.
901 network={
902         ssid="test adhoc"
903         mode=1
904         frequency=2412
905         proto=WPA
906         key_mgmt=WPA-NONE
907         pairwise=NONE
908         group=TKIP
909         psk="secret passphrase"
910 }
911
912
913 # Catch all example that allows more or less all configuration modes
914 network={
915         ssid="example"
916         scan_ssid=1
917         key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
918         pairwise=CCMP TKIP
919         group=CCMP TKIP WEP104 WEP40
920         psk="very secret passphrase"
921         eap=TTLS PEAP TLS
922         identity="user@example.com"
923         password="foobar"
924         ca_cert="/etc/cert/ca.pem"
925         client_cert="/etc/cert/user.pem"
926         private_key="/etc/cert/user.prv"
927         private_key_passwd="password"
928         phase1="peaplabel=0"
929 }
930
931 # Example of EAP-TLS with smartcard (openssl engine)
932 network={
933         ssid="example"
934         key_mgmt=WPA-EAP
935         eap=TLS
936         proto=RSN
937         pairwise=CCMP TKIP
938         group=CCMP TKIP
939         identity="user@example.com"
940         ca_cert="/etc/cert/ca.pem"
941         client_cert="/etc/cert/user.pem"
942
943         engine=1
944
945         # The engine configured here must be available. Look at
946         # OpenSSL engine support in the global section.
947         # The key available through the engine must be the private key
948         # matching the client certificate configured above.
949
950         # use the opensc engine
951         #engine_id="opensc"
952         #key_id="45"
953
954         # use the pkcs11 engine
955         engine_id="pkcs11"
956         key_id="id_45"
957
958         # Optional PIN configuration; this can be left out and PIN will be
959         # asked through the control interface
960         pin="1234"
961 }
962
963 # Example configuration showing how to use an inlined blob as a CA certificate
964 # data instead of using external file
965 network={
966         ssid="example"
967         key_mgmt=WPA-EAP
968         eap=TTLS
969         identity="user@example.com"
970         anonymous_identity="anonymous@example.com"
971         password="foobar"
972         ca_cert="blob://exampleblob"
973         priority=20
974 }
975
976 blob-base64-exampleblob={
977 SGVsbG8gV29ybGQhCg==
978 }
979
980
981 # Wildcard match for SSID (plaintext APs only). This example select any
982 # open AP regardless of its SSID.
983 network={
984         key_mgmt=NONE
985 }