Home | History | Annotate | Download | only in rsn_supp
      1 /*
      2  * Internal WPA/RSN supplicant state machine definitions
      3  * Copyright (c) 2004-2015, 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 WPA_I_H
     10 #define WPA_I_H
     11 
     12 #include "utils/list.h"
     13 
     14 struct wpa_peerkey;
     15 struct wpa_tdls_peer;
     16 struct wpa_eapol_key;
     17 
     18 /**
     19  * struct wpa_sm - Internal WPA state machine data
     20  */
     21 struct wpa_sm {
     22 	u8 pmk[PMK_LEN_MAX];
     23 	size_t pmk_len;
     24 	struct wpa_ptk ptk, tptk;
     25 	int ptk_set, tptk_set;
     26 	unsigned int msg_3_of_4_ok:1;
     27 	u8 snonce[WPA_NONCE_LEN];
     28 	u8 anonce[WPA_NONCE_LEN]; /* ANonce from the last 1/4 msg */
     29 	int renew_snonce;
     30 	u8 rx_replay_counter[WPA_REPLAY_COUNTER_LEN];
     31 	int rx_replay_counter_set;
     32 	u8 request_counter[WPA_REPLAY_COUNTER_LEN];
     33 	struct wpa_gtk gtk;
     34 	struct wpa_gtk gtk_wnm_sleep;
     35 #ifdef CONFIG_IEEE80211W
     36 	struct wpa_igtk igtk;
     37 	struct wpa_igtk igtk_wnm_sleep;
     38 #endif /* CONFIG_IEEE80211W */
     39 
     40 	struct eapol_sm *eapol; /* EAPOL state machine from upper level code */
     41 
     42 	struct rsn_pmksa_cache *pmksa; /* PMKSA cache */
     43 	struct rsn_pmksa_cache_entry *cur_pmksa; /* current PMKSA entry */
     44 	struct dl_list pmksa_candidates;
     45 
     46 	struct l2_packet_data *l2_preauth;
     47 	struct l2_packet_data *l2_preauth_br;
     48 	struct l2_packet_data *l2_tdls;
     49 	u8 preauth_bssid[ETH_ALEN]; /* current RSN pre-auth peer or
     50 				     * 00:00:00:00:00:00 if no pre-auth is
     51 				     * in progress */
     52 	struct eapol_sm *preauth_eapol;
     53 
     54 	struct wpa_sm_ctx *ctx;
     55 
     56 	void *scard_ctx; /* context for smartcard callbacks */
     57 	int fast_reauth; /* whether EAP fast re-authentication is enabled */
     58 
     59 	void *network_ctx;
     60 	int peerkey_enabled;
     61 	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
     62 	int proactive_key_caching;
     63 	int eap_workaround;
     64 	void *eap_conf_ctx;
     65 	u8 ssid[32];
     66 	size_t ssid_len;
     67 	int wpa_ptk_rekey;
     68 	int p2p;
     69 	int wpa_rsc_relaxation;
     70 
     71 	u8 own_addr[ETH_ALEN];
     72 	const char *ifname;
     73 	const char *bridge_ifname;
     74 	u8 bssid[ETH_ALEN];
     75 
     76 	unsigned int dot11RSNAConfigPMKLifetime;
     77 	unsigned int dot11RSNAConfigPMKReauthThreshold;
     78 	unsigned int dot11RSNAConfigSATimeout;
     79 
     80 	unsigned int dot11RSNA4WayHandshakeFailures;
     81 
     82 	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
     83 	unsigned int proto;
     84 	unsigned int pairwise_cipher;
     85 	unsigned int group_cipher;
     86 	unsigned int key_mgmt;
     87 	unsigned int mgmt_group_cipher;
     88 
     89 	int rsn_enabled; /* Whether RSN is enabled in configuration */
     90 	int mfp; /* 0 = disabled, 1 = optional, 2 = mandatory */
     91 
     92 	u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
     93 	size_t assoc_wpa_ie_len;
     94 	u8 *ap_wpa_ie, *ap_rsn_ie;
     95 	size_t ap_wpa_ie_len, ap_rsn_ie_len;
     96 
     97 #ifdef CONFIG_PEERKEY
     98 	struct wpa_peerkey *peerkey;
     99 #endif /* CONFIG_PEERKEY */
    100 #ifdef CONFIG_TDLS
    101 	struct wpa_tdls_peer *tdls;
    102 	int tdls_prohibited;
    103 	int tdls_chan_switch_prohibited;
    104 	int tdls_disabled;
    105 
    106 	/* The driver supports TDLS */
    107 	int tdls_supported;
    108 
    109 	/*
    110 	 * The driver requires explicit discovery/setup/teardown frames sent
    111 	 * to it via tdls_mgmt.
    112 	 */
    113 	int tdls_external_setup;
    114 
    115 	/* The driver supports TDLS channel switching */
    116 	int tdls_chan_switch;
    117 #endif /* CONFIG_TDLS */
    118 
    119 #ifdef CONFIG_IEEE80211R
    120 	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
    121 	size_t xxkey_len;
    122 	u8 pmk_r0[PMK_LEN];
    123 	u8 pmk_r0_name[WPA_PMK_NAME_LEN];
    124 	u8 pmk_r1[PMK_LEN];
    125 	u8 pmk_r1_name[WPA_PMK_NAME_LEN];
    126 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
    127 	u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
    128 	size_t r0kh_id_len;
    129 	u8 r1kh_id[FT_R1KH_ID_LEN];
    130 	int ft_completed;
    131 	int ft_reassoc_completed;
    132 	int over_the_ds_in_progress;
    133 	u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
    134 	int set_ptk_after_assoc;
    135 	u8 mdie_ft_capab; /* FT Capability and Policy from target AP MDIE */
    136 	u8 *assoc_resp_ies; /* MDIE and FTIE from (Re)Association Response */
    137 	size_t assoc_resp_ies_len;
    138 #endif /* CONFIG_IEEE80211R */
    139 
    140 #ifdef CONFIG_P2P
    141 	u8 p2p_ip_addr[3 * 4];
    142 #endif /* CONFIG_P2P */
    143 
    144 #ifdef CONFIG_TESTING_OPTIONS
    145 	struct wpabuf *test_assoc_ie;
    146 #endif /* CONFIG_TESTING_OPTIONS */
    147 
    148 #ifdef CONFIG_FILS
    149 	u8 fils_nonce[FILS_NONCE_LEN];
    150 	u8 fils_session[FILS_SESSION_LEN];
    151 	u8 fils_anonce[FILS_NONCE_LEN];
    152 	u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN];
    153 	u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN];
    154 	size_t fils_key_auth_len;
    155 	unsigned int fils_completed:1;
    156 	unsigned int fils_erp_pmkid_set:1;
    157 	u8 fils_erp_pmkid[PMKID_LEN];
    158 #endif /* CONFIG_FILS */
    159 };
    160 
    161 
    162 static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
    163 {
    164 	WPA_ASSERT(sm->ctx->set_state);
    165 	sm->ctx->set_state(sm->ctx->ctx, state);
    166 }
    167 
    168 static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
    169 {
    170 	WPA_ASSERT(sm->ctx->get_state);
    171 	return sm->ctx->get_state(sm->ctx->ctx);
    172 }
    173 
    174 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
    175 {
    176 	WPA_ASSERT(sm->ctx->deauthenticate);
    177 	sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
    178 }
    179 
    180 static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
    181 				 const u8 *addr, int key_idx, int set_tx,
    182 				 const u8 *seq, size_t seq_len,
    183 				 const u8 *key, size_t key_len)
    184 {
    185 	WPA_ASSERT(sm->ctx->set_key);
    186 	return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
    187 				seq, seq_len, key, key_len);
    188 }
    189 
    190 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
    191 {
    192 	WPA_ASSERT(sm->ctx->get_network_ctx);
    193 	return sm->ctx->get_network_ctx(sm->ctx->ctx);
    194 }
    195 
    196 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
    197 {
    198 	WPA_ASSERT(sm->ctx->get_bssid);
    199 	return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
    200 }
    201 
    202 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
    203 				    u16 proto, const u8 *buf, size_t len)
    204 {
    205 	WPA_ASSERT(sm->ctx->ether_send);
    206 	return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
    207 }
    208 
    209 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
    210 {
    211 	WPA_ASSERT(sm->ctx->get_beacon_ie);
    212 	return sm->ctx->get_beacon_ie(sm->ctx->ctx);
    213 }
    214 
    215 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
    216 {
    217 	WPA_ASSERT(sm->ctx->cancel_auth_timeout);
    218 	sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
    219 }
    220 
    221 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
    222 				      const void *data, u16 data_len,
    223 				      size_t *msg_len, void **data_pos)
    224 {
    225 	WPA_ASSERT(sm->ctx->alloc_eapol);
    226 	return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
    227 				    msg_len, data_pos);
    228 }
    229 
    230 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, void *network_ctx,
    231 				   const u8 *bssid, const u8 *pmkid)
    232 {
    233 	WPA_ASSERT(sm->ctx->add_pmkid);
    234 	return sm->ctx->add_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid);
    235 }
    236 
    237 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, void *network_ctx,
    238 				      const u8 *bssid, const u8 *pmkid)
    239 {
    240 	WPA_ASSERT(sm->ctx->remove_pmkid);
    241 	return sm->ctx->remove_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid);
    242 }
    243 
    244 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
    245 					    int protect_type, int key_type)
    246 {
    247 	WPA_ASSERT(sm->ctx->mlme_setprotection);
    248 	return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
    249 					   key_type);
    250 }
    251 
    252 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
    253 				       const u8 *ies, size_t ies_len)
    254 {
    255 	if (sm->ctx->update_ft_ies)
    256 		return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
    257 	return -1;
    258 }
    259 
    260 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
    261 					const u8 *target_ap,
    262 					const u8 *ies, size_t ies_len)
    263 {
    264 	if (sm->ctx->send_ft_action)
    265 		return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
    266 					       ies, ies_len);
    267 	return -1;
    268 }
    269 
    270 static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
    271 					    const u8 *target_ap)
    272 {
    273 	if (sm->ctx->mark_authenticated)
    274 		return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
    275 	return -1;
    276 }
    277 
    278 static inline void wpa_sm_set_rekey_offload(struct wpa_sm *sm)
    279 {
    280 	if (!sm->ctx->set_rekey_offload)
    281 		return;
    282 	sm->ctx->set_rekey_offload(sm->ctx->ctx, sm->ptk.kek, sm->ptk.kek_len,
    283 				   sm->ptk.kck, sm->ptk.kck_len,
    284 				   sm->rx_replay_counter);
    285 }
    286 
    287 #ifdef CONFIG_TDLS
    288 static inline int wpa_sm_tdls_get_capa(struct wpa_sm *sm,
    289 				       int *tdls_supported,
    290 				       int *tdls_ext_setup,
    291 				       int *tdls_chan_switch)
    292 {
    293 	if (sm->ctx->tdls_get_capa)
    294 		return sm->ctx->tdls_get_capa(sm->ctx->ctx, tdls_supported,
    295 					      tdls_ext_setup, tdls_chan_switch);
    296 	return -1;
    297 }
    298 
    299 static inline int wpa_sm_send_tdls_mgmt(struct wpa_sm *sm, const u8 *dst,
    300 					u8 action_code, u8 dialog_token,
    301 					u16 status_code, u32 peer_capab,
    302 					int initiator, const u8 *buf,
    303 					size_t len)
    304 {
    305 	if (sm->ctx->send_tdls_mgmt)
    306 		return sm->ctx->send_tdls_mgmt(sm->ctx->ctx, dst, action_code,
    307 					       dialog_token, status_code,
    308 					       peer_capab, initiator, buf,
    309 					       len);
    310 	return -1;
    311 }
    312 
    313 static inline int wpa_sm_tdls_oper(struct wpa_sm *sm, int oper,
    314 				   const u8 *peer)
    315 {
    316 	if (sm->ctx->tdls_oper)
    317 		return sm->ctx->tdls_oper(sm->ctx->ctx, oper, peer);
    318 	return -1;
    319 }
    320 
    321 static inline int
    322 wpa_sm_tdls_peer_addset(struct wpa_sm *sm, const u8 *addr, int add,
    323 			u16 aid, u16 capability, const u8 *supp_rates,
    324 			size_t supp_rates_len,
    325 			const struct ieee80211_ht_capabilities *ht_capab,
    326 			const struct ieee80211_vht_capabilities *vht_capab,
    327 			u8 qosinfo, int wmm, const u8 *ext_capab,
    328 			size_t ext_capab_len, const u8 *supp_channels,
    329 			size_t supp_channels_len, const u8 *supp_oper_classes,
    330 			size_t supp_oper_classes_len)
    331 {
    332 	if (sm->ctx->tdls_peer_addset)
    333 		return sm->ctx->tdls_peer_addset(sm->ctx->ctx, addr, add,
    334 						 aid, capability, supp_rates,
    335 						 supp_rates_len, ht_capab,
    336 						 vht_capab, qosinfo, wmm,
    337 						 ext_capab, ext_capab_len,
    338 						 supp_channels,
    339 						 supp_channels_len,
    340 						 supp_oper_classes,
    341 						 supp_oper_classes_len);
    342 	return -1;
    343 }
    344 
    345 static inline int
    346 wpa_sm_tdls_enable_channel_switch(struct wpa_sm *sm, const u8 *addr,
    347 				  u8 oper_class,
    348 				  const struct hostapd_freq_params *freq_params)
    349 {
    350 	if (sm->ctx->tdls_enable_channel_switch)
    351 		return sm->ctx->tdls_enable_channel_switch(sm->ctx->ctx, addr,
    352 							   oper_class,
    353 							   freq_params);
    354 	return -1;
    355 }
    356 
    357 static inline int
    358 wpa_sm_tdls_disable_channel_switch(struct wpa_sm *sm, const u8 *addr)
    359 {
    360 	if (sm->ctx->tdls_disable_channel_switch)
    361 		return sm->ctx->tdls_disable_channel_switch(sm->ctx->ctx, addr);
    362 	return -1;
    363 }
    364 #endif /* CONFIG_TDLS */
    365 
    366 static inline int wpa_sm_key_mgmt_set_pmk(struct wpa_sm *sm,
    367 					  const u8 *pmk, size_t pmk_len)
    368 {
    369 	if (!sm->ctx->key_mgmt_set_pmk)
    370 		return -1;
    371 	return sm->ctx->key_mgmt_set_pmk(sm->ctx->ctx, pmk, pmk_len);
    372 }
    373 
    374 static inline void wpa_sm_fils_hlp_rx(struct wpa_sm *sm,
    375 				      const u8 *dst, const u8 *src,
    376 				      const u8 *pkt, size_t pkt_len)
    377 {
    378 	if (sm->ctx->fils_hlp_rx)
    379 		sm->ctx->fils_hlp_rx(sm->ctx->ctx, dst, src, pkt, pkt_len);
    380 }
    381 
    382 
    383 int wpa_eapol_key_send(struct wpa_sm *sm, struct wpa_ptk *ptk,
    384 		       int ver, const u8 *dest, u16 proto,
    385 		       u8 *msg, size_t msg_len, u8 *key_mic);
    386 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
    387 			       const struct wpa_eapol_key *key,
    388 			       int ver, const u8 *nonce,
    389 			       const u8 *wpa_ie, size_t wpa_ie_len,
    390 			       struct wpa_ptk *ptk);
    391 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
    392 			       const struct wpa_eapol_key *key,
    393 			       u16 ver, u16 key_info,
    394 			       struct wpa_ptk *ptk);
    395 
    396 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
    397 		      const struct wpa_eapol_key *key, struct wpa_ptk *ptk);
    398 
    399 void wpa_tdls_assoc(struct wpa_sm *sm);
    400 void wpa_tdls_disassoc(struct wpa_sm *sm);
    401 
    402 #endif /* WPA_I_H */
    403