sys/net80211/ieee80211_crypto.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2001 Atsushi Onoe
   5  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30 #ifndef _NET80211_IEEE80211_CRYPTO_H_
  31 #define _NET80211_IEEE80211_CRYPTO_H_
  32
  33 /*
  34  * 802.11 protocol crypto-related definitions.
  35  */
  36 #define IEEE80211_KEYBUF_SIZE   16
  37 #define IEEE80211_MICBUF_SIZE   (8+8)   /* space for both tx+rx keys */
  38
  39 /*
  40  * Old WEP-style key.  Deprecated.
  41  */
  42 struct ieee80211_wepkey {
  43         u_int           wk_len;         /* key length in bytes */
  44         uint8_t         wk_key[IEEE80211_KEYBUF_SIZE];
  45 };
  46
  47 struct ieee80211_rsnparms {
  48         uint8_t         rsn_mcastcipher;        /* mcast/group cipher */
  49         uint8_t         rsn_mcastkeylen;        /* mcast key length */
  50         uint8_t         rsn_ucastcipher;        /* selected unicast cipher */
  51         uint8_t         rsn_ucastkeylen;        /* unicast key length */
  52         uint8_t         rsn_keymgmt;            /* selected key mgmt algo */
  53         uint16_t        rsn_caps;               /* capabilities */
  54 };
  55
  56 struct ieee80211_cipher;
  57
  58 /*
  59  * Crypto key state.  There is sufficient room for all supported
  60  * ciphers (see below).  The underlying ciphers are handled
  61  * separately through loadable cipher modules that register with
  62  * the generic crypto support.  A key has a reference to an instance
  63  * of the cipher; any per-key state is hung off wk_private by the
  64  * cipher when it is attached.  Ciphers are automatically called
  65  * to detach and cleanup any such state when the key is deleted.
  66  *
  67  * The generic crypto support handles encap/decap of cipher-related
  68  * frame contents for both hardware- and software-based implementations.
  69  * A key requiring software crypto support is automatically flagged and
  70  * the cipher is expected to honor this and do the necessary work.
  71  * Ciphers such as TKIP may also support mixed hardware/software
  72  * encrypt/decrypt and MIC processing.
  73  */
  74 typedef uint16_t ieee80211_keyix;       /* h/w key index */
  75
  76 struct ieee80211_key {
  77         uint8_t         wk_keylen;      /* key length in bytes */
  78         uint8_t         wk_pad;         /* .. some drivers use this. Fix that. */
  79         uint8_t         wk_pad1[2];
  80         uint32_t        wk_flags;
  81 #define IEEE80211_KEY_XMIT      0x00000001      /* key used for xmit */
  82 #define IEEE80211_KEY_RECV      0x00000002      /* key used for recv */
  83 #define IEEE80211_KEY_GROUP     0x00000004      /* key used for WPA group operation */
  84 #define IEEE80211_KEY_NOREPLAY  0x00000008      /* ignore replay failures */
  85 #define IEEE80211_KEY_SWENCRYPT 0x00000010      /* host-based encrypt */
  86 #define IEEE80211_KEY_SWDECRYPT 0x00000020      /* host-based decrypt */
  87 #define IEEE80211_KEY_SWENMIC   0x00000040      /* host-based enmic */
  88 #define IEEE80211_KEY_SWDEMIC   0x00000080      /* host-based demic */
  89 #define IEEE80211_KEY_DEVKEY    0x00000100      /* device key request completed */
  90 #define IEEE80211_KEY_CIPHER0   0x00001000      /* cipher-specific action 0 */
  91 #define IEEE80211_KEY_CIPHER1   0x00002000      /* cipher-specific action 1 */
  92 #define IEEE80211_KEY_NOIV      0x00004000      /* don't insert IV/MIC for !mgmt */
  93 #define IEEE80211_KEY_NOIVMGT   0x00008000      /* don't insert IV/MIC for mgmt */
  94 #define IEEE80211_KEY_NOMIC     0x00010000      /* don't insert MIC for !mgmt */
  95 #define IEEE80211_KEY_NOMICMGT  0x00020000      /* don't insert MIC for mgmt */
  96
  97         ieee80211_keyix wk_keyix;       /* h/w key index */
  98         ieee80211_keyix wk_rxkeyix;     /* optional h/w rx key index */
  99         uint8_t         wk_key[IEEE80211_KEYBUF_SIZE+IEEE80211_MICBUF_SIZE];
 100 #define wk_txmic        wk_key+IEEE80211_KEYBUF_SIZE+0  /* XXX can't () right */
 101 #define wk_rxmic        wk_key+IEEE80211_KEYBUF_SIZE+8  /* XXX can't () right */
 102                                         /* key receive sequence counter */
 103         uint64_t        wk_keyrsc[IEEE80211_TID_SIZE];
 104         uint64_t        wk_keytsc;      /* key transmit sequence counter */
 105         const struct ieee80211_cipher *wk_cipher;
 106         void            *wk_private;    /* private cipher state */
 107         uint8_t         wk_macaddr[IEEE80211_ADDR_LEN];
 108 };
 109 #define IEEE80211_KEY_COMMON            /* common flags passed in by apps */\
 110         (IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV | IEEE80211_KEY_GROUP | \
 111          IEEE80211_KEY_NOREPLAY)
 112
 113 #define IEEE80211_KEY_SWCRYPT \
 114         (IEEE80211_KEY_SWENCRYPT | IEEE80211_KEY_SWDECRYPT)
 115 #define IEEE80211_KEY_SWMIC     (IEEE80211_KEY_SWENMIC | IEEE80211_KEY_SWDEMIC)
 116
 117 #define IEEE80211_KEY_DEVICE            /* flags owned by device driver */\
 118         (IEEE80211_KEY_DEVKEY|IEEE80211_KEY_CIPHER0|IEEE80211_KEY_CIPHER1| \
 119          IEEE80211_KEY_SWCRYPT|IEEE80211_KEY_SWMIC|IEEE80211_KEY_NOIV | \
 120          IEEE80211_KEY_NOIVMGT|IEEE80211_KEY_NOMIC|IEEE80211_KEY_NOMICMGT)
 121
 122 #define IEEE80211_KEY_BITS \
 123         "\20\1XMIT\2RECV\3GROUP\4SWENCRYPT\5SWDECRYPT\6SWENMIC\7SWDEMIC" \
 124         "\10DEVKEY\11CIPHER0\12CIPHER1"
 125
 126 #define IEEE80211_KEYIX_NONE    ((ieee80211_keyix) -1)
 127
 128 /*
 129  * NB: these values are ordered carefully; there are lots of
 130  * of implications in any reordering.  Beware that 4 is used
 131  * only to indicate h/w TKIP MIC support in driver capabilities;
 132  * there is no separate cipher support (it's rolled into the
 133  * TKIP cipher support).
 134  */
 135 #define IEEE80211_CIPHER_WEP            0
 136 #define IEEE80211_CIPHER_TKIP           1
 137 #define IEEE80211_CIPHER_AES_OCB        2
 138 #define IEEE80211_CIPHER_AES_CCM        3
 139 #define IEEE80211_CIPHER_TKIPMIC        4       /* TKIP MIC capability */
 140 #define IEEE80211_CIPHER_CKIP           5
 141 #define IEEE80211_CIPHER_NONE           6       /* pseudo value */
 142
 143 #define IEEE80211_CIPHER_MAX            (IEEE80211_CIPHER_NONE+1)
 144
 145 /* capability bits in ic_cryptocaps/iv_cryptocaps */
 146 #define IEEE80211_CRYPTO_WEP            (1<<IEEE80211_CIPHER_WEP)
 147 #define IEEE80211_CRYPTO_TKIP           (1<<IEEE80211_CIPHER_TKIP)
 148 #define IEEE80211_CRYPTO_AES_OCB        (1<<IEEE80211_CIPHER_AES_OCB)
 149 #define IEEE80211_CRYPTO_AES_CCM        (1<<IEEE80211_CIPHER_AES_CCM)
 150 #define IEEE80211_CRYPTO_TKIPMIC        (1<<IEEE80211_CIPHER_TKIPMIC)
 151 #define IEEE80211_CRYPTO_CKIP           (1<<IEEE80211_CIPHER_CKIP)
 152
 153 #define IEEE80211_CRYPTO_BITS \
 154         "\20\1WEP\2TKIP\3AES\4AES_CCM\5TKIPMIC\6CKIP"
 155
 156 #if defined(__KERNEL__) || defined(_KERNEL)
 157
 158 struct ieee80211com;
 159 struct ieee80211vap;
 160 struct ieee80211_node;
 161 struct mbuf;
 162
 163 MALLOC_DECLARE(M_80211_CRYPTO);
 164
 165 void    ieee80211_crypto_attach(struct ieee80211com *);
 166 void    ieee80211_crypto_detach(struct ieee80211com *);
 167 void    ieee80211_crypto_vattach(struct ieee80211vap *);
 168 void    ieee80211_crypto_vdetach(struct ieee80211vap *);
 169 int     ieee80211_crypto_newkey(struct ieee80211vap *,
 170                 int cipher, int flags, struct ieee80211_key *);
 171 int     ieee80211_crypto_delkey(struct ieee80211vap *,
 172                 struct ieee80211_key *);
 173 int     ieee80211_crypto_setkey(struct ieee80211vap *, struct ieee80211_key *);
 174 void    ieee80211_crypto_delglobalkeys(struct ieee80211vap *);
 175 void    ieee80211_crypto_reload_keys(struct ieee80211com *);
 176 void    ieee80211_crypto_set_deftxkey(struct ieee80211vap *,
 177             ieee80211_keyix kid);
 178
 179 /*
 180  * Template for a supported cipher.  Ciphers register with the
 181  * crypto code and are typically loaded as separate modules
 182  * (the null cipher is always present).
 183  * XXX may need refcnts
 184  */
 185 struct ieee80211_cipher {
 186         const char *ic_name;            /* printable name */
 187         u_int   ic_cipher;              /* IEEE80211_CIPHER_* */
 188         u_int   ic_header;              /* size of privacy header (bytes) */
 189         u_int   ic_trailer;             /* size of privacy trailer (bytes) */
 190         u_int   ic_miclen;              /* size of mic trailer (bytes) */
 191         void*   (*ic_attach)(struct ieee80211vap *, struct ieee80211_key *);
 192         void    (*ic_detach)(struct ieee80211_key *);
 193         int     (*ic_setkey)(struct ieee80211_key *);
 194         void    (*ic_setiv)(struct ieee80211_key *, uint8_t *);
 195         int     (*ic_encap)(struct ieee80211_key *, struct mbuf *);
 196         int     (*ic_decap)(struct ieee80211_key *, struct mbuf *, int);
 197         int     (*ic_enmic)(struct ieee80211_key *, struct mbuf *, int);
 198         int     (*ic_demic)(struct ieee80211_key *, struct mbuf *, int);
 199 };
 200 extern  const struct ieee80211_cipher ieee80211_cipher_none;
 201
 202 #define IEEE80211_KEY_UNDEFINED(k) \
 203         ((k)->wk_cipher == &ieee80211_cipher_none)
 204
 205 void    ieee80211_crypto_register(const struct ieee80211_cipher *);
 206 void    ieee80211_crypto_unregister(const struct ieee80211_cipher *);
 207 int     ieee80211_crypto_available(u_int cipher);
 208
 209 int     ieee80211_crypto_get_key_wepidx(const struct ieee80211vap *,
 210             const struct ieee80211_key *k);
 211 uint8_t ieee80211_crypto_get_keyid(struct ieee80211vap *vap,
 212                 struct ieee80211_key *k);
 213 struct ieee80211_key *ieee80211_crypto_get_txkey(struct ieee80211_node *,
 214                 struct mbuf *);
 215 struct ieee80211_key *ieee80211_crypto_encap(struct ieee80211_node *,
 216                 struct mbuf *);
 217 int     ieee80211_crypto_decap(struct ieee80211_node *,
 218                 struct mbuf *, int, struct ieee80211_key **);
 219 int ieee80211_crypto_demic(struct ieee80211vap *vap, struct ieee80211_key *k,
 220                 struct mbuf *, int);
 221 /*
 222  * Add any MIC.
 223  */
 224 static __inline int
 225 ieee80211_crypto_enmic(struct ieee80211vap *vap,
 226         struct ieee80211_key *k, struct mbuf *m, int force)
 227 {
 228         const struct ieee80211_cipher *cip = k->wk_cipher;
 229         return (cip->ic_miclen > 0 ? cip->ic_enmic(k, m, force) : 1);
 230 }
 231
 232 /*
 233  * Reset key state to an unused state.  The crypto
 234  * key allocation mechanism insures other state (e.g.
 235  * key data) is properly setup before a key is used.
 236  */
 237 static __inline void
 238 ieee80211_crypto_resetkey(struct ieee80211vap *vap,
 239         struct ieee80211_key *k, ieee80211_keyix ix)
 240 {
 241         k->wk_cipher = &ieee80211_cipher_none;
 242         k->wk_private = k->wk_cipher->ic_attach(vap, k);
 243         k->wk_keyix = k->wk_rxkeyix = ix;
 244         k->wk_flags = IEEE80211_KEY_XMIT | IEEE80211_KEY_RECV;
 245 }
 246
 247 /*
 248  * Crypt-related notification methods.
 249  */
 250 void    ieee80211_notify_replay_failure(struct ieee80211vap *,
 251                 const struct ieee80211_frame *, const struct ieee80211_key *,
 252                 uint64_t rsc, int tid);
 253 void    ieee80211_notify_michael_failure(struct ieee80211vap *,
 254                 const struct ieee80211_frame *, u_int keyix);
 255 #endif /* defined(__KERNEL__) || defined(_KERNEL) */
 256 #endif /* _NET80211_IEEE80211_CRYPTO_H_ */