wpa_supplicant.conf revision 1.2 1 1.1 christos ##### Example wpa_supplicant configuration file ###############################
2 1.1 christos #
3 1.1 christos # This file describes configuration file format and lists all available option.
4 1.1 christos # Please also take a look at simpler configuration examples in 'examples'
5 1.1 christos # subdirectory.
6 1.1 christos #
7 1.1 christos # Empty lines and lines starting with # are ignored
8 1.1 christos
9 1.1 christos # NOTE! This file may contain password information and should probably be made
10 1.1 christos # readable only by root user on multiuser systems.
11 1.1 christos
12 1.1 christos # Note: All file paths in this configuration file should use full (absolute,
13 1.1 christos # not relative to working directory) path in order to allow working directory
14 1.1 christos # to be changed. This can happen if wpa_supplicant is run in the background.
15 1.1 christos
16 1.1 christos # Whether to allow wpa_supplicant to update (overwrite) configuration
17 1.1 christos #
18 1.1 christos # This option can be used to allow wpa_supplicant to overwrite configuration
19 1.1 christos # file whenever configuration is changed (e.g., new network block is added with
20 1.1 christos # wpa_cli or wpa_gui, or a password is changed). This is required for
21 1.1 christos # wpa_cli/wpa_gui to be able to store the configuration changes permanently.
22 1.1 christos # Please note that overwriting configuration file will remove the comments from
23 1.1 christos # it.
24 1.1 christos #update_config=1
25 1.1 christos
26 1.1 christos # global configuration (shared by all network blocks)
27 1.1 christos #
28 1.1 christos # Parameters for the control interface. If this is specified, wpa_supplicant
29 1.1 christos # will open a control interface that is available for external programs to
30 1.1 christos # manage wpa_supplicant. The meaning of this string depends on which control
31 1.2 christos # interface mechanism is used. For all cases, the existence of this parameter
32 1.1 christos # in configuration is used to determine whether the control interface is
33 1.1 christos # enabled.
34 1.1 christos #
35 1.1 christos # For UNIX domain sockets (default on Linux and BSD): This is a directory that
36 1.1 christos # will be created for UNIX domain sockets for listening to requests from
37 1.1 christos # external programs (CLI/GUI, etc.) for status information and configuration.
38 1.1 christos # The socket file will be named based on the interface name, so multiple
39 1.1 christos # wpa_supplicant processes can be run at the same time if more than one
40 1.1 christos # interface is used.
41 1.1 christos # /var/run/wpa_supplicant is the recommended directory for sockets and by
42 1.1 christos # default, wpa_cli will use it when trying to connect with wpa_supplicant.
43 1.1 christos #
44 1.1 christos # Access control for the control interface can be configured by setting the
45 1.1 christos # directory to allow only members of a group to use sockets. This way, it is
46 1.1 christos # possible to run wpa_supplicant as root (since it needs to change network
47 1.1 christos # configuration and open raw sockets) and still allow GUI/CLI components to be
48 1.1 christos # run as non-root users. However, since the control interface can be used to
49 1.1 christos # change the network configuration, this access needs to be protected in many
50 1.1 christos # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you
51 1.1 christos # want to allow non-root users to use the control interface, add a new group
52 1.1 christos # and change this value to match with that group. Add users that should have
53 1.1 christos # control interface access to this group. If this variable is commented out or
54 1.1 christos # not included in the configuration file, group will not be changed from the
55 1.1 christos # value it got by default when the directory or socket was created.
56 1.1 christos #
57 1.1 christos # When configuring both the directory and group, use following format:
58 1.1 christos # DIR=/var/run/wpa_supplicant GROUP=wheel
59 1.1 christos # DIR=/var/run/wpa_supplicant GROUP=0
60 1.1 christos # (group can be either group name or gid)
61 1.1 christos #
62 1.1 christos # For UDP connections (default on Windows): The value will be ignored. This
63 1.1 christos # variable is just used to select that the control interface is to be created.
64 1.1 christos # The value can be set to, e.g., udp (ctrl_interface=udp)
65 1.1 christos #
66 1.1 christos # For Windows Named Pipe: This value can be used to set the security descriptor
67 1.1 christos # for controlling access to the control interface. Security descriptor can be
68 1.1 christos # set using Security Descriptor String Format (see http://msdn.microsoft.com/
69 1.1 christos # library/default.asp?url=/library/en-us/secauthz/security/
70 1.1 christos # security_descriptor_string_format.asp). The descriptor string needs to be
71 1.1 christos # prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty
72 1.1 christos # DACL (which will reject all connections). See README-Windows.txt for more
73 1.1 christos # information about SDDL string format.
74 1.1 christos #
75 1.1 christos ctrl_interface=/var/run/wpa_supplicant
76 1.1 christos
77 1.1 christos # IEEE 802.1X/EAPOL version
78 1.1 christos # wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines
79 1.1 christos # EAPOL version 2. However, there are many APs that do not handle the new
80 1.1 christos # version number correctly (they seem to drop the frames completely). In order
81 1.1 christos # to make wpa_supplicant interoperate with these APs, the version number is set
82 1.1 christos # to 1 by default. This configuration value can be used to set it to the new
83 1.1 christos # version (2).
84 1.2 christos # Note: When using MACsec, eapol_version shall be set to 3, which is
85 1.2 christos # defined in IEEE Std 802.1X-2010.
86 1.1 christos eapol_version=1
87 1.1 christos
88 1.1 christos # AP scanning/selection
89 1.1 christos # By default, wpa_supplicant requests driver to perform AP scanning and then
90 1.1 christos # uses the scan results to select a suitable AP. Another alternative is to
91 1.1 christos # allow the driver to take care of AP scanning and selection and use
92 1.1 christos # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
93 1.1 christos # information from the driver.
94 1.1 christos # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
95 1.1 christos # the currently enabled networks are found, a new network (IBSS or AP mode
96 1.1 christos # operation) may be initialized (if configured) (default)
97 1.1 christos # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
98 1.1 christos # parameters (e.g., WPA IE generation); this mode can also be used with
99 1.1 christos # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
100 1.1 christos # APs (i.e., external program needs to control association). This mode must
101 1.2 christos # also be used when using wired Ethernet drivers (including MACsec).
102 1.1 christos # 2: like 0, but associate with APs using security policy and SSID (but not
103 1.1 christos # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
104 1.1 christos # enable operation with hidden SSIDs and optimized roaming; in this mode,
105 1.1 christos # the network blocks in the configuration file are tried one by one until
106 1.1 christos # the driver reports successful association; each network block should have
107 1.1 christos # explicit security policy (i.e., only one option in the lists) for
108 1.1 christos # key_mgmt, pairwise, group, proto variables
109 1.2 christos # Note: ap_scan=2 should not be used with the nl80211 driver interface (the
110 1.2 christos # current Linux interface). ap_scan=1 is optimized work working with nl80211.
111 1.2 christos # For finding networks using hidden SSID, scan_ssid=1 in the network block can
112 1.2 christos # be used with nl80211.
113 1.1 christos # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
114 1.1 christos # created immediately regardless of scan results. ap_scan=1 mode will first try
115 1.1 christos # to scan for existing networks and only if no matches with the enabled
116 1.1 christos # networks are found, a new IBSS or AP mode network is created.
117 1.1 christos ap_scan=1
118 1.1 christos
119 1.2 christos # Whether to force passive scan for network connection
120 1.2 christos #
121 1.2 christos # By default, scans will send out Probe Request frames on channels that allow
122 1.2 christos # active scanning. This advertise the local station to the world. Normally this
123 1.2 christos # is fine, but users may wish to do passive scanning where the radio should only
124 1.2 christos # listen quietly for Beacon frames and not send any Probe Request frames. Actual
125 1.2 christos # functionality may be driver dependent.
126 1.2 christos #
127 1.2 christos # This parameter can be used to force only passive scanning to be used
128 1.2 christos # for network connection cases. It should be noted that this will slow
129 1.2 christos # down scan operations and reduce likelihood of finding the AP. In
130 1.2 christos # addition, some use cases will override this due to functional
131 1.2 christos # requirements, e.g., for finding an AP that uses hidden SSID
132 1.2 christos # (scan_ssid=1) or P2P device discovery.
133 1.2 christos #
134 1.2 christos # 0: Do normal scans (allow active scans) (default)
135 1.2 christos # 1: Do passive scans.
136 1.2 christos #passive_scan=0
137 1.2 christos
138 1.2 christos # MPM residency
139 1.2 christos # By default, wpa_supplicant implements the mesh peering manager (MPM) for an
140 1.2 christos # open mesh. However, if the driver can implement the MPM, you may set this to
141 1.2 christos # 0 to use the driver version. When AMPE is enabled, the wpa_supplicant MPM is
142 1.2 christos # always used.
143 1.2 christos # 0: MPM lives in the driver
144 1.2 christos # 1: wpa_supplicant provides an MPM which handles peering (default)
145 1.2 christos #user_mpm=1
146 1.2 christos
147 1.2 christos # Maximum number of peer links (0-255; default: 99)
148 1.2 christos # Maximum number of mesh peering currently maintained by the STA.
149 1.2 christos #max_peer_links=99
150 1.2 christos
151 1.2 christos # Timeout in seconds to detect STA inactivity (default: 300 seconds)
152 1.2 christos #
153 1.2 christos # This timeout value is used in mesh STA to clean up inactive stations.
154 1.2 christos #mesh_max_inactivity=300
155 1.2 christos
156 1.2 christos # cert_in_cb - Whether to include a peer certificate dump in events
157 1.2 christos # This controls whether peer certificates for authentication server and
158 1.2 christos # its certificate chain are included in EAP peer certificate events. This is
159 1.2 christos # enabled by default.
160 1.2 christos #cert_in_cb=1
161 1.2 christos
162 1.1 christos # EAP fast re-authentication
163 1.1 christos # By default, fast re-authentication is enabled for all EAP methods that
164 1.1 christos # support it. This variable can be used to disable fast re-authentication.
165 1.1 christos # Normally, there is no need to disable this.
166 1.1 christos fast_reauth=1
167 1.1 christos
168 1.1 christos # OpenSSL Engine support
169 1.2 christos # These options can be used to load OpenSSL engines in special or legacy
170 1.2 christos # modes.
171 1.1 christos # The two engines that are supported currently are shown below:
172 1.1 christos # They are both from the opensc project (http://www.opensc.org/)
173 1.2 christos # By default the PKCS#11 engine is loaded if the client_cert or
174 1.2 christos # private_key option appear to be a PKCS#11 URI, and these options
175 1.2 christos # should not need to be used explicitly.
176 1.1 christos # make the opensc engine available
177 1.1 christos #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
178 1.1 christos # make the pkcs11 engine available
179 1.1 christos #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
180 1.1 christos # configure the path to the pkcs11 module required by the pkcs11 engine
181 1.1 christos #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
182 1.1 christos
183 1.2 christos # OpenSSL cipher string
184 1.2 christos #
185 1.2 christos # This is an OpenSSL specific configuration option for configuring the default
186 1.2 christos # ciphers. If not set, the value configured at build time ("DEFAULT:!EXP:!LOW"
187 1.2 christos # by default) is used.
188 1.2 christos # See https://www.openssl.org/docs/apps/ciphers.html for OpenSSL documentation
189 1.2 christos # on cipher suite configuration. This is applicable only if wpa_supplicant is
190 1.2 christos # built to use OpenSSL.
191 1.2 christos #openssl_ciphers=DEFAULT:!EXP:!LOW
192 1.2 christos
193 1.1 christos # Dynamic EAP methods
194 1.1 christos # If EAP methods were built dynamically as shared object files, they need to be
195 1.1 christos # loaded here before being used in the network blocks. By default, EAP methods
196 1.1 christos # are included statically in the build, so these lines are not needed
197 1.1 christos #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
198 1.1 christos #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
199 1.1 christos
200 1.1 christos # Driver interface parameters
201 1.2 christos # This field can be used to configure arbitrary driver interface parameters. The
202 1.1 christos # format is specific to the selected driver interface. This field is not used
203 1.1 christos # in most cases.
204 1.1 christos #driver_param="field=value"
205 1.1 christos
206 1.1 christos # Country code
207 1.1 christos # The ISO/IEC alpha2 country code for the country in which this device is
208 1.1 christos # currently operating.
209 1.1 christos #country=US
210 1.1 christos
211 1.1 christos # Maximum lifetime for PMKSA in seconds; default 43200
212 1.1 christos #dot11RSNAConfigPMKLifetime=43200
213 1.1 christos # Threshold for reauthentication (percentage of PMK lifetime); default 70
214 1.1 christos #dot11RSNAConfigPMKReauthThreshold=70
215 1.1 christos # Timeout for security association negotiation in seconds; default 60
216 1.1 christos #dot11RSNAConfigSATimeout=60
217 1.1 christos
218 1.1 christos # Wi-Fi Protected Setup (WPS) parameters
219 1.1 christos
220 1.1 christos # Universally Unique IDentifier (UUID; see RFC 4122) of the device
221 1.2 christos # If not configured, UUID will be generated based on the mechanism selected with
222 1.2 christos # the auto_uuid parameter.
223 1.1 christos #uuid=12345678-9abc-def0-1234-56789abcdef0
224 1.1 christos
225 1.2 christos # Automatic UUID behavior
226 1.2 christos # 0 = generate static value based on the local MAC address (default)
227 1.2 christos # 1 = generate a random UUID every time wpa_supplicant starts
228 1.2 christos #auto_uuid=0
229 1.2 christos
230 1.1 christos # Device Name
231 1.1 christos # User-friendly description of device; up to 32 octets encoded in UTF-8
232 1.1 christos #device_name=Wireless Client
233 1.1 christos
234 1.1 christos # Manufacturer
235 1.1 christos # The manufacturer of the device (up to 64 ASCII characters)
236 1.1 christos #manufacturer=Company
237 1.1 christos
238 1.1 christos # Model Name
239 1.1 christos # Model of the device (up to 32 ASCII characters)
240 1.1 christos #model_name=cmodel
241 1.1 christos
242 1.1 christos # Model Number
243 1.1 christos # Additional device description (up to 32 ASCII characters)
244 1.1 christos #model_number=123
245 1.1 christos
246 1.1 christos # Serial Number
247 1.1 christos # Serial number of the device (up to 32 characters)
248 1.1 christos #serial_number=12345
249 1.1 christos
250 1.1 christos # Primary Device Type
251 1.1 christos # Used format: <categ>-<OUI>-<subcateg>
252 1.1 christos # categ = Category as an integer value
253 1.1 christos # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
254 1.1 christos # default WPS OUI
255 1.1 christos # subcateg = OUI-specific Sub Category as an integer value
256 1.1 christos # Examples:
257 1.1 christos # 1-0050F204-1 (Computer / PC)
258 1.1 christos # 1-0050F204-2 (Computer / Server)
259 1.1 christos # 5-0050F204-1 (Storage / NAS)
260 1.1 christos # 6-0050F204-1 (Network Infrastructure / AP)
261 1.1 christos #device_type=1-0050F204-1
262 1.1 christos
263 1.1 christos # OS Version
264 1.1 christos # 4-octet operating system version number (hex string)
265 1.1 christos #os_version=01020300
266 1.1 christos
267 1.1 christos # Config Methods
268 1.1 christos # List of the supported configuration methods
269 1.1 christos # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
270 1.2 christos # nfc_interface push_button keypad virtual_display physical_display
271 1.2 christos # virtual_push_button physical_push_button
272 1.2 christos # For WSC 1.0:
273 1.1 christos #config_methods=label display push_button keypad
274 1.2 christos # For WSC 2.0:
275 1.2 christos #config_methods=label virtual_display virtual_push_button keypad
276 1.1 christos
277 1.1 christos # Credential processing
278 1.1 christos # 0 = process received credentials internally (default)
279 1.1 christos # 1 = do not process received credentials; just pass them over ctrl_iface to
280 1.1 christos # external program(s)
281 1.1 christos # 2 = process received credentials internally and pass them over ctrl_iface
282 1.1 christos # to external program(s)
283 1.1 christos #wps_cred_processing=0
284 1.1 christos
285 1.2 christos # Whether to enable SAE (WPA3-Personal transition mode) automatically for
286 1.2 christos # WPA2-PSK credentials received using WPS.
287 1.2 christos # 0 = only add the explicitly listed WPA2-PSK configuration (default)
288 1.2 christos # 1 = add both the WPA2-PSK and SAE configuration and enable PMF so that the
289 1.2 christos # station gets configured in WPA3-Personal transition mode (supports both
290 1.2 christos # WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
291 1.2 christos #wps_cred_add_sae=0
292 1.2 christos
293 1.2 christos # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
294 1.2 christos # The vendor attribute contents to be added in M1 (hex string)
295 1.2 christos #wps_vendor_ext_m1=000137100100020001
296 1.2 christos
297 1.2 christos # NFC password token for WPS
298 1.2 christos # These parameters can be used to configure a fixed NFC password token for the
299 1.2 christos # station. This can be generated, e.g., with nfc_pw_token. When these
300 1.2 christos # parameters are used, the station is assumed to be deployed with a NFC tag
301 1.2 christos # that includes the matching NFC password token (e.g., written based on the
302 1.2 christos # NDEF record from nfc_pw_token).
303 1.2 christos #
304 1.2 christos #wps_nfc_dev_pw_id: Device Password ID (16..65535)
305 1.2 christos #wps_nfc_dh_pubkey: Hexdump of DH Public Key
306 1.2 christos #wps_nfc_dh_privkey: Hexdump of DH Private Key
307 1.2 christos #wps_nfc_dev_pw: Hexdump of Device Password
308 1.2 christos
309 1.2 christos # Priority for the networks added through WPS
310 1.2 christos # This priority value will be set to each network profile that is added
311 1.2 christos # by executing the WPS protocol.
312 1.2 christos #wps_priority=0
313 1.2 christos
314 1.1 christos # Maximum number of BSS entries to keep in memory
315 1.1 christos # Default: 200
316 1.1 christos # This can be used to limit memory use on the BSS entries (cached scan
317 1.1 christos # results). A larger value may be needed in environments that have huge number
318 1.1 christos # of APs when using ap_scan=1 mode.
319 1.1 christos #bss_max_count=200
320 1.1 christos
321 1.2 christos # BSS expiration age in seconds. A BSS will be removed from the local cache
322 1.2 christos # if it is not in use and has not been seen for this time. Default is 180.
323 1.2 christos #bss_expiration_age=180
324 1.2 christos
325 1.2 christos # BSS expiration after number of scans. A BSS will be removed from the local
326 1.2 christos # cache if it is not seen in this number of scans.
327 1.2 christos # Default is 2.
328 1.2 christos #bss_expiration_scan_count=2
329 1.2 christos
330 1.2 christos # Automatic scan
331 1.2 christos # This is an optional set of parameters for automatic scanning
332 1.2 christos # within an interface in following format:
333 1.2 christos #autoscan=<autoscan module name>:<module parameters>
334 1.2 christos # autoscan is like bgscan but on disconnected or inactive state.
335 1.2 christos # For instance, on exponential module parameters would be <base>:<limit>
336 1.2 christos #autoscan=exponential:3:300
337 1.2 christos # Which means a delay between scans on a base exponential of 3,
338 1.2 christos # up to the limit of 300 seconds (3, 9, 27 ... 300)
339 1.2 christos # For periodic module, parameters would be <fixed interval>
340 1.2 christos #autoscan=periodic:30
341 1.2 christos # So a delay of 30 seconds will be applied between each scan.
342 1.2 christos # Note: If sched_scan_plans are configured and supported by the driver,
343 1.2 christos # autoscan is ignored.
344 1.1 christos
345 1.1 christos # filter_ssids - SSID-based scan result filtering
346 1.1 christos # 0 = do not filter scan results (default)
347 1.1 christos # 1 = only include configured SSIDs in scan results/BSS table
348 1.1 christos #filter_ssids=0
349 1.1 christos
350 1.2 christos # Password (and passphrase, etc.) backend for external storage
351 1.2 christos # format: <backend name>[:<optional backend parameters>]
352 1.2 christos #ext_password_backend=test:pw1=password|pw2=testing
353 1.2 christos
354 1.2 christos
355 1.2 christos # Disable P2P functionality
356 1.2 christos # p2p_disabled=1
357 1.2 christos
358 1.2 christos # Timeout in seconds to detect STA inactivity (default: 300 seconds)
359 1.2 christos #
360 1.2 christos # This timeout value is used in P2P GO mode to clean up
361 1.2 christos # inactive stations.
362 1.2 christos #p2p_go_max_inactivity=300
363 1.2 christos
364 1.2 christos # Passphrase length (8..63) for P2P GO
365 1.2 christos #
366 1.2 christos # This parameter controls the length of the random passphrase that is
367 1.2 christos # generated at the GO. Default: 8.
368 1.2 christos #p2p_passphrase_len=8
369 1.2 christos
370 1.2 christos # Extra delay between concurrent P2P search iterations
371 1.2 christos #
372 1.2 christos # This value adds extra delay in milliseconds between concurrent search
373 1.2 christos # iterations to make p2p_find friendlier to concurrent operations by avoiding
374 1.2 christos # it from taking 100% of radio resources. The default value is 500 ms.
375 1.2 christos #p2p_search_delay=500
376 1.2 christos
377 1.2 christos # Opportunistic Key Caching (also known as Proactive Key Caching) default
378 1.2 christos # This parameter can be used to set the default behavior for the
379 1.2 christos # proactive_key_caching parameter. By default, OKC is disabled unless enabled
380 1.2 christos # with the global okc=1 parameter or with the per-network
381 1.2 christos # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
382 1.2 christos # can be disabled with per-network proactive_key_caching=0 parameter.
383 1.2 christos #okc=0
384 1.2 christos
385 1.2 christos # Protected Management Frames default
386 1.2 christos # This parameter can be used to set the default behavior for the ieee80211w
387 1.2 christos # parameter for RSN networks. By default, PMF is disabled unless enabled with
388 1.2 christos # the global pmf=1/2 parameter or with the per-network ieee80211w=1/2 parameter.
389 1.2 christos # With pmf=1/2, PMF is enabled/required by default, but can be disabled with the
390 1.2 christos # per-network ieee80211w parameter. This global default value does not apply
391 1.2 christos # for non-RSN networks (key_mgmt=NONE) since PMF is available only when using
392 1.2 christos # RSN.
393 1.2 christos #pmf=0
394 1.2 christos
395 1.2 christos # Enabled SAE finite cyclic groups in preference order
396 1.2 christos # By default (if this parameter is not set), the mandatory group 19 (ECC group
397 1.2 christos # defined over a 256-bit prime order field, NIST P-256) is preferred and groups
398 1.2 christos # 20 (NIST P-384) and 21 (NIST P-521) are also enabled. If this parameter is
399 1.2 christos # set, the groups will be tried in the indicated order.
400 1.2 christos # The group values are listed in the IANA registry:
401 1.2 christos # http://www.iana.org/assignments/ipsec-registry/ipsec-registry.xml#ipsec-registry-9
402 1.2 christos # Note that groups 1, 2, 5, 22, 23, and 24 should not be used in production
403 1.2 christos # purposes due limited security (see RFC 8247). Groups that are not as strong as
404 1.2 christos # group 19 (ECC, NIST P-256) are unlikely to be useful for production use cases
405 1.2 christos # since all implementations are required to support group 19.
406 1.2 christos #sae_groups=19 20 21
407 1.2 christos
408 1.2 christos # Default value for DTIM period (if not overridden in network block)
409 1.2 christos #dtim_period=2
410 1.2 christos
411 1.2 christos # Default value for Beacon interval (if not overridden in network block)
412 1.2 christos #beacon_int=100
413 1.2 christos
414 1.2 christos # Additional vendor specific elements for Beacon and Probe Response frames
415 1.2 christos # This parameter can be used to add additional vendor specific element(s) into
416 1.2 christos # the end of the Beacon and Probe Response frames. The format for these
417 1.2 christos # element(s) is a hexdump of the raw information elements (id+len+payload for
418 1.2 christos # one or more elements). This is used in AP and P2P GO modes.
419 1.2 christos #ap_vendor_elements=dd0411223301
420 1.2 christos
421 1.2 christos # Ignore scan results older than request
422 1.2 christos #
423 1.2 christos # The driver may have a cache of scan results that makes it return
424 1.2 christos # information that is older than our scan trigger. This parameter can
425 1.2 christos # be used to configure such old information to be ignored instead of
426 1.2 christos # allowing it to update the internal BSS table.
427 1.2 christos #ignore_old_scan_res=0
428 1.2 christos
429 1.2 christos # scan_cur_freq: Whether to scan only the current frequency
430 1.2 christos # 0: Scan all available frequencies. (Default)
431 1.2 christos # 1: Scan current operating frequency if another VIF on the same radio
432 1.2 christos # is already associated.
433 1.2 christos
434 1.2 christos # MAC address policy default
435 1.2 christos # 0 = use permanent MAC address
436 1.2 christos # 1 = use random MAC address for each ESS connection
437 1.2 christos # 2 = like 1, but maintain OUI (with local admin bit set)
438 1.2 christos #
439 1.2 christos # By default, permanent MAC address is used unless policy is changed by
440 1.2 christos # the per-network mac_addr parameter. Global mac_addr=1 can be used to
441 1.2 christos # change this default behavior.
442 1.2 christos #mac_addr=0
443 1.2 christos
444 1.2 christos # Lifetime of random MAC address in seconds (default: 60)
445 1.2 christos #rand_addr_lifetime=60
446 1.2 christos
447 1.2 christos # MAC address policy for pre-association operations (scanning, ANQP)
448 1.2 christos # 0 = use permanent MAC address
449 1.2 christos # 1 = use random MAC address
450 1.2 christos # 2 = like 1, but maintain OUI (with local admin bit set)
451 1.2 christos #preassoc_mac_addr=0
452 1.2 christos
453 1.2 christos # MAC address policy for GAS operations
454 1.2 christos # 0 = use permanent MAC address
455 1.2 christos # 1 = use random MAC address
456 1.2 christos # 2 = like 1, but maintain OUI (with local admin bit set)
457 1.2 christos #gas_rand_mac_addr=0
458 1.2 christos
459 1.2 christos # Lifetime of GAS random MAC address in seconds (default: 60)
460 1.2 christos #gas_rand_addr_lifetime=60
461 1.2 christos
462 1.2 christos # Interworking (IEEE 802.11u)
463 1.2 christos
464 1.2 christos # Enable Interworking
465 1.2 christos # interworking=1
466 1.2 christos
467 1.2 christos # Enable P2P GO advertisement of Interworking
468 1.2 christos # go_interworking=1
469 1.2 christos
470 1.2 christos # P2P GO Interworking: Access Network Type
471 1.2 christos # 0 = Private network
472 1.2 christos # 1 = Private network with guest access
473 1.2 christos # 2 = Chargeable public network
474 1.2 christos # 3 = Free public network
475 1.2 christos # 4 = Personal device network
476 1.2 christos # 5 = Emergency services only network
477 1.2 christos # 14 = Test or experimental
478 1.2 christos # 15 = Wildcard
479 1.2 christos #go_access_network_type=0
480 1.2 christos
481 1.2 christos # P2P GO Interworking: Whether the network provides connectivity to the Internet
482 1.2 christos # 0 = Unspecified
483 1.2 christos # 1 = Network provides connectivity to the Internet
484 1.2 christos #go_internet=1
485 1.2 christos
486 1.2 christos # P2P GO Interworking: Group Venue Info (optional)
487 1.2 christos # The available values are defined in IEEE Std 802.11-2016, 9.4.1.35.
488 1.2 christos # Example values (group,type):
489 1.2 christos # 0,0 = Unspecified
490 1.2 christos # 1,7 = Convention Center
491 1.2 christos # 1,13 = Coffee Shop
492 1.2 christos # 2,0 = Unspecified Business
493 1.2 christos # 7,1 Private Residence
494 1.2 christos #go_venue_group=7
495 1.2 christos #go_venue_type=1
496 1.2 christos
497 1.2 christos # Homogenous ESS identifier
498 1.2 christos # If this is set, scans will be used to request response only from BSSes
499 1.2 christos # belonging to the specified Homogeneous ESS. This is used only if interworking
500 1.2 christos # is enabled.
501 1.2 christos # hessid=00:11:22:33:44:55
502 1.2 christos
503 1.2 christos # Automatic network selection behavior
504 1.2 christos # 0 = do not automatically go through Interworking network selection
505 1.2 christos # (i.e., require explicit interworking_select command for this; default)
506 1.2 christos # 1 = perform Interworking network selection if one or more
507 1.2 christos # credentials have been configured and scan did not find a
508 1.2 christos # matching network block
509 1.2 christos #auto_interworking=0
510 1.2 christos
511 1.2 christos # GAS Address3 field behavior
512 1.2 christos # 0 = P2P specification (Address3 = AP BSSID); default
513 1.2 christos # 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
514 1.2 christos # sent to not-associated AP; if associated, AP BSSID)
515 1.2 christos #gas_address3=0
516 1.2 christos
517 1.2 christos # Publish fine timing measurement (FTM) responder functionality in
518 1.2 christos # the Extended Capabilities element bit 70.
519 1.2 christos # Controls whether FTM responder functionality will be published by AP/STA.
520 1.2 christos # Note that actual FTM responder operation is managed outside wpa_supplicant.
521 1.2 christos # 0 = Do not publish; default
522 1.2 christos # 1 = Publish
523 1.2 christos #ftm_responder=0
524 1.2 christos
525 1.2 christos # Publish fine timing measurement (FTM) initiator functionality in
526 1.2 christos # the Extended Capabilities element bit 71.
527 1.2 christos # Controls whether FTM initiator functionality will be published by AP/STA.
528 1.2 christos # Note that actual FTM initiator operation is managed outside wpa_supplicant.
529 1.2 christos # 0 = Do not publish; default
530 1.2 christos # 1 = Publish
531 1.2 christos #ftm_initiator=0
532 1.2 christos
533 1.2 christos # credential block
534 1.2 christos #
535 1.2 christos # Each credential used for automatic network selection is configured as a set
536 1.2 christos # of parameters that are compared to the information advertised by the APs when
537 1.2 christos # interworking_select and interworking_connect commands are used.
538 1.2 christos #
539 1.2 christos # credential fields:
540 1.2 christos #
541 1.2 christos # temporary: Whether this credential is temporary and not to be saved
542 1.2 christos #
543 1.2 christos # priority: Priority group
544 1.2 christos # By default, all networks and credentials get the same priority group
545 1.2 christos # (0). This field can be used to give higher priority for credentials
546 1.2 christos # (and similarly in struct wpa_ssid for network blocks) to change the
547 1.2 christos # Interworking automatic networking selection behavior. The matching
548 1.2 christos # network (based on either an enabled network block or a credential)
549 1.2 christos # with the highest priority value will be selected.
550 1.2 christos #
551 1.2 christos # pcsc: Use PC/SC and SIM/USIM card
552 1.2 christos #
553 1.2 christos # realm: Home Realm for Interworking
554 1.2 christos #
555 1.2 christos # username: Username for Interworking network selection
556 1.2 christos #
557 1.2 christos # password: Password for Interworking network selection
558 1.2 christos #
559 1.2 christos # ca_cert: CA certificate for Interworking network selection
560 1.2 christos #
561 1.2 christos # client_cert: File path to client certificate file (PEM/DER)
562 1.2 christos # This field is used with Interworking networking selection for a case
563 1.2 christos # where client certificate/private key is used for authentication
564 1.2 christos # (EAP-TLS). Full path to the file should be used since working
565 1.2 christos # directory may change when wpa_supplicant is run in the background.
566 1.2 christos #
567 1.2 christos # Certificates from PKCS#11 tokens can be referenced by a PKCS#11 URI.
568 1.2 christos #
569 1.2 christos # For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
570 1.2 christos #
571 1.2 christos # Alternatively, a named configuration blob can be used by setting
572 1.2 christos # this to blob://blob_name.
573 1.2 christos #
574 1.2 christos # private_key: File path to client private key file (PEM/DER/PFX)
575 1.2 christos # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
576 1.2 christos # commented out. Both the private key and certificate will be read
577 1.2 christos # from the PKCS#12 file in this case. Full path to the file should be
578 1.2 christos # used since working directory may change when wpa_supplicant is run
579 1.2 christos # in the background.
580 1.2 christos #
581 1.2 christos # Keys in PKCS#11 tokens can be referenced by a PKCS#11 URI.
582 1.2 christos # For example: private_key="pkcs11:manufacturer=piv_II;id=%01"
583 1.2 christos #
584 1.2 christos # Windows certificate store can be used by leaving client_cert out and
585 1.2 christos # configuring private_key in one of the following formats:
586 1.2 christos #
587 1.2 christos # cert://substring_to_match
588 1.2 christos #
589 1.2 christos # hash://certificate_thumbprint_in_hex
590 1.2 christos #
591 1.2 christos # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
592 1.2 christos #
593 1.2 christos # Note that when running wpa_supplicant as an application, the user
594 1.2 christos # certificate store (My user account) is used, whereas computer store
595 1.2 christos # (Computer account) is used when running wpasvc as a service.
596 1.2 christos #
597 1.2 christos # Alternatively, a named configuration blob can be used by setting
598 1.2 christos # this to blob://blob_name.
599 1.2 christos #
600 1.2 christos # private_key_passwd: Password for private key file
601 1.2 christos #
602 1.2 christos # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
603 1.2 christos #
604 1.2 christos # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
605 1.2 christos # format
606 1.2 christos #
607 1.2 christos # domain: Home service provider FQDN(s)
608 1.2 christos # This is used to compare against the Domain Name List to figure out
609 1.2 christos # whether the AP is operated by the Home SP. Multiple domain entries can
610 1.2 christos # be used to configure alternative FQDNs that will be considered home
611 1.2 christos # networks.
612 1.2 christos #
613 1.2 christos # roaming_consortium: Roaming Consortium OI
614 1.2 christos # If roaming_consortium_len is non-zero, this field contains the
615 1.2 christos # Roaming Consortium OI that can be used to determine which access
616 1.2 christos # points support authentication with this credential. This is an
617 1.2 christos # alternative to the use of the realm parameter. When using Roaming
618 1.2 christos # Consortium to match the network, the EAP parameters need to be
619 1.2 christos # pre-configured with the credential since the NAI Realm information
620 1.2 christos # may not be available or fetched.
621 1.2 christos #
622 1.2 christos # required_roaming_consortium: Required Roaming Consortium OI
623 1.2 christos # If required_roaming_consortium_len is non-zero, this field contains the
624 1.2 christos # Roaming Consortium OI that is required to be advertised by the AP for
625 1.2 christos # the credential to be considered matching.
626 1.2 christos #
627 1.2 christos # roaming_consortiums: Roaming Consortium OI(s) memberships
628 1.2 christos # This string field contains one or more comma delimited OIs (hexdump)
629 1.2 christos # identifying the roaming consortiums of which the provider is a member.
630 1.2 christos # The list is sorted from the most preferred one to the least preferred
631 1.2 christos # one. A match between the Roaming Consortium OIs advertised by an AP and
632 1.2 christos # the OIs in this list indicates that successful authentication is
633 1.2 christos # possible.
634 1.2 christos # (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
635 1.2 christos #
636 1.2 christos # eap: Pre-configured EAP method
637 1.2 christos # This optional field can be used to specify which EAP method will be
638 1.2 christos # used with this credential. If not set, the EAP method is selected
639 1.2 christos # automatically based on ANQP information (e.g., NAI Realm).
640 1.2 christos #
641 1.2 christos # phase1: Pre-configure Phase 1 (outer authentication) parameters
642 1.2 christos # This optional field is used with like the 'eap' parameter.
643 1.2 christos #
644 1.2 christos # phase2: Pre-configure Phase 2 (inner authentication) parameters
645 1.2 christos # This optional field is used with like the 'eap' parameter.
646 1.2 christos #
647 1.2 christos # excluded_ssid: Excluded SSID
648 1.2 christos # This optional field can be used to excluded specific SSID(s) from
649 1.2 christos # matching with the network. Multiple entries can be used to specify more
650 1.2 christos # than one SSID.
651 1.2 christos #
652 1.2 christos # roaming_partner: Roaming partner information
653 1.2 christos # This optional field can be used to configure preferences between roaming
654 1.2 christos # partners. The field is a string in following format:
655 1.2 christos # <FQDN>,<0/1 exact match>,<priority>,<* or country code>
656 1.2 christos # (non-exact match means any subdomain matches the entry; priority is in
657 1.2 christos # 0..255 range with 0 being the highest priority)
658 1.2 christos #
659 1.2 christos # update_identifier: PPS MO ID
660 1.2 christos # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
661 1.2 christos #
662 1.2 christos # provisioning_sp: FQDN of the SP that provisioned the credential
663 1.2 christos # This optional field can be used to keep track of the SP that provisioned
664 1.2 christos # the credential to find the PPS MO (./Wi-Fi/<provisioning_sp>).
665 1.2 christos #
666 1.2 christos # Minimum backhaul threshold (PPS/<X+>/Policy/MinBackhauldThreshold/*)
667 1.2 christos # These fields can be used to specify minimum download/upload backhaul
668 1.2 christos # bandwidth that is preferred for the credential. This constraint is
669 1.2 christos # ignored if the AP does not advertise WAN Metrics information or if the
670 1.2 christos # limit would prevent any connection. Values are in kilobits per second.
671 1.2 christos # min_dl_bandwidth_home
672 1.2 christos # min_ul_bandwidth_home
673 1.2 christos # min_dl_bandwidth_roaming
674 1.2 christos # min_ul_bandwidth_roaming
675 1.2 christos #
676 1.2 christos # max_bss_load: Maximum BSS Load Channel Utilization (1..255)
677 1.2 christos # (PPS/<X+>/Policy/MaximumBSSLoadValue)
678 1.2 christos # This value is used as the maximum channel utilization for network
679 1.2 christos # selection purposes for home networks. If the AP does not advertise
680 1.2 christos # BSS Load or if the limit would prevent any connection, this constraint
681 1.2 christos # will be ignored.
682 1.2 christos #
683 1.2 christos # req_conn_capab: Required connection capability
684 1.2 christos # (PPS/<X+>/Policy/RequiredProtoPortTuple)
685 1.2 christos # This value is used to configure set of required protocol/port pairs that
686 1.2 christos # a roaming network shall support (include explicitly in Connection
687 1.2 christos # Capability ANQP element). This constraint is ignored if the AP does not
688 1.2 christos # advertise Connection Capability or if this constraint would prevent any
689 1.2 christos # network connection. This policy is not used in home networks.
690 1.2 christos # Format: <protocol>[:<comma-separated list of ports]
691 1.2 christos # Multiple entries can be used to list multiple requirements.
692 1.2 christos # For example, number of common TCP protocols:
693 1.2 christos # req_conn_capab=6,22,80,443
694 1.2 christos # For example, IPSec/IKE:
695 1.2 christos # req_conn_capab=17:500
696 1.2 christos # req_conn_capab=50
697 1.2 christos #
698 1.2 christos # ocsp: Whether to use/require OCSP to check server certificate
699 1.2 christos # 0 = do not use OCSP stapling (TLS certificate status extension)
700 1.2 christos # 1 = try to use OCSP stapling, but not require response
701 1.2 christos # 2 = require valid OCSP stapling response
702 1.2 christos # 3 = require valid OCSP stapling response for all not-trusted
703 1.2 christos # certificates in the server certificate chain
704 1.2 christos #
705 1.2 christos # sim_num: Identifier for which SIM to use in multi-SIM devices
706 1.2 christos #
707 1.2 christos # for example:
708 1.2 christos #
709 1.2 christos #cred={
710 1.2 christos # realm="example.com"
711 1.2 christos # username="user (at] example.com"
712 1.2 christos # password="password"
713 1.2 christos # ca_cert="/etc/wpa_supplicant/ca.pem"
714 1.2 christos # domain="example.com"
715 1.2 christos #}
716 1.2 christos #
717 1.2 christos #cred={
718 1.2 christos # imsi="310026-000000000"
719 1.2 christos # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
720 1.2 christos #}
721 1.2 christos #
722 1.2 christos #cred={
723 1.2 christos # realm="example.com"
724 1.2 christos # username="user"
725 1.2 christos # password="password"
726 1.2 christos # ca_cert="/etc/wpa_supplicant/ca.pem"
727 1.2 christos # domain="example.com"
728 1.2 christos # roaming_consortium=223344
729 1.2 christos # eap=TTLS
730 1.2 christos # phase2="auth=MSCHAPV2"
731 1.2 christos #}
732 1.2 christos
733 1.2 christos # Hotspot 2.0
734 1.2 christos # hs20=1
735 1.2 christos
736 1.2 christos # Scheduled scan plans
737 1.2 christos #
738 1.2 christos # A space delimited list of scan plans. Each scan plan specifies the scan
739 1.2 christos # interval and number of iterations, delimited by a colon. The last scan plan
740 1.2 christos # will run infinitely and thus must specify only the interval and not the number
741 1.2 christos # of iterations.
742 1.2 christos #
743 1.2 christos # The driver advertises the maximum number of scan plans supported. If more scan
744 1.2 christos # plans than supported are configured, only the first ones are set (up to the
745 1.2 christos # maximum supported). The last scan plan that specifies only the interval is
746 1.2 christos # always set as the last plan.
747 1.2 christos #
748 1.2 christos # If the scan interval or the number of iterations for a scan plan exceeds the
749 1.2 christos # maximum supported, it will be set to the maximum supported value.
750 1.2 christos #
751 1.2 christos # Format:
752 1.2 christos # sched_scan_plans=<interval:iterations> <interval:iterations> ... <interval>
753 1.2 christos #
754 1.2 christos # Example:
755 1.2 christos # sched_scan_plans=10:100 20:200 30
756 1.2 christos
757 1.2 christos # Multi Band Operation (MBO) non-preferred channels
758 1.2 christos # A space delimited list of non-preferred channels where each channel is a colon
759 1.2 christos # delimited list of values.
760 1.2 christos # Format:
761 1.2 christos # non_pref_chan=<oper_class>:<chan>:<preference>:<reason>
762 1.2 christos # Example:
763 1.2 christos # non_pref_chan=81:5:10:2 81:1:0:2 81:9:0:2
764 1.2 christos
765 1.2 christos # MBO Cellular Data Capabilities
766 1.2 christos # 1 = Cellular data connection available
767 1.2 christos # 2 = Cellular data connection not available
768 1.2 christos # 3 = Not cellular capable (default)
769 1.2 christos #mbo_cell_capa=3
770 1.2 christos
771 1.2 christos # Optimized Connectivity Experience (OCE)
772 1.2 christos # oce: Enable OCE features (bitmap)
773 1.2 christos # Set BIT(0) to Enable OCE in non-AP STA mode (default; disabled if the driver
774 1.2 christos # does not indicate support for OCE in STA mode)
775 1.2 christos # Set BIT(1) to Enable OCE in STA-CFON mode
776 1.2 christos #oce=1
777 1.1 christos
778 1.1 christos # network block
779 1.1 christos #
780 1.1 christos # Each network (usually AP's sharing the same SSID) is configured as a separate
781 1.1 christos # block in this configuration file. The network blocks are in preference order
782 1.1 christos # (the first match is used).
783 1.1 christos #
784 1.1 christos # network block fields:
785 1.1 christos #
786 1.1 christos # disabled:
787 1.1 christos # 0 = this network can be used (default)
788 1.1 christos # 1 = this network block is disabled (can be enabled through ctrl_iface,
789 1.1 christos # e.g., with wpa_cli or wpa_gui)
790 1.1 christos #
791 1.1 christos # id_str: Network identifier string for external scripts. This value is passed
792 1.1 christos # to external action script through wpa_cli as WPA_ID_STR environment
793 1.1 christos # variable to make it easier to do network specific configuration.
794 1.1 christos #
795 1.2 christos # ssid: SSID (mandatory); network name in one of the optional formats:
796 1.2 christos # - an ASCII string with double quotation
797 1.2 christos # - a hex string (two characters per octet of SSID)
798 1.2 christos # - a printf-escaped ASCII string P"<escaped string>"
799 1.1 christos #
800 1.1 christos # scan_ssid:
801 1.1 christos # 0 = do not scan this SSID with specific Probe Request frames (default)
802 1.1 christos # 1 = scan with SSID-specific Probe Request frames (this can be used to
803 1.1 christos # find APs that do not accept broadcast SSID or use multiple SSIDs;
804 1.1 christos # this will add latency to scanning, so enable this only when needed)
805 1.1 christos #
806 1.1 christos # bssid: BSSID (optional); if set, this network block is used only when
807 1.1 christos # associating with the AP using the configured BSSID
808 1.1 christos #
809 1.1 christos # priority: priority group (integer)
810 1.1 christos # By default, all networks will get same priority group (0). If some of the
811 1.1 christos # networks are more desirable, this field can be used to change the order in
812 1.1 christos # which wpa_supplicant goes through the networks when selecting a BSS. The
813 1.1 christos # priority groups will be iterated in decreasing priority (i.e., the larger the
814 1.1 christos # priority value, the sooner the network is matched against the scan results).
815 1.1 christos # Within each priority group, networks will be selected based on security
816 1.1 christos # policy, signal strength, etc.
817 1.1 christos # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
818 1.1 christos # using this priority to select the order for scanning. Instead, they try the
819 1.1 christos # networks in the order that used in the configuration file.
820 1.1 christos #
821 1.1 christos # mode: IEEE 802.11 operation mode
822 1.1 christos # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
823 1.1 christos # 1 = IBSS (ad-hoc, peer-to-peer)
824 1.1 christos # 2 = AP (access point)
825 1.2 christos # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and
826 1.2 christos # WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE (fixed group key
827 1.2 christos # TKIP/CCMP) is available for backwards compatibility, but its use is
828 1.2 christos # deprecated. WPA-None requires following network block options:
829 1.1 christos # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
830 1.1 christos # both), and psk must also be set.
831 1.1 christos #
832 1.1 christos # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
833 1.1 christos # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
834 1.1 christos # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
835 1.1 christos # In addition, this value is only used by the station that creates the IBSS. If
836 1.1 christos # an IBSS network with the configured SSID is already present, the frequency of
837 1.1 christos # the network will be used instead of this configured value.
838 1.1 christos #
839 1.2 christos # pbss: Whether to use PBSS. Relevant to IEEE 802.11ad networks only.
840 1.2 christos # 0 = do not use PBSS
841 1.2 christos # 1 = use PBSS
842 1.2 christos # 2 = don't care (not allowed in AP mode)
843 1.2 christos # Used together with mode configuration. When mode is AP, it means to start a
844 1.2 christos # PCP instead of a regular AP. When mode is infrastructure it means connect
845 1.2 christos # to a PCP instead of AP. In this mode you can also specify 2 (don't care)
846 1.2 christos # which means connect to either PCP or AP.
847 1.2 christos # P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in IEEE 802.11ad network.
848 1.2 christos # For more details, see IEEE Std 802.11ad-2012.
849 1.2 christos #
850 1.1 christos # scan_freq: List of frequencies to scan
851 1.1 christos # Space-separated list of frequencies in MHz to scan when searching for this
852 1.1 christos # BSS. If the subset of channels used by the network is known, this option can
853 1.1 christos # be used to optimize scanning to not occur on channels that the network does
854 1.1 christos # not use. Example: scan_freq=2412 2437 2462
855 1.1 christos #
856 1.1 christos # freq_list: Array of allowed frequencies
857 1.1 christos # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
858 1.1 christos # set, scan results that do not match any of the specified frequencies are not
859 1.1 christos # considered when selecting a BSS.
860 1.1 christos #
861 1.2 christos # This can also be set on the outside of the network block. In this case,
862 1.2 christos # it limits the frequencies that will be scanned.
863 1.2 christos #
864 1.2 christos # bgscan: Background scanning
865 1.2 christos # wpa_supplicant behavior for background scanning can be specified by
866 1.2 christos # configuring a bgscan module. These modules are responsible for requesting
867 1.2 christos # background scans for the purpose of roaming within an ESS (i.e., within a
868 1.2 christos # single network block with all the APs using the same SSID). The bgscan
869 1.2 christos # parameter uses following format: "<bgscan module name>:<module parameters>"
870 1.2 christos # Following bgscan modules are available:
871 1.2 christos # simple - Periodic background scans based on signal strength
872 1.2 christos # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
873 1.2 christos # <long interval>"
874 1.2 christos # bgscan="simple:30:-45:300"
875 1.2 christos # learn - Learn channels used by the network and try to avoid bgscans on other
876 1.2 christos # channels (experimental)
877 1.2 christos # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
878 1.2 christos # <long interval>[:<database file name>]"
879 1.2 christos # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
880 1.2 christos # Explicitly disable bgscan by setting
881 1.2 christos # bgscan=""
882 1.2 christos #
883 1.2 christos # This option can also be set outside of all network blocks for the bgscan
884 1.2 christos # parameter to apply for all the networks that have no specific bgscan
885 1.2 christos # parameter.
886 1.2 christos #
887 1.1 christos # proto: list of accepted protocols
888 1.1 christos # WPA = WPA/IEEE 802.11i/D3.0
889 1.1 christos # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
890 1.2 christos # Note that RSN is used also for WPA3.
891 1.1 christos # If not set, this defaults to: WPA RSN
892 1.1 christos #
893 1.1 christos # key_mgmt: list of accepted authenticated key management protocols
894 1.1 christos # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
895 1.1 christos # WPA-EAP = WPA using EAP authentication
896 1.1 christos # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
897 1.1 christos # generated WEP keys
898 1.1 christos # NONE = WPA is not used; plaintext or static WEP could be used
899 1.2 christos # WPA-NONE = WPA-None for IBSS (deprecated; use proto=RSN key_mgmt=WPA-PSK
900 1.2 christos # instead)
901 1.2 christos # FT-PSK = Fast BSS Transition (IEEE 802.11r) with pre-shared key
902 1.2 christos # FT-EAP = Fast BSS Transition (IEEE 802.11r) with EAP authentication
903 1.2 christos # FT-EAP-SHA384 = Fast BSS Transition (IEEE 802.11r) with EAP authentication
904 1.2 christos # and using SHA384
905 1.1 christos # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
906 1.1 christos # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
907 1.2 christos # SAE = Simultaneous authentication of equals; pre-shared key/password -based
908 1.2 christos # authentication with stronger security than WPA-PSK especially when using
909 1.2 christos # not that strong password; a.k.a. WPA3-Personal
910 1.2 christos # FT-SAE = SAE with FT
911 1.2 christos # WPA-EAP-SUITE-B = Suite B 128-bit level
912 1.2 christos # WPA-EAP-SUITE-B-192 = Suite B 192-bit level
913 1.2 christos # OSEN = Hotspot 2.0 Rel 2 online signup connection
914 1.2 christos # FILS-SHA256 = Fast Initial Link Setup with SHA256
915 1.2 christos # FILS-SHA384 = Fast Initial Link Setup with SHA384
916 1.2 christos # FT-FILS-SHA256 = FT and Fast Initial Link Setup with SHA256
917 1.2 christos # FT-FILS-SHA384 = FT and Fast Initial Link Setup with SHA384
918 1.2 christos # OWE = Opportunistic Wireless Encryption (a.k.a. Enhanced Open)
919 1.2 christos # DPP = Device Provisioning Protocol
920 1.1 christos # If not set, this defaults to: WPA-PSK WPA-EAP
921 1.1 christos #
922 1.2 christos # ieee80211w: whether management frame protection is enabled
923 1.2 christos # 0 = disabled (default unless changed with the global pmf parameter)
924 1.2 christos # 1 = optional
925 1.2 christos # 2 = required
926 1.2 christos # The most common configuration options for this based on the PMF (protected
927 1.2 christos # management frames) certification program are:
928 1.2 christos # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
929 1.2 christos # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
930 1.2 christos # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
931 1.2 christos #
932 1.2 christos # ocv: whether operating channel validation is enabled
933 1.2 christos # This is a countermeasure against multi-channel man-in-the-middle attacks.
934 1.2 christos # Enabling this automatically also enables ieee80211w, if not yet enabled.
935 1.2 christos # 0 = disabled (default)
936 1.2 christos # 1 = enabled
937 1.2 christos #ocv=1
938 1.2 christos #
939 1.1 christos # auth_alg: list of allowed IEEE 802.11 authentication algorithms
940 1.1 christos # OPEN = Open System authentication (required for WPA/WPA2)
941 1.1 christos # SHARED = Shared Key authentication (requires static WEP keys)
942 1.1 christos # LEAP = LEAP/Network EAP (only used with LEAP)
943 1.1 christos # If not set, automatic selection is used (Open System with LEAP enabled if
944 1.1 christos # LEAP is allowed as one of the EAP methods).
945 1.1 christos #
946 1.1 christos # pairwise: list of accepted pairwise (unicast) ciphers for WPA
947 1.1 christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
948 1.1 christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
949 1.1 christos # NONE = Use only Group Keys (deprecated, should not be included if APs support
950 1.1 christos # pairwise keys)
951 1.1 christos # If not set, this defaults to: CCMP TKIP
952 1.1 christos #
953 1.1 christos # group: list of accepted group (broadcast/multicast) ciphers for WPA
954 1.1 christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
955 1.1 christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
956 1.1 christos # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
957 1.1 christos # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
958 1.1 christos # If not set, this defaults to: CCMP TKIP WEP104 WEP40
959 1.1 christos #
960 1.2 christos # group_mgmt: list of accepted group management ciphers for RSN (PMF)
961 1.2 christos # AES-128-CMAC = BIP-CMAC-128
962 1.2 christos # BIP-GMAC-128
963 1.2 christos # BIP-GMAC-256
964 1.2 christos # BIP-CMAC-256
965 1.2 christos # If not set, no constraint on the cipher, i.e., accept whichever cipher the AP
966 1.2 christos # indicates.
967 1.2 christos #
968 1.1 christos # psk: WPA preshared key; 256-bit pre-shared key
969 1.1 christos # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
970 1.1 christos # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
971 1.1 christos # generated using the passphrase and SSID). ASCII passphrase must be between
972 1.2 christos # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
973 1.2 christos # be used to indicate that the PSK/passphrase is stored in external storage.
974 1.1 christos # This field is not needed, if WPA-EAP is used.
975 1.1 christos # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
976 1.1 christos # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
977 1.1 christos # startup and reconfiguration time can be optimized by generating the PSK only
978 1.1 christos # only when the passphrase or SSID has actually changed.
979 1.1 christos #
980 1.2 christos # mem_only_psk: Whether to keep PSK/passphrase only in memory
981 1.2 christos # 0 = allow psk/passphrase to be stored to the configuration file
982 1.2 christos # 1 = do not store psk/passphrase to the configuration file
983 1.2 christos #mem_only_psk=0
984 1.2 christos #
985 1.2 christos # sae_password: SAE password
986 1.2 christos # This parameter can be used to set a password for SAE. By default, the
987 1.2 christos # passphrase from the psk parameter is used if this separate parameter is not
988 1.2 christos # used, but psk follows the WPA-PSK constraints (8..63 characters) even though
989 1.2 christos # SAE passwords do not have such constraints.
990 1.2 christos #
991 1.2 christos # sae_password_id: SAE password identifier
992 1.2 christos # This parameter can be used to set an identifier for the SAE password. By
993 1.2 christos # default, no such identifier is used. If set, the specified identifier value
994 1.2 christos # is used by the other peer to select which password to use for authentication.
995 1.2 christos #
996 1.1 christos # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
997 1.1 christos # Dynamic WEP key required for non-WPA mode
998 1.1 christos # bit0 (1): require dynamically generated unicast WEP key
999 1.1 christos # bit1 (2): require dynamically generated broadcast WEP key
1000 1.1 christos # (3 = require both keys; default)
1001 1.2 christos # Note: When using wired authentication (including MACsec drivers),
1002 1.2 christos # eapol_flags must be set to 0 for the authentication to be completed
1003 1.2 christos # successfully.
1004 1.2 christos #
1005 1.2 christos # macsec_policy: IEEE 802.1X/MACsec options
1006 1.2 christos # This determines how sessions are secured with MACsec (only for MACsec
1007 1.2 christos # drivers).
1008 1.2 christos # 0: MACsec not in use (default)
1009 1.2 christos # 1: MACsec enabled - Should secure, accept key server's advice to
1010 1.2 christos # determine whether to use a secure session or not.
1011 1.2 christos #
1012 1.2 christos # macsec_integ_only: IEEE 802.1X/MACsec transmit mode
1013 1.2 christos # This setting applies only when MACsec is in use, i.e.,
1014 1.2 christos # - macsec_policy is enabled
1015 1.2 christos # - the key server has decided to enable MACsec
1016 1.2 christos # 0: Encrypt traffic (default)
1017 1.2 christos # 1: Integrity only
1018 1.2 christos #
1019 1.2 christos # macsec_replay_protect: IEEE 802.1X/MACsec replay protection
1020 1.2 christos # This setting applies only when MACsec is in use, i.e.,
1021 1.2 christos # - macsec_policy is enabled
1022 1.2 christos # - the key server has decided to enable MACsec
1023 1.2 christos # 0: Replay protection disabled (default)
1024 1.2 christos # 1: Replay protection enabled
1025 1.2 christos #
1026 1.2 christos # macsec_replay_window: IEEE 802.1X/MACsec replay protection window
1027 1.2 christos # This determines a window in which replay is tolerated, to allow receipt
1028 1.2 christos # of frames that have been misordered by the network.
1029 1.2 christos # This setting applies only when MACsec replay protection active, i.e.,
1030 1.2 christos # - macsec_replay_protect is enabled
1031 1.2 christos # - the key server has decided to enable MACsec
1032 1.2 christos # 0: No replay window, strict check (default)
1033 1.2 christos # 1..2^32-1: number of packets that could be misordered
1034 1.2 christos #
1035 1.2 christos # macsec_port: IEEE 802.1X/MACsec port
1036 1.2 christos # Port component of the SCI
1037 1.2 christos # Range: 1-65534 (default: 1)
1038 1.2 christos #
1039 1.2 christos # mka_cak, mka_ckn, and mka_priority: IEEE 802.1X/MACsec pre-shared key mode
1040 1.2 christos # This allows to configure MACsec with a pre-shared key using a (CAK,CKN) pair.
1041 1.2 christos # In this mode, instances of wpa_supplicant can act as MACsec peers. The peer
1042 1.2 christos # with lower priority will become the key server and start distributing SAKs.
1043 1.2 christos # mka_cak (CAK = Secure Connectivity Association Key) takes a 16-byte (128-bit)
1044 1.2 christos # hex-string (32 hex-digits) or a 32-byte (256-bit) hex-string (64 hex-digits)
1045 1.2 christos # mka_ckn (CKN = CAK Name) takes a 1..32-bytes (8..256 bit) hex-string
1046 1.2 christos # (2..64 hex-digits)
1047 1.2 christos # mka_priority (Priority of MKA Actor) is in 0..255 range with 255 being
1048 1.2 christos # default priority
1049 1.1 christos #
1050 1.1 christos # mixed_cell: This option can be used to configure whether so called mixed
1051 1.1 christos # cells, i.e., networks that use both plaintext and encryption in the same
1052 1.2 christos # SSID, are allowed when selecting a BSS from scan results.
1053 1.1 christos # 0 = disabled (default)
1054 1.1 christos # 1 = enabled
1055 1.1 christos #
1056 1.1 christos # proactive_key_caching:
1057 1.1 christos # Enable/disable opportunistic PMKSA caching for WPA2.
1058 1.2 christos # 0 = disabled (default unless changed with the global okc parameter)
1059 1.1 christos # 1 = enabled
1060 1.1 christos #
1061 1.2 christos # ft_eap_pmksa_caching:
1062 1.2 christos # Whether FT-EAP PMKSA caching is allowed
1063 1.2 christos # 0 = do not try to use PMKSA caching with FT-EAP (default)
1064 1.2 christos # 1 = try to use PMKSA caching with FT-EAP
1065 1.2 christos # This controls whether to try to use PMKSA caching with FT-EAP for the
1066 1.2 christos # FT initial mobility domain association.
1067 1.2 christos #ft_eap_pmksa_caching=0
1068 1.2 christos #
1069 1.1 christos # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
1070 1.1 christos # hex without quotation, e.g., 0102030405)
1071 1.1 christos # wep_tx_keyidx: Default WEP key index (TX) (0..3)
1072 1.1 christos #
1073 1.1 christos # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
1074 1.1 christos # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
1075 1.1 christos #
1076 1.2 christos # group_rekey: Group rekeying time in seconds. This value, if non-zero, is used
1077 1.2 christos # as the dot11RSNAConfigGroupRekeyTime parameter when operating in
1078 1.2 christos # Authenticator role in IBSS, or in AP and mesh modes.
1079 1.2 christos #
1080 1.1 christos # Following fields are only used with internal EAP implementation.
1081 1.1 christos # eap: space-separated list of accepted EAP methods
1082 1.2 christos # MD5 = EAP-MD5 (insecure and does not generate keying material ->
1083 1.1 christos # cannot be used with WPA; to be used as a Phase 2 method
1084 1.1 christos # with EAP-PEAP or EAP-TTLS)
1085 1.1 christos # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
1086 1.1 christos # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1087 1.1 christos # OTP = EAP-OTP (cannot be used separately with WPA; to be used
1088 1.1 christos # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1089 1.1 christos # GTC = EAP-GTC (cannot be used separately with WPA; to be used
1090 1.1 christos # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
1091 1.1 christos # TLS = EAP-TLS (client and server certificate)
1092 1.1 christos # PEAP = EAP-PEAP (with tunnelled EAP authentication)
1093 1.1 christos # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
1094 1.1 christos # authentication)
1095 1.1 christos # If not set, all compiled in methods are allowed.
1096 1.1 christos #
1097 1.1 christos # identity: Identity string for EAP
1098 1.1 christos # This field is also used to configure user NAI for
1099 1.1 christos # EAP-PSK/PAX/SAKE/GPSK.
1100 1.1 christos # anonymous_identity: Anonymous identity string for EAP (to be used as the
1101 1.1 christos # unencrypted identity with EAP types that support different tunnelled
1102 1.2 christos # identity, e.g., EAP-TTLS). This field can also be used with
1103 1.2 christos # EAP-SIM/AKA/AKA' to store the pseudonym identity.
1104 1.1 christos # password: Password string for EAP. This field can include either the
1105 1.1 christos # plaintext password (using ASCII or hex string) or a NtPasswordHash
1106 1.1 christos # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
1107 1.1 christos # NtPasswordHash can only be used when the password is for MSCHAPv2 or
1108 1.1 christos # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
1109 1.1 christos # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
1110 1.1 christos # PSK) is also configured using this field. For EAP-GPSK, this is a
1111 1.2 christos # variable length PSK. ext:<name of external password field> format can
1112 1.2 christos # be used to indicate that the password is stored in external storage.
1113 1.1 christos # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
1114 1.1 christos # or more trusted CA certificates. If ca_cert and ca_path are not
1115 1.1 christos # included, server certificate will not be verified. This is insecure and
1116 1.1 christos # a trusted CA certificate should always be configured when using
1117 1.1 christos # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
1118 1.1 christos # change when wpa_supplicant is run in the background.
1119 1.1 christos #
1120 1.1 christos # Alternatively, this can be used to only perform matching of the server
1121 1.1 christos # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
1122 1.1 christos # this case, the possible CA certificates in the server certificate chain
1123 1.1 christos # are ignored and only the server certificate is verified. This is
1124 1.1 christos # configured with the following format:
1125 1.1 christos # hash:://server/sha256/cert_hash_in_hex
1126 1.1 christos # For example: "hash://server/sha256/
1127 1.1 christos # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
1128 1.1 christos #
1129 1.1 christos # On Windows, trusted CA certificates can be loaded from the system
1130 1.1 christos # certificate store by setting this to cert_store://<name>, e.g.,
1131 1.1 christos # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
1132 1.1 christos # Note that when running wpa_supplicant as an application, the user
1133 1.1 christos # certificate store (My user account) is used, whereas computer store
1134 1.1 christos # (Computer account) is used when running wpasvc as a service.
1135 1.1 christos # ca_path: Directory path for CA certificate files (PEM). This path may
1136 1.1 christos # contain multiple CA certificates in OpenSSL format. Common use for this
1137 1.1 christos # is to point to system trusted CA list which is often installed into
1138 1.1 christos # directory like /etc/ssl/certs. If configured, these certificates are
1139 1.1 christos # added to the list of trusted CAs. ca_cert may also be included in that
1140 1.1 christos # case, but it is not required.
1141 1.1 christos # client_cert: File path to client certificate file (PEM/DER)
1142 1.1 christos # Full path should be used since working directory may change when
1143 1.1 christos # wpa_supplicant is run in the background.
1144 1.1 christos # Alternatively, a named configuration blob can be used by setting this
1145 1.1 christos # to blob://<blob name>.
1146 1.1 christos # private_key: File path to client private key file (PEM/DER/PFX)
1147 1.1 christos # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
1148 1.1 christos # commented out. Both the private key and certificate will be read from
1149 1.1 christos # the PKCS#12 file in this case. Full path should be used since working
1150 1.1 christos # directory may change when wpa_supplicant is run in the background.
1151 1.1 christos # Windows certificate store can be used by leaving client_cert out and
1152 1.1 christos # configuring private_key in one of the following formats:
1153 1.1 christos # cert://substring_to_match
1154 1.1 christos # hash://certificate_thumbprint_in_hex
1155 1.1 christos # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
1156 1.1 christos # Note that when running wpa_supplicant as an application, the user
1157 1.1 christos # certificate store (My user account) is used, whereas computer store
1158 1.1 christos # (Computer account) is used when running wpasvc as a service.
1159 1.1 christos # Alternatively, a named configuration blob can be used by setting this
1160 1.1 christos # to blob://<blob name>.
1161 1.1 christos # private_key_passwd: Password for private key file (if left out, this will be
1162 1.1 christos # asked through control interface)
1163 1.1 christos # dh_file: File path to DH/DSA parameters file (in PEM format)
1164 1.1 christos # This is an optional configuration file for setting parameters for an
1165 1.1 christos # ephemeral DH key exchange. In most cases, the default RSA
1166 1.1 christos # authentication does not use this configuration. However, it is possible
1167 1.1 christos # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
1168 1.1 christos # DSA keys always use ephemeral DH keys. This can be used to achieve
1169 1.1 christos # forward secrecy. If the file is in DSA parameters format, it will be
1170 1.1 christos # automatically converted into DH params.
1171 1.1 christos # subject_match: Substring to be matched against the subject of the
1172 1.1 christos # authentication server certificate. If this string is set, the server
1173 1.2 christos # certificate is only accepted if it contains this string in the subject.
1174 1.1 christos # The subject string is in following format:
1175 1.1 christos # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as (at] example.com
1176 1.2 christos # Note: Since this is a substring match, this cannot be used securely to
1177 1.2 christos # do a suffix match against a possible domain name in the CN entry. For
1178 1.2 christos # such a use case, domain_suffix_match or domain_match should be used
1179 1.2 christos # instead.
1180 1.1 christos # altsubject_match: Semicolon separated string of entries to be matched against
1181 1.1 christos # the alternative subject name of the authentication server certificate.
1182 1.2 christos # If this string is set, the server certificate is only accepted if it
1183 1.1 christos # contains one of the entries in an alternative subject name extension.
1184 1.1 christos # altSubjectName string is in following format: TYPE:VALUE
1185 1.1 christos # Example: EMAIL:server (at] example.com
1186 1.1 christos # Example: DNS:server.example.com;DNS:server2.example.com
1187 1.1 christos # Following types are supported: EMAIL, DNS, URI
1188 1.2 christos # domain_suffix_match: Constraint for server domain name. If set, this FQDN is
1189 1.2 christos # used as a suffix match requirement for the AAA server certificate in
1190 1.2 christos # SubjectAltName dNSName element(s). If a matching dNSName is found, this
1191 1.2 christos # constraint is met. If no dNSName values are present, this constraint is
1192 1.2 christos # matched against SubjectName CN using same suffix match comparison.
1193 1.2 christos #
1194 1.2 christos # Suffix match here means that the host/domain name is compared one label
1195 1.2 christos # at a time starting from the top-level domain and all the labels in
1196 1.2 christos # domain_suffix_match shall be included in the certificate. The
1197 1.2 christos # certificate may include additional sub-level labels in addition to the
1198 1.2 christos # required labels.
1199 1.2 christos #
1200 1.2 christos # More than one match string can be provided by using semicolons to
1201 1.2 christos # separate the strings (e.g., example.org;example.com). When multiple
1202 1.2 christos # strings are specified, a match with any one of the values is considered
1203 1.2 christos # a sufficient match for the certificate, i.e., the conditions are ORed
1204 1.2 christos # together.
1205 1.2 christos #
1206 1.2 christos # For example, domain_suffix_match=example.com would match
1207 1.2 christos # test.example.com but would not match test-example.com.
1208 1.2 christos # domain_match: Constraint for server domain name
1209 1.2 christos # If set, this FQDN is used as a full match requirement for the
1210 1.2 christos # server certificate in SubjectAltName dNSName element(s). If a
1211 1.2 christos # matching dNSName is found, this constraint is met. If no dNSName
1212 1.2 christos # values are present, this constraint is matched against SubjectName CN
1213 1.2 christos # using same full match comparison. This behavior is similar to
1214 1.2 christos # domain_suffix_match, but has the requirement of a full match, i.e.,
1215 1.2 christos # no subdomains or wildcard matches are allowed. Case-insensitive
1216 1.2 christos # comparison is used, so "Example.com" matches "example.com", but would
1217 1.2 christos # not match "test.Example.com".
1218 1.2 christos #
1219 1.2 christos # More than one match string can be provided by using semicolons to
1220 1.2 christos # separate the strings (e.g., example.org;example.com). When multiple
1221 1.2 christos # strings are specified, a match with any one of the values is considered
1222 1.2 christos # a sufficient match for the certificate, i.e., the conditions are ORed
1223 1.2 christos # together.
1224 1.1 christos # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
1225 1.1 christos # (string with field-value pairs, e.g., "peapver=0" or
1226 1.1 christos # "peapver=1 peaplabel=1")
1227 1.1 christos # 'peapver' can be used to force which PEAP version (0 or 1) is used.
1228 1.1 christos # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
1229 1.1 christos # to be used during key derivation when PEAPv1 or newer. Most existing
1230 1.1 christos # PEAPv1 implementation seem to be using the old label, "client EAP
1231 1.1 christos # encryption", and wpa_supplicant is now using that as the default value.
1232 1.1 christos # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
1233 1.1 christos # interoperate with PEAPv1; see eap_testing.txt for more details.
1234 1.1 christos # 'peap_outer_success=0' can be used to terminate PEAP authentication on
1235 1.1 christos # tunneled EAP-Success. This is required with some RADIUS servers that
1236 1.1 christos # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
1237 1.1 christos # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
1238 1.1 christos # include_tls_length=1 can be used to force wpa_supplicant to include
1239 1.1 christos # TLS Message Length field in all TLS messages even if they are not
1240 1.1 christos # fragmented.
1241 1.1 christos # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
1242 1.1 christos # challenges (by default, it accepts 2 or 3)
1243 1.1 christos # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
1244 1.1 christos # protected result indication.
1245 1.1 christos # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
1246 1.1 christos # behavior:
1247 1.1 christos # * 0 = do not use cryptobinding (default)
1248 1.1 christos # * 1 = use cryptobinding if server supports it
1249 1.1 christos # * 2 = require cryptobinding
1250 1.2 christos # 'phase2_auth' option can be used to control Phase 2 (i.e., within TLS
1251 1.2 christos # tunnel) behavior for PEAP:
1252 1.2 christos # * 0 = do not require Phase 2 authentication
1253 1.2 christos # * 1 = require Phase 2 authentication when client certificate
1254 1.2 christos # (private_key/client_cert) is no used and TLS session resumption was
1255 1.2 christos # not used (default)
1256 1.2 christos # * 2 = require Phase 2 authentication in all cases
1257 1.1 christos # EAP-WSC (WPS) uses following options: pin=<Device Password> or
1258 1.1 christos # pbc=1.
1259 1.2 christos #
1260 1.2 christos # For wired IEEE 802.1X authentication, "allow_canned_success=1" can be
1261 1.2 christos # used to configure a mode that allows EAP-Success (and EAP-Failure)
1262 1.2 christos # without going through authentication step. Some switches use such
1263 1.2 christos # sequence when forcing the port to be authorized/unauthorized or as a
1264 1.2 christos # fallback option if the authentication server is unreachable. By default,
1265 1.2 christos # wpa_supplicant discards such frames to protect against potential attacks
1266 1.2 christos # by rogue devices, but this option can be used to disable that protection
1267 1.2 christos # for cases where the server/authenticator does not need to be
1268 1.2 christos # authenticated.
1269 1.1 christos # phase2: Phase2 (inner authentication with TLS tunnel) parameters
1270 1.1 christos # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
1271 1.2 christos # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS). "mschapv2_retry=0" can be
1272 1.2 christos # used to disable MSCHAPv2 password retry in authentication failure cases.
1273 1.2 christos #
1274 1.2 christos # TLS-based methods can use the following parameters to control TLS behavior
1275 1.2 christos # (these are normally in the phase1 parameter, but can be used also in the
1276 1.2 christos # phase2 parameter when EAP-TLS is used within the inner tunnel):
1277 1.2 christos # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
1278 1.2 christos # TLS library, these may be disabled by default to enforce stronger
1279 1.2 christos # security)
1280 1.2 christos # tls_disable_time_checks=1 - ignore certificate validity time (this requests
1281 1.2 christos # the TLS library to accept certificates even if they are not currently
1282 1.2 christos # valid, i.e., have expired or have not yet become valid; this should be
1283 1.2 christos # used only for testing purposes)
1284 1.2 christos # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
1285 1.2 christos # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
1286 1.2 christos # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
1287 1.2 christos # as a workaround for broken authentication server implementations unless
1288 1.2 christos # EAP workarounds are disabled with eap_workaround=0.
1289 1.2 christos # For EAP-FAST, this must be set to 0 (or left unconfigured for the
1290 1.2 christos # default value to be used automatically).
1291 1.2 christos # tls_disable_tlsv1_0=1 - disable use of TLSv1.0
1292 1.2 christos # tls_disable_tlsv1_0=0 - explicitly enable use of TLSv1.0 (this allows
1293 1.2 christos # systemwide TLS policies to be overridden)
1294 1.2 christos # tls_disable_tlsv1_1=1 - disable use of TLSv1.1 (a workaround for AAA servers
1295 1.2 christos # that have issues interoperating with updated TLS version)
1296 1.2 christos # tls_disable_tlsv1_1=0 - explicitly enable use of TLSv1.1 (this allows
1297 1.2 christos # systemwide TLS policies to be overridden)
1298 1.2 christos # tls_disable_tlsv1_2=1 - disable use of TLSv1.2 (a workaround for AAA servers
1299 1.2 christos # that have issues interoperating with updated TLS version)
1300 1.2 christos # tls_disable_tlsv1_2=0 - explicitly enable use of TLSv1.2 (this allows
1301 1.2 christos # systemwide TLS policies to be overridden)
1302 1.2 christos # tls_disable_tlsv1_3=1 - disable use of TLSv1.3 (a workaround for AAA servers
1303 1.2 christos # that have issues interoperating with updated TLS version)
1304 1.2 christos # tls_disable_tlsv1_3=0 - enable TLSv1.3 (experimental - disabled by default)
1305 1.2 christos # tls_ext_cert_check=0 - No external server certificate validation (default)
1306 1.2 christos # tls_ext_cert_check=1 - External server certificate validation enabled; this
1307 1.2 christos # requires an external program doing validation of server certificate
1308 1.2 christos # chain when receiving CTRL-RSP-EXT_CERT_CHECK event from the control
1309 1.2 christos # interface and report the result of the validation with
1310 1.2 christos # CTRL-RSP_EXT_CERT_CHECK.
1311 1.2 christos # tls_suiteb=0 - do not apply Suite B 192-bit constraints on TLS (default)
1312 1.2 christos # tls_suiteb=1 - apply Suite B 192-bit constraints on TLS; this is used in
1313 1.2 christos # particular when using Suite B with RSA keys of >= 3K (3072) bits
1314 1.2 christos #
1315 1.1 christos # Following certificate/private key fields are used in inner Phase2
1316 1.1 christos # authentication when using EAP-TTLS or EAP-PEAP.
1317 1.1 christos # ca_cert2: File path to CA certificate file. This file can have one or more
1318 1.1 christos # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
1319 1.1 christos # server certificate will not be verified. This is insecure and a trusted
1320 1.1 christos # CA certificate should always be configured.
1321 1.1 christos # ca_path2: Directory path for CA certificate files (PEM)
1322 1.1 christos # client_cert2: File path to client certificate file
1323 1.1 christos # private_key2: File path to client private key file
1324 1.1 christos # private_key2_passwd: Password for private key file
1325 1.1 christos # dh_file2: File path to DH/DSA parameters file (in PEM format)
1326 1.1 christos # subject_match2: Substring to be matched against the subject of the
1327 1.2 christos # authentication server certificate. See subject_match for more details.
1328 1.2 christos # altsubject_match2: Semicolon separated string of entries to be matched
1329 1.2 christos # against the alternative subject name of the authentication server
1330 1.2 christos # certificate. See altsubject_match documentation for more details.
1331 1.2 christos # domain_suffix_match2: Constraint for server domain name. See
1332 1.2 christos # domain_suffix_match for more details.
1333 1.1 christos #
1334 1.1 christos # fragment_size: Maximum EAP fragment size in bytes (default 1398).
1335 1.1 christos # This value limits the fragment size for EAP methods that support
1336 1.1 christos # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
1337 1.1 christos # small enough to make the EAP messages fit in MTU of the network
1338 1.1 christos # interface used for EAPOL. The default value is suitable for most
1339 1.1 christos # cases.
1340 1.1 christos #
1341 1.2 christos # ocsp: Whether to use/require OCSP to check server certificate
1342 1.2 christos # 0 = do not use OCSP stapling (TLS certificate status extension)
1343 1.2 christos # 1 = try to use OCSP stapling, but not require response
1344 1.2 christos # 2 = require valid OCSP stapling response
1345 1.2 christos # 3 = require valid OCSP stapling response for all not-trusted
1346 1.2 christos # certificates in the server certificate chain
1347 1.2 christos #
1348 1.2 christos # openssl_ciphers: OpenSSL specific cipher configuration
1349 1.2 christos # This can be used to override the global openssl_ciphers configuration
1350 1.2 christos # parameter (see above).
1351 1.2 christos #
1352 1.2 christos # erp: Whether EAP Re-authentication Protocol (ERP) is enabled
1353 1.2 christos #
1354 1.1 christos # EAP-FAST variables:
1355 1.1 christos # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
1356 1.1 christos # to create this file and write updates to it when PAC is being
1357 1.1 christos # provisioned or refreshed. Full path to the file should be used since
1358 1.1 christos # working directory may change when wpa_supplicant is run in the
1359 1.1 christos # background. Alternatively, a named configuration blob can be used by
1360 1.1 christos # setting this to blob://<blob name>
1361 1.1 christos # phase1: fast_provisioning option can be used to enable in-line provisioning
1362 1.1 christos # of EAP-FAST credentials (PAC):
1363 1.1 christos # 0 = disabled,
1364 1.1 christos # 1 = allow unauthenticated provisioning,
1365 1.1 christos # 2 = allow authenticated provisioning,
1366 1.1 christos # 3 = allow both unauthenticated and authenticated provisioning
1367 1.1 christos # fast_max_pac_list_len=<num> option can be used to set the maximum
1368 1.1 christos # number of PAC entries to store in a PAC list (default: 10)
1369 1.1 christos # fast_pac_format=binary option can be used to select binary format for
1370 1.1 christos # storing PAC entries in order to save some space (the default
1371 1.1 christos # text format uses about 2.5 times the size of minimal binary
1372 1.1 christos # format)
1373 1.1 christos #
1374 1.1 christos # wpa_supplicant supports number of "EAP workarounds" to work around
1375 1.1 christos # interoperability issues with incorrectly behaving authentication servers.
1376 1.1 christos # These are enabled by default because some of the issues are present in large
1377 1.1 christos # number of authentication servers. Strict EAP conformance mode can be
1378 1.1 christos # configured by disabling workarounds with eap_workaround=0.
1379 1.1 christos
1380 1.2 christos # update_identifier: PPS MO ID
1381 1.2 christos # (Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)
1382 1.2 christos #
1383 1.2 christos # roaming_consortium_selection: Roaming Consortium Selection
1384 1.2 christos # The matching Roaming Consortium OI that was used to generate this
1385 1.2 christos # network profile.
1386 1.2 christos
1387 1.2 christos # Station inactivity limit
1388 1.2 christos #
1389 1.2 christos # If a station does not send anything in ap_max_inactivity seconds, an
1390 1.2 christos # empty data frame is sent to it in order to verify whether it is
1391 1.2 christos # still in range. If this frame is not ACKed, the station will be
1392 1.2 christos # disassociated and then deauthenticated. This feature is used to
1393 1.2 christos # clear station table of old entries when the STAs move out of the
1394 1.2 christos # range.
1395 1.2 christos #
1396 1.2 christos # The station can associate again with the AP if it is still in range;
1397 1.2 christos # this inactivity poll is just used as a nicer way of verifying
1398 1.2 christos # inactivity; i.e., client will not report broken connection because
1399 1.2 christos # disassociation frame is not sent immediately without first polling
1400 1.2 christos # the STA with a data frame.
1401 1.2 christos # default: 300 (i.e., 5 minutes)
1402 1.2 christos #ap_max_inactivity=300
1403 1.2 christos
1404 1.2 christos # DTIM period in Beacon intervals for AP mode (default: 2)
1405 1.2 christos #dtim_period=2
1406 1.2 christos
1407 1.2 christos # Beacon interval (default: 100 TU)
1408 1.2 christos #beacon_int=100
1409 1.2 christos
1410 1.2 christos # WPS in AP mode
1411 1.2 christos # 0 = WPS enabled and configured (default)
1412 1.2 christos # 1 = WPS disabled
1413 1.2 christos #wps_disabled=0
1414 1.2 christos
1415 1.2 christos # FILS DH Group
1416 1.2 christos # 0 = PFS disabled with FILS shared key authentication (default)
1417 1.2 christos # 1-65535 = DH Group to use for FILS PFS
1418 1.2 christos #fils_dh_group=0
1419 1.2 christos
1420 1.2 christos # MAC address policy
1421 1.2 christos # 0 = use permanent MAC address
1422 1.2 christos # 1 = use random MAC address for each ESS connection
1423 1.2 christos # 2 = like 1, but maintain OUI (with local admin bit set)
1424 1.2 christos #mac_addr=0
1425 1.2 christos
1426 1.2 christos # disable_ht: Whether HT (802.11n) should be disabled.
1427 1.2 christos # 0 = HT enabled (if AP supports it)
1428 1.2 christos # 1 = HT disabled
1429 1.2 christos #
1430 1.2 christos # disable_ht40: Whether HT-40 (802.11n) should be disabled.
1431 1.2 christos # 0 = HT-40 enabled (if AP supports it)
1432 1.2 christos # 1 = HT-40 disabled
1433 1.2 christos #
1434 1.2 christos # disable_sgi: Whether SGI (short guard interval) should be disabled.
1435 1.2 christos # 0 = SGI enabled (if AP supports it)
1436 1.2 christos # 1 = SGI disabled
1437 1.2 christos #
1438 1.2 christos # disable_ldpc: Whether LDPC should be disabled.
1439 1.2 christos # 0 = LDPC enabled (if AP supports it)
1440 1.2 christos # 1 = LDPC disabled
1441 1.2 christos #
1442 1.2 christos # ht40_intolerant: Whether 40 MHz intolerant should be indicated.
1443 1.2 christos # 0 = 40 MHz tolerant (default)
1444 1.2 christos # 1 = 40 MHz intolerant
1445 1.2 christos #
1446 1.2 christos # ht_mcs: Configure allowed MCS rates.
1447 1.2 christos # Parsed as an array of bytes, in base-16 (ascii-hex)
1448 1.2 christos # ht_mcs="" // Use all available (default)
1449 1.2 christos # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
1450 1.2 christos # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
1451 1.2 christos #
1452 1.2 christos # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
1453 1.2 christos # -1 = Do not make any changes.
1454 1.2 christos # 0 = Enable MAX-AMSDU if hardware supports it.
1455 1.2 christos # 1 = Disable AMSDU
1456 1.2 christos #
1457 1.2 christos # ampdu_factor: Maximum A-MPDU Length Exponent
1458 1.2 christos # Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
1459 1.2 christos #
1460 1.2 christos # ampdu_density: Allow overriding AMPDU density configuration.
1461 1.2 christos # Treated as hint by the kernel.
1462 1.2 christos # -1 = Do not make any changes.
1463 1.2 christos # 0-3 = Set AMPDU density (aka factor) to specified value.
1464 1.2 christos #
1465 1.2 christos # tx_stbc: Allow overriding STBC support for TX streams
1466 1.2 christos # Value: 0-1, see IEEE Std 802.11-2016, 9.4.2.56.2.
1467 1.2 christos # -1 = Do not make any changes (default)
1468 1.2 christos # 0 = Set if not supported
1469 1.2 christos # 1 = Set if supported
1470 1.2 christos #
1471 1.2 christos # rx_stbc: Allow overriding STBC support for RX streams
1472 1.2 christos # Value: 0-3, see IEEE Std 802.11-2016, 9.4.2.56.2.
1473 1.2 christos # -1 = Do not make any changes (default)
1474 1.2 christos # 0 = Set if not supported
1475 1.2 christos # 1 = Set for support of one spatial stream
1476 1.2 christos # 2 = Set for support of one and two spatial streams
1477 1.2 christos # 3 = Set for support of one, two and three spatial streams
1478 1.2 christos
1479 1.2 christos # disable_vht: Whether VHT should be disabled.
1480 1.2 christos # 0 = VHT enabled (if AP supports it)
1481 1.2 christos # 1 = VHT disabled
1482 1.2 christos #
1483 1.2 christos # vht_capa: VHT capabilities to set in the override
1484 1.2 christos # vht_capa_mask: mask of VHT capabilities
1485 1.2 christos #
1486 1.2 christos # vht_rx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for RX NSS 1-8
1487 1.2 christos # vht_tx_mcs_nss_1/2/3/4/5/6/7/8: override the MCS set for TX NSS 1-8
1488 1.2 christos # 0: MCS 0-7
1489 1.2 christos # 1: MCS 0-8
1490 1.2 christos # 2: MCS 0-9
1491 1.2 christos # 3: not supported
1492 1.2 christos
1493 1.2 christos # multi_ap_backhaul_sta: Multi-AP backhaul STA functionality
1494 1.2 christos # 0 = normal STA (default)
1495 1.2 christos # 1 = backhaul STA
1496 1.2 christos # A backhaul STA sends the Multi-AP IE, fails to associate if the AP does not
1497 1.2 christos # support Multi-AP, and sets 4-address mode if it does. Thus, the netdev can be
1498 1.2 christos # added to a bridge to allow forwarding frames over this backhaul link.
1499 1.2 christos
1500 1.2 christos ##### Fast Session Transfer (FST) support #####################################
1501 1.2 christos #
1502 1.2 christos # The options in this section are only available when the build configuration
1503 1.2 christos # option CONFIG_FST is set while compiling wpa_supplicant. They allow this
1504 1.2 christos # interface to be a part of FST setup.
1505 1.2 christos #
1506 1.2 christos # FST is the transfer of a session from a channel to another channel, in the
1507 1.2 christos # same or different frequency bands.
1508 1.2 christos #
1509 1.2 christos # For details, see IEEE Std 802.11ad-2012.
1510 1.2 christos
1511 1.2 christos # Identifier of an FST Group the interface belongs to.
1512 1.2 christos #fst_group_id=bond0
1513 1.2 christos
1514 1.2 christos # Interface priority within the FST Group.
1515 1.2 christos # Announcing a higher priority for an interface means declaring it more
1516 1.2 christos # preferable for FST switch.
1517 1.2 christos # fst_priority is in 1..255 range with 1 being the lowest priority.
1518 1.2 christos #fst_priority=100
1519 1.2 christos
1520 1.2 christos # Default LLT value for this interface in milliseconds. The value used in case
1521 1.2 christos # no value provided during session setup. Default is 50 msec.
1522 1.2 christos # fst_llt is in 1..4294967 range (due to spec limitation, see 10.32.2.2
1523 1.2 christos # Transitioning between states).
1524 1.2 christos #fst_llt=100
1525 1.2 christos
1526 1.2 christos # BSS Transition Management
1527 1.2 christos # disable_btm - Disable BSS transition management in STA
1528 1.2 christos # Set to 0 to enable BSS transition management (default behavior)
1529 1.2 christos # Set to 1 to disable BSS transition management
1530 1.2 christos #disable_btm=0
1531 1.2 christos
1532 1.1 christos # Example blocks:
1533 1.1 christos
1534 1.1 christos # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
1535 1.1 christos network={
1536 1.1 christos ssid="simple"
1537 1.1 christos psk="very secret passphrase"
1538 1.1 christos priority=5
1539 1.1 christos }
1540 1.1 christos
1541 1.1 christos # Same as previous, but request SSID-specific scanning (for APs that reject
1542 1.1 christos # broadcast SSID)
1543 1.1 christos network={
1544 1.1 christos ssid="second ssid"
1545 1.1 christos scan_ssid=1
1546 1.1 christos psk="very secret passphrase"
1547 1.1 christos priority=2
1548 1.1 christos }
1549 1.1 christos
1550 1.1 christos # Only WPA-PSK is used. Any valid cipher combination is accepted.
1551 1.1 christos network={
1552 1.1 christos ssid="example"
1553 1.1 christos proto=WPA
1554 1.1 christos key_mgmt=WPA-PSK
1555 1.1 christos pairwise=CCMP TKIP
1556 1.1 christos group=CCMP TKIP WEP104 WEP40
1557 1.1 christos psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1558 1.1 christos priority=2
1559 1.1 christos }
1560 1.1 christos
1561 1.1 christos # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
1562 1.1 christos network={
1563 1.1 christos ssid="example"
1564 1.1 christos proto=WPA
1565 1.1 christos key_mgmt=WPA-PSK
1566 1.1 christos pairwise=TKIP
1567 1.1 christos group=TKIP
1568 1.1 christos psk="not so secure passphrase"
1569 1.1 christos wpa_ptk_rekey=600
1570 1.1 christos }
1571 1.1 christos
1572 1.1 christos # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
1573 1.1 christos # or WEP40 as the group cipher will not be accepted.
1574 1.1 christos network={
1575 1.1 christos ssid="example"
1576 1.1 christos proto=RSN
1577 1.1 christos key_mgmt=WPA-EAP
1578 1.1 christos pairwise=CCMP TKIP
1579 1.1 christos group=CCMP TKIP
1580 1.1 christos eap=TLS
1581 1.1 christos identity="user (at] example.com"
1582 1.1 christos ca_cert="/etc/cert/ca.pem"
1583 1.1 christos client_cert="/etc/cert/user.pem"
1584 1.1 christos private_key="/etc/cert/user.prv"
1585 1.1 christos private_key_passwd="password"
1586 1.1 christos priority=1
1587 1.1 christos }
1588 1.1 christos
1589 1.1 christos # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
1590 1.1 christos # (e.g., Radiator)
1591 1.1 christos network={
1592 1.1 christos ssid="example"
1593 1.1 christos key_mgmt=WPA-EAP
1594 1.1 christos eap=PEAP
1595 1.1 christos identity="user (at] example.com"
1596 1.1 christos password="foobar"
1597 1.1 christos ca_cert="/etc/cert/ca.pem"
1598 1.1 christos phase1="peaplabel=1"
1599 1.1 christos phase2="auth=MSCHAPV2"
1600 1.1 christos priority=10
1601 1.1 christos }
1602 1.1 christos
1603 1.1 christos # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
1604 1.1 christos # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
1605 1.1 christos network={
1606 1.1 christos ssid="example"
1607 1.1 christos key_mgmt=WPA-EAP
1608 1.1 christos eap=TTLS
1609 1.1 christos identity="user (at] example.com"
1610 1.1 christos anonymous_identity="anonymous (at] example.com"
1611 1.1 christos password="foobar"
1612 1.1 christos ca_cert="/etc/cert/ca.pem"
1613 1.1 christos priority=2
1614 1.1 christos }
1615 1.1 christos
1616 1.1 christos # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
1617 1.1 christos # use. Real identity is sent only within an encrypted TLS tunnel.
1618 1.1 christos network={
1619 1.1 christos ssid="example"
1620 1.1 christos key_mgmt=WPA-EAP
1621 1.1 christos eap=TTLS
1622 1.1 christos identity="user (at] example.com"
1623 1.1 christos anonymous_identity="anonymous (at] example.com"
1624 1.1 christos password="foobar"
1625 1.1 christos ca_cert="/etc/cert/ca.pem"
1626 1.1 christos phase2="auth=MSCHAPV2"
1627 1.1 christos }
1628 1.1 christos
1629 1.1 christos # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
1630 1.1 christos # authentication.
1631 1.1 christos network={
1632 1.1 christos ssid="example"
1633 1.1 christos key_mgmt=WPA-EAP
1634 1.1 christos eap=TTLS
1635 1.1 christos # Phase1 / outer authentication
1636 1.1 christos anonymous_identity="anonymous (at] example.com"
1637 1.1 christos ca_cert="/etc/cert/ca.pem"
1638 1.1 christos # Phase 2 / inner authentication
1639 1.1 christos phase2="autheap=TLS"
1640 1.1 christos ca_cert2="/etc/cert/ca2.pem"
1641 1.1 christos client_cert2="/etc/cer/user.pem"
1642 1.1 christos private_key2="/etc/cer/user.prv"
1643 1.1 christos private_key2_passwd="password"
1644 1.1 christos priority=2
1645 1.1 christos }
1646 1.1 christos
1647 1.1 christos # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
1648 1.1 christos # group cipher.
1649 1.1 christos network={
1650 1.1 christos ssid="example"
1651 1.1 christos bssid=00:11:22:33:44:55
1652 1.1 christos proto=WPA RSN
1653 1.1 christos key_mgmt=WPA-PSK WPA-EAP
1654 1.1 christos pairwise=CCMP
1655 1.1 christos group=CCMP
1656 1.1 christos psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
1657 1.1 christos }
1658 1.1 christos
1659 1.1 christos # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
1660 1.1 christos # and all valid ciphers.
1661 1.1 christos network={
1662 1.1 christos ssid=00010203
1663 1.1 christos psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
1664 1.1 christos }
1665 1.1 christos
1666 1.1 christos
1667 1.1 christos # EAP-SIM with a GSM SIM or USIM
1668 1.1 christos network={
1669 1.1 christos ssid="eap-sim-test"
1670 1.1 christos key_mgmt=WPA-EAP
1671 1.1 christos eap=SIM
1672 1.1 christos pin="1234"
1673 1.1 christos pcsc=""
1674 1.1 christos }
1675 1.1 christos
1676 1.1 christos
1677 1.1 christos # EAP-PSK
1678 1.1 christos network={
1679 1.1 christos ssid="eap-psk-test"
1680 1.1 christos key_mgmt=WPA-EAP
1681 1.1 christos eap=PSK
1682 1.1 christos anonymous_identity="eap_psk_user"
1683 1.1 christos password=06b4be19da289f475aa46a33cb793029
1684 1.1 christos identity="eap_psk_user (at] example.com"
1685 1.1 christos }
1686 1.1 christos
1687 1.1 christos
1688 1.1 christos # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1689 1.1 christos # EAP-TLS for authentication and key generation; require both unicast and
1690 1.1 christos # broadcast WEP keys.
1691 1.1 christos network={
1692 1.1 christos ssid="1x-test"
1693 1.1 christos key_mgmt=IEEE8021X
1694 1.1 christos eap=TLS
1695 1.1 christos identity="user (at] example.com"
1696 1.1 christos ca_cert="/etc/cert/ca.pem"
1697 1.1 christos client_cert="/etc/cert/user.pem"
1698 1.1 christos private_key="/etc/cert/user.prv"
1699 1.1 christos private_key_passwd="password"
1700 1.1 christos eapol_flags=3
1701 1.1 christos }
1702 1.1 christos
1703 1.1 christos
1704 1.1 christos # LEAP with dynamic WEP keys
1705 1.1 christos network={
1706 1.1 christos ssid="leap-example"
1707 1.1 christos key_mgmt=IEEE8021X
1708 1.1 christos eap=LEAP
1709 1.1 christos identity="user"
1710 1.1 christos password="foobar"
1711 1.1 christos }
1712 1.1 christos
1713 1.1 christos # EAP-IKEv2 using shared secrets for both server and peer authentication
1714 1.1 christos network={
1715 1.1 christos ssid="ikev2-example"
1716 1.1 christos key_mgmt=WPA-EAP
1717 1.1 christos eap=IKEV2
1718 1.1 christos identity="user"
1719 1.1 christos password="foobar"
1720 1.1 christos }
1721 1.1 christos
1722 1.1 christos # EAP-FAST with WPA (WPA or WPA2)
1723 1.1 christos network={
1724 1.1 christos ssid="eap-fast-test"
1725 1.1 christos key_mgmt=WPA-EAP
1726 1.1 christos eap=FAST
1727 1.1 christos anonymous_identity="FAST-000102030405"
1728 1.1 christos identity="username"
1729 1.1 christos password="password"
1730 1.1 christos phase1="fast_provisioning=1"
1731 1.1 christos pac_file="/etc/wpa_supplicant.eap-fast-pac"
1732 1.1 christos }
1733 1.1 christos
1734 1.1 christos network={
1735 1.1 christos ssid="eap-fast-test"
1736 1.1 christos key_mgmt=WPA-EAP
1737 1.1 christos eap=FAST
1738 1.1 christos anonymous_identity="FAST-000102030405"
1739 1.1 christos identity="username"
1740 1.1 christos password="password"
1741 1.1 christos phase1="fast_provisioning=1"
1742 1.1 christos pac_file="blob://eap-fast-pac"
1743 1.1 christos }
1744 1.1 christos
1745 1.1 christos # Plaintext connection (no WPA, no IEEE 802.1X)
1746 1.1 christos network={
1747 1.1 christos ssid="plaintext-test"
1748 1.1 christos key_mgmt=NONE
1749 1.1 christos }
1750 1.1 christos
1751 1.1 christos
1752 1.1 christos # Shared WEP key connection (no WPA, no IEEE 802.1X)
1753 1.1 christos network={
1754 1.1 christos ssid="static-wep-test"
1755 1.1 christos key_mgmt=NONE
1756 1.1 christos wep_key0="abcde"
1757 1.1 christos wep_key1=0102030405
1758 1.1 christos wep_key2="1234567890123"
1759 1.1 christos wep_tx_keyidx=0
1760 1.1 christos priority=5
1761 1.1 christos }
1762 1.1 christos
1763 1.1 christos
1764 1.1 christos # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1765 1.1 christos # IEEE 802.11 authentication
1766 1.1 christos network={
1767 1.1 christos ssid="static-wep-test2"
1768 1.1 christos key_mgmt=NONE
1769 1.1 christos wep_key0="abcde"
1770 1.1 christos wep_key1=0102030405
1771 1.1 christos wep_key2="1234567890123"
1772 1.1 christos wep_tx_keyidx=0
1773 1.1 christos priority=5
1774 1.1 christos auth_alg=SHARED
1775 1.1 christos }
1776 1.1 christos
1777 1.1 christos
1778 1.2 christos # IBSS/ad-hoc network with RSN
1779 1.2 christos network={
1780 1.2 christos ssid="ibss-rsn"
1781 1.2 christos key_mgmt=WPA-PSK
1782 1.2 christos proto=RSN
1783 1.2 christos psk="12345678"
1784 1.2 christos mode=1
1785 1.2 christos frequency=2412
1786 1.2 christos pairwise=CCMP
1787 1.2 christos group=CCMP
1788 1.2 christos }
1789 1.2 christos
1790 1.2 christos # IBSS/ad-hoc network with WPA-None/TKIP (deprecated)
1791 1.1 christos network={
1792 1.1 christos ssid="test adhoc"
1793 1.1 christos mode=1
1794 1.1 christos frequency=2412
1795 1.1 christos proto=WPA
1796 1.1 christos key_mgmt=WPA-NONE
1797 1.1 christos pairwise=NONE
1798 1.1 christos group=TKIP
1799 1.1 christos psk="secret passphrase"
1800 1.1 christos }
1801 1.1 christos
1802 1.2 christos # open mesh network
1803 1.2 christos network={
1804 1.2 christos ssid="test mesh"
1805 1.2 christos mode=5
1806 1.2 christos frequency=2437
1807 1.2 christos key_mgmt=NONE
1808 1.2 christos }
1809 1.2 christos
1810 1.2 christos # secure (SAE + AMPE) network
1811 1.2 christos network={
1812 1.2 christos ssid="secure mesh"
1813 1.2 christos mode=5
1814 1.2 christos frequency=2437
1815 1.2 christos key_mgmt=SAE
1816 1.2 christos psk="very secret passphrase"
1817 1.2 christos }
1818 1.2 christos
1819 1.1 christos
1820 1.1 christos # Catch all example that allows more or less all configuration modes
1821 1.1 christos network={
1822 1.1 christos ssid="example"
1823 1.1 christos scan_ssid=1
1824 1.1 christos key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1825 1.1 christos pairwise=CCMP TKIP
1826 1.1 christos group=CCMP TKIP WEP104 WEP40
1827 1.1 christos psk="very secret passphrase"
1828 1.1 christos eap=TTLS PEAP TLS
1829 1.1 christos identity="user (at] example.com"
1830 1.1 christos password="foobar"
1831 1.1 christos ca_cert="/etc/cert/ca.pem"
1832 1.1 christos client_cert="/etc/cert/user.pem"
1833 1.1 christos private_key="/etc/cert/user.prv"
1834 1.1 christos private_key_passwd="password"
1835 1.1 christos phase1="peaplabel=0"
1836 1.1 christos }
1837 1.1 christos
1838 1.1 christos # Example of EAP-TLS with smartcard (openssl engine)
1839 1.1 christos network={
1840 1.1 christos ssid="example"
1841 1.1 christos key_mgmt=WPA-EAP
1842 1.1 christos eap=TLS
1843 1.1 christos proto=RSN
1844 1.1 christos pairwise=CCMP TKIP
1845 1.1 christos group=CCMP TKIP
1846 1.1 christos identity="user (at] example.com"
1847 1.1 christos ca_cert="/etc/cert/ca.pem"
1848 1.1 christos
1849 1.2 christos # Certificate and/or key identified by PKCS#11 URI (RFC7512)
1850 1.2 christos client_cert="pkcs11:manufacturer=piv_II;id=%01"
1851 1.2 christos private_key="pkcs11:manufacturer=piv_II;id=%01"
1852 1.1 christos
1853 1.1 christos # Optional PIN configuration; this can be left out and PIN will be
1854 1.1 christos # asked through the control interface
1855 1.1 christos pin="1234"
1856 1.1 christos }
1857 1.1 christos
1858 1.1 christos # Example configuration showing how to use an inlined blob as a CA certificate
1859 1.1 christos # data instead of using external file
1860 1.1 christos network={
1861 1.1 christos ssid="example"
1862 1.1 christos key_mgmt=WPA-EAP
1863 1.1 christos eap=TTLS
1864 1.1 christos identity="user (at] example.com"
1865 1.1 christos anonymous_identity="anonymous (at] example.com"
1866 1.1 christos password="foobar"
1867 1.1 christos ca_cert="blob://exampleblob"
1868 1.1 christos priority=20
1869 1.1 christos }
1870 1.1 christos
1871 1.1 christos blob-base64-exampleblob={
1872 1.1 christos SGVsbG8gV29ybGQhCg==
1873 1.1 christos }
1874 1.1 christos
1875 1.1 christos
1876 1.1 christos # Wildcard match for SSID (plaintext APs only). This example select any
1877 1.1 christos # open AP regardless of its SSID.
1878 1.1 christos network={
1879 1.1 christos key_mgmt=NONE
1880 1.1 christos }
1881 1.2 christos
1882 1.2 christos # Example configuration blacklisting two APs - these will be ignored
1883 1.2 christos # for this network.
1884 1.2 christos network={
1885 1.2 christos ssid="example"
1886 1.2 christos psk="very secret passphrase"
1887 1.2 christos bssid_blacklist=02:11:22:33:44:55 02:22:aa:44:55:66
1888 1.2 christos }
1889 1.2 christos
1890 1.2 christos # Example configuration limiting AP selection to a specific set of APs;
1891 1.2 christos # any other AP not matching the masked address will be ignored.
1892 1.2 christos network={
1893 1.2 christos ssid="example"
1894 1.2 christos psk="very secret passphrase"
1895 1.2 christos 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
1896 1.2 christos }
1897 1.2 christos
1898 1.2 christos # Example config file that will only scan on channel 36.
1899 1.2 christos freq_list=5180
1900 1.2 christos network={
1901 1.2 christos key_mgmt=NONE
1902 1.2 christos }
1903 1.2 christos
1904 1.2 christos
1905 1.2 christos # Example configuration using EAP-TTLS for authentication and key
1906 1.2 christos # generation for MACsec
1907 1.2 christos network={
1908 1.2 christos key_mgmt=IEEE8021X
1909 1.2 christos eap=TTLS
1910 1.2 christos phase2="auth=PAP"
1911 1.2 christos anonymous_identity="anonymous (at] example.com"
1912 1.2 christos identity="user (at] example.com"
1913 1.2 christos password="secretr"
1914 1.2 christos ca_cert="/etc/cert/ca.pem"
1915 1.2 christos eapol_flags=0
1916 1.2 christos macsec_policy=1
1917 1.2 christos }
1918 1.2 christos
1919 1.2 christos # Example configuration for MACsec with preshared key
1920 1.2 christos network={
1921 1.2 christos key_mgmt=NONE
1922 1.2 christos eapol_flags=0
1923 1.2 christos macsec_policy=1
1924 1.2 christos mka_cak=0123456789ABCDEF0123456789ABCDEF
1925 1.2 christos mka_ckn=6162636465666768696A6B6C6D6E6F707172737475767778797A303132333435
1926 1.2 christos mka_priority=128
1927 1.2 christos }
1928