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