blob: f4cf91d3a9cbb46671d14a9e1234b63d88e35060 [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)
97# 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
98# parameters (e.g., WPA IE generation); this mode can also be used with
99# non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
100# APs (i.e., external program needs to control association). This mode must
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800101# also be used when using wired Ethernet drivers (including MACsec).
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800102# 2: like 0, but associate with APs using security policy and SSID (but not
103# BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
104# enable operation with hidden SSIDs and optimized roaming; in this mode,
105# the network blocks in the configuration file are tried one by one until
106# the driver reports successful association; each network block should have
107# explicit security policy (i.e., only one option in the lists) for
108# key_mgmt, pairwise, group, proto variables
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800109# Note: ap_scan=2 should not be used with the nl80211 driver interface (the
110# current Linux interface). ap_scan=1 is optimized work working with nl80211.
111# For finding networks using hidden SSID, scan_ssid=1 in the network block can
112# be used with nl80211.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800113# When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
114# created immediately regardless of scan results. ap_scan=1 mode will first try
115# to scan for existing networks and only if no matches with the enabled
116# networks are found, a new IBSS or AP mode network is created.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700117ap_scan=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800118
Dmitry Shmidtb70d0bb2015-11-16 10:43:06 -0800119# Whether to force passive scan for network connection
120#
121# By default, scans will send out Probe Request frames on channels that allow
122# active scanning. This advertise the local station to the world. Normally this
123# is fine, but users may wish to do passive scanning where the radio should only
124# listen quietly for Beacon frames and not send any Probe Request frames. Actual
125# functionality may be driver dependent.
126#
127# This parameter can be used to force only passive scanning to be used
128# for network connection cases. It should be noted that this will slow
129# down scan operations and reduce likelihood of finding the AP. In
130# addition, some use cases will override this due to functional
131# requirements, e.g., for finding an AP that uses hidden SSID
132# (scan_ssid=1) or P2P device discovery.
133#
134# 0: Do normal scans (allow active scans) (default)
135# 1: Do passive scans.
136#passive_scan=0
137
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800138# MPM residency
139# By default, wpa_supplicant implements the mesh peering manager (MPM) for an
140# open mesh. However, if the driver can implement the MPM, you may set this to
141# 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
142# always used.
143# 0: MPM lives in the driver
144# 1: wpa_supplicant provides an MPM which handles peering (default)
145#user_mpm=1
146
147# Maximum number of peer links (0-255; default: 99)
148# Maximum number of mesh peering currently maintained by the STA.
149#max_peer_links=99
150
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800151# Timeout in seconds to detect STA inactivity (default: 300 seconds)
152#
153# This timeout value is used in mesh STA to clean up inactive stations.
154#mesh_max_inactivity=300
155
156# cert_in_cb - Whether to include a peer certificate dump in events
157# This controls whether peer certificates for authentication server and
158# its certificate chain are included in EAP peer certificate events. This is
159# enabled by default.
160#cert_in_cb=1
161
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800162# EAP fast re-authentication
163# By default, fast re-authentication is enabled for all EAP methods that
164# support it. This variable can be used to disable fast re-authentication.
165# Normally, there is no need to disable this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700166fast_reauth=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800167
168# OpenSSL Engine support
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700169# These options can be used to load OpenSSL engines in special or legacy
170# modes.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800171# The two engines that are supported currently are shown below:
172# They are both from the opensc project (http://www.opensc.org/)
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700173# By default the PKCS#11 engine is loaded if the client_cert or
174# private_key option appear to be a PKCS#11 URI, and these options
175# should not need to be used explicitly.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800176# make the opensc engine available
177#opensc_engine_path=/usr/lib/opensc/engine_opensc.so
178# make the pkcs11 engine available
179#pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
180# configure the path to the pkcs11 module required by the pkcs11 engine
181#pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
182
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800183# OpenSSL cipher string
184#
185# This is an OpenSSL specific configuration option for configuring the default
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700186# ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
187# by default) is used.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800188# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
189# on cipher suite configuration. This is applicable only if wpa_supplicant is
190# built to use OpenSSL.
191#openssl_ciphers=DEFAULT:!EXP:!LOW
192
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800193# Dynamic EAP methods
194# If EAP methods were built dynamically as shared object files, they need to be
195# loaded here before being used in the network blocks. By default, EAP methods
196# are included statically in the build, so these lines are not needed
197#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
198#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
199
200# Driver interface parameters
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700201# This field can be used to configure arbitrary driver interface parameters. The
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800202# format is specific to the selected driver interface. This field is not used
203# in most cases.
204#driver_param="field=value"
205
206# Country code
207# The ISO/IEC alpha2 country code for the country in which this device is
208# currently operating.
209#country=US
210
211# Maximum lifetime for PMKSA in seconds; default 43200
212#dot11RSNAConfigPMKLifetime=43200
213# Threshold for reauthentication (percentage of PMK lifetime); default 70
214#dot11RSNAConfigPMKReauthThreshold=70
215# Timeout for security association negotiation in seconds; default 60
216#dot11RSNAConfigSATimeout=60
217
218# Wi-Fi Protected Setup (WPS) parameters
219
220# Universally Unique IDentifier (UUID; see RFC 4122) of the device
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700221# If not configured, UUID will be generated based on the mechanism selected with
222# the auto_uuid parameter.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800223#uuid=12345678-9abc-def0-1234-56789abcdef0
224
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700225# Automatic UUID behavior
226# 0 = generate static value based on the local MAC address (default)
227# 1 = generate a random UUID every time wpa_supplicant starts
228#auto_uuid=0
229
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800230# Device Name
231# User-friendly description of device; up to 32 octets encoded in UTF-8
232#device_name=Wireless Client
233
234# Manufacturer
235# The manufacturer of the device (up to 64 ASCII characters)
236#manufacturer=Company
237
238# Model Name
239# Model of the device (up to 32 ASCII characters)
240#model_name=cmodel
241
242# Model Number
243# Additional device description (up to 32 ASCII characters)
244#model_number=123
245
246# Serial Number
247# Serial number of the device (up to 32 characters)
248#serial_number=12345
249
250# Primary Device Type
251# Used format: <categ>-<OUI>-<subcateg>
252# categ = Category as an integer value
253# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
254# default WPS OUI
255# subcateg = OUI-specific Sub Category as an integer value
256# Examples:
257# 1-0050F204-1 (Computer / PC)
258# 1-0050F204-2 (Computer / Server)
259# 5-0050F204-1 (Storage / NAS)
260# 6-0050F204-1 (Network Infrastructure / AP)
261#device_type=1-0050F204-1
262
263# OS Version
264# 4-octet operating system version number (hex string)
265#os_version=01020300
266
267# Config Methods
268# List of the supported configuration methods
269# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
270# nfc_interface push_button keypad virtual_display physical_display
271# virtual_push_button physical_push_button
272# For WSC 1.0:
273#config_methods=label display push_button keypad
274# For WSC 2.0:
275#config_methods=label virtual_display virtual_push_button keypad
276
277# Credential processing
278# 0 = process received credentials internally (default)
279# 1 = do not process received credentials; just pass them over ctrl_iface to
280# external program(s)
281# 2 = process received credentials internally and pass them over ctrl_iface
282# to external program(s)
283#wps_cred_processing=0
284
Dmitry Shmidt04949592012-07-19 12:16:46 -0700285# Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
286# The vendor attribute contents to be added in M1 (hex string)
287#wps_vendor_ext_m1=000137100100020001
288
289# NFC password token for WPS
290# These parameters can be used to configure a fixed NFC password token for the
291# station. This can be generated, e.g., with nfc_pw_token. When these
292# parameters are used, the station is assumed to be deployed with a NFC tag
293# that includes the matching NFC password token (e.g., written based on the
294# NDEF record from nfc_pw_token).
295#
296#wps_nfc_dev_pw_id: Device Password ID (16..65535)
297#wps_nfc_dh_pubkey: Hexdump of DH Public Key
298#wps_nfc_dh_privkey: Hexdump of DH Private Key
299#wps_nfc_dev_pw: Hexdump of Device Password
300
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700301# Priority for the networks added through WPS
302# This priority value will be set to each network profile that is added
303# by executing the WPS protocol.
304#wps_priority=0
305
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800306# Maximum number of BSS entries to keep in memory
307# Default: 200
308# This can be used to limit memory use on the BSS entries (cached scan
309# results). A larger value may be needed in environments that have huge number
310# of APs when using ap_scan=1 mode.
311#bss_max_count=200
312
Dmitry Shmidt04949592012-07-19 12:16:46 -0700313# Automatic scan
314# This is an optional set of parameters for automatic scanning
315# within an interface in following format:
316#autoscan=<autoscan module name>:<module parameters>
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800317# autoscan is like bgscan but on disconnected or inactive state.
318# For instance, on exponential module parameters would be <base>:<limit>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700319#autoscan=exponential:3:300
320# Which means a delay between scans on a base exponential of 3,
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800321# up to the limit of 300 seconds (3, 9, 27 ... 300)
322# For periodic module, parameters would be <fixed interval>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700323#autoscan=periodic:30
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800324# So a delay of 30 seconds will be applied between each scan.
325# Note: If sched_scan_plans are configured and supported by the driver,
326# autoscan is ignored.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800327
328# filter_ssids - SSID-based scan result filtering
329# 0 = do not filter scan results (default)
330# 1 = only include configured SSIDs in scan results/BSS table
331#filter_ssids=0
332
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700333# Password (and passphrase, etc.) backend for external storage
334# format: <backend name>[:<optional backend parameters>]
335#ext_password_backend=test:pw1=password|pw2=testing
336
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700337
338# Disable P2P functionality
339# p2p_disabled=1
340
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700341# Timeout in seconds to detect STA inactivity (default: 300 seconds)
342#
343# This timeout value is used in P2P GO mode to clean up
344# inactive stations.
345#p2p_go_max_inactivity=300
346
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700347# Passphrase length (8..63) for P2P GO
348#
349# This parameter controls the length of the random passphrase that is
350# generated at the GO. Default: 8.
351#p2p_passphrase_len=8
352
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700353# Extra delay between concurrent P2P search iterations
354#
355# This value adds extra delay in milliseconds between concurrent search
356# iterations to make p2p_find friendlier to concurrent operations by avoiding
357# it from taking 100% of radio resources. The default value is 500 ms.
358#p2p_search_delay=500
359
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800360# Opportunistic Key Caching (also known as Proactive Key Caching) default
361# This parameter can be used to set the default behavior for the
362# proactive_key_caching parameter. By default, OKC is disabled unless enabled
363# with the global okc=1 parameter or with the per-network
364# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
365# can be disabled with per-network proactive_key_caching=0 parameter.
366#okc=0
367
368# Protected Management Frames default
369# This parameter can be used to set the default behavior for the ieee80211w
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700370# parameter for RSN networks. By default, PMF is disabled unless enabled with
371# the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
372# With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
373# per-network ieee80211w parameter. This global default value does not apply
374# for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
375# RSN.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800376#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800377
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800378# Enabled SAE finite cyclic groups in preference order
379# By default (if this parameter is not set), the mandatory group 19 (ECC group
380# defined over a 256-bit prime order field) is preferred, but other groups are
381# also enabled. If this parameter is set, the groups will be tried in the
382# indicated order. The group values are listed in the IANA registry:
383# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
384#sae_groups=21 20 19 26 25
385
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800386# Default value for DTIM period (if not overridden in network block)
387#dtim_period=2
388
389# Default value for Beacon interval (if not overridden in network block)
390#beacon_int=100
391
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700392# Additional vendor specific elements for Beacon and Probe Response frames
393# This parameter can be used to add additional vendor specific element(s) into
394# the end of the Beacon and Probe Response frames. The format for these
395# element(s) is a hexdump of the raw information elements (id+len+payload for
396# one or more elements). This is used in AP and P2P GO modes.
397#ap_vendor_elements=dd0411223301
398
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700399# Ignore scan results older than request
400#
401# The driver may have a cache of scan results that makes it return
402# information that is older than our scan trigger. This parameter can
403# be used to configure such old information to be ignored instead of
404# allowing it to update the internal BSS table.
405#ignore_old_scan_res=0
406
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700407# scan_cur_freq: Whether to scan only the current frequency
408# 0: Scan all available frequencies. (Default)
409# 1: Scan current operating frequency if another VIF on the same radio
410# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700411
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700412# MAC address policy default
413# 0 = use permanent MAC address
414# 1 = use random MAC address for each ESS connection
415# 2 = like 1, but maintain OUI (with local admin bit set)
416#
417# By default, permanent MAC address is used unless policy is changed by
418# the per-network mac_addr parameter. Global mac_addr=1 can be used to
419# change this default behavior.
420#mac_addr=0
421
422# Lifetime of random MAC address in seconds (default: 60)
423#rand_addr_lifetime=60
424
425# MAC address policy for pre-association operations (scanning, ANQP)
426# 0 = use permanent MAC address
427# 1 = use random MAC address
428# 2 = like 1, but maintain OUI (with local admin bit set)
429#preassoc_mac_addr=0
430
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800431# MAC address policy for GAS operations
432# 0 = use permanent MAC address
433# 1 = use random MAC address
434# 2 = like 1, but maintain OUI (with local admin bit set)
435#gas_rand_mac_addr=0
436
437# Lifetime of GAS random MAC address in seconds (default: 60)
438#gas_rand_addr_lifetime=60
439
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800440# Interworking (IEEE 802.11u)
441
442# Enable Interworking
443# interworking=1
444
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700445# Enable P2P GO advertisement of Interworking
446# go_interworking=1
447
448# P2P GO Interworking: Access Network Type
449# 0 = Private network
450# 1 = Private network with guest access
451# 2 = Chargeable public network
452# 3 = Free public network
453# 4 = Personal device network
454# 5 = Emergency services only network
455# 14 = Test or experimental
456# 15 = Wildcard
457#go_access_network_type=0
458
459# P2P GO Interworking: Whether the network provides connectivity to the Internet
460# 0 = Unspecified
461# 1 = Network provides connectivity to the Internet
462#go_internet=1
463
464# P2P GO Interworking: Group Venue Info (optional)
465# The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
466# Example values (group,type):
467# 0,0 = Unspecified
468# 1,7 = Convention Center
469# 1,13 = Coffee Shop
470# 2,0 = Unspecified Business
471# 7,1 Private Residence
472#go_venue_group=7
473#go_venue_type=1
474
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800475# Homogenous ESS identifier
476# If this is set, scans will be used to request response only from BSSes
477# belonging to the specified Homogeneous ESS. This is used only if interworking
478# is enabled.
479# hessid=00:11:22:33:44:55
480
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700481# Automatic network selection behavior
482# 0 = do not automatically go through Interworking network selection
483# (i.e., require explicit interworking_select command for this; default)
484# 1 = perform Interworking network selection if one or more
485# credentials have been configured and scan did not find a
486# matching network block
487#auto_interworking=0
488
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700489# GAS Address3 field behavior
490# 0 = P2P specification (Address3 = AP BSSID); default
491# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
492# sent to not-associated AP; if associated, AP BSSID)
493#gas_address3=0
494
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700495# Publish fine timing measurement (FTM) responder functionality in
496# the Extended Capabilities element bit 70.
497# Controls whether FTM responder functionality will be published by AP/STA.
498# Note that actual FTM responder operation is managed outside wpa_supplicant.
499# 0 = Do not publish; default
500# 1 = Publish
501#ftm_responder=0
502
503# Publish fine timing measurement (FTM) initiator functionality in
504# the Extended Capabilities element bit 71.
505# Controls whether FTM initiator functionality will be published by AP/STA.
506# Note that actual FTM initiator operation is managed outside wpa_supplicant.
507# 0 = Do not publish; default
508# 1 = Publish
509#ftm_initiator=0
510
Dmitry Shmidt04949592012-07-19 12:16:46 -0700511# credential block
512#
513# Each credential used for automatic network selection is configured as a set
514# of parameters that are compared to the information advertised by the APs when
515# interworking_select and interworking_connect commands are used.
516#
517# credential fields:
518#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800519# temporary: Whether this credential is temporary and not to be saved
520#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700521# priority: Priority group
522# By default, all networks and credentials get the same priority group
523# (0). This field can be used to give higher priority for credentials
524# (and similarly in struct wpa_ssid for network blocks) to change the
525# Interworking automatic networking selection behavior. The matching
526# network (based on either an enabled network block or a credential)
527# with the highest priority value will be selected.
528#
529# pcsc: Use PC/SC and SIM/USIM card
530#
531# realm: Home Realm for Interworking
532#
533# username: Username for Interworking network selection
534#
535# password: Password for Interworking network selection
536#
537# ca_cert: CA certificate for Interworking network selection
538#
539# client_cert: File path to client certificate file (PEM/DER)
540# This field is used with Interworking networking selection for a case
541# where client certificate/private key is used for authentication
542# (EAP-TLS). Full path to the file should be used since working
543# directory may change when wpa_supplicant is run in the background.
544#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700545# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
546#
547# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
548#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700549# Alternatively, a named configuration blob can be used by setting
550# this to blob://blob_name.
551#
552# private_key: File path to client private key file (PEM/DER/PFX)
553# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
554# commented out. Both the private key and certificate will be read
555# from the PKCS#12 file in this case. Full path to the file should be
556# used since working directory may change when wpa_supplicant is run
557# in the background.
558#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700559# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
560# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
561#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700562# Windows certificate store can be used by leaving client_cert out and
563# configuring private_key in one of the following formats:
564#
565# cert://substring_to_match
566#
567# hash://certificate_thumbprint_in_hex
568#
569# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
570#
571# Note that when running wpa_supplicant as an application, the user
572# certificate store (My user account) is used, whereas computer store
573# (Computer account) is used when running wpasvc as a service.
574#
575# Alternatively, a named configuration blob can be used by setting
576# this to blob://blob_name.
577#
578# private_key_passwd: Password for private key file
579#
580# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
581#
582# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
583# format
584#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700585# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700586# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700587# whether the AP is operated by the Home SP. Multiple domain entries can
588# be used to configure alternative FQDNs that will be considered home
589# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700590#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700591# roaming_consortium: Roaming Consortium OI
592# If roaming_consortium_len is non-zero, this field contains the
593# Roaming Consortium OI that can be used to determine which access
594# points support authentication with this credential. This is an
595# alternative to the use of the realm parameter. When using Roaming
596# Consortium to match the network, the EAP parameters need to be
597# pre-configured with the credential since the NAI Realm information
598# may not be available or fetched.
599#
Roshan Pius3a1667e2018-07-03 15:17:14 -0700600# required_roaming_consortium: Required Roaming Consortium OI
601# If required_roaming_consortium_len is non-zero, this field contains the
602# Roaming Consortium OI that is required to be advertised by the AP for
603# the credential to be considered matching.
604#
605# roaming_consortiums: Roaming Consortium OI(s) memberships
606# This string field contains one or more comma delimited OIs (hexdump)
607# identifying the roaming consortiums of which the provider is a member.
608# The list is sorted from the most preferred one to the least preferred
609# one. A match between the Roaming Consortium OIs advertised by an AP and
610# the OIs in this list indicates that successful authentication is
611# possible.
612# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
613#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700614# eap: Pre-configured EAP method
615# This optional field can be used to specify which EAP method will be
616# used with this credential. If not set, the EAP method is selected
617# automatically based on ANQP information (e.g., NAI Realm).
618#
619# phase1: Pre-configure Phase 1 (outer authentication) parameters
620# This optional field is used with like the 'eap' parameter.
621#
622# phase2: Pre-configure Phase 2 (inner authentication) parameters
623# This optional field is used with like the 'eap' parameter.
624#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800625# excluded_ssid: Excluded SSID
626# This optional field can be used to excluded specific SSID(s) from
627# matching with the network. Multiple entries can be used to specify more
628# than one SSID.
629#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800630# roaming_partner: Roaming partner information
631# This optional field can be used to configure preferences between roaming
632# partners. The field is a string in following format:
633# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
634# (non-exact match means any subdomain matches the entry; priority is in
635# 0..255 range with 0 being the highest priority)
636#
637# update_identifier: PPS MO ID
638# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
639#
640# provisioning_sp: FQDN of the SP that provisioned the credential
641# This optional field can be used to keep track of the SP that provisioned
642# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
643#
644# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
645# These fields can be used to specify minimum download/upload backhaul
646# bandwidth that is preferred for the credential. This constraint is
647# ignored if the AP does not advertise WAN Metrics information or if the
648# limit would prevent any connection. Values are in kilobits per second.
649# min_dl_bandwidth_home
650# min_ul_bandwidth_home
651# min_dl_bandwidth_roaming
652# min_ul_bandwidth_roaming
653#
654# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
655# (PPS/<X+>/Policy/MaximumBSSLoadValue)
656# This value is used as the maximum channel utilization for network
657# selection purposes for home networks. If the AP does not advertise
658# BSS Load or if the limit would prevent any connection, this constraint
659# will be ignored.
660#
661# req_conn_capab: Required connection capability
662# (PPS/<X+>/Policy/RequiredProtoPortTuple)
663# This value is used to configure set of required protocol/port pairs that
664# a roaming network shall support (include explicitly in Connection
665# Capability ANQP element). This constraint is ignored if the AP does not
666# advertise Connection Capability or if this constraint would prevent any
667# network connection. This policy is not used in home networks.
668# Format: <protocol>[:<comma-separated list of ports]
669# Multiple entries can be used to list multiple requirements.
670# For example, number of common TCP protocols:
671# req_conn_capab=6,22,80,443
672# For example, IPSec/IKE:
673# req_conn_capab=17:500
674# req_conn_capab=50
675#
676# ocsp: Whether to use/require OCSP to check server certificate
677# 0 = do not use OCSP stapling (TLS certificate status extension)
678# 1 = try to use OCSP stapling, but not require response
679# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800680# 3 = require valid OCSP stapling response for all not-trusted
681# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800682#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700683# sim_num: Identifier for which SIM to use in multi-SIM devices
684#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700685# for example:
686#
687#cred={
688# realm="example.com"
689# username="user@example.com"
690# password="password"
691# ca_cert="/etc/wpa_supplicant/ca.pem"
692# domain="example.com"
693#}
694#
695#cred={
696# imsi="310026-000000000"
697# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
698#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700699#
700#cred={
701# realm="example.com"
702# username="user"
703# password="password"
704# ca_cert="/etc/wpa_supplicant/ca.pem"
705# domain="example.com"
706# roaming_consortium=223344
707# eap=TTLS
708# phase2="auth=MSCHAPV2"
709#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800710
Dmitry Shmidt04949592012-07-19 12:16:46 -0700711# Hotspot 2.0
712# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800713
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800714# Scheduled scan plans
715#
716# A space delimited list of scan plans. Each scan plan specifies the scan
717# interval and number of iterations, delimited by a colon. The last scan plan
718# will run infinitely and thus must specify only the interval and not the number
719# of iterations.
720#
721# The driver advertises the maximum number of scan plans supported. If more scan
722# plans than supported are configured, only the first ones are set (up to the
723# maximum supported). The last scan plan that specifies only the interval is
724# always set as the last plan.
725#
726# If the scan interval or the number of iterations for a scan plan exceeds the
727# maximum supported, it will be set to the maximum supported value.
728#
729# Format:
730# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
731#
732# Example:
733# sched_scan_plans=10:100 20:200 30
734
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800735# Multi Band Operation (MBO) non-preferred channels
736# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700737# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800738# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700739# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800740# Example:
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700741# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800742
743# MBO Cellular Data Capabilities
744# 1 = Cellular data connection available
745# 2 = Cellular data connection not available
746# 3 = Not cellular capable (default)
747#mbo_cell_capa=3
748
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700749# Optimized Connectivity Experience (OCE)
750# oce: Enable OCE features (bitmap)
751# Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
752# does not indicate support for OCE in STA mode)
753# Set BIT(1) to Enable OCE in STA-CFON mode
754#oce=1
755
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800756# network block
757#
758# Each network (usually AP's sharing the same SSID) is configured as a separate
759# block in this configuration file. The network blocks are in preference order
760# (the first match is used).
761#
762# network block fields:
763#
764# disabled:
765# 0 = this network can be used (default)
766# 1 = this network block is disabled (can be enabled through ctrl_iface,
767# e.g., with wpa_cli or wpa_gui)
768#
769# id_str: Network identifier string for external scripts. This value is passed
770# to external action script through wpa_cli as WPA_ID_STR environment
771# variable to make it easier to do network specific configuration.
772#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700773# ssid: SSID (mandatory); network name in one of the optional formats:
774# - an ASCII string with double quotation
775# - a hex string (two characters per octet of SSID)
776# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800777#
778# scan_ssid:
779# 0 = do not scan this SSID with specific Probe Request frames (default)
780# 1 = scan with SSID-specific Probe Request frames (this can be used to
781# find APs that do not accept broadcast SSID or use multiple SSIDs;
782# this will add latency to scanning, so enable this only when needed)
783#
784# bssid: BSSID (optional); if set, this network block is used only when
785# associating with the AP using the configured BSSID
786#
787# priority: priority group (integer)
788# By default, all networks will get same priority group (0). If some of the
789# networks are more desirable, this field can be used to change the order in
790# which wpa_supplicant goes through the networks when selecting a BSS. The
791# priority groups will be iterated in decreasing priority (i.e., the larger the
792# priority value, the sooner the network is matched against the scan results).
793# Within each priority group, networks will be selected based on security
794# policy, signal strength, etc.
795# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
796# using this priority to select the order for scanning. Instead, they try the
797# networks in the order that used in the configuration file.
798#
799# mode: IEEE 802.11 operation mode
800# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
801# 1 = IBSS (ad-hoc, peer-to-peer)
802# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800803# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
804# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
805# TKIP/CCMP) is available for backwards compatibility, but its use is
806# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800807# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
808# both), and psk must also be set.
809#
810# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
811# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
812# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
813# In addition, this value is only used by the station that creates the IBSS. If
814# an IBSS network with the configured SSID is already present, the frequency of
815# the network will be used instead of this configured value.
816#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800817# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700818# 0 = do not use PBSS
819# 1 = use PBSS
820# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800821# Used together with mode configuration. When mode is AP, it means to start a
822# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700823# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
824# which means connect to either PCP or AP.
825# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800826# For more details, see IEEE Std 802.11ad-2012.
827#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800828# scan_freq: List of frequencies to scan
829# Space-separated list of frequencies in MHz to scan when searching for this
830# BSS. If the subset of channels used by the network is known, this option can
831# be used to optimize scanning to not occur on channels that the network does
832# not use. Example: scan_freq=2412 2437 2462
833#
834# freq_list: Array of allowed frequencies
835# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
836# set, scan results that do not match any of the specified frequencies are not
837# considered when selecting a BSS.
838#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700839# This can also be set on the outside of the network block. In this case,
840# it limits the frequencies that will be scanned.
841#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800842# bgscan: Background scanning
843# wpa_supplicant behavior for background scanning can be specified by
844# configuring a bgscan module. These modules are responsible for requesting
845# background scans for the purpose of roaming within an ESS (i.e., within a
846# single network block with all the APs using the same SSID). The bgscan
847# parameter uses following format: "<bgscan module name>:<module parameters>"
848# Following bgscan modules are available:
849# simple - Periodic background scans based on signal strength
850# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
851# <long interval>"
852# bgscan="simple:30:-45:300"
853# learn - Learn channels used by the network and try to avoid bgscans on other
854# channels (experimental)
855# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
856# <long interval>[:<database file name>]"
857# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800858# Explicitly disable bgscan by setting
859# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800860#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800861# This option can also be set outside of all network blocks for the bgscan
862# parameter to apply for all the networks that have no specific bgscan
863# parameter.
864#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800865# proto: list of accepted protocols
866# WPA = WPA/IEEE 802.11i/D3.0
867# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
868# If not set, this defaults to: WPA RSN
869#
870# key_mgmt: list of accepted authenticated key management protocols
871# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
872# WPA-EAP = WPA using EAP authentication
873# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
874# generated WEP keys
875# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800876# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
877# instead)
878# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
879# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Roshan Pius3a1667e2018-07-03 15:17:14 -0700880# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
881# and using SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800882# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
883# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800884# SAE = Simultaneous authentication of equals; pre-shared key/password -based
885# authentication with stronger security than WPA-PSK especially when using
886# not that strong password
887# FT-SAE = SAE with FT
888# WPA-EAP-SUITE-B = Suite B 128-bit level
889# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800890# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800891# FILS-SHA256 = Fast Initial Link Setup with SHA256
892# FILS-SHA384 = Fast Initial Link Setup with SHA384
893# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
894# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800895# If not set, this defaults to: WPA-PSK WPA-EAP
896#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700897# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800898# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700899# 1 = optional
900# 2 = required
901# The most common configuration options for this based on the PMF (protected
902# management frames) certification program are:
903# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
904# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
905# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
906#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800907# auth_alg: list of allowed IEEE 802.11 authentication algorithms
908# OPEN = Open System authentication (required for WPA/WPA2)
909# SHARED = Shared Key authentication (requires static WEP keys)
910# LEAP = LEAP/Network EAP (only used with LEAP)
911# If not set, automatic selection is used (Open System with LEAP enabled if
912# LEAP is allowed as one of the EAP methods).
913#
914# pairwise: list of accepted pairwise (unicast) ciphers for WPA
915# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
916# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
917# NONE = Use only Group Keys (deprecated, should not be included if APs support
918# pairwise keys)
919# If not set, this defaults to: CCMP TKIP
920#
921# group: list of accepted group (broadcast/multicast) ciphers for WPA
922# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
923# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
924# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
925# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
926# If not set, this defaults to: CCMP TKIP WEP104 WEP40
927#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700928# group_mgmt: list of accepted group management ciphers for RSN (PMF)
929# AES-128-CMAC = BIP-CMAC-128
930# BIP-GMAC-128
931# BIP-GMAC-256
932# BIP-CMAC-256
933# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
934# indicates.
935#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800936# psk: WPA preshared key; 256-bit pre-shared key
937# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
938# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
939# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700940# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
941# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800942# This field is not needed, if WPA-EAP is used.
943# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
944# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
945# startup and reconfiguration time can be optimized by generating the PSK only
946# only when the passphrase or SSID has actually changed.
947#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -0700948# mem_only_psk: Whether to keep PSK/passphrase only in memory
949# 0 = allow psk/passphrase to be stored to the configuration file
950# 1 = do not store psk/passphrase to the configuration file
951#mem_only_psk=0
952#
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700953# sae_password: SAE password
954# This parameter can be used to set a password for SAE. By default, the
Roshan Pius3a1667e2018-07-03 15:17:14 -0700955# passphrase from the psk parameter is used if this separate parameter is not
956# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
957# SAE passwords do not have such constraints.
958#
959# sae_password_id: SAE password identifier
960# This parameter can be used to set an identifier for the SAE password. By
961# default, no such identifier is used. If set, the specified identifier value
962# is used by the other peer to select which password to use for authentication.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700963#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800964# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
965# Dynamic WEP key required for non-WPA mode
966# bit0 (1): require dynamically generated unicast WEP key
967# bit1 (2): require dynamically generated broadcast WEP key
968# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800969# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700970# eapol_flags must be set to 0 for the authentication to be completed
971# successfully.
972#
973# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800974# This determines how sessions are secured with MACsec (only for MACsec
975# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700976# 0: MACsec not in use (default)
977# 1: MACsec enabled - Should secure, accept key server's advice to
978# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800979#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800980# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
981# This setting applies only when MACsec is in use, i.e.,
982# - macsec_policy is enabled
983# - the key server has decided to enable MACsec
984# 0: Encrypt traffic (default)
985# 1: Integrity only
986#
987# macsec_port: IEEE 802.1X/MACsec port
988# Port component of the SCI
989# Range: 1-65534 (default: 1)
990#
Dmitry Shmidt29333592017-01-09 12:27:11 -0800991# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800992# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -0800993# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
994# with lower priority will become the key server and start distributing SAKs.
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800995# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-bytes (128 bit)
996# hex-string (32 hex-digits)
997# mka_ckn (CKN = CAK Name) takes a 32-bytes (256 bit) hex-string (64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800998# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
999# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001000#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001001# mixed_cell: This option can be used to configure whether so called mixed
1002# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001003# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001004# 0 = disabled (default)
1005# 1 = enabled
1006#
1007# proactive_key_caching:
1008# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001009# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001010# 1 = enabled
1011#
1012# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1013# hex without quotation, e.g., 0102030405)
1014# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1015#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001016# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1017# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1018#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001019# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1020# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -08001021# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07001022#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001023# Following fields are only used with internal EAP implementation.
1024# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001025# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001026# cannot be used with WPA; to be used as a Phase 2 method
1027# with EAP-PEAP or EAP-TTLS)
1028# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1029# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1030# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1031# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1032# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1033# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1034# TLS = EAP-TLS (client and server certificate)
1035# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1036# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1037# authentication)
1038# If not set, all compiled in methods are allowed.
1039#
1040# identity: Identity string for EAP
1041# This field is also used to configure user NAI for
1042# EAP-PSK/PAX/SAKE/GPSK.
1043# anonymous_identity: Anonymous identity string for EAP (to be used as the
1044# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07001045# identity, e.g., EAP-TTLS). This field can also be used with
1046# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001047# password: Password string for EAP. This field can include either the
1048# plaintext password (using ASCII or hex string) or a NtPasswordHash
1049# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1050# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1051# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1052# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1053# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001054# variable length PSK. ext:<name of external password field> format can
1055# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001056# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1057# or more trusted CA certificates. If ca_cert and ca_path are not
1058# included, server certificate will not be verified. This is insecure and
1059# a trusted CA certificate should always be configured when using
1060# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1061# change when wpa_supplicant is run in the background.
1062#
1063# Alternatively, this can be used to only perform matching of the server
1064# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1065# this case, the possible CA certificates in the server certificate chain
1066# are ignored and only the server certificate is verified. This is
1067# configured with the following format:
1068# hash:://server/sha256/cert_hash_in_hex
1069# For example: "hash://server/sha256/
1070# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1071#
1072# On Windows, trusted CA certificates can be loaded from the system
1073# certificate store by setting this to cert_store://<name>, e.g.,
1074# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1075# Note that when running wpa_supplicant as an application, the user
1076# certificate store (My user account) is used, whereas computer store
1077# (Computer account) is used when running wpasvc as a service.
1078# ca_path: Directory path for CA certificate files (PEM). This path may
1079# contain multiple CA certificates in OpenSSL format. Common use for this
1080# is to point to system trusted CA list which is often installed into
1081# directory like /etc/ssl/certs. If configured, these certificates are
1082# added to the list of trusted CAs. ca_cert may also be included in that
1083# case, but it is not required.
1084# client_cert: File path to client certificate file (PEM/DER)
1085# Full path should be used since working directory may change when
1086# wpa_supplicant is run in the background.
1087# Alternatively, a named configuration blob can be used by setting this
1088# to blob://<blob name>.
1089# private_key: File path to client private key file (PEM/DER/PFX)
1090# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1091# commented out. Both the private key and certificate will be read from
1092# the PKCS#12 file in this case. Full path should be used since working
1093# directory may change when wpa_supplicant is run in the background.
1094# Windows certificate store can be used by leaving client_cert out and
1095# configuring private_key in one of the following formats:
1096# cert://substring_to_match
1097# hash://certificate_thumbprint_in_hex
1098# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1099# Note that when running wpa_supplicant as an application, the user
1100# certificate store (My user account) is used, whereas computer store
1101# (Computer account) is used when running wpasvc as a service.
1102# Alternatively, a named configuration blob can be used by setting this
1103# to blob://<blob name>.
1104# private_key_passwd: Password for private key file (if left out, this will be
1105# asked through control interface)
1106# dh_file: File path to DH/DSA parameters file (in PEM format)
1107# This is an optional configuration file for setting parameters for an
1108# ephemeral DH key exchange. In most cases, the default RSA
1109# authentication does not use this configuration. However, it is possible
1110# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1111# DSA keys always use ephemeral DH keys. This can be used to achieve
1112# forward secrecy. If the file is in DSA parameters format, it will be
1113# automatically converted into DH params.
1114# subject_match: Substring to be matched against the subject of the
1115# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001116# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001117# The subject string is in following format:
1118# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001119# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001120# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001121# such a use case, domain_suffix_match or domain_match should be used
1122# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001123# altsubject_match: Semicolon separated string of entries to be matched against
1124# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001125# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001126# contains one of the entries in an alternative subject name extension.
1127# altSubjectName string is in following format: TYPE:VALUE
1128# Example: EMAIL:server@example.com
1129# Example: DNS:server.example.com;DNS:server2.example.com
1130# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001131# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001132# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001133# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1134# constraint is met. If no dNSName values are present, this constraint is
1135# matched against SubjectName CN using same suffix match comparison.
1136#
1137# Suffix match here means that the host/domain name is compared one label
1138# at a time starting from the top-level domain and all the labels in
1139# domain_suffix_match shall be included in the certificate. The
1140# certificate may include additional sub-level labels in addition to the
1141# required labels.
1142#
1143# For example, domain_suffix_match=example.com would match
1144# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001145# domain_match: Constraint for server domain name
1146# If set, this FQDN is used as a full match requirement for the
1147# server certificate in SubjectAltName dNSName element(s). If a
1148# matching dNSName is found, this constraint is met. If no dNSName
1149# values are present, this constraint is matched against SubjectName CN
1150# using same full match comparison. This behavior is similar to
1151# domain_suffix_match, but has the requirement of a full match, i.e.,
1152# no subdomains or wildcard matches are allowed. Case-insensitive
1153# comparison is used, so "Example.com" matches "example.com", but would
1154# not match "test.Example.com".
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001155# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1156# (string with field-value pairs, e.g., "peapver=0" or
1157# "peapver=1 peaplabel=1")
1158# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1159# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1160# to be used during key derivation when PEAPv1 or newer. Most existing
1161# PEAPv1 implementation seem to be using the old label, "client EAP
1162# encryption", and wpa_supplicant is now using that as the default value.
1163# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1164# interoperate with PEAPv1; see eap_testing.txt for more details.
1165# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1166# tunneled EAP-Success. This is required with some RADIUS servers that
1167# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1168# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1169# include_tls_length=1 can be used to force wpa_supplicant to include
1170# TLS Message Length field in all TLS messages even if they are not
1171# fragmented.
1172# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1173# challenges (by default, it accepts 2 or 3)
1174# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1175# protected result indication.
1176# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1177# behavior:
1178# * 0 = do not use cryptobinding (default)
1179# * 1 = use cryptobinding if server supports it
1180# * 2 = require cryptobinding
1181# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1182# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001183#
1184# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1185# used to configure a mode that allows EAP-Success (and EAP-Failure)
1186# without going through authentication step. Some switches use such
1187# sequence when forcing the port to be authorized/unauthorized or as a
1188# fallback option if the authentication server is unreachable. By default,
1189# wpa_supplicant discards such frames to protect against potential attacks
1190# by rogue devices, but this option can be used to disable that protection
1191# for cases where the server/authenticator does not need to be
1192# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001193# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1194# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001195# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1196# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001197#
1198# TLS-based methods can use the following parameters to control TLS behavior
1199# (these are normally in the phase1 parameter, but can be used also in the
1200# phase2 parameter when EAP-TLS is used within the inner tunnel):
1201# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1202# TLS library, these may be disabled by default to enforce stronger
1203# security)
1204# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1205# the TLS library to accept certificates even if they are not currently
1206# valid, i.e., have expired or have not yet become valid; this should be
1207# used only for testing purposes)
1208# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1209# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1210# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1211# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001212# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001213# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1214# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001215# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001216# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1217# that have issues interoperating with updated TLS version)
1218# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1219# that have issues interoperating with updated TLS version)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001220# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1221# that have issues interoperating with updated TLS version)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001222# tls_ext_cert_check=0 - No external server certificate validation (default)
1223# tls_ext_cert_check=1 - External server certificate validation enabled; this
1224# requires an external program doing validation of server certificate
1225# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1226# interface and report the result of the validation with
1227# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001228# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1229# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1230# particular when using Suite B with RSA keys of >= 3K (3072) bits
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001231#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001232# Following certificate/private key fields are used in inner Phase2
1233# authentication when using EAP-TTLS or EAP-PEAP.
1234# ca_cert2: File path to CA certificate file. This file can have one or more
1235# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1236# server certificate will not be verified. This is insecure and a trusted
1237# CA certificate should always be configured.
1238# ca_path2: Directory path for CA certificate files (PEM)
1239# client_cert2: File path to client certificate file
1240# private_key2: File path to client private key file
1241# private_key2_passwd: Password for private key file
1242# dh_file2: File path to DH/DSA parameters file (in PEM format)
1243# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001244# authentication server certificate. See subject_match for more details.
1245# altsubject_match2: Semicolon separated string of entries to be matched
1246# against the alternative subject name of the authentication server
1247# certificate. See altsubject_match documentation for more details.
1248# domain_suffix_match2: Constraint for server domain name. See
1249# domain_suffix_match for more details.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001250#
1251# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1252# This value limits the fragment size for EAP methods that support
1253# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1254# small enough to make the EAP messages fit in MTU of the network
1255# interface used for EAPOL. The default value is suitable for most
1256# cases.
1257#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001258# ocsp: Whether to use/require OCSP to check server certificate
1259# 0 = do not use OCSP stapling (TLS certificate status extension)
1260# 1 = try to use OCSP stapling, but not require response
1261# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001262# 3 = require valid OCSP stapling response for all not-trusted
1263# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001264#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001265# openssl_ciphers: OpenSSL specific cipher configuration
1266# This can be used to override the global openssl_ciphers configuration
1267# parameter (see above).
1268#
1269# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1270#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001271# EAP-FAST variables:
1272# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1273# to create this file and write updates to it when PAC is being
1274# provisioned or refreshed. Full path to the file should be used since
1275# working directory may change when wpa_supplicant is run in the
1276# background. Alternatively, a named configuration blob can be used by
1277# setting this to blob://<blob name>
1278# phase1: fast_provisioning option can be used to enable in-line provisioning
1279# of EAP-FAST credentials (PAC):
1280# 0 = disabled,
1281# 1 = allow unauthenticated provisioning,
1282# 2 = allow authenticated provisioning,
1283# 3 = allow both unauthenticated and authenticated provisioning
1284# fast_max_pac_list_len=<num> option can be used to set the maximum
1285# number of PAC entries to store in a PAC list (default: 10)
1286# fast_pac_format=binary option can be used to select binary format for
1287# storing PAC entries in order to save some space (the default
1288# text format uses about 2.5 times the size of minimal binary
1289# format)
1290#
1291# wpa_supplicant supports number of "EAP workarounds" to work around
1292# interoperability issues with incorrectly behaving authentication servers.
1293# These are enabled by default because some of the issues are present in large
1294# number of authentication servers. Strict EAP conformance mode can be
1295# configured by disabling workarounds with eap_workaround=0.
1296
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001297# update_identifier: PPS MO ID
1298# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001299#
1300# roaming_consortium_selection: Roaming Consortium Selection
1301# The matching Roaming Consortium OI that was used to generate this
1302# network profile.
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001303
Dmitry Shmidt04949592012-07-19 12:16:46 -07001304# Station inactivity limit
1305#
1306# If a station does not send anything in ap_max_inactivity seconds, an
1307# empty data frame is sent to it in order to verify whether it is
1308# still in range. If this frame is not ACKed, the station will be
1309# disassociated and then deauthenticated. This feature is used to
1310# clear station table of old entries when the STAs move out of the
1311# range.
1312#
1313# The station can associate again with the AP if it is still in range;
1314# this inactivity poll is just used as a nicer way of verifying
1315# inactivity; i.e., client will not report broken connection because
1316# disassociation frame is not sent immediately without first polling
1317# the STA with a data frame.
1318# default: 300 (i.e., 5 minutes)
1319#ap_max_inactivity=300
1320
1321# DTIM period in Beacon intervals for AP mode (default: 2)
1322#dtim_period=2
1323
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001324# Beacon interval (default: 100 TU)
1325#beacon_int=100
1326
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001327# WPS in AP mode
1328# 0 = WPS enabled and configured (default)
1329# 1 = WPS disabled
1330#wps_disabled=0
1331
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001332# FILS DH Group
1333# 0 = PFS disabled with FILS shared key authentication (default)
1334# 1-65535 = DH Group to use for FILS PFS
1335#fils_dh_group=0
1336
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001337# MAC address policy
1338# 0 = use permanent MAC address
1339# 1 = use random MAC address for each ESS connection
1340# 2 = like 1, but maintain OUI (with local admin bit set)
1341#mac_addr=0
1342
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001343# disable_ht: Whether HT (802.11n) should be disabled.
1344# 0 = HT enabled (if AP supports it)
1345# 1 = HT disabled
1346#
1347# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1348# 0 = HT-40 enabled (if AP supports it)
1349# 1 = HT-40 disabled
1350#
1351# disable_sgi: Whether SGI (short guard interval) should be disabled.
1352# 0 = SGI enabled (if AP supports it)
1353# 1 = SGI disabled
1354#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001355# disable_ldpc: Whether LDPC should be disabled.
1356# 0 = LDPC enabled (if AP supports it)
1357# 1 = LDPC disabled
1358#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001359# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1360# 0 = 40 MHz tolerant (default)
1361# 1 = 40 MHz intolerant
1362#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001363# ht_mcs: Configure allowed MCS rates.
1364# Parsed as an array of bytes, in base-16 (ascii-hex)
1365# ht_mcs="" // Use all available (default)
1366# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1367# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1368#
1369# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1370# -1 = Do not make any changes.
1371# 0 = Enable MAX-AMSDU if hardware supports it.
1372# 1 = Disable AMSDU
1373#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001374# ampdu_factor: Maximum A-MPDU Length Exponent
1375# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1376#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001377# ampdu_density: Allow overriding AMPDU density configuration.
1378# Treated as hint by the kernel.
1379# -1 = Do not make any changes.
1380# 0-3 = Set AMPDU density (aka factor) to specified value.
1381
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001382# disable_vht: Whether VHT should be disabled.
1383# 0 = VHT enabled (if AP supports it)
1384# 1 = VHT disabled
1385#
1386# vht_capa: VHT capabilities to set in the override
1387# vht_capa_mask: mask of VHT capabilities
1388#
1389# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1390# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1391# 0: MCS 0-7
1392# 1: MCS 0-8
1393# 2: MCS 0-9
1394# 3: not supported
1395
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001396##### Fast Session Transfer (FST) support #####################################
1397#
1398# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001399# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1400# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001401#
1402# FST is the transfer of a session from a channel to another channel, in the
1403# same or different frequency bands.
1404#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001405# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001406
1407# Identifier of an FST Group the interface belongs to.
1408#fst_group_id=bond0
1409
1410# Interface priority within the FST Group.
1411# Announcing a higher priority for an interface means declaring it more
1412# preferable for FST switch.
1413# fst_priority is in 1..255 range with 1 being the lowest priority.
1414#fst_priority=100
1415
1416# Default LLT value for this interface in milliseconds. The value used in case
1417# no value provided during session setup. Default is 50 msec.
1418# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1419# Transitioning between states).
1420#fst_llt=100
1421
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001422# Example blocks:
1423
1424# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1425network={
1426 ssid="simple"
1427 psk="very secret passphrase"
1428 priority=5
1429}
1430
1431# Same as previous, but request SSID-specific scanning (for APs that reject
1432# broadcast SSID)
1433network={
1434 ssid="second ssid"
1435 scan_ssid=1
1436 psk="very secret passphrase"
1437 priority=2
1438}
1439
1440# Only WPA-PSK is used. Any valid cipher combination is accepted.
1441network={
1442 ssid="example"
1443 proto=WPA
1444 key_mgmt=WPA-PSK
1445 pairwise=CCMP TKIP
1446 group=CCMP TKIP WEP104 WEP40
1447 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1448 priority=2
1449}
1450
1451# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1452network={
1453 ssid="example"
1454 proto=WPA
1455 key_mgmt=WPA-PSK
1456 pairwise=TKIP
1457 group=TKIP
1458 psk="not so secure passphrase"
1459 wpa_ptk_rekey=600
1460}
1461
1462# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1463# or WEP40 as the group cipher will not be accepted.
1464network={
1465 ssid="example"
1466 proto=RSN
1467 key_mgmt=WPA-EAP
1468 pairwise=CCMP TKIP
1469 group=CCMP TKIP
1470 eap=TLS
1471 identity="user@example.com"
1472 ca_cert="/etc/cert/ca.pem"
1473 client_cert="/etc/cert/user.pem"
1474 private_key="/etc/cert/user.prv"
1475 private_key_passwd="password"
1476 priority=1
1477}
1478
1479# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1480# (e.g., Radiator)
1481network={
1482 ssid="example"
1483 key_mgmt=WPA-EAP
1484 eap=PEAP
1485 identity="user@example.com"
1486 password="foobar"
1487 ca_cert="/etc/cert/ca.pem"
1488 phase1="peaplabel=1"
1489 phase2="auth=MSCHAPV2"
1490 priority=10
1491}
1492
1493# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1494# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1495network={
1496 ssid="example"
1497 key_mgmt=WPA-EAP
1498 eap=TTLS
1499 identity="user@example.com"
1500 anonymous_identity="anonymous@example.com"
1501 password="foobar"
1502 ca_cert="/etc/cert/ca.pem"
1503 priority=2
1504}
1505
1506# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1507# use. Real identity is sent only within an encrypted TLS tunnel.
1508network={
1509 ssid="example"
1510 key_mgmt=WPA-EAP
1511 eap=TTLS
1512 identity="user@example.com"
1513 anonymous_identity="anonymous@example.com"
1514 password="foobar"
1515 ca_cert="/etc/cert/ca.pem"
1516 phase2="auth=MSCHAPV2"
1517}
1518
1519# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1520# authentication.
1521network={
1522 ssid="example"
1523 key_mgmt=WPA-EAP
1524 eap=TTLS
1525 # Phase1 / outer authentication
1526 anonymous_identity="anonymous@example.com"
1527 ca_cert="/etc/cert/ca.pem"
1528 # Phase 2 / inner authentication
1529 phase2="autheap=TLS"
1530 ca_cert2="/etc/cert/ca2.pem"
1531 client_cert2="/etc/cer/user.pem"
1532 private_key2="/etc/cer/user.prv"
1533 private_key2_passwd="password"
1534 priority=2
1535}
1536
1537# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1538# group cipher.
1539network={
1540 ssid="example"
1541 bssid=00:11:22:33:44:55
1542 proto=WPA RSN
1543 key_mgmt=WPA-PSK WPA-EAP
1544 pairwise=CCMP
1545 group=CCMP
1546 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1547}
1548
1549# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1550# and all valid ciphers.
1551network={
1552 ssid=00010203
1553 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1554}
1555
1556
1557# EAP-SIM with a GSM SIM or USIM
1558network={
1559 ssid="eap-sim-test"
1560 key_mgmt=WPA-EAP
1561 eap=SIM
1562 pin="1234"
1563 pcsc=""
1564}
1565
1566
1567# EAP-PSK
1568network={
1569 ssid="eap-psk-test"
1570 key_mgmt=WPA-EAP
1571 eap=PSK
1572 anonymous_identity="eap_psk_user"
1573 password=06b4be19da289f475aa46a33cb793029
1574 identity="eap_psk_user@example.com"
1575}
1576
1577
1578# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1579# EAP-TLS for authentication and key generation; require both unicast and
1580# broadcast WEP keys.
1581network={
1582 ssid="1x-test"
1583 key_mgmt=IEEE8021X
1584 eap=TLS
1585 identity="user@example.com"
1586 ca_cert="/etc/cert/ca.pem"
1587 client_cert="/etc/cert/user.pem"
1588 private_key="/etc/cert/user.prv"
1589 private_key_passwd="password"
1590 eapol_flags=3
1591}
1592
1593
1594# LEAP with dynamic WEP keys
1595network={
1596 ssid="leap-example"
1597 key_mgmt=IEEE8021X
1598 eap=LEAP
1599 identity="user"
1600 password="foobar"
1601}
1602
1603# EAP-IKEv2 using shared secrets for both server and peer authentication
1604network={
1605 ssid="ikev2-example"
1606 key_mgmt=WPA-EAP
1607 eap=IKEV2
1608 identity="user"
1609 password="foobar"
1610}
1611
1612# EAP-FAST with WPA (WPA or WPA2)
1613network={
1614 ssid="eap-fast-test"
1615 key_mgmt=WPA-EAP
1616 eap=FAST
1617 anonymous_identity="FAST-000102030405"
1618 identity="username"
1619 password="password"
1620 phase1="fast_provisioning=1"
1621 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1622}
1623
1624network={
1625 ssid="eap-fast-test"
1626 key_mgmt=WPA-EAP
1627 eap=FAST
1628 anonymous_identity="FAST-000102030405"
1629 identity="username"
1630 password="password"
1631 phase1="fast_provisioning=1"
1632 pac_file="blob://eap-fast-pac"
1633}
1634
1635# Plaintext connection (no WPA, no IEEE 802.1X)
1636network={
1637 ssid="plaintext-test"
1638 key_mgmt=NONE
1639}
1640
1641
1642# Shared WEP key connection (no WPA, no IEEE 802.1X)
1643network={
1644 ssid="static-wep-test"
1645 key_mgmt=NONE
1646 wep_key0="abcde"
1647 wep_key1=0102030405
1648 wep_key2="1234567890123"
1649 wep_tx_keyidx=0
1650 priority=5
1651}
1652
1653
1654# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1655# IEEE 802.11 authentication
1656network={
1657 ssid="static-wep-test2"
1658 key_mgmt=NONE
1659 wep_key0="abcde"
1660 wep_key1=0102030405
1661 wep_key2="1234567890123"
1662 wep_tx_keyidx=0
1663 priority=5
1664 auth_alg=SHARED
1665}
1666
1667
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001668# IBSS/ad-hoc network with RSN
1669network={
1670 ssid="ibss-rsn"
1671 key_mgmt=WPA-PSK
1672 proto=RSN
1673 psk="12345678"
1674 mode=1
1675 frequency=2412
1676 pairwise=CCMP
1677 group=CCMP
1678}
1679
1680# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001681network={
1682 ssid="test adhoc"
1683 mode=1
1684 frequency=2412
1685 proto=WPA
1686 key_mgmt=WPA-NONE
1687 pairwise=NONE
1688 group=TKIP
1689 psk="secret passphrase"
1690}
1691
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001692# open mesh network
1693network={
1694 ssid="test mesh"
1695 mode=5
1696 frequency=2437
1697 key_mgmt=NONE
1698}
1699
1700# secure (SAE + AMPE) network
1701network={
1702 ssid="secure mesh"
1703 mode=5
1704 frequency=2437
1705 key_mgmt=SAE
1706 psk="very secret passphrase"
1707}
1708
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001709
1710# Catch all example that allows more or less all configuration modes
1711network={
1712 ssid="example"
1713 scan_ssid=1
1714 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1715 pairwise=CCMP TKIP
1716 group=CCMP TKIP WEP104 WEP40
1717 psk="very secret passphrase"
1718 eap=TTLS PEAP TLS
1719 identity="user@example.com"
1720 password="foobar"
1721 ca_cert="/etc/cert/ca.pem"
1722 client_cert="/etc/cert/user.pem"
1723 private_key="/etc/cert/user.prv"
1724 private_key_passwd="password"
1725 phase1="peaplabel=0"
1726}
1727
1728# Example of EAP-TLS with smartcard (openssl engine)
1729network={
1730 ssid="example"
1731 key_mgmt=WPA-EAP
1732 eap=TLS
1733 proto=RSN
1734 pairwise=CCMP TKIP
1735 group=CCMP TKIP
1736 identity="user@example.com"
1737 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001738
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001739 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1740 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1741 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001742
1743 # Optional PIN configuration; this can be left out and PIN will be
1744 # asked through the control interface
1745 pin="1234"
1746}
1747
1748# Example configuration showing how to use an inlined blob as a CA certificate
1749# data instead of using external file
1750network={
1751 ssid="example"
1752 key_mgmt=WPA-EAP
1753 eap=TTLS
1754 identity="user@example.com"
1755 anonymous_identity="anonymous@example.com"
1756 password="foobar"
1757 ca_cert="blob://exampleblob"
1758 priority=20
1759}
1760
1761blob-base64-exampleblob={
1762SGVsbG8gV29ybGQhCg==
1763}
1764
1765
1766# Wildcard match for SSID (plaintext APs only). This example select any
1767# open AP regardless of its SSID.
1768network={
1769 key_mgmt=NONE
1770}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001771
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001772# Example configuration blacklisting two APs - these will be ignored
1773# for this network.
1774network={
1775 ssid="example"
1776 psk="very secret passphrase"
1777 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1778}
1779
1780# Example configuration limiting AP selection to a specific set of APs;
1781# any other AP not matching the masked address will be ignored.
1782network={
1783 ssid="example"
1784 psk="very secret passphrase"
1785 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
1786}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001787
1788# Example config file that will only scan on channel 36.
1789freq_list=5180
1790network={
1791 key_mgmt=NONE
1792}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001793
1794
Roshan Pius3a1667e2018-07-03 15:17:14 -07001795# Example configuration using EAP-TTLS for authentication and key
1796# generation for MACsec
1797network={
1798 key_mgmt=IEEE8021X
1799 eap=TTLS
1800 phase2="auth=PAP"
1801 anonymous_identity="anonymous@example.com"
1802 identity="user@example.com"
1803 password="secretr"
1804 ca_cert="/etc/cert/ca.pem"
1805 eapol_flags=0
1806 macsec_policy=1
1807}
1808
1809# Example configuration for MACsec with preshared key
1810network={
1811 key_mgmt=NONE
1812 eapol_flags=0
1813 macsec_policy=1
1814 mka_cak=0123456789ABCDEF0123456789ABCDEF
1815 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
1816 mka_priority=128
1817}