contrib/hostapd/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_AUTHORIZED BIT(5)
  16 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
  17 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
  18 #define WLAN_STA_PREAUTH BIT(8)
  19 #define WLAN_STA_WMM BIT(9)
  20 #define WLAN_STA_MFP BIT(10)
  21 #define WLAN_STA_HT BIT(11)
  22 #define WLAN_STA_WPS BIT(12)
  23 #define WLAN_STA_MAYBE_WPS BIT(13)
  24 #define WLAN_STA_WDS BIT(14)
  25 #define WLAN_STA_ASSOC_REQ_OK BIT(15)
  26 #define WLAN_STA_WPS2 BIT(16)
  27 #define WLAN_STA_GAS BIT(17)
  28 #define WLAN_STA_VHT BIT(18)
  29 #define WLAN_STA_WNM_SLEEP_MODE BIT(19)
  30 #define WLAN_STA_PENDING_DISASSOC_CB BIT(29)
  31 #define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
  32 #define WLAN_STA_NONERP BIT(31)
  33
  34 /* Maximum number of supported rates (from both Supported Rates and Extended
  35  * Supported Rates IEs). */
  36 #define WLAN_SUPP_RATES_MAX 32
  37
  38
  39 struct sta_info {
  40         struct sta_info *next; /* next entry in sta list */
  41         struct sta_info *hnext; /* next entry in hash table list */
  42         u8 addr[6];
  43         u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
  44         u32 flags; /* Bitfield of WLAN_STA_* */
  45         u16 capability;
  46         u16 listen_interval; /* or beacon_int for APs */
  47         u8 supported_rates[WLAN_SUPP_RATES_MAX];
  48         int supported_rates_len;
  49         u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
  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         unsigned int no_p2p_set:1;
  58         unsigned int qos_map_enabled:1;
  59
  60         u16 auth_alg;
  61         u8 previous_ap[6];
  62
  63         enum {
  64                 STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
  65                 STA_DISASSOC_FROM_CLI
  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         struct os_reltime 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          /* PSKs from RADIUS authentication server */
  99         struct hostapd_sta_wpa_psk_short *psk;
 100
 101         char *identity; /* User-Name from RADIUS */
 102         char *radius_cui; /* Chargeable-User-Identity from RADIUS */
 103
 104         struct ieee80211_ht_capabilities *ht_capabilities;
 105         struct ieee80211_vht_capabilities *vht_capabilities;
 106
 107 #ifdef CONFIG_IEEE80211W
 108         int sa_query_count; /* number of pending SA Query requests;
 109                              * 0 = no SA Query in progress */
 110         int sa_query_timed_out;
 111         u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
 112                                 * sa_query_count octets of pending SA Query
 113                                 * transaction identifiers */
 114         struct os_reltime sa_query_start;
 115 #endif /* CONFIG_IEEE80211W */
 116
 117 #ifdef CONFIG_INTERWORKING
 118 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
 119         struct gas_dialog_info *gas_dialog;
 120         u8 gas_dialog_next;
 121 #endif /* CONFIG_INTERWORKING */
 122
 123         struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
 124         struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
 125         struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
 126
 127         struct os_reltime connected_time;
 128
 129 #ifdef CONFIG_SAE
 130         struct sae_data *sae;
 131 #endif /* CONFIG_SAE */
 132 };
 133
 134
 135 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
 136  * passed since last received frame from the station, a nullfunc data frame is
 137  * sent to the station. If this frame is not acknowledged and no other frames
 138  * have been received, the station will be disassociated after
 139  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
 140  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
 141 #define AP_MAX_INACTIVITY (5 * 60)
 142 #define AP_DISASSOC_DELAY (1)
 143 #define AP_DEAUTH_DELAY (1)
 144 /* Number of seconds to keep STA entry with Authenticated flag after it has
 145  * been disassociated. */
 146 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
 147 /* Number of seconds to keep STA entry after it has been deauthenticated. */
 148 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
 149
 150
 151 struct hostapd_data;
 152
 153 int ap_for_each_sta(struct hostapd_data *hapd,
 154                     int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
 155                               void *ctx),
 156                     void *ctx);
 157 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
 158 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
 159 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
 160 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
 161 void hostapd_free_stas(struct hostapd_data *hapd);
 162 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
 163 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
 164                               u32 session_timeout);
 165 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
 166                             u32 session_timeout);
 167 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
 168                                struct sta_info *sta);
 169 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
 170 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
 171                          u16 reason);
 172 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
 173                            u16 reason);
 174 #ifdef CONFIG_WPS
 175 int ap_sta_wps_cancel(struct hostapd_data *hapd,
 176                       struct sta_info *sta, void *ctx);
 177 #endif /* CONFIG_WPS */
 178 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta,
 179                      int old_vlanid);
 180 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
 181 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
 182 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
 183 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
 184                        const u8 *addr, u16 reason);
 185
 186 void ap_sta_set_authorized(struct hostapd_data *hapd,
 187                            struct sta_info *sta, int authorized);
 188 static inline int ap_sta_is_authorized(struct sta_info *sta)
 189 {
 190         return sta->flags & WLAN_STA_AUTHORIZED;
 191 }
 192
 193 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
 194 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
 195
 196 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
 197
 198 #endif /* STA_INFO_H */