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 779ea7e421SPawel Jakub Dawidek #define SHA2_256_HASH_LEN 32 789ea7e421SPawel Jakub Dawidek #define SHA2_384_HASH_LEN 48 799ea7e421SPawel Jakub Dawidek #define SHA2_512_HASH_LEN 64 809ea7e421SPawel Jakub Dawidek #define MD5_KPDK_HASH_LEN 16 819ea7e421SPawel Jakub Dawidek #define SHA1_KPDK_HASH_LEN 20 82a2bc81bfSJohn-Mark Gurney #define AES_GMAC_HASH_LEN 16 830bbc4bf9SPawel Jakub Dawidek /* Maximum hash algorithm result length */ 840bbc4bf9SPawel Jakub Dawidek #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */ 850bbc4bf9SPawel Jakub Dawidek 86091d81d1SSam Leffler /* HMAC values */ 879ea7e421SPawel Jakub Dawidek #define NULL_HMAC_BLOCK_LEN 64 889ea7e421SPawel Jakub Dawidek #define MD5_HMAC_BLOCK_LEN 64 899ea7e421SPawel Jakub Dawidek #define SHA1_HMAC_BLOCK_LEN 64 909ea7e421SPawel Jakub Dawidek #define RIPEMD160_HMAC_BLOCK_LEN 64 919ea7e421SPawel Jakub Dawidek #define SHA2_256_HMAC_BLOCK_LEN 64 929ea7e421SPawel Jakub Dawidek #define SHA2_384_HMAC_BLOCK_LEN 128 939ea7e421SPawel Jakub Dawidek #define SHA2_512_HMAC_BLOCK_LEN 128 94bc58b0ecSPawel Jakub Dawidek /* Maximum HMAC block length */ 95bc58b0ecSPawel Jakub Dawidek #define HMAC_MAX_BLOCK_LEN SHA2_512_HMAC_BLOCK_LEN /* Keep this updated */ 96091d81d1SSam Leffler #define HMAC_IPAD_VAL 0x36 97091d81d1SSam Leffler #define HMAC_OPAD_VAL 0x5C 9816de9ac1SGeorge V. Neville-Neil /* HMAC Key Length */ 99a2bc81bfSJohn-Mark Gurney #define AES_128_GMAC_KEY_LEN 16 100a2bc81bfSJohn-Mark Gurney #define AES_192_GMAC_KEY_LEN 24 101a2bc81bfSJohn-Mark Gurney #define AES_256_GMAC_KEY_LEN 32 102091d81d1SSam Leffler 103091d81d1SSam Leffler /* Encryption algorithm block sizes */ 104a2bc81bfSJohn-Mark Gurney #define NULL_BLOCK_LEN 4 /* IPsec to maintain alignment */ 105091d81d1SSam Leffler #define DES_BLOCK_LEN 8 106091d81d1SSam Leffler #define DES3_BLOCK_LEN 8 107091d81d1SSam Leffler #define BLOWFISH_BLOCK_LEN 8 108091d81d1SSam Leffler #define SKIPJACK_BLOCK_LEN 8 109091d81d1SSam Leffler #define CAST128_BLOCK_LEN 8 110091d81d1SSam Leffler #define RIJNDAEL128_BLOCK_LEN 16 11116de9ac1SGeorge V. Neville-Neil #define AES_BLOCK_LEN 16 112577f7474SJohn-Mark Gurney #define AES_ICM_BLOCK_LEN 1 11316de9ac1SGeorge V. Neville-Neil #define ARC4_BLOCK_LEN 1 114559d3390SGeorge V. Neville-Neil #define CAMELLIA_BLOCK_LEN 16 115*61590291SConrad Meyer #define CHACHA20_NATIVE_BLOCK_LEN 64 116*61590291SConrad Meyer #define EALG_MAX_BLOCK_LEN CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */ 117091d81d1SSam Leffler 11816de9ac1SGeorge V. Neville-Neil /* IV Lengths */ 11916de9ac1SGeorge V. Neville-Neil 12016de9ac1SGeorge V. Neville-Neil #define ARC4_IV_LEN 1 121577f7474SJohn-Mark Gurney #define AES_GCM_IV_LEN 12 12216de9ac1SGeorge V. Neville-Neil #define AES_XTS_IV_LEN 8 12316de9ac1SGeorge V. Neville-Neil #define AES_XTS_ALPHA 0x87 /* GF(2^128) generator polynomial */ 12416de9ac1SGeorge V. Neville-Neil 12516de9ac1SGeorge V. Neville-Neil /* Min and Max Encryption Key Sizes */ 12616de9ac1SGeorge V. Neville-Neil #define NULL_MIN_KEY 0 12716de9ac1SGeorge V. Neville-Neil #define NULL_MAX_KEY 256 /* 2048 bits, max key */ 12816de9ac1SGeorge V. Neville-Neil #define DES_MIN_KEY 8 12916de9ac1SGeorge V. Neville-Neil #define DES_MAX_KEY DES_MIN_KEY 13016de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MIN_KEY 24 13116de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MAX_KEY TRIPLE_DES_MIN_KEY 13216de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MIN_KEY 5 13316de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MAX_KEY 56 /* 448 bits, max key */ 13416de9ac1SGeorge V. Neville-Neil #define CAST_MIN_KEY 5 13516de9ac1SGeorge V. Neville-Neil #define CAST_MAX_KEY 16 13616de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MIN_KEY 10 13716de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MAX_KEY SKIPJACK_MIN_KEY 13816de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MIN_KEY 16 13916de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MAX_KEY 32 140577f7474SJohn-Mark Gurney #define AES_MIN_KEY RIJNDAEL_MIN_KEY 141577f7474SJohn-Mark Gurney #define AES_MAX_KEY RIJNDAEL_MAX_KEY 142577f7474SJohn-Mark Gurney #define AES_XTS_MIN_KEY (2 * AES_MIN_KEY) 143577f7474SJohn-Mark Gurney #define AES_XTS_MAX_KEY (2 * AES_MAX_KEY) 14416de9ac1SGeorge V. Neville-Neil #define ARC4_MIN_KEY 1 14516de9ac1SGeorge V. Neville-Neil #define ARC4_MAX_KEY 32 14616de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MIN_KEY 8 14716de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MAX_KEY 32 14816de9ac1SGeorge V. Neville-Neil 14908fca7a5SJohn-Mark Gurney /* Maximum hash algorithm result length */ 15008fca7a5SJohn-Mark Gurney #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 15108fca7a5SJohn-Mark Gurney 152091d81d1SSam Leffler #define CRYPTO_ALGORITHM_MIN 1 153091d81d1SSam Leffler #define CRYPTO_DES_CBC 1 154091d81d1SSam Leffler #define CRYPTO_3DES_CBC 2 155091d81d1SSam Leffler #define CRYPTO_BLF_CBC 3 156091d81d1SSam Leffler #define CRYPTO_CAST_CBC 4 157091d81d1SSam Leffler #define CRYPTO_SKIPJACK_CBC 5 158091d81d1SSam Leffler #define CRYPTO_MD5_HMAC 6 159091d81d1SSam Leffler #define CRYPTO_SHA1_HMAC 7 160091d81d1SSam Leffler #define CRYPTO_RIPEMD160_HMAC 8 161091d81d1SSam Leffler #define CRYPTO_MD5_KPDK 9 162091d81d1SSam Leffler #define CRYPTO_SHA1_KPDK 10 163091d81d1SSam Leffler #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 164091d81d1SSam Leffler #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 165091d81d1SSam Leffler #define CRYPTO_ARC4 12 166091d81d1SSam Leffler #define CRYPTO_MD5 13 167091d81d1SSam Leffler #define CRYPTO_SHA1 14 168f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_HMAC 15 169f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_CBC 16 170f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */ 171f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_256_HMAC 18 172f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_384_HMAC 19 173f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_512_HMAC 20 174559d3390SGeorge V. Neville-Neil #define CRYPTO_CAMELLIA_CBC 21 175d295bdeeSPawel Jakub Dawidek #define CRYPTO_AES_XTS 22 17608fca7a5SJohn-Mark Gurney #define CRYPTO_AES_ICM 23 /* commonly known as CTR mode */ 17708fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GMAC 24 /* cipher side */ 17808fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GCM_16 25 /* 16 byte ICV */ 17908fca7a5SJohn-Mark Gurney #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */ 18008fca7a5SJohn-Mark Gurney #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */ 18108fca7a5SJohn-Mark Gurney #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */ 1820e33efe4SConrad Meyer #define CRYPTO_BLAKE2B 29 /* Blake2b hash */ 1830e33efe4SConrad Meyer #define CRYPTO_BLAKE2S 30 /* Blake2s hash */ 184*61590291SConrad Meyer #define CRYPTO_CHACHA20 31 /* Chacha20 stream cipher */ 185*61590291SConrad Meyer #define CRYPTO_ALGORITHM_MAX 31 /* Keep updated - see below */ 18608fca7a5SJohn-Mark Gurney 18708fca7a5SJohn-Mark Gurney #define CRYPTO_ALGO_VALID(x) ((x) >= CRYPTO_ALGORITHM_MIN && \ 18808fca7a5SJohn-Mark Gurney (x) <= CRYPTO_ALGORITHM_MAX) 189091d81d1SSam Leffler 190091d81d1SSam Leffler /* Algorithm flags */ 191091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 192091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 193091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 194091d81d1SSam Leffler 1956810ad6fSSam Leffler /* 1966810ad6fSSam Leffler * Crypto driver/device flags. They can set in the crid 1976810ad6fSSam Leffler * parameter when creating a session or submitting a key 1986810ad6fSSam Leffler * op to affect the device/driver assigned. If neither 1996810ad6fSSam Leffler * of these are specified then the crid is assumed to hold 2006810ad6fSSam Leffler * the driver id of an existing (and suitable) device that 2016810ad6fSSam Leffler * must be used to satisfy the request. 2026810ad6fSSam Leffler */ 2036810ad6fSSam Leffler #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */ 2046810ad6fSSam Leffler #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */ 2056810ad6fSSam Leffler 2066810ad6fSSam Leffler /* NB: deprecated */ 207091d81d1SSam Leffler struct session_op { 208091d81d1SSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 209091d81d1SSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 210091d81d1SSam Leffler 211091d81d1SSam Leffler u_int32_t keylen; /* cipher key */ 2127dd10fdeSJohn Baldwin c_caddr_t key; 213091d81d1SSam Leffler int mackeylen; /* mac key */ 2147dd10fdeSJohn Baldwin c_caddr_t mackey; 215091d81d1SSam Leffler 216091d81d1SSam Leffler u_int32_t ses; /* returns: session # */ 217091d81d1SSam Leffler }; 218091d81d1SSam Leffler 2196810ad6fSSam Leffler struct session2_op { 2206810ad6fSSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 2216810ad6fSSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 2226810ad6fSSam Leffler 2236810ad6fSSam Leffler u_int32_t keylen; /* cipher key */ 2247dd10fdeSJohn Baldwin c_caddr_t key; 2256810ad6fSSam Leffler int mackeylen; /* mac key */ 2267dd10fdeSJohn Baldwin c_caddr_t mackey; 2276810ad6fSSam Leffler 2286810ad6fSSam Leffler u_int32_t ses; /* returns: session # */ 2296810ad6fSSam Leffler int crid; /* driver id + flags (rw) */ 2306810ad6fSSam Leffler int pad[4]; /* for future expansion */ 2316810ad6fSSam Leffler }; 2326810ad6fSSam Leffler 233091d81d1SSam Leffler struct crypt_op { 234091d81d1SSam Leffler u_int32_t ses; 235091d81d1SSam Leffler u_int16_t op; /* i.e. COP_ENCRYPT */ 236091d81d1SSam Leffler #define COP_ENCRYPT 1 237091d81d1SSam Leffler #define COP_DECRYPT 2 238eb73a605SSam Leffler u_int16_t flags; 2392c907637SJohn Baldwin #define COP_F_CIPHER_FIRST 0x0001 /* Cipher before MAC. */ 240eb73a605SSam Leffler #define COP_F_BATCH 0x0008 /* Batch op if possible */ 241091d81d1SSam Leffler u_int len; 2427dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2437dd10fdeSJohn Baldwin caddr_t dst; 244091d81d1SSam Leffler caddr_t mac; /* must be big enough for chosen MAC */ 2457dd10fdeSJohn Baldwin c_caddr_t iv; 246091d81d1SSam Leffler }; 247091d81d1SSam Leffler 24808fca7a5SJohn-Mark Gurney /* op and flags the same as crypt_op */ 24908fca7a5SJohn-Mark Gurney struct crypt_aead { 25008fca7a5SJohn-Mark Gurney u_int32_t ses; 25108fca7a5SJohn-Mark Gurney u_int16_t op; /* i.e. COP_ENCRYPT */ 25208fca7a5SJohn-Mark Gurney u_int16_t flags; 25308fca7a5SJohn-Mark Gurney u_int len; 25408fca7a5SJohn-Mark Gurney u_int aadlen; 25508fca7a5SJohn-Mark Gurney u_int ivlen; 2567dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2577dd10fdeSJohn Baldwin caddr_t dst; 2587dd10fdeSJohn Baldwin c_caddr_t aad; /* additional authenticated data */ 25908fca7a5SJohn-Mark Gurney caddr_t tag; /* must fit for chosen TAG length */ 2607dd10fdeSJohn Baldwin c_caddr_t iv; 26108fca7a5SJohn-Mark Gurney }; 26208fca7a5SJohn-Mark Gurney 2636810ad6fSSam Leffler /* 2646810ad6fSSam Leffler * Parameters for looking up a crypto driver/device by 2656810ad6fSSam Leffler * device name or by id. The latter are returned for 2666810ad6fSSam Leffler * created sessions (crid) and completed key operations. 2676810ad6fSSam Leffler */ 2686810ad6fSSam Leffler struct crypt_find_op { 2696810ad6fSSam Leffler int crid; /* driver id + flags */ 2706810ad6fSSam Leffler char name[32]; /* device/driver name */ 2716810ad6fSSam Leffler }; 2726810ad6fSSam Leffler 273091d81d1SSam Leffler /* bignum parameter, in packed bytes, ... */ 274091d81d1SSam Leffler struct crparam { 275091d81d1SSam Leffler caddr_t crp_p; 276091d81d1SSam Leffler u_int crp_nbits; 277091d81d1SSam Leffler }; 278091d81d1SSam Leffler 279091d81d1SSam Leffler #define CRK_MAXPARAM 8 280091d81d1SSam Leffler 281091d81d1SSam Leffler struct crypt_kop { 282091d81d1SSam Leffler u_int crk_op; /* ie. CRK_MOD_EXP or other */ 283091d81d1SSam Leffler u_int crk_status; /* return status */ 284091d81d1SSam Leffler u_short crk_iparams; /* # of input parameters */ 285091d81d1SSam Leffler u_short crk_oparams; /* # of output parameters */ 2866810ad6fSSam Leffler u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */ 287091d81d1SSam Leffler struct crparam crk_param[CRK_MAXPARAM]; 288091d81d1SSam Leffler }; 289091d81d1SSam Leffler #define CRK_ALGORITM_MIN 0 290091d81d1SSam Leffler #define CRK_MOD_EXP 0 291091d81d1SSam Leffler #define CRK_MOD_EXP_CRT 1 292091d81d1SSam Leffler #define CRK_DSA_SIGN 2 293091d81d1SSam Leffler #define CRK_DSA_VERIFY 3 294091d81d1SSam Leffler #define CRK_DH_COMPUTE_KEY 4 295091d81d1SSam Leffler #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */ 296091d81d1SSam Leffler 297091d81d1SSam Leffler #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 298091d81d1SSam Leffler #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 299091d81d1SSam Leffler #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 300091d81d1SSam Leffler #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 301091d81d1SSam Leffler #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 302091d81d1SSam Leffler 303091d81d1SSam Leffler /* 304091d81d1SSam Leffler * done against open of /dev/crypto, to get a cloned descriptor. 305091d81d1SSam Leffler * Please use F_SETFD against the cloned descriptor. 306091d81d1SSam Leffler */ 307091d81d1SSam Leffler #define CRIOGET _IOWR('c', 100, u_int32_t) 3086810ad6fSSam Leffler #define CRIOASYMFEAT CIOCASYMFEAT 3096810ad6fSSam Leffler #define CRIOFINDDEV CIOCFINDDEV 310091d81d1SSam Leffler 311091d81d1SSam Leffler /* the following are done against the cloned descriptor */ 312091d81d1SSam Leffler #define CIOCGSESSION _IOWR('c', 101, struct session_op) 313091d81d1SSam Leffler #define CIOCFSESSION _IOW('c', 102, u_int32_t) 314091d81d1SSam Leffler #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) 315091d81d1SSam Leffler #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 316091d81d1SSam Leffler #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 3176810ad6fSSam Leffler #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op) 3186810ad6fSSam Leffler #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop) 3196810ad6fSSam Leffler #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op) 32008fca7a5SJohn-Mark Gurney #define CIOCCRYPTAEAD _IOWR('c', 109, struct crypt_aead) 321091d81d1SSam Leffler 3227d1853eeSSam Leffler struct cryptotstat { 3237d1853eeSSam Leffler struct timespec acc; /* total accumulated time */ 3247d1853eeSSam Leffler struct timespec min; /* min time */ 3257d1853eeSSam Leffler struct timespec max; /* max time */ 3267d1853eeSSam Leffler u_int32_t count; /* number of observations */ 3277d1853eeSSam Leffler }; 3287d1853eeSSam Leffler 3297d1853eeSSam Leffler struct cryptostats { 3307d1853eeSSam Leffler u_int32_t cs_ops; /* symmetric crypto ops submitted */ 3317d1853eeSSam Leffler u_int32_t cs_errs; /* symmetric crypto ops that failed */ 3327d1853eeSSam Leffler u_int32_t cs_kops; /* asymetric/key ops submitted */ 3337d1853eeSSam Leffler u_int32_t cs_kerrs; /* asymetric/key ops that failed */ 3347d1853eeSSam Leffler u_int32_t cs_intrs; /* crypto swi thread activations */ 3357d1853eeSSam Leffler u_int32_t cs_rets; /* crypto return thread activations */ 3367d1853eeSSam Leffler u_int32_t cs_blocks; /* symmetric op driver block */ 3377d1853eeSSam Leffler u_int32_t cs_kblocks; /* symmetric op driver block */ 3387d1853eeSSam Leffler /* 3397d1853eeSSam Leffler * When CRYPTO_TIMING is defined at compile time and the 3407d1853eeSSam Leffler * sysctl debug.crypto is set to 1, the crypto system will 3417d1853eeSSam Leffler * accumulate statistics about how long it takes to process 3427d1853eeSSam Leffler * crypto requests at various points during processing. 3437d1853eeSSam Leffler */ 3447d1853eeSSam Leffler struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */ 3457d1853eeSSam Leffler struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */ 3467d1853eeSSam Leffler struct cryptotstat cs_cb; /* crypto_done -> callback */ 3477d1853eeSSam Leffler struct cryptotstat cs_finis; /* callback -> callback return */ 3487d1853eeSSam Leffler }; 3497d1853eeSSam Leffler 350091d81d1SSam Leffler #ifdef _KERNEL 35108fca7a5SJohn-Mark Gurney 35208fca7a5SJohn-Mark Gurney #if 0 353289b9798SConrad Meyer #define CRYPTDEB(s, ...) do { \ 354289b9798SConrad Meyer printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__); \ 35508fca7a5SJohn-Mark Gurney } while (0) 35608fca7a5SJohn-Mark Gurney #else 357289b9798SConrad Meyer #define CRYPTDEB(...) do { } while (0) 35808fca7a5SJohn-Mark Gurney #endif 35908fca7a5SJohn-Mark Gurney 360091d81d1SSam Leffler /* Standard initialization structure beginning */ 361091d81d1SSam Leffler struct cryptoini { 362091d81d1SSam Leffler int cri_alg; /* Algorithm to use */ 363091d81d1SSam Leffler int cri_klen; /* Key length, in bits */ 364f6c4bc3bSPawel Jakub Dawidek int cri_mlen; /* Number of bytes we want from the 365f6c4bc3bSPawel Jakub Dawidek entire hash. 0 means all. */ 366091d81d1SSam Leffler caddr_t cri_key; /* key to use */ 367091d81d1SSam Leffler u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 368091d81d1SSam Leffler struct cryptoini *cri_next; 369091d81d1SSam Leffler }; 370091d81d1SSam Leffler 371091d81d1SSam Leffler /* Describe boundaries of a single crypto operation */ 372091d81d1SSam Leffler struct cryptodesc { 373091d81d1SSam Leffler int crd_skip; /* How many bytes to ignore from start */ 374091d81d1SSam Leffler int crd_len; /* How many bytes to process */ 375091d81d1SSam Leffler int crd_inject; /* Where to inject results, if applicable */ 376091d81d1SSam Leffler int crd_flags; 377091d81d1SSam Leffler 378091d81d1SSam Leffler #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 379091d81d1SSam Leffler #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 380091d81d1SSam Leffler place, so don't copy. */ 381091d81d1SSam Leffler #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 382091d81d1SSam Leffler #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 383091d81d1SSam Leffler #define CRD_F_COMP 0x0f /* Set when doing compression */ 38408fca7a5SJohn-Mark Gurney #define CRD_F_KEY_EXPLICIT 0x10 /* Key explicitly provided */ 385091d81d1SSam Leffler 386091d81d1SSam Leffler struct cryptoini CRD_INI; /* Initialization/context data */ 38708fca7a5SJohn-Mark Gurney #define crd_esn CRD_INI.cri_esn 388091d81d1SSam Leffler #define crd_iv CRD_INI.cri_iv 389091d81d1SSam Leffler #define crd_key CRD_INI.cri_key 390091d81d1SSam Leffler #define crd_alg CRD_INI.cri_alg 391091d81d1SSam Leffler #define crd_klen CRD_INI.cri_klen 392091d81d1SSam Leffler 393091d81d1SSam Leffler struct cryptodesc *crd_next; 394091d81d1SSam Leffler }; 395091d81d1SSam Leffler 396091d81d1SSam Leffler /* Structure describing complete operation */ 397091d81d1SSam Leffler struct cryptop { 398091d81d1SSam Leffler TAILQ_ENTRY(cryptop) crp_next; 399091d81d1SSam Leffler 40039bbca6fSFabien Thomas struct task crp_task; 40139bbca6fSFabien Thomas 402091d81d1SSam Leffler u_int64_t crp_sid; /* Session ID */ 403091d81d1SSam Leffler int crp_ilen; /* Input data total length */ 404091d81d1SSam Leffler int crp_olen; /* Result total length */ 405091d81d1SSam Leffler 406091d81d1SSam Leffler int crp_etype; /* 407091d81d1SSam Leffler * Error type (zero means no error). 408091d81d1SSam Leffler * All error codes except EAGAIN 409091d81d1SSam Leffler * indicate possible data corruption (as in, 410091d81d1SSam Leffler * the data have been touched). On all 411091d81d1SSam Leffler * errors, the crp_sid may have changed 412091d81d1SSam Leffler * (reset to a new one), so the caller 413091d81d1SSam Leffler * should always check and use the new 414091d81d1SSam Leffler * value on future requests. 415091d81d1SSam Leffler */ 416091d81d1SSam Leffler int crp_flags; 417091d81d1SSam Leffler 418d8409aafSSam Leffler #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */ 419091d81d1SSam Leffler #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 420eb73a605SSam Leffler #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible */ 421eb73a605SSam Leffler #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */ 4223569ae7fSSam Leffler #define CRYPTO_F_DONE 0x0020 /* Operation completed */ 423d8409aafSSam Leffler #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */ 42439bbca6fSFabien Thomas #define CRYPTO_F_ASYNC 0x0080 /* Dispatch crypto jobs on several threads 42539bbca6fSFabien Thomas * if op is synchronous 42639bbca6fSFabien Thomas */ 42739bbca6fSFabien Thomas #define CRYPTO_F_ASYNC_KEEPORDER 0x0100 /* 42839bbca6fSFabien Thomas * Dispatch the crypto jobs in the same 42939bbca6fSFabien Thomas * order there are submitted. Applied only 43039bbca6fSFabien Thomas * if CRYPTO_F_ASYNC flags is set 43139bbca6fSFabien Thomas */ 432091d81d1SSam Leffler 433a296c719SJohn Baldwin union { 434091d81d1SSam Leffler caddr_t crp_buf; /* Data to be processed */ 435a296c719SJohn Baldwin struct mbuf *crp_mbuf; 436a296c719SJohn Baldwin struct uio *crp_uio; 437a296c719SJohn Baldwin }; 438eda08c83SJohn Baldwin void * crp_opaque; /* Opaque pointer, passed along */ 439091d81d1SSam Leffler struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 440091d81d1SSam Leffler 441091d81d1SSam Leffler int (*crp_callback)(struct cryptop *); /* Callback function */ 442091d81d1SSam Leffler 4437d1853eeSSam Leffler struct bintime crp_tstamp; /* performance time stamp */ 44439bbca6fSFabien Thomas uint32_t crp_seq; /* used for ordered dispatch */ 44539bbca6fSFabien Thomas uint32_t crp_retw_id; /* 44639bbca6fSFabien Thomas * the return worker to be used, 44739bbca6fSFabien Thomas * used for ordered dispatch 44839bbca6fSFabien Thomas */ 449091d81d1SSam Leffler }; 450091d81d1SSam Leffler 45139bbca6fSFabien Thomas #define CRYPTOP_ASYNC(crp) \ 45239bbca6fSFabien Thomas (((crp)->crp_flags & CRYPTO_F_ASYNC) && \ 45339bbca6fSFabien Thomas CRYPTO_SESID2CAPS((crp)->crp_sid) & CRYPTOCAP_F_SYNC) 45439bbca6fSFabien Thomas #define CRYPTOP_ASYNC_KEEPORDER(crp) \ 45539bbca6fSFabien Thomas (CRYPTOP_ASYNC(crp) && \ 45639bbca6fSFabien Thomas (crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER) 45739bbca6fSFabien Thomas 458091d81d1SSam Leffler #define CRYPTO_BUF_CONTIG 0x0 459091d81d1SSam Leffler #define CRYPTO_BUF_IOV 0x1 460091d81d1SSam Leffler #define CRYPTO_BUF_MBUF 0x2 461091d81d1SSam Leffler 462091d81d1SSam Leffler #define CRYPTO_OP_DECRYPT 0x0 463091d81d1SSam Leffler #define CRYPTO_OP_ENCRYPT 0x1 464091d81d1SSam Leffler 465091d81d1SSam Leffler /* 466091d81d1SSam Leffler * Hints passed to process methods. 467091d81d1SSam Leffler */ 468091d81d1SSam Leffler #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 469091d81d1SSam Leffler 470091d81d1SSam Leffler struct cryptkop { 471091d81d1SSam Leffler TAILQ_ENTRY(cryptkop) krp_next; 472091d81d1SSam Leffler 473091d81d1SSam Leffler u_int krp_op; /* ie. CRK_MOD_EXP or other */ 474091d81d1SSam Leffler u_int krp_status; /* return status */ 475091d81d1SSam Leffler u_short krp_iparams; /* # of input parameters */ 476091d81d1SSam Leffler u_short krp_oparams; /* # of output parameters */ 4776810ad6fSSam Leffler u_int krp_crid; /* desired device, etc. */ 478091d81d1SSam Leffler u_int32_t krp_hid; 479091d81d1SSam Leffler struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 480091d81d1SSam Leffler int (*krp_callback)(struct cryptkop *); 481091d81d1SSam Leffler }; 482091d81d1SSam Leffler 4833aaf7145SPawel Jakub Dawidek /* 48407d0c94aSSam Leffler * Session ids are 64 bits. The lower 32 bits contain a "local id" which 48507d0c94aSSam Leffler * is a driver-private session identifier. The upper 32 bits contain a 48607d0c94aSSam Leffler * "hardware id" used by the core crypto code to identify the driver and 48707d0c94aSSam Leffler * a copy of the driver's capabilities that can be used by client code to 48807d0c94aSSam Leffler * optimize operation. 48907d0c94aSSam Leffler */ 4906810ad6fSSam Leffler #define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0x00ffffff) 4916810ad6fSSam Leffler #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 32) & 0xff000000) 49207d0c94aSSam Leffler #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff) 49307d0c94aSSam Leffler 494091d81d1SSam Leffler MALLOC_DECLARE(M_CRYPTO_DATA); 495091d81d1SSam Leffler 496091d81d1SSam Leffler extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard); 497091d81d1SSam Leffler extern int crypto_freesession(u_int64_t sid); 4986810ad6fSSam Leffler #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE 4996810ad6fSSam Leffler #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE 5006810ad6fSSam Leffler #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */ 5016810ad6fSSam Leffler extern int32_t crypto_get_driverid(device_t dev, int flags); 5026810ad6fSSam Leffler extern int crypto_find_driver(const char *); 5036810ad6fSSam Leffler extern device_t crypto_find_device_byhid(int hid); 5046810ad6fSSam Leffler extern int crypto_getcaps(int hid); 505091d81d1SSam Leffler extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, 5066810ad6fSSam Leffler u_int32_t flags); 5076810ad6fSSam Leffler extern int crypto_kregister(u_int32_t, int, u_int32_t); 508091d81d1SSam Leffler extern int crypto_unregister(u_int32_t driverid, int alg); 509091d81d1SSam Leffler extern int crypto_unregister_all(u_int32_t driverid); 510091d81d1SSam Leffler extern int crypto_dispatch(struct cryptop *crp); 511091d81d1SSam Leffler extern int crypto_kdispatch(struct cryptkop *); 512091d81d1SSam Leffler #define CRYPTO_SYMQ 0x1 513091d81d1SSam Leffler #define CRYPTO_ASYMQ 0x2 514091d81d1SSam Leffler extern int crypto_unblock(u_int32_t, int); 515091d81d1SSam Leffler extern void crypto_done(struct cryptop *crp); 516091d81d1SSam Leffler extern void crypto_kdone(struct cryptkop *); 517091d81d1SSam Leffler extern int crypto_getfeat(int *); 518091d81d1SSam Leffler 519091d81d1SSam Leffler extern void crypto_freereq(struct cryptop *crp); 520091d81d1SSam Leffler extern struct cryptop *crypto_getreq(int num); 521091d81d1SSam Leffler 522091d81d1SSam Leffler extern int crypto_usercrypto; /* userland may do crypto requests */ 523091d81d1SSam Leffler extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 524091d81d1SSam Leffler extern int crypto_devallowsoft; /* only use hardware crypto */ 525091d81d1SSam Leffler 526091d81d1SSam Leffler /* 527091d81d1SSam Leffler * Crypto-related utility routines used mainly by drivers. 528091d81d1SSam Leffler * 529091d81d1SSam Leffler * XXX these don't really belong here; but for now they're 530091d81d1SSam Leffler * kept apart from the rest of the system. 531091d81d1SSam Leffler */ 532091d81d1SSam Leffler struct uio; 533091d81d1SSam Leffler extern void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp); 5347dd10fdeSJohn Baldwin extern void cuio_copyback(struct uio* uio, int off, int len, c_caddr_t cp); 53508fca7a5SJohn-Mark Gurney extern int cuio_getptr(struct uio *uio, int loc, int *off); 536b5161eb7SPawel Jakub Dawidek extern int cuio_apply(struct uio *uio, int off, int len, 537b5161eb7SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 53811d2e1e8SPawel Jakub Dawidek 53908fca7a5SJohn-Mark Gurney struct mbuf; 54008fca7a5SJohn-Mark Gurney struct iovec; 541748a12e2SJohn-Mark Gurney extern int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr, 54208fca7a5SJohn-Mark Gurney int *cnt, int *allocated); 54308fca7a5SJohn-Mark Gurney 54411d2e1e8SPawel Jakub Dawidek extern void crypto_copyback(int flags, caddr_t buf, int off, int size, 5457dd10fdeSJohn Baldwin c_caddr_t in); 54611d2e1e8SPawel Jakub Dawidek extern void crypto_copydata(int flags, caddr_t buf, int off, int size, 54711d2e1e8SPawel Jakub Dawidek caddr_t out); 54811d2e1e8SPawel Jakub Dawidek extern int crypto_apply(int flags, caddr_t buf, int off, int len, 54911d2e1e8SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 550a296c719SJohn Baldwin 551091d81d1SSam Leffler #endif /* _KERNEL */ 552091d81d1SSam Leffler #endif /* _CRYPTO_CRYPTO_H_ */ 553