key.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright 2002-2004, Instant802 Networks, Inc.
  4. * Copyright 2005, Devicescape Software, Inc.
  5. * Copyright (C) 2019 Intel Corporation
  6. */
  7. #ifndef IEEE80211_KEY_H
  8. #define IEEE80211_KEY_H
  9. #include <linux/types.h>
  10. #include <linux/list.h>
  11. #include <linux/crypto.h>
  12. #include <linux/rcupdate.h>
  13. #include <crypto/arc4.h>
  14. #include <net/mac80211.h>
  15. #define NUM_DEFAULT_KEYS 4
  16. #define NUM_DEFAULT_MGMT_KEYS 2
  17. #define NUM_DEFAULT_BEACON_KEYS 2
  18. #define INVALID_PTK_KEYIDX 2 /* Keyidx always pointing to a NULL key for PTK */
  19. struct ieee80211_local;
  20. struct ieee80211_sub_if_data;
  21. struct sta_info;
  22. /**
  23. * enum ieee80211_internal_key_flags - internal key flags
  24. *
  25. * @KEY_FLAG_UPLOADED_TO_HARDWARE: Indicates that this key is present
  26. * in the hardware for TX crypto hardware acceleration.
  27. * @KEY_FLAG_TAINTED: Key is tainted and packets should be dropped.
  28. * @KEY_FLAG_CIPHER_SCHEME: This key is for a hardware cipher scheme
  29. */
  30. enum ieee80211_internal_key_flags {
  31. KEY_FLAG_UPLOADED_TO_HARDWARE = BIT(0),
  32. KEY_FLAG_TAINTED = BIT(1),
  33. KEY_FLAG_CIPHER_SCHEME = BIT(2),
  34. };
  35. enum ieee80211_internal_tkip_state {
  36. TKIP_STATE_NOT_INIT,
  37. TKIP_STATE_PHASE1_DONE,
  38. TKIP_STATE_PHASE1_HW_UPLOADED,
  39. };
  40. struct tkip_ctx {
  41. u16 p1k[5]; /* p1k cache */
  42. u32 p1k_iv32; /* iv32 for which p1k computed */
  43. enum ieee80211_internal_tkip_state state;
  44. };
  45. struct tkip_ctx_rx {
  46. struct tkip_ctx ctx;
  47. u32 iv32; /* current iv32 */
  48. u16 iv16; /* current iv16 */
  49. };
  50. struct ieee80211_key {
  51. struct ieee80211_local *local;
  52. struct ieee80211_sub_if_data *sdata;
  53. struct sta_info *sta;
  54. /* for sdata list */
  55. struct list_head list;
  56. /* protected by key mutex */
  57. unsigned int flags;
  58. union {
  59. struct {
  60. /* protects tx context */
  61. spinlock_t txlock;
  62. /* last used TSC */
  63. struct tkip_ctx tx;
  64. /* last received RSC */
  65. struct tkip_ctx_rx rx[IEEE80211_NUM_TIDS];
  66. /* number of mic failures */
  67. u32 mic_failures;
  68. } tkip;
  69. struct {
  70. /*
  71. * Last received packet number. The first
  72. * IEEE80211_NUM_TIDS counters are used with Data
  73. * frames and the last counter is used with Robust
  74. * Management frames.
  75. */
  76. u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_CCMP_PN_LEN];
  77. struct crypto_aead *tfm;
  78. u32 replays; /* dot11RSNAStatsCCMPReplays */
  79. } ccmp;
  80. struct {
  81. u8 rx_pn[IEEE80211_CMAC_PN_LEN];
  82. struct crypto_shash *tfm;
  83. u32 replays; /* dot11RSNAStatsCMACReplays */
  84. u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
  85. } aes_cmac;
  86. struct {
  87. u8 rx_pn[IEEE80211_GMAC_PN_LEN];
  88. struct crypto_aead *tfm;
  89. u32 replays; /* dot11RSNAStatsCMACReplays */
  90. u32 icverrors; /* dot11RSNAStatsCMACICVErrors */
  91. } aes_gmac;
  92. struct {
  93. /* Last received packet number. The first
  94. * IEEE80211_NUM_TIDS counters are used with Data
  95. * frames and the last counter is used with Robust
  96. * Management frames.
  97. */
  98. u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_GCMP_PN_LEN];
  99. struct crypto_aead *tfm;
  100. u32 replays; /* dot11RSNAStatsGCMPReplays */
  101. } gcmp;
  102. struct {
  103. /* generic cipher scheme */
  104. u8 rx_pn[IEEE80211_NUM_TIDS + 1][IEEE80211_MAX_PN_LEN];
  105. } gen;
  106. } u;
  107. #ifdef CONFIG_MAC80211_DEBUGFS
  108. struct {
  109. struct dentry *stalink;
  110. struct dentry *dir;
  111. int cnt;
  112. } debugfs;
  113. #endif
  114. unsigned int color;
  115. /*
  116. * key config, must be last because it contains key
  117. * material as variable length member
  118. */
  119. struct ieee80211_key_conf conf;
  120. };
  121. struct ieee80211_key *
  122. ieee80211_key_alloc(u32 cipher, int idx, size_t key_len,
  123. const u8 *key_data,
  124. size_t seq_len, const u8 *seq,
  125. const struct ieee80211_cipher_scheme *cs);
  126. /*
  127. * Insert a key into data structures (sdata, sta if necessary)
  128. * to make it used, free old key. On failure, also free the new key.
  129. */
  130. int ieee80211_key_link(struct ieee80211_key *key,
  131. struct ieee80211_sub_if_data *sdata,
  132. struct sta_info *sta);
  133. int ieee80211_set_tx_key(struct ieee80211_key *key);
  134. void ieee80211_key_free(struct ieee80211_key *key, bool delay_tailroom);
  135. void ieee80211_key_free_unused(struct ieee80211_key *key);
  136. void ieee80211_set_default_key(struct ieee80211_sub_if_data *sdata, int idx,
  137. bool uni, bool multi);
  138. void ieee80211_set_default_mgmt_key(struct ieee80211_sub_if_data *sdata,
  139. int idx);
  140. void ieee80211_set_default_beacon_key(struct ieee80211_sub_if_data *sdata,
  141. int idx);
  142. void ieee80211_free_keys(struct ieee80211_sub_if_data *sdata,
  143. bool force_synchronize);
  144. void ieee80211_free_sta_keys(struct ieee80211_local *local,
  145. struct sta_info *sta);
  146. void ieee80211_reenable_keys(struct ieee80211_sub_if_data *sdata);
  147. #define key_mtx_dereference(local, ref) \
  148. rcu_dereference_protected(ref, lockdep_is_held(&((local)->key_mtx)))
  149. void ieee80211_delayed_tailroom_dec(struct work_struct *wk);
  150. #endif /* IEEE80211_KEY_H */