xref: /openbmc/linux/net/mac80211/key.h (revision 9ac8d3fb)
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  */
50 enum ieee80211_internal_key_flags {
51 	KEY_FLAG_UPLOADED_TO_HARDWARE	= BIT(0),
52 	KEY_FLAG_TODO_DELETE		= BIT(1),
53 	KEY_FLAG_TODO_HWACCEL_ADD	= BIT(2),
54 	KEY_FLAG_TODO_HWACCEL_REMOVE	= BIT(3),
55 	KEY_FLAG_TODO_DEFKEY		= BIT(4),
56 	KEY_FLAG_TODO_ADD_DEBUGFS	= BIT(5),
57 };
58 
59 struct tkip_ctx {
60 	u32 iv32;
61 	u16 iv16;
62 	u16 p1k[5];
63 	int initialized;
64 };
65 
66 struct ieee80211_key {
67 	struct ieee80211_local *local;
68 	struct ieee80211_sub_if_data *sdata;
69 	struct sta_info *sta;
70 
71 	/* for sdata list */
72 	struct list_head list;
73 	/* for todo list */
74 	struct list_head todo;
75 
76 	/* protected by todo lock! */
77 	unsigned int flags;
78 
79 	union {
80 		struct {
81 			/* last used TSC */
82 			struct tkip_ctx tx;
83 
84 			/* last received RSC */
85 			struct tkip_ctx rx[NUM_RX_DATA_QUEUES];
86 		} tkip;
87 		struct {
88 			u8 tx_pn[6];
89 			u8 rx_pn[NUM_RX_DATA_QUEUES][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 	} u;
100 
101 	/* number of times this key has been used */
102 	int tx_rx_count;
103 
104 #ifdef CONFIG_MAC80211_DEBUGFS
105 	struct {
106 		struct dentry *stalink;
107 		struct dentry *dir;
108 		struct dentry *keylen;
109 		struct dentry *flags;
110 		struct dentry *keyidx;
111 		struct dentry *hw_key_idx;
112 		struct dentry *tx_rx_count;
113 		struct dentry *algorithm;
114 		struct dentry *tx_spec;
115 		struct dentry *rx_spec;
116 		struct dentry *replays;
117 		struct dentry *key;
118 		struct dentry *ifindex;
119 		int cnt;
120 	} debugfs;
121 #endif
122 
123 	/*
124 	 * key config, must be last because it contains key
125 	 * material as variable length member
126 	 */
127 	struct ieee80211_key_conf conf;
128 };
129 
130 struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
131 					  int idx,
132 					  size_t key_len,
133 					  const u8 *key_data);
134 /*
135  * Insert a key into data structures (sdata, sta if necessary)
136  * to make it used, free old key.
137  */
138 void ieee80211_key_link(struct ieee80211_key *key,
139 			struct ieee80211_sub_if_data *sdata,
140 			struct sta_info *sta);
141 void ieee80211_key_free(struct ieee80211_key *key);
142 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, 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 void ieee80211_key_todo(void);
148 
149 #endif /* IEEE80211_KEY_H */
150