blob: a8abf9ae925d2a201246c8b434ac33101db23656 [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)
506#
507# By default, permanent MAC address is used unless policy is changed by
508# the per-network mac_addr parameter. Global mac_addr=1 can be used to
509# change this default behavior.
510#mac_addr=0
511
512# Lifetime of random MAC address in seconds (default: 60)
513#rand_addr_lifetime=60
514
515# MAC address policy for pre-association operations (scanning, ANQP)
516# 0 = use permanent MAC address
517# 1 = use random MAC address
518# 2 = like 1, but maintain OUI (with local admin bit set)
519#preassoc_mac_addr=0
520
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800521# MAC address policy for GAS operations
522# 0 = use permanent MAC address
523# 1 = use random MAC address
524# 2 = like 1, but maintain OUI (with local admin bit set)
Hai Shalomb755a2a2020-04-23 21:49:02 -0700525# Note that this setting is ignored when a specific MAC address is needed for
526# a full protocol exchange that includes GAS, e.g., when going through a DPP
527# exchange that exposes the configured interface address as part of the DP
528# Public Action frame exchanges before using GAS. That same address is then used
529# during the GAS exchange as well to avoid breaking the protocol expectations.
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800530#gas_rand_mac_addr=0
531
532# Lifetime of GAS random MAC address in seconds (default: 60)
533#gas_rand_addr_lifetime=60
534
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800535# Interworking (IEEE 802.11u)
536
537# Enable Interworking
538# interworking=1
539
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700540# Enable P2P GO advertisement of Interworking
541# go_interworking=1
542
543# P2P GO Interworking: Access Network Type
544# 0 = Private network
545# 1 = Private network with guest access
546# 2 = Chargeable public network
547# 3 = Free public network
548# 4 = Personal device network
549# 5 = Emergency services only network
550# 14 = Test or experimental
551# 15 = Wildcard
552#go_access_network_type=0
553
554# P2P GO Interworking: Whether the network provides connectivity to the Internet
555# 0 = Unspecified
556# 1 = Network provides connectivity to the Internet
557#go_internet=1
558
559# P2P GO Interworking: Group Venue Info (optional)
560# The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
561# Example values (group,type):
562# 0,0 = Unspecified
563# 1,7 = Convention Center
564# 1,13 = Coffee Shop
565# 2,0 = Unspecified Business
566# 7,1 Private Residence
567#go_venue_group=7
568#go_venue_type=1
569
Hai Shalom60840252021-02-19 19:02:11 -0800570# Homogeneous ESS identifier
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800571# If this is set, scans will be used to request response only from BSSes
572# belonging to the specified Homogeneous ESS. This is used only if interworking
573# is enabled.
574# hessid=00:11:22:33:44:55
575
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700576# Automatic network selection behavior
577# 0 = do not automatically go through Interworking network selection
578# (i.e., require explicit interworking_select command for this; default)
579# 1 = perform Interworking network selection if one or more
580# credentials have been configured and scan did not find a
581# matching network block
582#auto_interworking=0
583
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700584# GAS Address3 field behavior
585# 0 = P2P specification (Address3 = AP BSSID); default
586# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
587# sent to not-associated AP; if associated, AP BSSID)
588#gas_address3=0
589
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700590# Publish fine timing measurement (FTM) responder functionality in
591# the Extended Capabilities element bit 70.
592# Controls whether FTM responder functionality will be published by AP/STA.
593# Note that actual FTM responder operation is managed outside wpa_supplicant.
594# 0 = Do not publish; default
595# 1 = Publish
596#ftm_responder=0
597
598# Publish fine timing measurement (FTM) initiator functionality in
599# the Extended Capabilities element bit 71.
600# Controls whether FTM initiator functionality will be published by AP/STA.
601# Note that actual FTM initiator operation is managed outside wpa_supplicant.
602# 0 = Do not publish; default
603# 1 = Publish
604#ftm_initiator=0
605
Dmitry Shmidt04949592012-07-19 12:16:46 -0700606# credential block
607#
608# Each credential used for automatic network selection is configured as a set
609# of parameters that are compared to the information advertised by the APs when
610# interworking_select and interworking_connect commands are used.
611#
612# credential fields:
613#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800614# temporary: Whether this credential is temporary and not to be saved
615#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700616# priority: Priority group
617# By default, all networks and credentials get the same priority group
618# (0). This field can be used to give higher priority for credentials
619# (and similarly in struct wpa_ssid for network blocks) to change the
620# Interworking automatic networking selection behavior. The matching
621# network (based on either an enabled network block or a credential)
622# with the highest priority value will be selected.
623#
624# pcsc: Use PC/SC and SIM/USIM card
625#
626# realm: Home Realm for Interworking
627#
628# username: Username for Interworking network selection
629#
630# password: Password for Interworking network selection
631#
632# ca_cert: CA certificate for Interworking network selection
633#
634# client_cert: File path to client certificate file (PEM/DER)
635# This field is used with Interworking networking selection for a case
636# where client certificate/private key is used for authentication
637# (EAP-TLS). Full path to the file should be used since working
638# directory may change when wpa_supplicant is run in the background.
639#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700640# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
641#
642# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
643#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700644# Alternatively, a named configuration blob can be used by setting
645# this to blob://blob_name.
646#
647# private_key: File path to client private key file (PEM/DER/PFX)
648# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
649# commented out. Both the private key and certificate will be read
650# from the PKCS#12 file in this case. Full path to the file should be
651# used since working directory may change when wpa_supplicant is run
652# in the background.
653#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700654# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
655# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
656#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700657# Windows certificate store can be used by leaving client_cert out and
658# configuring private_key in one of the following formats:
659#
660# cert://substring_to_match
661#
662# hash://certificate_thumbprint_in_hex
663#
664# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
665#
666# Note that when running wpa_supplicant as an application, the user
667# certificate store (My user account) is used, whereas computer store
668# (Computer account) is used when running wpasvc as a service.
669#
670# Alternatively, a named configuration blob can be used by setting
671# this to blob://blob_name.
672#
673# private_key_passwd: Password for private key file
674#
675# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
676#
677# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
678# format
679#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700680# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700681# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700682# whether the AP is operated by the Home SP. Multiple domain entries can
683# be used to configure alternative FQDNs that will be considered home
684# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700685#
Sunil Ravi77d572f2023-01-17 23:58:31 +0000686# home_ois: Home OI(s)
687# This string field contains one or more comma delimited OIs (hexdump)
688# identifying the access the access points that support authentication
689# with this credential. There are an alternative to the use of the realm
690# parameter. When using Home OIs to match the network, the EAP parameters
691# need to be pre-configured with the credentials since the NAI Realm
692# information may not be available or fetched.
693# A successful authentication with the access point is possible as soon
694# as at least one Home OI from the list matches an OI in the Roaming
695# Consortium advertised by the access point.
696# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOI)
697#
698# required_home_ois: Required Home OI(s)
699# This string field contains the set of Home OI(s) (hexdump) that are
700# required to be advertised by the AP for the credential to be considered
701# matching.
702# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOIRequired)
703#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700704# roaming_consortium: Roaming Consortium OI
Sunil Ravi77d572f2023-01-17 23:58:31 +0000705# Deprecated: use home_ois instead.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700706# If roaming_consortium_len is non-zero, this field contains the
707# Roaming Consortium OI that can be used to determine which access
708# points support authentication with this credential. This is an
709# alternative to the use of the realm parameter. When using Roaming
710# Consortium to match the network, the EAP parameters need to be
711# pre-configured with the credential since the NAI Realm information
712# may not be available or fetched.
713#
Roshan Pius3a1667e2018-07-03 15:17:14 -0700714# required_roaming_consortium: Required Roaming Consortium OI
Sunil Ravi77d572f2023-01-17 23:58:31 +0000715# Deprecated: use required_home_ois instead.
Roshan Pius3a1667e2018-07-03 15:17:14 -0700716# If required_roaming_consortium_len is non-zero, this field contains the
717# Roaming Consortium OI that is required to be advertised by the AP for
718# the credential to be considered matching.
719#
720# roaming_consortiums: Roaming Consortium OI(s) memberships
721# This string field contains one or more comma delimited OIs (hexdump)
722# identifying the roaming consortiums of which the provider is a member.
723# The list is sorted from the most preferred one to the least preferred
724# one. A match between the Roaming Consortium OIs advertised by an AP and
725# the OIs in this list indicates that successful authentication is
726# possible.
727# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
728#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700729# eap: Pre-configured EAP method
730# This optional field can be used to specify which EAP method will be
731# used with this credential. If not set, the EAP method is selected
732# automatically based on ANQP information (e.g., NAI Realm).
733#
734# phase1: Pre-configure Phase 1 (outer authentication) parameters
735# This optional field is used with like the 'eap' parameter.
736#
737# phase2: Pre-configure Phase 2 (inner authentication) parameters
738# This optional field is used with like the 'eap' parameter.
739#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800740# excluded_ssid: Excluded SSID
741# This optional field can be used to excluded specific SSID(s) from
742# matching with the network. Multiple entries can be used to specify more
743# than one SSID.
744#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800745# roaming_partner: Roaming partner information
746# This optional field can be used to configure preferences between roaming
747# partners. The field is a string in following format:
748# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
749# (non-exact match means any subdomain matches the entry; priority is in
750# 0..255 range with 0 being the highest priority)
751#
752# update_identifier: PPS MO ID
753# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
754#
755# provisioning_sp: FQDN of the SP that provisioned the credential
756# This optional field can be used to keep track of the SP that provisioned
757# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
758#
759# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
760# These fields can be used to specify minimum download/upload backhaul
761# bandwidth that is preferred for the credential. This constraint is
762# ignored if the AP does not advertise WAN Metrics information or if the
763# limit would prevent any connection. Values are in kilobits per second.
764# min_dl_bandwidth_home
765# min_ul_bandwidth_home
766# min_dl_bandwidth_roaming
767# min_ul_bandwidth_roaming
768#
769# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
770# (PPS/<X+>/Policy/MaximumBSSLoadValue)
771# This value is used as the maximum channel utilization for network
772# selection purposes for home networks. If the AP does not advertise
773# BSS Load or if the limit would prevent any connection, this constraint
774# will be ignored.
775#
776# req_conn_capab: Required connection capability
777# (PPS/<X+>/Policy/RequiredProtoPortTuple)
778# This value is used to configure set of required protocol/port pairs that
779# a roaming network shall support (include explicitly in Connection
780# Capability ANQP element). This constraint is ignored if the AP does not
781# advertise Connection Capability or if this constraint would prevent any
782# network connection. This policy is not used in home networks.
783# Format: <protocol>[:<comma-separated list of ports]
784# Multiple entries can be used to list multiple requirements.
785# For example, number of common TCP protocols:
786# req_conn_capab=6,22,80,443
787# For example, IPSec/IKE:
788# req_conn_capab=17:500
789# req_conn_capab=50
790#
791# ocsp: Whether to use/require OCSP to check server certificate
792# 0 = do not use OCSP stapling (TLS certificate status extension)
793# 1 = try to use OCSP stapling, but not require response
794# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800795# 3 = require valid OCSP stapling response for all not-trusted
796# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800797#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700798# sim_num: Identifier for which SIM to use in multi-SIM devices
799#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700800# for example:
801#
802#cred={
803# realm="example.com"
804# username="user@example.com"
805# password="password"
806# ca_cert="/etc/wpa_supplicant/ca.pem"
807# domain="example.com"
808#}
809#
810#cred={
811# imsi="310026-000000000"
812# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
813#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700814#
815#cred={
816# realm="example.com"
817# username="user"
818# password="password"
819# ca_cert="/etc/wpa_supplicant/ca.pem"
820# domain="example.com"
Sunil Ravi77d572f2023-01-17 23:58:31 +0000821# home_ois="223344"
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700822# eap=TTLS
823# phase2="auth=MSCHAPV2"
824#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800825
Dmitry Shmidt04949592012-07-19 12:16:46 -0700826# Hotspot 2.0
827# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800828
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800829# Scheduled scan plans
830#
831# A space delimited list of scan plans. Each scan plan specifies the scan
832# interval and number of iterations, delimited by a colon. The last scan plan
833# will run infinitely and thus must specify only the interval and not the number
834# of iterations.
835#
836# The driver advertises the maximum number of scan plans supported. If more scan
837# plans than supported are configured, only the first ones are set (up to the
838# maximum supported). The last scan plan that specifies only the interval is
839# always set as the last plan.
840#
841# If the scan interval or the number of iterations for a scan plan exceeds the
842# maximum supported, it will be set to the maximum supported value.
843#
844# Format:
845# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
846#
847# Example:
848# sched_scan_plans=10:100 20:200 30
849
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800850# Multi Band Operation (MBO) non-preferred channels
851# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700852# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800853# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700854# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800855# Example:
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700856# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800857
858# MBO Cellular Data Capabilities
859# 1 = Cellular data connection available
860# 2 = Cellular data connection not available
861# 3 = Not cellular capable (default)
862#mbo_cell_capa=3
863
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700864# Optimized Connectivity Experience (OCE)
865# oce: Enable OCE features (bitmap)
866# Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
867# does not indicate support for OCE in STA mode)
868# Set BIT(1) to Enable OCE in STA-CFON mode
869#oce=1
870
Hai Shalomfdcde762020-04-02 11:19:20 -0700871# Extended Key ID support for Individually Addressed frames
872# 0 = force off: Do not use Extended Key ID (default)
873# 1 = auto: Activate Extended Key ID support if the driver supports it
874#extended_key_id=0
875
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800876# network block
877#
878# Each network (usually AP's sharing the same SSID) is configured as a separate
879# block in this configuration file. The network blocks are in preference order
880# (the first match is used).
881#
882# network block fields:
883#
884# disabled:
885# 0 = this network can be used (default)
886# 1 = this network block is disabled (can be enabled through ctrl_iface,
887# e.g., with wpa_cli or wpa_gui)
888#
889# id_str: Network identifier string for external scripts. This value is passed
890# to external action script through wpa_cli as WPA_ID_STR environment
891# variable to make it easier to do network specific configuration.
892#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700893# ssid: SSID (mandatory); network name in one of the optional formats:
894# - an ASCII string with double quotation
895# - a hex string (two characters per octet of SSID)
896# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800897#
898# scan_ssid:
899# 0 = do not scan this SSID with specific Probe Request frames (default)
900# 1 = scan with SSID-specific Probe Request frames (this can be used to
901# find APs that do not accept broadcast SSID or use multiple SSIDs;
902# this will add latency to scanning, so enable this only when needed)
903#
904# bssid: BSSID (optional); if set, this network block is used only when
905# associating with the AP using the configured BSSID
906#
Hai Shalom899fcc72020-10-19 14:38:18 -0700907# ignore_broadcast_ssid: SSID broadcast behavior
908# Send empty SSID in beacons and ignore probe request frames that do not
909# specify full SSID, i.e., require stations to know SSID.
910# default: disabled (0)
911# 1 = send empty (length=0) SSID in beacon and ignore probe request for
912# broadcast SSID
913# 2 = clear SSID (ASCII 0), but keep the original length (this may be required
914# with some clients that do not support empty SSID) and ignore probe
915# requests for broadcast SSID
916#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800917# priority: priority group (integer)
918# By default, all networks will get same priority group (0). If some of the
919# networks are more desirable, this field can be used to change the order in
920# which wpa_supplicant goes through the networks when selecting a BSS. The
921# priority groups will be iterated in decreasing priority (i.e., the larger the
922# priority value, the sooner the network is matched against the scan results).
923# Within each priority group, networks will be selected based on security
924# policy, signal strength, etc.
925# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
926# using this priority to select the order for scanning. Instead, they try the
927# networks in the order that used in the configuration file.
928#
929# mode: IEEE 802.11 operation mode
930# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
931# 1 = IBSS (ad-hoc, peer-to-peer)
932# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800933# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
934# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
935# TKIP/CCMP) is available for backwards compatibility, but its use is
936# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800937# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
938# both), and psk must also be set.
939#
940# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
941# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
942# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
943# In addition, this value is only used by the station that creates the IBSS. If
944# an IBSS network with the configured SSID is already present, the frequency of
945# the network will be used instead of this configured value.
946#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800947# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700948# 0 = do not use PBSS
949# 1 = use PBSS
950# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800951# Used together with mode configuration. When mode is AP, it means to start a
952# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700953# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
954# which means connect to either PCP or AP.
955# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800956# For more details, see IEEE Std 802.11ad-2012.
957#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800958# scan_freq: List of frequencies to scan
959# Space-separated list of frequencies in MHz to scan when searching for this
960# BSS. If the subset of channels used by the network is known, this option can
961# be used to optimize scanning to not occur on channels that the network does
962# not use. Example: scan_freq=2412 2437 2462
963#
964# freq_list: Array of allowed frequencies
965# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
966# set, scan results that do not match any of the specified frequencies are not
967# considered when selecting a BSS.
968#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700969# This can also be set on the outside of the network block. In this case,
970# it limits the frequencies that will be scanned.
971#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800972# bgscan: Background scanning
973# wpa_supplicant behavior for background scanning can be specified by
974# configuring a bgscan module. These modules are responsible for requesting
975# background scans for the purpose of roaming within an ESS (i.e., within a
976# single network block with all the APs using the same SSID). The bgscan
977# parameter uses following format: "<bgscan module name>:<module parameters>"
978# Following bgscan modules are available:
979# simple - Periodic background scans based on signal strength
980# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
981# <long interval>"
982# bgscan="simple:30:-45:300"
983# learn - Learn channels used by the network and try to avoid bgscans on other
984# channels (experimental)
985# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
986# <long interval>[:<database file name>]"
987# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800988# Explicitly disable bgscan by setting
989# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800990#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800991# This option can also be set outside of all network blocks for the bgscan
992# parameter to apply for all the networks that have no specific bgscan
993# parameter.
994#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800995# proto: list of accepted protocols
996# WPA = WPA/IEEE 802.11i/D3.0
997# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
Hai Shalomce48b4a2018-09-05 11:41:35 -0700998# Note that RSN is used also for WPA3.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800999# If not set, this defaults to: WPA RSN
1000#
1001# key_mgmt: list of accepted authenticated key management protocols
1002# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
1003# WPA-EAP = WPA using EAP authentication
1004# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
1005# generated WEP keys
1006# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001007# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
1008# instead)
1009# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
1010# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Roshan Pius3a1667e2018-07-03 15:17:14 -07001011# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
1012# and using SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001013# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
1014# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001015# SAE = Simultaneous authentication of equals; pre-shared key/password -based
1016# authentication with stronger security than WPA-PSK especially when using
Hai Shalomce48b4a2018-09-05 11:41:35 -07001017# not that strong password; a.k.a. WPA3-Personal
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001018# FT-SAE = SAE with FT
1019# WPA-EAP-SUITE-B = Suite B 128-bit level
1020# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001021# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001022# FILS-SHA256 = Fast Initial Link Setup with SHA256
1023# FILS-SHA384 = Fast Initial Link Setup with SHA384
1024# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
1025# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Hai Shalomce48b4a2018-09-05 11:41:35 -07001026# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
1027# DPP = Device Provisioning Protocol
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001028# If not set, this defaults to: WPA-PSK WPA-EAP
1029#
Dmitry Shmidt04949592012-07-19 12:16:46 -07001030# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001031# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -07001032# 1 = optional
1033# 2 = required
1034# The most common configuration options for this based on the PMF (protected
1035# management frames) certification program are:
1036# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
1037# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001038# (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
1039# WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE
Dmitry Shmidt04949592012-07-19 12:16:46 -07001040#
Hai Shalom74f70d42019-02-11 14:42:39 -08001041# ocv: whether operating channel validation is enabled
Hai Shaloma20dcd72022-02-04 13:43:00 -08001042# This is a countermeasure against multi-channel on-path attacks.
Hai Shalom74f70d42019-02-11 14:42:39 -08001043# Enabling this automatically also enables ieee80211w, if not yet enabled.
1044# 0 = disabled (default)
Hai Shalom60840252021-02-19 19:02:11 -08001045# 1 = enabled if wpa_supplicant's SME in use. Otherwise enabled only when the
1046# driver indicates support for operating channel validation.
Hai Shalom74f70d42019-02-11 14:42:39 -08001047#ocv=1
1048#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001049# auth_alg: list of allowed IEEE 802.11 authentication algorithms
1050# OPEN = Open System authentication (required for WPA/WPA2)
1051# SHARED = Shared Key authentication (requires static WEP keys)
1052# LEAP = LEAP/Network EAP (only used with LEAP)
1053# If not set, automatic selection is used (Open System with LEAP enabled if
1054# LEAP is allowed as one of the EAP methods).
1055#
1056# pairwise: list of accepted pairwise (unicast) ciphers for WPA
1057# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1058# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1059# NONE = Use only Group Keys (deprecated, should not be included if APs support
1060# pairwise keys)
1061# If not set, this defaults to: CCMP TKIP
1062#
1063# group: list of accepted group (broadcast/multicast) ciphers for WPA
1064# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1065# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1066# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
1067# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
1068# If not set, this defaults to: CCMP TKIP WEP104 WEP40
1069#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001070# group_mgmt: list of accepted group management ciphers for RSN (PMF)
1071# AES-128-CMAC = BIP-CMAC-128
1072# BIP-GMAC-128
1073# BIP-GMAC-256
1074# BIP-CMAC-256
1075# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
1076# indicates.
1077#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001078# psk: WPA preshared key; 256-bit pre-shared key
1079# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
1080# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
1081# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001082# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
1083# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001084# This field is not needed, if WPA-EAP is used.
1085# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
1086# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
1087# startup and reconfiguration time can be optimized by generating the PSK only
1088# only when the passphrase or SSID has actually changed.
1089#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -07001090# mem_only_psk: Whether to keep PSK/passphrase only in memory
1091# 0 = allow psk/passphrase to be stored to the configuration file
1092# 1 = do not store psk/passphrase to the configuration file
1093#mem_only_psk=0
1094#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001095# sae_password: SAE password
1096# This parameter can be used to set a password for SAE. By default, the
Roshan Pius3a1667e2018-07-03 15:17:14 -07001097# passphrase from the psk parameter is used if this separate parameter is not
1098# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
1099# SAE passwords do not have such constraints.
1100#
1101# sae_password_id: SAE password identifier
1102# This parameter can be used to set an identifier for the SAE password. By
1103# default, no such identifier is used. If set, the specified identifier value
1104# is used by the other peer to select which password to use for authentication.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001105#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001106# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
1107# Dynamic WEP key required for non-WPA mode
1108# bit0 (1): require dynamically generated unicast WEP key
1109# bit1 (2): require dynamically generated broadcast WEP key
1110# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001111# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001112# eapol_flags must be set to 0 for the authentication to be completed
1113# successfully.
1114#
1115# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001116# This determines how sessions are secured with MACsec (only for MACsec
1117# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001118# 0: MACsec not in use (default)
1119# 1: MACsec enabled - Should secure, accept key server's advice to
1120# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001121#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001122# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1123# This setting applies only when MACsec is in use, i.e.,
1124# - macsec_policy is enabled
1125# - the key server has decided to enable MACsec
1126# 0: Encrypt traffic (default)
1127# 1: Integrity only
1128#
Hai Shalom74f70d42019-02-11 14:42:39 -08001129# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1130# This setting applies only when MACsec is in use, i.e.,
1131# - macsec_policy is enabled
1132# - the key server has decided to enable MACsec
1133# 0: Replay protection disabled (default)
1134# 1: Replay protection enabled
1135#
1136# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1137# This determines a window in which replay is tolerated, to allow receipt
1138# of frames that have been misordered by the network.
1139# This setting applies only when MACsec replay protection active, i.e.,
1140# - macsec_replay_protect is enabled
1141# - the key server has decided to enable MACsec
1142# 0: No replay window, strict check (default)
1143# 1..2^32-1: number of packets that could be misordered
1144#
Sunil Ravi036cec52023-03-29 11:35:17 -07001145# macsec_offload - Enable MACsec hardware offload
1146#
1147# This setting applies only when MACsec is in use, i.e.,
1148# - the key server has decided to enable MACsec
1149#
1150# 0 = MACSEC_OFFLOAD_OFF (default)
1151# 1 = MACSEC_OFFLOAD_PHY
1152# 2 = MACSEC_OFFLOAD_MAC
1153#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001154# macsec_port: IEEE 802.1X/MACsec port
1155# Port component of the SCI
1156# Range: 1-65534 (default: 1)
1157#
Dmitry Shmidt29333592017-01-09 12:27:11 -08001158# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001159# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -08001160# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1161# with lower priority will become the key server and start distributing SAKs.
Hai Shalom74f70d42019-02-11 14:42:39 -08001162# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1163# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1164# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1165# (2..64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -08001166# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1167# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001168#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001169# mixed_cell: This option can be used to configure whether so called mixed
1170# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001171# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001172# 0 = disabled (default)
1173# 1 = enabled
1174#
1175# proactive_key_caching:
1176# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001177# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001178# 1 = enabled
1179#
Hai Shalom81f62d82019-07-22 12:10:00 -07001180# ft_eap_pmksa_caching:
1181# Whether FT-EAP PMKSA caching is allowed
1182# 0 = do not try to use PMKSA caching with FT-EAP (default)
1183# 1 = try to use PMKSA caching with FT-EAP
1184# This controls whether to try to use PMKSA caching with FT-EAP for the
1185# FT initial mobility domain association.
1186#ft_eap_pmksa_caching=0
1187#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001188# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1189# hex without quotation, e.g., 0102030405)
1190# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1191#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001192# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1193# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1194#
Hai Shalomfdcde762020-04-02 11:19:20 -07001195# wpa_deny_ptk0_rekey: Workaround for PTK rekey issues
1196# PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the
1197# security and stability with some cards.
1198# To avoid the issues wpa_supplicant can replace those PTK rekeys (including
1199# EAP reauthentications) with fast reconnects.
1200#
1201# Available options:
1202# 0 = always rekey when configured/instructed (default)
1203# 1 = only rekey when the local driver is explicitly indicating it can perform
1204# this operation without issues
1205# 2 = never allow problematic PTK0 rekeys
1206#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001207# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1208# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -08001209# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001210#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001211# Following fields are only used with internal EAP implementation.
1212# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001213# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001214# cannot be used with WPA; to be used as a Phase 2 method
1215# with EAP-PEAP or EAP-TTLS)
1216# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1217# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1218# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1219# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1220# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1221# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1222# TLS = EAP-TLS (client and server certificate)
1223# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1224# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1225# authentication)
1226# If not set, all compiled in methods are allowed.
1227#
1228# identity: Identity string for EAP
1229# This field is also used to configure user NAI for
1230# EAP-PSK/PAX/SAKE/GPSK.
1231# anonymous_identity: Anonymous identity string for EAP (to be used as the
1232# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07001233# identity, e.g., EAP-TTLS). This field can also be used with
1234# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Steven Liu9138d432022-11-23 22:29:05 +00001235# strict_conservative_peer_mode: Whether the strict conservative peer mode
1236# is enabled. This field is used to handle the reponse of AT_PERMANENT_ID_REQ
1237# for EAP-SIM/AKA/AKA'. In non-strict convervative peer mode, a client
1238# error would be sent to the server, but the mode will send the permanent
1239# identity in some special cases according to 4.6.2 of RFC 4187; With the
1240# strict mode, the permanent identity is never sent to the server.
1241# 0 = disabled (default)
1242# 1 = enabled
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001243# password: Password string for EAP. This field can include either the
1244# plaintext password (using ASCII or hex string) or a NtPasswordHash
1245# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1246# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1247# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1248# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1249# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001250# variable length PSK. ext:<name of external password field> format can
1251# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001252# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1253# or more trusted CA certificates. If ca_cert and ca_path are not
1254# included, server certificate will not be verified. This is insecure and
1255# a trusted CA certificate should always be configured when using
1256# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1257# change when wpa_supplicant is run in the background.
1258#
1259# Alternatively, this can be used to only perform matching of the server
1260# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1261# this case, the possible CA certificates in the server certificate chain
1262# are ignored and only the server certificate is verified. This is
1263# configured with the following format:
1264# hash:://server/sha256/cert_hash_in_hex
1265# For example: "hash://server/sha256/
1266# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1267#
1268# On Windows, trusted CA certificates can be loaded from the system
1269# certificate store by setting this to cert_store://<name>, e.g.,
1270# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1271# Note that when running wpa_supplicant as an application, the user
1272# certificate store (My user account) is used, whereas computer store
1273# (Computer account) is used when running wpasvc as a service.
1274# ca_path: Directory path for CA certificate files (PEM). This path may
1275# contain multiple CA certificates in OpenSSL format. Common use for this
1276# is to point to system trusted CA list which is often installed into
1277# directory like /etc/ssl/certs. If configured, these certificates are
1278# added to the list of trusted CAs. ca_cert may also be included in that
1279# case, but it is not required.
1280# client_cert: File path to client certificate file (PEM/DER)
1281# Full path should be used since working directory may change when
1282# wpa_supplicant is run in the background.
1283# Alternatively, a named configuration blob can be used by setting this
1284# to blob://<blob name>.
1285# private_key: File path to client private key file (PEM/DER/PFX)
1286# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1287# commented out. Both the private key and certificate will be read from
1288# the PKCS#12 file in this case. Full path should be used since working
1289# directory may change when wpa_supplicant is run in the background.
1290# Windows certificate store can be used by leaving client_cert out and
1291# configuring private_key in one of the following formats:
1292# cert://substring_to_match
1293# hash://certificate_thumbprint_in_hex
1294# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1295# Note that when running wpa_supplicant as an application, the user
1296# certificate store (My user account) is used, whereas computer store
1297# (Computer account) is used when running wpasvc as a service.
1298# Alternatively, a named configuration blob can be used by setting this
1299# to blob://<blob name>.
1300# private_key_passwd: Password for private key file (if left out, this will be
1301# asked through control interface)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001302# subject_match: Substring to be matched against the subject of the
1303# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001304# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001305# The subject string is in following format:
1306# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001307# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001308# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001309# such a use case, domain_suffix_match or domain_match should be used
1310# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001311# altsubject_match: Semicolon separated string of entries to be matched against
1312# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001313# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001314# contains one of the entries in an alternative subject name extension.
1315# altSubjectName string is in following format: TYPE:VALUE
1316# Example: EMAIL:server@example.com
1317# Example: DNS:server.example.com;DNS:server2.example.com
1318# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001319# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001320# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001321# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1322# constraint is met. If no dNSName values are present, this constraint is
1323# matched against SubjectName CN using same suffix match comparison.
1324#
1325# Suffix match here means that the host/domain name is compared one label
1326# at a time starting from the top-level domain and all the labels in
1327# domain_suffix_match shall be included in the certificate. The
1328# certificate may include additional sub-level labels in addition to the
1329# required labels.
1330#
Hai Shalom021b0b52019-04-10 11:17:58 -07001331# More than one match string can be provided by using semicolons to
1332# separate the strings (e.g., example.org;example.com). When multiple
1333# strings are specified, a match with any one of the values is considered
1334# a sufficient match for the certificate, i.e., the conditions are ORed
1335# together.
1336#
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001337# For example, domain_suffix_match=example.com would match
1338# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001339# domain_match: Constraint for server domain name
1340# If set, this FQDN is used as a full match requirement for the
1341# server certificate in SubjectAltName dNSName element(s). If a
1342# matching dNSName is found, this constraint is met. If no dNSName
1343# values are present, this constraint is matched against SubjectName CN
1344# using same full match comparison. This behavior is similar to
1345# domain_suffix_match, but has the requirement of a full match, i.e.,
1346# no subdomains or wildcard matches are allowed. Case-insensitive
1347# comparison is used, so "Example.com" matches "example.com", but would
1348# not match "test.Example.com".
Hai Shalom021b0b52019-04-10 11:17:58 -07001349#
1350# More than one match string can be provided by using semicolons to
1351# separate the strings (e.g., example.org;example.com). When multiple
1352# strings are specified, a match with any one of the values is considered
1353# a sufficient match for the certificate, i.e., the conditions are ORed
1354# together.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001355# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1356# (string with field-value pairs, e.g., "peapver=0" or
1357# "peapver=1 peaplabel=1")
1358# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1359# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1360# to be used during key derivation when PEAPv1 or newer. Most existing
1361# PEAPv1 implementation seem to be using the old label, "client EAP
1362# encryption", and wpa_supplicant is now using that as the default value.
1363# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1364# interoperate with PEAPv1; see eap_testing.txt for more details.
1365# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1366# tunneled EAP-Success. This is required with some RADIUS servers that
1367# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1368# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1369# include_tls_length=1 can be used to force wpa_supplicant to include
1370# TLS Message Length field in all TLS messages even if they are not
1371# fragmented.
1372# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1373# challenges (by default, it accepts 2 or 3)
1374# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1375# protected result indication.
1376# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1377# behavior:
1378# * 0 = do not use cryptobinding (default)
1379# * 1 = use cryptobinding if server supports it
1380# * 2 = require cryptobinding
Jouni Malinenab31d322023-07-08 19:55:32 +03001381# 'phase2_auth' option can be used to control Phase 2 (i.e., within TLS
1382# tunnel) behavior for PEAP:
1383# * 0 = do not require Phase 2 authentication
1384# * 1 = require Phase 2 authentication when client certificate
1385# (private_key/client_cert) is not used and TLS session resumption was
1386# not used (default)
1387# * 2 = require Phase 2 authentication in all cases
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001388# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1389# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001390#
1391# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1392# used to configure a mode that allows EAP-Success (and EAP-Failure)
1393# without going through authentication step. Some switches use such
1394# sequence when forcing the port to be authorized/unauthorized or as a
1395# fallback option if the authentication server is unreachable. By default,
1396# wpa_supplicant discards such frames to protect against potential attacks
1397# by rogue devices, but this option can be used to disable that protection
1398# for cases where the server/authenticator does not need to be
1399# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001400# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1401# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001402# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1403# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001404#
1405# TLS-based methods can use the following parameters to control TLS behavior
1406# (these are normally in the phase1 parameter, but can be used also in the
1407# phase2 parameter when EAP-TLS is used within the inner tunnel):
1408# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1409# TLS library, these may be disabled by default to enforce stronger
1410# security)
1411# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1412# the TLS library to accept certificates even if they are not currently
1413# valid, i.e., have expired or have not yet become valid; this should be
1414# used only for testing purposes)
1415# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1416# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1417# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1418# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001419# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001420# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1421# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001422# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Hai Shalom74f70d42019-02-11 14:42:39 -08001423# tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1424# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001425# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1426# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001427# tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1428# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001429# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1430# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001431# tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1432# systemwide TLS policies to be overridden)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001433# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1434# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001435# tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001436# tls_ext_cert_check=0 - No external server certificate validation (default)
1437# tls_ext_cert_check=1 - External server certificate validation enabled; this
1438# requires an external program doing validation of server certificate
1439# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1440# interface and report the result of the validation with
1441# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001442# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1443# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1444# particular when using Suite B with RSA keys of >= 3K (3072) bits
Sunil Ravia04bd252022-05-02 22:54:18 -07001445# allow_unsafe_renegotiation=1 - allow connection with a TLS server that does
1446# not support safe renegotiation (RFC 5746); please note that this
1447# workaround should be only when having to authenticate with an old
1448# authentication server that cannot be updated to use secure TLS
1449# implementation.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001450#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001451# Following certificate/private key fields are used in inner Phase2
1452# authentication when using EAP-TTLS or EAP-PEAP.
1453# ca_cert2: File path to CA certificate file. This file can have one or more
1454# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1455# server certificate will not be verified. This is insecure and a trusted
1456# CA certificate should always be configured.
1457# ca_path2: Directory path for CA certificate files (PEM)
1458# client_cert2: File path to client certificate file
1459# private_key2: File path to client private key file
1460# private_key2_passwd: Password for private key file
1461# dh_file2: File path to DH/DSA parameters file (in PEM format)
1462# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001463# authentication server certificate. See subject_match for more details.
1464# altsubject_match2: Semicolon separated string of entries to be matched
1465# against the alternative subject name of the authentication server
1466# certificate. See altsubject_match documentation for more details.
1467# domain_suffix_match2: Constraint for server domain name. See
1468# domain_suffix_match for more details.
Hai Shalomc3565922019-10-28 11:58:20 -07001469# ocsp2: See ocsp for more details.
1470#
1471# Separate machine credentials can be configured for EAP-TEAP Phase 2 with
1472# "machine_" prefix (e.g., "machine_identity") in the configuration parameters.
1473# See the parameters without that prefix for more details on the meaning and
1474# format of each such parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001475#
1476# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1477# This value limits the fragment size for EAP methods that support
1478# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1479# small enough to make the EAP messages fit in MTU of the network
1480# interface used for EAPOL. The default value is suitable for most
1481# cases.
1482#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001483# ocsp: Whether to use/require OCSP to check server certificate
1484# 0 = do not use OCSP stapling (TLS certificate status extension)
1485# 1 = try to use OCSP stapling, but not require response
1486# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001487# 3 = require valid OCSP stapling response for all not-trusted
1488# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001489#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001490# openssl_ciphers: OpenSSL specific cipher configuration
1491# This can be used to override the global openssl_ciphers configuration
1492# parameter (see above).
1493#
1494# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1495#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001496# EAP-FAST variables:
1497# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1498# to create this file and write updates to it when PAC is being
1499# provisioned or refreshed. Full path to the file should be used since
1500# working directory may change when wpa_supplicant is run in the
1501# background. Alternatively, a named configuration blob can be used by
1502# setting this to blob://<blob name>
1503# phase1: fast_provisioning option can be used to enable in-line provisioning
1504# of EAP-FAST credentials (PAC):
1505# 0 = disabled,
1506# 1 = allow unauthenticated provisioning,
1507# 2 = allow authenticated provisioning,
1508# 3 = allow both unauthenticated and authenticated provisioning
1509# fast_max_pac_list_len=<num> option can be used to set the maximum
1510# number of PAC entries to store in a PAC list (default: 10)
1511# fast_pac_format=binary option can be used to select binary format for
1512# storing PAC entries in order to save some space (the default
1513# text format uses about 2.5 times the size of minimal binary
1514# format)
1515#
1516# wpa_supplicant supports number of "EAP workarounds" to work around
1517# interoperability issues with incorrectly behaving authentication servers.
1518# These are enabled by default because some of the issues are present in large
1519# number of authentication servers. Strict EAP conformance mode can be
1520# configured by disabling workarounds with eap_workaround=0.
1521
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001522# update_identifier: PPS MO ID
1523# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001524#
1525# roaming_consortium_selection: Roaming Consortium Selection
1526# The matching Roaming Consortium OI that was used to generate this
1527# network profile.
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001528
Dmitry Shmidt04949592012-07-19 12:16:46 -07001529# Station inactivity limit
1530#
1531# If a station does not send anything in ap_max_inactivity seconds, an
1532# empty data frame is sent to it in order to verify whether it is
1533# still in range. If this frame is not ACKed, the station will be
1534# disassociated and then deauthenticated. This feature is used to
1535# clear station table of old entries when the STAs move out of the
1536# range.
1537#
1538# The station can associate again with the AP if it is still in range;
1539# this inactivity poll is just used as a nicer way of verifying
1540# inactivity; i.e., client will not report broken connection because
1541# disassociation frame is not sent immediately without first polling
1542# the STA with a data frame.
1543# default: 300 (i.e., 5 minutes)
1544#ap_max_inactivity=300
1545
1546# DTIM period in Beacon intervals for AP mode (default: 2)
1547#dtim_period=2
1548
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001549# Beacon interval (default: 100 TU)
1550#beacon_int=100
1551
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001552# WPS in AP mode
1553# 0 = WPS enabled and configured (default)
1554# 1 = WPS disabled
1555#wps_disabled=0
1556
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001557# FILS DH Group
1558# 0 = PFS disabled with FILS shared key authentication (default)
1559# 1-65535 = DH Group to use for FILS PFS
1560#fils_dh_group=0
1561
Hai Shalomfdcde762020-04-02 11:19:20 -07001562# DPP PFS
1563# 0: allow PFS to be used or not used (default)
1564# 1: require PFS to be used (note: not compatible with DPP R1)
1565# 2: do not allow PFS to be used
1566#dpp_pfs=0
1567
Sunil Ravi89eba102022-09-13 21:04:37 -07001568# DPP Network introduction type
1569# 0: unprotected variant from DPP R1 (default)
1570# 1: privacy protecting (station Connector encrypted) variant from
1571# DPP R3
1572#dpp_connector_privacy=0
1573
Hai Shalom60840252021-02-19 19:02:11 -08001574# Whether beacon protection is enabled
1575# This depends on management frame protection (ieee80211w) being enabled and
1576# beacon protection support indication from the driver.
1577# 0 = disabled (default)
1578# 1 = enabled
Hai Shalom899fcc72020-10-19 14:38:18 -07001579#beacon_prot=0
1580
1581# OWE DH Group
1582# 0: use default (19) first and then try all supported groups one by one if AP
1583# rejects the selected group
1584# 1-65535: DH Group to use for OWE
1585# Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
1586# currently supported.
1587#owe_group=0
1588
1589# OWE-only mode (disable transition mode)
1590# 0: enable transition mode (allow connection to either OWE or open BSS)
1591# 1 = disable transition mode (allow connection only with OWE)
1592#owe_only=0
1593
1594# OWE PTK derivation workaround
1595# Initial OWE implementation used SHA256 when deriving the PTK for all
1596# OWE groups. This was supposed to change to SHA384 for group 20 and
1597# SHA512 for group 21. This parameter can be used to enable older
1598# behavior mainly for testing purposes. There is no impact to group 19
1599# behavior, but if enabled, this will make group 20 and 21 cases use
1600# SHA256-based PTK derivation which will not work with the updated
1601# OWE implementation on the AP side.
1602#owe_ptk_workaround=0
1603
1604# Transition Disable indication
1605# The AP can notify authenticated stations to disable transition mode
1606# in their network profiles when the network has completed transition
1607# steps, i.e., once sufficiently large number of APs in the ESS have
1608# been updated to support the more secure alternative. When this
1609# indication is used, the stations are expected to automatically
1610# disable transition mode and less secure security options. This
1611# includes use of WEP, TKIP (including use of TKIP as the group
1612# cipher), and connections without PMF.
1613# Bitmap bits:
1614# bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK
1615# and only allow SAE to be used)
1616# bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
1617# bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
1618# bit 3 (0x08): Enhanced Open (disable use of open network; require
1619# OWE)
1620
1621# SAE-PK mode
1622# 0: automatic SAE/SAE-PK selection based on password; enable
1623# transition mode (allow SAE authentication without SAE-PK)
1624# 1: SAE-PK only (disable transition mode; allow SAE authentication
1625# only with SAE-PK)
1626# 2: disable SAE-PK (allow SAE authentication only without SAE-PK)
1627#sae_pk=0
1628
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001629# MAC address policy
1630# 0 = use permanent MAC address
1631# 1 = use random MAC address for each ESS connection
1632# 2 = like 1, but maintain OUI (with local admin bit set)
1633#mac_addr=0
1634
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001635# disable_ht: Whether HT (802.11n) should be disabled.
1636# 0 = HT enabled (if AP supports it)
1637# 1 = HT disabled
1638#
1639# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1640# 0 = HT-40 enabled (if AP supports it)
1641# 1 = HT-40 disabled
1642#
1643# disable_sgi: Whether SGI (short guard interval) should be disabled.
1644# 0 = SGI enabled (if AP supports it)
1645# 1 = SGI disabled
1646#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001647# disable_ldpc: Whether LDPC should be disabled.
1648# 0 = LDPC enabled (if AP supports it)
1649# 1 = LDPC disabled
1650#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001651# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1652# 0 = 40 MHz tolerant (default)
1653# 1 = 40 MHz intolerant
1654#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001655# ht_mcs: Configure allowed MCS rates.
1656# Parsed as an array of bytes, in base-16 (ascii-hex)
1657# ht_mcs="" // Use all available (default)
1658# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1659# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1660#
1661# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1662# -1 = Do not make any changes.
1663# 0 = Enable MAX-AMSDU if hardware supports it.
1664# 1 = Disable AMSDU
1665#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001666# ampdu_factor: Maximum A-MPDU Length Exponent
1667# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1668#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001669# ampdu_density: Allow overriding AMPDU density configuration.
1670# Treated as hint by the kernel.
1671# -1 = Do not make any changes.
1672# 0-3 = Set AMPDU density (aka factor) to specified value.
Hai Shalom74f70d42019-02-11 14:42:39 -08001673#
1674# tx_stbc: Allow overriding STBC support for TX streams
1675# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1676# -1 = Do not make any changes (default)
1677# 0 = Set if not supported
1678# 1 = Set if supported
1679#
1680# rx_stbc: Allow overriding STBC support for RX streams
1681# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1682# -1 = Do not make any changes (default)
1683# 0 = Set if not supported
1684# 1 = Set for support of one spatial stream
1685# 2 = Set for support of one and two spatial streams
1686# 3 = Set for support of one, two and three spatial streams
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001687
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001688# disable_vht: Whether VHT should be disabled.
1689# 0 = VHT enabled (if AP supports it)
1690# 1 = VHT disabled
1691#
1692# vht_capa: VHT capabilities to set in the override
1693# vht_capa_mask: mask of VHT capabilities
1694#
1695# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1696# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1697# 0: MCS 0-7
1698# 1: MCS 0-8
1699# 2: MCS 0-9
1700# 3: not supported
1701
Sunil Ravi77d572f2023-01-17 23:58:31 +00001702# disable_eht: Whether EHT should be disabled.
1703# 0 = EHT enabled (if supported) (default)
1704# 1 = EHT disabled
1705
Hai Shalom74f70d42019-02-11 14:42:39 -08001706# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1707# 0 = normal STA (default)
1708# 1 = backhaul STA
1709# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1710# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1711# added to a bridge to allow forwarding frames over this backhaul link.
1712
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001713##### Fast Session Transfer (FST) support #####################################
1714#
1715# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001716# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1717# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001718#
1719# FST is the transfer of a session from a channel to another channel, in the
1720# same or different frequency bands.
1721#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001722# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001723
1724# Identifier of an FST Group the interface belongs to.
1725#fst_group_id=bond0
1726
1727# Interface priority within the FST Group.
1728# Announcing a higher priority for an interface means declaring it more
1729# preferable for FST switch.
1730# fst_priority is in 1..255 range with 1 being the lowest priority.
1731#fst_priority=100
1732
1733# Default LLT value for this interface in milliseconds. The value used in case
1734# no value provided during session setup. Default is 50 msec.
1735# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1736# Transitioning between states).
1737#fst_llt=100
1738
Hai Shalom81f62d82019-07-22 12:10:00 -07001739# BSS Transition Management
1740# disable_btm - Disable BSS transition management in STA
1741# Set to 0 to enable BSS transition management (default behavior)
1742# Set to 1 to disable BSS transition management
1743#disable_btm=0
1744
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001745# This value is used to set where to perform roaming logic
1746# Set to 0 to handle roaming logic fully in supplicant
1747# Set to 1 to skip roaming logic in supplicant and handle it in firmware
1748# In supplicant, just parse BTM frame and notify framework
1749#btm_offload=0
1750
Hai Shalomc3565922019-10-28 11:58:20 -07001751# Enable EDMG capability in STA/AP mode, default value is false
1752#enable_edmg=1
1753
1754# This value is used to configure the channel bonding feature.
1755# Default value is 0.
1756# Relevant only if enable_edmg is true
1757# In AP mode it defines the EDMG channel to use for AP operation.
1758# In STA mode it defines the EDMG channel for connection (if supported by AP).
1759#edmg_channel=9
1760
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001761# Example blocks:
1762
1763# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1764network={
1765 ssid="simple"
1766 psk="very secret passphrase"
1767 priority=5
1768}
1769
1770# Same as previous, but request SSID-specific scanning (for APs that reject
1771# broadcast SSID)
1772network={
1773 ssid="second ssid"
1774 scan_ssid=1
1775 psk="very secret passphrase"
1776 priority=2
1777}
1778
1779# Only WPA-PSK is used. Any valid cipher combination is accepted.
1780network={
1781 ssid="example"
1782 proto=WPA
1783 key_mgmt=WPA-PSK
1784 pairwise=CCMP TKIP
1785 group=CCMP TKIP WEP104 WEP40
1786 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1787 priority=2
1788}
1789
1790# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1791network={
1792 ssid="example"
1793 proto=WPA
1794 key_mgmt=WPA-PSK
1795 pairwise=TKIP
1796 group=TKIP
1797 psk="not so secure passphrase"
1798 wpa_ptk_rekey=600
1799}
1800
1801# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1802# or WEP40 as the group cipher will not be accepted.
1803network={
1804 ssid="example"
1805 proto=RSN
1806 key_mgmt=WPA-EAP
1807 pairwise=CCMP TKIP
1808 group=CCMP TKIP
1809 eap=TLS
1810 identity="user@example.com"
1811 ca_cert="/etc/cert/ca.pem"
1812 client_cert="/etc/cert/user.pem"
1813 private_key="/etc/cert/user.prv"
1814 private_key_passwd="password"
1815 priority=1
1816}
1817
1818# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1819# (e.g., Radiator)
1820network={
1821 ssid="example"
1822 key_mgmt=WPA-EAP
1823 eap=PEAP
1824 identity="user@example.com"
1825 password="foobar"
1826 ca_cert="/etc/cert/ca.pem"
1827 phase1="peaplabel=1"
1828 phase2="auth=MSCHAPV2"
1829 priority=10
1830}
1831
1832# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1833# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1834network={
1835 ssid="example"
1836 key_mgmt=WPA-EAP
1837 eap=TTLS
1838 identity="user@example.com"
1839 anonymous_identity="anonymous@example.com"
1840 password="foobar"
1841 ca_cert="/etc/cert/ca.pem"
1842 priority=2
1843}
1844
1845# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1846# use. Real identity is sent only within an encrypted TLS tunnel.
1847network={
1848 ssid="example"
1849 key_mgmt=WPA-EAP
1850 eap=TTLS
1851 identity="user@example.com"
1852 anonymous_identity="anonymous@example.com"
1853 password="foobar"
1854 ca_cert="/etc/cert/ca.pem"
1855 phase2="auth=MSCHAPV2"
1856}
1857
1858# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1859# authentication.
1860network={
1861 ssid="example"
1862 key_mgmt=WPA-EAP
1863 eap=TTLS
1864 # Phase1 / outer authentication
1865 anonymous_identity="anonymous@example.com"
1866 ca_cert="/etc/cert/ca.pem"
1867 # Phase 2 / inner authentication
1868 phase2="autheap=TLS"
1869 ca_cert2="/etc/cert/ca2.pem"
1870 client_cert2="/etc/cer/user.pem"
1871 private_key2="/etc/cer/user.prv"
1872 private_key2_passwd="password"
1873 priority=2
1874}
1875
1876# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1877# group cipher.
1878network={
1879 ssid="example"
1880 bssid=00:11:22:33:44:55
1881 proto=WPA RSN
1882 key_mgmt=WPA-PSK WPA-EAP
1883 pairwise=CCMP
1884 group=CCMP
1885 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1886}
1887
1888# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1889# and all valid ciphers.
1890network={
1891 ssid=00010203
1892 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1893}
1894
1895
1896# EAP-SIM with a GSM SIM or USIM
1897network={
1898 ssid="eap-sim-test"
1899 key_mgmt=WPA-EAP
1900 eap=SIM
1901 pin="1234"
1902 pcsc=""
1903}
1904
1905
1906# EAP-PSK
1907network={
1908 ssid="eap-psk-test"
1909 key_mgmt=WPA-EAP
1910 eap=PSK
1911 anonymous_identity="eap_psk_user"
1912 password=06b4be19da289f475aa46a33cb793029
1913 identity="eap_psk_user@example.com"
1914}
1915
1916
1917# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1918# EAP-TLS for authentication and key generation; require both unicast and
1919# broadcast WEP keys.
1920network={
1921 ssid="1x-test"
1922 key_mgmt=IEEE8021X
1923 eap=TLS
1924 identity="user@example.com"
1925 ca_cert="/etc/cert/ca.pem"
1926 client_cert="/etc/cert/user.pem"
1927 private_key="/etc/cert/user.prv"
1928 private_key_passwd="password"
1929 eapol_flags=3
1930}
1931
1932
1933# LEAP with dynamic WEP keys
1934network={
1935 ssid="leap-example"
1936 key_mgmt=IEEE8021X
1937 eap=LEAP
1938 identity="user"
1939 password="foobar"
1940}
1941
1942# EAP-IKEv2 using shared secrets for both server and peer authentication
1943network={
1944 ssid="ikev2-example"
1945 key_mgmt=WPA-EAP
1946 eap=IKEV2
1947 identity="user"
1948 password="foobar"
1949}
1950
1951# EAP-FAST with WPA (WPA or WPA2)
1952network={
1953 ssid="eap-fast-test"
1954 key_mgmt=WPA-EAP
1955 eap=FAST
1956 anonymous_identity="FAST-000102030405"
1957 identity="username"
1958 password="password"
1959 phase1="fast_provisioning=1"
1960 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1961}
1962
1963network={
1964 ssid="eap-fast-test"
1965 key_mgmt=WPA-EAP
1966 eap=FAST
1967 anonymous_identity="FAST-000102030405"
1968 identity="username"
1969 password="password"
1970 phase1="fast_provisioning=1"
1971 pac_file="blob://eap-fast-pac"
1972}
1973
1974# Plaintext connection (no WPA, no IEEE 802.1X)
1975network={
1976 ssid="plaintext-test"
1977 key_mgmt=NONE
1978}
1979
1980
1981# Shared WEP key connection (no WPA, no IEEE 802.1X)
1982network={
1983 ssid="static-wep-test"
1984 key_mgmt=NONE
1985 wep_key0="abcde"
1986 wep_key1=0102030405
1987 wep_key2="1234567890123"
1988 wep_tx_keyidx=0
1989 priority=5
1990}
1991
1992
1993# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1994# IEEE 802.11 authentication
1995network={
1996 ssid="static-wep-test2"
1997 key_mgmt=NONE
1998 wep_key0="abcde"
1999 wep_key1=0102030405
2000 wep_key2="1234567890123"
2001 wep_tx_keyidx=0
2002 priority=5
2003 auth_alg=SHARED
2004}
2005
2006
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002007# IBSS/ad-hoc network with RSN
2008network={
2009 ssid="ibss-rsn"
2010 key_mgmt=WPA-PSK
2011 proto=RSN
2012 psk="12345678"
2013 mode=1
2014 frequency=2412
2015 pairwise=CCMP
2016 group=CCMP
2017}
2018
2019# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002020network={
2021 ssid="test adhoc"
2022 mode=1
2023 frequency=2412
2024 proto=WPA
2025 key_mgmt=WPA-NONE
2026 pairwise=NONE
2027 group=TKIP
2028 psk="secret passphrase"
2029}
2030
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002031# open mesh network
2032network={
2033 ssid="test mesh"
2034 mode=5
2035 frequency=2437
2036 key_mgmt=NONE
2037}
2038
2039# secure (SAE + AMPE) network
2040network={
2041 ssid="secure mesh"
2042 mode=5
2043 frequency=2437
2044 key_mgmt=SAE
2045 psk="very secret passphrase"
2046}
2047
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002048
2049# Catch all example that allows more or less all configuration modes
2050network={
2051 ssid="example"
2052 scan_ssid=1
2053 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
2054 pairwise=CCMP TKIP
2055 group=CCMP TKIP WEP104 WEP40
2056 psk="very secret passphrase"
2057 eap=TTLS PEAP TLS
2058 identity="user@example.com"
2059 password="foobar"
2060 ca_cert="/etc/cert/ca.pem"
2061 client_cert="/etc/cert/user.pem"
2062 private_key="/etc/cert/user.prv"
2063 private_key_passwd="password"
2064 phase1="peaplabel=0"
2065}
2066
2067# Example of EAP-TLS with smartcard (openssl engine)
2068network={
2069 ssid="example"
2070 key_mgmt=WPA-EAP
2071 eap=TLS
2072 proto=RSN
2073 pairwise=CCMP TKIP
2074 group=CCMP TKIP
2075 identity="user@example.com"
2076 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002077
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07002078 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
2079 client_cert="pkcs11:manufacturer=piv_II;id=%01"
2080 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08002081
2082 # Optional PIN configuration; this can be left out and PIN will be
2083 # asked through the control interface
2084 pin="1234"
2085}
2086
2087# Example configuration showing how to use an inlined blob as a CA certificate
2088# data instead of using external file
2089network={
2090 ssid="example"
2091 key_mgmt=WPA-EAP
2092 eap=TTLS
2093 identity="user@example.com"
2094 anonymous_identity="anonymous@example.com"
2095 password="foobar"
2096 ca_cert="blob://exampleblob"
2097 priority=20
2098}
2099
2100blob-base64-exampleblob={
2101SGVsbG8gV29ybGQhCg==
2102}
2103
2104
2105# Wildcard match for SSID (plaintext APs only). This example select any
2106# open AP regardless of its SSID.
2107network={
2108 key_mgmt=NONE
2109}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002110
Hai Shalom60840252021-02-19 19:02:11 -08002111# Example configuration ignoring two APs - these will be ignored
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002112# for this network.
2113network={
2114 ssid="example"
2115 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002116 bssid_ignore=02:11:22:33:44:55 02:22:aa:44:55:66
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002117}
2118
2119# Example configuration limiting AP selection to a specific set of APs;
2120# any other AP not matching the masked address will be ignored.
2121network={
2122 ssid="example"
2123 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002124 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 -08002125}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002126
2127# Example config file that will only scan on channel 36.
2128freq_list=5180
2129network={
2130 key_mgmt=NONE
2131}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002132
2133
Roshan Pius3a1667e2018-07-03 15:17:14 -07002134# Example configuration using EAP-TTLS for authentication and key
2135# generation for MACsec
2136network={
2137 key_mgmt=IEEE8021X
2138 eap=TTLS
2139 phase2="auth=PAP"
2140 anonymous_identity="anonymous@example.com"
2141 identity="user@example.com"
2142 password="secretr"
2143 ca_cert="/etc/cert/ca.pem"
2144 eapol_flags=0
2145 macsec_policy=1
2146}
2147
2148# Example configuration for MACsec with preshared key
2149network={
2150 key_mgmt=NONE
2151 eapol_flags=0
2152 macsec_policy=1
2153 mka_cak=0123456789ABCDEF0123456789ABCDEF
2154 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
2155 mka_priority=128
2156}