1091d81d1SSam Leffler /* $FreeBSD$ */ 2091d81d1SSam Leffler /* $OpenBSD: cryptodev.h,v 1.31 2002/06/11 11:14:29 beck Exp $ */ 3091d81d1SSam Leffler 460727d8bSWarner Losh /*- 5091d81d1SSam Leffler * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) 66810ad6fSSam Leffler * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting 7091d81d1SSam Leffler * 8091d81d1SSam Leffler * This code was written by Angelos D. Keromytis in Athens, Greece, in 9091d81d1SSam Leffler * February 2000. Network Security Technologies Inc. (NSTI) kindly 10091d81d1SSam Leffler * supported the development of this code. 11091d81d1SSam Leffler * 12091d81d1SSam Leffler * Copyright (c) 2000 Angelos D. Keromytis 13091d81d1SSam Leffler * 14091d81d1SSam Leffler * Permission to use, copy, and modify this software with or without fee 15091d81d1SSam Leffler * is hereby granted, provided that this entire notice is included in 16091d81d1SSam Leffler * all source code copies of any software which is or includes a copy or 17091d81d1SSam Leffler * modification of this software. 18091d81d1SSam Leffler * 19091d81d1SSam Leffler * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 20091d81d1SSam Leffler * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 21091d81d1SSam Leffler * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 22091d81d1SSam Leffler * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 23091d81d1SSam Leffler * PURPOSE. 24091d81d1SSam Leffler * 25091d81d1SSam Leffler * Copyright (c) 2001 Theo de Raadt 2608fca7a5SJohn-Mark Gurney * Copyright (c) 2014 The FreeBSD Foundation 2708fca7a5SJohn-Mark Gurney * All rights reserved. 2808fca7a5SJohn-Mark Gurney * 2908fca7a5SJohn-Mark Gurney * Portions of this software were developed by John-Mark Gurney 3008fca7a5SJohn-Mark Gurney * under sponsorship of the FreeBSD Foundation and 3108fca7a5SJohn-Mark Gurney * Rubicon Communications, LLC (Netgate). 32091d81d1SSam Leffler * 33091d81d1SSam Leffler * Redistribution and use in source and binary forms, with or without 34091d81d1SSam Leffler * modification, are permitted provided that the following conditions 35091d81d1SSam Leffler * are met: 36091d81d1SSam Leffler * 37091d81d1SSam Leffler * 1. Redistributions of source code must retain the above copyright 38091d81d1SSam Leffler * notice, this list of conditions and the following disclaimer. 39091d81d1SSam Leffler * 2. Redistributions in binary form must reproduce the above copyright 40091d81d1SSam Leffler * notice, this list of conditions and the following disclaimer in the 41091d81d1SSam Leffler * documentation and/or other materials provided with the distribution. 42091d81d1SSam Leffler * 3. The name of the author may not be used to endorse or promote products 43091d81d1SSam Leffler * derived from this software without specific prior written permission. 44091d81d1SSam Leffler * 45091d81d1SSam Leffler * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 46091d81d1SSam Leffler * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 47091d81d1SSam Leffler * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 48091d81d1SSam Leffler * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 49091d81d1SSam Leffler * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 50091d81d1SSam Leffler * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 51091d81d1SSam Leffler * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 52091d81d1SSam Leffler * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 53091d81d1SSam Leffler * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 54091d81d1SSam Leffler * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 55091d81d1SSam Leffler * 56091d81d1SSam Leffler * Effort sponsored in part by the Defense Advanced Research Projects 57091d81d1SSam Leffler * Agency (DARPA) and Air Force Research Laboratory, Air Force 58091d81d1SSam Leffler * Materiel Command, USAF, under agreement number F30602-01-2-0537. 59091d81d1SSam Leffler * 60091d81d1SSam Leffler */ 61091d81d1SSam Leffler 62091d81d1SSam Leffler #ifndef _CRYPTO_CRYPTO_H_ 63091d81d1SSam Leffler #define _CRYPTO_CRYPTO_H_ 64091d81d1SSam Leffler 65091d81d1SSam Leffler #include <sys/ioccom.h> 66091d81d1SSam Leffler 672e08e39fSConrad Meyer #ifdef _KERNEL 682e08e39fSConrad Meyer #include <opencrypto/_cryptodev.h> 69345c692dSMarius Strobl #include <sys/_task.h> 702e08e39fSConrad Meyer #endif 712e08e39fSConrad Meyer 72091d81d1SSam Leffler /* Some initial values */ 73091d81d1SSam Leffler #define CRYPTO_DRIVERS_INITIAL 4 74091d81d1SSam Leffler #define CRYPTO_SW_SESSIONS 32 75091d81d1SSam Leffler 769ea7e421SPawel Jakub Dawidek /* Hash values */ 779ea7e421SPawel Jakub Dawidek #define NULL_HASH_LEN 16 789ea7e421SPawel Jakub Dawidek #define MD5_HASH_LEN 16 799ea7e421SPawel Jakub Dawidek #define SHA1_HASH_LEN 20 809ea7e421SPawel Jakub Dawidek #define RIPEMD160_HASH_LEN 20 81c97f39ceSConrad Meyer #define SHA2_224_HASH_LEN 28 829ea7e421SPawel Jakub Dawidek #define SHA2_256_HASH_LEN 32 839ea7e421SPawel Jakub Dawidek #define SHA2_384_HASH_LEN 48 849ea7e421SPawel Jakub Dawidek #define SHA2_512_HASH_LEN 64 859ea7e421SPawel Jakub Dawidek #define MD5_KPDK_HASH_LEN 16 869ea7e421SPawel Jakub Dawidek #define SHA1_KPDK_HASH_LEN 20 87a2bc81bfSJohn-Mark Gurney #define AES_GMAC_HASH_LEN 16 8801d5de8fSConrad Meyer #define POLY1305_HASH_LEN 16 89*a99bc4c3SSean Eric Fagan #define AES_CBC_MAC_HASH_LEN 16 900bbc4bf9SPawel Jakub Dawidek /* Maximum hash algorithm result length */ 910bbc4bf9SPawel Jakub Dawidek #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */ 920bbc4bf9SPawel Jakub Dawidek 93590adc1bSConrad Meyer #define MD5_BLOCK_LEN 64 94590adc1bSConrad Meyer #define SHA1_BLOCK_LEN 64 95590adc1bSConrad Meyer #define RIPEMD160_BLOCK_LEN 64 96c97f39ceSConrad Meyer #define SHA2_224_BLOCK_LEN 64 97590adc1bSConrad Meyer #define SHA2_256_BLOCK_LEN 64 98590adc1bSConrad Meyer #define SHA2_384_BLOCK_LEN 128 99590adc1bSConrad Meyer #define SHA2_512_BLOCK_LEN 128 100590adc1bSConrad Meyer 101091d81d1SSam Leffler /* HMAC values */ 1029ea7e421SPawel Jakub Dawidek #define NULL_HMAC_BLOCK_LEN 64 103bc58b0ecSPawel Jakub Dawidek /* Maximum HMAC block length */ 104590adc1bSConrad Meyer #define HMAC_MAX_BLOCK_LEN SHA2_512_BLOCK_LEN /* Keep this updated */ 105091d81d1SSam Leffler #define HMAC_IPAD_VAL 0x36 106091d81d1SSam Leffler #define HMAC_OPAD_VAL 0x5C 10716de9ac1SGeorge V. Neville-Neil /* HMAC Key Length */ 108a2bc81bfSJohn-Mark Gurney #define AES_128_GMAC_KEY_LEN 16 109a2bc81bfSJohn-Mark Gurney #define AES_192_GMAC_KEY_LEN 24 110a2bc81bfSJohn-Mark Gurney #define AES_256_GMAC_KEY_LEN 32 111*a99bc4c3SSean Eric Fagan #define AES_128_CBC_MAC_KEY_LEN 16 112*a99bc4c3SSean Eric Fagan #define AES_192_CBC_MAC_KEY_LEN 24 113*a99bc4c3SSean Eric Fagan #define AES_256_CBC_MAC_KEY_LEN 32 114091d81d1SSam Leffler 11501d5de8fSConrad Meyer #define POLY1305_KEY_LEN 32 11601d5de8fSConrad Meyer 117091d81d1SSam Leffler /* Encryption algorithm block sizes */ 118a2bc81bfSJohn-Mark Gurney #define NULL_BLOCK_LEN 4 /* IPsec to maintain alignment */ 119091d81d1SSam Leffler #define DES_BLOCK_LEN 8 120091d81d1SSam Leffler #define DES3_BLOCK_LEN 8 121091d81d1SSam Leffler #define BLOWFISH_BLOCK_LEN 8 122091d81d1SSam Leffler #define SKIPJACK_BLOCK_LEN 8 123091d81d1SSam Leffler #define CAST128_BLOCK_LEN 8 124091d81d1SSam Leffler #define RIJNDAEL128_BLOCK_LEN 16 12516de9ac1SGeorge V. Neville-Neil #define AES_BLOCK_LEN 16 126577f7474SJohn-Mark Gurney #define AES_ICM_BLOCK_LEN 1 12716de9ac1SGeorge V. Neville-Neil #define ARC4_BLOCK_LEN 1 128559d3390SGeorge V. Neville-Neil #define CAMELLIA_BLOCK_LEN 16 12961590291SConrad Meyer #define CHACHA20_NATIVE_BLOCK_LEN 64 13061590291SConrad Meyer #define EALG_MAX_BLOCK_LEN CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */ 131091d81d1SSam Leffler 13216de9ac1SGeorge V. Neville-Neil /* IV Lengths */ 13316de9ac1SGeorge V. Neville-Neil 13416de9ac1SGeorge V. Neville-Neil #define ARC4_IV_LEN 1 135577f7474SJohn-Mark Gurney #define AES_GCM_IV_LEN 12 13616de9ac1SGeorge V. Neville-Neil #define AES_XTS_IV_LEN 8 13716de9ac1SGeorge V. Neville-Neil #define AES_XTS_ALPHA 0x87 /* GF(2^128) generator polynomial */ 13816de9ac1SGeorge V. Neville-Neil 13916de9ac1SGeorge V. Neville-Neil /* Min and Max Encryption Key Sizes */ 14016de9ac1SGeorge V. Neville-Neil #define NULL_MIN_KEY 0 14116de9ac1SGeorge V. Neville-Neil #define NULL_MAX_KEY 256 /* 2048 bits, max key */ 14216de9ac1SGeorge V. Neville-Neil #define DES_MIN_KEY 8 14316de9ac1SGeorge V. Neville-Neil #define DES_MAX_KEY DES_MIN_KEY 14416de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MIN_KEY 24 14516de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MAX_KEY TRIPLE_DES_MIN_KEY 14616de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MIN_KEY 5 14716de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MAX_KEY 56 /* 448 bits, max key */ 14816de9ac1SGeorge V. Neville-Neil #define CAST_MIN_KEY 5 14916de9ac1SGeorge V. Neville-Neil #define CAST_MAX_KEY 16 15016de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MIN_KEY 10 15116de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MAX_KEY SKIPJACK_MIN_KEY 15216de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MIN_KEY 16 15316de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MAX_KEY 32 154577f7474SJohn-Mark Gurney #define AES_MIN_KEY RIJNDAEL_MIN_KEY 155577f7474SJohn-Mark Gurney #define AES_MAX_KEY RIJNDAEL_MAX_KEY 156577f7474SJohn-Mark Gurney #define AES_XTS_MIN_KEY (2 * AES_MIN_KEY) 157577f7474SJohn-Mark Gurney #define AES_XTS_MAX_KEY (2 * AES_MAX_KEY) 15816de9ac1SGeorge V. Neville-Neil #define ARC4_MIN_KEY 1 15916de9ac1SGeorge V. Neville-Neil #define ARC4_MAX_KEY 32 16016de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MIN_KEY 8 16116de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MAX_KEY 32 16216de9ac1SGeorge V. Neville-Neil 16308fca7a5SJohn-Mark Gurney /* Maximum hash algorithm result length */ 16408fca7a5SJohn-Mark Gurney #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 16508fca7a5SJohn-Mark Gurney 166091d81d1SSam Leffler #define CRYPTO_ALGORITHM_MIN 1 167091d81d1SSam Leffler #define CRYPTO_DES_CBC 1 168091d81d1SSam Leffler #define CRYPTO_3DES_CBC 2 169091d81d1SSam Leffler #define CRYPTO_BLF_CBC 3 170091d81d1SSam Leffler #define CRYPTO_CAST_CBC 4 171091d81d1SSam Leffler #define CRYPTO_SKIPJACK_CBC 5 172091d81d1SSam Leffler #define CRYPTO_MD5_HMAC 6 173091d81d1SSam Leffler #define CRYPTO_SHA1_HMAC 7 174091d81d1SSam Leffler #define CRYPTO_RIPEMD160_HMAC 8 175091d81d1SSam Leffler #define CRYPTO_MD5_KPDK 9 176091d81d1SSam Leffler #define CRYPTO_SHA1_KPDK 10 177091d81d1SSam Leffler #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 178091d81d1SSam Leffler #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 179091d81d1SSam Leffler #define CRYPTO_ARC4 12 180091d81d1SSam Leffler #define CRYPTO_MD5 13 181091d81d1SSam Leffler #define CRYPTO_SHA1 14 182f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_HMAC 15 183f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_CBC 16 184f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */ 185f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_256_HMAC 18 186f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_384_HMAC 19 187f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_512_HMAC 20 188559d3390SGeorge V. Neville-Neil #define CRYPTO_CAMELLIA_CBC 21 189d295bdeeSPawel Jakub Dawidek #define CRYPTO_AES_XTS 22 19008fca7a5SJohn-Mark Gurney #define CRYPTO_AES_ICM 23 /* commonly known as CTR mode */ 19108fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GMAC 24 /* cipher side */ 19208fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GCM_16 25 /* 16 byte ICV */ 19308fca7a5SJohn-Mark Gurney #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */ 19408fca7a5SJohn-Mark Gurney #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */ 19508fca7a5SJohn-Mark Gurney #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */ 1960e33efe4SConrad Meyer #define CRYPTO_BLAKE2B 29 /* Blake2b hash */ 1970e33efe4SConrad Meyer #define CRYPTO_BLAKE2S 30 /* Blake2s hash */ 19861590291SConrad Meyer #define CRYPTO_CHACHA20 31 /* Chacha20 stream cipher */ 199c97f39ceSConrad Meyer #define CRYPTO_SHA2_224_HMAC 32 200c4729f6eSConrad Meyer #define CRYPTO_RIPEMD160 33 201c4729f6eSConrad Meyer #define CRYPTO_SHA2_224 34 202c4729f6eSConrad Meyer #define CRYPTO_SHA2_256 35 203c4729f6eSConrad Meyer #define CRYPTO_SHA2_384 36 204c4729f6eSConrad Meyer #define CRYPTO_SHA2_512 37 20501d5de8fSConrad Meyer #define CRYPTO_POLY1305 38 206*a99bc4c3SSean Eric Fagan #define CRYPTO_AES_CCM_CBC_MAC 39 /* auth side */ 207*a99bc4c3SSean Eric Fagan #define CRYPTO_ALGORITHM_MAX 39 /* Keep updated - see below */ 20808fca7a5SJohn-Mark Gurney 20908fca7a5SJohn-Mark Gurney #define CRYPTO_ALGO_VALID(x) ((x) >= CRYPTO_ALGORITHM_MIN && \ 21008fca7a5SJohn-Mark Gurney (x) <= CRYPTO_ALGORITHM_MAX) 211091d81d1SSam Leffler 212091d81d1SSam Leffler /* Algorithm flags */ 213091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 214091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 215091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 216091d81d1SSam Leffler 2176810ad6fSSam Leffler /* 2186810ad6fSSam Leffler * Crypto driver/device flags. They can set in the crid 2196810ad6fSSam Leffler * parameter when creating a session or submitting a key 2206810ad6fSSam Leffler * op to affect the device/driver assigned. If neither 2216810ad6fSSam Leffler * of these are specified then the crid is assumed to hold 2226810ad6fSSam Leffler * the driver id of an existing (and suitable) device that 2236810ad6fSSam Leffler * must be used to satisfy the request. 2246810ad6fSSam Leffler */ 2256810ad6fSSam Leffler #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */ 2266810ad6fSSam Leffler #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */ 2276810ad6fSSam Leffler 2286810ad6fSSam Leffler /* NB: deprecated */ 229091d81d1SSam Leffler struct session_op { 230091d81d1SSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 231091d81d1SSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 232091d81d1SSam Leffler 233091d81d1SSam Leffler u_int32_t keylen; /* cipher key */ 2347dd10fdeSJohn Baldwin c_caddr_t key; 235091d81d1SSam Leffler int mackeylen; /* mac key */ 2367dd10fdeSJohn Baldwin c_caddr_t mackey; 237091d81d1SSam Leffler 238091d81d1SSam Leffler u_int32_t ses; /* returns: session # */ 239091d81d1SSam Leffler }; 240091d81d1SSam Leffler 2411b0909d5SConrad Meyer /* 2421b0909d5SConrad Meyer * session and crypt _op structs are used by userspace programs to interact 2431b0909d5SConrad Meyer * with /dev/crypto. Confusingly, the internal kernel interface is named 2441b0909d5SConrad Meyer * "cryptop" (no underscore). 2451b0909d5SConrad Meyer */ 2466810ad6fSSam Leffler struct session2_op { 2476810ad6fSSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 2486810ad6fSSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 2496810ad6fSSam Leffler 2506810ad6fSSam Leffler u_int32_t keylen; /* cipher key */ 2517dd10fdeSJohn Baldwin c_caddr_t key; 2526810ad6fSSam Leffler int mackeylen; /* mac key */ 2537dd10fdeSJohn Baldwin c_caddr_t mackey; 2546810ad6fSSam Leffler 2556810ad6fSSam Leffler u_int32_t ses; /* returns: session # */ 2566810ad6fSSam Leffler int crid; /* driver id + flags (rw) */ 2576810ad6fSSam Leffler int pad[4]; /* for future expansion */ 2586810ad6fSSam Leffler }; 2596810ad6fSSam Leffler 260091d81d1SSam Leffler struct crypt_op { 261091d81d1SSam Leffler u_int32_t ses; 262091d81d1SSam Leffler u_int16_t op; /* i.e. COP_ENCRYPT */ 263091d81d1SSam Leffler #define COP_ENCRYPT 1 264091d81d1SSam Leffler #define COP_DECRYPT 2 265eb73a605SSam Leffler u_int16_t flags; 2662c907637SJohn Baldwin #define COP_F_CIPHER_FIRST 0x0001 /* Cipher before MAC. */ 267eb73a605SSam Leffler #define COP_F_BATCH 0x0008 /* Batch op if possible */ 268091d81d1SSam Leffler u_int len; 2697dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2707dd10fdeSJohn Baldwin caddr_t dst; 271091d81d1SSam Leffler caddr_t mac; /* must be big enough for chosen MAC */ 2727dd10fdeSJohn Baldwin c_caddr_t iv; 273091d81d1SSam Leffler }; 274091d81d1SSam Leffler 27508fca7a5SJohn-Mark Gurney /* op and flags the same as crypt_op */ 27608fca7a5SJohn-Mark Gurney struct crypt_aead { 27708fca7a5SJohn-Mark Gurney u_int32_t ses; 27808fca7a5SJohn-Mark Gurney u_int16_t op; /* i.e. COP_ENCRYPT */ 27908fca7a5SJohn-Mark Gurney u_int16_t flags; 28008fca7a5SJohn-Mark Gurney u_int len; 28108fca7a5SJohn-Mark Gurney u_int aadlen; 28208fca7a5SJohn-Mark Gurney u_int ivlen; 2837dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2847dd10fdeSJohn Baldwin caddr_t dst; 2857dd10fdeSJohn Baldwin c_caddr_t aad; /* additional authenticated data */ 28608fca7a5SJohn-Mark Gurney caddr_t tag; /* must fit for chosen TAG length */ 2877dd10fdeSJohn Baldwin c_caddr_t iv; 28808fca7a5SJohn-Mark Gurney }; 28908fca7a5SJohn-Mark Gurney 2906810ad6fSSam Leffler /* 2916810ad6fSSam Leffler * Parameters for looking up a crypto driver/device by 2926810ad6fSSam Leffler * device name or by id. The latter are returned for 2936810ad6fSSam Leffler * created sessions (crid) and completed key operations. 2946810ad6fSSam Leffler */ 2956810ad6fSSam Leffler struct crypt_find_op { 2966810ad6fSSam Leffler int crid; /* driver id + flags */ 2976810ad6fSSam Leffler char name[32]; /* device/driver name */ 2986810ad6fSSam Leffler }; 2996810ad6fSSam Leffler 300091d81d1SSam Leffler /* bignum parameter, in packed bytes, ... */ 301091d81d1SSam Leffler struct crparam { 302091d81d1SSam Leffler caddr_t crp_p; 303091d81d1SSam Leffler u_int crp_nbits; 304091d81d1SSam Leffler }; 305091d81d1SSam Leffler 306091d81d1SSam Leffler #define CRK_MAXPARAM 8 307091d81d1SSam Leffler 308091d81d1SSam Leffler struct crypt_kop { 309091d81d1SSam Leffler u_int crk_op; /* ie. CRK_MOD_EXP or other */ 310091d81d1SSam Leffler u_int crk_status; /* return status */ 311091d81d1SSam Leffler u_short crk_iparams; /* # of input parameters */ 312091d81d1SSam Leffler u_short crk_oparams; /* # of output parameters */ 3136810ad6fSSam Leffler u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */ 314091d81d1SSam Leffler struct crparam crk_param[CRK_MAXPARAM]; 315091d81d1SSam Leffler }; 316091d81d1SSam Leffler #define CRK_ALGORITM_MIN 0 317091d81d1SSam Leffler #define CRK_MOD_EXP 0 318091d81d1SSam Leffler #define CRK_MOD_EXP_CRT 1 319091d81d1SSam Leffler #define CRK_DSA_SIGN 2 320091d81d1SSam Leffler #define CRK_DSA_VERIFY 3 321091d81d1SSam Leffler #define CRK_DH_COMPUTE_KEY 4 322091d81d1SSam Leffler #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */ 323091d81d1SSam Leffler 324091d81d1SSam Leffler #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 325091d81d1SSam Leffler #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 326091d81d1SSam Leffler #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 327091d81d1SSam Leffler #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 328091d81d1SSam Leffler #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 329091d81d1SSam Leffler 330091d81d1SSam Leffler /* 331091d81d1SSam Leffler * done against open of /dev/crypto, to get a cloned descriptor. 332091d81d1SSam Leffler * Please use F_SETFD against the cloned descriptor. 333091d81d1SSam Leffler */ 334091d81d1SSam Leffler #define CRIOGET _IOWR('c', 100, u_int32_t) 3356810ad6fSSam Leffler #define CRIOASYMFEAT CIOCASYMFEAT 3366810ad6fSSam Leffler #define CRIOFINDDEV CIOCFINDDEV 337091d81d1SSam Leffler 338091d81d1SSam Leffler /* the following are done against the cloned descriptor */ 339091d81d1SSam Leffler #define CIOCGSESSION _IOWR('c', 101, struct session_op) 340091d81d1SSam Leffler #define CIOCFSESSION _IOW('c', 102, u_int32_t) 341091d81d1SSam Leffler #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) 342091d81d1SSam Leffler #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 343091d81d1SSam Leffler #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 3446810ad6fSSam Leffler #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op) 3456810ad6fSSam Leffler #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop) 3466810ad6fSSam Leffler #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op) 34708fca7a5SJohn-Mark Gurney #define CIOCCRYPTAEAD _IOWR('c', 109, struct crypt_aead) 348091d81d1SSam Leffler 3497d1853eeSSam Leffler struct cryptotstat { 3507d1853eeSSam Leffler struct timespec acc; /* total accumulated time */ 3517d1853eeSSam Leffler struct timespec min; /* min time */ 3527d1853eeSSam Leffler struct timespec max; /* max time */ 3537d1853eeSSam Leffler u_int32_t count; /* number of observations */ 3547d1853eeSSam Leffler }; 3557d1853eeSSam Leffler 3567d1853eeSSam Leffler struct cryptostats { 3577d1853eeSSam Leffler u_int32_t cs_ops; /* symmetric crypto ops submitted */ 3587d1853eeSSam Leffler u_int32_t cs_errs; /* symmetric crypto ops that failed */ 3597d1853eeSSam Leffler u_int32_t cs_kops; /* asymetric/key ops submitted */ 3607d1853eeSSam Leffler u_int32_t cs_kerrs; /* asymetric/key ops that failed */ 3617d1853eeSSam Leffler u_int32_t cs_intrs; /* crypto swi thread activations */ 3627d1853eeSSam Leffler u_int32_t cs_rets; /* crypto return thread activations */ 3637d1853eeSSam Leffler u_int32_t cs_blocks; /* symmetric op driver block */ 3647d1853eeSSam Leffler u_int32_t cs_kblocks; /* symmetric op driver block */ 3657d1853eeSSam Leffler /* 3667d1853eeSSam Leffler * When CRYPTO_TIMING is defined at compile time and the 3677d1853eeSSam Leffler * sysctl debug.crypto is set to 1, the crypto system will 3687d1853eeSSam Leffler * accumulate statistics about how long it takes to process 3697d1853eeSSam Leffler * crypto requests at various points during processing. 3707d1853eeSSam Leffler */ 3717d1853eeSSam Leffler struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */ 3727d1853eeSSam Leffler struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */ 3737d1853eeSSam Leffler struct cryptotstat cs_cb; /* crypto_done -> callback */ 3747d1853eeSSam Leffler struct cryptotstat cs_finis; /* callback -> callback return */ 3757d1853eeSSam Leffler }; 3767d1853eeSSam Leffler 377091d81d1SSam Leffler #ifdef _KERNEL 37808fca7a5SJohn-Mark Gurney 37908fca7a5SJohn-Mark Gurney #if 0 380289b9798SConrad Meyer #define CRYPTDEB(s, ...) do { \ 381289b9798SConrad Meyer printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__); \ 38208fca7a5SJohn-Mark Gurney } while (0) 38308fca7a5SJohn-Mark Gurney #else 384289b9798SConrad Meyer #define CRYPTDEB(...) do { } while (0) 38508fca7a5SJohn-Mark Gurney #endif 38608fca7a5SJohn-Mark Gurney 387091d81d1SSam Leffler /* Standard initialization structure beginning */ 388091d81d1SSam Leffler struct cryptoini { 389091d81d1SSam Leffler int cri_alg; /* Algorithm to use */ 390091d81d1SSam Leffler int cri_klen; /* Key length, in bits */ 391f6c4bc3bSPawel Jakub Dawidek int cri_mlen; /* Number of bytes we want from the 392f6c4bc3bSPawel Jakub Dawidek entire hash. 0 means all. */ 393091d81d1SSam Leffler caddr_t cri_key; /* key to use */ 394091d81d1SSam Leffler u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 395091d81d1SSam Leffler struct cryptoini *cri_next; 396091d81d1SSam Leffler }; 397091d81d1SSam Leffler 398091d81d1SSam Leffler /* Describe boundaries of a single crypto operation */ 399091d81d1SSam Leffler struct cryptodesc { 400091d81d1SSam Leffler int crd_skip; /* How many bytes to ignore from start */ 401091d81d1SSam Leffler int crd_len; /* How many bytes to process */ 402091d81d1SSam Leffler int crd_inject; /* Where to inject results, if applicable */ 403091d81d1SSam Leffler int crd_flags; 404091d81d1SSam Leffler 405091d81d1SSam Leffler #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 406091d81d1SSam Leffler #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 407091d81d1SSam Leffler place, so don't copy. */ 408091d81d1SSam Leffler #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 409091d81d1SSam Leffler #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 410091d81d1SSam Leffler #define CRD_F_COMP 0x0f /* Set when doing compression */ 41108fca7a5SJohn-Mark Gurney #define CRD_F_KEY_EXPLICIT 0x10 /* Key explicitly provided */ 412091d81d1SSam Leffler 413091d81d1SSam Leffler struct cryptoini CRD_INI; /* Initialization/context data */ 41408fca7a5SJohn-Mark Gurney #define crd_esn CRD_INI.cri_esn 415091d81d1SSam Leffler #define crd_iv CRD_INI.cri_iv 416091d81d1SSam Leffler #define crd_key CRD_INI.cri_key 417091d81d1SSam Leffler #define crd_alg CRD_INI.cri_alg 418091d81d1SSam Leffler #define crd_klen CRD_INI.cri_klen 419091d81d1SSam Leffler 420091d81d1SSam Leffler struct cryptodesc *crd_next; 421091d81d1SSam Leffler }; 422091d81d1SSam Leffler 423091d81d1SSam Leffler /* Structure describing complete operation */ 424091d81d1SSam Leffler struct cryptop { 425091d81d1SSam Leffler TAILQ_ENTRY(cryptop) crp_next; 426091d81d1SSam Leffler 42739bbca6fSFabien Thomas struct task crp_task; 42839bbca6fSFabien Thomas 4291b0909d5SConrad Meyer crypto_session_t crp_session; /* Session */ 430091d81d1SSam Leffler int crp_ilen; /* Input data total length */ 431091d81d1SSam Leffler int crp_olen; /* Result total length */ 432091d81d1SSam Leffler 433091d81d1SSam Leffler int crp_etype; /* 434091d81d1SSam Leffler * Error type (zero means no error). 435091d81d1SSam Leffler * All error codes except EAGAIN 436091d81d1SSam Leffler * indicate possible data corruption (as in, 437091d81d1SSam Leffler * the data have been touched). On all 4381b0909d5SConrad Meyer * errors, the crp_session may have changed 439091d81d1SSam Leffler * (reset to a new one), so the caller 440091d81d1SSam Leffler * should always check and use the new 441091d81d1SSam Leffler * value on future requests. 442091d81d1SSam Leffler */ 443091d81d1SSam Leffler int crp_flags; 444091d81d1SSam Leffler 445d8409aafSSam Leffler #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */ 446091d81d1SSam Leffler #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 447eb73a605SSam Leffler #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible */ 448eb73a605SSam Leffler #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */ 4493569ae7fSSam Leffler #define CRYPTO_F_DONE 0x0020 /* Operation completed */ 450d8409aafSSam Leffler #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */ 45139bbca6fSFabien Thomas #define CRYPTO_F_ASYNC 0x0080 /* Dispatch crypto jobs on several threads 45239bbca6fSFabien Thomas * if op is synchronous 45339bbca6fSFabien Thomas */ 45439bbca6fSFabien Thomas #define CRYPTO_F_ASYNC_KEEPORDER 0x0100 /* 45539bbca6fSFabien Thomas * Dispatch the crypto jobs in the same 45639bbca6fSFabien Thomas * order there are submitted. Applied only 45739bbca6fSFabien Thomas * if CRYPTO_F_ASYNC flags is set 45839bbca6fSFabien Thomas */ 459091d81d1SSam Leffler 460a296c719SJohn Baldwin union { 461091d81d1SSam Leffler caddr_t crp_buf; /* Data to be processed */ 462a296c719SJohn Baldwin struct mbuf *crp_mbuf; 463a296c719SJohn Baldwin struct uio *crp_uio; 464a296c719SJohn Baldwin }; 465eda08c83SJohn Baldwin void * crp_opaque; /* Opaque pointer, passed along */ 466091d81d1SSam Leffler struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 467091d81d1SSam Leffler 468091d81d1SSam Leffler int (*crp_callback)(struct cryptop *); /* Callback function */ 469091d81d1SSam Leffler 4707d1853eeSSam Leffler struct bintime crp_tstamp; /* performance time stamp */ 47139bbca6fSFabien Thomas uint32_t crp_seq; /* used for ordered dispatch */ 47239bbca6fSFabien Thomas uint32_t crp_retw_id; /* 47339bbca6fSFabien Thomas * the return worker to be used, 47439bbca6fSFabien Thomas * used for ordered dispatch 47539bbca6fSFabien Thomas */ 476091d81d1SSam Leffler }; 477091d81d1SSam Leffler 47839bbca6fSFabien Thomas #define CRYPTOP_ASYNC(crp) \ 47939bbca6fSFabien Thomas (((crp)->crp_flags & CRYPTO_F_ASYNC) && \ 4801b0909d5SConrad Meyer crypto_ses2caps((crp)->crp_session) & CRYPTOCAP_F_SYNC) 48139bbca6fSFabien Thomas #define CRYPTOP_ASYNC_KEEPORDER(crp) \ 48239bbca6fSFabien Thomas (CRYPTOP_ASYNC(crp) && \ 48339bbca6fSFabien Thomas (crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER) 48439bbca6fSFabien Thomas 485091d81d1SSam Leffler #define CRYPTO_BUF_CONTIG 0x0 486091d81d1SSam Leffler #define CRYPTO_BUF_IOV 0x1 487091d81d1SSam Leffler #define CRYPTO_BUF_MBUF 0x2 488091d81d1SSam Leffler 489091d81d1SSam Leffler #define CRYPTO_OP_DECRYPT 0x0 490091d81d1SSam Leffler #define CRYPTO_OP_ENCRYPT 0x1 491091d81d1SSam Leffler 492091d81d1SSam Leffler /* 493091d81d1SSam Leffler * Hints passed to process methods. 494091d81d1SSam Leffler */ 495091d81d1SSam Leffler #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 496091d81d1SSam Leffler 497091d81d1SSam Leffler struct cryptkop { 498091d81d1SSam Leffler TAILQ_ENTRY(cryptkop) krp_next; 499091d81d1SSam Leffler 500091d81d1SSam Leffler u_int krp_op; /* ie. CRK_MOD_EXP or other */ 501091d81d1SSam Leffler u_int krp_status; /* return status */ 502091d81d1SSam Leffler u_short krp_iparams; /* # of input parameters */ 503091d81d1SSam Leffler u_short krp_oparams; /* # of output parameters */ 5046810ad6fSSam Leffler u_int krp_crid; /* desired device, etc. */ 505091d81d1SSam Leffler u_int32_t krp_hid; 506091d81d1SSam Leffler struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 507091d81d1SSam Leffler int (*krp_callback)(struct cryptkop *); 508091d81d1SSam Leffler }; 509091d81d1SSam Leffler 5101b0909d5SConrad Meyer uint32_t crypto_ses2hid(crypto_session_t crypto_session); 5111b0909d5SConrad Meyer uint32_t crypto_ses2caps(crypto_session_t crypto_session); 5121b0909d5SConrad Meyer void *crypto_get_driver_session(crypto_session_t crypto_session); 51307d0c94aSSam Leffler 514091d81d1SSam Leffler MALLOC_DECLARE(M_CRYPTO_DATA); 515091d81d1SSam Leffler 5161b0909d5SConrad Meyer extern int crypto_newsession(crypto_session_t *cses, struct cryptoini *cri, int hard); 5171b0909d5SConrad Meyer extern void crypto_freesession(crypto_session_t cses); 5186810ad6fSSam Leffler #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE 5196810ad6fSSam Leffler #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE 5206810ad6fSSam Leffler #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */ 5211b0909d5SConrad Meyer extern int32_t crypto_get_driverid(device_t dev, size_t session_size, 5221b0909d5SConrad Meyer int flags); 5236810ad6fSSam Leffler extern int crypto_find_driver(const char *); 5246810ad6fSSam Leffler extern device_t crypto_find_device_byhid(int hid); 5256810ad6fSSam Leffler extern int crypto_getcaps(int hid); 526091d81d1SSam Leffler extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, 5276810ad6fSSam Leffler u_int32_t flags); 5286810ad6fSSam Leffler extern int crypto_kregister(u_int32_t, int, u_int32_t); 529091d81d1SSam Leffler extern int crypto_unregister(u_int32_t driverid, int alg); 530091d81d1SSam Leffler extern int crypto_unregister_all(u_int32_t driverid); 531091d81d1SSam Leffler extern int crypto_dispatch(struct cryptop *crp); 532091d81d1SSam Leffler extern int crypto_kdispatch(struct cryptkop *); 533091d81d1SSam Leffler #define CRYPTO_SYMQ 0x1 534091d81d1SSam Leffler #define CRYPTO_ASYMQ 0x2 535091d81d1SSam Leffler extern int crypto_unblock(u_int32_t, int); 536091d81d1SSam Leffler extern void crypto_done(struct cryptop *crp); 537091d81d1SSam Leffler extern void crypto_kdone(struct cryptkop *); 538091d81d1SSam Leffler extern int crypto_getfeat(int *); 539091d81d1SSam Leffler 540091d81d1SSam Leffler extern void crypto_freereq(struct cryptop *crp); 541091d81d1SSam Leffler extern struct cryptop *crypto_getreq(int num); 542091d81d1SSam Leffler 543091d81d1SSam Leffler extern int crypto_usercrypto; /* userland may do crypto requests */ 544091d81d1SSam Leffler extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 545091d81d1SSam Leffler extern int crypto_devallowsoft; /* only use hardware crypto */ 546091d81d1SSam Leffler 547091d81d1SSam Leffler /* 548091d81d1SSam Leffler * Crypto-related utility routines used mainly by drivers. 549091d81d1SSam Leffler * 550091d81d1SSam Leffler * XXX these don't really belong here; but for now they're 551091d81d1SSam Leffler * kept apart from the rest of the system. 552091d81d1SSam Leffler */ 553091d81d1SSam Leffler struct uio; 554091d81d1SSam Leffler extern void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp); 5557dd10fdeSJohn Baldwin extern void cuio_copyback(struct uio* uio, int off, int len, c_caddr_t cp); 55608fca7a5SJohn-Mark Gurney extern int cuio_getptr(struct uio *uio, int loc, int *off); 557b5161eb7SPawel Jakub Dawidek extern int cuio_apply(struct uio *uio, int off, int len, 558b5161eb7SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 55911d2e1e8SPawel Jakub Dawidek 56008fca7a5SJohn-Mark Gurney struct mbuf; 56108fca7a5SJohn-Mark Gurney struct iovec; 562748a12e2SJohn-Mark Gurney extern int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr, 56308fca7a5SJohn-Mark Gurney int *cnt, int *allocated); 56408fca7a5SJohn-Mark Gurney 56511d2e1e8SPawel Jakub Dawidek extern void crypto_copyback(int flags, caddr_t buf, int off, int size, 5667dd10fdeSJohn Baldwin c_caddr_t in); 56711d2e1e8SPawel Jakub Dawidek extern void crypto_copydata(int flags, caddr_t buf, int off, int size, 56811d2e1e8SPawel Jakub Dawidek caddr_t out); 56911d2e1e8SPawel Jakub Dawidek extern int crypto_apply(int flags, caddr_t buf, int off, int len, 57011d2e1e8SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 571a296c719SJohn Baldwin 572ff2038a9SMatt Macy extern void *crypto_contiguous_subsegment(int, void *, size_t, size_t); 573ff2038a9SMatt Macy 574091d81d1SSam Leffler #endif /* _KERNEL */ 575091d81d1SSam Leffler #endif /* _CRYPTO_CRYPTO_H_ */ 576