WPS: Allow the priority for the WPS networks to be configured
[mech_eap.git] / wpa_supplicant / wpa_supplicant.conf
1 ##### Example wpa_supplicant configuration file ###############################
2 #
3 # This file describes configuration file format and lists all available option.
4 # Please also take a look at simpler configuration examples in 'examples'
5 # subdirectory.
6 #
7 # Empty lines and lines starting with # are ignored
8
9 # NOTE! This file may contain password information and should probably be made
10 # readable only by root user on multiuser systems.
11
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.
15
16 # Whether to allow wpa_supplicant to update (overwrite) configuration
17 #
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
23 # it.
24 #update_config=1
25
26 # global configuration (shared by all network blocks)
27 #
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
33 # enabled.
34 #
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
40 # interface is used.
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.
43 #
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.
56 #
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)
61 #
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)
65 #
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.
74 #
75 ctrl_interface=/var/run/wpa_supplicant
76
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
83 # version (2).
84 # Note: When using MACsec, eapol_version shall be set to 3, which is
85 # defined in IEEE Std 802.1X-2010.
86 eapol_version=1
87
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
103 #    macsec feature.
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 # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
112 # created immediately regardless of scan results. ap_scan=1 mode will first try
113 # to scan for existing networks and only if no matches with the enabled
114 # networks are found, a new IBSS or AP mode network is created.
115 ap_scan=1
116
117 # MPM residency
118 # By default, wpa_supplicant implements the mesh peering manager (MPM) for an
119 # open mesh. However, if the driver can implement the MPM, you may set this to
120 # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
121 # always used.
122 # 0: MPM lives in the driver
123 # 1: wpa_supplicant provides an MPM which handles peering (default)
124 #user_mpm=1
125
126 # Maximum number of peer links (0-255; default: 99)
127 # Maximum number of mesh peering currently maintained by the STA.
128 #max_peer_links=99
129
130 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
131 #
132 # This timeout value is used in mesh STA to clean up inactive stations.
133 #mesh_max_inactivity=300
134
135 # cert_in_cb - Whether to include a peer certificate dump in events
136 # This controls whether peer certificates for authentication server and
137 # its certificate chain are included in EAP peer certificate events. This is
138 # enabled by default.
139 #cert_in_cb=1
140
141 # EAP fast re-authentication
142 # By default, fast re-authentication is enabled for all EAP methods that
143 # support it. This variable can be used to disable fast re-authentication.
144 # Normally, there is no need to disable this.
145 fast_reauth=1
146
147 # OpenSSL Engine support
148 # These options can be used to load OpenSSL engines.
149 # The two engines that are supported currently are shown below:
150 # They are both from the opensc project (http://www.opensc.org/)
151 # By default no engines are loaded.
152 # make the opensc engine available
153 #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
154 # make the pkcs11 engine available
155 #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
156 # configure the path to the pkcs11 module required by the pkcs11 engine
157 #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
158
159 # OpenSSL cipher string
160 #
161 # This is an OpenSSL specific configuration option for configuring the default
162 # ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the default.
163 # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
164 # on cipher suite configuration. This is applicable only if wpa_supplicant is
165 # built to use OpenSSL.
166 #openssl_ciphers=DEFAULT:!EXP:!LOW
167
168
169 # Dynamic EAP methods
170 # If EAP methods were built dynamically as shared object files, they need to be
171 # loaded here before being used in the network blocks. By default, EAP methods
172 # are included statically in the build, so these lines are not needed
173 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
174 #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
175
176 # Driver interface parameters
177 # This field can be used to configure arbitrary driver interace parameters. The
178 # format is specific to the selected driver interface. This field is not used
179 # in most cases.
180 #driver_param="field=value"
181
182 # Country code
183 # The ISO/IEC alpha2 country code for the country in which this device is
184 # currently operating.
185 #country=US
186
187 # Maximum lifetime for PMKSA in seconds; default 43200
188 #dot11RSNAConfigPMKLifetime=43200
189 # Threshold for reauthentication (percentage of PMK lifetime); default 70
190 #dot11RSNAConfigPMKReauthThreshold=70
191 # Timeout for security association negotiation in seconds; default 60
192 #dot11RSNAConfigSATimeout=60
193
194 # Wi-Fi Protected Setup (WPS) parameters
195
196 # Universally Unique IDentifier (UUID; see RFC 4122) of the device
197 # If not configured, UUID will be generated based on the local MAC address.
198 #uuid=12345678-9abc-def0-1234-56789abcdef0
199
200 # Device Name
201 # User-friendly description of device; up to 32 octets encoded in UTF-8
202 #device_name=Wireless Client
203
204 # Manufacturer
205 # The manufacturer of the device (up to 64 ASCII characters)
206 #manufacturer=Company
207
208 # Model Name
209 # Model of the device (up to 32 ASCII characters)
210 #model_name=cmodel
211
212 # Model Number
213 # Additional device description (up to 32 ASCII characters)
214 #model_number=123
215
216 # Serial Number
217 # Serial number of the device (up to 32 characters)
218 #serial_number=12345
219
220 # Primary Device Type
221 # Used format: <categ>-<OUI>-<subcateg>
222 # categ = Category as an integer value
223 # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
224 #       default WPS OUI
225 # subcateg = OUI-specific Sub Category as an integer value
226 # Examples:
227 #   1-0050F204-1 (Computer / PC)
228 #   1-0050F204-2 (Computer / Server)
229 #   5-0050F204-1 (Storage / NAS)
230 #   6-0050F204-1 (Network Infrastructure / AP)
231 #device_type=1-0050F204-1
232
233 # OS Version
234 # 4-octet operating system version number (hex string)
235 #os_version=01020300
236
237 # Config Methods
238 # List of the supported configuration methods
239 # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
240 #       nfc_interface push_button keypad virtual_display physical_display
241 #       virtual_push_button physical_push_button
242 # For WSC 1.0:
243 #config_methods=label display push_button keypad
244 # For WSC 2.0:
245 #config_methods=label virtual_display virtual_push_button keypad
246
247 # Credential processing
248 #   0 = process received credentials internally (default)
249 #   1 = do not process received credentials; just pass them over ctrl_iface to
250 #       external program(s)
251 #   2 = process received credentials internally and pass them over ctrl_iface
252 #       to external program(s)
253 #wps_cred_processing=0
254
255 # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
256 # The vendor attribute contents to be added in M1 (hex string)
257 #wps_vendor_ext_m1=000137100100020001
258
259 # NFC password token for WPS
260 # These parameters can be used to configure a fixed NFC password token for the
261 # station. This can be generated, e.g., with nfc_pw_token. When these
262 # parameters are used, the station is assumed to be deployed with a NFC tag
263 # that includes the matching NFC password token (e.g., written based on the
264 # NDEF record from nfc_pw_token).
265 #
266 #wps_nfc_dev_pw_id: Device Password ID (16..65535)
267 #wps_nfc_dh_pubkey: Hexdump of DH Public Key
268 #wps_nfc_dh_privkey: Hexdump of DH Private Key
269 #wps_nfc_dev_pw: Hexdump of Device Password
270
271 # Priority for the networks added through WPS
272 # This priority value will be set to each network profile that is added
273 # by executing the WPS protocol.
274 #wps_priority=0
275
276 # Maximum number of BSS entries to keep in memory
277 # Default: 200
278 # This can be used to limit memory use on the BSS entries (cached scan
279 # results). A larger value may be needed in environments that have huge number
280 # of APs when using ap_scan=1 mode.
281 #bss_max_count=200
282
283 # Automatic scan
284 # This is an optional set of parameters for automatic scanning
285 # within an interface in following format:
286 #autoscan=<autoscan module name>:<module parameters>
287 # autoscan is like bgscan but on disconnected or inactive state.
288 # For instance, on exponential module parameters would be <base>:<limit>
289 #autoscan=exponential:3:300
290 # Which means a delay between scans on a base exponential of 3,
291 # up to the limit of 300 seconds (3, 9, 27 ... 300)
292 # For periodic module, parameters would be <fixed interval>
293 #autoscan=periodic:30
294 # So a delay of 30 seconds will be applied between each scan
295
296 # filter_ssids - SSID-based scan result filtering
297 # 0 = do not filter scan results (default)
298 # 1 = only include configured SSIDs in scan results/BSS table
299 #filter_ssids=0
300
301 # Password (and passphrase, etc.) backend for external storage
302 # format: <backend name>[:<optional backend parameters>]
303 #ext_password_backend=test:pw1=password|pw2=testing
304
305
306 # Disable P2P functionality
307 # p2p_disabled=1
308
309 # Timeout in seconds to detect STA inactivity (default: 300 seconds)
310 #
311 # This timeout value is used in P2P GO mode to clean up
312 # inactive stations.
313 #p2p_go_max_inactivity=300
314
315 # Passphrase length (8..63) for P2P GO
316 #
317 # This parameter controls the length of the random passphrase that is
318 # generated at the GO. Default: 8.
319 #p2p_passphrase_len=8
320
321 # Extra delay between concurrent P2P search iterations
322 #
323 # This value adds extra delay in milliseconds between concurrent search
324 # iterations to make p2p_find friendlier to concurrent operations by avoiding
325 # it from taking 100% of radio resources. The default value is 500 ms.
326 #p2p_search_delay=500
327
328 # Opportunistic Key Caching (also known as Proactive Key Caching) default
329 # This parameter can be used to set the default behavior for the
330 # proactive_key_caching parameter. By default, OKC is disabled unless enabled
331 # with the global okc=1 parameter or with the per-network
332 # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
333 # can be disabled with per-network proactive_key_caching=0 parameter.
334 #okc=0
335
336 # Protected Management Frames default
337 # This parameter can be used to set the default behavior for the ieee80211w
338 # parameter. By default, PMF is disabled unless enabled with the global pmf=1/2
339 # parameter or with the per-network ieee80211w=1/2 parameter. With pmf=1/2, PMF
340 # is enabled/required by default, but can be disabled with the per-network
341 # ieee80211w parameter.
342 #pmf=0
343
344 # Enabled SAE finite cyclic groups in preference order
345 # By default (if this parameter is not set), the mandatory group 19 (ECC group
346 # defined over a 256-bit prime order field) is preferred, but other groups are
347 # also enabled. If this parameter is set, the groups will be tried in the
348 # indicated order. The group values are listed in the IANA registry:
349 # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
350 #sae_groups=21 20 19 26 25
351
352 # Default value for DTIM period (if not overridden in network block)
353 #dtim_period=2
354
355 # Default value for Beacon interval (if not overridden in network block)
356 #beacon_int=100
357
358 # Additional vendor specific elements for Beacon and Probe Response frames
359 # This parameter can be used to add additional vendor specific element(s) into
360 # the end of the Beacon and Probe Response frames. The format for these
361 # element(s) is a hexdump of the raw information elements (id+len+payload for
362 # one or more elements). This is used in AP and P2P GO modes.
363 #ap_vendor_elements=dd0411223301
364
365 # Ignore scan results older than request
366 #
367 # The driver may have a cache of scan results that makes it return
368 # information that is older than our scan trigger. This parameter can
369 # be used to configure such old information to be ignored instead of
370 # allowing it to update the internal BSS table.
371 #ignore_old_scan_res=0
372
373 # scan_cur_freq: Whether to scan only the current frequency
374 # 0:  Scan all available frequencies. (Default)
375 # 1:  Scan current operating frequency if another VIF on the same radio
376 #     is already associated.
377
378 # MAC address policy default
379 # 0 = use permanent MAC address
380 # 1 = use random MAC address for each ESS connection
381 # 2 = like 1, but maintain OUI (with local admin bit set)
382 #
383 # By default, permanent MAC address is used unless policy is changed by
384 # the per-network mac_addr parameter. Global mac_addr=1 can be used to
385 # change this default behavior.
386 #mac_addr=0
387
388 # Lifetime of random MAC address in seconds (default: 60)
389 #rand_addr_lifetime=60
390
391 # MAC address policy for pre-association operations (scanning, ANQP)
392 # 0 = use permanent MAC address
393 # 1 = use random MAC address
394 # 2 = like 1, but maintain OUI (with local admin bit set)
395 #preassoc_mac_addr=0
396
397 # Interworking (IEEE 802.11u)
398
399 # Enable Interworking
400 # interworking=1
401
402 # Homogenous ESS identifier
403 # If this is set, scans will be used to request response only from BSSes
404 # belonging to the specified Homogeneous ESS. This is used only if interworking
405 # is enabled.
406 # hessid=00:11:22:33:44:55
407
408 # Automatic network selection behavior
409 # 0 = do not automatically go through Interworking network selection
410 #     (i.e., require explicit interworking_select command for this; default)
411 # 1 = perform Interworking network selection if one or more
412 #     credentials have been configured and scan did not find a
413 #     matching network block
414 #auto_interworking=0
415
416 # credential block
417 #
418 # Each credential used for automatic network selection is configured as a set
419 # of parameters that are compared to the information advertised by the APs when
420 # interworking_select and interworking_connect commands are used.
421 #
422 # credential fields:
423 #
424 # temporary: Whether this credential is temporary and not to be saved
425 #
426 # priority: Priority group
427 #       By default, all networks and credentials get the same priority group
428 #       (0). This field can be used to give higher priority for credentials
429 #       (and similarly in struct wpa_ssid for network blocks) to change the
430 #       Interworking automatic networking selection behavior. The matching
431 #       network (based on either an enabled network block or a credential)
432 #       with the highest priority value will be selected.
433 #
434 # pcsc: Use PC/SC and SIM/USIM card
435 #
436 # realm: Home Realm for Interworking
437 #
438 # username: Username for Interworking network selection
439 #
440 # password: Password for Interworking network selection
441 #
442 # ca_cert: CA certificate for Interworking network selection
443 #
444 # client_cert: File path to client certificate file (PEM/DER)
445 #       This field is used with Interworking networking selection for a case
446 #       where client certificate/private key is used for authentication
447 #       (EAP-TLS). Full path to the file should be used since working
448 #       directory may change when wpa_supplicant is run in the background.
449 #
450 #       Alternatively, a named configuration blob can be used by setting
451 #       this to blob://blob_name.
452 #
453 # private_key: File path to client private key file (PEM/DER/PFX)
454 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
455 #       commented out. Both the private key and certificate will be read
456 #       from the PKCS#12 file in this case. Full path to the file should be
457 #       used since working directory may change when wpa_supplicant is run
458 #       in the background.
459 #
460 #       Windows certificate store can be used by leaving client_cert out and
461 #       configuring private_key in one of the following formats:
462 #
463 #       cert://substring_to_match
464 #
465 #       hash://certificate_thumbprint_in_hex
466 #
467 #       For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
468 #
469 #       Note that when running wpa_supplicant as an application, the user
470 #       certificate store (My user account) is used, whereas computer store
471 #       (Computer account) is used when running wpasvc as a service.
472 #
473 #       Alternatively, a named configuration blob can be used by setting
474 #       this to blob://blob_name.
475 #
476 # private_key_passwd: Password for private key file
477 #
478 # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
479 #
480 # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
481 #       format
482 #
483 # domain: Home service provider FQDN(s)
484 #       This is used to compare against the Domain Name List to figure out
485 #       whether the AP is operated by the Home SP. Multiple domain entries can
486 #       be used to configure alternative FQDNs that will be considered home
487 #       networks.
488 #
489 # roaming_consortium: Roaming Consortium OI
490 #       If roaming_consortium_len is non-zero, this field contains the
491 #       Roaming Consortium OI that can be used to determine which access
492 #       points support authentication with this credential. This is an
493 #       alternative to the use of the realm parameter. When using Roaming
494 #       Consortium to match the network, the EAP parameters need to be
495 #       pre-configured with the credential since the NAI Realm information
496 #       may not be available or fetched.
497 #
498 # eap: Pre-configured EAP method
499 #       This optional field can be used to specify which EAP method will be
500 #       used with this credential. If not set, the EAP method is selected
501 #       automatically based on ANQP information (e.g., NAI Realm).
502 #
503 # phase1: Pre-configure Phase 1 (outer authentication) parameters
504 #       This optional field is used with like the 'eap' parameter.
505 #
506 # phase2: Pre-configure Phase 2 (inner authentication) parameters
507 #       This optional field is used with like the 'eap' parameter.
508 #
509 # excluded_ssid: Excluded SSID
510 #       This optional field can be used to excluded specific SSID(s) from
511 #       matching with the network. Multiple entries can be used to specify more
512 #       than one SSID.
513 #
514 # roaming_partner: Roaming partner information
515 #       This optional field can be used to configure preferences between roaming
516 #       partners. The field is a string in following format:
517 #       <FQDN>,<0/1 exact match>,<priority>,<* or country code>
518 #       (non-exact match means any subdomain matches the entry; priority is in
519 #       0..255 range with 0 being the highest priority)
520 #
521 # update_identifier: PPS MO ID
522 #       (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
523 #
524 # provisioning_sp: FQDN of the SP that provisioned the credential
525 #       This optional field can be used to keep track of the SP that provisioned
526 #       the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
527 #
528 # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
529 #       These fields can be used to specify minimum download/upload backhaul
530 #       bandwidth that is preferred for the credential. This constraint is
531 #       ignored if the AP does not advertise WAN Metrics information or if the
532 #       limit would prevent any connection. Values are in kilobits per second.
533 # min_dl_bandwidth_home
534 # min_ul_bandwidth_home
535 # min_dl_bandwidth_roaming
536 # min_ul_bandwidth_roaming
537 #
538 # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
539 #       (PPS/<X+>/Policy/MaximumBSSLoadValue)
540 #       This value is used as the maximum channel utilization for network
541 #       selection purposes for home networks. If the AP does not advertise
542 #       BSS Load or if the limit would prevent any connection, this constraint
543 #       will be ignored.
544 #
545 # req_conn_capab: Required connection capability
546 #       (PPS/<X+>/Policy/RequiredProtoPortTuple)
547 #       This value is used to configure set of required protocol/port pairs that
548 #       a roaming network shall support (include explicitly in Connection
549 #       Capability ANQP element). This constraint is ignored if the AP does not
550 #       advertise Connection Capability or if this constraint would prevent any
551 #       network connection. This policy is not used in home networks.
552 #       Format: <protocol>[:<comma-separated list of ports]
553 #       Multiple entries can be used to list multiple requirements.
554 #       For example, number of common TCP protocols:
555 #       req_conn_capab=6,22,80,443
556 #       For example, IPSec/IKE:
557 #       req_conn_capab=17:500
558 #       req_conn_capab=50
559 #
560 # ocsp: Whether to use/require OCSP to check server certificate
561 #       0 = do not use OCSP stapling (TLS certificate status extension)
562 #       1 = try to use OCSP stapling, but not require response
563 #       2 = require valid OCSP stapling response
564 #
565 # sim_num: Identifier for which SIM to use in multi-SIM devices
566 #
567 # for example:
568 #
569 #cred={
570 #       realm="example.com"
571 #       username="user@example.com"
572 #       password="password"
573 #       ca_cert="/etc/wpa_supplicant/ca.pem"
574 #       domain="example.com"
575 #}
576 #
577 #cred={
578 #       imsi="310026-000000000"
579 #       milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
580 #}
581 #
582 #cred={
583 #       realm="example.com"
584 #       username="user"
585 #       password="password"
586 #       ca_cert="/etc/wpa_supplicant/ca.pem"
587 #       domain="example.com"
588 #       roaming_consortium=223344
589 #       eap=TTLS
590 #       phase2="auth=MSCHAPV2"
591 #}
592
593 # Hotspot 2.0
594 # hs20=1
595
596 # network block
597 #
598 # Each network (usually AP's sharing the same SSID) is configured as a separate
599 # block in this configuration file. The network blocks are in preference order
600 # (the first match is used).
601 #
602 # network block fields:
603 #
604 # disabled:
605 #       0 = this network can be used (default)
606 #       1 = this network block is disabled (can be enabled through ctrl_iface,
607 #           e.g., with wpa_cli or wpa_gui)
608 #
609 # id_str: Network identifier string for external scripts. This value is passed
610 #       to external action script through wpa_cli as WPA_ID_STR environment
611 #       variable to make it easier to do network specific configuration.
612 #
613 # ssid: SSID (mandatory); network name in one of the optional formats:
614 #       - an ASCII string with double quotation
615 #       - a hex string (two characters per octet of SSID)
616 #       - a printf-escaped ASCII string P"<escaped string>"
617 #
618 # scan_ssid:
619 #       0 = do not scan this SSID with specific Probe Request frames (default)
620 #       1 = scan with SSID-specific Probe Request frames (this can be used to
621 #           find APs that do not accept broadcast SSID or use multiple SSIDs;
622 #           this will add latency to scanning, so enable this only when needed)
623 #
624 # bssid: BSSID (optional); if set, this network block is used only when
625 #       associating with the AP using the configured BSSID
626 #
627 # priority: priority group (integer)
628 # By default, all networks will get same priority group (0). If some of the
629 # networks are more desirable, this field can be used to change the order in
630 # which wpa_supplicant goes through the networks when selecting a BSS. The
631 # priority groups will be iterated in decreasing priority (i.e., the larger the
632 # priority value, the sooner the network is matched against the scan results).
633 # Within each priority group, networks will be selected based on security
634 # policy, signal strength, etc.
635 # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
636 # using this priority to select the order for scanning. Instead, they try the
637 # networks in the order that used in the configuration file.
638 #
639 # mode: IEEE 802.11 operation mode
640 # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
641 # 1 = IBSS (ad-hoc, peer-to-peer)
642 # 2 = AP (access point)
643 # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
644 # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
645 # TKIP/CCMP) is available for backwards compatibility, but its use is
646 # deprecated. WPA-None requires following network block options:
647 # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
648 # both), and psk must also be set.
649 #
650 # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
651 # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
652 # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
653 # In addition, this value is only used by the station that creates the IBSS. If
654 # an IBSS network with the configured SSID is already present, the frequency of
655 # the network will be used instead of this configured value.
656 #
657 # scan_freq: List of frequencies to scan
658 # Space-separated list of frequencies in MHz to scan when searching for this
659 # BSS. If the subset of channels used by the network is known, this option can
660 # be used to optimize scanning to not occur on channels that the network does
661 # not use. Example: scan_freq=2412 2437 2462
662 #
663 # freq_list: Array of allowed frequencies
664 # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
665 # set, scan results that do not match any of the specified frequencies are not
666 # considered when selecting a BSS.
667 #
668 # This can also be set on the outside of the network block. In this case,
669 # it limits the frequencies that will be scanned.
670 #
671 # bgscan: Background scanning
672 # wpa_supplicant behavior for background scanning can be specified by
673 # configuring a bgscan module. These modules are responsible for requesting
674 # background scans for the purpose of roaming within an ESS (i.e., within a
675 # single network block with all the APs using the same SSID). The bgscan
676 # parameter uses following format: "<bgscan module name>:<module parameters>"
677 # Following bgscan modules are available:
678 # simple - Periodic background scans based on signal strength
679 # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
680 # <long interval>"
681 # bgscan="simple:30:-45:300"
682 # learn - Learn channels used by the network and try to avoid bgscans on other
683 # channels (experimental)
684 # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
685 # <long interval>[:<database file name>]"
686 # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
687 # Explicitly disable bgscan by setting
688 # bgscan=""
689 #
690 # This option can also be set outside of all network blocks for the bgscan
691 # parameter to apply for all the networks that have no specific bgscan
692 # parameter.
693 #
694 # proto: list of accepted protocols
695 # WPA = WPA/IEEE 802.11i/D3.0
696 # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
697 # If not set, this defaults to: WPA RSN
698 #
699 # key_mgmt: list of accepted authenticated key management protocols
700 # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
701 # WPA-EAP = WPA using EAP authentication
702 # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
703 #       generated WEP keys
704 # NONE = WPA is not used; plaintext or static WEP could be used
705 # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
706 # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
707 # If not set, this defaults to: WPA-PSK WPA-EAP
708 #
709 # ieee80211w: whether management frame protection is enabled
710 # 0 = disabled (default unless changed with the global pmf parameter)
711 # 1 = optional
712 # 2 = required
713 # The most common configuration options for this based on the PMF (protected
714 # management frames) certification program are:
715 # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
716 # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
717 # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
718 #
719 # auth_alg: list of allowed IEEE 802.11 authentication algorithms
720 # OPEN = Open System authentication (required for WPA/WPA2)
721 # SHARED = Shared Key authentication (requires static WEP keys)
722 # LEAP = LEAP/Network EAP (only used with LEAP)
723 # If not set, automatic selection is used (Open System with LEAP enabled if
724 # LEAP is allowed as one of the EAP methods).
725 #
726 # pairwise: list of accepted pairwise (unicast) ciphers for WPA
727 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
728 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
729 # NONE = Use only Group Keys (deprecated, should not be included if APs support
730 #       pairwise keys)
731 # If not set, this defaults to: CCMP TKIP
732 #
733 # group: list of accepted group (broadcast/multicast) ciphers for WPA
734 # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
735 # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
736 # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
737 # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
738 # If not set, this defaults to: CCMP TKIP WEP104 WEP40
739 #
740 # psk: WPA preshared key; 256-bit pre-shared key
741 # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
742 # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
743 # generated using the passphrase and SSID). ASCII passphrase must be between
744 # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
745 # be used to indicate that the PSK/passphrase is stored in external storage.
746 # This field is not needed, if WPA-EAP is used.
747 # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
748 # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
749 # startup and reconfiguration time can be optimized by generating the PSK only
750 # only when the passphrase or SSID has actually changed.
751 #
752 # mem_only_psk: Whether to keep PSK/passphrase only in memory
753 # 0 = allow psk/passphrase to be stored to the configuration file
754 # 1 = do not store psk/passphrase to the configuration file
755 #mem_only_psk=0
756 #
757 # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
758 # Dynamic WEP key required for non-WPA mode
759 # bit0 (1): require dynamically generated unicast WEP key
760 # bit1 (2): require dynamically generated broadcast WEP key
761 #       (3 = require both keys; default)
762 # Note: When using wired authentication (including macsec_qca driver),
763 # eapol_flags must be set to 0 for the authentication to be completed
764 # successfully.
765 #
766 # macsec_policy: IEEE 802.1X/MACsec options
767 # This determines how sessions are secured with MACsec. It is currently
768 # applicable only when using the macsec_qca driver interface.
769 # 0: MACsec not in use (default)
770 # 1: MACsec enabled - Should secure, accept key server's advice to
771 #    determine whether to use a secure session or not.
772 #
773 # mixed_cell: This option can be used to configure whether so called mixed
774 # cells, i.e., networks that use both plaintext and encryption in the same
775 # SSID, are allowed when selecting a BSS from scan results.
776 # 0 = disabled (default)
777 # 1 = enabled
778 #
779 # proactive_key_caching:
780 # Enable/disable opportunistic PMKSA caching for WPA2.
781 # 0 = disabled (default unless changed with the global okc parameter)
782 # 1 = enabled
783 #
784 # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
785 # hex without quotation, e.g., 0102030405)
786 # wep_tx_keyidx: Default WEP key index (TX) (0..3)
787 #
788 # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
789 # allowed. This is only used with RSN/WPA2.
790 # 0 = disabled (default)
791 # 1 = enabled
792 #peerkey=1
793 #
794 # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
795 # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
796 #
797 # Following fields are only used with internal EAP implementation.
798 # eap: space-separated list of accepted EAP methods
799 #       MD5 = EAP-MD5 (unsecure and does not generate keying material ->
800 #                       cannot be used with WPA; to be used as a Phase 2 method
801 #                       with EAP-PEAP or EAP-TTLS)
802 #       MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
803 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
804 #       OTP = EAP-OTP (cannot be used separately with WPA; to be used
805 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
806 #       GTC = EAP-GTC (cannot be used separately with WPA; to be used
807 #               as a Phase 2 method with EAP-PEAP or EAP-TTLS)
808 #       TLS = EAP-TLS (client and server certificate)
809 #       PEAP = EAP-PEAP (with tunnelled EAP authentication)
810 #       TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
811 #                        authentication)
812 #       If not set, all compiled in methods are allowed.
813 #
814 # identity: Identity string for EAP
815 #       This field is also used to configure user NAI for
816 #       EAP-PSK/PAX/SAKE/GPSK.
817 # anonymous_identity: Anonymous identity string for EAP (to be used as the
818 #       unencrypted identity with EAP types that support different tunnelled
819 #       identity, e.g., EAP-TTLS). This field can also be used with
820 #       EAP-SIM/AKA/AKA' to store the pseudonym identity.
821 # password: Password string for EAP. This field can include either the
822 #       plaintext password (using ASCII or hex string) or a NtPasswordHash
823 #       (16-byte MD4 hash of password) in hash:<32 hex digits> format.
824 #       NtPasswordHash can only be used when the password is for MSCHAPv2 or
825 #       MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
826 #       EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
827 #       PSK) is also configured using this field. For EAP-GPSK, this is a
828 #       variable length PSK. ext:<name of external password field> format can
829 #       be used to indicate that the password is stored in external storage.
830 # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
831 #       or more trusted CA certificates. If ca_cert and ca_path are not
832 #       included, server certificate will not be verified. This is insecure and
833 #       a trusted CA certificate should always be configured when using
834 #       EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
835 #       change when wpa_supplicant is run in the background.
836 #
837 #       Alternatively, this can be used to only perform matching of the server
838 #       certificate (SHA-256 hash of the DER encoded X.509 certificate). In
839 #       this case, the possible CA certificates in the server certificate chain
840 #       are ignored and only the server certificate is verified. This is
841 #       configured with the following format:
842 #       hash:://server/sha256/cert_hash_in_hex
843 #       For example: "hash://server/sha256/
844 #       5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
845 #
846 #       On Windows, trusted CA certificates can be loaded from the system
847 #       certificate store by setting this to cert_store://<name>, e.g.,
848 #       ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
849 #       Note that when running wpa_supplicant as an application, the user
850 #       certificate store (My user account) is used, whereas computer store
851 #       (Computer account) is used when running wpasvc as a service.
852 # ca_path: Directory path for CA certificate files (PEM). This path may
853 #       contain multiple CA certificates in OpenSSL format. Common use for this
854 #       is to point to system trusted CA list which is often installed into
855 #       directory like /etc/ssl/certs. If configured, these certificates are
856 #       added to the list of trusted CAs. ca_cert may also be included in that
857 #       case, but it is not required.
858 # client_cert: File path to client certificate file (PEM/DER)
859 #       Full path should be used since working directory may change when
860 #       wpa_supplicant is run in the background.
861 #       Alternatively, a named configuration blob can be used by setting this
862 #       to blob://<blob name>.
863 # private_key: File path to client private key file (PEM/DER/PFX)
864 #       When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
865 #       commented out. Both the private key and certificate will be read from
866 #       the PKCS#12 file in this case. Full path should be used since working
867 #       directory may change when wpa_supplicant is run in the background.
868 #       Windows certificate store can be used by leaving client_cert out and
869 #       configuring private_key in one of the following formats:
870 #       cert://substring_to_match
871 #       hash://certificate_thumbprint_in_hex
872 #       for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
873 #       Note that when running wpa_supplicant as an application, the user
874 #       certificate store (My user account) is used, whereas computer store
875 #       (Computer account) is used when running wpasvc as a service.
876 #       Alternatively, a named configuration blob can be used by setting this
877 #       to blob://<blob name>.
878 # private_key_passwd: Password for private key file (if left out, this will be
879 #       asked through control interface)
880 # dh_file: File path to DH/DSA parameters file (in PEM format)
881 #       This is an optional configuration file for setting parameters for an
882 #       ephemeral DH key exchange. In most cases, the default RSA
883 #       authentication does not use this configuration. However, it is possible
884 #       setup RSA to use ephemeral DH key exchange. In addition, ciphers with
885 #       DSA keys always use ephemeral DH keys. This can be used to achieve
886 #       forward secrecy. If the file is in DSA parameters format, it will be
887 #       automatically converted into DH params.
888 # subject_match: Substring to be matched against the subject of the
889 #       authentication server certificate. If this string is set, the server
890 #       sertificate is only accepted if it contains this string in the subject.
891 #       The subject string is in following format:
892 #       /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com
893 #       Note: Since this is a substring match, this cannot be used securily to
894 #       do a suffix match against a possible domain name in the CN entry. For
895 #       such a use case, domain_suffix_match or domain_match should be used
896 #       instead.
897 # altsubject_match: Semicolon separated string of entries to be matched against
898 #       the alternative subject name of the authentication server certificate.
899 #       If this string is set, the server sertificate is only accepted if it
900 #       contains one of the entries in an alternative subject name extension.
901 #       altSubjectName string is in following format: TYPE:VALUE
902 #       Example: EMAIL:server@example.com
903 #       Example: DNS:server.example.com;DNS:server2.example.com
904 #       Following types are supported: EMAIL, DNS, URI
905 # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
906 #       used as a suffix match requirement for the AAAserver certificate in
907 #       SubjectAltName dNSName element(s). If a matching dNSName is found, this
908 #       constraint is met. If no dNSName values are present, this constraint is
909 #       matched against SubjectName CN using same suffix match comparison.
910 #
911 #       Suffix match here means that the host/domain name is compared one label
912 #       at a time starting from the top-level domain and all the labels in
913 #       domain_suffix_match shall be included in the certificate. The
914 #       certificate may include additional sub-level labels in addition to the
915 #       required labels.
916 #
917 #       For example, domain_suffix_match=example.com would match
918 #       test.example.com but would not match test-example.com.
919 # domain_match: Constraint for server domain name
920 #       If set, this FQDN is used as a full match requirement for the
921 #       server certificate in SubjectAltName dNSName element(s). If a
922 #       matching dNSName is found, this constraint is met. If no dNSName
923 #       values are present, this constraint is matched against SubjectName CN
924 #       using same full match comparison. This behavior is similar to
925 #       domain_suffix_match, but has the requirement of a full match, i.e.,
926 #       no subdomains or wildcard matches are allowed. Case-insensitive
927 #       comparison is used, so "Example.com" matches "example.com", but would
928 #       not match "test.Example.com".
929 # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
930 #       (string with field-value pairs, e.g., "peapver=0" or
931 #       "peapver=1 peaplabel=1")
932 #       'peapver' can be used to force which PEAP version (0 or 1) is used.
933 #       'peaplabel=1' can be used to force new label, "client PEAP encryption",
934 #       to be used during key derivation when PEAPv1 or newer. Most existing
935 #       PEAPv1 implementation seem to be using the old label, "client EAP
936 #       encryption", and wpa_supplicant is now using that as the default value.
937 #       Some servers, e.g., Radiator, may require peaplabel=1 configuration to
938 #       interoperate with PEAPv1; see eap_testing.txt for more details.
939 #       'peap_outer_success=0' can be used to terminate PEAP authentication on
940 #       tunneled EAP-Success. This is required with some RADIUS servers that
941 #       implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
942 #       Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
943 #       include_tls_length=1 can be used to force wpa_supplicant to include
944 #       TLS Message Length field in all TLS messages even if they are not
945 #       fragmented.
946 #       sim_min_num_chal=3 can be used to configure EAP-SIM to require three
947 #       challenges (by default, it accepts 2 or 3)
948 #       result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
949 #       protected result indication.
950 #       'crypto_binding' option can be used to control PEAPv0 cryptobinding
951 #       behavior:
952 #        * 0 = do not use cryptobinding (default)
953 #        * 1 = use cryptobinding if server supports it
954 #        * 2 = require cryptobinding
955 #       EAP-WSC (WPS) uses following options: pin=<Device Password> or
956 #       pbc=1.
957 #
958 #       For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
959 #       used to configure a mode that allows EAP-Success (and EAP-Failure)
960 #       without going through authentication step. Some switches use such
961 #       sequence when forcing the port to be authorized/unauthorized or as a
962 #       fallback option if the authentication server is unreachable. By default,
963 #       wpa_supplicant discards such frames to protect against potential attacks
964 #       by rogue devices, but this option can be used to disable that protection
965 #       for cases where the server/authenticator does not need to be
966 #       authenticated.
967 # phase2: Phase2 (inner authentication with TLS tunnel) parameters
968 #       (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
969 #       "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
970 #       used to disable MSCHAPv2 password retry in authentication failure cases.
971 #
972 # TLS-based methods can use the following parameters to control TLS behavior
973 # (these are normally in the phase1 parameter, but can be used also in the
974 # phase2 parameter when EAP-TLS is used within the inner tunnel):
975 # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
976 #       TLS library, these may be disabled by default to enforce stronger
977 #       security)
978 # tls_disable_time_checks=1 - ignore certificate validity time (this requests
979 #       the TLS library to accept certificates even if they are not currently
980 #       valid, i.e., have expired or have not yet become valid; this should be
981 #       used only for testing purposes)
982 # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
983 # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
984 #       Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
985 #       as a workaround for broken authentication server implementations unless
986 #       EAP workarounds are disabled with eap_workaround=0.
987 #       For EAP-FAST, this must be set to 0 (or left unconfigured for the
988 #       default value to be used automatically).
989 # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
990 #       that have issues interoperating with updated TLS version)
991 # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
992 #       that have issues interoperating with updated TLS version)
993 #
994 # Following certificate/private key fields are used in inner Phase2
995 # authentication when using EAP-TTLS or EAP-PEAP.
996 # ca_cert2: File path to CA certificate file. This file can have one or more
997 #       trusted CA certificates. If ca_cert2 and ca_path2 are not included,
998 #       server certificate will not be verified. This is insecure and a trusted
999 #       CA certificate should always be configured.
1000 # ca_path2: Directory path for CA certificate files (PEM)
1001 # client_cert2: File path to client certificate file
1002 # private_key2: File path to client private key file
1003 # private_key2_passwd: Password for private key file
1004 # dh_file2: File path to DH/DSA parameters file (in PEM format)
1005 # subject_match2: Substring to be matched against the subject of the
1006 #       authentication server certificate. See subject_match for more details.
1007 # altsubject_match2: Semicolon separated string of entries to be matched
1008 #       against the alternative subject name of the authentication server
1009 #       certificate. See altsubject_match documentation for more details.
1010 # domain_suffix_match2: Constraint for server domain name. See
1011 #       domain_suffix_match for more details.
1012 #
1013 # fragment_size: Maximum EAP fragment size in bytes (default 1398).
1014 #       This value limits the fragment size for EAP methods that support
1015 #       fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1016 #       small enough to make the EAP messages fit in MTU of the network
1017 #       interface used for EAPOL. The default value is suitable for most
1018 #       cases.
1019 #
1020 # ocsp: Whether to use/require OCSP to check server certificate
1021 #       0 = do not use OCSP stapling (TLS certificate status extension)
1022 #       1 = try to use OCSP stapling, but not require response
1023 #       2 = require valid OCSP stapling response
1024 #
1025 # openssl_ciphers: OpenSSL specific cipher configuration
1026 #       This can be used to override the global openssl_ciphers configuration
1027 #       parameter (see above).
1028 #
1029 # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1030 #
1031 # EAP-FAST variables:
1032 # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1033 #       to create this file and write updates to it when PAC is being
1034 #       provisioned or refreshed. Full path to the file should be used since
1035 #       working directory may change when wpa_supplicant is run in the
1036 #       background. Alternatively, a named configuration blob can be used by
1037 #       setting this to blob://<blob name>
1038 # phase1: fast_provisioning option can be used to enable in-line provisioning
1039 #         of EAP-FAST credentials (PAC):
1040 #         0 = disabled,
1041 #         1 = allow unauthenticated provisioning,
1042 #         2 = allow authenticated provisioning,
1043 #         3 = allow both unauthenticated and authenticated provisioning
1044 #       fast_max_pac_list_len=<num> option can be used to set the maximum
1045 #               number of PAC entries to store in a PAC list (default: 10)
1046 #       fast_pac_format=binary option can be used to select binary format for
1047 #               storing PAC entries in order to save some space (the default
1048 #               text format uses about 2.5 times the size of minimal binary
1049 #               format)
1050 #
1051 # wpa_supplicant supports number of "EAP workarounds" to work around
1052 # interoperability issues with incorrectly behaving authentication servers.
1053 # These are enabled by default because some of the issues are present in large
1054 # number of authentication servers. Strict EAP conformance mode can be
1055 # configured by disabling workarounds with eap_workaround=0.
1056
1057 # Station inactivity limit
1058 #
1059 # If a station does not send anything in ap_max_inactivity seconds, an
1060 # empty data frame is sent to it in order to verify whether it is
1061 # still in range. If this frame is not ACKed, the station will be
1062 # disassociated and then deauthenticated. This feature is used to
1063 # clear station table of old entries when the STAs move out of the
1064 # range.
1065 #
1066 # The station can associate again with the AP if it is still in range;
1067 # this inactivity poll is just used as a nicer way of verifying
1068 # inactivity; i.e., client will not report broken connection because
1069 # disassociation frame is not sent immediately without first polling
1070 # the STA with a data frame.
1071 # default: 300 (i.e., 5 minutes)
1072 #ap_max_inactivity=300
1073
1074 # DTIM period in Beacon intervals for AP mode (default: 2)
1075 #dtim_period=2
1076
1077 # Beacon interval (default: 100 TU)
1078 #beacon_int=100
1079
1080 # MAC address policy
1081 # 0 = use permanent MAC address
1082 # 1 = use random MAC address for each ESS connection
1083 # 2 = like 1, but maintain OUI (with local admin bit set)
1084 #mac_addr=0
1085
1086 # disable_ht: Whether HT (802.11n) should be disabled.
1087 # 0 = HT enabled (if AP supports it)
1088 # 1 = HT disabled
1089 #
1090 # disable_ht40: Whether HT-40 (802.11n) should be disabled.
1091 # 0 = HT-40 enabled (if AP supports it)
1092 # 1 = HT-40 disabled
1093 #
1094 # disable_sgi: Whether SGI (short guard interval) should be disabled.
1095 # 0 = SGI enabled (if AP supports it)
1096 # 1 = SGI disabled
1097 #
1098 # disable_ldpc: Whether LDPC should be disabled.
1099 # 0 = LDPC enabled (if AP supports it)
1100 # 1 = LDPC disabled
1101 #
1102 # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1103 # 0 = 40 MHz tolerant (default)
1104 # 1 = 40 MHz intolerant
1105 #
1106 # ht_mcs:  Configure allowed MCS rates.
1107 #  Parsed as an array of bytes, in base-16 (ascii-hex)
1108 # ht_mcs=""                                   // Use all available (default)
1109 # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 "   // Use MCS 0-7 only
1110 # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 "   // Use MCS 0-15 only
1111 #
1112 # disable_max_amsdu:  Whether MAX_AMSDU should be disabled.
1113 # -1 = Do not make any changes.
1114 # 0  = Enable MAX-AMSDU if hardware supports it.
1115 # 1  = Disable AMSDU
1116 #
1117 # ampdu_factor: Maximum A-MPDU Length Exponent
1118 # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1119 #
1120 # ampdu_density:  Allow overriding AMPDU density configuration.
1121 #  Treated as hint by the kernel.
1122 # -1 = Do not make any changes.
1123 # 0-3 = Set AMPDU density (aka factor) to specified value.
1124
1125 # disable_vht: Whether VHT should be disabled.
1126 # 0 = VHT enabled (if AP supports it)
1127 # 1 = VHT disabled
1128 #
1129 # vht_capa: VHT capabilities to set in the override
1130 # vht_capa_mask: mask of VHT capabilities
1131 #
1132 # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1133 # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1134 #  0: MCS 0-7
1135 #  1: MCS 0-8
1136 #  2: MCS 0-9
1137 #  3: not supported
1138
1139 # Example blocks:
1140
1141 # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1142 network={
1143         ssid="simple"
1144         psk="very secret passphrase"
1145         priority=5
1146 }
1147
1148 # Same as previous, but request SSID-specific scanning (for APs that reject
1149 # broadcast SSID)
1150 network={
1151         ssid="second ssid"
1152         scan_ssid=1
1153         psk="very secret passphrase"
1154         priority=2
1155 }
1156
1157 # Only WPA-PSK is used. Any valid cipher combination is accepted.
1158 network={
1159         ssid="example"
1160         proto=WPA
1161         key_mgmt=WPA-PSK
1162         pairwise=CCMP TKIP
1163         group=CCMP TKIP WEP104 WEP40
1164         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1165         priority=2
1166 }
1167
1168 # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1169 network={
1170         ssid="example"
1171         proto=WPA
1172         key_mgmt=WPA-PSK
1173         pairwise=TKIP
1174         group=TKIP
1175         psk="not so secure passphrase"
1176         wpa_ptk_rekey=600
1177 }
1178
1179 # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1180 # or WEP40 as the group cipher will not be accepted.
1181 network={
1182         ssid="example"
1183         proto=RSN
1184         key_mgmt=WPA-EAP
1185         pairwise=CCMP TKIP
1186         group=CCMP TKIP
1187         eap=TLS
1188         identity="user@example.com"
1189         ca_cert="/etc/cert/ca.pem"
1190         client_cert="/etc/cert/user.pem"
1191         private_key="/etc/cert/user.prv"
1192         private_key_passwd="password"
1193         priority=1
1194 }
1195
1196 # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1197 # (e.g., Radiator)
1198 network={
1199         ssid="example"
1200         key_mgmt=WPA-EAP
1201         eap=PEAP
1202         identity="user@example.com"
1203         password="foobar"
1204         ca_cert="/etc/cert/ca.pem"
1205         phase1="peaplabel=1"
1206         phase2="auth=MSCHAPV2"
1207         priority=10
1208 }
1209
1210 # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1211 # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1212 network={
1213         ssid="example"
1214         key_mgmt=WPA-EAP
1215         eap=TTLS
1216         identity="user@example.com"
1217         anonymous_identity="anonymous@example.com"
1218         password="foobar"
1219         ca_cert="/etc/cert/ca.pem"
1220         priority=2
1221 }
1222
1223 # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1224 # use. Real identity is sent only within an encrypted TLS tunnel.
1225 network={
1226         ssid="example"
1227         key_mgmt=WPA-EAP
1228         eap=TTLS
1229         identity="user@example.com"
1230         anonymous_identity="anonymous@example.com"
1231         password="foobar"
1232         ca_cert="/etc/cert/ca.pem"
1233         phase2="auth=MSCHAPV2"
1234 }
1235
1236 # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1237 # authentication.
1238 network={
1239         ssid="example"
1240         key_mgmt=WPA-EAP
1241         eap=TTLS
1242         # Phase1 / outer authentication
1243         anonymous_identity="anonymous@example.com"
1244         ca_cert="/etc/cert/ca.pem"
1245         # Phase 2 / inner authentication
1246         phase2="autheap=TLS"
1247         ca_cert2="/etc/cert/ca2.pem"
1248         client_cert2="/etc/cer/user.pem"
1249         private_key2="/etc/cer/user.prv"
1250         private_key2_passwd="password"
1251         priority=2
1252 }
1253
1254 # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1255 # group cipher.
1256 network={
1257         ssid="example"
1258         bssid=00:11:22:33:44:55
1259         proto=WPA RSN
1260         key_mgmt=WPA-PSK WPA-EAP
1261         pairwise=CCMP
1262         group=CCMP
1263         psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1264 }
1265
1266 # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1267 # and all valid ciphers.
1268 network={
1269         ssid=00010203
1270         psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1271 }
1272
1273
1274 # EAP-SIM with a GSM SIM or USIM
1275 network={
1276         ssid="eap-sim-test"
1277         key_mgmt=WPA-EAP
1278         eap=SIM
1279         pin="1234"
1280         pcsc=""
1281 }
1282
1283
1284 # EAP-PSK
1285 network={
1286         ssid="eap-psk-test"
1287         key_mgmt=WPA-EAP
1288         eap=PSK
1289         anonymous_identity="eap_psk_user"
1290         password=06b4be19da289f475aa46a33cb793029
1291         identity="eap_psk_user@example.com"
1292 }
1293
1294
1295 # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1296 # EAP-TLS for authentication and key generation; require both unicast and
1297 # broadcast WEP keys.
1298 network={
1299         ssid="1x-test"
1300         key_mgmt=IEEE8021X
1301         eap=TLS
1302         identity="user@example.com"
1303         ca_cert="/etc/cert/ca.pem"
1304         client_cert="/etc/cert/user.pem"
1305         private_key="/etc/cert/user.prv"
1306         private_key_passwd="password"
1307         eapol_flags=3
1308 }
1309
1310
1311 # LEAP with dynamic WEP keys
1312 network={
1313         ssid="leap-example"
1314         key_mgmt=IEEE8021X
1315         eap=LEAP
1316         identity="user"
1317         password="foobar"
1318 }
1319
1320 # EAP-IKEv2 using shared secrets for both server and peer authentication
1321 network={
1322         ssid="ikev2-example"
1323         key_mgmt=WPA-EAP
1324         eap=IKEV2
1325         identity="user"
1326         password="foobar"
1327 }
1328
1329 # EAP-FAST with WPA (WPA or WPA2)
1330 network={
1331         ssid="eap-fast-test"
1332         key_mgmt=WPA-EAP
1333         eap=FAST
1334         anonymous_identity="FAST-000102030405"
1335         identity="username"
1336         password="password"
1337         phase1="fast_provisioning=1"
1338         pac_file="/etc/wpa_supplicant.eap-fast-pac"
1339 }
1340
1341 network={
1342         ssid="eap-fast-test"
1343         key_mgmt=WPA-EAP
1344         eap=FAST
1345         anonymous_identity="FAST-000102030405"
1346         identity="username"
1347         password="password"
1348         phase1="fast_provisioning=1"
1349         pac_file="blob://eap-fast-pac"
1350 }
1351
1352 # Plaintext connection (no WPA, no IEEE 802.1X)
1353 network={
1354         ssid="plaintext-test"
1355         key_mgmt=NONE
1356 }
1357
1358
1359 # Shared WEP key connection (no WPA, no IEEE 802.1X)
1360 network={
1361         ssid="static-wep-test"
1362         key_mgmt=NONE
1363         wep_key0="abcde"
1364         wep_key1=0102030405
1365         wep_key2="1234567890123"
1366         wep_tx_keyidx=0
1367         priority=5
1368 }
1369
1370
1371 # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1372 # IEEE 802.11 authentication
1373 network={
1374         ssid="static-wep-test2"
1375         key_mgmt=NONE
1376         wep_key0="abcde"
1377         wep_key1=0102030405
1378         wep_key2="1234567890123"
1379         wep_tx_keyidx=0
1380         priority=5
1381         auth_alg=SHARED
1382 }
1383
1384
1385 # IBSS/ad-hoc network with RSN
1386 network={
1387         ssid="ibss-rsn"
1388         key_mgmt=WPA-PSK
1389         proto=RSN
1390         psk="12345678"
1391         mode=1
1392         frequency=2412
1393         pairwise=CCMP
1394         group=CCMP
1395 }
1396
1397 # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
1398 network={
1399         ssid="test adhoc"
1400         mode=1
1401         frequency=2412
1402         proto=WPA
1403         key_mgmt=WPA-NONE
1404         pairwise=NONE
1405         group=TKIP
1406         psk="secret passphrase"
1407 }
1408
1409 # open mesh network
1410 network={
1411         ssid="test mesh"
1412         mode=5
1413         frequency=2437
1414         key_mgmt=NONE
1415 }
1416
1417 # secure (SAE + AMPE) network
1418 network={
1419         ssid="secure mesh"
1420         mode=5
1421         frequency=2437
1422         key_mgmt=SAE
1423         psk="very secret passphrase"
1424 }
1425
1426
1427 # Catch all example that allows more or less all configuration modes
1428 network={
1429         ssid="example"
1430         scan_ssid=1
1431         key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1432         pairwise=CCMP TKIP
1433         group=CCMP TKIP WEP104 WEP40
1434         psk="very secret passphrase"
1435         eap=TTLS PEAP TLS
1436         identity="user@example.com"
1437         password="foobar"
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"
1442         phase1="peaplabel=0"
1443 }
1444
1445 # Example of EAP-TLS with smartcard (openssl engine)
1446 network={
1447         ssid="example"
1448         key_mgmt=WPA-EAP
1449         eap=TLS
1450         proto=RSN
1451         pairwise=CCMP TKIP
1452         group=CCMP TKIP
1453         identity="user@example.com"
1454         ca_cert="/etc/cert/ca.pem"
1455         client_cert="/etc/cert/user.pem"
1456
1457         engine=1
1458
1459         # The engine configured here must be available. Look at
1460         # OpenSSL engine support in the global section.
1461         # The key available through the engine must be the private key
1462         # matching the client certificate configured above.
1463
1464         # use the opensc engine
1465         #engine_id="opensc"
1466         #key_id="45"
1467
1468         # use the pkcs11 engine
1469         engine_id="pkcs11"
1470         key_id="id_45"
1471
1472         # Optional PIN configuration; this can be left out and PIN will be
1473         # asked through the control interface
1474         pin="1234"
1475 }
1476
1477 # Example configuration showing how to use an inlined blob as a CA certificate
1478 # data instead of using external file
1479 network={
1480         ssid="example"
1481         key_mgmt=WPA-EAP
1482         eap=TTLS
1483         identity="user@example.com"
1484         anonymous_identity="anonymous@example.com"
1485         password="foobar"
1486         ca_cert="blob://exampleblob"
1487         priority=20
1488 }
1489
1490 blob-base64-exampleblob={
1491 SGVsbG8gV29ybGQhCg==
1492 }
1493
1494
1495 # Wildcard match for SSID (plaintext APs only). This example select any
1496 # open AP regardless of its SSID.
1497 network={
1498         key_mgmt=NONE
1499 }
1500
1501 # Example configuration blacklisting two APs - these will be ignored
1502 # for this network.
1503 network={
1504         ssid="example"
1505         psk="very secret passphrase"
1506         bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1507 }
1508
1509 # Example configuration limiting AP selection to a specific set of APs;
1510 # any other AP not matching the masked address will be ignored.
1511 network={
1512         ssid="example"
1513         psk="very secret passphrase"
1514         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
1515 }
1516
1517 # Example config file that will only scan on channel 36.
1518 freq_list=5180
1519 network={
1520         key_mgmt=NONE
1521 }
1522
1523
1524 # Example MACsec configuration
1525 #network={
1526 #       key_mgmt=IEEE8021X
1527 #       eap=TTLS
1528 #       phase2="auth=PAP"
1529 #       anonymous_identity="anonymous@example.com"
1530 #       identity="user@example.com"
1531 #       password="secretr"
1532 #       ca_cert="/etc/cert/ca.pem"
1533 #       eapol_flags=0
1534 #       macsec_policy=1
1535 #}