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