1/*
2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator
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_H
10#define WPA_AUTH_H
11
12#include "common/defs.h"
13#include "common/eapol_common.h"
14#include "common/wpa_common.h"
15#include "common/ieee802_11_defs.h"
16
17#define MAX_OWN_IE_OVERRIDE 256
18
19#ifdef _MSC_VER
20#pragma pack(push, 1)
21#endif /* _MSC_VER */
22
23/* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
24 */
25struct ft_rrb_frame {
26	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
27	u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
28	le16 action_length; /* little endian length of action_frame */
29	u8 ap_address[ETH_ALEN];
30	/*
31	 * Followed by action_length bytes of FT Action frame (from Category
32	 * field to the end of Action Frame body.
33	 */
34} STRUCT_PACKED;
35
36#define RSN_REMOTE_FRAME_TYPE_FT_RRB 1
37
38#define FT_PACKET_REQUEST 0
39#define FT_PACKET_RESPONSE 1
40/* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r */
41#define FT_PACKET_R0KH_R1KH_PULL 200
42#define FT_PACKET_R0KH_R1KH_RESP 201
43#define FT_PACKET_R0KH_R1KH_PUSH 202
44
45#define FT_R0KH_R1KH_PULL_NONCE_LEN 16
46#define FT_R0KH_R1KH_PULL_DATA_LEN (FT_R0KH_R1KH_PULL_NONCE_LEN + \
47				    WPA_PMK_NAME_LEN + FT_R1KH_ID_LEN + \
48				    ETH_ALEN)
49#define FT_R0KH_R1KH_PULL_PAD_LEN ((8 - FT_R0KH_R1KH_PULL_DATA_LEN % 8) % 8)
50
51struct ft_r0kh_r1kh_pull_frame {
52	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
53	u8 packet_type; /* FT_PACKET_R0KH_R1KH_PULL */
54	le16 data_length; /* little endian length of data (44) */
55	u8 ap_address[ETH_ALEN];
56
57	u8 nonce[FT_R0KH_R1KH_PULL_NONCE_LEN];
58	u8 pmk_r0_name[WPA_PMK_NAME_LEN];
59	u8 r1kh_id[FT_R1KH_ID_LEN];
60	u8 s1kh_id[ETH_ALEN];
61	u8 pad[FT_R0KH_R1KH_PULL_PAD_LEN]; /* 8-octet boundary for AES block */
62	u8 key_wrap_extra[8];
63} STRUCT_PACKED;
64
65#define FT_R0KH_R1KH_RESP_DATA_LEN (FT_R0KH_R1KH_PULL_NONCE_LEN + \
66				    FT_R1KH_ID_LEN + ETH_ALEN + PMK_LEN + \
67				    WPA_PMK_NAME_LEN + 2)
68#define FT_R0KH_R1KH_RESP_PAD_LEN ((8 - FT_R0KH_R1KH_RESP_DATA_LEN % 8) % 8)
69struct ft_r0kh_r1kh_resp_frame {
70	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
71	u8 packet_type; /* FT_PACKET_R0KH_R1KH_RESP */
72	le16 data_length; /* little endian length of data (78) */
73	u8 ap_address[ETH_ALEN];
74
75	u8 nonce[FT_R0KH_R1KH_PULL_NONCE_LEN]; /* copied from pull */
76	u8 r1kh_id[FT_R1KH_ID_LEN]; /* copied from pull */
77	u8 s1kh_id[ETH_ALEN]; /* copied from pull */
78	u8 pmk_r1[PMK_LEN];
79	u8 pmk_r1_name[WPA_PMK_NAME_LEN];
80	le16 pairwise;
81	u8 pad[FT_R0KH_R1KH_RESP_PAD_LEN]; /* 8-octet boundary for AES block */
82	u8 key_wrap_extra[8];
83} STRUCT_PACKED;
84
85#define FT_R0KH_R1KH_PUSH_DATA_LEN (4 + FT_R1KH_ID_LEN + ETH_ALEN + \
86				    WPA_PMK_NAME_LEN + PMK_LEN + \
87				    WPA_PMK_NAME_LEN + 2)
88#define FT_R0KH_R1KH_PUSH_PAD_LEN ((8 - FT_R0KH_R1KH_PUSH_DATA_LEN % 8) % 8)
89struct ft_r0kh_r1kh_push_frame {
90	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
91	u8 packet_type; /* FT_PACKET_R0KH_R1KH_PUSH */
92	le16 data_length; /* little endian length of data (82) */
93	u8 ap_address[ETH_ALEN];
94
95	/* Encrypted with AES key-wrap */
96	u8 timestamp[4]; /* current time in seconds since unix epoch, little
97			  * endian */
98	u8 r1kh_id[FT_R1KH_ID_LEN];
99	u8 s1kh_id[ETH_ALEN];
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	le16 pairwise;
104	u8 pad[FT_R0KH_R1KH_PUSH_PAD_LEN]; /* 8-octet boundary for AES block */
105	u8 key_wrap_extra[8];
106} STRUCT_PACKED;
107
108#ifdef _MSC_VER
109#pragma pack(pop)
110#endif /* _MSC_VER */
111
112
113/* per STA state machine data */
114
115struct wpa_authenticator;
116struct wpa_state_machine;
117struct rsn_pmksa_cache_entry;
118struct eapol_state_machine;
119
120
121struct ft_remote_r0kh {
122	struct ft_remote_r0kh *next;
123	u8 addr[ETH_ALEN];
124	u8 id[FT_R0KH_ID_MAX_LEN];
125	size_t id_len;
126	u8 key[16];
127};
128
129
130struct ft_remote_r1kh {
131	struct ft_remote_r1kh *next;
132	u8 addr[ETH_ALEN];
133	u8 id[FT_R1KH_ID_LEN];
134	u8 key[16];
135};
136
137
138struct wpa_auth_config {
139	int wpa;
140	int wpa_key_mgmt;
141	int wpa_pairwise;
142	int wpa_group;
143	int wpa_group_rekey;
144	int wpa_strict_rekey;
145	int wpa_gmk_rekey;
146	int wpa_ptk_rekey;
147	int rsn_pairwise;
148	int rsn_preauth;
149	int eapol_version;
150	int peerkey;
151	int wmm_enabled;
152	int wmm_uapsd;
153	int disable_pmksa_caching;
154	int okc;
155	int tx_status;
156#ifdef CONFIG_IEEE80211W
157	enum mfp_options ieee80211w;
158	int group_mgmt_cipher;
159#endif /* CONFIG_IEEE80211W */
160#ifdef CONFIG_IEEE80211R
161	u8 ssid[SSID_MAX_LEN];
162	size_t ssid_len;
163	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
164	u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
165	size_t r0_key_holder_len;
166	u8 r1_key_holder[FT_R1KH_ID_LEN];
167	u32 r0_key_lifetime;
168	u32 reassociation_deadline;
169	struct ft_remote_r0kh *r0kh_list;
170	struct ft_remote_r1kh *r1kh_list;
171	int pmk_r1_push;
172	int ft_over_ds;
173#endif /* CONFIG_IEEE80211R */
174	int disable_gtk;
175	int ap_mlme;
176#ifdef CONFIG_TESTING_OPTIONS
177	double corrupt_gtk_rekey_mic_probability;
178	u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
179	size_t own_ie_override_len;
180#endif /* CONFIG_TESTING_OPTIONS */
181#ifdef CONFIG_P2P
182	u8 ip_addr_go[4];
183	u8 ip_addr_mask[4];
184	u8 ip_addr_start[4];
185	u8 ip_addr_end[4];
186#endif /* CONFIG_P2P */
187};
188
189typedef enum {
190	LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
191} logger_level;
192
193typedef enum {
194	WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
195	WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
196	WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
197} wpa_eapol_variable;
198
199struct wpa_auth_callbacks {
200	void *ctx;
201	void (*logger)(void *ctx, const u8 *addr, logger_level level,
202		       const char *txt);
203	void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
204	int (*mic_failure_report)(void *ctx, const u8 *addr);
205	void (*psk_failure_report)(void *ctx, const u8 *addr);
206	void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
207			  int value);
208	int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
209	const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
210			      const u8 *prev_psk);
211	int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
212	int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
213		       const u8 *addr, int idx, u8 *key, size_t key_len);
214	int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
215	int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
216			  size_t data_len, int encrypt);
217	int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
218						 void *ctx), void *cb_ctx);
219	int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
220						  void *ctx), void *cb_ctx);
221	int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
222			  size_t data_len);
223#ifdef CONFIG_IEEE80211R
224	struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
225	int (*send_ft_action)(void *ctx, const u8 *dst,
226			      const u8 *data, size_t data_len);
227	int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
228			 size_t tspec_ielen);
229#endif /* CONFIG_IEEE80211R */
230#ifdef CONFIG_MESH
231	int (*start_ampe)(void *ctx, const u8 *sta_addr);
232#endif /* CONFIG_MESH */
233};
234
235struct wpa_authenticator * wpa_init(const u8 *addr,
236				    struct wpa_auth_config *conf,
237				    struct wpa_auth_callbacks *cb);
238int wpa_init_keys(struct wpa_authenticator *wpa_auth);
239void wpa_deinit(struct wpa_authenticator *wpa_auth);
240int wpa_reconfig(struct wpa_authenticator *wpa_auth,
241		 struct wpa_auth_config *conf);
242
243enum {
244	WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
245	WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
246	WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
247	WPA_INVALID_MDIE, WPA_INVALID_PROTO
248};
249
250int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
251			struct wpa_state_machine *sm,
252			const u8 *wpa_ie, size_t wpa_ie_len,
253			const u8 *mdie, size_t mdie_len);
254int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
255		      struct wpa_state_machine *sm,
256		      const u8 *osen_ie, size_t osen_ie_len);
257int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
258struct wpa_state_machine *
259wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
260		  const u8 *p2p_dev_addr);
261int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
262			    struct wpa_state_machine *sm);
263void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
264void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
265void wpa_receive(struct wpa_authenticator *wpa_auth,
266		 struct wpa_state_machine *sm,
267		 u8 *data, size_t data_len);
268enum wpa_event {
269	WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
270	WPA_REAUTH_EAPOL, WPA_ASSOC_FT, WPA_DRV_STA_REMOVED
271};
272void wpa_remove_ptk(struct wpa_state_machine *sm);
273int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
274void wpa_auth_sm_notify(struct wpa_state_machine *sm);
275void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
276int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
277int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
278void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
279int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
280int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
281int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
282int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
283int wpa_auth_sta_ft_tk_already_set(struct wpa_state_machine *sm);
284int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
285			     struct rsn_pmksa_cache_entry *entry);
286struct rsn_pmksa_cache_entry *
287wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
288void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
289const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
290			       size_t *len);
291int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
292		       unsigned int pmk_len,
293		       int session_timeout, struct eapol_state_machine *eapol);
294int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
295			       const u8 *pmk, size_t len, const u8 *sta_addr,
296			       int session_timeout,
297			       struct eapol_state_machine *eapol);
298int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
299			   const u8 *pmk, const u8 *pmkid);
300void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
301			   const u8 *sta_addr);
302int wpa_auth_pmksa_list(struct wpa_authenticator *wpa_auth, char *buf,
303			size_t len);
304void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
305struct rsn_pmksa_cache_entry *
306wpa_auth_pmksa_get(struct wpa_authenticator *wpa_auth, const u8 *sta_addr);
307void wpa_auth_pmksa_set_to_sm(struct rsn_pmksa_cache_entry *pmksa,
308			      struct wpa_state_machine *sm,
309			      struct wpa_authenticator *wpa_auth,
310			      u8 *pmkid, u8 *pmk);
311int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
312void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
313				  struct wpa_state_machine *sm, int ack);
314
315#ifdef CONFIG_IEEE80211R
316u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
317				 size_t max_len, int auth_alg,
318				 const u8 *req_ies, size_t req_ies_len);
319void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid,
320			 u16 auth_transaction, const u8 *ies, size_t ies_len,
321			 void (*cb)(void *ctx, const u8 *dst, const u8 *bssid,
322				    u16 auth_transaction, u16 resp,
323				    const u8 *ies, size_t ies_len),
324			 void *ctx);
325u16 wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
326			    size_t ies_len);
327int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
328int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
329		  const u8 *data, size_t data_len);
330void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
331#endif /* CONFIG_IEEE80211R */
332
333void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
334void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
335int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos);
336int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);
337
338int wpa_auth_uses_sae(struct wpa_state_machine *sm);
339int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
340
341int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);
342
343struct radius_das_attrs;
344int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
345					 struct radius_das_attrs *attr);
346void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
347
348int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
349int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
350
351#endif /* WPA_AUTH_H */
352