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