blob: f242c3a9e0406b9fe8778f0fc0a8d36baad70cfc [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>]
369#ext_password_backend=test:pw1=password|pw2=testing
370
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700371
372# Disable P2P functionality
373# p2p_disabled=1
374
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700375# Timeout in seconds to detect STA inactivity (default: 300 seconds)
376#
377# This timeout value is used in P2P GO mode to clean up
378# inactive stations.
379#p2p_go_max_inactivity=300
380
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700381# Passphrase length (8..63) for P2P GO
382#
383# This parameter controls the length of the random passphrase that is
384# generated at the GO. Default: 8.
385#p2p_passphrase_len=8
386
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700387# Extra delay between concurrent P2P search iterations
388#
389# This value adds extra delay in milliseconds between concurrent search
390# iterations to make p2p_find friendlier to concurrent operations by avoiding
391# it from taking 100% of radio resources. The default value is 500 ms.
392#p2p_search_delay=500
393
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800394# Opportunistic Key Caching (also known as Proactive Key Caching) default
395# This parameter can be used to set the default behavior for the
396# proactive_key_caching parameter. By default, OKC is disabled unless enabled
397# with the global okc=1 parameter or with the per-network
398# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
399# can be disabled with per-network proactive_key_caching=0 parameter.
400#okc=0
401
402# Protected Management Frames default
403# This parameter can be used to set the default behavior for the ieee80211w
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700404# parameter for RSN networks. By default, PMF is disabled unless enabled with
405# the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
406# With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
407# per-network ieee80211w parameter. This global default value does not apply
408# for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
409# RSN.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800410#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800411
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800412# Enabled SAE finite cyclic groups in preference order
413# By default (if this parameter is not set), the mandatory group 19 (ECC group
Hai Shalom021b0b52019-04-10 11:17:58 -0700414# defined over a 256-bit prime order field, NIST P-256) is preferred and groups
415# 20 (NIST P-384) and 21 (NIST P-521) are also enabled. If this parameter is
416# set, the groups will be tried in the indicated order.
417# The group values are listed in the IANA registry:
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800418# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
Hai Shalom021b0b52019-04-10 11:17:58 -0700419# Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
420# purposes due limited security (see RFC 8247). Groups that are not as strong as
421# group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
422# since all implementations are required to support group 19.
423#sae_groups=19 20 21
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800424
Hai Shalomc3565922019-10-28 11:58:20 -0700425# SAE mechanism for PWE derivation
Hai Shalomfdcde762020-04-02 11:19:20 -0700426# 0 = hunting-and-pecking loop only (default without password identifier)
427# 1 = hash-to-element only (default with password identifier)
Hai Shalomc3565922019-10-28 11:58:20 -0700428# 2 = both hunting-and-pecking loop and hash-to-element enabled
429# Note: The default value is likely to change from 0 to 2 once the new
430# hash-to-element mechanism has received more interoperability testing.
Hai Shalomfdcde762020-04-02 11:19:20 -0700431# When using SAE password identifier, the hash-to-element mechanism is used
432# regardless of the sae_pwe parameter value.
Hai Shalomc3565922019-10-28 11:58:20 -0700433#sae_pwe=0
434
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800435# Default value for DTIM period (if not overridden in network block)
436#dtim_period=2
437
438# Default value for Beacon interval (if not overridden in network block)
439#beacon_int=100
440
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700441# Additional vendor specific elements for Beacon and Probe Response frames
442# This parameter can be used to add additional vendor specific element(s) into
443# the end of the Beacon and Probe Response frames. The format for these
444# element(s) is a hexdump of the raw information elements (id+len+payload for
445# one or more elements). This is used in AP and P2P GO modes.
446#ap_vendor_elements=dd0411223301
447
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700448# Ignore scan results older than request
449#
450# The driver may have a cache of scan results that makes it return
451# information that is older than our scan trigger. This parameter can
452# be used to configure such old information to be ignored instead of
453# allowing it to update the internal BSS table.
454#ignore_old_scan_res=0
455
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700456# scan_cur_freq: Whether to scan only the current frequency
457# 0: Scan all available frequencies. (Default)
458# 1: Scan current operating frequency if another VIF on the same radio
459# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700460
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700461# MAC address policy default
462# 0 = use permanent MAC address
463# 1 = use random MAC address for each ESS connection
464# 2 = like 1, but maintain OUI (with local admin bit set)
465#
466# By default, permanent MAC address is used unless policy is changed by
467# the per-network mac_addr parameter. Global mac_addr=1 can be used to
468# change this default behavior.
469#mac_addr=0
470
471# Lifetime of random MAC address in seconds (default: 60)
472#rand_addr_lifetime=60
473
474# MAC address policy for pre-association operations (scanning, ANQP)
475# 0 = use permanent MAC address
476# 1 = use random MAC address
477# 2 = like 1, but maintain OUI (with local admin bit set)
478#preassoc_mac_addr=0
479
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800480# MAC address policy for GAS operations
481# 0 = use permanent MAC address
482# 1 = use random MAC address
483# 2 = like 1, but maintain OUI (with local admin bit set)
484#gas_rand_mac_addr=0
485
486# Lifetime of GAS random MAC address in seconds (default: 60)
487#gas_rand_addr_lifetime=60
488
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800489# Interworking (IEEE 802.11u)
490
491# Enable Interworking
492# interworking=1
493
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700494# Enable P2P GO advertisement of Interworking
495# go_interworking=1
496
497# P2P GO Interworking: Access Network Type
498# 0 = Private network
499# 1 = Private network with guest access
500# 2 = Chargeable public network
501# 3 = Free public network
502# 4 = Personal device network
503# 5 = Emergency services only network
504# 14 = Test or experimental
505# 15 = Wildcard
506#go_access_network_type=0
507
508# P2P GO Interworking: Whether the network provides connectivity to the Internet
509# 0 = Unspecified
510# 1 = Network provides connectivity to the Internet
511#go_internet=1
512
513# P2P GO Interworking: Group Venue Info (optional)
514# The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
515# Example values (group,type):
516# 0,0 = Unspecified
517# 1,7 = Convention Center
518# 1,13 = Coffee Shop
519# 2,0 = Unspecified Business
520# 7,1 Private Residence
521#go_venue_group=7
522#go_venue_type=1
523
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800524# Homogenous ESS identifier
525# If this is set, scans will be used to request response only from BSSes
526# belonging to the specified Homogeneous ESS. This is used only if interworking
527# is enabled.
528# hessid=00:11:22:33:44:55
529
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700530# Automatic network selection behavior
531# 0 = do not automatically go through Interworking network selection
532# (i.e., require explicit interworking_select command for this; default)
533# 1 = perform Interworking network selection if one or more
534# credentials have been configured and scan did not find a
535# matching network block
536#auto_interworking=0
537
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700538# GAS Address3 field behavior
539# 0 = P2P specification (Address3 = AP BSSID); default
540# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
541# sent to not-associated AP; if associated, AP BSSID)
542#gas_address3=0
543
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700544# Publish fine timing measurement (FTM) responder functionality in
545# the Extended Capabilities element bit 70.
546# Controls whether FTM responder functionality will be published by AP/STA.
547# Note that actual FTM responder operation is managed outside wpa_supplicant.
548# 0 = Do not publish; default
549# 1 = Publish
550#ftm_responder=0
551
552# Publish fine timing measurement (FTM) initiator functionality in
553# the Extended Capabilities element bit 71.
554# Controls whether FTM initiator functionality will be published by AP/STA.
555# Note that actual FTM initiator operation is managed outside wpa_supplicant.
556# 0 = Do not publish; default
557# 1 = Publish
558#ftm_initiator=0
559
Dmitry Shmidt04949592012-07-19 12:16:46 -0700560# credential block
561#
562# Each credential used for automatic network selection is configured as a set
563# of parameters that are compared to the information advertised by the APs when
564# interworking_select and interworking_connect commands are used.
565#
566# credential fields:
567#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800568# temporary: Whether this credential is temporary and not to be saved
569#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700570# priority: Priority group
571# By default, all networks and credentials get the same priority group
572# (0). This field can be used to give higher priority for credentials
573# (and similarly in struct wpa_ssid for network blocks) to change the
574# Interworking automatic networking selection behavior. The matching
575# network (based on either an enabled network block or a credential)
576# with the highest priority value will be selected.
577#
578# pcsc: Use PC/SC and SIM/USIM card
579#
580# realm: Home Realm for Interworking
581#
582# username: Username for Interworking network selection
583#
584# password: Password for Interworking network selection
585#
586# ca_cert: CA certificate for Interworking network selection
587#
588# client_cert: File path to client certificate file (PEM/DER)
589# This field is used with Interworking networking selection for a case
590# where client certificate/private key is used for authentication
591# (EAP-TLS). Full path to the file should be used since working
592# directory may change when wpa_supplicant is run in the background.
593#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700594# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
595#
596# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
597#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700598# Alternatively, a named configuration blob can be used by setting
599# this to blob://blob_name.
600#
601# private_key: File path to client private key file (PEM/DER/PFX)
602# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
603# commented out. Both the private key and certificate will be read
604# from the PKCS#12 file in this case. Full path to the file should be
605# used since working directory may change when wpa_supplicant is run
606# in the background.
607#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700608# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
609# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
610#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700611# Windows certificate store can be used by leaving client_cert out and
612# configuring private_key in one of the following formats:
613#
614# cert://substring_to_match
615#
616# hash://certificate_thumbprint_in_hex
617#
618# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
619#
620# Note that when running wpa_supplicant as an application, the user
621# certificate store (My user account) is used, whereas computer store
622# (Computer account) is used when running wpasvc as a service.
623#
624# Alternatively, a named configuration blob can be used by setting
625# this to blob://blob_name.
626#
627# private_key_passwd: Password for private key file
628#
629# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
630#
631# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
632# format
633#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700634# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700635# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700636# whether the AP is operated by the Home SP. Multiple domain entries can
637# be used to configure alternative FQDNs that will be considered home
638# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700639#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700640# roaming_consortium: Roaming Consortium OI
641# If roaming_consortium_len is non-zero, this field contains the
642# Roaming Consortium OI that can be used to determine which access
643# points support authentication with this credential. This is an
644# alternative to the use of the realm parameter. When using Roaming
645# Consortium to match the network, the EAP parameters need to be
646# pre-configured with the credential since the NAI Realm information
647# may not be available or fetched.
648#
Roshan Pius3a1667e2018-07-03 15:17:14 -0700649# required_roaming_consortium: Required Roaming Consortium OI
650# If required_roaming_consortium_len is non-zero, this field contains the
651# Roaming Consortium OI that is required to be advertised by the AP for
652# the credential to be considered matching.
653#
654# roaming_consortiums: Roaming Consortium OI(s) memberships
655# This string field contains one or more comma delimited OIs (hexdump)
656# identifying the roaming consortiums of which the provider is a member.
657# The list is sorted from the most preferred one to the least preferred
658# one. A match between the Roaming Consortium OIs advertised by an AP and
659# the OIs in this list indicates that successful authentication is
660# possible.
661# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
662#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700663# eap: Pre-configured EAP method
664# This optional field can be used to specify which EAP method will be
665# used with this credential. If not set, the EAP method is selected
666# automatically based on ANQP information (e.g., NAI Realm).
667#
668# phase1: Pre-configure Phase 1 (outer authentication) parameters
669# This optional field is used with like the 'eap' parameter.
670#
671# phase2: Pre-configure Phase 2 (inner authentication) parameters
672# This optional field is used with like the 'eap' parameter.
673#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800674# excluded_ssid: Excluded SSID
675# This optional field can be used to excluded specific SSID(s) from
676# matching with the network. Multiple entries can be used to specify more
677# than one SSID.
678#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800679# roaming_partner: Roaming partner information
680# This optional field can be used to configure preferences between roaming
681# partners. The field is a string in following format:
682# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
683# (non-exact match means any subdomain matches the entry; priority is in
684# 0..255 range with 0 being the highest priority)
685#
686# update_identifier: PPS MO ID
687# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
688#
689# provisioning_sp: FQDN of the SP that provisioned the credential
690# This optional field can be used to keep track of the SP that provisioned
691# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
692#
693# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
694# These fields can be used to specify minimum download/upload backhaul
695# bandwidth that is preferred for the credential. This constraint is
696# ignored if the AP does not advertise WAN Metrics information or if the
697# limit would prevent any connection. Values are in kilobits per second.
698# min_dl_bandwidth_home
699# min_ul_bandwidth_home
700# min_dl_bandwidth_roaming
701# min_ul_bandwidth_roaming
702#
703# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
704# (PPS/<X+>/Policy/MaximumBSSLoadValue)
705# This value is used as the maximum channel utilization for network
706# selection purposes for home networks. If the AP does not advertise
707# BSS Load or if the limit would prevent any connection, this constraint
708# will be ignored.
709#
710# req_conn_capab: Required connection capability
711# (PPS/<X+>/Policy/RequiredProtoPortTuple)
712# This value is used to configure set of required protocol/port pairs that
713# a roaming network shall support (include explicitly in Connection
714# Capability ANQP element). This constraint is ignored if the AP does not
715# advertise Connection Capability or if this constraint would prevent any
716# network connection. This policy is not used in home networks.
717# Format: <protocol>[:<comma-separated list of ports]
718# Multiple entries can be used to list multiple requirements.
719# For example, number of common TCP protocols:
720# req_conn_capab=6,22,80,443
721# For example, IPSec/IKE:
722# req_conn_capab=17:500
723# req_conn_capab=50
724#
725# ocsp: Whether to use/require OCSP to check server certificate
726# 0 = do not use OCSP stapling (TLS certificate status extension)
727# 1 = try to use OCSP stapling, but not require response
728# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800729# 3 = require valid OCSP stapling response for all not-trusted
730# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800731#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700732# sim_num: Identifier for which SIM to use in multi-SIM devices
733#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700734# for example:
735#
736#cred={
737# realm="example.com"
738# username="user@example.com"
739# password="password"
740# ca_cert="/etc/wpa_supplicant/ca.pem"
741# domain="example.com"
742#}
743#
744#cred={
745# imsi="310026-000000000"
746# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
747#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700748#
749#cred={
750# realm="example.com"
751# username="user"
752# password="password"
753# ca_cert="/etc/wpa_supplicant/ca.pem"
754# domain="example.com"
755# roaming_consortium=223344
756# eap=TTLS
757# phase2="auth=MSCHAPV2"
758#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800759
Dmitry Shmidt04949592012-07-19 12:16:46 -0700760# Hotspot 2.0
761# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800762
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800763# Scheduled scan plans
764#
765# A space delimited list of scan plans. Each scan plan specifies the scan
766# interval and number of iterations, delimited by a colon. The last scan plan
767# will run infinitely and thus must specify only the interval and not the number
768# of iterations.
769#
770# The driver advertises the maximum number of scan plans supported. If more scan
771# plans than supported are configured, only the first ones are set (up to the
772# maximum supported). The last scan plan that specifies only the interval is
773# always set as the last plan.
774#
775# If the scan interval or the number of iterations for a scan plan exceeds the
776# maximum supported, it will be set to the maximum supported value.
777#
778# Format:
779# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
780#
781# Example:
782# sched_scan_plans=10:100 20:200 30
783
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800784# Multi Band Operation (MBO) non-preferred channels
785# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700786# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800787# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700788# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800789# Example:
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700790# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800791
792# MBO Cellular Data Capabilities
793# 1 = Cellular data connection available
794# 2 = Cellular data connection not available
795# 3 = Not cellular capable (default)
796#mbo_cell_capa=3
797
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700798# Optimized Connectivity Experience (OCE)
799# oce: Enable OCE features (bitmap)
800# Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
801# does not indicate support for OCE in STA mode)
802# Set BIT(1) to Enable OCE in STA-CFON mode
803#oce=1
804
Hai Shalomfdcde762020-04-02 11:19:20 -0700805# Extended Key ID support for Individually Addressed frames
806# 0 = force off: Do not use Extended Key ID (default)
807# 1 = auto: Activate Extended Key ID support if the driver supports it
808#extended_key_id=0
809
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800810# network block
811#
812# Each network (usually AP's sharing the same SSID) is configured as a separate
813# block in this configuration file. The network blocks are in preference order
814# (the first match is used).
815#
816# network block fields:
817#
818# disabled:
819# 0 = this network can be used (default)
820# 1 = this network block is disabled (can be enabled through ctrl_iface,
821# e.g., with wpa_cli or wpa_gui)
822#
823# id_str: Network identifier string for external scripts. This value is passed
824# to external action script through wpa_cli as WPA_ID_STR environment
825# variable to make it easier to do network specific configuration.
826#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700827# ssid: SSID (mandatory); network name in one of the optional formats:
828# - an ASCII string with double quotation
829# - a hex string (two characters per octet of SSID)
830# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800831#
832# scan_ssid:
833# 0 = do not scan this SSID with specific Probe Request frames (default)
834# 1 = scan with SSID-specific Probe Request frames (this can be used to
835# find APs that do not accept broadcast SSID or use multiple SSIDs;
836# this will add latency to scanning, so enable this only when needed)
837#
838# bssid: BSSID (optional); if set, this network block is used only when
839# associating with the AP using the configured BSSID
840#
841# priority: priority group (integer)
842# By default, all networks will get same priority group (0). If some of the
843# networks are more desirable, this field can be used to change the order in
844# which wpa_supplicant goes through the networks when selecting a BSS. The
845# priority groups will be iterated in decreasing priority (i.e., the larger the
846# priority value, the sooner the network is matched against the scan results).
847# Within each priority group, networks will be selected based on security
848# policy, signal strength, etc.
849# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
850# using this priority to select the order for scanning. Instead, they try the
851# networks in the order that used in the configuration file.
852#
853# mode: IEEE 802.11 operation mode
854# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
855# 1 = IBSS (ad-hoc, peer-to-peer)
856# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800857# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
858# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
859# TKIP/CCMP) is available for backwards compatibility, but its use is
860# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800861# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
862# both), and psk must also be set.
863#
864# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
865# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
866# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
867# In addition, this value is only used by the station that creates the IBSS. If
868# an IBSS network with the configured SSID is already present, the frequency of
869# the network will be used instead of this configured value.
870#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800871# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700872# 0 = do not use PBSS
873# 1 = use PBSS
874# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800875# Used together with mode configuration. When mode is AP, it means to start a
876# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700877# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
878# which means connect to either PCP or AP.
879# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800880# For more details, see IEEE Std 802.11ad-2012.
881#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800882# scan_freq: List of frequencies to scan
883# Space-separated list of frequencies in MHz to scan when searching for this
884# BSS. If the subset of channels used by the network is known, this option can
885# be used to optimize scanning to not occur on channels that the network does
886# not use. Example: scan_freq=2412 2437 2462
887#
888# freq_list: Array of allowed frequencies
889# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
890# set, scan results that do not match any of the specified frequencies are not
891# considered when selecting a BSS.
892#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700893# This can also be set on the outside of the network block. In this case,
894# it limits the frequencies that will be scanned.
895#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800896# bgscan: Background scanning
897# wpa_supplicant behavior for background scanning can be specified by
898# configuring a bgscan module. These modules are responsible for requesting
899# background scans for the purpose of roaming within an ESS (i.e., within a
900# single network block with all the APs using the same SSID). The bgscan
901# parameter uses following format: "<bgscan module name>:<module parameters>"
902# Following bgscan modules are available:
903# simple - Periodic background scans based on signal strength
904# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
905# <long interval>"
906# bgscan="simple:30:-45:300"
907# learn - Learn channels used by the network and try to avoid bgscans on other
908# channels (experimental)
909# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
910# <long interval>[:<database file name>]"
911# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800912# Explicitly disable bgscan by setting
913# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800914#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800915# This option can also be set outside of all network blocks for the bgscan
916# parameter to apply for all the networks that have no specific bgscan
917# parameter.
918#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800919# proto: list of accepted protocols
920# WPA = WPA/IEEE 802.11i/D3.0
921# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
Hai Shalomce48b4a2018-09-05 11:41:35 -0700922# Note that RSN is used also for WPA3.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800923# If not set, this defaults to: WPA RSN
924#
925# key_mgmt: list of accepted authenticated key management protocols
926# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
927# WPA-EAP = WPA using EAP authentication
928# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
929# generated WEP keys
930# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800931# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
932# instead)
933# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
934# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Roshan Pius3a1667e2018-07-03 15:17:14 -0700935# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
936# and using SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800937# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
938# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800939# SAE = Simultaneous authentication of equals; pre-shared key/password -based
940# authentication with stronger security than WPA-PSK especially when using
Hai Shalomce48b4a2018-09-05 11:41:35 -0700941# not that strong password; a.k.a. WPA3-Personal
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800942# FT-SAE = SAE with FT
943# WPA-EAP-SUITE-B = Suite B 128-bit level
944# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800945# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800946# FILS-SHA256 = Fast Initial Link Setup with SHA256
947# FILS-SHA384 = Fast Initial Link Setup with SHA384
948# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
949# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Hai Shalomce48b4a2018-09-05 11:41:35 -0700950# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
951# DPP = Device Provisioning Protocol
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800952# If not set, this defaults to: WPA-PSK WPA-EAP
953#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700954# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800955# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700956# 1 = optional
957# 2 = required
958# The most common configuration options for this based on the PMF (protected
959# management frames) certification program are:
960# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
961# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -0800962# (and similarly for WPA-PSK and WPA-PSK-SHA256 if WPA2-Personal is used)
963# WPA3-Personal-only mode: ieee80211w=2 and key_mgmt=SAE
Dmitry Shmidt04949592012-07-19 12:16:46 -0700964#
Hai Shalom74f70d42019-02-11 14:42:39 -0800965# ocv: whether operating channel validation is enabled
966# This is a countermeasure against multi-channel man-in-the-middle attacks.
967# Enabling this automatically also enables ieee80211w, if not yet enabled.
968# 0 = disabled (default)
969# 1 = enabled
970#ocv=1
971#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800972# auth_alg: list of allowed IEEE 802.11 authentication algorithms
973# OPEN = Open System authentication (required for WPA/WPA2)
974# SHARED = Shared Key authentication (requires static WEP keys)
975# LEAP = LEAP/Network EAP (only used with LEAP)
976# If not set, automatic selection is used (Open System with LEAP enabled if
977# LEAP is allowed as one of the EAP methods).
978#
979# pairwise: list of accepted pairwise (unicast) ciphers for WPA
980# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
981# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
982# NONE = Use only Group Keys (deprecated, should not be included if APs support
983# pairwise keys)
984# If not set, this defaults to: CCMP TKIP
985#
986# group: list of accepted group (broadcast/multicast) ciphers for WPA
987# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
988# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
989# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
990# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
991# If not set, this defaults to: CCMP TKIP WEP104 WEP40
992#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700993# group_mgmt: list of accepted group management ciphers for RSN (PMF)
994# AES-128-CMAC = BIP-CMAC-128
995# BIP-GMAC-128
996# BIP-GMAC-256
997# BIP-CMAC-256
998# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
999# indicates.
1000#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001001# psk: WPA preshared key; 256-bit pre-shared key
1002# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
1003# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
1004# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001005# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
1006# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001007# This field is not needed, if WPA-EAP is used.
1008# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
1009# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
1010# startup and reconfiguration time can be optimized by generating the PSK only
1011# only when the passphrase or SSID has actually changed.
1012#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -07001013# mem_only_psk: Whether to keep PSK/passphrase only in memory
1014# 0 = allow psk/passphrase to be stored to the configuration file
1015# 1 = do not store psk/passphrase to the configuration file
1016#mem_only_psk=0
1017#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001018# sae_password: SAE password
1019# This parameter can be used to set a password for SAE. By default, the
Roshan Pius3a1667e2018-07-03 15:17:14 -07001020# passphrase from the psk parameter is used if this separate parameter is not
1021# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
1022# SAE passwords do not have such constraints.
1023#
1024# sae_password_id: SAE password identifier
1025# This parameter can be used to set an identifier for the SAE password. By
1026# default, no such identifier is used. If set, the specified identifier value
1027# is used by the other peer to select which password to use for authentication.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001028#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001029# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
1030# Dynamic WEP key required for non-WPA mode
1031# bit0 (1): require dynamically generated unicast WEP key
1032# bit1 (2): require dynamically generated broadcast WEP key
1033# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001034# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001035# eapol_flags must be set to 0 for the authentication to be completed
1036# successfully.
1037#
1038# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001039# This determines how sessions are secured with MACsec (only for MACsec
1040# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001041# 0: MACsec not in use (default)
1042# 1: MACsec enabled - Should secure, accept key server's advice to
1043# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001044#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001045# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1046# This setting applies only when MACsec is in use, i.e.,
1047# - macsec_policy is enabled
1048# - the key server has decided to enable MACsec
1049# 0: Encrypt traffic (default)
1050# 1: Integrity only
1051#
Hai Shalom74f70d42019-02-11 14:42:39 -08001052# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1053# This setting applies only when MACsec is in use, i.e.,
1054# - macsec_policy is enabled
1055# - the key server has decided to enable MACsec
1056# 0: Replay protection disabled (default)
1057# 1: Replay protection enabled
1058#
1059# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1060# This determines a window in which replay is tolerated, to allow receipt
1061# of frames that have been misordered by the network.
1062# This setting applies only when MACsec replay protection active, i.e.,
1063# - macsec_replay_protect is enabled
1064# - the key server has decided to enable MACsec
1065# 0: No replay window, strict check (default)
1066# 1..2^32-1: number of packets that could be misordered
1067#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001068# macsec_port: IEEE 802.1X/MACsec port
1069# Port component of the SCI
1070# Range: 1-65534 (default: 1)
1071#
Dmitry Shmidt29333592017-01-09 12:27:11 -08001072# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001073# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -08001074# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1075# with lower priority will become the key server and start distributing SAKs.
Hai Shalom74f70d42019-02-11 14:42:39 -08001076# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1077# hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1078# mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1079# (2..64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -08001080# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1081# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001082#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001083# mixed_cell: This option can be used to configure whether so called mixed
1084# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001085# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001086# 0 = disabled (default)
1087# 1 = enabled
1088#
1089# proactive_key_caching:
1090# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001091# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001092# 1 = enabled
1093#
Hai Shalom81f62d82019-07-22 12:10:00 -07001094# ft_eap_pmksa_caching:
1095# Whether FT-EAP PMKSA caching is allowed
1096# 0 = do not try to use PMKSA caching with FT-EAP (default)
1097# 1 = try to use PMKSA caching with FT-EAP
1098# This controls whether to try to use PMKSA caching with FT-EAP for the
1099# FT initial mobility domain association.
1100#ft_eap_pmksa_caching=0
1101#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001102# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1103# hex without quotation, e.g., 0102030405)
1104# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1105#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001106# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1107# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1108#
Hai Shalomfdcde762020-04-02 11:19:20 -07001109# wpa_deny_ptk0_rekey: Workaround for PTK rekey issues
1110# PTK0 rekeys (using only one Key ID value for pairwise keys) can degrade the
1111# security and stability with some cards.
1112# To avoid the issues wpa_supplicant can replace those PTK rekeys (including
1113# EAP reauthentications) with fast reconnects.
1114#
1115# Available options:
1116# 0 = always rekey when configured/instructed (default)
1117# 1 = only rekey when the local driver is explicitly indicating it can perform
1118# this operation without issues
1119# 2 = never allow problematic PTK0 rekeys
1120#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001121# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1122# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -08001123# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001124#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001125# Following fields are only used with internal EAP implementation.
1126# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001127# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001128# cannot be used with WPA; to be used as a Phase 2 method
1129# with EAP-PEAP or EAP-TTLS)
1130# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1131# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1132# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1133# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1134# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1135# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1136# TLS = EAP-TLS (client and server certificate)
1137# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1138# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1139# authentication)
1140# If not set, all compiled in methods are allowed.
1141#
1142# identity: Identity string for EAP
1143# This field is also used to configure user NAI for
1144# EAP-PSK/PAX/SAKE/GPSK.
1145# anonymous_identity: Anonymous identity string for EAP (to be used as the
1146# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07001147# identity, e.g., EAP-TTLS). This field can also be used with
1148# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001149# password: Password string for EAP. This field can include either the
1150# plaintext password (using ASCII or hex string) or a NtPasswordHash
1151# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1152# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1153# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1154# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1155# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001156# variable length PSK. ext:<name of external password field> format can
1157# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001158# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1159# or more trusted CA certificates. If ca_cert and ca_path are not
1160# included, server certificate will not be verified. This is insecure and
1161# a trusted CA certificate should always be configured when using
1162# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1163# change when wpa_supplicant is run in the background.
1164#
1165# Alternatively, this can be used to only perform matching of the server
1166# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1167# this case, the possible CA certificates in the server certificate chain
1168# are ignored and only the server certificate is verified. This is
1169# configured with the following format:
1170# hash:://server/sha256/cert_hash_in_hex
1171# For example: "hash://server/sha256/
1172# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1173#
1174# On Windows, trusted CA certificates can be loaded from the system
1175# certificate store by setting this to cert_store://<name>, e.g.,
1176# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1177# Note that when running wpa_supplicant as an application, the user
1178# certificate store (My user account) is used, whereas computer store
1179# (Computer account) is used when running wpasvc as a service.
1180# ca_path: Directory path for CA certificate files (PEM). This path may
1181# contain multiple CA certificates in OpenSSL format. Common use for this
1182# is to point to system trusted CA list which is often installed into
1183# directory like /etc/ssl/certs. If configured, these certificates are
1184# added to the list of trusted CAs. ca_cert may also be included in that
1185# case, but it is not required.
1186# client_cert: File path to client certificate file (PEM/DER)
1187# Full path should be used since working directory may change when
1188# wpa_supplicant is run in the background.
1189# Alternatively, a named configuration blob can be used by setting this
1190# to blob://<blob name>.
1191# private_key: File path to client private key file (PEM/DER/PFX)
1192# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1193# commented out. Both the private key and certificate will be read from
1194# the PKCS#12 file in this case. Full path should be used since working
1195# directory may change when wpa_supplicant is run in the background.
1196# Windows certificate store can be used by leaving client_cert out and
1197# configuring private_key in one of the following formats:
1198# cert://substring_to_match
1199# hash://certificate_thumbprint_in_hex
1200# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1201# Note that when running wpa_supplicant as an application, the user
1202# certificate store (My user account) is used, whereas computer store
1203# (Computer account) is used when running wpasvc as a service.
1204# Alternatively, a named configuration blob can be used by setting this
1205# to blob://<blob name>.
1206# private_key_passwd: Password for private key file (if left out, this will be
1207# asked through control interface)
1208# dh_file: File path to DH/DSA parameters file (in PEM format)
1209# This is an optional configuration file for setting parameters for an
1210# ephemeral DH key exchange. In most cases, the default RSA
1211# authentication does not use this configuration. However, it is possible
1212# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1213# DSA keys always use ephemeral DH keys. This can be used to achieve
1214# forward secrecy. If the file is in DSA parameters format, it will be
1215# automatically converted into DH params.
1216# subject_match: Substring to be matched against the subject of the
1217# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001218# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001219# The subject string is in following format:
1220# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001221# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001222# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001223# such a use case, domain_suffix_match or domain_match should be used
1224# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001225# altsubject_match: Semicolon separated string of entries to be matched against
1226# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001227# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001228# contains one of the entries in an alternative subject name extension.
1229# altSubjectName string is in following format: TYPE:VALUE
1230# Example: EMAIL:server@example.com
1231# Example: DNS:server.example.com;DNS:server2.example.com
1232# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001233# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001234# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001235# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1236# constraint is met. If no dNSName values are present, this constraint is
1237# matched against SubjectName CN using same suffix match comparison.
1238#
1239# Suffix match here means that the host/domain name is compared one label
1240# at a time starting from the top-level domain and all the labels in
1241# domain_suffix_match shall be included in the certificate. The
1242# certificate may include additional sub-level labels in addition to the
1243# required labels.
1244#
Hai Shalom021b0b52019-04-10 11:17:58 -07001245# More than one match string can be provided by using semicolons to
1246# separate the strings (e.g., example.org;example.com). When multiple
1247# strings are specified, a match with any one of the values is considered
1248# a sufficient match for the certificate, i.e., the conditions are ORed
1249# together.
1250#
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001251# For example, domain_suffix_match=example.com would match
1252# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001253# domain_match: Constraint for server domain name
1254# If set, this FQDN is used as a full match requirement for the
1255# server certificate in SubjectAltName dNSName element(s). If a
1256# matching dNSName is found, this constraint is met. If no dNSName
1257# values are present, this constraint is matched against SubjectName CN
1258# using same full match comparison. This behavior is similar to
1259# domain_suffix_match, but has the requirement of a full match, i.e.,
1260# no subdomains or wildcard matches are allowed. Case-insensitive
1261# comparison is used, so "Example.com" matches "example.com", but would
1262# not match "test.Example.com".
Hai Shalom021b0b52019-04-10 11:17:58 -07001263#
1264# More than one match string can be provided by using semicolons to
1265# separate the strings (e.g., example.org;example.com). When multiple
1266# strings are specified, a match with any one of the values is considered
1267# a sufficient match for the certificate, i.e., the conditions are ORed
1268# together.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001269# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1270# (string with field-value pairs, e.g., "peapver=0" or
1271# "peapver=1 peaplabel=1")
1272# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1273# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1274# to be used during key derivation when PEAPv1 or newer. Most existing
1275# PEAPv1 implementation seem to be using the old label, "client EAP
1276# encryption", and wpa_supplicant is now using that as the default value.
1277# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1278# interoperate with PEAPv1; see eap_testing.txt for more details.
1279# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1280# tunneled EAP-Success. This is required with some RADIUS servers that
1281# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1282# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1283# include_tls_length=1 can be used to force wpa_supplicant to include
1284# TLS Message Length field in all TLS messages even if they are not
1285# fragmented.
1286# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1287# challenges (by default, it accepts 2 or 3)
1288# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1289# protected result indication.
1290# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1291# behavior:
1292# * 0 = do not use cryptobinding (default)
1293# * 1 = use cryptobinding if server supports it
1294# * 2 = require cryptobinding
1295# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1296# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001297#
1298# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1299# used to configure a mode that allows EAP-Success (and EAP-Failure)
1300# without going through authentication step. Some switches use such
1301# sequence when forcing the port to be authorized/unauthorized or as a
1302# fallback option if the authentication server is unreachable. By default,
1303# wpa_supplicant discards such frames to protect against potential attacks
1304# by rogue devices, but this option can be used to disable that protection
1305# for cases where the server/authenticator does not need to be
1306# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001307# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1308# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001309# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1310# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001311#
1312# TLS-based methods can use the following parameters to control TLS behavior
1313# (these are normally in the phase1 parameter, but can be used also in the
1314# phase2 parameter when EAP-TLS is used within the inner tunnel):
1315# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1316# TLS library, these may be disabled by default to enforce stronger
1317# security)
1318# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1319# the TLS library to accept certificates even if they are not currently
1320# valid, i.e., have expired or have not yet become valid; this should be
1321# used only for testing purposes)
1322# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1323# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1324# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1325# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001326# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001327# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1328# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001329# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Hai Shalom74f70d42019-02-11 14:42:39 -08001330# tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1331# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001332# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1333# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001334# tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1335# systemwide TLS policies to be overridden)
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001336# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1337# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001338# tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1339# systemwide TLS policies to be overridden)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001340# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1341# that have issues interoperating with updated TLS version)
Hai Shalom74f70d42019-02-11 14:42:39 -08001342# tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001343# tls_ext_cert_check=0 - No external server certificate validation (default)
1344# tls_ext_cert_check=1 - External server certificate validation enabled; this
1345# requires an external program doing validation of server certificate
1346# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1347# interface and report the result of the validation with
1348# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001349# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1350# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1351# particular when using Suite B with RSA keys of >= 3K (3072) bits
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001352#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001353# Following certificate/private key fields are used in inner Phase2
1354# authentication when using EAP-TTLS or EAP-PEAP.
1355# ca_cert2: File path to CA certificate file. This file can have one or more
1356# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1357# server certificate will not be verified. This is insecure and a trusted
1358# CA certificate should always be configured.
1359# ca_path2: Directory path for CA certificate files (PEM)
1360# client_cert2: File path to client certificate file
1361# private_key2: File path to client private key file
1362# private_key2_passwd: Password for private key file
1363# dh_file2: File path to DH/DSA parameters file (in PEM format)
1364# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001365# authentication server certificate. See subject_match for more details.
1366# altsubject_match2: Semicolon separated string of entries to be matched
1367# against the alternative subject name of the authentication server
1368# certificate. See altsubject_match documentation for more details.
1369# domain_suffix_match2: Constraint for server domain name. See
1370# domain_suffix_match for more details.
Hai Shalomc3565922019-10-28 11:58:20 -07001371# ocsp2: See ocsp for more details.
1372#
1373# Separate machine credentials can be configured for EAP-TEAP Phase 2 with
1374# "machine_" prefix (e.g., "machine_identity") in the configuration parameters.
1375# See the parameters without that prefix for more details on the meaning and
1376# format of each such parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001377#
1378# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1379# This value limits the fragment size for EAP methods that support
1380# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1381# small enough to make the EAP messages fit in MTU of the network
1382# interface used for EAPOL. The default value is suitable for most
1383# cases.
1384#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001385# ocsp: Whether to use/require OCSP to check server certificate
1386# 0 = do not use OCSP stapling (TLS certificate status extension)
1387# 1 = try to use OCSP stapling, but not require response
1388# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001389# 3 = require valid OCSP stapling response for all not-trusted
1390# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001391#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001392# openssl_ciphers: OpenSSL specific cipher configuration
1393# This can be used to override the global openssl_ciphers configuration
1394# parameter (see above).
1395#
1396# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1397#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001398# EAP-FAST variables:
1399# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1400# to create this file and write updates to it when PAC is being
1401# provisioned or refreshed. Full path to the file should be used since
1402# working directory may change when wpa_supplicant is run in the
1403# background. Alternatively, a named configuration blob can be used by
1404# setting this to blob://<blob name>
1405# phase1: fast_provisioning option can be used to enable in-line provisioning
1406# of EAP-FAST credentials (PAC):
1407# 0 = disabled,
1408# 1 = allow unauthenticated provisioning,
1409# 2 = allow authenticated provisioning,
1410# 3 = allow both unauthenticated and authenticated provisioning
1411# fast_max_pac_list_len=<num> option can be used to set the maximum
1412# number of PAC entries to store in a PAC list (default: 10)
1413# fast_pac_format=binary option can be used to select binary format for
1414# storing PAC entries in order to save some space (the default
1415# text format uses about 2.5 times the size of minimal binary
1416# format)
1417#
1418# wpa_supplicant supports number of "EAP workarounds" to work around
1419# interoperability issues with incorrectly behaving authentication servers.
1420# These are enabled by default because some of the issues are present in large
1421# number of authentication servers. Strict EAP conformance mode can be
1422# configured by disabling workarounds with eap_workaround=0.
1423
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001424# update_identifier: PPS MO ID
1425# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001426#
1427# roaming_consortium_selection: Roaming Consortium Selection
1428# The matching Roaming Consortium OI that was used to generate this
1429# network profile.
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001430
Dmitry Shmidt04949592012-07-19 12:16:46 -07001431# Station inactivity limit
1432#
1433# If a station does not send anything in ap_max_inactivity seconds, an
1434# empty data frame is sent to it in order to verify whether it is
1435# still in range. If this frame is not ACKed, the station will be
1436# disassociated and then deauthenticated. This feature is used to
1437# clear station table of old entries when the STAs move out of the
1438# range.
1439#
1440# The station can associate again with the AP if it is still in range;
1441# this inactivity poll is just used as a nicer way of verifying
1442# inactivity; i.e., client will not report broken connection because
1443# disassociation frame is not sent immediately without first polling
1444# the STA with a data frame.
1445# default: 300 (i.e., 5 minutes)
1446#ap_max_inactivity=300
1447
1448# DTIM period in Beacon intervals for AP mode (default: 2)
1449#dtim_period=2
1450
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001451# Beacon interval (default: 100 TU)
1452#beacon_int=100
1453
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001454# WPS in AP mode
1455# 0 = WPS enabled and configured (default)
1456# 1 = WPS disabled
1457#wps_disabled=0
1458
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001459# FILS DH Group
1460# 0 = PFS disabled with FILS shared key authentication (default)
1461# 1-65535 = DH Group to use for FILS PFS
1462#fils_dh_group=0
1463
Hai Shalomfdcde762020-04-02 11:19:20 -07001464# DPP PFS
1465# 0: allow PFS to be used or not used (default)
1466# 1: require PFS to be used (note: not compatible with DPP R1)
1467# 2: do not allow PFS to be used
1468#dpp_pfs=0
1469
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001470# MAC address policy
1471# 0 = use permanent MAC address
1472# 1 = use random MAC address for each ESS connection
1473# 2 = like 1, but maintain OUI (with local admin bit set)
1474#mac_addr=0
1475
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001476# disable_ht: Whether HT (802.11n) should be disabled.
1477# 0 = HT enabled (if AP supports it)
1478# 1 = HT disabled
1479#
1480# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1481# 0 = HT-40 enabled (if AP supports it)
1482# 1 = HT-40 disabled
1483#
1484# disable_sgi: Whether SGI (short guard interval) should be disabled.
1485# 0 = SGI enabled (if AP supports it)
1486# 1 = SGI disabled
1487#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001488# disable_ldpc: Whether LDPC should be disabled.
1489# 0 = LDPC enabled (if AP supports it)
1490# 1 = LDPC disabled
1491#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001492# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1493# 0 = 40 MHz tolerant (default)
1494# 1 = 40 MHz intolerant
1495#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001496# ht_mcs: Configure allowed MCS rates.
1497# Parsed as an array of bytes, in base-16 (ascii-hex)
1498# ht_mcs="" // Use all available (default)
1499# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1500# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1501#
1502# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1503# -1 = Do not make any changes.
1504# 0 = Enable MAX-AMSDU if hardware supports it.
1505# 1 = Disable AMSDU
1506#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001507# ampdu_factor: Maximum A-MPDU Length Exponent
1508# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1509#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001510# ampdu_density: Allow overriding AMPDU density configuration.
1511# Treated as hint by the kernel.
1512# -1 = Do not make any changes.
1513# 0-3 = Set AMPDU density (aka factor) to specified value.
Hai Shalom74f70d42019-02-11 14:42:39 -08001514#
1515# tx_stbc: Allow overriding STBC support for TX streams
1516# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1517# -1 = Do not make any changes (default)
1518# 0 = Set if not supported
1519# 1 = Set if supported
1520#
1521# rx_stbc: Allow overriding STBC support for RX streams
1522# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1523# -1 = Do not make any changes (default)
1524# 0 = Set if not supported
1525# 1 = Set for support of one spatial stream
1526# 2 = Set for support of one and two spatial streams
1527# 3 = Set for support of one, two and three spatial streams
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001528
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001529# disable_vht: Whether VHT should be disabled.
1530# 0 = VHT enabled (if AP supports it)
1531# 1 = VHT disabled
1532#
1533# vht_capa: VHT capabilities to set in the override
1534# vht_capa_mask: mask of VHT capabilities
1535#
1536# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1537# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1538# 0: MCS 0-7
1539# 1: MCS 0-8
1540# 2: MCS 0-9
1541# 3: not supported
1542
Hai Shalom74f70d42019-02-11 14:42:39 -08001543# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1544# 0 = normal STA (default)
1545# 1 = backhaul STA
1546# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1547# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1548# added to a bridge to allow forwarding frames over this backhaul link.
1549
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001550##### Fast Session Transfer (FST) support #####################################
1551#
1552# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001553# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1554# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001555#
1556# FST is the transfer of a session from a channel to another channel, in the
1557# same or different frequency bands.
1558#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001559# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001560
1561# Identifier of an FST Group the interface belongs to.
1562#fst_group_id=bond0
1563
1564# Interface priority within the FST Group.
1565# Announcing a higher priority for an interface means declaring it more
1566# preferable for FST switch.
1567# fst_priority is in 1..255 range with 1 being the lowest priority.
1568#fst_priority=100
1569
1570# Default LLT value for this interface in milliseconds. The value used in case
1571# no value provided during session setup. Default is 50 msec.
1572# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1573# Transitioning between states).
1574#fst_llt=100
1575
Hai Shalom81f62d82019-07-22 12:10:00 -07001576# BSS Transition Management
1577# disable_btm - Disable BSS transition management in STA
1578# Set to 0 to enable BSS transition management (default behavior)
1579# Set to 1 to disable BSS transition management
1580#disable_btm=0
1581
Hai Shalomc3565922019-10-28 11:58:20 -07001582# Enable EDMG capability in STA/AP mode, default value is false
1583#enable_edmg=1
1584
1585# This value is used to configure the channel bonding feature.
1586# Default value is 0.
1587# Relevant only if enable_edmg is true
1588# In AP mode it defines the EDMG channel to use for AP operation.
1589# In STA mode it defines the EDMG channel for connection (if supported by AP).
1590#edmg_channel=9
1591
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001592# Example blocks:
1593
1594# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1595network={
1596 ssid="simple"
1597 psk="very secret passphrase"
1598 priority=5
1599}
1600
1601# Same as previous, but request SSID-specific scanning (for APs that reject
1602# broadcast SSID)
1603network={
1604 ssid="second ssid"
1605 scan_ssid=1
1606 psk="very secret passphrase"
1607 priority=2
1608}
1609
1610# Only WPA-PSK is used. Any valid cipher combination is accepted.
1611network={
1612 ssid="example"
1613 proto=WPA
1614 key_mgmt=WPA-PSK
1615 pairwise=CCMP TKIP
1616 group=CCMP TKIP WEP104 WEP40
1617 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1618 priority=2
1619}
1620
1621# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1622network={
1623 ssid="example"
1624 proto=WPA
1625 key_mgmt=WPA-PSK
1626 pairwise=TKIP
1627 group=TKIP
1628 psk="not so secure passphrase"
1629 wpa_ptk_rekey=600
1630}
1631
1632# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1633# or WEP40 as the group cipher will not be accepted.
1634network={
1635 ssid="example"
1636 proto=RSN
1637 key_mgmt=WPA-EAP
1638 pairwise=CCMP TKIP
1639 group=CCMP TKIP
1640 eap=TLS
1641 identity="user@example.com"
1642 ca_cert="/etc/cert/ca.pem"
1643 client_cert="/etc/cert/user.pem"
1644 private_key="/etc/cert/user.prv"
1645 private_key_passwd="password"
1646 priority=1
1647}
1648
1649# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1650# (e.g., Radiator)
1651network={
1652 ssid="example"
1653 key_mgmt=WPA-EAP
1654 eap=PEAP
1655 identity="user@example.com"
1656 password="foobar"
1657 ca_cert="/etc/cert/ca.pem"
1658 phase1="peaplabel=1"
1659 phase2="auth=MSCHAPV2"
1660 priority=10
1661}
1662
1663# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1664# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1665network={
1666 ssid="example"
1667 key_mgmt=WPA-EAP
1668 eap=TTLS
1669 identity="user@example.com"
1670 anonymous_identity="anonymous@example.com"
1671 password="foobar"
1672 ca_cert="/etc/cert/ca.pem"
1673 priority=2
1674}
1675
1676# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1677# use. Real identity is sent only within an encrypted TLS tunnel.
1678network={
1679 ssid="example"
1680 key_mgmt=WPA-EAP
1681 eap=TTLS
1682 identity="user@example.com"
1683 anonymous_identity="anonymous@example.com"
1684 password="foobar"
1685 ca_cert="/etc/cert/ca.pem"
1686 phase2="auth=MSCHAPV2"
1687}
1688
1689# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1690# authentication.
1691network={
1692 ssid="example"
1693 key_mgmt=WPA-EAP
1694 eap=TTLS
1695 # Phase1 / outer authentication
1696 anonymous_identity="anonymous@example.com"
1697 ca_cert="/etc/cert/ca.pem"
1698 # Phase 2 / inner authentication
1699 phase2="autheap=TLS"
1700 ca_cert2="/etc/cert/ca2.pem"
1701 client_cert2="/etc/cer/user.pem"
1702 private_key2="/etc/cer/user.prv"
1703 private_key2_passwd="password"
1704 priority=2
1705}
1706
1707# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1708# group cipher.
1709network={
1710 ssid="example"
1711 bssid=00:11:22:33:44:55
1712 proto=WPA RSN
1713 key_mgmt=WPA-PSK WPA-EAP
1714 pairwise=CCMP
1715 group=CCMP
1716 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1717}
1718
1719# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1720# and all valid ciphers.
1721network={
1722 ssid=00010203
1723 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1724}
1725
1726
1727# EAP-SIM with a GSM SIM or USIM
1728network={
1729 ssid="eap-sim-test"
1730 key_mgmt=WPA-EAP
1731 eap=SIM
1732 pin="1234"
1733 pcsc=""
1734}
1735
1736
1737# EAP-PSK
1738network={
1739 ssid="eap-psk-test"
1740 key_mgmt=WPA-EAP
1741 eap=PSK
1742 anonymous_identity="eap_psk_user"
1743 password=06b4be19da289f475aa46a33cb793029
1744 identity="eap_psk_user@example.com"
1745}
1746
1747
1748# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1749# EAP-TLS for authentication and key generation; require both unicast and
1750# broadcast WEP keys.
1751network={
1752 ssid="1x-test"
1753 key_mgmt=IEEE8021X
1754 eap=TLS
1755 identity="user@example.com"
1756 ca_cert="/etc/cert/ca.pem"
1757 client_cert="/etc/cert/user.pem"
1758 private_key="/etc/cert/user.prv"
1759 private_key_passwd="password"
1760 eapol_flags=3
1761}
1762
1763
1764# LEAP with dynamic WEP keys
1765network={
1766 ssid="leap-example"
1767 key_mgmt=IEEE8021X
1768 eap=LEAP
1769 identity="user"
1770 password="foobar"
1771}
1772
1773# EAP-IKEv2 using shared secrets for both server and peer authentication
1774network={
1775 ssid="ikev2-example"
1776 key_mgmt=WPA-EAP
1777 eap=IKEV2
1778 identity="user"
1779 password="foobar"
1780}
1781
1782# EAP-FAST with WPA (WPA or WPA2)
1783network={
1784 ssid="eap-fast-test"
1785 key_mgmt=WPA-EAP
1786 eap=FAST
1787 anonymous_identity="FAST-000102030405"
1788 identity="username"
1789 password="password"
1790 phase1="fast_provisioning=1"
1791 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1792}
1793
1794network={
1795 ssid="eap-fast-test"
1796 key_mgmt=WPA-EAP
1797 eap=FAST
1798 anonymous_identity="FAST-000102030405"
1799 identity="username"
1800 password="password"
1801 phase1="fast_provisioning=1"
1802 pac_file="blob://eap-fast-pac"
1803}
1804
1805# Plaintext connection (no WPA, no IEEE 802.1X)
1806network={
1807 ssid="plaintext-test"
1808 key_mgmt=NONE
1809}
1810
1811
1812# Shared WEP key connection (no WPA, no IEEE 802.1X)
1813network={
1814 ssid="static-wep-test"
1815 key_mgmt=NONE
1816 wep_key0="abcde"
1817 wep_key1=0102030405
1818 wep_key2="1234567890123"
1819 wep_tx_keyidx=0
1820 priority=5
1821}
1822
1823
1824# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1825# IEEE 802.11 authentication
1826network={
1827 ssid="static-wep-test2"
1828 key_mgmt=NONE
1829 wep_key0="abcde"
1830 wep_key1=0102030405
1831 wep_key2="1234567890123"
1832 wep_tx_keyidx=0
1833 priority=5
1834 auth_alg=SHARED
1835}
1836
1837
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001838# IBSS/ad-hoc network with RSN
1839network={
1840 ssid="ibss-rsn"
1841 key_mgmt=WPA-PSK
1842 proto=RSN
1843 psk="12345678"
1844 mode=1
1845 frequency=2412
1846 pairwise=CCMP
1847 group=CCMP
1848}
1849
1850# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001851network={
1852 ssid="test adhoc"
1853 mode=1
1854 frequency=2412
1855 proto=WPA
1856 key_mgmt=WPA-NONE
1857 pairwise=NONE
1858 group=TKIP
1859 psk="secret passphrase"
1860}
1861
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001862# open mesh network
1863network={
1864 ssid="test mesh"
1865 mode=5
1866 frequency=2437
1867 key_mgmt=NONE
1868}
1869
1870# secure (SAE + AMPE) network
1871network={
1872 ssid="secure mesh"
1873 mode=5
1874 frequency=2437
1875 key_mgmt=SAE
1876 psk="very secret passphrase"
1877}
1878
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001879
1880# Catch all example that allows more or less all configuration modes
1881network={
1882 ssid="example"
1883 scan_ssid=1
1884 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1885 pairwise=CCMP TKIP
1886 group=CCMP TKIP WEP104 WEP40
1887 psk="very secret passphrase"
1888 eap=TTLS PEAP TLS
1889 identity="user@example.com"
1890 password="foobar"
1891 ca_cert="/etc/cert/ca.pem"
1892 client_cert="/etc/cert/user.pem"
1893 private_key="/etc/cert/user.prv"
1894 private_key_passwd="password"
1895 phase1="peaplabel=0"
1896}
1897
1898# Example of EAP-TLS with smartcard (openssl engine)
1899network={
1900 ssid="example"
1901 key_mgmt=WPA-EAP
1902 eap=TLS
1903 proto=RSN
1904 pairwise=CCMP TKIP
1905 group=CCMP TKIP
1906 identity="user@example.com"
1907 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001908
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001909 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1910 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1911 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001912
1913 # Optional PIN configuration; this can be left out and PIN will be
1914 # asked through the control interface
1915 pin="1234"
1916}
1917
1918# Example configuration showing how to use an inlined blob as a CA certificate
1919# data instead of using external file
1920network={
1921 ssid="example"
1922 key_mgmt=WPA-EAP
1923 eap=TTLS
1924 identity="user@example.com"
1925 anonymous_identity="anonymous@example.com"
1926 password="foobar"
1927 ca_cert="blob://exampleblob"
1928 priority=20
1929}
1930
1931blob-base64-exampleblob={
1932SGVsbG8gV29ybGQhCg==
1933}
1934
1935
1936# Wildcard match for SSID (plaintext APs only). This example select any
1937# open AP regardless of its SSID.
1938network={
1939 key_mgmt=NONE
1940}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001941
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001942# Example configuration blacklisting two APs - these will be ignored
1943# for this network.
1944network={
1945 ssid="example"
1946 psk="very secret passphrase"
1947 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1948}
1949
1950# Example configuration limiting AP selection to a specific set of APs;
1951# any other AP not matching the masked address will be ignored.
1952network={
1953 ssid="example"
1954 psk="very secret passphrase"
1955 bssid_whitelist=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff
1956}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001957
1958# Example config file that will only scan on channel 36.
1959freq_list=5180
1960network={
1961 key_mgmt=NONE
1962}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001963
1964
Roshan Pius3a1667e2018-07-03 15:17:14 -07001965# Example configuration using EAP-TTLS for authentication and key
1966# generation for MACsec
1967network={
1968 key_mgmt=IEEE8021X
1969 eap=TTLS
1970 phase2="auth=PAP"
1971 anonymous_identity="anonymous@example.com"
1972 identity="user@example.com"
1973 password="secretr"
1974 ca_cert="/etc/cert/ca.pem"
1975 eapol_flags=0
1976 macsec_policy=1
1977}
1978
1979# Example configuration for MACsec with preshared key
1980network={
1981 key_mgmt=NONE
1982 eapol_flags=0
1983 macsec_policy=1
1984 mka_cak=0123456789ABCDEF0123456789ABCDEF
1985 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
1986 mka_priority=128
1987}