[deliverable/linux.git] / net / mac80211 / key.h

/*
 * Copyright 2002-2004, Instant802 Networks, Inc.
 * Copyright 2005, Devicescape Software, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef IEEE80211_KEY_H
#define IEEE80211_KEY_H

#include <linux/types.h>
#include <linux/list.h>
#include <linux/crypto.h>
#include <linux/rcupdate.h>
#include <net/mac80211.h>

/* ALG_TKIP
 * struct ieee80211_key::key is encoded as a 256-bit (32 byte) data block:
 * Temporal Encryption Key (128 bits)
 * Temporal Authenticator Tx MIC Key (64 bits)
 * Temporal Authenticator Rx MIC Key (64 bits)
 */

#define WEP_IV_LEN 4
#define WEP_ICV_LEN 4

#define ALG_TKIP_KEY_LEN 32
/* Starting offsets for each key */
#define ALG_TKIP_TEMP_ENCR_KEY 0
#define ALG_TKIP_TEMP_AUTH_TX_MIC_KEY 16
#define ALG_TKIP_TEMP_AUTH_RX_MIC_KEY 24
#define TKIP_IV_LEN 8
#define TKIP_ICV_LEN 4

#define ALG_CCMP_KEY_LEN 16
#define CCMP_HDR_LEN 8
#define CCMP_MIC_LEN 8
#define CCMP_TK_LEN 16
#define CCMP_PN_LEN 6

#define NUM_RX_DATA_QUEUES 17

struct ieee80211_local;
struct ieee80211_sub_if_data;
struct sta_info;

/**
 * enum ieee80211_internal_key_flags - internal key flags
 *
 * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
 *	in the hardware for TX crypto hardware acceleration.
 * @KEY_FLAG_TODO_DELETE: Key is marked for deletion and will, after an
 *	RCU grace period, no longer be reachable other than from the
 *	todo list.
 * @KEY_FLAG_TODO_HWACCEL_ADD: Key needs to be added to hardware acceleration.
 * @KEY_FLAG_TODO_HWACCEL_REMOVE: Key needs to be removed from hardware
 *	acceleration.
 * @KEY_FLAG_TODO_DEFKEY: Key is default key and debugfs needs to be updated.
 * @KEY_FLAG_TODO_ADD_DEBUGFS: Key needs to be added to debugfs.
 */
enum ieee80211_internal_key_flags {
	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
	KEY_FLAG_TODO_DELETE		= BIT(1),
	KEY_FLAG_TODO_HWACCEL_ADD	= BIT(2),
	KEY_FLAG_TODO_HWACCEL_REMOVE	= BIT(3),
	KEY_FLAG_TODO_DEFKEY		= BIT(4),
	KEY_FLAG_TODO_ADD_DEBUGFS	= BIT(5),
};

struct tkip_ctx {
	u32 iv32;
	u16 iv16;
	u16 p1k[5];
	int initialized;
};

struct ieee80211_key {
	struct ieee80211_local *local;
	struct ieee80211_sub_if_data *sdata;
	struct sta_info *sta;

	/* for sdata list */
	struct list_head list;
	/* for todo list */
	struct list_head todo;

	/* protected by todo lock! */
	unsigned int flags;

	union {
		struct {
			/* last used TSC */
			struct tkip_ctx tx;

			/* last received RSC */
			struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
		} tkip;
		struct {
			u8 tx_pn[6];
			u8 rx_pn[NUM_RX_DATA_QUEUES][6];
			struct crypto_cipher *tfm;
			u32 replays; /* dot11RSNAStatsCCMPReplays */
			/* scratch buffers for virt_to_page() (crypto API) */
#ifndef AES_BLOCK_LEN
#define AES_BLOCK_LEN 16
#endif
			u8 tx_crypto_buf[6 * AES_BLOCK_LEN];
			u8 rx_crypto_buf[6 * AES_BLOCK_LEN];
		} ccmp;
	} u;

	/* number of times this key has been used */
	int tx_rx_count;

#ifdef CONFIG_MAC80211_DEBUGFS
	struct {
		struct dentry *stalink;
		struct dentry *dir;
		struct dentry *keylen;
		struct dentry *flags;
		struct dentry *keyidx;
		struct dentry *hw_key_idx;
		struct dentry *tx_rx_count;
		struct dentry *algorithm;
		struct dentry *tx_spec;
		struct dentry *rx_spec;
		struct dentry *replays;
		struct dentry *key;
		struct dentry *ifindex;
		int cnt;
	} debugfs;
#endif

	/*
	 * key config, must be last because it contains key
	 * material as variable length member
	 */
	struct ieee80211_key_conf conf;
};

struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
					  int idx,
					  size_t key_len,
					  const u8 *key_data);
/*
 * Insert a key into data structures (sdata, sta if necessary)
 * to make it used, free old key.
 */
void ieee80211_key_link(struct ieee80211_key *key,
			struct ieee80211_sub_if_data *sdata,
			struct sta_info *sta);
void ieee80211_key_free(struct ieee80211_key *key);
void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx);
void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata);
void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
void ieee80211_disable_keys(struct ieee80211_sub_if_data *sdata);

void ieee80211_key_todo(void);

#endif /* IEEE80211_KEY_H */
Commit	Line	Data
f0706e82 JB	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>
8f37171a	14	#include <linux/list.h>
f0706e82	15	#include <linux/crypto.h>
db4d1169	16	#include <linux/rcupdate.h>
f0706e82 JB	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
11a843b7 JB	45	struct ieee80211_local;
	46	struct ieee80211_sub_if_data;
	47	struct sta_info;
	48
db4d1169 JB	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.
3b96766f JB	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.
3a245766 JB	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.
3b96766f JB	60	* @KEY_FLAG_TODO_DEFKEY: Key is default key and debugfs needs to be updated.
3b96766f JB	61	* @KEY_FLAG_TODO_ADD_DEBUGFS: Key needs to be added to debugfs.
db4d1169 JB	62	*/
	63	enum ieee80211_internal_key_flags {
	64	KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
3b96766f	65	KEY_FLAG_TODO_DELETE = BIT(1),
3a245766 JB	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),
db4d1169	70	};
11a843b7	71
b0f76b33 HH	72	struct tkip_ctx {
	73	u32 iv32;
	74	u16 iv16;
	75	u16 p1k[5];
	76	int initialized;
	77	};
	78
f0706e82	79	struct ieee80211_key {
11a843b7 JB	80	struct ieee80211_local *local;
	81	struct ieee80211_sub_if_data *sdata;
	82	struct sta_info *sta;
	83
3b96766f	84	/* for sdata list */
11a843b7	85	struct list_head list;
3b96766f JB	86	/* for todo list */
3b96766f JB	87	struct list_head todo;
11a843b7	88
3b96766f	89	/* protected by todo lock! */
11a843b7 JB	90	unsigned int flags;
11a843b7 JB	91
f0706e82 JB	92	union {
	93	struct {
	94	/* last used TSC */
b0f76b33	95	struct tkip_ctx tx;
f0706e82 JB	96
f0706e82 JB	97	/* last received RSC */
b0f76b33	98	struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
f0706e82 JB	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;
f0706e82	113
8f20fc24 JB	114	/* number of times this key has been used */
8f20fc24 JB	115	int tx_rx_count;
f0706e82	116
e9f207f0 JB	117	#ifdef CONFIG_MAC80211_DEBUGFS
	118	struct {
	119	struct dentry *stalink;
	120	struct dentry *dir;
	121	struct dentry *keylen;
8f20fc24	122	struct dentry *flags;
e9f207f0 JB	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;
e7a64f12	131	struct dentry *ifindex;
d9c58f30	132	int cnt;
e9f207f0 JB	133	} debugfs;
	134	#endif
	135
8f20fc24 JB	136	/*
	137	* key config, must be last because it contains key
	138	* material as variable length member
	139	*/
	140	struct ieee80211_key_conf conf;
f0706e82 JB	141	};
f0706e82 JB	142
db4d1169	143	struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
11a843b7 JB	144	int idx,
	145	size_t key_len,
	146	const u8 *key_data);
db4d1169 JB	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);
11a843b7 JB	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
3b96766f JB	160	void ieee80211_key_todo(void);
3b96766f JB	161
f0706e82	162	#endif /* IEEE80211_KEY_H */