1 ##### Example wpa_supplicant configuration file ###############################
3 # ***** Please check wpa_supplicant.conf(5) for details on these options *****
5 # This file describes configuration file format and lists all available option.
6 # Please also take a look at simpler configuration examples in 'examples'
9 # Empty lines and lines starting with # are ignored
11 # NOTE! This file may contain password information and should probably be made
12 # readable only by root user on multiuser systems.
14 # Note: All file paths in this configuration file should use full (absolute,
15 # not relative to working directory) path in order to allow working directory
16 # to be changed. This can happen if wpa_supplicant is run in the background.
18 # Whether to allow wpa_supplicant to update (overwrite) configuration
20 # This option can be used to allow wpa_supplicant to overwrite configuration
21 # file whenever configuration is changed (e.g., new network block is added with
22 # wpa_cli or wpa_gui, or a password is changed). This is required for
23 # wpa_cli/wpa_gui to be able to store the configuration changes permanently.
24 # Please note that overwriting configuration file will remove the comments from
28 # global configuration (shared by all network blocks)
30 # Parameters for the control interface. If this is specified, wpa_supplicant
31 # will open a control interface that is available for external programs to
32 # manage wpa_supplicant. The meaning of this string depends on which control
33 # interface mechanism is used. For all cases, the existence of this parameter
34 # in configuration is used to determine whether the control interface is
37 # For UNIX domain sockets (default on Linux and BSD): This is a directory that
38 # will be created for UNIX domain sockets for listening to requests from
39 # external programs (CLI/GUI, etc.) for status information and configuration.
40 # The socket file will be named based on the interface name, so multiple
41 # wpa_supplicant processes can be run at the same time if more than one
43 # /var/run/wpa_supplicant is the recommended directory for sockets and by
44 # default, wpa_cli will use it when trying to connect with wpa_supplicant.
46 # Access control for the control interface can be configured by setting the
47 # directory to allow only members of a group to use sockets. This way, it is
48 # possible to run wpa_supplicant as root (since it needs to change network
49 # configuration and open raw sockets) and still allow GUI/CLI components to be
50 # run as non-root users. However, since the control interface can be used to
51 # change the network configuration, this access needs to be protected in many
52 # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
53 # want to allow non-root users to use the control interface, add a new group
54 # and change this value to match with that group. Add users that should have
55 # control interface access to this group. If this variable is commented out or
56 # not included in the configuration file, group will not be changed from the
57 # value it got by default when the directory or socket was created.
59 # When configuring both the directory and group, use following format:
60 # DIR=/var/run/wpa_supplicant GROUP=wheel
61 # DIR=/var/run/wpa_supplicant GROUP=0
62 # (group can be either group name or gid)
64 ctrl_interface=/var/run/wpa_supplicant
66 # IEEE 802.1X/EAPOL version
67 # wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
68 # EAPOL version 2. However, there are many APs that do not handle the new
69 # version number correctly (they seem to drop the frames completely). In order
70 # to make wpa_supplicant interoperate with these APs, the version number is set
71 # to 1 by default. This configuration value can be used to set it to the new
73 # Note: When using MACsec, eapol_version shall be set to 3, which is
74 # defined in IEEE Std 802.1X-2010.
77 # AP scanning/selection
78 # By default, wpa_supplicant requests driver to perform AP scanning and then
79 # uses the scan results to select a suitable AP. Another alternative is to
80 # allow the driver to take care of AP scanning and selection and use
81 # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
82 # information from the driver.
83 # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
84 # the currently enabled networks are found, a new network (IBSS or AP mode
85 # operation) may be initialized (if configured) (default)
86 # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
87 # parameters (e.g., WPA IE generation); this mode can also be used with
88 # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
89 # APs (i.e., external program needs to control association). This mode must
90 # also be used when using wired Ethernet drivers (including MACsec).
91 # 2: like 0, but associate with APs using security policy and SSID (but not
92 # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
93 # enable operation with hidden SSIDs and optimized roaming; in this mode,
94 # the network blocks in the configuration file are tried one by one until
95 # the driver reports successful association; each network block should have
96 # explicit security policy (i.e., only one option in the lists) for
97 # key_mgmt, pairwise, group, proto variables
99 # For use in FreeBSD with the wlan module ap_scan must be set to 1.
101 # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
102 # created immediately regardless of scan results. ap_scan=1 mode will first try
103 # to scan for existing networks and only if no matches with the enabled
104 # networks are found, a new IBSS or AP mode network is created.
107 # Whether to force passive scan for network connection
109 # By default, scans will send out Probe Request frames on channels that allow
110 # active scanning. This advertise the local station to the world. Normally this
111 # is fine, but users may wish to do passive scanning where the radio should only
112 # listen quietly for Beacon frames and not send any Probe Request frames. Actual
113 # functionality may be driver dependent.
115 # This parameter can be used to force only passive scanning to be used
116 # for network connection cases. It should be noted that this will slow
117 # down scan operations and reduce likelihood of finding the AP. In
118 # addition, some use cases will override this due to functional
119 # requirements, e.g., for finding an AP that uses hidden SSID
120 # (scan_ssid=1) or P2P device discovery.
122 # 0: Do normal scans (allow active scans) (default)
123 # 1: Do passive scans.
127 # By default, wpa_supplicant implements the mesh peering manager (MPM) for an
128 # open mesh. However, if the driver can implement the MPM, you may set this to
129 # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
131 # 0: MPM lives in the driver
132 # 1: wpa_supplicant provides an MPM which handles peering (default)
135 # Maximum number of peer links (0-255; default: 99)
136 # Maximum number of mesh peering currently maintained by the STA.
139 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
141 # This timeout value is used in mesh STA to clean up inactive stations.
142 #mesh_max_inactivity=300
144 # cert_in_cb - Whether to include a peer certificate dump in events
145 # This controls whether peer certificates for authentication server and
146 # its certificate chain are included in EAP peer certificate events. This is
147 # enabled by default.
150 # EAP fast re-authentication
151 # By default, fast re-authentication is enabled for all EAP methods that
152 # support it. This variable can be used to disable fast re-authentication.
153 # Normally, there is no need to disable this.
156 # OpenSSL Engine support
157 # These options can be used to load OpenSSL engines in special or legacy
159 # The two engines that are supported currently are shown below:
160 # They are both from the opensc project (http://www.opensc.org/)
161 # By default the PKCS#11 engine is loaded if the client_cert or
162 # private_key option appear to be a PKCS#11 URI, and these options
163 # should not need to be used explicitly.
164 # make the opensc engine available
165 #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
166 # make the pkcs11 engine available
167 #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
168 # configure the path to the pkcs11 module required by the pkcs11 engine
169 #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
171 # OpenSSL cipher string
173 # This is an OpenSSL specific configuration option for configuring the default
174 # ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
175 # by default) is used.
176 # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
177 # on cipher suite configuration. This is applicable only if wpa_supplicant is
178 # built to use OpenSSL.
179 #openssl_ciphers=DEFAULT:!EXP:!LOW
181 # Dynamic EAP methods
182 # If EAP methods were built dynamically as shared object files, they need to be
183 # loaded here before being used in the network blocks. By default, EAP methods
184 # are included statically in the build, so these lines are not needed
185 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
186 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
188 # Driver interface parameters
189 # This field can be used to configure arbitrary driver interface parameters. The
190 # format is specific to the selected driver interface. This field is not used
192 #driver_param="field=value"
195 # The ISO/IEC alpha2 country code for the country in which this device is
196 # currently operating.
199 # Maximum lifetime for PMKSA in seconds; default 43200
200 #dot11RSNAConfigPMKLifetime=43200
201 # Threshold for reauthentication (percentage of PMK lifetime); default 70
202 #dot11RSNAConfigPMKReauthThreshold=70
203 # Timeout for security association negotiation in seconds; default 60
204 #dot11RSNAConfigSATimeout=60
206 # Wi-Fi Protected Setup (WPS) parameters
208 # Universally Unique IDentifier (UUID; see RFC 4122) of the device
209 # If not configured, UUID will be generated based on the mechanism selected with
210 # the auto_uuid parameter.
211 #uuid=12345678-9abc-def0-1234-56789abcdef0
213 # Automatic UUID behavior
214 # 0 = generate static value based on the local MAC address (default)
215 # 1 = generate a random UUID every time wpa_supplicant starts
219 # User-friendly description of device; up to 32 octets encoded in UTF-8
220 #device_name=Wireless Client
223 # The manufacturer of the device (up to 64 ASCII characters)
224 #manufacturer=Company
227 # Model of the device (up to 32 ASCII characters)
231 # Additional device description (up to 32 ASCII characters)
235 # Serial number of the device (up to 32 characters)
238 # Primary Device Type
239 # Used format: <categ>-<OUI>-<subcateg>
240 # categ = Category as an integer value
241 # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
243 # subcateg = OUI-specific Sub Category as an integer value
245 # 1-0050F204-1 (Computer / PC)
246 # 1-0050F204-2 (Computer / Server)
247 # 5-0050F204-1 (Storage / NAS)
248 # 6-0050F204-1 (Network Infrastructure / AP)
249 #device_type=1-0050F204-1
252 # 4-octet operating system version number (hex string)
256 # List of the supported configuration methods
257 # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
258 # nfc_interface push_button keypad virtual_display physical_display
259 # virtual_push_button physical_push_button
261 #config_methods=label display push_button keypad
263 #config_methods=label virtual_display virtual_push_button keypad
265 # Credential processing
266 # 0 = process received credentials internally (default)
267 # 1 = do not process received credentials; just pass them over ctrl_iface to
268 # external program(s)
269 # 2 = process received credentials internally and pass them over ctrl_iface
270 # to external program(s)
271 #wps_cred_processing=0
273 # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
274 # The vendor attribute contents to be added in M1 (hex string)
275 #wps_vendor_ext_m1=000137100100020001
277 # NFC password token for WPS
278 # These parameters can be used to configure a fixed NFC password token for the
279 # station. This can be generated, e.g., with nfc_pw_token. When these
280 # parameters are used, the station is assumed to be deployed with a NFC tag
281 # that includes the matching NFC password token (e.g., written based on the
282 # NDEF record from nfc_pw_token).
284 #wps_nfc_dev_pw_id: Device Password ID (16..65535)
285 #wps_nfc_dh_pubkey: Hexdump of DH Public Key
286 #wps_nfc_dh_privkey: Hexdump of DH Private Key
287 #wps_nfc_dev_pw: Hexdump of Device Password
289 # Priority for the networks added through WPS
290 # This priority value will be set to each network profile that is added
291 # by executing the WPS protocol.
294 # Maximum number of BSS entries to keep in memory
296 # This can be used to limit memory use on the BSS entries (cached scan
297 # results). A larger value may be needed in environments that have huge number
298 # of APs when using ap_scan=1 mode.
302 # This is an optional set of parameters for automatic scanning
303 # within an interface in following format:
304 #autoscan=<autoscan module name>:<module parameters>
305 # autoscan is like bgscan but on disconnected or inactive state.
306 # For instance, on exponential module parameters would be <base>:<limit>
307 #autoscan=exponential:3:300
308 # Which means a delay between scans on a base exponential of 3,
309 # up to the limit of 300 seconds (3, 9, 27 ... 300)
310 # For periodic module, parameters would be <fixed interval>
311 #autoscan=periodic:30
312 # So a delay of 30 seconds will be applied between each scan.
313 # Note: If sched_scan_plans are configured and supported by the driver,
314 # autoscan is ignored.
316 # filter_ssids - SSID-based scan result filtering
317 # 0 = do not filter scan results (default)
318 # 1 = only include configured SSIDs in scan results/BSS table
321 # Password (and passphrase, etc.) backend for external storage
322 # format: <backend name>[:<optional backend parameters>]
323 #ext_password_backend=test:pw1=password|pw2=testing
326 # Disable P2P functionality
329 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
331 # This timeout value is used in P2P GO mode to clean up
333 #p2p_go_max_inactivity=300
335 # Passphrase length (8..63) for P2P GO
337 # This parameter controls the length of the random passphrase that is
338 # generated at the GO. Default: 8.
339 #p2p_passphrase_len=8
341 # Extra delay between concurrent P2P search iterations
343 # This value adds extra delay in milliseconds between concurrent search
344 # iterations to make p2p_find friendlier to concurrent operations by avoiding
345 # it from taking 100% of radio resources. The default value is 500 ms.
346 #p2p_search_delay=500
348 # Opportunistic Key Caching (also known as Proactive Key Caching) default
349 # This parameter can be used to set the default behavior for the
350 # proactive_key_caching parameter. By default, OKC is disabled unless enabled
351 # with the global okc=1 parameter or with the per-network
352 # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
353 # can be disabled with per-network proactive_key_caching=0 parameter.
356 # Protected Management Frames default
357 # This parameter can be used to set the default behavior for the ieee80211w
358 # parameter for RSN networks. By default, PMF is disabled unless enabled with
359 # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
360 # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
361 # per-network ieee80211w parameter. This global default value does not apply
362 # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
366 # Enabled SAE finite cyclic groups in preference order
367 # By default (if this parameter is not set), the mandatory group 19 (ECC group
368 # defined over a 256-bit prime order field) is preferred, but other groups are
369 # also enabled. If this parameter is set, the groups will be tried in the
370 # indicated order. The group values are listed in the IANA registry:
371 # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
372 #sae_groups=21 20 19 26 25
374 # Default value for DTIM period (if not overridden in network block)
377 # Default value for Beacon interval (if not overridden in network block)
380 # Additional vendor specific elements for Beacon and Probe Response frames
381 # This parameter can be used to add additional vendor specific element(s) into
382 # the end of the Beacon and Probe Response frames. The format for these
383 # element(s) is a hexdump of the raw information elements (id+len+payload for
384 # one or more elements). This is used in AP and P2P GO modes.
385 #ap_vendor_elements=dd0411223301
387 # Ignore scan results older than request
389 # The driver may have a cache of scan results that makes it return
390 # information that is older than our scan trigger. This parameter can
391 # be used to configure such old information to be ignored instead of
392 # allowing it to update the internal BSS table.
393 #ignore_old_scan_res=0
395 # scan_cur_freq: Whether to scan only the current frequency
396 # 0: Scan all available frequencies. (Default)
397 # 1: Scan current operating frequency if another VIF on the same radio
398 # is already associated.
400 # MAC address policy default
401 # 0 = use permanent MAC address
402 # 1 = use random MAC address for each ESS connection
403 # 2 = like 1, but maintain OUI (with local admin bit set)
405 # By default, permanent MAC address is used unless policy is changed by
406 # the per-network mac_addr parameter. Global mac_addr=1 can be used to
407 # change this default behavior.
410 # Lifetime of random MAC address in seconds (default: 60)
411 #rand_addr_lifetime=60
413 # MAC address policy for pre-association operations (scanning, ANQP)
414 # 0 = use permanent MAC address
415 # 1 = use random MAC address
416 # 2 = like 1, but maintain OUI (with local admin bit set)
419 # MAC address policy for GAS operations
420 # 0 = use permanent MAC address
421 # 1 = use random MAC address
422 # 2 = like 1, but maintain OUI (with local admin bit set)
425 # Lifetime of GAS random MAC address in seconds (default: 60)
426 #gas_rand_addr_lifetime=60
428 # Interworking (IEEE 802.11u)
430 # Enable Interworking
433 # Enable P2P GO advertisement of Interworking
436 # P2P GO Interworking: Access Network Type
437 # 0 = Private network
438 # 1 = Private network with guest access
439 # 2 = Chargeable public network
440 # 3 = Free public network
441 # 4 = Personal device network
442 # 5 = Emergency services only network
443 # 14 = Test or experimental
445 #go_access_network_type=0
447 # P2P GO Interworking: Whether the network provides connectivity to the Internet
449 # 1 = Network provides connectivity to the Internet
452 # P2P GO Interworking: Group Venue Info (optional)
453 # The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
454 # Example values (group,type):
456 # 1,7 = Convention Center
458 # 2,0 = Unspecified Business
459 # 7,1 Private Residence
463 # Homogenous ESS identifier
464 # If this is set, scans will be used to request response only from BSSes
465 # belonging to the specified Homogeneous ESS. This is used only if interworking
467 # hessid=00:11:22:33:44:55
469 # Automatic network selection behavior
470 # 0 = do not automatically go through Interworking network selection
471 # (i.e., require explicit interworking_select command for this; default)
472 # 1 = perform Interworking network selection if one or more
473 # credentials have been configured and scan did not find a
474 # matching network block
477 # GAS Address3 field behavior
478 # 0 = P2P specification (Address3 = AP BSSID); default
479 # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
480 # sent to not-associated AP; if associated, AP BSSID)
483 # Publish fine timing measurement (FTM) responder functionality in
484 # the Extended Capabilities element bit 70.
485 # Controls whether FTM responder functionality will be published by AP/STA.
486 # Note that actual FTM responder operation is managed outside wpa_supplicant.
487 # 0 = Do not publish; default
491 # Publish fine timing measurement (FTM) initiator functionality in
492 # the Extended Capabilities element bit 71.
493 # Controls whether FTM initiator functionality will be published by AP/STA.
494 # Note that actual FTM initiator operation is managed outside wpa_supplicant.
495 # 0 = Do not publish; default
501 # Each credential used for automatic network selection is configured as a set
502 # of parameters that are compared to the information advertised by the APs when
503 # interworking_select and interworking_connect commands are used.
507 # temporary: Whether this credential is temporary and not to be saved
509 # priority: Priority group
510 # By default, all networks and credentials get the same priority group
511 # (0). This field can be used to give higher priority for credentials
512 # (and similarly in struct wpa_ssid for network blocks) to change the
513 # Interworking automatic networking selection behavior. The matching
514 # network (based on either an enabled network block or a credential)
515 # with the highest priority value will be selected.
517 # pcsc: Use PC/SC and SIM/USIM card
519 # realm: Home Realm for Interworking
521 # username: Username for Interworking network selection
523 # password: Password for Interworking network selection
525 # ca_cert: CA certificate for Interworking network selection
527 # client_cert: File path to client certificate file (PEM/DER)
528 # This field is used with Interworking networking selection for a case
529 # where client certificate/private key is used for authentication
530 # (EAP-TLS). Full path to the file should be used since working
531 # directory may change when wpa_supplicant is run in the background.
533 # Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
535 # For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
537 # Alternatively, a named configuration blob can be used by setting
538 # this to blob://blob_name.
540 # private_key: File path to client private key file (PEM/DER/PFX)
541 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
542 # commented out. Both the private key and certificate will be read
543 # from the PKCS#12 file in this case. Full path to the file should be
544 # used since working directory may change when wpa_supplicant is run
547 # Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
548 # For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
550 # Windows certificate store can be used by leaving client_cert out and
551 # configuring private_key in one of the following formats:
553 # cert://substring_to_match
555 # hash://certificate_thumbprint_in_hex
557 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
559 # Note that when running wpa_supplicant as an application, the user
560 # certificate store (My user account) is used, whereas computer store
561 # (Computer account) is used when running wpasvc as a service.
563 # Alternatively, a named configuration blob can be used by setting
564 # this to blob://blob_name.
566 # private_key_passwd: Password for private key file
568 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
570 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
573 # domain: Home service provider FQDN(s)
574 # This is used to compare against the Domain Name List to figure out
575 # whether the AP is operated by the Home SP. Multiple domain entries can
576 # be used to configure alternative FQDNs that will be considered home
579 # roaming_consortium: Roaming Consortium OI
580 # If roaming_consortium_len is non-zero, this field contains the
581 # Roaming Consortium OI that can be used to determine which access
582 # points support authentication with this credential. This is an
583 # alternative to the use of the realm parameter. When using Roaming
584 # Consortium to match the network, the EAP parameters need to be
585 # pre-configured with the credential since the NAI Realm information
586 # may not be available or fetched.
588 # required_roaming_consortium: Required Roaming Consortium OI
589 # If required_roaming_consortium_len is non-zero, this field contains the
590 # Roaming Consortium OI that is required to be advertised by the AP for
591 # the credential to be considered matching.
593 # roaming_consortiums: Roaming Consortium OI(s) memberships
594 # This string field contains one or more comma delimited OIs (hexdump)
595 # identifying the roaming consortiums of which the provider is a member.
596 # The list is sorted from the most preferred one to the least preferred
597 # one. A match between the Roaming Consortium OIs advertised by an AP and
598 # the OIs in this list indicates that successful authentication is
600 # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
602 # eap: Pre-configured EAP method
603 # This optional field can be used to specify which EAP method will be
604 # used with this credential. If not set, the EAP method is selected
605 # automatically based on ANQP information (e.g., NAI Realm).
607 # phase1: Pre-configure Phase 1 (outer authentication) parameters
608 # This optional field is used with like the 'eap' parameter.
610 # phase2: Pre-configure Phase 2 (inner authentication) parameters
611 # This optional field is used with like the 'eap' parameter.
613 # excluded_ssid: Excluded SSID
614 # This optional field can be used to excluded specific SSID(s) from
615 # matching with the network. Multiple entries can be used to specify more
618 # roaming_partner: Roaming partner information
619 # This optional field can be used to configure preferences between roaming
620 # partners. The field is a string in following format:
621 # <FQDN>,<0/1 exact match>,<priority>,<* or country code>
622 # (non-exact match means any subdomain matches the entry; priority is in
623 # 0..255 range with 0 being the highest priority)
625 # update_identifier: PPS MO ID
626 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
628 # provisioning_sp: FQDN of the SP that provisioned the credential
629 # This optional field can be used to keep track of the SP that provisioned
630 # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
632 # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
633 # These fields can be used to specify minimum download/upload backhaul
634 # bandwidth that is preferred for the credential. This constraint is
635 # ignored if the AP does not advertise WAN Metrics information or if the
636 # limit would prevent any connection. Values are in kilobits per second.
637 # min_dl_bandwidth_home
638 # min_ul_bandwidth_home
639 # min_dl_bandwidth_roaming
640 # min_ul_bandwidth_roaming
642 # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
643 # (PPS/<X+>/Policy/MaximumBSSLoadValue)
644 # This value is used as the maximum channel utilization for network
645 # selection purposes for home networks. If the AP does not advertise
646 # BSS Load or if the limit would prevent any connection, this constraint
649 # req_conn_capab: Required connection capability
650 # (PPS/<X+>/Policy/RequiredProtoPortTuple)
651 # This value is used to configure set of required protocol/port pairs that
652 # a roaming network shall support (include explicitly in Connection
653 # Capability ANQP element). This constraint is ignored if the AP does not
654 # advertise Connection Capability or if this constraint would prevent any
655 # network connection. This policy is not used in home networks.
656 # Format: <protocol>[:<comma-separated list of ports]
657 # Multiple entries can be used to list multiple requirements.
658 # For example, number of common TCP protocols:
659 # req_conn_capab=6,22,80,443
660 # For example, IPSec/IKE:
661 # req_conn_capab=17:500
664 # ocsp: Whether to use/require OCSP to check server certificate
665 # 0 = do not use OCSP stapling (TLS certificate status extension)
666 # 1 = try to use OCSP stapling, but not require response
667 # 2 = require valid OCSP stapling response
668 # 3 = require valid OCSP stapling response for all not-trusted
669 # certificates in the server certificate chain
671 # sim_num: Identifier for which SIM to use in multi-SIM devices
676 # realm="example.com"
677 # username="user@example.com"
678 # password="password"
679 # ca_cert="/etc/wpa_supplicant/ca.pem"
680 # domain="example.com"
684 # imsi="310026-000000000"
685 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
689 # realm="example.com"
691 # password="password"
692 # ca_cert="/etc/wpa_supplicant/ca.pem"
693 # domain="example.com"
694 # roaming_consortium=223344
696 # phase2="auth=MSCHAPV2"
702 # Scheduled scan plans
704 # A space delimited list of scan plans. Each scan plan specifies the scan
705 # interval and number of iterations, delimited by a colon. The last scan plan
706 # will run infinitely and thus must specify only the interval and not the number
709 # The driver advertises the maximum number of scan plans supported. If more scan
710 # plans than supported are configured, only the first ones are set (up to the
711 # maximum supported). The last scan plan that specifies only the interval is
712 # always set as the last plan.
714 # If the scan interval or the number of iterations for a scan plan exceeds the
715 # maximum supported, it will be set to the maximum supported value.
718 # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
721 # sched_scan_plans=10:100 20:200 30
723 # Multi Band Operation (MBO) non-preferred channels
724 # A space delimited list of non-preferred channels where each channel is a colon
725 # delimited list of values.
727 # non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
729 # non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
731 # MBO Cellular Data Capabilities
732 # 1 = Cellular data connection available
733 # 2 = Cellular data connection not available
734 # 3 = Not cellular capable (default)
737 # Optimized Connectivity Experience (OCE)
738 # oce: Enable OCE features (bitmap)
739 # Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
740 # does not indicate support for OCE in STA mode)
741 # Set BIT(1) to Enable OCE in STA-CFON mode
746 # Each network (usually AP's sharing the same SSID) is configured as a separate
747 # block in this configuration file. The network blocks are in preference order
748 # (the first match is used).
750 # network block fields:
753 # 0 = this network can be used (default)
754 # 1 = this network block is disabled (can be enabled through ctrl_iface,
755 # e.g., with wpa_cli or wpa_gui)
757 # id_str: Network identifier string for external scripts. This value is passed
758 # to external action script through wpa_cli as WPA_ID_STR environment
759 # variable to make it easier to do network specific configuration.
761 # ssid: SSID (mandatory); network name in one of the optional formats:
762 # - an ASCII string with double quotation
763 # - a hex string (two characters per octet of SSID)
764 # - a printf-escaped ASCII string P"<escaped string>"
767 # 0 = do not scan this SSID with specific Probe Request frames (default)
768 # 1 = scan with SSID-specific Probe Request frames (this can be used to
769 # find APs that hide (do not broadcast) SSID or use multiple SSIDs;
770 # this will add latency to scanning, so enable this only when needed)
772 # bssid: BSSID (optional); if set, this network block is used only when
773 # associating with the AP using the configured BSSID
775 # priority: priority group (integer)
776 # By default, all networks will get same priority group (0). If some of the
777 # networks are more desirable, this field can be used to change the order in
778 # which wpa_supplicant goes through the networks when selecting a BSS. The
779 # priority groups will be iterated in decreasing priority (i.e., the larger the
780 # priority value, the sooner the network is matched against the scan results).
781 # Within each priority group, networks will be selected based on security
782 # policy, signal strength, etc.
783 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
784 # using this priority to select the order for scanning. Instead, they try the
785 # networks in the order that they are listed in the configuration file.
787 # mode: IEEE 802.11 operation mode
788 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
789 # 1 = IBSS (ad-hoc, peer-to-peer)
790 # 2 = AP (access point)
791 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
792 # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
793 # TKIP/CCMP) is available for backwards compatibility, but its use is
794 # deprecated. WPA-None requires following network block options:
795 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
796 # both), and psk must also be set.
798 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
799 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
800 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
801 # In addition, this value is only used by the station that creates the IBSS. If
802 # an IBSS network with the configured SSID is already present, the frequency of
803 # the network will be used instead of this configured value.
805 # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
806 # 0 = do not use PBSS
808 # 2 = don't care (not allowed in AP mode)
809 # Used together with mode configuration. When mode is AP, it means to start a
810 # PCP instead of a regular AP. When mode is infrastructure it means connect
811 # to a PCP instead of AP. In this mode you can also specify 2 (don't care)
812 # which means connect to either PCP or AP.
813 # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
814 # For more details, see IEEE Std 802.11ad-2012.
816 # scan_freq: List of frequencies to scan
817 # Space-separated list of frequencies in MHz to scan when searching for this
818 # BSS. If the subset of channels used by the network is known, this option can
819 # be used to optimize scanning to not occur on channels that the network does
820 # not use. Example: scan_freq=2412 2437 2462
822 # freq_list: Array of allowed frequencies
823 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
824 # set, scan results that do not match any of the specified frequencies are not
825 # considered when selecting a BSS.
827 # This can also be set on the outside of the network block. In this case,
828 # it limits the frequencies that will be scanned.
830 # bgscan: Background scanning
831 # wpa_supplicant behavior for background scanning can be specified by
832 # configuring a bgscan module. These modules are responsible for requesting
833 # background scans for the purpose of roaming within an ESS (i.e., within a
834 # single network block with all the APs using the same SSID). The bgscan
835 # parameter uses following format: "<bgscan module name>:<module parameters>"
836 # Following bgscan modules are available:
837 # simple - Periodic background scans based on signal strength
838 # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
840 # bgscan="simple:30:-45:300"
841 # learn - Learn channels used by the network and try to avoid bgscans on other
842 # channels (experimental)
843 # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
844 # <long interval>[:<database file name>]"
845 # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
846 # Explicitly disable bgscan by setting
849 # This option can also be set outside of all network blocks for the bgscan
850 # parameter to apply for all the networks that have no specific bgscan
853 # proto: list of accepted protocols
854 # WPA = WPA/IEEE 802.11i/D3.0
855 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
856 # Note that RSN is used also for WPA3.
857 # If not set, this defaults to: WPA RSN
859 # key_mgmt: list of accepted authenticated key management protocols
860 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
861 # WPA-EAP = WPA using EAP authentication
862 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
864 # NONE = WPA is not used; plaintext or static WEP could be used
865 # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
867 # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
868 # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
869 # FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
871 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
872 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
873 # SAE = Simultaneous authentication of equals; pre-shared key/password -based
874 # authentication with stronger security than WPA-PSK especially when using
875 # not that strong password; a.k.a. WPA3-Personal
876 # FT-SAE = SAE with FT
877 # WPA-EAP-SUITE-B = Suite B 128-bit level
878 # WPA-EAP-SUITE-B-192 = Suite B 192-bit level
879 # OSEN = Hotspot 2.0 Rel 2 online signup connection
880 # FILS-SHA256 = Fast Initial Link Setup with SHA256
881 # FILS-SHA384 = Fast Initial Link Setup with SHA384
882 # FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
883 # FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
884 # OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
885 # DPP = Device Provisioning Protocol
886 # If not set, this defaults to: WPA-PSK WPA-EAP
888 # ieee80211w: whether management frame protection is enabled
889 # 0 = disabled (default unless changed with the global pmf parameter)
892 # The most common configuration options for this based on the PMF (protected
893 # management frames) certification program are:
894 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
895 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
896 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
898 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
899 # OPEN = Open System authentication (required for WPA/WPA2)
900 # SHARED = Shared Key authentication (requires static WEP keys)
901 # LEAP = LEAP/Network EAP (only used with LEAP)
902 # If not set, automatic selection is used (Open System with LEAP enabled if
903 # LEAP is allowed as one of the EAP methods).
905 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
906 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
907 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
908 # NONE = Use only Group Keys (deprecated, should not be included if APs support
910 # If not set, this defaults to: CCMP TKIP
912 # group: list of accepted group (broadcast/multicast) ciphers for WPA
913 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
914 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
915 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
916 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
917 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
919 # group_mgmt: list of accepted group management ciphers for RSN (PMF)
920 # AES-128-CMAC = BIP-CMAC-128
924 # If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
927 # psk: WPA preshared key; 256-bit pre-shared key
928 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
929 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
930 # generated using the passphrase and SSID). ASCII passphrase must be between
931 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
932 # be used to indicate that the PSK/passphrase is stored in external storage.
933 # This field is not needed, if WPA-EAP is used.
934 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
935 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
936 # startup and reconfiguration time can be optimized by generating the PSK only
937 # only when the passphrase or SSID has actually changed.
939 # mem_only_psk: Whether to keep PSK/passphrase only in memory
940 # 0 = allow psk/passphrase to be stored to the configuration file
941 # 1 = do not store psk/passphrase to the configuration file
944 # sae_password: SAE password
945 # This parameter can be used to set a password for SAE. By default, the
946 # passphrase from the psk parameter is used if this separate parameter is not
947 # used, but psk follows the WPA-PSK constraints (8..63 characters) even though
948 # SAE passwords do not have such constraints.
950 # sae_password_id: SAE password identifier
951 # This parameter can be used to set an identifier for the SAE password. By
952 # default, no such identifier is used. If set, the specified identifier value
953 # is used by the other peer to select which password to use for authentication.
955 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
956 # Dynamic WEP key required for non-WPA mode
957 # bit0 (1): require dynamically generated unicast WEP key
958 # bit1 (2): require dynamically generated broadcast WEP key
959 # (3 = require both keys; default)
960 # Note: When using wired authentication (including MACsec drivers),
961 # eapol_flags must be set to 0 for the authentication to be completed
964 # macsec_policy: IEEE 802.1X/MACsec options
965 # This determines how sessions are secured with MACsec (only for MACsec
967 # 0: MACsec not in use (default)
968 # 1: MACsec enabled - Should secure, accept key server's advice to
969 # determine whether to use a secure session or not.
971 # macsec_integ_only: IEEE 802.1X/MACsec transmit mode
972 # This setting applies only when MACsec is in use, i.e.,
973 # - macsec_policy is enabled
974 # - the key server has decided to enable MACsec
975 # 0: Encrypt traffic (default)
978 # macsec_port: IEEE 802.1X/MACsec port
979 # Port component of the SCI
980 # Range: 1-65534 (default: 1)
982 # mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
983 # This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
984 # In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
985 # with lower priority will become the key server and start distributing SAKs.
986 # mka_cak (CAK = Secure Connectivity Association Key) takes a 16-bytes (128 bit)
987 # hex-string (32 hex-digits)
988 # mka_ckn (CKN = CAK Name) takes a 32-bytes (256 bit) hex-string (64 hex-digits)
989 # mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
992 # mixed_cell: This option can be used to configure whether so called mixed
993 # cells, i.e., networks that use both plaintext and encryption in the same
994 # SSID, are allowed when selecting a BSS from scan results.
995 # 0 = disabled (default)
998 # proactive_key_caching:
999 # Enable/disable opportunistic PMKSA caching for WPA2.
1000 # 0 = disabled (default unless changed with the global okc parameter)
1003 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1004 # hex without quotation, e.g., 0102030405)
1005 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
1007 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1008 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1010 # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1011 # as the dot11RSNAConfigGroupRekeyTime parameter when operating in
1012 # Authenticator role in IBSS, or in AP and mesh modes.
1014 # Following fields are only used with internal EAP implementation.
1015 # eap: space-separated list of accepted EAP methods
1016 # MD5 = EAP-MD5 (insecure and does not generate keying material ->
1017 # cannot be used with WPA; to be used as a Phase 2 method
1018 # with EAP-PEAP or EAP-TTLS)
1019 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1020 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1021 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
1022 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1023 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
1024 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1025 # TLS = EAP-TLS (client and server certificate)
1026 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
1027 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1029 # If not set, all compiled in methods are allowed.
1031 # identity: Identity string for EAP
1032 # This field is also used to configure user NAI for
1033 # EAP-PSK/PAX/SAKE/GPSK.
1034 # anonymous_identity: Anonymous identity string for EAP (to be used as the
1035 # unencrypted identity with EAP types that support different tunnelled
1036 # identity, e.g., EAP-TTLS). This field can also be used with
1037 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
1038 # password: Password string for EAP. This field can include either the
1039 # plaintext password (using ASCII or hex string) or a NtPasswordHash
1040 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1041 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
1042 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1043 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1044 # PSK) is also configured using this field. For EAP-GPSK, this is a
1045 # variable length PSK. ext:<name of external password field> format can
1046 # be used to indicate that the password is stored in external storage.
1047 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1048 # or more trusted CA certificates. If ca_cert and ca_path are not
1049 # included, server certificate will not be verified. This is insecure and
1050 # a trusted CA certificate should always be configured when using
1051 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1052 # change when wpa_supplicant is run in the background.
1054 # Alternatively, this can be used to only perform matching of the server
1055 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1056 # this case, the possible CA certificates in the server certificate chain
1057 # are ignored and only the server certificate is verified. This is
1058 # configured with the following format:
1059 # hash:://server/sha256/cert_hash_in_hex
1060 # For example: "hash://server/sha256/
1061 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1063 # On Windows, trusted CA certificates can be loaded from the system
1064 # certificate store by setting this to cert_store://<name>, e.g.,
1065 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1066 # Note that when running wpa_supplicant as an application, the user
1067 # certificate store (My user account) is used, whereas computer store
1068 # (Computer account) is used when running wpasvc as a service.
1069 # ca_path: Directory path for CA certificate files (PEM). This path may
1070 # contain multiple CA certificates in OpenSSL format. Common use for this
1071 # is to point to system trusted CA list which is often installed into
1072 # directory like /etc/ssl/certs. If configured, these certificates are
1073 # added to the list of trusted CAs. ca_cert may also be included in that
1074 # case, but it is not required.
1075 # client_cert: File path to client certificate file (PEM/DER)
1076 # Full path should be used since working directory may change when
1077 # wpa_supplicant is run in the background.
1078 # Alternatively, a named configuration blob can be used by setting this
1079 # to blob://<blob name>.
1080 # private_key: File path to client private key file (PEM/DER/PFX)
1081 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1082 # commented out. Both the private key and certificate will be read from
1083 # the PKCS#12 file in this case. Full path should be used since working
1084 # directory may change when wpa_supplicant is run in the background.
1085 # Windows certificate store can be used by leaving client_cert out and
1086 # configuring private_key in one of the following formats:
1087 # cert://substring_to_match
1088 # hash://certificate_thumbprint_in_hex
1089 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1090 # Note that when running wpa_supplicant as an application, the user
1091 # certificate store (My user account) is used, whereas computer store
1092 # (Computer account) is used when running wpasvc as a service.
1093 # Alternatively, a named configuration blob can be used by setting this
1094 # to blob://<blob name>.
1095 # private_key_passwd: Password for private key file (if left out, this will be
1096 # asked through control interface)
1097 # dh_file: File path to DH/DSA parameters file (in PEM format)
1098 # This is an optional configuration file for setting parameters for an
1099 # ephemeral DH key exchange. In most cases, the default RSA
1100 # authentication does not use this configuration. However, it is possible
1101 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1102 # DSA keys always use ephemeral DH keys. This can be used to achieve
1103 # forward secrecy. If the file is in DSA parameters format, it will be
1104 # automatically converted into DH params.
1105 # subject_match: Substring to be matched against the subject of the
1106 # authentication server certificate. If this string is set, the server
1107 # certificate is only accepted if it contains this string in the subject.
1108 # The subject string is in following format:
1109 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
1110 # Note: Since this is a substring match, this cannot be used securely to
1111 # do a suffix match against a possible domain name in the CN entry. For
1112 # such a use case, domain_suffix_match or domain_match should be used
1114 # altsubject_match: Semicolon separated string of entries to be matched against
1115 # the alternative subject name of the authentication server certificate.
1116 # If this string is set, the server certificate is only accepted if it
1117 # contains one of the entries in an alternative subject name extension.
1118 # altSubjectName string is in following format: TYPE:VALUE
1119 # Example: EMAIL:server@example.com
1120 # Example: DNS:server.example.com;DNS:server2.example.com
1121 # Following types are supported: EMAIL, DNS, URI
1122 # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
1123 # used as a suffix match requirement for the AAA server certificate in
1124 # SubjectAltName dNSName element(s). If a matching dNSName is found, this
1125 # constraint is met. If no dNSName values are present, this constraint is
1126 # matched against SubjectName CN using same suffix match comparison.
1128 # Suffix match here means that the host/domain name is compared one label
1129 # at a time starting from the top-level domain and all the labels in
1130 # domain_suffix_match shall be included in the certificate. The
1131 # certificate may include additional sub-level labels in addition to the
1134 # For example, domain_suffix_match=example.com would match
1135 # test.example.com but would not match test-example.com.
1136 # domain_match: Constraint for server domain name
1137 # If set, this FQDN is used as a full match requirement for the
1138 # server certificate in SubjectAltName dNSName element(s). If a
1139 # matching dNSName is found, this constraint is met. If no dNSName
1140 # values are present, this constraint is matched against SubjectName CN
1141 # using same full match comparison. This behavior is similar to
1142 # domain_suffix_match, but has the requirement of a full match, i.e.,
1143 # no subdomains or wildcard matches are allowed. Case-insensitive
1144 # comparison is used, so "Example.com" matches "example.com", but would
1145 # not match "test.Example.com".
1146 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1147 # (string with field-value pairs, e.g., "peapver=0" or
1148 # "peapver=1 peaplabel=1")
1149 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
1150 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1151 # to be used during key derivation when PEAPv1 or newer. Most existing
1152 # PEAPv1 implementation seem to be using the old label, "client EAP
1153 # encryption", and wpa_supplicant is now using that as the default value.
1154 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1155 # interoperate with PEAPv1; see eap_testing.txt for more details.
1156 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
1157 # tunneled EAP-Success. This is required with some RADIUS servers that
1158 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1159 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1160 # include_tls_length=1 can be used to force wpa_supplicant to include
1161 # TLS Message Length field in all TLS messages even if they are not
1163 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1164 # challenges (by default, it accepts 2 or 3)
1165 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1166 # protected result indication.
1167 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1169 # * 0 = do not use cryptobinding (default)
1170 # * 1 = use cryptobinding if server supports it
1171 # * 2 = require cryptobinding
1172 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
1175 # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1176 # used to configure a mode that allows EAP-Success (and EAP-Failure)
1177 # without going through authentication step. Some switches use such
1178 # sequence when forcing the port to be authorized/unauthorized or as a
1179 # fallback option if the authentication server is unreachable. By default,
1180 # wpa_supplicant discards such frames to protect against potential attacks
1181 # by rogue devices, but this option can be used to disable that protection
1182 # for cases where the server/authenticator does not need to be
1184 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
1185 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
1186 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1187 # used to disable MSCHAPv2 password retry in authentication failure cases.
1189 # TLS-based methods can use the following parameters to control TLS behavior
1190 # (these are normally in the phase1 parameter, but can be used also in the
1191 # phase2 parameter when EAP-TLS is used within the inner tunnel):
1192 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1193 # TLS library, these may be disabled by default to enforce stronger
1195 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
1196 # the TLS library to accept certificates even if they are not currently
1197 # valid, i.e., have expired or have not yet become valid; this should be
1198 # used only for testing purposes)
1199 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1200 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1201 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1202 # as a workaround for broken authentication server implementations unless
1203 # EAP workarounds are disabled with eap_workaround=0.
1204 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
1205 # default value to be used automatically).
1206 # tls_disable_tlsv1_0=1 - disable use of TLSv1.0
1207 # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1208 # that have issues interoperating with updated TLS version)
1209 # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1210 # that have issues interoperating with updated TLS version)
1211 # tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1212 # that have issues interoperating with updated TLS version)
1213 # tls_ext_cert_check=0 - No external server certificate validation (default)
1214 # tls_ext_cert_check=1 - External server certificate validation enabled; this
1215 # requires an external program doing validation of server certificate
1216 # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1217 # interface and report the result of the validation with
1218 # CTRL-RSP_EXT_CERT_CHECK.
1219 # tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1220 # tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1221 # particular when using Suite B with RSA keys of >= 3K (3072) bits
1223 # Following certificate/private key fields are used in inner Phase2
1224 # authentication when using EAP-TTLS or EAP-PEAP.
1225 # ca_cert2: File path to CA certificate file. This file can have one or more
1226 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1227 # server certificate will not be verified. This is insecure and a trusted
1228 # CA certificate should always be configured.
1229 # ca_path2: Directory path for CA certificate files (PEM)
1230 # client_cert2: File path to client certificate file
1231 # private_key2: File path to client private key file
1232 # private_key2_passwd: Password for private key file
1233 # dh_file2: File path to DH/DSA parameters file (in PEM format)
1234 # subject_match2: Substring to be matched against the subject of the
1235 # authentication server certificate. See subject_match for more details.
1236 # altsubject_match2: Semicolon separated string of entries to be matched
1237 # against the alternative subject name of the authentication server
1238 # certificate. See altsubject_match documentation for more details.
1239 # domain_suffix_match2: Constraint for server domain name. See
1240 # domain_suffix_match for more details.
1242 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
1243 # This value limits the fragment size for EAP methods that support
1244 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1245 # small enough to make the EAP messages fit in MTU of the network
1246 # interface used for EAPOL. The default value is suitable for most
1249 # ocsp: Whether to use/require OCSP to check server certificate
1250 # 0 = do not use OCSP stapling (TLS certificate status extension)
1251 # 1 = try to use OCSP stapling, but not require response
1252 # 2 = require valid OCSP stapling response
1253 # 3 = require valid OCSP stapling response for all not-trusted
1254 # certificates in the server certificate chain
1256 # openssl_ciphers: OpenSSL specific cipher configuration
1257 # This can be used to override the global openssl_ciphers configuration
1258 # parameter (see above).
1260 # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1262 # EAP-FAST variables:
1263 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1264 # to create this file and write updates to it when PAC is being
1265 # provisioned or refreshed. Full path to the file should be used since
1266 # working directory may change when wpa_supplicant is run in the
1267 # background. Alternatively, a named configuration blob can be used by
1268 # setting this to blob://<blob name>
1269 # phase1: fast_provisioning option can be used to enable in-line provisioning
1270 # of EAP-FAST credentials (PAC):
1272 # 1 = allow unauthenticated provisioning,
1273 # 2 = allow authenticated provisioning,
1274 # 3 = allow both unauthenticated and authenticated provisioning
1275 # fast_max_pac_list_len=<num> option can be used to set the maximum
1276 # number of PAC entries to store in a PAC list (default: 10)
1277 # fast_pac_format=binary option can be used to select binary format for
1278 # storing PAC entries in order to save some space (the default
1279 # text format uses about 2.5 times the size of minimal binary
1282 # wpa_supplicant supports number of "EAP workarounds" to work around
1283 # interoperability issues with incorrectly behaving authentication servers.
1284 # These are enabled by default because some of the issues are present in large
1285 # number of authentication servers. Strict EAP conformance mode can be
1286 # configured by disabling workarounds with eap_workaround=0.
1288 # update_identifier: PPS MO ID
1289 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1291 # roaming_consortium_selection: Roaming Consortium Selection
1292 # The matching Roaming Consortium OI that was used to generate this
1295 # Station inactivity limit
1297 # If a station does not send anything in ap_max_inactivity seconds, an
1298 # empty data frame is sent to it in order to verify whether it is
1299 # still in range. If this frame is not ACKed, the station will be
1300 # disassociated and then deauthenticated. This feature is used to
1301 # clear station table of old entries when the STAs move out of the
1304 # The station can associate again with the AP if it is still in range;
1305 # this inactivity poll is just used as a nicer way of verifying
1306 # inactivity; i.e., client will not report broken connection because
1307 # disassociation frame is not sent immediately without first polling
1308 # the STA with a data frame.
1309 # default: 300 (i.e., 5 minutes)
1310 #ap_max_inactivity=300
1312 # DTIM period in Beacon intervals for AP mode (default: 2)
1315 # Beacon interval (default: 100 TU)
1319 # 0 = WPS enabled and configured (default)
1324 # 0 = PFS disabled with FILS shared key authentication (default)
1325 # 1-65535 = DH Group to use for FILS PFS
1328 # MAC address policy
1329 # 0 = use permanent MAC address
1330 # 1 = use random MAC address for each ESS connection
1331 # 2 = like 1, but maintain OUI (with local admin bit set)
1334 # disable_ht: Whether HT (802.11n) should be disabled.
1335 # 0 = HT enabled (if AP supports it)
1338 # disable_ht40: Whether HT-40 (802.11n) should be disabled.
1339 # 0 = HT-40 enabled (if AP supports it)
1340 # 1 = HT-40 disabled
1342 # disable_sgi: Whether SGI (short guard interval) should be disabled.
1343 # 0 = SGI enabled (if AP supports it)
1346 # disable_ldpc: Whether LDPC should be disabled.
1347 # 0 = LDPC enabled (if AP supports it)
1350 # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1351 # 0 = 40 MHz tolerant (default)
1352 # 1 = 40 MHz intolerant
1354 # ht_mcs: Configure allowed MCS rates.
1355 # Parsed as an array of bytes, in base-16 (ascii-hex)
1356 # ht_mcs="" // Use all available (default)
1357 # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1358 # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1360 # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1361 # -1 = Do not make any changes.
1362 # 0 = Enable MAX-AMSDU if hardware supports it.
1365 # ampdu_factor: Maximum A-MPDU Length Exponent
1366 # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1368 # ampdu_density: Allow overriding AMPDU density configuration.
1369 # Treated as hint by the kernel.
1370 # -1 = Do not make any changes.
1371 # 0-3 = Set AMPDU density (aka factor) to specified value.
1373 # disable_vht: Whether VHT should be disabled.
1374 # 0 = VHT enabled (if AP supports it)
1377 # vht_capa: VHT capabilities to set in the override
1378 # vht_capa_mask: mask of VHT capabilities
1380 # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1381 # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1387 ##### Fast Session Transfer (FST) support #####################################
1389 # The options in this section are only available when the build configuration
1390 # option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1391 # interface to be a part of FST setup.
1393 # FST is the transfer of a session from a channel to another channel, in the
1394 # same or different frequency bands.
1396 # For details, see IEEE Std 802.11ad-2012.
1398 # Identifier of an FST Group the interface belongs to.
1401 # Interface priority within the FST Group.
1402 # Announcing a higher priority for an interface means declaring it more
1403 # preferable for FST switch.
1404 # fst_priority is in 1..255 range with 1 being the lowest priority.
1407 # Default LLT value for this interface in milliseconds. The value used in case
1408 # no value provided during session setup. Default is 50 msec.
1409 # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1410 # Transitioning between states).
1415 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1418 psk="very secret passphrase"
1422 # Same as previous, but request SSID-specific scanning (for APs that reject
1427 psk="very secret passphrase"
1431 # Only WPA-PSK is used. Any valid cipher combination is accepted.
1437 group=CCMP TKIP WEP104 WEP40
1438 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1442 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1449 psk="not so secure passphrase"
1453 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1454 # or WEP40 as the group cipher will not be accepted.
1462 identity="user@example.com"
1463 ca_cert="/etc/cert/ca.pem"
1464 client_cert="/etc/cert/user.pem"
1465 private_key="/etc/cert/user.prv"
1466 private_key_passwd="password"
1470 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1476 identity="user@example.com"
1478 ca_cert="/etc/cert/ca.pem"
1479 phase1="peaplabel=1"
1480 phase2="auth=MSCHAPV2"
1484 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1485 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1490 identity="user@example.com"
1491 anonymous_identity="anonymous@example.com"
1493 ca_cert="/etc/cert/ca.pem"
1497 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1498 # use. Real identity is sent only within an encrypted TLS tunnel.
1503 identity="user@example.com"
1504 anonymous_identity="anonymous@example.com"
1506 ca_cert="/etc/cert/ca.pem"
1507 phase2="auth=MSCHAPV2"
1510 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1516 # Phase1 / outer authentication
1517 anonymous_identity="anonymous@example.com"
1518 ca_cert="/etc/cert/ca.pem"
1519 # Phase 2 / inner authentication
1520 phase2="autheap=TLS"
1521 ca_cert2="/etc/cert/ca2.pem"
1522 client_cert2="/etc/cer/user.pem"
1523 private_key2="/etc/cer/user.prv"
1524 private_key2_passwd="password"
1528 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1532 bssid=00:11:22:33:44:55
1534 key_mgmt=WPA-PSK WPA-EAP
1537 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1540 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1541 # and all valid ciphers.
1544 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1548 # EAP-SIM with a GSM SIM or USIM
1563 anonymous_identity="eap_psk_user"
1564 password=06b4be19da289f475aa46a33cb793029
1565 identity="eap_psk_user@example.com"
1569 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1570 # EAP-TLS for authentication and key generation; require both unicast and
1571 # broadcast WEP keys.
1576 identity="user@example.com"
1577 ca_cert="/etc/cert/ca.pem"
1578 client_cert="/etc/cert/user.pem"
1579 private_key="/etc/cert/user.prv"
1580 private_key_passwd="password"
1585 # LEAP with dynamic WEP keys
1594 # EAP-IKEv2 using shared secrets for both server and peer authentication
1596 ssid="ikev2-example"
1603 # EAP-FAST with WPA (WPA or WPA2)
1605 ssid="eap-fast-test"
1608 anonymous_identity="FAST-000102030405"
1611 phase1="fast_provisioning=1"
1612 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1616 ssid="eap-fast-test"
1619 anonymous_identity="FAST-000102030405"
1622 phase1="fast_provisioning=1"
1623 pac_file="blob://eap-fast-pac"
1626 # Plaintext connection (no WPA, no IEEE 802.1X)
1628 ssid="plaintext-test"
1633 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1635 ssid="static-wep-test"
1639 wep_key2="1234567890123"
1645 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1646 # IEEE 802.11 authentication
1648 ssid="static-wep-test2"
1652 wep_key2="1234567890123"
1659 # IBSS/ad-hoc network with RSN
1671 # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
1680 psk="secret passphrase"
1691 # secure (SAE + AMPE) network
1697 psk="very secret passphrase"
1701 # Catch all example that allows more or less all configuration modes
1705 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1707 group=CCMP TKIP WEP104 WEP40
1708 psk="very secret passphrase"
1710 identity="user@example.com"
1712 ca_cert="/etc/cert/ca.pem"
1713 client_cert="/etc/cert/user.pem"
1714 private_key="/etc/cert/user.prv"
1715 private_key_passwd="password"
1716 phase1="peaplabel=0"
1719 # Example of EAP-TLS with smartcard (openssl engine)
1727 identity="user@example.com"
1728 ca_cert="/etc/cert/ca.pem"
1730 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1731 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1732 private_key="pkcs11:manufacturer=piv_II;id=%01"
1734 # Optional PIN configuration; this can be left out and PIN will be
1735 # asked through the control interface
1739 # Example configuration showing how to use an inlined blob as a CA certificate
1740 # data instead of using external file
1745 identity="user@example.com"
1746 anonymous_identity="anonymous@example.com"
1748 ca_cert="blob://exampleblob"
1752 blob-base64-exampleblob={
1753 SGVsbG8gV29ybGQhCg==
1757 # Wildcard match for SSID (plaintext APs only). This example select any
1758 # open AP regardless of its SSID.
1763 # Example configuration blacklisting two APs - these will be ignored
1767 psk="very secret passphrase"
1768 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1771 # Example configuration limiting AP selection to a specific set of APs;
1772 # any other AP not matching the masked address will be ignored.
1775 psk="very secret passphrase"
1776 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
1779 # Example config file that will only scan on channel 36.
1786 # Example configuration using EAP-TTLS for authentication and key
1787 # generation for MACsec
1792 anonymous_identity="anonymous@example.com"
1793 identity="user@example.com"
1795 ca_cert="/etc/cert/ca.pem"
1800 # Example configuration for MACsec with preshared key
1805 mka_cak=0123456789ABCDEF0123456789ABCDEF
1806 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435