2 /* $OpenBSD: cryptodev.c,v 1.52 2002/06/19 07:22:46 deraadt Exp $ */
5 * Copyright (c) 2001 Theo de Raadt
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * Effort sponsored in part by the Defense Advanced Research Projects
31 * Agency (DARPA) and Air Force Research Laboratory, Air Force
32 * 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/mutex.h>
42 #include <sys/sysctl.h>
44 #include <sys/filedesc.h>
45 #include <sys/errno.h>
47 #include <sys/random.h>
49 #include <sys/kernel.h>
50 #include <sys/fcntl.h>
52 #include <opencrypto/cryptodev.h>
53 #include <opencrypto/xform.h>
56 TAILQ_ENTRY(csession) next;
61 struct enc_xform *txform;
63 struct auth_hash *thash;
67 u_char tmp_iv[EALG_MAX_BLOCK_LEN];
71 u_char tmp_mac[CRYPTO_MAX_MAC_LEN];
73 struct iovec iovec[UIO_MAXIOV];
79 TAILQ_HEAD(csessionlist, csession) csessions;
83 static int cryptof_rw(struct file *fp, struct uio *uio,
84 struct ucred *cred, int flags, struct thread *);
85 static int cryptof_ioctl(struct file *, u_long, void *,
86 struct ucred *, struct thread *);
87 static int cryptof_poll(struct file *, int, struct ucred *, struct thread *);
88 static int cryptof_kqfilter(struct file *, struct knote *);
89 static int cryptof_stat(struct file *, struct stat *,
90 struct ucred *, struct thread *);
91 static int cryptof_close(struct file *, struct thread *);
93 static struct fileops cryptofops = {
103 static struct csession *csefind(struct fcrypt *, u_int);
104 static int csedelete(struct fcrypt *, struct csession *);
105 static struct csession *cseadd(struct fcrypt *, struct csession *);
106 static struct csession *csecreate(struct fcrypt *, u_int64_t, caddr_t,
107 u_int64_t, caddr_t, u_int64_t, u_int32_t, u_int32_t, struct enc_xform *,
109 static int csefree(struct csession *);
111 static int cryptodev_op(struct csession *, struct crypt_op *,
112 struct ucred *, struct thread *td);
113 static int cryptodev_key(struct crypt_kop *);
119 struct ucred *active_cred,
133 struct ucred *active_cred,
136 struct cryptoini cria, crie;
137 struct fcrypt *fcr = (struct fcrypt *)fp->f_data;
138 struct csession *cse;
139 struct session_op *sop;
140 struct crypt_op *cop;
141 struct enc_xform *txform = NULL;
142 struct auth_hash *thash = NULL;
149 sop = (struct session_op *)data;
150 switch (sop->cipher) {
154 txform = &enc_xform_des;
156 case CRYPTO_3DES_CBC:
157 txform = &enc_xform_3des;
160 txform = &enc_xform_blf;
162 case CRYPTO_CAST_CBC:
163 txform = &enc_xform_cast5;
165 case CRYPTO_SKIPJACK_CBC:
166 txform = &enc_xform_skipjack;
169 txform = &enc_xform_rijndael128;
171 case CRYPTO_NULL_CBC:
172 txform = &enc_xform_null;
175 txform = &enc_xform_arc4;
184 case CRYPTO_MD5_HMAC:
185 thash = &auth_hash_hmac_md5_96;
187 case CRYPTO_SHA1_HMAC:
188 thash = &auth_hash_hmac_sha1_96;
190 case CRYPTO_SHA2_HMAC:
191 if (sop->mackeylen == auth_hash_hmac_sha2_256.keysize)
192 thash = &auth_hash_hmac_sha2_256;
193 else if (sop->mackeylen == auth_hash_hmac_sha2_384.keysize)
194 thash = &auth_hash_hmac_sha2_384;
195 else if (sop->mackeylen == auth_hash_hmac_sha2_512.keysize)
196 thash = &auth_hash_hmac_sha2_512;
200 case CRYPTO_RIPEMD160_HMAC:
201 thash = &auth_hash_hmac_ripemd_160_96;
205 thash = &auth_hash_md5;
208 thash = &auth_hash_sha1;
211 case CRYPTO_NULL_HMAC:
212 thash = &auth_hash_null;
218 bzero(&crie, sizeof(crie));
219 bzero(&cria, sizeof(cria));
222 crie.cri_alg = txform->type;
223 crie.cri_klen = sop->keylen * 8;
224 if (sop->keylen > txform->maxkey ||
225 sop->keylen < txform->minkey) {
230 MALLOC(crie.cri_key, u_int8_t *,
231 crie.cri_klen / 8, M_XDATA, M_WAITOK);
232 if ((error = copyin(sop->key, crie.cri_key,
236 crie.cri_next = &cria;
240 cria.cri_alg = thash->type;
241 cria.cri_klen = sop->mackeylen * 8;
242 if (sop->mackeylen != thash->keysize) {
248 MALLOC(cria.cri_key, u_int8_t *,
249 cria.cri_klen / 8, M_XDATA, M_WAITOK);
250 if ((error = copyin(sop->mackey, cria.cri_key,
256 error = crypto_newsession(&sid, (txform ? &crie : &cria), 1);
260 cse = csecreate(fcr, sid, crie.cri_key, crie.cri_klen,
261 cria.cri_key, cria.cri_klen, sop->cipher, sop->mac, txform,
265 crypto_freesession(sid);
274 FREE(crie.cri_key, M_XDATA);
276 FREE(cria.cri_key, M_XDATA);
280 ses = *(u_int32_t *)data;
281 cse = csefind(fcr, ses);
285 error = csefree(cse);
288 cop = (struct crypt_op *)data;
289 cse = csefind(fcr, cop->ses);
292 error = cryptodev_op(cse, cop, active_cred, td);
295 error = cryptodev_key((struct crypt_kop *)data);
298 error = crypto_getfeat((int *)data);
306 static int cryptodev_cb(void *);
311 struct csession *cse,
312 struct crypt_op *cop,
313 struct ucred *active_cred,
316 struct cryptop *crp = NULL;
317 struct cryptodesc *crde = NULL, *crda = NULL;
320 if (cop->len > 256*1024-4)
323 if (cse->txform && (cop->len % cse->txform->blocksize) != 0)
326 bzero(&cse->uio, sizeof(cse->uio));
327 cse->uio.uio_iovcnt = 1;
328 cse->uio.uio_resid = 0;
329 cse->uio.uio_segflg = UIO_SYSSPACE;
330 cse->uio.uio_rw = UIO_WRITE;
331 cse->uio.uio_td = td;
332 cse->uio.uio_iov = cse->iovec;
333 bzero(&cse->iovec, sizeof(cse->iovec));
334 cse->uio.uio_iov[0].iov_len = cop->len;
335 cse->uio.uio_iov[0].iov_base = malloc(cop->len, M_XDATA, M_WAITOK);
336 for (i = 0; i < cse->uio.uio_iovcnt; i++)
337 cse->uio.uio_resid += cse->uio.uio_iov[0].iov_len;
339 crp = crypto_getreq((cse->txform != NULL) + (cse->thash != NULL));
346 crda = crp->crp_desc;
348 crde = crda->crd_next;
351 crde = crp->crp_desc;
358 if ((error = copyin(cop->src, cse->uio.uio_iov[0].iov_base, cop->len)))
363 crda->crd_len = cop->len;
364 crda->crd_inject = 0; /* ??? */
366 crda->crd_alg = cse->mac;
367 crda->crd_key = cse->mackey;
368 crda->crd_klen = cse->mackeylen * 8;
372 if (cop->op == COP_ENCRYPT)
373 crde->crd_flags |= CRD_F_ENCRYPT;
375 crde->crd_flags &= ~CRD_F_ENCRYPT;
376 crde->crd_len = cop->len;
377 crde->crd_inject = 0;
379 crde->crd_alg = cse->cipher;
380 crde->crd_key = cse->key;
381 crde->crd_klen = cse->keylen * 8;
384 crp->crp_ilen = cop->len;
385 crp->crp_flags = CRYPTO_F_IOV;
386 crp->crp_buf = (caddr_t)&cse->uio;
387 crp->crp_callback = (int (*) (struct cryptop *)) cryptodev_cb;
388 crp->crp_sid = cse->sid;
389 crp->crp_opaque = (void *)cse;
396 if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
400 if ((error = copyin(cop->iv, cse->tmp_iv, cse->txform->blocksize)))
402 bcopy(cse->tmp_iv, crde->crd_iv, cse->txform->blocksize);
403 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
405 } else if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
408 crde->crd_flags |= CRD_F_IV_PRESENT;
409 crde->crd_skip = cse->txform->blocksize;
410 crde->crd_len -= cse->txform->blocksize;
418 crp->crp_mac=cse->tmp_mac;
421 crypto_dispatch(crp);
422 error = tsleep(cse, PSOCK, "crydev", 0);
424 /* XXX can this happen? if so, how do we recover? */
428 if (crp->crp_etype != 0) {
429 error = crp->crp_etype;
439 (error = copyout(cse->uio.uio_iov[0].iov_base, cop->dst, cop->len)))
443 (error = copyout(crp->crp_mac, cop->mac, cse->thash->authsize)))
449 if (cse->uio.uio_iov[0].iov_base)
450 free(cse->uio.uio_iov[0].iov_base, M_XDATA);
456 cryptodev_cb(void *op)
458 struct cryptop *crp = (struct cryptop *) op;
459 struct csession *cse = (struct csession *)crp->crp_opaque;
461 cse->error = crp->crp_etype;
462 if (crp->crp_etype == EAGAIN)
463 return crypto_dispatch(crp);
469 cryptodevkey_cb(void *op)
471 struct cryptkop *krp = (struct cryptkop *) op;
478 cryptodev_key(struct crypt_kop *kop)
480 struct cryptkop *krp = NULL;
482 int in, out, size, i;
484 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
488 in = kop->crk_iparams;
489 out = kop->crk_oparams;
490 switch (kop->crk_op) {
492 if (in == 3 && out == 1)
495 case CRK_MOD_EXP_CRT:
496 if (in == 6 && out == 1)
500 if (in == 5 && out == 2)
504 if (in == 7 && out == 0)
507 case CRK_DH_COMPUTE_KEY:
508 if (in == 3 && out == 1)
515 krp = (struct cryptkop *)malloc(sizeof *krp, M_XDATA, M_WAITOK);
518 bzero(krp, sizeof *krp);
519 krp->krp_op = kop->crk_op;
520 krp->krp_status = kop->crk_status;
521 krp->krp_iparams = kop->crk_iparams;
522 krp->krp_oparams = kop->crk_oparams;
524 krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb;
526 for (i = 0; i < CRK_MAXPARAM; i++)
527 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
528 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
529 size = (krp->krp_param[i].crp_nbits + 7) / 8;
532 MALLOC(krp->krp_param[i].crp_p, caddr_t, size, M_XDATA, M_WAITOK);
533 if (i >= krp->krp_iparams)
535 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
540 error = crypto_kdispatch(krp);
543 error = tsleep(krp, PSOCK, "crydev", 0);
545 /* XXX can this happen? if so, how do we recover? */
549 if (krp->krp_status != 0) {
550 error = krp->krp_status;
554 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
555 size = (krp->krp_param[i].crp_nbits + 7) / 8;
558 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
565 kop->crk_status = krp->krp_status;
566 for (i = 0; i < CRK_MAXPARAM; i++) {
567 if (krp->krp_param[i].crp_p)
568 FREE(krp->krp_param[i].crp_p, M_XDATA);
580 struct ucred *active_cred,
589 cryptof_kqfilter(struct file *fp, struct knote *kn)
600 struct ucred *active_cred,
609 cryptof_close(struct file *fp, struct thread *td)
611 struct fcrypt *fcr = (struct fcrypt *)fp->f_data;
612 struct csession *cse;
614 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
615 TAILQ_REMOVE(&fcr->csessions, cse, next);
623 static struct csession *
624 csefind(struct fcrypt *fcr, u_int ses)
626 struct csession *cse;
628 TAILQ_FOREACH(cse, &fcr->csessions, next)
635 csedelete(struct fcrypt *fcr, struct csession *cse_del)
637 struct csession *cse;
639 TAILQ_FOREACH(cse, &fcr->csessions, next) {
640 if (cse == cse_del) {
641 TAILQ_REMOVE(&fcr->csessions, cse, next);
648 static struct csession *
649 cseadd(struct fcrypt *fcr, struct csession *cse)
651 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
652 cse->ses = fcr->sesn++;
657 csecreate(struct fcrypt *fcr, u_int64_t sid, caddr_t key, u_int64_t keylen,
658 caddr_t mackey, u_int64_t mackeylen, u_int32_t cipher, u_int32_t mac,
659 struct enc_xform *txform, struct auth_hash *thash)
661 struct csession *cse;
663 MALLOC(cse, struct csession *, sizeof(struct csession),
668 cse->keylen = keylen/8;
669 cse->mackey = mackey;
670 cse->mackeylen = mackeylen/8;
672 cse->cipher = cipher;
674 cse->txform = txform;
681 csefree(struct csession *cse)
685 error = crypto_freesession(cse->sid);
687 FREE(cse->key, M_XDATA);
689 FREE(cse->mackey, M_XDATA);
695 cryptoopen(dev_t dev, int oflags, int devtype, struct thread *td)
697 if (crypto_usercrypto == 0)
703 cryptoread(dev_t dev, struct uio *uio, int ioflag)
709 cryptowrite(dev_t dev, struct uio *uio, int ioflag)
715 cryptoioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct thread *td)
723 MALLOC(fcr, struct fcrypt *,
724 sizeof(struct fcrypt), M_XDATA, M_WAITOK);
725 TAILQ_INIT(&fcr->csessions);
728 error = falloc(td, &f, &fd);
735 f->f_flag = FREAD | FWRITE;
736 f->f_type = DTYPE_CRYPTO;
737 f->f_ops = &cryptofops;
738 f->f_data = (caddr_t) fcr;
739 *(u_int32_t *)data = fd;
749 #define CRYPTO_MAJOR 70 /* from openbsd */
750 static struct cdevsw crypto_cdevsw = {
751 /* open */ cryptoopen,
752 /* close */ nullclose,
753 /* read */ cryptoread,
754 /* write */ cryptowrite,
755 /* ioctl */ cryptoioctl,
758 /* strategy */ nostrategy,
759 /* dev name */ "crypto",
760 /* dev major */ CRYPTO_MAJOR,
766 static dev_t crypto_dev;
769 * Initialization code, both for static and dynamic loading.
772 cryptodev_modevent(module_t mod, int type, void *unused)
777 printf("crypto: <crypto device>\n");
778 crypto_dev = make_dev(&crypto_cdevsw, CRYPTO_MAJOR,
779 UID_ROOT, GID_WHEEL, 0666,
783 /*XXX disallow if active sessions */
784 destroy_dev(crypto_dev);
790 static moduledata_t cryptodev_mod = {
795 MODULE_VERSION(cryptodev, 1);
796 DECLARE_MODULE(cryptodev, cryptodev_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
797 MODULE_DEPEND(cryptodev, crypto, 1, 1, 1);