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