nl80211: Add RSC configuration for new keys
[linux-2.6] / 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  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11
12 #include <linux/if_ether.h>
13 #include <linux/etherdevice.h>
14 #include <linux/list.h>
15 #include <linux/rcupdate.h>
16 #include <linux/rtnetlink.h>
17 #include <net/mac80211.h>
18 #include "ieee80211_i.h"
19 #include "driver-ops.h"
20 #include "debugfs_key.h"
21 #include "aes_ccm.h"
22 #include "aes_cmac.h"
23
24
25 /**
26  * DOC: Key handling basics
27  *
28  * Key handling in mac80211 is done based on per-interface (sub_if_data)
29  * keys and per-station keys. Since each station belongs to an interface,
30  * each station key also belongs to that interface.
31  *
32  * Hardware acceleration is done on a best-effort basis, for each key
33  * that is eligible the hardware is asked to enable that key but if
34  * it cannot do that they key is simply kept for software encryption.
35  * There is currently no way of knowing this except by looking into
36  * debugfs.
37  *
38  * All key operations are protected internally so you can call them at
39  * any time.
40  *
41  * Within mac80211, key references are, just as STA structure references,
42  * protected by RCU. Note, however, that some things are unprotected,
43  * namely the key->sta dereferences within the hardware acceleration
44  * functions. This means that sta_info_destroy() must flush the key todo
45  * list.
46  *
47  * All the direct key list manipulation functions must not sleep because
48  * they can operate on STA info structs that are protected by RCU.
49  */
50
51 static const u8 bcast_addr[ETH_ALEN] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
52
53 /* key mutex: used to synchronise todo runners */
54 static DEFINE_MUTEX(key_mutex);
55 static DEFINE_SPINLOCK(todo_lock);
56 static LIST_HEAD(todo_list);
57
58 static void key_todo(struct work_struct *work)
59 {
60         ieee80211_key_todo();
61 }
62
63 static DECLARE_WORK(todo_work, key_todo);
64
65 /**
66  * add_todo - add todo item for a key
67  *
68  * @key: key to add to do item for
69  * @flag: todo flag(s)
70  */
71 static void add_todo(struct ieee80211_key *key, u32 flag)
72 {
73         if (!key)
74                 return;
75
76         spin_lock(&todo_lock);
77         key->flags |= flag;
78         /*
79          * Remove again if already on the list so that we move it to the end.
80          */
81         if (!list_empty(&key->todo))
82                 list_del(&key->todo);
83         list_add_tail(&key->todo, &todo_list);
84         schedule_work(&todo_work);
85         spin_unlock(&todo_lock);
86 }
87
88 /**
89  * ieee80211_key_lock - lock the mac80211 key operation lock
90  *
91  * This locks the (global) mac80211 key operation lock, all
92  * key operations must be done under this lock.
93  */
94 static void ieee80211_key_lock(void)
95 {
96         mutex_lock(&key_mutex);
97 }
98
99 /**
100  * ieee80211_key_unlock - unlock the mac80211 key operation lock
101  */
102 static void ieee80211_key_unlock(void)
103 {
104         mutex_unlock(&key_mutex);
105 }
106
107 static void assert_key_lock(void)
108 {
109         WARN_ON(!mutex_is_locked(&key_mutex));
110 }
111
112 static struct ieee80211_sta *get_sta_for_key(struct ieee80211_key *key)
113 {
114         if (key->sta)
115                 return &key->sta->sta;
116
117         return NULL;
118 }
119
120 static void ieee80211_key_enable_hw_accel(struct ieee80211_key *key)
121 {
122         struct ieee80211_sub_if_data *sdata;
123         struct ieee80211_sta *sta;
124         int ret;
125
126         assert_key_lock();
127         might_sleep();
128
129         if (!key->local->ops->set_key)
130                 return;
131
132         sta = get_sta_for_key(key);
133
134         sdata = key->sdata;
135         if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
136                 sdata = container_of(sdata->bss,
137                                      struct ieee80211_sub_if_data,
138                                      u.ap);
139
140         ret = drv_set_key(key->local, SET_KEY, &sdata->vif, sta, &key->conf);
141
142         if (!ret) {
143                 spin_lock(&todo_lock);
144                 key->flags |= KEY_FLAG_UPLOADED_TO_HARDWARE;
145                 spin_unlock(&todo_lock);
146         }
147
148         if (ret && ret != -ENOSPC && ret != -EOPNOTSUPP)
149                 printk(KERN_ERR "mac80211-%s: failed to set key "
150                        "(%d, %pM) to hardware (%d)\n",
151                        wiphy_name(key->local->hw.wiphy),
152                        key->conf.keyidx, sta ? sta->addr : bcast_addr, ret);
153 }
154
155 static void ieee80211_key_disable_hw_accel(struct ieee80211_key *key)
156 {
157         struct ieee80211_sub_if_data *sdata;
158         struct ieee80211_sta *sta;
159         int ret;
160
161         assert_key_lock();
162         might_sleep();
163
164         if (!key || !key->local->ops->set_key)
165                 return;
166
167         spin_lock(&todo_lock);
168         if (!(key->flags & KEY_FLAG_UPLOADED_TO_HARDWARE)) {
169                 spin_unlock(&todo_lock);
170                 return;
171         }
172         spin_unlock(&todo_lock);
173
174         sta = get_sta_for_key(key);
175         sdata = key->sdata;
176
177         if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
178                 sdata = container_of(sdata->bss,
179                                      struct ieee80211_sub_if_data,
180                                      u.ap);
181
182         ret = drv_set_key(key->local, DISABLE_KEY, &sdata->vif,
183                           sta, &key->conf);
184
185         if (ret)
186                 printk(KERN_ERR "mac80211-%s: failed to remove key "
187                        "(%d, %pM) from hardware (%d)\n",
188                        wiphy_name(key->local->hw.wiphy),
189                        key->conf.keyidx, sta ? sta->addr : bcast_addr, ret);
190
191         spin_lock(&todo_lock);
192         key->flags &= ~KEY_FLAG_UPLOADED_TO_HARDWARE;
193         spin_unlock(&todo_lock);
194 }
195
196 static void __ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata,
197                                         int idx)
198 {
199         struct ieee80211_key *key = NULL;
200
201         if (idx >= 0 && idx < NUM_DEFAULT_KEYS)
202                 key = sdata->keys[idx];
203
204         rcu_assign_pointer(sdata->default_key, key);
205
206         if (key)
207                 add_todo(key, KEY_FLAG_TODO_DEFKEY);
208 }
209
210 void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx)
211 {
212         unsigned long flags;
213
214         spin_lock_irqsave(&sdata->local->key_lock, flags);
215         __ieee80211_set_default_key(sdata, idx);
216         spin_unlock_irqrestore(&sdata->local->key_lock, flags);
217 }
218
219 static void
220 __ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata, int idx)
221 {
222         struct ieee80211_key *key = NULL;
223
224         if (idx >= NUM_DEFAULT_KEYS &&
225             idx < NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS)
226                 key = sdata->keys[idx];
227
228         rcu_assign_pointer(sdata->default_mgmt_key, key);
229
230         if (key)
231                 add_todo(key, KEY_FLAG_TODO_DEFMGMTKEY);
232 }
233
234 void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
235                                     int idx)
236 {
237         unsigned long flags;
238
239         spin_lock_irqsave(&sdata->local->key_lock, flags);
240         __ieee80211_set_default_mgmt_key(sdata, idx);
241         spin_unlock_irqrestore(&sdata->local->key_lock, flags);
242 }
243
244
245 static void __ieee80211_key_replace(struct ieee80211_sub_if_data *sdata,
246                                     struct sta_info *sta,
247                                     struct ieee80211_key *old,
248                                     struct ieee80211_key *new)
249 {
250         int idx, defkey, defmgmtkey;
251
252         if (new)
253                 list_add(&new->list, &sdata->key_list);
254
255         if (sta) {
256                 rcu_assign_pointer(sta->key, new);
257         } else {
258                 WARN_ON(new && old && new->conf.keyidx != old->conf.keyidx);
259
260                 if (old)
261                         idx = old->conf.keyidx;
262                 else
263                         idx = new->conf.keyidx;
264
265                 defkey = old && sdata->default_key == old;
266                 defmgmtkey = old && sdata->default_mgmt_key == old;
267
268                 if (defkey && !new)
269                         __ieee80211_set_default_key(sdata, -1);
270                 if (defmgmtkey && !new)
271                         __ieee80211_set_default_mgmt_key(sdata, -1);
272
273                 rcu_assign_pointer(sdata->keys[idx], new);
274                 if (defkey && new)
275                         __ieee80211_set_default_key(sdata, new->conf.keyidx);
276                 if (defmgmtkey && new)
277                         __ieee80211_set_default_mgmt_key(sdata,
278                                                          new->conf.keyidx);
279         }
280
281         if (old) {
282                 /*
283                  * We'll use an empty list to indicate that the key
284                  * has already been removed.
285                  */
286                 list_del_init(&old->list);
287         }
288 }
289
290 struct ieee80211_key *ieee80211_key_alloc(enum ieee80211_key_alg alg,
291                                           int idx,
292                                           size_t key_len,
293                                           const u8 *key_data,
294                                           size_t seq_len, const u8 *seq)
295 {
296         struct ieee80211_key *key;
297         int i, j;
298
299         BUG_ON(idx < 0 || idx >= NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS);
300
301         key = kzalloc(sizeof(struct ieee80211_key) + key_len, GFP_KERNEL);
302         if (!key)
303                 return NULL;
304
305         /*
306          * Default to software encryption; we'll later upload the
307          * key to the hardware if possible.
308          */
309         key->conf.flags = 0;
310         key->flags = 0;
311
312         key->conf.alg = alg;
313         key->conf.keyidx = idx;
314         key->conf.keylen = key_len;
315         switch (alg) {
316         case ALG_WEP:
317                 key->conf.iv_len = WEP_IV_LEN;
318                 key->conf.icv_len = WEP_ICV_LEN;
319                 break;
320         case ALG_TKIP:
321                 key->conf.iv_len = TKIP_IV_LEN;
322                 key->conf.icv_len = TKIP_ICV_LEN;
323                 if (seq && seq_len == 6) {
324                         for (i = 0; i < NUM_RX_DATA_QUEUES; i++) {
325                                 key->u.tkip.rx[i].iv32 =
326                                         get_unaligned_le32(&seq[2]);
327                                 key->u.tkip.rx[i].iv16 =
328                                         get_unaligned_le16(seq);
329                         }
330                 }
331                 break;
332         case ALG_CCMP:
333                 key->conf.iv_len = CCMP_HDR_LEN;
334                 key->conf.icv_len = CCMP_MIC_LEN;
335                 if (seq && seq_len == CCMP_PN_LEN) {
336                         for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
337                                 for (j = 0; j < CCMP_PN_LEN; j++)
338                                         key->u.ccmp.rx_pn[i][j] =
339                                                 seq[CCMP_PN_LEN - j - 1];
340                 }
341                 break;
342         case ALG_AES_CMAC:
343                 key->conf.iv_len = 0;
344                 key->conf.icv_len = sizeof(struct ieee80211_mmie);
345                 if (seq && seq_len == 6)
346                         for (j = 0; j < 6; j++)
347                                 key->u.aes_cmac.rx_pn[j] = seq[6 - j - 1];
348                 break;
349         }
350         memcpy(key->conf.key, key_data, key_len);
351         INIT_LIST_HEAD(&key->list);
352         INIT_LIST_HEAD(&key->todo);
353
354         if (alg == ALG_CCMP) {
355                 /*
356                  * Initialize AES key state here as an optimization so that
357                  * it does not need to be initialized for every packet.
358                  */
359                 key->u.ccmp.tfm = ieee80211_aes_key_setup_encrypt(key_data);
360                 if (!key->u.ccmp.tfm) {
361                         kfree(key);
362                         return NULL;
363                 }
364         }
365
366         if (alg == ALG_AES_CMAC) {
367                 /*
368                  * Initialize AES key state here as an optimization so that
369                  * it does not need to be initialized for every packet.
370                  */
371                 key->u.aes_cmac.tfm =
372                         ieee80211_aes_cmac_key_setup(key_data);
373                 if (!key->u.aes_cmac.tfm) {
374                         kfree(key);
375                         return NULL;
376                 }
377         }
378
379         return key;
380 }
381
382 void ieee80211_key_link(struct ieee80211_key *key,
383                         struct ieee80211_sub_if_data *sdata,
384                         struct sta_info *sta)
385 {
386         struct ieee80211_key *old_key;
387         unsigned long flags;
388         int idx;
389
390         BUG_ON(!sdata);
391         BUG_ON(!key);
392
393         idx = key->conf.keyidx;
394         key->local = sdata->local;
395         key->sdata = sdata;
396         key->sta = sta;
397
398         if (sta) {
399                 /*
400                  * some hardware cannot handle TKIP with QoS, so
401                  * we indicate whether QoS could be in use.
402                  */
403                 if (test_sta_flags(sta, WLAN_STA_WME))
404                         key->conf.flags |= IEEE80211_KEY_FLAG_WMM_STA;
405
406                 /*
407                  * This key is for a specific sta interface,
408                  * inform the driver that it should try to store
409                  * this key as pairwise key.
410                  */
411                 key->conf.flags |= IEEE80211_KEY_FLAG_PAIRWISE;
412         } else {
413                 if (sdata->vif.type == NL80211_IFTYPE_STATION) {
414                         struct sta_info *ap;
415
416                         /*
417                          * We're getting a sta pointer in,
418                          * so must be under RCU read lock.
419                          */
420
421                         /* same here, the AP could be using QoS */
422                         ap = sta_info_get(key->local, key->sdata->u.mgd.bssid);
423                         if (ap) {
424                                 if (test_sta_flags(ap, WLAN_STA_WME))
425                                         key->conf.flags |=
426                                                 IEEE80211_KEY_FLAG_WMM_STA;
427                         }
428                 }
429         }
430
431         spin_lock_irqsave(&sdata->local->key_lock, flags);
432
433         if (sta)
434                 old_key = sta->key;
435         else
436                 old_key = sdata->keys[idx];
437
438         __ieee80211_key_replace(sdata, sta, old_key, key);
439
440         spin_unlock_irqrestore(&sdata->local->key_lock, flags);
441
442         /* free old key later */
443         add_todo(old_key, KEY_FLAG_TODO_DELETE);
444
445         add_todo(key, KEY_FLAG_TODO_ADD_DEBUGFS);
446         if (netif_running(sdata->dev))
447                 add_todo(key, KEY_FLAG_TODO_HWACCEL_ADD);
448 }
449
450 static void __ieee80211_key_free(struct ieee80211_key *key)
451 {
452         /*
453          * Replace key with nothingness if it was ever used.
454          */
455         if (key->sdata)
456                 __ieee80211_key_replace(key->sdata, key->sta,
457                                         key, NULL);
458
459         add_todo(key, KEY_FLAG_TODO_DELETE);
460 }
461
462 void ieee80211_key_free(struct ieee80211_key *key)
463 {
464         unsigned long flags;
465
466         if (!key)
467                 return;
468
469         if (!key->sdata) {
470                 /* The key has not been linked yet, simply free it
471                  * and don't Oops */
472                 if (key->conf.alg == ALG_CCMP)
473                         ieee80211_aes_key_free(key->u.ccmp.tfm);
474                 kfree(key);
475                 return;
476         }
477
478         spin_lock_irqsave(&key->sdata->local->key_lock, flags);
479         __ieee80211_key_free(key);
480         spin_unlock_irqrestore(&key->sdata->local->key_lock, flags);
481 }
482
483 /*
484  * To be safe against concurrent manipulations of the list (which shouldn't
485  * actually happen) we need to hold the spinlock. But under the spinlock we
486  * can't actually do much, so we defer processing to the todo list. Then run
487  * the todo list to be sure the operation and possibly previously pending
488  * operations are completed.
489  */
490 static void ieee80211_todo_for_each_key(struct ieee80211_sub_if_data *sdata,
491                                         u32 todo_flags)
492 {
493         struct ieee80211_key *key;
494         unsigned long flags;
495
496         might_sleep();
497
498         spin_lock_irqsave(&sdata->local->key_lock, flags);
499         list_for_each_entry(key, &sdata->key_list, list)
500                 add_todo(key, todo_flags);
501         spin_unlock_irqrestore(&sdata->local->key_lock, flags);
502
503         ieee80211_key_todo();
504 }
505
506 void ieee80211_enable_keys(struct ieee80211_sub_if_data *sdata)
507 {
508         ASSERT_RTNL();
509
510         if (WARN_ON(!netif_running(sdata->dev)))
511                 return;
512
513         ieee80211_todo_for_each_key(sdata, KEY_FLAG_TODO_HWACCEL_ADD);
514 }
515
516 void ieee80211_disable_keys(struct ieee80211_sub_if_data *sdata)
517 {
518         ASSERT_RTNL();
519
520         ieee80211_todo_for_each_key(sdata, KEY_FLAG_TODO_HWACCEL_REMOVE);
521 }
522
523 static void __ieee80211_key_destroy(struct ieee80211_key *key)
524 {
525         if (!key)
526                 return;
527
528         ieee80211_key_disable_hw_accel(key);
529
530         if (key->conf.alg == ALG_CCMP)
531                 ieee80211_aes_key_free(key->u.ccmp.tfm);
532         if (key->conf.alg == ALG_AES_CMAC)
533                 ieee80211_aes_cmac_key_free(key->u.aes_cmac.tfm);
534         ieee80211_debugfs_key_remove(key);
535
536         kfree(key);
537 }
538
539 static void __ieee80211_key_todo(void)
540 {
541         struct ieee80211_key *key;
542         bool work_done;
543         u32 todoflags;
544
545         /*
546          * NB: sta_info_destroy relies on this!
547          */
548         synchronize_rcu();
549
550         spin_lock(&todo_lock);
551         while (!list_empty(&todo_list)) {
552                 key = list_first_entry(&todo_list, struct ieee80211_key, todo);
553                 list_del_init(&key->todo);
554                 todoflags = key->flags & (KEY_FLAG_TODO_ADD_DEBUGFS |
555                                           KEY_FLAG_TODO_DEFKEY |
556                                           KEY_FLAG_TODO_DEFMGMTKEY |
557                                           KEY_FLAG_TODO_HWACCEL_ADD |
558                                           KEY_FLAG_TODO_HWACCEL_REMOVE |
559                                           KEY_FLAG_TODO_DELETE);
560                 key->flags &= ~todoflags;
561                 spin_unlock(&todo_lock);
562
563                 work_done = false;
564
565                 if (todoflags & KEY_FLAG_TODO_ADD_DEBUGFS) {
566                         ieee80211_debugfs_key_add(key);
567                         work_done = true;
568                 }
569                 if (todoflags & KEY_FLAG_TODO_DEFKEY) {
570                         ieee80211_debugfs_key_remove_default(key->sdata);
571                         ieee80211_debugfs_key_add_default(key->sdata);
572                         work_done = true;
573                 }
574                 if (todoflags & KEY_FLAG_TODO_DEFMGMTKEY) {
575                         ieee80211_debugfs_key_remove_mgmt_default(key->sdata);
576                         ieee80211_debugfs_key_add_mgmt_default(key->sdata);
577                         work_done = true;
578                 }
579                 if (todoflags & KEY_FLAG_TODO_HWACCEL_ADD) {
580                         ieee80211_key_enable_hw_accel(key);
581                         work_done = true;
582                 }
583                 if (todoflags & KEY_FLAG_TODO_HWACCEL_REMOVE) {
584                         ieee80211_key_disable_hw_accel(key);
585                         work_done = true;
586                 }
587                 if (todoflags & KEY_FLAG_TODO_DELETE) {
588                         __ieee80211_key_destroy(key);
589                         work_done = true;
590                 }
591
592                 WARN_ON(!work_done);
593
594                 spin_lock(&todo_lock);
595         }
596         spin_unlock(&todo_lock);
597 }
598
599 void ieee80211_key_todo(void)
600 {
601         ieee80211_key_lock();
602         __ieee80211_key_todo();
603         ieee80211_key_unlock();
604 }
605
606 void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata)
607 {
608         struct ieee80211_key *key, *tmp;
609         unsigned long flags;
610
611         ieee80211_key_lock();
612
613         ieee80211_debugfs_key_remove_default(sdata);
614         ieee80211_debugfs_key_remove_mgmt_default(sdata);
615
616         spin_lock_irqsave(&sdata->local->key_lock, flags);
617         list_for_each_entry_safe(key, tmp, &sdata->key_list, list)
618                 __ieee80211_key_free(key);
619         spin_unlock_irqrestore(&sdata->local->key_lock, flags);
620
621         __ieee80211_key_todo();
622
623         ieee80211_key_unlock();
624 }