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
445 # Each credential used for automatic network selection is configured as a set
446 # of parameters that are compared to the information advertised by the APs when
447 # interworking_select and interworking_connect commands are used.
451 # temporary: Whether this credential is temporary and not to be saved
453 # priority: Priority group
454 # By default, all networks and credentials get the same priority group
455 # (0). This field can be used to give higher priority for credentials
456 # (and similarly in struct wpa_ssid for network blocks) to change the
457 # Interworking automatic networking selection behavior. The matching
458 # network (based on either an enabled network block or a credential)
459 # with the highest priority value will be selected.
461 # pcsc: Use PC/SC and SIM/USIM card
463 # realm: Home Realm for Interworking
465 # username: Username for Interworking network selection
467 # password: Password for Interworking network selection
469 # ca_cert: CA certificate for Interworking network selection
471 # client_cert: File path to client certificate file (PEM/DER)
472 # This field is used with Interworking networking selection for a case
473 # where client certificate/private key is used for authentication
474 # (EAP-TLS). Full path to the file should be used since working
475 # directory may change when wpa_supplicant is run in the background.
477 # Alternatively, a named configuration blob can be used by setting
478 # this to blob://blob_name.
480 # private_key: File path to client private key file (PEM/DER/PFX)
481 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
482 # commented out. Both the private key and certificate will be read
483 # from the PKCS#12 file in this case. Full path to the file should be
484 # used since working directory may change when wpa_supplicant is run
487 # Windows certificate store can be used by leaving client_cert out and
488 # configuring private_key in one of the following formats:
490 # cert://substring_to_match
492 # hash://certificate_thumbprint_in_hex
494 # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
496 # Note that when running wpa_supplicant as an application, the user
497 # certificate store (My user account) is used, whereas computer store
498 # (Computer account) is used when running wpasvc as a service.
500 # Alternatively, a named configuration blob can be used by setting
501 # this to blob://blob_name.
503 # private_key_passwd: Password for private key file
505 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
507 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
510 # domain: Home service provider FQDN(s)
511 # This is used to compare against the Domain Name List to figure out
512 # whether the AP is operated by the Home SP. Multiple domain entries can
513 # be used to configure alternative FQDNs that will be considered home
516 # roaming_consortium: Roaming Consortium OI
517 # If roaming_consortium_len is non-zero, this field contains the
518 # Roaming Consortium OI that can be used to determine which access
519 # points support authentication with this credential. This is an
520 # alternative to the use of the realm parameter. When using Roaming
521 # Consortium to match the network, the EAP parameters need to be
522 # pre-configured with the credential since the NAI Realm information
523 # may not be available or fetched.
525 # eap: Pre-configured EAP method
526 # This optional field can be used to specify which EAP method will be
527 # used with this credential. If not set, the EAP method is selected
528 # automatically based on ANQP information (e.g., NAI Realm).
530 # phase1: Pre-configure Phase 1 (outer authentication) parameters
531 # This optional field is used with like the 'eap' parameter.
533 # phase2: Pre-configure Phase 2 (inner authentication) parameters
534 # This optional field is used with like the 'eap' parameter.
536 # excluded_ssid: Excluded SSID
537 # This optional field can be used to excluded specific SSID(s) from
538 # matching with the network. Multiple entries can be used to specify more
541 # roaming_partner: Roaming partner information
542 # This optional field can be used to configure preferences between roaming
543 # partners. The field is a string in following format:
544 # <FQDN>,<0/1 exact match>,<priority>,<* or country code>
545 # (non-exact match means any subdomain matches the entry; priority is in
546 # 0..255 range with 0 being the highest priority)
548 # update_identifier: PPS MO ID
549 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
551 # provisioning_sp: FQDN of the SP that provisioned the credential
552 # This optional field can be used to keep track of the SP that provisioned
553 # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
555 # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
556 # These fields can be used to specify minimum download/upload backhaul
557 # bandwidth that is preferred for the credential. This constraint is
558 # ignored if the AP does not advertise WAN Metrics information or if the
559 # limit would prevent any connection. Values are in kilobits per second.
560 # min_dl_bandwidth_home
561 # min_ul_bandwidth_home
562 # min_dl_bandwidth_roaming
563 # min_ul_bandwidth_roaming
565 # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
566 # (PPS/<X+>/Policy/MaximumBSSLoadValue)
567 # This value is used as the maximum channel utilization for network
568 # selection purposes for home networks. If the AP does not advertise
569 # BSS Load or if the limit would prevent any connection, this constraint
572 # req_conn_capab: Required connection capability
573 # (PPS/<X+>/Policy/RequiredProtoPortTuple)
574 # This value is used to configure set of required protocol/port pairs that
575 # a roaming network shall support (include explicitly in Connection
576 # Capability ANQP element). This constraint is ignored if the AP does not
577 # advertise Connection Capability or if this constraint would prevent any
578 # network connection. This policy is not used in home networks.
579 # Format: <protocol>[:<comma-separated list of ports]
580 # Multiple entries can be used to list multiple requirements.
581 # For example, number of common TCP protocols:
582 # req_conn_capab=6,22,80,443
583 # For example, IPSec/IKE:
584 # req_conn_capab=17:500
587 # ocsp: Whether to use/require OCSP to check server certificate
588 # 0 = do not use OCSP stapling (TLS certificate status extension)
589 # 1 = try to use OCSP stapling, but not require response
590 # 2 = require valid OCSP stapling response
591 # 3 = require valid OCSP stapling response for all not-trusted
592 # certificates in the server certificate chain
594 # sim_num: Identifier for which SIM to use in multi-SIM devices
599 # realm="example.com"
600 # username="user@example.com"
601 # password="password"
602 # ca_cert="/etc/wpa_supplicant/ca.pem"
603 # domain="example.com"
607 # imsi="310026-000000000"
608 # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
612 # realm="example.com"
614 # password="password"
615 # ca_cert="/etc/wpa_supplicant/ca.pem"
616 # domain="example.com"
617 # roaming_consortium=223344
619 # phase2="auth=MSCHAPV2"
625 # Scheduled scan plans
627 # A space delimited list of scan plans. Each scan plan specifies the scan
628 # interval and number of iterations, delimited by a colon. The last scan plan
629 # will run infinitely and thus must specify only the interval and not the number
632 # The driver advertises the maximum number of scan plans supported. If more scan
633 # plans than supported are configured, only the first ones are set (up to the
634 # maximum supported). The last scan plan that specifies only the interval is
635 # always set as the last plan.
637 # If the scan interval or the number of iterations for a scan plan exceeds the
638 # maximum supported, it will be set to the maximum supported value.
641 # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
644 # sched_scan_plans=10:100 20:200 30
646 # Multi Band Operation (MBO) non-preferred channels
647 # A space delimited list of non-preferred channels where each channel is a colon
648 # delimited list of values. Reason detail is optional.
650 # non_pref_chan=<oper_class>:<chan>:<preference>:<reason>[:reason_detail]
652 # non_pref_chan="81:5:10:2:0 81:1:0:2:0 81:9:0:2"
654 # MBO Cellular Data Capabilities
655 # 1 = Cellular data connection available
656 # 2 = Cellular data connection not available
657 # 3 = Not cellular capable (default)
662 # Each network (usually AP's sharing the same SSID) is configured as a separate
663 # block in this configuration file. The network blocks are in preference order
664 # (the first match is used).
666 # network block fields:
669 # 0 = this network can be used (default)
670 # 1 = this network block is disabled (can be enabled through ctrl_iface,
671 # e.g., with wpa_cli or wpa_gui)
673 # id_str: Network identifier string for external scripts. This value is passed
674 # to external action script through wpa_cli as WPA_ID_STR environment
675 # variable to make it easier to do network specific configuration.
677 # ssid: SSID (mandatory); network name in one of the optional formats:
678 # - an ASCII string with double quotation
679 # - a hex string (two characters per octet of SSID)
680 # - a printf-escaped ASCII string P"<escaped string>"
683 # 0 = do not scan this SSID with specific Probe Request frames (default)
684 # 1 = scan with SSID-specific Probe Request frames (this can be used to
685 # find APs that do not accept broadcast SSID or use multiple SSIDs;
686 # this will add latency to scanning, so enable this only when needed)
688 # bssid: BSSID (optional); if set, this network block is used only when
689 # associating with the AP using the configured BSSID
691 # priority: priority group (integer)
692 # By default, all networks will get same priority group (0). If some of the
693 # networks are more desirable, this field can be used to change the order in
694 # which wpa_supplicant goes through the networks when selecting a BSS. The
695 # priority groups will be iterated in decreasing priority (i.e., the larger the
696 # priority value, the sooner the network is matched against the scan results).
697 # Within each priority group, networks will be selected based on security
698 # policy, signal strength, etc.
699 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
700 # using this priority to select the order for scanning. Instead, they try the
701 # networks in the order that used in the configuration file.
703 # mode: IEEE 802.11 operation mode
704 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
705 # 1 = IBSS (ad-hoc, peer-to-peer)
706 # 2 = AP (access point)
707 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
708 # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
709 # TKIP/CCMP) is available for backwards compatibility, but its use is
710 # deprecated. WPA-None requires following network block options:
711 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
712 # both), and psk must also be set.
714 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
715 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
716 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
717 # In addition, this value is only used by the station that creates the IBSS. If
718 # an IBSS network with the configured SSID is already present, the frequency of
719 # the network will be used instead of this configured value.
721 # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
722 # 0 = do not use PBSS
724 # 2 = don't care (not allowed in AP mode)
725 # Used together with mode configuration. When mode is AP, it means to start a
726 # PCP instead of a regular AP. When mode is infrastructure it means connect
727 # to a PCP instead of AP. In this mode you can also specify 2 (don't care)
728 # which means connect to either PCP or AP.
729 # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
730 # For more details, see IEEE Std 802.11ad-2012.
732 # scan_freq: List of frequencies to scan
733 # Space-separated list of frequencies in MHz to scan when searching for this
734 # BSS. If the subset of channels used by the network is known, this option can
735 # be used to optimize scanning to not occur on channels that the network does
736 # not use. Example: scan_freq=2412 2437 2462
738 # freq_list: Array of allowed frequencies
739 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
740 # set, scan results that do not match any of the specified frequencies are not
741 # considered when selecting a BSS.
743 # This can also be set on the outside of the network block. In this case,
744 # it limits the frequencies that will be scanned.
746 # bgscan: Background scanning
747 # wpa_supplicant behavior for background scanning can be specified by
748 # configuring a bgscan module. These modules are responsible for requesting
749 # background scans for the purpose of roaming within an ESS (i.e., within a
750 # single network block with all the APs using the same SSID). The bgscan
751 # parameter uses following format: "<bgscan module name>:<module parameters>"
752 # Following bgscan modules are available:
753 # simple - Periodic background scans based on signal strength
754 # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
756 # bgscan="simple:30:-45:300"
757 # learn - Learn channels used by the network and try to avoid bgscans on other
758 # channels (experimental)
759 # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
760 # <long interval>[:<database file name>]"
761 # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
762 # Explicitly disable bgscan by setting
765 # This option can also be set outside of all network blocks for the bgscan
766 # parameter to apply for all the networks that have no specific bgscan
769 # proto: list of accepted protocols
770 # WPA = WPA/IEEE 802.11i/D3.0
771 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
772 # If not set, this defaults to: WPA RSN
774 # key_mgmt: list of accepted authenticated key management protocols
775 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
776 # WPA-EAP = WPA using EAP authentication
777 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
779 # NONE = WPA is not used; plaintext or static WEP could be used
780 # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
782 # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
783 # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
784 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
785 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
786 # SAE = Simultaneous authentication of equals; pre-shared key/password -based
787 # authentication with stronger security than WPA-PSK especially when using
788 # not that strong password
789 # FT-SAE = SAE with FT
790 # WPA-EAP-SUITE-B = Suite B 128-bit level
791 # WPA-EAP-SUITE-B-192 = Suite B 192-bit level
792 # OSEN = Hotspot 2.0 Rel 2 online signup connection
793 # If not set, this defaults to: WPA-PSK WPA-EAP
795 # ieee80211w: whether management frame protection is enabled
796 # 0 = disabled (default unless changed with the global pmf parameter)
799 # The most common configuration options for this based on the PMF (protected
800 # management frames) certification program are:
801 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
802 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
803 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
805 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
806 # OPEN = Open System authentication (required for WPA/WPA2)
807 # SHARED = Shared Key authentication (requires static WEP keys)
808 # LEAP = LEAP/Network EAP (only used with LEAP)
809 # If not set, automatic selection is used (Open System with LEAP enabled if
810 # LEAP is allowed as one of the EAP methods).
812 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
813 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
814 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
815 # NONE = Use only Group Keys (deprecated, should not be included if APs support
817 # If not set, this defaults to: CCMP TKIP
819 # group: list of accepted group (broadcast/multicast) ciphers for WPA
820 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
821 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
822 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
823 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
824 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
826 # psk: WPA preshared key; 256-bit pre-shared key
827 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
828 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
829 # generated using the passphrase and SSID). ASCII passphrase must be between
830 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
831 # be used to indicate that the PSK/passphrase is stored in external storage.
832 # This field is not needed, if WPA-EAP is used.
833 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
834 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
835 # startup and reconfiguration time can be optimized by generating the PSK only
836 # only when the passphrase or SSID has actually changed.
838 # mem_only_psk: Whether to keep PSK/passphrase only in memory
839 # 0 = allow psk/passphrase to be stored to the configuration file
840 # 1 = do not store psk/passphrase to the configuration file
843 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
844 # Dynamic WEP key required for non-WPA mode
845 # bit0 (1): require dynamically generated unicast WEP key
846 # bit1 (2): require dynamically generated broadcast WEP key
847 # (3 = require both keys; default)
848 # Note: When using wired authentication (including macsec_qca driver),
849 # eapol_flags must be set to 0 for the authentication to be completed
852 # macsec_policy: IEEE 802.1X/MACsec options
853 # This determines how sessions are secured with MACsec. It is currently
854 # applicable only when using the macsec_qca driver interface.
855 # 0: MACsec not in use (default)
856 # 1: MACsec enabled - Should secure, accept key server's advice to
857 # determine whether to use a secure session or not.
859 # mixed_cell: This option can be used to configure whether so called mixed
860 # cells, i.e., networks that use both plaintext and encryption in the same
861 # SSID, are allowed when selecting a BSS from scan results.
862 # 0 = disabled (default)
865 # proactive_key_caching:
866 # Enable/disable opportunistic PMKSA caching for WPA2.
867 # 0 = disabled (default unless changed with the global okc parameter)
870 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
871 # hex without quotation, e.g., 0102030405)
872 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
874 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
875 # allowed. This is only used with RSN/WPA2.
876 # 0 = disabled (default)
880 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
881 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
883 # Following fields are only used with internal EAP implementation.
884 # eap: space-separated list of accepted EAP methods
885 # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
886 # cannot be used with WPA; to be used as a Phase 2 method
887 # with EAP-PEAP or EAP-TTLS)
888 # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
889 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
890 # OTP = EAP-OTP (cannot be used separately with WPA; to be used
891 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
892 # GTC = EAP-GTC (cannot be used separately with WPA; to be used
893 # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
894 # TLS = EAP-TLS (client and server certificate)
895 # PEAP = EAP-PEAP (with tunnelled EAP authentication)
896 # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
898 # If not set, all compiled in methods are allowed.
900 # identity: Identity string for EAP
901 # This field is also used to configure user NAI for
902 # EAP-PSK/PAX/SAKE/GPSK.
903 # anonymous_identity: Anonymous identity string for EAP (to be used as the
904 # unencrypted identity with EAP types that support different tunnelled
905 # identity, e.g., EAP-TTLS). This field can also be used with
906 # EAP-SIM/AKA/AKA' to store the pseudonym identity.
907 # password: Password string for EAP. This field can include either the
908 # plaintext password (using ASCII or hex string) or a NtPasswordHash
909 # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
910 # NtPasswordHash can only be used when the password is for MSCHAPv2 or
911 # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
912 # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
913 # PSK) is also configured using this field. For EAP-GPSK, this is a
914 # variable length PSK. ext:<name of external password field> format can
915 # be used to indicate that the password is stored in external storage.
916 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
917 # or more trusted CA certificates. If ca_cert and ca_path are not
918 # included, server certificate will not be verified. This is insecure and
919 # a trusted CA certificate should always be configured when using
920 # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
921 # change when wpa_supplicant is run in the background.
923 # Alternatively, this can be used to only perform matching of the server
924 # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
925 # this case, the possible CA certificates in the server certificate chain
926 # are ignored and only the server certificate is verified. This is
927 # configured with the following format:
928 # hash:://server/sha256/cert_hash_in_hex
929 # For example: "hash://server/sha256/
930 # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
932 # On Windows, trusted CA certificates can be loaded from the system
933 # certificate store by setting this to cert_store://<name>, e.g.,
934 # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
935 # Note that when running wpa_supplicant as an application, the user
936 # certificate store (My user account) is used, whereas computer store
937 # (Computer account) is used when running wpasvc as a service.
938 # ca_path: Directory path for CA certificate files (PEM). This path may
939 # contain multiple CA certificates in OpenSSL format. Common use for this
940 # is to point to system trusted CA list which is often installed into
941 # directory like /etc/ssl/certs. If configured, these certificates are
942 # added to the list of trusted CAs. ca_cert may also be included in that
943 # case, but it is not required.
944 # client_cert: File path to client certificate file (PEM/DER)
945 # Full path should be used since working directory may change when
946 # wpa_supplicant is run in the background.
947 # Alternatively, a named configuration blob can be used by setting this
948 # to blob://<blob name>.
949 # private_key: File path to client private key file (PEM/DER/PFX)
950 # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
951 # commented out. Both the private key and certificate will be read from
952 # the PKCS#12 file in this case. Full path should be used since working
953 # directory may change when wpa_supplicant is run in the background.
954 # Windows certificate store can be used by leaving client_cert out and
955 # configuring private_key in one of the following formats:
956 # cert://substring_to_match
957 # hash://certificate_thumbprint_in_hex
958 # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
959 # Note that when running wpa_supplicant as an application, the user
960 # certificate store (My user account) is used, whereas computer store
961 # (Computer account) is used when running wpasvc as a service.
962 # Alternatively, a named configuration blob can be used by setting this
963 # to blob://<blob name>.
964 # private_key_passwd: Password for private key file (if left out, this will be
965 # asked through control interface)
966 # dh_file: File path to DH/DSA parameters file (in PEM format)
967 # This is an optional configuration file for setting parameters for an
968 # ephemeral DH key exchange. In most cases, the default RSA
969 # authentication does not use this configuration. However, it is possible
970 # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
971 # DSA keys always use ephemeral DH keys. This can be used to achieve
972 # forward secrecy. If the file is in DSA parameters format, it will be
973 # automatically converted into DH params.
974 # subject_match: Substring to be matched against the subject of the
975 # authentication server certificate. If this string is set, the server
976 # sertificate is only accepted if it contains this string in the subject.
977 # The subject string is in following format:
978 # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
979 # Note: Since this is a substring match, this cannot be used securily to
980 # do a suffix match against a possible domain name in the CN entry. For
981 # such a use case, domain_suffix_match or domain_match should be used
983 # altsubject_match: Semicolon separated string of entries to be matched against
984 # the alternative subject name of the authentication server certificate.
985 # If this string is set, the server sertificate is only accepted if it
986 # contains one of the entries in an alternative subject name extension.
987 # altSubjectName string is in following format: TYPE:VALUE
988 # Example: EMAIL:server@example.com
989 # Example: DNS:server.example.com;DNS:server2.example.com
990 # Following types are supported: EMAIL, DNS, URI
991 # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
992 # used as a suffix match requirement for the AAAserver certificate in
993 # SubjectAltName dNSName element(s). If a matching dNSName is found, this
994 # constraint is met. If no dNSName values are present, this constraint is
995 # matched against SubjectName CN using same suffix match comparison.
997 # Suffix match here means that the host/domain name is compared one label
998 # at a time starting from the top-level domain and all the labels in
999 # domain_suffix_match shall be included in the certificate. The
1000 # certificate may include additional sub-level labels in addition to the
1003 # For example, domain_suffix_match=example.com would match
1004 # test.example.com but would not match test-example.com.
1005 # domain_match: Constraint for server domain name
1006 # If set, this FQDN is used as a full match requirement for the
1007 # server certificate in SubjectAltName dNSName element(s). If a
1008 # matching dNSName is found, this constraint is met. If no dNSName
1009 # values are present, this constraint is matched against SubjectName CN
1010 # using same full match comparison. This behavior is similar to
1011 # domain_suffix_match, but has the requirement of a full match, i.e.,
1012 # no subdomains or wildcard matches are allowed. Case-insensitive
1013 # comparison is used, so "Example.com" matches "example.com", but would
1014 # not match "test.Example.com".
1015 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1016 # (string with field-value pairs, e.g., "peapver=0" or
1017 # "peapver=1 peaplabel=1")
1018 # 'peapver' can be used to force which PEAP version (0 or 1) is used.
1019 # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1020 # to be used during key derivation when PEAPv1 or newer. Most existing
1021 # PEAPv1 implementation seem to be using the old label, "client EAP
1022 # encryption", and wpa_supplicant is now using that as the default value.
1023 # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1024 # interoperate with PEAPv1; see eap_testing.txt for more details.
1025 # 'peap_outer_success=0' can be used to terminate PEAP authentication on
1026 # tunneled EAP-Success. This is required with some RADIUS servers that
1027 # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1028 # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1029 # include_tls_length=1 can be used to force wpa_supplicant to include
1030 # TLS Message Length field in all TLS messages even if they are not
1032 # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1033 # challenges (by default, it accepts 2 or 3)
1034 # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1035 # protected result indication.
1036 # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1038 # * 0 = do not use cryptobinding (default)
1039 # * 1 = use cryptobinding if server supports it
1040 # * 2 = require cryptobinding
1041 # EAP-WSC (WPS) uses following options: pin=<Device Password> or
1044 # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1045 # used to configure a mode that allows EAP-Success (and EAP-Failure)
1046 # without going through authentication step. Some switches use such
1047 # sequence when forcing the port to be authorized/unauthorized or as a
1048 # fallback option if the authentication server is unreachable. By default,
1049 # wpa_supplicant discards such frames to protect against potential attacks
1050 # by rogue devices, but this option can be used to disable that protection
1051 # for cases where the server/authenticator does not need to be
1053 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
1054 # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
1055 # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1056 # used to disable MSCHAPv2 password retry in authentication failure cases.
1058 # TLS-based methods can use the following parameters to control TLS behavior
1059 # (these are normally in the phase1 parameter, but can be used also in the
1060 # phase2 parameter when EAP-TLS is used within the inner tunnel):
1061 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1062 # TLS library, these may be disabled by default to enforce stronger
1064 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
1065 # the TLS library to accept certificates even if they are not currently
1066 # valid, i.e., have expired or have not yet become valid; this should be
1067 # used only for testing purposes)
1068 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1069 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1070 # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1071 # as a workaround for broken authentication server implementations unless
1072 # EAP workarounds are disabled with eap_workaround=0.
1073 # For EAP-FAST, this must be set to 0 (or left unconfigured for the
1074 # default value to be used automatically).
1075 # tls_disable_tlsv1_0=1 - disable use of TLSv1.0
1076 # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1077 # that have issues interoperating with updated TLS version)
1078 # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1079 # that have issues interoperating with updated TLS version)
1080 # tls_ext_cert_check=0 - No external server certificate validation (default)
1081 # tls_ext_cert_check=1 - External server certificate validation enabled; this
1082 # requires an external program doing validation of server certificate
1083 # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1084 # interface and report the result of the validation with
1085 # CTRL-RSP_EXT_CERT_CHECK.
1087 # Following certificate/private key fields are used in inner Phase2
1088 # authentication when using EAP-TTLS or EAP-PEAP.
1089 # ca_cert2: File path to CA certificate file. This file can have one or more
1090 # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1091 # server certificate will not be verified. This is insecure and a trusted
1092 # CA certificate should always be configured.
1093 # ca_path2: Directory path for CA certificate files (PEM)
1094 # client_cert2: File path to client certificate file
1095 # private_key2: File path to client private key file
1096 # private_key2_passwd: Password for private key file
1097 # dh_file2: File path to DH/DSA parameters file (in PEM format)
1098 # subject_match2: Substring to be matched against the subject of the
1099 # authentication server certificate. See subject_match for more details.
1100 # altsubject_match2: Semicolon separated string of entries to be matched
1101 # against the alternative subject name of the authentication server
1102 # certificate. See altsubject_match documentation for more details.
1103 # domain_suffix_match2: Constraint for server domain name. See
1104 # domain_suffix_match for more details.
1106 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
1107 # This value limits the fragment size for EAP methods that support
1108 # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1109 # small enough to make the EAP messages fit in MTU of the network
1110 # interface used for EAPOL. The default value is suitable for most
1113 # ocsp: Whether to use/require OCSP to check server certificate
1114 # 0 = do not use OCSP stapling (TLS certificate status extension)
1115 # 1 = try to use OCSP stapling, but not require response
1116 # 2 = require valid OCSP stapling response
1117 # 3 = require valid OCSP stapling response for all not-trusted
1118 # certificates in the server certificate chain
1120 # openssl_ciphers: OpenSSL specific cipher configuration
1121 # This can be used to override the global openssl_ciphers configuration
1122 # parameter (see above).
1124 # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1126 # EAP-FAST variables:
1127 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1128 # to create this file and write updates to it when PAC is being
1129 # provisioned or refreshed. Full path to the file should be used since
1130 # working directory may change when wpa_supplicant is run in the
1131 # background. Alternatively, a named configuration blob can be used by
1132 # setting this to blob://<blob name>
1133 # phase1: fast_provisioning option can be used to enable in-line provisioning
1134 # of EAP-FAST credentials (PAC):
1136 # 1 = allow unauthenticated provisioning,
1137 # 2 = allow authenticated provisioning,
1138 # 3 = allow both unauthenticated and authenticated provisioning
1139 # fast_max_pac_list_len=<num> option can be used to set the maximum
1140 # number of PAC entries to store in a PAC list (default: 10)
1141 # fast_pac_format=binary option can be used to select binary format for
1142 # storing PAC entries in order to save some space (the default
1143 # text format uses about 2.5 times the size of minimal binary
1146 # wpa_supplicant supports number of "EAP workarounds" to work around
1147 # interoperability issues with incorrectly behaving authentication servers.
1148 # These are enabled by default because some of the issues are present in large
1149 # number of authentication servers. Strict EAP conformance mode can be
1150 # configured by disabling workarounds with eap_workaround=0.
1152 # update_identifier: PPS MO ID
1153 # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1155 # Station inactivity limit
1157 # If a station does not send anything in ap_max_inactivity seconds, an
1158 # empty data frame is sent to it in order to verify whether it is
1159 # still in range. If this frame is not ACKed, the station will be
1160 # disassociated and then deauthenticated. This feature is used to
1161 # clear station table of old entries when the STAs move out of the
1164 # The station can associate again with the AP if it is still in range;
1165 # this inactivity poll is just used as a nicer way of verifying
1166 # inactivity; i.e., client will not report broken connection because
1167 # disassociation frame is not sent immediately without first polling
1168 # the STA with a data frame.
1169 # default: 300 (i.e., 5 minutes)
1170 #ap_max_inactivity=300
1172 # DTIM period in Beacon intervals for AP mode (default: 2)
1175 # Beacon interval (default: 100 TU)
1178 # MAC address policy
1179 # 0 = use permanent MAC address
1180 # 1 = use random MAC address for each ESS connection
1181 # 2 = like 1, but maintain OUI (with local admin bit set)
1184 # disable_ht: Whether HT (802.11n) should be disabled.
1185 # 0 = HT enabled (if AP supports it)
1188 # disable_ht40: Whether HT-40 (802.11n) should be disabled.
1189 # 0 = HT-40 enabled (if AP supports it)
1190 # 1 = HT-40 disabled
1192 # disable_sgi: Whether SGI (short guard interval) should be disabled.
1193 # 0 = SGI enabled (if AP supports it)
1196 # disable_ldpc: Whether LDPC should be disabled.
1197 # 0 = LDPC enabled (if AP supports it)
1200 # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1201 # 0 = 40 MHz tolerant (default)
1202 # 1 = 40 MHz intolerant
1204 # ht_mcs: Configure allowed MCS rates.
1205 # Parsed as an array of bytes, in base-16 (ascii-hex)
1206 # ht_mcs="" // Use all available (default)
1207 # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1208 # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1210 # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1211 # -1 = Do not make any changes.
1212 # 0 = Enable MAX-AMSDU if hardware supports it.
1215 # ampdu_factor: Maximum A-MPDU Length Exponent
1216 # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1218 # ampdu_density: Allow overriding AMPDU density configuration.
1219 # Treated as hint by the kernel.
1220 # -1 = Do not make any changes.
1221 # 0-3 = Set AMPDU density (aka factor) to specified value.
1223 # disable_vht: Whether VHT should be disabled.
1224 # 0 = VHT enabled (if AP supports it)
1227 # vht_capa: VHT capabilities to set in the override
1228 # vht_capa_mask: mask of VHT capabilities
1230 # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1231 # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1237 ##### Fast Session Transfer (FST) support #####################################
1239 # The options in this section are only available when the build configuration
1240 # option CONFIG_FST is set while compiling hostapd. They allow this interface
1241 # to be a part of FST setup.
1243 # FST is the transfer of a session from a channel to another channel, in the
1244 # same or different frequency bands.
1246 # For detals, see IEEE Std 802.11ad-2012.
1248 # Identifier of an FST Group the interface belongs to.
1251 # Interface priority within the FST Group.
1252 # Announcing a higher priority for an interface means declaring it more
1253 # preferable for FST switch.
1254 # fst_priority is in 1..255 range with 1 being the lowest priority.
1257 # Default LLT value for this interface in milliseconds. The value used in case
1258 # no value provided during session setup. Default is 50 msec.
1259 # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1260 # Transitioning between states).
1265 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1268 psk="very secret passphrase"
1272 # Same as previous, but request SSID-specific scanning (for APs that reject
1277 psk="very secret passphrase"
1281 # Only WPA-PSK is used. Any valid cipher combination is accepted.
1287 group=CCMP TKIP WEP104 WEP40
1288 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1292 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1299 psk="not so secure passphrase"
1303 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1304 # or WEP40 as the group cipher will not be accepted.
1312 identity="user@example.com"
1313 ca_cert="/etc/cert/ca.pem"
1314 client_cert="/etc/cert/user.pem"
1315 private_key="/etc/cert/user.prv"
1316 private_key_passwd="password"
1320 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1326 identity="user@example.com"
1328 ca_cert="/etc/cert/ca.pem"
1329 phase1="peaplabel=1"
1330 phase2="auth=MSCHAPV2"
1334 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1335 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1340 identity="user@example.com"
1341 anonymous_identity="anonymous@example.com"
1343 ca_cert="/etc/cert/ca.pem"
1347 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1348 # use. Real identity is sent only within an encrypted TLS tunnel.
1353 identity="user@example.com"
1354 anonymous_identity="anonymous@example.com"
1356 ca_cert="/etc/cert/ca.pem"
1357 phase2="auth=MSCHAPV2"
1360 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1366 # Phase1 / outer authentication
1367 anonymous_identity="anonymous@example.com"
1368 ca_cert="/etc/cert/ca.pem"
1369 # Phase 2 / inner authentication
1370 phase2="autheap=TLS"
1371 ca_cert2="/etc/cert/ca2.pem"
1372 client_cert2="/etc/cer/user.pem"
1373 private_key2="/etc/cer/user.prv"
1374 private_key2_passwd="password"
1378 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1382 bssid=00:11:22:33:44:55
1384 key_mgmt=WPA-PSK WPA-EAP
1387 psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1390 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1391 # and all valid ciphers.
1394 psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1398 # EAP-SIM with a GSM SIM or USIM
1413 anonymous_identity="eap_psk_user"
1414 password=06b4be19da289f475aa46a33cb793029
1415 identity="eap_psk_user@example.com"
1419 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1420 # EAP-TLS for authentication and key generation; require both unicast and
1421 # broadcast WEP keys.
1426 identity="user@example.com"
1427 ca_cert="/etc/cert/ca.pem"
1428 client_cert="/etc/cert/user.pem"
1429 private_key="/etc/cert/user.prv"
1430 private_key_passwd="password"
1435 # LEAP with dynamic WEP keys
1444 # EAP-IKEv2 using shared secrets for both server and peer authentication
1446 ssid="ikev2-example"
1453 # EAP-FAST with WPA (WPA or WPA2)
1455 ssid="eap-fast-test"
1458 anonymous_identity="FAST-000102030405"
1461 phase1="fast_provisioning=1"
1462 pac_file="/etc/wpa_supplicant.eap-fast-pac"
1466 ssid="eap-fast-test"
1469 anonymous_identity="FAST-000102030405"
1472 phase1="fast_provisioning=1"
1473 pac_file="blob://eap-fast-pac"
1476 # Plaintext connection (no WPA, no IEEE 802.1X)
1478 ssid="plaintext-test"
1483 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1485 ssid="static-wep-test"
1489 wep_key2="1234567890123"
1495 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1496 # IEEE 802.11 authentication
1498 ssid="static-wep-test2"
1502 wep_key2="1234567890123"
1509 # IBSS/ad-hoc network with RSN
1521 # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
1530 psk="secret passphrase"
1541 # secure (SAE + AMPE) network
1547 psk="very secret passphrase"
1551 # Catch all example that allows more or less all configuration modes
1555 key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1557 group=CCMP TKIP WEP104 WEP40
1558 psk="very secret passphrase"
1560 identity="user@example.com"
1562 ca_cert="/etc/cert/ca.pem"
1563 client_cert="/etc/cert/user.pem"
1564 private_key="/etc/cert/user.prv"
1565 private_key_passwd="password"
1566 phase1="peaplabel=0"
1569 # Example of EAP-TLS with smartcard (openssl engine)
1577 identity="user@example.com"
1578 ca_cert="/etc/cert/ca.pem"
1579 client_cert="/etc/cert/user.pem"
1583 # The engine configured here must be available. Look at
1584 # OpenSSL engine support in the global section.
1585 # The key available through the engine must be the private key
1586 # matching the client certificate configured above.
1588 # use the opensc engine
1592 # use the pkcs11 engine
1596 # Optional PIN configuration; this can be left out and PIN will be
1597 # asked through the control interface
1601 # Example configuration showing how to use an inlined blob as a CA certificate
1602 # data instead of using external file
1607 identity="user@example.com"
1608 anonymous_identity="anonymous@example.com"
1610 ca_cert="blob://exampleblob"
1614 blob-base64-exampleblob={
1615 SGVsbG8gV29ybGQhCg==
1619 # Wildcard match for SSID (plaintext APs only). This example select any
1620 # open AP regardless of its SSID.
1625 # Example configuration blacklisting two APs - these will be ignored
1629 psk="very secret passphrase"
1630 bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1633 # Example configuration limiting AP selection to a specific set of APs;
1634 # any other AP not matching the masked address will be ignored.
1637 psk="very secret passphrase"
1638 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
1641 # Example config file that will only scan on channel 36.
1648 # Example MACsec configuration
1650 # key_mgmt=IEEE8021X
1653 # anonymous_identity="anonymous@example.com"
1654 # identity="user@example.com"
1655 # password="secretr"
1656 # ca_cert="/etc/cert/ca.pem"