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

/*
 * hostapd - IEEE 802.11i-2004 / WPA Authenticator
 * Copyright (c) 2004-2017, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef WPA_AUTH_H
#define WPA_AUTH_H

#include "common/defs.h"
#include "common/eapol_common.h"
#include "common/wpa_common.h"
#include "common/ieee802_11_defs.h"

#define MAX_OWN_IE_OVERRIDE 256

#ifdef _MSC_VER
#pragma pack(push, 1)
#endif /* _MSC_VER */

/* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
 */
struct ft_rrb_frame {
	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
	u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
	le16 action_length; /* little endian length of action_frame */
	u8 ap_address[ETH_ALEN];
	/*
	 * Followed by action_length bytes of FT Action frame (from Category
	 * field to the end of Action Frame body.
	 */
} STRUCT_PACKED;

#define RSN_REMOTE_FRAME_TYPE_FT_RRB 1

#define FT_PACKET_REQUEST 0
#define FT_PACKET_RESPONSE 1

/* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r. These
 * use OUI Extended EtherType as the encapsulating format. */
#define FT_PACKET_R0KH_R1KH_PULL 0x01
#define FT_PACKET_R0KH_R1KH_RESP 0x02
#define FT_PACKET_R0KH_R1KH_PUSH 0x03
#define FT_PACKET_R0KH_R1KH_SEQ_REQ 0x04
#define FT_PACKET_R0KH_R1KH_SEQ_RESP 0x05

/* packet layout
 *  IEEE 802 extended OUI ethertype frame header
 *  u16 authlen (little endian)
 *  multiple of struct ft_rrb_tlv (authenticated only, length = authlen)
 *  multiple of struct ft_rrb_tlv (AES-SIV encrypted, AES-SIV needs an extra
 *                                 blocksize length)
 *
 * AES-SIV AAD;
 *  source MAC address (6)
 *  authenticated-only TLVs (authlen)
 *  subtype (1; FT_PACKET_*)
 */

#define FT_RRB_NONCE_LEN 16

#define FT_RRB_LAST_EMPTY     0 /* placeholder or padding */

#define FT_RRB_SEQ            1 /* struct ft_rrb_seq */
#define FT_RRB_NONCE          2 /* size FT_RRB_NONCE_LEN */
#define FT_RRB_TIMESTAMP      3 /* le32 unix seconds */

#define FT_RRB_R0KH_ID        4 /* FT_R0KH_ID_MAX_LEN */
#define FT_RRB_R1KH_ID        5 /* FT_R1KH_ID_LEN */
#define FT_RRB_S1KH_ID        6 /* ETH_ALEN */

#define FT_RRB_PMK_R0_NAME    7 /* WPA_PMK_NAME_LEN */
#define FT_RRB_PMK_R0         8 /* PMK_LEN */
#define FT_RRB_PMK_R1_NAME    9 /* WPA_PMK_NAME_LEN */
#define FT_RRB_PMK_R1        10 /* PMK_LEN */

#define FT_RRB_PAIRWISE      11 /* le16 */

struct ft_rrb_tlv {
	le16 type;
	le16 len;
	/* followed by data of length len */
} STRUCT_PACKED;

struct ft_rrb_seq {
	le32 dom;
	le32 seq;
	le32 ts;
} STRUCT_PACKED;

/* session TLVs:
 *   required: PMK_R1, PMK_R1_NAME, PAIRWISE
 *
 * pull frame TLVs:
 *   auth:
 *     required: SEQ, NONCE, R0KH_ID, R1KH_ID
 *   encrypted:
 *     required: PMK_R0_NAME, S1KH_ID
 *
 * response frame TLVs:
 *   auth:
 *     required: SEQ, NONCE, R0KH_ID, R1KH_ID
 *   encrypted:
 *     required: S1KH_ID
 *     optional: session TLVs
 *
 * push frame TLVs:
 *   auth:
 *     required: SEQ, R0KH_ID, R1KH_ID
 *   encrypted:
 *     required: S1KH_ID, PMK_R0_NAME, session TLVs
 *
 * sequence number request frame TLVs:
 *   auth:
 *     required: R0KH_ID, R1KH_ID, NONCE
 *
 * sequence number response frame TLVs:
 *   auth:
 *     required: SEQ, NONCE, R0KH_ID, R1KH_ID
 */

#ifdef _MSC_VER
#pragma pack(pop)
#endif /* _MSC_VER */


/* per STA state machine data */

struct wpa_authenticator;
struct wpa_state_machine;
struct rsn_pmksa_cache_entry;
struct eapol_state_machine;
struct ft_remote_seq;


struct ft_remote_r0kh {
	struct ft_remote_r0kh *next;
	u8 addr[ETH_ALEN];
	u8 id[FT_R0KH_ID_MAX_LEN];
	size_t id_len;
	u8 key[32];
	struct ft_remote_seq *seq;
};


struct ft_remote_r1kh {
	struct ft_remote_r1kh *next;
	u8 addr[ETH_ALEN];
	u8 id[FT_R1KH_ID_LEN];
	u8 key[32];
	struct ft_remote_seq *seq;
};


struct wpa_auth_config {
	int wpa;
	int wpa_key_mgmt;
	int wpa_pairwise;
	int wpa_group;
	int wpa_group_rekey;
	int wpa_strict_rekey;
	int wpa_gmk_rekey;
	int wpa_ptk_rekey;
	u32 wpa_group_update_count;
	u32 wpa_pairwise_update_count;
	int rsn_pairwise;
	int rsn_preauth;
	int eapol_version;
	int peerkey;
	int wmm_enabled;
	int wmm_uapsd;
	int disable_pmksa_caching;
	int okc;
	int tx_status;
#ifdef CONFIG_IEEE80211W
	enum mfp_options ieee80211w;
	int group_mgmt_cipher;
#endif /* CONFIG_IEEE80211W */
#ifdef CONFIG_IEEE80211R_AP
	u8 ssid[SSID_MAX_LEN];
	size_t ssid_len;
	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
	u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
	size_t r0_key_holder_len;
	u8 r1_key_holder[FT_R1KH_ID_LEN];
	u32 r0_key_lifetime;
	int rkh_pos_timeout;
	int rkh_neg_timeout;
	int rkh_pull_timeout; /* ms */
	int rkh_pull_retries;
	u32 reassociation_deadline;
	struct ft_remote_r0kh **r0kh_list;
	struct ft_remote_r1kh **r1kh_list;
	int pmk_r1_push;
	int ft_over_ds;
	int ft_psk_generate_local;
#endif /* CONFIG_IEEE80211R_AP */
	int disable_gtk;
	int ap_mlme;
#ifdef CONFIG_TESTING_OPTIONS
	double corrupt_gtk_rekey_mic_probability;
	u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
	size_t own_ie_override_len;
#endif /* CONFIG_TESTING_OPTIONS */
#ifdef CONFIG_P2P
	u8 ip_addr_go[4];
	u8 ip_addr_mask[4];
	u8 ip_addr_start[4];
	u8 ip_addr_end[4];
#endif /* CONFIG_P2P */
#ifdef CONFIG_FILS
	unsigned int fils_cache_id_set:1;
	u8 fils_cache_id[FILS_CACHE_ID_LEN];
#endif /* CONFIG_FILS */
};

typedef enum {
	LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
} logger_level;

typedef enum {
	WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
	WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
	WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
} wpa_eapol_variable;

struct wpa_auth_callbacks {
	void (*logger)(void *ctx, const u8 *addr, logger_level level,
		       const char *txt);
	void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
	int (*mic_failure_report)(void *ctx, const u8 *addr);
	void (*psk_failure_report)(void *ctx, const u8 *addr);
	void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
			  int value);
	int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
	const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
			      const u8 *prev_psk);
	int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
	int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
		       const u8 *addr, int idx, u8 *key, size_t key_len);
	int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
	int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
			  size_t data_len, int encrypt);
	int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
						 void *ctx), void *cb_ctx);
	int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
						  void *ctx), void *cb_ctx);
	int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
			  size_t data_len);
	int (*send_oui)(void *ctx, const u8 *dst, u8 oui_suffix, const u8 *data,
			size_t data_len);
#ifdef CONFIG_IEEE80211R_AP
	struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
	int (*send_ft_action)(void *ctx, const u8 *dst,
			      const u8 *data, size_t data_len);
	int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
			 size_t tspec_ielen);
#endif /* CONFIG_IEEE80211R_AP */
#ifdef CONFIG_MESH
	int (*start_ampe)(void *ctx, const u8 *sta_addr);
#endif /* CONFIG_MESH */
};

struct wpa_authenticator * wpa_init(const u8 *addr,
				    struct wpa_auth_config *conf,
				    const struct wpa_auth_callbacks *cb,
				    void *cb_ctx);
int wpa_init_keys(struct wpa_authenticator *wpa_auth);
void wpa_deinit(struct wpa_authenticator *wpa_auth);
int wpa_reconfig(struct wpa_authenticator *wpa_auth,
		 struct wpa_auth_config *conf);

enum {
	WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
	WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
	WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
	WPA_INVALID_MDIE, WPA_INVALID_PROTO
};

int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
			struct wpa_state_machine *sm,
			const u8 *wpa_ie, size_t wpa_ie_len,
			const u8 *mdie, size_t mdie_len,
			const u8 *owe_dh, size_t owe_dh_len);
int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
		      struct wpa_state_machine *sm,
		      const u8 *osen_ie, size_t osen_ie_len);
int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
struct wpa_state_machine *
wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
		  const u8 *p2p_dev_addr);
int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
			    struct wpa_state_machine *sm);
void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
void wpa_receive(struct wpa_authenticator *wpa_auth,
		 struct wpa_state_machine *sm,
		 u8 *data, size_t data_len);
enum wpa_event {
	WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
	WPA_REAUTH_EAPOL, WPA_ASSOC_FT, WPA_ASSOC_FILS
};
void wpa_remove_ptk(struct wpa_state_machine *sm);
int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
void wpa_auth_sm_notify(struct wpa_state_machine *sm);
void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
			     struct rsn_pmksa_cache_entry *entry);
struct rsn_pmksa_cache_entry *
wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
			       size_t *len);
int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
		       unsigned int pmk_len,
		       int session_timeout, struct eapol_state_machine *eapol);
int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
			       const u8 *pmk, size_t len, const u8 *sta_addr,
			       int session_timeout,
			       struct eapol_state_machine *eapol);
int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
			   const u8 *pmk, const u8 *pmkid);
void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
			   const u8 *sta_addr);
int wpa_auth_pmksa_list(struct wpa_authenticator *wpa_auth, char *buf,
			size_t len);
void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
int wpa_auth_pmksa_list_mesh(struct wpa_authenticator *wpa_auth, const u8 *addr,
			     char *buf, size_t len);
struct rsn_pmksa_cache_entry *
wpa_auth_pmksa_create_entry(const u8 *aa, const u8 *spa, const u8 *pmk,
			    const u8 *pmkid, int expiration);
int wpa_auth_pmksa_add_entry(struct wpa_authenticator *wpa_auth,
			     struct rsn_pmksa_cache_entry *entry);
struct rsn_pmksa_cache_entry *
wpa_auth_pmksa_get(struct wpa_authenticator *wpa_auth, const u8 *sta_addr,
		   const u8 *pmkid);
struct rsn_pmksa_cache_entry *
wpa_auth_pmksa_get_fils_cache_id(struct wpa_authenticator *wpa_auth,
				 const u8 *sta_addr, const u8 *pmkid);
void wpa_auth_pmksa_set_to_sm(struct rsn_pmksa_cache_entry *pmksa,
			      struct wpa_state_machine *sm,
			      struct wpa_authenticator *wpa_auth,
			      u8 *pmkid, u8 *pmk);
int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
				  struct wpa_state_machine *sm, int ack);

#ifdef CONFIG_IEEE80211R_AP
u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
				 size_t max_len, int auth_alg,
				 const u8 *req_ies, size_t req_ies_len);
void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid,
			 u16 auth_transaction, const u8 *ies, size_t ies_len,
			 void (*cb)(void *ctx, const u8 *dst, const u8 *bssid,
				    u16 auth_transaction, u16 resp,
				    const u8 *ies, size_t ies_len),
			 void *ctx);
u16 wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
			    size_t ies_len);
int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
		  const u8 *data, size_t data_len);
void wpa_ft_rrb_oui_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
		       const u8 *dst_addr, u8 oui_suffix, const u8 *data,
		       size_t data_len);
void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
void wpa_ft_deinit(struct wpa_authenticator *wpa_auth);
void wpa_ft_sta_deinit(struct wpa_state_machine *sm);
#endif /* CONFIG_IEEE80211R_AP */

void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos);
int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);

int wpa_auth_uses_sae(struct wpa_state_machine *sm);
int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);

int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);

struct radius_das_attrs;
int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
					 struct radius_das_attrs *attr);
void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);

int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
int fils_auth_pmk_to_ptk(struct wpa_state_machine *sm, const u8 *pmk,
			 size_t pmk_len, const u8 *snonce, const u8 *anonce);
int fils_decrypt_assoc(struct wpa_state_machine *sm, const u8 *fils_session,
		       const struct ieee80211_mgmt *mgmt, size_t frame_len,
		       u8 *pos, size_t left);
int fils_encrypt_assoc(struct wpa_state_machine *sm, u8 *buf,
		       size_t current_len, size_t max_len,
		       const struct wpabuf *hlp);
int fils_set_tk(struct wpa_state_machine *sm);
u8 * hostapd_eid_assoc_fils_session(struct wpa_state_machine *sm, u8 *eid,
				    const u8 *fils_session);
const u8 *  wpa_fils_validate_fils_session(struct wpa_state_machine *sm,
					   const u8 *ies, size_t ies_len,
					   const u8 *fils_session);
int wpa_fils_validate_key_confirm(struct wpa_state_machine *sm, const u8 *ies,
				  size_t ies_len);

int wpa_auth_write_fte(struct wpa_authenticator *wpa_auth, u8 *buf, size_t len);
void wpa_auth_get_fils_aead_params(struct wpa_state_machine *sm,
				   u8 *fils_anonce, u8 *fils_snonce,
				   u8 *fils_kek, size_t *fils_kek_len);

#endif /* WPA_AUTH_H */
Commit	Line	Data
6fc6879b JM	1	/*
6fc6879b JM	2	* hostapd - IEEE 802.11i-2004 / WPA Authenticator
09368515	3	* Copyright (c) 2004-2017, Jouni Malinen <j@w1.fi>
6fc6879b	4	*
0f3d578e JM	5	* This software may be distributed under the terms of the BSD license.
0f3d578e JM	6	* See README for more details.
6fc6879b JM	7	*/
	8
	9	#ifndef WPA_AUTH_H
	10	#define WPA_AUTH_H
	11
90973fb2 JM	12	#include "common/defs.h"
	13	#include "common/eapol_common.h"
	14	#include "common/wpa_common.h"
d6c3067d	15	#include "common/ieee802_11_defs.h"
6fc6879b	16
bc02843e JM	17	#define MAX_OWN_IE_OVERRIDE 256
bc02843e JM	18
6fc6879b JM	19	#ifdef _MSC_VER
	20	#pragma pack(push, 1)
	21	#endif /* _MSC_VER */
	22
c1e033b0 JM	23	/* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
c1e033b0 JM	24	*/
6fc6879b JM	25	struct ft_rrb_frame {
	26	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
	27	u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
2eba45c8	28	le16 action_length; /* little endian length of action_frame */
6fc6879b JM	29	u8 ap_address[ETH_ALEN];
	30	/*
	31	* Followed by action_length bytes of FT Action frame (from Category
	32	* field to the end of Action Frame body.
	33	*/
	34	} STRUCT_PACKED;
	35
	36	#define RSN_REMOTE_FRAME_TYPE_FT_RRB 1
	37
	38	#define FT_PACKET_REQUEST 0
	39	#define FT_PACKET_RESPONSE 1
50bd8e0a MB	40
	41	/* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r. These
	42	* use OUI Extended EtherType as the encapsulating format. */
	43	#define FT_PACKET_R0KH_R1KH_PULL 0x01
	44	#define FT_PACKET_R0KH_R1KH_RESP 0x02
	45	#define FT_PACKET_R0KH_R1KH_PUSH 0x03
eefe8630 MB	46	#define FT_PACKET_R0KH_R1KH_SEQ_REQ 0x04
eefe8630 MB	47	#define FT_PACKET_R0KH_R1KH_SEQ_RESP 0x05
6fc6879b	48
245fc96e MB	49	/* packet layout
	50	* IEEE 802 extended OUI ethertype frame header
	51	* u16 authlen (little endian)
	52	* multiple of struct ft_rrb_tlv (authenticated only, length = authlen)
	53	* multiple of struct ft_rrb_tlv (AES-SIV encrypted, AES-SIV needs an extra
	54	* blocksize length)
	55	*
	56	* AES-SIV AAD;
	57	* source MAC address (6)
	58	* authenticated-only TLVs (authlen)
	59	* subtype (1; FT_PACKET_*)
	60	*/
6fc6879b	61
245fc96e MB	62	#define FT_RRB_NONCE_LEN 16
	63
	64	#define FT_RRB_LAST_EMPTY 0 /* placeholder or padding */
	65
eefe8630	66	#define FT_RRB_SEQ 1 /* struct ft_rrb_seq */
245fc96e MB	67	#define FT_RRB_NONCE 2 /* size FT_RRB_NONCE_LEN */
	68	#define FT_RRB_TIMESTAMP 3 /* le32 unix seconds */
	69
	70	#define FT_RRB_R0KH_ID 4 /* FT_R0KH_ID_MAX_LEN */
	71	#define FT_RRB_R1KH_ID 5 /* FT_R1KH_ID_LEN */
	72	#define FT_RRB_S1KH_ID 6 /* ETH_ALEN */
6fc6879b	73
245fc96e MB	74	#define FT_RRB_PMK_R0_NAME 7 /* WPA_PMK_NAME_LEN */
	75	#define FT_RRB_PMK_R0 8 /* PMK_LEN */
	76	#define FT_RRB_PMK_R1_NAME 9 /* WPA_PMK_NAME_LEN */
	77	#define FT_RRB_PMK_R1 10 /* PMK_LEN */
	78
	79	#define FT_RRB_PAIRWISE 11 /* le16 */
	80
	81	struct ft_rrb_tlv {
	82	le16 type;
	83	le16 len;
	84	/* followed by data of length len */
6fc6879b JM	85	} STRUCT_PACKED;
6fc6879b JM	86
eefe8630 MB	87	struct ft_rrb_seq {
	88	le32 dom;
	89	le32 seq;
	90	le32 ts;
	91	} STRUCT_PACKED;
	92
245fc96e MB	93	/* session TLVs:
	94	* required: PMK_R1, PMK_R1_NAME, PAIRWISE
	95	*
	96	* pull frame TLVs:
	97	* auth:
eefe8630	98	* required: SEQ, NONCE, R0KH_ID, R1KH_ID
245fc96e MB	99	* encrypted:
	100	* required: PMK_R0_NAME, S1KH_ID
	101	*
	102	* response frame TLVs:
	103	* auth:
eefe8630	104	* required: SEQ, NONCE, R0KH_ID, R1KH_ID
245fc96e	105	* encrypted:
3a46cf93 MB	106	* required: S1KH_ID
3a46cf93 MB	107	* optional: session TLVs
245fc96e MB	108	*
	109	* push frame TLVs:
	110	* auth:
eefe8630	111	* required: SEQ, R0KH_ID, R1KH_ID
245fc96e MB	112	* encrypted:
245fc96e MB	113	* required: S1KH_ID, PMK_R0_NAME, session TLVs
eefe8630 MB	114	*
	115	* sequence number request frame TLVs:
	116	* auth:
	117	* required: R0KH_ID, R1KH_ID, NONCE
	118	*
	119	* sequence number response frame TLVs:
	120	* auth:
	121	* required: SEQ, NONCE, R0KH_ID, R1KH_ID
245fc96e MB	122	*/
245fc96e MB	123
6fc6879b JM	124	#ifdef _MSC_VER
	125	#pragma pack(pop)
	126	#endif /* _MSC_VER */
	127
	128
	129	/* per STA state machine data */
	130
	131	struct wpa_authenticator;
	132	struct wpa_state_machine;
	133	struct rsn_pmksa_cache_entry;
	134	struct eapol_state_machine;
eefe8630	135	struct ft_remote_seq;
6fc6879b JM	136
	137
	138	struct ft_remote_r0kh {
	139	struct ft_remote_r0kh *next;
	140	u8 addr[ETH_ALEN];
	141	u8 id[FT_R0KH_ID_MAX_LEN];
	142	size_t id_len;
245fc96e	143	u8 key[32];
eefe8630	144	struct ft_remote_seq *seq;
6fc6879b JM	145	};
	146
	147
	148	struct ft_remote_r1kh {
	149	struct ft_remote_r1kh *next;
	150	u8 addr[ETH_ALEN];
	151	u8 id[FT_R1KH_ID_LEN];
245fc96e	152	u8 key[32];
eefe8630	153	struct ft_remote_seq *seq;
6fc6879b JM	154	};
	155
	156
	157	struct wpa_auth_config {
	158	int wpa;
	159	int wpa_key_mgmt;
	160	int wpa_pairwise;
	161	int wpa_group;
	162	int wpa_group_rekey;
	163	int wpa_strict_rekey;
	164	int wpa_gmk_rekey;
581a8cde	165	int wpa_ptk_rekey;
41f140d3 GK	166	u32 wpa_group_update_count;
41f140d3 GK	167	u32 wpa_pairwise_update_count;
6fc6879b JM	168	int rsn_pairwise;
	169	int rsn_preauth;
	170	int eapol_version;
	171	int peerkey;
3ae0800c	172	int wmm_enabled;
721abef9	173	int wmm_uapsd;
cb465555	174	int disable_pmksa_caching;
bf98f7f3	175	int okc;
e4bf4db9	176	int tx_status;
6fc6879b	177	#ifdef CONFIG_IEEE80211W
70f8cc8e	178	enum mfp_options ieee80211w;
8dd9f9cd	179	int group_mgmt_cipher;
6fc6879b	180	#endif /* CONFIG_IEEE80211W */
4ec1fd8e	181	#ifdef CONFIG_IEEE80211R_AP
d6c3067d	182	u8 ssid[SSID_MAX_LEN];
6fc6879b JM	183	size_t ssid_len;
	184	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
	185	u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
	186	size_t r0_key_holder_len;
	187	u8 r1_key_holder[FT_R1KH_ID_LEN];
	188	u32 r0_key_lifetime;
3a46cf93 MB	189	int rkh_pos_timeout;
	190	int rkh_neg_timeout;
	191	int rkh_pull_timeout; /* ms */
	192	int rkh_pull_retries;
6fc6879b	193	u32 reassociation_deadline;
3a46cf93 MB	194	struct ft_remote_r0kh **r0kh_list;
3a46cf93 MB	195	struct ft_remote_r1kh **r1kh_list;
6fc6879b	196	int pmk_r1_push;
d7956add	197	int ft_over_ds;
96590564	198	int ft_psk_generate_local;
4ec1fd8e	199	#endif /* CONFIG_IEEE80211R_AP */
83421850	200	int disable_gtk;
88b32a99	201	int ap_mlme;
7af092a0 JB	202	#ifdef CONFIG_TESTING_OPTIONS
7af092a0 JB	203	double corrupt_gtk_rekey_mic_probability;
bc02843e JM	204	u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
bc02843e JM	205	size_t own_ie_override_len;
7af092a0	206	#endif /* CONFIG_TESTING_OPTIONS */
25ef8529 JM	207	#ifdef CONFIG_P2P
	208	u8 ip_addr_go[4];
	209	u8 ip_addr_mask[4];
	210	u8 ip_addr_start[4];
	211	u8 ip_addr_end[4];
	212	#endif /* CONFIG_P2P */
7eace378 JM	213	#ifdef CONFIG_FILS
	214	unsigned int fils_cache_id_set:1;
	215	u8 fils_cache_id[FILS_CACHE_ID_LEN];
	216	#endif /* CONFIG_FILS */
6fc6879b JM	217	};
	218
	219	typedef enum {
	220	LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
	221	} logger_level;
	222
	223	typedef enum {
	224	WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
	225	WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
	226	WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
	227	} wpa_eapol_variable;
	228
	229	struct wpa_auth_callbacks {
6fc6879b JM	230	void (logger)(void ctx, const u8 *addr, logger_level level,
	231	const char *txt);
	232	void (disconnect)(void ctx, const u8 *addr, u16 reason);
c772d054	233	int (mic_failure_report)(void ctx, const u8 *addr);
2c502460	234	void (psk_failure_report)(void ctx, const u8 *addr);
6fc6879b JM	235	void (set_eapol)(void ctx, const u8 *addr, wpa_eapol_variable var,
	236	int value);
	237	int (get_eapol)(void ctx, const u8 *addr, wpa_eapol_variable var);
759fd76b JM	238	const u8 * (get_psk)(void ctx, const u8 addr, const u8 p2p_dev_addr,
759fd76b JM	239	const u8 *prev_psk);
6fc6879b	240	int (get_msk)(void ctx, const u8 addr, u8 msk, size_t *len);
71934751 JM	241	int (set_key)(void ctx, int vlan_id, enum wpa_alg alg,
71934751 JM	242	const u8 addr, int idx, u8 key, size_t key_len);
6fc6879b	243	int (get_seqnum)(void ctx, const u8 addr, int idx, u8 seq);
6fc6879b JM	244	int (send_eapol)(void ctx, const u8 addr, const u8 data,
	245	size_t data_len, int encrypt);
	246	int (for_each_sta)(void ctx, int (cb)(struct wpa_state_machine sm,
	247	void ctx), void cb_ctx);
bf98f7f3 JM	248	int (for_each_auth)(void ctx, int (cb)(struct wpa_authenticator a,
bf98f7f3 JM	249	void ctx), void cb_ctx);
6fc6879b JM	250	int (send_ether)(void ctx, const u8 dst, u16 proto, const u8 data,
6fc6879b JM	251	size_t data_len);
50bd8e0a MB	252	int (send_oui)(void ctx, const u8 dst, u8 oui_suffix, const u8 data,
50bd8e0a MB	253	size_t data_len);
4ec1fd8e	254	#ifdef CONFIG_IEEE80211R_AP
6fc6879b JM	255	struct wpa_state_machine * (add_sta)(void ctx, const u8 *sta_addr);
	256	int (send_ft_action)(void ctx, const u8 *dst,
	257	const u8 *data, size_t data_len);
88b32a99	258	int (add_tspec)(void ctx, const u8 sta_addr, u8 tspec_ie,
006309b5	259	size_t tspec_ielen);
4ec1fd8e	260	#endif /* CONFIG_IEEE80211R_AP */
0f950df0 TP	261	#ifdef CONFIG_MESH
	262	int (start_ampe)(void ctx, const u8 *sta_addr);
	263	#endif /* CONFIG_MESH */
6fc6879b JM	264	};
	265
	266	struct wpa_authenticator * wpa_init(const u8 *addr,
	267	struct wpa_auth_config *conf,
cef8fac0 JB	268	const struct wpa_auth_callbacks *cb,
cef8fac0 JB	269	void *cb_ctx);
bdffdc5d	270	int wpa_init_keys(struct wpa_authenticator *wpa_auth);
6fc6879b JM	271	void wpa_deinit(struct wpa_authenticator *wpa_auth);
	272	int wpa_reconfig(struct wpa_authenticator *wpa_auth,
	273	struct wpa_auth_config *conf);
	274
	275	enum {
	276	WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
	277	WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
	278	WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
2100a768	279	WPA_INVALID_MDIE, WPA_INVALID_PROTO
6fc6879b	280	};
91d91abf	281
6fc6879b JM	282	int wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
	283	struct wpa_state_machine *sm,
	284	const u8 *wpa_ie, size_t wpa_ie_len,
09368515 JM	285	const u8 *mdie, size_t mdie_len,
09368515 JM	286	const u8 *owe_dh, size_t owe_dh_len);
a14896e8 JM	287	int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
	288	struct wpa_state_machine *sm,
	289	const u8 *osen_ie, size_t osen_ie_len);
f3f7540e	290	int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
6fc6879b	291	struct wpa_state_machine *
94ddef3e JM	292	wpa_auth_sta_init(struct wpa_authenticator wpa_auth, const u8 addr,
94ddef3e JM	293	const u8 *p2p_dev_addr);
6f9b5d16 JM	294	int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
6f9b5d16 JM	295	struct wpa_state_machine *sm);
a8d05fca	296	void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
6fc6879b JM	297	void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
	298	void wpa_receive(struct wpa_authenticator *wpa_auth,
	299	struct wpa_state_machine *sm,
	300	u8 *data, size_t data_len);
bb119228	301	enum wpa_event {
6fc6879b	302	WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
957bff83	303	WPA_REAUTH_EAPOL, WPA_ASSOC_FT, WPA_ASSOC_FILS
bb119228	304	};
6fc6879b	305	void wpa_remove_ptk(struct wpa_state_machine *sm);
bb119228	306	int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
6fc6879b JM	307	void wpa_auth_sm_notify(struct wpa_state_machine *sm);
	308	void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
	309	int wpa_get_mib(struct wpa_authenticator wpa_auth, char buf, size_t buflen);
	310	int wpa_get_mib_sta(struct wpa_state_machine sm, char buf, size_t buflen);
	311	void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
	312	int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
ff36ff00	313	int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
6fc6879b JM	314	int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
	315	int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
	316	int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
	317	struct rsn_pmksa_cache_entry *entry);
	318	struct rsn_pmksa_cache_entry *
	319	wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
	320	void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
	321	const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
	322	size_t *len);
	323	int wpa_auth_pmksa_add(struct wpa_state_machine sm, const u8 pmk,
207976f0	324	unsigned int pmk_len,
6fc6879b JM	325	int session_timeout, struct eapol_state_machine *eapol);
	326	int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
	327	const u8 pmk, size_t len, const u8 sta_addr,
	328	int session_timeout,
	329	struct eapol_state_machine *eapol);
f2991170	330	int wpa_auth_pmksa_add_sae(struct wpa_authenticator wpa_auth, const u8 addr,
70c93963	331	const u8 pmk, const u8 pmkid);
901d1fe1 JM	332	void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
901d1fe1 JM	333	const u8 *sta_addr);
b8daac18 MH	334	int wpa_auth_pmksa_list(struct wpa_authenticator wpa_auth, char buf,
b8daac18 MH	335	size_t len);
4c522c77	336	void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
4d77d80e MH	337	int wpa_auth_pmksa_list_mesh(struct wpa_authenticator wpa_auth, const u8 addr,
	338	char *buf, size_t len);
	339	struct rsn_pmksa_cache_entry *
	340	wpa_auth_pmksa_create_entry(const u8 aa, const u8 spa, const u8 *pmk,
	341	const u8 *pmkid, int expiration);
	342	int wpa_auth_pmksa_add_entry(struct wpa_authenticator *wpa_auth,
	343	struct rsn_pmksa_cache_entry *entry);
9f2cf23e	344	struct rsn_pmksa_cache_entry *
c1bd4bac JM	345	wpa_auth_pmksa_get(struct wpa_authenticator wpa_auth, const u8 sta_addr,
c1bd4bac JM	346	const u8 *pmkid);
7eace378 JM	347	struct rsn_pmksa_cache_entry *
	348	wpa_auth_pmksa_get_fils_cache_id(struct wpa_authenticator *wpa_auth,
	349	const u8 sta_addr, const u8 pmkid);
9f2cf23e MH	350	void wpa_auth_pmksa_set_to_sm(struct rsn_pmksa_cache_entry *pmksa,
	351	struct wpa_state_machine *sm,
	352	struct wpa_authenticator *wpa_auth,
	353	u8 pmkid, u8 pmk);
6fc6879b	354	int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
e4bf4db9 JM	355	void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
e4bf4db9 JM	356	struct wpa_state_machine *sm, int ack);
6fc6879b	357
4ec1fd8e	358	#ifdef CONFIG_IEEE80211R_AP
6fc6879b	359	u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine sm, u8 pos,
f238cf9f JM	360	size_t max_len, int auth_alg,
f238cf9f JM	361	const u8 *req_ies, size_t req_ies_len);
6fc6879b JM	362	void wpa_ft_process_auth(struct wpa_state_machine sm, const u8 bssid,
	363	u16 auth_transaction, const u8 *ies, size_t ies_len,
	364	void (cb)(void ctx, const u8 dst, const u8 bssid,
	365	u16 auth_transaction, u16 resp,
	366	const u8 *ies, size_t ies_len),
	367	void *ctx);
	368	u16 wpa_ft_validate_reassoc(struct wpa_state_machine sm, const u8 ies,
	369	size_t ies_len);
	370	int wpa_ft_action_rx(struct wpa_state_machine sm, const u8 data, size_t len);
	371	int wpa_ft_rrb_rx(struct wpa_authenticator wpa_auth, const u8 src_addr,
	372	const u8 *data, size_t data_len);
50bd8e0a MB	373	void wpa_ft_rrb_oui_rx(struct wpa_authenticator wpa_auth, const u8 src_addr,
	374	const u8 dst_addr, u8 oui_suffix, const u8 data,
	375	size_t data_len);
6fc6879b	376	void wpa_ft_push_pmk_r1(struct wpa_authenticator wpa_auth, const u8 addr);
eefe8630	377	void wpa_ft_deinit(struct wpa_authenticator *wpa_auth);
3a46cf93	378	void wpa_ft_sta_deinit(struct wpa_state_machine *sm);
4ec1fd8e	379	#endif /* CONFIG_IEEE80211R_AP */
6fc6879b	380
d32d94db XC	381	void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
	382	void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
	383	int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine sm, u8 pos);
d32d94db	384	int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine sm, u8 pos);
d32d94db	385
c10347f2	386	int wpa_auth_uses_sae(struct wpa_state_machine *sm);
aa189ac9	387	int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
c10347f2	388
25ef8529 JM	389	int wpa_auth_get_ip_addr(struct wpa_state_machine sm, u8 addr);
25ef8529 JM	390
cbc210de JM	391	struct radius_das_attrs;
	392	int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
	393	struct radius_das_attrs *attr);
34782730	394	void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
cbc210de	395
7cebc8e2 MB	396	int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
7cebc8e2 MB	397	int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
c4fd6d8a JM	398	int fils_auth_pmk_to_ptk(struct wpa_state_machine sm, const u8 pmk,
c4fd6d8a JM	399	size_t pmk_len, const u8 snonce, const u8 anonce);
78815f3d JM	400	int fils_decrypt_assoc(struct wpa_state_machine sm, const u8 fils_session,
	401	const struct ieee80211_mgmt *mgmt, size_t frame_len,
	402	u8 *pos, size_t left);
e73ffa09	403	int fils_encrypt_assoc(struct wpa_state_machine sm, u8 buf,
91d91abf JM	404	size_t current_len, size_t max_len,
91d91abf JM	405	const struct wpabuf *hlp);
da24c5aa	406	int fils_set_tk(struct wpa_state_machine *sm);
fa61bff6 JM	407	u8 * hostapd_eid_assoc_fils_session(struct wpa_state_machine sm, u8 eid,
fa61bff6 JM	408	const u8 *fils_session);
087631b9 JM	409	const u8 * wpa_fils_validate_fils_session(struct wpa_state_machine *sm,
	410	const u8 *ies, size_t ies_len,
	411	const u8 *fils_session);
bd599353 JM	412	int wpa_fils_validate_key_confirm(struct wpa_state_machine sm, const u8 ies,
bd599353 JM	413	size_t ies_len);
7cebc8e2	414
5db997e3	415	int wpa_auth_write_fte(struct wpa_authenticator wpa_auth, u8 buf, size_t len);
8acbf85f JM	416	void wpa_auth_get_fils_aead_params(struct wpa_state_machine *sm,
	417	u8 fils_anonce, u8 fils_snonce,
	418	u8 fils_kek, size_t fils_kek_len);
5db997e3	419
6fc6879b	420	#endif /* WPA_AUTH_H */