xref: /freebsd/contrib/wpa/wpa_supplicant/config_ssid.h (revision ec0ea6efa1ad229d75c394c1a9b9cac33af2b1d3)
1 /*
2  * WPA Supplicant / Network configuration structures
3  * Copyright (c) 2003-2013, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #ifndef CONFIG_SSID_H
10 #define CONFIG_SSID_H
11 
12 #include "common/defs.h"
13 #include "utils/list.h"
14 #include "eap_peer/eap_config.h"
15 
16 
17 #define DEFAULT_EAP_WORKAROUND ((unsigned int) -1)
18 #define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \
19 			     EAPOL_FLAG_REQUIRE_KEY_BROADCAST)
20 #define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN)
21 #define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X)
22 #ifdef CONFIG_NO_TKIP
23 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP)
24 #define DEFAULT_GROUP (WPA_CIPHER_CCMP)
25 #else /* CONFIG_NO_TKIP */
26 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
27 #define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
28 #endif /* CONFIG_NO_TKIP */
29 #define DEFAULT_FRAGMENT_SIZE 1398
30 
31 #define DEFAULT_BG_SCAN_PERIOD -1
32 #define DEFAULT_MESH_MAX_RETRIES 2
33 #define DEFAULT_MESH_RETRY_TIMEOUT 40
34 #define DEFAULT_MESH_CONFIRM_TIMEOUT 40
35 #define DEFAULT_MESH_HOLDING_TIMEOUT 40
36 #define DEFAULT_MESH_RSSI_THRESHOLD 1 /* no change */
37 #define DEFAULT_DISABLE_HT 0
38 #define DEFAULT_DISABLE_HT40 0
39 #define DEFAULT_DISABLE_SGI 0
40 #define DEFAULT_DISABLE_LDPC 0
41 #define DEFAULT_TX_STBC -1 /* no change */
42 #define DEFAULT_RX_STBC -1 /* no change */
43 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
44 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
45 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
46 #define DEFAULT_USER_SELECTED_SIM 1
47 #define DEFAULT_MAX_OPER_CHWIDTH -1
48 
49 /* Consider global sae_pwe for SAE mechanism for PWE derivation */
50 #define DEFAULT_SAE_PWE 4
51 
52 struct psk_list_entry {
53 	struct dl_list list;
54 	u8 addr[ETH_ALEN];
55 	u8 psk[32];
56 	u8 p2p;
57 };
58 
59 enum wpas_mode {
60 	WPAS_MODE_INFRA = 0,
61 	WPAS_MODE_IBSS = 1,
62 	WPAS_MODE_AP = 2,
63 	WPAS_MODE_P2P_GO = 3,
64 	WPAS_MODE_P2P_GROUP_FORMATION = 4,
65 	WPAS_MODE_MESH = 5,
66 };
67 
68 enum sae_pk_mode {
69 	SAE_PK_MODE_AUTOMATIC = 0,
70 	SAE_PK_MODE_ONLY = 1,
71 	SAE_PK_MODE_DISABLED = 2,
72 };
73 
74 /**
75  * struct wpa_ssid - Network configuration data
76  *
77  * This structure includes all the configuration variables for a network. This
78  * data is included in the per-interface configuration data as an element of
79  * the network list, struct wpa_config::ssid. Each network block in the
80  * configuration is mapped to a struct wpa_ssid instance.
81  */
82 struct wpa_ssid {
83 	/**
84 	 * next - Next network in global list
85 	 *
86 	 * This pointer can be used to iterate over all networks. The head of
87 	 * this list is stored in the ssid field of struct wpa_config.
88 	 */
89 	struct wpa_ssid *next;
90 
91 	/**
92 	 * pnext - Next network in per-priority list
93 	 *
94 	 * This pointer can be used to iterate over all networks in the same
95 	 * priority class. The heads of these list are stored in the pssid
96 	 * fields of struct wpa_config.
97 	 */
98 	struct wpa_ssid *pnext;
99 
100 	/**
101 	 * id - Unique id for the network
102 	 *
103 	 * This identifier is used as a unique identifier for each network
104 	 * block when using the control interface. Each network is allocated an
105 	 * id when it is being created, either when reading the configuration
106 	 * file or when a new network is added through the control interface.
107 	 */
108 	int id;
109 
110 	/**
111 	 * priority - Priority group
112 	 *
113 	 * By default, all networks will get same priority group (0). If some
114 	 * of the networks are more desirable, this field can be used to change
115 	 * the order in which wpa_supplicant goes through the networks when
116 	 * selecting a BSS. The priority groups will be iterated in decreasing
117 	 * priority (i.e., the larger the priority value, the sooner the
118 	 * network is matched against the scan results). Within each priority
119 	 * group, networks will be selected based on security policy, signal
120 	 * strength, etc.
121 	 *
122 	 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
123 	 * not using this priority to select the order for scanning. Instead,
124 	 * they try the networks in the order that used in the configuration
125 	 * file.
126 	 */
127 	int priority;
128 
129 	/**
130 	 * ssid - Service set identifier (network name)
131 	 *
132 	 * This is the SSID for the network. For wireless interfaces, this is
133 	 * used to select which network will be used. If set to %NULL (or
134 	 * ssid_len=0), any SSID can be used. For wired interfaces, this must
135 	 * be set to %NULL. Note: SSID may contain any characters, even nul
136 	 * (ASCII 0) and as such, this should not be assumed to be a nul
137 	 * terminated string. ssid_len defines how many characters are valid
138 	 * and the ssid field is not guaranteed to be nul terminated.
139 	 */
140 	u8 *ssid;
141 
142 	/**
143 	 * ssid_len - Length of the SSID
144 	 */
145 	size_t ssid_len;
146 
147 	/**
148 	 * bssid - BSSID
149 	 *
150 	 * If set, this network block is used only when associating with the AP
151 	 * using the configured BSSID
152 	 *
153 	 * If this is a persistent P2P group (disabled == 2), this is the GO
154 	 * Device Address.
155 	 */
156 	u8 bssid[ETH_ALEN];
157 
158 	/**
159 	 * bssid_ignore - List of inacceptable BSSIDs
160 	 */
161 	u8 *bssid_ignore;
162 	size_t num_bssid_ignore;
163 
164 	/**
165 	 * bssid_accept - List of acceptable BSSIDs
166 	 */
167 	u8 *bssid_accept;
168 	size_t num_bssid_accept;
169 
170 	/**
171 	 * bssid_set - Whether BSSID is configured for this network
172 	 */
173 	int bssid_set;
174 
175 	/**
176 	 * bssid_hint - BSSID hint
177 	 *
178 	 * If set, this is configured to the driver as a preferred initial BSSID
179 	 * while connecting to this network.
180 	 */
181 	u8 bssid_hint[ETH_ALEN];
182 
183 	/**
184 	 * bssid_hint_set - Whether BSSID hint is configured for this network
185 	 */
186 	int bssid_hint_set;
187 
188 	/**
189 	 * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
190 	 */
191 	u8 go_p2p_dev_addr[ETH_ALEN];
192 
193 	/**
194 	 * psk - WPA pre-shared key (256 bits)
195 	 */
196 	u8 psk[32];
197 
198 	/**
199 	 * psk_set - Whether PSK field is configured
200 	 */
201 	int psk_set;
202 
203 	/**
204 	 * passphrase - WPA ASCII passphrase
205 	 *
206 	 * If this is set, psk will be generated using the SSID and passphrase
207 	 * configured for the network. ASCII passphrase must be between 8 and
208 	 * 63 characters (inclusive).
209 	 */
210 	char *passphrase;
211 
212 	/**
213 	 * sae_password - SAE password
214 	 *
215 	 * This parameter can be used to set a password for SAE. By default, the
216 	 * passphrase value is used if this separate parameter is not used, but
217 	 * passphrase follows the WPA-PSK constraints (8..63 characters) even
218 	 * though SAE passwords do not have such constraints.
219 	 */
220 	char *sae_password;
221 
222 	/**
223 	 * sae_password_id - SAE password identifier
224 	 *
225 	 * This parameter can be used to identify a specific SAE password. If
226 	 * not included, the default SAE password is used instead.
227 	 */
228 	char *sae_password_id;
229 
230 	struct sae_pt *pt;
231 
232 	/**
233 	 * ext_psk - PSK/passphrase name in external storage
234 	 *
235 	 * If this is set, PSK/passphrase will be fetched from external storage
236 	 * when requesting association with the network.
237 	 */
238 	char *ext_psk;
239 
240 	/**
241 	 * mem_only_psk - Whether to keep PSK/passphrase only in memory
242 	 *
243 	 * 0 = allow psk/passphrase to be stored to the configuration file
244 	 * 1 = do not store psk/passphrase to the configuration file
245 	 */
246 	int mem_only_psk;
247 
248 	/**
249 	 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
250 	 */
251 	int pairwise_cipher;
252 
253 	/**
254 	 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
255 	 */
256 	int group_cipher;
257 
258 	/**
259 	 * group_mgmt_cipher - Bitfield of allowed group management ciphers
260 	 *
261 	 * This is a bitfield of WPA_CIPHER_AES_128_CMAC and WPA_CIPHER_BIP_*
262 	 * values. If 0, no constraint is used for the cipher, i.e., whatever
263 	 * the AP uses is accepted.
264 	 */
265 	int group_mgmt_cipher;
266 
267 	/**
268 	 * key_mgmt - Bitfield of allowed key management protocols
269 	 *
270 	 * WPA_KEY_MGMT_*
271 	 */
272 	int key_mgmt;
273 
274 	/**
275 	 * bg_scan_period - Background scan period in seconds, 0 to disable, or
276 	 * -1 to indicate no change to default driver configuration
277 	 */
278 	int bg_scan_period;
279 
280 	/**
281 	 * proto - Bitfield of allowed protocols, WPA_PROTO_*
282 	 */
283 	int proto;
284 
285 	/**
286 	 * auth_alg -  Bitfield of allowed authentication algorithms
287 	 *
288 	 * WPA_AUTH_ALG_*
289 	 */
290 	int auth_alg;
291 
292 	/**
293 	 * scan_ssid - Scan this SSID with Probe Requests
294 	 *
295 	 * scan_ssid can be used to scan for APs using hidden SSIDs.
296 	 * Note: Many drivers do not support this. ap_mode=2 can be used with
297 	 * such drivers to use hidden SSIDs. Note2: Most nl80211-based drivers
298 	 * do support scan_ssid=1 and that should be used with them instead of
299 	 * ap_scan=2.
300 	 */
301 	int scan_ssid;
302 
303 #ifdef IEEE8021X_EAPOL
304 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
305 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
306 	/**
307 	 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
308 	 */
309 	int eapol_flags;
310 
311 	/**
312 	 * eap - EAP peer configuration for this network
313 	 */
314 	struct eap_peer_config eap;
315 #endif /* IEEE8021X_EAPOL */
316 
317 #ifdef CONFIG_WEP
318 #define NUM_WEP_KEYS 4
319 #define MAX_WEP_KEY_LEN 16
320 	/**
321 	 * wep_key - WEP keys
322 	 */
323 	u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
324 
325 	/**
326 	 * wep_key_len - WEP key lengths
327 	 */
328 	size_t wep_key_len[NUM_WEP_KEYS];
329 
330 	/**
331 	 * wep_tx_keyidx - Default key index for TX frames using WEP
332 	 */
333 	int wep_tx_keyidx;
334 #endif /* CONFIG_WEP */
335 
336 	/**
337 	 * proactive_key_caching - Enable proactive key caching
338 	 *
339 	 * This field can be used to enable proactive key caching which is also
340 	 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
341 	 * by default unless default value is changed with the global okc=1
342 	 * parameter. Enable by setting this to 1.
343 	 *
344 	 * Proactive key caching is used to make supplicant assume that the APs
345 	 * are using the same PMK and generate PMKSA cache entries without
346 	 * doing RSN pre-authentication. This requires support from the AP side
347 	 * and is normally used with wireless switches that co-locate the
348 	 * authenticator.
349 	 *
350 	 * Internally, special value -1 is used to indicate that the parameter
351 	 * was not specified in the configuration (i.e., default behavior is
352 	 * followed).
353 	 */
354 	int proactive_key_caching;
355 
356 	/**
357 	 * mixed_cell - Whether mixed cells are allowed
358 	 *
359 	 * This option can be used to configure whether so called mixed cells,
360 	 * i.e., networks that use both plaintext and encryption in the same
361 	 * SSID, are allowed. This is disabled (0) by default. Enable by
362 	 * setting this to 1.
363 	 */
364 	int mixed_cell;
365 
366 #ifdef IEEE8021X_EAPOL
367 
368 	/**
369 	 * leap - Number of EAP methods using LEAP
370 	 *
371 	 * This field should be set to 1 if LEAP is enabled. This is used to
372 	 * select IEEE 802.11 authentication algorithm.
373 	 */
374 	int leap;
375 
376 	/**
377 	 * non_leap - Number of EAP methods not using LEAP
378 	 *
379 	 * This field should be set to >0 if any EAP method other than LEAP is
380 	 * enabled. This is used to select IEEE 802.11 authentication
381 	 * algorithm.
382 	 */
383 	int non_leap;
384 
385 	/**
386 	 * eap_workaround - EAP workarounds enabled
387 	 *
388 	 * wpa_supplicant supports number of "EAP workarounds" to work around
389 	 * interoperability issues with incorrectly behaving authentication
390 	 * servers. This is recommended to be enabled by default because some
391 	 * of the issues are present in large number of authentication servers.
392 	 *
393 	 * Strict EAP conformance mode can be configured by disabling
394 	 * workarounds with eap_workaround = 0.
395 	 */
396 	unsigned int eap_workaround;
397 
398 #endif /* IEEE8021X_EAPOL */
399 
400 	/**
401 	 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
402 	 *
403 	 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
404 	 *
405 	 * 1 = IBSS (ad-hoc, peer-to-peer)
406 	 *
407 	 * 2 = AP (access point)
408 	 *
409 	 * 3 = P2P Group Owner (can be set in the configuration file)
410 	 *
411 	 * 4 = P2P Group Formation (used internally; not in configuration
412 	 * files)
413 	 *
414 	 * 5 = Mesh
415 	 *
416 	 * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
417 	 * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
418 	 * (fixed group key TKIP/CCMP) is available for backwards compatibility,
419 	 * but its use is deprecated. WPA-None requires following network block
420 	 * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
421 	 * CCMP, but not both), and psk must also be set (either directly or
422 	 * using ASCII passphrase).
423 	 */
424 	enum wpas_mode mode;
425 
426 	/**
427 	 * pbss - Whether to use PBSS. Relevant to DMG networks only.
428 	 * 0 = do not use PBSS
429 	 * 1 = use PBSS
430 	 * 2 = don't care (not allowed in AP mode)
431 	 * Used together with mode configuration. When mode is AP, it
432 	 * means to start a PCP instead of a regular AP. When mode is INFRA it
433 	 * means connect to a PCP instead of AP. In this mode you can also
434 	 * specify 2 (don't care) meaning connect to either AP or PCP.
435 	 * P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in DMG network.
436 	 */
437 	int pbss;
438 
439 	/**
440 	 * disabled - Whether this network is currently disabled
441 	 *
442 	 * 0 = this network can be used (default).
443 	 * 1 = this network block is disabled (can be enabled through
444 	 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
445 	 * 2 = this network block includes parameters for a persistent P2P
446 	 * group (can be used with P2P ctrl_iface commands)
447 	 */
448 	int disabled;
449 
450 	/**
451 	 * disabled_for_connect - Whether this network was temporarily disabled
452 	 *
453 	 * This flag is used to reenable all the temporarily disabled networks
454 	 * after either the success or failure of a WPS connection.
455 	 */
456 	int disabled_for_connect;
457 
458 	/**
459 	 * id_str - Network identifier string for external scripts
460 	 *
461 	 * This value is passed to external ctrl_iface monitors in
462 	 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
463 	 * environment variable for action scripts.
464 	 */
465 	char *id_str;
466 
467 	/**
468 	 * ieee80211w - Whether management frame protection is enabled
469 	 *
470 	 * This value is used to configure policy for management frame
471 	 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
472 	 * This is disabled by default unless the default value has been changed
473 	 * with the global pmf=1/2 parameter.
474 	 *
475 	 * Internally, special value 3 is used to indicate that the parameter
476 	 * was not specified in the configuration (i.e., default behavior is
477 	 * followed).
478 	 */
479 	enum mfp_options ieee80211w;
480 
481 #ifdef CONFIG_OCV
482 	/**
483 	 * ocv - Enable/disable operating channel validation
484 	 *
485 	 * If this parameter is set to 1, stations will exchange OCI element
486 	 * to cryptographically verify the operating channel. Setting this
487 	 * parameter to 0 disables this option. Default value: 0.
488 	 */
489 	int ocv;
490 #endif /* CONFIG_OCV */
491 
492 	/**
493 	 * frequency - Channel frequency in megahertz (MHz) for IBSS
494 	 *
495 	 * This value is used to configure the initial channel for IBSS (adhoc)
496 	 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
497 	 * the infrastructure mode. In addition, this value is only used by the
498 	 * station that creates the IBSS. If an IBSS network with the
499 	 * configured SSID is already present, the frequency of the network
500 	 * will be used instead of this configured value.
501 	 */
502 	int frequency;
503 
504 	/**
505 	 * enable_edmg - Enable EDMG feature in STA/AP mode
506 	 *
507 	 * This flag is used for enabling the EDMG capability in STA/AP mode.
508 	 */
509 	int enable_edmg;
510 
511 	/**
512 	 * edmg_channel - EDMG channel number
513 	 *
514 	 * This value is used to configure the EDMG channel bonding feature.
515 	 * In AP mode it defines the EDMG channel to start the AP on.
516 	 * in STA mode it defines the EDMG channel to use for connection
517 	 * (if supported by AP).
518 	 */
519 	u8 edmg_channel;
520 
521 	/**
522 	 * fixed_freq - Use fixed frequency for IBSS
523 	 */
524 	int fixed_freq;
525 
526 #ifdef CONFIG_ACS
527 	/**
528 	 * ACS - Automatic Channel Selection for AP mode
529 	 *
530 	 * If present, it will be handled together with frequency.
531 	 * frequency will be used to determine hardware mode only, when it is
532 	 * used for both hardware mode and channel when used alone. This will
533 	 * force the channel to be set to 0, thus enabling ACS.
534 	 */
535 	int acs;
536 #endif /* CONFIG_ACS */
537 
538 	/**
539 	 * mesh_basic_rates - BSS Basic rate set for mesh network
540 	 *
541 	 */
542 	int *mesh_basic_rates;
543 
544 	/**
545 	 * Mesh network plink parameters
546 	 */
547 	int dot11MeshMaxRetries;
548 	int dot11MeshRetryTimeout; /* msec */
549 	int dot11MeshConfirmTimeout; /* msec */
550 	int dot11MeshHoldingTimeout; /* msec */
551 
552 	int ht;
553 	int ht40;
554 
555 	int vht;
556 
557 	int he;
558 
559 	int max_oper_chwidth;
560 
561 	unsigned int vht_center_freq1;
562 	unsigned int vht_center_freq2;
563 
564 	/**
565 	 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
566 	 *
567 	 * This value can be used to enforce rekeying of PTK to mitigate some
568 	 * attacks against TKIP deficiencies.
569 	 */
570 	int wpa_ptk_rekey;
571 
572 	/** wpa_deny_ptk0_rekey - Control PTK0 rekeying
573 	 *
574 	 * Rekeying a pairwise key using only keyid 0 (PTK0 rekey) has many
575 	 * broken implementations and should be avoided when using or
576 	 * interacting with one.
577 	 *
578 	 * 0 = always rekey when configured/instructed
579 	 * 1 = only rekey when the local driver is explicitly indicating it can
580 	 *	perform this operation without issues
581 	 * 2 = never allow PTK0 rekeys
582 	 */
583 	enum ptk0_rekey_handling wpa_deny_ptk0_rekey;
584 
585 	/**
586 	 * group_rekey - Group rekeying time in seconds
587 	 *
588 	 * This value, if non-zero, is used as the dot11RSNAConfigGroupRekeyTime
589 	 * parameter when operating in Authenticator role in IBSS.
590 	 */
591 	int group_rekey;
592 
593 	/**
594 	 * scan_freq - Array of frequencies to scan or %NULL for all
595 	 *
596 	 * This is an optional zero-terminated array of frequencies in
597 	 * megahertz (MHz) to include in scan requests when searching for this
598 	 * network. This can be used to speed up scanning when the network is
599 	 * known to not use all possible channels.
600 	 */
601 	int *scan_freq;
602 
603 	/**
604 	 * bgscan - Background scan and roaming parameters or %NULL if none
605 	 *
606 	 * This is an optional set of parameters for background scanning and
607 	 * roaming within a network (ESS) in following format:
608 	 * <bgscan module name>:<module parameters>
609 	 */
610 	char *bgscan;
611 
612 	/**
613 	 * ignore_broadcast_ssid - Hide SSID in AP mode
614 	 *
615 	 * Send empty SSID in beacons and ignore probe request frames that do
616 	 * not specify full SSID, i.e., require stations to know SSID.
617 	 * default: disabled (0)
618 	 * 1 = send empty (length=0) SSID in beacon and ignore probe request
619 	 * for broadcast SSID
620 	 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
621 	 * required with some clients that do not support empty SSID) and
622 	 * ignore probe requests for broadcast SSID
623 	 */
624 	int ignore_broadcast_ssid;
625 
626 	/**
627 	 * freq_list - Array of allowed frequencies or %NULL for all
628 	 *
629 	 * This is an optional zero-terminated array of frequencies in
630 	 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
631 	 * that do not match any of the specified frequencies are not
632 	 * considered when selecting a BSS.
633 	 */
634 	int *freq_list;
635 
636 	/**
637 	 * p2p_client_list - List of P2P Clients in a persistent group (GO)
638 	 *
639 	 * This is a list of P2P Clients (P2P Device Address) that have joined
640 	 * the persistent group. This is maintained on the GO for persistent
641 	 * group entries (disabled == 2).
642 	 */
643 	u8 *p2p_client_list;
644 
645 	/**
646 	 * num_p2p_clients - Number of entries in p2p_client_list
647 	 */
648 	size_t num_p2p_clients;
649 
650 #ifndef P2P_MAX_STORED_CLIENTS
651 #define P2P_MAX_STORED_CLIENTS 100
652 #endif /* P2P_MAX_STORED_CLIENTS */
653 
654 	/**
655 	 * psk_list - Per-client PSKs (struct psk_list_entry)
656 	 */
657 	struct dl_list psk_list;
658 
659 	/**
660 	 * p2p_group - Network generated as a P2P group (used internally)
661 	 */
662 	int p2p_group;
663 
664 	/**
665 	 * p2p_persistent_group - Whether this is a persistent group
666 	 */
667 	int p2p_persistent_group;
668 
669 	/**
670 	 * temporary - Whether this network is temporary and not to be saved
671 	 */
672 	int temporary;
673 
674 	/**
675 	 * export_keys - Whether keys may be exported
676 	 *
677 	 * This attribute will be set when keys are determined through
678 	 * WPS or similar so that they may be exported.
679 	 */
680 	int export_keys;
681 
682 #ifdef CONFIG_HT_OVERRIDES
683 	/**
684 	 * disable_ht - Disable HT (IEEE 802.11n) for this network
685 	 *
686 	 * By default, use it if it is available, but this can be configured
687 	 * to 1 to have it disabled.
688 	 */
689 	int disable_ht;
690 
691 	/**
692 	 * disable_ht40 - Disable HT40 for this network
693 	 *
694 	 * By default, use it if it is available, but this can be configured
695 	 * to 1 to have it disabled.
696 	 */
697 	int disable_ht40;
698 
699 	/**
700 	 * disable_sgi - Disable SGI (Short Guard Interval) for this network
701 	 *
702 	 * By default, use it if it is available, but this can be configured
703 	 * to 1 to have it disabled.
704 	 */
705 	int disable_sgi;
706 
707 	/**
708 	 * disable_ldpc - Disable LDPC for this network
709 	 *
710 	 * By default, use it if it is available, but this can be configured
711 	 * to 1 to have it disabled.
712 	 */
713 	int disable_ldpc;
714 
715 	/**
716 	 * ht40_intolerant - Indicate 40 MHz intolerant for this network
717 	 */
718 	int ht40_intolerant;
719 
720 	/**
721 	 * disable_max_amsdu - Disable MAX A-MSDU
722 	 *
723 	 * A-MDSU will be 3839 bytes when disabled, or 7935
724 	 * when enabled (assuming it is otherwise supported)
725 	 * -1 (default) means do not apply any settings to the kernel.
726 	 */
727 	int disable_max_amsdu;
728 
729 	/**
730 	 * ampdu_factor - Maximum A-MPDU Length Exponent
731 	 *
732 	 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
733 	 */
734 	int ampdu_factor;
735 
736 	/**
737 	 * ampdu_density - Minimum A-MPDU Start Spacing
738 	 *
739 	 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
740 	 */
741 	int ampdu_density;
742 
743 	/**
744 	 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
745 	 *
746 	 * By default (empty string): Use whatever the OS has configured.
747 	 */
748 	char *ht_mcs;
749 
750 	/**
751 	 * tx_stbc - Indicate STBC support for TX streams
752 	 *
753 	 * Value: -1..1, by default (-1): use whatever the OS or card has
754 	 * configured. See IEEE Std 802.11-2016, 9.4.2.56.2.
755 	 */
756 	int tx_stbc;
757 
758 	/**
759 	 * rx_stbc - Indicate STBC support for RX streams
760 	 *
761 	 * Value: -1..3, by default (-1): use whatever the OS or card has
762 	 * configured. See IEEE Std 802.11-2016, 9.4.2.56.2.
763 	 */
764 	int rx_stbc;
765 #endif /* CONFIG_HT_OVERRIDES */
766 
767 #ifdef CONFIG_VHT_OVERRIDES
768 	/**
769 	 * disable_vht - Disable VHT (IEEE 802.11ac) for this network
770 	 *
771 	 * By default, use it if it is available, but this can be configured
772 	 * to 1 to have it disabled.
773 	 */
774 	int disable_vht;
775 
776 	/**
777 	 * vht_capa - VHT capabilities to use
778 	 */
779 	unsigned int vht_capa;
780 
781 	/**
782 	 * vht_capa_mask - mask for VHT capabilities
783 	 */
784 	unsigned int vht_capa_mask;
785 
786 	int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
787 	    vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
788 	    vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
789 	    vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
790 	int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
791 	    vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
792 	    vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
793 	    vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
794 #endif /* CONFIG_VHT_OVERRIDES */
795 
796 #ifdef CONFIG_HE_OVERRIDES
797 	/**
798 	 * disable_he - Disable HE (IEEE 802.11ax) for this network
799 	 *
800 	 * By default, use it if it is available, but this can be configured
801 	 * to 1 to have it disabled.
802 	 */
803 	int disable_he;
804 #endif /* CONFIG_HE_OVERRIDES */
805 
806 	/**
807 	 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
808 	 *
809 	 * This timeout value is used in AP mode to clean up inactive stations.
810 	 * By default: 300 seconds.
811 	 */
812 	int ap_max_inactivity;
813 
814 	/**
815 	 * dtim_period - DTIM period in Beacon intervals
816 	 * By default: 2
817 	 */
818 	int dtim_period;
819 
820 	/**
821 	 * beacon_int - Beacon interval (default: 100 TU)
822 	 */
823 	int beacon_int;
824 
825 	/**
826 	 * auth_failures - Number of consecutive authentication failures
827 	 */
828 	unsigned int auth_failures;
829 
830 	/**
831 	 * disabled_until - Network block disabled until this time if non-zero
832 	 */
833 	struct os_reltime disabled_until;
834 
835 	/**
836 	 * parent_cred - Pointer to parent wpa_cred entry
837 	 *
838 	 * This pointer can be used to delete temporary networks when a wpa_cred
839 	 * that was used to create them is removed. This pointer should not be
840 	 * dereferences since it may not be updated in all cases.
841 	 */
842 	void *parent_cred;
843 
844 #ifdef CONFIG_MACSEC
845 	/**
846 	 * macsec_policy - Determines the policy for MACsec secure session
847 	 *
848 	 * 0: MACsec not in use (default)
849 	 * 1: MACsec enabled - Should secure, accept key server's advice to
850 	 *    determine whether to use a secure session or not.
851 	 */
852 	int macsec_policy;
853 
854 	/**
855 	 * macsec_integ_only - Determines how MACsec are transmitted
856 	 *
857 	 * This setting applies only when MACsec is in use, i.e.,
858 	 *  - macsec_policy is enabled
859 	 *  - the key server has decided to enable MACsec
860 	 *
861 	 * 0: Encrypt traffic (default)
862 	 * 1: Integrity only
863 	 */
864 	int macsec_integ_only;
865 
866 	/**
867 	 * macsec_replay_protect - Enable MACsec replay protection
868 	 *
869 	 * This setting applies only when MACsec is in use, i.e.,
870 	 *  - macsec_policy is enabled
871 	 *  - the key server has decided to enable MACsec
872 	 *
873 	 * 0: Replay protection disabled (default)
874 	 * 1: Replay protection enabled
875 	 */
876 	int macsec_replay_protect;
877 
878 	/**
879 	 * macsec_replay_window - MACsec replay protection window
880 	 *
881 	 * A window in which replay is tolerated, to allow receipt of frames
882 	 * that have been misordered by the network.
883 	 *
884 	 * This setting applies only when MACsec replay protection active, i.e.,
885 	 *  - macsec_replay_protect is enabled
886 	 *  - the key server has decided to enable MACsec
887 	 *
888 	 * 0: No replay window, strict check (default)
889 	 * 1..2^32-1: number of packets that could be misordered
890 	 */
891 	u32 macsec_replay_window;
892 
893 	/**
894 	 * macsec_port - MACsec port (in SCI)
895 	 *
896 	 * Port component of the SCI.
897 	 *
898 	 * Range: 1-65534 (default: 1)
899 	 */
900 	int macsec_port;
901 
902 	/**
903 	 * mka_priority - Priority of MKA Actor
904 	 *
905 	 * Range: 0-255 (default: 255)
906 	 */
907 	int mka_priority;
908 
909 	/**
910 	 * mka_ckn - MKA pre-shared CKN
911 	 */
912 #define MACSEC_CKN_MAX_LEN 32
913 	size_t mka_ckn_len;
914 	u8 mka_ckn[MACSEC_CKN_MAX_LEN];
915 
916 	/**
917 	 * mka_cak - MKA pre-shared CAK
918 	 */
919 #define MACSEC_CAK_MAX_LEN 32
920 	size_t mka_cak_len;
921 	u8 mka_cak[MACSEC_CAK_MAX_LEN];
922 
923 #define MKA_PSK_SET_CKN BIT(0)
924 #define MKA_PSK_SET_CAK BIT(1)
925 #define MKA_PSK_SET (MKA_PSK_SET_CKN | MKA_PSK_SET_CAK)
926 	/**
927 	 * mka_psk_set - Whether mka_ckn and mka_cak are set
928 	 */
929 	u8 mka_psk_set;
930 #endif /* CONFIG_MACSEC */
931 
932 #ifdef CONFIG_HS20
933 	int update_identifier;
934 
935 	/**
936 	 * roaming_consortium_selection - Roaming Consortium Selection
937 	 *
938 	 * The matching Roaming Consortium OI that was used to generate this
939 	 * network profile.
940 	 */
941 	u8 *roaming_consortium_selection;
942 
943 	/**
944 	 * roaming_consortium_selection_len - roaming_consortium_selection len
945 	 */
946 	size_t roaming_consortium_selection_len;
947 #endif /* CONFIG_HS20 */
948 
949 	unsigned int wps_run;
950 
951 	/**
952 	 * mac_addr - MAC address policy
953 	 *
954 	 * 0 = use permanent MAC address
955 	 * 1 = use random MAC address for each ESS connection
956 	 * 2 = like 1, but maintain OUI (with local admin bit set)
957 	 *
958 	 * Internally, special value -1 is used to indicate that the parameter
959 	 * was not specified in the configuration (i.e., default behavior is
960 	 * followed).
961 	 */
962 	int mac_addr;
963 
964 	/**
965 	 * no_auto_peer - Do not automatically peer with compatible mesh peers
966 	 *
967 	 * When unset, the reception of a beacon from a another mesh peer in
968 	 * this MBSS will trigger a peering attempt.
969 	 */
970 	int no_auto_peer;
971 
972 	/**
973 	 * mesh_rssi_threshold - Set mesh parameter mesh_rssi_threshold (dBm)
974 	 *
975 	 * -255..-1 = threshold value in dBm
976 	 * 0 = not using RSSI threshold
977 	 * 1 = do not change driver default
978 	 */
979 	int mesh_rssi_threshold;
980 
981 	/**
982 	 * wps_disabled - WPS disabled in AP mode
983 	 *
984 	 * 0 = WPS enabled and configured (default)
985 	 * 1 = WPS disabled
986 	 */
987 	int wps_disabled;
988 
989 	/**
990 	 * fils_dh_group - FILS DH Group
991 	 *
992 	 * 0 = PFS disabled with FILS shared key authentication
993 	 * 1-65535 DH Group to use for FILS PFS
994 	 */
995 	int fils_dh_group;
996 
997 	/**
998 	 * dpp_connector - DPP Connector (signedConnector as string)
999 	 */
1000 	char *dpp_connector;
1001 
1002 	/**
1003 	 * dpp_netaccesskey - DPP netAccessKey (own private key)
1004 	 */
1005 	u8 *dpp_netaccesskey;
1006 
1007 	/**
1008 	 * dpp_netaccesskey_len - DPP netAccessKey length in octets
1009 	 */
1010 	size_t dpp_netaccesskey_len;
1011 
1012 	/**
1013 	 * net_access_key_expiry - DPP netAccessKey expiry in UNIX time stamp
1014 	 *
1015 	 * 0 indicates no expiration.
1016 	 */
1017 	unsigned int dpp_netaccesskey_expiry;
1018 
1019 	/**
1020 	 * dpp_csign - C-sign-key (Configurator public key)
1021 	 */
1022 	u8 *dpp_csign;
1023 
1024 	/**
1025 	 * dpp_csign_len - C-sign-key length in octets
1026 	 */
1027 	size_t dpp_csign_len;
1028 
1029 	/**
1030 	 * dpp_pp_key - ppKey (Configurator privacy protection public key)
1031 	 */
1032 	u8 *dpp_pp_key;
1033 
1034 	/**
1035 	 * dpp_pp_key_len - ppKey length in octets
1036 	 */
1037 	size_t dpp_pp_key_len;
1038 
1039 	/**
1040 	 * dpp_pfs - DPP PFS
1041 	 * 0: allow PFS to be used or not used
1042 	 * 1: require PFS to be used (note: not compatible with DPP R1)
1043 	 * 2: do not allow PFS to be used
1044 	 */
1045 	int dpp_pfs;
1046 
1047 	/**
1048 	 * dpp_pfs_fallback - DPP PFS fallback selection
1049 	 *
1050 	 * This is an internally used variable (i.e., not used in external
1051 	 * configuration) to track state of the DPP PFS fallback mechanism.
1052 	 */
1053 	int dpp_pfs_fallback;
1054 
1055 	/**
1056 	 * owe_group - OWE DH Group
1057 	 *
1058 	 * 0 = use default (19) first and then try all supported groups one by
1059 	 *	one if AP rejects the selected group
1060 	 * 1-65535 DH Group to use for OWE
1061 	 *
1062 	 * Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
1063 	 * currently supported.
1064 	 */
1065 	int owe_group;
1066 
1067 	/**
1068 	 * owe_only - OWE-only mode (disable transition mode)
1069 	 *
1070 	 * 0 = enable transition mode (allow connection to either OWE or open
1071 	 *	BSS)
1072 	 * 1 = disable transition mode (allow connection only with OWE)
1073 	 */
1074 	int owe_only;
1075 
1076 	/**
1077 	 * owe_ptk_workaround - OWE PTK derivation workaround
1078 	 *
1079 	 * Initial OWE implementation used SHA256 when deriving the PTK for all
1080 	 * OWE groups. This was supposed to change to SHA384 for group 20 and
1081 	 * SHA512 for group 21. This parameter can be used to enable older
1082 	 * behavior mainly for testing purposes. There is no impact to group 19
1083 	 * behavior, but if enabled, this will make group 20 and 21 cases use
1084 	 * SHA256-based PTK derivation which will not work with the updated
1085 	 * OWE implementation on the AP side.
1086 	 */
1087 	int owe_ptk_workaround;
1088 
1089 	/**
1090 	 * owe_transition_bss_select_count - OWE transition BSS select count
1091 	 *
1092 	 * This is an internally used variable (i.e., not used in external
1093 	 * configuration) to track the number of selection attempts done for
1094 	 * OWE BSS in transition mode. This allows fallback to an open BSS if
1095 	 * the selection attempts for OWE BSS exceed the configured threshold.
1096 	 */
1097 	int owe_transition_bss_select_count;
1098 
1099 	/**
1100 	 * multi_ap_backhaul_sta - Multi-AP backhaul STA
1101 	 * 0 = normal (non-Multi-AP) station
1102 	 * 1 = Multi-AP backhaul station
1103 	 */
1104 	int multi_ap_backhaul_sta;
1105 
1106 	/**
1107 	 * ft_eap_pmksa_caching - Whether FT-EAP PMKSA caching is allowed
1108 	 * 0 = do not try to use PMKSA caching with FT-EAP
1109 	 * 1 = try to use PMKSA caching with FT-EAP
1110 	 *
1111 	 * This controls whether to try to use PMKSA caching with FT-EAP for the
1112 	 * FT initial mobility domain association.
1113 	 */
1114 	int ft_eap_pmksa_caching;
1115 
1116 	/**
1117 	 * beacon_prot - Whether Beacon protection is enabled
1118 	 *
1119 	 * This depends on management frame protection (ieee80211w) being
1120 	 * enabled.
1121 	 */
1122 	int beacon_prot;
1123 
1124 	/**
1125 	 * transition_disable - Transition Disable indication
1126 	 * The AP can notify authenticated stations to disable transition mode
1127 	 * in their network profiles when the network has completed transition
1128 	 * steps, i.e., once sufficiently large number of APs in the ESS have
1129 	 * been updated to support the more secure alternative. When this
1130 	 * indication is used, the stations are expected to automatically
1131 	 * disable transition mode and less secure security options. This
1132 	 * includes use of WEP, TKIP (including use of TKIP as the group
1133 	 * cipher), and connections without PMF.
1134 	 * Bitmap bits:
1135 	 * bit 0 (0x01): WPA3-Personal (i.e., disable WPA2-Personal = WPA-PSK
1136 	 *	and only allow SAE to be used)
1137 	 * bit 1 (0x02): SAE-PK (disable SAE without use of SAE-PK)
1138 	 * bit 2 (0x04): WPA3-Enterprise (move to requiring PMF)
1139 	 * bit 3 (0x08): Enhanced Open (disable use of open network; require
1140 	 *	OWE)
1141 	 */
1142 	u8 transition_disable;
1143 
1144 	/**
1145 	 * sae_pk - SAE-PK mode
1146 	 * 0 = automatic SAE/SAE-PK selection based on password; enable
1147 	 * transition mode (allow SAE authentication without SAE-PK)
1148 	 * 1 = SAE-PK only (disable transition mode; allow SAE authentication
1149 	 * only with SAE-PK)
1150 	 * 2 = disable SAE-PK (allow SAE authentication only without SAE-PK)
1151 	 */
1152 	enum sae_pk_mode sae_pk;
1153 
1154 	/**
1155 	 * was_recently_reconfigured - Whether this SSID config has been changed
1156 	 * recently
1157 	 *
1158 	 * This is an internally used variable, i.e., not used in external
1159 	 * configuration.
1160 	 */
1161 	bool was_recently_reconfigured;
1162 
1163 	/**
1164 	 * sae_pwe - SAE mechanism for PWE derivation
1165 	 *
1166 	 * Internally, special value 4 (DEFAULT_SAE_PWE) is used to indicate
1167 	 * that the parameter is not set and the global sae_pwe value needs to
1168 	 * be considered.
1169 	 *
1170 	 * 0 = hunting-and-pecking loop only
1171 	 * 1 = hash-to-element only
1172 	 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1173 	 */
1174 	int sae_pwe;
1175 };
1176 
1177 #endif /* CONFIG_SSID_H */
1178