xref: /freebsd/sys/opencrypto/cryptodev.h (revision 780fb4a2fa9a9aee5ac48a60b790f567c0dc13e9)
1 /*	$FreeBSD$	*/
2 /*	$OpenBSD: cryptodev.h,v 1.31 2002/06/11 11:14:29 beck Exp $	*/
3 
4 /*-
5  * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu)
6  * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting
7  *
8  * This code was written by Angelos D. Keromytis in Athens, Greece, in
9  * February 2000. Network Security Technologies Inc. (NSTI) kindly
10  * supported the development of this code.
11  *
12  * Copyright (c) 2000 Angelos D. Keromytis
13  *
14  * Permission to use, copy, and modify this software with or without fee
15  * is hereby granted, provided that this entire notice is included in
16  * all source code copies of any software which is or includes a copy or
17  * modification of this software.
18  *
19  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
20  * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
21  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
22  * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
23  * PURPOSE.
24  *
25  * Copyright (c) 2001 Theo de Raadt
26  * Copyright (c) 2014 The FreeBSD Foundation
27  * All rights reserved.
28  *
29  * Portions of this software were developed by John-Mark Gurney
30  * under sponsorship of the FreeBSD Foundation and
31  * Rubicon Communications, LLC (Netgate).
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  *
37  * 1. Redistributions of source code must retain the above copyright
38  *   notice, this list of conditions and the following disclaimer.
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *   notice, this list of conditions and the following disclaimer in the
41  *   documentation and/or other materials provided with the distribution.
42  * 3. The name of the author may not be used to endorse or promote products
43  *   derived from this software without specific prior written permission.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55  *
56  * Effort sponsored in part by the Defense Advanced Research Projects
57  * Agency (DARPA) and Air Force Research Laboratory, Air Force
58  * Materiel Command, USAF, under agreement number F30602-01-2-0537.
59  *
60  */
61 
62 #ifndef _CRYPTO_CRYPTO_H_
63 #define _CRYPTO_CRYPTO_H_
64 
65 #include <sys/ioccom.h>
66 #include <sys/_task.h>
67 
68 /* Some initial values */
69 #define CRYPTO_DRIVERS_INITIAL	4
70 #define CRYPTO_SW_SESSIONS	32
71 
72 /* Hash values */
73 #define	NULL_HASH_LEN		16
74 #define	MD5_HASH_LEN		16
75 #define	SHA1_HASH_LEN		20
76 #define	RIPEMD160_HASH_LEN	20
77 #define	SHA2_224_HASH_LEN	28
78 #define	SHA2_256_HASH_LEN	32
79 #define	SHA2_384_HASH_LEN	48
80 #define	SHA2_512_HASH_LEN	64
81 #define	MD5_KPDK_HASH_LEN	16
82 #define	SHA1_KPDK_HASH_LEN	20
83 #define	AES_GMAC_HASH_LEN	16
84 /* Maximum hash algorithm result length */
85 #define	HASH_MAX_LEN		SHA2_512_HASH_LEN /* Keep this updated */
86 
87 #define	MD5_BLOCK_LEN		64
88 #define	SHA1_BLOCK_LEN		64
89 #define	RIPEMD160_BLOCK_LEN	64
90 #define	SHA2_224_BLOCK_LEN	64
91 #define	SHA2_256_BLOCK_LEN	64
92 #define	SHA2_384_BLOCK_LEN	128
93 #define	SHA2_512_BLOCK_LEN	128
94 
95 /* HMAC values */
96 #define	NULL_HMAC_BLOCK_LEN		64
97 /* Maximum HMAC block length */
98 #define	HMAC_MAX_BLOCK_LEN	SHA2_512_BLOCK_LEN /* Keep this updated */
99 #define	HMAC_IPAD_VAL			0x36
100 #define	HMAC_OPAD_VAL			0x5C
101 /* HMAC Key Length */
102 #define	AES_128_GMAC_KEY_LEN		16
103 #define	AES_192_GMAC_KEY_LEN		24
104 #define	AES_256_GMAC_KEY_LEN		32
105 
106 /* Encryption algorithm block sizes */
107 #define	NULL_BLOCK_LEN		4	/* IPsec to maintain alignment */
108 #define	DES_BLOCK_LEN		8
109 #define	DES3_BLOCK_LEN		8
110 #define	BLOWFISH_BLOCK_LEN	8
111 #define	SKIPJACK_BLOCK_LEN	8
112 #define	CAST128_BLOCK_LEN	8
113 #define	RIJNDAEL128_BLOCK_LEN	16
114 #define	AES_BLOCK_LEN		16
115 #define	AES_ICM_BLOCK_LEN	1
116 #define	ARC4_BLOCK_LEN		1
117 #define	CAMELLIA_BLOCK_LEN	16
118 #define	CHACHA20_NATIVE_BLOCK_LEN	64
119 #define	EALG_MAX_BLOCK_LEN	CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */
120 
121 /* IV Lengths */
122 
123 #define	ARC4_IV_LEN		1
124 #define	AES_GCM_IV_LEN		12
125 #define	AES_XTS_IV_LEN		8
126 #define	AES_XTS_ALPHA		0x87	/* GF(2^128) generator polynomial */
127 
128 /* Min and Max Encryption Key Sizes */
129 #define	NULL_MIN_KEY		0
130 #define	NULL_MAX_KEY		256 /* 2048 bits, max key */
131 #define	DES_MIN_KEY		8
132 #define	DES_MAX_KEY		DES_MIN_KEY
133 #define	TRIPLE_DES_MIN_KEY	24
134 #define	TRIPLE_DES_MAX_KEY	TRIPLE_DES_MIN_KEY
135 #define	BLOWFISH_MIN_KEY	5
136 #define	BLOWFISH_MAX_KEY	56 /* 448 bits, max key */
137 #define	CAST_MIN_KEY		5
138 #define	CAST_MAX_KEY		16
139 #define	SKIPJACK_MIN_KEY	10
140 #define	SKIPJACK_MAX_KEY	SKIPJACK_MIN_KEY
141 #define	RIJNDAEL_MIN_KEY	16
142 #define	RIJNDAEL_MAX_KEY	32
143 #define	AES_MIN_KEY		RIJNDAEL_MIN_KEY
144 #define	AES_MAX_KEY		RIJNDAEL_MAX_KEY
145 #define	AES_XTS_MIN_KEY		(2 * AES_MIN_KEY)
146 #define	AES_XTS_MAX_KEY		(2 * AES_MAX_KEY)
147 #define	ARC4_MIN_KEY		1
148 #define	ARC4_MAX_KEY		32
149 #define	CAMELLIA_MIN_KEY	8
150 #define	CAMELLIA_MAX_KEY	32
151 
152 /* Maximum hash algorithm result length */
153 #define	AALG_MAX_RESULT_LEN	64 /* Keep this updated */
154 
155 #define	CRYPTO_ALGORITHM_MIN	1
156 #define	CRYPTO_DES_CBC		1
157 #define	CRYPTO_3DES_CBC		2
158 #define	CRYPTO_BLF_CBC		3
159 #define	CRYPTO_CAST_CBC		4
160 #define	CRYPTO_SKIPJACK_CBC	5
161 #define	CRYPTO_MD5_HMAC		6
162 #define	CRYPTO_SHA1_HMAC	7
163 #define	CRYPTO_RIPEMD160_HMAC	8
164 #define	CRYPTO_MD5_KPDK		9
165 #define	CRYPTO_SHA1_KPDK	10
166 #define	CRYPTO_RIJNDAEL128_CBC	11 /* 128 bit blocksize */
167 #define	CRYPTO_AES_CBC		11 /* 128 bit blocksize -- the same as above */
168 #define	CRYPTO_ARC4		12
169 #define	CRYPTO_MD5		13
170 #define	CRYPTO_SHA1		14
171 #define	CRYPTO_NULL_HMAC	15
172 #define	CRYPTO_NULL_CBC		16
173 #define	CRYPTO_DEFLATE_COMP	17 /* Deflate compression algorithm */
174 #define	CRYPTO_SHA2_256_HMAC	18
175 #define	CRYPTO_SHA2_384_HMAC	19
176 #define	CRYPTO_SHA2_512_HMAC	20
177 #define	CRYPTO_CAMELLIA_CBC	21
178 #define	CRYPTO_AES_XTS		22
179 #define	CRYPTO_AES_ICM		23 /* commonly known as CTR mode */
180 #define	CRYPTO_AES_NIST_GMAC	24 /* cipher side */
181 #define	CRYPTO_AES_NIST_GCM_16	25 /* 16 byte ICV */
182 #define	CRYPTO_AES_128_NIST_GMAC 26 /* auth side */
183 #define	CRYPTO_AES_192_NIST_GMAC 27 /* auth side */
184 #define	CRYPTO_AES_256_NIST_GMAC 28 /* auth side */
185 #define	CRYPTO_BLAKE2B		29 /* Blake2b hash */
186 #define	CRYPTO_BLAKE2S		30 /* Blake2s hash */
187 #define	CRYPTO_CHACHA20		31 /* Chacha20 stream cipher */
188 #define	CRYPTO_SHA2_224_HMAC	32
189 #define	CRYPTO_RIPEMD160	33
190 #define	CRYPTO_SHA2_224		34
191 #define	CRYPTO_SHA2_256		35
192 #define	CRYPTO_SHA2_384		36
193 #define	CRYPTO_SHA2_512		37
194 #define	CRYPTO_ALGORITHM_MAX	37 /* Keep updated - see below */
195 
196 #define	CRYPTO_ALGO_VALID(x)	((x) >= CRYPTO_ALGORITHM_MIN && \
197 				 (x) <= CRYPTO_ALGORITHM_MAX)
198 
199 /* Algorithm flags */
200 #define	CRYPTO_ALG_FLAG_SUPPORTED	0x01 /* Algorithm is supported */
201 #define	CRYPTO_ALG_FLAG_RNG_ENABLE	0x02 /* Has HW RNG for DH/DSA */
202 #define	CRYPTO_ALG_FLAG_DSA_SHA		0x04 /* Can do SHA on msg */
203 
204 /*
205  * Crypto driver/device flags.  They can set in the crid
206  * parameter when creating a session or submitting a key
207  * op to affect the device/driver assigned.  If neither
208  * of these are specified then the crid is assumed to hold
209  * the driver id of an existing (and suitable) device that
210  * must be used to satisfy the request.
211  */
212 #define CRYPTO_FLAG_HARDWARE	0x01000000	/* hardware accelerated */
213 #define CRYPTO_FLAG_SOFTWARE	0x02000000	/* software implementation */
214 
215 /* NB: deprecated */
216 struct session_op {
217 	u_int32_t	cipher;		/* ie. CRYPTO_DES_CBC */
218 	u_int32_t	mac;		/* ie. CRYPTO_MD5_HMAC */
219 
220 	u_int32_t	keylen;		/* cipher key */
221 	c_caddr_t	key;
222 	int		mackeylen;	/* mac key */
223 	c_caddr_t	mackey;
224 
225   	u_int32_t	ses;		/* returns: session # */
226 };
227 
228 struct session2_op {
229 	u_int32_t	cipher;		/* ie. CRYPTO_DES_CBC */
230 	u_int32_t	mac;		/* ie. CRYPTO_MD5_HMAC */
231 
232 	u_int32_t	keylen;		/* cipher key */
233 	c_caddr_t	key;
234 	int		mackeylen;	/* mac key */
235 	c_caddr_t	mackey;
236 
237   	u_int32_t	ses;		/* returns: session # */
238 	int		crid;		/* driver id + flags (rw) */
239 	int		pad[4];		/* for future expansion */
240 };
241 
242 struct crypt_op {
243 	u_int32_t	ses;
244 	u_int16_t	op;		/* i.e. COP_ENCRYPT */
245 #define COP_ENCRYPT	1
246 #define COP_DECRYPT	2
247 	u_int16_t	flags;
248 #define	COP_F_CIPHER_FIRST	0x0001	/* Cipher before MAC. */
249 #define	COP_F_BATCH		0x0008	/* Batch op if possible */
250 	u_int		len;
251 	c_caddr_t	src;		/* become iov[] inside kernel */
252 	caddr_t		dst;
253 	caddr_t		mac;		/* must be big enough for chosen MAC */
254 	c_caddr_t	iv;
255 };
256 
257 /* op and flags the same as crypt_op */
258 struct crypt_aead {
259 	u_int32_t	ses;
260 	u_int16_t	op;		/* i.e. COP_ENCRYPT */
261 	u_int16_t	flags;
262 	u_int		len;
263 	u_int		aadlen;
264 	u_int		ivlen;
265 	c_caddr_t	src;		/* become iov[] inside kernel */
266 	caddr_t		dst;
267 	c_caddr_t	aad;		/* additional authenticated data */
268 	caddr_t		tag;		/* must fit for chosen TAG length */
269 	c_caddr_t	iv;
270 };
271 
272 /*
273  * Parameters for looking up a crypto driver/device by
274  * device name or by id.  The latter are returned for
275  * created sessions (crid) and completed key operations.
276  */
277 struct crypt_find_op {
278 	int		crid;		/* driver id + flags */
279 	char		name[32];	/* device/driver name */
280 };
281 
282 /* bignum parameter, in packed bytes, ... */
283 struct crparam {
284 	caddr_t		crp_p;
285 	u_int		crp_nbits;
286 };
287 
288 #define CRK_MAXPARAM	8
289 
290 struct crypt_kop {
291 	u_int		crk_op;		/* ie. CRK_MOD_EXP or other */
292 	u_int		crk_status;	/* return status */
293 	u_short		crk_iparams;	/* # of input parameters */
294 	u_short		crk_oparams;	/* # of output parameters */
295 	u_int		crk_crid;	/* NB: only used by CIOCKEY2 (rw) */
296 	struct crparam	crk_param[CRK_MAXPARAM];
297 };
298 #define	CRK_ALGORITM_MIN	0
299 #define CRK_MOD_EXP		0
300 #define CRK_MOD_EXP_CRT		1
301 #define CRK_DSA_SIGN		2
302 #define CRK_DSA_VERIFY		3
303 #define CRK_DH_COMPUTE_KEY	4
304 #define CRK_ALGORITHM_MAX	4 /* Keep updated - see below */
305 
306 #define CRF_MOD_EXP		(1 << CRK_MOD_EXP)
307 #define CRF_MOD_EXP_CRT		(1 << CRK_MOD_EXP_CRT)
308 #define CRF_DSA_SIGN		(1 << CRK_DSA_SIGN)
309 #define CRF_DSA_VERIFY		(1 << CRK_DSA_VERIFY)
310 #define CRF_DH_COMPUTE_KEY	(1 << CRK_DH_COMPUTE_KEY)
311 
312 /*
313  * done against open of /dev/crypto, to get a cloned descriptor.
314  * Please use F_SETFD against the cloned descriptor.
315  */
316 #define	CRIOGET		_IOWR('c', 100, u_int32_t)
317 #define	CRIOASYMFEAT	CIOCASYMFEAT
318 #define	CRIOFINDDEV	CIOCFINDDEV
319 
320 /* the following are done against the cloned descriptor */
321 #define	CIOCGSESSION	_IOWR('c', 101, struct session_op)
322 #define	CIOCFSESSION	_IOW('c', 102, u_int32_t)
323 #define CIOCCRYPT	_IOWR('c', 103, struct crypt_op)
324 #define CIOCKEY		_IOWR('c', 104, struct crypt_kop)
325 #define CIOCASYMFEAT	_IOR('c', 105, u_int32_t)
326 #define	CIOCGSESSION2	_IOWR('c', 106, struct session2_op)
327 #define	CIOCKEY2	_IOWR('c', 107, struct crypt_kop)
328 #define	CIOCFINDDEV	_IOWR('c', 108, struct crypt_find_op)
329 #define	CIOCCRYPTAEAD	_IOWR('c', 109, struct crypt_aead)
330 
331 struct cryptotstat {
332 	struct timespec	acc;		/* total accumulated time */
333 	struct timespec	min;		/* min time */
334 	struct timespec	max;		/* max time */
335 	u_int32_t	count;		/* number of observations */
336 };
337 
338 struct cryptostats {
339 	u_int32_t	cs_ops;		/* symmetric crypto ops submitted */
340 	u_int32_t	cs_errs;	/* symmetric crypto ops that failed */
341 	u_int32_t	cs_kops;	/* asymetric/key ops submitted */
342 	u_int32_t	cs_kerrs;	/* asymetric/key ops that failed */
343 	u_int32_t	cs_intrs;	/* crypto swi thread activations */
344 	u_int32_t	cs_rets;	/* crypto return thread activations */
345 	u_int32_t	cs_blocks;	/* symmetric op driver block */
346 	u_int32_t	cs_kblocks;	/* symmetric op driver block */
347 	/*
348 	 * When CRYPTO_TIMING is defined at compile time and the
349 	 * sysctl debug.crypto is set to 1, the crypto system will
350 	 * accumulate statistics about how long it takes to process
351 	 * crypto requests at various points during processing.
352 	 */
353 	struct cryptotstat cs_invoke;	/* crypto_dipsatch -> crypto_invoke */
354 	struct cryptotstat cs_done;	/* crypto_invoke -> crypto_done */
355 	struct cryptotstat cs_cb;	/* crypto_done -> callback */
356 	struct cryptotstat cs_finis;	/* callback -> callback return */
357 };
358 
359 #ifdef _KERNEL
360 
361 #if 0
362 #define CRYPTDEB(s, ...) do {						\
363 	printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__);	\
364 } while (0)
365 #else
366 #define CRYPTDEB(...)	do { } while (0)
367 #endif
368 
369 /* Standard initialization structure beginning */
370 struct cryptoini {
371 	int		cri_alg;	/* Algorithm to use */
372 	int		cri_klen;	/* Key length, in bits */
373 	int		cri_mlen;	/* Number of bytes we want from the
374 					   entire hash. 0 means all. */
375 	caddr_t		cri_key;	/* key to use */
376 	u_int8_t	cri_iv[EALG_MAX_BLOCK_LEN];	/* IV to use */
377 	struct cryptoini *cri_next;
378 };
379 
380 /* Describe boundaries of a single crypto operation */
381 struct cryptodesc {
382 	int		crd_skip;	/* How many bytes to ignore from start */
383 	int		crd_len;	/* How many bytes to process */
384 	int		crd_inject;	/* Where to inject results, if applicable */
385 	int		crd_flags;
386 
387 #define	CRD_F_ENCRYPT		0x01	/* Set when doing encryption */
388 #define	CRD_F_IV_PRESENT	0x02	/* When encrypting, IV is already in
389 					   place, so don't copy. */
390 #define	CRD_F_IV_EXPLICIT	0x04	/* IV explicitly provided */
391 #define	CRD_F_DSA_SHA_NEEDED	0x08	/* Compute SHA-1 of buffer for DSA */
392 #define	CRD_F_COMP		0x0f    /* Set when doing compression */
393 #define	CRD_F_KEY_EXPLICIT	0x10	/* Key explicitly provided */
394 
395 	struct cryptoini	CRD_INI; /* Initialization/context data */
396 #define	crd_esn		CRD_INI.cri_esn
397 #define	crd_iv		CRD_INI.cri_iv
398 #define	crd_key		CRD_INI.cri_key
399 #define	crd_alg		CRD_INI.cri_alg
400 #define	crd_klen	CRD_INI.cri_klen
401 
402 	struct cryptodesc *crd_next;
403 };
404 
405 /* Structure describing complete operation */
406 struct cryptop {
407 	TAILQ_ENTRY(cryptop) crp_next;
408 
409 	struct task	crp_task;
410 
411 	u_int64_t	crp_sid;	/* Session ID */
412 	int		crp_ilen;	/* Input data total length */
413 	int		crp_olen;	/* Result total length */
414 
415 	int		crp_etype;	/*
416 					 * Error type (zero means no error).
417 					 * All error codes except EAGAIN
418 					 * indicate possible data corruption (as in,
419 					 * the data have been touched). On all
420 					 * errors, the crp_sid may have changed
421 					 * (reset to a new one), so the caller
422 					 * should always check and use the new
423 					 * value on future requests.
424 					 */
425 	int		crp_flags;
426 
427 #define	CRYPTO_F_IMBUF		0x0001	/* Input/output are mbuf chains */
428 #define	CRYPTO_F_IOV		0x0002	/* Input/output are uio */
429 #define	CRYPTO_F_BATCH		0x0008	/* Batch op if possible */
430 #define	CRYPTO_F_CBIMM		0x0010	/* Do callback immediately */
431 #define	CRYPTO_F_DONE		0x0020	/* Operation completed */
432 #define	CRYPTO_F_CBIFSYNC	0x0040	/* Do CBIMM if op is synchronous */
433 #define	CRYPTO_F_ASYNC		0x0080	/* Dispatch crypto jobs on several threads
434 					 * if op is synchronous
435 					 */
436 #define	CRYPTO_F_ASYNC_KEEPORDER	0x0100	/*
437 					 * Dispatch the crypto jobs in the same
438 					 * order there are submitted. Applied only
439 					 * if CRYPTO_F_ASYNC flags is set
440 					 */
441 
442 	union {
443 		caddr_t		crp_buf;	/* Data to be processed */
444 		struct mbuf	*crp_mbuf;
445 		struct uio	*crp_uio;
446 	};
447 	void *		crp_opaque;	/* Opaque pointer, passed along */
448 	struct cryptodesc *crp_desc;	/* Linked list of processing descriptors */
449 
450 	int (*crp_callback)(struct cryptop *); /* Callback function */
451 
452 	struct bintime	crp_tstamp;	/* performance time stamp */
453 	uint32_t	crp_seq;	/* used for ordered dispatch */
454 	uint32_t	crp_retw_id;	/*
455 					 * the return worker to be used,
456 					 *  used for ordered dispatch
457 					 */
458 };
459 
460 #define	CRYPTOP_ASYNC(crp) \
461 	(((crp)->crp_flags & CRYPTO_F_ASYNC) && \
462 	CRYPTO_SESID2CAPS((crp)->crp_sid) & CRYPTOCAP_F_SYNC)
463 #define	CRYPTOP_ASYNC_KEEPORDER(crp) \
464 	(CRYPTOP_ASYNC(crp) && \
465 	(crp)->crp_flags & CRYPTO_F_ASYNC_KEEPORDER)
466 
467 #define	CRYPTO_BUF_CONTIG	0x0
468 #define	CRYPTO_BUF_IOV		0x1
469 #define	CRYPTO_BUF_MBUF		0x2
470 
471 #define	CRYPTO_OP_DECRYPT	0x0
472 #define	CRYPTO_OP_ENCRYPT	0x1
473 
474 /*
475  * Hints passed to process methods.
476  */
477 #define	CRYPTO_HINT_MORE	0x1	/* more ops coming shortly */
478 
479 struct cryptkop {
480 	TAILQ_ENTRY(cryptkop) krp_next;
481 
482 	u_int		krp_op;		/* ie. CRK_MOD_EXP or other */
483 	u_int		krp_status;	/* return status */
484 	u_short		krp_iparams;	/* # of input parameters */
485 	u_short		krp_oparams;	/* # of output parameters */
486 	u_int		krp_crid;	/* desired device, etc. */
487 	u_int32_t	krp_hid;
488 	struct crparam	krp_param[CRK_MAXPARAM];	/* kvm */
489 	int		(*krp_callback)(struct cryptkop *);
490 };
491 
492 /*
493  * Session ids are 64 bits.  The lower 32 bits contain a "local id" which
494  * is a driver-private session identifier.  The upper 32 bits contain a
495  * "hardware id" used by the core crypto code to identify the driver and
496  * a copy of the driver's capabilities that can be used by client code to
497  * optimize operation.
498  */
499 #define	CRYPTO_SESID2HID(_sid)	(((_sid) >> 32) & 0x00ffffff)
500 #define	CRYPTO_SESID2CAPS(_sid)	(((_sid) >> 32) & 0xff000000)
501 #define	CRYPTO_SESID2LID(_sid)	(((u_int32_t) (_sid)) & 0xffffffff)
502 
503 MALLOC_DECLARE(M_CRYPTO_DATA);
504 
505 extern	int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard);
506 extern	int crypto_freesession(u_int64_t sid);
507 #define	CRYPTOCAP_F_HARDWARE	CRYPTO_FLAG_HARDWARE
508 #define	CRYPTOCAP_F_SOFTWARE	CRYPTO_FLAG_SOFTWARE
509 #define	CRYPTOCAP_F_SYNC	0x04000000	/* operates synchronously */
510 extern	int32_t crypto_get_driverid(device_t dev, int flags);
511 extern	int crypto_find_driver(const char *);
512 extern	device_t crypto_find_device_byhid(int hid);
513 extern	int crypto_getcaps(int hid);
514 extern	int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
515 	    u_int32_t flags);
516 extern	int crypto_kregister(u_int32_t, int, u_int32_t);
517 extern	int crypto_unregister(u_int32_t driverid, int alg);
518 extern	int crypto_unregister_all(u_int32_t driverid);
519 extern	int crypto_dispatch(struct cryptop *crp);
520 extern	int crypto_kdispatch(struct cryptkop *);
521 #define	CRYPTO_SYMQ	0x1
522 #define	CRYPTO_ASYMQ	0x2
523 extern	int crypto_unblock(u_int32_t, int);
524 extern	void crypto_done(struct cryptop *crp);
525 extern	void crypto_kdone(struct cryptkop *);
526 extern	int crypto_getfeat(int *);
527 
528 extern	void crypto_freereq(struct cryptop *crp);
529 extern	struct cryptop *crypto_getreq(int num);
530 
531 extern	int crypto_usercrypto;		/* userland may do crypto requests */
532 extern	int crypto_userasymcrypto;	/* userland may do asym crypto reqs */
533 extern	int crypto_devallowsoft;	/* only use hardware crypto */
534 
535 /*
536  * Crypto-related utility routines used mainly by drivers.
537  *
538  * XXX these don't really belong here; but for now they're
539  *     kept apart from the rest of the system.
540  */
541 struct uio;
542 extern	void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
543 extern	void cuio_copyback(struct uio* uio, int off, int len, c_caddr_t cp);
544 extern	int cuio_getptr(struct uio *uio, int loc, int *off);
545 extern	int cuio_apply(struct uio *uio, int off, int len,
546 	    int (*f)(void *, void *, u_int), void *arg);
547 
548 struct mbuf;
549 struct iovec;
550 extern	int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr,
551 	    int *cnt, int *allocated);
552 
553 extern	void crypto_copyback(int flags, caddr_t buf, int off, int size,
554 	    c_caddr_t in);
555 extern	void crypto_copydata(int flags, caddr_t buf, int off, int size,
556 	    caddr_t out);
557 extern	int crypto_apply(int flags, caddr_t buf, int off, int len,
558 	    int (*f)(void *, void *, u_int), void *arg);
559 
560 #endif /* _KERNEL */
561 #endif /* _CRYPTO_CRYPTO_H_ */
562