wpa_supplicant.conf revision 1.1.1.3 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.1.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.1 christos eapol_version=1
85 1.1 christos
86 1.1 christos # AP scanning/selection
87 1.1 christos # By default, wpa_supplicant requests driver to perform AP scanning and then
88 1.1 christos # uses the scan results to select a suitable AP. Another alternative is to
89 1.1 christos # allow the driver to take care of AP scanning and selection and use
90 1.1 christos # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association
91 1.1 christos # information from the driver.
92 1.1 christos # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to
93 1.1 christos # the currently enabled networks are found, a new network (IBSS or AP mode
94 1.1 christos # operation) may be initialized (if configured) (default)
95 1.1 christos # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association
96 1.1 christos # parameters (e.g., WPA IE generation); this mode can also be used with
97 1.1 christos # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with
98 1.1 christos # APs (i.e., external program needs to control association). This mode must
99 1.1 christos # also be used when using wired Ethernet drivers.
100 1.1 christos # 2: like 0, but associate with APs using security policy and SSID (but not
101 1.1 christos # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to
102 1.1 christos # enable operation with hidden SSIDs and optimized roaming; in this mode,
103 1.1 christos # the network blocks in the configuration file are tried one by one until
104 1.1 christos # the driver reports successful association; each network block should have
105 1.1 christos # explicit security policy (i.e., only one option in the lists) for
106 1.1 christos # key_mgmt, pairwise, group, proto variables
107 1.1 christos # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be
108 1.1 christos # created immediately regardless of scan results. ap_scan=1 mode will first try
109 1.1 christos # to scan for existing networks and only if no matches with the enabled
110 1.1 christos # networks are found, a new IBSS or AP mode network is created.
111 1.1 christos ap_scan=1
112 1.1 christos
113 1.1 christos # EAP fast re-authentication
114 1.1 christos # By default, fast re-authentication is enabled for all EAP methods that
115 1.1 christos # support it. This variable can be used to disable fast re-authentication.
116 1.1 christos # Normally, there is no need to disable this.
117 1.1 christos fast_reauth=1
118 1.1 christos
119 1.1 christos # OpenSSL Engine support
120 1.1 christos # These options can be used to load OpenSSL engines.
121 1.1 christos # The two engines that are supported currently are shown below:
122 1.1 christos # They are both from the opensc project (http://www.opensc.org/)
123 1.1 christos # By default no engines are loaded.
124 1.1 christos # make the opensc engine available
125 1.1 christos #opensc_engine_path=/usr/lib/opensc/engine_opensc.so
126 1.1 christos # make the pkcs11 engine available
127 1.1 christos #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so
128 1.1 christos # configure the path to the pkcs11 module required by the pkcs11 engine
129 1.1 christos #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so
130 1.1 christos
131 1.1 christos # Dynamic EAP methods
132 1.1 christos # If EAP methods were built dynamically as shared object files, they need to be
133 1.1 christos # loaded here before being used in the network blocks. By default, EAP methods
134 1.1 christos # are included statically in the build, so these lines are not needed
135 1.1 christos #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so
136 1.1 christos #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so
137 1.1 christos
138 1.1 christos # Driver interface parameters
139 1.1 christos # This field can be used to configure arbitrary driver interace parameters. The
140 1.1 christos # format is specific to the selected driver interface. This field is not used
141 1.1 christos # in most cases.
142 1.1 christos #driver_param="field=value"
143 1.1 christos
144 1.1 christos # Country code
145 1.1 christos # The ISO/IEC alpha2 country code for the country in which this device is
146 1.1 christos # currently operating.
147 1.1 christos #country=US
148 1.1 christos
149 1.1 christos # Maximum lifetime for PMKSA in seconds; default 43200
150 1.1 christos #dot11RSNAConfigPMKLifetime=43200
151 1.1 christos # Threshold for reauthentication (percentage of PMK lifetime); default 70
152 1.1 christos #dot11RSNAConfigPMKReauthThreshold=70
153 1.1 christos # Timeout for security association negotiation in seconds; default 60
154 1.1 christos #dot11RSNAConfigSATimeout=60
155 1.1 christos
156 1.1 christos # Wi-Fi Protected Setup (WPS) parameters
157 1.1 christos
158 1.1 christos # Universally Unique IDentifier (UUID; see RFC 4122) of the device
159 1.1 christos # If not configured, UUID will be generated based on the local MAC address.
160 1.1 christos #uuid=12345678-9abc-def0-1234-56789abcdef0
161 1.1 christos
162 1.1 christos # Device Name
163 1.1 christos # User-friendly description of device; up to 32 octets encoded in UTF-8
164 1.1 christos #device_name=Wireless Client
165 1.1 christos
166 1.1 christos # Manufacturer
167 1.1 christos # The manufacturer of the device (up to 64 ASCII characters)
168 1.1 christos #manufacturer=Company
169 1.1 christos
170 1.1 christos # Model Name
171 1.1 christos # Model of the device (up to 32 ASCII characters)
172 1.1 christos #model_name=cmodel
173 1.1 christos
174 1.1 christos # Model Number
175 1.1 christos # Additional device description (up to 32 ASCII characters)
176 1.1 christos #model_number=123
177 1.1 christos
178 1.1 christos # Serial Number
179 1.1 christos # Serial number of the device (up to 32 characters)
180 1.1 christos #serial_number=12345
181 1.1 christos
182 1.1 christos # Primary Device Type
183 1.1 christos # Used format: <categ>-<OUI>-<subcateg>
184 1.1 christos # categ = Category as an integer value
185 1.1 christos # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for
186 1.1 christos # default WPS OUI
187 1.1 christos # subcateg = OUI-specific Sub Category as an integer value
188 1.1 christos # Examples:
189 1.1 christos # 1-0050F204-1 (Computer / PC)
190 1.1 christos # 1-0050F204-2 (Computer / Server)
191 1.1 christos # 5-0050F204-1 (Storage / NAS)
192 1.1 christos # 6-0050F204-1 (Network Infrastructure / AP)
193 1.1 christos #device_type=1-0050F204-1
194 1.1 christos
195 1.1 christos # OS Version
196 1.1 christos # 4-octet operating system version number (hex string)
197 1.1 christos #os_version=01020300
198 1.1 christos
199 1.1 christos # Config Methods
200 1.1 christos # List of the supported configuration methods
201 1.1 christos # Available methods: usba ethernet label display ext_nfc_token int_nfc_token
202 1.1.1.2 christos # nfc_interface push_button keypad virtual_display physical_display
203 1.1.1.2 christos # virtual_push_button physical_push_button
204 1.1.1.2 christos # For WSC 1.0:
205 1.1 christos #config_methods=label display push_button keypad
206 1.1.1.2 christos # For WSC 2.0:
207 1.1.1.2 christos #config_methods=label virtual_display virtual_push_button keypad
208 1.1 christos
209 1.1 christos # Credential processing
210 1.1 christos # 0 = process received credentials internally (default)
211 1.1 christos # 1 = do not process received credentials; just pass them over ctrl_iface to
212 1.1 christos # external program(s)
213 1.1 christos # 2 = process received credentials internally and pass them over ctrl_iface
214 1.1 christos # to external program(s)
215 1.1 christos #wps_cred_processing=0
216 1.1 christos
217 1.1.1.3 christos # Vendor attribute in WPS M1, e.g., Windows 7 Vertical Pairing
218 1.1.1.3 christos # The vendor attribute contents to be added in M1 (hex string)
219 1.1.1.3 christos #wps_vendor_ext_m1=000137100100020001
220 1.1.1.3 christos
221 1.1.1.3 christos # NFC password token for WPS
222 1.1.1.3 christos # These parameters can be used to configure a fixed NFC password token for the
223 1.1.1.3 christos # station. This can be generated, e.g., with nfc_pw_token. When these
224 1.1.1.3 christos # parameters are used, the station is assumed to be deployed with a NFC tag
225 1.1.1.3 christos # that includes the matching NFC password token (e.g., written based on the
226 1.1.1.3 christos # NDEF record from nfc_pw_token).
227 1.1.1.3 christos #
228 1.1.1.3 christos #wps_nfc_dev_pw_id: Device Password ID (16..65535)
229 1.1.1.3 christos #wps_nfc_dh_pubkey: Hexdump of DH Public Key
230 1.1.1.3 christos #wps_nfc_dh_privkey: Hexdump of DH Private Key
231 1.1.1.3 christos #wps_nfc_dev_pw: Hexdump of Device Password
232 1.1.1.3 christos
233 1.1 christos # Maximum number of BSS entries to keep in memory
234 1.1 christos # Default: 200
235 1.1 christos # This can be used to limit memory use on the BSS entries (cached scan
236 1.1 christos # results). A larger value may be needed in environments that have huge number
237 1.1 christos # of APs when using ap_scan=1 mode.
238 1.1 christos #bss_max_count=200
239 1.1 christos
240 1.1.1.3 christos # Automatic scan
241 1.1.1.3 christos # This is an optional set of parameters for automatic scanning
242 1.1.1.3 christos # within an interface in following format:
243 1.1.1.3 christos #autoscan=<autoscan module name>:<module parameters>
244 1.1.1.3 christos #autoscan is like bgscan but on disconnected or inactive state.
245 1.1.1.3 christos #For instance, on exponential module parameters would be <base>:<limit>
246 1.1.1.3 christos #autoscan=exponential:3:300
247 1.1.1.3 christos # Which means a delay between scans on a base exponential of 3,
248 1.1.1.3 christos #up to the limit of 300 seconds (3, 9, 27 ... 300)
249 1.1.1.3 christos #For periodic module, parameters would be <fixed interval>
250 1.1.1.3 christos #autoscan=periodic:30
251 1.1.1.3 christos #So a delay of 30 seconds will be applied between each scan
252 1.1 christos
253 1.1 christos # filter_ssids - SSID-based scan result filtering
254 1.1 christos # 0 = do not filter scan results (default)
255 1.1 christos # 1 = only include configured SSIDs in scan results/BSS table
256 1.1 christos #filter_ssids=0
257 1.1 christos
258 1.1.1.3 christos # Password (and passphrase, etc.) backend for external storage
259 1.1.1.3 christos # format: <backend name>[:<optional backend parameters>]
260 1.1.1.3 christos #ext_password_backend=test:pw1=password|pw2=testing
261 1.1.1.3 christos
262 1.1.1.3 christos # Timeout in seconds to detect STA inactivity (default: 300 seconds)
263 1.1.1.3 christos #
264 1.1.1.3 christos # This timeout value is used in P2P GO mode to clean up
265 1.1.1.3 christos # inactive stations.
266 1.1.1.3 christos #p2p_go_max_inactivity=300
267 1.1.1.3 christos
268 1.1.1.3 christos # Opportunistic Key Caching (also known as Proactive Key Caching) default
269 1.1.1.3 christos # This parameter can be used to set the default behavior for the
270 1.1.1.3 christos # proactive_key_caching parameter. By default, OKC is disabled unless enabled
271 1.1.1.3 christos # with the global okc=1 parameter or with the per-network
272 1.1.1.3 christos # proactive_key_caching=1 parameter. With okc=1, OKC is enabled by default, but
273 1.1.1.3 christos # can be disabled with per-network proactive_key_caching=0 parameter.
274 1.1.1.3 christos #okc=0
275 1.1.1.3 christos
276 1.1.1.3 christos # Protected Management Frames default
277 1.1.1.3 christos # This parameter can be used to set the default behavior for the ieee80211w
278 1.1.1.3 christos # parameter. By default, PMF is disabled unless enabled with the global pmf=1/2
279 1.1.1.3 christos # parameter or with the per-network ieee80211w=1/2 parameter. With pmf=1/2, PMF
280 1.1.1.3 christos # is enabled/required by default, but can be disabled with the per-network
281 1.1.1.3 christos # ieee80211w parameter.
282 1.1.1.3 christos #pmf=0
283 1.1 christos
284 1.1.1.2 christos # Interworking (IEEE 802.11u)
285 1.1.1.2 christos
286 1.1.1.2 christos # Enable Interworking
287 1.1.1.2 christos # interworking=1
288 1.1.1.2 christos
289 1.1.1.2 christos # Homogenous ESS identifier
290 1.1.1.2 christos # If this is set, scans will be used to request response only from BSSes
291 1.1.1.2 christos # belonging to the specified Homogeneous ESS. This is used only if interworking
292 1.1.1.2 christos # is enabled.
293 1.1.1.2 christos # hessid=00:11:22:33:44:55
294 1.1.1.2 christos
295 1.1.1.3 christos # Automatic network selection behavior
296 1.1.1.3 christos # 0 = do not automatically go through Interworking network selection
297 1.1.1.3 christos # (i.e., require explicit interworking_select command for this; default)
298 1.1.1.3 christos # 1 = perform Interworking network selection if one or more
299 1.1.1.3 christos # credentials have been configured and scan did not find a
300 1.1.1.3 christos # matching network block
301 1.1.1.3 christos #auto_interworking=0
302 1.1.1.2 christos
303 1.1.1.3 christos # credential block
304 1.1.1.3 christos #
305 1.1.1.3 christos # Each credential used for automatic network selection is configured as a set
306 1.1.1.3 christos # of parameters that are compared to the information advertised by the APs when
307 1.1.1.3 christos # interworking_select and interworking_connect commands are used.
308 1.1.1.3 christos #
309 1.1.1.3 christos # credential fields:
310 1.1.1.3 christos #
311 1.1.1.3 christos # priority: Priority group
312 1.1.1.3 christos # By default, all networks and credentials get the same priority group
313 1.1.1.3 christos # (0). This field can be used to give higher priority for credentials
314 1.1.1.3 christos # (and similarly in struct wpa_ssid for network blocks) to change the
315 1.1.1.3 christos # Interworking automatic networking selection behavior. The matching
316 1.1.1.3 christos # network (based on either an enabled network block or a credential)
317 1.1.1.3 christos # with the highest priority value will be selected.
318 1.1.1.3 christos #
319 1.1.1.3 christos # pcsc: Use PC/SC and SIM/USIM card
320 1.1.1.3 christos #
321 1.1.1.3 christos # realm: Home Realm for Interworking
322 1.1.1.3 christos #
323 1.1.1.3 christos # username: Username for Interworking network selection
324 1.1.1.3 christos #
325 1.1.1.3 christos # password: Password for Interworking network selection
326 1.1.1.3 christos #
327 1.1.1.3 christos # ca_cert: CA certificate for Interworking network selection
328 1.1.1.3 christos #
329 1.1.1.3 christos # client_cert: File path to client certificate file (PEM/DER)
330 1.1.1.3 christos # This field is used with Interworking networking selection for a case
331 1.1.1.3 christos # where client certificate/private key is used for authentication
332 1.1.1.3 christos # (EAP-TLS). Full path to the file should be used since working
333 1.1.1.3 christos # directory may change when wpa_supplicant is run in the background.
334 1.1.1.3 christos #
335 1.1.1.3 christos # Alternatively, a named configuration blob can be used by setting
336 1.1.1.3 christos # this to blob://blob_name.
337 1.1.1.3 christos #
338 1.1.1.3 christos # private_key: File path to client private key file (PEM/DER/PFX)
339 1.1.1.3 christos # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
340 1.1.1.3 christos # commented out. Both the private key and certificate will be read
341 1.1.1.3 christos # from the PKCS#12 file in this case. Full path to the file should be
342 1.1.1.3 christos # used since working directory may change when wpa_supplicant is run
343 1.1.1.3 christos # in the background.
344 1.1.1.3 christos #
345 1.1.1.3 christos # Windows certificate store can be used by leaving client_cert out and
346 1.1.1.3 christos # configuring private_key in one of the following formats:
347 1.1.1.3 christos #
348 1.1.1.3 christos # cert://substring_to_match
349 1.1.1.3 christos #
350 1.1.1.3 christos # hash://certificate_thumbprint_in_hex
351 1.1.1.3 christos #
352 1.1.1.3 christos # For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
353 1.1.1.3 christos #
354 1.1.1.3 christos # Note that when running wpa_supplicant as an application, the user
355 1.1.1.3 christos # certificate store (My user account) is used, whereas computer store
356 1.1.1.3 christos # (Computer account) is used when running wpasvc as a service.
357 1.1.1.3 christos #
358 1.1.1.3 christos # Alternatively, a named configuration blob can be used by setting
359 1.1.1.3 christos # this to blob://blob_name.
360 1.1.1.3 christos #
361 1.1.1.3 christos # private_key_passwd: Password for private key file
362 1.1.1.3 christos #
363 1.1.1.3 christos # imsi: IMSI in <MCC> | <MNC> | '-' | <MSIN> format
364 1.1.1.3 christos #
365 1.1.1.3 christos # milenage: Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN>
366 1.1.1.3 christos # format
367 1.1.1.3 christos #
368 1.1.1.3 christos # domain: Home service provider FQDN
369 1.1.1.3 christos # This is used to compare against the Domain Name List to figure out
370 1.1.1.3 christos # whether the AP is operated by the Home SP.
371 1.1.1.3 christos #
372 1.1.1.3 christos # roaming_consortium: Roaming Consortium OI
373 1.1.1.3 christos # If roaming_consortium_len is non-zero, this field contains the
374 1.1.1.3 christos # Roaming Consortium OI that can be used to determine which access
375 1.1.1.3 christos # points support authentication with this credential. This is an
376 1.1.1.3 christos # alternative to the use of the realm parameter. When using Roaming
377 1.1.1.3 christos # Consortium to match the network, the EAP parameters need to be
378 1.1.1.3 christos # pre-configured with the credential since the NAI Realm information
379 1.1.1.3 christos # may not be available or fetched.
380 1.1.1.3 christos #
381 1.1.1.3 christos # eap: Pre-configured EAP method
382 1.1.1.3 christos # This optional field can be used to specify which EAP method will be
383 1.1.1.3 christos # used with this credential. If not set, the EAP method is selected
384 1.1.1.3 christos # automatically based on ANQP information (e.g., NAI Realm).
385 1.1.1.3 christos #
386 1.1.1.3 christos # phase1: Pre-configure Phase 1 (outer authentication) parameters
387 1.1.1.3 christos # This optional field is used with like the 'eap' parameter.
388 1.1.1.3 christos #
389 1.1.1.3 christos # phase2: Pre-configure Phase 2 (inner authentication) parameters
390 1.1.1.3 christos # This optional field is used with like the 'eap' parameter.
391 1.1.1.3 christos #
392 1.1.1.3 christos # excluded_ssid: Excluded SSID
393 1.1.1.3 christos # This optional field can be used to excluded specific SSID(s) from
394 1.1.1.3 christos # matching with the network. Multiple entries can be used to specify more
395 1.1.1.3 christos # than one SSID.
396 1.1.1.3 christos #
397 1.1.1.3 christos # for example:
398 1.1.1.3 christos #
399 1.1.1.3 christos #cred={
400 1.1.1.3 christos # realm="example.com"
401 1.1.1.3 christos # username="user (at] example.com"
402 1.1.1.3 christos # password="password"
403 1.1.1.3 christos # ca_cert="/etc/wpa_supplicant/ca.pem"
404 1.1.1.3 christos # domain="example.com"
405 1.1.1.3 christos #}
406 1.1.1.3 christos #
407 1.1.1.3 christos #cred={
408 1.1.1.3 christos # imsi="310026-000000000"
409 1.1.1.3 christos # milenage="90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82"
410 1.1.1.3 christos #}
411 1.1.1.3 christos #
412 1.1.1.3 christos #cred={
413 1.1.1.3 christos # realm="example.com"
414 1.1.1.3 christos # username="user"
415 1.1.1.3 christos # password="password"
416 1.1.1.3 christos # ca_cert="/etc/wpa_supplicant/ca.pem"
417 1.1.1.3 christos # domain="example.com"
418 1.1.1.3 christos # roaming_consortium=223344
419 1.1.1.3 christos # eap=TTLS
420 1.1.1.3 christos # phase2="auth=MSCHAPV2"
421 1.1.1.3 christos #}
422 1.1.1.2 christos
423 1.1.1.3 christos # Hotspot 2.0
424 1.1.1.3 christos # hs20=1
425 1.1.1.2 christos
426 1.1 christos # network block
427 1.1 christos #
428 1.1 christos # Each network (usually AP's sharing the same SSID) is configured as a separate
429 1.1 christos # block in this configuration file. The network blocks are in preference order
430 1.1 christos # (the first match is used).
431 1.1 christos #
432 1.1 christos # network block fields:
433 1.1 christos #
434 1.1 christos # disabled:
435 1.1 christos # 0 = this network can be used (default)
436 1.1 christos # 1 = this network block is disabled (can be enabled through ctrl_iface,
437 1.1 christos # e.g., with wpa_cli or wpa_gui)
438 1.1 christos #
439 1.1 christos # id_str: Network identifier string for external scripts. This value is passed
440 1.1 christos # to external action script through wpa_cli as WPA_ID_STR environment
441 1.1 christos # variable to make it easier to do network specific configuration.
442 1.1 christos #
443 1.1.1.3 christos # ssid: SSID (mandatory); network name in one of the optional formats:
444 1.1.1.3 christos # - an ASCII string with double quotation
445 1.1.1.3 christos # - a hex string (two characters per octet of SSID)
446 1.1.1.3 christos # - a printf-escaped ASCII string P"<escaped string>"
447 1.1 christos #
448 1.1 christos # scan_ssid:
449 1.1 christos # 0 = do not scan this SSID with specific Probe Request frames (default)
450 1.1 christos # 1 = scan with SSID-specific Probe Request frames (this can be used to
451 1.1 christos # find APs that do not accept broadcast SSID or use multiple SSIDs;
452 1.1 christos # this will add latency to scanning, so enable this only when needed)
453 1.1 christos #
454 1.1 christos # bssid: BSSID (optional); if set, this network block is used only when
455 1.1 christos # associating with the AP using the configured BSSID
456 1.1 christos #
457 1.1 christos # priority: priority group (integer)
458 1.1 christos # By default, all networks will get same priority group (0). If some of the
459 1.1 christos # networks are more desirable, this field can be used to change the order in
460 1.1 christos # which wpa_supplicant goes through the networks when selecting a BSS. The
461 1.1 christos # priority groups will be iterated in decreasing priority (i.e., the larger the
462 1.1 christos # priority value, the sooner the network is matched against the scan results).
463 1.1 christos # Within each priority group, networks will be selected based on security
464 1.1 christos # policy, signal strength, etc.
465 1.1 christos # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not
466 1.1 christos # using this priority to select the order for scanning. Instead, they try the
467 1.1 christos # networks in the order that used in the configuration file.
468 1.1 christos #
469 1.1 christos # mode: IEEE 802.11 operation mode
470 1.1 christos # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default)
471 1.1 christos # 1 = IBSS (ad-hoc, peer-to-peer)
472 1.1 christos # 2 = AP (access point)
473 1.1 christos # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP)
474 1.1 christos # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires
475 1.1 christos # following network block options:
476 1.1 christos # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not
477 1.1 christos # both), and psk must also be set.
478 1.1 christos #
479 1.1 christos # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g.,
480 1.1 christos # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial
481 1.1 christos # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode.
482 1.1 christos # In addition, this value is only used by the station that creates the IBSS. If
483 1.1 christos # an IBSS network with the configured SSID is already present, the frequency of
484 1.1 christos # the network will be used instead of this configured value.
485 1.1 christos #
486 1.1 christos # scan_freq: List of frequencies to scan
487 1.1 christos # Space-separated list of frequencies in MHz to scan when searching for this
488 1.1 christos # BSS. If the subset of channels used by the network is known, this option can
489 1.1 christos # be used to optimize scanning to not occur on channels that the network does
490 1.1 christos # not use. Example: scan_freq=2412 2437 2462
491 1.1 christos #
492 1.1 christos # freq_list: Array of allowed frequencies
493 1.1 christos # Space-separated list of frequencies in MHz to allow for selecting the BSS. If
494 1.1 christos # set, scan results that do not match any of the specified frequencies are not
495 1.1 christos # considered when selecting a BSS.
496 1.1 christos #
497 1.1.1.3 christos # bgscan: Background scanning
498 1.1.1.3 christos # wpa_supplicant behavior for background scanning can be specified by
499 1.1.1.3 christos # configuring a bgscan module. These modules are responsible for requesting
500 1.1.1.3 christos # background scans for the purpose of roaming within an ESS (i.e., within a
501 1.1.1.3 christos # single network block with all the APs using the same SSID). The bgscan
502 1.1.1.3 christos # parameter uses following format: "<bgscan module name>:<module parameters>"
503 1.1.1.3 christos # Following bgscan modules are available:
504 1.1.1.3 christos # simple - Periodic background scans based on signal strength
505 1.1.1.3 christos # bgscan="simple:<short bgscan interval in seconds>:<signal strength threshold>:
506 1.1.1.3 christos # <long interval>"
507 1.1.1.3 christos # bgscan="simple:30:-45:300"
508 1.1.1.3 christos # learn - Learn channels used by the network and try to avoid bgscans on other
509 1.1.1.3 christos # channels (experimental)
510 1.1.1.3 christos # bgscan="learn:<short bgscan interval in seconds>:<signal strength threshold>:
511 1.1.1.3 christos # <long interval>[:<database file name>]"
512 1.1.1.3 christos # bgscan="learn:30:-45:300:/etc/wpa_supplicant/network1.bgscan"
513 1.1.1.3 christos #
514 1.1 christos # proto: list of accepted protocols
515 1.1 christos # WPA = WPA/IEEE 802.11i/D3.0
516 1.1 christos # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN)
517 1.1 christos # If not set, this defaults to: WPA RSN
518 1.1 christos #
519 1.1 christos # key_mgmt: list of accepted authenticated key management protocols
520 1.1 christos # WPA-PSK = WPA pre-shared key (this requires 'psk' field)
521 1.1 christos # WPA-EAP = WPA using EAP authentication
522 1.1 christos # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically
523 1.1 christos # generated WEP keys
524 1.1 christos # NONE = WPA is not used; plaintext or static WEP could be used
525 1.1 christos # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms
526 1.1 christos # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms
527 1.1 christos # If not set, this defaults to: WPA-PSK WPA-EAP
528 1.1 christos #
529 1.1.1.3 christos # ieee80211w: whether management frame protection is enabled
530 1.1.1.3 christos # 0 = disabled (default unless changed with the global pmf parameter)
531 1.1.1.3 christos # 1 = optional
532 1.1.1.3 christos # 2 = required
533 1.1.1.3 christos # The most common configuration options for this based on the PMF (protected
534 1.1.1.3 christos # management frames) certification program are:
535 1.1.1.3 christos # PMF enabled: ieee80211w=1 and key_mgmt=WPA-EAP WPA-EAP-SHA256
536 1.1.1.3 christos # PMF required: ieee80211w=2 and key_mgmt=WPA-EAP-SHA256
537 1.1.1.3 christos # (and similarly for WPA-PSK and WPA-WPSK-SHA256 if WPA2-Personal is used)
538 1.1.1.3 christos #
539 1.1 christos # auth_alg: list of allowed IEEE 802.11 authentication algorithms
540 1.1 christos # OPEN = Open System authentication (required for WPA/WPA2)
541 1.1 christos # SHARED = Shared Key authentication (requires static WEP keys)
542 1.1 christos # LEAP = LEAP/Network EAP (only used with LEAP)
543 1.1 christos # If not set, automatic selection is used (Open System with LEAP enabled if
544 1.1 christos # LEAP is allowed as one of the EAP methods).
545 1.1 christos #
546 1.1 christos # pairwise: list of accepted pairwise (unicast) ciphers for WPA
547 1.1 christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
548 1.1 christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
549 1.1 christos # NONE = Use only Group Keys (deprecated, should not be included if APs support
550 1.1 christos # pairwise keys)
551 1.1 christos # If not set, this defaults to: CCMP TKIP
552 1.1 christos #
553 1.1 christos # group: list of accepted group (broadcast/multicast) ciphers for WPA
554 1.1 christos # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0]
555 1.1 christos # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0]
556 1.1 christos # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key
557 1.1 christos # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11]
558 1.1 christos # If not set, this defaults to: CCMP TKIP WEP104 WEP40
559 1.1 christos #
560 1.1 christos # psk: WPA preshared key; 256-bit pre-shared key
561 1.1 christos # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e.,
562 1.1 christos # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be
563 1.1 christos # generated using the passphrase and SSID). ASCII passphrase must be between
564 1.1.1.3 christos # 8 and 63 characters (inclusive). ext:<name of external PSK field> format can
565 1.1.1.3 christos # be used to indicate that the PSK/passphrase is stored in external storage.
566 1.1 christos # This field is not needed, if WPA-EAP is used.
567 1.1 christos # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys
568 1.1 christos # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant
569 1.1 christos # startup and reconfiguration time can be optimized by generating the PSK only
570 1.1 christos # only when the passphrase or SSID has actually changed.
571 1.1 christos #
572 1.1 christos # eapol_flags: IEEE 802.1X/EAPOL options (bit field)
573 1.1 christos # Dynamic WEP key required for non-WPA mode
574 1.1 christos # bit0 (1): require dynamically generated unicast WEP key
575 1.1 christos # bit1 (2): require dynamically generated broadcast WEP key
576 1.1 christos # (3 = require both keys; default)
577 1.1 christos # Note: When using wired authentication, eapol_flags must be set to 0 for the
578 1.1 christos # authentication to be completed successfully.
579 1.1 christos #
580 1.1 christos # mixed_cell: This option can be used to configure whether so called mixed
581 1.1 christos # cells, i.e., networks that use both plaintext and encryption in the same
582 1.1.1.2 christos # SSID, are allowed when selecting a BSS from scan results.
583 1.1 christos # 0 = disabled (default)
584 1.1 christos # 1 = enabled
585 1.1 christos #
586 1.1 christos # proactive_key_caching:
587 1.1 christos # Enable/disable opportunistic PMKSA caching for WPA2.
588 1.1.1.3 christos # 0 = disabled (default unless changed with the global okc parameter)
589 1.1 christos # 1 = enabled
590 1.1 christos #
591 1.1 christos # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or
592 1.1 christos # hex without quotation, e.g., 0102030405)
593 1.1 christos # wep_tx_keyidx: Default WEP key index (TX) (0..3)
594 1.1 christos #
595 1.1 christos # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is
596 1.1 christos # allowed. This is only used with RSN/WPA2.
597 1.1 christos # 0 = disabled (default)
598 1.1 christos # 1 = enabled
599 1.1 christos #peerkey=1
600 1.1 christos #
601 1.1 christos # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to
602 1.1 christos # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.
603 1.1 christos #
604 1.1 christos # Following fields are only used with internal EAP implementation.
605 1.1 christos # eap: space-separated list of accepted EAP methods
606 1.1 christos # MD5 = EAP-MD5 (unsecure and does not generate keying material ->
607 1.1 christos # cannot be used with WPA; to be used as a Phase 2 method
608 1.1 christos # with EAP-PEAP or EAP-TTLS)
609 1.1 christos # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used
610 1.1 christos # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
611 1.1 christos # OTP = EAP-OTP (cannot be used separately with WPA; to be used
612 1.1 christos # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
613 1.1 christos # GTC = EAP-GTC (cannot be used separately with WPA; to be used
614 1.1 christos # as a Phase 2 method with EAP-PEAP or EAP-TTLS)
615 1.1 christos # TLS = EAP-TLS (client and server certificate)
616 1.1 christos # PEAP = EAP-PEAP (with tunnelled EAP authentication)
617 1.1 christos # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2
618 1.1 christos # authentication)
619 1.1 christos # If not set, all compiled in methods are allowed.
620 1.1 christos #
621 1.1 christos # identity: Identity string for EAP
622 1.1 christos # This field is also used to configure user NAI for
623 1.1 christos # EAP-PSK/PAX/SAKE/GPSK.
624 1.1 christos # anonymous_identity: Anonymous identity string for EAP (to be used as the
625 1.1 christos # unencrypted identity with EAP types that support different tunnelled
626 1.1.1.3 christos # identity, e.g., EAP-TTLS). This field can also be used with
627 1.1.1.3 christos # EAP-SIM/AKA/AKA' to store the pseudonym identity.
628 1.1 christos # password: Password string for EAP. This field can include either the
629 1.1 christos # plaintext password (using ASCII or hex string) or a NtPasswordHash
630 1.1 christos # (16-byte MD4 hash of password) in hash:<32 hex digits> format.
631 1.1 christos # NtPasswordHash can only be used when the password is for MSCHAPv2 or
632 1.1 christos # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP).
633 1.1 christos # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit
634 1.1 christos # PSK) is also configured using this field. For EAP-GPSK, this is a
635 1.1.1.3 christos # variable length PSK. ext:<name of external password field> format can
636 1.1.1.3 christos # be used to indicate that the password is stored in external storage.
637 1.1 christos # ca_cert: File path to CA certificate file (PEM/DER). This file can have one
638 1.1 christos # or more trusted CA certificates. If ca_cert and ca_path are not
639 1.1 christos # included, server certificate will not be verified. This is insecure and
640 1.1 christos # a trusted CA certificate should always be configured when using
641 1.1 christos # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may
642 1.1 christos # change when wpa_supplicant is run in the background.
643 1.1 christos #
644 1.1 christos # Alternatively, this can be used to only perform matching of the server
645 1.1 christos # certificate (SHA-256 hash of the DER encoded X.509 certificate). In
646 1.1 christos # this case, the possible CA certificates in the server certificate chain
647 1.1 christos # are ignored and only the server certificate is verified. This is
648 1.1 christos # configured with the following format:
649 1.1 christos # hash:://server/sha256/cert_hash_in_hex
650 1.1 christos # For example: "hash://server/sha256/
651 1.1 christos # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a"
652 1.1 christos #
653 1.1 christos # On Windows, trusted CA certificates can be loaded from the system
654 1.1 christos # certificate store by setting this to cert_store://<name>, e.g.,
655 1.1 christos # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT".
656 1.1 christos # Note that when running wpa_supplicant as an application, the user
657 1.1 christos # certificate store (My user account) is used, whereas computer store
658 1.1 christos # (Computer account) is used when running wpasvc as a service.
659 1.1 christos # ca_path: Directory path for CA certificate files (PEM). This path may
660 1.1 christos # contain multiple CA certificates in OpenSSL format. Common use for this
661 1.1 christos # is to point to system trusted CA list which is often installed into
662 1.1 christos # directory like /etc/ssl/certs. If configured, these certificates are
663 1.1 christos # added to the list of trusted CAs. ca_cert may also be included in that
664 1.1 christos # case, but it is not required.
665 1.1 christos # client_cert: File path to client certificate file (PEM/DER)
666 1.1 christos # Full path should be used since working directory may change when
667 1.1 christos # wpa_supplicant is run in the background.
668 1.1 christos # Alternatively, a named configuration blob can be used by setting this
669 1.1 christos # to blob://<blob name>.
670 1.1 christos # private_key: File path to client private key file (PEM/DER/PFX)
671 1.1 christos # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
672 1.1 christos # commented out. Both the private key and certificate will be read from
673 1.1 christos # the PKCS#12 file in this case. Full path should be used since working
674 1.1 christos # directory may change when wpa_supplicant is run in the background.
675 1.1 christos # Windows certificate store can be used by leaving client_cert out and
676 1.1 christos # configuring private_key in one of the following formats:
677 1.1 christos # cert://substring_to_match
678 1.1 christos # hash://certificate_thumbprint_in_hex
679 1.1 christos # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
680 1.1 christos # Note that when running wpa_supplicant as an application, the user
681 1.1 christos # certificate store (My user account) is used, whereas computer store
682 1.1 christos # (Computer account) is used when running wpasvc as a service.
683 1.1 christos # Alternatively, a named configuration blob can be used by setting this
684 1.1 christos # to blob://<blob name>.
685 1.1 christos # private_key_passwd: Password for private key file (if left out, this will be
686 1.1 christos # asked through control interface)
687 1.1 christos # dh_file: File path to DH/DSA parameters file (in PEM format)
688 1.1 christos # This is an optional configuration file for setting parameters for an
689 1.1 christos # ephemeral DH key exchange. In most cases, the default RSA
690 1.1 christos # authentication does not use this configuration. However, it is possible
691 1.1 christos # setup RSA to use ephemeral DH key exchange. In addition, ciphers with
692 1.1 christos # DSA keys always use ephemeral DH keys. This can be used to achieve
693 1.1 christos # forward secrecy. If the file is in DSA parameters format, it will be
694 1.1 christos # automatically converted into DH params.
695 1.1 christos # subject_match: Substring to be matched against the subject of the
696 1.1 christos # authentication server certificate. If this string is set, the server
697 1.1 christos # sertificate is only accepted if it contains this string in the subject.
698 1.1 christos # The subject string is in following format:
699 1.1 christos # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as (at] example.com
700 1.1 christos # altsubject_match: Semicolon separated string of entries to be matched against
701 1.1 christos # the alternative subject name of the authentication server certificate.
702 1.1 christos # If this string is set, the server sertificate is only accepted if it
703 1.1 christos # contains one of the entries in an alternative subject name extension.
704 1.1 christos # altSubjectName string is in following format: TYPE:VALUE
705 1.1 christos # Example: EMAIL:server (at] example.com
706 1.1 christos # Example: DNS:server.example.com;DNS:server2.example.com
707 1.1 christos # Following types are supported: EMAIL, DNS, URI
708 1.1 christos # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters
709 1.1 christos # (string with field-value pairs, e.g., "peapver=0" or
710 1.1 christos # "peapver=1 peaplabel=1")
711 1.1 christos # 'peapver' can be used to force which PEAP version (0 or 1) is used.
712 1.1 christos # 'peaplabel=1' can be used to force new label, "client PEAP encryption",
713 1.1 christos # to be used during key derivation when PEAPv1 or newer. Most existing
714 1.1 christos # PEAPv1 implementation seem to be using the old label, "client EAP
715 1.1 christos # encryption", and wpa_supplicant is now using that as the default value.
716 1.1 christos # Some servers, e.g., Radiator, may require peaplabel=1 configuration to
717 1.1 christos # interoperate with PEAPv1; see eap_testing.txt for more details.
718 1.1 christos # 'peap_outer_success=0' can be used to terminate PEAP authentication on
719 1.1 christos # tunneled EAP-Success. This is required with some RADIUS servers that
720 1.1 christos # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g.,
721 1.1 christos # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode)
722 1.1 christos # include_tls_length=1 can be used to force wpa_supplicant to include
723 1.1 christos # TLS Message Length field in all TLS messages even if they are not
724 1.1 christos # fragmented.
725 1.1 christos # sim_min_num_chal=3 can be used to configure EAP-SIM to require three
726 1.1 christos # challenges (by default, it accepts 2 or 3)
727 1.1 christos # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use
728 1.1 christos # protected result indication.
729 1.1 christos # 'crypto_binding' option can be used to control PEAPv0 cryptobinding
730 1.1 christos # behavior:
731 1.1 christos # * 0 = do not use cryptobinding (default)
732 1.1 christos # * 1 = use cryptobinding if server supports it
733 1.1 christos # * 2 = require cryptobinding
734 1.1 christos # EAP-WSC (WPS) uses following options: pin=<Device Password> or
735 1.1 christos # pbc=1.
736 1.1 christos # phase2: Phase2 (inner authentication with TLS tunnel) parameters
737 1.1 christos # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or
738 1.1 christos # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS)
739 1.1.1.3 christos #
740 1.1.1.3 christos # TLS-based methods can use the following parameters to control TLS behavior
741 1.1.1.3 christos # (these are normally in the phase1 parameter, but can be used also in the
742 1.1.1.3 christos # phase2 parameter when EAP-TLS is used within the inner tunnel):
743 1.1.1.3 christos # tls_allow_md5=1 - allow MD5-based certificate signatures (depending on the
744 1.1.1.3 christos # TLS library, these may be disabled by default to enforce stronger
745 1.1.1.3 christos # security)
746 1.1.1.3 christos # tls_disable_time_checks=1 - ignore certificate validity time (this requests
747 1.1.1.3 christos # the TLS library to accept certificates even if they are not currently
748 1.1.1.3 christos # valid, i.e., have expired or have not yet become valid; this should be
749 1.1.1.3 christos # used only for testing purposes)
750 1.1.1.3 christos # tls_disable_session_ticket=1 - disable TLS Session Ticket extension
751 1.1.1.3 christos # tls_disable_session_ticket=0 - allow TLS Session Ticket extension to be used
752 1.1.1.3 christos # Note: If not set, this is automatically set to 1 for EAP-TLS/PEAP/TTLS
753 1.1.1.3 christos # as a workaround for broken authentication server implementations unless
754 1.1.1.3 christos # EAP workarounds are disabled with eap_workarounds=0.
755 1.1.1.3 christos # For EAP-FAST, this must be set to 0 (or left unconfigured for the
756 1.1.1.3 christos # default value to be used automatically).
757 1.1.1.3 christos #
758 1.1 christos # Following certificate/private key fields are used in inner Phase2
759 1.1 christos # authentication when using EAP-TTLS or EAP-PEAP.
760 1.1 christos # ca_cert2: File path to CA certificate file. This file can have one or more
761 1.1 christos # trusted CA certificates. If ca_cert2 and ca_path2 are not included,
762 1.1 christos # server certificate will not be verified. This is insecure and a trusted
763 1.1 christos # CA certificate should always be configured.
764 1.1 christos # ca_path2: Directory path for CA certificate files (PEM)
765 1.1 christos # client_cert2: File path to client certificate file
766 1.1 christos # private_key2: File path to client private key file
767 1.1 christos # private_key2_passwd: Password for private key file
768 1.1 christos # dh_file2: File path to DH/DSA parameters file (in PEM format)
769 1.1 christos # subject_match2: Substring to be matched against the subject of the
770 1.1 christos # authentication server certificate.
771 1.1 christos # altsubject_match2: Substring to be matched against the alternative subject
772 1.1 christos # name of the authentication server certificate.
773 1.1 christos #
774 1.1 christos # fragment_size: Maximum EAP fragment size in bytes (default 1398).
775 1.1 christos # This value limits the fragment size for EAP methods that support
776 1.1 christos # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set
777 1.1 christos # small enough to make the EAP messages fit in MTU of the network
778 1.1 christos # interface used for EAPOL. The default value is suitable for most
779 1.1 christos # cases.
780 1.1 christos #
781 1.1 christos # EAP-FAST variables:
782 1.1 christos # pac_file: File path for the PAC entries. wpa_supplicant will need to be able
783 1.1 christos # to create this file and write updates to it when PAC is being
784 1.1 christos # provisioned or refreshed. Full path to the file should be used since
785 1.1 christos # working directory may change when wpa_supplicant is run in the
786 1.1 christos # background. Alternatively, a named configuration blob can be used by
787 1.1 christos # setting this to blob://<blob name>
788 1.1 christos # phase1: fast_provisioning option can be used to enable in-line provisioning
789 1.1 christos # of EAP-FAST credentials (PAC):
790 1.1 christos # 0 = disabled,
791 1.1 christos # 1 = allow unauthenticated provisioning,
792 1.1 christos # 2 = allow authenticated provisioning,
793 1.1 christos # 3 = allow both unauthenticated and authenticated provisioning
794 1.1 christos # fast_max_pac_list_len=<num> option can be used to set the maximum
795 1.1 christos # number of PAC entries to store in a PAC list (default: 10)
796 1.1 christos # fast_pac_format=binary option can be used to select binary format for
797 1.1 christos # storing PAC entries in order to save some space (the default
798 1.1 christos # text format uses about 2.5 times the size of minimal binary
799 1.1 christos # format)
800 1.1 christos #
801 1.1 christos # wpa_supplicant supports number of "EAP workarounds" to work around
802 1.1 christos # interoperability issues with incorrectly behaving authentication servers.
803 1.1 christos # These are enabled by default because some of the issues are present in large
804 1.1 christos # number of authentication servers. Strict EAP conformance mode can be
805 1.1 christos # configured by disabling workarounds with eap_workaround=0.
806 1.1 christos
807 1.1.1.3 christos # Station inactivity limit
808 1.1.1.3 christos #
809 1.1.1.3 christos # If a station does not send anything in ap_max_inactivity seconds, an
810 1.1.1.3 christos # empty data frame is sent to it in order to verify whether it is
811 1.1.1.3 christos # still in range. If this frame is not ACKed, the station will be
812 1.1.1.3 christos # disassociated and then deauthenticated. This feature is used to
813 1.1.1.3 christos # clear station table of old entries when the STAs move out of the
814 1.1.1.3 christos # range.
815 1.1.1.3 christos #
816 1.1.1.3 christos # The station can associate again with the AP if it is still in range;
817 1.1.1.3 christos # this inactivity poll is just used as a nicer way of verifying
818 1.1.1.3 christos # inactivity; i.e., client will not report broken connection because
819 1.1.1.3 christos # disassociation frame is not sent immediately without first polling
820 1.1.1.3 christos # the STA with a data frame.
821 1.1.1.3 christos # default: 300 (i.e., 5 minutes)
822 1.1.1.3 christos #ap_max_inactivity=300
823 1.1.1.3 christos
824 1.1.1.3 christos # DTIM period in Beacon intervals for AP mode (default: 2)
825 1.1.1.3 christos #dtim_period=2
826 1.1.1.3 christos
827 1.1.1.3 christos # disable_ht: Whether HT (802.11n) should be disabled.
828 1.1.1.3 christos # 0 = HT enabled (if AP supports it)
829 1.1.1.3 christos # 1 = HT disabled
830 1.1.1.3 christos #
831 1.1.1.3 christos # disable_ht40: Whether HT-40 (802.11n) should be disabled.
832 1.1.1.3 christos # 0 = HT-40 enabled (if AP supports it)
833 1.1.1.3 christos # 1 = HT-40 disabled
834 1.1.1.3 christos #
835 1.1.1.3 christos # disable_sgi: Whether SGI (short guard interval) should be disabled.
836 1.1.1.3 christos # 0 = SGI enabled (if AP supports it)
837 1.1.1.3 christos # 1 = SGI disabled
838 1.1.1.3 christos #
839 1.1.1.3 christos # ht_mcs: Configure allowed MCS rates.
840 1.1.1.3 christos # Parsed as an array of bytes, in base-16 (ascii-hex)
841 1.1.1.3 christos # ht_mcs="" // Use all available (default)
842 1.1.1.3 christos # ht_mcs="0xff 00 00 00 00 00 00 00 00 00 " // Use MCS 0-7 only
843 1.1.1.3 christos # ht_mcs="0xff ff 00 00 00 00 00 00 00 00 " // Use MCS 0-15 only
844 1.1.1.3 christos #
845 1.1.1.3 christos # disable_max_amsdu: Whether MAX_AMSDU should be disabled.
846 1.1.1.3 christos # -1 = Do not make any changes.
847 1.1.1.3 christos # 0 = Enable MAX-AMSDU if hardware supports it.
848 1.1.1.3 christos # 1 = Disable AMSDU
849 1.1.1.3 christos #
850 1.1.1.3 christos # ampdu_density: Allow overriding AMPDU density configuration.
851 1.1.1.3 christos # Treated as hint by the kernel.
852 1.1.1.3 christos # -1 = Do not make any changes.
853 1.1.1.3 christos # 0-3 = Set AMPDU density (aka factor) to specified value.
854 1.1.1.3 christos
855 1.1 christos # Example blocks:
856 1.1 christos
857 1.1 christos # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers
858 1.1 christos network={
859 1.1 christos ssid="simple"
860 1.1 christos psk="very secret passphrase"
861 1.1 christos priority=5
862 1.1 christos }
863 1.1 christos
864 1.1 christos # Same as previous, but request SSID-specific scanning (for APs that reject
865 1.1 christos # broadcast SSID)
866 1.1 christos network={
867 1.1 christos ssid="second ssid"
868 1.1 christos scan_ssid=1
869 1.1 christos psk="very secret passphrase"
870 1.1 christos priority=2
871 1.1 christos }
872 1.1 christos
873 1.1 christos # Only WPA-PSK is used. Any valid cipher combination is accepted.
874 1.1 christos network={
875 1.1 christos ssid="example"
876 1.1 christos proto=WPA
877 1.1 christos key_mgmt=WPA-PSK
878 1.1 christos pairwise=CCMP TKIP
879 1.1 christos group=CCMP TKIP WEP104 WEP40
880 1.1 christos psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
881 1.1 christos priority=2
882 1.1 christos }
883 1.1 christos
884 1.1 christos # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying
885 1.1 christos network={
886 1.1 christos ssid="example"
887 1.1 christos proto=WPA
888 1.1 christos key_mgmt=WPA-PSK
889 1.1 christos pairwise=TKIP
890 1.1 christos group=TKIP
891 1.1 christos psk="not so secure passphrase"
892 1.1 christos wpa_ptk_rekey=600
893 1.1 christos }
894 1.1 christos
895 1.1 christos # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104
896 1.1 christos # or WEP40 as the group cipher will not be accepted.
897 1.1 christos network={
898 1.1 christos ssid="example"
899 1.1 christos proto=RSN
900 1.1 christos key_mgmt=WPA-EAP
901 1.1 christos pairwise=CCMP TKIP
902 1.1 christos group=CCMP TKIP
903 1.1 christos eap=TLS
904 1.1 christos identity="user (at] example.com"
905 1.1 christos ca_cert="/etc/cert/ca.pem"
906 1.1 christos client_cert="/etc/cert/user.pem"
907 1.1 christos private_key="/etc/cert/user.prv"
908 1.1 christos private_key_passwd="password"
909 1.1 christos priority=1
910 1.1 christos }
911 1.1 christos
912 1.1 christos # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel
913 1.1 christos # (e.g., Radiator)
914 1.1 christos network={
915 1.1 christos ssid="example"
916 1.1 christos key_mgmt=WPA-EAP
917 1.1 christos eap=PEAP
918 1.1 christos identity="user (at] example.com"
919 1.1 christos password="foobar"
920 1.1 christos ca_cert="/etc/cert/ca.pem"
921 1.1 christos phase1="peaplabel=1"
922 1.1 christos phase2="auth=MSCHAPV2"
923 1.1 christos priority=10
924 1.1 christos }
925 1.1 christos
926 1.1 christos # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the
927 1.1 christos # unencrypted use. Real identity is sent only within an encrypted TLS tunnel.
928 1.1 christos network={
929 1.1 christos ssid="example"
930 1.1 christos key_mgmt=WPA-EAP
931 1.1 christos eap=TTLS
932 1.1 christos identity="user (at] example.com"
933 1.1 christos anonymous_identity="anonymous (at] example.com"
934 1.1 christos password="foobar"
935 1.1 christos ca_cert="/etc/cert/ca.pem"
936 1.1 christos priority=2
937 1.1 christos }
938 1.1 christos
939 1.1 christos # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted
940 1.1 christos # use. Real identity is sent only within an encrypted TLS tunnel.
941 1.1 christos network={
942 1.1 christos ssid="example"
943 1.1 christos key_mgmt=WPA-EAP
944 1.1 christos eap=TTLS
945 1.1 christos identity="user (at] example.com"
946 1.1 christos anonymous_identity="anonymous (at] example.com"
947 1.1 christos password="foobar"
948 1.1 christos ca_cert="/etc/cert/ca.pem"
949 1.1 christos phase2="auth=MSCHAPV2"
950 1.1 christos }
951 1.1 christos
952 1.1 christos # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner
953 1.1 christos # authentication.
954 1.1 christos network={
955 1.1 christos ssid="example"
956 1.1 christos key_mgmt=WPA-EAP
957 1.1 christos eap=TTLS
958 1.1 christos # Phase1 / outer authentication
959 1.1 christos anonymous_identity="anonymous (at] example.com"
960 1.1 christos ca_cert="/etc/cert/ca.pem"
961 1.1 christos # Phase 2 / inner authentication
962 1.1 christos phase2="autheap=TLS"
963 1.1 christos ca_cert2="/etc/cert/ca2.pem"
964 1.1 christos client_cert2="/etc/cer/user.pem"
965 1.1 christos private_key2="/etc/cer/user.prv"
966 1.1 christos private_key2_passwd="password"
967 1.1 christos priority=2
968 1.1 christos }
969 1.1 christos
970 1.1 christos # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and
971 1.1 christos # group cipher.
972 1.1 christos network={
973 1.1 christos ssid="example"
974 1.1 christos bssid=00:11:22:33:44:55
975 1.1 christos proto=WPA RSN
976 1.1 christos key_mgmt=WPA-PSK WPA-EAP
977 1.1 christos pairwise=CCMP
978 1.1 christos group=CCMP
979 1.1 christos psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb
980 1.1 christos }
981 1.1 christos
982 1.1 christos # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP
983 1.1 christos # and all valid ciphers.
984 1.1 christos network={
985 1.1 christos ssid=00010203
986 1.1 christos psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f
987 1.1 christos }
988 1.1 christos
989 1.1 christos
990 1.1 christos # EAP-SIM with a GSM SIM or USIM
991 1.1 christos network={
992 1.1 christos ssid="eap-sim-test"
993 1.1 christos key_mgmt=WPA-EAP
994 1.1 christos eap=SIM
995 1.1 christos pin="1234"
996 1.1 christos pcsc=""
997 1.1 christos }
998 1.1 christos
999 1.1 christos
1000 1.1 christos # EAP-PSK
1001 1.1 christos network={
1002 1.1 christos ssid="eap-psk-test"
1003 1.1 christos key_mgmt=WPA-EAP
1004 1.1 christos eap=PSK
1005 1.1 christos anonymous_identity="eap_psk_user"
1006 1.1 christos password=06b4be19da289f475aa46a33cb793029
1007 1.1 christos identity="eap_psk_user (at] example.com"
1008 1.1 christos }
1009 1.1 christos
1010 1.1 christos
1011 1.1 christos # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using
1012 1.1 christos # EAP-TLS for authentication and key generation; require both unicast and
1013 1.1 christos # broadcast WEP keys.
1014 1.1 christos network={
1015 1.1 christos ssid="1x-test"
1016 1.1 christos key_mgmt=IEEE8021X
1017 1.1 christos eap=TLS
1018 1.1 christos identity="user (at] example.com"
1019 1.1 christos ca_cert="/etc/cert/ca.pem"
1020 1.1 christos client_cert="/etc/cert/user.pem"
1021 1.1 christos private_key="/etc/cert/user.prv"
1022 1.1 christos private_key_passwd="password"
1023 1.1 christos eapol_flags=3
1024 1.1 christos }
1025 1.1 christos
1026 1.1 christos
1027 1.1 christos # LEAP with dynamic WEP keys
1028 1.1 christos network={
1029 1.1 christos ssid="leap-example"
1030 1.1 christos key_mgmt=IEEE8021X
1031 1.1 christos eap=LEAP
1032 1.1 christos identity="user"
1033 1.1 christos password="foobar"
1034 1.1 christos }
1035 1.1 christos
1036 1.1 christos # EAP-IKEv2 using shared secrets for both server and peer authentication
1037 1.1 christos network={
1038 1.1 christos ssid="ikev2-example"
1039 1.1 christos key_mgmt=WPA-EAP
1040 1.1 christos eap=IKEV2
1041 1.1 christos identity="user"
1042 1.1 christos password="foobar"
1043 1.1 christos }
1044 1.1 christos
1045 1.1 christos # EAP-FAST with WPA (WPA or WPA2)
1046 1.1 christos network={
1047 1.1 christos ssid="eap-fast-test"
1048 1.1 christos key_mgmt=WPA-EAP
1049 1.1 christos eap=FAST
1050 1.1 christos anonymous_identity="FAST-000102030405"
1051 1.1 christos identity="username"
1052 1.1 christos password="password"
1053 1.1 christos phase1="fast_provisioning=1"
1054 1.1 christos pac_file="/etc/wpa_supplicant.eap-fast-pac"
1055 1.1 christos }
1056 1.1 christos
1057 1.1 christos network={
1058 1.1 christos ssid="eap-fast-test"
1059 1.1 christos key_mgmt=WPA-EAP
1060 1.1 christos eap=FAST
1061 1.1 christos anonymous_identity="FAST-000102030405"
1062 1.1 christos identity="username"
1063 1.1 christos password="password"
1064 1.1 christos phase1="fast_provisioning=1"
1065 1.1 christos pac_file="blob://eap-fast-pac"
1066 1.1 christos }
1067 1.1 christos
1068 1.1 christos # Plaintext connection (no WPA, no IEEE 802.1X)
1069 1.1 christos network={
1070 1.1 christos ssid="plaintext-test"
1071 1.1 christos key_mgmt=NONE
1072 1.1 christos }
1073 1.1 christos
1074 1.1 christos
1075 1.1 christos # Shared WEP key connection (no WPA, no IEEE 802.1X)
1076 1.1 christos network={
1077 1.1 christos ssid="static-wep-test"
1078 1.1 christos key_mgmt=NONE
1079 1.1 christos wep_key0="abcde"
1080 1.1 christos wep_key1=0102030405
1081 1.1 christos wep_key2="1234567890123"
1082 1.1 christos wep_tx_keyidx=0
1083 1.1 christos priority=5
1084 1.1 christos }
1085 1.1 christos
1086 1.1 christos
1087 1.1 christos # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key
1088 1.1 christos # IEEE 802.11 authentication
1089 1.1 christos network={
1090 1.1 christos ssid="static-wep-test2"
1091 1.1 christos key_mgmt=NONE
1092 1.1 christos wep_key0="abcde"
1093 1.1 christos wep_key1=0102030405
1094 1.1 christos wep_key2="1234567890123"
1095 1.1 christos wep_tx_keyidx=0
1096 1.1 christos priority=5
1097 1.1 christos auth_alg=SHARED
1098 1.1 christos }
1099 1.1 christos
1100 1.1 christos
1101 1.1 christos # IBSS/ad-hoc network with WPA-None/TKIP.
1102 1.1 christos network={
1103 1.1 christos ssid="test adhoc"
1104 1.1 christos mode=1
1105 1.1 christos frequency=2412
1106 1.1 christos proto=WPA
1107 1.1 christos key_mgmt=WPA-NONE
1108 1.1 christos pairwise=NONE
1109 1.1 christos group=TKIP
1110 1.1 christos psk="secret passphrase"
1111 1.1 christos }
1112 1.1 christos
1113 1.1 christos
1114 1.1 christos # Catch all example that allows more or less all configuration modes
1115 1.1 christos network={
1116 1.1 christos ssid="example"
1117 1.1 christos scan_ssid=1
1118 1.1 christos key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE
1119 1.1 christos pairwise=CCMP TKIP
1120 1.1 christos group=CCMP TKIP WEP104 WEP40
1121 1.1 christos psk="very secret passphrase"
1122 1.1 christos eap=TTLS PEAP TLS
1123 1.1 christos identity="user (at] example.com"
1124 1.1 christos password="foobar"
1125 1.1 christos ca_cert="/etc/cert/ca.pem"
1126 1.1 christos client_cert="/etc/cert/user.pem"
1127 1.1 christos private_key="/etc/cert/user.prv"
1128 1.1 christos private_key_passwd="password"
1129 1.1 christos phase1="peaplabel=0"
1130 1.1 christos }
1131 1.1 christos
1132 1.1 christos # Example of EAP-TLS with smartcard (openssl engine)
1133 1.1 christos network={
1134 1.1 christos ssid="example"
1135 1.1 christos key_mgmt=WPA-EAP
1136 1.1 christos eap=TLS
1137 1.1 christos proto=RSN
1138 1.1 christos pairwise=CCMP TKIP
1139 1.1 christos group=CCMP TKIP
1140 1.1 christos identity="user (at] example.com"
1141 1.1 christos ca_cert="/etc/cert/ca.pem"
1142 1.1 christos client_cert="/etc/cert/user.pem"
1143 1.1 christos
1144 1.1 christos engine=1
1145 1.1 christos
1146 1.1 christos # The engine configured here must be available. Look at
1147 1.1 christos # OpenSSL engine support in the global section.
1148 1.1 christos # The key available through the engine must be the private key
1149 1.1 christos # matching the client certificate configured above.
1150 1.1 christos
1151 1.1 christos # use the opensc engine
1152 1.1 christos #engine_id="opensc"
1153 1.1 christos #key_id="45"
1154 1.1 christos
1155 1.1 christos # use the pkcs11 engine
1156 1.1 christos engine_id="pkcs11"
1157 1.1 christos key_id="id_45"
1158 1.1 christos
1159 1.1 christos # Optional PIN configuration; this can be left out and PIN will be
1160 1.1 christos # asked through the control interface
1161 1.1 christos pin="1234"
1162 1.1 christos }
1163 1.1 christos
1164 1.1 christos # Example configuration showing how to use an inlined blob as a CA certificate
1165 1.1 christos # data instead of using external file
1166 1.1 christos network={
1167 1.1 christos ssid="example"
1168 1.1 christos key_mgmt=WPA-EAP
1169 1.1 christos eap=TTLS
1170 1.1 christos identity="user (at] example.com"
1171 1.1 christos anonymous_identity="anonymous (at] example.com"
1172 1.1 christos password="foobar"
1173 1.1 christos ca_cert="blob://exampleblob"
1174 1.1 christos priority=20
1175 1.1 christos }
1176 1.1 christos
1177 1.1 christos blob-base64-exampleblob={
1178 1.1 christos SGVsbG8gV29ybGQhCg==
1179 1.1 christos }
1180 1.1 christos
1181 1.1 christos
1182 1.1 christos # Wildcard match for SSID (plaintext APs only). This example select any
1183 1.1 christos # open AP regardless of its SSID.
1184 1.1 christos network={
1185 1.1 christos key_mgmt=NONE
1186 1.1 christos }
1187