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         struct wpa_igtk igtk;
  35         struct wpa_igtk igtk_wnm_sleep;
  36         struct wpa_bigtk bigtk;
  37         struct wpa_bigtk bigtk_wnm_sleep;
  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         int owe_ptk_workaround;
  69         int beacon_prot;
  70
  71         u8 own_addr[ETH_ALEN];
  72         const char *ifname;
  73         const char *bridge_ifname;
  74         u8 bssid[ETH_ALEN];
  75
  76         unsigned int dot11RSNAConfigPMKLifetime;
  77         unsigned int dot11RSNAConfigPMKReauthThreshold;
  78         unsigned int dot11RSNAConfigSATimeout;
  79
  80         unsigned int dot11RSNA4WayHandshakeFailures;
  81
  82         /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
  83         unsigned int proto;
  84         unsigned int pairwise_cipher;
  85         unsigned int group_cipher;
  86         unsigned int key_mgmt;
  87         unsigned int mgmt_group_cipher;
  88
  89         int rsn_enabled; /* Whether RSN is enabled in configuration */
  90         int mfp; /* 0 = disabled, 1 = optional, 2 = mandatory */
  91         int ocv; /* Operating Channel Validation */
  92         int sae_pwe; /* SAE PWE generation options */
  93
  94         u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
  95         size_t assoc_wpa_ie_len;
  96         u8 *assoc_rsnxe; /* Own RSNXE from (Re)AssocReq */
  97         size_t assoc_rsnxe_len;
  98         u8 *ap_wpa_ie, *ap_rsn_ie, *ap_rsnxe;
  99         size_t ap_wpa_ie_len, ap_rsn_ie_len, ap_rsnxe_len;
 100
 101 #ifdef CONFIG_TDLS
 102         struct wpa_tdls_peer *tdls;
 103         int tdls_prohibited;
 104         int tdls_chan_switch_prohibited;
 105         int tdls_disabled;
 106
 107         /* The driver supports TDLS */
 108         int tdls_supported;
 109
 110         /*
 111          * The driver requires explicit discovery/setup/teardown frames sent
 112          * to it via tdls_mgmt.
 113          */
 114         int tdls_external_setup;
 115
 116         /* The driver supports TDLS channel switching */
 117         int tdls_chan_switch;
 118 #endif /* CONFIG_TDLS */
 119
 120 #ifdef CONFIG_IEEE80211R
 121         u8 xxkey[PMK_LEN_MAX]; /* PSK or the second 256 bits of MSK, or the
 122                                 * first 384 bits of MSK */
 123         size_t xxkey_len;
 124         u8 pmk_r0[PMK_LEN_MAX];
 125         size_t pmk_r0_len;
 126         u8 pmk_r0_name[WPA_PMK_NAME_LEN];
 127         u8 pmk_r1[PMK_LEN_MAX];
 128         size_t pmk_r1_len;
 129         u8 pmk_r1_name[WPA_PMK_NAME_LEN];
 130         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
 131         u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
 132         size_t r0kh_id_len;
 133         u8 r1kh_id[FT_R1KH_ID_LEN];
 134         unsigned int ft_completed:1;
 135         unsigned int ft_reassoc_completed:1;
 136         unsigned int ft_protocol:1;
 137         int over_the_ds_in_progress;
 138         u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
 139         int set_ptk_after_assoc;
 140         u8 mdie_ft_capab; /* FT Capability and Policy from target AP MDIE */
 141         u8 *assoc_resp_ies; /* MDIE and FTIE from (Re)Association Response */
 142         size_t assoc_resp_ies_len;
 143 #endif /* CONFIG_IEEE80211R */
 144
 145 #ifdef CONFIG_P2P
 146         u8 p2p_ip_addr[3 * 4];
 147 #endif /* CONFIG_P2P */
 148
 149 #ifdef CONFIG_TESTING_OPTIONS
 150         struct wpabuf *test_assoc_ie;
 151 #endif /* CONFIG_TESTING_OPTIONS */
 152
 153 #ifdef CONFIG_FILS
 154         u8 fils_nonce[FILS_NONCE_LEN];
 155         u8 fils_session[FILS_SESSION_LEN];
 156         u8 fils_anonce[FILS_NONCE_LEN];
 157         u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN];
 158         u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN];
 159         size_t fils_key_auth_len;
 160         unsigned int fils_completed:1;
 161         unsigned int fils_erp_pmkid_set:1;
 162         unsigned int fils_cache_id_set:1;
 163         u8 fils_erp_pmkid[PMKID_LEN];
 164         u8 fils_cache_id[FILS_CACHE_ID_LEN];
 165         struct crypto_ecdh *fils_ecdh;
 166         int fils_dh_group;
 167         size_t fils_dh_elem_len;
 168         struct wpabuf *fils_ft_ies;
 169         u8 fils_ft[FILS_FT_MAX_LEN];
 170         size_t fils_ft_len;
 171 #endif /* CONFIG_FILS */
 172
 173 #ifdef CONFIG_OWE
 174         struct crypto_ecdh *owe_ecdh;
 175         u16 owe_group;
 176 #endif /* CONFIG_OWE */
 177
 178 #ifdef CONFIG_DPP2
 179         struct wpabuf *dpp_z;
 180 #endif /* CONFIG_DPP2 */
 181 };
 182
 183
 184 static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
 185 {
 186         WPA_ASSERT(sm->ctx->set_state);
 187         sm->ctx->set_state(sm->ctx->ctx, state);
 188 }
 189
 190 static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
 191 {
 192         WPA_ASSERT(sm->ctx->get_state);
 193         return sm->ctx->get_state(sm->ctx->ctx);
 194 }
 195
 196 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, u16 reason_code)
 197 {
 198         WPA_ASSERT(sm->ctx->deauthenticate);
 199         sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
 200 }
 201
 202 static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
 203                                  const u8 *addr, int key_idx, int set_tx,
 204                                  const u8 *seq, size_t seq_len,
 205                                  const u8 *key, size_t key_len,
 206                                  enum key_flag key_flag)
 207 {
 208         WPA_ASSERT(sm->ctx->set_key);
 209         return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
 210                                 seq, seq_len, key, key_len, key_flag);
 211 }
 212
 213 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
 214 {
 215         WPA_ASSERT(sm->ctx->get_network_ctx);
 216         return sm->ctx->get_network_ctx(sm->ctx->ctx);
 217 }
 218
 219 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
 220 {
 221         WPA_ASSERT(sm->ctx->get_bssid);
 222         return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
 223 }
 224
 225 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
 226                                     u16 proto, const u8 *buf, size_t len)
 227 {
 228         WPA_ASSERT(sm->ctx->ether_send);
 229         return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
 230 }
 231
 232 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
 233 {
 234         WPA_ASSERT(sm->ctx->get_beacon_ie);
 235         return sm->ctx->get_beacon_ie(sm->ctx->ctx);
 236 }
 237
 238 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
 239 {
 240         WPA_ASSERT(sm->ctx->cancel_auth_timeout);
 241         sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
 242 }
 243
 244 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
 245                                       const void *data, u16 data_len,
 246                                       size_t *msg_len, void **data_pos)
 247 {
 248         WPA_ASSERT(sm->ctx->alloc_eapol);
 249         return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
 250                                     msg_len, data_pos);
 251 }
 252
 253 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, void *network_ctx,
 254                                    const u8 *bssid, const u8 *pmkid,
 255                                    const u8 *cache_id, const u8 *pmk,
 256                                    size_t pmk_len)
 257 {
 258         WPA_ASSERT(sm->ctx->add_pmkid);
 259         return sm->ctx->add_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid,
 260                                   cache_id, pmk, pmk_len);
 261 }
 262
 263 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, void *network_ctx,
 264                                       const u8 *bssid, const u8 *pmkid,
 265                                       const u8 *cache_id)
 266 {
 267         WPA_ASSERT(sm->ctx->remove_pmkid);
 268         return sm->ctx->remove_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid,
 269                                      cache_id);
 270 }
 271
 272 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
 273                                             int protect_type, int key_type)
 274 {
 275         WPA_ASSERT(sm->ctx->mlme_setprotection);
 276         return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
 277                                            key_type);
 278 }
 279
 280 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
 281                                        const u8 *ies, size_t ies_len)
 282 {
 283         if (sm->ctx->update_ft_ies)
 284                 return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
 285         return -1;
 286 }
 287
 288 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
 289                                         const u8 *target_ap,
 290                                         const u8 *ies, size_t ies_len)
 291 {
 292         if (sm->ctx->send_ft_action)
 293                 return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
 294                                                ies, ies_len);
 295         return -1;
 296 }
 297
 298 static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
 299                                             const u8 *target_ap)
 300 {
 301         if (sm->ctx->mark_authenticated)
 302                 return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
 303         return -1;
 304 }
 305
 306 static inline void wpa_sm_set_rekey_offload(struct wpa_sm *sm)
 307 {
 308         if (!sm->ctx->set_rekey_offload)
 309                 return;
 310         sm->ctx->set_rekey_offload(sm->ctx->ctx, sm->ptk.kek, sm->ptk.kek_len,
 311                                    sm->ptk.kck, sm->ptk.kck_len,
 312                                    sm->rx_replay_counter);
 313 }
 314
 315 #ifdef CONFIG_TDLS
 316 static inline int wpa_sm_tdls_get_capa(struct wpa_sm *sm,
 317                                        int *tdls_supported,
 318                                        int *tdls_ext_setup,
 319                                        int *tdls_chan_switch)
 320 {
 321         if (sm->ctx->tdls_get_capa)
 322                 return sm->ctx->tdls_get_capa(sm->ctx->ctx, tdls_supported,
 323                                               tdls_ext_setup, tdls_chan_switch);
 324         return -1;
 325 }
 326
 327 static inline int wpa_sm_send_tdls_mgmt(struct wpa_sm *sm, const u8 *dst,
 328                                         u8 action_code, u8 dialog_token,
 329                                         u16 status_code, u32 peer_capab,
 330                                         int initiator, const u8 *buf,
 331                                         size_t len)
 332 {
 333         if (sm->ctx->send_tdls_mgmt)
 334                 return sm->ctx->send_tdls_mgmt(sm->ctx->ctx, dst, action_code,
 335                                                dialog_token, status_code,
 336                                                peer_capab, initiator, buf,
 337                                                len);
 338         return -1;
 339 }
 340
 341 static inline int wpa_sm_tdls_oper(struct wpa_sm *sm, int oper,
 342                                    const u8 *peer)
 343 {
 344         if (sm->ctx->tdls_oper)
 345                 return sm->ctx->tdls_oper(sm->ctx->ctx, oper, peer);
 346         return -1;
 347 }
 348
 349 static inline int
 350 wpa_sm_tdls_peer_addset(struct wpa_sm *sm, const u8 *addr, int add,
 351                         u16 aid, u16 capability, const u8 *supp_rates,
 352                         size_t supp_rates_len,
 353                         const struct ieee80211_ht_capabilities *ht_capab,
 354                         const struct ieee80211_vht_capabilities *vht_capab,
 355                         u8 qosinfo, int wmm, const u8 *ext_capab,
 356                         size_t ext_capab_len, const u8 *supp_channels,
 357                         size_t supp_channels_len, const u8 *supp_oper_classes,
 358                         size_t supp_oper_classes_len)
 359 {
 360         if (sm->ctx->tdls_peer_addset)
 361                 return sm->ctx->tdls_peer_addset(sm->ctx->ctx, addr, add,
 362                                                  aid, capability, supp_rates,
 363                                                  supp_rates_len, ht_capab,
 364                                                  vht_capab, qosinfo, wmm,
 365                                                  ext_capab, ext_capab_len,
 366                                                  supp_channels,
 367                                                  supp_channels_len,
 368                                                  supp_oper_classes,
 369                                                  supp_oper_classes_len);
 370         return -1;
 371 }
 372
 373 static inline int
 374 wpa_sm_tdls_enable_channel_switch(struct wpa_sm *sm, const u8 *addr,
 375                                   u8 oper_class,
 376                                   const struct hostapd_freq_params *freq_params)
 377 {
 378         if (sm->ctx->tdls_enable_channel_switch)
 379                 return sm->ctx->tdls_enable_channel_switch(sm->ctx->ctx, addr,
 380                                                            oper_class,
 381                                                            freq_params);
 382         return -1;
 383 }
 384
 385 static inline int
 386 wpa_sm_tdls_disable_channel_switch(struct wpa_sm *sm, const u8 *addr)
 387 {
 388         if (sm->ctx->tdls_disable_channel_switch)
 389                 return sm->ctx->tdls_disable_channel_switch(sm->ctx->ctx, addr);
 390         return -1;
 391 }
 392 #endif /* CONFIG_TDLS */
 393
 394 static inline int wpa_sm_key_mgmt_set_pmk(struct wpa_sm *sm,
 395                                           const u8 *pmk, size_t pmk_len)
 396 {
 397         if (!sm->ctx->key_mgmt_set_pmk)
 398                 return -1;
 399         return sm->ctx->key_mgmt_set_pmk(sm->ctx->ctx, pmk, pmk_len);
 400 }
 401
 402 static inline void wpa_sm_fils_hlp_rx(struct wpa_sm *sm,
 403                                       const u8 *dst, const u8 *src,
 404                                       const u8 *pkt, size_t pkt_len)
 405 {
 406         if (sm->ctx->fils_hlp_rx)
 407                 sm->ctx->fils_hlp_rx(sm->ctx->ctx, dst, src, pkt, pkt_len);
 408 }
 409
 410 static inline int wpa_sm_channel_info(struct wpa_sm *sm,
 411                                       struct wpa_channel_info *ci)
 412 {
 413         if (!sm->ctx->channel_info)
 414                 return -1;
 415         return sm->ctx->channel_info(sm->ctx->ctx, ci);
 416 }
 417
 418
 419 int wpa_eapol_key_send(struct wpa_sm *sm, struct wpa_ptk *ptk,
 420                        int ver, const u8 *dest, u16 proto,
 421                        u8 *msg, size_t msg_len, u8 *key_mic);
 422 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
 423                                const struct wpa_eapol_key *key,
 424                                int ver, const u8 *nonce,
 425                                const u8 *wpa_ie, size_t wpa_ie_len,
 426                                struct wpa_ptk *ptk);
 427 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
 428                                const struct wpa_eapol_key *key,
 429                                u16 ver, u16 key_info,
 430                                struct wpa_ptk *ptk);
 431
 432 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
 433                       const struct wpa_eapol_key *key, struct wpa_ptk *ptk);
 434
 435 void wpa_tdls_assoc(struct wpa_sm *sm);
 436 void wpa_tdls_disassoc(struct wpa_sm *sm);
 437
 438 #endif /* WPA_I_H */