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