blob: 6faa7af1ff0a31ab29e398b39722555c0a1672a5 [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
186# ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
187# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
188# on cipher suite configuration. This is applicable only if wpa_supplicant is
189# built to use OpenSSL.
190#openssl_ciphers=DEFAULT:!EXP:!LOW
191
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
221# If not configured, UUID will be generated based on the local MAC address.
222#uuid=12345678-9abc-def0-1234-56789abcdef0
223
224# Device Name
225# User-friendly description of device; up to 32 octets encoded in UTF-8
226#device_name=Wireless Client
227
228# Manufacturer
229# The manufacturer of the device (up to 64 ASCII characters)
230#manufacturer=Company
231
232# Model Name
233# Model of the device (up to 32 ASCII characters)
234#model_name=cmodel
235
236# Model Number
237# Additional device description (up to 32 ASCII characters)
238#model_number=123
239
240# Serial Number
241# Serial number of the device (up to 32 characters)
242#serial_number=12345
243
244# Primary Device Type
245# Used format: <categ>-<OUI>-<subcateg>
246# categ = Category as an integer value
247# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
248# default WPS OUI
249# subcateg = OUI-specific Sub Category as an integer value
250# Examples:
251# 1-0050F204-1 (Computer / PC)
252# 1-0050F204-2 (Computer / Server)
253# 5-0050F204-1 (Storage / NAS)
254# 6-0050F204-1 (Network Infrastructure / AP)
255#device_type=1-0050F204-1
256
257# OS Version
258# 4-octet operating system version number (hex string)
259#os_version=01020300
260
261# Config Methods
262# List of the supported configuration methods
263# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
264# nfc_interface push_button keypad virtual_display physical_display
265# virtual_push_button physical_push_button
266# For WSC 1.0:
267#config_methods=label display push_button keypad
268# For WSC 2.0:
269#config_methods=label virtual_display virtual_push_button keypad
270
271# Credential processing
272# 0 = process received credentials internally (default)
273# 1 = do not process received credentials; just pass them over ctrl_iface to
274# external program(s)
275# 2 = process received credentials internally and pass them over ctrl_iface
276# to external program(s)
277#wps_cred_processing=0
278
Dmitry Shmidt04949592012-07-19 12:16:46 -0700279# Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
280# The vendor attribute contents to be added in M1 (hex string)
281#wps_vendor_ext_m1=000137100100020001
282
283# NFC password token for WPS
284# These parameters can be used to configure a fixed NFC password token for the
285# station. This can be generated, e.g., with nfc_pw_token. When these
286# parameters are used, the station is assumed to be deployed with a NFC tag
287# that includes the matching NFC password token (e.g., written based on the
288# NDEF record from nfc_pw_token).
289#
290#wps_nfc_dev_pw_id: Device Password ID (16..65535)
291#wps_nfc_dh_pubkey: Hexdump of DH Public Key
292#wps_nfc_dh_privkey: Hexdump of DH Private Key
293#wps_nfc_dev_pw: Hexdump of Device Password
294
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700295# Priority for the networks added through WPS
296# This priority value will be set to each network profile that is added
297# by executing the WPS protocol.
298#wps_priority=0
299
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800300# Maximum number of BSS entries to keep in memory
301# Default: 200
302# This can be used to limit memory use on the BSS entries (cached scan
303# results). A larger value may be needed in environments that have huge number
304# of APs when using ap_scan=1 mode.
305#bss_max_count=200
306
Dmitry Shmidt04949592012-07-19 12:16:46 -0700307# Automatic scan
308# This is an optional set of parameters for automatic scanning
309# within an interface in following format:
310#autoscan=<autoscan module name>:<module parameters>
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800311# autoscan is like bgscan but on disconnected or inactive state.
312# For instance, on exponential module parameters would be <base>:<limit>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700313#autoscan=exponential:3:300
314# Which means a delay between scans on a base exponential of 3,
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800315# up to the limit of 300 seconds (3, 9, 27 ... 300)
316# For periodic module, parameters would be <fixed interval>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700317#autoscan=periodic:30
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800318# So a delay of 30 seconds will be applied between each scan.
319# Note: If sched_scan_plans are configured and supported by the driver,
320# autoscan is ignored.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800321
322# filter_ssids - SSID-based scan result filtering
323# 0 = do not filter scan results (default)
324# 1 = only include configured SSIDs in scan results/BSS table
325#filter_ssids=0
326
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700327# Password (and passphrase, etc.) backend for external storage
328# format: <backend name>[:<optional backend parameters>]
329#ext_password_backend=test:pw1=password|pw2=testing
330
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700331
332# Disable P2P functionality
333# p2p_disabled=1
334
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700335# Timeout in seconds to detect STA inactivity (default: 300 seconds)
336#
337# This timeout value is used in P2P GO mode to clean up
338# inactive stations.
339#p2p_go_max_inactivity=300
340
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700341# Passphrase length (8..63) for P2P GO
342#
343# This parameter controls the length of the random passphrase that is
344# generated at the GO. Default: 8.
345#p2p_passphrase_len=8
346
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700347# Extra delay between concurrent P2P search iterations
348#
349# This value adds extra delay in milliseconds between concurrent search
350# iterations to make p2p_find friendlier to concurrent operations by avoiding
351# it from taking 100% of radio resources. The default value is 500 ms.
352#p2p_search_delay=500
353
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800354# Opportunistic Key Caching (also known as Proactive Key Caching) default
355# This parameter can be used to set the default behavior for the
356# proactive_key_caching parameter. By default, OKC is disabled unless enabled
357# with the global okc=1 parameter or with the per-network
358# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
359# can be disabled with per-network proactive_key_caching=0 parameter.
360#okc=0
361
362# Protected Management Frames default
363# This parameter can be used to set the default behavior for the ieee80211w
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700364# parameter for RSN networks. By default, PMF is disabled unless enabled with
365# the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
366# With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
367# per-network ieee80211w parameter. This global default value does not apply
368# for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
369# RSN.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800370#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800371
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800372# Enabled SAE finite cyclic groups in preference order
373# By default (if this parameter is not set), the mandatory group 19 (ECC group
374# defined over a 256-bit prime order field) is preferred, but other groups are
375# also enabled. If this parameter is set, the groups will be tried in the
376# indicated order. The group values are listed in the IANA registry:
377# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
378#sae_groups=21 20 19 26 25
379
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800380# Default value for DTIM period (if not overridden in network block)
381#dtim_period=2
382
383# Default value for Beacon interval (if not overridden in network block)
384#beacon_int=100
385
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700386# Additional vendor specific elements for Beacon and Probe Response frames
387# This parameter can be used to add additional vendor specific element(s) into
388# the end of the Beacon and Probe Response frames. The format for these
389# element(s) is a hexdump of the raw information elements (id+len+payload for
390# one or more elements). This is used in AP and P2P GO modes.
391#ap_vendor_elements=dd0411223301
392
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700393# Ignore scan results older than request
394#
395# The driver may have a cache of scan results that makes it return
396# information that is older than our scan trigger. This parameter can
397# be used to configure such old information to be ignored instead of
398# allowing it to update the internal BSS table.
399#ignore_old_scan_res=0
400
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700401# scan_cur_freq: Whether to scan only the current frequency
402# 0: Scan all available frequencies. (Default)
403# 1: Scan current operating frequency if another VIF on the same radio
404# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700405
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700406# MAC address policy default
407# 0 = use permanent MAC address
408# 1 = use random MAC address for each ESS connection
409# 2 = like 1, but maintain OUI (with local admin bit set)
410#
411# By default, permanent MAC address is used unless policy is changed by
412# the per-network mac_addr parameter. Global mac_addr=1 can be used to
413# change this default behavior.
414#mac_addr=0
415
416# Lifetime of random MAC address in seconds (default: 60)
417#rand_addr_lifetime=60
418
419# MAC address policy for pre-association operations (scanning, ANQP)
420# 0 = use permanent MAC address
421# 1 = use random MAC address
422# 2 = like 1, but maintain OUI (with local admin bit set)
423#preassoc_mac_addr=0
424
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800425# MAC address policy for GAS operations
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#gas_rand_mac_addr=0
430
431# Lifetime of GAS random MAC address in seconds (default: 60)
432#gas_rand_addr_lifetime=60
433
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800434# Interworking (IEEE 802.11u)
435
436# Enable Interworking
437# interworking=1
438
439# Homogenous ESS identifier
440# If this is set, scans will be used to request response only from BSSes
441# belonging to the specified Homogeneous ESS. This is used only if interworking
442# is enabled.
443# hessid=00:11:22:33:44:55
444
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700445# Automatic network selection behavior
446# 0 = do not automatically go through Interworking network selection
447# (i.e., require explicit interworking_select command for this; default)
448# 1 = perform Interworking network selection if one or more
449# credentials have been configured and scan did not find a
450# matching network block
451#auto_interworking=0
452
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700453# GAS Address3 field behavior
454# 0 = P2P specification (Address3 = AP BSSID); default
455# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
456# sent to not-associated AP; if associated, AP BSSID)
457#gas_address3=0
458
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700459# Publish fine timing measurement (FTM) responder functionality in
460# the Extended Capabilities element bit 70.
461# Controls whether FTM responder functionality will be published by AP/STA.
462# Note that actual FTM responder operation is managed outside wpa_supplicant.
463# 0 = Do not publish; default
464# 1 = Publish
465#ftm_responder=0
466
467# Publish fine timing measurement (FTM) initiator functionality in
468# the Extended Capabilities element bit 71.
469# Controls whether FTM initiator functionality will be published by AP/STA.
470# Note that actual FTM initiator operation is managed outside wpa_supplicant.
471# 0 = Do not publish; default
472# 1 = Publish
473#ftm_initiator=0
474
Dmitry Shmidt04949592012-07-19 12:16:46 -0700475# credential block
476#
477# Each credential used for automatic network selection is configured as a set
478# of parameters that are compared to the information advertised by the APs when
479# interworking_select and interworking_connect commands are used.
480#
481# credential fields:
482#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800483# temporary: Whether this credential is temporary and not to be saved
484#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700485# priority: Priority group
486# By default, all networks and credentials get the same priority group
487# (0). This field can be used to give higher priority for credentials
488# (and similarly in struct wpa_ssid for network blocks) to change the
489# Interworking automatic networking selection behavior. The matching
490# network (based on either an enabled network block or a credential)
491# with the highest priority value will be selected.
492#
493# pcsc: Use PC/SC and SIM/USIM card
494#
495# realm: Home Realm for Interworking
496#
497# username: Username for Interworking network selection
498#
499# password: Password for Interworking network selection
500#
501# ca_cert: CA certificate for Interworking network selection
502#
503# client_cert: File path to client certificate file (PEM/DER)
504# This field is used with Interworking networking selection for a case
505# where client certificate/private key is used for authentication
506# (EAP-TLS). Full path to the file should be used since working
507# directory may change when wpa_supplicant is run in the background.
508#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700509# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
510#
511# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
512#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700513# Alternatively, a named configuration blob can be used by setting
514# this to blob://blob_name.
515#
516# private_key: File path to client private key file (PEM/DER/PFX)
517# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
518# commented out. Both the private key and certificate will be read
519# from the PKCS#12 file in this case. Full path to the file should be
520# used since working directory may change when wpa_supplicant is run
521# in the background.
522#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700523# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
524# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
525#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700526# Windows certificate store can be used by leaving client_cert out and
527# configuring private_key in one of the following formats:
528#
529# cert://substring_to_match
530#
531# hash://certificate_thumbprint_in_hex
532#
533# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
534#
535# Note that when running wpa_supplicant as an application, the user
536# certificate store (My user account) is used, whereas computer store
537# (Computer account) is used when running wpasvc as a service.
538#
539# Alternatively, a named configuration blob can be used by setting
540# this to blob://blob_name.
541#
542# private_key_passwd: Password for private key file
543#
544# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
545#
546# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
547# format
548#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700549# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700550# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700551# whether the AP is operated by the Home SP. Multiple domain entries can
552# be used to configure alternative FQDNs that will be considered home
553# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700554#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700555# roaming_consortium: Roaming Consortium OI
556# If roaming_consortium_len is non-zero, this field contains the
557# Roaming Consortium OI that can be used to determine which access
558# points support authentication with this credential. This is an
559# alternative to the use of the realm parameter. When using Roaming
560# Consortium to match the network, the EAP parameters need to be
561# pre-configured with the credential since the NAI Realm information
562# may not be available or fetched.
563#
564# eap: Pre-configured EAP method
565# This optional field can be used to specify which EAP method will be
566# used with this credential. If not set, the EAP method is selected
567# automatically based on ANQP information (e.g., NAI Realm).
568#
569# phase1: Pre-configure Phase 1 (outer authentication) parameters
570# This optional field is used with like the 'eap' parameter.
571#
572# phase2: Pre-configure Phase 2 (inner authentication) parameters
573# This optional field is used with like the 'eap' parameter.
574#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800575# excluded_ssid: Excluded SSID
576# This optional field can be used to excluded specific SSID(s) from
577# matching with the network. Multiple entries can be used to specify more
578# than one SSID.
579#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800580# roaming_partner: Roaming partner information
581# This optional field can be used to configure preferences between roaming
582# partners. The field is a string in following format:
583# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
584# (non-exact match means any subdomain matches the entry; priority is in
585# 0..255 range with 0 being the highest priority)
586#
587# update_identifier: PPS MO ID
588# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
589#
590# provisioning_sp: FQDN of the SP that provisioned the credential
591# This optional field can be used to keep track of the SP that provisioned
592# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
593#
594# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
595# These fields can be used to specify minimum download/upload backhaul
596# bandwidth that is preferred for the credential. This constraint is
597# ignored if the AP does not advertise WAN Metrics information or if the
598# limit would prevent any connection. Values are in kilobits per second.
599# min_dl_bandwidth_home
600# min_ul_bandwidth_home
601# min_dl_bandwidth_roaming
602# min_ul_bandwidth_roaming
603#
604# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
605# (PPS/<X+>/Policy/MaximumBSSLoadValue)
606# This value is used as the maximum channel utilization for network
607# selection purposes for home networks. If the AP does not advertise
608# BSS Load or if the limit would prevent any connection, this constraint
609# will be ignored.
610#
611# req_conn_capab: Required connection capability
612# (PPS/<X+>/Policy/RequiredProtoPortTuple)
613# This value is used to configure set of required protocol/port pairs that
614# a roaming network shall support (include explicitly in Connection
615# Capability ANQP element). This constraint is ignored if the AP does not
616# advertise Connection Capability or if this constraint would prevent any
617# network connection. This policy is not used in home networks.
618# Format: <protocol>[:<comma-separated list of ports]
619# Multiple entries can be used to list multiple requirements.
620# For example, number of common TCP protocols:
621# req_conn_capab=6,22,80,443
622# For example, IPSec/IKE:
623# req_conn_capab=17:500
624# req_conn_capab=50
625#
626# ocsp: Whether to use/require OCSP to check server certificate
627# 0 = do not use OCSP stapling (TLS certificate status extension)
628# 1 = try to use OCSP stapling, but not require response
629# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800630# 3 = require valid OCSP stapling response for all not-trusted
631# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800632#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700633# sim_num: Identifier for which SIM to use in multi-SIM devices
634#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700635# for example:
636#
637#cred={
638# realm="example.com"
639# username="user@example.com"
640# password="password"
641# ca_cert="/etc/wpa_supplicant/ca.pem"
642# domain="example.com"
643#}
644#
645#cred={
646# imsi="310026-000000000"
647# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
648#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700649#
650#cred={
651# realm="example.com"
652# username="user"
653# password="password"
654# ca_cert="/etc/wpa_supplicant/ca.pem"
655# domain="example.com"
656# roaming_consortium=223344
657# eap=TTLS
658# phase2="auth=MSCHAPV2"
659#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800660
Dmitry Shmidt04949592012-07-19 12:16:46 -0700661# Hotspot 2.0
662# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800663
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800664# Scheduled scan plans
665#
666# A space delimited list of scan plans. Each scan plan specifies the scan
667# interval and number of iterations, delimited by a colon. The last scan plan
668# will run infinitely and thus must specify only the interval and not the number
669# of iterations.
670#
671# The driver advertises the maximum number of scan plans supported. If more scan
672# plans than supported are configured, only the first ones are set (up to the
673# maximum supported). The last scan plan that specifies only the interval is
674# always set as the last plan.
675#
676# If the scan interval or the number of iterations for a scan plan exceeds the
677# maximum supported, it will be set to the maximum supported value.
678#
679# Format:
680# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
681#
682# Example:
683# sched_scan_plans=10:100 20:200 30
684
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800685# Multi Band Operation (MBO) non-preferred channels
686# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700687# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800688# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700689# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800690# Example:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700691# non_pref_chan="81:5:10:2 81:1:0:2 81:9:0:2"
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800692
693# MBO Cellular Data Capabilities
694# 1 = Cellular data connection available
695# 2 = Cellular data connection not available
696# 3 = Not cellular capable (default)
697#mbo_cell_capa=3
698
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800699# network block
700#
701# Each network (usually AP's sharing the same SSID) is configured as a separate
702# block in this configuration file. The network blocks are in preference order
703# (the first match is used).
704#
705# network block fields:
706#
707# disabled:
708# 0 = this network can be used (default)
709# 1 = this network block is disabled (can be enabled through ctrl_iface,
710# e.g., with wpa_cli or wpa_gui)
711#
712# id_str: Network identifier string for external scripts. This value is passed
713# to external action script through wpa_cli as WPA_ID_STR environment
714# variable to make it easier to do network specific configuration.
715#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700716# ssid: SSID (mandatory); network name in one of the optional formats:
717# - an ASCII string with double quotation
718# - a hex string (two characters per octet of SSID)
719# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800720#
721# scan_ssid:
722# 0 = do not scan this SSID with specific Probe Request frames (default)
723# 1 = scan with SSID-specific Probe Request frames (this can be used to
724# find APs that do not accept broadcast SSID or use multiple SSIDs;
725# this will add latency to scanning, so enable this only when needed)
726#
727# bssid: BSSID (optional); if set, this network block is used only when
728# associating with the AP using the configured BSSID
729#
730# priority: priority group (integer)
731# By default, all networks will get same priority group (0). If some of the
732# networks are more desirable, this field can be used to change the order in
733# which wpa_supplicant goes through the networks when selecting a BSS. The
734# priority groups will be iterated in decreasing priority (i.e., the larger the
735# priority value, the sooner the network is matched against the scan results).
736# Within each priority group, networks will be selected based on security
737# policy, signal strength, etc.
738# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
739# using this priority to select the order for scanning. Instead, they try the
740# networks in the order that used in the configuration file.
741#
742# mode: IEEE 802.11 operation mode
743# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
744# 1 = IBSS (ad-hoc, peer-to-peer)
745# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800746# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
747# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
748# TKIP/CCMP) is available for backwards compatibility, but its use is
749# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800750# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
751# both), and psk must also be set.
752#
753# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
754# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
755# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
756# In addition, this value is only used by the station that creates the IBSS. If
757# an IBSS network with the configured SSID is already present, the frequency of
758# the network will be used instead of this configured value.
759#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800760# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700761# 0 = do not use PBSS
762# 1 = use PBSS
763# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800764# Used together with mode configuration. When mode is AP, it means to start a
765# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700766# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
767# which means connect to either PCP or AP.
768# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800769# For more details, see IEEE Std 802.11ad-2012.
770#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800771# scan_freq: List of frequencies to scan
772# Space-separated list of frequencies in MHz to scan when searching for this
773# BSS. If the subset of channels used by the network is known, this option can
774# be used to optimize scanning to not occur on channels that the network does
775# not use. Example: scan_freq=2412 2437 2462
776#
777# freq_list: Array of allowed frequencies
778# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
779# set, scan results that do not match any of the specified frequencies are not
780# considered when selecting a BSS.
781#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700782# This can also be set on the outside of the network block. In this case,
783# it limits the frequencies that will be scanned.
784#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800785# bgscan: Background scanning
786# wpa_supplicant behavior for background scanning can be specified by
787# configuring a bgscan module. These modules are responsible for requesting
788# background scans for the purpose of roaming within an ESS (i.e., within a
789# single network block with all the APs using the same SSID). The bgscan
790# parameter uses following format: "<bgscan module name>:<module parameters>"
791# Following bgscan modules are available:
792# simple - Periodic background scans based on signal strength
793# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
794# <long interval>"
795# bgscan="simple:30:-45:300"
796# learn - Learn channels used by the network and try to avoid bgscans on other
797# channels (experimental)
798# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
799# <long interval>[:<database file name>]"
800# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800801# Explicitly disable bgscan by setting
802# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800803#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800804# This option can also be set outside of all network blocks for the bgscan
805# parameter to apply for all the networks that have no specific bgscan
806# parameter.
807#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800808# proto: list of accepted protocols
809# WPA = WPA/IEEE 802.11i/D3.0
810# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
811# If not set, this defaults to: WPA RSN
812#
813# key_mgmt: list of accepted authenticated key management protocols
814# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
815# WPA-EAP = WPA using EAP authentication
816# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
817# generated WEP keys
818# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800819# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
820# instead)
821# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
822# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800823# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
824# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800825# SAE = Simultaneous authentication of equals; pre-shared key/password -based
826# authentication with stronger security than WPA-PSK especially when using
827# not that strong password
828# FT-SAE = SAE with FT
829# WPA-EAP-SUITE-B = Suite B 128-bit level
830# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800831# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800832# FILS-SHA256 = Fast Initial Link Setup with SHA256
833# FILS-SHA384 = Fast Initial Link Setup with SHA384
834# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
835# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800836# If not set, this defaults to: WPA-PSK WPA-EAP
837#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700838# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800839# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700840# 1 = optional
841# 2 = required
842# The most common configuration options for this based on the PMF (protected
843# management frames) certification program are:
844# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
845# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
846# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
847#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800848# auth_alg: list of allowed IEEE 802.11 authentication algorithms
849# OPEN = Open System authentication (required for WPA/WPA2)
850# SHARED = Shared Key authentication (requires static WEP keys)
851# LEAP = LEAP/Network EAP (only used with LEAP)
852# If not set, automatic selection is used (Open System with LEAP enabled if
853# LEAP is allowed as one of the EAP methods).
854#
855# pairwise: list of accepted pairwise (unicast) ciphers for WPA
856# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
857# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
858# NONE = Use only Group Keys (deprecated, should not be included if APs support
859# pairwise keys)
860# If not set, this defaults to: CCMP TKIP
861#
862# group: list of accepted group (broadcast/multicast) ciphers for WPA
863# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
864# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
865# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
866# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
867# If not set, this defaults to: CCMP TKIP WEP104 WEP40
868#
869# psk: WPA preshared key; 256-bit pre-shared key
870# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
871# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
872# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700873# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
874# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800875# This field is not needed, if WPA-EAP is used.
876# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
877# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
878# startup and reconfiguration time can be optimized by generating the PSK only
879# only when the passphrase or SSID has actually changed.
880#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -0700881# mem_only_psk: Whether to keep PSK/passphrase only in memory
882# 0 = allow psk/passphrase to be stored to the configuration file
883# 1 = do not store psk/passphrase to the configuration file
884#mem_only_psk=0
885#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800886# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
887# Dynamic WEP key required for non-WPA mode
888# bit0 (1): require dynamically generated unicast WEP key
889# bit1 (2): require dynamically generated broadcast WEP key
890# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800891# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700892# eapol_flags must be set to 0 for the authentication to be completed
893# successfully.
894#
895# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800896# This determines how sessions are secured with MACsec (only for MACsec
897# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700898# 0: MACsec not in use (default)
899# 1: MACsec enabled - Should secure, accept key server's advice to
900# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800901#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800902# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
903# This setting applies only when MACsec is in use, i.e.,
904# - macsec_policy is enabled
905# - the key server has decided to enable MACsec
906# 0: Encrypt traffic (default)
907# 1: Integrity only
908#
909# macsec_port: IEEE 802.1X/MACsec port
910# Port component of the SCI
911# Range: 1-65534 (default: 1)
912#
Dmitry Shmidt29333592017-01-09 12:27:11 -0800913# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800914# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -0800915# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
916# with lower priority will become the key server and start distributing SAKs.
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800917# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-bytes (128 bit)
918# hex-string (32 hex-digits)
919# mka_ckn (CKN = CAK Name) takes a 32-bytes (256 bit) hex-string (64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800920# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
921# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800922#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800923# mixed_cell: This option can be used to configure whether so called mixed
924# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800925# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800926# 0 = disabled (default)
927# 1 = enabled
928#
929# proactive_key_caching:
930# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800931# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800932# 1 = enabled
933#
934# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
935# hex without quotation, e.g., 0102030405)
936# wep_tx_keyidx: Default WEP key index (TX) (0..3)
937#
938# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
939# allowed. This is only used with RSN/WPA2.
940# 0 = disabled (default)
941# 1 = enabled
942#peerkey=1
943#
944# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
945# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
946#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -0700947# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
948# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
Paul Stewart092955c2017-02-06 09:13:09 -0800949# Authenticator role in IBSS, or in AP and mesh modes.
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -0700950#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800951# Following fields are only used with internal EAP implementation.
952# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700953# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800954# cannot be used with WPA; to be used as a Phase 2 method
955# with EAP-PEAP or EAP-TTLS)
956# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
957# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
958# OTP = EAP-OTP (cannot be used separately with WPA; to be used
959# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
960# GTC = EAP-GTC (cannot be used separately with WPA; to be used
961# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
962# TLS = EAP-TLS (client and server certificate)
963# PEAP = EAP-PEAP (with tunnelled EAP authentication)
964# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
965# authentication)
966# If not set, all compiled in methods are allowed.
967#
968# identity: Identity string for EAP
969# This field is also used to configure user NAI for
970# EAP-PSK/PAX/SAKE/GPSK.
971# anonymous_identity: Anonymous identity string for EAP (to be used as the
972# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700973# identity, e.g., EAP-TTLS). This field can also be used with
974# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800975# password: Password string for EAP. This field can include either the
976# plaintext password (using ASCII or hex string) or a NtPasswordHash
977# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
978# NtPasswordHash can only be used when the password is for MSCHAPv2 or
979# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
980# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
981# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700982# variable length PSK. ext:<name of external password field> format can
983# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800984# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
985# or more trusted CA certificates. If ca_cert and ca_path are not
986# included, server certificate will not be verified. This is insecure and
987# a trusted CA certificate should always be configured when using
988# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
989# change when wpa_supplicant is run in the background.
990#
991# Alternatively, this can be used to only perform matching of the server
992# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
993# this case, the possible CA certificates in the server certificate chain
994# are ignored and only the server certificate is verified. This is
995# configured with the following format:
996# hash:://server/sha256/cert_hash_in_hex
997# For example: "hash://server/sha256/
998# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
999#
1000# On Windows, trusted CA certificates can be loaded from the system
1001# certificate store by setting this to cert_store://<name>, e.g.,
1002# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1003# Note that when running wpa_supplicant as an application, the user
1004# certificate store (My user account) is used, whereas computer store
1005# (Computer account) is used when running wpasvc as a service.
1006# ca_path: Directory path for CA certificate files (PEM). This path may
1007# contain multiple CA certificates in OpenSSL format. Common use for this
1008# is to point to system trusted CA list which is often installed into
1009# directory like /etc/ssl/certs. If configured, these certificates are
1010# added to the list of trusted CAs. ca_cert may also be included in that
1011# case, but it is not required.
1012# client_cert: File path to client certificate file (PEM/DER)
1013# Full path should be used since working directory may change when
1014# wpa_supplicant is run in the background.
1015# Alternatively, a named configuration blob can be used by setting this
1016# to blob://<blob name>.
1017# private_key: File path to client private key file (PEM/DER/PFX)
1018# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1019# commented out. Both the private key and certificate will be read from
1020# the PKCS#12 file in this case. Full path should be used since working
1021# directory may change when wpa_supplicant is run in the background.
1022# Windows certificate store can be used by leaving client_cert out and
1023# configuring private_key in one of the following formats:
1024# cert://substring_to_match
1025# hash://certificate_thumbprint_in_hex
1026# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1027# Note that when running wpa_supplicant as an application, the user
1028# certificate store (My user account) is used, whereas computer store
1029# (Computer account) is used when running wpasvc as a service.
1030# Alternatively, a named configuration blob can be used by setting this
1031# to blob://<blob name>.
1032# private_key_passwd: Password for private key file (if left out, this will be
1033# asked through control interface)
1034# dh_file: File path to DH/DSA parameters file (in PEM format)
1035# This is an optional configuration file for setting parameters for an
1036# ephemeral DH key exchange. In most cases, the default RSA
1037# authentication does not use this configuration. However, it is possible
1038# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1039# DSA keys always use ephemeral DH keys. This can be used to achieve
1040# forward secrecy. If the file is in DSA parameters format, it will be
1041# automatically converted into DH params.
1042# subject_match: Substring to be matched against the subject of the
1043# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001044# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001045# The subject string is in following format:
1046# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001047# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001048# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001049# such a use case, domain_suffix_match or domain_match should be used
1050# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001051# altsubject_match: Semicolon separated string of entries to be matched against
1052# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001053# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001054# contains one of the entries in an alternative subject name extension.
1055# altSubjectName string is in following format: TYPE:VALUE
1056# Example: EMAIL:server@example.com
1057# Example: DNS:server.example.com;DNS:server2.example.com
1058# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001059# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001060# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001061# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1062# constraint is met. If no dNSName values are present, this constraint is
1063# matched against SubjectName CN using same suffix match comparison.
1064#
1065# Suffix match here means that the host/domain name is compared one label
1066# at a time starting from the top-level domain and all the labels in
1067# domain_suffix_match shall be included in the certificate. The
1068# certificate may include additional sub-level labels in addition to the
1069# required labels.
1070#
1071# For example, domain_suffix_match=example.com would match
1072# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001073# domain_match: Constraint for server domain name
1074# If set, this FQDN is used as a full match requirement for the
1075# server certificate in SubjectAltName dNSName element(s). If a
1076# matching dNSName is found, this constraint is met. If no dNSName
1077# values are present, this constraint is matched against SubjectName CN
1078# using same full match comparison. This behavior is similar to
1079# domain_suffix_match, but has the requirement of a full match, i.e.,
1080# no subdomains or wildcard matches are allowed. Case-insensitive
1081# comparison is used, so "Example.com" matches "example.com", but would
1082# not match "test.Example.com".
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001083# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1084# (string with field-value pairs, e.g., "peapver=0" or
1085# "peapver=1 peaplabel=1")
1086# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1087# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1088# to be used during key derivation when PEAPv1 or newer. Most existing
1089# PEAPv1 implementation seem to be using the old label, "client EAP
1090# encryption", and wpa_supplicant is now using that as the default value.
1091# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1092# interoperate with PEAPv1; see eap_testing.txt for more details.
1093# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1094# tunneled EAP-Success. This is required with some RADIUS servers that
1095# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1096# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1097# include_tls_length=1 can be used to force wpa_supplicant to include
1098# TLS Message Length field in all TLS messages even if they are not
1099# fragmented.
1100# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1101# challenges (by default, it accepts 2 or 3)
1102# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1103# protected result indication.
1104# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1105# behavior:
1106# * 0 = do not use cryptobinding (default)
1107# * 1 = use cryptobinding if server supports it
1108# * 2 = require cryptobinding
1109# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1110# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001111#
1112# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1113# used to configure a mode that allows EAP-Success (and EAP-Failure)
1114# without going through authentication step. Some switches use such
1115# sequence when forcing the port to be authorized/unauthorized or as a
1116# fallback option if the authentication server is unreachable. By default,
1117# wpa_supplicant discards such frames to protect against potential attacks
1118# by rogue devices, but this option can be used to disable that protection
1119# for cases where the server/authenticator does not need to be
1120# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001121# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1122# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001123# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1124# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001125#
1126# TLS-based methods can use the following parameters to control TLS behavior
1127# (these are normally in the phase1 parameter, but can be used also in the
1128# phase2 parameter when EAP-TLS is used within the inner tunnel):
1129# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1130# TLS library, these may be disabled by default to enforce stronger
1131# security)
1132# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1133# the TLS library to accept certificates even if they are not currently
1134# valid, i.e., have expired or have not yet become valid; this should be
1135# used only for testing purposes)
1136# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1137# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1138# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1139# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001140# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001141# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1142# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001143# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001144# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1145# that have issues interoperating with updated TLS version)
1146# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1147# that have issues interoperating with updated TLS version)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001148# tls_ext_cert_check=0 - No external server certificate validation (default)
1149# tls_ext_cert_check=1 - External server certificate validation enabled; this
1150# requires an external program doing validation of server certificate
1151# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1152# interface and report the result of the validation with
1153# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001154#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001155# Following certificate/private key fields are used in inner Phase2
1156# authentication when using EAP-TTLS or EAP-PEAP.
1157# ca_cert2: File path to CA certificate file. This file can have one or more
1158# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1159# server certificate will not be verified. This is insecure and a trusted
1160# CA certificate should always be configured.
1161# ca_path2: Directory path for CA certificate files (PEM)
1162# client_cert2: File path to client certificate file
1163# private_key2: File path to client private key file
1164# private_key2_passwd: Password for private key file
1165# dh_file2: File path to DH/DSA parameters file (in PEM format)
1166# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001167# authentication server certificate. See subject_match for more details.
1168# altsubject_match2: Semicolon separated string of entries to be matched
1169# against the alternative subject name of the authentication server
1170# certificate. See altsubject_match documentation for more details.
1171# domain_suffix_match2: Constraint for server domain name. See
1172# domain_suffix_match for more details.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001173#
1174# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1175# This value limits the fragment size for EAP methods that support
1176# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1177# small enough to make the EAP messages fit in MTU of the network
1178# interface used for EAPOL. The default value is suitable for most
1179# cases.
1180#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001181# ocsp: Whether to use/require OCSP to check server certificate
1182# 0 = do not use OCSP stapling (TLS certificate status extension)
1183# 1 = try to use OCSP stapling, but not require response
1184# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001185# 3 = require valid OCSP stapling response for all not-trusted
1186# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001187#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001188# openssl_ciphers: OpenSSL specific cipher configuration
1189# This can be used to override the global openssl_ciphers configuration
1190# parameter (see above).
1191#
1192# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1193#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001194# EAP-FAST variables:
1195# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1196# to create this file and write updates to it when PAC is being
1197# provisioned or refreshed. Full path to the file should be used since
1198# working directory may change when wpa_supplicant is run in the
1199# background. Alternatively, a named configuration blob can be used by
1200# setting this to blob://<blob name>
1201# phase1: fast_provisioning option can be used to enable in-line provisioning
1202# of EAP-FAST credentials (PAC):
1203# 0 = disabled,
1204# 1 = allow unauthenticated provisioning,
1205# 2 = allow authenticated provisioning,
1206# 3 = allow both unauthenticated and authenticated provisioning
1207# fast_max_pac_list_len=<num> option can be used to set the maximum
1208# number of PAC entries to store in a PAC list (default: 10)
1209# fast_pac_format=binary option can be used to select binary format for
1210# storing PAC entries in order to save some space (the default
1211# text format uses about 2.5 times the size of minimal binary
1212# format)
1213#
1214# wpa_supplicant supports number of "EAP workarounds" to work around
1215# interoperability issues with incorrectly behaving authentication servers.
1216# These are enabled by default because some of the issues are present in large
1217# number of authentication servers. Strict EAP conformance mode can be
1218# configured by disabling workarounds with eap_workaround=0.
1219
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001220# update_identifier: PPS MO ID
1221# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1222
Dmitry Shmidt04949592012-07-19 12:16:46 -07001223# Station inactivity limit
1224#
1225# If a station does not send anything in ap_max_inactivity seconds, an
1226# empty data frame is sent to it in order to verify whether it is
1227# still in range. If this frame is not ACKed, the station will be
1228# disassociated and then deauthenticated. This feature is used to
1229# clear station table of old entries when the STAs move out of the
1230# range.
1231#
1232# The station can associate again with the AP if it is still in range;
1233# this inactivity poll is just used as a nicer way of verifying
1234# inactivity; i.e., client will not report broken connection because
1235# disassociation frame is not sent immediately without first polling
1236# the STA with a data frame.
1237# default: 300 (i.e., 5 minutes)
1238#ap_max_inactivity=300
1239
1240# DTIM period in Beacon intervals for AP mode (default: 2)
1241#dtim_period=2
1242
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001243# Beacon interval (default: 100 TU)
1244#beacon_int=100
1245
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001246# WPS in AP mode
1247# 0 = WPS enabled and configured (default)
1248# 1 = WPS disabled
1249#wps_disabled=0
1250
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001251# MAC address policy
1252# 0 = use permanent MAC address
1253# 1 = use random MAC address for each ESS connection
1254# 2 = like 1, but maintain OUI (with local admin bit set)
1255#mac_addr=0
1256
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001257# disable_ht: Whether HT (802.11n) should be disabled.
1258# 0 = HT enabled (if AP supports it)
1259# 1 = HT disabled
1260#
1261# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1262# 0 = HT-40 enabled (if AP supports it)
1263# 1 = HT-40 disabled
1264#
1265# disable_sgi: Whether SGI (short guard interval) should be disabled.
1266# 0 = SGI enabled (if AP supports it)
1267# 1 = SGI disabled
1268#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001269# disable_ldpc: Whether LDPC should be disabled.
1270# 0 = LDPC enabled (if AP supports it)
1271# 1 = LDPC disabled
1272#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001273# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1274# 0 = 40 MHz tolerant (default)
1275# 1 = 40 MHz intolerant
1276#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001277# ht_mcs: Configure allowed MCS rates.
1278# Parsed as an array of bytes, in base-16 (ascii-hex)
1279# ht_mcs="" // Use all available (default)
1280# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1281# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1282#
1283# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1284# -1 = Do not make any changes.
1285# 0 = Enable MAX-AMSDU if hardware supports it.
1286# 1 = Disable AMSDU
1287#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001288# ampdu_factor: Maximum A-MPDU Length Exponent
1289# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1290#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001291# ampdu_density: Allow overriding AMPDU density configuration.
1292# Treated as hint by the kernel.
1293# -1 = Do not make any changes.
1294# 0-3 = Set AMPDU density (aka factor) to specified value.
1295
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001296# disable_vht: Whether VHT should be disabled.
1297# 0 = VHT enabled (if AP supports it)
1298# 1 = VHT disabled
1299#
1300# vht_capa: VHT capabilities to set in the override
1301# vht_capa_mask: mask of VHT capabilities
1302#
1303# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1304# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1305# 0: MCS 0-7
1306# 1: MCS 0-8
1307# 2: MCS 0-9
1308# 3: not supported
1309
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001310##### Fast Session Transfer (FST) support #####################################
1311#
1312# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001313# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1314# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001315#
1316# FST is the transfer of a session from a channel to another channel, in the
1317# same or different frequency bands.
1318#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001319# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001320
1321# Identifier of an FST Group the interface belongs to.
1322#fst_group_id=bond0
1323
1324# Interface priority within the FST Group.
1325# Announcing a higher priority for an interface means declaring it more
1326# preferable for FST switch.
1327# fst_priority is in 1..255 range with 1 being the lowest priority.
1328#fst_priority=100
1329
1330# Default LLT value for this interface in milliseconds. The value used in case
1331# no value provided during session setup. Default is 50 msec.
1332# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1333# Transitioning between states).
1334#fst_llt=100
1335
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001336# Example blocks:
1337
1338# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1339network={
1340 ssid="simple"
1341 psk="very secret passphrase"
1342 priority=5
1343}
1344
1345# Same as previous, but request SSID-specific scanning (for APs that reject
1346# broadcast SSID)
1347network={
1348 ssid="second ssid"
1349 scan_ssid=1
1350 psk="very secret passphrase"
1351 priority=2
1352}
1353
1354# Only WPA-PSK is used. Any valid cipher combination is accepted.
1355network={
1356 ssid="example"
1357 proto=WPA
1358 key_mgmt=WPA-PSK
1359 pairwise=CCMP TKIP
1360 group=CCMP TKIP WEP104 WEP40
1361 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1362 priority=2
1363}
1364
1365# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1366network={
1367 ssid="example"
1368 proto=WPA
1369 key_mgmt=WPA-PSK
1370 pairwise=TKIP
1371 group=TKIP
1372 psk="not so secure passphrase"
1373 wpa_ptk_rekey=600
1374}
1375
1376# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1377# or WEP40 as the group cipher will not be accepted.
1378network={
1379 ssid="example"
1380 proto=RSN
1381 key_mgmt=WPA-EAP
1382 pairwise=CCMP TKIP
1383 group=CCMP TKIP
1384 eap=TLS
1385 identity="user@example.com"
1386 ca_cert="/etc/cert/ca.pem"
1387 client_cert="/etc/cert/user.pem"
1388 private_key="/etc/cert/user.prv"
1389 private_key_passwd="password"
1390 priority=1
1391}
1392
1393# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1394# (e.g., Radiator)
1395network={
1396 ssid="example"
1397 key_mgmt=WPA-EAP
1398 eap=PEAP
1399 identity="user@example.com"
1400 password="foobar"
1401 ca_cert="/etc/cert/ca.pem"
1402 phase1="peaplabel=1"
1403 phase2="auth=MSCHAPV2"
1404 priority=10
1405}
1406
1407# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1408# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1409network={
1410 ssid="example"
1411 key_mgmt=WPA-EAP
1412 eap=TTLS
1413 identity="user@example.com"
1414 anonymous_identity="anonymous@example.com"
1415 password="foobar"
1416 ca_cert="/etc/cert/ca.pem"
1417 priority=2
1418}
1419
1420# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1421# use. Real identity is sent only within an encrypted TLS tunnel.
1422network={
1423 ssid="example"
1424 key_mgmt=WPA-EAP
1425 eap=TTLS
1426 identity="user@example.com"
1427 anonymous_identity="anonymous@example.com"
1428 password="foobar"
1429 ca_cert="/etc/cert/ca.pem"
1430 phase2="auth=MSCHAPV2"
1431}
1432
1433# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1434# authentication.
1435network={
1436 ssid="example"
1437 key_mgmt=WPA-EAP
1438 eap=TTLS
1439 # Phase1 / outer authentication
1440 anonymous_identity="anonymous@example.com"
1441 ca_cert="/etc/cert/ca.pem"
1442 # Phase 2 / inner authentication
1443 phase2="autheap=TLS"
1444 ca_cert2="/etc/cert/ca2.pem"
1445 client_cert2="/etc/cer/user.pem"
1446 private_key2="/etc/cer/user.prv"
1447 private_key2_passwd="password"
1448 priority=2
1449}
1450
1451# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1452# group cipher.
1453network={
1454 ssid="example"
1455 bssid=00:11:22:33:44:55
1456 proto=WPA RSN
1457 key_mgmt=WPA-PSK WPA-EAP
1458 pairwise=CCMP
1459 group=CCMP
1460 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1461}
1462
1463# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1464# and all valid ciphers.
1465network={
1466 ssid=00010203
1467 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1468}
1469
1470
1471# EAP-SIM with a GSM SIM or USIM
1472network={
1473 ssid="eap-sim-test"
1474 key_mgmt=WPA-EAP
1475 eap=SIM
1476 pin="1234"
1477 pcsc=""
1478}
1479
1480
1481# EAP-PSK
1482network={
1483 ssid="eap-psk-test"
1484 key_mgmt=WPA-EAP
1485 eap=PSK
1486 anonymous_identity="eap_psk_user"
1487 password=06b4be19da289f475aa46a33cb793029
1488 identity="eap_psk_user@example.com"
1489}
1490
1491
1492# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1493# EAP-TLS for authentication and key generation; require both unicast and
1494# broadcast WEP keys.
1495network={
1496 ssid="1x-test"
1497 key_mgmt=IEEE8021X
1498 eap=TLS
1499 identity="user@example.com"
1500 ca_cert="/etc/cert/ca.pem"
1501 client_cert="/etc/cert/user.pem"
1502 private_key="/etc/cert/user.prv"
1503 private_key_passwd="password"
1504 eapol_flags=3
1505}
1506
1507
1508# LEAP with dynamic WEP keys
1509network={
1510 ssid="leap-example"
1511 key_mgmt=IEEE8021X
1512 eap=LEAP
1513 identity="user"
1514 password="foobar"
1515}
1516
1517# EAP-IKEv2 using shared secrets for both server and peer authentication
1518network={
1519 ssid="ikev2-example"
1520 key_mgmt=WPA-EAP
1521 eap=IKEV2
1522 identity="user"
1523 password="foobar"
1524}
1525
1526# EAP-FAST with WPA (WPA or WPA2)
1527network={
1528 ssid="eap-fast-test"
1529 key_mgmt=WPA-EAP
1530 eap=FAST
1531 anonymous_identity="FAST-000102030405"
1532 identity="username"
1533 password="password"
1534 phase1="fast_provisioning=1"
1535 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1536}
1537
1538network={
1539 ssid="eap-fast-test"
1540 key_mgmt=WPA-EAP
1541 eap=FAST
1542 anonymous_identity="FAST-000102030405"
1543 identity="username"
1544 password="password"
1545 phase1="fast_provisioning=1"
1546 pac_file="blob://eap-fast-pac"
1547}
1548
1549# Plaintext connection (no WPA, no IEEE 802.1X)
1550network={
1551 ssid="plaintext-test"
1552 key_mgmt=NONE
1553}
1554
1555
1556# Shared WEP key connection (no WPA, no IEEE 802.1X)
1557network={
1558 ssid="static-wep-test"
1559 key_mgmt=NONE
1560 wep_key0="abcde"
1561 wep_key1=0102030405
1562 wep_key2="1234567890123"
1563 wep_tx_keyidx=0
1564 priority=5
1565}
1566
1567
1568# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1569# IEEE 802.11 authentication
1570network={
1571 ssid="static-wep-test2"
1572 key_mgmt=NONE
1573 wep_key0="abcde"
1574 wep_key1=0102030405
1575 wep_key2="1234567890123"
1576 wep_tx_keyidx=0
1577 priority=5
1578 auth_alg=SHARED
1579}
1580
1581
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001582# IBSS/ad-hoc network with RSN
1583network={
1584 ssid="ibss-rsn"
1585 key_mgmt=WPA-PSK
1586 proto=RSN
1587 psk="12345678"
1588 mode=1
1589 frequency=2412
1590 pairwise=CCMP
1591 group=CCMP
1592}
1593
1594# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001595network={
1596 ssid="test adhoc"
1597 mode=1
1598 frequency=2412
1599 proto=WPA
1600 key_mgmt=WPA-NONE
1601 pairwise=NONE
1602 group=TKIP
1603 psk="secret passphrase"
1604}
1605
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001606# open mesh network
1607network={
1608 ssid="test mesh"
1609 mode=5
1610 frequency=2437
1611 key_mgmt=NONE
1612}
1613
1614# secure (SAE + AMPE) network
1615network={
1616 ssid="secure mesh"
1617 mode=5
1618 frequency=2437
1619 key_mgmt=SAE
1620 psk="very secret passphrase"
1621}
1622
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001623
1624# Catch all example that allows more or less all configuration modes
1625network={
1626 ssid="example"
1627 scan_ssid=1
1628 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1629 pairwise=CCMP TKIP
1630 group=CCMP TKIP WEP104 WEP40
1631 psk="very secret passphrase"
1632 eap=TTLS PEAP TLS
1633 identity="user@example.com"
1634 password="foobar"
1635 ca_cert="/etc/cert/ca.pem"
1636 client_cert="/etc/cert/user.pem"
1637 private_key="/etc/cert/user.prv"
1638 private_key_passwd="password"
1639 phase1="peaplabel=0"
1640}
1641
1642# Example of EAP-TLS with smartcard (openssl engine)
1643network={
1644 ssid="example"
1645 key_mgmt=WPA-EAP
1646 eap=TLS
1647 proto=RSN
1648 pairwise=CCMP TKIP
1649 group=CCMP TKIP
1650 identity="user@example.com"
1651 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001652
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001653 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1654 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1655 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001656
1657 # Optional PIN configuration; this can be left out and PIN will be
1658 # asked through the control interface
1659 pin="1234"
1660}
1661
1662# Example configuration showing how to use an inlined blob as a CA certificate
1663# data instead of using external file
1664network={
1665 ssid="example"
1666 key_mgmt=WPA-EAP
1667 eap=TTLS
1668 identity="user@example.com"
1669 anonymous_identity="anonymous@example.com"
1670 password="foobar"
1671 ca_cert="blob://exampleblob"
1672 priority=20
1673}
1674
1675blob-base64-exampleblob={
1676SGVsbG8gV29ybGQhCg==
1677}
1678
1679
1680# Wildcard match for SSID (plaintext APs only). This example select any
1681# open AP regardless of its SSID.
1682network={
1683 key_mgmt=NONE
1684}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001685
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001686# Example configuration blacklisting two APs - these will be ignored
1687# for this network.
1688network={
1689 ssid="example"
1690 psk="very secret passphrase"
1691 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1692}
1693
1694# Example configuration limiting AP selection to a specific set of APs;
1695# any other AP not matching the masked address will be ignored.
1696network={
1697 ssid="example"
1698 psk="very secret passphrase"
1699 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
1700}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001701
1702# Example config file that will only scan on channel 36.
1703freq_list=5180
1704network={
1705 key_mgmt=NONE
1706}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001707
1708
1709# Example MACsec configuration
1710#network={
1711# key_mgmt=IEEE8021X
1712# eap=TTLS
1713# phase2="auth=PAP"
1714# anonymous_identity="anonymous@example.com"
1715# identity="user@example.com"
1716# password="secretr"
1717# ca_cert="/etc/cert/ca.pem"
1718# eapol_flags=0
1719# macsec_policy=1
1720#}