ieee80211_crypto.h revision 179394
1/*- 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD: head/sys/net80211/ieee80211_crypto.h 179394 2008-05-28 23:25:36Z sam $ 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; 77 uint16_t wk_flags; 78#define IEEE80211_KEY_XMIT 0x01 /* key used for xmit */ 79#define IEEE80211_KEY_RECV 0x02 /* key used for recv */ 80#define IEEE80211_KEY_GROUP 0x04 /* key used for WPA group operation */ 81#define IEEE80211_KEY_SWENCRYPT 0x10 /* host-based encrypt */ 82#define IEEE80211_KEY_SWDECRYPT 0x20 /* host-based decrypt */ 83#define IEEE80211_KEY_SWENMIC 0x40 /* host-based enmic */ 84#define IEEE80211_KEY_SWDEMIC 0x80 /* host-based demic */ 85 ieee80211_keyix wk_keyix; /* h/w key index */ 86 ieee80211_keyix wk_rxkeyix; /* optional h/w rx key index */ 87 uint8_t wk_key[IEEE80211_KEYBUF_SIZE+IEEE80211_MICBUF_SIZE]; 88#define wk_txmic wk_key+IEEE80211_KEYBUF_SIZE+0 /* XXX can't () right */ 89#define wk_rxmic wk_key+IEEE80211_KEYBUF_SIZE+8 /* XXX can't () right */ 90 /* key receive sequence counter */ 91 uint64_t wk_keyrsc[IEEE80211_TID_SIZE]; 92 uint64_t wk_keytsc; /* key transmit sequence counter */ 93 const struct ieee80211_cipher *wk_cipher; 94 void *wk_private; /* private cipher state */ 95}; 96#define IEEE80211_KEY_COMMON /* common flags passed in by apps */\ 97 (IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV | IEEE80211_KEY_GROUP) 98 99#define IEEE80211_KEY_SWCRYPT \ 100 (IEEE80211_KEY_SWENCRYPT | IEEE80211_KEY_SWDECRYPT) 101#define IEEE80211_KEY_SWMIC (IEEE80211_KEY_SWENMIC | IEEE80211_KEY_SWDEMIC) 102 103#define IEEE80211_KEYIX_NONE ((ieee80211_keyix) -1) 104 105/* 106 * NB: these values are ordered carefully; there are lots of 107 * of implications in any reordering. Beware that 4 is used 108 * only to indicate h/w TKIP MIC support in driver capabilities; 109 * there is no separate cipher support (it's rolled into the 110 * TKIP cipher support). 111 */ 112#define IEEE80211_CIPHER_WEP 0 113#define IEEE80211_CIPHER_TKIP 1 114#define IEEE80211_CIPHER_AES_OCB 2 115#define IEEE80211_CIPHER_AES_CCM 3 116#define IEEE80211_CIPHER_TKIPMIC 4 /* TKIP MIC capability */ 117#define IEEE80211_CIPHER_CKIP 5 118#define IEEE80211_CIPHER_NONE 6 /* pseudo value */ 119 120#define IEEE80211_CIPHER_MAX (IEEE80211_CIPHER_NONE+1) 121 122/* capability bits in ic_cryptocaps/iv_cryptocaps */ 123#define IEEE80211_CRYPTO_WEP (1<<IEEE80211_CIPHER_WEP) 124#define IEEE80211_CRYPTO_TKIP (1<<IEEE80211_CIPHER_TKIP) 125#define IEEE80211_CRYPTO_AES_OCB (1<<IEEE80211_CIPHER_AES_OCB) 126#define IEEE80211_CRYPTO_AES_CCM (1<<IEEE80211_CIPHER_AES_CCM) 127#define IEEE80211_CRYPTO_TKIPMIC (1<<IEEE80211_CIPHER_TKIPMIC) 128#define IEEE80211_CRYPTO_CKIP (1<<IEEE80211_CIPHER_CKIP) 129 130#if defined(__KERNEL__) || defined(_KERNEL) 131 132struct ieee80211com; 133struct ieee80211vap; 134struct ieee80211_node; 135struct mbuf; 136 137MALLOC_DECLARE(M_80211_CRYPTO); 138 139void ieee80211_crypto_attach(struct ieee80211com *); 140void ieee80211_crypto_detach(struct ieee80211com *); 141void ieee80211_crypto_vattach(struct ieee80211vap *); 142void ieee80211_crypto_vdetach(struct ieee80211vap *); 143int ieee80211_crypto_newkey(struct ieee80211vap *, 144 int cipher, int flags, struct ieee80211_key *); 145int ieee80211_crypto_delkey(struct ieee80211vap *, 146 struct ieee80211_key *); 147int ieee80211_crypto_setkey(struct ieee80211vap *, 148 struct ieee80211_key *, 149 const uint8_t macaddr[IEEE80211_ADDR_LEN]); 150void ieee80211_crypto_delglobalkeys(struct ieee80211vap *); 151 152/* 153 * Template for a supported cipher. Ciphers register with the 154 * crypto code and are typically loaded as separate modules 155 * (the null cipher is always present). 156 * XXX may need refcnts 157 */ 158struct ieee80211_cipher { 159 const char *ic_name; /* printable name */ 160 u_int ic_cipher; /* IEEE80211_CIPHER_* */ 161 u_int ic_header; /* size of privacy header (bytes) */ 162 u_int ic_trailer; /* size of privacy trailer (bytes) */ 163 u_int ic_miclen; /* size of mic trailer (bytes) */ 164 void* (*ic_attach)(struct ieee80211vap *, struct ieee80211_key *); 165 void (*ic_detach)(struct ieee80211_key *); 166 int (*ic_setkey)(struct ieee80211_key *); 167 int (*ic_encap)(struct ieee80211_key *, struct mbuf *, 168 uint8_t keyid); 169 int (*ic_decap)(struct ieee80211_key *, struct mbuf *, int); 170 int (*ic_enmic)(struct ieee80211_key *, struct mbuf *, int); 171 int (*ic_demic)(struct ieee80211_key *, struct mbuf *, int); 172}; 173extern const struct ieee80211_cipher ieee80211_cipher_none; 174 175#define IEEE80211_KEY_UNDEFINED(k) \ 176 ((k)->wk_cipher == &ieee80211_cipher_none) 177 178void ieee80211_crypto_register(const struct ieee80211_cipher *); 179void ieee80211_crypto_unregister(const struct ieee80211_cipher *); 180int ieee80211_crypto_available(u_int cipher); 181 182struct ieee80211_key *ieee80211_crypto_encap(struct ieee80211_node *, 183 struct mbuf *); 184struct ieee80211_key *ieee80211_crypto_decap(struct ieee80211_node *, 185 struct mbuf *, int); 186 187/* 188 * Check and remove any MIC. 189 */ 190static __inline int 191ieee80211_crypto_demic(struct ieee80211vap *vap, struct ieee80211_key *k, 192 struct mbuf *m, int force) 193{ 194 const struct ieee80211_cipher *cip = k->wk_cipher; 195 return (cip->ic_miclen > 0 ? cip->ic_demic(k, m, force) : 1); 196} 197 198/* 199 * Add any MIC. 200 */ 201static __inline int 202ieee80211_crypto_enmic(struct ieee80211vap *vap, 203 struct ieee80211_key *k, struct mbuf *m, int force) 204{ 205 const struct ieee80211_cipher *cip = k->wk_cipher; 206 return (cip->ic_miclen > 0 ? cip->ic_enmic(k, m, force) : 1); 207} 208 209/* 210 * Reset key state to an unused state. The crypto 211 * key allocation mechanism insures other state (e.g. 212 * key data) is properly setup before a key is used. 213 */ 214static __inline void 215ieee80211_crypto_resetkey(struct ieee80211vap *vap, 216 struct ieee80211_key *k, ieee80211_keyix ix) 217{ 218 k->wk_cipher = &ieee80211_cipher_none;; 219 k->wk_private = k->wk_cipher->ic_attach(vap, k); 220 k->wk_keyix = k->wk_rxkeyix = ix; 221 k->wk_flags = IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV; 222} 223 224/* 225 * Crypt-related notification methods. 226 */ 227void ieee80211_notify_replay_failure(struct ieee80211vap *, 228 const struct ieee80211_frame *, const struct ieee80211_key *, 229 uint64_t rsc); 230void ieee80211_notify_michael_failure(struct ieee80211vap *, 231 const struct ieee80211_frame *, u_int keyix); 232#endif /* defined(__KERNEL__) || defined(_KERNEL) */ 233#endif /* _NET80211_IEEE80211_CRYPTO_H_ */ 234