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) |
| 97 | # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association |
| 98 | # parameters (e.g., WPA IE generation); this mode can also be used with |
| 99 | # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with |
| 100 | # APs (i.e., external program needs to control association). This mode must |
| 101 | # also be used when using wired Ethernet drivers. |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 102 | # Note: macsec_qca driver is one type of Ethernet driver which implements |
| 103 | # macsec feature. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 104 | # 2: like 0, but associate with APs using security policy and SSID (but not |
| 105 | # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to |
| 106 | # enable operation with hidden SSIDs and optimized roaming; in this mode, |
| 107 | # the network blocks in the configuration file are tried one by one until |
| 108 | # the driver reports successful association; each network block should have |
| 109 | # explicit security policy (i.e., only one option in the lists) for |
| 110 | # key_mgmt, pairwise, group, proto variables |
| 111 | # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be |
| 112 | # created immediately regardless of scan results. ap_scan=1 mode will first try |
| 113 | # to scan for existing networks and only if no matches with the enabled |
| 114 | # networks are found, a new IBSS or AP mode network is created. |
Dmitry Shmidt | 8d520ff | 2011-05-09 14:06:53 -0700 | [diff] [blame] | 115 | ap_scan=1 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 116 | |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 117 | # MPM residency |
| 118 | # By default, wpa_supplicant implements the mesh peering manager (MPM) for an |
| 119 | # open mesh. However, if the driver can implement the MPM, you may set this to |
| 120 | # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is |
| 121 | # always used. |
| 122 | # 0: MPM lives in the driver |
| 123 | # 1: wpa_supplicant provides an MPM which handles peering (default) |
| 124 | #user_mpm=1 |
| 125 | |
| 126 | # Maximum number of peer links (0-255; default: 99) |
| 127 | # Maximum number of mesh peering currently maintained by the STA. |
| 128 | #max_peer_links=99 |
| 129 | |
Dmitry Shmidt | 2f74e36 | 2015-01-21 13:19:05 -0800 | [diff] [blame] | 130 | # Timeout in seconds to detect STA inactivity (default: 300 seconds) |
| 131 | # |
| 132 | # This timeout value is used in mesh STA to clean up inactive stations. |
| 133 | #mesh_max_inactivity=300 |
| 134 | |
| 135 | # cert_in_cb - Whether to include a peer certificate dump in events |
| 136 | # This controls whether peer certificates for authentication server and |
| 137 | # its certificate chain are included in EAP peer certificate events. This is |
| 138 | # enabled by default. |
| 139 | #cert_in_cb=1 |
| 140 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 141 | # EAP fast re-authentication |
| 142 | # By default, fast re-authentication is enabled for all EAP methods that |
| 143 | # support it. This variable can be used to disable fast re-authentication. |
| 144 | # Normally, there is no need to disable this. |
Dmitry Shmidt | 8d520ff | 2011-05-09 14:06:53 -0700 | [diff] [blame] | 145 | fast_reauth=1 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 146 | |
| 147 | # OpenSSL Engine support |
| 148 | # These options can be used to load OpenSSL engines. |
| 149 | # The two engines that are supported currently are shown below: |
| 150 | # They are both from the opensc project (http://www.opensc.org/) |
| 151 | # By default no engines are loaded. |
| 152 | # make the opensc engine available |
| 153 | #opensc_engine_path=/usr/lib/opensc/engine_opensc.so |
| 154 | # make the pkcs11 engine available |
| 155 | #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so |
| 156 | # configure the path to the pkcs11 module required by the pkcs11 engine |
| 157 | #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so |
| 158 | |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 159 | # OpenSSL cipher string |
| 160 | # |
| 161 | # This is an OpenSSL specific configuration option for configuring the default |
| 162 | # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default. |
| 163 | # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation |
| 164 | # on cipher suite configuration. This is applicable only if wpa_supplicant is |
| 165 | # built to use OpenSSL. |
| 166 | #openssl_ciphers=DEFAULT:!EXP:!LOW |
| 167 | |
| 168 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 169 | # Dynamic EAP methods |
| 170 | # If EAP methods were built dynamically as shared object files, they need to be |
| 171 | # loaded here before being used in the network blocks. By default, EAP methods |
| 172 | # are included statically in the build, so these lines are not needed |
| 173 | #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so |
| 174 | #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so |
| 175 | |
| 176 | # Driver interface parameters |
| 177 | # This field can be used to configure arbitrary driver interace parameters. The |
| 178 | # format is specific to the selected driver interface. This field is not used |
| 179 | # in most cases. |
| 180 | #driver_param="field=value" |
| 181 | |
| 182 | # Country code |
| 183 | # The ISO/IEC alpha2 country code for the country in which this device is |
| 184 | # currently operating. |
| 185 | #country=US |
| 186 | |
| 187 | # Maximum lifetime for PMKSA in seconds; default 43200 |
| 188 | #dot11RSNAConfigPMKLifetime=43200 |
| 189 | # Threshold for reauthentication (percentage of PMK lifetime); default 70 |
| 190 | #dot11RSNAConfigPMKReauthThreshold=70 |
| 191 | # Timeout for security association negotiation in seconds; default 60 |
| 192 | #dot11RSNAConfigSATimeout=60 |
| 193 | |
| 194 | # Wi-Fi Protected Setup (WPS) parameters |
| 195 | |
| 196 | # Universally Unique IDentifier (UUID; see RFC 4122) of the device |
| 197 | # If not configured, UUID will be generated based on the local MAC address. |
| 198 | #uuid=12345678-9abc-def0-1234-56789abcdef0 |
| 199 | |
| 200 | # Device Name |
| 201 | # User-friendly description of device; up to 32 octets encoded in UTF-8 |
| 202 | #device_name=Wireless Client |
| 203 | |
| 204 | # Manufacturer |
| 205 | # The manufacturer of the device (up to 64 ASCII characters) |
| 206 | #manufacturer=Company |
| 207 | |
| 208 | # Model Name |
| 209 | # Model of the device (up to 32 ASCII characters) |
| 210 | #model_name=cmodel |
| 211 | |
| 212 | # Model Number |
| 213 | # Additional device description (up to 32 ASCII characters) |
| 214 | #model_number=123 |
| 215 | |
| 216 | # Serial Number |
| 217 | # Serial number of the device (up to 32 characters) |
| 218 | #serial_number=12345 |
| 219 | |
| 220 | # Primary Device Type |
| 221 | # Used format: <categ>-<OUI>-<subcateg> |
| 222 | # categ = Category as an integer value |
| 223 | # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for |
| 224 | # default WPS OUI |
| 225 | # subcateg = OUI-specific Sub Category as an integer value |
| 226 | # Examples: |
| 227 | # 1-0050F204-1 (Computer / PC) |
| 228 | # 1-0050F204-2 (Computer / Server) |
| 229 | # 5-0050F204-1 (Storage / NAS) |
| 230 | # 6-0050F204-1 (Network Infrastructure / AP) |
| 231 | #device_type=1-0050F204-1 |
| 232 | |
| 233 | # OS Version |
| 234 | # 4-octet operating system version number (hex string) |
| 235 | #os_version=01020300 |
| 236 | |
| 237 | # Config Methods |
| 238 | # List of the supported configuration methods |
| 239 | # Available methods: usba ethernet label display ext_nfc_token int_nfc_token |
| 240 | # nfc_interface push_button keypad virtual_display physical_display |
| 241 | # virtual_push_button physical_push_button |
| 242 | # For WSC 1.0: |
| 243 | #config_methods=label display push_button keypad |
| 244 | # For WSC 2.0: |
| 245 | #config_methods=label virtual_display virtual_push_button keypad |
| 246 | |
| 247 | # Credential processing |
| 248 | # 0 = process received credentials internally (default) |
| 249 | # 1 = do not process received credentials; just pass them over ctrl_iface to |
| 250 | # external program(s) |
| 251 | # 2 = process received credentials internally and pass them over ctrl_iface |
| 252 | # to external program(s) |
| 253 | #wps_cred_processing=0 |
| 254 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 255 | # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing |
| 256 | # The vendor attribute contents to be added in M1 (hex string) |
| 257 | #wps_vendor_ext_m1=000137100100020001 |
| 258 | |
| 259 | # NFC password token for WPS |
| 260 | # These parameters can be used to configure a fixed NFC password token for the |
| 261 | # station. This can be generated, e.g., with nfc_pw_token. When these |
| 262 | # parameters are used, the station is assumed to be deployed with a NFC tag |
| 263 | # that includes the matching NFC password token (e.g., written based on the |
| 264 | # NDEF record from nfc_pw_token). |
| 265 | # |
| 266 | #wps_nfc_dev_pw_id: Device Password ID (16..65535) |
| 267 | #wps_nfc_dh_pubkey: Hexdump of DH Public Key |
| 268 | #wps_nfc_dh_privkey: Hexdump of DH Private Key |
| 269 | #wps_nfc_dev_pw: Hexdump of Device Password |
| 270 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 271 | # Maximum number of BSS entries to keep in memory |
| 272 | # Default: 200 |
| 273 | # This can be used to limit memory use on the BSS entries (cached scan |
| 274 | # results). A larger value may be needed in environments that have huge number |
| 275 | # of APs when using ap_scan=1 mode. |
| 276 | #bss_max_count=200 |
| 277 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 278 | # Automatic scan |
| 279 | # This is an optional set of parameters for automatic scanning |
| 280 | # within an interface in following format: |
| 281 | #autoscan=<autoscan module name>:<module parameters> |
Dmitry Shmidt | cce0666 | 2013-11-04 18:44:24 -0800 | [diff] [blame] | 282 | # autoscan is like bgscan but on disconnected or inactive state. |
| 283 | # For instance, on exponential module parameters would be <base>:<limit> |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 284 | #autoscan=exponential:3:300 |
| 285 | # Which means a delay between scans on a base exponential of 3, |
Dmitry Shmidt | cce0666 | 2013-11-04 18:44:24 -0800 | [diff] [blame] | 286 | # up to the limit of 300 seconds (3, 9, 27 ... 300) |
| 287 | # For periodic module, parameters would be <fixed interval> |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 288 | #autoscan=periodic:30 |
Dmitry Shmidt | cce0666 | 2013-11-04 18:44:24 -0800 | [diff] [blame] | 289 | # So a delay of 30 seconds will be applied between each scan |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 290 | |
| 291 | # filter_ssids - SSID-based scan result filtering |
| 292 | # 0 = do not filter scan results (default) |
| 293 | # 1 = only include configured SSIDs in scan results/BSS table |
| 294 | #filter_ssids=0 |
| 295 | |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 296 | # Password (and passphrase, etc.) backend for external storage |
| 297 | # format: <backend name>[:<optional backend parameters>] |
| 298 | #ext_password_backend=test:pw1=password|pw2=testing |
| 299 | |
| 300 | # Timeout in seconds to detect STA inactivity (default: 300 seconds) |
| 301 | # |
| 302 | # This timeout value is used in P2P GO mode to clean up |
| 303 | # inactive stations. |
| 304 | #p2p_go_max_inactivity=300 |
| 305 | |
Dmitry Shmidt | 2271d3f | 2014-06-23 12:16:31 -0700 | [diff] [blame] | 306 | # Passphrase length (8..63) for P2P GO |
| 307 | # |
| 308 | # This parameter controls the length of the random passphrase that is |
| 309 | # generated at the GO. Default: 8. |
| 310 | #p2p_passphrase_len=8 |
| 311 | |
Dmitry Shmidt | 09f57ba | 2014-06-10 16:07:13 -0700 | [diff] [blame] | 312 | # Extra delay between concurrent P2P search iterations |
| 313 | # |
| 314 | # This value adds extra delay in milliseconds between concurrent search |
| 315 | # iterations to make p2p_find friendlier to concurrent operations by avoiding |
| 316 | # it from taking 100% of radio resources. The default value is 500 ms. |
| 317 | #p2p_search_delay=500 |
| 318 | |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 319 | # Opportunistic Key Caching (also known as Proactive Key Caching) default |
| 320 | # This parameter can be used to set the default behavior for the |
| 321 | # proactive_key_caching parameter. By default, OKC is disabled unless enabled |
| 322 | # with the global okc=1 parameter or with the per-network |
| 323 | # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but |
| 324 | # can be disabled with per-network proactive_key_caching=0 parameter. |
| 325 | #okc=0 |
| 326 | |
| 327 | # Protected Management Frames default |
| 328 | # This parameter can be used to set the default behavior for the ieee80211w |
| 329 | # parameter. By default, PMF is disabled unless enabled with the global pmf=1/2 |
| 330 | # parameter or with the per-network ieee80211w=1/2 parameter. With pmf=1/2, PMF |
| 331 | # is enabled/required by default, but can be disabled with the per-network |
| 332 | # ieee80211w parameter. |
| 333 | #pmf=0 |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 334 | |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 335 | # Enabled SAE finite cyclic groups in preference order |
| 336 | # By default (if this parameter is not set), the mandatory group 19 (ECC group |
| 337 | # defined over a 256-bit prime order field) is preferred, but other groups are |
| 338 | # also enabled. If this parameter is set, the groups will be tried in the |
| 339 | # indicated order. The group values are listed in the IANA registry: |
| 340 | # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9 |
| 341 | #sae_groups=21 20 19 26 25 |
| 342 | |
Dmitry Shmidt | 7a5e50a | 2013-03-05 12:37:16 -0800 | [diff] [blame] | 343 | # Default value for DTIM period (if not overridden in network block) |
| 344 | #dtim_period=2 |
| 345 | |
| 346 | # Default value for Beacon interval (if not overridden in network block) |
| 347 | #beacon_int=100 |
| 348 | |
Dmitry Shmidt | 0ccb66e | 2013-03-29 16:41:28 -0700 | [diff] [blame] | 349 | # Additional vendor specific elements for Beacon and Probe Response frames |
| 350 | # This parameter can be used to add additional vendor specific element(s) into |
| 351 | # the end of the Beacon and Probe Response frames. The format for these |
| 352 | # element(s) is a hexdump of the raw information elements (id+len+payload for |
| 353 | # one or more elements). This is used in AP and P2P GO modes. |
| 354 | #ap_vendor_elements=dd0411223301 |
| 355 | |
Dmitry Shmidt | 444d567 | 2013-04-01 13:08:44 -0700 | [diff] [blame] | 356 | # Ignore scan results older than request |
| 357 | # |
| 358 | # The driver may have a cache of scan results that makes it return |
| 359 | # information that is older than our scan trigger. This parameter can |
| 360 | # be used to configure such old information to be ignored instead of |
| 361 | # allowing it to update the internal BSS table. |
| 362 | #ignore_old_scan_res=0 |
| 363 | |
Dmitry Shmidt | ea69e84 | 2013-05-13 14:52:28 -0700 | [diff] [blame] | 364 | # scan_cur_freq: Whether to scan only the current frequency |
| 365 | # 0: Scan all available frequencies. (Default) |
| 366 | # 1: Scan current operating frequency if another VIF on the same radio |
| 367 | # is already associated. |
Dmitry Shmidt | 444d567 | 2013-04-01 13:08:44 -0700 | [diff] [blame] | 368 | |
Dmitry Shmidt | 661b4f7 | 2014-09-29 14:58:27 -0700 | [diff] [blame] | 369 | # MAC address policy default |
| 370 | # 0 = use permanent MAC address |
| 371 | # 1 = use random MAC address for each ESS connection |
| 372 | # 2 = like 1, but maintain OUI (with local admin bit set) |
| 373 | # |
| 374 | # By default, permanent MAC address is used unless policy is changed by |
| 375 | # the per-network mac_addr parameter. Global mac_addr=1 can be used to |
| 376 | # change this default behavior. |
| 377 | #mac_addr=0 |
| 378 | |
| 379 | # Lifetime of random MAC address in seconds (default: 60) |
| 380 | #rand_addr_lifetime=60 |
| 381 | |
| 382 | # MAC address policy for pre-association operations (scanning, ANQP) |
| 383 | # 0 = use permanent MAC address |
| 384 | # 1 = use random MAC address |
| 385 | # 2 = like 1, but maintain OUI (with local admin bit set) |
| 386 | #preassoc_mac_addr=0 |
| 387 | |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 388 | # Interworking (IEEE 802.11u) |
| 389 | |
| 390 | # Enable Interworking |
| 391 | # interworking=1 |
| 392 | |
| 393 | # Homogenous ESS identifier |
| 394 | # If this is set, scans will be used to request response only from BSSes |
| 395 | # belonging to the specified Homogeneous ESS. This is used only if interworking |
| 396 | # is enabled. |
| 397 | # hessid=00:11:22:33:44:55 |
| 398 | |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 399 | # Automatic network selection behavior |
| 400 | # 0 = do not automatically go through Interworking network selection |
| 401 | # (i.e., require explicit interworking_select command for this; default) |
| 402 | # 1 = perform Interworking network selection if one or more |
| 403 | # credentials have been configured and scan did not find a |
| 404 | # matching network block |
| 405 | #auto_interworking=0 |
| 406 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 407 | # credential block |
| 408 | # |
| 409 | # Each credential used for automatic network selection is configured as a set |
| 410 | # of parameters that are compared to the information advertised by the APs when |
| 411 | # interworking_select and interworking_connect commands are used. |
| 412 | # |
| 413 | # credential fields: |
| 414 | # |
Dmitry Shmidt | fb79edc | 2014-01-10 10:45:54 -0800 | [diff] [blame] | 415 | # temporary: Whether this credential is temporary and not to be saved |
| 416 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 417 | # priority: Priority group |
| 418 | # By default, all networks and credentials get the same priority group |
| 419 | # (0). This field can be used to give higher priority for credentials |
| 420 | # (and similarly in struct wpa_ssid for network blocks) to change the |
| 421 | # Interworking automatic networking selection behavior. The matching |
| 422 | # network (based on either an enabled network block or a credential) |
| 423 | # with the highest priority value will be selected. |
| 424 | # |
| 425 | # pcsc: Use PC/SC and SIM/USIM card |
| 426 | # |
| 427 | # realm: Home Realm for Interworking |
| 428 | # |
| 429 | # username: Username for Interworking network selection |
| 430 | # |
| 431 | # password: Password for Interworking network selection |
| 432 | # |
| 433 | # ca_cert: CA certificate for Interworking network selection |
| 434 | # |
| 435 | # client_cert: File path to client certificate file (PEM/DER) |
| 436 | # This field is used with Interworking networking selection for a case |
| 437 | # where client certificate/private key is used for authentication |
| 438 | # (EAP-TLS). Full path to the file should be used since working |
| 439 | # directory may change when wpa_supplicant is run in the background. |
| 440 | # |
| 441 | # Alternatively, a named configuration blob can be used by setting |
| 442 | # this to blob://blob_name. |
| 443 | # |
| 444 | # private_key: File path to client private key file (PEM/DER/PFX) |
| 445 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be |
| 446 | # commented out. Both the private key and certificate will be read |
| 447 | # from the PKCS#12 file in this case. Full path to the file should be |
| 448 | # used since working directory may change when wpa_supplicant is run |
| 449 | # in the background. |
| 450 | # |
| 451 | # Windows certificate store can be used by leaving client_cert out and |
| 452 | # configuring private_key in one of the following formats: |
| 453 | # |
| 454 | # cert://substring_to_match |
| 455 | # |
| 456 | # hash://certificate_thumbprint_in_hex |
| 457 | # |
| 458 | # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4" |
| 459 | # |
| 460 | # Note that when running wpa_supplicant as an application, the user |
| 461 | # certificate store (My user account) is used, whereas computer store |
| 462 | # (Computer account) is used when running wpasvc as a service. |
| 463 | # |
| 464 | # Alternatively, a named configuration blob can be used by setting |
| 465 | # this to blob://blob_name. |
| 466 | # |
| 467 | # private_key_passwd: Password for private key file |
| 468 | # |
| 469 | # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format |
| 470 | # |
| 471 | # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN> |
| 472 | # format |
| 473 | # |
Dmitry Shmidt | 051af73 | 2013-10-22 13:52:46 -0700 | [diff] [blame] | 474 | # domain: Home service provider FQDN(s) |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 475 | # 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] | 476 | # whether the AP is operated by the Home SP. Multiple domain entries can |
| 477 | # be used to configure alternative FQDNs that will be considered home |
| 478 | # networks. |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 479 | # |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 480 | # roaming_consortium: Roaming Consortium OI |
| 481 | # If roaming_consortium_len is non-zero, this field contains the |
| 482 | # Roaming Consortium OI that can be used to determine which access |
| 483 | # points support authentication with this credential. This is an |
| 484 | # alternative to the use of the realm parameter. When using Roaming |
| 485 | # Consortium to match the network, the EAP parameters need to be |
| 486 | # pre-configured with the credential since the NAI Realm information |
| 487 | # may not be available or fetched. |
| 488 | # |
| 489 | # eap: Pre-configured EAP method |
| 490 | # This optional field can be used to specify which EAP method will be |
| 491 | # used with this credential. If not set, the EAP method is selected |
| 492 | # automatically based on ANQP information (e.g., NAI Realm). |
| 493 | # |
| 494 | # phase1: Pre-configure Phase 1 (outer authentication) parameters |
| 495 | # This optional field is used with like the 'eap' parameter. |
| 496 | # |
| 497 | # phase2: Pre-configure Phase 2 (inner authentication) parameters |
| 498 | # This optional field is used with like the 'eap' parameter. |
| 499 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 500 | # excluded_ssid: Excluded SSID |
| 501 | # This optional field can be used to excluded specific SSID(s) from |
| 502 | # matching with the network. Multiple entries can be used to specify more |
| 503 | # than one SSID. |
| 504 | # |
Dmitry Shmidt | f21452a | 2014-02-26 10:55:25 -0800 | [diff] [blame] | 505 | # roaming_partner: Roaming partner information |
| 506 | # This optional field can be used to configure preferences between roaming |
| 507 | # partners. The field is a string in following format: |
| 508 | # <FQDN>,<0/1 exact match>,<priority>,<* or country code> |
| 509 | # (non-exact match means any subdomain matches the entry; priority is in |
| 510 | # 0..255 range with 0 being the highest priority) |
| 511 | # |
| 512 | # update_identifier: PPS MO ID |
| 513 | # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier) |
| 514 | # |
| 515 | # provisioning_sp: FQDN of the SP that provisioned the credential |
| 516 | # This optional field can be used to keep track of the SP that provisioned |
| 517 | # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>). |
| 518 | # |
| 519 | # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*) |
| 520 | # These fields can be used to specify minimum download/upload backhaul |
| 521 | # bandwidth that is preferred for the credential. This constraint is |
| 522 | # ignored if the AP does not advertise WAN Metrics information or if the |
| 523 | # limit would prevent any connection. Values are in kilobits per second. |
| 524 | # min_dl_bandwidth_home |
| 525 | # min_ul_bandwidth_home |
| 526 | # min_dl_bandwidth_roaming |
| 527 | # min_ul_bandwidth_roaming |
| 528 | # |
| 529 | # max_bss_load: Maximum BSS Load Channel Utilization (1..255) |
| 530 | # (PPS/<X+>/Policy/MaximumBSSLoadValue) |
| 531 | # This value is used as the maximum channel utilization for network |
| 532 | # selection purposes for home networks. If the AP does not advertise |
| 533 | # BSS Load or if the limit would prevent any connection, this constraint |
| 534 | # will be ignored. |
| 535 | # |
| 536 | # req_conn_capab: Required connection capability |
| 537 | # (PPS/<X+>/Policy/RequiredProtoPortTuple) |
| 538 | # This value is used to configure set of required protocol/port pairs that |
| 539 | # a roaming network shall support (include explicitly in Connection |
| 540 | # Capability ANQP element). This constraint is ignored if the AP does not |
| 541 | # advertise Connection Capability or if this constraint would prevent any |
| 542 | # network connection. This policy is not used in home networks. |
| 543 | # Format: <protocol>[:<comma-separated list of ports] |
| 544 | # Multiple entries can be used to list multiple requirements. |
| 545 | # For example, number of common TCP protocols: |
| 546 | # req_conn_capab=6,22,80,443 |
| 547 | # For example, IPSec/IKE: |
| 548 | # req_conn_capab=17:500 |
| 549 | # req_conn_capab=50 |
| 550 | # |
| 551 | # ocsp: Whether to use/require OCSP to check server certificate |
| 552 | # 0 = do not use OCSP stapling (TLS certificate status extension) |
| 553 | # 1 = try to use OCSP stapling, but not require response |
| 554 | # 2 = require valid OCSP stapling response |
| 555 | # |
Dmitry Shmidt | f9bdef9 | 2014-04-25 10:46:36 -0700 | [diff] [blame] | 556 | # sim_num: Identifier for which SIM to use in multi-SIM devices |
| 557 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 558 | # for example: |
| 559 | # |
| 560 | #cred={ |
| 561 | # realm="example.com" |
| 562 | # username="user@example.com" |
| 563 | # password="password" |
| 564 | # ca_cert="/etc/wpa_supplicant/ca.pem" |
| 565 | # domain="example.com" |
| 566 | #} |
| 567 | # |
| 568 | #cred={ |
| 569 | # imsi="310026-000000000" |
| 570 | # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82" |
| 571 | #} |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 572 | # |
| 573 | #cred={ |
| 574 | # realm="example.com" |
| 575 | # username="user" |
| 576 | # password="password" |
| 577 | # ca_cert="/etc/wpa_supplicant/ca.pem" |
| 578 | # domain="example.com" |
| 579 | # roaming_consortium=223344 |
| 580 | # eap=TTLS |
| 581 | # phase2="auth=MSCHAPV2" |
| 582 | #} |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 583 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 584 | # Hotspot 2.0 |
| 585 | # hs20=1 |
Dmitry Shmidt | c5ec7f5 | 2012-03-06 16:33:24 -0800 | [diff] [blame] | 586 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 587 | # network block |
| 588 | # |
| 589 | # Each network (usually AP's sharing the same SSID) is configured as a separate |
| 590 | # block in this configuration file. The network blocks are in preference order |
| 591 | # (the first match is used). |
| 592 | # |
| 593 | # network block fields: |
| 594 | # |
| 595 | # disabled: |
| 596 | # 0 = this network can be used (default) |
| 597 | # 1 = this network block is disabled (can be enabled through ctrl_iface, |
| 598 | # e.g., with wpa_cli or wpa_gui) |
| 599 | # |
| 600 | # id_str: Network identifier string for external scripts. This value is passed |
| 601 | # to external action script through wpa_cli as WPA_ID_STR environment |
| 602 | # variable to make it easier to do network specific configuration. |
| 603 | # |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 604 | # ssid: SSID (mandatory); network name in one of the optional formats: |
| 605 | # - an ASCII string with double quotation |
| 606 | # - a hex string (two characters per octet of SSID) |
| 607 | # - a printf-escaped ASCII string P"<escaped string>" |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 608 | # |
| 609 | # scan_ssid: |
| 610 | # 0 = do not scan this SSID with specific Probe Request frames (default) |
| 611 | # 1 = scan with SSID-specific Probe Request frames (this can be used to |
| 612 | # find APs that do not accept broadcast SSID or use multiple SSIDs; |
| 613 | # this will add latency to scanning, so enable this only when needed) |
| 614 | # |
| 615 | # bssid: BSSID (optional); if set, this network block is used only when |
| 616 | # associating with the AP using the configured BSSID |
| 617 | # |
| 618 | # priority: priority group (integer) |
| 619 | # By default, all networks will get same priority group (0). If some of the |
| 620 | # networks are more desirable, this field can be used to change the order in |
| 621 | # which wpa_supplicant goes through the networks when selecting a BSS. The |
| 622 | # priority groups will be iterated in decreasing priority (i.e., the larger the |
| 623 | # priority value, the sooner the network is matched against the scan results). |
| 624 | # Within each priority group, networks will be selected based on security |
| 625 | # policy, signal strength, etc. |
| 626 | # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not |
| 627 | # using this priority to select the order for scanning. Instead, they try the |
| 628 | # networks in the order that used in the configuration file. |
| 629 | # |
| 630 | # mode: IEEE 802.11 operation mode |
| 631 | # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default) |
| 632 | # 1 = IBSS (ad-hoc, peer-to-peer) |
| 633 | # 2 = AP (access point) |
Dmitry Shmidt | fb79edc | 2014-01-10 10:45:54 -0800 | [diff] [blame] | 634 | # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and |
| 635 | # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key |
| 636 | # TKIP/CCMP) is available for backwards compatibility, but its use is |
| 637 | # deprecated. WPA-None requires following network block options: |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 638 | # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not |
| 639 | # both), and psk must also be set. |
| 640 | # |
| 641 | # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g., |
| 642 | # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial |
| 643 | # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode. |
| 644 | # In addition, this value is only used by the station that creates the IBSS. If |
| 645 | # an IBSS network with the configured SSID is already present, the frequency of |
| 646 | # the network will be used instead of this configured value. |
| 647 | # |
| 648 | # scan_freq: List of frequencies to scan |
| 649 | # Space-separated list of frequencies in MHz to scan when searching for this |
| 650 | # BSS. If the subset of channels used by the network is known, this option can |
| 651 | # be used to optimize scanning to not occur on channels that the network does |
| 652 | # not use. Example: scan_freq=2412 2437 2462 |
| 653 | # |
| 654 | # freq_list: Array of allowed frequencies |
| 655 | # Space-separated list of frequencies in MHz to allow for selecting the BSS. If |
| 656 | # set, scan results that do not match any of the specified frequencies are not |
| 657 | # considered when selecting a BSS. |
| 658 | # |
Dmitry Shmidt | 51b6ea8 | 2013-05-08 10:42:09 -0700 | [diff] [blame] | 659 | # This can also be set on the outside of the network block. In this case, |
| 660 | # it limits the frequencies that will be scanned. |
| 661 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 662 | # bgscan: Background scanning |
| 663 | # wpa_supplicant behavior for background scanning can be specified by |
| 664 | # configuring a bgscan module. These modules are responsible for requesting |
| 665 | # background scans for the purpose of roaming within an ESS (i.e., within a |
| 666 | # single network block with all the APs using the same SSID). The bgscan |
| 667 | # parameter uses following format: "<bgscan module name>:<module parameters>" |
| 668 | # Following bgscan modules are available: |
| 669 | # simple - Periodic background scans based on signal strength |
| 670 | # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>: |
| 671 | # <long interval>" |
| 672 | # bgscan="simple:30:-45:300" |
| 673 | # learn - Learn channels used by the network and try to avoid bgscans on other |
| 674 | # channels (experimental) |
| 675 | # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>: |
| 676 | # <long interval>[:<database file name>]" |
| 677 | # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan" |
Dmitry Shmidt | a38abf9 | 2014-03-06 13:38:44 -0800 | [diff] [blame] | 678 | # Explicitly disable bgscan by setting |
| 679 | # bgscan="" |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 680 | # |
Dmitry Shmidt | b96dad4 | 2013-11-05 10:07:29 -0800 | [diff] [blame] | 681 | # This option can also be set outside of all network blocks for the bgscan |
| 682 | # parameter to apply for all the networks that have no specific bgscan |
| 683 | # parameter. |
| 684 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 685 | # proto: list of accepted protocols |
| 686 | # WPA = WPA/IEEE 802.11i/D3.0 |
| 687 | # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN) |
| 688 | # If not set, this defaults to: WPA RSN |
| 689 | # |
| 690 | # key_mgmt: list of accepted authenticated key management protocols |
| 691 | # WPA-PSK = WPA pre-shared key (this requires 'psk' field) |
| 692 | # WPA-EAP = WPA using EAP authentication |
| 693 | # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically |
| 694 | # generated WEP keys |
| 695 | # NONE = WPA is not used; plaintext or static WEP could be used |
| 696 | # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms |
| 697 | # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms |
| 698 | # If not set, this defaults to: WPA-PSK WPA-EAP |
| 699 | # |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 700 | # ieee80211w: whether management frame protection is enabled |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 701 | # 0 = disabled (default unless changed with the global pmf parameter) |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 702 | # 1 = optional |
| 703 | # 2 = required |
| 704 | # The most common configuration options for this based on the PMF (protected |
| 705 | # management frames) certification program are: |
| 706 | # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256 |
| 707 | # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256 |
| 708 | # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used) |
| 709 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 710 | # auth_alg: list of allowed IEEE 802.11 authentication algorithms |
| 711 | # OPEN = Open System authentication (required for WPA/WPA2) |
| 712 | # SHARED = Shared Key authentication (requires static WEP keys) |
| 713 | # LEAP = LEAP/Network EAP (only used with LEAP) |
| 714 | # If not set, automatic selection is used (Open System with LEAP enabled if |
| 715 | # LEAP is allowed as one of the EAP methods). |
| 716 | # |
| 717 | # pairwise: list of accepted pairwise (unicast) ciphers for WPA |
| 718 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] |
| 719 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] |
| 720 | # NONE = Use only Group Keys (deprecated, should not be included if APs support |
| 721 | # pairwise keys) |
| 722 | # If not set, this defaults to: CCMP TKIP |
| 723 | # |
| 724 | # group: list of accepted group (broadcast/multicast) ciphers for WPA |
| 725 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] |
| 726 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] |
| 727 | # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key |
| 728 | # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11] |
| 729 | # If not set, this defaults to: CCMP TKIP WEP104 WEP40 |
| 730 | # |
| 731 | # psk: WPA preshared key; 256-bit pre-shared key |
| 732 | # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e., |
| 733 | # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be |
| 734 | # generated using the passphrase and SSID). ASCII passphrase must be between |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 735 | # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can |
| 736 | # 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] | 737 | # This field is not needed, if WPA-EAP is used. |
| 738 | # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys |
| 739 | # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant |
| 740 | # startup and reconfiguration time can be optimized by generating the PSK only |
| 741 | # only when the passphrase or SSID has actually changed. |
| 742 | # |
Dmitry Shmidt | 912c6ec | 2015-03-30 13:16:51 -0700 | [diff] [blame] | 743 | # mem_only_psk: Whether to keep PSK/passphrase only in memory |
| 744 | # 0 = allow psk/passphrase to be stored to the configuration file |
| 745 | # 1 = do not store psk/passphrase to the configuration file |
| 746 | #mem_only_psk=0 |
| 747 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 748 | # eapol_flags: IEEE 802.1X/EAPOL options (bit field) |
| 749 | # Dynamic WEP key required for non-WPA mode |
| 750 | # bit0 (1): require dynamically generated unicast WEP key |
| 751 | # bit1 (2): require dynamically generated broadcast WEP key |
| 752 | # (3 = require both keys; default) |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 753 | # Note: When using wired authentication (including macsec_qca driver), |
| 754 | # eapol_flags must be set to 0 for the authentication to be completed |
| 755 | # successfully. |
| 756 | # |
| 757 | # macsec_policy: IEEE 802.1X/MACsec options |
| 758 | # This determines how sessions are secured with MACsec. It is currently |
| 759 | # applicable only when using the macsec_qca driver interface. |
| 760 | # 0: MACsec not in use (default) |
| 761 | # 1: MACsec enabled - Should secure, accept key server's advice to |
| 762 | # determine whether to use a secure session or not. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 763 | # |
| 764 | # mixed_cell: This option can be used to configure whether so called mixed |
| 765 | # 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] | 766 | # SSID, are allowed when selecting a BSS from scan results. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 767 | # 0 = disabled (default) |
| 768 | # 1 = enabled |
| 769 | # |
| 770 | # proactive_key_caching: |
| 771 | # Enable/disable opportunistic PMKSA caching for WPA2. |
Dmitry Shmidt | d5e4923 | 2012-12-03 15:08:10 -0800 | [diff] [blame] | 772 | # 0 = disabled (default unless changed with the global okc parameter) |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 773 | # 1 = enabled |
| 774 | # |
| 775 | # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or |
| 776 | # hex without quotation, e.g., 0102030405) |
| 777 | # wep_tx_keyidx: Default WEP key index (TX) (0..3) |
| 778 | # |
| 779 | # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is |
| 780 | # allowed. This is only used with RSN/WPA2. |
| 781 | # 0 = disabled (default) |
| 782 | # 1 = enabled |
| 783 | #peerkey=1 |
| 784 | # |
| 785 | # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to |
| 786 | # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies. |
| 787 | # |
| 788 | # Following fields are only used with internal EAP implementation. |
| 789 | # eap: space-separated list of accepted EAP methods |
| 790 | # MD5 = EAP-MD5 (unsecure and does not generate keying material -> |
| 791 | # cannot be used with WPA; to be used as a Phase 2 method |
| 792 | # with EAP-PEAP or EAP-TTLS) |
| 793 | # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used |
| 794 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) |
| 795 | # OTP = EAP-OTP (cannot be used separately with WPA; to be used |
| 796 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) |
| 797 | # GTC = EAP-GTC (cannot be used separately with WPA; to be used |
| 798 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) |
| 799 | # TLS = EAP-TLS (client and server certificate) |
| 800 | # PEAP = EAP-PEAP (with tunnelled EAP authentication) |
| 801 | # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 |
| 802 | # authentication) |
| 803 | # If not set, all compiled in methods are allowed. |
| 804 | # |
| 805 | # identity: Identity string for EAP |
| 806 | # This field is also used to configure user NAI for |
| 807 | # EAP-PSK/PAX/SAKE/GPSK. |
| 808 | # anonymous_identity: Anonymous identity string for EAP (to be used as the |
| 809 | # unencrypted identity with EAP types that support different tunnelled |
Dmitry Shmidt | 4530cfd | 2012-09-09 15:20:40 -0700 | [diff] [blame] | 810 | # identity, e.g., EAP-TTLS). This field can also be used with |
| 811 | # EAP-SIM/AKA/AKA' to store the pseudonym identity. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 812 | # password: Password string for EAP. This field can include either the |
| 813 | # plaintext password (using ASCII or hex string) or a NtPasswordHash |
| 814 | # (16-byte MD4 hash of password) in hash:<32 hex digits> format. |
| 815 | # NtPasswordHash can only be used when the password is for MSCHAPv2 or |
| 816 | # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). |
| 817 | # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit |
| 818 | # 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] | 819 | # variable length PSK. ext:<name of external password field> format can |
| 820 | # be used to indicate that the password is stored in external storage. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 821 | # ca_cert: File path to CA certificate file (PEM/DER). This file can have one |
| 822 | # or more trusted CA certificates. If ca_cert and ca_path are not |
| 823 | # included, server certificate will not be verified. This is insecure and |
| 824 | # a trusted CA certificate should always be configured when using |
| 825 | # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may |
| 826 | # change when wpa_supplicant is run in the background. |
| 827 | # |
| 828 | # Alternatively, this can be used to only perform matching of the server |
| 829 | # certificate (SHA-256 hash of the DER encoded X.509 certificate). In |
| 830 | # this case, the possible CA certificates in the server certificate chain |
| 831 | # are ignored and only the server certificate is verified. This is |
| 832 | # configured with the following format: |
| 833 | # hash:://server/sha256/cert_hash_in_hex |
| 834 | # For example: "hash://server/sha256/ |
| 835 | # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a" |
| 836 | # |
| 837 | # On Windows, trusted CA certificates can be loaded from the system |
| 838 | # certificate store by setting this to cert_store://<name>, e.g., |
| 839 | # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". |
| 840 | # Note that when running wpa_supplicant as an application, the user |
| 841 | # certificate store (My user account) is used, whereas computer store |
| 842 | # (Computer account) is used when running wpasvc as a service. |
| 843 | # ca_path: Directory path for CA certificate files (PEM). This path may |
| 844 | # contain multiple CA certificates in OpenSSL format. Common use for this |
| 845 | # is to point to system trusted CA list which is often installed into |
| 846 | # directory like /etc/ssl/certs. If configured, these certificates are |
| 847 | # added to the list of trusted CAs. ca_cert may also be included in that |
| 848 | # case, but it is not required. |
| 849 | # client_cert: File path to client certificate file (PEM/DER) |
| 850 | # Full path should be used since working directory may change when |
| 851 | # wpa_supplicant is run in the background. |
| 852 | # Alternatively, a named configuration blob can be used by setting this |
| 853 | # to blob://<blob name>. |
| 854 | # private_key: File path to client private key file (PEM/DER/PFX) |
| 855 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be |
| 856 | # commented out. Both the private key and certificate will be read from |
| 857 | # the PKCS#12 file in this case. Full path should be used since working |
| 858 | # directory may change when wpa_supplicant is run in the background. |
| 859 | # Windows certificate store can be used by leaving client_cert out and |
| 860 | # configuring private_key in one of the following formats: |
| 861 | # cert://substring_to_match |
| 862 | # hash://certificate_thumbprint_in_hex |
| 863 | # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4" |
| 864 | # Note that when running wpa_supplicant as an application, the user |
| 865 | # certificate store (My user account) is used, whereas computer store |
| 866 | # (Computer account) is used when running wpasvc as a service. |
| 867 | # Alternatively, a named configuration blob can be used by setting this |
| 868 | # to blob://<blob name>. |
| 869 | # private_key_passwd: Password for private key file (if left out, this will be |
| 870 | # asked through control interface) |
| 871 | # dh_file: File path to DH/DSA parameters file (in PEM format) |
| 872 | # This is an optional configuration file for setting parameters for an |
| 873 | # ephemeral DH key exchange. In most cases, the default RSA |
| 874 | # authentication does not use this configuration. However, it is possible |
| 875 | # setup RSA to use ephemeral DH key exchange. In addition, ciphers with |
| 876 | # DSA keys always use ephemeral DH keys. This can be used to achieve |
| 877 | # forward secrecy. If the file is in DSA parameters format, it will be |
| 878 | # automatically converted into DH params. |
| 879 | # subject_match: Substring to be matched against the subject of the |
| 880 | # authentication server certificate. If this string is set, the server |
| 881 | # sertificate is only accepted if it contains this string in the subject. |
| 882 | # The subject string is in following format: |
| 883 | # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 884 | # Note: Since this is a substring match, this cannot be used securily to |
| 885 | # 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] | 886 | # such a use case, domain_suffix_match or domain_match should be used |
| 887 | # instead. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 888 | # altsubject_match: Semicolon separated string of entries to be matched against |
| 889 | # the alternative subject name of the authentication server certificate. |
| 890 | # If this string is set, the server sertificate is only accepted if it |
| 891 | # contains one of the entries in an alternative subject name extension. |
| 892 | # altSubjectName string is in following format: TYPE:VALUE |
| 893 | # Example: EMAIL:server@example.com |
| 894 | # Example: DNS:server.example.com;DNS:server2.example.com |
| 895 | # Following types are supported: EMAIL, DNS, URI |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 896 | # domain_suffix_match: Constraint for server domain name. If set, this FQDN is |
| 897 | # used as a suffix match requirement for the AAAserver certificate in |
| 898 | # SubjectAltName dNSName element(s). If a matching dNSName is found, this |
| 899 | # constraint is met. If no dNSName values are present, this constraint is |
| 900 | # matched against SubjectName CN using same suffix match comparison. |
| 901 | # |
| 902 | # Suffix match here means that the host/domain name is compared one label |
| 903 | # at a time starting from the top-level domain and all the labels in |
| 904 | # domain_suffix_match shall be included in the certificate. The |
| 905 | # certificate may include additional sub-level labels in addition to the |
| 906 | # required labels. |
| 907 | # |
| 908 | # For example, domain_suffix_match=example.com would match |
| 909 | # test.example.com but would not match test-example.com. |
Dmitry Shmidt | 2f74e36 | 2015-01-21 13:19:05 -0800 | [diff] [blame] | 910 | # domain_match: Constraint for server domain name |
| 911 | # If set, this FQDN is used as a full match requirement for the |
| 912 | # server certificate in SubjectAltName dNSName element(s). If a |
| 913 | # matching dNSName is found, this constraint is met. If no dNSName |
| 914 | # values are present, this constraint is matched against SubjectName CN |
| 915 | # using same full match comparison. This behavior is similar to |
| 916 | # domain_suffix_match, but has the requirement of a full match, i.e., |
| 917 | # no subdomains or wildcard matches are allowed. Case-insensitive |
| 918 | # comparison is used, so "Example.com" matches "example.com", but would |
| 919 | # not match "test.Example.com". |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 920 | # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters |
| 921 | # (string with field-value pairs, e.g., "peapver=0" or |
| 922 | # "peapver=1 peaplabel=1") |
| 923 | # 'peapver' can be used to force which PEAP version (0 or 1) is used. |
| 924 | # 'peaplabel=1' can be used to force new label, "client PEAP encryption", |
| 925 | # to be used during key derivation when PEAPv1 or newer. Most existing |
| 926 | # PEAPv1 implementation seem to be using the old label, "client EAP |
| 927 | # encryption", and wpa_supplicant is now using that as the default value. |
| 928 | # Some servers, e.g., Radiator, may require peaplabel=1 configuration to |
| 929 | # interoperate with PEAPv1; see eap_testing.txt for more details. |
| 930 | # 'peap_outer_success=0' can be used to terminate PEAP authentication on |
| 931 | # tunneled EAP-Success. This is required with some RADIUS servers that |
| 932 | # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g., |
| 933 | # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode) |
| 934 | # include_tls_length=1 can be used to force wpa_supplicant to include |
| 935 | # TLS Message Length field in all TLS messages even if they are not |
| 936 | # fragmented. |
| 937 | # sim_min_num_chal=3 can be used to configure EAP-SIM to require three |
| 938 | # challenges (by default, it accepts 2 or 3) |
| 939 | # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use |
| 940 | # protected result indication. |
| 941 | # 'crypto_binding' option can be used to control PEAPv0 cryptobinding |
| 942 | # behavior: |
| 943 | # * 0 = do not use cryptobinding (default) |
| 944 | # * 1 = use cryptobinding if server supports it |
| 945 | # * 2 = require cryptobinding |
| 946 | # EAP-WSC (WPS) uses following options: pin=<Device Password> or |
| 947 | # pbc=1. |
Dmitry Shmidt | 216983b | 2015-02-06 10:50:36 -0800 | [diff] [blame] | 948 | # |
| 949 | # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be |
| 950 | # used to configure a mode that allows EAP-Success (and EAP-Failure) |
| 951 | # without going through authentication step. Some switches use such |
| 952 | # sequence when forcing the port to be authorized/unauthorized or as a |
| 953 | # fallback option if the authentication server is unreachable. By default, |
| 954 | # wpa_supplicant discards such frames to protect against potential attacks |
| 955 | # by rogue devices, but this option can be used to disable that protection |
| 956 | # for cases where the server/authenticator does not need to be |
| 957 | # authenticated. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 958 | # phase2: Phase2 (inner authentication with TLS tunnel) parameters |
| 959 | # (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] | 960 | # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be |
| 961 | # used to disable MSCHAPv2 password retry in authentication failure cases. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 962 | # |
| 963 | # TLS-based methods can use the following parameters to control TLS behavior |
| 964 | # (these are normally in the phase1 parameter, but can be used also in the |
| 965 | # phase2 parameter when EAP-TLS is used within the inner tunnel): |
| 966 | # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the |
| 967 | # TLS library, these may be disabled by default to enforce stronger |
| 968 | # security) |
| 969 | # tls_disable_time_checks=1 - ignore certificate validity time (this requests |
| 970 | # the TLS library to accept certificates even if they are not currently |
| 971 | # valid, i.e., have expired or have not yet become valid; this should be |
| 972 | # used only for testing purposes) |
| 973 | # tls_disable_session_ticket=1 - disable TLS Session Ticket extension |
| 974 | # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used |
| 975 | # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS |
| 976 | # as a workaround for broken authentication server implementations unless |
Dmitry Shmidt | af9da31 | 2015-04-03 10:03:11 -0700 | [diff] [blame^] | 977 | # EAP workarounds are disabled with eap_workaround=0. |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 978 | # For EAP-FAST, this must be set to 0 (or left unconfigured for the |
| 979 | # default value to be used automatically). |
Dmitry Shmidt | 13ca8d8 | 2014-02-20 10:18:40 -0800 | [diff] [blame] | 980 | # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers |
| 981 | # that have issues interoperating with updated TLS version) |
| 982 | # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers |
| 983 | # that have issues interoperating with updated TLS version) |
Dmitry Shmidt | 61d9df3 | 2012-08-29 16:22:06 -0700 | [diff] [blame] | 984 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 985 | # Following certificate/private key fields are used in inner Phase2 |
| 986 | # authentication when using EAP-TTLS or EAP-PEAP. |
| 987 | # ca_cert2: File path to CA certificate file. This file can have one or more |
| 988 | # trusted CA certificates. If ca_cert2 and ca_path2 are not included, |
| 989 | # server certificate will not be verified. This is insecure and a trusted |
| 990 | # CA certificate should always be configured. |
| 991 | # ca_path2: Directory path for CA certificate files (PEM) |
| 992 | # client_cert2: File path to client certificate file |
| 993 | # private_key2: File path to client private key file |
| 994 | # private_key2_passwd: Password for private key file |
| 995 | # dh_file2: File path to DH/DSA parameters file (in PEM format) |
| 996 | # subject_match2: Substring to be matched against the subject of the |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 997 | # authentication server certificate. See subject_match for more details. |
| 998 | # altsubject_match2: Semicolon separated string of entries to be matched |
| 999 | # against the alternative subject name of the authentication server |
| 1000 | # certificate. See altsubject_match documentation for more details. |
| 1001 | # domain_suffix_match2: Constraint for server domain name. See |
| 1002 | # domain_suffix_match for more details. |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1003 | # |
| 1004 | # fragment_size: Maximum EAP fragment size in bytes (default 1398). |
| 1005 | # This value limits the fragment size for EAP methods that support |
| 1006 | # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set |
| 1007 | # small enough to make the EAP messages fit in MTU of the network |
| 1008 | # interface used for EAPOL. The default value is suitable for most |
| 1009 | # cases. |
| 1010 | # |
Dmitry Shmidt | 34af306 | 2013-07-11 10:46:32 -0700 | [diff] [blame] | 1011 | # ocsp: Whether to use/require OCSP to check server certificate |
| 1012 | # 0 = do not use OCSP stapling (TLS certificate status extension) |
| 1013 | # 1 = try to use OCSP stapling, but not require response |
| 1014 | # 2 = require valid OCSP stapling response |
| 1015 | # |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 1016 | # openssl_ciphers: OpenSSL specific cipher configuration |
| 1017 | # This can be used to override the global openssl_ciphers configuration |
| 1018 | # parameter (see above). |
| 1019 | # |
| 1020 | # erp: Whether EAP Re-authentication Protocol (ERP) is enabled |
| 1021 | # |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1022 | # EAP-FAST variables: |
| 1023 | # pac_file: File path for the PAC entries. wpa_supplicant will need to be able |
| 1024 | # to create this file and write updates to it when PAC is being |
| 1025 | # provisioned or refreshed. Full path to the file should be used since |
| 1026 | # working directory may change when wpa_supplicant is run in the |
| 1027 | # background. Alternatively, a named configuration blob can be used by |
| 1028 | # setting this to blob://<blob name> |
| 1029 | # phase1: fast_provisioning option can be used to enable in-line provisioning |
| 1030 | # of EAP-FAST credentials (PAC): |
| 1031 | # 0 = disabled, |
| 1032 | # 1 = allow unauthenticated provisioning, |
| 1033 | # 2 = allow authenticated provisioning, |
| 1034 | # 3 = allow both unauthenticated and authenticated provisioning |
| 1035 | # fast_max_pac_list_len=<num> option can be used to set the maximum |
| 1036 | # number of PAC entries to store in a PAC list (default: 10) |
| 1037 | # fast_pac_format=binary option can be used to select binary format for |
| 1038 | # storing PAC entries in order to save some space (the default |
| 1039 | # text format uses about 2.5 times the size of minimal binary |
| 1040 | # format) |
| 1041 | # |
| 1042 | # wpa_supplicant supports number of "EAP workarounds" to work around |
| 1043 | # interoperability issues with incorrectly behaving authentication servers. |
| 1044 | # These are enabled by default because some of the issues are present in large |
| 1045 | # number of authentication servers. Strict EAP conformance mode can be |
| 1046 | # configured by disabling workarounds with eap_workaround=0. |
| 1047 | |
Dmitry Shmidt | 0494959 | 2012-07-19 12:16:46 -0700 | [diff] [blame] | 1048 | # Station inactivity limit |
| 1049 | # |
| 1050 | # If a station does not send anything in ap_max_inactivity seconds, an |
| 1051 | # empty data frame is sent to it in order to verify whether it is |
| 1052 | # still in range. If this frame is not ACKed, the station will be |
| 1053 | # disassociated and then deauthenticated. This feature is used to |
| 1054 | # clear station table of old entries when the STAs move out of the |
| 1055 | # range. |
| 1056 | # |
| 1057 | # The station can associate again with the AP if it is still in range; |
| 1058 | # this inactivity poll is just used as a nicer way of verifying |
| 1059 | # inactivity; i.e., client will not report broken connection because |
| 1060 | # disassociation frame is not sent immediately without first polling |
| 1061 | # the STA with a data frame. |
| 1062 | # default: 300 (i.e., 5 minutes) |
| 1063 | #ap_max_inactivity=300 |
| 1064 | |
| 1065 | # DTIM period in Beacon intervals for AP mode (default: 2) |
| 1066 | #dtim_period=2 |
| 1067 | |
Dmitry Shmidt | 7a5e50a | 2013-03-05 12:37:16 -0800 | [diff] [blame] | 1068 | # Beacon interval (default: 100 TU) |
| 1069 | #beacon_int=100 |
| 1070 | |
Dmitry Shmidt | 661b4f7 | 2014-09-29 14:58:27 -0700 | [diff] [blame] | 1071 | # MAC address policy |
| 1072 | # 0 = use permanent MAC address |
| 1073 | # 1 = use random MAC address for each ESS connection |
| 1074 | # 2 = like 1, but maintain OUI (with local admin bit set) |
| 1075 | #mac_addr=0 |
| 1076 | |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1077 | # disable_ht: Whether HT (802.11n) should be disabled. |
| 1078 | # 0 = HT enabled (if AP supports it) |
| 1079 | # 1 = HT disabled |
| 1080 | # |
| 1081 | # disable_ht40: Whether HT-40 (802.11n) should be disabled. |
| 1082 | # 0 = HT-40 enabled (if AP supports it) |
| 1083 | # 1 = HT-40 disabled |
| 1084 | # |
| 1085 | # disable_sgi: Whether SGI (short guard interval) should be disabled. |
| 1086 | # 0 = SGI enabled (if AP supports it) |
| 1087 | # 1 = SGI disabled |
| 1088 | # |
Dmitry Shmidt | df5a7e4 | 2014-04-02 12:59:59 -0700 | [diff] [blame] | 1089 | # disable_ldpc: Whether LDPC should be disabled. |
| 1090 | # 0 = LDPC enabled (if AP supports it) |
| 1091 | # 1 = LDPC disabled |
| 1092 | # |
Dmitry Shmidt | 61593f0 | 2014-04-21 16:27:35 -0700 | [diff] [blame] | 1093 | # ht40_intolerant: Whether 40 MHz intolerant should be indicated. |
| 1094 | # 0 = 40 MHz tolerant (default) |
| 1095 | # 1 = 40 MHz intolerant |
| 1096 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1097 | # ht_mcs: Configure allowed MCS rates. |
| 1098 | # Parsed as an array of bytes, in base-16 (ascii-hex) |
| 1099 | # ht_mcs="" // Use all available (default) |
| 1100 | # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only |
| 1101 | # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only |
| 1102 | # |
| 1103 | # disable_max_amsdu: Whether MAX_AMSDU should be disabled. |
| 1104 | # -1 = Do not make any changes. |
| 1105 | # 0 = Enable MAX-AMSDU if hardware supports it. |
| 1106 | # 1 = Disable AMSDU |
| 1107 | # |
Dmitry Shmidt | 7dba0e5 | 2014-04-14 10:49:15 -0700 | [diff] [blame] | 1108 | # ampdu_factor: Maximum A-MPDU Length Exponent |
| 1109 | # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009. |
| 1110 | # |
Dmitry Shmidt | a54fa5f | 2013-01-15 13:53:35 -0800 | [diff] [blame] | 1111 | # ampdu_density: Allow overriding AMPDU density configuration. |
| 1112 | # Treated as hint by the kernel. |
| 1113 | # -1 = Do not make any changes. |
| 1114 | # 0-3 = Set AMPDU density (aka factor) to specified value. |
| 1115 | |
Dmitry Shmidt | 2f02319 | 2013-03-12 12:44:17 -0700 | [diff] [blame] | 1116 | # disable_vht: Whether VHT should be disabled. |
| 1117 | # 0 = VHT enabled (if AP supports it) |
| 1118 | # 1 = VHT disabled |
| 1119 | # |
| 1120 | # vht_capa: VHT capabilities to set in the override |
| 1121 | # vht_capa_mask: mask of VHT capabilities |
| 1122 | # |
| 1123 | # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8 |
| 1124 | # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8 |
| 1125 | # 0: MCS 0-7 |
| 1126 | # 1: MCS 0-8 |
| 1127 | # 2: MCS 0-9 |
| 1128 | # 3: not supported |
| 1129 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1130 | # Example blocks: |
| 1131 | |
| 1132 | # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers |
| 1133 | network={ |
| 1134 | ssid="simple" |
| 1135 | psk="very secret passphrase" |
| 1136 | priority=5 |
| 1137 | } |
| 1138 | |
| 1139 | # Same as previous, but request SSID-specific scanning (for APs that reject |
| 1140 | # broadcast SSID) |
| 1141 | network={ |
| 1142 | ssid="second ssid" |
| 1143 | scan_ssid=1 |
| 1144 | psk="very secret passphrase" |
| 1145 | priority=2 |
| 1146 | } |
| 1147 | |
| 1148 | # Only WPA-PSK is used. Any valid cipher combination is accepted. |
| 1149 | network={ |
| 1150 | ssid="example" |
| 1151 | proto=WPA |
| 1152 | key_mgmt=WPA-PSK |
| 1153 | pairwise=CCMP TKIP |
| 1154 | group=CCMP TKIP WEP104 WEP40 |
| 1155 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb |
| 1156 | priority=2 |
| 1157 | } |
| 1158 | |
| 1159 | # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying |
| 1160 | network={ |
| 1161 | ssid="example" |
| 1162 | proto=WPA |
| 1163 | key_mgmt=WPA-PSK |
| 1164 | pairwise=TKIP |
| 1165 | group=TKIP |
| 1166 | psk="not so secure passphrase" |
| 1167 | wpa_ptk_rekey=600 |
| 1168 | } |
| 1169 | |
| 1170 | # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104 |
| 1171 | # or WEP40 as the group cipher will not be accepted. |
| 1172 | network={ |
| 1173 | ssid="example" |
| 1174 | proto=RSN |
| 1175 | key_mgmt=WPA-EAP |
| 1176 | pairwise=CCMP TKIP |
| 1177 | group=CCMP TKIP |
| 1178 | eap=TLS |
| 1179 | identity="user@example.com" |
| 1180 | ca_cert="/etc/cert/ca.pem" |
| 1181 | client_cert="/etc/cert/user.pem" |
| 1182 | private_key="/etc/cert/user.prv" |
| 1183 | private_key_passwd="password" |
| 1184 | priority=1 |
| 1185 | } |
| 1186 | |
| 1187 | # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel |
| 1188 | # (e.g., Radiator) |
| 1189 | network={ |
| 1190 | ssid="example" |
| 1191 | key_mgmt=WPA-EAP |
| 1192 | eap=PEAP |
| 1193 | identity="user@example.com" |
| 1194 | password="foobar" |
| 1195 | ca_cert="/etc/cert/ca.pem" |
| 1196 | phase1="peaplabel=1" |
| 1197 | phase2="auth=MSCHAPV2" |
| 1198 | priority=10 |
| 1199 | } |
| 1200 | |
| 1201 | # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the |
| 1202 | # unencrypted use. Real identity is sent only within an encrypted TLS tunnel. |
| 1203 | network={ |
| 1204 | ssid="example" |
| 1205 | key_mgmt=WPA-EAP |
| 1206 | eap=TTLS |
| 1207 | identity="user@example.com" |
| 1208 | anonymous_identity="anonymous@example.com" |
| 1209 | password="foobar" |
| 1210 | ca_cert="/etc/cert/ca.pem" |
| 1211 | priority=2 |
| 1212 | } |
| 1213 | |
| 1214 | # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted |
| 1215 | # use. Real identity is sent only within an encrypted TLS tunnel. |
| 1216 | network={ |
| 1217 | ssid="example" |
| 1218 | key_mgmt=WPA-EAP |
| 1219 | eap=TTLS |
| 1220 | identity="user@example.com" |
| 1221 | anonymous_identity="anonymous@example.com" |
| 1222 | password="foobar" |
| 1223 | ca_cert="/etc/cert/ca.pem" |
| 1224 | phase2="auth=MSCHAPV2" |
| 1225 | } |
| 1226 | |
| 1227 | # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner |
| 1228 | # authentication. |
| 1229 | network={ |
| 1230 | ssid="example" |
| 1231 | key_mgmt=WPA-EAP |
| 1232 | eap=TTLS |
| 1233 | # Phase1 / outer authentication |
| 1234 | anonymous_identity="anonymous@example.com" |
| 1235 | ca_cert="/etc/cert/ca.pem" |
| 1236 | # Phase 2 / inner authentication |
| 1237 | phase2="autheap=TLS" |
| 1238 | ca_cert2="/etc/cert/ca2.pem" |
| 1239 | client_cert2="/etc/cer/user.pem" |
| 1240 | private_key2="/etc/cer/user.prv" |
| 1241 | private_key2_passwd="password" |
| 1242 | priority=2 |
| 1243 | } |
| 1244 | |
| 1245 | # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and |
| 1246 | # group cipher. |
| 1247 | network={ |
| 1248 | ssid="example" |
| 1249 | bssid=00:11:22:33:44:55 |
| 1250 | proto=WPA RSN |
| 1251 | key_mgmt=WPA-PSK WPA-EAP |
| 1252 | pairwise=CCMP |
| 1253 | group=CCMP |
| 1254 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb |
| 1255 | } |
| 1256 | |
| 1257 | # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP |
| 1258 | # and all valid ciphers. |
| 1259 | network={ |
| 1260 | ssid=00010203 |
| 1261 | psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f |
| 1262 | } |
| 1263 | |
| 1264 | |
| 1265 | # EAP-SIM with a GSM SIM or USIM |
| 1266 | network={ |
| 1267 | ssid="eap-sim-test" |
| 1268 | key_mgmt=WPA-EAP |
| 1269 | eap=SIM |
| 1270 | pin="1234" |
| 1271 | pcsc="" |
| 1272 | } |
| 1273 | |
| 1274 | |
| 1275 | # EAP-PSK |
| 1276 | network={ |
| 1277 | ssid="eap-psk-test" |
| 1278 | key_mgmt=WPA-EAP |
| 1279 | eap=PSK |
| 1280 | anonymous_identity="eap_psk_user" |
| 1281 | password=06b4be19da289f475aa46a33cb793029 |
| 1282 | identity="eap_psk_user@example.com" |
| 1283 | } |
| 1284 | |
| 1285 | |
| 1286 | # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using |
| 1287 | # EAP-TLS for authentication and key generation; require both unicast and |
| 1288 | # broadcast WEP keys. |
| 1289 | network={ |
| 1290 | ssid="1x-test" |
| 1291 | key_mgmt=IEEE8021X |
| 1292 | eap=TLS |
| 1293 | identity="user@example.com" |
| 1294 | ca_cert="/etc/cert/ca.pem" |
| 1295 | client_cert="/etc/cert/user.pem" |
| 1296 | private_key="/etc/cert/user.prv" |
| 1297 | private_key_passwd="password" |
| 1298 | eapol_flags=3 |
| 1299 | } |
| 1300 | |
| 1301 | |
| 1302 | # LEAP with dynamic WEP keys |
| 1303 | network={ |
| 1304 | ssid="leap-example" |
| 1305 | key_mgmt=IEEE8021X |
| 1306 | eap=LEAP |
| 1307 | identity="user" |
| 1308 | password="foobar" |
| 1309 | } |
| 1310 | |
| 1311 | # EAP-IKEv2 using shared secrets for both server and peer authentication |
| 1312 | network={ |
| 1313 | ssid="ikev2-example" |
| 1314 | key_mgmt=WPA-EAP |
| 1315 | eap=IKEV2 |
| 1316 | identity="user" |
| 1317 | password="foobar" |
| 1318 | } |
| 1319 | |
| 1320 | # EAP-FAST with WPA (WPA or WPA2) |
| 1321 | network={ |
| 1322 | ssid="eap-fast-test" |
| 1323 | key_mgmt=WPA-EAP |
| 1324 | eap=FAST |
| 1325 | anonymous_identity="FAST-000102030405" |
| 1326 | identity="username" |
| 1327 | password="password" |
| 1328 | phase1="fast_provisioning=1" |
| 1329 | pac_file="/etc/wpa_supplicant.eap-fast-pac" |
| 1330 | } |
| 1331 | |
| 1332 | network={ |
| 1333 | ssid="eap-fast-test" |
| 1334 | key_mgmt=WPA-EAP |
| 1335 | eap=FAST |
| 1336 | anonymous_identity="FAST-000102030405" |
| 1337 | identity="username" |
| 1338 | password="password" |
| 1339 | phase1="fast_provisioning=1" |
| 1340 | pac_file="blob://eap-fast-pac" |
| 1341 | } |
| 1342 | |
| 1343 | # Plaintext connection (no WPA, no IEEE 802.1X) |
| 1344 | network={ |
| 1345 | ssid="plaintext-test" |
| 1346 | key_mgmt=NONE |
| 1347 | } |
| 1348 | |
| 1349 | |
| 1350 | # Shared WEP key connection (no WPA, no IEEE 802.1X) |
| 1351 | network={ |
| 1352 | ssid="static-wep-test" |
| 1353 | key_mgmt=NONE |
| 1354 | wep_key0="abcde" |
| 1355 | wep_key1=0102030405 |
| 1356 | wep_key2="1234567890123" |
| 1357 | wep_tx_keyidx=0 |
| 1358 | priority=5 |
| 1359 | } |
| 1360 | |
| 1361 | |
| 1362 | # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key |
| 1363 | # IEEE 802.11 authentication |
| 1364 | network={ |
| 1365 | ssid="static-wep-test2" |
| 1366 | key_mgmt=NONE |
| 1367 | wep_key0="abcde" |
| 1368 | wep_key1=0102030405 |
| 1369 | wep_key2="1234567890123" |
| 1370 | wep_tx_keyidx=0 |
| 1371 | priority=5 |
| 1372 | auth_alg=SHARED |
| 1373 | } |
| 1374 | |
| 1375 | |
Dmitry Shmidt | fb79edc | 2014-01-10 10:45:54 -0800 | [diff] [blame] | 1376 | # IBSS/ad-hoc network with RSN |
| 1377 | network={ |
| 1378 | ssid="ibss-rsn" |
| 1379 | key_mgmt=WPA-PSK |
| 1380 | proto=RSN |
| 1381 | psk="12345678" |
| 1382 | mode=1 |
| 1383 | frequency=2412 |
| 1384 | pairwise=CCMP |
| 1385 | group=CCMP |
| 1386 | } |
| 1387 | |
| 1388 | # IBSS/ad-hoc network with WPA-None/TKIP (deprecated) |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1389 | network={ |
| 1390 | ssid="test adhoc" |
| 1391 | mode=1 |
| 1392 | frequency=2412 |
| 1393 | proto=WPA |
| 1394 | key_mgmt=WPA-NONE |
| 1395 | pairwise=NONE |
| 1396 | group=TKIP |
| 1397 | psk="secret passphrase" |
| 1398 | } |
| 1399 | |
Dmitry Shmidt | 6c0da2b | 2015-01-05 13:08:17 -0800 | [diff] [blame] | 1400 | # open mesh network |
| 1401 | network={ |
| 1402 | ssid="test mesh" |
| 1403 | mode=5 |
| 1404 | frequency=2437 |
| 1405 | key_mgmt=NONE |
| 1406 | } |
| 1407 | |
| 1408 | # secure (SAE + AMPE) network |
| 1409 | network={ |
| 1410 | ssid="secure mesh" |
| 1411 | mode=5 |
| 1412 | frequency=2437 |
| 1413 | key_mgmt=SAE |
| 1414 | psk="very secret passphrase" |
| 1415 | } |
| 1416 | |
Dmitry Shmidt | 30f9481 | 2012-02-21 17:02:48 -0800 | [diff] [blame] | 1417 | |
| 1418 | # Catch all example that allows more or less all configuration modes |
| 1419 | network={ |
| 1420 | ssid="example" |
| 1421 | scan_ssid=1 |
| 1422 | key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE |
| 1423 | pairwise=CCMP TKIP |
| 1424 | group=CCMP TKIP WEP104 WEP40 |
| 1425 | psk="very secret passphrase" |
| 1426 | eap=TTLS PEAP TLS |
| 1427 | identity="user@example.com" |
| 1428 | password="foobar" |
| 1429 | ca_cert="/etc/cert/ca.pem" |
| 1430 | client_cert="/etc/cert/user.pem" |
| 1431 | private_key="/etc/cert/user.prv" |
| 1432 | private_key_passwd="password" |
| 1433 | phase1="peaplabel=0" |
| 1434 | } |
| 1435 | |
| 1436 | # Example of EAP-TLS with smartcard (openssl engine) |
| 1437 | network={ |
| 1438 | ssid="example" |
| 1439 | key_mgmt=WPA-EAP |
| 1440 | eap=TLS |
| 1441 | proto=RSN |
| 1442 | pairwise=CCMP TKIP |
| 1443 | group=CCMP TKIP |
| 1444 | identity="user@example.com" |
| 1445 | ca_cert="/etc/cert/ca.pem" |
| 1446 | client_cert="/etc/cert/user.pem" |
| 1447 | |
| 1448 | engine=1 |
| 1449 | |
| 1450 | # The engine configured here must be available. Look at |
| 1451 | # OpenSSL engine support in the global section. |
| 1452 | # The key available through the engine must be the private key |
| 1453 | # matching the client certificate configured above. |
| 1454 | |
| 1455 | # use the opensc engine |
| 1456 | #engine_id="opensc" |
| 1457 | #key_id="45" |
| 1458 | |
| 1459 | # use the pkcs11 engine |
| 1460 | engine_id="pkcs11" |
| 1461 | key_id="id_45" |
| 1462 | |
| 1463 | # Optional PIN configuration; this can be left out and PIN will be |
| 1464 | # asked through the control interface |
| 1465 | pin="1234" |
| 1466 | } |
| 1467 | |
| 1468 | # Example configuration showing how to use an inlined blob as a CA certificate |
| 1469 | # data instead of using external file |
| 1470 | network={ |
| 1471 | ssid="example" |
| 1472 | key_mgmt=WPA-EAP |
| 1473 | eap=TTLS |
| 1474 | identity="user@example.com" |
| 1475 | anonymous_identity="anonymous@example.com" |
| 1476 | password="foobar" |
| 1477 | ca_cert="blob://exampleblob" |
| 1478 | priority=20 |
| 1479 | } |
| 1480 | |
| 1481 | blob-base64-exampleblob={ |
| 1482 | SGVsbG8gV29ybGQhCg== |
| 1483 | } |
| 1484 | |
| 1485 | |
| 1486 | # Wildcard match for SSID (plaintext APs only). This example select any |
| 1487 | # open AP regardless of its SSID. |
| 1488 | network={ |
| 1489 | key_mgmt=NONE |
| 1490 | } |
Dmitry Shmidt | 51b6ea8 | 2013-05-08 10:42:09 -0700 | [diff] [blame] | 1491 | |
Dmitry Shmidt | ff787d5 | 2015-01-12 13:01:47 -0800 | [diff] [blame] | 1492 | # Example configuration blacklisting two APs - these will be ignored |
| 1493 | # for this network. |
| 1494 | network={ |
| 1495 | ssid="example" |
| 1496 | psk="very secret passphrase" |
| 1497 | bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66 |
| 1498 | } |
| 1499 | |
| 1500 | # Example configuration limiting AP selection to a specific set of APs; |
| 1501 | # any other AP not matching the masked address will be ignored. |
| 1502 | network={ |
| 1503 | ssid="example" |
| 1504 | psk="very secret passphrase" |
| 1505 | bssid_whitelist=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff |
| 1506 | } |
Dmitry Shmidt | 51b6ea8 | 2013-05-08 10:42:09 -0700 | [diff] [blame] | 1507 | |
| 1508 | # Example config file that will only scan on channel 36. |
| 1509 | freq_list=5180 |
| 1510 | network={ |
| 1511 | key_mgmt=NONE |
| 1512 | } |
Dmitry Shmidt | 5a1480c | 2014-05-12 09:46:02 -0700 | [diff] [blame] | 1513 | |
| 1514 | |
| 1515 | # Example MACsec configuration |
| 1516 | #network={ |
| 1517 | # key_mgmt=IEEE8021X |
| 1518 | # eap=TTLS |
| 1519 | # phase2="auth=PAP" |
| 1520 | # anonymous_identity="anonymous@example.com" |
| 1521 | # identity="user@example.com" |
| 1522 | # password="secretr" |
| 1523 | # ca_cert="/etc/cert/ca.pem" |
| 1524 | # eapol_flags=0 |
| 1525 | # macsec_policy=1 |
| 1526 | #} |