sys/opencrypto/cryptodev.h

   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  *
   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;          /* always 0 */
 126         u_int           len;
 127         caddr_t         src, dst;       /* become iov[] inside kernel */
 128         caddr_t         mac;            /* must be big enough for chosen MAC */
 129         caddr_t         iv;
 130 };
 131
 132 #define CRYPTO_MAX_MAC_LEN      20
 133
 134 /* bignum parameter, in packed bytes, ... */
 135 struct crparam {
 136         caddr_t         crp_p;
 137         u_int           crp_nbits;
 138 };
 139
 140 #define CRK_MAXPARAM    8
 141
 142 struct crypt_kop {
 143         u_int           crk_op;         /* ie. CRK_MOD_EXP or other */
 144         u_int           crk_status;     /* return status */
 145         u_short         crk_iparams;    /* # of input parameters */
 146         u_short         crk_oparams;    /* # of output parameters */
 147         u_int           crk_pad1;
 148         struct crparam  crk_param[CRK_MAXPARAM];
 149 };
 150 #define CRK_ALGORITM_MIN        0
 151 #define CRK_MOD_EXP             0
 152 #define CRK_MOD_EXP_CRT         1
 153 #define CRK_DSA_SIGN            2
 154 #define CRK_DSA_VERIFY          3
 155 #define CRK_DH_COMPUTE_KEY      4
 156 #define CRK_ALGORITHM_MAX       4 /* Keep updated - see below */
 157
 158 #define CRF_MOD_EXP             (1 << CRK_MOD_EXP)
 159 #define CRF_MOD_EXP_CRT         (1 << CRK_MOD_EXP_CRT)
 160 #define CRF_DSA_SIGN            (1 << CRK_DSA_SIGN)
 161 #define CRF_DSA_VERIFY          (1 << CRK_DSA_VERIFY)
 162 #define CRF_DH_COMPUTE_KEY      (1 << CRK_DH_COMPUTE_KEY)
 163
 164 /*
 165  * done against open of /dev/crypto, to get a cloned descriptor.
 166  * Please use F_SETFD against the cloned descriptor.
 167  */
 168 #define CRIOGET         _IOWR('c', 100, u_int32_t)
 169
 170 /* the following are done against the cloned descriptor */
 171 #define CIOCGSESSION    _IOWR('c', 101, struct session_op)
 172 #define CIOCFSESSION    _IOW('c', 102, u_int32_t)
 173 #define CIOCCRYPT       _IOWR('c', 103, struct crypt_op)
 174 #define CIOCKEY         _IOWR('c', 104, struct crypt_kop)
 175
 176 #define CIOCASYMFEAT    _IOR('c', 105, u_int32_t)
 177
 178 #ifdef _KERNEL
 179 /* Standard initialization structure beginning */
 180 struct cryptoini {
 181         int             cri_alg;        /* Algorithm to use */
 182         int             cri_klen;       /* Key length, in bits */
 183         int             cri_rnd;        /* Algorithm rounds, where relevant */
 184         caddr_t         cri_key;        /* key to use */
 185         u_int8_t        cri_iv[EALG_MAX_BLOCK_LEN];     /* IV to use */
 186         struct cryptoini *cri_next;
 187 };
 188
 189 /* Describe boundaries of a single crypto operation */
 190 struct cryptodesc {
 191         int             crd_skip;       /* How many bytes to ignore from start */
 192         int             crd_len;        /* How many bytes to process */
 193         int             crd_inject;     /* Where to inject results, if applicable */
 194         int             crd_flags;
 195
 196 #define CRD_F_ENCRYPT           0x01    /* Set when doing encryption */
 197 #define CRD_F_IV_PRESENT        0x02    /* When encrypting, IV is already in
 198                                            place, so don't copy. */
 199 #define CRD_F_IV_EXPLICIT       0x04    /* IV explicitly provided */
 200 #define CRD_F_DSA_SHA_NEEDED    0x08    /* Compute SHA-1 of buffer for DSA */
 201 #define CRD_F_COMP              0x0f    /* Set when doing compression */
 202
 203         struct cryptoini        CRD_INI; /* Initialization/context data */
 204 #define crd_iv          CRD_INI.cri_iv
 205 #define crd_key         CRD_INI.cri_key
 206 #define crd_rnd         CRD_INI.cri_rnd
 207 #define crd_alg         CRD_INI.cri_alg
 208 #define crd_klen        CRD_INI.cri_klen
 209
 210         struct cryptodesc *crd_next;
 211 };
 212
 213 /* Structure describing complete operation */
 214 struct cryptop {
 215         TAILQ_ENTRY(cryptop) crp_next;
 216
 217         u_int64_t       crp_sid;        /* Session ID */
 218         int             crp_ilen;       /* Input data total length */
 219         int             crp_olen;       /* Result total length */
 220         int             crp_alloctype;  /* Type of buf to allocate if needed */
 221
 222         int             crp_etype;      /*
 223                                          * Error type (zero means no error).
 224                                          * All error codes except EAGAIN
 225                                          * indicate possible data corruption (as in,
 226                                          * the data have been touched). On all
 227                                          * errors, the crp_sid may have changed
 228                                          * (reset to a new one), so the caller
 229                                          * should always check and use the new
 230                                          * value on future requests.
 231                                          */
 232         int             crp_flags;
 233
 234 #define CRYPTO_F_IMBUF  0x0001  /* Input/output are mbuf chains, otherwise contig */
 235 #define CRYPTO_F_IOV    0x0002  /* Input/output are uio */
 236 #define CRYPTO_F_REL    0x0004  /* Must return data in same place */
 237 #define CRYPTO_F_NODELAY 0x0008 /* Dispatch as quickly as possible */
 238
 239         caddr_t         crp_buf;        /* Data to be processed */
 240         caddr_t         crp_opaque;     /* Opaque pointer, passed along */
 241         struct cryptodesc *crp_desc;    /* Linked list of processing descriptors */
 242
 243         int (*crp_callback)(struct cryptop *); /* Callback function */
 244
 245         caddr_t         crp_mac;
 246 };
 247
 248 #define CRYPTO_BUF_CONTIG       0x0
 249 #define CRYPTO_BUF_IOV          0x1
 250 #define CRYPTO_BUF_MBUF         0x2
 251
 252 #define CRYPTO_OP_DECRYPT       0x0
 253 #define CRYPTO_OP_ENCRYPT       0x1
 254
 255 /*
 256  * Hints passed to process methods.
 257  */
 258 #define CRYPTO_HINT_MORE        0x1     /* more ops coming shortly */
 259
 260 struct cryptkop {
 261         TAILQ_ENTRY(cryptkop) krp_next;
 262
 263         u_int           krp_op;         /* ie. CRK_MOD_EXP or other */
 264         u_int           krp_status;     /* return status */
 265         u_short         krp_iparams;    /* # of input parameters */
 266         u_short         krp_oparams;    /* # of output parameters */
 267         u_int32_t       krp_hid;
 268         struct crparam  krp_param[CRK_MAXPARAM];        /* kvm */
 269         int             (*krp_callback)(struct cryptkop *);
 270 };
 271
 272 /* Crypto capabilities structure */
 273 struct cryptocap {
 274         u_int32_t       cc_sessions;
 275
 276         /*
 277          * Largest possible operator length (in bits) for each type of
 278          * encryption algorithm.
 279          */
 280         u_int16_t       cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1];
 281
 282         u_int8_t        cc_alg[CRYPTO_ALGORITHM_MAX + 1];
 283
 284         u_int8_t        cc_kalg[CRK_ALGORITHM_MAX + 1];
 285
 286         u_int8_t        cc_flags;
 287         u_int8_t        cc_qblocked;            /* symmetric q blocked */
 288         u_int8_t        cc_kqblocked;           /* asymmetric q blocked */
 289 #define CRYPTOCAP_F_CLEANUP   0x1
 290 #define CRYPTOCAP_F_SOFTWARE  0x02
 291
 292         void            *cc_arg;                /* callback argument */
 293         int             (*cc_newsession)(void*, u_int32_t*, struct cryptoini*);
 294         int             (*cc_process)(void*, struct cryptop *, int);
 295         int             (*cc_freesession)(void*, u_int64_t);
 296         void            *cc_karg;               /* callback argument */
 297         int             (*cc_kprocess) (void*, struct cryptkop *, int);
 298 };
 299
 300 MALLOC_DECLARE(M_CRYPTO_DATA);
 301
 302 extern  int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard);
 303 extern  int crypto_freesession(u_int64_t sid);
 304 extern  int32_t crypto_get_driverid(u_int32_t flags);
 305 extern  int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
 306             u_int32_t flags,
 307             int (*newses)(void*, u_int32_t*, struct cryptoini*),
 308             int (*freeses)(void*, u_int64_t),
 309             int (*process)(void*, struct cryptop *, int),
 310             void *arg);
 311 extern  int crypto_kregister(u_int32_t, int, u_int32_t,
 312             int (*)(void*, struct cryptkop *, int),
 313             void *arg);
 314 extern  int crypto_unregister(u_int32_t driverid, int alg);
 315 extern  int crypto_unregister_all(u_int32_t driverid);
 316 extern  int crypto_dispatch(struct cryptop *crp);
 317 extern  int crypto_kdispatch(struct cryptkop *);
 318 #define CRYPTO_SYMQ     0x1
 319 #define CRYPTO_ASYMQ    0x2
 320 extern  int crypto_unblock(u_int32_t, int);
 321 extern  void crypto_done(struct cryptop *crp);
 322 extern  void crypto_kdone(struct cryptkop *);
 323 extern  int crypto_getfeat(int *);
 324
 325 extern  void crypto_freereq(struct cryptop *crp);
 326 extern  struct cryptop *crypto_getreq(int num);
 327
 328 extern  int crypto_usercrypto;          /* userland may do crypto requests */
 329 extern  int crypto_userasymcrypto;      /* userland may do asym crypto reqs */
 330 extern  int crypto_devallowsoft;        /* only use hardware crypto */
 331
 332 /*
 333  * Crypto-related utility routines used mainly by drivers.
 334  *
 335  * XXX these don't really belong here; but for now they're
 336  *     kept apart from the rest of the system.
 337  */
 338 struct mbuf;
 339 struct  mbuf    *m_getptr(struct mbuf *, int, int *);
 340
 341 struct uio;
 342 extern  void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
 343 extern  void cuio_copyback(struct uio* uio, int off, int len, caddr_t cp);
 344 extern  struct iovec *cuio_getptr(struct uio *uio, int loc, int *off);
 345 #endif /* _KERNEL */
 346 #endif /* _CRYPTO_CRYPTO_H_ */