blob: 6ece942d921830e7e16bed850c69c34067c5ada3 [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
203# This field can be used to configure arbitrary driver interace parameters. The
204# 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 Shmidt04949592012-07-19 12:16:46 -0700452# credential block
453#
454# Each credential used for automatic network selection is configured as a set
455# of parameters that are compared to the information advertised by the APs when
456# interworking_select and interworking_connect commands are used.
457#
458# credential fields:
459#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800460# temporary: Whether this credential is temporary and not to be saved
461#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700462# priority: Priority group
463# By default, all networks and credentials get the same priority group
464# (0). This field can be used to give higher priority for credentials
465# (and similarly in struct wpa_ssid for network blocks) to change the
466# Interworking automatic networking selection behavior. The matching
467# network (based on either an enabled network block or a credential)
468# with the highest priority value will be selected.
469#
470# pcsc: Use PC/SC and SIM/USIM card
471#
472# realm: Home Realm for Interworking
473#
474# username: Username for Interworking network selection
475#
476# password: Password for Interworking network selection
477#
478# ca_cert: CA certificate for Interworking network selection
479#
480# client_cert: File path to client certificate file (PEM/DER)
481# This field is used with Interworking networking selection for a case
482# where client certificate/private key is used for authentication
483# (EAP-TLS). Full path to the file should be used since working
484# directory may change when wpa_supplicant is run in the background.
485#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700486# Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
487#
488# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
489#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700490# Alternatively, a named configuration blob can be used by setting
491# this to blob://blob_name.
492#
493# private_key: File path to client private key file (PEM/DER/PFX)
494# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
495# commented out. Both the private key and certificate will be read
496# from the PKCS#12 file in this case. Full path to the file should be
497# used since working directory may change when wpa_supplicant is run
498# in the background.
499#
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -0700500# Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
501# For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
502#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700503# Windows certificate store can be used by leaving client_cert out and
504# configuring private_key in one of the following formats:
505#
506# cert://substring_to_match
507#
508# hash://certificate_thumbprint_in_hex
509#
510# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
511#
512# Note that when running wpa_supplicant as an application, the user
513# certificate store (My user account) is used, whereas computer store
514# (Computer account) is used when running wpasvc as a service.
515#
516# Alternatively, a named configuration blob can be used by setting
517# this to blob://blob_name.
518#
519# private_key_passwd: Password for private key file
520#
521# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
522#
523# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
524# format
525#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700526# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700527# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700528# whether the AP is operated by the Home SP. Multiple domain entries can
529# be used to configure alternative FQDNs that will be considered home
530# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700531#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700532# roaming_consortium: Roaming Consortium OI
533# If roaming_consortium_len is non-zero, this field contains the
534# Roaming Consortium OI that can be used to determine which access
535# points support authentication with this credential. This is an
536# alternative to the use of the realm parameter. When using Roaming
537# Consortium to match the network, the EAP parameters need to be
538# pre-configured with the credential since the NAI Realm information
539# may not be available or fetched.
540#
541# eap: Pre-configured EAP method
542# This optional field can be used to specify which EAP method will be
543# used with this credential. If not set, the EAP method is selected
544# automatically based on ANQP information (e.g., NAI Realm).
545#
546# phase1: Pre-configure Phase 1 (outer authentication) parameters
547# This optional field is used with like the 'eap' parameter.
548#
549# phase2: Pre-configure Phase 2 (inner authentication) parameters
550# This optional field is used with like the 'eap' parameter.
551#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800552# excluded_ssid: Excluded SSID
553# This optional field can be used to excluded specific SSID(s) from
554# matching with the network. Multiple entries can be used to specify more
555# than one SSID.
556#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800557# roaming_partner: Roaming partner information
558# This optional field can be used to configure preferences between roaming
559# partners. The field is a string in following format:
560# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
561# (non-exact match means any subdomain matches the entry; priority is in
562# 0..255 range with 0 being the highest priority)
563#
564# update_identifier: PPS MO ID
565# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
566#
567# provisioning_sp: FQDN of the SP that provisioned the credential
568# This optional field can be used to keep track of the SP that provisioned
569# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
570#
571# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
572# These fields can be used to specify minimum download/upload backhaul
573# bandwidth that is preferred for the credential. This constraint is
574# ignored if the AP does not advertise WAN Metrics information or if the
575# limit would prevent any connection. Values are in kilobits per second.
576# min_dl_bandwidth_home
577# min_ul_bandwidth_home
578# min_dl_bandwidth_roaming
579# min_ul_bandwidth_roaming
580#
581# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
582# (PPS/<X+>/Policy/MaximumBSSLoadValue)
583# This value is used as the maximum channel utilization for network
584# selection purposes for home networks. If the AP does not advertise
585# BSS Load or if the limit would prevent any connection, this constraint
586# will be ignored.
587#
588# req_conn_capab: Required connection capability
589# (PPS/<X+>/Policy/RequiredProtoPortTuple)
590# This value is used to configure set of required protocol/port pairs that
591# a roaming network shall support (include explicitly in Connection
592# Capability ANQP element). This constraint is ignored if the AP does not
593# advertise Connection Capability or if this constraint would prevent any
594# network connection. This policy is not used in home networks.
595# Format: <protocol>[:<comma-separated list of ports]
596# Multiple entries can be used to list multiple requirements.
597# For example, number of common TCP protocols:
598# req_conn_capab=6,22,80,443
599# For example, IPSec/IKE:
600# req_conn_capab=17:500
601# req_conn_capab=50
602#
603# ocsp: Whether to use/require OCSP to check server certificate
604# 0 = do not use OCSP stapling (TLS certificate status extension)
605# 1 = try to use OCSP stapling, but not require response
606# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800607# 3 = require valid OCSP stapling response for all not-trusted
608# certificates in the server certificate chain
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800609#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700610# sim_num: Identifier for which SIM to use in multi-SIM devices
611#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700612# for example:
613#
614#cred={
615# realm="example.com"
616# username="user@example.com"
617# password="password"
618# ca_cert="/etc/wpa_supplicant/ca.pem"
619# domain="example.com"
620#}
621#
622#cred={
623# imsi="310026-000000000"
624# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
625#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700626#
627#cred={
628# realm="example.com"
629# username="user"
630# password="password"
631# ca_cert="/etc/wpa_supplicant/ca.pem"
632# domain="example.com"
633# roaming_consortium=223344
634# eap=TTLS
635# phase2="auth=MSCHAPV2"
636#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800637
Dmitry Shmidt04949592012-07-19 12:16:46 -0700638# Hotspot 2.0
639# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800640
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800641# Scheduled scan plans
642#
643# A space delimited list of scan plans. Each scan plan specifies the scan
644# interval and number of iterations, delimited by a colon. The last scan plan
645# will run infinitely and thus must specify only the interval and not the number
646# of iterations.
647#
648# The driver advertises the maximum number of scan plans supported. If more scan
649# plans than supported are configured, only the first ones are set (up to the
650# maximum supported). The last scan plan that specifies only the interval is
651# always set as the last plan.
652#
653# If the scan interval or the number of iterations for a scan plan exceeds the
654# maximum supported, it will be set to the maximum supported value.
655#
656# Format:
657# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
658#
659# Example:
660# sched_scan_plans=10:100 20:200 30
661
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800662# Multi Band Operation (MBO) non-preferred channels
663# A space delimited list of non-preferred channels where each channel is a colon
664# delimited list of values. Reason detail is optional.
665# Format:
666# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>[:reason_detail]
667# Example:
668# non_pref_chan="81:5:10:2:0 81:1:0:2:0 81:9:0:2"
669
670# MBO Cellular Data Capabilities
671# 1 = Cellular data connection available
672# 2 = Cellular data connection not available
673# 3 = Not cellular capable (default)
674#mbo_cell_capa=3
675
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800676# network block
677#
678# Each network (usually AP's sharing the same SSID) is configured as a separate
679# block in this configuration file. The network blocks are in preference order
680# (the first match is used).
681#
682# network block fields:
683#
684# disabled:
685# 0 = this network can be used (default)
686# 1 = this network block is disabled (can be enabled through ctrl_iface,
687# e.g., with wpa_cli or wpa_gui)
688#
689# id_str: Network identifier string for external scripts. This value is passed
690# to external action script through wpa_cli as WPA_ID_STR environment
691# variable to make it easier to do network specific configuration.
692#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700693# ssid: SSID (mandatory); network name in one of the optional formats:
694# - an ASCII string with double quotation
695# - a hex string (two characters per octet of SSID)
696# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800697#
698# scan_ssid:
699# 0 = do not scan this SSID with specific Probe Request frames (default)
700# 1 = scan with SSID-specific Probe Request frames (this can be used to
701# find APs that do not accept broadcast SSID or use multiple SSIDs;
702# this will add latency to scanning, so enable this only when needed)
703#
704# bssid: BSSID (optional); if set, this network block is used only when
705# associating with the AP using the configured BSSID
706#
707# priority: priority group (integer)
708# By default, all networks will get same priority group (0). If some of the
709# networks are more desirable, this field can be used to change the order in
710# which wpa_supplicant goes through the networks when selecting a BSS. The
711# priority groups will be iterated in decreasing priority (i.e., the larger the
712# priority value, the sooner the network is matched against the scan results).
713# Within each priority group, networks will be selected based on security
714# policy, signal strength, etc.
715# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
716# using this priority to select the order for scanning. Instead, they try the
717# networks in the order that used in the configuration file.
718#
719# mode: IEEE 802.11 operation mode
720# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
721# 1 = IBSS (ad-hoc, peer-to-peer)
722# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800723# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
724# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
725# TKIP/CCMP) is available for backwards compatibility, but its use is
726# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800727# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
728# both), and psk must also be set.
729#
730# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
731# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
732# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
733# In addition, this value is only used by the station that creates the IBSS. If
734# an IBSS network with the configured SSID is already present, the frequency of
735# the network will be used instead of this configured value.
736#
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800737# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700738# 0 = do not use PBSS
739# 1 = use PBSS
740# 2 = don't care (not allowed in AP mode)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800741# Used together with mode configuration. When mode is AP, it means to start a
742# PCP instead of a regular AP. When mode is infrastructure it means connect
Dmitry Shmidt849734c2016-05-27 09:59:01 -0700743# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
744# which means connect to either PCP or AP.
745# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800746# For more details, see IEEE Std 802.11ad-2012.
747#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800748# scan_freq: List of frequencies to scan
749# Space-separated list of frequencies in MHz to scan when searching for this
750# BSS. If the subset of channels used by the network is known, this option can
751# be used to optimize scanning to not occur on channels that the network does
752# not use. Example: scan_freq=2412 2437 2462
753#
754# freq_list: Array of allowed frequencies
755# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
756# set, scan results that do not match any of the specified frequencies are not
757# considered when selecting a BSS.
758#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700759# This can also be set on the outside of the network block. In this case,
760# it limits the frequencies that will be scanned.
761#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800762# bgscan: Background scanning
763# wpa_supplicant behavior for background scanning can be specified by
764# configuring a bgscan module. These modules are responsible for requesting
765# background scans for the purpose of roaming within an ESS (i.e., within a
766# single network block with all the APs using the same SSID). The bgscan
767# parameter uses following format: "<bgscan module name>:<module parameters>"
768# Following bgscan modules are available:
769# simple - Periodic background scans based on signal strength
770# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
771# <long interval>"
772# bgscan="simple:30:-45:300"
773# learn - Learn channels used by the network and try to avoid bgscans on other
774# channels (experimental)
775# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
776# <long interval>[:<database file name>]"
777# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800778# Explicitly disable bgscan by setting
779# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800780#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800781# This option can also be set outside of all network blocks for the bgscan
782# parameter to apply for all the networks that have no specific bgscan
783# parameter.
784#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800785# proto: list of accepted protocols
786# WPA = WPA/IEEE 802.11i/D3.0
787# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
788# If not set, this defaults to: WPA RSN
789#
790# key_mgmt: list of accepted authenticated key management protocols
791# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
792# WPA-EAP = WPA using EAP authentication
793# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
794# generated WEP keys
795# NONE = WPA is not used; plaintext or static WEP could be used
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800796# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
797# instead)
798# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
799# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800800# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
801# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -0800802# SAE = Simultaneous authentication of equals; pre-shared key/password -based
803# authentication with stronger security than WPA-PSK especially when using
804# not that strong password
805# FT-SAE = SAE with FT
806# WPA-EAP-SUITE-B = Suite B 128-bit level
807# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
Dmitry Shmidtde47be72016-01-07 12:52:55 -0800808# OSEN = Hotspot 2.0 Rel 2 online signup connection
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800809# If not set, this defaults to: WPA-PSK WPA-EAP
810#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700811# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800812# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700813# 1 = optional
814# 2 = required
815# The most common configuration options for this based on the PMF (protected
816# management frames) certification program are:
817# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
818# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
819# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
820#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800821# auth_alg: list of allowed IEEE 802.11 authentication algorithms
822# OPEN = Open System authentication (required for WPA/WPA2)
823# SHARED = Shared Key authentication (requires static WEP keys)
824# LEAP = LEAP/Network EAP (only used with LEAP)
825# If not set, automatic selection is used (Open System with LEAP enabled if
826# LEAP is allowed as one of the EAP methods).
827#
828# pairwise: list of accepted pairwise (unicast) ciphers for WPA
829# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
830# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
831# NONE = Use only Group Keys (deprecated, should not be included if APs support
832# pairwise keys)
833# If not set, this defaults to: CCMP TKIP
834#
835# group: list of accepted group (broadcast/multicast) ciphers for WPA
836# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
837# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
838# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
839# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
840# If not set, this defaults to: CCMP TKIP WEP104 WEP40
841#
842# psk: WPA preshared key; 256-bit pre-shared key
843# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
844# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
845# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700846# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
847# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800848# This field is not needed, if WPA-EAP is used.
849# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
850# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
851# startup and reconfiguration time can be optimized by generating the PSK only
852# only when the passphrase or SSID has actually changed.
853#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -0700854# mem_only_psk: Whether to keep PSK/passphrase only in memory
855# 0 = allow psk/passphrase to be stored to the configuration file
856# 1 = do not store psk/passphrase to the configuration file
857#mem_only_psk=0
858#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800859# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
860# Dynamic WEP key required for non-WPA mode
861# bit0 (1): require dynamically generated unicast WEP key
862# bit1 (2): require dynamically generated broadcast WEP key
863# (3 = require both keys; default)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700864# Note: When using wired authentication (including macsec_qca driver),
865# eapol_flags must be set to 0 for the authentication to be completed
866# successfully.
867#
868# macsec_policy: IEEE 802.1X/MACsec options
869# This determines how sessions are secured with MACsec. It is currently
870# applicable only when using the macsec_qca driver interface.
871# 0: MACsec not in use (default)
872# 1: MACsec enabled - Should secure, accept key server's advice to
873# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800874#
875# mixed_cell: This option can be used to configure whether so called mixed
876# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800877# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800878# 0 = disabled (default)
879# 1 = enabled
880#
881# proactive_key_caching:
882# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800883# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800884# 1 = enabled
885#
886# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
887# hex without quotation, e.g., 0102030405)
888# wep_tx_keyidx: Default WEP key index (TX) (0..3)
889#
890# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
891# allowed. This is only used with RSN/WPA2.
892# 0 = disabled (default)
893# 1 = enabled
894#peerkey=1
895#
896# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
897# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
898#
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -0700899# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
900# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
901# Authenticator role in IBSS.
902#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800903# Following fields are only used with internal EAP implementation.
904# eap: space-separated list of accepted EAP methods
905# MD5 = EAP-MD5 (unsecure and does not generate keying material ->
906# cannot be used with WPA; to be used as a Phase 2 method
907# with EAP-PEAP or EAP-TTLS)
908# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
909# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
910# OTP = EAP-OTP (cannot be used separately with WPA; to be used
911# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
912# GTC = EAP-GTC (cannot be used separately with WPA; to be used
913# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
914# TLS = EAP-TLS (client and server certificate)
915# PEAP = EAP-PEAP (with tunnelled EAP authentication)
916# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
917# authentication)
918# If not set, all compiled in methods are allowed.
919#
920# identity: Identity string for EAP
921# This field is also used to configure user NAI for
922# EAP-PSK/PAX/SAKE/GPSK.
923# anonymous_identity: Anonymous identity string for EAP (to be used as the
924# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700925# identity, e.g., EAP-TTLS). This field can also be used with
926# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800927# password: Password string for EAP. This field can include either the
928# plaintext password (using ASCII or hex string) or a NtPasswordHash
929# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
930# NtPasswordHash can only be used when the password is for MSCHAPv2 or
931# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
932# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
933# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700934# variable length PSK. ext:<name of external password field> format can
935# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800936# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
937# or more trusted CA certificates. If ca_cert and ca_path are not
938# included, server certificate will not be verified. This is insecure and
939# a trusted CA certificate should always be configured when using
940# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
941# change when wpa_supplicant is run in the background.
942#
943# Alternatively, this can be used to only perform matching of the server
944# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
945# this case, the possible CA certificates in the server certificate chain
946# are ignored and only the server certificate is verified. This is
947# configured with the following format:
948# hash:://server/sha256/cert_hash_in_hex
949# For example: "hash://server/sha256/
950# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
951#
952# On Windows, trusted CA certificates can be loaded from the system
953# certificate store by setting this to cert_store://<name>, e.g.,
954# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
955# Note that when running wpa_supplicant as an application, the user
956# certificate store (My user account) is used, whereas computer store
957# (Computer account) is used when running wpasvc as a service.
958# ca_path: Directory path for CA certificate files (PEM). This path may
959# contain multiple CA certificates in OpenSSL format. Common use for this
960# is to point to system trusted CA list which is often installed into
961# directory like /etc/ssl/certs. If configured, these certificates are
962# added to the list of trusted CAs. ca_cert may also be included in that
963# case, but it is not required.
964# client_cert: File path to client certificate file (PEM/DER)
965# Full path should be used since working directory may change when
966# wpa_supplicant is run in the background.
967# Alternatively, a named configuration blob can be used by setting this
968# to blob://<blob name>.
969# private_key: File path to client private key file (PEM/DER/PFX)
970# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
971# commented out. Both the private key and certificate will be read from
972# the PKCS#12 file in this case. Full path should be used since working
973# directory may change when wpa_supplicant is run in the background.
974# Windows certificate store can be used by leaving client_cert out and
975# configuring private_key in one of the following formats:
976# cert://substring_to_match
977# hash://certificate_thumbprint_in_hex
978# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
979# Note that when running wpa_supplicant as an application, the user
980# certificate store (My user account) is used, whereas computer store
981# (Computer account) is used when running wpasvc as a service.
982# Alternatively, a named configuration blob can be used by setting this
983# to blob://<blob name>.
984# private_key_passwd: Password for private key file (if left out, this will be
985# asked through control interface)
986# dh_file: File path to DH/DSA parameters file (in PEM format)
987# This is an optional configuration file for setting parameters for an
988# ephemeral DH key exchange. In most cases, the default RSA
989# authentication does not use this configuration. However, it is possible
990# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
991# DSA keys always use ephemeral DH keys. This can be used to achieve
992# forward secrecy. If the file is in DSA parameters format, it will be
993# automatically converted into DH params.
994# subject_match: Substring to be matched against the subject of the
995# authentication server certificate. If this string is set, the server
996# sertificate is only accepted if it contains this string in the subject.
997# The subject string is in following format:
998# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtff787d52015-01-12 13:01:47 -0800999# Note: Since this is a substring match, this cannot be used securily to
1000# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001001# such a use case, domain_suffix_match or domain_match should be used
1002# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001003# altsubject_match: Semicolon separated string of entries to be matched against
1004# the alternative subject name of the authentication server certificate.
1005# If this string is set, the server sertificate is only accepted if it
1006# contains one of the entries in an alternative subject name extension.
1007# altSubjectName string is in following format: TYPE:VALUE
1008# Example: EMAIL:server@example.com
1009# Example: DNS:server.example.com;DNS:server2.example.com
1010# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001011# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
1012# used as a suffix match requirement for the AAAserver certificate in
1013# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1014# constraint is met. If no dNSName values are present, this constraint is
1015# matched against SubjectName CN using same suffix match comparison.
1016#
1017# Suffix match here means that the host/domain name is compared one label
1018# at a time starting from the top-level domain and all the labels in
1019# domain_suffix_match shall be included in the certificate. The
1020# certificate may include additional sub-level labels in addition to the
1021# required labels.
1022#
1023# For example, domain_suffix_match=example.com would match
1024# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001025# domain_match: Constraint for server domain name
1026# If set, this FQDN is used as a full match requirement for the
1027# server certificate in SubjectAltName dNSName element(s). If a
1028# matching dNSName is found, this constraint is met. If no dNSName
1029# values are present, this constraint is matched against SubjectName CN
1030# using same full match comparison. This behavior is similar to
1031# domain_suffix_match, but has the requirement of a full match, i.e.,
1032# no subdomains or wildcard matches are allowed. Case-insensitive
1033# comparison is used, so "Example.com" matches "example.com", but would
1034# not match "test.Example.com".
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001035# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1036# (string with field-value pairs, e.g., "peapver=0" or
1037# "peapver=1 peaplabel=1")
1038# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1039# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1040# to be used during key derivation when PEAPv1 or newer. Most existing
1041# PEAPv1 implementation seem to be using the old label, "client EAP
1042# encryption", and wpa_supplicant is now using that as the default value.
1043# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1044# interoperate with PEAPv1; see eap_testing.txt for more details.
1045# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1046# tunneled EAP-Success. This is required with some RADIUS servers that
1047# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1048# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1049# include_tls_length=1 can be used to force wpa_supplicant to include
1050# TLS Message Length field in all TLS messages even if they are not
1051# fragmented.
1052# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1053# challenges (by default, it accepts 2 or 3)
1054# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1055# protected result indication.
1056# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1057# behavior:
1058# * 0 = do not use cryptobinding (default)
1059# * 1 = use cryptobinding if server supports it
1060# * 2 = require cryptobinding
1061# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1062# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001063#
1064# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1065# used to configure a mode that allows EAP-Success (and EAP-Failure)
1066# without going through authentication step. Some switches use such
1067# sequence when forcing the port to be authorized/unauthorized or as a
1068# fallback option if the authentication server is unreachable. By default,
1069# wpa_supplicant discards such frames to protect against potential attacks
1070# by rogue devices, but this option can be used to disable that protection
1071# for cases where the server/authenticator does not need to be
1072# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001073# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1074# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -08001075# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1076# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001077#
1078# TLS-based methods can use the following parameters to control TLS behavior
1079# (these are normally in the phase1 parameter, but can be used also in the
1080# phase2 parameter when EAP-TLS is used within the inner tunnel):
1081# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1082# TLS library, these may be disabled by default to enforce stronger
1083# security)
1084# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1085# the TLS library to accept certificates even if they are not currently
1086# valid, i.e., have expired or have not yet become valid; this should be
1087# used only for testing purposes)
1088# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1089# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1090# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1091# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -07001092# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001093# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1094# default value to be used automatically).
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001095# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -08001096# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1097# that have issues interoperating with updated TLS version)
1098# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1099# that have issues interoperating with updated TLS version)
Dmitry Shmidt55840ad2015-12-14 12:45:46 -08001100# tls_ext_cert_check=0 - No external server certificate validation (default)
1101# tls_ext_cert_check=1 - External server certificate validation enabled; this
1102# requires an external program doing validation of server certificate
1103# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1104# interface and report the result of the validation with
1105# CTRL-RSP_EXT_CERT_CHECK.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001106#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001107# Following certificate/private key fields are used in inner Phase2
1108# authentication when using EAP-TTLS or EAP-PEAP.
1109# ca_cert2: File path to CA certificate file. This file can have one or more
1110# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1111# server certificate will not be verified. This is insecure and a trusted
1112# CA certificate should always be configured.
1113# ca_path2: Directory path for CA certificate files (PEM)
1114# client_cert2: File path to client certificate file
1115# private_key2: File path to client private key file
1116# private_key2_passwd: Password for private key file
1117# dh_file2: File path to DH/DSA parameters file (in PEM format)
1118# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001119# authentication server certificate. See subject_match for more details.
1120# altsubject_match2: Semicolon separated string of entries to be matched
1121# against the alternative subject name of the authentication server
1122# certificate. See altsubject_match documentation for more details.
1123# domain_suffix_match2: Constraint for server domain name. See
1124# domain_suffix_match for more details.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001125#
1126# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1127# This value limits the fragment size for EAP methods that support
1128# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1129# small enough to make the EAP messages fit in MTU of the network
1130# interface used for EAPOL. The default value is suitable for most
1131# cases.
1132#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001133# ocsp: Whether to use/require OCSP to check server certificate
1134# 0 = do not use OCSP stapling (TLS certificate status extension)
1135# 1 = try to use OCSP stapling, but not require response
1136# 2 = require valid OCSP stapling response
Dmitry Shmidt014a3ff2015-12-28 13:27:49 -08001137# 3 = require valid OCSP stapling response for all not-trusted
1138# certificates in the server certificate chain
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001139#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001140# openssl_ciphers: OpenSSL specific cipher configuration
1141# This can be used to override the global openssl_ciphers configuration
1142# parameter (see above).
1143#
1144# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1145#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001146# EAP-FAST variables:
1147# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1148# to create this file and write updates to it when PAC is being
1149# provisioned or refreshed. Full path to the file should be used since
1150# working directory may change when wpa_supplicant is run in the
1151# background. Alternatively, a named configuration blob can be used by
1152# setting this to blob://<blob name>
1153# phase1: fast_provisioning option can be used to enable in-line provisioning
1154# of EAP-FAST credentials (PAC):
1155# 0 = disabled,
1156# 1 = allow unauthenticated provisioning,
1157# 2 = allow authenticated provisioning,
1158# 3 = allow both unauthenticated and authenticated provisioning
1159# fast_max_pac_list_len=<num> option can be used to set the maximum
1160# number of PAC entries to store in a PAC list (default: 10)
1161# fast_pac_format=binary option can be used to select binary format for
1162# storing PAC entries in order to save some space (the default
1163# text format uses about 2.5 times the size of minimal binary
1164# format)
1165#
1166# wpa_supplicant supports number of "EAP workarounds" to work around
1167# interoperability issues with incorrectly behaving authentication servers.
1168# These are enabled by default because some of the issues are present in large
1169# number of authentication servers. Strict EAP conformance mode can be
1170# configured by disabling workarounds with eap_workaround=0.
1171
Dmitry Shmidtde47be72016-01-07 12:52:55 -08001172# update_identifier: PPS MO ID
1173# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1174
Dmitry Shmidt04949592012-07-19 12:16:46 -07001175# Station inactivity limit
1176#
1177# If a station does not send anything in ap_max_inactivity seconds, an
1178# empty data frame is sent to it in order to verify whether it is
1179# still in range. If this frame is not ACKed, the station will be
1180# disassociated and then deauthenticated. This feature is used to
1181# clear station table of old entries when the STAs move out of the
1182# range.
1183#
1184# The station can associate again with the AP if it is still in range;
1185# this inactivity poll is just used as a nicer way of verifying
1186# inactivity; i.e., client will not report broken connection because
1187# disassociation frame is not sent immediately without first polling
1188# the STA with a data frame.
1189# default: 300 (i.e., 5 minutes)
1190#ap_max_inactivity=300
1191
1192# DTIM period in Beacon intervals for AP mode (default: 2)
1193#dtim_period=2
1194
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001195# Beacon interval (default: 100 TU)
1196#beacon_int=100
1197
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001198# WPS in AP mode
1199# 0 = WPS enabled and configured (default)
1200# 1 = WPS disabled
1201#wps_disabled=0
1202
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001203# MAC address policy
1204# 0 = use permanent MAC address
1205# 1 = use random MAC address for each ESS connection
1206# 2 = like 1, but maintain OUI (with local admin bit set)
1207#mac_addr=0
1208
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001209# disable_ht: Whether HT (802.11n) should be disabled.
1210# 0 = HT enabled (if AP supports it)
1211# 1 = HT disabled
1212#
1213# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1214# 0 = HT-40 enabled (if AP supports it)
1215# 1 = HT-40 disabled
1216#
1217# disable_sgi: Whether SGI (short guard interval) should be disabled.
1218# 0 = SGI enabled (if AP supports it)
1219# 1 = SGI disabled
1220#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001221# disable_ldpc: Whether LDPC should be disabled.
1222# 0 = LDPC enabled (if AP supports it)
1223# 1 = LDPC disabled
1224#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001225# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1226# 0 = 40 MHz tolerant (default)
1227# 1 = 40 MHz intolerant
1228#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001229# ht_mcs: Configure allowed MCS rates.
1230# Parsed as an array of bytes, in base-16 (ascii-hex)
1231# ht_mcs="" // Use all available (default)
1232# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1233# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1234#
1235# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1236# -1 = Do not make any changes.
1237# 0 = Enable MAX-AMSDU if hardware supports it.
1238# 1 = Disable AMSDU
1239#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001240# ampdu_factor: Maximum A-MPDU Length Exponent
1241# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1242#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001243# ampdu_density: Allow overriding AMPDU density configuration.
1244# Treated as hint by the kernel.
1245# -1 = Do not make any changes.
1246# 0-3 = Set AMPDU density (aka factor) to specified value.
1247
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001248# disable_vht: Whether VHT should be disabled.
1249# 0 = VHT enabled (if AP supports it)
1250# 1 = VHT disabled
1251#
1252# vht_capa: VHT capabilities to set in the override
1253# vht_capa_mask: mask of VHT capabilities
1254#
1255# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1256# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1257# 0: MCS 0-7
1258# 1: MCS 0-8
1259# 2: MCS 0-9
1260# 3: not supported
1261
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001262##### Fast Session Transfer (FST) support #####################################
1263#
1264# The options in this section are only available when the build configuration
1265# option CONFIG_FST is set while compiling hostapd. They allow this interface
1266# to be a part of FST setup.
1267#
1268# FST is the transfer of a session from a channel to another channel, in the
1269# same or different frequency bands.
1270#
1271# For detals, see IEEE Std 802.11ad-2012.
1272
1273# Identifier of an FST Group the interface belongs to.
1274#fst_group_id=bond0
1275
1276# Interface priority within the FST Group.
1277# Announcing a higher priority for an interface means declaring it more
1278# preferable for FST switch.
1279# fst_priority is in 1..255 range with 1 being the lowest priority.
1280#fst_priority=100
1281
1282# Default LLT value for this interface in milliseconds. The value used in case
1283# no value provided during session setup. Default is 50 msec.
1284# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1285# Transitioning between states).
1286#fst_llt=100
1287
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001288# Example blocks:
1289
1290# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1291network={
1292 ssid="simple"
1293 psk="very secret passphrase"
1294 priority=5
1295}
1296
1297# Same as previous, but request SSID-specific scanning (for APs that reject
1298# broadcast SSID)
1299network={
1300 ssid="second ssid"
1301 scan_ssid=1
1302 psk="very secret passphrase"
1303 priority=2
1304}
1305
1306# Only WPA-PSK is used. Any valid cipher combination is accepted.
1307network={
1308 ssid="example"
1309 proto=WPA
1310 key_mgmt=WPA-PSK
1311 pairwise=CCMP TKIP
1312 group=CCMP TKIP WEP104 WEP40
1313 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1314 priority=2
1315}
1316
1317# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1318network={
1319 ssid="example"
1320 proto=WPA
1321 key_mgmt=WPA-PSK
1322 pairwise=TKIP
1323 group=TKIP
1324 psk="not so secure passphrase"
1325 wpa_ptk_rekey=600
1326}
1327
1328# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1329# or WEP40 as the group cipher will not be accepted.
1330network={
1331 ssid="example"
1332 proto=RSN
1333 key_mgmt=WPA-EAP
1334 pairwise=CCMP TKIP
1335 group=CCMP TKIP
1336 eap=TLS
1337 identity="user@example.com"
1338 ca_cert="/etc/cert/ca.pem"
1339 client_cert="/etc/cert/user.pem"
1340 private_key="/etc/cert/user.prv"
1341 private_key_passwd="password"
1342 priority=1
1343}
1344
1345# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1346# (e.g., Radiator)
1347network={
1348 ssid="example"
1349 key_mgmt=WPA-EAP
1350 eap=PEAP
1351 identity="user@example.com"
1352 password="foobar"
1353 ca_cert="/etc/cert/ca.pem"
1354 phase1="peaplabel=1"
1355 phase2="auth=MSCHAPV2"
1356 priority=10
1357}
1358
1359# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1360# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1361network={
1362 ssid="example"
1363 key_mgmt=WPA-EAP
1364 eap=TTLS
1365 identity="user@example.com"
1366 anonymous_identity="anonymous@example.com"
1367 password="foobar"
1368 ca_cert="/etc/cert/ca.pem"
1369 priority=2
1370}
1371
1372# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1373# use. Real identity is sent only within an encrypted TLS tunnel.
1374network={
1375 ssid="example"
1376 key_mgmt=WPA-EAP
1377 eap=TTLS
1378 identity="user@example.com"
1379 anonymous_identity="anonymous@example.com"
1380 password="foobar"
1381 ca_cert="/etc/cert/ca.pem"
1382 phase2="auth=MSCHAPV2"
1383}
1384
1385# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1386# authentication.
1387network={
1388 ssid="example"
1389 key_mgmt=WPA-EAP
1390 eap=TTLS
1391 # Phase1 / outer authentication
1392 anonymous_identity="anonymous@example.com"
1393 ca_cert="/etc/cert/ca.pem"
1394 # Phase 2 / inner authentication
1395 phase2="autheap=TLS"
1396 ca_cert2="/etc/cert/ca2.pem"
1397 client_cert2="/etc/cer/user.pem"
1398 private_key2="/etc/cer/user.prv"
1399 private_key2_passwd="password"
1400 priority=2
1401}
1402
1403# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1404# group cipher.
1405network={
1406 ssid="example"
1407 bssid=00:11:22:33:44:55
1408 proto=WPA RSN
1409 key_mgmt=WPA-PSK WPA-EAP
1410 pairwise=CCMP
1411 group=CCMP
1412 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1413}
1414
1415# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1416# and all valid ciphers.
1417network={
1418 ssid=00010203
1419 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1420}
1421
1422
1423# EAP-SIM with a GSM SIM or USIM
1424network={
1425 ssid="eap-sim-test"
1426 key_mgmt=WPA-EAP
1427 eap=SIM
1428 pin="1234"
1429 pcsc=""
1430}
1431
1432
1433# EAP-PSK
1434network={
1435 ssid="eap-psk-test"
1436 key_mgmt=WPA-EAP
1437 eap=PSK
1438 anonymous_identity="eap_psk_user"
1439 password=06b4be19da289f475aa46a33cb793029
1440 identity="eap_psk_user@example.com"
1441}
1442
1443
1444# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1445# EAP-TLS for authentication and key generation; require both unicast and
1446# broadcast WEP keys.
1447network={
1448 ssid="1x-test"
1449 key_mgmt=IEEE8021X
1450 eap=TLS
1451 identity="user@example.com"
1452 ca_cert="/etc/cert/ca.pem"
1453 client_cert="/etc/cert/user.pem"
1454 private_key="/etc/cert/user.prv"
1455 private_key_passwd="password"
1456 eapol_flags=3
1457}
1458
1459
1460# LEAP with dynamic WEP keys
1461network={
1462 ssid="leap-example"
1463 key_mgmt=IEEE8021X
1464 eap=LEAP
1465 identity="user"
1466 password="foobar"
1467}
1468
1469# EAP-IKEv2 using shared secrets for both server and peer authentication
1470network={
1471 ssid="ikev2-example"
1472 key_mgmt=WPA-EAP
1473 eap=IKEV2
1474 identity="user"
1475 password="foobar"
1476}
1477
1478# EAP-FAST with WPA (WPA or WPA2)
1479network={
1480 ssid="eap-fast-test"
1481 key_mgmt=WPA-EAP
1482 eap=FAST
1483 anonymous_identity="FAST-000102030405"
1484 identity="username"
1485 password="password"
1486 phase1="fast_provisioning=1"
1487 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1488}
1489
1490network={
1491 ssid="eap-fast-test"
1492 key_mgmt=WPA-EAP
1493 eap=FAST
1494 anonymous_identity="FAST-000102030405"
1495 identity="username"
1496 password="password"
1497 phase1="fast_provisioning=1"
1498 pac_file="blob://eap-fast-pac"
1499}
1500
1501# Plaintext connection (no WPA, no IEEE 802.1X)
1502network={
1503 ssid="plaintext-test"
1504 key_mgmt=NONE
1505}
1506
1507
1508# Shared WEP key connection (no WPA, no IEEE 802.1X)
1509network={
1510 ssid="static-wep-test"
1511 key_mgmt=NONE
1512 wep_key0="abcde"
1513 wep_key1=0102030405
1514 wep_key2="1234567890123"
1515 wep_tx_keyidx=0
1516 priority=5
1517}
1518
1519
1520# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1521# IEEE 802.11 authentication
1522network={
1523 ssid="static-wep-test2"
1524 key_mgmt=NONE
1525 wep_key0="abcde"
1526 wep_key1=0102030405
1527 wep_key2="1234567890123"
1528 wep_tx_keyidx=0
1529 priority=5
1530 auth_alg=SHARED
1531}
1532
1533
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001534# IBSS/ad-hoc network with RSN
1535network={
1536 ssid="ibss-rsn"
1537 key_mgmt=WPA-PSK
1538 proto=RSN
1539 psk="12345678"
1540 mode=1
1541 frequency=2412
1542 pairwise=CCMP
1543 group=CCMP
1544}
1545
1546# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001547network={
1548 ssid="test adhoc"
1549 mode=1
1550 frequency=2412
1551 proto=WPA
1552 key_mgmt=WPA-NONE
1553 pairwise=NONE
1554 group=TKIP
1555 psk="secret passphrase"
1556}
1557
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001558# open mesh network
1559network={
1560 ssid="test mesh"
1561 mode=5
1562 frequency=2437
1563 key_mgmt=NONE
1564}
1565
1566# secure (SAE + AMPE) network
1567network={
1568 ssid="secure mesh"
1569 mode=5
1570 frequency=2437
1571 key_mgmt=SAE
1572 psk="very secret passphrase"
1573}
1574
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001575
1576# Catch all example that allows more or less all configuration modes
1577network={
1578 ssid="example"
1579 scan_ssid=1
1580 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1581 pairwise=CCMP TKIP
1582 group=CCMP TKIP WEP104 WEP40
1583 psk="very secret passphrase"
1584 eap=TTLS PEAP TLS
1585 identity="user@example.com"
1586 password="foobar"
1587 ca_cert="/etc/cert/ca.pem"
1588 client_cert="/etc/cert/user.pem"
1589 private_key="/etc/cert/user.prv"
1590 private_key_passwd="password"
1591 phase1="peaplabel=0"
1592}
1593
1594# Example of EAP-TLS with smartcard (openssl engine)
1595network={
1596 ssid="example"
1597 key_mgmt=WPA-EAP
1598 eap=TLS
1599 proto=RSN
1600 pairwise=CCMP TKIP
1601 group=CCMP TKIP
1602 identity="user@example.com"
1603 ca_cert="/etc/cert/ca.pem"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001604
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001605 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1606 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1607 private_key="pkcs11:manufacturer=piv_II;id=%01"
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001608
1609 # Optional PIN configuration; this can be left out and PIN will be
1610 # asked through the control interface
1611 pin="1234"
1612}
1613
1614# Example configuration showing how to use an inlined blob as a CA certificate
1615# data instead of using external file
1616network={
1617 ssid="example"
1618 key_mgmt=WPA-EAP
1619 eap=TTLS
1620 identity="user@example.com"
1621 anonymous_identity="anonymous@example.com"
1622 password="foobar"
1623 ca_cert="blob://exampleblob"
1624 priority=20
1625}
1626
1627blob-base64-exampleblob={
1628SGVsbG8gV29ybGQhCg==
1629}
1630
1631
1632# Wildcard match for SSID (plaintext APs only). This example select any
1633# open AP regardless of its SSID.
1634network={
1635 key_mgmt=NONE
1636}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001637
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001638# Example configuration blacklisting two APs - these will be ignored
1639# for this network.
1640network={
1641 ssid="example"
1642 psk="very secret passphrase"
1643 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1644}
1645
1646# Example configuration limiting AP selection to a specific set of APs;
1647# any other AP not matching the masked address will be ignored.
1648network={
1649 ssid="example"
1650 psk="very secret passphrase"
1651 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
1652}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001653
1654# Example config file that will only scan on channel 36.
1655freq_list=5180
1656network={
1657 key_mgmt=NONE
1658}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001659
1660
1661# Example MACsec configuration
1662#network={
1663# key_mgmt=IEEE8021X
1664# eap=TTLS
1665# phase2="auth=PAP"
1666# anonymous_identity="anonymous@example.com"
1667# identity="user@example.com"
1668# password="secretr"
1669# ca_cert="/etc/cert/ca.pem"
1670# eapol_flags=0
1671# macsec_policy=1
1672#}