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