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 #ifdef CONFIG_MESH
  13 /* needed for mesh_plink_state enum */
  14 #include "common/defs.h"
  15 #endif /* CONFIG_MESH */
  16
  17 /* STA flags */
  18 #define WLAN_STA_AUTH BIT(0)
  19 #define WLAN_STA_ASSOC BIT(1)
  20 #define WLAN_STA_AUTHORIZED BIT(5)
  21 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
  22 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
  23 #define WLAN_STA_PREAUTH BIT(8)
  24 #define WLAN_STA_WMM BIT(9)
  25 #define WLAN_STA_MFP BIT(10)
  26 #define WLAN_STA_HT BIT(11)
  27 #define WLAN_STA_WPS BIT(12)
  28 #define WLAN_STA_MAYBE_WPS BIT(13)
  29 #define WLAN_STA_WDS BIT(14)
  30 #define WLAN_STA_ASSOC_REQ_OK BIT(15)
  31 #define WLAN_STA_WPS2 BIT(16)
  32 #define WLAN_STA_GAS BIT(17)
  33 #define WLAN_STA_VHT BIT(18)
  34 #define WLAN_STA_WNM_SLEEP_MODE BIT(19)
  35 #define WLAN_STA_VHT_OPMODE_ENABLED BIT(20)
  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         be32 ipaddr;
  50         u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
  51         u32 flags; /* Bitfield of WLAN_STA_* */
  52         u16 capability;
  53         u16 listen_interval; /* or beacon_int for APs */
  54         u8 supported_rates[WLAN_SUPP_RATES_MAX];
  55         int supported_rates_len;
  56         u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
  57
  58 #ifdef CONFIG_MESH
  59         enum mesh_plink_state plink_state;
  60         u16 peer_lid;
  61         u16 my_lid;
  62         u16 mpm_close_reason;
  63         int mpm_retries;
  64         u8 my_nonce[32];
  65         u8 peer_nonce[32];
  66         u8 aek[32];     /* SHA256 digest length */
  67         u8 mtk[16];
  68         u8 mgtk[16];
  69         u8 sae_auth_retry;
  70 #endif /* CONFIG_MESH */
  71
  72         unsigned int nonerp_set:1;
  73         unsigned int no_short_slot_time_set:1;
  74         unsigned int no_short_preamble_set:1;
  75         unsigned int no_ht_gf_set:1;
  76         unsigned int no_ht_set:1;
  77         unsigned int ht40_intolerant_set:1;
  78         unsigned int ht_20mhz_set:1;
  79         unsigned int no_p2p_set:1;
  80         unsigned int qos_map_enabled:1;
  81         unsigned int remediation:1;
  82         unsigned int hs20_deauth_requested:1;
  83         unsigned int session_timeout_set:1;
  84
  85         u16 auth_alg;
  86
  87         enum {
  88                 STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
  89                 STA_DISASSOC_FROM_CLI
  90         } timeout_next;
  91
  92         u16 deauth_reason;
  93         u16 disassoc_reason;
  94
  95         /* IEEE 802.1X related data */
  96         struct eapol_state_machine *eapol_sm;
  97
  98         u32 acct_session_id_hi;
  99         u32 acct_session_id_lo;
 100         struct os_reltime acct_session_start;
 101         int acct_session_started;
 102         int acct_terminate_cause; /* Acct-Terminate-Cause */
 103         int acct_interim_interval; /* Acct-Interim-Interval */
 104
 105         unsigned long last_rx_bytes;
 106         unsigned long last_tx_bytes;
 107         u32 acct_input_gigawords; /* Acct-Input-Gigawords */
 108         u32 acct_output_gigawords; /* Acct-Output-Gigawords */
 109
 110         u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
 111
 112         struct wpa_state_machine *wpa_sm;
 113         struct rsn_preauth_interface *preauth_iface;
 114
 115         struct hostapd_ssid *ssid; /* SSID selection based on (Re)AssocReq */
 116         struct hostapd_ssid *ssid_probe; /* SSID selection based on ProbeReq */
 117
 118         int vlan_id;
 119          /* PSKs from RADIUS authentication server */
 120         struct hostapd_sta_wpa_psk_short *psk;
 121
 122         char *identity; /* User-Name from RADIUS */
 123         char *radius_cui; /* Chargeable-User-Identity from RADIUS */
 124
 125         struct ieee80211_ht_capabilities *ht_capabilities;
 126         struct ieee80211_vht_capabilities *vht_capabilities;
 127         u8 vht_opmode;
 128
 129 #ifdef CONFIG_IEEE80211W
 130         int sa_query_count; /* number of pending SA Query requests;
 131                              * 0 = no SA Query in progress */
 132         int sa_query_timed_out;
 133         u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
 134                                 * sa_query_count octets of pending SA Query
 135                                 * transaction identifiers */
 136         struct os_reltime sa_query_start;
 137 #endif /* CONFIG_IEEE80211W */
 138
 139 #ifdef CONFIG_INTERWORKING
 140 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
 141         struct gas_dialog_info *gas_dialog;
 142         u8 gas_dialog_next;
 143 #endif /* CONFIG_INTERWORKING */
 144
 145         struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
 146         struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
 147         struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
 148         u8 remediation_method;
 149         char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
 150         struct wpabuf *hs20_deauth_req;
 151         char *hs20_session_info_url;
 152         int hs20_disassoc_timer;
 153
 154         struct os_reltime connected_time;
 155
 156 #ifdef CONFIG_SAE
 157         struct sae_data *sae;
 158 #endif /* CONFIG_SAE */
 159
 160         u32 session_timeout; /* valid only if session_timeout_set == 1 */
 161
 162         /* Last Authentication/(Re)Association Request/Action frame sequence
 163          * control */
 164         u16 last_seq_ctrl;
 165         /* Last Authentication/(Re)Association Request/Action frame subtype */
 166         u8 last_subtype;
 167 };
 168
 169
 170 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
 171  * passed since last received frame from the station, a nullfunc data frame is
 172  * sent to the station. If this frame is not acknowledged and no other frames
 173  * have been received, the station will be disassociated after
 174  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
 175  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
 176 #define AP_MAX_INACTIVITY (5 * 60)
 177 #define AP_DISASSOC_DELAY (1)
 178 #define AP_DEAUTH_DELAY (1)
 179 /* Number of seconds to keep STA entry with Authenticated flag after it has
 180  * been disassociated. */
 181 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
 182 /* Number of seconds to keep STA entry after it has been deauthenticated. */
 183 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
 184
 185
 186 struct hostapd_data;
 187
 188 int ap_for_each_sta(struct hostapd_data *hapd,
 189                     int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
 190                               void *ctx),
 191                     void *ctx);
 192 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
 193 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
 194 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
 195 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
 196 void hostapd_free_stas(struct hostapd_data *hapd);
 197 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
 198 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
 199                               u32 session_timeout);
 200 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
 201                             u32 session_timeout);
 202 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
 203                                struct sta_info *sta);
 204 void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
 205                                     struct sta_info *sta, int warning_time);
 206 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
 207 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
 208                          u16 reason);
 209 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
 210                            u16 reason);
 211 #ifdef CONFIG_WPS
 212 int ap_sta_wps_cancel(struct hostapd_data *hapd,
 213                       struct sta_info *sta, void *ctx);
 214 #endif /* CONFIG_WPS */
 215 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta,
 216                      int old_vlanid);
 217 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
 218 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
 219 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
 220 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
 221                        const u8 *addr, u16 reason);
 222
 223 void ap_sta_set_authorized(struct hostapd_data *hapd,
 224                            struct sta_info *sta, int authorized);
 225 static inline int ap_sta_is_authorized(struct sta_info *sta)
 226 {
 227         return sta->flags & WLAN_STA_AUTHORIZED;
 228 }
 229
 230 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
 231 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
 232
 233 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
 234
 235 #endif /* STA_INFO_H */