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