1 /* $FreeBSD: src/sys/opencrypto/cryptodev.h,v 1.25 2007/05/09 19:37:02 gnn Exp $ */
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
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
31 * 1. Redistributions of source code must retain the above copyright
32 * notice, this list of conditions and the following disclaimer.
33 * 2. Redistributions in binary form must reproduce the above copyright
34 * notice, this list of conditions and the following disclaimer in the
35 * documentation and/or other materials provided with the distribution.
36 * 3. The name of the author may not be used to endorse or promote products
37 * derived from this software without specific prior written permission.
39 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
40 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
42 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
43 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
45 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
46 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
47 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
48 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50 * Effort sponsored in part by the Defense Advanced Research Projects
51 * Agency (DARPA) and Air Force Research Laboratory, Air Force
52 * Materiel Command, USAF, under agreement number F30602-01-2-0537.
56 #ifndef _CRYPTO_CRYPTO_H_
57 #define _CRYPTO_CRYPTO_H_
59 #include <sys/ioccom.h>
62 /* Some initial values */
63 #define CRYPTO_DRIVERS_INITIAL 4
64 #define CRYPTO_SW_SESSIONS 32
67 #define NULL_HASH_LEN 16
68 #define MD5_HASH_LEN 16
69 #define SHA1_HASH_LEN 20
70 #define RIPEMD160_HASH_LEN 20
71 #define SHA2_256_HASH_LEN 32
72 #define SHA2_384_HASH_LEN 48
73 #define SHA2_512_HASH_LEN 64
74 #define MD5_KPDK_HASH_LEN 16
75 #define SHA1_KPDK_HASH_LEN 20
76 /* Maximum hash algorithm result length */
77 #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */
80 #define NULL_HMAC_BLOCK_LEN 64
81 #define MD5_HMAC_BLOCK_LEN 64
82 #define SHA1_HMAC_BLOCK_LEN 64
83 #define RIPEMD160_HMAC_BLOCK_LEN 64
84 #define SHA2_256_HMAC_BLOCK_LEN 64
85 #define SHA2_384_HMAC_BLOCK_LEN 128
86 #define SHA2_512_HMAC_BLOCK_LEN 128
87 /* Maximum HMAC block length */
88 #define HMAC_MAX_BLOCK_LEN SHA2_512_HMAC_BLOCK_LEN /* Keep this updated */
89 #define HMAC_IPAD_VAL 0x36
90 #define HMAC_OPAD_VAL 0x5C
92 /* Encryption algorithm block sizes */
93 #define NULL_BLOCK_LEN 4
94 #define DES_BLOCK_LEN 8
95 #define DES3_BLOCK_LEN 8
96 #define BLOWFISH_BLOCK_LEN 8
97 #define SKIPJACK_BLOCK_LEN 8
98 #define CAST128_BLOCK_LEN 8
99 #define RIJNDAEL128_BLOCK_LEN 16
100 #define AES_BLOCK_LEN RIJNDAEL128_BLOCK_LEN
101 #define AES_XTS_BLOCK_LEN 16
102 #define AES_XTS_IV_LEN 8
103 #define AESCTR_IV_LEN 8
104 #define AESCTR_BLOCK_LEN 16
105 #define AESGCM_IV_LEN 8
106 #define AESGCM_BLOCK_LEN 1
107 #define AESGMAC_IV_LEN 8
108 #define AESGMAC_BLOCK_LEN 1
109 #define CAMELLIA_BLOCK_LEN 16
110 #define TWOFISH_BLOCK_LEN 16
111 #define SERPENT_BLOCK_LEN 16
112 #define EALG_MAX_BLOCK_LEN AES_BLOCK_LEN /* Keep this updated */
114 #define CRYPTO_ALGORITHM_MIN 1
115 #define CRYPTO_DES_CBC 1
116 #define CRYPTO_3DES_CBC 2
117 #define CRYPTO_BLF_CBC 3
118 #define CRYPTO_CAST_CBC 4
119 #define CRYPTO_SKIPJACK_CBC 5
120 #define CRYPTO_MD5_HMAC 6
121 #define CRYPTO_SHA1_HMAC 7
122 #define CRYPTO_RIPEMD160_HMAC 8
123 #define CRYPTO_MD5_KPDK 9
124 #define CRYPTO_SHA1_KPDK 10
125 #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */
126 #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */
127 #define CRYPTO_ARC4 12
128 #define CRYPTO_MD5 13
129 #define CRYPTO_SHA1 14
130 #define CRYPTO_NULL_HMAC 15
131 #define CRYPTO_NULL_CBC 16
132 #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */
133 #define CRYPTO_SHA2_256_HMAC 18
134 #define CRYPTO_SHA2_384_HMAC 19
135 #define CRYPTO_SHA2_512_HMAC 20
136 #define CRYPTO_CAMELLIA_CBC 21
137 #define CRYPTO_AES_XTS 22
138 #define CRYPTO_AES_CTR 23
139 #define CRYPTO_AES_GCM_16 24
140 #define CRYPTO_AES_128_GMAC 25
141 #define CRYPTO_AES_192_GMAC 26
142 #define CRYPTO_AES_256_GMAC 27
143 #define CRYPTO_AES_GMAC 28
144 #define CRYPTO_TWOFISH_CBC 29
145 #define CRYPTO_SERPENT_CBC 30
146 #define CRYPTO_ALGORITHM_MAX 30 /* Keep updated - see below */
148 /* Algorithm flags */
149 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */
150 #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */
151 #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */
154 * Crypto driver/device flags. They can set in the crid
155 * parameter when creating a session or submitting a key
156 * op to affect the device/driver assigned. If neither
157 * of these are specified then the crid is assumed to hold
158 * the driver id of an existing (and suitable) device that
159 * must be used to satisfy the request.
161 #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */
162 #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */
166 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */
167 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */
169 u_int32_t keylen; /* cipher key */
171 int mackeylen; /* mac key */
174 u_int32_t ses; /* returns: session # */
178 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */
179 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */
181 u_int32_t keylen; /* cipher key */
183 int mackeylen; /* mac key */
186 u_int32_t ses; /* returns: session # */
187 int crid; /* driver id + flags (rw) */
188 int pad[4]; /* for future expansion */
193 u_int16_t op; /* i.e. COP_ENCRYPT */
194 #define COP_ENCRYPT 1
195 #define COP_DECRYPT 2
197 #define COP_F_BATCH 0x0008 /* Batch op if possible */
199 caddr_t src, dst; /* become iov[] inside kernel */
200 caddr_t mac; /* must be big enough for chosen MAC */
205 * Parameters for looking up a crypto driver/device by
206 * device name or by id. The latter are returned for
207 * created sessions (crid) and completed key operations.
209 struct crypt_find_op {
210 int crid; /* driver id + flags */
211 char name[32]; /* device/driver name */
214 /* bignum parameter, in packed bytes, ... */
220 #define CRK_MAXPARAM 8
223 u_int crk_op; /* ie. CRK_MOD_EXP or other */
224 u_int crk_status; /* return status */
225 u_short crk_iparams; /* # of input parameters */
226 u_short crk_oparams; /* # of output parameters */
227 u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */
228 struct crparam crk_param[CRK_MAXPARAM];
230 #define CRK_ALGORITM_MIN 0
231 #define CRK_MOD_EXP 0
232 #define CRK_MOD_EXP_CRT 1
233 #define CRK_DSA_SIGN 2
234 #define CRK_DSA_VERIFY 3
235 #define CRK_DH_COMPUTE_KEY 4
236 #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */
238 #define CRF_MOD_EXP (1 << CRK_MOD_EXP)
239 #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT)
240 #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN)
241 #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY)
242 #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY)
245 * done against open of /dev/crypto, to get a cloned descriptor.
246 * Please use F_SETFD against the cloned descriptor.
248 #define CRIOGET _IOWR('c', 100, u_int32_t)
249 #define CRIOASYMFEAT CIOCASYMFEAT
250 #define CRIOFINDDEV CIOCFINDDEV
252 /* the following are done against the cloned descriptor */
253 #define CIOCGSESSION _IOWR('c', 101, struct session_op)
254 #define CIOCFSESSION _IOW('c', 102, u_int32_t)
255 #define CIOCCRYPT _IOWR('c', 103, struct crypt_op)
256 #define CIOCKEY _IOWR('c', 104, struct crypt_kop)
257 #define CIOCASYMFEAT _IOR('c', 105, u_int32_t)
258 #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op)
259 #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop)
260 #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op)
263 struct timespec acc; /* total accumulated time */
264 struct timespec min; /* min time */
265 struct timespec max; /* max time */
266 u_int32_t count; /* number of observations */
270 u_int32_t cs_ops; /* symmetric crypto ops submitted */
271 u_int32_t cs_errs; /* symmetric crypto ops that failed */
272 u_int32_t cs_kops; /* asymetric/key ops submitted */
273 u_int32_t cs_kerrs; /* asymetric/key ops that failed */
274 u_int32_t cs_intrs; /* crypto swi thread activations */
275 u_int32_t cs_rets; /* crypto return thread activations */
276 u_int32_t cs_blocks; /* symmetric op driver block */
277 u_int32_t cs_kblocks; /* symmetric op driver block */
279 * When CRYPTO_TIMING is defined at compile time and the
280 * sysctl debug.crypto is set to 1, the crypto system will
281 * accumulate statistics about how long it takes to process
282 * crypto requests at various points during processing.
284 struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */
285 struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */
286 struct cryptotstat cs_cb; /* crypto_done -> callback */
287 struct cryptotstat cs_finis; /* callback -> callback return */
291 /* Standard initialization structure beginning */
293 int cri_alg; /* Algorithm to use */
294 int cri_klen; /* Key length, in bits */
295 int cri_mlen; /* Number of bytes we want from the
296 entire hash. 0 means all. */
297 caddr_t cri_key; /* key to use */
298 u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */
299 struct cryptoini *cri_next;
302 /* Describe boundaries of a single crypto operation */
304 int crd_skip; /* How many bytes to ignore from start */
305 int crd_len; /* How many bytes to process */
306 int crd_inject; /* Where to inject results, if applicable */
309 #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */
310 #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in
311 place, so don't copy. */
312 #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */
313 #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */
314 #define CRD_F_COMP 0x0f /* Set when doing compression */
315 #define CRD_F_KEY_EXPLICIT 0x10 /* Key explicitly provided */
317 struct cryptoini CRD_INI; /* Initialization/context data */
318 #define crd_iv CRD_INI.cri_iv
319 #define crd_key CRD_INI.cri_key
320 #define crd_alg CRD_INI.cri_alg
321 #define crd_klen CRD_INI.cri_klen
323 struct cryptodesc *crd_next;
326 /* Structure describing complete operation */
328 TAILQ_ENTRY(cryptop) crp_next;
330 u_int64_t crp_sid; /* Session ID */
331 int crp_ilen; /* Input data total length */
332 int crp_olen; /* Result total length */
335 * Error type (zero means no error).
336 * All error codes except EAGAIN
337 * indicate possible data corruption (as in,
338 * the data have been touched). On all
339 * errors, the crp_sid may have changed
340 * (reset to a new one), so the caller
341 * should always check and use the new
342 * value on future requests.
346 #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */
347 #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */
348 #define CRYPTO_F_REL 0x0004 /* Must return data in same place */
349 #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible */
350 #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */
351 #define CRYPTO_F_DONE 0x0020 /* Operation completed */
352 #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */
354 caddr_t crp_buf; /* Data to be processed */
355 caddr_t crp_opaque; /* Opaque pointer, passed along */
356 struct cryptodesc *crp_desc; /* Linked list of processing descriptors */
358 int (*crp_callback)(struct cryptop *); /* Callback function */
360 struct timespec crp_tstamp; /* performance time stamp */
365 #define CRYPTO_BUF_CONTIG 0x0
366 #define CRYPTO_BUF_IOV 0x1
367 #define CRYPTO_BUF_MBUF 0x2
369 #define CRYPTO_OP_DECRYPT 0x0
370 #define CRYPTO_OP_ENCRYPT 0x1
373 * Hints passed to process methods.
375 #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */
378 TAILQ_ENTRY(cryptkop) krp_next;
380 u_int krp_op; /* ie. CRK_MOD_EXP or other */
381 u_int krp_status; /* return status */
382 u_short krp_iparams; /* # of input parameters */
383 u_short krp_oparams; /* # of output parameters */
384 u_int krp_crid; /* desired device, etc. */
386 struct crparam krp_param[CRK_MAXPARAM]; /* kvm */
387 int (*krp_callback)(struct cryptkop *);
391 * Session ids are 64 bits. The lower 32 bits contain a "local id" which
392 * is a driver-private session identifier. The upper 32 bits contain a
393 * "hardware id" used by the core crypto code to identify the driver and
394 * a copy of the driver's capabilities that can be used by client code to
395 * optimize operation.
397 #define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0x00ffffff)
398 #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 32) & 0xff000000)
399 #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff)
401 MALLOC_DECLARE(M_CRYPTO_DATA);
403 extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard);
404 extern int crypto_freesession(u_int64_t sid);
405 #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE
406 #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE
407 #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */
408 #define CRYPTOCAP_F_SMP 0x08000000 /* SMP dispatch ok */
409 extern int32_t crypto_get_driverid(device_t dev, int flags);
410 extern int crypto_find_driver(const char *);
411 extern device_t crypto_find_device_byhid(int hid);
412 extern int crypto_getcaps(int hid);
413 extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
415 extern int crypto_kregister(u_int32_t, int, u_int32_t);
416 extern int crypto_unregister(u_int32_t driverid, int alg);
417 extern int crypto_unregister_all(u_int32_t driverid);
418 extern int crypto_dispatch(struct cryptop *crp);
419 extern int crypto_kdispatch(struct cryptkop *);
420 #define CRYPTO_SYMQ 0x1
421 #define CRYPTO_ASYMQ 0x2
422 extern int crypto_unblock(u_int32_t, int);
423 extern void crypto_done(struct cryptop *crp);
424 extern void crypto_kdone(struct cryptkop *);
425 extern int crypto_getfeat(int *);
427 extern void crypto_freereq(struct cryptop *crp);
428 extern struct cryptop *crypto_getreq(int num);
430 extern int crypto_usercrypto; /* userland may do crypto requests */
431 extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */
432 extern int crypto_devallowsoft; /* only use hardware crypto */
435 * Crypto-related utility routines used mainly by drivers.
437 * XXX these don't really belong here; but for now they're
438 * kept apart from the rest of the system.
441 extern void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
442 extern void cuio_copyback(struct uio* uio, int off, int len, caddr_t cp);
443 extern struct iovec *cuio_getptr(struct uio *uio, int loc, int *off);
444 extern int cuio_apply(struct uio *uio, int off, int len,
445 int (*f)(void *, void *, u_int), void *arg);
447 extern void crypto_copyback(int flags, caddr_t buf, int off, int size,
449 extern void crypto_copydata(int flags, caddr_t buf, int off, int size,
451 extern int crypto_apply(int flags, caddr_t buf, int off, int len,
452 int (*f)(void *, void *, u_int), void *arg);
454 #endif /* _CRYPTO_CRYPTO_H_ */