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