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 = key->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;
165 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
167 * The driver doesn't know anything about VLAN interfaces.
168 * Hence, don't send GTKs for VLAN interfaces to the driver.
170 if (!(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
172 goto out_unsupported;
176 ret = drv_set_key(key->local, SET_KEY, sdata,
177 sta ? &sta->sta : NULL, &key->conf);
180 key->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
182 if (!((key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
183 IEEE80211_KEY_FLAG_PUT_MIC_SPACE)) ||
184 (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
185 decrease_tailroom_need_count(sdata, 1);
187 WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_IV_SPACE) &&
188 (key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_IV));
190 WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_MIC_SPACE) &&
191 (key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC));
196 if (ret != -ENOSPC && ret != -EOPNOTSUPP && ret != 1)
198 "failed to set key (%d, %pM) to hardware (%d)\n",
200 sta ? sta->sta.addr : bcast_addr, ret);
203 switch (key->conf.cipher) {
204 case WLAN_CIPHER_SUITE_WEP40:
205 case WLAN_CIPHER_SUITE_WEP104:
206 case WLAN_CIPHER_SUITE_TKIP:
207 case WLAN_CIPHER_SUITE_CCMP:
208 case WLAN_CIPHER_SUITE_CCMP_256:
209 case WLAN_CIPHER_SUITE_AES_CMAC:
210 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
211 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
212 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
213 case WLAN_CIPHER_SUITE_GCMP:
214 case WLAN_CIPHER_SUITE_GCMP_256:
215 /* all of these we can do in software - if driver can */
218 if (ieee80211_hw_check(&key->local->hw, SW_CRYPTO_CONTROL))
226 static void ieee80211_key_disable_hw_accel(struct ieee80211_key *key)
228 struct ieee80211_sub_if_data *sdata;
229 struct sta_info *sta;
234 if (!key || !key->local->ops->set_key)
237 assert_key_lock(key->local);
239 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
245 if (!((key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
246 IEEE80211_KEY_FLAG_PUT_MIC_SPACE)) ||
247 (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
248 increment_tailroom_need_count(sdata);
250 ret = drv_set_key(key->local, DISABLE_KEY, sdata,
251 sta ? &sta->sta : NULL, &key->conf);
255 "failed to remove key (%d, %pM) from hardware (%d)\n",
257 sta ? sta->sta.addr : bcast_addr, ret);
259 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
262 static void __ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata,
263 int idx, bool uni, bool multi)
265 struct ieee80211_key *key = NULL;
267 assert_key_lock(sdata->local);
269 if (idx >= 0 && idx < NUM_DEFAULT_KEYS)
270 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
273 rcu_assign_pointer(sdata->default_unicast_key, key);
274 ieee80211_check_fast_xmit_iface(sdata);
275 if (sdata->vif.type != NL80211_IFTYPE_AP_VLAN)
276 drv_set_default_unicast_key(sdata->local, sdata, idx);
280 rcu_assign_pointer(sdata->default_multicast_key, key);
282 ieee80211_debugfs_key_update_default(sdata);
285 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
286 bool uni, bool multi)
288 mutex_lock(&sdata->local->key_mtx);
289 __ieee80211_set_default_key(sdata, idx, uni, multi);
290 mutex_unlock(&sdata->local->key_mtx);
294 __ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata, int idx)
296 struct ieee80211_key *key = NULL;
298 assert_key_lock(sdata->local);
300 if (idx >= NUM_DEFAULT_KEYS &&
301 idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS)
302 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
304 rcu_assign_pointer(sdata->default_mgmt_key, key);
306 ieee80211_debugfs_key_update_default(sdata);
309 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
312 mutex_lock(&sdata->local->key_mtx);
313 __ieee80211_set_default_mgmt_key(sdata, idx);
314 mutex_unlock(&sdata->local->key_mtx);
318 static void ieee80211_key_replace(struct ieee80211_sub_if_data *sdata,
319 struct sta_info *sta,
321 struct ieee80211_key *old,
322 struct ieee80211_key *new)
325 bool defunikey, defmultikey, defmgmtkey;
327 /* caller must provide at least one old/new */
328 if (WARN_ON(!new && !old))
332 list_add_tail_rcu(&new->list, &sdata->key_list);
334 WARN_ON(new && old && new->conf.keyidx != old->conf.keyidx);
337 idx = old->conf.keyidx;
339 idx = new->conf.keyidx;
343 rcu_assign_pointer(sta->ptk[idx], new);
344 set_sta_flag(sta, WLAN_STA_USES_ENCRYPTION);
346 ieee80211_check_fast_xmit(sta);
348 rcu_assign_pointer(sta->gtk[idx], new);
350 ieee80211_check_fast_rx(sta);
353 old == key_mtx_dereference(sdata->local,
354 sdata->default_unicast_key);
356 old == key_mtx_dereference(sdata->local,
357 sdata->default_multicast_key);
359 old == key_mtx_dereference(sdata->local,
360 sdata->default_mgmt_key);
362 if (defunikey && !new)
363 __ieee80211_set_default_key(sdata, -1, true, false);
364 if (defmultikey && !new)
365 __ieee80211_set_default_key(sdata, -1, false, true);
366 if (defmgmtkey && !new)
367 __ieee80211_set_default_mgmt_key(sdata, -1);
369 rcu_assign_pointer(sdata->keys[idx], new);
370 if (defunikey && new)
371 __ieee80211_set_default_key(sdata, new->conf.keyidx,
373 if (defmultikey && new)
374 __ieee80211_set_default_key(sdata, new->conf.keyidx,
376 if (defmgmtkey && new)
377 __ieee80211_set_default_mgmt_key(sdata,
382 list_del_rcu(&old->list);
385 struct ieee80211_key *
386 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
388 size_t seq_len, const u8 *seq,
389 const struct ieee80211_cipher_scheme *cs)
391 struct ieee80211_key *key;
394 if (WARN_ON(idx < 0 || idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS))
395 return ERR_PTR(-EINVAL);
397 key = kzalloc(sizeof(struct ieee80211_key) + key_len, GFP_KERNEL);
399 return ERR_PTR(-ENOMEM);
402 * Default to software encryption; we'll later upload the
403 * key to the hardware if possible.
408 key->conf.cipher = cipher;
409 key->conf.keyidx = idx;
410 key->conf.keylen = key_len;
412 case WLAN_CIPHER_SUITE_WEP40:
413 case WLAN_CIPHER_SUITE_WEP104:
414 key->conf.iv_len = IEEE80211_WEP_IV_LEN;
415 key->conf.icv_len = IEEE80211_WEP_ICV_LEN;
417 case WLAN_CIPHER_SUITE_TKIP:
418 key->conf.iv_len = IEEE80211_TKIP_IV_LEN;
419 key->conf.icv_len = IEEE80211_TKIP_ICV_LEN;
421 for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
422 key->u.tkip.rx[i].iv32 =
423 get_unaligned_le32(&seq[2]);
424 key->u.tkip.rx[i].iv16 =
425 get_unaligned_le16(seq);
428 spin_lock_init(&key->u.tkip.txlock);
430 case WLAN_CIPHER_SUITE_CCMP:
431 key->conf.iv_len = IEEE80211_CCMP_HDR_LEN;
432 key->conf.icv_len = IEEE80211_CCMP_MIC_LEN;
434 for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
435 for (j = 0; j < IEEE80211_CCMP_PN_LEN; j++)
436 key->u.ccmp.rx_pn[i][j] =
437 seq[IEEE80211_CCMP_PN_LEN - j - 1];
440 * Initialize AES key state here as an optimization so that
441 * it does not need to be initialized for every packet.
443 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
444 key_data, key_len, IEEE80211_CCMP_MIC_LEN);
445 if (IS_ERR(key->u.ccmp.tfm)) {
446 err = PTR_ERR(key->u.ccmp.tfm);
451 case WLAN_CIPHER_SUITE_CCMP_256:
452 key->conf.iv_len = IEEE80211_CCMP_256_HDR_LEN;
453 key->conf.icv_len = IEEE80211_CCMP_256_MIC_LEN;
454 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
455 for (j = 0; j < IEEE80211_CCMP_256_PN_LEN; j++)
456 key->u.ccmp.rx_pn[i][j] =
457 seq[IEEE80211_CCMP_256_PN_LEN - j - 1];
458 /* Initialize AES key state here as an optimization so that
459 * it does not need to be initialized for every packet.
461 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
462 key_data, key_len, IEEE80211_CCMP_256_MIC_LEN);
463 if (IS_ERR(key->u.ccmp.tfm)) {
464 err = PTR_ERR(key->u.ccmp.tfm);
469 case WLAN_CIPHER_SUITE_AES_CMAC:
470 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
471 key->conf.iv_len = 0;
472 if (cipher == WLAN_CIPHER_SUITE_AES_CMAC)
473 key->conf.icv_len = sizeof(struct ieee80211_mmie);
475 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
477 for (j = 0; j < IEEE80211_CMAC_PN_LEN; j++)
478 key->u.aes_cmac.rx_pn[j] =
479 seq[IEEE80211_CMAC_PN_LEN - j - 1];
481 * Initialize AES key state here as an optimization so that
482 * it does not need to be initialized for every packet.
484 key->u.aes_cmac.tfm =
485 ieee80211_aes_cmac_key_setup(key_data, key_len);
486 if (IS_ERR(key->u.aes_cmac.tfm)) {
487 err = PTR_ERR(key->u.aes_cmac.tfm);
492 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
493 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
494 key->conf.iv_len = 0;
495 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
497 for (j = 0; j < IEEE80211_GMAC_PN_LEN; j++)
498 key->u.aes_gmac.rx_pn[j] =
499 seq[IEEE80211_GMAC_PN_LEN - j - 1];
500 /* Initialize AES key state here as an optimization so that
501 * it does not need to be initialized for every packet.
503 key->u.aes_gmac.tfm =
504 ieee80211_aes_gmac_key_setup(key_data, key_len);
505 if (IS_ERR(key->u.aes_gmac.tfm)) {
506 err = PTR_ERR(key->u.aes_gmac.tfm);
511 case WLAN_CIPHER_SUITE_GCMP:
512 case WLAN_CIPHER_SUITE_GCMP_256:
513 key->conf.iv_len = IEEE80211_GCMP_HDR_LEN;
514 key->conf.icv_len = IEEE80211_GCMP_MIC_LEN;
515 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
516 for (j = 0; j < IEEE80211_GCMP_PN_LEN; j++)
517 key->u.gcmp.rx_pn[i][j] =
518 seq[IEEE80211_GCMP_PN_LEN - j - 1];
519 /* Initialize AES key state here as an optimization so that
520 * it does not need to be initialized for every packet.
522 key->u.gcmp.tfm = ieee80211_aes_gcm_key_setup_encrypt(key_data,
524 if (IS_ERR(key->u.gcmp.tfm)) {
525 err = PTR_ERR(key->u.gcmp.tfm);
532 if (seq_len && seq_len != cs->pn_len) {
534 return ERR_PTR(-EINVAL);
537 key->conf.iv_len = cs->hdr_len;
538 key->conf.icv_len = cs->mic_len;
539 for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
540 for (j = 0; j < seq_len; j++)
541 key->u.gen.rx_pn[i][j] =
542 seq[seq_len - j - 1];
543 key->flags |= KEY_FLAG_CIPHER_SCHEME;
546 memcpy(key->conf.key, key_data, key_len);
547 INIT_LIST_HEAD(&key->list);
552 static void ieee80211_key_free_common(struct ieee80211_key *key)
554 switch (key->conf.cipher) {
555 case WLAN_CIPHER_SUITE_CCMP:
556 case WLAN_CIPHER_SUITE_CCMP_256:
557 ieee80211_aes_key_free(key->u.ccmp.tfm);
559 case WLAN_CIPHER_SUITE_AES_CMAC:
560 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
561 ieee80211_aes_cmac_key_free(key->u.aes_cmac.tfm);
563 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
564 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
565 ieee80211_aes_gmac_key_free(key->u.aes_gmac.tfm);
567 case WLAN_CIPHER_SUITE_GCMP:
568 case WLAN_CIPHER_SUITE_GCMP_256:
569 ieee80211_aes_gcm_key_free(key->u.gcmp.tfm);
575 static void __ieee80211_key_destroy(struct ieee80211_key *key,
579 ieee80211_key_disable_hw_accel(key);
582 struct ieee80211_sub_if_data *sdata = key->sdata;
584 ieee80211_debugfs_key_remove(key);
586 if (delay_tailroom) {
587 /* see ieee80211_delayed_tailroom_dec */
588 sdata->crypto_tx_tailroom_pending_dec++;
589 schedule_delayed_work(&sdata->dec_tailroom_needed_wk,
592 decrease_tailroom_need_count(sdata, 1);
596 ieee80211_key_free_common(key);
599 static void ieee80211_key_destroy(struct ieee80211_key *key,
606 * Synchronize so the TX path and rcu key iterators
607 * can no longer be using this key before we free/remove it.
611 __ieee80211_key_destroy(key, delay_tailroom);
614 void ieee80211_key_free_unused(struct ieee80211_key *key)
616 WARN_ON(key->sdata || key->local);
617 ieee80211_key_free_common(key);
620 static bool ieee80211_key_identical(struct ieee80211_sub_if_data *sdata,
621 struct ieee80211_key *old,
622 struct ieee80211_key *new)
624 u8 tkip_old[WLAN_KEY_LEN_TKIP], tkip_new[WLAN_KEY_LEN_TKIP];
627 if (!old || new->conf.keylen != old->conf.keylen)
630 tk_old = old->conf.key;
631 tk_new = new->conf.key;
634 * In station mode, don't compare the TX MIC key, as it's never used
635 * and offloaded rekeying may not care to send it to the host. This
636 * is the case in iwlwifi, for example.
638 if (sdata->vif.type == NL80211_IFTYPE_STATION &&
639 new->conf.cipher == WLAN_CIPHER_SUITE_TKIP &&
640 new->conf.keylen == WLAN_KEY_LEN_TKIP &&
641 !(new->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
642 memcpy(tkip_old, tk_old, WLAN_KEY_LEN_TKIP);
643 memcpy(tkip_new, tk_new, WLAN_KEY_LEN_TKIP);
644 memset(tkip_old + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
645 memset(tkip_new + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
650 return !crypto_memneq(tk_old, tk_new, new->conf.keylen);
653 int ieee80211_key_link(struct ieee80211_key *key,
654 struct ieee80211_sub_if_data *sdata,
655 struct sta_info *sta)
657 static atomic_t key_color = ATOMIC_INIT(0);
658 struct ieee80211_local *local = sdata->local;
659 struct ieee80211_key *old_key;
660 int idx = key->conf.keyidx;
661 bool pairwise = key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE;
663 * We want to delay tailroom updates only for station - in that
664 * case it helps roaming speed, but in other cases it hurts and
665 * can cause warnings to appear.
667 bool delay_tailroom = sdata->vif.type == NL80211_IFTYPE_STATION;
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;
694 * Assign a unique ID to every key so we can easily prevent mixed
695 * key and fragment cache attacks.
697 key->color = atomic_inc_return(&key_color);
699 increment_tailroom_need_count(sdata);
701 ieee80211_key_replace(sdata, sta, pairwise, old_key, key);
702 ieee80211_key_destroy(old_key, delay_tailroom);
704 ieee80211_debugfs_key_add(key);
706 if (!local->wowlan) {
707 ret = ieee80211_key_enable_hw_accel(key);
709 ieee80211_key_free(key, delay_tailroom);
715 mutex_unlock(&sdata->local->key_mtx);
720 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom)
726 * Replace key with nothingness if it was ever used.
729 ieee80211_key_replace(key->sdata, key->sta,
730 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
732 ieee80211_key_destroy(key, delay_tailroom);
735 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata)
737 struct ieee80211_key *key;
738 struct ieee80211_sub_if_data *vlan;
742 if (WARN_ON(!ieee80211_sdata_running(sdata)))
745 mutex_lock(&sdata->local->key_mtx);
747 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
748 sdata->crypto_tx_tailroom_pending_dec);
750 if (sdata->vif.type == NL80211_IFTYPE_AP) {
751 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
752 WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
753 vlan->crypto_tx_tailroom_pending_dec);
756 list_for_each_entry(key, &sdata->key_list, list) {
757 increment_tailroom_need_count(sdata);
758 ieee80211_key_enable_hw_accel(key);
761 mutex_unlock(&sdata->local->key_mtx);
764 void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata)
766 struct ieee80211_sub_if_data *vlan;
768 mutex_lock(&sdata->local->key_mtx);
770 sdata->crypto_tx_tailroom_needed_cnt = 0;
772 if (sdata->vif.type == NL80211_IFTYPE_AP) {
773 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
774 vlan->crypto_tx_tailroom_needed_cnt = 0;
777 mutex_unlock(&sdata->local->key_mtx);
780 void ieee80211_iter_keys(struct ieee80211_hw *hw,
781 struct ieee80211_vif *vif,
782 void (*iter)(struct ieee80211_hw *hw,
783 struct ieee80211_vif *vif,
784 struct ieee80211_sta *sta,
785 struct ieee80211_key_conf *key,
789 struct ieee80211_local *local = hw_to_local(hw);
790 struct ieee80211_key *key, *tmp;
791 struct ieee80211_sub_if_data *sdata;
795 mutex_lock(&local->key_mtx);
797 sdata = vif_to_sdata(vif);
798 list_for_each_entry_safe(key, tmp, &sdata->key_list, list)
799 iter(hw, &sdata->vif,
800 key->sta ? &key->sta->sta : NULL,
801 &key->conf, iter_data);
803 list_for_each_entry(sdata, &local->interfaces, list)
804 list_for_each_entry_safe(key, tmp,
805 &sdata->key_list, list)
806 iter(hw, &sdata->vif,
807 key->sta ? &key->sta->sta : NULL,
808 &key->conf, iter_data);
810 mutex_unlock(&local->key_mtx);
812 EXPORT_SYMBOL(ieee80211_iter_keys);
815 _ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
816 struct ieee80211_sub_if_data *sdata,
817 void (*iter)(struct ieee80211_hw *hw,
818 struct ieee80211_vif *vif,
819 struct ieee80211_sta *sta,
820 struct ieee80211_key_conf *key,
824 struct ieee80211_key *key;
826 list_for_each_entry_rcu(key, &sdata->key_list, list) {
827 /* skip keys of station in removal process */
828 if (key->sta && key->sta->removed)
830 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
833 iter(hw, &sdata->vif,
834 key->sta ? &key->sta->sta : NULL,
835 &key->conf, iter_data);
839 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
840 struct ieee80211_vif *vif,
841 void (*iter)(struct ieee80211_hw *hw,
842 struct ieee80211_vif *vif,
843 struct ieee80211_sta *sta,
844 struct ieee80211_key_conf *key,
848 struct ieee80211_local *local = hw_to_local(hw);
849 struct ieee80211_sub_if_data *sdata;
852 sdata = vif_to_sdata(vif);
853 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
855 list_for_each_entry_rcu(sdata, &local->interfaces, list)
856 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
859 EXPORT_SYMBOL(ieee80211_iter_keys_rcu);
861 static void ieee80211_free_keys_iface(struct ieee80211_sub_if_data *sdata,
862 struct list_head *keys)
864 struct ieee80211_key *key, *tmp;
866 decrease_tailroom_need_count(sdata,
867 sdata->crypto_tx_tailroom_pending_dec);
868 sdata->crypto_tx_tailroom_pending_dec = 0;
870 ieee80211_debugfs_key_remove_mgmt_default(sdata);
872 list_for_each_entry_safe(key, tmp, &sdata->key_list, list) {
873 ieee80211_key_replace(key->sdata, key->sta,
874 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
876 list_add_tail(&key->list, keys);
879 ieee80211_debugfs_key_update_default(sdata);
882 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
883 bool force_synchronize)
885 struct ieee80211_local *local = sdata->local;
886 struct ieee80211_sub_if_data *vlan;
887 struct ieee80211_sub_if_data *master;
888 struct ieee80211_key *key, *tmp;
891 cancel_delayed_work_sync(&sdata->dec_tailroom_needed_wk);
893 mutex_lock(&local->key_mtx);
895 ieee80211_free_keys_iface(sdata, &keys);
897 if (sdata->vif.type == NL80211_IFTYPE_AP) {
898 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
899 ieee80211_free_keys_iface(vlan, &keys);
902 if (!list_empty(&keys) || force_synchronize)
904 list_for_each_entry_safe(key, tmp, &keys, list)
905 __ieee80211_key_destroy(key, false);
907 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
909 master = container_of(sdata->bss,
910 struct ieee80211_sub_if_data,
913 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt !=
914 master->crypto_tx_tailroom_needed_cnt);
917 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
918 sdata->crypto_tx_tailroom_pending_dec);
921 if (sdata->vif.type == NL80211_IFTYPE_AP) {
922 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
923 WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
924 vlan->crypto_tx_tailroom_pending_dec);
927 mutex_unlock(&local->key_mtx);
930 void ieee80211_free_sta_keys(struct ieee80211_local *local,
931 struct sta_info *sta)
933 struct ieee80211_key *key;
936 mutex_lock(&local->key_mtx);
937 for (i = 0; i < ARRAY_SIZE(sta->gtk); i++) {
938 key = key_mtx_dereference(local, sta->gtk[i]);
941 ieee80211_key_replace(key->sdata, key->sta,
942 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
944 __ieee80211_key_destroy(key, key->sdata->vif.type ==
945 NL80211_IFTYPE_STATION);
948 for (i = 0; i < NUM_DEFAULT_KEYS; i++) {
949 key = key_mtx_dereference(local, sta->ptk[i]);
952 ieee80211_key_replace(key->sdata, key->sta,
953 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
955 __ieee80211_key_destroy(key, key->sdata->vif.type ==
956 NL80211_IFTYPE_STATION);
959 mutex_unlock(&local->key_mtx);
962 void ieee80211_delayed_tailroom_dec(struct work_struct *wk)
964 struct ieee80211_sub_if_data *sdata;
966 sdata = container_of(wk, struct ieee80211_sub_if_data,
967 dec_tailroom_needed_wk.work);
970 * The reason for the delayed tailroom needed decrementing is to
971 * make roaming faster: during roaming, all keys are first deleted
972 * and then new keys are installed. The first new key causes the
973 * crypto_tx_tailroom_needed_cnt to go from 0 to 1, which invokes
974 * the cost of synchronize_net() (which can be slow). Avoid this
975 * by deferring the crypto_tx_tailroom_needed_cnt decrementing on
976 * key removal for a while, so if we roam the value is larger than
977 * zero and no 0->1 transition happens.
979 * The cost is that if the AP switching was from an AP with keys
980 * to one without, we still allocate tailroom while it would no
981 * longer be needed. However, in the typical (fast) roaming case
982 * within an ESS this usually won't happen.
985 mutex_lock(&sdata->local->key_mtx);
986 decrease_tailroom_need_count(sdata,
987 sdata->crypto_tx_tailroom_pending_dec);
988 sdata->crypto_tx_tailroom_pending_dec = 0;
989 mutex_unlock(&sdata->local->key_mtx);
992 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
993 const u8 *replay_ctr, gfp_t gfp)
995 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
997 trace_api_gtk_rekey_notify(sdata, bssid, replay_ctr);
999 cfg80211_gtk_rekey_notify(sdata->dev, bssid, replay_ctr, gfp);
1001 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_notify);
1003 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
1004 int tid, struct ieee80211_key_seq *seq)
1006 struct ieee80211_key *key;
1009 key = container_of(keyconf, struct ieee80211_key, conf);
1011 switch (key->conf.cipher) {
1012 case WLAN_CIPHER_SUITE_TKIP:
1013 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1015 seq->tkip.iv32 = key->u.tkip.rx[tid].iv32;
1016 seq->tkip.iv16 = key->u.tkip.rx[tid].iv16;
1018 case WLAN_CIPHER_SUITE_CCMP:
1019 case WLAN_CIPHER_SUITE_CCMP_256:
1020 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1023 pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1025 pn = key->u.ccmp.rx_pn[tid];
1026 memcpy(seq->ccmp.pn, pn, IEEE80211_CCMP_PN_LEN);
1028 case WLAN_CIPHER_SUITE_AES_CMAC:
1029 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1030 if (WARN_ON(tid != 0))
1032 pn = key->u.aes_cmac.rx_pn;
1033 memcpy(seq->aes_cmac.pn, pn, IEEE80211_CMAC_PN_LEN);
1035 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1036 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1037 if (WARN_ON(tid != 0))
1039 pn = key->u.aes_gmac.rx_pn;
1040 memcpy(seq->aes_gmac.pn, pn, IEEE80211_GMAC_PN_LEN);
1042 case WLAN_CIPHER_SUITE_GCMP:
1043 case WLAN_CIPHER_SUITE_GCMP_256:
1044 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1047 pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1049 pn = key->u.gcmp.rx_pn[tid];
1050 memcpy(seq->gcmp.pn, pn, IEEE80211_GCMP_PN_LEN);
1054 EXPORT_SYMBOL(ieee80211_get_key_rx_seq);
1056 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
1057 int tid, struct ieee80211_key_seq *seq)
1059 struct ieee80211_key *key;
1062 key = container_of(keyconf, struct ieee80211_key, conf);
1064 switch (key->conf.cipher) {
1065 case WLAN_CIPHER_SUITE_TKIP:
1066 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1068 key->u.tkip.rx[tid].iv32 = seq->tkip.iv32;
1069 key->u.tkip.rx[tid].iv16 = seq->tkip.iv16;
1071 case WLAN_CIPHER_SUITE_CCMP:
1072 case WLAN_CIPHER_SUITE_CCMP_256:
1073 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1076 pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1078 pn = key->u.ccmp.rx_pn[tid];
1079 memcpy(pn, seq->ccmp.pn, IEEE80211_CCMP_PN_LEN);
1081 case WLAN_CIPHER_SUITE_AES_CMAC:
1082 case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1083 if (WARN_ON(tid != 0))
1085 pn = key->u.aes_cmac.rx_pn;
1086 memcpy(pn, seq->aes_cmac.pn, IEEE80211_CMAC_PN_LEN);
1088 case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1089 case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1090 if (WARN_ON(tid != 0))
1092 pn = key->u.aes_gmac.rx_pn;
1093 memcpy(pn, seq->aes_gmac.pn, IEEE80211_GMAC_PN_LEN);
1095 case WLAN_CIPHER_SUITE_GCMP:
1096 case WLAN_CIPHER_SUITE_GCMP_256:
1097 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1100 pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1102 pn = key->u.gcmp.rx_pn[tid];
1103 memcpy(pn, seq->gcmp.pn, IEEE80211_GCMP_PN_LEN);
1110 EXPORT_SYMBOL_GPL(ieee80211_set_key_rx_seq);
1112 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf)
1114 struct ieee80211_key *key;
1116 key = container_of(keyconf, struct ieee80211_key, conf);
1118 assert_key_lock(key->local);
1121 * if key was uploaded, we assume the driver will/has remove(d)
1122 * it, so adjust bookkeeping accordingly
1124 if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
1125 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
1127 if (!((key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
1128 IEEE80211_KEY_FLAG_PUT_MIC_SPACE)) ||
1129 (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
1130 increment_tailroom_need_count(key->sdata);
1133 ieee80211_key_free(key, false);
1135 EXPORT_SYMBOL_GPL(ieee80211_remove_key);
1137 struct ieee80211_key_conf *
1138 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
1139 struct ieee80211_key_conf *keyconf)
1141 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1142 struct ieee80211_local *local = sdata->local;
1143 struct ieee80211_key *key;
1146 if (WARN_ON(!local->wowlan))
1147 return ERR_PTR(-EINVAL);
1149 if (WARN_ON(vif->type != NL80211_IFTYPE_STATION))
1150 return ERR_PTR(-EINVAL);
1152 key = ieee80211_key_alloc(keyconf->cipher, keyconf->keyidx,
1153 keyconf->keylen, keyconf->key,
1156 return ERR_CAST(key);
1158 if (sdata->u.mgd.mfp != IEEE80211_MFP_DISABLED)
1159 key->conf.flags |= IEEE80211_KEY_FLAG_RX_MGMT;
1161 err = ieee80211_key_link(key, sdata, NULL);
1163 return ERR_PTR(err);
1167 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_add);