blob: f6e4f8383e5764811c0ae446df46396f78a1fef4 [file] [log] [blame]
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001##### Example wpa_supplicant configuration file ###############################
2#
3# This file describes configuration file format and lists all available option.
4# Please also take a look at simpler configuration examples in 'examples'
5# subdirectory.
6#
7# Empty lines and lines starting with # are ignored
8
9# NOTE! This file may contain password information and should probably be made
10# readable only by root user on multiuser systems.
11
12# Note: All file paths in this configuration file should use full (absolute,
13# not relative to working directory) path in order to allow working directory
14# to be changed. This can happen if wpa_supplicant is run in the background.
15
16# Whether to allow wpa_supplicant to update (overwrite) configuration
17#
18# This option can be used to allow wpa_supplicant to overwrite configuration
19# file whenever configuration is changed (e.g., new network block is added with
20# wpa_cli or wpa_gui, or a password is changed). This is required for
21# wpa_cli/wpa_gui to be able to store the configuration changes permanently.
22# Please note that overwriting configuration file will remove the comments from
23# it.
24#update_config=1
25
26# global configuration (shared by all network blocks)
27#
28# Parameters for the control interface. If this is specified, wpa_supplicant
29# will open a control interface that is available for external programs to
30# manage wpa_supplicant. The meaning of this string depends on which control
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -080031# interface mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt30f94812012-02-21 17:02:48 -080032# in configuration is used to determine whether the control interface is
33# enabled.
34#
35# For UNIX domain sockets (default on Linux and BSD): This is a directory that
36# will be created for UNIX domain sockets for listening to requests from
37# external programs (CLI/GUI, etc.) for status information and configuration.
38# The socket file will be named based on the interface name, so multiple
39# wpa_supplicant processes can be run at the same time if more than one
40# interface is used.
41# /var/run/wpa_supplicant is the recommended directory for sockets and by
42# default, wpa_cli will use it when trying to connect with wpa_supplicant.
43#
44# Access control for the control interface can be configured by setting the
45# directory to allow only members of a group to use sockets. This way, it is
46# possible to run wpa_supplicant as root (since it needs to change network
47# configuration and open raw sockets) and still allow GUI/CLI components to be
48# run as non-root users. However, since the control interface can be used to
49# change the network configuration, this access needs to be protected in many
50# cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
51# want to allow non-root users to use the control interface, add a new group
52# and change this value to match with that group. Add users that should have
53# control interface access to this group. If this variable is commented out or
54# not included in the configuration file, group will not be changed from the
55# value it got by default when the directory or socket was created.
56#
57# When configuring both the directory and group, use following format:
58# DIR=/var/run/wpa_supplicant GROUP=wheel
59# DIR=/var/run/wpa_supplicant GROUP=0
60# (group can be either group name or gid)
61#
62# For UDP connections (default on Windows): The value will be ignored. This
63# variable is just used to select that the control interface is to be created.
64# The value can be set to, e.g., udp (ctrl_interface=udp)
65#
66# For Windows Named Pipe: This value can be used to set the security descriptor
67# for controlling access to the control interface. Security descriptor can be
68# set using Security Descriptor String Format (see http://msdn.microsoft.com/
69# library/default.asp?url=/library/en-us/secauthz/security/
70# security_descriptor_string_format.asp). The descriptor string needs to be
71# prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
72# DACL (which will reject all connections). See README-Windows.txt for more
73# information about SDDL string format.
74#
75ctrl_interface=/var/run/wpa_supplicant
76
77# IEEE 802.1X/EAPOL version
78# wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
79# EAPOL version 2. However, there are many APs that do not handle the new
80# version number correctly (they seem to drop the frames completely). In order
81# to make wpa_supplicant interoperate with these APs, the version number is set
82# to 1 by default. This configuration value can be used to set it to the new
83# version (2).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -070084# Note: When using MACsec, eapol_version shall be set to 3, which is
85# defined in IEEE Std 802.1X-2010.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070086eapol_version=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -080087
88# AP scanning/selection
89# By default, wpa_supplicant requests driver to perform AP scanning and then
90# uses the scan results to select a suitable AP. Another alternative is to
91# allow the driver to take care of AP scanning and selection and use
92# wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
93# information from the driver.
94# 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
95# the currently enabled networks are found, a new network (IBSS or AP mode
96# operation) may be initialized (if configured) (default)
Hai Shalomfdcde762020-04-02 11:19:20 -070097# 0: This mode must only be used when using wired Ethernet drivers
98# (including MACsec).
Dmitry Shmidt30f94812012-02-21 17:02:48 -080099# 2: like 0, but associate with APs using security policy and SSID (but not
100# BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
101# enable operation with hidden SSIDs and optimized roaming; in this mode,
102# the network blocks in the configuration file are tried one by one until
103# the driver reports successful association; each network block should have
104# explicit security policy (i.e., only one option in the lists) for
105# key_mgmt, pairwise, group, proto variables
Hai Shalomfdcde762020-04-02 11:19:20 -0700106# Note: ap_scan=0/2 should not be used with the nl80211 driver interface (the
107# current Linux interface). ap_scan=1 is the only option working with nl80211.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800108# For finding networks using hidden SSID, scan_ssid=1 in the network block can
109# be used with nl80211.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800110# When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
111# created immediately regardless of scan results. ap_scan=1 mode will first try
112# to scan for existing networks and only if no matches with the enabled
113# networks are found, a new IBSS or AP mode network is created.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700114ap_scan=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800115
Dmitry Shmidtb70d0bb2015-11-16 10:43:06 -0800116# Whether to force passive scan for network connection
117#
118# By default, scans will send out Probe Request frames on channels that allow
119# active scanning. This advertise the local station to the world. Normally this
120# is fine, but users may wish to do passive scanning where the radio should only
121# listen quietly for Beacon frames and not send any Probe Request frames. Actual
122# functionality may be driver dependent.
123#
124# This parameter can be used to force only passive scanning to be used
125# for network connection cases. It should be noted that this will slow
126# down scan operations and reduce likelihood of finding the AP. In
127# addition, some use cases will override this due to functional
128# requirements, e.g., for finding an AP that uses hidden SSID
129# (scan_ssid=1) or P2P device discovery.
130#
131# 0: Do normal scans (allow active scans) (default)
132# 1: Do passive scans.
133#passive_scan=0
134
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800135# MPM residency
136# By default, wpa_supplicant implements the mesh peering manager (MPM) for an
137# open mesh. However, if the driver can implement the MPM, you may set this to
138# 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
139# always used.
140# 0: MPM lives in the driver
141# 1: wpa_supplicant provides an MPM which handles peering (default)
142#user_mpm=1
143
144# Maximum number of peer links (0-255; default: 99)
145# Maximum number of mesh peering currently maintained by the STA.
146#max_peer_links=99
147
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800148# Timeout in seconds to detect STA inactivity (default: 300 seconds)
149#
150# This timeout value is used in mesh STA to clean up inactive stations.
151#mesh_max_inactivity=300
152
Hai Shaloma20dcd72022-02-04 13:43:00 -0800153# Enable 802.11s layer-2 routing and forwarding (dot11MeshForwarding)
154#mesh_fwding=1
155
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800156# cert_in_cb - Whether to include a peer certificate dump in events
157# This controls whether peer certificates for authentication server and
158# its certificate chain are included in EAP peer certificate events. This is
159# enabled by default.
160#cert_in_cb=1
161
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800162# EAP fast re-authentication
163# By default, fast re-authentication is enabled for all EAP methods that
164# support it. This variable can be used to disable fast re-authentication.
165# Normally, there is no need to disable this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700166fast_reauth=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800167
168# OpenSSL Engine support
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700169# These options can be used to load OpenSSL engines in special or legacy
170# modes.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800171# The two engines that are supported currently are shown below:
172# They are both from the opensc project (http://www.opensc.org/)
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700173# By default the PKCS#11 engine is loaded if the client_cert or
174# private_key option appear to be a PKCS#11 URI, and these options
175# should not need to be used explicitly.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800176# make the opensc engine available
177#opensc_engine_path=/usr/lib/opensc/engine_opensc.so
178# make the pkcs11 engine available
179#pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
180# configure the path to the pkcs11 module required by the pkcs11 engine
181#pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
182
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800183# OpenSSL cipher string
184#
185# This is an OpenSSL specific configuration option for configuring the default
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700186# ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
187# by default) is used.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800188# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
189# on cipher suite configuration. This is applicable only if wpa_supplicant is
190# built to use OpenSSL.
191#openssl_ciphers=DEFAULT:!EXP:!LOW
192
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800193# Dynamic EAP methods
194# If EAP methods were built dynamically as shared object files, they need to be
195# loaded here before being used in the network blocks. By default, EAP methods
196# are included statically in the build, so these lines are not needed
197#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
198#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
199
200# Driver interface parameters
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700201# This field can be used to configure arbitrary driver interface parameters. The
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800202# format is specific to the selected driver interface. This field is not used
203# in most cases.
204#driver_param="field=value"
205
206# Country code
207# The ISO/IEC alpha2 country code for the country in which this device is
208# currently operating.
209#country=US
210
211# Maximum lifetime for PMKSA in seconds; default 43200
212#dot11RSNAConfigPMKLifetime=43200
213# Threshold for reauthentication (percentage of PMK lifetime); default 70
214#dot11RSNAConfigPMKReauthThreshold=70
215# Timeout for security association negotiation in seconds; default 60
216#dot11RSNAConfigSATimeout=60
217
218# Wi-Fi Protected Setup (WPS) parameters
219
220# Universally Unique IDentifier (UUID; see RFC 4122) of the device
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700221# If not configured, UUID will be generated based on the mechanism selected with
222# the auto_uuid parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800223#uuid=12345678-9abc-def0-1234-56789abcdef0
224
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700225# Automatic UUID behavior
226# 0 = generate static value based on the local MAC address (default)
227# 1 = generate a random UUID every time wpa_supplicant starts
228#auto_uuid=0
229
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800230# Device Name
231# User-friendly description of device; up to 32 octets encoded in UTF-8
232#device_name=Wireless Client
233
234# Manufacturer
235# The manufacturer of the device (up to 64 ASCII characters)
236#manufacturer=Company
237
238# Model Name
239# Model of the device (up to 32 ASCII characters)
240#model_name=cmodel
241
242# Model Number
243# Additional device description (up to 32 ASCII characters)
244#model_number=123
245
246# Serial Number
247# Serial number of the device (up to 32 characters)
248#serial_number=12345
249
250# Primary Device Type
251# Used format: <categ>-<OUI>-<subcateg>
252# categ = Category as an integer value
253# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
254# default WPS OUI
255# subcateg = OUI-specific Sub Category as an integer value
256# Examples:
257# 1-0050F204-1 (Computer / PC)
258# 1-0050F204-2 (Computer / Server)
259# 5-0050F204-1 (Storage / NAS)
260# 6-0050F204-1 (Network Infrastructure / AP)
261#device_type=1-0050F204-1
262
263# OS Version
264# 4-octet operating system version number (hex string)
265#os_version=01020300
266
267# Config Methods
268# List of the supported configuration methods
269# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
270# nfc_interface push_button keypad virtual_display physical_display
271# virtual_push_button physical_push_button
272# For WSC 1.0:
273#config_methods=label display push_button keypad
274# For WSC 2.0:
275#config_methods=label virtual_display virtual_push_button keypad
276
277# Credential processing
278# 0 = process received credentials internally (default)
279# 1 = do not process received credentials; just pass them over ctrl_iface to
280# external program(s)
281# 2 = process received credentials internally and pass them over ctrl_iface
282# to external program(s)
283#wps_cred_processing=0
284
Hai Shalom021b0b52019-04-10 11:17:58 -0700285# Whether to enable SAE (WPA3-Personal transition mode) automatically for
286# WPA2-PSK credentials received using WPS.
287# 0 = only add the explicitly listed WPA2-PSK configuration (default)
288# 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the
289# station gets configured in WPA3-Personal transition mode (supports both
290# WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
291#wps_cred_add_sae=0
292
Dmitry Shmidt04949592012-07-19 12:16:46 -0700293# Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
294# The vendor attribute contents to be added in M1 (hex string)
295#wps_vendor_ext_m1=000137100100020001
296
297# NFC password token for WPS
298# These parameters can be used to configure a fixed NFC password token for the
299# station. This can be generated, e.g., with nfc_pw_token. When these
300# parameters are used, the station is assumed to be deployed with a NFC tag
301# that includes the matching NFC password token (e.g., written based on the
302# NDEF record from nfc_pw_token).
303#
304#wps_nfc_dev_pw_id: Device Password ID (16..65535)
305#wps_nfc_dh_pubkey: Hexdump of DH Public Key
306#wps_nfc_dh_privkey: Hexdump of DH Private Key
307#wps_nfc_dev_pw: Hexdump of Device Password
308
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700309# Priority for the networks added through WPS
310# This priority value will be set to each network profile that is added
311# by executing the WPS protocol.
312#wps_priority=0
313
Hai Shalomc3565922019-10-28 11:58:20 -0700314# Device Provisioning Protocol (DPP) parameters
315#
316# How to process DPP configuration
317# 0 = report received configuration to an external program for
318# processing; do not generate any network profile internally (default)
319# 1 = report received configuration to an external program and generate
320# a network profile internally, but do not automatically connect
321# to the created (disabled) profile; the network profile id is
322# reported to external programs
323# 2 = report received configuration to an external program, generate
324# a network profile internally, try to connect to the created
325# profile automatically
326#dpp_config_processing=0
327#
328# Name for Enrollee's DPP Configuration Request
329#dpp_name=Test
330#
331# MUD URL for Enrollee's DPP Configuration Request (optional)
332#dpp_mud_url=https://example.com/mud
333
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800334# Maximum number of BSS entries to keep in memory
335# Default: 200
336# This can be used to limit memory use on the BSS entries (cached scan
337# results). A larger value may be needed in environments that have huge number
338# of APs when using ap_scan=1 mode.
339#bss_max_count=200
340
Hai Shalom5f92bc92019-04-18 11:54:11 -0700341# BSS expiration age in seconds. A BSS will be removed from the local cache
342# if it is not in use and has not been seen for this time. Default is 180.
343#bss_expiration_age=180
344
345# BSS expiration after number of scans. A BSS will be removed from the local
346# cache if it is not seen in this number of scans.
347# Default is 2.
348#bss_expiration_scan_count=2
349
Dmitry Shmidt04949592012-07-19 12:16:46 -0700350# Automatic scan
351# This is an optional set of parameters for automatic scanning
352# within an interface in following format:
353#autoscan=<autoscan module name>:<module parameters>
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800354# autoscan is like bgscan but on disconnected or inactive state.
355# For instance, on exponential module parameters would be <base>:<limit>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700356#autoscan=exponential:3:300
357# Which means a delay between scans on a base exponential of 3,
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800358# up to the limit of 300 seconds (3, 9, 27 ... 300)
359# For periodic module, parameters would be <fixed interval>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700360#autoscan=periodic:30
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800361# So a delay of 30 seconds will be applied between each scan.
362# Note: If sched_scan_plans are configured and supported by the driver,
363# autoscan is ignored.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800364
365# filter_ssids - SSID-based scan result filtering
366# 0 = do not filter scan results (default)
367# 1 = only include configured SSIDs in scan results/BSS table
368#filter_ssids=0
369
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700370# Password (and passphrase, etc.) backend for external storage
371# format: <backend name>[:<optional backend parameters>]
Hai Shalom60840252021-02-19 19:02:11 -0800372# Test backend which stores passwords in memory. Should only be used for
373# development purposes.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700374#ext_password_backend=test:pw1=password|pw2=testing
Hai Shalom60840252021-02-19 19:02:11 -0800375# File-based backend which reads passwords from a file. The parameter
376# identifies the file to read passwords from. The password file follows the
377# format of wpa_supplicant.conf and accepts simple `key=passphrase` formatted
378# passwords.
379#ext_password_backend=file:/path/to/passwords.conf
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700380
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700381
382# Disable P2P functionality
383# p2p_disabled=1
384
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700385# Timeout in seconds to detect STA inactivity (default: 300 seconds)
386#
387# This timeout value is used in P2P GO mode to clean up
388# inactive stations.
389#p2p_go_max_inactivity=300
390
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700391# Passphrase length (8..63) for P2P GO
392#
393# This parameter controls the length of the random passphrase that is
394# generated at the GO. Default: 8.
395#p2p_passphrase_len=8
396
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700397# Extra delay between concurrent P2P search iterations
398#
399# This value adds extra delay in milliseconds between concurrent search
400# iterations to make p2p_find friendlier to concurrent operations by avoiding
401# it from taking 100% of radio resources. The default value is 500 ms.
402#p2p_search_delay=500
403
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800404# Opportunistic Key Caching (also known as Proactive Key Caching) default
405# This parameter can be used to set the default behavior for the
406# proactive_key_caching parameter. By default, OKC is disabled unless enabled
407# with the global okc=1 parameter or with the per-network
408# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
409# can be disabled with per-network proactive_key_caching=0 parameter.
410#okc=0
411
412# Protected Management Frames default
413# This parameter can be used to set the default behavior for the ieee80211w
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700414# parameter for RSN networks. By default, PMF is disabled unless enabled with
415# the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
416# With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
417# per-network ieee80211w parameter. This global default value does not apply
418# for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
419# RSN.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800420#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800421
Sunil Ravi77d572f2023-01-17 23:58:31 +0000422# sae_check_mfp: Require PMF support to select SAE key_mgmt
423# 0 = Do not check PMF for SAE (default)
424# 1 = Limit SAE when PMF is not enabled
425#
426# When enabled SAE will not be selected if PMF will not be used
427# for the connection.
428# Scenarios where this check will limit SAE:
429# 1) ieee80211w=0 is set for the network
430# 2) The AP does not have PMF enabled.
431# 3) ieee80211w is unset, pmf=1 is enabled globally, and
432# the device does not support the BIP cipher.
433# Consider the configuration of global parameterss sae_check_mfp=1, pmf=1 and a
434# network configured with ieee80211w unset and key_mgmt=SAE WPA-PSK.
435# In the example WPA-PSK will be used if the device does not support
436# the BIP cipher or the AP has PMF disabled.
437# Limiting SAE with this check can avoid failing to associate to an AP
438# that is configured with sae_requires_mfp=1 if the device does
439# not support PMF due to lack of the BIP cipher.
440#
441# Enabling this check helps with compliance of the WPA3
442# specification for WPA3-Personal transition mode.
443# The WPA3 specification section 2.3 "WPA3-Personal transition mode" item 8
444# states "A STA shall negotiate PMF when associating to an AP using SAE".
445# With this check WPA3 capable devices when connecting
446# to transition mode APs that do not advertise PMF support
447# will not use SAE and instead fallback to PSK.
448#sae_check_mfp=0
449
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800450# Enabled SAE finite cyclic groups in preference order
451# By default (if this parameter is not set), the mandatory group 19 (ECC group
Hai Shalom021b0b52019-04-10 11:17:58 -0700452# defined over a 256-bit prime order field, NIST P-256) is preferred and groups
453# 20 (NIST P-384) and 21 (NIST P-521) are also enabled. If this parameter is
454# set, the groups will be tried in the indicated order.
455# The group values are listed in the IANA registry:
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800456# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
Hai Shalom021b0b52019-04-10 11:17:58 -0700457# Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
458# purposes due limited security (see RFC 8247). Groups that are not as strong as
459# group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
460# since all implementations are required to support group 19.
461#sae_groups=19 20 21
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800462
Hai Shalomc3565922019-10-28 11:58:20 -0700463# SAE mechanism for PWE derivation
Hai Shalomfdcde762020-04-02 11:19:20 -0700464# 0 = hunting-and-pecking loop only (default without password identifier)
465# 1 = hash-to-element only (default with password identifier)
Hai Shalomc3565922019-10-28 11:58:20 -0700466# 2 = both hunting-and-pecking loop and hash-to-element enabled
467# Note: The default value is likely to change from 0 to 2 once the new
468# hash-to-element mechanism has received more interoperability testing.
Hai Shalomfdcde762020-04-02 11:19:20 -0700469# When using SAE password identifier, the hash-to-element mechanism is used
470# regardless of the sae_pwe parameter value.
Hai Shalomc3565922019-10-28 11:58:20 -0700471#sae_pwe=0
472
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800473# Default value for DTIM period (if not overridden in network block)
474#dtim_period=2
475
476# Default value for Beacon interval (if not overridden in network block)
477#beacon_int=100
478
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700479# Additional vendor specific elements for Beacon and Probe Response frames
480# This parameter can be used to add additional vendor specific element(s) into
481# the end of the Beacon and Probe Response frames. The format for these
482# element(s) is a hexdump of the raw information elements (id+len+payload for
483# one or more elements). This is used in AP and P2P GO modes.
484#ap_vendor_elements=dd0411223301
485
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700486# Ignore scan results older than request
487#
488# The driver may have a cache of scan results that makes it return
489# information that is older than our scan trigger. This parameter can
490# be used to configure such old information to be ignored instead of
491# allowing it to update the internal BSS table.
492#ignore_old_scan_res=0
493
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700494# scan_cur_freq: Whether to scan only the current frequency
495# 0: Scan all available frequencies. (Default)
496# 1: Scan current operating frequency if another VIF on the same radio
497# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700498
Hai Shalom60840252021-02-19 19:02:11 -0800499# Seconds to consider old scan results valid for association (default: 5)
500#scan_res_valid_for_connect=5
501
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700502# MAC address policy default
503# 0 = use permanent MAC address
504# 1 = use random MAC address for each ESS connection
505# 2 = like 1, but maintain OUI (with local admin bit set)
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000506# 3 = use dedicated/pregenerated MAC address (see mac_value)
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700507#
508# By default, permanent MAC address is used unless policy is changed by
509# the per-network mac_addr parameter. Global mac_addr=1 can be used to
510# change this default behavior.
511#mac_addr=0
512
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000513# Local MAC address to use whenever connecting with this network profile
514# This is used with mac_addr=3.
515#mac_value=02:12:34:56:78:9a
516
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700517# Lifetime of random MAC address in seconds (default: 60)
518#rand_addr_lifetime=60
519
520# MAC address policy for pre-association operations (scanning, ANQP)
521# 0 = use permanent MAC address
522# 1 = use random MAC address
523# 2 = like 1, but maintain OUI (with local admin bit set)
524#preassoc_mac_addr=0
525
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800526# MAC address policy for GAS operations
527# 0 = use permanent MAC address
528# 1 = use random MAC address
529# 2 = like 1, but maintain OUI (with local admin bit set)
Hai Shalomb755a2a2020-04-23 21:49:02 -0700530# Note that this setting is ignored when a specific MAC address is needed for
531# a full protocol exchange that includes GAS, e.g., when going through a DPP
532# exchange that exposes the configured interface address as part of the DP
533# Public Action frame exchanges before using GAS. That same address is then used
534# during the GAS exchange as well to avoid breaking the protocol expectations.
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800535#gas_rand_mac_addr=0
536
537# Lifetime of GAS random MAC address in seconds (default: 60)
538#gas_rand_addr_lifetime=60
539
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800540# Interworking (IEEE 802.11u)
541
542# Enable Interworking
543# interworking=1
544
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700545# Enable P2P GO advertisement of Interworking
546# go_interworking=1
547
548# P2P GO Interworking: Access Network Type
549# 0 = Private network
550# 1 = Private network with guest access
551# 2 = Chargeable public network
552# 3 = Free public network
553# 4 = Personal device network
554# 5 = Emergency services only network
555# 14 = Test or experimental
556# 15 = Wildcard
557#go_access_network_type=0
558
559# P2P GO Interworking: Whether the network provides connectivity to the Internet
560# 0 = Unspecified
561# 1 = Network provides connectivity to the Internet
562#go_internet=1
563
564# P2P GO Interworking: Group Venue Info (optional)
565# The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
566# Example values (group,type):
567# 0,0 = Unspecified
568# 1,7 = Convention Center
569# 1,13 = Coffee Shop
570# 2,0 = Unspecified Business
571# 7,1 Private Residence
572#go_venue_group=7
573#go_venue_type=1
574
Hai Shalom60840252021-02-19 19:02:11 -0800575# Homogeneous ESS identifier
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800576# If this is set, scans will be used to request response only from BSSes
577# belonging to the specified Homogeneous ESS. This is used only if interworking
578# is enabled.
579# hessid=00:11:22:33:44:55
580
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700581# Automatic network selection behavior
582# 0 = do not automatically go through Interworking network selection
583# (i.e., require explicit interworking_select command for this; default)
584# 1 = perform Interworking network selection if one or more
585# credentials have been configured and scan did not find a
586# matching network block
587#auto_interworking=0
588
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700589# GAS Address3 field behavior
590# 0 = P2P specification (Address3 = AP BSSID); default
591# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
592# sent to not-associated AP; if associated, AP BSSID)
593#gas_address3=0
594
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700595# Publish fine timing measurement (FTM) responder functionality in
596# the Extended Capabilities element bit 70.
597# Controls whether FTM responder functionality will be published by AP/STA.
598# Note that actual FTM responder operation is managed outside wpa_supplicant.
599# 0 = Do not publish; default
600# 1 = Publish
601#ftm_responder=0
602
603# Publish fine timing measurement (FTM) initiator functionality in
604# the Extended Capabilities element bit 71.
605# Controls whether FTM initiator functionality will be published by AP/STA.
606# Note that actual FTM initiator operation is managed outside wpa_supplicant.
607# 0 = Do not publish; default
608# 1 = Publish
609#ftm_initiator=0
610
Dmitry Shmidt04949592012-07-19 12:16:46 -0700611# credential block
612#
613# Each credential used for automatic network selection is configured as a set
614# of parameters that are compared to the information advertised by the APs when
615# interworking_select and interworking_connect commands are used.
616#
617# credential fields:
618#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800619# temporary: Whether this credential is temporary and not to be saved
620#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700621# priority: Priority group
622# By default, all networks and credentials get the same priority group
623# (0). This field can be used to give higher priority for credentials
624# (and similarly in struct wpa_ssid for network blocks) to change the
625# Interworking automatic networking selection behavior. The matching
626# network (based on either an enabled network block or a credential)
627# with the highest priority value will be selected.
628#
629# pcsc: Use PC/SC and SIM/USIM card
630#
631# realm: Home Realm for Interworking
632#
633# username: Username for Interworking network selection
634#
635# password: Password for Interworking network selection
636#
637# ca_cert: CA certificate for Interworking network selection
638#
639# client_cert: File path to client certificate file (PEM/DER)
640# This field is used with Interworking networking selection for a case
641# where client certificate/private key is used for authentication
642# (EAP-TLS). Full path to the file should be used since working
643# directory may change when wpa_supplicant is run in the background.
644#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700645# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
646#
647# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
648#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700649# Alternatively, a named configuration blob can be used by setting
650# this to blob://blob_name.
651#
652# private_key: File path to client private key file (PEM/DER/PFX)
653# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
654# commented out. Both the private key and certificate will be read
655# from the PKCS#12 file in this case. Full path to the file should be
656# used since working directory may change when wpa_supplicant is run
657# in the background.
658#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700659# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
660# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
661#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700662# Windows certificate store can be used by leaving client_cert out and
663# configuring private_key in one of the following formats:
664#
665# cert://substring_to_match
666#
667# hash://certificate_thumbprint_in_hex
668#
669# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
670#
671# Note that when running wpa_supplicant as an application, the user
672# certificate store (My user account) is used, whereas computer store
673# (Computer account) is used when running wpasvc as a service.
674#
675# Alternatively, a named configuration blob can be used by setting
676# this to blob://blob_name.
677#
678# private_key_passwd: Password for private key file
679#
680# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
681#
682# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
683# format
684#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700685# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700686# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700687# whether the AP is operated by the Home SP. Multiple domain entries can
688# be used to configure alternative FQDNs that will be considered home
689# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700690#
Sunil Ravi77d572f2023-01-17 23:58:31 +0000691# home_ois: Home OI(s)
692# This string field contains one or more comma delimited OIs (hexdump)
693# identifying the access the access points that support authentication
694# with this credential. There are an alternative to the use of the realm
695# parameter. When using Home OIs to match the network, the EAP parameters
696# need to be pre-configured with the credentials since the NAI Realm
697# information may not be available or fetched.
698# A successful authentication with the access point is possible as soon
699# as at least one Home OI from the list matches an OI in the Roaming
700# Consortium advertised by the access point.
701# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOI)
702#
703# required_home_ois: Required Home OI(s)
704# This string field contains the set of Home OI(s) (hexdump) that are
705# required to be advertised by the AP for the credential to be considered
706# matching.
707# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOIRequired)
708#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700709# roaming_consortium: Roaming Consortium OI
Sunil Ravi77d572f2023-01-17 23:58:31 +0000710# Deprecated: use home_ois instead.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700711# If roaming_consortium_len is non-zero, this field contains the
712# Roaming Consortium OI that can be used to determine which access
713# points support authentication with this credential. This is an
714# alternative to the use of the realm parameter. When using Roaming
715# Consortium to match the network, the EAP parameters need to be
716# pre-configured with the credential since the NAI Realm information
717# may not be available or fetched.
718#
Roshan Pius3a1667e2018-07-03 15:17:14 -0700719# required_roaming_consortium: Required Roaming Consortium OI
Sunil Ravi77d572f2023-01-17 23:58:31 +0000720# Deprecated: use required_home_ois instead.
Roshan Pius3a1667e2018-07-03 15:17:14 -0700721# If required_roaming_consortium_len is non-zero, this field contains the
722# Roaming Consortium OI that is required to be advertised by the AP for
723# the credential to be considered matching.
724#
725# roaming_consortiums: Roaming Consortium OI(s) memberships
726# This string field contains one or more comma delimited OIs (hexdump)
727# identifying the roaming consortiums of which the provider is a member.
728# The list is sorted from the most preferred one to the least preferred
729# one. A match between the Roaming Consortium OIs advertised by an AP and
730# the OIs in this list indicates that successful authentication is
731# possible.
732# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
733#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700734# eap: Pre-configured EAP method
735# This optional field can be used to specify which EAP method will be
736# used with this credential. If not set, the EAP method is selected
737# automatically based on ANQP information (e.g., NAI Realm).
738#
739# phase1: Pre-configure Phase 1 (outer authentication) parameters
740# This optional field is used with like the 'eap' parameter.
741#
742# phase2: Pre-configure Phase 2 (inner authentication) parameters
743# This optional field is used with like the 'eap' parameter.
744#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800745# excluded_ssid: Excluded SSID
746# This optional field can be used to excluded specific SSID(s) from
747# matching with the network. Multiple entries can be used to specify more
748# than one SSID.
749#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800750# roaming_partner: Roaming partner information
751# This optional field can be used to configure preferences between roaming
752# partners. The field is a string in following format:
753# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
754# (non-exact match means any subdomain matches the entry; priority is in
755# 0..255 range with 0 being the highest priority)
756#
757# update_identifier: PPS MO ID
758# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
759#
760# provisioning_sp: FQDN of the SP that provisioned the credential
761# This optional field can be used to keep track of the SP that provisioned
762# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
763#
764# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
765# These fields can be used to specify minimum download/upload backhaul
766# bandwidth that is preferred for the credential. This constraint is
767# ignored if the AP does not advertise WAN Metrics information or if the
768# limit would prevent any connection. Values are in kilobits per second.
769# min_dl_bandwidth_home
770# min_ul_bandwidth_home
771# min_dl_bandwidth_roaming
772# min_ul_bandwidth_roaming
773#
774# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
775# (PPS/<X+>/Policy/MaximumBSSLoadValue)
776# This value is used as the maximum channel utilization for network
777# selection purposes for home networks. If the AP does not advertise
778# BSS Load or if the limit would prevent any connection, this constraint
779# will be ignored.
780#
781# req_conn_capab: Required connection capability
782# (PPS/<X+>/Policy/RequiredProtoPortTuple)
783# This value is used to configure set of required protocol/port pairs that
784# a roaming network shall support (include explicitly in Connection
785# Capability ANQP element). This constraint is ignored if the AP does not
786# advertise Connection Capability or if this constraint would prevent any
787# network connection. This policy is not used in home networks.
788# Format: <protocol>[:<comma-separated list of ports]
789# Multiple entries can be used to list multiple requirements.
790# For example, number of common TCP protocols:
791# req_conn_capab=6,22,80,443
792# For example, IPSec/IKE:
793# req_conn_capab=17:500
794# req_conn_capab=50
795#
796# ocsp: Whether to use/require OCSP to check server certificate
797# 0 = do not use OCSP stapling (TLS certificate status extension)
798# 1 = try to use OCSP stapling, but not require response
799# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800800# 3 = require valid OCSP stapling response for all not-trusted
801# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800802#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700803# sim_num: Identifier for which SIM to use in multi-SIM devices
804#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700805# for example:
806#
807#cred={
808# realm="example.com"
809# username="user@example.com"
810# password="password"
811# ca_cert="/etc/wpa_supplicant/ca.pem"
812# domain="example.com"
813#}
814#
815#cred={
816# imsi="310026-000000000"
817# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
818#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700819#
820#cred={
821# realm="example.com"
822# username="user"
823# password="password"
824# ca_cert="/etc/wpa_supplicant/ca.pem"
825# domain="example.com"
Sunil Ravi77d572f2023-01-17 23:58:31 +0000826# home_ois="223344"
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700827# eap=TTLS
828# phase2="auth=MSCHAPV2"
829#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800830
Dmitry Shmidt04949592012-07-19 12:16:46 -0700831# Hotspot 2.0
832# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800833
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800834# Scheduled scan plans
835#
836# A space delimited list of scan plans. Each scan plan specifies the scan
837# interval and number of iterations, delimited by a colon. The last scan plan
838# will run infinitely and thus must specify only the interval and not the number
839# of iterations.
840#
841# The driver advertises the maximum number of scan plans supported. If more scan
842# plans than supported are configured, only the first ones are set (up to the
843# maximum supported). The last scan plan that specifies only the interval is
844# always set as the last plan.
845#
846# If the scan interval or the number of iterations for a scan plan exceeds the
847# maximum supported, it will be set to the maximum supported value.
848#
849# Format:
850# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
851#
852# Example:
853# sched_scan_plans=10:100 20:200 30
854
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800855# Multi Band Operation (MBO) non-preferred channels
856# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700857# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800858# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700859# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800860# Example:
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700861# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800862
863# MBO Cellular Data Capabilities
864# 1 = Cellular data connection available
865# 2 = Cellular data connection not available
866# 3 = Not cellular capable (default)
867#mbo_cell_capa=3
868
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700869# Optimized Connectivity Experience (OCE)
870# oce: Enable OCE features (bitmap)
871# Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
872# does not indicate support for OCE in STA mode)
873# Set BIT(1) to Enable OCE in STA-CFON mode
874#oce=1
875
Hai Shalomfdcde762020-04-02 11:19:20 -0700876# Extended Key ID support for Individually Addressed frames
877# 0 = force off: Do not use Extended Key ID (default)
878# 1 = auto: Activate Extended Key ID support if the driver supports it
879#extended_key_id=0
880
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800881# network block
882#
883# Each network (usually AP's sharing the same SSID) is configured as a separate
884# block in this configuration file. The network blocks are in preference order
885# (the first match is used).
886#
887# network block fields:
888#
889# disabled:
890# 0 = this network can be used (default)
891# 1 = this network block is disabled (can be enabled through ctrl_iface,
892# e.g., with wpa_cli or wpa_gui)
893#
894# id_str: Network identifier string for external scripts. This value is passed
895# to external action script through wpa_cli as WPA_ID_STR environment
896# variable to make it easier to do network specific configuration.
897#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700898# ssid: SSID (mandatory); network name in one of the optional formats:
899# - an ASCII string with double quotation
900# - a hex string (two characters per octet of SSID)
901# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800902#
903# scan_ssid:
904# 0 = do not scan this SSID with specific Probe Request frames (default)
905# 1 = scan with SSID-specific Probe Request frames (this can be used to
906# find APs that do not accept broadcast SSID or use multiple SSIDs;
907# this will add latency to scanning, so enable this only when needed)
908#
909# bssid: BSSID (optional); if set, this network block is used only when
910# associating with the AP using the configured BSSID
911#
Hai Shalom899fcc72020-10-19 14:38:18 -0700912# ignore_broadcast_ssid: SSID broadcast behavior
913# Send empty SSID in beacons and ignore probe request frames that do not
914# specify full SSID, i.e., require stations to know SSID.
915# default: disabled (0)
916# 1 = send empty (length=0) SSID in beacon and ignore probe request for
917# broadcast SSID
918# 2 = clear SSID (ASCII 0), but keep the original length (this may be required
919# with some clients that do not support empty SSID) and ignore probe
920# requests for broadcast SSID
921#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800922# priority: priority group (integer)
923# By default, all networks will get same priority group (0). If some of the
924# networks are more desirable, this field can be used to change the order in
925# which wpa_supplicant goes through the networks when selecting a BSS. The
926# priority groups will be iterated in decreasing priority (i.e., the larger the
927# priority value, the sooner the network is matched against the scan results).
928# Within each priority group, networks will be selected based on security
929# policy, signal strength, etc.
930# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
931# using this priority to select the order for scanning. Instead, they try the
932# networks in the order that used in the configuration file.
933#
934# mode: IEEE 802.11 operation mode
935# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
936# 1 = IBSS (ad-hoc, peer-to-peer)
937# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800938# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
939# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
940# TKIP/CCMP) is available for backwards compatibility, but its use is
941# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800942# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
943# both), and psk must also be set.
944#
945# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
946# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
947# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
948# In addition, this value is only used by the station that creates the IBSS. If
949# an IBSS network with the configured SSID is already present, the frequency of
950# the network will be used instead of this configured value.
951#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800952# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700953# 0 = do not use PBSS
954# 1 = use PBSS
955# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800956# Used together with mode configuration. When mode is AP, it means to start a
957# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700958# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
959# which means connect to either PCP or AP.
960# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800961# For more details, see IEEE Std 802.11ad-2012.
962#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800963# scan_freq: List of frequencies to scan
964# Space-separated list of frequencies in MHz to scan when searching for this
965# BSS. If the subset of channels used by the network is known, this option can
966# be used to optimize scanning to not occur on channels that the network does
967# not use. Example: scan_freq=2412 2437 2462
968#
969# freq_list: Array of allowed frequencies
970# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
971# set, scan results that do not match any of the specified frequencies are not
972# considered when selecting a BSS.
973#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700974# This can also be set on the outside of the network block. In this case,
975# it limits the frequencies that will be scanned.
976#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800977# bgscan: Background scanning
978# wpa_supplicant behavior for background scanning can be specified by
979# configuring a bgscan module. These modules are responsible for requesting
980# background scans for the purpose of roaming within an ESS (i.e., within a
981# single network block with all the APs using the same SSID). The bgscan
982# parameter uses following format: "<bgscan module name>:<module parameters>"
983# Following bgscan modules are available:
984# simple - Periodic background scans based on signal strength
985# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
986# <long interval>"
987# bgscan="simple:30:-45:300"
988# learn - Learn channels used by the network and try to avoid bgscans on other
989# channels (experimental)
990# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
991# <long interval>[:<database file name>]"
992# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800993# Explicitly disable bgscan by setting
994# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800995#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800996# This option can also be set outside of all network blocks for the bgscan
997# parameter to apply for all the networks that have no specific bgscan
998# parameter.
999#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001000# proto: list of accepted protocols
1001# WPA = WPA/IEEE 802.11i/D3.0
1002# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
Hai Shalomce48b4a2018-09-05 11:41:35 -07001003# Note that RSN is used also for WPA3.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001004# If not set, this defaults to: WPA RSN
1005#
1006# key_mgmt: list of accepted authenticated key management protocols
1007# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
1008# WPA-EAP = WPA using EAP authentication
1009# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
1010# generated WEP keys
1011# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001012# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
1013# instead)
1014# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
1015# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Roshan Pius3a1667e2018-07-03 15:17:14 -07001016# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
1017# and using SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001018# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
1019# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001020# SAE = Simultaneous authentication of equals; pre-shared key/password -based
1021# authentication with stronger security than WPA-PSK especially when using
Hai Shalomce48b4a2018-09-05 11:41:35 -07001022# not that strong password; a.k.a. WPA3-Personal
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001023# FT-SAE = SAE with FT
1024# WPA-EAP-SUITE-B = Suite B 128-bit level
1025# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001026# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001027# FILS-SHA256 = Fast Initial Link Setup with SHA256
1028# FILS-SHA384 = Fast Initial Link Setup with SHA384
1029# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
1030# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Hai Shalomce48b4a2018-09-05 11:41:35 -07001031# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
1032# DPP = Device Provisioning Protocol
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001033# If not set, this defaults to: WPA-PSK WPA-EAP
1034#
Dmitry Shmidt04949592012-07-19 12:16:46 -07001035# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001036# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001037# 1 = optional
1038# 2 = required
1039# The most common configuration options for this based on the PMF (protected
1040# management frames) certification program are:
1041# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
1042# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001043# (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
1044# WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE
Dmitry Shmidt04949592012-07-19 12:16:46 -07001045#
Hai Shalom74f70d42019-02-11 14:42:39 -08001046# ocv: whether operating channel validation is enabled
Hai Shaloma20dcd72022-02-04 13:43:00 -08001047# This is a countermeasure against multi-channel on-path attacks.
Hai Shalom74f70d42019-02-11 14:42:39 -08001048# Enabling this automatically also enables ieee80211w, if not yet enabled.
1049# 0 = disabled (default)
Hai Shalom60840252021-02-19 19:02:11 -08001050# 1 = enabled if wpa_supplicant's SME in use. Otherwise enabled only when the
1051# driver indicates support for operating channel validation.
Hai Shalom74f70d42019-02-11 14:42:39 -08001052#ocv=1
1053#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001054# auth_alg: list of allowed IEEE 802.11 authentication algorithms
1055# OPEN = Open System authentication (required for WPA/WPA2)
1056# SHARED = Shared Key authentication (requires static WEP keys)
1057# LEAP = LEAP/Network EAP (only used with LEAP)
1058# If not set, automatic selection is used (Open System with LEAP enabled if
1059# LEAP is allowed as one of the EAP methods).
1060#
1061# pairwise: list of accepted pairwise (unicast) ciphers for WPA
1062# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1063# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1064# NONE = Use only Group Keys (deprecated, should not be included if APs support
1065# pairwise keys)
1066# If not set, this defaults to: CCMP TKIP
1067#
1068# group: list of accepted group (broadcast/multicast) ciphers for WPA
1069# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1070# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1071# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
1072# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
1073# If not set, this defaults to: CCMP TKIP WEP104 WEP40
1074#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001075# group_mgmt: list of accepted group management ciphers for RSN (PMF)
1076# AES-128-CMAC = BIP-CMAC-128
1077# BIP-GMAC-128
1078# BIP-GMAC-256
1079# BIP-CMAC-256
1080# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
1081# indicates.
1082#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001083# psk: WPA preshared key; 256-bit pre-shared key
1084# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
1085# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
1086# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001087# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
1088# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001089# This field is not needed, if WPA-EAP is used.
1090# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
1091# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
1092# startup and reconfiguration time can be optimized by generating the PSK only
1093# only when the passphrase or SSID has actually changed.
1094#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -07001095# mem_only_psk: Whether to keep PSK/passphrase only in memory
1096# 0 = allow psk/passphrase to be stored to the configuration file
1097# 1 = do not store psk/passphrase to the configuration file
1098#mem_only_psk=0
1099#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001100# sae_password: SAE password
1101# This parameter can be used to set a password for SAE. By default, the
Roshan Pius3a1667e2018-07-03 15:17:14 -07001102# passphrase from the psk parameter is used if this separate parameter is not
1103# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
1104# SAE passwords do not have such constraints.
1105#
1106# sae_password_id: SAE password identifier
1107# This parameter can be used to set an identifier for the SAE password. By
1108# default, no such identifier is used. If set, the specified identifier value
1109# is used by the other peer to select which password to use for authentication.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001110#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001111# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
1112# Dynamic WEP key required for non-WPA mode
1113# bit0 (1): require dynamically generated unicast WEP key
1114# bit1 (2): require dynamically generated broadcast WEP key
1115# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001116# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001117# eapol_flags must be set to 0 for the authentication to be completed
1118# successfully.
1119#
1120# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001121# This determines how sessions are secured with MACsec (only for MACsec
1122# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001123# 0: MACsec not in use (default)
1124# 1: MACsec enabled - Should secure, accept key server's advice to
1125# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001126#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001127# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1128# This setting applies only when MACsec is in use, i.e.,
1129# - macsec_policy is enabled
1130# - the key server has decided to enable MACsec
1131# 0: Encrypt traffic (default)
1132# 1: Integrity only
1133#
Hai Shalom74f70d42019-02-11 14:42:39 -08001134# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1135# This setting applies only when MACsec is in use, i.e.,
1136# - macsec_policy is enabled
1137# - the key server has decided to enable MACsec
1138# 0: Replay protection disabled (default)
1139# 1: Replay protection enabled
1140#
1141# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1142# This determines a window in which replay is tolerated, to allow receipt
1143# of frames that have been misordered by the network.
1144# This setting applies only when MACsec replay protection active, i.e.,
1145# - macsec_replay_protect is enabled
1146# - the key server has decided to enable MACsec
1147# 0: No replay window, strict check (default)
1148# 1..2^32-1: number of packets that could be misordered
1149#
Sunil Ravi036cec52023-03-29 11:35:17 -07001150# macsec_offload - Enable MACsec hardware offload
1151#
1152# This setting applies only when MACsec is in use, i.e.,
1153# - the key server has decided to enable MACsec
1154#
1155# 0 = MACSEC_OFFLOAD_OFF (default)
1156# 1 = MACSEC_OFFLOAD_PHY
1157# 2 = MACSEC_OFFLOAD_MAC
1158#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001159# macsec_port: IEEE 802.1X/MACsec port
1160# Port component of the SCI
1161# Range: 1-65534 (default: 1)
1162#
Dmitry Shmidt29333592017-01-09 12:27:11 -08001163# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001164# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -08001165# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1166# with lower priority will become the key server and start distributing SAKs.
Hai Shalom74f70d42019-02-11 14:42:39 -08001167# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1168# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1169# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1170# (2..64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -08001171# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1172# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001173#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001174# mixed_cell: This option can be used to configure whether so called mixed
1175# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001176# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001177# 0 = disabled (default)
1178# 1 = enabled
1179#
1180# proactive_key_caching:
1181# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001182# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001183# 1 = enabled
1184#
Hai Shalom81f62d82019-07-22 12:10:00 -07001185# ft_eap_pmksa_caching:
1186# Whether FT-EAP PMKSA caching is allowed
1187# 0 = do not try to use PMKSA caching with FT-EAP (default)
1188# 1 = try to use PMKSA caching with FT-EAP
1189# This controls whether to try to use PMKSA caching with FT-EAP for the
1190# FT initial mobility domain association.
1191#ft_eap_pmksa_caching=0
1192#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001193# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1194# hex without quotation, e.g., 0102030405)
1195# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1196#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001197# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1198# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1199#
Hai Shalomfdcde762020-04-02 11:19:20 -07001200# wpa_deny_ptk0_rekey: Workaround for PTK rekey issues
1201# PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the
1202# security and stability with some cards.
1203# To avoid the issues wpa_supplicant can replace those PTK rekeys (including
1204# EAP reauthentications) with fast reconnects.
1205#
1206# Available options:
1207# 0 = always rekey when configured/instructed (default)
1208# 1 = only rekey when the local driver is explicitly indicating it can perform
1209# this operation without issues
1210# 2 = never allow problematic PTK0 rekeys
1211#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001212# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1213# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -08001214# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001215#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001216# Following fields are only used with internal EAP implementation.
1217# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001218# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001219# cannot be used with WPA; to be used as a Phase 2 method
1220# with EAP-PEAP or EAP-TTLS)
1221# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1222# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1223# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1224# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1225# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1226# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1227# TLS = EAP-TLS (client and server certificate)
1228# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1229# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1230# authentication)
1231# If not set, all compiled in methods are allowed.
1232#
1233# identity: Identity string for EAP
1234# This field is also used to configure user NAI for
1235# EAP-PSK/PAX/SAKE/GPSK.
1236# anonymous_identity: Anonymous identity string for EAP (to be used as the
1237# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07001238# identity, e.g., EAP-TTLS). This field can also be used with
1239# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Steven Liu9138d432022-11-23 22:29:05 +00001240# strict_conservative_peer_mode: Whether the strict conservative peer mode
1241# is enabled. This field is used to handle the reponse of AT_PERMANENT_ID_REQ
1242# for EAP-SIM/AKA/AKA'. In non-strict convervative peer mode, a client
1243# error would be sent to the server, but the mode will send the permanent
1244# identity in some special cases according to 4.6.2 of RFC 4187; With the
1245# strict mode, the permanent identity is never sent to the server.
1246# 0 = disabled (default)
1247# 1 = enabled
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001248# password: Password string for EAP. This field can include either the
1249# plaintext password (using ASCII or hex string) or a NtPasswordHash
1250# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1251# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1252# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1253# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1254# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001255# variable length PSK. ext:<name of external password field> format can
1256# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001257# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1258# or more trusted CA certificates. If ca_cert and ca_path are not
1259# included, server certificate will not be verified. This is insecure and
1260# a trusted CA certificate should always be configured when using
1261# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1262# change when wpa_supplicant is run in the background.
1263#
1264# Alternatively, this can be used to only perform matching of the server
1265# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1266# this case, the possible CA certificates in the server certificate chain
1267# are ignored and only the server certificate is verified. This is
1268# configured with the following format:
1269# hash:://server/sha256/cert_hash_in_hex
1270# For example: "hash://server/sha256/
1271# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1272#
1273# On Windows, trusted CA certificates can be loaded from the system
1274# certificate store by setting this to cert_store://<name>, e.g.,
1275# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1276# Note that when running wpa_supplicant as an application, the user
1277# certificate store (My user account) is used, whereas computer store
1278# (Computer account) is used when running wpasvc as a service.
1279# ca_path: Directory path for CA certificate files (PEM). This path may
1280# contain multiple CA certificates in OpenSSL format. Common use for this
1281# is to point to system trusted CA list which is often installed into
1282# directory like /etc/ssl/certs. If configured, these certificates are
1283# added to the list of trusted CAs. ca_cert may also be included in that
1284# case, but it is not required.
1285# client_cert: File path to client certificate file (PEM/DER)
1286# Full path should be used since working directory may change when
1287# wpa_supplicant is run in the background.
1288# Alternatively, a named configuration blob can be used by setting this
1289# to blob://<blob name>.
1290# private_key: File path to client private key file (PEM/DER/PFX)
1291# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1292# commented out. Both the private key and certificate will be read from
1293# the PKCS#12 file in this case. Full path should be used since working
1294# directory may change when wpa_supplicant is run in the background.
1295# Windows certificate store can be used by leaving client_cert out and
1296# configuring private_key in one of the following formats:
1297# cert://substring_to_match
1298# hash://certificate_thumbprint_in_hex
1299# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1300# Note that when running wpa_supplicant as an application, the user
1301# certificate store (My user account) is used, whereas computer store
1302# (Computer account) is used when running wpasvc as a service.
1303# Alternatively, a named configuration blob can be used by setting this
1304# to blob://<blob name>.
1305# private_key_passwd: Password for private key file (if left out, this will be
1306# asked through control interface)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001307# subject_match: Substring to be matched against the subject of the
1308# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001309# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001310# The subject string is in following format:
1311# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001312# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001313# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001314# such a use case, domain_suffix_match or domain_match should be used
1315# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001316# altsubject_match: Semicolon separated string of entries to be matched against
1317# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001318# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001319# contains one of the entries in an alternative subject name extension.
1320# altSubjectName string is in following format: TYPE:VALUE
1321# Example: EMAIL:server@example.com
1322# Example: DNS:server.example.com;DNS:server2.example.com
1323# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001324# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001325# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001326# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1327# constraint is met. If no dNSName values are present, this constraint is
1328# matched against SubjectName CN using same suffix match comparison.
1329#
1330# Suffix match here means that the host/domain name is compared one label
1331# at a time starting from the top-level domain and all the labels in
1332# domain_suffix_match shall be included in the certificate. The
1333# certificate may include additional sub-level labels in addition to the
1334# required labels.
1335#
Hai Shalom021b0b52019-04-10 11:17:58 -07001336# More than one match string can be provided by using semicolons to
1337# separate the strings (e.g., example.org;example.com). When multiple
1338# strings are specified, a match with any one of the values is considered
1339# a sufficient match for the certificate, i.e., the conditions are ORed
1340# together.
1341#
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001342# For example, domain_suffix_match=example.com would match
1343# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001344# domain_match: Constraint for server domain name
1345# If set, this FQDN is used as a full match requirement for the
1346# server certificate in SubjectAltName dNSName element(s). If a
1347# matching dNSName is found, this constraint is met. If no dNSName
1348# values are present, this constraint is matched against SubjectName CN
1349# using same full match comparison. This behavior is similar to
1350# domain_suffix_match, but has the requirement of a full match, i.e.,
1351# no subdomains or wildcard matches are allowed. Case-insensitive
1352# comparison is used, so "Example.com" matches "example.com", but would
1353# not match "test.Example.com".
Hai Shalom021b0b52019-04-10 11:17:58 -07001354#
1355# More than one match string can be provided by using semicolons to
1356# separate the strings (e.g., example.org;example.com). When multiple
1357# strings are specified, a match with any one of the values is considered
1358# a sufficient match for the certificate, i.e., the conditions are ORed
1359# together.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001360# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1361# (string with field-value pairs, e.g., "peapver=0" or
1362# "peapver=1 peaplabel=1")
1363# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1364# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1365# to be used during key derivation when PEAPv1 or newer. Most existing
1366# PEAPv1 implementation seem to be using the old label, "client EAP
1367# encryption", and wpa_supplicant is now using that as the default value.
1368# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1369# interoperate with PEAPv1; see eap_testing.txt for more details.
1370# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1371# tunneled EAP-Success. This is required with some RADIUS servers that
1372# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1373# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1374# include_tls_length=1 can be used to force wpa_supplicant to include
1375# TLS Message Length field in all TLS messages even if they are not
1376# fragmented.
1377# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1378# challenges (by default, it accepts 2 or 3)
1379# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1380# protected result indication.
1381# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1382# behavior:
1383# * 0 = do not use cryptobinding (default)
1384# * 1 = use cryptobinding if server supports it
1385# * 2 = require cryptobinding
Jouni Malinenab31d322023-07-08 19:55:32 +03001386# 'phase2_auth' option can be used to control Phase 2 (i.e., within TLS
1387# tunnel) behavior for PEAP:
1388# * 0 = do not require Phase 2 authentication
1389# * 1 = require Phase 2 authentication when client certificate
1390# (private_key/client_cert) is not used and TLS session resumption was
1391# not used (default)
1392# * 2 = require Phase 2 authentication in all cases
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001393# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1394# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001395#
1396# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1397# used to configure a mode that allows EAP-Success (and EAP-Failure)
1398# without going through authentication step. Some switches use such
1399# sequence when forcing the port to be authorized/unauthorized or as a
1400# fallback option if the authentication server is unreachable. By default,
1401# wpa_supplicant discards such frames to protect against potential attacks
1402# by rogue devices, but this option can be used to disable that protection
1403# for cases where the server/authenticator does not need to be
1404# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001405# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1406# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001407# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1408# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001409#
1410# TLS-based methods can use the following parameters to control TLS behavior
1411# (these are normally in the phase1 parameter, but can be used also in the
1412# phase2 parameter when EAP-TLS is used within the inner tunnel):
1413# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1414# TLS library, these may be disabled by default to enforce stronger
1415# security)
1416# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1417# the TLS library to accept certificates even if they are not currently
1418# valid, i.e., have expired or have not yet become valid; this should be
1419# used only for testing purposes)
1420# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1421# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1422# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1423# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001424# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001425# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1426# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001427# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Hai Shalom74f70d42019-02-11 14:42:39 -08001428# tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1429# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001430# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1431# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001432# tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1433# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001434# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1435# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001436# tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1437# systemwide TLS policies to be overridden)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001438# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1439# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001440# tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001441# tls_ext_cert_check=0 - No external server certificate validation (default)
1442# tls_ext_cert_check=1 - External server certificate validation enabled; this
1443# requires an external program doing validation of server certificate
1444# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1445# interface and report the result of the validation with
1446# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001447# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1448# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1449# particular when using Suite B with RSA keys of >= 3K (3072) bits
Sunil Ravia04bd252022-05-02 22:54:18 -07001450# allow_unsafe_renegotiation=1 - allow connection with a TLS server that does
1451# not support safe renegotiation (RFC 5746); please note that this
1452# workaround should be only when having to authenticate with an old
1453# authentication server that cannot be updated to use secure TLS
1454# implementation.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001455#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001456# Following certificate/private key fields are used in inner Phase2
1457# authentication when using EAP-TTLS or EAP-PEAP.
1458# ca_cert2: File path to CA certificate file. This file can have one or more
1459# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1460# server certificate will not be verified. This is insecure and a trusted
1461# CA certificate should always be configured.
1462# ca_path2: Directory path for CA certificate files (PEM)
1463# client_cert2: File path to client certificate file
1464# private_key2: File path to client private key file
1465# private_key2_passwd: Password for private key file
1466# dh_file2: File path to DH/DSA parameters file (in PEM format)
1467# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001468# authentication server certificate. See subject_match for more details.
1469# altsubject_match2: Semicolon separated string of entries to be matched
1470# against the alternative subject name of the authentication server
1471# certificate. See altsubject_match documentation for more details.
1472# domain_suffix_match2: Constraint for server domain name. See
1473# domain_suffix_match for more details.
Hai Shalomc3565922019-10-28 11:58:20 -07001474# ocsp2: See ocsp for more details.
1475#
1476# Separate machine credentials can be configured for EAP-TEAP Phase 2 with
1477# "machine_" prefix (e.g., "machine_identity") in the configuration parameters.
1478# See the parameters without that prefix for more details on the meaning and
1479# format of each such parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001480#
1481# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1482# This value limits the fragment size for EAP methods that support
1483# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1484# small enough to make the EAP messages fit in MTU of the network
1485# interface used for EAPOL. The default value is suitable for most
1486# cases.
1487#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001488# ocsp: Whether to use/require OCSP to check server certificate
1489# 0 = do not use OCSP stapling (TLS certificate status extension)
1490# 1 = try to use OCSP stapling, but not require response
1491# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001492# 3 = require valid OCSP stapling response for all not-trusted
1493# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001494#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001495# openssl_ciphers: OpenSSL specific cipher configuration
1496# This can be used to override the global openssl_ciphers configuration
1497# parameter (see above).
1498#
1499# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1500#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001501# EAP-FAST variables:
1502# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1503# to create this file and write updates to it when PAC is being
1504# provisioned or refreshed. Full path to the file should be used since
1505# working directory may change when wpa_supplicant is run in the
1506# background. Alternatively, a named configuration blob can be used by
1507# setting this to blob://<blob name>
1508# phase1: fast_provisioning option can be used to enable in-line provisioning
1509# of EAP-FAST credentials (PAC):
1510# 0 = disabled,
1511# 1 = allow unauthenticated provisioning,
1512# 2 = allow authenticated provisioning,
1513# 3 = allow both unauthenticated and authenticated provisioning
1514# fast_max_pac_list_len=<num> option can be used to set the maximum
1515# number of PAC entries to store in a PAC list (default: 10)
1516# fast_pac_format=binary option can be used to select binary format for
1517# storing PAC entries in order to save some space (the default
1518# text format uses about 2.5 times the size of minimal binary
1519# format)
1520#
1521# wpa_supplicant supports number of "EAP workarounds" to work around
1522# interoperability issues with incorrectly behaving authentication servers.
1523# These are enabled by default because some of the issues are present in large
1524# number of authentication servers. Strict EAP conformance mode can be
1525# configured by disabling workarounds with eap_workaround=0.
1526
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001527# update_identifier: PPS MO ID
1528# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001529#
1530# roaming_consortium_selection: Roaming Consortium Selection
1531# The matching Roaming Consortium OI that was used to generate this
1532# network profile.
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001533
Dmitry Shmidt04949592012-07-19 12:16:46 -07001534# Station inactivity limit
1535#
1536# If a station does not send anything in ap_max_inactivity seconds, an
1537# empty data frame is sent to it in order to verify whether it is
1538# still in range. If this frame is not ACKed, the station will be
1539# disassociated and then deauthenticated. This feature is used to
1540# clear station table of old entries when the STAs move out of the
1541# range.
1542#
1543# The station can associate again with the AP if it is still in range;
1544# this inactivity poll is just used as a nicer way of verifying
1545# inactivity; i.e., client will not report broken connection because
1546# disassociation frame is not sent immediately without first polling
1547# the STA with a data frame.
1548# default: 300 (i.e., 5 minutes)
1549#ap_max_inactivity=300
1550
1551# DTIM period in Beacon intervals for AP mode (default: 2)
1552#dtim_period=2
1553
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001554# Beacon interval (default: 100 TU)
1555#beacon_int=100
1556
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001557# WPS in AP mode
1558# 0 = WPS enabled and configured (default)
1559# 1 = WPS disabled
1560#wps_disabled=0
1561
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001562# FILS DH Group
1563# 0 = PFS disabled with FILS shared key authentication (default)
1564# 1-65535 = DH Group to use for FILS PFS
1565#fils_dh_group=0
1566
Hai Shalomfdcde762020-04-02 11:19:20 -07001567# DPP PFS
1568# 0: allow PFS to be used or not used (default)
1569# 1: require PFS to be used (note: not compatible with DPP R1)
1570# 2: do not allow PFS to be used
1571#dpp_pfs=0
1572
Sunil Ravi89eba102022-09-13 21:04:37 -07001573# DPP Network introduction type
1574# 0: unprotected variant from DPP R1 (default)
1575# 1: privacy protecting (station Connector encrypted) variant from
1576# DPP R3
1577#dpp_connector_privacy=0
1578
Hai Shalom60840252021-02-19 19:02:11 -08001579# Whether beacon protection is enabled
1580# This depends on management frame protection (ieee80211w) being enabled and
1581# beacon protection support indication from the driver.
1582# 0 = disabled (default)
1583# 1 = enabled
Hai Shalom899fcc72020-10-19 14:38:18 -07001584#beacon_prot=0
1585
1586# OWE DH Group
1587# 0: use default (19) first and then try all supported groups one by one if AP
1588# rejects the selected group
1589# 1-65535: DH Group to use for OWE
1590# Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
1591# currently supported.
1592#owe_group=0
1593
1594# OWE-only mode (disable transition mode)
1595# 0: enable transition mode (allow connection to either OWE or open BSS)
1596# 1 = disable transition mode (allow connection only with OWE)
1597#owe_only=0
1598
1599# OWE PTK derivation workaround
1600# Initial OWE implementation used SHA256 when deriving the PTK for all
1601# OWE groups. This was supposed to change to SHA384 for group 20 and
1602# SHA512 for group 21. This parameter can be used to enable older
1603# behavior mainly for testing purposes. There is no impact to group 19
1604# behavior, but if enabled, this will make group 20 and 21 cases use
1605# SHA256-based PTK derivation which will not work with the updated
1606# OWE implementation on the AP side.
1607#owe_ptk_workaround=0
1608
1609# Transition Disable indication
1610# The AP can notify authenticated stations to disable transition mode
1611# in their network profiles when the network has completed transition
1612# steps, i.e., once sufficiently large number of APs in the ESS have
1613# been updated to support the more secure alternative. When this
1614# indication is used, the stations are expected to automatically
1615# disable transition mode and less secure security options. This
1616# includes use of WEP, TKIP (including use of TKIP as the group
1617# cipher), and connections without PMF.
1618# Bitmap bits:
1619# bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK
1620# and only allow SAE to be used)
1621# bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
1622# bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
1623# bit 3 (0x08): Enhanced Open (disable use of open network; require
1624# OWE)
1625
1626# SAE-PK mode
1627# 0: automatic SAE/SAE-PK selection based on password; enable
1628# transition mode (allow SAE authentication without SAE-PK)
1629# 1: SAE-PK only (disable transition mode; allow SAE authentication
1630# only with SAE-PK)
1631# 2: disable SAE-PK (allow SAE authentication only without SAE-PK)
1632#sae_pk=0
1633
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001634# MAC address policy
1635# 0 = use permanent MAC address
1636# 1 = use random MAC address for each ESS connection
1637# 2 = like 1, but maintain OUI (with local admin bit set)
1638#mac_addr=0
1639
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001640# disable_ht: Whether HT (802.11n) should be disabled.
1641# 0 = HT enabled (if AP supports it)
1642# 1 = HT disabled
1643#
1644# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1645# 0 = HT-40 enabled (if AP supports it)
1646# 1 = HT-40 disabled
1647#
1648# disable_sgi: Whether SGI (short guard interval) should be disabled.
1649# 0 = SGI enabled (if AP supports it)
1650# 1 = SGI disabled
1651#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001652# disable_ldpc: Whether LDPC should be disabled.
1653# 0 = LDPC enabled (if AP supports it)
1654# 1 = LDPC disabled
1655#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001656# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1657# 0 = 40 MHz tolerant (default)
1658# 1 = 40 MHz intolerant
1659#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001660# ht_mcs: Configure allowed MCS rates.
1661# Parsed as an array of bytes, in base-16 (ascii-hex)
1662# ht_mcs="" // Use all available (default)
1663# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1664# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1665#
1666# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1667# -1 = Do not make any changes.
1668# 0 = Enable MAX-AMSDU if hardware supports it.
1669# 1 = Disable AMSDU
1670#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001671# ampdu_factor: Maximum A-MPDU Length Exponent
1672# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1673#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001674# ampdu_density: Allow overriding AMPDU density configuration.
1675# Treated as hint by the kernel.
1676# -1 = Do not make any changes.
1677# 0-3 = Set AMPDU density (aka factor) to specified value.
Hai Shalom74f70d42019-02-11 14:42:39 -08001678#
1679# tx_stbc: Allow overriding STBC support for TX streams
1680# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1681# -1 = Do not make any changes (default)
1682# 0 = Set if not supported
1683# 1 = Set if supported
1684#
1685# rx_stbc: Allow overriding STBC support for RX streams
1686# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1687# -1 = Do not make any changes (default)
1688# 0 = Set if not supported
1689# 1 = Set for support of one spatial stream
1690# 2 = Set for support of one and two spatial streams
1691# 3 = Set for support of one, two and three spatial streams
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001692
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001693# disable_vht: Whether VHT should be disabled.
1694# 0 = VHT enabled (if AP supports it)
1695# 1 = VHT disabled
1696#
1697# vht_capa: VHT capabilities to set in the override
1698# vht_capa_mask: mask of VHT capabilities
1699#
1700# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1701# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1702# 0: MCS 0-7
1703# 1: MCS 0-8
1704# 2: MCS 0-9
1705# 3: not supported
1706
Sunil Ravi77d572f2023-01-17 23:58:31 +00001707# disable_eht: Whether EHT should be disabled.
1708# 0 = EHT enabled (if supported) (default)
1709# 1 = EHT disabled
1710
Hai Shalom74f70d42019-02-11 14:42:39 -08001711# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1712# 0 = normal STA (default)
1713# 1 = backhaul STA
1714# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1715# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1716# added to a bridge to allow forwarding frames over this backhaul link.
1717
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001718##### Fast Session Transfer (FST) support #####################################
1719#
1720# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001721# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1722# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001723#
1724# FST is the transfer of a session from a channel to another channel, in the
1725# same or different frequency bands.
1726#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001727# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001728
1729# Identifier of an FST Group the interface belongs to.
1730#fst_group_id=bond0
1731
1732# Interface priority within the FST Group.
1733# Announcing a higher priority for an interface means declaring it more
1734# preferable for FST switch.
1735# fst_priority is in 1..255 range with 1 being the lowest priority.
1736#fst_priority=100
1737
1738# Default LLT value for this interface in milliseconds. The value used in case
1739# no value provided during session setup. Default is 50 msec.
1740# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1741# Transitioning between states).
1742#fst_llt=100
1743
Hai Shalom81f62d82019-07-22 12:10:00 -07001744# BSS Transition Management
1745# disable_btm - Disable BSS transition management in STA
1746# Set to 0 to enable BSS transition management (default behavior)
1747# Set to 1 to disable BSS transition management
1748#disable_btm=0
1749
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001750# This value is used to set where to perform roaming logic
1751# Set to 0 to handle roaming logic fully in supplicant
1752# Set to 1 to skip roaming logic in supplicant and handle it in firmware
1753# In supplicant, just parse BTM frame and notify framework
1754#btm_offload=0
1755
Hai Shalomc3565922019-10-28 11:58:20 -07001756# Enable EDMG capability in STA/AP mode, default value is false
1757#enable_edmg=1
1758
1759# This value is used to configure the channel bonding feature.
1760# Default value is 0.
1761# Relevant only if enable_edmg is true
1762# In AP mode it defines the EDMG channel to use for AP operation.
1763# In STA mode it defines the EDMG channel for connection (if supported by AP).
1764#edmg_channel=9
1765
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001766# Example blocks:
1767
1768# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1769network={
1770 ssid="simple"
1771 psk="very secret passphrase"
1772 priority=5
1773}
1774
1775# Same as previous, but request SSID-specific scanning (for APs that reject
1776# broadcast SSID)
1777network={
1778 ssid="second ssid"
1779 scan_ssid=1
1780 psk="very secret passphrase"
1781 priority=2
1782}
1783
1784# Only WPA-PSK is used. Any valid cipher combination is accepted.
1785network={
1786 ssid="example"
1787 proto=WPA
1788 key_mgmt=WPA-PSK
1789 pairwise=CCMP TKIP
1790 group=CCMP TKIP WEP104 WEP40
1791 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1792 priority=2
1793}
1794
1795# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1796network={
1797 ssid="example"
1798 proto=WPA
1799 key_mgmt=WPA-PSK
1800 pairwise=TKIP
1801 group=TKIP
1802 psk="not so secure passphrase"
1803 wpa_ptk_rekey=600
1804}
1805
1806# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1807# or WEP40 as the group cipher will not be accepted.
1808network={
1809 ssid="example"
1810 proto=RSN
1811 key_mgmt=WPA-EAP
1812 pairwise=CCMP TKIP
1813 group=CCMP TKIP
1814 eap=TLS
1815 identity="user@example.com"
1816 ca_cert="/etc/cert/ca.pem"
1817 client_cert="/etc/cert/user.pem"
1818 private_key="/etc/cert/user.prv"
1819 private_key_passwd="password"
1820 priority=1
1821}
1822
1823# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1824# (e.g., Radiator)
1825network={
1826 ssid="example"
1827 key_mgmt=WPA-EAP
1828 eap=PEAP
1829 identity="user@example.com"
1830 password="foobar"
1831 ca_cert="/etc/cert/ca.pem"
1832 phase1="peaplabel=1"
1833 phase2="auth=MSCHAPV2"
1834 priority=10
1835}
1836
1837# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1838# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1839network={
1840 ssid="example"
1841 key_mgmt=WPA-EAP
1842 eap=TTLS
1843 identity="user@example.com"
1844 anonymous_identity="anonymous@example.com"
1845 password="foobar"
1846 ca_cert="/etc/cert/ca.pem"
1847 priority=2
1848}
1849
1850# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1851# use. Real identity is sent only within an encrypted TLS tunnel.
1852network={
1853 ssid="example"
1854 key_mgmt=WPA-EAP
1855 eap=TTLS
1856 identity="user@example.com"
1857 anonymous_identity="anonymous@example.com"
1858 password="foobar"
1859 ca_cert="/etc/cert/ca.pem"
1860 phase2="auth=MSCHAPV2"
1861}
1862
1863# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1864# authentication.
1865network={
1866 ssid="example"
1867 key_mgmt=WPA-EAP
1868 eap=TTLS
1869 # Phase1 / outer authentication
1870 anonymous_identity="anonymous@example.com"
1871 ca_cert="/etc/cert/ca.pem"
1872 # Phase 2 / inner authentication
1873 phase2="autheap=TLS"
1874 ca_cert2="/etc/cert/ca2.pem"
1875 client_cert2="/etc/cer/user.pem"
1876 private_key2="/etc/cer/user.prv"
1877 private_key2_passwd="password"
1878 priority=2
1879}
1880
1881# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1882# group cipher.
1883network={
1884 ssid="example"
1885 bssid=00:11:22:33:44:55
1886 proto=WPA RSN
1887 key_mgmt=WPA-PSK WPA-EAP
1888 pairwise=CCMP
1889 group=CCMP
1890 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1891}
1892
1893# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1894# and all valid ciphers.
1895network={
1896 ssid=00010203
1897 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1898}
1899
1900
1901# EAP-SIM with a GSM SIM or USIM
1902network={
1903 ssid="eap-sim-test"
1904 key_mgmt=WPA-EAP
1905 eap=SIM
1906 pin="1234"
1907 pcsc=""
1908}
1909
1910
1911# EAP-PSK
1912network={
1913 ssid="eap-psk-test"
1914 key_mgmt=WPA-EAP
1915 eap=PSK
1916 anonymous_identity="eap_psk_user"
1917 password=06b4be19da289f475aa46a33cb793029
1918 identity="eap_psk_user@example.com"
1919}
1920
1921
1922# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1923# EAP-TLS for authentication and key generation; require both unicast and
1924# broadcast WEP keys.
1925network={
1926 ssid="1x-test"
1927 key_mgmt=IEEE8021X
1928 eap=TLS
1929 identity="user@example.com"
1930 ca_cert="/etc/cert/ca.pem"
1931 client_cert="/etc/cert/user.pem"
1932 private_key="/etc/cert/user.prv"
1933 private_key_passwd="password"
1934 eapol_flags=3
1935}
1936
1937
1938# LEAP with dynamic WEP keys
1939network={
1940 ssid="leap-example"
1941 key_mgmt=IEEE8021X
1942 eap=LEAP
1943 identity="user"
1944 password="foobar"
1945}
1946
1947# EAP-IKEv2 using shared secrets for both server and peer authentication
1948network={
1949 ssid="ikev2-example"
1950 key_mgmt=WPA-EAP
1951 eap=IKEV2
1952 identity="user"
1953 password="foobar"
1954}
1955
1956# EAP-FAST with WPA (WPA or WPA2)
1957network={
1958 ssid="eap-fast-test"
1959 key_mgmt=WPA-EAP
1960 eap=FAST
1961 anonymous_identity="FAST-000102030405"
1962 identity="username"
1963 password="password"
1964 phase1="fast_provisioning=1"
1965 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1966}
1967
1968network={
1969 ssid="eap-fast-test"
1970 key_mgmt=WPA-EAP
1971 eap=FAST
1972 anonymous_identity="FAST-000102030405"
1973 identity="username"
1974 password="password"
1975 phase1="fast_provisioning=1"
1976 pac_file="blob://eap-fast-pac"
1977}
1978
1979# Plaintext connection (no WPA, no IEEE 802.1X)
1980network={
1981 ssid="plaintext-test"
1982 key_mgmt=NONE
1983}
1984
1985
1986# Shared WEP key connection (no WPA, no IEEE 802.1X)
1987network={
1988 ssid="static-wep-test"
1989 key_mgmt=NONE
1990 wep_key0="abcde"
1991 wep_key1=0102030405
1992 wep_key2="1234567890123"
1993 wep_tx_keyidx=0
1994 priority=5
1995}
1996
1997
1998# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1999# IEEE 802.11 authentication
2000network={
2001 ssid="static-wep-test2"
2002 key_mgmt=NONE
2003 wep_key0="abcde"
2004 wep_key1=0102030405
2005 wep_key2="1234567890123"
2006 wep_tx_keyidx=0
2007 priority=5
2008 auth_alg=SHARED
2009}
2010
2011
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002012# IBSS/ad-hoc network with RSN
2013network={
2014 ssid="ibss-rsn"
2015 key_mgmt=WPA-PSK
2016 proto=RSN
2017 psk="12345678"
2018 mode=1
2019 frequency=2412
2020 pairwise=CCMP
2021 group=CCMP
2022}
2023
2024# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002025network={
2026 ssid="test adhoc"
2027 mode=1
2028 frequency=2412
2029 proto=WPA
2030 key_mgmt=WPA-NONE
2031 pairwise=NONE
2032 group=TKIP
2033 psk="secret passphrase"
2034}
2035
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002036# open mesh network
2037network={
2038 ssid="test mesh"
2039 mode=5
2040 frequency=2437
2041 key_mgmt=NONE
2042}
2043
2044# secure (SAE + AMPE) network
2045network={
2046 ssid="secure mesh"
2047 mode=5
2048 frequency=2437
2049 key_mgmt=SAE
2050 psk="very secret passphrase"
2051}
2052
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002053
2054# Catch all example that allows more or less all configuration modes
2055network={
2056 ssid="example"
2057 scan_ssid=1
2058 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
2059 pairwise=CCMP TKIP
2060 group=CCMP TKIP WEP104 WEP40
2061 psk="very secret passphrase"
2062 eap=TTLS PEAP TLS
2063 identity="user@example.com"
2064 password="foobar"
2065 ca_cert="/etc/cert/ca.pem"
2066 client_cert="/etc/cert/user.pem"
2067 private_key="/etc/cert/user.prv"
2068 private_key_passwd="password"
2069 phase1="peaplabel=0"
2070}
2071
2072# Example of EAP-TLS with smartcard (openssl engine)
2073network={
2074 ssid="example"
2075 key_mgmt=WPA-EAP
2076 eap=TLS
2077 proto=RSN
2078 pairwise=CCMP TKIP
2079 group=CCMP TKIP
2080 identity="user@example.com"
2081 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002082
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07002083 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
2084 client_cert="pkcs11:manufacturer=piv_II;id=%01"
2085 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002086
2087 # Optional PIN configuration; this can be left out and PIN will be
2088 # asked through the control interface
2089 pin="1234"
2090}
2091
2092# Example configuration showing how to use an inlined blob as a CA certificate
2093# data instead of using external file
2094network={
2095 ssid="example"
2096 key_mgmt=WPA-EAP
2097 eap=TTLS
2098 identity="user@example.com"
2099 anonymous_identity="anonymous@example.com"
2100 password="foobar"
2101 ca_cert="blob://exampleblob"
2102 priority=20
2103}
2104
2105blob-base64-exampleblob={
2106SGVsbG8gV29ybGQhCg==
2107}
2108
2109
2110# Wildcard match for SSID (plaintext APs only). This example select any
2111# open AP regardless of its SSID.
2112network={
2113 key_mgmt=NONE
2114}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002115
Hai Shalom60840252021-02-19 19:02:11 -08002116# Example configuration ignoring two APs - these will be ignored
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002117# for this network.
2118network={
2119 ssid="example"
2120 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002121 bssid_ignore=02:11:22:33:44:55 02:22:aa:44:55:66
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002122}
2123
2124# Example configuration limiting AP selection to a specific set of APs;
2125# any other AP not matching the masked address will be ignored.
2126network={
2127 ssid="example"
2128 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002129 bssid_accept=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002130}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002131
2132# Example config file that will only scan on channel 36.
2133freq_list=5180
2134network={
2135 key_mgmt=NONE
2136}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002137
2138
Roshan Pius3a1667e2018-07-03 15:17:14 -07002139# Example configuration using EAP-TTLS for authentication and key
2140# generation for MACsec
2141network={
2142 key_mgmt=IEEE8021X
2143 eap=TTLS
2144 phase2="auth=PAP"
2145 anonymous_identity="anonymous@example.com"
2146 identity="user@example.com"
2147 password="secretr"
2148 ca_cert="/etc/cert/ca.pem"
2149 eapol_flags=0
2150 macsec_policy=1
2151}
2152
2153# Example configuration for MACsec with preshared key
2154network={
2155 key_mgmt=NONE
2156 eapol_flags=0
2157 macsec_policy=1
2158 mka_cak=0123456789ABCDEF0123456789ABCDEF
2159 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
2160 mka_priority=128
2161}