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