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