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