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