1 /* $OpenBSD: cryptodev.c,v 1.52 2002/06/19 07:22:46 deraadt Exp $ */
4 * Copyright (c) 2001 Theo de Raadt
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * Effort sponsored in part by the Defense Advanced Research Projects
30 * Agency (DARPA) and Air Force Research Laboratory, Air Force
31 * Materiel Command, USAF, under agreement number F30602-01-2-0537.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/malloc.h>
42 #include <sys/mutex.h>
43 #include <sys/sysctl.h>
45 #include <sys/filedesc.h>
46 #include <sys/errno.h>
48 #include <sys/random.h>
50 #include <sys/kernel.h>
51 #include <sys/module.h>
52 #include <sys/fcntl.h>
54 #include <opencrypto/cryptodev.h>
55 #include <opencrypto/xform.h>
58 TAILQ_ENTRY(csession) next;
61 struct mtx lock; /* for op submission */
64 struct enc_xform *txform;
66 struct auth_hash *thash;
70 u_char tmp_iv[EALG_MAX_BLOCK_LEN];
81 TAILQ_HEAD(csessionlist, csession) csessions;
85 static int cryptof_rw(struct file *fp, struct uio *uio,
86 struct ucred *cred, int flags, struct thread *);
87 static int cryptof_ioctl(struct file *, u_long, void *,
88 struct ucred *, struct thread *);
89 static int cryptof_poll(struct file *, int, struct ucred *, struct thread *);
90 static int cryptof_kqfilter(struct file *, struct knote *);
91 static int cryptof_stat(struct file *, struct stat *,
92 struct ucred *, struct thread *);
93 static int cryptof_close(struct file *, struct thread *);
95 static struct fileops cryptofops = {
96 .fo_read = cryptof_rw,
97 .fo_write = cryptof_rw,
98 .fo_ioctl = cryptof_ioctl,
99 .fo_poll = cryptof_poll,
100 .fo_kqfilter = cryptof_kqfilter,
101 .fo_stat = cryptof_stat,
102 .fo_close = cryptof_close
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 *,
114 struct ucred *, struct thread *td);
115 static int cryptodev_key(struct crypt_kop *);
121 struct ucred *active_cred,
135 struct ucred *active_cred,
138 struct cryptoini cria, crie;
139 struct fcrypt *fcr = fp->f_data;
140 struct csession *cse;
141 struct session_op *sop;
142 struct crypt_op *cop;
143 struct enc_xform *txform = NULL;
144 struct auth_hash *thash = NULL;
150 * XXX: Not sure Giant is needed, but better safe than sorry
155 sop = (struct session_op *)data;
156 switch (sop->cipher) {
160 txform = &enc_xform_des;
162 case CRYPTO_3DES_CBC:
163 txform = &enc_xform_3des;
166 txform = &enc_xform_blf;
168 case CRYPTO_CAST_CBC:
169 txform = &enc_xform_cast5;
171 case CRYPTO_SKIPJACK_CBC:
172 txform = &enc_xform_skipjack;
175 txform = &enc_xform_rijndael128;
177 case CRYPTO_NULL_CBC:
178 txform = &enc_xform_null;
181 txform = &enc_xform_arc4;
191 case CRYPTO_MD5_HMAC:
192 thash = &auth_hash_hmac_md5;
194 case CRYPTO_SHA1_HMAC:
195 thash = &auth_hash_hmac_sha1;
197 case CRYPTO_SHA2_256_HMAC:
198 thash = &auth_hash_hmac_sha2_256;
200 case CRYPTO_SHA2_384_HMAC:
201 thash = &auth_hash_hmac_sha2_384;
203 case CRYPTO_SHA2_512_HMAC:
204 thash = &auth_hash_hmac_sha2_512;
206 case CRYPTO_RIPEMD160_HMAC:
207 thash = &auth_hash_hmac_ripemd_160;
211 thash = &auth_hash_md5;
214 thash = &auth_hash_sha1;
217 case CRYPTO_NULL_HMAC:
218 thash = &auth_hash_null;
225 bzero(&crie, sizeof(crie));
226 bzero(&cria, sizeof(cria));
229 crie.cri_alg = txform->type;
230 crie.cri_klen = sop->keylen * 8;
231 if (sop->keylen > txform->maxkey ||
232 sop->keylen < txform->minkey) {
237 MALLOC(crie.cri_key, u_int8_t *,
238 crie.cri_klen / 8, M_XDATA, M_WAITOK);
239 if ((error = copyin(sop->key, crie.cri_key,
243 crie.cri_next = &cria;
247 cria.cri_alg = thash->type;
248 cria.cri_klen = sop->mackeylen * 8;
249 if (sop->mackeylen != thash->keysize) {
255 MALLOC(cria.cri_key, u_int8_t *,
256 cria.cri_klen / 8, M_XDATA, M_WAITOK);
257 if ((error = copyin(sop->mackey, cria.cri_key,
263 error = crypto_newsession(&sid, (txform ? &crie : &cria), 1);
265 if (crypto_devallowsoft) {
266 error = crypto_newsession(&sid,
267 (txform ? &crie : &cria), 0);
273 cse = csecreate(fcr, sid, crie.cri_key, crie.cri_klen,
274 cria.cri_key, cria.cri_klen, sop->cipher, sop->mac, txform,
278 crypto_freesession(sid);
287 FREE(crie.cri_key, M_XDATA);
289 FREE(cria.cri_key, M_XDATA);
293 ses = *(u_int32_t *)data;
294 cse = csefind(fcr, ses);
300 error = csefree(cse);
303 cop = (struct crypt_op *)data;
304 cse = csefind(fcr, cop->ses);
309 error = cryptodev_op(cse, cop, active_cred, td);
312 error = cryptodev_key((struct crypt_kop *)data);
315 error = crypto_getfeat((int *)data);
324 static int cryptodev_cb(void *);
329 struct csession *cse,
330 struct crypt_op *cop,
331 struct ucred *active_cred,
334 struct cryptop *crp = NULL;
335 struct cryptodesc *crde = NULL, *crda = NULL;
338 if (cop->len > 256*1024-4)
342 if (cop->len == 0 || (cop->len % cse->txform->blocksize) != 0)
346 cse->uio.uio_iov = &cse->iovec;
347 cse->uio.uio_iovcnt = 1;
348 cse->uio.uio_offset = 0;
349 cse->uio.uio_resid = cop->len;
350 cse->uio.uio_segflg = UIO_SYSSPACE;
351 cse->uio.uio_rw = UIO_WRITE;
352 cse->uio.uio_td = td;
353 cse->uio.uio_iov[0].iov_len = cop->len;
355 cse->uio.uio_iov[0].iov_len += cse->thash->hashsize;
356 cse->uio.uio_iov[0].iov_base = malloc(cse->uio.uio_iov[0].iov_len,
359 crp = crypto_getreq((cse->txform != NULL) + (cse->thash != NULL));
366 crda = crp->crp_desc;
368 crde = crda->crd_next;
371 crde = crp->crp_desc;
378 if ((error = copyin(cop->src, cse->uio.uio_iov[0].iov_base, cop->len)))
383 crda->crd_len = cop->len;
384 crda->crd_inject = cop->len;
386 crda->crd_alg = cse->mac;
387 crda->crd_key = cse->mackey;
388 crda->crd_klen = cse->mackeylen * 8;
392 if (cop->op == COP_ENCRYPT)
393 crde->crd_flags |= CRD_F_ENCRYPT;
395 crde->crd_flags &= ~CRD_F_ENCRYPT;
396 crde->crd_len = cop->len;
397 crde->crd_inject = 0;
399 crde->crd_alg = cse->cipher;
400 crde->crd_key = cse->key;
401 crde->crd_klen = cse->keylen * 8;
404 crp->crp_ilen = cop->len;
405 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIMM
406 | (cop->flags & COP_F_BATCH);
407 crp->crp_buf = (caddr_t)&cse->uio;
408 crp->crp_callback = (int (*) (struct cryptop *)) cryptodev_cb;
409 crp->crp_sid = cse->sid;
410 crp->crp_opaque = (void *)cse;
417 if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
421 if ((error = copyin(cop->iv, cse->tmp_iv, cse->txform->blocksize)))
423 bcopy(cse->tmp_iv, crde->crd_iv, cse->txform->blocksize);
424 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
426 } else if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
429 crde->crd_flags |= CRD_F_IV_PRESENT;
430 crde->crd_skip = cse->txform->blocksize;
431 crde->crd_len -= cse->txform->blocksize;
434 if (cop->mac && crda == NULL) {
440 * Let the dispatch run unlocked, then, interlock against the
441 * callback before checking if the operation completed and going
442 * to sleep. This insures drivers don't inherit our lock which
443 * results in a lock order reversal between crypto_dispatch forced
444 * entry and the crypto_done callback into us.
446 error = crypto_dispatch(crp);
447 mtx_lock(&cse->lock);
448 if (error == 0 && (crp->crp_flags & CRYPTO_F_DONE) == 0)
449 error = msleep(crp, &cse->lock, PWAIT, "crydev", 0);
450 mtx_unlock(&cse->lock);
455 if (crp->crp_etype != 0) {
456 error = crp->crp_etype;
466 (error = copyout(cse->uio.uio_iov[0].iov_base, cop->dst, cop->len)))
470 (error = copyout((caddr_t)cse->uio.uio_iov[0].iov_base + cop->len,
471 cop->mac, cse->thash->hashsize)))
477 if (cse->uio.uio_iov[0].iov_base)
478 free(cse->uio.uio_iov[0].iov_base, M_XDATA);
484 cryptodev_cb(void *op)
486 struct cryptop *crp = (struct cryptop *) op;
487 struct csession *cse = (struct csession *)crp->crp_opaque;
489 cse->error = crp->crp_etype;
490 if (crp->crp_etype == EAGAIN)
491 return crypto_dispatch(crp);
492 mtx_lock(&cse->lock);
494 mtx_unlock(&cse->lock);
499 cryptodevkey_cb(void *op)
501 struct cryptkop *krp = (struct cryptkop *) op;
508 cryptodev_key(struct crypt_kop *kop)
510 struct cryptkop *krp = NULL;
512 int in, out, size, i;
514 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
518 in = kop->crk_iparams;
519 out = kop->crk_oparams;
520 switch (kop->crk_op) {
522 if (in == 3 && out == 1)
525 case CRK_MOD_EXP_CRT:
526 if (in == 6 && out == 1)
530 if (in == 5 && out == 2)
534 if (in == 7 && out == 0)
537 case CRK_DH_COMPUTE_KEY:
538 if (in == 3 && out == 1)
545 krp = (struct cryptkop *)malloc(sizeof *krp, M_XDATA, M_WAITOK);
548 bzero(krp, sizeof *krp);
549 krp->krp_op = kop->crk_op;
550 krp->krp_status = kop->crk_status;
551 krp->krp_iparams = kop->crk_iparams;
552 krp->krp_oparams = kop->crk_oparams;
554 krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb;
556 for (i = 0; i < CRK_MAXPARAM; i++)
557 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
558 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
559 size = (krp->krp_param[i].crp_nbits + 7) / 8;
562 MALLOC(krp->krp_param[i].crp_p, caddr_t, size, M_XDATA, M_WAITOK);
563 if (i >= krp->krp_iparams)
565 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
570 error = crypto_kdispatch(krp);
573 error = tsleep(krp, PSOCK, "crydev", 0);
575 /* XXX can this happen? if so, how do we recover? */
579 if (krp->krp_status != 0) {
580 error = krp->krp_status;
584 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
585 size = (krp->krp_param[i].crp_nbits + 7) / 8;
588 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
595 kop->crk_status = krp->krp_status;
596 for (i = 0; i < CRK_MAXPARAM; i++) {
597 if (krp->krp_param[i].crp_p)
598 FREE(krp->krp_param[i].crp_p, M_XDATA);
610 struct ucred *active_cred,
619 cryptof_kqfilter(struct file *fp, struct knote *kn)
630 struct ucred *active_cred,
639 cryptof_close(struct file *fp, struct thread *td)
641 struct fcrypt *fcr = fp->f_data;
642 struct csession *cse;
644 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
645 TAILQ_REMOVE(&fcr->csessions, cse, next);
653 static struct csession *
654 csefind(struct fcrypt *fcr, u_int ses)
656 struct csession *cse;
658 TAILQ_FOREACH(cse, &fcr->csessions, next)
665 csedelete(struct fcrypt *fcr, struct csession *cse_del)
667 struct csession *cse;
669 TAILQ_FOREACH(cse, &fcr->csessions, next) {
670 if (cse == cse_del) {
671 TAILQ_REMOVE(&fcr->csessions, cse, next);
678 static struct csession *
679 cseadd(struct fcrypt *fcr, struct csession *cse)
681 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
682 cse->ses = fcr->sesn++;
687 csecreate(struct fcrypt *fcr, u_int64_t sid, caddr_t key, u_int64_t keylen,
688 caddr_t mackey, u_int64_t mackeylen, u_int32_t cipher, u_int32_t mac,
689 struct enc_xform *txform, struct auth_hash *thash)
691 struct csession *cse;
694 /* NB: required when mtx_init is built with INVARIANTS */
695 MALLOC(cse, struct csession *, sizeof(struct csession),
696 M_XDATA, M_NOWAIT | M_ZERO);
698 MALLOC(cse, struct csession *, sizeof(struct csession),
703 mtx_init(&cse->lock, "cryptodev", "crypto session lock", MTX_DEF);
705 cse->keylen = keylen/8;
706 cse->mackey = mackey;
707 cse->mackeylen = mackeylen/8;
709 cse->cipher = cipher;
711 cse->txform = txform;
718 csefree(struct csession *cse)
722 error = crypto_freesession(cse->sid);
723 mtx_destroy(&cse->lock);
725 FREE(cse->key, M_XDATA);
727 FREE(cse->mackey, M_XDATA);
733 cryptoopen(struct cdev *dev, int oflags, int devtype, struct thread *td)
739 cryptoread(struct cdev *dev, struct uio *uio, int ioflag)
745 cryptowrite(struct cdev *dev, struct uio *uio, int ioflag)
751 cryptoioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
759 MALLOC(fcr, struct fcrypt *,
760 sizeof(struct fcrypt), M_XDATA, M_WAITOK);
761 TAILQ_INIT(&fcr->csessions);
764 error = falloc(td, &f, &fd);
770 /* falloc automatically provides an extra reference to 'f'. */
771 f->f_flag = FREAD | FWRITE;
772 f->f_type = DTYPE_CRYPTO;
773 f->f_ops = &cryptofops;
775 *(u_int32_t *)data = fd;
785 static struct cdevsw crypto_cdevsw = {
786 .d_version = D_VERSION,
787 .d_flags = D_NEEDGIANT,
788 .d_open = cryptoopen,
789 .d_read = cryptoread,
790 .d_write = cryptowrite,
791 .d_ioctl = cryptoioctl,
794 static struct cdev *crypto_dev;
797 * Initialization code, both for static and dynamic loading.
800 cryptodev_modevent(module_t mod, int type, void *unused)
805 printf("crypto: <crypto device>\n");
806 crypto_dev = make_dev(&crypto_cdevsw, 0,
807 UID_ROOT, GID_WHEEL, 0666,
811 /*XXX disallow if active sessions */
812 destroy_dev(crypto_dev);
818 static moduledata_t cryptodev_mod = {
823 MODULE_VERSION(cryptodev, 1);
824 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
825 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);
826 MODULE_DEPEND(cryptodev, zlib, 1, 1, 1);