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