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
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/if_ether.h>
14 #include <linux/etherdevice.h>
15 #include <linux/list.h>
16 #include <linux/rcupdate.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/slab.h>
19 #include <linux/export.h>
20 #include <net/mac80211.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
;
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 key
->flags
&= ~KEY_FLAG_UPLOADED_TO_HARDWARE
;
145 if (!key
->local
->ops
->set_key
)
146 goto out_unsupported
;
148 assert_key_lock(key
->local
);
153 * If this is a per-STA GTK, check if it
154 * is supported; if not, return.
156 if (sta
&& !(key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
) &&
157 !ieee80211_hw_check(&key
->local
->hw
, SUPPORTS_PER_STA_GTK
))
158 goto out_unsupported
;
160 if (sta
&& !sta
->uploaded
)
161 goto out_unsupported
;
164 if (sdata
->vif
.type
== NL80211_IFTYPE_AP_VLAN
) {
166 * The driver doesn't know anything about VLAN interfaces.
167 * Hence, don't send GTKs for VLAN interfaces to the driver.
169 if (!(key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
))
170 goto out_unsupported
;
173 ret
= drv_set_key(key
->local
, SET_KEY
, sdata
,
174 sta
? &sta
->sta
: NULL
, &key
->conf
);
177 key
->flags
|= KEY_FLAG_UPLOADED_TO_HARDWARE
;
179 if (!((key
->conf
.flags
& IEEE80211_KEY_FLAG_GENERATE_MMIC
) ||
180 (key
->conf
.flags
& IEEE80211_KEY_FLAG_RESERVE_TAILROOM
)))
181 decrease_tailroom_need_count(sdata
, 1);
183 WARN_ON((key
->conf
.flags
& IEEE80211_KEY_FLAG_PUT_IV_SPACE
) &&
184 (key
->conf
.flags
& IEEE80211_KEY_FLAG_GENERATE_IV
));
189 if (ret
!= -ENOSPC
&& ret
!= -EOPNOTSUPP
&& ret
!= 1)
191 "failed to set key (%d, %pM) to hardware (%d)\n",
193 sta
? sta
->sta
.addr
: bcast_addr
, ret
);
196 switch (key
->conf
.cipher
) {
197 case WLAN_CIPHER_SUITE_WEP40
:
198 case WLAN_CIPHER_SUITE_WEP104
:
199 case WLAN_CIPHER_SUITE_TKIP
:
200 case WLAN_CIPHER_SUITE_CCMP
:
201 case WLAN_CIPHER_SUITE_CCMP_256
:
202 case WLAN_CIPHER_SUITE_AES_CMAC
:
203 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
204 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
205 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
206 case WLAN_CIPHER_SUITE_GCMP
:
207 case WLAN_CIPHER_SUITE_GCMP_256
:
208 /* all of these we can do in software - if driver can */
211 if (ieee80211_hw_check(&key
->local
->hw
, SW_CRYPTO_CONTROL
))
219 static void ieee80211_key_disable_hw_accel(struct ieee80211_key
*key
)
221 struct ieee80211_sub_if_data
*sdata
;
222 struct sta_info
*sta
;
227 if (!key
|| !key
->local
->ops
->set_key
)
230 assert_key_lock(key
->local
);
232 if (!(key
->flags
& KEY_FLAG_UPLOADED_TO_HARDWARE
))
238 if (!((key
->conf
.flags
& IEEE80211_KEY_FLAG_GENERATE_MMIC
) ||
239 (key
->conf
.flags
& IEEE80211_KEY_FLAG_RESERVE_TAILROOM
)))
240 increment_tailroom_need_count(sdata
);
242 ret
= drv_set_key(key
->local
, DISABLE_KEY
, sdata
,
243 sta
? &sta
->sta
: NULL
, &key
->conf
);
247 "failed to remove key (%d, %pM) from hardware (%d)\n",
249 sta
? sta
->sta
.addr
: bcast_addr
, ret
);
251 key
->flags
&= ~KEY_FLAG_UPLOADED_TO_HARDWARE
;
254 static void __ieee80211_set_default_key(struct ieee80211_sub_if_data
*sdata
,
255 int idx
, bool uni
, bool multi
)
257 struct ieee80211_key
*key
= NULL
;
259 assert_key_lock(sdata
->local
);
261 if (idx
>= 0 && idx
< NUM_DEFAULT_KEYS
)
262 key
= key_mtx_dereference(sdata
->local
, sdata
->keys
[idx
]);
265 rcu_assign_pointer(sdata
->default_unicast_key
, key
);
266 ieee80211_check_fast_xmit_iface(sdata
);
267 drv_set_default_unicast_key(sdata
->local
, sdata
, idx
);
271 rcu_assign_pointer(sdata
->default_multicast_key
, key
);
273 ieee80211_debugfs_key_update_default(sdata
);
276 void ieee80211_set_default_key(struct ieee80211_sub_if_data
*sdata
, int idx
,
277 bool uni
, bool multi
)
279 mutex_lock(&sdata
->local
->key_mtx
);
280 __ieee80211_set_default_key(sdata
, idx
, uni
, multi
);
281 mutex_unlock(&sdata
->local
->key_mtx
);
285 __ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data
*sdata
, int idx
)
287 struct ieee80211_key
*key
= NULL
;
289 assert_key_lock(sdata
->local
);
291 if (idx
>= NUM_DEFAULT_KEYS
&&
292 idx
< NUM_DEFAULT_KEYS
+ NUM_DEFAULT_MGMT_KEYS
)
293 key
= key_mtx_dereference(sdata
->local
, sdata
->keys
[idx
]);
295 rcu_assign_pointer(sdata
->default_mgmt_key
, key
);
297 ieee80211_debugfs_key_update_default(sdata
);
300 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data
*sdata
,
303 mutex_lock(&sdata
->local
->key_mtx
);
304 __ieee80211_set_default_mgmt_key(sdata
, idx
);
305 mutex_unlock(&sdata
->local
->key_mtx
);
309 static void ieee80211_key_replace(struct ieee80211_sub_if_data
*sdata
,
310 struct sta_info
*sta
,
312 struct ieee80211_key
*old
,
313 struct ieee80211_key
*new)
316 bool defunikey
, defmultikey
, defmgmtkey
;
318 /* caller must provide at least one old/new */
319 if (WARN_ON(!new && !old
))
323 list_add_tail(&new->list
, &sdata
->key_list
);
325 WARN_ON(new && old
&& new->conf
.keyidx
!= old
->conf
.keyidx
);
328 idx
= old
->conf
.keyidx
;
330 idx
= new->conf
.keyidx
;
334 rcu_assign_pointer(sta
->ptk
[idx
], new);
336 ieee80211_check_fast_xmit(sta
);
338 rcu_assign_pointer(sta
->gtk
[idx
], new);
343 old
== key_mtx_dereference(sdata
->local
,
344 sdata
->default_unicast_key
);
346 old
== key_mtx_dereference(sdata
->local
,
347 sdata
->default_multicast_key
);
349 old
== key_mtx_dereference(sdata
->local
,
350 sdata
->default_mgmt_key
);
352 if (defunikey
&& !new)
353 __ieee80211_set_default_key(sdata
, -1, true, false);
354 if (defmultikey
&& !new)
355 __ieee80211_set_default_key(sdata
, -1, false, true);
356 if (defmgmtkey
&& !new)
357 __ieee80211_set_default_mgmt_key(sdata
, -1);
359 rcu_assign_pointer(sdata
->keys
[idx
], new);
360 if (defunikey
&& new)
361 __ieee80211_set_default_key(sdata
, new->conf
.keyidx
,
363 if (defmultikey
&& new)
364 __ieee80211_set_default_key(sdata
, new->conf
.keyidx
,
366 if (defmgmtkey
&& new)
367 __ieee80211_set_default_mgmt_key(sdata
,
372 list_del(&old
->list
);
375 struct ieee80211_key
*
376 ieee80211_key_alloc(u32 cipher
, int idx
, size_t key_len
,
378 size_t seq_len
, const u8
*seq
,
379 const struct ieee80211_cipher_scheme
*cs
)
381 struct ieee80211_key
*key
;
384 if (WARN_ON(idx
< 0 || idx
>= NUM_DEFAULT_KEYS
+ NUM_DEFAULT_MGMT_KEYS
))
385 return ERR_PTR(-EINVAL
);
387 key
= kzalloc(sizeof(struct ieee80211_key
) + key_len
, GFP_KERNEL
);
389 return ERR_PTR(-ENOMEM
);
392 * Default to software encryption; we'll later upload the
393 * key to the hardware if possible.
398 key
->conf
.cipher
= cipher
;
399 key
->conf
.keyidx
= idx
;
400 key
->conf
.keylen
= key_len
;
402 case WLAN_CIPHER_SUITE_WEP40
:
403 case WLAN_CIPHER_SUITE_WEP104
:
404 key
->conf
.iv_len
= IEEE80211_WEP_IV_LEN
;
405 key
->conf
.icv_len
= IEEE80211_WEP_ICV_LEN
;
407 case WLAN_CIPHER_SUITE_TKIP
:
408 key
->conf
.iv_len
= IEEE80211_TKIP_IV_LEN
;
409 key
->conf
.icv_len
= IEEE80211_TKIP_ICV_LEN
;
411 for (i
= 0; i
< IEEE80211_NUM_TIDS
; i
++) {
412 key
->u
.tkip
.rx
[i
].iv32
=
413 get_unaligned_le32(&seq
[2]);
414 key
->u
.tkip
.rx
[i
].iv16
=
415 get_unaligned_le16(seq
);
418 spin_lock_init(&key
->u
.tkip
.txlock
);
420 case WLAN_CIPHER_SUITE_CCMP
:
421 key
->conf
.iv_len
= IEEE80211_CCMP_HDR_LEN
;
422 key
->conf
.icv_len
= IEEE80211_CCMP_MIC_LEN
;
424 for (i
= 0; i
< IEEE80211_NUM_TIDS
+ 1; i
++)
425 for (j
= 0; j
< IEEE80211_CCMP_PN_LEN
; j
++)
426 key
->u
.ccmp
.rx_pn
[i
][j
] =
427 seq
[IEEE80211_CCMP_PN_LEN
- j
- 1];
430 * Initialize AES key state here as an optimization so that
431 * it does not need to be initialized for every packet.
433 key
->u
.ccmp
.tfm
= ieee80211_aes_key_setup_encrypt(
434 key_data
, key_len
, IEEE80211_CCMP_MIC_LEN
);
435 if (IS_ERR(key
->u
.ccmp
.tfm
)) {
436 err
= PTR_ERR(key
->u
.ccmp
.tfm
);
441 case WLAN_CIPHER_SUITE_CCMP_256
:
442 key
->conf
.iv_len
= IEEE80211_CCMP_256_HDR_LEN
;
443 key
->conf
.icv_len
= IEEE80211_CCMP_256_MIC_LEN
;
444 for (i
= 0; seq
&& i
< IEEE80211_NUM_TIDS
+ 1; i
++)
445 for (j
= 0; j
< IEEE80211_CCMP_256_PN_LEN
; j
++)
446 key
->u
.ccmp
.rx_pn
[i
][j
] =
447 seq
[IEEE80211_CCMP_256_PN_LEN
- j
- 1];
448 /* Initialize AES key state here as an optimization so that
449 * it does not need to be initialized for every packet.
451 key
->u
.ccmp
.tfm
= ieee80211_aes_key_setup_encrypt(
452 key_data
, key_len
, IEEE80211_CCMP_256_MIC_LEN
);
453 if (IS_ERR(key
->u
.ccmp
.tfm
)) {
454 err
= PTR_ERR(key
->u
.ccmp
.tfm
);
459 case WLAN_CIPHER_SUITE_AES_CMAC
:
460 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
461 key
->conf
.iv_len
= 0;
462 if (cipher
== WLAN_CIPHER_SUITE_AES_CMAC
)
463 key
->conf
.icv_len
= sizeof(struct ieee80211_mmie
);
465 key
->conf
.icv_len
= sizeof(struct ieee80211_mmie_16
);
467 for (j
= 0; j
< IEEE80211_CMAC_PN_LEN
; j
++)
468 key
->u
.aes_cmac
.rx_pn
[j
] =
469 seq
[IEEE80211_CMAC_PN_LEN
- j
- 1];
471 * Initialize AES key state here as an optimization so that
472 * it does not need to be initialized for every packet.
474 key
->u
.aes_cmac
.tfm
=
475 ieee80211_aes_cmac_key_setup(key_data
, key_len
);
476 if (IS_ERR(key
->u
.aes_cmac
.tfm
)) {
477 err
= PTR_ERR(key
->u
.aes_cmac
.tfm
);
482 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
483 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
484 key
->conf
.iv_len
= 0;
485 key
->conf
.icv_len
= sizeof(struct ieee80211_mmie_16
);
487 for (j
= 0; j
< IEEE80211_GMAC_PN_LEN
; j
++)
488 key
->u
.aes_gmac
.rx_pn
[j
] =
489 seq
[IEEE80211_GMAC_PN_LEN
- j
- 1];
490 /* Initialize AES key state here as an optimization so that
491 * it does not need to be initialized for every packet.
493 key
->u
.aes_gmac
.tfm
=
494 ieee80211_aes_gmac_key_setup(key_data
, key_len
);
495 if (IS_ERR(key
->u
.aes_gmac
.tfm
)) {
496 err
= PTR_ERR(key
->u
.aes_gmac
.tfm
);
501 case WLAN_CIPHER_SUITE_GCMP
:
502 case WLAN_CIPHER_SUITE_GCMP_256
:
503 key
->conf
.iv_len
= IEEE80211_GCMP_HDR_LEN
;
504 key
->conf
.icv_len
= IEEE80211_GCMP_MIC_LEN
;
505 for (i
= 0; seq
&& i
< IEEE80211_NUM_TIDS
+ 1; i
++)
506 for (j
= 0; j
< IEEE80211_GCMP_PN_LEN
; j
++)
507 key
->u
.gcmp
.rx_pn
[i
][j
] =
508 seq
[IEEE80211_GCMP_PN_LEN
- j
- 1];
509 /* Initialize AES key state here as an optimization so that
510 * it does not need to be initialized for every packet.
512 key
->u
.gcmp
.tfm
= ieee80211_aes_gcm_key_setup_encrypt(key_data
,
514 if (IS_ERR(key
->u
.gcmp
.tfm
)) {
515 err
= PTR_ERR(key
->u
.gcmp
.tfm
);
522 if (seq_len
&& seq_len
!= cs
->pn_len
) {
524 return ERR_PTR(-EINVAL
);
527 key
->conf
.iv_len
= cs
->hdr_len
;
528 key
->conf
.icv_len
= cs
->mic_len
;
529 for (i
= 0; i
< IEEE80211_NUM_TIDS
+ 1; i
++)
530 for (j
= 0; j
< seq_len
; j
++)
531 key
->u
.gen
.rx_pn
[i
][j
] =
532 seq
[seq_len
- j
- 1];
533 key
->flags
|= KEY_FLAG_CIPHER_SCHEME
;
536 memcpy(key
->conf
.key
, key_data
, key_len
);
537 INIT_LIST_HEAD(&key
->list
);
542 static void ieee80211_key_free_common(struct ieee80211_key
*key
)
544 switch (key
->conf
.cipher
) {
545 case WLAN_CIPHER_SUITE_CCMP
:
546 case WLAN_CIPHER_SUITE_CCMP_256
:
547 ieee80211_aes_key_free(key
->u
.ccmp
.tfm
);
549 case WLAN_CIPHER_SUITE_AES_CMAC
:
550 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
551 ieee80211_aes_cmac_key_free(key
->u
.aes_cmac
.tfm
);
553 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
554 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
555 ieee80211_aes_gmac_key_free(key
->u
.aes_gmac
.tfm
);
557 case WLAN_CIPHER_SUITE_GCMP
:
558 case WLAN_CIPHER_SUITE_GCMP_256
:
559 ieee80211_aes_gcm_key_free(key
->u
.gcmp
.tfm
);
565 static void __ieee80211_key_destroy(struct ieee80211_key
*key
,
569 ieee80211_key_disable_hw_accel(key
);
572 struct ieee80211_sub_if_data
*sdata
= key
->sdata
;
574 ieee80211_debugfs_key_remove(key
);
576 if (delay_tailroom
) {
577 /* see ieee80211_delayed_tailroom_dec */
578 sdata
->crypto_tx_tailroom_pending_dec
++;
579 schedule_delayed_work(&sdata
->dec_tailroom_needed_wk
,
582 decrease_tailroom_need_count(sdata
, 1);
586 ieee80211_key_free_common(key
);
589 static void ieee80211_key_destroy(struct ieee80211_key
*key
,
596 * Synchronize so the TX path can no longer be using
597 * this key before we free/remove it.
601 __ieee80211_key_destroy(key
, delay_tailroom
);
604 void ieee80211_key_free_unused(struct ieee80211_key
*key
)
606 WARN_ON(key
->sdata
|| key
->local
);
607 ieee80211_key_free_common(key
);
610 int ieee80211_key_link(struct ieee80211_key
*key
,
611 struct ieee80211_sub_if_data
*sdata
,
612 struct sta_info
*sta
)
614 struct ieee80211_local
*local
= sdata
->local
;
615 struct ieee80211_key
*old_key
;
619 pairwise
= key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
;
620 idx
= key
->conf
.keyidx
;
621 key
->local
= sdata
->local
;
625 mutex_lock(&sdata
->local
->key_mtx
);
628 old_key
= key_mtx_dereference(sdata
->local
, sta
->ptk
[idx
]);
630 old_key
= key_mtx_dereference(sdata
->local
, sta
->gtk
[idx
]);
632 old_key
= key_mtx_dereference(sdata
->local
, sdata
->keys
[idx
]);
634 increment_tailroom_need_count(sdata
);
636 ieee80211_key_replace(sdata
, sta
, pairwise
, old_key
, key
);
637 ieee80211_key_destroy(old_key
, true);
639 ieee80211_debugfs_key_add(key
);
641 if (!local
->wowlan
) {
642 ret
= ieee80211_key_enable_hw_accel(key
);
644 ieee80211_key_free(key
, true);
649 mutex_unlock(&sdata
->local
->key_mtx
);
654 void ieee80211_key_free(struct ieee80211_key
*key
, bool delay_tailroom
)
660 * Replace key with nothingness if it was ever used.
663 ieee80211_key_replace(key
->sdata
, key
->sta
,
664 key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
,
666 ieee80211_key_destroy(key
, delay_tailroom
);
669 void ieee80211_enable_keys(struct ieee80211_sub_if_data
*sdata
)
671 struct ieee80211_key
*key
;
672 struct ieee80211_sub_if_data
*vlan
;
676 if (WARN_ON(!ieee80211_sdata_running(sdata
)))
679 mutex_lock(&sdata
->local
->key_mtx
);
681 WARN_ON_ONCE(sdata
->crypto_tx_tailroom_needed_cnt
||
682 sdata
->crypto_tx_tailroom_pending_dec
);
684 if (sdata
->vif
.type
== NL80211_IFTYPE_AP
) {
685 list_for_each_entry(vlan
, &sdata
->u
.ap
.vlans
, u
.vlan
.list
)
686 WARN_ON_ONCE(vlan
->crypto_tx_tailroom_needed_cnt
||
687 vlan
->crypto_tx_tailroom_pending_dec
);
690 list_for_each_entry(key
, &sdata
->key_list
, list
) {
691 increment_tailroom_need_count(sdata
);
692 ieee80211_key_enable_hw_accel(key
);
695 mutex_unlock(&sdata
->local
->key_mtx
);
698 void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data
*sdata
)
700 struct ieee80211_sub_if_data
*vlan
;
702 mutex_lock(&sdata
->local
->key_mtx
);
704 sdata
->crypto_tx_tailroom_needed_cnt
= 0;
706 if (sdata
->vif
.type
== NL80211_IFTYPE_AP
) {
707 list_for_each_entry(vlan
, &sdata
->u
.ap
.vlans
, u
.vlan
.list
)
708 vlan
->crypto_tx_tailroom_needed_cnt
= 0;
711 mutex_unlock(&sdata
->local
->key_mtx
);
714 void ieee80211_iter_keys(struct ieee80211_hw
*hw
,
715 struct ieee80211_vif
*vif
,
716 void (*iter
)(struct ieee80211_hw
*hw
,
717 struct ieee80211_vif
*vif
,
718 struct ieee80211_sta
*sta
,
719 struct ieee80211_key_conf
*key
,
723 struct ieee80211_local
*local
= hw_to_local(hw
);
724 struct ieee80211_key
*key
, *tmp
;
725 struct ieee80211_sub_if_data
*sdata
;
729 mutex_lock(&local
->key_mtx
);
731 sdata
= vif_to_sdata(vif
);
732 list_for_each_entry_safe(key
, tmp
, &sdata
->key_list
, list
)
733 iter(hw
, &sdata
->vif
,
734 key
->sta
? &key
->sta
->sta
: NULL
,
735 &key
->conf
, iter_data
);
737 list_for_each_entry(sdata
, &local
->interfaces
, list
)
738 list_for_each_entry_safe(key
, tmp
,
739 &sdata
->key_list
, list
)
740 iter(hw
, &sdata
->vif
,
741 key
->sta
? &key
->sta
->sta
: NULL
,
742 &key
->conf
, iter_data
);
744 mutex_unlock(&local
->key_mtx
);
746 EXPORT_SYMBOL(ieee80211_iter_keys
);
748 static void ieee80211_free_keys_iface(struct ieee80211_sub_if_data
*sdata
,
749 struct list_head
*keys
)
751 struct ieee80211_key
*key
, *tmp
;
753 decrease_tailroom_need_count(sdata
,
754 sdata
->crypto_tx_tailroom_pending_dec
);
755 sdata
->crypto_tx_tailroom_pending_dec
= 0;
757 ieee80211_debugfs_key_remove_mgmt_default(sdata
);
759 list_for_each_entry_safe(key
, tmp
, &sdata
->key_list
, list
) {
760 ieee80211_key_replace(key
->sdata
, key
->sta
,
761 key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
,
763 list_add_tail(&key
->list
, keys
);
766 ieee80211_debugfs_key_update_default(sdata
);
769 void ieee80211_free_keys(struct ieee80211_sub_if_data
*sdata
,
770 bool force_synchronize
)
772 struct ieee80211_local
*local
= sdata
->local
;
773 struct ieee80211_sub_if_data
*vlan
;
774 struct ieee80211_sub_if_data
*master
;
775 struct ieee80211_key
*key
, *tmp
;
778 cancel_delayed_work_sync(&sdata
->dec_tailroom_needed_wk
);
780 mutex_lock(&local
->key_mtx
);
782 ieee80211_free_keys_iface(sdata
, &keys
);
784 if (sdata
->vif
.type
== NL80211_IFTYPE_AP
) {
785 list_for_each_entry(vlan
, &sdata
->u
.ap
.vlans
, u
.vlan
.list
)
786 ieee80211_free_keys_iface(vlan
, &keys
);
789 if (!list_empty(&keys
) || force_synchronize
)
791 list_for_each_entry_safe(key
, tmp
, &keys
, list
)
792 __ieee80211_key_destroy(key
, false);
794 if (sdata
->vif
.type
== NL80211_IFTYPE_AP_VLAN
) {
796 master
= container_of(sdata
->bss
,
797 struct ieee80211_sub_if_data
,
800 WARN_ON_ONCE(sdata
->crypto_tx_tailroom_needed_cnt
!=
801 master
->crypto_tx_tailroom_needed_cnt
);
804 WARN_ON_ONCE(sdata
->crypto_tx_tailroom_needed_cnt
||
805 sdata
->crypto_tx_tailroom_pending_dec
);
808 if (sdata
->vif
.type
== NL80211_IFTYPE_AP
) {
809 list_for_each_entry(vlan
, &sdata
->u
.ap
.vlans
, u
.vlan
.list
)
810 WARN_ON_ONCE(vlan
->crypto_tx_tailroom_needed_cnt
||
811 vlan
->crypto_tx_tailroom_pending_dec
);
814 mutex_unlock(&local
->key_mtx
);
817 void ieee80211_free_sta_keys(struct ieee80211_local
*local
,
818 struct sta_info
*sta
)
820 struct ieee80211_key
*key
;
823 mutex_lock(&local
->key_mtx
);
824 for (i
= 0; i
< ARRAY_SIZE(sta
->gtk
); i
++) {
825 key
= key_mtx_dereference(local
, sta
->gtk
[i
]);
828 ieee80211_key_replace(key
->sdata
, key
->sta
,
829 key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
,
831 __ieee80211_key_destroy(key
, true);
834 for (i
= 0; i
< NUM_DEFAULT_KEYS
; i
++) {
835 key
= key_mtx_dereference(local
, sta
->ptk
[i
]);
838 ieee80211_key_replace(key
->sdata
, key
->sta
,
839 key
->conf
.flags
& IEEE80211_KEY_FLAG_PAIRWISE
,
841 __ieee80211_key_destroy(key
, true);
844 mutex_unlock(&local
->key_mtx
);
847 void ieee80211_delayed_tailroom_dec(struct work_struct
*wk
)
849 struct ieee80211_sub_if_data
*sdata
;
851 sdata
= container_of(wk
, struct ieee80211_sub_if_data
,
852 dec_tailroom_needed_wk
.work
);
855 * The reason for the delayed tailroom needed decrementing is to
856 * make roaming faster: during roaming, all keys are first deleted
857 * and then new keys are installed. The first new key causes the
858 * crypto_tx_tailroom_needed_cnt to go from 0 to 1, which invokes
859 * the cost of synchronize_net() (which can be slow). Avoid this
860 * by deferring the crypto_tx_tailroom_needed_cnt decrementing on
861 * key removal for a while, so if we roam the value is larger than
862 * zero and no 0->1 transition happens.
864 * The cost is that if the AP switching was from an AP with keys
865 * to one without, we still allocate tailroom while it would no
866 * longer be needed. However, in the typical (fast) roaming case
867 * within an ESS this usually won't happen.
870 mutex_lock(&sdata
->local
->key_mtx
);
871 decrease_tailroom_need_count(sdata
,
872 sdata
->crypto_tx_tailroom_pending_dec
);
873 sdata
->crypto_tx_tailroom_pending_dec
= 0;
874 mutex_unlock(&sdata
->local
->key_mtx
);
877 void ieee80211_gtk_rekey_notify(struct ieee80211_vif
*vif
, const u8
*bssid
,
878 const u8
*replay_ctr
, gfp_t gfp
)
880 struct ieee80211_sub_if_data
*sdata
= vif_to_sdata(vif
);
882 trace_api_gtk_rekey_notify(sdata
, bssid
, replay_ctr
);
884 cfg80211_gtk_rekey_notify(sdata
->dev
, bssid
, replay_ctr
, gfp
);
886 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_notify
);
888 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
889 struct ieee80211_key_seq
*seq
)
891 struct ieee80211_key
*key
;
894 if (WARN_ON(!(keyconf
->flags
& IEEE80211_KEY_FLAG_GENERATE_IV
)))
897 key
= container_of(keyconf
, struct ieee80211_key
, conf
);
899 switch (key
->conf
.cipher
) {
900 case WLAN_CIPHER_SUITE_TKIP
:
901 seq
->tkip
.iv32
= key
->u
.tkip
.tx
.iv32
;
902 seq
->tkip
.iv16
= key
->u
.tkip
.tx
.iv16
;
904 case WLAN_CIPHER_SUITE_CCMP
:
905 case WLAN_CIPHER_SUITE_CCMP_256
:
906 case WLAN_CIPHER_SUITE_AES_CMAC
:
907 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
908 BUILD_BUG_ON(offsetof(typeof(*seq
), ccmp
) !=
909 offsetof(typeof(*seq
), aes_cmac
));
910 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
911 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
912 BUILD_BUG_ON(offsetof(typeof(*seq
), ccmp
) !=
913 offsetof(typeof(*seq
), aes_gmac
));
914 case WLAN_CIPHER_SUITE_GCMP
:
915 case WLAN_CIPHER_SUITE_GCMP_256
:
916 BUILD_BUG_ON(offsetof(typeof(*seq
), ccmp
) !=
917 offsetof(typeof(*seq
), gcmp
));
918 pn64
= atomic64_read(&key
->conf
.tx_pn
);
919 seq
->ccmp
.pn
[5] = pn64
;
920 seq
->ccmp
.pn
[4] = pn64
>> 8;
921 seq
->ccmp
.pn
[3] = pn64
>> 16;
922 seq
->ccmp
.pn
[2] = pn64
>> 24;
923 seq
->ccmp
.pn
[1] = pn64
>> 32;
924 seq
->ccmp
.pn
[0] = pn64
>> 40;
930 EXPORT_SYMBOL(ieee80211_get_key_tx_seq
);
932 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
933 int tid
, struct ieee80211_key_seq
*seq
)
935 struct ieee80211_key
*key
;
938 key
= container_of(keyconf
, struct ieee80211_key
, conf
);
940 switch (key
->conf
.cipher
) {
941 case WLAN_CIPHER_SUITE_TKIP
:
942 if (WARN_ON(tid
< 0 || tid
>= IEEE80211_NUM_TIDS
))
944 seq
->tkip
.iv32
= key
->u
.tkip
.rx
[tid
].iv32
;
945 seq
->tkip
.iv16
= key
->u
.tkip
.rx
[tid
].iv16
;
947 case WLAN_CIPHER_SUITE_CCMP
:
948 case WLAN_CIPHER_SUITE_CCMP_256
:
949 if (WARN_ON(tid
< -1 || tid
>= IEEE80211_NUM_TIDS
))
952 pn
= key
->u
.ccmp
.rx_pn
[IEEE80211_NUM_TIDS
];
954 pn
= key
->u
.ccmp
.rx_pn
[tid
];
955 memcpy(seq
->ccmp
.pn
, pn
, IEEE80211_CCMP_PN_LEN
);
957 case WLAN_CIPHER_SUITE_AES_CMAC
:
958 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
959 if (WARN_ON(tid
!= 0))
961 pn
= key
->u
.aes_cmac
.rx_pn
;
962 memcpy(seq
->aes_cmac
.pn
, pn
, IEEE80211_CMAC_PN_LEN
);
964 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
965 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
966 if (WARN_ON(tid
!= 0))
968 pn
= key
->u
.aes_gmac
.rx_pn
;
969 memcpy(seq
->aes_gmac
.pn
, pn
, IEEE80211_GMAC_PN_LEN
);
971 case WLAN_CIPHER_SUITE_GCMP
:
972 case WLAN_CIPHER_SUITE_GCMP_256
:
973 if (WARN_ON(tid
< -1 || tid
>= IEEE80211_NUM_TIDS
))
976 pn
= key
->u
.gcmp
.rx_pn
[IEEE80211_NUM_TIDS
];
978 pn
= key
->u
.gcmp
.rx_pn
[tid
];
979 memcpy(seq
->gcmp
.pn
, pn
, IEEE80211_GCMP_PN_LEN
);
983 EXPORT_SYMBOL(ieee80211_get_key_rx_seq
);
985 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf
*keyconf
,
986 struct ieee80211_key_seq
*seq
)
988 struct ieee80211_key
*key
;
991 key
= container_of(keyconf
, struct ieee80211_key
, conf
);
993 switch (key
->conf
.cipher
) {
994 case WLAN_CIPHER_SUITE_TKIP
:
995 key
->u
.tkip
.tx
.iv32
= seq
->tkip
.iv32
;
996 key
->u
.tkip
.tx
.iv16
= seq
->tkip
.iv16
;
998 case WLAN_CIPHER_SUITE_CCMP
:
999 case WLAN_CIPHER_SUITE_CCMP_256
:
1000 case WLAN_CIPHER_SUITE_AES_CMAC
:
1001 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
1002 BUILD_BUG_ON(offsetof(typeof(*seq
), ccmp
) !=
1003 offsetof(typeof(*seq
), aes_cmac
));
1004 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
1005 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
1006 BUILD_BUG_ON(offsetof(typeof(*seq
), ccmp
) !=
1007 offsetof(typeof(*seq
), aes_gmac
));
1008 case WLAN_CIPHER_SUITE_GCMP
:
1009 case WLAN_CIPHER_SUITE_GCMP_256
:
1010 BUILD_BUG_ON(offsetof(typeof(*seq
), ccmp
) !=
1011 offsetof(typeof(*seq
), gcmp
));
1012 pn64
= (u64
)seq
->ccmp
.pn
[5] |
1013 ((u64
)seq
->ccmp
.pn
[4] << 8) |
1014 ((u64
)seq
->ccmp
.pn
[3] << 16) |
1015 ((u64
)seq
->ccmp
.pn
[2] << 24) |
1016 ((u64
)seq
->ccmp
.pn
[1] << 32) |
1017 ((u64
)seq
->ccmp
.pn
[0] << 40);
1018 atomic64_set(&key
->conf
.tx_pn
, pn64
);
1025 EXPORT_SYMBOL_GPL(ieee80211_set_key_tx_seq
);
1027 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf
*keyconf
,
1028 int tid
, struct ieee80211_key_seq
*seq
)
1030 struct ieee80211_key
*key
;
1033 key
= container_of(keyconf
, struct ieee80211_key
, conf
);
1035 switch (key
->conf
.cipher
) {
1036 case WLAN_CIPHER_SUITE_TKIP
:
1037 if (WARN_ON(tid
< 0 || tid
>= IEEE80211_NUM_TIDS
))
1039 key
->u
.tkip
.rx
[tid
].iv32
= seq
->tkip
.iv32
;
1040 key
->u
.tkip
.rx
[tid
].iv16
= seq
->tkip
.iv16
;
1042 case WLAN_CIPHER_SUITE_CCMP
:
1043 case WLAN_CIPHER_SUITE_CCMP_256
:
1044 if (WARN_ON(tid
< -1 || tid
>= IEEE80211_NUM_TIDS
))
1047 pn
= key
->u
.ccmp
.rx_pn
[IEEE80211_NUM_TIDS
];
1049 pn
= key
->u
.ccmp
.rx_pn
[tid
];
1050 memcpy(pn
, seq
->ccmp
.pn
, IEEE80211_CCMP_PN_LEN
);
1052 case WLAN_CIPHER_SUITE_AES_CMAC
:
1053 case WLAN_CIPHER_SUITE_BIP_CMAC_256
:
1054 if (WARN_ON(tid
!= 0))
1056 pn
= key
->u
.aes_cmac
.rx_pn
;
1057 memcpy(pn
, seq
->aes_cmac
.pn
, IEEE80211_CMAC_PN_LEN
);
1059 case WLAN_CIPHER_SUITE_BIP_GMAC_128
:
1060 case WLAN_CIPHER_SUITE_BIP_GMAC_256
:
1061 if (WARN_ON(tid
!= 0))
1063 pn
= key
->u
.aes_gmac
.rx_pn
;
1064 memcpy(pn
, seq
->aes_gmac
.pn
, IEEE80211_GMAC_PN_LEN
);
1066 case WLAN_CIPHER_SUITE_GCMP
:
1067 case WLAN_CIPHER_SUITE_GCMP_256
:
1068 if (WARN_ON(tid
< -1 || tid
>= IEEE80211_NUM_TIDS
))
1071 pn
= key
->u
.gcmp
.rx_pn
[IEEE80211_NUM_TIDS
];
1073 pn
= key
->u
.gcmp
.rx_pn
[tid
];
1074 memcpy(pn
, seq
->gcmp
.pn
, IEEE80211_GCMP_PN_LEN
);
1081 EXPORT_SYMBOL_GPL(ieee80211_set_key_rx_seq
);
1083 void ieee80211_remove_key(struct ieee80211_key_conf
*keyconf
)
1085 struct ieee80211_key
*key
;
1087 key
= container_of(keyconf
, struct ieee80211_key
, conf
);
1089 assert_key_lock(key
->local
);
1092 * if key was uploaded, we assume the driver will/has remove(d)
1093 * it, so adjust bookkeeping accordingly
1095 if (key
->flags
& KEY_FLAG_UPLOADED_TO_HARDWARE
) {
1096 key
->flags
&= ~KEY_FLAG_UPLOADED_TO_HARDWARE
;
1098 if (!((key
->conf
.flags
& IEEE80211_KEY_FLAG_GENERATE_MMIC
) ||
1099 (key
->conf
.flags
& IEEE80211_KEY_FLAG_RESERVE_TAILROOM
)))
1100 increment_tailroom_need_count(key
->sdata
);
1103 ieee80211_key_free(key
, false);
1105 EXPORT_SYMBOL_GPL(ieee80211_remove_key
);
1107 struct ieee80211_key_conf
*
1108 ieee80211_gtk_rekey_add(struct ieee80211_vif
*vif
,
1109 struct ieee80211_key_conf
*keyconf
)
1111 struct ieee80211_sub_if_data
*sdata
= vif_to_sdata(vif
);
1112 struct ieee80211_local
*local
= sdata
->local
;
1113 struct ieee80211_key
*key
;
1116 if (WARN_ON(!local
->wowlan
))
1117 return ERR_PTR(-EINVAL
);
1119 if (WARN_ON(vif
->type
!= NL80211_IFTYPE_STATION
))
1120 return ERR_PTR(-EINVAL
);
1122 key
= ieee80211_key_alloc(keyconf
->cipher
, keyconf
->keyidx
,
1123 keyconf
->keylen
, keyconf
->key
,
1126 return ERR_CAST(key
);
1128 if (sdata
->u
.mgd
.mfp
!= IEEE80211_MFP_DISABLED
)
1129 key
->conf
.flags
|= IEEE80211_KEY_FLAG_RX_MGMT
;
1131 err
= ieee80211_key_link(key
, sdata
, NULL
);
1133 return ERR_PTR(err
);
1137 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_add
);