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