]>
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 | |
ffbf1eaa | 31 | # interface mechanism is used. For all cases, the existence of this parameter |
6fc6879b JM |
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 | ||
c0e4dd9e JM |
199 | # Config Methods |
200 | # List of the supported configuration methods | |
201 | # Available methods: usba ethernet label display ext_nfc_token int_nfc_token | |
6a857074 JM |
202 | # nfc_interface push_button keypad virtual_display physical_display |
203 | # virtual_push_button physical_push_button | |
53587ec1 JM |
204 | # For WSC 1.0: |
205 | #config_methods=label display push_button keypad | |
206 | # For WSC 2.0: | |
6a857074 | 207 | #config_methods=label virtual_display virtual_push_button keypad |
c0e4dd9e | 208 | |
47662164 JM |
209 | # Credential processing |
210 | # 0 = process received credentials internally (default) | |
211 | # 1 = do not process received credentials; just pass them over ctrl_iface to | |
212 | # external program(s) | |
213 | # 2 = process received credentials internally and pass them over ctrl_iface | |
214 | # to external program(s) | |
215 | #wps_cred_processing=0 | |
f855f923 | 216 | |
c9c38b09 JM |
217 | # Maximum number of BSS entries to keep in memory |
218 | # Default: 200 | |
219 | # This can be used to limit memory use on the BSS entries (cached scan | |
220 | # results). A larger value may be needed in environments that have huge number | |
221 | # of APs when using ap_scan=1 mode. | |
222 | #bss_max_count=200 | |
223 | ||
224 | ||
3812464c JM |
225 | # filter_ssids - SSID-based scan result filtering |
226 | # 0 = do not filter scan results (default) | |
227 | # 1 = only include configured SSIDs in scan results/BSS table | |
228 | #filter_ssids=0 | |
229 | ||
230 | ||
46ee0427 JM |
231 | # Interworking (IEEE 802.11u) |
232 | ||
233 | # Enable Interworking | |
234 | # interworking=1 | |
235 | ||
236 | # Homogenous ESS identifier | |
237 | # If this is set, scans will be used to request response only from BSSes | |
238 | # belonging to the specified Homogeneous ESS. This is used only if interworking | |
239 | # is enabled. | |
240 | # hessid=00:11:22:33:44:55 | |
241 | ||
2a4b98a9 JM |
242 | # Home Realm for Interworking |
243 | #home_realm=example.com | |
244 | ||
245 | # Username for Interworking network selection | |
246 | #home_username=user | |
247 | ||
248 | # Password for Interworking network selection | |
249 | #home_password=secret | |
250 | ||
251 | # CA certificate for Interworking network selection | |
252 | #home_ca_cert=/etc/cert/ca.pem | |
253 | ||
254 | # IMSI in <MCC> | <MNC> | '-' | <MSIN> format | |
255 | #home_imsi=232010000000000 | |
256 | ||
257 | # Milenage parameters for SIM/USIM simulator in <Ki>:<OPc>:<SQN> format | |
258 | #home_milenage=90dca4eda45b53cf0f12d7c9c3bc6a89:cb9cccc4b9258e6dca4760379fb82581:000000000123 | |
259 | ||
6fc6879b JM |
260 | # network block |
261 | # | |
262 | # Each network (usually AP's sharing the same SSID) is configured as a separate | |
263 | # block in this configuration file. The network blocks are in preference order | |
264 | # (the first match is used). | |
265 | # | |
266 | # network block fields: | |
267 | # | |
268 | # disabled: | |
269 | # 0 = this network can be used (default) | |
270 | # 1 = this network block is disabled (can be enabled through ctrl_iface, | |
271 | # e.g., with wpa_cli or wpa_gui) | |
272 | # | |
273 | # id_str: Network identifier string for external scripts. This value is passed | |
274 | # to external action script through wpa_cli as WPA_ID_STR environment | |
275 | # variable to make it easier to do network specific configuration. | |
276 | # | |
277 | # ssid: SSID (mandatory); either as an ASCII string with double quotation or | |
278 | # as hex string; network name | |
279 | # | |
280 | # scan_ssid: | |
281 | # 0 = do not scan this SSID with specific Probe Request frames (default) | |
282 | # 1 = scan with SSID-specific Probe Request frames (this can be used to | |
283 | # find APs that do not accept broadcast SSID or use multiple SSIDs; | |
284 | # this will add latency to scanning, so enable this only when needed) | |
285 | # | |
286 | # bssid: BSSID (optional); if set, this network block is used only when | |
287 | # associating with the AP using the configured BSSID | |
288 | # | |
289 | # priority: priority group (integer) | |
290 | # By default, all networks will get same priority group (0). If some of the | |
291 | # networks are more desirable, this field can be used to change the order in | |
292 | # which wpa_supplicant goes through the networks when selecting a BSS. The | |
293 | # priority groups will be iterated in decreasing priority (i.e., the larger the | |
294 | # priority value, the sooner the network is matched against the scan results). | |
295 | # Within each priority group, networks will be selected based on security | |
296 | # policy, signal strength, etc. | |
297 | # Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not | |
298 | # using this priority to select the order for scanning. Instead, they try the | |
299 | # networks in the order that used in the configuration file. | |
300 | # | |
301 | # mode: IEEE 802.11 operation mode | |
302 | # 0 = infrastructure (Managed) mode, i.e., associate with an AP (default) | |
303 | # 1 = IBSS (ad-hoc, peer-to-peer) | |
1581b38b | 304 | # 2 = AP (access point) |
6fc6879b | 305 | # Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) |
b55aaa5f JM |
306 | # and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). WPA-None requires |
307 | # following network block options: | |
6fc6879b JM |
308 | # proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not |
309 | # both), and psk must also be set. | |
310 | # | |
311 | # frequency: Channel frequency in megahertz (MHz) for IBSS, e.g., | |
312 | # 2412 = IEEE 802.11b/g channel 1. This value is used to configure the initial | |
313 | # channel for IBSS (adhoc) networks. It is ignored in the infrastructure mode. | |
314 | # In addition, this value is only used by the station that creates the IBSS. If | |
315 | # an IBSS network with the configured SSID is already present, the frequency of | |
316 | # the network will be used instead of this configured value. | |
317 | # | |
d3a98225 JM |
318 | # scan_freq: List of frequencies to scan |
319 | # Space-separated list of frequencies in MHz to scan when searching for this | |
320 | # BSS. If the subset of channels used by the network is known, this option can | |
321 | # be used to optimize scanning to not occur on channels that the network does | |
322 | # not use. Example: scan_freq=2412 2437 2462 | |
323 | # | |
b766a9a2 JM |
324 | # freq_list: Array of allowed frequencies |
325 | # Space-separated list of frequencies in MHz to allow for selecting the BSS. If | |
326 | # set, scan results that do not match any of the specified frequencies are not | |
327 | # considered when selecting a BSS. | |
328 | # | |
6fc6879b JM |
329 | # proto: list of accepted protocols |
330 | # WPA = WPA/IEEE 802.11i/D3.0 | |
331 | # RSN = WPA2/IEEE 802.11i (also WPA2 can be used as an alias for RSN) | |
332 | # If not set, this defaults to: WPA RSN | |
333 | # | |
334 | # key_mgmt: list of accepted authenticated key management protocols | |
335 | # WPA-PSK = WPA pre-shared key (this requires 'psk' field) | |
f6190d37 | 336 | # WPA-EAP = WPA using EAP authentication |
6fc6879b JM |
337 | # IEEE8021X = IEEE 802.1X using EAP authentication and (optionally) dynamically |
338 | # generated WEP keys | |
339 | # NONE = WPA is not used; plaintext or static WEP could be used | |
56586197 JM |
340 | # WPA-PSK-SHA256 = Like WPA-PSK but using stronger SHA256-based algorithms |
341 | # WPA-EAP-SHA256 = Like WPA-EAP but using stronger SHA256-based algorithms | |
6fc6879b JM |
342 | # If not set, this defaults to: WPA-PSK WPA-EAP |
343 | # | |
344 | # auth_alg: list of allowed IEEE 802.11 authentication algorithms | |
345 | # OPEN = Open System authentication (required for WPA/WPA2) | |
346 | # SHARED = Shared Key authentication (requires static WEP keys) | |
347 | # LEAP = LEAP/Network EAP (only used with LEAP) | |
348 | # If not set, automatic selection is used (Open System with LEAP enabled if | |
349 | # LEAP is allowed as one of the EAP methods). | |
350 | # | |
351 | # pairwise: list of accepted pairwise (unicast) ciphers for WPA | |
352 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
353 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
354 | # NONE = Use only Group Keys (deprecated, should not be included if APs support | |
355 | # pairwise keys) | |
356 | # If not set, this defaults to: CCMP TKIP | |
357 | # | |
358 | # group: list of accepted group (broadcast/multicast) ciphers for WPA | |
359 | # CCMP = AES in Counter mode with CBC-MAC [RFC 3610, IEEE 802.11i/D7.0] | |
360 | # TKIP = Temporal Key Integrity Protocol [IEEE 802.11i/D7.0] | |
361 | # WEP104 = WEP (Wired Equivalent Privacy) with 104-bit key | |
362 | # WEP40 = WEP (Wired Equivalent Privacy) with 40-bit key [IEEE 802.11] | |
363 | # If not set, this defaults to: CCMP TKIP WEP104 WEP40 | |
364 | # | |
365 | # psk: WPA preshared key; 256-bit pre-shared key | |
366 | # The key used in WPA-PSK mode can be entered either as 64 hex-digits, i.e., | |
367 | # 32 bytes or as an ASCII passphrase (in which case, the real PSK will be | |
368 | # generated using the passphrase and SSID). ASCII passphrase must be between | |
369 | # 8 and 63 characters (inclusive). | |
370 | # This field is not needed, if WPA-EAP is used. | |
371 | # Note: Separate tool, wpa_passphrase, can be used to generate 256-bit keys | |
372 | # from ASCII passphrase. This process uses lot of CPU and wpa_supplicant | |
373 | # startup and reconfiguration time can be optimized by generating the PSK only | |
374 | # only when the passphrase or SSID has actually changed. | |
375 | # | |
376 | # eapol_flags: IEEE 802.1X/EAPOL options (bit field) | |
377 | # Dynamic WEP key required for non-WPA mode | |
378 | # bit0 (1): require dynamically generated unicast WEP key | |
379 | # bit1 (2): require dynamically generated broadcast WEP key | |
380 | # (3 = require both keys; default) | |
381 | # Note: When using wired authentication, eapol_flags must be set to 0 for the | |
382 | # authentication to be completed successfully. | |
383 | # | |
384 | # mixed_cell: This option can be used to configure whether so called mixed | |
385 | # cells, i.e., networks that use both plaintext and encryption in the same | |
ffbf1eaa | 386 | # SSID, are allowed when selecting a BSS from scan results. |
6fc6879b JM |
387 | # 0 = disabled (default) |
388 | # 1 = enabled | |
389 | # | |
390 | # proactive_key_caching: | |
391 | # Enable/disable opportunistic PMKSA caching for WPA2. | |
392 | # 0 = disabled (default) | |
393 | # 1 = enabled | |
394 | # | |
395 | # wep_key0..3: Static WEP key (ASCII in double quotation, e.g. "abcde" or | |
396 | # hex without quotation, e.g., 0102030405) | |
397 | # wep_tx_keyidx: Default WEP key index (TX) (0..3) | |
398 | # | |
399 | # peerkey: Whether PeerKey negotiation for direct links (IEEE 802.11e DLS) is | |
400 | # allowed. This is only used with RSN/WPA2. | |
401 | # 0 = disabled (default) | |
402 | # 1 = enabled | |
403 | #peerkey=1 | |
404 | # | |
581a8cde JM |
405 | # wpa_ptk_rekey: Maximum lifetime for PTK in seconds. This can be used to |
406 | # enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies. | |
407 | # | |
6fc6879b JM |
408 | # Following fields are only used with internal EAP implementation. |
409 | # eap: space-separated list of accepted EAP methods | |
410 | # MD5 = EAP-MD5 (unsecure and does not generate keying material -> | |
411 | # cannot be used with WPA; to be used as a Phase 2 method | |
412 | # with EAP-PEAP or EAP-TTLS) | |
413 | # MSCHAPV2 = EAP-MSCHAPv2 (cannot be used separately with WPA; to be used | |
414 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
415 | # OTP = EAP-OTP (cannot be used separately with WPA; to be used | |
416 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
417 | # GTC = EAP-GTC (cannot be used separately with WPA; to be used | |
418 | # as a Phase 2 method with EAP-PEAP or EAP-TTLS) | |
419 | # TLS = EAP-TLS (client and server certificate) | |
420 | # PEAP = EAP-PEAP (with tunnelled EAP authentication) | |
421 | # TTLS = EAP-TTLS (with tunnelled EAP or PAP/CHAP/MSCHAP/MSCHAPV2 | |
422 | # authentication) | |
423 | # If not set, all compiled in methods are allowed. | |
424 | # | |
425 | # identity: Identity string for EAP | |
426 | # This field is also used to configure user NAI for | |
427 | # EAP-PSK/PAX/SAKE/GPSK. | |
428 | # anonymous_identity: Anonymous identity string for EAP (to be used as the | |
429 | # unencrypted identity with EAP types that support different tunnelled | |
430 | # identity, e.g., EAP-TTLS) | |
431 | # password: Password string for EAP. This field can include either the | |
432 | # plaintext password (using ASCII or hex string) or a NtPasswordHash | |
433 | # (16-byte MD4 hash of password) in hash:<32 hex digits> format. | |
434 | # NtPasswordHash can only be used when the password is for MSCHAPv2 or | |
435 | # MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). | |
436 | # EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit | |
437 | # PSK) is also configured using this field. For EAP-GPSK, this is a | |
9474b3a4 | 438 | # variable length PSK. |
6fc6879b JM |
439 | # ca_cert: File path to CA certificate file (PEM/DER). This file can have one |
440 | # or more trusted CA certificates. If ca_cert and ca_path are not | |
441 | # included, server certificate will not be verified. This is insecure and | |
442 | # a trusted CA certificate should always be configured when using | |
443 | # EAP-TLS/TTLS/PEAP. Full path should be used since working directory may | |
444 | # change when wpa_supplicant is run in the background. | |
00468b46 JM |
445 | # |
446 | # Alternatively, this can be used to only perform matching of the server | |
447 | # certificate (SHA-256 hash of the DER encoded X.509 certificate). In | |
448 | # this case, the possible CA certificates in the server certificate chain | |
449 | # are ignored and only the server certificate is verified. This is | |
450 | # configured with the following format: | |
451 | # hash:://server/sha256/cert_hash_in_hex | |
452 | # For example: "hash://server/sha256/ | |
453 | # 5a1bc1296205e6fdbe3979728efe3920798885c1c4590b5f90f43222d239ca6a" | |
454 | # | |
6fc6879b JM |
455 | # On Windows, trusted CA certificates can be loaded from the system |
456 | # certificate store by setting this to cert_store://<name>, e.g., | |
457 | # ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". | |
458 | # Note that when running wpa_supplicant as an application, the user | |
459 | # certificate store (My user account) is used, whereas computer store | |
460 | # (Computer account) is used when running wpasvc as a service. | |
461 | # ca_path: Directory path for CA certificate files (PEM). This path may | |
462 | # contain multiple CA certificates in OpenSSL format. Common use for this | |
463 | # is to point to system trusted CA list which is often installed into | |
464 | # directory like /etc/ssl/certs. If configured, these certificates are | |
465 | # added to the list of trusted CAs. ca_cert may also be included in that | |
466 | # case, but it is not required. | |
467 | # client_cert: File path to client certificate file (PEM/DER) | |
468 | # Full path should be used since working directory may change when | |
469 | # wpa_supplicant is run in the background. | |
470 | # Alternatively, a named configuration blob can be used by setting this | |
471 | # to blob://<blob name>. | |
472 | # private_key: File path to client private key file (PEM/DER/PFX) | |
473 | # When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be | |
474 | # commented out. Both the private key and certificate will be read from | |
475 | # the PKCS#12 file in this case. Full path should be used since working | |
476 | # directory may change when wpa_supplicant is run in the background. | |
477 | # Windows certificate store can be used by leaving client_cert out and | |
478 | # configuring private_key in one of the following formats: | |
479 | # cert://substring_to_match | |
480 | # hash://certificate_thumbprint_in_hex | |
481 | # for example: private_key="hash://63093aa9c47f56ae88334c7b65a4" | |
482 | # Note that when running wpa_supplicant as an application, the user | |
483 | # certificate store (My user account) is used, whereas computer store | |
484 | # (Computer account) is used when running wpasvc as a service. | |
485 | # Alternatively, a named configuration blob can be used by setting this | |
486 | # to blob://<blob name>. | |
487 | # private_key_passwd: Password for private key file (if left out, this will be | |
488 | # asked through control interface) | |
489 | # dh_file: File path to DH/DSA parameters file (in PEM format) | |
490 | # This is an optional configuration file for setting parameters for an | |
491 | # ephemeral DH key exchange. In most cases, the default RSA | |
492 | # authentication does not use this configuration. However, it is possible | |
493 | # setup RSA to use ephemeral DH key exchange. In addition, ciphers with | |
494 | # DSA keys always use ephemeral DH keys. This can be used to achieve | |
495 | # forward secrecy. If the file is in DSA parameters format, it will be | |
496 | # automatically converted into DH params. | |
497 | # subject_match: Substring to be matched against the subject of the | |
498 | # authentication server certificate. If this string is set, the server | |
499 | # sertificate is only accepted if it contains this string in the subject. | |
500 | # The subject string is in following format: | |
501 | # /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com | |
502 | # altsubject_match: Semicolon separated string of entries to be matched against | |
503 | # the alternative subject name of the authentication server certificate. | |
504 | # If this string is set, the server sertificate is only accepted if it | |
505 | # contains one of the entries in an alternative subject name extension. | |
506 | # altSubjectName string is in following format: TYPE:VALUE | |
507 | # Example: EMAIL:server@example.com | |
508 | # Example: DNS:server.example.com;DNS:server2.example.com | |
509 | # Following types are supported: EMAIL, DNS, URI | |
510 | # phase1: Phase1 (outer authentication, i.e., TLS tunnel) parameters | |
511 | # (string with field-value pairs, e.g., "peapver=0" or | |
512 | # "peapver=1 peaplabel=1") | |
513 | # 'peapver' can be used to force which PEAP version (0 or 1) is used. | |
514 | # 'peaplabel=1' can be used to force new label, "client PEAP encryption", | |
515 | # to be used during key derivation when PEAPv1 or newer. Most existing | |
516 | # PEAPv1 implementation seem to be using the old label, "client EAP | |
517 | # encryption", and wpa_supplicant is now using that as the default value. | |
518 | # Some servers, e.g., Radiator, may require peaplabel=1 configuration to | |
519 | # interoperate with PEAPv1; see eap_testing.txt for more details. | |
520 | # 'peap_outer_success=0' can be used to terminate PEAP authentication on | |
521 | # tunneled EAP-Success. This is required with some RADIUS servers that | |
522 | # implement draft-josefsson-pppext-eap-tls-eap-05.txt (e.g., | |
523 | # Lucent NavisRadius v4.4.0 with PEAP in "IETF Draft 5" mode) | |
524 | # include_tls_length=1 can be used to force wpa_supplicant to include | |
525 | # TLS Message Length field in all TLS messages even if they are not | |
526 | # fragmented. | |
527 | # sim_min_num_chal=3 can be used to configure EAP-SIM to require three | |
528 | # challenges (by default, it accepts 2 or 3) | |
529 | # result_ind=1 can be used to enable EAP-SIM and EAP-AKA to use | |
530 | # protected result indication. | |
d6888f9e JM |
531 | # 'crypto_binding' option can be used to control PEAPv0 cryptobinding |
532 | # behavior: | |
c31a11c9 JM |
533 | # * 0 = do not use cryptobinding (default) |
534 | # * 1 = use cryptobinding if server supports it | |
d6888f9e | 535 | # * 2 = require cryptobinding |
f855f923 JM |
536 | # EAP-WSC (WPS) uses following options: pin=<Device Password> or |
537 | # pbc=1. | |
6fc6879b JM |
538 | # phase2: Phase2 (inner authentication with TLS tunnel) parameters |
539 | # (string with field-value pairs, e.g., "auth=MSCHAPV2" for EAP-PEAP or | |
540 | # "autheap=MSCHAPV2 autheap=MD5" for EAP-TTLS) | |
541 | # Following certificate/private key fields are used in inner Phase2 | |
542 | # authentication when using EAP-TTLS or EAP-PEAP. | |
543 | # ca_cert2: File path to CA certificate file. This file can have one or more | |
544 | # trusted CA certificates. If ca_cert2 and ca_path2 are not included, | |
545 | # server certificate will not be verified. This is insecure and a trusted | |
546 | # CA certificate should always be configured. | |
547 | # ca_path2: Directory path for CA certificate files (PEM) | |
548 | # client_cert2: File path to client certificate file | |
549 | # private_key2: File path to client private key file | |
550 | # private_key2_passwd: Password for private key file | |
551 | # dh_file2: File path to DH/DSA parameters file (in PEM format) | |
552 | # subject_match2: Substring to be matched against the subject of the | |
553 | # authentication server certificate. | |
554 | # altsubject_match2: Substring to be matched against the alternative subject | |
555 | # name of the authentication server certificate. | |
556 | # | |
557 | # fragment_size: Maximum EAP fragment size in bytes (default 1398). | |
558 | # This value limits the fragment size for EAP methods that support | |
559 | # fragmentation (e.g., EAP-TLS and EAP-PEAP). This value should be set | |
560 | # small enough to make the EAP messages fit in MTU of the network | |
561 | # interface used for EAPOL. The default value is suitable for most | |
562 | # cases. | |
563 | # | |
564 | # EAP-FAST variables: | |
565 | # pac_file: File path for the PAC entries. wpa_supplicant will need to be able | |
566 | # to create this file and write updates to it when PAC is being | |
567 | # provisioned or refreshed. Full path to the file should be used since | |
568 | # working directory may change when wpa_supplicant is run in the | |
569 | # background. Alternatively, a named configuration blob can be used by | |
570 | # setting this to blob://<blob name> | |
571 | # phase1: fast_provisioning option can be used to enable in-line provisioning | |
572 | # of EAP-FAST credentials (PAC): | |
573 | # 0 = disabled, | |
574 | # 1 = allow unauthenticated provisioning, | |
575 | # 2 = allow authenticated provisioning, | |
576 | # 3 = allow both unauthenticated and authenticated provisioning | |
577 | # fast_max_pac_list_len=<num> option can be used to set the maximum | |
578 | # number of PAC entries to store in a PAC list (default: 10) | |
579 | # fast_pac_format=binary option can be used to select binary format for | |
2e8c9a27 | 580 | # storing PAC entries in order to save some space (the default |
6fc6879b JM |
581 | # text format uses about 2.5 times the size of minimal binary |
582 | # format) | |
583 | # | |
584 | # wpa_supplicant supports number of "EAP workarounds" to work around | |
585 | # interoperability issues with incorrectly behaving authentication servers. | |
586 | # These are enabled by default because some of the issues are present in large | |
587 | # number of authentication servers. Strict EAP conformance mode can be | |
588 | # configured by disabling workarounds with eap_workaround=0. | |
589 | ||
590 | # Example blocks: | |
591 | ||
592 | # Simple case: WPA-PSK, PSK as an ASCII passphrase, allow all valid ciphers | |
593 | network={ | |
594 | ssid="simple" | |
595 | psk="very secret passphrase" | |
596 | priority=5 | |
597 | } | |
598 | ||
599 | # Same as previous, but request SSID-specific scanning (for APs that reject | |
600 | # broadcast SSID) | |
601 | network={ | |
602 | ssid="second ssid" | |
603 | scan_ssid=1 | |
604 | psk="very secret passphrase" | |
605 | priority=2 | |
606 | } | |
607 | ||
608 | # Only WPA-PSK is used. Any valid cipher combination is accepted. | |
609 | network={ | |
610 | ssid="example" | |
611 | proto=WPA | |
612 | key_mgmt=WPA-PSK | |
613 | pairwise=CCMP TKIP | |
614 | group=CCMP TKIP WEP104 WEP40 | |
615 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
616 | priority=2 | |
617 | } | |
618 | ||
581a8cde JM |
619 | # WPA-Personal(PSK) with TKIP and enforcement for frequent PTK rekeying |
620 | network={ | |
621 | ssid="example" | |
622 | proto=WPA | |
623 | key_mgmt=WPA-PSK | |
624 | pairwise=TKIP | |
625 | group=TKIP | |
626 | psk="not so secure passphrase" | |
627 | wpa_ptk_rekey=600 | |
628 | } | |
629 | ||
6fc6879b JM |
630 | # Only WPA-EAP is used. Both CCMP and TKIP is accepted. An AP that used WEP104 |
631 | # or WEP40 as the group cipher will not be accepted. | |
632 | network={ | |
633 | ssid="example" | |
634 | proto=RSN | |
635 | key_mgmt=WPA-EAP | |
636 | pairwise=CCMP TKIP | |
637 | group=CCMP TKIP | |
638 | eap=TLS | |
639 | identity="user@example.com" | |
640 | ca_cert="/etc/cert/ca.pem" | |
641 | client_cert="/etc/cert/user.pem" | |
642 | private_key="/etc/cert/user.prv" | |
643 | private_key_passwd="password" | |
644 | priority=1 | |
645 | } | |
646 | ||
647 | # EAP-PEAP/MSCHAPv2 configuration for RADIUS servers that use the new peaplabel | |
648 | # (e.g., Radiator) | |
649 | network={ | |
650 | ssid="example" | |
651 | key_mgmt=WPA-EAP | |
652 | eap=PEAP | |
653 | identity="user@example.com" | |
654 | password="foobar" | |
655 | ca_cert="/etc/cert/ca.pem" | |
656 | phase1="peaplabel=1" | |
657 | phase2="auth=MSCHAPV2" | |
658 | priority=10 | |
659 | } | |
660 | ||
661 | # EAP-TTLS/EAP-MD5-Challenge configuration with anonymous identity for the | |
662 | # unencrypted use. Real identity is sent only within an encrypted TLS tunnel. | |
663 | network={ | |
664 | ssid="example" | |
665 | key_mgmt=WPA-EAP | |
666 | eap=TTLS | |
667 | identity="user@example.com" | |
668 | anonymous_identity="anonymous@example.com" | |
669 | password="foobar" | |
670 | ca_cert="/etc/cert/ca.pem" | |
671 | priority=2 | |
672 | } | |
673 | ||
674 | # EAP-TTLS/MSCHAPv2 configuration with anonymous identity for the unencrypted | |
675 | # use. Real identity is sent only within an encrypted TLS tunnel. | |
676 | network={ | |
677 | ssid="example" | |
678 | key_mgmt=WPA-EAP | |
679 | eap=TTLS | |
680 | identity="user@example.com" | |
681 | anonymous_identity="anonymous@example.com" | |
682 | password="foobar" | |
683 | ca_cert="/etc/cert/ca.pem" | |
684 | phase2="auth=MSCHAPV2" | |
685 | } | |
686 | ||
687 | # WPA-EAP, EAP-TTLS with different CA certificate used for outer and inner | |
688 | # authentication. | |
689 | network={ | |
690 | ssid="example" | |
691 | key_mgmt=WPA-EAP | |
692 | eap=TTLS | |
693 | # Phase1 / outer authentication | |
694 | anonymous_identity="anonymous@example.com" | |
695 | ca_cert="/etc/cert/ca.pem" | |
696 | # Phase 2 / inner authentication | |
697 | phase2="autheap=TLS" | |
698 | ca_cert2="/etc/cert/ca2.pem" | |
699 | client_cert2="/etc/cer/user.pem" | |
700 | private_key2="/etc/cer/user.prv" | |
701 | private_key2_passwd="password" | |
702 | priority=2 | |
703 | } | |
704 | ||
705 | # Both WPA-PSK and WPA-EAP is accepted. Only CCMP is accepted as pairwise and | |
706 | # group cipher. | |
707 | network={ | |
708 | ssid="example" | |
709 | bssid=00:11:22:33:44:55 | |
710 | proto=WPA RSN | |
711 | key_mgmt=WPA-PSK WPA-EAP | |
712 | pairwise=CCMP | |
713 | group=CCMP | |
714 | psk=06b4be19da289f475aa46a33cb793029d4ab3db7a23ee92382eb0106c72ac7bb | |
715 | } | |
716 | ||
717 | # Special characters in SSID, so use hex string. Default to WPA-PSK, WPA-EAP | |
718 | # and all valid ciphers. | |
719 | network={ | |
720 | ssid=00010203 | |
721 | psk=000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f | |
722 | } | |
723 | ||
724 | ||
725 | # EAP-SIM with a GSM SIM or USIM | |
726 | network={ | |
727 | ssid="eap-sim-test" | |
728 | key_mgmt=WPA-EAP | |
729 | eap=SIM | |
730 | pin="1234" | |
731 | pcsc="" | |
732 | } | |
733 | ||
734 | ||
735 | # EAP-PSK | |
736 | network={ | |
737 | ssid="eap-psk-test" | |
738 | key_mgmt=WPA-EAP | |
739 | eap=PSK | |
740 | anonymous_identity="eap_psk_user" | |
741 | password=06b4be19da289f475aa46a33cb793029 | |
742 | identity="eap_psk_user@example.com" | |
743 | } | |
744 | ||
745 | ||
746 | # IEEE 802.1X/EAPOL with dynamically generated WEP keys (i.e., no WPA) using | |
747 | # EAP-TLS for authentication and key generation; require both unicast and | |
748 | # broadcast WEP keys. | |
749 | network={ | |
750 | ssid="1x-test" | |
751 | key_mgmt=IEEE8021X | |
752 | eap=TLS | |
753 | identity="user@example.com" | |
754 | ca_cert="/etc/cert/ca.pem" | |
755 | client_cert="/etc/cert/user.pem" | |
756 | private_key="/etc/cert/user.prv" | |
757 | private_key_passwd="password" | |
758 | eapol_flags=3 | |
759 | } | |
760 | ||
761 | ||
762 | # LEAP with dynamic WEP keys | |
763 | network={ | |
764 | ssid="leap-example" | |
765 | key_mgmt=IEEE8021X | |
766 | eap=LEAP | |
767 | identity="user" | |
768 | password="foobar" | |
769 | } | |
770 | ||
771 | # EAP-IKEv2 using shared secrets for both server and peer authentication | |
772 | network={ | |
773 | ssid="ikev2-example" | |
774 | key_mgmt=WPA-EAP | |
775 | eap=IKEV2 | |
776 | identity="user" | |
777 | password="foobar" | |
778 | } | |
779 | ||
780 | # EAP-FAST with WPA (WPA or WPA2) | |
781 | network={ | |
782 | ssid="eap-fast-test" | |
783 | key_mgmt=WPA-EAP | |
784 | eap=FAST | |
785 | anonymous_identity="FAST-000102030405" | |
786 | identity="username" | |
787 | password="password" | |
788 | phase1="fast_provisioning=1" | |
789 | pac_file="/etc/wpa_supplicant.eap-fast-pac" | |
790 | } | |
791 | ||
792 | network={ | |
793 | ssid="eap-fast-test" | |
794 | key_mgmt=WPA-EAP | |
795 | eap=FAST | |
796 | anonymous_identity="FAST-000102030405" | |
797 | identity="username" | |
798 | password="password" | |
799 | phase1="fast_provisioning=1" | |
800 | pac_file="blob://eap-fast-pac" | |
801 | } | |
802 | ||
803 | # Plaintext connection (no WPA, no IEEE 802.1X) | |
804 | network={ | |
805 | ssid="plaintext-test" | |
806 | key_mgmt=NONE | |
807 | } | |
808 | ||
809 | ||
810 | # Shared WEP key connection (no WPA, no IEEE 802.1X) | |
811 | network={ | |
812 | ssid="static-wep-test" | |
813 | key_mgmt=NONE | |
814 | wep_key0="abcde" | |
815 | wep_key1=0102030405 | |
816 | wep_key2="1234567890123" | |
817 | wep_tx_keyidx=0 | |
818 | priority=5 | |
819 | } | |
820 | ||
821 | ||
822 | # Shared WEP key connection (no WPA, no IEEE 802.1X) using Shared Key | |
823 | # IEEE 802.11 authentication | |
824 | network={ | |
825 | ssid="static-wep-test2" | |
826 | key_mgmt=NONE | |
827 | wep_key0="abcde" | |
828 | wep_key1=0102030405 | |
829 | wep_key2="1234567890123" | |
830 | wep_tx_keyidx=0 | |
831 | priority=5 | |
832 | auth_alg=SHARED | |
833 | } | |
834 | ||
835 | ||
836 | # IBSS/ad-hoc network with WPA-None/TKIP. | |
837 | network={ | |
838 | ssid="test adhoc" | |
839 | mode=1 | |
840 | frequency=2412 | |
841 | proto=WPA | |
842 | key_mgmt=WPA-NONE | |
843 | pairwise=NONE | |
844 | group=TKIP | |
845 | psk="secret passphrase" | |
846 | } | |
847 | ||
848 | ||
849 | # Catch all example that allows more or less all configuration modes | |
850 | network={ | |
851 | ssid="example" | |
852 | scan_ssid=1 | |
853 | key_mgmt=WPA-EAP WPA-PSK IEEE8021X NONE | |
854 | pairwise=CCMP TKIP | |
855 | group=CCMP TKIP WEP104 WEP40 | |
856 | psk="very secret passphrase" | |
857 | eap=TTLS PEAP TLS | |
858 | identity="user@example.com" | |
859 | password="foobar" | |
860 | ca_cert="/etc/cert/ca.pem" | |
861 | client_cert="/etc/cert/user.pem" | |
862 | private_key="/etc/cert/user.prv" | |
863 | private_key_passwd="password" | |
864 | phase1="peaplabel=0" | |
865 | } | |
866 | ||
867 | # Example of EAP-TLS with smartcard (openssl engine) | |
868 | network={ | |
869 | ssid="example" | |
870 | key_mgmt=WPA-EAP | |
871 | eap=TLS | |
872 | proto=RSN | |
873 | pairwise=CCMP TKIP | |
874 | group=CCMP TKIP | |
875 | identity="user@example.com" | |
876 | ca_cert="/etc/cert/ca.pem" | |
877 | client_cert="/etc/cert/user.pem" | |
878 | ||
879 | engine=1 | |
880 | ||
881 | # The engine configured here must be available. Look at | |
882 | # OpenSSL engine support in the global section. | |
883 | # The key available through the engine must be the private key | |
884 | # matching the client certificate configured above. | |
885 | ||
886 | # use the opensc engine | |
887 | #engine_id="opensc" | |
888 | #key_id="45" | |
889 | ||
890 | # use the pkcs11 engine | |
891 | engine_id="pkcs11" | |
892 | key_id="id_45" | |
893 | ||
894 | # Optional PIN configuration; this can be left out and PIN will be | |
895 | # asked through the control interface | |
896 | pin="1234" | |
897 | } | |
898 | ||
899 | # Example configuration showing how to use an inlined blob as a CA certificate | |
900 | # data instead of using external file | |
901 | network={ | |
902 | ssid="example" | |
903 | key_mgmt=WPA-EAP | |
904 | eap=TTLS | |
905 | identity="user@example.com" | |
906 | anonymous_identity="anonymous@example.com" | |
907 | password="foobar" | |
908 | ca_cert="blob://exampleblob" | |
909 | priority=20 | |
910 | } | |
911 | ||
912 | blob-base64-exampleblob={ | |
913 | SGVsbG8gV29ybGQhCg== | |
914 | } | |
915 | ||
916 | ||
917 | # Wildcard match for SSID (plaintext APs only). This example select any | |
918 | # open AP regardless of its SSID. | |
919 | network={ | |
920 | key_mgmt=NONE | |
921 | } |