]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/wpa_supplicant.conf
mka: Allow configuration of MACsec replay protection
[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#
9b6f93e4
JM
600# required_roaming_consortium: Required Roaming Consortium OI
601# If required_roaming_consortium_len is non-zero, this field contains the
602# Roaming Consortium OI that is required to be advertised by the AP for
603# the credential to be considered matching.
604#
909a948b
JM
605# roaming_consortiums: Roaming Consortium OI(s) memberships
606# This string field contains one or more comma delimited OIs (hexdump)
607# identifying the roaming consortiums of which the provider is a member.
608# The list is sorted from the most preferred one to the least preferred
609# one. A match between the Roaming Consortium OIs advertised by an AP and
610# the OIs in this list indicates that successful authentication is
611# possible.
612# (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
613#
8ca93c59
JM
614# eap: Pre-configured EAP method
615# This optional field can be used to specify which EAP method will be
616# used with this credential. If not set, the EAP method is selected
617# automatically based on ANQP information (e.g., NAI Realm).
618#
619# phase1: Pre-configure Phase 1 (outer authentication) parameters
620# This optional field is used with like the 'eap' parameter.
621#
622# phase2: Pre-configure Phase 2 (inner authentication) parameters
623# This optional field is used with like the 'eap' parameter.
624#
dbea8ac7
JM
625# excluded_ssid: Excluded SSID
626# This optional field can be used to excluded specific SSID(s) from
627# matching with the network. Multiple entries can be used to specify more
628# than one SSID.
629#
bc00053c
JM
630# roaming_partner: Roaming partner information
631# This optional field can be used to configure preferences between roaming
632# partners. The field is a string in following format:
633# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
634# (non-exact match means any subdomain matches the entry; priority is in
635# 0..255 range with 0 being the highest priority)
636#
f9cd147d
JM
637# update_identifier: PPS MO ID
638# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
639#
aa26ba68
JM
640# provisioning_sp: FQDN of the SP that provisioned the credential
641# This optional field can be used to keep track of the SP that provisioned
642# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
643#
4cad9df1
JM
644# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
645# These fields can be used to specify minimum download/upload backhaul
646# bandwidth that is preferred for the credential. This constraint is
647# ignored if the AP does not advertise WAN Metrics information or if the
648# limit would prevent any connection. Values are in kilobits per second.
649# min_dl_bandwidth_home
650# min_ul_bandwidth_home
651# min_dl_bandwidth_roaming
652# min_ul_bandwidth_roaming
653#
a45b2dc5
JM
654# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
655# (PPS/<X+>/Policy/MaximumBSSLoadValue)
656# This value is used as the maximum channel utilization for network
657# selection purposes for home networks. If the AP does not advertise
658# BSS Load or if the limit would prevent any connection, this constraint
659# will be ignored.
660#
33fb8c52
JM
661# req_conn_capab: Required connection capability
662# (PPS/<X+>/Policy/RequiredProtoPortTuple)
663# This value is used to configure set of required protocol/port pairs that
664# a roaming network shall support (include explicitly in Connection
665# Capability ANQP element). This constraint is ignored if the AP does not
666# advertise Connection Capability or if this constraint would prevent any
667# network connection. This policy is not used in home networks.
668# Format: <protocol>[:<comma-separated list of ports]
669# Multiple entries can be used to list multiple requirements.
670# For example, number of common TCP protocols:
671# req_conn_capab=6,22,80,443
672# For example, IPSec/IKE:
673# req_conn_capab=17:500
674# req_conn_capab=50
675#
cf6d08a6
JM
676# ocsp: Whether to use/require OCSP to check server certificate
677# 0 = do not use OCSP stapling (TLS certificate status extension)
678# 1 = try to use OCSP stapling, but not require response
679# 2 = require valid OCSP stapling response
d6b536f7
JM
680# 3 = require valid OCSP stapling response for all not-trusted
681# certificates in the server certificate chain
cf6d08a6 682#
13f6a07e
NJ
683# sim_num: Identifier for which SIM to use in multi-SIM devices
684#
400020cb
JM
685# for example:
686#
687#cred={
688# realm="example.com"
689# username="user@example.com"
690# password="password"
691# ca_cert="/etc/wpa_supplicant/ca.pem"
692# domain="example.com"
693#}
694#
695#cred={
696# imsi="310026-000000000"
817bb3e1 697# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
400020cb 698#}
955567bc
JM
699#
700#cred={
701# realm="example.com"
702# username="user"
703# password="password"
704# ca_cert="/etc/wpa_supplicant/ca.pem"
705# domain="example.com"
706# roaming_consortium=223344
707# eap=TTLS
708# phase2="auth=MSCHAPV2"
709#}
2a4b98a9 710
66aadbd7
JK
711# Hotspot 2.0
712# hs20=1
713
32c02261
AS
714# Scheduled scan plans
715#
716# A space delimited list of scan plans. Each scan plan specifies the scan
717# interval and number of iterations, delimited by a colon. The last scan plan
718# will run infinitely and thus must specify only the interval and not the number
719# of iterations.
720#
721# The driver advertises the maximum number of scan plans supported. If more scan
722# plans than supported are configured, only the first ones are set (up to the
723# maximum supported). The last scan plan that specifies only the interval is
724# always set as the last plan.
725#
726# If the scan interval or the number of iterations for a scan plan exceeds the
727# maximum supported, it will be set to the maximum supported value.
728#
729# Format:
730# sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
731#
732# Example:
733# sched_scan_plans=10:100 20:200 30
734
facf2c72
DS
735# Multi Band Operation (MBO) non-preferred channels
736# A space delimited list of non-preferred channels where each channel is a colon
4a83d4b6 737# delimited list of values.
facf2c72 738# Format:
4a83d4b6 739# non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
facf2c72 740# Example:
23cddd75 741# non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
facf2c72 742
c5d193d7
DS
743# MBO Cellular Data Capabilities
744# 1 = Cellular data connection available
745# 2 = Cellular data connection not available
746# 3 = Not cellular capable (default)
747#mbo_cell_capa=3
748
332aadb8
AP
749# Optimized Connectivity Experience (OCE)
750# oce: Enable OCE features (bitmap)
751# Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
752# does not indicate support for OCE in STA mode)
753# Set BIT(1) to Enable OCE in STA-CFON mode
754#oce=1
755
6fc6879b
JM
756# network block
757#
758# Each network (usually AP's sharing the same SSID) is configured as a separate
759# block in this configuration file. The network blocks are in preference order
760# (the first match is used).
761#
762# network block fields:
763#
764# disabled:
765# 0 = this network can be used (default)
766# 1 = this network block is disabled (can be enabled through ctrl_iface,
767# e.g., with wpa_cli or wpa_gui)
768#
769# id_str: Network identifier string for external scripts. This value is passed
770# to external action script through wpa_cli as WPA_ID_STR environment
771# variable to make it easier to do network specific configuration.
772#
5c4b93d7
JM
773# ssid: SSID (mandatory); network name in one of the optional formats:
774# - an ASCII string with double quotation
775# - a hex string (two characters per octet of SSID)
776# - a printf-escaped ASCII string P"<escaped string>"
6fc6879b
JM
777#
778# scan_ssid:
779# 0 = do not scan this SSID with specific Probe Request frames (default)
780# 1 = scan with SSID-specific Probe Request frames (this can be used to
781# find APs that do not accept broadcast SSID or use multiple SSIDs;
782# this will add latency to scanning, so enable this only when needed)
783#
784# bssid: BSSID (optional); if set, this network block is used only when
785# associating with the AP using the configured BSSID
786#
787# priority: priority group (integer)
788# By default, all networks will get same priority group (0). If some of the
789# networks are more desirable, this field can be used to change the order in
790# which wpa_supplicant goes through the networks when selecting a BSS. The
791# priority groups will be iterated in decreasing priority (i.e., the larger the
792# priority value, the sooner the network is matched against the scan results).
793# Within each priority group, networks will be selected based on security
794# policy, signal strength, etc.
795# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
796# using this priority to select the order for scanning. Instead, they try the
797# networks in the order that used in the configuration file.
798#
799# mode: IEEE 802.11 operation mode
800# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
801# 1 = IBSS (ad-hoc, peer-to-peer)
1581b38b 802# 2 = AP (access point)
b2838baf
JM
803# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
804# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
805# TKIP/CCMP) is available for backwards compatibility, but its use is
806# deprecated. WPA-None requires following network block options:
6fc6879b
JM
807# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
808# both), and psk must also be set.
809#
810# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
811# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
812# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
813# In addition, this value is only used by the station that creates the IBSS. If
814# an IBSS network with the configured SSID is already present, the frequency of
815# the network will be used instead of this configured value.
816#
b9074912 817# pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
90f14962
LD
818# 0 = do not use PBSS
819# 1 = use PBSS
820# 2 = don't care (not allowed in AP mode)
b9074912
LD
821# Used together with mode configuration. When mode is AP, it means to start a
822# PCP instead of a regular AP. When mode is infrastructure it means connect
90f14962
LD
823# to a PCP instead of AP. In this mode you can also specify 2 (don't care)
824# which means connect to either PCP or AP.
825# P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
b9074912
LD
826# For more details, see IEEE Std 802.11ad-2012.
827#
d3a98225
JM
828# scan_freq: List of frequencies to scan
829# Space-separated list of frequencies in MHz to scan when searching for this
830# BSS. If the subset of channels used by the network is known, this option can
831# be used to optimize scanning to not occur on channels that the network does
832# not use. Example: scan_freq=2412 2437 2462
833#
b766a9a2
JM
834# freq_list: Array of allowed frequencies
835# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
836# set, scan results that do not match any of the specified frequencies are not
837# considered when selecting a BSS.
838#
f5ffc348
BG
839# This can also be set on the outside of the network block. In this case,
840# it limits the frequencies that will be scanned.
841#
2474ce45
JM
842# bgscan: Background scanning
843# wpa_supplicant behavior for background scanning can be specified by
844# configuring a bgscan module. These modules are responsible for requesting
845# background scans for the purpose of roaming within an ESS (i.e., within a
846# single network block with all the APs using the same SSID). The bgscan
847# parameter uses following format: "<bgscan module name>:<module parameters>"
848# Following bgscan modules are available:
849# simple - Periodic background scans based on signal strength
850# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
851# <long interval>"
852# bgscan="simple:30:-45:300"
853# learn - Learn channels used by the network and try to avoid bgscans on other
854# channels (experimental)
855# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
856# <long interval>[:<database file name>]"
857# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
268043d5
DS
858# Explicitly disable bgscan by setting
859# bgscan=""
2474ce45 860#
31392709
HD
861# This option can also be set outside of all network blocks for the bgscan
862# parameter to apply for all the networks that have no specific bgscan
863# parameter.
864#
6fc6879b
JM
865# proto: list of accepted protocols
866# WPA = WPA/IEEE 802.11i/D3.0
867# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
ecec4878 868# Note that RSN is used also for WPA3.
6fc6879b
JM
869# If not set, this defaults to: WPA RSN
870#
871# key_mgmt: list of accepted authenticated key management protocols
872# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
f6190d37 873# WPA-EAP = WPA using EAP authentication
6fc6879b
JM
874# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
875# generated WEP keys
876# NONE = WPA is not used; plaintext or static WEP could be used
0ab0de88
JM
877# WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
878# instead)
879# FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
880# FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
d8e8c992
JM
881# FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
882# and using SHA384
56586197
JM
883# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
884# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
0ab0de88
JM
885# SAE = Simultaneous authentication of equals; pre-shared key/password -based
886# authentication with stronger security than WPA-PSK especially when using
ecec4878 887# not that strong password; a.k.a. WPA3-Personal
0ab0de88
JM
888# FT-SAE = SAE with FT
889# WPA-EAP-SUITE-B = Suite B 128-bit level
890# WPA-EAP-SUITE-B-192 = Suite B 192-bit level
aeb408ff 891# OSEN = Hotspot 2.0 Rel 2 online signup connection
9b7a2b83
JM
892# FILS-SHA256 = Fast Initial Link Setup with SHA256
893# FILS-SHA384 = Fast Initial Link Setup with SHA384
894# FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
895# FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
ecec4878
JM
896# OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
897# DPP = Device Provisioning Protocol
6fc6879b
JM
898# If not set, this defaults to: WPA-PSK WPA-EAP
899#
4732ee3a 900# ieee80211w: whether management frame protection is enabled
62d49803 901# 0 = disabled (default unless changed with the global pmf parameter)
4732ee3a
JM
902# 1 = optional
903# 2 = required
904# The most common configuration options for this based on the PMF (protected
905# management frames) certification program are:
906# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
907# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
908# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
909#
ce6829c2
MV
910# ocv: whether operating channel validation is enabled
911# This is a countermeasure against multi-channel man-in-the-middle attacks.
912# Enabling this automatically also enables ieee80211w, if not yet enabled.
913# 0 = disabled (default)
914# 1 = enabled
915#ocv=1
916#
6fc6879b
JM
917# auth_alg: list of allowed IEEE 802.11 authentication algorithms
918# OPEN = Open System authentication (required for WPA/WPA2)
919# SHARED = Shared Key authentication (requires static WEP keys)
920# LEAP = LEAP/Network EAP (only used with LEAP)
921# If not set, automatic selection is used (Open System with LEAP enabled if
922# LEAP is allowed as one of the EAP methods).
923#
924# pairwise: list of accepted pairwise (unicast) ciphers for WPA
925# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
926# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
927# NONE = Use only Group Keys (deprecated, should not be included if APs support
928# pairwise keys)
929# If not set, this defaults to: CCMP TKIP
930#
931# group: list of accepted group (broadcast/multicast) ciphers for WPA
932# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
933# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
934# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
935# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
936# If not set, this defaults to: CCMP TKIP WEP104 WEP40
937#
61a56c14
JM
938# group_mgmt: list of accepted group management ciphers for RSN (PMF)
939# AES-128-CMAC = BIP-CMAC-128
940# BIP-GMAC-128
941# BIP-GMAC-256
942# BIP-CMAC-256
943# If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
944# indicates.
945#
6fc6879b
JM
946# psk: WPA preshared key; 256-bit pre-shared key
947# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
948# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
949# generated using the passphrase and SSID). ASCII passphrase must be between
9173b16f
JM
950# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
951# be used to indicate that the PSK/passphrase is stored in external storage.
6fc6879b
JM
952# This field is not needed, if WPA-EAP is used.
953# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
954# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
955# startup and reconfiguration time can be optimized by generating the PSK only
956# only when the passphrase or SSID has actually changed.
957#
a52410c2
JM
958# mem_only_psk: Whether to keep PSK/passphrase only in memory
959# 0 = allow psk/passphrase to be stored to the configuration file
960# 1 = do not store psk/passphrase to the configuration file
961#mem_only_psk=0
962#
a34ca59e
JM
963# sae_password: SAE password
964# This parameter can be used to set a password for SAE. By default, the
a2ab3730
JM
965# passphrase from the psk parameter is used if this separate parameter is not
966# used, but psk follows the WPA-PSK constraints (8..63 characters) even though
967# SAE passwords do not have such constraints.
a34ca59e 968#
9be19d0b
JM
969# sae_password_id: SAE password identifier
970# This parameter can be used to set an identifier for the SAE password. By
971# default, no such identifier is used. If set, the specified identifier value
972# is used by the other peer to select which password to use for authentication.
973#
6fc6879b
JM
974# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
975# Dynamic WEP key required for non-WPA mode
976# bit0 (1): require dynamically generated unicast WEP key
977# bit1 (2): require dynamically generated broadcast WEP key
978# (3 = require both keys; default)
ba5ea116 979# Note: When using wired authentication (including MACsec drivers),
dd10abcc
HW
980# eapol_flags must be set to 0 for the authentication to be completed
981# successfully.
982#
983# macsec_policy: IEEE 802.1X/MACsec options
ba5ea116
SD
984# This determines how sessions are secured with MACsec (only for MACsec
985# drivers).
dd10abcc
HW
986# 0: MACsec not in use (default)
987# 1: MACsec enabled - Should secure, accept key server's advice to
988# determine whether to use a secure session or not.
6fc6879b 989#
7b4d546e
SD
990# macsec_integ_only: IEEE 802.1X/MACsec transmit mode
991# This setting applies only when MACsec is in use, i.e.,
992# - macsec_policy is enabled
993# - the key server has decided to enable MACsec
994# 0: Encrypt traffic (default)
995# 1: Integrity only
996#
e49b78c0
AK
997# macsec_replay_protect: IEEE 802.1X/MACsec replay protection
998# This setting applies only when MACsec is in use, i.e.,
999# - macsec_policy is enabled
1000# - the key server has decided to enable MACsec
1001# 0: Replay protection disabled (default)
1002# 1: Replay protection enabled
1003#
1004# macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1005# This determines a window in which replay is tolerated, to allow receipt
1006# of frames that have been misordered by the network.
1007# This setting applies only when MACsec replay protection active, i.e.,
1008# - macsec_replay_protect is enabled
1009# - the key server has decided to enable MACsec
1010# 0: No replay window, strict check (default)
1011# 1..2^32-1: number of packets that could be misordered
1012#
e0d9fd34
SD
1013# macsec_port: IEEE 802.1X/MACsec port
1014# Port component of the SCI
1015# Range: 1-65534 (default: 1)
1016#
65dfa872 1017# mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
ad51731a 1018# This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
65dfa872
BA
1019# In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1020# with lower priority will become the key server and start distributing SAKs.
ad51731a
SD
1021# mka_cak (CAK = Secure Connectivity Association Key) takes a 16-bytes (128 bit)
1022# hex-string (32 hex-digits)
1023# mka_ckn (CKN = CAK Name) takes a 32-bytes (256 bit) hex-string (64 hex-digits)
65dfa872
BA
1024# mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1025# default priority
ad51731a 1026#
6fc6879b
JM
1027# mixed_cell: This option can be used to configure whether so called mixed
1028# cells, i.e., networks that use both plaintext and encryption in the same
ffbf1eaa 1029# SSID, are allowed when selecting a BSS from scan results.
6fc6879b
JM
1030# 0 = disabled (default)
1031# 1 = enabled
1032#
1033# proactive_key_caching:
1034# Enable/disable opportunistic PMKSA caching for WPA2.
6e202021 1035# 0 = disabled (default unless changed with the global okc parameter)
6fc6879b
JM
1036# 1 = enabled
1037#
1038# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1039# hex without quotation, e.g., 0102030405)
1040# wep_tx_keyidx: Default WEP key index (TX) (0..3)
1041#
581a8cde
JM
1042# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1043# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1044#
6c33ca9f
JM
1045# group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1046# as the dot11RSNAConfigGroupRekeyTime parameter when operating in
f09095d5 1047# Authenticator role in IBSS, or in AP and mesh modes.
6c33ca9f 1048#
6fc6879b
JM
1049# Following fields are only used with internal EAP implementation.
1050# eap: space-separated list of accepted EAP methods
205d2d1f 1051# MD5 = EAP-MD5 (insecure and does not generate keying material ->
6fc6879b
JM
1052# cannot be used with WPA; to be used as a Phase 2 method
1053# with EAP-PEAP or EAP-TTLS)
1054# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1055# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1056# OTP = EAP-OTP (cannot be used separately with WPA; to be used
1057# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1058# GTC = EAP-GTC (cannot be used separately with WPA; to be used
1059# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1060# TLS = EAP-TLS (client and server certificate)
1061# PEAP = EAP-PEAP (with tunnelled EAP authentication)
1062# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1063# authentication)
1064# If not set, all compiled in methods are allowed.
1065#
1066# identity: Identity string for EAP
1067# This field is also used to configure user NAI for
1068# EAP-PSK/PAX/SAKE/GPSK.
1069# anonymous_identity: Anonymous identity string for EAP (to be used as the
1070# unencrypted identity with EAP types that support different tunnelled
e026159a
JM
1071# identity, e.g., EAP-TTLS). This field can also be used with
1072# EAP-SIM/AKA/AKA' to store the pseudonym identity.
6fc6879b
JM
1073# password: Password string for EAP. This field can include either the
1074# plaintext password (using ASCII or hex string) or a NtPasswordHash
1075# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1076# NtPasswordHash can only be used when the password is for MSCHAPv2 or
1077# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1078# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1079# PSK) is also configured using this field. For EAP-GPSK, this is a
0ebb23e3
JM
1080# variable length PSK. ext:<name of external password field> format can
1081# be used to indicate that the password is stored in external storage.
6fc6879b
JM
1082# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1083# or more trusted CA certificates. If ca_cert and ca_path are not
1084# included, server certificate will not be verified. This is insecure and
1085# a trusted CA certificate should always be configured when using
1086# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1087# change when wpa_supplicant is run in the background.
00468b46
JM
1088#
1089# Alternatively, this can be used to only perform matching of the server
1090# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1091# this case, the possible CA certificates in the server certificate chain
1092# are ignored and only the server certificate is verified. This is
1093# configured with the following format:
1094# hash:://server/sha256/cert_hash_in_hex
1095# For example: "hash://server/sha256/
1096# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1097#
6fc6879b
JM
1098# On Windows, trusted CA certificates can be loaded from the system
1099# certificate store by setting this to cert_store://<name>, e.g.,
1100# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1101# Note that when running wpa_supplicant as an application, the user
1102# certificate store (My user account) is used, whereas computer store
1103# (Computer account) is used when running wpasvc as a service.
1104# ca_path: Directory path for CA certificate files (PEM). This path may
1105# contain multiple CA certificates in OpenSSL format. Common use for this
1106# is to point to system trusted CA list which is often installed into
1107# directory like /etc/ssl/certs. If configured, these certificates are
1108# added to the list of trusted CAs. ca_cert may also be included in that
1109# case, but it is not required.
1110# client_cert: File path to client certificate file (PEM/DER)
1111# Full path should be used since working directory may change when
1112# wpa_supplicant is run in the background.
1113# Alternatively, a named configuration blob can be used by setting this
1114# to blob://<blob name>.
1115# private_key: File path to client private key file (PEM/DER/PFX)
1116# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1117# commented out. Both the private key and certificate will be read from
1118# the PKCS#12 file in this case. Full path should be used since working
1119# directory may change when wpa_supplicant is run in the background.
1120# Windows certificate store can be used by leaving client_cert out and
1121# configuring private_key in one of the following formats:
1122# cert://substring_to_match
1123# hash://certificate_thumbprint_in_hex
1124# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1125# Note that when running wpa_supplicant as an application, the user
1126# certificate store (My user account) is used, whereas computer store
1127# (Computer account) is used when running wpasvc as a service.
1128# Alternatively, a named configuration blob can be used by setting this
1129# to blob://<blob name>.
1130# private_key_passwd: Password for private key file (if left out, this will be
1131# asked through control interface)
1132# dh_file: File path to DH/DSA parameters file (in PEM format)
1133# This is an optional configuration file for setting parameters for an
1134# ephemeral DH key exchange. In most cases, the default RSA
1135# authentication does not use this configuration. However, it is possible
1136# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1137# DSA keys always use ephemeral DH keys. This can be used to achieve
1138# forward secrecy. If the file is in DSA parameters format, it will be
1139# automatically converted into DH params.
1140# subject_match: Substring to be matched against the subject of the
1141# authentication server certificate. If this string is set, the server
205d2d1f 1142# certificate is only accepted if it contains this string in the subject.
6fc6879b
JM
1143# The subject string is in following format:
1144# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
205d2d1f 1145# Note: Since this is a substring match, this cannot be used securely to
394b5473 1146# do a suffix match against a possible domain name in the CN entry. For
cebee30f
JM
1147# such a use case, domain_suffix_match or domain_match should be used
1148# instead.
6fc6879b
JM
1149# altsubject_match: Semicolon separated string of entries to be matched against
1150# the alternative subject name of the authentication server certificate.
205d2d1f 1151# If this string is set, the server certificate is only accepted if it
6fc6879b
JM
1152# contains one of the entries in an alternative subject name extension.
1153# altSubjectName string is in following format: TYPE:VALUE
1154# Example: EMAIL:server@example.com
1155# Example: DNS:server.example.com;DNS:server2.example.com
1156# Following types are supported: EMAIL, DNS, URI
394b5473 1157# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
205d2d1f 1158# used as a suffix match requirement for the AAA server certificate in
394b5473
JM
1159# SubjectAltName dNSName element(s). If a matching dNSName is found, this
1160# constraint is met. If no dNSName values are present, this constraint is
1161# matched against SubjectName CN using same suffix match comparison.
1162#
1163# Suffix match here means that the host/domain name is compared one label
1164# at a time starting from the top-level domain and all the labels in
1165# domain_suffix_match shall be included in the certificate. The
1166# certificate may include additional sub-level labels in addition to the
1167# required labels.
1168#
1169# For example, domain_suffix_match=example.com would match
1170# test.example.com but would not match test-example.com.
cebee30f
JM
1171# domain_match: Constraint for server domain name
1172# If set, this FQDN is used as a full match requirement for the
1173# server certificate in SubjectAltName dNSName element(s). If a
1174# matching dNSName is found, this constraint is met. If no dNSName
1175# values are present, this constraint is matched against SubjectName CN
1176# using same full match comparison. This behavior is similar to
1177# domain_suffix_match, but has the requirement of a full match, i.e.,
1178# no subdomains or wildcard matches are allowed. Case-insensitive
1179# comparison is used, so "Example.com" matches "example.com", but would
1180# not match "test.Example.com".
6fc6879b
JM
1181# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1182# (string with field-value pairs, e.g., "peapver=0" or
1183# "peapver=1 peaplabel=1")
1184# 'peapver' can be used to force which PEAP version (0 or 1) is used.
1185# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1186# to be used during key derivation when PEAPv1 or newer. Most existing
1187# PEAPv1 implementation seem to be using the old label, "client EAP
1188# encryption", and wpa_supplicant is now using that as the default value.
1189# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1190# interoperate with PEAPv1; see eap_testing.txt for more details.
1191# 'peap_outer_success=0' can be used to terminate PEAP authentication on
1192# tunneled EAP-Success. This is required with some RADIUS servers that
1193# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1194# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1195# include_tls_length=1 can be used to force wpa_supplicant to include
1196# TLS Message Length field in all TLS messages even if they are not
1197# fragmented.
1198# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1199# challenges (by default, it accepts 2 or 3)
1200# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1201# protected result indication.
d6888f9e
JM
1202# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1203# behavior:
c31a11c9
JM
1204# * 0 = do not use cryptobinding (default)
1205# * 1 = use cryptobinding if server supports it
d6888f9e 1206# * 2 = require cryptobinding
f855f923
JM
1207# EAP-WSC (WPS) uses following options: pin=<Device Password> or
1208# pbc=1.
7f7bfba9
JM
1209#
1210# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1211# used to configure a mode that allows EAP-Success (and EAP-Failure)
1212# without going through authentication step. Some switches use such
1213# sequence when forcing the port to be authorized/unauthorized or as a
1214# fallback option if the authentication server is unreachable. By default,
1215# wpa_supplicant discards such frames to protect against potential attacks
1216# by rogue devices, but this option can be used to disable that protection
1217# for cases where the server/authenticator does not need to be
1218# authenticated.
6fc6879b
JM
1219# phase2: Phase2 (inner authentication with TLS tunnel) parameters
1220# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
49fcc32e
JM
1221# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1222# used to disable MSCHAPv2 password retry in authentication failure cases.
9af7361b
JM
1223#
1224# TLS-based methods can use the following parameters to control TLS behavior
1225# (these are normally in the phase1 parameter, but can be used also in the
1226# phase2 parameter when EAP-TLS is used within the inner tunnel):
1227# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1228# TLS library, these may be disabled by default to enforce stronger
1229# security)
1230# tls_disable_time_checks=1 - ignore certificate validity time (this requests
1231# the TLS library to accept certificates even if they are not currently
1232# valid, i.e., have expired or have not yet become valid; this should be
1233# used only for testing purposes)
1234# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1235# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1236# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1237# as a workaround for broken authentication server implementations unless
56dfc493 1238# EAP workarounds are disabled with eap_workaround=0.
9af7361b
JM
1239# For EAP-FAST, this must be set to 0 (or left unconfigured for the
1240# default value to be used automatically).
5650d379 1241# tls_disable_tlsv1_0=1 - disable use of TLSv1.0
e9a6f183
DS
1242# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1243# that have issues interoperating with updated TLS version)
1244# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1245# that have issues interoperating with updated TLS version)
bbbc7e80
JM
1246# tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1247# that have issues interoperating with updated TLS version)
3c108b75
JM
1248# tls_ext_cert_check=0 - No external server certificate validation (default)
1249# tls_ext_cert_check=1 - External server certificate validation enabled; this
1250# requires an external program doing validation of server certificate
1251# chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1252# interface and report the result of the validation with
1253# CTRL-RSP_EXT_CERT_CHECK.
60ed2f24
JM
1254# tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1255# tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1256# particular when using Suite B with RSA keys of >= 3K (3072) bits
9af7361b 1257#
6fc6879b
JM
1258# Following certificate/private key fields are used in inner Phase2
1259# authentication when using EAP-TTLS or EAP-PEAP.
1260# ca_cert2: File path to CA certificate file. This file can have one or more
1261# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1262# server certificate will not be verified. This is insecure and a trusted
1263# CA certificate should always be configured.
1264# ca_path2: Directory path for CA certificate files (PEM)
1265# client_cert2: File path to client certificate file
1266# private_key2: File path to client private key file
1267# private_key2_passwd: Password for private key file
1268# dh_file2: File path to DH/DSA parameters file (in PEM format)
1269# subject_match2: Substring to be matched against the subject of the
394b5473
JM
1270# authentication server certificate. See subject_match for more details.
1271# altsubject_match2: Semicolon separated string of entries to be matched
1272# against the alternative subject name of the authentication server
1273# certificate. See altsubject_match documentation for more details.
1274# domain_suffix_match2: Constraint for server domain name. See
1275# domain_suffix_match for more details.
6fc6879b
JM
1276#
1277# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1278# This value limits the fragment size for EAP methods that support
1279# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1280# small enough to make the EAP messages fit in MTU of the network
1281# interface used for EAPOL. The default value is suitable for most
1282# cases.
1283#
080585c0
JM
1284# ocsp: Whether to use/require OCSP to check server certificate
1285# 0 = do not use OCSP stapling (TLS certificate status extension)
1286# 1 = try to use OCSP stapling, but not require response
1287# 2 = require valid OCSP stapling response
d6b536f7
JM
1288# 3 = require valid OCSP stapling response for all not-trusted
1289# certificates in the server certificate chain
080585c0 1290#
07e2de31
JM
1291# openssl_ciphers: OpenSSL specific cipher configuration
1292# This can be used to override the global openssl_ciphers configuration
1293# parameter (see above).
1294#
02a8d45a
JM
1295# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1296#
6fc6879b
JM
1297# EAP-FAST variables:
1298# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1299# to create this file and write updates to it when PAC is being
1300# provisioned or refreshed. Full path to the file should be used since
1301# working directory may change when wpa_supplicant is run in the
1302# background. Alternatively, a named configuration blob can be used by
1303# setting this to blob://<blob name>
1304# phase1: fast_provisioning option can be used to enable in-line provisioning
1305# of EAP-FAST credentials (PAC):
1306# 0 = disabled,
1307# 1 = allow unauthenticated provisioning,
1308# 2 = allow authenticated provisioning,
1309# 3 = allow both unauthenticated and authenticated provisioning
1310# fast_max_pac_list_len=<num> option can be used to set the maximum
1311# number of PAC entries to store in a PAC list (default: 10)
1312# fast_pac_format=binary option can be used to select binary format for
2e8c9a27 1313# storing PAC entries in order to save some space (the default
6fc6879b
JM
1314# text format uses about 2.5 times the size of minimal binary
1315# format)
1316#
1317# wpa_supplicant supports number of "EAP workarounds" to work around
1318# interoperability issues with incorrectly behaving authentication servers.
1319# These are enabled by default because some of the issues are present in large
1320# number of authentication servers. Strict EAP conformance mode can be
1321# configured by disabling workarounds with eap_workaround=0.
1322
aeb408ff
JM
1323# update_identifier: PPS MO ID
1324# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
6311547e
JM
1325#
1326# roaming_consortium_selection: Roaming Consortium Selection
1327# The matching Roaming Consortium OI that was used to generate this
1328# network profile.
aeb408ff 1329
07f53b8c
VT
1330# Station inactivity limit
1331#
1332# If a station does not send anything in ap_max_inactivity seconds, an
1333# empty data frame is sent to it in order to verify whether it is
1334# still in range. If this frame is not ACKed, the station will be
1335# disassociated and then deauthenticated. This feature is used to
1336# clear station table of old entries when the STAs move out of the
1337# range.
1338#
1339# The station can associate again with the AP if it is still in range;
1340# this inactivity poll is just used as a nicer way of verifying
1341# inactivity; i.e., client will not report broken connection because
1342# disassociation frame is not sent immediately without first polling
1343# the STA with a data frame.
1344# default: 300 (i.e., 5 minutes)
1345#ap_max_inactivity=300
1346
fdfb1c8b
EL
1347# DTIM period in Beacon intervals for AP mode (default: 2)
1348#dtim_period=2
1349
18206e02
JM
1350# Beacon interval (default: 100 TU)
1351#beacon_int=100
1352
b6317b41
LD
1353# WPS in AP mode
1354# 0 = WPS enabled and configured (default)
1355# 1 = WPS disabled
1356#wps_disabled=0
1357
76e20f4f
JM
1358# FILS DH Group
1359# 0 = PFS disabled with FILS shared key authentication (default)
1360# 1-65535 = DH Group to use for FILS PFS
1361#fils_dh_group=0
1362
c267753b
JM
1363# MAC address policy
1364# 0 = use permanent MAC address
1365# 1 = use random MAC address for each ESS connection
a313d17d 1366# 2 = like 1, but maintain OUI (with local admin bit set)
c267753b
JM
1367#mac_addr=0
1368
c8d22af8
BG
1369# disable_ht: Whether HT (802.11n) should be disabled.
1370# 0 = HT enabled (if AP supports it)
1371# 1 = HT disabled
1372#
1373# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1374# 0 = HT-40 enabled (if AP supports it)
1375# 1 = HT-40 disabled
1376#
1377# disable_sgi: Whether SGI (short guard interval) should be disabled.
1378# 0 = SGI enabled (if AP supports it)
1379# 1 = SGI disabled
1380#
39a5800f
PK
1381# disable_ldpc: Whether LDPC should be disabled.
1382# 0 = LDPC enabled (if AP supports it)
1383# 1 = LDPC disabled
1384#
d41cc8cc
JM
1385# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1386# 0 = 40 MHz tolerant (default)
1387# 1 = 40 MHz intolerant
1388#
c8d22af8
BG
1389# ht_mcs: Configure allowed MCS rates.
1390# Parsed as an array of bytes, in base-16 (ascii-hex)
1391# ht_mcs="" // Use all available (default)
1392# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1393# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1394#
1395# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1396# -1 = Do not make any changes.
1397# 0 = Enable MAX-AMSDU if hardware supports it.
1398# 1 = Disable AMSDU
1399#
e74dd0e5
JM
1400# ampdu_factor: Maximum A-MPDU Length Exponent
1401# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1402#
c8d22af8
BG
1403# ampdu_density: Allow overriding AMPDU density configuration.
1404# Treated as hint by the kernel.
1405# -1 = Do not make any changes.
1406# 0-3 = Set AMPDU density (aka factor) to specified value.
cdeea70f
SM
1407#
1408# tx_stbc: Allow overriding STBC support for TX streams
1409# Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1410# -1 = Do not make any changes (default)
1411# 0 = Set if not supported
1412# 1 = Set if supported
1413#
1414# rx_stbc: Allow overriding STBC support for RX streams
1415# Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1416# -1 = Do not make any changes (default)
1417# 0 = Set if not supported
1418# 1 = Set for support of one spatial stream
1419# 2 = Set for support of one and two spatial streams
1420# 3 = Set for support of one, two and three spatial streams
c8d22af8 1421
e9ee8dc3
JB
1422# disable_vht: Whether VHT should be disabled.
1423# 0 = VHT enabled (if AP supports it)
1424# 1 = VHT disabled
1425#
1426# vht_capa: VHT capabilities to set in the override
1427# vht_capa_mask: mask of VHT capabilities
1428#
1429# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1430# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1431# 0: MCS 0-7
1432# 1: MCS 0-8
1433# 2: MCS 0-9
1434# 3: not supported
1435
5abc7823
VN
1436# multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1437# 0 = normal STA (default)
1438# 1 = backhaul STA
1439# A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1440# support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1441# added to a bridge to allow forwarding frames over this backhaul link.
1442
76ca15b7
AN
1443##### Fast Session Transfer (FST) support #####################################
1444#
1445# The options in this section are only available when the build configuration
205d2d1f
JM
1446# option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1447# interface to be a part of FST setup.
76ca15b7
AN
1448#
1449# FST is the transfer of a session from a channel to another channel, in the
1450# same or different frequency bands.
1451#
205d2d1f 1452# For details, see IEEE Std 802.11ad-2012.
76ca15b7
AN
1453
1454# Identifier of an FST Group the interface belongs to.
1455#fst_group_id=bond0
1456
1457# Interface priority within the FST Group.
1458# Announcing a higher priority for an interface means declaring it more
1459# preferable for FST switch.
1460# fst_priority is in 1..255 range with 1 being the lowest priority.
1461#fst_priority=100
1462
1463# Default LLT value for this interface in milliseconds. The value used in case
1464# no value provided during session setup. Default is 50 msec.
1465# fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1466# Transitioning between states).
1467#fst_llt=100
1468
6fc6879b
JM
1469# Example blocks:
1470
1471# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1472network={
1473 ssid="simple"
1474 psk="very secret passphrase"
1475 priority=5
1476}
1477
1478# Same as previous, but request SSID-specific scanning (for APs that reject
1479# broadcast SSID)
1480network={
1481 ssid="second ssid"
1482 scan_ssid=1
1483 psk="very secret passphrase"
1484 priority=2
1485}
1486
1487# Only WPA-PSK is used. Any valid cipher combination is accepted.
1488network={
1489 ssid="example"
1490 proto=WPA
1491 key_mgmt=WPA-PSK
1492 pairwise=CCMP TKIP
1493 group=CCMP TKIP WEP104 WEP40
1494 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1495 priority=2
1496}
1497
581a8cde
JM
1498# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1499network={
1500 ssid="example"
1501 proto=WPA
1502 key_mgmt=WPA-PSK
1503 pairwise=TKIP
1504 group=TKIP
1505 psk="not so secure passphrase"
1506 wpa_ptk_rekey=600
1507}
1508
6fc6879b
JM
1509# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1510# or WEP40 as the group cipher will not be accepted.
1511network={
1512 ssid="example"
1513 proto=RSN
1514 key_mgmt=WPA-EAP
1515 pairwise=CCMP TKIP
1516 group=CCMP TKIP
1517 eap=TLS
1518 identity="user@example.com"
1519 ca_cert="/etc/cert/ca.pem"
1520 client_cert="/etc/cert/user.pem"
1521 private_key="/etc/cert/user.prv"
1522 private_key_passwd="password"
1523 priority=1
1524}
1525
1526# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1527# (e.g., Radiator)
1528network={
1529 ssid="example"
1530 key_mgmt=WPA-EAP
1531 eap=PEAP
1532 identity="user@example.com"
1533 password="foobar"
1534 ca_cert="/etc/cert/ca.pem"
1535 phase1="peaplabel=1"
1536 phase2="auth=MSCHAPV2"
1537 priority=10
1538}
1539
1540# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1541# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1542network={
1543 ssid="example"
1544 key_mgmt=WPA-EAP
1545 eap=TTLS
1546 identity="user@example.com"
1547 anonymous_identity="anonymous@example.com"
1548 password="foobar"
1549 ca_cert="/etc/cert/ca.pem"
1550 priority=2
1551}
1552
1553# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1554# use. Real identity is sent only within an encrypted TLS tunnel.
1555network={
1556 ssid="example"
1557 key_mgmt=WPA-EAP
1558 eap=TTLS
1559 identity="user@example.com"
1560 anonymous_identity="anonymous@example.com"
1561 password="foobar"
1562 ca_cert="/etc/cert/ca.pem"
1563 phase2="auth=MSCHAPV2"
1564}
1565
1566# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1567# authentication.
1568network={
1569 ssid="example"
1570 key_mgmt=WPA-EAP
1571 eap=TTLS
1572 # Phase1 / outer authentication
1573 anonymous_identity="anonymous@example.com"
1574 ca_cert="/etc/cert/ca.pem"
1575 # Phase 2 / inner authentication
1576 phase2="autheap=TLS"
1577 ca_cert2="/etc/cert/ca2.pem"
1578 client_cert2="/etc/cer/user.pem"
1579 private_key2="/etc/cer/user.prv"
1580 private_key2_passwd="password"
1581 priority=2
1582}
1583
1584# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1585# group cipher.
1586network={
1587 ssid="example"
1588 bssid=00:11:22:33:44:55
1589 proto=WPA RSN
1590 key_mgmt=WPA-PSK WPA-EAP
1591 pairwise=CCMP
1592 group=CCMP
1593 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1594}
1595
1596# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1597# and all valid ciphers.
1598network={
1599 ssid=00010203
1600 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1601}
1602
1603
1604# EAP-SIM with a GSM SIM or USIM
1605network={
1606 ssid="eap-sim-test"
1607 key_mgmt=WPA-EAP
1608 eap=SIM
1609 pin="1234"
1610 pcsc=""
1611}
1612
1613
1614# EAP-PSK
1615network={
1616 ssid="eap-psk-test"
1617 key_mgmt=WPA-EAP
1618 eap=PSK
1619 anonymous_identity="eap_psk_user"
1620 password=06b4be19da289f475aa46a33cb793029
1621 identity="eap_psk_user@example.com"
1622}
1623
1624
1625# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1626# EAP-TLS for authentication and key generation; require both unicast and
1627# broadcast WEP keys.
1628network={
1629 ssid="1x-test"
1630 key_mgmt=IEEE8021X
1631 eap=TLS
1632 identity="user@example.com"
1633 ca_cert="/etc/cert/ca.pem"
1634 client_cert="/etc/cert/user.pem"
1635 private_key="/etc/cert/user.prv"
1636 private_key_passwd="password"
1637 eapol_flags=3
1638}
1639
1640
1641# LEAP with dynamic WEP keys
1642network={
1643 ssid="leap-example"
1644 key_mgmt=IEEE8021X
1645 eap=LEAP
1646 identity="user"
1647 password="foobar"
1648}
1649
1650# EAP-IKEv2 using shared secrets for both server and peer authentication
1651network={
1652 ssid="ikev2-example"
1653 key_mgmt=WPA-EAP
1654 eap=IKEV2
1655 identity="user"
1656 password="foobar"
1657}
1658
1659# EAP-FAST with WPA (WPA or WPA2)
1660network={
1661 ssid="eap-fast-test"
1662 key_mgmt=WPA-EAP
1663 eap=FAST
1664 anonymous_identity="FAST-000102030405"
1665 identity="username"
1666 password="password"
1667 phase1="fast_provisioning=1"
1668 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1669}
1670
1671network={
1672 ssid="eap-fast-test"
1673 key_mgmt=WPA-EAP
1674 eap=FAST
1675 anonymous_identity="FAST-000102030405"
1676 identity="username"
1677 password="password"
1678 phase1="fast_provisioning=1"
1679 pac_file="blob://eap-fast-pac"
1680}
1681
1682# Plaintext connection (no WPA, no IEEE 802.1X)
1683network={
1684 ssid="plaintext-test"
1685 key_mgmt=NONE
1686}
1687
1688
1689# Shared WEP key connection (no WPA, no IEEE 802.1X)
1690network={
1691 ssid="static-wep-test"
1692 key_mgmt=NONE
1693 wep_key0="abcde"
1694 wep_key1=0102030405
1695 wep_key2="1234567890123"
1696 wep_tx_keyidx=0
1697 priority=5
1698}
1699
1700
1701# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1702# IEEE 802.11 authentication
1703network={
1704 ssid="static-wep-test2"
1705 key_mgmt=NONE
1706 wep_key0="abcde"
1707 wep_key1=0102030405
1708 wep_key2="1234567890123"
1709 wep_tx_keyidx=0
1710 priority=5
1711 auth_alg=SHARED
1712}
1713
1714
b2838baf
JM
1715# IBSS/ad-hoc network with RSN
1716network={
1717 ssid="ibss-rsn"
1718 key_mgmt=WPA-PSK
1719 proto=RSN
1720 psk="12345678"
1721 mode=1
1722 frequency=2412
1723 pairwise=CCMP
1724 group=CCMP
1725}
1726
1727# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
6fc6879b
JM
1728network={
1729 ssid="test adhoc"
1730 mode=1
1731 frequency=2412
1732 proto=WPA
1733 key_mgmt=WPA-NONE
1734 pairwise=NONE
1735 group=TKIP
1736 psk="secret passphrase"
9e5e03d7
TP
1737}
1738
1739# open mesh network
1740network={
1741 ssid="test mesh"
1742 mode=5
1743 frequency=2437
1744 key_mgmt=NONE
1745}
1746
1747# secure (SAE + AMPE) network
1748network={
1749 ssid="secure mesh"
1750 mode=5
1751 frequency=2437
1752 key_mgmt=SAE
1753 psk="very secret passphrase"
6fc6879b
JM
1754}
1755
1756
1757# Catch all example that allows more or less all configuration modes
1758network={
1759 ssid="example"
1760 scan_ssid=1
1761 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1762 pairwise=CCMP TKIP
1763 group=CCMP TKIP WEP104 WEP40
1764 psk="very secret passphrase"
1765 eap=TTLS PEAP TLS
1766 identity="user@example.com"
1767 password="foobar"
1768 ca_cert="/etc/cert/ca.pem"
1769 client_cert="/etc/cert/user.pem"
1770 private_key="/etc/cert/user.prv"
1771 private_key_passwd="password"
1772 phase1="peaplabel=0"
1773}
1774
1775# Example of EAP-TLS with smartcard (openssl engine)
1776network={
1777 ssid="example"
1778 key_mgmt=WPA-EAP
1779 eap=TLS
1780 proto=RSN
1781 pairwise=CCMP TKIP
1782 group=CCMP TKIP
1783 identity="user@example.com"
1784 ca_cert="/etc/cert/ca.pem"
6fc6879b 1785
f7cb6e9f
DW
1786 # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1787 client_cert="pkcs11:manufacturer=piv_II;id=%01"
1788 private_key="pkcs11:manufacturer=piv_II;id=%01"
6fc6879b
JM
1789
1790 # Optional PIN configuration; this can be left out and PIN will be
1791 # asked through the control interface
1792 pin="1234"
1793}
1794
1795# Example configuration showing how to use an inlined blob as a CA certificate
1796# data instead of using external file
1797network={
1798 ssid="example"
1799 key_mgmt=WPA-EAP
1800 eap=TTLS
1801 identity="user@example.com"
1802 anonymous_identity="anonymous@example.com"
1803 password="foobar"
1804 ca_cert="blob://exampleblob"
1805 priority=20
1806}
1807
1808blob-base64-exampleblob={
1809SGVsbG8gV29ybGQhCg==
1810}
1811
1812
1813# Wildcard match for SSID (plaintext APs only). This example select any
1814# open AP regardless of its SSID.
1815network={
1816 key_mgmt=NONE
1817}
f5ffc348 1818
b83e4554
ST
1819# Example configuration blacklisting two APs - these will be ignored
1820# for this network.
1821network={
1822 ssid="example"
1823 psk="very secret passphrase"
1824 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1825}
1826
1827# Example configuration limiting AP selection to a specific set of APs;
79cd993a 1828# any other AP not matching the masked address will be ignored.
b83e4554
ST
1829network={
1830 ssid="example"
1831 psk="very secret passphrase"
79cd993a 1832 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 1833}
f5ffc348
BG
1834
1835# Example config file that will only scan on channel 36.
1836freq_list=5180
1837network={
1838 key_mgmt=NONE
1839}
dd10abcc
HW
1840
1841
208263c0
JK
1842# Example configuration using EAP-TTLS for authentication and key
1843# generation for MACsec
1844network={
1845 key_mgmt=IEEE8021X
1846 eap=TTLS
1847 phase2="auth=PAP"
1848 anonymous_identity="anonymous@example.com"
1849 identity="user@example.com"
1850 password="secretr"
1851 ca_cert="/etc/cert/ca.pem"
1852 eapol_flags=0
1853 macsec_policy=1
1854}
1855
1856# Example configuration for MACsec with preshared key
1857network={
1858 key_mgmt=NONE
1859 eapol_flags=0
1860 macsec_policy=1
1861 mka_cak=0123456789ABCDEF0123456789ABCDEF
1862 mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
1863 mka_priority=128
1864}