]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/ap/wpa_auth.h
Fix Suite B 192-bit AKM to use proper PMK length
[thirdparty/hostap.git] / src / ap / wpa_auth.h
CommitLineData
6fc6879b
JM
1/*
2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator
bc02843e 3 * Copyright (c) 2004-2015, Jouni Malinen <j@w1.fi>
6fc6879b 4 *
0f3d578e
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
6fc6879b
JM
7 */
8
9#ifndef WPA_AUTH_H
10#define WPA_AUTH_H
11
90973fb2
JM
12#include "common/defs.h"
13#include "common/eapol_common.h"
14#include "common/wpa_common.h"
d6c3067d 15#include "common/ieee802_11_defs.h"
6fc6879b 16
bc02843e
JM
17#define MAX_OWN_IE_OVERRIDE 256
18
6fc6879b
JM
19#ifdef _MSC_VER
20#pragma pack(push, 1)
21#endif /* _MSC_VER */
22
c1e033b0
JM
23/* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
24 */
6fc6879b
JM
25struct ft_rrb_frame {
26 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
27 u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
2eba45c8 28 le16 action_length; /* little endian length of action_frame */
6fc6879b
JM
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
6fc6879b
JM
45#define FT_R0KH_R1KH_PULL_DATA_LEN 44
46#define FT_R0KH_R1KH_RESP_DATA_LEN 76
1b484d60 47#define FT_R0KH_R1KH_PUSH_DATA_LEN 88
692ec305 48#define FT_R0KH_R1KH_PULL_NONCE_LEN 16
6fc6879b
JM
49
50struct ft_r0kh_r1kh_pull_frame {
51 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
52 u8 packet_type; /* FT_PACKET_R0KH_R1KH_PULL */
2eba45c8 53 le16 data_length; /* little endian length of data (44) */
6fc6879b
JM
54 u8 ap_address[ETH_ALEN];
55
692ec305 56 u8 nonce[FT_R0KH_R1KH_PULL_NONCE_LEN];
6fc6879b
JM
57 u8 pmk_r0_name[WPA_PMK_NAME_LEN];
58 u8 r1kh_id[FT_R1KH_ID_LEN];
59 u8 s1kh_id[ETH_ALEN];
60 u8 pad[4]; /* 8-octet boundary for AES key wrap */
61 u8 key_wrap_extra[8];
62} STRUCT_PACKED;
63
64struct ft_r0kh_r1kh_resp_frame {
65 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
66 u8 packet_type; /* FT_PACKET_R0KH_R1KH_RESP */
2eba45c8 67 le16 data_length; /* little endian length of data (76) */
6fc6879b
JM
68 u8 ap_address[ETH_ALEN];
69
692ec305 70 u8 nonce[FT_R0KH_R1KH_PULL_NONCE_LEN]; /* copied from pull */
6fc6879b
JM
71 u8 r1kh_id[FT_R1KH_ID_LEN]; /* copied from pull */
72 u8 s1kh_id[ETH_ALEN]; /* copied from pull */
73 u8 pmk_r1[PMK_LEN];
74 u8 pmk_r1_name[WPA_PMK_NAME_LEN];
1b484d60
JM
75 le16 pairwise;
76 u8 pad[2]; /* 8-octet boundary for AES key wrap */
6fc6879b
JM
77 u8 key_wrap_extra[8];
78} STRUCT_PACKED;
79
80struct ft_r0kh_r1kh_push_frame {
81 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
82 u8 packet_type; /* FT_PACKET_R0KH_R1KH_PUSH */
1b484d60 83 le16 data_length; /* little endian length of data (88) */
6fc6879b
JM
84 u8 ap_address[ETH_ALEN];
85
86 /* Encrypted with AES key-wrap */
87 u8 timestamp[4]; /* current time in seconds since unix epoch, little
88 * endian */
89 u8 r1kh_id[FT_R1KH_ID_LEN];
90 u8 s1kh_id[ETH_ALEN];
91 u8 pmk_r0_name[WPA_PMK_NAME_LEN];
92 u8 pmk_r1[PMK_LEN];
93 u8 pmk_r1_name[WPA_PMK_NAME_LEN];
1b484d60
JM
94 le16 pairwise;
95 u8 pad[6]; /* 8-octet boundary for AES key wrap */
6fc6879b
JM
96 u8 key_wrap_extra[8];
97} STRUCT_PACKED;
98
99#ifdef _MSC_VER
100#pragma pack(pop)
101#endif /* _MSC_VER */
102
103
104/* per STA state machine data */
105
106struct wpa_authenticator;
107struct wpa_state_machine;
108struct rsn_pmksa_cache_entry;
109struct eapol_state_machine;
110
111
112struct ft_remote_r0kh {
113 struct ft_remote_r0kh *next;
114 u8 addr[ETH_ALEN];
115 u8 id[FT_R0KH_ID_MAX_LEN];
116 size_t id_len;
117 u8 key[16];
118};
119
120
121struct ft_remote_r1kh {
122 struct ft_remote_r1kh *next;
123 u8 addr[ETH_ALEN];
124 u8 id[FT_R1KH_ID_LEN];
125 u8 key[16];
126};
127
128
129struct wpa_auth_config {
130 int wpa;
131 int wpa_key_mgmt;
132 int wpa_pairwise;
133 int wpa_group;
134 int wpa_group_rekey;
135 int wpa_strict_rekey;
136 int wpa_gmk_rekey;
581a8cde 137 int wpa_ptk_rekey;
6fc6879b
JM
138 int rsn_pairwise;
139 int rsn_preauth;
140 int eapol_version;
141 int peerkey;
3ae0800c 142 int wmm_enabled;
721abef9 143 int wmm_uapsd;
cb465555 144 int disable_pmksa_caching;
bf98f7f3 145 int okc;
e4bf4db9 146 int tx_status;
6fc6879b 147#ifdef CONFIG_IEEE80211W
70f8cc8e 148 enum mfp_options ieee80211w;
8dd9f9cd 149 int group_mgmt_cipher;
6fc6879b
JM
150#endif /* CONFIG_IEEE80211W */
151#ifdef CONFIG_IEEE80211R
d6c3067d 152 u8 ssid[SSID_MAX_LEN];
6fc6879b
JM
153 size_t ssid_len;
154 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
155 u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
156 size_t r0_key_holder_len;
157 u8 r1_key_holder[FT_R1KH_ID_LEN];
158 u32 r0_key_lifetime;
159 u32 reassociation_deadline;
160 struct ft_remote_r0kh *r0kh_list;
161 struct ft_remote_r1kh *r1kh_list;
162 int pmk_r1_push;
d7956add 163 int ft_over_ds;
6fc6879b 164#endif /* CONFIG_IEEE80211R */
83421850 165 int disable_gtk;
88b32a99 166 int ap_mlme;
7af092a0
JB
167#ifdef CONFIG_TESTING_OPTIONS
168 double corrupt_gtk_rekey_mic_probability;
bc02843e
JM
169 u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
170 size_t own_ie_override_len;
7af092a0 171#endif /* CONFIG_TESTING_OPTIONS */
25ef8529
JM
172#ifdef CONFIG_P2P
173 u8 ip_addr_go[4];
174 u8 ip_addr_mask[4];
175 u8 ip_addr_start[4];
176 u8 ip_addr_end[4];
177#endif /* CONFIG_P2P */
6fc6879b
JM
178};
179
180typedef enum {
181 LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
182} logger_level;
183
184typedef enum {
185 WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
186 WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
187 WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
188} wpa_eapol_variable;
189
190struct wpa_auth_callbacks {
191 void *ctx;
192 void (*logger)(void *ctx, const u8 *addr, logger_level level,
193 const char *txt);
194 void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
c772d054 195 int (*mic_failure_report)(void *ctx, const u8 *addr);
2c502460 196 void (*psk_failure_report)(void *ctx, const u8 *addr);
6fc6879b
JM
197 void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
198 int value);
199 int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
759fd76b
JM
200 const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
201 const u8 *prev_psk);
6fc6879b 202 int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
71934751
JM
203 int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
204 const u8 *addr, int idx, u8 *key, size_t key_len);
6fc6879b 205 int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
6fc6879b
JM
206 int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
207 size_t data_len, int encrypt);
208 int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
209 void *ctx), void *cb_ctx);
bf98f7f3
JM
210 int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
211 void *ctx), void *cb_ctx);
6fc6879b
JM
212 int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
213 size_t data_len);
214#ifdef CONFIG_IEEE80211R
215 struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
216 int (*send_ft_action)(void *ctx, const u8 *dst,
217 const u8 *data, size_t data_len);
88b32a99 218 int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
006309b5 219 size_t tspec_ielen);
6fc6879b 220#endif /* CONFIG_IEEE80211R */
0f950df0
TP
221#ifdef CONFIG_MESH
222 int (*start_ampe)(void *ctx, const u8 *sta_addr);
223#endif /* CONFIG_MESH */
6fc6879b
JM
224};
225
226struct wpa_authenticator * wpa_init(const u8 *addr,
227 struct wpa_auth_config *conf,
228 struct wpa_auth_callbacks *cb);
bdffdc5d 229int wpa_init_keys(struct wpa_authenticator *wpa_auth);
6fc6879b
JM
230void wpa_deinit(struct wpa_authenticator *wpa_auth);
231int wpa_reconfig(struct wpa_authenticator *wpa_auth,
232 struct wpa_auth_config *conf);
233
234enum {
235 WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
236 WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
237 WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
2100a768 238 WPA_INVALID_MDIE, WPA_INVALID_PROTO
6fc6879b
JM
239};
240
241int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
242 struct wpa_state_machine *sm,
243 const u8 *wpa_ie, size_t wpa_ie_len,
244 const u8 *mdie, size_t mdie_len);
a14896e8
JM
245int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
246 struct wpa_state_machine *sm,
247 const u8 *osen_ie, size_t osen_ie_len);
f3f7540e 248int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
6fc6879b 249struct wpa_state_machine *
94ddef3e
JM
250wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
251 const u8 *p2p_dev_addr);
6f9b5d16
JM
252int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
253 struct wpa_state_machine *sm);
a8d05fca 254void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
6fc6879b
JM
255void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
256void wpa_receive(struct wpa_authenticator *wpa_auth,
257 struct wpa_state_machine *sm,
258 u8 *data, size_t data_len);
bb119228 259enum wpa_event {
6fc6879b
JM
260 WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
261 WPA_REAUTH_EAPOL, WPA_ASSOC_FT
bb119228 262};
6fc6879b 263void wpa_remove_ptk(struct wpa_state_machine *sm);
bb119228 264int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
6fc6879b
JM
265void wpa_auth_sm_notify(struct wpa_state_machine *sm);
266void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
267int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
268int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
269void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
270int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
ff36ff00 271int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
6fc6879b
JM
272int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
273int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
274int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
275 struct rsn_pmksa_cache_entry *entry);
276struct rsn_pmksa_cache_entry *
277wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
278void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
279const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
280 size_t *len);
281int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
207976f0 282 unsigned int pmk_len,
6fc6879b
JM
283 int session_timeout, struct eapol_state_machine *eapol);
284int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
285 const u8 *pmk, size_t len, const u8 *sta_addr,
286 int session_timeout,
287 struct eapol_state_machine *eapol);
f2991170
JM
288int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
289 const u8 *pmk);
901d1fe1
JM
290void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
291 const u8 *sta_addr);
6fc6879b 292int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
e4bf4db9
JM
293void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
294 struct wpa_state_machine *sm, int ack);
6fc6879b
JM
295
296#ifdef CONFIG_IEEE80211R
297u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
f238cf9f
JM
298 size_t max_len, int auth_alg,
299 const u8 *req_ies, size_t req_ies_len);
6fc6879b
JM
300void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid,
301 u16 auth_transaction, const u8 *ies, size_t ies_len,
302 void (*cb)(void *ctx, const u8 *dst, const u8 *bssid,
303 u16 auth_transaction, u16 resp,
304 const u8 *ies, size_t ies_len),
305 void *ctx);
306u16 wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
307 size_t ies_len);
308int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
309int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
310 const u8 *data, size_t data_len);
311void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
312#endif /* CONFIG_IEEE80211R */
313
d32d94db
XC
314void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
315void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
316int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos);
d32d94db 317int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);
d32d94db 318
c10347f2 319int wpa_auth_uses_sae(struct wpa_state_machine *sm);
aa189ac9 320int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
c10347f2 321
25ef8529
JM
322int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);
323
cbc210de
JM
324struct radius_das_attrs;
325int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
326 struct radius_das_attrs *attr);
34782730 327void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
cbc210de 328
7cebc8e2
MB
329int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
330int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
331
6fc6879b 332#endif /* WPA_AUTH_H */