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