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