Copy User-Name/CUI from RADIUS ACL to STA entry
[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 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 /* STA flags */
13 #define WLAN_STA_AUTH BIT(0)
14 #define WLAN_STA_ASSOC BIT(1)
15 #define WLAN_STA_PS BIT(2)
16 #define WLAN_STA_TIM BIT(3)
17 #define WLAN_STA_PERM BIT(4)
18 #define WLAN_STA_AUTHORIZED BIT(5)
19 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
20 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
21 #define WLAN_STA_PREAUTH BIT(8)
22 #define WLAN_STA_WMM BIT(9)
23 #define WLAN_STA_MFP BIT(10)
24 #define WLAN_STA_HT BIT(11)
25 #define WLAN_STA_WPS BIT(12)
26 #define WLAN_STA_MAYBE_WPS BIT(13)
27 #define WLAN_STA_WDS BIT(14)
28 #define WLAN_STA_ASSOC_REQ_OK BIT(15)
29 #define WLAN_STA_WPS2 BIT(16)
30 #define WLAN_STA_GAS BIT(17)
31 #define WLAN_STA_VHT BIT(18)
32 #define WLAN_STA_PENDING_DISASSOC_CB BIT(29)
33 #define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
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
41 struct 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         u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
52
53         unsigned int nonerp_set:1;
54         unsigned int no_short_slot_time_set:1;
55         unsigned int no_short_preamble_set:1;
56         unsigned int no_ht_gf_set:1;
57         unsigned int no_ht_set:1;
58         unsigned int ht_20mhz_set:1;
59         unsigned int no_p2p_set:1;
60
61         u16 auth_alg;
62         u8 previous_ap[6];
63
64         enum {
65                 STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE
66         } timeout_next;
67
68         u16 deauth_reason;
69         u16 disassoc_reason;
70
71         /* IEEE 802.1X related data */
72         struct eapol_state_machine *eapol_sm;
73
74         /* IEEE 802.11f (IAPP) related data */
75         struct ieee80211_mgmt *last_assoc_req;
76
77         u32 acct_session_id_hi;
78         u32 acct_session_id_lo;
79         time_t acct_session_start;
80         int acct_session_started;
81         int acct_terminate_cause; /* Acct-Terminate-Cause */
82         int acct_interim_interval; /* Acct-Interim-Interval */
83
84         unsigned long last_rx_bytes;
85         unsigned long last_tx_bytes;
86         u32 acct_input_gigawords; /* Acct-Input-Gigawords */
87         u32 acct_output_gigawords; /* Acct-Output-Gigawords */
88
89         u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
90
91         struct wpa_state_machine *wpa_sm;
92         struct rsn_preauth_interface *preauth_iface;
93
94         struct hostapd_ssid *ssid; /* SSID selection based on (Re)AssocReq */
95         struct hostapd_ssid *ssid_probe; /* SSID selection based on ProbeReq */
96
97         int vlan_id;
98         u8 *psk; /* PSK from RADIUS authentication server */
99
100         char *identity; /* User-Name from RADIUS */
101         char *radius_cui; /* Chargeable-User-Identity from RADIUS */
102
103         struct ieee80211_ht_capabilities *ht_capabilities;
104         struct ieee80211_vht_capabilities *vht_capabilities;
105
106 #ifdef CONFIG_IEEE80211W
107         int sa_query_count; /* number of pending SA Query requests;
108                              * 0 = no SA Query in progress */
109         int sa_query_timed_out;
110         u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
111                                 * sa_query_count octets of pending SA Query
112                                 * transaction identifiers */
113         struct os_time sa_query_start;
114 #endif /* CONFIG_IEEE80211W */
115
116 #ifdef CONFIG_INTERWORKING
117 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
118         struct gas_dialog_info *gas_dialog;
119         u8 gas_dialog_next;
120 #endif /* CONFIG_INTERWORKING */
121
122         struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
123         struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
124 };
125
126
127 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
128  * passed since last received frame from the station, a nullfunc data frame is
129  * sent to the station. If this frame is not acknowledged and no other frames
130  * have been received, the station will be disassociated after
131  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
132  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
133 #define AP_MAX_INACTIVITY (5 * 60)
134 #define AP_DISASSOC_DELAY (1)
135 #define AP_DEAUTH_DELAY (1)
136 /* Number of seconds to keep STA entry with Authenticated flag after it has
137  * been disassociated. */
138 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
139 /* Number of seconds to keep STA entry after it has been deauthenticated. */
140 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
141
142
143 struct hostapd_data;
144
145 int ap_for_each_sta(struct hostapd_data *hapd,
146                     int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
147                               void *ctx),
148                     void *ctx);
149 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
150 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
151 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
152 void hostapd_free_stas(struct hostapd_data *hapd);
153 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
154 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
155                             u32 session_timeout);
156 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
157                                struct sta_info *sta);
158 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
159 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
160                          u16 reason);
161 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
162                            u16 reason);
163 #ifdef CONFIG_WPS
164 int ap_sta_wps_cancel(struct hostapd_data *hapd,
165                       struct sta_info *sta, void *ctx);
166 #endif /* CONFIG_WPS */
167 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta,
168                      int old_vlanid);
169 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
170 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
171 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
172 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
173                        const u8 *addr, u16 reason);
174
175 void ap_sta_set_authorized(struct hostapd_data *hapd,
176                            struct sta_info *sta, int authorized);
177 static inline int ap_sta_is_authorized(struct sta_info *sta)
178 {
179         return sta->flags & WLAN_STA_AUTHORIZED;
180 }
181
182 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
183 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
184
185 #endif /* STA_INFO_H */