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;
290 TAILQ_HEAD(csessionlist, csession) csessions;
295 static bool use_outputbuffers;
296 SYSCTL_BOOL(_kern_crypto, OID_AUTO, cryptodev_use_output, CTLFLAG_RW,
297 &use_outputbuffers, 0,
298 "Use separate output buffers for /dev/crypto requests.");
300 static int cryptof_ioctl(struct file *, u_long, void *,
301 struct ucred *, struct thread *);
302 static int cryptof_stat(struct file *, struct stat *,
303 struct ucred *, struct thread *);
304 static int cryptof_close(struct file *, struct thread *);
305 static int cryptof_fill_kinfo(struct file *, struct kinfo_file *,
308 static struct fileops cryptofops = {
309 .fo_read = invfo_rdwr,
310 .fo_write = invfo_rdwr,
311 .fo_truncate = invfo_truncate,
312 .fo_ioctl = cryptof_ioctl,
313 .fo_poll = invfo_poll,
314 .fo_kqfilter = invfo_kqfilter,
315 .fo_stat = cryptof_stat,
316 .fo_close = cryptof_close,
317 .fo_chmod = invfo_chmod,
318 .fo_chown = invfo_chown,
319 .fo_sendfile = invfo_sendfile,
320 .fo_fill_kinfo = cryptof_fill_kinfo,
323 static struct csession *csefind(struct fcrypt *, u_int);
324 static bool csedelete(struct fcrypt *, u_int);
325 static struct csession *csecreate(struct fcrypt *, crypto_session_t,
326 struct crypto_session_params *, struct enc_xform *, void *,
327 struct auth_hash *, void *);
328 static void csefree(struct csession *);
330 static int cryptodev_op(struct csession *, struct crypt_op *,
331 struct ucred *, struct thread *td);
332 static int cryptodev_aead(struct csession *, struct crypt_aead *,
333 struct ucred *, struct thread *);
334 static int cryptodev_key(struct crypt_kop *);
335 static int cryptodev_find(struct crypt_find_op *);
338 * Check a crypto identifier to see if it requested
339 * a software device/driver. This can be done either
340 * by device name/class or through search constraints.
343 checkforsoftware(int *cridp)
349 if (!crypto_devallowsoft) {
350 if (crid & CRYPTOCAP_F_SOFTWARE) {
351 if (crid & CRYPTOCAP_F_HARDWARE) {
352 *cridp = CRYPTOCAP_F_HARDWARE;
357 if ((crid & CRYPTOCAP_F_HARDWARE) == 0 &&
358 (crypto_getcaps(crid) & CRYPTOCAP_F_HARDWARE) == 0)
370 struct ucred *active_cred,
373 #define SES2(p) ((struct session2_op *)p)
374 struct crypto_session_params csp;
375 struct fcrypt *fcr = fp->f_data;
376 struct csession *cse;
377 struct session_op *sop;
378 struct crypt_op *cop;
379 struct crypt_aead *caead;
380 struct enc_xform *txform = NULL;
381 struct auth_hash *thash = NULL;
384 struct crypt_kop *kop;
385 crypto_session_t cses;
388 #ifdef COMPAT_FREEBSD32
389 struct session2_op sopc;
390 struct crypt_op copc;
391 struct crypt_kop kopc;
397 #ifdef COMPAT_FREEBSD32
399 case CIOCGSESSION232:
400 if (cmd == CIOCGSESSION32) {
401 session_op_from_32(data, (struct session_op *)&sopc);
402 sop = (struct session_op *)&sopc;
403 } else if (cmd == CIOCGSESSION232) {
404 session2_op_from_32(data, &sopc);
405 sop = (struct session_op *)&sopc;
408 sop = (struct session_op *)data;
409 switch (sop->cipher) {
413 txform = &enc_xform_rijndael128;
416 txform = &enc_xform_aes_xts;
418 case CRYPTO_NULL_CBC:
419 txform = &enc_xform_null;
421 case CRYPTO_CAMELLIA_CBC:
422 txform = &enc_xform_camellia;
425 txform = &enc_xform_aes_icm;
427 case CRYPTO_AES_NIST_GCM_16:
428 txform = &enc_xform_aes_nist_gcm;
430 case CRYPTO_CHACHA20:
431 txform = &enc_xform_chacha20;
433 case CRYPTO_AES_CCM_16:
434 txform = &enc_xform_ccm;
438 CRYPTDEB("invalid cipher");
439 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
446 case CRYPTO_POLY1305:
447 thash = &auth_hash_poly1305;
449 case CRYPTO_SHA1_HMAC:
450 thash = &auth_hash_hmac_sha1;
452 case CRYPTO_SHA2_224_HMAC:
453 thash = &auth_hash_hmac_sha2_224;
455 case CRYPTO_SHA2_256_HMAC:
456 thash = &auth_hash_hmac_sha2_256;
458 case CRYPTO_SHA2_384_HMAC:
459 thash = &auth_hash_hmac_sha2_384;
461 case CRYPTO_SHA2_512_HMAC:
462 thash = &auth_hash_hmac_sha2_512;
464 case CRYPTO_RIPEMD160_HMAC:
465 thash = &auth_hash_hmac_ripemd_160;
467 #ifdef COMPAT_FREEBSD12
468 case CRYPTO_AES_128_NIST_GMAC:
469 case CRYPTO_AES_192_NIST_GMAC:
470 case CRYPTO_AES_256_NIST_GMAC:
471 /* Should always be paired with GCM. */
472 if (sop->cipher != CRYPTO_AES_NIST_GCM_16) {
473 CRYPTDEB("GMAC without GCM");
474 SDT_PROBE1(opencrypto, dev, ioctl, error,
480 case CRYPTO_AES_NIST_GMAC:
481 switch (sop->mackeylen * 8) {
483 thash = &auth_hash_nist_gmac_aes_128;
486 thash = &auth_hash_nist_gmac_aes_192;
489 thash = &auth_hash_nist_gmac_aes_256;
492 CRYPTDEB("invalid GMAC key length");
493 SDT_PROBE1(opencrypto, dev, ioctl, error,
498 case CRYPTO_AES_CCM_CBC_MAC:
499 switch (sop->mackeylen) {
501 thash = &auth_hash_ccm_cbc_mac_128;
504 thash = &auth_hash_ccm_cbc_mac_192;
507 thash = &auth_hash_ccm_cbc_mac_256;
510 CRYPTDEB("Invalid CBC MAC key size %d",
512 SDT_PROBE1(opencrypto, dev, ioctl,
518 thash = &auth_hash_sha1;
520 case CRYPTO_SHA2_224:
521 thash = &auth_hash_sha2_224;
523 case CRYPTO_SHA2_256:
524 thash = &auth_hash_sha2_256;
526 case CRYPTO_SHA2_384:
527 thash = &auth_hash_sha2_384;
529 case CRYPTO_SHA2_512:
530 thash = &auth_hash_sha2_512;
533 case CRYPTO_NULL_HMAC:
534 thash = &auth_hash_null;
538 thash = &auth_hash_blake2b;
541 thash = &auth_hash_blake2s;
545 CRYPTDEB("invalid mac");
546 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
550 if (txform == NULL && thash == NULL) {
551 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
555 memset(&csp, 0, sizeof(csp));
556 if (use_outputbuffers)
557 csp.csp_flags |= CSP_F_SEPARATE_OUTPUT;
559 if (sop->cipher == CRYPTO_AES_NIST_GCM_16) {
561 #ifdef COMPAT_FREEBSD12
562 case CRYPTO_AES_128_NIST_GMAC:
563 case CRYPTO_AES_192_NIST_GMAC:
564 case CRYPTO_AES_256_NIST_GMAC:
565 if (sop->keylen != sop->mackeylen) {
566 SDT_PROBE1(opencrypto, dev, ioctl,
575 SDT_PROBE1(opencrypto, dev, ioctl, error,
579 csp.csp_mode = CSP_MODE_AEAD;
580 } else if (sop->cipher == CRYPTO_AES_CCM_16) {
582 #ifdef COMPAT_FREEBSD12
583 case CRYPTO_AES_CCM_CBC_MAC:
584 if (sop->keylen != sop->mackeylen) {
585 SDT_PROBE1(opencrypto, dev, ioctl,
595 SDT_PROBE1(opencrypto, dev, ioctl, error,
599 csp.csp_mode = CSP_MODE_AEAD;
600 } else if (txform && thash)
601 csp.csp_mode = CSP_MODE_ETA;
603 csp.csp_mode = CSP_MODE_CIPHER;
605 csp.csp_mode = CSP_MODE_DIGEST;
608 csp.csp_cipher_alg = txform->type;
609 csp.csp_cipher_klen = sop->keylen;
610 if (sop->keylen > txform->maxkey ||
611 sop->keylen < txform->minkey) {
612 CRYPTDEB("invalid cipher parameters");
614 SDT_PROBE1(opencrypto, dev, ioctl, error,
619 key = malloc(csp.csp_cipher_klen, M_XDATA, M_WAITOK);
620 error = copyin(sop->key, key, csp.csp_cipher_klen);
622 CRYPTDEB("invalid key");
623 SDT_PROBE1(opencrypto, dev, ioctl, error,
627 csp.csp_cipher_key = key;
628 csp.csp_ivlen = txform->ivsize;
632 csp.csp_auth_alg = thash->type;
633 csp.csp_auth_klen = sop->mackeylen;
634 if (sop->mackeylen > thash->keysize ||
635 sop->mackeylen < 0) {
636 CRYPTDEB("invalid mac key length");
638 SDT_PROBE1(opencrypto, dev, ioctl, error,
643 if (csp.csp_auth_klen) {
644 mackey = malloc(csp.csp_auth_klen, M_XDATA,
646 error = copyin(sop->mackey, mackey,
649 CRYPTDEB("invalid mac key");
650 SDT_PROBE1(opencrypto, dev, ioctl,
654 csp.csp_auth_key = mackey;
657 if (csp.csp_auth_alg == CRYPTO_AES_NIST_GMAC)
658 csp.csp_ivlen = AES_GCM_IV_LEN;
659 if (csp.csp_auth_alg == CRYPTO_AES_CCM_CBC_MAC)
660 csp.csp_ivlen = AES_CCM_IV_LEN;
663 /* NB: CIOCGSESSION2 has the crid */
664 if (cmd == CIOCGSESSION2
665 #ifdef COMPAT_FREEBSD32
666 || cmd == CIOCGSESSION232
669 crid = SES2(sop)->crid;
670 error = checkforsoftware(&crid);
672 CRYPTDEB("checkforsoftware");
673 SDT_PROBE1(opencrypto, dev, ioctl, error,
678 crid = CRYPTOCAP_F_HARDWARE;
679 error = crypto_newsession(&cses, &csp, crid);
681 CRYPTDEB("crypto_newsession");
682 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
686 cse = csecreate(fcr, cses, &csp, txform, key, thash, mackey);
689 crypto_freesession(cses);
691 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
692 CRYPTDEB("csecreate");
696 if (cmd == CIOCGSESSION2
697 #ifdef COMPAT_FREEBSD32
698 || cmd == CIOCGSESSION232
701 /* return hardware/driver id */
702 SES2(sop)->crid = crypto_ses2hid(cse->cses);
707 free(mackey, M_XDATA);
709 #ifdef COMPAT_FREEBSD32
711 if (cmd == CIOCGSESSION32)
712 session_op_to_32(sop, data);
713 else if (cmd == CIOCGSESSION232)
714 session2_op_to_32((struct session2_op *)sop,
720 ses = *(u_int32_t *)data;
721 if (!csedelete(fcr, ses)) {
722 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
727 #ifdef COMPAT_FREEBSD32
729 if (cmd == CIOCCRYPT32) {
731 crypt_op_from_32(data, cop);
734 cop = (struct crypt_op *)data;
735 cse = csefind(fcr, cop->ses);
737 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
740 error = cryptodev_op(cse, cop, active_cred, td);
742 #ifdef COMPAT_FREEBSD32
743 if (error == 0 && cmd == CIOCCRYPT32)
744 crypt_op_to_32(cop, data);
749 #ifdef COMPAT_FREEBSD32
753 if (!crypto_userasymcrypto) {
754 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
755 return (EPERM); /* XXX compat? */
757 #ifdef COMPAT_FREEBSD32
758 if (cmd == CIOCKEY32 || cmd == CIOCKEY232) {
760 crypt_kop_from_32(data, kop);
763 kop = (struct crypt_kop *)data;
765 #ifdef COMPAT_FREEBSD32
769 /* NB: crypto core enforces s/w driver use */
771 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE;
774 error = cryptodev_key(kop);
776 #ifdef COMPAT_FREEBSD32
777 if (cmd == CIOCKEY32 || cmd == CIOCKEY232)
778 crypt_kop_to_32(kop, data);
782 if (!crypto_userasymcrypto) {
784 * NB: if user asym crypto operations are
785 * not permitted return "no algorithms"
786 * so well-behaved applications will just
787 * fallback to doing them in software.
791 error = crypto_getfeat((int *)data);
793 SDT_PROBE1(opencrypto, dev, ioctl, error,
798 error = cryptodev_find((struct crypt_find_op *)data);
801 caead = (struct crypt_aead *)data;
802 cse = csefind(fcr, caead->ses);
804 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
807 error = cryptodev_aead(cse, caead, active_cred, td);
812 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
819 static int cryptodev_cb(struct cryptop *);
821 static struct cryptop_data *
822 cod_alloc(struct csession *cse, size_t len, struct thread *td)
824 struct cryptop_data *cod;
826 cod = malloc(sizeof(struct cryptop_data), M_XDATA, M_WAITOK | M_ZERO);
829 cod->buf = malloc(len, M_XDATA, M_WAITOK);
830 if (crypto_get_params(cse->cses)->csp_flags & CSP_F_SEPARATE_OUTPUT)
831 cod->obuf = malloc(len, M_XDATA, M_WAITOK);
836 cod_free(struct cryptop_data *cod)
839 free(cod->obuf, M_XDATA);
840 free(cod->buf, M_XDATA);
846 struct csession *cse,
847 struct crypt_op *cop,
848 struct ucred *active_cred,
851 struct cryptop_data *cod = NULL;
852 struct cryptop *crp = NULL;
855 if (cop->len > 256*1024-4) {
856 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
861 if (cop->len == 0 || (cop->len % cse->txform->blocksize) != 0) {
862 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
867 if (cop->mac && cse->hashsize == 0) {
868 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
873 * The COP_F_CIPHER_FIRST flag predates explicit session
874 * modes, but the only way it was used was for EtA so allow it
875 * as long as it is consistent with EtA.
877 if (cop->flags & COP_F_CIPHER_FIRST) {
878 if (cop->op != COP_ENCRYPT) {
879 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
884 cod = cod_alloc(cse, cop->len + cse->hashsize, td);
886 crp = crypto_getreq(cse->cses, M_WAITOK);
888 error = copyin(cop->src, cod->buf, cop->len);
890 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
893 crp->crp_payload_start = 0;
894 crp->crp_payload_length = cop->len;
896 crp->crp_digest_start = cop->len;
899 case CSP_MODE_COMPRESS:
902 crp->crp_op = CRYPTO_OP_COMPRESS;
905 crp->crp_op = CRYPTO_OP_DECOMPRESS;
908 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
913 case CSP_MODE_CIPHER:
916 crp->crp_op = CRYPTO_OP_ENCRYPT;
919 crp->crp_op = CRYPTO_OP_DECRYPT;
922 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
927 case CSP_MODE_DIGEST:
932 crp->crp_op = CRYPTO_OP_COMPUTE_DIGEST;
933 if (cod->obuf != NULL)
934 crp->crp_digest_start = 0;
937 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
945 crp->crp_op = CRYPTO_OP_ENCRYPT |
946 CRYPTO_OP_COMPUTE_DIGEST;
949 crp->crp_op = CRYPTO_OP_DECRYPT |
950 CRYPTO_OP_VERIFY_DIGEST;
953 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
959 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
964 crp->crp_flags = CRYPTO_F_CBIMM | (cop->flags & COP_F_BATCH);
965 crypto_use_buf(crp, cod->buf, cop->len + cse->hashsize);
967 crypto_use_output_buf(crp, cod->obuf, cop->len + cse->hashsize);
968 crp->crp_callback = cryptodev_cb;
969 crp->crp_opaque = cod;
972 if (cse->ivsize == 0) {
973 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
977 error = copyin(cop->iv, crp->crp_iv, cse->ivsize);
979 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
982 crp->crp_flags |= CRYPTO_F_IV_SEPARATE;
983 } else if (cse->ivsize != 0) {
984 crp->crp_iv_start = 0;
985 crp->crp_payload_start += cse->ivsize;
986 crp->crp_payload_length -= cse->ivsize;
987 cop->dst += cse->ivsize;
990 if (cop->mac != NULL && crp->crp_op & CRYPTO_OP_VERIFY_DIGEST) {
991 error = copyin(cop->mac, cod->buf + crp->crp_digest_start,
994 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1000 * Let the dispatch run unlocked, then, interlock against the
1001 * callback before checking if the operation completed and going
1002 * to sleep. This insures drivers don't inherit our lock which
1003 * results in a lock order reversal between crypto_dispatch forced
1004 * entry and the crypto_done callback into us.
1006 error = crypto_dispatch(crp);
1008 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1012 mtx_lock(&cse->lock);
1014 mtx_sleep(cod, &cse->lock, PWAIT, "crydev", 0);
1015 mtx_unlock(&cse->lock);
1017 if (crp->crp_etype == EAGAIN) {
1019 crp->crp_flags &= ~CRYPTO_F_DONE;
1024 if (crp->crp_etype != 0) {
1025 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1026 error = crp->crp_etype;
1030 if (cop->dst != NULL) {
1031 error = copyout(cod->obuf != NULL ? cod->obuf :
1032 cod->buf + crp->crp_payload_start, cop->dst,
1033 crp->crp_payload_length);
1035 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1040 if (cop->mac != NULL && (crp->crp_op & CRYPTO_OP_VERIFY_DIGEST) == 0) {
1041 error = copyout((cod->obuf != NULL ? cod->obuf : cod->buf) +
1042 crp->crp_digest_start, cop->mac, cse->hashsize);
1044 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1050 crypto_freereq(crp);
1058 struct csession *cse,
1059 struct crypt_aead *caead,
1060 struct ucred *active_cred,
1063 struct cryptop_data *cod = NULL;
1064 struct cryptop *crp = NULL;
1067 if (caead->len > 256*1024-4 || caead->aadlen > 256*1024-4) {
1068 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1072 if (cse->txform == NULL || cse->hashsize == 0 || caead->tag == NULL ||
1073 (caead->len % cse->txform->blocksize) != 0) {
1074 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1079 * The COP_F_CIPHER_FIRST flag predates explicit session
1080 * modes, but the only way it was used was for EtA so allow it
1081 * as long as it is consistent with EtA.
1083 if (caead->flags & COP_F_CIPHER_FIRST) {
1084 if (caead->op != COP_ENCRYPT) {
1085 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1090 cod = cod_alloc(cse, caead->aadlen + caead->len + cse->hashsize, td);
1092 crp = crypto_getreq(cse->cses, M_WAITOK);
1094 error = copyin(caead->aad, cod->buf, caead->aadlen);
1096 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1099 crp->crp_aad_start = 0;
1100 crp->crp_aad_length = caead->aadlen;
1102 error = copyin(caead->src, cod->buf + caead->aadlen, caead->len);
1104 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1107 crp->crp_payload_start = caead->aadlen;
1108 crp->crp_payload_length = caead->len;
1109 if (caead->op == COP_ENCRYPT && cod->obuf != NULL)
1110 crp->crp_digest_start = caead->len;
1112 crp->crp_digest_start = caead->aadlen + caead->len;
1114 switch (cse->mode) {
1117 switch (caead->op) {
1119 crp->crp_op = CRYPTO_OP_ENCRYPT |
1120 CRYPTO_OP_COMPUTE_DIGEST;
1123 crp->crp_op = CRYPTO_OP_DECRYPT |
1124 CRYPTO_OP_VERIFY_DIGEST;
1127 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1133 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1138 crp->crp_flags = CRYPTO_F_CBIMM | (caead->flags & COP_F_BATCH);
1139 crypto_use_buf(crp, cod->buf, caead->aadlen + caead->len +
1141 if (cod->obuf != NULL)
1142 crypto_use_output_buf(crp, cod->obuf, caead->len +
1144 crp->crp_callback = cryptodev_cb;
1145 crp->crp_opaque = cod;
1149 * Permit a 16-byte IV for AES-XTS, but only use the
1150 * first 8 bytes as a block number.
1152 if (cse->mode == CSP_MODE_ETA &&
1153 caead->ivlen == AES_BLOCK_LEN &&
1154 cse->ivsize == AES_XTS_IV_LEN)
1155 caead->ivlen = AES_XTS_IV_LEN;
1157 if (caead->ivlen != cse->ivsize) {
1159 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1163 error = copyin(caead->iv, crp->crp_iv, cse->ivsize);
1165 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1168 crp->crp_flags |= CRYPTO_F_IV_SEPARATE;
1170 crp->crp_iv_start = crp->crp_payload_start;
1171 crp->crp_payload_start += cse->ivsize;
1172 crp->crp_payload_length -= cse->ivsize;
1173 caead->dst += cse->ivsize;
1176 if (crp->crp_op & CRYPTO_OP_VERIFY_DIGEST) {
1177 error = copyin(caead->tag, cod->buf + crp->crp_digest_start,
1180 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1186 * Let the dispatch run unlocked, then, interlock against the
1187 * callback before checking if the operation completed and going
1188 * to sleep. This insures drivers don't inherit our lock which
1189 * results in a lock order reversal between crypto_dispatch forced
1190 * entry and the crypto_done callback into us.
1192 error = crypto_dispatch(crp);
1194 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1198 mtx_lock(&cse->lock);
1200 mtx_sleep(cod, &cse->lock, PWAIT, "crydev", 0);
1201 mtx_unlock(&cse->lock);
1203 if (crp->crp_etype == EAGAIN) {
1205 crp->crp_flags &= ~CRYPTO_F_DONE;
1210 if (crp->crp_etype != 0) {
1211 error = crp->crp_etype;
1212 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1216 if (caead->dst != NULL) {
1217 error = copyout(cod->obuf != NULL ? cod->obuf :
1218 cod->buf + crp->crp_payload_start, caead->dst,
1219 crp->crp_payload_length);
1221 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1226 if ((crp->crp_op & CRYPTO_OP_VERIFY_DIGEST) == 0) {
1227 error = copyout((cod->obuf != NULL ? cod->obuf : cod->buf) +
1228 crp->crp_digest_start, caead->tag, cse->hashsize);
1230 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1236 crypto_freereq(crp);
1243 cryptodev_cb(struct cryptop *crp)
1245 struct cryptop_data *cod = crp->crp_opaque;
1248 * Lock to ensure the wakeup() is not missed by the loops
1249 * waiting on cod->done in cryptodev_op() and
1252 mtx_lock(&cod->cse->lock);
1254 mtx_unlock(&cod->cse->lock);
1260 cryptodevkey_cb(struct cryptkop *krp)
1267 cryptodev_key(struct crypt_kop *kop)
1269 struct cryptkop *krp = NULL;
1271 int in, out, size, i;
1273 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
1274 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1278 in = kop->crk_iparams;
1279 out = kop->crk_oparams;
1280 switch (kop->crk_op) {
1282 if (in == 3 && out == 1)
1284 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1286 case CRK_MOD_EXP_CRT:
1287 if (in == 6 && out == 1)
1289 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1292 if (in == 5 && out == 2)
1294 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1296 case CRK_DSA_VERIFY:
1297 if (in == 7 && out == 0)
1299 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1301 case CRK_DH_COMPUTE_KEY:
1302 if (in == 3 && out == 1)
1304 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1307 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1311 krp = (struct cryptkop *)malloc(sizeof *krp, M_XDATA, M_WAITOK|M_ZERO);
1313 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1316 krp->krp_op = kop->crk_op;
1317 krp->krp_status = kop->crk_status;
1318 krp->krp_iparams = kop->crk_iparams;
1319 krp->krp_oparams = kop->crk_oparams;
1320 krp->krp_crid = kop->crk_crid;
1321 krp->krp_status = 0;
1322 krp->krp_callback = cryptodevkey_cb;
1324 for (i = 0; i < CRK_MAXPARAM; i++) {
1325 if (kop->crk_param[i].crp_nbits > 65536) {
1326 /* Limit is the same as in OpenBSD */
1327 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1330 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
1332 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
1333 size = (krp->krp_param[i].crp_nbits + 7) / 8;
1336 krp->krp_param[i].crp_p = malloc(size, M_XDATA, M_WAITOK);
1337 if (i >= krp->krp_iparams)
1339 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
1341 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1346 error = crypto_kdispatch(krp);
1348 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1351 error = tsleep(krp, PSOCK, "crydev", 0);
1353 /* XXX can this happen? if so, how do we recover? */
1354 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1358 kop->crk_crid = krp->krp_hid; /* device that did the work */
1359 if (krp->krp_status != 0) {
1360 error = krp->krp_status;
1361 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1365 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
1366 size = (krp->krp_param[i].crp_nbits + 7) / 8;
1369 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
1371 SDT_PROBE1(opencrypto, dev, ioctl, error, __LINE__);
1378 kop->crk_status = krp->krp_status;
1379 for (i = 0; i < CRK_MAXPARAM; i++) {
1380 if (krp->krp_param[i].crp_p)
1381 free(krp->krp_param[i].crp_p, M_XDATA);
1389 cryptodev_find(struct crypt_find_op *find)
1392 size_t fnlen = sizeof find->name;
1394 if (find->crid != -1) {
1395 dev = crypto_find_device_byhid(find->crid);
1398 strncpy(find->name, device_get_nameunit(dev), fnlen);
1399 find->name[fnlen - 1] = '\x0';
1401 find->name[fnlen - 1] = '\x0';
1402 find->crid = crypto_find_driver(find->name);
1403 if (find->crid == -1)
1414 struct ucred *active_cred,
1418 return (EOPNOTSUPP);
1423 cryptof_close(struct file *fp, struct thread *td)
1425 struct fcrypt *fcr = fp->f_data;
1426 struct csession *cse;
1428 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
1429 TAILQ_REMOVE(&fcr->csessions, cse, next);
1430 KASSERT(cse->refs == 1,
1431 ("%s: crypto session %p with %d refs", __func__, cse,
1441 cryptof_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
1444 kif->kf_type = KF_TYPE_CRYPTO;
1448 static struct csession *
1449 csefind(struct fcrypt *fcr, u_int ses)
1451 struct csession *cse;
1453 mtx_lock(&fcr->lock);
1454 TAILQ_FOREACH(cse, &fcr->csessions, next) {
1455 if (cse->ses == ses) {
1456 refcount_acquire(&cse->refs);
1457 mtx_unlock(&fcr->lock);
1461 mtx_unlock(&fcr->lock);
1466 csedelete(struct fcrypt *fcr, u_int ses)
1468 struct csession *cse;
1470 mtx_lock(&fcr->lock);
1471 TAILQ_FOREACH(cse, &fcr->csessions, next) {
1472 if (cse->ses == ses) {
1473 TAILQ_REMOVE(&fcr->csessions, cse, next);
1474 mtx_unlock(&fcr->lock);
1479 mtx_unlock(&fcr->lock);
1484 csecreate(struct fcrypt *fcr, crypto_session_t cses,
1485 struct crypto_session_params *csp, struct enc_xform *txform,
1486 void *key, struct auth_hash *thash, void *mackey)
1488 struct csession *cse;
1490 cse = malloc(sizeof(struct csession), M_XDATA, M_NOWAIT | M_ZERO);
1493 mtx_init(&cse->lock, "cryptodev", "crypto session lock", MTX_DEF);
1494 refcount_init(&cse->refs, 1);
1496 cse->mackey = mackey;
1497 cse->mode = csp->csp_mode;
1499 cse->txform = txform;
1501 cse->hashsize = thash->hashsize;
1502 else if (csp->csp_cipher_alg == CRYPTO_AES_NIST_GCM_16)
1503 cse->hashsize = AES_GMAC_HASH_LEN;
1504 else if (csp->csp_cipher_alg == CRYPTO_AES_CCM_16)
1505 cse->hashsize = AES_CBC_MAC_HASH_LEN;
1506 cse->ivsize = csp->csp_ivlen;
1507 mtx_lock(&fcr->lock);
1508 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
1509 cse->ses = fcr->sesn++;
1510 mtx_unlock(&fcr->lock);
1515 csefree(struct csession *cse)
1518 if (!refcount_release(&cse->refs))
1520 crypto_freesession(cse->cses);
1521 mtx_destroy(&cse->lock);
1523 free(cse->key, M_XDATA);
1525 free(cse->mackey, M_XDATA);
1530 cryptoioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
1538 error = falloc_noinstall(td, &f);
1542 fcr = malloc(sizeof(struct fcrypt), M_XDATA, M_WAITOK | M_ZERO);
1543 TAILQ_INIT(&fcr->csessions);
1544 mtx_init(&fcr->lock, "fcrypt", NULL, MTX_DEF);
1546 finit(f, FREAD | FWRITE, DTYPE_CRYPTO, fcr, &cryptofops);
1547 error = finstall(td, f, &fd, 0, NULL);
1549 mtx_destroy(&fcr->lock);
1552 *(uint32_t *)data = fd;
1556 error = cryptodev_find((struct crypt_find_op *)data);
1559 error = crypto_getfeat((int *)data);
1568 static struct cdevsw crypto_cdevsw = {
1569 .d_version = D_VERSION,
1570 .d_ioctl = cryptoioctl,
1573 static struct cdev *crypto_dev;
1576 * Initialization code, both for static and dynamic loading.
1579 cryptodev_modevent(module_t mod, int type, void *unused)
1584 printf("crypto: <crypto device>\n");
1585 crypto_dev = make_dev(&crypto_cdevsw, 0,
1586 UID_ROOT, GID_WHEEL, 0666,
1590 /*XXX disallow if active sessions */
1591 destroy_dev(crypto_dev);
1597 static moduledata_t cryptodev_mod = {
1602 MODULE_VERSION(cryptodev, 1);
1603 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
1604 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);
1605 MODULE_DEPEND(cryptodev, zlib, 1, 1, 1);