[mirror_ubuntu-hirsute-kernel.git] / net / mac80211 / key.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright 2002-2004, Instant802 Networks, Inc.
 * Copyright 2005, Devicescape Software, Inc.
 * Copyright (C) 2019 Intel Corporation
 */

#ifndef IEEE80211_KEY_H
#define IEEE80211_KEY_H

#include <linux/types.h>
#include <linux/list.h>
#include <linux/crypto.h>
#include <linux/rcupdate.h>
#include <crypto/arc4.h>
#include <net/mac80211.h>

#define NUM_DEFAULT_KEYS 4
#define NUM_DEFAULT_MGMT_KEYS 2
#define NUM_DEFAULT_BEACON_KEYS 2
#define INVALID_PTK_KEYIDX 2 /* Keyidx always pointing to a NULL key for PTK */

struct ieee80211_local;
struct ieee80211_sub_if_data;
struct sta_info;

/**
 * enum ieee80211_internal_key_flags - internal key flags
 *
 * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
 *	in the hardware for TX crypto hardware acceleration.
 * @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
 * @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
 */
enum ieee80211_internal_key_flags {
	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
	KEY_FLAG_TAINTED		= BIT(1),
	KEY_FLAG_CIPHER_SCHEME		= BIT(2),
};

enum ieee80211_internal_tkip_state {
	TKIP_STATE_NOT_INIT,
	TKIP_STATE_PHASE1_DONE,
	TKIP_STATE_PHASE1_HW_UPLOADED,
};

struct tkip_ctx {
	u16 p1k[5];	/* p1k cache */
	u32 p1k_iv32;	/* iv32 for which p1k computed */
	enum ieee80211_internal_tkip_state state;
};

struct tkip_ctx_rx {
	struct tkip_ctx ctx;
	u32 iv32;	/* current iv32 */
	u16 iv16;	/* current iv16 */
};

struct ieee80211_key {
	struct ieee80211_local *local;
	struct ieee80211_sub_if_data *sdata;
	struct sta_info *sta;

	/* for sdata list */
	struct list_head list;

	/* protected by key mutex */
	unsigned int flags;

	union {
		struct {
			/* protects tx context */
			spinlock_t txlock;

			/* last used TSC */
			struct tkip_ctx tx;

			/* last received RSC */
			struct tkip_ctx_rx rx[IEEE80211_NUM_TIDS];

			/* number of mic failures */
			u32 mic_failures;
		} tkip;
		struct {
			/*
			 * Last received packet number. The first
			 * IEEE80211_NUM_TIDS counters are used with Data
			 * frames and the last counter is used with Robust
			 * Management frames.
			 */
			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
			struct crypto_aead *tfm;
			u32 replays; /* dot11RSNAStatsCCMPReplays */
		} ccmp;
		struct {
			u8 rx_pn[IEEE80211_CMAC_PN_LEN];
			struct crypto_shash *tfm;
			u32 replays; /* dot11RSNAStatsCMACReplays */
			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
		} aes_cmac;
		struct {
			u8 rx_pn[IEEE80211_GMAC_PN_LEN];
			struct crypto_aead *tfm;
			u32 replays; /* dot11RSNAStatsCMACReplays */
			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
		} aes_gmac;
		struct {
			/* Last received packet number. The first
			 * IEEE80211_NUM_TIDS counters are used with Data
			 * frames and the last counter is used with Robust
			 * Management frames.
			 */
			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
			struct crypto_aead *tfm;
			u32 replays; /* dot11RSNAStatsGCMPReplays */
		} gcmp;
		struct {
			/* generic cipher scheme */
			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
		} gen;
	} u;

#ifdef CONFIG_MAC80211_DEBUGFS
	struct {
		struct dentry *stalink;
		struct dentry *dir;
		int cnt;
	} debugfs;
#endif

	/*
	 * key config, must be last because it contains key
	 * material as variable length member
	 */
	struct ieee80211_key_conf conf;
};

struct ieee80211_key *
ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
		    const u8 *key_data,
		    size_t seq_len, const u8 *seq,
		    const struct ieee80211_cipher_scheme *cs);
/*
 * Insert a key into data structures (sdata, sta if necessary)
 * to make it used, free old key. On failure, also free the new key.
 */
int ieee80211_key_link(struct ieee80211_key *key,
		       struct ieee80211_sub_if_data *sdata,
		       struct sta_info *sta);
int ieee80211_set_tx_key(struct ieee80211_key *key);
void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
void ieee80211_key_free_unused(struct ieee80211_key *key);
void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
			       bool uni, bool multi);
void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
				    int idx);
void ieee80211_set_default_beacon_key(struct ieee80211_sub_if_data *sdata,
				      int idx);
void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
			 bool force_synchronize);
void ieee80211_free_sta_keys(struct ieee80211_local *local,
			     struct sta_info *sta);
void ieee80211_reenable_keys(struct ieee80211_sub_if_data *sdata);

#define key_mtx_dereference(local, ref) \
	rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))

void ieee80211_delayed_tailroom_dec(struct work_struct *wk);

#endif /* IEEE80211_KEY_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
f0706e82 JB	2	/*
	3	* Copyright 2002-2004, Instant802 Networks, Inc.
	4	* Copyright 2005, Devicescape Software, Inc.
624ff4b2	5	* Copyright (C) 2019 Intel Corporation
f0706e82 JB	6	*/
	7
	8	#ifndef IEEE80211_KEY_H
	9	#define IEEE80211_KEY_H
	10
	11	#include <linux/types.h>
8f37171a	12	#include <linux/list.h>
f0706e82	13	#include <linux/crypto.h>
db4d1169	14	#include <linux/rcupdate.h>
5fdb3735	15	#include <crypto/arc4.h>
f0706e82 JB	16	#include <net/mac80211.h>
f0706e82 JB	17
e31b8213 JB	18	#define NUM_DEFAULT_KEYS 4
e31b8213 JB	19	#define NUM_DEFAULT_MGMT_KEYS 2
e5473e80	20	#define NUM_DEFAULT_BEACON_KEYS 2
96fc6efb	21	#define INVALID_PTK_KEYIDX 2 /* Keyidx always pointing to a NULL key for PTK */
e31b8213	22
11a843b7 JB	23	struct ieee80211_local;
	24	struct ieee80211_sub_if_data;
	25	struct sta_info;
	26
db4d1169 JB	27	/**
	28	* enum ieee80211_internal_key_flags - internal key flags
	29	*
	30	* @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
	31	* in the hardware for TX crypto hardware acceleration.
95acac61	32	* @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
c7ef38e0	33	* @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
db4d1169 JB	34	*/
	35	enum ieee80211_internal_key_flags {
	36	KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
95acac61	37	KEY_FLAG_TAINTED = BIT(1),
c7ef38e0	38	KEY_FLAG_CIPHER_SCHEME = BIT(2),
db4d1169	39	};
11a843b7	40
ca99861d	41	enum ieee80211_internal_tkip_state {
	42	TKIP_STATE_NOT_INIT,
	43	TKIP_STATE_PHASE1_DONE,
	44	TKIP_STATE_PHASE1_HW_UPLOADED,
	45	};
	46
b0f76b33	47	struct tkip_ctx {
523b02ea JB	48	u16 p1k[5]; /* p1k cache */
523b02ea JB	49	u32 p1k_iv32; /* iv32 for which p1k computed */
ca99861d	50	enum ieee80211_internal_tkip_state state;
b0f76b33 HH	51	};
b0f76b33 HH	52
f8079d43 EP	53	struct tkip_ctx_rx {
	54	struct tkip_ctx ctx;
	55	u32 iv32; /* current iv32 */
	56	u16 iv16; /* current iv16 */
	57	};
	58
f0706e82	59	struct ieee80211_key {
11a843b7 JB	60	struct ieee80211_local *local;
	61	struct ieee80211_sub_if_data *sdata;
	62	struct sta_info *sta;
	63
3b96766f	64	/* for sdata list */
11a843b7 JB	65	struct list_head list;
11a843b7 JB	66
ad0e2b5a	67	/* protected by key mutex */
11a843b7 JB	68	unsigned int flags;
11a843b7 JB	69
f0706e82 JB	70	union {
f0706e82 JB	71	struct {
523b02ea JB	72	/* protects tx context */
	73	spinlock_t txlock;
	74
f0706e82	75	/* last used TSC */
b0f76b33	76	struct tkip_ctx tx;
f0706e82 JB	77
f0706e82 JB	78	/* last received RSC */
f8079d43	79	struct tkip_ctx_rx rx[IEEE80211_NUM_TIDS];
b98ea058 S	80
	81	/* number of mic failures */
	82	u32 mic_failures;
f0706e82 JB	83	} tkip;
f0706e82 JB	84	struct {
9190252c JM	85	/*
9190252c JM	86	* Last received packet number. The first
5a306f58	87	* IEEE80211_NUM_TIDS counters are used with Data
9190252c JM	88	* frames and the last counter is used with Robust
	89	* Management frames.
	90	*/
4325f6ca	91	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
7ec7c4a9	92	struct crypto_aead *tfm;
f0706e82	93	u32 replays; /* dot11RSNAStatsCCMPReplays */
f0706e82	94	} ccmp;
765cb46a	95	struct {
4325f6ca	96	u8 rx_pn[IEEE80211_CMAC_PN_LEN];
26717828	97	struct crypto_shash *tfm;
765cb46a JM	98	u32 replays; /* dot11RSNAStatsCMACReplays */
765cb46a JM	99	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
765cb46a	100	} aes_cmac;
8ade538b	101	struct {
8ade538b JM	102	u8 rx_pn[IEEE80211_GMAC_PN_LEN];
	103	struct crypto_aead *tfm;
	104	u32 replays; /* dot11RSNAStatsCMACReplays */
	105	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
	106	} aes_gmac;
00b9cfa3	107	struct {
00b9cfa3 JM	108	/* Last received packet number. The first
	109	* IEEE80211_NUM_TIDS counters are used with Data
	110	* frames and the last counter is used with Robust
	111	* Management frames.
	112	*/
	113	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
	114	struct crypto_aead *tfm;
	115	u32 replays; /* dot11RSNAStatsGCMPReplays */
	116	} gcmp;
2475b1cc MS	117	struct {
2475b1cc MS	118	/* generic cipher scheme */
a31cf1c6	119	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
2475b1cc	120	} gen;
f0706e82	121	} u;
f0706e82	122
e9f207f0 JB	123	#ifdef CONFIG_MAC80211_DEBUGFS
	124	struct {
	125	struct dentry *stalink;
	126	struct dentry *dir;
d9c58f30	127	int cnt;
e9f207f0 JB	128	} debugfs;
	129	#endif
	130
8f20fc24 JB	131	/*
	132	* key config, must be last because it contains key
	133	* material as variable length member
	134	*/
	135	struct ieee80211_key_conf conf;
f0706e82 JB	136	};
f0706e82 JB	137
2475b1cc MS	138	struct ieee80211_key *
	139	ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
	140	const u8 *key_data,
	141	size_t seq_len, const u8 *seq,
	142	const struct ieee80211_cipher_scheme *cs);
db4d1169 JB	143	/*
db4d1169 JB	144	* Insert a key into data structures (sdata, sta if necessary)
79cf2dfa	145	* to make it used, free old key. On failure, also free the new key.
db4d1169	146	*/
79cf2dfa JB	147	int ieee80211_key_link(struct ieee80211_key *key,
	148	struct ieee80211_sub_if_data *sdata,
	149	struct sta_info *sta);
96fc6efb	150	int ieee80211_set_tx_key(struct ieee80211_key *key);
3b8d9c29	151	void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
79cf2dfa	152	void ieee80211_key_free_unused(struct ieee80211_key *key);
f7e0104c JB	153	void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
f7e0104c JB	154	bool uni, bool multi);
3cfcf6ac JM	155	void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
3cfcf6ac JM	156	int idx);
e5473e80 JM	157	void ieee80211_set_default_beacon_key(struct ieee80211_sub_if_data *sdata,
e5473e80 JM	158	int idx);
7907c7d3 JB	159	void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
7907c7d3 JB	160	bool force_synchronize);
6d10e46b JB	161	void ieee80211_free_sta_keys(struct ieee80211_local *local,
6d10e46b JB	162	struct sta_info *sta);
624ff4b2	163	void ieee80211_reenable_keys(struct ieee80211_sub_if_data *sdata);
11a843b7	164
40b275b6 JB	165	#define key_mtx_dereference(local, ref) \
	166	rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
	167
8d1f7ecd JB	168	void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
8d1f7ecd JB	169
f0706e82	170	#endif /* IEEE80211_KEY_H */