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
31# interface mechanism is used. For all cases, the existence of this parameter
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).
84eapol_version=1
85
86# AP scanning/selection
87# By default, wpa_supplicant requests driver to perform AP scanning and then
88# uses the scan results to select a suitable AP. Another alternative is to
89# allow the driver to take care of AP scanning and selection and use
90# wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
91# information from the driver.
92# 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
93#    the currently enabled networks are found, a new network (IBSS or AP mode
94#    operation) may be initialized (if configured) (default)
95# 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
96#    parameters (e.g., WPA IE generation); this mode can also be used with
97#    non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
98#    APs (i.e., external program needs to control association). This mode must
99#    also be used when using wired Ethernet drivers.
100# 2: like 0, but associate with APs using security policy and SSID (but not
101#    BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
102#    enable operation with hidden SSIDs and optimized roaming; in this mode,
103#    the network blocks in the configuration file are tried one by one until
104#    the driver reports successful association; each network block should have
105#    explicit security policy (i.e., only one option in the lists) for
106#    key_mgmt, pairwise, group, proto variables
107# When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
108# created immediately regardless of scan results. ap_scan=1 mode will first try
109# to scan for existing networks and only if no matches with the enabled
110# networks are found, a new IBSS or AP mode network is created.
111ap_scan=1
112
113# EAP fast re-authentication
114# By default, fast re-authentication is enabled for all EAP methods that
115# support it. This variable can be used to disable fast re-authentication.
116# Normally, there is no need to disable this.
117fast_reauth=1
118
119# OpenSSL Engine support
120# These options can be used to load OpenSSL engines.
121# The two engines that are supported currently are shown below:
122# They are both from the opensc project (http://www.opensc.org/)
123# By default no engines are loaded.
124# make the opensc engine available
125#opensc_engine_path=/usr/lib/opensc/engine_opensc.so
126# make the pkcs11 engine available
127#pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
128# configure the path to the pkcs11 module required by the pkcs11 engine
129#pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
130
131# Dynamic EAP methods
132# If EAP methods were built dynamically as shared object files, they need to be
133# loaded here before being used in the network blocks. By default, EAP methods
134# are included statically in the build, so these lines are not needed
135#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
136#load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
137
138# Driver interface parameters
139# This field can be used to configure arbitrary driver interace parameters. The
140# format is specific to the selected driver interface. This field is not used
141# in most cases.
142#driver_param="field=value"
143
144# Country code
145# The ISO/IEC alpha2 country code for the country in which this device is
146# currently operating.
147#country=US
148
149# Maximum lifetime for PMKSA in seconds; default 43200
150#dot11RSNAConfigPMKLifetime=43200
151# Threshold for reauthentication (percentage of PMK lifetime); default 70
152#dot11RSNAConfigPMKReauthThreshold=70
153# Timeout for security association negotiation in seconds; default 60
154#dot11RSNAConfigSATimeout=60
155
156# Wi-Fi Protected Setup (WPS) parameters
157
158# Universally Unique IDentifier (UUID; see RFC 4122) of the device
159# If not configured, UUID will be generated based on the local MAC address.
160#uuid=12345678-9abc-def0-1234-56789abcdef0
161
162# Device Name
163# User-friendly description of device; up to 32 octets encoded in UTF-8
164#device_name=Wireless Client
165
166# Manufacturer
167# The manufacturer of the device (up to 64 ASCII characters)
168#manufacturer=Company
169
170# Model Name
171# Model of the device (up to 32 ASCII characters)
172#model_name=cmodel
173
174# Model Number
175# Additional device description (up to 32 ASCII characters)
176#model_number=123
177
178# Serial Number
179# Serial number of the device (up to 32 characters)
180#serial_number=12345
181
182# Primary Device Type
183# Used format: <categ>-<OUI>-<subcateg>
184# categ = Category as an integer value
185# OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
186#       default WPS OUI
187# subcateg = OUI-specific Sub Category as an integer value
188# Examples:
189#   1-0050F204-1 (Computer / PC)
190#   1-0050F204-2 (Computer / Server)
191#   5-0050F204-1 (Storage / NAS)
192#   6-0050F204-1 (Network Infrastructure / AP)
193#device_type=1-0050F204-1
194
195# OS Version
196# 4-octet operating system version number (hex string)
197#os_version=01020300
198
199# Config Methods
200# List of the supported configuration methods
201# Available methods: usba ethernet label display ext_nfc_token int_nfc_token
202#	nfc_interface push_button keypad virtual_display physical_display
203#	virtual_push_button physical_push_button
204# For WSC 1.0:
205#config_methods=label display push_button keypad
206# For WSC 2.0:
207#config_methods=label virtual_display virtual_push_button keypad
208
209# Credential processing
210#   0 = process received credentials internally (default)
211#   1 = do not process received credentials; just pass them over ctrl_iface to
212#	external program(s)
213#   2 = process received credentials internally and pass them over ctrl_iface
214#	to external program(s)
215#wps_cred_processing=0
216
217# Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
218# The vendor attribute contents to be added in M1 (hex string)
219#wps_vendor_ext_m1=000137100100020001
220
221# NFC password token for WPS
222# These parameters can be used to configure a fixed NFC password token for the
223# station. This can be generated, e.g., with nfc_pw_token. When these
224# parameters are used, the station is assumed to be deployed with a NFC tag
225# that includes the matching NFC password token (e.g., written based on the
226# NDEF record from nfc_pw_token).
227#
228#wps_nfc_dev_pw_id: Device Password ID (16..65535)
229#wps_nfc_dh_pubkey: Hexdump of DH Public Key
230#wps_nfc_dh_privkey: Hexdump of DH Private Key
231#wps_nfc_dev_pw: Hexdump of Device Password
232
233# Maximum number of BSS entries to keep in memory
234# Default: 200
235# This can be used to limit memory use on the BSS entries (cached scan
236# results). A larger value may be needed in environments that have huge number
237# of APs when using ap_scan=1 mode.
238#bss_max_count=200
239
240# Automatic scan
241# This is an optional set of parameters for automatic scanning
242# within an interface in following format:
243#autoscan=<autoscan module name>:<module parameters>
244# autoscan is like bgscan but on disconnected or inactive state.
245# For instance, on exponential module parameters would be <base>:<limit>
246#autoscan=exponential:3:300
247# Which means a delay between scans on a base exponential of 3,
248# up to the limit of 300 seconds (3, 9, 27 ... 300)
249# For periodic module, parameters would be <fixed interval>
250#autoscan=periodic:30
251# So a delay of 30 seconds will be applied between each scan
252
253# filter_ssids - SSID-based scan result filtering
254# 0 = do not filter scan results (default)
255# 1 = only include configured SSIDs in scan results/BSS table
256#filter_ssids=0
257
258# Password (and passphrase, etc.) backend for external storage
259# format: <backend name>[:<optional backend parameters>]
260#ext_password_backend=test:pw1=password|pw2=testing
261
262# Timeout in seconds to detect STA inactivity (default: 300 seconds)
263#
264# This timeout value is used in P2P GO mode to clean up
265# inactive stations.
266#p2p_go_max_inactivity=300
267
268
269# Interworking (IEEE 802.11u)
270
271# Enable Interworking
272# interworking=1
273
274# Homogenous ESS identifier
275# If this is set, scans will be used to request response only from BSSes
276# belonging to the specified Homogeneous ESS. This is used only if interworking
277# is enabled.
278# hessid=00:11:22:33:44:55
279
280# Automatic network selection behavior
281# 0 = do not automatically go through Interworking network selection
282#     (i.e., require explicit interworking_select command for this; default)
283# 1 = perform Interworking network selection if one or more
284#     credentials have been configured and scan did not find a
285#     matching network block
286#auto_interworking=0
287
288# credential block
289#
290# Each credential used for automatic network selection is configured as a set
291# of parameters that are compared to the information advertised by the APs when
292# interworking_select and interworking_connect commands are used.
293#
294# credential fields:
295#
296# priority: Priority group
297#	By default, all networks and credentials get the same priority group
298#	(0). This field can be used to give higher priority for credentials
299#	(and similarly in struct wpa_ssid for network blocks) to change the
300#	Interworking automatic networking selection behavior. The matching
301#	network (based on either an enabled network block or a credential)
302#	with the highest priority value will be selected.
303#
304# pcsc: Use PC/SC and SIM/USIM card
305#
306# realm: Home Realm for Interworking
307#
308# username: Username for Interworking network selection
309#
310# password: Password for Interworking network selection
311#
312# ca_cert: CA certificate for Interworking network selection
313#
314# client_cert: File path to client certificate file (PEM/DER)
315#	This field is used with Interworking networking selection for a case
316#	where client certificate/private key is used for authentication
317#	(EAP-TLS). Full path to the file should be used since working
318#	directory may change when wpa_supplicant is run in the background.
319#
320#	Alternatively, a named configuration blob can be used by setting
321#	this to blob://blob_name.
322#
323# private_key: File path to client private key file (PEM/DER/PFX)
324#	When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
325#	commented out. Both the private key and certificate will be read
326#	from the PKCS#12 file in this case. Full path to the file should be
327#	used since working directory may change when wpa_supplicant is run
328#	in the background.
329#
330#	Windows certificate store can be used by leaving client_cert out and
331#	configuring private_key in one of the following formats:
332#
333#	cert://substring_to_match
334#
335#	hash://certificate_thumbprint_in_hex
336#
337#	For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
338#
339#	Note that when running wpa_supplicant as an application, the user
340#	certificate store (My user account) is used, whereas computer store
341#	(Computer account) is used when running wpasvc as a service.
342#
343#	Alternatively, a named configuration blob can be used by setting
344#	this to blob://blob_name.
345#
346# private_key_passwd: Password for private key file
347#
348# imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
349#
350# milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
351#	format
352#
353# domain: Home service provider FQDN
354#	This is used to compare against the Domain Name List to figure out
355#	whether the AP is operated by the Home SP.
356#
357# roaming_consortium: Roaming Consortium OI
358#	If roaming_consortium_len is non-zero, this field contains the
359#	Roaming Consortium OI that can be used to determine which access
360#	points support authentication with this credential. This is an
361#	alternative to the use of the realm parameter. When using Roaming
362#	Consortium to match the network, the EAP parameters need to be
363#	pre-configured with the credential since the NAI Realm information
364#	may not be available or fetched.
365#
366# eap: Pre-configured EAP method
367#	This optional field can be used to specify which EAP method will be
368#	used with this credential. If not set, the EAP method is selected
369#	automatically based on ANQP information (e.g., NAI Realm).
370#
371# phase1: Pre-configure Phase 1 (outer authentication) parameters
372#	This optional field is used with like the 'eap' parameter.
373#
374# phase2: Pre-configure Phase 2 (inner authentication) parameters
375#	This optional field is used with like the 'eap' parameter.
376#
377# for example:
378#
379#cred={
380#	realm="example.com"
381#	username="user@example.com"
382#	password="password"
383#	ca_cert="/etc/wpa_supplicant/ca.pem"
384#	domain="example.com"
385#}
386#
387#cred={
388#	imsi="310026-000000000"
389#	milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
390#}
391#
392#cred={
393#	realm="example.com"
394#	username="user"
395#	password="password"
396#	ca_cert="/etc/wpa_supplicant/ca.pem"
397#	domain="example.com"
398#	roaming_consortium=223344
399#	eap=TTLS
400#	phase2="auth=MSCHAPV2"
401#}
402
403# Hotspot 2.0
404# hs20=1
405
406# network block
407#
408# Each network (usually AP's sharing the same SSID) is configured as a separate
409# block in this configuration file. The network blocks are in preference order
410# (the first match is used).
411#
412# network block fields:
413#
414# disabled:
415#	0 = this network can be used (default)
416#	1 = this network block is disabled (can be enabled through ctrl_iface,
417#	    e.g., with wpa_cli or wpa_gui)
418#
419# id_str: Network identifier string for external scripts. This value is passed
420#	to external action script through wpa_cli as WPA_ID_STR environment
421#	variable to make it easier to do network specific configuration.
422#
423# ssid: SSID (mandatory); network name in one of the optional formats:
424#	- an ASCII string with double quotation
425#	- a hex string (two characters per octet of SSID)
426#	- a printf-escaped ASCII string P"<escaped string>"
427#
428# scan_ssid:
429#	0 = do not scan this SSID with specific Probe Request frames (default)
430#	1 = scan with SSID-specific Probe Request frames (this can be used to
431#	    find APs that do not accept broadcast SSID or use multiple SSIDs;
432#	    this will add latency to scanning, so enable this only when needed)
433#
434# bssid: BSSID (optional); if set, this network block is used only when
435#	associating with the AP using the configured BSSID
436#
437# priority: priority group (integer)
438# By default, all networks will get same priority group (0). If some of the
439# networks are more desirable, this field can be used to change the order in
440# which wpa_supplicant goes through the networks when selecting a BSS. The
441# priority groups will be iterated in decreasing priority (i.e., the larger the
442# priority value, the sooner the network is matched against the scan results).
443# Within each priority group, networks will be selected based on security
444# policy, signal strength, etc.
445# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
446# using this priority to select the order for scanning. Instead, they try the
447# networks in the order that used in the configuration file.
448#
449# mode: IEEE 802.11 operation mode
450# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
451# 1 = IBSS (ad-hoc, peer-to-peer)
452# 2 = AP (access point)
453# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
454# and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
455# following network block options:
456# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
457# both), and psk must also be set.
458#
459# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
460# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
461# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
462# In addition, this value is only used by the station that creates the IBSS. If
463# an IBSS network with the configured SSID is already present, the frequency of
464# the network will be used instead of this configured value.
465#
466# scan_freq: List of frequencies to scan
467# Space-separated list of frequencies in MHz to scan when searching for this
468# BSS. If the subset of channels used by the network is known, this option can
469# be used to optimize scanning to not occur on channels that the network does
470# not use. Example: scan_freq=2412 2437 2462
471#
472# freq_list: Array of allowed frequencies
473# Space-separated list of frequencies in MHz to allow for selecting the BSS. If
474# set, scan results that do not match any of the specified frequencies are not
475# considered when selecting a BSS.
476#
477# proto: list of accepted protocols
478# WPA = WPA/IEEE 802.11i/D3.0
479# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
480# If not set, this defaults to: WPA RSN
481#
482# key_mgmt: list of accepted authenticated key management protocols
483# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
484# WPA-EAP = WPA using EAP authentication
485# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
486#	generated WEP keys
487# NONE = WPA is not used; plaintext or static WEP could be used
488# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
489# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
490# If not set, this defaults to: WPA-PSK WPA-EAP
491#
492# ieee80211w: whether management frame protection is enabled
493# 0 = disabled (default)
494# 1 = optional
495# 2 = required
496# The most common configuration options for this based on the PMF (protected
497# management frames) certification program are:
498# PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
499# PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
500# (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
501#
502# auth_alg: list of allowed IEEE 802.11 authentication algorithms
503# OPEN = Open System authentication (required for WPA/WPA2)
504# SHARED = Shared Key authentication (requires static WEP keys)
505# LEAP = LEAP/Network EAP (only used with LEAP)
506# If not set, automatic selection is used (Open System with LEAP enabled if
507# LEAP is allowed as one of the EAP methods).
508#
509# pairwise: list of accepted pairwise (unicast) ciphers for WPA
510# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
511# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
512# NONE = Use only Group Keys (deprecated, should not be included if APs support
513#	pairwise keys)
514# If not set, this defaults to: CCMP TKIP
515#
516# group: list of accepted group (broadcast/multicast) ciphers for WPA
517# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
518# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
519# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
520# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
521# If not set, this defaults to: CCMP TKIP WEP104 WEP40
522#
523# psk: WPA preshared key; 256-bit pre-shared key
524# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
525# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
526# generated using the passphrase and SSID). ASCII passphrase must be between
527# 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
528# be used to indicate that the PSK/passphrase is stored in external storage.
529# This field is not needed, if WPA-EAP is used.
530# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
531# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
532# startup and reconfiguration time can be optimized by generating the PSK only
533# only when the passphrase or SSID has actually changed.
534#
535# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
536# Dynamic WEP key required for non-WPA mode
537# bit0 (1): require dynamically generated unicast WEP key
538# bit1 (2): require dynamically generated broadcast WEP key
539# 	(3 = require both keys; default)
540# Note: When using wired authentication, eapol_flags must be set to 0 for the
541# authentication to be completed successfully.
542#
543# mixed_cell: This option can be used to configure whether so called mixed
544# cells, i.e., networks that use both plaintext and encryption in the same
545# SSID, are allowed when selecting a BSS from scan results.
546# 0 = disabled (default)
547# 1 = enabled
548#
549# proactive_key_caching:
550# Enable/disable opportunistic PMKSA caching for WPA2.
551# 0 = disabled (default)
552# 1 = enabled
553#
554# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
555# hex without quotation, e.g., 0102030405)
556# wep_tx_keyidx: Default WEP key index (TX) (0..3)
557#
558# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
559# allowed. This is only used with RSN/WPA2.
560# 0 = disabled (default)
561# 1 = enabled
562#peerkey=1
563#
564# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
565# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
566#
567# Following fields are only used with internal EAP implementation.
568# eap: space-separated list of accepted EAP methods
569#	MD5 = EAP-MD5 (unsecure and does not generate keying material ->
570#			cannot be used with WPA; to be used as a Phase 2 method
571#			with EAP-PEAP or EAP-TTLS)
572#       MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
573#		as a Phase 2 method with EAP-PEAP or EAP-TTLS)
574#       OTP = EAP-OTP (cannot be used separately with WPA; to be used
575#		as a Phase 2 method with EAP-PEAP or EAP-TTLS)
576#       GTC = EAP-GTC (cannot be used separately with WPA; to be used
577#		as a Phase 2 method with EAP-PEAP or EAP-TTLS)
578#	TLS = EAP-TLS (client and server certificate)
579#	PEAP = EAP-PEAP (with tunnelled EAP authentication)
580#	TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
581#			 authentication)
582#	If not set, all compiled in methods are allowed.
583#
584# identity: Identity string for EAP
585#	This field is also used to configure user NAI for
586#	EAP-PSK/PAX/SAKE/GPSK.
587# anonymous_identity: Anonymous identity string for EAP (to be used as the
588#	unencrypted identity with EAP types that support different tunnelled
589#	identity, e.g., EAP-TTLS). This field can also be used with
590#	EAP-SIM/AKA/AKA' to store the pseudonym identity.
591# password: Password string for EAP. This field can include either the
592#	plaintext password (using ASCII or hex string) or a NtPasswordHash
593#	(16-byte MD4 hash of password) in hash:<32 hex digits> format.
594#	NtPasswordHash can only be used when the password is for MSCHAPv2 or
595#	MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
596#	EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
597#	PSK) is also configured using this field. For EAP-GPSK, this is a
598#	variable length PSK. ext:<name of external password field> format can
599#	be used to indicate that the password is stored in external storage.
600# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
601#	or more trusted CA certificates. If ca_cert and ca_path are not
602#	included, server certificate will not be verified. This is insecure and
603#	a trusted CA certificate should always be configured when using
604#	EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
605#	change when wpa_supplicant is run in the background.
606#
607#	Alternatively, this can be used to only perform matching of the server
608#	certificate (SHA-256 hash of the DER encoded X.509 certificate). In
609#	this case, the possible CA certificates in the server certificate chain
610#	are ignored and only the server certificate is verified. This is
611#	configured with the following format:
612#	hash:://server/sha256/cert_hash_in_hex
613#	For example: "hash://server/sha256/
614#	5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
615#
616#	On Windows, trusted CA certificates can be loaded from the system
617#	certificate store by setting this to cert_store://<name>, e.g.,
618#	ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
619#	Note that when running wpa_supplicant as an application, the user
620#	certificate store (My user account) is used, whereas computer store
621#	(Computer account) is used when running wpasvc as a service.
622# ca_path: Directory path for CA certificate files (PEM). This path may
623#	contain multiple CA certificates in OpenSSL format. Common use for this
624#	is to point to system trusted CA list which is often installed into
625#	directory like /etc/ssl/certs. If configured, these certificates are
626#	added to the list of trusted CAs. ca_cert may also be included in that
627#	case, but it is not required.
628# client_cert: File path to client certificate file (PEM/DER)
629#	Full path should be used since working directory may change when
630#	wpa_supplicant is run in the background.
631#	Alternatively, a named configuration blob can be used by setting this
632#	to blob://<blob name>.
633# private_key: File path to client private key file (PEM/DER/PFX)
634#	When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
635#	commented out. Both the private key and certificate will be read from
636#	the PKCS#12 file in this case. Full path should be used since working
637#	directory may change when wpa_supplicant is run in the background.
638#	Windows certificate store can be used by leaving client_cert out and
639#	configuring private_key in one of the following formats:
640#	cert://substring_to_match
641#	hash://certificate_thumbprint_in_hex
642#	for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
643#	Note that when running wpa_supplicant as an application, the user
644#	certificate store (My user account) is used, whereas computer store
645#	(Computer account) is used when running wpasvc as a service.
646#	Alternatively, a named configuration blob can be used by setting this
647#	to blob://<blob name>.
648# private_key_passwd: Password for private key file (if left out, this will be
649#	asked through control interface)
650# dh_file: File path to DH/DSA parameters file (in PEM format)
651#	This is an optional configuration file for setting parameters for an
652#	ephemeral DH key exchange. In most cases, the default RSA
653#	authentication does not use this configuration. However, it is possible
654#	setup RSA to use ephemeral DH key exchange. In addition, ciphers with
655#	DSA keys always use ephemeral DH keys. This can be used to achieve
656#	forward secrecy. If the file is in DSA parameters format, it will be
657#	automatically converted into DH params.
658# subject_match: Substring to be matched against the subject of the
659#	authentication server certificate. If this string is set, the server
660#	sertificate is only accepted if it contains this string in the subject.
661#	The subject string is in following format:
662#	/C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
663# altsubject_match: Semicolon separated string of entries to be matched against
664#	the alternative subject name of the authentication server certificate.
665#	If this string is set, the server sertificate is only accepted if it
666#	contains one of the entries in an alternative subject name extension.
667#	altSubjectName string is in following format: TYPE:VALUE
668#	Example: EMAIL:server@example.com
669#	Example: DNS:server.example.com;DNS:server2.example.com
670#	Following types are supported: EMAIL, DNS, URI
671# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
672#	(string with field-value pairs, e.g., "peapver=0" or
673#	"peapver=1 peaplabel=1")
674#	'peapver' can be used to force which PEAP version (0 or 1) is used.
675#	'peaplabel=1' can be used to force new label, "client PEAP encryption",
676#	to be used during key derivation when PEAPv1 or newer. Most existing
677#	PEAPv1 implementation seem to be using the old label, "client EAP
678#	encryption", and wpa_supplicant is now using that as the default value.
679#	Some servers, e.g., Radiator, may require peaplabel=1 configuration to
680#	interoperate with PEAPv1; see eap_testing.txt for more details.
681#	'peap_outer_success=0' can be used to terminate PEAP authentication on
682#	tunneled EAP-Success. This is required with some RADIUS servers that
683#	implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
684#	Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
685#	include_tls_length=1 can be used to force wpa_supplicant to include
686#	TLS Message Length field in all TLS messages even if they are not
687#	fragmented.
688#	sim_min_num_chal=3 can be used to configure EAP-SIM to require three
689#	challenges (by default, it accepts 2 or 3)
690#	result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
691#	protected result indication.
692#	'crypto_binding' option can be used to control PEAPv0 cryptobinding
693#	behavior:
694#	 * 0 = do not use cryptobinding (default)
695#	 * 1 = use cryptobinding if server supports it
696#	 * 2 = require cryptobinding
697#	EAP-WSC (WPS) uses following options: pin=<Device Password> or
698#	pbc=1.
699# phase2: Phase2 (inner authentication with TLS tunnel) parameters
700#	(string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
701#	"autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
702#
703# TLS-based methods can use the following parameters to control TLS behavior
704# (these are normally in the phase1 parameter, but can be used also in the
705# phase2 parameter when EAP-TLS is used within the inner tunnel):
706# tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
707#	TLS library, these may be disabled by default to enforce stronger
708#	security)
709# tls_disable_time_checks=1 - ignore certificate validity time (this requests
710#	the TLS library to accept certificates even if they are not currently
711#	valid, i.e., have expired or have not yet become valid; this should be
712#	used only for testing purposes)
713# tls_disable_session_ticket=1 - disable TLS Session Ticket extension
714# tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
715#	Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
716#	as a workaround for broken authentication server implementations unless
717#	EAP workarounds are disabled with eap_workarounds=0.
718#	For EAP-FAST, this must be set to 0 (or left unconfigured for the
719#	default value to be used automatically).
720#
721# Following certificate/private key fields are used in inner Phase2
722# authentication when using EAP-TTLS or EAP-PEAP.
723# ca_cert2: File path to CA certificate file. This file can have one or more
724#	trusted CA certificates. If ca_cert2 and ca_path2 are not included,
725#	server certificate will not be verified. This is insecure and a trusted
726#	CA certificate should always be configured.
727# ca_path2: Directory path for CA certificate files (PEM)
728# client_cert2: File path to client certificate file
729# private_key2: File path to client private key file
730# private_key2_passwd: Password for private key file
731# dh_file2: File path to DH/DSA parameters file (in PEM format)
732# subject_match2: Substring to be matched against the subject of the
733#	authentication server certificate.
734# altsubject_match2: Substring to be matched against the alternative subject
735#	name of the authentication server certificate.
736#
737# fragment_size: Maximum EAP fragment size in bytes (default 1398).
738#	This value limits the fragment size for EAP methods that support
739#	fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
740#	small enough to make the EAP messages fit in MTU of the network
741#	interface used for EAPOL. The default value is suitable for most
742#	cases.
743#
744# EAP-FAST variables:
745# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
746#	to create this file and write updates to it when PAC is being
747#	provisioned or refreshed. Full path to the file should be used since
748#	working directory may change when wpa_supplicant is run in the
749#	background. Alternatively, a named configuration blob can be used by
750#	setting this to blob://<blob name>
751# phase1: fast_provisioning option can be used to enable in-line provisioning
752#         of EAP-FAST credentials (PAC):
753#         0 = disabled,
754#         1 = allow unauthenticated provisioning,
755#         2 = allow authenticated provisioning,
756#         3 = allow both unauthenticated and authenticated provisioning
757#	fast_max_pac_list_len=<num> option can be used to set the maximum
758#		number of PAC entries to store in a PAC list (default: 10)
759#	fast_pac_format=binary option can be used to select binary format for
760#		storing PAC entries in order to save some space (the default
761#		text format uses about 2.5 times the size of minimal binary
762#		format)
763#
764# wpa_supplicant supports number of "EAP workarounds" to work around
765# interoperability issues with incorrectly behaving authentication servers.
766# These are enabled by default because some of the issues are present in large
767# number of authentication servers. Strict EAP conformance mode can be
768# configured by disabling workarounds with eap_workaround=0.
769
770# Station inactivity limit
771#
772# If a station does not send anything in ap_max_inactivity seconds, an
773# empty data frame is sent to it in order to verify whether it is
774# still in range. If this frame is not ACKed, the station will be
775# disassociated and then deauthenticated. This feature is used to
776# clear station table of old entries when the STAs move out of the
777# range.
778#
779# The station can associate again with the AP if it is still in range;
780# this inactivity poll is just used as a nicer way of verifying
781# inactivity; i.e., client will not report broken connection because
782# disassociation frame is not sent immediately without first polling
783# the STA with a data frame.
784# default: 300 (i.e., 5 minutes)
785#ap_max_inactivity=300
786
787# DTIM period in Beacon intervals for AP mode (default: 2)
788#dtim_period=2
789
790# Example blocks:
791
792# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
793network={
794	ssid="simple"
795	psk="very secret passphrase"
796	priority=5
797}
798
799# Same as previous, but request SSID-specific scanning (for APs that reject
800# broadcast SSID)
801network={
802	ssid="second ssid"
803	scan_ssid=1
804	psk="very secret passphrase"
805	priority=2
806}
807
808# Only WPA-PSK is used. Any valid cipher combination is accepted.
809network={
810	ssid="example"
811	proto=WPA
812	key_mgmt=WPA-PSK
813	pairwise=CCMP TKIP
814	group=CCMP TKIP WEP104 WEP40
815	psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
816	priority=2
817}
818
819# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
820network={
821	ssid="example"
822	proto=WPA
823	key_mgmt=WPA-PSK
824	pairwise=TKIP
825	group=TKIP
826	psk="not so secure passphrase"
827	wpa_ptk_rekey=600
828}
829
830# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
831# or WEP40 as the group cipher will not be accepted.
832network={
833	ssid="example"
834	proto=RSN
835	key_mgmt=WPA-EAP
836	pairwise=CCMP TKIP
837	group=CCMP TKIP
838	eap=TLS
839	identity="user@example.com"
840	ca_cert="/etc/cert/ca.pem"
841	client_cert="/etc/cert/user.pem"
842	private_key="/etc/cert/user.prv"
843	private_key_passwd="password"
844	priority=1
845}
846
847# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
848# (e.g., Radiator)
849network={
850	ssid="example"
851	key_mgmt=WPA-EAP
852	eap=PEAP
853	identity="user@example.com"
854	password="foobar"
855	ca_cert="/etc/cert/ca.pem"
856	phase1="peaplabel=1"
857	phase2="auth=MSCHAPV2"
858	priority=10
859}
860
861# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
862# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
863network={
864	ssid="example"
865	key_mgmt=WPA-EAP
866	eap=TTLS
867	identity="user@example.com"
868	anonymous_identity="anonymous@example.com"
869	password="foobar"
870	ca_cert="/etc/cert/ca.pem"
871	priority=2
872}
873
874# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
875# use. Real identity is sent only within an encrypted TLS tunnel.
876network={
877	ssid="example"
878	key_mgmt=WPA-EAP
879	eap=TTLS
880	identity="user@example.com"
881	anonymous_identity="anonymous@example.com"
882	password="foobar"
883	ca_cert="/etc/cert/ca.pem"
884	phase2="auth=MSCHAPV2"
885}
886
887# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
888# authentication.
889network={
890	ssid="example"
891	key_mgmt=WPA-EAP
892	eap=TTLS
893	# Phase1 / outer authentication
894	anonymous_identity="anonymous@example.com"
895	ca_cert="/etc/cert/ca.pem"
896	# Phase 2 / inner authentication
897	phase2="autheap=TLS"
898	ca_cert2="/etc/cert/ca2.pem"
899	client_cert2="/etc/cer/user.pem"
900	private_key2="/etc/cer/user.prv"
901	private_key2_passwd="password"
902	priority=2
903}
904
905# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
906# group cipher.
907network={
908	ssid="example"
909	bssid=00:11:22:33:44:55
910	proto=WPA RSN
911	key_mgmt=WPA-PSK WPA-EAP
912	pairwise=CCMP
913	group=CCMP
914	psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
915}
916
917# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
918# and all valid ciphers.
919network={
920	ssid=00010203
921	psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
922}
923
924
925# EAP-SIM with a GSM SIM or USIM
926network={
927	ssid="eap-sim-test"
928	key_mgmt=WPA-EAP
929	eap=SIM
930	pin="1234"
931	pcsc=""
932}
933
934
935# EAP-PSK
936network={
937	ssid="eap-psk-test"
938	key_mgmt=WPA-EAP
939	eap=PSK
940	anonymous_identity="eap_psk_user"
941	password=06b4be19da289f475aa46a33cb793029
942	identity="eap_psk_user@example.com"
943}
944
945
946# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
947# EAP-TLS for authentication and key generation; require both unicast and
948# broadcast WEP keys.
949network={
950	ssid="1x-test"
951	key_mgmt=IEEE8021X
952	eap=TLS
953	identity="user@example.com"
954	ca_cert="/etc/cert/ca.pem"
955	client_cert="/etc/cert/user.pem"
956	private_key="/etc/cert/user.prv"
957	private_key_passwd="password"
958	eapol_flags=3
959}
960
961
962# LEAP with dynamic WEP keys
963network={
964	ssid="leap-example"
965	key_mgmt=IEEE8021X
966	eap=LEAP
967	identity="user"
968	password="foobar"
969}
970
971# EAP-IKEv2 using shared secrets for both server and peer authentication
972network={
973	ssid="ikev2-example"
974	key_mgmt=WPA-EAP
975	eap=IKEV2
976	identity="user"
977	password="foobar"
978}
979
980# EAP-FAST with WPA (WPA or WPA2)
981network={
982	ssid="eap-fast-test"
983	key_mgmt=WPA-EAP
984	eap=FAST
985	anonymous_identity="FAST-000102030405"
986	identity="username"
987	password="password"
988	phase1="fast_provisioning=1"
989	pac_file="/etc/wpa_supplicant.eap-fast-pac"
990}
991
992network={
993	ssid="eap-fast-test"
994	key_mgmt=WPA-EAP
995	eap=FAST
996	anonymous_identity="FAST-000102030405"
997	identity="username"
998	password="password"
999	phase1="fast_provisioning=1"
1000	pac_file="blob://eap-fast-pac"
1001}
1002
1003# Plaintext connection (no WPA, no IEEE 802.1X)
1004network={
1005	ssid="plaintext-test"
1006	key_mgmt=NONE
1007}
1008
1009
1010# Shared WEP key connection (no WPA, no IEEE 802.1X)
1011network={
1012	ssid="static-wep-test"
1013	key_mgmt=NONE
1014	wep_key0="abcde"
1015	wep_key1=0102030405
1016	wep_key2="1234567890123"
1017	wep_tx_keyidx=0
1018	priority=5
1019}
1020
1021
1022# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1023# IEEE 802.11 authentication
1024network={
1025	ssid="static-wep-test2"
1026	key_mgmt=NONE
1027	wep_key0="abcde"
1028	wep_key1=0102030405
1029	wep_key2="1234567890123"
1030	wep_tx_keyidx=0
1031	priority=5
1032	auth_alg=SHARED
1033}
1034
1035
1036# IBSS/ad-hoc network with WPA-None/TKIP.
1037network={
1038	ssid="test adhoc"
1039	mode=1
1040	frequency=2412
1041	proto=WPA
1042	key_mgmt=WPA-NONE
1043	pairwise=NONE
1044	group=TKIP
1045	psk="secret passphrase"
1046}
1047
1048
1049# Catch all example that allows more or less all configuration modes
1050network={
1051	ssid="example"
1052	scan_ssid=1
1053	key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1054	pairwise=CCMP TKIP
1055	group=CCMP TKIP WEP104 WEP40
1056	psk="very secret passphrase"
1057	eap=TTLS PEAP TLS
1058	identity="user@example.com"
1059	password="foobar"
1060	ca_cert="/etc/cert/ca.pem"
1061	client_cert="/etc/cert/user.pem"
1062	private_key="/etc/cert/user.prv"
1063	private_key_passwd="password"
1064	phase1="peaplabel=0"
1065}
1066
1067# Example of EAP-TLS with smartcard (openssl engine)
1068network={
1069	ssid="example"
1070	key_mgmt=WPA-EAP
1071	eap=TLS
1072	proto=RSN
1073	pairwise=CCMP TKIP
1074	group=CCMP TKIP
1075	identity="user@example.com"
1076	ca_cert="/etc/cert/ca.pem"
1077	client_cert="/etc/cert/user.pem"
1078
1079	engine=1
1080
1081	# The engine configured here must be available. Look at
1082	# OpenSSL engine support in the global section.
1083	# The key available through the engine must be the private key
1084	# matching the client certificate configured above.
1085
1086	# use the opensc engine
1087	#engine_id="opensc"
1088	#key_id="45"
1089
1090	# use the pkcs11 engine
1091	engine_id="pkcs11"
1092	key_id="id_45"
1093
1094	# Optional PIN configuration; this can be left out and PIN will be
1095	# asked through the control interface
1096	pin="1234"
1097}
1098
1099# Example configuration showing how to use an inlined blob as a CA certificate
1100# data instead of using external file
1101network={
1102	ssid="example"
1103	key_mgmt=WPA-EAP
1104	eap=TTLS
1105	identity="user@example.com"
1106	anonymous_identity="anonymous@example.com"
1107	password="foobar"
1108	ca_cert="blob://exampleblob"
1109	priority=20
1110}
1111
1112blob-base64-exampleblob={
1113SGVsbG8gV29ybGQhCg==
1114}
1115
1116
1117# Wildcard match for SSID (plaintext APs only). This example select any
1118# open AP regardless of its SSID.
1119network={
1120	key_mgmt=NONE
1121}
1122