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