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 /* ALG_TKIP
  20  * struct ieee80211_key::key is encoded as a 256-bit (32 byte) data block:
  21  * Temporal Encryption Key (128 bits)
  22  * Temporal Authenticator Tx MIC Key (64 bits)
  23  * Temporal Authenticator Rx MIC Key (64 bits)
  24  */
  25
  26 #define WEP_IV_LEN 4
  27 #define WEP_ICV_LEN 4
  28
  29 #define ALG_TKIP_KEY_LEN 32
  30 /* Starting offsets for each key */
  31 #define ALG_TKIP_TEMP_ENCR_KEY 0
  32 #define ALG_TKIP_TEMP_AUTH_TX_MIC_KEY 16
  33 #define ALG_TKIP_TEMP_AUTH_RX_MIC_KEY 24
  34 #define TKIP_IV_LEN 8
  35 #define TKIP_ICV_LEN 4
  36
  37 #define ALG_CCMP_KEY_LEN 16
  38 #define CCMP_HDR_LEN 8
  39 #define CCMP_MIC_LEN 8
  40 #define CCMP_TK_LEN 16
  41 #define CCMP_PN_LEN 6
  42
  43 #define NUM_RX_DATA_QUEUES 17
  44
  45 struct ieee80211_local;
  46 struct ieee80211_sub_if_data;
  47 struct sta_info;
  48
  49 /**
  50  * enum ieee80211_internal_key_flags - internal key flags
  51  *
  52  * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
  53  *      in the hardware for TX crypto hardware acceleration.
  54  * @KEY_FLAG_TODO_DELETE: Key is marked for deletion and will, after an
  55  *      RCU grace period, no longer be reachable other than from the
  56  *      todo list.
  57  * @KEY_FLAG_TODO_HWACCEL_ADD: Key needs to be added to hardware acceleration.
  58  * @KEY_FLAG_TODO_HWACCEL_REMOVE: Key needs to be removed from hardware
  59  *      acceleration.
  60  * @KEY_FLAG_TODO_DEFKEY: Key is default key and debugfs needs to be updated.
  61  * @KEY_FLAG_TODO_ADD_DEBUGFS: Key needs to be added to debugfs.
  62  */
  63 enum ieee80211_internal_key_flags {
  64         KEY_FLAG_UPLOADED_TO_HARDWARE   = BIT(0),
  65         KEY_FLAG_TODO_DELETE            = BIT(1),
  66         KEY_FLAG_TODO_HWACCEL_ADD       = BIT(2),
  67         KEY_FLAG_TODO_HWACCEL_REMOVE    = BIT(3),
  68         KEY_FLAG_TODO_DEFKEY            = BIT(4),
  69         KEY_FLAG_TODO_ADD_DEBUGFS       = BIT(5),
  70 };
  71
  72 struct tkip_ctx {
  73         u32 iv32;
  74         u16 iv16;
  75         u16 p1k[5];
  76         int initialized;
  77 };
  78
  79 struct ieee80211_key {
  80         struct ieee80211_local *local;
  81         struct ieee80211_sub_if_data *sdata;
  82         struct sta_info *sta;
  83
  84         /* for sdata list */
  85         struct list_head list;
  86         /* for todo list */
  87         struct list_head todo;
  88
  89         /* protected by todo lock! */
  90         unsigned int flags;
  91
  92         union {
  93                 struct {
  94                         /* last used TSC */
  95                         struct tkip_ctx tx;
  96
  97                         /* last received RSC */
  98                         struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
  99                 } tkip;
 100                 struct {
 101                         u8 tx_pn[6];
 102                         u8 rx_pn[NUM_RX_DATA_QUEUES][6];
 103                         struct crypto_cipher *tfm;
 104                         u32 replays; /* dot11RSNAStatsCCMPReplays */
 105                         /* scratch buffers for virt_to_page() (crypto API) */
 106 #ifndef AES_BLOCK_LEN
 107 #define AES_BLOCK_LEN 16
 108 #endif
 109                         u8 tx_crypto_buf[6 * AES_BLOCK_LEN];
 110                         u8 rx_crypto_buf[6 * AES_BLOCK_LEN];
 111                 } ccmp;
 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                 struct dentry *keylen;
 122                 struct dentry *flags;
 123                 struct dentry *keyidx;
 124                 struct dentry *hw_key_idx;
 125                 struct dentry *tx_rx_count;
 126                 struct dentry *algorithm;
 127                 struct dentry *tx_spec;
 128                 struct dentry *rx_spec;
 129                 struct dentry *replays;
 130                 struct dentry *key;
 131                 struct dentry *ifindex;
 132                 int cnt;
 133         } debugfs;
 134 #endif
 135
 136         /*
 137          * key config, must be last because it contains key
 138          * material as variable length member
 139          */
 140         struct ieee80211_key_conf conf;
 141 };
 142
 143 struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
 144                                           int idx,
 145                                           size_t key_len,
 146                                           const u8 *key_data);
 147 /*
 148  * Insert a key into data structures (sdata, sta if necessary)
 149  * to make it used, free old key.
 150  */
 151 void ieee80211_key_link(struct ieee80211_key *key,
 152                         struct ieee80211_sub_if_data *sdata,
 153                         struct sta_info *sta);
 154 void ieee80211_key_free(struct ieee80211_key *key);
 155 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx);
 156 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata);
 157 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
 158 void ieee80211_disable_keys(struct ieee80211_sub_if_data *sdata);
 159
 160 void ieee80211_key_todo(void);
 161
 162 #endif /* IEEE80211_KEY_H */