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 # Enabled SAE finite cyclic groups in preference order
285 # By default (if this parameter is not set), the mandatory group 19 (ECC group
286 # defined over a 256-bit prime order field) is preferred, but other groups are
287 # also enabled. If this parameter is set, the groups will be tried in the
288 # indicated order. The group values are listed in the IANA registry:
289 # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
290 #sae_groups=21 20 19 26 25
292 # Default value for DTIM period (if not overridden in network block)
295 # Default value for Beacon interval (if not overridden in network block)
298 # Additional vendor specific elements for Beacon and Probe Response frames
299 # This parameter can be used to add additional vendor specific element(s) into
300 # the end of the Beacon and Probe Response frames. The format for these
301 # element(s) is a hexdump of the raw information elements (id+len+payload for
302 # one or more elements). This is used in AP and P2P GO modes.
303 #ap_vendor_elements=dd0411223301
305 # Ignore scan results older than request
307 # The driver may have a cache of scan results that makes it return
308 # information that is older than our scan trigger. This parameter can
309 # be used to configure such old information to be ignored instead of
310 # allowing it to update the internal BSS table.
311 #ignore_old_scan_res=0
313 # scan_cur_freq: Whether to scan only the current frequency
314 # 0: Scan all available frequencies. (Default)
315 # 1: Scan current operating frequency if another VIF on the same radio
316 # is already associated.
318 # Interworking (IEEE 802.11u)
320 # Enable Interworking
323 # Homogenous ESS identifier
324 # If this is set, scans will be used to request response only from BSSes
325 # belonging to the specified Homogeneous ESS. This is used only if interworking
327 # hessid=00:11:22:33:44:55
329 # Automatic network selection behavior
330 # 0 = do not automatically go through Interworking network selection
331 # (i.e., require explicit interworking_select command for this; default)
332 # 1 = perform Interworking network selection if one or more
333 # credentials have been configured and scan did not find a
334 # matching network block
339 # Each credential used for automatic network selection is configured as a set
340 # of parameters that are compared to the information advertised by the APs when
341 # interworking_select and interworking_connect commands are used.
345 # priority: Priority group
346 # By default, all networks and credentials get the same priority group
347 # (0). This field can be used to give higher priority for credentials
348 # (and similarly in struct wpa_ssid for network blocks) to change the
349 # Interworking automatic networking selection behavior. The matching
350 # network (based on either an enabled network block or a credential)
351 # with the highest priority value will be selected.
353 # pcsc: Use PC/SC and SIM/USIM card
355 # realm: Home Realm for Interworking
357 # username: Username for Interworking network selection
359 # password: Password for Interworking network selection
361 # ca_cert: CA certificate for Interworking network selection
363 # client_cert: File path to client certificate file (PEM/DER)
364 # This field is used with Interworking networking selection for a case
365 # where client certificate/private key is used for authentication
366 # (EAP-TLS). Full path to the file should be used since working
367 # directory may change when wpa_supplicant is run in the background.
369 # Alternatively, a named configuration blob can be used by setting
370 # this to blob://blob_name.
372 # private_key: File path to client private key file (PEM/DER/PFX)
373 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
374 # commented out. Both the private key and certificate will be read
375 # from the PKCS#12 file in this case. Full path to the file should be
376 # used since working directory may change when wpa_supplicant is run
379 # Windows certificate store can be used by leaving client_cert out and
380 # configuring private_key in one of the following formats:
382 # cert://substring_to_match
384 # hash://certificate_thumbprint_in_hex
386 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
388 # Note that when running wpa_supplicant as an application, the user
389 # certificate store (My user account) is used, whereas computer store
390 # (Computer account) is used when running wpasvc as a service.
392 # Alternatively, a named configuration blob can be used by setting
393 # this to blob://blob_name.
395 # private_key_passwd: Password for private key file
397 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
399 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
402 # domain: Home service provider FQDN(s)
403 # This is used to compare against the Domain Name List to figure out
404 # whether the AP is operated by the Home SP. Multiple domain entries can
405 # be used to configure alternative FQDNs that will be considered home
408 # roaming_consortium: Roaming Consortium OI
409 # If roaming_consortium_len is non-zero, this field contains the
410 # Roaming Consortium OI that can be used to determine which access
411 # points support authentication with this credential. This is an
412 # alternative to the use of the realm parameter. When using Roaming
413 # Consortium to match the network, the EAP parameters need to be
414 # pre-configured with the credential since the NAI Realm information
415 # may not be available or fetched.
417 # eap: Pre-configured EAP method
418 # This optional field can be used to specify which EAP method will be
419 # used with this credential. If not set, the EAP method is selected
420 # automatically based on ANQP information (e.g., NAI Realm).
422 # phase1: Pre-configure Phase 1 (outer authentication) parameters
423 # This optional field is used with like the 'eap' parameter.
425 # phase2: Pre-configure Phase 2 (inner authentication) parameters
426 # This optional field is used with like the 'eap' parameter.
428 # excluded_ssid: Excluded SSID
429 # This optional field can be used to excluded specific SSID(s) from
430 # matching with the network. Multiple entries can be used to specify more
436 # realm="example.com"
437 # username="user@example.com"
438 # password="password"
439 # ca_cert="/etc/wpa_supplicant/ca.pem"
440 # domain="example.com"
444 # imsi="310026-000000000"
445 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
449 # realm="example.com"
451 # password="password"
452 # ca_cert="/etc/wpa_supplicant/ca.pem"
453 # domain="example.com"
454 # roaming_consortium=223344
456 # phase2="auth=MSCHAPV2"
464 # Each network (usually AP's sharing the same SSID) is configured as a separate
465 # block in this configuration file. The network blocks are in preference order
466 # (the first match is used).
468 # network block fields:
471 # 0 = this network can be used (default)
472 # 1 = this network block is disabled (can be enabled through ctrl_iface,
473 # e.g., with wpa_cli or wpa_gui)
475 # id_str: Network identifier string for external scripts. This value is passed
476 # to external action script through wpa_cli as WPA_ID_STR environment
477 # variable to make it easier to do network specific configuration.
479 # ssid: SSID (mandatory); network name in one of the optional formats:
480 # - an ASCII string with double quotation
481 # - a hex string (two characters per octet of SSID)
482 # - a printf-escaped ASCII string P"<escaped string>"
485 # 0 = do not scan this SSID with specific Probe Request frames (default)
486 # 1 = scan with SSID-specific Probe Request frames (this can be used to
487 # find APs that do not accept broadcast SSID or use multiple SSIDs;
488 # this will add latency to scanning, so enable this only when needed)
490 # bssid: BSSID (optional); if set, this network block is used only when
491 # associating with the AP using the configured BSSID
493 # priority: priority group (integer)
494 # By default, all networks will get same priority group (0). If some of the
495 # networks are more desirable, this field can be used to change the order in
496 # which wpa_supplicant goes through the networks when selecting a BSS. The
497 # priority groups will be iterated in decreasing priority (i.e., the larger the
498 # priority value, the sooner the network is matched against the scan results).
499 # Within each priority group, networks will be selected based on security
500 # policy, signal strength, etc.
501 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
502 # using this priority to select the order for scanning. Instead, they try the
503 # networks in the order that used in the configuration file.
505 # mode: IEEE 802.11 operation mode
506 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
507 # 1 = IBSS (ad-hoc, peer-to-peer)
508 # 2 = AP (access point)
509 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
510 # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
511 # following network block options:
512 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
513 # both), and psk must also be set.
515 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
516 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
517 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
518 # In addition, this value is only used by the station that creates the IBSS. If
519 # an IBSS network with the configured SSID is already present, the frequency of
520 # the network will be used instead of this configured value.
522 # scan_freq: List of frequencies to scan
523 # Space-separated list of frequencies in MHz to scan when searching for this
524 # BSS. If the subset of channels used by the network is known, this option can
525 # be used to optimize scanning to not occur on channels that the network does
526 # not use. Example: scan_freq=2412 2437 2462
528 # freq_list: Array of allowed frequencies
529 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
530 # set, scan results that do not match any of the specified frequencies are not
531 # considered when selecting a BSS.
533 # This can also be set on the outside of the network block. In this case,
534 # it limits the frequencies that will be scanned.
536 # bgscan: Background scanning
537 # wpa_supplicant behavior for background scanning can be specified by
538 # configuring a bgscan module. These modules are responsible for requesting
539 # background scans for the purpose of roaming within an ESS (i.e., within a
540 # single network block with all the APs using the same SSID). The bgscan
541 # parameter uses following format: "<bgscan module name>:<module parameters>"
542 # Following bgscan modules are available:
543 # simple - Periodic background scans based on signal strength
544 # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
546 # bgscan="simple:30:-45:300"
547 # learn - Learn channels used by the network and try to avoid bgscans on other
548 # channels (experimental)
549 # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
550 # <long interval>[:<database file name>]"
551 # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
553 # proto: list of accepted protocols
554 # WPA = WPA/IEEE 802.11i/D3.0
555 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
556 # If not set, this defaults to: WPA RSN
558 # key_mgmt: list of accepted authenticated key management protocols
559 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
560 # WPA-EAP = WPA using EAP authentication
561 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
563 # NONE = WPA is not used; plaintext or static WEP could be used
564 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
565 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
566 # If not set, this defaults to: WPA-PSK WPA-EAP
568 # ieee80211w: whether management frame protection is enabled
569 # 0 = disabled (default unless changed with the global pmf parameter)
572 # The most common configuration options for this based on the PMF (protected
573 # management frames) certification program are:
574 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
575 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
576 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
578 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
579 # OPEN = Open System authentication (required for WPA/WPA2)
580 # SHARED = Shared Key authentication (requires static WEP keys)
581 # LEAP = LEAP/Network EAP (only used with LEAP)
582 # If not set, automatic selection is used (Open System with LEAP enabled if
583 # LEAP is allowed as one of the EAP methods).
585 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
586 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
587 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
588 # NONE = Use only Group Keys (deprecated, should not be included if APs support
590 # If not set, this defaults to: CCMP TKIP
592 # group: list of accepted group (broadcast/multicast) ciphers for WPA
593 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
594 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
595 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
596 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
597 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
599 # psk: WPA preshared key; 256-bit pre-shared key
600 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
601 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
602 # generated using the passphrase and SSID). ASCII passphrase must be between
603 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
604 # be used to indicate that the PSK/passphrase is stored in external storage.
605 # This field is not needed, if WPA-EAP is used.
606 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
607 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
608 # startup and reconfiguration time can be optimized by generating the PSK only
609 # only when the passphrase or SSID has actually changed.
611 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
612 # Dynamic WEP key required for non-WPA mode
613 # bit0 (1): require dynamically generated unicast WEP key
614 # bit1 (2): require dynamically generated broadcast WEP key
615 # (3 = require both keys; default)
616 # Note: When using wired authentication, eapol_flags must be set to 0 for the
617 # authentication to be completed successfully.
619 # mixed_cell: This option can be used to configure whether so called mixed
620 # cells, i.e., networks that use both plaintext and encryption in the same
621 # SSID, are allowed when selecting a BSS from scan results.
622 # 0 = disabled (default)
625 # proactive_key_caching:
626 # Enable/disable opportunistic PMKSA caching for WPA2.
627 # 0 = disabled (default unless changed with the global okc parameter)
630 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
631 # hex without quotation, e.g., 0102030405)
632 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
634 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
635 # allowed. This is only used with RSN/WPA2.
636 # 0 = disabled (default)
640 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
641 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
643 # Following fields are only used with internal EAP implementation.
644 # eap: space-separated list of accepted EAP methods
645 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
646 # cannot be used with WPA; to be used as a Phase 2 method
647 # with EAP-PEAP or EAP-TTLS)
648 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
649 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
650 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
651 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
652 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
653 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
654 # TLS = EAP-TLS (client and server certificate)
655 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
656 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
658 # If not set, all compiled in methods are allowed.
660 # identity: Identity string for EAP
661 # This field is also used to configure user NAI for
662 # EAP-PSK/PAX/SAKE/GPSK.
663 # anonymous_identity: Anonymous identity string for EAP (to be used as the
664 # unencrypted identity with EAP types that support different tunnelled
665 # identity, e.g., EAP-TTLS). This field can also be used with
666 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
667 # password: Password string for EAP. This field can include either the
668 # plaintext password (using ASCII or hex string) or a NtPasswordHash
669 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
670 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
671 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
672 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
673 # PSK) is also configured using this field. For EAP-GPSK, this is a
674 # variable length PSK. ext:<name of external password field> format can
675 # be used to indicate that the password is stored in external storage.
676 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
677 # or more trusted CA certificates. If ca_cert and ca_path are not
678 # included, server certificate will not be verified. This is insecure and
679 # a trusted CA certificate should always be configured when using
680 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
681 # change when wpa_supplicant is run in the background.
683 # Alternatively, this can be used to only perform matching of the server
684 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
685 # this case, the possible CA certificates in the server certificate chain
686 # are ignored and only the server certificate is verified. This is
687 # configured with the following format:
688 # hash:://server/sha256/cert_hash_in_hex
689 # For example: "hash://server/sha256/
690 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
692 # On Windows, trusted CA certificates can be loaded from the system
693 # certificate store by setting this to cert_store://<name>, e.g.,
694 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
695 # Note that when running wpa_supplicant as an application, the user
696 # certificate store (My user account) is used, whereas computer store
697 # (Computer account) is used when running wpasvc as a service.
698 # ca_path: Directory path for CA certificate files (PEM). This path may
699 # contain multiple CA certificates in OpenSSL format. Common use for this
700 # is to point to system trusted CA list which is often installed into
701 # directory like /etc/ssl/certs. If configured, these certificates are
702 # added to the list of trusted CAs. ca_cert may also be included in that
703 # case, but it is not required.
704 # client_cert: File path to client certificate file (PEM/DER)
705 # Full path should be used since working directory may change when
706 # wpa_supplicant is run in the background.
707 # Alternatively, a named configuration blob can be used by setting this
708 # to blob://<blob name>.
709 # private_key: File path to client private key file (PEM/DER/PFX)
710 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
711 # commented out. Both the private key and certificate will be read from
712 # the PKCS#12 file in this case. Full path should be used since working
713 # directory may change when wpa_supplicant is run in the background.
714 # Windows certificate store can be used by leaving client_cert out and
715 # configuring private_key in one of the following formats:
716 # cert://substring_to_match
717 # hash://certificate_thumbprint_in_hex
718 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
719 # Note that when running wpa_supplicant as an application, the user
720 # certificate store (My user account) is used, whereas computer store
721 # (Computer account) is used when running wpasvc as a service.
722 # Alternatively, a named configuration blob can be used by setting this
723 # to blob://<blob name>.
724 # private_key_passwd: Password for private key file (if left out, this will be
725 # asked through control interface)
726 # dh_file: File path to DH/DSA parameters file (in PEM format)
727 # This is an optional configuration file for setting parameters for an
728 # ephemeral DH key exchange. In most cases, the default RSA
729 # authentication does not use this configuration. However, it is possible
730 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
731 # DSA keys always use ephemeral DH keys. This can be used to achieve
732 # forward secrecy. If the file is in DSA parameters format, it will be
733 # automatically converted into DH params.
734 # subject_match: Substring to be matched against the subject of the
735 # authentication server certificate. If this string is set, the server
736 # sertificate is only accepted if it contains this string in the subject.
737 # The subject string is in following format:
738 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
739 # altsubject_match: Semicolon separated string of entries to be matched against
740 # the alternative subject name of the authentication server certificate.
741 # If this string is set, the server sertificate is only accepted if it
742 # contains one of the entries in an alternative subject name extension.
743 # altSubjectName string is in following format: TYPE:VALUE
744 # Example: EMAIL:server@example.com
745 # Example: DNS:server.example.com;DNS:server2.example.com
746 # Following types are supported: EMAIL, DNS, URI
747 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
748 # (string with field-value pairs, e.g., "peapver=0" or
749 # "peapver=1 peaplabel=1")
750 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
751 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
752 # to be used during key derivation when PEAPv1 or newer. Most existing
753 # PEAPv1 implementation seem to be using the old label, "client EAP
754 # encryption", and wpa_supplicant is now using that as the default value.
755 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
756 # interoperate with PEAPv1; see eap_testing.txt for more details.
757 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
758 # tunneled EAP-Success. This is required with some RADIUS servers that
759 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
760 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
761 # include_tls_length=1 can be used to force wpa_supplicant to include
762 # TLS Message Length field in all TLS messages even if they are not
764 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
765 # challenges (by default, it accepts 2 or 3)
766 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
767 # protected result indication.
768 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
770 # * 0 = do not use cryptobinding (default)
771 # * 1 = use cryptobinding if server supports it
772 # * 2 = require cryptobinding
773 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
775 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
776 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
777 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
779 # TLS-based methods can use the following parameters to control TLS behavior
780 # (these are normally in the phase1 parameter, but can be used also in the
781 # phase2 parameter when EAP-TLS is used within the inner tunnel):
782 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
783 # TLS library, these may be disabled by default to enforce stronger
785 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
786 # the TLS library to accept certificates even if they are not currently
787 # valid, i.e., have expired or have not yet become valid; this should be
788 # used only for testing purposes)
789 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
790 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
791 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
792 # as a workaround for broken authentication server implementations unless
793 # EAP workarounds are disabled with eap_workarounds=0.
794 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
795 # default value to be used automatically).
797 # Following certificate/private key fields are used in inner Phase2
798 # authentication when using EAP-TTLS or EAP-PEAP.
799 # ca_cert2: File path to CA certificate file. This file can have one or more
800 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
801 # server certificate will not be verified. This is insecure and a trusted
802 # CA certificate should always be configured.
803 # ca_path2: Directory path for CA certificate files (PEM)
804 # client_cert2: File path to client certificate file
805 # private_key2: File path to client private key file
806 # private_key2_passwd: Password for private key file
807 # dh_file2: File path to DH/DSA parameters file (in PEM format)
808 # subject_match2: Substring to be matched against the subject of the
809 # authentication server certificate.
810 # altsubject_match2: Substring to be matched against the alternative subject
811 # name of the authentication server certificate.
813 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
814 # This value limits the fragment size for EAP methods that support
815 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
816 # small enough to make the EAP messages fit in MTU of the network
817 # interface used for EAPOL. The default value is suitable for most
820 # ocsp: Whether to use/require OCSP to check server certificate
821 # 0 = do not use OCSP stapling (TLS certificate status extension)
822 # 1 = try to use OCSP stapling, but not require response
823 # 2 = require valid OCSP stapling response
825 # EAP-FAST variables:
826 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
827 # to create this file and write updates to it when PAC is being
828 # provisioned or refreshed. Full path to the file should be used since
829 # working directory may change when wpa_supplicant is run in the
830 # background. Alternatively, a named configuration blob can be used by
831 # setting this to blob://<blob name>
832 # phase1: fast_provisioning option can be used to enable in-line provisioning
833 # of EAP-FAST credentials (PAC):
835 # 1 = allow unauthenticated provisioning,
836 # 2 = allow authenticated provisioning,
837 # 3 = allow both unauthenticated and authenticated provisioning
838 # fast_max_pac_list_len=<num> option can be used to set the maximum
839 # number of PAC entries to store in a PAC list (default: 10)
840 # fast_pac_format=binary option can be used to select binary format for
841 # storing PAC entries in order to save some space (the default
842 # text format uses about 2.5 times the size of minimal binary
845 # wpa_supplicant supports number of "EAP workarounds" to work around
846 # interoperability issues with incorrectly behaving authentication servers.
847 # These are enabled by default because some of the issues are present in large
848 # number of authentication servers. Strict EAP conformance mode can be
849 # configured by disabling workarounds with eap_workaround=0.
851 # Station inactivity limit
853 # If a station does not send anything in ap_max_inactivity seconds, an
854 # empty data frame is sent to it in order to verify whether it is
855 # still in range. If this frame is not ACKed, the station will be
856 # disassociated and then deauthenticated. This feature is used to
857 # clear station table of old entries when the STAs move out of the
860 # The station can associate again with the AP if it is still in range;
861 # this inactivity poll is just used as a nicer way of verifying
862 # inactivity; i.e., client will not report broken connection because
863 # disassociation frame is not sent immediately without first polling
864 # the STA with a data frame.
865 # default: 300 (i.e., 5 minutes)
866 #ap_max_inactivity=300
868 # DTIM period in Beacon intervals for AP mode (default: 2)
871 # Beacon interval (default: 100 TU)
874 # disable_ht: Whether HT (802.11n) should be disabled.
875 # 0 = HT enabled (if AP supports it)
878 # disable_ht40: Whether HT-40 (802.11n) should be disabled.
879 # 0 = HT-40 enabled (if AP supports it)
882 # disable_sgi: Whether SGI (short guard interval) should be disabled.
883 # 0 = SGI enabled (if AP supports it)
886 # ht_mcs: Configure allowed MCS rates.
887 # Parsed as an array of bytes, in base-16 (ascii-hex)
888 # ht_mcs="" // Use all available (default)
889 # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
890 # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
892 # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
893 # -1 = Do not make any changes.
894 # 0 = Enable MAX-AMSDU if hardware supports it.
897 # ampdu_density: Allow overriding AMPDU density configuration.
898 # Treated as hint by the kernel.
899 # -1 = Do not make any changes.
900 # 0-3 = Set AMPDU density (aka factor) to specified value.
902 # disable_vht: Whether VHT should be disabled.
903 # 0 = VHT enabled (if AP supports it)
906 # vht_capa: VHT capabilities to set in the override
907 # vht_capa_mask: mask of VHT capabilities
909 # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
910 # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
918 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
921 psk="very secret passphrase"
925 # Same as previous, but request SSID-specific scanning (for APs that reject
930 psk="very secret passphrase"
934 # Only WPA-PSK is used. Any valid cipher combination is accepted.
940 group=CCMP TKIP WEP104 WEP40
941 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
945 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
952 psk="not so secure passphrase"
956 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
957 # or WEP40 as the group cipher will not be accepted.
965 identity="user@example.com"
966 ca_cert="/etc/cert/ca.pem"
967 client_cert="/etc/cert/user.pem"
968 private_key="/etc/cert/user.prv"
969 private_key_passwd="password"
973 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
979 identity="user@example.com"
981 ca_cert="/etc/cert/ca.pem"
983 phase2="auth=MSCHAPV2"
987 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
988 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
993 identity="user@example.com"
994 anonymous_identity="anonymous@example.com"
996 ca_cert="/etc/cert/ca.pem"
1000 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1001 # use. Real identity is sent only within an encrypted TLS tunnel.
1006 identity="user@example.com"
1007 anonymous_identity="anonymous@example.com"
1009 ca_cert="/etc/cert/ca.pem"
1010 phase2="auth=MSCHAPV2"
1013 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1019 # Phase1 / outer authentication
1020 anonymous_identity="anonymous@example.com"
1021 ca_cert="/etc/cert/ca.pem"
1022 # Phase 2 / inner authentication
1023 phase2="autheap=TLS"
1024 ca_cert2="/etc/cert/ca2.pem"
1025 client_cert2="/etc/cer/user.pem"
1026 private_key2="/etc/cer/user.prv"
1027 private_key2_passwd="password"
1031 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1035 bssid=00:11:22:33:44:55
1037 key_mgmt=WPA-PSK WPA-EAP
1040 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1043 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1044 # and all valid ciphers.
1047 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1051 # EAP-SIM with a GSM SIM or USIM
1066 anonymous_identity="eap_psk_user"
1067 password=06b4be19da289f475aa46a33cb793029
1068 identity="eap_psk_user@example.com"
1072 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1073 # EAP-TLS for authentication and key generation; require both unicast and
1074 # broadcast WEP keys.
1079 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"
1088 # LEAP with dynamic WEP keys
1097 # EAP-IKEv2 using shared secrets for both server and peer authentication
1099 ssid="ikev2-example"
1106 # EAP-FAST with WPA (WPA or WPA2)
1108 ssid="eap-fast-test"
1111 anonymous_identity="FAST-000102030405"
1114 phase1="fast_provisioning=1"
1115 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1119 ssid="eap-fast-test"
1122 anonymous_identity="FAST-000102030405"
1125 phase1="fast_provisioning=1"
1126 pac_file="blob://eap-fast-pac"
1129 # Plaintext connection (no WPA, no IEEE 802.1X)
1131 ssid="plaintext-test"
1136 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1138 ssid="static-wep-test"
1142 wep_key2="1234567890123"
1148 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1149 # IEEE 802.11 authentication
1151 ssid="static-wep-test2"
1155 wep_key2="1234567890123"
1162 # IBSS/ad-hoc network with WPA-None/TKIP.
1171 psk="secret passphrase"
1175 # Catch all example that allows more or less all configuration modes
1179 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1181 group=CCMP TKIP WEP104 WEP40
1182 psk="very secret passphrase"
1184 identity="user@example.com"
1186 ca_cert="/etc/cert/ca.pem"
1187 client_cert="/etc/cert/user.pem"
1188 private_key="/etc/cert/user.prv"
1189 private_key_passwd="password"
1190 phase1="peaplabel=0"
1193 # Example of EAP-TLS with smartcard (openssl engine)
1201 identity="user@example.com"
1202 ca_cert="/etc/cert/ca.pem"
1203 client_cert="/etc/cert/user.pem"
1207 # The engine configured here must be available. Look at
1208 # OpenSSL engine support in the global section.
1209 # The key available through the engine must be the private key
1210 # matching the client certificate configured above.
1212 # use the opensc engine
1216 # use the pkcs11 engine
1220 # Optional PIN configuration; this can be left out and PIN will be
1221 # asked through the control interface
1225 # Example configuration showing how to use an inlined blob as a CA certificate
1226 # data instead of using external file
1231 identity="user@example.com"
1232 anonymous_identity="anonymous@example.com"
1234 ca_cert="blob://exampleblob"
1238 blob-base64-exampleblob={
1239 SGVsbG8gV29ybGQhCg==
1243 # Wildcard match for SSID (plaintext APs only). This example select any
1244 # open AP regardless of its SSID.
1250 # Example config file that will only scan on channel 36.