xref: /linux/net/mac80211/key.h (revision f8324e20f8289dffc646d64366332e05eaacab25)
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 #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
31 
32 struct ieee80211_local;
33 struct ieee80211_sub_if_data;
34 struct sta_info;
35 
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.
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.
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.
47  * @KEY_FLAG_TODO_DEFKEY: Key is default key and debugfs needs to be updated.
48  * @KEY_FLAG_TODO_ADD_DEBUGFS: Key needs to be added to debugfs.
49  * @KEY_FLAG_TODO_DEFMGMTKEY: Key is default management key and debugfs needs
50  *	to be updated.
51  */
52 enum ieee80211_internal_key_flags {
53 	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
54 	KEY_FLAG_TODO_DELETE		= BIT(1),
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),
59 	KEY_FLAG_TODO_DEFMGMTKEY	= BIT(6),
60 };
61 
62 enum ieee80211_internal_tkip_state {
63 	TKIP_STATE_NOT_INIT,
64 	TKIP_STATE_PHASE1_DONE,
65 	TKIP_STATE_PHASE1_HW_UPLOADED,
66 };
67 
68 struct tkip_ctx {
69 	u32 iv32;
70 	u16 iv16;
71 	u16 p1k[5];
72 	enum ieee80211_internal_tkip_state state;
73 };
74 
75 struct ieee80211_key {
76 	struct ieee80211_local *local;
77 	struct ieee80211_sub_if_data *sdata;
78 	struct sta_info *sta;
79 
80 	/* for sdata list */
81 	struct list_head list;
82 	/* for todo list */
83 	struct list_head todo;
84 
85 	/* protected by todo lock! */
86 	unsigned int flags;
87 
88 	union {
89 		struct {
90 			/* last used TSC */
91 			struct tkip_ctx tx;
92 
93 			/* last received RSC */
94 			struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
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;
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;
118 	} u;
119 
120 	/* number of times this key has been used */
121 	int tx_rx_count;
122 
123 #ifdef CONFIG_MAC80211_DEBUGFS
124 	struct {
125 		struct dentry *stalink;
126 		struct dentry *dir;
127 		int cnt;
128 	} debugfs;
129 #endif
130 
131 	/*
132 	 * key config, must be last because it contains key
133 	 * material as variable length member
134 	 */
135 	struct ieee80211_key_conf conf;
136 };
137 
138 struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
139 					  int idx,
140 					  size_t key_len,
141 					  const u8 *key_data,
142 					  size_t seq_len, const u8 *seq);
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);
150 void ieee80211_key_free(struct ieee80211_key *key);
151 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx);
152 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
153 				    int idx);
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 
158 void ieee80211_key_todo(void);
159 
160 #endif /* IEEE80211_KEY_H */
161