1 /* $FreeBSD: src/sys/opencrypto/cryptodev.c,v 1.41 2009/09/04 09:48:18 pjd Exp $ */
2 /* $OpenBSD: cryptodev.c,v 1.52 2002/06/19 07:22:46 deraadt Exp $ */
5 * Copyright (c) 2001 Theo de Raadt
6 * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 * Effort sponsored in part by the Defense Advanced Research Projects
32 * Agency (DARPA) and Air Force Research Laboratory, Air Force
33 * Materiel Command, USAF, under agreement number F30602-01-2-0537.
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/malloc.h>
39 #include <sys/device.h>
42 #include <sys/sysctl.h>
44 #include <sys/filedesc.h>
45 #include <sys/errno.h>
47 #include <sys/random.h>
49 #include <sys/module.h>
50 #include <sys/kernel.h>
51 #include <sys/fcntl.h>
54 #include <sys/file2.h>
56 #include <opencrypto/cryptodev.h>
57 #include <opencrypto/xform.h>
60 TAILQ_ENTRY(csession) next;
66 struct enc_xform *txform;
68 struct auth_hash *thash;
72 u_char tmp_iv[EALG_MAX_BLOCK_LEN];
84 TAILQ_HEAD(csessionlist, csession) csessions;
88 static int cryptof_rw(struct file *fp, struct uio *uio,
89 struct ucred *cred, int flags);
90 static int cryptof_ioctl(struct file *, u_long, caddr_t,
91 struct ucred *, struct sysmsg *);
92 static int cryptof_kqfilter(struct file *, struct knote *);
93 static int cryptof_stat(struct file *, struct stat *, struct ucred *);
94 static int cryptof_close(struct file *);
96 static struct fileops cryptofops = {
97 .fo_read = cryptof_rw,
98 .fo_write = cryptof_rw,
99 .fo_ioctl = cryptof_ioctl,
100 .fo_kqfilter = cryptof_kqfilter,
101 .fo_stat = cryptof_stat,
102 .fo_close = cryptof_close,
103 .fo_shutdown = nofo_shutdown
106 static struct csession *csefind(struct fcrypt *, u_int, int *);
107 static void csedrop(struct csession *);
108 static int csedelete(struct fcrypt *, struct csession *);
109 static struct csession *cseadd(struct fcrypt *, struct csession *);
110 static struct csession *csecreate(struct fcrypt *, u_int64_t, caddr_t,
111 u_int64_t, caddr_t, u_int64_t, u_int32_t, u_int32_t, struct enc_xform *,
113 static int csefree(struct csession *);
115 static int cryptodev_op(struct csession *, struct crypt_op *, struct ucred *);
116 static int cryptodev_key(struct crypt_kop *);
117 static int cryptodev_find(struct crypt_find_op *);
119 static struct lock cryptodev_lock = LOCK_INITIALIZER("cryptodev", 0, 0);
125 struct ucred *active_cred,
132 * Check a crypto identifier to see if it requested
133 * a software device/driver. This can be done either
134 * by device name/class or through search constraints.
137 checkforsoftware(int crid)
139 if (crid & CRYPTOCAP_F_SOFTWARE)
140 return EINVAL; /* XXX */
141 if ((crid & CRYPTOCAP_F_HARDWARE) == 0 &&
142 (crypto_getcaps(crid) & CRYPTOCAP_F_HARDWARE) == 0)
143 return EINVAL; /* XXX */
149 cryptof_ioctl(struct file *fp, u_long cmd, caddr_t data,
150 struct ucred *cred, struct sysmsg *msg)
152 #define SES2(p) ((struct session2_op *)p)
153 struct cryptoini cria, crie;
154 struct fcrypt *fcr = fp->f_data;
155 struct csession *cse;
156 struct session_op *sop;
157 struct crypt_op *cop;
158 struct enc_xform *txform = NULL;
159 struct auth_hash *thash = NULL;
160 struct crypt_kop *kop;
168 sop = (struct session_op *)data;
169 switch (sop->cipher) {
173 txform = &enc_xform_des;
175 case CRYPTO_3DES_CBC:
176 txform = &enc_xform_3des;
179 txform = &enc_xform_blf;
181 case CRYPTO_CAST_CBC:
182 txform = &enc_xform_cast5;
184 case CRYPTO_SKIPJACK_CBC:
185 txform = &enc_xform_skipjack;
188 txform = &enc_xform_rijndael128;
191 txform = &enc_xform_aes_xts;
194 txform = &enc_xform_aes_ctr;
196 case CRYPTO_NULL_CBC:
197 txform = &enc_xform_null;
200 txform = &enc_xform_arc4;
202 case CRYPTO_CAMELLIA_CBC:
203 txform = &enc_xform_camellia;
205 case CRYPTO_TWOFISH_CBC:
206 txform = &enc_xform_twofish;
208 case CRYPTO_SERPENT_CBC:
209 txform = &enc_xform_serpent;
211 case CRYPTO_TWOFISH_XTS:
212 txform = &enc_xform_twofish_xts;
214 case CRYPTO_SERPENT_XTS:
215 txform = &enc_xform_serpent_xts;
224 case CRYPTO_MD5_HMAC:
225 thash = &auth_hash_hmac_md5;
227 case CRYPTO_SHA1_HMAC:
228 thash = &auth_hash_hmac_sha1;
230 case CRYPTO_SHA2_256_HMAC:
231 thash = &auth_hash_hmac_sha2_256;
233 case CRYPTO_SHA2_384_HMAC:
234 thash = &auth_hash_hmac_sha2_384;
236 case CRYPTO_SHA2_512_HMAC:
237 thash = &auth_hash_hmac_sha2_512;
239 case CRYPTO_RIPEMD160_HMAC:
240 thash = &auth_hash_hmac_ripemd_160;
244 thash = &auth_hash_md5;
247 thash = &auth_hash_sha1;
250 case CRYPTO_NULL_HMAC:
251 thash = &auth_hash_null;
257 bzero(&crie, sizeof(crie));
258 bzero(&cria, sizeof(cria));
261 crie.cri_alg = txform->type;
262 crie.cri_klen = sop->keylen * 8;
263 if (sop->keylen > txform->maxkey ||
264 sop->keylen < txform->minkey) {
269 crie.cri_key = kmalloc(crie.cri_klen / 8,
271 if ((error = copyin(sop->key, crie.cri_key,
275 crie.cri_next = &cria;
279 cria.cri_alg = thash->type;
280 cria.cri_klen = sop->mackeylen * 8;
281 if (sop->mackeylen != thash->keysize) {
287 cria.cri_key = kmalloc(cria.cri_klen / 8,
289 if ((error = copyin(sop->mackey, cria.cri_key,
295 /* NB: CIOGSESSION2 has the crid */
296 if (cmd == CIOCGSESSION2) {
297 crid = SES2(sop)->crid;
298 error = checkforsoftware(crid);
302 crid = CRYPTOCAP_F_HARDWARE;
303 if (crypto_devallowsoft)
304 crid |= CRYPTOCAP_F_SOFTWARE;
306 error = crypto_newsession(&sid, (txform ? &crie : &cria), crid);
310 lockmgr(&cryptodev_lock, LK_EXCLUSIVE);
311 cse = csecreate(fcr, sid, crie.cri_key, crie.cri_klen,
312 cria.cri_key, cria.cri_klen, sop->cipher,
313 sop->mac, txform, thash);
314 lockmgr(&cryptodev_lock, LK_RELEASE);
317 crypto_freesession(sid);
322 if (cmd == CIOCGSESSION2) {
323 /* return hardware/driver id */
324 SES2(sop)->crid = CRYPTO_SESID2HID(cse->sid);
329 bzero(crie.cri_key, crie.cri_klen / 8);
330 kfree(crie.cri_key, M_XDATA);
333 bzero(cria.cri_key, cria.cri_klen / 8);
334 kfree(cria.cri_key, M_XDATA);
339 lockmgr(&cryptodev_lock, LK_EXCLUSIVE);
340 ses = *(u_int32_t *)data;
341 cse = csefind(fcr, ses, &error);
344 error = csefree(cse);
346 lockmgr(&cryptodev_lock, LK_RELEASE);
349 cop = (struct crypt_op *)data;
350 lockmgr(&cryptodev_lock, LK_EXCLUSIVE);
351 cse = csefind(fcr, cop->ses, &error);
352 lockmgr(&cryptodev_lock, LK_RELEASE);
354 error = cryptodev_op(cse, cop, cred);
360 if (!crypto_userasymcrypto)
361 return (EPERM); /* XXX compat? */
362 lockmgr(&cryptodev_lock, LK_EXCLUSIVE);
363 kop = (struct crypt_kop *)data;
364 if (cmd == CIOCKEY) {
365 /* NB: crypto core enforces s/w driver use */
367 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE;
369 error = cryptodev_key(kop);
370 lockmgr(&cryptodev_lock, LK_RELEASE);
373 if (!crypto_userasymcrypto) {
375 * NB: if user asym crypto operations are
376 * not permitted return "no algorithms"
377 * so well-behaved applications will just
378 * fallback to doing them in software.
382 error = crypto_getfeat((int *)data);
386 error = cryptodev_find((struct crypt_find_op *)data);
396 static int cryptodev_cb(void *);
399 cryptodev_op(struct csession *cse, struct crypt_op *cop,
400 struct ucred *active_cred)
402 struct cryptop *crp = NULL;
403 struct cryptodesc *crde = NULL, *crda = NULL;
406 if (cop->len > 256*1024-4)
410 if (cop->len == 0 || (cop->len % cse->txform->blocksize) != 0)
414 bzero(&cse->uio, sizeof(cse->uio));
415 cse->uio.uio_iov = &cse->iovec;
416 cse->uio.uio_iovcnt = 1;
417 cse->uio.uio_offset = 0;
418 cse->uio.uio_resid = cop->len;
419 cse->uio.uio_segflg = UIO_SYSSPACE;
420 cse->uio.uio_rw = UIO_WRITE;
421 /* XXX: not sure, was td, now curthread? */
422 cse->uio.uio_td = curthread;
423 cse->uio.uio_iov[0].iov_len = cop->len;
425 cse->uio.uio_iov[0].iov_len += cse->thash->hashsize;
426 cse->uio.uio_resid += cse->thash->hashsize;
428 cse->uio.uio_iov[0].iov_base = kmalloc(cse->uio.uio_iov[0].iov_len,
431 crp = crypto_getreq((cse->txform != NULL) + (cse->thash != NULL));
438 crda = crp->crp_desc;
440 crde = crda->crd_next;
443 crde = crp->crp_desc;
450 if ((error = copyin(cop->src, cse->uio.uio_iov[0].iov_base, cop->len)))
455 crda->crd_len = cop->len;
456 crda->crd_inject = cop->len;
458 crda->crd_alg = cse->mac;
459 crda->crd_key = cse->mackey;
460 crda->crd_klen = cse->mackeylen * 8;
464 if (cop->op == COP_ENCRYPT)
465 crde->crd_flags |= CRD_F_ENCRYPT;
467 crde->crd_flags &= ~CRD_F_ENCRYPT;
468 crde->crd_len = cop->len;
469 crde->crd_inject = 0;
471 crde->crd_alg = cse->cipher;
472 crde->crd_key = cse->key;
473 crde->crd_klen = cse->keylen * 8;
476 crp->crp_ilen = cop->len;
477 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIMM
478 | (cop->flags & COP_F_BATCH);
479 crp->crp_buf = (caddr_t)&cse->uio;
480 crp->crp_callback = (int (*) (struct cryptop *)) cryptodev_cb;
481 crp->crp_sid = cse->sid;
482 crp->crp_opaque = (void *)cse;
489 if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
493 if ((error = copyin(cop->iv, cse->tmp_iv, cse->txform->blocksize)))
495 bcopy(cse->tmp_iv, crde->crd_iv, cse->txform->blocksize);
496 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
498 } else if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
501 crde->crd_flags |= CRD_F_IV_PRESENT;
502 crde->crd_skip = cse->txform->blocksize;
503 crde->crd_len -= cse->txform->blocksize;
506 if (cop->mac && crda == NULL) {
513 * Let the dispatch run unlocked, then, interlock against the
514 * callback before checking if the operation completed and going
515 * to sleep. This insures drivers don't inherit our lock which
516 * results in a lock order reversal between crypto_dispatch forced
517 * entry and the crypto_done callback into us.
519 error = crypto_dispatch(crp);
520 lockmgr(&cse->lock, LK_EXCLUSIVE);
521 if (error == 0 && (crp->crp_flags & CRYPTO_F_DONE) == 0)
522 error = lksleep(crp, &cse->lock, 0, "crydev", 0);
523 lockmgr(&cse->lock, LK_RELEASE);
528 if (crp->crp_etype == EAGAIN) {
530 crp->crp_flags &= ~CRYPTO_F_DONE;
534 if (crp->crp_etype != 0) {
535 error = crp->crp_etype;
545 (error = copyout(cse->uio.uio_iov[0].iov_base, cop->dst, cop->len)))
549 (error = copyout((caddr_t)cse->uio.uio_iov[0].iov_base + cop->len,
550 cop->mac, cse->thash->hashsize)))
556 if (cse->uio.uio_iov[0].iov_base)
557 kfree(cse->uio.uio_iov[0].iov_base, M_XDATA);
563 cryptodev_cb(void *op)
565 struct cryptop *crp = (struct cryptop *) op;
566 struct csession *cse = (struct csession *)crp->crp_opaque;
568 lockmgr(&cse->lock, LK_EXCLUSIVE);
569 cse->error = crp->crp_etype;
571 lockmgr(&cse->lock, LK_RELEASE);
576 cryptodevkey_cb(void *op)
578 struct cryptkop *krp = (struct cryptkop *) op;
585 cryptodev_key(struct crypt_kop *kop)
587 struct cryptkop *krp = NULL;
589 int in, out, size, i;
591 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
595 in = kop->crk_iparams;
596 out = kop->crk_oparams;
597 switch (kop->crk_op) {
599 if (in == 3 && out == 1)
602 case CRK_MOD_EXP_CRT:
603 if (in == 6 && out == 1)
607 if (in == 5 && out == 2)
611 if (in == 7 && out == 0)
614 case CRK_DH_COMPUTE_KEY:
615 if (in == 3 && out == 1)
622 krp = (struct cryptkop *)kmalloc(sizeof *krp, M_XDATA, M_WAITOK | M_ZERO);
623 krp->krp_op = kop->crk_op;
624 krp->krp_status = kop->crk_status;
625 krp->krp_iparams = kop->crk_iparams;
626 krp->krp_oparams = kop->crk_oparams;
627 krp->krp_crid = kop->crk_crid;
629 krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb;
631 for (i = 0; i < CRK_MAXPARAM; i++) {
632 if (kop->crk_param[i].crp_nbits > 65536)
633 /* Limit is the same as in OpenBSD */
635 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
637 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
638 size = (krp->krp_param[i].crp_nbits + 7) / 8;
641 krp->krp_param[i].crp_p = kmalloc(size, M_XDATA, M_WAITOK);
642 if (i >= krp->krp_iparams)
644 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
649 error = crypto_kdispatch(krp);
652 error = tsleep(krp, 0, "crydev", 0);
654 /* XXX can this happen? if so, how do we recover? */
658 kop->crk_crid = krp->krp_crid; /* device that did the work */
659 if (krp->krp_status != 0) {
660 error = krp->krp_status;
664 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
665 size = (krp->krp_param[i].crp_nbits + 7) / 8;
668 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
675 kop->crk_status = krp->krp_status;
676 for (i = 0; i < CRK_MAXPARAM; i++) {
677 if (krp->krp_param[i].crp_p) {
678 bzero(krp->krp_param[i].crp_p,
679 (krp->krp_param[i].crp_nbits + 7) / 8);
680 kfree(krp->krp_param[i].crp_p, M_XDATA);
689 cryptodev_find(struct crypt_find_op *find)
693 if (find->crid != -1) {
694 dev = crypto_find_device_byhid(find->crid);
697 strlcpy(find->name, device_get_nameunit(dev),
700 find->crid = crypto_find_driver(find->name);
701 if (find->crid == -1)
711 cryptof_kqfilter(struct file *fp, struct knote *kn)
721 cryptof_stat(struct file *fp, struct stat *sb, struct ucred *cred)
727 cryptof_close(struct file *fp)
729 struct fcrypt *fcr = fp->f_data;
730 struct csession *cse;
732 lockmgr(&cryptodev_lock, LK_EXCLUSIVE);
733 fcr = (struct fcrypt *)fp->f_data;
734 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
735 TAILQ_REMOVE(&fcr->csessions, cse, next);
739 lockmgr(&cryptodev_lock, LK_RELEASE);
745 static struct csession *
746 csefind(struct fcrypt *fcr, u_int ses, int *errorp)
748 struct csession *cse;
750 TAILQ_FOREACH(cse, &fcr->csessions, next) {
751 if (cse->ses == ses) {
753 kprintf("csefind: cse %p BUSY\n", cse);
766 csedrop(struct csession *cse)
772 csedelete(struct fcrypt *fcr, struct csession *cse_del)
774 struct csession *cse;
776 TAILQ_FOREACH(cse, &fcr->csessions, next) {
777 if (cse == cse_del) {
778 TAILQ_REMOVE(&fcr->csessions, cse, next);
785 static struct csession *
786 cseadd(struct fcrypt *fcr, struct csession *cse)
788 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
789 cse->ses = fcr->sesn++;
794 csecreate(struct fcrypt *fcr, u_int64_t sid, caddr_t key, u_int64_t keylen,
795 caddr_t mackey, u_int64_t mackeylen, u_int32_t cipher, u_int32_t mac,
796 struct enc_xform *txform, struct auth_hash *thash)
798 struct csession *cse;
800 cse = kmalloc(sizeof(struct csession), M_XDATA, M_WAITOK | M_ZERO);
801 lockinit(&cse->lock, "cryptodev", 0, LK_CANRECURSE);
803 cse->keylen = keylen/8;
804 cse->mackey = mackey;
805 cse->mackeylen = mackeylen/8;
807 cse->cipher = cipher;
809 cse->txform = txform;
816 csefree(struct csession *cse)
820 error = crypto_freesession(cse->sid);
821 lockuninit(&cse->lock);
823 kfree(cse->key, M_XDATA);
825 kfree(cse->mackey, M_XDATA);
831 cryptoopen(struct dev_open_args *ap)
837 cryptoread(struct dev_read_args *ap)
843 cryptowrite(struct dev_write_args *ap)
849 cryptoioctl(struct dev_ioctl_args *ap)
851 struct thread *td = curthread;
858 fcr = kmalloc(sizeof(struct fcrypt), M_XDATA, M_WAITOK);
859 TAILQ_INIT(&fcr->csessions);
862 KKASSERT(td->td_lwp);
863 error = falloc(td->td_lwp, &f, &fd);
869 /* falloc automatically provides an extra reference to 'f'. */
870 f->f_flag = FREAD | FWRITE;
871 f->f_type = DTYPE_CRYPTO;
872 f->f_ops = &cryptofops;
874 fsetfd(td->td_proc->p_fd, f, fd);
875 *(u_int32_t *)ap->a_data = fd;
880 error = cryptodev_find((struct crypt_find_op *)ap->a_data);
883 error = crypto_getfeat((int *)ap->a_data);
892 static struct dev_ops crypto_ops = {
893 { "crypto", 0, D_MPSAFE },
894 .d_open = cryptoopen,
895 .d_read = cryptoread,
896 .d_write = cryptowrite,
897 .d_ioctl = cryptoioctl,
901 * Initialization code, both for static and dynamic loading.
904 cryptodev_modevent(module_t mod, int type, void *unused)
909 kprintf("crypto: <crypto device>\n");
910 make_dev(&crypto_ops, 0, UID_ROOT, GID_WHEEL,
914 /*XXX disallow if active sessions */
915 //dev_ops_remove(&crypto_ops, 0, 0);
916 dev_ops_remove_all(&crypto_ops);
922 static moduledata_t cryptodev_mod = {
927 MODULE_VERSION(cryptodev, 1);
928 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
929 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);