xref: /linux/net/mac80211/key.c (revision 730eeb17bbdd3c31f91e2a4fff35dd7e9c67d706)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
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, 2022-2023  Intel Corporation
10  */
11 
12 #include <crypto/utils.h>
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"
25 #include "aes_ccm.h"
26 #include "aes_cmac.h"
27 #include "aes_gmac.h"
28 #include "aes_gcm.h"
29 
30 
31 /**
32  * DOC: Key handling basics
33  *
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.
37  *
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.
45  *
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.
52  */
53 
54 static const u8 bcast_addr[ETH_ALEN] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
55 
56 static void
57 update_vlan_tailroom_need_count(struct ieee80211_sub_if_data *sdata, int delta)
58 {
59 	struct ieee80211_sub_if_data *vlan;
60 
61 	if (sdata->vif.type != NL80211_IFTYPE_AP)
62 		return;
63 
64 	/* crypto_tx_tailroom_needed_cnt is protected by this */
65 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
66 
67 	rcu_read_lock();
68 
69 	list_for_each_entry_rcu(vlan, &sdata->u.ap.vlans, u.vlan.list)
70 		vlan->crypto_tx_tailroom_needed_cnt += delta;
71 
72 	rcu_read_unlock();
73 }
74 
75 static void increment_tailroom_need_count(struct ieee80211_sub_if_data *sdata)
76 {
77 	/*
78 	 * When this count is zero, SKB resizing for allocating tailroom
79 	 * for IV or MMIC is skipped. But, this check has created two race
80 	 * cases in xmit path while transiting from zero count to one:
81 	 *
82 	 * 1. SKB resize was skipped because no key was added but just before
83 	 * the xmit key is added and SW encryption kicks off.
84 	 *
85 	 * 2. SKB resize was skipped because all the keys were hw planted but
86 	 * just before xmit one of the key is deleted and SW encryption kicks
87 	 * off.
88 	 *
89 	 * In both the above case SW encryption will find not enough space for
90 	 * tailroom and exits with WARN_ON. (See WARN_ONs at wpa.c)
91 	 *
92 	 * Solution has been explained at
93 	 * http://mid.gmane.org/1308590980.4322.19.camel@jlt3.sipsolutions.net
94 	 */
95 
96 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
97 
98 	update_vlan_tailroom_need_count(sdata, 1);
99 
100 	if (!sdata->crypto_tx_tailroom_needed_cnt++) {
101 		/*
102 		 * Flush all XMIT packets currently using HW encryption or no
103 		 * encryption at all if the count transition is from 0 -> 1.
104 		 */
105 		synchronize_net();
106 	}
107 }
108 
109 static void decrease_tailroom_need_count(struct ieee80211_sub_if_data *sdata,
110 					 int delta)
111 {
112 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
113 
114 	WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt < delta);
115 
116 	update_vlan_tailroom_need_count(sdata, -delta);
117 	sdata->crypto_tx_tailroom_needed_cnt -= delta;
118 }
119 
120 static int ieee80211_key_enable_hw_accel(struct ieee80211_key *key)
121 {
122 	struct ieee80211_sub_if_data *sdata = key->sdata;
123 	struct sta_info *sta;
124 	int ret = -EOPNOTSUPP;
125 
126 	might_sleep();
127 	lockdep_assert_wiphy(key->local->hw.wiphy);
128 
129 	if (key->flags & KEY_FLAG_TAINTED) {
130 		/* If we get here, it's during resume and the key is
131 		 * tainted so shouldn't be used/programmed any more.
132 		 * However, its flags may still indicate that it was
133 		 * programmed into the device (since we're in resume)
134 		 * so clear that flag now to avoid trying to remove
135 		 * it again later.
136 		 */
137 		if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE &&
138 		    !(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
139 					 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
140 					 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
141 			increment_tailroom_need_count(sdata);
142 
143 		key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
144 		return -EINVAL;
145 	}
146 
147 	if (!key->local->ops->set_key)
148 		goto out_unsupported;
149 
150 	sta = key->sta;
151 
152 	/*
153 	 * If this is a per-STA GTK, check if it
154 	 * is supported; if not, return.
155 	 */
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;
159 
160 	if (sta && !sta->uploaded)
161 		goto out_unsupported;
162 
163 	if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
164 		/*
165 		 * The driver doesn't know anything about VLAN interfaces.
166 		 * Hence, don't send GTKs for VLAN interfaces to the driver.
167 		 */
168 		if (!(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
169 			ret = 1;
170 			goto out_unsupported;
171 		}
172 	}
173 
174 	if (key->conf.link_id >= 0 && sdata->vif.active_links &&
175 	    !(sdata->vif.active_links & BIT(key->conf.link_id)))
176 		return 0;
177 
178 	ret = drv_set_key(key->local, SET_KEY, sdata,
179 			  sta ? &sta->sta : NULL, &key->conf);
180 
181 	if (!ret) {
182 		key->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
183 
184 		if (!(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
185 					 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
186 					 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
187 			decrease_tailroom_need_count(sdata, 1);
188 
189 		WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_IV_SPACE) &&
190 			(key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_IV));
191 
192 		WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_MIC_SPACE) &&
193 			(key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC));
194 
195 		return 0;
196 	}
197 
198 	if (ret != -ENOSPC && ret != -EOPNOTSUPP && ret != 1)
199 		sdata_err(sdata,
200 			  "failed to set key (%d, %pM) to hardware (%d)\n",
201 			  key->conf.keyidx,
202 			  sta ? sta->sta.addr : bcast_addr, ret);
203 
204  out_unsupported:
205 	switch (key->conf.cipher) {
206 	case WLAN_CIPHER_SUITE_WEP40:
207 	case WLAN_CIPHER_SUITE_WEP104:
208 	case WLAN_CIPHER_SUITE_TKIP:
209 	case WLAN_CIPHER_SUITE_CCMP:
210 	case WLAN_CIPHER_SUITE_CCMP_256:
211 	case WLAN_CIPHER_SUITE_GCMP:
212 	case WLAN_CIPHER_SUITE_GCMP_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 		/* all of these we can do in software - if driver can */
218 		if (ret == 1)
219 			return 0;
220 		if (ieee80211_hw_check(&key->local->hw, SW_CRYPTO_CONTROL))
221 			return -EINVAL;
222 		return 0;
223 	default:
224 		return -EINVAL;
225 	}
226 }
227 
228 static void ieee80211_key_disable_hw_accel(struct ieee80211_key *key)
229 {
230 	struct ieee80211_sub_if_data *sdata;
231 	struct sta_info *sta;
232 	int ret;
233 
234 	might_sleep();
235 
236 	if (!key || !key->local->ops->set_key)
237 		return;
238 
239 	if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
240 		return;
241 
242 	sta = key->sta;
243 	sdata = key->sdata;
244 
245 	lockdep_assert_wiphy(key->local->hw.wiphy);
246 
247 	if (key->conf.link_id >= 0 && sdata->vif.active_links &&
248 	    !(sdata->vif.active_links & BIT(key->conf.link_id)))
249 		return;
250 
251 	if (!(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
252 				 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
253 				 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
254 		increment_tailroom_need_count(sdata);
255 
256 	key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
257 	ret = drv_set_key(key->local, DISABLE_KEY, sdata,
258 			  sta ? &sta->sta : NULL, &key->conf);
259 
260 	if (ret)
261 		sdata_err(sdata,
262 			  "failed to remove key (%d, %pM) from hardware (%d)\n",
263 			  key->conf.keyidx,
264 			  sta ? sta->sta.addr : bcast_addr, ret);
265 }
266 
267 static int _ieee80211_set_tx_key(struct ieee80211_key *key, bool force)
268 {
269 	struct sta_info *sta = key->sta;
270 	struct ieee80211_local *local = key->local;
271 
272 	lockdep_assert_wiphy(local->hw.wiphy);
273 
274 	set_sta_flag(sta, WLAN_STA_USES_ENCRYPTION);
275 
276 	sta->ptk_idx = key->conf.keyidx;
277 
278 	if (force || !ieee80211_hw_check(&local->hw, AMPDU_KEYBORDER_SUPPORT))
279 		clear_sta_flag(sta, WLAN_STA_BLOCK_BA);
280 	ieee80211_check_fast_xmit(sta);
281 
282 	return 0;
283 }
284 
285 int ieee80211_set_tx_key(struct ieee80211_key *key)
286 {
287 	return _ieee80211_set_tx_key(key, false);
288 }
289 
290 static void ieee80211_pairwise_rekey(struct ieee80211_key *old,
291 				     struct ieee80211_key *new)
292 {
293 	struct ieee80211_local *local = new->local;
294 	struct sta_info *sta = new->sta;
295 	int i;
296 
297 	lockdep_assert_wiphy(local->hw.wiphy);
298 
299 	if (new->conf.flags & IEEE80211_KEY_FLAG_NO_AUTO_TX) {
300 		/* Extended Key ID key install, initial one or rekey */
301 
302 		if (sta->ptk_idx != INVALID_PTK_KEYIDX &&
303 		    !ieee80211_hw_check(&local->hw, AMPDU_KEYBORDER_SUPPORT)) {
304 			/* Aggregation Sessions with Extended Key ID must not
305 			 * mix MPDUs with different keyIDs within one A-MPDU.
306 			 * Tear down running Tx aggregation sessions and block
307 			 * new Rx/Tx aggregation requests during rekey to
308 			 * ensure there are no A-MPDUs when the driver is not
309 			 * supporting A-MPDU key borders. (Blocking Tx only
310 			 * would be sufficient but WLAN_STA_BLOCK_BA gets the
311 			 * job done for the few ms we need it.)
312 			 */
313 			set_sta_flag(sta, WLAN_STA_BLOCK_BA);
314 			for (i = 0; i <  IEEE80211_NUM_TIDS; i++)
315 				__ieee80211_stop_tx_ba_session(sta, i,
316 							       AGG_STOP_LOCAL_REQUEST);
317 		}
318 	} else if (old) {
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
322 		 * crypto, though.
323 		 */
324 		if (!(old->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
325 			return;
326 
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);
334 		}
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.",
338 					    sta->sta.addr);
339 			/* Flushing the driver queues *may* help prevent
340 			 * the clear text leaks and freezes.
341 			 */
342 			ieee80211_flush_queues(local, old->sdata, false);
343 		}
344 	}
345 }
346 
347 static void __ieee80211_set_default_key(struct ieee80211_link_data *link,
348 					int idx, bool uni, bool multi)
349 {
350 	struct ieee80211_sub_if_data *sdata = link->sdata;
351 	struct ieee80211_key *key = NULL;
352 
353 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
354 
355 	if (idx >= 0 && idx < NUM_DEFAULT_KEYS) {
356 		key = wiphy_dereference(sdata->local->hw.wiphy,
357 					sdata->keys[idx]);
358 		if (!key)
359 			key = wiphy_dereference(sdata->local->hw.wiphy,
360 						link->gtk[idx]);
361 	}
362 
363 	if (uni) {
364 		rcu_assign_pointer(sdata->default_unicast_key, key);
365 		ieee80211_check_fast_xmit_iface(sdata);
366 		if (sdata->vif.type != NL80211_IFTYPE_AP_VLAN)
367 			drv_set_default_unicast_key(sdata->local, sdata, idx);
368 	}
369 
370 	if (multi)
371 		rcu_assign_pointer(link->default_multicast_key, key);
372 
373 	ieee80211_debugfs_key_update_default(sdata);
374 }
375 
376 void ieee80211_set_default_key(struct ieee80211_link_data *link, int idx,
377 			       bool uni, bool multi)
378 {
379 	lockdep_assert_wiphy(link->sdata->local->hw.wiphy);
380 
381 	__ieee80211_set_default_key(link, idx, uni, multi);
382 }
383 
384 static void
385 __ieee80211_set_default_mgmt_key(struct ieee80211_link_data *link, int idx)
386 {
387 	struct ieee80211_sub_if_data *sdata = link->sdata;
388 	struct ieee80211_key *key = NULL;
389 
390 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
391 
392 	if (idx >= NUM_DEFAULT_KEYS &&
393 	    idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS)
394 		key = wiphy_dereference(sdata->local->hw.wiphy,
395 					link->gtk[idx]);
396 
397 	rcu_assign_pointer(link->default_mgmt_key, key);
398 
399 	ieee80211_debugfs_key_update_default(sdata);
400 }
401 
402 void ieee80211_set_default_mgmt_key(struct ieee80211_link_data *link,
403 				    int idx)
404 {
405 	lockdep_assert_wiphy(link->sdata->local->hw.wiphy);
406 
407 	__ieee80211_set_default_mgmt_key(link, idx);
408 }
409 
410 static void
411 __ieee80211_set_default_beacon_key(struct ieee80211_link_data *link, int idx)
412 {
413 	struct ieee80211_sub_if_data *sdata = link->sdata;
414 	struct ieee80211_key *key = NULL;
415 
416 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
417 
418 	if (idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS &&
419 	    idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS +
420 	    NUM_DEFAULT_BEACON_KEYS)
421 		key = wiphy_dereference(sdata->local->hw.wiphy,
422 					link->gtk[idx]);
423 
424 	rcu_assign_pointer(link->default_beacon_key, key);
425 
426 	ieee80211_debugfs_key_update_default(sdata);
427 }
428 
429 void ieee80211_set_default_beacon_key(struct ieee80211_link_data *link,
430 				      int idx)
431 {
432 	lockdep_assert_wiphy(link->sdata->local->hw.wiphy);
433 
434 	__ieee80211_set_default_beacon_key(link, idx);
435 }
436 
437 static int ieee80211_key_replace(struct ieee80211_sub_if_data *sdata,
438 				 struct ieee80211_link_data *link,
439 				 struct sta_info *sta,
440 				 bool pairwise,
441 				 struct ieee80211_key *old,
442 				 struct ieee80211_key *new)
443 {
444 	struct link_sta_info *link_sta = sta ? &sta->deflink : NULL;
445 	int link_id;
446 	int idx;
447 	int ret = 0;
448 	bool defunikey, defmultikey, defmgmtkey, defbeaconkey;
449 	bool is_wep;
450 
451 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
452 
453 	/* caller must provide at least one old/new */
454 	if (WARN_ON(!new && !old))
455 		return 0;
456 
457 	if (new) {
458 		idx = new->conf.keyidx;
459 		is_wep = new->conf.cipher == WLAN_CIPHER_SUITE_WEP40 ||
460 			 new->conf.cipher == WLAN_CIPHER_SUITE_WEP104;
461 		link_id = new->conf.link_id;
462 	} else {
463 		idx = old->conf.keyidx;
464 		is_wep = old->conf.cipher == WLAN_CIPHER_SUITE_WEP40 ||
465 			 old->conf.cipher == WLAN_CIPHER_SUITE_WEP104;
466 		link_id = old->conf.link_id;
467 	}
468 
469 	if (WARN(old && old->conf.link_id != link_id,
470 		 "old link ID %d doesn't match new link ID %d\n",
471 		 old->conf.link_id, link_id))
472 		return -EINVAL;
473 
474 	if (link_id >= 0) {
475 		if (!link) {
476 			link = sdata_dereference(sdata->link[link_id], sdata);
477 			if (!link)
478 				return -ENOLINK;
479 		}
480 
481 		if (sta) {
482 			link_sta = rcu_dereference_protected(sta->link[link_id],
483 							     lockdep_is_held(&sta->local->hw.wiphy->mtx));
484 			if (!link_sta)
485 				return -ENOLINK;
486 		}
487 	} else {
488 		link = &sdata->deflink;
489 	}
490 
491 	if ((is_wep || pairwise) && idx >= NUM_DEFAULT_KEYS)
492 		return -EINVAL;
493 
494 	WARN_ON(new && old && new->conf.keyidx != old->conf.keyidx);
495 
496 	if (new && sta && pairwise) {
497 		/* Unicast rekey needs special handling. With Extended Key ID
498 		 * old is still NULL for the first rekey.
499 		 */
500 		ieee80211_pairwise_rekey(old, new);
501 	}
502 
503 	if (old) {
504 		if (old->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
505 			ieee80211_key_disable_hw_accel(old);
506 
507 			if (new)
508 				ret = ieee80211_key_enable_hw_accel(new);
509 		}
510 	} else {
511 		if (!new->local->wowlan)
512 			ret = ieee80211_key_enable_hw_accel(new);
513 		else
514 			new->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
515 	}
516 
517 	if (ret)
518 		return ret;
519 
520 	if (new)
521 		list_add_tail_rcu(&new->list, &sdata->key_list);
522 
523 	if (sta) {
524 		if (pairwise) {
525 			rcu_assign_pointer(sta->ptk[idx], new);
526 			if (new &&
527 			    !(new->conf.flags & IEEE80211_KEY_FLAG_NO_AUTO_TX))
528 				_ieee80211_set_tx_key(new, true);
529 		} else {
530 			rcu_assign_pointer(link_sta->gtk[idx], new);
531 		}
532 		/* Only needed for transition from no key -> key.
533 		 * Still triggers unnecessary when using Extended Key ID
534 		 * and installing the second key ID the first time.
535 		 */
536 		if (new && !old)
537 			ieee80211_check_fast_rx(sta);
538 	} else {
539 		defunikey = old &&
540 			old == wiphy_dereference(sdata->local->hw.wiphy,
541 						 sdata->default_unicast_key);
542 		defmultikey = old &&
543 			old == wiphy_dereference(sdata->local->hw.wiphy,
544 						 link->default_multicast_key);
545 		defmgmtkey = old &&
546 			old == wiphy_dereference(sdata->local->hw.wiphy,
547 						 link->default_mgmt_key);
548 		defbeaconkey = old &&
549 			old == wiphy_dereference(sdata->local->hw.wiphy,
550 						 link->default_beacon_key);
551 
552 		if (defunikey && !new)
553 			__ieee80211_set_default_key(link, -1, true, false);
554 		if (defmultikey && !new)
555 			__ieee80211_set_default_key(link, -1, false, true);
556 		if (defmgmtkey && !new)
557 			__ieee80211_set_default_mgmt_key(link, -1);
558 		if (defbeaconkey && !new)
559 			__ieee80211_set_default_beacon_key(link, -1);
560 
561 		if (is_wep || pairwise)
562 			rcu_assign_pointer(sdata->keys[idx], new);
563 		else
564 			rcu_assign_pointer(link->gtk[idx], new);
565 
566 		if (defunikey && new)
567 			__ieee80211_set_default_key(link, new->conf.keyidx,
568 						    true, false);
569 		if (defmultikey && new)
570 			__ieee80211_set_default_key(link, new->conf.keyidx,
571 						    false, true);
572 		if (defmgmtkey && new)
573 			__ieee80211_set_default_mgmt_key(link,
574 							 new->conf.keyidx);
575 		if (defbeaconkey && new)
576 			__ieee80211_set_default_beacon_key(link,
577 							   new->conf.keyidx);
578 	}
579 
580 	if (old)
581 		list_del_rcu(&old->list);
582 
583 	return 0;
584 }
585 
586 struct ieee80211_key *
587 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
588 		    const u8 *key_data,
589 		    size_t seq_len, const u8 *seq)
590 {
591 	struct ieee80211_key *key;
592 	int i, j, err;
593 
594 	if (WARN_ON(idx < 0 ||
595 		    idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS +
596 		    NUM_DEFAULT_BEACON_KEYS))
597 		return ERR_PTR(-EINVAL);
598 
599 	key = kzalloc(sizeof(struct ieee80211_key) + key_len, GFP_KERNEL);
600 	if (!key)
601 		return ERR_PTR(-ENOMEM);
602 
603 	/*
604 	 * Default to software encryption; we'll later upload the
605 	 * key to the hardware if possible.
606 	 */
607 	key->conf.flags = 0;
608 	key->flags = 0;
609 
610 	key->conf.link_id = -1;
611 	key->conf.cipher = cipher;
612 	key->conf.keyidx = idx;
613 	key->conf.keylen = key_len;
614 	switch (cipher) {
615 	case WLAN_CIPHER_SUITE_WEP40:
616 	case WLAN_CIPHER_SUITE_WEP104:
617 		key->conf.iv_len = IEEE80211_WEP_IV_LEN;
618 		key->conf.icv_len = IEEE80211_WEP_ICV_LEN;
619 		break;
620 	case WLAN_CIPHER_SUITE_TKIP:
621 		key->conf.iv_len = IEEE80211_TKIP_IV_LEN;
622 		key->conf.icv_len = IEEE80211_TKIP_ICV_LEN;
623 		if (seq) {
624 			for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
625 				key->u.tkip.rx[i].iv32 =
626 					get_unaligned_le32(&seq[2]);
627 				key->u.tkip.rx[i].iv16 =
628 					get_unaligned_le16(seq);
629 			}
630 		}
631 		spin_lock_init(&key->u.tkip.txlock);
632 		break;
633 	case WLAN_CIPHER_SUITE_CCMP:
634 		key->conf.iv_len = IEEE80211_CCMP_HDR_LEN;
635 		key->conf.icv_len = IEEE80211_CCMP_MIC_LEN;
636 		if (seq) {
637 			for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
638 				for (j = 0; j < IEEE80211_CCMP_PN_LEN; j++)
639 					key->u.ccmp.rx_pn[i][j] =
640 						seq[IEEE80211_CCMP_PN_LEN - j - 1];
641 		}
642 		/*
643 		 * Initialize AES key state here as an optimization so that
644 		 * it does not need to be initialized for every packet.
645 		 */
646 		key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
647 			key_data, key_len, IEEE80211_CCMP_MIC_LEN);
648 		if (IS_ERR(key->u.ccmp.tfm)) {
649 			err = PTR_ERR(key->u.ccmp.tfm);
650 			kfree(key);
651 			return ERR_PTR(err);
652 		}
653 		break;
654 	case WLAN_CIPHER_SUITE_CCMP_256:
655 		key->conf.iv_len = IEEE80211_CCMP_256_HDR_LEN;
656 		key->conf.icv_len = IEEE80211_CCMP_256_MIC_LEN;
657 		for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
658 			for (j = 0; j < IEEE80211_CCMP_256_PN_LEN; j++)
659 				key->u.ccmp.rx_pn[i][j] =
660 					seq[IEEE80211_CCMP_256_PN_LEN - j - 1];
661 		/* Initialize AES key state here as an optimization so that
662 		 * it does not need to be initialized for every packet.
663 		 */
664 		key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
665 			key_data, key_len, IEEE80211_CCMP_256_MIC_LEN);
666 		if (IS_ERR(key->u.ccmp.tfm)) {
667 			err = PTR_ERR(key->u.ccmp.tfm);
668 			kfree(key);
669 			return ERR_PTR(err);
670 		}
671 		break;
672 	case WLAN_CIPHER_SUITE_AES_CMAC:
673 	case WLAN_CIPHER_SUITE_BIP_CMAC_256:
674 		key->conf.iv_len = 0;
675 		if (cipher == WLAN_CIPHER_SUITE_AES_CMAC)
676 			key->conf.icv_len = sizeof(struct ieee80211_mmie);
677 		else
678 			key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
679 		if (seq)
680 			for (j = 0; j < IEEE80211_CMAC_PN_LEN; j++)
681 				key->u.aes_cmac.rx_pn[j] =
682 					seq[IEEE80211_CMAC_PN_LEN - j - 1];
683 		/*
684 		 * Initialize AES key state here as an optimization so that
685 		 * it does not need to be initialized for every packet.
686 		 */
687 		key->u.aes_cmac.tfm =
688 			ieee80211_aes_cmac_key_setup(key_data, key_len);
689 		if (IS_ERR(key->u.aes_cmac.tfm)) {
690 			err = PTR_ERR(key->u.aes_cmac.tfm);
691 			kfree(key);
692 			return ERR_PTR(err);
693 		}
694 		break;
695 	case WLAN_CIPHER_SUITE_BIP_GMAC_128:
696 	case WLAN_CIPHER_SUITE_BIP_GMAC_256:
697 		key->conf.iv_len = 0;
698 		key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
699 		if (seq)
700 			for (j = 0; j < IEEE80211_GMAC_PN_LEN; j++)
701 				key->u.aes_gmac.rx_pn[j] =
702 					seq[IEEE80211_GMAC_PN_LEN - j - 1];
703 		/* Initialize AES key state here as an optimization so that
704 		 * it does not need to be initialized for every packet.
705 		 */
706 		key->u.aes_gmac.tfm =
707 			ieee80211_aes_gmac_key_setup(key_data, key_len);
708 		if (IS_ERR(key->u.aes_gmac.tfm)) {
709 			err = PTR_ERR(key->u.aes_gmac.tfm);
710 			kfree(key);
711 			return ERR_PTR(err);
712 		}
713 		break;
714 	case WLAN_CIPHER_SUITE_GCMP:
715 	case WLAN_CIPHER_SUITE_GCMP_256:
716 		key->conf.iv_len = IEEE80211_GCMP_HDR_LEN;
717 		key->conf.icv_len = IEEE80211_GCMP_MIC_LEN;
718 		for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
719 			for (j = 0; j < IEEE80211_GCMP_PN_LEN; j++)
720 				key->u.gcmp.rx_pn[i][j] =
721 					seq[IEEE80211_GCMP_PN_LEN - j - 1];
722 		/* Initialize AES key state here as an optimization so that
723 		 * it does not need to be initialized for every packet.
724 		 */
725 		key->u.gcmp.tfm = ieee80211_aes_gcm_key_setup_encrypt(key_data,
726 								      key_len);
727 		if (IS_ERR(key->u.gcmp.tfm)) {
728 			err = PTR_ERR(key->u.gcmp.tfm);
729 			kfree(key);
730 			return ERR_PTR(err);
731 		}
732 		break;
733 	}
734 	memcpy(key->conf.key, key_data, key_len);
735 	INIT_LIST_HEAD(&key->list);
736 
737 	return key;
738 }
739 
740 static void ieee80211_key_free_common(struct ieee80211_key *key)
741 {
742 	switch (key->conf.cipher) {
743 	case WLAN_CIPHER_SUITE_CCMP:
744 	case WLAN_CIPHER_SUITE_CCMP_256:
745 		ieee80211_aes_key_free(key->u.ccmp.tfm);
746 		break;
747 	case WLAN_CIPHER_SUITE_AES_CMAC:
748 	case WLAN_CIPHER_SUITE_BIP_CMAC_256:
749 		ieee80211_aes_cmac_key_free(key->u.aes_cmac.tfm);
750 		break;
751 	case WLAN_CIPHER_SUITE_BIP_GMAC_128:
752 	case WLAN_CIPHER_SUITE_BIP_GMAC_256:
753 		ieee80211_aes_gmac_key_free(key->u.aes_gmac.tfm);
754 		break;
755 	case WLAN_CIPHER_SUITE_GCMP:
756 	case WLAN_CIPHER_SUITE_GCMP_256:
757 		ieee80211_aes_gcm_key_free(key->u.gcmp.tfm);
758 		break;
759 	}
760 	kfree_sensitive(key);
761 }
762 
763 static void __ieee80211_key_destroy(struct ieee80211_key *key,
764 				    bool delay_tailroom)
765 {
766 	if (key->local) {
767 		struct ieee80211_sub_if_data *sdata = key->sdata;
768 
769 		ieee80211_debugfs_key_remove(key);
770 
771 		if (delay_tailroom) {
772 			/* see ieee80211_delayed_tailroom_dec */
773 			sdata->crypto_tx_tailroom_pending_dec++;
774 			wiphy_delayed_work_queue(sdata->local->hw.wiphy,
775 						 &sdata->dec_tailroom_needed_wk,
776 						 HZ / 2);
777 		} else {
778 			decrease_tailroom_need_count(sdata, 1);
779 		}
780 	}
781 
782 	ieee80211_key_free_common(key);
783 }
784 
785 static void ieee80211_key_destroy(struct ieee80211_key *key,
786 				  bool delay_tailroom)
787 {
788 	if (!key)
789 		return;
790 
791 	/*
792 	 * Synchronize so the TX path and rcu key iterators
793 	 * can no longer be using this key before we free/remove it.
794 	 */
795 	synchronize_net();
796 
797 	__ieee80211_key_destroy(key, delay_tailroom);
798 }
799 
800 void ieee80211_key_free_unused(struct ieee80211_key *key)
801 {
802 	WARN_ON(key->sdata || key->local);
803 	ieee80211_key_free_common(key);
804 }
805 
806 static bool ieee80211_key_identical(struct ieee80211_sub_if_data *sdata,
807 				    struct ieee80211_key *old,
808 				    struct ieee80211_key *new)
809 {
810 	u8 tkip_old[WLAN_KEY_LEN_TKIP], tkip_new[WLAN_KEY_LEN_TKIP];
811 	u8 *tk_old, *tk_new;
812 
813 	if (!old || new->conf.keylen != old->conf.keylen)
814 		return false;
815 
816 	tk_old = old->conf.key;
817 	tk_new = new->conf.key;
818 
819 	/*
820 	 * In station mode, don't compare the TX MIC key, as it's never used
821 	 * and offloaded rekeying may not care to send it to the host. This
822 	 * is the case in iwlwifi, for example.
823 	 */
824 	if (sdata->vif.type == NL80211_IFTYPE_STATION &&
825 	    new->conf.cipher == WLAN_CIPHER_SUITE_TKIP &&
826 	    new->conf.keylen == WLAN_KEY_LEN_TKIP &&
827 	    !(new->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
828 		memcpy(tkip_old, tk_old, WLAN_KEY_LEN_TKIP);
829 		memcpy(tkip_new, tk_new, WLAN_KEY_LEN_TKIP);
830 		memset(tkip_old + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
831 		memset(tkip_new + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
832 		tk_old = tkip_old;
833 		tk_new = tkip_new;
834 	}
835 
836 	return !crypto_memneq(tk_old, tk_new, new->conf.keylen);
837 }
838 
839 int ieee80211_key_link(struct ieee80211_key *key,
840 		       struct ieee80211_link_data *link,
841 		       struct sta_info *sta)
842 {
843 	struct ieee80211_sub_if_data *sdata = link->sdata;
844 	static atomic_t key_color = ATOMIC_INIT(0);
845 	struct ieee80211_key *old_key = NULL;
846 	int idx = key->conf.keyidx;
847 	bool pairwise = key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE;
848 	/*
849 	 * We want to delay tailroom updates only for station - in that
850 	 * case it helps roaming speed, but in other cases it hurts and
851 	 * can cause warnings to appear.
852 	 */
853 	bool delay_tailroom = sdata->vif.type == NL80211_IFTYPE_STATION;
854 	int ret;
855 
856 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
857 
858 	if (sta && pairwise) {
859 		struct ieee80211_key *alt_key;
860 
861 		old_key = wiphy_dereference(sdata->local->hw.wiphy,
862 					    sta->ptk[idx]);
863 		alt_key = wiphy_dereference(sdata->local->hw.wiphy,
864 					    sta->ptk[idx ^ 1]);
865 
866 		/* The rekey code assumes that the old and new key are using
867 		 * the same cipher. Enforce the assumption for pairwise keys.
868 		 */
869 		if ((alt_key && alt_key->conf.cipher != key->conf.cipher) ||
870 		    (old_key && old_key->conf.cipher != key->conf.cipher))
871 			return -EOPNOTSUPP;
872 	} else if (sta) {
873 		struct link_sta_info *link_sta = &sta->deflink;
874 		int link_id = key->conf.link_id;
875 
876 		if (link_id >= 0) {
877 			link_sta = rcu_dereference_protected(sta->link[link_id],
878 							     lockdep_is_held(&sta->local->hw.wiphy->mtx));
879 			if (!link_sta)
880 				return -ENOLINK;
881 		}
882 
883 		old_key = wiphy_dereference(sdata->local->hw.wiphy,
884 					    link_sta->gtk[idx]);
885 	} else {
886 		if (idx < NUM_DEFAULT_KEYS)
887 			old_key = wiphy_dereference(sdata->local->hw.wiphy,
888 						    sdata->keys[idx]);
889 		if (!old_key)
890 			old_key = wiphy_dereference(sdata->local->hw.wiphy,
891 						    link->gtk[idx]);
892 	}
893 
894 	/* Non-pairwise keys must also not switch the cipher on rekey */
895 	if (!pairwise) {
896 		if (old_key && old_key->conf.cipher != key->conf.cipher)
897 			return -EOPNOTSUPP;
898 	}
899 
900 	/*
901 	 * Silently accept key re-installation without really installing the
902 	 * new version of the key to avoid nonce reuse or replay issues.
903 	 */
904 	if (ieee80211_key_identical(sdata, old_key, key)) {
905 		ieee80211_key_free_unused(key);
906 		return 0;
907 	}
908 
909 	key->local = sdata->local;
910 	key->sdata = sdata;
911 	key->sta = sta;
912 
913 	/*
914 	 * Assign a unique ID to every key so we can easily prevent mixed
915 	 * key and fragment cache attacks.
916 	 */
917 	key->color = atomic_inc_return(&key_color);
918 
919 	increment_tailroom_need_count(sdata);
920 
921 	ret = ieee80211_key_replace(sdata, link, sta, pairwise, old_key, key);
922 
923 	if (!ret) {
924 		ieee80211_debugfs_key_add(key);
925 		ieee80211_key_destroy(old_key, delay_tailroom);
926 	} else {
927 		ieee80211_key_free(key, delay_tailroom);
928 	}
929 
930 	return ret;
931 }
932 
933 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom)
934 {
935 	if (!key)
936 		return;
937 
938 	/*
939 	 * Replace key with nothingness if it was ever used.
940 	 */
941 	if (key->sdata)
942 		ieee80211_key_replace(key->sdata, NULL, key->sta,
943 				      key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
944 				      key, NULL);
945 	ieee80211_key_destroy(key, delay_tailroom);
946 }
947 
948 void ieee80211_reenable_keys(struct ieee80211_sub_if_data *sdata)
949 {
950 	struct ieee80211_key *key;
951 	struct ieee80211_sub_if_data *vlan;
952 
953 	lockdep_assert_wiphy(sdata->local->hw.wiphy);
954 
955 	sdata->crypto_tx_tailroom_needed_cnt = 0;
956 	sdata->crypto_tx_tailroom_pending_dec = 0;
957 
958 	if (sdata->vif.type == NL80211_IFTYPE_AP) {
959 		list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list) {
960 			vlan->crypto_tx_tailroom_needed_cnt = 0;
961 			vlan->crypto_tx_tailroom_pending_dec = 0;
962 		}
963 	}
964 
965 	if (ieee80211_sdata_running(sdata)) {
966 		list_for_each_entry(key, &sdata->key_list, list) {
967 			increment_tailroom_need_count(sdata);
968 			ieee80211_key_enable_hw_accel(key);
969 		}
970 	}
971 }
972 
973 void ieee80211_iter_keys(struct ieee80211_hw *hw,
974 			 struct ieee80211_vif *vif,
975 			 void (*iter)(struct ieee80211_hw *hw,
976 				      struct ieee80211_vif *vif,
977 				      struct ieee80211_sta *sta,
978 				      struct ieee80211_key_conf *key,
979 				      void *data),
980 			 void *iter_data)
981 {
982 	struct ieee80211_local *local = hw_to_local(hw);
983 	struct ieee80211_key *key, *tmp;
984 	struct ieee80211_sub_if_data *sdata;
985 
986 	lockdep_assert_wiphy(hw->wiphy);
987 
988 	if (vif) {
989 		sdata = vif_to_sdata(vif);
990 		list_for_each_entry_safe(key, tmp, &sdata->key_list, list)
991 			iter(hw, &sdata->vif,
992 			     key->sta ? &key->sta->sta : NULL,
993 			     &key->conf, iter_data);
994 	} else {
995 		list_for_each_entry(sdata, &local->interfaces, list)
996 			list_for_each_entry_safe(key, tmp,
997 						 &sdata->key_list, list)
998 				iter(hw, &sdata->vif,
999 				     key->sta ? &key->sta->sta : NULL,
1000 				     &key->conf, iter_data);
1001 	}
1002 }
1003 EXPORT_SYMBOL(ieee80211_iter_keys);
1004 
1005 static void
1006 _ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
1007 			 struct ieee80211_sub_if_data *sdata,
1008 			 void (*iter)(struct ieee80211_hw *hw,
1009 				      struct ieee80211_vif *vif,
1010 				      struct ieee80211_sta *sta,
1011 				      struct ieee80211_key_conf *key,
1012 				      void *data),
1013 			 void *iter_data)
1014 {
1015 	struct ieee80211_key *key;
1016 
1017 	list_for_each_entry_rcu(key, &sdata->key_list, list) {
1018 		/* skip keys of station in removal process */
1019 		if (key->sta && key->sta->removed)
1020 			continue;
1021 		if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
1022 			continue;
1023 
1024 		iter(hw, &sdata->vif,
1025 		     key->sta ? &key->sta->sta : NULL,
1026 		     &key->conf, iter_data);
1027 	}
1028 }
1029 
1030 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
1031 			     struct ieee80211_vif *vif,
1032 			     void (*iter)(struct ieee80211_hw *hw,
1033 					  struct ieee80211_vif *vif,
1034 					  struct ieee80211_sta *sta,
1035 					  struct ieee80211_key_conf *key,
1036 					  void *data),
1037 			     void *iter_data)
1038 {
1039 	struct ieee80211_local *local = hw_to_local(hw);
1040 	struct ieee80211_sub_if_data *sdata;
1041 
1042 	if (vif) {
1043 		sdata = vif_to_sdata(vif);
1044 		_ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
1045 	} else {
1046 		list_for_each_entry_rcu(sdata, &local->interfaces, list)
1047 			_ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
1048 	}
1049 }
1050 EXPORT_SYMBOL(ieee80211_iter_keys_rcu);
1051 
1052 static void ieee80211_free_keys_iface(struct ieee80211_sub_if_data *sdata,
1053 				      struct list_head *keys)
1054 {
1055 	struct ieee80211_key *key, *tmp;
1056 
1057 	decrease_tailroom_need_count(sdata,
1058 				     sdata->crypto_tx_tailroom_pending_dec);
1059 	sdata->crypto_tx_tailroom_pending_dec = 0;
1060 
1061 	ieee80211_debugfs_key_remove_mgmt_default(sdata);
1062 	ieee80211_debugfs_key_remove_beacon_default(sdata);
1063 
1064 	list_for_each_entry_safe(key, tmp, &sdata->key_list, list) {
1065 		ieee80211_key_replace(key->sdata, NULL, key->sta,
1066 				      key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
1067 				      key, NULL);
1068 		list_add_tail(&key->list, keys);
1069 	}
1070 
1071 	ieee80211_debugfs_key_update_default(sdata);
1072 }
1073 
1074 void ieee80211_remove_link_keys(struct ieee80211_link_data *link,
1075 				struct list_head *keys)
1076 {
1077 	struct ieee80211_sub_if_data *sdata = link->sdata;
1078 	struct ieee80211_local *local = sdata->local;
1079 	struct ieee80211_key *key, *tmp;
1080 
1081 	lockdep_assert_wiphy(local->hw.wiphy);
1082 
1083 	list_for_each_entry_safe(key, tmp, &sdata->key_list, list) {
1084 		if (key->conf.link_id != link->link_id)
1085 			continue;
1086 		ieee80211_key_replace(key->sdata, link, key->sta,
1087 				      key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
1088 				      key, NULL);
1089 		list_add_tail(&key->list, keys);
1090 	}
1091 }
1092 
1093 void ieee80211_free_key_list(struct ieee80211_local *local,
1094 			     struct list_head *keys)
1095 {
1096 	struct ieee80211_key *key, *tmp;
1097 
1098 	lockdep_assert_wiphy(local->hw.wiphy);
1099 
1100 	list_for_each_entry_safe(key, tmp, keys, list)
1101 		__ieee80211_key_destroy(key, false);
1102 }
1103 
1104 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
1105 			 bool force_synchronize)
1106 {
1107 	struct ieee80211_local *local = sdata->local;
1108 	struct ieee80211_sub_if_data *vlan;
1109 	struct ieee80211_sub_if_data *master;
1110 	struct ieee80211_key *key, *tmp;
1111 	LIST_HEAD(keys);
1112 
1113 	wiphy_delayed_work_cancel(local->hw.wiphy,
1114 				  &sdata->dec_tailroom_needed_wk);
1115 
1116 	lockdep_assert_wiphy(local->hw.wiphy);
1117 
1118 	ieee80211_free_keys_iface(sdata, &keys);
1119 
1120 	if (sdata->vif.type == NL80211_IFTYPE_AP) {
1121 		list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
1122 			ieee80211_free_keys_iface(vlan, &keys);
1123 	}
1124 
1125 	if (!list_empty(&keys) || force_synchronize)
1126 		synchronize_net();
1127 	list_for_each_entry_safe(key, tmp, &keys, list)
1128 		__ieee80211_key_destroy(key, false);
1129 
1130 	if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
1131 		if (sdata->bss) {
1132 			master = container_of(sdata->bss,
1133 					      struct ieee80211_sub_if_data,
1134 					      u.ap);
1135 
1136 			WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt !=
1137 				     master->crypto_tx_tailroom_needed_cnt);
1138 		}
1139 	} else {
1140 		WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
1141 			     sdata->crypto_tx_tailroom_pending_dec);
1142 	}
1143 
1144 	if (sdata->vif.type == NL80211_IFTYPE_AP) {
1145 		list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
1146 			WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
1147 				     vlan->crypto_tx_tailroom_pending_dec);
1148 	}
1149 }
1150 
1151 void ieee80211_free_sta_keys(struct ieee80211_local *local,
1152 			     struct sta_info *sta)
1153 {
1154 	struct ieee80211_key *key;
1155 	int i;
1156 
1157 	lockdep_assert_wiphy(local->hw.wiphy);
1158 
1159 	for (i = 0; i < ARRAY_SIZE(sta->deflink.gtk); i++) {
1160 		key = wiphy_dereference(local->hw.wiphy, sta->deflink.gtk[i]);
1161 		if (!key)
1162 			continue;
1163 		ieee80211_key_replace(key->sdata, NULL, key->sta,
1164 				      key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
1165 				      key, NULL);
1166 		__ieee80211_key_destroy(key, key->sdata->vif.type ==
1167 					NL80211_IFTYPE_STATION);
1168 	}
1169 
1170 	for (i = 0; i < NUM_DEFAULT_KEYS; i++) {
1171 		key = wiphy_dereference(local->hw.wiphy, sta->ptk[i]);
1172 		if (!key)
1173 			continue;
1174 		ieee80211_key_replace(key->sdata, NULL, key->sta,
1175 				      key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
1176 				      key, NULL);
1177 		__ieee80211_key_destroy(key, key->sdata->vif.type ==
1178 					NL80211_IFTYPE_STATION);
1179 	}
1180 }
1181 
1182 void ieee80211_delayed_tailroom_dec(struct wiphy *wiphy,
1183 				    struct wiphy_work *wk)
1184 {
1185 	struct ieee80211_sub_if_data *sdata;
1186 
1187 	sdata = container_of(wk, struct ieee80211_sub_if_data,
1188 			     dec_tailroom_needed_wk.work);
1189 
1190 	/*
1191 	 * The reason for the delayed tailroom needed decrementing is to
1192 	 * make roaming faster: during roaming, all keys are first deleted
1193 	 * and then new keys are installed. The first new key causes the
1194 	 * crypto_tx_tailroom_needed_cnt to go from 0 to 1, which invokes
1195 	 * the cost of synchronize_net() (which can be slow). Avoid this
1196 	 * by deferring the crypto_tx_tailroom_needed_cnt decrementing on
1197 	 * key removal for a while, so if we roam the value is larger than
1198 	 * zero and no 0->1 transition happens.
1199 	 *
1200 	 * The cost is that if the AP switching was from an AP with keys
1201 	 * to one without, we still allocate tailroom while it would no
1202 	 * longer be needed. However, in the typical (fast) roaming case
1203 	 * within an ESS this usually won't happen.
1204 	 */
1205 
1206 	decrease_tailroom_need_count(sdata,
1207 				     sdata->crypto_tx_tailroom_pending_dec);
1208 	sdata->crypto_tx_tailroom_pending_dec = 0;
1209 }
1210 
1211 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
1212 				const u8 *replay_ctr, gfp_t gfp)
1213 {
1214 	struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1215 
1216 	trace_api_gtk_rekey_notify(sdata, bssid, replay_ctr);
1217 
1218 	cfg80211_gtk_rekey_notify(sdata->dev, bssid, replay_ctr, gfp);
1219 }
1220 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_notify);
1221 
1222 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
1223 			      int tid, struct ieee80211_key_seq *seq)
1224 {
1225 	struct ieee80211_key *key;
1226 	const u8 *pn;
1227 
1228 	key = container_of(keyconf, struct ieee80211_key, conf);
1229 
1230 	switch (key->conf.cipher) {
1231 	case WLAN_CIPHER_SUITE_TKIP:
1232 		if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1233 			return;
1234 		seq->tkip.iv32 = key->u.tkip.rx[tid].iv32;
1235 		seq->tkip.iv16 = key->u.tkip.rx[tid].iv16;
1236 		break;
1237 	case WLAN_CIPHER_SUITE_CCMP:
1238 	case WLAN_CIPHER_SUITE_CCMP_256:
1239 		if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1240 			return;
1241 		if (tid < 0)
1242 			pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1243 		else
1244 			pn = key->u.ccmp.rx_pn[tid];
1245 		memcpy(seq->ccmp.pn, pn, IEEE80211_CCMP_PN_LEN);
1246 		break;
1247 	case WLAN_CIPHER_SUITE_AES_CMAC:
1248 	case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1249 		if (WARN_ON(tid != 0))
1250 			return;
1251 		pn = key->u.aes_cmac.rx_pn;
1252 		memcpy(seq->aes_cmac.pn, pn, IEEE80211_CMAC_PN_LEN);
1253 		break;
1254 	case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1255 	case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1256 		if (WARN_ON(tid != 0))
1257 			return;
1258 		pn = key->u.aes_gmac.rx_pn;
1259 		memcpy(seq->aes_gmac.pn, pn, IEEE80211_GMAC_PN_LEN);
1260 		break;
1261 	case WLAN_CIPHER_SUITE_GCMP:
1262 	case WLAN_CIPHER_SUITE_GCMP_256:
1263 		if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1264 			return;
1265 		if (tid < 0)
1266 			pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1267 		else
1268 			pn = key->u.gcmp.rx_pn[tid];
1269 		memcpy(seq->gcmp.pn, pn, IEEE80211_GCMP_PN_LEN);
1270 		break;
1271 	}
1272 }
1273 EXPORT_SYMBOL(ieee80211_get_key_rx_seq);
1274 
1275 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
1276 			      int tid, struct ieee80211_key_seq *seq)
1277 {
1278 	struct ieee80211_key *key;
1279 	u8 *pn;
1280 
1281 	key = container_of(keyconf, struct ieee80211_key, conf);
1282 
1283 	switch (key->conf.cipher) {
1284 	case WLAN_CIPHER_SUITE_TKIP:
1285 		if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1286 			return;
1287 		key->u.tkip.rx[tid].iv32 = seq->tkip.iv32;
1288 		key->u.tkip.rx[tid].iv16 = seq->tkip.iv16;
1289 		break;
1290 	case WLAN_CIPHER_SUITE_CCMP:
1291 	case WLAN_CIPHER_SUITE_CCMP_256:
1292 		if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1293 			return;
1294 		if (tid < 0)
1295 			pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1296 		else
1297 			pn = key->u.ccmp.rx_pn[tid];
1298 		memcpy(pn, seq->ccmp.pn, IEEE80211_CCMP_PN_LEN);
1299 		break;
1300 	case WLAN_CIPHER_SUITE_AES_CMAC:
1301 	case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1302 		if (WARN_ON(tid != 0))
1303 			return;
1304 		pn = key->u.aes_cmac.rx_pn;
1305 		memcpy(pn, seq->aes_cmac.pn, IEEE80211_CMAC_PN_LEN);
1306 		break;
1307 	case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1308 	case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1309 		if (WARN_ON(tid != 0))
1310 			return;
1311 		pn = key->u.aes_gmac.rx_pn;
1312 		memcpy(pn, seq->aes_gmac.pn, IEEE80211_GMAC_PN_LEN);
1313 		break;
1314 	case WLAN_CIPHER_SUITE_GCMP:
1315 	case WLAN_CIPHER_SUITE_GCMP_256:
1316 		if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1317 			return;
1318 		if (tid < 0)
1319 			pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1320 		else
1321 			pn = key->u.gcmp.rx_pn[tid];
1322 		memcpy(pn, seq->gcmp.pn, IEEE80211_GCMP_PN_LEN);
1323 		break;
1324 	default:
1325 		WARN_ON(1);
1326 		break;
1327 	}
1328 }
1329 EXPORT_SYMBOL_GPL(ieee80211_set_key_rx_seq);
1330 
1331 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf)
1332 {
1333 	struct ieee80211_key *key;
1334 
1335 	key = container_of(keyconf, struct ieee80211_key, conf);
1336 
1337 	lockdep_assert_wiphy(key->local->hw.wiphy);
1338 
1339 	/*
1340 	 * if key was uploaded, we assume the driver will/has remove(d)
1341 	 * it, so adjust bookkeeping accordingly
1342 	 */
1343 	if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
1344 		key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
1345 
1346 		if (!(key->conf.flags & (IEEE80211_KEY_FLAG_GENERATE_MMIC |
1347 					 IEEE80211_KEY_FLAG_PUT_MIC_SPACE |
1348 					 IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
1349 			increment_tailroom_need_count(key->sdata);
1350 	}
1351 
1352 	ieee80211_key_free(key, false);
1353 }
1354 EXPORT_SYMBOL_GPL(ieee80211_remove_key);
1355 
1356 struct ieee80211_key_conf *
1357 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
1358 			struct ieee80211_key_conf *keyconf)
1359 {
1360 	struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1361 	struct ieee80211_local *local = sdata->local;
1362 	struct ieee80211_key *key;
1363 	int err;
1364 
1365 	if (WARN_ON(!local->wowlan))
1366 		return ERR_PTR(-EINVAL);
1367 
1368 	if (WARN_ON(vif->type != NL80211_IFTYPE_STATION))
1369 		return ERR_PTR(-EINVAL);
1370 
1371 	key = ieee80211_key_alloc(keyconf->cipher, keyconf->keyidx,
1372 				  keyconf->keylen, keyconf->key,
1373 				  0, NULL);
1374 	if (IS_ERR(key))
1375 		return ERR_CAST(key);
1376 
1377 	if (sdata->u.mgd.mfp != IEEE80211_MFP_DISABLED)
1378 		key->conf.flags |= IEEE80211_KEY_FLAG_RX_MGMT;
1379 
1380 	/* FIXME: this function needs to get a link ID */
1381 	err = ieee80211_key_link(key, &sdata->deflink, NULL);
1382 	if (err)
1383 		return ERR_PTR(err);
1384 
1385 	return &key->conf;
1386 }
1387 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_add);
1388 
1389 void ieee80211_key_mic_failure(struct ieee80211_key_conf *keyconf)
1390 {
1391 	struct ieee80211_key *key;
1392 
1393 	key = container_of(keyconf, struct ieee80211_key, conf);
1394 
1395 	switch (key->conf.cipher) {
1396 	case WLAN_CIPHER_SUITE_AES_CMAC:
1397 	case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1398 		key->u.aes_cmac.icverrors++;
1399 		break;
1400 	case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1401 	case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1402 		key->u.aes_gmac.icverrors++;
1403 		break;
1404 	default:
1405 		/* ignore the others for now, we don't keep counters now */
1406 		break;
1407 	}
1408 }
1409 EXPORT_SYMBOL_GPL(ieee80211_key_mic_failure);
1410 
1411 void ieee80211_key_replay(struct ieee80211_key_conf *keyconf)
1412 {
1413 	struct ieee80211_key *key;
1414 
1415 	key = container_of(keyconf, struct ieee80211_key, conf);
1416 
1417 	switch (key->conf.cipher) {
1418 	case WLAN_CIPHER_SUITE_CCMP:
1419 	case WLAN_CIPHER_SUITE_CCMP_256:
1420 		key->u.ccmp.replays++;
1421 		break;
1422 	case WLAN_CIPHER_SUITE_AES_CMAC:
1423 	case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1424 		key->u.aes_cmac.replays++;
1425 		break;
1426 	case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1427 	case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1428 		key->u.aes_gmac.replays++;
1429 		break;
1430 	case WLAN_CIPHER_SUITE_GCMP:
1431 	case WLAN_CIPHER_SUITE_GCMP_256:
1432 		key->u.gcmp.replays++;
1433 		break;
1434 	}
1435 }
1436 EXPORT_SYMBOL_GPL(ieee80211_key_replay);
1437 
1438 int ieee80211_key_switch_links(struct ieee80211_sub_if_data *sdata,
1439 			       unsigned long del_links_mask,
1440 			       unsigned long add_links_mask)
1441 {
1442 	struct ieee80211_key *key;
1443 	int ret;
1444 
1445 	list_for_each_entry(key, &sdata->key_list, list) {
1446 		if (key->conf.link_id < 0 ||
1447 		    !(del_links_mask & BIT(key->conf.link_id)))
1448 			continue;
1449 
1450 		/* shouldn't happen for per-link keys */
1451 		WARN_ON(key->sta);
1452 
1453 		ieee80211_key_disable_hw_accel(key);
1454 	}
1455 
1456 	list_for_each_entry(key, &sdata->key_list, list) {
1457 		if (key->conf.link_id < 0 ||
1458 		    !(add_links_mask & BIT(key->conf.link_id)))
1459 			continue;
1460 
1461 		/* shouldn't happen for per-link keys */
1462 		WARN_ON(key->sta);
1463 
1464 		ret = ieee80211_key_enable_hw_accel(key);
1465 		if (ret)
1466 			return ret;
1467 	}
1468 
1469 	return 0;
1470 }
1471