blob: 191f2063ba8d2df6278f4e0c0d7276e426c381f0 [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 Shmidt09f57ba2014-06-10 16:07:13 -0700272# Extra delay between concurrent P2P search iterations
273#
274# This value adds extra delay in milliseconds between concurrent search
275# iterations to make p2p_find friendlier to concurrent operations by avoiding
276# it from taking 100% of radio resources. The default value is 500 ms.
277#p2p_search_delay=500
278
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800279# Opportunistic Key Caching (also known as Proactive Key Caching) default
280# This parameter can be used to set the default behavior for the
281# proactive_key_caching parameter. By default, OKC is disabled unless enabled
282# with the global okc=1 parameter or with the per-network
283# proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
284# can be disabled with per-network proactive_key_caching=0 parameter.
285#okc=0
286
287# Protected Management Frames default
288# This parameter can be used to set the default behavior for the ieee80211w
289# parameter. By default, PMF is disabled unless enabled with the global pmf=1/2
290# parameter or with the per-network ieee80211w=1/2 parameter. With pmf=1/2, PMF
291# is enabled/required by default, but can be disabled with the per-network
292# ieee80211w parameter.
293#pmf=0
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800294
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800295# Enabled SAE finite cyclic groups in preference order
296# By default (if this parameter is not set), the mandatory group 19 (ECC group
297# defined over a 256-bit prime order field) is preferred, but other groups are
298# also enabled. If this parameter is set, the groups will be tried in the
299# indicated order. The group values are listed in the IANA registry:
300# http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
301#sae_groups=21 20 19 26 25
302
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800303# Default value for DTIM period (if not overridden in network block)
304#dtim_period=2
305
306# Default value for Beacon interval (if not overridden in network block)
307#beacon_int=100
308
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700309# Additional vendor specific elements for Beacon and Probe Response frames
310# This parameter can be used to add additional vendor specific element(s) into
311# the end of the Beacon and Probe Response frames. The format for these
312# element(s) is a hexdump of the raw information elements (id+len+payload for
313# one or more elements). This is used in AP and P2P GO modes.
314#ap_vendor_elements=dd0411223301
315
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700316# Ignore scan results older than request
317#
318# The driver may have a cache of scan results that makes it return
319# information that is older than our scan trigger. This parameter can
320# be used to configure such old information to be ignored instead of
321# allowing it to update the internal BSS table.
322#ignore_old_scan_res=0
323
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700324# scan_cur_freq: Whether to scan only the current frequency
325# 0: Scan all available frequencies. (Default)
326# 1: Scan current operating frequency if another VIF on the same radio
327# is already associated.
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700328
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800329# Interworking (IEEE 802.11u)
330
331# Enable Interworking
332# interworking=1
333
334# Homogenous ESS identifier
335# If this is set, scans will be used to request response only from BSSes
336# belonging to the specified Homogeneous ESS. This is used only if interworking
337# is enabled.
338# hessid=00:11:22:33:44:55
339
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700340# Automatic network selection behavior
341# 0 = do not automatically go through Interworking network selection
342# (i.e., require explicit interworking_select command for this; default)
343# 1 = perform Interworking network selection if one or more
344# credentials have been configured and scan did not find a
345# matching network block
346#auto_interworking=0
347
Dmitry Shmidt04949592012-07-19 12:16:46 -0700348# credential block
349#
350# Each credential used for automatic network selection is configured as a set
351# of parameters that are compared to the information advertised by the APs when
352# interworking_select and interworking_connect commands are used.
353#
354# credential fields:
355#
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800356# temporary: Whether this credential is temporary and not to be saved
357#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700358# priority: Priority group
359# By default, all networks and credentials get the same priority group
360# (0). This field can be used to give higher priority for credentials
361# (and similarly in struct wpa_ssid for network blocks) to change the
362# Interworking automatic networking selection behavior. The matching
363# network (based on either an enabled network block or a credential)
364# with the highest priority value will be selected.
365#
366# pcsc: Use PC/SC and SIM/USIM card
367#
368# realm: Home Realm for Interworking
369#
370# username: Username for Interworking network selection
371#
372# password: Password for Interworking network selection
373#
374# ca_cert: CA certificate for Interworking network selection
375#
376# client_cert: File path to client certificate file (PEM/DER)
377# This field is used with Interworking networking selection for a case
378# where client certificate/private key is used for authentication
379# (EAP-TLS). Full path to the file should be used since working
380# directory may change when wpa_supplicant is run in the background.
381#
382# Alternatively, a named configuration blob can be used by setting
383# this to blob://blob_name.
384#
385# private_key: File path to client private key file (PEM/DER/PFX)
386# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
387# commented out. Both the private key and certificate will be read
388# from the PKCS#12 file in this case. Full path to the file should be
389# used since working directory may change when wpa_supplicant is run
390# in the background.
391#
392# Windows certificate store can be used by leaving client_cert out and
393# configuring private_key in one of the following formats:
394#
395# cert://substring_to_match
396#
397# hash://certificate_thumbprint_in_hex
398#
399# For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
400#
401# Note that when running wpa_supplicant as an application, the user
402# certificate store (My user account) is used, whereas computer store
403# (Computer account) is used when running wpasvc as a service.
404#
405# Alternatively, a named configuration blob can be used by setting
406# this to blob://blob_name.
407#
408# private_key_passwd: Password for private key file
409#
410# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
411#
412# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
413# format
414#
Dmitry Shmidt051af732013-10-22 13:52:46 -0700415# domain: Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700416# This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700417# whether the AP is operated by the Home SP. Multiple domain entries can
418# be used to configure alternative FQDNs that will be considered home
419# networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700420#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700421# roaming_consortium: Roaming Consortium OI
422# If roaming_consortium_len is non-zero, this field contains the
423# Roaming Consortium OI that can be used to determine which access
424# points support authentication with this credential. This is an
425# alternative to the use of the realm parameter. When using Roaming
426# Consortium to match the network, the EAP parameters need to be
427# pre-configured with the credential since the NAI Realm information
428# may not be available or fetched.
429#
430# eap: Pre-configured EAP method
431# This optional field can be used to specify which EAP method will be
432# used with this credential. If not set, the EAP method is selected
433# automatically based on ANQP information (e.g., NAI Realm).
434#
435# phase1: Pre-configure Phase 1 (outer authentication) parameters
436# This optional field is used with like the 'eap' parameter.
437#
438# phase2: Pre-configure Phase 2 (inner authentication) parameters
439# This optional field is used with like the 'eap' parameter.
440#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800441# excluded_ssid: Excluded SSID
442# This optional field can be used to excluded specific SSID(s) from
443# matching with the network. Multiple entries can be used to specify more
444# than one SSID.
445#
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800446# roaming_partner: Roaming partner information
447# This optional field can be used to configure preferences between roaming
448# partners. The field is a string in following format:
449# <FQDN>,<0/1 exact match>,<priority>,<* or country code>
450# (non-exact match means any subdomain matches the entry; priority is in
451# 0..255 range with 0 being the highest priority)
452#
453# update_identifier: PPS MO ID
454# (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
455#
456# provisioning_sp: FQDN of the SP that provisioned the credential
457# This optional field can be used to keep track of the SP that provisioned
458# the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
459#
460# Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
461# These fields can be used to specify minimum download/upload backhaul
462# bandwidth that is preferred for the credential. This constraint is
463# ignored if the AP does not advertise WAN Metrics information or if the
464# limit would prevent any connection. Values are in kilobits per second.
465# min_dl_bandwidth_home
466# min_ul_bandwidth_home
467# min_dl_bandwidth_roaming
468# min_ul_bandwidth_roaming
469#
470# max_bss_load: Maximum BSS Load Channel Utilization (1..255)
471# (PPS/<X+>/Policy/MaximumBSSLoadValue)
472# This value is used as the maximum channel utilization for network
473# selection purposes for home networks. If the AP does not advertise
474# BSS Load or if the limit would prevent any connection, this constraint
475# will be ignored.
476#
477# req_conn_capab: Required connection capability
478# (PPS/<X+>/Policy/RequiredProtoPortTuple)
479# This value is used to configure set of required protocol/port pairs that
480# a roaming network shall support (include explicitly in Connection
481# Capability ANQP element). This constraint is ignored if the AP does not
482# advertise Connection Capability or if this constraint would prevent any
483# network connection. This policy is not used in home networks.
484# Format: <protocol>[:<comma-separated list of ports]
485# Multiple entries can be used to list multiple requirements.
486# For example, number of common TCP protocols:
487# req_conn_capab=6,22,80,443
488# For example, IPSec/IKE:
489# req_conn_capab=17:500
490# req_conn_capab=50
491#
492# ocsp: Whether to use/require OCSP to check server certificate
493# 0 = do not use OCSP stapling (TLS certificate status extension)
494# 1 = try to use OCSP stapling, but not require response
495# 2 = require valid OCSP stapling response
496#
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700497# sim_num: Identifier for which SIM to use in multi-SIM devices
498#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700499# for example:
500#
501#cred={
502# realm="example.com"
503# username="user@example.com"
504# password="password"
505# ca_cert="/etc/wpa_supplicant/ca.pem"
506# domain="example.com"
507#}
508#
509#cred={
510# imsi="310026-000000000"
511# milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
512#}
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700513#
514#cred={
515# realm="example.com"
516# username="user"
517# password="password"
518# ca_cert="/etc/wpa_supplicant/ca.pem"
519# domain="example.com"
520# roaming_consortium=223344
521# eap=TTLS
522# phase2="auth=MSCHAPV2"
523#}
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800524
Dmitry Shmidt04949592012-07-19 12:16:46 -0700525# Hotspot 2.0
526# hs20=1
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800527
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800528# network block
529#
530# Each network (usually AP's sharing the same SSID) is configured as a separate
531# block in this configuration file. The network blocks are in preference order
532# (the first match is used).
533#
534# network block fields:
535#
536# disabled:
537# 0 = this network can be used (default)
538# 1 = this network block is disabled (can be enabled through ctrl_iface,
539# e.g., with wpa_cli or wpa_gui)
540#
541# id_str: Network identifier string for external scripts. This value is passed
542# to external action script through wpa_cli as WPA_ID_STR environment
543# variable to make it easier to do network specific configuration.
544#
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700545# ssid: SSID (mandatory); network name in one of the optional formats:
546# - an ASCII string with double quotation
547# - a hex string (two characters per octet of SSID)
548# - a printf-escaped ASCII string P"<escaped string>"
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800549#
550# scan_ssid:
551# 0 = do not scan this SSID with specific Probe Request frames (default)
552# 1 = scan with SSID-specific Probe Request frames (this can be used to
553# find APs that do not accept broadcast SSID or use multiple SSIDs;
554# this will add latency to scanning, so enable this only when needed)
555#
556# bssid: BSSID (optional); if set, this network block is used only when
557# associating with the AP using the configured BSSID
558#
559# priority: priority group (integer)
560# By default, all networks will get same priority group (0). If some of the
561# networks are more desirable, this field can be used to change the order in
562# which wpa_supplicant goes through the networks when selecting a BSS. The
563# priority groups will be iterated in decreasing priority (i.e., the larger the
564# priority value, the sooner the network is matched against the scan results).
565# Within each priority group, networks will be selected based on security
566# policy, signal strength, etc.
567# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
568# using this priority to select the order for scanning. Instead, they try the
569# networks in the order that used in the configuration file.
570#
571# mode: IEEE 802.11 operation mode
572# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
573# 1 = IBSS (ad-hoc, peer-to-peer)
574# 2 = AP (access point)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800575# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
576# WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
577# TKIP/CCMP) is available for backwards compatibility, but its use is
578# deprecated. WPA-None requires following network block options:
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800579# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
580# both), and psk must also be set.
581#
582# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
583# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
584# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
585# In addition, this value is only used by the station that creates the IBSS. If
586# an IBSS network with the configured SSID is already present, the frequency of
587# the network will be used instead of this configured value.
588#
589# scan_freq: List of frequencies to scan
590# Space-separated list of frequencies in MHz to scan when searching for this
591# BSS. If the subset of channels used by the network is known, this option can
592# be used to optimize scanning to not occur on channels that the network does
593# not use. Example: scan_freq=2412 2437 2462
594#
595# freq_list: Array of allowed frequencies
596# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
597# set, scan results that do not match any of the specified frequencies are not
598# considered when selecting a BSS.
599#
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700600# This can also be set on the outside of the network block. In this case,
601# it limits the frequencies that will be scanned.
602#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800603# bgscan: Background scanning
604# wpa_supplicant behavior for background scanning can be specified by
605# configuring a bgscan module. These modules are responsible for requesting
606# background scans for the purpose of roaming within an ESS (i.e., within a
607# single network block with all the APs using the same SSID). The bgscan
608# parameter uses following format: "<bgscan module name>:<module parameters>"
609# Following bgscan modules are available:
610# simple - Periodic background scans based on signal strength
611# bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
612# <long interval>"
613# bgscan="simple:30:-45:300"
614# learn - Learn channels used by the network and try to avoid bgscans on other
615# channels (experimental)
616# bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
617# <long interval>[:<database file name>]"
618# bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
Dmitry Shmidta38abf92014-03-06 13:38:44 -0800619# Explicitly disable bgscan by setting
620# bgscan=""
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800621#
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800622# This option can also be set outside of all network blocks for the bgscan
623# parameter to apply for all the networks that have no specific bgscan
624# parameter.
625#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800626# proto: list of accepted protocols
627# WPA = WPA/IEEE 802.11i/D3.0
628# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
629# If not set, this defaults to: WPA RSN
630#
631# key_mgmt: list of accepted authenticated key management protocols
632# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
633# WPA-EAP = WPA using EAP authentication
634# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
635# generated WEP keys
636# NONE = WPA is not used; plaintext or static WEP could be used
637# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
638# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
639# If not set, this defaults to: WPA-PSK WPA-EAP
640#
Dmitry Shmidt04949592012-07-19 12:16:46 -0700641# ieee80211w: whether management frame protection is enabled
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800642# 0 = disabled (default unless changed with the global pmf parameter)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700643# 1 = optional
644# 2 = required
645# The most common configuration options for this based on the PMF (protected
646# management frames) certification program are:
647# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
648# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
649# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
650#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800651# auth_alg: list of allowed IEEE 802.11 authentication algorithms
652# OPEN = Open System authentication (required for WPA/WPA2)
653# SHARED = Shared Key authentication (requires static WEP keys)
654# LEAP = LEAP/Network EAP (only used with LEAP)
655# If not set, automatic selection is used (Open System with LEAP enabled if
656# LEAP is allowed as one of the EAP methods).
657#
658# pairwise: list of accepted pairwise (unicast) ciphers for WPA
659# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
660# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
661# NONE = Use only Group Keys (deprecated, should not be included if APs support
662# pairwise keys)
663# If not set, this defaults to: CCMP TKIP
664#
665# group: list of accepted group (broadcast/multicast) ciphers for WPA
666# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
667# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
668# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
669# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
670# If not set, this defaults to: CCMP TKIP WEP104 WEP40
671#
672# psk: WPA preshared key; 256-bit pre-shared key
673# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
674# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
675# generated using the passphrase and SSID). ASCII passphrase must be between
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700676# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
677# be used to indicate that the PSK/passphrase is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800678# This field is not needed, if WPA-EAP is used.
679# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
680# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
681# startup and reconfiguration time can be optimized by generating the PSK only
682# only when the passphrase or SSID has actually changed.
683#
684# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
685# Dynamic WEP key required for non-WPA mode
686# bit0 (1): require dynamically generated unicast WEP key
687# bit1 (2): require dynamically generated broadcast WEP key
688# (3 = require both keys; default)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -0700689# Note: When using wired authentication (including macsec_qca driver),
690# eapol_flags must be set to 0 for the authentication to be completed
691# successfully.
692#
693# macsec_policy: IEEE 802.1X/MACsec options
694# This determines how sessions are secured with MACsec. It is currently
695# applicable only when using the macsec_qca driver interface.
696# 0: MACsec not in use (default)
697# 1: MACsec enabled - Should secure, accept key server's advice to
698# determine whether to use a secure session or not.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800699#
700# mixed_cell: This option can be used to configure whether so called mixed
701# cells, i.e., networks that use both plaintext and encryption in the same
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800702# SSID, are allowed when selecting a BSS from scan results.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800703# 0 = disabled (default)
704# 1 = enabled
705#
706# proactive_key_caching:
707# Enable/disable opportunistic PMKSA caching for WPA2.
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800708# 0 = disabled (default unless changed with the global okc parameter)
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800709# 1 = enabled
710#
711# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
712# hex without quotation, e.g., 0102030405)
713# wep_tx_keyidx: Default WEP key index (TX) (0..3)
714#
715# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
716# allowed. This is only used with RSN/WPA2.
717# 0 = disabled (default)
718# 1 = enabled
719#peerkey=1
720#
721# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
722# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
723#
724# Following fields are only used with internal EAP implementation.
725# eap: space-separated list of accepted EAP methods
726# MD5 = EAP-MD5 (unsecure and does not generate keying material ->
727# cannot be used with WPA; to be used as a Phase 2 method
728# with EAP-PEAP or EAP-TTLS)
729# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
730# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
731# OTP = EAP-OTP (cannot be used separately with WPA; to be used
732# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
733# GTC = EAP-GTC (cannot be used separately with WPA; to be used
734# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
735# TLS = EAP-TLS (client and server certificate)
736# PEAP = EAP-PEAP (with tunnelled EAP authentication)
737# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
738# authentication)
739# If not set, all compiled in methods are allowed.
740#
741# identity: Identity string for EAP
742# This field is also used to configure user NAI for
743# EAP-PSK/PAX/SAKE/GPSK.
744# anonymous_identity: Anonymous identity string for EAP (to be used as the
745# unencrypted identity with EAP types that support different tunnelled
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700746# identity, e.g., EAP-TTLS). This field can also be used with
747# EAP-SIM/AKA/AKA' to store the pseudonym identity.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800748# password: Password string for EAP. This field can include either the
749# plaintext password (using ASCII or hex string) or a NtPasswordHash
750# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
751# NtPasswordHash can only be used when the password is for MSCHAPv2 or
752# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
753# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
754# PSK) is also configured using this field. For EAP-GPSK, this is a
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700755# variable length PSK. ext:<name of external password field> format can
756# be used to indicate that the password is stored in external storage.
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800757# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
758# or more trusted CA certificates. If ca_cert and ca_path are not
759# included, server certificate will not be verified. This is insecure and
760# a trusted CA certificate should always be configured when using
761# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
762# change when wpa_supplicant is run in the background.
763#
764# Alternatively, this can be used to only perform matching of the server
765# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
766# this case, the possible CA certificates in the server certificate chain
767# are ignored and only the server certificate is verified. This is
768# configured with the following format:
769# hash:://server/sha256/cert_hash_in_hex
770# For example: "hash://server/sha256/
771# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
772#
773# On Windows, trusted CA certificates can be loaded from the system
774# certificate store by setting this to cert_store://<name>, e.g.,
775# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
776# Note that when running wpa_supplicant as an application, the user
777# certificate store (My user account) is used, whereas computer store
778# (Computer account) is used when running wpasvc as a service.
779# ca_path: Directory path for CA certificate files (PEM). This path may
780# contain multiple CA certificates in OpenSSL format. Common use for this
781# is to point to system trusted CA list which is often installed into
782# directory like /etc/ssl/certs. If configured, these certificates are
783# added to the list of trusted CAs. ca_cert may also be included in that
784# case, but it is not required.
785# client_cert: File path to client certificate file (PEM/DER)
786# Full path should be used since working directory may change when
787# wpa_supplicant is run in the background.
788# Alternatively, a named configuration blob can be used by setting this
789# to blob://<blob name>.
790# private_key: File path to client private key file (PEM/DER/PFX)
791# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
792# commented out. Both the private key and certificate will be read from
793# the PKCS#12 file in this case. Full path should be used since working
794# directory may change when wpa_supplicant is run in the background.
795# Windows certificate store can be used by leaving client_cert out and
796# configuring private_key in one of the following formats:
797# cert://substring_to_match
798# hash://certificate_thumbprint_in_hex
799# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
800# Note that when running wpa_supplicant as an application, the user
801# certificate store (My user account) is used, whereas computer store
802# (Computer account) is used when running wpasvc as a service.
803# Alternatively, a named configuration blob can be used by setting this
804# to blob://<blob name>.
805# private_key_passwd: Password for private key file (if left out, this will be
806# asked through control interface)
807# dh_file: File path to DH/DSA parameters file (in PEM format)
808# This is an optional configuration file for setting parameters for an
809# ephemeral DH key exchange. In most cases, the default RSA
810# authentication does not use this configuration. However, it is possible
811# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
812# DSA keys always use ephemeral DH keys. This can be used to achieve
813# forward secrecy. If the file is in DSA parameters format, it will be
814# automatically converted into DH params.
815# subject_match: Substring to be matched against the subject of the
816# authentication server certificate. If this string is set, the server
817# sertificate is only accepted if it contains this string in the subject.
818# The subject string is in following format:
819# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
820# altsubject_match: Semicolon separated string of entries to be matched against
821# the alternative subject name of the authentication server certificate.
822# If this string is set, the server sertificate is only accepted if it
823# contains one of the entries in an alternative subject name extension.
824# altSubjectName string is in following format: TYPE:VALUE
825# Example: EMAIL:server@example.com
826# Example: DNS:server.example.com;DNS:server2.example.com
827# Following types are supported: EMAIL, DNS, URI
828# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
829# (string with field-value pairs, e.g., "peapver=0" or
830# "peapver=1 peaplabel=1")
831# 'peapver' can be used to force which PEAP version (0 or 1) is used.
832# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
833# to be used during key derivation when PEAPv1 or newer. Most existing
834# PEAPv1 implementation seem to be using the old label, "client EAP
835# encryption", and wpa_supplicant is now using that as the default value.
836# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
837# interoperate with PEAPv1; see eap_testing.txt for more details.
838# 'peap_outer_success=0' can be used to terminate PEAP authentication on
839# tunneled EAP-Success. This is required with some RADIUS servers that
840# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
841# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
842# include_tls_length=1 can be used to force wpa_supplicant to include
843# TLS Message Length field in all TLS messages even if they are not
844# fragmented.
845# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
846# challenges (by default, it accepts 2 or 3)
847# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
848# protected result indication.
849# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
850# behavior:
851# * 0 = do not use cryptobinding (default)
852# * 1 = use cryptobinding if server supports it
853# * 2 = require cryptobinding
854# EAP-WSC (WPS) uses following options: pin=<Device Password> or
855# pbc=1.
856# phase2: Phase2 (inner authentication with TLS tunnel) parameters
857# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
858# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700859#
860# TLS-based methods can use the following parameters to control TLS behavior
861# (these are normally in the phase1 parameter, but can be used also in the
862# phase2 parameter when EAP-TLS is used within the inner tunnel):
863# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
864# TLS library, these may be disabled by default to enforce stronger
865# security)
866# tls_disable_time_checks=1 - ignore certificate validity time (this requests
867# the TLS library to accept certificates even if they are not currently
868# valid, i.e., have expired or have not yet become valid; this should be
869# used only for testing purposes)
870# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
871# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
872# Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
873# as a workaround for broken authentication server implementations unless
874# EAP workarounds are disabled with eap_workarounds=0.
875# For EAP-FAST, this must be set to 0 (or left unconfigured for the
876# default value to be used automatically).
Dmitry Shmidt13ca8d82014-02-20 10:18:40 -0800877# tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
878# that have issues interoperating with updated TLS version)
879# tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
880# that have issues interoperating with updated TLS version)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700881#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800882# Following certificate/private key fields are used in inner Phase2
883# authentication when using EAP-TTLS or EAP-PEAP.
884# ca_cert2: File path to CA certificate file. This file can have one or more
885# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
886# server certificate will not be verified. This is insecure and a trusted
887# CA certificate should always be configured.
888# ca_path2: Directory path for CA certificate files (PEM)
889# client_cert2: File path to client certificate file
890# private_key2: File path to client private key file
891# private_key2_passwd: Password for private key file
892# dh_file2: File path to DH/DSA parameters file (in PEM format)
893# subject_match2: Substring to be matched against the subject of the
894# authentication server certificate.
895# altsubject_match2: Substring to be matched against the alternative subject
896# name of the authentication server certificate.
897#
898# fragment_size: Maximum EAP fragment size in bytes (default 1398).
899# This value limits the fragment size for EAP methods that support
900# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
901# small enough to make the EAP messages fit in MTU of the network
902# interface used for EAPOL. The default value is suitable for most
903# cases.
904#
Dmitry Shmidt34af3062013-07-11 10:46:32 -0700905# ocsp: Whether to use/require OCSP to check server certificate
906# 0 = do not use OCSP stapling (TLS certificate status extension)
907# 1 = try to use OCSP stapling, but not require response
908# 2 = require valid OCSP stapling response
909#
Dmitry Shmidt30f94812012-02-21 17:02:48 -0800910# EAP-FAST variables:
911# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
912# to create this file and write updates to it when PAC is being
913# provisioned or refreshed. Full path to the file should be used since
914# working directory may change when wpa_supplicant is run in the
915# background. Alternatively, a named configuration blob can be used by
916# setting this to blob://<blob name>
917# phase1: fast_provisioning option can be used to enable in-line provisioning
918# of EAP-FAST credentials (PAC):
919# 0 = disabled,
920# 1 = allow unauthenticated provisioning,
921# 2 = allow authenticated provisioning,
922# 3 = allow both unauthenticated and authenticated provisioning
923# fast_max_pac_list_len=<num> option can be used to set the maximum
924# number of PAC entries to store in a PAC list (default: 10)
925# fast_pac_format=binary option can be used to select binary format for
926# storing PAC entries in order to save some space (the default
927# text format uses about 2.5 times the size of minimal binary
928# format)
929#
930# wpa_supplicant supports number of "EAP workarounds" to work around
931# interoperability issues with incorrectly behaving authentication servers.
932# These are enabled by default because some of the issues are present in large
933# number of authentication servers. Strict EAP conformance mode can be
934# configured by disabling workarounds with eap_workaround=0.
935
Dmitry Shmidt04949592012-07-19 12:16:46 -0700936# Station inactivity limit
937#
938# If a station does not send anything in ap_max_inactivity seconds, an
939# empty data frame is sent to it in order to verify whether it is
940# still in range. If this frame is not ACKed, the station will be
941# disassociated and then deauthenticated. This feature is used to
942# clear station table of old entries when the STAs move out of the
943# range.
944#
945# The station can associate again with the AP if it is still in range;
946# this inactivity poll is just used as a nicer way of verifying
947# inactivity; i.e., client will not report broken connection because
948# disassociation frame is not sent immediately without first polling
949# the STA with a data frame.
950# default: 300 (i.e., 5 minutes)
951#ap_max_inactivity=300
952
953# DTIM period in Beacon intervals for AP mode (default: 2)
954#dtim_period=2
955
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800956# Beacon interval (default: 100 TU)
957#beacon_int=100
958
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800959# disable_ht: Whether HT (802.11n) should be disabled.
960# 0 = HT enabled (if AP supports it)
961# 1 = HT disabled
962#
963# disable_ht40: Whether HT-40 (802.11n) should be disabled.
964# 0 = HT-40 enabled (if AP supports it)
965# 1 = HT-40 disabled
966#
967# disable_sgi: Whether SGI (short guard interval) should be disabled.
968# 0 = SGI enabled (if AP supports it)
969# 1 = SGI disabled
970#
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700971# disable_ldpc: Whether LDPC should be disabled.
972# 0 = LDPC enabled (if AP supports it)
973# 1 = LDPC disabled
974#
Dmitry Shmidt61593f02014-04-21 16:27:35 -0700975# ht40_intolerant: Whether 40 MHz intolerant should be indicated.
976# 0 = 40 MHz tolerant (default)
977# 1 = 40 MHz intolerant
978#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800979# ht_mcs: Configure allowed MCS rates.
980# Parsed as an array of bytes, in base-16 (ascii-hex)
981# ht_mcs="" // Use all available (default)
982# ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
983# ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
984#
985# disable_max_amsdu: Whether MAX_AMSDU should be disabled.
986# -1 = Do not make any changes.
987# 0 = Enable MAX-AMSDU if hardware supports it.
988# 1 = Disable AMSDU
989#
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -0700990# ampdu_factor: Maximum A-MPDU Length Exponent
991# Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
992#
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800993# ampdu_density: Allow overriding AMPDU density configuration.
994# Treated as hint by the kernel.
995# -1 = Do not make any changes.
996# 0-3 = Set AMPDU density (aka factor) to specified value.
997
Dmitry Shmidt2f023192013-03-12 12:44:17 -0700998# disable_vht: Whether VHT should be disabled.
999# 0 = VHT enabled (if AP supports it)
1000# 1 = VHT disabled
1001#
1002# vht_capa: VHT capabilities to set in the override
1003# vht_capa_mask: mask of VHT capabilities
1004#
1005# vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1006# vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1007# 0: MCS 0-7
1008# 1: MCS 0-8
1009# 2: MCS 0-9
1010# 3: not supported
1011
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001012# Example blocks:
1013
1014# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1015network={
1016 ssid="simple"
1017 psk="very secret passphrase"
1018 priority=5
1019}
1020
1021# Same as previous, but request SSID-specific scanning (for APs that reject
1022# broadcast SSID)
1023network={
1024 ssid="second ssid"
1025 scan_ssid=1
1026 psk="very secret passphrase"
1027 priority=2
1028}
1029
1030# Only WPA-PSK is used. Any valid cipher combination is accepted.
1031network={
1032 ssid="example"
1033 proto=WPA
1034 key_mgmt=WPA-PSK
1035 pairwise=CCMP TKIP
1036 group=CCMP TKIP WEP104 WEP40
1037 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1038 priority=2
1039}
1040
1041# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1042network={
1043 ssid="example"
1044 proto=WPA
1045 key_mgmt=WPA-PSK
1046 pairwise=TKIP
1047 group=TKIP
1048 psk="not so secure passphrase"
1049 wpa_ptk_rekey=600
1050}
1051
1052# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1053# or WEP40 as the group cipher will not be accepted.
1054network={
1055 ssid="example"
1056 proto=RSN
1057 key_mgmt=WPA-EAP
1058 pairwise=CCMP TKIP
1059 group=CCMP TKIP
1060 eap=TLS
1061 identity="user@example.com"
1062 ca_cert="/etc/cert/ca.pem"
1063 client_cert="/etc/cert/user.pem"
1064 private_key="/etc/cert/user.prv"
1065 private_key_passwd="password"
1066 priority=1
1067}
1068
1069# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1070# (e.g., Radiator)
1071network={
1072 ssid="example"
1073 key_mgmt=WPA-EAP
1074 eap=PEAP
1075 identity="user@example.com"
1076 password="foobar"
1077 ca_cert="/etc/cert/ca.pem"
1078 phase1="peaplabel=1"
1079 phase2="auth=MSCHAPV2"
1080 priority=10
1081}
1082
1083# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1084# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1085network={
1086 ssid="example"
1087 key_mgmt=WPA-EAP
1088 eap=TTLS
1089 identity="user@example.com"
1090 anonymous_identity="anonymous@example.com"
1091 password="foobar"
1092 ca_cert="/etc/cert/ca.pem"
1093 priority=2
1094}
1095
1096# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1097# use. Real identity is sent only within an encrypted TLS tunnel.
1098network={
1099 ssid="example"
1100 key_mgmt=WPA-EAP
1101 eap=TTLS
1102 identity="user@example.com"
1103 anonymous_identity="anonymous@example.com"
1104 password="foobar"
1105 ca_cert="/etc/cert/ca.pem"
1106 phase2="auth=MSCHAPV2"
1107}
1108
1109# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1110# authentication.
1111network={
1112 ssid="example"
1113 key_mgmt=WPA-EAP
1114 eap=TTLS
1115 # Phase1 / outer authentication
1116 anonymous_identity="anonymous@example.com"
1117 ca_cert="/etc/cert/ca.pem"
1118 # Phase 2 / inner authentication
1119 phase2="autheap=TLS"
1120 ca_cert2="/etc/cert/ca2.pem"
1121 client_cert2="/etc/cer/user.pem"
1122 private_key2="/etc/cer/user.prv"
1123 private_key2_passwd="password"
1124 priority=2
1125}
1126
1127# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1128# group cipher.
1129network={
1130 ssid="example"
1131 bssid=00:11:22:33:44:55
1132 proto=WPA RSN
1133 key_mgmt=WPA-PSK WPA-EAP
1134 pairwise=CCMP
1135 group=CCMP
1136 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1137}
1138
1139# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1140# and all valid ciphers.
1141network={
1142 ssid=00010203
1143 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1144}
1145
1146
1147# EAP-SIM with a GSM SIM or USIM
1148network={
1149 ssid="eap-sim-test"
1150 key_mgmt=WPA-EAP
1151 eap=SIM
1152 pin="1234"
1153 pcsc=""
1154}
1155
1156
1157# EAP-PSK
1158network={
1159 ssid="eap-psk-test"
1160 key_mgmt=WPA-EAP
1161 eap=PSK
1162 anonymous_identity="eap_psk_user"
1163 password=06b4be19da289f475aa46a33cb793029
1164 identity="eap_psk_user@example.com"
1165}
1166
1167
1168# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1169# EAP-TLS for authentication and key generation; require both unicast and
1170# broadcast WEP keys.
1171network={
1172 ssid="1x-test"
1173 key_mgmt=IEEE8021X
1174 eap=TLS
1175 identity="user@example.com"
1176 ca_cert="/etc/cert/ca.pem"
1177 client_cert="/etc/cert/user.pem"
1178 private_key="/etc/cert/user.prv"
1179 private_key_passwd="password"
1180 eapol_flags=3
1181}
1182
1183
1184# LEAP with dynamic WEP keys
1185network={
1186 ssid="leap-example"
1187 key_mgmt=IEEE8021X
1188 eap=LEAP
1189 identity="user"
1190 password="foobar"
1191}
1192
1193# EAP-IKEv2 using shared secrets for both server and peer authentication
1194network={
1195 ssid="ikev2-example"
1196 key_mgmt=WPA-EAP
1197 eap=IKEV2
1198 identity="user"
1199 password="foobar"
1200}
1201
1202# EAP-FAST with WPA (WPA or WPA2)
1203network={
1204 ssid="eap-fast-test"
1205 key_mgmt=WPA-EAP
1206 eap=FAST
1207 anonymous_identity="FAST-000102030405"
1208 identity="username"
1209 password="password"
1210 phase1="fast_provisioning=1"
1211 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1212}
1213
1214network={
1215 ssid="eap-fast-test"
1216 key_mgmt=WPA-EAP
1217 eap=FAST
1218 anonymous_identity="FAST-000102030405"
1219 identity="username"
1220 password="password"
1221 phase1="fast_provisioning=1"
1222 pac_file="blob://eap-fast-pac"
1223}
1224
1225# Plaintext connection (no WPA, no IEEE 802.1X)
1226network={
1227 ssid="plaintext-test"
1228 key_mgmt=NONE
1229}
1230
1231
1232# Shared WEP key connection (no WPA, no IEEE 802.1X)
1233network={
1234 ssid="static-wep-test"
1235 key_mgmt=NONE
1236 wep_key0="abcde"
1237 wep_key1=0102030405
1238 wep_key2="1234567890123"
1239 wep_tx_keyidx=0
1240 priority=5
1241}
1242
1243
1244# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1245# IEEE 802.11 authentication
1246network={
1247 ssid="static-wep-test2"
1248 key_mgmt=NONE
1249 wep_key0="abcde"
1250 wep_key1=0102030405
1251 wep_key2="1234567890123"
1252 wep_tx_keyidx=0
1253 priority=5
1254 auth_alg=SHARED
1255}
1256
1257
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001258# IBSS/ad-hoc network with RSN
1259network={
1260 ssid="ibss-rsn"
1261 key_mgmt=WPA-PSK
1262 proto=RSN
1263 psk="12345678"
1264 mode=1
1265 frequency=2412
1266 pairwise=CCMP
1267 group=CCMP
1268}
1269
1270# IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
Dmitry Shmidt30f94812012-02-21 17:02:48 -08001271network={
1272 ssid="test adhoc"
1273 mode=1
1274 frequency=2412
1275 proto=WPA
1276 key_mgmt=WPA-NONE
1277 pairwise=NONE
1278 group=TKIP
1279 psk="secret passphrase"
1280}
1281
1282
1283# Catch all example that allows more or less all configuration modes
1284network={
1285 ssid="example"
1286 scan_ssid=1
1287 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1288 pairwise=CCMP TKIP
1289 group=CCMP TKIP WEP104 WEP40
1290 psk="very secret passphrase"
1291 eap=TTLS PEAP TLS
1292 identity="user@example.com"
1293 password="foobar"
1294 ca_cert="/etc/cert/ca.pem"
1295 client_cert="/etc/cert/user.pem"
1296 private_key="/etc/cert/user.prv"
1297 private_key_passwd="password"
1298 phase1="peaplabel=0"
1299}
1300
1301# Example of EAP-TLS with smartcard (openssl engine)
1302network={
1303 ssid="example"
1304 key_mgmt=WPA-EAP
1305 eap=TLS
1306 proto=RSN
1307 pairwise=CCMP TKIP
1308 group=CCMP TKIP
1309 identity="user@example.com"
1310 ca_cert="/etc/cert/ca.pem"
1311 client_cert="/etc/cert/user.pem"
1312
1313 engine=1
1314
1315 # The engine configured here must be available. Look at
1316 # OpenSSL engine support in the global section.
1317 # The key available through the engine must be the private key
1318 # matching the client certificate configured above.
1319
1320 # use the opensc engine
1321 #engine_id="opensc"
1322 #key_id="45"
1323
1324 # use the pkcs11 engine
1325 engine_id="pkcs11"
1326 key_id="id_45"
1327
1328 # Optional PIN configuration; this can be left out and PIN will be
1329 # asked through the control interface
1330 pin="1234"
1331}
1332
1333# Example configuration showing how to use an inlined blob as a CA certificate
1334# data instead of using external file
1335network={
1336 ssid="example"
1337 key_mgmt=WPA-EAP
1338 eap=TTLS
1339 identity="user@example.com"
1340 anonymous_identity="anonymous@example.com"
1341 password="foobar"
1342 ca_cert="blob://exampleblob"
1343 priority=20
1344}
1345
1346blob-base64-exampleblob={
1347SGVsbG8gV29ybGQhCg==
1348}
1349
1350
1351# Wildcard match for SSID (plaintext APs only). This example select any
1352# open AP regardless of its SSID.
1353network={
1354 key_mgmt=NONE
1355}
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001356
1357
1358# Example config file that will only scan on channel 36.
1359freq_list=5180
1360network={
1361 key_mgmt=NONE
1362}
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001363
1364
1365# Example MACsec configuration
1366#network={
1367# key_mgmt=IEEE8021X
1368# eap=TTLS
1369# phase2="auth=PAP"
1370# anonymous_identity="anonymous@example.com"
1371# identity="user@example.com"
1372# password="secretr"
1373# ca_cert="/etc/cert/ca.pem"
1374# eapol_flags=0
1375# macsec_policy=1
1376#}