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>
54 #include <sys/random.h>
56 #include <sys/kernel.h>
57 #include <sys/module.h>
58 #include <sys/fcntl.h>
63 #include <opencrypto/cryptodev.h>
64 #include <opencrypto/xform.h>
66 SDT_PROVIDER_DECLARE(opencrypto);
68 SDT_PROBE_DEFINE1(opencrypto, dev, ioctl, error, "int"/*line number*/);
70 #ifdef COMPAT_FREEBSD32
71 #include <sys/mount.h>
72 #include <compat/freebsd32/freebsd32.h>
84 struct session2_op32 {
117 struct crparam32 crk_param[CRK_MAXPARAM];
120 struct cryptotstat32 {
121 struct timespec32 acc;
122 struct timespec32 min;
123 struct timespec32 max;
127 struct cryptostats32 {
135 u_int32_t cs_kblocks;
136 struct cryptotstat32 cs_invoke;
137 struct cryptotstat32 cs_done;
138 struct cryptotstat32 cs_cb;
139 struct cryptotstat32 cs_finis;
142 #define CIOCGSESSION32 _IOWR('c', 101, struct session_op32)
143 #define CIOCCRYPT32 _IOWR('c', 103, struct crypt_op32)
144 #define CIOCKEY32 _IOWR('c', 104, struct crypt_kop32)
145 #define CIOCGSESSION232 _IOWR('c', 106, struct session2_op32)
146 #define CIOCKEY232 _IOWR('c', 107, struct crypt_kop32)
149 session_op_from_32(const struct session_op32 *from, struct session_op *to)
152 CP(*from, *to, cipher);
154 CP(*from, *to, keylen);
155 PTRIN_CP(*from, *to, key);
156 CP(*from, *to, mackeylen);
157 PTRIN_CP(*from, *to, mackey);
162 session2_op_from_32(const struct session2_op32 *from, struct session2_op *to)
165 session_op_from_32((const struct session_op32 *)from,
166 (struct session_op *)to);
167 CP(*from, *to, crid);
171 session_op_to_32(const struct session_op *from, struct session_op32 *to)
174 CP(*from, *to, cipher);
176 CP(*from, *to, keylen);
177 PTROUT_CP(*from, *to, key);
178 CP(*from, *to, mackeylen);
179 PTROUT_CP(*from, *to, mackey);
184 session2_op_to_32(const struct session2_op *from, struct session2_op32 *to)
187 session_op_to_32((const struct session_op *)from,
188 (struct session_op32 *)to);
189 CP(*from, *to, crid);
193 crypt_op_from_32(const struct crypt_op32 *from, struct crypt_op *to)
198 CP(*from, *to, flags);
200 PTRIN_CP(*from, *to, src);
201 PTRIN_CP(*from, *to, dst);
202 PTRIN_CP(*from, *to, mac);
203 PTRIN_CP(*from, *to, iv);
207 crypt_op_to_32(const struct crypt_op *from, struct crypt_op32 *to)
212 CP(*from, *to, flags);
214 PTROUT_CP(*from, *to, src);
215 PTROUT_CP(*from, *to, dst);
216 PTROUT_CP(*from, *to, mac);
217 PTROUT_CP(*from, *to, iv);
221 crparam_from_32(const struct crparam32 *from, struct crparam *to)
224 PTRIN_CP(*from, *to, crp_p);
225 CP(*from, *to, crp_nbits);
229 crparam_to_32(const struct crparam *from, struct crparam32 *to)
232 PTROUT_CP(*from, *to, crp_p);
233 CP(*from, *to, crp_nbits);
237 crypt_kop_from_32(const struct crypt_kop32 *from, struct crypt_kop *to)
241 CP(*from, *to, crk_op);
242 CP(*from, *to, crk_status);
243 CP(*from, *to, crk_iparams);
244 CP(*from, *to, crk_oparams);
245 CP(*from, *to, crk_crid);
246 for (i = 0; i < CRK_MAXPARAM; i++)
247 crparam_from_32(&from->crk_param[i], &to->crk_param[i]);
251 crypt_kop_to_32(const struct crypt_kop *from, struct crypt_kop32 *to)
255 CP(*from, *to, crk_op);
256 CP(*from, *to, crk_status);
257 CP(*from, *to, crk_iparams);
258 CP(*from, *to, crk_oparams);
259 CP(*from, *to, crk_crid);
260 for (i = 0; i < CRK_MAXPARAM; i++)
261 crparam_to_32(&from->crk_param[i], &to->crk_param[i]);
266 TAILQ_ENTRY(csession) next;
267 crypto_session_t cses;
270 struct mtx lock; /* for op submission */
272 struct enc_xform *txform;
281 struct cryptop_data {
282 struct csession *cse;
289 TAILQ_HEAD(csessionlist, csession) csessions;
294 static int cryptof_ioctl(struct file *, u_long, void *,
295 struct ucred *, struct thread *);
296 static int cryptof_stat(struct file *, struct stat *,
297 struct ucred *, struct thread *);
298 static int cryptof_close(struct file *, struct thread *);
299 static int cryptof_fill_kinfo(struct file *, struct kinfo_file *,
302 static struct fileops cryptofops = {
303 .fo_read = invfo_rdwr,
304 .fo_write = invfo_rdwr,
305 .fo_truncate = invfo_truncate,
306 .fo_ioctl = cryptof_ioctl,
307 .fo_poll = invfo_poll,
308 .fo_kqfilter = invfo_kqfilter,
309 .fo_stat = cryptof_stat,
310 .fo_close = cryptof_close,
311 .fo_chmod = invfo_chmod,
312 .fo_chown = invfo_chown,
313 .fo_sendfile = invfo_sendfile,
314 .fo_fill_kinfo = cryptof_fill_kinfo,
317 static struct csession *csefind(struct fcrypt *, u_int);
318 static bool csedelete(struct fcrypt *, u_int);
319 static struct csession *csecreate(struct fcrypt *, crypto_session_t,
320 struct crypto_session_params *, struct enc_xform *, void *,
321 struct auth_hash *, void *);
322 static void csefree(struct csession *);
324 static int cryptodev_op(struct csession *, struct crypt_op *,
325 struct ucred *, struct thread *td);
326 static int cryptodev_aead(struct csession *, struct crypt_aead *,
327 struct ucred *, struct thread *);
328 static int cryptodev_key(struct crypt_kop *);
329 static int cryptodev_find(struct crypt_find_op *);
332 * Check a crypto identifier to see if it requested
333 * a software device/driver. This can be done either
334 * by device name/class or through search constraints.
337 checkforsoftware(int *cridp)
343 if (!crypto_devallowsoft) {
344 if (crid & CRYPTOCAP_F_SOFTWARE) {
345 if (crid & CRYPTOCAP_F_HARDWARE) {
346 *cridp = CRYPTOCAP_F_HARDWARE;
351 if ((crid & CRYPTOCAP_F_HARDWARE) == 0 &&
352 (crypto_getcaps(crid) & CRYPTOCAP_F_HARDWARE) == 0)
364 struct ucred *active_cred,
367 #define SES2(p) ((struct session2_op *)p)
368 struct crypto_session_params csp;
369 struct fcrypt *fcr = fp->f_data;
370 struct csession *cse;
371 struct session_op *sop;
372 struct crypt_op *cop;
373 struct crypt_aead *caead;
374 struct enc_xform *txform = NULL;
375 struct auth_hash *thash = NULL;
378 struct crypt_kop *kop;
379 crypto_session_t cses;
382 #ifdef COMPAT_FREEBSD32
383 struct session2_op sopc;
384 struct crypt_op copc;
385 struct crypt_kop kopc;
391 #ifdef COMPAT_FREEBSD32
393 case CIOCGSESSION232:
394 if (cmd == CIOCGSESSION32) {
395 session_op_from_32(data, (struct session_op *)&sopc);
396 sop = (struct session_op *)&sopc;
397 } else if (cmd == CIOCGSESSION232) {
398 session2_op_from_32(data, &sopc);
399 sop = (struct session_op *)&sopc;
402 sop = (struct session_op *)data;
403 switch (sop->cipher) {
407 txform = &enc_xform_rijndael128;
410 txform = &enc_xform_aes_xts;
412 case CRYPTO_NULL_CBC:
413 txform = &enc_xform_null;
415 case CRYPTO_CAMELLIA_CBC:
416 txform = &enc_xform_camellia;
419 txform = &enc_xform_aes_icm;
421 case CRYPTO_AES_NIST_GCM_16:
422 txform = &enc_xform_aes_nist_gcm;
424 case CRYPTO_CHACHA20:
425 txform = &enc_xform_chacha20;
427 case CRYPTO_AES_CCM_16:
428 txform = &enc_xform_ccm;
432 CRYPTDEB("invalid cipher");
433 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
440 case CRYPTO_POLY1305:
441 thash = &auth_hash_poly1305;
443 case CRYPTO_SHA1_HMAC:
444 thash = &auth_hash_hmac_sha1;
446 case CRYPTO_SHA2_224_HMAC:
447 thash = &auth_hash_hmac_sha2_224;
449 case CRYPTO_SHA2_256_HMAC:
450 thash = &auth_hash_hmac_sha2_256;
452 case CRYPTO_SHA2_384_HMAC:
453 thash = &auth_hash_hmac_sha2_384;
455 case CRYPTO_SHA2_512_HMAC:
456 thash = &auth_hash_hmac_sha2_512;
458 case CRYPTO_RIPEMD160_HMAC:
459 thash = &auth_hash_hmac_ripemd_160;
461 #ifdef COMPAT_FREEBSD12
462 case CRYPTO_AES_128_NIST_GMAC:
463 case CRYPTO_AES_192_NIST_GMAC:
464 case CRYPTO_AES_256_NIST_GMAC:
465 /* Should always be paired with GCM. */
466 if (sop->cipher != CRYPTO_AES_NIST_GCM_16) {
467 CRYPTDEB("GMAC without GCM");
472 case CRYPTO_AES_NIST_GMAC:
473 switch (sop->mackeylen * 8) {
475 thash = &auth_hash_nist_gmac_aes_128;
478 thash = &auth_hash_nist_gmac_aes_192;
481 thash = &auth_hash_nist_gmac_aes_256;
484 CRYPTDEB("invalid GMAC key length");
485 SDT_PROBE1(opencrypto, dev, ioctl, error,
490 case CRYPTO_AES_CCM_CBC_MAC:
491 switch (sop->mackeylen) {
493 thash = &auth_hash_ccm_cbc_mac_128;
496 thash = &auth_hash_ccm_cbc_mac_192;
499 thash = &auth_hash_ccm_cbc_mac_256;
502 CRYPTDEB("Invalid CBC MAC key size %d",
504 SDT_PROBE1(opencrypto, dev, ioctl,
510 thash = &auth_hash_sha1;
512 case CRYPTO_SHA2_224:
513 thash = &auth_hash_sha2_224;
515 case CRYPTO_SHA2_256:
516 thash = &auth_hash_sha2_256;
518 case CRYPTO_SHA2_384:
519 thash = &auth_hash_sha2_384;
521 case CRYPTO_SHA2_512:
522 thash = &auth_hash_sha2_512;
525 case CRYPTO_NULL_HMAC:
526 thash = &auth_hash_null;
530 thash = &auth_hash_blake2b;
533 thash = &auth_hash_blake2s;
537 CRYPTDEB("invalid mac");
538 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
542 if (txform == NULL && thash == NULL)
545 memset(&csp, 0, sizeof(csp));
547 if (sop->cipher == CRYPTO_AES_NIST_GCM_16) {
549 #ifdef COMPAT_FREEBSD12
550 case CRYPTO_AES_128_NIST_GMAC:
551 case CRYPTO_AES_192_NIST_GMAC:
552 case CRYPTO_AES_256_NIST_GMAC:
553 if (sop->keylen != sop->mackeylen)
562 csp.csp_mode = CSP_MODE_AEAD;
563 } else if (sop->cipher == CRYPTO_AES_CCM_16) {
565 #ifdef COMPAT_FREEBSD12
566 case CRYPTO_AES_CCM_CBC_MAC:
567 if (sop->keylen != sop->mackeylen)
577 csp.csp_mode = CSP_MODE_AEAD;
578 } else if (txform && thash)
579 csp.csp_mode = CSP_MODE_ETA;
581 csp.csp_mode = CSP_MODE_CIPHER;
583 csp.csp_mode = CSP_MODE_DIGEST;
586 csp.csp_cipher_alg = txform->type;
587 csp.csp_cipher_klen = sop->keylen;
588 if (sop->keylen > txform->maxkey ||
589 sop->keylen < txform->minkey) {
590 CRYPTDEB("invalid cipher parameters");
592 SDT_PROBE1(opencrypto, dev, ioctl, error,
597 key = malloc(csp.csp_cipher_klen, M_XDATA, M_WAITOK);
598 error = copyin(sop->key, key, csp.csp_cipher_klen);
600 CRYPTDEB("invalid key");
601 SDT_PROBE1(opencrypto, dev, ioctl, error,
605 csp.csp_cipher_key = key;
606 csp.csp_ivlen = txform->ivsize;
610 csp.csp_auth_alg = thash->type;
611 csp.csp_auth_klen = sop->mackeylen;
612 if (sop->mackeylen > thash->keysize ||
613 sop->mackeylen < 0) {
614 CRYPTDEB("invalid mac key length");
616 SDT_PROBE1(opencrypto, dev, ioctl, error,
621 if (csp.csp_auth_klen) {
622 mackey = malloc(csp.csp_auth_klen, M_XDATA,
624 error = copyin(sop->mackey, mackey,
627 CRYPTDEB("invalid mac key");
628 SDT_PROBE1(opencrypto, dev, ioctl,
632 csp.csp_auth_key = mackey;
635 if (csp.csp_auth_alg == CRYPTO_AES_NIST_GMAC)
636 csp.csp_ivlen = AES_GCM_IV_LEN;
637 if (csp.csp_auth_alg == CRYPTO_AES_CCM_CBC_MAC)
638 csp.csp_ivlen = AES_CCM_IV_LEN;
641 /* NB: CIOCGSESSION2 has the crid */
642 if (cmd == CIOCGSESSION2
643 #ifdef COMPAT_FREEBSD32
644 || cmd == CIOCGSESSION232
647 crid = SES2(sop)->crid;
648 error = checkforsoftware(&crid);
650 CRYPTDEB("checkforsoftware");
651 SDT_PROBE1(opencrypto, dev, ioctl, error,
656 crid = CRYPTOCAP_F_HARDWARE;
657 error = crypto_newsession(&cses, &csp, crid);
659 CRYPTDEB("crypto_newsession");
660 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
664 cse = csecreate(fcr, cses, &csp, txform, key, thash, mackey);
667 crypto_freesession(cses);
669 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
670 CRYPTDEB("csecreate");
674 if (cmd == CIOCGSESSION2
675 #ifdef COMPAT_FREEBSD32
676 || cmd == CIOCGSESSION232
679 /* return hardware/driver id */
680 SES2(sop)->crid = crypto_ses2hid(cse->cses);
685 free(mackey, M_XDATA);
687 #ifdef COMPAT_FREEBSD32
689 if (cmd == CIOCGSESSION32)
690 session_op_to_32(sop, data);
691 else if (cmd == CIOCGSESSION232)
692 session2_op_to_32((struct session2_op *)sop,
698 ses = *(u_int32_t *)data;
699 if (!csedelete(fcr, ses)) {
700 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
705 #ifdef COMPAT_FREEBSD32
707 if (cmd == CIOCCRYPT32) {
709 crypt_op_from_32(data, cop);
712 cop = (struct crypt_op *)data;
713 cse = csefind(fcr, cop->ses);
715 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
718 error = cryptodev_op(cse, cop, active_cred, td);
720 #ifdef COMPAT_FREEBSD32
721 if (error == 0 && cmd == CIOCCRYPT32)
722 crypt_op_to_32(cop, data);
727 #ifdef COMPAT_FREEBSD32
731 if (!crypto_userasymcrypto) {
732 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
733 return (EPERM); /* XXX compat? */
735 #ifdef COMPAT_FREEBSD32
736 if (cmd == CIOCKEY32 || cmd == CIOCKEY232) {
738 crypt_kop_from_32(data, kop);
741 kop = (struct crypt_kop *)data;
743 #ifdef COMPAT_FREEBSD32
747 /* NB: crypto core enforces s/w driver use */
749 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE;
752 error = cryptodev_key(kop);
754 #ifdef COMPAT_FREEBSD32
755 if (cmd == CIOCKEY32 || cmd == CIOCKEY232)
756 crypt_kop_to_32(kop, data);
760 if (!crypto_userasymcrypto) {
762 * NB: if user asym crypto operations are
763 * not permitted return "no algorithms"
764 * so well-behaved applications will just
765 * fallback to doing them in software.
769 error = crypto_getfeat((int *)data);
771 SDT_PROBE1(opencrypto, dev, ioctl, error,
776 error = cryptodev_find((struct crypt_find_op *)data);
779 caead = (struct crypt_aead *)data;
780 cse = csefind(fcr, caead->ses);
782 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
785 error = cryptodev_aead(cse, caead, active_cred, td);
790 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
797 static int cryptodev_cb(struct cryptop *);
799 static struct cryptop_data *
800 cod_alloc(struct csession *cse, size_t len, struct thread *td)
802 struct cryptop_data *cod;
804 cod = malloc(sizeof(struct cryptop_data), M_XDATA, M_WAITOK | M_ZERO);
807 cod->buf = malloc(len, M_XDATA, M_WAITOK);
812 cod_free(struct cryptop_data *cod)
815 free(cod->buf, M_XDATA);
821 struct csession *cse,
822 struct crypt_op *cop,
823 struct ucred *active_cred,
826 struct cryptop_data *cod = NULL;
827 struct cryptop *crp = NULL;
830 if (cop->len > 256*1024-4) {
831 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
836 if (cop->len == 0 || (cop->len % cse->txform->blocksize) != 0) {
837 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
842 if (cop->mac && cse->hashsize == 0) {
843 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
848 * The COP_F_CIPHER_FIRST flag predates explicit session
849 * modes, but the only way it was used was for EtA so allow it
850 * as long as it is consistent with EtA.
852 if (cop->flags & COP_F_CIPHER_FIRST) {
853 if (cop->op != COP_ENCRYPT) {
854 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
859 cod = cod_alloc(cse, cop->len + cse->hashsize, td);
861 crp = crypto_getreq(cse->cses, M_WAITOK);
863 error = copyin(cop->src, cod->buf, cop->len);
865 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
868 crp->crp_payload_start = 0;
869 crp->crp_payload_length = cop->len;
871 crp->crp_digest_start = cop->len;
874 case CSP_MODE_COMPRESS:
877 crp->crp_op = CRYPTO_OP_COMPRESS;
880 crp->crp_op = CRYPTO_OP_DECOMPRESS;
883 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
888 case CSP_MODE_CIPHER:
891 crp->crp_op = CRYPTO_OP_ENCRYPT;
894 crp->crp_op = CRYPTO_OP_DECRYPT;
897 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
902 case CSP_MODE_DIGEST:
907 crp->crp_op = CRYPTO_OP_COMPUTE_DIGEST;
910 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
918 crp->crp_op = CRYPTO_OP_ENCRYPT |
919 CRYPTO_OP_COMPUTE_DIGEST;
922 crp->crp_op = CRYPTO_OP_DECRYPT |
923 CRYPTO_OP_VERIFY_DIGEST;
926 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
932 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
937 crp->crp_ilen = cop->len + cse->hashsize;
938 crp->crp_flags = CRYPTO_F_CBIMM | (cop->flags & COP_F_BATCH);
939 crp->crp_buf = cod->buf;
940 crp->crp_buf_type = CRYPTO_BUF_CONTIG;
941 crp->crp_callback = cryptodev_cb;
942 crp->crp_opaque = cod;
945 if (cse->ivsize == 0) {
946 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
950 error = copyin(cop->iv, crp->crp_iv, cse->ivsize);
952 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
955 crp->crp_flags |= CRYPTO_F_IV_SEPARATE;
956 } else if (cse->ivsize != 0) {
957 crp->crp_iv_start = 0;
958 crp->crp_payload_start += cse->ivsize;
959 crp->crp_payload_length -= cse->ivsize;
962 if (cop->mac != NULL) {
963 error = copyin(cop->mac, cod->buf + cop->len, cse->hashsize);
965 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
971 * Let the dispatch run unlocked, then, interlock against the
972 * callback before checking if the operation completed and going
973 * to sleep. This insures drivers don't inherit our lock which
974 * results in a lock order reversal between crypto_dispatch forced
975 * entry and the crypto_done callback into us.
977 error = crypto_dispatch(crp);
979 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
983 mtx_lock(&cse->lock);
985 mtx_sleep(cod, &cse->lock, PWAIT, "crydev", 0);
986 mtx_unlock(&cse->lock);
988 if (crp->crp_etype == EAGAIN) {
990 crp->crp_flags &= ~CRYPTO_F_DONE;
995 if (crp->crp_etype != 0) {
996 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
997 error = crp->crp_etype;
1001 if (cop->dst != NULL) {
1002 error = copyout(cod->buf, cop->dst, cop->len);
1004 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1009 if (cop->mac != NULL) {
1010 error = copyout(cod->buf + cop->len, cop->mac, cse->hashsize);
1012 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1018 crypto_freereq(crp);
1026 struct csession *cse,
1027 struct crypt_aead *caead,
1028 struct ucred *active_cred,
1031 struct cryptop_data *cod = NULL;
1032 struct cryptop *crp = NULL;
1035 if (caead->len > 256*1024-4 || caead->aadlen > 256*1024-4) {
1036 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1040 if (cse->txform == NULL || cse->hashsize == 0 || caead->tag == NULL ||
1041 (caead->len % cse->txform->blocksize) != 0) {
1042 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1047 * The COP_F_CIPHER_FIRST flag predates explicit session
1048 * modes, but the only way it was used was for EtA so allow it
1049 * as long as it is consistent with EtA.
1051 if (caead->flags & COP_F_CIPHER_FIRST) {
1052 if (caead->op != COP_ENCRYPT) {
1053 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1058 cod = cod_alloc(cse, caead->aadlen + caead->len + cse->hashsize, td);
1060 crp = crypto_getreq(cse->cses, M_WAITOK);
1062 error = copyin(caead->aad, cod->buf, caead->aadlen);
1064 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1067 crp->crp_aad_start = 0;
1068 crp->crp_aad_length = caead->aadlen;
1070 error = copyin(caead->src, cod->buf + caead->aadlen, caead->len);
1072 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1075 crp->crp_payload_start = caead->aadlen;
1076 crp->crp_payload_length = caead->len;
1077 crp->crp_digest_start = caead->aadlen + caead->len;
1079 switch (cse->mode) {
1081 switch (caead->op) {
1083 crp->crp_op = CRYPTO_OP_ENCRYPT |
1084 CRYPTO_OP_COMPUTE_DIGEST;
1087 crp->crp_op = CRYPTO_OP_DECRYPT |
1088 CRYPTO_OP_VERIFY_DIGEST;
1091 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1097 switch (caead->op) {
1099 crp->crp_op = CRYPTO_OP_ENCRYPT |
1100 CRYPTO_OP_COMPUTE_DIGEST;
1103 crp->crp_op = CRYPTO_OP_DECRYPT |
1104 CRYPTO_OP_VERIFY_DIGEST;
1107 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1113 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1118 crp->crp_ilen = caead->aadlen + caead->len + cse->hashsize;
1119 crp->crp_flags = CRYPTO_F_CBIMM | (caead->flags & COP_F_BATCH);
1120 crp->crp_buf = cod->buf;
1121 crp->crp_buf_type = CRYPTO_BUF_CONTIG;
1122 crp->crp_callback = cryptodev_cb;
1123 crp->crp_opaque = cod;
1127 * Permit a 16-byte IV for AES-XTS, but only use the
1128 * first 8 bytes as a block number.
1130 if (cse->mode == CSP_MODE_ETA &&
1131 caead->ivlen == AES_BLOCK_LEN &&
1132 cse->ivsize == AES_XTS_IV_LEN)
1133 caead->ivlen = AES_XTS_IV_LEN;
1135 if (caead->ivlen != cse->ivsize) {
1137 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1141 error = copyin(caead->iv, crp->crp_iv, cse->ivsize);
1143 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1146 crp->crp_flags |= CRYPTO_F_IV_SEPARATE;
1148 crp->crp_iv_start = crp->crp_payload_start;
1149 crp->crp_payload_start += cse->ivsize;
1150 crp->crp_payload_length -= cse->ivsize;
1153 error = copyin(caead->tag, cod->buf + caead->len + caead->aadlen,
1156 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1161 * Let the dispatch run unlocked, then, interlock against the
1162 * callback before checking if the operation completed and going
1163 * to sleep. This insures drivers don't inherit our lock which
1164 * results in a lock order reversal between crypto_dispatch forced
1165 * entry and the crypto_done callback into us.
1167 error = crypto_dispatch(crp);
1169 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1173 mtx_lock(&cse->lock);
1175 mtx_sleep(cod, &cse->lock, PWAIT, "crydev", 0);
1176 mtx_unlock(&cse->lock);
1178 if (crp->crp_etype == EAGAIN) {
1180 crp->crp_flags &= ~CRYPTO_F_DONE;
1185 if (crp->crp_etype != 0) {
1186 error = crp->crp_etype;
1187 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1191 if (caead->dst != NULL) {
1192 error = copyout(cod->buf + caead->aadlen, caead->dst,
1195 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1200 error = copyout(cod->buf + caead->aadlen + caead->len, caead->tag,
1203 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1208 crypto_freereq(crp);
1215 cryptodev_cb(struct cryptop *crp)
1217 struct cryptop_data *cod = crp->crp_opaque;
1220 * Lock to ensure the wakeup() is not missed by the loops
1221 * waiting on cod->done in cryptodev_op() and
1224 mtx_lock(&cod->cse->lock);
1226 mtx_unlock(&cod->cse->lock);
1232 cryptodevkey_cb(struct cryptkop *krp)
1239 cryptodev_key(struct crypt_kop *kop)
1241 struct cryptkop *krp = NULL;
1243 int in, out, size, i;
1245 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
1246 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1250 in = kop->crk_iparams;
1251 out = kop->crk_oparams;
1252 switch (kop->crk_op) {
1254 if (in == 3 && out == 1)
1256 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1258 case CRK_MOD_EXP_CRT:
1259 if (in == 6 && out == 1)
1261 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1264 if (in == 5 && out == 2)
1266 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1268 case CRK_DSA_VERIFY:
1269 if (in == 7 && out == 0)
1271 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1273 case CRK_DH_COMPUTE_KEY:
1274 if (in == 3 && out == 1)
1276 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1279 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1283 krp = (struct cryptkop *)malloc(sizeof *krp, M_XDATA, M_WAITOK|M_ZERO);
1285 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1288 krp->krp_op = kop->crk_op;
1289 krp->krp_status = kop->crk_status;
1290 krp->krp_iparams = kop->crk_iparams;
1291 krp->krp_oparams = kop->crk_oparams;
1292 krp->krp_crid = kop->crk_crid;
1293 krp->krp_status = 0;
1294 krp->krp_callback = cryptodevkey_cb;
1296 for (i = 0; i < CRK_MAXPARAM; i++) {
1297 if (kop->crk_param[i].crp_nbits > 65536) {
1298 /* Limit is the same as in OpenBSD */
1299 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1302 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
1304 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
1305 size = (krp->krp_param[i].crp_nbits + 7) / 8;
1308 krp->krp_param[i].crp_p = malloc(size, M_XDATA, M_WAITOK);
1309 if (i >= krp->krp_iparams)
1311 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
1313 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1318 error = crypto_kdispatch(krp);
1320 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1323 error = tsleep(krp, PSOCK, "crydev", 0);
1325 /* XXX can this happen? if so, how do we recover? */
1326 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1330 kop->crk_crid = krp->krp_hid; /* device that did the work */
1331 if (krp->krp_status != 0) {
1332 error = krp->krp_status;
1333 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1337 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
1338 size = (krp->krp_param[i].crp_nbits + 7) / 8;
1341 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
1343 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1350 kop->crk_status = krp->krp_status;
1351 for (i = 0; i < CRK_MAXPARAM; i++) {
1352 if (krp->krp_param[i].crp_p)
1353 free(krp->krp_param[i].crp_p, M_XDATA);
1361 cryptodev_find(struct crypt_find_op *find)
1364 size_t fnlen = sizeof find->name;
1366 if (find->crid != -1) {
1367 dev = crypto_find_device_byhid(find->crid);
1370 strncpy(find->name, device_get_nameunit(dev), fnlen);
1371 find->name[fnlen - 1] = '\x0';
1373 find->name[fnlen - 1] = '\x0';
1374 find->crid = crypto_find_driver(find->name);
1375 if (find->crid == -1)
1386 struct ucred *active_cred,
1390 return (EOPNOTSUPP);
1395 cryptof_close(struct file *fp, struct thread *td)
1397 struct fcrypt *fcr = fp->f_data;
1398 struct csession *cse;
1400 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
1401 TAILQ_REMOVE(&fcr->csessions, cse, next);
1402 KASSERT(cse->refs == 1,
1403 ("%s: crypto session %p with %d refs", __func__, cse,
1413 cryptof_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
1416 kif->kf_type = KF_TYPE_CRYPTO;
1420 static struct csession *
1421 csefind(struct fcrypt *fcr, u_int ses)
1423 struct csession *cse;
1425 mtx_lock(&fcr->lock);
1426 TAILQ_FOREACH(cse, &fcr->csessions, next) {
1427 if (cse->ses == ses) {
1428 refcount_acquire(&cse->refs);
1429 mtx_unlock(&fcr->lock);
1433 mtx_unlock(&fcr->lock);
1438 csedelete(struct fcrypt *fcr, u_int ses)
1440 struct csession *cse;
1442 mtx_lock(&fcr->lock);
1443 TAILQ_FOREACH(cse, &fcr->csessions, next) {
1444 if (cse->ses == ses) {
1445 TAILQ_REMOVE(&fcr->csessions, cse, next);
1446 mtx_unlock(&fcr->lock);
1451 mtx_unlock(&fcr->lock);
1456 csecreate(struct fcrypt *fcr, crypto_session_t cses,
1457 struct crypto_session_params *csp, struct enc_xform *txform,
1458 void *key, struct auth_hash *thash, void *mackey)
1460 struct csession *cse;
1462 cse = malloc(sizeof(struct csession), M_XDATA, M_NOWAIT | M_ZERO);
1465 mtx_init(&cse->lock, "cryptodev", "crypto session lock", MTX_DEF);
1466 refcount_init(&cse->refs, 1);
1468 cse->mackey = mackey;
1469 cse->mode = csp->csp_mode;
1471 cse->txform = txform;
1473 cse->hashsize = thash->hashsize;
1474 else if (csp->csp_cipher_alg == CRYPTO_AES_NIST_GCM_16)
1475 cse->hashsize = AES_GMAC_HASH_LEN;
1476 else if (csp->csp_cipher_alg == CRYPTO_AES_CCM_16)
1477 cse->hashsize = AES_CBC_MAC_HASH_LEN;
1478 cse->ivsize = csp->csp_ivlen;
1479 mtx_lock(&fcr->lock);
1480 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
1481 cse->ses = fcr->sesn++;
1482 mtx_unlock(&fcr->lock);
1487 csefree(struct csession *cse)
1490 if (!refcount_release(&cse->refs))
1492 crypto_freesession(cse->cses);
1493 mtx_destroy(&cse->lock);
1495 free(cse->key, M_XDATA);
1497 free(cse->mackey, M_XDATA);
1502 cryptoioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
1510 error = falloc_noinstall(td, &f);
1514 fcr = malloc(sizeof(struct fcrypt), M_XDATA, M_WAITOK | M_ZERO);
1515 TAILQ_INIT(&fcr->csessions);
1516 mtx_init(&fcr->lock, "fcrypt", NULL, MTX_DEF);
1518 finit(f, FREAD | FWRITE, DTYPE_CRYPTO, fcr, &cryptofops);
1519 error = finstall(td, f, &fd, 0, NULL);
1521 mtx_destroy(&fcr->lock);
1524 *(uint32_t *)data = fd;
1528 error = cryptodev_find((struct crypt_find_op *)data);
1531 error = crypto_getfeat((int *)data);
1540 static struct cdevsw crypto_cdevsw = {
1541 .d_version = D_VERSION,
1542 .d_ioctl = cryptoioctl,
1545 static struct cdev *crypto_dev;
1548 * Initialization code, both for static and dynamic loading.
1551 cryptodev_modevent(module_t mod, int type, void *unused)
1556 printf("crypto: <crypto device>\n");
1557 crypto_dev = make_dev(&crypto_cdevsw, 0,
1558 UID_ROOT, GID_WHEEL, 0666,
1562 /*XXX disallow if active sessions */
1563 destroy_dev(crypto_dev);
1569 static moduledata_t cryptodev_mod = {
1574 MODULE_VERSION(cryptodev, 1);
1575 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
1576 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);
1577 MODULE_DEPEND(cryptodev, zlib, 1, 1, 1);