1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2002-2005, Instant802 Networks, Inc.
4 * Copyright 2005-2006, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2008 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright 2015-2017 Intel Deutschland GmbH
9 * Copyright 2018-2020 Intel Corporation
12 #include <linux/if_ether.h>
13 #include <linux/etherdevice.h>
14 #include <linux/list.h>
15 #include <linux/rcupdate.h>
16 #include <linux/rtnetlink.h>
17 #include <linux/slab.h>
18 #include <linux/export.h>
19 #include <net/mac80211.h>
20 #include <crypto/algapi.h>
21 #include <asm/unaligned.h>
22 #include "ieee80211_i.h"
23 #include "driver-ops.h"
24 #include "debugfs_key.h"
32 * DOC: Key handling basics
34 * Key handling in mac80211 is done based on per-interface (sub_if_data)
35 * keys and per-station keys. Since each station belongs to an interface,
36 * each station key also belongs to that interface.
38 * Hardware acceleration is done on a best-effort basis for algorithms
39 * that are implemented in software, for each key the hardware is asked
40 * to enable that key for offloading but if it cannot do that the key is
41 * simply kept for software encryption (unless it is for an algorithm
42 * that isn't implemented in software).
43 * There is currently no way of knowing whether a key is handled in SW
44 * or HW except by looking into debugfs.
46 * All key management is internally protected by a mutex. Within all
47 * other parts of mac80211, key references are, just as STA structure
48 * references, protected by RCU. Note, however, that some things are
49 * unprotected, namely the key->sta dereferences within the hardware
50 * acceleration functions. This means that sta_info_destroy() must
51 * remove the key which waits for an RCU grace period.
54 static const u8 bcast_addr[ETH_ALEN] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
56 static void assert_key_lock(struct ieee80211_local *local)
58 lockdep_assert_held(&local->key_mtx);
62 update_vlan_tailroom_need_count(struct ieee80211_sub_if_data *sdata, int delta)
64 struct ieee80211_sub_if_data *vlan;
66 if (sdata->vif.type != NL80211_IFTYPE_AP)
69 /* crypto_tx_tailroom_needed_cnt is protected by this */
70 assert_key_lock(sdata->local);
74 list_for_each_entry_rcu(vlan, &sdata->u.ap.vlans, u.vlan.list)
75 vlan->crypto_tx_tailroom_needed_cnt += delta;
80 static void increment_tailroom_need_count(struct ieee80211_sub_if_data *sdata)
83 * When this count is zero, SKB resizing for allocating tailroom
84 * for IV or MMIC is skipped. But, this check has created two race
85 * cases in xmit path while transiting from zero count to one:
87 * 1. SKB resize was skipped because no key was added but just before
88 * the xmit key is added and SW encryption kicks off.
90 * 2. SKB resize was skipped because all the keys were hw planted but
91 * just before xmit one of the key is deleted and SW encryption kicks
94 * In both the above case SW encryption will find not enough space for
95 * tailroom and exits with WARN_ON. (See WARN_ONs at wpa.c)
97 * Solution has been explained at
98 * http://mid.gmane.org/1308590980.4322.19.camel@jlt3.sipsolutions.net
101 assert_key_lock(sdata->local);
103 update_vlan_tailroom_need_count(sdata, 1);
105 if (!sdata->crypto_tx_tailroom_needed_cnt++) {
107 * Flush all XMIT packets currently using HW encryption or no
108 * encryption at all if the count transition is from 0 -> 1.
114 static void decrease_tailroom_need_count(struct ieee80211_sub_if_data *sdata,
117 assert_key_lock(sdata->local);
119 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt < delta);
121 update_vlan_tailroom_need_count(sdata, -delta);
122 sdata->crypto_tx_tailroom_needed_cnt -= delta;
125 static int ieee80211_key_enable_hw_accel(struct ieee80211_key *key)
127 struct ieee80211_sub_if_data *sdata = key->sdata;
128 struct sta_info *sta;
129 int ret = -EOPNOTSUPP;
133 if (key->flags & KEY_FLAG_TAINTED) {
134 /* If we get here, it's during resume and the key is
135 * tainted so shouldn't be used/programmed any more.
136 * However, its flags may still indicate that it was
137 * programmed into the device (since we're in resume)
138 * so clear that flag now to avoid trying to remove
141 if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE &&
142 !(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
143 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
144 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
145 increment_tailroom_need_count(sdata);
147 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
151 if (!key->local->ops->set_key)
152 goto out_unsupported;
154 assert_key_lock(key->local);
159 * If this is a per-STA GTK, check if it
160 * is supported; if not, return.
162 if (sta && !(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE) &&
163 !ieee80211_hw_check(&key->local->hw, SUPPORTS_PER_STA_GTK))
164 goto out_unsupported;
166 if (sta && !sta->uploaded)
167 goto out_unsupported;
169 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
171 * The driver doesn't know anything about VLAN interfaces.
172 * Hence, don't send GTKs for VLAN interfaces to the driver.
174 if (!(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
176 goto out_unsupported;
180 ret = drv_set_key(key->local, SET_KEY, sdata,
181 sta ? &sta->sta : NULL, &key->conf);
184 key->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
186 if (!(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
187 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
188 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
189 decrease_tailroom_need_count(sdata, 1);
191 WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_IV_SPACE) &&
192 (key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_IV));
194 WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_MIC_SPACE) &&
195 (key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC));
200 if (ret != -ENOSPC && ret != -EOPNOTSUPP && ret != 1)
202 "failed to set key (%d, %pM) to hardware (%d)\n",
204 sta ? sta->sta.addr : bcast_addr, ret);
207 switch (key->conf.cipher) {
208 case WLAN_CIPHER_SUITE_WEP40:
209 case WLAN_CIPHER_SUITE_WEP104:
210 case WLAN_CIPHER_SUITE_TKIP:
211 case WLAN_CIPHER_SUITE_CCMP:
212 case WLAN_CIPHER_SUITE_CCMP_256:
213 case WLAN_CIPHER_SUITE_AES_CMAC:
214 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
215 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
216 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
217 case WLAN_CIPHER_SUITE_GCMP:
218 case WLAN_CIPHER_SUITE_GCMP_256:
219 /* all of these we can do in software - if driver can */
222 if (ieee80211_hw_check(&key->local->hw, SW_CRYPTO_CONTROL))
230 static void ieee80211_key_disable_hw_accel(struct ieee80211_key *key)
232 struct ieee80211_sub_if_data *sdata;
233 struct sta_info *sta;
238 if (!key || !key->local->ops->set_key)
241 assert_key_lock(key->local);
243 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
249 if (!(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
250 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
251 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
252 increment_tailroom_need_count(sdata);
254 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
255 ret = drv_set_key(key->local, DISABLE_KEY, sdata,
256 sta ? &sta->sta : NULL, &key->conf);
260 "failed to remove key (%d, %pM) from hardware (%d)\n",
262 sta ? sta->sta.addr : bcast_addr, ret);
265 static int _ieee80211_set_tx_key(struct ieee80211_key *key, bool force)
267 struct sta_info *sta = key->sta;
268 struct ieee80211_local *local = key->local;
270 assert_key_lock(local);
272 set_sta_flag(sta, WLAN_STA_USES_ENCRYPTION);
274 sta->ptk_idx = key->conf.keyidx;
276 if (force || !ieee80211_hw_check(&local->hw, AMPDU_KEYBORDER_SUPPORT))
277 clear_sta_flag(sta, WLAN_STA_BLOCK_BA);
278 ieee80211_check_fast_xmit(sta);
283 int ieee80211_set_tx_key(struct ieee80211_key *key)
285 return _ieee80211_set_tx_key(key, false);
288 static void ieee80211_pairwise_rekey(struct ieee80211_key *old,
289 struct ieee80211_key *new)
291 struct ieee80211_local *local = new->local;
292 struct sta_info *sta = new->sta;
295 assert_key_lock(local);
297 if (new->conf.flags & IEEE80211_KEY_FLAG_NO_AUTO_TX) {
298 /* Extended Key ID key install, initial one or rekey */
300 if (sta->ptk_idx != INVALID_PTK_KEYIDX &&
301 !ieee80211_hw_check(&local->hw, AMPDU_KEYBORDER_SUPPORT)) {
302 /* Aggregation Sessions with Extended Key ID must not
303 * mix MPDUs with different keyIDs within one A-MPDU.
304 * Tear down running Tx aggregation sessions and block
305 * new Rx/Tx aggregation requests during rekey to
306 * ensure there are no A-MPDUs when the driver is not
307 * supporting A-MPDU key borders. (Blocking Tx only
308 * would be sufficient but WLAN_STA_BLOCK_BA gets the
309 * job done for the few ms we need it.)
311 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
312 mutex_lock(&sta->ampdu_mlme.mtx);
313 for (i = 0; i < IEEE80211_NUM_TIDS; i++)
314 ___ieee80211_stop_tx_ba_session(sta, i,
315 AGG_STOP_LOCAL_REQUEST);
316 mutex_unlock(&sta->ampdu_mlme.mtx);
319 /* Rekey without Extended Key ID.
320 * Aggregation sessions are OK when running on SW crypto.
321 * A broken remote STA may cause issues not observed with HW
324 if (!(old->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
327 /* Stop Tx till we are on the new key */
328 old->flags |= KEY_FLAG_TAINTED;
329 ieee80211_clear_fast_xmit(sta);
330 if (ieee80211_hw_check(&local->hw, AMPDU_AGGREGATION)) {
331 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
332 ieee80211_sta_tear_down_BA_sessions(sta,
333 AGG_STOP_LOCAL_REQUEST);
335 if (!wiphy_ext_feature_isset(local->hw.wiphy,
336 NL80211_EXT_FEATURE_CAN_REPLACE_PTK0)) {
337 pr_warn_ratelimited("Rekeying PTK for STA %pM but driver can't safely do that.",
339 /* Flushing the driver queues *may* help prevent
340 * the clear text leaks and freezes.
342 ieee80211_flush_queues(local, old->sdata, false);
347 static void __ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata,
348 int idx, bool uni, bool multi)
350 struct ieee80211_key *key = NULL;
352 assert_key_lock(sdata->local);
354 if (idx >= 0 && idx < NUM_DEFAULT_KEYS)
355 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
358 rcu_assign_pointer(sdata->default_unicast_key, key);
359 ieee80211_check_fast_xmit_iface(sdata);
360 if (sdata->vif.type != NL80211_IFTYPE_AP_VLAN)
361 drv_set_default_unicast_key(sdata->local, sdata, idx);
365 rcu_assign_pointer(sdata->default_multicast_key, key);
367 ieee80211_debugfs_key_update_default(sdata);
370 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
371 bool uni, bool multi)
373 mutex_lock(&sdata->local->key_mtx);
374 __ieee80211_set_default_key(sdata, idx, uni, multi);
375 mutex_unlock(&sdata->local->key_mtx);
379 __ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata, int idx)
381 struct ieee80211_key *key = NULL;
383 assert_key_lock(sdata->local);
385 if (idx >= NUM_DEFAULT_KEYS &&
386 idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS)
387 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
389 rcu_assign_pointer(sdata->default_mgmt_key, key);
391 ieee80211_debugfs_key_update_default(sdata);
394 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
397 mutex_lock(&sdata->local->key_mtx);
398 __ieee80211_set_default_mgmt_key(sdata, idx);
399 mutex_unlock(&sdata->local->key_mtx);
402 static int ieee80211_key_replace(struct ieee80211_sub_if_data *sdata,
403 struct sta_info *sta,
405 struct ieee80211_key *old,
406 struct ieee80211_key *new)
410 bool defunikey, defmultikey, defmgmtkey;
412 /* caller must provide at least one old/new */
413 if (WARN_ON(!new && !old))
417 list_add_tail_rcu(&new->list, &sdata->key_list);
419 WARN_ON(new && old && new->conf.keyidx != old->conf.keyidx);
421 if (new && sta && pairwise) {
422 /* Unicast rekey needs special handling. With Extended Key ID
423 * old is still NULL for the first rekey.
425 ieee80211_pairwise_rekey(old, new);
429 idx = old->conf.keyidx;
431 if (old->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
432 ieee80211_key_disable_hw_accel(old);
435 ret = ieee80211_key_enable_hw_accel(new);
438 /* new must be provided in case old is not */
439 idx = new->conf.keyidx;
440 if (!new->local->wowlan)
441 ret = ieee80211_key_enable_hw_accel(new);
449 rcu_assign_pointer(sta->ptk[idx], new);
451 !(new->conf.flags & IEEE80211_KEY_FLAG_NO_AUTO_TX))
452 _ieee80211_set_tx_key(new, true);
454 rcu_assign_pointer(sta->gtk[idx], new);
456 /* Only needed for transition from no key -> key.
457 * Still triggers unnecessary when using Extended Key ID
458 * and installing the second key ID the first time.
461 ieee80211_check_fast_rx(sta);
464 old == key_mtx_dereference(sdata->local,
465 sdata->default_unicast_key);
467 old == key_mtx_dereference(sdata->local,
468 sdata->default_multicast_key);
470 old == key_mtx_dereference(sdata->local,
471 sdata->default_mgmt_key);
473 if (defunikey && !new)
474 __ieee80211_set_default_key(sdata, -1, true, false);
475 if (defmultikey && !new)
476 __ieee80211_set_default_key(sdata, -1, false, true);
477 if (defmgmtkey && !new)
478 __ieee80211_set_default_mgmt_key(sdata, -1);
480 rcu_assign_pointer(sdata->keys[idx], new);
481 if (defunikey && new)
482 __ieee80211_set_default_key(sdata, new->conf.keyidx,
484 if (defmultikey && new)
485 __ieee80211_set_default_key(sdata, new->conf.keyidx,
487 if (defmgmtkey && new)
488 __ieee80211_set_default_mgmt_key(sdata,
493 list_del_rcu(&old->list);
498 struct ieee80211_key *
499 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
501 size_t seq_len, const u8 *seq,
502 const struct ieee80211_cipher_scheme *cs)
504 struct ieee80211_key *key;
507 if (WARN_ON(idx < 0 || idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS))
508 return ERR_PTR(-EINVAL);
510 key = kzalloc(sizeof(struct ieee80211_key) + key_len, GFP_KERNEL);
512 return ERR_PTR(-ENOMEM);
515 * Default to software encryption; we'll later upload the
516 * key to the hardware if possible.
521 key->conf.cipher = cipher;
522 key->conf.keyidx = idx;
523 key->conf.keylen = key_len;
525 case WLAN_CIPHER_SUITE_WEP40:
526 case WLAN_CIPHER_SUITE_WEP104:
527 key->conf.iv_len = IEEE80211_WEP_IV_LEN;
528 key->conf.icv_len = IEEE80211_WEP_ICV_LEN;
530 case WLAN_CIPHER_SUITE_TKIP:
531 key->conf.iv_len = IEEE80211_TKIP_IV_LEN;
532 key->conf.icv_len = IEEE80211_TKIP_ICV_LEN;
534 for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
535 key->u.tkip.rx[i].iv32 =
536 get_unaligned_le32(&seq[2]);
537 key->u.tkip.rx[i].iv16 =
538 get_unaligned_le16(seq);
541 spin_lock_init(&key->u.tkip.txlock);
543 case WLAN_CIPHER_SUITE_CCMP:
544 key->conf.iv_len = IEEE80211_CCMP_HDR_LEN;
545 key->conf.icv_len = IEEE80211_CCMP_MIC_LEN;
547 for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
548 for (j = 0; j < IEEE80211_CCMP_PN_LEN; j++)
549 key->u.ccmp.rx_pn[i][j] =
550 seq[IEEE80211_CCMP_PN_LEN - j - 1];
553 * Initialize AES key state here as an optimization so that
554 * it does not need to be initialized for every packet.
556 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
557 key_data, key_len, IEEE80211_CCMP_MIC_LEN);
558 if (IS_ERR(key->u.ccmp.tfm)) {
559 err = PTR_ERR(key->u.ccmp.tfm);
564 case WLAN_CIPHER_SUITE_CCMP_256:
565 key->conf.iv_len = IEEE80211_CCMP_256_HDR_LEN;
566 key->conf.icv_len = IEEE80211_CCMP_256_MIC_LEN;
567 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
568 for (j = 0; j < IEEE80211_CCMP_256_PN_LEN; j++)
569 key->u.ccmp.rx_pn[i][j] =
570 seq[IEEE80211_CCMP_256_PN_LEN - j - 1];
571 /* Initialize AES key state here as an optimization so that
572 * it does not need to be initialized for every packet.
574 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
575 key_data, key_len, IEEE80211_CCMP_256_MIC_LEN);
576 if (IS_ERR(key->u.ccmp.tfm)) {
577 err = PTR_ERR(key->u.ccmp.tfm);
582 case WLAN_CIPHER_SUITE_AES_CMAC:
583 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
584 key->conf.iv_len = 0;
585 if (cipher == WLAN_CIPHER_SUITE_AES_CMAC)
586 key->conf.icv_len = sizeof(struct ieee80211_mmie);
588 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
590 for (j = 0; j < IEEE80211_CMAC_PN_LEN; j++)
591 key->u.aes_cmac.rx_pn[j] =
592 seq[IEEE80211_CMAC_PN_LEN - j - 1];
594 * Initialize AES key state here as an optimization so that
595 * it does not need to be initialized for every packet.
597 key->u.aes_cmac.tfm =
598 ieee80211_aes_cmac_key_setup(key_data, key_len);
599 if (IS_ERR(key->u.aes_cmac.tfm)) {
600 err = PTR_ERR(key->u.aes_cmac.tfm);
605 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
606 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
607 key->conf.iv_len = 0;
608 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
610 for (j = 0; j < IEEE80211_GMAC_PN_LEN; j++)
611 key->u.aes_gmac.rx_pn[j] =
612 seq[IEEE80211_GMAC_PN_LEN - j - 1];
613 /* Initialize AES key state here as an optimization so that
614 * it does not need to be initialized for every packet.
616 key->u.aes_gmac.tfm =
617 ieee80211_aes_gmac_key_setup(key_data, key_len);
618 if (IS_ERR(key->u.aes_gmac.tfm)) {
619 err = PTR_ERR(key->u.aes_gmac.tfm);
624 case WLAN_CIPHER_SUITE_GCMP:
625 case WLAN_CIPHER_SUITE_GCMP_256:
626 key->conf.iv_len = IEEE80211_GCMP_HDR_LEN;
627 key->conf.icv_len = IEEE80211_GCMP_MIC_LEN;
628 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
629 for (j = 0; j < IEEE80211_GCMP_PN_LEN; j++)
630 key->u.gcmp.rx_pn[i][j] =
631 seq[IEEE80211_GCMP_PN_LEN - j - 1];
632 /* Initialize AES key state here as an optimization so that
633 * it does not need to be initialized for every packet.
635 key->u.gcmp.tfm = ieee80211_aes_gcm_key_setup_encrypt(key_data,
637 if (IS_ERR(key->u.gcmp.tfm)) {
638 err = PTR_ERR(key->u.gcmp.tfm);
645 if (seq_len && seq_len != cs->pn_len) {
647 return ERR_PTR(-EINVAL);
650 key->conf.iv_len = cs->hdr_len;
651 key->conf.icv_len = cs->mic_len;
652 for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
653 for (j = 0; j < seq_len; j++)
654 key->u.gen.rx_pn[i][j] =
655 seq[seq_len - j - 1];
656 key->flags |= KEY_FLAG_CIPHER_SCHEME;
659 memcpy(key->conf.key, key_data, key_len);
660 INIT_LIST_HEAD(&key->list);
665 static void ieee80211_key_free_common(struct ieee80211_key *key)
667 switch (key->conf.cipher) {
668 case WLAN_CIPHER_SUITE_CCMP:
669 case WLAN_CIPHER_SUITE_CCMP_256:
670 ieee80211_aes_key_free(key->u.ccmp.tfm);
672 case WLAN_CIPHER_SUITE_AES_CMAC:
673 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
674 ieee80211_aes_cmac_key_free(key->u.aes_cmac.tfm);
676 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
677 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
678 ieee80211_aes_gmac_key_free(key->u.aes_gmac.tfm);
680 case WLAN_CIPHER_SUITE_GCMP:
681 case WLAN_CIPHER_SUITE_GCMP_256:
682 ieee80211_aes_gcm_key_free(key->u.gcmp.tfm);
688 static void __ieee80211_key_destroy(struct ieee80211_key *key,
692 struct ieee80211_sub_if_data *sdata = key->sdata;
694 ieee80211_debugfs_key_remove(key);
696 if (delay_tailroom) {
697 /* see ieee80211_delayed_tailroom_dec */
698 sdata->crypto_tx_tailroom_pending_dec++;
699 schedule_delayed_work(&sdata->dec_tailroom_needed_wk,
702 decrease_tailroom_need_count(sdata, 1);
706 ieee80211_key_free_common(key);
709 static void ieee80211_key_destroy(struct ieee80211_key *key,
716 * Synchronize so the TX path and rcu key iterators
717 * can no longer be using this key before we free/remove it.
721 __ieee80211_key_destroy(key, delay_tailroom);
724 void ieee80211_key_free_unused(struct ieee80211_key *key)
726 WARN_ON(key->sdata || key->local);
727 ieee80211_key_free_common(key);
730 static bool ieee80211_key_identical(struct ieee80211_sub_if_data *sdata,
731 struct ieee80211_key *old,
732 struct ieee80211_key *new)
734 u8 tkip_old[WLAN_KEY_LEN_TKIP], tkip_new[WLAN_KEY_LEN_TKIP];
737 if (!old || new->conf.keylen != old->conf.keylen)
740 tk_old = old->conf.key;
741 tk_new = new->conf.key;
744 * In station mode, don't compare the TX MIC key, as it's never used
745 * and offloaded rekeying may not care to send it to the host. This
746 * is the case in iwlwifi, for example.
748 if (sdata->vif.type == NL80211_IFTYPE_STATION &&
749 new->conf.cipher == WLAN_CIPHER_SUITE_TKIP &&
750 new->conf.keylen == WLAN_KEY_LEN_TKIP &&
751 !(new->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
752 memcpy(tkip_old, tk_old, WLAN_KEY_LEN_TKIP);
753 memcpy(tkip_new, tk_new, WLAN_KEY_LEN_TKIP);
754 memset(tkip_old + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
755 memset(tkip_new + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
760 return !crypto_memneq(tk_old, tk_new, new->conf.keylen);
763 int ieee80211_key_link(struct ieee80211_key *key,
764 struct ieee80211_sub_if_data *sdata,
765 struct sta_info *sta)
767 static atomic_t key_color = ATOMIC_INIT(0);
768 struct ieee80211_key *old_key;
769 int idx = key->conf.keyidx;
770 bool pairwise = key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE;
772 * We want to delay tailroom updates only for station - in that
773 * case it helps roaming speed, but in other cases it hurts and
774 * can cause warnings to appear.
776 bool delay_tailroom = sdata->vif.type == NL80211_IFTYPE_STATION;
777 int ret = -EOPNOTSUPP;
779 mutex_lock(&sdata->local->key_mtx);
781 if (sta && pairwise) {
782 struct ieee80211_key *alt_key;
784 old_key = key_mtx_dereference(sdata->local, sta->ptk[idx]);
785 alt_key = key_mtx_dereference(sdata->local, sta->ptk[idx ^ 1]);
787 /* The rekey code assumes that the old and new key are using
788 * the same cipher. Enforce the assumption for pairwise keys.
790 if ((alt_key && alt_key->conf.cipher != key->conf.cipher) ||
791 (old_key && old_key->conf.cipher != key->conf.cipher))
794 old_key = key_mtx_dereference(sdata->local, sta->gtk[idx]);
796 old_key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
799 /* Non-pairwise keys must also not switch the cipher on rekey */
801 if (old_key && old_key->conf.cipher != key->conf.cipher)
806 * Silently accept key re-installation without really installing the
807 * new version of the key to avoid nonce reuse or replay issues.
809 if (ieee80211_key_identical(sdata, old_key, key)) {
810 ieee80211_key_free_unused(key);
815 key->local = sdata->local;
820 * Assign a unique ID to every key so we can easily prevent mixed
821 * key and fragment cache attacks.
823 key->color = atomic_inc_return(&key_color);
825 increment_tailroom_need_count(sdata);
827 ret = ieee80211_key_replace(sdata, sta, pairwise, old_key, key);
830 ieee80211_debugfs_key_add(key);
831 ieee80211_key_destroy(old_key, delay_tailroom);
833 ieee80211_key_free(key, delay_tailroom);
837 mutex_unlock(&sdata->local->key_mtx);
842 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom)
848 * Replace key with nothingness if it was ever used.
851 ieee80211_key_replace(key->sdata, key->sta,
852 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
854 ieee80211_key_destroy(key, delay_tailroom);
857 void ieee80211_reenable_keys(struct ieee80211_sub_if_data *sdata)
859 struct ieee80211_key *key;
860 struct ieee80211_sub_if_data *vlan;
864 mutex_lock(&sdata->local->key_mtx);
866 sdata->crypto_tx_tailroom_needed_cnt = 0;
867 sdata->crypto_tx_tailroom_pending_dec = 0;
869 if (sdata->vif.type == NL80211_IFTYPE_AP) {
870 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list) {
871 vlan->crypto_tx_tailroom_needed_cnt = 0;
872 vlan->crypto_tx_tailroom_pending_dec = 0;
876 if (ieee80211_sdata_running(sdata)) {
877 list_for_each_entry(key, &sdata->key_list, list) {
878 increment_tailroom_need_count(sdata);
879 ieee80211_key_enable_hw_accel(key);
883 mutex_unlock(&sdata->local->key_mtx);
886 void ieee80211_iter_keys(struct ieee80211_hw *hw,
887 struct ieee80211_vif *vif,
888 void (*iter)(struct ieee80211_hw *hw,
889 struct ieee80211_vif *vif,
890 struct ieee80211_sta *sta,
891 struct ieee80211_key_conf *key,
895 struct ieee80211_local *local = hw_to_local(hw);
896 struct ieee80211_key *key, *tmp;
897 struct ieee80211_sub_if_data *sdata;
901 mutex_lock(&local->key_mtx);
903 sdata = vif_to_sdata(vif);
904 list_for_each_entry_safe(key, tmp, &sdata->key_list, list)
905 iter(hw, &sdata->vif,
906 key->sta ? &key->sta->sta : NULL,
907 &key->conf, iter_data);
909 list_for_each_entry(sdata, &local->interfaces, list)
910 list_for_each_entry_safe(key, tmp,
911 &sdata->key_list, list)
912 iter(hw, &sdata->vif,
913 key->sta ? &key->sta->sta : NULL,
914 &key->conf, iter_data);
916 mutex_unlock(&local->key_mtx);
918 EXPORT_SYMBOL(ieee80211_iter_keys);
921 _ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
922 struct ieee80211_sub_if_data *sdata,
923 void (*iter)(struct ieee80211_hw *hw,
924 struct ieee80211_vif *vif,
925 struct ieee80211_sta *sta,
926 struct ieee80211_key_conf *key,
930 struct ieee80211_key *key;
932 list_for_each_entry_rcu(key, &sdata->key_list, list) {
933 /* skip keys of station in removal process */
934 if (key->sta && key->sta->removed)
936 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
939 iter(hw, &sdata->vif,
940 key->sta ? &key->sta->sta : NULL,
941 &key->conf, iter_data);
945 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
946 struct ieee80211_vif *vif,
947 void (*iter)(struct ieee80211_hw *hw,
948 struct ieee80211_vif *vif,
949 struct ieee80211_sta *sta,
950 struct ieee80211_key_conf *key,
954 struct ieee80211_local *local = hw_to_local(hw);
955 struct ieee80211_sub_if_data *sdata;
958 sdata = vif_to_sdata(vif);
959 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
961 list_for_each_entry_rcu(sdata, &local->interfaces, list)
962 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
965 EXPORT_SYMBOL(ieee80211_iter_keys_rcu);
967 static void ieee80211_free_keys_iface(struct ieee80211_sub_if_data *sdata,
968 struct list_head *keys)
970 struct ieee80211_key *key, *tmp;
972 decrease_tailroom_need_count(sdata,
973 sdata->crypto_tx_tailroom_pending_dec);
974 sdata->crypto_tx_tailroom_pending_dec = 0;
976 ieee80211_debugfs_key_remove_mgmt_default(sdata);
978 list_for_each_entry_safe(key, tmp, &sdata->key_list, list) {
979 ieee80211_key_replace(key->sdata, key->sta,
980 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
982 list_add_tail(&key->list, keys);
985 ieee80211_debugfs_key_update_default(sdata);
988 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
989 bool force_synchronize)
991 struct ieee80211_local *local = sdata->local;
992 struct ieee80211_sub_if_data *vlan;
993 struct ieee80211_sub_if_data *master;
994 struct ieee80211_key *key, *tmp;
997 cancel_delayed_work_sync(&sdata->dec_tailroom_needed_wk);
999 mutex_lock(&local->key_mtx);
1001 ieee80211_free_keys_iface(sdata, &keys);
1003 if (sdata->vif.type == NL80211_IFTYPE_AP) {
1004 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
1005 ieee80211_free_keys_iface(vlan, &keys);
1008 if (!list_empty(&keys) || force_synchronize)
1010 list_for_each_entry_safe(key, tmp, &keys, list)
1011 __ieee80211_key_destroy(key, false);
1013 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
1015 master = container_of(sdata->bss,
1016 struct ieee80211_sub_if_data,
1019 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt !=
1020 master->crypto_tx_tailroom_needed_cnt);
1023 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
1024 sdata->crypto_tx_tailroom_pending_dec);
1027 if (sdata->vif.type == NL80211_IFTYPE_AP) {
1028 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
1029 WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
1030 vlan->crypto_tx_tailroom_pending_dec);
1033 mutex_unlock(&local->key_mtx);
1036 void ieee80211_free_sta_keys(struct ieee80211_local *local,
1037 struct sta_info *sta)
1039 struct ieee80211_key *key;
1042 mutex_lock(&local->key_mtx);
1043 for (i = 0; i < ARRAY_SIZE(sta->gtk); i++) {
1044 key = key_mtx_dereference(local, sta->gtk[i]);
1047 ieee80211_key_replace(key->sdata, key->sta,
1048 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
1050 __ieee80211_key_destroy(key, key->sdata->vif.type ==
1051 NL80211_IFTYPE_STATION);
1054 for (i = 0; i < NUM_DEFAULT_KEYS; i++) {
1055 key = key_mtx_dereference(local, sta->ptk[i]);
1058 ieee80211_key_replace(key->sdata, key->sta,
1059 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
1061 __ieee80211_key_destroy(key, key->sdata->vif.type ==
1062 NL80211_IFTYPE_STATION);
1065 mutex_unlock(&local->key_mtx);
1068 void ieee80211_delayed_tailroom_dec(struct work_struct *wk)
1070 struct ieee80211_sub_if_data *sdata;
1072 sdata = container_of(wk, struct ieee80211_sub_if_data,
1073 dec_tailroom_needed_wk.work);
1076 * The reason for the delayed tailroom needed decrementing is to
1077 * make roaming faster: during roaming, all keys are first deleted
1078 * and then new keys are installed. The first new key causes the
1079 * crypto_tx_tailroom_needed_cnt to go from 0 to 1, which invokes
1080 * the cost of synchronize_net() (which can be slow). Avoid this
1081 * by deferring the crypto_tx_tailroom_needed_cnt decrementing on
1082 * key removal for a while, so if we roam the value is larger than
1083 * zero and no 0->1 transition happens.
1085 * The cost is that if the AP switching was from an AP with keys
1086 * to one without, we still allocate tailroom while it would no
1087 * longer be needed. However, in the typical (fast) roaming case
1088 * within an ESS this usually won't happen.
1091 mutex_lock(&sdata->local->key_mtx);
1092 decrease_tailroom_need_count(sdata,
1093 sdata->crypto_tx_tailroom_pending_dec);
1094 sdata->crypto_tx_tailroom_pending_dec = 0;
1095 mutex_unlock(&sdata->local->key_mtx);
1098 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
1099 const u8 *replay_ctr, gfp_t gfp)
1101 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1103 trace_api_gtk_rekey_notify(sdata, bssid, replay_ctr);
1105 cfg80211_gtk_rekey_notify(sdata->dev, bssid, replay_ctr, gfp);
1107 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_notify);
1109 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
1110 int tid, struct ieee80211_key_seq *seq)
1112 struct ieee80211_key *key;
1115 key = container_of(keyconf, struct ieee80211_key, conf);
1117 switch (key->conf.cipher) {
1118 case WLAN_CIPHER_SUITE_TKIP:
1119 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1121 seq->tkip.iv32 = key->u.tkip.rx[tid].iv32;
1122 seq->tkip.iv16 = key->u.tkip.rx[tid].iv16;
1124 case WLAN_CIPHER_SUITE_CCMP:
1125 case WLAN_CIPHER_SUITE_CCMP_256:
1126 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1129 pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1131 pn = key->u.ccmp.rx_pn[tid];
1132 memcpy(seq->ccmp.pn, pn, IEEE80211_CCMP_PN_LEN);
1134 case WLAN_CIPHER_SUITE_AES_CMAC:
1135 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1136 if (WARN_ON(tid != 0))
1138 pn = key->u.aes_cmac.rx_pn;
1139 memcpy(seq->aes_cmac.pn, pn, IEEE80211_CMAC_PN_LEN);
1141 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1142 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1143 if (WARN_ON(tid != 0))
1145 pn = key->u.aes_gmac.rx_pn;
1146 memcpy(seq->aes_gmac.pn, pn, IEEE80211_GMAC_PN_LEN);
1148 case WLAN_CIPHER_SUITE_GCMP:
1149 case WLAN_CIPHER_SUITE_GCMP_256:
1150 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1153 pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1155 pn = key->u.gcmp.rx_pn[tid];
1156 memcpy(seq->gcmp.pn, pn, IEEE80211_GCMP_PN_LEN);
1160 EXPORT_SYMBOL(ieee80211_get_key_rx_seq);
1162 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
1163 int tid, struct ieee80211_key_seq *seq)
1165 struct ieee80211_key *key;
1168 key = container_of(keyconf, struct ieee80211_key, conf);
1170 switch (key->conf.cipher) {
1171 case WLAN_CIPHER_SUITE_TKIP:
1172 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1174 key->u.tkip.rx[tid].iv32 = seq->tkip.iv32;
1175 key->u.tkip.rx[tid].iv16 = seq->tkip.iv16;
1177 case WLAN_CIPHER_SUITE_CCMP:
1178 case WLAN_CIPHER_SUITE_CCMP_256:
1179 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1182 pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1184 pn = key->u.ccmp.rx_pn[tid];
1185 memcpy(pn, seq->ccmp.pn, IEEE80211_CCMP_PN_LEN);
1187 case WLAN_CIPHER_SUITE_AES_CMAC:
1188 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1189 if (WARN_ON(tid != 0))
1191 pn = key->u.aes_cmac.rx_pn;
1192 memcpy(pn, seq->aes_cmac.pn, IEEE80211_CMAC_PN_LEN);
1194 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1195 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1196 if (WARN_ON(tid != 0))
1198 pn = key->u.aes_gmac.rx_pn;
1199 memcpy(pn, seq->aes_gmac.pn, IEEE80211_GMAC_PN_LEN);
1201 case WLAN_CIPHER_SUITE_GCMP:
1202 case WLAN_CIPHER_SUITE_GCMP_256:
1203 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1206 pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1208 pn = key->u.gcmp.rx_pn[tid];
1209 memcpy(pn, seq->gcmp.pn, IEEE80211_GCMP_PN_LEN);
1216 EXPORT_SYMBOL_GPL(ieee80211_set_key_rx_seq);
1218 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf)
1220 struct ieee80211_key *key;
1222 key = container_of(keyconf, struct ieee80211_key, conf);
1224 assert_key_lock(key->local);
1227 * if key was uploaded, we assume the driver will/has remove(d)
1228 * it, so adjust bookkeeping accordingly
1230 if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
1231 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
1233 if (!(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
1234 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
1235 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
1236 increment_tailroom_need_count(key->sdata);
1239 ieee80211_key_free(key, false);
1241 EXPORT_SYMBOL_GPL(ieee80211_remove_key);
1243 struct ieee80211_key_conf *
1244 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
1245 struct ieee80211_key_conf *keyconf)
1247 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1248 struct ieee80211_local *local = sdata->local;
1249 struct ieee80211_key *key;
1252 if (WARN_ON(!local->wowlan))
1253 return ERR_PTR(-EINVAL);
1255 if (WARN_ON(vif->type != NL80211_IFTYPE_STATION))
1256 return ERR_PTR(-EINVAL);
1258 key = ieee80211_key_alloc(keyconf->cipher, keyconf->keyidx,
1259 keyconf->keylen, keyconf->key,
1262 return ERR_CAST(key);
1264 if (sdata->u.mgd.mfp != IEEE80211_MFP_DISABLED)
1265 key->conf.flags |= IEEE80211_KEY_FLAG_RX_MGMT;
1267 err = ieee80211_key_link(key, sdata, NULL);
1269 return ERR_PTR(err);
1273 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_add);