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
84 # Note: When using MACsec, eapol_version shall be set to 3, which is
85 # defined in IEEE Std 802.1X-2010.
88 # AP scanning/selection
89 # By default, wpa_supplicant requests driver to perform AP scanning and then
90 # uses the scan results to select a suitable AP. Another alternative is to
91 # allow the driver to take care of AP scanning and selection and use
92 # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
93 # information from the driver.
94 # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
95 # the currently enabled networks are found, a new network (IBSS or AP mode
96 # operation) may be initialized (if configured) (default)
97 # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
98 # parameters (e.g., WPA IE generation); this mode can also be used with
99 # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
100 # APs (i.e., external program needs to control association). This mode must
101 # also be used when using wired Ethernet drivers.
102 # Note: macsec_qca driver is one type of Ethernet driver which implements
104 # 2: like 0, but associate with APs using security policy and SSID (but not
105 # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
106 # enable operation with hidden SSIDs and optimized roaming; in this mode,
107 # the network blocks in the configuration file are tried one by one until
108 # the driver reports successful association; each network block should have
109 # explicit security policy (i.e., only one option in the lists) for
110 # key_mgmt, pairwise, group, proto variables
111 # Note: ap_scan=2 should not be used with the nl80211 driver interface (the
112 # current Linux interface). ap_scan=1 is optimized work working with nl80211.
113 # For finding networks using hidden SSID, scan_ssid=1 in the network block can
114 # be used with nl80211.
115 # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
116 # created immediately regardless of scan results. ap_scan=1 mode will first try
117 # to scan for existing networks and only if no matches with the enabled
118 # networks are found, a new IBSS or AP mode network is created.
121 # Whether to force passive scan for network connection
123 # By default, scans will send out Probe Request frames on channels that allow
124 # active scanning. This advertise the local station to the world. Normally this
125 # is fine, but users may wish to do passive scanning where the radio should only
126 # listen quietly for Beacon frames and not send any Probe Request frames. Actual
127 # functionality may be driver dependent.
129 # This parameter can be used to force only passive scanning to be used
130 # for network connection cases. It should be noted that this will slow
131 # down scan operations and reduce likelihood of finding the AP. In
132 # addition, some use cases will override this due to functional
133 # requirements, e.g., for finding an AP that uses hidden SSID
134 # (scan_ssid=1) or P2P device discovery.
136 # 0: Do normal scans (allow active scans) (default)
137 # 1: Do passive scans.
141 # By default, wpa_supplicant implements the mesh peering manager (MPM) for an
142 # open mesh. However, if the driver can implement the MPM, you may set this to
143 # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
145 # 0: MPM lives in the driver
146 # 1: wpa_supplicant provides an MPM which handles peering (default)
149 # Maximum number of peer links (0-255; default: 99)
150 # Maximum number of mesh peering currently maintained by the STA.
153 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
155 # This timeout value is used in mesh STA to clean up inactive stations.
156 #mesh_max_inactivity=300
158 # cert_in_cb - Whether to include a peer certificate dump in events
159 # This controls whether peer certificates for authentication server and
160 # its certificate chain are included in EAP peer certificate events. This is
161 # enabled by default.
164 # EAP fast re-authentication
165 # By default, fast re-authentication is enabled for all EAP methods that
166 # support it. This variable can be used to disable fast re-authentication.
167 # Normally, there is no need to disable this.
170 # OpenSSL Engine support
171 # These options can be used to load OpenSSL engines.
172 # The two engines that are supported currently are shown below:
173 # They are both from the opensc project (http://www.opensc.org/)
174 # By default no engines are loaded.
175 # make the opensc engine available
176 #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
177 # make the pkcs11 engine available
178 #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
179 # configure the path to the pkcs11 module required by the pkcs11 engine
180 #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
182 # OpenSSL cipher string
184 # This is an OpenSSL specific configuration option for configuring the default
185 # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
186 # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
187 # on cipher suite configuration. This is applicable only if wpa_supplicant is
188 # built to use OpenSSL.
189 #openssl_ciphers=DEFAULT:!EXP:!LOW
192 # Dynamic EAP methods
193 # If EAP methods were built dynamically as shared object files, they need to be
194 # loaded here before being used in the network blocks. By default, EAP methods
195 # are included statically in the build, so these lines are not needed
196 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
197 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
199 # Driver interface parameters
200 # This field can be used to configure arbitrary driver interace parameters. The
201 # format is specific to the selected driver interface. This field is not used
203 #driver_param="field=value"
206 # The ISO/IEC alpha2 country code for the country in which this device is
207 # currently operating.
210 # Maximum lifetime for PMKSA in seconds; default 43200
211 #dot11RSNAConfigPMKLifetime=43200
212 # Threshold for reauthentication (percentage of PMK lifetime); default 70
213 #dot11RSNAConfigPMKReauthThreshold=70
214 # Timeout for security association negotiation in seconds; default 60
215 #dot11RSNAConfigSATimeout=60
217 # Wi-Fi Protected Setup (WPS) parameters
219 # Universally Unique IDentifier (UUID; see RFC 4122) of the device
220 # If not configured, UUID will be generated based on the local MAC address.
221 #uuid=12345678-9abc-def0-1234-56789abcdef0
224 # User-friendly description of device; up to 32 octets encoded in UTF-8
225 #device_name=Wireless Client
228 # The manufacturer of the device (up to 64 ASCII characters)
229 #manufacturer=Company
232 # Model of the device (up to 32 ASCII characters)
236 # Additional device description (up to 32 ASCII characters)
240 # Serial number of the device (up to 32 characters)
243 # Primary Device Type
244 # Used format: <categ>-<OUI>-<subcateg>
245 # categ = Category as an integer value
246 # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
248 # subcateg = OUI-specific Sub Category as an integer value
250 # 1-0050F204-1 (Computer / PC)
251 # 1-0050F204-2 (Computer / Server)
252 # 5-0050F204-1 (Storage / NAS)
253 # 6-0050F204-1 (Network Infrastructure / AP)
254 #device_type=1-0050F204-1
257 # 4-octet operating system version number (hex string)
261 # List of the supported configuration methods
262 # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
263 # nfc_interface push_button keypad virtual_display physical_display
264 # virtual_push_button physical_push_button
266 #config_methods=label display push_button keypad
268 #config_methods=label virtual_display virtual_push_button keypad
270 # Credential processing
271 # 0 = process received credentials internally (default)
272 # 1 = do not process received credentials; just pass them over ctrl_iface to
273 # external program(s)
274 # 2 = process received credentials internally and pass them over ctrl_iface
275 # to external program(s)
276 #wps_cred_processing=0
278 # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
279 # The vendor attribute contents to be added in M1 (hex string)
280 #wps_vendor_ext_m1=000137100100020001
282 # NFC password token for WPS
283 # These parameters can be used to configure a fixed NFC password token for the
284 # station. This can be generated, e.g., with nfc_pw_token. When these
285 # parameters are used, the station is assumed to be deployed with a NFC tag
286 # that includes the matching NFC password token (e.g., written based on the
287 # NDEF record from nfc_pw_token).
289 #wps_nfc_dev_pw_id: Device Password ID (16..65535)
290 #wps_nfc_dh_pubkey: Hexdump of DH Public Key
291 #wps_nfc_dh_privkey: Hexdump of DH Private Key
292 #wps_nfc_dev_pw: Hexdump of Device Password
294 # Priority for the networks added through WPS
295 # This priority value will be set to each network profile that is added
296 # by executing the WPS protocol.
299 # Maximum number of BSS entries to keep in memory
301 # This can be used to limit memory use on the BSS entries (cached scan
302 # results). A larger value may be needed in environments that have huge number
303 # of APs when using ap_scan=1 mode.
307 # This is an optional set of parameters for automatic scanning
308 # within an interface in following format:
309 #autoscan=<autoscan module name>:<module parameters>
310 # autoscan is like bgscan but on disconnected or inactive state.
311 # For instance, on exponential module parameters would be <base>:<limit>
312 #autoscan=exponential:3:300
313 # Which means a delay between scans on a base exponential of 3,
314 # up to the limit of 300 seconds (3, 9, 27 ... 300)
315 # For periodic module, parameters would be <fixed interval>
316 #autoscan=periodic:30
317 # So a delay of 30 seconds will be applied between each scan.
318 # Note: If sched_scan_plans are configured and supported by the driver,
319 # autoscan is ignored.
321 # filter_ssids - SSID-based scan result filtering
322 # 0 = do not filter scan results (default)
323 # 1 = only include configured SSIDs in scan results/BSS table
326 # Password (and passphrase, etc.) backend for external storage
327 # format: <backend name>[:<optional backend parameters>]
328 #ext_password_backend=test:pw1=password|pw2=testing
331 # Disable P2P functionality
334 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
336 # This timeout value is used in P2P GO mode to clean up
338 #p2p_go_max_inactivity=300
340 # Passphrase length (8..63) for P2P GO
342 # This parameter controls the length of the random passphrase that is
343 # generated at the GO. Default: 8.
344 #p2p_passphrase_len=8
346 # Extra delay between concurrent P2P search iterations
348 # This value adds extra delay in milliseconds between concurrent search
349 # iterations to make p2p_find friendlier to concurrent operations by avoiding
350 # it from taking 100% of radio resources. The default value is 500 ms.
351 #p2p_search_delay=500
353 # Opportunistic Key Caching (also known as Proactive Key Caching) default
354 # This parameter can be used to set the default behavior for the
355 # proactive_key_caching parameter. By default, OKC is disabled unless enabled
356 # with the global okc=1 parameter or with the per-network
357 # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
358 # can be disabled with per-network proactive_key_caching=0 parameter.
361 # Protected Management Frames default
362 # This parameter can be used to set the default behavior for the ieee80211w
363 # parameter for RSN networks. By default, PMF is disabled unless enabled with
364 # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
365 # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
366 # per-network ieee80211w parameter. This global default value does not apply
367 # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
371 # Enabled SAE finite cyclic groups in preference order
372 # By default (if this parameter is not set), the mandatory group 19 (ECC group
373 # defined over a 256-bit prime order field) is preferred, but other groups are
374 # also enabled. If this parameter is set, the groups will be tried in the
375 # indicated order. The group values are listed in the IANA registry:
376 # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
377 #sae_groups=21 20 19 26 25
379 # Default value for DTIM period (if not overridden in network block)
382 # Default value for Beacon interval (if not overridden in network block)
385 # Additional vendor specific elements for Beacon and Probe Response frames
386 # This parameter can be used to add additional vendor specific element(s) into
387 # the end of the Beacon and Probe Response frames. The format for these
388 # element(s) is a hexdump of the raw information elements (id+len+payload for
389 # one or more elements). This is used in AP and P2P GO modes.
390 #ap_vendor_elements=dd0411223301
392 # Ignore scan results older than request
394 # The driver may have a cache of scan results that makes it return
395 # information that is older than our scan trigger. This parameter can
396 # be used to configure such old information to be ignored instead of
397 # allowing it to update the internal BSS table.
398 #ignore_old_scan_res=0
400 # scan_cur_freq: Whether to scan only the current frequency
401 # 0: Scan all available frequencies. (Default)
402 # 1: Scan current operating frequency if another VIF on the same radio
403 # is already associated.
405 # MAC address policy default
406 # 0 = use permanent MAC address
407 # 1 = use random MAC address for each ESS connection
408 # 2 = like 1, but maintain OUI (with local admin bit set)
410 # By default, permanent MAC address is used unless policy is changed by
411 # the per-network mac_addr parameter. Global mac_addr=1 can be used to
412 # change this default behavior.
415 # Lifetime of random MAC address in seconds (default: 60)
416 #rand_addr_lifetime=60
418 # MAC address policy for pre-association operations (scanning, ANQP)
419 # 0 = use permanent MAC address
420 # 1 = use random MAC address
421 # 2 = like 1, but maintain OUI (with local admin bit set)
424 # Interworking (IEEE 802.11u)
426 # Enable Interworking
429 # Homogenous ESS identifier
430 # If this is set, scans will be used to request response only from BSSes
431 # belonging to the specified Homogeneous ESS. This is used only if interworking
433 # hessid=00:11:22:33:44:55
435 # Automatic network selection behavior
436 # 0 = do not automatically go through Interworking network selection
437 # (i.e., require explicit interworking_select command for this; default)
438 # 1 = perform Interworking network selection if one or more
439 # credentials have been configured and scan did not find a
440 # matching network block
443 # GAS Address3 field behavior
444 # 0 = P2P specification (Address3 = AP BSSID); default
445 # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
446 # sent to not-associated AP; if associated, AP BSSID)
451 # Each credential used for automatic network selection is configured as a set
452 # of parameters that are compared to the information advertised by the APs when
453 # interworking_select and interworking_connect commands are used.
457 # temporary: Whether this credential is temporary and not to be saved
459 # priority: Priority group
460 # By default, all networks and credentials get the same priority group
461 # (0). This field can be used to give higher priority for credentials
462 # (and similarly in struct wpa_ssid for network blocks) to change the
463 # Interworking automatic networking selection behavior. The matching
464 # network (based on either an enabled network block or a credential)
465 # with the highest priority value will be selected.
467 # pcsc: Use PC/SC and SIM/USIM card
469 # realm: Home Realm for Interworking
471 # username: Username for Interworking network selection
473 # password: Password for Interworking network selection
475 # ca_cert: CA certificate for Interworking network selection
477 # client_cert: File path to client certificate file (PEM/DER)
478 # This field is used with Interworking networking selection for a case
479 # where client certificate/private key is used for authentication
480 # (EAP-TLS). Full path to the file should be used since working
481 # directory may change when wpa_supplicant is run in the background.
483 # Alternatively, a named configuration blob can be used by setting
484 # this to blob://blob_name.
486 # private_key: File path to client private key file (PEM/DER/PFX)
487 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
488 # commented out. Both the private key and certificate will be read
489 # from the PKCS#12 file in this case. Full path to the file should be
490 # used since working directory may change when wpa_supplicant is run
493 # Windows certificate store can be used by leaving client_cert out and
494 # configuring private_key in one of the following formats:
496 # cert://substring_to_match
498 # hash://certificate_thumbprint_in_hex
500 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
502 # Note that when running wpa_supplicant as an application, the user
503 # certificate store (My user account) is used, whereas computer store
504 # (Computer account) is used when running wpasvc as a service.
506 # Alternatively, a named configuration blob can be used by setting
507 # this to blob://blob_name.
509 # private_key_passwd: Password for private key file
511 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
513 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
516 # domain: Home service provider FQDN(s)
517 # This is used to compare against the Domain Name List to figure out
518 # whether the AP is operated by the Home SP. Multiple domain entries can
519 # be used to configure alternative FQDNs that will be considered home
522 # roaming_consortium: Roaming Consortium OI
523 # If roaming_consortium_len is non-zero, this field contains the
524 # Roaming Consortium OI that can be used to determine which access
525 # points support authentication with this credential. This is an
526 # alternative to the use of the realm parameter. When using Roaming
527 # Consortium to match the network, the EAP parameters need to be
528 # pre-configured with the credential since the NAI Realm information
529 # may not be available or fetched.
531 # eap: Pre-configured EAP method
532 # This optional field can be used to specify which EAP method will be
533 # used with this credential. If not set, the EAP method is selected
534 # automatically based on ANQP information (e.g., NAI Realm).
536 # phase1: Pre-configure Phase 1 (outer authentication) parameters
537 # This optional field is used with like the 'eap' parameter.
539 # phase2: Pre-configure Phase 2 (inner authentication) parameters
540 # This optional field is used with like the 'eap' parameter.
542 # excluded_ssid: Excluded SSID
543 # This optional field can be used to excluded specific SSID(s) from
544 # matching with the network. Multiple entries can be used to specify more
547 # roaming_partner: Roaming partner information
548 # This optional field can be used to configure preferences between roaming
549 # partners. The field is a string in following format:
550 # <FQDN>,<0/1 exact match>,<priority>,<* or country code>
551 # (non-exact match means any subdomain matches the entry; priority is in
552 # 0..255 range with 0 being the highest priority)
554 # update_identifier: PPS MO ID
555 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
557 # provisioning_sp: FQDN of the SP that provisioned the credential
558 # This optional field can be used to keep track of the SP that provisioned
559 # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
561 # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
562 # These fields can be used to specify minimum download/upload backhaul
563 # bandwidth that is preferred for the credential. This constraint is
564 # ignored if the AP does not advertise WAN Metrics information or if the
565 # limit would prevent any connection. Values are in kilobits per second.
566 # min_dl_bandwidth_home
567 # min_ul_bandwidth_home
568 # min_dl_bandwidth_roaming
569 # min_ul_bandwidth_roaming
571 # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
572 # (PPS/<X+>/Policy/MaximumBSSLoadValue)
573 # This value is used as the maximum channel utilization for network
574 # selection purposes for home networks. If the AP does not advertise
575 # BSS Load or if the limit would prevent any connection, this constraint
578 # req_conn_capab: Required connection capability
579 # (PPS/<X+>/Policy/RequiredProtoPortTuple)
580 # This value is used to configure set of required protocol/port pairs that
581 # a roaming network shall support (include explicitly in Connection
582 # Capability ANQP element). This constraint is ignored if the AP does not
583 # advertise Connection Capability or if this constraint would prevent any
584 # network connection. This policy is not used in home networks.
585 # Format: <protocol>[:<comma-separated list of ports]
586 # Multiple entries can be used to list multiple requirements.
587 # For example, number of common TCP protocols:
588 # req_conn_capab=6,22,80,443
589 # For example, IPSec/IKE:
590 # req_conn_capab=17:500
593 # ocsp: Whether to use/require OCSP to check server certificate
594 # 0 = do not use OCSP stapling (TLS certificate status extension)
595 # 1 = try to use OCSP stapling, but not require response
596 # 2 = require valid OCSP stapling response
597 # 3 = require valid OCSP stapling response for all not-trusted
598 # certificates in the server certificate chain
600 # sim_num: Identifier for which SIM to use in multi-SIM devices
605 # realm="example.com"
606 # username="user@example.com"
607 # password="password"
608 # ca_cert="/etc/wpa_supplicant/ca.pem"
609 # domain="example.com"
613 # imsi="310026-000000000"
614 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
618 # realm="example.com"
620 # password="password"
621 # ca_cert="/etc/wpa_supplicant/ca.pem"
622 # domain="example.com"
623 # roaming_consortium=223344
625 # phase2="auth=MSCHAPV2"
631 # Scheduled scan plans
633 # A space delimited list of scan plans. Each scan plan specifies the scan
634 # interval and number of iterations, delimited by a colon. The last scan plan
635 # will run infinitely and thus must specify only the interval and not the number
638 # The driver advertises the maximum number of scan plans supported. If more scan
639 # plans than supported are configured, only the first ones are set (up to the
640 # maximum supported). The last scan plan that specifies only the interval is
641 # always set as the last plan.
643 # If the scan interval or the number of iterations for a scan plan exceeds the
644 # maximum supported, it will be set to the maximum supported value.
647 # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
650 # sched_scan_plans=10:100 20:200 30
652 # Multi Band Operation (MBO) non-preferred channels
653 # A space delimited list of non-preferred channels where each channel is a colon
654 # delimited list of values. Reason detail is optional.
656 # non_pref_chan=<oper_class>:<chan>:<preference>:<reason>[:reason_detail]
658 # non_pref_chan="81:5:10:2:0 81:1:0:2:0 81:9:0:2"
660 # MBO Cellular Data Capabilities
661 # 1 = Cellular data connection available
662 # 2 = Cellular data connection not available
663 # 3 = Not cellular capable (default)
668 # Each network (usually AP's sharing the same SSID) is configured as a separate
669 # block in this configuration file. The network blocks are in preference order
670 # (the first match is used).
672 # network block fields:
675 # 0 = this network can be used (default)
676 # 1 = this network block is disabled (can be enabled through ctrl_iface,
677 # e.g., with wpa_cli or wpa_gui)
679 # id_str: Network identifier string for external scripts. This value is passed
680 # to external action script through wpa_cli as WPA_ID_STR environment
681 # variable to make it easier to do network specific configuration.
683 # ssid: SSID (mandatory); network name in one of the optional formats:
684 # - an ASCII string with double quotation
685 # - a hex string (two characters per octet of SSID)
686 # - a printf-escaped ASCII string P"<escaped string>"
689 # 0 = do not scan this SSID with specific Probe Request frames (default)
690 # 1 = scan with SSID-specific Probe Request frames (this can be used to
691 # find APs that do not accept broadcast SSID or use multiple SSIDs;
692 # this will add latency to scanning, so enable this only when needed)
694 # bssid: BSSID (optional); if set, this network block is used only when
695 # associating with the AP using the configured BSSID
697 # priority: priority group (integer)
698 # By default, all networks will get same priority group (0). If some of the
699 # networks are more desirable, this field can be used to change the order in
700 # which wpa_supplicant goes through the networks when selecting a BSS. The
701 # priority groups will be iterated in decreasing priority (i.e., the larger the
702 # priority value, the sooner the network is matched against the scan results).
703 # Within each priority group, networks will be selected based on security
704 # policy, signal strength, etc.
705 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
706 # using this priority to select the order for scanning. Instead, they try the
707 # networks in the order that used in the configuration file.
709 # mode: IEEE 802.11 operation mode
710 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
711 # 1 = IBSS (ad-hoc, peer-to-peer)
712 # 2 = AP (access point)
713 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
714 # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
715 # TKIP/CCMP) is available for backwards compatibility, but its use is
716 # deprecated. WPA-None requires following network block options:
717 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
718 # both), and psk must also be set.
720 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
721 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
722 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
723 # In addition, this value is only used by the station that creates the IBSS. If
724 # an IBSS network with the configured SSID is already present, the frequency of
725 # the network will be used instead of this configured value.
727 # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
728 # 0 = do not use PBSS
730 # 2 = don't care (not allowed in AP mode)
731 # Used together with mode configuration. When mode is AP, it means to start a
732 # PCP instead of a regular AP. When mode is infrastructure it means connect
733 # to a PCP instead of AP. In this mode you can also specify 2 (don't care)
734 # which means connect to either PCP or AP.
735 # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
736 # For more details, see IEEE Std 802.11ad-2012.
738 # scan_freq: List of frequencies to scan
739 # Space-separated list of frequencies in MHz to scan when searching for this
740 # BSS. If the subset of channels used by the network is known, this option can
741 # be used to optimize scanning to not occur on channels that the network does
742 # not use. Example: scan_freq=2412 2437 2462
744 # freq_list: Array of allowed frequencies
745 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
746 # set, scan results that do not match any of the specified frequencies are not
747 # considered when selecting a BSS.
749 # This can also be set on the outside of the network block. In this case,
750 # it limits the frequencies that will be scanned.
752 # bgscan: Background scanning
753 # wpa_supplicant behavior for background scanning can be specified by
754 # configuring a bgscan module. These modules are responsible for requesting
755 # background scans for the purpose of roaming within an ESS (i.e., within a
756 # single network block with all the APs using the same SSID). The bgscan
757 # parameter uses following format: "<bgscan module name>:<module parameters>"
758 # Following bgscan modules are available:
759 # simple - Periodic background scans based on signal strength
760 # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
762 # bgscan="simple:30:-45:300"
763 # learn - Learn channels used by the network and try to avoid bgscans on other
764 # channels (experimental)
765 # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
766 # <long interval>[:<database file name>]"
767 # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
768 # Explicitly disable bgscan by setting
771 # This option can also be set outside of all network blocks for the bgscan
772 # parameter to apply for all the networks that have no specific bgscan
775 # proto: list of accepted protocols
776 # WPA = WPA/IEEE 802.11i/D3.0
777 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
778 # If not set, this defaults to: WPA RSN
780 # key_mgmt: list of accepted authenticated key management protocols
781 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
782 # WPA-EAP = WPA using EAP authentication
783 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
785 # NONE = WPA is not used; plaintext or static WEP could be used
786 # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
788 # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
789 # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
790 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
791 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
792 # SAE = Simultaneous authentication of equals; pre-shared key/password -based
793 # authentication with stronger security than WPA-PSK especially when using
794 # not that strong password
795 # FT-SAE = SAE with FT
796 # WPA-EAP-SUITE-B = Suite B 128-bit level
797 # WPA-EAP-SUITE-B-192 = Suite B 192-bit level
798 # OSEN = Hotspot 2.0 Rel 2 online signup connection
799 # If not set, this defaults to: WPA-PSK WPA-EAP
801 # ieee80211w: whether management frame protection is enabled
802 # 0 = disabled (default unless changed with the global pmf parameter)
805 # The most common configuration options for this based on the PMF (protected
806 # management frames) certification program are:
807 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
808 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
809 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
811 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
812 # OPEN = Open System authentication (required for WPA/WPA2)
813 # SHARED = Shared Key authentication (requires static WEP keys)
814 # LEAP = LEAP/Network EAP (only used with LEAP)
815 # If not set, automatic selection is used (Open System with LEAP enabled if
816 # LEAP is allowed as one of the EAP methods).
818 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
819 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
820 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
821 # NONE = Use only Group Keys (deprecated, should not be included if APs support
823 # If not set, this defaults to: CCMP TKIP
825 # group: list of accepted group (broadcast/multicast) ciphers for WPA
826 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
827 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
828 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
829 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
830 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
832 # psk: WPA preshared key; 256-bit pre-shared key
833 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
834 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
835 # generated using the passphrase and SSID). ASCII passphrase must be between
836 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
837 # be used to indicate that the PSK/passphrase is stored in external storage.
838 # This field is not needed, if WPA-EAP is used.
839 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
840 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
841 # startup and reconfiguration time can be optimized by generating the PSK only
842 # only when the passphrase or SSID has actually changed.
844 # mem_only_psk: Whether to keep PSK/passphrase only in memory
845 # 0 = allow psk/passphrase to be stored to the configuration file
846 # 1 = do not store psk/passphrase to the configuration file
849 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
850 # Dynamic WEP key required for non-WPA mode
851 # bit0 (1): require dynamically generated unicast WEP key
852 # bit1 (2): require dynamically generated broadcast WEP key
853 # (3 = require both keys; default)
854 # Note: When using wired authentication (including macsec_qca driver),
855 # eapol_flags must be set to 0 for the authentication to be completed
858 # macsec_policy: IEEE 802.1X/MACsec options
859 # This determines how sessions are secured with MACsec. It is currently
860 # applicable only when using the macsec_qca driver interface.
861 # 0: MACsec not in use (default)
862 # 1: MACsec enabled - Should secure, accept key server's advice to
863 # determine whether to use a secure session or not.
865 # mixed_cell: This option can be used to configure whether so called mixed
866 # cells, i.e., networks that use both plaintext and encryption in the same
867 # SSID, are allowed when selecting a BSS from scan results.
868 # 0 = disabled (default)
871 # proactive_key_caching:
872 # Enable/disable opportunistic PMKSA caching for WPA2.
873 # 0 = disabled (default unless changed with the global okc parameter)
876 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
877 # hex without quotation, e.g., 0102030405)
878 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
880 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
881 # allowed. This is only used with RSN/WPA2.
882 # 0 = disabled (default)
886 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
887 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
889 # Following fields are only used with internal EAP implementation.
890 # eap: space-separated list of accepted EAP methods
891 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
892 # cannot be used with WPA; to be used as a Phase 2 method
893 # with EAP-PEAP or EAP-TTLS)
894 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
895 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
896 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
897 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
898 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
899 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
900 # TLS = EAP-TLS (client and server certificate)
901 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
902 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
904 # If not set, all compiled in methods are allowed.
906 # identity: Identity string for EAP
907 # This field is also used to configure user NAI for
908 # EAP-PSK/PAX/SAKE/GPSK.
909 # anonymous_identity: Anonymous identity string for EAP (to be used as the
910 # unencrypted identity with EAP types that support different tunnelled
911 # identity, e.g., EAP-TTLS). This field can also be used with
912 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
913 # password: Password string for EAP. This field can include either the
914 # plaintext password (using ASCII or hex string) or a NtPasswordHash
915 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
916 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
917 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
918 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
919 # PSK) is also configured using this field. For EAP-GPSK, this is a
920 # variable length PSK. ext:<name of external password field> format can
921 # be used to indicate that the password is stored in external storage.
922 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
923 # or more trusted CA certificates. If ca_cert and ca_path are not
924 # included, server certificate will not be verified. This is insecure and
925 # a trusted CA certificate should always be configured when using
926 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
927 # change when wpa_supplicant is run in the background.
929 # Alternatively, this can be used to only perform matching of the server
930 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
931 # this case, the possible CA certificates in the server certificate chain
932 # are ignored and only the server certificate is verified. This is
933 # configured with the following format:
934 # hash:://server/sha256/cert_hash_in_hex
935 # For example: "hash://server/sha256/
936 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
938 # On Windows, trusted CA certificates can be loaded from the system
939 # certificate store by setting this to cert_store://<name>, e.g.,
940 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
941 # Note that when running wpa_supplicant as an application, the user
942 # certificate store (My user account) is used, whereas computer store
943 # (Computer account) is used when running wpasvc as a service.
944 # ca_path: Directory path for CA certificate files (PEM). This path may
945 # contain multiple CA certificates in OpenSSL format. Common use for this
946 # is to point to system trusted CA list which is often installed into
947 # directory like /etc/ssl/certs. If configured, these certificates are
948 # added to the list of trusted CAs. ca_cert may also be included in that
949 # case, but it is not required.
950 # client_cert: File path to client certificate file (PEM/DER)
951 # Full path should be used since working directory may change when
952 # wpa_supplicant is run in the background.
953 # Alternatively, a named configuration blob can be used by setting this
954 # to blob://<blob name>.
955 # private_key: File path to client private key file (PEM/DER/PFX)
956 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
957 # commented out. Both the private key and certificate will be read from
958 # the PKCS#12 file in this case. Full path should be used since working
959 # directory may change when wpa_supplicant is run in the background.
960 # Windows certificate store can be used by leaving client_cert out and
961 # configuring private_key in one of the following formats:
962 # cert://substring_to_match
963 # hash://certificate_thumbprint_in_hex
964 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
965 # Note that when running wpa_supplicant as an application, the user
966 # certificate store (My user account) is used, whereas computer store
967 # (Computer account) is used when running wpasvc as a service.
968 # Alternatively, a named configuration blob can be used by setting this
969 # to blob://<blob name>.
970 # private_key_passwd: Password for private key file (if left out, this will be
971 # asked through control interface)
972 # dh_file: File path to DH/DSA parameters file (in PEM format)
973 # This is an optional configuration file for setting parameters for an
974 # ephemeral DH key exchange. In most cases, the default RSA
975 # authentication does not use this configuration. However, it is possible
976 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
977 # DSA keys always use ephemeral DH keys. This can be used to achieve
978 # forward secrecy. If the file is in DSA parameters format, it will be
979 # automatically converted into DH params.
980 # subject_match: Substring to be matched against the subject of the
981 # authentication server certificate. If this string is set, the server
982 # sertificate is only accepted if it contains this string in the subject.
983 # The subject string is in following format:
984 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
985 # Note: Since this is a substring match, this cannot be used securily to
986 # do a suffix match against a possible domain name in the CN entry. For
987 # such a use case, domain_suffix_match or domain_match should be used
989 # altsubject_match: Semicolon separated string of entries to be matched against
990 # the alternative subject name of the authentication server certificate.
991 # If this string is set, the server sertificate is only accepted if it
992 # contains one of the entries in an alternative subject name extension.
993 # altSubjectName string is in following format: TYPE:VALUE
994 # Example: EMAIL:server@example.com
995 # Example: DNS:server.example.com;DNS:server2.example.com
996 # Following types are supported: EMAIL, DNS, URI
997 # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
998 # used as a suffix match requirement for the AAAserver certificate in
999 # SubjectAltName dNSName element(s). If a matching dNSName is found, this
1000 # constraint is met. If no dNSName values are present, this constraint is
1001 # matched against SubjectName CN using same suffix match comparison.
1003 # Suffix match here means that the host/domain name is compared one label
1004 # at a time starting from the top-level domain and all the labels in
1005 # domain_suffix_match shall be included in the certificate. The
1006 # certificate may include additional sub-level labels in addition to the
1009 # For example, domain_suffix_match=example.com would match
1010 # test.example.com but would not match test-example.com.
1011 # domain_match: Constraint for server domain name
1012 # If set, this FQDN is used as a full match requirement for the
1013 # server certificate in SubjectAltName dNSName element(s). If a
1014 # matching dNSName is found, this constraint is met. If no dNSName
1015 # values are present, this constraint is matched against SubjectName CN
1016 # using same full match comparison. This behavior is similar to
1017 # domain_suffix_match, but has the requirement of a full match, i.e.,
1018 # no subdomains or wildcard matches are allowed. Case-insensitive
1019 # comparison is used, so "Example.com" matches "example.com", but would
1020 # not match "test.Example.com".
1021 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1022 # (string with field-value pairs, e.g., "peapver=0" or
1023 # "peapver=1 peaplabel=1")
1024 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
1025 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1026 # to be used during key derivation when PEAPv1 or newer. Most existing
1027 # PEAPv1 implementation seem to be using the old label, "client EAP
1028 # encryption", and wpa_supplicant is now using that as the default value.
1029 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1030 # interoperate with PEAPv1; see eap_testing.txt for more details.
1031 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
1032 # tunneled EAP-Success. This is required with some RADIUS servers that
1033 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1034 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1035 # include_tls_length=1 can be used to force wpa_supplicant to include
1036 # TLS Message Length field in all TLS messages even if they are not
1038 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1039 # challenges (by default, it accepts 2 or 3)
1040 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1041 # protected result indication.
1042 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1044 # * 0 = do not use cryptobinding (default)
1045 # * 1 = use cryptobinding if server supports it
1046 # * 2 = require cryptobinding
1047 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
1050 # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1051 # used to configure a mode that allows EAP-Success (and EAP-Failure)
1052 # without going through authentication step. Some switches use such
1053 # sequence when forcing the port to be authorized/unauthorized or as a
1054 # fallback option if the authentication server is unreachable. By default,
1055 # wpa_supplicant discards such frames to protect against potential attacks
1056 # by rogue devices, but this option can be used to disable that protection
1057 # for cases where the server/authenticator does not need to be
1059 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
1060 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
1061 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1062 # used to disable MSCHAPv2 password retry in authentication failure cases.
1064 # TLS-based methods can use the following parameters to control TLS behavior
1065 # (these are normally in the phase1 parameter, but can be used also in the
1066 # phase2 parameter when EAP-TLS is used within the inner tunnel):
1067 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1068 # TLS library, these may be disabled by default to enforce stronger
1070 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
1071 # the TLS library to accept certificates even if they are not currently
1072 # valid, i.e., have expired or have not yet become valid; this should be
1073 # used only for testing purposes)
1074 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1075 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1076 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1077 # as a workaround for broken authentication server implementations unless
1078 # EAP workarounds are disabled with eap_workaround=0.
1079 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
1080 # default value to be used automatically).
1081 # tls_disable_tlsv1_0=1 - disable use of TLSv1.0
1082 # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1083 # that have issues interoperating with updated TLS version)
1084 # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1085 # that have issues interoperating with updated TLS version)
1086 # tls_ext_cert_check=0 - No external server certificate validation (default)
1087 # tls_ext_cert_check=1 - External server certificate validation enabled; this
1088 # requires an external program doing validation of server certificate
1089 # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1090 # interface and report the result of the validation with
1091 # CTRL-RSP_EXT_CERT_CHECK.
1093 # Following certificate/private key fields are used in inner Phase2
1094 # authentication when using EAP-TTLS or EAP-PEAP.
1095 # ca_cert2: File path to CA certificate file. This file can have one or more
1096 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1097 # server certificate will not be verified. This is insecure and a trusted
1098 # CA certificate should always be configured.
1099 # ca_path2: Directory path for CA certificate files (PEM)
1100 # client_cert2: File path to client certificate file
1101 # private_key2: File path to client private key file
1102 # private_key2_passwd: Password for private key file
1103 # dh_file2: File path to DH/DSA parameters file (in PEM format)
1104 # subject_match2: Substring to be matched against the subject of the
1105 # authentication server certificate. See subject_match for more details.
1106 # altsubject_match2: Semicolon separated string of entries to be matched
1107 # against the alternative subject name of the authentication server
1108 # certificate. See altsubject_match documentation for more details.
1109 # domain_suffix_match2: Constraint for server domain name. See
1110 # domain_suffix_match for more details.
1112 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
1113 # This value limits the fragment size for EAP methods that support
1114 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1115 # small enough to make the EAP messages fit in MTU of the network
1116 # interface used for EAPOL. The default value is suitable for most
1119 # ocsp: Whether to use/require OCSP to check server certificate
1120 # 0 = do not use OCSP stapling (TLS certificate status extension)
1121 # 1 = try to use OCSP stapling, but not require response
1122 # 2 = require valid OCSP stapling response
1123 # 3 = require valid OCSP stapling response for all not-trusted
1124 # certificates in the server certificate chain
1126 # openssl_ciphers: OpenSSL specific cipher configuration
1127 # This can be used to override the global openssl_ciphers configuration
1128 # parameter (see above).
1130 # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1132 # EAP-FAST variables:
1133 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1134 # to create this file and write updates to it when PAC is being
1135 # provisioned or refreshed. Full path to the file should be used since
1136 # working directory may change when wpa_supplicant is run in the
1137 # background. Alternatively, a named configuration blob can be used by
1138 # setting this to blob://<blob name>
1139 # phase1: fast_provisioning option can be used to enable in-line provisioning
1140 # of EAP-FAST credentials (PAC):
1142 # 1 = allow unauthenticated provisioning,
1143 # 2 = allow authenticated provisioning,
1144 # 3 = allow both unauthenticated and authenticated provisioning
1145 # fast_max_pac_list_len=<num> option can be used to set the maximum
1146 # number of PAC entries to store in a PAC list (default: 10)
1147 # fast_pac_format=binary option can be used to select binary format for
1148 # storing PAC entries in order to save some space (the default
1149 # text format uses about 2.5 times the size of minimal binary
1152 # wpa_supplicant supports number of "EAP workarounds" to work around
1153 # interoperability issues with incorrectly behaving authentication servers.
1154 # These are enabled by default because some of the issues are present in large
1155 # number of authentication servers. Strict EAP conformance mode can be
1156 # configured by disabling workarounds with eap_workaround=0.
1158 # update_identifier: PPS MO ID
1159 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1161 # Station inactivity limit
1163 # If a station does not send anything in ap_max_inactivity seconds, an
1164 # empty data frame is sent to it in order to verify whether it is
1165 # still in range. If this frame is not ACKed, the station will be
1166 # disassociated and then deauthenticated. This feature is used to
1167 # clear station table of old entries when the STAs move out of the
1170 # The station can associate again with the AP if it is still in range;
1171 # this inactivity poll is just used as a nicer way of verifying
1172 # inactivity; i.e., client will not report broken connection because
1173 # disassociation frame is not sent immediately without first polling
1174 # the STA with a data frame.
1175 # default: 300 (i.e., 5 minutes)
1176 #ap_max_inactivity=300
1178 # DTIM period in Beacon intervals for AP mode (default: 2)
1181 # Beacon interval (default: 100 TU)
1185 # 0 = WPS enabled and configured (default)
1189 # MAC address policy
1190 # 0 = use permanent MAC address
1191 # 1 = use random MAC address for each ESS connection
1192 # 2 = like 1, but maintain OUI (with local admin bit set)
1195 # disable_ht: Whether HT (802.11n) should be disabled.
1196 # 0 = HT enabled (if AP supports it)
1199 # disable_ht40: Whether HT-40 (802.11n) should be disabled.
1200 # 0 = HT-40 enabled (if AP supports it)
1201 # 1 = HT-40 disabled
1203 # disable_sgi: Whether SGI (short guard interval) should be disabled.
1204 # 0 = SGI enabled (if AP supports it)
1207 # disable_ldpc: Whether LDPC should be disabled.
1208 # 0 = LDPC enabled (if AP supports it)
1211 # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1212 # 0 = 40 MHz tolerant (default)
1213 # 1 = 40 MHz intolerant
1215 # ht_mcs: Configure allowed MCS rates.
1216 # Parsed as an array of bytes, in base-16 (ascii-hex)
1217 # ht_mcs="" // Use all available (default)
1218 # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1219 # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1221 # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1222 # -1 = Do not make any changes.
1223 # 0 = Enable MAX-AMSDU if hardware supports it.
1226 # ampdu_factor: Maximum A-MPDU Length Exponent
1227 # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1229 # ampdu_density: Allow overriding AMPDU density configuration.
1230 # Treated as hint by the kernel.
1231 # -1 = Do not make any changes.
1232 # 0-3 = Set AMPDU density (aka factor) to specified value.
1234 # disable_vht: Whether VHT should be disabled.
1235 # 0 = VHT enabled (if AP supports it)
1238 # vht_capa: VHT capabilities to set in the override
1239 # vht_capa_mask: mask of VHT capabilities
1241 # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1242 # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1248 ##### Fast Session Transfer (FST) support #####################################
1250 # The options in this section are only available when the build configuration
1251 # option CONFIG_FST is set while compiling hostapd. They allow this interface
1252 # to be a part of FST setup.
1254 # FST is the transfer of a session from a channel to another channel, in the
1255 # same or different frequency bands.
1257 # For detals, see IEEE Std 802.11ad-2012.
1259 # Identifier of an FST Group the interface belongs to.
1262 # Interface priority within the FST Group.
1263 # Announcing a higher priority for an interface means declaring it more
1264 # preferable for FST switch.
1265 # fst_priority is in 1..255 range with 1 being the lowest priority.
1268 # Default LLT value for this interface in milliseconds. The value used in case
1269 # no value provided during session setup. Default is 50 msec.
1270 # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1271 # Transitioning between states).
1276 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1279 psk="very secret passphrase"
1283 # Same as previous, but request SSID-specific scanning (for APs that reject
1288 psk="very secret passphrase"
1292 # Only WPA-PSK is used. Any valid cipher combination is accepted.
1298 group=CCMP TKIP WEP104 WEP40
1299 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1303 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1310 psk="not so secure passphrase"
1314 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1315 # or WEP40 as the group cipher will not be accepted.
1323 identity="user@example.com"
1324 ca_cert="/etc/cert/ca.pem"
1325 client_cert="/etc/cert/user.pem"
1326 private_key="/etc/cert/user.prv"
1327 private_key_passwd="password"
1331 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1337 identity="user@example.com"
1339 ca_cert="/etc/cert/ca.pem"
1340 phase1="peaplabel=1"
1341 phase2="auth=MSCHAPV2"
1345 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1346 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1351 identity="user@example.com"
1352 anonymous_identity="anonymous@example.com"
1354 ca_cert="/etc/cert/ca.pem"
1358 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1359 # use. Real identity is sent only within an encrypted TLS tunnel.
1364 identity="user@example.com"
1365 anonymous_identity="anonymous@example.com"
1367 ca_cert="/etc/cert/ca.pem"
1368 phase2="auth=MSCHAPV2"
1371 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1377 # Phase1 / outer authentication
1378 anonymous_identity="anonymous@example.com"
1379 ca_cert="/etc/cert/ca.pem"
1380 # Phase 2 / inner authentication
1381 phase2="autheap=TLS"
1382 ca_cert2="/etc/cert/ca2.pem"
1383 client_cert2="/etc/cer/user.pem"
1384 private_key2="/etc/cer/user.prv"
1385 private_key2_passwd="password"
1389 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1393 bssid=00:11:22:33:44:55
1395 key_mgmt=WPA-PSK WPA-EAP
1398 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1401 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1402 # and all valid ciphers.
1405 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1409 # EAP-SIM with a GSM SIM or USIM
1424 anonymous_identity="eap_psk_user"
1425 password=06b4be19da289f475aa46a33cb793029
1426 identity="eap_psk_user@example.com"
1430 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1431 # EAP-TLS for authentication and key generation; require both unicast and
1432 # broadcast WEP keys.
1437 identity="user@example.com"
1438 ca_cert="/etc/cert/ca.pem"
1439 client_cert="/etc/cert/user.pem"
1440 private_key="/etc/cert/user.prv"
1441 private_key_passwd="password"
1446 # LEAP with dynamic WEP keys
1455 # EAP-IKEv2 using shared secrets for both server and peer authentication
1457 ssid="ikev2-example"
1464 # EAP-FAST with WPA (WPA or WPA2)
1466 ssid="eap-fast-test"
1469 anonymous_identity="FAST-000102030405"
1472 phase1="fast_provisioning=1"
1473 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1477 ssid="eap-fast-test"
1480 anonymous_identity="FAST-000102030405"
1483 phase1="fast_provisioning=1"
1484 pac_file="blob://eap-fast-pac"
1487 # Plaintext connection (no WPA, no IEEE 802.1X)
1489 ssid="plaintext-test"
1494 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1496 ssid="static-wep-test"
1500 wep_key2="1234567890123"
1506 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1507 # IEEE 802.11 authentication
1509 ssid="static-wep-test2"
1513 wep_key2="1234567890123"
1520 # IBSS/ad-hoc network with RSN
1532 # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
1541 psk="secret passphrase"
1552 # secure (SAE + AMPE) network
1558 psk="very secret passphrase"
1562 # Catch all example that allows more or less all configuration modes
1566 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1568 group=CCMP TKIP WEP104 WEP40
1569 psk="very secret passphrase"
1571 identity="user@example.com"
1573 ca_cert="/etc/cert/ca.pem"
1574 client_cert="/etc/cert/user.pem"
1575 private_key="/etc/cert/user.prv"
1576 private_key_passwd="password"
1577 phase1="peaplabel=0"
1580 # Example of EAP-TLS with smartcard (openssl engine)
1588 identity="user@example.com"
1589 ca_cert="/etc/cert/ca.pem"
1590 client_cert="/etc/cert/user.pem"
1594 # The engine configured here must be available. Look at
1595 # OpenSSL engine support in the global section.
1596 # The key available through the engine must be the private key
1597 # matching the client certificate configured above.
1599 # use the opensc engine
1603 # use the pkcs11 engine
1607 # Optional PIN configuration; this can be left out and PIN will be
1608 # asked through the control interface
1612 # Example configuration showing how to use an inlined blob as a CA certificate
1613 # data instead of using external file
1618 identity="user@example.com"
1619 anonymous_identity="anonymous@example.com"
1621 ca_cert="blob://exampleblob"
1625 blob-base64-exampleblob={
1626 SGVsbG8gV29ybGQhCg==
1630 # Wildcard match for SSID (plaintext APs only). This example select any
1631 # open AP regardless of its SSID.
1636 # Example configuration blacklisting two APs - these will be ignored
1640 psk="very secret passphrase"
1641 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1644 # Example configuration limiting AP selection to a specific set of APs;
1645 # any other AP not matching the masked address will be ignored.
1648 psk="very secret passphrase"
1649 bssid_whitelist=02:55:ae:bc:00:00/ff:ff:ff:ff:00:00 00:00:77:66:55:44/00:00:ff:ff:ff:ff
1652 # Example config file that will only scan on channel 36.
1659 # Example MACsec configuration
1661 # key_mgmt=IEEE8021X
1664 # anonymous_identity="anonymous@example.com"
1665 # identity="user@example.com"
1666 # password="secretr"
1667 # ca_cert="/etc/cert/ca.pem"