blob: 94cef4afbf5c5e8c96d8b9bb11d91afcb305edf9 [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 Shmidtc5ec7f52012-03-06 16:33:24 -0800425# Interworking (IEEE 802.11u)
426
427# Enable Interworking
428# interworking=1
429
430# Homogenous ESS identifier
431# If this is set, scans will be used to request response only from BSSes
432# belonging to the specified Homogeneous ESS. This is used only if interworking
433# is enabled.
434# hessid=00:11:22:33:44:55
435
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700436# Automatic network selection behavior
437# 0 = do not automatically go through Interworking network selection
438# (i.e., require explicit interworking_select command for this; default)
439# 1 = perform Interworking network selection if one or more
440# credentials have been configured and scan did not find a
441# matching network block
442#auto_interworking=0
443
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700444# GAS Address3 field behavior
445# 0 = P2P specification (Address3 = AP BSSID); default
446# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
447# sent to not-associated AP; if associated, AP BSSID)
448#gas_address3=0
449
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700450# Publish fine timing measurement (FTM) responder functionality in
451# the Extended Capabilities element bit 70.
452# Controls whether FTM responder functionality will be published by AP/STA.
453# Note that actual FTM responder operation is managed outside wpa_supplicant.
454# 0 = Do not publish; default
455# 1 = Publish
456#ftm_responder=0
457
458# Publish fine timing measurement (FTM) initiator functionality in
459# the Extended Capabilities element bit 71.
460# Controls whether FTM initiator functionality will be published by AP/STA.
461# Note that actual FTM initiator operation is managed outside wpa_supplicant.
462# 0 = Do not publish; default
463# 1 = Publish
464#ftm_initiator=0
465
Dmitry Shmidt04949592012-07-19 12:16:46 -0700466# credential block
467#
468# Each credential used for automatic network selection is configured as a set
469# of parameters that are compared to the information advertised by the APs when
470# interworking_select and interworking_connect commands are used.
471#
472# credential fields:
473#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800474# temporary: Whether this credential is temporary and not to be saved
475#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700476# priority: Priority group
477# By default, all networks and credentials get the same priority group
478# (0). This field can be used to give higher priority for credentials
479# (and similarly in struct wpa_ssid for network blocks) to change the
480# Interworking automatic networking selection behavior. The matching
481# network (based on either an enabled network block or a credential)
482# with the highest priority value will be selected.
483#
484# pcsc: Use PC/SC and SIM/USIM card
485#
486# realm: Home Realm for Interworking
487#
488# username: Username for Interworking network selection
489#
490# password: Password for Interworking network selection
491#
492# ca_cert: CA certificate for Interworking network selection
493#
494# client_cert: File path to client certificate file (PEM/DER)
495# This field is used with Interworking networking selection for a case
496# where client certificate/private key is used for authentication
497# (EAP-TLS). Full path to the file should be used since working
498# directory may change when wpa_supplicant is run in the background.
499#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700500# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
501#
502# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
503#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700504# Alternatively, a named configuration blob can be used by setting
505# this to blob://blob_name.
506#
507# private_key: File path to client private key file (PEM/DER/PFX)
508# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
509# commented out. Both the private key and certificate will be read
510# from the PKCS#12 file in this case. Full path to the file should be
511# used since working directory may change when wpa_supplicant is run
512# in the background.
513#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700514# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
515# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
516#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700517# Windows certificate store can be used by leaving client_cert out and
518# configuring private_key in one of the following formats:
519#
520# cert://substring_to_match
521#
522# hash://certificate_thumbprint_in_hex
523#
524# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
525#
526# Note that when running wpa_supplicant as an application, the user
527# certificate store (My user account) is used, whereas computer store
528# (Computer account) is used when running wpasvc as a service.
529#
530# Alternatively, a named configuration blob can be used by setting
531# this to blob://blob_name.
532#
533# private_key_passwd: Password for private key file
534#
535# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
536#
537# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
538# format
539#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700540# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700541# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700542# whether the AP is operated by the Home SP. Multiple domain entries can
543# be used to configure alternative FQDNs that will be considered home
544# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700545#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700546# roaming_consortium: Roaming Consortium OI
547# If roaming_consortium_len is non-zero, this field contains the
548# Roaming Consortium OI that can be used to determine which access
549# points support authentication with this credential. This is an
550# alternative to the use of the realm parameter. When using Roaming
551# Consortium to match the network, the EAP parameters need to be
552# pre-configured with the credential since the NAI Realm information
553# may not be available or fetched.
554#
555# eap: Pre-configured EAP method
556# This optional field can be used to specify which EAP method will be
557# used with this credential. If not set, the EAP method is selected
558# automatically based on ANQP information (e.g., NAI Realm).
559#
560# phase1: Pre-configure Phase 1 (outer authentication) parameters
561# This optional field is used with like the 'eap' parameter.
562#
563# phase2: Pre-configure Phase 2 (inner authentication) parameters
564# This optional field is used with like the 'eap' parameter.
565#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800566# excluded_ssid: Excluded SSID
567# This optional field can be used to excluded specific SSID(s) from
568# matching with the network. Multiple entries can be used to specify more
569# than one SSID.
570#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800571# roaming_partner: Roaming partner information
572# This optional field can be used to configure preferences between roaming
573# partners. The field is a string in following format:
574# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
575# (non-exact match means any subdomain matches the entry; priority is in
576# 0..255 range with 0 being the highest priority)
577#
578# update_identifier: PPS MO ID
579# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
580#
581# provisioning_sp: FQDN of the SP that provisioned the credential
582# This optional field can be used to keep track of the SP that provisioned
583# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
584#
585# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
586# These fields can be used to specify minimum download/upload backhaul
587# bandwidth that is preferred for the credential. This constraint is
588# ignored if the AP does not advertise WAN Metrics information or if the
589# limit would prevent any connection. Values are in kilobits per second.
590# min_dl_bandwidth_home
591# min_ul_bandwidth_home
592# min_dl_bandwidth_roaming
593# min_ul_bandwidth_roaming
594#
595# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
596# (PPS/<X+>/Policy/MaximumBSSLoadValue)
597# This value is used as the maximum channel utilization for network
598# selection purposes for home networks. If the AP does not advertise
599# BSS Load or if the limit would prevent any connection, this constraint
600# will be ignored.
601#
602# req_conn_capab: Required connection capability
603# (PPS/<X+>/Policy/RequiredProtoPortTuple)
604# This value is used to configure set of required protocol/port pairs that
605# a roaming network shall support (include explicitly in Connection
606# Capability ANQP element). This constraint is ignored if the AP does not
607# advertise Connection Capability or if this constraint would prevent any
608# network connection. This policy is not used in home networks.
609# Format: <protocol>[:<comma-separated list of ports]
610# Multiple entries can be used to list multiple requirements.
611# For example, number of common TCP protocols:
612# req_conn_capab=6,22,80,443
613# For example, IPSec/IKE:
614# req_conn_capab=17:500
615# req_conn_capab=50
616#
617# ocsp: Whether to use/require OCSP to check server certificate
618# 0 = do not use OCSP stapling (TLS certificate status extension)
619# 1 = try to use OCSP stapling, but not require response
620# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800621# 3 = require valid OCSP stapling response for all not-trusted
622# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800623#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700624# sim_num: Identifier for which SIM to use in multi-SIM devices
625#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700626# for example:
627#
628#cred={
629# realm="example.com"
630# username="user@example.com"
631# password="password"
632# ca_cert="/etc/wpa_supplicant/ca.pem"
633# domain="example.com"
634#}
635#
636#cred={
637# imsi="310026-000000000"
638# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
639#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700640#
641#cred={
642# realm="example.com"
643# username="user"
644# password="password"
645# ca_cert="/etc/wpa_supplicant/ca.pem"
646# domain="example.com"
647# roaming_consortium=223344
648# eap=TTLS
649# phase2="auth=MSCHAPV2"
650#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800651
Dmitry Shmidt04949592012-07-19 12:16:46 -0700652# Hotspot 2.0
653# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800654
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800655# Scheduled scan plans
656#
657# A space delimited list of scan plans. Each scan plan specifies the scan
658# interval and number of iterations, delimited by a colon. The last scan plan
659# will run infinitely and thus must specify only the interval and not the number
660# of iterations.
661#
662# The driver advertises the maximum number of scan plans supported. If more scan
663# plans than supported are configured, only the first ones are set (up to the
664# maximum supported). The last scan plan that specifies only the interval is
665# always set as the last plan.
666#
667# If the scan interval or the number of iterations for a scan plan exceeds the
668# maximum supported, it will be set to the maximum supported value.
669#
670# Format:
671# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
672#
673# Example:
674# sched_scan_plans=10:100 20:200 30
675
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800676# Multi Band Operation (MBO) non-preferred channels
677# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700678# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800679# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700680# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800681# Example:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700682# non_pref_chan="81:5:10:2 81:1:0:2 81:9:0:2"
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800683
684# MBO Cellular Data Capabilities
685# 1 = Cellular data connection available
686# 2 = Cellular data connection not available
687# 3 = Not cellular capable (default)
688#mbo_cell_capa=3
689
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800690# network block
691#
692# Each network (usually AP's sharing the same SSID) is configured as a separate
693# block in this configuration file. The network blocks are in preference order
694# (the first match is used).
695#
696# network block fields:
697#
698# disabled:
699# 0 = this network can be used (default)
700# 1 = this network block is disabled (can be enabled through ctrl_iface,
701# e.g., with wpa_cli or wpa_gui)
702#
703# id_str: Network identifier string for external scripts. This value is passed
704# to external action script through wpa_cli as WPA_ID_STR environment
705# variable to make it easier to do network specific configuration.
706#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700707# ssid: SSID (mandatory); network name in one of the optional formats:
708# - an ASCII string with double quotation
709# - a hex string (two characters per octet of SSID)
710# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800711#
712# scan_ssid:
713# 0 = do not scan this SSID with specific Probe Request frames (default)
714# 1 = scan with SSID-specific Probe Request frames (this can be used to
715# find APs that do not accept broadcast SSID or use multiple SSIDs;
716# this will add latency to scanning, so enable this only when needed)
717#
718# bssid: BSSID (optional); if set, this network block is used only when
719# associating with the AP using the configured BSSID
720#
721# priority: priority group (integer)
722# By default, all networks will get same priority group (0). If some of the
723# networks are more desirable, this field can be used to change the order in
724# which wpa_supplicant goes through the networks when selecting a BSS. The
725# priority groups will be iterated in decreasing priority (i.e., the larger the
726# priority value, the sooner the network is matched against the scan results).
727# Within each priority group, networks will be selected based on security
728# policy, signal strength, etc.
729# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
730# using this priority to select the order for scanning. Instead, they try the
731# networks in the order that used in the configuration file.
732#
733# mode: IEEE 802.11 operation mode
734# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
735# 1 = IBSS (ad-hoc, peer-to-peer)
736# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800737# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
738# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
739# TKIP/CCMP) is available for backwards compatibility, but its use is
740# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800741# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
742# both), and psk must also be set.
743#
744# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
745# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
746# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
747# In addition, this value is only used by the station that creates the IBSS. If
748# an IBSS network with the configured SSID is already present, the frequency of
749# the network will be used instead of this configured value.
750#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800751# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700752# 0 = do not use PBSS
753# 1 = use PBSS
754# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800755# Used together with mode configuration. When mode is AP, it means to start a
756# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700757# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
758# which means connect to either PCP or AP.
759# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800760# For more details, see IEEE Std 802.11ad-2012.
761#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800762# scan_freq: List of frequencies to scan
763# Space-separated list of frequencies in MHz to scan when searching for this
764# BSS. If the subset of channels used by the network is known, this option can
765# be used to optimize scanning to not occur on channels that the network does
766# not use. Example: scan_freq=2412 2437 2462
767#
768# freq_list: Array of allowed frequencies
769# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
770# set, scan results that do not match any of the specified frequencies are not
771# considered when selecting a BSS.
772#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700773# This can also be set on the outside of the network block. In this case,
774# it limits the frequencies that will be scanned.
775#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800776# bgscan: Background scanning
777# wpa_supplicant behavior for background scanning can be specified by
778# configuring a bgscan module. These modules are responsible for requesting
779# background scans for the purpose of roaming within an ESS (i.e., within a
780# single network block with all the APs using the same SSID). The bgscan
781# parameter uses following format: "<bgscan module name>:<module parameters>"
782# Following bgscan modules are available:
783# simple - Periodic background scans based on signal strength
784# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
785# <long interval>"
786# bgscan="simple:30:-45:300"
787# learn - Learn channels used by the network and try to avoid bgscans on other
788# channels (experimental)
789# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
790# <long interval>[:<database file name>]"
791# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800792# Explicitly disable bgscan by setting
793# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800794#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800795# This option can also be set outside of all network blocks for the bgscan
796# parameter to apply for all the networks that have no specific bgscan
797# parameter.
798#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800799# proto: list of accepted protocols
800# WPA = WPA/IEEE 802.11i/D3.0
801# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
802# If not set, this defaults to: WPA RSN
803#
804# key_mgmt: list of accepted authenticated key management protocols
805# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
806# WPA-EAP = WPA using EAP authentication
807# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
808# generated WEP keys
809# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800810# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
811# instead)
812# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
813# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800814# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
815# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800816# SAE = Simultaneous authentication of equals; pre-shared key/password -based
817# authentication with stronger security than WPA-PSK especially when using
818# not that strong password
819# FT-SAE = SAE with FT
820# WPA-EAP-SUITE-B = Suite B 128-bit level
821# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800822# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800823# FILS-SHA256 = Fast Initial Link Setup with SHA256
824# FILS-SHA384 = Fast Initial Link Setup with SHA384
825# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
826# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800827# If not set, this defaults to: WPA-PSK WPA-EAP
828#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700829# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800830# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700831# 1 = optional
832# 2 = required
833# The most common configuration options for this based on the PMF (protected
834# management frames) certification program are:
835# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
836# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
837# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
838#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800839# auth_alg: list of allowed IEEE 802.11 authentication algorithms
840# OPEN = Open System authentication (required for WPA/WPA2)
841# SHARED = Shared Key authentication (requires static WEP keys)
842# LEAP = LEAP/Network EAP (only used with LEAP)
843# If not set, automatic selection is used (Open System with LEAP enabled if
844# LEAP is allowed as one of the EAP methods).
845#
846# pairwise: list of accepted pairwise (unicast) ciphers for WPA
847# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
848# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
849# NONE = Use only Group Keys (deprecated, should not be included if APs support
850# pairwise keys)
851# If not set, this defaults to: CCMP TKIP
852#
853# group: list of accepted group (broadcast/multicast) ciphers for WPA
854# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
855# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
856# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
857# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
858# If not set, this defaults to: CCMP TKIP WEP104 WEP40
859#
860# psk: WPA preshared key; 256-bit pre-shared key
861# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
862# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
863# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700864# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
865# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800866# This field is not needed, if WPA-EAP is used.
867# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
868# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
869# startup and reconfiguration time can be optimized by generating the PSK only
870# only when the passphrase or SSID has actually changed.
871#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -0700872# mem_only_psk: Whether to keep PSK/passphrase only in memory
873# 0 = allow psk/passphrase to be stored to the configuration file
874# 1 = do not store psk/passphrase to the configuration file
875#mem_only_psk=0
876#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800877# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
878# Dynamic WEP key required for non-WPA mode
879# bit0 (1): require dynamically generated unicast WEP key
880# bit1 (2): require dynamically generated broadcast WEP key
881# (3 = require both keys; default)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800882# Note: When using wired authentication (including MACsec drivers),
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700883# eapol_flags must be set to 0 for the authentication to be completed
884# successfully.
885#
886# macsec_policy: IEEE 802.1X/MACsec options
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800887# This determines how sessions are secured with MACsec (only for MACsec
888# drivers).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700889# 0: MACsec not in use (default)
890# 1: MACsec enabled - Should secure, accept key server's advice to
891# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800892#
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800893# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
894# This setting applies only when MACsec is in use, i.e.,
895# - macsec_policy is enabled
896# - the key server has decided to enable MACsec
897# 0: Encrypt traffic (default)
898# 1: Integrity only
899#
900# macsec_port: IEEE 802.1X/MACsec port
901# Port component of the SCI
902# Range: 1-65534 (default: 1)
903#
Dmitry Shmidt29333592017-01-09 12:27:11 -0800904# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800905# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
Dmitry Shmidt29333592017-01-09 12:27:11 -0800906# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
907# with lower priority will become the key server and start distributing SAKs.
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800908# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-bytes (128 bit)
909# hex-string (32 hex-digits)
910# mka_ckn (CKN = CAK Name) takes a 32-bytes (256 bit) hex-string (64 hex-digits)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800911# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
912# default priority
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800913#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800914# mixed_cell: This option can be used to configure whether so called mixed
915# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800916# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800917# 0 = disabled (default)
918# 1 = enabled
919#
920# proactive_key_caching:
921# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800922# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800923# 1 = enabled
924#
925# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
926# hex without quotation, e.g., 0102030405)
927# wep_tx_keyidx: Default WEP key index (TX) (0..3)
928#
929# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
930# allowed. This is only used with RSN/WPA2.
931# 0 = disabled (default)
932# 1 = enabled
933#peerkey=1
934#
935# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
936# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
937#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -0700938# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
939# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
940# Authenticator role in IBSS.
941#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800942# Following fields are only used with internal EAP implementation.
943# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700944# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800945# cannot be used with WPA; to be used as a Phase 2 method
946# with EAP-PEAP or EAP-TTLS)
947# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
948# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
949# OTP = EAP-OTP (cannot be used separately with WPA; to be used
950# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
951# GTC = EAP-GTC (cannot be used separately with WPA; to be used
952# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
953# TLS = EAP-TLS (client and server certificate)
954# PEAP = EAP-PEAP (with tunnelled EAP authentication)
955# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
956# authentication)
957# If not set, all compiled in methods are allowed.
958#
959# identity: Identity string for EAP
960# This field is also used to configure user NAI for
961# EAP-PSK/PAX/SAKE/GPSK.
962# anonymous_identity: Anonymous identity string for EAP (to be used as the
963# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700964# identity, e.g., EAP-TTLS). This field can also be used with
965# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800966# password: Password string for EAP. This field can include either the
967# plaintext password (using ASCII or hex string) or a NtPasswordHash
968# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
969# NtPasswordHash can only be used when the password is for MSCHAPv2 or
970# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
971# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
972# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700973# variable length PSK. ext:<name of external password field> format can
974# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800975# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
976# or more trusted CA certificates. If ca_cert and ca_path are not
977# included, server certificate will not be verified. This is insecure and
978# a trusted CA certificate should always be configured when using
979# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
980# change when wpa_supplicant is run in the background.
981#
982# Alternatively, this can be used to only perform matching of the server
983# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
984# this case, the possible CA certificates in the server certificate chain
985# are ignored and only the server certificate is verified. This is
986# configured with the following format:
987# hash:://server/sha256/cert_hash_in_hex
988# For example: "hash://server/sha256/
989# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
990#
991# On Windows, trusted CA certificates can be loaded from the system
992# certificate store by setting this to cert_store://<name>, e.g.,
993# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
994# Note that when running wpa_supplicant as an application, the user
995# certificate store (My user account) is used, whereas computer store
996# (Computer account) is used when running wpasvc as a service.
997# ca_path: Directory path for CA certificate files (PEM). This path may
998# contain multiple CA certificates in OpenSSL format. Common use for this
999# is to point to system trusted CA list which is often installed into
1000# directory like /etc/ssl/certs. If configured, these certificates are
1001# added to the list of trusted CAs. ca_cert may also be included in that
1002# case, but it is not required.
1003# client_cert: File path to client certificate file (PEM/DER)
1004# Full path should be used since working directory may change when
1005# wpa_supplicant is run in the background.
1006# Alternatively, a named configuration blob can be used by setting this
1007# to blob://<blob name>.
1008# private_key: File path to client private key file (PEM/DER/PFX)
1009# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1010# commented out. Both the private key and certificate will be read from
1011# the PKCS#12 file in this case. Full path should be used since working
1012# directory may change when wpa_supplicant is run in the background.
1013# Windows certificate store can be used by leaving client_cert out and
1014# configuring private_key in one of the following formats:
1015# cert://substring_to_match
1016# hash://certificate_thumbprint_in_hex
1017# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1018# Note that when running wpa_supplicant as an application, the user
1019# certificate store (My user account) is used, whereas computer store
1020# (Computer account) is used when running wpasvc as a service.
1021# Alternatively, a named configuration blob can be used by setting this
1022# to blob://<blob name>.
1023# private_key_passwd: Password for private key file (if left out, this will be
1024# asked through control interface)
1025# dh_file: File path to DH/DSA parameters file (in PEM format)
1026# This is an optional configuration file for setting parameters for an
1027# ephemeral DH key exchange. In most cases, the default RSA
1028# authentication does not use this configuration. However, it is possible
1029# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1030# DSA keys always use ephemeral DH keys. This can be used to achieve
1031# forward secrecy. If the file is in DSA parameters format, it will be
1032# automatically converted into DH params.
1033# subject_match: Substring to be matched against the subject of the
1034# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001035# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001036# The subject string is in following format:
1037# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001038# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001039# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001040# such a use case, domain_suffix_match or domain_match should be used
1041# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001042# altsubject_match: Semicolon separated string of entries to be matched against
1043# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001044# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001045# contains one of the entries in an alternative subject name extension.
1046# altSubjectName string is in following format: TYPE:VALUE
1047# Example: EMAIL:server@example.com
1048# Example: DNS:server.example.com;DNS:server2.example.com
1049# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001050# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001051# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001052# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1053# constraint is met. If no dNSName values are present, this constraint is
1054# matched against SubjectName CN using same suffix match comparison.
1055#
1056# Suffix match here means that the host/domain name is compared one label
1057# at a time starting from the top-level domain and all the labels in
1058# domain_suffix_match shall be included in the certificate. The
1059# certificate may include additional sub-level labels in addition to the
1060# required labels.
1061#
1062# For example, domain_suffix_match=example.com would match
1063# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001064# domain_match: Constraint for server domain name
1065# If set, this FQDN is used as a full match requirement for the
1066# server certificate in SubjectAltName dNSName element(s). If a
1067# matching dNSName is found, this constraint is met. If no dNSName
1068# values are present, this constraint is matched against SubjectName CN
1069# using same full match comparison. This behavior is similar to
1070# domain_suffix_match, but has the requirement of a full match, i.e.,
1071# no subdomains or wildcard matches are allowed. Case-insensitive
1072# comparison is used, so "Example.com" matches "example.com", but would
1073# not match "test.Example.com".
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001074# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1075# (string with field-value pairs, e.g., "peapver=0" or
1076# "peapver=1 peaplabel=1")
1077# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1078# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1079# to be used during key derivation when PEAPv1 or newer. Most existing
1080# PEAPv1 implementation seem to be using the old label, "client EAP
1081# encryption", and wpa_supplicant is now using that as the default value.
1082# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1083# interoperate with PEAPv1; see eap_testing.txt for more details.
1084# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1085# tunneled EAP-Success. This is required with some RADIUS servers that
1086# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1087# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1088# include_tls_length=1 can be used to force wpa_supplicant to include
1089# TLS Message Length field in all TLS messages even if they are not
1090# fragmented.
1091# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1092# challenges (by default, it accepts 2 or 3)
1093# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1094# protected result indication.
1095# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1096# behavior:
1097# * 0 = do not use cryptobinding (default)
1098# * 1 = use cryptobinding if server supports it
1099# * 2 = require cryptobinding
1100# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1101# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001102#
1103# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1104# used to configure a mode that allows EAP-Success (and EAP-Failure)
1105# without going through authentication step. Some switches use such
1106# sequence when forcing the port to be authorized/unauthorized or as a
1107# fallback option if the authentication server is unreachable. By default,
1108# wpa_supplicant discards such frames to protect against potential attacks
1109# by rogue devices, but this option can be used to disable that protection
1110# for cases where the server/authenticator does not need to be
1111# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001112# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1113# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001114# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1115# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001116#
1117# TLS-based methods can use the following parameters to control TLS behavior
1118# (these are normally in the phase1 parameter, but can be used also in the
1119# phase2 parameter when EAP-TLS is used within the inner tunnel):
1120# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1121# TLS library, these may be disabled by default to enforce stronger
1122# security)
1123# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1124# the TLS library to accept certificates even if they are not currently
1125# valid, i.e., have expired or have not yet become valid; this should be
1126# used only for testing purposes)
1127# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1128# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1129# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1130# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001131# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001132# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1133# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001134# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001135# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1136# that have issues interoperating with updated TLS version)
1137# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1138# that have issues interoperating with updated TLS version)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001139# tls_ext_cert_check=0 - No external server certificate validation (default)
1140# tls_ext_cert_check=1 - External server certificate validation enabled; this
1141# requires an external program doing validation of server certificate
1142# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1143# interface and report the result of the validation with
1144# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001145#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001146# Following certificate/private key fields are used in inner Phase2
1147# authentication when using EAP-TTLS or EAP-PEAP.
1148# ca_cert2: File path to CA certificate file. This file can have one or more
1149# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1150# server certificate will not be verified. This is insecure and a trusted
1151# CA certificate should always be configured.
1152# ca_path2: Directory path for CA certificate files (PEM)
1153# client_cert2: File path to client certificate file
1154# private_key2: File path to client private key file
1155# private_key2_passwd: Password for private key file
1156# dh_file2: File path to DH/DSA parameters file (in PEM format)
1157# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001158# authentication server certificate. See subject_match for more details.
1159# altsubject_match2: Semicolon separated string of entries to be matched
1160# against the alternative subject name of the authentication server
1161# certificate. See altsubject_match documentation for more details.
1162# domain_suffix_match2: Constraint for server domain name. See
1163# domain_suffix_match for more details.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001164#
1165# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1166# This value limits the fragment size for EAP methods that support
1167# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1168# small enough to make the EAP messages fit in MTU of the network
1169# interface used for EAPOL. The default value is suitable for most
1170# cases.
1171#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001172# ocsp: Whether to use/require OCSP to check server certificate
1173# 0 = do not use OCSP stapling (TLS certificate status extension)
1174# 1 = try to use OCSP stapling, but not require response
1175# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001176# 3 = require valid OCSP stapling response for all not-trusted
1177# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001178#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001179# openssl_ciphers: OpenSSL specific cipher configuration
1180# This can be used to override the global openssl_ciphers configuration
1181# parameter (see above).
1182#
1183# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1184#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001185# EAP-FAST variables:
1186# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1187# to create this file and write updates to it when PAC is being
1188# provisioned or refreshed. Full path to the file should be used since
1189# working directory may change when wpa_supplicant is run in the
1190# background. Alternatively, a named configuration blob can be used by
1191# setting this to blob://<blob name>
1192# phase1: fast_provisioning option can be used to enable in-line provisioning
1193# of EAP-FAST credentials (PAC):
1194# 0 = disabled,
1195# 1 = allow unauthenticated provisioning,
1196# 2 = allow authenticated provisioning,
1197# 3 = allow both unauthenticated and authenticated provisioning
1198# fast_max_pac_list_len=<num> option can be used to set the maximum
1199# number of PAC entries to store in a PAC list (default: 10)
1200# fast_pac_format=binary option can be used to select binary format for
1201# storing PAC entries in order to save some space (the default
1202# text format uses about 2.5 times the size of minimal binary
1203# format)
1204#
1205# wpa_supplicant supports number of "EAP workarounds" to work around
1206# interoperability issues with incorrectly behaving authentication servers.
1207# These are enabled by default because some of the issues are present in large
1208# number of authentication servers. Strict EAP conformance mode can be
1209# configured by disabling workarounds with eap_workaround=0.
1210
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001211# update_identifier: PPS MO ID
1212# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1213
Dmitry Shmidt04949592012-07-19 12:16:46 -07001214# Station inactivity limit
1215#
1216# If a station does not send anything in ap_max_inactivity seconds, an
1217# empty data frame is sent to it in order to verify whether it is
1218# still in range. If this frame is not ACKed, the station will be
1219# disassociated and then deauthenticated. This feature is used to
1220# clear station table of old entries when the STAs move out of the
1221# range.
1222#
1223# The station can associate again with the AP if it is still in range;
1224# this inactivity poll is just used as a nicer way of verifying
1225# inactivity; i.e., client will not report broken connection because
1226# disassociation frame is not sent immediately without first polling
1227# the STA with a data frame.
1228# default: 300 (i.e., 5 minutes)
1229#ap_max_inactivity=300
1230
1231# DTIM period in Beacon intervals for AP mode (default: 2)
1232#dtim_period=2
1233
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001234# Beacon interval (default: 100 TU)
1235#beacon_int=100
1236
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001237# WPS in AP mode
1238# 0 = WPS enabled and configured (default)
1239# 1 = WPS disabled
1240#wps_disabled=0
1241
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001242# MAC address policy
1243# 0 = use permanent MAC address
1244# 1 = use random MAC address for each ESS connection
1245# 2 = like 1, but maintain OUI (with local admin bit set)
1246#mac_addr=0
1247
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001248# disable_ht: Whether HT (802.11n) should be disabled.
1249# 0 = HT enabled (if AP supports it)
1250# 1 = HT disabled
1251#
1252# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1253# 0 = HT-40 enabled (if AP supports it)
1254# 1 = HT-40 disabled
1255#
1256# disable_sgi: Whether SGI (short guard interval) should be disabled.
1257# 0 = SGI enabled (if AP supports it)
1258# 1 = SGI disabled
1259#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001260# disable_ldpc: Whether LDPC should be disabled.
1261# 0 = LDPC enabled (if AP supports it)
1262# 1 = LDPC disabled
1263#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001264# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1265# 0 = 40 MHz tolerant (default)
1266# 1 = 40 MHz intolerant
1267#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001268# ht_mcs: Configure allowed MCS rates.
1269# Parsed as an array of bytes, in base-16 (ascii-hex)
1270# ht_mcs="" // Use all available (default)
1271# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1272# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1273#
1274# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1275# -1 = Do not make any changes.
1276# 0 = Enable MAX-AMSDU if hardware supports it.
1277# 1 = Disable AMSDU
1278#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001279# ampdu_factor: Maximum A-MPDU Length Exponent
1280# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1281#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001282# ampdu_density: Allow overriding AMPDU density configuration.
1283# Treated as hint by the kernel.
1284# -1 = Do not make any changes.
1285# 0-3 = Set AMPDU density (aka factor) to specified value.
1286
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001287# disable_vht: Whether VHT should be disabled.
1288# 0 = VHT enabled (if AP supports it)
1289# 1 = VHT disabled
1290#
1291# vht_capa: VHT capabilities to set in the override
1292# vht_capa_mask: mask of VHT capabilities
1293#
1294# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1295# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1296# 0: MCS 0-7
1297# 1: MCS 0-8
1298# 2: MCS 0-9
1299# 3: not supported
1300
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001301##### Fast Session Transfer (FST) support #####################################
1302#
1303# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001304# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1305# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001306#
1307# FST is the transfer of a session from a channel to another channel, in the
1308# same or different frequency bands.
1309#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001310# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001311
1312# Identifier of an FST Group the interface belongs to.
1313#fst_group_id=bond0
1314
1315# Interface priority within the FST Group.
1316# Announcing a higher priority for an interface means declaring it more
1317# preferable for FST switch.
1318# fst_priority is in 1..255 range with 1 being the lowest priority.
1319#fst_priority=100
1320
1321# Default LLT value for this interface in milliseconds. The value used in case
1322# no value provided during session setup. Default is 50 msec.
1323# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1324# Transitioning between states).
1325#fst_llt=100
1326
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001327# Example blocks:
1328
1329# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1330network={
1331 ssid="simple"
1332 psk="very secret passphrase"
1333 priority=5
1334}
1335
1336# Same as previous, but request SSID-specific scanning (for APs that reject
1337# broadcast SSID)
1338network={
1339 ssid="second ssid"
1340 scan_ssid=1
1341 psk="very secret passphrase"
1342 priority=2
1343}
1344
1345# Only WPA-PSK is used. Any valid cipher combination is accepted.
1346network={
1347 ssid="example"
1348 proto=WPA
1349 key_mgmt=WPA-PSK
1350 pairwise=CCMP TKIP
1351 group=CCMP TKIP WEP104 WEP40
1352 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1353 priority=2
1354}
1355
1356# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1357network={
1358 ssid="example"
1359 proto=WPA
1360 key_mgmt=WPA-PSK
1361 pairwise=TKIP
1362 group=TKIP
1363 psk="not so secure passphrase"
1364 wpa_ptk_rekey=600
1365}
1366
1367# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1368# or WEP40 as the group cipher will not be accepted.
1369network={
1370 ssid="example"
1371 proto=RSN
1372 key_mgmt=WPA-EAP
1373 pairwise=CCMP TKIP
1374 group=CCMP TKIP
1375 eap=TLS
1376 identity="user@example.com"
1377 ca_cert="/etc/cert/ca.pem"
1378 client_cert="/etc/cert/user.pem"
1379 private_key="/etc/cert/user.prv"
1380 private_key_passwd="password"
1381 priority=1
1382}
1383
1384# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1385# (e.g., Radiator)
1386network={
1387 ssid="example"
1388 key_mgmt=WPA-EAP
1389 eap=PEAP
1390 identity="user@example.com"
1391 password="foobar"
1392 ca_cert="/etc/cert/ca.pem"
1393 phase1="peaplabel=1"
1394 phase2="auth=MSCHAPV2"
1395 priority=10
1396}
1397
1398# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1399# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1400network={
1401 ssid="example"
1402 key_mgmt=WPA-EAP
1403 eap=TTLS
1404 identity="user@example.com"
1405 anonymous_identity="anonymous@example.com"
1406 password="foobar"
1407 ca_cert="/etc/cert/ca.pem"
1408 priority=2
1409}
1410
1411# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1412# use. Real identity is sent only within an encrypted TLS tunnel.
1413network={
1414 ssid="example"
1415 key_mgmt=WPA-EAP
1416 eap=TTLS
1417 identity="user@example.com"
1418 anonymous_identity="anonymous@example.com"
1419 password="foobar"
1420 ca_cert="/etc/cert/ca.pem"
1421 phase2="auth=MSCHAPV2"
1422}
1423
1424# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1425# authentication.
1426network={
1427 ssid="example"
1428 key_mgmt=WPA-EAP
1429 eap=TTLS
1430 # Phase1 / outer authentication
1431 anonymous_identity="anonymous@example.com"
1432 ca_cert="/etc/cert/ca.pem"
1433 # Phase 2 / inner authentication
1434 phase2="autheap=TLS"
1435 ca_cert2="/etc/cert/ca2.pem"
1436 client_cert2="/etc/cer/user.pem"
1437 private_key2="/etc/cer/user.prv"
1438 private_key2_passwd="password"
1439 priority=2
1440}
1441
1442# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1443# group cipher.
1444network={
1445 ssid="example"
1446 bssid=00:11:22:33:44:55
1447 proto=WPA RSN
1448 key_mgmt=WPA-PSK WPA-EAP
1449 pairwise=CCMP
1450 group=CCMP
1451 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1452}
1453
1454# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1455# and all valid ciphers.
1456network={
1457 ssid=00010203
1458 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1459}
1460
1461
1462# EAP-SIM with a GSM SIM or USIM
1463network={
1464 ssid="eap-sim-test"
1465 key_mgmt=WPA-EAP
1466 eap=SIM
1467 pin="1234"
1468 pcsc=""
1469}
1470
1471
1472# EAP-PSK
1473network={
1474 ssid="eap-psk-test"
1475 key_mgmt=WPA-EAP
1476 eap=PSK
1477 anonymous_identity="eap_psk_user"
1478 password=06b4be19da289f475aa46a33cb793029
1479 identity="eap_psk_user@example.com"
1480}
1481
1482
1483# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1484# EAP-TLS for authentication and key generation; require both unicast and
1485# broadcast WEP keys.
1486network={
1487 ssid="1x-test"
1488 key_mgmt=IEEE8021X
1489 eap=TLS
1490 identity="user@example.com"
1491 ca_cert="/etc/cert/ca.pem"
1492 client_cert="/etc/cert/user.pem"
1493 private_key="/etc/cert/user.prv"
1494 private_key_passwd="password"
1495 eapol_flags=3
1496}
1497
1498
1499# LEAP with dynamic WEP keys
1500network={
1501 ssid="leap-example"
1502 key_mgmt=IEEE8021X
1503 eap=LEAP
1504 identity="user"
1505 password="foobar"
1506}
1507
1508# EAP-IKEv2 using shared secrets for both server and peer authentication
1509network={
1510 ssid="ikev2-example"
1511 key_mgmt=WPA-EAP
1512 eap=IKEV2
1513 identity="user"
1514 password="foobar"
1515}
1516
1517# EAP-FAST with WPA (WPA or WPA2)
1518network={
1519 ssid="eap-fast-test"
1520 key_mgmt=WPA-EAP
1521 eap=FAST
1522 anonymous_identity="FAST-000102030405"
1523 identity="username"
1524 password="password"
1525 phase1="fast_provisioning=1"
1526 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1527}
1528
1529network={
1530 ssid="eap-fast-test"
1531 key_mgmt=WPA-EAP
1532 eap=FAST
1533 anonymous_identity="FAST-000102030405"
1534 identity="username"
1535 password="password"
1536 phase1="fast_provisioning=1"
1537 pac_file="blob://eap-fast-pac"
1538}
1539
1540# Plaintext connection (no WPA, no IEEE 802.1X)
1541network={
1542 ssid="plaintext-test"
1543 key_mgmt=NONE
1544}
1545
1546
1547# Shared WEP key connection (no WPA, no IEEE 802.1X)
1548network={
1549 ssid="static-wep-test"
1550 key_mgmt=NONE
1551 wep_key0="abcde"
1552 wep_key1=0102030405
1553 wep_key2="1234567890123"
1554 wep_tx_keyidx=0
1555 priority=5
1556}
1557
1558
1559# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1560# IEEE 802.11 authentication
1561network={
1562 ssid="static-wep-test2"
1563 key_mgmt=NONE
1564 wep_key0="abcde"
1565 wep_key1=0102030405
1566 wep_key2="1234567890123"
1567 wep_tx_keyidx=0
1568 priority=5
1569 auth_alg=SHARED
1570}
1571
1572
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001573# IBSS/ad-hoc network with RSN
1574network={
1575 ssid="ibss-rsn"
1576 key_mgmt=WPA-PSK
1577 proto=RSN
1578 psk="12345678"
1579 mode=1
1580 frequency=2412
1581 pairwise=CCMP
1582 group=CCMP
1583}
1584
1585# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001586network={
1587 ssid="test adhoc"
1588 mode=1
1589 frequency=2412
1590 proto=WPA
1591 key_mgmt=WPA-NONE
1592 pairwise=NONE
1593 group=TKIP
1594 psk="secret passphrase"
1595}
1596
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001597# open mesh network
1598network={
1599 ssid="test mesh"
1600 mode=5
1601 frequency=2437
1602 key_mgmt=NONE
1603}
1604
1605# secure (SAE + AMPE) network
1606network={
1607 ssid="secure mesh"
1608 mode=5
1609 frequency=2437
1610 key_mgmt=SAE
1611 psk="very secret passphrase"
1612}
1613
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001614
1615# Catch all example that allows more or less all configuration modes
1616network={
1617 ssid="example"
1618 scan_ssid=1
1619 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1620 pairwise=CCMP TKIP
1621 group=CCMP TKIP WEP104 WEP40
1622 psk="very secret passphrase"
1623 eap=TTLS PEAP TLS
1624 identity="user@example.com"
1625 password="foobar"
1626 ca_cert="/etc/cert/ca.pem"
1627 client_cert="/etc/cert/user.pem"
1628 private_key="/etc/cert/user.prv"
1629 private_key_passwd="password"
1630 phase1="peaplabel=0"
1631}
1632
1633# Example of EAP-TLS with smartcard (openssl engine)
1634network={
1635 ssid="example"
1636 key_mgmt=WPA-EAP
1637 eap=TLS
1638 proto=RSN
1639 pairwise=CCMP TKIP
1640 group=CCMP TKIP
1641 identity="user@example.com"
1642 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001643
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001644 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1645 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1646 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001647
1648 # Optional PIN configuration; this can be left out and PIN will be
1649 # asked through the control interface
1650 pin="1234"
1651}
1652
1653# Example configuration showing how to use an inlined blob as a CA certificate
1654# data instead of using external file
1655network={
1656 ssid="example"
1657 key_mgmt=WPA-EAP
1658 eap=TTLS
1659 identity="user@example.com"
1660 anonymous_identity="anonymous@example.com"
1661 password="foobar"
1662 ca_cert="blob://exampleblob"
1663 priority=20
1664}
1665
1666blob-base64-exampleblob={
1667SGVsbG8gV29ybGQhCg==
1668}
1669
1670
1671# Wildcard match for SSID (plaintext APs only). This example select any
1672# open AP regardless of its SSID.
1673network={
1674 key_mgmt=NONE
1675}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001676
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001677# Example configuration blacklisting two APs - these will be ignored
1678# for this network.
1679network={
1680 ssid="example"
1681 psk="very secret passphrase"
1682 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1683}
1684
1685# Example configuration limiting AP selection to a specific set of APs;
1686# any other AP not matching the masked address will be ignored.
1687network={
1688 ssid="example"
1689 psk="very secret passphrase"
1690 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
1691}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001692
1693# Example config file that will only scan on channel 36.
1694freq_list=5180
1695network={
1696 key_mgmt=NONE
1697}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001698
1699
1700# Example MACsec configuration
1701#network={
1702# key_mgmt=IEEE8021X
1703# eap=TTLS
1704# phase2="auth=PAP"
1705# anonymous_identity="anonymous@example.com"
1706# identity="user@example.com"
1707# password="secretr"
1708# ca_cert="/etc/cert/ca.pem"
1709# eapol_flags=0
1710# macsec_policy=1
1711#}