Home | History | Annotate | Download | only in rsn_supp
      1 /*
      2  * wpa_supplicant - Internal WPA state machine definitions
      3  * Copyright (c) 2004-2007, Jouni Malinen <j (at) w1.fi>
      4  *
      5  * This program is free software; you can redistribute it and/or modify
      6  * it under the terms of the GNU General Public License version 2 as
      7  * published by the Free Software Foundation.
      8  *
      9  * Alternatively, this software may be distributed under the terms of BSD
     10  * license.
     11  *
     12  * See README and COPYING for more details.
     13  */
     14 
     15 #ifndef WPA_I_H
     16 #define WPA_I_H
     17 
     18 struct rsn_pmksa_candidate;
     19 struct wpa_peerkey;
     20 struct wpa_eapol_key;
     21 
     22 /**
     23  * struct wpa_sm - Internal WPA state machine data
     24  */
     25 struct wpa_sm {
     26 	u8 pmk[PMK_LEN];
     27 	size_t pmk_len;
     28 	struct wpa_ptk ptk, tptk;
     29 	int ptk_set, tptk_set;
     30 	u8 snonce[WPA_NONCE_LEN];
     31 	u8 anonce[WPA_NONCE_LEN]; /* ANonce from the last 1/4 msg */
     32 	int renew_snonce;
     33 	u8 rx_replay_counter[WPA_REPLAY_COUNTER_LEN];
     34 	int rx_replay_counter_set;
     35 	u8 request_counter[WPA_REPLAY_COUNTER_LEN];
     36 
     37 	struct eapol_sm *eapol; /* EAPOL state machine from upper level code */
     38 
     39 	struct rsn_pmksa_cache *pmksa; /* PMKSA cache */
     40 	struct rsn_pmksa_cache_entry *cur_pmksa; /* current PMKSA entry */
     41 	struct rsn_pmksa_candidate *pmksa_candidates;
     42 
     43 	struct l2_packet_data *l2_preauth;
     44 	struct l2_packet_data *l2_preauth_br;
     45 	u8 preauth_bssid[ETH_ALEN]; /* current RSN pre-auth peer or
     46 				     * 00:00:00:00:00:00 if no pre-auth is
     47 				     * in progress */
     48 	struct eapol_sm *preauth_eapol;
     49 
     50 	struct wpa_sm_ctx *ctx;
     51 
     52 	void *scard_ctx; /* context for smartcard callbacks */
     53 	int fast_reauth; /* whether EAP fast re-authentication is enabled */
     54 
     55 	void *network_ctx;
     56 	int peerkey_enabled;
     57 	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
     58 	int proactive_key_caching;
     59 	int eap_workaround;
     60 	void *eap_conf_ctx;
     61 	u8 ssid[32];
     62 	size_t ssid_len;
     63 	int wpa_ptk_rekey;
     64 
     65 	u8 own_addr[ETH_ALEN];
     66 	const char *ifname;
     67 	const char *bridge_ifname;
     68 	u8 bssid[ETH_ALEN];
     69 
     70 	unsigned int dot11RSNAConfigPMKLifetime;
     71 	unsigned int dot11RSNAConfigPMKReauthThreshold;
     72 	unsigned int dot11RSNAConfigSATimeout;
     73 
     74 	unsigned int dot11RSNA4WayHandshakeFailures;
     75 
     76 	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
     77 	unsigned int proto;
     78 	unsigned int pairwise_cipher;
     79 	unsigned int group_cipher;
     80 	unsigned int key_mgmt;
     81 	unsigned int mgmt_group_cipher;
     82 
     83 	int rsn_enabled; /* Whether RSN is enabled in configuration */
     84 
     85 	u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
     86 	size_t assoc_wpa_ie_len;
     87 	u8 *ap_wpa_ie, *ap_rsn_ie;
     88 	size_t ap_wpa_ie_len, ap_rsn_ie_len;
     89 
     90 #ifdef CONFIG_PEERKEY
     91 	struct wpa_peerkey *peerkey;
     92 #endif /* CONFIG_PEERKEY */
     93 
     94 #ifdef CONFIG_IEEE80211R
     95 	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
     96 	size_t xxkey_len;
     97 	u8 pmk_r0[PMK_LEN];
     98 	u8 pmk_r0_name[WPA_PMK_NAME_LEN];
     99 	u8 pmk_r1[PMK_LEN];
    100 	u8 pmk_r1_name[WPA_PMK_NAME_LEN];
    101 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
    102 	u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
    103 	size_t r0kh_id_len;
    104 	u8 r1kh_id[FT_R1KH_ID_LEN];
    105 	int ft_completed;
    106 	int over_the_ds_in_progress;
    107 	u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
    108 #endif /* CONFIG_IEEE80211R */
    109 };
    110 
    111 
    112 static inline void wpa_sm_set_state(struct wpa_sm *sm, wpa_states state)
    113 {
    114 	WPA_ASSERT(sm->ctx->set_state);
    115 	sm->ctx->set_state(sm->ctx->ctx, state);
    116 }
    117 
    118 static inline wpa_states wpa_sm_get_state(struct wpa_sm *sm)
    119 {
    120 	WPA_ASSERT(sm->ctx->get_state);
    121 	return sm->ctx->get_state(sm->ctx->ctx);
    122 }
    123 
    124 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
    125 {
    126 	WPA_ASSERT(sm->ctx->deauthenticate);
    127 	sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
    128 }
    129 
    130 static inline void wpa_sm_disassociate(struct wpa_sm *sm, int reason_code)
    131 {
    132 	WPA_ASSERT(sm->ctx->disassociate);
    133 	sm->ctx->disassociate(sm->ctx->ctx, reason_code);
    134 }
    135 
    136 static inline int wpa_sm_set_key(struct wpa_sm *sm, wpa_alg alg,
    137 				 const u8 *addr, int key_idx, int set_tx,
    138 				 const u8 *seq, size_t seq_len,
    139 				 const u8 *key, size_t key_len)
    140 {
    141 	WPA_ASSERT(sm->ctx->set_key);
    142 	return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
    143 				seq, seq_len, key, key_len);
    144 }
    145 
    146 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
    147 {
    148 	WPA_ASSERT(sm->ctx->get_network_ctx);
    149 	return sm->ctx->get_network_ctx(sm->ctx->ctx);
    150 }
    151 
    152 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
    153 {
    154 	WPA_ASSERT(sm->ctx->get_bssid);
    155 	return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
    156 }
    157 
    158 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
    159 				    u16 proto, const u8 *buf, size_t len)
    160 {
    161 	WPA_ASSERT(sm->ctx->ether_send);
    162 	return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
    163 }
    164 
    165 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
    166 {
    167 	WPA_ASSERT(sm->ctx->get_beacon_ie);
    168 	return sm->ctx->get_beacon_ie(sm->ctx->ctx);
    169 }
    170 
    171 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
    172 {
    173 	WPA_ASSERT(sm->ctx->cancel_auth_timeout);
    174 	sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
    175 }
    176 
    177 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
    178 				      const void *data, u16 data_len,
    179 				      size_t *msg_len, void **data_pos)
    180 {
    181 	WPA_ASSERT(sm->ctx->alloc_eapol);
    182 	return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
    183 				    msg_len, data_pos);
    184 }
    185 
    186 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, const u8 *bssid,
    187 				   const u8 *pmkid)
    188 {
    189 	WPA_ASSERT(sm->ctx->add_pmkid);
    190 	return sm->ctx->add_pmkid(sm->ctx->ctx, bssid, pmkid);
    191 }
    192 
    193 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, const u8 *bssid,
    194 				      const u8 *pmkid)
    195 {
    196 	WPA_ASSERT(sm->ctx->remove_pmkid);
    197 	return sm->ctx->remove_pmkid(sm->ctx->ctx, bssid, pmkid);
    198 }
    199 
    200 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
    201 					    int protect_type, int key_type)
    202 {
    203 	WPA_ASSERT(sm->ctx->mlme_setprotection);
    204 	return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
    205 					   key_type);
    206 }
    207 
    208 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
    209 				       const u8 *ies, size_t ies_len)
    210 {
    211 	if (sm->ctx->update_ft_ies)
    212 		return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
    213 	return -1;
    214 }
    215 
    216 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
    217 					const u8 *target_ap,
    218 					const u8 *ies, size_t ies_len)
    219 {
    220 	if (sm->ctx->send_ft_action)
    221 		return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
    222 					       ies, ies_len);
    223 	return -1;
    224 }
    225 
    226 
    227 void wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck,
    228 			int ver, const u8 *dest, u16 proto,
    229 			u8 *msg, size_t msg_len, u8 *key_mic);
    230 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
    231 			       const struct wpa_eapol_key *key,
    232 			       int ver, const u8 *nonce,
    233 			       const u8 *wpa_ie, size_t wpa_ie_len,
    234 			       struct wpa_ptk *ptk);
    235 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
    236 			       const struct wpa_eapol_key *key,
    237 			       u16 ver, u16 key_info,
    238 			       const u8 *kde, size_t kde_len,
    239 			       struct wpa_ptk *ptk);
    240 
    241 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
    242 		      const struct wpa_eapol_key *key,
    243 		      struct wpa_ptk *ptk, size_t ptk_len);
    244 
    245 #endif /* WPA_I_H */
    246