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