Comment CONFIG_WPA_TRACE_BFD=y out by default
[libeap.git] / hostapd / sta_info.h
1 /*
2  * hostapd / Station table
3  * Copyright (c) 2002-2009, 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_NONERP BIT(31)
34
35 /* Maximum number of supported rates (from both Supported Rates and Extended
36  * Supported Rates IEs). */
37 #define WLAN_SUPP_RATES_MAX 32
38
39
40 struct sta_info {
41         struct sta_info *next; /* next entry in sta list */
42         struct sta_info *hnext; /* next entry in hash table list */
43         u8 addr[6];
44         u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
45         u32 flags; /* Bitfield of WLAN_STA_* */
46         u16 capability;
47         u16 listen_interval; /* or beacon_int for APs */
48         u8 supported_rates[WLAN_SUPP_RATES_MAX];
49         int supported_rates_len;
50
51         unsigned int nonerp_set:1;
52         unsigned int no_short_slot_time_set:1;
53         unsigned int no_short_preamble_set:1;
54         unsigned int no_ht_gf_set:1;
55         unsigned int no_ht_set:1;
56         unsigned int ht_20mhz_set:1;
57
58         u16 auth_alg;
59         u8 previous_ap[6];
60
61         enum {
62                 STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE
63         } timeout_next;
64
65         /* IEEE 802.1X related data */
66         struct eapol_state_machine *eapol_sm;
67
68         /* IEEE 802.11f (IAPP) related data */
69         struct ieee80211_mgmt *last_assoc_req;
70
71         u32 acct_session_id_hi;
72         u32 acct_session_id_lo;
73         time_t acct_session_start;
74         int acct_session_started;
75         int acct_terminate_cause; /* Acct-Terminate-Cause */
76         int acct_interim_interval; /* Acct-Interim-Interval */
77
78         unsigned long last_rx_bytes;
79         unsigned long last_tx_bytes;
80         u32 acct_input_gigawords; /* Acct-Input-Gigawords */
81         u32 acct_output_gigawords; /* Acct-Output-Gigawords */
82
83         u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
84
85         struct wpa_state_machine *wpa_sm;
86         struct rsn_preauth_interface *preauth_iface;
87
88         struct hostapd_ssid *ssid; /* SSID selection based on (Re)AssocReq */
89         struct hostapd_ssid *ssid_probe; /* SSID selection based on ProbeReq */
90
91         int vlan_id;
92
93         struct ieee80211_ht_capabilities *ht_capabilities;
94
95 #ifdef CONFIG_IEEE80211W
96         int sa_query_count; /* number of pending SA Query requests;
97                              * 0 = no SA Query in progress */
98         int sa_query_timed_out;
99         u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
100                                 * sa_query_count octets of pending SA Query
101                                 * transaction identifiers */
102         struct os_time sa_query_start;
103 #endif /* CONFIG_IEEE80211W */
104
105         struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
106 };
107
108
109 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
110  * passed since last received frame from the station, a nullfunc data frame is
111  * sent to the station. If this frame is not acknowledged and no other frames
112  * have been received, the station will be disassociated after
113  * AP_DISASSOC_DELAY seconds. Similarily, the station will be deauthenticated
114  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
115 #define AP_MAX_INACTIVITY (5 * 60)
116 #define AP_DISASSOC_DELAY (1)
117 #define AP_DEAUTH_DELAY (1)
118 /* Number of seconds to keep STA entry with Authenticated flag after it has
119  * been disassociated. */
120 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
121 /* Number of seconds to keep STA entry after it has been deauthenticated. */
122 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
123
124
125 struct hostapd_data;
126
127 int ap_for_each_sta(struct hostapd_data *hapd,
128                     int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
129                               void *ctx),
130                     void *ctx);
131 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
132 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
133 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
134 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
135 void hostapd_free_stas(struct hostapd_data *hapd);
136 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
137 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
138                             u32 session_timeout);
139 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
140                                struct sta_info *sta);
141 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
142 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
143                          u16 reason);
144 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
145                            u16 reason);
146 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta,
147                      int old_vlanid);
148 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
149 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
150 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
151
152 #endif /* STA_INFO_H */