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