[net-next-2.6.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>

#define WEP_IV_LEN		4
#define WEP_ICV_LEN		4
#define ALG_TKIP_KEY_LEN	32
#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 TKIP_IV_LEN		8
#define TKIP_ICV_LEN		4

#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.
 * @KEY_FLAG_TODO_DEFMGMTKEY: Key is default management key and debugfs needs
 *	to be updated.
 */
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),
	KEY_FLAG_TODO_DEFMGMTKEY	= BIT(6),
};

enum ieee80211_internal_tkip_state {
	TKIP_STATE_NOT_INIT,
	TKIP_STATE_PHASE1_DONE,
	TKIP_STATE_PHASE1_HW_UPLOADED,
};

struct tkip_ctx {
	u32 iv32;
	u16 iv16;
	u16 p1k[5];
	enum ieee80211_internal_tkip_state state;
};

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;
		struct {
			u8 tx_pn[6];
			u8 rx_pn[6];
			struct crypto_cipher *tfm;
			u32 replays; /* dot11RSNAStatsCMACReplays */
			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
			/* scratch buffers for virt_to_page() (crypto API) */
			u8 tx_crypto_buf[2 * AES_BLOCK_LEN];
			u8 rx_crypto_buf[2 * AES_BLOCK_LEN];
		} aes_cmac;
	} u;

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

#ifdef CONFIG_MAC80211_DEBUGFS
	struct {
		struct dentry *stalink;
		struct dentry *dir;
		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,
					  size_t seq_len, const u8 *seq);
/*
 * 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_set_default_mgmt_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>
f0706e82 JB	18
ffd7891d LR	19	#define WEP_IV_LEN 4
	20	#define WEP_ICV_LEN 4
	21	#define ALG_TKIP_KEY_LEN 32
	22	#define ALG_CCMP_KEY_LEN 16
	23	#define CCMP_HDR_LEN 8
	24	#define CCMP_MIC_LEN 8
	25	#define CCMP_TK_LEN 16
	26	#define CCMP_PN_LEN 6
	27	#define TKIP_IV_LEN 8
	28	#define TKIP_ICV_LEN 4
	29
	30	#define NUM_RX_DATA_QUEUES 17
f0706e82	31
11a843b7 JB	32	struct ieee80211_local;
	33	struct ieee80211_sub_if_data;
	34	struct sta_info;
	35
db4d1169 JB	36	/**
	37	* enum ieee80211_internal_key_flags - internal key flags
	38	*
	39	* @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
	40	* in the hardware for TX crypto hardware acceleration.
3b96766f JB	41	* @KEY_FLAG_TODO_DELETE: Key is marked for deletion and will, after an
	42	* RCU grace period, no longer be reachable other than from the
	43	* todo list.
3a245766 JB	44	* @KEY_FLAG_TODO_HWACCEL_ADD: Key needs to be added to hardware acceleration.
	45	* @KEY_FLAG_TODO_HWACCEL_REMOVE: Key needs to be removed from hardware
	46	* acceleration.
3b96766f JB	47	* @KEY_FLAG_TODO_DEFKEY: Key is default key and debugfs needs to be updated.
3b96766f JB	48	* @KEY_FLAG_TODO_ADD_DEBUGFS: Key needs to be added to debugfs.
3cfcf6ac JM	49	* @KEY_FLAG_TODO_DEFMGMTKEY: Key is default management key and debugfs needs
3cfcf6ac JM	50	* to be updated.
db4d1169 JB	51	*/
	52	enum ieee80211_internal_key_flags {
	53	KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
3b96766f	54	KEY_FLAG_TODO_DELETE = BIT(1),
3a245766 JB	55	KEY_FLAG_TODO_HWACCEL_ADD = BIT(2),
	56	KEY_FLAG_TODO_HWACCEL_REMOVE = BIT(3),
	57	KEY_FLAG_TODO_DEFKEY = BIT(4),
	58	KEY_FLAG_TODO_ADD_DEBUGFS = BIT(5),
3cfcf6ac	59	KEY_FLAG_TODO_DEFMGMTKEY = BIT(6),
db4d1169	60	};
11a843b7	61
ca99861d	62	enum ieee80211_internal_tkip_state {
	63	TKIP_STATE_NOT_INIT,
	64	TKIP_STATE_PHASE1_DONE,
	65	TKIP_STATE_PHASE1_HW_UPLOADED,
	66	};
	67
b0f76b33 HH	68	struct tkip_ctx {
	69	u32 iv32;
	70	u16 iv16;
	71	u16 p1k[5];
ca99861d	72	enum ieee80211_internal_tkip_state state;
b0f76b33 HH	73	};
b0f76b33 HH	74
f0706e82	75	struct ieee80211_key {
11a843b7 JB	76	struct ieee80211_local *local;
	77	struct ieee80211_sub_if_data *sdata;
	78	struct sta_info *sta;
	79
3b96766f	80	/* for sdata list */
11a843b7	81	struct list_head list;
3b96766f JB	82	/* for todo list */
3b96766f JB	83	struct list_head todo;
11a843b7	84
3b96766f	85	/* protected by todo lock! */
11a843b7 JB	86	unsigned int flags;
11a843b7 JB	87
f0706e82 JB	88	union {
	89	struct {
	90	/* last used TSC */
b0f76b33	91	struct tkip_ctx tx;
f0706e82 JB	92
f0706e82 JB	93	/* last received RSC */
b0f76b33	94	struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
f0706e82 JB	95	} tkip;
	96	struct {
	97	u8 tx_pn[6];
	98	u8 rx_pn[NUM_RX_DATA_QUEUES][6];
	99	struct crypto_cipher *tfm;
	100	u32 replays; /* dot11RSNAStatsCCMPReplays */
	101	/* scratch buffers for virt_to_page() (crypto API) */
	102	#ifndef AES_BLOCK_LEN
	103	#define AES_BLOCK_LEN 16
	104	#endif
	105	u8 tx_crypto_buf[6 * AES_BLOCK_LEN];
	106	u8 rx_crypto_buf[6 * AES_BLOCK_LEN];
	107	} ccmp;
765cb46a JM	108	struct {
	109	u8 tx_pn[6];
	110	u8 rx_pn[6];
	111	struct crypto_cipher *tfm;
	112	u32 replays; /* dot11RSNAStatsCMACReplays */
	113	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
	114	/* scratch buffers for virt_to_page() (crypto API) */
	115	u8 tx_crypto_buf[2 * AES_BLOCK_LEN];
	116	u8 rx_crypto_buf[2 * AES_BLOCK_LEN];
	117	} aes_cmac;
f0706e82	118	} u;
f0706e82	119
8f20fc24 JB	120	/* number of times this key has been used */
8f20fc24 JB	121	int tx_rx_count;
f0706e82	122
e9f207f0 JB	123	#ifdef CONFIG_MAC80211_DEBUGFS
	124	struct {
	125	struct dentry *stalink;
	126	struct dentry *dir;
d9c58f30	127	int cnt;
e9f207f0 JB	128	} debugfs;
	129	#endif
	130
8f20fc24 JB	131	/*
	132	* key config, must be last because it contains key
	133	* material as variable length member
	134	*/
	135	struct ieee80211_key_conf conf;
f0706e82 JB	136	};
f0706e82 JB	137
db4d1169	138	struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
11a843b7 JB	139	int idx,
11a843b7 JB	140	size_t key_len,
faa8fdc8 JM	141	const u8 *key_data,
faa8fdc8 JM	142	size_t seq_len, const u8 *seq);
db4d1169 JB	143	/*
	144	* Insert a key into data structures (sdata, sta if necessary)
	145	* to make it used, free old key.
	146	*/
	147	void ieee80211_key_link(struct ieee80211_key *key,
	148	struct ieee80211_sub_if_data *sdata,
	149	struct sta_info *sta);
11a843b7 JB	150	void ieee80211_key_free(struct ieee80211_key *key);
11a843b7 JB	151	void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx);
3cfcf6ac JM	152	void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
3cfcf6ac JM	153	int idx);
11a843b7 JB	154	void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata);
	155	void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
	156	void ieee80211_disable_keys(struct ieee80211_sub_if_data *sdata);
	157
3b96766f JB	158	void ieee80211_key_todo(void);
3b96766f JB	159
f0706e82	160	#endif /* IEEE80211_KEY_H */