libeap/src/rsn_supp/wpa_i.h

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