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