2/* $OpenBSD: cryptodev.c,v 1.52 2002/06/19 07:22:46 deraadt Exp $ */
3
4/*
5 * Copyright (c) 2001 Theo de Raadt
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
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.
18 *
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.
29 *
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.
33 *
34 */
35
36#include <sys/param.h>
37#include <sys/systm.h>
38#include <sys/malloc.h>
39#include <sys/mbuf.h>
40#include <sys/lock.h>
41#include <sys/mutex.h>
42#include <sys/sysctl.h>
43#include <sys/file.h>
44#include <sys/filedesc.h>
45#include <sys/errno.h>
46#include <sys/uio.h>
47#include <sys/random.h>
48#include <sys/conf.h>
49#include <sys/kernel.h>
50#include <sys/fcntl.h>
51
52#include <opencrypto/cryptodev.h>
53#include <opencrypto/xform.h>
54
55struct csession {
56 TAILQ_ENTRY(csession) next;
57 u_int64_t sid;
58 u_int32_t ses;
59
60 u_int32_t cipher;
61 struct enc_xform *txform;
62 u_int32_t mac;
63 struct auth_hash *thash;
64
65 caddr_t key;
66 int keylen;
67 u_char tmp_iv[EALG_MAX_BLOCK_LEN];
68
69 caddr_t mackey;
70 int mackeylen;
71 u_char tmp_mac[CRYPTO_MAX_MAC_LEN];
72
73 struct iovec iovec[UIO_MAXIOV];
74 struct uio uio;
75 int error;
76};
77
78struct fcrypt {
79 TAILQ_HEAD(csessionlist, csession) csessions;
80 int sesn;
81};
82
83static int cryptof_rw(struct file *fp, struct uio *uio,
84 struct ucred *cred, int flags, struct thread *);
85static int cryptof_ioctl(struct file *, u_long, void *,
86 struct ucred *, struct thread *);
87static int cryptof_poll(struct file *, int, struct ucred *, struct thread *);
88static int cryptof_kqfilter(struct file *, struct knote *);
89static int cryptof_stat(struct file *, struct stat *,
90 struct ucred *, struct thread *);
91static int cryptof_close(struct file *, struct thread *);
92
93static struct fileops cryptofops = {
94 cryptof_rw,
95 cryptof_rw,
96 cryptof_ioctl,
97 cryptof_poll,
98 cryptof_kqfilter,
99 cryptof_stat,
100 cryptof_close
101};
102
103static struct csession *csefind(struct fcrypt *, u_int);
104static int csedelete(struct fcrypt *, struct csession *);
105static struct csession *cseadd(struct fcrypt *, struct csession *);
106static 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 *,
108 struct auth_hash *);
109static int csefree(struct csession *);
110
111static int cryptodev_op(struct csession *, struct crypt_op *,
112 struct ucred *, struct thread *td);
113static int cryptodev_key(struct crypt_kop *);
114
115static int
116cryptof_rw(
117 struct file *fp,
118 struct uio *uio,
119 struct ucred *active_cred,
120 int flags,
121 struct thread *td)
122{
123
124 return (EIO);
125}
126
127/* ARGSUSED */
128static int
129cryptof_ioctl(
130 struct file *fp,
131 u_long cmd,
132 void *data,
133 struct ucred *active_cred,
134 struct thread *td)
135{
136 struct cryptoini cria, crie;
137 struct fcrypt *fcr = 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;
143 u_int64_t sid;
144 u_int32_t ses;
145 int error = 0;
146
147 switch (cmd) {
148 case CIOCGSESSION:
149 sop = (struct session_op *)data;
150 switch (sop->cipher) {
151 case 0:
152 break;
153 case CRYPTO_DES_CBC:
154 txform = &enc_xform_des;
155 break;
156 case CRYPTO_3DES_CBC:
157 txform = &enc_xform_3des;
158 break;
159 case CRYPTO_BLF_CBC:
160 txform = &enc_xform_blf;
161 break;
162 case CRYPTO_CAST_CBC:
163 txform = &enc_xform_cast5;
164 break;
165 case CRYPTO_SKIPJACK_CBC:
166 txform = &enc_xform_skipjack;
167 break;
168 case CRYPTO_AES_CBC:
169 txform = &enc_xform_rijndael128;
170 break;
171 case CRYPTO_NULL_CBC:
172 txform = &enc_xform_null;
173 break;
174 case CRYPTO_ARC4:
175 txform = &enc_xform_arc4;
176 break;
177 default:
178 return (EINVAL);
179 }
180
181 switch (sop->mac) {
182 case 0:
183 break;
184 case CRYPTO_MD5_HMAC:
185 thash = &auth_hash_hmac_md5_96;
186 break;
187 case CRYPTO_SHA1_HMAC:
188 thash = &auth_hash_hmac_sha1_96;
189 break;
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;
197 else
198 return (EINVAL);
199 break;
200 case CRYPTO_RIPEMD160_HMAC:
201 thash = &auth_hash_hmac_ripemd_160_96;
202 break;
203#ifdef notdef
204 case CRYPTO_MD5:
205 thash = &auth_hash_md5;
206 break;
207 case CRYPTO_SHA1:
208 thash = &auth_hash_sha1;
209 break;
210#endif
211 case CRYPTO_NULL_HMAC:
212 thash = &auth_hash_null;
213 break;
214 default:
215 return (EINVAL);
216 }
217
218 bzero(&crie, sizeof(crie));
219 bzero(&cria, sizeof(cria));
220
221 if (txform) {
222 crie.cri_alg = txform->type;
223 crie.cri_klen = sop->keylen * 8;
224 if (sop->keylen > txform->maxkey ||
225 sop->keylen < txform->minkey) {
226 error = EINVAL;
227 goto bail;
228 }
229
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,
233 crie.cri_klen / 8)))
234 goto bail;
235 if (thash)
236 crie.cri_next = &cria;
237 }
238
239 if (thash) {
240 cria.cri_alg = thash->type;
241 cria.cri_klen = sop->mackeylen * 8;
242 if (sop->mackeylen != thash->keysize) {
243 error = EINVAL;
244 goto bail;
245 }
246
247 if (cria.cri_klen) {
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,
251 cria.cri_klen / 8)))
252 goto bail;
253 }
254 }
255
256 error = crypto_newsession(&sid, (txform ? &crie : &cria), 1);
257 if (error)
258 goto bail;
259
260 cse = csecreate(fcr, sid, crie.cri_key, crie.cri_klen,
261 cria.cri_key, cria.cri_klen, sop->cipher, sop->mac, txform,
262 thash);
263
264 if (cse == NULL) {
265 crypto_freesession(sid);
266 error = EINVAL;
267 goto bail;
268 }
269 sop->ses = cse->ses;
270
271bail:
272 if (error) {
273 if (crie.cri_key)
274 FREE(crie.cri_key, M_XDATA);
275 if (cria.cri_key)
276 FREE(cria.cri_key, M_XDATA);
277 }
278 break;
279 case CIOCFSESSION:
280 ses = *(u_int32_t *)data;
281 cse = csefind(fcr, ses);
282 if (cse == NULL)
283 return (EINVAL);
284 csedelete(fcr, cse);
285 error = csefree(cse);
286 break;
287 case CIOCCRYPT:
288 cop = (struct crypt_op *)data;
289 cse = csefind(fcr, cop->ses);
290 if (cse == NULL)
291 return (EINVAL);
292 error = cryptodev_op(cse, cop, active_cred, td);
293 break;
294 case CIOCKEY:
295 error = cryptodev_key((struct crypt_kop *)data);
296 break;
297 case CIOCASYMFEAT:
298 error = crypto_getfeat((int *)data);
299 break;
300 default:
301 error = EINVAL;
302 }
303 return (error);
304}
305
306static int cryptodev_cb(void *);
307
308
309static int
310cryptodev_op(
311 struct csession *cse,
312 struct crypt_op *cop,
313 struct ucred *active_cred,
314 struct thread *td)
315{
316 struct cryptop *crp = NULL;
317 struct cryptodesc *crde = NULL, *crda = NULL;
318 int i, error;
319
320 if (cop->len > 256*1024-4)
321 return (E2BIG);
322
323 if (cse->txform && (cop->len % cse->txform->blocksize) != 0)
324 return (EINVAL);
325
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;
338
339 crp = crypto_getreq((cse->txform != NULL) + (cse->thash != NULL));
340 if (crp == NULL) {
341 error = ENOMEM;
342 goto bail;
343 }
344
345 if (cse->thash) {
346 crda = crp->crp_desc;
347 if (cse->txform)
348 crde = crda->crd_next;
349 } else {
350 if (cse->txform)
351 crde = crp->crp_desc;
352 else {
353 error = EINVAL;
354 goto bail;
355 }
356 }
357
358 if ((error = copyin(cop->src, cse->uio.uio_iov[0].iov_base, cop->len)))
359 goto bail;
360
361 if (crda) {
362 crda->crd_skip = 0;
363 crda->crd_len = cop->len;
364 crda->crd_inject = 0; /* ??? */
365
366 crda->crd_alg = cse->mac;
367 crda->crd_key = cse->mackey;
368 crda->crd_klen = cse->mackeylen * 8;
369 }
370
371 if (crde) {
372 if (cop->op == COP_ENCRYPT)
373 crde->crd_flags |= CRD_F_ENCRYPT;
374 else
375 crde->crd_flags &= ~CRD_F_ENCRYPT;
376 crde->crd_len = cop->len;
377 crde->crd_inject = 0;
378
379 crde->crd_alg = cse->cipher;
380 crde->crd_key = cse->key;
381 crde->crd_klen = cse->keylen * 8;
382 }
383
384 crp->crp_ilen = cop->len;
385 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIMM
386 | (cop->flags & COP_F_BATCH);
387 crp->crp_buf = (caddr_t)&cse->uio;
388 crp->crp_callback = (int (*) (struct cryptop *)) cryptodev_cb;
389 crp->crp_sid = cse->sid;
390 crp->crp_opaque = (void *)cse;
391
392 if (cop->iv) {
393 if (crde == NULL) {
394 error = EINVAL;
395 goto bail;
396 }
397 if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
398 error = EINVAL;
399 goto bail;
400 }
401 if ((error = copyin(cop->iv, cse->tmp_iv, cse->txform->blocksize)))
402 goto bail;
403 bcopy(cse->tmp_iv, crde->crd_iv, cse->txform->blocksize);
404 crde->crd_flags |= CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
405 crde->crd_skip = 0;
406 } else if (cse->cipher == CRYPTO_ARC4) { /* XXX use flag? */
407 crde->crd_skip = 0;
408 } else if (crde) {
409 crde->crd_flags |= CRD_F_IV_PRESENT;
410 crde->crd_skip = cse->txform->blocksize;
411 crde->crd_len -= cse->txform->blocksize;
412 }
413
414 if (cop->mac) {
415 if (crda == NULL) {
416 error = EINVAL;
417 goto bail;
418 }
419 crp->crp_mac=cse->tmp_mac;
420 }
421
422 crypto_dispatch(crp);
423 error = tsleep(cse, PSOCK, "crydev", 0);
424 if (error) {
425 /* XXX can this happen? if so, how do we recover? */
426 goto bail;
427 }
428
429 if (crp->crp_etype != 0) {
430 error = crp->crp_etype;
431 goto bail;
432 }
433
434 if (cse->error) {
435 error = cse->error;
436 goto bail;
437 }
438
439 if (cop->dst &&
440 (error = copyout(cse->uio.uio_iov[0].iov_base, cop->dst, cop->len)))
441 goto bail;
442
443 if (cop->mac &&
444 (error = copyout(crp->crp_mac, cop->mac, cse->thash->authsize)))
445 goto bail;
446
447bail:
448 if (crp)
449 crypto_freereq(crp);
450 if (cse->uio.uio_iov[0].iov_base)
451 free(cse->uio.uio_iov[0].iov_base, M_XDATA);
452
453 return (error);
454}
455
456static int
457cryptodev_cb(void *op)
458{
459 struct cryptop *crp = (struct cryptop *) op;
460 struct csession *cse = (struct csession *)crp->crp_opaque;
461
462 cse->error = crp->crp_etype;
463 if (crp->crp_etype == EAGAIN)
464 return crypto_dispatch(crp);
465 wakeup(cse);
466 return (0);
467}
468
469static int
470cryptodevkey_cb(void *op)
471{
472 struct cryptkop *krp = (struct cryptkop *) op;
473
474 wakeup(krp);
475 return (0);
476}
477
478static int
479cryptodev_key(struct crypt_kop *kop)
480{
481 struct cryptkop *krp = NULL;
482 int error = EINVAL;
483 int in, out, size, i;
484
485 if (kop->crk_iparams + kop->crk_oparams > CRK_MAXPARAM) {
486 return (EFBIG);
487 }
488
489 in = kop->crk_iparams;
490 out = kop->crk_oparams;
491 switch (kop->crk_op) {
492 case CRK_MOD_EXP:
493 if (in == 3 && out == 1)
494 break;
495 return (EINVAL);
496 case CRK_MOD_EXP_CRT:
497 if (in == 6 && out == 1)
498 break;
499 return (EINVAL);
500 case CRK_DSA_SIGN:
501 if (in == 5 && out == 2)
502 break;
503 return (EINVAL);
504 case CRK_DSA_VERIFY:
505 if (in == 7 && out == 0)
506 break;
507 return (EINVAL);
508 case CRK_DH_COMPUTE_KEY:
509 if (in == 3 && out == 1)
510 break;
511 return (EINVAL);
512 default:
513 return (EINVAL);
514 }
515
516 krp = (struct cryptkop *)malloc(sizeof *krp, M_XDATA, M_WAITOK);
517 if (!krp)
518 return (ENOMEM);
519 bzero(krp, sizeof *krp);
520 krp->krp_op = kop->crk_op;
521 krp->krp_status = kop->crk_status;
522 krp->krp_iparams = kop->crk_iparams;
523 krp->krp_oparams = kop->crk_oparams;
524 krp->krp_status = 0;
525 krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb;
526
527 for (i = 0; i < CRK_MAXPARAM; i++)
528 krp->krp_param[i].crp_nbits = kop->crk_param[i].crp_nbits;
529 for (i = 0; i < krp->krp_iparams + krp->krp_oparams; i++) {
530 size = (krp->krp_param[i].crp_nbits + 7) / 8;
531 if (size == 0)
532 continue;
533 MALLOC(krp->krp_param[i].crp_p, caddr_t, size, M_XDATA, M_WAITOK);
534 if (i >= krp->krp_iparams)
535 continue;
536 error = copyin(kop->crk_param[i].crp_p, krp->krp_param[i].crp_p, size);
537 if (error)
538 goto fail;
539 }
540
541 error = crypto_kdispatch(krp);
542 if (error)
543 goto fail;
544 error = tsleep(krp, PSOCK, "crydev", 0);
545 if (error) {
546 /* XXX can this happen? if so, how do we recover? */
547 goto fail;
548 }
549
550 if (krp->krp_status != 0) {
551 error = krp->krp_status;
552 goto fail;
553 }
554
555 for (i = krp->krp_iparams; i < krp->krp_iparams + krp->krp_oparams; i++) {
556 size = (krp->krp_param[i].crp_nbits + 7) / 8;
557 if (size == 0)
558 continue;
559 error = copyout(krp->krp_param[i].crp_p, kop->crk_param[i].crp_p, size);
560 if (error)
561 goto fail;
562 }
563
564fail:
565 if (krp) {
566 kop->crk_status = krp->krp_status;
567 for (i = 0; i < CRK_MAXPARAM; i++) {
568 if (krp->krp_param[i].crp_p)
569 FREE(krp->krp_param[i].crp_p, M_XDATA);
570 }
571 free(krp, M_XDATA);
572 }
573 return (error);
574}
575
576/* ARGSUSED */
577static int
578cryptof_poll(
579 struct file *fp,
580 int events,
581 struct ucred *active_cred,
582 struct thread *td)
583{
584
585 return (0);
586}
587
588/* ARGSUSED */
589static int
590cryptof_kqfilter(struct file *fp, struct knote *kn)
591{
592
593 return (0);
594}
595
596/* ARGSUSED */
597static int
598cryptof_stat(
599 struct file *fp,
600 struct stat *sb,
601 struct ucred *active_cred,
602 struct thread *td)
603{
604
605 return (EOPNOTSUPP);
606}
607
608/* ARGSUSED */
609static int
610cryptof_close(struct file *fp, struct thread *td)
611{
612 struct fcrypt *fcr = fp->f_data;
613 struct csession *cse;
614
615 while ((cse = TAILQ_FIRST(&fcr->csessions))) {
616 TAILQ_REMOVE(&fcr->csessions, cse, next);
617 (void)csefree(cse);
618 }
619 FREE(fcr, M_XDATA);
620 fp->f_data = NULL;
621 return 0;
622}
623
624static struct csession *
625csefind(struct fcrypt *fcr, u_int ses)
626{
627 struct csession *cse;
628
629 TAILQ_FOREACH(cse, &fcr->csessions, next)
630 if (cse->ses == ses)
631 return (cse);
632 return (NULL);
633}
634
635static int
636csedelete(struct fcrypt *fcr, struct csession *cse_del)
637{
638 struct csession *cse;
639
640 TAILQ_FOREACH(cse, &fcr->csessions, next) {
641 if (cse == cse_del) {
642 TAILQ_REMOVE(&fcr->csessions, cse, next);
643 return (1);
644 }
645 }
646 return (0);
647}
648
649static struct csession *
650cseadd(struct fcrypt *fcr, struct csession *cse)
651{
652 TAILQ_INSERT_TAIL(&fcr->csessions, cse, next);
653 cse->ses = fcr->sesn++;
654 return (cse);
655}
656
657struct csession *
658csecreate(struct fcrypt *fcr, u_int64_t sid, caddr_t key, u_int64_t keylen,
659 caddr_t mackey, u_int64_t mackeylen, u_int32_t cipher, u_int32_t mac,
660 struct enc_xform *txform, struct auth_hash *thash)
661{
662 struct csession *cse;
663
664 MALLOC(cse, struct csession *, sizeof(struct csession),
665 M_XDATA, M_NOWAIT);
666 if (cse == NULL)
667 return NULL;
668 cse->key = key;
669 cse->keylen = keylen/8;
670 cse->mackey = mackey;
671 cse->mackeylen = mackeylen/8;
672 cse->sid = sid;
673 cse->cipher = cipher;
674 cse->mac = mac;
675 cse->txform = txform;
676 cse->thash = thash;
677 cseadd(fcr, cse);
678 return (cse);
679}
680
681static int
682csefree(struct csession *cse)
683{
684 int error;
685
686 error = crypto_freesession(cse->sid);
687 if (cse->key)
688 FREE(cse->key, M_XDATA);
689 if (cse->mackey)
690 FREE(cse->mackey, M_XDATA);
691 FREE(cse, M_XDATA);
692 return (error);
693}
694
695static int
696cryptoopen(dev_t dev, int oflags, int devtype, struct thread *td)
697{
698 return (0);
699}
700
701static int
702cryptoread(dev_t dev, struct uio *uio, int ioflag)
703{
704 return (EIO);
705}
706
707static int
708cryptowrite(dev_t dev, struct uio *uio, int ioflag)
709{
710 return (EIO);
711}
712
713static int
714cryptoioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct thread *td)
715{
716 struct file *f;
717 struct fcrypt *fcr;
718 int fd, error;
719
720 switch (cmd) {
721 case CRIOGET:
722 MALLOC(fcr, struct fcrypt *,
723 sizeof(struct fcrypt), M_XDATA, M_WAITOK);
724 TAILQ_INIT(&fcr->csessions);
725 fcr->sesn = 0;
726
727 error = falloc(td, &f, &fd);
728
729 if (error) {
730 FREE(fcr, M_XDATA);
731 return (error);
732 }
733 fhold(f);
734 f->f_flag = FREAD | FWRITE;
735 f->f_type = DTYPE_CRYPTO;
736 f->f_ops = &cryptofops;
737 f->f_data = fcr;
738 *(u_int32_t *)data = fd;
739 fdrop(f, td);
740 break;
741 default:
742 error = EINVAL;
743 break;
744 }
745 return (error);
746}
747
748#define CRYPTO_MAJOR 70 /* from openbsd */
749static struct cdevsw crypto_cdevsw = {
|