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> 6639bbca6fSFabien Thomas #include <sys/_task.h> 67091d81d1SSam Leffler 68091d81d1SSam Leffler /* Some initial values */ 69091d81d1SSam Leffler #define CRYPTO_DRIVERS_INITIAL 4 70091d81d1SSam Leffler #define CRYPTO_SW_SESSIONS 32 71091d81d1SSam Leffler 729ea7e421SPawel Jakub Dawidek /* Hash values */ 739ea7e421SPawel Jakub Dawidek #define NULL_HASH_LEN 16 749ea7e421SPawel Jakub Dawidek #define MD5_HASH_LEN 16 759ea7e421SPawel Jakub Dawidek #define SHA1_HASH_LEN 20 769ea7e421SPawel Jakub Dawidek #define RIPEMD160_HASH_LEN 20 77*c97f39ceSConrad Meyer #define SHA2_224_HASH_LEN 28 789ea7e421SPawel Jakub Dawidek #define SHA2_256_HASH_LEN 32 799ea7e421SPawel Jakub Dawidek #define SHA2_384_HASH_LEN 48 809ea7e421SPawel Jakub Dawidek #define SHA2_512_HASH_LEN 64 819ea7e421SPawel Jakub Dawidek #define MD5_KPDK_HASH_LEN 16 829ea7e421SPawel Jakub Dawidek #define SHA1_KPDK_HASH_LEN 20 83a2bc81bfSJohn-Mark Gurney #define AES_GMAC_HASH_LEN 16 840bbc4bf9SPawel Jakub Dawidek /* Maximum hash algorithm result length */ 850bbc4bf9SPawel Jakub Dawidek #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */ 860bbc4bf9SPawel Jakub Dawidek 87590adc1bSConrad Meyer #define MD5_BLOCK_LEN 64 88590adc1bSConrad Meyer #define SHA1_BLOCK_LEN 64 89590adc1bSConrad Meyer #define RIPEMD160_BLOCK_LEN 64 90*c97f39ceSConrad Meyer #define SHA2_224_BLOCK_LEN 64 91590adc1bSConrad Meyer #define SHA2_256_BLOCK_LEN 64 92590adc1bSConrad Meyer #define SHA2_384_BLOCK_LEN 128 93590adc1bSConrad Meyer #define SHA2_512_BLOCK_LEN 128 94590adc1bSConrad Meyer 95091d81d1SSam Leffler /* HMAC values */ 969ea7e421SPawel Jakub Dawidek #define NULL_HMAC_BLOCK_LEN 64 97bc58b0ecSPawel Jakub Dawidek /* Maximum HMAC block length */ 98590adc1bSConrad Meyer #define HMAC_MAX_BLOCK_LEN SHA2_512_BLOCK_LEN /* Keep this updated */ 99091d81d1SSam Leffler #define HMAC_IPAD_VAL 0x36 100091d81d1SSam Leffler #define HMAC_OPAD_VAL 0x5C 10116de9ac1SGeorge V. Neville-Neil /* HMAC Key Length */ 102a2bc81bfSJohn-Mark Gurney #define AES_128_GMAC_KEY_LEN 16 103a2bc81bfSJohn-Mark Gurney #define AES_192_GMAC_KEY_LEN 24 104a2bc81bfSJohn-Mark Gurney #define AES_256_GMAC_KEY_LEN 32 105091d81d1SSam Leffler 106091d81d1SSam Leffler /* Encryption algorithm block sizes */ 107a2bc81bfSJohn-Mark Gurney #define NULL_BLOCK_LEN 4 /* IPsec to maintain alignment */ 108091d81d1SSam Leffler #define DES_BLOCK_LEN 8 109091d81d1SSam Leffler #define DES3_BLOCK_LEN 8 110091d81d1SSam Leffler #define BLOWFISH_BLOCK_LEN 8 111091d81d1SSam Leffler #define SKIPJACK_BLOCK_LEN 8 112091d81d1SSam Leffler #define CAST128_BLOCK_LEN 8 113091d81d1SSam Leffler #define RIJNDAEL128_BLOCK_LEN 16 11416de9ac1SGeorge V. Neville-Neil #define AES_BLOCK_LEN 16 115577f7474SJohn-Mark Gurney #define AES_ICM_BLOCK_LEN 1 11616de9ac1SGeorge V. Neville-Neil #define ARC4_BLOCK_LEN 1 117559d3390SGeorge V. Neville-Neil #define CAMELLIA_BLOCK_LEN 16 11861590291SConrad Meyer #define CHACHA20_NATIVE_BLOCK_LEN 64 11961590291SConrad Meyer #define EALG_MAX_BLOCK_LEN CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */ 120091d81d1SSam Leffler 12116de9ac1SGeorge V. Neville-Neil /* IV Lengths */ 12216de9ac1SGeorge V. Neville-Neil 12316de9ac1SGeorge V. Neville-Neil #define ARC4_IV_LEN 1 124577f7474SJohn-Mark Gurney #define AES_GCM_IV_LEN 12 12516de9ac1SGeorge V. Neville-Neil #define AES_XTS_IV_LEN 8 12616de9ac1SGeorge V. Neville-Neil #define AES_XTS_ALPHA 0x87 /* GF(2^128) generator polynomial */ 12716de9ac1SGeorge V. Neville-Neil 12816de9ac1SGeorge V. Neville-Neil /* Min and Max Encryption Key Sizes */ 12916de9ac1SGeorge V. Neville-Neil #define NULL_MIN_KEY 0 13016de9ac1SGeorge V. Neville-Neil #define NULL_MAX_KEY 256 /* 2048 bits, max key */ 13116de9ac1SGeorge V. Neville-Neil #define DES_MIN_KEY 8 13216de9ac1SGeorge V. Neville-Neil #define DES_MAX_KEY DES_MIN_KEY 13316de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MIN_KEY 24 13416de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MAX_KEY TRIPLE_DES_MIN_KEY 13516de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MIN_KEY 5 13616de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MAX_KEY 56 /* 448 bits, max key */ 13716de9ac1SGeorge V. Neville-Neil #define CAST_MIN_KEY 5 13816de9ac1SGeorge V. Neville-Neil #define CAST_MAX_KEY 16 13916de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MIN_KEY 10 14016de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MAX_KEY SKIPJACK_MIN_KEY 14116de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MIN_KEY 16 14216de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MAX_KEY 32 143577f7474SJohn-Mark Gurney #define AES_MIN_KEY RIJNDAEL_MIN_KEY 144577f7474SJohn-Mark Gurney #define AES_MAX_KEY RIJNDAEL_MAX_KEY 145577f7474SJohn-Mark Gurney #define AES_XTS_MIN_KEY (2 * AES_MIN_KEY) 146577f7474SJohn-Mark Gurney #define AES_XTS_MAX_KEY (2 * AES_MAX_KEY) 14716de9ac1SGeorge V. Neville-Neil #define ARC4_MIN_KEY 1 14816de9ac1SGeorge V. Neville-Neil #define ARC4_MAX_KEY 32 14916de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MIN_KEY 8 15016de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MAX_KEY 32 15116de9ac1SGeorge V. Neville-Neil 15208fca7a5SJohn-Mark Gurney /* Maximum hash algorithm result length */ 15308fca7a5SJohn-Mark Gurney #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 15408fca7a5SJohn-Mark Gurney 155091d81d1SSam Leffler #define CRYPTO_ALGORITHM_MIN 1 156091d81d1SSam Leffler #define CRYPTO_DES_CBC 1 157091d81d1SSam Leffler #define CRYPTO_3DES_CBC 2 158091d81d1SSam Leffler #define CRYPTO_BLF_CBC 3 159091d81d1SSam Leffler #define CRYPTO_CAST_CBC 4 160091d81d1SSam Leffler #define CRYPTO_SKIPJACK_CBC 5 161091d81d1SSam Leffler #define CRYPTO_MD5_HMAC 6 162091d81d1SSam Leffler #define CRYPTO_SHA1_HMAC 7 163091d81d1SSam Leffler #define CRYPTO_RIPEMD160_HMAC 8 164091d81d1SSam Leffler #define CRYPTO_MD5_KPDK 9 165091d81d1SSam Leffler #define CRYPTO_SHA1_KPDK 10 166091d81d1SSam Leffler #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 167091d81d1SSam Leffler #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 168091d81d1SSam Leffler #define CRYPTO_ARC4 12 169091d81d1SSam Leffler #define CRYPTO_MD5 13 170091d81d1SSam Leffler #define CRYPTO_SHA1 14 171f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_HMAC 15 172f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_CBC 16 173f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */ 174f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_256_HMAC 18 175f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_384_HMAC 19 176f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_512_HMAC 20 177559d3390SGeorge V. Neville-Neil #define CRYPTO_CAMELLIA_CBC 21 178d295bdeeSPawel Jakub Dawidek #define CRYPTO_AES_XTS 22 17908fca7a5SJohn-Mark Gurney #define CRYPTO_AES_ICM 23 /* commonly known as CTR mode */ 18008fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GMAC 24 /* cipher side */ 18108fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GCM_16 25 /* 16 byte ICV */ 18208fca7a5SJohn-Mark Gurney #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */ 18308fca7a5SJohn-Mark Gurney #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */ 18408fca7a5SJohn-Mark Gurney #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */ 1850e33efe4SConrad Meyer #define CRYPTO_BLAKE2B 29 /* Blake2b hash */ 1860e33efe4SConrad Meyer #define CRYPTO_BLAKE2S 30 /* Blake2s hash */ 18761590291SConrad Meyer #define CRYPTO_CHACHA20 31 /* Chacha20 stream cipher */ 188*c97f39ceSConrad Meyer #define CRYPTO_SHA2_224_HMAC 32 189*c97f39ceSConrad Meyer #define CRYPTO_ALGORITHM_MAX 32 /* Keep updated - see below */ 19008fca7a5SJohn-Mark Gurney 19108fca7a5SJohn-Mark Gurney #define CRYPTO_ALGO_VALID(x) ((x) >= CRYPTO_ALGORITHM_MIN && \ 19208fca7a5SJohn-Mark Gurney (x) <= CRYPTO_ALGORITHM_MAX) 193091d81d1SSam Leffler 194091d81d1SSam Leffler /* Algorithm flags */ 195091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 196091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 197091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 198091d81d1SSam Leffler 1996810ad6fSSam Leffler /* 2006810ad6fSSam Leffler * Crypto driver/device flags. They can set in the crid 2016810ad6fSSam Leffler * parameter when creating a session or submitting a key 2026810ad6fSSam Leffler * op to affect the device/driver assigned. If neither 2036810ad6fSSam Leffler * of these are specified then the crid is assumed to hold 2046810ad6fSSam Leffler * the driver id of an existing (and suitable) device that 2056810ad6fSSam Leffler * must be used to satisfy the request. 2066810ad6fSSam Leffler */ 2076810ad6fSSam Leffler #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */ 2086810ad6fSSam Leffler #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */ 2096810ad6fSSam Leffler 2106810ad6fSSam Leffler /* NB: deprecated */ 211091d81d1SSam Leffler struct session_op { 212091d81d1SSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 213091d81d1SSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 214091d81d1SSam Leffler 215091d81d1SSam Leffler u_int32_t keylen; /* cipher key */ 2167dd10fdeSJohn Baldwin c_caddr_t key; 217091d81d1SSam Leffler int mackeylen; /* mac key */ 2187dd10fdeSJohn Baldwin c_caddr_t mackey; 219091d81d1SSam Leffler 220091d81d1SSam Leffler u_int32_t ses; /* returns: session # */ 221091d81d1SSam Leffler }; 222091d81d1SSam Leffler 2236810ad6fSSam Leffler struct session2_op { 2246810ad6fSSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 2256810ad6fSSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 2266810ad6fSSam Leffler 2276810ad6fSSam Leffler u_int32_t keylen; /* cipher key */ 2287dd10fdeSJohn Baldwin c_caddr_t key; 2296810ad6fSSam Leffler int mackeylen; /* mac key */ 2307dd10fdeSJohn Baldwin c_caddr_t mackey; 2316810ad6fSSam Leffler 2326810ad6fSSam Leffler u_int32_t ses; /* returns: session # */ 2336810ad6fSSam Leffler int crid; /* driver id + flags (rw) */ 2346810ad6fSSam Leffler int pad[4]; /* for future expansion */ 2356810ad6fSSam Leffler }; 2366810ad6fSSam Leffler 237091d81d1SSam Leffler struct crypt_op { 238091d81d1SSam Leffler u_int32_t ses; 239091d81d1SSam Leffler u_int16_t op; /* i.e. COP_ENCRYPT */ 240091d81d1SSam Leffler #define COP_ENCRYPT 1 241091d81d1SSam Leffler #define COP_DECRYPT 2 242eb73a605SSam Leffler u_int16_t flags; 2432c907637SJohn Baldwin #define COP_F_CIPHER_FIRST 0x0001 /* Cipher before MAC. */ 244eb73a605SSam Leffler #define COP_F_BATCH 0x0008 /* Batch op if possible */ 245091d81d1SSam Leffler u_int len; 2467dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2477dd10fdeSJohn Baldwin caddr_t dst; 248091d81d1SSam Leffler caddr_t mac; /* must be big enough for chosen MAC */ 2497dd10fdeSJohn Baldwin c_caddr_t iv; 250091d81d1SSam Leffler }; 251091d81d1SSam Leffler 25208fca7a5SJohn-Mark Gurney /* op and flags the same as crypt_op */ 25308fca7a5SJohn-Mark Gurney struct crypt_aead { 25408fca7a5SJohn-Mark Gurney u_int32_t ses; 25508fca7a5SJohn-Mark Gurney u_int16_t op; /* i.e. COP_ENCRYPT */ 25608fca7a5SJohn-Mark Gurney u_int16_t flags; 25708fca7a5SJohn-Mark Gurney u_int len; 25808fca7a5SJohn-Mark Gurney u_int aadlen; 25908fca7a5SJohn-Mark Gurney u_int ivlen; 2607dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2617dd10fdeSJohn Baldwin caddr_t dst; 2627dd10fdeSJohn Baldwin c_caddr_t aad; /* additional authenticated data */ 26308fca7a5SJohn-Mark Gurney caddr_t tag; /* must fit for chosen TAG length */ 2647dd10fdeSJohn Baldwin c_caddr_t iv; 26508fca7a5SJohn-Mark Gurney }; 26608fca7a5SJohn-Mark Gurney 2676810ad6fSSam Leffler /* 2686810ad6fSSam Leffler * Parameters for looking up a crypto driver/device by 2696810ad6fSSam Leffler * device name or by id. The latter are returned for 2706810ad6fSSam Leffler * created sessions (crid) and completed key operations. 2716810ad6fSSam Leffler */ 2726810ad6fSSam Leffler struct crypt_find_op { 2736810ad6fSSam Leffler int crid; /* driver id + flags */ 2746810ad6fSSam Leffler char name[32]; /* device/driver name */ 2756810ad6fSSam Leffler }; 2766810ad6fSSam Leffler 277091d81d1SSam Leffler /* bignum parameter, in packed bytes, ... */ 278091d81d1SSam Leffler struct crparam { 279091d81d1SSam Leffler caddr_t crp_p; 280091d81d1SSam Leffler u_int crp_nbits; 281091d81d1SSam Leffler }; 282091d81d1SSam Leffler 283091d81d1SSam Leffler #define CRK_MAXPARAM 8 284091d81d1SSam Leffler 285091d81d1SSam Leffler struct crypt_kop { 286091d81d1SSam Leffler u_int crk_op; /* ie. CRK_MOD_EXP or other */ 287091d81d1SSam Leffler u_int crk_status; /* return status */ 288091d81d1SSam Leffler u_short crk_iparams; /* # of input parameters */ 289091d81d1SSam Leffler u_short crk_oparams; /* # of output parameters */ 2906810ad6fSSam Leffler u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */ 291091d81d1SSam Leffler struct crparam crk_param[CRK_MAXPARAM]; 292091d81d1SSam Leffler }; 293091d81d1SSam Leffler #define CRK_ALGORITM_MIN 0 294091d81d1SSam Leffler #define CRK_MOD_EXP 0 295091d81d1SSam Leffler #define CRK_MOD_EXP_CRT 1 296091d81d1SSam Leffler #define CRK_DSA_SIGN 2 297091d81d1SSam Leffler #define CRK_DSA_VERIFY 3 298091d81d1SSam Leffler #define CRK_DH_COMPUTE_KEY 4 299091d81d1SSam Leffler #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */ 300091d81d1SSam Leffler 301091d81d1SSam Leffler #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 302091d81d1SSam Leffler #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 303091d81d1SSam Leffler #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 304091d81d1SSam Leffler #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 305091d81d1SSam Leffler #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 306091d81d1SSam Leffler 307091d81d1SSam Leffler /* 308091d81d1SSam Leffler * done against open of /dev/crypto, to get a cloned descriptor. 309091d81d1SSam Leffler * Please use F_SETFD against the cloned descriptor. 310091d81d1SSam Leffler */ 311091d81d1SSam Leffler #define CRIOGET _IOWR('c', 100, u_int32_t) 3126810ad6fSSam Leffler #define CRIOASYMFEAT CIOCASYMFEAT 3136810ad6fSSam Leffler #define CRIOFINDDEV CIOCFINDDEV 314091d81d1SSam Leffler 315091d81d1SSam Leffler /* the following are done against the cloned descriptor */ 316091d81d1SSam Leffler #define CIOCGSESSION _IOWR('c', 101, struct session_op) 317091d81d1SSam Leffler #define CIOCFSESSION _IOW('c', 102, u_int32_t) 318091d81d1SSam Leffler #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) 319091d81d1SSam Leffler #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 320091d81d1SSam Leffler #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 3216810ad6fSSam Leffler #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op) 3226810ad6fSSam Leffler #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop) 3236810ad6fSSam Leffler #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op) 32408fca7a5SJohn-Mark Gurney #define CIOCCRYPTAEAD _IOWR('c', 109, struct crypt_aead) 325091d81d1SSam Leffler 3267d1853eeSSam Leffler struct cryptotstat { 3277d1853eeSSam Leffler struct timespec acc; /* total accumulated time */ 3287d1853eeSSam Leffler struct timespec min; /* min time */ 3297d1853eeSSam Leffler struct timespec max; /* max time */ 3307d1853eeSSam Leffler u_int32_t count; /* number of observations */ 3317d1853eeSSam Leffler }; 3327d1853eeSSam Leffler 3337d1853eeSSam Leffler struct cryptostats { 3347d1853eeSSam Leffler u_int32_t cs_ops; /* symmetric crypto ops submitted */ 3357d1853eeSSam Leffler u_int32_t cs_errs; /* symmetric crypto ops that failed */ 3367d1853eeSSam Leffler u_int32_t cs_kops; /* asymetric/key ops submitted */ 3377d1853eeSSam Leffler u_int32_t cs_kerrs; /* asymetric/key ops that failed */ 3387d1853eeSSam Leffler u_int32_t cs_intrs; /* crypto swi thread activations */ 3397d1853eeSSam Leffler u_int32_t cs_rets; /* crypto return thread activations */ 3407d1853eeSSam Leffler u_int32_t cs_blocks; /* symmetric op driver block */ 3417d1853eeSSam Leffler u_int32_t cs_kblocks; /* symmetric op driver block */ 3427d1853eeSSam Leffler /* 3437d1853eeSSam Leffler * When CRYPTO_TIMING is defined at compile time and the 3447d1853eeSSam Leffler * sysctl debug.crypto is set to 1, the crypto system will 3457d1853eeSSam Leffler * accumulate statistics about how long it takes to process 3467d1853eeSSam Leffler * crypto requests at various points during processing. 3477d1853eeSSam Leffler */ 3487d1853eeSSam Leffler struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */ 3497d1853eeSSam Leffler struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */ 3507d1853eeSSam Leffler struct cryptotstat cs_cb; /* crypto_done -> callback */ 3517d1853eeSSam Leffler struct cryptotstat cs_finis; /* callback -> callback return */ 3527d1853eeSSam Leffler }; 3537d1853eeSSam Leffler 354091d81d1SSam Leffler #ifdef _KERNEL 35508fca7a5SJohn-Mark Gurney 35608fca7a5SJohn-Mark Gurney #if 0 357289b9798SConrad Meyer #define CRYPTDEB(s, ...) do { \ 358289b9798SConrad Meyer printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__); \ 35908fca7a5SJohn-Mark Gurney } while (0) 36008fca7a5SJohn-Mark Gurney #else 361289b9798SConrad Meyer #define CRYPTDEB(...) do { } while (0) 36208fca7a5SJohn-Mark Gurney #endif 36308fca7a5SJohn-Mark Gurney 364091d81d1SSam Leffler /* Standard initialization structure beginning */ 365091d81d1SSam Leffler struct cryptoini { 366091d81d1SSam Leffler int cri_alg; /* Algorithm to use */ 367091d81d1SSam Leffler int cri_klen; /* Key length, in bits */ 368f6c4bc3bSPawel Jakub Dawidek int cri_mlen; /* Number of bytes we want from the 369f6c4bc3bSPawel Jakub Dawidek entire hash. 0 means all. */ 370091d81d1SSam Leffler caddr_t cri_key; /* key to use */ 371091d81d1SSam Leffler u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 372091d81d1SSam Leffler struct cryptoini *cri_next; 373091d81d1SSam Leffler }; 374091d81d1SSam Leffler 375091d81d1SSam Leffler /* Describe boundaries of a single crypto operation */ 376091d81d1SSam Leffler struct cryptodesc { 377091d81d1SSam Leffler int crd_skip; /* How many bytes to ignore from start */ 378091d81d1SSam Leffler int crd_len; /* How many bytes to process */ 379091d81d1SSam Leffler int crd_inject; /* Where to inject results, if applicable */ 380091d81d1SSam Leffler int crd_flags; 381091d81d1SSam Leffler 382091d81d1SSam Leffler #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 383091d81d1SSam Leffler #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 384091d81d1SSam Leffler place, so don't copy. */ 385091d81d1SSam Leffler #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 386091d81d1SSam Leffler #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 387091d81d1SSam Leffler #define CRD_F_COMP 0x0f /* Set when doing compression */ 38808fca7a5SJohn-Mark Gurney #define CRD_F_KEY_EXPLICIT 0x10 /* Key explicitly provided */ 389091d81d1SSam Leffler 390091d81d1SSam Leffler struct cryptoini CRD_INI; /* Initialization/context data */ 39108fca7a5SJohn-Mark Gurney #define crd_esn CRD_INI.cri_esn 392091d81d1SSam Leffler #define crd_iv CRD_INI.cri_iv 393091d81d1SSam Leffler #define crd_key CRD_INI.cri_key 394091d81d1SSam Leffler #define crd_alg CRD_INI.cri_alg 395091d81d1SSam Leffler #define crd_klen CRD_INI.cri_klen 396091d81d1SSam Leffler 397091d81d1SSam Leffler struct cryptodesc *crd_next; 398091d81d1SSam Leffler }; 399091d81d1SSam Leffler 400091d81d1SSam Leffler /* Structure describing complete operation */ 401091d81d1SSam Leffler struct cryptop { 402091d81d1SSam Leffler TAILQ_ENTRY(cryptop) crp_next; 403091d81d1SSam Leffler 40439bbca6fSFabien Thomas struct task crp_task; 40539bbca6fSFabien Thomas 406091d81d1SSam Leffler u_int64_t crp_sid; /* Session ID */ 407091d81d1SSam Leffler int crp_ilen; /* Input data total length */ 408091d81d1SSam Leffler int crp_olen; /* Result total length */ 409091d81d1SSam Leffler 410091d81d1SSam Leffler int crp_etype; /* 411091d81d1SSam Leffler * Error type (zero means no error). 412091d81d1SSam Leffler * All error codes except EAGAIN 413091d81d1SSam Leffler * indicate possible data corruption (as in, 414091d81d1SSam Leffler * the data have been touched). On all 415091d81d1SSam Leffler * errors, the crp_sid may have changed 416091d81d1SSam Leffler * (reset to a new one), so the caller 417091d81d1SSam Leffler * should always check and use the new 418091d81d1SSam Leffler * value on future requests. 419091d81d1SSam Leffler */ 420091d81d1SSam Leffler int crp_flags; 421091d81d1SSam Leffler 422d8409aafSSam Leffler #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */ 423091d81d1SSam Leffler #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 424eb73a605SSam Leffler #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible */ 425eb73a605SSam Leffler #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */ 4263569ae7fSSam Leffler #define CRYPTO_F_DONE 0x0020 /* Operation completed */ 427d8409aafSSam Leffler #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */ 42839bbca6fSFabien Thomas #define CRYPTO_F_ASYNC 0x0080 /* Dispatch crypto jobs on several threads 42939bbca6fSFabien Thomas * if op is synchronous 43039bbca6fSFabien Thomas */ 43139bbca6fSFabien Thomas #define CRYPTO_F_ASYNC_KEEPORDER 0x0100 /* 43239bbca6fSFabien Thomas * Dispatch the crypto jobs in the same 43339bbca6fSFabien Thomas * order there are submitted. Applied only 43439bbca6fSFabien Thomas * if CRYPTO_F_ASYNC flags is set 43539bbca6fSFabien Thomas */ 436091d81d1SSam Leffler 437a296c719SJohn Baldwin union { 438091d81d1SSam Leffler caddr_t crp_buf; /* Data to be processed */ 439a296c719SJohn Baldwin struct mbuf *crp_mbuf; 440a296c719SJohn Baldwin struct uio *crp_uio; 441a296c719SJohn Baldwin }; 442eda08c83SJohn Baldwin void * crp_opaque; /* Opaque pointer, passed along */ 443091d81d1SSam Leffler struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 444091d81d1SSam Leffler 445091d81d1SSam Leffler int (*crp_callback)(struct cryptop *); /* Callback function */ 446091d81d1SSam Leffler 4477d1853eeSSam Leffler struct bintime crp_tstamp; /* performance time stamp */ 44839bbca6fSFabien Thomas uint32_t crp_seq; /* used for ordered dispatch */ 44939bbca6fSFabien Thomas uint32_t crp_retw_id; /* 45039bbca6fSFabien Thomas * the return worker to be used, 45139bbca6fSFabien Thomas * used for ordered dispatch 45239bbca6fSFabien Thomas */ 453091d81d1SSam Leffler }; 454091d81d1SSam Leffler 45539bbca6fSFabien Thomas #define CRYPTOP_ASYNC(crp) \ 45639bbca6fSFabien Thomas (((crp)->crp_flags & CRYPTO_F_ASYNC) && \ 45739bbca6fSFabien Thomas CRYPTO_SESID2CAPS((crp)->crp_sid) & CRYPTOCAP_F_SYNC) 45839bbca6fSFabien Thomas #define CRYPTOP_ASYNC_KEEPORDER(crp) \ 45939bbca6fSFabien Thomas (CRYPTOP_ASYNC(crp) && \ 46039bbca6fSFabien Thomas (crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER) 46139bbca6fSFabien Thomas 462091d81d1SSam Leffler #define CRYPTO_BUF_CONTIG 0x0 463091d81d1SSam Leffler #define CRYPTO_BUF_IOV 0x1 464091d81d1SSam Leffler #define CRYPTO_BUF_MBUF 0x2 465091d81d1SSam Leffler 466091d81d1SSam Leffler #define CRYPTO_OP_DECRYPT 0x0 467091d81d1SSam Leffler #define CRYPTO_OP_ENCRYPT 0x1 468091d81d1SSam Leffler 469091d81d1SSam Leffler /* 470091d81d1SSam Leffler * Hints passed to process methods. 471091d81d1SSam Leffler */ 472091d81d1SSam Leffler #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 473091d81d1SSam Leffler 474091d81d1SSam Leffler struct cryptkop { 475091d81d1SSam Leffler TAILQ_ENTRY(cryptkop) krp_next; 476091d81d1SSam Leffler 477091d81d1SSam Leffler u_int krp_op; /* ie. CRK_MOD_EXP or other */ 478091d81d1SSam Leffler u_int krp_status; /* return status */ 479091d81d1SSam Leffler u_short krp_iparams; /* # of input parameters */ 480091d81d1SSam Leffler u_short krp_oparams; /* # of output parameters */ 4816810ad6fSSam Leffler u_int krp_crid; /* desired device, etc. */ 482091d81d1SSam Leffler u_int32_t krp_hid; 483091d81d1SSam Leffler struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 484091d81d1SSam Leffler int (*krp_callback)(struct cryptkop *); 485091d81d1SSam Leffler }; 486091d81d1SSam Leffler 4873aaf7145SPawel Jakub Dawidek /* 48807d0c94aSSam Leffler * Session ids are 64 bits. The lower 32 bits contain a "local id" which 48907d0c94aSSam Leffler * is a driver-private session identifier. The upper 32 bits contain a 49007d0c94aSSam Leffler * "hardware id" used by the core crypto code to identify the driver and 49107d0c94aSSam Leffler * a copy of the driver's capabilities that can be used by client code to 49207d0c94aSSam Leffler * optimize operation. 49307d0c94aSSam Leffler */ 4946810ad6fSSam Leffler #define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0x00ffffff) 4956810ad6fSSam Leffler #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 32) & 0xff000000) 49607d0c94aSSam Leffler #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff) 49707d0c94aSSam Leffler 498091d81d1SSam Leffler MALLOC_DECLARE(M_CRYPTO_DATA); 499091d81d1SSam Leffler 500091d81d1SSam Leffler extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard); 501091d81d1SSam Leffler extern int crypto_freesession(u_int64_t sid); 5026810ad6fSSam Leffler #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE 5036810ad6fSSam Leffler #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE 5046810ad6fSSam Leffler #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */ 5056810ad6fSSam Leffler extern int32_t crypto_get_driverid(device_t dev, int flags); 5066810ad6fSSam Leffler extern int crypto_find_driver(const char *); 5076810ad6fSSam Leffler extern device_t crypto_find_device_byhid(int hid); 5086810ad6fSSam Leffler extern int crypto_getcaps(int hid); 509091d81d1SSam Leffler extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, 5106810ad6fSSam Leffler u_int32_t flags); 5116810ad6fSSam Leffler extern int crypto_kregister(u_int32_t, int, u_int32_t); 512091d81d1SSam Leffler extern int crypto_unregister(u_int32_t driverid, int alg); 513091d81d1SSam Leffler extern int crypto_unregister_all(u_int32_t driverid); 514091d81d1SSam Leffler extern int crypto_dispatch(struct cryptop *crp); 515091d81d1SSam Leffler extern int crypto_kdispatch(struct cryptkop *); 516091d81d1SSam Leffler #define CRYPTO_SYMQ 0x1 517091d81d1SSam Leffler #define CRYPTO_ASYMQ 0x2 518091d81d1SSam Leffler extern int crypto_unblock(u_int32_t, int); 519091d81d1SSam Leffler extern void crypto_done(struct cryptop *crp); 520091d81d1SSam Leffler extern void crypto_kdone(struct cryptkop *); 521091d81d1SSam Leffler extern int crypto_getfeat(int *); 522091d81d1SSam Leffler 523091d81d1SSam Leffler extern void crypto_freereq(struct cryptop *crp); 524091d81d1SSam Leffler extern struct cryptop *crypto_getreq(int num); 525091d81d1SSam Leffler 526091d81d1SSam Leffler extern int crypto_usercrypto; /* userland may do crypto requests */ 527091d81d1SSam Leffler extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 528091d81d1SSam Leffler extern int crypto_devallowsoft; /* only use hardware crypto */ 529091d81d1SSam Leffler 530091d81d1SSam Leffler /* 531091d81d1SSam Leffler * Crypto-related utility routines used mainly by drivers. 532091d81d1SSam Leffler * 533091d81d1SSam Leffler * XXX these don't really belong here; but for now they're 534091d81d1SSam Leffler * kept apart from the rest of the system. 535091d81d1SSam Leffler */ 536091d81d1SSam Leffler struct uio; 537091d81d1SSam Leffler extern void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp); 5387dd10fdeSJohn Baldwin extern void cuio_copyback(struct uio* uio, int off, int len, c_caddr_t cp); 53908fca7a5SJohn-Mark Gurney extern int cuio_getptr(struct uio *uio, int loc, int *off); 540b5161eb7SPawel Jakub Dawidek extern int cuio_apply(struct uio *uio, int off, int len, 541b5161eb7SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 54211d2e1e8SPawel Jakub Dawidek 54308fca7a5SJohn-Mark Gurney struct mbuf; 54408fca7a5SJohn-Mark Gurney struct iovec; 545748a12e2SJohn-Mark Gurney extern int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr, 54608fca7a5SJohn-Mark Gurney int *cnt, int *allocated); 54708fca7a5SJohn-Mark Gurney 54811d2e1e8SPawel Jakub Dawidek extern void crypto_copyback(int flags, caddr_t buf, int off, int size, 5497dd10fdeSJohn Baldwin c_caddr_t in); 55011d2e1e8SPawel Jakub Dawidek extern void crypto_copydata(int flags, caddr_t buf, int off, int size, 55111d2e1e8SPawel Jakub Dawidek caddr_t out); 55211d2e1e8SPawel Jakub Dawidek extern int crypto_apply(int flags, caddr_t buf, int off, int len, 55311d2e1e8SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 554a296c719SJohn Baldwin 555091d81d1SSam Leffler #endif /* _KERNEL */ 556091d81d1SSam Leffler #endif /* _CRYPTO_CRYPTO_H_ */ 557