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_req_scan(struct wpa_sm *sm, int sec, int usec)
 124 {
 125         WPA_ASSERT(sm->ctx->req_scan);
 126         sm->ctx->req_scan(sm->ctx->ctx, sec, usec);
 127 }
 128
 129 static inline void wpa_sm_cancel_scan(struct wpa_sm *sm)
 130 {
 131         WPA_ASSERT(sm->ctx->cancel_scan);
 132         sm->ctx->cancel_scan(sm->ctx->ctx);
 133 }
 134
 135 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
 136 {
 137         WPA_ASSERT(sm->ctx->deauthenticate);
 138         sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
 139 }
 140
 141 static inline void wpa_sm_disassociate(struct wpa_sm *sm, int reason_code)
 142 {
 143         WPA_ASSERT(sm->ctx->disassociate);
 144         sm->ctx->disassociate(sm->ctx->ctx, reason_code);
 145 }
 146
 147 static inline int wpa_sm_set_key(struct wpa_sm *sm, wpa_alg alg,
 148                                  const u8 *addr, int key_idx, int set_tx,
 149                                  const u8 *seq, size_t seq_len,
 150                                  const u8 *key, size_t key_len)
 151 {
 152         WPA_ASSERT(sm->ctx->set_key);
 153         return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
 154                                 seq, seq_len, key, key_len);
 155 }
 156
 157 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
 158 {
 159         WPA_ASSERT(sm->ctx->get_network_ctx);
 160         return sm->ctx->get_network_ctx(sm->ctx->ctx);
 161 }
 162
 163 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
 164 {
 165         WPA_ASSERT(sm->ctx->get_bssid);
 166         return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
 167 }
 168
 169 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
 170                                     u16 proto, const u8 *buf, size_t len)
 171 {
 172         WPA_ASSERT(sm->ctx->ether_send);
 173         return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
 174 }
 175
 176 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
 177 {
 178         WPA_ASSERT(sm->ctx->get_beacon_ie);
 179         return sm->ctx->get_beacon_ie(sm->ctx->ctx);
 180 }
 181
 182 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
 183 {
 184         WPA_ASSERT(sm->ctx->cancel_auth_timeout);
 185         sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
 186 }
 187
 188 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
 189                                       const void *data, u16 data_len,
 190                                       size_t *msg_len, void **data_pos)
 191 {
 192         WPA_ASSERT(sm->ctx->alloc_eapol);
 193         return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
 194                                     msg_len, data_pos);
 195 }
 196
 197 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, const u8 *bssid,
 198                                    const u8 *pmkid)
 199 {
 200         WPA_ASSERT(sm->ctx->add_pmkid);
 201         return sm->ctx->add_pmkid(sm->ctx->ctx, bssid, pmkid);
 202 }
 203
 204 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, const u8 *bssid,
 205                                       const u8 *pmkid)
 206 {
 207         WPA_ASSERT(sm->ctx->remove_pmkid);
 208         return sm->ctx->remove_pmkid(sm->ctx->ctx, bssid, pmkid);
 209 }
 210
 211 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
 212                                             int protect_type, int key_type)
 213 {
 214         WPA_ASSERT(sm->ctx->mlme_setprotection);
 215         return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
 216                                            key_type);
 217 }
 218
 219 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
 220                                        const u8 *ies, size_t ies_len)
 221 {
 222         if (sm->ctx->update_ft_ies)
 223                 return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
 224         return -1;
 225 }
 226
 227 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
 228                                         const u8 *target_ap,
 229                                         const u8 *ies, size_t ies_len)
 230 {
 231         if (sm->ctx->send_ft_action)
 232                 return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
 233                                                ies, ies_len);
 234         return -1;
 235 }
 236
 237
 238 void wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck,
 239                         int ver, const u8 *dest, u16 proto,
 240                         u8 *msg, size_t msg_len, u8 *key_mic);
 241 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
 242                                const struct wpa_eapol_key *key,
 243                                int ver, const u8 *nonce,
 244                                const u8 *wpa_ie, size_t wpa_ie_len,
 245                                struct wpa_ptk *ptk);
 246 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
 247                                const struct wpa_eapol_key *key,
 248                                u16 ver, u16 key_info,
 249                                const u8 *kde, size_t kde_len,
 250                                struct wpa_ptk *ptk);
 251
 252 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
 253                       const struct wpa_eapol_key *key,
 254                       struct wpa_ptk *ptk);
 255
 256 #endif /* WPA_I_H */