]>
Commit | Line | Data |
---|---|---|
6fc6879b JM |
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 | |
ffbf1eaa | 31 | # interface mechanism is used. For all cases, the existence of this parameter |
6fc6879b JM |
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). | |
dd10abcc HW |
84 | # Note: When using MACsec, eapol_version shall be set to 3, which is |
85 | # defined in IEEE Std 802.1X-2010. | |
6fc6879b JM |
86 | eapol_version=1 |
87 | ||
88 | # AP scanning/selection | |
89 | # By default, wpa_supplicant requests driver to perform AP scanning and then | |
90 | # uses the scan results to select a suitable AP. Another alternative is to | |
91 | # allow the driver to take care of AP scanning and selection and use | |
92 | # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association | |
93 | # information from the driver. | |
b55aaa5f JM |
94 | # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to |
95 | # the currently enabled networks are found, a new network (IBSS or AP mode | |
96 | # operation) may be initialized (if configured) (default) | |
4658eb77 CT |
97 | # 0: This mode must only be used when using wired Ethernet drivers |
98 | # (including MACsec). | |
6fc6879b JM |
99 | # 2: like 0, but associate with APs using security policy and SSID (but not |
100 | # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to | |
101 | # enable operation with hidden SSIDs and optimized roaming; in this mode, | |
102 | # the network blocks in the configuration file are tried one by one until | |
103 | # the driver reports successful association; each network block should have | |
104 | # explicit security policy (i.e., only one option in the lists) for | |
105 | # key_mgmt, pairwise, group, proto variables | |
4658eb77 CT |
106 | # Note: ap_scan=0/2 should not be used with the nl80211 driver interface (the |
107 | # current Linux interface). ap_scan=1 is the only option working with nl80211. | |
8406cd35 JM |
108 | # For finding networks using hidden SSID, scan_ssid=1 in the network block can |
109 | # be used with nl80211. | |
b55aaa5f JM |
110 | # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be |
111 | # created immediately regardless of scan results. ap_scan=1 mode will first try | |
112 | # to scan for existing networks and only if no matches with the enabled | |
113 | # networks are found, a new IBSS or AP mode network is created. | |
6fc6879b JM |
114 | ap_scan=1 |
115 | ||
5b75ecea BG |
116 | # Whether to force passive scan for network connection |
117 | # | |
118 | # By default, scans will send out Probe Request frames on channels that allow | |
119 | # active scanning. This advertise the local station to the world. Normally this | |
120 | # is fine, but users may wish to do passive scanning where the radio should only | |
121 | # listen quietly for Beacon frames and not send any Probe Request frames. Actual | |
122 | # functionality may be driver dependent. | |
123 | # | |
124 | # This parameter can be used to force only passive scanning to be used | |
125 | # for network connection cases. It should be noted that this will slow | |
126 | # down scan operations and reduce likelihood of finding the AP. In | |
127 | # addition, some use cases will override this due to functional | |
128 | # requirements, e.g., for finding an AP that uses hidden SSID | |
129 | # (scan_ssid=1) or P2P device discovery. | |
130 | # | |
131 | # 0: Do normal scans (allow active scans) (default) | |
132 | # 1: Do passive scans. | |
133 | #passive_scan=0 | |
134 | ||
e45e8989 TP |
135 | # MPM residency |
136 | # By default, wpa_supplicant implements the mesh peering manager (MPM) for an | |
137 | # open mesh. However, if the driver can implement the MPM, you may set this to | |
138 | # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is | |
139 | # always used. | |
140 | # 0: MPM lives in the driver | |
141 | # 1: wpa_supplicant provides an MPM which handles peering (default) | |
142 | #user_mpm=1 | |
143 | ||
4b409368 MH |
144 | # Maximum number of peer links (0-255; default: 99) |
145 | # Maximum number of mesh peering currently maintained by the STA. | |
146 | #max_peer_links=99 | |
147 | ||
5a2a6de6 MH |
148 | # Timeout in seconds to detect STA inactivity (default: 300 seconds) |
149 | # | |
150 | # This timeout value is used in mesh STA to clean up inactive stations. | |
151 | #mesh_max_inactivity=300 | |
152 | ||
e6db1bc5 DG |
153 | # Enable 802.11s layer-2 routing and forwarding (dot11MeshForwarding) |
154 | #mesh_fwding=1 | |
155 | ||
483dd6a5 JM |
156 | # cert_in_cb - Whether to include a peer certificate dump in events |
157 | # This controls whether peer certificates for authentication server and | |
158 | # its certificate chain are included in EAP peer certificate events. This is | |
159 | # enabled by default. | |
160 | #cert_in_cb=1 | |
161 | ||
6fc6879b JM |
162 | # EAP fast re-authentication |
163 | # By default, fast re-authentication is enabled for all EAP methods that | |
164 | # support it. This variable can be used to disable fast re-authentication. | |
165 | # Normally, there is no need to disable this. | |
166 | fast_reauth=1 | |
167 | ||
168 | # OpenSSL Engine support | |
f7cb6e9f DW |
169 | # These options can be used to load OpenSSL engines in special or legacy |
170 | # modes. | |
6fc6879b JM |
171 | # The two engines that are supported currently are shown below: |
172 | # They are both from the opensc project (http://www.opensc.org/) | |
f7cb6e9f DW |
173 | # By default the PKCS#11 engine is loaded if the client_cert or |
174 | # private_key option appear to be a PKCS#11 URI, and these options | |
175 | # should not need to be used explicitly. | |
6fc6879b JM |
176 | # make the opensc engine available |
177 | #opensc_engine_path=/usr/lib/opensc/engine_opensc.so | |
178 | # make the pkcs11 engine available | |
179 | #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so | |
180 | # configure the path to the pkcs11 module required by the pkcs11 engine | |
181 | #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so | |
182 | ||
07e2de31 JM |
183 | # OpenSSL cipher string |
184 | # | |
185 | # This is an OpenSSL specific configuration option for configuring the default | |
2b9891bd BG |
186 | # ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW" |
187 | # by default) is used. | |
07e2de31 JM |
188 | # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation |
189 | # on cipher suite configuration. This is applicable only if wpa_supplicant is | |
190 | # built to use OpenSSL. | |
191 | #openssl_ciphers=DEFAULT:!EXP:!LOW | |
192 | ||
6fc6879b JM |
193 | # Dynamic EAP methods |
194 | # If EAP methods were built dynamically as shared object files, they need to be | |
195 | # loaded here before being used in the network blocks. By default, EAP methods | |
196 | # are included statically in the build, so these lines are not needed | |
197 | #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so | |
198 | #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so | |
199 | ||
200 | # Driver interface parameters | |
205d2d1f | 201 | # This field can be used to configure arbitrary driver interface parameters. The |
6fc6879b JM |
202 | # format is specific to the selected driver interface. This field is not used |
203 | # in most cases. | |
204 | #driver_param="field=value" | |
205 | ||
814e925d JM |
206 | # Country code |
207 | # The ISO/IEC alpha2 country code for the country in which this device is | |
208 | # currently operating. | |
209 | #country=US | |
210 | ||
6fc6879b JM |
211 | # Maximum lifetime for PMKSA in seconds; default 43200 |
212 | #dot11RSNAConfigPMKLifetime=43200 | |
213 | # Threshold for reauthentication (percentage of PMK lifetime); default 70 | |
214 | #dot11RSNAConfigPMKReauthThreshold=70 | |
215 | # Timeout for security association negotiation in seconds; default 60 | |
216 | #dot11RSNAConfigSATimeout=60 | |
217 | ||
f855f923 JM |
218 | # Wi-Fi Protected Setup (WPS) parameters |
219 | ||
220 | # Universally Unique IDentifier (UUID; see RFC 4122) of the device | |
183d3924 JM |
221 | # If not configured, UUID will be generated based on the mechanism selected with |
222 | # the auto_uuid parameter. | |
f855f923 JM |
223 | #uuid=12345678-9abc-def0-1234-56789abcdef0 |
224 | ||
183d3924 JM |
225 | # Automatic UUID behavior |
226 | # 0 = generate static value based on the local MAC address (default) | |
227 | # 1 = generate a random UUID every time wpa_supplicant starts | |
228 | #auto_uuid=0 | |
229 | ||
3c0b7aa4 JM |
230 | # Device Name |
231 | # User-friendly description of device; up to 32 octets encoded in UTF-8 | |
232 | #device_name=Wireless Client | |
233 | ||
234 | # Manufacturer | |
235 | # The manufacturer of the device (up to 64 ASCII characters) | |
236 | #manufacturer=Company | |
237 | ||
238 | # Model Name | |
239 | # Model of the device (up to 32 ASCII characters) | |
240 | #model_name=cmodel | |
241 | ||
242 | # Model Number | |
243 | # Additional device description (up to 32 ASCII characters) | |
244 | #model_number=123 | |
245 | ||
246 | # Serial Number | |
247 | # Serial number of the device (up to 32 characters) | |
248 | #serial_number=12345 | |
249 | ||
250 | # Primary Device Type | |
251 | # Used format: <categ>-<OUI>-<subcateg> | |
252 | # categ = Category as an integer value | |
253 | # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for | |
254 | # default WPS OUI | |
255 | # subcateg = OUI-specific Sub Category as an integer value | |
256 | # Examples: | |
257 | # 1-0050F204-1 (Computer / PC) | |
258 | # 1-0050F204-2 (Computer / Server) | |
259 | # 5-0050F204-1 (Storage / NAS) | |
260 | # 6-0050F204-1 (Network Infrastructure / AP) | |
e83a0898 | 261 | #device_type=1-0050F204-1 |
3c0b7aa4 JM |
262 | |
263 | # OS Version | |
264 | # 4-octet operating system version number (hex string) | |
265 | #os_version=01020300 | |
266 | ||
c0e4dd9e JM |
267 | # Config Methods |
268 | # List of the supported configuration methods | |
269 | # Available methods: usba ethernet label display ext_nfc_token int_nfc_token | |
6a857074 JM |
270 | # nfc_interface push_button keypad virtual_display physical_display |
271 | # virtual_push_button physical_push_button | |
53587ec1 JM |
272 | # For WSC 1.0: |
273 | #config_methods=label display push_button keypad | |
274 | # For WSC 2.0: | |
6a857074 | 275 | #config_methods=label virtual_display virtual_push_button keypad |
c0e4dd9e | 276 | |
47662164 JM |
277 | # Credential processing |
278 | # 0 = process received credentials internally (default) | |
279 | # 1 = do not process received credentials; just pass them over ctrl_iface to | |
280 | # external program(s) | |
281 | # 2 = process received credentials internally and pass them over ctrl_iface | |
282 | # to external program(s) | |
283 | #wps_cred_processing=0 | |
f855f923 | 284 | |
339dc8bd JM |
285 | # Whether to enable SAE (WPA3-Personal transition mode) automatically for |
286 | # WPA2-PSK credentials received using WPS. | |
287 | # 0 = only add the explicitly listed WPA2-PSK configuration (default) | |
288 | # 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the | |
289 | # station gets configured in WPA3-Personal transition mode (supports both | |
290 | # WPA2-Personal (PSK) and WPA3-Personal (SAE) APs). | |
291 | #wps_cred_add_sae=0 | |
292 | ||
71dd3b78 AS |
293 | # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing |
294 | # The vendor attribute contents to be added in M1 (hex string) | |
295 | #wps_vendor_ext_m1=000137100100020001 | |
296 | ||
51ca03f4 JM |
297 | # NFC password token for WPS |
298 | # These parameters can be used to configure a fixed NFC password token for the | |
299 | # station. This can be generated, e.g., with nfc_pw_token. When these | |
300 | # parameters are used, the station is assumed to be deployed with a NFC tag | |
301 | # that includes the matching NFC password token (e.g., written based on the | |
302 | # NDEF record from nfc_pw_token). | |
303 | # | |
304 | #wps_nfc_dev_pw_id: Device Password ID (16..65535) | |
305 | #wps_nfc_dh_pubkey: Hexdump of DH Public Key | |
306 | #wps_nfc_dh_privkey: Hexdump of DH Private Key | |
307 | #wps_nfc_dev_pw: Hexdump of Device Password | |
308 | ||
94687a0a SD |
309 | # Priority for the networks added through WPS |
310 | # This priority value will be set to each network profile that is added | |
311 | # by executing the WPS protocol. | |
312 | #wps_priority=0 | |
313 | ||
5a5639b0 JM |
314 | # Device Provisioning Protocol (DPP) parameters |
315 | # | |
316 | # How to process DPP configuration | |
317 | # 0 = report received configuration to an external program for | |
318 | # processing; do not generate any network profile internally (default) | |
319 | # 1 = report received configuration to an external program and generate | |
320 | # a network profile internally, but do not automatically connect | |
321 | # to the created (disabled) profile; the network profile id is | |
322 | # reported to external programs | |
323 | # 2 = report received configuration to an external program, generate | |
324 | # a network profile internally, try to connect to the created | |
325 | # profile automatically | |
326 | #dpp_config_processing=0 | |
327 | # | |
328 | # Name for Enrollee's DPP Configuration Request | |
329 | #dpp_name=Test | |
330 | # | |
331 | # MUD URL for Enrollee's DPP Configuration Request (optional) | |
332 | #dpp_mud_url=https://example.com/mud | |
333 | ||
c9c38b09 JM |
334 | # Maximum number of BSS entries to keep in memory |
335 | # Default: 200 | |
336 | # This can be used to limit memory use on the BSS entries (cached scan | |
337 | # results). A larger value may be needed in environments that have huge number | |
338 | # of APs when using ap_scan=1 mode. | |
339 | #bss_max_count=200 | |
340 | ||
6f484978 BG |
341 | # BSS expiration age in seconds. A BSS will be removed from the local cache |
342 | # if it is not in use and has not been seen for this time. Default is 180. | |
343 | #bss_expiration_age=180 | |
344 | ||
345 | # BSS expiration after number of scans. A BSS will be removed from the local | |
346 | # cache if it is not seen in this number of scans. | |
347 | # Default is 2. | |
348 | #bss_expiration_scan_count=2 | |
349 | ||
b0786fba TB |
350 | # Automatic scan |
351 | # This is an optional set of parameters for automatic scanning | |
352 | # within an interface in following format: | |
353 | #autoscan=<autoscan module name>:<module parameters> | |
65015b2d JM |
354 | # autoscan is like bgscan but on disconnected or inactive state. |
355 | # For instance, on exponential module parameters would be <base>:<limit> | |
c0fba2b3 TB |
356 | #autoscan=exponential:3:300 |
357 | # Which means a delay between scans on a base exponential of 3, | |
65015b2d JM |
358 | # up to the limit of 300 seconds (3, 9, 27 ... 300) |
359 | # For periodic module, parameters would be <fixed interval> | |
e3659c89 | 360 | #autoscan=periodic:30 |
32c02261 AS |
361 | # So a delay of 30 seconds will be applied between each scan. |
362 | # Note: If sched_scan_plans are configured and supported by the driver, | |
363 | # autoscan is ignored. | |
c9c38b09 | 364 | |
3812464c JM |
365 | # filter_ssids - SSID-based scan result filtering |
366 | # 0 = do not filter scan results (default) | |
367 | # 1 = only include configured SSIDs in scan results/BSS table | |
368 | #filter_ssids=0 | |
369 | ||
306ae225 JM |
370 | # Password (and passphrase, etc.) backend for external storage |
371 | # format: <backend name>[:<optional backend parameters>] | |
e680a51e PS |
372 | # Test backend which stores passwords in memory. Should only be used for |
373 | # development purposes. | |
306ae225 | 374 | #ext_password_backend=test:pw1=password|pw2=testing |
e680a51e PS |
375 | # File-based backend which reads passwords from a file. The parameter |
376 | # identifies the file to read passwords from. The password file follows the | |
377 | # format of wpa_supplicant.conf and accepts simple `key=passphrase` formatted | |
378 | # passwords. | |
379 | #ext_password_backend=file:/path/to/passwords.conf | |
306ae225 | 380 | |
579674eb BG |
381 | |
382 | # Disable P2P functionality | |
383 | # p2p_disabled=1 | |
384 | ||
462a7439 ES |
385 | # Timeout in seconds to detect STA inactivity (default: 300 seconds) |
386 | # | |
387 | # This timeout value is used in P2P GO mode to clean up | |
388 | # inactive stations. | |
389 | #p2p_go_max_inactivity=300 | |
390 | ||
1b928f96 JM |
391 | # Passphrase length (8..63) for P2P GO |
392 | # | |
393 | # This parameter controls the length of the random passphrase that is | |
394 | # generated at the GO. Default: 8. | |
395 | #p2p_passphrase_len=8 | |
396 | ||
d3b20469 NS |
397 | # Extra delay between concurrent P2P search iterations |
398 | # | |
399 | # This value adds extra delay in milliseconds between concurrent search | |
400 | # iterations to make p2p_find friendlier to concurrent operations by avoiding | |
401 | # it from taking 100% of radio resources. The default value is 500 ms. | |
402 | #p2p_search_delay=500 | |
403 | ||
6e202021 JM |
404 | # Opportunistic Key Caching (also known as Proactive Key Caching) default |
405 | # This parameter can be used to set the default behavior for the | |
406 | # proactive_key_caching parameter. By default, OKC is disabled unless enabled | |
407 | # with the global okc=1 parameter or with the per-network | |
408 | # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but | |
409 | # can be disabled with per-network proactive_key_caching=0 parameter. | |
410 | #okc=0 | |
3812464c | 411 | |
62d49803 JM |
412 | # Protected Management Frames default |
413 | # This parameter can be used to set the default behavior for the ieee80211w | |
22950049 JM |
414 | # parameter for RSN networks. By default, PMF is disabled unless enabled with |
415 | # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter. | |
416 | # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the | |
417 | # per-network ieee80211w parameter. This global default value does not apply | |
418 | # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using | |
419 | # RSN. | |
62d49803 JM |
420 | #pmf=0 |
421 | ||
c6f8af50 JM |
422 | # sae_check_mfp: Require PMF support to select SAE key_mgmt |
423 | # 0 = Do not check PMF for SAE (default) | |
424 | # 1 = Limit SAE when PMF is not enabled | |
425 | # | |
426 | # When enabled SAE will not be selected if PMF will not be used | |
427 | # for the connection. | |
428 | # Scenarios where this check will limit SAE: | |
429 | # 1) ieee80211w=0 is set for the network | |
430 | # 2) The AP does not have PMF enabled. | |
431 | # 3) ieee80211w is unset, pmf=1 is enabled globally, and | |
432 | # the device does not support the BIP cipher. | |
433 | # Consider the configuration of global parameterss sae_check_mfp=1, pmf=1 and a | |
434 | # network configured with ieee80211w unset and key_mgmt=SAE WPA-PSK. | |
435 | # In the example WPA-PSK will be used if the device does not support | |
436 | # the BIP cipher or the AP has PMF disabled. | |
437 | # Limiting SAE with this check can avoid failing to associate to an AP | |
438 | # that is configured with sae_requires_mfp=1 if the device does | |
439 | # not support PMF due to lack of the BIP cipher. | |
440 | # | |
441 | # Enabling this check helps with compliance of the WPA3 | |
442 | # specification for WPA3-Personal transition mode. | |
443 | # The WPA3 specification section 2.3 "WPA3-Personal transition mode" item 8 | |
444 | # states "A STA shall negotiate PMF when associating to an AP using SAE". | |
445 | # With this check WPA3 capable devices when connecting | |
446 | # to transition mode APs that do not advertise PMF support | |
447 | # will not use SAE and instead fallback to PSK. | |
448 | #sae_check_mfp=0 | |
449 | ||
625f202a JM |
450 | # Enabled SAE finite cyclic groups in preference order |
451 | # By default (if this parameter is not set), the mandatory group 19 (ECC group | |
a9fe1303 JM |
452 | # defined over a 256-bit prime order field, NIST P-256) is preferred and groups |
453 | # 20 (NIST P-384) and 21 (NIST P-521) are also enabled. If this parameter is | |
454 | # set, the groups will be tried in the indicated order. | |
455 | # The group values are listed in the IANA registry: | |
625f202a | 456 | # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9 |
a9fe1303 JM |
457 | # Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production |
458 | # purposes due limited security (see RFC 8247). Groups that are not as strong as | |
459 | # group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases | |
460 | # since all implementations are required to support group 19. | |
461 | #sae_groups=19 20 21 | |
625f202a | 462 | |
85e64e63 | 463 | # SAE mechanism for PWE derivation |
e36a5894 JM |
464 | # 0 = hunting-and-pecking loop only (default without password identifier) |
465 | # 1 = hash-to-element only (default with password identifier) | |
85e64e63 JM |
466 | # 2 = both hunting-and-pecking loop and hash-to-element enabled |
467 | # Note: The default value is likely to change from 0 to 2 once the new | |
468 | # hash-to-element mechanism has received more interoperability testing. | |
e36a5894 JM |
469 | # When using SAE password identifier, the hash-to-element mechanism is used |
470 | # regardless of the sae_pwe parameter value. | |
85e64e63 JM |
471 | #sae_pwe=0 |
472 | ||
18206e02 JM |
473 | # Default value for DTIM period (if not overridden in network block) |
474 | #dtim_period=2 | |
475 | ||
476 | # Default value for Beacon interval (if not overridden in network block) | |
477 | #beacon_int=100 | |
478 | ||
18a2eaab JM |
479 | # Additional vendor specific elements for Beacon and Probe Response frames |
480 | # This parameter can be used to add additional vendor specific element(s) into | |
481 | # the end of the Beacon and Probe Response frames. The format for these | |
482 | # element(s) is a hexdump of the raw information elements (id+len+payload for | |
483 | # one or more elements). This is used in AP and P2P GO modes. | |
484 | #ap_vendor_elements=dd0411223301 | |
485 | ||
4342326f JM |
486 | # Ignore scan results older than request |
487 | # | |
488 | # The driver may have a cache of scan results that makes it return | |
489 | # information that is older than our scan trigger. This parameter can | |
490 | # be used to configure such old information to be ignored instead of | |
491 | # allowing it to update the internal BSS table. | |
492 | #ignore_old_scan_res=0 | |
493 | ||
6124e858 BG |
494 | # scan_cur_freq: Whether to scan only the current frequency |
495 | # 0: Scan all available frequencies. (Default) | |
496 | # 1: Scan current operating frequency if another VIF on the same radio | |
497 | # is already associated. | |
4342326f | 498 | |
f7bbad57 MK |
499 | # Seconds to consider old scan results valid for association (default: 5) |
500 | #scan_res_valid_for_connect=5 | |
501 | ||
c267753b JM |
502 | # MAC address policy default |
503 | # 0 = use permanent MAC address | |
504 | # 1 = use random MAC address for each ESS connection | |
a313d17d | 505 | # 2 = like 1, but maintain OUI (with local admin bit set) |
3e715169 | 506 | # 3 = use dedicated/pregenerated MAC address (see mac_value) |
c267753b JM |
507 | # |
508 | # By default, permanent MAC address is used unless policy is changed by | |
509 | # the per-network mac_addr parameter. Global mac_addr=1 can be used to | |
510 | # change this default behavior. | |
511 | #mac_addr=0 | |
512 | ||
3e715169 JM |
513 | # Local MAC address to use whenever connecting with this network profile |
514 | # This is used with mac_addr=3. | |
515 | #mac_value=02:12:34:56:78:9a | |
516 | ||
c267753b JM |
517 | # Lifetime of random MAC address in seconds (default: 60) |
518 | #rand_addr_lifetime=60 | |
519 | ||
520 | # MAC address policy for pre-association operations (scanning, ANQP) | |
521 | # 0 = use permanent MAC address | |
522 | # 1 = use random MAC address | |
a313d17d | 523 | # 2 = like 1, but maintain OUI (with local admin bit set) |
c267753b JM |
524 | #preassoc_mac_addr=0 |
525 | ||
1d9d21f3 VK |
526 | # MAC address policy for GAS operations |
527 | # 0 = use permanent MAC address | |
528 | # 1 = use random MAC address | |
529 | # 2 = like 1, but maintain OUI (with local admin bit set) | |
0c5edede JM |
530 | # Note that this setting is ignored when a specific MAC address is needed for |
531 | # a full protocol exchange that includes GAS, e.g., when going through a DPP | |
532 | # exchange that exposes the configured interface address as part of the DP | |
533 | # Public Action frame exchanges before using GAS. That same address is then used | |
534 | # during the GAS exchange as well to avoid breaking the protocol expectations. | |
1d9d21f3 VK |
535 | #gas_rand_mac_addr=0 |
536 | ||
537 | # Lifetime of GAS random MAC address in seconds (default: 60) | |
538 | #gas_rand_addr_lifetime=60 | |
539 | ||
46ee0427 JM |
540 | # Interworking (IEEE 802.11u) |
541 | ||
542 | # Enable Interworking | |
543 | # interworking=1 | |
544 | ||
63bc0ab0 SD |
545 | # Enable P2P GO advertisement of Interworking |
546 | # go_interworking=1 | |
547 | ||
548 | # P2P GO Interworking: Access Network Type | |
549 | # 0 = Private network | |
550 | # 1 = Private network with guest access | |
551 | # 2 = Chargeable public network | |
552 | # 3 = Free public network | |
553 | # 4 = Personal device network | |
554 | # 5 = Emergency services only network | |
555 | # 14 = Test or experimental | |
556 | # 15 = Wildcard | |
557 | #go_access_network_type=0 | |
558 | ||
559 | # P2P GO Interworking: Whether the network provides connectivity to the Internet | |
560 | # 0 = Unspecified | |
561 | # 1 = Network provides connectivity to the Internet | |
562 | #go_internet=1 | |
563 | ||
564 | # P2P GO Interworking: Group Venue Info (optional) | |
565 | # The available values are defined in IEEE Std 802.11-2016, 9.4.1.35. | |
566 | # Example values (group,type): | |
567 | # 0,0 = Unspecified | |
568 | # 1,7 = Convention Center | |
569 | # 1,13 = Coffee Shop | |
570 | # 2,0 = Unspecified Business | |
571 | # 7,1 Private Residence | |
572 | #go_venue_group=7 | |
573 | #go_venue_type=1 | |
574 | ||
b439b21a | 575 | # Homogeneous ESS identifier |
46ee0427 JM |
576 | # If this is set, scans will be used to request response only from BSSes |
577 | # belonging to the specified Homogeneous ESS. This is used only if interworking | |
578 | # is enabled. | |
579 | # hessid=00:11:22:33:44:55 | |
580 | ||
4d5bda5f JM |
581 | # Automatic network selection behavior |
582 | # 0 = do not automatically go through Interworking network selection | |
583 | # (i.e., require explicit interworking_select command for this; default) | |
584 | # 1 = perform Interworking network selection if one or more | |
585 | # credentials have been configured and scan did not find a | |
586 | # matching network block | |
587 | #auto_interworking=0 | |
588 | ||
c86bef29 JM |
589 | # GAS Address3 field behavior |
590 | # 0 = P2P specification (Address3 = AP BSSID); default | |
591 | # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when | |
592 | # sent to not-associated AP; if associated, AP BSSID) | |
593 | #gas_address3=0 | |
594 | ||
d1723c55 LD |
595 | # Publish fine timing measurement (FTM) responder functionality in |
596 | # the Extended Capabilities element bit 70. | |
597 | # Controls whether FTM responder functionality will be published by AP/STA. | |
598 | # Note that actual FTM responder operation is managed outside wpa_supplicant. | |
599 | # 0 = Do not publish; default | |
600 | # 1 = Publish | |
601 | #ftm_responder=0 | |
602 | ||
603 | # Publish fine timing measurement (FTM) initiator functionality in | |
604 | # the Extended Capabilities element bit 71. | |
605 | # Controls whether FTM initiator functionality will be published by AP/STA. | |
606 | # Note that actual FTM initiator operation is managed outside wpa_supplicant. | |
607 | # 0 = Do not publish; default | |
608 | # 1 = Publish | |
609 | #ftm_initiator=0 | |
610 | ||
400020cb JM |
611 | # credential block |
612 | # | |
613 | # Each credential used for automatic network selection is configured as a set | |
614 | # of parameters that are compared to the information advertised by the APs when | |
615 | # interworking_select and interworking_connect commands are used. | |
616 | # | |
617 | # credential fields: | |
618 | # | |
03ed3324 JM |
619 | # temporary: Whether this credential is temporary and not to be saved |
620 | # | |
400020cb JM |
621 | # priority: Priority group |
622 | # By default, all networks and credentials get the same priority group | |
623 | # (0). This field can be used to give higher priority for credentials | |
624 | # (and similarly in struct wpa_ssid for network blocks) to change the | |
625 | # Interworking automatic networking selection behavior. The matching | |
626 | # network (based on either an enabled network block or a credential) | |
627 | # with the highest priority value will be selected. | |
628 | # | |
d7b01abd JM |
629 | # pcsc: Use PC/SC and SIM/USIM card |
630 | # | |
400020cb JM |
631 | # realm: Home Realm for Interworking |
632 | # | |
633 | # username: Username for Interworking network selection | |
634 | # | |
635 | # password: Password for Interworking network selection | |
636 | # | |
637 | # ca_cert: CA certificate for Interworking network selection | |
638 | # | |
639 | # client_cert: File path to client certificate file (PEM/DER) | |
640 | # This field is used with Interworking networking selection for a case | |
641 | # where client certificate/private key is used for authentication | |
642 | # (EAP-TLS). Full path to the file should be used since working | |
643 | # directory may change when wpa_supplicant is run in the background. | |
644 | # | |
f7cb6e9f DW |
645 | # Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI. |
646 | # | |
647 | # For example: private_key="pkcs11:manufacturer=piv_II;id=%01" | |
648 | # | |
400020cb JM |
649 | # Alternatively, a named configuration blob can be used by setting |
650 | # this to blob://blob_name. | |
651 | # | |
652 | # private_key: File path to client private key file (PEM/DER/PFX) | |
653 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be | |
654 | # commented out. Both the private key and certificate will be read | |
655 | # from the PKCS#12 file in this case. Full path to the file should be | |
656 | # used since working directory may change when wpa_supplicant is run | |
657 | # in the background. | |
658 | # | |
f7cb6e9f DW |
659 | # Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI. |
660 | # For example: private_key="pkcs11:manufacturer=piv_II;id=%01" | |
661 | # | |
400020cb JM |
662 | # Windows certificate store can be used by leaving client_cert out and |
663 | # configuring private_key in one of the following formats: | |
664 | # | |
665 | # cert://substring_to_match | |
666 | # | |
667 | # hash://certificate_thumbprint_in_hex | |
668 | # | |
669 | # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4" | |
670 | # | |
671 | # Note that when running wpa_supplicant as an application, the user | |
672 | # certificate store (My user account) is used, whereas computer store | |
673 | # (Computer account) is used when running wpasvc as a service. | |
674 | # | |
675 | # Alternatively, a named configuration blob can be used by setting | |
676 | # this to blob://blob_name. | |
677 | # | |
678 | # private_key_passwd: Password for private key file | |
679 | # | |
680 | # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format | |
681 | # | |
682 | # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN> | |
683 | # format | |
684 | # | |
463c8ffb | 685 | # domain: Home service provider FQDN(s) |
400020cb | 686 | # This is used to compare against the Domain Name List to figure out |
463c8ffb JM |
687 | # whether the AP is operated by the Home SP. Multiple domain entries can |
688 | # be used to configure alternative FQDNs that will be considered home | |
689 | # networks. | |
400020cb | 690 | # |
58eb905a DD |
691 | # home_ois: Home OI(s) |
692 | # This string field contains one or more comma delimited OIs (hexdump) | |
693 | # identifying the access the access points that support authentication | |
694 | # with this credential. There are an alternative to the use of the realm | |
695 | # parameter. When using Home OIs to match the network, the EAP parameters | |
696 | # need to be pre-configured with the credentials since the NAI Realm | |
697 | # information may not be available or fetched. | |
698 | # A successful authentication with the access point is possible as soon | |
699 | # as at least one Home OI from the list matches an OI in the Roaming | |
700 | # Consortium advertised by the access point. | |
701 | # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOI) | |
702 | # | |
703 | # required_home_ois: Required Home OI(s) | |
704 | # This string field contains the set of Home OI(s) (hexdump) that are | |
705 | # required to be advertised by the AP for the credential to be considered | |
706 | # matching. | |
707 | # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOIRequired) | |
708 | # | |
955567bc | 709 | # roaming_consortium: Roaming Consortium OI |
58eb905a | 710 | # Deprecated: use home_ois instead. |
955567bc JM |
711 | # If roaming_consortium_len is non-zero, this field contains the |
712 | # Roaming Consortium OI that can be used to determine which access | |
713 | # points support authentication with this credential. This is an | |
714 | # alternative to the use of the realm parameter. When using Roaming | |
715 | # Consortium to match the network, the EAP parameters need to be | |
716 | # pre-configured with the credential since the NAI Realm information | |
717 | # may not be available or fetched. | |
718 | # | |
9b6f93e4 | 719 | # required_roaming_consortium: Required Roaming Consortium OI |
58eb905a | 720 | # Deprecated: use required_home_ois instead. |
9b6f93e4 JM |
721 | # If required_roaming_consortium_len is non-zero, this field contains the |
722 | # Roaming Consortium OI that is required to be advertised by the AP for | |
723 | # the credential to be considered matching. | |
724 | # | |
909a948b JM |
725 | # roaming_consortiums: Roaming Consortium OI(s) memberships |
726 | # This string field contains one or more comma delimited OIs (hexdump) | |
727 | # identifying the roaming consortiums of which the provider is a member. | |
728 | # The list is sorted from the most preferred one to the least preferred | |
729 | # one. A match between the Roaming Consortium OIs advertised by an AP and | |
730 | # the OIs in this list indicates that successful authentication is | |
731 | # possible. | |
732 | # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI) | |
733 | # | |
8ca93c59 JM |
734 | # eap: Pre-configured EAP method |
735 | # This optional field can be used to specify which EAP method will be | |
736 | # used with this credential. If not set, the EAP method is selected | |
737 | # automatically based on ANQP information (e.g., NAI Realm). | |
738 | # | |
739 | # phase1: Pre-configure Phase 1 (outer authentication) parameters | |
740 | # This optional field is used with like the 'eap' parameter. | |
741 | # | |
742 | # phase2: Pre-configure Phase 2 (inner authentication) parameters | |
743 | # This optional field is used with like the 'eap' parameter. | |
744 | # | |
dbea8ac7 JM |
745 | # excluded_ssid: Excluded SSID |
746 | # This optional field can be used to excluded specific SSID(s) from | |
747 | # matching with the network. Multiple entries can be used to specify more | |
748 | # than one SSID. | |
749 | # | |
bc00053c JM |
750 | # roaming_partner: Roaming partner information |
751 | # This optional field can be used to configure preferences between roaming | |
752 | # partners. The field is a string in following format: | |
753 | # <FQDN>,<0/1 exact match>,<priority>,<* or country code> | |
754 | # (non-exact match means any subdomain matches the entry; priority is in | |
755 | # 0..255 range with 0 being the highest priority) | |
756 | # | |
f9cd147d JM |
757 | # update_identifier: PPS MO ID |
758 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) | |
759 | # | |
aa26ba68 JM |
760 | # provisioning_sp: FQDN of the SP that provisioned the credential |
761 | # This optional field can be used to keep track of the SP that provisioned | |
762 | # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>). | |
763 | # | |
4cad9df1 JM |
764 | # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*) |
765 | # These fields can be used to specify minimum download/upload backhaul | |
766 | # bandwidth that is preferred for the credential. This constraint is | |
767 | # ignored if the AP does not advertise WAN Metrics information or if the | |
768 | # limit would prevent any connection. Values are in kilobits per second. | |
769 | # min_dl_bandwidth_home | |
770 | # min_ul_bandwidth_home | |
771 | # min_dl_bandwidth_roaming | |
772 | # min_ul_bandwidth_roaming | |
773 | # | |
a45b2dc5 JM |
774 | # max_bss_load: Maximum BSS Load Channel Utilization (1..255) |
775 | # (PPS/<X+>/Policy/MaximumBSSLoadValue) | |
776 | # This value is used as the maximum channel utilization for network | |
777 | # selection purposes for home networks. If the AP does not advertise | |
778 | # BSS Load or if the limit would prevent any connection, this constraint | |
779 | # will be ignored. | |
780 | # | |
33fb8c52 JM |
781 | # req_conn_capab: Required connection capability |
782 | # (PPS/<X+>/Policy/RequiredProtoPortTuple) | |
783 | # This value is used to configure set of required protocol/port pairs that | |
784 | # a roaming network shall support (include explicitly in Connection | |
785 | # Capability ANQP element). This constraint is ignored if the AP does not | |
786 | # advertise Connection Capability or if this constraint would prevent any | |
787 | # network connection. This policy is not used in home networks. | |
788 | # Format: <protocol>[:<comma-separated list of ports] | |
789 | # Multiple entries can be used to list multiple requirements. | |
790 | # For example, number of common TCP protocols: | |
791 | # req_conn_capab=6,22,80,443 | |
792 | # For example, IPSec/IKE: | |
793 | # req_conn_capab=17:500 | |
794 | # req_conn_capab=50 | |
795 | # | |
cf6d08a6 JM |
796 | # ocsp: Whether to use/require OCSP to check server certificate |
797 | # 0 = do not use OCSP stapling (TLS certificate status extension) | |
798 | # 1 = try to use OCSP stapling, but not require response | |
799 | # 2 = require valid OCSP stapling response | |
d6b536f7 JM |
800 | # 3 = require valid OCSP stapling response for all not-trusted |
801 | # certificates in the server certificate chain | |
cf6d08a6 | 802 | # |
13f6a07e NJ |
803 | # sim_num: Identifier for which SIM to use in multi-SIM devices |
804 | # | |
400020cb JM |
805 | # for example: |
806 | # | |
807 | #cred={ | |
808 | # realm="example.com" | |
809 | # username="user@example.com" | |
810 | # password="password" | |
811 | # ca_cert="/etc/wpa_supplicant/ca.pem" | |
812 | # domain="example.com" | |
813 | #} | |
814 | # | |
815 | #cred={ | |
816 | # imsi="310026-000000000" | |
817bb3e1 | 817 | # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82" |
400020cb | 818 | #} |
955567bc JM |
819 | # |
820 | #cred={ | |
821 | # realm="example.com" | |
822 | # username="user" | |
823 | # password="password" | |
824 | # ca_cert="/etc/wpa_supplicant/ca.pem" | |
825 | # domain="example.com" | |
58eb905a | 826 | # home_ois="223344" |
955567bc JM |
827 | # eap=TTLS |
828 | # phase2="auth=MSCHAPV2" | |
829 | #} | |
2a4b98a9 | 830 | |
66aadbd7 JK |
831 | # Hotspot 2.0 |
832 | # hs20=1 | |
833 | ||
32c02261 AS |
834 | # Scheduled scan plans |
835 | # | |
836 | # A space delimited list of scan plans. Each scan plan specifies the scan | |
837 | # interval and number of iterations, delimited by a colon. The last scan plan | |
838 | # will run infinitely and thus must specify only the interval and not the number | |
839 | # of iterations. | |
840 | # | |
841 | # The driver advertises the maximum number of scan plans supported. If more scan | |
842 | # plans than supported are configured, only the first ones are set (up to the | |
843 | # maximum supported). The last scan plan that specifies only the interval is | |
844 | # always set as the last plan. | |
845 | # | |
846 | # If the scan interval or the number of iterations for a scan plan exceeds the | |
847 | # maximum supported, it will be set to the maximum supported value. | |
848 | # | |
849 | # Format: | |
850 | # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval> | |
851 | # | |
852 | # Example: | |
853 | # sched_scan_plans=10:100 20:200 30 | |
854 | ||
facf2c72 DS |
855 | # Multi Band Operation (MBO) non-preferred channels |
856 | # A space delimited list of non-preferred channels where each channel is a colon | |
4a83d4b6 | 857 | # delimited list of values. |
facf2c72 | 858 | # Format: |
4a83d4b6 | 859 | # non_pref_chan=<oper_class>:<chan>:<preference>:<reason> |
facf2c72 | 860 | # Example: |
23cddd75 | 861 | # non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2 |
facf2c72 | 862 | |
c5d193d7 DS |
863 | # MBO Cellular Data Capabilities |
864 | # 1 = Cellular data connection available | |
865 | # 2 = Cellular data connection not available | |
866 | # 3 = Not cellular capable (default) | |
867 | #mbo_cell_capa=3 | |
868 | ||
332aadb8 AP |
869 | # Optimized Connectivity Experience (OCE) |
870 | # oce: Enable OCE features (bitmap) | |
871 | # Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver | |
872 | # does not indicate support for OCE in STA mode) | |
873 | # Set BIT(1) to Enable OCE in STA-CFON mode | |
874 | #oce=1 | |
875 | ||
b17b7a8e AW |
876 | # Extended Key ID support for Individually Addressed frames |
877 | # 0 = force off: Do not use Extended Key ID (default) | |
878 | # 1 = auto: Activate Extended Key ID support if the driver supports it | |
879 | #extended_key_id=0 | |
880 | ||
6fc6879b JM |
881 | # network block |
882 | # | |
883 | # Each network (usually AP's sharing the same SSID) is configured as a separate | |
884 | # block in this configuration file. The network blocks are in preference order | |
885 | # (the first match is used). | |
886 | # | |
887 | # network block fields: | |
888 | # | |
889 | # disabled: | |
890 | # 0 = this network can be used (default) | |
891 | # 1 = this network block is disabled (can be enabled through ctrl_iface, | |
892 | # e.g., with wpa_cli or wpa_gui) | |
893 | # | |
894 | # id_str: Network identifier string for external scripts. This value is passed | |
895 | # to external action script through wpa_cli as WPA_ID_STR environment | |
896 | # variable to make it easier to do network specific configuration. | |
897 | # | |
5c4b93d7 JM |
898 | # ssid: SSID (mandatory); network name in one of the optional formats: |
899 | # - an ASCII string with double quotation | |
900 | # - a hex string (two characters per octet of SSID) | |
901 | # - a printf-escaped ASCII string P"<escaped string>" | |
6fc6879b JM |
902 | # |
903 | # scan_ssid: | |
904 | # 0 = do not scan this SSID with specific Probe Request frames (default) | |
905 | # 1 = scan with SSID-specific Probe Request frames (this can be used to | |
906 | # find APs that do not accept broadcast SSID or use multiple SSIDs; | |
907 | # this will add latency to scanning, so enable this only when needed) | |
908 | # | |
909 | # bssid: BSSID (optional); if set, this network block is used only when | |
910 | # associating with the AP using the configured BSSID | |
911 | # | |
a8f30422 YY |
912 | # ignore_broadcast_ssid: SSID broadcast behavior |
913 | # Send empty SSID in beacons and ignore probe request frames that do not | |
914 | # specify full SSID, i.e., require stations to know SSID. | |
915 | # default: disabled (0) | |
916 | # 1 = send empty (length=0) SSID in beacon and ignore probe request for | |
917 | # broadcast SSID | |
918 | # 2 = clear SSID (ASCII 0), but keep the original length (this may be required | |
919 | # with some clients that do not support empty SSID) and ignore probe | |
920 | # requests for broadcast SSID | |
921 | # | |
6fc6879b JM |
922 | # priority: priority group (integer) |
923 | # By default, all networks will get same priority group (0). If some of the | |
924 | # networks are more desirable, this field can be used to change the order in | |
925 | # which wpa_supplicant goes through the networks when selecting a BSS. The | |
926 | # priority groups will be iterated in decreasing priority (i.e., the larger the | |
927 | # priority value, the sooner the network is matched against the scan results). | |
928 | # Within each priority group, networks will be selected based on security | |
929 | # policy, signal strength, etc. | |
930 | # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not | |
931 | # using this priority to select the order for scanning. Instead, they try the | |
932 | # networks in the order that used in the configuration file. | |
933 | # | |
934 | # mode: IEEE 802.11 operation mode | |
935 | # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default) | |
936 | # 1 = IBSS (ad-hoc, peer-to-peer) | |
1581b38b | 937 | # 2 = AP (access point) |
b2838baf JM |
938 | # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and |
939 | # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key | |
940 | # TKIP/CCMP) is available for backwards compatibility, but its use is | |
941 | # deprecated. WPA-None requires following network block options: | |
6fc6879b JM |
942 | # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not |
943 | # both), and psk must also be set. | |
944 | # | |
945 | # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g., | |
946 | # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial | |
947 | # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode. | |
948 | # In addition, this value is only used by the station that creates the IBSS. If | |
949 | # an IBSS network with the configured SSID is already present, the frequency of | |
950 | # the network will be used instead of this configured value. | |
951 | # | |
b9074912 | 952 | # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only. |
90f14962 LD |
953 | # 0 = do not use PBSS |
954 | # 1 = use PBSS | |
955 | # 2 = don't care (not allowed in AP mode) | |
b9074912 LD |
956 | # Used together with mode configuration. When mode is AP, it means to start a |
957 | # PCP instead of a regular AP. When mode is infrastructure it means connect | |
90f14962 LD |
958 | # to a PCP instead of AP. In this mode you can also specify 2 (don't care) |
959 | # which means connect to either PCP or AP. | |
960 | # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network. | |
b9074912 LD |
961 | # For more details, see IEEE Std 802.11ad-2012. |
962 | # | |
d3a98225 JM |
963 | # scan_freq: List of frequencies to scan |
964 | # Space-separated list of frequencies in MHz to scan when searching for this | |
965 | # BSS. If the subset of channels used by the network is known, this option can | |
966 | # be used to optimize scanning to not occur on channels that the network does | |
967 | # not use. Example: scan_freq=2412 2437 2462 | |
968 | # | |
b766a9a2 JM |
969 | # freq_list: Array of allowed frequencies |
970 | # Space-separated list of frequencies in MHz to allow for selecting the BSS. If | |
971 | # set, scan results that do not match any of the specified frequencies are not | |
972 | # considered when selecting a BSS. | |
973 | # | |
f5ffc348 BG |
974 | # This can also be set on the outside of the network block. In this case, |
975 | # it limits the frequencies that will be scanned. | |
976 | # | |
2474ce45 JM |
977 | # bgscan: Background scanning |
978 | # wpa_supplicant behavior for background scanning can be specified by | |
979 | # configuring a bgscan module. These modules are responsible for requesting | |
980 | # background scans for the purpose of roaming within an ESS (i.e., within a | |
981 | # single network block with all the APs using the same SSID). The bgscan | |
982 | # parameter uses following format: "<bgscan module name>:<module parameters>" | |
983 | # Following bgscan modules are available: | |
984 | # simple - Periodic background scans based on signal strength | |
ceb7f65d | 985 | # send_btm_query > 0 means do this many BTM queries before attempting a scan. |
2474ce45 | 986 | # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>: |
ceb7f65d | 987 | # <long interval>[:<send_btm_query>]" |
2474ce45 | 988 | # bgscan="simple:30:-45:300" |
ceb7f65d | 989 | # bgscan="simple:30:-45:300:3" |
2474ce45 JM |
990 | # learn - Learn channels used by the network and try to avoid bgscans on other |
991 | # channels (experimental) | |
992 | # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>: | |
993 | # <long interval>[:<database file name>]" | |
994 | # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan" | |
268043d5 DS |
995 | # Explicitly disable bgscan by setting |
996 | # bgscan="" | |
2474ce45 | 997 | # |
31392709 HD |
998 | # This option can also be set outside of all network blocks for the bgscan |
999 | # parameter to apply for all the networks that have no specific bgscan | |
1000 | # parameter. | |
1001 | # | |
6fc6879b JM |
1002 | # proto: list of accepted protocols |
1003 | # WPA = WPA/IEEE 802.11i/D3.0 | |
1004 | # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN) | |
ecec4878 | 1005 | # Note that RSN is used also for WPA3. |
6fc6879b JM |
1006 | # If not set, this defaults to: WPA RSN |
1007 | # | |
1008 | # key_mgmt: list of accepted authenticated key management protocols | |
1009 | # WPA-PSK = WPA pre-shared key (this requires 'psk' field) | |
f6190d37 | 1010 | # WPA-EAP = WPA using EAP authentication |
6fc6879b JM |
1011 | # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically |
1012 | # generated WEP keys | |
1013 | # NONE = WPA is not used; plaintext or static WEP could be used | |
0ab0de88 JM |
1014 | # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK |
1015 | # instead) | |
1016 | # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key | |
1017 | # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication | |
d8e8c992 JM |
1018 | # FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication |
1019 | # and using SHA384 | |
56586197 JM |
1020 | # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms |
1021 | # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms | |
0ab0de88 JM |
1022 | # SAE = Simultaneous authentication of equals; pre-shared key/password -based |
1023 | # authentication with stronger security than WPA-PSK especially when using | |
ecec4878 | 1024 | # not that strong password; a.k.a. WPA3-Personal |
0ab0de88 JM |
1025 | # FT-SAE = SAE with FT |
1026 | # WPA-EAP-SUITE-B = Suite B 128-bit level | |
1027 | # WPA-EAP-SUITE-B-192 = Suite B 192-bit level | |
aeb408ff | 1028 | # OSEN = Hotspot 2.0 Rel 2 online signup connection |
9b7a2b83 JM |
1029 | # FILS-SHA256 = Fast Initial Link Setup with SHA256 |
1030 | # FILS-SHA384 = Fast Initial Link Setup with SHA384 | |
1031 | # FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256 | |
1032 | # FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384 | |
ecec4878 JM |
1033 | # OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open) |
1034 | # DPP = Device Provisioning Protocol | |
6fc6879b JM |
1035 | # If not set, this defaults to: WPA-PSK WPA-EAP |
1036 | # | |
4732ee3a | 1037 | # ieee80211w: whether management frame protection is enabled |
62d49803 | 1038 | # 0 = disabled (default unless changed with the global pmf parameter) |
4732ee3a JM |
1039 | # 1 = optional |
1040 | # 2 = required | |
1041 | # The most common configuration options for this based on the PMF (protected | |
1042 | # management frames) certification program are: | |
1043 | # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256 | |
1044 | # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256 | |
efaa6256 JM |
1045 | # (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used) |
1046 | # WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE | |
4732ee3a | 1047 | # |
ce6829c2 | 1048 | # ocv: whether operating channel validation is enabled |
2fb33ce4 | 1049 | # This is a countermeasure against multi-channel on-path attacks. |
ce6829c2 MV |
1050 | # Enabling this automatically also enables ieee80211w, if not yet enabled. |
1051 | # 0 = disabled (default) | |
73ebd58f VJ |
1052 | # 1 = enabled if wpa_supplicant's SME in use. Otherwise enabled only when the |
1053 | # driver indicates support for operating channel validation. | |
ce6829c2 MV |
1054 | #ocv=1 |
1055 | # | |
6fc6879b JM |
1056 | # auth_alg: list of allowed IEEE 802.11 authentication algorithms |
1057 | # OPEN = Open System authentication (required for WPA/WPA2) | |
1058 | # SHARED = Shared Key authentication (requires static WEP keys) | |
1059 | # LEAP = LEAP/Network EAP (only used with LEAP) | |
1060 | # If not set, automatic selection is used (Open System with LEAP enabled if | |
1061 | # LEAP is allowed as one of the EAP methods). | |
1062 | # | |
1063 | # pairwise: list of accepted pairwise (unicast) ciphers for WPA | |
1064 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
1065 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
1066 | # NONE = Use only Group Keys (deprecated, should not be included if APs support | |
1067 | # pairwise keys) | |
1068 | # If not set, this defaults to: CCMP TKIP | |
1069 | # | |
1070 | # group: list of accepted group (broadcast/multicast) ciphers for WPA | |
1071 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
1072 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
1073 | # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key | |
1074 | # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11] | |
1075 | # If not set, this defaults to: CCMP TKIP WEP104 WEP40 | |
1076 | # | |
61a56c14 JM |
1077 | # group_mgmt: list of accepted group management ciphers for RSN (PMF) |
1078 | # AES-128-CMAC = BIP-CMAC-128 | |
1079 | # BIP-GMAC-128 | |
1080 | # BIP-GMAC-256 | |
1081 | # BIP-CMAC-256 | |
1082 | # If not set, no constraint on the cipher, i.e., accept whichever cipher the AP | |
1083 | # indicates. | |
1084 | # | |
6fc6879b JM |
1085 | # psk: WPA preshared key; 256-bit pre-shared key |
1086 | # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e., | |
1087 | # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be | |
1088 | # generated using the passphrase and SSID). ASCII passphrase must be between | |
9173b16f JM |
1089 | # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can |
1090 | # be used to indicate that the PSK/passphrase is stored in external storage. | |
6fc6879b JM |
1091 | # This field is not needed, if WPA-EAP is used. |
1092 | # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys | |
1093 | # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant | |
1094 | # startup and reconfiguration time can be optimized by generating the PSK only | |
1095 | # only when the passphrase or SSID has actually changed. | |
1096 | # | |
a52410c2 JM |
1097 | # mem_only_psk: Whether to keep PSK/passphrase only in memory |
1098 | # 0 = allow psk/passphrase to be stored to the configuration file | |
1099 | # 1 = do not store psk/passphrase to the configuration file | |
1100 | #mem_only_psk=0 | |
1101 | # | |
a34ca59e JM |
1102 | # sae_password: SAE password |
1103 | # This parameter can be used to set a password for SAE. By default, the | |
a2ab3730 JM |
1104 | # passphrase from the psk parameter is used if this separate parameter is not |
1105 | # used, but psk follows the WPA-PSK constraints (8..63 characters) even though | |
1106 | # SAE passwords do not have such constraints. | |
a34ca59e | 1107 | # |
9be19d0b JM |
1108 | # sae_password_id: SAE password identifier |
1109 | # This parameter can be used to set an identifier for the SAE password. By | |
1110 | # default, no such identifier is used. If set, the specified identifier value | |
1111 | # is used by the other peer to select which password to use for authentication. | |
1112 | # | |
6fc6879b JM |
1113 | # eapol_flags: IEEE 802.1X/EAPOL options (bit field) |
1114 | # Dynamic WEP key required for non-WPA mode | |
1115 | # bit0 (1): require dynamically generated unicast WEP key | |
1116 | # bit1 (2): require dynamically generated broadcast WEP key | |
1117 | # (3 = require both keys; default) | |
ba5ea116 | 1118 | # Note: When using wired authentication (including MACsec drivers), |
dd10abcc HW |
1119 | # eapol_flags must be set to 0 for the authentication to be completed |
1120 | # successfully. | |
1121 | # | |
1122 | # macsec_policy: IEEE 802.1X/MACsec options | |
ba5ea116 SD |
1123 | # This determines how sessions are secured with MACsec (only for MACsec |
1124 | # drivers). | |
dd10abcc HW |
1125 | # 0: MACsec not in use (default) |
1126 | # 1: MACsec enabled - Should secure, accept key server's advice to | |
1127 | # determine whether to use a secure session or not. | |
6fc6879b | 1128 | # |
7b4d546e SD |
1129 | # macsec_integ_only: IEEE 802.1X/MACsec transmit mode |
1130 | # This setting applies only when MACsec is in use, i.e., | |
1131 | # - macsec_policy is enabled | |
1132 | # - the key server has decided to enable MACsec | |
1133 | # 0: Encrypt traffic (default) | |
1134 | # 1: Integrity only | |
1135 | # | |
e49b78c0 AK |
1136 | # macsec_replay_protect: IEEE 802.1X/MACsec replay protection |
1137 | # This setting applies only when MACsec is in use, i.e., | |
1138 | # - macsec_policy is enabled | |
1139 | # - the key server has decided to enable MACsec | |
1140 | # 0: Replay protection disabled (default) | |
1141 | # 1: Replay protection enabled | |
1142 | # | |
1143 | # macsec_replay_window: IEEE 802.1X/MACsec replay protection window | |
1144 | # This determines a window in which replay is tolerated, to allow receipt | |
1145 | # of frames that have been misordered by the network. | |
1146 | # This setting applies only when MACsec replay protection active, i.e., | |
1147 | # - macsec_replay_protect is enabled | |
1148 | # - the key server has decided to enable MACsec | |
1149 | # 0: No replay window, strict check (default) | |
1150 | # 1..2^32-1: number of packets that could be misordered | |
1151 | # | |
6d24673a EH |
1152 | # macsec_offload - Enable MACsec hardware offload |
1153 | # | |
1154 | # This setting applies only when MACsec is in use, i.e., | |
1155 | # - the key server has decided to enable MACsec | |
1156 | # | |
1157 | # 0 = MACSEC_OFFLOAD_OFF (default) | |
1158 | # 1 = MACSEC_OFFLOAD_PHY | |
1159 | # 2 = MACSEC_OFFLOAD_MAC | |
1160 | # | |
e0d9fd34 SD |
1161 | # macsec_port: IEEE 802.1X/MACsec port |
1162 | # Port component of the SCI | |
1163 | # Range: 1-65534 (default: 1) | |
1164 | # | |
65dfa872 | 1165 | # mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode |
ad51731a | 1166 | # This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair. |
65dfa872 BA |
1167 | # In this mode, instances of wpa_supplicant can act as MACsec peers. The peer |
1168 | # with lower priority will become the key server and start distributing SAKs. | |
871439b5 JM |
1169 | # mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit) |
1170 | # hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits) | |
1171 | # mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string | |
1172 | # (2..64 hex-digits) | |
65dfa872 BA |
1173 | # mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being |
1174 | # default priority | |
ad51731a | 1175 | # |
6fc6879b JM |
1176 | # mixed_cell: This option can be used to configure whether so called mixed |
1177 | # cells, i.e., networks that use both plaintext and encryption in the same | |
ffbf1eaa | 1178 | # SSID, are allowed when selecting a BSS from scan results. |
6fc6879b JM |
1179 | # 0 = disabled (default) |
1180 | # 1 = enabled | |
1181 | # | |
1182 | # proactive_key_caching: | |
1183 | # Enable/disable opportunistic PMKSA caching for WPA2. | |
6e202021 | 1184 | # 0 = disabled (default unless changed with the global okc parameter) |
6fc6879b JM |
1185 | # 1 = enabled |
1186 | # | |
9083ef13 JM |
1187 | # ft_eap_pmksa_caching: |
1188 | # Whether FT-EAP PMKSA caching is allowed | |
1189 | # 0 = do not try to use PMKSA caching with FT-EAP (default) | |
1190 | # 1 = try to use PMKSA caching with FT-EAP | |
1191 | # This controls whether to try to use PMKSA caching with FT-EAP for the | |
1192 | # FT initial mobility domain association. | |
1193 | #ft_eap_pmksa_caching=0 | |
1194 | # | |
6fc6879b JM |
1195 | # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or |
1196 | # hex without quotation, e.g., 0102030405) | |
1197 | # wep_tx_keyidx: Default WEP key index (TX) (0..3) | |
1198 | # | |
581a8cde JM |
1199 | # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to |
1200 | # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies. | |
1201 | # | |
0e05e878 AW |
1202 | # wpa_deny_ptk0_rekey: Workaround for PTK rekey issues |
1203 | # PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the | |
1204 | # security and stability with some cards. | |
1205 | # To avoid the issues wpa_supplicant can replace those PTK rekeys (including | |
1206 | # EAP reauthentications) with fast reconnects. | |
1f90a49d AW |
1207 | # |
1208 | # Available options: | |
1209 | # 0 = always rekey when configured/instructed (default) | |
1210 | # 1 = only rekey when the local driver is explicitly indicating it can perform | |
1211 | # this operation without issues | |
1212 | # 2 = never allow problematic PTK0 rekeys | |
1213 | # | |
6c33ca9f JM |
1214 | # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used |
1215 | # as the dot11RSNAConfigGroupRekeyTime parameter when operating in | |
f09095d5 | 1216 | # Authenticator role in IBSS, or in AP and mesh modes. |
6c33ca9f | 1217 | # |
6fc6879b JM |
1218 | # Following fields are only used with internal EAP implementation. |
1219 | # eap: space-separated list of accepted EAP methods | |
205d2d1f | 1220 | # MD5 = EAP-MD5 (insecure and does not generate keying material -> |
6fc6879b JM |
1221 | # cannot be used with WPA; to be used as a Phase 2 method |
1222 | # with EAP-PEAP or EAP-TTLS) | |
1223 | # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used | |
1224 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
1225 | # OTP = EAP-OTP (cannot be used separately with WPA; to be used | |
1226 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
1227 | # GTC = EAP-GTC (cannot be used separately with WPA; to be used | |
1228 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
1229 | # TLS = EAP-TLS (client and server certificate) | |
1230 | # PEAP = EAP-PEAP (with tunnelled EAP authentication) | |
1231 | # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 | |
1232 | # authentication) | |
1233 | # If not set, all compiled in methods are allowed. | |
1234 | # | |
1235 | # identity: Identity string for EAP | |
1236 | # This field is also used to configure user NAI for | |
1237 | # EAP-PSK/PAX/SAKE/GPSK. | |
1238 | # anonymous_identity: Anonymous identity string for EAP (to be used as the | |
1239 | # unencrypted identity with EAP types that support different tunnelled | |
e026159a JM |
1240 | # identity, e.g., EAP-TTLS). This field can also be used with |
1241 | # EAP-SIM/AKA/AKA' to store the pseudonym identity. | |
6fc6879b JM |
1242 | # password: Password string for EAP. This field can include either the |
1243 | # plaintext password (using ASCII or hex string) or a NtPasswordHash | |
1244 | # (16-byte MD4 hash of password) in hash:<32 hex digits> format. | |
1245 | # NtPasswordHash can only be used when the password is for MSCHAPv2 or | |
1246 | # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). | |
1247 | # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit | |
1248 | # PSK) is also configured using this field. For EAP-GPSK, this is a | |
0ebb23e3 JM |
1249 | # variable length PSK. ext:<name of external password field> format can |
1250 | # be used to indicate that the password is stored in external storage. | |
6fc6879b JM |
1251 | # ca_cert: File path to CA certificate file (PEM/DER). This file can have one |
1252 | # or more trusted CA certificates. If ca_cert and ca_path are not | |
1253 | # included, server certificate will not be verified. This is insecure and | |
1254 | # a trusted CA certificate should always be configured when using | |
1255 | # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may | |
1256 | # change when wpa_supplicant is run in the background. | |
00468b46 JM |
1257 | # |
1258 | # Alternatively, this can be used to only perform matching of the server | |
1259 | # certificate (SHA-256 hash of the DER encoded X.509 certificate). In | |
1260 | # this case, the possible CA certificates in the server certificate chain | |
1261 | # are ignored and only the server certificate is verified. This is | |
1262 | # configured with the following format: | |
1263 | # hash:://server/sha256/cert_hash_in_hex | |
1264 | # For example: "hash://server/sha256/ | |
1265 | # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a" | |
1266 | # | |
6fc6879b JM |
1267 | # On Windows, trusted CA certificates can be loaded from the system |
1268 | # certificate store by setting this to cert_store://<name>, e.g., | |
1269 | # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". | |
1270 | # Note that when running wpa_supplicant as an application, the user | |
1271 | # certificate store (My user account) is used, whereas computer store | |
1272 | # (Computer account) is used when running wpasvc as a service. | |
1273 | # ca_path: Directory path for CA certificate files (PEM). This path may | |
1274 | # contain multiple CA certificates in OpenSSL format. Common use for this | |
1275 | # is to point to system trusted CA list which is often installed into | |
1276 | # directory like /etc/ssl/certs. If configured, these certificates are | |
1277 | # added to the list of trusted CAs. ca_cert may also be included in that | |
1278 | # case, but it is not required. | |
1279 | # client_cert: File path to client certificate file (PEM/DER) | |
1280 | # Full path should be used since working directory may change when | |
1281 | # wpa_supplicant is run in the background. | |
1282 | # Alternatively, a named configuration blob can be used by setting this | |
1283 | # to blob://<blob name>. | |
1284 | # private_key: File path to client private key file (PEM/DER/PFX) | |
1285 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be | |
1286 | # commented out. Both the private key and certificate will be read from | |
1287 | # the PKCS#12 file in this case. Full path should be used since working | |
1288 | # directory may change when wpa_supplicant is run in the background. | |
1289 | # Windows certificate store can be used by leaving client_cert out and | |
1290 | # configuring private_key in one of the following formats: | |
1291 | # cert://substring_to_match | |
1292 | # hash://certificate_thumbprint_in_hex | |
1293 | # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4" | |
1294 | # Note that when running wpa_supplicant as an application, the user | |
1295 | # certificate store (My user account) is used, whereas computer store | |
1296 | # (Computer account) is used when running wpasvc as a service. | |
1297 | # Alternatively, a named configuration blob can be used by setting this | |
1298 | # to blob://<blob name>. | |
1299 | # private_key_passwd: Password for private key file (if left out, this will be | |
1300 | # asked through control interface) | |
6fc6879b JM |
1301 | # subject_match: Substring to be matched against the subject of the |
1302 | # authentication server certificate. If this string is set, the server | |
205d2d1f | 1303 | # certificate is only accepted if it contains this string in the subject. |
6fc6879b JM |
1304 | # The subject string is in following format: |
1305 | # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com | |
205d2d1f | 1306 | # Note: Since this is a substring match, this cannot be used securely to |
394b5473 | 1307 | # do a suffix match against a possible domain name in the CN entry. For |
cebee30f JM |
1308 | # such a use case, domain_suffix_match or domain_match should be used |
1309 | # instead. | |
6fc6879b JM |
1310 | # altsubject_match: Semicolon separated string of entries to be matched against |
1311 | # the alternative subject name of the authentication server certificate. | |
205d2d1f | 1312 | # If this string is set, the server certificate is only accepted if it |
6fc6879b JM |
1313 | # contains one of the entries in an alternative subject name extension. |
1314 | # altSubjectName string is in following format: TYPE:VALUE | |
1315 | # Example: EMAIL:server@example.com | |
1316 | # Example: DNS:server.example.com;DNS:server2.example.com | |
1317 | # Following types are supported: EMAIL, DNS, URI | |
394b5473 | 1318 | # domain_suffix_match: Constraint for server domain name. If set, this FQDN is |
205d2d1f | 1319 | # used as a suffix match requirement for the AAA server certificate in |
394b5473 JM |
1320 | # SubjectAltName dNSName element(s). If a matching dNSName is found, this |
1321 | # constraint is met. If no dNSName values are present, this constraint is | |
1322 | # matched against SubjectName CN using same suffix match comparison. | |
1323 | # | |
1324 | # Suffix match here means that the host/domain name is compared one label | |
1325 | # at a time starting from the top-level domain and all the labels in | |
1326 | # domain_suffix_match shall be included in the certificate. The | |
1327 | # certificate may include additional sub-level labels in addition to the | |
1328 | # required labels. | |
1329 | # | |
242e8572 JM |
1330 | # More than one match string can be provided by using semicolons to |
1331 | # separate the strings (e.g., example.org;example.com). When multiple | |
1332 | # strings are specified, a match with any one of the values is considered | |
1333 | # a sufficient match for the certificate, i.e., the conditions are ORed | |
1334 | # together. | |
1335 | # | |
394b5473 JM |
1336 | # For example, domain_suffix_match=example.com would match |
1337 | # test.example.com but would not match test-example.com. | |
cebee30f JM |
1338 | # domain_match: Constraint for server domain name |
1339 | # If set, this FQDN is used as a full match requirement for the | |
1340 | # server certificate in SubjectAltName dNSName element(s). If a | |
1341 | # matching dNSName is found, this constraint is met. If no dNSName | |
1342 | # values are present, this constraint is matched against SubjectName CN | |
1343 | # using same full match comparison. This behavior is similar to | |
1344 | # domain_suffix_match, but has the requirement of a full match, i.e., | |
1345 | # no subdomains or wildcard matches are allowed. Case-insensitive | |
1346 | # comparison is used, so "Example.com" matches "example.com", but would | |
1347 | # not match "test.Example.com". | |
242e8572 JM |
1348 | # |
1349 | # More than one match string can be provided by using semicolons to | |
1350 | # separate the strings (e.g., example.org;example.com). When multiple | |
1351 | # strings are specified, a match with any one of the values is considered | |
1352 | # a sufficient match for the certificate, i.e., the conditions are ORed | |
1353 | # together. | |
6fc6879b JM |
1354 | # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters |
1355 | # (string with field-value pairs, e.g., "peapver=0" or | |
1356 | # "peapver=1 peaplabel=1") | |
1357 | # 'peapver' can be used to force which PEAP version (0 or 1) is used. | |
1358 | # 'peaplabel=1' can be used to force new label, "client PEAP encryption", | |
1359 | # to be used during key derivation when PEAPv1 or newer. Most existing | |
1360 | # PEAPv1 implementation seem to be using the old label, "client EAP | |
1361 | # encryption", and wpa_supplicant is now using that as the default value. | |
1362 | # Some servers, e.g., Radiator, may require peaplabel=1 configuration to | |
1363 | # interoperate with PEAPv1; see eap_testing.txt for more details. | |
1364 | # 'peap_outer_success=0' can be used to terminate PEAP authentication on | |
1365 | # tunneled EAP-Success. This is required with some RADIUS servers that | |
1366 | # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g., | |
1367 | # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode) | |
1368 | # include_tls_length=1 can be used to force wpa_supplicant to include | |
1369 | # TLS Message Length field in all TLS messages even if they are not | |
1370 | # fragmented. | |
1371 | # sim_min_num_chal=3 can be used to configure EAP-SIM to require three | |
1372 | # challenges (by default, it accepts 2 or 3) | |
1373 | # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use | |
1374 | # protected result indication. | |
d6888f9e JM |
1375 | # 'crypto_binding' option can be used to control PEAPv0 cryptobinding |
1376 | # behavior: | |
c31a11c9 JM |
1377 | # * 0 = do not use cryptobinding (default) |
1378 | # * 1 = use cryptobinding if server supports it | |
d6888f9e | 1379 | # * 2 = require cryptobinding |
8e6485a1 JM |
1380 | # 'phase2_auth' option can be used to control Phase 2 (i.e., within TLS |
1381 | # tunnel) behavior for PEAP: | |
1382 | # * 0 = do not require Phase 2 authentication | |
1383 | # * 1 = require Phase 2 authentication when client certificate | |
1384 | # (private_key/client_cert) is no used and TLS session resumption was | |
1385 | # not used (default) | |
1386 | # * 2 = require Phase 2 authentication in all cases | |
f855f923 JM |
1387 | # EAP-WSC (WPS) uses following options: pin=<Device Password> or |
1388 | # pbc=1. | |
7f7bfba9 JM |
1389 | # |
1390 | # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be | |
1391 | # used to configure a mode that allows EAP-Success (and EAP-Failure) | |
1392 | # without going through authentication step. Some switches use such | |
1393 | # sequence when forcing the port to be authorized/unauthorized or as a | |
1394 | # fallback option if the authentication server is unreachable. By default, | |
1395 | # wpa_supplicant discards such frames to protect against potential attacks | |
1396 | # by rogue devices, but this option can be used to disable that protection | |
1397 | # for cases where the server/authenticator does not need to be | |
1398 | # authenticated. | |
6fc6879b JM |
1399 | # phase2: Phase2 (inner authentication with TLS tunnel) parameters |
1400 | # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or | |
49fcc32e JM |
1401 | # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be |
1402 | # used to disable MSCHAPv2 password retry in authentication failure cases. | |
9af7361b JM |
1403 | # |
1404 | # TLS-based methods can use the following parameters to control TLS behavior | |
1405 | # (these are normally in the phase1 parameter, but can be used also in the | |
1406 | # phase2 parameter when EAP-TLS is used within the inner tunnel): | |
1407 | # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the | |
1408 | # TLS library, these may be disabled by default to enforce stronger | |
1409 | # security) | |
1410 | # tls_disable_time_checks=1 - ignore certificate validity time (this requests | |
1411 | # the TLS library to accept certificates even if they are not currently | |
1412 | # valid, i.e., have expired or have not yet become valid; this should be | |
1413 | # used only for testing purposes) | |
1414 | # tls_disable_session_ticket=1 - disable TLS Session Ticket extension | |
1415 | # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used | |
1416 | # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS | |
1417 | # as a workaround for broken authentication server implementations unless | |
56dfc493 | 1418 | # EAP workarounds are disabled with eap_workaround=0. |
9af7361b JM |
1419 | # For EAP-FAST, this must be set to 0 (or left unconfigured for the |
1420 | # default value to be used automatically). | |
5650d379 | 1421 | # tls_disable_tlsv1_0=1 - disable use of TLSv1.0 |
cc9c4fec JM |
1422 | # tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows |
1423 | # systemwide TLS policies to be overridden) | |
e9a6f183 DS |
1424 | # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers |
1425 | # that have issues interoperating with updated TLS version) | |
cc9c4fec JM |
1426 | # tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows |
1427 | # systemwide TLS policies to be overridden) | |
e9a6f183 DS |
1428 | # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers |
1429 | # that have issues interoperating with updated TLS version) | |
cc9c4fec JM |
1430 | # tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows |
1431 | # systemwide TLS policies to be overridden) | |
bbbc7e80 JM |
1432 | # tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers |
1433 | # that have issues interoperating with updated TLS version) | |
cc9c4fec | 1434 | # tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default) |
3c108b75 JM |
1435 | # tls_ext_cert_check=0 - No external server certificate validation (default) |
1436 | # tls_ext_cert_check=1 - External server certificate validation enabled; this | |
1437 | # requires an external program doing validation of server certificate | |
1438 | # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control | |
1439 | # interface and report the result of the validation with | |
1440 | # CTRL-RSP_EXT_CERT_CHECK. | |
60ed2f24 JM |
1441 | # tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default) |
1442 | # tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in | |
1443 | # particular when using Suite B with RSA keys of >= 3K (3072) bits | |
566ce69a JM |
1444 | # allow_unsafe_renegotiation=1 - allow connection with a TLS server that does |
1445 | # not support safe renegotiation (RFC 5746); please note that this | |
1446 | # workaround should be only when having to authenticate with an old | |
1447 | # authentication server that cannot be updated to use secure TLS | |
1448 | # implementation. | |
9af7361b | 1449 | # |
6fc6879b JM |
1450 | # Following certificate/private key fields are used in inner Phase2 |
1451 | # authentication when using EAP-TTLS or EAP-PEAP. | |
1452 | # ca_cert2: File path to CA certificate file. This file can have one or more | |
1453 | # trusted CA certificates. If ca_cert2 and ca_path2 are not included, | |
1454 | # server certificate will not be verified. This is insecure and a trusted | |
1455 | # CA certificate should always be configured. | |
1456 | # ca_path2: Directory path for CA certificate files (PEM) | |
1457 | # client_cert2: File path to client certificate file | |
1458 | # private_key2: File path to client private key file | |
1459 | # private_key2_passwd: Password for private key file | |
1460 | # dh_file2: File path to DH/DSA parameters file (in PEM format) | |
1461 | # subject_match2: Substring to be matched against the subject of the | |
394b5473 JM |
1462 | # authentication server certificate. See subject_match for more details. |
1463 | # altsubject_match2: Semicolon separated string of entries to be matched | |
1464 | # against the alternative subject name of the authentication server | |
1465 | # certificate. See altsubject_match documentation for more details. | |
1466 | # domain_suffix_match2: Constraint for server domain name. See | |
1467 | # domain_suffix_match for more details. | |
043de65f | 1468 | # ocsp2: See ocsp for more details. |
6fc6879b | 1469 | # |
68161824 JM |
1470 | # Separate machine credentials can be configured for EAP-TEAP Phase 2 with |
1471 | # "machine_" prefix (e.g., "machine_identity") in the configuration parameters. | |
1472 | # See the parameters without that prefix for more details on the meaning and | |
1473 | # format of each such parameter. | |
1474 | # | |
6fc6879b JM |
1475 | # fragment_size: Maximum EAP fragment size in bytes (default 1398). |
1476 | # This value limits the fragment size for EAP methods that support | |
1477 | # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set | |
1478 | # small enough to make the EAP messages fit in MTU of the network | |
1479 | # interface used for EAPOL. The default value is suitable for most | |
1480 | # cases. | |
1481 | # | |
080585c0 JM |
1482 | # ocsp: Whether to use/require OCSP to check server certificate |
1483 | # 0 = do not use OCSP stapling (TLS certificate status extension) | |
1484 | # 1 = try to use OCSP stapling, but not require response | |
1485 | # 2 = require valid OCSP stapling response | |
d6b536f7 JM |
1486 | # 3 = require valid OCSP stapling response for all not-trusted |
1487 | # certificates in the server certificate chain | |
080585c0 | 1488 | # |
07e2de31 JM |
1489 | # openssl_ciphers: OpenSSL specific cipher configuration |
1490 | # This can be used to override the global openssl_ciphers configuration | |
1491 | # parameter (see above). | |
1492 | # | |
02a8d45a JM |
1493 | # erp: Whether EAP Re-authentication Protocol (ERP) is enabled |
1494 | # | |
6fc6879b JM |
1495 | # EAP-FAST variables: |
1496 | # pac_file: File path for the PAC entries. wpa_supplicant will need to be able | |
1497 | # to create this file and write updates to it when PAC is being | |
1498 | # provisioned or refreshed. Full path to the file should be used since | |
1499 | # working directory may change when wpa_supplicant is run in the | |
1500 | # background. Alternatively, a named configuration blob can be used by | |
1501 | # setting this to blob://<blob name> | |
1502 | # phase1: fast_provisioning option can be used to enable in-line provisioning | |
1503 | # of EAP-FAST credentials (PAC): | |
1504 | # 0 = disabled, | |
1505 | # 1 = allow unauthenticated provisioning, | |
1506 | # 2 = allow authenticated provisioning, | |
1507 | # 3 = allow both unauthenticated and authenticated provisioning | |
1508 | # fast_max_pac_list_len=<num> option can be used to set the maximum | |
1509 | # number of PAC entries to store in a PAC list (default: 10) | |
1510 | # fast_pac_format=binary option can be used to select binary format for | |
2e8c9a27 | 1511 | # storing PAC entries in order to save some space (the default |
6fc6879b JM |
1512 | # text format uses about 2.5 times the size of minimal binary |
1513 | # format) | |
1514 | # | |
1515 | # wpa_supplicant supports number of "EAP workarounds" to work around | |
1516 | # interoperability issues with incorrectly behaving authentication servers. | |
1517 | # These are enabled by default because some of the issues are present in large | |
1518 | # number of authentication servers. Strict EAP conformance mode can be | |
1519 | # configured by disabling workarounds with eap_workaround=0. | |
1520 | ||
aeb408ff JM |
1521 | # update_identifier: PPS MO ID |
1522 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) | |
6311547e JM |
1523 | # |
1524 | # roaming_consortium_selection: Roaming Consortium Selection | |
1525 | # The matching Roaming Consortium OI that was used to generate this | |
1526 | # network profile. | |
aeb408ff | 1527 | |
07f53b8c VT |
1528 | # Station inactivity limit |
1529 | # | |
1530 | # If a station does not send anything in ap_max_inactivity seconds, an | |
1531 | # empty data frame is sent to it in order to verify whether it is | |
1532 | # still in range. If this frame is not ACKed, the station will be | |
1533 | # disassociated and then deauthenticated. This feature is used to | |
1534 | # clear station table of old entries when the STAs move out of the | |
1535 | # range. | |
1536 | # | |
1537 | # The station can associate again with the AP if it is still in range; | |
1538 | # this inactivity poll is just used as a nicer way of verifying | |
1539 | # inactivity; i.e., client will not report broken connection because | |
1540 | # disassociation frame is not sent immediately without first polling | |
1541 | # the STA with a data frame. | |
1542 | # default: 300 (i.e., 5 minutes) | |
1543 | #ap_max_inactivity=300 | |
1544 | ||
fdfb1c8b EL |
1545 | # DTIM period in Beacon intervals for AP mode (default: 2) |
1546 | #dtim_period=2 | |
1547 | ||
18206e02 JM |
1548 | # Beacon interval (default: 100 TU) |
1549 | #beacon_int=100 | |
1550 | ||
b6317b41 LD |
1551 | # WPS in AP mode |
1552 | # 0 = WPS enabled and configured (default) | |
1553 | # 1 = WPS disabled | |
1554 | #wps_disabled=0 | |
1555 | ||
76e20f4f JM |
1556 | # FILS DH Group |
1557 | # 0 = PFS disabled with FILS shared key authentication (default) | |
1558 | # 1-65535 = DH Group to use for FILS PFS | |
1559 | #fils_dh_group=0 | |
1560 | ||
5058f771 JM |
1561 | # DPP PFS |
1562 | # 0: allow PFS to be used or not used (default) | |
1563 | # 1: require PFS to be used (note: not compatible with DPP R1) | |
1564 | # 2: do not allow PFS to be used | |
1565 | #dpp_pfs=0 | |
1566 | ||
148de3e0 JM |
1567 | # DPP Network introduction type |
1568 | # 0: unprotected variant from DPP R1 (default) | |
1569 | # 1: privacy protecting (station Connector encrypted) variant from | |
1570 | # DPP R3 | |
1571 | #dpp_connector_privacy=0 | |
1572 | ||
d36d4209 VJ |
1573 | # Whether beacon protection is enabled |
1574 | # This depends on management frame protection (ieee80211w) being enabled and | |
1575 | # beacon protection support indication from the driver. | |
1576 | # 0 = disabled (default) | |
1577 | # 1 = enabled | |
bc908daa JM |
1578 | #beacon_prot=0 |
1579 | ||
1580 | # OWE DH Group | |
1581 | # 0: use default (19) first and then try all supported groups one by one if AP | |
1582 | # rejects the selected group | |
1583 | # 1-65535: DH Group to use for OWE | |
1584 | # Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are | |
1585 | # currently supported. | |
1586 | #owe_group=0 | |
1587 | ||
1588 | # OWE-only mode (disable transition mode) | |
1589 | # 0: enable transition mode (allow connection to either OWE or open BSS) | |
1590 | # 1 = disable transition mode (allow connection only with OWE) | |
1591 | #owe_only=0 | |
1592 | ||
1593 | # OWE PTK derivation workaround | |
1594 | # Initial OWE implementation used SHA256 when deriving the PTK for all | |
1595 | # OWE groups. This was supposed to change to SHA384 for group 20 and | |
1596 | # SHA512 for group 21. This parameter can be used to enable older | |
1597 | # behavior mainly for testing purposes. There is no impact to group 19 | |
1598 | # behavior, but if enabled, this will make group 20 and 21 cases use | |
1599 | # SHA256-based PTK derivation which will not work with the updated | |
1600 | # OWE implementation on the AP side. | |
1601 | #owe_ptk_workaround=0 | |
1602 | ||
1603 | # Transition Disable indication | |
1604 | # The AP can notify authenticated stations to disable transition mode | |
1605 | # in their network profiles when the network has completed transition | |
1606 | # steps, i.e., once sufficiently large number of APs in the ESS have | |
1607 | # been updated to support the more secure alternative. When this | |
1608 | # indication is used, the stations are expected to automatically | |
1609 | # disable transition mode and less secure security options. This | |
1610 | # includes use of WEP, TKIP (including use of TKIP as the group | |
1611 | # cipher), and connections without PMF. | |
1612 | # Bitmap bits: | |
1613 | # bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK | |
1614 | # and only allow SAE to be used) | |
1615 | # bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK) | |
1616 | # bit 2 (0x04): WPA3-Enterprise (move to requiring PMF) | |
1617 | # bit 3 (0x08): Enhanced Open (disable use of open network; require | |
1618 | # OWE) | |
1619 | ||
9ad010c2 JM |
1620 | # SAE-PK mode |
1621 | # 0: automatic SAE/SAE-PK selection based on password; enable | |
1622 | # transition mode (allow SAE authentication without SAE-PK) | |
1623 | # 1: SAE-PK only (disable transition mode; allow SAE authentication | |
1624 | # only with SAE-PK) | |
1625 | # 2: disable SAE-PK (allow SAE authentication only without SAE-PK) | |
1626 | #sae_pk=0 | |
1c846d64 | 1627 | |
c267753b JM |
1628 | # MAC address policy |
1629 | # 0 = use permanent MAC address | |
1630 | # 1 = use random MAC address for each ESS connection | |
a313d17d | 1631 | # 2 = like 1, but maintain OUI (with local admin bit set) |
c267753b JM |
1632 | #mac_addr=0 |
1633 | ||
c8d22af8 BG |
1634 | # disable_ht: Whether HT (802.11n) should be disabled. |
1635 | # 0 = HT enabled (if AP supports it) | |
1636 | # 1 = HT disabled | |
1637 | # | |
1638 | # disable_ht40: Whether HT-40 (802.11n) should be disabled. | |
1639 | # 0 = HT-40 enabled (if AP supports it) | |
1640 | # 1 = HT-40 disabled | |
1641 | # | |
1642 | # disable_sgi: Whether SGI (short guard interval) should be disabled. | |
1643 | # 0 = SGI enabled (if AP supports it) | |
1644 | # 1 = SGI disabled | |
1645 | # | |
39a5800f PK |
1646 | # disable_ldpc: Whether LDPC should be disabled. |
1647 | # 0 = LDPC enabled (if AP supports it) | |
1648 | # 1 = LDPC disabled | |
1649 | # | |
d41cc8cc JM |
1650 | # ht40_intolerant: Whether 40 MHz intolerant should be indicated. |
1651 | # 0 = 40 MHz tolerant (default) | |
1652 | # 1 = 40 MHz intolerant | |
1653 | # | |
c8d22af8 BG |
1654 | # ht_mcs: Configure allowed MCS rates. |
1655 | # Parsed as an array of bytes, in base-16 (ascii-hex) | |
1656 | # ht_mcs="" // Use all available (default) | |
1657 | # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only | |
1658 | # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only | |
1659 | # | |
1660 | # disable_max_amsdu: Whether MAX_AMSDU should be disabled. | |
1661 | # -1 = Do not make any changes. | |
1662 | # 0 = Enable MAX-AMSDU if hardware supports it. | |
1663 | # 1 = Disable AMSDU | |
1664 | # | |
e74dd0e5 JM |
1665 | # ampdu_factor: Maximum A-MPDU Length Exponent |
1666 | # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009. | |
1667 | # | |
c8d22af8 BG |
1668 | # ampdu_density: Allow overriding AMPDU density configuration. |
1669 | # Treated as hint by the kernel. | |
1670 | # -1 = Do not make any changes. | |
1671 | # 0-3 = Set AMPDU density (aka factor) to specified value. | |
cdeea70f SM |
1672 | # |
1673 | # tx_stbc: Allow overriding STBC support for TX streams | |
1674 | # Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2. | |
1675 | # -1 = Do not make any changes (default) | |
1676 | # 0 = Set if not supported | |
1677 | # 1 = Set if supported | |
1678 | # | |
1679 | # rx_stbc: Allow overriding STBC support for RX streams | |
1680 | # Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2. | |
1681 | # -1 = Do not make any changes (default) | |
1682 | # 0 = Set if not supported | |
1683 | # 1 = Set for support of one spatial stream | |
1684 | # 2 = Set for support of one and two spatial streams | |
1685 | # 3 = Set for support of one, two and three spatial streams | |
c8d22af8 | 1686 | |
e9ee8dc3 JB |
1687 | # disable_vht: Whether VHT should be disabled. |
1688 | # 0 = VHT enabled (if AP supports it) | |
1689 | # 1 = VHT disabled | |
1690 | # | |
1691 | # vht_capa: VHT capabilities to set in the override | |
1692 | # vht_capa_mask: mask of VHT capabilities | |
1693 | # | |
1694 | # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8 | |
1695 | # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8 | |
1696 | # 0: MCS 0-7 | |
1697 | # 1: MCS 0-8 | |
1698 | # 2: MCS 0-9 | |
1699 | # 3: not supported | |
1700 | ||
e5d15e22 JM |
1701 | # disable_eht: Whether EHT should be disabled. |
1702 | # 0 = EHT enabled (if supported) (default) | |
1703 | # 1 = EHT disabled | |
1704 | ||
5abc7823 VN |
1705 | # multi_ap_backhaul_sta: Multi-AP backhaul STA functionality |
1706 | # 0 = normal STA (default) | |
1707 | # 1 = backhaul STA | |
1708 | # A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not | |
1709 | # support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be | |
1710 | # added to a bridge to allow forwarding frames over this backhaul link. | |
1711 | ||
76ca15b7 AN |
1712 | ##### Fast Session Transfer (FST) support ##################################### |
1713 | # | |
1714 | # The options in this section are only available when the build configuration | |
205d2d1f JM |
1715 | # option CONFIG_FST is set while compiling wpa_supplicant. They allow this |
1716 | # interface to be a part of FST setup. | |
76ca15b7 AN |
1717 | # |
1718 | # FST is the transfer of a session from a channel to another channel, in the | |
1719 | # same or different frequency bands. | |
1720 | # | |
205d2d1f | 1721 | # For details, see IEEE Std 802.11ad-2012. |
76ca15b7 AN |
1722 | |
1723 | # Identifier of an FST Group the interface belongs to. | |
1724 | #fst_group_id=bond0 | |
1725 | ||
1726 | # Interface priority within the FST Group. | |
1727 | # Announcing a higher priority for an interface means declaring it more | |
1728 | # preferable for FST switch. | |
1729 | # fst_priority is in 1..255 range with 1 being the lowest priority. | |
1730 | #fst_priority=100 | |
1731 | ||
1732 | # Default LLT value for this interface in milliseconds. The value used in case | |
1733 | # no value provided during session setup. Default is 50 msec. | |
1734 | # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2 | |
1735 | # Transitioning between states). | |
1736 | #fst_llt=100 | |
1737 | ||
ef59f987 AB |
1738 | # BSS Transition Management |
1739 | # disable_btm - Disable BSS transition management in STA | |
1740 | # Set to 0 to enable BSS transition management (default behavior) | |
1741 | # Set to 1 to disable BSS transition management | |
1742 | #disable_btm=0 | |
1743 | ||
e8ff22f4 AAL |
1744 | # Enable EDMG capability in STA/AP mode, default value is false |
1745 | #enable_edmg=1 | |
1746 | ||
1747 | # This value is used to configure the channel bonding feature. | |
1748 | # Default value is 0. | |
1749 | # Relevant only if enable_edmg is true | |
1750 | # In AP mode it defines the EDMG channel to use for AP operation. | |
1751 | # In STA mode it defines the EDMG channel for connection (if supported by AP). | |
1752 | #edmg_channel=9 | |
1753 | ||
6fc6879b JM |
1754 | # Example blocks: |
1755 | ||
1756 | # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers | |
1757 | network={ | |
1758 | ssid="simple" | |
1759 | psk="very secret passphrase" | |
1760 | priority=5 | |
1761 | } | |
1762 | ||
1763 | # Same as previous, but request SSID-specific scanning (for APs that reject | |
1764 | # broadcast SSID) | |
1765 | network={ | |
1766 | ssid="second ssid" | |
1767 | scan_ssid=1 | |
1768 | psk="very secret passphrase" | |
1769 | priority=2 | |
1770 | } | |
1771 | ||
1772 | # Only WPA-PSK is used. Any valid cipher combination is accepted. | |
1773 | network={ | |
1774 | ssid="example" | |
1775 | proto=WPA | |
1776 | key_mgmt=WPA-PSK | |
1777 | pairwise=CCMP TKIP | |
1778 | group=CCMP TKIP WEP104 WEP40 | |
1779 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
1780 | priority=2 | |
1781 | } | |
1782 | ||
581a8cde JM |
1783 | # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying |
1784 | network={ | |
1785 | ssid="example" | |
1786 | proto=WPA | |
1787 | key_mgmt=WPA-PSK | |
1788 | pairwise=TKIP | |
1789 | group=TKIP | |
1790 | psk="not so secure passphrase" | |
1791 | wpa_ptk_rekey=600 | |
1792 | } | |
1793 | ||
6fc6879b JM |
1794 | # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104 |
1795 | # or WEP40 as the group cipher will not be accepted. | |
1796 | network={ | |
1797 | ssid="example" | |
1798 | proto=RSN | |
1799 | key_mgmt=WPA-EAP | |
1800 | pairwise=CCMP TKIP | |
1801 | group=CCMP TKIP | |
1802 | eap=TLS | |
1803 | identity="user@example.com" | |
1804 | ca_cert="/etc/cert/ca.pem" | |
1805 | client_cert="/etc/cert/user.pem" | |
1806 | private_key="/etc/cert/user.prv" | |
1807 | private_key_passwd="password" | |
1808 | priority=1 | |
1809 | } | |
1810 | ||
1811 | # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel | |
1812 | # (e.g., Radiator) | |
1813 | network={ | |
1814 | ssid="example" | |
1815 | key_mgmt=WPA-EAP | |
1816 | eap=PEAP | |
1817 | identity="user@example.com" | |
1818 | password="foobar" | |
1819 | ca_cert="/etc/cert/ca.pem" | |
1820 | phase1="peaplabel=1" | |
1821 | phase2="auth=MSCHAPV2" | |
1822 | priority=10 | |
1823 | } | |
1824 | ||
1825 | # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the | |
1826 | # unencrypted use. Real identity is sent only within an encrypted TLS tunnel. | |
1827 | network={ | |
1828 | ssid="example" | |
1829 | key_mgmt=WPA-EAP | |
1830 | eap=TTLS | |
1831 | identity="user@example.com" | |
1832 | anonymous_identity="anonymous@example.com" | |
1833 | password="foobar" | |
1834 | ca_cert="/etc/cert/ca.pem" | |
1835 | priority=2 | |
1836 | } | |
1837 | ||
1838 | # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted | |
1839 | # use. Real identity is sent only within an encrypted TLS tunnel. | |
1840 | network={ | |
1841 | ssid="example" | |
1842 | key_mgmt=WPA-EAP | |
1843 | eap=TTLS | |
1844 | identity="user@example.com" | |
1845 | anonymous_identity="anonymous@example.com" | |
1846 | password="foobar" | |
1847 | ca_cert="/etc/cert/ca.pem" | |
1848 | phase2="auth=MSCHAPV2" | |
1849 | } | |
1850 | ||
1851 | # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner | |
1852 | # authentication. | |
1853 | network={ | |
1854 | ssid="example" | |
1855 | key_mgmt=WPA-EAP | |
1856 | eap=TTLS | |
1857 | # Phase1 / outer authentication | |
1858 | anonymous_identity="anonymous@example.com" | |
1859 | ca_cert="/etc/cert/ca.pem" | |
1860 | # Phase 2 / inner authentication | |
1861 | phase2="autheap=TLS" | |
1862 | ca_cert2="/etc/cert/ca2.pem" | |
1863 | client_cert2="/etc/cer/user.pem" | |
1864 | private_key2="/etc/cer/user.prv" | |
1865 | private_key2_passwd="password" | |
1866 | priority=2 | |
1867 | } | |
1868 | ||
1869 | # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and | |
1870 | # group cipher. | |
1871 | network={ | |
1872 | ssid="example" | |
1873 | bssid=00:11:22:33:44:55 | |
1874 | proto=WPA RSN | |
1875 | key_mgmt=WPA-PSK WPA-EAP | |
1876 | pairwise=CCMP | |
1877 | group=CCMP | |
1878 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
1879 | } | |
1880 | ||
1881 | # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP | |
1882 | # and all valid ciphers. | |
1883 | network={ | |
1884 | ssid=00010203 | |
1885 | psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f | |
1886 | } | |
1887 | ||
1888 | ||
1889 | # EAP-SIM with a GSM SIM or USIM | |
1890 | network={ | |
1891 | ssid="eap-sim-test" | |
1892 | key_mgmt=WPA-EAP | |
1893 | eap=SIM | |
1894 | pin="1234" | |
1895 | pcsc="" | |
1896 | } | |
1897 | ||
1898 | ||
1899 | # EAP-PSK | |
1900 | network={ | |
1901 | ssid="eap-psk-test" | |
1902 | key_mgmt=WPA-EAP | |
1903 | eap=PSK | |
1904 | anonymous_identity="eap_psk_user" | |
1905 | password=06b4be19da289f475aa46a33cb793029 | |
1906 | identity="eap_psk_user@example.com" | |
1907 | } | |
1908 | ||
1909 | ||
1910 | # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using | |
1911 | # EAP-TLS for authentication and key generation; require both unicast and | |
1912 | # broadcast WEP keys. | |
1913 | network={ | |
1914 | ssid="1x-test" | |
1915 | key_mgmt=IEEE8021X | |
1916 | eap=TLS | |
1917 | identity="user@example.com" | |
1918 | ca_cert="/etc/cert/ca.pem" | |
1919 | client_cert="/etc/cert/user.pem" | |
1920 | private_key="/etc/cert/user.prv" | |
1921 | private_key_passwd="password" | |
1922 | eapol_flags=3 | |
1923 | } | |
1924 | ||
1925 | ||
1926 | # LEAP with dynamic WEP keys | |
1927 | network={ | |
1928 | ssid="leap-example" | |
1929 | key_mgmt=IEEE8021X | |
1930 | eap=LEAP | |
1931 | identity="user" | |
1932 | password="foobar" | |
1933 | } | |
1934 | ||
1935 | # EAP-IKEv2 using shared secrets for both server and peer authentication | |
1936 | network={ | |
1937 | ssid="ikev2-example" | |
1938 | key_mgmt=WPA-EAP | |
1939 | eap=IKEV2 | |
1940 | identity="user" | |
1941 | password="foobar" | |
1942 | } | |
1943 | ||
1944 | # EAP-FAST with WPA (WPA or WPA2) | |
1945 | network={ | |
1946 | ssid="eap-fast-test" | |
1947 | key_mgmt=WPA-EAP | |
1948 | eap=FAST | |
1949 | anonymous_identity="FAST-000102030405" | |
1950 | identity="username" | |
1951 | password="password" | |
1952 | phase1="fast_provisioning=1" | |
1953 | pac_file="/etc/wpa_supplicant.eap-fast-pac" | |
1954 | } | |
1955 | ||
1956 | network={ | |
1957 | ssid="eap-fast-test" | |
1958 | key_mgmt=WPA-EAP | |
1959 | eap=FAST | |
1960 | anonymous_identity="FAST-000102030405" | |
1961 | identity="username" | |
1962 | password="password" | |
1963 | phase1="fast_provisioning=1" | |
1964 | pac_file="blob://eap-fast-pac" | |
1965 | } | |
1966 | ||
1967 | # Plaintext connection (no WPA, no IEEE 802.1X) | |
1968 | network={ | |
1969 | ssid="plaintext-test" | |
1970 | key_mgmt=NONE | |
1971 | } | |
1972 | ||
1973 | ||
1974 | # Shared WEP key connection (no WPA, no IEEE 802.1X) | |
1975 | network={ | |
1976 | ssid="static-wep-test" | |
1977 | key_mgmt=NONE | |
1978 | wep_key0="abcde" | |
1979 | wep_key1=0102030405 | |
1980 | wep_key2="1234567890123" | |
1981 | wep_tx_keyidx=0 | |
1982 | priority=5 | |
1983 | } | |
1984 | ||
1985 | ||
1986 | # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key | |
1987 | # IEEE 802.11 authentication | |
1988 | network={ | |
1989 | ssid="static-wep-test2" | |
1990 | key_mgmt=NONE | |
1991 | wep_key0="abcde" | |
1992 | wep_key1=0102030405 | |
1993 | wep_key2="1234567890123" | |
1994 | wep_tx_keyidx=0 | |
1995 | priority=5 | |
1996 | auth_alg=SHARED | |
1997 | } | |
1998 | ||
1999 | ||
b2838baf JM |
2000 | # IBSS/ad-hoc network with RSN |
2001 | network={ | |
2002 | ssid="ibss-rsn" | |
2003 | key_mgmt=WPA-PSK | |
2004 | proto=RSN | |
2005 | psk="12345678" | |
2006 | mode=1 | |
2007 | frequency=2412 | |
2008 | pairwise=CCMP | |
2009 | group=CCMP | |
2010 | } | |
2011 | ||
2012 | # IBSS/ad-hoc network with WPA-None/TKIP (deprecated) | |
6fc6879b JM |
2013 | network={ |
2014 | ssid="test adhoc" | |
2015 | mode=1 | |
2016 | frequency=2412 | |
2017 | proto=WPA | |
2018 | key_mgmt=WPA-NONE | |
2019 | pairwise=NONE | |
2020 | group=TKIP | |
2021 | psk="secret passphrase" | |
9e5e03d7 TP |
2022 | } |
2023 | ||
2024 | # open mesh network | |
2025 | network={ | |
2026 | ssid="test mesh" | |
2027 | mode=5 | |
2028 | frequency=2437 | |
2029 | key_mgmt=NONE | |
2030 | } | |
2031 | ||
2032 | # secure (SAE + AMPE) network | |
2033 | network={ | |
2034 | ssid="secure mesh" | |
2035 | mode=5 | |
2036 | frequency=2437 | |
2037 | key_mgmt=SAE | |
2038 | psk="very secret passphrase" | |
6fc6879b JM |
2039 | } |
2040 | ||
2041 | ||
2042 | # Catch all example that allows more or less all configuration modes | |
2043 | network={ | |
2044 | ssid="example" | |
2045 | scan_ssid=1 | |
2046 | key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE | |
2047 | pairwise=CCMP TKIP | |
2048 | group=CCMP TKIP WEP104 WEP40 | |
2049 | psk="very secret passphrase" | |
2050 | eap=TTLS PEAP TLS | |
2051 | identity="user@example.com" | |
2052 | password="foobar" | |
2053 | ca_cert="/etc/cert/ca.pem" | |
2054 | client_cert="/etc/cert/user.pem" | |
2055 | private_key="/etc/cert/user.prv" | |
2056 | private_key_passwd="password" | |
2057 | phase1="peaplabel=0" | |
2058 | } | |
2059 | ||
2060 | # Example of EAP-TLS with smartcard (openssl engine) | |
2061 | network={ | |
2062 | ssid="example" | |
2063 | key_mgmt=WPA-EAP | |
2064 | eap=TLS | |
2065 | proto=RSN | |
2066 | pairwise=CCMP TKIP | |
2067 | group=CCMP TKIP | |
2068 | identity="user@example.com" | |
2069 | ca_cert="/etc/cert/ca.pem" | |
6fc6879b | 2070 | |
f7cb6e9f DW |
2071 | # Certificate and/or key identified by PKCS#11 URI (RFC7512) |
2072 | client_cert="pkcs11:manufacturer=piv_II;id=%01" | |
2073 | private_key="pkcs11:manufacturer=piv_II;id=%01" | |
6fc6879b JM |
2074 | |
2075 | # Optional PIN configuration; this can be left out and PIN will be | |
2076 | # asked through the control interface | |
2077 | pin="1234" | |
2078 | } | |
2079 | ||
2080 | # Example configuration showing how to use an inlined blob as a CA certificate | |
2081 | # data instead of using external file | |
2082 | network={ | |
2083 | ssid="example" | |
2084 | key_mgmt=WPA-EAP | |
2085 | eap=TTLS | |
2086 | identity="user@example.com" | |
2087 | anonymous_identity="anonymous@example.com" | |
2088 | password="foobar" | |
2089 | ca_cert="blob://exampleblob" | |
2090 | priority=20 | |
2091 | } | |
2092 | ||
2093 | blob-base64-exampleblob={ | |
2094 | SGVsbG8gV29ybGQhCg== | |
2095 | } | |
2096 | ||
2097 | ||
2098 | # Wildcard match for SSID (plaintext APs only). This example select any | |
2099 | # open AP regardless of its SSID. | |
2100 | network={ | |
2101 | key_mgmt=NONE | |
2102 | } | |
f5ffc348 | 2103 | |
752b1c60 | 2104 | # Example configuration ignoring two APs - these will be ignored |
b83e4554 ST |
2105 | # for this network. |
2106 | network={ | |
2107 | ssid="example" | |
2108 | psk="very secret passphrase" | |
752b1c60 | 2109 | bssid_ignore=02:11:22:33:44:55 02:22:aa:44:55:66 |
b83e4554 ST |
2110 | } |
2111 | ||
2112 | # Example configuration limiting AP selection to a specific set of APs; | |
79cd993a | 2113 | # any other AP not matching the masked address will be ignored. |
b83e4554 ST |
2114 | network={ |
2115 | ssid="example" | |
2116 | psk="very secret passphrase" | |
752b1c60 | 2117 | bssid_accept=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff |
b83e4554 | 2118 | } |
f5ffc348 BG |
2119 | |
2120 | # Example config file that will only scan on channel 36. | |
2121 | freq_list=5180 | |
2122 | network={ | |
2123 | key_mgmt=NONE | |
2124 | } | |
dd10abcc HW |
2125 | |
2126 | ||
208263c0 JK |
2127 | # Example configuration using EAP-TTLS for authentication and key |
2128 | # generation for MACsec | |
2129 | network={ | |
2130 | key_mgmt=IEEE8021X | |
2131 | eap=TTLS | |
2132 | phase2="auth=PAP" | |
2133 | anonymous_identity="anonymous@example.com" | |
2134 | identity="user@example.com" | |
2135 | password="secretr" | |
2136 | ca_cert="/etc/cert/ca.pem" | |
2137 | eapol_flags=0 | |
2138 | macsec_policy=1 | |
2139 | } | |
2140 | ||
2141 | # Example configuration for MACsec with preshared key | |
2142 | network={ | |
2143 | key_mgmt=NONE | |
2144 | eapol_flags=0 | |
2145 | macsec_policy=1 | |
2146 | mka_cak=0123456789ABCDEF0123456789ABCDEF | |
2147 | mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435 | |
2148 | mka_priority=128 | |
2149 | } |