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