contrib/wpa/src/rsn_supp/wpa_i.h

   1 /*
   2  * Internal WPA/RSN supplicant state machine definitions
   3  * Copyright (c) 2004-2018, 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_I_H
  10 #define WPA_I_H
  11
  12 #include "utils/list.h"
  13
  14 struct wpa_tdls_peer;
  15 struct wpa_eapol_key;
  16
  17 /**
  18  * struct wpa_sm - Internal WPA state machine data
  19  */
  20 struct wpa_sm {
  21         u8 pmk[PMK_LEN_MAX];
  22         size_t pmk_len;
  23         struct wpa_ptk ptk, tptk;
  24         int ptk_set, tptk_set;
  25         unsigned int msg_3_of_4_ok:1;
  26         u8 snonce[WPA_NONCE_LEN];
  27         u8 anonce[WPA_NONCE_LEN]; /* ANonce from the last 1/4 msg */
  28         int renew_snonce;
  29         u8 rx_replay_counter[WPA_REPLAY_COUNTER_LEN];
  30         int rx_replay_counter_set;
  31         u8 request_counter[WPA_REPLAY_COUNTER_LEN];
  32         struct wpa_gtk gtk;
  33         struct wpa_gtk gtk_wnm_sleep;
  34 #ifdef CONFIG_IEEE80211W
  35         struct wpa_igtk igtk;
  36         struct wpa_igtk igtk_wnm_sleep;
  37 #endif /* CONFIG_IEEE80211W */
  38
  39         struct eapol_sm *eapol; /* EAPOL state machine from upper level code */
  40
  41         struct rsn_pmksa_cache *pmksa; /* PMKSA cache */
  42         struct rsn_pmksa_cache_entry *cur_pmksa; /* current PMKSA entry */
  43         struct dl_list pmksa_candidates;
  44
  45         struct l2_packet_data *l2_preauth;
  46         struct l2_packet_data *l2_preauth_br;
  47         struct l2_packet_data *l2_tdls;
  48         u8 preauth_bssid[ETH_ALEN]; /* current RSN pre-auth peer or
  49                                      * 00:00:00:00:00:00 if no pre-auth is
  50                                      * in progress */
  51         struct eapol_sm *preauth_eapol;
  52
  53         struct wpa_sm_ctx *ctx;
  54
  55         void *scard_ctx; /* context for smartcard callbacks */
  56         int fast_reauth; /* whether EAP fast re-authentication is enabled */
  57
  58         void *network_ctx;
  59         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
  60         int proactive_key_caching;
  61         int eap_workaround;
  62         void *eap_conf_ctx;
  63         u8 ssid[32];
  64         size_t ssid_len;
  65         int wpa_ptk_rekey;
  66         int p2p;
  67         int wpa_rsc_relaxation;
  68
  69         u8 own_addr[ETH_ALEN];
  70         const char *ifname;
  71         const char *bridge_ifname;
  72         u8 bssid[ETH_ALEN];
  73
  74         unsigned int dot11RSNAConfigPMKLifetime;
  75         unsigned int dot11RSNAConfigPMKReauthThreshold;
  76         unsigned int dot11RSNAConfigSATimeout;
  77
  78         unsigned int dot11RSNA4WayHandshakeFailures;
  79
  80         /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
  81         unsigned int proto;
  82         unsigned int pairwise_cipher;
  83         unsigned int group_cipher;
  84         unsigned int key_mgmt;
  85         unsigned int mgmt_group_cipher;
  86
  87         int rsn_enabled; /* Whether RSN is enabled in configuration */
  88         int mfp; /* 0 = disabled, 1 = optional, 2 = mandatory */
  89
  90         u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
  91         size_t assoc_wpa_ie_len;
  92         u8 *ap_wpa_ie, *ap_rsn_ie;
  93         size_t ap_wpa_ie_len, ap_rsn_ie_len;
  94
  95 #ifdef CONFIG_TDLS
  96         struct wpa_tdls_peer *tdls;
  97         int tdls_prohibited;
  98         int tdls_chan_switch_prohibited;
  99         int tdls_disabled;
 100
 101         /* The driver supports TDLS */
 102         int tdls_supported;
 103
 104         /*
 105          * The driver requires explicit discovery/setup/teardown frames sent
 106          * to it via tdls_mgmt.
 107          */
 108         int tdls_external_setup;
 109
 110         /* The driver supports TDLS channel switching */
 111         int tdls_chan_switch;
 112 #endif /* CONFIG_TDLS */
 113
 114 #ifdef CONFIG_IEEE80211R
 115         u8 xxkey[PMK_LEN_MAX]; /* PSK or the second 256 bits of MSK, or the
 116                                 * first 384 bits of MSK */
 117         size_t xxkey_len;
 118         u8 pmk_r0[PMK_LEN_MAX];
 119         size_t pmk_r0_len;
 120         u8 pmk_r0_name[WPA_PMK_NAME_LEN];
 121         u8 pmk_r1[PMK_LEN_MAX];
 122         size_t pmk_r1_len;
 123         u8 pmk_r1_name[WPA_PMK_NAME_LEN];
 124         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
 125         u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
 126         size_t r0kh_id_len;
 127         u8 r1kh_id[FT_R1KH_ID_LEN];
 128         int ft_completed;
 129         int ft_reassoc_completed;
 130         int over_the_ds_in_progress;
 131         u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
 132         int set_ptk_after_assoc;
 133         u8 mdie_ft_capab; /* FT Capability and Policy from target AP MDIE */
 134         u8 *assoc_resp_ies; /* MDIE and FTIE from (Re)Association Response */
 135         size_t assoc_resp_ies_len;
 136 #endif /* CONFIG_IEEE80211R */
 137
 138 #ifdef CONFIG_P2P
 139         u8 p2p_ip_addr[3 * 4];
 140 #endif /* CONFIG_P2P */
 141
 142 #ifdef CONFIG_TESTING_OPTIONS
 143         struct wpabuf *test_assoc_ie;
 144 #endif /* CONFIG_TESTING_OPTIONS */
 145
 146 #ifdef CONFIG_FILS
 147         u8 fils_nonce[FILS_NONCE_LEN];
 148         u8 fils_session[FILS_SESSION_LEN];
 149         u8 fils_anonce[FILS_NONCE_LEN];
 150         u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN];
 151         u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN];
 152         size_t fils_key_auth_len;
 153         unsigned int fils_completed:1;
 154         unsigned int fils_erp_pmkid_set:1;
 155         unsigned int fils_cache_id_set:1;
 156         u8 fils_erp_pmkid[PMKID_LEN];
 157         u8 fils_cache_id[FILS_CACHE_ID_LEN];
 158         struct crypto_ecdh *fils_ecdh;
 159         int fils_dh_group;
 160         size_t fils_dh_elem_len;
 161         struct wpabuf *fils_ft_ies;
 162         u8 fils_ft[FILS_FT_MAX_LEN];
 163         size_t fils_ft_len;
 164 #endif /* CONFIG_FILS */
 165
 166 #ifdef CONFIG_OWE
 167         struct crypto_ecdh *owe_ecdh;
 168         u16 owe_group;
 169 #endif /* CONFIG_OWE */
 170 };
 171
 172
 173 static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
 174 {
 175         WPA_ASSERT(sm->ctx->set_state);
 176         sm->ctx->set_state(sm->ctx->ctx, state);
 177 }
 178
 179 static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
 180 {
 181         WPA_ASSERT(sm->ctx->get_state);
 182         return sm->ctx->get_state(sm->ctx->ctx);
 183 }
 184
 185 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
 186 {
 187         WPA_ASSERT(sm->ctx->deauthenticate);
 188         sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
 189 }
 190
 191 static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
 192                                  const u8 *addr, int key_idx, int set_tx,
 193                                  const u8 *seq, size_t seq_len,
 194                                  const u8 *key, size_t key_len)
 195 {
 196         WPA_ASSERT(sm->ctx->set_key);
 197         return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
 198                                 seq, seq_len, key, key_len);
 199 }
 200
 201 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
 202 {
 203         WPA_ASSERT(sm->ctx->get_network_ctx);
 204         return sm->ctx->get_network_ctx(sm->ctx->ctx);
 205 }
 206
 207 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
 208 {
 209         WPA_ASSERT(sm->ctx->get_bssid);
 210         return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
 211 }
 212
 213 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
 214                                     u16 proto, const u8 *buf, size_t len)
 215 {
 216         WPA_ASSERT(sm->ctx->ether_send);
 217         return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
 218 }
 219
 220 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
 221 {
 222         WPA_ASSERT(sm->ctx->get_beacon_ie);
 223         return sm->ctx->get_beacon_ie(sm->ctx->ctx);
 224 }
 225
 226 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
 227 {
 228         WPA_ASSERT(sm->ctx->cancel_auth_timeout);
 229         sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
 230 }
 231
 232 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
 233                                       const void *data, u16 data_len,
 234                                       size_t *msg_len, void **data_pos)
 235 {
 236         WPA_ASSERT(sm->ctx->alloc_eapol);
 237         return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
 238                                     msg_len, data_pos);
 239 }
 240
 241 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, void *network_ctx,
 242                                    const u8 *bssid, const u8 *pmkid,
 243                                    const u8 *cache_id, const u8 *pmk,
 244                                    size_t pmk_len)
 245 {
 246         WPA_ASSERT(sm->ctx->add_pmkid);
 247         return sm->ctx->add_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid,
 248                                   cache_id, pmk, pmk_len);
 249 }
 250
 251 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, void *network_ctx,
 252                                       const u8 *bssid, const u8 *pmkid,
 253                                       const u8 *cache_id)
 254 {
 255         WPA_ASSERT(sm->ctx->remove_pmkid);
 256         return sm->ctx->remove_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid,
 257                                      cache_id);
 258 }
 259
 260 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
 261                                             int protect_type, int key_type)
 262 {
 263         WPA_ASSERT(sm->ctx->mlme_setprotection);
 264         return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
 265                                            key_type);
 266 }
 267
 268 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
 269                                        const u8 *ies, size_t ies_len)
 270 {
 271         if (sm->ctx->update_ft_ies)
 272                 return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
 273         return -1;
 274 }
 275
 276 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
 277                                         const u8 *target_ap,
 278                                         const u8 *ies, size_t ies_len)
 279 {
 280         if (sm->ctx->send_ft_action)
 281                 return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
 282                                                ies, ies_len);
 283         return -1;
 284 }
 285
 286 static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
 287                                             const u8 *target_ap)
 288 {
 289         if (sm->ctx->mark_authenticated)
 290                 return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
 291         return -1;
 292 }
 293
 294 static inline void wpa_sm_set_rekey_offload(struct wpa_sm *sm)
 295 {
 296         if (!sm->ctx->set_rekey_offload)
 297                 return;
 298         sm->ctx->set_rekey_offload(sm->ctx->ctx, sm->ptk.kek, sm->ptk.kek_len,
 299                                    sm->ptk.kck, sm->ptk.kck_len,
 300                                    sm->rx_replay_counter);
 301 }
 302
 303 #ifdef CONFIG_TDLS
 304 static inline int wpa_sm_tdls_get_capa(struct wpa_sm *sm,
 305                                        int *tdls_supported,
 306                                        int *tdls_ext_setup,
 307                                        int *tdls_chan_switch)
 308 {
 309         if (sm->ctx->tdls_get_capa)
 310                 return sm->ctx->tdls_get_capa(sm->ctx->ctx, tdls_supported,
 311                                               tdls_ext_setup, tdls_chan_switch);
 312         return -1;
 313 }
 314
 315 static inline int wpa_sm_send_tdls_mgmt(struct wpa_sm *sm, const u8 *dst,
 316                                         u8 action_code, u8 dialog_token,
 317                                         u16 status_code, u32 peer_capab,
 318                                         int initiator, const u8 *buf,
 319                                         size_t len)
 320 {
 321         if (sm->ctx->send_tdls_mgmt)
 322                 return sm->ctx->send_tdls_mgmt(sm->ctx->ctx, dst, action_code,
 323                                                dialog_token, status_code,
 324                                                peer_capab, initiator, buf,
 325                                                len);
 326         return -1;
 327 }
 328
 329 static inline int wpa_sm_tdls_oper(struct wpa_sm *sm, int oper,
 330                                    const u8 *peer)
 331 {
 332         if (sm->ctx->tdls_oper)
 333                 return sm->ctx->tdls_oper(sm->ctx->ctx, oper, peer);
 334         return -1;
 335 }
 336
 337 static inline int
 338 wpa_sm_tdls_peer_addset(struct wpa_sm *sm, const u8 *addr, int add,
 339                         u16 aid, u16 capability, const u8 *supp_rates,
 340                         size_t supp_rates_len,
 341                         const struct ieee80211_ht_capabilities *ht_capab,
 342                         const struct ieee80211_vht_capabilities *vht_capab,
 343                         u8 qosinfo, int wmm, const u8 *ext_capab,
 344                         size_t ext_capab_len, const u8 *supp_channels,
 345                         size_t supp_channels_len, const u8 *supp_oper_classes,
 346                         size_t supp_oper_classes_len)
 347 {
 348         if (sm->ctx->tdls_peer_addset)
 349                 return sm->ctx->tdls_peer_addset(sm->ctx->ctx, addr, add,
 350                                                  aid, capability, supp_rates,
 351                                                  supp_rates_len, ht_capab,
 352                                                  vht_capab, qosinfo, wmm,
 353                                                  ext_capab, ext_capab_len,
 354                                                  supp_channels,
 355                                                  supp_channels_len,
 356                                                  supp_oper_classes,
 357                                                  supp_oper_classes_len);
 358         return -1;
 359 }
 360
 361 static inline int
 362 wpa_sm_tdls_enable_channel_switch(struct wpa_sm *sm, const u8 *addr,
 363                                   u8 oper_class,
 364                                   const struct hostapd_freq_params *freq_params)
 365 {
 366         if (sm->ctx->tdls_enable_channel_switch)
 367                 return sm->ctx->tdls_enable_channel_switch(sm->ctx->ctx, addr,
 368                                                            oper_class,
 369                                                            freq_params);
 370         return -1;
 371 }
 372
 373 static inline int
 374 wpa_sm_tdls_disable_channel_switch(struct wpa_sm *sm, const u8 *addr)
 375 {
 376         if (sm->ctx->tdls_disable_channel_switch)
 377                 return sm->ctx->tdls_disable_channel_switch(sm->ctx->ctx, addr);
 378         return -1;
 379 }
 380 #endif /* CONFIG_TDLS */
 381
 382 static inline int wpa_sm_key_mgmt_set_pmk(struct wpa_sm *sm,
 383                                           const u8 *pmk, size_t pmk_len)
 384 {
 385         if (!sm->ctx->key_mgmt_set_pmk)
 386                 return -1;
 387         return sm->ctx->key_mgmt_set_pmk(sm->ctx->ctx, pmk, pmk_len);
 388 }
 389
 390 static inline void wpa_sm_fils_hlp_rx(struct wpa_sm *sm,
 391                                       const u8 *dst, const u8 *src,
 392                                       const u8 *pkt, size_t pkt_len)
 393 {
 394         if (sm->ctx->fils_hlp_rx)
 395                 sm->ctx->fils_hlp_rx(sm->ctx->ctx, dst, src, pkt, pkt_len);
 396 }
 397
 398
 399 int wpa_eapol_key_send(struct wpa_sm *sm, struct wpa_ptk *ptk,
 400                        int ver, const u8 *dest, u16 proto,
 401                        u8 *msg, size_t msg_len, u8 *key_mic);
 402 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
 403                                const struct wpa_eapol_key *key,
 404                                int ver, const u8 *nonce,
 405                                const u8 *wpa_ie, size_t wpa_ie_len,
 406                                struct wpa_ptk *ptk);
 407 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
 408                                const struct wpa_eapol_key *key,
 409                                u16 ver, u16 key_info,
 410                                struct wpa_ptk *ptk);
 411
 412 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
 413                       const struct wpa_eapol_key *key, struct wpa_ptk *ptk);
 414
 415 void wpa_tdls_assoc(struct wpa_sm *sm);
 416 void wpa_tdls_disassoc(struct wpa_sm *sm);
 417
 418 #endif /* WPA_I_H */