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>
41 #include <sys/sysctl.h>
43 #include <sys/filedesc.h>
44 #include <sys/errno.h>
46 #include <sys/random.h>
48 #include <sys/module.h>
49 #include <sys/kernel.h>
50 #include <sys/fcntl.h>
52 #include <sys/file2.h>
53 #include <sys/thread2.h>
55 #include <opencrypto/cryptodev.h>
56 #include <opencrypto/xform.h>
59 TAILQ_ENTRY(csession) next;
65 struct enc_xform *txform;
67 struct auth_hash *thash;
81 TAILQ_HEAD(csessionlist, csession) csessions;
85 static int cryptof_rw(struct file *fp, struct uio *uio,
86 struct ucred *cred, int flags);
87 static int cryptof_ioctl(struct file *, u_long, caddr_t,
88 struct ucred *, struct sysmsg *);
89 static int cryptof_poll(struct file *, int, struct ucred *);
90 static int cryptof_kqfilter(struct file *, struct knote *);
91 static int cryptof_stat(struct file *, struct stat *, struct ucred *);
92 static int cryptof_close(struct file *);
94 static struct fileops cryptofops = {
95 .fo_read = cryptof_rw,
96 .fo_write = cryptof_rw,
97 .fo_ioctl = cryptof_ioctl,
98 .fo_poll = cryptof_poll,
99 .fo_kqfilter = cryptof_kqfilter,
100 .fo_stat = cryptof_stat,
101 .fo_close = cryptof_close,
102 .fo_shutdown = nofo_shutdown
105 static struct csession *csefind(struct fcrypt *, u_int);
106 static int csedelete(struct fcrypt *, struct csession *);
107 static struct csession *cseadd(struct fcrypt *, struct csession *);
108 static struct csession *csecreate(struct fcrypt *, u_int64_t, caddr_t,
109 u_int64_t, caddr_t, u_int64_t, u_int32_t, u_int32_t, struct enc_xform *,
111 static int csefree(struct csession *);
113 static int cryptodev_op(struct csession *, struct crypt_op *, struct ucred *);
114 static int cryptodev_key(struct crypt_kop *);
115 static int cryptodev_find(struct crypt_find_op *);
121 struct ucred *active_cred,
128 * Check a crypto identifier to see if it requested
129 * a software device/driver. This can be done either
130 * by device name/class or through search constraints.
133 checkforsoftware(int crid)
135 if (crid & CRYPTOCAP_F_SOFTWARE)
136 return EINVAL; /* XXX */
137 if ((crid & CRYPTOCAP_F_HARDWARE) == 0 &&
138 (crypto_getcaps(crid) & CRYPTOCAP_F_HARDWARE) == 0)
139 return EINVAL; /* XXX */
145 cryptof_ioctl(struct file *fp, u_long cmd, caddr_t data,
146 struct ucred *cred, struct sysmsg *msg)
148 #define SES2(p) ((struct session2_op *)p)
149 struct cryptoini cria, crie;
151 struct csession *cse;
152 struct session_op *sop;
153 struct crypt_op *cop;
154 struct enc_xform *txform = NULL;
155 struct auth_hash *thash = NULL;
156 struct crypt_kop *kop;
164 sop = (struct session_op *)data;
165 switch (sop->cipher) {
169 txform = &enc_xform_des;
171 case CRYPTO_3DES_CBC:
172 txform = &enc_xform_3des;
175 txform = &enc_xform_blf;
177 case CRYPTO_CAST_CBC:
178 txform = &enc_xform_cast5;
180 case CRYPTO_SKIPJACK_CBC:
181 txform = &enc_xform_skipjack;
184 txform = &enc_xform_rijndael128;
186 case CRYPTO_NULL_CBC:
187 txform = &enc_xform_null;
190 txform = &enc_xform_arc4;
192 case CRYPTO_CAMELLIA_CBC:
193 txform = &enc_xform_camellia;
202 case CRYPTO_MD5_HMAC:
203 thash = &auth_hash_hmac_md5;
205 case CRYPTO_SHA1_HMAC:
206 thash = &auth_hash_hmac_sha1;
208 case CRYPTO_SHA2_256_HMAC:
209 thash = &auth_hash_hmac_sha2_256;
211 case CRYPTO_SHA2_384_HMAC:
212 thash = &auth_hash_hmac_sha2_384;
214 case CRYPTO_SHA2_512_HMAC:
215 thash = &auth_hash_hmac_sha2_512;
217 case CRYPTO_RIPEMD160_HMAC:
218 thash = &auth_hash_hmac_ripemd_160;
222 thash = &auth_hash_md5;
225 thash = &auth_hash_sha1;
228 case CRYPTO_NULL_HMAC:
229 thash = &auth_hash_null;
235 bzero(&crie, sizeof(crie));
236 bzero(&cria, sizeof(cria));
239 crie.cri_alg = txform->type;
240 crie.cri_klen = sop->keylen * 8;
241 if (sop->keylen > txform->maxkey ||
242 sop->keylen < txform->minkey) {
247 crie.cri_key = kmalloc(crie.cri_klen / 8,
249 if ((error = copyin(sop->key, crie.cri_key,
253 crie.cri_next = &cria;
257 cria.cri_alg = thash->type;
258 cria.cri_klen = sop->mackeylen * 8;
259 if (sop->mackeylen != thash->keysize) {
265 cria.cri_key = malloc(cria.cri_klen / 8,
267 if ((error = copyin(sop->mackey, cria.cri_key,
273 /* NB: CIOGSESSION2 has the crid */
274 if (cmd == CIOCGSESSION2) {
275 crid = SES2(sop)->crid;
276 error = checkforsoftware(crid);
280 crid = CRYPTOCAP_F_HARDWARE;
281 error = crypto_newsession(&sid, (txform ? &crie : &cria), crid);
285 cse = csecreate(fcr, sid, crie.cri_key, crie.cri_klen,
286 cria.cri_key, cria.cri_klen, sop->cipher, sop->mac, txform,
290 crypto_freesession(sid);
295 if (cmd == CIOCGSESSION2) {
296 /* return hardware/driver id */
297 SES2(sop)->crid = CRYPTO_SESID2HID(cse->sid);
302 kfree(crie.cri_key, M_XDATA);
304 kfree(cria.cri_key, M_XDATA);
308 ses = *(u_int32_t *)data;
309 cse = csefind(fcr, ses);
313 error = csefree(cse);
316 cop = (struct crypt_op *)data;
317 cse = csefind(fcr, cop->ses);
320 error = cryptodev_op(cse, cop, active_cred);
324 if (!crypto_userasymcrypto)
325 return (EPERM); /* XXX compat? */
327 kop = (struct crypt_kop *)data;
328 if (cmd == CIOCKEY) {
329 /* NB: crypto core enforces s/w driver use */
331 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE;
333 error = cryptodev_key(kop);
337 if (!crypto_userasymcrypto) {
339 * NB: if user asym crypto operations are
340 * not permitted return "no algorithms"
341 * so well-behaved applications will just
342 * fallback to doing them in software.
346 error = crypto_getfeat((int *)data);
349 error = cryptodev_find((struct crypt_find_op *)data);
359 static int cryptodev_cb(void *);
363 cryptodev_op(struct csession *cse, struct crypt_op *cop,
364 struct ucred *active_cred)
366 struct cryptop *crp = NULL;
367 struct cryptodesc *crde = NULL, *crda = NULL;
370 if (cop->len > 256*1024-4)
374 if (cop->len == 0 || (cop->len % cse->txform->blocksize) != 0)
378 bzero(&cse->uio, sizeof(cse->uio));
379 cse->uio.uio_iov = &cse->iovec;
380 cse->uio.uio_iovcnt = 1;
381 cse->uio.uio_offset = 0;
382 cse->uio.uio_resid = cop->len;
383 cse->uio.uio_segflg = UIO_SYSSPACE;
384 cse->uio.uio_rw = UIO_WRITE;
385 cse->uio.uio_td = td;
386 cse->uio.uio_iov[0].iov_len = cop->len;
388 cse->uio.uio_iov[0].iov_len += cse->thash->hashsize;
389 cse->uio.uio_resid += cse->thash->hashsize;
391 cse->uio.uio_iov[0].iov_base = kmalloc(cse->uio.uio_iov[0].iov_len,
394 crp = crypto_getreq((cse->txform != NULL) + (cse->thash != NULL));
401 crda = crp->crp_desc;
403 crde = crda->crd_next;
406 crde = crp->crp_desc;
413 if ((error = copyin(cop->src, cse->uio.uio_iov[0].iov_base, cop->len)))
418 crda->crd_len = cop->len;
419 crda->crd_inject = cop->len;
421 crda->crd_alg = cse->mac;
422 crda->crd_key = cse->mackey;
423 crda->crd_klen = cse->mackeylen * 8;
427 if (cop->op == COP_ENCRYPT)
428 crde->crd_flags |= CRD_F_ENCRYPT;
430 crde->crd_flags &= ~CRD_F_ENCRYPT;
431 crde->crd_len = cop->len;
432 crde->crd_inject = 0;
434 crde->crd_alg = cse->cipher;
435 crde->crd_key = cse->key;
436 crde->crd_klen = cse->keylen * 8;
439 crp->crp_ilen = cop->len;
440 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIMM
441 | (cop->flags & COP_F_BATCH);
442 crp->crp_buf = (caddr_t)&cse->uio;
443 crp->crp_callback = (int (*) (struct cryptop *)) cryptodev_cb;
444 crp->crp_sid = cse->sid;
445 crp->crp_opaque = (void *)cse;
452 if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
456 if ((error = copyin(cop->iv, cse->tmp_iv, cse->txform->blocksize)))
458 bcopy(cse->tmp_iv, crde->crd_iv, cse->txform->blocksize);
459 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
461 } else if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
464 crde->crd_flags |= CRD_F_IV_PRESENT;
465 crde->crd_skip = cse->txform->blocksize;
466 crde->crd_len -= cse->txform->blocksize;
469 if (cop->mac && crda == NULL) {
476 * Let the dispatch run unlocked, then, interlock against the
477 * callback before checking if the operation completed and going
478 * to sleep. This insures drivers don't inherit our lock which
479 * results in a lock order reversal between crypto_dispatch forced
480 * entry and the crypto_done callback into us.
482 error = crypto_dispatch(crp);
483 lockmgr(&cse->lock, LK_EXCLUSIVE);
484 if (error == 0 && (crp->crp_flags & CRYPTO_F_DONE) == 0)
485 error = tsleep(crp, 0, "crydev", 0);
486 lockmgr(&cse->lock, LK_RELEASE);
491 if (crp->crp_etype == EAGAIN) {
493 crp->crp_flags &= ~CRYPTO_F_DONE;
497 if (crp->crp_etype != 0) {
498 error = crp->crp_etype;
508 (error = copyout(cse->uio.uio_iov[0].iov_base, cop->dst, cop->len)))
512 (error = copyout((caddr_t)cse->uio.uio_iov[0].iov_base + cop->len,
513 cop->mac, cse->thash->hashsize)))
519 if (cse->uio.uio_iov[0].iov_base)
520 kfree(cse->uio.uio_iov[0].iov_base, M_XDATA);
526 cryptodev_cb(void *op)
528 struct cryptop *crp = (struct cryptop *) op;
529 struct csession *cse = (struct csession *)crp->crp_opaque;
531 lockmgr(&cse->lock, LK_EXCLUSIVE);
532 cse->error = crp->crp_etype;
534 lockmgr(&cse->lock, LK_RELEASE);
539 cryptodevkey_cb(void *op)
541 struct cryptkop *krp = (struct cryptkop *) op;
548 cryptodev_key(struct crypt_kop *kop)
550 struct cryptkop *krp = NULL;
552 int in, out, size, i;
554 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
558 in = kop->crk_iparams;
559 out = kop->crk_oparams;
560 switch (kop->crk_op) {
562 if (in == 3 && out == 1)
565 case CRK_MOD_EXP_CRT:
566 if (in == 6 && out == 1)
570 if (in == 5 && out == 2)
574 if (in == 7 && out == 0)
577 case CRK_DH_COMPUTE_KEY:
578 if (in == 3 && out == 1)
585 krp = (struct cryptkop *)kmalloc(sizeof *krp, M_XDATA, M_WAITOK | M_ZERO);
586 krp->krp_op = kop->crk_op;
587 krp->krp_status = kop->crk_status;
588 krp->krp_iparams = kop->crk_iparams;
589 krp->krp_oparams = kop->crk_oparams;
590 krp->krp_crid = kop->crk_crid;
592 krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb;
594 for (i = 0; i < CRK_MAXPARAM; i++) {
595 if (kop->crk_param[i].crp_nbits > 65536)
596 /* Limit is the same as in OpenBSD */
598 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
600 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
601 size = (krp->krp_param[i].crp_nbits + 7) / 8;
604 krp->krp_param[i].crp_p = kmalloc(size, M_XDATA, M_WAITOK);
605 if (i >= krp->krp_iparams)
607 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
612 error = crypto_kdispatch(krp);
615 error = tsleep(krp, PSOCK, "crydev", 0);
617 /* XXX can this happen? if so, how do we recover? */
621 kop->crk_crid = krp->krp_crid; /* device that did the work */
622 if (krp->krp_status != 0) {
623 error = krp->krp_status;
627 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
628 size = (krp->krp_param[i].crp_nbits + 7) / 8;
631 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
638 kop->crk_status = krp->krp_status;
639 for (i = 0; i < CRK_MAXPARAM; i++) {
640 if (krp->krp_param[i].crp_p)
641 kfree(krp->krp_param[i].crp_p, M_XDATA);
649 cryptodev_find(struct crypt_find_op *find)
653 if (find->crid != -1) {
654 dev = crypto_find_device_byhid(find->crid);
657 strlcpy(find->name, device_get_nameunit(dev),
660 find->crid = crypto_find_driver(find->name);
661 if (find->crid == -1)
671 cryptof_poll(struct file *fp, int events, struct ucred *active_cred)
680 cryptof_kqfilter(struct file *fp, struct knote *kn)
690 cryptof_stat(struct file *fp, struct stat *sb, struct ucred *cred)
696 * MPALMOSTSAFE - acquires mplock
699 cryptof_close(struct file *fp)
701 struct fcrypt *fcr = fp->f_data;
702 struct csession *cse;
705 fcr = (struct fcrypt *)fp->f_data;
706 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
707 TAILQ_REMOVE(&fcr->csessions, cse, next);
717 static struct csession *
718 csefind(struct fcrypt *fcr, u_int ses)
720 struct csession *cse;
722 TAILQ_FOREACH(cse, &fcr->csessions, next)
729 csedelete(struct fcrypt *fcr, struct csession *cse_del)
731 struct csession *cse;
733 TAILQ_FOREACH(cse, &fcr->csessions, next) {
734 if (cse == cse_del) {
735 TAILQ_REMOVE(&fcr->csessions, cse, next);
742 static struct csession *
743 cseadd(struct fcrypt *fcr, struct csession *cse)
745 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
746 cse->ses = fcr->sesn++;
751 csecreate(struct fcrypt *fcr, u_int64_t sid, caddr_t key, u_int64_t keylen,
752 caddr_t mackey, u_int64_t mackeylen, u_int32_t cipher, u_int32_t mac,
753 struct enc_xform *txform, struct auth_hash *thash)
755 struct csession *cse;
757 cse = malloc(sizeof(struct csession), M_XDATA, M_NOWAIT);
760 lockinit(&cse->lock, "cryptodev", LK_CANRECURSE);
762 cse->keylen = keylen/8;
763 cse->mackey = mackey;
764 cse->mackeylen = mackeylen/8;
766 cse->cipher = cipher;
768 cse->txform = txform;
775 csefree(struct csession *cse)
779 error = crypto_freesession(cse->sid);
780 lockuninit(&cse->lock);
782 kfree(cse->key, M_XDATA);
784 kfree(cse->mackey, M_XDATA);
790 cryptoopen(struct dev_open_args *ap)
796 cryptoread(struct dev_read_args *ap)
802 cryptowrite(struct dev_write_args *ap)
808 cryptoioctl(struct dev_ioctl_args *ap)
816 fcr = kmalloc(sizeof(struct fcrypt), M_XDATA, M_WAITOK);
817 TAILQ_INIT(&fcr->csessions);
821 error = falloc(curproc, &f, &fd);
827 /* falloc automatically provides an extra reference to 'f'. */
828 finit(f, FREAD | FWRITE, DTYPE_CRYPTO, fcr, &cryptofops);
829 *(u_int32_t *)data = fd;
833 error = cryptodev_find((struct crypt_find_op *)data);
836 error = crypto_getfeat((int *)data);
845 static struct dev_ops crypto_ops = {
847 .d_open = cryptoopen,
848 .d_read = cryptoread,
849 .d_write = cryptowrite,
850 .d_ioctl = cryptoioctl,
854 * Initialization code, both for static and dynamic loading.
857 cryptodev_modevent(module_t mod, int type, void *unused)
862 kprintf("crypto: <crypto device>\n");
863 make_dev(&crypto_ops, 0, UID_ROOT, GID_WHEEL,
867 /*XXX disallow if active sessions */
868 //dev_ops_remove(&crypto_ops, 0, 0);
869 dev_ops_remove_all(&crypto_ops);
875 static moduledata_t cryptodev_mod = {
880 MODULE_VERSION(cryptodev, 1);
881 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
882 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);
883 MODULE_DEPEND(cryptodev, zlib, 1, 1, 1);