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 # Interworking (IEEE 802.11u)
278 # Enable Interworking
281 # Homogenous ESS identifier
282 # If this is set, scans will be used to request response only from BSSes
283 # belonging to the specified Homogeneous ESS. This is used only if interworking
285 # hessid=00:11:22:33:44:55
287 # Automatic network selection behavior
288 # 0 = do not automatically go through Interworking network selection
289 # (i.e., require explicit interworking_select command for this; default)
290 # 1 = perform Interworking network selection if one or more
291 # credentials have been configured and scan did not find a
292 # matching network block
297 # Each credential used for automatic network selection is configured as a set
298 # of parameters that are compared to the information advertised by the APs when
299 # interworking_select and interworking_connect commands are used.
303 # priority: Priority group
304 # By default, all networks and credentials get the same priority group
305 # (0). This field can be used to give higher priority for credentials
306 # (and similarly in struct wpa_ssid for network blocks) to change the
307 # Interworking automatic networking selection behavior. The matching
308 # network (based on either an enabled network block or a credential)
309 # with the highest priority value will be selected.
311 # pcsc: Use PC/SC and SIM/USIM card
313 # realm: Home Realm for Interworking
315 # username: Username for Interworking network selection
317 # password: Password for Interworking network selection
319 # ca_cert: CA certificate for Interworking network selection
321 # client_cert: File path to client certificate file (PEM/DER)
322 # This field is used with Interworking networking selection for a case
323 # where client certificate/private key is used for authentication
324 # (EAP-TLS). Full path to the file should be used since working
325 # directory may change when wpa_supplicant is run in the background.
327 # Alternatively, a named configuration blob can be used by setting
328 # this to blob://blob_name.
330 # private_key: File path to client private key file (PEM/DER/PFX)
331 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
332 # commented out. Both the private key and certificate will be read
333 # from the PKCS#12 file in this case. Full path to the file should be
334 # used since working directory may change when wpa_supplicant is run
337 # Windows certificate store can be used by leaving client_cert out and
338 # configuring private_key in one of the following formats:
340 # cert://substring_to_match
342 # hash://certificate_thumbprint_in_hex
344 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
346 # Note that when running wpa_supplicant as an application, the user
347 # certificate store (My user account) is used, whereas computer store
348 # (Computer account) is used when running wpasvc as a service.
350 # Alternatively, a named configuration blob can be used by setting
351 # this to blob://blob_name.
353 # private_key_passwd: Password for private key file
355 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
357 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
360 # domain: Home service provider FQDN
361 # This is used to compare against the Domain Name List to figure out
362 # whether the AP is operated by the Home SP.
364 # roaming_consortium: Roaming Consortium OI
365 # If roaming_consortium_len is non-zero, this field contains the
366 # Roaming Consortium OI that can be used to determine which access
367 # points support authentication with this credential. This is an
368 # alternative to the use of the realm parameter. When using Roaming
369 # Consortium to match the network, the EAP parameters need to be
370 # pre-configured with the credential since the NAI Realm information
371 # may not be available or fetched.
373 # eap: Pre-configured EAP method
374 # This optional field can be used to specify which EAP method will be
375 # used with this credential. If not set, the EAP method is selected
376 # automatically based on ANQP information (e.g., NAI Realm).
378 # phase1: Pre-configure Phase 1 (outer authentication) parameters
379 # This optional field is used with like the 'eap' parameter.
381 # phase2: Pre-configure Phase 2 (inner authentication) parameters
382 # This optional field is used with like the 'eap' parameter.
387 # realm="example.com"
388 # username="user@example.com"
389 # password="password"
390 # ca_cert="/etc/wpa_supplicant/ca.pem"
391 # domain="example.com"
395 # imsi="310026-000000000"
396 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
400 # realm="example.com"
402 # password="password"
403 # ca_cert="/etc/wpa_supplicant/ca.pem"
404 # domain="example.com"
405 # roaming_consortium=223344
407 # phase2="auth=MSCHAPV2"
415 # Each network (usually AP's sharing the same SSID) is configured as a separate
416 # block in this configuration file. The network blocks are in preference order
417 # (the first match is used).
419 # network block fields:
422 # 0 = this network can be used (default)
423 # 1 = this network block is disabled (can be enabled through ctrl_iface,
424 # e.g., with wpa_cli or wpa_gui)
426 # id_str: Network identifier string for external scripts. This value is passed
427 # to external action script through wpa_cli as WPA_ID_STR environment
428 # variable to make it easier to do network specific configuration.
430 # ssid: SSID (mandatory); network name in one of the optional formats:
431 # - an ASCII string with double quotation
432 # - a hex string (two characters per octet of SSID)
433 # - a printf-escaped ASCII string P"<escaped string>"
436 # 0 = do not scan this SSID with specific Probe Request frames (default)
437 # 1 = scan with SSID-specific Probe Request frames (this can be used to
438 # find APs that do not accept broadcast SSID or use multiple SSIDs;
439 # this will add latency to scanning, so enable this only when needed)
441 # bssid: BSSID (optional); if set, this network block is used only when
442 # associating with the AP using the configured BSSID
444 # priority: priority group (integer)
445 # By default, all networks will get same priority group (0). If some of the
446 # networks are more desirable, this field can be used to change the order in
447 # which wpa_supplicant goes through the networks when selecting a BSS. The
448 # priority groups will be iterated in decreasing priority (i.e., the larger the
449 # priority value, the sooner the network is matched against the scan results).
450 # Within each priority group, networks will be selected based on security
451 # policy, signal strength, etc.
452 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
453 # using this priority to select the order for scanning. Instead, they try the
454 # networks in the order that used in the configuration file.
456 # mode: IEEE 802.11 operation mode
457 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
458 # 1 = IBSS (ad-hoc, peer-to-peer)
459 # 2 = AP (access point)
460 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
461 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
462 # following network block options:
463 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
464 # both), and psk must also be set.
466 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
467 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
468 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
469 # In addition, this value is only used by the station that creates the IBSS. If
470 # an IBSS network with the configured SSID is already present, the frequency of
471 # the network will be used instead of this configured value.
473 # scan_freq: List of frequencies to scan
474 # Space-separated list of frequencies in MHz to scan when searching for this
475 # BSS. If the subset of channels used by the network is known, this option can
476 # be used to optimize scanning to not occur on channels that the network does
477 # not use. Example: scan_freq=2412 2437 2462
479 # freq_list: Array of allowed frequencies
480 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
481 # set, scan results that do not match any of the specified frequencies are not
482 # considered when selecting a BSS.
484 # proto: list of accepted protocols
485 # WPA = WPA/IEEE 802.11i/D3.0
486 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
487 # If not set, this defaults to: WPA RSN
489 # key_mgmt: list of accepted authenticated key management protocols
490 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
491 # WPA-EAP = WPA using EAP authentication
492 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
494 # NONE = WPA is not used; plaintext or static WEP could be used
495 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
496 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
497 # If not set, this defaults to: WPA-PSK WPA-EAP
499 # ieee80211w: whether management frame protection is enabled
500 # 0 = disabled (default)
503 # The most common configuration options for this based on the PMF (protected
504 # management frames) certification program are:
505 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
506 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
507 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
509 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
510 # OPEN = Open System authentication (required for WPA/WPA2)
511 # SHARED = Shared Key authentication (requires static WEP keys)
512 # LEAP = LEAP/Network EAP (only used with LEAP)
513 # If not set, automatic selection is used (Open System with LEAP enabled if
514 # LEAP is allowed as one of the EAP methods).
516 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
517 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
518 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
519 # NONE = Use only Group Keys (deprecated, should not be included if APs support
521 # If not set, this defaults to: CCMP TKIP
523 # group: list of accepted group (broadcast/multicast) ciphers for WPA
524 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
525 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
526 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
527 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
528 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
530 # psk: WPA preshared key; 256-bit pre-shared key
531 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
532 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
533 # generated using the passphrase and SSID). ASCII passphrase must be between
534 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
535 # be used to indicate that the PSK/passphrase is stored in external storage.
536 # This field is not needed, if WPA-EAP is used.
537 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
538 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
539 # startup and reconfiguration time can be optimized by generating the PSK only
540 # only when the passphrase or SSID has actually changed.
542 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
543 # Dynamic WEP key required for non-WPA mode
544 # bit0 (1): require dynamically generated unicast WEP key
545 # bit1 (2): require dynamically generated broadcast WEP key
546 # (3 = require both keys; default)
547 # Note: When using wired authentication, eapol_flags must be set to 0 for the
548 # authentication to be completed successfully.
550 # mixed_cell: This option can be used to configure whether so called mixed
551 # cells, i.e., networks that use both plaintext and encryption in the same
552 # SSID, are allowed when selecting a BSS from scan results.
553 # 0 = disabled (default)
556 # proactive_key_caching:
557 # Enable/disable opportunistic PMKSA caching for WPA2.
558 # 0 = disabled (default unless changed with the global okc parameter)
561 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
562 # hex without quotation, e.g., 0102030405)
563 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
565 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
566 # allowed. This is only used with RSN/WPA2.
567 # 0 = disabled (default)
571 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
572 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
574 # Following fields are only used with internal EAP implementation.
575 # eap: space-separated list of accepted EAP methods
576 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
577 # cannot be used with WPA; to be used as a Phase 2 method
578 # with EAP-PEAP or EAP-TTLS)
579 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
580 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
581 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
582 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
583 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
584 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
585 # TLS = EAP-TLS (client and server certificate)
586 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
587 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
589 # If not set, all compiled in methods are allowed.
591 # identity: Identity string for EAP
592 # This field is also used to configure user NAI for
593 # EAP-PSK/PAX/SAKE/GPSK.
594 # anonymous_identity: Anonymous identity string for EAP (to be used as the
595 # unencrypted identity with EAP types that support different tunnelled
596 # identity, e.g., EAP-TTLS). This field can also be used with
597 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
598 # password: Password string for EAP. This field can include either the
599 # plaintext password (using ASCII or hex string) or a NtPasswordHash
600 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
601 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
602 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
603 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
604 # PSK) is also configured using this field. For EAP-GPSK, this is a
605 # variable length PSK. ext:<name of external password field> format can
606 # be used to indicate that the password is stored in external storage.
607 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
608 # or more trusted CA certificates. If ca_cert and ca_path are not
609 # included, server certificate will not be verified. This is insecure and
610 # a trusted CA certificate should always be configured when using
611 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
612 # change when wpa_supplicant is run in the background.
614 # Alternatively, this can be used to only perform matching of the server
615 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
616 # this case, the possible CA certificates in the server certificate chain
617 # are ignored and only the server certificate is verified. This is
618 # configured with the following format:
619 # hash:://server/sha256/cert_hash_in_hex
620 # For example: "hash://server/sha256/
621 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
623 # On Windows, trusted CA certificates can be loaded from the system
624 # certificate store by setting this to cert_store://<name>, e.g.,
625 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
626 # Note that when running wpa_supplicant as an application, the user
627 # certificate store (My user account) is used, whereas computer store
628 # (Computer account) is used when running wpasvc as a service.
629 # ca_path: Directory path for CA certificate files (PEM). This path may
630 # contain multiple CA certificates in OpenSSL format. Common use for this
631 # is to point to system trusted CA list which is often installed into
632 # directory like /etc/ssl/certs. If configured, these certificates are
633 # added to the list of trusted CAs. ca_cert may also be included in that
634 # case, but it is not required.
635 # client_cert: File path to client certificate file (PEM/DER)
636 # Full path should be used since working directory may change when
637 # wpa_supplicant is run in the background.
638 # Alternatively, a named configuration blob can be used by setting this
639 # to blob://<blob name>.
640 # private_key: File path to client private key file (PEM/DER/PFX)
641 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
642 # commented out. Both the private key and certificate will be read from
643 # the PKCS#12 file in this case. Full path should be used since working
644 # directory may change when wpa_supplicant is run in the background.
645 # Windows certificate store can be used by leaving client_cert out and
646 # configuring private_key in one of the following formats:
647 # cert://substring_to_match
648 # hash://certificate_thumbprint_in_hex
649 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
650 # Note that when running wpa_supplicant as an application, the user
651 # certificate store (My user account) is used, whereas computer store
652 # (Computer account) is used when running wpasvc as a service.
653 # Alternatively, a named configuration blob can be used by setting this
654 # to blob://<blob name>.
655 # private_key_passwd: Password for private key file (if left out, this will be
656 # asked through control interface)
657 # dh_file: File path to DH/DSA parameters file (in PEM format)
658 # This is an optional configuration file for setting parameters for an
659 # ephemeral DH key exchange. In most cases, the default RSA
660 # authentication does not use this configuration. However, it is possible
661 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
662 # DSA keys always use ephemeral DH keys. This can be used to achieve
663 # forward secrecy. If the file is in DSA parameters format, it will be
664 # automatically converted into DH params.
665 # subject_match: Substring to be matched against the subject of the
666 # authentication server certificate. If this string is set, the server
667 # sertificate is only accepted if it contains this string in the subject.
668 # The subject string is in following format:
669 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
670 # altsubject_match: Semicolon separated string of entries to be matched against
671 # the alternative subject name of the authentication server certificate.
672 # If this string is set, the server sertificate is only accepted if it
673 # contains one of the entries in an alternative subject name extension.
674 # altSubjectName string is in following format: TYPE:VALUE
675 # Example: EMAIL:server@example.com
676 # Example: DNS:server.example.com;DNS:server2.example.com
677 # Following types are supported: EMAIL, DNS, URI
678 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
679 # (string with field-value pairs, e.g., "peapver=0" or
680 # "peapver=1 peaplabel=1")
681 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
682 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
683 # to be used during key derivation when PEAPv1 or newer. Most existing
684 # PEAPv1 implementation seem to be using the old label, "client EAP
685 # encryption", and wpa_supplicant is now using that as the default value.
686 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
687 # interoperate with PEAPv1; see eap_testing.txt for more details.
688 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
689 # tunneled EAP-Success. This is required with some RADIUS servers that
690 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
691 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
692 # include_tls_length=1 can be used to force wpa_supplicant to include
693 # TLS Message Length field in all TLS messages even if they are not
695 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
696 # challenges (by default, it accepts 2 or 3)
697 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
698 # protected result indication.
699 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
701 # * 0 = do not use cryptobinding (default)
702 # * 1 = use cryptobinding if server supports it
703 # * 2 = require cryptobinding
704 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
706 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
707 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
708 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
710 # TLS-based methods can use the following parameters to control TLS behavior
711 # (these are normally in the phase1 parameter, but can be used also in the
712 # phase2 parameter when EAP-TLS is used within the inner tunnel):
713 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
714 # TLS library, these may be disabled by default to enforce stronger
716 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
717 # the TLS library to accept certificates even if they are not currently
718 # valid, i.e., have expired or have not yet become valid; this should be
719 # used only for testing purposes)
720 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
721 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
722 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
723 # as a workaround for broken authentication server implementations unless
724 # EAP workarounds are disabled with eap_workarounds=0.
725 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
726 # default value to be used automatically).
728 # Following certificate/private key fields are used in inner Phase2
729 # authentication when using EAP-TTLS or EAP-PEAP.
730 # ca_cert2: File path to CA certificate file. This file can have one or more
731 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
732 # server certificate will not be verified. This is insecure and a trusted
733 # CA certificate should always be configured.
734 # ca_path2: Directory path for CA certificate files (PEM)
735 # client_cert2: File path to client certificate file
736 # private_key2: File path to client private key file
737 # private_key2_passwd: Password for private key file
738 # dh_file2: File path to DH/DSA parameters file (in PEM format)
739 # subject_match2: Substring to be matched against the subject of the
740 # authentication server certificate.
741 # altsubject_match2: Substring to be matched against the alternative subject
742 # name of the authentication server certificate.
744 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
745 # This value limits the fragment size for EAP methods that support
746 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
747 # small enough to make the EAP messages fit in MTU of the network
748 # interface used for EAPOL. The default value is suitable for most
751 # EAP-FAST variables:
752 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
753 # to create this file and write updates to it when PAC is being
754 # provisioned or refreshed. Full path to the file should be used since
755 # working directory may change when wpa_supplicant is run in the
756 # background. Alternatively, a named configuration blob can be used by
757 # setting this to blob://<blob name>
758 # phase1: fast_provisioning option can be used to enable in-line provisioning
759 # of EAP-FAST credentials (PAC):
761 # 1 = allow unauthenticated provisioning,
762 # 2 = allow authenticated provisioning,
763 # 3 = allow both unauthenticated and authenticated provisioning
764 # fast_max_pac_list_len=<num> option can be used to set the maximum
765 # number of PAC entries to store in a PAC list (default: 10)
766 # fast_pac_format=binary option can be used to select binary format for
767 # storing PAC entries in order to save some space (the default
768 # text format uses about 2.5 times the size of minimal binary
771 # wpa_supplicant supports number of "EAP workarounds" to work around
772 # interoperability issues with incorrectly behaving authentication servers.
773 # These are enabled by default because some of the issues are present in large
774 # number of authentication servers. Strict EAP conformance mode can be
775 # configured by disabling workarounds with eap_workaround=0.
777 # Station inactivity limit
779 # If a station does not send anything in ap_max_inactivity seconds, an
780 # empty data frame is sent to it in order to verify whether it is
781 # still in range. If this frame is not ACKed, the station will be
782 # disassociated and then deauthenticated. This feature is used to
783 # clear station table of old entries when the STAs move out of the
786 # The station can associate again with the AP if it is still in range;
787 # this inactivity poll is just used as a nicer way of verifying
788 # inactivity; i.e., client will not report broken connection because
789 # disassociation frame is not sent immediately without first polling
790 # the STA with a data frame.
791 # default: 300 (i.e., 5 minutes)
792 #ap_max_inactivity=300
794 # DTIM period in Beacon intervals for AP mode (default: 2)
799 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
802 psk="very secret passphrase"
806 # Same as previous, but request SSID-specific scanning (for APs that reject
811 psk="very secret passphrase"
815 # Only WPA-PSK is used. Any valid cipher combination is accepted.
821 group=CCMP TKIP WEP104 WEP40
822 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
826 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
833 psk="not so secure passphrase"
837 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
838 # or WEP40 as the group cipher will not be accepted.
846 identity="user@example.com"
847 ca_cert="/etc/cert/ca.pem"
848 client_cert="/etc/cert/user.pem"
849 private_key="/etc/cert/user.prv"
850 private_key_passwd="password"
854 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
860 identity="user@example.com"
862 ca_cert="/etc/cert/ca.pem"
864 phase2="auth=MSCHAPV2"
868 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
869 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
874 identity="user@example.com"
875 anonymous_identity="anonymous@example.com"
877 ca_cert="/etc/cert/ca.pem"
881 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
882 # 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"
891 phase2="auth=MSCHAPV2"
894 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
900 # Phase1 / outer authentication
901 anonymous_identity="anonymous@example.com"
902 ca_cert="/etc/cert/ca.pem"
903 # Phase 2 / inner authentication
905 ca_cert2="/etc/cert/ca2.pem"
906 client_cert2="/etc/cer/user.pem"
907 private_key2="/etc/cer/user.prv"
908 private_key2_passwd="password"
912 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
916 bssid=00:11:22:33:44:55
918 key_mgmt=WPA-PSK WPA-EAP
921 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
924 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
925 # and all valid ciphers.
928 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
932 # EAP-SIM with a GSM SIM or USIM
947 anonymous_identity="eap_psk_user"
948 password=06b4be19da289f475aa46a33cb793029
949 identity="eap_psk_user@example.com"
953 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
954 # EAP-TLS for authentication and key generation; require both unicast and
955 # broadcast WEP keys.
960 identity="user@example.com"
961 ca_cert="/etc/cert/ca.pem"
962 client_cert="/etc/cert/user.pem"
963 private_key="/etc/cert/user.prv"
964 private_key_passwd="password"
969 # LEAP with dynamic WEP keys
978 # EAP-IKEv2 using shared secrets for both server and peer authentication
987 # EAP-FAST with WPA (WPA or WPA2)
992 anonymous_identity="FAST-000102030405"
995 phase1="fast_provisioning=1"
996 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1000 ssid="eap-fast-test"
1003 anonymous_identity="FAST-000102030405"
1006 phase1="fast_provisioning=1"
1007 pac_file="blob://eap-fast-pac"
1010 # Plaintext connection (no WPA, no IEEE 802.1X)
1012 ssid="plaintext-test"
1017 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1019 ssid="static-wep-test"
1023 wep_key2="1234567890123"
1029 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1030 # IEEE 802.11 authentication
1032 ssid="static-wep-test2"
1036 wep_key2="1234567890123"
1043 # IBSS/ad-hoc network with WPA-None/TKIP.
1052 psk="secret passphrase"
1056 # Catch all example that allows more or less all configuration modes
1060 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1062 group=CCMP TKIP WEP104 WEP40
1063 psk="very secret passphrase"
1065 identity="user@example.com"
1067 ca_cert="/etc/cert/ca.pem"
1068 client_cert="/etc/cert/user.pem"
1069 private_key="/etc/cert/user.prv"
1070 private_key_passwd="password"
1071 phase1="peaplabel=0"
1074 # Example of EAP-TLS with smartcard (openssl engine)
1082 identity="user@example.com"
1083 ca_cert="/etc/cert/ca.pem"
1084 client_cert="/etc/cert/user.pem"
1088 # The engine configured here must be available. Look at
1089 # OpenSSL engine support in the global section.
1090 # The key available through the engine must be the private key
1091 # matching the client certificate configured above.
1093 # use the opensc engine
1097 # use the pkcs11 engine
1101 # Optional PIN configuration; this can be left out and PIN will be
1102 # asked through the control interface
1106 # Example configuration showing how to use an inlined blob as a CA certificate
1107 # data instead of using external file
1112 identity="user@example.com"
1113 anonymous_identity="anonymous@example.com"
1115 ca_cert="blob://exampleblob"
1119 blob-base64-exampleblob={
1120 SGVsbG8gV29ybGQhCg==
1124 # Wildcard match for SSID (plaintext APs only). This example select any
1125 # open AP regardless of its SSID.