1 /* SPDX-License-Identifier: GPL-2.0-only */ 1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* 2 /*
3 * Copyright 2002-2004, Instant802 Networks, I 3 * Copyright 2002-2004, Instant802 Networks, Inc.
4 * Copyright 2005, Devicescape Software, Inc. 4 * Copyright 2005, Devicescape Software, Inc.
5 * Copyright (C) 2019, 2022-2023 Intel Corpora <<
6 */ 5 */
7 6
8 #ifndef IEEE80211_KEY_H 7 #ifndef IEEE80211_KEY_H
9 #define IEEE80211_KEY_H 8 #define IEEE80211_KEY_H
10 9
11 #include <linux/types.h> 10 #include <linux/types.h>
12 #include <linux/list.h> 11 #include <linux/list.h>
13 #include <linux/crypto.h> 12 #include <linux/crypto.h>
14 #include <linux/rcupdate.h> 13 #include <linux/rcupdate.h>
15 #include <crypto/arc4.h> <<
16 #include <net/mac80211.h> 14 #include <net/mac80211.h>
17 15
18 #define NUM_DEFAULT_KEYS 4 16 #define NUM_DEFAULT_KEYS 4
19 #define NUM_DEFAULT_MGMT_KEYS 2 17 #define NUM_DEFAULT_MGMT_KEYS 2
20 #define NUM_DEFAULT_BEACON_KEYS 2 <<
21 #define INVALID_PTK_KEYIDX 2 /* Keyidx always 18 #define INVALID_PTK_KEYIDX 2 /* Keyidx always pointing to a NULL key for PTK */
22 19
23 struct ieee80211_local; 20 struct ieee80211_local;
24 struct ieee80211_sub_if_data; 21 struct ieee80211_sub_if_data;
25 struct ieee80211_link_data; <<
26 struct sta_info; 22 struct sta_info;
27 23
28 /** 24 /**
29 * enum ieee80211_internal_key_flags - interna 25 * enum ieee80211_internal_key_flags - internal key flags
30 * 26 *
31 * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates t 27 * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
32 * in the hardware for TX crypto hardware 28 * in the hardware for TX crypto hardware acceleration.
33 * @KEY_FLAG_TAINTED: Key is tainted and packe 29 * @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
>> 30 * @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
34 */ 31 */
35 enum ieee80211_internal_key_flags { 32 enum ieee80211_internal_key_flags {
36 KEY_FLAG_UPLOADED_TO_HARDWARE = BIT( 33 KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
37 KEY_FLAG_TAINTED = BIT( 34 KEY_FLAG_TAINTED = BIT(1),
>> 35 KEY_FLAG_CIPHER_SCHEME = BIT(2),
38 }; 36 };
39 37
40 enum ieee80211_internal_tkip_state { 38 enum ieee80211_internal_tkip_state {
41 TKIP_STATE_NOT_INIT, 39 TKIP_STATE_NOT_INIT,
42 TKIP_STATE_PHASE1_DONE, 40 TKIP_STATE_PHASE1_DONE,
43 TKIP_STATE_PHASE1_HW_UPLOADED, 41 TKIP_STATE_PHASE1_HW_UPLOADED,
44 }; 42 };
45 43
46 struct tkip_ctx { 44 struct tkip_ctx {
47 u16 p1k[5]; /* p1k cache */ 45 u16 p1k[5]; /* p1k cache */
48 u32 p1k_iv32; /* iv32 for which p1k 46 u32 p1k_iv32; /* iv32 for which p1k computed */
49 enum ieee80211_internal_tkip_state sta 47 enum ieee80211_internal_tkip_state state;
50 }; 48 };
51 49
52 struct tkip_ctx_rx { 50 struct tkip_ctx_rx {
53 struct tkip_ctx ctx; 51 struct tkip_ctx ctx;
54 u32 iv32; /* current iv32 */ 52 u32 iv32; /* current iv32 */
55 u16 iv16; /* current iv16 */ 53 u16 iv16; /* current iv16 */
56 }; 54 };
57 55
58 struct ieee80211_key { 56 struct ieee80211_key {
59 struct ieee80211_local *local; 57 struct ieee80211_local *local;
60 struct ieee80211_sub_if_data *sdata; 58 struct ieee80211_sub_if_data *sdata;
61 struct sta_info *sta; 59 struct sta_info *sta;
62 60
63 /* for sdata list */ 61 /* for sdata list */
64 struct list_head list; 62 struct list_head list;
65 63
66 /* protected by key mutex */ 64 /* protected by key mutex */
67 unsigned int flags; 65 unsigned int flags;
68 66
69 union { 67 union {
70 struct { 68 struct {
71 /* protects tx context 69 /* protects tx context */
72 spinlock_t txlock; 70 spinlock_t txlock;
73 71
74 /* last used TSC */ 72 /* last used TSC */
75 struct tkip_ctx tx; 73 struct tkip_ctx tx;
76 74
77 /* last received RSC * 75 /* last received RSC */
78 struct tkip_ctx_rx rx[ 76 struct tkip_ctx_rx rx[IEEE80211_NUM_TIDS];
79 77
80 /* number of mic failu 78 /* number of mic failures */
81 u32 mic_failures; 79 u32 mic_failures;
82 } tkip; 80 } tkip;
83 struct { 81 struct {
84 /* 82 /*
85 * Last received packe 83 * Last received packet number. The first
86 * IEEE80211_NUM_TIDS 84 * IEEE80211_NUM_TIDS counters are used with Data
87 * frames and the last 85 * frames and the last counter is used with Robust
88 * Management frames. 86 * Management frames.
89 */ 87 */
90 u8 rx_pn[IEEE80211_NUM 88 u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
91 struct crypto_aead *tf 89 struct crypto_aead *tfm;
92 u32 replays; /* dot11R 90 u32 replays; /* dot11RSNAStatsCCMPReplays */
93 } ccmp; 91 } ccmp;
94 struct { 92 struct {
95 u8 rx_pn[IEEE80211_CMA 93 u8 rx_pn[IEEE80211_CMAC_PN_LEN];
96 struct crypto_shash *t 94 struct crypto_shash *tfm;
97 u32 replays; /* dot11R 95 u32 replays; /* dot11RSNAStatsCMACReplays */
98 u32 icverrors; /* dot1 96 u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
99 } aes_cmac; 97 } aes_cmac;
100 struct { 98 struct {
101 u8 rx_pn[IEEE80211_GMA 99 u8 rx_pn[IEEE80211_GMAC_PN_LEN];
102 struct crypto_aead *tf 100 struct crypto_aead *tfm;
103 u32 replays; /* dot11R 101 u32 replays; /* dot11RSNAStatsCMACReplays */
104 u32 icverrors; /* dot1 102 u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
105 } aes_gmac; 103 } aes_gmac;
106 struct { 104 struct {
107 /* Last received packe 105 /* Last received packet number. The first
108 * IEEE80211_NUM_TIDS 106 * IEEE80211_NUM_TIDS counters are used with Data
109 * frames and the last 107 * frames and the last counter is used with Robust
110 * Management frames. 108 * Management frames.
111 */ 109 */
112 u8 rx_pn[IEEE80211_NUM 110 u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
113 struct crypto_aead *tf 111 struct crypto_aead *tfm;
114 u32 replays; /* dot11R 112 u32 replays; /* dot11RSNAStatsGCMPReplays */
115 } gcmp; 113 } gcmp;
116 struct { 114 struct {
117 /* generic cipher sche 115 /* generic cipher scheme */
118 u8 rx_pn[IEEE80211_NUM 116 u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
119 } gen; 117 } gen;
120 } u; 118 } u;
121 119
122 #ifdef CONFIG_MAC80211_DEBUGFS 120 #ifdef CONFIG_MAC80211_DEBUGFS
123 struct { 121 struct {
124 struct dentry *stalink; 122 struct dentry *stalink;
125 struct dentry *dir; 123 struct dentry *dir;
126 int cnt; 124 int cnt;
127 } debugfs; 125 } debugfs;
128 #endif 126 #endif
129 127
130 unsigned int color; <<
131 <<
132 /* 128 /*
133 * key config, must be last because it 129 * key config, must be last because it contains key
134 * material as variable length member 130 * material as variable length member
135 */ 131 */
136 struct ieee80211_key_conf conf; 132 struct ieee80211_key_conf conf;
137 }; 133 };
138 134
139 struct ieee80211_key * 135 struct ieee80211_key *
140 ieee80211_key_alloc(u32 cipher, int idx, size_ 136 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
141 const u8 *key_data, 137 const u8 *key_data,
142 size_t seq_len, const u8 * !! 138 size_t seq_len, const u8 *seq,
>> 139 const struct ieee80211_cipher_scheme *cs);
143 /* 140 /*
144 * Insert a key into data structures (sdata, s 141 * Insert a key into data structures (sdata, sta if necessary)
145 * to make it used, free old key. On failure, 142 * to make it used, free old key. On failure, also free the new key.
146 */ 143 */
147 int ieee80211_key_link(struct ieee80211_key *k 144 int ieee80211_key_link(struct ieee80211_key *key,
148 struct ieee80211_link_d !! 145 struct ieee80211_sub_if_data *sdata,
149 struct sta_info *sta); 146 struct sta_info *sta);
150 int ieee80211_set_tx_key(struct ieee80211_key 147 int ieee80211_set_tx_key(struct ieee80211_key *key);
151 void ieee80211_key_free(struct ieee80211_key * 148 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
152 void ieee80211_key_free_unused(struct ieee8021 149 void ieee80211_key_free_unused(struct ieee80211_key *key);
153 void ieee80211_set_default_key(struct ieee8021 !! 150 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
154 bool uni, bool 151 bool uni, bool multi);
155 void ieee80211_set_default_mgmt_key(struct iee !! 152 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
156 int idx); 153 int idx);
157 void ieee80211_set_default_beacon_key(struct i <<
158 int idx) <<
159 void ieee80211_remove_link_keys(struct ieee802 <<
160 struct list_he <<
161 void ieee80211_free_key_list(struct ieee80211_ <<
162 struct list_head <<
163 void ieee80211_free_keys(struct ieee80211_sub_ 154 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
164 bool force_synchroniz 155 bool force_synchronize);
165 void ieee80211_free_sta_keys(struct ieee80211_ 156 void ieee80211_free_sta_keys(struct ieee80211_local *local,
166 struct sta_info * 157 struct sta_info *sta);
167 void ieee80211_reenable_keys(struct ieee80211_ !! 158 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
168 int ieee80211_key_switch_links(struct ieee8021 !! 159 void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata);
169 unsigned long d !! 160
170 unsigned long a !! 161 #define key_mtx_dereference(local, ref) \
171 void ieee80211_delayed_tailroom_dec(struct wip !! 162 rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
172 struct wip !! 163
>> 164 void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
173 165
174 #endif /* IEEE80211_KEY_H */ 166 #endif /* IEEE80211_KEY_H */
175 167
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.