Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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 |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 31 | # interface mechanism is used. For all cases, the existence of this parameter |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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). |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 84 | # Note: When using MACsec, eapol_version shall be set to 3, which is |
| 85 | # defined in IEEE Std 802.1X-2010. |
Dmitry Shmidt | 8d520ff | 2011-05-09 14:06:53 -0700 | [diff] [blame] | 86 | eapol_version=1 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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. |
| 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) |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 97 | # 0: This mode must only be used when using wired Ethernet drivers |
| 98 | # (including MACsec). |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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 |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 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. |
Dmitry Shmidt | d80a401 | 2015-11-05 16:35:40 -0800 | [diff] [blame] | 108 | # For finding networks using hidden SSID, scan_ssid=1 in the network block can |
| 109 | # be used with nl80211. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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. |
Dmitry Shmidt | 8d520ff | 2011-05-09 14:06:53 -0700 | [diff] [blame] | 114 | ap_scan=1 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 115 | |
Dmitry Shmidt | b70d0bb | 2015-11-16 10:43:06 -0800 | [diff] [blame] | 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 | |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 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 | |
| 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 | |
Dmitry Shmidt | 2f74e36 | 2015-01-21 13:19:05 -0800 | [diff] [blame] | 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 | |
Hai Shalom | a20dcd7 | 2022-02-04 13:43:00 -0800 | [diff] [blame] | 153 | # Enable 802.11s layer-2 routing and forwarding (dot11MeshForwarding) |
| 154 | #mesh_fwding=1 |
| 155 | |
Dmitry Shmidt | 2f74e36 | 2015-01-21 13:19:05 -0800 | [diff] [blame] | 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 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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. |
Dmitry Shmidt | 8d520ff | 2011-05-09 14:06:53 -0700 | [diff] [blame] | 166 | fast_reauth=1 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 167 | |
| 168 | # OpenSSL Engine support |
Dmitry Shmidt | d5ab1b5 | 2016-06-21 12:38:41 -0700 | [diff] [blame] | 169 | # These options can be used to load OpenSSL engines in special or legacy |
| 170 | # modes. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 171 | # The two engines that are supported currently are shown below: |
| 172 | # They are both from the opensc project (http://www.opensc.org/) |
Dmitry Shmidt | d5ab1b5 | 2016-06-21 12:38:41 -0700 | [diff] [blame] | 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. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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 | |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 183 | # OpenSSL cipher string |
| 184 | # |
| 185 | # This is an OpenSSL specific configuration option for configuring the default |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 186 | # ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW" |
| 187 | # by default) is used. |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 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 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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 |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 201 | # This field can be used to configure arbitrary driver interface parameters. The |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 202 | # format is specific to the selected driver interface. This field is not used |
| 203 | # in most cases. |
| 204 | #driver_param="field=value" |
| 205 | |
| 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 | |
| 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 | |
| 218 | # Wi-Fi Protected Setup (WPS) parameters |
| 219 | |
| 220 | # Universally Unique IDentifier (UUID; see RFC 4122) of the device |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 221 | # If not configured, UUID will be generated based on the mechanism selected with |
| 222 | # the auto_uuid parameter. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 223 | #uuid=12345678-9abc-def0-1234-56789abcdef0 |
| 224 | |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 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 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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) |
| 261 | #device_type=1-0050F204-1 |
| 262 | |
| 263 | # OS Version |
| 264 | # 4-octet operating system version number (hex string) |
| 265 | #os_version=01020300 |
| 266 | |
| 267 | # Config Methods |
| 268 | # List of the supported configuration methods |
| 269 | # Available methods: usba ethernet label display ext_nfc_token int_nfc_token |
| 270 | # nfc_interface push_button keypad virtual_display physical_display |
| 271 | # virtual_push_button physical_push_button |
| 272 | # For WSC 1.0: |
| 273 | #config_methods=label display push_button keypad |
| 274 | # For WSC 2.0: |
| 275 | #config_methods=label virtual_display virtual_push_button keypad |
| 276 | |
| 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 |
| 284 | |
Hai Shalom | 021b0b5 | 2019-04-10 11:17:58 -0700 | [diff] [blame] | 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 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 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 | |
| 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 | |
Dmitry Shmidt | 7a53dbb | 2015-06-11 13:13:53 -0700 | [diff] [blame] | 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 | |
Hai Shalom | c356592 | 2019-10-28 11:58:20 -0700 | [diff] [blame] | 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 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 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 | |
Hai Shalom | 5f92bc9 | 2019-04-18 11:54:11 -0700 | [diff] [blame] | 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 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 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> |
Dmitry Shmidt | cce0666 | 2013-11-04 18:44:24 -0800 | [diff] [blame] | 354 | # autoscan is like bgscan but on disconnected or inactive state. |
| 355 | # For instance, on exponential module parameters would be <base>:<limit> |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 356 | #autoscan=exponential:3:300 |
| 357 | # Which means a delay between scans on a base exponential of 3, |
Dmitry Shmidt | cce0666 | 2013-11-04 18:44:24 -0800 | [diff] [blame] | 358 | # up to the limit of 300 seconds (3, 9, 27 ... 300) |
| 359 | # For periodic module, parameters would be <fixed interval> |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 360 | #autoscan=periodic:30 |
Dmitry Shmidt | d7ff03d | 2015-12-04 14:49:35 -0800 | [diff] [blame] | 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. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 364 | |
| 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 | |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 370 | # Password (and passphrase, etc.) backend for external storage |
| 371 | # format: <backend name>[:<optional backend parameters>] |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 372 | # Test backend which stores passwords in memory. Should only be used for |
| 373 | # development purposes. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 374 | #ext_password_backend=test:pw1=password|pw2=testing |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 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 |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 380 | |
Dmitry Shmidt | 1d755d0 | 2015-04-28 10:34:29 -0700 | [diff] [blame] | 381 | |
| 382 | # Disable P2P functionality |
| 383 | # p2p_disabled=1 |
| 384 | |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 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 | |
Dmitry Shmidt | 2271d3f | 2014-06-23 12:16:31 -0700 | [diff] [blame] | 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 | |
Dmitry Shmidt | 09f57ba | 2014-06-10 16:07:13 -0700 | [diff] [blame] | 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 | |
Sunil Ravi | 79e6c4f | 2025-01-04 00:47:06 +0000 | [diff] [blame] | 404 | # Enable/disable P2P pairing setup |
| 405 | #p2p_pairing_setup=0 |
| 406 | |
| 407 | # Enable/disable P2P pairing cache for verification |
| 408 | #p2p_pairing_cache=0 |
| 409 | |
| 410 | # Enable/disable P2P pairing verification with cached NIK/NPK |
| 411 | #p2p_pairing_verification=0 |
| 412 | |
| 413 | # Supported P2P bootstrapping method bitmap |
| 414 | # b0: whether opportunistic bootstrapping is supported |
| 415 | # b1: whether PIN display is supported |
| 416 | # b2: whether passphrase display is supported |
| 417 | # b3: whether QR Code display is supported |
| 418 | # b4: whether NFC tag is supported |
| 419 | # b5: whether keypad (PIN only) is supported |
| 420 | # b6: whether keypad (passphrase) is supported |
| 421 | # b7: whether QR Code scan is supported |
| 422 | # b8: whether NFC reader is supported |
| 423 | # b14: whether service managed bootstrapping is supported |
| 424 | # b15: whether bootstrapping handshakes skipped is supported |
| 425 | #p2p_bootstrap_methods=0 |
| 426 | |
| 427 | # Bitmap of supported PASN types |
| 428 | # B0: whether DH Group 19 with unauthenticated PASN is supported |
| 429 | # B1: whether DH Group 19 with authenticated PASN is supported |
| 430 | # B2: whether DH Group 20 with unauthenticated PASN is supported |
| 431 | # B3: whether DH Group 20 authenticated PASN is supported |
| 432 | #p2p_pasn_type=0 |
| 433 | |
| 434 | # Bootstrap request for unauthorized peer is asked to come back after |
| 435 | # this many TUs. |
| 436 | #p2p_comeback_after=977 |
| 437 | |
| 438 | # Enable/disable TWT based power management for P2P |
| 439 | #p2p_twt_power_mgmt=0 |
| 440 | |
| 441 | # Enable/disable P2P client channel switch request |
| 442 | #p2p_chan_switch_req_enable=0 |
| 443 | |
| 444 | # Regulatory info encoding for operation in 6 GHz band |
| 445 | # As defined in Table E-12 and E-13 of IEEE P802.11-REVme/D7.0. |
| 446 | #p2p_reg_info=0 |
| 447 | |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 448 | # Opportunistic Key Caching (also known as Proactive Key Caching) default |
| 449 | # This parameter can be used to set the default behavior for the |
| 450 | # proactive_key_caching parameter. By default, OKC is disabled unless enabled |
| 451 | # with the global okc=1 parameter or with the per-network |
| 452 | # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but |
| 453 | # can be disabled with per-network proactive_key_caching=0 parameter. |
| 454 | #okc=0 |
| 455 | |
| 456 | # Protected Management Frames default |
| 457 | # This parameter can be used to set the default behavior for the ieee80211w |
Dmitry Shmidt | 849734c | 2016-05-27 09:59:01 -0700 | [diff] [blame] | 458 | # parameter for RSN networks. By default, PMF is disabled unless enabled with |
| 459 | # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter. |
| 460 | # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the |
| 461 | # per-network ieee80211w parameter. This global default value does not apply |
| 462 | # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using |
| 463 | # RSN. |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 464 | #pmf=0 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 465 | |
Sunil Ravi | 77d572f | 2023-01-17 23:58:31 +0000 | [diff] [blame] | 466 | # sae_check_mfp: Require PMF support to select SAE key_mgmt |
| 467 | # 0 = Do not check PMF for SAE (default) |
| 468 | # 1 = Limit SAE when PMF is not enabled |
| 469 | # |
| 470 | # When enabled SAE will not be selected if PMF will not be used |
| 471 | # for the connection. |
| 472 | # Scenarios where this check will limit SAE: |
| 473 | # 1) ieee80211w=0 is set for the network |
| 474 | # 2) The AP does not have PMF enabled. |
| 475 | # 3) ieee80211w is unset, pmf=1 is enabled globally, and |
| 476 | # the device does not support the BIP cipher. |
| 477 | # Consider the configuration of global parameterss sae_check_mfp=1, pmf=1 and a |
| 478 | # network configured with ieee80211w unset and key_mgmt=SAE WPA-PSK. |
| 479 | # In the example WPA-PSK will be used if the device does not support |
| 480 | # the BIP cipher or the AP has PMF disabled. |
| 481 | # Limiting SAE with this check can avoid failing to associate to an AP |
| 482 | # that is configured with sae_requires_mfp=1 if the device does |
| 483 | # not support PMF due to lack of the BIP cipher. |
| 484 | # |
| 485 | # Enabling this check helps with compliance of the WPA3 |
| 486 | # specification for WPA3-Personal transition mode. |
| 487 | # The WPA3 specification section 2.3 "WPA3-Personal transition mode" item 8 |
| 488 | # states "A STA shall negotiate PMF when associating to an AP using SAE". |
| 489 | # With this check WPA3 capable devices when connecting |
| 490 | # to transition mode APs that do not advertise PMF support |
| 491 | # will not use SAE and instead fallback to PSK. |
| 492 | #sae_check_mfp=0 |
| 493 | |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 494 | # Enabled SAE finite cyclic groups in preference order |
| 495 | # By default (if this parameter is not set), the mandatory group 19 (ECC group |
Hai Shalom | 021b0b5 | 2019-04-10 11:17:58 -0700 | [diff] [blame] | 496 | # defined over a 256-bit prime order field, NIST P-256) is preferred and groups |
| 497 | # 20 (NIST P-384) and 21 (NIST P-521) are also enabled. If this parameter is |
| 498 | # set, the groups will be tried in the indicated order. |
| 499 | # The group values are listed in the IANA registry: |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 500 | # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9 |
Hai Shalom | 021b0b5 | 2019-04-10 11:17:58 -0700 | [diff] [blame] | 501 | # Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production |
| 502 | # purposes due limited security (see RFC 8247). Groups that are not as strong as |
| 503 | # group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases |
| 504 | # since all implementations are required to support group 19. |
| 505 | #sae_groups=19 20 21 |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 506 | |
Hai Shalom | c356592 | 2019-10-28 11:58:20 -0700 | [diff] [blame] | 507 | # SAE mechanism for PWE derivation |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 508 | # 0 = hunting-and-pecking loop only (default without password identifier) |
| 509 | # 1 = hash-to-element only (default with password identifier) |
Hai Shalom | c356592 | 2019-10-28 11:58:20 -0700 | [diff] [blame] | 510 | # 2 = both hunting-and-pecking loop and hash-to-element enabled |
| 511 | # Note: The default value is likely to change from 0 to 2 once the new |
| 512 | # hash-to-element mechanism has received more interoperability testing. |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 513 | # When using SAE password identifier, the hash-to-element mechanism is used |
| 514 | # regardless of the sae_pwe parameter value. |
Hai Shalom | c356592 | 2019-10-28 11:58:20 -0700 | [diff] [blame] | 515 | #sae_pwe=0 |
| 516 | |
Dmitry Shmidt | 7a5e50a | 2013-03-05 12:37:16 -0800 | [diff] [blame] | 517 | # Default value for DTIM period (if not overridden in network block) |
| 518 | #dtim_period=2 |
| 519 | |
| 520 | # Default value for Beacon interval (if not overridden in network block) |
| 521 | #beacon_int=100 |
| 522 | |
Dmitry Shmidt | 0ccb66e | 2013-03-29 16:41:28 -0700 | [diff] [blame] | 523 | # Additional vendor specific elements for Beacon and Probe Response frames |
| 524 | # This parameter can be used to add additional vendor specific element(s) into |
| 525 | # the end of the Beacon and Probe Response frames. The format for these |
| 526 | # element(s) is a hexdump of the raw information elements (id+len+payload for |
| 527 | # one or more elements). This is used in AP and P2P GO modes. |
| 528 | #ap_vendor_elements=dd0411223301 |
| 529 | |
Dmitry Shmidt | 444d567 | 2013-04-01 13:08:44 -0700 | [diff] [blame] | 530 | # Ignore scan results older than request |
| 531 | # |
| 532 | # The driver may have a cache of scan results that makes it return |
| 533 | # information that is older than our scan trigger. This parameter can |
| 534 | # be used to configure such old information to be ignored instead of |
| 535 | # allowing it to update the internal BSS table. |
| 536 | #ignore_old_scan_res=0 |
| 537 | |
Dmitry Shmidt | ea69e84 | 2013-05-13 14:52:28 -0700 | [diff] [blame] | 538 | # scan_cur_freq: Whether to scan only the current frequency |
| 539 | # 0: Scan all available frequencies. (Default) |
| 540 | # 1: Scan current operating frequency if another VIF on the same radio |
| 541 | # is already associated. |
Dmitry Shmidt | 444d567 | 2013-04-01 13:08:44 -0700 | [diff] [blame] | 542 | |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 543 | # Seconds to consider old scan results valid for association (default: 5) |
| 544 | #scan_res_valid_for_connect=5 |
| 545 | |
Dmitry Shmidt | 661b4f7 | 2014-09-29 14:58:27 -0700 | [diff] [blame] | 546 | # MAC address policy default |
| 547 | # 0 = use permanent MAC address |
| 548 | # 1 = use random MAC address for each ESS connection |
| 549 | # 2 = like 1, but maintain OUI (with local admin bit set) |
Sunil Ravi | 2a14cf1 | 2023-11-21 00:54:38 +0000 | [diff] [blame] | 550 | # 3 = use dedicated/pregenerated MAC address (see mac_value) |
Dmitry Shmidt | 661b4f7 | 2014-09-29 14:58:27 -0700 | [diff] [blame] | 551 | # |
| 552 | # By default, permanent MAC address is used unless policy is changed by |
| 553 | # the per-network mac_addr parameter. Global mac_addr=1 can be used to |
| 554 | # change this default behavior. |
| 555 | #mac_addr=0 |
| 556 | |
Sunil Ravi | 2a14cf1 | 2023-11-21 00:54:38 +0000 | [diff] [blame] | 557 | # Local MAC address to use whenever connecting with this network profile |
| 558 | # This is used with mac_addr=3. |
| 559 | #mac_value=02:12:34:56:78:9a |
| 560 | |
Dmitry Shmidt | 661b4f7 | 2014-09-29 14:58:27 -0700 | [diff] [blame] | 561 | # Lifetime of random MAC address in seconds (default: 60) |
| 562 | #rand_addr_lifetime=60 |
| 563 | |
| 564 | # MAC address policy for pre-association operations (scanning, ANQP) |
| 565 | # 0 = use permanent MAC address |
| 566 | # 1 = use random MAC address |
| 567 | # 2 = like 1, but maintain OUI (with local admin bit set) |
| 568 | #preassoc_mac_addr=0 |
| 569 | |
Dmitry Shmidt | ebd93af | 2017-02-21 13:40:44 -0800 | [diff] [blame] | 570 | # MAC address policy for GAS operations |
| 571 | # 0 = use permanent MAC address |
| 572 | # 1 = use random MAC address |
| 573 | # 2 = like 1, but maintain OUI (with local admin bit set) |
Hai Shalom | b755a2a | 2020-04-23 21:49:02 -0700 | [diff] [blame] | 574 | # Note that this setting is ignored when a specific MAC address is needed for |
| 575 | # a full protocol exchange that includes GAS, e.g., when going through a DPP |
| 576 | # exchange that exposes the configured interface address as part of the DP |
| 577 | # Public Action frame exchanges before using GAS. That same address is then used |
| 578 | # during the GAS exchange as well to avoid breaking the protocol expectations. |
Dmitry Shmidt | ebd93af | 2017-02-21 13:40:44 -0800 | [diff] [blame] | 579 | #gas_rand_mac_addr=0 |
| 580 | |
| 581 | # Lifetime of GAS random MAC address in seconds (default: 60) |
| 582 | #gas_rand_addr_lifetime=60 |
| 583 | |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 584 | # Interworking (IEEE 802.11u) |
| 585 | |
| 586 | # Enable Interworking |
| 587 | # interworking=1 |
| 588 | |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 589 | # Enable P2P GO advertisement of Interworking |
| 590 | # go_interworking=1 |
| 591 | |
| 592 | # P2P GO Interworking: Access Network Type |
| 593 | # 0 = Private network |
| 594 | # 1 = Private network with guest access |
| 595 | # 2 = Chargeable public network |
| 596 | # 3 = Free public network |
| 597 | # 4 = Personal device network |
| 598 | # 5 = Emergency services only network |
| 599 | # 14 = Test or experimental |
| 600 | # 15 = Wildcard |
| 601 | #go_access_network_type=0 |
| 602 | |
| 603 | # P2P GO Interworking: Whether the network provides connectivity to the Internet |
| 604 | # 0 = Unspecified |
| 605 | # 1 = Network provides connectivity to the Internet |
| 606 | #go_internet=1 |
| 607 | |
| 608 | # P2P GO Interworking: Group Venue Info (optional) |
| 609 | # The available values are defined in IEEE Std 802.11-2016, 9.4.1.35. |
| 610 | # Example values (group,type): |
| 611 | # 0,0 = Unspecified |
| 612 | # 1,7 = Convention Center |
| 613 | # 1,13 = Coffee Shop |
| 614 | # 2,0 = Unspecified Business |
| 615 | # 7,1 Private Residence |
| 616 | #go_venue_group=7 |
| 617 | #go_venue_type=1 |
| 618 | |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 619 | # Homogeneous ESS identifier |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 620 | # If this is set, scans will be used to request response only from BSSes |
| 621 | # belonging to the specified Homogeneous ESS. This is used only if interworking |
| 622 | # is enabled. |
| 623 | # hessid=00:11:22:33:44:55 |
| 624 | |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 625 | # Automatic network selection behavior |
| 626 | # 0 = do not automatically go through Interworking network selection |
| 627 | # (i.e., require explicit interworking_select command for this; default) |
| 628 | # 1 = perform Interworking network selection if one or more |
| 629 | # credentials have been configured and scan did not find a |
| 630 | # matching network block |
| 631 | #auto_interworking=0 |
| 632 | |
Dmitry Shmidt | d5ab1b5 | 2016-06-21 12:38:41 -0700 | [diff] [blame] | 633 | # GAS Address3 field behavior |
| 634 | # 0 = P2P specification (Address3 = AP BSSID); default |
| 635 | # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when |
| 636 | # sent to not-associated AP; if associated, AP BSSID) |
| 637 | #gas_address3=0 |
| 638 | |
Dmitry Shmidt | 7d17530 | 2016-09-06 13:11:34 -0700 | [diff] [blame] | 639 | # Publish fine timing measurement (FTM) responder functionality in |
| 640 | # the Extended Capabilities element bit 70. |
| 641 | # Controls whether FTM responder functionality will be published by AP/STA. |
| 642 | # Note that actual FTM responder operation is managed outside wpa_supplicant. |
| 643 | # 0 = Do not publish; default |
| 644 | # 1 = Publish |
| 645 | #ftm_responder=0 |
| 646 | |
| 647 | # Publish fine timing measurement (FTM) initiator functionality in |
| 648 | # the Extended Capabilities element bit 71. |
| 649 | # Controls whether FTM initiator functionality will be published by AP/STA. |
| 650 | # Note that actual FTM initiator operation is managed outside wpa_supplicant. |
| 651 | # 0 = Do not publish; default |
| 652 | # 1 = Publish |
| 653 | #ftm_initiator=0 |
| 654 | |
Sunil Ravi | 79e6c4f | 2025-01-04 00:47:06 +0000 | [diff] [blame] | 655 | #twt_requester: Whether TWT requester is enabled |
| 656 | # 0 = disabled (default) |
| 657 | # 1 = enabled if supported by the driver |
| 658 | #twt_requester=0 |
| 659 | |
| 660 | # Wi-Fi Alliance generational capabilities indication |
| 661 | # |
| 662 | # wfa_gen_capa: Whether to indicate Wi-Fi generational capability to the AP |
| 663 | # 0 = do not indicate (default) |
| 664 | # 1 = indicate in protected Action frame |
| 665 | # 2 = indicate in unprotected (Re)Association Request frame |
| 666 | #wfa_gen_capa=0 |
| 667 | # |
| 668 | # wfa_gen_capa_supp: Supported Generations (hexdump of a bit field) |
| 669 | # A bit field of supported Wi-Fi generations. This is encoded as an little |
| 670 | # endian octet string. If this is not set, the driver capabilities are |
| 671 | # determined automatically. |
| 672 | # bit 0: Wi-Fi 4 |
| 673 | # bit 1: Wi-Fi 5 |
| 674 | # bit 2: Wi-Fi 6 |
| 675 | # bit 3: Wi-Fi 7 |
| 676 | #wfa_gen_capa_supp=07 |
| 677 | # |
| 678 | # wfa_gen_capa_cert: Certified Generations (hexdump of a bit field) |
| 679 | # This has the same format as wfa_gen_capa_supp. This is an optional field, but |
| 680 | # if included, shall have the same length as wfa_gen_capa_supp. |
| 681 | #wfa_gen_capa_cert=07 |
| 682 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 683 | # credential block |
| 684 | # |
| 685 | # Each credential used for automatic network selection is configured as a set |
| 686 | # of parameters that are compared to the information advertised by the APs when |
| 687 | # interworking_select and interworking_connect commands are used. |
| 688 | # |
| 689 | # credential fields: |
| 690 | # |
Dmitry Shmidt | fb79edc | 2014-01-10 10:45:54 -0800 | [diff] [blame] | 691 | # temporary: Whether this credential is temporary and not to be saved |
| 692 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 693 | # priority: Priority group |
| 694 | # By default, all networks and credentials get the same priority group |
| 695 | # (0). This field can be used to give higher priority for credentials |
| 696 | # (and similarly in struct wpa_ssid for network blocks) to change the |
| 697 | # Interworking automatic networking selection behavior. The matching |
| 698 | # network (based on either an enabled network block or a credential) |
| 699 | # with the highest priority value will be selected. |
| 700 | # |
| 701 | # pcsc: Use PC/SC and SIM/USIM card |
| 702 | # |
| 703 | # realm: Home Realm for Interworking |
| 704 | # |
| 705 | # username: Username for Interworking network selection |
| 706 | # |
| 707 | # password: Password for Interworking network selection |
| 708 | # |
| 709 | # ca_cert: CA certificate for Interworking network selection |
| 710 | # |
| 711 | # client_cert: File path to client certificate file (PEM/DER) |
| 712 | # This field is used with Interworking networking selection for a case |
| 713 | # where client certificate/private key is used for authentication |
| 714 | # (EAP-TLS). Full path to the file should be used since working |
| 715 | # directory may change when wpa_supplicant is run in the background. |
| 716 | # |
Dmitry Shmidt | d5ab1b5 | 2016-06-21 12:38:41 -0700 | [diff] [blame] | 717 | # Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI. |
| 718 | # |
| 719 | # For example: private_key="pkcs11:manufacturer=piv_II;id=%01" |
| 720 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 721 | # Alternatively, a named configuration blob can be used by setting |
| 722 | # this to blob://blob_name. |
| 723 | # |
| 724 | # private_key: File path to client private key file (PEM/DER/PFX) |
| 725 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be |
| 726 | # commented out. Both the private key and certificate will be read |
| 727 | # from the PKCS#12 file in this case. Full path to the file should be |
| 728 | # used since working directory may change when wpa_supplicant is run |
| 729 | # in the background. |
| 730 | # |
Dmitry Shmidt | d5ab1b5 | 2016-06-21 12:38:41 -0700 | [diff] [blame] | 731 | # Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI. |
| 732 | # For example: private_key="pkcs11:manufacturer=piv_II;id=%01" |
| 733 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 734 | # Windows certificate store can be used by leaving client_cert out and |
| 735 | # configuring private_key in one of the following formats: |
| 736 | # |
| 737 | # cert://substring_to_match |
| 738 | # |
| 739 | # hash://certificate_thumbprint_in_hex |
| 740 | # |
| 741 | # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4" |
| 742 | # |
| 743 | # Note that when running wpa_supplicant as an application, the user |
| 744 | # certificate store (My user account) is used, whereas computer store |
| 745 | # (Computer account) is used when running wpasvc as a service. |
| 746 | # |
| 747 | # Alternatively, a named configuration blob can be used by setting |
| 748 | # this to blob://blob_name. |
| 749 | # |
| 750 | # private_key_passwd: Password for private key file |
| 751 | # |
| 752 | # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format |
| 753 | # |
| 754 | # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN> |
| 755 | # format |
| 756 | # |
Dmitry Shmidt | 051af73 | 2013-10-22 13:52:46 -0700 | [diff] [blame] | 757 | # domain: Home service provider FQDN(s) |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 758 | # This is used to compare against the Domain Name List to figure out |
Dmitry Shmidt | 051af73 | 2013-10-22 13:52:46 -0700 | [diff] [blame] | 759 | # whether the AP is operated by the Home SP. Multiple domain entries can |
| 760 | # be used to configure alternative FQDNs that will be considered home |
| 761 | # networks. |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 762 | # |
Sunil Ravi | 77d572f | 2023-01-17 23:58:31 +0000 | [diff] [blame] | 763 | # home_ois: Home OI(s) |
| 764 | # This string field contains one or more comma delimited OIs (hexdump) |
| 765 | # identifying the access the access points that support authentication |
| 766 | # with this credential. There are an alternative to the use of the realm |
| 767 | # parameter. When using Home OIs to match the network, the EAP parameters |
| 768 | # need to be pre-configured with the credentials since the NAI Realm |
| 769 | # information may not be available or fetched. |
| 770 | # A successful authentication with the access point is possible as soon |
| 771 | # as at least one Home OI from the list matches an OI in the Roaming |
| 772 | # Consortium advertised by the access point. |
| 773 | # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOI) |
| 774 | # |
| 775 | # required_home_ois: Required Home OI(s) |
| 776 | # This string field contains the set of Home OI(s) (hexdump) that are |
| 777 | # required to be advertised by the AP for the credential to be considered |
| 778 | # matching. |
| 779 | # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOIRequired) |
| 780 | # |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 781 | # roaming_consortium: Roaming Consortium OI |
Sunil Ravi | 77d572f | 2023-01-17 23:58:31 +0000 | [diff] [blame] | 782 | # Deprecated: use home_ois instead. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 783 | # If roaming_consortium_len is non-zero, this field contains the |
| 784 | # Roaming Consortium OI that can be used to determine which access |
| 785 | # points support authentication with this credential. This is an |
| 786 | # alternative to the use of the realm parameter. When using Roaming |
| 787 | # Consortium to match the network, the EAP parameters need to be |
| 788 | # pre-configured with the credential since the NAI Realm information |
| 789 | # may not be available or fetched. |
| 790 | # |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 791 | # required_roaming_consortium: Required Roaming Consortium OI |
Sunil Ravi | 77d572f | 2023-01-17 23:58:31 +0000 | [diff] [blame] | 792 | # Deprecated: use required_home_ois instead. |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 793 | # If required_roaming_consortium_len is non-zero, this field contains the |
| 794 | # Roaming Consortium OI that is required to be advertised by the AP for |
| 795 | # the credential to be considered matching. |
| 796 | # |
| 797 | # roaming_consortiums: Roaming Consortium OI(s) memberships |
| 798 | # This string field contains one or more comma delimited OIs (hexdump) |
| 799 | # identifying the roaming consortiums of which the provider is a member. |
| 800 | # The list is sorted from the most preferred one to the least preferred |
| 801 | # one. A match between the Roaming Consortium OIs advertised by an AP and |
| 802 | # the OIs in this list indicates that successful authentication is |
| 803 | # possible. |
| 804 | # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI) |
| 805 | # |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 806 | # eap: Pre-configured EAP method |
| 807 | # This optional field can be used to specify which EAP method will be |
| 808 | # used with this credential. If not set, the EAP method is selected |
| 809 | # automatically based on ANQP information (e.g., NAI Realm). |
| 810 | # |
| 811 | # phase1: Pre-configure Phase 1 (outer authentication) parameters |
| 812 | # This optional field is used with like the 'eap' parameter. |
| 813 | # |
| 814 | # phase2: Pre-configure Phase 2 (inner authentication) parameters |
| 815 | # This optional field is used with like the 'eap' parameter. |
| 816 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 817 | # excluded_ssid: Excluded SSID |
| 818 | # This optional field can be used to excluded specific SSID(s) from |
| 819 | # matching with the network. Multiple entries can be used to specify more |
| 820 | # than one SSID. |
| 821 | # |
Dmitry Shmidt | f21452a | 2014-02-26 10:55:25 -0800 | [diff] [blame] | 822 | # roaming_partner: Roaming partner information |
| 823 | # This optional field can be used to configure preferences between roaming |
| 824 | # partners. The field is a string in following format: |
| 825 | # <FQDN>,<0/1 exact match>,<priority>,<* or country code> |
| 826 | # (non-exact match means any subdomain matches the entry; priority is in |
| 827 | # 0..255 range with 0 being the highest priority) |
| 828 | # |
| 829 | # update_identifier: PPS MO ID |
| 830 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) |
| 831 | # |
| 832 | # provisioning_sp: FQDN of the SP that provisioned the credential |
| 833 | # This optional field can be used to keep track of the SP that provisioned |
| 834 | # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>). |
| 835 | # |
| 836 | # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*) |
| 837 | # These fields can be used to specify minimum download/upload backhaul |
| 838 | # bandwidth that is preferred for the credential. This constraint is |
| 839 | # ignored if the AP does not advertise WAN Metrics information or if the |
| 840 | # limit would prevent any connection. Values are in kilobits per second. |
| 841 | # min_dl_bandwidth_home |
| 842 | # min_ul_bandwidth_home |
| 843 | # min_dl_bandwidth_roaming |
| 844 | # min_ul_bandwidth_roaming |
| 845 | # |
| 846 | # max_bss_load: Maximum BSS Load Channel Utilization (1..255) |
| 847 | # (PPS/<X+>/Policy/MaximumBSSLoadValue) |
| 848 | # This value is used as the maximum channel utilization for network |
| 849 | # selection purposes for home networks. If the AP does not advertise |
| 850 | # BSS Load or if the limit would prevent any connection, this constraint |
| 851 | # will be ignored. |
| 852 | # |
| 853 | # req_conn_capab: Required connection capability |
| 854 | # (PPS/<X+>/Policy/RequiredProtoPortTuple) |
| 855 | # This value is used to configure set of required protocol/port pairs that |
| 856 | # a roaming network shall support (include explicitly in Connection |
| 857 | # Capability ANQP element). This constraint is ignored if the AP does not |
| 858 | # advertise Connection Capability or if this constraint would prevent any |
| 859 | # network connection. This policy is not used in home networks. |
| 860 | # Format: <protocol>[:<comma-separated list of ports] |
| 861 | # Multiple entries can be used to list multiple requirements. |
| 862 | # For example, number of common TCP protocols: |
| 863 | # req_conn_capab=6,22,80,443 |
| 864 | # For example, IPSec/IKE: |
| 865 | # req_conn_capab=17:500 |
| 866 | # req_conn_capab=50 |
| 867 | # |
| 868 | # ocsp: Whether to use/require OCSP to check server certificate |
| 869 | # 0 = do not use OCSP stapling (TLS certificate status extension) |
| 870 | # 1 = try to use OCSP stapling, but not require response |
| 871 | # 2 = require valid OCSP stapling response |
Dmitry Shmidt | 014a3ff | 2015-12-28 13:27:49 -0800 | [diff] [blame] | 872 | # 3 = require valid OCSP stapling response for all not-trusted |
| 873 | # certificates in the server certificate chain |
Dmitry Shmidt | f21452a | 2014-02-26 10:55:25 -0800 | [diff] [blame] | 874 | # |
Dmitry Shmidt | f9bdef9 | 2014-04-25 10:46:36 -0700 | [diff] [blame] | 875 | # sim_num: Identifier for which SIM to use in multi-SIM devices |
| 876 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 877 | # for example: |
| 878 | # |
| 879 | #cred={ |
| 880 | # realm="example.com" |
| 881 | # username="user@example.com" |
| 882 | # password="password" |
| 883 | # ca_cert="/etc/wpa_supplicant/ca.pem" |
| 884 | # domain="example.com" |
| 885 | #} |
| 886 | # |
| 887 | #cred={ |
| 888 | # imsi="310026-000000000" |
| 889 | # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82" |
| 890 | #} |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 891 | # |
| 892 | #cred={ |
| 893 | # realm="example.com" |
| 894 | # username="user" |
| 895 | # password="password" |
| 896 | # ca_cert="/etc/wpa_supplicant/ca.pem" |
| 897 | # domain="example.com" |
Sunil Ravi | 77d572f | 2023-01-17 23:58:31 +0000 | [diff] [blame] | 898 | # home_ois="223344" |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 899 | # eap=TTLS |
| 900 | # phase2="auth=MSCHAPV2" |
| 901 | #} |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 902 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 903 | # Hotspot 2.0 |
| 904 | # hs20=1 |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 905 | |
Dmitry Shmidt | d7ff03d | 2015-12-04 14:49:35 -0800 | [diff] [blame] | 906 | # Scheduled scan plans |
| 907 | # |
| 908 | # A space delimited list of scan plans. Each scan plan specifies the scan |
| 909 | # interval and number of iterations, delimited by a colon. The last scan plan |
| 910 | # will run infinitely and thus must specify only the interval and not the number |
| 911 | # of iterations. |
| 912 | # |
| 913 | # The driver advertises the maximum number of scan plans supported. If more scan |
| 914 | # plans than supported are configured, only the first ones are set (up to the |
| 915 | # maximum supported). The last scan plan that specifies only the interval is |
| 916 | # always set as the last plan. |
| 917 | # |
| 918 | # If the scan interval or the number of iterations for a scan plan exceeds the |
| 919 | # maximum supported, it will be set to the maximum supported value. |
| 920 | # |
| 921 | # Format: |
| 922 | # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval> |
| 923 | # |
| 924 | # Example: |
| 925 | # sched_scan_plans=10:100 20:200 30 |
| 926 | |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 927 | # Multi Band Operation (MBO) non-preferred channels |
| 928 | # A space delimited list of non-preferred channels where each channel is a colon |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 929 | # delimited list of values. |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 930 | # Format: |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 931 | # non_pref_chan=<oper_class>:<chan>:<preference>:<reason> |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 932 | # Example: |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 933 | # non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2 |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 934 | |
| 935 | # MBO Cellular Data Capabilities |
| 936 | # 1 = Cellular data connection available |
| 937 | # 2 = Cellular data connection not available |
| 938 | # 3 = Not cellular capable (default) |
| 939 | #mbo_cell_capa=3 |
| 940 | |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 941 | # Optimized Connectivity Experience (OCE) |
| 942 | # oce: Enable OCE features (bitmap) |
| 943 | # Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver |
| 944 | # does not indicate support for OCE in STA mode) |
| 945 | # Set BIT(1) to Enable OCE in STA-CFON mode |
| 946 | #oce=1 |
| 947 | |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 948 | # Extended Key ID support for Individually Addressed frames |
| 949 | # 0 = force off: Do not use Extended Key ID (default) |
| 950 | # 1 = auto: Activate Extended Key ID support if the driver supports it |
| 951 | #extended_key_id=0 |
| 952 | |
Sunil Ravi | 7f76929 | 2024-07-23 22:21:32 +0000 | [diff] [blame] | 953 | # RSN overriding |
| 954 | # NOTE: The protocol used for this mechanism is still subject to change and as |
| 955 | # such, this should not yet be enabled for production uses to avoid issues if |
| 956 | # something were to change. |
Sunil Ravi | 79e6c4f | 2025-01-04 00:47:06 +0000 | [diff] [blame] | 957 | # A per-network block parameter with the same name can be used to override this |
| 958 | # global parameter. |
Sunil Ravi | 7f76929 | 2024-07-23 22:21:32 +0000 | [diff] [blame] | 959 | # 0 = Disabled (default) |
| 960 | # 1 = Enabled automatically if the driver indicates support |
| 961 | # 2 = Forced to be enabled even without driver capability indication |
| 962 | #rsn_overriding=0 |
| 963 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 964 | # network block |
| 965 | # |
| 966 | # Each network (usually AP's sharing the same SSID) is configured as a separate |
| 967 | # block in this configuration file. The network blocks are in preference order |
| 968 | # (the first match is used). |
| 969 | # |
| 970 | # network block fields: |
| 971 | # |
| 972 | # disabled: |
| 973 | # 0 = this network can be used (default) |
| 974 | # 1 = this network block is disabled (can be enabled through ctrl_iface, |
| 975 | # e.g., with wpa_cli or wpa_gui) |
| 976 | # |
| 977 | # id_str: Network identifier string for external scripts. This value is passed |
| 978 | # to external action script through wpa_cli as WPA_ID_STR environment |
| 979 | # variable to make it easier to do network specific configuration. |
| 980 | # |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 981 | # ssid: SSID (mandatory); network name in one of the optional formats: |
| 982 | # - an ASCII string with double quotation |
| 983 | # - a hex string (two characters per octet of SSID) |
| 984 | # - a printf-escaped ASCII string P"<escaped string>" |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 985 | # |
| 986 | # scan_ssid: |
| 987 | # 0 = do not scan this SSID with specific Probe Request frames (default) |
| 988 | # 1 = scan with SSID-specific Probe Request frames (this can be used to |
| 989 | # find APs that do not accept broadcast SSID or use multiple SSIDs; |
| 990 | # this will add latency to scanning, so enable this only when needed) |
| 991 | # |
| 992 | # bssid: BSSID (optional); if set, this network block is used only when |
| 993 | # associating with the AP using the configured BSSID |
| 994 | # |
Hai Shalom | 899fcc7 | 2020-10-19 14:38:18 -0700 | [diff] [blame] | 995 | # ignore_broadcast_ssid: SSID broadcast behavior |
| 996 | # Send empty SSID in beacons and ignore probe request frames that do not |
| 997 | # specify full SSID, i.e., require stations to know SSID. |
| 998 | # default: disabled (0) |
| 999 | # 1 = send empty (length=0) SSID in beacon and ignore probe request for |
| 1000 | # broadcast SSID |
| 1001 | # 2 = clear SSID (ASCII 0), but keep the original length (this may be required |
| 1002 | # with some clients that do not support empty SSID) and ignore probe |
| 1003 | # requests for broadcast SSID |
| 1004 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1005 | # priority: priority group (integer) |
| 1006 | # By default, all networks will get same priority group (0). If some of the |
| 1007 | # networks are more desirable, this field can be used to change the order in |
| 1008 | # which wpa_supplicant goes through the networks when selecting a BSS. The |
| 1009 | # priority groups will be iterated in decreasing priority (i.e., the larger the |
| 1010 | # priority value, the sooner the network is matched against the scan results). |
| 1011 | # Within each priority group, networks will be selected based on security |
| 1012 | # policy, signal strength, etc. |
| 1013 | # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not |
| 1014 | # using this priority to select the order for scanning. Instead, they try the |
| 1015 | # networks in the order that used in the configuration file. |
| 1016 | # |
| 1017 | # mode: IEEE 802.11 operation mode |
| 1018 | # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default) |
| 1019 | # 1 = IBSS (ad-hoc, peer-to-peer) |
| 1020 | # 2 = AP (access point) |
Dmitry Shmidt | fb79edc | 2014-01-10 10:45:54 -0800 | [diff] [blame] | 1021 | # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and |
| 1022 | # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key |
| 1023 | # TKIP/CCMP) is available for backwards compatibility, but its use is |
| 1024 | # deprecated. WPA-None requires following network block options: |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1025 | # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not |
| 1026 | # both), and psk must also be set. |
| 1027 | # |
| 1028 | # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g., |
| 1029 | # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial |
| 1030 | # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode. |
| 1031 | # In addition, this value is only used by the station that creates the IBSS. If |
| 1032 | # an IBSS network with the configured SSID is already present, the frequency of |
| 1033 | # the network will be used instead of this configured value. |
| 1034 | # |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 1035 | # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only. |
Dmitry Shmidt | 849734c | 2016-05-27 09:59:01 -0700 | [diff] [blame] | 1036 | # 0 = do not use PBSS |
| 1037 | # 1 = use PBSS |
| 1038 | # 2 = don't care (not allowed in AP mode) |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 1039 | # Used together with mode configuration. When mode is AP, it means to start a |
| 1040 | # PCP instead of a regular AP. When mode is infrastructure it means connect |
Dmitry Shmidt | 849734c | 2016-05-27 09:59:01 -0700 | [diff] [blame] | 1041 | # to a PCP instead of AP. In this mode you can also specify 2 (don't care) |
| 1042 | # which means connect to either PCP or AP. |
| 1043 | # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network. |
Dmitry Shmidt | 57c2d39 | 2016-02-23 13:40:19 -0800 | [diff] [blame] | 1044 | # For more details, see IEEE Std 802.11ad-2012. |
| 1045 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1046 | # scan_freq: List of frequencies to scan |
| 1047 | # Space-separated list of frequencies in MHz to scan when searching for this |
| 1048 | # BSS. If the subset of channels used by the network is known, this option can |
| 1049 | # be used to optimize scanning to not occur on channels that the network does |
| 1050 | # not use. Example: scan_freq=2412 2437 2462 |
| 1051 | # |
| 1052 | # freq_list: Array of allowed frequencies |
| 1053 | # Space-separated list of frequencies in MHz to allow for selecting the BSS. If |
| 1054 | # set, scan results that do not match any of the specified frequencies are not |
| 1055 | # considered when selecting a BSS. |
| 1056 | # |
Dmitry Shmidt | 51b6ea8 | 2013-05-08 10:42:09 -0700 | [diff] [blame] | 1057 | # This can also be set on the outside of the network block. In this case, |
| 1058 | # it limits the frequencies that will be scanned. |
| 1059 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1060 | # bgscan: Background scanning |
| 1061 | # wpa_supplicant behavior for background scanning can be specified by |
| 1062 | # configuring a bgscan module. These modules are responsible for requesting |
| 1063 | # background scans for the purpose of roaming within an ESS (i.e., within a |
| 1064 | # single network block with all the APs using the same SSID). The bgscan |
| 1065 | # parameter uses following format: "<bgscan module name>:<module parameters>" |
| 1066 | # Following bgscan modules are available: |
| 1067 | # simple - Periodic background scans based on signal strength |
Sunil Ravi | b0ac25f | 2024-07-12 01:42:03 +0000 | [diff] [blame] | 1068 | # send_btm_query > 0 means do this many BTM queries before attempting a scan. |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1069 | # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>: |
Sunil Ravi | b0ac25f | 2024-07-12 01:42:03 +0000 | [diff] [blame] | 1070 | # <long interval>[:<send_btm_query>]" |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1071 | # bgscan="simple:30:-45:300" |
Sunil Ravi | b0ac25f | 2024-07-12 01:42:03 +0000 | [diff] [blame] | 1072 | # bgscan="simple:30:-45:300:3" |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1073 | # learn - Learn channels used by the network and try to avoid bgscans on other |
| 1074 | # channels (experimental) |
| 1075 | # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>: |
| 1076 | # <long interval>[:<database file name>]" |
| 1077 | # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan" |
Dmitry Shmidt | a38abf9 | 2014-03-06 13:38:44 -0800 | [diff] [blame] | 1078 | # Explicitly disable bgscan by setting |
| 1079 | # bgscan="" |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1080 | # |
Dmitry Shmidt | b96dad4 | 2013-11-05 10:07:29 -0800 | [diff] [blame] | 1081 | # This option can also be set outside of all network blocks for the bgscan |
| 1082 | # parameter to apply for all the networks that have no specific bgscan |
| 1083 | # parameter. |
| 1084 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1085 | # proto: list of accepted protocols |
| 1086 | # WPA = WPA/IEEE 802.11i/D3.0 |
| 1087 | # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN) |
Hai Shalom | ce48b4a | 2018-09-05 11:41:35 -0700 | [diff] [blame] | 1088 | # Note that RSN is used also for WPA3. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1089 | # If not set, this defaults to: WPA RSN |
| 1090 | # |
| 1091 | # key_mgmt: list of accepted authenticated key management protocols |
| 1092 | # WPA-PSK = WPA pre-shared key (this requires 'psk' field) |
| 1093 | # WPA-EAP = WPA using EAP authentication |
| 1094 | # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically |
| 1095 | # generated WEP keys |
| 1096 | # NONE = WPA is not used; plaintext or static WEP could be used |
Dmitry Shmidt | 014a3ff | 2015-12-28 13:27:49 -0800 | [diff] [blame] | 1097 | # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK |
| 1098 | # instead) |
| 1099 | # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key |
| 1100 | # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 1101 | # FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication |
| 1102 | # and using SHA384 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1103 | # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms |
| 1104 | # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms |
Dmitry Shmidt | 014a3ff | 2015-12-28 13:27:49 -0800 | [diff] [blame] | 1105 | # SAE = Simultaneous authentication of equals; pre-shared key/password -based |
| 1106 | # authentication with stronger security than WPA-PSK especially when using |
Hai Shalom | ce48b4a | 2018-09-05 11:41:35 -0700 | [diff] [blame] | 1107 | # not that strong password; a.k.a. WPA3-Personal |
Dmitry Shmidt | 014a3ff | 2015-12-28 13:27:49 -0800 | [diff] [blame] | 1108 | # FT-SAE = SAE with FT |
| 1109 | # WPA-EAP-SUITE-B = Suite B 128-bit level |
| 1110 | # WPA-EAP-SUITE-B-192 = Suite B 192-bit level |
Dmitry Shmidt | de47be7 | 2016-01-07 12:52:55 -0800 | [diff] [blame] | 1111 | # OSEN = Hotspot 2.0 Rel 2 online signup connection |
Dmitry Shmidt | 9839ecd | 2016-11-07 11:05:47 -0800 | [diff] [blame] | 1112 | # FILS-SHA256 = Fast Initial Link Setup with SHA256 |
| 1113 | # FILS-SHA384 = Fast Initial Link Setup with SHA384 |
| 1114 | # FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256 |
| 1115 | # FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384 |
Hai Shalom | ce48b4a | 2018-09-05 11:41:35 -0700 | [diff] [blame] | 1116 | # OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open) |
| 1117 | # DPP = Device Provisioning Protocol |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1118 | # If not set, this defaults to: WPA-PSK WPA-EAP |
| 1119 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 1120 | # ieee80211w: whether management frame protection is enabled |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 1121 | # 0 = disabled (default unless changed with the global pmf parameter) |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 1122 | # 1 = optional |
| 1123 | # 2 = required |
| 1124 | # The most common configuration options for this based on the PMF (protected |
| 1125 | # management frames) certification program are: |
| 1126 | # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256 |
| 1127 | # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256 |
Ahmed ElArabawy | 0ff61c5 | 2019-12-26 12:38:39 -0800 | [diff] [blame] | 1128 | # (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used) |
| 1129 | # WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 1130 | # |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1131 | # ocv: whether operating channel validation is enabled |
Hai Shalom | a20dcd7 | 2022-02-04 13:43:00 -0800 | [diff] [blame] | 1132 | # This is a countermeasure against multi-channel on-path attacks. |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1133 | # Enabling this automatically also enables ieee80211w, if not yet enabled. |
| 1134 | # 0 = disabled (default) |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 1135 | # 1 = enabled if wpa_supplicant's SME in use. Otherwise enabled only when the |
| 1136 | # driver indicates support for operating channel validation. |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1137 | #ocv=1 |
| 1138 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1139 | # auth_alg: list of allowed IEEE 802.11 authentication algorithms |
| 1140 | # OPEN = Open System authentication (required for WPA/WPA2) |
| 1141 | # SHARED = Shared Key authentication (requires static WEP keys) |
| 1142 | # LEAP = LEAP/Network EAP (only used with LEAP) |
| 1143 | # If not set, automatic selection is used (Open System with LEAP enabled if |
| 1144 | # LEAP is allowed as one of the EAP methods). |
| 1145 | # |
| 1146 | # pairwise: list of accepted pairwise (unicast) ciphers for WPA |
| 1147 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] |
| 1148 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] |
| 1149 | # NONE = Use only Group Keys (deprecated, should not be included if APs support |
| 1150 | # pairwise keys) |
| 1151 | # If not set, this defaults to: CCMP TKIP |
| 1152 | # |
| 1153 | # group: list of accepted group (broadcast/multicast) ciphers for WPA |
| 1154 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] |
| 1155 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] |
| 1156 | # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key |
| 1157 | # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11] |
| 1158 | # If not set, this defaults to: CCMP TKIP WEP104 WEP40 |
| 1159 | # |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 1160 | # group_mgmt: list of accepted group management ciphers for RSN (PMF) |
| 1161 | # AES-128-CMAC = BIP-CMAC-128 |
| 1162 | # BIP-GMAC-128 |
| 1163 | # BIP-GMAC-256 |
| 1164 | # BIP-CMAC-256 |
| 1165 | # If not set, no constraint on the cipher, i.e., accept whichever cipher the AP |
| 1166 | # indicates. |
| 1167 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1168 | # psk: WPA preshared key; 256-bit pre-shared key |
| 1169 | # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e., |
| 1170 | # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be |
| 1171 | # generated using the passphrase and SSID). ASCII passphrase must be between |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 1172 | # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can |
| 1173 | # be used to indicate that the PSK/passphrase is stored in external storage. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1174 | # This field is not needed, if WPA-EAP is used. |
| 1175 | # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys |
| 1176 | # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant |
| 1177 | # startup and reconfiguration time can be optimized by generating the PSK only |
| 1178 | # only when the passphrase or SSID has actually changed. |
| 1179 | # |
Dmitry Shmidt | 912c6ec | 2015-03-30 13:16:51 -0700 | [diff] [blame] | 1180 | # mem_only_psk: Whether to keep PSK/passphrase only in memory |
| 1181 | # 0 = allow psk/passphrase to be stored to the configuration file |
| 1182 | # 1 = do not store psk/passphrase to the configuration file |
| 1183 | #mem_only_psk=0 |
| 1184 | # |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 1185 | # sae_password: SAE password |
| 1186 | # This parameter can be used to set a password for SAE. By default, the |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 1187 | # passphrase from the psk parameter is used if this separate parameter is not |
| 1188 | # used, but psk follows the WPA-PSK constraints (8..63 characters) even though |
| 1189 | # SAE passwords do not have such constraints. |
| 1190 | # |
| 1191 | # sae_password_id: SAE password identifier |
| 1192 | # This parameter can be used to set an identifier for the SAE password. By |
| 1193 | # default, no such identifier is used. If set, the specified identifier value |
| 1194 | # is used by the other peer to select which password to use for authentication. |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 1195 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1196 | # eapol_flags: IEEE 802.1X/EAPOL options (bit field) |
| 1197 | # Dynamic WEP key required for non-WPA mode |
| 1198 | # bit0 (1): require dynamically generated unicast WEP key |
| 1199 | # bit1 (2): require dynamically generated broadcast WEP key |
| 1200 | # (3 = require both keys; default) |
Dmitry Shmidt | abb90a3 | 2016-12-05 15:34:39 -0800 | [diff] [blame] | 1201 | # Note: When using wired authentication (including MACsec drivers), |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 1202 | # eapol_flags must be set to 0 for the authentication to be completed |
| 1203 | # successfully. |
| 1204 | # |
| 1205 | # macsec_policy: IEEE 802.1X/MACsec options |
Dmitry Shmidt | abb90a3 | 2016-12-05 15:34:39 -0800 | [diff] [blame] | 1206 | # This determines how sessions are secured with MACsec (only for MACsec |
| 1207 | # drivers). |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 1208 | # 0: MACsec not in use (default) |
| 1209 | # 1: MACsec enabled - Should secure, accept key server's advice to |
| 1210 | # determine whether to use a secure session or not. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1211 | # |
Dmitry Shmidt | abb90a3 | 2016-12-05 15:34:39 -0800 | [diff] [blame] | 1212 | # macsec_integ_only: IEEE 802.1X/MACsec transmit mode |
| 1213 | # This setting applies only when MACsec is in use, i.e., |
| 1214 | # - macsec_policy is enabled |
| 1215 | # - the key server has decided to enable MACsec |
| 1216 | # 0: Encrypt traffic (default) |
| 1217 | # 1: Integrity only |
| 1218 | # |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1219 | # macsec_replay_protect: IEEE 802.1X/MACsec replay protection |
| 1220 | # This setting applies only when MACsec is in use, i.e., |
| 1221 | # - macsec_policy is enabled |
| 1222 | # - the key server has decided to enable MACsec |
| 1223 | # 0: Replay protection disabled (default) |
| 1224 | # 1: Replay protection enabled |
| 1225 | # |
| 1226 | # macsec_replay_window: IEEE 802.1X/MACsec replay protection window |
| 1227 | # This determines a window in which replay is tolerated, to allow receipt |
| 1228 | # of frames that have been misordered by the network. |
| 1229 | # This setting applies only when MACsec replay protection active, i.e., |
| 1230 | # - macsec_replay_protect is enabled |
| 1231 | # - the key server has decided to enable MACsec |
| 1232 | # 0: No replay window, strict check (default) |
| 1233 | # 1..2^32-1: number of packets that could be misordered |
| 1234 | # |
Sunil Ravi | 036cec5 | 2023-03-29 11:35:17 -0700 | [diff] [blame] | 1235 | # macsec_offload - Enable MACsec hardware offload |
| 1236 | # |
| 1237 | # This setting applies only when MACsec is in use, i.e., |
| 1238 | # - the key server has decided to enable MACsec |
| 1239 | # |
| 1240 | # 0 = MACSEC_OFFLOAD_OFF (default) |
| 1241 | # 1 = MACSEC_OFFLOAD_PHY |
| 1242 | # 2 = MACSEC_OFFLOAD_MAC |
| 1243 | # |
Dmitry Shmidt | abb90a3 | 2016-12-05 15:34:39 -0800 | [diff] [blame] | 1244 | # macsec_port: IEEE 802.1X/MACsec port |
| 1245 | # Port component of the SCI |
| 1246 | # Range: 1-65534 (default: 1) |
| 1247 | # |
Dmitry Shmidt | 2933359 | 2017-01-09 12:27:11 -0800 | [diff] [blame] | 1248 | # mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode |
Dmitry Shmidt | abb90a3 | 2016-12-05 15:34:39 -0800 | [diff] [blame] | 1249 | # This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair. |
Dmitry Shmidt | 2933359 | 2017-01-09 12:27:11 -0800 | [diff] [blame] | 1250 | # In this mode, instances of wpa_supplicant can act as MACsec peers. The peer |
| 1251 | # with lower priority will become the key server and start distributing SAKs. |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1252 | # mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit) |
| 1253 | # hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits) |
| 1254 | # mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string |
| 1255 | # (2..64 hex-digits) |
Dmitry Shmidt | 2933359 | 2017-01-09 12:27:11 -0800 | [diff] [blame] | 1256 | # mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being |
| 1257 | # default priority |
Dmitry Shmidt | abb90a3 | 2016-12-05 15:34:39 -0800 | [diff] [blame] | 1258 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1259 | # mixed_cell: This option can be used to configure whether so called mixed |
| 1260 | # cells, i.e., networks that use both plaintext and encryption in the same |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 1261 | # SSID, are allowed when selecting a BSS from scan results. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1262 | # 0 = disabled (default) |
| 1263 | # 1 = enabled |
| 1264 | # |
| 1265 | # proactive_key_caching: |
| 1266 | # Enable/disable opportunistic PMKSA caching for WPA2. |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 1267 | # 0 = disabled (default unless changed with the global okc parameter) |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1268 | # 1 = enabled |
| 1269 | # |
Hai Shalom | 81f62d8 | 2019-07-22 12:10:00 -0700 | [diff] [blame] | 1270 | # ft_eap_pmksa_caching: |
| 1271 | # Whether FT-EAP PMKSA caching is allowed |
| 1272 | # 0 = do not try to use PMKSA caching with FT-EAP (default) |
| 1273 | # 1 = try to use PMKSA caching with FT-EAP |
| 1274 | # This controls whether to try to use PMKSA caching with FT-EAP for the |
| 1275 | # FT initial mobility domain association. |
| 1276 | #ft_eap_pmksa_caching=0 |
| 1277 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1278 | # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or |
| 1279 | # hex without quotation, e.g., 0102030405) |
| 1280 | # wep_tx_keyidx: Default WEP key index (TX) (0..3) |
| 1281 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1282 | # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to |
| 1283 | # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies. |
| 1284 | # |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 1285 | # wpa_deny_ptk0_rekey: Workaround for PTK rekey issues |
| 1286 | # PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the |
| 1287 | # security and stability with some cards. |
| 1288 | # To avoid the issues wpa_supplicant can replace those PTK rekeys (including |
| 1289 | # EAP reauthentications) with fast reconnects. |
| 1290 | # |
| 1291 | # Available options: |
| 1292 | # 0 = always rekey when configured/instructed (default) |
| 1293 | # 1 = only rekey when the local driver is explicitly indicating it can perform |
| 1294 | # this operation without issues |
| 1295 | # 2 = never allow problematic PTK0 rekeys |
| 1296 | # |
Dmitry Shmidt | 7f2c753 | 2016-08-15 09:48:12 -0700 | [diff] [blame] | 1297 | # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used |
| 1298 | # as the dot11RSNAConfigGroupRekeyTime parameter when operating in |
Paul Stewart | 092955c | 2017-02-06 09:13:09 -0800 | [diff] [blame] | 1299 | # Authenticator role in IBSS, or in AP and mesh modes. |
Dmitry Shmidt | 7f2c753 | 2016-08-15 09:48:12 -0700 | [diff] [blame] | 1300 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1301 | # Following fields are only used with internal EAP implementation. |
| 1302 | # eap: space-separated list of accepted EAP methods |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1303 | # MD5 = EAP-MD5 (insecure and does not generate keying material -> |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1304 | # cannot be used with WPA; to be used as a Phase 2 method |
| 1305 | # with EAP-PEAP or EAP-TTLS) |
| 1306 | # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used |
| 1307 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) |
| 1308 | # OTP = EAP-OTP (cannot be used separately with WPA; to be used |
| 1309 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) |
| 1310 | # GTC = EAP-GTC (cannot be used separately with WPA; to be used |
| 1311 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) |
| 1312 | # TLS = EAP-TLS (client and server certificate) |
| 1313 | # PEAP = EAP-PEAP (with tunnelled EAP authentication) |
| 1314 | # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 |
| 1315 | # authentication) |
| 1316 | # If not set, all compiled in methods are allowed. |
| 1317 | # |
| 1318 | # identity: Identity string for EAP |
| 1319 | # This field is also used to configure user NAI for |
| 1320 | # EAP-PSK/PAX/SAKE/GPSK. |
| 1321 | # anonymous_identity: Anonymous identity string for EAP (to be used as the |
| 1322 | # unencrypted identity with EAP types that support different tunnelled |
Dmitry Shmidt | 4530cfd | 2012-09-09 15:20:40 -0700 | [diff] [blame] | 1323 | # identity, e.g., EAP-TTLS). This field can also be used with |
| 1324 | # EAP-SIM/AKA/AKA' to store the pseudonym identity. |
Steven Liu | 9138d43 | 2022-11-23 22:29:05 +0000 | [diff] [blame] | 1325 | # strict_conservative_peer_mode: Whether the strict conservative peer mode |
| 1326 | # is enabled. This field is used to handle the reponse of AT_PERMANENT_ID_REQ |
| 1327 | # for EAP-SIM/AKA/AKA'. In non-strict convervative peer mode, a client |
| 1328 | # error would be sent to the server, but the mode will send the permanent |
| 1329 | # identity in some special cases according to 4.6.2 of RFC 4187; With the |
| 1330 | # strict mode, the permanent identity is never sent to the server. |
| 1331 | # 0 = disabled (default) |
| 1332 | # 1 = enabled |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1333 | # password: Password string for EAP. This field can include either the |
| 1334 | # plaintext password (using ASCII or hex string) or a NtPasswordHash |
| 1335 | # (16-byte MD4 hash of password) in hash:<32 hex digits> format. |
| 1336 | # NtPasswordHash can only be used when the password is for MSCHAPv2 or |
| 1337 | # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). |
| 1338 | # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit |
| 1339 | # PSK) is also configured using this field. For EAP-GPSK, this is a |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 1340 | # variable length PSK. ext:<name of external password field> format can |
| 1341 | # be used to indicate that the password is stored in external storage. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1342 | # ca_cert: File path to CA certificate file (PEM/DER). This file can have one |
| 1343 | # or more trusted CA certificates. If ca_cert and ca_path are not |
| 1344 | # included, server certificate will not be verified. This is insecure and |
| 1345 | # a trusted CA certificate should always be configured when using |
| 1346 | # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may |
| 1347 | # change when wpa_supplicant is run in the background. |
| 1348 | # |
| 1349 | # Alternatively, this can be used to only perform matching of the server |
| 1350 | # certificate (SHA-256 hash of the DER encoded X.509 certificate). In |
| 1351 | # this case, the possible CA certificates in the server certificate chain |
| 1352 | # are ignored and only the server certificate is verified. This is |
| 1353 | # configured with the following format: |
| 1354 | # hash:://server/sha256/cert_hash_in_hex |
| 1355 | # For example: "hash://server/sha256/ |
| 1356 | # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a" |
| 1357 | # |
| 1358 | # On Windows, trusted CA certificates can be loaded from the system |
| 1359 | # certificate store by setting this to cert_store://<name>, e.g., |
| 1360 | # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". |
| 1361 | # Note that when running wpa_supplicant as an application, the user |
| 1362 | # certificate store (My user account) is used, whereas computer store |
| 1363 | # (Computer account) is used when running wpasvc as a service. |
| 1364 | # ca_path: Directory path for CA certificate files (PEM). This path may |
| 1365 | # contain multiple CA certificates in OpenSSL format. Common use for this |
| 1366 | # is to point to system trusted CA list which is often installed into |
| 1367 | # directory like /etc/ssl/certs. If configured, these certificates are |
| 1368 | # added to the list of trusted CAs. ca_cert may also be included in that |
| 1369 | # case, but it is not required. |
| 1370 | # client_cert: File path to client certificate file (PEM/DER) |
| 1371 | # Full path should be used since working directory may change when |
| 1372 | # wpa_supplicant is run in the background. |
| 1373 | # Alternatively, a named configuration blob can be used by setting this |
| 1374 | # to blob://<blob name>. |
| 1375 | # private_key: File path to client private key file (PEM/DER/PFX) |
| 1376 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be |
| 1377 | # commented out. Both the private key and certificate will be read from |
| 1378 | # the PKCS#12 file in this case. Full path should be used since working |
| 1379 | # directory may change when wpa_supplicant is run in the background. |
| 1380 | # Windows certificate store can be used by leaving client_cert out and |
| 1381 | # configuring private_key in one of the following formats: |
| 1382 | # cert://substring_to_match |
| 1383 | # hash://certificate_thumbprint_in_hex |
| 1384 | # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4" |
| 1385 | # Note that when running wpa_supplicant as an application, the user |
| 1386 | # certificate store (My user account) is used, whereas computer store |
| 1387 | # (Computer account) is used when running wpasvc as a service. |
| 1388 | # Alternatively, a named configuration blob can be used by setting this |
| 1389 | # to blob://<blob name>. |
| 1390 | # private_key_passwd: Password for private key file (if left out, this will be |
| 1391 | # asked through control interface) |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1392 | # subject_match: Substring to be matched against the subject of the |
| 1393 | # authentication server certificate. If this string is set, the server |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1394 | # certificate is only accepted if it contains this string in the subject. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1395 | # The subject string is in following format: |
| 1396 | # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1397 | # Note: Since this is a substring match, this cannot be used securely to |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 1398 | # do a suffix match against a possible domain name in the CN entry. For |
Dmitry Shmidt | 2f74e36 | 2015-01-21 13:19:05 -0800 | [diff] [blame] | 1399 | # such a use case, domain_suffix_match or domain_match should be used |
| 1400 | # instead. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1401 | # altsubject_match: Semicolon separated string of entries to be matched against |
| 1402 | # the alternative subject name of the authentication server certificate. |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1403 | # If this string is set, the server certificate is only accepted if it |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1404 | # contains one of the entries in an alternative subject name extension. |
| 1405 | # altSubjectName string is in following format: TYPE:VALUE |
| 1406 | # Example: EMAIL:server@example.com |
| 1407 | # Example: DNS:server.example.com;DNS:server2.example.com |
| 1408 | # Following types are supported: EMAIL, DNS, URI |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 1409 | # domain_suffix_match: Constraint for server domain name. If set, this FQDN is |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1410 | # used as a suffix match requirement for the AAA server certificate in |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 1411 | # SubjectAltName dNSName element(s). If a matching dNSName is found, this |
| 1412 | # constraint is met. If no dNSName values are present, this constraint is |
| 1413 | # matched against SubjectName CN using same suffix match comparison. |
| 1414 | # |
| 1415 | # Suffix match here means that the host/domain name is compared one label |
| 1416 | # at a time starting from the top-level domain and all the labels in |
| 1417 | # domain_suffix_match shall be included in the certificate. The |
| 1418 | # certificate may include additional sub-level labels in addition to the |
| 1419 | # required labels. |
| 1420 | # |
Hai Shalom | 021b0b5 | 2019-04-10 11:17:58 -0700 | [diff] [blame] | 1421 | # More than one match string can be provided by using semicolons to |
| 1422 | # separate the strings (e.g., example.org;example.com). When multiple |
| 1423 | # strings are specified, a match with any one of the values is considered |
| 1424 | # a sufficient match for the certificate, i.e., the conditions are ORed |
| 1425 | # together. |
| 1426 | # |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 1427 | # For example, domain_suffix_match=example.com would match |
| 1428 | # test.example.com but would not match test-example.com. |
Dmitry Shmidt | 2f74e36 | 2015-01-21 13:19:05 -0800 | [diff] [blame] | 1429 | # domain_match: Constraint for server domain name |
| 1430 | # If set, this FQDN is used as a full match requirement for the |
| 1431 | # server certificate in SubjectAltName dNSName element(s). If a |
| 1432 | # matching dNSName is found, this constraint is met. If no dNSName |
| 1433 | # values are present, this constraint is matched against SubjectName CN |
| 1434 | # using same full match comparison. This behavior is similar to |
| 1435 | # domain_suffix_match, but has the requirement of a full match, i.e., |
| 1436 | # no subdomains or wildcard matches are allowed. Case-insensitive |
| 1437 | # comparison is used, so "Example.com" matches "example.com", but would |
| 1438 | # not match "test.Example.com". |
Hai Shalom | 021b0b5 | 2019-04-10 11:17:58 -0700 | [diff] [blame] | 1439 | # |
| 1440 | # More than one match string can be provided by using semicolons to |
| 1441 | # separate the strings (e.g., example.org;example.com). When multiple |
| 1442 | # strings are specified, a match with any one of the values is considered |
| 1443 | # a sufficient match for the certificate, i.e., the conditions are ORed |
| 1444 | # together. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1445 | # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters |
| 1446 | # (string with field-value pairs, e.g., "peapver=0" or |
| 1447 | # "peapver=1 peaplabel=1") |
| 1448 | # 'peapver' can be used to force which PEAP version (0 or 1) is used. |
| 1449 | # 'peaplabel=1' can be used to force new label, "client PEAP encryption", |
| 1450 | # to be used during key derivation when PEAPv1 or newer. Most existing |
| 1451 | # PEAPv1 implementation seem to be using the old label, "client EAP |
| 1452 | # encryption", and wpa_supplicant is now using that as the default value. |
| 1453 | # Some servers, e.g., Radiator, may require peaplabel=1 configuration to |
| 1454 | # interoperate with PEAPv1; see eap_testing.txt for more details. |
| 1455 | # 'peap_outer_success=0' can be used to terminate PEAP authentication on |
| 1456 | # tunneled EAP-Success. This is required with some RADIUS servers that |
| 1457 | # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g., |
| 1458 | # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode) |
| 1459 | # include_tls_length=1 can be used to force wpa_supplicant to include |
| 1460 | # TLS Message Length field in all TLS messages even if they are not |
| 1461 | # fragmented. |
| 1462 | # sim_min_num_chal=3 can be used to configure EAP-SIM to require three |
| 1463 | # challenges (by default, it accepts 2 or 3) |
| 1464 | # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use |
| 1465 | # protected result indication. |
| 1466 | # 'crypto_binding' option can be used to control PEAPv0 cryptobinding |
| 1467 | # behavior: |
| 1468 | # * 0 = do not use cryptobinding (default) |
| 1469 | # * 1 = use cryptobinding if server supports it |
| 1470 | # * 2 = require cryptobinding |
Jouni Malinen | ab31d32 | 2023-07-08 19:55:32 +0300 | [diff] [blame] | 1471 | # 'phase2_auth' option can be used to control Phase 2 (i.e., within TLS |
| 1472 | # tunnel) behavior for PEAP: |
| 1473 | # * 0 = do not require Phase 2 authentication |
| 1474 | # * 1 = require Phase 2 authentication when client certificate |
| 1475 | # (private_key/client_cert) is not used and TLS session resumption was |
| 1476 | # not used (default) |
| 1477 | # * 2 = require Phase 2 authentication in all cases |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1478 | # EAP-WSC (WPS) uses following options: pin=<Device Password> or |
| 1479 | # pbc=1. |
Dmitry Shmidt | 216983b | 2015-02-06 10:50:36 -0800 | [diff] [blame] | 1480 | # |
| 1481 | # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be |
| 1482 | # used to configure a mode that allows EAP-Success (and EAP-Failure) |
| 1483 | # without going through authentication step. Some switches use such |
| 1484 | # sequence when forcing the port to be authorized/unauthorized or as a |
| 1485 | # fallback option if the authentication server is unreachable. By default, |
| 1486 | # wpa_supplicant discards such frames to protect against potential attacks |
| 1487 | # by rogue devices, but this option can be used to disable that protection |
| 1488 | # for cases where the server/authenticator does not need to be |
| 1489 | # authenticated. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1490 | # phase2: Phase2 (inner authentication with TLS tunnel) parameters |
| 1491 | # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or |
Dmitry Shmidt | 216983b | 2015-02-06 10:50:36 -0800 | [diff] [blame] | 1492 | # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be |
| 1493 | # used to disable MSCHAPv2 password retry in authentication failure cases. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 1494 | # |
| 1495 | # TLS-based methods can use the following parameters to control TLS behavior |
| 1496 | # (these are normally in the phase1 parameter, but can be used also in the |
| 1497 | # phase2 parameter when EAP-TLS is used within the inner tunnel): |
| 1498 | # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the |
| 1499 | # TLS library, these may be disabled by default to enforce stronger |
| 1500 | # security) |
| 1501 | # tls_disable_time_checks=1 - ignore certificate validity time (this requests |
| 1502 | # the TLS library to accept certificates even if they are not currently |
| 1503 | # valid, i.e., have expired or have not yet become valid; this should be |
| 1504 | # used only for testing purposes) |
| 1505 | # tls_disable_session_ticket=1 - disable TLS Session Ticket extension |
| 1506 | # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used |
| 1507 | # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS |
| 1508 | # as a workaround for broken authentication server implementations unless |
Dmitry Shmidt | af9da31 | 2015-04-03 10:03:11 -0700 | [diff] [blame] | 1509 | # EAP workarounds are disabled with eap_workaround=0. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 1510 | # For EAP-FAST, this must be set to 0 (or left unconfigured for the |
| 1511 | # default value to be used automatically). |
Dmitry Shmidt | d80a401 | 2015-11-05 16:35:40 -0800 | [diff] [blame] | 1512 | # tls_disable_tlsv1_0=1 - disable use of TLSv1.0 |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1513 | # tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows |
| 1514 | # systemwide TLS policies to be overridden) |
Dmitry Shmidt | 13ca8d8 | 2014-02-20 10:18:40 -0800 | [diff] [blame] | 1515 | # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers |
| 1516 | # that have issues interoperating with updated TLS version) |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1517 | # tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows |
| 1518 | # systemwide TLS policies to be overridden) |
Dmitry Shmidt | 13ca8d8 | 2014-02-20 10:18:40 -0800 | [diff] [blame] | 1519 | # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers |
| 1520 | # that have issues interoperating with updated TLS version) |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1521 | # tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows |
| 1522 | # systemwide TLS policies to be overridden) |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 1523 | # tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers |
| 1524 | # that have issues interoperating with updated TLS version) |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1525 | # tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default) |
Dmitry Shmidt | 55840ad | 2015-12-14 12:45:46 -0800 | [diff] [blame] | 1526 | # tls_ext_cert_check=0 - No external server certificate validation (default) |
| 1527 | # tls_ext_cert_check=1 - External server certificate validation enabled; this |
| 1528 | # requires an external program doing validation of server certificate |
| 1529 | # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control |
| 1530 | # interface and report the result of the validation with |
| 1531 | # CTRL-RSP_EXT_CERT_CHECK. |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 1532 | # tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default) |
| 1533 | # tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in |
| 1534 | # particular when using Suite B with RSA keys of >= 3K (3072) bits |
Sunil Ravi | a04bd25 | 2022-05-02 22:54:18 -0700 | [diff] [blame] | 1535 | # allow_unsafe_renegotiation=1 - allow connection with a TLS server that does |
| 1536 | # not support safe renegotiation (RFC 5746); please note that this |
| 1537 | # workaround should be only when having to authenticate with an old |
| 1538 | # authentication server that cannot be updated to use secure TLS |
| 1539 | # implementation. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 1540 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1541 | # Following certificate/private key fields are used in inner Phase2 |
| 1542 | # authentication when using EAP-TTLS or EAP-PEAP. |
| 1543 | # ca_cert2: File path to CA certificate file. This file can have one or more |
| 1544 | # trusted CA certificates. If ca_cert2 and ca_path2 are not included, |
| 1545 | # server certificate will not be verified. This is insecure and a trusted |
| 1546 | # CA certificate should always be configured. |
| 1547 | # ca_path2: Directory path for CA certificate files (PEM) |
| 1548 | # client_cert2: File path to client certificate file |
| 1549 | # private_key2: File path to client private key file |
| 1550 | # private_key2_passwd: Password for private key file |
| 1551 | # dh_file2: File path to DH/DSA parameters file (in PEM format) |
| 1552 | # subject_match2: Substring to be matched against the subject of the |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 1553 | # authentication server certificate. See subject_match for more details. |
| 1554 | # altsubject_match2: Semicolon separated string of entries to be matched |
| 1555 | # against the alternative subject name of the authentication server |
| 1556 | # certificate. See altsubject_match documentation for more details. |
| 1557 | # domain_suffix_match2: Constraint for server domain name. See |
| 1558 | # domain_suffix_match for more details. |
Hai Shalom | c356592 | 2019-10-28 11:58:20 -0700 | [diff] [blame] | 1559 | # ocsp2: See ocsp for more details. |
| 1560 | # |
| 1561 | # Separate machine credentials can be configured for EAP-TEAP Phase 2 with |
| 1562 | # "machine_" prefix (e.g., "machine_identity") in the configuration parameters. |
| 1563 | # See the parameters without that prefix for more details on the meaning and |
| 1564 | # format of each such parameter. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1565 | # |
| 1566 | # fragment_size: Maximum EAP fragment size in bytes (default 1398). |
| 1567 | # This value limits the fragment size for EAP methods that support |
| 1568 | # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set |
| 1569 | # small enough to make the EAP messages fit in MTU of the network |
| 1570 | # interface used for EAPOL. The default value is suitable for most |
| 1571 | # cases. |
| 1572 | # |
Dmitry Shmidt | 34af306 | 2013-07-11 10:46:32 -0700 | [diff] [blame] | 1573 | # ocsp: Whether to use/require OCSP to check server certificate |
| 1574 | # 0 = do not use OCSP stapling (TLS certificate status extension) |
| 1575 | # 1 = try to use OCSP stapling, but not require response |
| 1576 | # 2 = require valid OCSP stapling response |
Dmitry Shmidt | 014a3ff | 2015-12-28 13:27:49 -0800 | [diff] [blame] | 1577 | # 3 = require valid OCSP stapling response for all not-trusted |
| 1578 | # certificates in the server certificate chain |
Dmitry Shmidt | 34af306 | 2013-07-11 10:46:32 -0700 | [diff] [blame] | 1579 | # |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 1580 | # openssl_ciphers: OpenSSL specific cipher configuration |
| 1581 | # This can be used to override the global openssl_ciphers configuration |
| 1582 | # parameter (see above). |
| 1583 | # |
| 1584 | # erp: Whether EAP Re-authentication Protocol (ERP) is enabled |
| 1585 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1586 | # EAP-FAST variables: |
| 1587 | # pac_file: File path for the PAC entries. wpa_supplicant will need to be able |
| 1588 | # to create this file and write updates to it when PAC is being |
| 1589 | # provisioned or refreshed. Full path to the file should be used since |
| 1590 | # working directory may change when wpa_supplicant is run in the |
| 1591 | # background. Alternatively, a named configuration blob can be used by |
| 1592 | # setting this to blob://<blob name> |
| 1593 | # phase1: fast_provisioning option can be used to enable in-line provisioning |
| 1594 | # of EAP-FAST credentials (PAC): |
| 1595 | # 0 = disabled, |
| 1596 | # 1 = allow unauthenticated provisioning, |
| 1597 | # 2 = allow authenticated provisioning, |
| 1598 | # 3 = allow both unauthenticated and authenticated provisioning |
| 1599 | # fast_max_pac_list_len=<num> option can be used to set the maximum |
| 1600 | # number of PAC entries to store in a PAC list (default: 10) |
| 1601 | # fast_pac_format=binary option can be used to select binary format for |
| 1602 | # storing PAC entries in order to save some space (the default |
| 1603 | # text format uses about 2.5 times the size of minimal binary |
| 1604 | # format) |
| 1605 | # |
| 1606 | # wpa_supplicant supports number of "EAP workarounds" to work around |
| 1607 | # interoperability issues with incorrectly behaving authentication servers. |
| 1608 | # These are enabled by default because some of the issues are present in large |
| 1609 | # number of authentication servers. Strict EAP conformance mode can be |
| 1610 | # configured by disabling workarounds with eap_workaround=0. |
| 1611 | |
Dmitry Shmidt | de47be7 | 2016-01-07 12:52:55 -0800 | [diff] [blame] | 1612 | # update_identifier: PPS MO ID |
| 1613 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 1614 | # |
| 1615 | # roaming_consortium_selection: Roaming Consortium Selection |
| 1616 | # The matching Roaming Consortium OI that was used to generate this |
| 1617 | # network profile. |
Dmitry Shmidt | de47be7 | 2016-01-07 12:52:55 -0800 | [diff] [blame] | 1618 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 1619 | # Station inactivity limit |
| 1620 | # |
| 1621 | # If a station does not send anything in ap_max_inactivity seconds, an |
| 1622 | # empty data frame is sent to it in order to verify whether it is |
| 1623 | # still in range. If this frame is not ACKed, the station will be |
| 1624 | # disassociated and then deauthenticated. This feature is used to |
| 1625 | # clear station table of old entries when the STAs move out of the |
| 1626 | # range. |
| 1627 | # |
| 1628 | # The station can associate again with the AP if it is still in range; |
| 1629 | # this inactivity poll is just used as a nicer way of verifying |
| 1630 | # inactivity; i.e., client will not report broken connection because |
| 1631 | # disassociation frame is not sent immediately without first polling |
| 1632 | # the STA with a data frame. |
| 1633 | # default: 300 (i.e., 5 minutes) |
| 1634 | #ap_max_inactivity=300 |
| 1635 | |
| 1636 | # DTIM period in Beacon intervals for AP mode (default: 2) |
| 1637 | #dtim_period=2 |
| 1638 | |
Dmitry Shmidt | 7a5e50a | 2013-03-05 12:37:16 -0800 | [diff] [blame] | 1639 | # Beacon interval (default: 100 TU) |
| 1640 | #beacon_int=100 |
| 1641 | |
Dmitry Shmidt | 849734c | 2016-05-27 09:59:01 -0700 | [diff] [blame] | 1642 | # WPS in AP mode |
| 1643 | # 0 = WPS enabled and configured (default) |
| 1644 | # 1 = WPS disabled |
| 1645 | #wps_disabled=0 |
| 1646 | |
Dmitry Shmidt | d2986c2 | 2017-10-23 14:22:09 -0700 | [diff] [blame] | 1647 | # FILS DH Group |
| 1648 | # 0 = PFS disabled with FILS shared key authentication (default) |
| 1649 | # 1-65535 = DH Group to use for FILS PFS |
| 1650 | #fils_dh_group=0 |
| 1651 | |
Hai Shalom | fdcde76 | 2020-04-02 11:19:20 -0700 | [diff] [blame] | 1652 | # DPP PFS |
| 1653 | # 0: allow PFS to be used or not used (default) |
| 1654 | # 1: require PFS to be used (note: not compatible with DPP R1) |
| 1655 | # 2: do not allow PFS to be used |
| 1656 | #dpp_pfs=0 |
| 1657 | |
Sunil Ravi | 89eba10 | 2022-09-13 21:04:37 -0700 | [diff] [blame] | 1658 | # DPP Network introduction type |
| 1659 | # 0: unprotected variant from DPP R1 (default) |
| 1660 | # 1: privacy protecting (station Connector encrypted) variant from |
| 1661 | # DPP R3 |
| 1662 | #dpp_connector_privacy=0 |
| 1663 | |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 1664 | # Whether beacon protection is enabled |
| 1665 | # This depends on management frame protection (ieee80211w) being enabled and |
| 1666 | # beacon protection support indication from the driver. |
| 1667 | # 0 = disabled (default) |
| 1668 | # 1 = enabled |
Hai Shalom | 899fcc7 | 2020-10-19 14:38:18 -0700 | [diff] [blame] | 1669 | #beacon_prot=0 |
| 1670 | |
| 1671 | # OWE DH Group |
| 1672 | # 0: use default (19) first and then try all supported groups one by one if AP |
| 1673 | # rejects the selected group |
| 1674 | # 1-65535: DH Group to use for OWE |
| 1675 | # Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are |
| 1676 | # currently supported. |
| 1677 | #owe_group=0 |
| 1678 | |
| 1679 | # OWE-only mode (disable transition mode) |
| 1680 | # 0: enable transition mode (allow connection to either OWE or open BSS) |
| 1681 | # 1 = disable transition mode (allow connection only with OWE) |
| 1682 | #owe_only=0 |
| 1683 | |
| 1684 | # OWE PTK derivation workaround |
| 1685 | # Initial OWE implementation used SHA256 when deriving the PTK for all |
| 1686 | # OWE groups. This was supposed to change to SHA384 for group 20 and |
| 1687 | # SHA512 for group 21. This parameter can be used to enable older |
| 1688 | # behavior mainly for testing purposes. There is no impact to group 19 |
| 1689 | # behavior, but if enabled, this will make group 20 and 21 cases use |
| 1690 | # SHA256-based PTK derivation which will not work with the updated |
| 1691 | # OWE implementation on the AP side. |
| 1692 | #owe_ptk_workaround=0 |
| 1693 | |
| 1694 | # Transition Disable indication |
| 1695 | # The AP can notify authenticated stations to disable transition mode |
| 1696 | # in their network profiles when the network has completed transition |
| 1697 | # steps, i.e., once sufficiently large number of APs in the ESS have |
| 1698 | # been updated to support the more secure alternative. When this |
| 1699 | # indication is used, the stations are expected to automatically |
| 1700 | # disable transition mode and less secure security options. This |
| 1701 | # includes use of WEP, TKIP (including use of TKIP as the group |
| 1702 | # cipher), and connections without PMF. |
| 1703 | # Bitmap bits: |
| 1704 | # bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK |
| 1705 | # and only allow SAE to be used) |
| 1706 | # bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK) |
| 1707 | # bit 2 (0x04): WPA3-Enterprise (move to requiring PMF) |
| 1708 | # bit 3 (0x08): Enhanced Open (disable use of open network; require |
| 1709 | # OWE) |
| 1710 | |
| 1711 | # SAE-PK mode |
| 1712 | # 0: automatic SAE/SAE-PK selection based on password; enable |
| 1713 | # transition mode (allow SAE authentication without SAE-PK) |
| 1714 | # 1: SAE-PK only (disable transition mode; allow SAE authentication |
| 1715 | # only with SAE-PK) |
| 1716 | # 2: disable SAE-PK (allow SAE authentication only without SAE-PK) |
| 1717 | #sae_pk=0 |
| 1718 | |
Dmitry Shmidt | 661b4f7 | 2014-09-29 14:58:27 -0700 | [diff] [blame] | 1719 | # MAC address policy |
| 1720 | # 0 = use permanent MAC address |
| 1721 | # 1 = use random MAC address for each ESS connection |
| 1722 | # 2 = like 1, but maintain OUI (with local admin bit set) |
| 1723 | #mac_addr=0 |
| 1724 | |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1725 | # disable_ht: Whether HT (802.11n) should be disabled. |
| 1726 | # 0 = HT enabled (if AP supports it) |
| 1727 | # 1 = HT disabled |
| 1728 | # |
| 1729 | # disable_ht40: Whether HT-40 (802.11n) should be disabled. |
| 1730 | # 0 = HT-40 enabled (if AP supports it) |
| 1731 | # 1 = HT-40 disabled |
| 1732 | # |
| 1733 | # disable_sgi: Whether SGI (short guard interval) should be disabled. |
| 1734 | # 0 = SGI enabled (if AP supports it) |
| 1735 | # 1 = SGI disabled |
| 1736 | # |
Dmitry Shmidt | df5a7e4 | 2014-04-02 12:59:59 -0700 | [diff] [blame] | 1737 | # disable_ldpc: Whether LDPC should be disabled. |
| 1738 | # 0 = LDPC enabled (if AP supports it) |
| 1739 | # 1 = LDPC disabled |
| 1740 | # |
Dmitry Shmidt | 61593f0 | 2014-04-21 16:27:35 -0700 | [diff] [blame] | 1741 | # ht40_intolerant: Whether 40 MHz intolerant should be indicated. |
| 1742 | # 0 = 40 MHz tolerant (default) |
| 1743 | # 1 = 40 MHz intolerant |
| 1744 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1745 | # ht_mcs: Configure allowed MCS rates. |
| 1746 | # Parsed as an array of bytes, in base-16 (ascii-hex) |
| 1747 | # ht_mcs="" // Use all available (default) |
| 1748 | # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only |
| 1749 | # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only |
| 1750 | # |
| 1751 | # disable_max_amsdu: Whether MAX_AMSDU should be disabled. |
| 1752 | # -1 = Do not make any changes. |
| 1753 | # 0 = Enable MAX-AMSDU if hardware supports it. |
| 1754 | # 1 = Disable AMSDU |
| 1755 | # |
Dmitry Shmidt | 7dba0e5 | 2014-04-14 10:49:15 -0700 | [diff] [blame] | 1756 | # ampdu_factor: Maximum A-MPDU Length Exponent |
| 1757 | # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009. |
| 1758 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1759 | # ampdu_density: Allow overriding AMPDU density configuration. |
| 1760 | # Treated as hint by the kernel. |
| 1761 | # -1 = Do not make any changes. |
| 1762 | # 0-3 = Set AMPDU density (aka factor) to specified value. |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1763 | # |
| 1764 | # tx_stbc: Allow overriding STBC support for TX streams |
| 1765 | # Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2. |
| 1766 | # -1 = Do not make any changes (default) |
| 1767 | # 0 = Set if not supported |
| 1768 | # 1 = Set if supported |
| 1769 | # |
| 1770 | # rx_stbc: Allow overriding STBC support for RX streams |
| 1771 | # Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2. |
| 1772 | # -1 = Do not make any changes (default) |
| 1773 | # 0 = Set if not supported |
| 1774 | # 1 = Set for support of one spatial stream |
| 1775 | # 2 = Set for support of one and two spatial streams |
| 1776 | # 3 = Set for support of one, two and three spatial streams |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1777 | |
Dmitry Shmidt | 2f02319 | 2013-03-12 12:44:17 -0700 | [diff] [blame] | 1778 | # disable_vht: Whether VHT should be disabled. |
| 1779 | # 0 = VHT enabled (if AP supports it) |
| 1780 | # 1 = VHT disabled |
| 1781 | # |
| 1782 | # vht_capa: VHT capabilities to set in the override |
| 1783 | # vht_capa_mask: mask of VHT capabilities |
| 1784 | # |
| 1785 | # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8 |
| 1786 | # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8 |
| 1787 | # 0: MCS 0-7 |
| 1788 | # 1: MCS 0-8 |
| 1789 | # 2: MCS 0-9 |
| 1790 | # 3: not supported |
| 1791 | |
Sunil Ravi | 77d572f | 2023-01-17 23:58:31 +0000 | [diff] [blame] | 1792 | # disable_eht: Whether EHT should be disabled. |
| 1793 | # 0 = EHT enabled (if supported) (default) |
| 1794 | # 1 = EHT disabled |
| 1795 | |
Hai Shalom | 74f70d4 | 2019-02-11 14:42:39 -0800 | [diff] [blame] | 1796 | # multi_ap_backhaul_sta: Multi-AP backhaul STA functionality |
| 1797 | # 0 = normal STA (default) |
| 1798 | # 1 = backhaul STA |
| 1799 | # A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not |
| 1800 | # support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be |
| 1801 | # added to a bridge to allow forwarding frames over this backhaul link. |
| 1802 | |
Sunil Ravi | 99c035e | 2024-07-12 01:42:03 +0000 | [diff] [blame] | 1803 | # Multi-AP Profile |
| 1804 | # Indicate the supported Multi-AP profile |
| 1805 | # 1 = Supports Multi-AP profile 1 as defined in Wi-Fi EasyMesh specification |
| 1806 | # 2 = Supports Multi-AP profile 2 as defined in Wi-Fi EasyMesh specification |
| 1807 | #multi_ap_profile=2 |
| 1808 | |
Dmitry Shmidt | d80a401 | 2015-11-05 16:35:40 -0800 | [diff] [blame] | 1809 | ##### Fast Session Transfer (FST) support ##################################### |
| 1810 | # |
| 1811 | # The options in this section are only available when the build configuration |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1812 | # option CONFIG_FST is set while compiling wpa_supplicant. They allow this |
| 1813 | # interface to be a part of FST setup. |
Dmitry Shmidt | d80a401 | 2015-11-05 16:35:40 -0800 | [diff] [blame] | 1814 | # |
| 1815 | # FST is the transfer of a session from a channel to another channel, in the |
| 1816 | # same or different frequency bands. |
| 1817 | # |
Dmitry Shmidt | aca489e | 2016-09-28 15:44:14 -0700 | [diff] [blame] | 1818 | # For details, see IEEE Std 802.11ad-2012. |
Dmitry Shmidt | d80a401 | 2015-11-05 16:35:40 -0800 | [diff] [blame] | 1819 | |
| 1820 | # Identifier of an FST Group the interface belongs to. |
| 1821 | #fst_group_id=bond0 |
| 1822 | |
| 1823 | # Interface priority within the FST Group. |
| 1824 | # Announcing a higher priority for an interface means declaring it more |
| 1825 | # preferable for FST switch. |
| 1826 | # fst_priority is in 1..255 range with 1 being the lowest priority. |
| 1827 | #fst_priority=100 |
| 1828 | |
| 1829 | # Default LLT value for this interface in milliseconds. The value used in case |
| 1830 | # no value provided during session setup. Default is 50 msec. |
| 1831 | # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2 |
| 1832 | # Transitioning between states). |
| 1833 | #fst_llt=100 |
| 1834 | |
Hai Shalom | 81f62d8 | 2019-07-22 12:10:00 -0700 | [diff] [blame] | 1835 | # BSS Transition Management |
| 1836 | # disable_btm - Disable BSS transition management in STA |
| 1837 | # Set to 0 to enable BSS transition management (default behavior) |
| 1838 | # Set to 1 to disable BSS transition management |
| 1839 | #disable_btm=0 |
| 1840 | |
Dennis Jeon | e2cb56b | 2020-10-23 21:23:01 +0900 | [diff] [blame] | 1841 | # This value is used to set where to perform roaming logic |
| 1842 | # Set to 0 to handle roaming logic fully in supplicant |
| 1843 | # Set to 1 to skip roaming logic in supplicant and handle it in firmware |
| 1844 | # In supplicant, just parse BTM frame and notify framework |
| 1845 | #btm_offload=0 |
| 1846 | |
Hai Shalom | c356592 | 2019-10-28 11:58:20 -0700 | [diff] [blame] | 1847 | # Enable EDMG capability in STA/AP mode, default value is false |
| 1848 | #enable_edmg=1 |
| 1849 | |
| 1850 | # This value is used to configure the channel bonding feature. |
| 1851 | # Default value is 0. |
| 1852 | # Relevant only if enable_edmg is true |
| 1853 | # In AP mode it defines the EDMG channel to use for AP operation. |
| 1854 | # In STA mode it defines the EDMG channel for connection (if supported by AP). |
| 1855 | #edmg_channel=9 |
| 1856 | |
Sunil Ravi | 7f76929 | 2024-07-23 22:21:32 +0000 | [diff] [blame] | 1857 | # BSS max idle period to request |
| 1858 | # If nonzero, request the specified number of 1000 TU (i.e., 1.024 s) |
| 1859 | # as the maximum idle period for the STA during association. |
| 1860 | #max_idle=600 |
| 1861 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1862 | # Example blocks: |
| 1863 | |
| 1864 | # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers |
| 1865 | network={ |
| 1866 | ssid="simple" |
| 1867 | psk="very secret passphrase" |
| 1868 | priority=5 |
| 1869 | } |
| 1870 | |
| 1871 | # Same as previous, but request SSID-specific scanning (for APs that reject |
| 1872 | # broadcast SSID) |
| 1873 | network={ |
| 1874 | ssid="second ssid" |
| 1875 | scan_ssid=1 |
| 1876 | psk="very secret passphrase" |
| 1877 | priority=2 |
| 1878 | } |
| 1879 | |
| 1880 | # Only WPA-PSK is used. Any valid cipher combination is accepted. |
| 1881 | network={ |
| 1882 | ssid="example" |
| 1883 | proto=WPA |
| 1884 | key_mgmt=WPA-PSK |
| 1885 | pairwise=CCMP TKIP |
| 1886 | group=CCMP TKIP WEP104 WEP40 |
| 1887 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb |
| 1888 | priority=2 |
| 1889 | } |
| 1890 | |
| 1891 | # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying |
| 1892 | network={ |
| 1893 | ssid="example" |
| 1894 | proto=WPA |
| 1895 | key_mgmt=WPA-PSK |
| 1896 | pairwise=TKIP |
| 1897 | group=TKIP |
| 1898 | psk="not so secure passphrase" |
| 1899 | wpa_ptk_rekey=600 |
| 1900 | } |
| 1901 | |
| 1902 | # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104 |
| 1903 | # or WEP40 as the group cipher will not be accepted. |
| 1904 | network={ |
| 1905 | ssid="example" |
| 1906 | proto=RSN |
| 1907 | key_mgmt=WPA-EAP |
| 1908 | pairwise=CCMP TKIP |
| 1909 | group=CCMP TKIP |
| 1910 | eap=TLS |
| 1911 | identity="user@example.com" |
| 1912 | ca_cert="/etc/cert/ca.pem" |
| 1913 | client_cert="/etc/cert/user.pem" |
| 1914 | private_key="/etc/cert/user.prv" |
| 1915 | private_key_passwd="password" |
| 1916 | priority=1 |
| 1917 | } |
| 1918 | |
| 1919 | # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel |
| 1920 | # (e.g., Radiator) |
| 1921 | network={ |
| 1922 | ssid="example" |
| 1923 | key_mgmt=WPA-EAP |
| 1924 | eap=PEAP |
| 1925 | identity="user@example.com" |
| 1926 | password="foobar" |
| 1927 | ca_cert="/etc/cert/ca.pem" |
| 1928 | phase1="peaplabel=1" |
| 1929 | phase2="auth=MSCHAPV2" |
| 1930 | priority=10 |
| 1931 | } |
| 1932 | |
| 1933 | # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the |
| 1934 | # unencrypted use. Real identity is sent only within an encrypted TLS tunnel. |
| 1935 | network={ |
| 1936 | ssid="example" |
| 1937 | key_mgmt=WPA-EAP |
| 1938 | eap=TTLS |
| 1939 | identity="user@example.com" |
| 1940 | anonymous_identity="anonymous@example.com" |
| 1941 | password="foobar" |
| 1942 | ca_cert="/etc/cert/ca.pem" |
| 1943 | priority=2 |
| 1944 | } |
| 1945 | |
| 1946 | # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted |
| 1947 | # use. Real identity is sent only within an encrypted TLS tunnel. |
| 1948 | network={ |
| 1949 | ssid="example" |
| 1950 | key_mgmt=WPA-EAP |
| 1951 | eap=TTLS |
| 1952 | identity="user@example.com" |
| 1953 | anonymous_identity="anonymous@example.com" |
| 1954 | password="foobar" |
| 1955 | ca_cert="/etc/cert/ca.pem" |
| 1956 | phase2="auth=MSCHAPV2" |
| 1957 | } |
| 1958 | |
| 1959 | # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner |
| 1960 | # authentication. |
| 1961 | network={ |
| 1962 | ssid="example" |
| 1963 | key_mgmt=WPA-EAP |
| 1964 | eap=TTLS |
| 1965 | # Phase1 / outer authentication |
| 1966 | anonymous_identity="anonymous@example.com" |
| 1967 | ca_cert="/etc/cert/ca.pem" |
| 1968 | # Phase 2 / inner authentication |
| 1969 | phase2="autheap=TLS" |
| 1970 | ca_cert2="/etc/cert/ca2.pem" |
| 1971 | client_cert2="/etc/cer/user.pem" |
| 1972 | private_key2="/etc/cer/user.prv" |
| 1973 | private_key2_passwd="password" |
| 1974 | priority=2 |
| 1975 | } |
| 1976 | |
| 1977 | # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and |
| 1978 | # group cipher. |
| 1979 | network={ |
| 1980 | ssid="example" |
| 1981 | bssid=00:11:22:33:44:55 |
| 1982 | proto=WPA RSN |
| 1983 | key_mgmt=WPA-PSK WPA-EAP |
| 1984 | pairwise=CCMP |
| 1985 | group=CCMP |
| 1986 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb |
| 1987 | } |
| 1988 | |
| 1989 | # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP |
| 1990 | # and all valid ciphers. |
| 1991 | network={ |
| 1992 | ssid=00010203 |
| 1993 | psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f |
| 1994 | } |
| 1995 | |
| 1996 | |
| 1997 | # EAP-SIM with a GSM SIM or USIM |
| 1998 | network={ |
| 1999 | ssid="eap-sim-test" |
| 2000 | key_mgmt=WPA-EAP |
| 2001 | eap=SIM |
| 2002 | pin="1234" |
| 2003 | pcsc="" |
| 2004 | } |
| 2005 | |
| 2006 | |
| 2007 | # EAP-PSK |
| 2008 | network={ |
| 2009 | ssid="eap-psk-test" |
| 2010 | key_mgmt=WPA-EAP |
| 2011 | eap=PSK |
| 2012 | anonymous_identity="eap_psk_user" |
| 2013 | password=06b4be19da289f475aa46a33cb793029 |
| 2014 | identity="eap_psk_user@example.com" |
| 2015 | } |
| 2016 | |
| 2017 | |
| 2018 | # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using |
| 2019 | # EAP-TLS for authentication and key generation; require both unicast and |
| 2020 | # broadcast WEP keys. |
| 2021 | network={ |
| 2022 | ssid="1x-test" |
| 2023 | key_mgmt=IEEE8021X |
| 2024 | eap=TLS |
| 2025 | identity="user@example.com" |
| 2026 | ca_cert="/etc/cert/ca.pem" |
| 2027 | client_cert="/etc/cert/user.pem" |
| 2028 | private_key="/etc/cert/user.prv" |
| 2029 | private_key_passwd="password" |
| 2030 | eapol_flags=3 |
| 2031 | } |
| 2032 | |
| 2033 | |
| 2034 | # LEAP with dynamic WEP keys |
| 2035 | network={ |
| 2036 | ssid="leap-example" |
| 2037 | key_mgmt=IEEE8021X |
| 2038 | eap=LEAP |
| 2039 | identity="user" |
| 2040 | password="foobar" |
| 2041 | } |
| 2042 | |
| 2043 | # EAP-IKEv2 using shared secrets for both server and peer authentication |
| 2044 | network={ |
| 2045 | ssid="ikev2-example" |
| 2046 | key_mgmt=WPA-EAP |
| 2047 | eap=IKEV2 |
| 2048 | identity="user" |
| 2049 | password="foobar" |
| 2050 | } |
| 2051 | |
| 2052 | # EAP-FAST with WPA (WPA or WPA2) |
| 2053 | network={ |
| 2054 | ssid="eap-fast-test" |
| 2055 | key_mgmt=WPA-EAP |
| 2056 | eap=FAST |
| 2057 | anonymous_identity="FAST-000102030405" |
| 2058 | identity="username" |
| 2059 | password="password" |
| 2060 | phase1="fast_provisioning=1" |
| 2061 | pac_file="/etc/wpa_supplicant.eap-fast-pac" |
| 2062 | } |
| 2063 | |
| 2064 | network={ |
| 2065 | ssid="eap-fast-test" |
| 2066 | key_mgmt=WPA-EAP |
| 2067 | eap=FAST |
| 2068 | anonymous_identity="FAST-000102030405" |
| 2069 | identity="username" |
| 2070 | password="password" |
| 2071 | phase1="fast_provisioning=1" |
| 2072 | pac_file="blob://eap-fast-pac" |
| 2073 | } |
| 2074 | |
| 2075 | # Plaintext connection (no WPA, no IEEE 802.1X) |
| 2076 | network={ |
| 2077 | ssid="plaintext-test" |
| 2078 | key_mgmt=NONE |
| 2079 | } |
| 2080 | |
| 2081 | |
| 2082 | # Shared WEP key connection (no WPA, no IEEE 802.1X) |
| 2083 | network={ |
| 2084 | ssid="static-wep-test" |
| 2085 | key_mgmt=NONE |
| 2086 | wep_key0="abcde" |
| 2087 | wep_key1=0102030405 |
| 2088 | wep_key2="1234567890123" |
| 2089 | wep_tx_keyidx=0 |
| 2090 | priority=5 |
| 2091 | } |
| 2092 | |
| 2093 | |
| 2094 | # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key |
| 2095 | # IEEE 802.11 authentication |
| 2096 | network={ |
| 2097 | ssid="static-wep-test2" |
| 2098 | key_mgmt=NONE |
| 2099 | wep_key0="abcde" |
| 2100 | wep_key1=0102030405 |
| 2101 | wep_key2="1234567890123" |
| 2102 | wep_tx_keyidx=0 |
| 2103 | priority=5 |
| 2104 | auth_alg=SHARED |
| 2105 | } |
| 2106 | |
| 2107 | |
Dmitry Shmidt | fb79edc | 2014-01-10 10:45:54 -0800 | [diff] [blame] | 2108 | # IBSS/ad-hoc network with RSN |
| 2109 | network={ |
| 2110 | ssid="ibss-rsn" |
| 2111 | key_mgmt=WPA-PSK |
| 2112 | proto=RSN |
| 2113 | psk="12345678" |
| 2114 | mode=1 |
| 2115 | frequency=2412 |
| 2116 | pairwise=CCMP |
| 2117 | group=CCMP |
| 2118 | } |
| 2119 | |
| 2120 | # IBSS/ad-hoc network with WPA-None/TKIP (deprecated) |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 2121 | network={ |
| 2122 | ssid="test adhoc" |
| 2123 | mode=1 |
| 2124 | frequency=2412 |
| 2125 | proto=WPA |
| 2126 | key_mgmt=WPA-NONE |
| 2127 | pairwise=NONE |
| 2128 | group=TKIP |
| 2129 | psk="secret passphrase" |
| 2130 | } |
| 2131 | |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 2132 | # open mesh network |
| 2133 | network={ |
| 2134 | ssid="test mesh" |
| 2135 | mode=5 |
| 2136 | frequency=2437 |
| 2137 | key_mgmt=NONE |
| 2138 | } |
| 2139 | |
| 2140 | # secure (SAE + AMPE) network |
| 2141 | network={ |
| 2142 | ssid="secure mesh" |
| 2143 | mode=5 |
| 2144 | frequency=2437 |
| 2145 | key_mgmt=SAE |
| 2146 | psk="very secret passphrase" |
| 2147 | } |
| 2148 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 2149 | |
| 2150 | # Catch all example that allows more or less all configuration modes |
| 2151 | network={ |
| 2152 | ssid="example" |
| 2153 | scan_ssid=1 |
| 2154 | key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE |
| 2155 | pairwise=CCMP TKIP |
| 2156 | group=CCMP TKIP WEP104 WEP40 |
| 2157 | psk="very secret passphrase" |
| 2158 | eap=TTLS PEAP TLS |
| 2159 | identity="user@example.com" |
| 2160 | password="foobar" |
| 2161 | ca_cert="/etc/cert/ca.pem" |
| 2162 | client_cert="/etc/cert/user.pem" |
| 2163 | private_key="/etc/cert/user.prv" |
| 2164 | private_key_passwd="password" |
| 2165 | phase1="peaplabel=0" |
| 2166 | } |
| 2167 | |
| 2168 | # Example of EAP-TLS with smartcard (openssl engine) |
| 2169 | network={ |
| 2170 | ssid="example" |
| 2171 | key_mgmt=WPA-EAP |
| 2172 | eap=TLS |
| 2173 | proto=RSN |
| 2174 | pairwise=CCMP TKIP |
| 2175 | group=CCMP TKIP |
| 2176 | identity="user@example.com" |
| 2177 | ca_cert="/etc/cert/ca.pem" |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 2178 | |
Dmitry Shmidt | d5ab1b5 | 2016-06-21 12:38:41 -0700 | [diff] [blame] | 2179 | # Certificate and/or key identified by PKCS#11 URI (RFC7512) |
| 2180 | client_cert="pkcs11:manufacturer=piv_II;id=%01" |
| 2181 | private_key="pkcs11:manufacturer=piv_II;id=%01" |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 2182 | |
| 2183 | # Optional PIN configuration; this can be left out and PIN will be |
| 2184 | # asked through the control interface |
| 2185 | pin="1234" |
| 2186 | } |
| 2187 | |
| 2188 | # Example configuration showing how to use an inlined blob as a CA certificate |
| 2189 | # data instead of using external file |
| 2190 | network={ |
| 2191 | ssid="example" |
| 2192 | key_mgmt=WPA-EAP |
| 2193 | eap=TTLS |
| 2194 | identity="user@example.com" |
| 2195 | anonymous_identity="anonymous@example.com" |
| 2196 | password="foobar" |
| 2197 | ca_cert="blob://exampleblob" |
| 2198 | priority=20 |
| 2199 | } |
| 2200 | |
| 2201 | blob-base64-exampleblob={ |
| 2202 | SGVsbG8gV29ybGQhCg== |
| 2203 | } |
| 2204 | |
| 2205 | |
| 2206 | # Wildcard match for SSID (plaintext APs only). This example select any |
| 2207 | # open AP regardless of its SSID. |
| 2208 | network={ |
| 2209 | key_mgmt=NONE |
| 2210 | } |
Dmitry Shmidt | 51b6ea8 | 2013-05-08 10:42:09 -0700 | [diff] [blame] | 2211 | |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 2212 | # Example configuration ignoring two APs - these will be ignored |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 2213 | # for this network. |
| 2214 | network={ |
| 2215 | ssid="example" |
| 2216 | psk="very secret passphrase" |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 2217 | bssid_ignore=02:11:22:33:44:55 02:22:aa:44:55:66 |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 2218 | } |
| 2219 | |
| 2220 | # Example configuration limiting AP selection to a specific set of APs; |
| 2221 | # any other AP not matching the masked address will be ignored. |
| 2222 | network={ |
| 2223 | ssid="example" |
| 2224 | psk="very secret passphrase" |
Hai Shalom | 6084025 | 2021-02-19 19:02:11 -0800 | [diff] [blame] | 2225 | 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 |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 2226 | } |
Dmitry Shmidt | 51b6ea8 | 2013-05-08 10:42:09 -0700 | [diff] [blame] | 2227 | |
| 2228 | # Example config file that will only scan on channel 36. |
| 2229 | freq_list=5180 |
| 2230 | network={ |
| 2231 | key_mgmt=NONE |
| 2232 | } |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 2233 | |
| 2234 | |
Roshan Pius | 3a1667e | 2018-07-03 15:17:14 -0700 | [diff] [blame] | 2235 | # Example configuration using EAP-TTLS for authentication and key |
| 2236 | # generation for MACsec |
| 2237 | network={ |
| 2238 | key_mgmt=IEEE8021X |
| 2239 | eap=TTLS |
| 2240 | phase2="auth=PAP" |
| 2241 | anonymous_identity="anonymous@example.com" |
| 2242 | identity="user@example.com" |
| 2243 | password="secretr" |
| 2244 | ca_cert="/etc/cert/ca.pem" |
| 2245 | eapol_flags=0 |
| 2246 | macsec_policy=1 |
| 2247 | } |
| 2248 | |
| 2249 | # Example configuration for MACsec with preshared key |
| 2250 | network={ |
| 2251 | key_mgmt=NONE |
| 2252 | eapol_flags=0 |
| 2253 | macsec_policy=1 |
| 2254 | mka_cak=0123456789ABCDEF0123456789ABCDEF |
| 2255 | mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435 |
| 2256 | mka_priority=128 |
| 2257 | } |