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