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