1 /* 2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator 3 * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi> 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License version 2 as 7 * published by the Free Software Foundation. 8 * 9 * Alternatively, this software may be distributed under the terms of BSD 10 * license. 11 * 12 * See README and COPYING for more details. 13 */ 14 15 #ifndef WPA_AUTH_H 16 #define WPA_AUTH_H 17 18 #include "common/defs.h" 19 #include "common/eapol_common.h" 20 #include "common/wpa_common.h" 21 22 #ifdef _MSC_VER 23 #pragma pack(push, 1) 24 #endif /* _MSC_VER */ 25 26 /* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition 27 */ 28 struct ft_rrb_frame { 29 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 30 u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */ 31 le16 action_length; /* little endian length of action_frame */ 32 u8 ap_address[ETH_ALEN]; 33 /* 34 * Followed by action_length bytes of FT Action frame (from Category 35 * field to the end of Action Frame body. 36 */ 37 } STRUCT_PACKED; 38 39 #define RSN_REMOTE_FRAME_TYPE_FT_RRB 1 40 41 #define FT_PACKET_REQUEST 0 42 #define FT_PACKET_RESPONSE 1 43 /* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r */ 44 #define FT_PACKET_R0KH_R1KH_PULL 200 45 #define FT_PACKET_R0KH_R1KH_RESP 201 46 #define FT_PACKET_R0KH_R1KH_PUSH 202 47 48 #define FT_R0KH_R1KH_PULL_DATA_LEN 44 49 #define FT_R0KH_R1KH_RESP_DATA_LEN 76 50 #define FT_R0KH_R1KH_PUSH_DATA_LEN 88 51 52 struct ft_r0kh_r1kh_pull_frame { 53 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 54 u8 packet_type; /* FT_PACKET_R0KH_R1KH_PULL */ 55 le16 data_length; /* little endian length of data (44) */ 56 u8 ap_address[ETH_ALEN]; 57 58 u8 nonce[16]; 59 u8 pmk_r0_name[WPA_PMK_NAME_LEN]; 60 u8 r1kh_id[FT_R1KH_ID_LEN]; 61 u8 s1kh_id[ETH_ALEN]; 62 u8 pad[4]; /* 8-octet boundary for AES key wrap */ 63 u8 key_wrap_extra[8]; 64 } STRUCT_PACKED; 65 66 struct ft_r0kh_r1kh_resp_frame { 67 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 68 u8 packet_type; /* FT_PACKET_R0KH_R1KH_RESP */ 69 le16 data_length; /* little endian length of data (76) */ 70 u8 ap_address[ETH_ALEN]; 71 72 u8 nonce[16]; /* copied from pull */ 73 u8 r1kh_id[FT_R1KH_ID_LEN]; /* copied from pull */ 74 u8 s1kh_id[ETH_ALEN]; /* copied from pull */ 75 u8 pmk_r1[PMK_LEN]; 76 u8 pmk_r1_name[WPA_PMK_NAME_LEN]; 77 le16 pairwise; 78 u8 pad[2]; /* 8-octet boundary for AES key wrap */ 79 u8 key_wrap_extra[8]; 80 } STRUCT_PACKED; 81 82 struct ft_r0kh_r1kh_push_frame { 83 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */ 84 u8 packet_type; /* FT_PACKET_R0KH_R1KH_PUSH */ 85 le16 data_length; /* little endian length of data (88) */ 86 u8 ap_address[ETH_ALEN]; 87 88 /* Encrypted with AES key-wrap */ 89 u8 timestamp[4]; /* current time in seconds since unix epoch, little 90 * endian */ 91 u8 r1kh_id[FT_R1KH_ID_LEN]; 92 u8 s1kh_id[ETH_ALEN]; 93 u8 pmk_r0_name[WPA_PMK_NAME_LEN]; 94 u8 pmk_r1[PMK_LEN]; 95 u8 pmk_r1_name[WPA_PMK_NAME_LEN]; 96 le16 pairwise; 97 u8 pad[6]; /* 8-octet boundary for AES key wrap */ 98 u8 key_wrap_extra[8]; 99 } STRUCT_PACKED; 100 101 #ifdef _MSC_VER 102 #pragma pack(pop) 103 #endif /* _MSC_VER */ 104 105 106 /* per STA state machine data */ 107 108 struct wpa_authenticator; 109 struct wpa_state_machine; 110 struct rsn_pmksa_cache_entry; 111 struct eapol_state_machine; 112 113 114 struct ft_remote_r0kh { 115 struct ft_remote_r0kh *next; 116 u8 addr[ETH_ALEN]; 117 u8 id[FT_R0KH_ID_MAX_LEN]; 118 size_t id_len; 119 u8 key[16]; 120 }; 121 122 123 struct ft_remote_r1kh { 124 struct ft_remote_r1kh *next; 125 u8 addr[ETH_ALEN]; 126 u8 id[FT_R1KH_ID_LEN]; 127 u8 key[16]; 128 }; 129 130 131 struct wpa_auth_config { 132 int wpa; 133 int wpa_key_mgmt; 134 int wpa_pairwise; 135 int wpa_group; 136 int wpa_group_rekey; 137 int wpa_strict_rekey; 138 int wpa_gmk_rekey; 139 int wpa_ptk_rekey; 140 int rsn_pairwise; 141 int rsn_preauth; 142 int eapol_version; 143 int peerkey; 144 int wmm_enabled; 145 int wmm_uapsd; 146 int okc; 147 #ifdef CONFIG_IEEE80211W 148 enum mfp_options ieee80211w; 149 #endif /* CONFIG_IEEE80211W */ 150 #ifdef CONFIG_IEEE80211R 151 #define SSID_LEN 32 152 u8 ssid[SSID_LEN]; 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; 163 #endif /* CONFIG_IEEE80211R */ 164 }; 165 166 typedef enum { 167 LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING 168 } logger_level; 169 170 typedef enum { 171 WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized, 172 WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable, 173 WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx 174 } wpa_eapol_variable; 175 176 struct wpa_auth_callbacks { 177 void *ctx; 178 void (*logger)(void *ctx, const u8 *addr, logger_level level, 179 const char *txt); 180 void (*disconnect)(void *ctx, const u8 *addr, u16 reason); 181 void (*mic_failure_report)(void *ctx, const u8 *addr); 182 void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var, 183 int value); 184 int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var); 185 const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *prev_psk); 186 int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len); 187 int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg, 188 const u8 *addr, int idx, u8 *key, size_t key_len); 189 int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq); 190 int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data, 191 size_t data_len, int encrypt); 192 int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm, 193 void *ctx), void *cb_ctx); 194 int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a, 195 void *ctx), void *cb_ctx); 196 int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data, 197 size_t data_len); 198 #ifdef CONFIG_IEEE80211R 199 struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr); 200 int (*send_ft_action)(void *ctx, const u8 *dst, 201 const u8 *data, size_t data_len); 202 #endif /* CONFIG_IEEE80211R */ 203 }; 204 205 struct wpa_authenticator * wpa_init(const u8 *addr, 206 struct wpa_auth_config *conf, 207 struct wpa_auth_callbacks *cb); 208 void wpa_deinit(struct wpa_authenticator *wpa_auth); 209 int wpa_reconfig(struct wpa_authenticator *wpa_auth, 210 struct wpa_auth_config *conf); 211 212 enum { 213 WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE, 214 WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL, 215 WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER, 216 WPA_INVALID_MDIE, WPA_INVALID_PROTO 217 }; 218 219 int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth, 220 struct wpa_state_machine *sm, 221 const u8 *wpa_ie, size_t wpa_ie_len, 222 const u8 *mdie, size_t mdie_len); 223 int wpa_auth_uses_mfp(struct wpa_state_machine *sm); 224 struct wpa_state_machine * 225 wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr); 226 int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth, 227 struct wpa_state_machine *sm); 228 void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm); 229 void wpa_auth_sta_deinit(struct wpa_state_machine *sm); 230 void wpa_receive(struct wpa_authenticator *wpa_auth, 231 struct wpa_state_machine *sm, 232 u8 *data, size_t data_len); 233 typedef enum { 234 WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH, 235 WPA_REAUTH_EAPOL, WPA_ASSOC_FT 236 } wpa_event; 237 void wpa_remove_ptk(struct wpa_state_machine *sm); 238 int wpa_auth_sm_event(struct wpa_state_machine *sm, wpa_event event); 239 void wpa_auth_sm_notify(struct wpa_state_machine *sm); 240 void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth); 241 int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen); 242 int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen); 243 void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth); 244 int wpa_auth_pairwise_set(struct wpa_state_machine *sm); 245 int wpa_auth_get_pairwise(struct wpa_state_machine *sm); 246 int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm); 247 int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm); 248 int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm, 249 struct rsn_pmksa_cache_entry *entry); 250 struct rsn_pmksa_cache_entry * 251 wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm); 252 void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm); 253 const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth, 254 size_t *len); 255 int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk, 256 int session_timeout, struct eapol_state_machine *eapol); 257 int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth, 258 const u8 *pmk, size_t len, const u8 *sta_addr, 259 int session_timeout, 260 struct eapol_state_machine *eapol); 261 int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id); 262 263 #ifdef CONFIG_IEEE80211R 264 u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos, 265 size_t max_len, int auth_alg, 266 const u8 *req_ies, size_t req_ies_len); 267 void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid, 268 u16 auth_transaction, const u8 *ies, size_t ies_len, 269 void (*cb)(void *ctx, const u8 *dst, const u8 *bssid, 270 u16 auth_transaction, u16 resp, 271 const u8 *ies, size_t ies_len), 272 void *ctx); 273 u16 wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies, 274 size_t ies_len); 275 int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len); 276 int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr, 277 const u8 *data, size_t data_len); 278 void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr); 279 #endif /* CONFIG_IEEE80211R */ 280 281 #endif /* WPA_AUTH_H */ 282