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