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