blob: c1bcbd49d164cb7bb24f6fca26d51d708154d16d [file] [log] [blame]
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001##### Example wpa_supplicant configuration file ###############################
2#
3# This file describes configuration file format and lists all available option.
4# Please also take a look at simpler configuration examples in 'examples'
5# subdirectory.
6#
7# Empty lines and lines starting with # are ignored
8
9# NOTE! This file may contain password information and should probably be made
10# readable only by root user on multiuser systems.
11
12# Note: All file paths in this configuration file should use full (absolute,
13# not relative to working directory) path in order to allow working directory
14# to be changed. This can happen if wpa_supplicant is run in the background.
15
16# Whether to allow wpa_supplicant to update (overwrite) configuration
17#
18# This option can be used to allow wpa_supplicant to overwrite configuration
19# file whenever configuration is changed (e.g., new network block is added with
20# wpa_cli or wpa_gui, or a password is changed). This is required for
21# wpa_cli/wpa_gui to be able to store the configuration changes permanently.
22# Please note that overwriting configuration file will remove the comments from
23# it.
24#update_config=1
25
26# global configuration (shared by all network blocks)
27#
28# Parameters for the control interface. If this is specified, wpa_supplicant
29# will open a control interface that is available for external programs to
30# manage wpa_supplicant. The meaning of this string depends on which control
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -080031# interface mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt30f94812012-02-21 17:02:48 -080032# in configuration is used to determine whether the control interface is
33# enabled.
34#
35# For UNIX domain sockets (default on Linux and BSD): This is a directory that
36# will be created for UNIX domain sockets for listening to requests from
37# external programs (CLI/GUI, etc.) for status information and configuration.
38# The socket file will be named based on the interface name, so multiple
39# wpa_supplicant processes can be run at the same time if more than one
40# interface is used.
41# /var/run/wpa_supplicant is the recommended directory for sockets and by
42# default, wpa_cli will use it when trying to connect with wpa_supplicant.
43#
44# Access control for the control interface can be configured by setting the
45# directory to allow only members of a group to use sockets. This way, it is
46# possible to run wpa_supplicant as root (since it needs to change network
47# configuration and open raw sockets) and still allow GUI/CLI components to be
48# run as non-root users. However, since the control interface can be used to
49# change the network configuration, this access needs to be protected in many
50# cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
51# want to allow non-root users to use the control interface, add a new group
52# and change this value to match with that group. Add users that should have
53# control interface access to this group. If this variable is commented out or
54# not included in the configuration file, group will not be changed from the
55# value it got by default when the directory or socket was created.
56#
57# When configuring both the directory and group, use following format:
58# DIR=/var/run/wpa_supplicant GROUP=wheel
59# DIR=/var/run/wpa_supplicant GROUP=0
60# (group can be either group name or gid)
61#
62# For UDP connections (default on Windows): The value will be ignored. This
63# variable is just used to select that the control interface is to be created.
64# The value can be set to, e.g., udp (ctrl_interface=udp)
65#
66# For Windows Named Pipe: This value can be used to set the security descriptor
67# for controlling access to the control interface. Security descriptor can be
68# set using Security Descriptor String Format (see http://msdn.microsoft.com/
69# library/default.asp?url=/library/en-us/secauthz/security/
70# security_descriptor_string_format.asp). The descriptor string needs to be
71# prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
72# DACL (which will reject all connections). See README-Windows.txt for more
73# information about SDDL string format.
74#
75ctrl_interface=/var/run/wpa_supplicant
76
77# IEEE 802.1X/EAPOL version
78# wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
79# EAPOL version 2. However, there are many APs that do not handle the new
80# version number correctly (they seem to drop the frames completely). In order
81# to make wpa_supplicant interoperate with these APs, the version number is set
82# to 1 by default. This configuration value can be used to set it to the new
83# version (2).
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -070084# Note: When using MACsec, eapol_version shall be set to 3, which is
85# defined in IEEE Std 802.1X-2010.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070086eapol_version=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -080087
88# AP scanning/selection
89# By default, wpa_supplicant requests driver to perform AP scanning and then
90# uses the scan results to select a suitable AP. Another alternative is to
91# allow the driver to take care of AP scanning and selection and use
92# wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
93# information from the driver.
94# 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
95# the currently enabled networks are found, a new network (IBSS or AP mode
96# operation) may be initialized (if configured) (default)
97# 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
98# parameters (e.g., WPA IE generation); this mode can also be used with
99# non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
100# APs (i.e., external program needs to control association). This mode must
101# also be used when using wired Ethernet drivers.
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700102# Note: macsec_qca driver is one type of Ethernet driver which implements
103# macsec feature.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800104# 2: like 0, but associate with APs using security policy and SSID (but not
105# BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
106# enable operation with hidden SSIDs and optimized roaming; in this mode,
107# the network blocks in the configuration file are tried one by one until
108# the driver reports successful association; each network block should have
109# explicit security policy (i.e., only one option in the lists) for
110# key_mgmt, pairwise, group, proto variables
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.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700115ap_scan=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800116
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800117# 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
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
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800130# 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
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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800141# 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.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700145fast_reauth=1
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800146
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
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800159# 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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800169# 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
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
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
194# Wi-Fi Protected Setup (WPS) parameters
195
196# Universally Unique IDentifier (UUID; see RFC 4122) of the device
197# If not configured, UUID will be generated based on the local MAC address.
198#uuid=12345678-9abc-def0-1234-56789abcdef0
199
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)
231#device_type=1-0050F204-1
232
233# OS Version
234# 4-octet operating system version number (hex string)
235#os_version=01020300
236
237# Config Methods
238# List of the supported configuration methods
239# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
240# nfc_interface push_button keypad virtual_display physical_display
241# virtual_push_button physical_push_button
242# For WSC 1.0:
243#config_methods=label display push_button keypad
244# For WSC 2.0:
245#config_methods=label virtual_display virtual_push_button keypad
246
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
254
Dmitry Shmidt04949592012-07-19 12:16:46 -0700255# 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
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
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800271# Maximum number of BSS entries to keep in memory
272# Default: 200
273# This can be used to limit memory use on the BSS entries (cached scan
274# results). A larger value may be needed in environments that have huge number
275# of APs when using ap_scan=1 mode.
276#bss_max_count=200
277
Dmitry Shmidt04949592012-07-19 12:16:46 -0700278# Automatic scan
279# This is an optional set of parameters for automatic scanning
280# within an interface in following format:
281#autoscan=<autoscan module name>:<module parameters>
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800282# autoscan is like bgscan but on disconnected or inactive state.
283# For instance, on exponential module parameters would be <base>:<limit>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700284#autoscan=exponential:3:300
285# Which means a delay between scans on a base exponential of 3,
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800286# up to the limit of 300 seconds (3, 9, 27 ... 300)
287# For periodic module, parameters would be <fixed interval>
Dmitry Shmidt04949592012-07-19 12:16:46 -0700288#autoscan=periodic:30
Dmitry Shmidtcce06662013-11-04 18:44:24 -0800289# So a delay of 30 seconds will be applied between each scan
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800290
291# filter_ssids - SSID-based scan result filtering
292# 0 = do not filter scan results (default)
293# 1 = only include configured SSIDs in scan results/BSS table
294#filter_ssids=0
295
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700296# Password (and passphrase, etc.) backend for external storage
297# format: <backend name>[:<optional backend parameters>]
298#ext_password_backend=test:pw1=password|pw2=testing
299
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700300
301# Disable P2P functionality
302# p2p_disabled=1
303
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700304# Timeout in seconds to detect STA inactivity (default: 300 seconds)
305#
306# This timeout value is used in P2P GO mode to clean up
307# inactive stations.
308#p2p_go_max_inactivity=300
309
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700310# Passphrase length (8..63) for P2P GO
311#
312# This parameter controls the length of the random passphrase that is
313# generated at the GO. Default: 8.
314#p2p_passphrase_len=8
315
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -0700316# Extra delay between concurrent P2P search iterations
317#
318# This value adds extra delay in milliseconds between concurrent search
319# iterations to make p2p_find friendlier to concurrent operations by avoiding
320# it from taking 100% of radio resources. The default value is 500 ms.
321#p2p_search_delay=500
322
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800323# Opportunistic Key Caching (also known as Proactive Key Caching) default
324# This parameter can be used to set the default behavior for the
325# proactive_key_caching parameter. By default, OKC is disabled unless enabled
326# with the global okc=1 parameter or with the per-network
327# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
328# can be disabled with per-network proactive_key_caching=0 parameter.
329#okc=0
330
331# Protected Management Frames default
332# This parameter can be used to set the default behavior for the ieee80211w
333# parameter. By default, PMF is disabled unless enabled with the global pmf=1/2
334# parameter or with the per-network ieee80211w=1/2 parameter. With pmf=1/2, PMF
335# is enabled/required by default, but can be disabled with the per-network
336# ieee80211w parameter.
337#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800338
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800339# Enabled SAE finite cyclic groups in preference order
340# By default (if this parameter is not set), the mandatory group 19 (ECC group
341# defined over a 256-bit prime order field) is preferred, but other groups are
342# also enabled. If this parameter is set, the groups will be tried in the
343# indicated order. The group values are listed in the IANA registry:
344# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
345#sae_groups=21 20 19 26 25
346
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800347# Default value for DTIM period (if not overridden in network block)
348#dtim_period=2
349
350# Default value for Beacon interval (if not overridden in network block)
351#beacon_int=100
352
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700353# Additional vendor specific elements for Beacon and Probe Response frames
354# This parameter can be used to add additional vendor specific element(s) into
355# the end of the Beacon and Probe Response frames. The format for these
356# element(s) is a hexdump of the raw information elements (id+len+payload for
357# one or more elements). This is used in AP and P2P GO modes.
358#ap_vendor_elements=dd0411223301
359
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700360# Ignore scan results older than request
361#
362# The driver may have a cache of scan results that makes it return
363# information that is older than our scan trigger. This parameter can
364# be used to configure such old information to be ignored instead of
365# allowing it to update the internal BSS table.
366#ignore_old_scan_res=0
367
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700368# scan_cur_freq: Whether to scan only the current frequency
369# 0: Scan all available frequencies. (Default)
370# 1: Scan current operating frequency if another VIF on the same radio
371# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700372
Dmitry Shmidt661b4f72014-09-29 14:58:27 -0700373# MAC address policy default
374# 0 = use permanent MAC address
375# 1 = use random MAC address for each ESS connection
376# 2 = like 1, but maintain OUI (with local admin bit set)
377#
378# By default, permanent MAC address is used unless policy is changed by
379# the per-network mac_addr parameter. Global mac_addr=1 can be used to
380# change this default behavior.
381#mac_addr=0
382
383# Lifetime of random MAC address in seconds (default: 60)
384#rand_addr_lifetime=60
385
386# MAC address policy for pre-association operations (scanning, ANQP)
387# 0 = use permanent MAC address
388# 1 = use random MAC address
389# 2 = like 1, but maintain OUI (with local admin bit set)
390#preassoc_mac_addr=0
391
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800392# Interworking (IEEE 802.11u)
393
394# Enable Interworking
395# interworking=1
396
397# Homogenous ESS identifier
398# If this is set, scans will be used to request response only from BSSes
399# belonging to the specified Homogeneous ESS. This is used only if interworking
400# is enabled.
401# hessid=00:11:22:33:44:55
402
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700403# Automatic network selection behavior
404# 0 = do not automatically go through Interworking network selection
405# (i.e., require explicit interworking_select command for this; default)
406# 1 = perform Interworking network selection if one or more
407# credentials have been configured and scan did not find a
408# matching network block
409#auto_interworking=0
410
Dmitry Shmidt04949592012-07-19 12:16:46 -0700411# credential block
412#
413# Each credential used for automatic network selection is configured as a set
414# of parameters that are compared to the information advertised by the APs when
415# interworking_select and interworking_connect commands are used.
416#
417# credential fields:
418#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800419# temporary: Whether this credential is temporary and not to be saved
420#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700421# priority: Priority group
422# By default, all networks and credentials get the same priority group
423# (0). This field can be used to give higher priority for credentials
424# (and similarly in struct wpa_ssid for network blocks) to change the
425# Interworking automatic networking selection behavior. The matching
426# network (based on either an enabled network block or a credential)
427# with the highest priority value will be selected.
428#
429# pcsc: Use PC/SC and SIM/USIM card
430#
431# realm: Home Realm for Interworking
432#
433# username: Username for Interworking network selection
434#
435# password: Password for Interworking network selection
436#
437# ca_cert: CA certificate for Interworking network selection
438#
439# client_cert: File path to client certificate file (PEM/DER)
440# This field is used with Interworking networking selection for a case
441# where client certificate/private key is used for authentication
442# (EAP-TLS). Full path to the file should be used since working
443# directory may change when wpa_supplicant is run in the background.
444#
445# Alternatively, a named configuration blob can be used by setting
446# this to blob://blob_name.
447#
448# private_key: File path to client private key file (PEM/DER/PFX)
449# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
450# commented out. Both the private key and certificate will be read
451# from the PKCS#12 file in this case. Full path to the file should be
452# used since working directory may change when wpa_supplicant is run
453# in the background.
454#
455# Windows certificate store can be used by leaving client_cert out and
456# configuring private_key in one of the following formats:
457#
458# cert://substring_to_match
459#
460# hash://certificate_thumbprint_in_hex
461#
462# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
463#
464# Note that when running wpa_supplicant as an application, the user
465# certificate store (My user account) is used, whereas computer store
466# (Computer account) is used when running wpasvc as a service.
467#
468# Alternatively, a named configuration blob can be used by setting
469# this to blob://blob_name.
470#
471# private_key_passwd: Password for private key file
472#
473# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
474#
475# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
476# format
477#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700478# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700479# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700480# whether the AP is operated by the Home SP. Multiple domain entries can
481# be used to configure alternative FQDNs that will be considered home
482# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700483#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700484# roaming_consortium: Roaming Consortium OI
485# If roaming_consortium_len is non-zero, this field contains the
486# Roaming Consortium OI that can be used to determine which access
487# points support authentication with this credential. This is an
488# alternative to the use of the realm parameter. When using Roaming
489# Consortium to match the network, the EAP parameters need to be
490# pre-configured with the credential since the NAI Realm information
491# may not be available or fetched.
492#
493# eap: Pre-configured EAP method
494# This optional field can be used to specify which EAP method will be
495# used with this credential. If not set, the EAP method is selected
496# automatically based on ANQP information (e.g., NAI Realm).
497#
498# phase1: Pre-configure Phase 1 (outer authentication) parameters
499# This optional field is used with like the 'eap' parameter.
500#
501# phase2: Pre-configure Phase 2 (inner authentication) parameters
502# This optional field is used with like the 'eap' parameter.
503#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800504# excluded_ssid: Excluded SSID
505# This optional field can be used to excluded specific SSID(s) from
506# matching with the network. Multiple entries can be used to specify more
507# than one SSID.
508#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800509# roaming_partner: Roaming partner information
510# This optional field can be used to configure preferences between roaming
511# partners. The field is a string in following format:
512# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
513# (non-exact match means any subdomain matches the entry; priority is in
514# 0..255 range with 0 being the highest priority)
515#
516# update_identifier: PPS MO ID
517# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
518#
519# provisioning_sp: FQDN of the SP that provisioned the credential
520# This optional field can be used to keep track of the SP that provisioned
521# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
522#
523# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
524# These fields can be used to specify minimum download/upload backhaul
525# bandwidth that is preferred for the credential. This constraint is
526# ignored if the AP does not advertise WAN Metrics information or if the
527# limit would prevent any connection. Values are in kilobits per second.
528# min_dl_bandwidth_home
529# min_ul_bandwidth_home
530# min_dl_bandwidth_roaming
531# min_ul_bandwidth_roaming
532#
533# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
534# (PPS/<X+>/Policy/MaximumBSSLoadValue)
535# This value is used as the maximum channel utilization for network
536# selection purposes for home networks. If the AP does not advertise
537# BSS Load or if the limit would prevent any connection, this constraint
538# will be ignored.
539#
540# req_conn_capab: Required connection capability
541# (PPS/<X+>/Policy/RequiredProtoPortTuple)
542# This value is used to configure set of required protocol/port pairs that
543# a roaming network shall support (include explicitly in Connection
544# Capability ANQP element). This constraint is ignored if the AP does not
545# advertise Connection Capability or if this constraint would prevent any
546# network connection. This policy is not used in home networks.
547# Format: <protocol>[:<comma-separated list of ports]
548# Multiple entries can be used to list multiple requirements.
549# For example, number of common TCP protocols:
550# req_conn_capab=6,22,80,443
551# For example, IPSec/IKE:
552# req_conn_capab=17:500
553# req_conn_capab=50
554#
555# ocsp: Whether to use/require OCSP to check server certificate
556# 0 = do not use OCSP stapling (TLS certificate status extension)
557# 1 = try to use OCSP stapling, but not require response
558# 2 = require valid OCSP stapling response
559#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700560# sim_num: Identifier for which SIM to use in multi-SIM devices
561#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700562# for example:
563#
564#cred={
565# realm="example.com"
566# username="user@example.com"
567# password="password"
568# ca_cert="/etc/wpa_supplicant/ca.pem"
569# domain="example.com"
570#}
571#
572#cred={
573# imsi="310026-000000000"
574# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
575#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700576#
577#cred={
578# realm="example.com"
579# username="user"
580# password="password"
581# ca_cert="/etc/wpa_supplicant/ca.pem"
582# domain="example.com"
583# roaming_consortium=223344
584# eap=TTLS
585# phase2="auth=MSCHAPV2"
586#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800587
Dmitry Shmidt04949592012-07-19 12:16:46 -0700588# Hotspot 2.0
589# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800590
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800591# network block
592#
593# Each network (usually AP's sharing the same SSID) is configured as a separate
594# block in this configuration file. The network blocks are in preference order
595# (the first match is used).
596#
597# network block fields:
598#
599# disabled:
600# 0 = this network can be used (default)
601# 1 = this network block is disabled (can be enabled through ctrl_iface,
602# e.g., with wpa_cli or wpa_gui)
603#
604# id_str: Network identifier string for external scripts. This value is passed
605# to external action script through wpa_cli as WPA_ID_STR environment
606# variable to make it easier to do network specific configuration.
607#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700608# ssid: SSID (mandatory); network name in one of the optional formats:
609# - an ASCII string with double quotation
610# - a hex string (two characters per octet of SSID)
611# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800612#
613# scan_ssid:
614# 0 = do not scan this SSID with specific Probe Request frames (default)
615# 1 = scan with SSID-specific Probe Request frames (this can be used to
616# find APs that do not accept broadcast SSID or use multiple SSIDs;
617# this will add latency to scanning, so enable this only when needed)
618#
619# bssid: BSSID (optional); if set, this network block is used only when
620# associating with the AP using the configured BSSID
621#
622# priority: priority group (integer)
623# By default, all networks will get same priority group (0). If some of the
624# networks are more desirable, this field can be used to change the order in
625# which wpa_supplicant goes through the networks when selecting a BSS. The
626# priority groups will be iterated in decreasing priority (i.e., the larger the
627# priority value, the sooner the network is matched against the scan results).
628# Within each priority group, networks will be selected based on security
629# policy, signal strength, etc.
630# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
631# using this priority to select the order for scanning. Instead, they try the
632# networks in the order that used in the configuration file.
633#
634# mode: IEEE 802.11 operation mode
635# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
636# 1 = IBSS (ad-hoc, peer-to-peer)
637# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800638# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
639# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
640# TKIP/CCMP) is available for backwards compatibility, but its use is
641# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800642# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
643# both), and psk must also be set.
644#
645# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
646# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
647# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
648# In addition, this value is only used by the station that creates the IBSS. If
649# an IBSS network with the configured SSID is already present, the frequency of
650# the network will be used instead of this configured value.
651#
652# scan_freq: List of frequencies to scan
653# Space-separated list of frequencies in MHz to scan when searching for this
654# BSS. If the subset of channels used by the network is known, this option can
655# be used to optimize scanning to not occur on channels that the network does
656# not use. Example: scan_freq=2412 2437 2462
657#
658# freq_list: Array of allowed frequencies
659# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
660# set, scan results that do not match any of the specified frequencies are not
661# considered when selecting a BSS.
662#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700663# This can also be set on the outside of the network block. In this case,
664# it limits the frequencies that will be scanned.
665#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800666# bgscan: Background scanning
667# wpa_supplicant behavior for background scanning can be specified by
668# configuring a bgscan module. These modules are responsible for requesting
669# background scans for the purpose of roaming within an ESS (i.e., within a
670# single network block with all the APs using the same SSID). The bgscan
671# parameter uses following format: "<bgscan module name>:<module parameters>"
672# Following bgscan modules are available:
673# simple - Periodic background scans based on signal strength
674# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
675# <long interval>"
676# bgscan="simple:30:-45:300"
677# learn - Learn channels used by the network and try to avoid bgscans on other
678# channels (experimental)
679# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
680# <long interval>[:<database file name>]"
681# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800682# Explicitly disable bgscan by setting
683# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800684#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800685# This option can also be set outside of all network blocks for the bgscan
686# parameter to apply for all the networks that have no specific bgscan
687# parameter.
688#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800689# proto: list of accepted protocols
690# WPA = WPA/IEEE 802.11i/D3.0
691# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
692# If not set, this defaults to: WPA RSN
693#
694# key_mgmt: list of accepted authenticated key management protocols
695# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
696# WPA-EAP = WPA using EAP authentication
697# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
698# generated WEP keys
699# NONE = WPA is not used; plaintext or static WEP could be used
700# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
701# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
702# If not set, this defaults to: WPA-PSK WPA-EAP
703#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700704# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800705# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700706# 1 = optional
707# 2 = required
708# The most common configuration options for this based on the PMF (protected
709# management frames) certification program are:
710# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
711# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
712# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
713#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800714# auth_alg: list of allowed IEEE 802.11 authentication algorithms
715# OPEN = Open System authentication (required for WPA/WPA2)
716# SHARED = Shared Key authentication (requires static WEP keys)
717# LEAP = LEAP/Network EAP (only used with LEAP)
718# If not set, automatic selection is used (Open System with LEAP enabled if
719# LEAP is allowed as one of the EAP methods).
720#
721# pairwise: list of accepted pairwise (unicast) ciphers for WPA
722# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
723# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
724# NONE = Use only Group Keys (deprecated, should not be included if APs support
725# pairwise keys)
726# If not set, this defaults to: CCMP TKIP
727#
728# group: list of accepted group (broadcast/multicast) ciphers for WPA
729# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
730# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
731# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
732# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
733# If not set, this defaults to: CCMP TKIP WEP104 WEP40
734#
735# psk: WPA preshared key; 256-bit pre-shared key
736# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
737# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
738# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700739# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
740# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800741# This field is not needed, if WPA-EAP is used.
742# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
743# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
744# startup and reconfiguration time can be optimized by generating the PSK only
745# only when the passphrase or SSID has actually changed.
746#
Dmitry Shmidt912c6ec2015-03-30 13:16:51 -0700747# mem_only_psk: Whether to keep PSK/passphrase only in memory
748# 0 = allow psk/passphrase to be stored to the configuration file
749# 1 = do not store psk/passphrase to the configuration file
750#mem_only_psk=0
751#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800752# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
753# Dynamic WEP key required for non-WPA mode
754# bit0 (1): require dynamically generated unicast WEP key
755# bit1 (2): require dynamically generated broadcast WEP key
756# (3 = require both keys; default)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700757# Note: When using wired authentication (including macsec_qca driver),
758# eapol_flags must be set to 0 for the authentication to be completed
759# successfully.
760#
761# macsec_policy: IEEE 802.1X/MACsec options
762# This determines how sessions are secured with MACsec. It is currently
763# applicable only when using the macsec_qca driver interface.
764# 0: MACsec not in use (default)
765# 1: MACsec enabled - Should secure, accept key server's advice to
766# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800767#
768# mixed_cell: This option can be used to configure whether so called mixed
769# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800770# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800771# 0 = disabled (default)
772# 1 = enabled
773#
774# proactive_key_caching:
775# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800776# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800777# 1 = enabled
778#
779# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
780# hex without quotation, e.g., 0102030405)
781# wep_tx_keyidx: Default WEP key index (TX) (0..3)
782#
783# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
784# allowed. This is only used with RSN/WPA2.
785# 0 = disabled (default)
786# 1 = enabled
787#peerkey=1
788#
789# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
790# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
791#
792# Following fields are only used with internal EAP implementation.
793# eap: space-separated list of accepted EAP methods
794# MD5 = EAP-MD5 (unsecure and does not generate keying material ->
795# cannot be used with WPA; to be used as a Phase 2 method
796# with EAP-PEAP or EAP-TTLS)
797# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
798# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
799# OTP = EAP-OTP (cannot be used separately with WPA; to be used
800# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
801# GTC = EAP-GTC (cannot be used separately with WPA; to be used
802# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
803# TLS = EAP-TLS (client and server certificate)
804# PEAP = EAP-PEAP (with tunnelled EAP authentication)
805# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
806# authentication)
807# If not set, all compiled in methods are allowed.
808#
809# identity: Identity string for EAP
810# This field is also used to configure user NAI for
811# EAP-PSK/PAX/SAKE/GPSK.
812# anonymous_identity: Anonymous identity string for EAP (to be used as the
813# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700814# identity, e.g., EAP-TTLS). This field can also be used with
815# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800816# password: Password string for EAP. This field can include either the
817# plaintext password (using ASCII or hex string) or a NtPasswordHash
818# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
819# NtPasswordHash can only be used when the password is for MSCHAPv2 or
820# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
821# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
822# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700823# variable length PSK. ext:<name of external password field> format can
824# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800825# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
826# or more trusted CA certificates. If ca_cert and ca_path are not
827# included, server certificate will not be verified. This is insecure and
828# a trusted CA certificate should always be configured when using
829# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
830# change when wpa_supplicant is run in the background.
831#
832# Alternatively, this can be used to only perform matching of the server
833# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
834# this case, the possible CA certificates in the server certificate chain
835# are ignored and only the server certificate is verified. This is
836# configured with the following format:
837# hash:://server/sha256/cert_hash_in_hex
838# For example: "hash://server/sha256/
839# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
840#
841# On Windows, trusted CA certificates can be loaded from the system
842# certificate store by setting this to cert_store://<name>, e.g.,
843# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
844# Note that when running wpa_supplicant as an application, the user
845# certificate store (My user account) is used, whereas computer store
846# (Computer account) is used when running wpasvc as a service.
847# ca_path: Directory path for CA certificate files (PEM). This path may
848# contain multiple CA certificates in OpenSSL format. Common use for this
849# is to point to system trusted CA list which is often installed into
850# directory like /etc/ssl/certs. If configured, these certificates are
851# added to the list of trusted CAs. ca_cert may also be included in that
852# case, but it is not required.
853# client_cert: File path to client certificate file (PEM/DER)
854# Full path should be used since working directory may change when
855# wpa_supplicant is run in the background.
856# Alternatively, a named configuration blob can be used by setting this
857# to blob://<blob name>.
858# private_key: File path to client private key file (PEM/DER/PFX)
859# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
860# commented out. Both the private key and certificate will be read from
861# the PKCS#12 file in this case. Full path should be used since working
862# directory may change when wpa_supplicant is run in the background.
863# Windows certificate store can be used by leaving client_cert out and
864# configuring private_key in one of the following formats:
865# cert://substring_to_match
866# hash://certificate_thumbprint_in_hex
867# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
868# Note that when running wpa_supplicant as an application, the user
869# certificate store (My user account) is used, whereas computer store
870# (Computer account) is used when running wpasvc as a service.
871# Alternatively, a named configuration blob can be used by setting this
872# to blob://<blob name>.
873# private_key_passwd: Password for private key file (if left out, this will be
874# asked through control interface)
875# dh_file: File path to DH/DSA parameters file (in PEM format)
876# This is an optional configuration file for setting parameters for an
877# ephemeral DH key exchange. In most cases, the default RSA
878# authentication does not use this configuration. However, it is possible
879# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
880# DSA keys always use ephemeral DH keys. This can be used to achieve
881# forward secrecy. If the file is in DSA parameters format, it will be
882# automatically converted into DH params.
883# subject_match: Substring to be matched against the subject of the
884# authentication server certificate. If this string is set, the server
885# sertificate is only accepted if it contains this string in the subject.
886# The subject string is in following format:
887# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
Dmitry Shmidtff787d52015-01-12 13:01:47 -0800888# Note: Since this is a substring match, this cannot be used securily to
889# do a suffix match against a possible domain name in the CN entry. For
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800890# such a use case, domain_suffix_match or domain_match should be used
891# instead.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800892# altsubject_match: Semicolon separated string of entries to be matched against
893# the alternative subject name of the authentication server certificate.
894# If this string is set, the server sertificate is only accepted if it
895# contains one of the entries in an alternative subject name extension.
896# altSubjectName string is in following format: TYPE:VALUE
897# Example: EMAIL:server@example.com
898# Example: DNS:server.example.com;DNS:server2.example.com
899# Following types are supported: EMAIL, DNS, URI
Dmitry Shmidtff787d52015-01-12 13:01:47 -0800900# domain_suffix_match: Constraint for server domain name. If set, this FQDN is
901# used as a suffix match requirement for the AAAserver certificate in
902# SubjectAltName dNSName element(s). If a matching dNSName is found, this
903# constraint is met. If no dNSName values are present, this constraint is
904# matched against SubjectName CN using same suffix match comparison.
905#
906# Suffix match here means that the host/domain name is compared one label
907# at a time starting from the top-level domain and all the labels in
908# domain_suffix_match shall be included in the certificate. The
909# certificate may include additional sub-level labels in addition to the
910# required labels.
911#
912# For example, domain_suffix_match=example.com would match
913# test.example.com but would not match test-example.com.
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800914# domain_match: Constraint for server domain name
915# If set, this FQDN is used as a full match requirement for the
916# server certificate in SubjectAltName dNSName element(s). If a
917# matching dNSName is found, this constraint is met. If no dNSName
918# values are present, this constraint is matched against SubjectName CN
919# using same full match comparison. This behavior is similar to
920# domain_suffix_match, but has the requirement of a full match, i.e.,
921# no subdomains or wildcard matches are allowed. Case-insensitive
922# comparison is used, so "Example.com" matches "example.com", but would
923# not match "test.Example.com".
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800924# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
925# (string with field-value pairs, e.g., "peapver=0" or
926# "peapver=1 peaplabel=1")
927# 'peapver' can be used to force which PEAP version (0 or 1) is used.
928# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
929# to be used during key derivation when PEAPv1 or newer. Most existing
930# PEAPv1 implementation seem to be using the old label, "client EAP
931# encryption", and wpa_supplicant is now using that as the default value.
932# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
933# interoperate with PEAPv1; see eap_testing.txt for more details.
934# 'peap_outer_success=0' can be used to terminate PEAP authentication on
935# tunneled EAP-Success. This is required with some RADIUS servers that
936# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
937# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
938# include_tls_length=1 can be used to force wpa_supplicant to include
939# TLS Message Length field in all TLS messages even if they are not
940# fragmented.
941# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
942# challenges (by default, it accepts 2 or 3)
943# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
944# protected result indication.
945# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
946# behavior:
947# * 0 = do not use cryptobinding (default)
948# * 1 = use cryptobinding if server supports it
949# * 2 = require cryptobinding
950# EAP-WSC (WPS) uses following options: pin=<Device Password> or
951# pbc=1.
Dmitry Shmidt216983b2015-02-06 10:50:36 -0800952#
953# For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
954# used to configure a mode that allows EAP-Success (and EAP-Failure)
955# without going through authentication step. Some switches use such
956# sequence when forcing the port to be authorized/unauthorized or as a
957# fallback option if the authentication server is unreachable. By default,
958# wpa_supplicant discards such frames to protect against potential attacks
959# by rogue devices, but this option can be used to disable that protection
960# for cases where the server/authenticator does not need to be
961# authenticated.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800962# phase2: Phase2 (inner authentication with TLS tunnel) parameters
963# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
Dmitry Shmidt216983b2015-02-06 10:50:36 -0800964# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
965# used to disable MSCHAPv2 password retry in authentication failure cases.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700966#
967# TLS-based methods can use the following parameters to control TLS behavior
968# (these are normally in the phase1 parameter, but can be used also in the
969# phase2 parameter when EAP-TLS is used within the inner tunnel):
970# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
971# TLS library, these may be disabled by default to enforce stronger
972# security)
973# tls_disable_time_checks=1 - ignore certificate validity time (this requests
974# the TLS library to accept certificates even if they are not currently
975# valid, i.e., have expired or have not yet become valid; this should be
976# used only for testing purposes)
977# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
978# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
979# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
980# as a workaround for broken authentication server implementations unless
Dmitry Shmidtaf9da312015-04-03 10:03:11 -0700981# EAP workarounds are disabled with eap_workaround=0.
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700982# For EAP-FAST, this must be set to 0 (or left unconfigured for the
983# default value to be used automatically).
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -0800984# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
985# that have issues interoperating with updated TLS version)
986# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
987# that have issues interoperating with updated TLS version)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700988#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800989# Following certificate/private key fields are used in inner Phase2
990# authentication when using EAP-TTLS or EAP-PEAP.
991# ca_cert2: File path to CA certificate file. This file can have one or more
992# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
993# server certificate will not be verified. This is insecure and a trusted
994# CA certificate should always be configured.
995# ca_path2: Directory path for CA certificate files (PEM)
996# client_cert2: File path to client certificate file
997# private_key2: File path to client private key file
998# private_key2_passwd: Password for private key file
999# dh_file2: File path to DH/DSA parameters file (in PEM format)
1000# subject_match2: Substring to be matched against the subject of the
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001001# authentication server certificate. See subject_match for more details.
1002# altsubject_match2: Semicolon separated string of entries to be matched
1003# against the alternative subject name of the authentication server
1004# certificate. See altsubject_match documentation for more details.
1005# domain_suffix_match2: Constraint for server domain name. See
1006# domain_suffix_match for more details.
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001007#
1008# fragment_size: Maximum EAP fragment size in bytes (default 1398).
1009# This value limits the fragment size for EAP methods that support
1010# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1011# small enough to make the EAP messages fit in MTU of the network
1012# interface used for EAPOL. The default value is suitable for most
1013# cases.
1014#
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001015# ocsp: Whether to use/require OCSP to check server certificate
1016# 0 = do not use OCSP stapling (TLS certificate status extension)
1017# 1 = try to use OCSP stapling, but not require response
1018# 2 = require valid OCSP stapling response
1019#
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001020# openssl_ciphers: OpenSSL specific cipher configuration
1021# This can be used to override the global openssl_ciphers configuration
1022# parameter (see above).
1023#
1024# erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1025#
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001026# EAP-FAST variables:
1027# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1028# to create this file and write updates to it when PAC is being
1029# provisioned or refreshed. Full path to the file should be used since
1030# working directory may change when wpa_supplicant is run in the
1031# background. Alternatively, a named configuration blob can be used by
1032# setting this to blob://<blob name>
1033# phase1: fast_provisioning option can be used to enable in-line provisioning
1034# of EAP-FAST credentials (PAC):
1035# 0 = disabled,
1036# 1 = allow unauthenticated provisioning,
1037# 2 = allow authenticated provisioning,
1038# 3 = allow both unauthenticated and authenticated provisioning
1039# fast_max_pac_list_len=<num> option can be used to set the maximum
1040# number of PAC entries to store in a PAC list (default: 10)
1041# fast_pac_format=binary option can be used to select binary format for
1042# storing PAC entries in order to save some space (the default
1043# text format uses about 2.5 times the size of minimal binary
1044# format)
1045#
1046# wpa_supplicant supports number of "EAP workarounds" to work around
1047# interoperability issues with incorrectly behaving authentication servers.
1048# These are enabled by default because some of the issues are present in large
1049# number of authentication servers. Strict EAP conformance mode can be
1050# configured by disabling workarounds with eap_workaround=0.
1051
Dmitry Shmidt04949592012-07-19 12:16:46 -07001052# Station inactivity limit
1053#
1054# If a station does not send anything in ap_max_inactivity seconds, an
1055# empty data frame is sent to it in order to verify whether it is
1056# still in range. If this frame is not ACKed, the station will be
1057# disassociated and then deauthenticated. This feature is used to
1058# clear station table of old entries when the STAs move out of the
1059# range.
1060#
1061# The station can associate again with the AP if it is still in range;
1062# this inactivity poll is just used as a nicer way of verifying
1063# inactivity; i.e., client will not report broken connection because
1064# disassociation frame is not sent immediately without first polling
1065# the STA with a data frame.
1066# default: 300 (i.e., 5 minutes)
1067#ap_max_inactivity=300
1068
1069# DTIM period in Beacon intervals for AP mode (default: 2)
1070#dtim_period=2
1071
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001072# Beacon interval (default: 100 TU)
1073#beacon_int=100
1074
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001075# MAC address policy
1076# 0 = use permanent MAC address
1077# 1 = use random MAC address for each ESS connection
1078# 2 = like 1, but maintain OUI (with local admin bit set)
1079#mac_addr=0
1080
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001081# disable_ht: Whether HT (802.11n) should be disabled.
1082# 0 = HT enabled (if AP supports it)
1083# 1 = HT disabled
1084#
1085# disable_ht40: Whether HT-40 (802.11n) should be disabled.
1086# 0 = HT-40 enabled (if AP supports it)
1087# 1 = HT-40 disabled
1088#
1089# disable_sgi: Whether SGI (short guard interval) should be disabled.
1090# 0 = SGI enabled (if AP supports it)
1091# 1 = SGI disabled
1092#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001093# disable_ldpc: Whether LDPC should be disabled.
1094# 0 = LDPC enabled (if AP supports it)
1095# 1 = LDPC disabled
1096#
Dmitry Shmidt61593f02014-04-21 16:27:35 -07001097# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1098# 0 = 40 MHz tolerant (default)
1099# 1 = 40 MHz intolerant
1100#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001101# ht_mcs: Configure allowed MCS rates.
1102# Parsed as an array of bytes, in base-16 (ascii-hex)
1103# ht_mcs="" // Use all available (default)
1104# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1105# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1106#
1107# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1108# -1 = Do not make any changes.
1109# 0 = Enable MAX-AMSDU if hardware supports it.
1110# 1 = Disable AMSDU
1111#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07001112# ampdu_factor: Maximum A-MPDU Length Exponent
1113# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1114#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001115# ampdu_density: Allow overriding AMPDU density configuration.
1116# Treated as hint by the kernel.
1117# -1 = Do not make any changes.
1118# 0-3 = Set AMPDU density (aka factor) to specified value.
1119
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001120# disable_vht: Whether VHT should be disabled.
1121# 0 = VHT enabled (if AP supports it)
1122# 1 = VHT disabled
1123#
1124# vht_capa: VHT capabilities to set in the override
1125# vht_capa_mask: mask of VHT capabilities
1126#
1127# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1128# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1129# 0: MCS 0-7
1130# 1: MCS 0-8
1131# 2: MCS 0-9
1132# 3: not supported
1133
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001134# Example blocks:
1135
1136# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1137network={
1138 ssid="simple"
1139 psk="very secret passphrase"
1140 priority=5
1141}
1142
1143# Same as previous, but request SSID-specific scanning (for APs that reject
1144# broadcast SSID)
1145network={
1146 ssid="second ssid"
1147 scan_ssid=1
1148 psk="very secret passphrase"
1149 priority=2
1150}
1151
1152# Only WPA-PSK is used. Any valid cipher combination is accepted.
1153network={
1154 ssid="example"
1155 proto=WPA
1156 key_mgmt=WPA-PSK
1157 pairwise=CCMP TKIP
1158 group=CCMP TKIP WEP104 WEP40
1159 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1160 priority=2
1161}
1162
1163# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1164network={
1165 ssid="example"
1166 proto=WPA
1167 key_mgmt=WPA-PSK
1168 pairwise=TKIP
1169 group=TKIP
1170 psk="not so secure passphrase"
1171 wpa_ptk_rekey=600
1172}
1173
1174# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1175# or WEP40 as the group cipher will not be accepted.
1176network={
1177 ssid="example"
1178 proto=RSN
1179 key_mgmt=WPA-EAP
1180 pairwise=CCMP TKIP
1181 group=CCMP TKIP
1182 eap=TLS
1183 identity="user@example.com"
1184 ca_cert="/etc/cert/ca.pem"
1185 client_cert="/etc/cert/user.pem"
1186 private_key="/etc/cert/user.prv"
1187 private_key_passwd="password"
1188 priority=1
1189}
1190
1191# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1192# (e.g., Radiator)
1193network={
1194 ssid="example"
1195 key_mgmt=WPA-EAP
1196 eap=PEAP
1197 identity="user@example.com"
1198 password="foobar"
1199 ca_cert="/etc/cert/ca.pem"
1200 phase1="peaplabel=1"
1201 phase2="auth=MSCHAPV2"
1202 priority=10
1203}
1204
1205# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1206# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1207network={
1208 ssid="example"
1209 key_mgmt=WPA-EAP
1210 eap=TTLS
1211 identity="user@example.com"
1212 anonymous_identity="anonymous@example.com"
1213 password="foobar"
1214 ca_cert="/etc/cert/ca.pem"
1215 priority=2
1216}
1217
1218# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1219# use. Real identity is sent only within an encrypted TLS tunnel.
1220network={
1221 ssid="example"
1222 key_mgmt=WPA-EAP
1223 eap=TTLS
1224 identity="user@example.com"
1225 anonymous_identity="anonymous@example.com"
1226 password="foobar"
1227 ca_cert="/etc/cert/ca.pem"
1228 phase2="auth=MSCHAPV2"
1229}
1230
1231# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1232# authentication.
1233network={
1234 ssid="example"
1235 key_mgmt=WPA-EAP
1236 eap=TTLS
1237 # Phase1 / outer authentication
1238 anonymous_identity="anonymous@example.com"
1239 ca_cert="/etc/cert/ca.pem"
1240 # Phase 2 / inner authentication
1241 phase2="autheap=TLS"
1242 ca_cert2="/etc/cert/ca2.pem"
1243 client_cert2="/etc/cer/user.pem"
1244 private_key2="/etc/cer/user.prv"
1245 private_key2_passwd="password"
1246 priority=2
1247}
1248
1249# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1250# group cipher.
1251network={
1252 ssid="example"
1253 bssid=00:11:22:33:44:55
1254 proto=WPA RSN
1255 key_mgmt=WPA-PSK WPA-EAP
1256 pairwise=CCMP
1257 group=CCMP
1258 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1259}
1260
1261# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1262# and all valid ciphers.
1263network={
1264 ssid=00010203
1265 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1266}
1267
1268
1269# EAP-SIM with a GSM SIM or USIM
1270network={
1271 ssid="eap-sim-test"
1272 key_mgmt=WPA-EAP
1273 eap=SIM
1274 pin="1234"
1275 pcsc=""
1276}
1277
1278
1279# EAP-PSK
1280network={
1281 ssid="eap-psk-test"
1282 key_mgmt=WPA-EAP
1283 eap=PSK
1284 anonymous_identity="eap_psk_user"
1285 password=06b4be19da289f475aa46a33cb793029
1286 identity="eap_psk_user@example.com"
1287}
1288
1289
1290# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1291# EAP-TLS for authentication and key generation; require both unicast and
1292# broadcast WEP keys.
1293network={
1294 ssid="1x-test"
1295 key_mgmt=IEEE8021X
1296 eap=TLS
1297 identity="user@example.com"
1298 ca_cert="/etc/cert/ca.pem"
1299 client_cert="/etc/cert/user.pem"
1300 private_key="/etc/cert/user.prv"
1301 private_key_passwd="password"
1302 eapol_flags=3
1303}
1304
1305
1306# LEAP with dynamic WEP keys
1307network={
1308 ssid="leap-example"
1309 key_mgmt=IEEE8021X
1310 eap=LEAP
1311 identity="user"
1312 password="foobar"
1313}
1314
1315# EAP-IKEv2 using shared secrets for both server and peer authentication
1316network={
1317 ssid="ikev2-example"
1318 key_mgmt=WPA-EAP
1319 eap=IKEV2
1320 identity="user"
1321 password="foobar"
1322}
1323
1324# EAP-FAST with WPA (WPA or WPA2)
1325network={
1326 ssid="eap-fast-test"
1327 key_mgmt=WPA-EAP
1328 eap=FAST
1329 anonymous_identity="FAST-000102030405"
1330 identity="username"
1331 password="password"
1332 phase1="fast_provisioning=1"
1333 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1334}
1335
1336network={
1337 ssid="eap-fast-test"
1338 key_mgmt=WPA-EAP
1339 eap=FAST
1340 anonymous_identity="FAST-000102030405"
1341 identity="username"
1342 password="password"
1343 phase1="fast_provisioning=1"
1344 pac_file="blob://eap-fast-pac"
1345}
1346
1347# Plaintext connection (no WPA, no IEEE 802.1X)
1348network={
1349 ssid="plaintext-test"
1350 key_mgmt=NONE
1351}
1352
1353
1354# Shared WEP key connection (no WPA, no IEEE 802.1X)
1355network={
1356 ssid="static-wep-test"
1357 key_mgmt=NONE
1358 wep_key0="abcde"
1359 wep_key1=0102030405
1360 wep_key2="1234567890123"
1361 wep_tx_keyidx=0
1362 priority=5
1363}
1364
1365
1366# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1367# IEEE 802.11 authentication
1368network={
1369 ssid="static-wep-test2"
1370 key_mgmt=NONE
1371 wep_key0="abcde"
1372 wep_key1=0102030405
1373 wep_key2="1234567890123"
1374 wep_tx_keyidx=0
1375 priority=5
1376 auth_alg=SHARED
1377}
1378
1379
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001380# IBSS/ad-hoc network with RSN
1381network={
1382 ssid="ibss-rsn"
1383 key_mgmt=WPA-PSK
1384 proto=RSN
1385 psk="12345678"
1386 mode=1
1387 frequency=2412
1388 pairwise=CCMP
1389 group=CCMP
1390}
1391
1392# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001393network={
1394 ssid="test adhoc"
1395 mode=1
1396 frequency=2412
1397 proto=WPA
1398 key_mgmt=WPA-NONE
1399 pairwise=NONE
1400 group=TKIP
1401 psk="secret passphrase"
1402}
1403
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001404# open mesh network
1405network={
1406 ssid="test mesh"
1407 mode=5
1408 frequency=2437
1409 key_mgmt=NONE
1410}
1411
1412# secure (SAE + AMPE) network
1413network={
1414 ssid="secure mesh"
1415 mode=5
1416 frequency=2437
1417 key_mgmt=SAE
1418 psk="very secret passphrase"
1419}
1420
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001421
1422# Catch all example that allows more or less all configuration modes
1423network={
1424 ssid="example"
1425 scan_ssid=1
1426 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1427 pairwise=CCMP TKIP
1428 group=CCMP TKIP WEP104 WEP40
1429 psk="very secret passphrase"
1430 eap=TTLS PEAP TLS
1431 identity="user@example.com"
1432 password="foobar"
1433 ca_cert="/etc/cert/ca.pem"
1434 client_cert="/etc/cert/user.pem"
1435 private_key="/etc/cert/user.prv"
1436 private_key_passwd="password"
1437 phase1="peaplabel=0"
1438}
1439
1440# Example of EAP-TLS with smartcard (openssl engine)
1441network={
1442 ssid="example"
1443 key_mgmt=WPA-EAP
1444 eap=TLS
1445 proto=RSN
1446 pairwise=CCMP TKIP
1447 group=CCMP TKIP
1448 identity="user@example.com"
1449 ca_cert="/etc/cert/ca.pem"
1450 client_cert="/etc/cert/user.pem"
1451
1452 engine=1
1453
1454 # The engine configured here must be available. Look at
1455 # OpenSSL engine support in the global section.
1456 # The key available through the engine must be the private key
1457 # matching the client certificate configured above.
1458
1459 # use the opensc engine
1460 #engine_id="opensc"
1461 #key_id="45"
1462
1463 # use the pkcs11 engine
1464 engine_id="pkcs11"
1465 key_id="id_45"
1466
1467 # Optional PIN configuration; this can be left out and PIN will be
1468 # asked through the control interface
1469 pin="1234"
1470}
1471
1472# Example configuration showing how to use an inlined blob as a CA certificate
1473# data instead of using external file
1474network={
1475 ssid="example"
1476 key_mgmt=WPA-EAP
1477 eap=TTLS
1478 identity="user@example.com"
1479 anonymous_identity="anonymous@example.com"
1480 password="foobar"
1481 ca_cert="blob://exampleblob"
1482 priority=20
1483}
1484
1485blob-base64-exampleblob={
1486SGVsbG8gV29ybGQhCg==
1487}
1488
1489
1490# Wildcard match for SSID (plaintext APs only). This example select any
1491# open AP regardless of its SSID.
1492network={
1493 key_mgmt=NONE
1494}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001495
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001496# Example configuration blacklisting two APs - these will be ignored
1497# for this network.
1498network={
1499 ssid="example"
1500 psk="very secret passphrase"
1501 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1502}
1503
1504# Example configuration limiting AP selection to a specific set of APs;
1505# any other AP not matching the masked address will be ignored.
1506network={
1507 ssid="example"
1508 psk="very secret passphrase"
1509 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
1510}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001511
1512# Example config file that will only scan on channel 36.
1513freq_list=5180
1514network={
1515 key_mgmt=NONE
1516}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001517
1518
1519# Example MACsec configuration
1520#network={
1521# key_mgmt=IEEE8021X
1522# eap=TTLS
1523# phase2="auth=PAP"
1524# anonymous_identity="anonymous@example.com"
1525# identity="user@example.com"
1526# password="secretr"
1527# ca_cert="/etc/cert/ca.pem"
1528# eapol_flags=0
1529# macsec_policy=1
1530#}