xref: /freebsd/contrib/wpa/src/ap/sta_info.h (revision 580744621f33383027108364dcadad718df46ffe)
1 /*
2  * hostapd / Station table
3  * Copyright (c) 2002-2017, 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 STA_INFO_H
10 #define STA_INFO_H
11 
12 #include "common/defs.h"
13 #include "list.h"
14 #include "vlan.h"
15 #include "common/wpa_common.h"
16 #include "common/ieee802_11_defs.h"
17 
18 /* STA flags */
19 #define WLAN_STA_AUTH BIT(0)
20 #define WLAN_STA_ASSOC BIT(1)
21 #define WLAN_STA_AUTHORIZED BIT(5)
22 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
23 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
24 #define WLAN_STA_PREAUTH BIT(8)
25 #define WLAN_STA_WMM BIT(9)
26 #define WLAN_STA_MFP BIT(10)
27 #define WLAN_STA_HT BIT(11)
28 #define WLAN_STA_WPS BIT(12)
29 #define WLAN_STA_MAYBE_WPS BIT(13)
30 #define WLAN_STA_WDS BIT(14)
31 #define WLAN_STA_ASSOC_REQ_OK BIT(15)
32 #define WLAN_STA_WPS2 BIT(16)
33 #define WLAN_STA_GAS BIT(17)
34 #define WLAN_STA_VHT BIT(18)
35 #define WLAN_STA_WNM_SLEEP_MODE BIT(19)
36 #define WLAN_STA_VHT_OPMODE_ENABLED BIT(20)
37 #define WLAN_STA_VENDOR_VHT BIT(21)
38 #define WLAN_STA_PENDING_FILS_ERP BIT(22)
39 #define WLAN_STA_MULTI_AP BIT(23)
40 #define WLAN_STA_HE BIT(24)
41 #define WLAN_STA_PENDING_DISASSOC_CB BIT(29)
42 #define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
43 #define WLAN_STA_NONERP BIT(31)
44 
45 /* Maximum number of supported rates (from both Supported Rates and Extended
46  * Supported Rates IEs). */
47 #define WLAN_SUPP_RATES_MAX 32
48 
49 struct hostapd_data;
50 
51 struct mbo_non_pref_chan_info {
52 	struct mbo_non_pref_chan_info *next;
53 	u8 op_class;
54 	u8 pref;
55 	u8 reason_code;
56 	u8 num_channels;
57 	u8 channels[];
58 };
59 
60 struct pending_eapol_rx {
61 	struct wpabuf *buf;
62 	struct os_reltime rx_time;
63 };
64 
65 struct sta_info {
66 	struct sta_info *next; /* next entry in sta list */
67 	struct sta_info *hnext; /* next entry in hash table list */
68 	u8 addr[6];
69 	be32 ipaddr;
70 	struct dl_list ip6addr; /* list head for struct ip6addr */
71 	u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
72 	u16 disconnect_reason_code; /* RADIUS server override */
73 	u32 flags; /* Bitfield of WLAN_STA_* */
74 	u16 capability;
75 	u16 listen_interval; /* or beacon_int for APs */
76 	u8 supported_rates[WLAN_SUPP_RATES_MAX];
77 	int supported_rates_len;
78 	u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
79 
80 #ifdef CONFIG_MESH
81 	enum mesh_plink_state plink_state;
82 	u16 peer_lid;
83 	u16 my_lid;
84 	u16 peer_aid;
85 	u16 mpm_close_reason;
86 	int mpm_retries;
87 	u8 my_nonce[WPA_NONCE_LEN];
88 	u8 peer_nonce[WPA_NONCE_LEN];
89 	u8 aek[32];	/* SHA256 digest length */
90 	u8 mtk[WPA_TK_MAX_LEN];
91 	size_t mtk_len;
92 	u8 mgtk_rsc[6];
93 	u8 mgtk_key_id;
94 	u8 mgtk[WPA_TK_MAX_LEN];
95 	size_t mgtk_len;
96 	u8 igtk_rsc[6];
97 	u8 igtk[WPA_TK_MAX_LEN];
98 	size_t igtk_len;
99 	u16 igtk_key_id;
100 	u8 sae_auth_retry;
101 #endif /* CONFIG_MESH */
102 
103 	unsigned int nonerp_set:1;
104 	unsigned int no_short_slot_time_set:1;
105 	unsigned int no_short_preamble_set:1;
106 	unsigned int no_ht_gf_set:1;
107 	unsigned int no_ht_set:1;
108 	unsigned int ht40_intolerant_set:1;
109 	unsigned int ht_20mhz_set:1;
110 	unsigned int no_p2p_set:1;
111 	unsigned int qos_map_enabled:1;
112 	unsigned int remediation:1;
113 	unsigned int hs20_deauth_requested:1;
114 	unsigned int session_timeout_set:1;
115 	unsigned int radius_das_match:1;
116 	unsigned int ecsa_supported:1;
117 	unsigned int added_unassoc:1;
118 	unsigned int pending_wds_enable:1;
119 	unsigned int power_capab:1;
120 	unsigned int agreed_to_steer:1;
121 	unsigned int hs20_t_c_filtering:1;
122 	unsigned int ft_over_ds:1;
123 	unsigned int external_dh_updated:1;
124 
125 	u16 auth_alg;
126 
127 	enum {
128 		STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
129 		STA_DISASSOC_FROM_CLI
130 	} timeout_next;
131 
132 	u16 deauth_reason;
133 	u16 disassoc_reason;
134 
135 	/* IEEE 802.1X related data */
136 	struct eapol_state_machine *eapol_sm;
137 
138 	struct pending_eapol_rx *pending_eapol_rx;
139 
140 	u64 acct_session_id;
141 	struct os_reltime acct_session_start;
142 	int acct_session_started;
143 	int acct_terminate_cause; /* Acct-Terminate-Cause */
144 	int acct_interim_interval; /* Acct-Interim-Interval */
145 	unsigned int acct_interim_errors;
146 
147 	/* For extending 32-bit driver counters to 64-bit counters */
148 	u32 last_rx_bytes_hi;
149 	u32 last_rx_bytes_lo;
150 	u32 last_tx_bytes_hi;
151 	u32 last_tx_bytes_lo;
152 
153 	u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
154 
155 	struct wpa_state_machine *wpa_sm;
156 	struct rsn_preauth_interface *preauth_iface;
157 
158 	int vlan_id; /* 0: none, >0: VID */
159 	struct vlan_description *vlan_desc;
160 	int vlan_id_bound; /* updated by ap_sta_bind_vlan() */
161 	 /* PSKs from RADIUS authentication server */
162 	struct hostapd_sta_wpa_psk_short *psk;
163 
164 	char *identity; /* User-Name from RADIUS */
165 	char *radius_cui; /* Chargeable-User-Identity from RADIUS */
166 
167 	struct ieee80211_ht_capabilities *ht_capabilities;
168 	struct ieee80211_vht_capabilities *vht_capabilities;
169 	struct ieee80211_vht_operation *vht_operation;
170 	u8 vht_opmode;
171 	struct ieee80211_he_capabilities *he_capab;
172 	size_t he_capab_len;
173 
174 #ifdef CONFIG_IEEE80211W
175 	int sa_query_count; /* number of pending SA Query requests;
176 			     * 0 = no SA Query in progress */
177 	int sa_query_timed_out;
178 	u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
179 				* sa_query_count octets of pending SA Query
180 				* transaction identifiers */
181 	struct os_reltime sa_query_start;
182 #endif /* CONFIG_IEEE80211W */
183 
184 #if defined(CONFIG_INTERWORKING) || defined(CONFIG_DPP)
185 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
186 	struct gas_dialog_info *gas_dialog;
187 	u8 gas_dialog_next;
188 #endif /* CONFIG_INTERWORKING || CONFIG_DPP */
189 
190 	struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
191 	struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
192 	struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
193 	/* Hotspot 2.0 Roaming Consortium from (Re)Association Request */
194 	struct wpabuf *roaming_consortium;
195 	u8 remediation_method;
196 	char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
197 	char *t_c_url; /* HS 2.0 Terms and Conditions Server URL */
198 	struct wpabuf *hs20_deauth_req;
199 	char *hs20_session_info_url;
200 	int hs20_disassoc_timer;
201 #ifdef CONFIG_FST
202 	struct wpabuf *mb_ies; /* MB IEs from (Re)Association Request */
203 #endif /* CONFIG_FST */
204 
205 	struct os_reltime connected_time;
206 
207 #ifdef CONFIG_SAE
208 	struct sae_data *sae;
209 	unsigned int mesh_sae_pmksa_caching:1;
210 #endif /* CONFIG_SAE */
211 
212 	/* valid only if session_timeout_set == 1 */
213 	struct os_reltime session_timeout;
214 
215 	/* Last Authentication/(Re)Association Request/Action frame sequence
216 	 * control */
217 	u16 last_seq_ctrl;
218 	/* Last Authentication/(Re)Association Request/Action frame subtype */
219 	u8 last_subtype;
220 
221 #ifdef CONFIG_MBO
222 	u8 cell_capa; /* 0 = unknown (not an MBO STA); otherwise,
223 		       * enum mbo_cellular_capa values */
224 	struct mbo_non_pref_chan_info *non_pref_chan;
225 	int auth_rssi; /* Last Authentication frame RSSI */
226 #endif /* CONFIG_MBO */
227 
228 	u8 *supp_op_classes; /* Supported Operating Classes element, if
229 			      * received, starting from the Length field */
230 
231 	u8 rrm_enabled_capa[5];
232 
233 	s8 min_tx_power;
234 	s8 max_tx_power;
235 
236 #ifdef CONFIG_TAXONOMY
237 	struct wpabuf *probe_ie_taxonomy;
238 	struct wpabuf *assoc_ie_taxonomy;
239 #endif /* CONFIG_TAXONOMY */
240 
241 #ifdef CONFIG_FILS
242 	u8 fils_snonce[FILS_NONCE_LEN];
243 	u8 fils_session[FILS_SESSION_LEN];
244 	u8 fils_erp_pmkid[PMKID_LEN];
245 	u8 *fils_pending_assoc_req;
246 	size_t fils_pending_assoc_req_len;
247 	unsigned int fils_pending_assoc_is_reassoc:1;
248 	unsigned int fils_dhcp_rapid_commit_proxy:1;
249 	unsigned int fils_erp_pmkid_set:1;
250 	unsigned int fils_drv_assoc_finish:1;
251 	struct wpabuf *fils_hlp_resp;
252 	struct wpabuf *hlp_dhcp_discover;
253 	void (*fils_pending_cb)(struct hostapd_data *hapd, struct sta_info *sta,
254 				u16 resp, struct wpabuf *data, int pub);
255 #ifdef CONFIG_FILS_SK_PFS
256 	struct crypto_ecdh *fils_ecdh;
257 #endif /* CONFIG_FILS_SK_PFS */
258 	struct wpabuf *fils_dh_ss;
259 	struct wpabuf *fils_g_sta;
260 #endif /* CONFIG_FILS */
261 
262 #ifdef CONFIG_OWE
263 	u8 *owe_pmk;
264 	size_t owe_pmk_len;
265 	struct crypto_ecdh *owe_ecdh;
266 	u16 owe_group;
267 #endif /* CONFIG_OWE */
268 
269 	u8 *ext_capability;
270 	char *ifname_wds; /* WDS ifname, if in use */
271 
272 #ifdef CONFIG_DPP2
273 	struct dpp_pfs *dpp_pfs;
274 #endif /* CONFIG_DPP2 */
275 
276 #ifdef CONFIG_TESTING_OPTIONS
277 	enum wpa_alg last_tk_alg;
278 	int last_tk_key_idx;
279 	u8 last_tk[WPA_TK_MAX_LEN];
280 	size_t last_tk_len;
281 #endif /* CONFIG_TESTING_OPTIONS */
282 #ifdef CONFIG_AIRTIME_POLICY
283 	unsigned int airtime_weight;
284 	struct os_reltime backlogged_until;
285 #endif /* CONFIG_AIRTIME_POLICY */
286 };
287 
288 
289 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
290  * passed since last received frame from the station, a nullfunc data frame is
291  * sent to the station. If this frame is not acknowledged and no other frames
292  * have been received, the station will be disassociated after
293  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
294  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
295 #define AP_MAX_INACTIVITY (5 * 60)
296 #define AP_DISASSOC_DELAY (3)
297 #define AP_DEAUTH_DELAY (1)
298 /* Number of seconds to keep STA entry with Authenticated flag after it has
299  * been disassociated. */
300 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
301 /* Number of seconds to keep STA entry after it has been deauthenticated. */
302 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
303 
304 
305 int ap_for_each_sta(struct hostapd_data *hapd,
306 		    int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
307 			      void *ctx),
308 		    void *ctx);
309 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
310 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
311 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
312 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
313 void ap_sta_ip6addr_del(struct hostapd_data *hapd, struct sta_info *sta);
314 void hostapd_free_stas(struct hostapd_data *hapd);
315 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
316 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
317 			      u32 session_timeout);
318 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
319 			    u32 session_timeout);
320 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
321 			       struct sta_info *sta);
322 void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
323 				    struct sta_info *sta, int warning_time);
324 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
325 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
326 			 u16 reason);
327 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
328 			   u16 reason);
329 #ifdef CONFIG_WPS
330 int ap_sta_wps_cancel(struct hostapd_data *hapd,
331 		      struct sta_info *sta, void *ctx);
332 #endif /* CONFIG_WPS */
333 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta);
334 int ap_sta_set_vlan(struct hostapd_data *hapd, struct sta_info *sta,
335 		    struct vlan_description *vlan_desc);
336 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
337 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
338 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
339 const char * ap_sta_wpa_get_keyid(struct hostapd_data *hapd,
340 				  struct sta_info *sta);
341 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
342 		       const u8 *addr, u16 reason);
343 
344 void ap_sta_set_authorized(struct hostapd_data *hapd,
345 			   struct sta_info *sta, int authorized);
346 static inline int ap_sta_is_authorized(struct sta_info *sta)
347 {
348 	return sta->flags & WLAN_STA_AUTHORIZED;
349 }
350 
351 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
352 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
353 void ap_sta_clear_disconnect_timeouts(struct hostapd_data *hapd,
354 				      struct sta_info *sta);
355 
356 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
357 void ap_sta_delayed_1x_auth_fail_disconnect(struct hostapd_data *hapd,
358 					    struct sta_info *sta);
359 int ap_sta_pending_delayed_1x_auth_fail_disconnect(struct hostapd_data *hapd,
360 						   struct sta_info *sta);
361 
362 #endif /* STA_INFO_H */
363