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