wpa_auth_i.h revision 324697 
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
15struct wpa_group;
16
17struct wpa_stsl_negotiation {
18	struct wpa_stsl_negotiation *next;
19	u8 initiator[ETH_ALEN];
20	u8 peer[ETH_ALEN];
21};
22
23
24struct wpa_state_machine {
25	struct wpa_authenticator *wpa_auth;
26	struct wpa_group *group;
27
28	u8 addr[ETH_ALEN];
29	u8 p2p_dev_addr[ETH_ALEN];
30
31	enum {
32		WPA_PTK_INITIALIZE, WPA_PTK_DISCONNECT, WPA_PTK_DISCONNECTED,
33		WPA_PTK_AUTHENTICATION, WPA_PTK_AUTHENTICATION2,
34		WPA_PTK_INITPMK, WPA_PTK_INITPSK, WPA_PTK_PTKSTART,
35		WPA_PTK_PTKCALCNEGOTIATING, WPA_PTK_PTKCALCNEGOTIATING2,
36		WPA_PTK_PTKINITNEGOTIATING, WPA_PTK_PTKINITDONE
37	} wpa_ptk_state;
38
39	enum {
40		WPA_PTK_GROUP_IDLE = 0,
41		WPA_PTK_GROUP_REKEYNEGOTIATING,
42		WPA_PTK_GROUP_REKEYESTABLISHED,
43		WPA_PTK_GROUP_KEYERROR
44	} wpa_ptk_group_state;
45
46	Boolean Init;
47	Boolean DeauthenticationRequest;
48	Boolean AuthenticationRequest;
49	Boolean ReAuthenticationRequest;
50	Boolean Disconnect;
51	int TimeoutCtr;
52	int GTimeoutCtr;
53	Boolean TimeoutEvt;
54	Boolean EAPOLKeyReceived;
55	Boolean EAPOLKeyPairwise;
56	Boolean EAPOLKeyRequest;
57	Boolean MICVerified;
58	Boolean GUpdateStationKeys;
59	u8 ANonce[WPA_NONCE_LEN];
60	u8 SNonce[WPA_NONCE_LEN];
61	u8 alt_SNonce[WPA_NONCE_LEN];
62	u8 alt_replay_counter[WPA_REPLAY_COUNTER_LEN];
63	u8 PMK[PMK_LEN];
64	struct wpa_ptk PTK;
65	Boolean PTK_valid;
66	Boolean pairwise_set;
67	Boolean tk_already_set;
68	int keycount;
69	Boolean Pair;
70	struct wpa_key_replay_counter {
71		u8 counter[WPA_REPLAY_COUNTER_LEN];
72		Boolean valid;
73	} key_replay[RSNA_MAX_EAPOL_RETRIES],
74		prev_key_replay[RSNA_MAX_EAPOL_RETRIES];
75	Boolean PInitAKeys; /* WPA only, not in IEEE 802.11i */
76	Boolean PTKRequest; /* not in IEEE 802.11i state machine */
77	Boolean has_GTK;
78	Boolean PtkGroupInit; /* init request for PTK Group state machine */
79
80	u8 *last_rx_eapol_key; /* starting from IEEE 802.1X header */
81	size_t last_rx_eapol_key_len;
82
83	unsigned int changed:1;
84	unsigned int in_step_loop:1;
85	unsigned int pending_deinit:1;
86	unsigned int started:1;
87	unsigned int mgmt_frame_prot:1;
88	unsigned int rx_eapol_key_secure:1;
89	unsigned int update_snonce:1;
90	unsigned int alt_snonce_valid:1;
91#ifdef CONFIG_IEEE80211R
92	unsigned int ft_completed:1;
93	unsigned int pmk_r1_name_valid:1;
94#endif /* CONFIG_IEEE80211R */
95	unsigned int is_wnmsleep:1;
96
97	u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN];
98	int req_replay_counter_used;
99
100	u8 *wpa_ie;
101	size_t wpa_ie_len;
102
103	enum {
104		WPA_VERSION_NO_WPA = 0 /* WPA not used */,
105		WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */,
106		WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */
107	} wpa;
108	int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */
109	int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */
110	struct rsn_pmksa_cache_entry *pmksa;
111
112	u32 dot11RSNAStatsTKIPLocalMICFailures;
113	u32 dot11RSNAStatsTKIPRemoteMICFailures;
114
115#ifdef CONFIG_IEEE80211R
116	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
117	size_t xxkey_len;
118	u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth
119					   * Request */
120	u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */
121	size_t r0kh_id_len;
122	u8 sup_pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name from EAPOL-Key
123					       * message 2/4 */
124	u8 *assoc_resp_ftie;
125
126	void (*ft_pending_cb)(void *ctx, const u8 *dst, const u8 *bssid,
127			      u16 auth_transaction, u16 status,
128			      const u8 *ies, size_t ies_len);
129	void *ft_pending_cb_ctx;
130	struct wpabuf *ft_pending_req_ies;
131	u8 ft_pending_pull_nonce[FT_R0KH_R1KH_PULL_NONCE_LEN];
132	u8 ft_pending_auth_transaction;
133	u8 ft_pending_current_ap[ETH_ALEN];
134#endif /* CONFIG_IEEE80211R */
135
136	int pending_1_of_4_timeout;
137
138#ifdef CONFIG_P2P
139	u8 ip_addr[4];
140#endif /* CONFIG_P2P */
141};
142
143
144/* per group key state machine data */
145struct 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};
176
177
178struct wpa_ft_pmk_cache;
179
180/* per authenticator data */
181struct wpa_authenticator {
182	struct wpa_group *group;
183
184	unsigned int dot11RSNAStatsTKIPRemoteMICFailures;
185	u32 dot11RSNAAuthenticationSuiteSelected;
186	u32 dot11RSNAPairwiseCipherSelected;
187	u32 dot11RSNAGroupCipherSelected;
188	u8 dot11RSNAPMKIDUsed[PMKID_LEN];
189	u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */
190	u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */
191	u32 dot11RSNAGroupCipherRequested; /* FIX: update */
192	unsigned int dot11RSNATKIPCounterMeasuresInvoked;
193	unsigned int dot11RSNA4WayHandshakeFailures;
194
195	struct wpa_stsl_negotiation *stsl_negotiations;
196
197	struct wpa_auth_config conf;
198	struct wpa_auth_callbacks cb;
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
214int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len,
215		     const u8 *pmkid);
216void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
217		     logger_level level, const char *txt);
218void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
219		      logger_level level, const char *fmt, ...);
220void __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);
225int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
226			  int (*cb)(struct wpa_state_machine *sm, void *ctx),
227			  void *cb_ctx);
228int 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
233int wpa_stsl_remove(struct wpa_authenticator *wpa_auth,
234		    struct wpa_stsl_negotiation *neg);
235void wpa_smk_error(struct wpa_authenticator *wpa_auth,
236		   struct wpa_state_machine *sm,
237		   const u8 *key_data, size_t key_data_len);
238void wpa_smk_m1(struct wpa_authenticator *wpa_auth,
239		struct wpa_state_machine *sm, struct wpa_eapol_key *key,
240		const u8 *key_data, size_t key_data_len);
241void wpa_smk_m3(struct wpa_authenticator *wpa_auth,
242		struct wpa_state_machine *sm, struct wpa_eapol_key *key,
243		const u8 *key_data, size_t key_data_len);
244#endif /* CONFIG_PEERKEY */
245
246#ifdef CONFIG_IEEE80211R
247int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len);
248int wpa_write_ftie(struct wpa_auth_config *conf, const u8 *r0kh_id,
249		   size_t r0kh_id_len,
250		   const u8 *anonce, const u8 *snonce,
251		   u8 *buf, size_t len, const u8 *subelem,
252		   size_t subelem_len);
253int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, const u8 *pmk,
254			   struct wpa_ptk *ptk);
255struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void);
256void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache);
257void wpa_ft_install_ptk(struct wpa_state_machine *sm);
258#endif /* CONFIG_IEEE80211R */
259
260#endif /* WPA_AUTH_I_H */
261