[linux-2.6-block.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 NUM_DEFAULT_KEYS 4
#define NUM_DEFAULT_MGMT_KEYS 2

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_TAINTED: Key is tainted and packets should be dropped.
 * @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
 */
enum ieee80211_internal_key_flags {
	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
	KEY_FLAG_TAINTED		= BIT(1),
	KEY_FLAG_CIPHER_SCHEME		= BIT(2),
};

enum ieee80211_internal_tkip_state {
	TKIP_STATE_NOT_INIT,
	TKIP_STATE_PHASE1_DONE,
	TKIP_STATE_PHASE1_HW_UPLOADED,
};

struct tkip_ctx {
	u32 iv32;	/* current iv32 */
	u16 iv16;	/* current iv16 */
	u16 p1k[5];	/* p1k cache */
	u32 p1k_iv32;	/* iv32 for which p1k computed */
	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;

	/* protected by key mutex */
	unsigned int flags;

	union {
		struct {
			/* protects tx context */
			spinlock_t txlock;

			/* last used TSC */
			struct tkip_ctx tx;

			/* last received RSC */
			struct tkip_ctx rx[IEEE80211_NUM_TIDS];

			/* number of mic failures */
			u32 mic_failures;
		} tkip;
		struct {
			/*
			 * Last received packet number. The first
			 * IEEE80211_NUM_TIDS counters are used with Data
			 * frames and the last counter is used with Robust
			 * Management frames.
			 */
			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
			struct crypto_aead *tfm;
			u32 replays; /* dot11RSNAStatsCCMPReplays */
		} ccmp;
		struct {
			u8 rx_pn[IEEE80211_CMAC_PN_LEN];
			struct crypto_cipher *tfm;
			u32 replays; /* dot11RSNAStatsCMACReplays */
			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
		} aes_cmac;
		struct {
			u8 rx_pn[IEEE80211_GMAC_PN_LEN];
			struct crypto_aead *tfm;
			u32 replays; /* dot11RSNAStatsCMACReplays */
			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
		} aes_gmac;
		struct {
			/* Last received packet number. The first
			 * IEEE80211_NUM_TIDS counters are used with Data
			 * frames and the last counter is used with Robust
			 * Management frames.
			 */
			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
			struct crypto_aead *tfm;
			u32 replays; /* dot11RSNAStatsGCMPReplays */
		} gcmp;
		struct {
			/* generic cipher scheme */
			u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
		} gen;
	} u;

#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(u32 cipher, int idx, size_t key_len,
		    const u8 *key_data,
		    size_t seq_len, const u8 *seq,
		    const struct ieee80211_cipher_scheme *cs);
/*
 * Insert a key into data structures (sdata, sta if necessary)
 * to make it used, free old key. On failure, also free the new key.
 */
int 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, bool delay_tailroom);
void ieee80211_key_free_unused(struct ieee80211_key *key);
void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
			       bool uni, bool multi);
void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
				    int idx);
void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
			 bool force_synchronize);
void ieee80211_free_sta_keys(struct ieee80211_local *local,
			     struct sta_info *sta);
void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata);

#define key_mtx_dereference(local, ref) \
	rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))

void ieee80211_delayed_tailroom_dec(struct work_struct *wk);

#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
e31b8213 JB	19	#define NUM_DEFAULT_KEYS 4
	20	#define NUM_DEFAULT_MGMT_KEYS 2
	21
11a843b7 JB	22	struct ieee80211_local;
	23	struct ieee80211_sub_if_data;
	24	struct sta_info;
	25
db4d1169 JB	26	/**
	27	* enum ieee80211_internal_key_flags - internal key flags
	28	*
	29	* @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
	30	* in the hardware for TX crypto hardware acceleration.
95acac61	31	* @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
c7ef38e0	32	* @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
db4d1169 JB	33	*/
	34	enum ieee80211_internal_key_flags {
	35	KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
95acac61	36	KEY_FLAG_TAINTED = BIT(1),
c7ef38e0	37	KEY_FLAG_CIPHER_SCHEME = BIT(2),
db4d1169	38	};
11a843b7	39
ca99861d	40	enum ieee80211_internal_tkip_state {
	41	TKIP_STATE_NOT_INIT,
	42	TKIP_STATE_PHASE1_DONE,
	43	TKIP_STATE_PHASE1_HW_UPLOADED,
	44	};
	45
b0f76b33	46	struct tkip_ctx {
523b02ea JB	47	u32 iv32; /* current iv32 */
	48	u16 iv16; /* current iv16 */
	49	u16 p1k[5]; /* p1k cache */
	50	u32 p1k_iv32; /* iv32 for which p1k computed */
ca99861d	51	enum ieee80211_internal_tkip_state state;
b0f76b33 HH	52	};
b0f76b33 HH	53
f0706e82	54	struct ieee80211_key {
11a843b7 JB	55	struct ieee80211_local *local;
	56	struct ieee80211_sub_if_data *sdata;
	57	struct sta_info *sta;
	58
3b96766f	59	/* for sdata list */
11a843b7 JB	60	struct list_head list;
11a843b7 JB	61
ad0e2b5a	62	/* protected by key mutex */
11a843b7 JB	63	unsigned int flags;
11a843b7 JB	64
f0706e82 JB	65	union {
f0706e82 JB	66	struct {
523b02ea JB	67	/* protects tx context */
	68	spinlock_t txlock;
	69
f0706e82	70	/* last used TSC */
b0f76b33	71	struct tkip_ctx tx;
f0706e82 JB	72
f0706e82 JB	73	/* last received RSC */
5a306f58	74	struct tkip_ctx rx[IEEE80211_NUM_TIDS];
b98ea058 S	75
	76	/* number of mic failures */
	77	u32 mic_failures;
f0706e82 JB	78	} tkip;
f0706e82 JB	79	struct {
9190252c JM	80	/*
9190252c JM	81	* Last received packet number. The first
5a306f58	82	* IEEE80211_NUM_TIDS counters are used with Data
9190252c JM	83	* frames and the last counter is used with Robust
	84	* Management frames.
	85	*/
4325f6ca	86	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
7ec7c4a9	87	struct crypto_aead *tfm;
f0706e82	88	u32 replays; /* dot11RSNAStatsCCMPReplays */
f0706e82	89	} ccmp;
765cb46a	90	struct {
4325f6ca	91	u8 rx_pn[IEEE80211_CMAC_PN_LEN];
765cb46a JM	92	struct crypto_cipher *tfm;
	93	u32 replays; /* dot11RSNAStatsCMACReplays */
	94	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
765cb46a	95	} aes_cmac;
8ade538b	96	struct {
8ade538b JM	97	u8 rx_pn[IEEE80211_GMAC_PN_LEN];
	98	struct crypto_aead *tfm;
	99	u32 replays; /* dot11RSNAStatsCMACReplays */
	100	u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
	101	} aes_gmac;
00b9cfa3	102	struct {
00b9cfa3 JM	103	/* Last received packet number. The first
	104	* IEEE80211_NUM_TIDS counters are used with Data
	105	* frames and the last counter is used with Robust
	106	* Management frames.
	107	*/
	108	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
	109	struct crypto_aead *tfm;
	110	u32 replays; /* dot11RSNAStatsGCMPReplays */
	111	} gcmp;
2475b1cc MS	112	struct {
2475b1cc MS	113	/* generic cipher scheme */
a31cf1c6	114	u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
2475b1cc	115	} gen;
f0706e82	116	} u;
f0706e82	117
e9f207f0 JB	118	#ifdef CONFIG_MAC80211_DEBUGFS
	119	struct {
	120	struct dentry *stalink;
	121	struct dentry *dir;
d9c58f30	122	int cnt;
e9f207f0 JB	123	} debugfs;
	124	#endif
	125
8f20fc24 JB	126	/*
	127	* key config, must be last because it contains key
	128	* material as variable length member
	129	*/
	130	struct ieee80211_key_conf conf;
f0706e82 JB	131	};
f0706e82 JB	132
2475b1cc MS	133	struct ieee80211_key *
	134	ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
	135	const u8 *key_data,
	136	size_t seq_len, const u8 *seq,
	137	const struct ieee80211_cipher_scheme *cs);
db4d1169 JB	138	/*
db4d1169 JB	139	* Insert a key into data structures (sdata, sta if necessary)
79cf2dfa	140	* to make it used, free old key. On failure, also free the new key.
db4d1169	141	*/
79cf2dfa JB	142	int ieee80211_key_link(struct ieee80211_key *key,
	143	struct ieee80211_sub_if_data *sdata,
	144	struct sta_info *sta);
3b8d9c29	145	void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
79cf2dfa	146	void ieee80211_key_free_unused(struct ieee80211_key *key);
f7e0104c JB	147	void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
f7e0104c JB	148	bool uni, bool multi);
3cfcf6ac JM	149	void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
3cfcf6ac JM	150	int idx);
7907c7d3 JB	151	void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
7907c7d3 JB	152	bool force_synchronize);
6d10e46b JB	153	void ieee80211_free_sta_keys(struct ieee80211_local *local,
6d10e46b JB	154	struct sta_info *sta);
11a843b7	155	void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
f9dca80b	156	void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata);
11a843b7	157
40b275b6 JB	158	#define key_mtx_dereference(local, ref) \
	159	rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
	160
8d1f7ecd JB	161	void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
8d1f7ecd JB	162
f0706e82	163	#endif /* IEEE80211_KEY_H */