net/mac80211/ieee80211_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_REMOVE_FROM_HARDWARE: Indicates to the key code that this
  55  *      key is present in the hardware (but it cannot be used for
  56  *      hardware acceleration any more!)
  57  */
  58 enum ieee80211_internal_key_flags {
  59         KEY_FLAG_UPLOADED_TO_HARDWARE   = BIT(0),
  60         KEY_FLAG_REMOVE_FROM_HARDWARE   = BIT(1),
  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         struct list_head list;
  69
  70         unsigned int flags;
  71
  72         union {
  73                 struct {
  74                         /* last used TSC */
  75                         u32 iv32;
  76                         u16 iv16;
  77                         u16 p1k[5];
  78                         int tx_initialized;
  79
  80                         /* last received RSC */
  81                         u32 iv32_rx[NUM_RX_DATA_QUEUES];
  82                         u16 iv16_rx[NUM_RX_DATA_QUEUES];
  83                         u16 p1k_rx[NUM_RX_DATA_QUEUES][5];
  84                         int rx_initialized[NUM_RX_DATA_QUEUES];
  85                 } tkip;
  86                 struct {
  87                         u8 tx_pn[6];
  88                         u8 rx_pn[NUM_RX_DATA_QUEUES][6];
  89                         struct crypto_cipher *tfm;
  90                         u32 replays; /* dot11RSNAStatsCCMPReplays */
  91                         /* scratch buffers for virt_to_page() (crypto API) */
  92 #ifndef AES_BLOCK_LEN
  93 #define AES_BLOCK_LEN 16
  94 #endif
  95                         u8 tx_crypto_buf[6 * AES_BLOCK_LEN];
  96                         u8 rx_crypto_buf[6 * AES_BLOCK_LEN];
  97                 } ccmp;
  98         } u;
  99
 100         /* number of times this key has been used */
 101         int tx_rx_count;
 102
 103 #ifdef CONFIG_MAC80211_DEBUGFS
 104         struct {
 105                 struct dentry *stalink;
 106                 struct dentry *dir;
 107                 struct dentry *keylen;
 108                 struct dentry *flags;
 109                 struct dentry *keyidx;
 110                 struct dentry *hw_key_idx;
 111                 struct dentry *tx_rx_count;
 112                 struct dentry *algorithm;
 113                 struct dentry *tx_spec;
 114                 struct dentry *rx_spec;
 115                 struct dentry *replays;
 116                 struct dentry *key;
 117                 struct dentry *ifindex;
 118         } debugfs;
 119 #endif
 120
 121         /*
 122          * key config, must be last because it contains key
 123          * material as variable length member
 124          */
 125         struct ieee80211_key_conf conf;
 126 };
 127
 128 struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
 129                                           int idx,
 130                                           size_t key_len,
 131                                           const u8 *key_data);
 132 /*
 133  * Insert a key into data structures (sdata, sta if necessary)
 134  * to make it used, free old key.
 135  */
 136 void ieee80211_key_link(struct ieee80211_key *key,
 137                         struct ieee80211_sub_if_data *sdata,
 138                         struct sta_info *sta);
 139 void ieee80211_key_free(struct ieee80211_key *key);
 140 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx);
 141 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata);
 142 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
 143 void ieee80211_disable_keys(struct ieee80211_sub_if_data *sdata);
 144
 145 #endif /* IEEE80211_KEY_H */