src/rsn_supp/wpa_i.h

   1 /*
   2  * wpa_supplicant - Internal WPA state machine definitions
   3  * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * Alternatively, this software may be distributed under the terms of BSD
  10  * license.
  11  *
  12  * See README and COPYING for more details.
  13  */
  14
  15 #ifndef WPA_I_H
  16 #define WPA_I_H
  17
  18 struct rsn_pmksa_candidate;
  19 struct wpa_peerkey;
  20 struct wpa_eapol_key;
  21
  22 /**
  23  * struct wpa_sm - Internal WPA state machine data
  24  */
  25 struct wpa_sm {
  26         u8 pmk[PMK_LEN];
  27         size_t pmk_len;
  28         struct wpa_ptk ptk, tptk;
  29         int ptk_set, tptk_set;
  30         u8 snonce[WPA_NONCE_LEN];
  31         u8 anonce[WPA_NONCE_LEN]; /* ANonce from the last 1/4 msg */
  32         int renew_snonce;
  33         u8 rx_replay_counter[WPA_REPLAY_COUNTER_LEN];
  34         int rx_replay_counter_set;
  35         u8 request_counter[WPA_REPLAY_COUNTER_LEN];
  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 rsn_pmksa_candidate *pmksa_candidates;
  42
  43         struct l2_packet_data *l2_preauth;
  44         struct l2_packet_data *l2_preauth_br;
  45         u8 preauth_bssid[ETH_ALEN]; /* current RSN pre-auth peer or
  46                                      * 00:00:00:00:00:00 if no pre-auth is
  47                                      * in progress */
  48         struct eapol_sm *preauth_eapol;
  49
  50         struct wpa_sm_ctx *ctx;
  51
  52         void *scard_ctx; /* context for smartcard callbacks */
  53         int fast_reauth; /* whether EAP fast re-authentication is enabled */
  54
  55         void *network_ctx;
  56         int peerkey_enabled;
  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
  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
  84         u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
  85         size_t assoc_wpa_ie_len;
  86         u8 *ap_wpa_ie, *ap_rsn_ie;
  87         size_t ap_wpa_ie_len, ap_rsn_ie_len;
  88
  89 #ifdef CONFIG_PEERKEY
  90         struct wpa_peerkey *peerkey;
  91 #endif /* CONFIG_PEERKEY */
  92
  93 #ifdef CONFIG_IEEE80211R
  94         u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
  95         size_t xxkey_len;
  96         u8 pmk_r0[PMK_LEN];
  97         u8 pmk_r0_name[WPA_PMK_NAME_LEN];
  98         u8 pmk_r1[PMK_LEN];
  99         u8 pmk_r1_name[WPA_PMK_NAME_LEN];
 100         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
 101         u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
 102         size_t r0kh_id_len;
 103         u8 r1kh_id[FT_R1KH_ID_LEN];
 104         int ft_completed;
 105         int over_the_ds_in_progress;
 106         u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
 107 #endif /* CONFIG_IEEE80211R */
 108 };
 109
 110
 111 static inline void wpa_sm_set_state(struct wpa_sm *sm, wpa_states state)
 112 {
 113         WPA_ASSERT(sm->ctx->set_state);
 114         sm->ctx->set_state(sm->ctx->ctx, state);
 115 }
 116
 117 static inline wpa_states wpa_sm_get_state(struct wpa_sm *sm)
 118 {
 119         WPA_ASSERT(sm->ctx->get_state);
 120         return sm->ctx->get_state(sm->ctx->ctx);
 121 }
 122
 123 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
 124 {
 125         WPA_ASSERT(sm->ctx->deauthenticate);
 126         sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
 127 }
 128
 129 static inline void wpa_sm_disassociate(struct wpa_sm *sm, int reason_code)
 130 {
 131         WPA_ASSERT(sm->ctx->disassociate);
 132         sm->ctx->disassociate(sm->ctx->ctx, reason_code);
 133 }
 134
 135 static inline int wpa_sm_set_key(struct wpa_sm *sm, wpa_alg alg,
 136                                  const u8 *addr, int key_idx, int set_tx,
 137                                  const u8 *seq, size_t seq_len,
 138                                  const u8 *key, size_t key_len)
 139 {
 140         WPA_ASSERT(sm->ctx->set_key);
 141         return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
 142                                 seq, seq_len, key, key_len);
 143 }
 144
 145 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
 146 {
 147         WPA_ASSERT(sm->ctx->get_network_ctx);
 148         return sm->ctx->get_network_ctx(sm->ctx->ctx);
 149 }
 150
 151 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
 152 {
 153         WPA_ASSERT(sm->ctx->get_bssid);
 154         return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
 155 }
 156
 157 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
 158                                     u16 proto, const u8 *buf, size_t len)
 159 {
 160         WPA_ASSERT(sm->ctx->ether_send);
 161         return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
 162 }
 163
 164 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
 165 {
 166         WPA_ASSERT(sm->ctx->get_beacon_ie);
 167         return sm->ctx->get_beacon_ie(sm->ctx->ctx);
 168 }
 169
 170 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
 171 {
 172         WPA_ASSERT(sm->ctx->cancel_auth_timeout);
 173         sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
 174 }
 175
 176 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
 177                                       const void *data, u16 data_len,
 178                                       size_t *msg_len, void **data_pos)
 179 {
 180         WPA_ASSERT(sm->ctx->alloc_eapol);
 181         return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
 182                                     msg_len, data_pos);
 183 }
 184
 185 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, const u8 *bssid,
 186                                    const u8 *pmkid)
 187 {
 188         WPA_ASSERT(sm->ctx->add_pmkid);
 189         return sm->ctx->add_pmkid(sm->ctx->ctx, bssid, pmkid);
 190 }
 191
 192 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, const u8 *bssid,
 193                                       const u8 *pmkid)
 194 {
 195         WPA_ASSERT(sm->ctx->remove_pmkid);
 196         return sm->ctx->remove_pmkid(sm->ctx->ctx, bssid, pmkid);
 197 }
 198
 199 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
 200                                             int protect_type, int key_type)
 201 {
 202         WPA_ASSERT(sm->ctx->mlme_setprotection);
 203         return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
 204                                            key_type);
 205 }
 206
 207 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
 208                                        const u8 *ies, size_t ies_len)
 209 {
 210         if (sm->ctx->update_ft_ies)
 211                 return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
 212         return -1;
 213 }
 214
 215 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
 216                                         const u8 *target_ap,
 217                                         const u8 *ies, size_t ies_len)
 218 {
 219         if (sm->ctx->send_ft_action)
 220                 return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
 221                                                ies, ies_len);
 222         return -1;
 223 }
 224
 225
 226 void wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck,
 227                         int ver, const u8 *dest, u16 proto,
 228                         u8 *msg, size_t msg_len, u8 *key_mic);
 229 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
 230                                const struct wpa_eapol_key *key,
 231                                int ver, const u8 *nonce,
 232                                const u8 *wpa_ie, size_t wpa_ie_len,
 233                                struct wpa_ptk *ptk);
 234 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
 235                                const struct wpa_eapol_key *key,
 236                                u16 ver, u16 key_info,
 237                                const u8 *kde, size_t kde_len,
 238                                struct wpa_ptk *ptk);
 239
 240 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
 241                       const struct wpa_eapol_key *key,
 242                       struct wpa_ptk *ptk);
 243
 244 #endif /* WPA_I_H */