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 #include "common/wpa_common.h"
  16 #endif /* CONFIG_MESH */
  17
  18 #include "list.h"
  19 #include "vlan.h"
  20
  21 /* STA flags */
  22 #define WLAN_STA_AUTH BIT(0)
  23 #define WLAN_STA_ASSOC BIT(1)
  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_GAS BIT(17)
  37 #define WLAN_STA_VHT BIT(18)
  38 #define WLAN_STA_WNM_SLEEP_MODE BIT(19)
  39 #define WLAN_STA_VHT_OPMODE_ENABLED BIT(20)
  40 #define WLAN_STA_VENDOR_VHT BIT(21)
  41 #define WLAN_STA_PENDING_DISASSOC_CB BIT(29)
  42 #define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
  43 #define WLAN_STA_NONERP BIT(31)
  44
  45 /* Maximum number of supported rates (from both Supported Rates and Extended
  46  * Supported Rates IEs). */
  47 #define WLAN_SUPP_RATES_MAX 32
  48
  49
  50 struct mbo_non_pref_chan_info {
  51         struct mbo_non_pref_chan_info *next;
  52         u8 op_class;
  53         u8 pref;
  54         u8 reason_code;
  55         u8 reason_detail;
  56         u8 num_channels;
  57         u8 channels[];
  58 };
  59
  60 struct pending_eapol_rx {
  61         struct wpabuf *buf;
  62         struct os_reltime rx_time;
  63 };
  64
  65 struct sta_info {
  66         struct sta_info *next; /* next entry in sta list */
  67         struct sta_info *hnext; /* next entry in hash table list */
  68         u8 addr[6];
  69         be32 ipaddr;
  70         struct dl_list ip6addr; /* list head for struct ip6addr */
  71         u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
  72         u32 flags; /* Bitfield of WLAN_STA_* */
  73         u16 capability;
  74         u16 listen_interval; /* or beacon_int for APs */
  75         u8 supported_rates[WLAN_SUPP_RATES_MAX];
  76         int supported_rates_len;
  77         u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
  78
  79 #ifdef CONFIG_MESH
  80         enum mesh_plink_state plink_state;
  81         u16 peer_lid;
  82         u16 my_lid;
  83         u16 mpm_close_reason;
  84         int mpm_retries;
  85         u8 my_nonce[WPA_NONCE_LEN];
  86         u8 peer_nonce[WPA_NONCE_LEN];
  87         u8 aek[32];     /* SHA256 digest length */
  88         u8 mtk[WPA_TK_MAX_LEN];
  89         size_t mtk_len;
  90         u8 mgtk[WPA_TK_MAX_LEN];
  91         size_t mgtk_len;
  92         u8 igtk[WPA_TK_MAX_LEN];
  93         size_t igtk_len;
  94         u8 sae_auth_retry;
  95 #endif /* CONFIG_MESH */
  96
  97         unsigned int nonerp_set:1;
  98         unsigned int no_short_slot_time_set:1;
  99         unsigned int no_short_preamble_set:1;
 100         unsigned int no_ht_gf_set:1;
 101         unsigned int no_ht_set:1;
 102         unsigned int ht40_intolerant_set:1;
 103         unsigned int ht_20mhz_set:1;
 104         unsigned int no_p2p_set:1;
 105         unsigned int qos_map_enabled:1;
 106         unsigned int remediation:1;
 107         unsigned int hs20_deauth_requested:1;
 108         unsigned int session_timeout_set:1;
 109         unsigned int radius_das_match:1;
 110         unsigned int ecsa_supported:1;
 111         unsigned int added_unassoc:1;
 112
 113         u16 auth_alg;
 114
 115         enum {
 116                 STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
 117                 STA_DISASSOC_FROM_CLI
 118         } timeout_next;
 119
 120         u16 deauth_reason;
 121         u16 disassoc_reason;
 122
 123         /* IEEE 802.1X related data */
 124         struct eapol_state_machine *eapol_sm;
 125
 126         struct pending_eapol_rx *pending_eapol_rx;
 127
 128         u64 acct_session_id;
 129         struct os_reltime acct_session_start;
 130         int acct_session_started;
 131         int acct_terminate_cause; /* Acct-Terminate-Cause */
 132         int acct_interim_interval; /* Acct-Interim-Interval */
 133         unsigned int acct_interim_errors;
 134
 135         /* For extending 32-bit driver counters to 64-bit counters */
 136         u32 last_rx_bytes_hi;
 137         u32 last_rx_bytes_lo;
 138         u32 last_tx_bytes_hi;
 139         u32 last_tx_bytes_lo;
 140
 141         u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
 142
 143         struct wpa_state_machine *wpa_sm;
 144         struct rsn_preauth_interface *preauth_iface;
 145
 146         int vlan_id; /* 0: none, >0: VID */
 147         struct vlan_description *vlan_desc;
 148         int vlan_id_bound; /* updated by ap_sta_bind_vlan() */
 149          /* PSKs from RADIUS authentication server */
 150         struct hostapd_sta_wpa_psk_short *psk;
 151
 152         char *identity; /* User-Name from RADIUS */
 153         char *radius_cui; /* Chargeable-User-Identity from RADIUS */
 154
 155         struct ieee80211_ht_capabilities *ht_capabilities;
 156         struct ieee80211_vht_capabilities *vht_capabilities;
 157         u8 vht_opmode;
 158
 159 #ifdef CONFIG_IEEE80211W
 160         int sa_query_count; /* number of pending SA Query requests;
 161                              * 0 = no SA Query in progress */
 162         int sa_query_timed_out;
 163         u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
 164                                 * sa_query_count octets of pending SA Query
 165                                 * transaction identifiers */
 166         struct os_reltime sa_query_start;
 167 #endif /* CONFIG_IEEE80211W */
 168
 169 #ifdef CONFIG_INTERWORKING
 170 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
 171         struct gas_dialog_info *gas_dialog;
 172         u8 gas_dialog_next;
 173 #endif /* CONFIG_INTERWORKING */
 174
 175         struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
 176         struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
 177         struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
 178         u8 remediation_method;
 179         char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
 180         struct wpabuf *hs20_deauth_req;
 181         char *hs20_session_info_url;
 182         int hs20_disassoc_timer;
 183 #ifdef CONFIG_FST
 184         struct wpabuf *mb_ies; /* MB IEs from (Re)Association Request */
 185 #endif /* CONFIG_FST */
 186
 187         struct os_reltime connected_time;
 188
 189 #ifdef CONFIG_SAE
 190         struct sae_data *sae;
 191         unsigned int mesh_sae_pmksa_caching:1;
 192 #endif /* CONFIG_SAE */
 193
 194         u32 session_timeout; /* valid only if session_timeout_set == 1 */
 195
 196         /* Last Authentication/(Re)Association Request/Action frame sequence
 197          * control */
 198         u16 last_seq_ctrl;
 199         /* Last Authentication/(Re)Association Request/Action frame subtype */
 200         u8 last_subtype;
 201
 202 #ifdef CONFIG_MBO
 203         u8 cell_capa; /* 0 = unknown (not an MBO STA); otherwise,
 204                        * enum mbo_cellular_capa values */
 205         struct mbo_non_pref_chan_info *non_pref_chan;
 206 #endif /* CONFIG_MBO */
 207
 208         u8 *supp_op_classes; /* Supported Operating Classes element, if
 209                               * received, starting from the Length field */
 210
 211         u8 rrm_enabled_capa[5];
 212 };
 213
 214
 215 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
 216  * passed since last received frame from the station, a nullfunc data frame is
 217  * sent to the station. If this frame is not acknowledged and no other frames
 218  * have been received, the station will be disassociated after
 219  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
 220  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
 221 #define AP_MAX_INACTIVITY (5 * 60)
 222 #define AP_DISASSOC_DELAY (3)
 223 #define AP_DEAUTH_DELAY (1)
 224 /* Number of seconds to keep STA entry with Authenticated flag after it has
 225  * been disassociated. */
 226 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
 227 /* Number of seconds to keep STA entry after it has been deauthenticated. */
 228 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
 229
 230
 231 struct hostapd_data;
 232
 233 int ap_for_each_sta(struct hostapd_data *hapd,
 234                     int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
 235                               void *ctx),
 236                     void *ctx);
 237 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
 238 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
 239 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
 240 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
 241 void ap_sta_ip6addr_del(struct hostapd_data *hapd, struct sta_info *sta);
 242 void hostapd_free_stas(struct hostapd_data *hapd);
 243 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
 244 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
 245                               u32 session_timeout);
 246 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
 247                             u32 session_timeout);
 248 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
 249                                struct sta_info *sta);
 250 void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
 251                                     struct sta_info *sta, int warning_time);
 252 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
 253 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
 254                          u16 reason);
 255 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
 256                            u16 reason);
 257 #ifdef CONFIG_WPS
 258 int ap_sta_wps_cancel(struct hostapd_data *hapd,
 259                       struct sta_info *sta, void *ctx);
 260 #endif /* CONFIG_WPS */
 261 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta);
 262 int ap_sta_set_vlan(struct hostapd_data *hapd, struct sta_info *sta,
 263                     struct vlan_description *vlan_desc);
 264 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
 265 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
 266 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
 267 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
 268                        const u8 *addr, u16 reason);
 269
 270 void ap_sta_set_authorized(struct hostapd_data *hapd,
 271                            struct sta_info *sta, int authorized);
 272 static inline int ap_sta_is_authorized(struct sta_info *sta)
 273 {
 274         return sta->flags & WLAN_STA_AUTHORIZED;
 275 }
 276
 277 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
 278 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
 279 void ap_sta_clear_disconnect_timeouts(struct hostapd_data *hapd,
 280                                       struct sta_info *sta);
 281
 282 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
 283
 284 #endif /* STA_INFO_H */