net/mac80211/key.h

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