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