1 ##### Example wpa_supplicant configuration file ###############################
3 # This file describes configuration file format and lists all available option.
4 # Please also take a look at simpler configuration examples in 'examples'
7 # Empty lines and lines starting with # are ignored
9 # NOTE! This file may contain password information and should probably be made
10 # readable only by root user on multiuser systems.
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.
16 # Whether to allow wpa_supplicant to update (overwrite) configuration
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
26 # global configuration (shared by all network blocks)
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
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
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.
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.
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)
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)
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.
75 ctrl_interface=/var/run/wpa_supplicant
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
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.
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.
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
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
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
142 #driver_param="field=value"
145 # The ISO/IEC alpha2 country code for the country in which this device is
146 # currently operating.
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
156 # Wi-Fi Protected Setup (WPS) parameters
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
163 # User-friendly description of device; up to 32 octets encoded in UTF-8
164 #device_name=Wireless Client
167 # The manufacturer of the device (up to 64 ASCII characters)
168 #manufacturer=Company
171 # Model of the device (up to 32 ASCII characters)
175 # Additional device description (up to 32 ASCII characters)
179 # Serial number of the device (up to 32 characters)
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
187 # subcateg = OUI-specific Sub Category as an integer value
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
196 # 4-octet operating system version number (hex string)
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
205 #config_methods=label display push_button keypad
207 #config_methods=label virtual_display virtual_push_button keypad
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
217 # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
218 # The vendor attribute contents to be added in M1 (hex string)
219 #wps_vendor_ext_m1=000137100100020001
221 # NFC password token for WPS
222 # These parameters can be used to configure a fixed NFC password token for the
223 # station. This can be generated, e.g., with nfc_pw_token. When these
224 # parameters are used, the station is assumed to be deployed with a NFC tag
225 # that includes the matching NFC password token (e.g., written based on the
226 # NDEF record from nfc_pw_token).
228 #wps_nfc_dev_pw_id: Device Password ID (16..65535)
229 #wps_nfc_dh_pubkey: Hexdump of DH Public Key
230 #wps_nfc_dh_privkey: Hexdump of DH Private Key
231 #wps_nfc_dev_pw: Hexdump of Device Password
233 # Maximum number of BSS entries to keep in memory
235 # This can be used to limit memory use on the BSS entries (cached scan
236 # results). A larger value may be needed in environments that have huge number
237 # of APs when using ap_scan=1 mode.
241 # This is an optional set of parameters for automatic scanning
242 # within an interface in following format:
243 #autoscan=<autoscan module name>:<module parameters>
244 #Â autoscan is like bgscan but on disconnected or inactive state.
245 #Â For instance, on exponential module parameters would be <base>:<limit>
246 #autoscan=exponential:3:300
247 # Which means a delay between scans on a base exponential of 3,
248 #Â up to the limit of 300 seconds (3, 9, 27 ... 300)
249 #Â For periodic module, parameters would be <fixed interval>
250 #autoscan=periodic:30
251 #Â So a delay of 30 seconds will be applied between each scan
253 # filter_ssids - SSID-based scan result filtering
254 # 0 = do not filter scan results (default)
255 # 1 = only include configured SSIDs in scan results/BSS table
258 # Password (and passphrase, etc.) backend for external storage
259 # format: <backend name>[:<optional backend parameters>]
260 #ext_password_backend=test:pw1=password|pw2=testing
262 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
264 # This timeout value is used in P2P GO mode to clean up
266 #p2p_go_max_inactivity=300
268 # Opportunistic Key Caching (also known as Proactive Key Caching) default
269 # This parameter can be used to set the default behavior for the
270 # proactive_key_caching parameter. By default, OKC is disabled unless enabled
271 # with the global okc=1 parameter or with the per-network
272 # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
273 # can be disabled with per-network proactive_key_caching=0 parameter.
276 # Protected Management Frames default
277 # This parameter can be used to set the default behavior for the ieee80211w
278 # parameter. By default, PMF is disabled unless enabled with the global pmf=1/2
279 # parameter or with the per-network ieee80211w=1/2 parameter. With pmf=1/2, PMF
280 # is enabled/required by default, but can be disabled with the per-network
281 # ieee80211w parameter.
284 # Interworking (IEEE 802.11u)
286 # Enable Interworking
289 # Homogenous ESS identifier
290 # If this is set, scans will be used to request response only from BSSes
291 # belonging to the specified Homogeneous ESS. This is used only if interworking
293 # hessid=00:11:22:33:44:55
295 # Automatic network selection behavior
296 # 0 = do not automatically go through Interworking network selection
297 # (i.e., require explicit interworking_select command for this; default)
298 # 1 = perform Interworking network selection if one or more
299 # credentials have been configured and scan did not find a
300 # matching network block
305 # Each credential used for automatic network selection is configured as a set
306 # of parameters that are compared to the information advertised by the APs when
307 # interworking_select and interworking_connect commands are used.
311 # priority: Priority group
312 # By default, all networks and credentials get the same priority group
313 # (0). This field can be used to give higher priority for credentials
314 # (and similarly in struct wpa_ssid for network blocks) to change the
315 # Interworking automatic networking selection behavior. The matching
316 # network (based on either an enabled network block or a credential)
317 # with the highest priority value will be selected.
319 # pcsc: Use PC/SC and SIM/USIM card
321 # realm: Home Realm for Interworking
323 # username: Username for Interworking network selection
325 # password: Password for Interworking network selection
327 # ca_cert: CA certificate for Interworking network selection
329 # client_cert: File path to client certificate file (PEM/DER)
330 # This field is used with Interworking networking selection for a case
331 # where client certificate/private key is used for authentication
332 # (EAP-TLS). Full path to the file should be used since working
333 # directory may change when wpa_supplicant is run in the background.
335 # Alternatively, a named configuration blob can be used by setting
336 # this to blob://blob_name.
338 # private_key: File path to client private key file (PEM/DER/PFX)
339 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
340 # commented out. Both the private key and certificate will be read
341 # from the PKCS#12 file in this case. Full path to the file should be
342 # used since working directory may change when wpa_supplicant is run
345 # Windows certificate store can be used by leaving client_cert out and
346 # configuring private_key in one of the following formats:
348 # cert://substring_to_match
350 # hash://certificate_thumbprint_in_hex
352 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
354 # Note that when running wpa_supplicant as an application, the user
355 # certificate store (My user account) is used, whereas computer store
356 # (Computer account) is used when running wpasvc as a service.
358 # Alternatively, a named configuration blob can be used by setting
359 # this to blob://blob_name.
361 # private_key_passwd: Password for private key file
363 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
365 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
368 # domain: Home service provider FQDN
369 # This is used to compare against the Domain Name List to figure out
370 # whether the AP is operated by the Home SP.
372 # roaming_consortium: Roaming Consortium OI
373 # If roaming_consortium_len is non-zero, this field contains the
374 # Roaming Consortium OI that can be used to determine which access
375 # points support authentication with this credential. This is an
376 # alternative to the use of the realm parameter. When using Roaming
377 # Consortium to match the network, the EAP parameters need to be
378 # pre-configured with the credential since the NAI Realm information
379 # may not be available or fetched.
381 # eap: Pre-configured EAP method
382 # This optional field can be used to specify which EAP method will be
383 # used with this credential. If not set, the EAP method is selected
384 # automatically based on ANQP information (e.g., NAI Realm).
386 # phase1: Pre-configure Phase 1 (outer authentication) parameters
387 # This optional field is used with like the 'eap' parameter.
389 # phase2: Pre-configure Phase 2 (inner authentication) parameters
390 # This optional field is used with like the 'eap' parameter.
392 # excluded_ssid: Excluded SSID
393 # This optional field can be used to excluded specific SSID(s) from
394 # matching with the network. Multiple entries can be used to specify more
400 # realm="example.com"
401 # username="user@example.com"
402 # password="password"
403 # ca_cert="/etc/wpa_supplicant/ca.pem"
404 # domain="example.com"
408 # imsi="310026-000000000"
409 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
413 # realm="example.com"
415 # password="password"
416 # ca_cert="/etc/wpa_supplicant/ca.pem"
417 # domain="example.com"
418 # roaming_consortium=223344
420 # phase2="auth=MSCHAPV2"
428 # Each network (usually AP's sharing the same SSID) is configured as a separate
429 # block in this configuration file. The network blocks are in preference order
430 # (the first match is used).
432 # network block fields:
435 # 0 = this network can be used (default)
436 # 1 = this network block is disabled (can be enabled through ctrl_iface,
437 # e.g., with wpa_cli or wpa_gui)
439 # id_str: Network identifier string for external scripts. This value is passed
440 # to external action script through wpa_cli as WPA_ID_STR environment
441 # variable to make it easier to do network specific configuration.
443 # ssid: SSID (mandatory); network name in one of the optional formats:
444 # - an ASCII string with double quotation
445 # - a hex string (two characters per octet of SSID)
446 # - a printf-escaped ASCII string P"<escaped string>"
449 # 0 = do not scan this SSID with specific Probe Request frames (default)
450 # 1 = scan with SSID-specific Probe Request frames (this can be used to
451 # find APs that do not accept broadcast SSID or use multiple SSIDs;
452 # this will add latency to scanning, so enable this only when needed)
454 # bssid: BSSID (optional); if set, this network block is used only when
455 # associating with the AP using the configured BSSID
457 # priority: priority group (integer)
458 # By default, all networks will get same priority group (0). If some of the
459 # networks are more desirable, this field can be used to change the order in
460 # which wpa_supplicant goes through the networks when selecting a BSS. The
461 # priority groups will be iterated in decreasing priority (i.e., the larger the
462 # priority value, the sooner the network is matched against the scan results).
463 # Within each priority group, networks will be selected based on security
464 # policy, signal strength, etc.
465 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
466 # using this priority to select the order for scanning. Instead, they try the
467 # networks in the order that used in the configuration file.
469 # mode: IEEE 802.11 operation mode
470 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
471 # 1 = IBSS (ad-hoc, peer-to-peer)
472 # 2 = AP (access point)
473 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
474 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
475 # following network block options:
476 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
477 # both), and psk must also be set.
479 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
480 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
481 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
482 # In addition, this value is only used by the station that creates the IBSS. If
483 # an IBSS network with the configured SSID is already present, the frequency of
484 # the network will be used instead of this configured value.
486 # scan_freq: List of frequencies to scan
487 # Space-separated list of frequencies in MHz to scan when searching for this
488 # BSS. If the subset of channels used by the network is known, this option can
489 # be used to optimize scanning to not occur on channels that the network does
490 # not use. Example: scan_freq=2412 2437 2462
492 # freq_list: Array of allowed frequencies
493 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
494 # set, scan results that do not match any of the specified frequencies are not
495 # considered when selecting a BSS.
497 # proto: list of accepted protocols
498 # WPA = WPA/IEEE 802.11i/D3.0
499 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
500 # If not set, this defaults to: WPA RSN
502 # key_mgmt: list of accepted authenticated key management protocols
503 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
504 # WPA-EAP = WPA using EAP authentication
505 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
507 # NONE = WPA is not used; plaintext or static WEP could be used
508 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
509 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
510 # If not set, this defaults to: WPA-PSK WPA-EAP
512 # ieee80211w: whether management frame protection is enabled
513 # 0 = disabled (default unless changed with the global pmf parameter)
516 # The most common configuration options for this based on the PMF (protected
517 # management frames) certification program are:
518 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
519 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
520 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
522 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
523 # OPEN = Open System authentication (required for WPA/WPA2)
524 # SHARED = Shared Key authentication (requires static WEP keys)
525 # LEAP = LEAP/Network EAP (only used with LEAP)
526 # If not set, automatic selection is used (Open System with LEAP enabled if
527 # LEAP is allowed as one of the EAP methods).
529 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
530 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
531 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
532 # NONE = Use only Group Keys (deprecated, should not be included if APs support
534 # If not set, this defaults to: CCMP TKIP
536 # group: list of accepted group (broadcast/multicast) ciphers for WPA
537 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
538 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
539 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
540 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
541 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
543 # psk: WPA preshared key; 256-bit pre-shared key
544 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
545 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
546 # generated using the passphrase and SSID). ASCII passphrase must be between
547 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
548 # be used to indicate that the PSK/passphrase is stored in external storage.
549 # This field is not needed, if WPA-EAP is used.
550 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
551 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
552 # startup and reconfiguration time can be optimized by generating the PSK only
553 # only when the passphrase or SSID has actually changed.
555 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
556 # Dynamic WEP key required for non-WPA mode
557 # bit0 (1): require dynamically generated unicast WEP key
558 # bit1 (2): require dynamically generated broadcast WEP key
559 # (3 = require both keys; default)
560 # Note: When using wired authentication, eapol_flags must be set to 0 for the
561 # authentication to be completed successfully.
563 # mixed_cell: This option can be used to configure whether so called mixed
564 # cells, i.e., networks that use both plaintext and encryption in the same
565 # SSID, are allowed when selecting a BSS from scan results.
566 # 0 = disabled (default)
569 # proactive_key_caching:
570 # Enable/disable opportunistic PMKSA caching for WPA2.
571 # 0 = disabled (default unless changed with the global okc parameter)
574 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
575 # hex without quotation, e.g., 0102030405)
576 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
578 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
579 # allowed. This is only used with RSN/WPA2.
580 # 0 = disabled (default)
584 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
585 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
587 # Following fields are only used with internal EAP implementation.
588 # eap: space-separated list of accepted EAP methods
589 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
590 # cannot be used with WPA; to be used as a Phase 2 method
591 # with EAP-PEAP or EAP-TTLS)
592 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
593 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
594 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
595 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
596 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
597 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
598 # TLS = EAP-TLS (client and server certificate)
599 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
600 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
602 # If not set, all compiled in methods are allowed.
604 # identity: Identity string for EAP
605 # This field is also used to configure user NAI for
606 # EAP-PSK/PAX/SAKE/GPSK.
607 # anonymous_identity: Anonymous identity string for EAP (to be used as the
608 # unencrypted identity with EAP types that support different tunnelled
609 # identity, e.g., EAP-TTLS). This field can also be used with
610 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
611 # password: Password string for EAP. This field can include either the
612 # plaintext password (using ASCII or hex string) or a NtPasswordHash
613 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
614 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
615 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
616 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
617 # PSK) is also configured using this field. For EAP-GPSK, this is a
618 # variable length PSK. ext:<name of external password field> format can
619 # be used to indicate that the password is stored in external storage.
620 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
621 # or more trusted CA certificates. If ca_cert and ca_path are not
622 # included, server certificate will not be verified. This is insecure and
623 # a trusted CA certificate should always be configured when using
624 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
625 # change when wpa_supplicant is run in the background.
627 # Alternatively, this can be used to only perform matching of the server
628 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
629 # this case, the possible CA certificates in the server certificate chain
630 # are ignored and only the server certificate is verified. This is
631 # configured with the following format:
632 # hash:://server/sha256/cert_hash_in_hex
633 # For example: "hash://server/sha256/
634 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
636 # On Windows, trusted CA certificates can be loaded from the system
637 # certificate store by setting this to cert_store://<name>, e.g.,
638 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
639 # Note that when running wpa_supplicant as an application, the user
640 # certificate store (My user account) is used, whereas computer store
641 # (Computer account) is used when running wpasvc as a service.
642 # ca_path: Directory path for CA certificate files (PEM). This path may
643 # contain multiple CA certificates in OpenSSL format. Common use for this
644 # is to point to system trusted CA list which is often installed into
645 # directory like /etc/ssl/certs. If configured, these certificates are
646 # added to the list of trusted CAs. ca_cert may also be included in that
647 # case, but it is not required.
648 # client_cert: File path to client certificate file (PEM/DER)
649 # Full path should be used since working directory may change when
650 # wpa_supplicant is run in the background.
651 # Alternatively, a named configuration blob can be used by setting this
652 # to blob://<blob name>.
653 # private_key: File path to client private key file (PEM/DER/PFX)
654 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
655 # commented out. Both the private key and certificate will be read from
656 # the PKCS#12 file in this case. Full path should be used since working
657 # directory may change when wpa_supplicant is run in the background.
658 # Windows certificate store can be used by leaving client_cert out and
659 # configuring private_key in one of the following formats:
660 # cert://substring_to_match
661 # hash://certificate_thumbprint_in_hex
662 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
663 # Note that when running wpa_supplicant as an application, the user
664 # certificate store (My user account) is used, whereas computer store
665 # (Computer account) is used when running wpasvc as a service.
666 # Alternatively, a named configuration blob can be used by setting this
667 # to blob://<blob name>.
668 # private_key_passwd: Password for private key file (if left out, this will be
669 # asked through control interface)
670 # dh_file: File path to DH/DSA parameters file (in PEM format)
671 # This is an optional configuration file for setting parameters for an
672 # ephemeral DH key exchange. In most cases, the default RSA
673 # authentication does not use this configuration. However, it is possible
674 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
675 # DSA keys always use ephemeral DH keys. This can be used to achieve
676 # forward secrecy. If the file is in DSA parameters format, it will be
677 # automatically converted into DH params.
678 # subject_match: Substring to be matched against the subject of the
679 # authentication server certificate. If this string is set, the server
680 # sertificate is only accepted if it contains this string in the subject.
681 # The subject string is in following format:
682 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
683 # altsubject_match: Semicolon separated string of entries to be matched against
684 # the alternative subject name of the authentication server certificate.
685 # If this string is set, the server sertificate is only accepted if it
686 # contains one of the entries in an alternative subject name extension.
687 # altSubjectName string is in following format: TYPE:VALUE
688 # Example: EMAIL:server@example.com
689 # Example: DNS:server.example.com;DNS:server2.example.com
690 # Following types are supported: EMAIL, DNS, URI
691 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
692 # (string with field-value pairs, e.g., "peapver=0" or
693 # "peapver=1 peaplabel=1")
694 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
695 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
696 # to be used during key derivation when PEAPv1 or newer. Most existing
697 # PEAPv1 implementation seem to be using the old label, "client EAP
698 # encryption", and wpa_supplicant is now using that as the default value.
699 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
700 # interoperate with PEAPv1; see eap_testing.txt for more details.
701 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
702 # tunneled EAP-Success. This is required with some RADIUS servers that
703 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
704 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
705 # include_tls_length=1 can be used to force wpa_supplicant to include
706 # TLS Message Length field in all TLS messages even if they are not
708 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
709 # challenges (by default, it accepts 2 or 3)
710 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
711 # protected result indication.
712 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
714 # * 0 = do not use cryptobinding (default)
715 # * 1 = use cryptobinding if server supports it
716 # * 2 = require cryptobinding
717 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
719 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
720 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
721 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
723 # TLS-based methods can use the following parameters to control TLS behavior
724 # (these are normally in the phase1 parameter, but can be used also in the
725 # phase2 parameter when EAP-TLS is used within the inner tunnel):
726 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
727 # TLS library, these may be disabled by default to enforce stronger
729 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
730 # the TLS library to accept certificates even if they are not currently
731 # valid, i.e., have expired or have not yet become valid; this should be
732 # used only for testing purposes)
733 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
734 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
735 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
736 # as a workaround for broken authentication server implementations unless
737 # EAP workarounds are disabled with eap_workarounds=0.
738 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
739 # default value to be used automatically).
741 # Following certificate/private key fields are used in inner Phase2
742 # authentication when using EAP-TTLS or EAP-PEAP.
743 # ca_cert2: File path to CA certificate file. This file can have one or more
744 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
745 # server certificate will not be verified. This is insecure and a trusted
746 # CA certificate should always be configured.
747 # ca_path2: Directory path for CA certificate files (PEM)
748 # client_cert2: File path to client certificate file
749 # private_key2: File path to client private key file
750 # private_key2_passwd: Password for private key file
751 # dh_file2: File path to DH/DSA parameters file (in PEM format)
752 # subject_match2: Substring to be matched against the subject of the
753 # authentication server certificate.
754 # altsubject_match2: Substring to be matched against the alternative subject
755 # name of the authentication server certificate.
757 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
758 # This value limits the fragment size for EAP methods that support
759 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
760 # small enough to make the EAP messages fit in MTU of the network
761 # interface used for EAPOL. The default value is suitable for most
764 # EAP-FAST variables:
765 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
766 # to create this file and write updates to it when PAC is being
767 # provisioned or refreshed. Full path to the file should be used since
768 # working directory may change when wpa_supplicant is run in the
769 # background. Alternatively, a named configuration blob can be used by
770 # setting this to blob://<blob name>
771 # phase1: fast_provisioning option can be used to enable in-line provisioning
772 # of EAP-FAST credentials (PAC):
774 # 1 = allow unauthenticated provisioning,
775 # 2 = allow authenticated provisioning,
776 # 3 = allow both unauthenticated and authenticated provisioning
777 # fast_max_pac_list_len=<num> option can be used to set the maximum
778 # number of PAC entries to store in a PAC list (default: 10)
779 # fast_pac_format=binary option can be used to select binary format for
780 # storing PAC entries in order to save some space (the default
781 # text format uses about 2.5 times the size of minimal binary
784 # wpa_supplicant supports number of "EAP workarounds" to work around
785 # interoperability issues with incorrectly behaving authentication servers.
786 # These are enabled by default because some of the issues are present in large
787 # number of authentication servers. Strict EAP conformance mode can be
788 # configured by disabling workarounds with eap_workaround=0.
790 # Station inactivity limit
792 # If a station does not send anything in ap_max_inactivity seconds, an
793 # empty data frame is sent to it in order to verify whether it is
794 # still in range. If this frame is not ACKed, the station will be
795 # disassociated and then deauthenticated. This feature is used to
796 # clear station table of old entries when the STAs move out of the
799 # The station can associate again with the AP if it is still in range;
800 # this inactivity poll is just used as a nicer way of verifying
801 # inactivity; i.e., client will not report broken connection because
802 # disassociation frame is not sent immediately without first polling
803 # the STA with a data frame.
804 # default: 300 (i.e., 5 minutes)
805 #ap_max_inactivity=300
807 # DTIM period in Beacon intervals for AP mode (default: 2)
812 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
815 psk="very secret passphrase"
819 # Same as previous, but request SSID-specific scanning (for APs that reject
824 psk="very secret passphrase"
828 # Only WPA-PSK is used. Any valid cipher combination is accepted.
834 group=CCMP TKIP WEP104 WEP40
835 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
839 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
846 psk="not so secure passphrase"
850 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
851 # or WEP40 as the group cipher will not be accepted.
859 identity="user@example.com"
860 ca_cert="/etc/cert/ca.pem"
861 client_cert="/etc/cert/user.pem"
862 private_key="/etc/cert/user.prv"
863 private_key_passwd="password"
867 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
873 identity="user@example.com"
875 ca_cert="/etc/cert/ca.pem"
877 phase2="auth=MSCHAPV2"
881 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
882 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
887 identity="user@example.com"
888 anonymous_identity="anonymous@example.com"
890 ca_cert="/etc/cert/ca.pem"
894 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
895 # use. Real identity is sent only within an encrypted TLS tunnel.
900 identity="user@example.com"
901 anonymous_identity="anonymous@example.com"
903 ca_cert="/etc/cert/ca.pem"
904 phase2="auth=MSCHAPV2"
907 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
913 # Phase1 / outer authentication
914 anonymous_identity="anonymous@example.com"
915 ca_cert="/etc/cert/ca.pem"
916 # Phase 2 / inner authentication
918 ca_cert2="/etc/cert/ca2.pem"
919 client_cert2="/etc/cer/user.pem"
920 private_key2="/etc/cer/user.prv"
921 private_key2_passwd="password"
925 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
929 bssid=00:11:22:33:44:55
931 key_mgmt=WPA-PSK WPA-EAP
934 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
937 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
938 # and all valid ciphers.
941 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
945 # EAP-SIM with a GSM SIM or USIM
960 anonymous_identity="eap_psk_user"
961 password=06b4be19da289f475aa46a33cb793029
962 identity="eap_psk_user@example.com"
966 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
967 # EAP-TLS for authentication and key generation; require both unicast and
968 # broadcast WEP keys.
973 identity="user@example.com"
974 ca_cert="/etc/cert/ca.pem"
975 client_cert="/etc/cert/user.pem"
976 private_key="/etc/cert/user.prv"
977 private_key_passwd="password"
982 # LEAP with dynamic WEP keys
991 # EAP-IKEv2 using shared secrets for both server and peer authentication
1000 # EAP-FAST with WPA (WPA or WPA2)
1002 ssid="eap-fast-test"
1005 anonymous_identity="FAST-000102030405"
1008 phase1="fast_provisioning=1"
1009 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1013 ssid="eap-fast-test"
1016 anonymous_identity="FAST-000102030405"
1019 phase1="fast_provisioning=1"
1020 pac_file="blob://eap-fast-pac"
1023 # Plaintext connection (no WPA, no IEEE 802.1X)
1025 ssid="plaintext-test"
1030 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1032 ssid="static-wep-test"
1036 wep_key2="1234567890123"
1042 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1043 # IEEE 802.11 authentication
1045 ssid="static-wep-test2"
1049 wep_key2="1234567890123"
1056 # IBSS/ad-hoc network with WPA-None/TKIP.
1065 psk="secret passphrase"
1069 # Catch all example that allows more or less all configuration modes
1073 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1075 group=CCMP TKIP WEP104 WEP40
1076 psk="very secret passphrase"
1078 identity="user@example.com"
1080 ca_cert="/etc/cert/ca.pem"
1081 client_cert="/etc/cert/user.pem"
1082 private_key="/etc/cert/user.prv"
1083 private_key_passwd="password"
1084 phase1="peaplabel=0"
1087 # Example of EAP-TLS with smartcard (openssl engine)
1095 identity="user@example.com"
1096 ca_cert="/etc/cert/ca.pem"
1097 client_cert="/etc/cert/user.pem"
1101 # The engine configured here must be available. Look at
1102 # OpenSSL engine support in the global section.
1103 # The key available through the engine must be the private key
1104 # matching the client certificate configured above.
1106 # use the opensc engine
1110 # use the pkcs11 engine
1114 # Optional PIN configuration; this can be left out and PIN will be
1115 # asked through the control interface
1119 # Example configuration showing how to use an inlined blob as a CA certificate
1120 # data instead of using external file
1125 identity="user@example.com"
1126 anonymous_identity="anonymous@example.com"
1128 ca_cert="blob://exampleblob"
1132 blob-base64-exampleblob={
1133 SGVsbG8gV29ybGQhCg==
1137 # Wildcard match for SSID (plaintext APs only). This example select any
1138 # open AP regardless of its SSID.