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