xref: /freebsd/contrib/wpa/src/ap/sta_info.h (revision e4c66ddabdb470bab319705c1834a4867c508a43)
1 /*
2  * hostapd / Station table
3  * Copyright (c) 2002-2011, 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 #ifdef CONFIG_MESH
13 /* needed for mesh_plink_state enum */
14 #include "common/defs.h"
15 #include "common/wpa_common.h"
16 #endif /* CONFIG_MESH */
17 
18 #include "list.h"
19 #include "vlan.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_DISASSOC_CB BIT(29)
42 #define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
43 #define WLAN_STA_NONERP BIT(31)
44 
45 /* Maximum number of supported rates (from both Supported Rates and Extended
46  * Supported Rates IEs). */
47 #define WLAN_SUPP_RATES_MAX 32
48 
49 
50 struct mbo_non_pref_chan_info {
51 	struct mbo_non_pref_chan_info *next;
52 	u8 op_class;
53 	u8 pref;
54 	u8 reason_code;
55 	u8 num_channels;
56 	u8 channels[];
57 };
58 
59 struct pending_eapol_rx {
60 	struct wpabuf *buf;
61 	struct os_reltime rx_time;
62 };
63 
64 struct sta_info {
65 	struct sta_info *next; /* next entry in sta list */
66 	struct sta_info *hnext; /* next entry in hash table list */
67 	u8 addr[6];
68 	be32 ipaddr;
69 	struct dl_list ip6addr; /* list head for struct ip6addr */
70 	u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
71 	u32 flags; /* Bitfield of WLAN_STA_* */
72 	u16 capability;
73 	u16 listen_interval; /* or beacon_int for APs */
74 	u8 supported_rates[WLAN_SUPP_RATES_MAX];
75 	int supported_rates_len;
76 	u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
77 
78 #ifdef CONFIG_MESH
79 	enum mesh_plink_state plink_state;
80 	u16 peer_lid;
81 	u16 my_lid;
82 	u16 peer_aid;
83 	u16 mpm_close_reason;
84 	int mpm_retries;
85 	u8 my_nonce[WPA_NONCE_LEN];
86 	u8 peer_nonce[WPA_NONCE_LEN];
87 	u8 aek[32];	/* SHA256 digest length */
88 	u8 mtk[WPA_TK_MAX_LEN];
89 	size_t mtk_len;
90 	u8 mgtk_rsc[6];
91 	u8 mgtk_key_id;
92 	u8 mgtk[WPA_TK_MAX_LEN];
93 	size_t mgtk_len;
94 	u8 igtk_rsc[6];
95 	u8 igtk[WPA_TK_MAX_LEN];
96 	size_t igtk_len;
97 	u16 igtk_key_id;
98 	u8 sae_auth_retry;
99 #endif /* CONFIG_MESH */
100 
101 	unsigned int nonerp_set:1;
102 	unsigned int no_short_slot_time_set:1;
103 	unsigned int no_short_preamble_set:1;
104 	unsigned int no_ht_gf_set:1;
105 	unsigned int no_ht_set:1;
106 	unsigned int ht40_intolerant_set:1;
107 	unsigned int ht_20mhz_set:1;
108 	unsigned int no_p2p_set:1;
109 	unsigned int qos_map_enabled:1;
110 	unsigned int remediation:1;
111 	unsigned int hs20_deauth_requested:1;
112 	unsigned int session_timeout_set:1;
113 	unsigned int radius_das_match:1;
114 	unsigned int ecsa_supported:1;
115 	unsigned int added_unassoc:1;
116 
117 	u16 auth_alg;
118 
119 	enum {
120 		STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
121 		STA_DISASSOC_FROM_CLI
122 	} timeout_next;
123 
124 	u16 deauth_reason;
125 	u16 disassoc_reason;
126 
127 	/* IEEE 802.1X related data */
128 	struct eapol_state_machine *eapol_sm;
129 
130 	struct pending_eapol_rx *pending_eapol_rx;
131 
132 	u64 acct_session_id;
133 	struct os_reltime acct_session_start;
134 	int acct_session_started;
135 	int acct_terminate_cause; /* Acct-Terminate-Cause */
136 	int acct_interim_interval; /* Acct-Interim-Interval */
137 	unsigned int acct_interim_errors;
138 
139 	/* For extending 32-bit driver counters to 64-bit counters */
140 	u32 last_rx_bytes_hi;
141 	u32 last_rx_bytes_lo;
142 	u32 last_tx_bytes_hi;
143 	u32 last_tx_bytes_lo;
144 
145 	u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
146 
147 	struct wpa_state_machine *wpa_sm;
148 	struct rsn_preauth_interface *preauth_iface;
149 
150 	int vlan_id; /* 0: none, >0: VID */
151 	struct vlan_description *vlan_desc;
152 	int vlan_id_bound; /* updated by ap_sta_bind_vlan() */
153 	 /* PSKs from RADIUS authentication server */
154 	struct hostapd_sta_wpa_psk_short *psk;
155 
156 	char *identity; /* User-Name from RADIUS */
157 	char *radius_cui; /* Chargeable-User-Identity from RADIUS */
158 
159 	struct ieee80211_ht_capabilities *ht_capabilities;
160 	struct ieee80211_vht_capabilities *vht_capabilities;
161 	u8 vht_opmode;
162 
163 #ifdef CONFIG_IEEE80211W
164 	int sa_query_count; /* number of pending SA Query requests;
165 			     * 0 = no SA Query in progress */
166 	int sa_query_timed_out;
167 	u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
168 				* sa_query_count octets of pending SA Query
169 				* transaction identifiers */
170 	struct os_reltime sa_query_start;
171 #endif /* CONFIG_IEEE80211W */
172 
173 #ifdef CONFIG_INTERWORKING
174 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
175 	struct gas_dialog_info *gas_dialog;
176 	u8 gas_dialog_next;
177 #endif /* CONFIG_INTERWORKING */
178 
179 	struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
180 	struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
181 	struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
182 	u8 remediation_method;
183 	char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
184 	struct wpabuf *hs20_deauth_req;
185 	char *hs20_session_info_url;
186 	int hs20_disassoc_timer;
187 #ifdef CONFIG_FST
188 	struct wpabuf *mb_ies; /* MB IEs from (Re)Association Request */
189 #endif /* CONFIG_FST */
190 
191 	struct os_reltime connected_time;
192 
193 #ifdef CONFIG_SAE
194 	struct sae_data *sae;
195 	unsigned int mesh_sae_pmksa_caching:1;
196 #endif /* CONFIG_SAE */
197 
198 	u32 session_timeout; /* valid only if session_timeout_set == 1 */
199 
200 	/* Last Authentication/(Re)Association Request/Action frame sequence
201 	 * control */
202 	u16 last_seq_ctrl;
203 	/* Last Authentication/(Re)Association Request/Action frame subtype */
204 	u8 last_subtype;
205 
206 #ifdef CONFIG_MBO
207 	u8 cell_capa; /* 0 = unknown (not an MBO STA); otherwise,
208 		       * enum mbo_cellular_capa values */
209 	struct mbo_non_pref_chan_info *non_pref_chan;
210 #endif /* CONFIG_MBO */
211 
212 	u8 *supp_op_classes; /* Supported Operating Classes element, if
213 			      * received, starting from the Length field */
214 
215 	u8 rrm_enabled_capa[5];
216 
217 #ifdef CONFIG_TAXONOMY
218 	struct wpabuf *probe_ie_taxonomy;
219 	struct wpabuf *assoc_ie_taxonomy;
220 #endif /* CONFIG_TAXONOMY */
221 };
222 
223 
224 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
225  * passed since last received frame from the station, a nullfunc data frame is
226  * sent to the station. If this frame is not acknowledged and no other frames
227  * have been received, the station will be disassociated after
228  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
229  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
230 #define AP_MAX_INACTIVITY (5 * 60)
231 #define AP_DISASSOC_DELAY (3)
232 #define AP_DEAUTH_DELAY (1)
233 /* Number of seconds to keep STA entry with Authenticated flag after it has
234  * been disassociated. */
235 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
236 /* Number of seconds to keep STA entry after it has been deauthenticated. */
237 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
238 
239 
240 struct hostapd_data;
241 
242 int ap_for_each_sta(struct hostapd_data *hapd,
243 		    int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
244 			      void *ctx),
245 		    void *ctx);
246 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
247 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
248 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
249 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
250 void ap_sta_ip6addr_del(struct hostapd_data *hapd, struct sta_info *sta);
251 void hostapd_free_stas(struct hostapd_data *hapd);
252 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
253 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
254 			      u32 session_timeout);
255 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
256 			    u32 session_timeout);
257 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
258 			       struct sta_info *sta);
259 void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
260 				    struct sta_info *sta, int warning_time);
261 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
262 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
263 			 u16 reason);
264 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
265 			   u16 reason);
266 #ifdef CONFIG_WPS
267 int ap_sta_wps_cancel(struct hostapd_data *hapd,
268 		      struct sta_info *sta, void *ctx);
269 #endif /* CONFIG_WPS */
270 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta);
271 int ap_sta_set_vlan(struct hostapd_data *hapd, struct sta_info *sta,
272 		    struct vlan_description *vlan_desc);
273 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
274 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
275 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
276 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
277 		       const u8 *addr, u16 reason);
278 
279 void ap_sta_set_authorized(struct hostapd_data *hapd,
280 			   struct sta_info *sta, int authorized);
281 static inline int ap_sta_is_authorized(struct sta_info *sta)
282 {
283 	return sta->flags & WLAN_STA_AUTHORIZED;
284 }
285 
286 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
287 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
288 void ap_sta_clear_disconnect_timeouts(struct hostapd_data *hapd,
289 				      struct sta_info *sta);
290 
291 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
292 
293 #endif /* STA_INFO_H */
294