The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/net80211/ieee80211_crypto.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: 75a161fe5211684beb5a7c62193d2747


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.