]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/wpa_supplicant.conf
Add TLS client events, server probing, and srv cert matching
[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
31# interface mechanism is used. For all cases, the existance 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.
b55aaa5f
JM
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)
6fc6879b
JM
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
b55aaa5f
JM
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.
6fc6879b
JM
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
814e925d
JM
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
6fc6879b
JM
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
f855f923
JM
156# Wi-Fi Protected Setup (WPS) parameters
157
158# Universally Unique IDentifier (UUID; see RFC 4122) of the device
79da74a2 159# If not configured, UUID will be generated based on the local MAC address.
f855f923
JM
160#uuid=12345678-9abc-def0-1234-56789abcdef0
161
3c0b7aa4
JM
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)
e83a0898 193#device_type=1-0050F204-1
3c0b7aa4
JM
194
195# OS Version
196# 4-octet operating system version number (hex string)
197#os_version=01020300
198
c0e4dd9e
JM
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
203#config_methods=label display push_button keypad
204
47662164
JM
205# Credential processing
206# 0 = process received credentials internally (default)
207# 1 = do not process received credentials; just pass them over ctrl_iface to
208# external program(s)
209# 2 = process received credentials internally and pass them over ctrl_iface
210# to external program(s)
211#wps_cred_processing=0
f855f923 212
6fc6879b
JM
213# network block
214#
215# Each network (usually AP's sharing the same SSID) is configured as a separate
216# block in this configuration file. The network blocks are in preference order
217# (the first match is used).
218#
219# network block fields:
220#
221# disabled:
222# 0 = this network can be used (default)
223# 1 = this network block is disabled (can be enabled through ctrl_iface,
224# e.g., with wpa_cli or wpa_gui)
225#
226# id_str: Network identifier string for external scripts. This value is passed
227# to external action script through wpa_cli as WPA_ID_STR environment
228# variable to make it easier to do network specific configuration.
229#
230# ssid: SSID (mandatory); either as an ASCII string with double quotation or
231# as hex string; network name
232#
233# scan_ssid:
234# 0 = do not scan this SSID with specific Probe Request frames (default)
235# 1 = scan with SSID-specific Probe Request frames (this can be used to
236# find APs that do not accept broadcast SSID or use multiple SSIDs;
237# this will add latency to scanning, so enable this only when needed)
238#
239# bssid: BSSID (optional); if set, this network block is used only when
240# associating with the AP using the configured BSSID
241#
242# priority: priority group (integer)
243# By default, all networks will get same priority group (0). If some of the
244# networks are more desirable, this field can be used to change the order in
245# which wpa_supplicant goes through the networks when selecting a BSS. The
246# priority groups will be iterated in decreasing priority (i.e., the larger the
247# priority value, the sooner the network is matched against the scan results).
248# Within each priority group, networks will be selected based on security
249# policy, signal strength, etc.
250# Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
251# using this priority to select the order for scanning. Instead, they try the
252# networks in the order that used in the configuration file.
253#
254# mode: IEEE 802.11 operation mode
255# 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
256# 1 = IBSS (ad-hoc, peer-to-peer)
1581b38b 257# 2 = AP (access point)
6fc6879b 258# Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
b55aaa5f
JM
259# and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
260# following network block options:
6fc6879b
JM
261# proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
262# both), and psk must also be set.
263#
264# frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
265# 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
266# channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
267# In addition, this value is only used by the station that creates the IBSS. If
268# an IBSS network with the configured SSID is already present, the frequency of
269# the network will be used instead of this configured value.
270#
d3a98225
JM
271# scan_freq: List of frequencies to scan
272# Space-separated list of frequencies in MHz to scan when searching for this
273# BSS. If the subset of channels used by the network is known, this option can
274# be used to optimize scanning to not occur on channels that the network does
275# not use. Example: scan_freq=2412 2437 2462
276#
6fc6879b
JM
277# proto: list of accepted protocols
278# WPA = WPA/IEEE 802.11i/D3.0
279# RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
280# If not set, this defaults to: WPA RSN
281#
282# key_mgmt: list of accepted authenticated key management protocols
283# WPA-PSK = WPA pre-shared key (this requires 'psk' field)
f6190d37 284# WPA-EAP = WPA using EAP authentication
6fc6879b
JM
285# IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
286# generated WEP keys
287# NONE = WPA is not used; plaintext or static WEP could be used
56586197
JM
288# WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
289# WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
6fc6879b
JM
290# If not set, this defaults to: WPA-PSK WPA-EAP
291#
292# auth_alg: list of allowed IEEE 802.11 authentication algorithms
293# OPEN = Open System authentication (required for WPA/WPA2)
294# SHARED = Shared Key authentication (requires static WEP keys)
295# LEAP = LEAP/Network EAP (only used with LEAP)
296# If not set, automatic selection is used (Open System with LEAP enabled if
297# LEAP is allowed as one of the EAP methods).
298#
299# pairwise: list of accepted pairwise (unicast) ciphers for WPA
300# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
301# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
302# NONE = Use only Group Keys (deprecated, should not be included if APs support
303# pairwise keys)
304# If not set, this defaults to: CCMP TKIP
305#
306# group: list of accepted group (broadcast/multicast) ciphers for WPA
307# CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
308# TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
309# WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
310# WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
311# If not set, this defaults to: CCMP TKIP WEP104 WEP40
312#
313# psk: WPA preshared key; 256-bit pre-shared key
314# The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
315# 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
316# generated using the passphrase and SSID). ASCII passphrase must be between
317# 8 and 63 characters (inclusive).
318# This field is not needed, if WPA-EAP is used.
319# Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
320# from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
321# startup and reconfiguration time can be optimized by generating the PSK only
322# only when the passphrase or SSID has actually changed.
323#
324# eapol_flags: IEEE 802.1X/EAPOL options (bit field)
325# Dynamic WEP key required for non-WPA mode
326# bit0 (1): require dynamically generated unicast WEP key
327# bit1 (2): require dynamically generated broadcast WEP key
328# (3 = require both keys; default)
329# Note: When using wired authentication, eapol_flags must be set to 0 for the
330# authentication to be completed successfully.
331#
332# mixed_cell: This option can be used to configure whether so called mixed
333# cells, i.e., networks that use both plaintext and encryption in the same
334# SSID, are allowed when selecting a BSS form scan results.
335# 0 = disabled (default)
336# 1 = enabled
337#
338# proactive_key_caching:
339# Enable/disable opportunistic PMKSA caching for WPA2.
340# 0 = disabled (default)
341# 1 = enabled
342#
343# wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
344# hex without quotation, e.g., 0102030405)
345# wep_tx_keyidx: Default WEP key index (TX) (0..3)
346#
347# peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
348# allowed. This is only used with RSN/WPA2.
349# 0 = disabled (default)
350# 1 = enabled
351#peerkey=1
352#
581a8cde
JM
353# wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
354# enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
355#
6fc6879b
JM
356# Following fields are only used with internal EAP implementation.
357# eap: space-separated list of accepted EAP methods
358# MD5 = EAP-MD5 (unsecure and does not generate keying material ->
359# cannot be used with WPA; to be used as a Phase 2 method
360# with EAP-PEAP or EAP-TTLS)
361# MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
362# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
363# OTP = EAP-OTP (cannot be used separately with WPA; to be used
364# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
365# GTC = EAP-GTC (cannot be used separately with WPA; to be used
366# as a Phase 2 method with EAP-PEAP or EAP-TTLS)
367# TLS = EAP-TLS (client and server certificate)
368# PEAP = EAP-PEAP (with tunnelled EAP authentication)
369# TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
370# authentication)
371# If not set, all compiled in methods are allowed.
372#
373# identity: Identity string for EAP
374# This field is also used to configure user NAI for
375# EAP-PSK/PAX/SAKE/GPSK.
376# anonymous_identity: Anonymous identity string for EAP (to be used as the
377# unencrypted identity with EAP types that support different tunnelled
378# identity, e.g., EAP-TTLS)
379# password: Password string for EAP. This field can include either the
380# plaintext password (using ASCII or hex string) or a NtPasswordHash
381# (16-byte MD4 hash of password) in hash:<32 hex digits> format.
382# NtPasswordHash can only be used when the password is for MSCHAPv2 or
383# MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
384# EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
385# PSK) is also configured using this field. For EAP-GPSK, this is a
9474b3a4 386# variable length PSK.
6fc6879b
JM
387# ca_cert: File path to CA certificate file (PEM/DER). This file can have one
388# or more trusted CA certificates. If ca_cert and ca_path are not
389# included, server certificate will not be verified. This is insecure and
390# a trusted CA certificate should always be configured when using
391# EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
392# change when wpa_supplicant is run in the background.
00468b46
JM
393#
394# Alternatively, this can be used to only perform matching of the server
395# certificate (SHA-256 hash of the DER encoded X.509 certificate). In
396# this case, the possible CA certificates in the server certificate chain
397# are ignored and only the server certificate is verified. This is
398# configured with the following format:
399# hash:://server/sha256/cert_hash_in_hex
400# For example: "hash://server/sha256/
401# 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
402#
6fc6879b
JM
403# On Windows, trusted CA certificates can be loaded from the system
404# certificate store by setting this to cert_store://<name>, e.g.,
405# ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
406# Note that when running wpa_supplicant as an application, the user
407# certificate store (My user account) is used, whereas computer store
408# (Computer account) is used when running wpasvc as a service.
409# ca_path: Directory path for CA certificate files (PEM). This path may
410# contain multiple CA certificates in OpenSSL format. Common use for this
411# is to point to system trusted CA list which is often installed into
412# directory like /etc/ssl/certs. If configured, these certificates are
413# added to the list of trusted CAs. ca_cert may also be included in that
414# case, but it is not required.
415# client_cert: File path to client certificate file (PEM/DER)
416# Full path should be used since working directory may change when
417# wpa_supplicant is run in the background.
418# Alternatively, a named configuration blob can be used by setting this
419# to blob://<blob name>.
420# private_key: File path to client private key file (PEM/DER/PFX)
421# When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
422# commented out. Both the private key and certificate will be read from
423# the PKCS#12 file in this case. Full path should be used since working
424# directory may change when wpa_supplicant is run in the background.
425# Windows certificate store can be used by leaving client_cert out and
426# configuring private_key in one of the following formats:
427# cert://substring_to_match
428# hash://certificate_thumbprint_in_hex
429# for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
430# Note that when running wpa_supplicant as an application, the user
431# certificate store (My user account) is used, whereas computer store
432# (Computer account) is used when running wpasvc as a service.
433# Alternatively, a named configuration blob can be used by setting this
434# to blob://<blob name>.
435# private_key_passwd: Password for private key file (if left out, this will be
436# asked through control interface)
437# dh_file: File path to DH/DSA parameters file (in PEM format)
438# This is an optional configuration file for setting parameters for an
439# ephemeral DH key exchange. In most cases, the default RSA
440# authentication does not use this configuration. However, it is possible
441# setup RSA to use ephemeral DH key exchange. In addition, ciphers with
442# DSA keys always use ephemeral DH keys. This can be used to achieve
443# forward secrecy. If the file is in DSA parameters format, it will be
444# automatically converted into DH params.
445# subject_match: Substring to be matched against the subject of the
446# authentication server certificate. If this string is set, the server
447# sertificate is only accepted if it contains this string in the subject.
448# The subject string is in following format:
449# /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
450# altsubject_match: Semicolon separated string of entries to be matched against
451# the alternative subject name of the authentication server certificate.
452# If this string is set, the server sertificate is only accepted if it
453# contains one of the entries in an alternative subject name extension.
454# altSubjectName string is in following format: TYPE:VALUE
455# Example: EMAIL:server@example.com
456# Example: DNS:server.example.com;DNS:server2.example.com
457# Following types are supported: EMAIL, DNS, URI
458# phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
459# (string with field-value pairs, e.g., "peapver=0" or
460# "peapver=1 peaplabel=1")
461# 'peapver' can be used to force which PEAP version (0 or 1) is used.
462# 'peaplabel=1' can be used to force new label, "client PEAP encryption",
463# to be used during key derivation when PEAPv1 or newer. Most existing
464# PEAPv1 implementation seem to be using the old label, "client EAP
465# encryption", and wpa_supplicant is now using that as the default value.
466# Some servers, e.g., Radiator, may require peaplabel=1 configuration to
467# interoperate with PEAPv1; see eap_testing.txt for more details.
468# 'peap_outer_success=0' can be used to terminate PEAP authentication on
469# tunneled EAP-Success. This is required with some RADIUS servers that
470# implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
471# Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
472# include_tls_length=1 can be used to force wpa_supplicant to include
473# TLS Message Length field in all TLS messages even if they are not
474# fragmented.
475# sim_min_num_chal=3 can be used to configure EAP-SIM to require three
476# challenges (by default, it accepts 2 or 3)
477# result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
478# protected result indication.
d6888f9e
JM
479# 'crypto_binding' option can be used to control PEAPv0 cryptobinding
480# behavior:
c31a11c9
JM
481# * 0 = do not use cryptobinding (default)
482# * 1 = use cryptobinding if server supports it
d6888f9e 483# * 2 = require cryptobinding
f855f923
JM
484# EAP-WSC (WPS) uses following options: pin=<Device Password> or
485# pbc=1.
6fc6879b
JM
486# phase2: Phase2 (inner authentication with TLS tunnel) parameters
487# (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
488# "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
489# Following certificate/private key fields are used in inner Phase2
490# authentication when using EAP-TTLS or EAP-PEAP.
491# ca_cert2: File path to CA certificate file. This file can have one or more
492# trusted CA certificates. If ca_cert2 and ca_path2 are not included,
493# server certificate will not be verified. This is insecure and a trusted
494# CA certificate should always be configured.
495# ca_path2: Directory path for CA certificate files (PEM)
496# client_cert2: File path to client certificate file
497# private_key2: File path to client private key file
498# private_key2_passwd: Password for private key file
499# dh_file2: File path to DH/DSA parameters file (in PEM format)
500# subject_match2: Substring to be matched against the subject of the
501# authentication server certificate.
502# altsubject_match2: Substring to be matched against the alternative subject
503# name of the authentication server certificate.
504#
505# fragment_size: Maximum EAP fragment size in bytes (default 1398).
506# This value limits the fragment size for EAP methods that support
507# fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
508# small enough to make the EAP messages fit in MTU of the network
509# interface used for EAPOL. The default value is suitable for most
510# cases.
511#
512# EAP-FAST variables:
513# pac_file: File path for the PAC entries. wpa_supplicant will need to be able
514# to create this file and write updates to it when PAC is being
515# provisioned or refreshed. Full path to the file should be used since
516# working directory may change when wpa_supplicant is run in the
517# background. Alternatively, a named configuration blob can be used by
518# setting this to blob://<blob name>
519# phase1: fast_provisioning option can be used to enable in-line provisioning
520# of EAP-FAST credentials (PAC):
521# 0 = disabled,
522# 1 = allow unauthenticated provisioning,
523# 2 = allow authenticated provisioning,
524# 3 = allow both unauthenticated and authenticated provisioning
525# fast_max_pac_list_len=<num> option can be used to set the maximum
526# number of PAC entries to store in a PAC list (default: 10)
527# fast_pac_format=binary option can be used to select binary format for
2e8c9a27 528# storing PAC entries in order to save some space (the default
6fc6879b
JM
529# text format uses about 2.5 times the size of minimal binary
530# format)
531#
532# wpa_supplicant supports number of "EAP workarounds" to work around
533# interoperability issues with incorrectly behaving authentication servers.
534# These are enabled by default because some of the issues are present in large
535# number of authentication servers. Strict EAP conformance mode can be
536# configured by disabling workarounds with eap_workaround=0.
537
538# Example blocks:
539
540# Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
541network={
542 ssid="simple"
543 psk="very secret passphrase"
544 priority=5
545}
546
547# Same as previous, but request SSID-specific scanning (for APs that reject
548# broadcast SSID)
549network={
550 ssid="second ssid"
551 scan_ssid=1
552 psk="very secret passphrase"
553 priority=2
554}
555
556# Only WPA-PSK is used. Any valid cipher combination is accepted.
557network={
558 ssid="example"
559 proto=WPA
560 key_mgmt=WPA-PSK
561 pairwise=CCMP TKIP
562 group=CCMP TKIP WEP104 WEP40
563 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
564 priority=2
565}
566
581a8cde
JM
567# WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
568network={
569 ssid="example"
570 proto=WPA
571 key_mgmt=WPA-PSK
572 pairwise=TKIP
573 group=TKIP
574 psk="not so secure passphrase"
575 wpa_ptk_rekey=600
576}
577
6fc6879b
JM
578# Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
579# or WEP40 as the group cipher will not be accepted.
580network={
581 ssid="example"
582 proto=RSN
583 key_mgmt=WPA-EAP
584 pairwise=CCMP TKIP
585 group=CCMP TKIP
586 eap=TLS
587 identity="user@example.com"
588 ca_cert="/etc/cert/ca.pem"
589 client_cert="/etc/cert/user.pem"
590 private_key="/etc/cert/user.prv"
591 private_key_passwd="password"
592 priority=1
593}
594
595# EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
596# (e.g., Radiator)
597network={
598 ssid="example"
599 key_mgmt=WPA-EAP
600 eap=PEAP
601 identity="user@example.com"
602 password="foobar"
603 ca_cert="/etc/cert/ca.pem"
604 phase1="peaplabel=1"
605 phase2="auth=MSCHAPV2"
606 priority=10
607}
608
609# EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
610# unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
611network={
612 ssid="example"
613 key_mgmt=WPA-EAP
614 eap=TTLS
615 identity="user@example.com"
616 anonymous_identity="anonymous@example.com"
617 password="foobar"
618 ca_cert="/etc/cert/ca.pem"
619 priority=2
620}
621
622# EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
623# use. Real identity is sent only within an encrypted TLS tunnel.
624network={
625 ssid="example"
626 key_mgmt=WPA-EAP
627 eap=TTLS
628 identity="user@example.com"
629 anonymous_identity="anonymous@example.com"
630 password="foobar"
631 ca_cert="/etc/cert/ca.pem"
632 phase2="auth=MSCHAPV2"
633}
634
635# WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
636# authentication.
637network={
638 ssid="example"
639 key_mgmt=WPA-EAP
640 eap=TTLS
641 # Phase1 / outer authentication
642 anonymous_identity="anonymous@example.com"
643 ca_cert="/etc/cert/ca.pem"
644 # Phase 2 / inner authentication
645 phase2="autheap=TLS"
646 ca_cert2="/etc/cert/ca2.pem"
647 client_cert2="/etc/cer/user.pem"
648 private_key2="/etc/cer/user.prv"
649 private_key2_passwd="password"
650 priority=2
651}
652
653# Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
654# group cipher.
655network={
656 ssid="example"
657 bssid=00:11:22:33:44:55
658 proto=WPA RSN
659 key_mgmt=WPA-PSK WPA-EAP
660 pairwise=CCMP
661 group=CCMP
662 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
663}
664
665# Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
666# and all valid ciphers.
667network={
668 ssid=00010203
669 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
670}
671
672
673# EAP-SIM with a GSM SIM or USIM
674network={
675 ssid="eap-sim-test"
676 key_mgmt=WPA-EAP
677 eap=SIM
678 pin="1234"
679 pcsc=""
680}
681
682
683# EAP-PSK
684network={
685 ssid="eap-psk-test"
686 key_mgmt=WPA-EAP
687 eap=PSK
688 anonymous_identity="eap_psk_user"
689 password=06b4be19da289f475aa46a33cb793029
690 identity="eap_psk_user@example.com"
691}
692
693
694# IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
695# EAP-TLS for authentication and key generation; require both unicast and
696# broadcast WEP keys.
697network={
698 ssid="1x-test"
699 key_mgmt=IEEE8021X
700 eap=TLS
701 identity="user@example.com"
702 ca_cert="/etc/cert/ca.pem"
703 client_cert="/etc/cert/user.pem"
704 private_key="/etc/cert/user.prv"
705 private_key_passwd="password"
706 eapol_flags=3
707}
708
709
710# LEAP with dynamic WEP keys
711network={
712 ssid="leap-example"
713 key_mgmt=IEEE8021X
714 eap=LEAP
715 identity="user"
716 password="foobar"
717}
718
719# EAP-IKEv2 using shared secrets for both server and peer authentication
720network={
721 ssid="ikev2-example"
722 key_mgmt=WPA-EAP
723 eap=IKEV2
724 identity="user"
725 password="foobar"
726}
727
728# EAP-FAST with WPA (WPA or WPA2)
729network={
730 ssid="eap-fast-test"
731 key_mgmt=WPA-EAP
732 eap=FAST
733 anonymous_identity="FAST-000102030405"
734 identity="username"
735 password="password"
736 phase1="fast_provisioning=1"
737 pac_file="/etc/wpa_supplicant.eap-fast-pac"
738}
739
740network={
741 ssid="eap-fast-test"
742 key_mgmt=WPA-EAP
743 eap=FAST
744 anonymous_identity="FAST-000102030405"
745 identity="username"
746 password="password"
747 phase1="fast_provisioning=1"
748 pac_file="blob://eap-fast-pac"
749}
750
751# Plaintext connection (no WPA, no IEEE 802.1X)
752network={
753 ssid="plaintext-test"
754 key_mgmt=NONE
755}
756
757
758# Shared WEP key connection (no WPA, no IEEE 802.1X)
759network={
760 ssid="static-wep-test"
761 key_mgmt=NONE
762 wep_key0="abcde"
763 wep_key1=0102030405
764 wep_key2="1234567890123"
765 wep_tx_keyidx=0
766 priority=5
767}
768
769
770# Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
771# IEEE 802.11 authentication
772network={
773 ssid="static-wep-test2"
774 key_mgmt=NONE
775 wep_key0="abcde"
776 wep_key1=0102030405
777 wep_key2="1234567890123"
778 wep_tx_keyidx=0
779 priority=5
780 auth_alg=SHARED
781}
782
783
784# IBSS/ad-hoc network with WPA-None/TKIP.
785network={
786 ssid="test adhoc"
787 mode=1
788 frequency=2412
789 proto=WPA
790 key_mgmt=WPA-NONE
791 pairwise=NONE
792 group=TKIP
793 psk="secret passphrase"
794}
795
796
797# Catch all example that allows more or less all configuration modes
798network={
799 ssid="example"
800 scan_ssid=1
801 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
802 pairwise=CCMP TKIP
803 group=CCMP TKIP WEP104 WEP40
804 psk="very secret passphrase"
805 eap=TTLS PEAP TLS
806 identity="user@example.com"
807 password="foobar"
808 ca_cert="/etc/cert/ca.pem"
809 client_cert="/etc/cert/user.pem"
810 private_key="/etc/cert/user.prv"
811 private_key_passwd="password"
812 phase1="peaplabel=0"
813}
814
815# Example of EAP-TLS with smartcard (openssl engine)
816network={
817 ssid="example"
818 key_mgmt=WPA-EAP
819 eap=TLS
820 proto=RSN
821 pairwise=CCMP TKIP
822 group=CCMP TKIP
823 identity="user@example.com"
824 ca_cert="/etc/cert/ca.pem"
825 client_cert="/etc/cert/user.pem"
826
827 engine=1
828
829 # The engine configured here must be available. Look at
830 # OpenSSL engine support in the global section.
831 # The key available through the engine must be the private key
832 # matching the client certificate configured above.
833
834 # use the opensc engine
835 #engine_id="opensc"
836 #key_id="45"
837
838 # use the pkcs11 engine
839 engine_id="pkcs11"
840 key_id="id_45"
841
842 # Optional PIN configuration; this can be left out and PIN will be
843 # asked through the control interface
844 pin="1234"
845}
846
847# Example configuration showing how to use an inlined blob as a CA certificate
848# data instead of using external file
849network={
850 ssid="example"
851 key_mgmt=WPA-EAP
852 eap=TTLS
853 identity="user@example.com"
854 anonymous_identity="anonymous@example.com"
855 password="foobar"
856 ca_cert="blob://exampleblob"
857 priority=20
858}
859
860blob-base64-exampleblob={
861SGVsbG8gV29ybGQhCg==
862}
863
864
865# Wildcard match for SSID (plaintext APs only). This example select any
866# open AP regardless of its SSID.
867network={
868 key_mgmt=NONE
869}