2 * Copyright 2002-2005, Instant802 Networks, Inc.
3 * Copyright 2005-2006, Devicescape Software, Inc.
4 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
5 * Copyright 2007-2008 Johannes Berg <johannes@sipsolutions.net>
6 * Copyright 2013-2014 Intel Mobile Communications GmbH
7 * Copyright 2015-2017 Intel Deutschland GmbH
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/if_ether.h>
15 #include <linux/etherdevice.h>
16 #include <linux/list.h>
17 #include <linux/rcupdate.h>
18 #include <linux/rtnetlink.h>
19 #include <linux/slab.h>
20 #include <linux/export.h>
21 #include <net/mac80211.h>
22 #include <crypto/algapi.h>
23 #include <asm/unaligned.h>
24 #include "ieee80211_i.h"
25 #include "driver-ops.h"
26 #include "debugfs_key.h"
34 * DOC: Key handling basics
36 * Key handling in mac80211 is done based on per-interface (sub_if_data)
37 * keys and per-station keys. Since each station belongs to an interface,
38 * each station key also belongs to that interface.
40 * Hardware acceleration is done on a best-effort basis for algorithms
41 * that are implemented in software, for each key the hardware is asked
42 * to enable that key for offloading but if it cannot do that the key is
43 * simply kept for software encryption (unless it is for an algorithm
44 * that isn't implemented in software).
45 * There is currently no way of knowing whether a key is handled in SW
46 * or HW except by looking into debugfs.
48 * All key management is internally protected by a mutex. Within all
49 * other parts of mac80211, key references are, just as STA structure
50 * references, protected by RCU. Note, however, that some things are
51 * unprotected, namely the key->sta dereferences within the hardware
52 * acceleration functions. This means that sta_info_destroy() must
53 * remove the key which waits for an RCU grace period.
56 static const u8 bcast_addr[ETH_ALEN] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
58 static void assert_key_lock(struct ieee80211_local *local)
60 lockdep_assert_held(&local->key_mtx);
64 update_vlan_tailroom_need_count(struct ieee80211_sub_if_data *sdata, int delta)
66 struct ieee80211_sub_if_data *vlan;
68 if (sdata->vif.type != NL80211_IFTYPE_AP)
71 /* crypto_tx_tailroom_needed_cnt is protected by this */
72 assert_key_lock(sdata->local);
76 list_for_each_entry_rcu(vlan, &sdata->u.ap.vlans, u.vlan.list)
77 vlan->crypto_tx_tailroom_needed_cnt += delta;
82 static void increment_tailroom_need_count(struct ieee80211_sub_if_data *sdata)
85 * When this count is zero, SKB resizing for allocating tailroom
86 * for IV or MMIC is skipped. But, this check has created two race
87 * cases in xmit path while transiting from zero count to one:
89 * 1. SKB resize was skipped because no key was added but just before
90 * the xmit key is added and SW encryption kicks off.
92 * 2. SKB resize was skipped because all the keys were hw planted but
93 * just before xmit one of the key is deleted and SW encryption kicks
96 * In both the above case SW encryption will find not enough space for
97 * tailroom and exits with WARN_ON. (See WARN_ONs at wpa.c)
99 * Solution has been explained at
100 * http://mid.gmane.org/1308590980.4322.19.camel@jlt3.sipsolutions.net
103 assert_key_lock(sdata->local);
105 update_vlan_tailroom_need_count(sdata, 1);
107 if (!sdata->crypto_tx_tailroom_needed_cnt++) {
109 * Flush all XMIT packets currently using HW encryption or no
110 * encryption at all if the count transition is from 0 -> 1.
116 static void decrease_tailroom_need_count(struct ieee80211_sub_if_data *sdata,
119 assert_key_lock(sdata->local);
121 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt < delta);
123 update_vlan_tailroom_need_count(sdata, -delta);
124 sdata->crypto_tx_tailroom_needed_cnt -= delta;
127 static int ieee80211_key_enable_hw_accel(struct ieee80211_key *key)
129 struct ieee80211_sub_if_data *sdata;
130 struct sta_info *sta;
131 int ret = -EOPNOTSUPP;
135 if (key->flags & KEY_FLAG_TAINTED) {
136 /* If we get here, it's during resume and the key is
137 * tainted so shouldn't be used/programmed any more.
138 * However, its flags may still indicate that it was
139 * programmed into the device (since we're in resume)
140 * so clear that flag now to avoid trying to remove
143 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
147 if (!key->local->ops->set_key)
148 goto out_unsupported;
150 assert_key_lock(key->local);
155 * If this is a per-STA GTK, check if it
156 * is supported; if not, return.
158 if (sta && !(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE) &&
159 !ieee80211_hw_check(&key->local->hw, SUPPORTS_PER_STA_GTK))
160 goto out_unsupported;
162 if (sta && !sta->uploaded)
163 goto out_unsupported;
166 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
168 * The driver doesn't know anything about VLAN interfaces.
169 * Hence, don't send GTKs for VLAN interfaces to the driver.
171 if (!(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE))
172 goto out_unsupported;
175 ret = drv_set_key(key->local, SET_KEY, sdata,
176 sta ? &sta->sta : NULL, &key->conf);
179 key->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
181 if (!((key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC) ||
182 (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
183 decrease_tailroom_need_count(sdata, 1);
185 WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_IV_SPACE) &&
186 (key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_IV));
191 if (ret != -ENOSPC && ret != -EOPNOTSUPP && ret != 1)
193 "failed to set key (%d, %pM) to hardware (%d)\n",
195 sta ? sta->sta.addr : bcast_addr, ret);
198 switch (key->conf.cipher) {
199 case WLAN_CIPHER_SUITE_WEP40:
200 case WLAN_CIPHER_SUITE_WEP104:
201 case WLAN_CIPHER_SUITE_TKIP:
202 case WLAN_CIPHER_SUITE_CCMP:
203 case WLAN_CIPHER_SUITE_CCMP_256:
204 case WLAN_CIPHER_SUITE_AES_CMAC:
205 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
206 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
207 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
208 case WLAN_CIPHER_SUITE_GCMP:
209 case WLAN_CIPHER_SUITE_GCMP_256:
210 /* all of these we can do in software - if driver can */
213 if (ieee80211_hw_check(&key->local->hw, SW_CRYPTO_CONTROL))
221 static void ieee80211_key_disable_hw_accel(struct ieee80211_key *key)
223 struct ieee80211_sub_if_data *sdata;
224 struct sta_info *sta;
229 if (!key || !key->local->ops->set_key)
232 assert_key_lock(key->local);
234 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
240 if (!((key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC) ||
241 (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
242 increment_tailroom_need_count(sdata);
244 ret = drv_set_key(key->local, DISABLE_KEY, sdata,
245 sta ? &sta->sta : NULL, &key->conf);
249 "failed to remove key (%d, %pM) from hardware (%d)\n",
251 sta ? sta->sta.addr : bcast_addr, ret);
253 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
256 static void __ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata,
257 int idx, bool uni, bool multi)
259 struct ieee80211_key *key = NULL;
261 assert_key_lock(sdata->local);
263 if (idx >= 0 && idx < NUM_DEFAULT_KEYS)
264 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
267 rcu_assign_pointer(sdata->default_unicast_key, key);
268 ieee80211_check_fast_xmit_iface(sdata);
269 if (sdata->vif.type != NL80211_IFTYPE_AP_VLAN)
270 drv_set_default_unicast_key(sdata->local, sdata, idx);
274 rcu_assign_pointer(sdata->default_multicast_key, key);
276 ieee80211_debugfs_key_update_default(sdata);
279 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
280 bool uni, bool multi)
282 mutex_lock(&sdata->local->key_mtx);
283 __ieee80211_set_default_key(sdata, idx, uni, multi);
284 mutex_unlock(&sdata->local->key_mtx);
288 __ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata, int idx)
290 struct ieee80211_key *key = NULL;
292 assert_key_lock(sdata->local);
294 if (idx >= NUM_DEFAULT_KEYS &&
295 idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS)
296 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
298 rcu_assign_pointer(sdata->default_mgmt_key, key);
300 ieee80211_debugfs_key_update_default(sdata);
303 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
306 mutex_lock(&sdata->local->key_mtx);
307 __ieee80211_set_default_mgmt_key(sdata, idx);
308 mutex_unlock(&sdata->local->key_mtx);
312 static void ieee80211_key_replace(struct ieee80211_sub_if_data *sdata,
313 struct sta_info *sta,
315 struct ieee80211_key *old,
316 struct ieee80211_key *new)
319 bool defunikey, defmultikey, defmgmtkey;
321 /* caller must provide at least one old/new */
322 if (WARN_ON(!new && !old))
326 list_add_tail_rcu(&new->list, &sdata->key_list);
328 WARN_ON(new && old && new->conf.keyidx != old->conf.keyidx);
331 idx = old->conf.keyidx;
333 idx = new->conf.keyidx;
337 rcu_assign_pointer(sta->ptk[idx], new);
338 set_sta_flag(sta, WLAN_STA_USES_ENCRYPTION);
340 ieee80211_check_fast_xmit(sta);
342 rcu_assign_pointer(sta->gtk[idx], new);
344 ieee80211_check_fast_rx(sta);
347 old == key_mtx_dereference(sdata->local,
348 sdata->default_unicast_key);
350 old == key_mtx_dereference(sdata->local,
351 sdata->default_multicast_key);
353 old == key_mtx_dereference(sdata->local,
354 sdata->default_mgmt_key);
356 if (defunikey && !new)
357 __ieee80211_set_default_key(sdata, -1, true, false);
358 if (defmultikey && !new)
359 __ieee80211_set_default_key(sdata, -1, false, true);
360 if (defmgmtkey && !new)
361 __ieee80211_set_default_mgmt_key(sdata, -1);
363 rcu_assign_pointer(sdata->keys[idx], new);
364 if (defunikey && new)
365 __ieee80211_set_default_key(sdata, new->conf.keyidx,
367 if (defmultikey && new)
368 __ieee80211_set_default_key(sdata, new->conf.keyidx,
370 if (defmgmtkey && new)
371 __ieee80211_set_default_mgmt_key(sdata,
376 list_del_rcu(&old->list);
379 struct ieee80211_key *
380 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
382 size_t seq_len, const u8 *seq,
383 const struct ieee80211_cipher_scheme *cs)
385 struct ieee80211_key *key;
388 if (WARN_ON(idx < 0 || idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS))
389 return ERR_PTR(-EINVAL);
391 key = kzalloc(sizeof(struct ieee80211_key) + key_len, GFP_KERNEL);
393 return ERR_PTR(-ENOMEM);
396 * Default to software encryption; we'll later upload the
397 * key to the hardware if possible.
402 key->conf.cipher = cipher;
403 key->conf.keyidx = idx;
404 key->conf.keylen = key_len;
406 case WLAN_CIPHER_SUITE_WEP40:
407 case WLAN_CIPHER_SUITE_WEP104:
408 key->conf.iv_len = IEEE80211_WEP_IV_LEN;
409 key->conf.icv_len = IEEE80211_WEP_ICV_LEN;
411 case WLAN_CIPHER_SUITE_TKIP:
412 key->conf.iv_len = IEEE80211_TKIP_IV_LEN;
413 key->conf.icv_len = IEEE80211_TKIP_ICV_LEN;
415 for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
416 key->u.tkip.rx[i].iv32 =
417 get_unaligned_le32(&seq[2]);
418 key->u.tkip.rx[i].iv16 =
419 get_unaligned_le16(seq);
422 spin_lock_init(&key->u.tkip.txlock);
424 case WLAN_CIPHER_SUITE_CCMP:
425 key->conf.iv_len = IEEE80211_CCMP_HDR_LEN;
426 key->conf.icv_len = IEEE80211_CCMP_MIC_LEN;
428 for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
429 for (j = 0; j < IEEE80211_CCMP_PN_LEN; j++)
430 key->u.ccmp.rx_pn[i][j] =
431 seq[IEEE80211_CCMP_PN_LEN - j - 1];
434 * Initialize AES key state here as an optimization so that
435 * it does not need to be initialized for every packet.
437 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
438 key_data, key_len, IEEE80211_CCMP_MIC_LEN);
439 if (IS_ERR(key->u.ccmp.tfm)) {
440 err = PTR_ERR(key->u.ccmp.tfm);
445 case WLAN_CIPHER_SUITE_CCMP_256:
446 key->conf.iv_len = IEEE80211_CCMP_256_HDR_LEN;
447 key->conf.icv_len = IEEE80211_CCMP_256_MIC_LEN;
448 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
449 for (j = 0; j < IEEE80211_CCMP_256_PN_LEN; j++)
450 key->u.ccmp.rx_pn[i][j] =
451 seq[IEEE80211_CCMP_256_PN_LEN - j - 1];
452 /* Initialize AES key state here as an optimization so that
453 * it does not need to be initialized for every packet.
455 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
456 key_data, key_len, IEEE80211_CCMP_256_MIC_LEN);
457 if (IS_ERR(key->u.ccmp.tfm)) {
458 err = PTR_ERR(key->u.ccmp.tfm);
463 case WLAN_CIPHER_SUITE_AES_CMAC:
464 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
465 key->conf.iv_len = 0;
466 if (cipher == WLAN_CIPHER_SUITE_AES_CMAC)
467 key->conf.icv_len = sizeof(struct ieee80211_mmie);
469 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
471 for (j = 0; j < IEEE80211_CMAC_PN_LEN; j++)
472 key->u.aes_cmac.rx_pn[j] =
473 seq[IEEE80211_CMAC_PN_LEN - j - 1];
475 * Initialize AES key state here as an optimization so that
476 * it does not need to be initialized for every packet.
478 key->u.aes_cmac.tfm =
479 ieee80211_aes_cmac_key_setup(key_data, key_len);
480 if (IS_ERR(key->u.aes_cmac.tfm)) {
481 err = PTR_ERR(key->u.aes_cmac.tfm);
486 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
487 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
488 key->conf.iv_len = 0;
489 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
491 for (j = 0; j < IEEE80211_GMAC_PN_LEN; j++)
492 key->u.aes_gmac.rx_pn[j] =
493 seq[IEEE80211_GMAC_PN_LEN - j - 1];
494 /* Initialize AES key state here as an optimization so that
495 * it does not need to be initialized for every packet.
497 key->u.aes_gmac.tfm =
498 ieee80211_aes_gmac_key_setup(key_data, key_len);
499 if (IS_ERR(key->u.aes_gmac.tfm)) {
500 err = PTR_ERR(key->u.aes_gmac.tfm);
505 case WLAN_CIPHER_SUITE_GCMP:
506 case WLAN_CIPHER_SUITE_GCMP_256:
507 key->conf.iv_len = IEEE80211_GCMP_HDR_LEN;
508 key->conf.icv_len = IEEE80211_GCMP_MIC_LEN;
509 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
510 for (j = 0; j < IEEE80211_GCMP_PN_LEN; j++)
511 key->u.gcmp.rx_pn[i][j] =
512 seq[IEEE80211_GCMP_PN_LEN - j - 1];
513 /* Initialize AES key state here as an optimization so that
514 * it does not need to be initialized for every packet.
516 key->u.gcmp.tfm = ieee80211_aes_gcm_key_setup_encrypt(key_data,
518 if (IS_ERR(key->u.gcmp.tfm)) {
519 err = PTR_ERR(key->u.gcmp.tfm);
526 if (seq_len && seq_len != cs->pn_len) {
528 return ERR_PTR(-EINVAL);
531 key->conf.iv_len = cs->hdr_len;
532 key->conf.icv_len = cs->mic_len;
533 for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
534 for (j = 0; j < seq_len; j++)
535 key->u.gen.rx_pn[i][j] =
536 seq[seq_len - j - 1];
537 key->flags |= KEY_FLAG_CIPHER_SCHEME;
540 memcpy(key->conf.key, key_data, key_len);
541 INIT_LIST_HEAD(&key->list);
546 static void ieee80211_key_free_common(struct ieee80211_key *key)
548 switch (key->conf.cipher) {
549 case WLAN_CIPHER_SUITE_CCMP:
550 case WLAN_CIPHER_SUITE_CCMP_256:
551 ieee80211_aes_key_free(key->u.ccmp.tfm);
553 case WLAN_CIPHER_SUITE_AES_CMAC:
554 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
555 ieee80211_aes_cmac_key_free(key->u.aes_cmac.tfm);
557 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
558 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
559 ieee80211_aes_gmac_key_free(key->u.aes_gmac.tfm);
561 case WLAN_CIPHER_SUITE_GCMP:
562 case WLAN_CIPHER_SUITE_GCMP_256:
563 ieee80211_aes_gcm_key_free(key->u.gcmp.tfm);
569 static void __ieee80211_key_destroy(struct ieee80211_key *key,
573 ieee80211_key_disable_hw_accel(key);
576 struct ieee80211_sub_if_data *sdata = key->sdata;
578 ieee80211_debugfs_key_remove(key);
580 if (delay_tailroom) {
581 /* see ieee80211_delayed_tailroom_dec */
582 sdata->crypto_tx_tailroom_pending_dec++;
583 schedule_delayed_work(&sdata->dec_tailroom_needed_wk,
586 decrease_tailroom_need_count(sdata, 1);
590 ieee80211_key_free_common(key);
593 static void ieee80211_key_destroy(struct ieee80211_key *key,
600 * Synchronize so the TX path and rcu key iterators
601 * can no longer be using this key before we free/remove it.
605 __ieee80211_key_destroy(key, delay_tailroom);
608 void ieee80211_key_free_unused(struct ieee80211_key *key)
610 WARN_ON(key->sdata || key->local);
611 ieee80211_key_free_common(key);
614 static bool ieee80211_key_identical(struct ieee80211_sub_if_data *sdata,
615 struct ieee80211_key *old,
616 struct ieee80211_key *new)
618 u8 tkip_old[WLAN_KEY_LEN_TKIP], tkip_new[WLAN_KEY_LEN_TKIP];
621 if (!old || new->conf.keylen != old->conf.keylen)
624 tk_old = old->conf.key;
625 tk_new = new->conf.key;
628 * In station mode, don't compare the TX MIC key, as it's never used
629 * and offloaded rekeying may not care to send it to the host. This
630 * is the case in iwlwifi, for example.
632 if (sdata->vif.type == NL80211_IFTYPE_STATION &&
633 new->conf.cipher == WLAN_CIPHER_SUITE_TKIP &&
634 new->conf.keylen == WLAN_KEY_LEN_TKIP &&
635 !(new->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
636 memcpy(tkip_old, tk_old, WLAN_KEY_LEN_TKIP);
637 memcpy(tkip_new, tk_new, WLAN_KEY_LEN_TKIP);
638 memset(tkip_old + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
639 memset(tkip_new + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
644 return !crypto_memneq(tk_old, tk_new, new->conf.keylen);
647 int ieee80211_key_link(struct ieee80211_key *key,
648 struct ieee80211_sub_if_data *sdata,
649 struct sta_info *sta)
651 struct ieee80211_local *local = sdata->local;
652 static atomic_t key_color = ATOMIC_INIT(0);
653 struct ieee80211_key *old_key;
654 int idx = key->conf.keyidx;
655 bool pairwise = key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE;
657 * We want to delay tailroom updates only for station - in that
658 * case it helps roaming speed, but in other cases it hurts and
659 * can cause warnings to appear.
661 bool delay_tailroom = sdata->vif.type == NL80211_IFTYPE_STATION;
665 * Assign a unique ID to every key so we can easily prevent mixed
666 * key and fragment cache attacks.
668 key->color = atomic_inc_return(&key_color);
670 mutex_lock(&sdata->local->key_mtx);
673 old_key = key_mtx_dereference(sdata->local, sta->ptk[idx]);
675 old_key = key_mtx_dereference(sdata->local, sta->gtk[idx]);
677 old_key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
680 * Silently accept key re-installation without really installing the
681 * new version of the key to avoid nonce reuse or replay issues.
683 if (ieee80211_key_identical(sdata, old_key, key)) {
684 ieee80211_key_free_unused(key);
689 key->local = sdata->local;
693 increment_tailroom_need_count(sdata);
695 ieee80211_key_replace(sdata, sta, pairwise, old_key, key);
696 ieee80211_key_destroy(old_key, delay_tailroom);
698 ieee80211_debugfs_key_add(key);
700 if (!local->wowlan) {
701 ret = ieee80211_key_enable_hw_accel(key);
703 ieee80211_key_free(key, delay_tailroom);
709 mutex_unlock(&sdata->local->key_mtx);
714 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom)
720 * Replace key with nothingness if it was ever used.
723 ieee80211_key_replace(key->sdata, key->sta,
724 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
726 ieee80211_key_destroy(key, delay_tailroom);
729 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata)
731 struct ieee80211_key *key;
732 struct ieee80211_sub_if_data *vlan;
736 if (WARN_ON(!ieee80211_sdata_running(sdata)))
739 mutex_lock(&sdata->local->key_mtx);
741 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
742 sdata->crypto_tx_tailroom_pending_dec);
744 if (sdata->vif.type == NL80211_IFTYPE_AP) {
745 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
746 WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
747 vlan->crypto_tx_tailroom_pending_dec);
750 list_for_each_entry(key, &sdata->key_list, list) {
751 increment_tailroom_need_count(sdata);
752 ieee80211_key_enable_hw_accel(key);
755 mutex_unlock(&sdata->local->key_mtx);
758 void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata)
760 struct ieee80211_sub_if_data *vlan;
762 mutex_lock(&sdata->local->key_mtx);
764 sdata->crypto_tx_tailroom_needed_cnt = 0;
766 if (sdata->vif.type == NL80211_IFTYPE_AP) {
767 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
768 vlan->crypto_tx_tailroom_needed_cnt = 0;
771 mutex_unlock(&sdata->local->key_mtx);
774 void ieee80211_iter_keys(struct ieee80211_hw *hw,
775 struct ieee80211_vif *vif,
776 void (*iter)(struct ieee80211_hw *hw,
777 struct ieee80211_vif *vif,
778 struct ieee80211_sta *sta,
779 struct ieee80211_key_conf *key,
783 struct ieee80211_local *local = hw_to_local(hw);
784 struct ieee80211_key *key, *tmp;
785 struct ieee80211_sub_if_data *sdata;
789 mutex_lock(&local->key_mtx);
791 sdata = vif_to_sdata(vif);
792 list_for_each_entry_safe(key, tmp, &sdata->key_list, list)
793 iter(hw, &sdata->vif,
794 key->sta ? &key->sta->sta : NULL,
795 &key->conf, iter_data);
797 list_for_each_entry(sdata, &local->interfaces, list)
798 list_for_each_entry_safe(key, tmp,
799 &sdata->key_list, list)
800 iter(hw, &sdata->vif,
801 key->sta ? &key->sta->sta : NULL,
802 &key->conf, iter_data);
804 mutex_unlock(&local->key_mtx);
806 EXPORT_SYMBOL(ieee80211_iter_keys);
809 _ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
810 struct ieee80211_sub_if_data *sdata,
811 void (*iter)(struct ieee80211_hw *hw,
812 struct ieee80211_vif *vif,
813 struct ieee80211_sta *sta,
814 struct ieee80211_key_conf *key,
818 struct ieee80211_key *key;
820 list_for_each_entry_rcu(key, &sdata->key_list, list) {
821 /* skip keys of station in removal process */
822 if (key->sta && key->sta->removed)
824 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
827 iter(hw, &sdata->vif,
828 key->sta ? &key->sta->sta : NULL,
829 &key->conf, iter_data);
833 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
834 struct ieee80211_vif *vif,
835 void (*iter)(struct ieee80211_hw *hw,
836 struct ieee80211_vif *vif,
837 struct ieee80211_sta *sta,
838 struct ieee80211_key_conf *key,
842 struct ieee80211_local *local = hw_to_local(hw);
843 struct ieee80211_sub_if_data *sdata;
846 sdata = vif_to_sdata(vif);
847 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
849 list_for_each_entry_rcu(sdata, &local->interfaces, list)
850 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
853 EXPORT_SYMBOL(ieee80211_iter_keys_rcu);
855 static void ieee80211_free_keys_iface(struct ieee80211_sub_if_data *sdata,
856 struct list_head *keys)
858 struct ieee80211_key *key, *tmp;
860 decrease_tailroom_need_count(sdata,
861 sdata->crypto_tx_tailroom_pending_dec);
862 sdata->crypto_tx_tailroom_pending_dec = 0;
864 ieee80211_debugfs_key_remove_mgmt_default(sdata);
866 list_for_each_entry_safe(key, tmp, &sdata->key_list, list) {
867 ieee80211_key_replace(key->sdata, key->sta,
868 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
870 list_add_tail(&key->list, keys);
873 ieee80211_debugfs_key_update_default(sdata);
876 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
877 bool force_synchronize)
879 struct ieee80211_local *local = sdata->local;
880 struct ieee80211_sub_if_data *vlan;
881 struct ieee80211_sub_if_data *master;
882 struct ieee80211_key *key, *tmp;
885 cancel_delayed_work_sync(&sdata->dec_tailroom_needed_wk);
887 mutex_lock(&local->key_mtx);
889 ieee80211_free_keys_iface(sdata, &keys);
891 if (sdata->vif.type == NL80211_IFTYPE_AP) {
892 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
893 ieee80211_free_keys_iface(vlan, &keys);
896 if (!list_empty(&keys) || force_synchronize)
898 list_for_each_entry_safe(key, tmp, &keys, list)
899 __ieee80211_key_destroy(key, false);
901 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
903 master = container_of(sdata->bss,
904 struct ieee80211_sub_if_data,
907 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt !=
908 master->crypto_tx_tailroom_needed_cnt);
911 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
912 sdata->crypto_tx_tailroom_pending_dec);
915 if (sdata->vif.type == NL80211_IFTYPE_AP) {
916 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
917 WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
918 vlan->crypto_tx_tailroom_pending_dec);
921 mutex_unlock(&local->key_mtx);
924 void ieee80211_free_sta_keys(struct ieee80211_local *local,
925 struct sta_info *sta)
927 struct ieee80211_key *key;
930 mutex_lock(&local->key_mtx);
931 for (i = 0; i < ARRAY_SIZE(sta->gtk); i++) {
932 key = key_mtx_dereference(local, sta->gtk[i]);
935 ieee80211_key_replace(key->sdata, key->sta,
936 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
938 __ieee80211_key_destroy(key, key->sdata->vif.type ==
939 NL80211_IFTYPE_STATION);
942 for (i = 0; i < NUM_DEFAULT_KEYS; i++) {
943 key = key_mtx_dereference(local, sta->ptk[i]);
946 ieee80211_key_replace(key->sdata, key->sta,
947 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
949 __ieee80211_key_destroy(key, key->sdata->vif.type ==
950 NL80211_IFTYPE_STATION);
953 mutex_unlock(&local->key_mtx);
956 void ieee80211_delayed_tailroom_dec(struct work_struct *wk)
958 struct ieee80211_sub_if_data *sdata;
960 sdata = container_of(wk, struct ieee80211_sub_if_data,
961 dec_tailroom_needed_wk.work);
964 * The reason for the delayed tailroom needed decrementing is to
965 * make roaming faster: during roaming, all keys are first deleted
966 * and then new keys are installed. The first new key causes the
967 * crypto_tx_tailroom_needed_cnt to go from 0 to 1, which invokes
968 * the cost of synchronize_net() (which can be slow). Avoid this
969 * by deferring the crypto_tx_tailroom_needed_cnt decrementing on
970 * key removal for a while, so if we roam the value is larger than
971 * zero and no 0->1 transition happens.
973 * The cost is that if the AP switching was from an AP with keys
974 * to one without, we still allocate tailroom while it would no
975 * longer be needed. However, in the typical (fast) roaming case
976 * within an ESS this usually won't happen.
979 mutex_lock(&sdata->local->key_mtx);
980 decrease_tailroom_need_count(sdata,
981 sdata->crypto_tx_tailroom_pending_dec);
982 sdata->crypto_tx_tailroom_pending_dec = 0;
983 mutex_unlock(&sdata->local->key_mtx);
986 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
987 const u8 *replay_ctr, gfp_t gfp)
989 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
991 trace_api_gtk_rekey_notify(sdata, bssid, replay_ctr);
993 cfg80211_gtk_rekey_notify(sdata->dev, bssid, replay_ctr, gfp);
995 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_notify);
997 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
998 int tid, struct ieee80211_key_seq *seq)
1000 struct ieee80211_key *key;
1003 key = container_of(keyconf, struct ieee80211_key, conf);
1005 switch (key->conf.cipher) {
1006 case WLAN_CIPHER_SUITE_TKIP:
1007 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1009 seq->tkip.iv32 = key->u.tkip.rx[tid].iv32;
1010 seq->tkip.iv16 = key->u.tkip.rx[tid].iv16;
1012 case WLAN_CIPHER_SUITE_CCMP:
1013 case WLAN_CIPHER_SUITE_CCMP_256:
1014 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1017 pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1019 pn = key->u.ccmp.rx_pn[tid];
1020 memcpy(seq->ccmp.pn, pn, IEEE80211_CCMP_PN_LEN);
1022 case WLAN_CIPHER_SUITE_AES_CMAC:
1023 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1024 if (WARN_ON(tid != 0))
1026 pn = key->u.aes_cmac.rx_pn;
1027 memcpy(seq->aes_cmac.pn, pn, IEEE80211_CMAC_PN_LEN);
1029 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1030 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1031 if (WARN_ON(tid != 0))
1033 pn = key->u.aes_gmac.rx_pn;
1034 memcpy(seq->aes_gmac.pn, pn, IEEE80211_GMAC_PN_LEN);
1036 case WLAN_CIPHER_SUITE_GCMP:
1037 case WLAN_CIPHER_SUITE_GCMP_256:
1038 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1041 pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1043 pn = key->u.gcmp.rx_pn[tid];
1044 memcpy(seq->gcmp.pn, pn, IEEE80211_GCMP_PN_LEN);
1048 EXPORT_SYMBOL(ieee80211_get_key_rx_seq);
1050 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
1051 int tid, struct ieee80211_key_seq *seq)
1053 struct ieee80211_key *key;
1056 key = container_of(keyconf, struct ieee80211_key, conf);
1058 switch (key->conf.cipher) {
1059 case WLAN_CIPHER_SUITE_TKIP:
1060 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1062 key->u.tkip.rx[tid].iv32 = seq->tkip.iv32;
1063 key->u.tkip.rx[tid].iv16 = seq->tkip.iv16;
1065 case WLAN_CIPHER_SUITE_CCMP:
1066 case WLAN_CIPHER_SUITE_CCMP_256:
1067 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1070 pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1072 pn = key->u.ccmp.rx_pn[tid];
1073 memcpy(pn, seq->ccmp.pn, IEEE80211_CCMP_PN_LEN);
1075 case WLAN_CIPHER_SUITE_AES_CMAC:
1076 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1077 if (WARN_ON(tid != 0))
1079 pn = key->u.aes_cmac.rx_pn;
1080 memcpy(pn, seq->aes_cmac.pn, IEEE80211_CMAC_PN_LEN);
1082 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1083 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1084 if (WARN_ON(tid != 0))
1086 pn = key->u.aes_gmac.rx_pn;
1087 memcpy(pn, seq->aes_gmac.pn, IEEE80211_GMAC_PN_LEN);
1089 case WLAN_CIPHER_SUITE_GCMP:
1090 case WLAN_CIPHER_SUITE_GCMP_256:
1091 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1094 pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1096 pn = key->u.gcmp.rx_pn[tid];
1097 memcpy(pn, seq->gcmp.pn, IEEE80211_GCMP_PN_LEN);
1104 EXPORT_SYMBOL_GPL(ieee80211_set_key_rx_seq);
1106 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf)
1108 struct ieee80211_key *key;
1110 key = container_of(keyconf, struct ieee80211_key, conf);
1112 assert_key_lock(key->local);
1115 * if key was uploaded, we assume the driver will/has remove(d)
1116 * it, so adjust bookkeeping accordingly
1118 if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
1119 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
1121 if (!((key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC) ||
1122 (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
1123 increment_tailroom_need_count(key->sdata);
1126 ieee80211_key_free(key, false);
1128 EXPORT_SYMBOL_GPL(ieee80211_remove_key);
1130 struct ieee80211_key_conf *
1131 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
1132 struct ieee80211_key_conf *keyconf)
1134 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1135 struct ieee80211_local *local = sdata->local;
1136 struct ieee80211_key *key;
1139 if (WARN_ON(!local->wowlan))
1140 return ERR_PTR(-EINVAL);
1142 if (WARN_ON(vif->type != NL80211_IFTYPE_STATION))
1143 return ERR_PTR(-EINVAL);
1145 key = ieee80211_key_alloc(keyconf->cipher, keyconf->keyidx,
1146 keyconf->keylen, keyconf->key,
1149 return ERR_CAST(key);
1151 if (sdata->u.mgd.mfp != IEEE80211_MFP_DISABLED)
1152 key->conf.flags |= IEEE80211_KEY_FLAG_RX_MGMT;
1154 err = ieee80211_key_link(key, sdata, NULL);
1156 return ERR_PTR(err);
1160 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_add);