2 /* $OpenBSD: cryptodev.h,v 1.31 2002/06/11 11:14:29 beck Exp $ */
5 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu)
6 * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting
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.
12 * Copyright (c) 2000 Angelos D. Keromytis
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.
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
25 * Copyright (c) 2001 Theo de Raadt
26 * Copyright (c) 2014 The FreeBSD Foundation
27 * All rights reserved.
29 * Portions of this software were developed by John-Mark Gurney
30 * under sponsorship of the FreeBSD Foundation and
31 * Rubicon Communications, LLC (Netgate).
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
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.
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.
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.
62 #ifndef _CRYPTO_CRYPTO_H_
63 #define _CRYPTO_CRYPTO_H_
65 #include <sys/ioccom.h>
67 /* Some initial values */
68 #define CRYPTO_DRIVERS_INITIAL 4
69 #define CRYPTO_SW_SESSIONS 32
72 #define NULL_HASH_LEN 16
73 #define MD5_HASH_LEN 16
74 #define SHA1_HASH_LEN 20
75 #define RIPEMD160_HASH_LEN 20
76 #define SHA2_256_HASH_LEN 32
77 #define SHA2_384_HASH_LEN 48
78 #define SHA2_512_HASH_LEN 64
79 #define MD5_KPDK_HASH_LEN 16
80 #define SHA1_KPDK_HASH_LEN 20
81 #define AES_GMAC_HASH_LEN 16
82 /* Maximum hash algorithm result length */
83 #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */
86 #define NULL_HMAC_BLOCK_LEN 64
87 #define MD5_HMAC_BLOCK_LEN 64
88 #define SHA1_HMAC_BLOCK_LEN 64
89 #define RIPEMD160_HMAC_BLOCK_LEN 64
90 #define SHA2_256_HMAC_BLOCK_LEN 64
91 #define SHA2_384_HMAC_BLOCK_LEN 128
92 #define SHA2_512_HMAC_BLOCK_LEN 128
93 /* Maximum HMAC block length */
94 #define HMAC_MAX_BLOCK_LEN SHA2_512_HMAC_BLOCK_LEN /* Keep this updated */
95 #define HMAC_IPAD_VAL 0x36
96 #define HMAC_OPAD_VAL 0x5C
98 #define NULL_HMAC_KEY_LEN 0
99 #define MD5_HMAC_KEY_LEN 16
100 #define SHA1_HMAC_KEY_LEN 20
101 #define RIPEMD160_HMAC_KEY_LEN 20
102 #define SHA2_256_HMAC_KEY_LEN 32
103 #define SHA2_384_HMAC_KEY_LEN 48
104 #define SHA2_512_HMAC_KEY_LEN 64
105 #define AES_128_GMAC_KEY_LEN 16
106 #define AES_192_GMAC_KEY_LEN 24
107 #define AES_256_GMAC_KEY_LEN 32
109 /* Encryption algorithm block sizes */
110 #define NULL_BLOCK_LEN 4 /* IPsec to maintain alignment */
111 #define DES_BLOCK_LEN 8
112 #define DES3_BLOCK_LEN 8
113 #define BLOWFISH_BLOCK_LEN 8
114 #define SKIPJACK_BLOCK_LEN 8
115 #define CAST128_BLOCK_LEN 8
116 #define RIJNDAEL128_BLOCK_LEN 16
117 #define AES_BLOCK_LEN 16
118 #define AES_ICM_BLOCK_LEN 1
119 #define ARC4_BLOCK_LEN 1
120 #define CAMELLIA_BLOCK_LEN 16
121 #define EALG_MAX_BLOCK_LEN AES_BLOCK_LEN /* Keep this updated */
125 #define ARC4_IV_LEN 1
126 #define AES_GCM_IV_LEN 12
127 #define AES_XTS_IV_LEN 8
128 #define AES_XTS_ALPHA 0x87 /* GF(2^128) generator polynomial */
130 /* Min and Max Encryption Key Sizes */
131 #define NULL_MIN_KEY 0
132 #define NULL_MAX_KEY 256 /* 2048 bits, max key */
133 #define DES_MIN_KEY 8
134 #define DES_MAX_KEY DES_MIN_KEY
135 #define TRIPLE_DES_MIN_KEY 24
136 #define TRIPLE_DES_MAX_KEY TRIPLE_DES_MIN_KEY
137 #define BLOWFISH_MIN_KEY 5
138 #define BLOWFISH_MAX_KEY 56 /* 448 bits, max key */
139 #define CAST_MIN_KEY 5
140 #define CAST_MAX_KEY 16
141 #define SKIPJACK_MIN_KEY 10
142 #define SKIPJACK_MAX_KEY SKIPJACK_MIN_KEY
143 #define RIJNDAEL_MIN_KEY 16
144 #define RIJNDAEL_MAX_KEY 32
145 #define AES_MIN_KEY RIJNDAEL_MIN_KEY
146 #define AES_MAX_KEY RIJNDAEL_MAX_KEY
147 #define AES_XTS_MIN_KEY (2 * AES_MIN_KEY)
148 #define AES_XTS_MAX_KEY (2 * AES_MAX_KEY)
149 #define ARC4_MIN_KEY 1
150 #define ARC4_MAX_KEY 32
151 #define CAMELLIA_MIN_KEY 8
152 #define CAMELLIA_MAX_KEY 32
154 /* Maximum hash algorithm result length */
155 #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */
157 #define CRYPTO_ALGORITHM_MIN 1
158 #define CRYPTO_DES_CBC 1
159 #define CRYPTO_3DES_CBC 2
160 #define CRYPTO_BLF_CBC 3
161 #define CRYPTO_CAST_CBC 4
162 #define CRYPTO_SKIPJACK_CBC 5
163 #define CRYPTO_MD5_HMAC 6
164 #define CRYPTO_SHA1_HMAC 7
165 #define CRYPTO_RIPEMD160_HMAC 8
166 #define CRYPTO_MD5_KPDK 9
167 #define CRYPTO_SHA1_KPDK 10
168 #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */
169 #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */
170 #define CRYPTO_ARC4 12
171 #define CRYPTO_MD5 13
172 #define CRYPTO_SHA1 14
173 #define CRYPTO_NULL_HMAC 15
174 #define CRYPTO_NULL_CBC 16
175 #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */
176 #define CRYPTO_SHA2_256_HMAC 18
177 #define CRYPTO_SHA2_384_HMAC 19
178 #define CRYPTO_SHA2_512_HMAC 20
179 #define CRYPTO_CAMELLIA_CBC 21
180 #define CRYPTO_AES_XTS 22
181 #define CRYPTO_AES_ICM 23 /* commonly known as CTR mode */
182 #define CRYPTO_AES_NIST_GMAC 24 /* cipher side */
183 #define CRYPTO_AES_NIST_GCM_16 25 /* 16 byte ICV */
184 #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */
185 #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */
186 #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */
187 #define CRYPTO_ALGORITHM_MAX 28 /* Keep updated - see below */
189 #define CRYPTO_ALGO_VALID(x) ((x) >= CRYPTO_ALGORITHM_MIN && \
190 (x) <= CRYPTO_ALGORITHM_MAX)
192 /* Algorithm flags */
193 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */
194 #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */
195 #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */
198 * Crypto driver/device flags. They can set in the crid
199 * parameter when creating a session or submitting a key
200 * op to affect the device/driver assigned. If neither
201 * of these are specified then the crid is assumed to hold
202 * the driver id of an existing (and suitable) device that
203 * must be used to satisfy the request.
205 #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */
206 #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */
210 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */
211 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */
213 u_int32_t keylen; /* cipher key */
215 int mackeylen; /* mac key */
218 u_int32_t ses; /* returns: session # */
222 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */
223 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */
225 u_int32_t keylen; /* cipher key */
227 int mackeylen; /* mac key */
230 u_int32_t ses; /* returns: session # */
231 int crid; /* driver id + flags (rw) */
232 int pad[4]; /* for future expansion */
237 u_int16_t op; /* i.e. COP_ENCRYPT */
238 #define COP_ENCRYPT 1
239 #define COP_DECRYPT 2
241 #define COP_F_BATCH 0x0008 /* Batch op if possible */
243 caddr_t src, dst; /* become iov[] inside kernel */
244 caddr_t mac; /* must be big enough for chosen MAC */
248 /* op and flags the same as crypt_op */
251 u_int16_t op; /* i.e. COP_ENCRYPT */
256 caddr_t src, dst; /* become iov[] inside kernel */
257 caddr_t aad; /* additional authenticated data */
258 caddr_t tag; /* must fit for chosen TAG length */
263 * Parameters for looking up a crypto driver/device by
264 * device name or by id. The latter are returned for
265 * created sessions (crid) and completed key operations.
267 struct crypt_find_op {
268 int crid; /* driver id + flags */
269 char name[32]; /* device/driver name */
272 /* bignum parameter, in packed bytes, ... */
278 #define CRK_MAXPARAM 8
281 u_int crk_op; /* ie. CRK_MOD_EXP or other */
282 u_int crk_status; /* return status */
283 u_short crk_iparams; /* # of input parameters */
284 u_short crk_oparams; /* # of output parameters */
285 u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */
286 struct crparam crk_param[CRK_MAXPARAM];
288 #define CRK_ALGORITM_MIN 0
289 #define CRK_MOD_EXP 0
290 #define CRK_MOD_EXP_CRT 1
291 #define CRK_DSA_SIGN 2
292 #define CRK_DSA_VERIFY 3
293 #define CRK_DH_COMPUTE_KEY 4
294 #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */
296 #define CRF_MOD_EXP (1 << CRK_MOD_EXP)
297 #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT)
298 #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN)
299 #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY)
300 #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY)
303 * done against open of /dev/crypto, to get a cloned descriptor.
304 * Please use F_SETFD against the cloned descriptor.
306 #define CRIOGET _IOWR('c', 100, u_int32_t)
307 #define CRIOASYMFEAT CIOCASYMFEAT
308 #define CRIOFINDDEV CIOCFINDDEV
310 /* the following are done against the cloned descriptor */
311 #define CIOCGSESSION _IOWR('c', 101, struct session_op)
312 #define CIOCFSESSION _IOW('c', 102, u_int32_t)
313 #define CIOCCRYPT _IOWR('c', 103, struct crypt_op)
314 #define CIOCKEY _IOWR('c', 104, struct crypt_kop)
315 #define CIOCASYMFEAT _IOR('c', 105, u_int32_t)
316 #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op)
317 #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop)
318 #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op)
319 #define CIOCCRYPTAEAD _IOWR('c', 109, struct crypt_aead)
322 struct timespec acc; /* total accumulated time */
323 struct timespec min; /* min time */
324 struct timespec max; /* max time */
325 u_int32_t count; /* number of observations */
329 u_int32_t cs_ops; /* symmetric crypto ops submitted */
330 u_int32_t cs_errs; /* symmetric crypto ops that failed */
331 u_int32_t cs_kops; /* asymetric/key ops submitted */
332 u_int32_t cs_kerrs; /* asymetric/key ops that failed */
333 u_int32_t cs_intrs; /* crypto swi thread activations */
334 u_int32_t cs_rets; /* crypto return thread activations */
335 u_int32_t cs_blocks; /* symmetric op driver block */
336 u_int32_t cs_kblocks; /* symmetric op driver block */
338 * When CRYPTO_TIMING is defined at compile time and the
339 * sysctl debug.crypto is set to 1, the crypto system will
340 * accumulate statistics about how long it takes to process
341 * crypto requests at various points during processing.
343 struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */
344 struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */
345 struct cryptotstat cs_cb; /* crypto_done -> callback */
346 struct cryptotstat cs_finis; /* callback -> callback return */
352 #define CRYPTDEB(s) do { printf("%s:%d: %s\n", __FILE__, __LINE__, s); \
355 #define CRYPTDEB(s) do { } while (0)
358 /* Standard initialization structure beginning */
360 int cri_alg; /* Algorithm to use */
361 int cri_klen; /* Key length, in bits */
362 int cri_mlen; /* Number of bytes we want from the
363 entire hash. 0 means all. */
364 caddr_t cri_key; /* key to use */
365 u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */
366 struct cryptoini *cri_next;
369 /* Describe boundaries of a single crypto operation */
371 int crd_skip; /* How many bytes to ignore from start */
372 int crd_len; /* How many bytes to process */
373 int crd_inject; /* Where to inject results, if applicable */
376 #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */
377 #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in
378 place, so don't copy. */
379 #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */
380 #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */
381 #define CRD_F_COMP 0x0f /* Set when doing compression */
382 #define CRD_F_KEY_EXPLICIT 0x10 /* Key explicitly provided */
384 struct cryptoini CRD_INI; /* Initialization/context data */
385 #define crd_esn CRD_INI.cri_esn
386 #define crd_iv CRD_INI.cri_iv
387 #define crd_key CRD_INI.cri_key
388 #define crd_alg CRD_INI.cri_alg
389 #define crd_klen CRD_INI.cri_klen
391 struct cryptodesc *crd_next;
394 /* Structure describing complete operation */
396 TAILQ_ENTRY(cryptop) crp_next;
398 u_int64_t crp_sid; /* Session ID */
399 int crp_ilen; /* Input data total length */
400 int crp_olen; /* Result total length */
403 * Error type (zero means no error).
404 * All error codes except EAGAIN
405 * indicate possible data corruption (as in,
406 * the data have been touched). On all
407 * errors, the crp_sid may have changed
408 * (reset to a new one), so the caller
409 * should always check and use the new
410 * value on future requests.
414 #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */
415 #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */
416 #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible */
417 #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */
418 #define CRYPTO_F_DONE 0x0020 /* Operation completed */
419 #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */
421 caddr_t crp_buf; /* Data to be processed */
422 caddr_t crp_opaque; /* Opaque pointer, passed along */
423 struct cryptodesc *crp_desc; /* Linked list of processing descriptors */
425 int (*crp_callback)(struct cryptop *); /* Callback function */
427 struct bintime crp_tstamp; /* performance time stamp */
430 #define CRYPTO_BUF_CONTIG 0x0
431 #define CRYPTO_BUF_IOV 0x1
432 #define CRYPTO_BUF_MBUF 0x2
434 #define CRYPTO_OP_DECRYPT 0x0
435 #define CRYPTO_OP_ENCRYPT 0x1
438 * Hints passed to process methods.
440 #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */
443 TAILQ_ENTRY(cryptkop) krp_next;
445 u_int krp_op; /* ie. CRK_MOD_EXP or other */
446 u_int krp_status; /* return status */
447 u_short krp_iparams; /* # of input parameters */
448 u_short krp_oparams; /* # of output parameters */
449 u_int krp_crid; /* desired device, etc. */
451 struct crparam krp_param[CRK_MAXPARAM]; /* kvm */
452 int (*krp_callback)(struct cryptkop *);
456 * Session ids are 64 bits. The lower 32 bits contain a "local id" which
457 * is a driver-private session identifier. The upper 32 bits contain a
458 * "hardware id" used by the core crypto code to identify the driver and
459 * a copy of the driver's capabilities that can be used by client code to
460 * optimize operation.
462 #define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0x00ffffff)
463 #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 32) & 0xff000000)
464 #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff)
466 MALLOC_DECLARE(M_CRYPTO_DATA);
468 extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard);
469 extern int crypto_freesession(u_int64_t sid);
470 #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE
471 #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE
472 #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */
473 extern int32_t crypto_get_driverid(device_t dev, int flags);
474 extern int crypto_find_driver(const char *);
475 extern device_t crypto_find_device_byhid(int hid);
476 extern int crypto_getcaps(int hid);
477 extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
479 extern int crypto_kregister(u_int32_t, int, u_int32_t);
480 extern int crypto_unregister(u_int32_t driverid, int alg);
481 extern int crypto_unregister_all(u_int32_t driverid);
482 extern int crypto_dispatch(struct cryptop *crp);
483 extern int crypto_kdispatch(struct cryptkop *);
484 #define CRYPTO_SYMQ 0x1
485 #define CRYPTO_ASYMQ 0x2
486 extern int crypto_unblock(u_int32_t, int);
487 extern void crypto_done(struct cryptop *crp);
488 extern void crypto_kdone(struct cryptkop *);
489 extern int crypto_getfeat(int *);
491 extern void crypto_freereq(struct cryptop *crp);
492 extern struct cryptop *crypto_getreq(int num);
494 extern int crypto_usercrypto; /* userland may do crypto requests */
495 extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */
496 extern int crypto_devallowsoft; /* only use hardware crypto */
499 * Crypto-related utility routines used mainly by drivers.
501 * XXX these don't really belong here; but for now they're
502 * kept apart from the rest of the system.
505 extern void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
506 extern void cuio_copyback(struct uio* uio, int off, int len, caddr_t cp);
507 extern int cuio_getptr(struct uio *uio, int loc, int *off);
508 extern int cuio_apply(struct uio *uio, int off, int len,
509 int (*f)(void *, void *, u_int), void *arg);
513 extern int crypto_mbuftoiov(struct mbuf *mbuf, struct iovec **iovptr,
514 int *cnt, int *allocated);
516 extern void crypto_copyback(int flags, caddr_t buf, int off, int size,
518 extern void crypto_copydata(int flags, caddr_t buf, int off, int size,
520 extern int crypto_apply(int flags, caddr_t buf, int off, int len,
521 int (*f)(void *, void *, u_int), void *arg);
523 #endif /* _CRYPTO_CRYPTO_H_ */