1 ##### Example wpa_supplicant configuration file ###############################
3 # This file describes configuration file format and lists all available option.
4 # Please also take a look at simpler configuration examples in 'examples'
7 # Empty lines and lines starting with # are ignored
9 # NOTE! This file may contain password information and should probably be made
10 # readable only by root user on multiuser systems.
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.
16 # Whether to allow wpa_supplicant to update (overwrite) configuration
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
26 # global configuration (shared by all network blocks)
28 # Parameters for the control interface. If this is specified, wpa_supplicant
29 # will open a control interface that is available for external programs to
30 # manage wpa_supplicant. The meaning of this string depends on which control
31 # interface mechanism is used. For all cases, the existence of this parameter
32 # in configuration is used to determine whether the control interface is
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
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.
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.
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)
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)
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.
75 ctrl_interface=/var/run/wpa_supplicant
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
84 # Note: When using MACsec, eapol_version shall be set to 3, which is
85 # defined in IEEE Std 802.1X-2010.
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.
102 # Note: macsec_qca driver is one type of Ethernet driver which implements
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 # Note: ap_scan=2 should not be used with the nl80211 driver interface (the
112 # current Linux interface). ap_scan=1 is optimized work working with nl80211.
113 # For finding networks using hidden SSID, scan_ssid=1 in the network block can
114 # be used with nl80211.
115 # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
116 # created immediately regardless of scan results. ap_scan=1 mode will first try
117 # to scan for existing networks and only if no matches with the enabled
118 # networks are found, a new IBSS or AP mode network is created.
121 # Whether to force passive scan for network connection
123 # By default, scans will send out Probe Request frames on channels that allow
124 # active scanning. This advertise the local station to the world. Normally this
125 # is fine, but users may wish to do passive scanning where the radio should only
126 # listen quietly for Beacon frames and not send any Probe Request frames. Actual
127 # functionality may be driver dependent.
129 # This parameter can be used to force only passive scanning to be used
130 # for network connection cases. It should be noted that this will slow
131 # down scan operations and reduce likelihood of finding the AP. In
132 # addition, some use cases will override this due to functional
133 # requirements, e.g., for finding an AP that uses hidden SSID
134 # (scan_ssid=1) or P2P device discovery.
136 # 0: Do normal scans (allow active scans) (default)
137 # 1: Do passive scans.
141 # By default, wpa_supplicant implements the mesh peering manager (MPM) for an
142 # open mesh. However, if the driver can implement the MPM, you may set this to
143 # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
145 # 0: MPM lives in the driver
146 # 1: wpa_supplicant provides an MPM which handles peering (default)
149 # Maximum number of peer links (0-255; default: 99)
150 # Maximum number of mesh peering currently maintained by the STA.
153 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
155 # This timeout value is used in mesh STA to clean up inactive stations.
156 #mesh_max_inactivity=300
158 # cert_in_cb - Whether to include a peer certificate dump in events
159 # This controls whether peer certificates for authentication server and
160 # its certificate chain are included in EAP peer certificate events. This is
161 # enabled by default.
164 # EAP fast re-authentication
165 # By default, fast re-authentication is enabled for all EAP methods that
166 # support it. This variable can be used to disable fast re-authentication.
167 # Normally, there is no need to disable this.
170 # OpenSSL Engine support
171 # These options can be used to load OpenSSL engines in special or legacy
173 # The two engines that are supported currently are shown below:
174 # They are both from the opensc project (http://www.opensc.org/)
175 # By default the PKCS#11 engine is loaded if the client_cert or
176 # private_key option appear to be a PKCS#11 URI, and these options
177 # should not need to be used explicitly.
178 # make the opensc engine available
179 #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
180 # make the pkcs11 engine available
181 #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
182 # configure the path to the pkcs11 module required by the pkcs11 engine
183 #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
185 # OpenSSL cipher string
187 # This is an OpenSSL specific configuration option for configuring the default
188 # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
189 # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
190 # on cipher suite configuration. This is applicable only if wpa_supplicant is
191 # built to use OpenSSL.
192 #openssl_ciphers=DEFAULT:!EXP:!LOW
195 # Dynamic EAP methods
196 # If EAP methods were built dynamically as shared object files, they need to be
197 # loaded here before being used in the network blocks. By default, EAP methods
198 # are included statically in the build, so these lines are not needed
199 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
200 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
202 # Driver interface parameters
203 # This field can be used to configure arbitrary driver interface parameters. The
204 # format is specific to the selected driver interface. This field is not used
206 #driver_param="field=value"
209 # The ISO/IEC alpha2 country code for the country in which this device is
210 # currently operating.
213 # Maximum lifetime for PMKSA in seconds; default 43200
214 #dot11RSNAConfigPMKLifetime=43200
215 # Threshold for reauthentication (percentage of PMK lifetime); default 70
216 #dot11RSNAConfigPMKReauthThreshold=70
217 # Timeout for security association negotiation in seconds; default 60
218 #dot11RSNAConfigSATimeout=60
220 # Wi-Fi Protected Setup (WPS) parameters
222 # Universally Unique IDentifier (UUID; see RFC 4122) of the device
223 # If not configured, UUID will be generated based on the local MAC address.
224 #uuid=12345678-9abc-def0-1234-56789abcdef0
227 # User-friendly description of device; up to 32 octets encoded in UTF-8
228 #device_name=Wireless Client
231 # The manufacturer of the device (up to 64 ASCII characters)
232 #manufacturer=Company
235 # Model of the device (up to 32 ASCII characters)
239 # Additional device description (up to 32 ASCII characters)
243 # Serial number of the device (up to 32 characters)
246 # Primary Device Type
247 # Used format: <categ>-<OUI>-<subcateg>
248 # categ = Category as an integer value
249 # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
251 # subcateg = OUI-specific Sub Category as an integer value
253 # 1-0050F204-1 (Computer / PC)
254 # 1-0050F204-2 (Computer / Server)
255 # 5-0050F204-1 (Storage / NAS)
256 # 6-0050F204-1 (Network Infrastructure / AP)
257 #device_type=1-0050F204-1
260 # 4-octet operating system version number (hex string)
264 # List of the supported configuration methods
265 # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
266 # nfc_interface push_button keypad virtual_display physical_display
267 # virtual_push_button physical_push_button
269 #config_methods=label display push_button keypad
271 #config_methods=label virtual_display virtual_push_button keypad
273 # Credential processing
274 # 0 = process received credentials internally (default)
275 # 1 = do not process received credentials; just pass them over ctrl_iface to
276 # external program(s)
277 # 2 = process received credentials internally and pass them over ctrl_iface
278 # to external program(s)
279 #wps_cred_processing=0
281 # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
282 # The vendor attribute contents to be added in M1 (hex string)
283 #wps_vendor_ext_m1=000137100100020001
285 # NFC password token for WPS
286 # These parameters can be used to configure a fixed NFC password token for the
287 # station. This can be generated, e.g., with nfc_pw_token. When these
288 # parameters are used, the station is assumed to be deployed with a NFC tag
289 # that includes the matching NFC password token (e.g., written based on the
290 # NDEF record from nfc_pw_token).
292 #wps_nfc_dev_pw_id: Device Password ID (16..65535)
293 #wps_nfc_dh_pubkey: Hexdump of DH Public Key
294 #wps_nfc_dh_privkey: Hexdump of DH Private Key
295 #wps_nfc_dev_pw: Hexdump of Device Password
297 # Priority for the networks added through WPS
298 # This priority value will be set to each network profile that is added
299 # by executing the WPS protocol.
302 # Maximum number of BSS entries to keep in memory
304 # This can be used to limit memory use on the BSS entries (cached scan
305 # results). A larger value may be needed in environments that have huge number
306 # of APs when using ap_scan=1 mode.
310 # This is an optional set of parameters for automatic scanning
311 # within an interface in following format:
312 #autoscan=<autoscan module name>:<module parameters>
313 # autoscan is like bgscan but on disconnected or inactive state.
314 # For instance, on exponential module parameters would be <base>:<limit>
315 #autoscan=exponential:3:300
316 # Which means a delay between scans on a base exponential of 3,
317 # up to the limit of 300 seconds (3, 9, 27 ... 300)
318 # For periodic module, parameters would be <fixed interval>
319 #autoscan=periodic:30
320 # So a delay of 30 seconds will be applied between each scan.
321 # Note: If sched_scan_plans are configured and supported by the driver,
322 # autoscan is ignored.
324 # filter_ssids - SSID-based scan result filtering
325 # 0 = do not filter scan results (default)
326 # 1 = only include configured SSIDs in scan results/BSS table
329 # Password (and passphrase, etc.) backend for external storage
330 # format: <backend name>[:<optional backend parameters>]
331 #ext_password_backend=test:pw1=password|pw2=testing
334 # Disable P2P functionality
337 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
339 # This timeout value is used in P2P GO mode to clean up
341 #p2p_go_max_inactivity=300
343 # Passphrase length (8..63) for P2P GO
345 # This parameter controls the length of the random passphrase that is
346 # generated at the GO. Default: 8.
347 #p2p_passphrase_len=8
349 # Extra delay between concurrent P2P search iterations
351 # This value adds extra delay in milliseconds between concurrent search
352 # iterations to make p2p_find friendlier to concurrent operations by avoiding
353 # it from taking 100% of radio resources. The default value is 500 ms.
354 #p2p_search_delay=500
356 # Opportunistic Key Caching (also known as Proactive Key Caching) default
357 # This parameter can be used to set the default behavior for the
358 # proactive_key_caching parameter. By default, OKC is disabled unless enabled
359 # with the global okc=1 parameter or with the per-network
360 # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
361 # can be disabled with per-network proactive_key_caching=0 parameter.
364 # Protected Management Frames default
365 # This parameter can be used to set the default behavior for the ieee80211w
366 # parameter for RSN networks. By default, PMF is disabled unless enabled with
367 # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
368 # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
369 # per-network ieee80211w parameter. This global default value does not apply
370 # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
374 # Enabled SAE finite cyclic groups in preference order
375 # By default (if this parameter is not set), the mandatory group 19 (ECC group
376 # defined over a 256-bit prime order field) is preferred, but other groups are
377 # also enabled. If this parameter is set, the groups will be tried in the
378 # indicated order. The group values are listed in the IANA registry:
379 # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
380 #sae_groups=21 20 19 26 25
382 # Default value for DTIM period (if not overridden in network block)
385 # Default value for Beacon interval (if not overridden in network block)
388 # Additional vendor specific elements for Beacon and Probe Response frames
389 # This parameter can be used to add additional vendor specific element(s) into
390 # the end of the Beacon and Probe Response frames. The format for these
391 # element(s) is a hexdump of the raw information elements (id+len+payload for
392 # one or more elements). This is used in AP and P2P GO modes.
393 #ap_vendor_elements=dd0411223301
395 # Ignore scan results older than request
397 # The driver may have a cache of scan results that makes it return
398 # information that is older than our scan trigger. This parameter can
399 # be used to configure such old information to be ignored instead of
400 # allowing it to update the internal BSS table.
401 #ignore_old_scan_res=0
403 # scan_cur_freq: Whether to scan only the current frequency
404 # 0: Scan all available frequencies. (Default)
405 # 1: Scan current operating frequency if another VIF on the same radio
406 # is already associated.
408 # MAC address policy default
409 # 0 = use permanent MAC address
410 # 1 = use random MAC address for each ESS connection
411 # 2 = like 1, but maintain OUI (with local admin bit set)
413 # By default, permanent MAC address is used unless policy is changed by
414 # the per-network mac_addr parameter. Global mac_addr=1 can be used to
415 # change this default behavior.
418 # Lifetime of random MAC address in seconds (default: 60)
419 #rand_addr_lifetime=60
421 # MAC address policy for pre-association operations (scanning, ANQP)
422 # 0 = use permanent MAC address
423 # 1 = use random MAC address
424 # 2 = like 1, but maintain OUI (with local admin bit set)
427 # Interworking (IEEE 802.11u)
429 # Enable Interworking
432 # Homogenous ESS identifier
433 # If this is set, scans will be used to request response only from BSSes
434 # belonging to the specified Homogeneous ESS. This is used only if interworking
436 # hessid=00:11:22:33:44:55
438 # Automatic network selection behavior
439 # 0 = do not automatically go through Interworking network selection
440 # (i.e., require explicit interworking_select command for this; default)
441 # 1 = perform Interworking network selection if one or more
442 # credentials have been configured and scan did not find a
443 # matching network block
446 # GAS Address3 field behavior
447 # 0 = P2P specification (Address3 = AP BSSID); default
448 # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
449 # sent to not-associated AP; if associated, AP BSSID)
452 # Publish fine timing measurement (FTM) responder functionality in
453 # the Extended Capabilities element bit 70.
454 # Controls whether FTM responder functionality will be published by AP/STA.
455 # Note that actual FTM responder operation is managed outside wpa_supplicant.
456 # 0 = Do not publish; default
460 # Publish fine timing measurement (FTM) initiator functionality in
461 # the Extended Capabilities element bit 71.
462 # Controls whether FTM initiator functionality will be published by AP/STA.
463 # Note that actual FTM initiator operation is managed outside wpa_supplicant.
464 # 0 = Do not publish; default
470 # Each credential used for automatic network selection is configured as a set
471 # of parameters that are compared to the information advertised by the APs when
472 # interworking_select and interworking_connect commands are used.
476 # temporary: Whether this credential is temporary and not to be saved
478 # priority: Priority group
479 # By default, all networks and credentials get the same priority group
480 # (0). This field can be used to give higher priority for credentials
481 # (and similarly in struct wpa_ssid for network blocks) to change the
482 # Interworking automatic networking selection behavior. The matching
483 # network (based on either an enabled network block or a credential)
484 # with the highest priority value will be selected.
486 # pcsc: Use PC/SC and SIM/USIM card
488 # realm: Home Realm for Interworking
490 # username: Username for Interworking network selection
492 # password: Password for Interworking network selection
494 # ca_cert: CA certificate for Interworking network selection
496 # client_cert: File path to client certificate file (PEM/DER)
497 # This field is used with Interworking networking selection for a case
498 # where client certificate/private key is used for authentication
499 # (EAP-TLS). Full path to the file should be used since working
500 # directory may change when wpa_supplicant is run in the background.
502 # Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
504 # For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
506 # Alternatively, a named configuration blob can be used by setting
507 # this to blob://blob_name.
509 # private_key: File path to client private key file (PEM/DER/PFX)
510 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
511 # commented out. Both the private key and certificate will be read
512 # from the PKCS#12 file in this case. Full path to the file should be
513 # used since working directory may change when wpa_supplicant is run
516 # Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
517 # For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
519 # Windows certificate store can be used by leaving client_cert out and
520 # configuring private_key in one of the following formats:
522 # cert://substring_to_match
524 # hash://certificate_thumbprint_in_hex
526 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
528 # Note that when running wpa_supplicant as an application, the user
529 # certificate store (My user account) is used, whereas computer store
530 # (Computer account) is used when running wpasvc as a service.
532 # Alternatively, a named configuration blob can be used by setting
533 # this to blob://blob_name.
535 # private_key_passwd: Password for private key file
537 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
539 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
542 # domain: Home service provider FQDN(s)
543 # This is used to compare against the Domain Name List to figure out
544 # whether the AP is operated by the Home SP. Multiple domain entries can
545 # be used to configure alternative FQDNs that will be considered home
548 # roaming_consortium: Roaming Consortium OI
549 # If roaming_consortium_len is non-zero, this field contains the
550 # Roaming Consortium OI that can be used to determine which access
551 # points support authentication with this credential. This is an
552 # alternative to the use of the realm parameter. When using Roaming
553 # Consortium to match the network, the EAP parameters need to be
554 # pre-configured with the credential since the NAI Realm information
555 # may not be available or fetched.
557 # eap: Pre-configured EAP method
558 # This optional field can be used to specify which EAP method will be
559 # used with this credential. If not set, the EAP method is selected
560 # automatically based on ANQP information (e.g., NAI Realm).
562 # phase1: Pre-configure Phase 1 (outer authentication) parameters
563 # This optional field is used with like the 'eap' parameter.
565 # phase2: Pre-configure Phase 2 (inner authentication) parameters
566 # This optional field is used with like the 'eap' parameter.
568 # excluded_ssid: Excluded SSID
569 # This optional field can be used to excluded specific SSID(s) from
570 # matching with the network. Multiple entries can be used to specify more
573 # roaming_partner: Roaming partner information
574 # This optional field can be used to configure preferences between roaming
575 # partners. The field is a string in following format:
576 # <FQDN>,<0/1 exact match>,<priority>,<* or country code>
577 # (non-exact match means any subdomain matches the entry; priority is in
578 # 0..255 range with 0 being the highest priority)
580 # update_identifier: PPS MO ID
581 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
583 # provisioning_sp: FQDN of the SP that provisioned the credential
584 # This optional field can be used to keep track of the SP that provisioned
585 # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
587 # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
588 # These fields can be used to specify minimum download/upload backhaul
589 # bandwidth that is preferred for the credential. This constraint is
590 # ignored if the AP does not advertise WAN Metrics information or if the
591 # limit would prevent any connection. Values are in kilobits per second.
592 # min_dl_bandwidth_home
593 # min_ul_bandwidth_home
594 # min_dl_bandwidth_roaming
595 # min_ul_bandwidth_roaming
597 # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
598 # (PPS/<X+>/Policy/MaximumBSSLoadValue)
599 # This value is used as the maximum channel utilization for network
600 # selection purposes for home networks. If the AP does not advertise
601 # BSS Load or if the limit would prevent any connection, this constraint
604 # req_conn_capab: Required connection capability
605 # (PPS/<X+>/Policy/RequiredProtoPortTuple)
606 # This value is used to configure set of required protocol/port pairs that
607 # a roaming network shall support (include explicitly in Connection
608 # Capability ANQP element). This constraint is ignored if the AP does not
609 # advertise Connection Capability or if this constraint would prevent any
610 # network connection. This policy is not used in home networks.
611 # Format: <protocol>[:<comma-separated list of ports]
612 # Multiple entries can be used to list multiple requirements.
613 # For example, number of common TCP protocols:
614 # req_conn_capab=6,22,80,443
615 # For example, IPSec/IKE:
616 # req_conn_capab=17:500
619 # ocsp: Whether to use/require OCSP to check server certificate
620 # 0 = do not use OCSP stapling (TLS certificate status extension)
621 # 1 = try to use OCSP stapling, but not require response
622 # 2 = require valid OCSP stapling response
623 # 3 = require valid OCSP stapling response for all not-trusted
624 # certificates in the server certificate chain
626 # sim_num: Identifier for which SIM to use in multi-SIM devices
631 # realm="example.com"
632 # username="user@example.com"
633 # password="password"
634 # ca_cert="/etc/wpa_supplicant/ca.pem"
635 # domain="example.com"
639 # imsi="310026-000000000"
640 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
644 # realm="example.com"
646 # password="password"
647 # ca_cert="/etc/wpa_supplicant/ca.pem"
648 # domain="example.com"
649 # roaming_consortium=223344
651 # phase2="auth=MSCHAPV2"
657 # Scheduled scan plans
659 # A space delimited list of scan plans. Each scan plan specifies the scan
660 # interval and number of iterations, delimited by a colon. The last scan plan
661 # will run infinitely and thus must specify only the interval and not the number
664 # The driver advertises the maximum number of scan plans supported. If more scan
665 # plans than supported are configured, only the first ones are set (up to the
666 # maximum supported). The last scan plan that specifies only the interval is
667 # always set as the last plan.
669 # If the scan interval or the number of iterations for a scan plan exceeds the
670 # maximum supported, it will be set to the maximum supported value.
673 # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
676 # sched_scan_plans=10:100 20:200 30
678 # Multi Band Operation (MBO) non-preferred channels
679 # A space delimited list of non-preferred channels where each channel is a colon
680 # delimited list of values.
682 # non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
684 # non_pref_chan="81:5:10:2 81:1:0:2 81:9:0:2"
686 # MBO Cellular Data Capabilities
687 # 1 = Cellular data connection available
688 # 2 = Cellular data connection not available
689 # 3 = Not cellular capable (default)
694 # Each network (usually AP's sharing the same SSID) is configured as a separate
695 # block in this configuration file. The network blocks are in preference order
696 # (the first match is used).
698 # network block fields:
701 # 0 = this network can be used (default)
702 # 1 = this network block is disabled (can be enabled through ctrl_iface,
703 # e.g., with wpa_cli or wpa_gui)
705 # id_str: Network identifier string for external scripts. This value is passed
706 # to external action script through wpa_cli as WPA_ID_STR environment
707 # variable to make it easier to do network specific configuration.
709 # ssid: SSID (mandatory); network name in one of the optional formats:
710 # - an ASCII string with double quotation
711 # - a hex string (two characters per octet of SSID)
712 # - a printf-escaped ASCII string P"<escaped string>"
715 # 0 = do not scan this SSID with specific Probe Request frames (default)
716 # 1 = scan with SSID-specific Probe Request frames (this can be used to
717 # find APs that do not accept broadcast SSID or use multiple SSIDs;
718 # this will add latency to scanning, so enable this only when needed)
720 # bssid: BSSID (optional); if set, this network block is used only when
721 # associating with the AP using the configured BSSID
723 # priority: priority group (integer)
724 # By default, all networks will get same priority group (0). If some of the
725 # networks are more desirable, this field can be used to change the order in
726 # which wpa_supplicant goes through the networks when selecting a BSS. The
727 # priority groups will be iterated in decreasing priority (i.e., the larger the
728 # priority value, the sooner the network is matched against the scan results).
729 # Within each priority group, networks will be selected based on security
730 # policy, signal strength, etc.
731 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
732 # using this priority to select the order for scanning. Instead, they try the
733 # networks in the order that used in the configuration file.
735 # mode: IEEE 802.11 operation mode
736 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
737 # 1 = IBSS (ad-hoc, peer-to-peer)
738 # 2 = AP (access point)
739 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
740 # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
741 # TKIP/CCMP) is available for backwards compatibility, but its use is
742 # deprecated. WPA-None requires following network block options:
743 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
744 # both), and psk must also be set.
746 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
747 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
748 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
749 # In addition, this value is only used by the station that creates the IBSS. If
750 # an IBSS network with the configured SSID is already present, the frequency of
751 # the network will be used instead of this configured value.
753 # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
754 # 0 = do not use PBSS
756 # 2 = don't care (not allowed in AP mode)
757 # Used together with mode configuration. When mode is AP, it means to start a
758 # PCP instead of a regular AP. When mode is infrastructure it means connect
759 # to a PCP instead of AP. In this mode you can also specify 2 (don't care)
760 # which means connect to either PCP or AP.
761 # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
762 # For more details, see IEEE Std 802.11ad-2012.
764 # scan_freq: List of frequencies to scan
765 # Space-separated list of frequencies in MHz to scan when searching for this
766 # BSS. If the subset of channels used by the network is known, this option can
767 # be used to optimize scanning to not occur on channels that the network does
768 # not use. Example: scan_freq=2412 2437 2462
770 # freq_list: Array of allowed frequencies
771 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
772 # set, scan results that do not match any of the specified frequencies are not
773 # considered when selecting a BSS.
775 # This can also be set on the outside of the network block. In this case,
776 # it limits the frequencies that will be scanned.
778 # bgscan: Background scanning
779 # wpa_supplicant behavior for background scanning can be specified by
780 # configuring a bgscan module. These modules are responsible for requesting
781 # background scans for the purpose of roaming within an ESS (i.e., within a
782 # single network block with all the APs using the same SSID). The bgscan
783 # parameter uses following format: "<bgscan module name>:<module parameters>"
784 # Following bgscan modules are available:
785 # simple - Periodic background scans based on signal strength
786 # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
788 # bgscan="simple:30:-45:300"
789 # learn - Learn channels used by the network and try to avoid bgscans on other
790 # channels (experimental)
791 # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
792 # <long interval>[:<database file name>]"
793 # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
794 # Explicitly disable bgscan by setting
797 # This option can also be set outside of all network blocks for the bgscan
798 # parameter to apply for all the networks that have no specific bgscan
801 # proto: list of accepted protocols
802 # WPA = WPA/IEEE 802.11i/D3.0
803 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
804 # If not set, this defaults to: WPA RSN
806 # key_mgmt: list of accepted authenticated key management protocols
807 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
808 # WPA-EAP = WPA using EAP authentication
809 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
811 # NONE = WPA is not used; plaintext or static WEP could be used
812 # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
814 # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
815 # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
816 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
817 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
818 # SAE = Simultaneous authentication of equals; pre-shared key/password -based
819 # authentication with stronger security than WPA-PSK especially when using
820 # not that strong password
821 # FT-SAE = SAE with FT
822 # WPA-EAP-SUITE-B = Suite B 128-bit level
823 # WPA-EAP-SUITE-B-192 = Suite B 192-bit level
824 # OSEN = Hotspot 2.0 Rel 2 online signup connection
825 # If not set, this defaults to: WPA-PSK WPA-EAP
827 # ieee80211w: whether management frame protection is enabled
828 # 0 = disabled (default unless changed with the global pmf parameter)
831 # The most common configuration options for this based on the PMF (protected
832 # management frames) certification program are:
833 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
834 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
835 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
837 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
838 # OPEN = Open System authentication (required for WPA/WPA2)
839 # SHARED = Shared Key authentication (requires static WEP keys)
840 # LEAP = LEAP/Network EAP (only used with LEAP)
841 # If not set, automatic selection is used (Open System with LEAP enabled if
842 # LEAP is allowed as one of the EAP methods).
844 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
845 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
846 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
847 # NONE = Use only Group Keys (deprecated, should not be included if APs support
849 # If not set, this defaults to: CCMP TKIP
851 # group: list of accepted group (broadcast/multicast) ciphers for WPA
852 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
853 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
854 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
855 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
856 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
858 # psk: WPA preshared key; 256-bit pre-shared key
859 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
860 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
861 # generated using the passphrase and SSID). ASCII passphrase must be between
862 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
863 # be used to indicate that the PSK/passphrase is stored in external storage.
864 # This field is not needed, if WPA-EAP is used.
865 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
866 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
867 # startup and reconfiguration time can be optimized by generating the PSK only
868 # only when the passphrase or SSID has actually changed.
870 # mem_only_psk: Whether to keep PSK/passphrase only in memory
871 # 0 = allow psk/passphrase to be stored to the configuration file
872 # 1 = do not store psk/passphrase to the configuration file
875 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
876 # Dynamic WEP key required for non-WPA mode
877 # bit0 (1): require dynamically generated unicast WEP key
878 # bit1 (2): require dynamically generated broadcast WEP key
879 # (3 = require both keys; default)
880 # Note: When using wired authentication (including macsec_qca driver),
881 # eapol_flags must be set to 0 for the authentication to be completed
884 # macsec_policy: IEEE 802.1X/MACsec options
885 # This determines how sessions are secured with MACsec. It is currently
886 # applicable only when using the macsec_qca driver interface.
887 # 0: MACsec not in use (default)
888 # 1: MACsec enabled - Should secure, accept key server's advice to
889 # determine whether to use a secure session or not.
891 # mixed_cell: This option can be used to configure whether so called mixed
892 # cells, i.e., networks that use both plaintext and encryption in the same
893 # SSID, are allowed when selecting a BSS from scan results.
894 # 0 = disabled (default)
897 # proactive_key_caching:
898 # Enable/disable opportunistic PMKSA caching for WPA2.
899 # 0 = disabled (default unless changed with the global okc parameter)
902 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
903 # hex without quotation, e.g., 0102030405)
904 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
906 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
907 # allowed. This is only used with RSN/WPA2.
908 # 0 = disabled (default)
912 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
913 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
915 # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
916 # as the dot11RSNAConfigGroupRekeyTime parameter when operating in
917 # Authenticator role in IBSS.
919 # Following fields are only used with internal EAP implementation.
920 # eap: space-separated list of accepted EAP methods
921 # MD5 = EAP-MD5 (insecure and does not generate keying material ->
922 # cannot be used with WPA; to be used as a Phase 2 method
923 # with EAP-PEAP or EAP-TTLS)
924 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
925 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
926 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
927 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
928 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
929 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
930 # TLS = EAP-TLS (client and server certificate)
931 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
932 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
934 # If not set, all compiled in methods are allowed.
936 # identity: Identity string for EAP
937 # This field is also used to configure user NAI for
938 # EAP-PSK/PAX/SAKE/GPSK.
939 # anonymous_identity: Anonymous identity string for EAP (to be used as the
940 # unencrypted identity with EAP types that support different tunnelled
941 # identity, e.g., EAP-TTLS). This field can also be used with
942 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
943 # password: Password string for EAP. This field can include either the
944 # plaintext password (using ASCII or hex string) or a NtPasswordHash
945 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
946 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
947 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
948 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
949 # PSK) is also configured using this field. For EAP-GPSK, this is a
950 # variable length PSK. ext:<name of external password field> format can
951 # be used to indicate that the password is stored in external storage.
952 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
953 # or more trusted CA certificates. If ca_cert and ca_path are not
954 # included, server certificate will not be verified. This is insecure and
955 # a trusted CA certificate should always be configured when using
956 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
957 # change when wpa_supplicant is run in the background.
959 # Alternatively, this can be used to only perform matching of the server
960 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
961 # this case, the possible CA certificates in the server certificate chain
962 # are ignored and only the server certificate is verified. This is
963 # configured with the following format:
964 # hash:://server/sha256/cert_hash_in_hex
965 # For example: "hash://server/sha256/
966 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
968 # On Windows, trusted CA certificates can be loaded from the system
969 # certificate store by setting this to cert_store://<name>, e.g.,
970 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
971 # Note that when running wpa_supplicant as an application, the user
972 # certificate store (My user account) is used, whereas computer store
973 # (Computer account) is used when running wpasvc as a service.
974 # ca_path: Directory path for CA certificate files (PEM). This path may
975 # contain multiple CA certificates in OpenSSL format. Common use for this
976 # is to point to system trusted CA list which is often installed into
977 # directory like /etc/ssl/certs. If configured, these certificates are
978 # added to the list of trusted CAs. ca_cert may also be included in that
979 # case, but it is not required.
980 # client_cert: File path to client certificate file (PEM/DER)
981 # Full path should be used since working directory may change when
982 # wpa_supplicant is run in the background.
983 # Alternatively, a named configuration blob can be used by setting this
984 # to blob://<blob name>.
985 # private_key: File path to client private key file (PEM/DER/PFX)
986 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
987 # commented out. Both the private key and certificate will be read from
988 # the PKCS#12 file in this case. Full path should be used since working
989 # directory may change when wpa_supplicant is run in the background.
990 # Windows certificate store can be used by leaving client_cert out and
991 # configuring private_key in one of the following formats:
992 # cert://substring_to_match
993 # hash://certificate_thumbprint_in_hex
994 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
995 # Note that when running wpa_supplicant as an application, the user
996 # certificate store (My user account) is used, whereas computer store
997 # (Computer account) is used when running wpasvc as a service.
998 # Alternatively, a named configuration blob can be used by setting this
999 # to blob://<blob name>.
1000 # private_key_passwd: Password for private key file (if left out, this will be
1001 # asked through control interface)
1002 # dh_file: File path to DH/DSA parameters file (in PEM format)
1003 # This is an optional configuration file for setting parameters for an
1004 # ephemeral DH key exchange. In most cases, the default RSA
1005 # authentication does not use this configuration. However, it is possible
1006 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1007 # DSA keys always use ephemeral DH keys. This can be used to achieve
1008 # forward secrecy. If the file is in DSA parameters format, it will be
1009 # automatically converted into DH params.
1010 # subject_match: Substring to be matched against the subject of the
1011 # authentication server certificate. If this string is set, the server
1012 # certificate is only accepted if it contains this string in the subject.
1013 # The subject string is in following format:
1014 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
1015 # Note: Since this is a substring match, this cannot be used securely to
1016 # do a suffix match against a possible domain name in the CN entry. For
1017 # such a use case, domain_suffix_match or domain_match should be used
1019 # altsubject_match: Semicolon separated string of entries to be matched against
1020 # the alternative subject name of the authentication server certificate.
1021 # If this string is set, the server certificate is only accepted if it
1022 # contains one of the entries in an alternative subject name extension.
1023 # altSubjectName string is in following format: TYPE:VALUE
1024 # Example: EMAIL:server@example.com
1025 # Example: DNS:server.example.com;DNS:server2.example.com
1026 # Following types are supported: EMAIL, DNS, URI
1027 # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
1028 # used as a suffix match requirement for the AAA server certificate in
1029 # SubjectAltName dNSName element(s). If a matching dNSName is found, this
1030 # constraint is met. If no dNSName values are present, this constraint is
1031 # matched against SubjectName CN using same suffix match comparison.
1033 # Suffix match here means that the host/domain name is compared one label
1034 # at a time starting from the top-level domain and all the labels in
1035 # domain_suffix_match shall be included in the certificate. The
1036 # certificate may include additional sub-level labels in addition to the
1039 # For example, domain_suffix_match=example.com would match
1040 # test.example.com but would not match test-example.com.
1041 # domain_match: Constraint for server domain name
1042 # If set, this FQDN is used as a full match requirement for the
1043 # server certificate in SubjectAltName dNSName element(s). If a
1044 # matching dNSName is found, this constraint is met. If no dNSName
1045 # values are present, this constraint is matched against SubjectName CN
1046 # using same full match comparison. This behavior is similar to
1047 # domain_suffix_match, but has the requirement of a full match, i.e.,
1048 # no subdomains or wildcard matches are allowed. Case-insensitive
1049 # comparison is used, so "Example.com" matches "example.com", but would
1050 # not match "test.Example.com".
1051 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1052 # (string with field-value pairs, e.g., "peapver=0" or
1053 # "peapver=1 peaplabel=1")
1054 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
1055 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1056 # to be used during key derivation when PEAPv1 or newer. Most existing
1057 # PEAPv1 implementation seem to be using the old label, "client EAP
1058 # encryption", and wpa_supplicant is now using that as the default value.
1059 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1060 # interoperate with PEAPv1; see eap_testing.txt for more details.
1061 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
1062 # tunneled EAP-Success. This is required with some RADIUS servers that
1063 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1064 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1065 # include_tls_length=1 can be used to force wpa_supplicant to include
1066 # TLS Message Length field in all TLS messages even if they are not
1068 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1069 # challenges (by default, it accepts 2 or 3)
1070 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1071 # protected result indication.
1072 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1074 # * 0 = do not use cryptobinding (default)
1075 # * 1 = use cryptobinding if server supports it
1076 # * 2 = require cryptobinding
1077 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
1080 # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1081 # used to configure a mode that allows EAP-Success (and EAP-Failure)
1082 # without going through authentication step. Some switches use such
1083 # sequence when forcing the port to be authorized/unauthorized or as a
1084 # fallback option if the authentication server is unreachable. By default,
1085 # wpa_supplicant discards such frames to protect against potential attacks
1086 # by rogue devices, but this option can be used to disable that protection
1087 # for cases where the server/authenticator does not need to be
1089 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
1090 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
1091 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1092 # used to disable MSCHAPv2 password retry in authentication failure cases.
1094 # TLS-based methods can use the following parameters to control TLS behavior
1095 # (these are normally in the phase1 parameter, but can be used also in the
1096 # phase2 parameter when EAP-TLS is used within the inner tunnel):
1097 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1098 # TLS library, these may be disabled by default to enforce stronger
1100 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
1101 # the TLS library to accept certificates even if they are not currently
1102 # valid, i.e., have expired or have not yet become valid; this should be
1103 # used only for testing purposes)
1104 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1105 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1106 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1107 # as a workaround for broken authentication server implementations unless
1108 # EAP workarounds are disabled with eap_workaround=0.
1109 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
1110 # default value to be used automatically).
1111 # tls_disable_tlsv1_0=1 - disable use of TLSv1.0
1112 # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1113 # that have issues interoperating with updated TLS version)
1114 # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1115 # that have issues interoperating with updated TLS version)
1116 # tls_ext_cert_check=0 - No external server certificate validation (default)
1117 # tls_ext_cert_check=1 - External server certificate validation enabled; this
1118 # requires an external program doing validation of server certificate
1119 # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1120 # interface and report the result of the validation with
1121 # CTRL-RSP_EXT_CERT_CHECK.
1123 # Following certificate/private key fields are used in inner Phase2
1124 # authentication when using EAP-TTLS or EAP-PEAP.
1125 # ca_cert2: File path to CA certificate file. This file can have one or more
1126 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1127 # server certificate will not be verified. This is insecure and a trusted
1128 # CA certificate should always be configured.
1129 # ca_path2: Directory path for CA certificate files (PEM)
1130 # client_cert2: File path to client certificate file
1131 # private_key2: File path to client private key file
1132 # private_key2_passwd: Password for private key file
1133 # dh_file2: File path to DH/DSA parameters file (in PEM format)
1134 # subject_match2: Substring to be matched against the subject of the
1135 # authentication server certificate. See subject_match for more details.
1136 # altsubject_match2: Semicolon separated string of entries to be matched
1137 # against the alternative subject name of the authentication server
1138 # certificate. See altsubject_match documentation for more details.
1139 # domain_suffix_match2: Constraint for server domain name. See
1140 # domain_suffix_match for more details.
1142 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
1143 # This value limits the fragment size for EAP methods that support
1144 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1145 # small enough to make the EAP messages fit in MTU of the network
1146 # interface used for EAPOL. The default value is suitable for most
1149 # ocsp: Whether to use/require OCSP to check server certificate
1150 # 0 = do not use OCSP stapling (TLS certificate status extension)
1151 # 1 = try to use OCSP stapling, but not require response
1152 # 2 = require valid OCSP stapling response
1153 # 3 = require valid OCSP stapling response for all not-trusted
1154 # certificates in the server certificate chain
1156 # openssl_ciphers: OpenSSL specific cipher configuration
1157 # This can be used to override the global openssl_ciphers configuration
1158 # parameter (see above).
1160 # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1162 # EAP-FAST variables:
1163 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1164 # to create this file and write updates to it when PAC is being
1165 # provisioned or refreshed. Full path to the file should be used since
1166 # working directory may change when wpa_supplicant is run in the
1167 # background. Alternatively, a named configuration blob can be used by
1168 # setting this to blob://<blob name>
1169 # phase1: fast_provisioning option can be used to enable in-line provisioning
1170 # of EAP-FAST credentials (PAC):
1172 # 1 = allow unauthenticated provisioning,
1173 # 2 = allow authenticated provisioning,
1174 # 3 = allow both unauthenticated and authenticated provisioning
1175 # fast_max_pac_list_len=<num> option can be used to set the maximum
1176 # number of PAC entries to store in a PAC list (default: 10)
1177 # fast_pac_format=binary option can be used to select binary format for
1178 # storing PAC entries in order to save some space (the default
1179 # text format uses about 2.5 times the size of minimal binary
1182 # wpa_supplicant supports number of "EAP workarounds" to work around
1183 # interoperability issues with incorrectly behaving authentication servers.
1184 # These are enabled by default because some of the issues are present in large
1185 # number of authentication servers. Strict EAP conformance mode can be
1186 # configured by disabling workarounds with eap_workaround=0.
1188 # update_identifier: PPS MO ID
1189 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1191 # Station inactivity limit
1193 # If a station does not send anything in ap_max_inactivity seconds, an
1194 # empty data frame is sent to it in order to verify whether it is
1195 # still in range. If this frame is not ACKed, the station will be
1196 # disassociated and then deauthenticated. This feature is used to
1197 # clear station table of old entries when the STAs move out of the
1200 # The station can associate again with the AP if it is still in range;
1201 # this inactivity poll is just used as a nicer way of verifying
1202 # inactivity; i.e., client will not report broken connection because
1203 # disassociation frame is not sent immediately without first polling
1204 # the STA with a data frame.
1205 # default: 300 (i.e., 5 minutes)
1206 #ap_max_inactivity=300
1208 # DTIM period in Beacon intervals for AP mode (default: 2)
1211 # Beacon interval (default: 100 TU)
1215 # 0 = WPS enabled and configured (default)
1219 # MAC address policy
1220 # 0 = use permanent MAC address
1221 # 1 = use random MAC address for each ESS connection
1222 # 2 = like 1, but maintain OUI (with local admin bit set)
1225 # disable_ht: Whether HT (802.11n) should be disabled.
1226 # 0 = HT enabled (if AP supports it)
1229 # disable_ht40: Whether HT-40 (802.11n) should be disabled.
1230 # 0 = HT-40 enabled (if AP supports it)
1231 # 1 = HT-40 disabled
1233 # disable_sgi: Whether SGI (short guard interval) should be disabled.
1234 # 0 = SGI enabled (if AP supports it)
1237 # disable_ldpc: Whether LDPC should be disabled.
1238 # 0 = LDPC enabled (if AP supports it)
1241 # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1242 # 0 = 40 MHz tolerant (default)
1243 # 1 = 40 MHz intolerant
1245 # ht_mcs: Configure allowed MCS rates.
1246 # Parsed as an array of bytes, in base-16 (ascii-hex)
1247 # ht_mcs="" // Use all available (default)
1248 # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1249 # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1251 # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1252 # -1 = Do not make any changes.
1253 # 0 = Enable MAX-AMSDU if hardware supports it.
1256 # ampdu_factor: Maximum A-MPDU Length Exponent
1257 # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1259 # ampdu_density: Allow overriding AMPDU density configuration.
1260 # Treated as hint by the kernel.
1261 # -1 = Do not make any changes.
1262 # 0-3 = Set AMPDU density (aka factor) to specified value.
1264 # disable_vht: Whether VHT should be disabled.
1265 # 0 = VHT enabled (if AP supports it)
1268 # vht_capa: VHT capabilities to set in the override
1269 # vht_capa_mask: mask of VHT capabilities
1271 # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1272 # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1278 ##### Fast Session Transfer (FST) support #####################################
1280 # The options in this section are only available when the build configuration
1281 # option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1282 # interface to be a part of FST setup.
1284 # FST is the transfer of a session from a channel to another channel, in the
1285 # same or different frequency bands.
1287 # For details, see IEEE Std 802.11ad-2012.
1289 # Identifier of an FST Group the interface belongs to.
1292 # Interface priority within the FST Group.
1293 # Announcing a higher priority for an interface means declaring it more
1294 # preferable for FST switch.
1295 # fst_priority is in 1..255 range with 1 being the lowest priority.
1298 # Default LLT value for this interface in milliseconds. The value used in case
1299 # no value provided during session setup. Default is 50 msec.
1300 # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1301 # Transitioning between states).
1306 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1309 psk="very secret passphrase"
1313 # Same as previous, but request SSID-specific scanning (for APs that reject
1318 psk="very secret passphrase"
1322 # Only WPA-PSK is used. Any valid cipher combination is accepted.
1328 group=CCMP TKIP WEP104 WEP40
1329 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1333 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1340 psk="not so secure passphrase"
1344 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1345 # or WEP40 as the group cipher will not be accepted.
1353 identity="user@example.com"
1354 ca_cert="/etc/cert/ca.pem"
1355 client_cert="/etc/cert/user.pem"
1356 private_key="/etc/cert/user.prv"
1357 private_key_passwd="password"
1361 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1367 identity="user@example.com"
1369 ca_cert="/etc/cert/ca.pem"
1370 phase1="peaplabel=1"
1371 phase2="auth=MSCHAPV2"
1375 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1376 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1381 identity="user@example.com"
1382 anonymous_identity="anonymous@example.com"
1384 ca_cert="/etc/cert/ca.pem"
1388 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1389 # use. Real identity is sent only within an encrypted TLS tunnel.
1394 identity="user@example.com"
1395 anonymous_identity="anonymous@example.com"
1397 ca_cert="/etc/cert/ca.pem"
1398 phase2="auth=MSCHAPV2"
1401 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1407 # Phase1 / outer authentication
1408 anonymous_identity="anonymous@example.com"
1409 ca_cert="/etc/cert/ca.pem"
1410 # Phase 2 / inner authentication
1411 phase2="autheap=TLS"
1412 ca_cert2="/etc/cert/ca2.pem"
1413 client_cert2="/etc/cer/user.pem"
1414 private_key2="/etc/cer/user.prv"
1415 private_key2_passwd="password"
1419 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1423 bssid=00:11:22:33:44:55
1425 key_mgmt=WPA-PSK WPA-EAP
1428 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1431 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1432 # and all valid ciphers.
1435 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1439 # EAP-SIM with a GSM SIM or USIM
1454 anonymous_identity="eap_psk_user"
1455 password=06b4be19da289f475aa46a33cb793029
1456 identity="eap_psk_user@example.com"
1460 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1461 # EAP-TLS for authentication and key generation; require both unicast and
1462 # broadcast WEP keys.
1467 identity="user@example.com"
1468 ca_cert="/etc/cert/ca.pem"
1469 client_cert="/etc/cert/user.pem"
1470 private_key="/etc/cert/user.prv"
1471 private_key_passwd="password"
1476 # LEAP with dynamic WEP keys
1485 # EAP-IKEv2 using shared secrets for both server and peer authentication
1487 ssid="ikev2-example"
1494 # EAP-FAST with WPA (WPA or WPA2)
1496 ssid="eap-fast-test"
1499 anonymous_identity="FAST-000102030405"
1502 phase1="fast_provisioning=1"
1503 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1507 ssid="eap-fast-test"
1510 anonymous_identity="FAST-000102030405"
1513 phase1="fast_provisioning=1"
1514 pac_file="blob://eap-fast-pac"
1517 # Plaintext connection (no WPA, no IEEE 802.1X)
1519 ssid="plaintext-test"
1524 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1526 ssid="static-wep-test"
1530 wep_key2="1234567890123"
1536 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1537 # IEEE 802.11 authentication
1539 ssid="static-wep-test2"
1543 wep_key2="1234567890123"
1550 # IBSS/ad-hoc network with RSN
1562 # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
1571 psk="secret passphrase"
1582 # secure (SAE + AMPE) network
1588 psk="very secret passphrase"
1592 # Catch all example that allows more or less all configuration modes
1596 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1598 group=CCMP TKIP WEP104 WEP40
1599 psk="very secret passphrase"
1601 identity="user@example.com"
1603 ca_cert="/etc/cert/ca.pem"
1604 client_cert="/etc/cert/user.pem"
1605 private_key="/etc/cert/user.prv"
1606 private_key_passwd="password"
1607 phase1="peaplabel=0"
1610 # Example of EAP-TLS with smartcard (openssl engine)
1618 identity="user@example.com"
1619 ca_cert="/etc/cert/ca.pem"
1621 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1622 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1623 private_key="pkcs11:manufacturer=piv_II;id=%01"
1625 # Optional PIN configuration; this can be left out and PIN will be
1626 # asked through the control interface
1630 # Example configuration showing how to use an inlined blob as a CA certificate
1631 # data instead of using external file
1636 identity="user@example.com"
1637 anonymous_identity="anonymous@example.com"
1639 ca_cert="blob://exampleblob"
1643 blob-base64-exampleblob={
1644 SGVsbG8gV29ybGQhCg==
1648 # Wildcard match for SSID (plaintext APs only). This example select any
1649 # open AP regardless of its SSID.
1654 # Example configuration blacklisting two APs - these will be ignored
1658 psk="very secret passphrase"
1659 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1662 # Example configuration limiting AP selection to a specific set of APs;
1663 # any other AP not matching the masked address will be ignored.
1666 psk="very secret passphrase"
1667 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
1670 # Example config file that will only scan on channel 36.
1677 # Example MACsec configuration
1679 # key_mgmt=IEEE8021X
1682 # anonymous_identity="anonymous@example.com"
1683 # identity="user@example.com"
1684 # password="secretr"
1685 # ca_cert="/etc/cert/ca.pem"