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