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