xref: /freebsd/sys/opencrypto/cryptodev.h (revision ff2038a9bfd79bcc67e258f1e0c6231aa76eec43)
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
8801d5de8fSConrad Meyer #define	POLY1305_HASH_LEN	16
890bbc4bf9SPawel Jakub Dawidek /* Maximum hash algorithm result length */
900bbc4bf9SPawel Jakub Dawidek #define	HASH_MAX_LEN		SHA2_512_HASH_LEN /* Keep this updated */
910bbc4bf9SPawel Jakub Dawidek 
92590adc1bSConrad Meyer #define	MD5_BLOCK_LEN		64
93590adc1bSConrad Meyer #define	SHA1_BLOCK_LEN		64
94590adc1bSConrad Meyer #define	RIPEMD160_BLOCK_LEN	64
95c97f39ceSConrad Meyer #define	SHA2_224_BLOCK_LEN	64
96590adc1bSConrad Meyer #define	SHA2_256_BLOCK_LEN	64
97590adc1bSConrad Meyer #define	SHA2_384_BLOCK_LEN	128
98590adc1bSConrad Meyer #define	SHA2_512_BLOCK_LEN	128
99590adc1bSConrad Meyer 
100091d81d1SSam Leffler /* HMAC values */
1019ea7e421SPawel Jakub Dawidek #define	NULL_HMAC_BLOCK_LEN		64
102bc58b0ecSPawel Jakub Dawidek /* Maximum HMAC block length */
103590adc1bSConrad Meyer #define	HMAC_MAX_BLOCK_LEN	SHA2_512_BLOCK_LEN /* Keep this updated */
104091d81d1SSam Leffler #define	HMAC_IPAD_VAL			0x36
105091d81d1SSam Leffler #define	HMAC_OPAD_VAL			0x5C
10616de9ac1SGeorge V. Neville-Neil /* HMAC Key Length */
107a2bc81bfSJohn-Mark Gurney #define	AES_128_GMAC_KEY_LEN		16
108a2bc81bfSJohn-Mark Gurney #define	AES_192_GMAC_KEY_LEN		24
109a2bc81bfSJohn-Mark Gurney #define	AES_256_GMAC_KEY_LEN		32
110091d81d1SSam Leffler 
11101d5de8fSConrad Meyer #define	POLY1305_KEY_LEN		32
11201d5de8fSConrad Meyer 
113091d81d1SSam Leffler /* Encryption algorithm block sizes */
114a2bc81bfSJohn-Mark Gurney #define	NULL_BLOCK_LEN		4	/* IPsec to maintain alignment */
115091d81d1SSam Leffler #define	DES_BLOCK_LEN		8
116091d81d1SSam Leffler #define	DES3_BLOCK_LEN		8
117091d81d1SSam Leffler #define	BLOWFISH_BLOCK_LEN	8
118091d81d1SSam Leffler #define	SKIPJACK_BLOCK_LEN	8
119091d81d1SSam Leffler #define	CAST128_BLOCK_LEN	8
120091d81d1SSam Leffler #define	RIJNDAEL128_BLOCK_LEN	16
12116de9ac1SGeorge V. Neville-Neil #define	AES_BLOCK_LEN		16
122577f7474SJohn-Mark Gurney #define	AES_ICM_BLOCK_LEN	1
12316de9ac1SGeorge V. Neville-Neil #define	ARC4_BLOCK_LEN		1
124559d3390SGeorge V. Neville-Neil #define	CAMELLIA_BLOCK_LEN	16
12561590291SConrad Meyer #define	CHACHA20_NATIVE_BLOCK_LEN	64
12661590291SConrad Meyer #define	EALG_MAX_BLOCK_LEN	CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */
127091d81d1SSam Leffler 
12816de9ac1SGeorge V. Neville-Neil /* IV Lengths */
12916de9ac1SGeorge V. Neville-Neil 
13016de9ac1SGeorge V. Neville-Neil #define	ARC4_IV_LEN		1
131577f7474SJohn-Mark Gurney #define	AES_GCM_IV_LEN		12
13216de9ac1SGeorge V. Neville-Neil #define	AES_XTS_IV_LEN		8
13316de9ac1SGeorge V. Neville-Neil #define	AES_XTS_ALPHA		0x87	/* GF(2^128) generator polynomial */
13416de9ac1SGeorge V. Neville-Neil 
13516de9ac1SGeorge V. Neville-Neil /* Min and Max Encryption Key Sizes */
13616de9ac1SGeorge V. Neville-Neil #define	NULL_MIN_KEY		0
13716de9ac1SGeorge V. Neville-Neil #define	NULL_MAX_KEY		256 /* 2048 bits, max key */
13816de9ac1SGeorge V. Neville-Neil #define	DES_MIN_KEY		8
13916de9ac1SGeorge V. Neville-Neil #define	DES_MAX_KEY		DES_MIN_KEY
14016de9ac1SGeorge V. Neville-Neil #define	TRIPLE_DES_MIN_KEY	24
14116de9ac1SGeorge V. Neville-Neil #define	TRIPLE_DES_MAX_KEY	TRIPLE_DES_MIN_KEY
14216de9ac1SGeorge V. Neville-Neil #define	BLOWFISH_MIN_KEY	5
14316de9ac1SGeorge V. Neville-Neil #define	BLOWFISH_MAX_KEY	56 /* 448 bits, max key */
14416de9ac1SGeorge V. Neville-Neil #define	CAST_MIN_KEY		5
14516de9ac1SGeorge V. Neville-Neil #define	CAST_MAX_KEY		16
14616de9ac1SGeorge V. Neville-Neil #define	SKIPJACK_MIN_KEY	10
14716de9ac1SGeorge V. Neville-Neil #define	SKIPJACK_MAX_KEY	SKIPJACK_MIN_KEY
14816de9ac1SGeorge V. Neville-Neil #define	RIJNDAEL_MIN_KEY	16
14916de9ac1SGeorge V. Neville-Neil #define	RIJNDAEL_MAX_KEY	32
150577f7474SJohn-Mark Gurney #define	AES_MIN_KEY		RIJNDAEL_MIN_KEY
151577f7474SJohn-Mark Gurney #define	AES_MAX_KEY		RIJNDAEL_MAX_KEY
152577f7474SJohn-Mark Gurney #define	AES_XTS_MIN_KEY		(2 * AES_MIN_KEY)
153577f7474SJohn-Mark Gurney #define	AES_XTS_MAX_KEY		(2 * AES_MAX_KEY)
15416de9ac1SGeorge V. Neville-Neil #define	ARC4_MIN_KEY		1
15516de9ac1SGeorge V. Neville-Neil #define	ARC4_MAX_KEY		32
15616de9ac1SGeorge V. Neville-Neil #define	CAMELLIA_MIN_KEY	8
15716de9ac1SGeorge V. Neville-Neil #define	CAMELLIA_MAX_KEY	32
15816de9ac1SGeorge V. Neville-Neil 
15908fca7a5SJohn-Mark Gurney /* Maximum hash algorithm result length */
16008fca7a5SJohn-Mark Gurney #define	AALG_MAX_RESULT_LEN	64 /* Keep this updated */
16108fca7a5SJohn-Mark Gurney 
162091d81d1SSam Leffler #define	CRYPTO_ALGORITHM_MIN	1
163091d81d1SSam Leffler #define	CRYPTO_DES_CBC		1
164091d81d1SSam Leffler #define	CRYPTO_3DES_CBC		2
165091d81d1SSam Leffler #define	CRYPTO_BLF_CBC		3
166091d81d1SSam Leffler #define	CRYPTO_CAST_CBC		4
167091d81d1SSam Leffler #define	CRYPTO_SKIPJACK_CBC	5
168091d81d1SSam Leffler #define	CRYPTO_MD5_HMAC		6
169091d81d1SSam Leffler #define	CRYPTO_SHA1_HMAC	7
170091d81d1SSam Leffler #define	CRYPTO_RIPEMD160_HMAC	8
171091d81d1SSam Leffler #define	CRYPTO_MD5_KPDK		9
172091d81d1SSam Leffler #define	CRYPTO_SHA1_KPDK	10
173091d81d1SSam Leffler #define	CRYPTO_RIJNDAEL128_CBC	11 /* 128 bit blocksize */
174091d81d1SSam Leffler #define	CRYPTO_AES_CBC		11 /* 128 bit blocksize -- the same as above */
175091d81d1SSam Leffler #define	CRYPTO_ARC4		12
176091d81d1SSam Leffler #define	CRYPTO_MD5		13
177091d81d1SSam Leffler #define	CRYPTO_SHA1		14
178f6c4bc3bSPawel Jakub Dawidek #define	CRYPTO_NULL_HMAC	15
179f6c4bc3bSPawel Jakub Dawidek #define	CRYPTO_NULL_CBC		16
180f6c4bc3bSPawel Jakub Dawidek #define	CRYPTO_DEFLATE_COMP	17 /* Deflate compression algorithm */
181f6c4bc3bSPawel Jakub Dawidek #define	CRYPTO_SHA2_256_HMAC	18
182f6c4bc3bSPawel Jakub Dawidek #define	CRYPTO_SHA2_384_HMAC	19
183f6c4bc3bSPawel Jakub Dawidek #define	CRYPTO_SHA2_512_HMAC	20
184559d3390SGeorge V. Neville-Neil #define	CRYPTO_CAMELLIA_CBC	21
185d295bdeeSPawel Jakub Dawidek #define	CRYPTO_AES_XTS		22
18608fca7a5SJohn-Mark Gurney #define	CRYPTO_AES_ICM		23 /* commonly known as CTR mode */
18708fca7a5SJohn-Mark Gurney #define	CRYPTO_AES_NIST_GMAC	24 /* cipher side */
18808fca7a5SJohn-Mark Gurney #define	CRYPTO_AES_NIST_GCM_16	25 /* 16 byte ICV */
18908fca7a5SJohn-Mark Gurney #define	CRYPTO_AES_128_NIST_GMAC 26 /* auth side */
19008fca7a5SJohn-Mark Gurney #define	CRYPTO_AES_192_NIST_GMAC 27 /* auth side */
19108fca7a5SJohn-Mark Gurney #define	CRYPTO_AES_256_NIST_GMAC 28 /* auth side */
1920e33efe4SConrad Meyer #define	CRYPTO_BLAKE2B		29 /* Blake2b hash */
1930e33efe4SConrad Meyer #define	CRYPTO_BLAKE2S		30 /* Blake2s hash */
19461590291SConrad Meyer #define	CRYPTO_CHACHA20		31 /* Chacha20 stream cipher */
195c97f39ceSConrad Meyer #define	CRYPTO_SHA2_224_HMAC	32
196c4729f6eSConrad Meyer #define	CRYPTO_RIPEMD160	33
197c4729f6eSConrad Meyer #define	CRYPTO_SHA2_224		34
198c4729f6eSConrad Meyer #define	CRYPTO_SHA2_256		35
199c4729f6eSConrad Meyer #define	CRYPTO_SHA2_384		36
200c4729f6eSConrad Meyer #define	CRYPTO_SHA2_512		37
20101d5de8fSConrad Meyer #define	CRYPTO_POLY1305		38
20201d5de8fSConrad Meyer #define	CRYPTO_ALGORITHM_MAX	38 /* Keep updated - see below */
20308fca7a5SJohn-Mark Gurney 
20408fca7a5SJohn-Mark Gurney #define	CRYPTO_ALGO_VALID(x)	((x) >= CRYPTO_ALGORITHM_MIN && \
20508fca7a5SJohn-Mark Gurney 				 (x) <= CRYPTO_ALGORITHM_MAX)
206091d81d1SSam Leffler 
207091d81d1SSam Leffler /* Algorithm flags */
208091d81d1SSam Leffler #define	CRYPTO_ALG_FLAG_SUPPORTED	0x01 /* Algorithm is supported */
209091d81d1SSam Leffler #define	CRYPTO_ALG_FLAG_RNG_ENABLE	0x02 /* Has HW RNG for DH/DSA */
210091d81d1SSam Leffler #define	CRYPTO_ALG_FLAG_DSA_SHA		0x04 /* Can do SHA on msg */
211091d81d1SSam Leffler 
2126810ad6fSSam Leffler /*
2136810ad6fSSam Leffler  * Crypto driver/device flags.  They can set in the crid
2146810ad6fSSam Leffler  * parameter when creating a session or submitting a key
2156810ad6fSSam Leffler  * op to affect the device/driver assigned.  If neither
2166810ad6fSSam Leffler  * of these are specified then the crid is assumed to hold
2176810ad6fSSam Leffler  * the driver id of an existing (and suitable) device that
2186810ad6fSSam Leffler  * must be used to satisfy the request.
2196810ad6fSSam Leffler  */
2206810ad6fSSam Leffler #define CRYPTO_FLAG_HARDWARE	0x01000000	/* hardware accelerated */
2216810ad6fSSam Leffler #define CRYPTO_FLAG_SOFTWARE	0x02000000	/* software implementation */
2226810ad6fSSam Leffler 
2236810ad6fSSam Leffler /* NB: deprecated */
224091d81d1SSam Leffler struct session_op {
225091d81d1SSam Leffler 	u_int32_t	cipher;		/* ie. CRYPTO_DES_CBC */
226091d81d1SSam Leffler 	u_int32_t	mac;		/* ie. CRYPTO_MD5_HMAC */
227091d81d1SSam Leffler 
228091d81d1SSam Leffler 	u_int32_t	keylen;		/* cipher key */
2297dd10fdeSJohn Baldwin 	c_caddr_t	key;
230091d81d1SSam Leffler 	int		mackeylen;	/* mac key */
2317dd10fdeSJohn Baldwin 	c_caddr_t	mackey;
232091d81d1SSam Leffler 
233091d81d1SSam Leffler   	u_int32_t	ses;		/* returns: session # */
234091d81d1SSam Leffler };
235091d81d1SSam Leffler 
2361b0909d5SConrad Meyer /*
2371b0909d5SConrad Meyer  * session and crypt _op structs are used by userspace programs to interact
2381b0909d5SConrad Meyer  * with /dev/crypto.  Confusingly, the internal kernel interface is named
2391b0909d5SConrad Meyer  * "cryptop" (no underscore).
2401b0909d5SConrad Meyer  */
2416810ad6fSSam Leffler struct session2_op {
2426810ad6fSSam Leffler 	u_int32_t	cipher;		/* ie. CRYPTO_DES_CBC */
2436810ad6fSSam Leffler 	u_int32_t	mac;		/* ie. CRYPTO_MD5_HMAC */
2446810ad6fSSam Leffler 
2456810ad6fSSam Leffler 	u_int32_t	keylen;		/* cipher key */
2467dd10fdeSJohn Baldwin 	c_caddr_t	key;
2476810ad6fSSam Leffler 	int		mackeylen;	/* mac key */
2487dd10fdeSJohn Baldwin 	c_caddr_t	mackey;
2496810ad6fSSam Leffler 
2506810ad6fSSam Leffler   	u_int32_t	ses;		/* returns: session # */
2516810ad6fSSam Leffler 	int		crid;		/* driver id + flags (rw) */
2526810ad6fSSam Leffler 	int		pad[4];		/* for future expansion */
2536810ad6fSSam Leffler };
2546810ad6fSSam Leffler 
255091d81d1SSam Leffler struct crypt_op {
256091d81d1SSam Leffler 	u_int32_t	ses;
257091d81d1SSam Leffler 	u_int16_t	op;		/* i.e. COP_ENCRYPT */
258091d81d1SSam Leffler #define COP_ENCRYPT	1
259091d81d1SSam Leffler #define COP_DECRYPT	2
260eb73a605SSam Leffler 	u_int16_t	flags;
2612c907637SJohn Baldwin #define	COP_F_CIPHER_FIRST	0x0001	/* Cipher before MAC. */
262eb73a605SSam Leffler #define	COP_F_BATCH		0x0008	/* Batch op if possible */
263091d81d1SSam Leffler 	u_int		len;
2647dd10fdeSJohn Baldwin 	c_caddr_t	src;		/* become iov[] inside kernel */
2657dd10fdeSJohn Baldwin 	caddr_t		dst;
266091d81d1SSam Leffler 	caddr_t		mac;		/* must be big enough for chosen MAC */
2677dd10fdeSJohn Baldwin 	c_caddr_t	iv;
268091d81d1SSam Leffler };
269091d81d1SSam Leffler 
27008fca7a5SJohn-Mark Gurney /* op and flags the same as crypt_op */
27108fca7a5SJohn-Mark Gurney struct crypt_aead {
27208fca7a5SJohn-Mark Gurney 	u_int32_t	ses;
27308fca7a5SJohn-Mark Gurney 	u_int16_t	op;		/* i.e. COP_ENCRYPT */
27408fca7a5SJohn-Mark Gurney 	u_int16_t	flags;
27508fca7a5SJohn-Mark Gurney 	u_int		len;
27608fca7a5SJohn-Mark Gurney 	u_int		aadlen;
27708fca7a5SJohn-Mark Gurney 	u_int		ivlen;
2787dd10fdeSJohn Baldwin 	c_caddr_t	src;		/* become iov[] inside kernel */
2797dd10fdeSJohn Baldwin 	caddr_t		dst;
2807dd10fdeSJohn Baldwin 	c_caddr_t	aad;		/* additional authenticated data */
28108fca7a5SJohn-Mark Gurney 	caddr_t		tag;		/* must fit for chosen TAG length */
2827dd10fdeSJohn Baldwin 	c_caddr_t	iv;
28308fca7a5SJohn-Mark Gurney };
28408fca7a5SJohn-Mark Gurney 
2856810ad6fSSam Leffler /*
2866810ad6fSSam Leffler  * Parameters for looking up a crypto driver/device by
2876810ad6fSSam Leffler  * device name or by id.  The latter are returned for
2886810ad6fSSam Leffler  * created sessions (crid) and completed key operations.
2896810ad6fSSam Leffler  */
2906810ad6fSSam Leffler struct crypt_find_op {
2916810ad6fSSam Leffler 	int		crid;		/* driver id + flags */
2926810ad6fSSam Leffler 	char		name[32];	/* device/driver name */
2936810ad6fSSam Leffler };
2946810ad6fSSam Leffler 
295091d81d1SSam Leffler /* bignum parameter, in packed bytes, ... */
296091d81d1SSam Leffler struct crparam {
297091d81d1SSam Leffler 	caddr_t		crp_p;
298091d81d1SSam Leffler 	u_int		crp_nbits;
299091d81d1SSam Leffler };
300091d81d1SSam Leffler 
301091d81d1SSam Leffler #define CRK_MAXPARAM	8
302091d81d1SSam Leffler 
303091d81d1SSam Leffler struct crypt_kop {
304091d81d1SSam Leffler 	u_int		crk_op;		/* ie. CRK_MOD_EXP or other */
305091d81d1SSam Leffler 	u_int		crk_status;	/* return status */
306091d81d1SSam Leffler 	u_short		crk_iparams;	/* # of input parameters */
307091d81d1SSam Leffler 	u_short		crk_oparams;	/* # of output parameters */
3086810ad6fSSam Leffler 	u_int		crk_crid;	/* NB: only used by CIOCKEY2 (rw) */
309091d81d1SSam Leffler 	struct crparam	crk_param[CRK_MAXPARAM];
310091d81d1SSam Leffler };
311091d81d1SSam Leffler #define	CRK_ALGORITM_MIN	0
312091d81d1SSam Leffler #define CRK_MOD_EXP		0
313091d81d1SSam Leffler #define CRK_MOD_EXP_CRT		1
314091d81d1SSam Leffler #define CRK_DSA_SIGN		2
315091d81d1SSam Leffler #define CRK_DSA_VERIFY		3
316091d81d1SSam Leffler #define CRK_DH_COMPUTE_KEY	4
317091d81d1SSam Leffler #define CRK_ALGORITHM_MAX	4 /* Keep updated - see below */
318091d81d1SSam Leffler 
319091d81d1SSam Leffler #define CRF_MOD_EXP		(1 << CRK_MOD_EXP)
320091d81d1SSam Leffler #define CRF_MOD_EXP_CRT		(1 << CRK_MOD_EXP_CRT)
321091d81d1SSam Leffler #define CRF_DSA_SIGN		(1 << CRK_DSA_SIGN)
322091d81d1SSam Leffler #define CRF_DSA_VERIFY		(1 << CRK_DSA_VERIFY)
323091d81d1SSam Leffler #define CRF_DH_COMPUTE_KEY	(1 << CRK_DH_COMPUTE_KEY)
324091d81d1SSam Leffler 
325091d81d1SSam Leffler /*
326091d81d1SSam Leffler  * done against open of /dev/crypto, to get a cloned descriptor.
327091d81d1SSam Leffler  * Please use F_SETFD against the cloned descriptor.
328091d81d1SSam Leffler  */
329091d81d1SSam Leffler #define	CRIOGET		_IOWR('c', 100, u_int32_t)
3306810ad6fSSam Leffler #define	CRIOASYMFEAT	CIOCASYMFEAT
3316810ad6fSSam Leffler #define	CRIOFINDDEV	CIOCFINDDEV
332091d81d1SSam Leffler 
333091d81d1SSam Leffler /* the following are done against the cloned descriptor */
334091d81d1SSam Leffler #define	CIOCGSESSION	_IOWR('c', 101, struct session_op)
335091d81d1SSam Leffler #define	CIOCFSESSION	_IOW('c', 102, u_int32_t)
336091d81d1SSam Leffler #define CIOCCRYPT	_IOWR('c', 103, struct crypt_op)
337091d81d1SSam Leffler #define CIOCKEY		_IOWR('c', 104, struct crypt_kop)
338091d81d1SSam Leffler #define CIOCASYMFEAT	_IOR('c', 105, u_int32_t)
3396810ad6fSSam Leffler #define	CIOCGSESSION2	_IOWR('c', 106, struct session2_op)
3406810ad6fSSam Leffler #define	CIOCKEY2	_IOWR('c', 107, struct crypt_kop)
3416810ad6fSSam Leffler #define	CIOCFINDDEV	_IOWR('c', 108, struct crypt_find_op)
34208fca7a5SJohn-Mark Gurney #define	CIOCCRYPTAEAD	_IOWR('c', 109, struct crypt_aead)
343091d81d1SSam Leffler 
3447d1853eeSSam Leffler struct cryptotstat {
3457d1853eeSSam Leffler 	struct timespec	acc;		/* total accumulated time */
3467d1853eeSSam Leffler 	struct timespec	min;		/* min time */
3477d1853eeSSam Leffler 	struct timespec	max;		/* max time */
3487d1853eeSSam Leffler 	u_int32_t	count;		/* number of observations */
3497d1853eeSSam Leffler };
3507d1853eeSSam Leffler 
3517d1853eeSSam Leffler struct cryptostats {
3527d1853eeSSam Leffler 	u_int32_t	cs_ops;		/* symmetric crypto ops submitted */
3537d1853eeSSam Leffler 	u_int32_t	cs_errs;	/* symmetric crypto ops that failed */
3547d1853eeSSam Leffler 	u_int32_t	cs_kops;	/* asymetric/key ops submitted */
3557d1853eeSSam Leffler 	u_int32_t	cs_kerrs;	/* asymetric/key ops that failed */
3567d1853eeSSam Leffler 	u_int32_t	cs_intrs;	/* crypto swi thread activations */
3577d1853eeSSam Leffler 	u_int32_t	cs_rets;	/* crypto return thread activations */
3587d1853eeSSam Leffler 	u_int32_t	cs_blocks;	/* symmetric op driver block */
3597d1853eeSSam Leffler 	u_int32_t	cs_kblocks;	/* symmetric op driver block */
3607d1853eeSSam Leffler 	/*
3617d1853eeSSam Leffler 	 * When CRYPTO_TIMING is defined at compile time and the
3627d1853eeSSam Leffler 	 * sysctl debug.crypto is set to 1, the crypto system will
3637d1853eeSSam Leffler 	 * accumulate statistics about how long it takes to process
3647d1853eeSSam Leffler 	 * crypto requests at various points during processing.
3657d1853eeSSam Leffler 	 */
3667d1853eeSSam Leffler 	struct cryptotstat cs_invoke;	/* crypto_dipsatch -> crypto_invoke */
3677d1853eeSSam Leffler 	struct cryptotstat cs_done;	/* crypto_invoke -> crypto_done */
3687d1853eeSSam Leffler 	struct cryptotstat cs_cb;	/* crypto_done -> callback */
3697d1853eeSSam Leffler 	struct cryptotstat cs_finis;	/* callback -> callback return */
3707d1853eeSSam Leffler };
3717d1853eeSSam Leffler 
372091d81d1SSam Leffler #ifdef _KERNEL
37308fca7a5SJohn-Mark Gurney 
37408fca7a5SJohn-Mark Gurney #if 0
375289b9798SConrad Meyer #define CRYPTDEB(s, ...) do {						\
376289b9798SConrad Meyer 	printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__);	\
37708fca7a5SJohn-Mark Gurney } while (0)
37808fca7a5SJohn-Mark Gurney #else
379289b9798SConrad Meyer #define CRYPTDEB(...)	do { } while (0)
38008fca7a5SJohn-Mark Gurney #endif
38108fca7a5SJohn-Mark Gurney 
382091d81d1SSam Leffler /* Standard initialization structure beginning */
383091d81d1SSam Leffler struct cryptoini {
384091d81d1SSam Leffler 	int		cri_alg;	/* Algorithm to use */
385091d81d1SSam Leffler 	int		cri_klen;	/* Key length, in bits */
386f6c4bc3bSPawel Jakub Dawidek 	int		cri_mlen;	/* Number of bytes we want from the
387f6c4bc3bSPawel Jakub Dawidek 					   entire hash. 0 means all. */
388091d81d1SSam Leffler 	caddr_t		cri_key;	/* key to use */
389091d81d1SSam Leffler 	u_int8_t	cri_iv[EALG_MAX_BLOCK_LEN];	/* IV to use */
390091d81d1SSam Leffler 	struct cryptoini *cri_next;
391091d81d1SSam Leffler };
392091d81d1SSam Leffler 
393091d81d1SSam Leffler /* Describe boundaries of a single crypto operation */
394091d81d1SSam Leffler struct cryptodesc {
395091d81d1SSam Leffler 	int		crd_skip;	/* How many bytes to ignore from start */
396091d81d1SSam Leffler 	int		crd_len;	/* How many bytes to process */
397091d81d1SSam Leffler 	int		crd_inject;	/* Where to inject results, if applicable */
398091d81d1SSam Leffler 	int		crd_flags;
399091d81d1SSam Leffler 
400091d81d1SSam Leffler #define	CRD_F_ENCRYPT		0x01	/* Set when doing encryption */
401091d81d1SSam Leffler #define	CRD_F_IV_PRESENT	0x02	/* When encrypting, IV is already in
402091d81d1SSam Leffler 					   place, so don't copy. */
403091d81d1SSam Leffler #define	CRD_F_IV_EXPLICIT	0x04	/* IV explicitly provided */
404091d81d1SSam Leffler #define	CRD_F_DSA_SHA_NEEDED	0x08	/* Compute SHA-1 of buffer for DSA */
405091d81d1SSam Leffler #define	CRD_F_COMP		0x0f    /* Set when doing compression */
40608fca7a5SJohn-Mark Gurney #define	CRD_F_KEY_EXPLICIT	0x10	/* Key explicitly provided */
407091d81d1SSam Leffler 
408091d81d1SSam Leffler 	struct cryptoini	CRD_INI; /* Initialization/context data */
40908fca7a5SJohn-Mark Gurney #define	crd_esn		CRD_INI.cri_esn
410091d81d1SSam Leffler #define	crd_iv		CRD_INI.cri_iv
411091d81d1SSam Leffler #define	crd_key		CRD_INI.cri_key
412091d81d1SSam Leffler #define	crd_alg		CRD_INI.cri_alg
413091d81d1SSam Leffler #define	crd_klen	CRD_INI.cri_klen
414091d81d1SSam Leffler 
415091d81d1SSam Leffler 	struct cryptodesc *crd_next;
416091d81d1SSam Leffler };
417091d81d1SSam Leffler 
418091d81d1SSam Leffler /* Structure describing complete operation */
419091d81d1SSam Leffler struct cryptop {
420091d81d1SSam Leffler 	TAILQ_ENTRY(cryptop) crp_next;
421091d81d1SSam Leffler 
42239bbca6fSFabien Thomas 	struct task	crp_task;
42339bbca6fSFabien Thomas 
4241b0909d5SConrad Meyer 	crypto_session_t crp_session;	/* Session */
425091d81d1SSam Leffler 	int		crp_ilen;	/* Input data total length */
426091d81d1SSam Leffler 	int		crp_olen;	/* Result total length */
427091d81d1SSam Leffler 
428091d81d1SSam Leffler 	int		crp_etype;	/*
429091d81d1SSam Leffler 					 * Error type (zero means no error).
430091d81d1SSam Leffler 					 * All error codes except EAGAIN
431091d81d1SSam Leffler 					 * indicate possible data corruption (as in,
432091d81d1SSam Leffler 					 * the data have been touched). On all
4331b0909d5SConrad Meyer 					 * errors, the crp_session may have changed
434091d81d1SSam Leffler 					 * (reset to a new one), so the caller
435091d81d1SSam Leffler 					 * should always check and use the new
436091d81d1SSam Leffler 					 * value on future requests.
437091d81d1SSam Leffler 					 */
438091d81d1SSam Leffler 	int		crp_flags;
439091d81d1SSam Leffler 
440d8409aafSSam Leffler #define	CRYPTO_F_IMBUF		0x0001	/* Input/output are mbuf chains */
441091d81d1SSam Leffler #define	CRYPTO_F_IOV		0x0002	/* Input/output are uio */
442eb73a605SSam Leffler #define	CRYPTO_F_BATCH		0x0008	/* Batch op if possible */
443eb73a605SSam Leffler #define	CRYPTO_F_CBIMM		0x0010	/* Do callback immediately */
4443569ae7fSSam Leffler #define	CRYPTO_F_DONE		0x0020	/* Operation completed */
445d8409aafSSam Leffler #define	CRYPTO_F_CBIFSYNC	0x0040	/* Do CBIMM if op is synchronous */
44639bbca6fSFabien Thomas #define	CRYPTO_F_ASYNC		0x0080	/* Dispatch crypto jobs on several threads
44739bbca6fSFabien Thomas 					 * if op is synchronous
44839bbca6fSFabien Thomas 					 */
44939bbca6fSFabien Thomas #define	CRYPTO_F_ASYNC_KEEPORDER	0x0100	/*
45039bbca6fSFabien Thomas 					 * Dispatch the crypto jobs in the same
45139bbca6fSFabien Thomas 					 * order there are submitted. Applied only
45239bbca6fSFabien Thomas 					 * if CRYPTO_F_ASYNC flags is set
45339bbca6fSFabien Thomas 					 */
454091d81d1SSam Leffler 
455a296c719SJohn Baldwin 	union {
456091d81d1SSam Leffler 		caddr_t		crp_buf;	/* Data to be processed */
457a296c719SJohn Baldwin 		struct mbuf	*crp_mbuf;
458a296c719SJohn Baldwin 		struct uio	*crp_uio;
459a296c719SJohn Baldwin 	};
460eda08c83SJohn Baldwin 	void *		crp_opaque;	/* Opaque pointer, passed along */
461091d81d1SSam Leffler 	struct cryptodesc *crp_desc;	/* Linked list of processing descriptors */
462091d81d1SSam Leffler 
463091d81d1SSam Leffler 	int (*crp_callback)(struct cryptop *); /* Callback function */
464091d81d1SSam Leffler 
4657d1853eeSSam Leffler 	struct bintime	crp_tstamp;	/* performance time stamp */
46639bbca6fSFabien Thomas 	uint32_t	crp_seq;	/* used for ordered dispatch */
46739bbca6fSFabien Thomas 	uint32_t	crp_retw_id;	/*
46839bbca6fSFabien Thomas 					 * the return worker to be used,
46939bbca6fSFabien Thomas 					 *  used for ordered dispatch
47039bbca6fSFabien Thomas 					 */
471091d81d1SSam Leffler };
472091d81d1SSam Leffler 
47339bbca6fSFabien Thomas #define	CRYPTOP_ASYNC(crp) \
47439bbca6fSFabien Thomas 	(((crp)->crp_flags & CRYPTO_F_ASYNC) && \
4751b0909d5SConrad Meyer 	crypto_ses2caps((crp)->crp_session) & CRYPTOCAP_F_SYNC)
47639bbca6fSFabien Thomas #define	CRYPTOP_ASYNC_KEEPORDER(crp) \
47739bbca6fSFabien Thomas 	(CRYPTOP_ASYNC(crp) && \
47839bbca6fSFabien Thomas 	(crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER)
47939bbca6fSFabien Thomas 
480091d81d1SSam Leffler #define	CRYPTO_BUF_CONTIG	0x0
481091d81d1SSam Leffler #define	CRYPTO_BUF_IOV		0x1
482091d81d1SSam Leffler #define	CRYPTO_BUF_MBUF		0x2
483091d81d1SSam Leffler 
484091d81d1SSam Leffler #define	CRYPTO_OP_DECRYPT	0x0
485091d81d1SSam Leffler #define	CRYPTO_OP_ENCRYPT	0x1
486091d81d1SSam Leffler 
487091d81d1SSam Leffler /*
488091d81d1SSam Leffler  * Hints passed to process methods.
489091d81d1SSam Leffler  */
490091d81d1SSam Leffler #define	CRYPTO_HINT_MORE	0x1	/* more ops coming shortly */
491091d81d1SSam Leffler 
492091d81d1SSam Leffler struct cryptkop {
493091d81d1SSam Leffler 	TAILQ_ENTRY(cryptkop) krp_next;
494091d81d1SSam Leffler 
495091d81d1SSam Leffler 	u_int		krp_op;		/* ie. CRK_MOD_EXP or other */
496091d81d1SSam Leffler 	u_int		krp_status;	/* return status */
497091d81d1SSam Leffler 	u_short		krp_iparams;	/* # of input parameters */
498091d81d1SSam Leffler 	u_short		krp_oparams;	/* # of output parameters */
4996810ad6fSSam Leffler 	u_int		krp_crid;	/* desired device, etc. */
500091d81d1SSam Leffler 	u_int32_t	krp_hid;
501091d81d1SSam Leffler 	struct crparam	krp_param[CRK_MAXPARAM];	/* kvm */
502091d81d1SSam Leffler 	int		(*krp_callback)(struct cryptkop *);
503091d81d1SSam Leffler };
504091d81d1SSam Leffler 
5051b0909d5SConrad Meyer uint32_t crypto_ses2hid(crypto_session_t crypto_session);
5061b0909d5SConrad Meyer uint32_t crypto_ses2caps(crypto_session_t crypto_session);
5071b0909d5SConrad Meyer void *crypto_get_driver_session(crypto_session_t crypto_session);
50807d0c94aSSam Leffler 
509091d81d1SSam Leffler MALLOC_DECLARE(M_CRYPTO_DATA);
510091d81d1SSam Leffler 
5111b0909d5SConrad Meyer extern	int crypto_newsession(crypto_session_t *cses, struct cryptoini *cri, int hard);
5121b0909d5SConrad Meyer extern	void crypto_freesession(crypto_session_t cses);
5136810ad6fSSam Leffler #define	CRYPTOCAP_F_HARDWARE	CRYPTO_FLAG_HARDWARE
5146810ad6fSSam Leffler #define	CRYPTOCAP_F_SOFTWARE	CRYPTO_FLAG_SOFTWARE
5156810ad6fSSam Leffler #define	CRYPTOCAP_F_SYNC	0x04000000	/* operates synchronously */
5161b0909d5SConrad Meyer extern	int32_t crypto_get_driverid(device_t dev, size_t session_size,
5171b0909d5SConrad Meyer     int flags);
5186810ad6fSSam Leffler extern	int crypto_find_driver(const char *);
5196810ad6fSSam Leffler extern	device_t crypto_find_device_byhid(int hid);
5206810ad6fSSam Leffler extern	int crypto_getcaps(int hid);
521091d81d1SSam Leffler extern	int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
5226810ad6fSSam Leffler 	    u_int32_t flags);
5236810ad6fSSam Leffler extern	int crypto_kregister(u_int32_t, int, u_int32_t);
524091d81d1SSam Leffler extern	int crypto_unregister(u_int32_t driverid, int alg);
525091d81d1SSam Leffler extern	int crypto_unregister_all(u_int32_t driverid);
526091d81d1SSam Leffler extern	int crypto_dispatch(struct cryptop *crp);
527091d81d1SSam Leffler extern	int crypto_kdispatch(struct cryptkop *);
528091d81d1SSam Leffler #define	CRYPTO_SYMQ	0x1
529091d81d1SSam Leffler #define	CRYPTO_ASYMQ	0x2
530091d81d1SSam Leffler extern	int crypto_unblock(u_int32_t, int);
531091d81d1SSam Leffler extern	void crypto_done(struct cryptop *crp);
532091d81d1SSam Leffler extern	void crypto_kdone(struct cryptkop *);
533091d81d1SSam Leffler extern	int crypto_getfeat(int *);
534091d81d1SSam Leffler 
535091d81d1SSam Leffler extern	void crypto_freereq(struct cryptop *crp);
536091d81d1SSam Leffler extern	struct cryptop *crypto_getreq(int num);
537091d81d1SSam Leffler 
538091d81d1SSam Leffler extern	int crypto_usercrypto;		/* userland may do crypto requests */
539091d81d1SSam Leffler extern	int crypto_userasymcrypto;	/* userland may do asym crypto reqs */
540091d81d1SSam Leffler extern	int crypto_devallowsoft;	/* only use hardware crypto */
541091d81d1SSam Leffler 
542091d81d1SSam Leffler /*
543091d81d1SSam Leffler  * Crypto-related utility routines used mainly by drivers.
544091d81d1SSam Leffler  *
545091d81d1SSam Leffler  * XXX these don't really belong here; but for now they're
546091d81d1SSam Leffler  *     kept apart from the rest of the system.
547091d81d1SSam Leffler  */
548091d81d1SSam Leffler struct uio;
549091d81d1SSam Leffler extern	void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
5507dd10fdeSJohn Baldwin extern	void cuio_copyback(struct uio* uio, int off, int len, c_caddr_t cp);
55108fca7a5SJohn-Mark Gurney extern	int cuio_getptr(struct uio *uio, int loc, int *off);
552b5161eb7SPawel Jakub Dawidek extern	int cuio_apply(struct uio *uio, int off, int len,
553b5161eb7SPawel Jakub Dawidek 	    int (*f)(void *, void *, u_int), void *arg);
55411d2e1e8SPawel Jakub Dawidek 
55508fca7a5SJohn-Mark Gurney struct mbuf;
55608fca7a5SJohn-Mark Gurney struct iovec;
557748a12e2SJohn-Mark Gurney extern	int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr,
55808fca7a5SJohn-Mark Gurney 	    int *cnt, int *allocated);
55908fca7a5SJohn-Mark Gurney 
56011d2e1e8SPawel Jakub Dawidek extern	void crypto_copyback(int flags, caddr_t buf, int off, int size,
5617dd10fdeSJohn Baldwin 	    c_caddr_t in);
56211d2e1e8SPawel Jakub Dawidek extern	void crypto_copydata(int flags, caddr_t buf, int off, int size,
56311d2e1e8SPawel Jakub Dawidek 	    caddr_t out);
56411d2e1e8SPawel Jakub Dawidek extern	int crypto_apply(int flags, caddr_t buf, int off, int len,
56511d2e1e8SPawel Jakub Dawidek 	    int (*f)(void *, void *, u_int), void *arg);
566a296c719SJohn Baldwin 
567*ff2038a9SMatt Macy extern void *crypto_contiguous_subsegment(int, void *, size_t, size_t);
568*ff2038a9SMatt Macy 
569091d81d1SSam Leffler #endif /* _KERNEL */
570091d81d1SSam Leffler #endif /* _CRYPTO_CRYPTO_H_ */
571