2005-06-05 21:18:53 +00:00
|
|
|
.\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
|
|
|
|
.\" All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" $FreeBSD$
|
|
|
|
.\"
|
2018-03-26 22:10:20 +00:00
|
|
|
.Dd March 26, 2018
|
2005-06-05 21:18:53 +00:00
|
|
|
.Dt WPA_SUPPLICANT.CONF 5
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm wpa_supplicant.conf
|
2005-06-27 06:40:43 +00:00
|
|
|
.Nd configuration file for
|
|
|
|
.Xr wpa_supplicant 8
|
2005-06-05 21:18:53 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
utility is an implementation of the WPA Supplicant component,
|
2005-06-05 21:18:53 +00:00
|
|
|
i.e., the part that runs in the client stations.
|
2005-06-27 06:40:43 +00:00
|
|
|
It implements WPA key negotiation with a WPA Authenticator
|
2005-06-05 21:18:53 +00:00
|
|
|
and EAP authentication with Authentication Server using
|
|
|
|
configuration information stored in a text file.
|
|
|
|
.Pp
|
2005-06-17 05:32:48 +00:00
|
|
|
The configuration file consists of optional global parameter
|
2005-06-27 06:40:43 +00:00
|
|
|
settings and one or more network blocks, e.g.\&
|
2005-06-05 21:18:53 +00:00
|
|
|
one for each used SSID.
|
2005-06-27 06:40:43 +00:00
|
|
|
The
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
utility
|
2005-06-05 21:18:53 +00:00
|
|
|
will automatically select the best network based on the order of
|
|
|
|
the network blocks in the configuration file, network security level
|
|
|
|
(WPA/WPA2 is preferred), and signal strength.
|
2005-06-27 06:40:43 +00:00
|
|
|
Comments are indicated with the
|
|
|
|
.Ql #
|
|
|
|
character; all text to the
|
2005-06-17 05:32:48 +00:00
|
|
|
end of the line will be ignored.
|
|
|
|
.Sh GLOBAL PARAMETERS
|
2005-06-27 06:40:43 +00:00
|
|
|
Default parameters used by
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
may be overridden by specifying
|
|
|
|
.Pp
|
|
|
|
.Dl parameter=value
|
2005-06-17 05:32:48 +00:00
|
|
|
.Pp
|
|
|
|
in the configuration file (note no spaces are allowed).
|
2005-06-27 06:40:43 +00:00
|
|
|
Values with embedded spaces must be enclosed in quote marks.
|
2005-06-17 05:32:48 +00:00
|
|
|
.Pp
|
|
|
|
The following parameters are recognized:
|
|
|
|
.Bl -tag -width indent
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va ctrl_interface
|
2005-06-17 05:32:48 +00:00
|
|
|
The pathname of the directory in which
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
creates
|
|
|
|
.Ux
|
|
|
|
domain socket files for communication
|
2005-06-17 05:32:48 +00:00
|
|
|
with frontend programs such as
|
|
|
|
.Xr wpa_cli 8 .
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va ctrl_interface_group
|
2005-06-17 05:32:48 +00:00
|
|
|
A group name or group ID to use in setting protection on the
|
|
|
|
control interface file.
|
|
|
|
This can be set to allow non-root users to access the
|
|
|
|
control interface files.
|
2005-06-27 06:40:43 +00:00
|
|
|
If no group is specified, the group ID of the control interface
|
2005-06-17 05:32:48 +00:00
|
|
|
is not modified and will, typically, be the
|
|
|
|
group ID of the directory in which the socket is created.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va eapol_version
|
2005-06-17 05:32:48 +00:00
|
|
|
The IEEE 802.1x/EAPOL protocol version to use; either 1 (default) or 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
The
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
utility
|
2005-06-17 05:32:48 +00:00
|
|
|
is implemented according to IEEE 802-1X-REV-d8 which defines
|
|
|
|
EAPOL version to be 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
However, some access points do not work when presented with
|
2005-06-17 05:32:48 +00:00
|
|
|
this version so by default
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8
|
2005-06-17 05:32:48 +00:00
|
|
|
will announce that it is using EAPOL version 1.
|
|
|
|
If version 2 must be announced for correct operation with an
|
2005-06-27 06:40:43 +00:00
|
|
|
access point, this value may be set to 2.
|
|
|
|
.It Va ap_scan
|
2005-06-17 05:32:48 +00:00
|
|
|
Access point scanning and selection control; one of 0, 1 (default), or 2.
|
|
|
|
Only setting 1 should be used with the
|
|
|
|
.Xr wlan 4
|
|
|
|
module; the other settings are for use on other operating systems.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va fast_reauth
|
2005-06-17 05:32:48 +00:00
|
|
|
EAP fast re-authentication; either 1 (default) or 0.
|
|
|
|
Control fast re-authentication support in EAP methods that support it.
|
|
|
|
.El
|
|
|
|
.Sh NETWORK BLOCKS
|
2005-06-27 06:40:43 +00:00
|
|
|
Each potential network/access point should have a
|
|
|
|
.Dq "network block"
|
|
|
|
that describes how to identify it and how to set up security.
|
|
|
|
When multiple network blocks are listed in a configuration file,
|
2005-06-17 05:32:48 +00:00
|
|
|
the highest priority one is selected for use or, if multiple networks
|
|
|
|
with the same priority are identified, the first one listed in the
|
|
|
|
configuration file is used.
|
|
|
|
.Pp
|
|
|
|
A network block description is of the form:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Bd -literal -offset indent
|
2005-06-17 05:32:48 +00:00
|
|
|
network={
|
|
|
|
parameter=value
|
|
|
|
...
|
|
|
|
}
|
|
|
|
.Ed
|
|
|
|
.Pp
|
2005-06-27 06:40:43 +00:00
|
|
|
(note the leading
|
|
|
|
.Qq Li "network={"
|
|
|
|
may have no spaces).
|
2005-06-17 05:32:48 +00:00
|
|
|
The block specification contains one or more parameters
|
|
|
|
from the following list:
|
|
|
|
.Bl -tag -width indent
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va ssid No (required)
|
2005-06-17 05:32:48 +00:00
|
|
|
Network name (as announced by the access point).
|
2005-06-27 06:40:43 +00:00
|
|
|
An
|
|
|
|
.Tn ASCII
|
|
|
|
or hex string enclosed in quotation marks.
|
|
|
|
.It Va scan_ssid
|
2005-06-17 05:32:48 +00:00
|
|
|
SSID scan technique; 0 (default) or 1.
|
|
|
|
Technique 0 scans for the SSID using a broadcast Probe Request
|
|
|
|
frame while 1 uses a directed Probe Request frame.
|
2005-07-31 03:30:48 +00:00
|
|
|
Access points that cloak themselves by not broadcasting their SSID
|
2005-06-17 05:32:48 +00:00
|
|
|
require technique 1, but beware that this scheme can cause scanning
|
|
|
|
to take longer to complete.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va bssid
|
2005-06-17 05:32:48 +00:00
|
|
|
Network BSSID (typically the MAC address of the access point).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va priority
|
2005-06-17 05:32:48 +00:00
|
|
|
The priority of a network when selecting among multiple networks;
|
|
|
|
a higher value means a network is more desirable.
|
|
|
|
By default networks have priority 0.
|
|
|
|
When multiple networks with the same priority are considered
|
2005-06-27 06:40:43 +00:00
|
|
|
for selection, other information such as security policy and
|
2005-06-17 05:32:48 +00:00
|
|
|
signal strength are used to select one.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va mode
|
2005-06-17 05:32:48 +00:00
|
|
|
IEEE 802.11 operation mode; either 0 (infrastructure, default) or 1 (IBSS).
|
|
|
|
Note that IBSS (adhoc) mode can only be used with
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va key_mgmt
|
2005-06-17 05:32:48 +00:00
|
|
|
set to
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li NONE
|
2010-04-10 13:54:00 +00:00
|
|
|
(plaintext and static WEP), or
|
|
|
|
.Va key_mgmt
|
|
|
|
set to
|
|
|
|
.Li WPA-NONE
|
|
|
|
(fixed group key TKIP/CCMP).
|
|
|
|
In addition,
|
|
|
|
.Va ap_scan
|
|
|
|
has to be set to 2 for IBSS.
|
|
|
|
.Li WPA-NONE
|
|
|
|
requires
|
|
|
|
.Va proto
|
|
|
|
set to WPA,
|
|
|
|
.Va key_mgmt
|
|
|
|
set to WPA-NONE,
|
|
|
|
.Va pairwise
|
|
|
|
set to NONE,
|
|
|
|
.Va group
|
|
|
|
set to either
|
|
|
|
CCMP or TKIP (but not both), and
|
|
|
|
.Va psk
|
|
|
|
must also be set.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va proto
|
2005-06-17 05:32:48 +00:00
|
|
|
List of acceptable protocols; one or more of:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li WPA
|
|
|
|
(IEEE 802.11i/D3.0)
|
2005-06-17 05:32:48 +00:00
|
|
|
and
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li RSN
|
|
|
|
(IEEE 802.11i).
|
|
|
|
.Li WPA2
|
|
|
|
is another name for
|
|
|
|
.Li RSN .
|
|
|
|
If not set this defaults to
|
|
|
|
.Qq Li "WPA RSN" .
|
|
|
|
.It Va key_mgmt
|
2005-06-17 05:32:48 +00:00
|
|
|
List of acceptable key management protocols; one or more of:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li WPA-PSK
|
|
|
|
(WPA pre-shared key),
|
|
|
|
.Li WPA-EAP
|
|
|
|
(WPA using EAP authentication),
|
|
|
|
.Li IEEE8021X
|
|
|
|
(IEEE 802.1x using EAP authentication and,
|
2005-06-17 05:32:48 +00:00
|
|
|
optionally, dynamically generated WEP keys),
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li NONE
|
|
|
|
(plaintext or static WEP keys).
|
|
|
|
If not set this defaults to
|
|
|
|
.Qq Li "WPA-PSK WPA-EAP" .
|
|
|
|
.It Va auth_alg
|
2005-06-17 05:32:48 +00:00
|
|
|
List of allowed IEEE 802.11 authentication algorithms; one or more of:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li OPEN
|
|
|
|
(Open System authentication, required for WPA/WPA2),
|
|
|
|
.Li SHARED
|
|
|
|
(Shared Key authentication),
|
|
|
|
.Li LEAP
|
|
|
|
(LEAP/Network EAP).
|
2005-06-17 05:32:48 +00:00
|
|
|
If not set automatic selection is used (Open System with LEAP
|
|
|
|
enabled if LEAP is allowed as one of the EAP methods).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va pairwise
|
2005-06-17 05:32:48 +00:00
|
|
|
List of acceptable pairwise (unicast) ciphers for WPA; one or more of:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li CCMP
|
|
|
|
(AES in Counter mode with CBC-MAC, RFC 3610, IEEE 802.11i/D7.0),
|
|
|
|
.Li TKIP
|
2005-07-13 05:39:47 +00:00
|
|
|
(Temporal Key Integrity Protocol, IEEE 802.11i/D7.0),
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li NONE
|
|
|
|
(deprecated).
|
|
|
|
If not set this defaults to
|
|
|
|
.Qq Li "CCMP TKIP" .
|
|
|
|
.It Va group
|
2005-06-17 05:32:48 +00:00
|
|
|
List of acceptable group (multicast) ciphers for WPA; one or more of:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li CCMP
|
|
|
|
(AES in Counter mode with CBC-MAC, RFC 3610, IEEE 802.11i/D7.0),
|
|
|
|
.Li TKIP
|
2005-07-13 05:39:47 +00:00
|
|
|
(Temporal Key Integrity Protocol, IEEE 802.11i/D7.0),
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li WEP104
|
|
|
|
(WEP with 104-bit key),
|
|
|
|
.Li WEP40
|
|
|
|
(WEP with 40-bit key).
|
|
|
|
If not set this defaults to
|
|
|
|
.Qq Li "CCMP TKIP WEP104 WEP40" .
|
|
|
|
.It Va psk
|
2005-06-17 05:32:48 +00:00
|
|
|
WPA preshared key used in WPA-PSK mode.
|
|
|
|
The key is specified as 64 hex digits or as
|
2005-06-27 06:40:43 +00:00
|
|
|
an 8-63 character
|
|
|
|
.Tn ASCII
|
|
|
|
passphrase.
|
|
|
|
.Tn ASCII
|
2006-11-17 19:38:51 +00:00
|
|
|
passphrases are dynamically converted to a 256-bit key at runtime
|
|
|
|
using the network SSID, or they can be statically converted at
|
|
|
|
configuration time using
|
|
|
|
the
|
|
|
|
.Xr wpa_passphrase 8
|
|
|
|
utility.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va eapol_flags
|
2005-06-17 05:32:48 +00:00
|
|
|
Dynamic WEP key usage for non-WPA mode, specified as a bit field.
|
|
|
|
Bit 0 (1) forces dynamically generated unicast WEP keys to be used.
|
|
|
|
Bit 1 (2) forces dynamically generated broadcast WEP keys to be used.
|
|
|
|
By default this is set to 3 (use both).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va eap
|
2005-06-17 05:32:48 +00:00
|
|
|
List of acceptable EAP methods; one or more of:
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li MD5
|
|
|
|
(EAP-MD5, cannot be used with WPA,
|
|
|
|
used only as a Phase 2 method with EAP-PEAP or EAP-TTLS),
|
|
|
|
.Li MSCHAPV2
|
|
|
|
(EAP-MSCHAPV2, cannot be used with WPA;
|
|
|
|
used only as a Phase 2 method with EAP-PEAP or EAP-TTLS),
|
|
|
|
.Li OTP
|
|
|
|
(EAP-OTP, cannot be used with WPA;
|
|
|
|
used only as a Phase 2 metod with EAP-PEAP or EAP-TTLS),
|
|
|
|
.Li GTC
|
|
|
|
(EAP-GTC, cannot be used with WPA;
|
|
|
|
used only as a Phase 2 metod with EAP-PEAP or EAP-TTLS),
|
|
|
|
.Li TLS
|
|
|
|
(EAP-TLS, client and server certificate),
|
|
|
|
.Li PEAP
|
2005-07-13 05:39:47 +00:00
|
|
|
(EAP-PEAP, with tunneled EAP authentication),
|
2005-06-27 06:40:43 +00:00
|
|
|
.Li TTLS
|
2005-07-13 05:39:47 +00:00
|
|
|
(EAP-TTLS, with tunneled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 authentication).
|
2005-06-17 05:32:48 +00:00
|
|
|
If not set this defaults to all available methods compiled in to
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8 .
|
2005-06-17 05:32:48 +00:00
|
|
|
Note that by default
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8
|
2006-02-14 23:51:21 +00:00
|
|
|
is compiled with EAP support; see
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr make.conf 5
|
2005-06-17 05:32:48 +00:00
|
|
|
for the
|
2006-02-14 23:51:21 +00:00
|
|
|
.Va NO_WPA_SUPPLICANT_EAPOL
|
|
|
|
configuration variable that can be used to disable EAP support.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va identity
|
2005-06-17 05:32:48 +00:00
|
|
|
Identity string for EAP.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va anonymous_identity
|
2005-06-17 05:32:48 +00:00
|
|
|
Anonymous identity string for EAP (to be used as the unencrypted identity
|
2005-07-13 05:39:47 +00:00
|
|
|
with EAP types that support different tunneled identities; e.g.\& EAP-TTLS).
|
2007-07-11 16:04:08 +00:00
|
|
|
.It Va mixed_cell
|
|
|
|
Configure whether networks that allow both plaintext and encryption
|
|
|
|
are allowed when selecting a BSS from the scan results.
|
|
|
|
By default this is set to 0 (disabled).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va password
|
2005-06-17 05:32:48 +00:00
|
|
|
Password string for EAP.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va ca_cert
|
2005-06-17 05:32:48 +00:00
|
|
|
Pathname to CA certificate file.
|
|
|
|
This file can have one or more trusted CA certificates.
|
|
|
|
If
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va ca_cert
|
2005-06-17 05:32:48 +00:00
|
|
|
is not included, server certificates will not be verified (not recommended).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va client_cert
|
2005-06-17 05:32:48 +00:00
|
|
|
Pathname to client certificate file (PEM/DER).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va private_key
|
2005-06-17 05:32:48 +00:00
|
|
|
Pathname to a client private key file (PEM/DER/PFX).
|
|
|
|
When a PKCS#12/PFX file is used, then
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va client_cert
|
2005-06-17 05:32:48 +00:00
|
|
|
should not be specified as both the private key and certificate will be
|
|
|
|
read from PKCS#12 file.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va private_key_passwd
|
2005-06-17 05:32:48 +00:00
|
|
|
Password for any private key file.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va dh_file
|
2005-06-17 05:32:48 +00:00
|
|
|
Pathname to a file holding DH/DSA parameters (in PEM format).
|
|
|
|
This file holds parameters for an ephemeral DH key exchange.
|
|
|
|
In most cases, the default RSA authentication does not use this configuration.
|
2005-06-27 06:40:43 +00:00
|
|
|
However, it is possible to set up RSA to use an ephemeral DH key exchange.
|
2005-06-17 05:32:48 +00:00
|
|
|
In addition, ciphers with
|
|
|
|
DSA keys always use ephemeral DH keys.
|
|
|
|
This can be used to achieve forward secrecy.
|
|
|
|
If the
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va dh_file
|
2005-06-17 05:32:48 +00:00
|
|
|
is in DSA parameters format, it will be automatically converted
|
2012-05-12 15:08:22 +00:00
|
|
|
into DH parameters.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va subject_match
|
2005-06-17 05:32:48 +00:00
|
|
|
Substring to be matched against the subject of the
|
|
|
|
authentication server certificate.
|
|
|
|
If this string is set, the server
|
2005-07-13 05:39:47 +00:00
|
|
|
certificate is only accepted if it contains this string in the subject.
|
2005-06-17 05:32:48 +00:00
|
|
|
The subject string is in following format:
|
|
|
|
.Pp
|
2005-06-27 06:40:43 +00:00
|
|
|
.Dl "/C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com"
|
|
|
|
.It Va phase1
|
|
|
|
Phase1 (outer authentication, i.e., TLS tunnel) parameters
|
|
|
|
(string with field-value pairs, e.g.,
|
|
|
|
.Qq Li peapver=0
|
|
|
|
or
|
|
|
|
.Qq Li "peapver=1 peaplabel=1" ) .
|
|
|
|
.Bl -inset
|
|
|
|
.It Li peapver
|
|
|
|
can be used to force which PEAP version (0 or 1) is used.
|
|
|
|
.It Li peaplabel=1
|
|
|
|
can be used to force new label,
|
|
|
|
.Dq "client PEAP encryption" ,
|
2005-06-17 05:32:48 +00:00
|
|
|
to be used during key derivation when PEAPv1 or newer.
|
2005-06-27 06:40:43 +00:00
|
|
|
Most existing PEAPv1 implementations seem to be using the old label,
|
|
|
|
.Dq Li "client EAP encryption" ,
|
|
|
|
and
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
is now using that as the
|
2005-06-17 05:32:48 +00:00
|
|
|
default value.
|
2005-06-27 06:40:43 +00:00
|
|
|
Some servers, e.g.,
|
|
|
|
.Tn Radiator ,
|
|
|
|
may require
|
|
|
|
.Li peaplabel=1
|
|
|
|
configuration to interoperate with PEAPv1; see
|
|
|
|
.Pa eap_testing.txt
|
|
|
|
for more details.
|
|
|
|
.It Li peap_outer_success=0
|
|
|
|
can be used to terminate PEAP authentication on
|
2005-06-17 05:32:48 +00:00
|
|
|
tunneled EAP-Success.
|
|
|
|
This is required with some RADIUS servers that
|
2005-06-27 06:40:43 +00:00
|
|
|
implement
|
|
|
|
.Pa draft-josefsson-pppext-eap-tls-eap-05.txt
|
|
|
|
(e.g.,
|
|
|
|
.Tn Lucent NavisRadius v4.4.0
|
|
|
|
with PEAP in
|
|
|
|
.Dq "IETF Draft 5"
|
|
|
|
mode).
|
|
|
|
.It Li include_tls_length=1
|
|
|
|
can be used to force
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
to include
|
2005-06-17 05:32:48 +00:00
|
|
|
TLS Message Length field in all TLS messages even if they are not
|
|
|
|
fragmented.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Li sim_min_num_chal=3
|
|
|
|
can be used to configure EAP-SIM to require three
|
2012-05-12 15:08:22 +00:00
|
|
|
challenges (by default, it accepts 2 or 3).
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Li fast_provisioning=1
|
|
|
|
option enables in-line provisioning of EAP-FAST
|
2005-06-17 05:32:48 +00:00
|
|
|
credentials (PAC).
|
2005-06-27 06:40:43 +00:00
|
|
|
.El
|
|
|
|
.It Va phase2
|
2005-06-17 05:32:48 +00:00
|
|
|
phase2: Phase2 (inner authentication with TLS tunnel) parameters
|
2005-06-27 06:40:43 +00:00
|
|
|
(string with field-value pairs, e.g.,
|
|
|
|
.Qq Li "auth=MSCHAPV2"
|
|
|
|
for EAP-PEAP or
|
|
|
|
.Qq Li "autheap=MSCHAPV2 autheap=MD5"
|
|
|
|
for EAP-TTLS).
|
|
|
|
.It Va ca_cert2
|
2005-06-17 05:32:48 +00:00
|
|
|
Like
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va ca_cert
|
2005-06-17 05:32:48 +00:00
|
|
|
but for EAP inner Phase 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va client_cert2
|
2005-06-17 05:32:48 +00:00
|
|
|
Like
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va client_cert
|
2005-06-17 05:32:48 +00:00
|
|
|
but for EAP inner Phase 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va private_key2
|
2005-06-17 05:32:48 +00:00
|
|
|
Like
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va private_key
|
2005-06-17 05:32:48 +00:00
|
|
|
but for EAP inner Phase 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va private_key2_passwd
|
2005-06-17 05:32:48 +00:00
|
|
|
Like
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va private_key_passwd
|
2005-06-17 05:32:48 +00:00
|
|
|
but for EAP inner Phase 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va dh_file2
|
2005-06-17 05:32:48 +00:00
|
|
|
Like
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va dh_file
|
2005-06-17 05:32:48 +00:00
|
|
|
but for EAP inner Phase 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va subject_match2
|
2005-06-17 05:32:48 +00:00
|
|
|
Like
|
2005-06-27 06:40:43 +00:00
|
|
|
.Va subject_match
|
2005-06-17 05:32:48 +00:00
|
|
|
but for EAP inner Phase 2.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va eappsk
|
2005-07-13 05:39:47 +00:00
|
|
|
16-byte pre-shared key in hex format for use with EAP-PSK.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va nai
|
2005-06-17 05:32:48 +00:00
|
|
|
User NAI for use with EAP-PSK.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va server_nai
|
2005-06-17 05:32:48 +00:00
|
|
|
Authentication Server NAI for use with EAP-PSK.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va pac_file
|
2005-06-17 05:32:48 +00:00
|
|
|
Pathname to the file to use for PAC entries with EAP-FAST.
|
2005-06-27 06:40:43 +00:00
|
|
|
The
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
utility
|
2005-06-17 05:32:48 +00:00
|
|
|
must be able to create this file and write updates to it when
|
|
|
|
PAC is being provisioned or refreshed.
|
2005-06-27 06:40:43 +00:00
|
|
|
.It Va eap_workaround
|
2005-06-17 05:32:48 +00:00
|
|
|
Enable/disable EAP workarounds for various interoperability issues
|
|
|
|
with misbehaving authentication servers.
|
|
|
|
By default these workarounds are enabled.
|
2008-11-21 18:15:39 +00:00
|
|
|
Strict EAP conformance can be configured by setting this to 0.
|
2011-02-20 17:54:49 +00:00
|
|
|
.It Va wep_tx_keyidx
|
|
|
|
which key to use for transmission of packets.
|
|
|
|
.It Va wep_keyN key
|
|
|
|
An
|
|
|
|
.Tn ASCII
|
|
|
|
string enclosed in quotation marks to encode the WEP key.
|
|
|
|
Without quotes this is a hex string of the actual key.
|
|
|
|
WEP is considered insecure and should be avoided.
|
|
|
|
The exact translation from an ASCII key to a hex key varies.
|
|
|
|
Use hex keys where possible.
|
2005-06-17 05:32:48 +00:00
|
|
|
.El
|
2005-06-05 21:18:53 +00:00
|
|
|
.Sh CERTIFICATES
|
|
|
|
Some EAP authentication methods require use of certificates.
|
|
|
|
EAP-TLS uses both server- and client-side certificates,
|
|
|
|
whereas EAP-PEAP and EAP-TTLS only require a server-side certificate.
|
|
|
|
When a client certificate is used, a matching private key file must
|
|
|
|
also be included in configuration.
|
|
|
|
If the private key uses a passphrase, this
|
2005-06-27 06:40:43 +00:00
|
|
|
has to be configured in the
|
|
|
|
.Nm
|
|
|
|
file as
|
|
|
|
.Va private_key_passwd .
|
2005-06-05 21:18:53 +00:00
|
|
|
.Pp
|
2005-06-27 06:40:43 +00:00
|
|
|
The
|
|
|
|
.Xr wpa_supplicant 8
|
|
|
|
utility
|
2005-06-05 21:18:53 +00:00
|
|
|
supports X.509 certificates in PEM and DER formats.
|
|
|
|
User certificate and private key can be included in the same file.
|
|
|
|
.Pp
|
|
|
|
If the user certificate and private key is received in PKCS#12/PFX
|
2005-06-27 06:40:43 +00:00
|
|
|
format, they need to be converted to a suitable PEM/DER format for
|
2005-06-05 21:18:53 +00:00
|
|
|
use by
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8 .
|
2005-06-05 21:18:53 +00:00
|
|
|
This can be done using the
|
|
|
|
.Xr openssl 1
|
2005-06-27 06:40:43 +00:00
|
|
|
program, e.g.\& with the following commands:
|
2005-06-05 21:18:53 +00:00
|
|
|
.Bd -literal
|
|
|
|
# convert client certificate and private key to PEM format
|
|
|
|
openssl pkcs12 -in example.pfx -out user.pem -clcerts
|
|
|
|
# convert CA certificate (if included in PFX file) to PEM format
|
|
|
|
openssl pkcs12 -in example.pfx -out ca.pem -cacerts -nokeys
|
2005-06-17 05:32:48 +00:00
|
|
|
.Ed
|
2010-05-13 12:08:11 +00:00
|
|
|
.Sh FILES
|
|
|
|
.Bl -tag -width ".Pa /usr/share/examples/etc/wpa_supplicant.conf" -compact
|
|
|
|
.It Pa /etc/wpa_supplicant.conf
|
|
|
|
.It Pa /usr/share/examples/etc/wpa_supplicant.conf
|
|
|
|
.El
|
2005-06-05 21:18:53 +00:00
|
|
|
.Sh EXAMPLES
|
|
|
|
WPA-Personal (PSK) as a home network and WPA-Enterprise with EAP-TLS
|
|
|
|
as a work network:
|
|
|
|
.Bd -literal
|
|
|
|
# allow frontend (e.g., wpa_cli) to be used by all users in 'wheel' group
|
|
|
|
ctrl_interface=/var/run/wpa_supplicant
|
|
|
|
ctrl_interface_group=wheel
|
|
|
|
#
|
|
|
|
# home network; allow all valid ciphers
|
|
|
|
network={
|
|
|
|
ssid="home"
|
|
|
|
scan_ssid=1
|
|
|
|
key_mgmt=WPA-PSK
|
|
|
|
psk="very secret passphrase"
|
|
|
|
}
|
|
|
|
#
|
|
|
|
# work network; use EAP-TLS with WPA; allow only CCMP and TKIP ciphers
|
|
|
|
network={
|
|
|
|
ssid="work"
|
|
|
|
scan_ssid=1
|
|
|
|
key_mgmt=WPA-EAP
|
|
|
|
pairwise=CCMP TKIP
|
|
|
|
group=CCMP TKIP
|
|
|
|
eap=TLS
|
|
|
|
identity="user@example.com"
|
|
|
|
ca_cert="/etc/cert/ca.pem"
|
|
|
|
client_cert="/etc/cert/user.pem"
|
|
|
|
private_key="/etc/cert/user.prv"
|
|
|
|
private_key_passwd="password"
|
|
|
|
}
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
WPA-RADIUS/EAP-PEAP/MSCHAPv2 with RADIUS servers that use old peaplabel
|
|
|
|
(e.g., Funk Odyssey and SBR, Meetinghouse Aegis, Interlink RAD-Series):
|
|
|
|
.Bd -literal
|
|
|
|
ctrl_interface=/var/run/wpa_supplicant
|
|
|
|
ctrl_interface_group=wheel
|
|
|
|
network={
|
|
|
|
ssid="example"
|
|
|
|
scan_ssid=1
|
|
|
|
key_mgmt=WPA-EAP
|
|
|
|
eap=PEAP
|
|
|
|
identity="user@example.com"
|
|
|
|
password="foobar"
|
|
|
|
ca_cert="/etc/cert/ca.pem"
|
|
|
|
phase1="peaplabel=0"
|
|
|
|
phase2="auth=MSCHAPV2"
|
|
|
|
}
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
|
2005-06-27 06:40:43 +00:00
|
|
|
unencrypted use.
|
|
|
|
Real identity is sent only within an encrypted TLS tunnel.
|
2005-06-05 21:18:53 +00:00
|
|
|
.Bd -literal
|
|
|
|
ctrl_interface=/var/run/wpa_supplicant
|
|
|
|
ctrl_interface_group=wheel
|
|
|
|
network={
|
|
|
|
ssid="example"
|
|
|
|
scan_ssid=1
|
|
|
|
key_mgmt=WPA-EAP
|
|
|
|
eap=TTLS
|
|
|
|
identity="user@example.com"
|
|
|
|
anonymous_identity="anonymous@example.com"
|
|
|
|
password="foobar"
|
|
|
|
ca_cert="/etc/cert/ca.pem"
|
|
|
|
phase2="auth=MD5"
|
|
|
|
}
|
|
|
|
.Ed
|
2005-12-25 22:09:17 +00:00
|
|
|
.Pp
|
|
|
|
Traditional WEP configuration with 104 bit key specified in hexadecimal.
|
|
|
|
Note the WEP key is not quoted.
|
|
|
|
.Bd -literal
|
|
|
|
ctrl_interface=/var/run/wpa_supplicant
|
|
|
|
ctrl_interface_group=wheel
|
|
|
|
network={
|
|
|
|
ssid="example"
|
|
|
|
scan_ssid=1
|
|
|
|
key_mgmt=NONE
|
|
|
|
wep_tx_keyidx=0
|
2011-02-20 17:54:49 +00:00
|
|
|
# hex keys denoted without quotes
|
2005-12-25 22:09:17 +00:00
|
|
|
wep_key0=42FEEDDEAFBABEDEAFBEEFAA55
|
2011-02-20 17:54:49 +00:00
|
|
|
# ASCII keys denoted with quotes.
|
|
|
|
wep_key1="FreeBSDr0cks!"
|
2005-12-25 22:09:17 +00:00
|
|
|
}
|
|
|
|
.Ed
|
2018-03-26 22:10:20 +00:00
|
|
|
.Pp
|
|
|
|
Minimal eduroam configuration.
|
|
|
|
.Bd -literal
|
|
|
|
ctrl_interface=/var/run/wpa_supplicant
|
|
|
|
ctrl_interface_group=wheel
|
|
|
|
network={
|
|
|
|
ssid="eduroam"
|
|
|
|
scan_ssid=1
|
|
|
|
key_mgmt=WPA-EAP
|
|
|
|
eap=TTLS
|
|
|
|
identity="user@example.org"
|
|
|
|
password="foobar"
|
|
|
|
phase2="auth=MSCHAPV2"
|
|
|
|
}
|
|
|
|
.Ed
|
2005-06-05 21:18:53 +00:00
|
|
|
.Sh SEE ALSO
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_cli 8 ,
|
2006-11-17 19:38:51 +00:00
|
|
|
.Xr wpa_passphrase 8 ,
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8
|
2005-06-05 21:18:53 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
manual page and
|
2005-06-27 06:40:43 +00:00
|
|
|
.Xr wpa_supplicant 8
|
2005-06-05 21:18:53 +00:00
|
|
|
functionality first appeared in
|
|
|
|
.Fx 6.0 .
|
|
|
|
.Sh AUTHORS
|
2005-06-27 06:40:43 +00:00
|
|
|
This manual page is derived from the
|
|
|
|
.Pa README
|
|
|
|
and
|
|
|
|
.Pa wpa_supplicant.conf
|
2005-06-17 05:32:48 +00:00
|
|
|
files in the
|
2005-06-05 21:18:53 +00:00
|
|
|
.Nm wpa_supplicant
|
|
|
|
distribution provided by
|
2014-06-20 09:57:27 +00:00
|
|
|
.An Jouni Malinen Aq Mt j@w1.fi .
|