blob: 11d188549b5ca03d79841a9af8cd693af4a4e8a4 [file] [log] [blame]
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001##### Example wpa_supplicant configuration file ###############################
2#
3# This file describes configuration file format and lists all available option.
4# Please also take a look at simpler configuration examples in 'examples'
5# subdirectory.
6#
7# Empty lines and lines starting with # are ignored
8
9# NOTE! This file may contain password information and should probably be made
10# readable only by root user on multiuser systems.
11
12# Note: All file paths in this configuration file should use full (absolute,
13# not relative to working directory) path in order to allow working directory
14# to be changed. This can happen if wpa_supplicant is run in the background.
15
16# Whether to allow wpa_supplicant to update (overwrite) configuration
17#
18# This option can be used to allow wpa_supplicant to overwrite configuration
19# file whenever configuration is changed (e.g., new network block is added with
20# wpa_cli or wpa_gui, or a password is changed). This is required for
21# wpa_cli/wpa_gui to be able to store the configuration changes permanently.
22# Please note that overwriting configuration file will remove the comments from
23# it.
24#update_config=1
25
26# global configuration (shared by all network blocks)
27#
28# Parameters for the control interface. If this is specified, wpa_supplicant
29# will open a control interface that is available for external programs to
30# manage wpa_supplicant. The meaning of this string depends on which control
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -080031# interface mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt30f94812012-02-21 17:02:48 -080032# in configuration is used to determine whether the control interface is
33# enabled.
34#
35# For UNIX domain sockets (default on Linux and BSD): This is a directory that
36# will be created for UNIX domain sockets for listening to requests from
37# external programs (CLI/GUI, etc.) for status information and configuration.
38# The socket file will be named based on the interface name, so multiple
39# wpa_supplicant processes can be run at the same time if more than one
40# interface is used.
41# /var/run/wpa_supplicant is the recommended directory for sockets and by
42# default, wpa_cli will use it when trying to connect with wpa_supplicant.
43#
44# Access control for the control interface can be configured by setting the
45# directory to allow only members of a group to use sockets. This way, it is
46# possible to run wpa_supplicant as root (since it needs to change network
47# configuration and open raw sockets) and still allow GUI/CLI components to be
48# run as non-root users. However, since the control interface can be used to
49# change the network configuration, this access needs to be protected in many
50# cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
51# want to allow non-root users to use the control interface, add a new group
52# and change this value to match with that group. Add users that should have
53# control interface access to this group. If this variable is commented out or
54# not included in the configuration file, group will not be changed from the
55# value it got by default when the directory or socket was created.
56#
57# When configuring both the directory and group, use following format:
58# DIR=/var/run/wpa_supplicant GROUP=wheel
59# DIR=/var/run/wpa_supplicant GROUP=0
60# (group can be either group name or gid)
61#
62# For UDP connections (default on Windows): The value will be ignored. This
63# variable is just used to select that the control interface is to be created.
64# The value can be set to, e.g., udp (ctrl_interface=udp)
65#
66# For Windows Named Pipe: This value can be used to set the security descriptor
67# for controlling access to the control interface. Security descriptor can be
68# set using Security Descriptor String Format (see http://msdn.microsoft.com/
69# library/default.asp?url=/library/en-us/secauthz/security/
70# security_descriptor_string_format.asp). The descriptor string needs to be
71# prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
72# DACL (which will reject all connections). See README-Windows.txt for more
73# information about SDDL string format.
74#
75ctrl_interface=/var/run/wpa_supplicant
76
77# IEEE 802.1X/EAPOL version
78# wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
79# EAPOL version 2. However, there are many APs that do not handle the new
80# version number correctly (they seem to drop the frames completely). In order
81# to make wpa_supplicant interoperate with these APs, the version number is set
82# to 1 by default. This configuration value can be used to set it to the new
83# version (2).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -070084# Note: When using MACsec, eapol_version shall be set to 3, which is
85# defined in IEEE Std 802.1X-2010.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070086eapol_version=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -080087
88# AP scanning/selection
89# By default, wpa_supplicant requests driver to perform AP scanning and then
90# uses the scan results to select a suitable AP. Another alternative is to
91# allow the driver to take care of AP scanning and selection and use
92# wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
93# information from the driver.
94# 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
95# the currently enabled networks are found, a new network (IBSS or AP mode
96# operation) may be initialized (if configured) (default)
Hai Shalomfdcde762020-04-02 11:19:20 -070097# 0: This mode must only be used when using wired Ethernet drivers
98# (including MACsec).
Dmitry Shmidt30f94812012-02-21 17:02:48 -080099# 2: like 0, but associate with APs using security policy and SSID (but not
100# BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
101# enable operation with hidden SSIDs and optimized roaming; in this mode,
102# the network blocks in the configuration file are tried one by one until
103# the driver reports successful association; each network block should have
104# explicit security policy (i.e., only one option in the lists) for
105# key_mgmt, pairwise, group, proto variables
Hai Shalomfdcde762020-04-02 11:19:20 -0700106# Note: ap_scan=0/2 should not be used with the nl80211 driver interface (the
107# current Linux interface). ap_scan=1 is the only option working with nl80211.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800108# For finding networks using hidden SSID, scan_ssid=1 in the network block can
109# be used with nl80211.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800110# When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
111# created immediately regardless of scan results. ap_scan=1 mode will first try
112# to scan for existing networks and only if no matches with the enabled
113# networks are found, a new IBSS or AP mode network is created.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700114ap_scan=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800115
Dmitry Shmidtb70d0bb2015-11-16 10:43:06 -0800116# Whether to force passive scan for network connection
117#
118# By default, scans will send out Probe Request frames on channels that allow
119# active scanning. This advertise the local station to the world. Normally this
120# is fine, but users may wish to do passive scanning where the radio should only
121# listen quietly for Beacon frames and not send any Probe Request frames. Actual
122# functionality may be driver dependent.
123#
124# This parameter can be used to force only passive scanning to be used
125# for network connection cases. It should be noted that this will slow
126# down scan operations and reduce likelihood of finding the AP. In
127# addition, some use cases will override this due to functional
128# requirements, e.g., for finding an AP that uses hidden SSID
129# (scan_ssid=1) or P2P device discovery.
130#
131# 0: Do normal scans (allow active scans) (default)
132# 1: Do passive scans.
133#passive_scan=0
134
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800135# MPM residency
136# By default, wpa_supplicant implements the mesh peering manager (MPM) for an
137# open mesh. However, if the driver can implement the MPM, you may set this to
138# 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
139# always used.
140# 0: MPM lives in the driver
141# 1: wpa_supplicant provides an MPM which handles peering (default)
142#user_mpm=1
143
144# Maximum number of peer links (0-255; default: 99)
145# Maximum number of mesh peering currently maintained by the STA.
146#max_peer_links=99
147
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800148# Timeout in seconds to detect STA inactivity (default: 300 seconds)
149#
150# This timeout value is used in mesh STA to clean up inactive stations.
151#mesh_max_inactivity=300
152
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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800159# 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.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700163fast_reauth=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800164
165# OpenSSL Engine support
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700166# These options can be used to load OpenSSL engines in special or legacy
167# modes.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800168# The two engines that are supported currently are shown below:
169# They are both from the opensc project (http://www.opensc.org/)
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700170# 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.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800173# 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
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800180# OpenSSL cipher string
181#
182# This is an OpenSSL specific configuration option for configuring the default
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700183# ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
184# by default) is used.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800185# 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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800190# 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
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700198# This field can be used to configure arbitrary driver interface parameters. The
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800199# format is specific to the selected driver interface. This field is not used
200# in most cases.
201#driver_param="field=value"
202
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
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
215# Wi-Fi Protected Setup (WPS) parameters
216
217# Universally Unique IDentifier (UUID; see RFC 4122) of the device
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700218# If not configured, UUID will be generated based on the mechanism selected with
219# the auto_uuid parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800220#uuid=12345678-9abc-def0-1234-56789abcdef0
221
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700222# 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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800227# 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)
258#device_type=1-0050F204-1
259
260# OS Version
261# 4-octet operating system version number (hex string)
262#os_version=01020300
263
264# Config Methods
265# List of the supported configuration methods
266# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
267# nfc_interface push_button keypad virtual_display physical_display
268# virtual_push_button physical_push_button
269# For WSC 1.0:
270#config_methods=label display push_button keypad
271# For WSC 2.0:
272#config_methods=label virtual_display virtual_push_button keypad
273
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
281
Hai Shalom021b0b52019-04-10 11:17:58 -0700282# 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
Dmitry Shmidt04949592012-07-19 12:16:46 -0700290# 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
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
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700306# 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
Hai Shalomc3565922019-10-28 11:58:20 -0700311# 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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800331# 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
Hai Shalom5f92bc92019-04-18 11:54:11 -0700338# 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
Dmitry Shmidt04949592012-07-19 12:16:46 -0700347# 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>
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800351# autoscan is like bgscan but on disconnected or inactive state.
352# For instance, on exponential module parameters would be <base>:<limit>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700353#autoscan=exponential:3:300
354# Which means a delay between scans on a base exponential of 3,
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800355# up to the limit of 300 seconds (3, 9, 27 ... 300)
356# For periodic module, parameters would be <fixed interval>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700357#autoscan=periodic:30
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800358# 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.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800361
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
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700367# Password (and passphrase, etc.) backend for external storage
368# format: <backend name>[:<optional backend parameters>]
Hai Shalom60840252021-02-19 19:02:11 -0800369# Test backend which stores passwords in memory. Should only be used for
370# development purposes.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700371#ext_password_backend=test:pw1=password|pw2=testing
Hai Shalom60840252021-02-19 19:02:11 -0800372# 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
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700377
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700378
379# Disable P2P functionality
380# p2p_disabled=1
381
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700382# 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
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700388# 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
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700394# 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
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800401# 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
408
409# Protected Management Frames default
410# This parameter can be used to set the default behavior for the ieee80211w
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700411# 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.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800417#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800418
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800419# Enabled SAE finite cyclic groups in preference order
420# By default (if this parameter is not set), the mandatory group 19 (ECC group
Hai Shalom021b0b52019-04-10 11:17:58 -0700421# 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:
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800425# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
Hai Shalom021b0b52019-04-10 11:17:58 -0700426# 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
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800431
Hai Shalomc3565922019-10-28 11:58:20 -0700432# SAE mechanism for PWE derivation
Hai Shalomfdcde762020-04-02 11:19:20 -0700433# 0 = hunting-and-pecking loop only (default without password identifier)
434# 1 = hash-to-element only (default with password identifier)
Hai Shalomc3565922019-10-28 11:58:20 -0700435# 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.
Hai Shalomfdcde762020-04-02 11:19:20 -0700438# When using SAE password identifier, the hash-to-element mechanism is used
439# regardless of the sae_pwe parameter value.
Hai Shalomc3565922019-10-28 11:58:20 -0700440#sae_pwe=0
441
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800442# 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
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700448# 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
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700455# 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
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700463# 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.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700467
Hai Shalom60840252021-02-19 19:02:11 -0800468# Seconds to consider old scan results valid for association (default: 5)
469#scan_res_valid_for_connect=5
470
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700471# MAC address policy default
472# 0 = use permanent MAC address
473# 1 = use random MAC address for each ESS connection
474# 2 = like 1, but maintain OUI (with local admin bit set)
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
487# 2 = like 1, but maintain OUI (with local admin bit set)
488#preassoc_mac_addr=0
489
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800490# 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)
Hai Shalomb755a2a2020-04-23 21:49:02 -0700494# 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.
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800499#gas_rand_mac_addr=0
500
501# Lifetime of GAS random MAC address in seconds (default: 60)
502#gas_rand_addr_lifetime=60
503
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800504# Interworking (IEEE 802.11u)
505
506# Enable Interworking
507# interworking=1
508
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700509# 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
Hai Shalom60840252021-02-19 19:02:11 -0800539# Homogeneous ESS identifier
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800540# 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
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700545# 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
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700553# 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
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700559# 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
Dmitry Shmidt04949592012-07-19 12:16:46 -0700575# 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#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800583# temporary: Whether this credential is temporary and not to be saved
584#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700585# 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#
593# pcsc: Use PC/SC and SIM/USIM card
594#
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#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700609# 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#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700613# 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#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700623# 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#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700626# 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#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700649# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700650# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700651# 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.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700654#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700655# 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#
Roshan Pius3a1667e2018-07-03 15:17:14 -0700664# 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#
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#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700678# 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#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800689# 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#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800694# 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#
701# update_identifier: PPS MO ID
702# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
703#
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#
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#
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#
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#
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
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800744# 3 = require valid OCSP stapling response for all not-trusted
745# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800746#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700747# sim_num: Identifier for which SIM to use in multi-SIM devices
748#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700749# 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"
761# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
762#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700763#
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#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800774
Dmitry Shmidt04949592012-07-19 12:16:46 -0700775# Hotspot 2.0
776# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800777
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800778# 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
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800799# Multi Band Operation (MBO) non-preferred channels
800# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700801# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800802# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700803# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800804# Example:
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700805# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800806
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
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700813# 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
Hai Shalomfdcde762020-04-02 11:19:20 -0700820# 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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800825# 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#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700842# 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>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800846#
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#
Hai Shalom899fcc72020-10-19 14:38:18 -0700856# 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#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800866# 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)
881# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800882# 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:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800886# 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#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800896# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700897# 0 = do not use PBSS
898# 1 = use PBSS
899# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800900# 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
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700902# 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.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800905# For more details, see IEEE Std 802.11ad-2012.
906#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800907# 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#
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#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700918# 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#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800921# 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"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800937# Explicitly disable bgscan by setting
938# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800939#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800940# 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#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800944# 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)
Hai Shalomce48b4a2018-09-05 11:41:35 -0700947# Note that RSN is used also for WPA3.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800948# 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)
952# WPA-EAP = WPA using EAP authentication
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
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800956# 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
Roshan Pius3a1667e2018-07-03 15:17:14 -0700960# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
961# and using SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800962# 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
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800964# SAE = Simultaneous authentication of equals; pre-shared key/password -based
965# authentication with stronger security than WPA-PSK especially when using
Hai Shalomce48b4a2018-09-05 11:41:35 -0700966# not that strong password; a.k.a. WPA3-Personal
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800967# 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
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800970# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800971# 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
Hai Shalomce48b4a2018-09-05 11:41:35 -0700975# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
976# DPP = Device Provisioning Protocol
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800977# If not set, this defaults to: WPA-PSK WPA-EAP
978#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700979# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800980# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700981# 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
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -0800987# (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
Dmitry Shmidt04949592012-07-19 12:16:46 -0700989#
Hai Shalom74f70d42019-02-11 14:42:39 -0800990# 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)
Hai Shalom60840252021-02-19 19:02:11 -0800994# 1 = enabled if wpa_supplicant's SME in use. Otherwise enabled only when the
995# driver indicates support for operating channel validation.
Hai Shalom74f70d42019-02-11 14:42:39 -0800996#ocv=1
997#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800998# auth_alg: list of allowed IEEE 802.11 authentication algorithms
999# OPEN = Open System authentication (required for WPA/WPA2)
1000# SHARED = Shared Key authentication (requires static WEP keys)
1001# LEAP = LEAP/Network EAP (only used with LEAP)
1002# If not set, automatic selection is used (Open System with LEAP enabled if
1003# LEAP is allowed as one of the EAP methods).
1004#
1005# pairwise: list of accepted pairwise (unicast) ciphers for WPA
1006# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1007# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1008# NONE = Use only Group Keys (deprecated, should not be included if APs support
1009# pairwise keys)
1010# If not set, this defaults to: CCMP TKIP
1011#
1012# group: list of accepted group (broadcast/multicast) ciphers for WPA
1013# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
1014# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
1015# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
1016# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
1017# If not set, this defaults to: CCMP TKIP WEP104 WEP40
1018#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001019# group_mgmt: list of accepted group management ciphers for RSN (PMF)
1020# AES-128-CMAC = BIP-CMAC-128
1021# BIP-GMAC-128
1022# BIP-GMAC-256
1023# BIP-CMAC-256
1024# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
1025# indicates.
1026#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001027# psk: WPA preshared key; 256-bit pre-shared key
1028# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
1029# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
1030# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001031# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
1032# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001033# This field is not needed, if WPA-EAP is used.
1034# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
1035# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
1036# startup and reconfiguration time can be optimized by generating the PSK only
1037# only when the passphrase or SSID has actually changed.
1038#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -07001039# mem_only_psk: Whether to keep PSK/passphrase only in memory
1040# 0 = allow psk/passphrase to be stored to the configuration file
1041# 1 = do not store psk/passphrase to the configuration file
1042#mem_only_psk=0
1043#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001044# sae_password: SAE password
1045# This parameter can be used to set a password for SAE. By default, the
Roshan Pius3a1667e2018-07-03 15:17:14 -07001046# passphrase from the psk parameter is used if this separate parameter is not
1047# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
1048# SAE passwords do not have such constraints.
1049#
1050# sae_password_id: SAE password identifier
1051# This parameter can be used to set an identifier for the SAE password. By
1052# default, no such identifier is used. If set, the specified identifier value
1053# is used by the other peer to select which password to use for authentication.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001054#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001055# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
1056# Dynamic WEP key required for non-WPA mode
1057# bit0 (1): require dynamically generated unicast WEP key
1058# bit1 (2): require dynamically generated broadcast WEP key
1059# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001060# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001061# eapol_flags must be set to 0 for the authentication to be completed
1062# successfully.
1063#
1064# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001065# This determines how sessions are secured with MACsec (only for MACsec
1066# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001067# 0: MACsec not in use (default)
1068# 1: MACsec enabled - Should secure, accept key server's advice to
1069# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001070#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001071# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1072# This setting applies only when MACsec is in use, i.e.,
1073# - macsec_policy is enabled
1074# - the key server has decided to enable MACsec
1075# 0: Encrypt traffic (default)
1076# 1: Integrity only
1077#
Hai Shalom74f70d42019-02-11 14:42:39 -08001078# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1079# This setting applies only when MACsec is in use, i.e.,
1080# - macsec_policy is enabled
1081# - the key server has decided to enable MACsec
1082# 0: Replay protection disabled (default)
1083# 1: Replay protection enabled
1084#
1085# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1086# This determines a window in which replay is tolerated, to allow receipt
1087# of frames that have been misordered by the network.
1088# This setting applies only when MACsec replay protection active, i.e.,
1089# - macsec_replay_protect is enabled
1090# - the key server has decided to enable MACsec
1091# 0: No replay window, strict check (default)
1092# 1..2^32-1: number of packets that could be misordered
1093#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001094# macsec_port: IEEE 802.1X/MACsec port
1095# Port component of the SCI
1096# Range: 1-65534 (default: 1)
1097#
Dmitry Shmidt29333592017-01-09 12:27:11 -08001098# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001099# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -08001100# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1101# with lower priority will become the key server and start distributing SAKs.
Hai Shalom74f70d42019-02-11 14:42:39 -08001102# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1103# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1104# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1105# (2..64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -08001106# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1107# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001108#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001109# mixed_cell: This option can be used to configure whether so called mixed
1110# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001111# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001112# 0 = disabled (default)
1113# 1 = enabled
1114#
1115# proactive_key_caching:
1116# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001117# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001118# 1 = enabled
1119#
Hai Shalom81f62d82019-07-22 12:10:00 -07001120# ft_eap_pmksa_caching:
1121# Whether FT-EAP PMKSA caching is allowed
1122# 0 = do not try to use PMKSA caching with FT-EAP (default)
1123# 1 = try to use PMKSA caching with FT-EAP
1124# This controls whether to try to use PMKSA caching with FT-EAP for the
1125# FT initial mobility domain association.
1126#ft_eap_pmksa_caching=0
1127#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001128# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1129# hex without quotation, e.g., 0102030405)
1130# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1131#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001132# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1133# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1134#
Hai Shalomfdcde762020-04-02 11:19:20 -07001135# wpa_deny_ptk0_rekey: Workaround for PTK rekey issues
1136# PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the
1137# security and stability with some cards.
1138# To avoid the issues wpa_supplicant can replace those PTK rekeys (including
1139# EAP reauthentications) with fast reconnects.
1140#
1141# Available options:
1142# 0 = always rekey when configured/instructed (default)
1143# 1 = only rekey when the local driver is explicitly indicating it can perform
1144# this operation without issues
1145# 2 = never allow problematic PTK0 rekeys
1146#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001147# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1148# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -08001149# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001150#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001151# Following fields are only used with internal EAP implementation.
1152# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001153# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001154# cannot be used with WPA; to be used as a Phase 2 method
1155# with EAP-PEAP or EAP-TTLS)
1156# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1157# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1158# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1159# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1160# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1161# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1162# TLS = EAP-TLS (client and server certificate)
1163# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1164# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1165# authentication)
1166# If not set, all compiled in methods are allowed.
1167#
1168# identity: Identity string for EAP
1169# This field is also used to configure user NAI for
1170# EAP-PSK/PAX/SAKE/GPSK.
1171# anonymous_identity: Anonymous identity string for EAP (to be used as the
1172# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07001173# identity, e.g., EAP-TTLS). This field can also be used with
1174# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001175# password: Password string for EAP. This field can include either the
1176# plaintext password (using ASCII or hex string) or a NtPasswordHash
1177# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1178# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1179# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1180# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1181# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001182# variable length PSK. ext:<name of external password field> format can
1183# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001184# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1185# or more trusted CA certificates. If ca_cert and ca_path are not
1186# included, server certificate will not be verified. This is insecure and
1187# a trusted CA certificate should always be configured when using
1188# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1189# change when wpa_supplicant is run in the background.
1190#
1191# Alternatively, this can be used to only perform matching of the server
1192# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1193# this case, the possible CA certificates in the server certificate chain
1194# are ignored and only the server certificate is verified. This is
1195# configured with the following format:
1196# hash:://server/sha256/cert_hash_in_hex
1197# For example: "hash://server/sha256/
1198# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1199#
1200# On Windows, trusted CA certificates can be loaded from the system
1201# certificate store by setting this to cert_store://<name>, e.g.,
1202# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1203# Note that when running wpa_supplicant as an application, the user
1204# certificate store (My user account) is used, whereas computer store
1205# (Computer account) is used when running wpasvc as a service.
1206# ca_path: Directory path for CA certificate files (PEM). This path may
1207# contain multiple CA certificates in OpenSSL format. Common use for this
1208# is to point to system trusted CA list which is often installed into
1209# directory like /etc/ssl/certs. If configured, these certificates are
1210# added to the list of trusted CAs. ca_cert may also be included in that
1211# case, but it is not required.
1212# client_cert: File path to client certificate file (PEM/DER)
1213# Full path should be used since working directory may change when
1214# wpa_supplicant is run in the background.
1215# Alternatively, a named configuration blob can be used by setting this
1216# to blob://<blob name>.
1217# private_key: File path to client private key file (PEM/DER/PFX)
1218# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1219# commented out. Both the private key and certificate will be read from
1220# the PKCS#12 file in this case. Full path should be used since working
1221# directory may change when wpa_supplicant is run in the background.
1222# Windows certificate store can be used by leaving client_cert out and
1223# configuring private_key in one of the following formats:
1224# cert://substring_to_match
1225# hash://certificate_thumbprint_in_hex
1226# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1227# Note that when running wpa_supplicant as an application, the user
1228# certificate store (My user account) is used, whereas computer store
1229# (Computer account) is used when running wpasvc as a service.
1230# Alternatively, a named configuration blob can be used by setting this
1231# to blob://<blob name>.
1232# private_key_passwd: Password for private key file (if left out, this will be
1233# asked through control interface)
1234# dh_file: File path to DH/DSA parameters file (in PEM format)
1235# This is an optional configuration file for setting parameters for an
1236# ephemeral DH key exchange. In most cases, the default RSA
1237# authentication does not use this configuration. However, it is possible
1238# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1239# DSA keys always use ephemeral DH keys. This can be used to achieve
1240# forward secrecy. If the file is in DSA parameters format, it will be
1241# automatically converted into DH params.
1242# subject_match: Substring to be matched against the subject of the
1243# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001244# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001245# The subject string is in following format:
1246# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001247# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001248# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001249# such a use case, domain_suffix_match or domain_match should be used
1250# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001251# altsubject_match: Semicolon separated string of entries to be matched against
1252# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001253# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001254# contains one of the entries in an alternative subject name extension.
1255# altSubjectName string is in following format: TYPE:VALUE
1256# Example: EMAIL:server@example.com
1257# Example: DNS:server.example.com;DNS:server2.example.com
1258# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001259# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001260# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001261# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1262# constraint is met. If no dNSName values are present, this constraint is
1263# matched against SubjectName CN using same suffix match comparison.
1264#
1265# Suffix match here means that the host/domain name is compared one label
1266# at a time starting from the top-level domain and all the labels in
1267# domain_suffix_match shall be included in the certificate. The
1268# certificate may include additional sub-level labels in addition to the
1269# required labels.
1270#
Hai Shalom021b0b52019-04-10 11:17:58 -07001271# More than one match string can be provided by using semicolons to
1272# separate the strings (e.g., example.org;example.com). When multiple
1273# strings are specified, a match with any one of the values is considered
1274# a sufficient match for the certificate, i.e., the conditions are ORed
1275# together.
1276#
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001277# For example, domain_suffix_match=example.com would match
1278# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001279# domain_match: Constraint for server domain name
1280# If set, this FQDN is used as a full match requirement for the
1281# server certificate in SubjectAltName dNSName element(s). If a
1282# matching dNSName is found, this constraint is met. If no dNSName
1283# values are present, this constraint is matched against SubjectName CN
1284# using same full match comparison. This behavior is similar to
1285# domain_suffix_match, but has the requirement of a full match, i.e.,
1286# no subdomains or wildcard matches are allowed. Case-insensitive
1287# comparison is used, so "Example.com" matches "example.com", but would
1288# not match "test.Example.com".
Hai Shalom021b0b52019-04-10 11:17:58 -07001289#
1290# More than one match string can be provided by using semicolons to
1291# separate the strings (e.g., example.org;example.com). When multiple
1292# strings are specified, a match with any one of the values is considered
1293# a sufficient match for the certificate, i.e., the conditions are ORed
1294# together.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001295# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1296# (string with field-value pairs, e.g., "peapver=0" or
1297# "peapver=1 peaplabel=1")
1298# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1299# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1300# to be used during key derivation when PEAPv1 or newer. Most existing
1301# PEAPv1 implementation seem to be using the old label, "client EAP
1302# encryption", and wpa_supplicant is now using that as the default value.
1303# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1304# interoperate with PEAPv1; see eap_testing.txt for more details.
1305# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1306# tunneled EAP-Success. This is required with some RADIUS servers that
1307# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1308# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1309# include_tls_length=1 can be used to force wpa_supplicant to include
1310# TLS Message Length field in all TLS messages even if they are not
1311# fragmented.
1312# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1313# challenges (by default, it accepts 2 or 3)
1314# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1315# protected result indication.
1316# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1317# behavior:
1318# * 0 = do not use cryptobinding (default)
1319# * 1 = use cryptobinding if server supports it
1320# * 2 = require cryptobinding
1321# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1322# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001323#
1324# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1325# used to configure a mode that allows EAP-Success (and EAP-Failure)
1326# without going through authentication step. Some switches use such
1327# sequence when forcing the port to be authorized/unauthorized or as a
1328# fallback option if the authentication server is unreachable. By default,
1329# wpa_supplicant discards such frames to protect against potential attacks
1330# by rogue devices, but this option can be used to disable that protection
1331# for cases where the server/authenticator does not need to be
1332# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001333# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1334# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001335# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1336# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001337#
1338# TLS-based methods can use the following parameters to control TLS behavior
1339# (these are normally in the phase1 parameter, but can be used also in the
1340# phase2 parameter when EAP-TLS is used within the inner tunnel):
1341# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1342# TLS library, these may be disabled by default to enforce stronger
1343# security)
1344# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1345# the TLS library to accept certificates even if they are not currently
1346# valid, i.e., have expired or have not yet become valid; this should be
1347# used only for testing purposes)
1348# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1349# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1350# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1351# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001352# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001353# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1354# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001355# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Hai Shalom74f70d42019-02-11 14:42:39 -08001356# tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1357# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001358# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1359# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001360# tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1361# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001362# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1363# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001364# tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1365# systemwide TLS policies to be overridden)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001366# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1367# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001368# tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001369# tls_ext_cert_check=0 - No external server certificate validation (default)
1370# tls_ext_cert_check=1 - External server certificate validation enabled; this
1371# requires an external program doing validation of server certificate
1372# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1373# interface and report the result of the validation with
1374# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001375# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1376# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1377# particular when using Suite B with RSA keys of >= 3K (3072) bits
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001378#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001379# Following certificate/private key fields are used in inner Phase2
1380# authentication when using EAP-TTLS or EAP-PEAP.
1381# ca_cert2: File path to CA certificate file. This file can have one or more
1382# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1383# server certificate will not be verified. This is insecure and a trusted
1384# CA certificate should always be configured.
1385# ca_path2: Directory path for CA certificate files (PEM)
1386# client_cert2: File path to client certificate file
1387# private_key2: File path to client private key file
1388# private_key2_passwd: Password for private key file
1389# dh_file2: File path to DH/DSA parameters file (in PEM format)
1390# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001391# authentication server certificate. See subject_match for more details.
1392# altsubject_match2: Semicolon separated string of entries to be matched
1393# against the alternative subject name of the authentication server
1394# certificate. See altsubject_match documentation for more details.
1395# domain_suffix_match2: Constraint for server domain name. See
1396# domain_suffix_match for more details.
Hai Shalomc3565922019-10-28 11:58:20 -07001397# ocsp2: See ocsp for more details.
1398#
1399# Separate machine credentials can be configured for EAP-TEAP Phase 2 with
1400# "machine_" prefix (e.g., "machine_identity") in the configuration parameters.
1401# See the parameters without that prefix for more details on the meaning and
1402# format of each such parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001403#
1404# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1405# This value limits the fragment size for EAP methods that support
1406# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1407# small enough to make the EAP messages fit in MTU of the network
1408# interface used for EAPOL. The default value is suitable for most
1409# cases.
1410#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001411# ocsp: Whether to use/require OCSP to check server certificate
1412# 0 = do not use OCSP stapling (TLS certificate status extension)
1413# 1 = try to use OCSP stapling, but not require response
1414# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001415# 3 = require valid OCSP stapling response for all not-trusted
1416# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001417#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001418# openssl_ciphers: OpenSSL specific cipher configuration
1419# This can be used to override the global openssl_ciphers configuration
1420# parameter (see above).
1421#
1422# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1423#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001424# EAP-FAST variables:
1425# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1426# to create this file and write updates to it when PAC is being
1427# provisioned or refreshed. Full path to the file should be used since
1428# working directory may change when wpa_supplicant is run in the
1429# background. Alternatively, a named configuration blob can be used by
1430# setting this to blob://<blob name>
1431# phase1: fast_provisioning option can be used to enable in-line provisioning
1432# of EAP-FAST credentials (PAC):
1433# 0 = disabled,
1434# 1 = allow unauthenticated provisioning,
1435# 2 = allow authenticated provisioning,
1436# 3 = allow both unauthenticated and authenticated provisioning
1437# fast_max_pac_list_len=<num> option can be used to set the maximum
1438# number of PAC entries to store in a PAC list (default: 10)
1439# fast_pac_format=binary option can be used to select binary format for
1440# storing PAC entries in order to save some space (the default
1441# text format uses about 2.5 times the size of minimal binary
1442# format)
1443#
1444# wpa_supplicant supports number of "EAP workarounds" to work around
1445# interoperability issues with incorrectly behaving authentication servers.
1446# These are enabled by default because some of the issues are present in large
1447# number of authentication servers. Strict EAP conformance mode can be
1448# configured by disabling workarounds with eap_workaround=0.
1449
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001450# update_identifier: PPS MO ID
1451# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001452#
1453# roaming_consortium_selection: Roaming Consortium Selection
1454# The matching Roaming Consortium OI that was used to generate this
1455# network profile.
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001456
Dmitry Shmidt04949592012-07-19 12:16:46 -07001457# Station inactivity limit
1458#
1459# If a station does not send anything in ap_max_inactivity seconds, an
1460# empty data frame is sent to it in order to verify whether it is
1461# still in range. If this frame is not ACKed, the station will be
1462# disassociated and then deauthenticated. This feature is used to
1463# clear station table of old entries when the STAs move out of the
1464# range.
1465#
1466# The station can associate again with the AP if it is still in range;
1467# this inactivity poll is just used as a nicer way of verifying
1468# inactivity; i.e., client will not report broken connection because
1469# disassociation frame is not sent immediately without first polling
1470# the STA with a data frame.
1471# default: 300 (i.e., 5 minutes)
1472#ap_max_inactivity=300
1473
1474# DTIM period in Beacon intervals for AP mode (default: 2)
1475#dtim_period=2
1476
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001477# Beacon interval (default: 100 TU)
1478#beacon_int=100
1479
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001480# WPS in AP mode
1481# 0 = WPS enabled and configured (default)
1482# 1 = WPS disabled
1483#wps_disabled=0
1484
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001485# FILS DH Group
1486# 0 = PFS disabled with FILS shared key authentication (default)
1487# 1-65535 = DH Group to use for FILS PFS
1488#fils_dh_group=0
1489
Hai Shalomfdcde762020-04-02 11:19:20 -07001490# DPP PFS
1491# 0: allow PFS to be used or not used (default)
1492# 1: require PFS to be used (note: not compatible with DPP R1)
1493# 2: do not allow PFS to be used
1494#dpp_pfs=0
1495
Hai Shalom60840252021-02-19 19:02:11 -08001496# Whether beacon protection is enabled
1497# This depends on management frame protection (ieee80211w) being enabled and
1498# beacon protection support indication from the driver.
1499# 0 = disabled (default)
1500# 1 = enabled
Hai Shalom899fcc72020-10-19 14:38:18 -07001501#beacon_prot=0
1502
1503# OWE DH Group
1504# 0: use default (19) first and then try all supported groups one by one if AP
1505# rejects the selected group
1506# 1-65535: DH Group to use for OWE
1507# Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
1508# currently supported.
1509#owe_group=0
1510
1511# OWE-only mode (disable transition mode)
1512# 0: enable transition mode (allow connection to either OWE or open BSS)
1513# 1 = disable transition mode (allow connection only with OWE)
1514#owe_only=0
1515
1516# OWE PTK derivation workaround
1517# Initial OWE implementation used SHA256 when deriving the PTK for all
1518# OWE groups. This was supposed to change to SHA384 for group 20 and
1519# SHA512 for group 21. This parameter can be used to enable older
1520# behavior mainly for testing purposes. There is no impact to group 19
1521# behavior, but if enabled, this will make group 20 and 21 cases use
1522# SHA256-based PTK derivation which will not work with the updated
1523# OWE implementation on the AP side.
1524#owe_ptk_workaround=0
1525
1526# Transition Disable indication
1527# The AP can notify authenticated stations to disable transition mode
1528# in their network profiles when the network has completed transition
1529# steps, i.e., once sufficiently large number of APs in the ESS have
1530# been updated to support the more secure alternative. When this
1531# indication is used, the stations are expected to automatically
1532# disable transition mode and less secure security options. This
1533# includes use of WEP, TKIP (including use of TKIP as the group
1534# cipher), and connections without PMF.
1535# Bitmap bits:
1536# bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK
1537# and only allow SAE to be used)
1538# bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
1539# bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
1540# bit 3 (0x08): Enhanced Open (disable use of open network; require
1541# OWE)
1542
1543# SAE-PK mode
1544# 0: automatic SAE/SAE-PK selection based on password; enable
1545# transition mode (allow SAE authentication without SAE-PK)
1546# 1: SAE-PK only (disable transition mode; allow SAE authentication
1547# only with SAE-PK)
1548# 2: disable SAE-PK (allow SAE authentication only without SAE-PK)
1549#sae_pk=0
1550
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001551# MAC address policy
1552# 0 = use permanent MAC address
1553# 1 = use random MAC address for each ESS connection
1554# 2 = like 1, but maintain OUI (with local admin bit set)
1555#mac_addr=0
1556
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001557# disable_ht: Whether HT (802.11n) should be disabled.
1558# 0 = HT enabled (if AP supports it)
1559# 1 = HT disabled
1560#
1561# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1562# 0 = HT-40 enabled (if AP supports it)
1563# 1 = HT-40 disabled
1564#
1565# disable_sgi: Whether SGI (short guard interval) should be disabled.
1566# 0 = SGI enabled (if AP supports it)
1567# 1 = SGI disabled
1568#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001569# disable_ldpc: Whether LDPC should be disabled.
1570# 0 = LDPC enabled (if AP supports it)
1571# 1 = LDPC disabled
1572#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001573# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1574# 0 = 40 MHz tolerant (default)
1575# 1 = 40 MHz intolerant
1576#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001577# ht_mcs: Configure allowed MCS rates.
1578# Parsed as an array of bytes, in base-16 (ascii-hex)
1579# ht_mcs="" // Use all available (default)
1580# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1581# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1582#
1583# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1584# -1 = Do not make any changes.
1585# 0 = Enable MAX-AMSDU if hardware supports it.
1586# 1 = Disable AMSDU
1587#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001588# ampdu_factor: Maximum A-MPDU Length Exponent
1589# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1590#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001591# ampdu_density: Allow overriding AMPDU density configuration.
1592# Treated as hint by the kernel.
1593# -1 = Do not make any changes.
1594# 0-3 = Set AMPDU density (aka factor) to specified value.
Hai Shalom74f70d42019-02-11 14:42:39 -08001595#
1596# tx_stbc: Allow overriding STBC support for TX streams
1597# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1598# -1 = Do not make any changes (default)
1599# 0 = Set if not supported
1600# 1 = Set if supported
1601#
1602# rx_stbc: Allow overriding STBC support for RX streams
1603# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1604# -1 = Do not make any changes (default)
1605# 0 = Set if not supported
1606# 1 = Set for support of one spatial stream
1607# 2 = Set for support of one and two spatial streams
1608# 3 = Set for support of one, two and three spatial streams
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001609
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001610# disable_vht: Whether VHT should be disabled.
1611# 0 = VHT enabled (if AP supports it)
1612# 1 = VHT disabled
1613#
1614# vht_capa: VHT capabilities to set in the override
1615# vht_capa_mask: mask of VHT capabilities
1616#
1617# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1618# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1619# 0: MCS 0-7
1620# 1: MCS 0-8
1621# 2: MCS 0-9
1622# 3: not supported
1623
Hai Shalom74f70d42019-02-11 14:42:39 -08001624# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1625# 0 = normal STA (default)
1626# 1 = backhaul STA
1627# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1628# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1629# added to a bridge to allow forwarding frames over this backhaul link.
1630
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001631##### Fast Session Transfer (FST) support #####################################
1632#
1633# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001634# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1635# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001636#
1637# FST is the transfer of a session from a channel to another channel, in the
1638# same or different frequency bands.
1639#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001640# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001641
1642# Identifier of an FST Group the interface belongs to.
1643#fst_group_id=bond0
1644
1645# Interface priority within the FST Group.
1646# Announcing a higher priority for an interface means declaring it more
1647# preferable for FST switch.
1648# fst_priority is in 1..255 range with 1 being the lowest priority.
1649#fst_priority=100
1650
1651# Default LLT value for this interface in milliseconds. The value used in case
1652# no value provided during session setup. Default is 50 msec.
1653# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1654# Transitioning between states).
1655#fst_llt=100
1656
Hai Shalom81f62d82019-07-22 12:10:00 -07001657# BSS Transition Management
1658# disable_btm - Disable BSS transition management in STA
1659# Set to 0 to enable BSS transition management (default behavior)
1660# Set to 1 to disable BSS transition management
1661#disable_btm=0
1662
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001663# This value is used to set where to perform roaming logic
1664# Set to 0 to handle roaming logic fully in supplicant
1665# Set to 1 to skip roaming logic in supplicant and handle it in firmware
1666# In supplicant, just parse BTM frame and notify framework
1667#btm_offload=0
1668
Hai Shalomc3565922019-10-28 11:58:20 -07001669# Enable EDMG capability in STA/AP mode, default value is false
1670#enable_edmg=1
1671
1672# This value is used to configure the channel bonding feature.
1673# Default value is 0.
1674# Relevant only if enable_edmg is true
1675# In AP mode it defines the EDMG channel to use for AP operation.
1676# In STA mode it defines the EDMG channel for connection (if supported by AP).
1677#edmg_channel=9
1678
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001679# Example blocks:
1680
1681# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1682network={
1683 ssid="simple"
1684 psk="very secret passphrase"
1685 priority=5
1686}
1687
1688# Same as previous, but request SSID-specific scanning (for APs that reject
1689# broadcast SSID)
1690network={
1691 ssid="second ssid"
1692 scan_ssid=1
1693 psk="very secret passphrase"
1694 priority=2
1695}
1696
1697# Only WPA-PSK is used. Any valid cipher combination is accepted.
1698network={
1699 ssid="example"
1700 proto=WPA
1701 key_mgmt=WPA-PSK
1702 pairwise=CCMP TKIP
1703 group=CCMP TKIP WEP104 WEP40
1704 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1705 priority=2
1706}
1707
1708# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1709network={
1710 ssid="example"
1711 proto=WPA
1712 key_mgmt=WPA-PSK
1713 pairwise=TKIP
1714 group=TKIP
1715 psk="not so secure passphrase"
1716 wpa_ptk_rekey=600
1717}
1718
1719# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1720# or WEP40 as the group cipher will not be accepted.
1721network={
1722 ssid="example"
1723 proto=RSN
1724 key_mgmt=WPA-EAP
1725 pairwise=CCMP TKIP
1726 group=CCMP TKIP
1727 eap=TLS
1728 identity="user@example.com"
1729 ca_cert="/etc/cert/ca.pem"
1730 client_cert="/etc/cert/user.pem"
1731 private_key="/etc/cert/user.prv"
1732 private_key_passwd="password"
1733 priority=1
1734}
1735
1736# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1737# (e.g., Radiator)
1738network={
1739 ssid="example"
1740 key_mgmt=WPA-EAP
1741 eap=PEAP
1742 identity="user@example.com"
1743 password="foobar"
1744 ca_cert="/etc/cert/ca.pem"
1745 phase1="peaplabel=1"
1746 phase2="auth=MSCHAPV2"
1747 priority=10
1748}
1749
1750# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1751# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1752network={
1753 ssid="example"
1754 key_mgmt=WPA-EAP
1755 eap=TTLS
1756 identity="user@example.com"
1757 anonymous_identity="anonymous@example.com"
1758 password="foobar"
1759 ca_cert="/etc/cert/ca.pem"
1760 priority=2
1761}
1762
1763# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1764# use. Real identity is sent only within an encrypted TLS tunnel.
1765network={
1766 ssid="example"
1767 key_mgmt=WPA-EAP
1768 eap=TTLS
1769 identity="user@example.com"
1770 anonymous_identity="anonymous@example.com"
1771 password="foobar"
1772 ca_cert="/etc/cert/ca.pem"
1773 phase2="auth=MSCHAPV2"
1774}
1775
1776# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1777# authentication.
1778network={
1779 ssid="example"
1780 key_mgmt=WPA-EAP
1781 eap=TTLS
1782 # Phase1 / outer authentication
1783 anonymous_identity="anonymous@example.com"
1784 ca_cert="/etc/cert/ca.pem"
1785 # Phase 2 / inner authentication
1786 phase2="autheap=TLS"
1787 ca_cert2="/etc/cert/ca2.pem"
1788 client_cert2="/etc/cer/user.pem"
1789 private_key2="/etc/cer/user.prv"
1790 private_key2_passwd="password"
1791 priority=2
1792}
1793
1794# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1795# group cipher.
1796network={
1797 ssid="example"
1798 bssid=00:11:22:33:44:55
1799 proto=WPA RSN
1800 key_mgmt=WPA-PSK WPA-EAP
1801 pairwise=CCMP
1802 group=CCMP
1803 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1804}
1805
1806# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1807# and all valid ciphers.
1808network={
1809 ssid=00010203
1810 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1811}
1812
1813
1814# EAP-SIM with a GSM SIM or USIM
1815network={
1816 ssid="eap-sim-test"
1817 key_mgmt=WPA-EAP
1818 eap=SIM
1819 pin="1234"
1820 pcsc=""
1821}
1822
1823
1824# EAP-PSK
1825network={
1826 ssid="eap-psk-test"
1827 key_mgmt=WPA-EAP
1828 eap=PSK
1829 anonymous_identity="eap_psk_user"
1830 password=06b4be19da289f475aa46a33cb793029
1831 identity="eap_psk_user@example.com"
1832}
1833
1834
1835# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1836# EAP-TLS for authentication and key generation; require both unicast and
1837# broadcast WEP keys.
1838network={
1839 ssid="1x-test"
1840 key_mgmt=IEEE8021X
1841 eap=TLS
1842 identity="user@example.com"
1843 ca_cert="/etc/cert/ca.pem"
1844 client_cert="/etc/cert/user.pem"
1845 private_key="/etc/cert/user.prv"
1846 private_key_passwd="password"
1847 eapol_flags=3
1848}
1849
1850
1851# LEAP with dynamic WEP keys
1852network={
1853 ssid="leap-example"
1854 key_mgmt=IEEE8021X
1855 eap=LEAP
1856 identity="user"
1857 password="foobar"
1858}
1859
1860# EAP-IKEv2 using shared secrets for both server and peer authentication
1861network={
1862 ssid="ikev2-example"
1863 key_mgmt=WPA-EAP
1864 eap=IKEV2
1865 identity="user"
1866 password="foobar"
1867}
1868
1869# EAP-FAST with WPA (WPA or WPA2)
1870network={
1871 ssid="eap-fast-test"
1872 key_mgmt=WPA-EAP
1873 eap=FAST
1874 anonymous_identity="FAST-000102030405"
1875 identity="username"
1876 password="password"
1877 phase1="fast_provisioning=1"
1878 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1879}
1880
1881network={
1882 ssid="eap-fast-test"
1883 key_mgmt=WPA-EAP
1884 eap=FAST
1885 anonymous_identity="FAST-000102030405"
1886 identity="username"
1887 password="password"
1888 phase1="fast_provisioning=1"
1889 pac_file="blob://eap-fast-pac"
1890}
1891
1892# Plaintext connection (no WPA, no IEEE 802.1X)
1893network={
1894 ssid="plaintext-test"
1895 key_mgmt=NONE
1896}
1897
1898
1899# Shared WEP key connection (no WPA, no IEEE 802.1X)
1900network={
1901 ssid="static-wep-test"
1902 key_mgmt=NONE
1903 wep_key0="abcde"
1904 wep_key1=0102030405
1905 wep_key2="1234567890123"
1906 wep_tx_keyidx=0
1907 priority=5
1908}
1909
1910
1911# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1912# IEEE 802.11 authentication
1913network={
1914 ssid="static-wep-test2"
1915 key_mgmt=NONE
1916 wep_key0="abcde"
1917 wep_key1=0102030405
1918 wep_key2="1234567890123"
1919 wep_tx_keyidx=0
1920 priority=5
1921 auth_alg=SHARED
1922}
1923
1924
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001925# IBSS/ad-hoc network with RSN
1926network={
1927 ssid="ibss-rsn"
1928 key_mgmt=WPA-PSK
1929 proto=RSN
1930 psk="12345678"
1931 mode=1
1932 frequency=2412
1933 pairwise=CCMP
1934 group=CCMP
1935}
1936
1937# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001938network={
1939 ssid="test adhoc"
1940 mode=1
1941 frequency=2412
1942 proto=WPA
1943 key_mgmt=WPA-NONE
1944 pairwise=NONE
1945 group=TKIP
1946 psk="secret passphrase"
1947}
1948
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001949# open mesh network
1950network={
1951 ssid="test mesh"
1952 mode=5
1953 frequency=2437
1954 key_mgmt=NONE
1955}
1956
1957# secure (SAE + AMPE) network
1958network={
1959 ssid="secure mesh"
1960 mode=5
1961 frequency=2437
1962 key_mgmt=SAE
1963 psk="very secret passphrase"
1964}
1965
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001966
1967# Catch all example that allows more or less all configuration modes
1968network={
1969 ssid="example"
1970 scan_ssid=1
1971 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1972 pairwise=CCMP TKIP
1973 group=CCMP TKIP WEP104 WEP40
1974 psk="very secret passphrase"
1975 eap=TTLS PEAP TLS
1976 identity="user@example.com"
1977 password="foobar"
1978 ca_cert="/etc/cert/ca.pem"
1979 client_cert="/etc/cert/user.pem"
1980 private_key="/etc/cert/user.prv"
1981 private_key_passwd="password"
1982 phase1="peaplabel=0"
1983}
1984
1985# Example of EAP-TLS with smartcard (openssl engine)
1986network={
1987 ssid="example"
1988 key_mgmt=WPA-EAP
1989 eap=TLS
1990 proto=RSN
1991 pairwise=CCMP TKIP
1992 group=CCMP TKIP
1993 identity="user@example.com"
1994 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001995
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001996 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1997 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1998 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001999
2000 # Optional PIN configuration; this can be left out and PIN will be
2001 # asked through the control interface
2002 pin="1234"
2003}
2004
2005# Example configuration showing how to use an inlined blob as a CA certificate
2006# data instead of using external file
2007network={
2008 ssid="example"
2009 key_mgmt=WPA-EAP
2010 eap=TTLS
2011 identity="user@example.com"
2012 anonymous_identity="anonymous@example.com"
2013 password="foobar"
2014 ca_cert="blob://exampleblob"
2015 priority=20
2016}
2017
2018blob-base64-exampleblob={
2019SGVsbG8gV29ybGQhCg==
2020}
2021
2022
2023# Wildcard match for SSID (plaintext APs only). This example select any
2024# open AP regardless of its SSID.
2025network={
2026 key_mgmt=NONE
2027}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002028
Hai Shalom60840252021-02-19 19:02:11 -08002029# Example configuration ignoring two APs - these will be ignored
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002030# for this network.
2031network={
2032 ssid="example"
2033 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002034 bssid_ignore=02:11:22:33:44:55 02:22:aa:44:55:66
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002035}
2036
2037# Example configuration limiting AP selection to a specific set of APs;
2038# any other AP not matching the masked address will be ignored.
2039network={
2040 ssid="example"
2041 psk="very secret passphrase"
Hai Shalom60840252021-02-19 19:02:11 -08002042 bssid_accept=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff
Dmitry Shmidtff787d52015-01-12 13:01:47 -08002043}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07002044
2045# Example config file that will only scan on channel 36.
2046freq_list=5180
2047network={
2048 key_mgmt=NONE
2049}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002050
2051
Roshan Pius3a1667e2018-07-03 15:17:14 -07002052# Example configuration using EAP-TTLS for authentication and key
2053# generation for MACsec
2054network={
2055 key_mgmt=IEEE8021X
2056 eap=TTLS
2057 phase2="auth=PAP"
2058 anonymous_identity="anonymous@example.com"
2059 identity="user@example.com"
2060 password="secretr"
2061 ca_cert="/etc/cert/ca.pem"
2062 eapol_flags=0
2063 macsec_policy=1
2064}
2065
2066# Example configuration for MACsec with preshared key
2067network={
2068 key_mgmt=NONE
2069 eapol_flags=0
2070 macsec_policy=1
2071 mka_cak=0123456789ABCDEF0123456789ABCDEF
2072 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
2073 mka_priority=128
2074}