src/ap/sta_info.h

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