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