blob: 047ca9001d8d1d02606f756d04bf85ffc0647a51 [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
101# also be used when using wired Ethernet drivers.
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700102# Note: macsec_qca driver is one type of Ethernet driver which implements
103# macsec feature.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800104# 2: like 0, but associate with APs using security policy and SSID (but not
105# BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
106# enable operation with hidden SSIDs and optimized roaming; in this mode,
107# the network blocks in the configuration file are tried one by one until
108# the driver reports successful association; each network block should have
109# explicit security policy (i.e., only one option in the lists) for
110# key_mgmt, pairwise, group, proto variables
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800111# Note: ap_scan=2 should not be used with the nl80211 driver interface (the
112# current Linux interface). ap_scan=1 is optimized work working with nl80211.
113# For finding networks using hidden SSID, scan_ssid=1 in the network block can
114# be used with nl80211.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800115# When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
116# created immediately regardless of scan results. ap_scan=1 mode will first try
117# to scan for existing networks and only if no matches with the enabled
118# networks are found, a new IBSS or AP mode network is created.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700119ap_scan=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800120
Dmitry Shmidtb70d0bb2015-11-16 10:43:06 -0800121# Whether to force passive scan for network connection
122#
123# By default, scans will send out Probe Request frames on channels that allow
124# active scanning. This advertise the local station to the world. Normally this
125# is fine, but users may wish to do passive scanning where the radio should only
126# listen quietly for Beacon frames and not send any Probe Request frames. Actual
127# functionality may be driver dependent.
128#
129# This parameter can be used to force only passive scanning to be used
130# for network connection cases. It should be noted that this will slow
131# down scan operations and reduce likelihood of finding the AP. In
132# addition, some use cases will override this due to functional
133# requirements, e.g., for finding an AP that uses hidden SSID
134# (scan_ssid=1) or P2P device discovery.
135#
136# 0: Do normal scans (allow active scans) (default)
137# 1: Do passive scans.
138#passive_scan=0
139
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800140# MPM residency
141# By default, wpa_supplicant implements the mesh peering manager (MPM) for an
142# open mesh. However, if the driver can implement the MPM, you may set this to
143# 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
144# always used.
145# 0: MPM lives in the driver
146# 1: wpa_supplicant provides an MPM which handles peering (default)
147#user_mpm=1
148
149# Maximum number of peer links (0-255; default: 99)
150# Maximum number of mesh peering currently maintained by the STA.
151#max_peer_links=99
152
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800153# Timeout in seconds to detect STA inactivity (default: 300 seconds)
154#
155# This timeout value is used in mesh STA to clean up inactive stations.
156#mesh_max_inactivity=300
157
158# cert_in_cb - Whether to include a peer certificate dump in events
159# This controls whether peer certificates for authentication server and
160# its certificate chain are included in EAP peer certificate events. This is
161# enabled by default.
162#cert_in_cb=1
163
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800164# EAP fast re-authentication
165# By default, fast re-authentication is enabled for all EAP methods that
166# support it. This variable can be used to disable fast re-authentication.
167# Normally, there is no need to disable this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700168fast_reauth=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800169
170# OpenSSL Engine support
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700171# These options can be used to load OpenSSL engines in special or legacy
172# modes.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800173# The two engines that are supported currently are shown below:
174# They are both from the opensc project (http://www.opensc.org/)
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700175# By default the PKCS#11 engine is loaded if the client_cert or
176# private_key option appear to be a PKCS#11 URI, and these options
177# should not need to be used explicitly.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800178# make the opensc engine available
179#opensc_engine_path=/usr/lib/opensc/engine_opensc.so
180# make the pkcs11 engine available
181#pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
182# configure the path to the pkcs11 module required by the pkcs11 engine
183#pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
184
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800185# OpenSSL cipher string
186#
187# This is an OpenSSL specific configuration option for configuring the default
188# ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
189# See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
190# on cipher suite configuration. This is applicable only if wpa_supplicant is
191# built to use OpenSSL.
192#openssl_ciphers=DEFAULT:!EXP:!LOW
193
194
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800195# Dynamic EAP methods
196# If EAP methods were built dynamically as shared object files, they need to be
197# loaded here before being used in the network blocks. By default, EAP methods
198# are included statically in the build, so these lines are not needed
199#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
200#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
201
202# Driver interface parameters
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700203# This field can be used to configure arbitrary driver interface parameters. The
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800204# format is specific to the selected driver interface. This field is not used
205# in most cases.
206#driver_param="field=value"
207
208# Country code
209# The ISO/IEC alpha2 country code for the country in which this device is
210# currently operating.
211#country=US
212
213# Maximum lifetime for PMKSA in seconds; default 43200
214#dot11RSNAConfigPMKLifetime=43200
215# Threshold for reauthentication (percentage of PMK lifetime); default 70
216#dot11RSNAConfigPMKReauthThreshold=70
217# Timeout for security association negotiation in seconds; default 60
218#dot11RSNAConfigSATimeout=60
219
220# Wi-Fi Protected Setup (WPS) parameters
221
222# Universally Unique IDentifier (UUID; see RFC 4122) of the device
223# If not configured, UUID will be generated based on the local MAC address.
224#uuid=12345678-9abc-def0-1234-56789abcdef0
225
226# Device Name
227# User-friendly description of device; up to 32 octets encoded in UTF-8
228#device_name=Wireless Client
229
230# Manufacturer
231# The manufacturer of the device (up to 64 ASCII characters)
232#manufacturer=Company
233
234# Model Name
235# Model of the device (up to 32 ASCII characters)
236#model_name=cmodel
237
238# Model Number
239# Additional device description (up to 32 ASCII characters)
240#model_number=123
241
242# Serial Number
243# Serial number of the device (up to 32 characters)
244#serial_number=12345
245
246# Primary Device Type
247# Used format: <categ>-<OUI>-<subcateg>
248# categ = Category as an integer value
249# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
250# default WPS OUI
251# subcateg = OUI-specific Sub Category as an integer value
252# Examples:
253# 1-0050F204-1 (Computer / PC)
254# 1-0050F204-2 (Computer / Server)
255# 5-0050F204-1 (Storage / NAS)
256# 6-0050F204-1 (Network Infrastructure / AP)
257#device_type=1-0050F204-1
258
259# OS Version
260# 4-octet operating system version number (hex string)
261#os_version=01020300
262
263# Config Methods
264# List of the supported configuration methods
265# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
266# nfc_interface push_button keypad virtual_display physical_display
267# virtual_push_button physical_push_button
268# For WSC 1.0:
269#config_methods=label display push_button keypad
270# For WSC 2.0:
271#config_methods=label virtual_display virtual_push_button keypad
272
273# Credential processing
274# 0 = process received credentials internally (default)
275# 1 = do not process received credentials; just pass them over ctrl_iface to
276# external program(s)
277# 2 = process received credentials internally and pass them over ctrl_iface
278# to external program(s)
279#wps_cred_processing=0
280
Dmitry Shmidt04949592012-07-19 12:16:46 -0700281# Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
282# The vendor attribute contents to be added in M1 (hex string)
283#wps_vendor_ext_m1=000137100100020001
284
285# NFC password token for WPS
286# These parameters can be used to configure a fixed NFC password token for the
287# station. This can be generated, e.g., with nfc_pw_token. When these
288# parameters are used, the station is assumed to be deployed with a NFC tag
289# that includes the matching NFC password token (e.g., written based on the
290# NDEF record from nfc_pw_token).
291#
292#wps_nfc_dev_pw_id: Device Password ID (16..65535)
293#wps_nfc_dh_pubkey: Hexdump of DH Public Key
294#wps_nfc_dh_privkey: Hexdump of DH Private Key
295#wps_nfc_dev_pw: Hexdump of Device Password
296
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -0700297# Priority for the networks added through WPS
298# This priority value will be set to each network profile that is added
299# by executing the WPS protocol.
300#wps_priority=0
301
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800302# Maximum number of BSS entries to keep in memory
303# Default: 200
304# This can be used to limit memory use on the BSS entries (cached scan
305# results). A larger value may be needed in environments that have huge number
306# of APs when using ap_scan=1 mode.
307#bss_max_count=200
308
Dmitry Shmidt04949592012-07-19 12:16:46 -0700309# Automatic scan
310# This is an optional set of parameters for automatic scanning
311# within an interface in following format:
312#autoscan=<autoscan module name>:<module parameters>
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800313# autoscan is like bgscan but on disconnected or inactive state.
314# For instance, on exponential module parameters would be <base>:<limit>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700315#autoscan=exponential:3:300
316# Which means a delay between scans on a base exponential of 3,
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800317# up to the limit of 300 seconds (3, 9, 27 ... 300)
318# For periodic module, parameters would be <fixed interval>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700319#autoscan=periodic:30
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800320# So a delay of 30 seconds will be applied between each scan.
321# Note: If sched_scan_plans are configured and supported by the driver,
322# autoscan is ignored.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800323
324# filter_ssids - SSID-based scan result filtering
325# 0 = do not filter scan results (default)
326# 1 = only include configured SSIDs in scan results/BSS table
327#filter_ssids=0
328
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700329# Password (and passphrase, etc.) backend for external storage
330# format: <backend name>[:<optional backend parameters>]
331#ext_password_backend=test:pw1=password|pw2=testing
332
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700333
334# Disable P2P functionality
335# p2p_disabled=1
336
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700337# Timeout in seconds to detect STA inactivity (default: 300 seconds)
338#
339# This timeout value is used in P2P GO mode to clean up
340# inactive stations.
341#p2p_go_max_inactivity=300
342
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700343# Passphrase length (8..63) for P2P GO
344#
345# This parameter controls the length of the random passphrase that is
346# generated at the GO. Default: 8.
347#p2p_passphrase_len=8
348
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700349# Extra delay between concurrent P2P search iterations
350#
351# This value adds extra delay in milliseconds between concurrent search
352# iterations to make p2p_find friendlier to concurrent operations by avoiding
353# it from taking 100% of radio resources. The default value is 500 ms.
354#p2p_search_delay=500
355
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800356# Opportunistic Key Caching (also known as Proactive Key Caching) default
357# This parameter can be used to set the default behavior for the
358# proactive_key_caching parameter. By default, OKC is disabled unless enabled
359# with the global okc=1 parameter or with the per-network
360# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
361# can be disabled with per-network proactive_key_caching=0 parameter.
362#okc=0
363
364# Protected Management Frames default
365# This parameter can be used to set the default behavior for the ieee80211w
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700366# parameter for RSN networks. By default, PMF is disabled unless enabled with
367# the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
368# With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
369# per-network ieee80211w parameter. This global default value does not apply
370# for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
371# RSN.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800372#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800373
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800374# Enabled SAE finite cyclic groups in preference order
375# By default (if this parameter is not set), the mandatory group 19 (ECC group
376# defined over a 256-bit prime order field) is preferred, but other groups are
377# also enabled. If this parameter is set, the groups will be tried in the
378# indicated order. The group values are listed in the IANA registry:
379# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
380#sae_groups=21 20 19 26 25
381
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800382# Default value for DTIM period (if not overridden in network block)
383#dtim_period=2
384
385# Default value for Beacon interval (if not overridden in network block)
386#beacon_int=100
387
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700388# Additional vendor specific elements for Beacon and Probe Response frames
389# This parameter can be used to add additional vendor specific element(s) into
390# the end of the Beacon and Probe Response frames. The format for these
391# element(s) is a hexdump of the raw information elements (id+len+payload for
392# one or more elements). This is used in AP and P2P GO modes.
393#ap_vendor_elements=dd0411223301
394
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700395# Ignore scan results older than request
396#
397# The driver may have a cache of scan results that makes it return
398# information that is older than our scan trigger. This parameter can
399# be used to configure such old information to be ignored instead of
400# allowing it to update the internal BSS table.
401#ignore_old_scan_res=0
402
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700403# scan_cur_freq: Whether to scan only the current frequency
404# 0: Scan all available frequencies. (Default)
405# 1: Scan current operating frequency if another VIF on the same radio
406# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700407
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700408# MAC address policy default
409# 0 = use permanent MAC address
410# 1 = use random MAC address for each ESS connection
411# 2 = like 1, but maintain OUI (with local admin bit set)
412#
413# By default, permanent MAC address is used unless policy is changed by
414# the per-network mac_addr parameter. Global mac_addr=1 can be used to
415# change this default behavior.
416#mac_addr=0
417
418# Lifetime of random MAC address in seconds (default: 60)
419#rand_addr_lifetime=60
420
421# MAC address policy for pre-association operations (scanning, ANQP)
422# 0 = use permanent MAC address
423# 1 = use random MAC address
424# 2 = like 1, but maintain OUI (with local admin bit set)
425#preassoc_mac_addr=0
426
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800427# Interworking (IEEE 802.11u)
428
429# Enable Interworking
430# interworking=1
431
432# Homogenous ESS identifier
433# If this is set, scans will be used to request response only from BSSes
434# belonging to the specified Homogeneous ESS. This is used only if interworking
435# is enabled.
436# hessid=00:11:22:33:44:55
437
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700438# Automatic network selection behavior
439# 0 = do not automatically go through Interworking network selection
440# (i.e., require explicit interworking_select command for this; default)
441# 1 = perform Interworking network selection if one or more
442# credentials have been configured and scan did not find a
443# matching network block
444#auto_interworking=0
445
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700446# GAS Address3 field behavior
447# 0 = P2P specification (Address3 = AP BSSID); default
448# 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
449# sent to not-associated AP; if associated, AP BSSID)
450#gas_address3=0
451
Dmitry Shmidt7d175302016-09-06 13:11:34 -0700452# Publish fine timing measurement (FTM) responder functionality in
453# the Extended Capabilities element bit 70.
454# Controls whether FTM responder functionality will be published by AP/STA.
455# Note that actual FTM responder operation is managed outside wpa_supplicant.
456# 0 = Do not publish; default
457# 1 = Publish
458#ftm_responder=0
459
460# Publish fine timing measurement (FTM) initiator functionality in
461# the Extended Capabilities element bit 71.
462# Controls whether FTM initiator functionality will be published by AP/STA.
463# Note that actual FTM initiator operation is managed outside wpa_supplicant.
464# 0 = Do not publish; default
465# 1 = Publish
466#ftm_initiator=0
467
Dmitry Shmidt04949592012-07-19 12:16:46 -0700468# credential block
469#
470# Each credential used for automatic network selection is configured as a set
471# of parameters that are compared to the information advertised by the APs when
472# interworking_select and interworking_connect commands are used.
473#
474# credential fields:
475#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800476# temporary: Whether this credential is temporary and not to be saved
477#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700478# priority: Priority group
479# By default, all networks and credentials get the same priority group
480# (0). This field can be used to give higher priority for credentials
481# (and similarly in struct wpa_ssid for network blocks) to change the
482# Interworking automatic networking selection behavior. The matching
483# network (based on either an enabled network block or a credential)
484# with the highest priority value will be selected.
485#
486# pcsc: Use PC/SC and SIM/USIM card
487#
488# realm: Home Realm for Interworking
489#
490# username: Username for Interworking network selection
491#
492# password: Password for Interworking network selection
493#
494# ca_cert: CA certificate for Interworking network selection
495#
496# client_cert: File path to client certificate file (PEM/DER)
497# This field is used with Interworking networking selection for a case
498# where client certificate/private key is used for authentication
499# (EAP-TLS). Full path to the file should be used since working
500# directory may change when wpa_supplicant is run in the background.
501#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700502# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
503#
504# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
505#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700506# Alternatively, a named configuration blob can be used by setting
507# this to blob://blob_name.
508#
509# private_key: File path to client private key file (PEM/DER/PFX)
510# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
511# commented out. Both the private key and certificate will be read
512# from the PKCS#12 file in this case. Full path to the file should be
513# used since working directory may change when wpa_supplicant is run
514# in the background.
515#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700516# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
517# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
518#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700519# Windows certificate store can be used by leaving client_cert out and
520# configuring private_key in one of the following formats:
521#
522# cert://substring_to_match
523#
524# hash://certificate_thumbprint_in_hex
525#
526# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
527#
528# Note that when running wpa_supplicant as an application, the user
529# certificate store (My user account) is used, whereas computer store
530# (Computer account) is used when running wpasvc as a service.
531#
532# Alternatively, a named configuration blob can be used by setting
533# this to blob://blob_name.
534#
535# private_key_passwd: Password for private key file
536#
537# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
538#
539# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
540# format
541#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700542# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700543# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700544# whether the AP is operated by the Home SP. Multiple domain entries can
545# be used to configure alternative FQDNs that will be considered home
546# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700547#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700548# roaming_consortium: Roaming Consortium OI
549# If roaming_consortium_len is non-zero, this field contains the
550# Roaming Consortium OI that can be used to determine which access
551# points support authentication with this credential. This is an
552# alternative to the use of the realm parameter. When using Roaming
553# Consortium to match the network, the EAP parameters need to be
554# pre-configured with the credential since the NAI Realm information
555# may not be available or fetched.
556#
557# eap: Pre-configured EAP method
558# This optional field can be used to specify which EAP method will be
559# used with this credential. If not set, the EAP method is selected
560# automatically based on ANQP information (e.g., NAI Realm).
561#
562# phase1: Pre-configure Phase 1 (outer authentication) parameters
563# This optional field is used with like the 'eap' parameter.
564#
565# phase2: Pre-configure Phase 2 (inner authentication) parameters
566# This optional field is used with like the 'eap' parameter.
567#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800568# excluded_ssid: Excluded SSID
569# This optional field can be used to excluded specific SSID(s) from
570# matching with the network. Multiple entries can be used to specify more
571# than one SSID.
572#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800573# roaming_partner: Roaming partner information
574# This optional field can be used to configure preferences between roaming
575# partners. The field is a string in following format:
576# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
577# (non-exact match means any subdomain matches the entry; priority is in
578# 0..255 range with 0 being the highest priority)
579#
580# update_identifier: PPS MO ID
581# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
582#
583# provisioning_sp: FQDN of the SP that provisioned the credential
584# This optional field can be used to keep track of the SP that provisioned
585# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
586#
587# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
588# These fields can be used to specify minimum download/upload backhaul
589# bandwidth that is preferred for the credential. This constraint is
590# ignored if the AP does not advertise WAN Metrics information or if the
591# limit would prevent any connection. Values are in kilobits per second.
592# min_dl_bandwidth_home
593# min_ul_bandwidth_home
594# min_dl_bandwidth_roaming
595# min_ul_bandwidth_roaming
596#
597# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
598# (PPS/<X+>/Policy/MaximumBSSLoadValue)
599# This value is used as the maximum channel utilization for network
600# selection purposes for home networks. If the AP does not advertise
601# BSS Load or if the limit would prevent any connection, this constraint
602# will be ignored.
603#
604# req_conn_capab: Required connection capability
605# (PPS/<X+>/Policy/RequiredProtoPortTuple)
606# This value is used to configure set of required protocol/port pairs that
607# a roaming network shall support (include explicitly in Connection
608# Capability ANQP element). This constraint is ignored if the AP does not
609# advertise Connection Capability or if this constraint would prevent any
610# network connection. This policy is not used in home networks.
611# Format: <protocol>[:<comma-separated list of ports]
612# Multiple entries can be used to list multiple requirements.
613# For example, number of common TCP protocols:
614# req_conn_capab=6,22,80,443
615# For example, IPSec/IKE:
616# req_conn_capab=17:500
617# req_conn_capab=50
618#
619# ocsp: Whether to use/require OCSP to check server certificate
620# 0 = do not use OCSP stapling (TLS certificate status extension)
621# 1 = try to use OCSP stapling, but not require response
622# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800623# 3 = require valid OCSP stapling response for all not-trusted
624# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800625#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700626# sim_num: Identifier for which SIM to use in multi-SIM devices
627#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700628# for example:
629#
630#cred={
631# realm="example.com"
632# username="user@example.com"
633# password="password"
634# ca_cert="/etc/wpa_supplicant/ca.pem"
635# domain="example.com"
636#}
637#
638#cred={
639# imsi="310026-000000000"
640# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
641#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700642#
643#cred={
644# realm="example.com"
645# username="user"
646# password="password"
647# ca_cert="/etc/wpa_supplicant/ca.pem"
648# domain="example.com"
649# roaming_consortium=223344
650# eap=TTLS
651# phase2="auth=MSCHAPV2"
652#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800653
Dmitry Shmidt04949592012-07-19 12:16:46 -0700654# Hotspot 2.0
655# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800656
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800657# Scheduled scan plans
658#
659# A space delimited list of scan plans. Each scan plan specifies the scan
660# interval and number of iterations, delimited by a colon. The last scan plan
661# will run infinitely and thus must specify only the interval and not the number
662# of iterations.
663#
664# The driver advertises the maximum number of scan plans supported. If more scan
665# plans than supported are configured, only the first ones are set (up to the
666# maximum supported). The last scan plan that specifies only the interval is
667# always set as the last plan.
668#
669# If the scan interval or the number of iterations for a scan plan exceeds the
670# maximum supported, it will be set to the maximum supported value.
671#
672# Format:
673# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
674#
675# Example:
676# sched_scan_plans=10:100 20:200 30
677
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800678# Multi Band Operation (MBO) non-preferred channels
679# A space delimited list of non-preferred channels where each channel is a colon
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700680# delimited list of values.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800681# Format:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700682# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800683# Example:
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700684# non_pref_chan="81:5:10:2 81:1:0:2 81:9:0:2"
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800685
686# MBO Cellular Data Capabilities
687# 1 = Cellular data connection available
688# 2 = Cellular data connection not available
689# 3 = Not cellular capable (default)
690#mbo_cell_capa=3
691
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800692# network block
693#
694# Each network (usually AP's sharing the same SSID) is configured as a separate
695# block in this configuration file. The network blocks are in preference order
696# (the first match is used).
697#
698# network block fields:
699#
700# disabled:
701# 0 = this network can be used (default)
702# 1 = this network block is disabled (can be enabled through ctrl_iface,
703# e.g., with wpa_cli or wpa_gui)
704#
705# id_str: Network identifier string for external scripts. This value is passed
706# to external action script through wpa_cli as WPA_ID_STR environment
707# variable to make it easier to do network specific configuration.
708#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700709# ssid: SSID (mandatory); network name in one of the optional formats:
710# - an ASCII string with double quotation
711# - a hex string (two characters per octet of SSID)
712# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800713#
714# scan_ssid:
715# 0 = do not scan this SSID with specific Probe Request frames (default)
716# 1 = scan with SSID-specific Probe Request frames (this can be used to
717# find APs that do not accept broadcast SSID or use multiple SSIDs;
718# this will add latency to scanning, so enable this only when needed)
719#
720# bssid: BSSID (optional); if set, this network block is used only when
721# associating with the AP using the configured BSSID
722#
723# priority: priority group (integer)
724# By default, all networks will get same priority group (0). If some of the
725# networks are more desirable, this field can be used to change the order in
726# which wpa_supplicant goes through the networks when selecting a BSS. The
727# priority groups will be iterated in decreasing priority (i.e., the larger the
728# priority value, the sooner the network is matched against the scan results).
729# Within each priority group, networks will be selected based on security
730# policy, signal strength, etc.
731# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
732# using this priority to select the order for scanning. Instead, they try the
733# networks in the order that used in the configuration file.
734#
735# mode: IEEE 802.11 operation mode
736# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
737# 1 = IBSS (ad-hoc, peer-to-peer)
738# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800739# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
740# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
741# TKIP/CCMP) is available for backwards compatibility, but its use is
742# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800743# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
744# both), and psk must also be set.
745#
746# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
747# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
748# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
749# In addition, this value is only used by the station that creates the IBSS. If
750# an IBSS network with the configured SSID is already present, the frequency of
751# the network will be used instead of this configured value.
752#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800753# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700754# 0 = do not use PBSS
755# 1 = use PBSS
756# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800757# Used together with mode configuration. When mode is AP, it means to start a
758# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700759# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
760# which means connect to either PCP or AP.
761# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800762# For more details, see IEEE Std 802.11ad-2012.
763#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800764# scan_freq: List of frequencies to scan
765# Space-separated list of frequencies in MHz to scan when searching for this
766# BSS. If the subset of channels used by the network is known, this option can
767# be used to optimize scanning to not occur on channels that the network does
768# not use. Example: scan_freq=2412 2437 2462
769#
770# freq_list: Array of allowed frequencies
771# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
772# set, scan results that do not match any of the specified frequencies are not
773# considered when selecting a BSS.
774#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700775# This can also be set on the outside of the network block. In this case,
776# it limits the frequencies that will be scanned.
777#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800778# bgscan: Background scanning
779# wpa_supplicant behavior for background scanning can be specified by
780# configuring a bgscan module. These modules are responsible for requesting
781# background scans for the purpose of roaming within an ESS (i.e., within a
782# single network block with all the APs using the same SSID). The bgscan
783# parameter uses following format: "<bgscan module name>:<module parameters>"
784# Following bgscan modules are available:
785# simple - Periodic background scans based on signal strength
786# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
787# <long interval>"
788# bgscan="simple:30:-45:300"
789# learn - Learn channels used by the network and try to avoid bgscans on other
790# channels (experimental)
791# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
792# <long interval>[:<database file name>]"
793# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800794# Explicitly disable bgscan by setting
795# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800796#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800797# This option can also be set outside of all network blocks for the bgscan
798# parameter to apply for all the networks that have no specific bgscan
799# parameter.
800#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800801# proto: list of accepted protocols
802# WPA = WPA/IEEE 802.11i/D3.0
803# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
804# If not set, this defaults to: WPA RSN
805#
806# key_mgmt: list of accepted authenticated key management protocols
807# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
808# WPA-EAP = WPA using EAP authentication
809# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
810# generated WEP keys
811# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800812# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
813# instead)
814# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
815# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800816# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
817# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800818# SAE = Simultaneous authentication of equals; pre-shared key/password -based
819# authentication with stronger security than WPA-PSK especially when using
820# not that strong password
821# FT-SAE = SAE with FT
822# WPA-EAP-SUITE-B = Suite B 128-bit level
823# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800824# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800825# FILS-SHA256 = Fast Initial Link Setup with SHA256
826# FILS-SHA384 = Fast Initial Link Setup with SHA384
827# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
828# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800829# If not set, this defaults to: WPA-PSK WPA-EAP
830#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700831# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800832# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700833# 1 = optional
834# 2 = required
835# The most common configuration options for this based on the PMF (protected
836# management frames) certification program are:
837# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
838# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
839# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
840#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800841# auth_alg: list of allowed IEEE 802.11 authentication algorithms
842# OPEN = Open System authentication (required for WPA/WPA2)
843# SHARED = Shared Key authentication (requires static WEP keys)
844# LEAP = LEAP/Network EAP (only used with LEAP)
845# If not set, automatic selection is used (Open System with LEAP enabled if
846# LEAP is allowed as one of the EAP methods).
847#
848# pairwise: list of accepted pairwise (unicast) ciphers for WPA
849# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
850# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
851# NONE = Use only Group Keys (deprecated, should not be included if APs support
852# pairwise keys)
853# If not set, this defaults to: CCMP TKIP
854#
855# group: list of accepted group (broadcast/multicast) 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# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
859# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
860# If not set, this defaults to: CCMP TKIP WEP104 WEP40
861#
862# psk: WPA preshared key; 256-bit pre-shared key
863# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
864# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
865# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700866# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
867# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800868# This field is not needed, if WPA-EAP is used.
869# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
870# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
871# startup and reconfiguration time can be optimized by generating the PSK only
872# only when the passphrase or SSID has actually changed.
873#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -0700874# mem_only_psk: Whether to keep PSK/passphrase only in memory
875# 0 = allow psk/passphrase to be stored to the configuration file
876# 1 = do not store psk/passphrase to the configuration file
877#mem_only_psk=0
878#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800879# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
880# Dynamic WEP key required for non-WPA mode
881# bit0 (1): require dynamically generated unicast WEP key
882# bit1 (2): require dynamically generated broadcast WEP key
883# (3 = require both keys; default)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700884# Note: When using wired authentication (including macsec_qca driver),
885# eapol_flags must be set to 0 for the authentication to be completed
886# successfully.
887#
888# macsec_policy: IEEE 802.1X/MACsec options
889# This determines how sessions are secured with MACsec. It is currently
890# applicable only when using the macsec_qca driver interface.
891# 0: MACsec not in use (default)
892# 1: MACsec enabled - Should secure, accept key server's advice to
893# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800894#
895# mixed_cell: This option can be used to configure whether so called mixed
896# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800897# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800898# 0 = disabled (default)
899# 1 = enabled
900#
901# proactive_key_caching:
902# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800903# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800904# 1 = enabled
905#
906# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
907# hex without quotation, e.g., 0102030405)
908# wep_tx_keyidx: Default WEP key index (TX) (0..3)
909#
910# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
911# allowed. This is only used with RSN/WPA2.
912# 0 = disabled (default)
913# 1 = enabled
914#peerkey=1
915#
916# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
917# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
918#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -0700919# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
920# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
921# Authenticator role in IBSS.
922#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800923# Following fields are only used with internal EAP implementation.
924# eap: space-separated list of accepted EAP methods
Dmitry Shmidtaca489e2016-09-28 15:44:14 -0700925# MD5 = EAP-MD5 (insecure and does not generate keying material ->
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800926# cannot be used with WPA; to be used as a Phase 2 method
927# with EAP-PEAP or EAP-TTLS)
928# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
929# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
930# OTP = EAP-OTP (cannot be used separately with WPA; to be used
931# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
932# GTC = EAP-GTC (cannot be used separately with WPA; to be used
933# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
934# TLS = EAP-TLS (client and server certificate)
935# PEAP = EAP-PEAP (with tunnelled EAP authentication)
936# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
937# authentication)
938# If not set, all compiled in methods are allowed.
939#
940# identity: Identity string for EAP
941# This field is also used to configure user NAI for
942# EAP-PSK/PAX/SAKE/GPSK.
943# anonymous_identity: Anonymous identity string for EAP (to be used as the
944# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700945# identity, e.g., EAP-TTLS). This field can also be used with
946# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800947# password: Password string for EAP. This field can include either the
948# plaintext password (using ASCII or hex string) or a NtPasswordHash
949# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
950# NtPasswordHash can only be used when the password is for MSCHAPv2 or
951# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
952# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
953# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700954# variable length PSK. ext:<name of external password field> format can
955# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800956# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
957# or more trusted CA certificates. If ca_cert and ca_path are not
958# included, server certificate will not be verified. This is insecure and
959# a trusted CA certificate should always be configured when using
960# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
961# change when wpa_supplicant is run in the background.
962#
963# Alternatively, this can be used to only perform matching of the server
964# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
965# this case, the possible CA certificates in the server certificate chain
966# are ignored and only the server certificate is verified. This is
967# configured with the following format:
968# hash:://server/sha256/cert_hash_in_hex
969# For example: "hash://server/sha256/
970# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
971#
972# On Windows, trusted CA certificates can be loaded from the system
973# certificate store by setting this to cert_store://<name>, e.g.,
974# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
975# Note that when running wpa_supplicant as an application, the user
976# certificate store (My user account) is used, whereas computer store
977# (Computer account) is used when running wpasvc as a service.
978# ca_path: Directory path for CA certificate files (PEM). This path may
979# contain multiple CA certificates in OpenSSL format. Common use for this
980# is to point to system trusted CA list which is often installed into
981# directory like /etc/ssl/certs. If configured, these certificates are
982# added to the list of trusted CAs. ca_cert may also be included in that
983# case, but it is not required.
984# client_cert: File path to client certificate file (PEM/DER)
985# Full path should be used since working directory may change when
986# wpa_supplicant is run in the background.
987# Alternatively, a named configuration blob can be used by setting this
988# to blob://<blob name>.
989# private_key: File path to client private key file (PEM/DER/PFX)
990# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
991# commented out. Both the private key and certificate will be read from
992# the PKCS#12 file in this case. Full path should be used since working
993# directory may change when wpa_supplicant is run in the background.
994# Windows certificate store can be used by leaving client_cert out and
995# configuring private_key in one of the following formats:
996# cert://substring_to_match
997# hash://certificate_thumbprint_in_hex
998# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
999# Note that when running wpa_supplicant as an application, the user
1000# certificate store (My user account) is used, whereas computer store
1001# (Computer account) is used when running wpasvc as a service.
1002# Alternatively, a named configuration blob can be used by setting this
1003# to blob://<blob name>.
1004# private_key_passwd: Password for private key file (if left out, this will be
1005# asked through control interface)
1006# dh_file: File path to DH/DSA parameters file (in PEM format)
1007# This is an optional configuration file for setting parameters for an
1008# ephemeral DH key exchange. In most cases, the default RSA
1009# authentication does not use this configuration. However, it is possible
1010# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1011# DSA keys always use ephemeral DH keys. This can be used to achieve
1012# forward secrecy. If the file is in DSA parameters format, it will be
1013# automatically converted into DH params.
1014# subject_match: Substring to be matched against the subject of the
1015# authentication server certificate. If this string is set, the server
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001016# certificate is only accepted if it contains this string in the subject.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001017# The subject string is in following format:
1018# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001019# Note: Since this is a substring match, this cannot be used securely to
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001020# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001021# such a use case, domain_suffix_match or domain_match should be used
1022# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001023# altsubject_match: Semicolon separated string of entries to be matched against
1024# the alternative subject name of the authentication server certificate.
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001025# If this string is set, the server certificate is only accepted if it
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001026# contains one of the entries in an alternative subject name extension.
1027# altSubjectName string is in following format: TYPE:VALUE
1028# Example: EMAIL:server@example.com
1029# Example: DNS:server.example.com;DNS:server2.example.com
1030# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001031# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001032# used as a suffix match requirement for the AAA server certificate in
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001033# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1034# constraint is met. If no dNSName values are present, this constraint is
1035# matched against SubjectName CN using same suffix match comparison.
1036#
1037# Suffix match here means that the host/domain name is compared one label
1038# at a time starting from the top-level domain and all the labels in
1039# domain_suffix_match shall be included in the certificate. The
1040# certificate may include additional sub-level labels in addition to the
1041# required labels.
1042#
1043# For example, domain_suffix_match=example.com would match
1044# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001045# domain_match: Constraint for server domain name
1046# If set, this FQDN is used as a full match requirement for the
1047# server certificate in SubjectAltName dNSName element(s). If a
1048# matching dNSName is found, this constraint is met. If no dNSName
1049# values are present, this constraint is matched against SubjectName CN
1050# using same full match comparison. This behavior is similar to
1051# domain_suffix_match, but has the requirement of a full match, i.e.,
1052# no subdomains or wildcard matches are allowed. Case-insensitive
1053# comparison is used, so "Example.com" matches "example.com", but would
1054# not match "test.Example.com".
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001055# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1056# (string with field-value pairs, e.g., "peapver=0" or
1057# "peapver=1 peaplabel=1")
1058# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1059# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1060# to be used during key derivation when PEAPv1 or newer. Most existing
1061# PEAPv1 implementation seem to be using the old label, "client EAP
1062# encryption", and wpa_supplicant is now using that as the default value.
1063# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1064# interoperate with PEAPv1; see eap_testing.txt for more details.
1065# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1066# tunneled EAP-Success. This is required with some RADIUS servers that
1067# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1068# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1069# include_tls_length=1 can be used to force wpa_supplicant to include
1070# TLS Message Length field in all TLS messages even if they are not
1071# fragmented.
1072# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1073# challenges (by default, it accepts 2 or 3)
1074# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1075# protected result indication.
1076# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1077# behavior:
1078# * 0 = do not use cryptobinding (default)
1079# * 1 = use cryptobinding if server supports it
1080# * 2 = require cryptobinding
1081# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1082# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001083#
1084# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1085# used to configure a mode that allows EAP-Success (and EAP-Failure)
1086# without going through authentication step. Some switches use such
1087# sequence when forcing the port to be authorized/unauthorized or as a
1088# fallback option if the authentication server is unreachable. By default,
1089# wpa_supplicant discards such frames to protect against potential attacks
1090# by rogue devices, but this option can be used to disable that protection
1091# for cases where the server/authenticator does not need to be
1092# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001093# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1094# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001095# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1096# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001097#
1098# TLS-based methods can use the following parameters to control TLS behavior
1099# (these are normally in the phase1 parameter, but can be used also in the
1100# phase2 parameter when EAP-TLS is used within the inner tunnel):
1101# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1102# TLS library, these may be disabled by default to enforce stronger
1103# security)
1104# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1105# the TLS library to accept certificates even if they are not currently
1106# valid, i.e., have expired or have not yet become valid; this should be
1107# used only for testing purposes)
1108# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1109# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1110# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1111# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001112# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001113# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1114# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001115# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001116# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1117# that have issues interoperating with updated TLS version)
1118# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1119# that have issues interoperating with updated TLS version)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001120# tls_ext_cert_check=0 - No external server certificate validation (default)
1121# tls_ext_cert_check=1 - External server certificate validation enabled; this
1122# requires an external program doing validation of server certificate
1123# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1124# interface and report the result of the validation with
1125# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001126#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001127# Following certificate/private key fields are used in inner Phase2
1128# authentication when using EAP-TTLS or EAP-PEAP.
1129# ca_cert2: File path to CA certificate file. This file can have one or more
1130# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1131# server certificate will not be verified. This is insecure and a trusted
1132# CA certificate should always be configured.
1133# ca_path2: Directory path for CA certificate files (PEM)
1134# client_cert2: File path to client certificate file
1135# private_key2: File path to client private key file
1136# private_key2_passwd: Password for private key file
1137# dh_file2: File path to DH/DSA parameters file (in PEM format)
1138# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001139# authentication server certificate. See subject_match for more details.
1140# altsubject_match2: Semicolon separated string of entries to be matched
1141# against the alternative subject name of the authentication server
1142# certificate. See altsubject_match documentation for more details.
1143# domain_suffix_match2: Constraint for server domain name. See
1144# domain_suffix_match for more details.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001145#
1146# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1147# This value limits the fragment size for EAP methods that support
1148# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1149# small enough to make the EAP messages fit in MTU of the network
1150# interface used for EAPOL. The default value is suitable for most
1151# cases.
1152#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001153# ocsp: Whether to use/require OCSP to check server certificate
1154# 0 = do not use OCSP stapling (TLS certificate status extension)
1155# 1 = try to use OCSP stapling, but not require response
1156# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001157# 3 = require valid OCSP stapling response for all not-trusted
1158# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001159#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001160# openssl_ciphers: OpenSSL specific cipher configuration
1161# This can be used to override the global openssl_ciphers configuration
1162# parameter (see above).
1163#
1164# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1165#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001166# EAP-FAST variables:
1167# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1168# to create this file and write updates to it when PAC is being
1169# provisioned or refreshed. Full path to the file should be used since
1170# working directory may change when wpa_supplicant is run in the
1171# background. Alternatively, a named configuration blob can be used by
1172# setting this to blob://<blob name>
1173# phase1: fast_provisioning option can be used to enable in-line provisioning
1174# of EAP-FAST credentials (PAC):
1175# 0 = disabled,
1176# 1 = allow unauthenticated provisioning,
1177# 2 = allow authenticated provisioning,
1178# 3 = allow both unauthenticated and authenticated provisioning
1179# fast_max_pac_list_len=<num> option can be used to set the maximum
1180# number of PAC entries to store in a PAC list (default: 10)
1181# fast_pac_format=binary option can be used to select binary format for
1182# storing PAC entries in order to save some space (the default
1183# text format uses about 2.5 times the size of minimal binary
1184# format)
1185#
1186# wpa_supplicant supports number of "EAP workarounds" to work around
1187# interoperability issues with incorrectly behaving authentication servers.
1188# These are enabled by default because some of the issues are present in large
1189# number of authentication servers. Strict EAP conformance mode can be
1190# configured by disabling workarounds with eap_workaround=0.
1191
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001192# update_identifier: PPS MO ID
1193# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1194
Dmitry Shmidt04949592012-07-19 12:16:46 -07001195# Station inactivity limit
1196#
1197# If a station does not send anything in ap_max_inactivity seconds, an
1198# empty data frame is sent to it in order to verify whether it is
1199# still in range. If this frame is not ACKed, the station will be
1200# disassociated and then deauthenticated. This feature is used to
1201# clear station table of old entries when the STAs move out of the
1202# range.
1203#
1204# The station can associate again with the AP if it is still in range;
1205# this inactivity poll is just used as a nicer way of verifying
1206# inactivity; i.e., client will not report broken connection because
1207# disassociation frame is not sent immediately without first polling
1208# the STA with a data frame.
1209# default: 300 (i.e., 5 minutes)
1210#ap_max_inactivity=300
1211
1212# DTIM period in Beacon intervals for AP mode (default: 2)
1213#dtim_period=2
1214
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001215# Beacon interval (default: 100 TU)
1216#beacon_int=100
1217
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001218# WPS in AP mode
1219# 0 = WPS enabled and configured (default)
1220# 1 = WPS disabled
1221#wps_disabled=0
1222
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001223# MAC address policy
1224# 0 = use permanent MAC address
1225# 1 = use random MAC address for each ESS connection
1226# 2 = like 1, but maintain OUI (with local admin bit set)
1227#mac_addr=0
1228
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001229# disable_ht: Whether HT (802.11n) should be disabled.
1230# 0 = HT enabled (if AP supports it)
1231# 1 = HT disabled
1232#
1233# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1234# 0 = HT-40 enabled (if AP supports it)
1235# 1 = HT-40 disabled
1236#
1237# disable_sgi: Whether SGI (short guard interval) should be disabled.
1238# 0 = SGI enabled (if AP supports it)
1239# 1 = SGI disabled
1240#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001241# disable_ldpc: Whether LDPC should be disabled.
1242# 0 = LDPC enabled (if AP supports it)
1243# 1 = LDPC disabled
1244#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001245# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1246# 0 = 40 MHz tolerant (default)
1247# 1 = 40 MHz intolerant
1248#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001249# ht_mcs: Configure allowed MCS rates.
1250# Parsed as an array of bytes, in base-16 (ascii-hex)
1251# ht_mcs="" // Use all available (default)
1252# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1253# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1254#
1255# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1256# -1 = Do not make any changes.
1257# 0 = Enable MAX-AMSDU if hardware supports it.
1258# 1 = Disable AMSDU
1259#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001260# ampdu_factor: Maximum A-MPDU Length Exponent
1261# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1262#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001263# ampdu_density: Allow overriding AMPDU density configuration.
1264# Treated as hint by the kernel.
1265# -1 = Do not make any changes.
1266# 0-3 = Set AMPDU density (aka factor) to specified value.
1267
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001268# disable_vht: Whether VHT should be disabled.
1269# 0 = VHT enabled (if AP supports it)
1270# 1 = VHT disabled
1271#
1272# vht_capa: VHT capabilities to set in the override
1273# vht_capa_mask: mask of VHT capabilities
1274#
1275# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1276# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1277# 0: MCS 0-7
1278# 1: MCS 0-8
1279# 2: MCS 0-9
1280# 3: not supported
1281
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001282##### Fast Session Transfer (FST) support #####################################
1283#
1284# The options in this section are only available when the build configuration
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001285# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1286# interface to be a part of FST setup.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001287#
1288# FST is the transfer of a session from a channel to another channel, in the
1289# same or different frequency bands.
1290#
Dmitry Shmidtaca489e2016-09-28 15:44:14 -07001291# For details, see IEEE Std 802.11ad-2012.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001292
1293# Identifier of an FST Group the interface belongs to.
1294#fst_group_id=bond0
1295
1296# Interface priority within the FST Group.
1297# Announcing a higher priority for an interface means declaring it more
1298# preferable for FST switch.
1299# fst_priority is in 1..255 range with 1 being the lowest priority.
1300#fst_priority=100
1301
1302# Default LLT value for this interface in milliseconds. The value used in case
1303# no value provided during session setup. Default is 50 msec.
1304# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1305# Transitioning between states).
1306#fst_llt=100
1307
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001308# Example blocks:
1309
1310# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1311network={
1312 ssid="simple"
1313 psk="very secret passphrase"
1314 priority=5
1315}
1316
1317# Same as previous, but request SSID-specific scanning (for APs that reject
1318# broadcast SSID)
1319network={
1320 ssid="second ssid"
1321 scan_ssid=1
1322 psk="very secret passphrase"
1323 priority=2
1324}
1325
1326# Only WPA-PSK is used. Any valid cipher combination is accepted.
1327network={
1328 ssid="example"
1329 proto=WPA
1330 key_mgmt=WPA-PSK
1331 pairwise=CCMP TKIP
1332 group=CCMP TKIP WEP104 WEP40
1333 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1334 priority=2
1335}
1336
1337# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1338network={
1339 ssid="example"
1340 proto=WPA
1341 key_mgmt=WPA-PSK
1342 pairwise=TKIP
1343 group=TKIP
1344 psk="not so secure passphrase"
1345 wpa_ptk_rekey=600
1346}
1347
1348# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1349# or WEP40 as the group cipher will not be accepted.
1350network={
1351 ssid="example"
1352 proto=RSN
1353 key_mgmt=WPA-EAP
1354 pairwise=CCMP TKIP
1355 group=CCMP TKIP
1356 eap=TLS
1357 identity="user@example.com"
1358 ca_cert="/etc/cert/ca.pem"
1359 client_cert="/etc/cert/user.pem"
1360 private_key="/etc/cert/user.prv"
1361 private_key_passwd="password"
1362 priority=1
1363}
1364
1365# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1366# (e.g., Radiator)
1367network={
1368 ssid="example"
1369 key_mgmt=WPA-EAP
1370 eap=PEAP
1371 identity="user@example.com"
1372 password="foobar"
1373 ca_cert="/etc/cert/ca.pem"
1374 phase1="peaplabel=1"
1375 phase2="auth=MSCHAPV2"
1376 priority=10
1377}
1378
1379# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1380# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1381network={
1382 ssid="example"
1383 key_mgmt=WPA-EAP
1384 eap=TTLS
1385 identity="user@example.com"
1386 anonymous_identity="anonymous@example.com"
1387 password="foobar"
1388 ca_cert="/etc/cert/ca.pem"
1389 priority=2
1390}
1391
1392# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1393# use. Real identity is sent only within an encrypted TLS tunnel.
1394network={
1395 ssid="example"
1396 key_mgmt=WPA-EAP
1397 eap=TTLS
1398 identity="user@example.com"
1399 anonymous_identity="anonymous@example.com"
1400 password="foobar"
1401 ca_cert="/etc/cert/ca.pem"
1402 phase2="auth=MSCHAPV2"
1403}
1404
1405# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1406# authentication.
1407network={
1408 ssid="example"
1409 key_mgmt=WPA-EAP
1410 eap=TTLS
1411 # Phase1 / outer authentication
1412 anonymous_identity="anonymous@example.com"
1413 ca_cert="/etc/cert/ca.pem"
1414 # Phase 2 / inner authentication
1415 phase2="autheap=TLS"
1416 ca_cert2="/etc/cert/ca2.pem"
1417 client_cert2="/etc/cer/user.pem"
1418 private_key2="/etc/cer/user.prv"
1419 private_key2_passwd="password"
1420 priority=2
1421}
1422
1423# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1424# group cipher.
1425network={
1426 ssid="example"
1427 bssid=00:11:22:33:44:55
1428 proto=WPA RSN
1429 key_mgmt=WPA-PSK WPA-EAP
1430 pairwise=CCMP
1431 group=CCMP
1432 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1433}
1434
1435# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1436# and all valid ciphers.
1437network={
1438 ssid=00010203
1439 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1440}
1441
1442
1443# EAP-SIM with a GSM SIM or USIM
1444network={
1445 ssid="eap-sim-test"
1446 key_mgmt=WPA-EAP
1447 eap=SIM
1448 pin="1234"
1449 pcsc=""
1450}
1451
1452
1453# EAP-PSK
1454network={
1455 ssid="eap-psk-test"
1456 key_mgmt=WPA-EAP
1457 eap=PSK
1458 anonymous_identity="eap_psk_user"
1459 password=06b4be19da289f475aa46a33cb793029
1460 identity="eap_psk_user@example.com"
1461}
1462
1463
1464# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1465# EAP-TLS for authentication and key generation; require both unicast and
1466# broadcast WEP keys.
1467network={
1468 ssid="1x-test"
1469 key_mgmt=IEEE8021X
1470 eap=TLS
1471 identity="user@example.com"
1472 ca_cert="/etc/cert/ca.pem"
1473 client_cert="/etc/cert/user.pem"
1474 private_key="/etc/cert/user.prv"
1475 private_key_passwd="password"
1476 eapol_flags=3
1477}
1478
1479
1480# LEAP with dynamic WEP keys
1481network={
1482 ssid="leap-example"
1483 key_mgmt=IEEE8021X
1484 eap=LEAP
1485 identity="user"
1486 password="foobar"
1487}
1488
1489# EAP-IKEv2 using shared secrets for both server and peer authentication
1490network={
1491 ssid="ikev2-example"
1492 key_mgmt=WPA-EAP
1493 eap=IKEV2
1494 identity="user"
1495 password="foobar"
1496}
1497
1498# EAP-FAST with WPA (WPA or WPA2)
1499network={
1500 ssid="eap-fast-test"
1501 key_mgmt=WPA-EAP
1502 eap=FAST
1503 anonymous_identity="FAST-000102030405"
1504 identity="username"
1505 password="password"
1506 phase1="fast_provisioning=1"
1507 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1508}
1509
1510network={
1511 ssid="eap-fast-test"
1512 key_mgmt=WPA-EAP
1513 eap=FAST
1514 anonymous_identity="FAST-000102030405"
1515 identity="username"
1516 password="password"
1517 phase1="fast_provisioning=1"
1518 pac_file="blob://eap-fast-pac"
1519}
1520
1521# Plaintext connection (no WPA, no IEEE 802.1X)
1522network={
1523 ssid="plaintext-test"
1524 key_mgmt=NONE
1525}
1526
1527
1528# Shared WEP key connection (no WPA, no IEEE 802.1X)
1529network={
1530 ssid="static-wep-test"
1531 key_mgmt=NONE
1532 wep_key0="abcde"
1533 wep_key1=0102030405
1534 wep_key2="1234567890123"
1535 wep_tx_keyidx=0
1536 priority=5
1537}
1538
1539
1540# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1541# IEEE 802.11 authentication
1542network={
1543 ssid="static-wep-test2"
1544 key_mgmt=NONE
1545 wep_key0="abcde"
1546 wep_key1=0102030405
1547 wep_key2="1234567890123"
1548 wep_tx_keyidx=0
1549 priority=5
1550 auth_alg=SHARED
1551}
1552
1553
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001554# IBSS/ad-hoc network with RSN
1555network={
1556 ssid="ibss-rsn"
1557 key_mgmt=WPA-PSK
1558 proto=RSN
1559 psk="12345678"
1560 mode=1
1561 frequency=2412
1562 pairwise=CCMP
1563 group=CCMP
1564}
1565
1566# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001567network={
1568 ssid="test adhoc"
1569 mode=1
1570 frequency=2412
1571 proto=WPA
1572 key_mgmt=WPA-NONE
1573 pairwise=NONE
1574 group=TKIP
1575 psk="secret passphrase"
1576}
1577
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001578# open mesh network
1579network={
1580 ssid="test mesh"
1581 mode=5
1582 frequency=2437
1583 key_mgmt=NONE
1584}
1585
1586# secure (SAE + AMPE) network
1587network={
1588 ssid="secure mesh"
1589 mode=5
1590 frequency=2437
1591 key_mgmt=SAE
1592 psk="very secret passphrase"
1593}
1594
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001595
1596# Catch all example that allows more or less all configuration modes
1597network={
1598 ssid="example"
1599 scan_ssid=1
1600 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1601 pairwise=CCMP TKIP
1602 group=CCMP TKIP WEP104 WEP40
1603 psk="very secret passphrase"
1604 eap=TTLS PEAP TLS
1605 identity="user@example.com"
1606 password="foobar"
1607 ca_cert="/etc/cert/ca.pem"
1608 client_cert="/etc/cert/user.pem"
1609 private_key="/etc/cert/user.prv"
1610 private_key_passwd="password"
1611 phase1="peaplabel=0"
1612}
1613
1614# Example of EAP-TLS with smartcard (openssl engine)
1615network={
1616 ssid="example"
1617 key_mgmt=WPA-EAP
1618 eap=TLS
1619 proto=RSN
1620 pairwise=CCMP TKIP
1621 group=CCMP TKIP
1622 identity="user@example.com"
1623 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001624
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001625 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1626 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1627 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001628
1629 # Optional PIN configuration; this can be left out and PIN will be
1630 # asked through the control interface
1631 pin="1234"
1632}
1633
1634# Example configuration showing how to use an inlined blob as a CA certificate
1635# data instead of using external file
1636network={
1637 ssid="example"
1638 key_mgmt=WPA-EAP
1639 eap=TTLS
1640 identity="user@example.com"
1641 anonymous_identity="anonymous@example.com"
1642 password="foobar"
1643 ca_cert="blob://exampleblob"
1644 priority=20
1645}
1646
1647blob-base64-exampleblob={
1648SGVsbG8gV29ybGQhCg==
1649}
1650
1651
1652# Wildcard match for SSID (plaintext APs only). This example select any
1653# open AP regardless of its SSID.
1654network={
1655 key_mgmt=NONE
1656}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001657
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001658# Example configuration blacklisting two APs - these will be ignored
1659# for this network.
1660network={
1661 ssid="example"
1662 psk="very secret passphrase"
1663 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1664}
1665
1666# Example configuration limiting AP selection to a specific set of APs;
1667# any other AP not matching the masked address will be ignored.
1668network={
1669 ssid="example"
1670 psk="very secret passphrase"
1671 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
1672}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001673
1674# Example config file that will only scan on channel 36.
1675freq_list=5180
1676network={
1677 key_mgmt=NONE
1678}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001679
1680
1681# Example MACsec configuration
1682#network={
1683# key_mgmt=IEEE8021X
1684# eap=TTLS
1685# phase2="auth=PAP"
1686# anonymous_identity="anonymous@example.com"
1687# identity="user@example.com"
1688# password="secretr"
1689# ca_cert="/etc/cert/ca.pem"
1690# eapol_flags=0
1691# macsec_policy=1
1692#}