xref: /openbmc/linux/net/mac80211/key.h (revision 4f3db074)
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 #define MAX_PN_LEN 16
22 
23 struct ieee80211_local;
24 struct ieee80211_sub_if_data;
25 struct sta_info;
26 
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.
32  * @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
33  * @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
34  */
35 enum ieee80211_internal_key_flags {
36 	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
37 	KEY_FLAG_TAINTED		= BIT(1),
38 	KEY_FLAG_CIPHER_SCHEME		= BIT(2),
39 };
40 
41 enum ieee80211_internal_tkip_state {
42 	TKIP_STATE_NOT_INIT,
43 	TKIP_STATE_PHASE1_DONE,
44 	TKIP_STATE_PHASE1_HW_UPLOADED,
45 };
46 
47 struct tkip_ctx {
48 	u32 iv32;	/* current iv32 */
49 	u16 iv16;	/* current iv16 */
50 	u16 p1k[5];	/* p1k cache */
51 	u32 p1k_iv32;	/* iv32 for which p1k computed */
52 	enum ieee80211_internal_tkip_state state;
53 };
54 
55 struct ieee80211_key {
56 	struct ieee80211_local *local;
57 	struct ieee80211_sub_if_data *sdata;
58 	struct sta_info *sta;
59 
60 	/* for sdata list */
61 	struct list_head list;
62 
63 	/* protected by key mutex */
64 	unsigned int flags;
65 
66 	union {
67 		struct {
68 			/* protects tx context */
69 			spinlock_t txlock;
70 
71 			/* last used TSC */
72 			struct tkip_ctx tx;
73 
74 			/* last received RSC */
75 			struct tkip_ctx rx[IEEE80211_NUM_TIDS];
76 
77 			/* number of mic failures */
78 			u32 mic_failures;
79 		} tkip;
80 		struct {
81 			atomic64_t tx_pn;
82 			/*
83 			 * Last received packet number. The first
84 			 * IEEE80211_NUM_TIDS counters are used with Data
85 			 * frames and the last counter is used with Robust
86 			 * Management frames.
87 			 */
88 			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
89 			struct crypto_aead *tfm;
90 			u32 replays; /* dot11RSNAStatsCCMPReplays */
91 		} ccmp;
92 		struct {
93 			atomic64_t tx_pn;
94 			u8 rx_pn[IEEE80211_CMAC_PN_LEN];
95 			struct crypto_cipher *tfm;
96 			u32 replays; /* dot11RSNAStatsCMACReplays */
97 			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
98 		} aes_cmac;
99 		struct {
100 			atomic64_t tx_pn;
101 			u8 rx_pn[IEEE80211_GMAC_PN_LEN];
102 			struct crypto_aead *tfm;
103 			u32 replays; /* dot11RSNAStatsCMACReplays */
104 			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
105 		} aes_gmac;
106 		struct {
107 			atomic64_t tx_pn;
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;
117 		struct {
118 			/* generic cipher scheme */
119 			u8 rx_pn[IEEE80211_NUM_TIDS + 1][MAX_PN_LEN];
120 		} gen;
121 	} u;
122 
123 	/* number of times this key has been used */
124 	int tx_rx_count;
125 
126 #ifdef CONFIG_MAC80211_DEBUGFS
127 	struct {
128 		struct dentry *stalink;
129 		struct dentry *dir;
130 		int cnt;
131 	} debugfs;
132 #endif
133 
134 	/*
135 	 * key config, must be last because it contains key
136 	 * material as variable length member
137 	 */
138 	struct ieee80211_key_conf conf;
139 };
140 
141 struct ieee80211_key *
142 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
143 		    const u8 *key_data,
144 		    size_t seq_len, const u8 *seq,
145 		    const struct ieee80211_cipher_scheme *cs);
146 /*
147  * Insert a key into data structures (sdata, sta if necessary)
148  * to make it used, free old key. On failure, also free the new key.
149  */
150 int ieee80211_key_link(struct ieee80211_key *key,
151 		       struct ieee80211_sub_if_data *sdata,
152 		       struct sta_info *sta);
153 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
154 void ieee80211_key_free_unused(struct ieee80211_key *key);
155 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
156 			       bool uni, bool multi);
157 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
158 				    int idx);
159 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
160 			 bool force_synchronize);
161 void ieee80211_free_sta_keys(struct ieee80211_local *local,
162 			     struct sta_info *sta);
163 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
164 
165 #define key_mtx_dereference(local, ref) \
166 	rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
167 
168 void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
169 
170 #endif /* IEEE80211_KEY_H */
171