11a1e1d21SSam Leffler /*- 27535e66aSSam Leffler * Copyright (c) 2001 Atsushi Onoe 3b032f27cSSam Leffler * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting 41a1e1d21SSam Leffler * All rights reserved. 51a1e1d21SSam Leffler * 61a1e1d21SSam Leffler * Redistribution and use in source and binary forms, with or without 71a1e1d21SSam Leffler * modification, are permitted provided that the following conditions 81a1e1d21SSam Leffler * are met: 91a1e1d21SSam Leffler * 1. Redistributions of source code must retain the above copyright 107535e66aSSam Leffler * notice, this list of conditions and the following disclaimer. 117535e66aSSam Leffler * 2. Redistributions in binary form must reproduce the above copyright 127535e66aSSam Leffler * notice, this list of conditions and the following disclaimer in the 137535e66aSSam Leffler * documentation and/or other materials provided with the distribution. 141a1e1d21SSam Leffler * 157535e66aSSam Leffler * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 167535e66aSSam Leffler * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 177535e66aSSam Leffler * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 187535e66aSSam Leffler * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 197535e66aSSam Leffler * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 207535e66aSSam Leffler * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 217535e66aSSam Leffler * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 227535e66aSSam Leffler * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 237535e66aSSam Leffler * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 247535e66aSSam Leffler * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 251a1e1d21SSam Leffler */ 261a1e1d21SSam Leffler 271a1e1d21SSam Leffler #include <sys/cdefs.h> 281a1e1d21SSam Leffler __FBSDID("$FreeBSD$"); 291a1e1d21SSam Leffler 308a1b9b6aSSam Leffler /* 318a1b9b6aSSam Leffler * IEEE 802.11 generic crypto support. 328a1b9b6aSSam Leffler */ 33b032f27cSSam Leffler #include "opt_wlan.h" 34b032f27cSSam Leffler 351a1e1d21SSam Leffler #include <sys/param.h> 36b032f27cSSam Leffler #include <sys/kernel.h> 37b032f27cSSam Leffler #include <sys/malloc.h> 381a1e1d21SSam Leffler #include <sys/mbuf.h> 391a1e1d21SSam Leffler 408a1b9b6aSSam Leffler #include <sys/socket.h> 411a1e1d21SSam Leffler 421a1e1d21SSam Leffler #include <net/if.h> 431a1e1d21SSam Leffler #include <net/if_media.h> 448a1b9b6aSSam Leffler #include <net/ethernet.h> /* XXX ETHER_HDR_LEN */ 451a1e1d21SSam Leffler 461a1e1d21SSam Leffler #include <net80211/ieee80211_var.h> 471a1e1d21SSam Leffler 48b032f27cSSam Leffler MALLOC_DEFINE(M_80211_CRYPTO, "80211crypto", "802.11 crypto state"); 49b032f27cSSam Leffler 50b032f27cSSam Leffler static int _ieee80211_crypto_delkey(struct ieee80211vap *, 51b032f27cSSam Leffler struct ieee80211_key *); 52b032f27cSSam Leffler 538a1b9b6aSSam Leffler /* 548a1b9b6aSSam Leffler * Table of registered cipher modules. 558a1b9b6aSSam Leffler */ 568a1b9b6aSSam Leffler static const struct ieee80211_cipher *ciphers[IEEE80211_CIPHER_MAX]; 571a1e1d21SSam Leffler 588a1b9b6aSSam Leffler /* 598a1b9b6aSSam Leffler * Default "null" key management routines. 608a1b9b6aSSam Leffler */ 618a1b9b6aSSam Leffler static int 62e6e547d5SSam Leffler null_key_alloc(struct ieee80211vap *vap, struct ieee80211_key *k, 63c1225b52SSam Leffler ieee80211_keyix *keyix, ieee80211_keyix *rxkeyix) 641a1e1d21SSam Leffler { 65b032f27cSSam Leffler if (!(&vap->iv_nw_keys[0] <= k && 66b032f27cSSam Leffler k < &vap->iv_nw_keys[IEEE80211_WEP_NKID])) { 675c8a7b1bSSam Leffler /* 685c8a7b1bSSam Leffler * Not in the global key table, the driver should handle this 695c8a7b1bSSam Leffler * by allocating a slot in the h/w key table/cache. In 705c8a7b1bSSam Leffler * lieu of that return key slot 0 for any unicast key 715c8a7b1bSSam Leffler * request. We disallow the request if this is a group key. 725c8a7b1bSSam Leffler * This default policy does the right thing for legacy hardware 735c8a7b1bSSam Leffler * with a 4 key table. It also handles devices that pass 745c8a7b1bSSam Leffler * packets through untouched when marked with the WEP bit 755c8a7b1bSSam Leffler * and key index 0. 765c8a7b1bSSam Leffler */ 77c1225b52SSam Leffler if (k->wk_flags & IEEE80211_KEY_GROUP) 78c1225b52SSam Leffler return 0; 79c1225b52SSam Leffler *keyix = 0; /* NB: use key index 0 for ucast key */ 80c1225b52SSam Leffler } else { 81b032f27cSSam Leffler *keyix = k - vap->iv_nw_keys; 828a1b9b6aSSam Leffler } 83c1225b52SSam Leffler *rxkeyix = IEEE80211_KEYIX_NONE; /* XXX maybe *keyix? */ 84c1225b52SSam Leffler return 1; 855c8a7b1bSSam Leffler } 868a1b9b6aSSam Leffler static int 87b032f27cSSam Leffler null_key_delete(struct ieee80211vap *vap, const struct ieee80211_key *k) 888a1b9b6aSSam Leffler { 898a1b9b6aSSam Leffler return 1; 908a1b9b6aSSam Leffler } 918a1b9b6aSSam Leffler static int 92b032f27cSSam Leffler null_key_set(struct ieee80211vap *vap, const struct ieee80211_key *k, 9368e8e04eSSam Leffler const uint8_t mac[IEEE80211_ADDR_LEN]) 948a1b9b6aSSam Leffler { 958a1b9b6aSSam Leffler return 1; 968a1b9b6aSSam Leffler } 97b032f27cSSam Leffler static void null_key_update(struct ieee80211vap *vap) {} 988a1b9b6aSSam Leffler 998a1b9b6aSSam Leffler /* 1008a1b9b6aSSam Leffler * Write-arounds for common operations. 1018a1b9b6aSSam Leffler */ 1028a1b9b6aSSam Leffler static __inline void 1038a1b9b6aSSam Leffler cipher_detach(struct ieee80211_key *key) 1048a1b9b6aSSam Leffler { 1058a1b9b6aSSam Leffler key->wk_cipher->ic_detach(key); 1068a1b9b6aSSam Leffler } 1078a1b9b6aSSam Leffler 1088a1b9b6aSSam Leffler static __inline void * 109b032f27cSSam Leffler cipher_attach(struct ieee80211vap *vap, struct ieee80211_key *key) 1108a1b9b6aSSam Leffler { 111b032f27cSSam Leffler return key->wk_cipher->ic_attach(vap, key); 1128a1b9b6aSSam Leffler } 1138a1b9b6aSSam Leffler 1148a1b9b6aSSam Leffler /* 1158a1b9b6aSSam Leffler * Wrappers for driver key management methods. 1168a1b9b6aSSam Leffler */ 1178a1b9b6aSSam Leffler static __inline int 118b032f27cSSam Leffler dev_key_alloc(struct ieee80211vap *vap, 119e6e547d5SSam Leffler struct ieee80211_key *key, 120c1225b52SSam Leffler ieee80211_keyix *keyix, ieee80211_keyix *rxkeyix) 1218a1b9b6aSSam Leffler { 122b032f27cSSam Leffler return vap->iv_key_alloc(vap, key, keyix, rxkeyix); 1238a1b9b6aSSam Leffler } 1248a1b9b6aSSam Leffler 1258a1b9b6aSSam Leffler static __inline int 126b032f27cSSam Leffler dev_key_delete(struct ieee80211vap *vap, 1278a1b9b6aSSam Leffler const struct ieee80211_key *key) 1288a1b9b6aSSam Leffler { 129b032f27cSSam Leffler return vap->iv_key_delete(vap, key); 1308a1b9b6aSSam Leffler } 1318a1b9b6aSSam Leffler 1328a1b9b6aSSam Leffler static __inline int 13371fe06caSSam Leffler dev_key_set(struct ieee80211vap *vap, const struct ieee80211_key *key) 1348a1b9b6aSSam Leffler { 13571fe06caSSam Leffler return vap->iv_key_set(vap, key, key->wk_macaddr); 1368a1b9b6aSSam Leffler } 1371a1e1d21SSam Leffler 1381a1e1d21SSam Leffler /* 139b032f27cSSam Leffler * Setup crypto support for a device/shared instance. 1401a1e1d21SSam Leffler */ 1411a1e1d21SSam Leffler void 1428a1b9b6aSSam Leffler ieee80211_crypto_attach(struct ieee80211com *ic) 1431a1e1d21SSam Leffler { 1448a1b9b6aSSam Leffler /* NB: we assume everything is pre-zero'd */ 1458a1b9b6aSSam Leffler ciphers[IEEE80211_CIPHER_NONE] = &ieee80211_cipher_none; 1461a1e1d21SSam Leffler } 1471a1e1d21SSam Leffler 1488a1b9b6aSSam Leffler /* 1498a1b9b6aSSam Leffler * Teardown crypto support. 1508a1b9b6aSSam Leffler */ 1518a1b9b6aSSam Leffler void 1528a1b9b6aSSam Leffler ieee80211_crypto_detach(struct ieee80211com *ic) 1538a1b9b6aSSam Leffler { 154b032f27cSSam Leffler } 155b032f27cSSam Leffler 156b032f27cSSam Leffler /* 157b032f27cSSam Leffler * Setup crypto support for a vap. 158b032f27cSSam Leffler */ 159b032f27cSSam Leffler void 160b032f27cSSam Leffler ieee80211_crypto_vattach(struct ieee80211vap *vap) 161b032f27cSSam Leffler { 162b032f27cSSam Leffler int i; 163b032f27cSSam Leffler 164b032f27cSSam Leffler /* NB: we assume everything is pre-zero'd */ 165b032f27cSSam Leffler vap->iv_max_keyix = IEEE80211_WEP_NKID; 166b032f27cSSam Leffler vap->iv_def_txkey = IEEE80211_KEYIX_NONE; 167b032f27cSSam Leffler for (i = 0; i < IEEE80211_WEP_NKID; i++) 168b032f27cSSam Leffler ieee80211_crypto_resetkey(vap, &vap->iv_nw_keys[i], 169b032f27cSSam Leffler IEEE80211_KEYIX_NONE); 170b032f27cSSam Leffler /* 171b032f27cSSam Leffler * Initialize the driver key support routines to noop entries. 172b032f27cSSam Leffler * This is useful especially for the cipher test modules. 173b032f27cSSam Leffler */ 174b032f27cSSam Leffler vap->iv_key_alloc = null_key_alloc; 175b032f27cSSam Leffler vap->iv_key_set = null_key_set; 176b032f27cSSam Leffler vap->iv_key_delete = null_key_delete; 177b032f27cSSam Leffler vap->iv_key_update_begin = null_key_update; 178b032f27cSSam Leffler vap->iv_key_update_end = null_key_update; 179b032f27cSSam Leffler } 180b032f27cSSam Leffler 181b032f27cSSam Leffler /* 182b032f27cSSam Leffler * Teardown crypto support for a vap. 183b032f27cSSam Leffler */ 184b032f27cSSam Leffler void 185b032f27cSSam Leffler ieee80211_crypto_vdetach(struct ieee80211vap *vap) 186b032f27cSSam Leffler { 187b032f27cSSam Leffler ieee80211_crypto_delglobalkeys(vap); 1881a1e1d21SSam Leffler } 1891a1e1d21SSam Leffler 1908a1b9b6aSSam Leffler /* 1918a1b9b6aSSam Leffler * Register a crypto cipher module. 1928a1b9b6aSSam Leffler */ 1938a1b9b6aSSam Leffler void 1948a1b9b6aSSam Leffler ieee80211_crypto_register(const struct ieee80211_cipher *cip) 1958a1b9b6aSSam Leffler { 1968a1b9b6aSSam Leffler if (cip->ic_cipher >= IEEE80211_CIPHER_MAX) { 1978a1b9b6aSSam Leffler printf("%s: cipher %s has an invalid cipher index %u\n", 1988a1b9b6aSSam Leffler __func__, cip->ic_name, cip->ic_cipher); 1998a1b9b6aSSam Leffler return; 2008a1b9b6aSSam Leffler } 2018a1b9b6aSSam Leffler if (ciphers[cip->ic_cipher] != NULL && ciphers[cip->ic_cipher] != cip) { 2028a1b9b6aSSam Leffler printf("%s: cipher %s registered with a different template\n", 2038a1b9b6aSSam Leffler __func__, cip->ic_name); 2048a1b9b6aSSam Leffler return; 2058a1b9b6aSSam Leffler } 2068a1b9b6aSSam Leffler ciphers[cip->ic_cipher] = cip; 2078a1b9b6aSSam Leffler } 2088a1b9b6aSSam Leffler 2098a1b9b6aSSam Leffler /* 2108a1b9b6aSSam Leffler * Unregister a crypto cipher module. 2118a1b9b6aSSam Leffler */ 2128a1b9b6aSSam Leffler void 2138a1b9b6aSSam Leffler ieee80211_crypto_unregister(const struct ieee80211_cipher *cip) 2148a1b9b6aSSam Leffler { 2158a1b9b6aSSam Leffler if (cip->ic_cipher >= IEEE80211_CIPHER_MAX) { 2168a1b9b6aSSam Leffler printf("%s: cipher %s has an invalid cipher index %u\n", 2178a1b9b6aSSam Leffler __func__, cip->ic_name, cip->ic_cipher); 2188a1b9b6aSSam Leffler return; 2198a1b9b6aSSam Leffler } 2208a1b9b6aSSam Leffler if (ciphers[cip->ic_cipher] != NULL && ciphers[cip->ic_cipher] != cip) { 2218a1b9b6aSSam Leffler printf("%s: cipher %s registered with a different template\n", 2228a1b9b6aSSam Leffler __func__, cip->ic_name); 2238a1b9b6aSSam Leffler return; 2248a1b9b6aSSam Leffler } 2258a1b9b6aSSam Leffler /* NB: don't complain about not being registered */ 2268a1b9b6aSSam Leffler /* XXX disallow if references */ 2278a1b9b6aSSam Leffler ciphers[cip->ic_cipher] = NULL; 2288a1b9b6aSSam Leffler } 2298a1b9b6aSSam Leffler 2308a1b9b6aSSam Leffler int 2318a1b9b6aSSam Leffler ieee80211_crypto_available(u_int cipher) 2328a1b9b6aSSam Leffler { 2338a1b9b6aSSam Leffler return cipher < IEEE80211_CIPHER_MAX && ciphers[cipher] != NULL; 2348a1b9b6aSSam Leffler } 2358a1b9b6aSSam Leffler 2368a1b9b6aSSam Leffler /* XXX well-known names! */ 237b032f27cSSam Leffler static const char *cipher_modnames[IEEE80211_CIPHER_MAX] = { 2388a1b9b6aSSam Leffler "wlan_wep", /* IEEE80211_CIPHER_WEP */ 2398a1b9b6aSSam Leffler "wlan_tkip", /* IEEE80211_CIPHER_TKIP */ 2408a1b9b6aSSam Leffler "wlan_aes_ocb", /* IEEE80211_CIPHER_AES_OCB */ 2418a1b9b6aSSam Leffler "wlan_ccmp", /* IEEE80211_CIPHER_AES_CCM */ 242b032f27cSSam Leffler "#4", /* reserved */ 2438a1b9b6aSSam Leffler "wlan_ckip", /* IEEE80211_CIPHER_CKIP */ 244b032f27cSSam Leffler "wlan_none", /* IEEE80211_CIPHER_NONE */ 2458a1b9b6aSSam Leffler }; 2468a1b9b6aSSam Leffler 2478a1b9b6aSSam Leffler /* 2488a1b9b6aSSam Leffler * Establish a relationship between the specified key and cipher 249dd70e17bSSam Leffler * and, if necessary, allocate a hardware index from the driver. 250dd70e17bSSam Leffler * Note that when a fixed key index is required it must be specified 251dd70e17bSSam Leffler * and we blindly assign it w/o consulting the driver (XXX). 2528a1b9b6aSSam Leffler * 2538a1b9b6aSSam Leffler * This must be the first call applied to a key; all the other key 2548a1b9b6aSSam Leffler * routines assume wk_cipher is setup. 2558a1b9b6aSSam Leffler * 2568a1b9b6aSSam Leffler * Locking must be handled by the caller using: 257b032f27cSSam Leffler * ieee80211_key_update_begin(vap); 258b032f27cSSam Leffler * ieee80211_key_update_end(vap); 2598a1b9b6aSSam Leffler */ 2608a1b9b6aSSam Leffler int 261b032f27cSSam Leffler ieee80211_crypto_newkey(struct ieee80211vap *vap, 262dd70e17bSSam Leffler int cipher, int flags, struct ieee80211_key *key) 2638a1b9b6aSSam Leffler { 264b032f27cSSam Leffler struct ieee80211com *ic = vap->iv_ic; 2658a1b9b6aSSam Leffler const struct ieee80211_cipher *cip; 266c1225b52SSam Leffler ieee80211_keyix keyix, rxkeyix; 2678a1b9b6aSSam Leffler void *keyctx; 2688a1b9b6aSSam Leffler int oflags; 2698a1b9b6aSSam Leffler 2708a1b9b6aSSam Leffler /* 2718a1b9b6aSSam Leffler * Validate cipher and set reference to cipher routines. 2728a1b9b6aSSam Leffler */ 2738a1b9b6aSSam Leffler if (cipher >= IEEE80211_CIPHER_MAX) { 274b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 2758a1b9b6aSSam Leffler "%s: invalid cipher %u\n", __func__, cipher); 276b032f27cSSam Leffler vap->iv_stats.is_crypto_badcipher++; 2778a1b9b6aSSam Leffler return 0; 2788a1b9b6aSSam Leffler } 2798a1b9b6aSSam Leffler cip = ciphers[cipher]; 2808a1b9b6aSSam Leffler if (cip == NULL) { 2818a1b9b6aSSam Leffler /* 2828a1b9b6aSSam Leffler * Auto-load cipher module if we have a well-known name 2838a1b9b6aSSam Leffler * for it. It might be better to use string names rather 2848a1b9b6aSSam Leffler * than numbers and craft a module name based on the cipher 2858a1b9b6aSSam Leffler * name; e.g. wlan_cipher_<cipher-name>. 2868a1b9b6aSSam Leffler */ 287b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 2888a1b9b6aSSam Leffler "%s: unregistered cipher %u, load module %s\n", 2898a1b9b6aSSam Leffler __func__, cipher, cipher_modnames[cipher]); 2908a1b9b6aSSam Leffler ieee80211_load_module(cipher_modnames[cipher]); 2918a1b9b6aSSam Leffler /* 2928a1b9b6aSSam Leffler * If cipher module loaded it should immediately 2938a1b9b6aSSam Leffler * call ieee80211_crypto_register which will fill 2948a1b9b6aSSam Leffler * in the entry in the ciphers array. 2958a1b9b6aSSam Leffler */ 2968a1b9b6aSSam Leffler cip = ciphers[cipher]; 2978a1b9b6aSSam Leffler if (cip == NULL) { 298b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 2998a1b9b6aSSam Leffler "%s: unable to load cipher %u, module %s\n", 300b032f27cSSam Leffler __func__, cipher, cipher_modnames[cipher]); 301b032f27cSSam Leffler vap->iv_stats.is_crypto_nocipher++; 3028a1b9b6aSSam Leffler return 0; 3038a1b9b6aSSam Leffler } 3048a1b9b6aSSam Leffler } 3058a1b9b6aSSam Leffler 3068a1b9b6aSSam Leffler oflags = key->wk_flags; 307dd70e17bSSam Leffler flags &= IEEE80211_KEY_COMMON; 3088a1b9b6aSSam Leffler /* 3098a1b9b6aSSam Leffler * If the hardware does not support the cipher then 3108a1b9b6aSSam Leffler * fallback to a host-based implementation. 3118a1b9b6aSSam Leffler */ 312b032f27cSSam Leffler if ((ic->ic_cryptocaps & (1<<cipher)) == 0) { 313b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 3148a1b9b6aSSam Leffler "%s: no h/w support for cipher %s, falling back to s/w\n", 3158a1b9b6aSSam Leffler __func__, cip->ic_name); 316dd70e17bSSam Leffler flags |= IEEE80211_KEY_SWCRYPT; 3178a1b9b6aSSam Leffler } 3188a1b9b6aSSam Leffler /* 3198a1b9b6aSSam Leffler * Hardware TKIP with software MIC is an important 3208a1b9b6aSSam Leffler * combination; we handle it by flagging each key, 3218a1b9b6aSSam Leffler * the cipher modules honor it. 3228a1b9b6aSSam Leffler */ 3238a1b9b6aSSam Leffler if (cipher == IEEE80211_CIPHER_TKIP && 324b032f27cSSam Leffler (ic->ic_cryptocaps & IEEE80211_CRYPTO_TKIPMIC) == 0) { 325b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 3268a1b9b6aSSam Leffler "%s: no h/w support for TKIP MIC, falling back to s/w\n", 3278a1b9b6aSSam Leffler __func__); 328dd70e17bSSam Leffler flags |= IEEE80211_KEY_SWMIC; 3298a1b9b6aSSam Leffler } 3308a1b9b6aSSam Leffler 3318a1b9b6aSSam Leffler /* 3328a1b9b6aSSam Leffler * Bind cipher to key instance. Note we do this 3338a1b9b6aSSam Leffler * after checking the device capabilities so the 3348a1b9b6aSSam Leffler * cipher module can optimize space usage based on 3358a1b9b6aSSam Leffler * whether or not it needs to do the cipher work. 3368a1b9b6aSSam Leffler */ 337dd70e17bSSam Leffler if (key->wk_cipher != cip || key->wk_flags != flags) { 338dd70e17bSSam Leffler /* 339dd70e17bSSam Leffler * Fillin the flags so cipher modules can see s/w 340dd70e17bSSam Leffler * crypto requirements and potentially allocate 341dd70e17bSSam Leffler * different state and/or attach different method 342dd70e17bSSam Leffler * pointers. 343dd70e17bSSam Leffler */ 344dd70e17bSSam Leffler key->wk_flags = flags; 345b032f27cSSam Leffler keyctx = cip->ic_attach(vap, key); 3468a1b9b6aSSam Leffler if (keyctx == NULL) { 347b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 3488a1b9b6aSSam Leffler "%s: unable to attach cipher %s\n", 3498a1b9b6aSSam Leffler __func__, cip->ic_name); 3508a1b9b6aSSam Leffler key->wk_flags = oflags; /* restore old flags */ 351b032f27cSSam Leffler vap->iv_stats.is_crypto_attachfail++; 3528a1b9b6aSSam Leffler return 0; 3538a1b9b6aSSam Leffler } 3548a1b9b6aSSam Leffler cipher_detach(key); 3558a1b9b6aSSam Leffler key->wk_cipher = cip; /* XXX refcnt? */ 3568a1b9b6aSSam Leffler key->wk_private = keyctx; 3578a1b9b6aSSam Leffler } 358dd70e17bSSam Leffler /* 359dd70e17bSSam Leffler * Commit to requested usage so driver can see the flags. 360dd70e17bSSam Leffler */ 361dd70e17bSSam Leffler key->wk_flags = flags; 3628a1b9b6aSSam Leffler 3638a1b9b6aSSam Leffler /* 3648a1b9b6aSSam Leffler * Ask the driver for a key index if we don't have one. 3658a1b9b6aSSam Leffler * Note that entries in the global key table always have 3668a1b9b6aSSam Leffler * an index; this means it's safe to call this routine 3678a1b9b6aSSam Leffler * for these entries just to setup the reference to the 3688a1b9b6aSSam Leffler * cipher template. Note also that when using software 3698a1b9b6aSSam Leffler * crypto we also call the driver to give us a key index. 3708a1b9b6aSSam Leffler */ 371e6e547d5SSam Leffler if ((key->wk_flags & IEEE80211_KEY_DEVKEY) == 0) { 372b032f27cSSam Leffler if (!dev_key_alloc(vap, key, &keyix, &rxkeyix)) { 3738a1b9b6aSSam Leffler /* 374e6e547d5SSam Leffler * Unable to setup driver state. 3758a1b9b6aSSam Leffler */ 376b032f27cSSam Leffler vap->iv_stats.is_crypto_keyfail++; 377b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 3788a1b9b6aSSam Leffler "%s: unable to setup cipher %s\n", 3798a1b9b6aSSam Leffler __func__, cip->ic_name); 3808a1b9b6aSSam Leffler return 0; 3818a1b9b6aSSam Leffler } 382e6e547d5SSam Leffler if (key->wk_flags != flags) { 383e6e547d5SSam Leffler /* 384e6e547d5SSam Leffler * Driver overrode flags we setup; typically because 385e6e547d5SSam Leffler * resources were unavailable to handle _this_ key. 386e6e547d5SSam Leffler * Re-attach the cipher context to allow cipher 387e6e547d5SSam Leffler * modules to handle differing requirements. 388e6e547d5SSam Leffler */ 389e6e547d5SSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 390e6e547d5SSam Leffler "%s: driver override for cipher %s, flags " 391e6e547d5SSam Leffler "0x%x -> 0x%x\n", __func__, cip->ic_name, 392e6e547d5SSam Leffler oflags, key->wk_flags); 393e6e547d5SSam Leffler keyctx = cip->ic_attach(vap, key); 394e6e547d5SSam Leffler if (keyctx == NULL) { 395e6e547d5SSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 396e6e547d5SSam Leffler "%s: unable to attach cipher %s with " 397e6e547d5SSam Leffler "flags 0x%x\n", __func__, cip->ic_name, 398e6e547d5SSam Leffler key->wk_flags); 399e6e547d5SSam Leffler key->wk_flags = oflags; /* restore old flags */ 400e6e547d5SSam Leffler vap->iv_stats.is_crypto_attachfail++; 401e6e547d5SSam Leffler return 0; 402e6e547d5SSam Leffler } 403e6e547d5SSam Leffler cipher_detach(key); 404e6e547d5SSam Leffler key->wk_cipher = cip; /* XXX refcnt? */ 405e6e547d5SSam Leffler key->wk_private = keyctx; 406e6e547d5SSam Leffler } 407c1225b52SSam Leffler key->wk_keyix = keyix; 408c1225b52SSam Leffler key->wk_rxkeyix = rxkeyix; 409e6e547d5SSam Leffler key->wk_flags |= IEEE80211_KEY_DEVKEY; 4108a1b9b6aSSam Leffler } 4118a1b9b6aSSam Leffler return 1; 4128a1b9b6aSSam Leffler } 4138a1b9b6aSSam Leffler 4148a1b9b6aSSam Leffler /* 4158a1b9b6aSSam Leffler * Remove the key (no locking, for internal use). 4168a1b9b6aSSam Leffler */ 4178a1b9b6aSSam Leffler static int 418b032f27cSSam Leffler _ieee80211_crypto_delkey(struct ieee80211vap *vap, struct ieee80211_key *key) 4198a1b9b6aSSam Leffler { 4208a1b9b6aSSam Leffler KASSERT(key->wk_cipher != NULL, ("No cipher!")); 4218a1b9b6aSSam Leffler 422b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 423fc508e8eSSam Leffler "%s: %s keyix %u flags 0x%x rsc %ju tsc %ju len %u\n", 424fc508e8eSSam Leffler __func__, key->wk_cipher->ic_name, 425fc508e8eSSam Leffler key->wk_keyix, key->wk_flags, 426b032f27cSSam Leffler key->wk_keyrsc[IEEE80211_NONQOS_TID], key->wk_keytsc, 427b032f27cSSam Leffler key->wk_keylen); 428fc508e8eSSam Leffler 429e6e547d5SSam Leffler if (key->wk_flags & IEEE80211_KEY_DEVKEY) { 4308a1b9b6aSSam Leffler /* 4318a1b9b6aSSam Leffler * Remove hardware entry. 4328a1b9b6aSSam Leffler */ 4338a1b9b6aSSam Leffler /* XXX key cache */ 434b032f27cSSam Leffler if (!dev_key_delete(vap, key)) { 435b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 4368a1b9b6aSSam Leffler "%s: driver did not delete key index %u\n", 437e6e547d5SSam Leffler __func__, key->wk_keyix); 438b032f27cSSam Leffler vap->iv_stats.is_crypto_delkey++; 4398a1b9b6aSSam Leffler /* XXX recovery? */ 4408a1b9b6aSSam Leffler } 4418a1b9b6aSSam Leffler } 4428a1b9b6aSSam Leffler cipher_detach(key); 4438a1b9b6aSSam Leffler memset(key, 0, sizeof(*key)); 444b032f27cSSam Leffler ieee80211_crypto_resetkey(vap, key, IEEE80211_KEYIX_NONE); 4458a1b9b6aSSam Leffler return 1; 4468a1b9b6aSSam Leffler } 4478a1b9b6aSSam Leffler 4488a1b9b6aSSam Leffler /* 4498a1b9b6aSSam Leffler * Remove the specified key. 4508a1b9b6aSSam Leffler */ 4518a1b9b6aSSam Leffler int 452b032f27cSSam Leffler ieee80211_crypto_delkey(struct ieee80211vap *vap, struct ieee80211_key *key) 4538a1b9b6aSSam Leffler { 4548a1b9b6aSSam Leffler int status; 4558a1b9b6aSSam Leffler 456b032f27cSSam Leffler ieee80211_key_update_begin(vap); 457b032f27cSSam Leffler status = _ieee80211_crypto_delkey(vap, key); 458b032f27cSSam Leffler ieee80211_key_update_end(vap); 4598a1b9b6aSSam Leffler return status; 4608a1b9b6aSSam Leffler } 4618a1b9b6aSSam Leffler 4628a1b9b6aSSam Leffler /* 4638a1b9b6aSSam Leffler * Clear the global key table. 4648a1b9b6aSSam Leffler */ 4658a1b9b6aSSam Leffler void 466b032f27cSSam Leffler ieee80211_crypto_delglobalkeys(struct ieee80211vap *vap) 4678a1b9b6aSSam Leffler { 4688a1b9b6aSSam Leffler int i; 4698a1b9b6aSSam Leffler 470b032f27cSSam Leffler ieee80211_key_update_begin(vap); 4718a1b9b6aSSam Leffler for (i = 0; i < IEEE80211_WEP_NKID; i++) 472b032f27cSSam Leffler (void) _ieee80211_crypto_delkey(vap, &vap->iv_nw_keys[i]); 473b032f27cSSam Leffler ieee80211_key_update_end(vap); 4748a1b9b6aSSam Leffler } 4758a1b9b6aSSam Leffler 4768a1b9b6aSSam Leffler /* 4778a1b9b6aSSam Leffler * Set the contents of the specified key. 4788a1b9b6aSSam Leffler * 4798a1b9b6aSSam Leffler * Locking must be handled by the caller using: 480b032f27cSSam Leffler * ieee80211_key_update_begin(vap); 481b032f27cSSam Leffler * ieee80211_key_update_end(vap); 4828a1b9b6aSSam Leffler */ 4838a1b9b6aSSam Leffler int 48471fe06caSSam Leffler ieee80211_crypto_setkey(struct ieee80211vap *vap, struct ieee80211_key *key) 4858a1b9b6aSSam Leffler { 4868a1b9b6aSSam Leffler const struct ieee80211_cipher *cip = key->wk_cipher; 4878a1b9b6aSSam Leffler 4888a1b9b6aSSam Leffler KASSERT(cip != NULL, ("No cipher!")); 4898a1b9b6aSSam Leffler 490b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 491fc508e8eSSam Leffler "%s: %s keyix %u flags 0x%x mac %s rsc %ju tsc %ju len %u\n", 492fc508e8eSSam Leffler __func__, cip->ic_name, key->wk_keyix, 49371fe06caSSam Leffler key->wk_flags, ether_sprintf(key->wk_macaddr), 494b032f27cSSam Leffler key->wk_keyrsc[IEEE80211_NONQOS_TID], key->wk_keytsc, 495b032f27cSSam Leffler key->wk_keylen); 496fc508e8eSSam Leffler 497e6e547d5SSam Leffler if ((key->wk_flags & IEEE80211_KEY_DEVKEY) == 0) { 498e6e547d5SSam Leffler /* XXX nothing allocated, should not happen */ 499e6e547d5SSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 500e6e547d5SSam Leffler "%s: no device key setup done; should not happen!\n", 501e6e547d5SSam Leffler __func__); 502e6e547d5SSam Leffler vap->iv_stats.is_crypto_setkey_nokey++; 503e6e547d5SSam Leffler return 0; 504e6e547d5SSam Leffler } 5058a1b9b6aSSam Leffler /* 5068a1b9b6aSSam Leffler * Give cipher a chance to validate key contents. 5078a1b9b6aSSam Leffler * XXX should happen before modifying state. 5088a1b9b6aSSam Leffler */ 5098a1b9b6aSSam Leffler if (!cip->ic_setkey(key)) { 510b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO, 5118a1b9b6aSSam Leffler "%s: cipher %s rejected key index %u len %u flags 0x%x\n", 5128a1b9b6aSSam Leffler __func__, cip->ic_name, key->wk_keyix, 5138a1b9b6aSSam Leffler key->wk_keylen, key->wk_flags); 514b032f27cSSam Leffler vap->iv_stats.is_crypto_setkey_cipher++; 5158a1b9b6aSSam Leffler return 0; 5168a1b9b6aSSam Leffler } 51771fe06caSSam Leffler return dev_key_set(vap, key); 5188a1b9b6aSSam Leffler } 5198a1b9b6aSSam Leffler 5208a1b9b6aSSam Leffler /* 5218a1b9b6aSSam Leffler * Add privacy headers appropriate for the specified key. 5228a1b9b6aSSam Leffler */ 5238a1b9b6aSSam Leffler struct ieee80211_key * 524b032f27cSSam Leffler ieee80211_crypto_encap(struct ieee80211_node *ni, struct mbuf *m) 5258a1b9b6aSSam Leffler { 526b032f27cSSam Leffler struct ieee80211vap *vap = ni->ni_vap; 5278a1b9b6aSSam Leffler struct ieee80211_key *k; 5288a1b9b6aSSam Leffler struct ieee80211_frame *wh; 5298a1b9b6aSSam Leffler const struct ieee80211_cipher *cip; 53068e8e04eSSam Leffler uint8_t keyid; 5318a1b9b6aSSam Leffler 5328a1b9b6aSSam Leffler /* 5338a1b9b6aSSam Leffler * Multicast traffic always uses the multicast key. 5348a1b9b6aSSam Leffler * Otherwise if a unicast key is set we use that and 5358a1b9b6aSSam Leffler * it is always key index 0. When no unicast key is 5368a1b9b6aSSam Leffler * set we fall back to the default transmit key. 5378a1b9b6aSSam Leffler */ 5388a1b9b6aSSam Leffler wh = mtod(m, struct ieee80211_frame *); 5398a1b9b6aSSam Leffler if (IEEE80211_IS_MULTICAST(wh->i_addr1) || 540cda15ce1SSam Leffler IEEE80211_KEY_UNDEFINED(&ni->ni_ucastkey)) { 541b032f27cSSam Leffler if (vap->iv_def_txkey == IEEE80211_KEYIX_NONE) { 542b032f27cSSam Leffler IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_CRYPTO, 543b032f27cSSam Leffler wh->i_addr1, 544b032f27cSSam Leffler "no default transmit key (%s) deftxkey %u", 545b032f27cSSam Leffler __func__, vap->iv_def_txkey); 546b032f27cSSam Leffler vap->iv_stats.is_tx_nodefkey++; 5478a1b9b6aSSam Leffler return NULL; 5488a1b9b6aSSam Leffler } 549b032f27cSSam Leffler keyid = vap->iv_def_txkey; 550b032f27cSSam Leffler k = &vap->iv_nw_keys[vap->iv_def_txkey]; 5518a1b9b6aSSam Leffler } else { 552dd70e17bSSam Leffler keyid = 0; 5538a1b9b6aSSam Leffler k = &ni->ni_ucastkey; 5548a1b9b6aSSam Leffler } 5558a1b9b6aSSam Leffler cip = k->wk_cipher; 556dd70e17bSSam Leffler return (cip->ic_encap(k, m, keyid<<6) ? k : NULL); 5578a1b9b6aSSam Leffler } 5588a1b9b6aSSam Leffler 5598a1b9b6aSSam Leffler /* 5608a1b9b6aSSam Leffler * Validate and strip privacy headers (and trailer) for a 5618a1b9b6aSSam Leffler * received frame that has the WEP/Privacy bit set. 5628a1b9b6aSSam Leffler */ 5638a1b9b6aSSam Leffler struct ieee80211_key * 564b032f27cSSam Leffler ieee80211_crypto_decap(struct ieee80211_node *ni, struct mbuf *m, int hdrlen) 5658a1b9b6aSSam Leffler { 5668a1b9b6aSSam Leffler #define IEEE80211_WEP_HDRLEN (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN) 5678a1b9b6aSSam Leffler #define IEEE80211_WEP_MINLEN \ 568a92c6eb0SSam Leffler (sizeof(struct ieee80211_frame) + \ 5698a1b9b6aSSam Leffler IEEE80211_WEP_HDRLEN + IEEE80211_WEP_CRCLEN) 570b032f27cSSam Leffler struct ieee80211vap *vap = ni->ni_vap; 5718a1b9b6aSSam Leffler struct ieee80211_key *k; 5728a1b9b6aSSam Leffler struct ieee80211_frame *wh; 5738a1b9b6aSSam Leffler const struct ieee80211_cipher *cip; 57468e8e04eSSam Leffler uint8_t keyid; 5758a1b9b6aSSam Leffler 5768a1b9b6aSSam Leffler /* NB: this minimum size data frame could be bigger */ 5778a1b9b6aSSam Leffler if (m->m_pkthdr.len < IEEE80211_WEP_MINLEN) { 578b032f27cSSam Leffler IEEE80211_DPRINTF(vap, IEEE80211_MSG_ANY, 5798a1b9b6aSSam Leffler "%s: WEP data frame too short, len %u\n", 5808a1b9b6aSSam Leffler __func__, m->m_pkthdr.len); 581b032f27cSSam Leffler vap->iv_stats.is_rx_tooshort++; /* XXX need unique stat? */ 5821a1e1d21SSam Leffler return NULL; 5831a1e1d21SSam Leffler } 5841a1e1d21SSam Leffler 5851a1e1d21SSam Leffler /* 5868a1b9b6aSSam Leffler * Locate the key. If unicast and there is no unicast 5878a1b9b6aSSam Leffler * key then we fall back to the key id in the header. 5888a1b9b6aSSam Leffler * This assumes unicast keys are only configured when 5898a1b9b6aSSam Leffler * the key id in the header is meaningless (typically 0). 5901a1e1d21SSam Leffler */ 5918a1b9b6aSSam Leffler wh = mtod(m, struct ieee80211_frame *); 592b032f27cSSam Leffler m_copydata(m, hdrlen + IEEE80211_WEP_IVLEN, sizeof(keyid), &keyid); 5938a1b9b6aSSam Leffler if (IEEE80211_IS_MULTICAST(wh->i_addr1) || 594cda15ce1SSam Leffler IEEE80211_KEY_UNDEFINED(&ni->ni_ucastkey)) 595b032f27cSSam Leffler k = &vap->iv_nw_keys[keyid >> 6]; 5961a1e1d21SSam Leffler else 5978a1b9b6aSSam Leffler k = &ni->ni_ucastkey; 5981a1e1d21SSam Leffler 5991a1e1d21SSam Leffler /* 6008a1b9b6aSSam Leffler * Insure crypto header is contiguous for all decap work. 6011a1e1d21SSam Leffler */ 6028a1b9b6aSSam Leffler cip = k->wk_cipher; 6038a1b9b6aSSam Leffler if (m->m_len < hdrlen + cip->ic_header && 6048a1b9b6aSSam Leffler (m = m_pullup(m, hdrlen + cip->ic_header)) == NULL) { 605b032f27cSSam Leffler IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_CRYPTO, wh->i_addr2, 606b032f27cSSam Leffler "unable to pullup %s header", cip->ic_name); 607b032f27cSSam Leffler vap->iv_stats.is_rx_wepfail++; /* XXX */ 60868e8e04eSSam Leffler return NULL; 6098a1b9b6aSSam Leffler } 6101a1e1d21SSam Leffler 6112cc12adeSSam Leffler return (cip->ic_decap(k, m, hdrlen) ? k : NULL); 6128a1b9b6aSSam Leffler #undef IEEE80211_WEP_MINLEN 6138a1b9b6aSSam Leffler #undef IEEE80211_WEP_HDRLEN 6141a1e1d21SSam Leffler } 61506b2d888SSam Leffler 61606b2d888SSam Leffler static void 61706b2d888SSam Leffler load_ucastkey(void *arg, struct ieee80211_node *ni) 61806b2d888SSam Leffler { 61906b2d888SSam Leffler struct ieee80211vap *vap = ni->ni_vap; 62006b2d888SSam Leffler struct ieee80211_key *k; 62106b2d888SSam Leffler 62206b2d888SSam Leffler if (vap->iv_state != IEEE80211_S_RUN) 62306b2d888SSam Leffler return; 62406b2d888SSam Leffler k = &ni->ni_ucastkey; 625e6e547d5SSam Leffler if (k->wk_flags & IEEE80211_KEY_DEVKEY) 62606b2d888SSam Leffler dev_key_set(vap, k); 62706b2d888SSam Leffler } 62806b2d888SSam Leffler 62906b2d888SSam Leffler /* 63006b2d888SSam Leffler * Re-load all keys known to the 802.11 layer that may 63106b2d888SSam Leffler * have hardware state backing them. This is used by 63206b2d888SSam Leffler * drivers on resume to push keys down into the device. 63306b2d888SSam Leffler */ 63406b2d888SSam Leffler void 63506b2d888SSam Leffler ieee80211_crypto_reload_keys(struct ieee80211com *ic) 63606b2d888SSam Leffler { 63706b2d888SSam Leffler struct ieee80211vap *vap; 63806b2d888SSam Leffler int i; 63906b2d888SSam Leffler 64006b2d888SSam Leffler /* 64106b2d888SSam Leffler * Keys in the global key table of each vap. 64206b2d888SSam Leffler */ 64306b2d888SSam Leffler /* NB: used only during resume so don't lock for now */ 64406b2d888SSam Leffler TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) { 64506b2d888SSam Leffler if (vap->iv_state != IEEE80211_S_RUN) 64606b2d888SSam Leffler continue; 64706b2d888SSam Leffler for (i = 0; i < IEEE80211_WEP_NKID; i++) { 64806b2d888SSam Leffler const struct ieee80211_key *k = &vap->iv_nw_keys[i]; 649e6e547d5SSam Leffler if (k->wk_flags & IEEE80211_KEY_DEVKEY) 65006b2d888SSam Leffler dev_key_set(vap, k); 65106b2d888SSam Leffler } 65206b2d888SSam Leffler } 65306b2d888SSam Leffler /* 65406b2d888SSam Leffler * Unicast keys. 65506b2d888SSam Leffler */ 65606b2d888SSam Leffler ieee80211_iterate_nodes(&ic->ic_sta, load_ucastkey, NULL); 65706b2d888SSam Leffler } 658