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/opencrypto/cryptodev.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $FreeBSD$       */
    2 /*      $OpenBSD: cryptodev.h,v 1.31 2002/06/11 11:14:29 beck Exp $     */
    3 
    4 /*-
    5  * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu)
    6  * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting
    7  *
    8  * This code was written by Angelos D. Keromytis in Athens, Greece, in
    9  * February 2000. Network Security Technologies Inc. (NSTI) kindly
   10  * supported the development of this code.
   11  *
   12  * Copyright (c) 2000 Angelos D. Keromytis
   13  *
   14  * Permission to use, copy, and modify this software with or without fee
   15  * is hereby granted, provided that this entire notice is included in
   16  * all source code copies of any software which is or includes a copy or
   17  * modification of this software.
   18  *
   19  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
   20  * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
   21  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
   22  * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
   23  * PURPOSE.
   24  *
   25  * Copyright (c) 2001 Theo de Raadt
   26  * Copyright (c) 2014 The FreeBSD Foundation
   27  * All rights reserved.
   28  *
   29  * Portions of this software were developed by John-Mark Gurney
   30  * under sponsorship of the FreeBSD Foundation and
   31  * Rubicon Communications, LLC (Netgate).
   32  *
   33  * Redistribution and use in source and binary forms, with or without
   34  * modification, are permitted provided that the following conditions
   35  * are met:
   36  *
   37  * 1. Redistributions of source code must retain the above copyright
   38  *   notice, this list of conditions and the following disclaimer.
   39  * 2. Redistributions in binary form must reproduce the above copyright
   40  *   notice, this list of conditions and the following disclaimer in the
   41  *   documentation and/or other materials provided with the distribution.
   42  * 3. The name of the author may not be used to endorse or promote products
   43  *   derived from this software without specific prior written permission.
   44  *
   45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   55  *
   56  * Effort sponsored in part by the Defense Advanced Research Projects
   57  * Agency (DARPA) and Air Force Research Laboratory, Air Force
   58  * Materiel Command, USAF, under agreement number F30602-01-2-0537.
   59  *
   60  */
   61 
   62 #ifndef _CRYPTO_CRYPTO_H_
   63 #define _CRYPTO_CRYPTO_H_
   64 
   65 #include <sys/ioccom.h>
   66 
   67 #ifdef _KERNEL
   68 #include <opencrypto/_cryptodev.h>
   69 #include <sys/_task.h>
   70 #endif
   71 
   72 /* Some initial values */
   73 #define CRYPTO_DRIVERS_INITIAL  4
   74 
   75 /* Hash values */
   76 #define NULL_HASH_LEN           16
   77 #define SHA1_HASH_LEN           20
   78 #define RIPEMD160_HASH_LEN      20
   79 #define SHA2_224_HASH_LEN       28
   80 #define SHA2_256_HASH_LEN       32
   81 #define SHA2_384_HASH_LEN       48
   82 #define SHA2_512_HASH_LEN       64
   83 #define AES_GMAC_HASH_LEN       16
   84 #define POLY1305_HASH_LEN       16
   85 #define AES_CBC_MAC_HASH_LEN    16
   86 /* Maximum hash algorithm result length */
   87 #define HASH_MAX_LEN            SHA2_512_HASH_LEN /* Keep this updated */
   88 
   89 #define SHA1_BLOCK_LEN          64
   90 #define RIPEMD160_BLOCK_LEN     64
   91 #define SHA2_224_BLOCK_LEN      64
   92 #define SHA2_256_BLOCK_LEN      64
   93 #define SHA2_384_BLOCK_LEN      128
   94 #define SHA2_512_BLOCK_LEN      128
   95 
   96 /* HMAC values */
   97 #define NULL_HMAC_BLOCK_LEN             64
   98 /* Maximum HMAC block length */
   99 #define HMAC_MAX_BLOCK_LEN      SHA2_512_BLOCK_LEN /* Keep this updated */
  100 #define HMAC_IPAD_VAL                   0x36
  101 #define HMAC_OPAD_VAL                   0x5C
  102 /* HMAC Key Length */
  103 #define AES_128_GMAC_KEY_LEN            16
  104 #define AES_192_GMAC_KEY_LEN            24
  105 #define AES_256_GMAC_KEY_LEN            32
  106 #define AES_128_CBC_MAC_KEY_LEN         16
  107 #define AES_192_CBC_MAC_KEY_LEN         24
  108 #define AES_256_CBC_MAC_KEY_LEN         32
  109 
  110 #define POLY1305_KEY_LEN                32
  111 
  112 /* Encryption algorithm block sizes */
  113 #define NULL_BLOCK_LEN          4       /* IPsec to maintain alignment */
  114 #define RIJNDAEL128_BLOCK_LEN   16
  115 #define AES_BLOCK_LEN           16
  116 #define AES_ICM_BLOCK_LEN       1
  117 #define CAMELLIA_BLOCK_LEN      16
  118 #define CHACHA20_NATIVE_BLOCK_LEN       64
  119 #define EALG_MAX_BLOCK_LEN      CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */
  120 
  121 /* IV Lengths */
  122 
  123 #define AES_GCM_IV_LEN          12
  124 #define AES_CCM_IV_LEN          12
  125 #define AES_XTS_IV_LEN          8
  126 #define AES_XTS_ALPHA           0x87    /* GF(2^128) generator polynomial */
  127 
  128 /* Min and Max Encryption Key Sizes */
  129 #define NULL_MIN_KEY            0
  130 #define NULL_MAX_KEY            256 /* 2048 bits, max key */
  131 #define RIJNDAEL_MIN_KEY        16
  132 #define RIJNDAEL_MAX_KEY        32
  133 #define AES_MIN_KEY             RIJNDAEL_MIN_KEY
  134 #define AES_MAX_KEY             RIJNDAEL_MAX_KEY
  135 #define AES_XTS_MIN_KEY         (2 * AES_MIN_KEY)
  136 #define AES_XTS_MAX_KEY         (2 * AES_MAX_KEY)
  137 #define CAMELLIA_MIN_KEY        16
  138 #define CAMELLIA_MAX_KEY        32
  139 
  140 /* Maximum hash algorithm result length */
  141 #define AALG_MAX_RESULT_LEN     64 /* Keep this updated */
  142 
  143 #define CRYPTO_ALGORITHM_MIN    1
  144 #define CRYPTO_DES_CBC          1
  145 #define CRYPTO_3DES_CBC         2
  146 #define CRYPTO_BLF_CBC          3
  147 #define CRYPTO_CAST_CBC         4
  148 #define CRYPTO_SKIPJACK_CBC     5
  149 #define CRYPTO_MD5_HMAC         6
  150 #define CRYPTO_SHA1_HMAC        7
  151 #define CRYPTO_RIPEMD160_HMAC   8
  152 #define CRYPTO_MD5_KPDK         9
  153 #define CRYPTO_SHA1_KPDK        10
  154 #define CRYPTO_RIJNDAEL128_CBC  11 /* 128 bit blocksize */
  155 #define CRYPTO_AES_CBC          11 /* 128 bit blocksize -- the same as above */
  156 #define CRYPTO_ARC4             12
  157 #define CRYPTO_MD5              13
  158 #define CRYPTO_SHA1             14
  159 #define CRYPTO_NULL_HMAC        15
  160 #define CRYPTO_NULL_CBC         16
  161 #define CRYPTO_DEFLATE_COMP     17 /* Deflate compression algorithm */
  162 #define CRYPTO_SHA2_256_HMAC    18
  163 #define CRYPTO_SHA2_384_HMAC    19
  164 #define CRYPTO_SHA2_512_HMAC    20
  165 #define CRYPTO_CAMELLIA_CBC     21
  166 #define CRYPTO_AES_XTS          22
  167 #define CRYPTO_AES_ICM          23 /* commonly known as CTR mode */
  168 #define CRYPTO_AES_NIST_GMAC    24 /* GMAC only */
  169 #define CRYPTO_AES_NIST_GCM_16  25 /* 16 byte ICV */
  170 #ifdef _KERNEL
  171 #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */
  172 #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */
  173 #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */
  174 #endif
  175 #define CRYPTO_BLAKE2B          29 /* Blake2b hash */
  176 #define CRYPTO_BLAKE2S          30 /* Blake2s hash */
  177 #define CRYPTO_CHACHA20         31 /* Chacha20 stream cipher */
  178 #define CRYPTO_SHA2_224_HMAC    32
  179 #define CRYPTO_RIPEMD160        33
  180 #define CRYPTO_SHA2_224         34
  181 #define CRYPTO_SHA2_256         35
  182 #define CRYPTO_SHA2_384         36
  183 #define CRYPTO_SHA2_512         37
  184 #define CRYPTO_POLY1305         38
  185 #define CRYPTO_AES_CCM_CBC_MAC  39      /* auth side */
  186 #define CRYPTO_AES_CCM_16       40      /* cipher side */
  187 #define CRYPTO_ALGORITHM_MAX    40      /* Keep updated - see below */
  188 
  189 #define CRYPTO_ALGO_VALID(x)    ((x) >= CRYPTO_ALGORITHM_MIN && \
  190                                  (x) <= CRYPTO_ALGORITHM_MAX)
  191 
  192 /* Algorithm flags */
  193 #define CRYPTO_ALG_FLAG_SUPPORTED       0x01 /* Algorithm is supported */
  194 #define CRYPTO_ALG_FLAG_RNG_ENABLE      0x02 /* Has HW RNG for DH/DSA */
  195 #define CRYPTO_ALG_FLAG_DSA_SHA         0x04 /* Can do SHA on msg */
  196 
  197 /*
  198  * Crypto driver/device flags.  They can set in the crid
  199  * parameter when creating a session or submitting a key
  200  * op to affect the device/driver assigned.  If neither
  201  * of these are specified then the crid is assumed to hold
  202  * the driver id of an existing (and suitable) device that
  203  * must be used to satisfy the request.
  204  */
  205 #define CRYPTO_FLAG_HARDWARE    0x01000000      /* hardware accelerated */
  206 #define CRYPTO_FLAG_SOFTWARE    0x02000000      /* software implementation */
  207 
  208 /* Does the kernel support vmpage buffers on this platform? */
  209 #ifdef __powerpc__
  210 #define CRYPTO_MAY_HAVE_VMPAGE  1
  211 #else
  212 #define CRYPTO_MAY_HAVE_VMPAGE  ( PMAP_HAS_DMAP )
  213 #endif
  214 /* Does the currently running system support vmpage buffers on this platform? */
  215 #define CRYPTO_HAS_VMPAGE       ( PMAP_HAS_DMAP )
  216 
  217 /* NB: deprecated */
  218 struct session_op {
  219         uint32_t        cipher;         /* ie. CRYPTO_AES_CBC */
  220         uint32_t        mac;            /* ie. CRYPTO_SHA2_256_HMAC */
  221 
  222         uint32_t        keylen;         /* cipher key */
  223         const void      *key;
  224         int             mackeylen;      /* mac key */
  225         const void      *mackey;
  226 
  227         uint32_t        ses;            /* returns: session # */ 
  228 };
  229 
  230 /*
  231  * session and crypt _op structs are used by userspace programs to interact
  232  * with /dev/crypto.  Confusingly, the internal kernel interface is named
  233  * "cryptop" (no underscore).
  234  */
  235 struct session2_op {
  236         uint32_t        cipher;         /* ie. CRYPTO_AES_CBC */
  237         uint32_t        mac;            /* ie. CRYPTO_SHA2_256_HMAC */
  238 
  239         uint32_t        keylen;         /* cipher key */
  240         const void      *key;
  241         int             mackeylen;      /* mac key */
  242         const void      *mackey;
  243 
  244         uint32_t        ses;            /* returns: session # */ 
  245         int             crid;           /* driver id + flags (rw) */
  246         int             pad[4];         /* for future expansion */
  247 };
  248 
  249 struct crypt_op {
  250         uint32_t        ses;
  251         uint16_t        op;             /* i.e. COP_ENCRYPT */
  252 #define COP_ENCRYPT     1
  253 #define COP_DECRYPT     2
  254         uint16_t        flags;
  255 #define COP_F_CIPHER_FIRST      0x0001  /* Cipher before MAC. */
  256 #define COP_F_BATCH             0x0008  /* Batch op if possible */
  257         u_int           len;
  258         const void      *src;           /* become iov[] inside kernel */
  259         void            *dst;
  260         void            *mac;           /* must be big enough for chosen MAC */
  261         const void      *iv;
  262 };
  263 
  264 /* op and flags the same as crypt_op */
  265 struct crypt_aead {
  266         uint32_t        ses;
  267         uint16_t        op;             /* i.e. COP_ENCRYPT */
  268         uint16_t        flags;
  269         u_int           len;
  270         u_int           aadlen;
  271         u_int           ivlen;
  272         const void      *src;           /* become iov[] inside kernel */
  273         void            *dst;
  274         const void      *aad;           /* additional authenticated data */
  275         void            *tag;           /* must fit for chosen TAG length */
  276         const void      *iv;
  277 };
  278 
  279 /*
  280  * Parameters for looking up a crypto driver/device by
  281  * device name or by id.  The latter are returned for
  282  * created sessions (crid) and completed key operations.
  283  */
  284 struct crypt_find_op {
  285         int             crid;           /* driver id + flags */
  286         char            name[32];       /* device/driver name */
  287 };
  288 
  289 /* bignum parameter, in packed bytes, ... */
  290 struct crparam {
  291         void            *crp_p;
  292         u_int           crp_nbits;
  293 };
  294 
  295 #define CRK_MAXPARAM    8
  296 
  297 struct crypt_kop {
  298         u_int           crk_op;         /* ie. CRK_MOD_EXP or other */
  299         u_int           crk_status;     /* return status */
  300         u_short         crk_iparams;    /* # of input parameters */
  301         u_short         crk_oparams;    /* # of output parameters */
  302         u_int           crk_crid;       /* NB: only used by CIOCKEY2 (rw) */
  303         struct crparam  crk_param[CRK_MAXPARAM];
  304 };
  305 #define CRK_ALGORITM_MIN        0
  306 #define CRK_MOD_EXP             0
  307 #define CRK_MOD_EXP_CRT         1
  308 #define CRK_DSA_SIGN            2
  309 #define CRK_DSA_VERIFY          3
  310 #define CRK_DH_COMPUTE_KEY      4
  311 #define CRK_ALGORITHM_MAX       4 /* Keep updated - see below */
  312 
  313 #define CRF_MOD_EXP             (1 << CRK_MOD_EXP)
  314 #define CRF_MOD_EXP_CRT         (1 << CRK_MOD_EXP_CRT)
  315 #define CRF_DSA_SIGN            (1 << CRK_DSA_SIGN)
  316 #define CRF_DSA_VERIFY          (1 << CRK_DSA_VERIFY)
  317 #define CRF_DH_COMPUTE_KEY      (1 << CRK_DH_COMPUTE_KEY)
  318 
  319 #define CIOCGSESSION    _IOWR('c', 101, struct session_op)
  320 #define CIOCFSESSION    _IOW('c', 102, uint32_t)
  321 #define CIOCCRYPT       _IOWR('c', 103, struct crypt_op)
  322 #define CIOCKEY         _IOWR('c', 104, struct crypt_kop)
  323 #define CIOCASYMFEAT    _IOR('c', 105, uint32_t)
  324 #define CIOCGSESSION2   _IOWR('c', 106, struct session2_op)
  325 #define CIOCKEY2        _IOWR('c', 107, struct crypt_kop)
  326 #define CIOCFINDDEV     _IOWR('c', 108, struct crypt_find_op)
  327 #define CIOCCRYPTAEAD   _IOWR('c', 109, struct crypt_aead)
  328 
  329 struct cryptostats {
  330         uint64_t        cs_ops;         /* symmetric crypto ops submitted */
  331         uint64_t        cs_errs;        /* symmetric crypto ops that failed */
  332         uint64_t        cs_kops;        /* asymetric/key ops submitted */
  333         uint64_t        cs_kerrs;       /* asymetric/key ops that failed */
  334         uint64_t        cs_intrs;       /* crypto swi thread activations */
  335         uint64_t        cs_rets;        /* crypto return thread activations */
  336         uint64_t        cs_blocks;      /* symmetric op driver block */
  337         uint64_t        cs_kblocks;     /* symmetric op driver block */
  338 };
  339 
  340 #ifdef _KERNEL
  341 
  342 /*
  343  * Return values for cryptodev_probesession methods.
  344  */
  345 #define CRYPTODEV_PROBE_HARDWARE        (-100)
  346 #define CRYPTODEV_PROBE_ACCEL_SOFTWARE  (-200)
  347 #define CRYPTODEV_PROBE_SOFTWARE        (-500)
  348 
  349 #if 0
  350 #define CRYPTDEB(s, ...) do {                                           \
  351         printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__);   \
  352 } while (0)
  353 #else
  354 #define CRYPTDEB(...)   do { } while (0)
  355 #endif
  356 
  357 struct crypto_session_params {
  358         int             csp_mode;       /* Type of operations to perform. */
  359 
  360 #define CSP_MODE_NONE           0
  361 #define CSP_MODE_COMPRESS       1       /* Compression/decompression. */
  362 #define CSP_MODE_CIPHER         2       /* Encrypt/decrypt. */
  363 #define CSP_MODE_DIGEST         3       /* Compute/verify digest. */
  364 #define CSP_MODE_AEAD           4       /* Combined auth/encryption. */
  365 #define CSP_MODE_ETA            5       /* IPsec style encrypt-then-auth */
  366 
  367         int             csp_flags;
  368 
  369 #define CSP_F_SEPARATE_OUTPUT   0x0001  /* Requests can use separate output */
  370 #define CSP_F_SEPARATE_AAD      0x0002  /* Requests can use separate AAD */
  371 #define CSP_F_ESN               0x0004  /* Requests can use seperate ESN field */ 
  372 
  373         int             csp_ivlen;      /* IV length in bytes. */
  374 
  375         int             csp_cipher_alg;
  376         int             csp_cipher_klen; /* Key length in bytes. */
  377         const void      *csp_cipher_key;
  378 
  379         int             csp_auth_alg;
  380         int             csp_auth_klen;  /* Key length in bytes. */
  381         const void      *csp_auth_key;
  382         int             csp_auth_mlen;  /* Number of digest bytes to use.
  383                                            0 means all. */
  384 };
  385 
  386 enum crypto_buffer_type {
  387         CRYPTO_BUF_NONE = 0,
  388         CRYPTO_BUF_CONTIG,
  389         CRYPTO_BUF_UIO,
  390         CRYPTO_BUF_MBUF,
  391         CRYPTO_BUF_VMPAGE,
  392         CRYPTO_BUF_LAST = CRYPTO_BUF_VMPAGE
  393 };
  394 
  395 /*
  396  * Description of a data buffer for a request.  Requests can either
  397  * have a single buffer that is modified in place or separate input
  398  * and output buffers.
  399  */
  400 struct crypto_buffer {
  401         union {
  402                 struct {
  403                         char    *cb_buf;
  404                         int     cb_buf_len;
  405                 };
  406                 struct mbuf *cb_mbuf;
  407                 struct {
  408                         vm_page_t *cb_vm_page;
  409                         int cb_vm_page_len;
  410                         int cb_vm_page_offset;
  411                 };
  412                 struct uio *cb_uio;
  413         };
  414         enum crypto_buffer_type cb_type;
  415 };
  416 
  417 /*
  418  * A cursor is used to iterate through a crypto request data buffer.
  419  */
  420 struct crypto_buffer_cursor {
  421         union {
  422                 char *cc_buf;
  423                 struct mbuf *cc_mbuf;
  424                 struct iovec *cc_iov;
  425                 vm_page_t *cc_vmpage;
  426         };
  427         /* Optional bytes of valid data remaining */
  428         int cc_buf_len;
  429         /* 
  430          * Optional offset within the current buffer segment where
  431          * valid data begins
  432          */
  433         size_t cc_offset;
  434         enum crypto_buffer_type cc_type;
  435 };
  436 
  437 /* Structure describing complete operation */
  438 struct cryptop {
  439         TAILQ_ENTRY(cryptop) crp_next;
  440 
  441         struct task     crp_task;
  442 
  443         crypto_session_t crp_session;   /* Session */
  444         int             crp_olen;       /* Result total length */
  445 
  446         int             crp_etype;      /*
  447                                          * Error type (zero means no error).
  448                                          * All error codes except EAGAIN
  449                                          * indicate possible data corruption (as in,
  450                                          * the data have been touched). On all
  451                                          * errors, the crp_session may have changed
  452                                          * (reset to a new one), so the caller
  453                                          * should always check and use the new
  454                                          * value on future requests.
  455                                          */
  456         int             crp_flags;
  457 
  458 #define CRYPTO_F_BATCH          0x0008  /* Batch op if possible */
  459 #define CRYPTO_F_CBIMM          0x0010  /* Do callback immediately */
  460 #define CRYPTO_F_DONE           0x0020  /* Operation completed */
  461 #define CRYPTO_F_CBIFSYNC       0x0040  /* Do CBIMM if op is synchronous */
  462 #define CRYPTO_F_ASYNC          0x0080  /* Dispatch crypto jobs on several threads
  463                                          * if op is synchronous
  464                                          */
  465 #define CRYPTO_F_ASYNC_KEEPORDER        0x0100  /*
  466                                          * Dispatch the crypto jobs in the same
  467                                          * order there are submitted. Applied only
  468                                          * if CRYPTO_F_ASYNC flags is set
  469                                          */
  470 #define CRYPTO_F_IV_SEPARATE    0x0200  /* Use crp_iv[] as IV. */
  471 
  472         int             crp_op;
  473 
  474         struct crypto_buffer crp_buf;
  475         struct crypto_buffer crp_obuf;
  476 
  477         void            *crp_aad;       /* AAD buffer. */
  478         int             crp_aad_start;  /* Location of AAD. */
  479         int             crp_aad_length; /* 0 => no AAD. */
  480         uint8_t         crp_esn[4];     /* high-order ESN */
  481 
  482         int             crp_iv_start;   /* Location of IV.  IV length is from
  483                                          * the session.
  484                                          */
  485         int             crp_payload_start; /* Location of ciphertext. */
  486         int             crp_payload_output_start;
  487         int             crp_payload_length;
  488         int             crp_digest_start; /* Location of MAC/tag.  Length is
  489                                            * from the session.
  490                                            */
  491 
  492         uint8_t         crp_iv[EALG_MAX_BLOCK_LEN]; /* IV if IV_SEPARATE. */
  493 
  494         const void      *crp_cipher_key; /* New cipher key if non-NULL. */
  495         const void      *crp_auth_key;  /* New auth key if non-NULL. */
  496 
  497         void            *crp_opaque;    /* Opaque pointer, passed along */
  498 
  499         int (*crp_callback)(struct cryptop *); /* Callback function */
  500 
  501         struct bintime  crp_tstamp;     /* performance time stamp */
  502         uint32_t        crp_seq;        /* used for ordered dispatch */
  503         uint32_t        crp_retw_id;    /*
  504                                          * the return worker to be used,
  505                                          *  used for ordered dispatch
  506                                          */
  507 };
  508 
  509 static __inline void
  510 _crypto_use_buf(struct crypto_buffer *cb, void *buf, int len)
  511 {
  512         cb->cb_buf = buf;
  513         cb->cb_buf_len = len;
  514         cb->cb_type = CRYPTO_BUF_CONTIG;
  515 }
  516 
  517 static __inline void
  518 _crypto_use_mbuf(struct crypto_buffer *cb, struct mbuf *m)
  519 {
  520         cb->cb_mbuf = m;
  521         cb->cb_type = CRYPTO_BUF_MBUF;
  522 }
  523 
  524 static __inline void
  525 _crypto_use_vmpage(struct crypto_buffer *cb, vm_page_t *pages, int len,
  526     int offset)
  527 {
  528         cb->cb_vm_page = pages;
  529         cb->cb_vm_page_len = len;
  530         cb->cb_vm_page_offset = offset;
  531         cb->cb_type = CRYPTO_BUF_VMPAGE;
  532 }
  533 
  534 static __inline void
  535 _crypto_use_uio(struct crypto_buffer *cb, struct uio *uio)
  536 {
  537         cb->cb_uio = uio;
  538         cb->cb_type = CRYPTO_BUF_UIO;
  539 }
  540 
  541 static __inline void
  542 crypto_use_buf(struct cryptop *crp, void *buf, int len)
  543 {
  544         _crypto_use_buf(&crp->crp_buf, buf, len);
  545 }
  546 
  547 static __inline void
  548 crypto_use_mbuf(struct cryptop *crp, struct mbuf *m)
  549 {
  550         _crypto_use_mbuf(&crp->crp_buf, m);
  551 }
  552 
  553 static __inline void
  554 crypto_use_vmpage(struct cryptop *crp, vm_page_t *pages, int len, int offset)
  555 {
  556         _crypto_use_vmpage(&crp->crp_buf, pages, len, offset);
  557 }
  558 
  559 static __inline void
  560 crypto_use_uio(struct cryptop *crp, struct uio *uio)
  561 {
  562         _crypto_use_uio(&crp->crp_buf, uio);
  563 }
  564 
  565 static __inline void
  566 crypto_use_output_buf(struct cryptop *crp, void *buf, int len)
  567 {
  568         _crypto_use_buf(&crp->crp_obuf, buf, len);
  569 }
  570 
  571 static __inline void
  572 crypto_use_output_mbuf(struct cryptop *crp, struct mbuf *m)
  573 {
  574         _crypto_use_mbuf(&crp->crp_obuf, m);
  575 }
  576 
  577 static __inline void
  578 crypto_use_output_vmpage(struct cryptop *crp, vm_page_t *pages, int len,
  579     int offset)
  580 {
  581         _crypto_use_vmpage(&crp->crp_obuf, pages, len, offset);
  582 }
  583 
  584 static __inline void
  585 crypto_use_output_uio(struct cryptop *crp, struct uio *uio)
  586 {
  587         _crypto_use_uio(&crp->crp_obuf, uio);
  588 }
  589 
  590 #define CRYPTOP_ASYNC(crp)                      \
  591         (((crp)->crp_flags & CRYPTO_F_ASYNC) && \
  592         crypto_ses2caps((crp)->crp_session) & CRYPTOCAP_F_SYNC)
  593 #define CRYPTOP_ASYNC_KEEPORDER(crp) \
  594         (CRYPTOP_ASYNC(crp) && \
  595         (crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER)
  596 #define CRYPTO_HAS_OUTPUT_BUFFER(crp)                                   \
  597         ((crp)->crp_obuf.cb_type != CRYPTO_BUF_NONE)
  598 
  599 /* Flags in crp_op. */
  600 #define CRYPTO_OP_DECRYPT               0x0
  601 #define CRYPTO_OP_ENCRYPT               0x1
  602 #define CRYPTO_OP_IS_ENCRYPT(op)        ((op) & CRYPTO_OP_ENCRYPT)
  603 #define CRYPTO_OP_COMPUTE_DIGEST        0x0
  604 #define CRYPTO_OP_VERIFY_DIGEST         0x2
  605 #define CRYPTO_OP_DECOMPRESS            CRYPTO_OP_DECRYPT
  606 #define CRYPTO_OP_COMPRESS              CRYPTO_OP_ENCRYPT
  607 #define CRYPTO_OP_IS_COMPRESS(op)       ((op) & CRYPTO_OP_COMPRESS)
  608 
  609 /*
  610  * Hints passed to process methods.
  611  */
  612 #define CRYPTO_HINT_MORE        0x1     /* more ops coming shortly */
  613 
  614 struct cryptkop {
  615         TAILQ_ENTRY(cryptkop) krp_next;
  616 
  617         u_int           krp_op;         /* ie. CRK_MOD_EXP or other */
  618         u_int           krp_status;     /* return status */
  619         u_short         krp_iparams;    /* # of input parameters */
  620         u_short         krp_oparams;    /* # of output parameters */
  621         u_int           krp_crid;       /* desired device, etc. */
  622         uint32_t        krp_hid;        /* device used */
  623         struct crparam  krp_param[CRK_MAXPARAM];        /* kvm */
  624         void            (*krp_callback)(struct cryptkop *);
  625         struct cryptocap *krp_cap;
  626 };
  627 
  628 uint32_t crypto_ses2hid(crypto_session_t crypto_session);
  629 uint32_t crypto_ses2caps(crypto_session_t crypto_session);
  630 void *crypto_get_driver_session(crypto_session_t crypto_session);
  631 const struct crypto_session_params *crypto_get_params(
  632     crypto_session_t crypto_session);
  633 struct auth_hash *crypto_auth_hash(const struct crypto_session_params *csp);
  634 struct enc_xform *crypto_cipher(const struct crypto_session_params *csp);
  635 
  636 MALLOC_DECLARE(M_CRYPTO_DATA);
  637 
  638 extern  int crypto_newsession(crypto_session_t *cses,
  639     const struct crypto_session_params *params, int hard);
  640 extern  void crypto_freesession(crypto_session_t cses);
  641 #define CRYPTOCAP_F_HARDWARE    CRYPTO_FLAG_HARDWARE
  642 #define CRYPTOCAP_F_SOFTWARE    CRYPTO_FLAG_SOFTWARE
  643 #define CRYPTOCAP_F_SYNC        0x04000000      /* operates synchronously */
  644 #define CRYPTOCAP_F_ACCEL_SOFTWARE 0x08000000
  645 extern  int32_t crypto_get_driverid(device_t dev, size_t session_size,
  646     int flags);
  647 extern  int crypto_find_driver(const char *);
  648 extern  device_t crypto_find_device_byhid(int hid);
  649 extern  int crypto_getcaps(int hid);
  650 extern  int crypto_kregister(uint32_t, int, uint32_t);
  651 extern  int crypto_unregister_all(uint32_t driverid);
  652 extern  int crypto_dispatch(struct cryptop *crp);
  653 extern  int crypto_kdispatch(struct cryptkop *);
  654 #define CRYPTO_SYMQ     0x1
  655 #define CRYPTO_ASYMQ    0x2
  656 extern  int crypto_unblock(uint32_t, int);
  657 extern  void crypto_done(struct cryptop *crp);
  658 extern  void crypto_kdone(struct cryptkop *);
  659 extern  int crypto_getfeat(int *);
  660 
  661 extern  void crypto_destroyreq(struct cryptop *crp);
  662 extern  void crypto_initreq(struct cryptop *crp, crypto_session_t cses);
  663 extern  void crypto_freereq(struct cryptop *crp);
  664 extern  struct cryptop *crypto_getreq(crypto_session_t cses, int how);
  665 
  666 extern  int crypto_usercrypto;          /* userland may do crypto requests */
  667 extern  int crypto_userasymcrypto;      /* userland may do asym crypto reqs */
  668 extern  int crypto_devallowsoft;        /* only use hardware crypto */
  669 
  670 #ifdef SYSCTL_DECL
  671 SYSCTL_DECL(_kern_crypto);
  672 #endif
  673 
  674 /* Helper routines for drivers to initialize auth contexts for HMAC. */
  675 struct auth_hash;
  676 
  677 void    hmac_init_ipad(const struct auth_hash *axf, const char *key, int klen,
  678     void *auth_ctx);
  679 void    hmac_init_opad(const struct auth_hash *axf, const char *key, int klen,
  680     void *auth_ctx);
  681 
  682 /*
  683  * Crypto-related utility routines used mainly by drivers.
  684  *
  685  * Similar to m_copyback/data, *_copyback copy data from the 'src'
  686  * buffer into the crypto request's data buffer while *_copydata copy
  687  * data from the crypto request's data buffer into the the 'dst'
  688  * buffer.
  689  */
  690 void    crypto_copyback(struct cryptop *crp, int off, int size,
  691             const void *src);
  692 void    crypto_copydata(struct cryptop *crp, int off, int size, void *dst);
  693 int     crypto_apply(struct cryptop *crp, int off, int len,
  694             int (*f)(void *, const void *, u_int), void *arg);
  695 void    *crypto_contiguous_subsegment(struct cryptop *crp, size_t skip,
  696             size_t len);
  697 
  698 int     crypto_apply_buf(struct crypto_buffer *cb, int off, int len,
  699             int (*f)(void *, const void *, u_int), void *arg);
  700 void    *crypto_buffer_contiguous_subsegment(struct crypto_buffer *cb,
  701             size_t skip, size_t len);
  702 size_t  crypto_buffer_len(struct crypto_buffer *cb);
  703 void    crypto_cursor_init(struct crypto_buffer_cursor *cc,
  704             const struct crypto_buffer *cb);
  705 void    crypto_cursor_advance(struct crypto_buffer_cursor *cc, size_t amount);
  706 void    *crypto_cursor_segbase(struct crypto_buffer_cursor *cc);
  707 size_t  crypto_cursor_seglen(struct crypto_buffer_cursor *cc);
  708 void    crypto_cursor_copyback(struct crypto_buffer_cursor *cc, int size,
  709             const void *vsrc);
  710 void    crypto_cursor_copydata(struct crypto_buffer_cursor *cc, int size,
  711             void *vdst);
  712 void    crypto_cursor_copydata_noadv(struct crypto_buffer_cursor *cc, int size,
  713             void *vdst);
  714 
  715 static __inline void
  716 crypto_read_iv(struct cryptop *crp, void *iv)
  717 {
  718         const struct crypto_session_params *csp;
  719 
  720         csp = crypto_get_params(crp->crp_session);
  721         if (crp->crp_flags & CRYPTO_F_IV_SEPARATE)
  722                 memcpy(iv, crp->crp_iv, csp->csp_ivlen);
  723         else
  724                 crypto_copydata(crp, crp->crp_iv_start, csp->csp_ivlen, iv);
  725 }
  726 
  727 #endif /* _KERNEL */
  728 #endif /* _CRYPTO_CRYPTO_H_ */

Cache object: c2685bb405136f32de6483ac01037111


[ 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.