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  -  FREEBSD11  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  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 /*      $FreeBSD: src/sys/opencrypto/cryptodev.h,v 1.9 2004/02/02 17:06:34 phk Exp $    */
    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  *
    7  * This code was written by Angelos D. Keromytis in Athens, Greece, in
    8  * February 2000. Network Security Technologies Inc. (NSTI) kindly
    9  * supported the development of this code.
   10  *
   11  * Copyright (c) 2000 Angelos D. Keromytis
   12  *
   13  * Permission to use, copy, and modify this software with or without fee
   14  * is hereby granted, provided that this entire notice is included in
   15  * all source code copies of any software which is or includes a copy or
   16  * modification of this software.
   17  *
   18  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
   19  * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
   20  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
   21  * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
   22  * PURPOSE.
   23  *
   24  * Copyright (c) 2001 Theo de Raadt
   25  *
   26  * Redistribution and use in source and binary forms, with or without
   27  * modification, are permitted provided that the following conditions
   28  * are met:
   29  *
   30  * 1. Redistributions of source code must retain the above copyright
   31  *   notice, this list of conditions and the following disclaimer.
   32  * 2. Redistributions in binary form must reproduce the above copyright
   33  *   notice, this list of conditions and the following disclaimer in the
   34  *   documentation and/or other materials provided with the distribution.
   35  * 3. The name of the author may not be used to endorse or promote products
   36  *   derived from this software without specific prior written permission.
   37  *
   38  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   39  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   40  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   41  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   42  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   43  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   44  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   45  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   47  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   48  *
   49  * Effort sponsored in part by the Defense Advanced Research Projects
   50  * Agency (DARPA) and Air Force Research Laboratory, Air Force
   51  * Materiel Command, USAF, under agreement number F30602-01-2-0537.
   52  *
   53  */
   54 
   55 #ifndef _CRYPTO_CRYPTO_H_
   56 #define _CRYPTO_CRYPTO_H_
   57 
   58 #include <sys/ioccom.h>
   59 
   60 /* Some initial values */
   61 #define CRYPTO_DRIVERS_INITIAL  4
   62 #define CRYPTO_SW_SESSIONS      32
   63 
   64 /* HMAC values */
   65 #define HMAC_BLOCK_LEN          64
   66 #define HMAC_IPAD_VAL           0x36
   67 #define HMAC_OPAD_VAL           0x5C
   68 
   69 /* Encryption algorithm block sizes */
   70 #define DES_BLOCK_LEN           8
   71 #define DES3_BLOCK_LEN          8
   72 #define BLOWFISH_BLOCK_LEN      8
   73 #define SKIPJACK_BLOCK_LEN      8
   74 #define CAST128_BLOCK_LEN       8
   75 #define RIJNDAEL128_BLOCK_LEN   16
   76 #define EALG_MAX_BLOCK_LEN      16 /* Keep this updated */
   77 
   78 /* Maximum hash algorithm result length */
   79 #define AALG_MAX_RESULT_LEN     64 /* Keep this updated */
   80 
   81 #define CRYPTO_ALGORITHM_MIN    1
   82 #define CRYPTO_DES_CBC          1
   83 #define CRYPTO_3DES_CBC         2
   84 #define CRYPTO_BLF_CBC          3
   85 #define CRYPTO_CAST_CBC         4
   86 #define CRYPTO_SKIPJACK_CBC     5
   87 #define CRYPTO_MD5_HMAC         6
   88 #define CRYPTO_SHA1_HMAC        7
   89 #define CRYPTO_RIPEMD160_HMAC   8
   90 #define CRYPTO_MD5_KPDK         9
   91 #define CRYPTO_SHA1_KPDK        10
   92 #define CRYPTO_RIJNDAEL128_CBC  11 /* 128 bit blocksize */
   93 #define CRYPTO_AES_CBC          11 /* 128 bit blocksize -- the same as above */
   94 #define CRYPTO_ARC4             12
   95 #define CRYPTO_MD5              13
   96 #define CRYPTO_SHA1             14
   97 #define CRYPTO_SHA2_HMAC        15
   98 #define CRYPTO_NULL_HMAC        16
   99 #define CRYPTO_NULL_CBC         17
  100 #define CRYPTO_DEFLATE_COMP     18 /* Deflate compression algorithm */
  101 #define CRYPTO_ALGORITHM_MAX    18 /* Keep updated - see below */
  102 
  103 /* Algorithm flags */
  104 #define CRYPTO_ALG_FLAG_SUPPORTED       0x01 /* Algorithm is supported */
  105 #define CRYPTO_ALG_FLAG_RNG_ENABLE      0x02 /* Has HW RNG for DH/DSA */
  106 #define CRYPTO_ALG_FLAG_DSA_SHA         0x04 /* Can do SHA on msg */
  107 
  108 struct session_op {
  109         u_int32_t       cipher;         /* ie. CRYPTO_DES_CBC */
  110         u_int32_t       mac;            /* ie. CRYPTO_MD5_HMAC */
  111 
  112         u_int32_t       keylen;         /* cipher key */
  113         caddr_t         key;
  114         int             mackeylen;      /* mac key */
  115         caddr_t         mackey;
  116 
  117         u_int32_t       ses;            /* returns: session # */ 
  118 };
  119 
  120 struct crypt_op {
  121         u_int32_t       ses;
  122         u_int16_t       op;             /* i.e. COP_ENCRYPT */
  123 #define COP_ENCRYPT     1
  124 #define COP_DECRYPT     2
  125         u_int16_t       flags;
  126 #define COP_F_BATCH     0x0008          /* Batch op if possible */
  127         u_int           len;
  128         caddr_t         src, dst;       /* become iov[] inside kernel */
  129         caddr_t         mac;            /* must be big enough for chosen MAC */
  130         caddr_t         iv;
  131 };
  132 
  133 #define CRYPTO_MAX_MAC_LEN      20
  134 
  135 /* bignum parameter, in packed bytes, ... */
  136 struct crparam {
  137         caddr_t         crp_p;
  138         u_int           crp_nbits;
  139 };
  140 
  141 #define CRK_MAXPARAM    8
  142 
  143 struct crypt_kop {
  144         u_int           crk_op;         /* ie. CRK_MOD_EXP or other */
  145         u_int           crk_status;     /* return status */
  146         u_short         crk_iparams;    /* # of input parameters */
  147         u_short         crk_oparams;    /* # of output parameters */
  148         u_int           crk_pad1;
  149         struct crparam  crk_param[CRK_MAXPARAM];
  150 };
  151 #define CRK_ALGORITM_MIN        0
  152 #define CRK_MOD_EXP             0
  153 #define CRK_MOD_EXP_CRT         1
  154 #define CRK_DSA_SIGN            2
  155 #define CRK_DSA_VERIFY          3
  156 #define CRK_DH_COMPUTE_KEY      4
  157 #define CRK_ALGORITHM_MAX       4 /* Keep updated - see below */
  158 
  159 #define CRF_MOD_EXP             (1 << CRK_MOD_EXP)
  160 #define CRF_MOD_EXP_CRT         (1 << CRK_MOD_EXP_CRT)
  161 #define CRF_DSA_SIGN            (1 << CRK_DSA_SIGN)
  162 #define CRF_DSA_VERIFY          (1 << CRK_DSA_VERIFY)
  163 #define CRF_DH_COMPUTE_KEY      (1 << CRK_DH_COMPUTE_KEY)
  164 
  165 /*
  166  * done against open of /dev/crypto, to get a cloned descriptor.
  167  * Please use F_SETFD against the cloned descriptor.
  168  */
  169 #define CRIOGET         _IOWR('c', 100, u_int32_t)
  170 
  171 /* the following are done against the cloned descriptor */
  172 #define CIOCGSESSION    _IOWR('c', 101, struct session_op)
  173 #define CIOCFSESSION    _IOW('c', 102, u_int32_t)
  174 #define CIOCCRYPT       _IOWR('c', 103, struct crypt_op)
  175 #define CIOCKEY         _IOWR('c', 104, struct crypt_kop)
  176 
  177 #define CIOCASYMFEAT    _IOR('c', 105, u_int32_t)
  178 
  179 struct cryptotstat {
  180         struct timespec acc;            /* total accumulated time */
  181         struct timespec min;            /* min time */
  182         struct timespec max;            /* max time */
  183         u_int32_t       count;          /* number of observations */
  184 };
  185 
  186 struct cryptostats {
  187         u_int32_t       cs_ops;         /* symmetric crypto ops submitted */
  188         u_int32_t       cs_errs;        /* symmetric crypto ops that failed */
  189         u_int32_t       cs_kops;        /* asymetric/key ops submitted */
  190         u_int32_t       cs_kerrs;       /* asymetric/key ops that failed */
  191         u_int32_t       cs_intrs;       /* crypto swi thread activations */
  192         u_int32_t       cs_rets;        /* crypto return thread activations */
  193         u_int32_t       cs_blocks;      /* symmetric op driver block */
  194         u_int32_t       cs_kblocks;     /* symmetric op driver block */
  195         /*
  196          * When CRYPTO_TIMING is defined at compile time and the
  197          * sysctl debug.crypto is set to 1, the crypto system will
  198          * accumulate statistics about how long it takes to process
  199          * crypto requests at various points during processing.
  200          */
  201         struct cryptotstat cs_invoke;   /* crypto_dipsatch -> crypto_invoke */
  202         struct cryptotstat cs_done;     /* crypto_invoke -> crypto_done */
  203         struct cryptotstat cs_cb;       /* crypto_done -> callback */
  204         struct cryptotstat cs_finis;    /* callback -> callback return */
  205 };
  206 
  207 #ifdef _KERNEL
  208 /* Standard initialization structure beginning */
  209 struct cryptoini {
  210         int             cri_alg;        /* Algorithm to use */
  211         int             cri_klen;       /* Key length, in bits */
  212         int             cri_rnd;        /* Algorithm rounds, where relevant */
  213         caddr_t         cri_key;        /* key to use */
  214         u_int8_t        cri_iv[EALG_MAX_BLOCK_LEN];     /* IV to use */
  215         struct cryptoini *cri_next;
  216 };
  217 
  218 /* Describe boundaries of a single crypto operation */
  219 struct cryptodesc {
  220         int             crd_skip;       /* How many bytes to ignore from start */
  221         int             crd_len;        /* How many bytes to process */
  222         int             crd_inject;     /* Where to inject results, if applicable */
  223         int             crd_flags;
  224 
  225 #define CRD_F_ENCRYPT           0x01    /* Set when doing encryption */
  226 #define CRD_F_IV_PRESENT        0x02    /* When encrypting, IV is already in
  227                                            place, so don't copy. */
  228 #define CRD_F_IV_EXPLICIT       0x04    /* IV explicitly provided */
  229 #define CRD_F_DSA_SHA_NEEDED    0x08    /* Compute SHA-1 of buffer for DSA */
  230 #define CRD_F_KEY_EXPLICIT      0x10    /* Key explicitly provided */
  231 #define CRD_F_COMP              0x0f    /* Set when doing compression */
  232 
  233         struct cryptoini        CRD_INI; /* Initialization/context data */
  234 #define crd_iv          CRD_INI.cri_iv
  235 #define crd_key         CRD_INI.cri_key
  236 #define crd_rnd         CRD_INI.cri_rnd
  237 #define crd_alg         CRD_INI.cri_alg
  238 #define crd_klen        CRD_INI.cri_klen
  239 
  240         struct cryptodesc *crd_next;
  241 };
  242 
  243 /* Structure describing complete operation */
  244 struct cryptop {
  245         TAILQ_ENTRY(cryptop) crp_next;
  246 
  247         u_int64_t       crp_sid;        /* Session ID */
  248         int             crp_ilen;       /* Input data total length */
  249         int             crp_olen;       /* Result total length */
  250 
  251         int             crp_etype;      /*
  252                                          * Error type (zero means no error).
  253                                          * All error codes except EAGAIN
  254                                          * indicate possible data corruption (as in,
  255                                          * the data have been touched). On all
  256                                          * errors, the crp_sid may have changed
  257                                          * (reset to a new one), so the caller
  258                                          * should always check and use the new
  259                                          * value on future requests.
  260                                          */
  261         int             crp_flags;
  262 
  263 #define CRYPTO_F_IMBUF          0x0001  /* Input/output are mbuf chains */
  264 #define CRYPTO_F_IOV            0x0002  /* Input/output are uio */
  265 #define CRYPTO_F_REL            0x0004  /* Must return data in same place */
  266 #define CRYPTO_F_BATCH          0x0008  /* Batch op if possible */
  267 #define CRYPTO_F_CBIMM          0x0010  /* Do callback immediately */
  268 #define CRYPTO_F_DONE           0x0020  /* Operation completed */
  269 #define CRYPTO_F_CBIFSYNC       0x0040  /* Do CBIMM if op is synchronous */
  270 
  271         caddr_t         crp_buf;        /* Data to be processed */
  272         caddr_t         crp_opaque;     /* Opaque pointer, passed along */
  273         struct cryptodesc *crp_desc;    /* Linked list of processing descriptors */
  274 
  275         int (*crp_callback)(struct cryptop *); /* Callback function */
  276 
  277         caddr_t         crp_mac;
  278         struct bintime  crp_tstamp;     /* performance time stamp */
  279 };
  280 
  281 #define CRYPTO_BUF_CONTIG       0x0
  282 #define CRYPTO_BUF_IOV          0x1
  283 #define CRYPTO_BUF_MBUF         0x2
  284 
  285 #define CRYPTO_OP_DECRYPT       0x0
  286 #define CRYPTO_OP_ENCRYPT       0x1
  287 
  288 /*
  289  * Hints passed to process methods.
  290  */
  291 #define CRYPTO_HINT_MORE        0x1     /* more ops coming shortly */
  292 
  293 struct cryptkop {
  294         TAILQ_ENTRY(cryptkop) krp_next;
  295 
  296         u_int           krp_op;         /* ie. CRK_MOD_EXP or other */
  297         u_int           krp_status;     /* return status */
  298         u_short         krp_iparams;    /* # of input parameters */
  299         u_short         krp_oparams;    /* # of output parameters */
  300         u_int32_t       krp_hid;
  301         struct crparam  krp_param[CRK_MAXPARAM];        /* kvm */
  302         int             (*krp_callback)(struct cryptkop *);
  303 };
  304 
  305 /* Crypto capabilities structure */
  306 struct cryptocap {
  307         u_int32_t       cc_sessions;
  308 
  309         /*
  310          * Largest possible operator length (in bits) for each type of
  311          * encryption algorithm.
  312          */
  313         u_int16_t       cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1];
  314 
  315         u_int8_t        cc_alg[CRYPTO_ALGORITHM_MAX + 1];
  316 
  317         u_int8_t        cc_kalg[CRK_ALGORITHM_MAX + 1];
  318 
  319         u_int8_t        cc_flags;
  320         u_int8_t        cc_qblocked;            /* symmetric q blocked */
  321         u_int8_t        cc_kqblocked;           /* asymmetric q blocked */
  322 #define CRYPTOCAP_F_CLEANUP     0x01            /* needs resource cleanup */
  323 #define CRYPTOCAP_F_SOFTWARE    0x02            /* software implementation */
  324 #define CRYPTOCAP_F_SYNC        0x04            /* operates synchronously */
  325 
  326         void            *cc_arg;                /* callback argument */
  327         int             (*cc_newsession)(void*, u_int32_t*, struct cryptoini*);
  328         int             (*cc_process)(void*, struct cryptop *, int);
  329         int             (*cc_freesession)(void*, u_int64_t);
  330         void            *cc_karg;               /* callback argument */
  331         int             (*cc_kprocess) (void*, struct cryptkop *, int);
  332 };
  333 
  334 /*
  335  * Session ids are 64 bits.  The lower 32 bits contain a "local id" which
  336  * is a driver-private session identifier.  The upper 32 bits contain a
  337  * "hardware id" used by the core crypto code to identify the driver and
  338  * a copy of the driver's capabilities that can be used by client code to
  339  * optimize operation.
  340  */
  341 #define CRYPTO_SESID2HID(_sid)  (((_sid) >> 32) & 0xffffff)
  342 #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 56) & 0xff)
  343 #define CRYPTO_SESID2LID(_sid)  (((u_int32_t) (_sid)) & 0xffffffff)
  344 
  345 MALLOC_DECLARE(M_CRYPTO_DATA);
  346 
  347 extern  int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard);
  348 extern  int crypto_freesession(u_int64_t sid);
  349 extern  int32_t crypto_get_driverid(u_int32_t flags);
  350 extern  int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
  351             u_int32_t flags,
  352             int (*newses)(void*, u_int32_t*, struct cryptoini*),
  353             int (*freeses)(void*, u_int64_t),
  354             int (*process)(void*, struct cryptop *, int),
  355             void *arg);
  356 extern  int crypto_kregister(u_int32_t, int, u_int32_t,
  357             int (*)(void*, struct cryptkop *, int),
  358             void *arg);
  359 extern  int crypto_unregister(u_int32_t driverid, int alg);
  360 extern  int crypto_unregister_all(u_int32_t driverid);
  361 extern  int crypto_dispatch(struct cryptop *crp);
  362 extern  int crypto_kdispatch(struct cryptkop *);
  363 #define CRYPTO_SYMQ     0x1
  364 #define CRYPTO_ASYMQ    0x2
  365 extern  int crypto_unblock(u_int32_t, int);
  366 extern  void crypto_done(struct cryptop *crp);
  367 extern  void crypto_kdone(struct cryptkop *);
  368 extern  int crypto_getfeat(int *);
  369 
  370 extern  void crypto_freereq(struct cryptop *crp);
  371 extern  struct cryptop *crypto_getreq(int num);
  372 
  373 extern  int crypto_usercrypto;          /* userland may do crypto requests */
  374 extern  int crypto_userasymcrypto;      /* userland may do asym crypto reqs */
  375 extern  int crypto_devallowsoft;        /* only use hardware crypto */
  376 
  377 /*
  378  * Crypto-related utility routines used mainly by drivers.
  379  *
  380  * XXX these don't really belong here; but for now they're
  381  *     kept apart from the rest of the system.
  382  */
  383 struct uio;
  384 extern  void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
  385 extern  void cuio_copyback(struct uio* uio, int off, int len, caddr_t cp);
  386 extern  struct iovec *cuio_getptr(struct uio *uio, int loc, int *off);
  387 #endif /* _KERNEL */
  388 #endif /* _CRYPTO_CRYPTO_H_ */

Cache object: 6a5cc172615ff65e3248fd7de2d15030


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