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