1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2001 Atsushi Onoe
5 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28#ifndef _NET80211_IEEE80211_CRYPTO_H_
29#define _NET80211_IEEE80211_CRYPTO_H_
30
31/*
32 * 802.11 protocol crypto-related definitions.
33 */
34#define IEEE80211_KEYBUF_SIZE 16
35#define IEEE80211_MICBUF_SIZE (8+8) /* space for both tx+rx keys */
36
37/*
38 * Old WEP-style key. Deprecated.
39 */
40struct ieee80211_wepkey {
41 u_int wk_len; /* key length in bytes */
42 uint8_t wk_key[IEEE80211_KEYBUF_SIZE];
43};
44
45struct ieee80211_rsnparms {
46 uint8_t rsn_mcastcipher; /* mcast/group cipher */
47 uint8_t rsn_mcastkeylen; /* mcast key length */
48 uint8_t rsn_ucastcipher; /* selected unicast cipher */
49 uint8_t rsn_ucastkeylen; /* unicast key length */
50 uint8_t rsn_keymgmt; /* selected key mgmt algo */
51 uint16_t rsn_caps; /* capabilities */
52};
53
54struct ieee80211_cipher;
55
56/*
57 * Crypto key state. There is sufficient room for all supported
58 * ciphers (see below). The underlying ciphers are handled
59 * separately through loadable cipher modules that register with
60 * the generic crypto support. A key has a reference to an instance
61 * of the cipher; any per-key state is hung off wk_private by the
62 * cipher when it is attached. Ciphers are automatically called
63 * to detach and cleanup any such state when the key is deleted.
64 *
65 * The generic crypto support handles encap/decap of cipher-related
66 * frame contents for both hardware- and software-based implementations.
67 * A key requiring software crypto support is automatically flagged and
68 * the cipher is expected to honor this and do the necessary work.
69 * Ciphers such as TKIP may also support mixed hardware/software
70 * encrypt/decrypt and MIC processing.
71 */
72typedef uint16_t ieee80211_keyix; /* h/w key index */
73
74struct ieee80211_key {
75 uint8_t wk_keylen; /* key length in bytes */
76 uint8_t wk_pad; /* .. some drivers use this. Fix that. */
77 uint8_t wk_pad1[2];
78 uint32_t wk_flags;
79#define IEEE80211_KEY_XMIT 0x00000001 /* key used for xmit */
80#define IEEE80211_KEY_RECV 0x00000002 /* key used for recv */
81#define IEEE80211_KEY_GROUP 0x00000004 /* key used for WPA group operation */
82#define IEEE80211_KEY_NOREPLAY 0x00000008 /* ignore replay failures */
83#define IEEE80211_KEY_SWENCRYPT 0x00000010 /* host-based encrypt */
84#define IEEE80211_KEY_SWDECRYPT 0x00000020 /* host-based decrypt */
85#define IEEE80211_KEY_SWENMIC 0x00000040 /* host-based enmic */
86#define IEEE80211_KEY_SWDEMIC 0x00000080 /* host-based demic */
87#define IEEE80211_KEY_DEVKEY 0x00000100 /* device key request completed */
88#define IEEE80211_KEY_CIPHER0 0x00001000 /* cipher-specific action 0 */
89#define IEEE80211_KEY_CIPHER1 0x00002000 /* cipher-specific action 1 */
90#define IEEE80211_KEY_NOIV 0x00004000 /* don't insert IV/MIC for !mgmt */
91#define IEEE80211_KEY_NOIVMGT 0x00008000 /* don't insert IV/MIC for mgmt */
92#define IEEE80211_KEY_NOMIC 0x00010000 /* don't insert MIC for !mgmt */
93#define IEEE80211_KEY_NOMICMGT 0x00020000 /* don't insert MIC for mgmt */
94
95 ieee80211_keyix wk_keyix; /* h/w key index */
96 ieee80211_keyix wk_rxkeyix; /* optional h/w rx key index */
97 uint8_t wk_key[IEEE80211_KEYBUF_SIZE+IEEE80211_MICBUF_SIZE];
98#define wk_txmic wk_key+IEEE80211_KEYBUF_SIZE+0 /* XXX can't () right */
99#define wk_rxmic wk_key+IEEE80211_KEYBUF_SIZE+8 /* XXX can't () right */
100 /* key receive sequence counter */
101 uint64_t wk_keyrsc[IEEE80211_TID_SIZE];
102 uint64_t wk_keytsc; /* key transmit sequence counter */
103 const struct ieee80211_cipher *wk_cipher;
104 void *wk_private; /* private cipher state */
105 uint8_t wk_macaddr[IEEE80211_ADDR_LEN];
106};
107#define IEEE80211_KEY_COMMON /* common flags passed in by apps */\
108 (IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV | IEEE80211_KEY_GROUP | \
109 IEEE80211_KEY_NOREPLAY)
110
111#define IEEE80211_KEY_SWCRYPT \
112 (IEEE80211_KEY_SWENCRYPT | IEEE80211_KEY_SWDECRYPT)
113#define IEEE80211_KEY_SWMIC (IEEE80211_KEY_SWENMIC | IEEE80211_KEY_SWDEMIC)
114
115#define IEEE80211_KEY_DEVICE /* flags owned by device driver */\
116 (IEEE80211_KEY_DEVKEY|IEEE80211_KEY_CIPHER0|IEEE80211_KEY_CIPHER1| \
117 IEEE80211_KEY_SWCRYPT|IEEE80211_KEY_SWMIC|IEEE80211_KEY_NOIV | \
118 IEEE80211_KEY_NOIVMGT|IEEE80211_KEY_NOMIC|IEEE80211_KEY_NOMICMGT)
119
120#define IEEE80211_KEY_BITS \
121 "\20\1XMIT\2RECV\3GROUP\4NOREPLAY\5SWENCRYPT\6SWDECRYPT\7SWENMIC\10SWDEMIC" \
122 "\11DEVKEY\12CIPHER0\13CIPHER1\14NOIV\15NOIVMGT\16NOMIC\17NOMICMGT"
123
124#define IEEE80211_KEYIX_NONE ((ieee80211_keyix) -1)
125
126/*
127 * NB: these values are ordered carefully; there are lots of
128 * of implications in any reordering. Beware that 4 is used
129 * only to indicate h/w TKIP MIC support in driver capabilities;
130 * there is no separate cipher support (it's rolled into the
131 * TKIP cipher support).
132 */
133#define IEEE80211_CIPHER_WEP 0
134#define IEEE80211_CIPHER_TKIP 1
135#define IEEE80211_CIPHER_AES_OCB 2
136#define IEEE80211_CIPHER_AES_CCM 3
137#define IEEE80211_CIPHER_TKIPMIC 4 /* TKIP MIC capability */
138#define IEEE80211_CIPHER_CKIP 5
139#define IEEE80211_CIPHER_NONE 6 /* pseudo value */
140#define IEEE80211_CIPHER_AES_CCM_256 7
141#define IEEE80211_CIPHER_BIP_CMAC_128 8
142#define IEEE80211_CIPHER_BIP_CMAC_256 9
143#define IEEE80211_CIPHER_BIP_GMAC_128 10
144#define IEEE80211_CIPHER_BIP_GMAC_256 11
145#define IEEE80211_CIPHER_AES_GCM_128 12
146#define IEEE80211_CIPHER_AES_GCM_256 13
147
148#define IEEE80211_CIPHER_LAST 13
149
150#define IEEE80211_CIPHER_MAX (IEEE80211_CIPHER_LAST+1)
151
152/* capability bits in ic_cryptocaps/iv_cryptocaps */
153#define IEEE80211_CRYPTO_WEP (1<<IEEE80211_CIPHER_WEP)
154#define IEEE80211_CRYPTO_TKIP (1<<IEEE80211_CIPHER_TKIP)
155#define IEEE80211_CRYPTO_AES_OCB (1<<IEEE80211_CIPHER_AES_OCB)
156#define IEEE80211_CRYPTO_AES_CCM (1<<IEEE80211_CIPHER_AES_CCM)
157#define IEEE80211_CRYPTO_TKIPMIC (1<<IEEE80211_CIPHER_TKIPMIC)
158#define IEEE80211_CRYPTO_CKIP (1<<IEEE80211_CIPHER_CKIP)
159#define IEEE80211_CRYPTO_AES_CCM_256 (1<<IEEE80211_CIPHER_AES_CCM_256)
160#define IEEE80211_CRYPTO_BIP_CMAC_128 (1<<IEEE80211_CIPHER_BIP_CMAC_128)
161#define IEEE80211_CRYPTO_BIP_CMAC_256 (1<<IEEE80211_CIPHER_BIP_CMAC_256)
162#define IEEE80211_CRYPTO_BIP_GMAC_128 (1<<IEEE80211_CIPHER_BIP_GMAC_128)
163#define IEEE80211_CRYPTO_BIP_GMAC_256 (1<<IEEE80211_CIPHER_BIP_GMAC_256)
164#define IEEE80211_CRYPTO_AES_GCM_128 (1<<IEEE80211_CIPHER_AES_GCM_128)
165#define IEEE80211_CRYPTO_AES_GCM_256 (1<<IEEE80211_CIPHER_AES_GCM_256)
166
167#define IEEE80211_CRYPTO_BITS \
168 "\20\1WEP\2TKIP\3AES\4AES_CCM\5TKIPMIC\6CKIP\10AES_CCM_256" \
169 "\11BIP_CMAC_128\12BIP_CMAC_256\13BIP_GMAC_128\14BIP_CMAC_256" \
170 "\15AES_GCM_128\16AES_GCM_256"
171
172#if defined(__KERNEL__) || defined(_KERNEL)
173
174struct ieee80211com;
175struct ieee80211vap;
176struct ieee80211_node;
177struct mbuf;
178
179MALLOC_DECLARE(M_80211_CRYPTO);
180
181void ieee80211_crypto_attach(struct ieee80211com *);
182void ieee80211_crypto_detach(struct ieee80211com *);
183void ieee80211_crypto_set_supported_software_ciphers(struct ieee80211com *,
184 uint32_t cipher_set);
185void ieee80211_crypto_set_supported_hardware_ciphers(struct ieee80211com *,
186 uint32_t cipher_set);
187void ieee80211_crypto_set_supported_driver_keymgmt(struct ieee80211com *,
188 uint32_t keymgmt_set);
189void ieee80211_crypto_vattach(struct ieee80211vap *);
190void ieee80211_crypto_vdetach(struct ieee80211vap *);
191int ieee80211_crypto_newkey(struct ieee80211vap *,
192 int cipher, int flags, struct ieee80211_key *);
193int ieee80211_crypto_delkey(struct ieee80211vap *,
194 struct ieee80211_key *);
195int ieee80211_crypto_setkey(struct ieee80211vap *, struct ieee80211_key *);
196void ieee80211_crypto_delglobalkeys(struct ieee80211vap *);
197void ieee80211_crypto_reload_keys(struct ieee80211com *);
198void ieee80211_crypto_set_deftxkey(struct ieee80211vap *,
199 ieee80211_keyix kid);
200
201/*
202 * Template for a supported cipher. Ciphers register with the
203 * crypto code and are typically loaded as separate modules
204 * (the null cipher is always present).
205 * XXX may need refcnts
206 */
207struct ieee80211_cipher {
208 const char *ic_name; /* printable name */
209 u_int ic_cipher; /* IEEE80211_CIPHER_* */
210 u_int ic_header; /* size of privacy header (bytes) */
211 u_int ic_trailer; /* size of privacy trailer (bytes) */
212 u_int ic_miclen; /* size of mic trailer (bytes) */
213 void* (*ic_attach)(struct ieee80211vap *, struct ieee80211_key *);
214 void (*ic_detach)(struct ieee80211_key *);
215 int (*ic_setkey)(struct ieee80211_key *);
216 void (*ic_setiv)(struct ieee80211_key *, uint8_t *);
217 int (*ic_encap)(struct ieee80211_key *, struct mbuf *);
218 int (*ic_decap)(struct ieee80211_key *, struct mbuf *, int);
219 /*
220 * ic_enmic() and ic_demic() are currently only used by TKIP.
221 * Please see ieee80211_crypto_enmic() and ieee80211_crypto_demic()
222 * for more information.
223 */
224 int (*ic_enmic)(struct ieee80211_key *, struct mbuf *, int);
225 int (*ic_demic)(struct ieee80211_key *, struct mbuf *, int);
226};
227extern const struct ieee80211_cipher ieee80211_cipher_none;
228
229#define IEEE80211_KEY_UNDEFINED(k) \
230 ((k)->wk_cipher == &ieee80211_cipher_none)
231
232void ieee80211_crypto_register(const struct ieee80211_cipher *);
233void ieee80211_crypto_unregister(const struct ieee80211_cipher *);
234int ieee80211_crypto_available(u_int cipher);
235
236int ieee80211_crypto_get_key_wepidx(const struct ieee80211vap *,
237 const struct ieee80211_key *k);
238uint8_t ieee80211_crypto_get_keyid(struct ieee80211vap *vap,
239 struct ieee80211_key *k);
240struct ieee80211_key *ieee80211_crypto_get_txkey(struct ieee80211_node *,
241 struct mbuf *);
242struct ieee80211_key *ieee80211_crypto_encap(struct ieee80211_node *,
243 struct mbuf *);
244int ieee80211_crypto_decap(struct ieee80211_node *,
245 struct mbuf *, int, struct ieee80211_key **);
246int ieee80211_crypto_demic(struct ieee80211vap *vap, struct ieee80211_key *k,
247 struct mbuf *, int);
248/**
249 * @brief Add any pre-fragmentation MIC to an MSDU.
250 *
251 * This is called before 802.11 fragmentation. Crypto types that implement
252 * a MIC/ICV check per MSDU will not implement this function.
253 *
254 * As an example, TKIP implements a Michael MIC check over the entire
255 * unencrypted MSDU before fragmenting it into MPDUs and passing each
256 * MPDU to be separately encrypted with their own MIC/ICV.
257 *
258 * Please see 802.11-2020 12.5.2.1.2 (TKIP cryptographic encapsulation)
259 * for more information.
260 *
261 * @param vap the current VAP
262 * @param k the current key
263 * @param m the mbuf representing the MSDU
264 * @param f set to 1 to force a MSDU MIC check, even if HW encrypted
265 * @returns 0 if error / MIC encap failed, 1 if OK
266 */
267static __inline int
268ieee80211_crypto_enmic(struct ieee80211vap *vap,
269 struct ieee80211_key *k, struct mbuf *m, int force)
270{
271 const struct ieee80211_cipher *cip = k->wk_cipher;
272 return (cip->ic_miclen > 0 ? cip->ic_enmic(k, m, force) : 1);
273}
274
275/*
276 * Reset key state to an unused state. The crypto
277 * key allocation mechanism insures other state (e.g.
278 * key data) is properly setup before a key is used.
279 */
280static __inline void
281ieee80211_crypto_resetkey(struct ieee80211vap *vap,
282 struct ieee80211_key *k, ieee80211_keyix ix)
283{
284 k->wk_cipher = &ieee80211_cipher_none;
285 k->wk_private = k->wk_cipher->ic_attach(vap, k);
286 k->wk_keyix = k->wk_rxkeyix = ix;
287 k->wk_flags = IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV;
288}
289
290/*
291 * Crypt-related notification methods.
292 */
293void ieee80211_notify_replay_failure(struct ieee80211vap *,
294 const struct ieee80211_frame *, const struct ieee80211_key *,
295 uint64_t rsc, int tid);
296void ieee80211_notify_michael_failure(struct ieee80211vap *,
297 const struct ieee80211_frame *, ieee80211_keyix keyix);
298
299/* AAD assembly for CCMP/GCMP. */
300uint16_t ieee80211_crypto_init_aad(const struct ieee80211_frame *,
301 uint8_t *, int);
302
303#endif /* defined(__KERNEL__) || defined(_KERNEL) */
304#endif /* _NET80211_IEEE80211_CRYPTO_H_ */