contrib/wpa/src/ap/wpa_auth_i.h

   1 /*
   2  * hostapd - IEEE 802.11i-2004 / WPA Authenticator: Internal definitions
   3  * Copyright (c) 2004-2007, 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_AUTH_I_H
  10 #define WPA_AUTH_I_H
  11
  12 /* max(dot11RSNAConfigGroupUpdateCount,dot11RSNAConfigPairwiseUpdateCount) */
  13 #define RSNA_MAX_EAPOL_RETRIES 4
  14
  15 struct wpa_group;
  16
  17 struct wpa_stsl_negotiation {
  18         struct wpa_stsl_negotiation *next;
  19         u8 initiator[ETH_ALEN];
  20         u8 peer[ETH_ALEN];
  21 };
  22
  23
  24 struct wpa_state_machine {
  25         struct wpa_authenticator *wpa_auth;
  26         struct wpa_group *group;
  27
  28         u8 addr[ETH_ALEN];
  29
  30         enum {
  31                 WPA_PTK_INITIALIZE, WPA_PTK_DISCONNECT, WPA_PTK_DISCONNECTED,
  32                 WPA_PTK_AUTHENTICATION, WPA_PTK_AUTHENTICATION2,
  33                 WPA_PTK_INITPMK, WPA_PTK_INITPSK, WPA_PTK_PTKSTART,
  34                 WPA_PTK_PTKCALCNEGOTIATING, WPA_PTK_PTKCALCNEGOTIATING2,
  35                 WPA_PTK_PTKINITNEGOTIATING, WPA_PTK_PTKINITDONE
  36         } wpa_ptk_state;
  37
  38         enum {
  39                 WPA_PTK_GROUP_IDLE = 0,
  40                 WPA_PTK_GROUP_REKEYNEGOTIATING,
  41                 WPA_PTK_GROUP_REKEYESTABLISHED,
  42                 WPA_PTK_GROUP_KEYERROR
  43         } wpa_ptk_group_state;
  44
  45         Boolean Init;
  46         Boolean DeauthenticationRequest;
  47         Boolean AuthenticationRequest;
  48         Boolean ReAuthenticationRequest;
  49         Boolean Disconnect;
  50         int TimeoutCtr;
  51         int GTimeoutCtr;
  52         Boolean TimeoutEvt;
  53         Boolean EAPOLKeyReceived;
  54         Boolean EAPOLKeyPairwise;
  55         Boolean EAPOLKeyRequest;
  56         Boolean MICVerified;
  57         Boolean GUpdateStationKeys;
  58         u8 ANonce[WPA_NONCE_LEN];
  59         u8 SNonce[WPA_NONCE_LEN];
  60         u8 PMK[PMK_LEN];
  61         struct wpa_ptk PTK;
  62         Boolean PTK_valid;
  63         Boolean pairwise_set;
  64         Boolean tk_already_set;
  65         int keycount;
  66         Boolean Pair;
  67         struct wpa_key_replay_counter {
  68                 u8 counter[WPA_REPLAY_COUNTER_LEN];
  69                 Boolean valid;
  70         } key_replay[RSNA_MAX_EAPOL_RETRIES],
  71                 prev_key_replay[RSNA_MAX_EAPOL_RETRIES];
  72         Boolean PInitAKeys; /* WPA only, not in IEEE 802.11i */
  73         Boolean PTKRequest; /* not in IEEE 802.11i state machine */
  74         Boolean has_GTK;
  75         Boolean PtkGroupInit; /* init request for PTK Group state machine */
  76
  77         u8 *last_rx_eapol_key; /* starting from IEEE 802.1X header */
  78         size_t last_rx_eapol_key_len;
  79
  80         unsigned int changed:1;
  81         unsigned int in_step_loop:1;
  82         unsigned int pending_deinit:1;
  83         unsigned int started:1;
  84         unsigned int mgmt_frame_prot:1;
  85         unsigned int rx_eapol_key_secure:1;
  86         unsigned int update_snonce:1;
  87 #ifdef CONFIG_IEEE80211R
  88         unsigned int ft_completed:1;
  89         unsigned int pmk_r1_name_valid:1;
  90 #endif /* CONFIG_IEEE80211R */
  91         unsigned int is_wnmsleep:1;
  92
  93         u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN];
  94         int req_replay_counter_used;
  95
  96         u8 *wpa_ie;
  97         size_t wpa_ie_len;
  98
  99         enum {
 100                 WPA_VERSION_NO_WPA = 0 /* WPA not used */,
 101                 WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */,
 102                 WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */
 103         } wpa;
 104         int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */
 105         int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */
 106         struct rsn_pmksa_cache_entry *pmksa;
 107
 108         u32 dot11RSNAStatsTKIPLocalMICFailures;
 109         u32 dot11RSNAStatsTKIPRemoteMICFailures;
 110
 111 #ifdef CONFIG_IEEE80211R
 112         u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
 113         size_t xxkey_len;
 114         u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth
 115                                            * Request */
 116         u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */
 117         size_t r0kh_id_len;
 118         u8 sup_pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name from EAPOL-Key
 119                                                * message 2/4 */
 120         u8 *assoc_resp_ftie;
 121 #endif /* CONFIG_IEEE80211R */
 122
 123         int pending_1_of_4_timeout;
 124 };
 125
 126
 127 /* per group key state machine data */
 128 struct wpa_group {
 129         struct wpa_group *next;
 130         int vlan_id;
 131
 132         Boolean GInit;
 133         int GKeyDoneStations;
 134         Boolean GTKReKey;
 135         int GTK_len;
 136         int GN, GM;
 137         Boolean GTKAuthenticator;
 138         u8 Counter[WPA_NONCE_LEN];
 139
 140         enum {
 141                 WPA_GROUP_GTK_INIT = 0,
 142                 WPA_GROUP_SETKEYS, WPA_GROUP_SETKEYSDONE
 143         } wpa_group_state;
 144
 145         u8 GMK[WPA_GMK_LEN];
 146         u8 GTK[2][WPA_GTK_MAX_LEN];
 147         u8 GNonce[WPA_NONCE_LEN];
 148         Boolean changed;
 149         Boolean first_sta_seen;
 150         Boolean reject_4way_hs_for_entropy;
 151 #ifdef CONFIG_IEEE80211W
 152         u8 IGTK[2][WPA_IGTK_LEN];
 153         int GN_igtk, GM_igtk;
 154 #endif /* CONFIG_IEEE80211W */
 155 };
 156
 157
 158 struct wpa_ft_pmk_cache;
 159
 160 /* per authenticator data */
 161 struct wpa_authenticator {
 162         struct wpa_group *group;
 163
 164         unsigned int dot11RSNAStatsTKIPRemoteMICFailures;
 165         u32 dot11RSNAAuthenticationSuiteSelected;
 166         u32 dot11RSNAPairwiseCipherSelected;
 167         u32 dot11RSNAGroupCipherSelected;
 168         u8 dot11RSNAPMKIDUsed[PMKID_LEN];
 169         u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */
 170         u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */
 171         u32 dot11RSNAGroupCipherRequested; /* FIX: update */
 172         unsigned int dot11RSNATKIPCounterMeasuresInvoked;
 173         unsigned int dot11RSNA4WayHandshakeFailures;
 174
 175         struct wpa_stsl_negotiation *stsl_negotiations;
 176
 177         struct wpa_auth_config conf;
 178         struct wpa_auth_callbacks cb;
 179
 180         u8 *wpa_ie;
 181         size_t wpa_ie_len;
 182
 183         u8 addr[ETH_ALEN];
 184
 185         struct rsn_pmksa_cache *pmksa;
 186         struct wpa_ft_pmk_cache *ft_pmk_cache;
 187 };
 188
 189
 190 int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len,
 191                      const u8 *pmkid);
 192 void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
 193                      logger_level level, const char *txt);
 194 void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
 195                       logger_level level, const char *fmt, ...);
 196 void __wpa_send_eapol(struct wpa_authenticator *wpa_auth,
 197                       struct wpa_state_machine *sm, int key_info,
 198                       const u8 *key_rsc, const u8 *nonce,
 199                       const u8 *kde, size_t kde_len,
 200                       int keyidx, int encr, int force_version);
 201 int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
 202                           int (*cb)(struct wpa_state_machine *sm, void *ctx),
 203                           void *cb_ctx);
 204 int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth,
 205                            int (*cb)(struct wpa_authenticator *a, void *ctx),
 206                            void *cb_ctx);
 207
 208 #ifdef CONFIG_PEERKEY
 209 int wpa_stsl_remove(struct wpa_authenticator *wpa_auth,
 210                     struct wpa_stsl_negotiation *neg);
 211 void wpa_smk_error(struct wpa_authenticator *wpa_auth,
 212                    struct wpa_state_machine *sm, struct wpa_eapol_key *key);
 213 void wpa_smk_m1(struct wpa_authenticator *wpa_auth,
 214                 struct wpa_state_machine *sm, struct wpa_eapol_key *key);
 215 void wpa_smk_m3(struct wpa_authenticator *wpa_auth,
 216                 struct wpa_state_machine *sm, struct wpa_eapol_key *key);
 217 #endif /* CONFIG_PEERKEY */
 218
 219 #ifdef CONFIG_IEEE80211R
 220 int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len);
 221 int wpa_write_ftie(struct wpa_auth_config *conf, const u8 *r0kh_id,
 222                    size_t r0kh_id_len,
 223                    const u8 *anonce, const u8 *snonce,
 224                    u8 *buf, size_t len, const u8 *subelem,
 225                    size_t subelem_len);
 226 int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, const u8 *pmk,
 227                            struct wpa_ptk *ptk, size_t ptk_len);
 228 struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void);
 229 void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache);
 230 void wpa_ft_install_ptk(struct wpa_state_machine *sm);
 231 #endif /* CONFIG_IEEE80211R */
 232
 233 #endif /* WPA_AUTH_I_H */