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