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