1 /* $OpenBSD: cryptodev.c,v 1.52 2002/06/19 07:22:46 deraadt Exp $ */
4 * Copyright (c) 2001 Theo de Raadt
5 * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting
6 * Copyright (c) 2014 The FreeBSD Foundation
9 * Portions of this software were developed by John-Mark Gurney
10 * under sponsorship of the FreeBSD Foundation and
11 * Rubicon Communications, LLC (Netgate).
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. The name of the author may not be used to endorse or promote products
23 * derived from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Effort sponsored in part by the Defense Advanced Research Projects
37 * Agency (DARPA) and Air Force Research Laboratory, Air Force
38 * Materiel Command, USAF, under agreement number F30602-01-2-0537.
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/malloc.h>
49 #include <sys/mutex.h>
50 #include <sys/sysctl.h>
52 #include <sys/filedesc.h>
53 #include <sys/errno.h>
55 #include <sys/random.h>
57 #include <sys/kernel.h>
58 #include <sys/module.h>
59 #include <sys/fcntl.h>
64 #include <opencrypto/cryptodev.h>
65 #include <opencrypto/xform.h>
67 SDT_PROVIDER_DECLARE(opencrypto);
69 SDT_PROBE_DEFINE1(opencrypto, dev, ioctl, error, "int"/*line number*/);
71 #ifdef COMPAT_FREEBSD32
72 #include <sys/mount.h>
73 #include <compat/freebsd32/freebsd32.h>
85 struct session2_op32 {
118 struct crparam32 crk_param[CRK_MAXPARAM];
121 struct cryptotstat32 {
122 struct timespec32 acc;
123 struct timespec32 min;
124 struct timespec32 max;
128 struct cryptostats32 {
136 u_int32_t cs_kblocks;
137 struct cryptotstat32 cs_invoke;
138 struct cryptotstat32 cs_done;
139 struct cryptotstat32 cs_cb;
140 struct cryptotstat32 cs_finis;
143 #define CIOCGSESSION32 _IOWR('c', 101, struct session_op32)
144 #define CIOCCRYPT32 _IOWR('c', 103, struct crypt_op32)
145 #define CIOCKEY32 _IOWR('c', 104, struct crypt_kop32)
146 #define CIOCGSESSION232 _IOWR('c', 106, struct session2_op32)
147 #define CIOCKEY232 _IOWR('c', 107, struct crypt_kop32)
150 session_op_from_32(const struct session_op32 *from, struct session_op *to)
153 CP(*from, *to, cipher);
155 CP(*from, *to, keylen);
156 PTRIN_CP(*from, *to, key);
157 CP(*from, *to, mackeylen);
158 PTRIN_CP(*from, *to, mackey);
163 session2_op_from_32(const struct session2_op32 *from, struct session2_op *to)
166 session_op_from_32((const struct session_op32 *)from,
167 (struct session_op *)to);
168 CP(*from, *to, crid);
172 session_op_to_32(const struct session_op *from, struct session_op32 *to)
175 CP(*from, *to, cipher);
177 CP(*from, *to, keylen);
178 PTROUT_CP(*from, *to, key);
179 CP(*from, *to, mackeylen);
180 PTROUT_CP(*from, *to, mackey);
185 session2_op_to_32(const struct session2_op *from, struct session2_op32 *to)
188 session_op_to_32((const struct session_op *)from,
189 (struct session_op32 *)to);
190 CP(*from, *to, crid);
194 crypt_op_from_32(const struct crypt_op32 *from, struct crypt_op *to)
199 CP(*from, *to, flags);
201 PTRIN_CP(*from, *to, src);
202 PTRIN_CP(*from, *to, dst);
203 PTRIN_CP(*from, *to, mac);
204 PTRIN_CP(*from, *to, iv);
208 crypt_op_to_32(const struct crypt_op *from, struct crypt_op32 *to)
213 CP(*from, *to, flags);
215 PTROUT_CP(*from, *to, src);
216 PTROUT_CP(*from, *to, dst);
217 PTROUT_CP(*from, *to, mac);
218 PTROUT_CP(*from, *to, iv);
222 crparam_from_32(const struct crparam32 *from, struct crparam *to)
225 PTRIN_CP(*from, *to, crp_p);
226 CP(*from, *to, crp_nbits);
230 crparam_to_32(const struct crparam *from, struct crparam32 *to)
233 PTROUT_CP(*from, *to, crp_p);
234 CP(*from, *to, crp_nbits);
238 crypt_kop_from_32(const struct crypt_kop32 *from, struct crypt_kop *to)
242 CP(*from, *to, crk_op);
243 CP(*from, *to, crk_status);
244 CP(*from, *to, crk_iparams);
245 CP(*from, *to, crk_oparams);
246 CP(*from, *to, crk_crid);
247 for (i = 0; i < CRK_MAXPARAM; i++)
248 crparam_from_32(&from->crk_param[i], &to->crk_param[i]);
252 crypt_kop_to_32(const struct crypt_kop *from, struct crypt_kop32 *to)
256 CP(*from, *to, crk_op);
257 CP(*from, *to, crk_status);
258 CP(*from, *to, crk_iparams);
259 CP(*from, *to, crk_oparams);
260 CP(*from, *to, crk_crid);
261 for (i = 0; i < CRK_MAXPARAM; i++)
262 crparam_to_32(&from->crk_param[i], &to->crk_param[i]);
267 TAILQ_ENTRY(csession) next;
268 crypto_session_t cses;
270 struct mtx lock; /* for op submission */
273 struct enc_xform *txform;
275 struct auth_hash *thash;
284 struct cryptop_data {
285 struct csession *cse;
287 struct iovec iovec[1];
293 TAILQ_HEAD(csessionlist, csession) csessions;
297 static int cryptof_ioctl(struct file *, u_long, void *,
298 struct ucred *, struct thread *);
299 static int cryptof_stat(struct file *, struct stat *,
300 struct ucred *, struct thread *);
301 static int cryptof_close(struct file *, struct thread *);
302 static int cryptof_fill_kinfo(struct file *, struct kinfo_file *,
305 static struct fileops cryptofops = {
306 .fo_read = invfo_rdwr,
307 .fo_write = invfo_rdwr,
308 .fo_truncate = invfo_truncate,
309 .fo_ioctl = cryptof_ioctl,
310 .fo_poll = invfo_poll,
311 .fo_kqfilter = invfo_kqfilter,
312 .fo_stat = cryptof_stat,
313 .fo_close = cryptof_close,
314 .fo_chmod = invfo_chmod,
315 .fo_chown = invfo_chown,
316 .fo_sendfile = invfo_sendfile,
317 .fo_fill_kinfo = cryptof_fill_kinfo,
320 static struct csession *csefind(struct fcrypt *, u_int);
321 static int csedelete(struct fcrypt *, struct csession *);
322 static struct csession *cseadd(struct fcrypt *, struct csession *);
323 static struct csession *csecreate(struct fcrypt *, crypto_session_t, caddr_t,
324 u_int64_t, caddr_t, u_int64_t, u_int32_t, u_int32_t, struct enc_xform *,
326 static void csefree(struct csession *);
328 static int cryptodev_op(struct csession *, struct crypt_op *,
329 struct ucred *, struct thread *td);
330 static int cryptodev_aead(struct csession *, struct crypt_aead *,
331 struct ucred *, struct thread *);
332 static int cryptodev_key(struct crypt_kop *);
333 static int cryptodev_find(struct crypt_find_op *);
336 * Check a crypto identifier to see if it requested
337 * a software device/driver. This can be done either
338 * by device name/class or through search constraints.
341 checkforsoftware(int *cridp)
347 if (!crypto_devallowsoft) {
348 if (crid & CRYPTOCAP_F_SOFTWARE) {
349 if (crid & CRYPTOCAP_F_HARDWARE) {
350 *cridp = CRYPTOCAP_F_HARDWARE;
355 if ((crid & CRYPTOCAP_F_HARDWARE) == 0 &&
356 (crypto_getcaps(crid) & CRYPTOCAP_F_HARDWARE) == 0)
368 struct ucred *active_cred,
371 #define SES2(p) ((struct session2_op *)p)
372 struct cryptoini cria, crie;
373 struct fcrypt *fcr = fp->f_data;
374 struct csession *cse;
375 struct session_op *sop;
376 struct crypt_op *cop;
377 struct crypt_aead *caead;
378 struct enc_xform *txform = NULL;
379 struct auth_hash *thash = NULL;
380 struct crypt_kop *kop;
381 crypto_session_t cses;
384 #ifdef COMPAT_FREEBSD32
385 struct session2_op sopc;
386 struct crypt_op copc;
387 struct crypt_kop kopc;
393 #ifdef COMPAT_FREEBSD32
395 case CIOCGSESSION232:
396 if (cmd == CIOCGSESSION32) {
397 session_op_from_32(data, (struct session_op *)&sopc);
398 sop = (struct session_op *)&sopc;
399 } else if (cmd == CIOCGSESSION232) {
400 session2_op_from_32(data, &sopc);
401 sop = (struct session_op *)&sopc;
404 sop = (struct session_op *)data;
405 switch (sop->cipher) {
409 txform = &enc_xform_des;
411 case CRYPTO_3DES_CBC:
412 txform = &enc_xform_3des;
415 txform = &enc_xform_blf;
417 case CRYPTO_CAST_CBC:
418 txform = &enc_xform_cast5;
420 case CRYPTO_SKIPJACK_CBC:
421 txform = &enc_xform_skipjack;
424 txform = &enc_xform_rijndael128;
427 txform = &enc_xform_aes_xts;
429 case CRYPTO_NULL_CBC:
430 txform = &enc_xform_null;
433 txform = &enc_xform_arc4;
435 case CRYPTO_CAMELLIA_CBC:
436 txform = &enc_xform_camellia;
439 txform = &enc_xform_aes_icm;
441 case CRYPTO_AES_NIST_GCM_16:
442 txform = &enc_xform_aes_nist_gcm;
444 case CRYPTO_CHACHA20:
445 txform = &enc_xform_chacha20;
447 case CRYPTO_AES_CCM_16:
448 txform = &enc_xform_ccm;
452 CRYPTDEB("invalid cipher");
453 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
460 case CRYPTO_MD5_HMAC:
461 thash = &auth_hash_hmac_md5;
463 case CRYPTO_POLY1305:
464 thash = &auth_hash_poly1305;
466 case CRYPTO_SHA1_HMAC:
467 thash = &auth_hash_hmac_sha1;
469 case CRYPTO_SHA2_224_HMAC:
470 thash = &auth_hash_hmac_sha2_224;
472 case CRYPTO_SHA2_256_HMAC:
473 thash = &auth_hash_hmac_sha2_256;
475 case CRYPTO_SHA2_384_HMAC:
476 thash = &auth_hash_hmac_sha2_384;
478 case CRYPTO_SHA2_512_HMAC:
479 thash = &auth_hash_hmac_sha2_512;
481 case CRYPTO_RIPEMD160_HMAC:
482 thash = &auth_hash_hmac_ripemd_160;
484 case CRYPTO_AES_128_NIST_GMAC:
485 thash = &auth_hash_nist_gmac_aes_128;
487 case CRYPTO_AES_192_NIST_GMAC:
488 thash = &auth_hash_nist_gmac_aes_192;
490 case CRYPTO_AES_256_NIST_GMAC:
491 thash = &auth_hash_nist_gmac_aes_256;
494 case CRYPTO_AES_CCM_CBC_MAC:
495 switch (sop->keylen) {
497 thash = &auth_hash_ccm_cbc_mac_128;
500 thash = &auth_hash_ccm_cbc_mac_192;
503 thash = &auth_hash_ccm_cbc_mac_256;
506 CRYPTDEB("Invalid CBC MAC key size %d",
508 SDT_PROBE1(opencrypto, dev, ioctl,
515 thash = &auth_hash_md5;
519 thash = &auth_hash_sha1;
521 case CRYPTO_SHA2_224:
522 thash = &auth_hash_sha2_224;
524 case CRYPTO_SHA2_256:
525 thash = &auth_hash_sha2_256;
527 case CRYPTO_SHA2_384:
528 thash = &auth_hash_sha2_384;
530 case CRYPTO_SHA2_512:
531 thash = &auth_hash_sha2_512;
534 case CRYPTO_NULL_HMAC:
535 thash = &auth_hash_null;
539 thash = &auth_hash_blake2b;
542 thash = &auth_hash_blake2s;
546 CRYPTDEB("invalid mac");
547 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
551 bzero(&crie, sizeof(crie));
552 bzero(&cria, sizeof(cria));
555 crie.cri_alg = txform->type;
556 crie.cri_klen = sop->keylen * 8;
557 if (sop->keylen > txform->maxkey ||
558 sop->keylen < txform->minkey) {
559 CRYPTDEB("invalid cipher parameters");
561 SDT_PROBE1(opencrypto, dev, ioctl, error,
566 crie.cri_key = malloc(crie.cri_klen / 8,
568 if ((error = copyin(sop->key, crie.cri_key,
569 crie.cri_klen / 8))) {
570 CRYPTDEB("invalid key");
571 SDT_PROBE1(opencrypto, dev, ioctl, error,
576 crie.cri_next = &cria;
580 cria.cri_alg = thash->type;
581 cria.cri_klen = sop->mackeylen * 8;
582 if (thash->keysize != 0 &&
583 sop->mackeylen > thash->keysize) {
584 CRYPTDEB("invalid mac key length");
586 SDT_PROBE1(opencrypto, dev, ioctl, error,
592 cria.cri_key = malloc(cria.cri_klen / 8,
594 if ((error = copyin(sop->mackey, cria.cri_key,
595 cria.cri_klen / 8))) {
596 CRYPTDEB("invalid mac key");
597 SDT_PROBE1(opencrypto, dev, ioctl,
604 /* NB: CIOCGSESSION2 has the crid */
605 if (cmd == CIOCGSESSION2
606 #ifdef COMPAT_FREEBSD32
607 || cmd == CIOCGSESSION232
610 crid = SES2(sop)->crid;
611 error = checkforsoftware(&crid);
613 CRYPTDEB("checkforsoftware");
614 SDT_PROBE1(opencrypto, dev, ioctl, error,
619 crid = CRYPTOCAP_F_HARDWARE;
620 error = crypto_newsession(&cses, (txform ? &crie : &cria), crid);
622 CRYPTDEB("crypto_newsession");
623 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
627 cse = csecreate(fcr, cses, crie.cri_key, crie.cri_klen,
628 cria.cri_key, cria.cri_klen, sop->cipher, sop->mac, txform,
632 crypto_freesession(cses);
634 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
635 CRYPTDEB("csecreate");
639 if (cmd == CIOCGSESSION2
640 #ifdef COMPAT_FREEBSD32
641 || cmd == CIOCGSESSION232
644 /* return hardware/driver id */
645 SES2(sop)->crid = crypto_ses2hid(cse->cses);
650 free(crie.cri_key, M_XDATA);
652 free(cria.cri_key, M_XDATA);
654 #ifdef COMPAT_FREEBSD32
656 if (cmd == CIOCGSESSION32)
657 session_op_to_32(sop, data);
658 else if (cmd == CIOCGSESSION232)
659 session2_op_to_32((struct session2_op *)sop,
665 ses = *(u_int32_t *)data;
666 cse = csefind(fcr, ses);
668 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
675 #ifdef COMPAT_FREEBSD32
677 if (cmd == CIOCCRYPT32) {
679 crypt_op_from_32(data, cop);
682 cop = (struct crypt_op *)data;
683 cse = csefind(fcr, cop->ses);
685 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
688 error = cryptodev_op(cse, cop, active_cred, td);
689 #ifdef COMPAT_FREEBSD32
690 if (error == 0 && cmd == CIOCCRYPT32)
691 crypt_op_to_32(cop, data);
696 #ifdef COMPAT_FREEBSD32
700 if (!crypto_userasymcrypto) {
701 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
702 return (EPERM); /* XXX compat? */
704 #ifdef COMPAT_FREEBSD32
705 if (cmd == CIOCKEY32 || cmd == CIOCKEY232) {
707 crypt_kop_from_32(data, kop);
710 kop = (struct crypt_kop *)data;
712 #ifdef COMPAT_FREEBSD32
716 /* NB: crypto core enforces s/w driver use */
718 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE;
721 error = cryptodev_key(kop);
723 #ifdef COMPAT_FREEBSD32
724 if (cmd == CIOCKEY32 || cmd == CIOCKEY232)
725 crypt_kop_to_32(kop, data);
729 if (!crypto_userasymcrypto) {
731 * NB: if user asym crypto operations are
732 * not permitted return "no algorithms"
733 * so well-behaved applications will just
734 * fallback to doing them in software.
738 error = crypto_getfeat((int *)data);
740 SDT_PROBE1(opencrypto, dev, ioctl, error,
745 error = cryptodev_find((struct crypt_find_op *)data);
748 caead = (struct crypt_aead *)data;
749 cse = csefind(fcr, caead->ses);
751 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
754 error = cryptodev_aead(cse, caead, active_cred, td);
758 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
765 static int cryptodev_cb(struct cryptop *);
767 static struct cryptop_data *
768 cod_alloc(struct csession *cse, size_t len, struct thread *td)
770 struct cryptop_data *cod;
773 cod = malloc(sizeof(struct cryptop_data), M_XDATA, M_WAITOK | M_ZERO);
777 uio->uio_iov = cod->iovec;
779 uio->uio_resid = len;
780 uio->uio_segflg = UIO_SYSSPACE;
781 uio->uio_rw = UIO_WRITE;
783 uio->uio_iov[0].iov_len = len;
784 uio->uio_iov[0].iov_base = malloc(len, M_XDATA, M_WAITOK);
789 cod_free(struct cryptop_data *cod)
792 free(cod->uio.uio_iov[0].iov_base, M_XDATA);
798 struct csession *cse,
799 struct crypt_op *cop,
800 struct ucred *active_cred,
803 struct cryptop_data *cod = NULL;
804 struct cryptop *crp = NULL;
805 struct cryptodesc *crde = NULL, *crda = NULL;
808 if (cop->len > 256*1024-4) {
809 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
814 if (cop->len == 0 || (cop->len % cse->txform->blocksize) != 0) {
815 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
821 cod = cod_alloc(cse, cop->len + cse->thash->hashsize, td);
823 cod = cod_alloc(cse, cop->len, td);
825 crp = crypto_getreq((cse->txform != NULL) + (cse->thash != NULL));
827 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
832 if (cse->thash && cse->txform) {
833 if (cop->flags & COP_F_CIPHER_FIRST) {
834 crde = crp->crp_desc;
835 crda = crde->crd_next;
837 crda = crp->crp_desc;
838 crde = crda->crd_next;
840 } else if (cse->thash) {
841 crda = crp->crp_desc;
842 } else if (cse->txform) {
843 crde = crp->crp_desc;
845 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
850 if ((error = copyin(cop->src, cod->uio.uio_iov[0].iov_base,
852 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
858 crda->crd_len = cop->len;
859 crda->crd_inject = cop->len;
861 crda->crd_alg = cse->mac;
862 crda->crd_key = cse->mackey;
863 crda->crd_klen = cse->mackeylen * 8;
867 if (cop->op == COP_ENCRYPT)
868 crde->crd_flags |= CRD_F_ENCRYPT;
870 crde->crd_flags &= ~CRD_F_ENCRYPT;
871 crde->crd_len = cop->len;
872 crde->crd_inject = 0;
874 crde->crd_alg = cse->cipher;
875 crde->crd_key = cse->key;
876 crde->crd_klen = cse->keylen * 8;
879 crp->crp_ilen = cop->len;
880 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIMM
881 | (cop->flags & COP_F_BATCH);
882 crp->crp_uio = &cod->uio;
883 crp->crp_callback = cryptodev_cb;
884 crp->crp_session = cse->cses;
885 crp->crp_opaque = cod;
889 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
893 if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
894 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
898 if ((error = copyin(cop->iv, crde->crd_iv,
899 cse->txform->ivsize))) {
900 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
903 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
905 } else if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
908 crde->crd_flags |= CRD_F_IV_PRESENT;
909 crde->crd_skip = cse->txform->ivsize;
910 crde->crd_len -= cse->txform->ivsize;
913 if (cop->mac && crda == NULL) {
914 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
921 * Let the dispatch run unlocked, then, interlock against the
922 * callback before checking if the operation completed and going
923 * to sleep. This insures drivers don't inherit our lock which
924 * results in a lock order reversal between crypto_dispatch forced
925 * entry and the crypto_done callback into us.
927 error = crypto_dispatch(crp);
929 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
933 mtx_lock(&cse->lock);
935 mtx_sleep(cod, &cse->lock, PWAIT, "crydev", 0);
936 mtx_unlock(&cse->lock);
938 if (crp->crp_etype == EAGAIN) {
940 crp->crp_flags &= ~CRYPTO_F_DONE;
945 if (crp->crp_etype != 0) {
946 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
947 error = crp->crp_etype;
952 (error = copyout(cod->uio.uio_iov[0].iov_base, cop->dst,
954 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
959 (error = copyout((caddr_t)cod->uio.uio_iov[0].iov_base + cop->len,
960 cop->mac, cse->thash->hashsize))) {
961 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
976 struct csession *cse,
977 struct crypt_aead *caead,
978 struct ucred *active_cred,
981 struct cryptop_data *cod = NULL;
982 struct cryptop *crp = NULL;
983 struct cryptodesc *crde = NULL, *crda = NULL;
986 if (caead->len > 256*1024-4 || caead->aadlen > 256*1024-4) {
987 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
991 if (cse->txform == NULL || cse->thash == NULL || caead->tag == NULL ||
992 (caead->len % cse->txform->blocksize) != 0) {
993 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
997 cod = cod_alloc(cse, caead->aadlen + caead->len + cse->thash->hashsize,
1000 crp = crypto_getreq(2);
1003 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1007 if (caead->flags & COP_F_CIPHER_FIRST) {
1008 crde = crp->crp_desc;
1009 crda = crde->crd_next;
1011 crda = crp->crp_desc;
1012 crde = crda->crd_next;
1015 if ((error = copyin(caead->aad, cod->uio.uio_iov[0].iov_base,
1017 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1021 if ((error = copyin(caead->src, (char *)cod->uio.uio_iov[0].iov_base +
1022 caead->aadlen, caead->len))) {
1023 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1028 * For GCM/CCM, crd_len covers only the AAD. For other ciphers
1029 * chained with an HMAC, crd_len covers both the AAD and the
1033 if (cse->cipher == CRYPTO_AES_NIST_GCM_16 ||
1034 cse->cipher == CRYPTO_AES_CCM_16)
1035 crda->crd_len = caead->aadlen;
1037 crda->crd_len = caead->aadlen + caead->len;
1038 crda->crd_inject = caead->aadlen + caead->len;
1040 crda->crd_alg = cse->mac;
1041 crda->crd_key = cse->mackey;
1042 crda->crd_klen = cse->mackeylen * 8;
1044 if (caead->op == COP_ENCRYPT)
1045 crde->crd_flags |= CRD_F_ENCRYPT;
1047 crde->crd_flags &= ~CRD_F_ENCRYPT;
1048 crde->crd_skip = caead->aadlen;
1049 crde->crd_len = caead->len;
1050 crde->crd_inject = caead->aadlen;
1052 crde->crd_alg = cse->cipher;
1053 crde->crd_key = cse->key;
1054 crde->crd_klen = cse->keylen * 8;
1056 crp->crp_ilen = caead->aadlen + caead->len;
1057 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIMM
1058 | (caead->flags & COP_F_BATCH);
1059 crp->crp_uio = &cod->uio;
1060 crp->crp_callback = cryptodev_cb;
1061 crp->crp_session = cse->cses;
1062 crp->crp_opaque = cod;
1065 if (caead->ivlen > sizeof(crde->crd_iv)) {
1067 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1071 if ((error = copyin(caead->iv, crde->crd_iv, caead->ivlen))) {
1072 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1075 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
1077 crde->crd_flags |= CRD_F_IV_PRESENT;
1078 crde->crd_skip += cse->txform->ivsize;
1079 crde->crd_len -= cse->txform->ivsize;
1082 if ((error = copyin(caead->tag, (caddr_t)cod->uio.uio_iov[0].iov_base +
1083 caead->len + caead->aadlen, cse->thash->hashsize))) {
1084 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1089 * Let the dispatch run unlocked, then, interlock against the
1090 * callback before checking if the operation completed and going
1091 * to sleep. This insures drivers don't inherit our lock which
1092 * results in a lock order reversal between crypto_dispatch forced
1093 * entry and the crypto_done callback into us.
1095 error = crypto_dispatch(crp);
1097 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1101 mtx_lock(&cse->lock);
1103 mtx_sleep(cod, &cse->lock, PWAIT, "crydev", 0);
1104 mtx_unlock(&cse->lock);
1106 if (crp->crp_etype == EAGAIN) {
1108 crp->crp_flags &= ~CRYPTO_F_DONE;
1113 if (crp->crp_etype != 0) {
1114 error = crp->crp_etype;
1115 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1119 if (caead->dst && (error = copyout(
1120 (caddr_t)cod->uio.uio_iov[0].iov_base + caead->aadlen, caead->dst,
1122 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1126 if ((error = copyout((caddr_t)cod->uio.uio_iov[0].iov_base +
1127 caead->aadlen + caead->len, caead->tag, cse->thash->hashsize))) {
1128 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1133 crypto_freereq(crp);
1141 cryptodev_cb(struct cryptop *crp)
1143 struct cryptop_data *cod = crp->crp_opaque;
1146 * Lock to ensure the wakeup() is not missed by the loops
1147 * waiting on cod->done in cryptodev_op() and
1150 mtx_lock(&cod->cse->lock);
1152 mtx_unlock(&cod->cse->lock);
1158 cryptodevkey_cb(void *op)
1160 struct cryptkop *krp = (struct cryptkop *) op;
1167 cryptodev_key(struct crypt_kop *kop)
1169 struct cryptkop *krp = NULL;
1171 int in, out, size, i;
1173 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
1174 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1178 in = kop->crk_iparams;
1179 out = kop->crk_oparams;
1180 switch (kop->crk_op) {
1182 if (in == 3 && out == 1)
1184 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1186 case CRK_MOD_EXP_CRT:
1187 if (in == 6 && out == 1)
1189 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1192 if (in == 5 && out == 2)
1194 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1196 case CRK_DSA_VERIFY:
1197 if (in == 7 && out == 0)
1199 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1201 case CRK_DH_COMPUTE_KEY:
1202 if (in == 3 && out == 1)
1204 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1207 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1211 krp = (struct cryptkop *)malloc(sizeof *krp, M_XDATA, M_WAITOK|M_ZERO);
1213 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1216 krp->krp_op = kop->crk_op;
1217 krp->krp_status = kop->crk_status;
1218 krp->krp_iparams = kop->crk_iparams;
1219 krp->krp_oparams = kop->crk_oparams;
1220 krp->krp_crid = kop->crk_crid;
1221 krp->krp_status = 0;
1222 krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb;
1224 for (i = 0; i < CRK_MAXPARAM; i++) {
1225 if (kop->crk_param[i].crp_nbits > 65536) {
1226 /* Limit is the same as in OpenBSD */
1227 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1230 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
1232 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
1233 size = (krp->krp_param[i].crp_nbits + 7) / 8;
1236 krp->krp_param[i].crp_p = malloc(size, M_XDATA, M_WAITOK);
1237 if (i >= krp->krp_iparams)
1239 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
1241 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1246 error = crypto_kdispatch(krp);
1248 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1251 error = tsleep(krp, PSOCK, "crydev", 0);
1253 /* XXX can this happen? if so, how do we recover? */
1254 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1258 kop->crk_crid = krp->krp_crid; /* device that did the work */
1259 if (krp->krp_status != 0) {
1260 error = krp->krp_status;
1261 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1265 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
1266 size = (krp->krp_param[i].crp_nbits + 7) / 8;
1269 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
1271 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1278 kop->crk_status = krp->krp_status;
1279 for (i = 0; i < CRK_MAXPARAM; i++) {
1280 if (krp->krp_param[i].crp_p)
1281 free(krp->krp_param[i].crp_p, M_XDATA);
1289 cryptodev_find(struct crypt_find_op *find)
1292 size_t fnlen = sizeof find->name;
1294 if (find->crid != -1) {
1295 dev = crypto_find_device_byhid(find->crid);
1298 strncpy(find->name, device_get_nameunit(dev), fnlen);
1299 find->name[fnlen - 1] = '\x0';
1301 find->name[fnlen - 1] = '\x0';
1302 find->crid = crypto_find_driver(find->name);
1303 if (find->crid == -1)
1314 struct ucred *active_cred,
1318 return (EOPNOTSUPP);
1323 cryptof_close(struct file *fp, struct thread *td)
1325 struct fcrypt *fcr = fp->f_data;
1326 struct csession *cse;
1328 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
1329 TAILQ_REMOVE(&fcr->csessions, cse, next);
1338 cryptof_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
1341 kif->kf_type = KF_TYPE_CRYPTO;
1345 static struct csession *
1346 csefind(struct fcrypt *fcr, u_int ses)
1348 struct csession *cse;
1350 TAILQ_FOREACH(cse, &fcr->csessions, next)
1351 if (cse->ses == ses)
1357 csedelete(struct fcrypt *fcr, struct csession *cse_del)
1359 struct csession *cse;
1361 TAILQ_FOREACH(cse, &fcr->csessions, next) {
1362 if (cse == cse_del) {
1363 TAILQ_REMOVE(&fcr->csessions, cse, next);
1370 static struct csession *
1371 cseadd(struct fcrypt *fcr, struct csession *cse)
1373 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
1374 cse->ses = fcr->sesn++;
1379 csecreate(struct fcrypt *fcr, crypto_session_t cses, caddr_t key, u_int64_t keylen,
1380 caddr_t mackey, u_int64_t mackeylen, u_int32_t cipher, u_int32_t mac,
1381 struct enc_xform *txform, struct auth_hash *thash)
1383 struct csession *cse;
1385 cse = malloc(sizeof(struct csession), M_XDATA, M_NOWAIT | M_ZERO);
1388 mtx_init(&cse->lock, "cryptodev", "crypto session lock", MTX_DEF);
1390 cse->keylen = keylen/8;
1391 cse->mackey = mackey;
1392 cse->mackeylen = mackeylen/8;
1394 cse->cipher = cipher;
1396 cse->txform = txform;
1403 csefree(struct csession *cse)
1406 crypto_freesession(cse->cses);
1407 mtx_destroy(&cse->lock);
1409 free(cse->key, M_XDATA);
1411 free(cse->mackey, M_XDATA);
1416 cryptoopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
1422 cryptoread(struct cdev *dev, struct uio *uio, int ioflag)
1428 cryptowrite(struct cdev *dev, struct uio *uio, int ioflag)
1434 cryptoioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
1442 fcr = malloc(sizeof(struct fcrypt), M_XDATA, M_WAITOK);
1443 TAILQ_INIT(&fcr->csessions);
1446 error = falloc(td, &f, &fd, 0);
1452 /* falloc automatically provides an extra reference to 'f'. */
1453 finit(f, FREAD | FWRITE, DTYPE_CRYPTO, fcr, &cryptofops);
1454 *(u_int32_t *)data = fd;
1458 error = cryptodev_find((struct crypt_find_op *)data);
1461 error = crypto_getfeat((int *)data);
1470 static struct cdevsw crypto_cdevsw = {
1471 .d_version = D_VERSION,
1472 .d_flags = D_NEEDGIANT,
1473 .d_open = cryptoopen,
1474 .d_read = cryptoread,
1475 .d_write = cryptowrite,
1476 .d_ioctl = cryptoioctl,
1479 static struct cdev *crypto_dev;
1482 * Initialization code, both for static and dynamic loading.
1485 cryptodev_modevent(module_t mod, int type, void *unused)
1490 printf("crypto: <crypto device>\n");
1491 crypto_dev = make_dev(&crypto_cdevsw, 0,
1492 UID_ROOT, GID_WHEEL, 0666,
1496 /*XXX disallow if active sessions */
1497 destroy_dev(crypto_dev);
1503 static moduledata_t cryptodev_mod = {
1508 MODULE_VERSION(cryptodev, 1);
1509 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
1510 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);
1511 MODULE_DEPEND(cryptodev, zlib, 1, 1, 1);