net/mac80211/key.h

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