sys/net80211/ieee80211_crypto.c

   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
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 /*
  31  * IEEE 802.11 generic crypto support.
  32  */
  33 #include "opt_wlan.h"
  34
  35 #include <sys/param.h>
  36 #include <sys/kernel.h>
  37 #include <sys/malloc.h>
  38 #include <sys/mbuf.h>
  39
  40 #include <sys/socket.h>
  41
  42 #include <net/if.h>
  43 #include <net/if_media.h>
  44 #include <net/ethernet.h>               /* XXX ETHER_HDR_LEN */
  45
  46 #include <net80211/ieee80211_var.h>
  47
  48 MALLOC_DEFINE(M_80211_CRYPTO, "80211crypto", "802.11 crypto state");
  49
  50 static  int _ieee80211_crypto_delkey(struct ieee80211vap *,
  51                 struct ieee80211_key *);
  52
  53 /*
  54  * Table of registered cipher modules.
  55  */
  56 static  const struct ieee80211_cipher *ciphers[IEEE80211_CIPHER_MAX];
  57
  58 /*
  59  * Default "null" key management routines.
  60  */
  61 static int
  62 null_key_alloc(struct ieee80211vap *vap, struct ieee80211_key *k,
  63         ieee80211_keyix *keyix, ieee80211_keyix *rxkeyix)
  64 {
  65         if (!(&vap->iv_nw_keys[0] <= k &&
  66              k < &vap->iv_nw_keys[IEEE80211_WEP_NKID])) {
  67                 /*
  68                  * Not in the global key table, the driver should handle this
  69                  * by allocating a slot in the h/w key table/cache.  In
  70                  * lieu of that return key slot 0 for any unicast key
  71                  * request.  We disallow the request if this is a group key.
  72                  * This default policy does the right thing for legacy hardware
  73                  * with a 4 key table.  It also handles devices that pass
  74                  * packets through untouched when marked with the WEP bit
  75                  * and key index 0.
  76                  */
  77                 if (k->wk_flags & IEEE80211_KEY_GROUP)
  78                         return 0;
  79                 *keyix = 0;     /* NB: use key index 0 for ucast key */
  80         } else {
  81                 *keyix = k - vap->iv_nw_keys;
  82         }
  83         *rxkeyix = IEEE80211_KEYIX_NONE;        /* XXX maybe *keyix? */
  84         return 1;
  85 }
  86 static int
  87 null_key_delete(struct ieee80211vap *vap, const struct ieee80211_key *k)
  88 {
  89         return 1;
  90 }
  91 static  int
  92 null_key_set(struct ieee80211vap *vap, const struct ieee80211_key *k,
  93         const uint8_t mac[IEEE80211_ADDR_LEN])
  94 {
  95         return 1;
  96 }
  97 static void null_key_update(struct ieee80211vap *vap) {}
  98
  99 /*
 100  * Write-arounds for common operations.
 101  */
 102 static __inline void
 103 cipher_detach(struct ieee80211_key *key)
 104 {
 105         key->wk_cipher->ic_detach(key);
 106 }
 107
 108 static __inline void *
 109 cipher_attach(struct ieee80211vap *vap, struct ieee80211_key *key)
 110 {
 111         return key->wk_cipher->ic_attach(vap, key);
 112 }
 113
 114 /*
 115  * Wrappers for driver key management methods.
 116  */
 117 static __inline int
 118 dev_key_alloc(struct ieee80211vap *vap,
 119         struct ieee80211_key *key,
 120         ieee80211_keyix *keyix, ieee80211_keyix *rxkeyix)
 121 {
 122         return vap->iv_key_alloc(vap, key, keyix, rxkeyix);
 123 }
 124
 125 static __inline int
 126 dev_key_delete(struct ieee80211vap *vap,
 127         const struct ieee80211_key *key)
 128 {
 129         return vap->iv_key_delete(vap, key);
 130 }
 131
 132 static __inline int
 133 dev_key_set(struct ieee80211vap *vap, const struct ieee80211_key *key)
 134 {
 135         return vap->iv_key_set(vap, key, key->wk_macaddr);
 136 }
 137
 138 /*
 139  * Setup crypto support for a device/shared instance.
 140  */
 141 void
 142 ieee80211_crypto_attach(struct ieee80211com *ic)
 143 {
 144         /* NB: we assume everything is pre-zero'd */
 145         ciphers[IEEE80211_CIPHER_NONE] = &ieee80211_cipher_none;
 146 }
 147
 148 /*
 149  * Teardown crypto support.
 150  */
 151 void
 152 ieee80211_crypto_detach(struct ieee80211com *ic)
 153 {
 154 }
 155
 156 /*
 157  * Setup crypto support for a vap.
 158  */
 159 void
 160 ieee80211_crypto_vattach(struct ieee80211vap *vap)
 161 {
 162         int i;
 163
 164         /* NB: we assume everything is pre-zero'd */
 165         vap->iv_max_keyix = IEEE80211_WEP_NKID;
 166         vap->iv_def_txkey = IEEE80211_KEYIX_NONE;
 167         for (i = 0; i < IEEE80211_WEP_NKID; i++)
 168                 ieee80211_crypto_resetkey(vap, &vap->iv_nw_keys[i],
 169                         IEEE80211_KEYIX_NONE);
 170         /*
 171          * Initialize the driver key support routines to noop entries.
 172          * This is useful especially for the cipher test modules.
 173          */
 174         vap->iv_key_alloc = null_key_alloc;
 175         vap->iv_key_set = null_key_set;
 176         vap->iv_key_delete = null_key_delete;
 177         vap->iv_key_update_begin = null_key_update;
 178         vap->iv_key_update_end = null_key_update;
 179 }
 180
 181 /*
 182  * Teardown crypto support for a vap.
 183  */
 184 void
 185 ieee80211_crypto_vdetach(struct ieee80211vap *vap)
 186 {
 187         ieee80211_crypto_delglobalkeys(vap);
 188 }
 189
 190 /*
 191  * Register a crypto cipher module.
 192  */
 193 void
 194 ieee80211_crypto_register(const struct ieee80211_cipher *cip)
 195 {
 196         if (cip->ic_cipher >= IEEE80211_CIPHER_MAX) {
 197                 printf("%s: cipher %s has an invalid cipher index %u\n",
 198                         __func__, cip->ic_name, cip->ic_cipher);
 199                 return;
 200         }
 201         if (ciphers[cip->ic_cipher] != NULL && ciphers[cip->ic_cipher] != cip) {
 202                 printf("%s: cipher %s registered with a different template\n",
 203                         __func__, cip->ic_name);
 204                 return;
 205         }
 206         ciphers[cip->ic_cipher] = cip;
 207 }
 208
 209 /*
 210  * Unregister a crypto cipher module.
 211  */
 212 void
 213 ieee80211_crypto_unregister(const struct ieee80211_cipher *cip)
 214 {
 215         if (cip->ic_cipher >= IEEE80211_CIPHER_MAX) {
 216                 printf("%s: cipher %s has an invalid cipher index %u\n",
 217                         __func__, cip->ic_name, cip->ic_cipher);
 218                 return;
 219         }
 220         if (ciphers[cip->ic_cipher] != NULL && ciphers[cip->ic_cipher] != cip) {
 221                 printf("%s: cipher %s registered with a different template\n",
 222                         __func__, cip->ic_name);
 223                 return;
 224         }
 225         /* NB: don't complain about not being registered */
 226         /* XXX disallow if references */
 227         ciphers[cip->ic_cipher] = NULL;
 228 }
 229
 230 int
 231 ieee80211_crypto_available(u_int cipher)
 232 {
 233         return cipher < IEEE80211_CIPHER_MAX && ciphers[cipher] != NULL;
 234 }
 235
 236 /* XXX well-known names! */
 237 static const char *cipher_modnames[IEEE80211_CIPHER_MAX] = {
 238         "wlan_wep",     /* IEEE80211_CIPHER_WEP */
 239         "wlan_tkip",    /* IEEE80211_CIPHER_TKIP */
 240         "wlan_aes_ocb", /* IEEE80211_CIPHER_AES_OCB */
 241         "wlan_ccmp",    /* IEEE80211_CIPHER_AES_CCM */
 242         "#4",           /* reserved */
 243         "wlan_ckip",    /* IEEE80211_CIPHER_CKIP */
 244         "wlan_none",    /* IEEE80211_CIPHER_NONE */
 245 };
 246
 247 /*
 248  * Establish a relationship between the specified key and cipher
 249  * and, if necessary, allocate a hardware index from the driver.
 250  * Note that when a fixed key index is required it must be specified
 251  * and we blindly assign it w/o consulting the driver (XXX).
 252  *
 253  * This must be the first call applied to a key; all the other key
 254  * routines assume wk_cipher is setup.
 255  *
 256  * Locking must be handled by the caller using:
 257  *      ieee80211_key_update_begin(vap);
 258  *      ieee80211_key_update_end(vap);
 259  */
 260 int
 261 ieee80211_crypto_newkey(struct ieee80211vap *vap,
 262         int cipher, int flags, struct ieee80211_key *key)
 263 {
 264         struct ieee80211com *ic = vap->iv_ic;
 265         const struct ieee80211_cipher *cip;
 266         ieee80211_keyix keyix, rxkeyix;
 267         void *keyctx;
 268         int oflags;
 269
 270         /*
 271          * Validate cipher and set reference to cipher routines.
 272          */
 273         if (cipher >= IEEE80211_CIPHER_MAX) {
 274                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 275                     "%s: invalid cipher %u\n", __func__, cipher);
 276                 vap->iv_stats.is_crypto_badcipher++;
 277                 return 0;
 278         }
 279         cip = ciphers[cipher];
 280         if (cip == NULL) {
 281                 /*
 282                  * Auto-load cipher module if we have a well-known name
 283                  * for it.  It might be better to use string names rather
 284                  * than numbers and craft a module name based on the cipher
 285                  * name; e.g. wlan_cipher_<cipher-name>.
 286                  */
 287                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 288                     "%s: unregistered cipher %u, load module %s\n",
 289                     __func__, cipher, cipher_modnames[cipher]);
 290                 ieee80211_load_module(cipher_modnames[cipher]);
 291                 /*
 292                  * If cipher module loaded it should immediately
 293                  * call ieee80211_crypto_register which will fill
 294                  * in the entry in the ciphers array.
 295                  */
 296                 cip = ciphers[cipher];
 297                 if (cip == NULL) {
 298                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 299                             "%s: unable to load cipher %u, module %s\n",
 300                             __func__, cipher, cipher_modnames[cipher]);
 301                         vap->iv_stats.is_crypto_nocipher++;
 302                         return 0;
 303                 }
 304         }
 305
 306         oflags = key->wk_flags;
 307         flags &= IEEE80211_KEY_COMMON;
 308         /*
 309          * If the hardware does not support the cipher then
 310          * fallback to a host-based implementation.
 311          */
 312         if ((ic->ic_cryptocaps & (1<<cipher)) == 0) {
 313                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 314                     "%s: no h/w support for cipher %s, falling back to s/w\n",
 315                     __func__, cip->ic_name);
 316                 flags |= IEEE80211_KEY_SWCRYPT;
 317         }
 318         /*
 319          * Hardware TKIP with software MIC is an important
 320          * combination; we handle it by flagging each key,
 321          * the cipher modules honor it.
 322          */
 323         if (cipher == IEEE80211_CIPHER_TKIP &&
 324             (ic->ic_cryptocaps & IEEE80211_CRYPTO_TKIPMIC) == 0) {
 325                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 326                     "%s: no h/w support for TKIP MIC, falling back to s/w\n",
 327                     __func__);
 328                 flags |= IEEE80211_KEY_SWMIC;
 329         }
 330
 331         /*
 332          * Bind cipher to key instance.  Note we do this
 333          * after checking the device capabilities so the
 334          * cipher module can optimize space usage based on
 335          * whether or not it needs to do the cipher work.
 336          */
 337         if (key->wk_cipher != cip || key->wk_flags != flags) {
 338                 /*
 339                  * Fillin the flags so cipher modules can see s/w
 340                  * crypto requirements and potentially allocate
 341                  * different state and/or attach different method
 342                  * pointers.
 343                  */
 344                 key->wk_flags = flags;
 345                 keyctx = cip->ic_attach(vap, key);
 346                 if (keyctx == NULL) {
 347                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 348                                 "%s: unable to attach cipher %s\n",
 349                                 __func__, cip->ic_name);
 350                         key->wk_flags = oflags; /* restore old flags */
 351                         vap->iv_stats.is_crypto_attachfail++;
 352                         return 0;
 353                 }
 354                 cipher_detach(key);
 355                 key->wk_cipher = cip;           /* XXX refcnt? */
 356                 key->wk_private = keyctx;
 357         }
 358         /*
 359          * Commit to requested usage so driver can see the flags.
 360          */
 361         key->wk_flags = flags;
 362
 363         /*
 364          * Ask the driver for a key index if we don't have one.
 365          * Note that entries in the global key table always have
 366          * an index; this means it's safe to call this routine
 367          * for these entries just to setup the reference to the
 368          * cipher template.  Note also that when using software
 369          * crypto we also call the driver to give us a key index.
 370          */
 371         if ((key->wk_flags & IEEE80211_KEY_DEVKEY) == 0) {
 372                 if (!dev_key_alloc(vap, key, &keyix, &rxkeyix)) {
 373                         /*
 374                          * Unable to setup driver state.
 375                          */
 376                         vap->iv_stats.is_crypto_keyfail++;
 377                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 378                             "%s: unable to setup cipher %s\n",
 379                             __func__, cip->ic_name);
 380                         return 0;
 381                 }
 382                 if (key->wk_flags != flags) {
 383                         /*
 384                          * Driver overrode flags we setup; typically because
 385                          * resources were unavailable to handle _this_ key.
 386                          * Re-attach the cipher context to allow cipher
 387                          * modules to handle differing requirements.
 388                          */
 389                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 390                             "%s: driver override for cipher %s, flags "
 391                             "0x%x -> 0x%x\n", __func__, cip->ic_name,
 392                             oflags, key->wk_flags);
 393                         keyctx = cip->ic_attach(vap, key);
 394                         if (keyctx == NULL) {
 395                                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 396                                     "%s: unable to attach cipher %s with "
 397                                     "flags 0x%x\n", __func__, cip->ic_name,
 398                                     key->wk_flags);
 399                                 key->wk_flags = oflags; /* restore old flags */
 400                                 vap->iv_stats.is_crypto_attachfail++;
 401                                 return 0;
 402                         }
 403                         cipher_detach(key);
 404                         key->wk_cipher = cip;           /* XXX refcnt? */
 405                         key->wk_private = keyctx;
 406                 }
 407                 key->wk_keyix = keyix;
 408                 key->wk_rxkeyix = rxkeyix;
 409                 key->wk_flags |= IEEE80211_KEY_DEVKEY;
 410         }
 411         return 1;
 412 }
 413
 414 /*
 415  * Remove the key (no locking, for internal use).
 416  */
 417 static int
 418 _ieee80211_crypto_delkey(struct ieee80211vap *vap, struct ieee80211_key *key)
 419 {
 420         KASSERT(key->wk_cipher != NULL, ("No cipher!"));
 421
 422         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 423             "%s: %s keyix %u flags 0x%x rsc %ju tsc %ju len %u\n",
 424             __func__, key->wk_cipher->ic_name,
 425             key->wk_keyix, key->wk_flags,
 426             key->wk_keyrsc[IEEE80211_NONQOS_TID], key->wk_keytsc,
 427             key->wk_keylen);
 428
 429         if (key->wk_flags & IEEE80211_KEY_DEVKEY) {
 430                 /*
 431                  * Remove hardware entry.
 432                  */
 433                 /* XXX key cache */
 434                 if (!dev_key_delete(vap, key)) {
 435                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 436                             "%s: driver did not delete key index %u\n",
 437                             __func__, key->wk_keyix);
 438                         vap->iv_stats.is_crypto_delkey++;
 439                         /* XXX recovery? */
 440                 }
 441         }
 442         cipher_detach(key);
 443         memset(key, 0, sizeof(*key));
 444         ieee80211_crypto_resetkey(vap, key, IEEE80211_KEYIX_NONE);
 445         return 1;
 446 }
 447
 448 /*
 449  * Remove the specified key.
 450  */
 451 int
 452 ieee80211_crypto_delkey(struct ieee80211vap *vap, struct ieee80211_key *key)
 453 {
 454         int status;
 455
 456         ieee80211_key_update_begin(vap);
 457         status = _ieee80211_crypto_delkey(vap, key);
 458         ieee80211_key_update_end(vap);
 459         return status;
 460 }
 461
 462 /*
 463  * Clear the global key table.
 464  */
 465 void
 466 ieee80211_crypto_delglobalkeys(struct ieee80211vap *vap)
 467 {
 468         int i;
 469
 470         ieee80211_key_update_begin(vap);
 471         for (i = 0; i < IEEE80211_WEP_NKID; i++)
 472                 (void) _ieee80211_crypto_delkey(vap, &vap->iv_nw_keys[i]);
 473         ieee80211_key_update_end(vap);
 474 }
 475
 476 /*
 477  * Set the contents of the specified key.
 478  *
 479  * Locking must be handled by the caller using:
 480  *      ieee80211_key_update_begin(vap);
 481  *      ieee80211_key_update_end(vap);
 482  */
 483 int
 484 ieee80211_crypto_setkey(struct ieee80211vap *vap, struct ieee80211_key *key)
 485 {
 486         const struct ieee80211_cipher *cip = key->wk_cipher;
 487
 488         KASSERT(cip != NULL, ("No cipher!"));
 489
 490         IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 491             "%s: %s keyix %u flags 0x%x mac %s rsc %ju tsc %ju len %u\n",
 492             __func__, cip->ic_name, key->wk_keyix,
 493             key->wk_flags, ether_sprintf(key->wk_macaddr),
 494             key->wk_keyrsc[IEEE80211_NONQOS_TID], key->wk_keytsc,
 495             key->wk_keylen);
 496
 497         if ((key->wk_flags & IEEE80211_KEY_DEVKEY)  == 0) {
 498                 /* XXX nothing allocated, should not happen */
 499                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 500                     "%s: no device key setup done; should not happen!\n",
 501                     __func__);
 502                 vap->iv_stats.is_crypto_setkey_nokey++;
 503                 return 0;
 504         }
 505         /*
 506          * Give cipher a chance to validate key contents.
 507          * XXX should happen before modifying state.
 508          */
 509         if (!cip->ic_setkey(key)) {
 510                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_CRYPTO,
 511                     "%s: cipher %s rejected key index %u len %u flags 0x%x\n",
 512                     __func__, cip->ic_name, key->wk_keyix,
 513                     key->wk_keylen, key->wk_flags);
 514                 vap->iv_stats.is_crypto_setkey_cipher++;
 515                 return 0;
 516         }
 517         return dev_key_set(vap, key);
 518 }
 519
 520 /*
 521  * Add privacy headers appropriate for the specified key.
 522  */
 523 struct ieee80211_key *
 524 ieee80211_crypto_encap(struct ieee80211_node *ni, struct mbuf *m)
 525 {
 526         struct ieee80211vap *vap = ni->ni_vap;
 527         struct ieee80211_key *k;
 528         struct ieee80211_frame *wh;
 529         const struct ieee80211_cipher *cip;
 530         uint8_t keyid;
 531
 532         /*
 533          * Multicast traffic always uses the multicast key.
 534          * Otherwise if a unicast key is set we use that and
 535          * it is always key index 0.  When no unicast key is
 536          * set we fall back to the default transmit key.
 537          */
 538         wh = mtod(m, struct ieee80211_frame *);
 539         if (IEEE80211_IS_MULTICAST(wh->i_addr1) ||
 540             IEEE80211_KEY_UNDEFINED(&ni->ni_ucastkey)) {
 541                 if (vap->iv_def_txkey == IEEE80211_KEYIX_NONE) {
 542                         IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_CRYPTO,
 543                             wh->i_addr1,
 544                             "no default transmit key (%s) deftxkey %u",
 545                             __func__, vap->iv_def_txkey);
 546                         vap->iv_stats.is_tx_nodefkey++;
 547                         return NULL;
 548                 }
 549                 keyid = vap->iv_def_txkey;
 550                 k = &vap->iv_nw_keys[vap->iv_def_txkey];
 551         } else {
 552                 keyid = 0;
 553                 k = &ni->ni_ucastkey;
 554         }
 555         cip = k->wk_cipher;
 556         return (cip->ic_encap(k, m, keyid<<6) ? k : NULL);
 557 }
 558
 559 /*
 560  * Validate and strip privacy headers (and trailer) for a
 561  * received frame that has the WEP/Privacy bit set.
 562  */
 563 struct ieee80211_key *
 564 ieee80211_crypto_decap(struct ieee80211_node *ni, struct mbuf *m, int hdrlen)
 565 {
 566 #define IEEE80211_WEP_HDRLEN    (IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN)
 567 #define IEEE80211_WEP_MINLEN \
 568         (sizeof(struct ieee80211_frame) + \
 569         IEEE80211_WEP_HDRLEN + IEEE80211_WEP_CRCLEN)
 570         struct ieee80211vap *vap = ni->ni_vap;
 571         struct ieee80211_key *k;
 572         struct ieee80211_frame *wh;
 573         const struct ieee80211_cipher *cip;
 574         uint8_t keyid;
 575
 576         /* NB: this minimum size data frame could be bigger */
 577         if (m->m_pkthdr.len < IEEE80211_WEP_MINLEN) {
 578                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_ANY,
 579                         "%s: WEP data frame too short, len %u\n",
 580                         __func__, m->m_pkthdr.len);
 581                 vap->iv_stats.is_rx_tooshort++; /* XXX need unique stat? */
 582                 return NULL;
 583         }
 584
 585         /*
 586          * Locate the key. If unicast and there is no unicast
 587          * key then we fall back to the key id in the header.
 588          * This assumes unicast keys are only configured when
 589          * the key id in the header is meaningless (typically 0).
 590          */
 591         wh = mtod(m, struct ieee80211_frame *);
 592         m_copydata(m, hdrlen + IEEE80211_WEP_IVLEN, sizeof(keyid), &keyid);
 593         if (IEEE80211_IS_MULTICAST(wh->i_addr1) ||
 594             IEEE80211_KEY_UNDEFINED(&ni->ni_ucastkey))
 595                 k = &vap->iv_nw_keys[keyid >> 6];
 596         else
 597                 k = &ni->ni_ucastkey;
 598
 599         /*
 600          * Insure crypto header is contiguous for all decap work.
 601          */
 602         cip = k->wk_cipher;
 603         if (m->m_len < hdrlen + cip->ic_header &&
 604             (m = m_pullup(m, hdrlen + cip->ic_header)) == NULL) {
 605                 IEEE80211_NOTE_MAC(vap, IEEE80211_MSG_CRYPTO, wh->i_addr2,
 606                     "unable to pullup %s header", cip->ic_name);
 607                 vap->iv_stats.is_rx_wepfail++;  /* XXX */
 608                 return NULL;
 609         }
 610
 611         return (cip->ic_decap(k, m, hdrlen) ? k : NULL);
 612 #undef IEEE80211_WEP_MINLEN
 613 #undef IEEE80211_WEP_HDRLEN
 614 }
 615
 616 static void
 617 load_ucastkey(void *arg, struct ieee80211_node *ni)
 618 {
 619         struct ieee80211vap *vap = ni->ni_vap;
 620         struct ieee80211_key *k;
 621
 622         if (vap->iv_state != IEEE80211_S_RUN)
 623                 return;
 624         k = &ni->ni_ucastkey;
 625         if (k->wk_flags & IEEE80211_KEY_DEVKEY)
 626                 dev_key_set(vap, k);
 627 }
 628
 629 /*
 630  * Re-load all keys known to the 802.11 layer that may
 631  * have hardware state backing them.  This is used by
 632  * drivers on resume to push keys down into the device.
 633  */
 634 void
 635 ieee80211_crypto_reload_keys(struct ieee80211com *ic)
 636 {
 637         struct ieee80211vap *vap;
 638         int i;
 639
 640         /*
 641          * Keys in the global key table of each vap.
 642          */
 643         /* NB: used only during resume so don't lock for now */
 644         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
 645                 if (vap->iv_state != IEEE80211_S_RUN)
 646                         continue;
 647                 for (i = 0; i < IEEE80211_WEP_NKID; i++) {
 648                         const struct ieee80211_key *k = &vap->iv_nw_keys[i];
 649                         if (k->wk_flags & IEEE80211_KEY_DEVKEY)
 650                                 dev_key_set(vap, k);
 651                 }
 652         }
 653         /*
 654          * Unicast keys.
 655          */
 656         ieee80211_iterate_nodes(&ic->ic_sta, load_ucastkey, NULL);
 657 }