1 /*
2  * hostapd - IEEE 802.11i-2004 / WPA Authenticator: Internal definitions
3  * Copyright (c) 2004-2015, Jouni Malinen <j@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_AUTH_I_H
10 #define WPA_AUTH_I_H
11 
12 /* max(dot11RSNAConfigGroupUpdateCount,dot11RSNAConfigPairwiseUpdateCount) */
13 #define RSNA_MAX_EAPOL_RETRIES 4
14 
15 struct wpa_group;
16 
17 struct wpa_state_machine {
18 	struct wpa_authenticator *wpa_auth;
19 	struct wpa_group *group;
20 
21 	u8 addr[ETH_ALEN];
22 	u8 p2p_dev_addr[ETH_ALEN];
23 
24 	enum {
25 		WPA_PTK_INITIALIZE, WPA_PTK_DISCONNECT, WPA_PTK_DISCONNECTED,
26 		WPA_PTK_AUTHENTICATION, WPA_PTK_AUTHENTICATION2,
27 		WPA_PTK_INITPMK, WPA_PTK_INITPSK, WPA_PTK_PTKSTART,
28 		WPA_PTK_PTKCALCNEGOTIATING, WPA_PTK_PTKCALCNEGOTIATING2,
29 		WPA_PTK_PTKINITNEGOTIATING, WPA_PTK_PTKINITDONE
30 	} wpa_ptk_state;
31 
32 	enum {
33 		WPA_PTK_GROUP_IDLE = 0,
34 		WPA_PTK_GROUP_REKEYNEGOTIATING,
35 		WPA_PTK_GROUP_REKEYESTABLISHED,
36 		WPA_PTK_GROUP_KEYERROR
37 	} wpa_ptk_group_state;
38 
39 	Boolean Init;
40 	Boolean DeauthenticationRequest;
41 	Boolean AuthenticationRequest;
42 	Boolean ReAuthenticationRequest;
43 	Boolean Disconnect;
44 	u32 TimeoutCtr;
45 	u32 GTimeoutCtr;
46 	Boolean TimeoutEvt;
47 	Boolean EAPOLKeyReceived;
48 	Boolean EAPOLKeyPairwise;
49 	Boolean EAPOLKeyRequest;
50 	Boolean MICVerified;
51 	Boolean GUpdateStationKeys;
52 	u8 ANonce[WPA_NONCE_LEN];
53 	u8 SNonce[WPA_NONCE_LEN];
54 	u8 alt_SNonce[WPA_NONCE_LEN];
55 	u8 alt_replay_counter[WPA_REPLAY_COUNTER_LEN];
56 	u8 PMK[PMK_LEN_MAX];
57 	unsigned int pmk_len;
58 	struct wpa_ptk PTK;
59 	Boolean PTK_valid;
60 	Boolean pairwise_set;
61 	int keycount;
62 	Boolean Pair;
63 	struct wpa_key_replay_counter {
64 		u8 counter[WPA_REPLAY_COUNTER_LEN];
65 		Boolean valid;
66 	} key_replay[RSNA_MAX_EAPOL_RETRIES],
67 		prev_key_replay[RSNA_MAX_EAPOL_RETRIES];
68 	Boolean PInitAKeys; /* WPA only, not in IEEE 802.11i */
69 	Boolean PTKRequest; /* not in IEEE 802.11i state machine */
70 	Boolean has_GTK;
71 	Boolean PtkGroupInit; /* init request for PTK Group state machine */
72 
73 	u8 *last_rx_eapol_key; /* starting from IEEE 802.1X header */
74 	size_t last_rx_eapol_key_len;
75 
76 	unsigned int changed:1;
77 	unsigned int in_step_loop:1;
78 	unsigned int pending_deinit:1;
79 	unsigned int started:1;
80 	unsigned int mgmt_frame_prot:1;
81 	unsigned int rx_eapol_key_secure:1;
82 	unsigned int update_snonce:1;
83 	unsigned int alt_snonce_valid:1;
84 #ifdef CONFIG_IEEE80211R_AP
85 	unsigned int ft_completed:1;
86 	unsigned int pmk_r1_name_valid:1;
87 #endif /* CONFIG_IEEE80211R_AP */
88 	unsigned int is_wnmsleep:1;
89 
90 	u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN];
91 	int req_replay_counter_used;
92 
93 	u8 *wpa_ie;
94 	size_t wpa_ie_len;
95 
96 	enum {
97 		WPA_VERSION_NO_WPA = 0 /* WPA not used */,
98 		WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */,
99 		WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */
100 	} wpa;
101 	int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */
102 	int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */
103 	struct rsn_pmksa_cache_entry *pmksa;
104 
105 	u32 dot11RSNAStatsTKIPLocalMICFailures;
106 	u32 dot11RSNAStatsTKIPRemoteMICFailures;
107 
108 #ifdef CONFIG_IEEE80211R_AP
109 	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
110 	size_t xxkey_len;
111 	u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth
112 					   * Request */
113 	u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */
114 	size_t r0kh_id_len;
115 	u8 sup_pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name from EAPOL-Key
116 					       * message 2/4 */
117 	u8 *assoc_resp_ftie;
118 
119 	void (*ft_pending_cb)(void *ctx, const u8 *dst, const u8 *bssid,
120 			      u16 auth_transaction, u16 status,
121 			      const u8 *ies, size_t ies_len);
122 	void *ft_pending_cb_ctx;
123 	struct wpabuf *ft_pending_req_ies;
124 	u8 ft_pending_pull_nonce[FT_R0KH_R1KH_PULL_NONCE_LEN];
125 	u8 ft_pending_auth_transaction;
126 	u8 ft_pending_current_ap[ETH_ALEN];
127 #endif /* CONFIG_IEEE80211R_AP */
128 
129 	int pending_1_of_4_timeout;
130 
131 #ifdef CONFIG_P2P
132 	u8 ip_addr[4];
133 #endif /* CONFIG_P2P */
134 
135 #ifdef CONFIG_FILS
136 	u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN];
137 	u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN];
138 	size_t fils_key_auth_len;
139 	unsigned int fils_completed:1;
140 #endif /* CONFIG_FILS */
141 };
142 
143 
144 /* per group key state machine data */
145 struct wpa_group {
146 	struct wpa_group *next;
147 	int vlan_id;
148 
149 	Boolean GInit;
150 	int GKeyDoneStations;
151 	Boolean GTKReKey;
152 	int GTK_len;
153 	int GN, GM;
154 	Boolean GTKAuthenticator;
155 	u8 Counter[WPA_NONCE_LEN];
156 
157 	enum {
158 		WPA_GROUP_GTK_INIT = 0,
159 		WPA_GROUP_SETKEYS, WPA_GROUP_SETKEYSDONE,
160 		WPA_GROUP_FATAL_FAILURE
161 	} wpa_group_state;
162 
163 	u8 GMK[WPA_GMK_LEN];
164 	u8 GTK[2][WPA_GTK_MAX_LEN];
165 	u8 GNonce[WPA_NONCE_LEN];
166 	Boolean changed;
167 	Boolean first_sta_seen;
168 	Boolean reject_4way_hs_for_entropy;
169 #ifdef CONFIG_IEEE80211W
170 	u8 IGTK[2][WPA_IGTK_MAX_LEN];
171 	int GN_igtk, GM_igtk;
172 #endif /* CONFIG_IEEE80211W */
173 	/* Number of references except those in struct wpa_group->next */
174 	unsigned int references;
175 	unsigned int num_setup_iface;
176 };
177 
178 
179 struct wpa_ft_pmk_cache;
180 
181 /* per authenticator data */
182 struct wpa_authenticator {
183 	struct wpa_group *group;
184 
185 	unsigned int dot11RSNAStatsTKIPRemoteMICFailures;
186 	u32 dot11RSNAAuthenticationSuiteSelected;
187 	u32 dot11RSNAPairwiseCipherSelected;
188 	u32 dot11RSNAGroupCipherSelected;
189 	u8 dot11RSNAPMKIDUsed[PMKID_LEN];
190 	u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */
191 	u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */
192 	u32 dot11RSNAGroupCipherRequested; /* FIX: update */
193 	unsigned int dot11RSNATKIPCounterMeasuresInvoked;
194 	unsigned int dot11RSNA4WayHandshakeFailures;
195 
196 	struct wpa_auth_config conf;
197 	const struct wpa_auth_callbacks *cb;
198 	void *cb_ctx;
199 
200 	u8 *wpa_ie;
201 	size_t wpa_ie_len;
202 
203 	u8 addr[ETH_ALEN];
204 
205 	struct rsn_pmksa_cache *pmksa;
206 	struct wpa_ft_pmk_cache *ft_pmk_cache;
207 
208 #ifdef CONFIG_P2P
209 	struct bitfield *ip_pool;
210 #endif /* CONFIG_P2P */
211 };
212 
213 
214 int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len,
215 		     const u8 *pmkid);
216 void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
217 		     logger_level level, const char *txt);
218 void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
219 		      logger_level level, const char *fmt, ...);
220 void __wpa_send_eapol(struct wpa_authenticator *wpa_auth,
221 		      struct wpa_state_machine *sm, int key_info,
222 		      const u8 *key_rsc, const u8 *nonce,
223 		      const u8 *kde, size_t kde_len,
224 		      int keyidx, int encr, int force_version);
225 int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
226 			  int (*cb)(struct wpa_state_machine *sm, void *ctx),
227 			  void *cb_ctx);
228 int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth,
229 			   int (*cb)(struct wpa_authenticator *a, void *ctx),
230 			   void *cb_ctx);
231 
232 #ifdef CONFIG_PEERKEY
233 void wpa_smk_error(struct wpa_authenticator *wpa_auth,
234 		   struct wpa_state_machine *sm,
235 		   const u8 *key_data, size_t key_data_len);
236 void wpa_smk_m1(struct wpa_authenticator *wpa_auth,
237 		struct wpa_state_machine *sm, struct wpa_eapol_key *key,
238 		const u8 *key_data, size_t key_data_len);
239 void wpa_smk_m3(struct wpa_authenticator *wpa_auth,
240 		struct wpa_state_machine *sm, struct wpa_eapol_key *key,
241 		const u8 *key_data, size_t key_data_len);
242 #endif /* CONFIG_PEERKEY */
243 
244 #ifdef CONFIG_IEEE80211R_AP
245 int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len);
246 int wpa_write_ftie(struct wpa_auth_config *conf, const u8 *r0kh_id,
247 		   size_t r0kh_id_len,
248 		   const u8 *anonce, const u8 *snonce,
249 		   u8 *buf, size_t len, const u8 *subelem,
250 		   size_t subelem_len);
251 int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, const u8 *pmk,
252 			   struct wpa_ptk *ptk);
253 struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void);
254 void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache);
255 void wpa_ft_install_ptk(struct wpa_state_machine *sm);
256 #endif /* CONFIG_IEEE80211R_AP */
257 
258 #endif /* WPA_AUTH_I_H */
259