]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/wpa_supplicant.conf
Add attribute for dwell time in QCA vendor scan
[thirdparty/hostap.git] / wpa_supplicant / wpa_supplicant.conf
CommitLineData
6fc6879b
JM
1##### 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
ffbf1eaa 31# interface mechanism is used. For all cases, the existence of this parameter
6fc6879b
JM
32# 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).
dd10abcc
HW
84# Note: When using MACsec, eapol_version shall be set to 3, which is
85# defined in IEEE Std 802.1X-2010.
6fc6879b
JM
86eapol_version=1
87
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.
b55aaa5f
JM
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)
4658eb77
CT
97# 0: This mode must only be used when using wired Ethernet drivers
98# (including MACsec).
6fc6879b
JM
99# 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
4658eb77
CT
106# 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.
8406cd35
JM
108# For finding networks using hidden SSID, scan_ssid=1 in the network block can
109# be used with nl80211.
b55aaa5f
JM
110# 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.
6fc6879b
JM
114ap_scan=1
115
5b75ecea
BG
116# 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
e45e8989
TP
135# 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
4b409368
MH
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
5a2a6de6
MH
148# 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
483dd6a5
JM
153# cert_in_cb - Whether to include a peer certificate dump in events
154# This controls whether peer certificates for authentication server and
155# its certificate chain are included in EAP peer certificate events. This is
156# enabled by default.
157#cert_in_cb=1
158
6fc6879b
JM
159# EAP fast re-authentication
160# By default, fast re-authentication is enabled for all EAP methods that
161# support it. This variable can be used to disable fast re-authentication.
162# Normally, there is no need to disable this.
163fast_reauth=1
164
165# OpenSSL Engine support
f7cb6e9f
DW
166# These options can be used to load OpenSSL engines in special or legacy
167# modes.
6fc6879b
JM
168# The two engines that are supported currently are shown below:
169# They are both from the opensc project (http://www.opensc.org/)
f7cb6e9f
DW
170# By default the PKCS#11 engine is loaded if the client_cert or
171# private_key option appear to be a PKCS#11 URI, and these options
172# should not need to be used explicitly.
6fc6879b
JM
173# make the opensc engine available
174#opensc_engine_path=/usr/lib/opensc/engine_opensc.so
175# make the pkcs11 engine available
176#pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
177# configure the path to the pkcs11 module required by the pkcs11 engine
178#pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
179
07e2de31
JM
180# OpenSSL cipher string
181#
182# This is an OpenSSL specific configuration option for configuring the default
2b9891bd
BG
183# ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
184# by default) is used.
07e2de31
JM
185# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
186# on cipher suite configuration. This is applicable only if wpa_supplicant is
187# built to use OpenSSL.
188#openssl_ciphers=DEFAULT:!EXP:!LOW
189
6fc6879b
JM
190# Dynamic EAP methods
191# If EAP methods were built dynamically as shared object files, they need to be
192# loaded here before being used in the network blocks. By default, EAP methods
193# are included statically in the build, so these lines are not needed
194#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
195#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
196
197# Driver interface parameters
205d2d1f 198# This field can be used to configure arbitrary driver interface parameters. The
6fc6879b
JM
199# format is specific to the selected driver interface. This field is not used
200# in most cases.
201#driver_param="field=value"
202
814e925d
JM
203# Country code
204# The ISO/IEC alpha2 country code for the country in which this device is
205# currently operating.
206#country=US
207
6fc6879b
JM
208# Maximum lifetime for PMKSA in seconds; default 43200
209#dot11RSNAConfigPMKLifetime=43200
210# Threshold for reauthentication (percentage of PMK lifetime); default 70
211#dot11RSNAConfigPMKReauthThreshold=70
212# Timeout for security association negotiation in seconds; default 60
213#dot11RSNAConfigSATimeout=60
214
f855f923
JM
215# Wi-Fi Protected Setup (WPS) parameters
216
217# Universally Unique IDentifier (UUID; see RFC 4122) of the device
183d3924
JM
218# If not configured, UUID will be generated based on the mechanism selected with
219# the auto_uuid parameter.
f855f923
JM
220#uuid=12345678-9abc-def0-1234-56789abcdef0
221
183d3924
JM
222# Automatic UUID behavior
223# 0 = generate static value based on the local MAC address (default)
224# 1 = generate a random UUID every time wpa_supplicant starts
225#auto_uuid=0
226
3c0b7aa4
JM
227# Device Name
228# User-friendly description of device; up to 32 octets encoded in UTF-8
229#device_name=Wireless Client
230
231# Manufacturer
232# The manufacturer of the device (up to 64 ASCII characters)
233#manufacturer=Company
234
235# Model Name
236# Model of the device (up to 32 ASCII characters)
237#model_name=cmodel
238
239# Model Number
240# Additional device description (up to 32 ASCII characters)
241#model_number=123
242
243# Serial Number
244# Serial number of the device (up to 32 characters)
245#serial_number=12345
246
247# Primary Device Type
248# Used format: <categ>-<OUI>-<subcateg>
249# categ = Category as an integer value
250# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
251# default WPS OUI
252# subcateg = OUI-specific Sub Category as an integer value
253# Examples:
254# 1-0050F204-1 (Computer / PC)
255# 1-0050F204-2 (Computer / Server)
256# 5-0050F204-1 (Storage / NAS)
257# 6-0050F204-1 (Network Infrastructure / AP)
e83a0898 258#device_type=1-0050F204-1
3c0b7aa4
JM
259
260# OS Version
261# 4-octet operating system version number (hex string)
262#os_version=01020300
263
c0e4dd9e
JM
264# Config Methods
265# List of the supported configuration methods
266# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
6a857074
JM
267# nfc_interface push_button keypad virtual_display physical_display
268# virtual_push_button physical_push_button
53587ec1
JM
269# For WSC 1.0:
270#config_methods=label display push_button keypad
271# For WSC 2.0:
6a857074 272#config_methods=label virtual_display virtual_push_button keypad
c0e4dd9e 273
47662164
JM
274# Credential processing
275# 0 = process received credentials internally (default)
276# 1 = do not process received credentials; just pass them over ctrl_iface to
277# external program(s)
278# 2 = process received credentials internally and pass them over ctrl_iface
279# to external program(s)
280#wps_cred_processing=0
f855f923 281
339dc8bd
JM
282# Whether to enable SAE (WPA3-Personal transition mode) automatically for
283# WPA2-PSK credentials received using WPS.
284# 0 = only add the explicitly listed WPA2-PSK configuration (default)
285# 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the
286# station gets configured in WPA3-Personal transition mode (supports both
287# WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
288#wps_cred_add_sae=0
289
71dd3b78
AS
290# Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
291# The vendor attribute contents to be added in M1 (hex string)
292#wps_vendor_ext_m1=000137100100020001
293
51ca03f4
JM
294# NFC password token for WPS
295# These parameters can be used to configure a fixed NFC password token for the
296# station. This can be generated, e.g., with nfc_pw_token. When these
297# parameters are used, the station is assumed to be deployed with a NFC tag
298# that includes the matching NFC password token (e.g., written based on the
299# NDEF record from nfc_pw_token).
300#
301#wps_nfc_dev_pw_id: Device Password ID (16..65535)
302#wps_nfc_dh_pubkey: Hexdump of DH Public Key
303#wps_nfc_dh_privkey: Hexdump of DH Private Key
304#wps_nfc_dev_pw: Hexdump of Device Password
305
94687a0a
SD
306# Priority for the networks added through WPS
307# This priority value will be set to each network profile that is added
308# by executing the WPS protocol.
309#wps_priority=0
310
5a5639b0
JM
311# Device Provisioning Protocol (DPP) parameters
312#
313# How to process DPP configuration
314# 0 = report received configuration to an external program for
315# processing; do not generate any network profile internally (default)
316# 1 = report received configuration to an external program and generate
317# a network profile internally, but do not automatically connect
318# to the created (disabled) profile; the network profile id is
319# reported to external programs
320# 2 = report received configuration to an external program, generate
321# a network profile internally, try to connect to the created
322# profile automatically
323#dpp_config_processing=0
324#
325# Name for Enrollee's DPP Configuration Request
326#dpp_name=Test
327#
328# MUD URL for Enrollee's DPP Configuration Request (optional)
329#dpp_mud_url=https://example.com/mud
330
c9c38b09
JM
331# Maximum number of BSS entries to keep in memory
332# Default: 200
333# This can be used to limit memory use on the BSS entries (cached scan
334# results). A larger value may be needed in environments that have huge number
335# of APs when using ap_scan=1 mode.
336#bss_max_count=200
337
6f484978
BG
338# BSS expiration age in seconds. A BSS will be removed from the local cache
339# if it is not in use and has not been seen for this time. Default is 180.
340#bss_expiration_age=180
341
342# BSS expiration after number of scans. A BSS will be removed from the local
343# cache if it is not seen in this number of scans.
344# Default is 2.
345#bss_expiration_scan_count=2
346
b0786fba
TB
347# Automatic scan
348# This is an optional set of parameters for automatic scanning
349# within an interface in following format:
350#autoscan=<autoscan module name>:<module parameters>
65015b2d
JM
351# autoscan is like bgscan but on disconnected or inactive state.
352# For instance, on exponential module parameters would be <base>:<limit>
c0fba2b3
TB
353#autoscan=exponential:3:300
354# Which means a delay between scans on a base exponential of 3,
65015b2d
JM
355# up to the limit of 300 seconds (3, 9, 27 ... 300)
356# For periodic module, parameters would be <fixed interval>
e3659c89 357#autoscan=periodic:30
32c02261
AS
358# So a delay of 30 seconds will be applied between each scan.
359# Note: If sched_scan_plans are configured and supported by the driver,
360# autoscan is ignored.
c9c38b09 361
3812464c
JM
362# filter_ssids - SSID-based scan result filtering
363# 0 = do not filter scan results (default)
364# 1 = only include configured SSIDs in scan results/BSS table
365#filter_ssids=0
366
306ae225
JM
367# Password (and passphrase, etc.) backend for external storage
368# format: <backend name>[:<optional backend parameters>]
369#ext_password_backend=test:pw1=password|pw2=testing
370
579674eb
BG
371
372# Disable P2P functionality
373# p2p_disabled=1
374
462a7439
ES
375# Timeout in seconds to detect STA inactivity (default: 300 seconds)
376#
377# This timeout value is used in P2P GO mode to clean up
378# inactive stations.
379#p2p_go_max_inactivity=300
380
1b928f96
JM
381# Passphrase length (8..63) for P2P GO
382#
383# This parameter controls the length of the random passphrase that is
384# generated at the GO. Default: 8.
385#p2p_passphrase_len=8
386
d3b20469
NS
387# Extra delay between concurrent P2P search iterations
388#
389# This value adds extra delay in milliseconds between concurrent search
390# iterations to make p2p_find friendlier to concurrent operations by avoiding
391# it from taking 100% of radio resources. The default value is 500 ms.
392#p2p_search_delay=500
393
6e202021
JM
394# Opportunistic Key Caching (also known as Proactive Key Caching) default
395# This parameter can be used to set the default behavior for the
396# proactive_key_caching parameter. By default, OKC is disabled unless enabled
397# with the global okc=1 parameter or with the per-network
398# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
399# can be disabled with per-network proactive_key_caching=0 parameter.
400#okc=0
3812464c 401
62d49803
JM
402# Protected Management Frames default
403# This parameter can be used to set the default behavior for the ieee80211w
22950049
JM
404# parameter for RSN networks. By default, PMF is disabled unless enabled with
405# the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
406# With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
407# per-network ieee80211w parameter. This global default value does not apply
408# for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
409# RSN.
62d49803
JM
410#pmf=0
411
625f202a
JM
412# Enabled SAE finite cyclic groups in preference order
413# By default (if this parameter is not set), the mandatory group 19 (ECC group
a9fe1303
JM
414# defined over a 256-bit prime order field, NIST P-256) is preferred and groups
415# 20 (NIST P-384) and 21 (NIST P-521) are also enabled. If this parameter is
416# set, the groups will be tried in the indicated order.
417# The group values are listed in the IANA registry:
625f202a 418# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
a9fe1303
JM
419# Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
420# purposes due limited security (see RFC 8247). Groups that are not as strong as
421# group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
422# since all implementations are required to support group 19.
423#sae_groups=19 20 21
625f202a 424
85e64e63 425# SAE mechanism for PWE derivation
e36a5894
JM
426# 0 = hunting-and-pecking loop only (default without password identifier)
427# 1 = hash-to-element only (default with password identifier)
85e64e63
JM
428# 2 = both hunting-and-pecking loop and hash-to-element enabled
429# Note: The default value is likely to change from 0 to 2 once the new
430# hash-to-element mechanism has received more interoperability testing.
e36a5894
JM
431# When using SAE password identifier, the hash-to-element mechanism is used
432# regardless of the sae_pwe parameter value.
85e64e63
JM
433#sae_pwe=0
434
18206e02
JM
435# Default value for DTIM period (if not overridden in network block)
436#dtim_period=2
437
438# Default value for Beacon interval (if not overridden in network block)
439#beacon_int=100
440
18a2eaab
JM
441# Additional vendor specific elements for Beacon and Probe Response frames
442# This parameter can be used to add additional vendor specific element(s) into
443# the end of the Beacon and Probe Response frames. The format for these
444# element(s) is a hexdump of the raw information elements (id+len+payload for
445# one or more elements). This is used in AP and P2P GO modes.
446#ap_vendor_elements=dd0411223301
447
4342326f
JM
448# Ignore scan results older than request
449#
450# The driver may have a cache of scan results that makes it return
451# information that is older than our scan trigger. This parameter can
452# be used to configure such old information to be ignored instead of
453# allowing it to update the internal BSS table.
454#ignore_old_scan_res=0
455
6124e858
BG
456# scan_cur_freq: Whether to scan only the current frequency
457# 0: Scan all available frequencies. (Default)
458# 1: Scan current operating frequency if another VIF on the same radio
459# is already associated.
4342326f 460
c267753b
JM
461# MAC address policy default
462# 0 = use permanent MAC address
463# 1 = use random MAC address for each ESS connection
a313d17d 464# 2 = like 1, but maintain OUI (with local admin bit set)
c267753b
JM
465#
466# By default, permanent MAC address is used unless policy is changed by
467# the per-network mac_addr parameter. Global mac_addr=1 can be used to
468# change this default behavior.
469#mac_addr=0
470
471# Lifetime of random MAC address in seconds (default: 60)
472#rand_addr_lifetime=60
473
474# MAC address policy for pre-association operations (scanning, ANQP)
475# 0 = use permanent MAC address
476# 1 = use random MAC address
a313d17d 477# 2 = like 1, but maintain OUI (with local admin bit set)
c267753b
JM
478#preassoc_mac_addr=0
479
1d9d21f3
VK
480# MAC address policy for GAS operations
481# 0 = use permanent MAC address
482# 1 = use random MAC address
483# 2 = like 1, but maintain OUI (with local admin bit set)
484#gas_rand_mac_addr=0
485
486# Lifetime of GAS random MAC address in seconds (default: 60)
487#gas_rand_addr_lifetime=60
488
46ee0427
JM
489# Interworking (IEEE 802.11u)
490
491# Enable Interworking
492# interworking=1
493
63bc0ab0
SD
494# Enable P2P GO advertisement of Interworking
495# go_interworking=1
496
497# P2P GO Interworking: Access Network Type
498# 0 = Private network
499# 1 = Private network with guest access
500# 2 = Chargeable public network
501# 3 = Free public network
502# 4 = Personal device network
503# 5 = Emergency services only network
504# 14 = Test or experimental
505# 15 = Wildcard
506#go_access_network_type=0
507
508# P2P GO Interworking: Whether the network provides connectivity to the Internet
509# 0 = Unspecified
510# 1 = Network provides connectivity to the Internet
511#go_internet=1
512
513# P2P GO Interworking: Group Venue Info (optional)
514# The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
515# Example values (group,type):
516# 0,0 = Unspecified
517# 1,7 = Convention Center
518# 1,13 = Coffee Shop
519# 2,0 = Unspecified Business
520# 7,1 Private Residence
521#go_venue_group=7
522#go_venue_type=1
523
46ee0427
JM
524# Homogenous ESS identifier
525# If this is set, scans will be used to request response only from BSSes
526# belonging to the specified Homogeneous ESS. This is used only if interworking
527# is enabled.
528# hessid=00:11:22:33:44:55
529
4d5bda5f
JM
530# Automatic network selection behavior
531# 0 = do not automatically go through Interworking network selection
532# (i.e., require explicit interworking_select command for this; default)
533# 1 = perform Interworking network selection if one or more
534# credentials have been configured and scan did not find a
535# matching network block
536#auto_interworking=0
537
c86bef29
JM
538# GAS Address3 field behavior
539# 0 = P2P specification (Address3 = AP BSSID); default
540# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
541# sent to not-associated AP; if associated, AP BSSID)
542#gas_address3=0
543
d1723c55
LD
544# Publish fine timing measurement (FTM) responder functionality in
545# the Extended Capabilities element bit 70.
546# Controls whether FTM responder functionality will be published by AP/STA.
547# Note that actual FTM responder operation is managed outside wpa_supplicant.
548# 0 = Do not publish; default
549# 1 = Publish
550#ftm_responder=0
551
552# Publish fine timing measurement (FTM) initiator functionality in
553# the Extended Capabilities element bit 71.
554# Controls whether FTM initiator functionality will be published by AP/STA.
555# Note that actual FTM initiator operation is managed outside wpa_supplicant.
556# 0 = Do not publish; default
557# 1 = Publish
558#ftm_initiator=0
559
400020cb
JM
560# credential block
561#
562# Each credential used for automatic network selection is configured as a set
563# of parameters that are compared to the information advertised by the APs when
564# interworking_select and interworking_connect commands are used.
565#
566# credential fields:
567#
03ed3324
JM
568# temporary: Whether this credential is temporary and not to be saved
569#
400020cb
JM
570# priority: Priority group
571# By default, all networks and credentials get the same priority group
572# (0). This field can be used to give higher priority for credentials
573# (and similarly in struct wpa_ssid for network blocks) to change the
574# Interworking automatic networking selection behavior. The matching
575# network (based on either an enabled network block or a credential)
576# with the highest priority value will be selected.
577#
d7b01abd
JM
578# pcsc: Use PC/SC and SIM/USIM card
579#
400020cb
JM
580# realm: Home Realm for Interworking
581#
582# username: Username for Interworking network selection
583#
584# password: Password for Interworking network selection
585#
586# ca_cert: CA certificate for Interworking network selection
587#
588# client_cert: File path to client certificate file (PEM/DER)
589# This field is used with Interworking networking selection for a case
590# where client certificate/private key is used for authentication
591# (EAP-TLS). Full path to the file should be used since working
592# directory may change when wpa_supplicant is run in the background.
593#
f7cb6e9f
DW
594# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
595#
596# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
597#
400020cb
JM
598# Alternatively, a named configuration blob can be used by setting
599# this to blob://blob_name.
600#
601# private_key: File path to client private key file (PEM/DER/PFX)
602# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
603# commented out. Both the private key and certificate will be read
604# from the PKCS#12 file in this case. Full path to the file should be
605# used since working directory may change when wpa_supplicant is run
606# in the background.
607#
f7cb6e9f
DW
608# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
609# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
610#
400020cb
JM
611# Windows certificate store can be used by leaving client_cert out and
612# configuring private_key in one of the following formats:
613#
614# cert://substring_to_match
615#
616# hash://certificate_thumbprint_in_hex
617#
618# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
619#
620# Note that when running wpa_supplicant as an application, the user
621# certificate store (My user account) is used, whereas computer store
622# (Computer account) is used when running wpasvc as a service.
623#
624# Alternatively, a named configuration blob can be used by setting
625# this to blob://blob_name.
626#
627# private_key_passwd: Password for private key file
628#
629# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
630#
631# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
632# format
633#
463c8ffb 634# domain: Home service provider FQDN(s)
400020cb 635# This is used to compare against the Domain Name List to figure out
463c8ffb
JM
636# whether the AP is operated by the Home SP. Multiple domain entries can
637# be used to configure alternative FQDNs that will be considered home
638# networks.
400020cb 639#
955567bc
JM
640# roaming_consortium: Roaming Consortium OI
641# If roaming_consortium_len is non-zero, this field contains the
642# Roaming Consortium OI that can be used to determine which access
643# points support authentication with this credential. This is an
644# alternative to the use of the realm parameter. When using Roaming
645# Consortium to match the network, the EAP parameters need to be
646# pre-configured with the credential since the NAI Realm information
647# may not be available or fetched.
648#
9b6f93e4
JM
649# required_roaming_consortium: Required Roaming Consortium OI
650# If required_roaming_consortium_len is non-zero, this field contains the
651# Roaming Consortium OI that is required to be advertised by the AP for
652# the credential to be considered matching.
653#
909a948b
JM
654# roaming_consortiums: Roaming Consortium OI(s) memberships
655# This string field contains one or more comma delimited OIs (hexdump)
656# identifying the roaming consortiums of which the provider is a member.
657# The list is sorted from the most preferred one to the least preferred
658# one. A match between the Roaming Consortium OIs advertised by an AP and
659# the OIs in this list indicates that successful authentication is
660# possible.
661# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
662#
8ca93c59
JM
663# eap: Pre-configured EAP method
664# This optional field can be used to specify which EAP method will be
665# used with this credential. If not set, the EAP method is selected
666# automatically based on ANQP information (e.g., NAI Realm).
667#
668# phase1: Pre-configure Phase 1 (outer authentication) parameters
669# This optional field is used with like the 'eap' parameter.
670#
671# phase2: Pre-configure Phase 2 (inner authentication) parameters
672# This optional field is used with like the 'eap' parameter.
673#
dbea8ac7
JM
674# excluded_ssid: Excluded SSID
675# This optional field can be used to excluded specific SSID(s) from
676# matching with the network. Multiple entries can be used to specify more
677# than one SSID.
678#
bc00053c
JM
679# roaming_partner: Roaming partner information
680# This optional field can be used to configure preferences between roaming
681# partners. The field is a string in following format:
682# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
683# (non-exact match means any subdomain matches the entry; priority is in
684# 0..255 range with 0 being the highest priority)
685#
f9cd147d
JM
686# update_identifier: PPS MO ID
687# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
688#
aa26ba68
JM
689# provisioning_sp: FQDN of the SP that provisioned the credential
690# This optional field can be used to keep track of the SP that provisioned
691# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
692#
4cad9df1
JM
693# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
694# These fields can be used to specify minimum download/upload backhaul
695# bandwidth that is preferred for the credential. This constraint is
696# ignored if the AP does not advertise WAN Metrics information or if the
697# limit would prevent any connection. Values are in kilobits per second.
698# min_dl_bandwidth_home
699# min_ul_bandwidth_home
700# min_dl_bandwidth_roaming
701# min_ul_bandwidth_roaming
702#
a45b2dc5
JM
703# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
704# (PPS/<X+>/Policy/MaximumBSSLoadValue)
705# This value is used as the maximum channel utilization for network
706# selection purposes for home networks. If the AP does not advertise
707# BSS Load or if the limit would prevent any connection, this constraint
708# will be ignored.
709#
33fb8c52
JM
710# req_conn_capab: Required connection capability
711# (PPS/<X+>/Policy/RequiredProtoPortTuple)
712# This value is used to configure set of required protocol/port pairs that
713# a roaming network shall support (include explicitly in Connection
714# Capability ANQP element). This constraint is ignored if the AP does not
715# advertise Connection Capability or if this constraint would prevent any
716# network connection. This policy is not used in home networks.
717# Format: <protocol>[:<comma-separated list of ports]
718# Multiple entries can be used to list multiple requirements.
719# For example, number of common TCP protocols:
720# req_conn_capab=6,22,80,443
721# For example, IPSec/IKE:
722# req_conn_capab=17:500
723# req_conn_capab=50
724#
cf6d08a6
JM
725# ocsp: Whether to use/require OCSP to check server certificate
726# 0 = do not use OCSP stapling (TLS certificate status extension)
727# 1 = try to use OCSP stapling, but not require response
728# 2 = require valid OCSP stapling response
d6b536f7
JM
729# 3 = require valid OCSP stapling response for all not-trusted
730# certificates in the server certificate chain
cf6d08a6 731#
13f6a07e
NJ
732# sim_num: Identifier for which SIM to use in multi-SIM devices
733#
400020cb
JM
734# for example:
735#
736#cred={
737# realm="example.com"
738# username="user@example.com"
739# password="password"
740# ca_cert="/etc/wpa_supplicant/ca.pem"
741# domain="example.com"
742#}
743#
744#cred={
745# imsi="310026-000000000"
817bb3e1 746# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
400020cb 747#}
955567bc
JM
748#
749#cred={
750# realm="example.com"
751# username="user"
752# password="password"
753# ca_cert="/etc/wpa_supplicant/ca.pem"
754# domain="example.com"
755# roaming_consortium=223344
756# eap=TTLS
757# phase2="auth=MSCHAPV2"
758#}
2a4b98a9 759
66aadbd7
JK
760# Hotspot 2.0
761# hs20=1
762
32c02261
AS
763# Scheduled scan plans
764#
765# A space delimited list of scan plans. Each scan plan specifies the scan
766# interval and number of iterations, delimited by a colon. The last scan plan
767# will run infinitely and thus must specify only the interval and not the number
768# of iterations.
769#
770# The driver advertises the maximum number of scan plans supported. If more scan
771# plans than supported are configured, only the first ones are set (up to the
772# maximum supported). The last scan plan that specifies only the interval is
773# always set as the last plan.
774#
775# If the scan interval or the number of iterations for a scan plan exceeds the
776# maximum supported, it will be set to the maximum supported value.
777#
778# Format:
779# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
780#
781# Example:
782# sched_scan_plans=10:100 20:200 30
783
facf2c72
DS
784# Multi Band Operation (MBO) non-preferred channels
785# A space delimited list of non-preferred channels where each channel is a colon
4a83d4b6 786# delimited list of values.
facf2c72 787# Format:
4a83d4b6 788# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
facf2c72 789# Example:
23cddd75 790# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
facf2c72 791
c5d193d7
DS
792# MBO Cellular Data Capabilities
793# 1 = Cellular data connection available
794# 2 = Cellular data connection not available
795# 3 = Not cellular capable (default)
796#mbo_cell_capa=3
797
332aadb8
AP
798# Optimized Connectivity Experience (OCE)
799# oce: Enable OCE features (bitmap)
800# Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
801# does not indicate support for OCE in STA mode)
802# Set BIT(1) to Enable OCE in STA-CFON mode
803#oce=1
804
6fc6879b
JM
805# network block
806#
807# Each network (usually AP's sharing the same SSID) is configured as a separate
808# block in this configuration file. The network blocks are in preference order
809# (the first match is used).
810#
811# network block fields:
812#
813# disabled:
814# 0 = this network can be used (default)
815# 1 = this network block is disabled (can be enabled through ctrl_iface,
816# e.g., with wpa_cli or wpa_gui)
817#
818# id_str: Network identifier string for external scripts. This value is passed
819# to external action script through wpa_cli as WPA_ID_STR environment
820# variable to make it easier to do network specific configuration.
821#
5c4b93d7
JM
822# ssid: SSID (mandatory); network name in one of the optional formats:
823# - an ASCII string with double quotation
824# - a hex string (two characters per octet of SSID)
825# - a printf-escaped ASCII string P"<escaped string>"
6fc6879b
JM
826#
827# scan_ssid:
828# 0 = do not scan this SSID with specific Probe Request frames (default)
829# 1 = scan with SSID-specific Probe Request frames (this can be used to
830# find APs that do not accept broadcast SSID or use multiple SSIDs;
831# this will add latency to scanning, so enable this only when needed)
832#
833# bssid: BSSID (optional); if set, this network block is used only when
834# associating with the AP using the configured BSSID
835#
836# priority: priority group (integer)
837# By default, all networks will get same priority group (0). If some of the
838# networks are more desirable, this field can be used to change the order in
839# which wpa_supplicant goes through the networks when selecting a BSS. The
840# priority groups will be iterated in decreasing priority (i.e., the larger the
841# priority value, the sooner the network is matched against the scan results).
842# Within each priority group, networks will be selected based on security
843# policy, signal strength, etc.
844# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
845# using this priority to select the order for scanning. Instead, they try the
846# networks in the order that used in the configuration file.
847#
848# mode: IEEE 802.11 operation mode
849# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
850# 1 = IBSS (ad-hoc, peer-to-peer)
1581b38b 851# 2 = AP (access point)
b2838baf
JM
852# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
853# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
854# TKIP/CCMP) is available for backwards compatibility, but its use is
855# deprecated. WPA-None requires following network block options:
6fc6879b
JM
856# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
857# both), and psk must also be set.
858#
859# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
860# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
861# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
862# In addition, this value is only used by the station that creates the IBSS. If
863# an IBSS network with the configured SSID is already present, the frequency of
864# the network will be used instead of this configured value.
865#
b9074912 866# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
90f14962
LD
867# 0 = do not use PBSS
868# 1 = use PBSS
869# 2 = don't care (not allowed in AP mode)
b9074912
LD
870# Used together with mode configuration. When mode is AP, it means to start a
871# PCP instead of a regular AP. When mode is infrastructure it means connect
90f14962
LD
872# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
873# which means connect to either PCP or AP.
874# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
b9074912
LD
875# For more details, see IEEE Std 802.11ad-2012.
876#
d3a98225
JM
877# scan_freq: List of frequencies to scan
878# Space-separated list of frequencies in MHz to scan when searching for this
879# BSS. If the subset of channels used by the network is known, this option can
880# be used to optimize scanning to not occur on channels that the network does
881# not use. Example: scan_freq=2412 2437 2462
882#
b766a9a2
JM
883# freq_list: Array of allowed frequencies
884# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
885# set, scan results that do not match any of the specified frequencies are not
886# considered when selecting a BSS.
887#
f5ffc348
BG
888# This can also be set on the outside of the network block. In this case,
889# it limits the frequencies that will be scanned.
890#
2474ce45
JM
891# bgscan: Background scanning
892# wpa_supplicant behavior for background scanning can be specified by
893# configuring a bgscan module. These modules are responsible for requesting
894# background scans for the purpose of roaming within an ESS (i.e., within a
895# single network block with all the APs using the same SSID). The bgscan
896# parameter uses following format: "<bgscan module name>:<module parameters>"
897# Following bgscan modules are available:
898# simple - Periodic background scans based on signal strength
899# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
900# <long interval>"
901# bgscan="simple:30:-45:300"
902# learn - Learn channels used by the network and try to avoid bgscans on other
903# channels (experimental)
904# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
905# <long interval>[:<database file name>]"
906# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
268043d5
DS
907# Explicitly disable bgscan by setting
908# bgscan=""
2474ce45 909#
31392709
HD
910# This option can also be set outside of all network blocks for the bgscan
911# parameter to apply for all the networks that have no specific bgscan
912# parameter.
913#
6fc6879b
JM
914# proto: list of accepted protocols
915# WPA = WPA/IEEE 802.11i/D3.0
916# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
ecec4878 917# Note that RSN is used also for WPA3.
6fc6879b
JM
918# If not set, this defaults to: WPA RSN
919#
920# key_mgmt: list of accepted authenticated key management protocols
921# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
f6190d37 922# WPA-EAP = WPA using EAP authentication
6fc6879b
JM
923# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
924# generated WEP keys
925# NONE = WPA is not used; plaintext or static WEP could be used
0ab0de88
JM
926# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
927# instead)
928# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
929# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
d8e8c992
JM
930# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
931# and using SHA384
56586197
JM
932# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
933# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
0ab0de88
JM
934# SAE = Simultaneous authentication of equals; pre-shared key/password -based
935# authentication with stronger security than WPA-PSK especially when using
ecec4878 936# not that strong password; a.k.a. WPA3-Personal
0ab0de88
JM
937# FT-SAE = SAE with FT
938# WPA-EAP-SUITE-B = Suite B 128-bit level
939# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
aeb408ff 940# OSEN = Hotspot 2.0 Rel 2 online signup connection
9b7a2b83
JM
941# FILS-SHA256 = Fast Initial Link Setup with SHA256
942# FILS-SHA384 = Fast Initial Link Setup with SHA384
943# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
944# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
ecec4878
JM
945# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
946# DPP = Device Provisioning Protocol
6fc6879b
JM
947# If not set, this defaults to: WPA-PSK WPA-EAP
948#
4732ee3a 949# ieee80211w: whether management frame protection is enabled
62d49803 950# 0 = disabled (default unless changed with the global pmf parameter)
4732ee3a
JM
951# 1 = optional
952# 2 = required
953# The most common configuration options for this based on the PMF (protected
954# management frames) certification program are:
955# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
956# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
efaa6256
JM
957# (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
958# WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE
4732ee3a 959#
ce6829c2
MV
960# ocv: whether operating channel validation is enabled
961# This is a countermeasure against multi-channel man-in-the-middle attacks.
962# Enabling this automatically also enables ieee80211w, if not yet enabled.
963# 0 = disabled (default)
964# 1 = enabled
965#ocv=1
966#
6fc6879b
JM
967# auth_alg: list of allowed IEEE 802.11 authentication algorithms
968# OPEN = Open System authentication (required for WPA/WPA2)
969# SHARED = Shared Key authentication (requires static WEP keys)
970# LEAP = LEAP/Network EAP (only used with LEAP)
971# If not set, automatic selection is used (Open System with LEAP enabled if
972# LEAP is allowed as one of the EAP methods).
973#
974# pairwise: list of accepted pairwise (unicast) ciphers for WPA
975# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
976# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
977# NONE = Use only Group Keys (deprecated, should not be included if APs support
978# pairwise keys)
979# If not set, this defaults to: CCMP TKIP
980#
981# group: list of accepted group (broadcast/multicast) ciphers for WPA
982# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
983# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
984# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
985# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
986# If not set, this defaults to: CCMP TKIP WEP104 WEP40
987#
61a56c14
JM
988# group_mgmt: list of accepted group management ciphers for RSN (PMF)
989# AES-128-CMAC = BIP-CMAC-128
990# BIP-GMAC-128
991# BIP-GMAC-256
992# BIP-CMAC-256
993# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
994# indicates.
995#
6fc6879b
JM
996# psk: WPA preshared key; 256-bit pre-shared key
997# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
998# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
999# generated using the passphrase and SSID). ASCII passphrase must be between
9173b16f
JM
1000# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
1001# be used to indicate that the PSK/passphrase is stored in external storage.
6fc6879b
JM
1002# This field is not needed, if WPA-EAP is used.
1003# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
1004# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
1005# startup and reconfiguration time can be optimized by generating the PSK only
1006# only when the passphrase or SSID has actually changed.
1007#
a52410c2
JM
1008# mem_only_psk: Whether to keep PSK/passphrase only in memory
1009# 0 = allow psk/passphrase to be stored to the configuration file
1010# 1 = do not store psk/passphrase to the configuration file
1011#mem_only_psk=0
1012#
a34ca59e
JM
1013# sae_password: SAE password
1014# This parameter can be used to set a password for SAE. By default, the
a2ab3730
JM
1015# passphrase from the psk parameter is used if this separate parameter is not
1016# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
1017# SAE passwords do not have such constraints.
a34ca59e 1018#
9be19d0b
JM
1019# sae_password_id: SAE password identifier
1020# This parameter can be used to set an identifier for the SAE password. By
1021# default, no such identifier is used. If set, the specified identifier value
1022# is used by the other peer to select which password to use for authentication.
1023#
6fc6879b
JM
1024# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
1025# Dynamic WEP key required for non-WPA mode
1026# bit0 (1): require dynamically generated unicast WEP key
1027# bit1 (2): require dynamically generated broadcast WEP key
1028# (3 = require both keys; default)
ba5ea116 1029# Note: When using wired authentication (including MACsec drivers),
dd10abcc
HW
1030# eapol_flags must be set to 0 for the authentication to be completed
1031# successfully.
1032#
1033# macsec_policy: IEEE 802.1X/MACsec options
ba5ea116
SD
1034# This determines how sessions are secured with MACsec (only for MACsec
1035# drivers).
dd10abcc
HW
1036# 0: MACsec not in use (default)
1037# 1: MACsec enabled - Should secure, accept key server's advice to
1038# determine whether to use a secure session or not.
6fc6879b 1039#
7b4d546e
SD
1040# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1041# This setting applies only when MACsec is in use, i.e.,
1042# - macsec_policy is enabled
1043# - the key server has decided to enable MACsec
1044# 0: Encrypt traffic (default)
1045# 1: Integrity only
1046#
e49b78c0
AK
1047# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1048# This setting applies only when MACsec is in use, i.e.,
1049# - macsec_policy is enabled
1050# - the key server has decided to enable MACsec
1051# 0: Replay protection disabled (default)
1052# 1: Replay protection enabled
1053#
1054# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1055# This determines a window in which replay is tolerated, to allow receipt
1056# of frames that have been misordered by the network.
1057# This setting applies only when MACsec replay protection active, i.e.,
1058# - macsec_replay_protect is enabled
1059# - the key server has decided to enable MACsec
1060# 0: No replay window, strict check (default)
1061# 1..2^32-1: number of packets that could be misordered
1062#
e0d9fd34
SD
1063# macsec_port: IEEE 802.1X/MACsec port
1064# Port component of the SCI
1065# Range: 1-65534 (default: 1)
1066#
65dfa872 1067# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
ad51731a 1068# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
65dfa872
BA
1069# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1070# with lower priority will become the key server and start distributing SAKs.
871439b5
JM
1071# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1072# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1073# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1074# (2..64 hex-digits)
65dfa872
BA
1075# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1076# default priority
ad51731a 1077#
6fc6879b
JM
1078# mixed_cell: This option can be used to configure whether so called mixed
1079# cells, i.e., networks that use both plaintext and encryption in the same
ffbf1eaa 1080# SSID, are allowed when selecting a BSS from scan results.
6fc6879b
JM
1081# 0 = disabled (default)
1082# 1 = enabled
1083#
1084# proactive_key_caching:
1085# Enable/disable opportunistic PMKSA caching for WPA2.
6e202021 1086# 0 = disabled (default unless changed with the global okc parameter)
6fc6879b
JM
1087# 1 = enabled
1088#
9083ef13
JM
1089# ft_eap_pmksa_caching:
1090# Whether FT-EAP PMKSA caching is allowed
1091# 0 = do not try to use PMKSA caching with FT-EAP (default)
1092# 1 = try to use PMKSA caching with FT-EAP
1093# This controls whether to try to use PMKSA caching with FT-EAP for the
1094# FT initial mobility domain association.
1095#ft_eap_pmksa_caching=0
1096#
6fc6879b
JM
1097# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1098# hex without quotation, e.g., 0102030405)
1099# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1100#
581a8cde
JM
1101# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1102# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1103#
0e05e878
AW
1104# wpa_deny_ptk0_rekey: Workaround for PTK rekey issues
1105# PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the
1106# security and stability with some cards.
1107# To avoid the issues wpa_supplicant can replace those PTK rekeys (including
1108# EAP reauthentications) with fast reconnects.
1f90a49d
AW
1109#
1110# Available options:
1111# 0 = always rekey when configured/instructed (default)
1112# 1 = only rekey when the local driver is explicitly indicating it can perform
1113# this operation without issues
1114# 2 = never allow problematic PTK0 rekeys
1115#
6c33ca9f
JM
1116# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1117# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
f09095d5 1118# Authenticator role in IBSS, or in AP and mesh modes.
6c33ca9f 1119#
6fc6879b
JM
1120# Following fields are only used with internal EAP implementation.
1121# eap: space-separated list of accepted EAP methods
205d2d1f 1122# MD5 = EAP-MD5 (insecure and does not generate keying material ->
6fc6879b
JM
1123# cannot be used with WPA; to be used as a Phase 2 method
1124# with EAP-PEAP or EAP-TTLS)
1125# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1126# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1127# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1128# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1129# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1130# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1131# TLS = EAP-TLS (client and server certificate)
1132# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1133# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1134# authentication)
1135# If not set, all compiled in methods are allowed.
1136#
1137# identity: Identity string for EAP
1138# This field is also used to configure user NAI for
1139# EAP-PSK/PAX/SAKE/GPSK.
1140# anonymous_identity: Anonymous identity string for EAP (to be used as the
1141# unencrypted identity with EAP types that support different tunnelled
e026159a
JM
1142# identity, e.g., EAP-TTLS). This field can also be used with
1143# EAP-SIM/AKA/AKA' to store the pseudonym identity.
6fc6879b
JM
1144# password: Password string for EAP. This field can include either the
1145# plaintext password (using ASCII or hex string) or a NtPasswordHash
1146# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1147# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1148# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1149# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1150# PSK) is also configured using this field. For EAP-GPSK, this is a
0ebb23e3
JM
1151# variable length PSK. ext:<name of external password field> format can
1152# be used to indicate that the password is stored in external storage.
6fc6879b
JM
1153# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1154# or more trusted CA certificates. If ca_cert and ca_path are not
1155# included, server certificate will not be verified. This is insecure and
1156# a trusted CA certificate should always be configured when using
1157# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1158# change when wpa_supplicant is run in the background.
00468b46
JM
1159#
1160# Alternatively, this can be used to only perform matching of the server
1161# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1162# this case, the possible CA certificates in the server certificate chain
1163# are ignored and only the server certificate is verified. This is
1164# configured with the following format:
1165# hash:://server/sha256/cert_hash_in_hex
1166# For example: "hash://server/sha256/
1167# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1168#
6fc6879b
JM
1169# On Windows, trusted CA certificates can be loaded from the system
1170# certificate store by setting this to cert_store://<name>, e.g.,
1171# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1172# Note that when running wpa_supplicant as an application, the user
1173# certificate store (My user account) is used, whereas computer store
1174# (Computer account) is used when running wpasvc as a service.
1175# ca_path: Directory path for CA certificate files (PEM). This path may
1176# contain multiple CA certificates in OpenSSL format. Common use for this
1177# is to point to system trusted CA list which is often installed into
1178# directory like /etc/ssl/certs. If configured, these certificates are
1179# added to the list of trusted CAs. ca_cert may also be included in that
1180# case, but it is not required.
1181# client_cert: File path to client certificate file (PEM/DER)
1182# Full path should be used since working directory may change when
1183# wpa_supplicant is run in the background.
1184# Alternatively, a named configuration blob can be used by setting this
1185# to blob://<blob name>.
1186# private_key: File path to client private key file (PEM/DER/PFX)
1187# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1188# commented out. Both the private key and certificate will be read from
1189# the PKCS#12 file in this case. Full path should be used since working
1190# directory may change when wpa_supplicant is run in the background.
1191# Windows certificate store can be used by leaving client_cert out and
1192# configuring private_key in one of the following formats:
1193# cert://substring_to_match
1194# hash://certificate_thumbprint_in_hex
1195# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1196# Note that when running wpa_supplicant as an application, the user
1197# certificate store (My user account) is used, whereas computer store
1198# (Computer account) is used when running wpasvc as a service.
1199# Alternatively, a named configuration blob can be used by setting this
1200# to blob://<blob name>.
1201# private_key_passwd: Password for private key file (if left out, this will be
1202# asked through control interface)
1203# dh_file: File path to DH/DSA parameters file (in PEM format)
1204# This is an optional configuration file for setting parameters for an
1205# ephemeral DH key exchange. In most cases, the default RSA
1206# authentication does not use this configuration. However, it is possible
1207# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1208# DSA keys always use ephemeral DH keys. This can be used to achieve
1209# forward secrecy. If the file is in DSA parameters format, it will be
1210# automatically converted into DH params.
1211# subject_match: Substring to be matched against the subject of the
1212# authentication server certificate. If this string is set, the server
205d2d1f 1213# certificate is only accepted if it contains this string in the subject.
6fc6879b
JM
1214# The subject string is in following format:
1215# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
205d2d1f 1216# Note: Since this is a substring match, this cannot be used securely to
394b5473 1217# do a suffix match against a possible domain name in the CN entry. For
cebee30f
JM
1218# such a use case, domain_suffix_match or domain_match should be used
1219# instead.
6fc6879b
JM
1220# altsubject_match: Semicolon separated string of entries to be matched against
1221# the alternative subject name of the authentication server certificate.
205d2d1f 1222# If this string is set, the server certificate is only accepted if it
6fc6879b
JM
1223# contains one of the entries in an alternative subject name extension.
1224# altSubjectName string is in following format: TYPE:VALUE
1225# Example: EMAIL:server@example.com
1226# Example: DNS:server.example.com;DNS:server2.example.com
1227# Following types are supported: EMAIL, DNS, URI
394b5473 1228# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
205d2d1f 1229# used as a suffix match requirement for the AAA server certificate in
394b5473
JM
1230# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1231# constraint is met. If no dNSName values are present, this constraint is
1232# matched against SubjectName CN using same suffix match comparison.
1233#
1234# Suffix match here means that the host/domain name is compared one label
1235# at a time starting from the top-level domain and all the labels in
1236# domain_suffix_match shall be included in the certificate. The
1237# certificate may include additional sub-level labels in addition to the
1238# required labels.
1239#
242e8572
JM
1240# More than one match string can be provided by using semicolons to
1241# separate the strings (e.g., example.org;example.com). When multiple
1242# strings are specified, a match with any one of the values is considered
1243# a sufficient match for the certificate, i.e., the conditions are ORed
1244# together.
1245#
394b5473
JM
1246# For example, domain_suffix_match=example.com would match
1247# test.example.com but would not match test-example.com.
cebee30f
JM
1248# domain_match: Constraint for server domain name
1249# If set, this FQDN is used as a full match requirement for the
1250# server certificate in SubjectAltName dNSName element(s). If a
1251# matching dNSName is found, this constraint is met. If no dNSName
1252# values are present, this constraint is matched against SubjectName CN
1253# using same full match comparison. This behavior is similar to
1254# domain_suffix_match, but has the requirement of a full match, i.e.,
1255# no subdomains or wildcard matches are allowed. Case-insensitive
1256# comparison is used, so "Example.com" matches "example.com", but would
1257# not match "test.Example.com".
242e8572
JM
1258#
1259# More than one match string can be provided by using semicolons to
1260# separate the strings (e.g., example.org;example.com). When multiple
1261# strings are specified, a match with any one of the values is considered
1262# a sufficient match for the certificate, i.e., the conditions are ORed
1263# together.
6fc6879b
JM
1264# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1265# (string with field-value pairs, e.g., "peapver=0" or
1266# "peapver=1 peaplabel=1")
1267# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1268# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1269# to be used during key derivation when PEAPv1 or newer. Most existing
1270# PEAPv1 implementation seem to be using the old label, "client EAP
1271# encryption", and wpa_supplicant is now using that as the default value.
1272# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1273# interoperate with PEAPv1; see eap_testing.txt for more details.
1274# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1275# tunneled EAP-Success. This is required with some RADIUS servers that
1276# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1277# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1278# include_tls_length=1 can be used to force wpa_supplicant to include
1279# TLS Message Length field in all TLS messages even if they are not
1280# fragmented.
1281# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1282# challenges (by default, it accepts 2 or 3)
1283# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1284# protected result indication.
d6888f9e
JM
1285# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1286# behavior:
c31a11c9
JM
1287# * 0 = do not use cryptobinding (default)
1288# * 1 = use cryptobinding if server supports it
d6888f9e 1289# * 2 = require cryptobinding
f855f923
JM
1290# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1291# pbc=1.
7f7bfba9
JM
1292#
1293# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1294# used to configure a mode that allows EAP-Success (and EAP-Failure)
1295# without going through authentication step. Some switches use such
1296# sequence when forcing the port to be authorized/unauthorized or as a
1297# fallback option if the authentication server is unreachable. By default,
1298# wpa_supplicant discards such frames to protect against potential attacks
1299# by rogue devices, but this option can be used to disable that protection
1300# for cases where the server/authenticator does not need to be
1301# authenticated.
6fc6879b
JM
1302# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1303# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
49fcc32e
JM
1304# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1305# used to disable MSCHAPv2 password retry in authentication failure cases.
9af7361b
JM
1306#
1307# TLS-based methods can use the following parameters to control TLS behavior
1308# (these are normally in the phase1 parameter, but can be used also in the
1309# phase2 parameter when EAP-TLS is used within the inner tunnel):
1310# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1311# TLS library, these may be disabled by default to enforce stronger
1312# security)
1313# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1314# the TLS library to accept certificates even if they are not currently
1315# valid, i.e., have expired or have not yet become valid; this should be
1316# used only for testing purposes)
1317# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1318# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1319# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1320# as a workaround for broken authentication server implementations unless
56dfc493 1321# EAP workarounds are disabled with eap_workaround=0.
9af7361b
JM
1322# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1323# default value to be used automatically).
5650d379 1324# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
cc9c4fec
JM
1325# tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1326# systemwide TLS policies to be overridden)
e9a6f183
DS
1327# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1328# that have issues interoperating with updated TLS version)
cc9c4fec
JM
1329# tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1330# systemwide TLS policies to be overridden)
e9a6f183
DS
1331# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1332# that have issues interoperating with updated TLS version)
cc9c4fec
JM
1333# tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1334# systemwide TLS policies to be overridden)
bbbc7e80
JM
1335# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1336# that have issues interoperating with updated TLS version)
cc9c4fec 1337# tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
3c108b75
JM
1338# tls_ext_cert_check=0 - No external server certificate validation (default)
1339# tls_ext_cert_check=1 - External server certificate validation enabled; this
1340# requires an external program doing validation of server certificate
1341# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1342# interface and report the result of the validation with
1343# CTRL-RSP_EXT_CERT_CHECK.
60ed2f24
JM
1344# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1345# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1346# particular when using Suite B with RSA keys of >= 3K (3072) bits
9af7361b 1347#
6fc6879b
JM
1348# Following certificate/private key fields are used in inner Phase2
1349# authentication when using EAP-TTLS or EAP-PEAP.
1350# ca_cert2: File path to CA certificate file. This file can have one or more
1351# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1352# server certificate will not be verified. This is insecure and a trusted
1353# CA certificate should always be configured.
1354# ca_path2: Directory path for CA certificate files (PEM)
1355# client_cert2: File path to client certificate file
1356# private_key2: File path to client private key file
1357# private_key2_passwd: Password for private key file
1358# dh_file2: File path to DH/DSA parameters file (in PEM format)
1359# subject_match2: Substring to be matched against the subject of the
394b5473
JM
1360# authentication server certificate. See subject_match for more details.
1361# altsubject_match2: Semicolon separated string of entries to be matched
1362# against the alternative subject name of the authentication server
1363# certificate. See altsubject_match documentation for more details.
1364# domain_suffix_match2: Constraint for server domain name. See
1365# domain_suffix_match for more details.
043de65f 1366# ocsp2: See ocsp for more details.
6fc6879b 1367#
68161824
JM
1368# Separate machine credentials can be configured for EAP-TEAP Phase 2 with
1369# "machine_" prefix (e.g., "machine_identity") in the configuration parameters.
1370# See the parameters without that prefix for more details on the meaning and
1371# format of each such parameter.
1372#
6fc6879b
JM
1373# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1374# This value limits the fragment size for EAP methods that support
1375# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1376# small enough to make the EAP messages fit in MTU of the network
1377# interface used for EAPOL. The default value is suitable for most
1378# cases.
1379#
080585c0
JM
1380# ocsp: Whether to use/require OCSP to check server certificate
1381# 0 = do not use OCSP stapling (TLS certificate status extension)
1382# 1 = try to use OCSP stapling, but not require response
1383# 2 = require valid OCSP stapling response
d6b536f7
JM
1384# 3 = require valid OCSP stapling response for all not-trusted
1385# certificates in the server certificate chain
080585c0 1386#
07e2de31
JM
1387# openssl_ciphers: OpenSSL specific cipher configuration
1388# This can be used to override the global openssl_ciphers configuration
1389# parameter (see above).
1390#
02a8d45a
JM
1391# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1392#
6fc6879b
JM
1393# EAP-FAST variables:
1394# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1395# to create this file and write updates to it when PAC is being
1396# provisioned or refreshed. Full path to the file should be used since
1397# working directory may change when wpa_supplicant is run in the
1398# background. Alternatively, a named configuration blob can be used by
1399# setting this to blob://<blob name>
1400# phase1: fast_provisioning option can be used to enable in-line provisioning
1401# of EAP-FAST credentials (PAC):
1402# 0 = disabled,
1403# 1 = allow unauthenticated provisioning,
1404# 2 = allow authenticated provisioning,
1405# 3 = allow both unauthenticated and authenticated provisioning
1406# fast_max_pac_list_len=<num> option can be used to set the maximum
1407# number of PAC entries to store in a PAC list (default: 10)
1408# fast_pac_format=binary option can be used to select binary format for
2e8c9a27 1409# storing PAC entries in order to save some space (the default
6fc6879b
JM
1410# text format uses about 2.5 times the size of minimal binary
1411# format)
1412#
1413# wpa_supplicant supports number of "EAP workarounds" to work around
1414# interoperability issues with incorrectly behaving authentication servers.
1415# These are enabled by default because some of the issues are present in large
1416# number of authentication servers. Strict EAP conformance mode can be
1417# configured by disabling workarounds with eap_workaround=0.
1418
aeb408ff
JM
1419# update_identifier: PPS MO ID
1420# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
6311547e
JM
1421#
1422# roaming_consortium_selection: Roaming Consortium Selection
1423# The matching Roaming Consortium OI that was used to generate this
1424# network profile.
aeb408ff 1425
07f53b8c
VT
1426# Station inactivity limit
1427#
1428# If a station does not send anything in ap_max_inactivity seconds, an
1429# empty data frame is sent to it in order to verify whether it is
1430# still in range. If this frame is not ACKed, the station will be
1431# disassociated and then deauthenticated. This feature is used to
1432# clear station table of old entries when the STAs move out of the
1433# range.
1434#
1435# The station can associate again with the AP if it is still in range;
1436# this inactivity poll is just used as a nicer way of verifying
1437# inactivity; i.e., client will not report broken connection because
1438# disassociation frame is not sent immediately without first polling
1439# the STA with a data frame.
1440# default: 300 (i.e., 5 minutes)
1441#ap_max_inactivity=300
1442
fdfb1c8b
EL
1443# DTIM period in Beacon intervals for AP mode (default: 2)
1444#dtim_period=2
1445
18206e02
JM
1446# Beacon interval (default: 100 TU)
1447#beacon_int=100
1448
b6317b41
LD
1449# WPS in AP mode
1450# 0 = WPS enabled and configured (default)
1451# 1 = WPS disabled
1452#wps_disabled=0
1453
76e20f4f
JM
1454# FILS DH Group
1455# 0 = PFS disabled with FILS shared key authentication (default)
1456# 1-65535 = DH Group to use for FILS PFS
1457#fils_dh_group=0
1458
c267753b
JM
1459# MAC address policy
1460# 0 = use permanent MAC address
1461# 1 = use random MAC address for each ESS connection
a313d17d 1462# 2 = like 1, but maintain OUI (with local admin bit set)
c267753b
JM
1463#mac_addr=0
1464
c8d22af8
BG
1465# disable_ht: Whether HT (802.11n) should be disabled.
1466# 0 = HT enabled (if AP supports it)
1467# 1 = HT disabled
1468#
1469# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1470# 0 = HT-40 enabled (if AP supports it)
1471# 1 = HT-40 disabled
1472#
1473# disable_sgi: Whether SGI (short guard interval) should be disabled.
1474# 0 = SGI enabled (if AP supports it)
1475# 1 = SGI disabled
1476#
39a5800f
PK
1477# disable_ldpc: Whether LDPC should be disabled.
1478# 0 = LDPC enabled (if AP supports it)
1479# 1 = LDPC disabled
1480#
d41cc8cc
JM
1481# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1482# 0 = 40 MHz tolerant (default)
1483# 1 = 40 MHz intolerant
1484#
c8d22af8
BG
1485# ht_mcs: Configure allowed MCS rates.
1486# Parsed as an array of bytes, in base-16 (ascii-hex)
1487# ht_mcs="" // Use all available (default)
1488# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1489# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1490#
1491# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1492# -1 = Do not make any changes.
1493# 0 = Enable MAX-AMSDU if hardware supports it.
1494# 1 = Disable AMSDU
1495#
e74dd0e5
JM
1496# ampdu_factor: Maximum A-MPDU Length Exponent
1497# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1498#
c8d22af8
BG
1499# ampdu_density: Allow overriding AMPDU density configuration.
1500# Treated as hint by the kernel.
1501# -1 = Do not make any changes.
1502# 0-3 = Set AMPDU density (aka factor) to specified value.
cdeea70f
SM
1503#
1504# tx_stbc: Allow overriding STBC support for TX streams
1505# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1506# -1 = Do not make any changes (default)
1507# 0 = Set if not supported
1508# 1 = Set if supported
1509#
1510# rx_stbc: Allow overriding STBC support for RX streams
1511# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1512# -1 = Do not make any changes (default)
1513# 0 = Set if not supported
1514# 1 = Set for support of one spatial stream
1515# 2 = Set for support of one and two spatial streams
1516# 3 = Set for support of one, two and three spatial streams
c8d22af8 1517
e9ee8dc3
JB
1518# disable_vht: Whether VHT should be disabled.
1519# 0 = VHT enabled (if AP supports it)
1520# 1 = VHT disabled
1521#
1522# vht_capa: VHT capabilities to set in the override
1523# vht_capa_mask: mask of VHT capabilities
1524#
1525# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1526# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1527# 0: MCS 0-7
1528# 1: MCS 0-8
1529# 2: MCS 0-9
1530# 3: not supported
1531
5abc7823
VN
1532# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1533# 0 = normal STA (default)
1534# 1 = backhaul STA
1535# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1536# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1537# added to a bridge to allow forwarding frames over this backhaul link.
1538
76ca15b7
AN
1539##### Fast Session Transfer (FST) support #####################################
1540#
1541# The options in this section are only available when the build configuration
205d2d1f
JM
1542# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1543# interface to be a part of FST setup.
76ca15b7
AN
1544#
1545# FST is the transfer of a session from a channel to another channel, in the
1546# same or different frequency bands.
1547#
205d2d1f 1548# For details, see IEEE Std 802.11ad-2012.
76ca15b7
AN
1549
1550# Identifier of an FST Group the interface belongs to.
1551#fst_group_id=bond0
1552
1553# Interface priority within the FST Group.
1554# Announcing a higher priority for an interface means declaring it more
1555# preferable for FST switch.
1556# fst_priority is in 1..255 range with 1 being the lowest priority.
1557#fst_priority=100
1558
1559# Default LLT value for this interface in milliseconds. The value used in case
1560# no value provided during session setup. Default is 50 msec.
1561# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1562# Transitioning between states).
1563#fst_llt=100
1564
ef59f987
AB
1565# BSS Transition Management
1566# disable_btm - Disable BSS transition management in STA
1567# Set to 0 to enable BSS transition management (default behavior)
1568# Set to 1 to disable BSS transition management
1569#disable_btm=0
1570
e8ff22f4
AAL
1571# Enable EDMG capability in STA/AP mode, default value is false
1572#enable_edmg=1
1573
1574# This value is used to configure the channel bonding feature.
1575# Default value is 0.
1576# Relevant only if enable_edmg is true
1577# In AP mode it defines the EDMG channel to use for AP operation.
1578# In STA mode it defines the EDMG channel for connection (if supported by AP).
1579#edmg_channel=9
1580
6fc6879b
JM
1581# Example blocks:
1582
1583# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1584network={
1585 ssid="simple"
1586 psk="very secret passphrase"
1587 priority=5
1588}
1589
1590# Same as previous, but request SSID-specific scanning (for APs that reject
1591# broadcast SSID)
1592network={
1593 ssid="second ssid"
1594 scan_ssid=1
1595 psk="very secret passphrase"
1596 priority=2
1597}
1598
1599# Only WPA-PSK is used. Any valid cipher combination is accepted.
1600network={
1601 ssid="example"
1602 proto=WPA
1603 key_mgmt=WPA-PSK
1604 pairwise=CCMP TKIP
1605 group=CCMP TKIP WEP104 WEP40
1606 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1607 priority=2
1608}
1609
581a8cde
JM
1610# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1611network={
1612 ssid="example"
1613 proto=WPA
1614 key_mgmt=WPA-PSK
1615 pairwise=TKIP
1616 group=TKIP
1617 psk="not so secure passphrase"
1618 wpa_ptk_rekey=600
1619}
1620
6fc6879b
JM
1621# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1622# or WEP40 as the group cipher will not be accepted.
1623network={
1624 ssid="example"
1625 proto=RSN
1626 key_mgmt=WPA-EAP
1627 pairwise=CCMP TKIP
1628 group=CCMP TKIP
1629 eap=TLS
1630 identity="user@example.com"
1631 ca_cert="/etc/cert/ca.pem"
1632 client_cert="/etc/cert/user.pem"
1633 private_key="/etc/cert/user.prv"
1634 private_key_passwd="password"
1635 priority=1
1636}
1637
1638# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1639# (e.g., Radiator)
1640network={
1641 ssid="example"
1642 key_mgmt=WPA-EAP
1643 eap=PEAP
1644 identity="user@example.com"
1645 password="foobar"
1646 ca_cert="/etc/cert/ca.pem"
1647 phase1="peaplabel=1"
1648 phase2="auth=MSCHAPV2"
1649 priority=10
1650}
1651
1652# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1653# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1654network={
1655 ssid="example"
1656 key_mgmt=WPA-EAP
1657 eap=TTLS
1658 identity="user@example.com"
1659 anonymous_identity="anonymous@example.com"
1660 password="foobar"
1661 ca_cert="/etc/cert/ca.pem"
1662 priority=2
1663}
1664
1665# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1666# use. Real identity is sent only within an encrypted TLS tunnel.
1667network={
1668 ssid="example"
1669 key_mgmt=WPA-EAP
1670 eap=TTLS
1671 identity="user@example.com"
1672 anonymous_identity="anonymous@example.com"
1673 password="foobar"
1674 ca_cert="/etc/cert/ca.pem"
1675 phase2="auth=MSCHAPV2"
1676}
1677
1678# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1679# authentication.
1680network={
1681 ssid="example"
1682 key_mgmt=WPA-EAP
1683 eap=TTLS
1684 # Phase1 / outer authentication
1685 anonymous_identity="anonymous@example.com"
1686 ca_cert="/etc/cert/ca.pem"
1687 # Phase 2 / inner authentication
1688 phase2="autheap=TLS"
1689 ca_cert2="/etc/cert/ca2.pem"
1690 client_cert2="/etc/cer/user.pem"
1691 private_key2="/etc/cer/user.prv"
1692 private_key2_passwd="password"
1693 priority=2
1694}
1695
1696# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1697# group cipher.
1698network={
1699 ssid="example"
1700 bssid=00:11:22:33:44:55
1701 proto=WPA RSN
1702 key_mgmt=WPA-PSK WPA-EAP
1703 pairwise=CCMP
1704 group=CCMP
1705 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1706}
1707
1708# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1709# and all valid ciphers.
1710network={
1711 ssid=00010203
1712 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1713}
1714
1715
1716# EAP-SIM with a GSM SIM or USIM
1717network={
1718 ssid="eap-sim-test"
1719 key_mgmt=WPA-EAP
1720 eap=SIM
1721 pin="1234"
1722 pcsc=""
1723}
1724
1725
1726# EAP-PSK
1727network={
1728 ssid="eap-psk-test"
1729 key_mgmt=WPA-EAP
1730 eap=PSK
1731 anonymous_identity="eap_psk_user"
1732 password=06b4be19da289f475aa46a33cb793029
1733 identity="eap_psk_user@example.com"
1734}
1735
1736
1737# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1738# EAP-TLS for authentication and key generation; require both unicast and
1739# broadcast WEP keys.
1740network={
1741 ssid="1x-test"
1742 key_mgmt=IEEE8021X
1743 eap=TLS
1744 identity="user@example.com"
1745 ca_cert="/etc/cert/ca.pem"
1746 client_cert="/etc/cert/user.pem"
1747 private_key="/etc/cert/user.prv"
1748 private_key_passwd="password"
1749 eapol_flags=3
1750}
1751
1752
1753# LEAP with dynamic WEP keys
1754network={
1755 ssid="leap-example"
1756 key_mgmt=IEEE8021X
1757 eap=LEAP
1758 identity="user"
1759 password="foobar"
1760}
1761
1762# EAP-IKEv2 using shared secrets for both server and peer authentication
1763network={
1764 ssid="ikev2-example"
1765 key_mgmt=WPA-EAP
1766 eap=IKEV2
1767 identity="user"
1768 password="foobar"
1769}
1770
1771# EAP-FAST with WPA (WPA or WPA2)
1772network={
1773 ssid="eap-fast-test"
1774 key_mgmt=WPA-EAP
1775 eap=FAST
1776 anonymous_identity="FAST-000102030405"
1777 identity="username"
1778 password="password"
1779 phase1="fast_provisioning=1"
1780 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1781}
1782
1783network={
1784 ssid="eap-fast-test"
1785 key_mgmt=WPA-EAP
1786 eap=FAST
1787 anonymous_identity="FAST-000102030405"
1788 identity="username"
1789 password="password"
1790 phase1="fast_provisioning=1"
1791 pac_file="blob://eap-fast-pac"
1792}
1793
1794# Plaintext connection (no WPA, no IEEE 802.1X)
1795network={
1796 ssid="plaintext-test"
1797 key_mgmt=NONE
1798}
1799
1800
1801# Shared WEP key connection (no WPA, no IEEE 802.1X)
1802network={
1803 ssid="static-wep-test"
1804 key_mgmt=NONE
1805 wep_key0="abcde"
1806 wep_key1=0102030405
1807 wep_key2="1234567890123"
1808 wep_tx_keyidx=0
1809 priority=5
1810}
1811
1812
1813# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1814# IEEE 802.11 authentication
1815network={
1816 ssid="static-wep-test2"
1817 key_mgmt=NONE
1818 wep_key0="abcde"
1819 wep_key1=0102030405
1820 wep_key2="1234567890123"
1821 wep_tx_keyidx=0
1822 priority=5
1823 auth_alg=SHARED
1824}
1825
1826
b2838baf
JM
1827# IBSS/ad-hoc network with RSN
1828network={
1829 ssid="ibss-rsn"
1830 key_mgmt=WPA-PSK
1831 proto=RSN
1832 psk="12345678"
1833 mode=1
1834 frequency=2412
1835 pairwise=CCMP
1836 group=CCMP
1837}
1838
1839# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
6fc6879b
JM
1840network={
1841 ssid="test adhoc"
1842 mode=1
1843 frequency=2412
1844 proto=WPA
1845 key_mgmt=WPA-NONE
1846 pairwise=NONE
1847 group=TKIP
1848 psk="secret passphrase"
9e5e03d7
TP
1849}
1850
1851# open mesh network
1852network={
1853 ssid="test mesh"
1854 mode=5
1855 frequency=2437
1856 key_mgmt=NONE
1857}
1858
1859# secure (SAE + AMPE) network
1860network={
1861 ssid="secure mesh"
1862 mode=5
1863 frequency=2437
1864 key_mgmt=SAE
1865 psk="very secret passphrase"
6fc6879b
JM
1866}
1867
1868
1869# Catch all example that allows more or less all configuration modes
1870network={
1871 ssid="example"
1872 scan_ssid=1
1873 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1874 pairwise=CCMP TKIP
1875 group=CCMP TKIP WEP104 WEP40
1876 psk="very secret passphrase"
1877 eap=TTLS PEAP TLS
1878 identity="user@example.com"
1879 password="foobar"
1880 ca_cert="/etc/cert/ca.pem"
1881 client_cert="/etc/cert/user.pem"
1882 private_key="/etc/cert/user.prv"
1883 private_key_passwd="password"
1884 phase1="peaplabel=0"
1885}
1886
1887# Example of EAP-TLS with smartcard (openssl engine)
1888network={
1889 ssid="example"
1890 key_mgmt=WPA-EAP
1891 eap=TLS
1892 proto=RSN
1893 pairwise=CCMP TKIP
1894 group=CCMP TKIP
1895 identity="user@example.com"
1896 ca_cert="/etc/cert/ca.pem"
6fc6879b 1897
f7cb6e9f
DW
1898 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1899 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1900 private_key="pkcs11:manufacturer=piv_II;id=%01"
6fc6879b
JM
1901
1902 # Optional PIN configuration; this can be left out and PIN will be
1903 # asked through the control interface
1904 pin="1234"
1905}
1906
1907# Example configuration showing how to use an inlined blob as a CA certificate
1908# data instead of using external file
1909network={
1910 ssid="example"
1911 key_mgmt=WPA-EAP
1912 eap=TTLS
1913 identity="user@example.com"
1914 anonymous_identity="anonymous@example.com"
1915 password="foobar"
1916 ca_cert="blob://exampleblob"
1917 priority=20
1918}
1919
1920blob-base64-exampleblob={
1921SGVsbG8gV29ybGQhCg==
1922}
1923
1924
1925# Wildcard match for SSID (plaintext APs only). This example select any
1926# open AP regardless of its SSID.
1927network={
1928 key_mgmt=NONE
1929}
f5ffc348 1930
b83e4554
ST
1931# Example configuration blacklisting two APs - these will be ignored
1932# for this network.
1933network={
1934 ssid="example"
1935 psk="very secret passphrase"
1936 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1937}
1938
1939# Example configuration limiting AP selection to a specific set of APs;
79cd993a 1940# any other AP not matching the masked address will be ignored.
b83e4554
ST
1941network={
1942 ssid="example"
1943 psk="very secret passphrase"
79cd993a 1944 bssid_whitelist=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff
b83e4554 1945}
f5ffc348
BG
1946
1947# Example config file that will only scan on channel 36.
1948freq_list=5180
1949network={
1950 key_mgmt=NONE
1951}
dd10abcc
HW
1952
1953
208263c0
JK
1954# Example configuration using EAP-TTLS for authentication and key
1955# generation for MACsec
1956network={
1957 key_mgmt=IEEE8021X
1958 eap=TTLS
1959 phase2="auth=PAP"
1960 anonymous_identity="anonymous@example.com"
1961 identity="user@example.com"
1962 password="secretr"
1963 ca_cert="/etc/cert/ca.pem"
1964 eapol_flags=0
1965 macsec_policy=1
1966}
1967
1968# Example configuration for MACsec with preshared key
1969network={
1970 key_mgmt=NONE
1971 eapol_flags=0
1972 macsec_policy=1
1973 mka_cak=0123456789ABCDEF0123456789ABCDEF
1974 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
1975 mka_priority=128
1976}