]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/ap/wpa_auth.h
FILS: Export IEEE 802.1X helper functions
[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
692ec305 45#define FT_R0KH_R1KH_PULL_NONCE_LEN 16
0270bded
MB
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)
6fc6879b
JM
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 */
2eba45c8 54 le16 data_length; /* little endian length of data (44) */
6fc6879b
JM
55 u8 ap_address[ETH_ALEN];
56
692ec305 57 u8 nonce[FT_R0KH_R1KH_PULL_NONCE_LEN];
6fc6879b
JM
58 u8 pmk_r0_name[WPA_PMK_NAME_LEN];
59 u8 r1kh_id[FT_R1KH_ID_LEN];
60 u8 s1kh_id[ETH_ALEN];
0270bded 61 u8 pad[FT_R0KH_R1KH_PULL_PAD_LEN]; /* 8-octet boundary for AES block */
6fc6879b
JM
62 u8 key_wrap_extra[8];
63} STRUCT_PACKED;
64
0270bded
MB
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)
6fc6879b
JM
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 */
0270bded 72 le16 data_length; /* little endian length of data (78) */
6fc6879b
JM
73 u8 ap_address[ETH_ALEN];
74
692ec305 75 u8 nonce[FT_R0KH_R1KH_PULL_NONCE_LEN]; /* copied from pull */
6fc6879b
JM
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];
1b484d60 80 le16 pairwise;
0270bded 81 u8 pad[FT_R0KH_R1KH_RESP_PAD_LEN]; /* 8-octet boundary for AES block */
6fc6879b
JM
82 u8 key_wrap_extra[8];
83} STRUCT_PACKED;
84
0270bded
MB
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)
6fc6879b
JM
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 */
0270bded 92 le16 data_length; /* little endian length of data (82) */
6fc6879b
JM
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];
1b484d60 103 le16 pairwise;
0270bded 104 u8 pad[FT_R0KH_R1KH_PUSH_PAD_LEN]; /* 8-octet boundary for AES block */
6fc6879b
JM
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;
581a8cde 146 int wpa_ptk_rekey;
6fc6879b
JM
147 int rsn_pairwise;
148 int rsn_preauth;
149 int eapol_version;
150 int peerkey;
3ae0800c 151 int wmm_enabled;
721abef9 152 int wmm_uapsd;
cb465555 153 int disable_pmksa_caching;
bf98f7f3 154 int okc;
e4bf4db9 155 int tx_status;
6fc6879b 156#ifdef CONFIG_IEEE80211W
70f8cc8e 157 enum mfp_options ieee80211w;
8dd9f9cd 158 int group_mgmt_cipher;
6fc6879b
JM
159#endif /* CONFIG_IEEE80211W */
160#ifdef CONFIG_IEEE80211R
d6c3067d 161 u8 ssid[SSID_MAX_LEN];
6fc6879b
JM
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;
d7956add 172 int ft_over_ds;
96590564 173 int ft_psk_generate_local;
6fc6879b 174#endif /* CONFIG_IEEE80211R */
83421850 175 int disable_gtk;
88b32a99 176 int ap_mlme;
7af092a0
JB
177#ifdef CONFIG_TESTING_OPTIONS
178 double corrupt_gtk_rekey_mic_probability;
bc02843e
JM
179 u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
180 size_t own_ie_override_len;
7af092a0 181#endif /* CONFIG_TESTING_OPTIONS */
25ef8529
JM
182#ifdef CONFIG_P2P
183 u8 ip_addr_go[4];
184 u8 ip_addr_mask[4];
185 u8 ip_addr_start[4];
186 u8 ip_addr_end[4];
187#endif /* CONFIG_P2P */
6fc6879b
JM
188};
189
190typedef enum {
191 LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
192} logger_level;
193
194typedef enum {
195 WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
196 WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
197 WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
198} wpa_eapol_variable;
199
200struct wpa_auth_callbacks {
201 void *ctx;
202 void (*logger)(void *ctx, const u8 *addr, logger_level level,
203 const char *txt);
204 void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
c772d054 205 int (*mic_failure_report)(void *ctx, const u8 *addr);
2c502460 206 void (*psk_failure_report)(void *ctx, const u8 *addr);
6fc6879b
JM
207 void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
208 int value);
209 int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
759fd76b
JM
210 const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
211 const u8 *prev_psk);
6fc6879b 212 int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
71934751
JM
213 int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
214 const u8 *addr, int idx, u8 *key, size_t key_len);
6fc6879b 215 int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
6fc6879b
JM
216 int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
217 size_t data_len, int encrypt);
218 int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
219 void *ctx), void *cb_ctx);
bf98f7f3
JM
220 int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
221 void *ctx), void *cb_ctx);
6fc6879b
JM
222 int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
223 size_t data_len);
224#ifdef CONFIG_IEEE80211R
225 struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
226 int (*send_ft_action)(void *ctx, const u8 *dst,
227 const u8 *data, size_t data_len);
88b32a99 228 int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
006309b5 229 size_t tspec_ielen);
6fc6879b 230#endif /* CONFIG_IEEE80211R */
0f950df0
TP
231#ifdef CONFIG_MESH
232 int (*start_ampe)(void *ctx, const u8 *sta_addr);
233#endif /* CONFIG_MESH */
6fc6879b
JM
234};
235
236struct wpa_authenticator * wpa_init(const u8 *addr,
237 struct wpa_auth_config *conf,
238 struct wpa_auth_callbacks *cb);
bdffdc5d 239int wpa_init_keys(struct wpa_authenticator *wpa_auth);
6fc6879b
JM
240void wpa_deinit(struct wpa_authenticator *wpa_auth);
241int wpa_reconfig(struct wpa_authenticator *wpa_auth,
242 struct wpa_auth_config *conf);
243
244enum {
245 WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
246 WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
247 WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
2100a768 248 WPA_INVALID_MDIE, WPA_INVALID_PROTO
6fc6879b
JM
249};
250
251int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
252 struct wpa_state_machine *sm,
253 const u8 *wpa_ie, size_t wpa_ie_len,
254 const u8 *mdie, size_t mdie_len);
a14896e8
JM
255int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
256 struct wpa_state_machine *sm,
257 const u8 *osen_ie, size_t osen_ie_len);
f3f7540e 258int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
6fc6879b 259struct wpa_state_machine *
94ddef3e
JM
260wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
261 const u8 *p2p_dev_addr);
6f9b5d16
JM
262int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
263 struct wpa_state_machine *sm);
a8d05fca 264void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
6fc6879b
JM
265void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
266void wpa_receive(struct wpa_authenticator *wpa_auth,
267 struct wpa_state_machine *sm,
268 u8 *data, size_t data_len);
bb119228 269enum wpa_event {
6fc6879b
JM
270 WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
271 WPA_REAUTH_EAPOL, WPA_ASSOC_FT
bb119228 272};
6fc6879b 273void wpa_remove_ptk(struct wpa_state_machine *sm);
bb119228 274int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
6fc6879b
JM
275void wpa_auth_sm_notify(struct wpa_state_machine *sm);
276void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
277int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
278int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
279void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
280int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
ff36ff00 281int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
6fc6879b
JM
282int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
283int wpa_auth_sta_wpa_version(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,
207976f0 292 unsigned int pmk_len,
6fc6879b
JM
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);
f2991170 298int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
70c93963 299 const u8 *pmk, const u8 *pmkid);
901d1fe1
JM
300void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
301 const u8 *sta_addr);
b8daac18
MH
302int wpa_auth_pmksa_list(struct wpa_authenticator *wpa_auth, char *buf,
303 size_t len);
4c522c77 304void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
9f2cf23e
MH
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);
6fc6879b 311int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
e4bf4db9
JM
312void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
313 struct wpa_state_machine *sm, int ack);
6fc6879b
JM
314
315#ifdef CONFIG_IEEE80211R
316u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
f238cf9f
JM
317 size_t max_len, int auth_alg,
318 const u8 *req_ies, size_t req_ies_len);
6fc6879b
JM
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
d32d94db
XC
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);
d32d94db 336int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);
d32d94db 337
c10347f2 338int wpa_auth_uses_sae(struct wpa_state_machine *sm);
aa189ac9 339int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
c10347f2 340
25ef8529
JM
341int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);
342
cbc210de
JM
343struct radius_das_attrs;
344int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
345 struct radius_das_attrs *attr);
34782730 346void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
cbc210de 347
7cebc8e2
MB
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
6fc6879b 351#endif /* WPA_AUTH_H */