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