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