GNU Linux-libre 4.14.290-gnu1
[releases.git] / net / mac80211 / key.c
1 /*
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
8  *
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.
12  */
13
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"
27 #include "aes_ccm.h"
28 #include "aes_cmac.h"
29 #include "aes_gmac.h"
30 #include "aes_gcm.h"
31
32
33 /**
34  * DOC: Key handling basics
35  *
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.
39  *
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.
47  *
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.
54  */
55
56 static const u8 bcast_addr[ETH_ALEN] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
57
58 static void assert_key_lock(struct ieee80211_local *local)
59 {
60         lockdep_assert_held(&local->key_mtx);
61 }
62
63 static void
64 update_vlan_tailroom_need_count(struct ieee80211_sub_if_data *sdata, int delta)
65 {
66         struct ieee80211_sub_if_data *vlan;
67
68         if (sdata->vif.type != NL80211_IFTYPE_AP)
69                 return;
70
71         /* crypto_tx_tailroom_needed_cnt is protected by this */
72         assert_key_lock(sdata->local);
73
74         rcu_read_lock();
75
76         list_for_each_entry_rcu(vlan, &sdata->u.ap.vlans, u.vlan.list)
77                 vlan->crypto_tx_tailroom_needed_cnt += delta;
78
79         rcu_read_unlock();
80 }
81
82 static void increment_tailroom_need_count(struct ieee80211_sub_if_data *sdata)
83 {
84         /*
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:
88          *
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.
91          *
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
94          * off.
95          *
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)
98          *
99          * Solution has been explained at
100          * http://mid.gmane.org/1308590980.4322.19.camel@jlt3.sipsolutions.net
101          */
102
103         assert_key_lock(sdata->local);
104
105         update_vlan_tailroom_need_count(sdata, 1);
106
107         if (!sdata->crypto_tx_tailroom_needed_cnt++) {
108                 /*
109                  * Flush all XMIT packets currently using HW encryption or no
110                  * encryption at all if the count transition is from 0 -> 1.
111                  */
112                 synchronize_net();
113         }
114 }
115
116 static void decrease_tailroom_need_count(struct ieee80211_sub_if_data *sdata,
117                                          int delta)
118 {
119         assert_key_lock(sdata->local);
120
121         WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt < delta);
122
123         update_vlan_tailroom_need_count(sdata, -delta);
124         sdata->crypto_tx_tailroom_needed_cnt -= delta;
125 }
126
127 static int ieee80211_key_enable_hw_accel(struct ieee80211_key *key)
128 {
129         struct ieee80211_sub_if_data *sdata;
130         struct sta_info *sta;
131         int ret = -EOPNOTSUPP;
132
133         might_sleep();
134
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
141                  * it again later.
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         assert_key_lock(key->local);
151
152         sta = key->sta;
153
154         /*
155          * If this is a per-STA GTK, check if it
156          * is supported; if not, return.
157          */
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;
161
162         if (sta && !sta->uploaded)
163                 goto out_unsupported;
164
165         sdata = key->sdata;
166         if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
167                 /*
168                  * The driver doesn't know anything about VLAN interfaces.
169                  * Hence, don't send GTKs for VLAN interfaces to the driver.
170                  */
171                 if (!(key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE))
172                         goto out_unsupported;
173         }
174
175         ret = drv_set_key(key->local, SET_KEY, sdata,
176                           sta ? &sta->sta : NULL, &key->conf);
177
178         if (!ret) {
179                 key->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
180
181                 if (!((key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC) ||
182                       (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
183                         decrease_tailroom_need_count(sdata, 1);
184
185                 WARN_ON((key->conf.flags & IEEE80211_KEY_FLAG_PUT_IV_SPACE) &&
186                         (key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_IV));
187
188                 return 0;
189         }
190
191         if (ret != -ENOSPC && ret != -EOPNOTSUPP && ret != 1)
192                 sdata_err(sdata,
193                           "failed to set key (%d, %pM) to hardware (%d)\n",
194                           key->conf.keyidx,
195                           sta ? sta->sta.addr : bcast_addr, ret);
196
197  out_unsupported:
198         switch (key->conf.cipher) {
199         case WLAN_CIPHER_SUITE_WEP40:
200         case WLAN_CIPHER_SUITE_WEP104:
201         case WLAN_CIPHER_SUITE_TKIP:
202         case WLAN_CIPHER_SUITE_CCMP:
203         case WLAN_CIPHER_SUITE_CCMP_256:
204         case WLAN_CIPHER_SUITE_AES_CMAC:
205         case WLAN_CIPHER_SUITE_BIP_CMAC_256:
206         case WLAN_CIPHER_SUITE_BIP_GMAC_128:
207         case WLAN_CIPHER_SUITE_BIP_GMAC_256:
208         case WLAN_CIPHER_SUITE_GCMP:
209         case WLAN_CIPHER_SUITE_GCMP_256:
210                 /* all of these we can do in software - if driver can */
211                 if (ret == 1)
212                         return 0;
213                 if (ieee80211_hw_check(&key->local->hw, SW_CRYPTO_CONTROL))
214                         return -EINVAL;
215                 return 0;
216         default:
217                 return -EINVAL;
218         }
219 }
220
221 static void ieee80211_key_disable_hw_accel(struct ieee80211_key *key)
222 {
223         struct ieee80211_sub_if_data *sdata;
224         struct sta_info *sta;
225         int ret;
226
227         might_sleep();
228
229         if (!key || !key->local->ops->set_key)
230                 return;
231
232         assert_key_lock(key->local);
233
234         if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
235                 return;
236
237         sta = key->sta;
238         sdata = key->sdata;
239
240         if (!((key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC) ||
241               (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
242                 increment_tailroom_need_count(sdata);
243
244         ret = drv_set_key(key->local, DISABLE_KEY, sdata,
245                           sta ? &sta->sta : NULL, &key->conf);
246
247         if (ret)
248                 sdata_err(sdata,
249                           "failed to remove key (%d, %pM) from hardware (%d)\n",
250                           key->conf.keyidx,
251                           sta ? sta->sta.addr : bcast_addr, ret);
252
253         key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
254 }
255
256 static void __ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata,
257                                         int idx, bool uni, bool multi)
258 {
259         struct ieee80211_key *key = NULL;
260
261         assert_key_lock(sdata->local);
262
263         if (idx >= 0 && idx < NUM_DEFAULT_KEYS)
264                 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
265
266         if (uni) {
267                 rcu_assign_pointer(sdata->default_unicast_key, key);
268                 ieee80211_check_fast_xmit_iface(sdata);
269                 if (sdata->vif.type != NL80211_IFTYPE_AP_VLAN)
270                         drv_set_default_unicast_key(sdata->local, sdata, idx);
271         }
272
273         if (multi)
274                 rcu_assign_pointer(sdata->default_multicast_key, key);
275
276         ieee80211_debugfs_key_update_default(sdata);
277 }
278
279 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
280                                bool uni, bool multi)
281 {
282         mutex_lock(&sdata->local->key_mtx);
283         __ieee80211_set_default_key(sdata, idx, uni, multi);
284         mutex_unlock(&sdata->local->key_mtx);
285 }
286
287 static void
288 __ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata, int idx)
289 {
290         struct ieee80211_key *key = NULL;
291
292         assert_key_lock(sdata->local);
293
294         if (idx >= NUM_DEFAULT_KEYS &&
295             idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS)
296                 key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
297
298         rcu_assign_pointer(sdata->default_mgmt_key, key);
299
300         ieee80211_debugfs_key_update_default(sdata);
301 }
302
303 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
304                                     int idx)
305 {
306         mutex_lock(&sdata->local->key_mtx);
307         __ieee80211_set_default_mgmt_key(sdata, idx);
308         mutex_unlock(&sdata->local->key_mtx);
309 }
310
311
312 static void ieee80211_key_replace(struct ieee80211_sub_if_data *sdata,
313                                   struct sta_info *sta,
314                                   bool pairwise,
315                                   struct ieee80211_key *old,
316                                   struct ieee80211_key *new)
317 {
318         int idx;
319         bool defunikey, defmultikey, defmgmtkey;
320
321         /* caller must provide at least one old/new */
322         if (WARN_ON(!new && !old))
323                 return;
324
325         if (new)
326                 list_add_tail_rcu(&new->list, &sdata->key_list);
327
328         WARN_ON(new && old && new->conf.keyidx != old->conf.keyidx);
329
330         if (old)
331                 idx = old->conf.keyidx;
332         else
333                 idx = new->conf.keyidx;
334
335         if (sta) {
336                 if (pairwise) {
337                         rcu_assign_pointer(sta->ptk[idx], new);
338                         set_sta_flag(sta, WLAN_STA_USES_ENCRYPTION);
339                         sta->ptk_idx = idx;
340                         ieee80211_check_fast_xmit(sta);
341                 } else {
342                         rcu_assign_pointer(sta->gtk[idx], new);
343                 }
344                 ieee80211_check_fast_rx(sta);
345         } else {
346                 defunikey = old &&
347                         old == key_mtx_dereference(sdata->local,
348                                                 sdata->default_unicast_key);
349                 defmultikey = old &&
350                         old == key_mtx_dereference(sdata->local,
351                                                 sdata->default_multicast_key);
352                 defmgmtkey = old &&
353                         old == key_mtx_dereference(sdata->local,
354                                                 sdata->default_mgmt_key);
355
356                 if (defunikey && !new)
357                         __ieee80211_set_default_key(sdata, -1, true, false);
358                 if (defmultikey && !new)
359                         __ieee80211_set_default_key(sdata, -1, false, true);
360                 if (defmgmtkey && !new)
361                         __ieee80211_set_default_mgmt_key(sdata, -1);
362
363                 rcu_assign_pointer(sdata->keys[idx], new);
364                 if (defunikey && new)
365                         __ieee80211_set_default_key(sdata, new->conf.keyidx,
366                                                     true, false);
367                 if (defmultikey && new)
368                         __ieee80211_set_default_key(sdata, new->conf.keyidx,
369                                                     false, true);
370                 if (defmgmtkey && new)
371                         __ieee80211_set_default_mgmt_key(sdata,
372                                                          new->conf.keyidx);
373         }
374
375         if (old)
376                 list_del_rcu(&old->list);
377 }
378
379 struct ieee80211_key *
380 ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
381                     const u8 *key_data,
382                     size_t seq_len, const u8 *seq,
383                     const struct ieee80211_cipher_scheme *cs)
384 {
385         struct ieee80211_key *key;
386         int i, j, err;
387
388         if (WARN_ON(idx < 0 || idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS))
389                 return ERR_PTR(-EINVAL);
390
391         key = kzalloc(sizeof(struct ieee80211_key) + key_len, GFP_KERNEL);
392         if (!key)
393                 return ERR_PTR(-ENOMEM);
394
395         /*
396          * Default to software encryption; we'll later upload the
397          * key to the hardware if possible.
398          */
399         key->conf.flags = 0;
400         key->flags = 0;
401
402         key->conf.cipher = cipher;
403         key->conf.keyidx = idx;
404         key->conf.keylen = key_len;
405         switch (cipher) {
406         case WLAN_CIPHER_SUITE_WEP40:
407         case WLAN_CIPHER_SUITE_WEP104:
408                 key->conf.iv_len = IEEE80211_WEP_IV_LEN;
409                 key->conf.icv_len = IEEE80211_WEP_ICV_LEN;
410                 break;
411         case WLAN_CIPHER_SUITE_TKIP:
412                 key->conf.iv_len = IEEE80211_TKIP_IV_LEN;
413                 key->conf.icv_len = IEEE80211_TKIP_ICV_LEN;
414                 if (seq) {
415                         for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
416                                 key->u.tkip.rx[i].iv32 =
417                                         get_unaligned_le32(&seq[2]);
418                                 key->u.tkip.rx[i].iv16 =
419                                         get_unaligned_le16(seq);
420                         }
421                 }
422                 spin_lock_init(&key->u.tkip.txlock);
423                 break;
424         case WLAN_CIPHER_SUITE_CCMP:
425                 key->conf.iv_len = IEEE80211_CCMP_HDR_LEN;
426                 key->conf.icv_len = IEEE80211_CCMP_MIC_LEN;
427                 if (seq) {
428                         for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
429                                 for (j = 0; j < IEEE80211_CCMP_PN_LEN; j++)
430                                         key->u.ccmp.rx_pn[i][j] =
431                                                 seq[IEEE80211_CCMP_PN_LEN - j - 1];
432                 }
433                 /*
434                  * Initialize AES key state here as an optimization so that
435                  * it does not need to be initialized for every packet.
436                  */
437                 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
438                         key_data, key_len, IEEE80211_CCMP_MIC_LEN);
439                 if (IS_ERR(key->u.ccmp.tfm)) {
440                         err = PTR_ERR(key->u.ccmp.tfm);
441                         kfree(key);
442                         return ERR_PTR(err);
443                 }
444                 break;
445         case WLAN_CIPHER_SUITE_CCMP_256:
446                 key->conf.iv_len = IEEE80211_CCMP_256_HDR_LEN;
447                 key->conf.icv_len = IEEE80211_CCMP_256_MIC_LEN;
448                 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
449                         for (j = 0; j < IEEE80211_CCMP_256_PN_LEN; j++)
450                                 key->u.ccmp.rx_pn[i][j] =
451                                         seq[IEEE80211_CCMP_256_PN_LEN - j - 1];
452                 /* Initialize AES key state here as an optimization so that
453                  * it does not need to be initialized for every packet.
454                  */
455                 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(
456                         key_data, key_len, IEEE80211_CCMP_256_MIC_LEN);
457                 if (IS_ERR(key->u.ccmp.tfm)) {
458                         err = PTR_ERR(key->u.ccmp.tfm);
459                         kfree(key);
460                         return ERR_PTR(err);
461                 }
462                 break;
463         case WLAN_CIPHER_SUITE_AES_CMAC:
464         case WLAN_CIPHER_SUITE_BIP_CMAC_256:
465                 key->conf.iv_len = 0;
466                 if (cipher == WLAN_CIPHER_SUITE_AES_CMAC)
467                         key->conf.icv_len = sizeof(struct ieee80211_mmie);
468                 else
469                         key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
470                 if (seq)
471                         for (j = 0; j < IEEE80211_CMAC_PN_LEN; j++)
472                                 key->u.aes_cmac.rx_pn[j] =
473                                         seq[IEEE80211_CMAC_PN_LEN - j - 1];
474                 /*
475                  * Initialize AES key state here as an optimization so that
476                  * it does not need to be initialized for every packet.
477                  */
478                 key->u.aes_cmac.tfm =
479                         ieee80211_aes_cmac_key_setup(key_data, key_len);
480                 if (IS_ERR(key->u.aes_cmac.tfm)) {
481                         err = PTR_ERR(key->u.aes_cmac.tfm);
482                         kfree(key);
483                         return ERR_PTR(err);
484                 }
485                 break;
486         case WLAN_CIPHER_SUITE_BIP_GMAC_128:
487         case WLAN_CIPHER_SUITE_BIP_GMAC_256:
488                 key->conf.iv_len = 0;
489                 key->conf.icv_len = sizeof(struct ieee80211_mmie_16);
490                 if (seq)
491                         for (j = 0; j < IEEE80211_GMAC_PN_LEN; j++)
492                                 key->u.aes_gmac.rx_pn[j] =
493                                         seq[IEEE80211_GMAC_PN_LEN - j - 1];
494                 /* Initialize AES key state here as an optimization so that
495                  * it does not need to be initialized for every packet.
496                  */
497                 key->u.aes_gmac.tfm =
498                         ieee80211_aes_gmac_key_setup(key_data, key_len);
499                 if (IS_ERR(key->u.aes_gmac.tfm)) {
500                         err = PTR_ERR(key->u.aes_gmac.tfm);
501                         kfree(key);
502                         return ERR_PTR(err);
503                 }
504                 break;
505         case WLAN_CIPHER_SUITE_GCMP:
506         case WLAN_CIPHER_SUITE_GCMP_256:
507                 key->conf.iv_len = IEEE80211_GCMP_HDR_LEN;
508                 key->conf.icv_len = IEEE80211_GCMP_MIC_LEN;
509                 for (i = 0; seq && i < IEEE80211_NUM_TIDS + 1; i++)
510                         for (j = 0; j < IEEE80211_GCMP_PN_LEN; j++)
511                                 key->u.gcmp.rx_pn[i][j] =
512                                         seq[IEEE80211_GCMP_PN_LEN - j - 1];
513                 /* Initialize AES key state here as an optimization so that
514                  * it does not need to be initialized for every packet.
515                  */
516                 key->u.gcmp.tfm = ieee80211_aes_gcm_key_setup_encrypt(key_data,
517                                                                       key_len);
518                 if (IS_ERR(key->u.gcmp.tfm)) {
519                         err = PTR_ERR(key->u.gcmp.tfm);
520                         kfree(key);
521                         return ERR_PTR(err);
522                 }
523                 break;
524         default:
525                 if (cs) {
526                         if (seq_len && seq_len != cs->pn_len) {
527                                 kfree(key);
528                                 return ERR_PTR(-EINVAL);
529                         }
530
531                         key->conf.iv_len = cs->hdr_len;
532                         key->conf.icv_len = cs->mic_len;
533                         for (i = 0; i < IEEE80211_NUM_TIDS + 1; i++)
534                                 for (j = 0; j < seq_len; j++)
535                                         key->u.gen.rx_pn[i][j] =
536                                                         seq[seq_len - j - 1];
537                         key->flags |= KEY_FLAG_CIPHER_SCHEME;
538                 }
539         }
540         memcpy(key->conf.key, key_data, key_len);
541         INIT_LIST_HEAD(&key->list);
542
543         return key;
544 }
545
546 static void ieee80211_key_free_common(struct ieee80211_key *key)
547 {
548         switch (key->conf.cipher) {
549         case WLAN_CIPHER_SUITE_CCMP:
550         case WLAN_CIPHER_SUITE_CCMP_256:
551                 ieee80211_aes_key_free(key->u.ccmp.tfm);
552                 break;
553         case WLAN_CIPHER_SUITE_AES_CMAC:
554         case WLAN_CIPHER_SUITE_BIP_CMAC_256:
555                 ieee80211_aes_cmac_key_free(key->u.aes_cmac.tfm);
556                 break;
557         case WLAN_CIPHER_SUITE_BIP_GMAC_128:
558         case WLAN_CIPHER_SUITE_BIP_GMAC_256:
559                 ieee80211_aes_gmac_key_free(key->u.aes_gmac.tfm);
560                 break;
561         case WLAN_CIPHER_SUITE_GCMP:
562         case WLAN_CIPHER_SUITE_GCMP_256:
563                 ieee80211_aes_gcm_key_free(key->u.gcmp.tfm);
564                 break;
565         }
566         kzfree(key);
567 }
568
569 static void __ieee80211_key_destroy(struct ieee80211_key *key,
570                                     bool delay_tailroom)
571 {
572         if (key->local)
573                 ieee80211_key_disable_hw_accel(key);
574
575         if (key->local) {
576                 struct ieee80211_sub_if_data *sdata = key->sdata;
577
578                 ieee80211_debugfs_key_remove(key);
579
580                 if (delay_tailroom) {
581                         /* see ieee80211_delayed_tailroom_dec */
582                         sdata->crypto_tx_tailroom_pending_dec++;
583                         schedule_delayed_work(&sdata->dec_tailroom_needed_wk,
584                                               HZ/2);
585                 } else {
586                         decrease_tailroom_need_count(sdata, 1);
587                 }
588         }
589
590         ieee80211_key_free_common(key);
591 }
592
593 static void ieee80211_key_destroy(struct ieee80211_key *key,
594                                   bool delay_tailroom)
595 {
596         if (!key)
597                 return;
598
599         /*
600          * Synchronize so the TX path and rcu key iterators
601          * can no longer be using this key before we free/remove it.
602          */
603         synchronize_net();
604
605         __ieee80211_key_destroy(key, delay_tailroom);
606 }
607
608 void ieee80211_key_free_unused(struct ieee80211_key *key)
609 {
610         WARN_ON(key->sdata || key->local);
611         ieee80211_key_free_common(key);
612 }
613
614 static bool ieee80211_key_identical(struct ieee80211_sub_if_data *sdata,
615                                     struct ieee80211_key *old,
616                                     struct ieee80211_key *new)
617 {
618         u8 tkip_old[WLAN_KEY_LEN_TKIP], tkip_new[WLAN_KEY_LEN_TKIP];
619         u8 *tk_old, *tk_new;
620
621         if (!old || new->conf.keylen != old->conf.keylen)
622                 return false;
623
624         tk_old = old->conf.key;
625         tk_new = new->conf.key;
626
627         /*
628          * In station mode, don't compare the TX MIC key, as it's never used
629          * and offloaded rekeying may not care to send it to the host. This
630          * is the case in iwlwifi, for example.
631          */
632         if (sdata->vif.type == NL80211_IFTYPE_STATION &&
633             new->conf.cipher == WLAN_CIPHER_SUITE_TKIP &&
634             new->conf.keylen == WLAN_KEY_LEN_TKIP &&
635             !(new->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE)) {
636                 memcpy(tkip_old, tk_old, WLAN_KEY_LEN_TKIP);
637                 memcpy(tkip_new, tk_new, WLAN_KEY_LEN_TKIP);
638                 memset(tkip_old + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
639                 memset(tkip_new + NL80211_TKIP_DATA_OFFSET_TX_MIC_KEY, 0, 8);
640                 tk_old = tkip_old;
641                 tk_new = tkip_new;
642         }
643
644         return !crypto_memneq(tk_old, tk_new, new->conf.keylen);
645 }
646
647 int ieee80211_key_link(struct ieee80211_key *key,
648                        struct ieee80211_sub_if_data *sdata,
649                        struct sta_info *sta)
650 {
651         struct ieee80211_local *local = sdata->local;
652         static atomic_t key_color = ATOMIC_INIT(0);
653         struct ieee80211_key *old_key;
654         int idx = key->conf.keyidx;
655         bool pairwise = key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE;
656         /*
657          * We want to delay tailroom updates only for station - in that
658          * case it helps roaming speed, but in other cases it hurts and
659          * can cause warnings to appear.
660          */
661         bool delay_tailroom = sdata->vif.type == NL80211_IFTYPE_STATION;
662         int ret;
663
664         /*
665          * Assign a unique ID to every key so we can easily prevent mixed
666          * key and fragment cache attacks.
667          */
668         key->color = atomic_inc_return(&key_color);
669
670         mutex_lock(&sdata->local->key_mtx);
671
672         if (sta && pairwise)
673                 old_key = key_mtx_dereference(sdata->local, sta->ptk[idx]);
674         else if (sta)
675                 old_key = key_mtx_dereference(sdata->local, sta->gtk[idx]);
676         else
677                 old_key = key_mtx_dereference(sdata->local, sdata->keys[idx]);
678
679         /*
680          * Silently accept key re-installation without really installing the
681          * new version of the key to avoid nonce reuse or replay issues.
682          */
683         if (ieee80211_key_identical(sdata, old_key, key)) {
684                 ieee80211_key_free_unused(key);
685                 ret = 0;
686                 goto out;
687         }
688
689         key->local = sdata->local;
690         key->sdata = sdata;
691         key->sta = sta;
692
693         increment_tailroom_need_count(sdata);
694
695         ieee80211_key_replace(sdata, sta, pairwise, old_key, key);
696         ieee80211_key_destroy(old_key, delay_tailroom);
697
698         ieee80211_debugfs_key_add(key);
699
700         if (!local->wowlan) {
701                 ret = ieee80211_key_enable_hw_accel(key);
702                 if (ret)
703                         ieee80211_key_free(key, delay_tailroom);
704         } else {
705                 ret = 0;
706         }
707
708  out:
709         mutex_unlock(&sdata->local->key_mtx);
710
711         return ret;
712 }
713
714 void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom)
715 {
716         if (!key)
717                 return;
718
719         /*
720          * Replace key with nothingness if it was ever used.
721          */
722         if (key->sdata)
723                 ieee80211_key_replace(key->sdata, key->sta,
724                                 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
725                                 key, NULL);
726         ieee80211_key_destroy(key, delay_tailroom);
727 }
728
729 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata)
730 {
731         struct ieee80211_key *key;
732         struct ieee80211_sub_if_data *vlan;
733
734         ASSERT_RTNL();
735
736         if (WARN_ON(!ieee80211_sdata_running(sdata)))
737                 return;
738
739         mutex_lock(&sdata->local->key_mtx);
740
741         WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
742                      sdata->crypto_tx_tailroom_pending_dec);
743
744         if (sdata->vif.type == NL80211_IFTYPE_AP) {
745                 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
746                         WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
747                                      vlan->crypto_tx_tailroom_pending_dec);
748         }
749
750         list_for_each_entry(key, &sdata->key_list, list) {
751                 increment_tailroom_need_count(sdata);
752                 ieee80211_key_enable_hw_accel(key);
753         }
754
755         mutex_unlock(&sdata->local->key_mtx);
756 }
757
758 void ieee80211_reset_crypto_tx_tailroom(struct ieee80211_sub_if_data *sdata)
759 {
760         struct ieee80211_sub_if_data *vlan;
761
762         mutex_lock(&sdata->local->key_mtx);
763
764         sdata->crypto_tx_tailroom_needed_cnt = 0;
765
766         if (sdata->vif.type == NL80211_IFTYPE_AP) {
767                 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
768                         vlan->crypto_tx_tailroom_needed_cnt = 0;
769         }
770
771         mutex_unlock(&sdata->local->key_mtx);
772 }
773
774 void ieee80211_iter_keys(struct ieee80211_hw *hw,
775                          struct ieee80211_vif *vif,
776                          void (*iter)(struct ieee80211_hw *hw,
777                                       struct ieee80211_vif *vif,
778                                       struct ieee80211_sta *sta,
779                                       struct ieee80211_key_conf *key,
780                                       void *data),
781                          void *iter_data)
782 {
783         struct ieee80211_local *local = hw_to_local(hw);
784         struct ieee80211_key *key, *tmp;
785         struct ieee80211_sub_if_data *sdata;
786
787         ASSERT_RTNL();
788
789         mutex_lock(&local->key_mtx);
790         if (vif) {
791                 sdata = vif_to_sdata(vif);
792                 list_for_each_entry_safe(key, tmp, &sdata->key_list, list)
793                         iter(hw, &sdata->vif,
794                              key->sta ? &key->sta->sta : NULL,
795                              &key->conf, iter_data);
796         } else {
797                 list_for_each_entry(sdata, &local->interfaces, list)
798                         list_for_each_entry_safe(key, tmp,
799                                                  &sdata->key_list, list)
800                                 iter(hw, &sdata->vif,
801                                      key->sta ? &key->sta->sta : NULL,
802                                      &key->conf, iter_data);
803         }
804         mutex_unlock(&local->key_mtx);
805 }
806 EXPORT_SYMBOL(ieee80211_iter_keys);
807
808 static void
809 _ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
810                          struct ieee80211_sub_if_data *sdata,
811                          void (*iter)(struct ieee80211_hw *hw,
812                                       struct ieee80211_vif *vif,
813                                       struct ieee80211_sta *sta,
814                                       struct ieee80211_key_conf *key,
815                                       void *data),
816                          void *iter_data)
817 {
818         struct ieee80211_key *key;
819
820         list_for_each_entry_rcu(key, &sdata->key_list, list) {
821                 /* skip keys of station in removal process */
822                 if (key->sta && key->sta->removed)
823                         continue;
824                 if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE))
825                         continue;
826
827                 iter(hw, &sdata->vif,
828                      key->sta ? &key->sta->sta : NULL,
829                      &key->conf, iter_data);
830         }
831 }
832
833 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
834                              struct ieee80211_vif *vif,
835                              void (*iter)(struct ieee80211_hw *hw,
836                                           struct ieee80211_vif *vif,
837                                           struct ieee80211_sta *sta,
838                                           struct ieee80211_key_conf *key,
839                                           void *data),
840                              void *iter_data)
841 {
842         struct ieee80211_local *local = hw_to_local(hw);
843         struct ieee80211_sub_if_data *sdata;
844
845         if (vif) {
846                 sdata = vif_to_sdata(vif);
847                 _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
848         } else {
849                 list_for_each_entry_rcu(sdata, &local->interfaces, list)
850                         _ieee80211_iter_keys_rcu(hw, sdata, iter, iter_data);
851         }
852 }
853 EXPORT_SYMBOL(ieee80211_iter_keys_rcu);
854
855 static void ieee80211_free_keys_iface(struct ieee80211_sub_if_data *sdata,
856                                       struct list_head *keys)
857 {
858         struct ieee80211_key *key, *tmp;
859
860         decrease_tailroom_need_count(sdata,
861                                      sdata->crypto_tx_tailroom_pending_dec);
862         sdata->crypto_tx_tailroom_pending_dec = 0;
863
864         ieee80211_debugfs_key_remove_mgmt_default(sdata);
865
866         list_for_each_entry_safe(key, tmp, &sdata->key_list, list) {
867                 ieee80211_key_replace(key->sdata, key->sta,
868                                 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
869                                 key, NULL);
870                 list_add_tail(&key->list, keys);
871         }
872
873         ieee80211_debugfs_key_update_default(sdata);
874 }
875
876 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
877                          bool force_synchronize)
878 {
879         struct ieee80211_local *local = sdata->local;
880         struct ieee80211_sub_if_data *vlan;
881         struct ieee80211_sub_if_data *master;
882         struct ieee80211_key *key, *tmp;
883         LIST_HEAD(keys);
884
885         cancel_delayed_work_sync(&sdata->dec_tailroom_needed_wk);
886
887         mutex_lock(&local->key_mtx);
888
889         ieee80211_free_keys_iface(sdata, &keys);
890
891         if (sdata->vif.type == NL80211_IFTYPE_AP) {
892                 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
893                         ieee80211_free_keys_iface(vlan, &keys);
894         }
895
896         if (!list_empty(&keys) || force_synchronize)
897                 synchronize_net();
898         list_for_each_entry_safe(key, tmp, &keys, list)
899                 __ieee80211_key_destroy(key, false);
900
901         if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
902                 if (sdata->bss) {
903                         master = container_of(sdata->bss,
904                                               struct ieee80211_sub_if_data,
905                                               u.ap);
906
907                         WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt !=
908                                      master->crypto_tx_tailroom_needed_cnt);
909                 }
910         } else {
911                 WARN_ON_ONCE(sdata->crypto_tx_tailroom_needed_cnt ||
912                              sdata->crypto_tx_tailroom_pending_dec);
913         }
914
915         if (sdata->vif.type == NL80211_IFTYPE_AP) {
916                 list_for_each_entry(vlan, &sdata->u.ap.vlans, u.vlan.list)
917                         WARN_ON_ONCE(vlan->crypto_tx_tailroom_needed_cnt ||
918                                      vlan->crypto_tx_tailroom_pending_dec);
919         }
920
921         mutex_unlock(&local->key_mtx);
922 }
923
924 void ieee80211_free_sta_keys(struct ieee80211_local *local,
925                              struct sta_info *sta)
926 {
927         struct ieee80211_key *key;
928         int i;
929
930         mutex_lock(&local->key_mtx);
931         for (i = 0; i < ARRAY_SIZE(sta->gtk); i++) {
932                 key = key_mtx_dereference(local, sta->gtk[i]);
933                 if (!key)
934                         continue;
935                 ieee80211_key_replace(key->sdata, key->sta,
936                                 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
937                                 key, NULL);
938                 __ieee80211_key_destroy(key, key->sdata->vif.type ==
939                                         NL80211_IFTYPE_STATION);
940         }
941
942         for (i = 0; i < NUM_DEFAULT_KEYS; i++) {
943                 key = key_mtx_dereference(local, sta->ptk[i]);
944                 if (!key)
945                         continue;
946                 ieee80211_key_replace(key->sdata, key->sta,
947                                 key->conf.flags & IEEE80211_KEY_FLAG_PAIRWISE,
948                                 key, NULL);
949                 __ieee80211_key_destroy(key, key->sdata->vif.type ==
950                                         NL80211_IFTYPE_STATION);
951         }
952
953         mutex_unlock(&local->key_mtx);
954 }
955
956 void ieee80211_delayed_tailroom_dec(struct work_struct *wk)
957 {
958         struct ieee80211_sub_if_data *sdata;
959
960         sdata = container_of(wk, struct ieee80211_sub_if_data,
961                              dec_tailroom_needed_wk.work);
962
963         /*
964          * The reason for the delayed tailroom needed decrementing is to
965          * make roaming faster: during roaming, all keys are first deleted
966          * and then new keys are installed. The first new key causes the
967          * crypto_tx_tailroom_needed_cnt to go from 0 to 1, which invokes
968          * the cost of synchronize_net() (which can be slow). Avoid this
969          * by deferring the crypto_tx_tailroom_needed_cnt decrementing on
970          * key removal for a while, so if we roam the value is larger than
971          * zero and no 0->1 transition happens.
972          *
973          * The cost is that if the AP switching was from an AP with keys
974          * to one without, we still allocate tailroom while it would no
975          * longer be needed. However, in the typical (fast) roaming case
976          * within an ESS this usually won't happen.
977          */
978
979         mutex_lock(&sdata->local->key_mtx);
980         decrease_tailroom_need_count(sdata,
981                                      sdata->crypto_tx_tailroom_pending_dec);
982         sdata->crypto_tx_tailroom_pending_dec = 0;
983         mutex_unlock(&sdata->local->key_mtx);
984 }
985
986 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
987                                 const u8 *replay_ctr, gfp_t gfp)
988 {
989         struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
990
991         trace_api_gtk_rekey_notify(sdata, bssid, replay_ctr);
992
993         cfg80211_gtk_rekey_notify(sdata->dev, bssid, replay_ctr, gfp);
994 }
995 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_notify);
996
997 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
998                               int tid, struct ieee80211_key_seq *seq)
999 {
1000         struct ieee80211_key *key;
1001         const u8 *pn;
1002
1003         key = container_of(keyconf, struct ieee80211_key, conf);
1004
1005         switch (key->conf.cipher) {
1006         case WLAN_CIPHER_SUITE_TKIP:
1007                 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1008                         return;
1009                 seq->tkip.iv32 = key->u.tkip.rx[tid].iv32;
1010                 seq->tkip.iv16 = key->u.tkip.rx[tid].iv16;
1011                 break;
1012         case WLAN_CIPHER_SUITE_CCMP:
1013         case WLAN_CIPHER_SUITE_CCMP_256:
1014                 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1015                         return;
1016                 if (tid < 0)
1017                         pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1018                 else
1019                         pn = key->u.ccmp.rx_pn[tid];
1020                 memcpy(seq->ccmp.pn, pn, IEEE80211_CCMP_PN_LEN);
1021                 break;
1022         case WLAN_CIPHER_SUITE_AES_CMAC:
1023         case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1024                 if (WARN_ON(tid != 0))
1025                         return;
1026                 pn = key->u.aes_cmac.rx_pn;
1027                 memcpy(seq->aes_cmac.pn, pn, IEEE80211_CMAC_PN_LEN);
1028                 break;
1029         case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1030         case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1031                 if (WARN_ON(tid != 0))
1032                         return;
1033                 pn = key->u.aes_gmac.rx_pn;
1034                 memcpy(seq->aes_gmac.pn, pn, IEEE80211_GMAC_PN_LEN);
1035                 break;
1036         case WLAN_CIPHER_SUITE_GCMP:
1037         case WLAN_CIPHER_SUITE_GCMP_256:
1038                 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1039                         return;
1040                 if (tid < 0)
1041                         pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1042                 else
1043                         pn = key->u.gcmp.rx_pn[tid];
1044                 memcpy(seq->gcmp.pn, pn, IEEE80211_GCMP_PN_LEN);
1045                 break;
1046         }
1047 }
1048 EXPORT_SYMBOL(ieee80211_get_key_rx_seq);
1049
1050 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
1051                               int tid, struct ieee80211_key_seq *seq)
1052 {
1053         struct ieee80211_key *key;
1054         u8 *pn;
1055
1056         key = container_of(keyconf, struct ieee80211_key, conf);
1057
1058         switch (key->conf.cipher) {
1059         case WLAN_CIPHER_SUITE_TKIP:
1060                 if (WARN_ON(tid < 0 || tid >= IEEE80211_NUM_TIDS))
1061                         return;
1062                 key->u.tkip.rx[tid].iv32 = seq->tkip.iv32;
1063                 key->u.tkip.rx[tid].iv16 = seq->tkip.iv16;
1064                 break;
1065         case WLAN_CIPHER_SUITE_CCMP:
1066         case WLAN_CIPHER_SUITE_CCMP_256:
1067                 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1068                         return;
1069                 if (tid < 0)
1070                         pn = key->u.ccmp.rx_pn[IEEE80211_NUM_TIDS];
1071                 else
1072                         pn = key->u.ccmp.rx_pn[tid];
1073                 memcpy(pn, seq->ccmp.pn, IEEE80211_CCMP_PN_LEN);
1074                 break;
1075         case WLAN_CIPHER_SUITE_AES_CMAC:
1076         case WLAN_CIPHER_SUITE_BIP_CMAC_256:
1077                 if (WARN_ON(tid != 0))
1078                         return;
1079                 pn = key->u.aes_cmac.rx_pn;
1080                 memcpy(pn, seq->aes_cmac.pn, IEEE80211_CMAC_PN_LEN);
1081                 break;
1082         case WLAN_CIPHER_SUITE_BIP_GMAC_128:
1083         case WLAN_CIPHER_SUITE_BIP_GMAC_256:
1084                 if (WARN_ON(tid != 0))
1085                         return;
1086                 pn = key->u.aes_gmac.rx_pn;
1087                 memcpy(pn, seq->aes_gmac.pn, IEEE80211_GMAC_PN_LEN);
1088                 break;
1089         case WLAN_CIPHER_SUITE_GCMP:
1090         case WLAN_CIPHER_SUITE_GCMP_256:
1091                 if (WARN_ON(tid < -1 || tid >= IEEE80211_NUM_TIDS))
1092                         return;
1093                 if (tid < 0)
1094                         pn = key->u.gcmp.rx_pn[IEEE80211_NUM_TIDS];
1095                 else
1096                         pn = key->u.gcmp.rx_pn[tid];
1097                 memcpy(pn, seq->gcmp.pn, IEEE80211_GCMP_PN_LEN);
1098                 break;
1099         default:
1100                 WARN_ON(1);
1101                 break;
1102         }
1103 }
1104 EXPORT_SYMBOL_GPL(ieee80211_set_key_rx_seq);
1105
1106 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf)
1107 {
1108         struct ieee80211_key *key;
1109
1110         key = container_of(keyconf, struct ieee80211_key, conf);
1111
1112         assert_key_lock(key->local);
1113
1114         /*
1115          * if key was uploaded, we assume the driver will/has remove(d)
1116          * it, so adjust bookkeeping accordingly
1117          */
1118         if (key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE) {
1119                 key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
1120
1121                 if (!((key->conf.flags & IEEE80211_KEY_FLAG_GENERATE_MMIC) ||
1122                       (key->conf.flags & IEEE80211_KEY_FLAG_RESERVE_TAILROOM)))
1123                         increment_tailroom_need_count(key->sdata);
1124         }
1125
1126         ieee80211_key_free(key, false);
1127 }
1128 EXPORT_SYMBOL_GPL(ieee80211_remove_key);
1129
1130 struct ieee80211_key_conf *
1131 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
1132                         struct ieee80211_key_conf *keyconf)
1133 {
1134         struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
1135         struct ieee80211_local *local = sdata->local;
1136         struct ieee80211_key *key;
1137         int err;
1138
1139         if (WARN_ON(!local->wowlan))
1140                 return ERR_PTR(-EINVAL);
1141
1142         if (WARN_ON(vif->type != NL80211_IFTYPE_STATION))
1143                 return ERR_PTR(-EINVAL);
1144
1145         key = ieee80211_key_alloc(keyconf->cipher, keyconf->keyidx,
1146                                   keyconf->keylen, keyconf->key,
1147                                   0, NULL, NULL);
1148         if (IS_ERR(key))
1149                 return ERR_CAST(key);
1150
1151         if (sdata->u.mgd.mfp != IEEE80211_MFP_DISABLED)
1152                 key->conf.flags |= IEEE80211_KEY_FLAG_RX_MGMT;
1153
1154         err = ieee80211_key_link(key, sdata, NULL);
1155         if (err)
1156                 return ERR_PTR(err);
1157
1158         return &key->conf;
1159 }
1160 EXPORT_SYMBOL_GPL(ieee80211_gtk_rekey_add);