Home | History | Annotate | Download | only in ap
      1 /*
      2  * hostapd / Station table
      3  * Copyright (c) 2002-2011, 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 /* STA flags */
     13 #define WLAN_STA_AUTH BIT(0)
     14 #define WLAN_STA_ASSOC BIT(1)
     15 #define WLAN_STA_AUTHORIZED BIT(5)
     16 #define WLAN_STA_PENDING_POLL BIT(6) /* pending activity poll not ACKed */
     17 #define WLAN_STA_SHORT_PREAMBLE BIT(7)
     18 #define WLAN_STA_PREAUTH BIT(8)
     19 #define WLAN_STA_WMM BIT(9)
     20 #define WLAN_STA_MFP BIT(10)
     21 #define WLAN_STA_HT BIT(11)
     22 #define WLAN_STA_WPS BIT(12)
     23 #define WLAN_STA_MAYBE_WPS BIT(13)
     24 #define WLAN_STA_WDS BIT(14)
     25 #define WLAN_STA_ASSOC_REQ_OK BIT(15)
     26 #define WLAN_STA_WPS2 BIT(16)
     27 #define WLAN_STA_GAS BIT(17)
     28 #define WLAN_STA_VHT BIT(18)
     29 #define WLAN_STA_WNM_SLEEP_MODE BIT(19)
     30 #define WLAN_STA_VHT_OPMODE_ENABLED BIT(20)
     31 #define WLAN_STA_PENDING_DISASSOC_CB BIT(29)
     32 #define WLAN_STA_PENDING_DEAUTH_CB BIT(30)
     33 #define WLAN_STA_NONERP BIT(31)
     34 
     35 /* Maximum number of supported rates (from both Supported Rates and Extended
     36  * Supported Rates IEs). */
     37 #define WLAN_SUPP_RATES_MAX 32
     38 
     39 
     40 struct sta_info {
     41 	struct sta_info *next; /* next entry in sta list */
     42 	struct sta_info *hnext; /* next entry in hash table list */
     43 	u8 addr[6];
     44 	u16 aid; /* STA's unique AID (1 .. 2007) or 0 if not yet assigned */
     45 	u32 flags; /* Bitfield of WLAN_STA_* */
     46 	u16 capability;
     47 	u16 listen_interval; /* or beacon_int for APs */
     48 	u8 supported_rates[WLAN_SUPP_RATES_MAX];
     49 	int supported_rates_len;
     50 	u8 qosinfo; /* Valid when WLAN_STA_WMM is set */
     51 
     52 	unsigned int nonerp_set:1;
     53 	unsigned int no_short_slot_time_set:1;
     54 	unsigned int no_short_preamble_set:1;
     55 	unsigned int no_ht_gf_set:1;
     56 	unsigned int no_ht_set:1;
     57 	unsigned int ht40_intolerant_set:1;
     58 	unsigned int ht_20mhz_set:1;
     59 	unsigned int no_p2p_set:1;
     60 	unsigned int qos_map_enabled:1;
     61 	unsigned int remediation:1;
     62 	unsigned int hs20_deauth_requested:1;
     63 	unsigned int session_timeout_set:1;
     64 
     65 	u16 auth_alg;
     66 
     67 	enum {
     68 		STA_NULLFUNC = 0, STA_DISASSOC, STA_DEAUTH, STA_REMOVE,
     69 		STA_DISASSOC_FROM_CLI
     70 	} timeout_next;
     71 
     72 	u16 deauth_reason;
     73 	u16 disassoc_reason;
     74 
     75 	/* IEEE 802.1X related data */
     76 	struct eapol_state_machine *eapol_sm;
     77 
     78 	u32 acct_session_id_hi;
     79 	u32 acct_session_id_lo;
     80 	struct os_reltime acct_session_start;
     81 	int acct_session_started;
     82 	int acct_terminate_cause; /* Acct-Terminate-Cause */
     83 	int acct_interim_interval; /* Acct-Interim-Interval */
     84 
     85 	unsigned long last_rx_bytes;
     86 	unsigned long last_tx_bytes;
     87 	u32 acct_input_gigawords; /* Acct-Input-Gigawords */
     88 	u32 acct_output_gigawords; /* Acct-Output-Gigawords */
     89 
     90 	u8 *challenge; /* IEEE 802.11 Shared Key Authentication Challenge */
     91 
     92 	struct wpa_state_machine *wpa_sm;
     93 	struct rsn_preauth_interface *preauth_iface;
     94 
     95 	struct hostapd_ssid *ssid; /* SSID selection based on (Re)AssocReq */
     96 	struct hostapd_ssid *ssid_probe; /* SSID selection based on ProbeReq */
     97 
     98 	int vlan_id;
     99 	 /* PSKs from RADIUS authentication server */
    100 	struct hostapd_sta_wpa_psk_short *psk;
    101 
    102 	char *identity; /* User-Name from RADIUS */
    103 	char *radius_cui; /* Chargeable-User-Identity from RADIUS */
    104 
    105 	struct ieee80211_ht_capabilities *ht_capabilities;
    106 	struct ieee80211_vht_capabilities *vht_capabilities;
    107 	u8 vht_opmode;
    108 
    109 #ifdef CONFIG_IEEE80211W
    110 	int sa_query_count; /* number of pending SA Query requests;
    111 			     * 0 = no SA Query in progress */
    112 	int sa_query_timed_out;
    113 	u8 *sa_query_trans_id; /* buffer of WLAN_SA_QUERY_TR_ID_LEN *
    114 				* sa_query_count octets of pending SA Query
    115 				* transaction identifiers */
    116 	struct os_reltime sa_query_start;
    117 #endif /* CONFIG_IEEE80211W */
    118 
    119 #ifdef CONFIG_INTERWORKING
    120 #define GAS_DIALOG_MAX 8 /* Max concurrent dialog number */
    121 	struct gas_dialog_info *gas_dialog;
    122 	u8 gas_dialog_next;
    123 #endif /* CONFIG_INTERWORKING */
    124 
    125 	struct wpabuf *wps_ie; /* WPS IE from (Re)Association Request */
    126 	struct wpabuf *p2p_ie; /* P2P IE from (Re)Association Request */
    127 	struct wpabuf *hs20_ie; /* HS 2.0 IE from (Re)Association Request */
    128 	u8 remediation_method;
    129 	char *remediation_url; /* HS 2.0 Subscription Remediation Server URL */
    130 	struct wpabuf *hs20_deauth_req;
    131 	char *hs20_session_info_url;
    132 	int hs20_disassoc_timer;
    133 
    134 	struct os_reltime connected_time;
    135 
    136 #ifdef CONFIG_SAE
    137 	struct sae_data *sae;
    138 #endif /* CONFIG_SAE */
    139 
    140 	u32 session_timeout; /* valid only if session_timeout_set == 1 */
    141 };
    142 
    143 
    144 /* Default value for maximum station inactivity. After AP_MAX_INACTIVITY has
    145  * passed since last received frame from the station, a nullfunc data frame is
    146  * sent to the station. If this frame is not acknowledged and no other frames
    147  * have been received, the station will be disassociated after
    148  * AP_DISASSOC_DELAY seconds. Similarly, the station will be deauthenticated
    149  * after AP_DEAUTH_DELAY seconds has passed after disassociation. */
    150 #define AP_MAX_INACTIVITY (5 * 60)
    151 #define AP_DISASSOC_DELAY (1)
    152 #define AP_DEAUTH_DELAY (1)
    153 /* Number of seconds to keep STA entry with Authenticated flag after it has
    154  * been disassociated. */
    155 #define AP_MAX_INACTIVITY_AFTER_DISASSOC (1 * 30)
    156 /* Number of seconds to keep STA entry after it has been deauthenticated. */
    157 #define AP_MAX_INACTIVITY_AFTER_DEAUTH (1 * 5)
    158 
    159 
    160 struct hostapd_data;
    161 
    162 int ap_for_each_sta(struct hostapd_data *hapd,
    163 		    int (*cb)(struct hostapd_data *hapd, struct sta_info *sta,
    164 			      void *ctx),
    165 		    void *ctx);
    166 struct sta_info * ap_get_sta(struct hostapd_data *hapd, const u8 *sta);
    167 struct sta_info * ap_get_sta_p2p(struct hostapd_data *hapd, const u8 *addr);
    168 void ap_sta_hash_add(struct hostapd_data *hapd, struct sta_info *sta);
    169 void ap_free_sta(struct hostapd_data *hapd, struct sta_info *sta);
    170 void hostapd_free_stas(struct hostapd_data *hapd);
    171 void ap_handle_timer(void *eloop_ctx, void *timeout_ctx);
    172 void ap_sta_replenish_timeout(struct hostapd_data *hapd, struct sta_info *sta,
    173 			      u32 session_timeout);
    174 void ap_sta_session_timeout(struct hostapd_data *hapd, struct sta_info *sta,
    175 			    u32 session_timeout);
    176 void ap_sta_no_session_timeout(struct hostapd_data *hapd,
    177 			       struct sta_info *sta);
    178 void ap_sta_session_warning_timeout(struct hostapd_data *hapd,
    179 				    struct sta_info *sta, int warning_time);
    180 struct sta_info * ap_sta_add(struct hostapd_data *hapd, const u8 *addr);
    181 void ap_sta_disassociate(struct hostapd_data *hapd, struct sta_info *sta,
    182 			 u16 reason);
    183 void ap_sta_deauthenticate(struct hostapd_data *hapd, struct sta_info *sta,
    184 			   u16 reason);
    185 #ifdef CONFIG_WPS
    186 int ap_sta_wps_cancel(struct hostapd_data *hapd,
    187 		      struct sta_info *sta, void *ctx);
    188 #endif /* CONFIG_WPS */
    189 int ap_sta_bind_vlan(struct hostapd_data *hapd, struct sta_info *sta,
    190 		     int old_vlanid);
    191 void ap_sta_start_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
    192 void ap_sta_stop_sa_query(struct hostapd_data *hapd, struct sta_info *sta);
    193 int ap_check_sa_query_timeout(struct hostapd_data *hapd, struct sta_info *sta);
    194 void ap_sta_disconnect(struct hostapd_data *hapd, struct sta_info *sta,
    195 		       const u8 *addr, u16 reason);
    196 
    197 void ap_sta_set_authorized(struct hostapd_data *hapd,
    198 			   struct sta_info *sta, int authorized);
    199 static inline int ap_sta_is_authorized(struct sta_info *sta)
    200 {
    201 	return sta->flags & WLAN_STA_AUTHORIZED;
    202 }
    203 
    204 void ap_sta_deauth_cb(struct hostapd_data *hapd, struct sta_info *sta);
    205 void ap_sta_disassoc_cb(struct hostapd_data *hapd, struct sta_info *sta);
    206 
    207 int ap_sta_flags_txt(u32 flags, char *buf, size_t buflen);
    208 
    209 #endif /* STA_INFO_H */
    210