]>
Commit | Line | Data |
---|---|---|
6fc6879b JM |
1 | ##### Example wpa_supplicant configuration file ############################### |
2 | # | |
3 | # This file describes configuration file format and lists all available option. | |
4 | # Please also take a look at simpler configuration examples in 'examples' | |
5 | # subdirectory. | |
6 | # | |
7 | # Empty lines and lines starting with # are ignored | |
8 | ||
9 | # NOTE! This file may contain password information and should probably be made | |
10 | # readable only by root user on multiuser systems. | |
11 | ||
12 | # Note: All file paths in this configuration file should use full (absolute, | |
13 | # not relative to working directory) path in order to allow working directory | |
14 | # to be changed. This can happen if wpa_supplicant is run in the background. | |
15 | ||
16 | # Whether to allow wpa_supplicant to update (overwrite) configuration | |
17 | # | |
18 | # This option can be used to allow wpa_supplicant to overwrite configuration | |
19 | # file whenever configuration is changed (e.g., new network block is added with | |
20 | # wpa_cli or wpa_gui, or a password is changed). This is required for | |
21 | # wpa_cli/wpa_gui to be able to store the configuration changes permanently. | |
22 | # Please note that overwriting configuration file will remove the comments from | |
23 | # it. | |
24 | #update_config=1 | |
25 | ||
26 | # global configuration (shared by all network blocks) | |
27 | # | |
28 | # Parameters for the control interface. If this is specified, wpa_supplicant | |
29 | # will open a control interface that is available for external programs to | |
30 | # manage wpa_supplicant. The meaning of this string depends on which control | |
31 | # interface mechanism is used. For all cases, the existance of this parameter | |
32 | # in configuration is used to determine whether the control interface is | |
33 | # enabled. | |
34 | # | |
35 | # For UNIX domain sockets (default on Linux and BSD): This is a directory that | |
36 | # will be created for UNIX domain sockets for listening to requests from | |
37 | # external programs (CLI/GUI, etc.) for status information and configuration. | |
38 | # The socket file will be named based on the interface name, so multiple | |
39 | # wpa_supplicant processes can be run at the same time if more than one | |
40 | # interface is used. | |
41 | # /var/run/wpa_supplicant is the recommended directory for sockets and by | |
42 | # default, wpa_cli will use it when trying to connect with wpa_supplicant. | |
43 | # | |
44 | # Access control for the control interface can be configured by setting the | |
45 | # directory to allow only members of a group to use sockets. This way, it is | |
46 | # possible to run wpa_supplicant as root (since it needs to change network | |
47 | # configuration and open raw sockets) and still allow GUI/CLI components to be | |
48 | # run as non-root users. However, since the control interface can be used to | |
49 | # change the network configuration, this access needs to be protected in many | |
50 | # cases. By default, wpa_supplicant is configured to use gid 0 (root). If you | |
51 | # want to allow non-root users to use the control interface, add a new group | |
52 | # and change this value to match with that group. Add users that should have | |
53 | # control interface access to this group. If this variable is commented out or | |
54 | # not included in the configuration file, group will not be changed from the | |
55 | # value it got by default when the directory or socket was created. | |
56 | # | |
57 | # When configuring both the directory and group, use following format: | |
58 | # DIR=/var/run/wpa_supplicant GROUP=wheel | |
59 | # DIR=/var/run/wpa_supplicant GROUP=0 | |
60 | # (group can be either group name or gid) | |
61 | # | |
62 | # For UDP connections (default on Windows): The value will be ignored. This | |
63 | # variable is just used to select that the control interface is to be created. | |
64 | # The value can be set to, e.g., udp (ctrl_interface=udp) | |
65 | # | |
66 | # For Windows Named Pipe: This value can be used to set the security descriptor | |
67 | # for controlling access to the control interface. Security descriptor can be | |
68 | # set using Security Descriptor String Format (see http://msdn.microsoft.com/ | |
69 | # library/default.asp?url=/library/en-us/secauthz/security/ | |
70 | # security_descriptor_string_format.asp). The descriptor string needs to be | |
71 | # prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty | |
72 | # DACL (which will reject all connections). See README-Windows.txt for more | |
73 | # information about SDDL string format. | |
74 | # | |
75 | ctrl_interface=/var/run/wpa_supplicant | |
76 | ||
77 | # IEEE 802.1X/EAPOL version | |
78 | # wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines | |
79 | # EAPOL version 2. However, there are many APs that do not handle the new | |
80 | # version number correctly (they seem to drop the frames completely). In order | |
81 | # to make wpa_supplicant interoperate with these APs, the version number is set | |
82 | # to 1 by default. This configuration value can be used to set it to the new | |
83 | # version (2). | |
84 | eapol_version=1 | |
85 | ||
86 | # AP scanning/selection | |
87 | # By default, wpa_supplicant requests driver to perform AP scanning and then | |
88 | # uses the scan results to select a suitable AP. Another alternative is to | |
89 | # allow the driver to take care of AP scanning and selection and use | |
90 | # wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association | |
91 | # information from the driver. | |
b55aaa5f JM |
92 | # 1: wpa_supplicant initiates scanning and AP selection; if no APs matching to |
93 | # the currently enabled networks are found, a new network (IBSS or AP mode | |
94 | # operation) may be initialized (if configured) (default) | |
6fc6879b JM |
95 | # 0: driver takes care of scanning, AP selection, and IEEE 802.11 association |
96 | # parameters (e.g., WPA IE generation); this mode can also be used with | |
97 | # non-WPA drivers when using IEEE 802.1X mode; do not try to associate with | |
98 | # APs (i.e., external program needs to control association). This mode must | |
99 | # also be used when using wired Ethernet drivers. | |
100 | # 2: like 0, but associate with APs using security policy and SSID (but not | |
101 | # BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to | |
102 | # enable operation with hidden SSIDs and optimized roaming; in this mode, | |
103 | # the network blocks in the configuration file are tried one by one until | |
104 | # the driver reports successful association; each network block should have | |
105 | # explicit security policy (i.e., only one option in the lists) for | |
106 | # key_mgmt, pairwise, group, proto variables | |
b55aaa5f JM |
107 | # When using IBSS or AP mode, ap_scan=2 mode can force the new network to be |
108 | # created immediately regardless of scan results. ap_scan=1 mode will first try | |
109 | # to scan for existing networks and only if no matches with the enabled | |
110 | # networks are found, a new IBSS or AP mode network is created. | |
6fc6879b JM |
111 | ap_scan=1 |
112 | ||
113 | # EAP fast re-authentication | |
114 | # By default, fast re-authentication is enabled for all EAP methods that | |
115 | # support it. This variable can be used to disable fast re-authentication. | |
116 | # Normally, there is no need to disable this. | |
117 | fast_reauth=1 | |
118 | ||
119 | # OpenSSL Engine support | |
120 | # These options can be used to load OpenSSL engines. | |
121 | # The two engines that are supported currently are shown below: | |
122 | # They are both from the opensc project (http://www.opensc.org/) | |
123 | # By default no engines are loaded. | |
124 | # make the opensc engine available | |
125 | #opensc_engine_path=/usr/lib/opensc/engine_opensc.so | |
126 | # make the pkcs11 engine available | |
127 | #pkcs11_engine_path=/usr/lib/opensc/engine_pkcs11.so | |
128 | # configure the path to the pkcs11 module required by the pkcs11 engine | |
129 | #pkcs11_module_path=/usr/lib/pkcs11/opensc-pkcs11.so | |
130 | ||
131 | # Dynamic EAP methods | |
132 | # If EAP methods were built dynamically as shared object files, they need to be | |
133 | # loaded here before being used in the network blocks. By default, EAP methods | |
134 | # are included statically in the build, so these lines are not needed | |
135 | #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_tls.so | |
136 | #load_dynamic_eap=/usr/lib/wpa_supplicant/eap_md5.so | |
137 | ||
138 | # Driver interface parameters | |
139 | # This field can be used to configure arbitrary driver interace parameters. The | |
140 | # format is specific to the selected driver interface. This field is not used | |
141 | # in most cases. | |
142 | #driver_param="field=value" | |
143 | ||
814e925d JM |
144 | # Country code |
145 | # The ISO/IEC alpha2 country code for the country in which this device is | |
146 | # currently operating. | |
147 | #country=US | |
148 | ||
6fc6879b JM |
149 | # Maximum lifetime for PMKSA in seconds; default 43200 |
150 | #dot11RSNAConfigPMKLifetime=43200 | |
151 | # Threshold for reauthentication (percentage of PMK lifetime); default 70 | |
152 | #dot11RSNAConfigPMKReauthThreshold=70 | |
153 | # Timeout for security association negotiation in seconds; default 60 | |
154 | #dot11RSNAConfigSATimeout=60 | |
155 | ||
f855f923 JM |
156 | # Wi-Fi Protected Setup (WPS) parameters |
157 | ||
158 | # Universally Unique IDentifier (UUID; see RFC 4122) of the device | |
79da74a2 | 159 | # If not configured, UUID will be generated based on the local MAC address. |
f855f923 JM |
160 | #uuid=12345678-9abc-def0-1234-56789abcdef0 |
161 | ||
3c0b7aa4 JM |
162 | # Device Name |
163 | # User-friendly description of device; up to 32 octets encoded in UTF-8 | |
164 | #device_name=Wireless Client | |
165 | ||
166 | # Manufacturer | |
167 | # The manufacturer of the device (up to 64 ASCII characters) | |
168 | #manufacturer=Company | |
169 | ||
170 | # Model Name | |
171 | # Model of the device (up to 32 ASCII characters) | |
172 | #model_name=cmodel | |
173 | ||
174 | # Model Number | |
175 | # Additional device description (up to 32 ASCII characters) | |
176 | #model_number=123 | |
177 | ||
178 | # Serial Number | |
179 | # Serial number of the device (up to 32 characters) | |
180 | #serial_number=12345 | |
181 | ||
182 | # Primary Device Type | |
183 | # Used format: <categ>-<OUI>-<subcateg> | |
184 | # categ = Category as an integer value | |
185 | # OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for | |
186 | # default WPS OUI | |
187 | # subcateg = OUI-specific Sub Category as an integer value | |
188 | # Examples: | |
189 | # 1-0050F204-1 (Computer / PC) | |
190 | # 1-0050F204-2 (Computer / Server) | |
191 | # 5-0050F204-1 (Storage / NAS) | |
192 | # 6-0050F204-1 (Network Infrastructure / AP) | |
e83a0898 | 193 | #device_type=1-0050F204-1 |
3c0b7aa4 JM |
194 | |
195 | # OS Version | |
196 | # 4-octet operating system version number (hex string) | |
197 | #os_version=01020300 | |
198 | ||
47662164 JM |
199 | # Credential processing |
200 | # 0 = process received credentials internally (default) | |
201 | # 1 = do not process received credentials; just pass them over ctrl_iface to | |
202 | # external program(s) | |
203 | # 2 = process received credentials internally and pass them over ctrl_iface | |
204 | # to external program(s) | |
205 | #wps_cred_processing=0 | |
f855f923 | 206 | |
6fc6879b JM |
207 | # network block |
208 | # | |
209 | # Each network (usually AP's sharing the same SSID) is configured as a separate | |
210 | # block in this configuration file. The network blocks are in preference order | |
211 | # (the first match is used). | |
212 | # | |
213 | # network block fields: | |
214 | # | |
215 | # disabled: | |
216 | # 0 = this network can be used (default) | |
217 | # 1 = this network block is disabled (can be enabled through ctrl_iface, | |
218 | # e.g., with wpa_cli or wpa_gui) | |
219 | # | |
220 | # id_str: Network identifier string for external scripts. This value is passed | |
221 | # to external action script through wpa_cli as WPA_ID_STR environment | |
222 | # variable to make it easier to do network specific configuration. | |
223 | # | |
224 | # ssid: SSID (mandatory); either as an ASCII string with double quotation or | |
225 | # as hex string; network name | |
226 | # | |
227 | # scan_ssid: | |
228 | # 0 = do not scan this SSID with specific Probe Request frames (default) | |
229 | # 1 = scan with SSID-specific Probe Request frames (this can be used to | |
230 | # find APs that do not accept broadcast SSID or use multiple SSIDs; | |
231 | # this will add latency to scanning, so enable this only when needed) | |
232 | # | |
233 | # bssid: BSSID (optional); if set, this network block is used only when | |
234 | # associating with the AP using the configured BSSID | |
235 | # | |
236 | # priority: priority group (integer) | |
237 | # By default, all networks will get same priority group (0). If some of the | |
238 | # networks are more desirable, this field can be used to change the order in | |
239 | # which wpa_supplicant goes through the networks when selecting a BSS. The | |
240 | # priority groups will be iterated in decreasing priority (i.e., the larger the | |
241 | # priority value, the sooner the network is matched against the scan results). | |
242 | # Within each priority group, networks will be selected based on security | |
243 | # policy, signal strength, etc. | |
244 | # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not | |
245 | # using this priority to select the order for scanning. Instead, they try the | |
246 | # networks in the order that used in the configuration file. | |
247 | # | |
248 | # mode: IEEE 802.11 operation mode | |
249 | # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default) | |
250 | # 1 = IBSS (ad-hoc, peer-to-peer) | |
1581b38b | 251 | # 2 = AP (access point) |
6fc6879b | 252 | # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) |
b55aaa5f JM |
253 | # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires |
254 | # following network block options: | |
6fc6879b JM |
255 | # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not |
256 | # both), and psk must also be set. | |
257 | # | |
258 | # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g., | |
259 | # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial | |
260 | # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode. | |
261 | # In addition, this value is only used by the station that creates the IBSS. If | |
262 | # an IBSS network with the configured SSID is already present, the frequency of | |
263 | # the network will be used instead of this configured value. | |
264 | # | |
d3a98225 JM |
265 | # scan_freq: List of frequencies to scan |
266 | # Space-separated list of frequencies in MHz to scan when searching for this | |
267 | # BSS. If the subset of channels used by the network is known, this option can | |
268 | # be used to optimize scanning to not occur on channels that the network does | |
269 | # not use. Example: scan_freq=2412 2437 2462 | |
270 | # | |
6fc6879b JM |
271 | # proto: list of accepted protocols |
272 | # WPA = WPA/IEEE 802.11i/D3.0 | |
273 | # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN) | |
274 | # If not set, this defaults to: WPA RSN | |
275 | # | |
276 | # key_mgmt: list of accepted authenticated key management protocols | |
277 | # WPA-PSK = WPA pre-shared key (this requires 'psk' field) | |
f6190d37 | 278 | # WPA-EAP = WPA using EAP authentication |
6fc6879b JM |
279 | # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically |
280 | # generated WEP keys | |
281 | # NONE = WPA is not used; plaintext or static WEP could be used | |
56586197 JM |
282 | # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms |
283 | # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms | |
6fc6879b JM |
284 | # If not set, this defaults to: WPA-PSK WPA-EAP |
285 | # | |
286 | # auth_alg: list of allowed IEEE 802.11 authentication algorithms | |
287 | # OPEN = Open System authentication (required for WPA/WPA2) | |
288 | # SHARED = Shared Key authentication (requires static WEP keys) | |
289 | # LEAP = LEAP/Network EAP (only used with LEAP) | |
290 | # If not set, automatic selection is used (Open System with LEAP enabled if | |
291 | # LEAP is allowed as one of the EAP methods). | |
292 | # | |
293 | # pairwise: list of accepted pairwise (unicast) ciphers for WPA | |
294 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
295 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
296 | # NONE = Use only Group Keys (deprecated, should not be included if APs support | |
297 | # pairwise keys) | |
298 | # If not set, this defaults to: CCMP TKIP | |
299 | # | |
300 | # group: list of accepted group (broadcast/multicast) ciphers for WPA | |
301 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
302 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
303 | # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key | |
304 | # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11] | |
305 | # If not set, this defaults to: CCMP TKIP WEP104 WEP40 | |
306 | # | |
307 | # psk: WPA preshared key; 256-bit pre-shared key | |
308 | # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e., | |
309 | # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be | |
310 | # generated using the passphrase and SSID). ASCII passphrase must be between | |
311 | # 8 and 63 characters (inclusive). | |
312 | # This field is not needed, if WPA-EAP is used. | |
313 | # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys | |
314 | # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant | |
315 | # startup and reconfiguration time can be optimized by generating the PSK only | |
316 | # only when the passphrase or SSID has actually changed. | |
317 | # | |
318 | # eapol_flags: IEEE 802.1X/EAPOL options (bit field) | |
319 | # Dynamic WEP key required for non-WPA mode | |
320 | # bit0 (1): require dynamically generated unicast WEP key | |
321 | # bit1 (2): require dynamically generated broadcast WEP key | |
322 | # (3 = require both keys; default) | |
323 | # Note: When using wired authentication, eapol_flags must be set to 0 for the | |
324 | # authentication to be completed successfully. | |
325 | # | |
326 | # mixed_cell: This option can be used to configure whether so called mixed | |
327 | # cells, i.e., networks that use both plaintext and encryption in the same | |
328 | # SSID, are allowed when selecting a BSS form scan results. | |
329 | # 0 = disabled (default) | |
330 | # 1 = enabled | |
331 | # | |
332 | # proactive_key_caching: | |
333 | # Enable/disable opportunistic PMKSA caching for WPA2. | |
334 | # 0 = disabled (default) | |
335 | # 1 = enabled | |
336 | # | |
337 | # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or | |
338 | # hex without quotation, e.g., 0102030405) | |
339 | # wep_tx_keyidx: Default WEP key index (TX) (0..3) | |
340 | # | |
341 | # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is | |
342 | # allowed. This is only used with RSN/WPA2. | |
343 | # 0 = disabled (default) | |
344 | # 1 = enabled | |
345 | #peerkey=1 | |
346 | # | |
581a8cde JM |
347 | # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to |
348 | # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies. | |
349 | # | |
6fc6879b JM |
350 | # Following fields are only used with internal EAP implementation. |
351 | # eap: space-separated list of accepted EAP methods | |
352 | # MD5 = EAP-MD5 (unsecure and does not generate keying material -> | |
353 | # cannot be used with WPA; to be used as a Phase 2 method | |
354 | # with EAP-PEAP or EAP-TTLS) | |
355 | # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used | |
356 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
357 | # OTP = EAP-OTP (cannot be used separately with WPA; to be used | |
358 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
359 | # GTC = EAP-GTC (cannot be used separately with WPA; to be used | |
360 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
361 | # TLS = EAP-TLS (client and server certificate) | |
362 | # PEAP = EAP-PEAP (with tunnelled EAP authentication) | |
363 | # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 | |
364 | # authentication) | |
365 | # If not set, all compiled in methods are allowed. | |
366 | # | |
367 | # identity: Identity string for EAP | |
368 | # This field is also used to configure user NAI for | |
369 | # EAP-PSK/PAX/SAKE/GPSK. | |
370 | # anonymous_identity: Anonymous identity string for EAP (to be used as the | |
371 | # unencrypted identity with EAP types that support different tunnelled | |
372 | # identity, e.g., EAP-TTLS) | |
373 | # password: Password string for EAP. This field can include either the | |
374 | # plaintext password (using ASCII or hex string) or a NtPasswordHash | |
375 | # (16-byte MD4 hash of password) in hash:<32 hex digits> format. | |
376 | # NtPasswordHash can only be used when the password is for MSCHAPv2 or | |
377 | # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). | |
378 | # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit | |
379 | # PSK) is also configured using this field. For EAP-GPSK, this is a | |
9474b3a4 | 380 | # variable length PSK. |
6fc6879b JM |
381 | # ca_cert: File path to CA certificate file (PEM/DER). This file can have one |
382 | # or more trusted CA certificates. If ca_cert and ca_path are not | |
383 | # included, server certificate will not be verified. This is insecure and | |
384 | # a trusted CA certificate should always be configured when using | |
385 | # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may | |
386 | # change when wpa_supplicant is run in the background. | |
387 | # On Windows, trusted CA certificates can be loaded from the system | |
388 | # certificate store by setting this to cert_store://<name>, e.g., | |
389 | # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". | |
390 | # Note that when running wpa_supplicant as an application, the user | |
391 | # certificate store (My user account) is used, whereas computer store | |
392 | # (Computer account) is used when running wpasvc as a service. | |
393 | # ca_path: Directory path for CA certificate files (PEM). This path may | |
394 | # contain multiple CA certificates in OpenSSL format. Common use for this | |
395 | # is to point to system trusted CA list which is often installed into | |
396 | # directory like /etc/ssl/certs. If configured, these certificates are | |
397 | # added to the list of trusted CAs. ca_cert may also be included in that | |
398 | # case, but it is not required. | |
399 | # client_cert: File path to client certificate file (PEM/DER) | |
400 | # Full path should be used since working directory may change when | |
401 | # wpa_supplicant is run in the background. | |
402 | # Alternatively, a named configuration blob can be used by setting this | |
403 | # to blob://<blob name>. | |
404 | # private_key: File path to client private key file (PEM/DER/PFX) | |
405 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be | |
406 | # commented out. Both the private key and certificate will be read from | |
407 | # the PKCS#12 file in this case. Full path should be used since working | |
408 | # directory may change when wpa_supplicant is run in the background. | |
409 | # Windows certificate store can be used by leaving client_cert out and | |
410 | # configuring private_key in one of the following formats: | |
411 | # cert://substring_to_match | |
412 | # hash://certificate_thumbprint_in_hex | |
413 | # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4" | |
414 | # Note that when running wpa_supplicant as an application, the user | |
415 | # certificate store (My user account) is used, whereas computer store | |
416 | # (Computer account) is used when running wpasvc as a service. | |
417 | # Alternatively, a named configuration blob can be used by setting this | |
418 | # to blob://<blob name>. | |
419 | # private_key_passwd: Password for private key file (if left out, this will be | |
420 | # asked through control interface) | |
421 | # dh_file: File path to DH/DSA parameters file (in PEM format) | |
422 | # This is an optional configuration file for setting parameters for an | |
423 | # ephemeral DH key exchange. In most cases, the default RSA | |
424 | # authentication does not use this configuration. However, it is possible | |
425 | # setup RSA to use ephemeral DH key exchange. In addition, ciphers with | |
426 | # DSA keys always use ephemeral DH keys. This can be used to achieve | |
427 | # forward secrecy. If the file is in DSA parameters format, it will be | |
428 | # automatically converted into DH params. | |
429 | # subject_match: Substring to be matched against the subject of the | |
430 | # authentication server certificate. If this string is set, the server | |
431 | # sertificate is only accepted if it contains this string in the subject. | |
432 | # The subject string is in following format: | |
433 | # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com | |
434 | # altsubject_match: Semicolon separated string of entries to be matched against | |
435 | # the alternative subject name of the authentication server certificate. | |
436 | # If this string is set, the server sertificate is only accepted if it | |
437 | # contains one of the entries in an alternative subject name extension. | |
438 | # altSubjectName string is in following format: TYPE:VALUE | |
439 | # Example: EMAIL:server@example.com | |
440 | # Example: DNS:server.example.com;DNS:server2.example.com | |
441 | # Following types are supported: EMAIL, DNS, URI | |
442 | # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters | |
443 | # (string with field-value pairs, e.g., "peapver=0" or | |
444 | # "peapver=1 peaplabel=1") | |
445 | # 'peapver' can be used to force which PEAP version (0 or 1) is used. | |
446 | # 'peaplabel=1' can be used to force new label, "client PEAP encryption", | |
447 | # to be used during key derivation when PEAPv1 or newer. Most existing | |
448 | # PEAPv1 implementation seem to be using the old label, "client EAP | |
449 | # encryption", and wpa_supplicant is now using that as the default value. | |
450 | # Some servers, e.g., Radiator, may require peaplabel=1 configuration to | |
451 | # interoperate with PEAPv1; see eap_testing.txt for more details. | |
452 | # 'peap_outer_success=0' can be used to terminate PEAP authentication on | |
453 | # tunneled EAP-Success. This is required with some RADIUS servers that | |
454 | # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g., | |
455 | # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode) | |
456 | # include_tls_length=1 can be used to force wpa_supplicant to include | |
457 | # TLS Message Length field in all TLS messages even if they are not | |
458 | # fragmented. | |
459 | # sim_min_num_chal=3 can be used to configure EAP-SIM to require three | |
460 | # challenges (by default, it accepts 2 or 3) | |
461 | # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use | |
462 | # protected result indication. | |
d6888f9e JM |
463 | # 'crypto_binding' option can be used to control PEAPv0 cryptobinding |
464 | # behavior: | |
c31a11c9 JM |
465 | # * 0 = do not use cryptobinding (default) |
466 | # * 1 = use cryptobinding if server supports it | |
d6888f9e | 467 | # * 2 = require cryptobinding |
f855f923 JM |
468 | # EAP-WSC (WPS) uses following options: pin=<Device Password> or |
469 | # pbc=1. | |
6fc6879b JM |
470 | # phase2: Phase2 (inner authentication with TLS tunnel) parameters |
471 | # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or | |
472 | # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS) | |
473 | # Following certificate/private key fields are used in inner Phase2 | |
474 | # authentication when using EAP-TTLS or EAP-PEAP. | |
475 | # ca_cert2: File path to CA certificate file. This file can have one or more | |
476 | # trusted CA certificates. If ca_cert2 and ca_path2 are not included, | |
477 | # server certificate will not be verified. This is insecure and a trusted | |
478 | # CA certificate should always be configured. | |
479 | # ca_path2: Directory path for CA certificate files (PEM) | |
480 | # client_cert2: File path to client certificate file | |
481 | # private_key2: File path to client private key file | |
482 | # private_key2_passwd: Password for private key file | |
483 | # dh_file2: File path to DH/DSA parameters file (in PEM format) | |
484 | # subject_match2: Substring to be matched against the subject of the | |
485 | # authentication server certificate. | |
486 | # altsubject_match2: Substring to be matched against the alternative subject | |
487 | # name of the authentication server certificate. | |
488 | # | |
489 | # fragment_size: Maximum EAP fragment size in bytes (default 1398). | |
490 | # This value limits the fragment size for EAP methods that support | |
491 | # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set | |
492 | # small enough to make the EAP messages fit in MTU of the network | |
493 | # interface used for EAPOL. The default value is suitable for most | |
494 | # cases. | |
495 | # | |
496 | # EAP-FAST variables: | |
497 | # pac_file: File path for the PAC entries. wpa_supplicant will need to be able | |
498 | # to create this file and write updates to it when PAC is being | |
499 | # provisioned or refreshed. Full path to the file should be used since | |
500 | # working directory may change when wpa_supplicant is run in the | |
501 | # background. Alternatively, a named configuration blob can be used by | |
502 | # setting this to blob://<blob name> | |
503 | # phase1: fast_provisioning option can be used to enable in-line provisioning | |
504 | # of EAP-FAST credentials (PAC): | |
505 | # 0 = disabled, | |
506 | # 1 = allow unauthenticated provisioning, | |
507 | # 2 = allow authenticated provisioning, | |
508 | # 3 = allow both unauthenticated and authenticated provisioning | |
509 | # fast_max_pac_list_len=<num> option can be used to set the maximum | |
510 | # number of PAC entries to store in a PAC list (default: 10) | |
511 | # fast_pac_format=binary option can be used to select binary format for | |
2e8c9a27 | 512 | # storing PAC entries in order to save some space (the default |
6fc6879b JM |
513 | # text format uses about 2.5 times the size of minimal binary |
514 | # format) | |
515 | # | |
516 | # wpa_supplicant supports number of "EAP workarounds" to work around | |
517 | # interoperability issues with incorrectly behaving authentication servers. | |
518 | # These are enabled by default because some of the issues are present in large | |
519 | # number of authentication servers. Strict EAP conformance mode can be | |
520 | # configured by disabling workarounds with eap_workaround=0. | |
521 | ||
522 | # Example blocks: | |
523 | ||
524 | # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers | |
525 | network={ | |
526 | ssid="simple" | |
527 | psk="very secret passphrase" | |
528 | priority=5 | |
529 | } | |
530 | ||
531 | # Same as previous, but request SSID-specific scanning (for APs that reject | |
532 | # broadcast SSID) | |
533 | network={ | |
534 | ssid="second ssid" | |
535 | scan_ssid=1 | |
536 | psk="very secret passphrase" | |
537 | priority=2 | |
538 | } | |
539 | ||
540 | # Only WPA-PSK is used. Any valid cipher combination is accepted. | |
541 | network={ | |
542 | ssid="example" | |
543 | proto=WPA | |
544 | key_mgmt=WPA-PSK | |
545 | pairwise=CCMP TKIP | |
546 | group=CCMP TKIP WEP104 WEP40 | |
547 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
548 | priority=2 | |
549 | } | |
550 | ||
581a8cde JM |
551 | # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying |
552 | network={ | |
553 | ssid="example" | |
554 | proto=WPA | |
555 | key_mgmt=WPA-PSK | |
556 | pairwise=TKIP | |
557 | group=TKIP | |
558 | psk="not so secure passphrase" | |
559 | wpa_ptk_rekey=600 | |
560 | } | |
561 | ||
6fc6879b JM |
562 | # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104 |
563 | # or WEP40 as the group cipher will not be accepted. | |
564 | network={ | |
565 | ssid="example" | |
566 | proto=RSN | |
567 | key_mgmt=WPA-EAP | |
568 | pairwise=CCMP TKIP | |
569 | group=CCMP TKIP | |
570 | eap=TLS | |
571 | identity="user@example.com" | |
572 | ca_cert="/etc/cert/ca.pem" | |
573 | client_cert="/etc/cert/user.pem" | |
574 | private_key="/etc/cert/user.prv" | |
575 | private_key_passwd="password" | |
576 | priority=1 | |
577 | } | |
578 | ||
579 | # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel | |
580 | # (e.g., Radiator) | |
581 | network={ | |
582 | ssid="example" | |
583 | key_mgmt=WPA-EAP | |
584 | eap=PEAP | |
585 | identity="user@example.com" | |
586 | password="foobar" | |
587 | ca_cert="/etc/cert/ca.pem" | |
588 | phase1="peaplabel=1" | |
589 | phase2="auth=MSCHAPV2" | |
590 | priority=10 | |
591 | } | |
592 | ||
593 | # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the | |
594 | # unencrypted use. Real identity is sent only within an encrypted TLS tunnel. | |
595 | network={ | |
596 | ssid="example" | |
597 | key_mgmt=WPA-EAP | |
598 | eap=TTLS | |
599 | identity="user@example.com" | |
600 | anonymous_identity="anonymous@example.com" | |
601 | password="foobar" | |
602 | ca_cert="/etc/cert/ca.pem" | |
603 | priority=2 | |
604 | } | |
605 | ||
606 | # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted | |
607 | # use. Real identity is sent only within an encrypted TLS tunnel. | |
608 | network={ | |
609 | ssid="example" | |
610 | key_mgmt=WPA-EAP | |
611 | eap=TTLS | |
612 | identity="user@example.com" | |
613 | anonymous_identity="anonymous@example.com" | |
614 | password="foobar" | |
615 | ca_cert="/etc/cert/ca.pem" | |
616 | phase2="auth=MSCHAPV2" | |
617 | } | |
618 | ||
619 | # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner | |
620 | # authentication. | |
621 | network={ | |
622 | ssid="example" | |
623 | key_mgmt=WPA-EAP | |
624 | eap=TTLS | |
625 | # Phase1 / outer authentication | |
626 | anonymous_identity="anonymous@example.com" | |
627 | ca_cert="/etc/cert/ca.pem" | |
628 | # Phase 2 / inner authentication | |
629 | phase2="autheap=TLS" | |
630 | ca_cert2="/etc/cert/ca2.pem" | |
631 | client_cert2="/etc/cer/user.pem" | |
632 | private_key2="/etc/cer/user.prv" | |
633 | private_key2_passwd="password" | |
634 | priority=2 | |
635 | } | |
636 | ||
637 | # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and | |
638 | # group cipher. | |
639 | network={ | |
640 | ssid="example" | |
641 | bssid=00:11:22:33:44:55 | |
642 | proto=WPA RSN | |
643 | key_mgmt=WPA-PSK WPA-EAP | |
644 | pairwise=CCMP | |
645 | group=CCMP | |
646 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
647 | } | |
648 | ||
649 | # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP | |
650 | # and all valid ciphers. | |
651 | network={ | |
652 | ssid=00010203 | |
653 | psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f | |
654 | } | |
655 | ||
656 | ||
657 | # EAP-SIM with a GSM SIM or USIM | |
658 | network={ | |
659 | ssid="eap-sim-test" | |
660 | key_mgmt=WPA-EAP | |
661 | eap=SIM | |
662 | pin="1234" | |
663 | pcsc="" | |
664 | } | |
665 | ||
666 | ||
667 | # EAP-PSK | |
668 | network={ | |
669 | ssid="eap-psk-test" | |
670 | key_mgmt=WPA-EAP | |
671 | eap=PSK | |
672 | anonymous_identity="eap_psk_user" | |
673 | password=06b4be19da289f475aa46a33cb793029 | |
674 | identity="eap_psk_user@example.com" | |
675 | } | |
676 | ||
677 | ||
678 | # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using | |
679 | # EAP-TLS for authentication and key generation; require both unicast and | |
680 | # broadcast WEP keys. | |
681 | network={ | |
682 | ssid="1x-test" | |
683 | key_mgmt=IEEE8021X | |
684 | eap=TLS | |
685 | identity="user@example.com" | |
686 | ca_cert="/etc/cert/ca.pem" | |
687 | client_cert="/etc/cert/user.pem" | |
688 | private_key="/etc/cert/user.prv" | |
689 | private_key_passwd="password" | |
690 | eapol_flags=3 | |
691 | } | |
692 | ||
693 | ||
694 | # LEAP with dynamic WEP keys | |
695 | network={ | |
696 | ssid="leap-example" | |
697 | key_mgmt=IEEE8021X | |
698 | eap=LEAP | |
699 | identity="user" | |
700 | password="foobar" | |
701 | } | |
702 | ||
703 | # EAP-IKEv2 using shared secrets for both server and peer authentication | |
704 | network={ | |
705 | ssid="ikev2-example" | |
706 | key_mgmt=WPA-EAP | |
707 | eap=IKEV2 | |
708 | identity="user" | |
709 | password="foobar" | |
710 | } | |
711 | ||
712 | # EAP-FAST with WPA (WPA or WPA2) | |
713 | network={ | |
714 | ssid="eap-fast-test" | |
715 | key_mgmt=WPA-EAP | |
716 | eap=FAST | |
717 | anonymous_identity="FAST-000102030405" | |
718 | identity="username" | |
719 | password="password" | |
720 | phase1="fast_provisioning=1" | |
721 | pac_file="/etc/wpa_supplicant.eap-fast-pac" | |
722 | } | |
723 | ||
724 | network={ | |
725 | ssid="eap-fast-test" | |
726 | key_mgmt=WPA-EAP | |
727 | eap=FAST | |
728 | anonymous_identity="FAST-000102030405" | |
729 | identity="username" | |
730 | password="password" | |
731 | phase1="fast_provisioning=1" | |
732 | pac_file="blob://eap-fast-pac" | |
733 | } | |
734 | ||
735 | # Plaintext connection (no WPA, no IEEE 802.1X) | |
736 | network={ | |
737 | ssid="plaintext-test" | |
738 | key_mgmt=NONE | |
739 | } | |
740 | ||
741 | ||
742 | # Shared WEP key connection (no WPA, no IEEE 802.1X) | |
743 | network={ | |
744 | ssid="static-wep-test" | |
745 | key_mgmt=NONE | |
746 | wep_key0="abcde" | |
747 | wep_key1=0102030405 | |
748 | wep_key2="1234567890123" | |
749 | wep_tx_keyidx=0 | |
750 | priority=5 | |
751 | } | |
752 | ||
753 | ||
754 | # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key | |
755 | # IEEE 802.11 authentication | |
756 | network={ | |
757 | ssid="static-wep-test2" | |
758 | key_mgmt=NONE | |
759 | wep_key0="abcde" | |
760 | wep_key1=0102030405 | |
761 | wep_key2="1234567890123" | |
762 | wep_tx_keyidx=0 | |
763 | priority=5 | |
764 | auth_alg=SHARED | |
765 | } | |
766 | ||
767 | ||
768 | # IBSS/ad-hoc network with WPA-None/TKIP. | |
769 | network={ | |
770 | ssid="test adhoc" | |
771 | mode=1 | |
772 | frequency=2412 | |
773 | proto=WPA | |
774 | key_mgmt=WPA-NONE | |
775 | pairwise=NONE | |
776 | group=TKIP | |
777 | psk="secret passphrase" | |
778 | } | |
779 | ||
780 | ||
781 | # Catch all example that allows more or less all configuration modes | |
782 | network={ | |
783 | ssid="example" | |
784 | scan_ssid=1 | |
785 | key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE | |
786 | pairwise=CCMP TKIP | |
787 | group=CCMP TKIP WEP104 WEP40 | |
788 | psk="very secret passphrase" | |
789 | eap=TTLS PEAP TLS | |
790 | identity="user@example.com" | |
791 | password="foobar" | |
792 | ca_cert="/etc/cert/ca.pem" | |
793 | client_cert="/etc/cert/user.pem" | |
794 | private_key="/etc/cert/user.prv" | |
795 | private_key_passwd="password" | |
796 | phase1="peaplabel=0" | |
797 | } | |
798 | ||
799 | # Example of EAP-TLS with smartcard (openssl engine) | |
800 | network={ | |
801 | ssid="example" | |
802 | key_mgmt=WPA-EAP | |
803 | eap=TLS | |
804 | proto=RSN | |
805 | pairwise=CCMP TKIP | |
806 | group=CCMP TKIP | |
807 | identity="user@example.com" | |
808 | ca_cert="/etc/cert/ca.pem" | |
809 | client_cert="/etc/cert/user.pem" | |
810 | ||
811 | engine=1 | |
812 | ||
813 | # The engine configured here must be available. Look at | |
814 | # OpenSSL engine support in the global section. | |
815 | # The key available through the engine must be the private key | |
816 | # matching the client certificate configured above. | |
817 | ||
818 | # use the opensc engine | |
819 | #engine_id="opensc" | |
820 | #key_id="45" | |
821 | ||
822 | # use the pkcs11 engine | |
823 | engine_id="pkcs11" | |
824 | key_id="id_45" | |
825 | ||
826 | # Optional PIN configuration; this can be left out and PIN will be | |
827 | # asked through the control interface | |
828 | pin="1234" | |
829 | } | |
830 | ||
831 | # Example configuration showing how to use an inlined blob as a CA certificate | |
832 | # data instead of using external file | |
833 | network={ | |
834 | ssid="example" | |
835 | key_mgmt=WPA-EAP | |
836 | eap=TTLS | |
837 | identity="user@example.com" | |
838 | anonymous_identity="anonymous@example.com" | |
839 | password="foobar" | |
840 | ca_cert="blob://exampleblob" | |
841 | priority=20 | |
842 | } | |
843 | ||
844 | blob-base64-exampleblob={ | |
845 | SGVsbG8gV29ybGQhCg== | |
846 | } | |
847 | ||
848 | ||
849 | # Wildcard match for SSID (plaintext APs only). This example select any | |
850 | # open AP regardless of its SSID. | |
851 | network={ | |
852 | key_mgmt=NONE | |
853 | } |