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