blob: 9951ef06323e743d2c33156d15e5a21478584cd9 [file] [log] [blame]
Kyle Swenson8d8f6542021-03-15 11:02:55 -06001/*
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
22struct ieee80211_local;
23struct ieee80211_sub_if_data;
24struct sta_info;
25
26/**
27 * enum ieee80211_internal_key_flags - internal key flags
28 *
29 * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
30 * in the hardware for TX crypto hardware acceleration.
31 * @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
32 * @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
33 */
34enum ieee80211_internal_key_flags {
35 KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
36 KEY_FLAG_TAINTED = BIT(1),
37 KEY_FLAG_CIPHER_SCHEME = BIT(2),
38};
39
40enum ieee80211_internal_tkip_state {
41 TKIP_STATE_NOT_INIT,
42 TKIP_STATE_PHASE1_DONE,
43 TKIP_STATE_PHASE1_HW_UPLOADED,
44};
45
46struct tkip_ctx {
47 u32 iv32; /* current iv32 */
48 u16 iv16; /* current iv16 */
49 u16 p1k[5]; /* p1k cache */
50 u32 p1k_iv32; /* iv32 for which p1k computed */
51 enum ieee80211_internal_tkip_state state;
52};
53
54struct ieee80211_key {
55 struct ieee80211_local *local;
56 struct ieee80211_sub_if_data *sdata;
57 struct sta_info *sta;
58
59 /* for sdata list */
60 struct list_head list;
61
62 /* protected by key mutex */
63 unsigned int flags;
64
65 union {
66 struct {
67 /* protects tx context */
68 spinlock_t txlock;
69
70 /* last used TSC */
71 struct tkip_ctx tx;
72
73 /* last received RSC */
74 struct tkip_ctx rx[IEEE80211_NUM_TIDS];
75
76 /* number of mic failures */
77 u32 mic_failures;
78 } tkip;
79 struct {
80 /*
81 * Last received packet number. The first
82 * IEEE80211_NUM_TIDS counters are used with Data
83 * frames and the last counter is used with Robust
84 * Management frames.
85 */
86 u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
87 struct crypto_aead *tfm;
88 u32 replays; /* dot11RSNAStatsCCMPReplays */
89 } ccmp;
90 struct {
91 u8 rx_pn[IEEE80211_CMAC_PN_LEN];
92 struct crypto_cipher *tfm;
93 u32 replays; /* dot11RSNAStatsCMACReplays */
94 u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
95 } aes_cmac;
96 struct {
97 u8 rx_pn[IEEE80211_GMAC_PN_LEN];
98 struct crypto_aead *tfm;
99 u32 replays; /* dot11RSNAStatsCMACReplays */
100 u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
101 } aes_gmac;
102 struct {
103 /* Last received packet number. The first
104 * IEEE80211_NUM_TIDS counters are used with Data
105 * frames and the last counter is used with Robust
106 * Management frames.
107 */
108 u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
109 struct crypto_aead *tfm;
110 u32 replays; /* dot11RSNAStatsGCMPReplays */
111 } gcmp;
112 struct {
113 /* generic cipher scheme */
114 u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
115 } gen;
116 } u;
117
118#ifdef CONFIG_MAC80211_DEBUGFS
119 struct {
120 struct dentry *stalink;
121 struct dentry *dir;
122 int cnt;
123 } debugfs;
124#endif
125
126 /*
127 * key config, must be last because it contains key
128 * material as variable length member
129 */
130 struct ieee80211_key_conf conf;
131};
132
133struct ieee80211_key *
134ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
135 const u8 *key_data,
136 size_t seq_len, const u8 *seq,
137 const struct ieee80211_cipher_scheme *cs);
138/*
139 * Insert a key into data structures (sdata, sta if necessary)
140 * to make it used, free old key. On failure, also free the new key.
141 */
142int ieee80211_key_link(struct ieee80211_key *key,
143 struct ieee80211_sub_if_data *sdata,
144 struct sta_info *sta);
145void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
146void ieee80211_key_free_unused(struct ieee80211_key *key);
147void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
148 bool uni, bool multi);
149void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
150 int idx);
151void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
152 bool force_synchronize);
153void ieee80211_free_sta_keys(struct ieee80211_local *local,
154 struct sta_info *sta);
155void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata);
156void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata);
157
158#define key_mtx_dereference(local, ref) \
159 rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
160
161void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
162
163#endif /* IEEE80211_KEY_H */