xref: /linux/net/mac80211/key.h (revision d39d0ed196aa1685bb24771e92f78633c66ac9cb)
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  */
42 enum ieee80211_internal_key_flags {
43 	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
44 };
45 
46 enum ieee80211_internal_tkip_state {
47 	TKIP_STATE_NOT_INIT,
48 	TKIP_STATE_PHASE1_DONE,
49 	TKIP_STATE_PHASE1_HW_UPLOADED,
50 };
51 
52 struct tkip_ctx {
53 	u32 iv32;
54 	u16 iv16;
55 	u16 p1k[5];
56 	enum ieee80211_internal_tkip_state state;
57 };
58 
59 struct ieee80211_key {
60 	struct ieee80211_local *local;
61 	struct ieee80211_sub_if_data *sdata;
62 	struct sta_info *sta;
63 
64 	/* for sdata list */
65 	struct list_head list;
66 
67 	/* protected by key mutex */
68 	unsigned int flags;
69 
70 	union {
71 		struct {
72 			/* last used TSC */
73 			struct tkip_ctx tx;
74 
75 			/* last received RSC */
76 			struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
77 		} tkip;
78 		struct {
79 			u8 tx_pn[6];
80 			/*
81 			 * Last received packet number. The first
82 			 * NUM_RX_DATA_QUEUES counters are used with Data
83 			 * frames and the last counter is used with Robust
84 			 * Management frames.
85 			 */
86 			u8 rx_pn[NUM_RX_DATA_QUEUES + 1][6];
87 			struct crypto_cipher *tfm;
88 			u32 replays; /* dot11RSNAStatsCCMPReplays */
89 			/* scratch buffers for virt_to_page() (crypto API) */
90 #ifndef AES_BLOCK_LEN
91 #define AES_BLOCK_LEN 16
92 #endif
93 			u8 tx_crypto_buf[6 * AES_BLOCK_LEN];
94 			u8 rx_crypto_buf[6 * AES_BLOCK_LEN];
95 		} ccmp;
96 		struct {
97 			u8 tx_pn[6];
98 			u8 rx_pn[6];
99 			struct crypto_cipher *tfm;
100 			u32 replays; /* dot11RSNAStatsCMACReplays */
101 			u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
102 			/* scratch buffers for virt_to_page() (crypto API) */
103 			u8 tx_crypto_buf[2 * AES_BLOCK_LEN];
104 			u8 rx_crypto_buf[2 * AES_BLOCK_LEN];
105 		} aes_cmac;
106 	} u;
107 
108 	/* number of times this key has been used */
109 	int tx_rx_count;
110 
111 #ifdef CONFIG_MAC80211_DEBUGFS
112 	struct {
113 		struct dentry *stalink;
114 		struct dentry *dir;
115 		int cnt;
116 	} debugfs;
117 #endif
118 
119 	/*
120 	 * key config, must be last because it contains key
121 	 * material as variable length member
122 	 */
123 	struct ieee80211_key_conf conf;
124 };
125 
126 struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
127 					  int idx,
128 					  size_t key_len,
129 					  const u8 *key_data,
130 					  size_t seq_len, const u8 *seq);
131 /*
132  * Insert a key into data structures (sdata, sta if necessary)
133  * to make it used, free old key.
134  */
135 void ieee80211_key_link(struct ieee80211_key *key,
136 			struct ieee80211_sub_if_data *sdata,
137 			struct sta_info *sta);
138 void ieee80211_key_free(struct ieee80211_local *local,
139 			struct ieee80211_key *key);
140 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx);
141 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
142 				    int idx);
143 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata);
144 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
145 void ieee80211_disable_keys(struct ieee80211_sub_if_data *sdata);
146 
147 #endif /* IEEE80211_KEY_H */
148