1214501Srpaulo/* 2214501Srpaulo * hostapd - IEEE 802.11i-2004 / WPA Authenticator 3214501Srpaulo * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi> 4214501Srpaulo * 5252726Srpaulo * This software may be distributed under the terms of the BSD license. 6252726Srpaulo * See README for more details. 7214501Srpaulo */ 8214501Srpaulo 9214501Srpaulo#ifndef WPA_AUTH_H 10214501Srpaulo#define WPA_AUTH_H 11214501Srpaulo 12214501Srpaulo#include "common/defs.h" 13214501Srpaulo#include "common/eapol_common.h" 14214501Srpaulo#include "common/wpa_common.h" 15214501Srpaulo 16214501Srpaulo#ifdef _MSC_VER 17214501Srpaulo#pragma pack(push, 1) 18214501Srpaulo#endif /* _MSC_VER */ 19214501Srpaulo 20214501Srpaulo/* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition 21214501Srpaulo */ 22214501Srpaulostruct ft_rrb_frame { 23214501Srpaulo u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 24214501Srpaulo u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */ 25214501Srpaulo le16 action_length; /* little endian length of action_frame */ 26214501Srpaulo u8 ap_address[ETH_ALEN]; 27214501Srpaulo /* 28214501Srpaulo * Followed by action_length bytes of FT Action frame (from Category 29214501Srpaulo * field to the end of Action Frame body. 30214501Srpaulo */ 31214501Srpaulo} STRUCT_PACKED; 32214501Srpaulo 33214501Srpaulo#define RSN_REMOTE_FRAME_TYPE_FT_RRB 1 34214501Srpaulo 35214501Srpaulo#define FT_PACKET_REQUEST 0 36214501Srpaulo#define FT_PACKET_RESPONSE 1 37214501Srpaulo/* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r */ 38214501Srpaulo#define FT_PACKET_R0KH_R1KH_PULL 200 39214501Srpaulo#define FT_PACKET_R0KH_R1KH_RESP 201 40214501Srpaulo#define FT_PACKET_R0KH_R1KH_PUSH 202 41214501Srpaulo 42214501Srpaulo#define FT_R0KH_R1KH_PULL_DATA_LEN 44 43214501Srpaulo#define FT_R0KH_R1KH_RESP_DATA_LEN 76 44214501Srpaulo#define FT_R0KH_R1KH_PUSH_DATA_LEN 88 45214501Srpaulo 46214501Srpaulostruct ft_r0kh_r1kh_pull_frame { 47214501Srpaulo u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 48214501Srpaulo u8 packet_type; /* FT_PACKET_R0KH_R1KH_PULL */ 49214501Srpaulo le16 data_length; /* little endian length of data (44) */ 50214501Srpaulo u8 ap_address[ETH_ALEN]; 51214501Srpaulo 52214501Srpaulo u8 nonce[16]; 53214501Srpaulo u8 pmk_r0_name[WPA_PMK_NAME_LEN]; 54214501Srpaulo u8 r1kh_id[FT_R1KH_ID_LEN]; 55214501Srpaulo u8 s1kh_id[ETH_ALEN]; 56214501Srpaulo u8 pad[4]; /* 8-octet boundary for AES key wrap */ 57214501Srpaulo u8 key_wrap_extra[8]; 58214501Srpaulo} STRUCT_PACKED; 59214501Srpaulo 60214501Srpaulostruct ft_r0kh_r1kh_resp_frame { 61214501Srpaulo u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 62214501Srpaulo u8 packet_type; /* FT_PACKET_R0KH_R1KH_RESP */ 63214501Srpaulo le16 data_length; /* little endian length of data (76) */ 64214501Srpaulo u8 ap_address[ETH_ALEN]; 65214501Srpaulo 66214501Srpaulo u8 nonce[16]; /* copied from pull */ 67214501Srpaulo u8 r1kh_id[FT_R1KH_ID_LEN]; /* copied from pull */ 68214501Srpaulo u8 s1kh_id[ETH_ALEN]; /* copied from pull */ 69214501Srpaulo u8 pmk_r1[PMK_LEN]; 70214501Srpaulo u8 pmk_r1_name[WPA_PMK_NAME_LEN]; 71214501Srpaulo le16 pairwise; 72214501Srpaulo u8 pad[2]; /* 8-octet boundary for AES key wrap */ 73214501Srpaulo u8 key_wrap_extra[8]; 74214501Srpaulo} STRUCT_PACKED; 75214501Srpaulo 76214501Srpaulostruct ft_r0kh_r1kh_push_frame { 77214501Srpaulo u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 78214501Srpaulo u8 packet_type; /* FT_PACKET_R0KH_R1KH_PUSH */ 79214501Srpaulo le16 data_length; /* little endian length of data (88) */ 80214501Srpaulo u8 ap_address[ETH_ALEN]; 81214501Srpaulo 82214501Srpaulo /* Encrypted with AES key-wrap */ 83214501Srpaulo u8 timestamp[4]; /* current time in seconds since unix epoch, little 84214501Srpaulo * endian */ 85214501Srpaulo u8 r1kh_id[FT_R1KH_ID_LEN]; 86214501Srpaulo u8 s1kh_id[ETH_ALEN]; 87214501Srpaulo u8 pmk_r0_name[WPA_PMK_NAME_LEN]; 88214501Srpaulo u8 pmk_r1[PMK_LEN]; 89214501Srpaulo u8 pmk_r1_name[WPA_PMK_NAME_LEN]; 90214501Srpaulo le16 pairwise; 91214501Srpaulo u8 pad[6]; /* 8-octet boundary for AES key wrap */ 92214501Srpaulo u8 key_wrap_extra[8]; 93214501Srpaulo} STRUCT_PACKED; 94214501Srpaulo 95214501Srpaulo#ifdef _MSC_VER 96214501Srpaulo#pragma pack(pop) 97214501Srpaulo#endif /* _MSC_VER */ 98214501Srpaulo 99214501Srpaulo 100214501Srpaulo/* per STA state machine data */ 101214501Srpaulo 102214501Srpaulostruct wpa_authenticator; 103214501Srpaulostruct wpa_state_machine; 104214501Srpaulostruct rsn_pmksa_cache_entry; 105214501Srpaulostruct eapol_state_machine; 106214501Srpaulo 107214501Srpaulo 108214501Srpaulostruct ft_remote_r0kh { 109214501Srpaulo struct ft_remote_r0kh *next; 110214501Srpaulo u8 addr[ETH_ALEN]; 111214501Srpaulo u8 id[FT_R0KH_ID_MAX_LEN]; 112214501Srpaulo size_t id_len; 113214501Srpaulo u8 key[16]; 114214501Srpaulo}; 115214501Srpaulo 116214501Srpaulo 117214501Srpaulostruct ft_remote_r1kh { 118214501Srpaulo struct ft_remote_r1kh *next; 119214501Srpaulo u8 addr[ETH_ALEN]; 120214501Srpaulo u8 id[FT_R1KH_ID_LEN]; 121214501Srpaulo u8 key[16]; 122214501Srpaulo}; 123214501Srpaulo 124214501Srpaulo 125214501Srpaulostruct wpa_auth_config { 126214501Srpaulo int wpa; 127214501Srpaulo int wpa_key_mgmt; 128214501Srpaulo int wpa_pairwise; 129214501Srpaulo int wpa_group; 130214501Srpaulo int wpa_group_rekey; 131214501Srpaulo int wpa_strict_rekey; 132214501Srpaulo int wpa_gmk_rekey; 133214501Srpaulo int wpa_ptk_rekey; 134214501Srpaulo int rsn_pairwise; 135214501Srpaulo int rsn_preauth; 136214501Srpaulo int eapol_version; 137214501Srpaulo int peerkey; 138214501Srpaulo int wmm_enabled; 139214501Srpaulo int wmm_uapsd; 140252726Srpaulo int disable_pmksa_caching; 141214501Srpaulo int okc; 142252726Srpaulo int tx_status; 143214501Srpaulo#ifdef CONFIG_IEEE80211W 144214501Srpaulo enum mfp_options ieee80211w; 145214501Srpaulo#endif /* CONFIG_IEEE80211W */ 146214501Srpaulo#ifdef CONFIG_IEEE80211R 147214501Srpaulo#define SSID_LEN 32 148214501Srpaulo u8 ssid[SSID_LEN]; 149214501Srpaulo size_t ssid_len; 150214501Srpaulo u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN]; 151214501Srpaulo u8 r0_key_holder[FT_R0KH_ID_MAX_LEN]; 152214501Srpaulo size_t r0_key_holder_len; 153214501Srpaulo u8 r1_key_holder[FT_R1KH_ID_LEN]; 154214501Srpaulo u32 r0_key_lifetime; 155214501Srpaulo u32 reassociation_deadline; 156214501Srpaulo struct ft_remote_r0kh *r0kh_list; 157214501Srpaulo struct ft_remote_r1kh *r1kh_list; 158214501Srpaulo int pmk_r1_push; 159252726Srpaulo int ft_over_ds; 160214501Srpaulo#endif /* CONFIG_IEEE80211R */ 161252726Srpaulo int disable_gtk; 162252726Srpaulo int ap_mlme; 163214501Srpaulo}; 164214501Srpaulo 165214501Srpaulotypedef enum { 166214501Srpaulo LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING 167214501Srpaulo} logger_level; 168214501Srpaulo 169214501Srpaulotypedef enum { 170214501Srpaulo WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized, 171214501Srpaulo WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable, 172214501Srpaulo WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx 173214501Srpaulo} wpa_eapol_variable; 174214501Srpaulo 175214501Srpaulostruct wpa_auth_callbacks { 176214501Srpaulo void *ctx; 177214501Srpaulo void (*logger)(void *ctx, const u8 *addr, logger_level level, 178214501Srpaulo const char *txt); 179214501Srpaulo void (*disconnect)(void *ctx, const u8 *addr, u16 reason); 180252726Srpaulo int (*mic_failure_report)(void *ctx, const u8 *addr); 181214501Srpaulo void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var, 182214501Srpaulo int value); 183214501Srpaulo int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var); 184214501Srpaulo const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *prev_psk); 185214501Srpaulo int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len); 186214501Srpaulo int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg, 187214501Srpaulo const u8 *addr, int idx, u8 *key, size_t key_len); 188214501Srpaulo int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq); 189214501Srpaulo int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data, 190214501Srpaulo size_t data_len, int encrypt); 191214501Srpaulo int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm, 192214501Srpaulo void *ctx), void *cb_ctx); 193214501Srpaulo int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a, 194214501Srpaulo void *ctx), void *cb_ctx); 195214501Srpaulo int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data, 196214501Srpaulo size_t data_len); 197214501Srpaulo#ifdef CONFIG_IEEE80211R 198214501Srpaulo struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr); 199214501Srpaulo int (*send_ft_action)(void *ctx, const u8 *dst, 200214501Srpaulo const u8 *data, size_t data_len); 201252726Srpaulo int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie, 202252726Srpaulo size_t tspec_ielen); 203214501Srpaulo#endif /* CONFIG_IEEE80211R */ 204214501Srpaulo}; 205214501Srpaulo 206214501Srpaulostruct wpa_authenticator * wpa_init(const u8 *addr, 207214501Srpaulo struct wpa_auth_config *conf, 208214501Srpaulo struct wpa_auth_callbacks *cb); 209252726Srpauloint wpa_init_keys(struct wpa_authenticator *wpa_auth); 210214501Srpaulovoid wpa_deinit(struct wpa_authenticator *wpa_auth); 211214501Srpauloint wpa_reconfig(struct wpa_authenticator *wpa_auth, 212214501Srpaulo struct wpa_auth_config *conf); 213214501Srpaulo 214214501Srpauloenum { 215214501Srpaulo WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE, 216214501Srpaulo WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL, 217214501Srpaulo WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER, 218214501Srpaulo WPA_INVALID_MDIE, WPA_INVALID_PROTO 219214501Srpaulo}; 220214501Srpaulo 221214501Srpauloint wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth, 222214501Srpaulo struct wpa_state_machine *sm, 223214501Srpaulo const u8 *wpa_ie, size_t wpa_ie_len, 224214501Srpaulo const u8 *mdie, size_t mdie_len); 225214501Srpauloint wpa_auth_uses_mfp(struct wpa_state_machine *sm); 226214501Srpaulostruct wpa_state_machine * 227214501Srpaulowpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr); 228214501Srpauloint wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth, 229214501Srpaulo struct wpa_state_machine *sm); 230214501Srpaulovoid wpa_auth_sta_no_wpa(struct wpa_state_machine *sm); 231214501Srpaulovoid wpa_auth_sta_deinit(struct wpa_state_machine *sm); 232214501Srpaulovoid wpa_receive(struct wpa_authenticator *wpa_auth, 233214501Srpaulo struct wpa_state_machine *sm, 234214501Srpaulo u8 *data, size_t data_len); 235214501Srpaulotypedef enum { 236214501Srpaulo WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH, 237214501Srpaulo WPA_REAUTH_EAPOL, WPA_ASSOC_FT 238214501Srpaulo} wpa_event; 239214501Srpaulovoid wpa_remove_ptk(struct wpa_state_machine *sm); 240214501Srpauloint wpa_auth_sm_event(struct wpa_state_machine *sm, wpa_event event); 241214501Srpaulovoid wpa_auth_sm_notify(struct wpa_state_machine *sm); 242214501Srpaulovoid wpa_gtk_rekey(struct wpa_authenticator *wpa_auth); 243214501Srpauloint wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen); 244214501Srpauloint wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen); 245214501Srpaulovoid wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth); 246214501Srpauloint wpa_auth_pairwise_set(struct wpa_state_machine *sm); 247214501Srpauloint wpa_auth_get_pairwise(struct wpa_state_machine *sm); 248214501Srpauloint wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm); 249214501Srpauloint wpa_auth_sta_wpa_version(struct wpa_state_machine *sm); 250324739Sgordonint wpa_auth_sta_ft_tk_already_set(struct wpa_state_machine *sm); 251214501Srpauloint wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm, 252214501Srpaulo struct rsn_pmksa_cache_entry *entry); 253214501Srpaulostruct rsn_pmksa_cache_entry * 254214501Srpaulowpa_auth_sta_get_pmksa(struct wpa_state_machine *sm); 255214501Srpaulovoid wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm); 256214501Srpauloconst u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth, 257214501Srpaulo size_t *len); 258214501Srpauloint wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk, 259214501Srpaulo int session_timeout, struct eapol_state_machine *eapol); 260214501Srpauloint wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth, 261214501Srpaulo const u8 *pmk, size_t len, const u8 *sta_addr, 262214501Srpaulo int session_timeout, 263214501Srpaulo struct eapol_state_machine *eapol); 264214501Srpauloint wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id); 265252726Srpaulovoid wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth, 266252726Srpaulo struct wpa_state_machine *sm, int ack); 267214501Srpaulo 268214501Srpaulo#ifdef CONFIG_IEEE80211R 269214501Srpaulou8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos, 270214501Srpaulo size_t max_len, int auth_alg, 271214501Srpaulo const u8 *req_ies, size_t req_ies_len); 272214501Srpaulovoid wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid, 273214501Srpaulo u16 auth_transaction, const u8 *ies, size_t ies_len, 274214501Srpaulo void (*cb)(void *ctx, const u8 *dst, const u8 *bssid, 275214501Srpaulo u16 auth_transaction, u16 resp, 276214501Srpaulo const u8 *ies, size_t ies_len), 277214501Srpaulo void *ctx); 278214501Srpaulou16 wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies, 279214501Srpaulo size_t ies_len); 280214501Srpauloint wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len); 281214501Srpauloint wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr, 282214501Srpaulo const u8 *data, size_t data_len); 283214501Srpaulovoid wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr); 284214501Srpaulo#endif /* CONFIG_IEEE80211R */ 285214501Srpaulo 286252726Srpaulovoid wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm); 287252726Srpaulovoid wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag); 288252726Srpauloint wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos); 289252726Srpauloint wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos); 290252726Srpaulo 291252726Srpauloint wpa_auth_uses_sae(struct wpa_state_machine *sm); 292252726Srpaulo 293214501Srpaulo#endif /* WPA_AUTH_H */ 294