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