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