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#endif /* CONFIG_MESH */
16
17#include "list.h"
18
19/* STA flags */
20#define WLAN_STA_AUTH BIT(0)
21#define WLAN_STA_ASSOC BIT(1)
22#define WLAN_STA_AUTHORIZED BIT(5)
23#define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
24#define WLAN_STA_SHORT_PREAMBLE BIT(7)
25#define WLAN_STA_PREAUTH BIT(8)
26#define WLAN_STA_WMM BIT(9)
27#define WLAN_STA_MFP BIT(10)
28#define WLAN_STA_HT BIT(11)
29#define WLAN_STA_WPS BIT(12)
30#define WLAN_STA_MAYBE_WPS BIT(13)
31#define WLAN_STA_WDS BIT(14)
32#define WLAN_STA_ASSOC_REQ_OK BIT(15)
33#define WLAN_STA_WPS2 BIT(16)
34#define WLAN_STA_GAS BIT(17)
35#define WLAN_STA_VHT BIT(18)
36#define WLAN_STA_WNM_SLEEP_MODE BIT(19)
37#define WLAN_STA_VHT_OPMODE_ENABLED BIT(20)
38#define WLAN_STA_VENDOR_VHT BIT(21)
39#define WLAN_STA_PENDING_DISASSOC_CB BIT(29)
40#define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
41#define WLAN_STA_NONERP BIT(31)
42
43/* Maximum number of supported rates (from both Supported Rates and Extended
44 * Supported Rates IEs). */
45#define WLAN_SUPP_RATES_MAX 32
46
47
48struct sta_info {
49	struct sta_info *next; /* next entry in sta list */
50	struct sta_info *hnext; /* next entry in hash table list */
51	u8 addr[6];
52	be32 ipaddr;
53	struct dl_list ip6addr; /* list head for struct ip6addr */
54	u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
55	u32 flags; /* Bitfield of WLAN_STA_* */
56	u16 capability;
57	u16 listen_interval; /* or beacon_int for APs */
58	u8 supported_rates[WLAN_SUPP_RATES_MAX];
59	int supported_rates_len;
60	u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
61
62#ifdef CONFIG_MESH
63	enum mesh_plink_state plink_state;
64	u16 peer_lid;
65	u16 my_lid;
66	u16 mpm_close_reason;
67	int mpm_retries;
68	u8 my_nonce[32];
69	u8 peer_nonce[32];
70	u8 aek[32];	/* SHA256 digest length */
71	u8 mtk[16];
72	u8 mgtk[16];
73	u8 sae_auth_retry;
74#endif /* CONFIG_MESH */
75
76	unsigned int nonerp_set:1;
77	unsigned int no_short_slot_time_set:1;
78	unsigned int no_short_preamble_set:1;
79	unsigned int no_ht_gf_set:1;
80	unsigned int no_ht_set:1;
81	unsigned int ht40_intolerant_set:1;
82	unsigned int ht_20mhz_set:1;
83	unsigned int no_p2p_set:1;
84	unsigned int qos_map_enabled:1;
85	unsigned int remediation:1;
86	unsigned int hs20_deauth_requested:1;
87	unsigned int session_timeout_set:1;
88	unsigned int radius_das_match:1;
89
90	u16 auth_alg;
91
92	enum {
93		STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
94		STA_DISASSOC_FROM_CLI
95	} timeout_next;
96
97	u16 deauth_reason;
98	u16 disassoc_reason;
99
100	/* IEEE 802.1X related data */
101	struct eapol_state_machine *eapol_sm;
102
103	u32 acct_session_id_hi;
104	u32 acct_session_id_lo;
105	struct os_reltime acct_session_start;
106	int acct_session_started;
107	int acct_terminate_cause; /* Acct-Terminate-Cause */
108	int acct_interim_interval; /* Acct-Interim-Interval */
109
110	unsigned long last_rx_bytes;
111	unsigned long last_tx_bytes;
112	u32 acct_input_gigawords; /* Acct-Input-Gigawords */
113	u32 acct_output_gigawords; /* Acct-Output-Gigawords */
114
115	u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
116
117	struct wpa_state_machine *wpa_sm;
118	struct rsn_preauth_interface *preauth_iface;
119
120	int vlan_id; /* 0: none, >0: VID */
121	int vlan_id_bound; /* updated by ap_sta_bind_vlan() */
122	 /* PSKs from RADIUS authentication server */
123	struct hostapd_sta_wpa_psk_short *psk;
124
125	char *identity; /* User-Name from RADIUS */
126	char *radius_cui; /* Chargeable-User-Identity from RADIUS */
127
128	struct ieee80211_ht_capabilities *ht_capabilities;
129	struct ieee80211_vht_capabilities *vht_capabilities;
130	u8 vht_opmode;
131
132#ifdef CONFIG_IEEE80211W
133	int sa_query_count; /* number of pending SA Query requests;
134			     * 0 = no SA Query in progress */
135	int sa_query_timed_out;
136	u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
137				* sa_query_count octets of pending SA Query
138				* transaction identifiers */
139	struct os_reltime sa_query_start;
140#endif /* CONFIG_IEEE80211W */
141
142#ifdef CONFIG_INTERWORKING
143#define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
144	struct gas_dialog_info *gas_dialog;
145	u8 gas_dialog_next;
146#endif /* CONFIG_INTERWORKING */
147
148	struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
149	struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
150	struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
151	u8 remediation_method;
152	char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
153	struct wpabuf *hs20_deauth_req;
154	char *hs20_session_info_url;
155	int hs20_disassoc_timer;
156
157	struct os_reltime connected_time;
158
159#ifdef CONFIG_SAE
160	struct sae_data *sae;
161#endif /* CONFIG_SAE */
162
163	u32 session_timeout; /* valid only if session_timeout_set == 1 */
164
165	/* Last Authentication/(Re)Association Request/Action frame sequence
166	 * control */
167	u16 last_seq_ctrl;
168	/* Last Authentication/(Re)Association Request/Action frame subtype */
169	u8 last_subtype;
170};
171
172
173/* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
174 * passed since last received frame from the station, a nullfunc data frame is
175 * sent to the station. If this frame is not acknowledged and no other frames
176 * have been received, the station will be disassociated after
177 * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
178 * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
179#define AP_MAX_INACTIVITY (5 * 60)
180#define AP_DISASSOC_DELAY (1)
181#define AP_DEAUTH_DELAY (1)
182/* Number of seconds to keep STA entry with Authenticated flag after it has
183 * been disassociated. */
184#define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
185/* Number of seconds to keep STA entry after it has been deauthenticated. */
186#define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
187
188
189struct hostapd_data;
190
191int ap_for_each_sta(struct hostapd_data *hapd,
192		    int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
193			      void *ctx),
194		    void *ctx);
195struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
196struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
197void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
198void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
199void ap_sta_ip6addr_del(struct hostapd_data *hapd, struct sta_info *sta);
200void hostapd_free_stas(struct hostapd_data *hapd);
201void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
202void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
203			      u32 session_timeout);
204void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
205			    u32 session_timeout);
206void ap_sta_no_session_timeout(struct hostapd_data *hapd,
207			       struct sta_info *sta);
208void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
209				    struct sta_info *sta, int warning_time);
210struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
211void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
212			 u16 reason);
213void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
214			   u16 reason);
215#ifdef CONFIG_WPS
216int ap_sta_wps_cancel(struct hostapd_data *hapd,
217		      struct sta_info *sta, void *ctx);
218#endif /* CONFIG_WPS */
219int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta);
220void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
221void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
222int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
223void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
224		       const u8 *addr, u16 reason);
225
226void ap_sta_set_authorized(struct hostapd_data *hapd,
227			   struct sta_info *sta, int authorized);
228static inline int ap_sta_is_authorized(struct sta_info *sta)
229{
230	return sta->flags & WLAN_STA_AUTHORIZED;
231}
232
233void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
234void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
235
236int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
237
238#endif /* STA_INFO_H */
239