ieee80211_crypto.h revision 1.10.46.1
1 /* $NetBSD: ieee80211_crypto.h,v 1.10.46.1 2008/02/22 16:50:25 skrll Exp $ */ 2 /*- 3 * Copyright (c) 2001 Atsushi Onoe 4 * Copyright (c) 2002-2007 Sam Leffler, Errno Consulting 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * $FreeBSD: src/sys/net80211/ieee80211_crypto.h,v 1.13 2007/06/11 03:36:54 sam Exp $ 28 */ 29 #ifndef _NET80211_IEEE80211_CRYPTO_H_ 30 #define _NET80211_IEEE80211_CRYPTO_H_ 31 32 /* 33 * 802.11 protocol crypto-related definitions. 34 */ 35 #define IEEE80211_KEYBUF_SIZE 16 36 #define IEEE80211_MICBUF_SIZE (8+8) /* space for both tx+rx keys */ 37 38 /* 39 * Old WEP-style key. Deprecated. 40 */ 41 struct ieee80211_wepkey { 42 u_int wk_len; /* key length in bytes */ 43 uint8_t wk_key[IEEE80211_KEYBUF_SIZE]; 44 }; 45 46 struct ieee80211_cipher; 47 48 /* 49 * Crypto key state. There is sufficient room for all supported 50 * ciphers (see below). The underlying ciphers are handled 51 * separately through loadable cipher modules that register with 52 * the generic crypto support. A key has a reference to an instance 53 * of the cipher; any per-key state is hung off wk_private by the 54 * cipher when it is attached. Ciphers are automatically called 55 * to detach and cleanup any such state when the key is deleted. 56 * 57 * The generic crypto support handles encap/decap of cipher-related 58 * frame contents for both hardware- and software-based implementations. 59 * A key requiring software crypto support is automatically flagged and 60 * the cipher is expected to honor this and do the necessary work. 61 * Ciphers such as TKIP may also support mixed hardware/software 62 * encrypt/decrypt and MIC processing. 63 */ 64 typedef uint16_t ieee80211_keyix; /* h/w key index */ 65 66 struct ieee80211_key { 67 uint8_t wk_keylen; /* key length in bytes */ 68 uint8_t wk_pad; 69 uint16_t wk_flags; 70 #define IEEE80211_KEY_XMIT 0x01 /* key used for xmit */ 71 #define IEEE80211_KEY_RECV 0x02 /* key used for recv */ 72 #define IEEE80211_KEY_GROUP 0x04 /* key used for WPA group operation */ 73 #define IEEE80211_KEY_SWCRYPT 0x10 /* host-based encrypt/decrypt */ 74 #define IEEE80211_KEY_SWMIC 0x20 /* host-based enmic/demic */ 75 ieee80211_keyix wk_keyix; /* h/w key index */ 76 ieee80211_keyix wk_rxkeyix; /* optional h/w rx key index */ 77 uint8_t wk_key[IEEE80211_KEYBUF_SIZE+IEEE80211_MICBUF_SIZE]; 78 #define wk_txmic wk_key+IEEE80211_KEYBUF_SIZE+0 /* XXX can't () right */ 79 #define wk_rxmic wk_key+IEEE80211_KEYBUF_SIZE+8 /* XXX can't () right */ 80 uint64_t wk_keyrsc; /* key receive sequence counter */ 81 uint64_t wk_keytsc; /* key transmit sequence counter */ 82 const struct ieee80211_cipher *wk_cipher; 83 void *wk_private; /* private cipher state */ 84 }; 85 #define IEEE80211_KEY_COMMON /* common flags passed in by apps */\ 86 (IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV | IEEE80211_KEY_GROUP) 87 88 /* 89 * NB: these values are ordered carefully; there are lots of 90 * of implications in any reordering. In particular beware 91 * that 4 is not used to avoid conflicting with IEEE80211_F_PRIVACY. 92 */ 93 #define IEEE80211_CIPHER_WEP 0 94 #define IEEE80211_CIPHER_TKIP 1 95 #define IEEE80211_CIPHER_AES_OCB 2 96 #define IEEE80211_CIPHER_AES_CCM 3 97 #define IEEE80211_CIPHER_CKIP 5 98 #define IEEE80211_CIPHER_NONE 6 /* pseudo value */ 99 100 #define IEEE80211_CIPHER_MAX (IEEE80211_CIPHER_NONE+1) 101 102 #define IEEE80211_KEYIX_NONE ((ieee80211_keyix) -1) 103 104 #if defined(__KERNEL__) || defined(_KERNEL) 105 106 struct ieee80211com; 107 struct ieee80211_node; 108 struct mbuf; 109 110 /* 111 * Crypto state kept in each ieee80211com. Some of this 112 * can/should be shared when virtual AP's are supported. 113 * 114 * XXX save reference to ieee80211com to properly encapsulate state. 115 * XXX split out crypto capabilities from ic_caps 116 */ 117 struct ieee80211_crypto_state { 118 struct ieee80211_key cs_nw_keys[IEEE80211_WEP_NKID]; 119 ieee80211_keyix cs_def_txkey; /* default/group tx key index */ 120 uint16_t cs_max_keyix; /* max h/w key index */ 121 122 int (*cs_key_alloc)(struct ieee80211com *, 123 const struct ieee80211_key *, 124 ieee80211_keyix *, ieee80211_keyix *); 125 int (*cs_key_delete)(struct ieee80211com *, 126 const struct ieee80211_key *); 127 int (*cs_key_set)(struct ieee80211com *, 128 const struct ieee80211_key *, 129 const uint8_t mac[IEEE80211_ADDR_LEN]); 130 void (*cs_key_update_begin)(struct ieee80211com *); 131 void (*cs_key_update_end)(struct ieee80211com *); 132 }; 133 134 void ieee80211_crypto_attach(struct ieee80211com *); 135 void ieee80211_crypto_detach(struct ieee80211com *); 136 int ieee80211_crypto_newkey(struct ieee80211com *, 137 int cipher, int flags, struct ieee80211_key *); 138 int ieee80211_crypto_delkey(struct ieee80211com *, 139 struct ieee80211_key *); 140 int ieee80211_crypto_setkey(struct ieee80211com *, 141 struct ieee80211_key *, const uint8_t macaddr[IEEE80211_ADDR_LEN]); 142 void ieee80211_crypto_delglobalkeys(struct ieee80211com *); 143 144 /* 145 * Template for a supported cipher. Ciphers register with the 146 * crypto code and are typically loaded as separate modules 147 * (the null cipher is always present). 148 * XXX may need refcnts 149 */ 150 struct ieee80211_cipher { 151 const char *ic_name; /* printable name */ 152 u_int ic_cipher; /* IEEE80211_CIPHER_* */ 153 u_int ic_header; /* size of privacy header (bytes) */ 154 u_int ic_trailer; /* size of privacy trailer (bytes) */ 155 u_int ic_miclen; /* size of mic trailer (bytes) */ 156 void* (*ic_attach)(struct ieee80211com *, struct ieee80211_key *); 157 void (*ic_detach)(struct ieee80211_key *); 158 int (*ic_setkey)(struct ieee80211_key *); 159 int (*ic_encap)(struct ieee80211_key *, struct mbuf *, 160 uint8_t keyid); 161 int (*ic_decap)(struct ieee80211_key *, struct mbuf *, int); 162 int (*ic_enmic)(struct ieee80211_key *, struct mbuf *, int); 163 int (*ic_demic)(struct ieee80211_key *, struct mbuf *, int); 164 }; 165 extern const struct ieee80211_cipher ieee80211_cipher_none; 166 extern const struct ieee80211_cipher ieee80211_cipher_wep; 167 extern const struct ieee80211_cipher ieee80211_cipher_tkip; 168 extern const struct ieee80211_cipher ieee80211_cipher_ccmp; 169 170 #define IEEE80211_KEY_UNDEFINED(k) \ 171 ((k)->wk_cipher == &ieee80211_cipher_none) 172 173 void ieee80211_crypto_register(const struct ieee80211_cipher *); 174 void ieee80211_crypto_unregister(const struct ieee80211_cipher *); 175 int ieee80211_crypto_available(u_int cipher); 176 177 struct ieee80211_key *ieee80211_crypto_encap(struct ieee80211com *, 178 struct ieee80211_node *, struct mbuf *); 179 struct ieee80211_key *ieee80211_crypto_decap(struct ieee80211com *, 180 struct ieee80211_node *, struct mbuf *, int); 181 182 /* 183 * Check and remove any MIC. 184 */ 185 static __inline int 186 ieee80211_crypto_demic(struct ieee80211com *ic, struct ieee80211_key *k, 187 struct mbuf *m, int force) 188 { 189 const struct ieee80211_cipher *cip = k->wk_cipher; 190 return (cip->ic_miclen > 0 ? cip->ic_demic(k, m, force) : 1); 191 } 192 193 /* 194 * Add any MIC. 195 */ 196 static __inline int 197 ieee80211_crypto_enmic(struct ieee80211com *ic, 198 struct ieee80211_key *k, struct mbuf *m, int force) 199 { 200 const struct ieee80211_cipher *cip = k->wk_cipher; 201 return (cip->ic_miclen > 0 ? cip->ic_enmic(k, m, force) : 1); 202 } 203 204 /* 205 * Reset key state to an unused state. The crypto 206 * key allocation mechanism insures other state (e.g. 207 * key data) is properly setup before a key is used. 208 */ 209 static __inline void 210 ieee80211_crypto_resetkey(struct ieee80211com *ic, 211 struct ieee80211_key *k, ieee80211_keyix ix) 212 { 213 k->wk_cipher = &ieee80211_cipher_none;; 214 k->wk_private = k->wk_cipher->ic_attach(ic, k); 215 k->wk_keyix = k->wk_rxkeyix = ix; 216 k->wk_flags = IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV; 217 } 218 219 /* 220 * Crypt-related notification methods. 221 */ 222 void ieee80211_notify_replay_failure(struct ieee80211com *, 223 const struct ieee80211_frame *, const struct ieee80211_key *, 224 u_int64_t rsc); 225 void ieee80211_notify_michael_failure(struct ieee80211com *, 226 const struct ieee80211_frame *, u_int keyix); 227 #endif /* defined(__KERNEL__) || defined(_KERNEL) */ 228 #endif /* !_NET80211_IEEE80211_CRYPTO_H_ */ 229
Indexes created Thu Oct 02 01:09:59 GMT 2025