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