]>
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) | |
6fc6879b JM |
97 | # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association |
98 | # parameters (e.g., WPA IE generation); this mode can also be used with | |
99 | # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with | |
100 | # APs (i.e., external program needs to control association). This mode must | |
ba5ea116 | 101 | # also be used when using wired Ethernet drivers (including MACsec). |
6fc6879b JM |
102 | # 2: like 0, but associate with APs using security policy and SSID (but not |
103 | # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to | |
104 | # enable operation with hidden SSIDs and optimized roaming; in this mode, | |
105 | # the network blocks in the configuration file are tried one by one until | |
106 | # the driver reports successful association; each network block should have | |
107 | # explicit security policy (i.e., only one option in the lists) for | |
108 | # key_mgmt, pairwise, group, proto variables | |
8406cd35 JM |
109 | # Note: ap_scan=2 should not be used with the nl80211 driver interface (the |
110 | # current Linux interface). ap_scan=1 is optimized work working with nl80211. | |
111 | # For finding networks using hidden SSID, scan_ssid=1 in the network block can | |
112 | # be used with nl80211. | |
b55aaa5f JM |
113 | # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be |
114 | # created immediately regardless of scan results. ap_scan=1 mode will first try | |
115 | # to scan for existing networks and only if no matches with the enabled | |
116 | # networks are found, a new IBSS or AP mode network is created. | |
6fc6879b JM |
117 | ap_scan=1 |
118 | ||
5b75ecea BG |
119 | # Whether to force passive scan for network connection |
120 | # | |
121 | # By default, scans will send out Probe Request frames on channels that allow | |
122 | # active scanning. This advertise the local station to the world. Normally this | |
123 | # is fine, but users may wish to do passive scanning where the radio should only | |
124 | # listen quietly for Beacon frames and not send any Probe Request frames. Actual | |
125 | # functionality may be driver dependent. | |
126 | # | |
127 | # This parameter can be used to force only passive scanning to be used | |
128 | # for network connection cases. It should be noted that this will slow | |
129 | # down scan operations and reduce likelihood of finding the AP. In | |
130 | # addition, some use cases will override this due to functional | |
131 | # requirements, e.g., for finding an AP that uses hidden SSID | |
132 | # (scan_ssid=1) or P2P device discovery. | |
133 | # | |
134 | # 0: Do normal scans (allow active scans) (default) | |
135 | # 1: Do passive scans. | |
136 | #passive_scan=0 | |
137 | ||
e45e8989 TP |
138 | # MPM residency |
139 | # By default, wpa_supplicant implements the mesh peering manager (MPM) for an | |
140 | # open mesh. However, if the driver can implement the MPM, you may set this to | |
141 | # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is | |
142 | # always used. | |
143 | # 0: MPM lives in the driver | |
144 | # 1: wpa_supplicant provides an MPM which handles peering (default) | |
145 | #user_mpm=1 | |
146 | ||
4b409368 MH |
147 | # Maximum number of peer links (0-255; default: 99) |
148 | # Maximum number of mesh peering currently maintained by the STA. | |
149 | #max_peer_links=99 | |
150 | ||
5a2a6de6 MH |
151 | # Timeout in seconds to detect STA inactivity (default: 300 seconds) |
152 | # | |
153 | # This timeout value is used in mesh STA to clean up inactive stations. | |
154 | #mesh_max_inactivity=300 | |
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 | |
186 | # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default. | |
187 | # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation | |
188 | # on cipher suite configuration. This is applicable only if wpa_supplicant is | |
189 | # built to use OpenSSL. | |
190 | #openssl_ciphers=DEFAULT:!EXP:!LOW | |
191 | ||
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 | |
71dd3b78 AS |
285 | # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing |
286 | # The vendor attribute contents to be added in M1 (hex string) | |
287 | #wps_vendor_ext_m1=000137100100020001 | |
288 | ||
51ca03f4 JM |
289 | # NFC password token for WPS |
290 | # These parameters can be used to configure a fixed NFC password token for the | |
291 | # station. This can be generated, e.g., with nfc_pw_token. When these | |
292 | # parameters are used, the station is assumed to be deployed with a NFC tag | |
293 | # that includes the matching NFC password token (e.g., written based on the | |
294 | # NDEF record from nfc_pw_token). | |
295 | # | |
296 | #wps_nfc_dev_pw_id: Device Password ID (16..65535) | |
297 | #wps_nfc_dh_pubkey: Hexdump of DH Public Key | |
298 | #wps_nfc_dh_privkey: Hexdump of DH Private Key | |
299 | #wps_nfc_dev_pw: Hexdump of Device Password | |
300 | ||
94687a0a SD |
301 | # Priority for the networks added through WPS |
302 | # This priority value will be set to each network profile that is added | |
303 | # by executing the WPS protocol. | |
304 | #wps_priority=0 | |
305 | ||
c9c38b09 JM |
306 | # Maximum number of BSS entries to keep in memory |
307 | # Default: 200 | |
308 | # This can be used to limit memory use on the BSS entries (cached scan | |
309 | # results). A larger value may be needed in environments that have huge number | |
310 | # of APs when using ap_scan=1 mode. | |
311 | #bss_max_count=200 | |
312 | ||
b0786fba TB |
313 | # Automatic scan |
314 | # This is an optional set of parameters for automatic scanning | |
315 | # within an interface in following format: | |
316 | #autoscan=<autoscan module name>:<module parameters> | |
65015b2d JM |
317 | # autoscan is like bgscan but on disconnected or inactive state. |
318 | # For instance, on exponential module parameters would be <base>:<limit> | |
c0fba2b3 TB |
319 | #autoscan=exponential:3:300 |
320 | # Which means a delay between scans on a base exponential of 3, | |
65015b2d JM |
321 | # up to the limit of 300 seconds (3, 9, 27 ... 300) |
322 | # For periodic module, parameters would be <fixed interval> | |
e3659c89 | 323 | #autoscan=periodic:30 |
32c02261 AS |
324 | # So a delay of 30 seconds will be applied between each scan. |
325 | # Note: If sched_scan_plans are configured and supported by the driver, | |
326 | # autoscan is ignored. | |
c9c38b09 | 327 | |
3812464c JM |
328 | # filter_ssids - SSID-based scan result filtering |
329 | # 0 = do not filter scan results (default) | |
330 | # 1 = only include configured SSIDs in scan results/BSS table | |
331 | #filter_ssids=0 | |
332 | ||
306ae225 JM |
333 | # Password (and passphrase, etc.) backend for external storage |
334 | # format: <backend name>[:<optional backend parameters>] | |
335 | #ext_password_backend=test:pw1=password|pw2=testing | |
336 | ||
579674eb BG |
337 | |
338 | # Disable P2P functionality | |
339 | # p2p_disabled=1 | |
340 | ||
462a7439 ES |
341 | # Timeout in seconds to detect STA inactivity (default: 300 seconds) |
342 | # | |
343 | # This timeout value is used in P2P GO mode to clean up | |
344 | # inactive stations. | |
345 | #p2p_go_max_inactivity=300 | |
346 | ||
1b928f96 JM |
347 | # Passphrase length (8..63) for P2P GO |
348 | # | |
349 | # This parameter controls the length of the random passphrase that is | |
350 | # generated at the GO. Default: 8. | |
351 | #p2p_passphrase_len=8 | |
352 | ||
d3b20469 NS |
353 | # Extra delay between concurrent P2P search iterations |
354 | # | |
355 | # This value adds extra delay in milliseconds between concurrent search | |
356 | # iterations to make p2p_find friendlier to concurrent operations by avoiding | |
357 | # it from taking 100% of radio resources. The default value is 500 ms. | |
358 | #p2p_search_delay=500 | |
359 | ||
6e202021 JM |
360 | # Opportunistic Key Caching (also known as Proactive Key Caching) default |
361 | # This parameter can be used to set the default behavior for the | |
362 | # proactive_key_caching parameter. By default, OKC is disabled unless enabled | |
363 | # with the global okc=1 parameter or with the per-network | |
364 | # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but | |
365 | # can be disabled with per-network proactive_key_caching=0 parameter. | |
366 | #okc=0 | |
3812464c | 367 | |
62d49803 JM |
368 | # Protected Management Frames default |
369 | # This parameter can be used to set the default behavior for the ieee80211w | |
22950049 JM |
370 | # parameter for RSN networks. By default, PMF is disabled unless enabled with |
371 | # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter. | |
372 | # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the | |
373 | # per-network ieee80211w parameter. This global default value does not apply | |
374 | # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using | |
375 | # RSN. | |
62d49803 JM |
376 | #pmf=0 |
377 | ||
625f202a JM |
378 | # Enabled SAE finite cyclic groups in preference order |
379 | # By default (if this parameter is not set), the mandatory group 19 (ECC group | |
380 | # defined over a 256-bit prime order field) is preferred, but other groups are | |
381 | # also enabled. If this parameter is set, the groups will be tried in the | |
382 | # indicated order. The group values are listed in the IANA registry: | |
383 | # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9 | |
384 | #sae_groups=21 20 19 26 25 | |
385 | ||
18206e02 JM |
386 | # Default value for DTIM period (if not overridden in network block) |
387 | #dtim_period=2 | |
388 | ||
389 | # Default value for Beacon interval (if not overridden in network block) | |
390 | #beacon_int=100 | |
391 | ||
18a2eaab JM |
392 | # Additional vendor specific elements for Beacon and Probe Response frames |
393 | # This parameter can be used to add additional vendor specific element(s) into | |
394 | # the end of the Beacon and Probe Response frames. The format for these | |
395 | # element(s) is a hexdump of the raw information elements (id+len+payload for | |
396 | # one or more elements). This is used in AP and P2P GO modes. | |
397 | #ap_vendor_elements=dd0411223301 | |
398 | ||
4342326f JM |
399 | # Ignore scan results older than request |
400 | # | |
401 | # The driver may have a cache of scan results that makes it return | |
402 | # information that is older than our scan trigger. This parameter can | |
403 | # be used to configure such old information to be ignored instead of | |
404 | # allowing it to update the internal BSS table. | |
405 | #ignore_old_scan_res=0 | |
406 | ||
6124e858 BG |
407 | # scan_cur_freq: Whether to scan only the current frequency |
408 | # 0: Scan all available frequencies. (Default) | |
409 | # 1: Scan current operating frequency if another VIF on the same radio | |
410 | # is already associated. | |
4342326f | 411 | |
c267753b JM |
412 | # MAC address policy default |
413 | # 0 = use permanent MAC address | |
414 | # 1 = use random MAC address for each ESS connection | |
a313d17d | 415 | # 2 = like 1, but maintain OUI (with local admin bit set) |
c267753b JM |
416 | # |
417 | # By default, permanent MAC address is used unless policy is changed by | |
418 | # the per-network mac_addr parameter. Global mac_addr=1 can be used to | |
419 | # change this default behavior. | |
420 | #mac_addr=0 | |
421 | ||
422 | # Lifetime of random MAC address in seconds (default: 60) | |
423 | #rand_addr_lifetime=60 | |
424 | ||
425 | # MAC address policy for pre-association operations (scanning, ANQP) | |
426 | # 0 = use permanent MAC address | |
427 | # 1 = use random MAC address | |
a313d17d | 428 | # 2 = like 1, but maintain OUI (with local admin bit set) |
c267753b JM |
429 | #preassoc_mac_addr=0 |
430 | ||
1d9d21f3 VK |
431 | # MAC address policy for GAS operations |
432 | # 0 = use permanent MAC address | |
433 | # 1 = use random MAC address | |
434 | # 2 = like 1, but maintain OUI (with local admin bit set) | |
435 | #gas_rand_mac_addr=0 | |
436 | ||
437 | # Lifetime of GAS random MAC address in seconds (default: 60) | |
438 | #gas_rand_addr_lifetime=60 | |
439 | ||
46ee0427 JM |
440 | # Interworking (IEEE 802.11u) |
441 | ||
442 | # Enable Interworking | |
443 | # interworking=1 | |
444 | ||
445 | # Homogenous ESS identifier | |
446 | # If this is set, scans will be used to request response only from BSSes | |
447 | # belonging to the specified Homogeneous ESS. This is used only if interworking | |
448 | # is enabled. | |
449 | # hessid=00:11:22:33:44:55 | |
450 | ||
4d5bda5f JM |
451 | # Automatic network selection behavior |
452 | # 0 = do not automatically go through Interworking network selection | |
453 | # (i.e., require explicit interworking_select command for this; default) | |
454 | # 1 = perform Interworking network selection if one or more | |
455 | # credentials have been configured and scan did not find a | |
456 | # matching network block | |
457 | #auto_interworking=0 | |
458 | ||
c86bef29 JM |
459 | # GAS Address3 field behavior |
460 | # 0 = P2P specification (Address3 = AP BSSID); default | |
461 | # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when | |
462 | # sent to not-associated AP; if associated, AP BSSID) | |
463 | #gas_address3=0 | |
464 | ||
d1723c55 LD |
465 | # Publish fine timing measurement (FTM) responder functionality in |
466 | # the Extended Capabilities element bit 70. | |
467 | # Controls whether FTM responder functionality will be published by AP/STA. | |
468 | # Note that actual FTM responder operation is managed outside wpa_supplicant. | |
469 | # 0 = Do not publish; default | |
470 | # 1 = Publish | |
471 | #ftm_responder=0 | |
472 | ||
473 | # Publish fine timing measurement (FTM) initiator functionality in | |
474 | # the Extended Capabilities element bit 71. | |
475 | # Controls whether FTM initiator functionality will be published by AP/STA. | |
476 | # Note that actual FTM initiator operation is managed outside wpa_supplicant. | |
477 | # 0 = Do not publish; default | |
478 | # 1 = Publish | |
479 | #ftm_initiator=0 | |
480 | ||
400020cb JM |
481 | # credential block |
482 | # | |
483 | # Each credential used for automatic network selection is configured as a set | |
484 | # of parameters that are compared to the information advertised by the APs when | |
485 | # interworking_select and interworking_connect commands are used. | |
486 | # | |
487 | # credential fields: | |
488 | # | |
03ed3324 JM |
489 | # temporary: Whether this credential is temporary and not to be saved |
490 | # | |
400020cb JM |
491 | # priority: Priority group |
492 | # By default, all networks and credentials get the same priority group | |
493 | # (0). This field can be used to give higher priority for credentials | |
494 | # (and similarly in struct wpa_ssid for network blocks) to change the | |
495 | # Interworking automatic networking selection behavior. The matching | |
496 | # network (based on either an enabled network block or a credential) | |
497 | # with the highest priority value will be selected. | |
498 | # | |
d7b01abd JM |
499 | # pcsc: Use PC/SC and SIM/USIM card |
500 | # | |
400020cb JM |
501 | # realm: Home Realm for Interworking |
502 | # | |
503 | # username: Username for Interworking network selection | |
504 | # | |
505 | # password: Password for Interworking network selection | |
506 | # | |
507 | # ca_cert: CA certificate for Interworking network selection | |
508 | # | |
509 | # client_cert: File path to client certificate file (PEM/DER) | |
510 | # This field is used with Interworking networking selection for a case | |
511 | # where client certificate/private key is used for authentication | |
512 | # (EAP-TLS). Full path to the file should be used since working | |
513 | # directory may change when wpa_supplicant is run in the background. | |
514 | # | |
f7cb6e9f DW |
515 | # Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI. |
516 | # | |
517 | # For example: private_key="pkcs11:manufacturer=piv_II;id=%01" | |
518 | # | |
400020cb JM |
519 | # Alternatively, a named configuration blob can be used by setting |
520 | # this to blob://blob_name. | |
521 | # | |
522 | # private_key: File path to client private key file (PEM/DER/PFX) | |
523 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be | |
524 | # commented out. Both the private key and certificate will be read | |
525 | # from the PKCS#12 file in this case. Full path to the file should be | |
526 | # used since working directory may change when wpa_supplicant is run | |
527 | # in the background. | |
528 | # | |
f7cb6e9f DW |
529 | # Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI. |
530 | # For example: private_key="pkcs11:manufacturer=piv_II;id=%01" | |
531 | # | |
400020cb JM |
532 | # Windows certificate store can be used by leaving client_cert out and |
533 | # configuring private_key in one of the following formats: | |
534 | # | |
535 | # cert://substring_to_match | |
536 | # | |
537 | # hash://certificate_thumbprint_in_hex | |
538 | # | |
539 | # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4" | |
540 | # | |
541 | # Note that when running wpa_supplicant as an application, the user | |
542 | # certificate store (My user account) is used, whereas computer store | |
543 | # (Computer account) is used when running wpasvc as a service. | |
544 | # | |
545 | # Alternatively, a named configuration blob can be used by setting | |
546 | # this to blob://blob_name. | |
547 | # | |
548 | # private_key_passwd: Password for private key file | |
549 | # | |
550 | # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format | |
551 | # | |
552 | # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN> | |
553 | # format | |
554 | # | |
463c8ffb | 555 | # domain: Home service provider FQDN(s) |
400020cb | 556 | # This is used to compare against the Domain Name List to figure out |
463c8ffb JM |
557 | # whether the AP is operated by the Home SP. Multiple domain entries can |
558 | # be used to configure alternative FQDNs that will be considered home | |
559 | # networks. | |
400020cb | 560 | # |
955567bc JM |
561 | # roaming_consortium: Roaming Consortium OI |
562 | # If roaming_consortium_len is non-zero, this field contains the | |
563 | # Roaming Consortium OI that can be used to determine which access | |
564 | # points support authentication with this credential. This is an | |
565 | # alternative to the use of the realm parameter. When using Roaming | |
566 | # Consortium to match the network, the EAP parameters need to be | |
567 | # pre-configured with the credential since the NAI Realm information | |
568 | # may not be available or fetched. | |
569 | # | |
8ca93c59 JM |
570 | # eap: Pre-configured EAP method |
571 | # This optional field can be used to specify which EAP method will be | |
572 | # used with this credential. If not set, the EAP method is selected | |
573 | # automatically based on ANQP information (e.g., NAI Realm). | |
574 | # | |
575 | # phase1: Pre-configure Phase 1 (outer authentication) parameters | |
576 | # This optional field is used with like the 'eap' parameter. | |
577 | # | |
578 | # phase2: Pre-configure Phase 2 (inner authentication) parameters | |
579 | # This optional field is used with like the 'eap' parameter. | |
580 | # | |
dbea8ac7 JM |
581 | # excluded_ssid: Excluded SSID |
582 | # This optional field can be used to excluded specific SSID(s) from | |
583 | # matching with the network. Multiple entries can be used to specify more | |
584 | # than one SSID. | |
585 | # | |
bc00053c JM |
586 | # roaming_partner: Roaming partner information |
587 | # This optional field can be used to configure preferences between roaming | |
588 | # partners. The field is a string in following format: | |
589 | # <FQDN>,<0/1 exact match>,<priority>,<* or country code> | |
590 | # (non-exact match means any subdomain matches the entry; priority is in | |
591 | # 0..255 range with 0 being the highest priority) | |
592 | # | |
f9cd147d JM |
593 | # update_identifier: PPS MO ID |
594 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) | |
595 | # | |
aa26ba68 JM |
596 | # provisioning_sp: FQDN of the SP that provisioned the credential |
597 | # This optional field can be used to keep track of the SP that provisioned | |
598 | # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>). | |
599 | # | |
4cad9df1 JM |
600 | # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*) |
601 | # These fields can be used to specify minimum download/upload backhaul | |
602 | # bandwidth that is preferred for the credential. This constraint is | |
603 | # ignored if the AP does not advertise WAN Metrics information or if the | |
604 | # limit would prevent any connection. Values are in kilobits per second. | |
605 | # min_dl_bandwidth_home | |
606 | # min_ul_bandwidth_home | |
607 | # min_dl_bandwidth_roaming | |
608 | # min_ul_bandwidth_roaming | |
609 | # | |
a45b2dc5 JM |
610 | # max_bss_load: Maximum BSS Load Channel Utilization (1..255) |
611 | # (PPS/<X+>/Policy/MaximumBSSLoadValue) | |
612 | # This value is used as the maximum channel utilization for network | |
613 | # selection purposes for home networks. If the AP does not advertise | |
614 | # BSS Load or if the limit would prevent any connection, this constraint | |
615 | # will be ignored. | |
616 | # | |
33fb8c52 JM |
617 | # req_conn_capab: Required connection capability |
618 | # (PPS/<X+>/Policy/RequiredProtoPortTuple) | |
619 | # This value is used to configure set of required protocol/port pairs that | |
620 | # a roaming network shall support (include explicitly in Connection | |
621 | # Capability ANQP element). This constraint is ignored if the AP does not | |
622 | # advertise Connection Capability or if this constraint would prevent any | |
623 | # network connection. This policy is not used in home networks. | |
624 | # Format: <protocol>[:<comma-separated list of ports] | |
625 | # Multiple entries can be used to list multiple requirements. | |
626 | # For example, number of common TCP protocols: | |
627 | # req_conn_capab=6,22,80,443 | |
628 | # For example, IPSec/IKE: | |
629 | # req_conn_capab=17:500 | |
630 | # req_conn_capab=50 | |
631 | # | |
cf6d08a6 JM |
632 | # ocsp: Whether to use/require OCSP to check server certificate |
633 | # 0 = do not use OCSP stapling (TLS certificate status extension) | |
634 | # 1 = try to use OCSP stapling, but not require response | |
635 | # 2 = require valid OCSP stapling response | |
d6b536f7 JM |
636 | # 3 = require valid OCSP stapling response for all not-trusted |
637 | # certificates in the server certificate chain | |
cf6d08a6 | 638 | # |
13f6a07e NJ |
639 | # sim_num: Identifier for which SIM to use in multi-SIM devices |
640 | # | |
400020cb JM |
641 | # for example: |
642 | # | |
643 | #cred={ | |
644 | # realm="example.com" | |
645 | # username="user@example.com" | |
646 | # password="password" | |
647 | # ca_cert="/etc/wpa_supplicant/ca.pem" | |
648 | # domain="example.com" | |
649 | #} | |
650 | # | |
651 | #cred={ | |
652 | # imsi="310026-000000000" | |
817bb3e1 | 653 | # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82" |
400020cb | 654 | #} |
955567bc JM |
655 | # |
656 | #cred={ | |
657 | # realm="example.com" | |
658 | # username="user" | |
659 | # password="password" | |
660 | # ca_cert="/etc/wpa_supplicant/ca.pem" | |
661 | # domain="example.com" | |
662 | # roaming_consortium=223344 | |
663 | # eap=TTLS | |
664 | # phase2="auth=MSCHAPV2" | |
665 | #} | |
2a4b98a9 | 666 | |
66aadbd7 JK |
667 | # Hotspot 2.0 |
668 | # hs20=1 | |
669 | ||
32c02261 AS |
670 | # Scheduled scan plans |
671 | # | |
672 | # A space delimited list of scan plans. Each scan plan specifies the scan | |
673 | # interval and number of iterations, delimited by a colon. The last scan plan | |
674 | # will run infinitely and thus must specify only the interval and not the number | |
675 | # of iterations. | |
676 | # | |
677 | # The driver advertises the maximum number of scan plans supported. If more scan | |
678 | # plans than supported are configured, only the first ones are set (up to the | |
679 | # maximum supported). The last scan plan that specifies only the interval is | |
680 | # always set as the last plan. | |
681 | # | |
682 | # If the scan interval or the number of iterations for a scan plan exceeds the | |
683 | # maximum supported, it will be set to the maximum supported value. | |
684 | # | |
685 | # Format: | |
686 | # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval> | |
687 | # | |
688 | # Example: | |
689 | # sched_scan_plans=10:100 20:200 30 | |
690 | ||
facf2c72 DS |
691 | # Multi Band Operation (MBO) non-preferred channels |
692 | # A space delimited list of non-preferred channels where each channel is a colon | |
4a83d4b6 | 693 | # delimited list of values. |
facf2c72 | 694 | # Format: |
4a83d4b6 | 695 | # non_pref_chan=<oper_class>:<chan>:<preference>:<reason> |
facf2c72 | 696 | # Example: |
23cddd75 | 697 | # non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2 |
facf2c72 | 698 | |
c5d193d7 DS |
699 | # MBO Cellular Data Capabilities |
700 | # 1 = Cellular data connection available | |
701 | # 2 = Cellular data connection not available | |
702 | # 3 = Not cellular capable (default) | |
703 | #mbo_cell_capa=3 | |
704 | ||
6fc6879b JM |
705 | # network block |
706 | # | |
707 | # Each network (usually AP's sharing the same SSID) is configured as a separate | |
708 | # block in this configuration file. The network blocks are in preference order | |
709 | # (the first match is used). | |
710 | # | |
711 | # network block fields: | |
712 | # | |
713 | # disabled: | |
714 | # 0 = this network can be used (default) | |
715 | # 1 = this network block is disabled (can be enabled through ctrl_iface, | |
716 | # e.g., with wpa_cli or wpa_gui) | |
717 | # | |
718 | # id_str: Network identifier string for external scripts. This value is passed | |
719 | # to external action script through wpa_cli as WPA_ID_STR environment | |
720 | # variable to make it easier to do network specific configuration. | |
721 | # | |
5c4b93d7 JM |
722 | # ssid: SSID (mandatory); network name in one of the optional formats: |
723 | # - an ASCII string with double quotation | |
724 | # - a hex string (two characters per octet of SSID) | |
725 | # - a printf-escaped ASCII string P"<escaped string>" | |
6fc6879b JM |
726 | # |
727 | # scan_ssid: | |
728 | # 0 = do not scan this SSID with specific Probe Request frames (default) | |
729 | # 1 = scan with SSID-specific Probe Request frames (this can be used to | |
730 | # find APs that do not accept broadcast SSID or use multiple SSIDs; | |
731 | # this will add latency to scanning, so enable this only when needed) | |
732 | # | |
733 | # bssid: BSSID (optional); if set, this network block is used only when | |
734 | # associating with the AP using the configured BSSID | |
735 | # | |
736 | # priority: priority group (integer) | |
737 | # By default, all networks will get same priority group (0). If some of the | |
738 | # networks are more desirable, this field can be used to change the order in | |
739 | # which wpa_supplicant goes through the networks when selecting a BSS. The | |
740 | # priority groups will be iterated in decreasing priority (i.e., the larger the | |
741 | # priority value, the sooner the network is matched against the scan results). | |
742 | # Within each priority group, networks will be selected based on security | |
743 | # policy, signal strength, etc. | |
744 | # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not | |
745 | # using this priority to select the order for scanning. Instead, they try the | |
746 | # networks in the order that used in the configuration file. | |
747 | # | |
748 | # mode: IEEE 802.11 operation mode | |
749 | # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default) | |
750 | # 1 = IBSS (ad-hoc, peer-to-peer) | |
1581b38b | 751 | # 2 = AP (access point) |
b2838baf JM |
752 | # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and |
753 | # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key | |
754 | # TKIP/CCMP) is available for backwards compatibility, but its use is | |
755 | # deprecated. WPA-None requires following network block options: | |
6fc6879b JM |
756 | # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not |
757 | # both), and psk must also be set. | |
758 | # | |
759 | # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g., | |
760 | # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial | |
761 | # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode. | |
762 | # In addition, this value is only used by the station that creates the IBSS. If | |
763 | # an IBSS network with the configured SSID is already present, the frequency of | |
764 | # the network will be used instead of this configured value. | |
765 | # | |
b9074912 | 766 | # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only. |
90f14962 LD |
767 | # 0 = do not use PBSS |
768 | # 1 = use PBSS | |
769 | # 2 = don't care (not allowed in AP mode) | |
b9074912 LD |
770 | # Used together with mode configuration. When mode is AP, it means to start a |
771 | # PCP instead of a regular AP. When mode is infrastructure it means connect | |
90f14962 LD |
772 | # to a PCP instead of AP. In this mode you can also specify 2 (don't care) |
773 | # which means connect to either PCP or AP. | |
774 | # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network. | |
b9074912 LD |
775 | # For more details, see IEEE Std 802.11ad-2012. |
776 | # | |
d3a98225 JM |
777 | # scan_freq: List of frequencies to scan |
778 | # Space-separated list of frequencies in MHz to scan when searching for this | |
779 | # BSS. If the subset of channels used by the network is known, this option can | |
780 | # be used to optimize scanning to not occur on channels that the network does | |
781 | # not use. Example: scan_freq=2412 2437 2462 | |
782 | # | |
b766a9a2 JM |
783 | # freq_list: Array of allowed frequencies |
784 | # Space-separated list of frequencies in MHz to allow for selecting the BSS. If | |
785 | # set, scan results that do not match any of the specified frequencies are not | |
786 | # considered when selecting a BSS. | |
787 | # | |
f5ffc348 BG |
788 | # This can also be set on the outside of the network block. In this case, |
789 | # it limits the frequencies that will be scanned. | |
790 | # | |
2474ce45 JM |
791 | # bgscan: Background scanning |
792 | # wpa_supplicant behavior for background scanning can be specified by | |
793 | # configuring a bgscan module. These modules are responsible for requesting | |
794 | # background scans for the purpose of roaming within an ESS (i.e., within a | |
795 | # single network block with all the APs using the same SSID). The bgscan | |
796 | # parameter uses following format: "<bgscan module name>:<module parameters>" | |
797 | # Following bgscan modules are available: | |
798 | # simple - Periodic background scans based on signal strength | |
799 | # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>: | |
800 | # <long interval>" | |
801 | # bgscan="simple:30:-45:300" | |
802 | # learn - Learn channels used by the network and try to avoid bgscans on other | |
803 | # channels (experimental) | |
804 | # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>: | |
805 | # <long interval>[:<database file name>]" | |
806 | # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan" | |
268043d5 DS |
807 | # Explicitly disable bgscan by setting |
808 | # bgscan="" | |
2474ce45 | 809 | # |
31392709 HD |
810 | # This option can also be set outside of all network blocks for the bgscan |
811 | # parameter to apply for all the networks that have no specific bgscan | |
812 | # parameter. | |
813 | # | |
6fc6879b JM |
814 | # proto: list of accepted protocols |
815 | # WPA = WPA/IEEE 802.11i/D3.0 | |
816 | # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN) | |
817 | # If not set, this defaults to: WPA RSN | |
818 | # | |
819 | # key_mgmt: list of accepted authenticated key management protocols | |
820 | # WPA-PSK = WPA pre-shared key (this requires 'psk' field) | |
f6190d37 | 821 | # WPA-EAP = WPA using EAP authentication |
6fc6879b JM |
822 | # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically |
823 | # generated WEP keys | |
824 | # NONE = WPA is not used; plaintext or static WEP could be used | |
0ab0de88 JM |
825 | # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK |
826 | # instead) | |
827 | # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key | |
828 | # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication | |
56586197 JM |
829 | # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms |
830 | # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms | |
0ab0de88 JM |
831 | # SAE = Simultaneous authentication of equals; pre-shared key/password -based |
832 | # authentication with stronger security than WPA-PSK especially when using | |
833 | # not that strong password | |
834 | # FT-SAE = SAE with FT | |
835 | # WPA-EAP-SUITE-B = Suite B 128-bit level | |
836 | # WPA-EAP-SUITE-B-192 = Suite B 192-bit level | |
aeb408ff | 837 | # OSEN = Hotspot 2.0 Rel 2 online signup connection |
9b7a2b83 JM |
838 | # FILS-SHA256 = Fast Initial Link Setup with SHA256 |
839 | # FILS-SHA384 = Fast Initial Link Setup with SHA384 | |
840 | # FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256 | |
841 | # FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384 | |
6fc6879b JM |
842 | # If not set, this defaults to: WPA-PSK WPA-EAP |
843 | # | |
4732ee3a | 844 | # ieee80211w: whether management frame protection is enabled |
62d49803 | 845 | # 0 = disabled (default unless changed with the global pmf parameter) |
4732ee3a JM |
846 | # 1 = optional |
847 | # 2 = required | |
848 | # The most common configuration options for this based on the PMF (protected | |
849 | # management frames) certification program are: | |
850 | # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256 | |
851 | # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256 | |
852 | # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used) | |
853 | # | |
6fc6879b JM |
854 | # auth_alg: list of allowed IEEE 802.11 authentication algorithms |
855 | # OPEN = Open System authentication (required for WPA/WPA2) | |
856 | # SHARED = Shared Key authentication (requires static WEP keys) | |
857 | # LEAP = LEAP/Network EAP (only used with LEAP) | |
858 | # If not set, automatic selection is used (Open System with LEAP enabled if | |
859 | # LEAP is allowed as one of the EAP methods). | |
860 | # | |
861 | # pairwise: list of accepted pairwise (unicast) ciphers for WPA | |
862 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
863 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
864 | # NONE = Use only Group Keys (deprecated, should not be included if APs support | |
865 | # pairwise keys) | |
866 | # If not set, this defaults to: CCMP TKIP | |
867 | # | |
868 | # group: list of accepted group (broadcast/multicast) ciphers for WPA | |
869 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
870 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
871 | # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key | |
872 | # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11] | |
873 | # If not set, this defaults to: CCMP TKIP WEP104 WEP40 | |
874 | # | |
875 | # psk: WPA preshared key; 256-bit pre-shared key | |
876 | # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e., | |
877 | # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be | |
878 | # generated using the passphrase and SSID). ASCII passphrase must be between | |
9173b16f JM |
879 | # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can |
880 | # be used to indicate that the PSK/passphrase is stored in external storage. | |
6fc6879b JM |
881 | # This field is not needed, if WPA-EAP is used. |
882 | # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys | |
883 | # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant | |
884 | # startup and reconfiguration time can be optimized by generating the PSK only | |
885 | # only when the passphrase or SSID has actually changed. | |
886 | # | |
a52410c2 JM |
887 | # mem_only_psk: Whether to keep PSK/passphrase only in memory |
888 | # 0 = allow psk/passphrase to be stored to the configuration file | |
889 | # 1 = do not store psk/passphrase to the configuration file | |
890 | #mem_only_psk=0 | |
891 | # | |
6fc6879b JM |
892 | # eapol_flags: IEEE 802.1X/EAPOL options (bit field) |
893 | # Dynamic WEP key required for non-WPA mode | |
894 | # bit0 (1): require dynamically generated unicast WEP key | |
895 | # bit1 (2): require dynamically generated broadcast WEP key | |
896 | # (3 = require both keys; default) | |
ba5ea116 | 897 | # Note: When using wired authentication (including MACsec drivers), |
dd10abcc HW |
898 | # eapol_flags must be set to 0 for the authentication to be completed |
899 | # successfully. | |
900 | # | |
901 | # macsec_policy: IEEE 802.1X/MACsec options | |
ba5ea116 SD |
902 | # This determines how sessions are secured with MACsec (only for MACsec |
903 | # drivers). | |
dd10abcc HW |
904 | # 0: MACsec not in use (default) |
905 | # 1: MACsec enabled - Should secure, accept key server's advice to | |
906 | # determine whether to use a secure session or not. | |
6fc6879b | 907 | # |
7b4d546e SD |
908 | # macsec_integ_only: IEEE 802.1X/MACsec transmit mode |
909 | # This setting applies only when MACsec is in use, i.e., | |
910 | # - macsec_policy is enabled | |
911 | # - the key server has decided to enable MACsec | |
912 | # 0: Encrypt traffic (default) | |
913 | # 1: Integrity only | |
914 | # | |
e0d9fd34 SD |
915 | # macsec_port: IEEE 802.1X/MACsec port |
916 | # Port component of the SCI | |
917 | # Range: 1-65534 (default: 1) | |
918 | # | |
65dfa872 | 919 | # mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode |
ad51731a | 920 | # This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair. |
65dfa872 BA |
921 | # In this mode, instances of wpa_supplicant can act as MACsec peers. The peer |
922 | # with lower priority will become the key server and start distributing SAKs. | |
ad51731a SD |
923 | # mka_cak (CAK = Secure Connectivity Association Key) takes a 16-bytes (128 bit) |
924 | # hex-string (32 hex-digits) | |
925 | # mka_ckn (CKN = CAK Name) takes a 32-bytes (256 bit) hex-string (64 hex-digits) | |
65dfa872 BA |
926 | # mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being |
927 | # default priority | |
ad51731a | 928 | # |
6fc6879b JM |
929 | # mixed_cell: This option can be used to configure whether so called mixed |
930 | # cells, i.e., networks that use both plaintext and encryption in the same | |
ffbf1eaa | 931 | # SSID, are allowed when selecting a BSS from scan results. |
6fc6879b JM |
932 | # 0 = disabled (default) |
933 | # 1 = enabled | |
934 | # | |
935 | # proactive_key_caching: | |
936 | # Enable/disable opportunistic PMKSA caching for WPA2. | |
6e202021 | 937 | # 0 = disabled (default unless changed with the global okc parameter) |
6fc6879b JM |
938 | # 1 = enabled |
939 | # | |
940 | # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or | |
941 | # hex without quotation, e.g., 0102030405) | |
942 | # wep_tx_keyidx: Default WEP key index (TX) (0..3) | |
943 | # | |
944 | # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is | |
945 | # allowed. This is only used with RSN/WPA2. | |
946 | # 0 = disabled (default) | |
947 | # 1 = enabled | |
948 | #peerkey=1 | |
949 | # | |
581a8cde JM |
950 | # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to |
951 | # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies. | |
952 | # | |
6c33ca9f JM |
953 | # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used |
954 | # as the dot11RSNAConfigGroupRekeyTime parameter when operating in | |
f09095d5 | 955 | # Authenticator role in IBSS, or in AP and mesh modes. |
6c33ca9f | 956 | # |
6fc6879b JM |
957 | # Following fields are only used with internal EAP implementation. |
958 | # eap: space-separated list of accepted EAP methods | |
205d2d1f | 959 | # MD5 = EAP-MD5 (insecure and does not generate keying material -> |
6fc6879b JM |
960 | # cannot be used with WPA; to be used as a Phase 2 method |
961 | # with EAP-PEAP or EAP-TTLS) | |
962 | # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used | |
963 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
964 | # OTP = EAP-OTP (cannot be used separately with WPA; to be used | |
965 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
966 | # GTC = EAP-GTC (cannot be used separately with WPA; to be used | |
967 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
968 | # TLS = EAP-TLS (client and server certificate) | |
969 | # PEAP = EAP-PEAP (with tunnelled EAP authentication) | |
970 | # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 | |
971 | # authentication) | |
972 | # If not set, all compiled in methods are allowed. | |
973 | # | |
974 | # identity: Identity string for EAP | |
975 | # This field is also used to configure user NAI for | |
976 | # EAP-PSK/PAX/SAKE/GPSK. | |
977 | # anonymous_identity: Anonymous identity string for EAP (to be used as the | |
978 | # unencrypted identity with EAP types that support different tunnelled | |
e026159a JM |
979 | # identity, e.g., EAP-TTLS). This field can also be used with |
980 | # EAP-SIM/AKA/AKA' to store the pseudonym identity. | |
6fc6879b JM |
981 | # password: Password string for EAP. This field can include either the |
982 | # plaintext password (using ASCII or hex string) or a NtPasswordHash | |
983 | # (16-byte MD4 hash of password) in hash:<32 hex digits> format. | |
984 | # NtPasswordHash can only be used when the password is for MSCHAPv2 or | |
985 | # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). | |
986 | # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit | |
987 | # PSK) is also configured using this field. For EAP-GPSK, this is a | |
0ebb23e3 JM |
988 | # variable length PSK. ext:<name of external password field> format can |
989 | # be used to indicate that the password is stored in external storage. | |
6fc6879b JM |
990 | # ca_cert: File path to CA certificate file (PEM/DER). This file can have one |
991 | # or more trusted CA certificates. If ca_cert and ca_path are not | |
992 | # included, server certificate will not be verified. This is insecure and | |
993 | # a trusted CA certificate should always be configured when using | |
994 | # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may | |
995 | # change when wpa_supplicant is run in the background. | |
00468b46 JM |
996 | # |
997 | # Alternatively, this can be used to only perform matching of the server | |
998 | # certificate (SHA-256 hash of the DER encoded X.509 certificate). In | |
999 | # this case, the possible CA certificates in the server certificate chain | |
1000 | # are ignored and only the server certificate is verified. This is | |
1001 | # configured with the following format: | |
1002 | # hash:://server/sha256/cert_hash_in_hex | |
1003 | # For example: "hash://server/sha256/ | |
1004 | # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a" | |
1005 | # | |
6fc6879b JM |
1006 | # On Windows, trusted CA certificates can be loaded from the system |
1007 | # certificate store by setting this to cert_store://<name>, e.g., | |
1008 | # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". | |
1009 | # Note that when running wpa_supplicant as an application, the user | |
1010 | # certificate store (My user account) is used, whereas computer store | |
1011 | # (Computer account) is used when running wpasvc as a service. | |
1012 | # ca_path: Directory path for CA certificate files (PEM). This path may | |
1013 | # contain multiple CA certificates in OpenSSL format. Common use for this | |
1014 | # is to point to system trusted CA list which is often installed into | |
1015 | # directory like /etc/ssl/certs. If configured, these certificates are | |
1016 | # added to the list of trusted CAs. ca_cert may also be included in that | |
1017 | # case, but it is not required. | |
1018 | # client_cert: File path to client certificate file (PEM/DER) | |
1019 | # Full path should be used since working directory may change when | |
1020 | # wpa_supplicant is run in the background. | |
1021 | # Alternatively, a named configuration blob can be used by setting this | |
1022 | # to blob://<blob name>. | |
1023 | # private_key: File path to client private key file (PEM/DER/PFX) | |
1024 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be | |
1025 | # commented out. Both the private key and certificate will be read from | |
1026 | # the PKCS#12 file in this case. Full path should be used since working | |
1027 | # directory may change when wpa_supplicant is run in the background. | |
1028 | # Windows certificate store can be used by leaving client_cert out and | |
1029 | # configuring private_key in one of the following formats: | |
1030 | # cert://substring_to_match | |
1031 | # hash://certificate_thumbprint_in_hex | |
1032 | # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4" | |
1033 | # Note that when running wpa_supplicant as an application, the user | |
1034 | # certificate store (My user account) is used, whereas computer store | |
1035 | # (Computer account) is used when running wpasvc as a service. | |
1036 | # Alternatively, a named configuration blob can be used by setting this | |
1037 | # to blob://<blob name>. | |
1038 | # private_key_passwd: Password for private key file (if left out, this will be | |
1039 | # asked through control interface) | |
1040 | # dh_file: File path to DH/DSA parameters file (in PEM format) | |
1041 | # This is an optional configuration file for setting parameters for an | |
1042 | # ephemeral DH key exchange. In most cases, the default RSA | |
1043 | # authentication does not use this configuration. However, it is possible | |
1044 | # setup RSA to use ephemeral DH key exchange. In addition, ciphers with | |
1045 | # DSA keys always use ephemeral DH keys. This can be used to achieve | |
1046 | # forward secrecy. If the file is in DSA parameters format, it will be | |
1047 | # automatically converted into DH params. | |
1048 | # subject_match: Substring to be matched against the subject of the | |
1049 | # authentication server certificate. If this string is set, the server | |
205d2d1f | 1050 | # certificate is only accepted if it contains this string in the subject. |
6fc6879b JM |
1051 | # The subject string is in following format: |
1052 | # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com | |
205d2d1f | 1053 | # Note: Since this is a substring match, this cannot be used securely to |
394b5473 | 1054 | # do a suffix match against a possible domain name in the CN entry. For |
cebee30f JM |
1055 | # such a use case, domain_suffix_match or domain_match should be used |
1056 | # instead. | |
6fc6879b JM |
1057 | # altsubject_match: Semicolon separated string of entries to be matched against |
1058 | # the alternative subject name of the authentication server certificate. | |
205d2d1f | 1059 | # If this string is set, the server certificate is only accepted if it |
6fc6879b JM |
1060 | # contains one of the entries in an alternative subject name extension. |
1061 | # altSubjectName string is in following format: TYPE:VALUE | |
1062 | # Example: EMAIL:server@example.com | |
1063 | # Example: DNS:server.example.com;DNS:server2.example.com | |
1064 | # Following types are supported: EMAIL, DNS, URI | |
394b5473 | 1065 | # domain_suffix_match: Constraint for server domain name. If set, this FQDN is |
205d2d1f | 1066 | # used as a suffix match requirement for the AAA server certificate in |
394b5473 JM |
1067 | # SubjectAltName dNSName element(s). If a matching dNSName is found, this |
1068 | # constraint is met. If no dNSName values are present, this constraint is | |
1069 | # matched against SubjectName CN using same suffix match comparison. | |
1070 | # | |
1071 | # Suffix match here means that the host/domain name is compared one label | |
1072 | # at a time starting from the top-level domain and all the labels in | |
1073 | # domain_suffix_match shall be included in the certificate. The | |
1074 | # certificate may include additional sub-level labels in addition to the | |
1075 | # required labels. | |
1076 | # | |
1077 | # For example, domain_suffix_match=example.com would match | |
1078 | # test.example.com but would not match test-example.com. | |
cebee30f JM |
1079 | # domain_match: Constraint for server domain name |
1080 | # If set, this FQDN is used as a full match requirement for the | |
1081 | # server certificate in SubjectAltName dNSName element(s). If a | |
1082 | # matching dNSName is found, this constraint is met. If no dNSName | |
1083 | # values are present, this constraint is matched against SubjectName CN | |
1084 | # using same full match comparison. This behavior is similar to | |
1085 | # domain_suffix_match, but has the requirement of a full match, i.e., | |
1086 | # no subdomains or wildcard matches are allowed. Case-insensitive | |
1087 | # comparison is used, so "Example.com" matches "example.com", but would | |
1088 | # not match "test.Example.com". | |
6fc6879b JM |
1089 | # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters |
1090 | # (string with field-value pairs, e.g., "peapver=0" or | |
1091 | # "peapver=1 peaplabel=1") | |
1092 | # 'peapver' can be used to force which PEAP version (0 or 1) is used. | |
1093 | # 'peaplabel=1' can be used to force new label, "client PEAP encryption", | |
1094 | # to be used during key derivation when PEAPv1 or newer. Most existing | |
1095 | # PEAPv1 implementation seem to be using the old label, "client EAP | |
1096 | # encryption", and wpa_supplicant is now using that as the default value. | |
1097 | # Some servers, e.g., Radiator, may require peaplabel=1 configuration to | |
1098 | # interoperate with PEAPv1; see eap_testing.txt for more details. | |
1099 | # 'peap_outer_success=0' can be used to terminate PEAP authentication on | |
1100 | # tunneled EAP-Success. This is required with some RADIUS servers that | |
1101 | # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g., | |
1102 | # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode) | |
1103 | # include_tls_length=1 can be used to force wpa_supplicant to include | |
1104 | # TLS Message Length field in all TLS messages even if they are not | |
1105 | # fragmented. | |
1106 | # sim_min_num_chal=3 can be used to configure EAP-SIM to require three | |
1107 | # challenges (by default, it accepts 2 or 3) | |
1108 | # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use | |
1109 | # protected result indication. | |
d6888f9e JM |
1110 | # 'crypto_binding' option can be used to control PEAPv0 cryptobinding |
1111 | # behavior: | |
c31a11c9 JM |
1112 | # * 0 = do not use cryptobinding (default) |
1113 | # * 1 = use cryptobinding if server supports it | |
d6888f9e | 1114 | # * 2 = require cryptobinding |
f855f923 JM |
1115 | # EAP-WSC (WPS) uses following options: pin=<Device Password> or |
1116 | # pbc=1. | |
7f7bfba9 JM |
1117 | # |
1118 | # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be | |
1119 | # used to configure a mode that allows EAP-Success (and EAP-Failure) | |
1120 | # without going through authentication step. Some switches use such | |
1121 | # sequence when forcing the port to be authorized/unauthorized or as a | |
1122 | # fallback option if the authentication server is unreachable. By default, | |
1123 | # wpa_supplicant discards such frames to protect against potential attacks | |
1124 | # by rogue devices, but this option can be used to disable that protection | |
1125 | # for cases where the server/authenticator does not need to be | |
1126 | # authenticated. | |
6fc6879b JM |
1127 | # phase2: Phase2 (inner authentication with TLS tunnel) parameters |
1128 | # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or | |
49fcc32e JM |
1129 | # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be |
1130 | # used to disable MSCHAPv2 password retry in authentication failure cases. | |
9af7361b JM |
1131 | # |
1132 | # TLS-based methods can use the following parameters to control TLS behavior | |
1133 | # (these are normally in the phase1 parameter, but can be used also in the | |
1134 | # phase2 parameter when EAP-TLS is used within the inner tunnel): | |
1135 | # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the | |
1136 | # TLS library, these may be disabled by default to enforce stronger | |
1137 | # security) | |
1138 | # tls_disable_time_checks=1 - ignore certificate validity time (this requests | |
1139 | # the TLS library to accept certificates even if they are not currently | |
1140 | # valid, i.e., have expired or have not yet become valid; this should be | |
1141 | # used only for testing purposes) | |
1142 | # tls_disable_session_ticket=1 - disable TLS Session Ticket extension | |
1143 | # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used | |
1144 | # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS | |
1145 | # as a workaround for broken authentication server implementations unless | |
56dfc493 | 1146 | # EAP workarounds are disabled with eap_workaround=0. |
9af7361b JM |
1147 | # For EAP-FAST, this must be set to 0 (or left unconfigured for the |
1148 | # default value to be used automatically). | |
5650d379 | 1149 | # tls_disable_tlsv1_0=1 - disable use of TLSv1.0 |
e9a6f183 DS |
1150 | # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers |
1151 | # that have issues interoperating with updated TLS version) | |
1152 | # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers | |
1153 | # that have issues interoperating with updated TLS version) | |
3c108b75 JM |
1154 | # tls_ext_cert_check=0 - No external server certificate validation (default) |
1155 | # tls_ext_cert_check=1 - External server certificate validation enabled; this | |
1156 | # requires an external program doing validation of server certificate | |
1157 | # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control | |
1158 | # interface and report the result of the validation with | |
1159 | # CTRL-RSP_EXT_CERT_CHECK. | |
9af7361b | 1160 | # |
6fc6879b JM |
1161 | # Following certificate/private key fields are used in inner Phase2 |
1162 | # authentication when using EAP-TTLS or EAP-PEAP. | |
1163 | # ca_cert2: File path to CA certificate file. This file can have one or more | |
1164 | # trusted CA certificates. If ca_cert2 and ca_path2 are not included, | |
1165 | # server certificate will not be verified. This is insecure and a trusted | |
1166 | # CA certificate should always be configured. | |
1167 | # ca_path2: Directory path for CA certificate files (PEM) | |
1168 | # client_cert2: File path to client certificate file | |
1169 | # private_key2: File path to client private key file | |
1170 | # private_key2_passwd: Password for private key file | |
1171 | # dh_file2: File path to DH/DSA parameters file (in PEM format) | |
1172 | # subject_match2: Substring to be matched against the subject of the | |
394b5473 JM |
1173 | # authentication server certificate. See subject_match for more details. |
1174 | # altsubject_match2: Semicolon separated string of entries to be matched | |
1175 | # against the alternative subject name of the authentication server | |
1176 | # certificate. See altsubject_match documentation for more details. | |
1177 | # domain_suffix_match2: Constraint for server domain name. See | |
1178 | # domain_suffix_match for more details. | |
6fc6879b JM |
1179 | # |
1180 | # fragment_size: Maximum EAP fragment size in bytes (default 1398). | |
1181 | # This value limits the fragment size for EAP methods that support | |
1182 | # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set | |
1183 | # small enough to make the EAP messages fit in MTU of the network | |
1184 | # interface used for EAPOL. The default value is suitable for most | |
1185 | # cases. | |
1186 | # | |
080585c0 JM |
1187 | # ocsp: Whether to use/require OCSP to check server certificate |
1188 | # 0 = do not use OCSP stapling (TLS certificate status extension) | |
1189 | # 1 = try to use OCSP stapling, but not require response | |
1190 | # 2 = require valid OCSP stapling response | |
d6b536f7 JM |
1191 | # 3 = require valid OCSP stapling response for all not-trusted |
1192 | # certificates in the server certificate chain | |
080585c0 | 1193 | # |
07e2de31 JM |
1194 | # openssl_ciphers: OpenSSL specific cipher configuration |
1195 | # This can be used to override the global openssl_ciphers configuration | |
1196 | # parameter (see above). | |
1197 | # | |
02a8d45a JM |
1198 | # erp: Whether EAP Re-authentication Protocol (ERP) is enabled |
1199 | # | |
6fc6879b JM |
1200 | # EAP-FAST variables: |
1201 | # pac_file: File path for the PAC entries. wpa_supplicant will need to be able | |
1202 | # to create this file and write updates to it when PAC is being | |
1203 | # provisioned or refreshed. Full path to the file should be used since | |
1204 | # working directory may change when wpa_supplicant is run in the | |
1205 | # background. Alternatively, a named configuration blob can be used by | |
1206 | # setting this to blob://<blob name> | |
1207 | # phase1: fast_provisioning option can be used to enable in-line provisioning | |
1208 | # of EAP-FAST credentials (PAC): | |
1209 | # 0 = disabled, | |
1210 | # 1 = allow unauthenticated provisioning, | |
1211 | # 2 = allow authenticated provisioning, | |
1212 | # 3 = allow both unauthenticated and authenticated provisioning | |
1213 | # fast_max_pac_list_len=<num> option can be used to set the maximum | |
1214 | # number of PAC entries to store in a PAC list (default: 10) | |
1215 | # fast_pac_format=binary option can be used to select binary format for | |
2e8c9a27 | 1216 | # storing PAC entries in order to save some space (the default |
6fc6879b JM |
1217 | # text format uses about 2.5 times the size of minimal binary |
1218 | # format) | |
1219 | # | |
1220 | # wpa_supplicant supports number of "EAP workarounds" to work around | |
1221 | # interoperability issues with incorrectly behaving authentication servers. | |
1222 | # These are enabled by default because some of the issues are present in large | |
1223 | # number of authentication servers. Strict EAP conformance mode can be | |
1224 | # configured by disabling workarounds with eap_workaround=0. | |
1225 | ||
aeb408ff JM |
1226 | # update_identifier: PPS MO ID |
1227 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) | |
1228 | ||
07f53b8c VT |
1229 | # Station inactivity limit |
1230 | # | |
1231 | # If a station does not send anything in ap_max_inactivity seconds, an | |
1232 | # empty data frame is sent to it in order to verify whether it is | |
1233 | # still in range. If this frame is not ACKed, the station will be | |
1234 | # disassociated and then deauthenticated. This feature is used to | |
1235 | # clear station table of old entries when the STAs move out of the | |
1236 | # range. | |
1237 | # | |
1238 | # The station can associate again with the AP if it is still in range; | |
1239 | # this inactivity poll is just used as a nicer way of verifying | |
1240 | # inactivity; i.e., client will not report broken connection because | |
1241 | # disassociation frame is not sent immediately without first polling | |
1242 | # the STA with a data frame. | |
1243 | # default: 300 (i.e., 5 minutes) | |
1244 | #ap_max_inactivity=300 | |
1245 | ||
fdfb1c8b EL |
1246 | # DTIM period in Beacon intervals for AP mode (default: 2) |
1247 | #dtim_period=2 | |
1248 | ||
18206e02 JM |
1249 | # Beacon interval (default: 100 TU) |
1250 | #beacon_int=100 | |
1251 | ||
b6317b41 LD |
1252 | # WPS in AP mode |
1253 | # 0 = WPS enabled and configured (default) | |
1254 | # 1 = WPS disabled | |
1255 | #wps_disabled=0 | |
1256 | ||
76e20f4f JM |
1257 | # FILS DH Group |
1258 | # 0 = PFS disabled with FILS shared key authentication (default) | |
1259 | # 1-65535 = DH Group to use for FILS PFS | |
1260 | #fils_dh_group=0 | |
1261 | ||
c267753b JM |
1262 | # MAC address policy |
1263 | # 0 = use permanent MAC address | |
1264 | # 1 = use random MAC address for each ESS connection | |
a313d17d | 1265 | # 2 = like 1, but maintain OUI (with local admin bit set) |
c267753b JM |
1266 | #mac_addr=0 |
1267 | ||
c8d22af8 BG |
1268 | # disable_ht: Whether HT (802.11n) should be disabled. |
1269 | # 0 = HT enabled (if AP supports it) | |
1270 | # 1 = HT disabled | |
1271 | # | |
1272 | # disable_ht40: Whether HT-40 (802.11n) should be disabled. | |
1273 | # 0 = HT-40 enabled (if AP supports it) | |
1274 | # 1 = HT-40 disabled | |
1275 | # | |
1276 | # disable_sgi: Whether SGI (short guard interval) should be disabled. | |
1277 | # 0 = SGI enabled (if AP supports it) | |
1278 | # 1 = SGI disabled | |
1279 | # | |
39a5800f PK |
1280 | # disable_ldpc: Whether LDPC should be disabled. |
1281 | # 0 = LDPC enabled (if AP supports it) | |
1282 | # 1 = LDPC disabled | |
1283 | # | |
d41cc8cc JM |
1284 | # ht40_intolerant: Whether 40 MHz intolerant should be indicated. |
1285 | # 0 = 40 MHz tolerant (default) | |
1286 | # 1 = 40 MHz intolerant | |
1287 | # | |
c8d22af8 BG |
1288 | # ht_mcs: Configure allowed MCS rates. |
1289 | # Parsed as an array of bytes, in base-16 (ascii-hex) | |
1290 | # ht_mcs="" // Use all available (default) | |
1291 | # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only | |
1292 | # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only | |
1293 | # | |
1294 | # disable_max_amsdu: Whether MAX_AMSDU should be disabled. | |
1295 | # -1 = Do not make any changes. | |
1296 | # 0 = Enable MAX-AMSDU if hardware supports it. | |
1297 | # 1 = Disable AMSDU | |
1298 | # | |
e74dd0e5 JM |
1299 | # ampdu_factor: Maximum A-MPDU Length Exponent |
1300 | # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009. | |
1301 | # | |
c8d22af8 BG |
1302 | # ampdu_density: Allow overriding AMPDU density configuration. |
1303 | # Treated as hint by the kernel. | |
1304 | # -1 = Do not make any changes. | |
1305 | # 0-3 = Set AMPDU density (aka factor) to specified value. | |
1306 | ||
e9ee8dc3 JB |
1307 | # disable_vht: Whether VHT should be disabled. |
1308 | # 0 = VHT enabled (if AP supports it) | |
1309 | # 1 = VHT disabled | |
1310 | # | |
1311 | # vht_capa: VHT capabilities to set in the override | |
1312 | # vht_capa_mask: mask of VHT capabilities | |
1313 | # | |
1314 | # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8 | |
1315 | # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8 | |
1316 | # 0: MCS 0-7 | |
1317 | # 1: MCS 0-8 | |
1318 | # 2: MCS 0-9 | |
1319 | # 3: not supported | |
1320 | ||
76ca15b7 AN |
1321 | ##### Fast Session Transfer (FST) support ##################################### |
1322 | # | |
1323 | # The options in this section are only available when the build configuration | |
205d2d1f JM |
1324 | # option CONFIG_FST is set while compiling wpa_supplicant. They allow this |
1325 | # interface to be a part of FST setup. | |
76ca15b7 AN |
1326 | # |
1327 | # FST is the transfer of a session from a channel to another channel, in the | |
1328 | # same or different frequency bands. | |
1329 | # | |
205d2d1f | 1330 | # For details, see IEEE Std 802.11ad-2012. |
76ca15b7 AN |
1331 | |
1332 | # Identifier of an FST Group the interface belongs to. | |
1333 | #fst_group_id=bond0 | |
1334 | ||
1335 | # Interface priority within the FST Group. | |
1336 | # Announcing a higher priority for an interface means declaring it more | |
1337 | # preferable for FST switch. | |
1338 | # fst_priority is in 1..255 range with 1 being the lowest priority. | |
1339 | #fst_priority=100 | |
1340 | ||
1341 | # Default LLT value for this interface in milliseconds. The value used in case | |
1342 | # no value provided during session setup. Default is 50 msec. | |
1343 | # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2 | |
1344 | # Transitioning between states). | |
1345 | #fst_llt=100 | |
1346 | ||
6fc6879b JM |
1347 | # Example blocks: |
1348 | ||
1349 | # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers | |
1350 | network={ | |
1351 | ssid="simple" | |
1352 | psk="very secret passphrase" | |
1353 | priority=5 | |
1354 | } | |
1355 | ||
1356 | # Same as previous, but request SSID-specific scanning (for APs that reject | |
1357 | # broadcast SSID) | |
1358 | network={ | |
1359 | ssid="second ssid" | |
1360 | scan_ssid=1 | |
1361 | psk="very secret passphrase" | |
1362 | priority=2 | |
1363 | } | |
1364 | ||
1365 | # Only WPA-PSK is used. Any valid cipher combination is accepted. | |
1366 | network={ | |
1367 | ssid="example" | |
1368 | proto=WPA | |
1369 | key_mgmt=WPA-PSK | |
1370 | pairwise=CCMP TKIP | |
1371 | group=CCMP TKIP WEP104 WEP40 | |
1372 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
1373 | priority=2 | |
1374 | } | |
1375 | ||
581a8cde JM |
1376 | # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying |
1377 | network={ | |
1378 | ssid="example" | |
1379 | proto=WPA | |
1380 | key_mgmt=WPA-PSK | |
1381 | pairwise=TKIP | |
1382 | group=TKIP | |
1383 | psk="not so secure passphrase" | |
1384 | wpa_ptk_rekey=600 | |
1385 | } | |
1386 | ||
6fc6879b JM |
1387 | # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104 |
1388 | # or WEP40 as the group cipher will not be accepted. | |
1389 | network={ | |
1390 | ssid="example" | |
1391 | proto=RSN | |
1392 | key_mgmt=WPA-EAP | |
1393 | pairwise=CCMP TKIP | |
1394 | group=CCMP TKIP | |
1395 | eap=TLS | |
1396 | identity="user@example.com" | |
1397 | ca_cert="/etc/cert/ca.pem" | |
1398 | client_cert="/etc/cert/user.pem" | |
1399 | private_key="/etc/cert/user.prv" | |
1400 | private_key_passwd="password" | |
1401 | priority=1 | |
1402 | } | |
1403 | ||
1404 | # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel | |
1405 | # (e.g., Radiator) | |
1406 | network={ | |
1407 | ssid="example" | |
1408 | key_mgmt=WPA-EAP | |
1409 | eap=PEAP | |
1410 | identity="user@example.com" | |
1411 | password="foobar" | |
1412 | ca_cert="/etc/cert/ca.pem" | |
1413 | phase1="peaplabel=1" | |
1414 | phase2="auth=MSCHAPV2" | |
1415 | priority=10 | |
1416 | } | |
1417 | ||
1418 | # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the | |
1419 | # unencrypted use. Real identity is sent only within an encrypted TLS tunnel. | |
1420 | network={ | |
1421 | ssid="example" | |
1422 | key_mgmt=WPA-EAP | |
1423 | eap=TTLS | |
1424 | identity="user@example.com" | |
1425 | anonymous_identity="anonymous@example.com" | |
1426 | password="foobar" | |
1427 | ca_cert="/etc/cert/ca.pem" | |
1428 | priority=2 | |
1429 | } | |
1430 | ||
1431 | # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted | |
1432 | # use. Real identity is sent only within an encrypted TLS tunnel. | |
1433 | network={ | |
1434 | ssid="example" | |
1435 | key_mgmt=WPA-EAP | |
1436 | eap=TTLS | |
1437 | identity="user@example.com" | |
1438 | anonymous_identity="anonymous@example.com" | |
1439 | password="foobar" | |
1440 | ca_cert="/etc/cert/ca.pem" | |
1441 | phase2="auth=MSCHAPV2" | |
1442 | } | |
1443 | ||
1444 | # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner | |
1445 | # authentication. | |
1446 | network={ | |
1447 | ssid="example" | |
1448 | key_mgmt=WPA-EAP | |
1449 | eap=TTLS | |
1450 | # Phase1 / outer authentication | |
1451 | anonymous_identity="anonymous@example.com" | |
1452 | ca_cert="/etc/cert/ca.pem" | |
1453 | # Phase 2 / inner authentication | |
1454 | phase2="autheap=TLS" | |
1455 | ca_cert2="/etc/cert/ca2.pem" | |
1456 | client_cert2="/etc/cer/user.pem" | |
1457 | private_key2="/etc/cer/user.prv" | |
1458 | private_key2_passwd="password" | |
1459 | priority=2 | |
1460 | } | |
1461 | ||
1462 | # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and | |
1463 | # group cipher. | |
1464 | network={ | |
1465 | ssid="example" | |
1466 | bssid=00:11:22:33:44:55 | |
1467 | proto=WPA RSN | |
1468 | key_mgmt=WPA-PSK WPA-EAP | |
1469 | pairwise=CCMP | |
1470 | group=CCMP | |
1471 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
1472 | } | |
1473 | ||
1474 | # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP | |
1475 | # and all valid ciphers. | |
1476 | network={ | |
1477 | ssid=00010203 | |
1478 | psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f | |
1479 | } | |
1480 | ||
1481 | ||
1482 | # EAP-SIM with a GSM SIM or USIM | |
1483 | network={ | |
1484 | ssid="eap-sim-test" | |
1485 | key_mgmt=WPA-EAP | |
1486 | eap=SIM | |
1487 | pin="1234" | |
1488 | pcsc="" | |
1489 | } | |
1490 | ||
1491 | ||
1492 | # EAP-PSK | |
1493 | network={ | |
1494 | ssid="eap-psk-test" | |
1495 | key_mgmt=WPA-EAP | |
1496 | eap=PSK | |
1497 | anonymous_identity="eap_psk_user" | |
1498 | password=06b4be19da289f475aa46a33cb793029 | |
1499 | identity="eap_psk_user@example.com" | |
1500 | } | |
1501 | ||
1502 | ||
1503 | # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using | |
1504 | # EAP-TLS for authentication and key generation; require both unicast and | |
1505 | # broadcast WEP keys. | |
1506 | network={ | |
1507 | ssid="1x-test" | |
1508 | key_mgmt=IEEE8021X | |
1509 | eap=TLS | |
1510 | identity="user@example.com" | |
1511 | ca_cert="/etc/cert/ca.pem" | |
1512 | client_cert="/etc/cert/user.pem" | |
1513 | private_key="/etc/cert/user.prv" | |
1514 | private_key_passwd="password" | |
1515 | eapol_flags=3 | |
1516 | } | |
1517 | ||
1518 | ||
1519 | # LEAP with dynamic WEP keys | |
1520 | network={ | |
1521 | ssid="leap-example" | |
1522 | key_mgmt=IEEE8021X | |
1523 | eap=LEAP | |
1524 | identity="user" | |
1525 | password="foobar" | |
1526 | } | |
1527 | ||
1528 | # EAP-IKEv2 using shared secrets for both server and peer authentication | |
1529 | network={ | |
1530 | ssid="ikev2-example" | |
1531 | key_mgmt=WPA-EAP | |
1532 | eap=IKEV2 | |
1533 | identity="user" | |
1534 | password="foobar" | |
1535 | } | |
1536 | ||
1537 | # EAP-FAST with WPA (WPA or WPA2) | |
1538 | network={ | |
1539 | ssid="eap-fast-test" | |
1540 | key_mgmt=WPA-EAP | |
1541 | eap=FAST | |
1542 | anonymous_identity="FAST-000102030405" | |
1543 | identity="username" | |
1544 | password="password" | |
1545 | phase1="fast_provisioning=1" | |
1546 | pac_file="/etc/wpa_supplicant.eap-fast-pac" | |
1547 | } | |
1548 | ||
1549 | network={ | |
1550 | ssid="eap-fast-test" | |
1551 | key_mgmt=WPA-EAP | |
1552 | eap=FAST | |
1553 | anonymous_identity="FAST-000102030405" | |
1554 | identity="username" | |
1555 | password="password" | |
1556 | phase1="fast_provisioning=1" | |
1557 | pac_file="blob://eap-fast-pac" | |
1558 | } | |
1559 | ||
1560 | # Plaintext connection (no WPA, no IEEE 802.1X) | |
1561 | network={ | |
1562 | ssid="plaintext-test" | |
1563 | key_mgmt=NONE | |
1564 | } | |
1565 | ||
1566 | ||
1567 | # Shared WEP key connection (no WPA, no IEEE 802.1X) | |
1568 | network={ | |
1569 | ssid="static-wep-test" | |
1570 | key_mgmt=NONE | |
1571 | wep_key0="abcde" | |
1572 | wep_key1=0102030405 | |
1573 | wep_key2="1234567890123" | |
1574 | wep_tx_keyidx=0 | |
1575 | priority=5 | |
1576 | } | |
1577 | ||
1578 | ||
1579 | # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key | |
1580 | # IEEE 802.11 authentication | |
1581 | network={ | |
1582 | ssid="static-wep-test2" | |
1583 | key_mgmt=NONE | |
1584 | wep_key0="abcde" | |
1585 | wep_key1=0102030405 | |
1586 | wep_key2="1234567890123" | |
1587 | wep_tx_keyidx=0 | |
1588 | priority=5 | |
1589 | auth_alg=SHARED | |
1590 | } | |
1591 | ||
1592 | ||
b2838baf JM |
1593 | # IBSS/ad-hoc network with RSN |
1594 | network={ | |
1595 | ssid="ibss-rsn" | |
1596 | key_mgmt=WPA-PSK | |
1597 | proto=RSN | |
1598 | psk="12345678" | |
1599 | mode=1 | |
1600 | frequency=2412 | |
1601 | pairwise=CCMP | |
1602 | group=CCMP | |
1603 | } | |
1604 | ||
1605 | # IBSS/ad-hoc network with WPA-None/TKIP (deprecated) | |
6fc6879b JM |
1606 | network={ |
1607 | ssid="test adhoc" | |
1608 | mode=1 | |
1609 | frequency=2412 | |
1610 | proto=WPA | |
1611 | key_mgmt=WPA-NONE | |
1612 | pairwise=NONE | |
1613 | group=TKIP | |
1614 | psk="secret passphrase" | |
9e5e03d7 TP |
1615 | } |
1616 | ||
1617 | # open mesh network | |
1618 | network={ | |
1619 | ssid="test mesh" | |
1620 | mode=5 | |
1621 | frequency=2437 | |
1622 | key_mgmt=NONE | |
1623 | } | |
1624 | ||
1625 | # secure (SAE + AMPE) network | |
1626 | network={ | |
1627 | ssid="secure mesh" | |
1628 | mode=5 | |
1629 | frequency=2437 | |
1630 | key_mgmt=SAE | |
1631 | psk="very secret passphrase" | |
6fc6879b JM |
1632 | } |
1633 | ||
1634 | ||
1635 | # Catch all example that allows more or less all configuration modes | |
1636 | network={ | |
1637 | ssid="example" | |
1638 | scan_ssid=1 | |
1639 | key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE | |
1640 | pairwise=CCMP TKIP | |
1641 | group=CCMP TKIP WEP104 WEP40 | |
1642 | psk="very secret passphrase" | |
1643 | eap=TTLS PEAP TLS | |
1644 | identity="user@example.com" | |
1645 | password="foobar" | |
1646 | ca_cert="/etc/cert/ca.pem" | |
1647 | client_cert="/etc/cert/user.pem" | |
1648 | private_key="/etc/cert/user.prv" | |
1649 | private_key_passwd="password" | |
1650 | phase1="peaplabel=0" | |
1651 | } | |
1652 | ||
1653 | # Example of EAP-TLS with smartcard (openssl engine) | |
1654 | network={ | |
1655 | ssid="example" | |
1656 | key_mgmt=WPA-EAP | |
1657 | eap=TLS | |
1658 | proto=RSN | |
1659 | pairwise=CCMP TKIP | |
1660 | group=CCMP TKIP | |
1661 | identity="user@example.com" | |
1662 | ca_cert="/etc/cert/ca.pem" | |
6fc6879b | 1663 | |
f7cb6e9f DW |
1664 | # Certificate and/or key identified by PKCS#11 URI (RFC7512) |
1665 | client_cert="pkcs11:manufacturer=piv_II;id=%01" | |
1666 | private_key="pkcs11:manufacturer=piv_II;id=%01" | |
6fc6879b JM |
1667 | |
1668 | # Optional PIN configuration; this can be left out and PIN will be | |
1669 | # asked through the control interface | |
1670 | pin="1234" | |
1671 | } | |
1672 | ||
1673 | # Example configuration showing how to use an inlined blob as a CA certificate | |
1674 | # data instead of using external file | |
1675 | network={ | |
1676 | ssid="example" | |
1677 | key_mgmt=WPA-EAP | |
1678 | eap=TTLS | |
1679 | identity="user@example.com" | |
1680 | anonymous_identity="anonymous@example.com" | |
1681 | password="foobar" | |
1682 | ca_cert="blob://exampleblob" | |
1683 | priority=20 | |
1684 | } | |
1685 | ||
1686 | blob-base64-exampleblob={ | |
1687 | SGVsbG8gV29ybGQhCg== | |
1688 | } | |
1689 | ||
1690 | ||
1691 | # Wildcard match for SSID (plaintext APs only). This example select any | |
1692 | # open AP regardless of its SSID. | |
1693 | network={ | |
1694 | key_mgmt=NONE | |
1695 | } | |
f5ffc348 | 1696 | |
b83e4554 ST |
1697 | # Example configuration blacklisting two APs - these will be ignored |
1698 | # for this network. | |
1699 | network={ | |
1700 | ssid="example" | |
1701 | psk="very secret passphrase" | |
1702 | bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66 | |
1703 | } | |
1704 | ||
1705 | # Example configuration limiting AP selection to a specific set of APs; | |
79cd993a | 1706 | # any other AP not matching the masked address will be ignored. |
b83e4554 ST |
1707 | network={ |
1708 | ssid="example" | |
1709 | psk="very secret passphrase" | |
79cd993a | 1710 | bssid_whitelist=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 | 1711 | } |
f5ffc348 BG |
1712 | |
1713 | # Example config file that will only scan on channel 36. | |
1714 | freq_list=5180 | |
1715 | network={ | |
1716 | key_mgmt=NONE | |
1717 | } | |
dd10abcc HW |
1718 | |
1719 | ||
1720 | # Example MACsec configuration | |
1721 | #network={ | |
1722 | # key_mgmt=IEEE8021X | |
1723 | # eap=TTLS | |
1724 | # phase2="auth=PAP" | |
1725 | # anonymous_identity="anonymous@example.com" | |
1726 | # identity="user@example.com" | |
1727 | # password="secretr" | |
1728 | # ca_cert="/etc/cert/ca.pem" | |
1729 | # eapol_flags=0 | |
1730 | # macsec_policy=1 | |
1731 | #} |