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