Home | History | Annotate | Download | only in ap
      1 /*
      2  * hostapd / Station table
      3  * Copyright (c) 2002-2017, Jouni Malinen <j (at) 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 #include "common/defs.h"
     13 #include "list.h"
     14 #include "vlan.h"
     15 #include "common/wpa_common.h"
     16 #include "common/ieee802_11_defs.h"
     17 
     18 /* STA flags */
     19 #define WLAN_STA_AUTH BIT(0)
     20 #define WLAN_STA_ASSOC BIT(1)
     21 #define WLAN_STA_AUTHORIZED BIT(5)
     22 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
     23 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
     24 #define WLAN_STA_PREAUTH BIT(8)
     25 #define WLAN_STA_WMM BIT(9)
     26 #define WLAN_STA_MFP BIT(10)
     27 #define WLAN_STA_HT BIT(11)
     28 #define WLAN_STA_WPS BIT(12)
     29 #define WLAN_STA_MAYBE_WPS BIT(13)
     30 #define WLAN_STA_WDS BIT(14)
     31 #define WLAN_STA_ASSOC_REQ_OK BIT(15)
     32 #define WLAN_STA_WPS2 BIT(16)
     33 #define WLAN_STA_GAS BIT(17)
     34 #define WLAN_STA_VHT BIT(18)
     35 #define WLAN_STA_WNM_SLEEP_MODE BIT(19)
     36 #define WLAN_STA_VHT_OPMODE_ENABLED BIT(20)
     37 #define WLAN_STA_VENDOR_VHT BIT(21)
     38 #define WLAN_STA_PENDING_FILS_ERP BIT(22)
     39 #define WLAN_STA_MULTI_AP BIT(23)
     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 struct hostapd_data;
     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 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 	u16 disconnect_reason_code; /* RADIUS server override */
     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 peer_aid;
     84 	u16 mpm_close_reason;
     85 	int mpm_retries;
     86 	u8 my_nonce[WPA_NONCE_LEN];
     87 	u8 peer_nonce[WPA_NONCE_LEN];
     88 	u8 aek[32];	/* SHA256 digest length */
     89 	u8 mtk[WPA_TK_MAX_LEN];
     90 	size_t mtk_len;
     91 	u8 mgtk_rsc[6];
     92 	u8 mgtk_key_id;
     93 	u8 mgtk[WPA_TK_MAX_LEN];
     94 	size_t mgtk_len;
     95 	u8 igtk_rsc[6];
     96 	u8 igtk[WPA_TK_MAX_LEN];
     97 	size_t igtk_len;
     98 	u16 igtk_key_id;
     99 	u8 sae_auth_retry;
    100 #endif /* CONFIG_MESH */
    101 
    102 	unsigned int nonerp_set:1;
    103 	unsigned int no_short_slot_time_set:1;
    104 	unsigned int no_short_preamble_set:1;
    105 	unsigned int no_ht_gf_set:1;
    106 	unsigned int no_ht_set:1;
    107 	unsigned int ht40_intolerant_set:1;
    108 	unsigned int ht_20mhz_set:1;
    109 	unsigned int no_p2p_set:1;
    110 	unsigned int qos_map_enabled:1;
    111 	unsigned int remediation:1;
    112 	unsigned int hs20_deauth_requested:1;
    113 	unsigned int session_timeout_set:1;
    114 	unsigned int radius_das_match:1;
    115 	unsigned int ecsa_supported:1;
    116 	unsigned int added_unassoc:1;
    117 	unsigned int pending_wds_enable:1;
    118 	unsigned int power_capab:1;
    119 	unsigned int agreed_to_steer:1;
    120 	unsigned int hs20_t_c_filtering:1;
    121 	unsigned int ft_over_ds:1;
    122 
    123 	u16 auth_alg;
    124 
    125 	enum {
    126 		STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
    127 		STA_DISASSOC_FROM_CLI
    128 	} timeout_next;
    129 
    130 	u16 deauth_reason;
    131 	u16 disassoc_reason;
    132 
    133 	/* IEEE 802.1X related data */
    134 	struct eapol_state_machine *eapol_sm;
    135 
    136 	struct pending_eapol_rx *pending_eapol_rx;
    137 
    138 	u64 acct_session_id;
    139 	struct os_reltime acct_session_start;
    140 	int acct_session_started;
    141 	int acct_terminate_cause; /* Acct-Terminate-Cause */
    142 	int acct_interim_interval; /* Acct-Interim-Interval */
    143 	unsigned int acct_interim_errors;
    144 
    145 	/* For extending 32-bit driver counters to 64-bit counters */
    146 	u32 last_rx_bytes_hi;
    147 	u32 last_rx_bytes_lo;
    148 	u32 last_tx_bytes_hi;
    149 	u32 last_tx_bytes_lo;
    150 
    151 	u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
    152 
    153 	struct wpa_state_machine *wpa_sm;
    154 	struct rsn_preauth_interface *preauth_iface;
    155 
    156 	int vlan_id; /* 0: none, >0: VID */
    157 	struct vlan_description *vlan_desc;
    158 	int vlan_id_bound; /* updated by ap_sta_bind_vlan() */
    159 	 /* PSKs from RADIUS authentication server */
    160 	struct hostapd_sta_wpa_psk_short *psk;
    161 
    162 	char *identity; /* User-Name from RADIUS */
    163 	char *radius_cui; /* Chargeable-User-Identity from RADIUS */
    164 
    165 	struct ieee80211_ht_capabilities *ht_capabilities;
    166 	struct ieee80211_vht_capabilities *vht_capabilities;
    167 	struct ieee80211_vht_operation *vht_operation;
    168 	u8 vht_opmode;
    169 
    170 #ifdef CONFIG_IEEE80211W
    171 	int sa_query_count; /* number of pending SA Query requests;
    172 			     * 0 = no SA Query in progress */
    173 	int sa_query_timed_out;
    174 	u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
    175 				* sa_query_count octets of pending SA Query
    176 				* transaction identifiers */
    177 	struct os_reltime sa_query_start;
    178 #endif /* CONFIG_IEEE80211W */
    179 
    180 #if defined(CONFIG_INTERWORKING) || defined(CONFIG_DPP)
    181 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
    182 	struct gas_dialog_info *gas_dialog;
    183 	u8 gas_dialog_next;
    184 #endif /* CONFIG_INTERWORKING || CONFIG_DPP */
    185 
    186 	struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
    187 	struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
    188 	struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
    189 	/* Hotspot 2.0 Roaming Consortium from (Re)Association Request */
    190 	struct wpabuf *roaming_consortium;
    191 	u8 remediation_method;
    192 	char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
    193 	char *t_c_url; /* HS 2.0 Terms and Conditions Server URL */
    194 	struct wpabuf *hs20_deauth_req;
    195 	char *hs20_session_info_url;
    196 	int hs20_disassoc_timer;
    197 #ifdef CONFIG_FST
    198 	struct wpabuf *mb_ies; /* MB IEs from (Re)Association Request */
    199 #endif /* CONFIG_FST */
    200 
    201 	struct os_reltime connected_time;
    202 
    203 #ifdef CONFIG_SAE
    204 	struct sae_data *sae;
    205 	unsigned int mesh_sae_pmksa_caching:1;
    206 #endif /* CONFIG_SAE */
    207 
    208 	/* valid only if session_timeout_set == 1 */
    209 	struct os_reltime session_timeout;
    210 
    211 	/* Last Authentication/(Re)Association Request/Action frame sequence
    212 	 * control */
    213 	u16 last_seq_ctrl;
    214 	/* Last Authentication/(Re)Association Request/Action frame subtype */
    215 	u8 last_subtype;
    216 
    217 #ifdef CONFIG_MBO
    218 	u8 cell_capa; /* 0 = unknown (not an MBO STA); otherwise,
    219 		       * enum mbo_cellular_capa values */
    220 	struct mbo_non_pref_chan_info *non_pref_chan;
    221 	int auth_rssi; /* Last Authentication frame RSSI */
    222 #endif /* CONFIG_MBO */
    223 
    224 	u8 *supp_op_classes; /* Supported Operating Classes element, if
    225 			      * received, starting from the Length field */
    226 
    227 	u8 rrm_enabled_capa[5];
    228 
    229 	s8 min_tx_power;
    230 	s8 max_tx_power;
    231 
    232 #ifdef CONFIG_TAXONOMY
    233 	struct wpabuf *probe_ie_taxonomy;
    234 	struct wpabuf *assoc_ie_taxonomy;
    235 #endif /* CONFIG_TAXONOMY */
    236 
    237 #ifdef CONFIG_FILS
    238 	u8 fils_snonce[FILS_NONCE_LEN];
    239 	u8 fils_session[FILS_SESSION_LEN];
    240 	u8 fils_erp_pmkid[PMKID_LEN];
    241 	u8 *fils_pending_assoc_req;
    242 	size_t fils_pending_assoc_req_len;
    243 	unsigned int fils_pending_assoc_is_reassoc:1;
    244 	unsigned int fils_dhcp_rapid_commit_proxy:1;
    245 	unsigned int fils_erp_pmkid_set:1;
    246 	unsigned int fils_drv_assoc_finish:1;
    247 	struct wpabuf *fils_hlp_resp;
    248 	struct wpabuf *hlp_dhcp_discover;
    249 	void (*fils_pending_cb)(struct hostapd_data *hapd, struct sta_info *sta,
    250 				u16 resp, struct wpabuf *data, int pub);
    251 #ifdef CONFIG_FILS_SK_PFS
    252 	struct crypto_ecdh *fils_ecdh;
    253 #endif /* CONFIG_FILS_SK_PFS */
    254 	struct wpabuf *fils_dh_ss;
    255 	struct wpabuf *fils_g_sta;
    256 #endif /* CONFIG_FILS */
    257 
    258 #ifdef CONFIG_OWE
    259 	u8 *owe_pmk;
    260 	size_t owe_pmk_len;
    261 	struct crypto_ecdh *owe_ecdh;
    262 	u16 owe_group;
    263 #endif /* CONFIG_OWE */
    264 
    265 	u8 *ext_capability;
    266 	char *ifname_wds; /* WDS ifname, if in use */
    267 
    268 #ifdef CONFIG_DPP2
    269 	struct dpp_pfs *dpp_pfs;
    270 #endif /* CONFIG_DPP2 */
    271 
    272 #ifdef CONFIG_TESTING_OPTIONS
    273 	enum wpa_alg last_tk_alg;
    274 	int last_tk_key_idx;
    275 	u8 last_tk[WPA_TK_MAX_LEN];
    276 	size_t last_tk_len;
    277 #endif /* CONFIG_TESTING_OPTIONS */
    278 };
    279 
    280 
    281 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
    282  * passed since last received frame from the station, a nullfunc data frame is
    283  * sent to the station. If this frame is not acknowledged and no other frames
    284  * have been received, the station will be disassociated after
    285  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
    286  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
    287 #define AP_MAX_INACTIVITY (5 * 60)
    288 #define AP_DISASSOC_DELAY (3)
    289 #define AP_DEAUTH_DELAY (1)
    290 /* Number of seconds to keep STA entry with Authenticated flag after it has
    291  * been disassociated. */
    292 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
    293 /* Number of seconds to keep STA entry after it has been deauthenticated. */
    294 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
    295 
    296 
    297 int ap_for_each_sta(struct hostapd_data *hapd,
    298 		    int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
    299 			      void *ctx),
    300 		    void *ctx);
    301 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
    302 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
    303 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
    304 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
    305 void ap_sta_ip6addr_del(struct hostapd_data *hapd, struct sta_info *sta);
    306 void hostapd_free_stas(struct hostapd_data *hapd);
    307 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
    308 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
    309 			      u32 session_timeout);
    310 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
    311 			    u32 session_timeout);
    312 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
    313 			       struct sta_info *sta);
    314 void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
    315 				    struct sta_info *sta, int warning_time);
    316 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
    317 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
    318 			 u16 reason);
    319 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
    320 			   u16 reason);
    321 #ifdef CONFIG_WPS
    322 int ap_sta_wps_cancel(struct hostapd_data *hapd,
    323 		      struct sta_info *sta, void *ctx);
    324 #endif /* CONFIG_WPS */
    325 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta);
    326 int ap_sta_set_vlan(struct hostapd_data *hapd, struct sta_info *sta,
    327 		    struct vlan_description *vlan_desc);
    328 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
    329 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
    330 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
    331 const char * ap_sta_wpa_get_keyid(struct hostapd_data *hapd,
    332 				  struct sta_info *sta);
    333 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
    334 		       const u8 *addr, u16 reason);
    335 
    336 void ap_sta_set_authorized(struct hostapd_data *hapd,
    337 			   struct sta_info *sta, int authorized);
    338 static inline int ap_sta_is_authorized(struct sta_info *sta)
    339 {
    340 	return sta->flags & WLAN_STA_AUTHORIZED;
    341 }
    342 
    343 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
    344 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
    345 void ap_sta_clear_disconnect_timeouts(struct hostapd_data *hapd,
    346 				      struct sta_info *sta);
    347 
    348 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
    349 void ap_sta_delayed_1x_auth_fail_disconnect(struct hostapd_data *hapd,
    350 					    struct sta_info *sta);
    351 int ap_sta_pending_delayed_1x_auth_fail_disconnect(struct hostapd_data *hapd,
    352 						   struct sta_info *sta);
    353 
    354 #endif /* STA_INFO_H */
    355