[thirdparty/hostap.git] / src / ap / wpa_auth_i.h

/*
 * hostapd - IEEE 802.11i-2004 / WPA Authenticator: Internal definitions
 * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 */

#ifndef WPA_AUTH_I_H
#define WPA_AUTH_I_H

/* max(dot11RSNAConfigGroupUpdateCount,dot11RSNAConfigPairwiseUpdateCount) */
#define RSNA_MAX_EAPOL_RETRIES 4

struct wpa_group;

struct wpa_stsl_negotiation {
	struct wpa_stsl_negotiation *next;
	u8 initiator[ETH_ALEN];
	u8 peer[ETH_ALEN];
};


struct wpa_state_machine {
	struct wpa_authenticator *wpa_auth;
	struct wpa_group *group;

	u8 addr[ETH_ALEN];

	enum {
		WPA_PTK_INITIALIZE, WPA_PTK_DISCONNECT, WPA_PTK_DISCONNECTED,
		WPA_PTK_AUTHENTICATION, WPA_PTK_AUTHENTICATION2,
		WPA_PTK_INITPMK, WPA_PTK_INITPSK, WPA_PTK_PTKSTART,
		WPA_PTK_PTKCALCNEGOTIATING, WPA_PTK_PTKCALCNEGOTIATING2,
		WPA_PTK_PTKINITNEGOTIATING, WPA_PTK_PTKINITDONE
	} wpa_ptk_state;

	enum {
		WPA_PTK_GROUP_IDLE = 0,
		WPA_PTK_GROUP_REKEYNEGOTIATING,
		WPA_PTK_GROUP_REKEYESTABLISHED,
		WPA_PTK_GROUP_KEYERROR
	} wpa_ptk_group_state;

	Boolean Init;
	Boolean DeauthenticationRequest;
	Boolean AuthenticationRequest;
	Boolean ReAuthenticationRequest;
	Boolean Disconnect;
	int TimeoutCtr;
	int GTimeoutCtr;
	Boolean TimeoutEvt;
	Boolean EAPOLKeyReceived;
	Boolean EAPOLKeyPairwise;
	Boolean EAPOLKeyRequest;
	Boolean MICVerified;
	Boolean GUpdateStationKeys;
	u8 ANonce[WPA_NONCE_LEN];
	u8 SNonce[WPA_NONCE_LEN];
	u8 PMK[PMK_LEN];
	struct wpa_ptk PTK;
	Boolean PTK_valid;
	Boolean pairwise_set;
	int keycount;
	Boolean Pair;
	struct wpa_key_replay_counter {
		u8 counter[WPA_REPLAY_COUNTER_LEN];
		Boolean valid;
	} key_replay[RSNA_MAX_EAPOL_RETRIES],
		prev_key_replay[RSNA_MAX_EAPOL_RETRIES];
	Boolean PInitAKeys; /* WPA only, not in IEEE 802.11i */
	Boolean PTKRequest; /* not in IEEE 802.11i state machine */
	Boolean has_GTK;
	Boolean PtkGroupInit; /* init request for PTK Group state machine */

	u8 *last_rx_eapol_key; /* starting from IEEE 802.1X header */
	size_t last_rx_eapol_key_len;

	unsigned int changed:1;
	unsigned int in_step_loop:1;
	unsigned int pending_deinit:1;
	unsigned int started:1;
	unsigned int mgmt_frame_prot:1;
	unsigned int rx_eapol_key_secure:1;
	unsigned int update_snonce:1;
#ifdef CONFIG_IEEE80211R
	unsigned int ft_completed:1;
	unsigned int pmk_r1_name_valid:1;
#endif /* CONFIG_IEEE80211R */

	u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN];
	int req_replay_counter_used;

	u8 *wpa_ie;
	size_t wpa_ie_len;

	enum {
		WPA_VERSION_NO_WPA = 0 /* WPA not used */,
		WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */,
		WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */
	} wpa;
	int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */
	int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */
	struct rsn_pmksa_cache_entry *pmksa;

	u32 dot11RSNAStatsTKIPLocalMICFailures;
	u32 dot11RSNAStatsTKIPRemoteMICFailures;

#ifdef CONFIG_IEEE80211R
	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
	size_t xxkey_len;
	u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth
					   * Request */
	u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */
	size_t r0kh_id_len;
	u8 sup_pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name from EAPOL-Key
					       * message 2/4 */
	u8 *assoc_resp_ftie;
#endif /* CONFIG_IEEE80211R */

	int pending_1_of_4_timeout;
};


/* per group key state machine data */
struct wpa_group {
	struct wpa_group *next;
	int vlan_id;

	Boolean GInit;
	int GKeyDoneStations;
	Boolean GTKReKey;
	int GTK_len;
	int GN, GM;
	Boolean GTKAuthenticator;
	u8 Counter[WPA_NONCE_LEN];

	enum {
		WPA_GROUP_GTK_INIT = 0,
		WPA_GROUP_SETKEYS, WPA_GROUP_SETKEYSDONE
	} wpa_group_state;

	u8 GMK[WPA_GMK_LEN];
	u8 GTK[2][WPA_GTK_MAX_LEN];
	u8 GNonce[WPA_NONCE_LEN];
	Boolean changed;
	Boolean first_sta_seen;
	Boolean reject_4way_hs_for_entropy;
#ifdef CONFIG_IEEE80211W
	u8 IGTK[2][WPA_IGTK_LEN];
	int GN_igtk, GM_igtk;
#endif /* CONFIG_IEEE80211W */
};


struct wpa_ft_pmk_cache;

/* per authenticator data */
struct wpa_authenticator {
	struct wpa_group *group;

	unsigned int dot11RSNAStatsTKIPRemoteMICFailures;
	u32 dot11RSNAAuthenticationSuiteSelected;
	u32 dot11RSNAPairwiseCipherSelected;
	u32 dot11RSNAGroupCipherSelected;
	u8 dot11RSNAPMKIDUsed[PMKID_LEN];
	u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */
	u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */
	u32 dot11RSNAGroupCipherRequested; /* FIX: update */
	unsigned int dot11RSNATKIPCounterMeasuresInvoked;
	unsigned int dot11RSNA4WayHandshakeFailures;

	struct wpa_stsl_negotiation *stsl_negotiations;

	struct wpa_auth_config conf;
	struct wpa_auth_callbacks cb;

	u8 *wpa_ie;
	size_t wpa_ie_len;

	u8 addr[ETH_ALEN];

	struct rsn_pmksa_cache *pmksa;
	struct wpa_ft_pmk_cache *ft_pmk_cache;
};


int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len,
		     const u8 *pmkid);
void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
		     logger_level level, const char *txt);
void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
		      logger_level level, const char *fmt, ...);
void __wpa_send_eapol(struct wpa_authenticator *wpa_auth,
		      struct wpa_state_machine *sm, int key_info,
		      const u8 *key_rsc, const u8 *nonce,
		      const u8 *kde, size_t kde_len,
		      int keyidx, int encr, int force_version);
int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
			  int (*cb)(struct wpa_state_machine *sm, void *ctx),
			  void *cb_ctx);
int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth,
			   int (*cb)(struct wpa_authenticator *a, void *ctx),
			   void *cb_ctx);

#ifdef CONFIG_PEERKEY
int wpa_stsl_remove(struct wpa_authenticator *wpa_auth,
		    struct wpa_stsl_negotiation *neg);
void wpa_smk_error(struct wpa_authenticator *wpa_auth,
		   struct wpa_state_machine *sm, struct wpa_eapol_key *key);
void wpa_smk_m1(struct wpa_authenticator *wpa_auth,
		struct wpa_state_machine *sm, struct wpa_eapol_key *key);
void wpa_smk_m3(struct wpa_authenticator *wpa_auth,
		struct wpa_state_machine *sm, struct wpa_eapol_key *key);
#endif /* CONFIG_PEERKEY */

#ifdef CONFIG_IEEE80211R
int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len);
int wpa_write_ftie(struct wpa_auth_config *conf, const u8 *r0kh_id,
		   size_t r0kh_id_len,
		   const u8 *anonce, const u8 *snonce,
		   u8 *buf, size_t len, const u8 *subelem,
		   size_t subelem_len);
int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, const u8 *pmk,
			   struct wpa_ptk *ptk, size_t ptk_len);
struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void);
void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache);
void wpa_ft_install_ptk(struct wpa_state_machine *sm);
#endif /* CONFIG_IEEE80211R */

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