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 682e08e39fSConrad Meyer #ifdef _KERNEL 692e08e39fSConrad Meyer #include <opencrypto/_cryptodev.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 880bbc4bf9SPawel Jakub Dawidek /* Maximum hash algorithm result length */ 890bbc4bf9SPawel Jakub Dawidek #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */ 900bbc4bf9SPawel Jakub Dawidek 91590adc1bSConrad Meyer #define MD5_BLOCK_LEN 64 92590adc1bSConrad Meyer #define SHA1_BLOCK_LEN 64 93590adc1bSConrad Meyer #define RIPEMD160_BLOCK_LEN 64 94c97f39ceSConrad Meyer #define SHA2_224_BLOCK_LEN 64 95590adc1bSConrad Meyer #define SHA2_256_BLOCK_LEN 64 96590adc1bSConrad Meyer #define SHA2_384_BLOCK_LEN 128 97590adc1bSConrad Meyer #define SHA2_512_BLOCK_LEN 128 98590adc1bSConrad Meyer 99091d81d1SSam Leffler /* HMAC values */ 1009ea7e421SPawel Jakub Dawidek #define NULL_HMAC_BLOCK_LEN 64 101bc58b0ecSPawel Jakub Dawidek /* Maximum HMAC block length */ 102590adc1bSConrad Meyer #define HMAC_MAX_BLOCK_LEN SHA2_512_BLOCK_LEN /* Keep this updated */ 103091d81d1SSam Leffler #define HMAC_IPAD_VAL 0x36 104091d81d1SSam Leffler #define HMAC_OPAD_VAL 0x5C 10516de9ac1SGeorge V. Neville-Neil /* HMAC Key Length */ 106a2bc81bfSJohn-Mark Gurney #define AES_128_GMAC_KEY_LEN 16 107a2bc81bfSJohn-Mark Gurney #define AES_192_GMAC_KEY_LEN 24 108a2bc81bfSJohn-Mark Gurney #define AES_256_GMAC_KEY_LEN 32 109091d81d1SSam Leffler 110091d81d1SSam Leffler /* Encryption algorithm block sizes */ 111a2bc81bfSJohn-Mark Gurney #define NULL_BLOCK_LEN 4 /* IPsec to maintain alignment */ 112091d81d1SSam Leffler #define DES_BLOCK_LEN 8 113091d81d1SSam Leffler #define DES3_BLOCK_LEN 8 114091d81d1SSam Leffler #define BLOWFISH_BLOCK_LEN 8 115091d81d1SSam Leffler #define SKIPJACK_BLOCK_LEN 8 116091d81d1SSam Leffler #define CAST128_BLOCK_LEN 8 117091d81d1SSam Leffler #define RIJNDAEL128_BLOCK_LEN 16 11816de9ac1SGeorge V. Neville-Neil #define AES_BLOCK_LEN 16 119577f7474SJohn-Mark Gurney #define AES_ICM_BLOCK_LEN 1 12016de9ac1SGeorge V. Neville-Neil #define ARC4_BLOCK_LEN 1 121559d3390SGeorge V. Neville-Neil #define CAMELLIA_BLOCK_LEN 16 12261590291SConrad Meyer #define CHACHA20_NATIVE_BLOCK_LEN 64 12361590291SConrad Meyer #define EALG_MAX_BLOCK_LEN CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */ 124091d81d1SSam Leffler 12516de9ac1SGeorge V. Neville-Neil /* IV Lengths */ 12616de9ac1SGeorge V. Neville-Neil 12716de9ac1SGeorge V. Neville-Neil #define ARC4_IV_LEN 1 128577f7474SJohn-Mark Gurney #define AES_GCM_IV_LEN 12 12916de9ac1SGeorge V. Neville-Neil #define AES_XTS_IV_LEN 8 13016de9ac1SGeorge V. Neville-Neil #define AES_XTS_ALPHA 0x87 /* GF(2^128) generator polynomial */ 13116de9ac1SGeorge V. Neville-Neil 13216de9ac1SGeorge V. Neville-Neil /* Min and Max Encryption Key Sizes */ 13316de9ac1SGeorge V. Neville-Neil #define NULL_MIN_KEY 0 13416de9ac1SGeorge V. Neville-Neil #define NULL_MAX_KEY 256 /* 2048 bits, max key */ 13516de9ac1SGeorge V. Neville-Neil #define DES_MIN_KEY 8 13616de9ac1SGeorge V. Neville-Neil #define DES_MAX_KEY DES_MIN_KEY 13716de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MIN_KEY 24 13816de9ac1SGeorge V. Neville-Neil #define TRIPLE_DES_MAX_KEY TRIPLE_DES_MIN_KEY 13916de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MIN_KEY 5 14016de9ac1SGeorge V. Neville-Neil #define BLOWFISH_MAX_KEY 56 /* 448 bits, max key */ 14116de9ac1SGeorge V. Neville-Neil #define CAST_MIN_KEY 5 14216de9ac1SGeorge V. Neville-Neil #define CAST_MAX_KEY 16 14316de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MIN_KEY 10 14416de9ac1SGeorge V. Neville-Neil #define SKIPJACK_MAX_KEY SKIPJACK_MIN_KEY 14516de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MIN_KEY 16 14616de9ac1SGeorge V. Neville-Neil #define RIJNDAEL_MAX_KEY 32 147577f7474SJohn-Mark Gurney #define AES_MIN_KEY RIJNDAEL_MIN_KEY 148577f7474SJohn-Mark Gurney #define AES_MAX_KEY RIJNDAEL_MAX_KEY 149577f7474SJohn-Mark Gurney #define AES_XTS_MIN_KEY (2 * AES_MIN_KEY) 150577f7474SJohn-Mark Gurney #define AES_XTS_MAX_KEY (2 * AES_MAX_KEY) 15116de9ac1SGeorge V. Neville-Neil #define ARC4_MIN_KEY 1 15216de9ac1SGeorge V. Neville-Neil #define ARC4_MAX_KEY 32 15316de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MIN_KEY 8 15416de9ac1SGeorge V. Neville-Neil #define CAMELLIA_MAX_KEY 32 15516de9ac1SGeorge V. Neville-Neil 15608fca7a5SJohn-Mark Gurney /* Maximum hash algorithm result length */ 15708fca7a5SJohn-Mark Gurney #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 15808fca7a5SJohn-Mark Gurney 159091d81d1SSam Leffler #define CRYPTO_ALGORITHM_MIN 1 160091d81d1SSam Leffler #define CRYPTO_DES_CBC 1 161091d81d1SSam Leffler #define CRYPTO_3DES_CBC 2 162091d81d1SSam Leffler #define CRYPTO_BLF_CBC 3 163091d81d1SSam Leffler #define CRYPTO_CAST_CBC 4 164091d81d1SSam Leffler #define CRYPTO_SKIPJACK_CBC 5 165091d81d1SSam Leffler #define CRYPTO_MD5_HMAC 6 166091d81d1SSam Leffler #define CRYPTO_SHA1_HMAC 7 167091d81d1SSam Leffler #define CRYPTO_RIPEMD160_HMAC 8 168091d81d1SSam Leffler #define CRYPTO_MD5_KPDK 9 169091d81d1SSam Leffler #define CRYPTO_SHA1_KPDK 10 170091d81d1SSam Leffler #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 171091d81d1SSam Leffler #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 172091d81d1SSam Leffler #define CRYPTO_ARC4 12 173091d81d1SSam Leffler #define CRYPTO_MD5 13 174091d81d1SSam Leffler #define CRYPTO_SHA1 14 175f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_HMAC 15 176f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_NULL_CBC 16 177f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */ 178f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_256_HMAC 18 179f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_384_HMAC 19 180f6c4bc3bSPawel Jakub Dawidek #define CRYPTO_SHA2_512_HMAC 20 181559d3390SGeorge V. Neville-Neil #define CRYPTO_CAMELLIA_CBC 21 182d295bdeeSPawel Jakub Dawidek #define CRYPTO_AES_XTS 22 18308fca7a5SJohn-Mark Gurney #define CRYPTO_AES_ICM 23 /* commonly known as CTR mode */ 18408fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GMAC 24 /* cipher side */ 18508fca7a5SJohn-Mark Gurney #define CRYPTO_AES_NIST_GCM_16 25 /* 16 byte ICV */ 18608fca7a5SJohn-Mark Gurney #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */ 18708fca7a5SJohn-Mark Gurney #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */ 18808fca7a5SJohn-Mark Gurney #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */ 1890e33efe4SConrad Meyer #define CRYPTO_BLAKE2B 29 /* Blake2b hash */ 1900e33efe4SConrad Meyer #define CRYPTO_BLAKE2S 30 /* Blake2s hash */ 19161590291SConrad Meyer #define CRYPTO_CHACHA20 31 /* Chacha20 stream cipher */ 192c97f39ceSConrad Meyer #define CRYPTO_SHA2_224_HMAC 32 193c4729f6eSConrad Meyer #define CRYPTO_RIPEMD160 33 194c4729f6eSConrad Meyer #define CRYPTO_SHA2_224 34 195c4729f6eSConrad Meyer #define CRYPTO_SHA2_256 35 196c4729f6eSConrad Meyer #define CRYPTO_SHA2_384 36 197c4729f6eSConrad Meyer #define CRYPTO_SHA2_512 37 198c4729f6eSConrad Meyer #define CRYPTO_ALGORITHM_MAX 37 /* Keep updated - see below */ 19908fca7a5SJohn-Mark Gurney 20008fca7a5SJohn-Mark Gurney #define CRYPTO_ALGO_VALID(x) ((x) >= CRYPTO_ALGORITHM_MIN && \ 20108fca7a5SJohn-Mark Gurney (x) <= CRYPTO_ALGORITHM_MAX) 202091d81d1SSam Leffler 203091d81d1SSam Leffler /* Algorithm flags */ 204091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 205091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 206091d81d1SSam Leffler #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 207091d81d1SSam Leffler 2086810ad6fSSam Leffler /* 2096810ad6fSSam Leffler * Crypto driver/device flags. They can set in the crid 2106810ad6fSSam Leffler * parameter when creating a session or submitting a key 2116810ad6fSSam Leffler * op to affect the device/driver assigned. If neither 2126810ad6fSSam Leffler * of these are specified then the crid is assumed to hold 2136810ad6fSSam Leffler * the driver id of an existing (and suitable) device that 2146810ad6fSSam Leffler * must be used to satisfy the request. 2156810ad6fSSam Leffler */ 2166810ad6fSSam Leffler #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */ 2176810ad6fSSam Leffler #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */ 2186810ad6fSSam Leffler 2196810ad6fSSam Leffler /* NB: deprecated */ 220091d81d1SSam Leffler struct session_op { 221091d81d1SSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 222091d81d1SSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 223091d81d1SSam Leffler 224091d81d1SSam Leffler u_int32_t keylen; /* cipher key */ 2257dd10fdeSJohn Baldwin c_caddr_t key; 226091d81d1SSam Leffler int mackeylen; /* mac key */ 2277dd10fdeSJohn Baldwin c_caddr_t mackey; 228091d81d1SSam Leffler 229091d81d1SSam Leffler u_int32_t ses; /* returns: session # */ 230091d81d1SSam Leffler }; 231091d81d1SSam Leffler 232*1b0909d5SConrad Meyer /* 233*1b0909d5SConrad Meyer * session and crypt _op structs are used by userspace programs to interact 234*1b0909d5SConrad Meyer * with /dev/crypto. Confusingly, the internal kernel interface is named 235*1b0909d5SConrad Meyer * "cryptop" (no underscore). 236*1b0909d5SConrad Meyer */ 2376810ad6fSSam Leffler struct session2_op { 2386810ad6fSSam Leffler u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 2396810ad6fSSam Leffler u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 2406810ad6fSSam Leffler 2416810ad6fSSam Leffler u_int32_t keylen; /* cipher key */ 2427dd10fdeSJohn Baldwin c_caddr_t key; 2436810ad6fSSam Leffler int mackeylen; /* mac key */ 2447dd10fdeSJohn Baldwin c_caddr_t mackey; 2456810ad6fSSam Leffler 2466810ad6fSSam Leffler u_int32_t ses; /* returns: session # */ 2476810ad6fSSam Leffler int crid; /* driver id + flags (rw) */ 2486810ad6fSSam Leffler int pad[4]; /* for future expansion */ 2496810ad6fSSam Leffler }; 2506810ad6fSSam Leffler 251091d81d1SSam Leffler struct crypt_op { 252091d81d1SSam Leffler u_int32_t ses; 253091d81d1SSam Leffler u_int16_t op; /* i.e. COP_ENCRYPT */ 254091d81d1SSam Leffler #define COP_ENCRYPT 1 255091d81d1SSam Leffler #define COP_DECRYPT 2 256eb73a605SSam Leffler u_int16_t flags; 2572c907637SJohn Baldwin #define COP_F_CIPHER_FIRST 0x0001 /* Cipher before MAC. */ 258eb73a605SSam Leffler #define COP_F_BATCH 0x0008 /* Batch op if possible */ 259091d81d1SSam Leffler u_int len; 2607dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2617dd10fdeSJohn Baldwin caddr_t dst; 262091d81d1SSam Leffler caddr_t mac; /* must be big enough for chosen MAC */ 2637dd10fdeSJohn Baldwin c_caddr_t iv; 264091d81d1SSam Leffler }; 265091d81d1SSam Leffler 26608fca7a5SJohn-Mark Gurney /* op and flags the same as crypt_op */ 26708fca7a5SJohn-Mark Gurney struct crypt_aead { 26808fca7a5SJohn-Mark Gurney u_int32_t ses; 26908fca7a5SJohn-Mark Gurney u_int16_t op; /* i.e. COP_ENCRYPT */ 27008fca7a5SJohn-Mark Gurney u_int16_t flags; 27108fca7a5SJohn-Mark Gurney u_int len; 27208fca7a5SJohn-Mark Gurney u_int aadlen; 27308fca7a5SJohn-Mark Gurney u_int ivlen; 2747dd10fdeSJohn Baldwin c_caddr_t src; /* become iov[] inside kernel */ 2757dd10fdeSJohn Baldwin caddr_t dst; 2767dd10fdeSJohn Baldwin c_caddr_t aad; /* additional authenticated data */ 27708fca7a5SJohn-Mark Gurney caddr_t tag; /* must fit for chosen TAG length */ 2787dd10fdeSJohn Baldwin c_caddr_t iv; 27908fca7a5SJohn-Mark Gurney }; 28008fca7a5SJohn-Mark Gurney 2816810ad6fSSam Leffler /* 2826810ad6fSSam Leffler * Parameters for looking up a crypto driver/device by 2836810ad6fSSam Leffler * device name or by id. The latter are returned for 2846810ad6fSSam Leffler * created sessions (crid) and completed key operations. 2856810ad6fSSam Leffler */ 2866810ad6fSSam Leffler struct crypt_find_op { 2876810ad6fSSam Leffler int crid; /* driver id + flags */ 2886810ad6fSSam Leffler char name[32]; /* device/driver name */ 2896810ad6fSSam Leffler }; 2906810ad6fSSam Leffler 291091d81d1SSam Leffler /* bignum parameter, in packed bytes, ... */ 292091d81d1SSam Leffler struct crparam { 293091d81d1SSam Leffler caddr_t crp_p; 294091d81d1SSam Leffler u_int crp_nbits; 295091d81d1SSam Leffler }; 296091d81d1SSam Leffler 297091d81d1SSam Leffler #define CRK_MAXPARAM 8 298091d81d1SSam Leffler 299091d81d1SSam Leffler struct crypt_kop { 300091d81d1SSam Leffler u_int crk_op; /* ie. CRK_MOD_EXP or other */ 301091d81d1SSam Leffler u_int crk_status; /* return status */ 302091d81d1SSam Leffler u_short crk_iparams; /* # of input parameters */ 303091d81d1SSam Leffler u_short crk_oparams; /* # of output parameters */ 3046810ad6fSSam Leffler u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */ 305091d81d1SSam Leffler struct crparam crk_param[CRK_MAXPARAM]; 306091d81d1SSam Leffler }; 307091d81d1SSam Leffler #define CRK_ALGORITM_MIN 0 308091d81d1SSam Leffler #define CRK_MOD_EXP 0 309091d81d1SSam Leffler #define CRK_MOD_EXP_CRT 1 310091d81d1SSam Leffler #define CRK_DSA_SIGN 2 311091d81d1SSam Leffler #define CRK_DSA_VERIFY 3 312091d81d1SSam Leffler #define CRK_DH_COMPUTE_KEY 4 313091d81d1SSam Leffler #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */ 314091d81d1SSam Leffler 315091d81d1SSam Leffler #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 316091d81d1SSam Leffler #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 317091d81d1SSam Leffler #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 318091d81d1SSam Leffler #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 319091d81d1SSam Leffler #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 320091d81d1SSam Leffler 321091d81d1SSam Leffler /* 322091d81d1SSam Leffler * done against open of /dev/crypto, to get a cloned descriptor. 323091d81d1SSam Leffler * Please use F_SETFD against the cloned descriptor. 324091d81d1SSam Leffler */ 325091d81d1SSam Leffler #define CRIOGET _IOWR('c', 100, u_int32_t) 3266810ad6fSSam Leffler #define CRIOASYMFEAT CIOCASYMFEAT 3276810ad6fSSam Leffler #define CRIOFINDDEV CIOCFINDDEV 328091d81d1SSam Leffler 329091d81d1SSam Leffler /* the following are done against the cloned descriptor */ 330091d81d1SSam Leffler #define CIOCGSESSION _IOWR('c', 101, struct session_op) 331091d81d1SSam Leffler #define CIOCFSESSION _IOW('c', 102, u_int32_t) 332091d81d1SSam Leffler #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) 333091d81d1SSam Leffler #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 334091d81d1SSam Leffler #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 3356810ad6fSSam Leffler #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op) 3366810ad6fSSam Leffler #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop) 3376810ad6fSSam Leffler #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op) 33808fca7a5SJohn-Mark Gurney #define CIOCCRYPTAEAD _IOWR('c', 109, struct crypt_aead) 339091d81d1SSam Leffler 3407d1853eeSSam Leffler struct cryptotstat { 3417d1853eeSSam Leffler struct timespec acc; /* total accumulated time */ 3427d1853eeSSam Leffler struct timespec min; /* min time */ 3437d1853eeSSam Leffler struct timespec max; /* max time */ 3447d1853eeSSam Leffler u_int32_t count; /* number of observations */ 3457d1853eeSSam Leffler }; 3467d1853eeSSam Leffler 3477d1853eeSSam Leffler struct cryptostats { 3487d1853eeSSam Leffler u_int32_t cs_ops; /* symmetric crypto ops submitted */ 3497d1853eeSSam Leffler u_int32_t cs_errs; /* symmetric crypto ops that failed */ 3507d1853eeSSam Leffler u_int32_t cs_kops; /* asymetric/key ops submitted */ 3517d1853eeSSam Leffler u_int32_t cs_kerrs; /* asymetric/key ops that failed */ 3527d1853eeSSam Leffler u_int32_t cs_intrs; /* crypto swi thread activations */ 3537d1853eeSSam Leffler u_int32_t cs_rets; /* crypto return thread activations */ 3547d1853eeSSam Leffler u_int32_t cs_blocks; /* symmetric op driver block */ 3557d1853eeSSam Leffler u_int32_t cs_kblocks; /* symmetric op driver block */ 3567d1853eeSSam Leffler /* 3577d1853eeSSam Leffler * When CRYPTO_TIMING is defined at compile time and the 3587d1853eeSSam Leffler * sysctl debug.crypto is set to 1, the crypto system will 3597d1853eeSSam Leffler * accumulate statistics about how long it takes to process 3607d1853eeSSam Leffler * crypto requests at various points during processing. 3617d1853eeSSam Leffler */ 3627d1853eeSSam Leffler struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */ 3637d1853eeSSam Leffler struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */ 3647d1853eeSSam Leffler struct cryptotstat cs_cb; /* crypto_done -> callback */ 3657d1853eeSSam Leffler struct cryptotstat cs_finis; /* callback -> callback return */ 3667d1853eeSSam Leffler }; 3677d1853eeSSam Leffler 368091d81d1SSam Leffler #ifdef _KERNEL 36908fca7a5SJohn-Mark Gurney 37008fca7a5SJohn-Mark Gurney #if 0 371289b9798SConrad Meyer #define CRYPTDEB(s, ...) do { \ 372289b9798SConrad Meyer printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__); \ 37308fca7a5SJohn-Mark Gurney } while (0) 37408fca7a5SJohn-Mark Gurney #else 375289b9798SConrad Meyer #define CRYPTDEB(...) do { } while (0) 37608fca7a5SJohn-Mark Gurney #endif 37708fca7a5SJohn-Mark Gurney 378091d81d1SSam Leffler /* Standard initialization structure beginning */ 379091d81d1SSam Leffler struct cryptoini { 380091d81d1SSam Leffler int cri_alg; /* Algorithm to use */ 381091d81d1SSam Leffler int cri_klen; /* Key length, in bits */ 382f6c4bc3bSPawel Jakub Dawidek int cri_mlen; /* Number of bytes we want from the 383f6c4bc3bSPawel Jakub Dawidek entire hash. 0 means all. */ 384091d81d1SSam Leffler caddr_t cri_key; /* key to use */ 385091d81d1SSam Leffler u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 386091d81d1SSam Leffler struct cryptoini *cri_next; 387091d81d1SSam Leffler }; 388091d81d1SSam Leffler 389091d81d1SSam Leffler /* Describe boundaries of a single crypto operation */ 390091d81d1SSam Leffler struct cryptodesc { 391091d81d1SSam Leffler int crd_skip; /* How many bytes to ignore from start */ 392091d81d1SSam Leffler int crd_len; /* How many bytes to process */ 393091d81d1SSam Leffler int crd_inject; /* Where to inject results, if applicable */ 394091d81d1SSam Leffler int crd_flags; 395091d81d1SSam Leffler 396091d81d1SSam Leffler #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 397091d81d1SSam Leffler #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 398091d81d1SSam Leffler place, so don't copy. */ 399091d81d1SSam Leffler #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 400091d81d1SSam Leffler #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 401091d81d1SSam Leffler #define CRD_F_COMP 0x0f /* Set when doing compression */ 40208fca7a5SJohn-Mark Gurney #define CRD_F_KEY_EXPLICIT 0x10 /* Key explicitly provided */ 403091d81d1SSam Leffler 404091d81d1SSam Leffler struct cryptoini CRD_INI; /* Initialization/context data */ 40508fca7a5SJohn-Mark Gurney #define crd_esn CRD_INI.cri_esn 406091d81d1SSam Leffler #define crd_iv CRD_INI.cri_iv 407091d81d1SSam Leffler #define crd_key CRD_INI.cri_key 408091d81d1SSam Leffler #define crd_alg CRD_INI.cri_alg 409091d81d1SSam Leffler #define crd_klen CRD_INI.cri_klen 410091d81d1SSam Leffler 411091d81d1SSam Leffler struct cryptodesc *crd_next; 412091d81d1SSam Leffler }; 413091d81d1SSam Leffler 414091d81d1SSam Leffler /* Structure describing complete operation */ 415091d81d1SSam Leffler struct cryptop { 416091d81d1SSam Leffler TAILQ_ENTRY(cryptop) crp_next; 417091d81d1SSam Leffler 41839bbca6fSFabien Thomas struct task crp_task; 41939bbca6fSFabien Thomas 420*1b0909d5SConrad Meyer crypto_session_t crp_session; /* Session */ 421091d81d1SSam Leffler int crp_ilen; /* Input data total length */ 422091d81d1SSam Leffler int crp_olen; /* Result total length */ 423091d81d1SSam Leffler 424091d81d1SSam Leffler int crp_etype; /* 425091d81d1SSam Leffler * Error type (zero means no error). 426091d81d1SSam Leffler * All error codes except EAGAIN 427091d81d1SSam Leffler * indicate possible data corruption (as in, 428091d81d1SSam Leffler * the data have been touched). On all 429*1b0909d5SConrad Meyer * errors, the crp_session may have changed 430091d81d1SSam Leffler * (reset to a new one), so the caller 431091d81d1SSam Leffler * should always check and use the new 432091d81d1SSam Leffler * value on future requests. 433091d81d1SSam Leffler */ 434091d81d1SSam Leffler int crp_flags; 435091d81d1SSam Leffler 436d8409aafSSam Leffler #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */ 437091d81d1SSam Leffler #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 438eb73a605SSam Leffler #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible */ 439eb73a605SSam Leffler #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */ 4403569ae7fSSam Leffler #define CRYPTO_F_DONE 0x0020 /* Operation completed */ 441d8409aafSSam Leffler #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */ 44239bbca6fSFabien Thomas #define CRYPTO_F_ASYNC 0x0080 /* Dispatch crypto jobs on several threads 44339bbca6fSFabien Thomas * if op is synchronous 44439bbca6fSFabien Thomas */ 44539bbca6fSFabien Thomas #define CRYPTO_F_ASYNC_KEEPORDER 0x0100 /* 44639bbca6fSFabien Thomas * Dispatch the crypto jobs in the same 44739bbca6fSFabien Thomas * order there are submitted. Applied only 44839bbca6fSFabien Thomas * if CRYPTO_F_ASYNC flags is set 44939bbca6fSFabien Thomas */ 450091d81d1SSam Leffler 451a296c719SJohn Baldwin union { 452091d81d1SSam Leffler caddr_t crp_buf; /* Data to be processed */ 453a296c719SJohn Baldwin struct mbuf *crp_mbuf; 454a296c719SJohn Baldwin struct uio *crp_uio; 455a296c719SJohn Baldwin }; 456eda08c83SJohn Baldwin void * crp_opaque; /* Opaque pointer, passed along */ 457091d81d1SSam Leffler struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 458091d81d1SSam Leffler 459091d81d1SSam Leffler int (*crp_callback)(struct cryptop *); /* Callback function */ 460091d81d1SSam Leffler 4617d1853eeSSam Leffler struct bintime crp_tstamp; /* performance time stamp */ 46239bbca6fSFabien Thomas uint32_t crp_seq; /* used for ordered dispatch */ 46339bbca6fSFabien Thomas uint32_t crp_retw_id; /* 46439bbca6fSFabien Thomas * the return worker to be used, 46539bbca6fSFabien Thomas * used for ordered dispatch 46639bbca6fSFabien Thomas */ 467091d81d1SSam Leffler }; 468091d81d1SSam Leffler 46939bbca6fSFabien Thomas #define CRYPTOP_ASYNC(crp) \ 47039bbca6fSFabien Thomas (((crp)->crp_flags & CRYPTO_F_ASYNC) && \ 471*1b0909d5SConrad Meyer crypto_ses2caps((crp)->crp_session) & CRYPTOCAP_F_SYNC) 47239bbca6fSFabien Thomas #define CRYPTOP_ASYNC_KEEPORDER(crp) \ 47339bbca6fSFabien Thomas (CRYPTOP_ASYNC(crp) && \ 47439bbca6fSFabien Thomas (crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER) 47539bbca6fSFabien Thomas 476091d81d1SSam Leffler #define CRYPTO_BUF_CONTIG 0x0 477091d81d1SSam Leffler #define CRYPTO_BUF_IOV 0x1 478091d81d1SSam Leffler #define CRYPTO_BUF_MBUF 0x2 479091d81d1SSam Leffler 480091d81d1SSam Leffler #define CRYPTO_OP_DECRYPT 0x0 481091d81d1SSam Leffler #define CRYPTO_OP_ENCRYPT 0x1 482091d81d1SSam Leffler 483091d81d1SSam Leffler /* 484091d81d1SSam Leffler * Hints passed to process methods. 485091d81d1SSam Leffler */ 486091d81d1SSam Leffler #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 487091d81d1SSam Leffler 488091d81d1SSam Leffler struct cryptkop { 489091d81d1SSam Leffler TAILQ_ENTRY(cryptkop) krp_next; 490091d81d1SSam Leffler 491091d81d1SSam Leffler u_int krp_op; /* ie. CRK_MOD_EXP or other */ 492091d81d1SSam Leffler u_int krp_status; /* return status */ 493091d81d1SSam Leffler u_short krp_iparams; /* # of input parameters */ 494091d81d1SSam Leffler u_short krp_oparams; /* # of output parameters */ 4956810ad6fSSam Leffler u_int krp_crid; /* desired device, etc. */ 496091d81d1SSam Leffler u_int32_t krp_hid; 497091d81d1SSam Leffler struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 498091d81d1SSam Leffler int (*krp_callback)(struct cryptkop *); 499091d81d1SSam Leffler }; 500091d81d1SSam Leffler 501*1b0909d5SConrad Meyer uint32_t crypto_ses2hid(crypto_session_t crypto_session); 502*1b0909d5SConrad Meyer uint32_t crypto_ses2caps(crypto_session_t crypto_session); 503*1b0909d5SConrad Meyer void *crypto_get_driver_session(crypto_session_t crypto_session); 50407d0c94aSSam Leffler 505091d81d1SSam Leffler MALLOC_DECLARE(M_CRYPTO_DATA); 506091d81d1SSam Leffler 507*1b0909d5SConrad Meyer extern int crypto_newsession(crypto_session_t *cses, struct cryptoini *cri, int hard); 508*1b0909d5SConrad Meyer extern void crypto_freesession(crypto_session_t cses); 5096810ad6fSSam Leffler #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE 5106810ad6fSSam Leffler #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE 5116810ad6fSSam Leffler #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */ 512*1b0909d5SConrad Meyer extern int32_t crypto_get_driverid(device_t dev, size_t session_size, 513*1b0909d5SConrad Meyer int flags); 5146810ad6fSSam Leffler extern int crypto_find_driver(const char *); 5156810ad6fSSam Leffler extern device_t crypto_find_device_byhid(int hid); 5166810ad6fSSam Leffler extern int crypto_getcaps(int hid); 517091d81d1SSam Leffler extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, 5186810ad6fSSam Leffler u_int32_t flags); 5196810ad6fSSam Leffler extern int crypto_kregister(u_int32_t, int, u_int32_t); 520091d81d1SSam Leffler extern int crypto_unregister(u_int32_t driverid, int alg); 521091d81d1SSam Leffler extern int crypto_unregister_all(u_int32_t driverid); 522091d81d1SSam Leffler extern int crypto_dispatch(struct cryptop *crp); 523091d81d1SSam Leffler extern int crypto_kdispatch(struct cryptkop *); 524091d81d1SSam Leffler #define CRYPTO_SYMQ 0x1 525091d81d1SSam Leffler #define CRYPTO_ASYMQ 0x2 526091d81d1SSam Leffler extern int crypto_unblock(u_int32_t, int); 527091d81d1SSam Leffler extern void crypto_done(struct cryptop *crp); 528091d81d1SSam Leffler extern void crypto_kdone(struct cryptkop *); 529091d81d1SSam Leffler extern int crypto_getfeat(int *); 530091d81d1SSam Leffler 531091d81d1SSam Leffler extern void crypto_freereq(struct cryptop *crp); 532091d81d1SSam Leffler extern struct cryptop *crypto_getreq(int num); 533091d81d1SSam Leffler 534091d81d1SSam Leffler extern int crypto_usercrypto; /* userland may do crypto requests */ 535091d81d1SSam Leffler extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 536091d81d1SSam Leffler extern int crypto_devallowsoft; /* only use hardware crypto */ 537091d81d1SSam Leffler 538091d81d1SSam Leffler /* 539091d81d1SSam Leffler * Crypto-related utility routines used mainly by drivers. 540091d81d1SSam Leffler * 541091d81d1SSam Leffler * XXX these don't really belong here; but for now they're 542091d81d1SSam Leffler * kept apart from the rest of the system. 543091d81d1SSam Leffler */ 544091d81d1SSam Leffler struct uio; 545091d81d1SSam Leffler extern void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp); 5467dd10fdeSJohn Baldwin extern void cuio_copyback(struct uio* uio, int off, int len, c_caddr_t cp); 54708fca7a5SJohn-Mark Gurney extern int cuio_getptr(struct uio *uio, int loc, int *off); 548b5161eb7SPawel Jakub Dawidek extern int cuio_apply(struct uio *uio, int off, int len, 549b5161eb7SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 55011d2e1e8SPawel Jakub Dawidek 55108fca7a5SJohn-Mark Gurney struct mbuf; 55208fca7a5SJohn-Mark Gurney struct iovec; 553748a12e2SJohn-Mark Gurney extern int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr, 55408fca7a5SJohn-Mark Gurney int *cnt, int *allocated); 55508fca7a5SJohn-Mark Gurney 55611d2e1e8SPawel Jakub Dawidek extern void crypto_copyback(int flags, caddr_t buf, int off, int size, 5577dd10fdeSJohn Baldwin c_caddr_t in); 55811d2e1e8SPawel Jakub Dawidek extern void crypto_copydata(int flags, caddr_t buf, int off, int size, 55911d2e1e8SPawel Jakub Dawidek caddr_t out); 56011d2e1e8SPawel Jakub Dawidek extern int crypto_apply(int flags, caddr_t buf, int off, int len, 56111d2e1e8SPawel Jakub Dawidek int (*f)(void *, void *, u_int), void *arg); 562a296c719SJohn Baldwin 563091d81d1SSam Leffler #endif /* _KERNEL */ 564091d81d1SSam Leffler #endif /* _CRYPTO_CRYPTO_H_ */ 565