Delay STA entry removal until Deauth/Disassoc TX status in AP mode
[mech_eap.git] / src / ap / sta_info.h
1 /*
2  * hostapd / Station table
3  * Copyright (c) 2002-2011, Jouni Malinen <j@w1.fi>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  *
9  * Alternatively, this software may be distributed under the terms of BSD
10  * license.
11  *
12  * See README and COPYING for more details.
13  */
14
15 #ifndef STA_INFO_H
16 #define STA_INFO_H
17
18 /* STA flags */
19 #define WLAN_STA_AUTH BIT(0)
20 #define WLAN_STA_ASSOC BIT(1)
21 #define WLAN_STA_PS BIT(2)
22 #define WLAN_STA_TIM BIT(3)
23 #define WLAN_STA_PERM BIT(4)
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_NONERP BIT(31)
37
38 /* Maximum number of supported rates (from both Supported Rates and Extended
39  * Supported Rates IEs). */
40 #define WLAN_SUPP_RATES_MAX 32
41
42
43 struct sta_info {
44         struct sta_info *next; /* next entry in sta list */
45         struct sta_info *hnext; /* next entry in hash table list */
46         u8 addr[6];
47         u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
48         u32 flags; /* Bitfield of WLAN_STA_* */
49         u16 capability;
50         u16 listen_interval; /* or beacon_int for APs */
51         u8 supported_rates[WLAN_SUPP_RATES_MAX];
52         int supported_rates_len;
53
54         unsigned int nonerp_set:1;
55         unsigned int no_short_slot_time_set:1;
56         unsigned int no_short_preamble_set:1;
57         unsigned int no_ht_gf_set:1;
58         unsigned int no_ht_set:1;
59         unsigned int ht_20mhz_set:1;
60         unsigned int no_p2p_set:1;
61
62         u16 auth_alg;
63         u8 previous_ap[6];
64
65         enum {
66                 STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE
67         } timeout_next;
68
69         u16 deauth_reason;
70         u16 disassoc_reason;
71
72         /* IEEE 802.1X related data */
73         struct eapol_state_machine *eapol_sm;
74
75         /* IEEE 802.11f (IAPP) related data */
76         struct ieee80211_mgmt *last_assoc_req;
77
78         u32 acct_session_id_hi;
79         u32 acct_session_id_lo;
80         time_t acct_session_start;
81         int acct_session_started;
82         int acct_terminate_cause; /* Acct-Terminate-Cause */
83         int acct_interim_interval; /* Acct-Interim-Interval */
84
85         unsigned long last_rx_bytes;
86         unsigned long last_tx_bytes;
87         u32 acct_input_gigawords; /* Acct-Input-Gigawords */
88         u32 acct_output_gigawords; /* Acct-Output-Gigawords */
89
90         u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
91
92         struct wpa_state_machine *wpa_sm;
93         struct rsn_preauth_interface *preauth_iface;
94
95         struct hostapd_ssid *ssid; /* SSID selection based on (Re)AssocReq */
96         struct hostapd_ssid *ssid_probe; /* SSID selection based on ProbeReq */
97
98         int vlan_id;
99
100         struct ieee80211_ht_capabilities *ht_capabilities;
101
102 #ifdef CONFIG_IEEE80211W
103         int sa_query_count; /* number of pending SA Query requests;
104                              * 0 = no SA Query in progress */
105         int sa_query_timed_out;
106         u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
107                                 * sa_query_count octets of pending SA Query
108                                 * transaction identifiers */
109         struct os_time sa_query_start;
110 #endif /* CONFIG_IEEE80211W */
111
112         struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
113         struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
114 };
115
116
117 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
118  * passed since last received frame from the station, a nullfunc data frame is
119  * sent to the station. If this frame is not acknowledged and no other frames
120  * have been received, the station will be disassociated after
121  * AP_DISASSOC_DELAY seconds. Similarily, the station will be deauthenticated
122  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
123 #define AP_MAX_INACTIVITY (5 * 60)
124 #define AP_DISASSOC_DELAY (1)
125 #define AP_DEAUTH_DELAY (1)
126 /* Number of seconds to keep STA entry with Authenticated flag after it has
127  * been disassociated. */
128 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
129 /* Number of seconds to keep STA entry after it has been deauthenticated. */
130 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
131
132
133 struct hostapd_data;
134
135 int ap_for_each_sta(struct hostapd_data *hapd,
136                     int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
137                               void *ctx),
138                     void *ctx);
139 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
140 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
141 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
142 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
143 void hostapd_free_stas(struct hostapd_data *hapd);
144 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
145 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
146                             u32 session_timeout);
147 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
148                                struct sta_info *sta);
149 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
150 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
151                          u16 reason);
152 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
153                            u16 reason);
154 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta,
155                      int old_vlanid);
156 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
157 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
158 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
159 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
160                        const u8 *addr, u16 reason);
161
162 void ap_sta_set_authorized(struct hostapd_data *hapd,
163                            struct sta_info *sta, int authorized);
164 static inline int ap_sta_is_authorized(struct sta_info *sta)
165 {
166         return sta->flags & WLAN_STA_AUTHORIZED;
167 }
168
169 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
170 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
171
172 #endif /* STA_INFO_H */