WPS: Document NFC use cases with password/config token
[mech_eap.git] / wpa_supplicant / wpa_supplicant.conf
1 ##### Example wpa_supplicant configuration file ###############################
2 #
3 # This file describes configuration file format and lists all available option.
4 # Please also take a look at simpler configuration examples in 'examples'
5 # subdirectory.
6 #
7 # Empty lines and lines starting with # are ignored
8
9 # NOTE! This file may contain password information and should probably be made
10 # readable only by root user on multiuser systems.
11
12 # Note: All file paths in this configuration file should use full (absolute,
13 # not relative to working directory) path in order to allow working directory
14 # to be changed. This can happen if wpa_supplicant is run in the background.
15
16 # Whether to allow wpa_supplicant to update (overwrite) configuration
17 #
18 # This option can be used to allow wpa_supplicant to overwrite configuration
19 # file whenever configuration is changed (e.g., new network block is added with
20 # wpa_cli or wpa_gui, or a password is changed). This is required for
21 # wpa_cli/wpa_gui to be able to store the configuration changes permanently.
22 # Please note that overwriting configuration file will remove the comments from
23 # it.
24 #update_config=1
25
26 # global configuration (shared by all network blocks)
27 #
28 # Parameters for the control interface. If this is specified, wpa_supplicant
29 # will open a control interface that is available for external programs to
30 # manage wpa_supplicant. The meaning of this string depends on which control
31 # interface mechanism is used. For all cases, the existence of this parameter
32 # in configuration is used to determine whether the control interface is
33 # enabled.
34 #
35 # For UNIX domain sockets (default on Linux and BSD): This is a directory that
36 # will be created for UNIX domain sockets for listening to requests from
37 # external programs (CLI/GUI, etc.) for status information and configuration.
38 # The socket file will be named based on the interface name, so multiple
39 # wpa_supplicant processes can be run at the same time if more than one
40 # interface is used.
41 # /var/run/wpa_supplicant is the recommended directory for sockets and by
42 # default, wpa_cli will use it when trying to connect with wpa_supplicant.
43 #
44 # Access control for the control interface can be configured by setting the
45 # directory to allow only members of a group to use sockets. This way, it is
46 # possible to run wpa_supplicant as root (since it needs to change network
47 # configuration and open raw sockets) and still allow GUI/CLI components to be
48 # run as non-root users. However, since the control interface can be used to
49 # change the network configuration, this access needs to be protected in many
50 # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
51 # want to allow non-root users to use the control interface, add a new group
52 # and change this value to match with that group. Add users that should have
53 # control interface access to this group. If this variable is commented out or
54 # not included in the configuration file, group will not be changed from the
55 # value it got by default when the directory or socket was created.
56 #
57 # When configuring both the directory and group, use following format:
58 # DIR=/var/run/wpa_supplicant GROUP=wheel
59 # DIR=/var/run/wpa_supplicant GROUP=0
60 # (group can be either group name or gid)
61 #
62 # For UDP connections (default on Windows): The value will be ignored. This
63 # variable is just used to select that the control interface is to be created.
64 # The value can be set to, e.g., udp (ctrl_interface=udp)
65 #
66 # For Windows Named Pipe: This value can be used to set the security descriptor
67 # for controlling access to the control interface. Security descriptor can be
68 # set using Security Descriptor String Format (see http://msdn.microsoft.com/
69 # library/default.asp?url=/library/en-us/secauthz/security/
70 # security_descriptor_string_format.asp). The descriptor string needs to be
71 # prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
72 # DACL (which will reject all connections). See README-Windows.txt for more
73 # information about SDDL string format.
74 #
75 ctrl_interface=/var/run/wpa_supplicant
76
77 # IEEE 802.1X/EAPOL version
78 # wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
79 # EAPOL version 2. However, there are many APs that do not handle the new
80 # version number correctly (they seem to drop the frames completely). In order
81 # to make wpa_supplicant interoperate with these APs, the version number is set
82 # to 1 by default. This configuration value can be used to set it to the new
83 # version (2).
84 eapol_version=1
85
86 # AP scanning/selection
87 # By default, wpa_supplicant requests driver to perform AP scanning and then
88 # uses the scan results to select a suitable AP. Another alternative is to
89 # allow the driver to take care of AP scanning and selection and use
90 # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
91 # information from the driver.
92 # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
93 #    the currently enabled networks are found, a new network (IBSS or AP mode
94 #    operation) may be initialized (if configured) (default)
95 # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
96 #    parameters (e.g., WPA IE generation); this mode can also be used with
97 #    non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
98 #    APs (i.e., external program needs to control association). This mode must
99 #    also be used when using wired Ethernet drivers.
100 # 2: like 0, but associate with APs using security policy and SSID (but not
101 #    BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
102 #    enable operation with hidden SSIDs and optimized roaming; in this mode,
103 #    the network blocks in the configuration file are tried one by one until
104 #    the driver reports successful association; each network block should have
105 #    explicit security policy (i.e., only one option in the lists) for
106 #    key_mgmt, pairwise, group, proto variables
107 # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
108 # created immediately regardless of scan results. ap_scan=1 mode will first try
109 # to scan for existing networks and only if no matches with the enabled
110 # networks are found, a new IBSS or AP mode network is created.
111 ap_scan=1
112
113 # EAP fast re-authentication
114 # By default, fast re-authentication is enabled for all EAP methods that
115 # support it. This variable can be used to disable fast re-authentication.
116 # Normally, there is no need to disable this.
117 fast_reauth=1
118
119 # OpenSSL Engine support
120 # These options can be used to load OpenSSL engines.
121 # The two engines that are supported currently are shown below:
122 # They are both from the opensc project (http://www.opensc.org/)
123 # By default no engines are loaded.
124 # make the opensc engine available
125 #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
126 # make the pkcs11 engine available
127 #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
128 # configure the path to the pkcs11 module required by the pkcs11 engine
129 #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
130
131 # Dynamic EAP methods
132 # If EAP methods were built dynamically as shared object files, they need to be
133 # loaded here before being used in the network blocks. By default, EAP methods
134 # are included statically in the build, so these lines are not needed
135 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
136 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
137
138 # Driver interface parameters
139 # This field can be used to configure arbitrary driver interace parameters. The
140 # format is specific to the selected driver interface. This field is not used
141 # in most cases.
142 #driver_param="field=value"
143
144 # Country code
145 # The ISO/IEC alpha2 country code for the country in which this device is
146 # currently operating.
147 #country=US
148
149 # Maximum lifetime for PMKSA in seconds; default 43200
150 #dot11RSNAConfigPMKLifetime=43200
151 # Threshold for reauthentication (percentage of PMK lifetime); default 70
152 #dot11RSNAConfigPMKReauthThreshold=70
153 # Timeout for security association negotiation in seconds; default 60
154 #dot11RSNAConfigSATimeout=60
155
156 # Wi-Fi Protected Setup (WPS) parameters
157
158 # Universally Unique IDentifier (UUID; see RFC 4122) of the device
159 # If not configured, UUID will be generated based on the local MAC address.
160 #uuid=12345678-9abc-def0-1234-56789abcdef0
161
162 # Device Name
163 # User-friendly description of device; up to 32 octets encoded in UTF-8
164 #device_name=Wireless Client
165
166 # Manufacturer
167 # The manufacturer of the device (up to 64 ASCII characters)
168 #manufacturer=Company
169
170 # Model Name
171 # Model of the device (up to 32 ASCII characters)
172 #model_name=cmodel
173
174 # Model Number
175 # Additional device description (up to 32 ASCII characters)
176 #model_number=123
177
178 # Serial Number
179 # Serial number of the device (up to 32 characters)
180 #serial_number=12345
181
182 # Primary Device Type
183 # Used format: <categ>-<OUI>-<subcateg>
184 # categ = Category as an integer value
185 # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
186 #       default WPS OUI
187 # subcateg = OUI-specific Sub Category as an integer value
188 # Examples:
189 #   1-0050F204-1 (Computer / PC)
190 #   1-0050F204-2 (Computer / Server)
191 #   5-0050F204-1 (Storage / NAS)
192 #   6-0050F204-1 (Network Infrastructure / AP)
193 #device_type=1-0050F204-1
194
195 # OS Version
196 # 4-octet operating system version number (hex string)
197 #os_version=01020300
198
199 # Config Methods
200 # List of the supported configuration methods
201 # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
202 #       nfc_interface push_button keypad virtual_display physical_display
203 #       virtual_push_button physical_push_button
204 # For WSC 1.0:
205 #config_methods=label display push_button keypad
206 # For WSC 2.0:
207 #config_methods=label virtual_display virtual_push_button keypad
208
209 # Credential processing
210 #   0 = process received credentials internally (default)
211 #   1 = do not process received credentials; just pass them over ctrl_iface to
212 #       external program(s)
213 #   2 = process received credentials internally and pass them over ctrl_iface
214 #       to external program(s)
215 #wps_cred_processing=0
216
217 # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
218 # The vendor attribute contents to be added in M1 (hex string)
219 #wps_vendor_ext_m1=000137100100020001
220
221 # NFC password token for WPS
222 # These parameters can be used to configure a fixed NFC password token for the
223 # station. This can be generated, e.g., with nfc_pw_token. When these
224 # parameters are used, the station is assumed to be deployed with a NFC tag
225 # that includes the matching NFC password token (e.g., written based on the
226 # NDEF record from nfc_pw_token).
227 #
228 #wps_nfc_dev_pw_id: Device Password ID (16..65535)
229 #wps_nfc_dh_pubkey: Hexdump of DH Public Key
230 #wps_nfc_dh_privkey: Hexdump of DH Private Key
231 #wps_nfc_dev_pw: Hexdump of Device Password
232
233 # Maximum number of BSS entries to keep in memory
234 # Default: 200
235 # This can be used to limit memory use on the BSS entries (cached scan
236 # results). A larger value may be needed in environments that have huge number
237 # of APs when using ap_scan=1 mode.
238 #bss_max_count=200
239
240 # Automatic scan
241 # This is an optional set of parameters for automatic scanning
242 # within an interface in following format:
243 #autoscan=<autoscan module name>:<module parameters>
244 # autoscan is like bgscan but on disconnected or inactive state.
245 # For instance, on exponential module parameters would be <base>:<limit>
246 #autoscan=exponential:3:300
247 # Which means a delay between scans on a base exponential of 3,
248 # up to the limit of 300 seconds (3, 9, 27 ... 300)
249 # For periodic module, parameters would be <fixed interval>
250 #autoscan=periodic:30
251 # So a delay of 30 seconds will be applied between each scan
252
253 # filter_ssids - SSID-based scan result filtering
254 # 0 = do not filter scan results (default)
255 # 1 = only include configured SSIDs in scan results/BSS table
256 #filter_ssids=0
257
258
259 # Interworking (IEEE 802.11u)
260
261 # Enable Interworking
262 # interworking=1
263
264 # Homogenous ESS identifier
265 # If this is set, scans will be used to request response only from BSSes
266 # belonging to the specified Homogeneous ESS. This is used only if interworking
267 # is enabled.
268 # hessid=00:11:22:33:44:55
269
270 # credential block
271 #
272 # Each credential used for automatic network selection is configured as a set
273 # of parameters that are compared to the information advertised by the APs when
274 # interworking_select and interworking_connect commands are used.
275 #
276 # credential fields:
277 #
278 # priority: Priority group
279 #       By default, all networks and credentials get the same priority group
280 #       (0). This field can be used to give higher priority for credentials
281 #       (and similarly in struct wpa_ssid for network blocks) to change the
282 #       Interworking automatic networking selection behavior. The matching
283 #       network (based on either an enabled network block or a credential)
284 #       with the highest priority value will be selected.
285 #
286 # pcsc: Use PC/SC and SIM/USIM card
287 #
288 # realm: Home Realm for Interworking
289 #
290 # username: Username for Interworking network selection
291 #
292 # password: Password for Interworking network selection
293 #
294 # ca_cert: CA certificate for Interworking network selection
295 #
296 # client_cert: File path to client certificate file (PEM/DER)
297 #       This field is used with Interworking networking selection for a case
298 #       where client certificate/private key is used for authentication
299 #       (EAP-TLS). Full path to the file should be used since working
300 #       directory may change when wpa_supplicant is run in the background.
301 #
302 #       Alternatively, a named configuration blob can be used by setting
303 #       this to blob://blob_name.
304 #
305 # private_key: File path to client private key file (PEM/DER/PFX)
306 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
307 #       commented out. Both the private key and certificate will be read
308 #       from the PKCS#12 file in this case. Full path to the file should be
309 #       used since working directory may change when wpa_supplicant is run
310 #       in the background.
311 #
312 #       Windows certificate store can be used by leaving client_cert out and
313 #       configuring private_key in one of the following formats:
314 #
315 #       cert://substring_to_match
316 #
317 #       hash://certificate_thumbprint_in_hex
318 #
319 #       For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
320 #
321 #       Note that when running wpa_supplicant as an application, the user
322 #       certificate store (My user account) is used, whereas computer store
323 #       (Computer account) is used when running wpasvc as a service.
324 #
325 #       Alternatively, a named configuration blob can be used by setting
326 #       this to blob://blob_name.
327 #
328 # private_key_passwd: Password for private key file
329 #
330 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
331 #
332 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
333 #       format
334 #
335 # domain: Home service provider FQDN
336 #       This is used to compare against the Domain Name List to figure out
337 #       whether the AP is operated by the Home SP.
338 #
339 # for example:
340 #
341 #cred={
342 #       realm="example.com"
343 #       username="user@example.com"
344 #       password="password"
345 #       ca_cert="/etc/wpa_supplicant/ca.pem"
346 #       domain="example.com"
347 #}
348 #
349 #cred={
350 #       imsi="310026-000000000"
351 #       milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
352 #}
353
354 # Hotspot 2.0
355 # hs20=1
356
357 # network block
358 #
359 # Each network (usually AP's sharing the same SSID) is configured as a separate
360 # block in this configuration file. The network blocks are in preference order
361 # (the first match is used).
362 #
363 # network block fields:
364 #
365 # disabled:
366 #       0 = this network can be used (default)
367 #       1 = this network block is disabled (can be enabled through ctrl_iface,
368 #           e.g., with wpa_cli or wpa_gui)
369 #
370 # id_str: Network identifier string for external scripts. This value is passed
371 #       to external action script through wpa_cli as WPA_ID_STR environment
372 #       variable to make it easier to do network specific configuration.
373 #
374 # ssid: SSID (mandatory); either as an ASCII string with double quotation or
375 #       as hex string; network name
376 #
377 # scan_ssid:
378 #       0 = do not scan this SSID with specific Probe Request frames (default)
379 #       1 = scan with SSID-specific Probe Request frames (this can be used to
380 #           find APs that do not accept broadcast SSID or use multiple SSIDs;
381 #           this will add latency to scanning, so enable this only when needed)
382 #
383 # bssid: BSSID (optional); if set, this network block is used only when
384 #       associating with the AP using the configured BSSID
385 #
386 # priority: priority group (integer)
387 # By default, all networks will get same priority group (0). If some of the
388 # networks are more desirable, this field can be used to change the order in
389 # which wpa_supplicant goes through the networks when selecting a BSS. The
390 # priority groups will be iterated in decreasing priority (i.e., the larger the
391 # priority value, the sooner the network is matched against the scan results).
392 # Within each priority group, networks will be selected based on security
393 # policy, signal strength, etc.
394 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
395 # using this priority to select the order for scanning. Instead, they try the
396 # networks in the order that used in the configuration file.
397 #
398 # mode: IEEE 802.11 operation mode
399 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
400 # 1 = IBSS (ad-hoc, peer-to-peer)
401 # 2 = AP (access point)
402 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
403 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
404 # following network block options:
405 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
406 # both), and psk must also be set.
407 #
408 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
409 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
410 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
411 # In addition, this value is only used by the station that creates the IBSS. If
412 # an IBSS network with the configured SSID is already present, the frequency of
413 # the network will be used instead of this configured value.
414 #
415 # scan_freq: List of frequencies to scan
416 # Space-separated list of frequencies in MHz to scan when searching for this
417 # BSS. If the subset of channels used by the network is known, this option can
418 # be used to optimize scanning to not occur on channels that the network does
419 # not use. Example: scan_freq=2412 2437 2462
420 #
421 # freq_list: Array of allowed frequencies
422 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
423 # set, scan results that do not match any of the specified frequencies are not
424 # considered when selecting a BSS.
425 #
426 # proto: list of accepted protocols
427 # WPA = WPA/IEEE 802.11i/D3.0
428 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
429 # If not set, this defaults to: WPA RSN
430 #
431 # key_mgmt: list of accepted authenticated key management protocols
432 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
433 # WPA-EAP = WPA using EAP authentication
434 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
435 #       generated WEP keys
436 # NONE = WPA is not used; plaintext or static WEP could be used
437 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
438 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
439 # If not set, this defaults to: WPA-PSK WPA-EAP
440 #
441 # ieee80211w: whether management frame protection is enabled
442 # 0 = disabled (default)
443 # 1 = optional
444 # 2 = required
445 # The most common configuration options for this based on the PMF (protected
446 # management frames) certification program are:
447 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
448 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
449 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
450 #
451 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
452 # OPEN = Open System authentication (required for WPA/WPA2)
453 # SHARED = Shared Key authentication (requires static WEP keys)
454 # LEAP = LEAP/Network EAP (only used with LEAP)
455 # If not set, automatic selection is used (Open System with LEAP enabled if
456 # LEAP is allowed as one of the EAP methods).
457 #
458 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
459 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
460 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
461 # NONE = Use only Group Keys (deprecated, should not be included if APs support
462 #       pairwise keys)
463 # If not set, this defaults to: CCMP TKIP
464 #
465 # group: list of accepted group (broadcast/multicast) ciphers for WPA
466 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
467 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
468 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
469 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
470 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
471 #
472 # psk: WPA preshared key; 256-bit pre-shared key
473 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
474 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
475 # generated using the passphrase and SSID). ASCII passphrase must be between
476 # 8 and 63 characters (inclusive).
477 # This field is not needed, if WPA-EAP is used.
478 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
479 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
480 # startup and reconfiguration time can be optimized by generating the PSK only
481 # only when the passphrase or SSID has actually changed.
482 #
483 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
484 # Dynamic WEP key required for non-WPA mode
485 # bit0 (1): require dynamically generated unicast WEP key
486 # bit1 (2): require dynamically generated broadcast WEP key
487 #       (3 = require both keys; default)
488 # Note: When using wired authentication, eapol_flags must be set to 0 for the
489 # authentication to be completed successfully.
490 #
491 # mixed_cell: This option can be used to configure whether so called mixed
492 # cells, i.e., networks that use both plaintext and encryption in the same
493 # SSID, are allowed when selecting a BSS from scan results.
494 # 0 = disabled (default)
495 # 1 = enabled
496 #
497 # proactive_key_caching:
498 # Enable/disable opportunistic PMKSA caching for WPA2.
499 # 0 = disabled (default)
500 # 1 = enabled
501 #
502 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
503 # hex without quotation, e.g., 0102030405)
504 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
505 #
506 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
507 # allowed. This is only used with RSN/WPA2.
508 # 0 = disabled (default)
509 # 1 = enabled
510 #peerkey=1
511 #
512 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
513 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
514 #
515 # Following fields are only used with internal EAP implementation.
516 # eap: space-separated list of accepted EAP methods
517 #       MD5 = EAP-MD5 (unsecure and does not generate keying material ->
518 #                       cannot be used with WPA; to be used as a Phase 2 method
519 #                       with EAP-PEAP or EAP-TTLS)
520 #       MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
521 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
522 #       OTP = EAP-OTP (cannot be used separately with WPA; to be used
523 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
524 #       GTC = EAP-GTC (cannot be used separately with WPA; to be used
525 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
526 #       TLS = EAP-TLS (client and server certificate)
527 #       PEAP = EAP-PEAP (with tunnelled EAP authentication)
528 #       TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
529 #                        authentication)
530 #       If not set, all compiled in methods are allowed.
531 #
532 # identity: Identity string for EAP
533 #       This field is also used to configure user NAI for
534 #       EAP-PSK/PAX/SAKE/GPSK.
535 # anonymous_identity: Anonymous identity string for EAP (to be used as the
536 #       unencrypted identity with EAP types that support different tunnelled
537 #       identity, e.g., EAP-TTLS)
538 # password: Password string for EAP. This field can include either the
539 #       plaintext password (using ASCII or hex string) or a NtPasswordHash
540 #       (16-byte MD4 hash of password) in hash:<32 hex digits> format.
541 #       NtPasswordHash can only be used when the password is for MSCHAPv2 or
542 #       MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
543 #       EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
544 #       PSK) is also configured using this field. For EAP-GPSK, this is a
545 #       variable length PSK.
546 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
547 #       or more trusted CA certificates. If ca_cert and ca_path are not
548 #       included, server certificate will not be verified. This is insecure and
549 #       a trusted CA certificate should always be configured when using
550 #       EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
551 #       change when wpa_supplicant is run in the background.
552 #
553 #       Alternatively, this can be used to only perform matching of the server
554 #       certificate (SHA-256 hash of the DER encoded X.509 certificate). In
555 #       this case, the possible CA certificates in the server certificate chain
556 #       are ignored and only the server certificate is verified. This is
557 #       configured with the following format:
558 #       hash:://server/sha256/cert_hash_in_hex
559 #       For example: "hash://server/sha256/
560 #       5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
561 #
562 #       On Windows, trusted CA certificates can be loaded from the system
563 #       certificate store by setting this to cert_store://<name>, e.g.,
564 #       ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
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 # ca_path: Directory path for CA certificate files (PEM). This path may
569 #       contain multiple CA certificates in OpenSSL format. Common use for this
570 #       is to point to system trusted CA list which is often installed into
571 #       directory like /etc/ssl/certs. If configured, these certificates are
572 #       added to the list of trusted CAs. ca_cert may also be included in that
573 #       case, but it is not required.
574 # client_cert: File path to client certificate file (PEM/DER)
575 #       Full path should be used since working directory may change when
576 #       wpa_supplicant is run in the background.
577 #       Alternatively, a named configuration blob can be used by setting this
578 #       to blob://<blob name>.
579 # private_key: File path to client private key file (PEM/DER/PFX)
580 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
581 #       commented out. Both the private key and certificate will be read from
582 #       the PKCS#12 file in this case. Full path should be used since working
583 #       directory may change when wpa_supplicant is run in the background.
584 #       Windows certificate store can be used by leaving client_cert out and
585 #       configuring private_key in one of the following formats:
586 #       cert://substring_to_match
587 #       hash://certificate_thumbprint_in_hex
588 #       for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
589 #       Note that when running wpa_supplicant as an application, the user
590 #       certificate store (My user account) is used, whereas computer store
591 #       (Computer account) is used when running wpasvc as a service.
592 #       Alternatively, a named configuration blob can be used by setting this
593 #       to blob://<blob name>.
594 # private_key_passwd: Password for private key file (if left out, this will be
595 #       asked through control interface)
596 # dh_file: File path to DH/DSA parameters file (in PEM format)
597 #       This is an optional configuration file for setting parameters for an
598 #       ephemeral DH key exchange. In most cases, the default RSA
599 #       authentication does not use this configuration. However, it is possible
600 #       setup RSA to use ephemeral DH key exchange. In addition, ciphers with
601 #       DSA keys always use ephemeral DH keys. This can be used to achieve
602 #       forward secrecy. If the file is in DSA parameters format, it will be
603 #       automatically converted into DH params.
604 # subject_match: Substring to be matched against the subject of the
605 #       authentication server certificate. If this string is set, the server
606 #       sertificate is only accepted if it contains this string in the subject.
607 #       The subject string is in following format:
608 #       /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
609 # altsubject_match: Semicolon separated string of entries to be matched against
610 #       the alternative subject name of the authentication server certificate.
611 #       If this string is set, the server sertificate is only accepted if it
612 #       contains one of the entries in an alternative subject name extension.
613 #       altSubjectName string is in following format: TYPE:VALUE
614 #       Example: EMAIL:server@example.com
615 #       Example: DNS:server.example.com;DNS:server2.example.com
616 #       Following types are supported: EMAIL, DNS, URI
617 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
618 #       (string with field-value pairs, e.g., "peapver=0" or
619 #       "peapver=1 peaplabel=1")
620 #       'peapver' can be used to force which PEAP version (0 or 1) is used.
621 #       'peaplabel=1' can be used to force new label, "client PEAP encryption",
622 #       to be used during key derivation when PEAPv1 or newer. Most existing
623 #       PEAPv1 implementation seem to be using the old label, "client EAP
624 #       encryption", and wpa_supplicant is now using that as the default value.
625 #       Some servers, e.g., Radiator, may require peaplabel=1 configuration to
626 #       interoperate with PEAPv1; see eap_testing.txt for more details.
627 #       'peap_outer_success=0' can be used to terminate PEAP authentication on
628 #       tunneled EAP-Success. This is required with some RADIUS servers that
629 #       implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
630 #       Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
631 #       include_tls_length=1 can be used to force wpa_supplicant to include
632 #       TLS Message Length field in all TLS messages even if they are not
633 #       fragmented.
634 #       sim_min_num_chal=3 can be used to configure EAP-SIM to require three
635 #       challenges (by default, it accepts 2 or 3)
636 #       result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
637 #       protected result indication.
638 #       'crypto_binding' option can be used to control PEAPv0 cryptobinding
639 #       behavior:
640 #        * 0 = do not use cryptobinding (default)
641 #        * 1 = use cryptobinding if server supports it
642 #        * 2 = require cryptobinding
643 #       EAP-WSC (WPS) uses following options: pin=<Device Password> or
644 #       pbc=1.
645 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
646 #       (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
647 #       "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
648 # Following certificate/private key fields are used in inner Phase2
649 # authentication when using EAP-TTLS or EAP-PEAP.
650 # ca_cert2: File path to CA certificate file. This file can have one or more
651 #       trusted CA certificates. If ca_cert2 and ca_path2 are not included,
652 #       server certificate will not be verified. This is insecure and a trusted
653 #       CA certificate should always be configured.
654 # ca_path2: Directory path for CA certificate files (PEM)
655 # client_cert2: File path to client certificate file
656 # private_key2: File path to client private key file
657 # private_key2_passwd: Password for private key file
658 # dh_file2: File path to DH/DSA parameters file (in PEM format)
659 # subject_match2: Substring to be matched against the subject of the
660 #       authentication server certificate.
661 # altsubject_match2: Substring to be matched against the alternative subject
662 #       name of the authentication server certificate.
663 #
664 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
665 #       This value limits the fragment size for EAP methods that support
666 #       fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
667 #       small enough to make the EAP messages fit in MTU of the network
668 #       interface used for EAPOL. The default value is suitable for most
669 #       cases.
670 #
671 # EAP-FAST variables:
672 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
673 #       to create this file and write updates to it when PAC is being
674 #       provisioned or refreshed. Full path to the file should be used since
675 #       working directory may change when wpa_supplicant is run in the
676 #       background. Alternatively, a named configuration blob can be used by
677 #       setting this to blob://<blob name>
678 # phase1: fast_provisioning option can be used to enable in-line provisioning
679 #         of EAP-FAST credentials (PAC):
680 #         0 = disabled,
681 #         1 = allow unauthenticated provisioning,
682 #         2 = allow authenticated provisioning,
683 #         3 = allow both unauthenticated and authenticated provisioning
684 #       fast_max_pac_list_len=<num> option can be used to set the maximum
685 #               number of PAC entries to store in a PAC list (default: 10)
686 #       fast_pac_format=binary option can be used to select binary format for
687 #               storing PAC entries in order to save some space (the default
688 #               text format uses about 2.5 times the size of minimal binary
689 #               format)
690 #
691 # wpa_supplicant supports number of "EAP workarounds" to work around
692 # interoperability issues with incorrectly behaving authentication servers.
693 # These are enabled by default because some of the issues are present in large
694 # number of authentication servers. Strict EAP conformance mode can be
695 # configured by disabling workarounds with eap_workaround=0.
696
697 # Station inactivity limit
698 #
699 # If a station does not send anything in ap_max_inactivity seconds, an
700 # empty data frame is sent to it in order to verify whether it is
701 # still in range. If this frame is not ACKed, the station will be
702 # disassociated and then deauthenticated. This feature is used to
703 # clear station table of old entries when the STAs move out of the
704 # range.
705 #
706 # The station can associate again with the AP if it is still in range;
707 # this inactivity poll is just used as a nicer way of verifying
708 # inactivity; i.e., client will not report broken connection because
709 # disassociation frame is not sent immediately without first polling
710 # the STA with a data frame.
711 # default: 300 (i.e., 5 minutes)
712 #ap_max_inactivity=300
713
714 # DTIM period in Beacon intervals for AP mode (default: 2)
715 #dtim_period=2
716
717 # Example blocks:
718
719 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
720 network={
721         ssid="simple"
722         psk="very secret passphrase"
723         priority=5
724 }
725
726 # Same as previous, but request SSID-specific scanning (for APs that reject
727 # broadcast SSID)
728 network={
729         ssid="second ssid"
730         scan_ssid=1
731         psk="very secret passphrase"
732         priority=2
733 }
734
735 # Only WPA-PSK is used. Any valid cipher combination is accepted.
736 network={
737         ssid="example"
738         proto=WPA
739         key_mgmt=WPA-PSK
740         pairwise=CCMP TKIP
741         group=CCMP TKIP WEP104 WEP40
742         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
743         priority=2
744 }
745
746 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
747 network={
748         ssid="example"
749         proto=WPA
750         key_mgmt=WPA-PSK
751         pairwise=TKIP
752         group=TKIP
753         psk="not so secure passphrase"
754         wpa_ptk_rekey=600
755 }
756
757 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
758 # or WEP40 as the group cipher will not be accepted.
759 network={
760         ssid="example"
761         proto=RSN
762         key_mgmt=WPA-EAP
763         pairwise=CCMP TKIP
764         group=CCMP TKIP
765         eap=TLS
766         identity="user@example.com"
767         ca_cert="/etc/cert/ca.pem"
768         client_cert="/etc/cert/user.pem"
769         private_key="/etc/cert/user.prv"
770         private_key_passwd="password"
771         priority=1
772 }
773
774 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
775 # (e.g., Radiator)
776 network={
777         ssid="example"
778         key_mgmt=WPA-EAP
779         eap=PEAP
780         identity="user@example.com"
781         password="foobar"
782         ca_cert="/etc/cert/ca.pem"
783         phase1="peaplabel=1"
784         phase2="auth=MSCHAPV2"
785         priority=10
786 }
787
788 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
789 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
790 network={
791         ssid="example"
792         key_mgmt=WPA-EAP
793         eap=TTLS
794         identity="user@example.com"
795         anonymous_identity="anonymous@example.com"
796         password="foobar"
797         ca_cert="/etc/cert/ca.pem"
798         priority=2
799 }
800
801 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
802 # use. Real identity is sent only within an encrypted TLS tunnel.
803 network={
804         ssid="example"
805         key_mgmt=WPA-EAP
806         eap=TTLS
807         identity="user@example.com"
808         anonymous_identity="anonymous@example.com"
809         password="foobar"
810         ca_cert="/etc/cert/ca.pem"
811         phase2="auth=MSCHAPV2"
812 }
813
814 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
815 # authentication.
816 network={
817         ssid="example"
818         key_mgmt=WPA-EAP
819         eap=TTLS
820         # Phase1 / outer authentication
821         anonymous_identity="anonymous@example.com"
822         ca_cert="/etc/cert/ca.pem"
823         # Phase 2 / inner authentication
824         phase2="autheap=TLS"
825         ca_cert2="/etc/cert/ca2.pem"
826         client_cert2="/etc/cer/user.pem"
827         private_key2="/etc/cer/user.prv"
828         private_key2_passwd="password"
829         priority=2
830 }
831
832 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
833 # group cipher.
834 network={
835         ssid="example"
836         bssid=00:11:22:33:44:55
837         proto=WPA RSN
838         key_mgmt=WPA-PSK WPA-EAP
839         pairwise=CCMP
840         group=CCMP
841         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
842 }
843
844 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
845 # and all valid ciphers.
846 network={
847         ssid=00010203
848         psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
849 }
850
851
852 # EAP-SIM with a GSM SIM or USIM
853 network={
854         ssid="eap-sim-test"
855         key_mgmt=WPA-EAP
856         eap=SIM
857         pin="1234"
858         pcsc=""
859 }
860
861
862 # EAP-PSK
863 network={
864         ssid="eap-psk-test"
865         key_mgmt=WPA-EAP
866         eap=PSK
867         anonymous_identity="eap_psk_user"
868         password=06b4be19da289f475aa46a33cb793029
869         identity="eap_psk_user@example.com"
870 }
871
872
873 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
874 # EAP-TLS for authentication and key generation; require both unicast and
875 # broadcast WEP keys.
876 network={
877         ssid="1x-test"
878         key_mgmt=IEEE8021X
879         eap=TLS
880         identity="user@example.com"
881         ca_cert="/etc/cert/ca.pem"
882         client_cert="/etc/cert/user.pem"
883         private_key="/etc/cert/user.prv"
884         private_key_passwd="password"
885         eapol_flags=3
886 }
887
888
889 # LEAP with dynamic WEP keys
890 network={
891         ssid="leap-example"
892         key_mgmt=IEEE8021X
893         eap=LEAP
894         identity="user"
895         password="foobar"
896 }
897
898 # EAP-IKEv2 using shared secrets for both server and peer authentication
899 network={
900         ssid="ikev2-example"
901         key_mgmt=WPA-EAP
902         eap=IKEV2
903         identity="user"
904         password="foobar"
905 }
906
907 # EAP-FAST with WPA (WPA or WPA2)
908 network={
909         ssid="eap-fast-test"
910         key_mgmt=WPA-EAP
911         eap=FAST
912         anonymous_identity="FAST-000102030405"
913         identity="username"
914         password="password"
915         phase1="fast_provisioning=1"
916         pac_file="/etc/wpa_supplicant.eap-fast-pac"
917 }
918
919 network={
920         ssid="eap-fast-test"
921         key_mgmt=WPA-EAP
922         eap=FAST
923         anonymous_identity="FAST-000102030405"
924         identity="username"
925         password="password"
926         phase1="fast_provisioning=1"
927         pac_file="blob://eap-fast-pac"
928 }
929
930 # Plaintext connection (no WPA, no IEEE 802.1X)
931 network={
932         ssid="plaintext-test"
933         key_mgmt=NONE
934 }
935
936
937 # Shared WEP key connection (no WPA, no IEEE 802.1X)
938 network={
939         ssid="static-wep-test"
940         key_mgmt=NONE
941         wep_key0="abcde"
942         wep_key1=0102030405
943         wep_key2="1234567890123"
944         wep_tx_keyidx=0
945         priority=5
946 }
947
948
949 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
950 # IEEE 802.11 authentication
951 network={
952         ssid="static-wep-test2"
953         key_mgmt=NONE
954         wep_key0="abcde"
955         wep_key1=0102030405
956         wep_key2="1234567890123"
957         wep_tx_keyidx=0
958         priority=5
959         auth_alg=SHARED
960 }
961
962
963 # IBSS/ad-hoc network with WPA-None/TKIP.
964 network={
965         ssid="test adhoc"
966         mode=1
967         frequency=2412
968         proto=WPA
969         key_mgmt=WPA-NONE
970         pairwise=NONE
971         group=TKIP
972         psk="secret passphrase"
973 }
974
975
976 # Catch all example that allows more or less all configuration modes
977 network={
978         ssid="example"
979         scan_ssid=1
980         key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
981         pairwise=CCMP TKIP
982         group=CCMP TKIP WEP104 WEP40
983         psk="very secret passphrase"
984         eap=TTLS PEAP TLS
985         identity="user@example.com"
986         password="foobar"
987         ca_cert="/etc/cert/ca.pem"
988         client_cert="/etc/cert/user.pem"
989         private_key="/etc/cert/user.prv"
990         private_key_passwd="password"
991         phase1="peaplabel=0"
992 }
993
994 # Example of EAP-TLS with smartcard (openssl engine)
995 network={
996         ssid="example"
997         key_mgmt=WPA-EAP
998         eap=TLS
999         proto=RSN
1000         pairwise=CCMP TKIP
1001         group=CCMP TKIP
1002         identity="user@example.com"
1003         ca_cert="/etc/cert/ca.pem"
1004         client_cert="/etc/cert/user.pem"
1005
1006         engine=1
1007
1008         # The engine configured here must be available. Look at
1009         # OpenSSL engine support in the global section.
1010         # The key available through the engine must be the private key
1011         # matching the client certificate configured above.
1012
1013         # use the opensc engine
1014         #engine_id="opensc"
1015         #key_id="45"
1016
1017         # use the pkcs11 engine
1018         engine_id="pkcs11"
1019         key_id="id_45"
1020
1021         # Optional PIN configuration; this can be left out and PIN will be
1022         # asked through the control interface
1023         pin="1234"
1024 }
1025
1026 # Example configuration showing how to use an inlined blob as a CA certificate
1027 # data instead of using external file
1028 network={
1029         ssid="example"
1030         key_mgmt=WPA-EAP
1031         eap=TTLS
1032         identity="user@example.com"
1033         anonymous_identity="anonymous@example.com"
1034         password="foobar"
1035         ca_cert="blob://exampleblob"
1036         priority=20
1037 }
1038
1039 blob-base64-exampleblob={
1040 SGVsbG8gV29ybGQhCg==
1041 }
1042
1043
1044 # Wildcard match for SSID (plaintext APs only). This example select any
1045 # open AP regardless of its SSID.
1046 network={
1047         key_mgmt=NONE
1048 }