xref: /openbmc/linux/net/mac80211/key.h (revision bc000245)
1 /*
2  * Copyright 2002-2004, Instant802 Networks, Inc.
3  * Copyright 2005, Devicescape Software, Inc.
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 
10 #ifndef IEEE80211_KEY_H
11 #define IEEE80211_KEY_H
12 
13 #include <linux/types.h>
14 #include <linux/list.h>
15 #include <linux/crypto.h>
16 #include <linux/rcupdate.h>
17 #include <net/mac80211.h>
18 
19 #define NUM_DEFAULT_KEYS 4
20 #define NUM_DEFAULT_MGMT_KEYS 2
21 
22 struct ieee80211_local;
23 struct ieee80211_sub_if_data;
24 struct sta_info;
25 
26 /**
27  * enum ieee80211_internal_key_flags - internal key flags
28  *
29  * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
30  *	in the hardware for TX crypto hardware acceleration.
31  * @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
32  */
33 enum ieee80211_internal_key_flags {
34 	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
35 	KEY_FLAG_TAINTED		= BIT(1),
36 };
37 
38 enum ieee80211_internal_tkip_state {
39 	TKIP_STATE_NOT_INIT,
40 	TKIP_STATE_PHASE1_DONE,
41 	TKIP_STATE_PHASE1_HW_UPLOADED,
42 };
43 
44 struct tkip_ctx {
45 	u32 iv32;	/* current iv32 */
46 	u16 iv16;	/* current iv16 */
47 	u16 p1k[5];	/* p1k cache */
48 	u32 p1k_iv32;	/* iv32 for which p1k computed */
49 	enum ieee80211_internal_tkip_state state;
50 };
51 
52 struct ieee80211_key {
53 	struct ieee80211_local *local;
54 	struct ieee80211_sub_if_data *sdata;
55 	struct sta_info *sta;
56 
57 	/* for sdata list */
58 	struct list_head list;
59 
60 	/* protected by key mutex */
61 	unsigned int flags;
62 
63 	union {
64 		struct {
65 			/* protects tx context */
66 			spinlock_t txlock;
67 
68 			/* last used TSC */
69 			struct tkip_ctx tx;
70 
71 			/* last received RSC */
72 			struct tkip_ctx rx[IEEE80211_NUM_TIDS];
73 
74 			/* number of mic failures */
75 			u32 mic_failures;
76 		} tkip;
77 		struct {
78 			atomic64_t tx_pn;
79 			/*
80 			 * Last received packet number. The first
81 			 * IEEE80211_NUM_TIDS counters are used with Data
82 			 * frames and the last counter is used with Robust
83 			 * Management frames.
84 			 */
85 			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
86 			struct crypto_aead *tfm;
87 			u32 replays; /* dot11RSNAStatsCCMPReplays */
88 		} ccmp;
89 		struct {
90 			atomic64_t tx_pn;
91 			u8 rx_pn[IEEE80211_CMAC_PN_LEN];
92 			struct crypto_cipher *tfm;
93 			u32 replays; /* dot11RSNAStatsCMACReplays */
94 			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
95 		} aes_cmac;
96 	} u;
97 
98 	/* number of times this key has been used */
99 	int tx_rx_count;
100 
101 #ifdef CONFIG_MAC80211_DEBUGFS
102 	struct {
103 		struct dentry *stalink;
104 		struct dentry *dir;
105 		int cnt;
106 	} debugfs;
107 #endif
108 
109 	/*
110 	 * key config, must be last because it contains key
111 	 * material as variable length member
112 	 */
113 	struct ieee80211_key_conf conf;
114 };
115 
116 struct ieee80211_key *ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
117 					  const u8 *key_data,
118 					  size_t seq_len, const u8 *seq);
119 /*
120  * Insert a key into data structures (sdata, sta if necessary)
121  * to make it used, free old key. On failure, also free the new key.
122  */
123 int ieee80211_key_link(struct ieee80211_key *key,
124 		       struct ieee80211_sub_if_data *sdata,
125 		       struct sta_info *sta);
126 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
127 void ieee80211_key_free_unused(struct ieee80211_key *key);
128 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
129 			       bool uni, bool multi);
130 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
131 				    int idx);
132 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata);
133 void ieee80211_free_sta_keys(struct ieee80211_local *local,
134 			     struct sta_info *sta);
135 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
136 
137 #define key_mtx_dereference(local, ref) \
138 	rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
139 
140 void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
141 
142 #endif /* IEEE80211_KEY_H */
143