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_MAX];
64	unsigned int pmk_len;
65	struct wpa_ptk PTK;
66	Boolean PTK_valid;
67	Boolean pairwise_set;
68	Boolean tk_already_set;
69	int keycount;
70	Boolean Pair;
71	struct wpa_key_replay_counter {
72		u8 counter[WPA_REPLAY_COUNTER_LEN];
73		Boolean valid;
74	} key_replay[RSNA_MAX_EAPOL_RETRIES],
75		prev_key_replay[RSNA_MAX_EAPOL_RETRIES];
76	Boolean PInitAKeys; /* WPA only, not in IEEE 802.11i */
77	Boolean PTKRequest; /* not in IEEE 802.11i state machine */
78	Boolean has_GTK;
79	Boolean PtkGroupInit; /* init request for PTK Group state machine */
80
81	u8 *last_rx_eapol_key; /* starting from IEEE 802.1X header */
82	size_t last_rx_eapol_key_len;
83
84	unsigned int changed:1;
85	unsigned int in_step_loop:1;
86	unsigned int pending_deinit:1;
87	unsigned int started:1;
88	unsigned int mgmt_frame_prot:1;
89	unsigned int rx_eapol_key_secure:1;
90	unsigned int update_snonce:1;
91	unsigned int alt_snonce_valid:1;
92#ifdef CONFIG_IEEE80211R
93	unsigned int ft_completed:1;
94	unsigned int pmk_r1_name_valid:1;
95#endif /* CONFIG_IEEE80211R */
96	unsigned int is_wnmsleep:1;
97
98	u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN];
99	int req_replay_counter_used;
100
101	u8 *wpa_ie;
102	size_t wpa_ie_len;
103
104	enum {
105		WPA_VERSION_NO_WPA = 0 /* WPA not used */,
106		WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */,
107		WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */
108	} wpa;
109	int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */
110	int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */
111	struct rsn_pmksa_cache_entry *pmksa;
112
113	u32 dot11RSNAStatsTKIPLocalMICFailures;
114	u32 dot11RSNAStatsTKIPRemoteMICFailures;
115
116#ifdef CONFIG_IEEE80211R
117	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
118	size_t xxkey_len;
119	u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth
120					   * Request */
121	u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */
122	size_t r0kh_id_len;
123	u8 sup_pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name from EAPOL-Key
124					       * message 2/4 */
125	u8 *assoc_resp_ftie;
126
127	void (*ft_pending_cb)(void *ctx, const u8 *dst, const u8 *bssid,
128			      u16 auth_transaction, u16 status,
129			      const u8 *ies, size_t ies_len);
130	void *ft_pending_cb_ctx;
131	struct wpabuf *ft_pending_req_ies;
132	u8 ft_pending_pull_nonce[FT_R0KH_R1KH_PULL_NONCE_LEN];
133	u8 ft_pending_auth_transaction;
134	u8 ft_pending_current_ap[ETH_ALEN];
135#endif /* CONFIG_IEEE80211R */
136
137	int pending_1_of_4_timeout;
138
139#ifdef CONFIG_P2P
140	u8 ip_addr[4];
141#endif /* CONFIG_P2P */
142};
143
144
145/* per group key state machine data */
146struct wpa_group {
147	struct wpa_group *next;
148	int vlan_id;
149
150	Boolean GInit;
151	int GKeyDoneStations;
152	Boolean GTKReKey;
153	int GTK_len;
154	int GN, GM;
155	Boolean GTKAuthenticator;
156	u8 Counter[WPA_NONCE_LEN];
157
158	enum {
159		WPA_GROUP_GTK_INIT = 0,
160		WPA_GROUP_SETKEYS, WPA_GROUP_SETKEYSDONE,
161		WPA_GROUP_FATAL_FAILURE
162	} wpa_group_state;
163
164	u8 GMK[WPA_GMK_LEN];
165	u8 GTK[2][WPA_GTK_MAX_LEN];
166	u8 GNonce[WPA_NONCE_LEN];
167	Boolean changed;
168	Boolean first_sta_seen;
169	Boolean reject_4way_hs_for_entropy;
170#ifdef CONFIG_IEEE80211W
171	u8 IGTK[2][WPA_IGTK_MAX_LEN];
172	int GN_igtk, GM_igtk;
173#endif /* CONFIG_IEEE80211W */
174	/* Number of references except those in struct wpa_group->next */
175	unsigned int references;
176	unsigned int num_setup_iface;
177};
178
179
180struct wpa_ft_pmk_cache;
181
182/* per authenticator data */
183struct wpa_authenticator {
184	struct wpa_group *group;
185
186	unsigned int dot11RSNAStatsTKIPRemoteMICFailures;
187	u32 dot11RSNAAuthenticationSuiteSelected;
188	u32 dot11RSNAPairwiseCipherSelected;
189	u32 dot11RSNAGroupCipherSelected;
190	u8 dot11RSNAPMKIDUsed[PMKID_LEN];
191	u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */
192	u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */
193	u32 dot11RSNAGroupCipherRequested; /* FIX: update */
194	unsigned int dot11RSNATKIPCounterMeasuresInvoked;
195	unsigned int dot11RSNA4WayHandshakeFailures;
196
197	struct wpa_stsl_negotiation *stsl_negotiations;
198
199	struct wpa_auth_config conf;
200	struct wpa_auth_callbacks cb;
201
202	u8 *wpa_ie;
203	size_t wpa_ie_len;
204
205	u8 addr[ETH_ALEN];
206
207	struct rsn_pmksa_cache *pmksa;
208	struct wpa_ft_pmk_cache *ft_pmk_cache;
209
210#ifdef CONFIG_P2P
211	struct bitfield *ip_pool;
212#endif /* CONFIG_P2P */
213};
214
215
216int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len,
217		     const u8 *pmkid);
218void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
219		     logger_level level, const char *txt);
220void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
221		      logger_level level, const char *fmt, ...);
222void __wpa_send_eapol(struct wpa_authenticator *wpa_auth,
223		      struct wpa_state_machine *sm, int key_info,
224		      const u8 *key_rsc, const u8 *nonce,
225		      const u8 *kde, size_t kde_len,
226		      int keyidx, int encr, int force_version);
227int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
228			  int (*cb)(struct wpa_state_machine *sm, void *ctx),
229			  void *cb_ctx);
230int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth,
231			   int (*cb)(struct wpa_authenticator *a, void *ctx),
232			   void *cb_ctx);
233
234#ifdef CONFIG_PEERKEY
235int wpa_stsl_remove(struct wpa_authenticator *wpa_auth,
236		    struct wpa_stsl_negotiation *neg);
237void wpa_smk_error(struct wpa_authenticator *wpa_auth,
238		   struct wpa_state_machine *sm,
239		   const u8 *key_data, size_t key_data_len);
240void wpa_smk_m1(struct wpa_authenticator *wpa_auth,
241		struct wpa_state_machine *sm, struct wpa_eapol_key *key,
242		const u8 *key_data, size_t key_data_len);
243void wpa_smk_m3(struct wpa_authenticator *wpa_auth,
244		struct wpa_state_machine *sm, struct wpa_eapol_key *key,
245		const u8 *key_data, size_t key_data_len);
246#endif /* CONFIG_PEERKEY */
247
248#ifdef CONFIG_IEEE80211R
249int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len);
250int wpa_write_ftie(struct wpa_auth_config *conf, const u8 *r0kh_id,
251		   size_t r0kh_id_len,
252		   const u8 *anonce, const u8 *snonce,
253		   u8 *buf, size_t len, const u8 *subelem,
254		   size_t subelem_len);
255int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, const u8 *pmk,
256			   struct wpa_ptk *ptk);
257struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void);
258void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache);
259void wpa_ft_install_ptk(struct wpa_state_machine *sm);
260#endif /* CONFIG_IEEE80211R */
261
262#endif /* WPA_AUTH_I_H */
263