[linux.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, 2022-2023 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 ieee80211_link_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.
 */
enum ieee80211_internal_key_flags {
	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
	KEY_FLAG_TAINTED		= BIT(1),
};

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

	unsigned int color;

	/*
	 * 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);
/*
 * 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_link_data *link,
		       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_link_data *link, int idx,
			       bool uni, bool multi);
void ieee80211_set_default_mgmt_key(struct ieee80211_link_data *link,
				    int idx);
void ieee80211_set_default_beacon_key(struct ieee80211_link_data *link,
				      int idx);
void ieee80211_remove_link_keys(struct ieee80211_link_data *link,
				struct list_head *keys);
void ieee80211_free_key_list(struct ieee80211_local *local,
			     struct list_head *keys);
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);
int ieee80211_key_switch_links(struct ieee80211_sub_if_data *sdata,
			       unsigned long del_links_mask,
			       unsigned long add_links_mask);
void ieee80211_delayed_tailroom_dec(struct wiphy *wiphy,
				    struct wiphy_work *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.
e3208fb7	5	* Copyright (C) 2019, 2022-2023 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;
11a843b7 JB	24	struct ieee80211_sub_if_data;
ccdde7c7	25	struct ieee80211_link_data;
11a843b7 JB	26	struct sta_info;
11a843b7 JB	27
db4d1169 JB	28	/**
	29	* enum ieee80211_internal_key_flags - internal key flags
	30	*
	31	* @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
	32	* in the hardware for TX crypto hardware acceleration.
95acac61	33	* @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
db4d1169 JB	34	*/
	35	enum ieee80211_internal_key_flags {
	36	KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
95acac61	37	KEY_FLAG_TAINTED = BIT(1),
db4d1169	38	};
11a843b7	39
ca99861d	40	enum ieee80211_internal_tkip_state {
	41	TKIP_STATE_NOT_INIT,
	42	TKIP_STATE_PHASE1_DONE,
	43	TKIP_STATE_PHASE1_HW_UPLOADED,
	44	};
	45
b0f76b33	46	struct tkip_ctx {
523b02ea JB	47	u16 p1k[5]; /* p1k cache */
523b02ea JB	48	u32 p1k_iv32; /* iv32 for which p1k computed */
ca99861d	49	enum ieee80211_internal_tkip_state state;
b0f76b33 HH	50	};
b0f76b33 HH	51
f8079d43 EP	52	struct tkip_ctx_rx {
	53	struct tkip_ctx ctx;
	54	u32 iv32; /* current iv32 */
	55	u16 iv16; /* current iv16 */
	56	};
	57
f0706e82	58	struct ieee80211_key {
11a843b7 JB	59	struct ieee80211_local *local;
	60	struct ieee80211_sub_if_data *sdata;
	61	struct sta_info *sta;
	62
3b96766f	63	/* for sdata list */
11a843b7 JB	64	struct list_head list;
11a843b7 JB	65
ad0e2b5a	66	/* protected by key mutex */
11a843b7 JB	67	unsigned int flags;
11a843b7 JB	68
f0706e82 JB	69	union {
f0706e82 JB	70	struct {
523b02ea JB	71	/* protects tx context */
	72	spinlock_t txlock;
	73
f0706e82	74	/* last used TSC */
b0f76b33	75	struct tkip_ctx tx;
f0706e82 JB	76
f0706e82 JB	77	/* last received RSC */
f8079d43	78	struct tkip_ctx_rx rx[IEEE80211_NUM_TIDS];
b98ea058 S	79
	80	/* number of mic failures */
	81	u32 mic_failures;
f0706e82 JB	82	} tkip;
f0706e82 JB	83	struct {
9190252c JM	84	/*
9190252c JM	85	* Last received packet number. The first
5a306f58	86	* IEEE80211_NUM_TIDS counters are used with Data
9190252c JM	87	* frames and the last counter is used with Robust
	88	* Management frames.
	89	*/
4325f6ca	90	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
7ec7c4a9	91	struct crypto_aead *tfm;
f0706e82	92	u32 replays; /* dot11RSNAStatsCCMPReplays */
f0706e82	93	} ccmp;
765cb46a	94	struct {
4325f6ca	95	u8 rx_pn[IEEE80211_CMAC_PN_LEN];
26717828	96	struct crypto_shash *tfm;
765cb46a JM	97	u32 replays; /* dot11RSNAStatsCMACReplays */
765cb46a JM	98	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
765cb46a	99	} aes_cmac;
8ade538b	100	struct {
8ade538b JM	101	u8 rx_pn[IEEE80211_GMAC_PN_LEN];
	102	struct crypto_aead *tfm;
	103	u32 replays; /* dot11RSNAStatsCMACReplays */
	104	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
	105	} aes_gmac;
00b9cfa3	106	struct {
00b9cfa3 JM	107	/* Last received packet number. The first
	108	* IEEE80211_NUM_TIDS counters are used with Data
	109	* frames and the last counter is used with Robust
	110	* Management frames.
	111	*/
	112	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
	113	struct crypto_aead *tfm;
	114	u32 replays; /* dot11RSNAStatsGCMPReplays */
	115	} gcmp;
2475b1cc MS	116	struct {
2475b1cc MS	117	/* generic cipher scheme */
a31cf1c6	118	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
2475b1cc	119	} gen;
f0706e82	120	} u;
f0706e82	121
e9f207f0 JB	122	#ifdef CONFIG_MAC80211_DEBUGFS
	123	struct {
	124	struct dentry *stalink;
	125	struct dentry *dir;
d9c58f30	126	int cnt;
e9f207f0 JB	127	} debugfs;
	128	#endif
	129
94034c40 MV	130	unsigned int color;
94034c40 MV	131
8f20fc24 JB	132	/*
	133	* key config, must be last because it contains key
	134	* material as variable length member
	135	*/
	136	struct ieee80211_key_conf conf;
f0706e82 JB	137	};
f0706e82 JB	138
2475b1cc MS	139	struct ieee80211_key *
	140	ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
	141	const u8 *key_data,
23a5f0af	142	size_t seq_len, const u8 *seq);
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	147	int ieee80211_key_link(struct ieee80211_key *key,
ccdde7c7	148	struct ieee80211_link_data *link,
79cf2dfa	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);
ccdde7c7	153	void ieee80211_set_default_key(struct ieee80211_link_data *link, int idx,
f7e0104c	154	bool uni, bool multi);
ccdde7c7	155	void ieee80211_set_default_mgmt_key(struct ieee80211_link_data *link,
3cfcf6ac	156	int idx);
ccdde7c7	157	void ieee80211_set_default_beacon_key(struct ieee80211_link_data *link,
e5473e80	158	int idx);
ccdde7c7 JB	159	void ieee80211_remove_link_keys(struct ieee80211_link_data *link,
	160	struct list_head *keys);
	161	void ieee80211_free_key_list(struct ieee80211_local *local,
	162	struct list_head *keys);
7907c7d3 JB	163	void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
7907c7d3 JB	164	bool force_synchronize);
6d10e46b JB	165	void ieee80211_free_sta_keys(struct ieee80211_local *local,
6d10e46b JB	166	struct sta_info *sta);
624ff4b2	167	void ieee80211_reenable_keys(struct ieee80211_sub_if_data *sdata);
3d901102 JB	168	int ieee80211_key_switch_links(struct ieee80211_sub_if_data *sdata,
	169	unsigned long del_links_mask,
	170	unsigned long add_links_mask);
e3208fb7 JB	171	void ieee80211_delayed_tailroom_dec(struct wiphy *wiphy,
e3208fb7 JB	172	struct wiphy_work *wk);
8d1f7ecd	173
f0706e82	174	#endif /* IEEE80211_KEY_H */