src/rsn_supp/wpa_i.h

   1 /*
   2  * Internal WPA/RSN supplicant state machine definitions
   3  * Copyright (c) 2004-2010, 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 #include "utils/list.h"
  19
  20 struct wpa_peerkey;
  21 struct wpa_eapol_key;
  22
  23 /**
  24  * struct wpa_sm - Internal WPA state machine data
  25  */
  26 struct wpa_sm {
  27         u8 pmk[PMK_LEN];
  28         size_t pmk_len;
  29         struct wpa_ptk ptk, tptk;
  30         int ptk_set, tptk_set;
  31         u8 snonce[WPA_NONCE_LEN];
  32         u8 anonce[WPA_NONCE_LEN]; /* ANonce from the last 1/4 msg */
  33         int renew_snonce;
  34         u8 rx_replay_counter[WPA_REPLAY_COUNTER_LEN];
  35         int rx_replay_counter_set;
  36         u8 request_counter[WPA_REPLAY_COUNTER_LEN];
  37
  38         struct eapol_sm *eapol; /* EAPOL state machine from upper level code */
  39
  40         struct rsn_pmksa_cache *pmksa; /* PMKSA cache */
  41         struct rsn_pmksa_cache_entry *cur_pmksa; /* current PMKSA entry */
  42         struct dl_list pmksa_candidates;
  43
  44         struct l2_packet_data *l2_preauth;
  45         struct l2_packet_data *l2_preauth_br;
  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 peerkey_enabled;
  58         int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
  59         int proactive_key_caching;
  60         int eap_workaround;
  61         void *eap_conf_ctx;
  62         u8 ssid[32];
  63         size_t ssid_len;
  64         int wpa_ptk_rekey;
  65
  66         u8 own_addr[ETH_ALEN];
  67         const char *ifname;
  68         const char *bridge_ifname;
  69         u8 bssid[ETH_ALEN];
  70
  71         unsigned int dot11RSNAConfigPMKLifetime;
  72         unsigned int dot11RSNAConfigPMKReauthThreshold;
  73         unsigned int dot11RSNAConfigSATimeout;
  74
  75         unsigned int dot11RSNA4WayHandshakeFailures;
  76
  77         /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
  78         unsigned int proto;
  79         unsigned int pairwise_cipher;
  80         unsigned int group_cipher;
  81         unsigned int key_mgmt;
  82         unsigned int mgmt_group_cipher;
  83
  84         int rsn_enabled; /* Whether RSN is enabled in configuration */
  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
  95 #ifdef CONFIG_IEEE80211R
  96         u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
  97         size_t xxkey_len;
  98         u8 pmk_r0[PMK_LEN];
  99         u8 pmk_r0_name[WPA_PMK_NAME_LEN];
 100         u8 pmk_r1[PMK_LEN];
 101         u8 pmk_r1_name[WPA_PMK_NAME_LEN];
 102         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
 103         u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
 104         size_t r0kh_id_len;
 105         u8 r1kh_id[FT_R1KH_ID_LEN];
 106         int ft_completed;
 107         int over_the_ds_in_progress;
 108         u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
 109         int set_ptk_after_assoc;
 110 #endif /* CONFIG_IEEE80211R */
 111 };
 112
 113
 114 static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
 115 {
 116         WPA_ASSERT(sm->ctx->set_state);
 117         sm->ctx->set_state(sm->ctx->ctx, state);
 118 }
 119
 120 static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
 121 {
 122         WPA_ASSERT(sm->ctx->get_state);
 123         return sm->ctx->get_state(sm->ctx->ctx);
 124 }
 125
 126 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
 127 {
 128         WPA_ASSERT(sm->ctx->deauthenticate);
 129         sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
 130 }
 131
 132 static inline void wpa_sm_disassociate(struct wpa_sm *sm, int reason_code)
 133 {
 134         WPA_ASSERT(sm->ctx->disassociate);
 135         sm->ctx->disassociate(sm->ctx->ctx, reason_code);
 136 }
 137
 138 static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
 139                                  const u8 *addr, int key_idx, int set_tx,
 140                                  const u8 *seq, size_t seq_len,
 141                                  const u8 *key, size_t key_len)
 142 {
 143         WPA_ASSERT(sm->ctx->set_key);
 144         return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
 145                                 seq, seq_len, key, key_len);
 146 }
 147
 148 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
 149 {
 150         WPA_ASSERT(sm->ctx->get_network_ctx);
 151         return sm->ctx->get_network_ctx(sm->ctx->ctx);
 152 }
 153
 154 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
 155 {
 156         WPA_ASSERT(sm->ctx->get_bssid);
 157         return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
 158 }
 159
 160 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
 161                                     u16 proto, const u8 *buf, size_t len)
 162 {
 163         WPA_ASSERT(sm->ctx->ether_send);
 164         return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
 165 }
 166
 167 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
 168 {
 169         WPA_ASSERT(sm->ctx->get_beacon_ie);
 170         return sm->ctx->get_beacon_ie(sm->ctx->ctx);
 171 }
 172
 173 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
 174 {
 175         WPA_ASSERT(sm->ctx->cancel_auth_timeout);
 176         sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
 177 }
 178
 179 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
 180                                       const void *data, u16 data_len,
 181                                       size_t *msg_len, void **data_pos)
 182 {
 183         WPA_ASSERT(sm->ctx->alloc_eapol);
 184         return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
 185                                     msg_len, data_pos);
 186 }
 187
 188 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, const u8 *bssid,
 189                                    const u8 *pmkid)
 190 {
 191         WPA_ASSERT(sm->ctx->add_pmkid);
 192         return sm->ctx->add_pmkid(sm->ctx->ctx, bssid, pmkid);
 193 }
 194
 195 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, const u8 *bssid,
 196                                       const u8 *pmkid)
 197 {
 198         WPA_ASSERT(sm->ctx->remove_pmkid);
 199         return sm->ctx->remove_pmkid(sm->ctx->ctx, bssid, pmkid);
 200 }
 201
 202 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
 203                                             int protect_type, int key_type)
 204 {
 205         WPA_ASSERT(sm->ctx->mlme_setprotection);
 206         return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
 207                                            key_type);
 208 }
 209
 210 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
 211                                        const u8 *ies, size_t ies_len)
 212 {
 213         if (sm->ctx->update_ft_ies)
 214                 return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
 215         return -1;
 216 }
 217
 218 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
 219                                         const u8 *target_ap,
 220                                         const u8 *ies, size_t ies_len)
 221 {
 222         if (sm->ctx->send_ft_action)
 223                 return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
 224                                                ies, ies_len);
 225         return -1;
 226 }
 227
 228 static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
 229                                             const u8 *target_ap)
 230 {
 231         if (sm->ctx->mark_authenticated)
 232                 return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
 233         return -1;
 234 }
 235
 236
 237 void wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck,
 238                         int ver, const u8 *dest, u16 proto,
 239                         u8 *msg, size_t msg_len, u8 *key_mic);
 240 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
 241                                const struct wpa_eapol_key *key,
 242                                int ver, const u8 *nonce,
 243                                const u8 *wpa_ie, size_t wpa_ie_len,
 244                                struct wpa_ptk *ptk);
 245 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
 246                                const struct wpa_eapol_key *key,
 247                                u16 ver, u16 key_info,
 248                                const u8 *kde, size_t kde_len,
 249                                struct wpa_ptk *ptk);
 250
 251 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
 252                       const struct wpa_eapol_key *key,
 253                       struct wpa_ptk *ptk, size_t ptk_len);
 254
 255 #endif /* WPA_I_H */