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