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