blob: abbe7d72e7fdfaee3f825572aba9765c8f5d11e5 [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
Sunil Ravi7f769292024-07-23 22:21:32 +0000881# RSN overriding
882# NOTE: The protocol used for this mechanism is still subject to change and as
883# such, this should not yet be enabled for production uses to avoid issues if
884# something were to change.
885# 0 = Disabled (default)
886# 1 = Enabled automatically if the driver indicates support
887# 2 = Forced to be enabled even without driver capability indication
888#rsn_overriding=0
889
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800890# network block
891#
892# Each network (usually AP's sharing the same SSID) is configured as a separate
893# block in this configuration file. The network blocks are in preference order
894# (the first match is used).
895#
896# network block fields:
897#
898# disabled:
899# 0 = this network can be used (default)
900# 1 = this network block is disabled (can be enabled through ctrl_iface,
901# e.g., with wpa_cli or wpa_gui)
902#
903# id_str: Network identifier string for external scripts. This value is passed
904# to external action script through wpa_cli as WPA_ID_STR environment
905# variable to make it easier to do network specific configuration.
906#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700907# ssid: SSID (mandatory); network name in one of the optional formats:
908# - an ASCII string with double quotation
909# - a hex string (two characters per octet of SSID)
910# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800911#
912# scan_ssid:
913# 0 = do not scan this SSID with specific Probe Request frames (default)
914# 1 = scan with SSID-specific Probe Request frames (this can be used to
915# find APs that do not accept broadcast SSID or use multiple SSIDs;
916# this will add latency to scanning, so enable this only when needed)
917#
918# bssid: BSSID (optional); if set, this network block is used only when
919# associating with the AP using the configured BSSID
920#
Hai Shalom899fcc72020-10-19 14:38:18 -0700921# ignore_broadcast_ssid: SSID broadcast behavior
922# Send empty SSID in beacons and ignore probe request frames that do not
923# specify full SSID, i.e., require stations to know SSID.
924# default: disabled (0)
925# 1 = send empty (length=0) SSID in beacon and ignore probe request for
926# broadcast SSID
927# 2 = clear SSID (ASCII 0), but keep the original length (this may be required
928# with some clients that do not support empty SSID) and ignore probe
929# requests for broadcast SSID
930#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800931# priority: priority group (integer)
932# By default, all networks will get same priority group (0). If some of the
933# networks are more desirable, this field can be used to change the order in
934# which wpa_supplicant goes through the networks when selecting a BSS. The
935# priority groups will be iterated in decreasing priority (i.e., the larger the
936# priority value, the sooner the network is matched against the scan results).
937# Within each priority group, networks will be selected based on security
938# policy, signal strength, etc.
939# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
940# using this priority to select the order for scanning. Instead, they try the
941# networks in the order that used in the configuration file.
942#
943# mode: IEEE 802.11 operation mode
944# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
945# 1 = IBSS (ad-hoc, peer-to-peer)
946# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800947# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
948# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
949# TKIP/CCMP) is available for backwards compatibility, but its use is
950# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800951# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
952# both), and psk must also be set.
953#
954# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
955# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
956# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
957# In addition, this value is only used by the station that creates the IBSS. If
958# an IBSS network with the configured SSID is already present, the frequency of
959# the network will be used instead of this configured value.
960#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800961# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700962# 0 = do not use PBSS
963# 1 = use PBSS
964# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800965# Used together with mode configuration. When mode is AP, it means to start a
966# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700967# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
968# which means connect to either PCP or AP.
969# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800970# For more details, see IEEE Std 802.11ad-2012.
971#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800972# scan_freq: List of frequencies to scan
973# Space-separated list of frequencies in MHz to scan when searching for this
974# BSS. If the subset of channels used by the network is known, this option can
975# be used to optimize scanning to not occur on channels that the network does
976# not use. Example: scan_freq=2412 2437 2462
977#
978# freq_list: Array of allowed frequencies
979# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
980# set, scan results that do not match any of the specified frequencies are not
981# considered when selecting a BSS.
982#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700983# This can also be set on the outside of the network block. In this case,
984# it limits the frequencies that will be scanned.
985#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800986# bgscan: Background scanning
987# wpa_supplicant behavior for background scanning can be specified by
988# configuring a bgscan module. These modules are responsible for requesting
989# background scans for the purpose of roaming within an ESS (i.e., within a
990# single network block with all the APs using the same SSID). The bgscan
991# parameter uses following format: "<bgscan module name>:<module parameters>"
992# Following bgscan modules are available:
993# simple - Periodic background scans based on signal strength
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000994# send_btm_query > 0 means do this many BTM queries before attempting a scan.
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800995# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000996# <long interval>[:<send_btm_query>]"
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800997# bgscan="simple:30:-45:300"
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000998# bgscan="simple:30:-45:300:3"
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800999# learn - Learn channels used by the network and try to avoid bgscans on other
1000# channels (experimental)
1001# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
1002# <long interval>[:<database file name>]"
1003# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001004# Explicitly disable bgscan by setting
1005# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001006#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -08001007# This option can also be set outside of all network blocks for the bgscan
1008# parameter to apply for all the networks that have no specific bgscan
1009# parameter.
1010#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001011# proto: list of accepted protocols
1012# WPA = WPA/IEEE 802.11i/D3.0
1013# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
Hai Shalomce48b4a2018-09-05 11:41:35 -07001014# Note that RSN is used also for WPA3.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001015# If not set, this defaults to: WPA RSN
1016#
1017# key_mgmt: list of accepted authenticated key management protocols
1018# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
1019# WPA-EAP = WPA using EAP authentication
1020# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
1021# generated WEP keys
1022# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001023# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
1024# instead)
1025# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
1026# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Roshan Pius3a1667e2018-07-03 15:17:14 -07001027# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
1028# and using SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001029# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
1030# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001031# SAE = Simultaneous authentication of equals; pre-shared key/password -based
1032# authentication with stronger security than WPA-PSK especially when using
Hai Shalomce48b4a2018-09-05 11:41:35 -07001033# not that strong password; a.k.a. WPA3-Personal
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001034# FT-SAE = SAE with FT
1035# WPA-EAP-SUITE-B = Suite B 128-bit level
1036# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001037# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001038# FILS-SHA256 = Fast Initial Link Setup with SHA256
1039# FILS-SHA384 = Fast Initial Link Setup with SHA384
1040# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
1041# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Hai Shalomce48b4a2018-09-05 11:41:35 -07001042# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
1043# DPP = Device Provisioning Protocol
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001044# If not set, this defaults to: WPA-PSK WPA-EAP
1045#
Dmitry Shmidt04949592012-07-19 12:16:46 -07001046# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001047# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001048# 1 = optional
1049# 2 = required
1050# The most common configuration options for this based on the PMF (protected
1051# management frames) certification program are:
1052# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
1053# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001054# (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
1055# WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE
Dmitry Shmidt04949592012-07-19 12:16:46 -07001056#
Hai Shalom74f70d42019-02-11 14:42:39 -08001057# ocv: whether operating channel validation is enabled
Hai Shaloma20dcd72022-02-04 13:43:00 -08001058# This is a countermeasure against multi-channel on-path attacks.
Hai Shalom74f70d42019-02-11 14:42:39 -08001059# Enabling this automatically also enables ieee80211w, if not yet enabled.
1060# 0 = disabled (default)
Hai Shalom60840252021-02-19 19:02:11 -08001061# 1 = enabled if wpa_supplicant's SME in use. Otherwise enabled only when the
1062# driver indicates support for operating channel validation.
Hai Shalom74f70d42019-02-11 14:42:39 -08001063#ocv=1
1064#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001065# auth_alg: list of allowed IEEE 802.11 authentication algorithms
1066# OPEN = Open System authentication (required for WPA/WPA2)
1067# SHARED = Shared Key authentication (requires static WEP keys)
1068# LEAP = LEAP/Network EAP (only used with LEAP)
1069# If not set, automatic selection is used (Open System with LEAP enabled if
1070# LEAP is allowed as one of the EAP methods).
1071#
1072# pairwise: list of accepted pairwise (unicast) ciphers for WPA
1073# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1074# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1075# NONE = Use only Group Keys (deprecated, should not be included if APs support
1076# pairwise keys)
1077# If not set, this defaults to: CCMP TKIP
1078#
1079# group: list of accepted group (broadcast/multicast) ciphers for WPA
1080# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1081# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1082# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
1083# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
1084# If not set, this defaults to: CCMP TKIP WEP104 WEP40
1085#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001086# group_mgmt: list of accepted group management ciphers for RSN (PMF)
1087# AES-128-CMAC = BIP-CMAC-128
1088# BIP-GMAC-128
1089# BIP-GMAC-256
1090# BIP-CMAC-256
1091# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
1092# indicates.
1093#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001094# psk: WPA preshared key; 256-bit pre-shared key
1095# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
1096# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
1097# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001098# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
1099# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001100# This field is not needed, if WPA-EAP is used.
1101# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
1102# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
1103# startup and reconfiguration time can be optimized by generating the PSK only
1104# only when the passphrase or SSID has actually changed.
1105#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -07001106# mem_only_psk: Whether to keep PSK/passphrase only in memory
1107# 0 = allow psk/passphrase to be stored to the configuration file
1108# 1 = do not store psk/passphrase to the configuration file
1109#mem_only_psk=0
1110#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001111# sae_password: SAE password
1112# This parameter can be used to set a password for SAE. By default, the
Roshan Pius3a1667e2018-07-03 15:17:14 -07001113# passphrase from the psk parameter is used if this separate parameter is not
1114# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
1115# SAE passwords do not have such constraints.
1116#
1117# sae_password_id: SAE password identifier
1118# This parameter can be used to set an identifier for the SAE password. By
1119# default, no such identifier is used. If set, the specified identifier value
1120# is used by the other peer to select which password to use for authentication.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001121#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001122# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
1123# Dynamic WEP key required for non-WPA mode
1124# bit0 (1): require dynamically generated unicast WEP key
1125# bit1 (2): require dynamically generated broadcast WEP key
1126# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001127# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001128# eapol_flags must be set to 0 for the authentication to be completed
1129# successfully.
1130#
1131# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001132# This determines how sessions are secured with MACsec (only for MACsec
1133# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001134# 0: MACsec not in use (default)
1135# 1: MACsec enabled - Should secure, accept key server's advice to
1136# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001137#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001138# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1139# This setting applies only when MACsec is in use, i.e.,
1140# - macsec_policy is enabled
1141# - the key server has decided to enable MACsec
1142# 0: Encrypt traffic (default)
1143# 1: Integrity only
1144#
Hai Shalom74f70d42019-02-11 14:42:39 -08001145# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1146# This setting applies only when MACsec is in use, i.e.,
1147# - macsec_policy is enabled
1148# - the key server has decided to enable MACsec
1149# 0: Replay protection disabled (default)
1150# 1: Replay protection enabled
1151#
1152# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1153# This determines a window in which replay is tolerated, to allow receipt
1154# of frames that have been misordered by the network.
1155# This setting applies only when MACsec replay protection active, i.e.,
1156# - macsec_replay_protect is enabled
1157# - the key server has decided to enable MACsec
1158# 0: No replay window, strict check (default)
1159# 1..2^32-1: number of packets that could be misordered
1160#
Sunil Ravi036cec52023-03-29 11:35:17 -07001161# macsec_offload - Enable MACsec hardware offload
1162#
1163# This setting applies only when MACsec is in use, i.e.,
1164# - the key server has decided to enable MACsec
1165#
1166# 0 = MACSEC_OFFLOAD_OFF (default)
1167# 1 = MACSEC_OFFLOAD_PHY
1168# 2 = MACSEC_OFFLOAD_MAC
1169#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001170# macsec_port: IEEE 802.1X/MACsec port
1171# Port component of the SCI
1172# Range: 1-65534 (default: 1)
1173#
Dmitry Shmidt29333592017-01-09 12:27:11 -08001174# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001175# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -08001176# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1177# with lower priority will become the key server and start distributing SAKs.
Hai Shalom74f70d42019-02-11 14:42:39 -08001178# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1179# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1180# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1181# (2..64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -08001182# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1183# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001184#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001185# mixed_cell: This option can be used to configure whether so called mixed
1186# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001187# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001188# 0 = disabled (default)
1189# 1 = enabled
1190#
1191# proactive_key_caching:
1192# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001193# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001194# 1 = enabled
1195#
Hai Shalom81f62d82019-07-22 12:10:00 -07001196# ft_eap_pmksa_caching:
1197# Whether FT-EAP PMKSA caching is allowed
1198# 0 = do not try to use PMKSA caching with FT-EAP (default)
1199# 1 = try to use PMKSA caching with FT-EAP
1200# This controls whether to try to use PMKSA caching with FT-EAP for the
1201# FT initial mobility domain association.
1202#ft_eap_pmksa_caching=0
1203#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001204# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1205# hex without quotation, e.g., 0102030405)
1206# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1207#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001208# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1209# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1210#
Hai Shalomfdcde762020-04-02 11:19:20 -07001211# wpa_deny_ptk0_rekey: Workaround for PTK rekey issues
1212# PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the
1213# security and stability with some cards.
1214# To avoid the issues wpa_supplicant can replace those PTK rekeys (including
1215# EAP reauthentications) with fast reconnects.
1216#
1217# Available options:
1218# 0 = always rekey when configured/instructed (default)
1219# 1 = only rekey when the local driver is explicitly indicating it can perform
1220# this operation without issues
1221# 2 = never allow problematic PTK0 rekeys
1222#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001223# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1224# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -08001225# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001226#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001227# Following fields are only used with internal EAP implementation.
1228# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001229# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001230# cannot be used with WPA; to be used as a Phase 2 method
1231# with EAP-PEAP or EAP-TTLS)
1232# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1233# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1234# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1235# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1236# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1237# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1238# TLS = EAP-TLS (client and server certificate)
1239# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1240# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1241# authentication)
1242# If not set, all compiled in methods are allowed.
1243#
1244# identity: Identity string for EAP
1245# This field is also used to configure user NAI for
1246# EAP-PSK/PAX/SAKE/GPSK.
1247# anonymous_identity: Anonymous identity string for EAP (to be used as the
1248# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07001249# identity, e.g., EAP-TTLS). This field can also be used with
1250# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Steven Liu9138d432022-11-23 22:29:05 +00001251# strict_conservative_peer_mode: Whether the strict conservative peer mode
1252# is enabled. This field is used to handle the reponse of AT_PERMANENT_ID_REQ
1253# for EAP-SIM/AKA/AKA'. In non-strict convervative peer mode, a client
1254# error would be sent to the server, but the mode will send the permanent
1255# identity in some special cases according to 4.6.2 of RFC 4187; With the
1256# strict mode, the permanent identity is never sent to the server.
1257# 0 = disabled (default)
1258# 1 = enabled
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001259# password: Password string for EAP. This field can include either the
1260# plaintext password (using ASCII or hex string) or a NtPasswordHash
1261# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1262# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1263# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1264# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1265# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001266# variable length PSK. ext:<name of external password field> format can
1267# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001268# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1269# or more trusted CA certificates. If ca_cert and ca_path are not
1270# included, server certificate will not be verified. This is insecure and
1271# a trusted CA certificate should always be configured when using
1272# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1273# change when wpa_supplicant is run in the background.
1274#
1275# Alternatively, this can be used to only perform matching of the server
1276# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1277# this case, the possible CA certificates in the server certificate chain
1278# are ignored and only the server certificate is verified. This is
1279# configured with the following format:
1280# hash:://server/sha256/cert_hash_in_hex
1281# For example: "hash://server/sha256/
1282# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1283#
1284# On Windows, trusted CA certificates can be loaded from the system
1285# certificate store by setting this to cert_store://<name>, e.g.,
1286# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1287# Note that when running wpa_supplicant as an application, the user
1288# certificate store (My user account) is used, whereas computer store
1289# (Computer account) is used when running wpasvc as a service.
1290# ca_path: Directory path for CA certificate files (PEM). This path may
1291# contain multiple CA certificates in OpenSSL format. Common use for this
1292# is to point to system trusted CA list which is often installed into
1293# directory like /etc/ssl/certs. If configured, these certificates are
1294# added to the list of trusted CAs. ca_cert may also be included in that
1295# case, but it is not required.
1296# client_cert: File path to client certificate file (PEM/DER)
1297# Full path should be used since working directory may change when
1298# wpa_supplicant is run in the background.
1299# Alternatively, a named configuration blob can be used by setting this
1300# to blob://<blob name>.
1301# private_key: File path to client private key file (PEM/DER/PFX)
1302# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1303# commented out. Both the private key and certificate will be read from
1304# the PKCS#12 file in this case. Full path should be used since working
1305# directory may change when wpa_supplicant is run in the background.
1306# Windows certificate store can be used by leaving client_cert out and
1307# configuring private_key in one of the following formats:
1308# cert://substring_to_match
1309# hash://certificate_thumbprint_in_hex
1310# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1311# Note that when running wpa_supplicant as an application, the user
1312# certificate store (My user account) is used, whereas computer store
1313# (Computer account) is used when running wpasvc as a service.
1314# Alternatively, a named configuration blob can be used by setting this
1315# to blob://<blob name>.
1316# private_key_passwd: Password for private key file (if left out, this will be
1317# asked through control interface)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001318# subject_match: Substring to be matched against the subject of the
1319# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001320# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001321# The subject string is in following format:
1322# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001323# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001324# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001325# such a use case, domain_suffix_match or domain_match should be used
1326# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001327# altsubject_match: Semicolon separated string of entries to be matched against
1328# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001329# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001330# contains one of the entries in an alternative subject name extension.
1331# altSubjectName string is in following format: TYPE:VALUE
1332# Example: EMAIL:server@example.com
1333# Example: DNS:server.example.com;DNS:server2.example.com
1334# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001335# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001336# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001337# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1338# constraint is met. If no dNSName values are present, this constraint is
1339# matched against SubjectName CN using same suffix match comparison.
1340#
1341# Suffix match here means that the host/domain name is compared one label
1342# at a time starting from the top-level domain and all the labels in
1343# domain_suffix_match shall be included in the certificate. The
1344# certificate may include additional sub-level labels in addition to the
1345# required labels.
1346#
Hai Shalom021b0b52019-04-10 11:17:58 -07001347# More than one match string can be provided by using semicolons to
1348# separate the strings (e.g., example.org;example.com). When multiple
1349# strings are specified, a match with any one of the values is considered
1350# a sufficient match for the certificate, i.e., the conditions are ORed
1351# together.
1352#
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001353# For example, domain_suffix_match=example.com would match
1354# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001355# domain_match: Constraint for server domain name
1356# If set, this FQDN is used as a full match requirement for the
1357# server certificate in SubjectAltName dNSName element(s). If a
1358# matching dNSName is found, this constraint is met. If no dNSName
1359# values are present, this constraint is matched against SubjectName CN
1360# using same full match comparison. This behavior is similar to
1361# domain_suffix_match, but has the requirement of a full match, i.e.,
1362# no subdomains or wildcard matches are allowed. Case-insensitive
1363# comparison is used, so "Example.com" matches "example.com", but would
1364# not match "test.Example.com".
Hai Shalom021b0b52019-04-10 11:17:58 -07001365#
1366# More than one match string can be provided by using semicolons to
1367# separate the strings (e.g., example.org;example.com). When multiple
1368# strings are specified, a match with any one of the values is considered
1369# a sufficient match for the certificate, i.e., the conditions are ORed
1370# together.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001371# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1372# (string with field-value pairs, e.g., "peapver=0" or
1373# "peapver=1 peaplabel=1")
1374# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1375# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1376# to be used during key derivation when PEAPv1 or newer. Most existing
1377# PEAPv1 implementation seem to be using the old label, "client EAP
1378# encryption", and wpa_supplicant is now using that as the default value.
1379# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1380# interoperate with PEAPv1; see eap_testing.txt for more details.
1381# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1382# tunneled EAP-Success. This is required with some RADIUS servers that
1383# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1384# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1385# include_tls_length=1 can be used to force wpa_supplicant to include
1386# TLS Message Length field in all TLS messages even if they are not
1387# fragmented.
1388# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1389# challenges (by default, it accepts 2 or 3)
1390# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1391# protected result indication.
1392# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1393# behavior:
1394# * 0 = do not use cryptobinding (default)
1395# * 1 = use cryptobinding if server supports it
1396# * 2 = require cryptobinding
Jouni Malinenab31d322023-07-08 19:55:32 +03001397# 'phase2_auth' option can be used to control Phase 2 (i.e., within TLS
1398# tunnel) behavior for PEAP:
1399# * 0 = do not require Phase 2 authentication
1400# * 1 = require Phase 2 authentication when client certificate
1401# (private_key/client_cert) is not used and TLS session resumption was
1402# not used (default)
1403# * 2 = require Phase 2 authentication in all cases
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001404# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1405# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001406#
1407# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1408# used to configure a mode that allows EAP-Success (and EAP-Failure)
1409# without going through authentication step. Some switches use such
1410# sequence when forcing the port to be authorized/unauthorized or as a
1411# fallback option if the authentication server is unreachable. By default,
1412# wpa_supplicant discards such frames to protect against potential attacks
1413# by rogue devices, but this option can be used to disable that protection
1414# for cases where the server/authenticator does not need to be
1415# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001416# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1417# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001418# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1419# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001420#
1421# TLS-based methods can use the following parameters to control TLS behavior
1422# (these are normally in the phase1 parameter, but can be used also in the
1423# phase2 parameter when EAP-TLS is used within the inner tunnel):
1424# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1425# TLS library, these may be disabled by default to enforce stronger
1426# security)
1427# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1428# the TLS library to accept certificates even if they are not currently
1429# valid, i.e., have expired or have not yet become valid; this should be
1430# used only for testing purposes)
1431# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1432# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1433# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1434# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001435# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001436# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1437# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001438# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Hai Shalom74f70d42019-02-11 14:42:39 -08001439# tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1440# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001441# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1442# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001443# tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1444# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001445# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1446# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001447# tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1448# systemwide TLS policies to be overridden)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001449# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1450# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001451# tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001452# tls_ext_cert_check=0 - No external server certificate validation (default)
1453# tls_ext_cert_check=1 - External server certificate validation enabled; this
1454# requires an external program doing validation of server certificate
1455# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1456# interface and report the result of the validation with
1457# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001458# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1459# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1460# particular when using Suite B with RSA keys of >= 3K (3072) bits
Sunil Ravia04bd252022-05-02 22:54:18 -07001461# allow_unsafe_renegotiation=1 - allow connection with a TLS server that does
1462# not support safe renegotiation (RFC 5746); please note that this
1463# workaround should be only when having to authenticate with an old
1464# authentication server that cannot be updated to use secure TLS
1465# implementation.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001466#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001467# Following certificate/private key fields are used in inner Phase2
1468# authentication when using EAP-TTLS or EAP-PEAP.
1469# ca_cert2: File path to CA certificate file. This file can have one or more
1470# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1471# server certificate will not be verified. This is insecure and a trusted
1472# CA certificate should always be configured.
1473# ca_path2: Directory path for CA certificate files (PEM)
1474# client_cert2: File path to client certificate file
1475# private_key2: File path to client private key file
1476# private_key2_passwd: Password for private key file
1477# dh_file2: File path to DH/DSA parameters file (in PEM format)
1478# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001479# authentication server certificate. See subject_match for more details.
1480# altsubject_match2: Semicolon separated string of entries to be matched
1481# against the alternative subject name of the authentication server
1482# certificate. See altsubject_match documentation for more details.
1483# domain_suffix_match2: Constraint for server domain name. See
1484# domain_suffix_match for more details.
Hai Shalomc3565922019-10-28 11:58:20 -07001485# ocsp2: See ocsp for more details.
1486#
1487# Separate machine credentials can be configured for EAP-TEAP Phase 2 with
1488# "machine_" prefix (e.g., "machine_identity") in the configuration parameters.
1489# See the parameters without that prefix for more details on the meaning and
1490# format of each such parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001491#
1492# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1493# This value limits the fragment size for EAP methods that support
1494# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1495# small enough to make the EAP messages fit in MTU of the network
1496# interface used for EAPOL. The default value is suitable for most
1497# cases.
1498#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001499# ocsp: Whether to use/require OCSP to check server certificate
1500# 0 = do not use OCSP stapling (TLS certificate status extension)
1501# 1 = try to use OCSP stapling, but not require response
1502# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001503# 3 = require valid OCSP stapling response for all not-trusted
1504# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001505#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001506# openssl_ciphers: OpenSSL specific cipher configuration
1507# This can be used to override the global openssl_ciphers configuration
1508# parameter (see above).
1509#
1510# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1511#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001512# EAP-FAST variables:
1513# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1514# to create this file and write updates to it when PAC is being
1515# provisioned or refreshed. Full path to the file should be used since
1516# working directory may change when wpa_supplicant is run in the
1517# background. Alternatively, a named configuration blob can be used by
1518# setting this to blob://<blob name>
1519# phase1: fast_provisioning option can be used to enable in-line provisioning
1520# of EAP-FAST credentials (PAC):
1521# 0 = disabled,
1522# 1 = allow unauthenticated provisioning,
1523# 2 = allow authenticated provisioning,
1524# 3 = allow both unauthenticated and authenticated provisioning
1525# fast_max_pac_list_len=<num> option can be used to set the maximum
1526# number of PAC entries to store in a PAC list (default: 10)
1527# fast_pac_format=binary option can be used to select binary format for
1528# storing PAC entries in order to save some space (the default
1529# text format uses about 2.5 times the size of minimal binary
1530# format)
1531#
1532# wpa_supplicant supports number of "EAP workarounds" to work around
1533# interoperability issues with incorrectly behaving authentication servers.
1534# These are enabled by default because some of the issues are present in large
1535# number of authentication servers. Strict EAP conformance mode can be
1536# configured by disabling workarounds with eap_workaround=0.
1537
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001538# update_identifier: PPS MO ID
1539# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001540#
1541# roaming_consortium_selection: Roaming Consortium Selection
1542# The matching Roaming Consortium OI that was used to generate this
1543# network profile.
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001544
Dmitry Shmidt04949592012-07-19 12:16:46 -07001545# Station inactivity limit
1546#
1547# If a station does not send anything in ap_max_inactivity seconds, an
1548# empty data frame is sent to it in order to verify whether it is
1549# still in range. If this frame is not ACKed, the station will be
1550# disassociated and then deauthenticated. This feature is used to
1551# clear station table of old entries when the STAs move out of the
1552# range.
1553#
1554# The station can associate again with the AP if it is still in range;
1555# this inactivity poll is just used as a nicer way of verifying
1556# inactivity; i.e., client will not report broken connection because
1557# disassociation frame is not sent immediately without first polling
1558# the STA with a data frame.
1559# default: 300 (i.e., 5 minutes)
1560#ap_max_inactivity=300
1561
1562# DTIM period in Beacon intervals for AP mode (default: 2)
1563#dtim_period=2
1564
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001565# Beacon interval (default: 100 TU)
1566#beacon_int=100
1567
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001568# WPS in AP mode
1569# 0 = WPS enabled and configured (default)
1570# 1 = WPS disabled
1571#wps_disabled=0
1572
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001573# FILS DH Group
1574# 0 = PFS disabled with FILS shared key authentication (default)
1575# 1-65535 = DH Group to use for FILS PFS
1576#fils_dh_group=0
1577
Hai Shalomfdcde762020-04-02 11:19:20 -07001578# DPP PFS
1579# 0: allow PFS to be used or not used (default)
1580# 1: require PFS to be used (note: not compatible with DPP R1)
1581# 2: do not allow PFS to be used
1582#dpp_pfs=0
1583
Sunil Ravi89eba102022-09-13 21:04:37 -07001584# DPP Network introduction type
1585# 0: unprotected variant from DPP R1 (default)
1586# 1: privacy protecting (station Connector encrypted) variant from
1587# DPP R3
1588#dpp_connector_privacy=0
1589
Hai Shalom60840252021-02-19 19:02:11 -08001590# Whether beacon protection is enabled
1591# This depends on management frame protection (ieee80211w) being enabled and
1592# beacon protection support indication from the driver.
1593# 0 = disabled (default)
1594# 1 = enabled
Hai Shalom899fcc72020-10-19 14:38:18 -07001595#beacon_prot=0
1596
1597# OWE DH Group
1598# 0: use default (19) first and then try all supported groups one by one if AP
1599# rejects the selected group
1600# 1-65535: DH Group to use for OWE
1601# Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
1602# currently supported.
1603#owe_group=0
1604
1605# OWE-only mode (disable transition mode)
1606# 0: enable transition mode (allow connection to either OWE or open BSS)
1607# 1 = disable transition mode (allow connection only with OWE)
1608#owe_only=0
1609
1610# OWE PTK derivation workaround
1611# Initial OWE implementation used SHA256 when deriving the PTK for all
1612# OWE groups. This was supposed to change to SHA384 for group 20 and
1613# SHA512 for group 21. This parameter can be used to enable older
1614# behavior mainly for testing purposes. There is no impact to group 19
1615# behavior, but if enabled, this will make group 20 and 21 cases use
1616# SHA256-based PTK derivation which will not work with the updated
1617# OWE implementation on the AP side.
1618#owe_ptk_workaround=0
1619
1620# Transition Disable indication
1621# The AP can notify authenticated stations to disable transition mode
1622# in their network profiles when the network has completed transition
1623# steps, i.e., once sufficiently large number of APs in the ESS have
1624# been updated to support the more secure alternative. When this
1625# indication is used, the stations are expected to automatically
1626# disable transition mode and less secure security options. This
1627# includes use of WEP, TKIP (including use of TKIP as the group
1628# cipher), and connections without PMF.
1629# Bitmap bits:
1630# bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK
1631# and only allow SAE to be used)
1632# bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
1633# bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
1634# bit 3 (0x08): Enhanced Open (disable use of open network; require
1635# OWE)
1636
1637# SAE-PK mode
1638# 0: automatic SAE/SAE-PK selection based on password; enable
1639# transition mode (allow SAE authentication without SAE-PK)
1640# 1: SAE-PK only (disable transition mode; allow SAE authentication
1641# only with SAE-PK)
1642# 2: disable SAE-PK (allow SAE authentication only without SAE-PK)
1643#sae_pk=0
1644
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001645# MAC address policy
1646# 0 = use permanent MAC address
1647# 1 = use random MAC address for each ESS connection
1648# 2 = like 1, but maintain OUI (with local admin bit set)
1649#mac_addr=0
1650
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001651# disable_ht: Whether HT (802.11n) should be disabled.
1652# 0 = HT enabled (if AP supports it)
1653# 1 = HT disabled
1654#
1655# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1656# 0 = HT-40 enabled (if AP supports it)
1657# 1 = HT-40 disabled
1658#
1659# disable_sgi: Whether SGI (short guard interval) should be disabled.
1660# 0 = SGI enabled (if AP supports it)
1661# 1 = SGI disabled
1662#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001663# disable_ldpc: Whether LDPC should be disabled.
1664# 0 = LDPC enabled (if AP supports it)
1665# 1 = LDPC disabled
1666#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001667# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1668# 0 = 40 MHz tolerant (default)
1669# 1 = 40 MHz intolerant
1670#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001671# ht_mcs: Configure allowed MCS rates.
1672# Parsed as an array of bytes, in base-16 (ascii-hex)
1673# ht_mcs="" // Use all available (default)
1674# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1675# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1676#
1677# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1678# -1 = Do not make any changes.
1679# 0 = Enable MAX-AMSDU if hardware supports it.
1680# 1 = Disable AMSDU
1681#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001682# ampdu_factor: Maximum A-MPDU Length Exponent
1683# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1684#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001685# ampdu_density: Allow overriding AMPDU density configuration.
1686# Treated as hint by the kernel.
1687# -1 = Do not make any changes.
1688# 0-3 = Set AMPDU density (aka factor) to specified value.
Hai Shalom74f70d42019-02-11 14:42:39 -08001689#
1690# tx_stbc: Allow overriding STBC support for TX streams
1691# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1692# -1 = Do not make any changes (default)
1693# 0 = Set if not supported
1694# 1 = Set if supported
1695#
1696# rx_stbc: Allow overriding STBC support for RX streams
1697# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1698# -1 = Do not make any changes (default)
1699# 0 = Set if not supported
1700# 1 = Set for support of one spatial stream
1701# 2 = Set for support of one and two spatial streams
1702# 3 = Set for support of one, two and three spatial streams
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001703
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001704# disable_vht: Whether VHT should be disabled.
1705# 0 = VHT enabled (if AP supports it)
1706# 1 = VHT disabled
1707#
1708# vht_capa: VHT capabilities to set in the override
1709# vht_capa_mask: mask of VHT capabilities
1710#
1711# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1712# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1713# 0: MCS 0-7
1714# 1: MCS 0-8
1715# 2: MCS 0-9
1716# 3: not supported
1717
Sunil Ravi77d572f2023-01-17 23:58:31 +00001718# disable_eht: Whether EHT should be disabled.
1719# 0 = EHT enabled (if supported) (default)
1720# 1 = EHT disabled
1721
Hai Shalom74f70d42019-02-11 14:42:39 -08001722# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1723# 0 = normal STA (default)
1724# 1 = backhaul STA
1725# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1726# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1727# added to a bridge to allow forwarding frames over this backhaul link.
1728
Sunil Ravi99c035e2024-07-12 01:42:03 +00001729# Multi-AP Profile
1730# Indicate the supported Multi-AP profile
1731# 1 = Supports Multi-AP profile 1 as defined in Wi-Fi EasyMesh specification
1732# 2 = Supports Multi-AP profile 2 as defined in Wi-Fi EasyMesh specification
1733#multi_ap_profile=2
1734
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001735##### Fast Session Transfer (FST) support #####################################
1736#
1737# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001738# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1739# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001740#
1741# FST is the transfer of a session from a channel to another channel, in the
1742# same or different frequency bands.
1743#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001744# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001745
1746# Identifier of an FST Group the interface belongs to.
1747#fst_group_id=bond0
1748
1749# Interface priority within the FST Group.
1750# Announcing a higher priority for an interface means declaring it more
1751# preferable for FST switch.
1752# fst_priority is in 1..255 range with 1 being the lowest priority.
1753#fst_priority=100
1754
1755# Default LLT value for this interface in milliseconds. The value used in case
1756# no value provided during session setup. Default is 50 msec.
1757# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1758# Transitioning between states).
1759#fst_llt=100
1760
Hai Shalom81f62d82019-07-22 12:10:00 -07001761# BSS Transition Management
1762# disable_btm - Disable BSS transition management in STA
1763# Set to 0 to enable BSS transition management (default behavior)
1764# Set to 1 to disable BSS transition management
1765#disable_btm=0
1766
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001767# This value is used to set where to perform roaming logic
1768# Set to 0 to handle roaming logic fully in supplicant
1769# Set to 1 to skip roaming logic in supplicant and handle it in firmware
1770# In supplicant, just parse BTM frame and notify framework
1771#btm_offload=0
1772
Hai Shalomc3565922019-10-28 11:58:20 -07001773# Enable EDMG capability in STA/AP mode, default value is false
1774#enable_edmg=1
1775
1776# This value is used to configure the channel bonding feature.
1777# Default value is 0.
1778# Relevant only if enable_edmg is true
1779# In AP mode it defines the EDMG channel to use for AP operation.
1780# In STA mode it defines the EDMG channel for connection (if supported by AP).
1781#edmg_channel=9
1782
Sunil Ravi7f769292024-07-23 22:21:32 +00001783# BSS max idle period to request
1784# If nonzero, request the specified number of 1000 TU (i.e., 1.024 s)
1785# as the maximum idle period for the STA during association.
1786#max_idle=600
1787
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001788# Example blocks:
1789
1790# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1791network={
1792 ssid="simple"
1793 psk="very secret passphrase"
1794 priority=5
1795}
1796
1797# Same as previous, but request SSID-specific scanning (for APs that reject
1798# broadcast SSID)
1799network={
1800 ssid="second ssid"
1801 scan_ssid=1
1802 psk="very secret passphrase"
1803 priority=2
1804}
1805
1806# Only WPA-PSK is used. Any valid cipher combination is accepted.
1807network={
1808 ssid="example"
1809 proto=WPA
1810 key_mgmt=WPA-PSK
1811 pairwise=CCMP TKIP
1812 group=CCMP TKIP WEP104 WEP40
1813 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1814 priority=2
1815}
1816
1817# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1818network={
1819 ssid="example"
1820 proto=WPA
1821 key_mgmt=WPA-PSK
1822 pairwise=TKIP
1823 group=TKIP
1824 psk="not so secure passphrase"
1825 wpa_ptk_rekey=600
1826}
1827
1828# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1829# or WEP40 as the group cipher will not be accepted.
1830network={
1831 ssid="example"
1832 proto=RSN
1833 key_mgmt=WPA-EAP
1834 pairwise=CCMP TKIP
1835 group=CCMP TKIP
1836 eap=TLS
1837 identity="user@example.com"
1838 ca_cert="/etc/cert/ca.pem"
1839 client_cert="/etc/cert/user.pem"
1840 private_key="/etc/cert/user.prv"
1841 private_key_passwd="password"
1842 priority=1
1843}
1844
1845# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1846# (e.g., Radiator)
1847network={
1848 ssid="example"
1849 key_mgmt=WPA-EAP
1850 eap=PEAP
1851 identity="user@example.com"
1852 password="foobar"
1853 ca_cert="/etc/cert/ca.pem"
1854 phase1="peaplabel=1"
1855 phase2="auth=MSCHAPV2"
1856 priority=10
1857}
1858
1859# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1860# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1861network={
1862 ssid="example"
1863 key_mgmt=WPA-EAP
1864 eap=TTLS
1865 identity="user@example.com"
1866 anonymous_identity="anonymous@example.com"
1867 password="foobar"
1868 ca_cert="/etc/cert/ca.pem"
1869 priority=2
1870}
1871
1872# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1873# use. Real identity is sent only within an encrypted TLS tunnel.
1874network={
1875 ssid="example"
1876 key_mgmt=WPA-EAP
1877 eap=TTLS
1878 identity="user@example.com"
1879 anonymous_identity="anonymous@example.com"
1880 password="foobar"
1881 ca_cert="/etc/cert/ca.pem"
1882 phase2="auth=MSCHAPV2"
1883}
1884
1885# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1886# authentication.
1887network={
1888 ssid="example"
1889 key_mgmt=WPA-EAP
1890 eap=TTLS
1891 # Phase1 / outer authentication
1892 anonymous_identity="anonymous@example.com"
1893 ca_cert="/etc/cert/ca.pem"
1894 # Phase 2 / inner authentication
1895 phase2="autheap=TLS"
1896 ca_cert2="/etc/cert/ca2.pem"
1897 client_cert2="/etc/cer/user.pem"
1898 private_key2="/etc/cer/user.prv"
1899 private_key2_passwd="password"
1900 priority=2
1901}
1902
1903# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1904# group cipher.
1905network={
1906 ssid="example"
1907 bssid=00:11:22:33:44:55
1908 proto=WPA RSN
1909 key_mgmt=WPA-PSK WPA-EAP
1910 pairwise=CCMP
1911 group=CCMP
1912 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1913}
1914
1915# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1916# and all valid ciphers.
1917network={
1918 ssid=00010203
1919 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1920}
1921
1922
1923# EAP-SIM with a GSM SIM or USIM
1924network={
1925 ssid="eap-sim-test"
1926 key_mgmt=WPA-EAP
1927 eap=SIM
1928 pin="1234"
1929 pcsc=""
1930}
1931
1932
1933# EAP-PSK
1934network={
1935 ssid="eap-psk-test"
1936 key_mgmt=WPA-EAP
1937 eap=PSK
1938 anonymous_identity="eap_psk_user"
1939 password=06b4be19da289f475aa46a33cb793029
1940 identity="eap_psk_user@example.com"
1941}
1942
1943
1944# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1945# EAP-TLS for authentication and key generation; require both unicast and
1946# broadcast WEP keys.
1947network={
1948 ssid="1x-test"
1949 key_mgmt=IEEE8021X
1950 eap=TLS
1951 identity="user@example.com"
1952 ca_cert="/etc/cert/ca.pem"
1953 client_cert="/etc/cert/user.pem"
1954 private_key="/etc/cert/user.prv"
1955 private_key_passwd="password"
1956 eapol_flags=3
1957}
1958
1959
1960# LEAP with dynamic WEP keys
1961network={
1962 ssid="leap-example"
1963 key_mgmt=IEEE8021X
1964 eap=LEAP
1965 identity="user"
1966 password="foobar"
1967}
1968
1969# EAP-IKEv2 using shared secrets for both server and peer authentication
1970network={
1971 ssid="ikev2-example"
1972 key_mgmt=WPA-EAP
1973 eap=IKEV2
1974 identity="user"
1975 password="foobar"
1976}
1977
1978# EAP-FAST with WPA (WPA or WPA2)
1979network={
1980 ssid="eap-fast-test"
1981 key_mgmt=WPA-EAP
1982 eap=FAST
1983 anonymous_identity="FAST-000102030405"
1984 identity="username"
1985 password="password"
1986 phase1="fast_provisioning=1"
1987 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1988}
1989
1990network={
1991 ssid="eap-fast-test"
1992 key_mgmt=WPA-EAP
1993 eap=FAST
1994 anonymous_identity="FAST-000102030405"
1995 identity="username"
1996 password="password"
1997 phase1="fast_provisioning=1"
1998 pac_file="blob://eap-fast-pac"
1999}
2000
2001# Plaintext connection (no WPA, no IEEE 802.1X)
2002network={
2003 ssid="plaintext-test"
2004 key_mgmt=NONE
2005}
2006
2007
2008# Shared WEP key connection (no WPA, no IEEE 802.1X)
2009network={
2010 ssid="static-wep-test"
2011 key_mgmt=NONE
2012 wep_key0="abcde"
2013 wep_key1=0102030405
2014 wep_key2="1234567890123"
2015 wep_tx_keyidx=0
2016 priority=5
2017}
2018
2019
2020# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
2021# IEEE 802.11 authentication
2022network={
2023 ssid="static-wep-test2"
2024 key_mgmt=NONE
2025 wep_key0="abcde"
2026 wep_key1=0102030405
2027 wep_key2="1234567890123"
2028 wep_tx_keyidx=0
2029 priority=5
2030 auth_alg=SHARED
2031}
2032
2033
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002034# IBSS/ad-hoc network with RSN
2035network={
2036 ssid="ibss-rsn"
2037 key_mgmt=WPA-PSK
2038 proto=RSN
2039 psk="12345678"
2040 mode=1
2041 frequency=2412
2042 pairwise=CCMP
2043 group=CCMP
2044}
2045
2046# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002047network={
2048 ssid="test adhoc"
2049 mode=1
2050 frequency=2412
2051 proto=WPA
2052 key_mgmt=WPA-NONE
2053 pairwise=NONE
2054 group=TKIP
2055 psk="secret passphrase"
2056}
2057
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002058# open mesh network
2059network={
2060 ssid="test mesh"
2061 mode=5
2062 frequency=2437
2063 key_mgmt=NONE
2064}
2065
2066# secure (SAE + AMPE) network
2067network={
2068 ssid="secure mesh"
2069 mode=5
2070 frequency=2437
2071 key_mgmt=SAE
2072 psk="very secret passphrase"
2073}
2074
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002075
2076# Catch all example that allows more or less all configuration modes
2077network={
2078 ssid="example"
2079 scan_ssid=1
2080 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
2081 pairwise=CCMP TKIP
2082 group=CCMP TKIP WEP104 WEP40
2083 psk="very secret passphrase"
2084 eap=TTLS PEAP TLS
2085 identity="user@example.com"
2086 password="foobar"
2087 ca_cert="/etc/cert/ca.pem"
2088 client_cert="/etc/cert/user.pem"
2089 private_key="/etc/cert/user.prv"
2090 private_key_passwd="password"
2091 phase1="peaplabel=0"
2092}
2093
2094# Example of EAP-TLS with smartcard (openssl engine)
2095network={
2096 ssid="example"
2097 key_mgmt=WPA-EAP
2098 eap=TLS
2099 proto=RSN
2100 pairwise=CCMP TKIP
2101 group=CCMP TKIP
2102 identity="user@example.com"
2103 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002104
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07002105 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
2106 client_cert="pkcs11:manufacturer=piv_II;id=%01"
2107 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002108
2109 # Optional PIN configuration; this can be left out and PIN will be
2110 # asked through the control interface
2111 pin="1234"
2112}
2113
2114# Example configuration showing how to use an inlined blob as a CA certificate
2115# data instead of using external file
2116network={
2117 ssid="example"
2118 key_mgmt=WPA-EAP
2119 eap=TTLS
2120 identity="user@example.com"
2121 anonymous_identity="anonymous@example.com"
2122 password="foobar"
2123 ca_cert="blob://exampleblob"
2124 priority=20
2125}
2126
2127blob-base64-exampleblob={
2128SGVsbG8gV29ybGQhCg==
2129}
2130
2131
2132# Wildcard match for SSID (plaintext APs only). This example select any
2133# open AP regardless of its SSID.
2134network={
2135 key_mgmt=NONE
2136}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002137
Hai Shalom60840252021-02-19 19:02:11 -08002138# Example configuration ignoring two APs - these will be ignored
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002139# for this network.
2140network={
2141 ssid="example"
2142 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002143 bssid_ignore=02:11:22:33:44:55 02:22:aa:44:55:66
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002144}
2145
2146# Example configuration limiting AP selection to a specific set of APs;
2147# any other AP not matching the masked address will be ignored.
2148network={
2149 ssid="example"
2150 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002151 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 -08002152}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002153
2154# Example config file that will only scan on channel 36.
2155freq_list=5180
2156network={
2157 key_mgmt=NONE
2158}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002159
2160
Roshan Pius3a1667e2018-07-03 15:17:14 -07002161# Example configuration using EAP-TTLS for authentication and key
2162# generation for MACsec
2163network={
2164 key_mgmt=IEEE8021X
2165 eap=TTLS
2166 phase2="auth=PAP"
2167 anonymous_identity="anonymous@example.com"
2168 identity="user@example.com"
2169 password="secretr"
2170 ca_cert="/etc/cert/ca.pem"
2171 eapol_flags=0
2172 macsec_policy=1
2173}
2174
2175# Example configuration for MACsec with preshared key
2176network={
2177 key_mgmt=NONE
2178 eapol_flags=0
2179 macsec_policy=1
2180 mka_cak=0123456789ABCDEF0123456789ABCDEF
2181 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
2182 mka_priority=128
2183}