1 /*- 2 * Copyright (c) 2002-2006 Sam Leffler. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 */ 24 25 #include <sys/cdefs.h> 26 __FBSDID("$FreeBSD$"); 27 28 /* 29 * Cryptographic Subsystem. 30 * 31 * This code is derived from the Openbsd Cryptographic Framework (OCF) 32 * that has the copyright shown below. Very little of the original 33 * code remains. 34 */ 35 36 /*- 37 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) 38 * 39 * This code was written by Angelos D. Keromytis in Athens, Greece, in 40 * February 2000. Network Security Technologies Inc. (NSTI) kindly 41 * supported the development of this code. 42 * 43 * Copyright (c) 2000, 2001 Angelos D. Keromytis 44 * 45 * Permission to use, copy, and modify this software with or without fee 46 * is hereby granted, provided that this entire notice is included in 47 * all source code copies of any software which is or includes a copy or 48 * modification of this software. 49 * 50 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 51 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 52 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 53 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 54 * PURPOSE. 55 */ 56 57 #define CRYPTO_TIMING /* enable timing support */ 58 59 #include "opt_compat.h" 60 #include "opt_ddb.h" 61 62 #include <sys/param.h> 63 #include <sys/systm.h> 64 #include <sys/eventhandler.h> 65 #include <sys/kernel.h> 66 #include <sys/kthread.h> 67 #include <sys/linker.h> 68 #include <sys/lock.h> 69 #include <sys/module.h> 70 #include <sys/mutex.h> 71 #include <sys/malloc.h> 72 #include <sys/proc.h> 73 #include <sys/refcount.h> 74 #include <sys/sdt.h> 75 #include <sys/smp.h> 76 #include <sys/sysctl.h> 77 #include <sys/taskqueue.h> 78 79 #include <ddb/ddb.h> 80 81 #include <vm/uma.h> 82 #include <crypto/intake.h> 83 #include <opencrypto/cryptodev.h> 84 #include <opencrypto/xform_auth.h> 85 #include <opencrypto/xform_enc.h> 86 87 #include <sys/kobj.h> 88 #include <sys/bus.h> 89 #include "cryptodev_if.h" 90 91 #if defined(__i386__) || defined(__amd64__) || defined(__aarch64__) 92 #include <machine/pcb.h> 93 #endif 94 95 SDT_PROVIDER_DEFINE(opencrypto); 96 97 /* 98 * Crypto drivers register themselves by allocating a slot in the 99 * crypto_drivers table with crypto_get_driverid() and then registering 100 * each asym algorithm they support with crypto_kregister(). 101 */ 102 static struct mtx crypto_drivers_mtx; /* lock on driver table */ 103 #define CRYPTO_DRIVER_LOCK() mtx_lock(&crypto_drivers_mtx) 104 #define CRYPTO_DRIVER_UNLOCK() mtx_unlock(&crypto_drivers_mtx) 105 #define CRYPTO_DRIVER_ASSERT() mtx_assert(&crypto_drivers_mtx, MA_OWNED) 106 107 /* 108 * Crypto device/driver capabilities structure. 109 * 110 * Synchronization: 111 * (d) - protected by CRYPTO_DRIVER_LOCK() 112 * (q) - protected by CRYPTO_Q_LOCK() 113 * Not tagged fields are read-only. 114 */ 115 struct cryptocap { 116 device_t cc_dev; 117 uint32_t cc_hid; 118 u_int32_t cc_sessions; /* (d) # of sessions */ 119 u_int32_t cc_koperations; /* (d) # os asym operations */ 120 u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1]; 121 122 int cc_flags; /* (d) flags */ 123 #define CRYPTOCAP_F_CLEANUP 0x80000000 /* needs resource cleanup */ 124 int cc_qblocked; /* (q) symmetric q blocked */ 125 int cc_kqblocked; /* (q) asymmetric q blocked */ 126 size_t cc_session_size; 127 volatile int cc_refs; 128 }; 129 130 static struct cryptocap **crypto_drivers = NULL; 131 static int crypto_drivers_size = 0; 132 133 struct crypto_session { 134 struct cryptocap *cap; 135 void *softc; 136 struct crypto_session_params csp; 137 }; 138 139 /* 140 * There are two queues for crypto requests; one for symmetric (e.g. 141 * cipher) operations and one for asymmetric (e.g. MOD)operations. 142 * A single mutex is used to lock access to both queues. We could 143 * have one per-queue but having one simplifies handling of block/unblock 144 * operations. 145 */ 146 static int crp_sleep = 0; 147 static TAILQ_HEAD(cryptop_q ,cryptop) crp_q; /* request queues */ 148 static TAILQ_HEAD(,cryptkop) crp_kq; 149 static struct mtx crypto_q_mtx; 150 #define CRYPTO_Q_LOCK() mtx_lock(&crypto_q_mtx) 151 #define CRYPTO_Q_UNLOCK() mtx_unlock(&crypto_q_mtx) 152 153 static SYSCTL_NODE(_kern, OID_AUTO, crypto, CTLFLAG_RW, 0, 154 "In-kernel cryptography"); 155 156 /* 157 * Taskqueue used to dispatch the crypto requests 158 * that have the CRYPTO_F_ASYNC flag 159 */ 160 static struct taskqueue *crypto_tq; 161 162 /* 163 * Crypto seq numbers are operated on with modular arithmetic 164 */ 165 #define CRYPTO_SEQ_GT(a,b) ((int)((a)-(b)) > 0) 166 167 struct crypto_ret_worker { 168 struct mtx crypto_ret_mtx; 169 170 TAILQ_HEAD(,cryptop) crp_ordered_ret_q; /* ordered callback queue for symetric jobs */ 171 TAILQ_HEAD(,cryptop) crp_ret_q; /* callback queue for symetric jobs */ 172 TAILQ_HEAD(,cryptkop) crp_ret_kq; /* callback queue for asym jobs */ 173 174 u_int32_t reorder_ops; /* total ordered sym jobs received */ 175 u_int32_t reorder_cur_seq; /* current sym job dispatched */ 176 177 struct proc *cryptoretproc; 178 }; 179 static struct crypto_ret_worker *crypto_ret_workers = NULL; 180 181 #define CRYPTO_RETW(i) (&crypto_ret_workers[i]) 182 #define CRYPTO_RETW_ID(w) ((w) - crypto_ret_workers) 183 #define FOREACH_CRYPTO_RETW(w) \ 184 for (w = crypto_ret_workers; w < crypto_ret_workers + crypto_workers_num; ++w) 185 186 #define CRYPTO_RETW_LOCK(w) mtx_lock(&w->crypto_ret_mtx) 187 #define CRYPTO_RETW_UNLOCK(w) mtx_unlock(&w->crypto_ret_mtx) 188 #define CRYPTO_RETW_EMPTY(w) \ 189 (TAILQ_EMPTY(&w->crp_ret_q) && TAILQ_EMPTY(&w->crp_ret_kq) && TAILQ_EMPTY(&w->crp_ordered_ret_q)) 190 191 static int crypto_workers_num = 0; 192 SYSCTL_INT(_kern_crypto, OID_AUTO, num_workers, CTLFLAG_RDTUN, 193 &crypto_workers_num, 0, 194 "Number of crypto workers used to dispatch crypto jobs"); 195 #ifdef COMPAT_FREEBSD12 196 SYSCTL_INT(_kern, OID_AUTO, crypto_workers_num, CTLFLAG_RDTUN, 197 &crypto_workers_num, 0, 198 "Number of crypto workers used to dispatch crypto jobs"); 199 #endif 200 201 static uma_zone_t cryptop_zone; 202 static uma_zone_t cryptoses_zone; 203 204 int crypto_userasymcrypto = 1; 205 SYSCTL_INT(_kern_crypto, OID_AUTO, asym_enable, CTLFLAG_RW, 206 &crypto_userasymcrypto, 0, 207 "Enable user-mode access to asymmetric crypto support"); 208 #ifdef COMPAT_FREEBSD12 209 SYSCTL_INT(_kern, OID_AUTO, userasymcrypto, CTLFLAG_RW, 210 &crypto_userasymcrypto, 0, 211 "Enable/disable user-mode access to asymmetric crypto support"); 212 #endif 213 214 int crypto_devallowsoft = 0; 215 SYSCTL_INT(_kern_crypto, OID_AUTO, allow_soft, CTLFLAG_RW, 216 &crypto_devallowsoft, 0, 217 "Enable use of software crypto by /dev/crypto"); 218 #ifdef COMPAT_FREEBSD12 219 SYSCTL_INT(_kern, OID_AUTO, cryptodevallowsoft, CTLFLAG_RW, 220 &crypto_devallowsoft, 0, 221 "Enable/disable use of software crypto by /dev/crypto"); 222 #endif 223 224 MALLOC_DEFINE(M_CRYPTO_DATA, "crypto", "crypto session records"); 225 226 static void crypto_proc(void); 227 static struct proc *cryptoproc; 228 static void crypto_ret_proc(struct crypto_ret_worker *ret_worker); 229 static void crypto_destroy(void); 230 static int crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint); 231 static int crypto_kinvoke(struct cryptkop *krp); 232 static void crypto_task_invoke(void *ctx, int pending); 233 static void crypto_batch_enqueue(struct cryptop *crp); 234 235 static struct cryptostats cryptostats; 236 SYSCTL_STRUCT(_kern_crypto, OID_AUTO, stats, CTLFLAG_RW, &cryptostats, 237 cryptostats, "Crypto system statistics"); 238 239 #ifdef CRYPTO_TIMING 240 static int crypto_timing = 0; 241 SYSCTL_INT(_debug, OID_AUTO, crypto_timing, CTLFLAG_RW, 242 &crypto_timing, 0, "Enable/disable crypto timing support"); 243 #endif 244 245 /* Try to avoid directly exposing the key buffer as a symbol */ 246 static struct keybuf *keybuf; 247 248 static struct keybuf empty_keybuf = { 249 .kb_nents = 0 250 }; 251 252 /* Obtain the key buffer from boot metadata */ 253 static void 254 keybuf_init(void) 255 { 256 caddr_t kmdp; 257 258 kmdp = preload_search_by_type("elf kernel"); 259 260 if (kmdp == NULL) 261 kmdp = preload_search_by_type("elf64 kernel"); 262 263 keybuf = (struct keybuf *)preload_search_info(kmdp, 264 MODINFO_METADATA | MODINFOMD_KEYBUF); 265 266 if (keybuf == NULL) 267 keybuf = &empty_keybuf; 268 } 269 270 /* It'd be nice if we could store these in some kind of secure memory... */ 271 struct keybuf * get_keybuf(void) { 272 273 return (keybuf); 274 } 275 276 static struct cryptocap * 277 cap_ref(struct cryptocap *cap) 278 { 279 280 refcount_acquire(&cap->cc_refs); 281 return (cap); 282 } 283 284 static void 285 cap_rele(struct cryptocap *cap) 286 { 287 288 if (refcount_release(&cap->cc_refs) == 0) 289 return; 290 291 KASSERT(cap->cc_sessions == 0, 292 ("freeing crypto driver with active sessions")); 293 KASSERT(cap->cc_koperations == 0, 294 ("freeing crypto driver with active key operations")); 295 296 free(cap, M_CRYPTO_DATA); 297 } 298 299 static int 300 crypto_init(void) 301 { 302 struct crypto_ret_worker *ret_worker; 303 int error; 304 305 mtx_init(&crypto_drivers_mtx, "crypto", "crypto driver table", 306 MTX_DEF|MTX_QUIET); 307 308 TAILQ_INIT(&crp_q); 309 TAILQ_INIT(&crp_kq); 310 mtx_init(&crypto_q_mtx, "crypto", "crypto op queues", MTX_DEF); 311 312 cryptop_zone = uma_zcreate("cryptop", sizeof (struct cryptop), 313 0, 0, 0, 0, 314 UMA_ALIGN_PTR, UMA_ZONE_ZINIT); 315 cryptoses_zone = uma_zcreate("crypto_session", 316 sizeof(struct crypto_session), NULL, NULL, NULL, NULL, 317 UMA_ALIGN_PTR, UMA_ZONE_ZINIT); 318 319 if (cryptop_zone == NULL || cryptoses_zone == NULL) { 320 printf("crypto_init: cannot setup crypto zones\n"); 321 error = ENOMEM; 322 goto bad; 323 } 324 325 crypto_drivers_size = CRYPTO_DRIVERS_INITIAL; 326 crypto_drivers = malloc(crypto_drivers_size * 327 sizeof(struct cryptocap), M_CRYPTO_DATA, M_NOWAIT | M_ZERO); 328 if (crypto_drivers == NULL) { 329 printf("crypto_init: cannot setup crypto drivers\n"); 330 error = ENOMEM; 331 goto bad; 332 } 333 334 if (crypto_workers_num < 1 || crypto_workers_num > mp_ncpus) 335 crypto_workers_num = mp_ncpus; 336 337 crypto_tq = taskqueue_create("crypto", M_WAITOK|M_ZERO, 338 taskqueue_thread_enqueue, &crypto_tq); 339 if (crypto_tq == NULL) { 340 printf("crypto init: cannot setup crypto taskqueue\n"); 341 error = ENOMEM; 342 goto bad; 343 } 344 345 taskqueue_start_threads(&crypto_tq, crypto_workers_num, PRI_MIN_KERN, 346 "crypto"); 347 348 error = kproc_create((void (*)(void *)) crypto_proc, NULL, 349 &cryptoproc, 0, 0, "crypto"); 350 if (error) { 351 printf("crypto_init: cannot start crypto thread; error %d", 352 error); 353 goto bad; 354 } 355 356 crypto_ret_workers = malloc(crypto_workers_num * sizeof(struct crypto_ret_worker), 357 M_CRYPTO_DATA, M_NOWAIT|M_ZERO); 358 if (crypto_ret_workers == NULL) { 359 error = ENOMEM; 360 printf("crypto_init: cannot allocate ret workers\n"); 361 goto bad; 362 } 363 364 365 FOREACH_CRYPTO_RETW(ret_worker) { 366 TAILQ_INIT(&ret_worker->crp_ordered_ret_q); 367 TAILQ_INIT(&ret_worker->crp_ret_q); 368 TAILQ_INIT(&ret_worker->crp_ret_kq); 369 370 ret_worker->reorder_ops = 0; 371 ret_worker->reorder_cur_seq = 0; 372 373 mtx_init(&ret_worker->crypto_ret_mtx, "crypto", "crypto return queues", MTX_DEF); 374 375 error = kproc_create((void (*)(void *)) crypto_ret_proc, ret_worker, 376 &ret_worker->cryptoretproc, 0, 0, "crypto returns %td", CRYPTO_RETW_ID(ret_worker)); 377 if (error) { 378 printf("crypto_init: cannot start cryptoret thread; error %d", 379 error); 380 goto bad; 381 } 382 } 383 384 keybuf_init(); 385 386 return 0; 387 bad: 388 crypto_destroy(); 389 return error; 390 } 391 392 /* 393 * Signal a crypto thread to terminate. We use the driver 394 * table lock to synchronize the sleep/wakeups so that we 395 * are sure the threads have terminated before we release 396 * the data structures they use. See crypto_finis below 397 * for the other half of this song-and-dance. 398 */ 399 static void 400 crypto_terminate(struct proc **pp, void *q) 401 { 402 struct proc *p; 403 404 mtx_assert(&crypto_drivers_mtx, MA_OWNED); 405 p = *pp; 406 *pp = NULL; 407 if (p) { 408 wakeup_one(q); 409 PROC_LOCK(p); /* NB: insure we don't miss wakeup */ 410 CRYPTO_DRIVER_UNLOCK(); /* let crypto_finis progress */ 411 msleep(p, &p->p_mtx, PWAIT, "crypto_destroy", 0); 412 PROC_UNLOCK(p); 413 CRYPTO_DRIVER_LOCK(); 414 } 415 } 416 417 static void 418 hmac_init_pad(struct auth_hash *axf, const char *key, int klen, void *auth_ctx, 419 uint8_t padval) 420 { 421 uint8_t hmac_key[HMAC_MAX_BLOCK_LEN]; 422 u_int i; 423 424 KASSERT(axf->blocksize <= sizeof(hmac_key), 425 ("Invalid HMAC block size %d", axf->blocksize)); 426 427 /* 428 * If the key is larger than the block size, use the digest of 429 * the key as the key instead. 430 */ 431 memset(hmac_key, 0, sizeof(hmac_key)); 432 if (klen > axf->blocksize) { 433 axf->Init(auth_ctx); 434 axf->Update(auth_ctx, key, klen); 435 axf->Final(hmac_key, auth_ctx); 436 klen = axf->hashsize; 437 } else 438 memcpy(hmac_key, key, klen); 439 440 for (i = 0; i < axf->blocksize; i++) 441 hmac_key[i] ^= padval; 442 443 axf->Init(auth_ctx); 444 axf->Update(auth_ctx, hmac_key, axf->blocksize); 445 } 446 447 void 448 hmac_init_ipad(struct auth_hash *axf, const char *key, int klen, 449 void *auth_ctx) 450 { 451 452 hmac_init_pad(axf, key, klen, auth_ctx, HMAC_IPAD_VAL); 453 } 454 455 void 456 hmac_init_opad(struct auth_hash *axf, const char *key, int klen, 457 void *auth_ctx) 458 { 459 460 hmac_init_pad(axf, key, klen, auth_ctx, HMAC_OPAD_VAL); 461 } 462 463 static void 464 crypto_destroy(void) 465 { 466 struct crypto_ret_worker *ret_worker; 467 int i; 468 469 /* 470 * Terminate any crypto threads. 471 */ 472 if (crypto_tq != NULL) 473 taskqueue_drain_all(crypto_tq); 474 CRYPTO_DRIVER_LOCK(); 475 crypto_terminate(&cryptoproc, &crp_q); 476 FOREACH_CRYPTO_RETW(ret_worker) 477 crypto_terminate(&ret_worker->cryptoretproc, &ret_worker->crp_ret_q); 478 CRYPTO_DRIVER_UNLOCK(); 479 480 /* XXX flush queues??? */ 481 482 /* 483 * Reclaim dynamically allocated resources. 484 */ 485 for (i = 0; i < crypto_drivers_size; i++) { 486 if (crypto_drivers[i] != NULL) 487 cap_rele(crypto_drivers[i]); 488 } 489 free(crypto_drivers, M_CRYPTO_DATA); 490 491 if (cryptoses_zone != NULL) 492 uma_zdestroy(cryptoses_zone); 493 if (cryptop_zone != NULL) 494 uma_zdestroy(cryptop_zone); 495 mtx_destroy(&crypto_q_mtx); 496 FOREACH_CRYPTO_RETW(ret_worker) 497 mtx_destroy(&ret_worker->crypto_ret_mtx); 498 free(crypto_ret_workers, M_CRYPTO_DATA); 499 if (crypto_tq != NULL) 500 taskqueue_free(crypto_tq); 501 mtx_destroy(&crypto_drivers_mtx); 502 } 503 504 uint32_t 505 crypto_ses2hid(crypto_session_t crypto_session) 506 { 507 return (crypto_session->cap->cc_hid); 508 } 509 510 uint32_t 511 crypto_ses2caps(crypto_session_t crypto_session) 512 { 513 return (crypto_session->cap->cc_flags & 0xff000000); 514 } 515 516 void * 517 crypto_get_driver_session(crypto_session_t crypto_session) 518 { 519 return (crypto_session->softc); 520 } 521 522 const struct crypto_session_params * 523 crypto_get_params(crypto_session_t crypto_session) 524 { 525 return (&crypto_session->csp); 526 } 527 528 struct auth_hash * 529 crypto_auth_hash(const struct crypto_session_params *csp) 530 { 531 532 switch (csp->csp_auth_alg) { 533 case CRYPTO_MD5_HMAC: 534 return (&auth_hash_hmac_md5); 535 case CRYPTO_SHA1_HMAC: 536 return (&auth_hash_hmac_sha1); 537 case CRYPTO_SHA2_224_HMAC: 538 return (&auth_hash_hmac_sha2_224); 539 case CRYPTO_SHA2_256_HMAC: 540 return (&auth_hash_hmac_sha2_256); 541 case CRYPTO_SHA2_384_HMAC: 542 return (&auth_hash_hmac_sha2_384); 543 case CRYPTO_SHA2_512_HMAC: 544 return (&auth_hash_hmac_sha2_512); 545 case CRYPTO_NULL_HMAC: 546 return (&auth_hash_null); 547 case CRYPTO_RIPEMD160_HMAC: 548 return (&auth_hash_hmac_ripemd_160); 549 case CRYPTO_MD5_KPDK: 550 return (&auth_hash_key_md5); 551 case CRYPTO_SHA1_KPDK: 552 return (&auth_hash_key_sha1); 553 case CRYPTO_SHA1: 554 return (&auth_hash_sha1); 555 case CRYPTO_SHA2_224: 556 return (&auth_hash_sha2_224); 557 case CRYPTO_SHA2_256: 558 return (&auth_hash_sha2_256); 559 case CRYPTO_SHA2_384: 560 return (&auth_hash_sha2_384); 561 case CRYPTO_SHA2_512: 562 return (&auth_hash_sha2_512); 563 case CRYPTO_AES_NIST_GMAC: 564 switch (csp->csp_auth_klen) { 565 case 128 / 8: 566 return (&auth_hash_nist_gmac_aes_128); 567 case 192 / 8: 568 return (&auth_hash_nist_gmac_aes_192); 569 case 256 / 8: 570 return (&auth_hash_nist_gmac_aes_256); 571 default: 572 return (NULL); 573 } 574 case CRYPTO_BLAKE2B: 575 return (&auth_hash_blake2b); 576 case CRYPTO_BLAKE2S: 577 return (&auth_hash_blake2s); 578 case CRYPTO_POLY1305: 579 return (&auth_hash_poly1305); 580 case CRYPTO_AES_CCM_CBC_MAC: 581 switch (csp->csp_auth_klen) { 582 case 128 / 8: 583 return (&auth_hash_ccm_cbc_mac_128); 584 case 192 / 8: 585 return (&auth_hash_ccm_cbc_mac_192); 586 case 256 / 8: 587 return (&auth_hash_ccm_cbc_mac_256); 588 default: 589 return (NULL); 590 } 591 default: 592 return (NULL); 593 } 594 } 595 596 struct enc_xform * 597 crypto_cipher(const struct crypto_session_params *csp) 598 { 599 600 switch (csp->csp_cipher_alg) { 601 case CRYPTO_DES_CBC: 602 return (&enc_xform_des); 603 case CRYPTO_3DES_CBC: 604 return (&enc_xform_3des); 605 case CRYPTO_BLF_CBC: 606 return (&enc_xform_blf); 607 case CRYPTO_CAST_CBC: 608 return (&enc_xform_cast5); 609 case CRYPTO_SKIPJACK_CBC: 610 return (&enc_xform_skipjack); 611 case CRYPTO_RIJNDAEL128_CBC: 612 return (&enc_xform_rijndael128); 613 case CRYPTO_AES_XTS: 614 return (&enc_xform_aes_xts); 615 case CRYPTO_AES_ICM: 616 return (&enc_xform_aes_icm); 617 case CRYPTO_AES_NIST_GCM_16: 618 return (&enc_xform_aes_nist_gcm); 619 case CRYPTO_CAMELLIA_CBC: 620 return (&enc_xform_camellia); 621 case CRYPTO_NULL_CBC: 622 return (&enc_xform_null); 623 case CRYPTO_CHACHA20: 624 return (&enc_xform_chacha20); 625 case CRYPTO_AES_CCM_16: 626 return (&enc_xform_ccm); 627 default: 628 return (NULL); 629 } 630 } 631 632 static struct cryptocap * 633 crypto_checkdriver(u_int32_t hid) 634 { 635 636 return (hid >= crypto_drivers_size ? NULL : crypto_drivers[hid]); 637 } 638 639 /* 640 * Select a driver for a new session that supports the specified 641 * algorithms and, optionally, is constrained according to the flags. 642 */ 643 static struct cryptocap * 644 crypto_select_driver(const struct crypto_session_params *csp, int flags) 645 { 646 struct cryptocap *cap, *best; 647 int best_match, error, hid; 648 649 CRYPTO_DRIVER_ASSERT(); 650 651 best = NULL; 652 for (hid = 0; hid < crypto_drivers_size; hid++) { 653 /* 654 * If there is no driver for this slot, or the driver 655 * is not appropriate (hardware or software based on 656 * match), then skip. 657 */ 658 cap = crypto_drivers[hid]; 659 if (cap == NULL || 660 (cap->cc_flags & flags) == 0) 661 continue; 662 663 error = CRYPTODEV_PROBESESSION(cap->cc_dev, csp); 664 if (error >= 0) 665 continue; 666 667 /* 668 * Use the driver with the highest probe value. 669 * Hardware drivers use a higher probe value than 670 * software. In case of a tie, prefer the driver with 671 * the fewest active sessions. 672 */ 673 if (best == NULL || error > best_match || 674 (error == best_match && 675 cap->cc_sessions < best->cc_sessions)) { 676 best = cap; 677 best_match = error; 678 } 679 } 680 return best; 681 } 682 683 static enum alg_type { 684 ALG_NONE = 0, 685 ALG_CIPHER, 686 ALG_DIGEST, 687 ALG_KEYED_DIGEST, 688 ALG_COMPRESSION, 689 ALG_AEAD 690 } alg_types[] = { 691 [CRYPTO_DES_CBC] = ALG_CIPHER, 692 [CRYPTO_3DES_CBC] = ALG_CIPHER, 693 [CRYPTO_BLF_CBC] = ALG_CIPHER, 694 [CRYPTO_CAST_CBC] = ALG_CIPHER, 695 [CRYPTO_SKIPJACK_CBC] = ALG_CIPHER, 696 [CRYPTO_MD5_HMAC] = ALG_KEYED_DIGEST, 697 [CRYPTO_SHA1_HMAC] = ALG_KEYED_DIGEST, 698 [CRYPTO_RIPEMD160_HMAC] = ALG_KEYED_DIGEST, 699 [CRYPTO_MD5_KPDK] = ALG_KEYED_DIGEST, 700 [CRYPTO_SHA1_KPDK] = ALG_KEYED_DIGEST, 701 [CRYPTO_AES_CBC] = ALG_CIPHER, 702 [CRYPTO_ARC4] = ALG_CIPHER, 703 [CRYPTO_SHA1] = ALG_DIGEST, 704 [CRYPTO_NULL_HMAC] = ALG_DIGEST, 705 [CRYPTO_NULL_CBC] = ALG_CIPHER, 706 [CRYPTO_DEFLATE_COMP] = ALG_COMPRESSION, 707 [CRYPTO_SHA2_256_HMAC] = ALG_KEYED_DIGEST, 708 [CRYPTO_SHA2_384_HMAC] = ALG_KEYED_DIGEST, 709 [CRYPTO_SHA2_512_HMAC] = ALG_KEYED_DIGEST, 710 [CRYPTO_CAMELLIA_CBC] = ALG_CIPHER, 711 [CRYPTO_AES_XTS] = ALG_CIPHER, 712 [CRYPTO_AES_ICM] = ALG_CIPHER, 713 [CRYPTO_AES_NIST_GMAC] = ALG_KEYED_DIGEST, 714 [CRYPTO_AES_NIST_GCM_16] = ALG_AEAD, 715 [CRYPTO_BLAKE2B] = ALG_KEYED_DIGEST, 716 [CRYPTO_BLAKE2S] = ALG_KEYED_DIGEST, 717 [CRYPTO_CHACHA20] = ALG_CIPHER, 718 [CRYPTO_SHA2_224_HMAC] = ALG_KEYED_DIGEST, 719 [CRYPTO_RIPEMD160] = ALG_DIGEST, 720 [CRYPTO_SHA2_224] = ALG_DIGEST, 721 [CRYPTO_SHA2_256] = ALG_DIGEST, 722 [CRYPTO_SHA2_384] = ALG_DIGEST, 723 [CRYPTO_SHA2_512] = ALG_DIGEST, 724 [CRYPTO_POLY1305] = ALG_KEYED_DIGEST, 725 [CRYPTO_AES_CCM_CBC_MAC] = ALG_KEYED_DIGEST, 726 [CRYPTO_AES_CCM_16] = ALG_AEAD, 727 }; 728 729 static enum alg_type 730 alg_type(int alg) 731 { 732 733 if (alg < nitems(alg_types)) 734 return (alg_types[alg]); 735 return (ALG_NONE); 736 } 737 738 static bool 739 alg_is_compression(int alg) 740 { 741 742 return (alg_type(alg) == ALG_COMPRESSION); 743 } 744 745 static bool 746 alg_is_cipher(int alg) 747 { 748 749 return (alg_type(alg) == ALG_CIPHER); 750 } 751 752 static bool 753 alg_is_digest(int alg) 754 { 755 756 return (alg_type(alg) == ALG_DIGEST || 757 alg_type(alg) == ALG_KEYED_DIGEST); 758 } 759 760 static bool 761 alg_is_keyed_digest(int alg) 762 { 763 764 return (alg_type(alg) == ALG_KEYED_DIGEST); 765 } 766 767 static bool 768 alg_is_aead(int alg) 769 { 770 771 return (alg_type(alg) == ALG_AEAD); 772 } 773 774 /* Various sanity checks on crypto session parameters. */ 775 static bool 776 check_csp(const struct crypto_session_params *csp) 777 { 778 struct auth_hash *axf; 779 780 /* Mode-independent checks. */ 781 if (csp->csp_flags != 0) 782 return (false); 783 if (csp->csp_ivlen < 0 || csp->csp_cipher_klen < 0 || 784 csp->csp_auth_klen < 0 || csp->csp_auth_mlen < 0) 785 return (false); 786 if (csp->csp_auth_key != NULL && csp->csp_auth_klen == 0) 787 return (false); 788 if (csp->csp_cipher_key != NULL && csp->csp_cipher_klen == 0) 789 return (false); 790 791 switch (csp->csp_mode) { 792 case CSP_MODE_COMPRESS: 793 if (!alg_is_compression(csp->csp_cipher_alg)) 794 return (false); 795 if (csp->csp_flags != 0) 796 return (false); 797 if (csp->csp_cipher_klen != 0 || csp->csp_ivlen != 0 || 798 csp->csp_auth_alg != 0 || csp->csp_auth_klen != 0 || 799 csp->csp_auth_mlen != 0) 800 return (false); 801 break; 802 case CSP_MODE_CIPHER: 803 if (!alg_is_cipher(csp->csp_cipher_alg)) 804 return (false); 805 if (csp->csp_cipher_alg != CRYPTO_NULL_CBC) { 806 if (csp->csp_cipher_klen == 0) 807 return (false); 808 if (csp->csp_cipher_alg != CRYPTO_ARC4) { 809 if (csp->csp_ivlen == 0) 810 return (false); 811 } 812 } 813 if (csp->csp_ivlen >= EALG_MAX_BLOCK_LEN) 814 return (false); 815 if (csp->csp_auth_alg != 0 || csp->csp_auth_klen != 0 || 816 csp->csp_auth_mlen != 0) 817 return (false); 818 break; 819 case CSP_MODE_DIGEST: 820 if (csp->csp_cipher_alg != 0 || csp->csp_cipher_klen != 0) 821 return (false); 822 823 /* IV is optional for digests (e.g. GMAC). */ 824 if (csp->csp_ivlen >= EALG_MAX_BLOCK_LEN) 825 return (false); 826 if (!alg_is_digest(csp->csp_auth_alg)) 827 return (false); 828 829 /* Key is optional for BLAKE2 digests. */ 830 if (csp->csp_auth_alg == CRYPTO_BLAKE2B || 831 csp->csp_auth_alg == CRYPTO_BLAKE2S) 832 ; 833 else if (alg_is_keyed_digest(csp->csp_auth_alg)) { 834 if (csp->csp_auth_klen == 0) 835 return (false); 836 } else { 837 if (csp->csp_auth_klen != 0) 838 return (false); 839 } 840 if (csp->csp_auth_mlen != 0) { 841 axf = crypto_auth_hash(csp); 842 if (axf == NULL || csp->csp_auth_mlen > axf->hashsize) 843 return (false); 844 } 845 break; 846 case CSP_MODE_AEAD: 847 if (!alg_is_aead(csp->csp_cipher_alg)) 848 return (false); 849 if (csp->csp_cipher_klen == 0) 850 return (false); 851 if (csp->csp_ivlen == 0 || 852 csp->csp_ivlen >= EALG_MAX_BLOCK_LEN) 853 return (false); 854 if (csp->csp_auth_alg != 0 || csp->csp_auth_klen != 0) 855 return (false); 856 857 /* 858 * XXX: Would be nice to have a better way to get this 859 * value. 860 */ 861 switch (csp->csp_cipher_alg) { 862 case CRYPTO_AES_NIST_GCM_16: 863 case CRYPTO_AES_CCM_16: 864 if (csp->csp_auth_mlen > 16) 865 return (false); 866 break; 867 } 868 break; 869 case CSP_MODE_ETA: 870 if (!alg_is_cipher(csp->csp_cipher_alg)) 871 return (false); 872 if (csp->csp_cipher_alg != CRYPTO_NULL_CBC) { 873 if (csp->csp_cipher_klen == 0) 874 return (false); 875 if (csp->csp_cipher_alg != CRYPTO_ARC4) { 876 if (csp->csp_ivlen == 0) 877 return (false); 878 } 879 } 880 if (csp->csp_ivlen >= EALG_MAX_BLOCK_LEN) 881 return (false); 882 if (!alg_is_digest(csp->csp_auth_alg)) 883 return (false); 884 885 /* Key is optional for BLAKE2 digests. */ 886 if (csp->csp_auth_alg == CRYPTO_BLAKE2B || 887 csp->csp_auth_alg == CRYPTO_BLAKE2S) 888 ; 889 else if (alg_is_keyed_digest(csp->csp_auth_alg)) { 890 if (csp->csp_auth_klen == 0) 891 return (false); 892 } else { 893 if (csp->csp_auth_klen != 0) 894 return (false); 895 } 896 if (csp->csp_auth_mlen != 0) { 897 axf = crypto_auth_hash(csp); 898 if (axf == NULL || csp->csp_auth_mlen > axf->hashsize) 899 return (false); 900 } 901 break; 902 default: 903 return (false); 904 } 905 906 return (true); 907 } 908 909 /* 910 * Delete a session after it has been detached from its driver. 911 */ 912 static void 913 crypto_deletesession(crypto_session_t cses) 914 { 915 struct cryptocap *cap; 916 917 cap = cses->cap; 918 919 explicit_bzero(cses->softc, cap->cc_session_size); 920 free(cses->softc, M_CRYPTO_DATA); 921 uma_zfree(cryptoses_zone, cses); 922 923 CRYPTO_DRIVER_LOCK(); 924 cap->cc_sessions--; 925 if (cap->cc_sessions == 0 && cap->cc_flags & CRYPTOCAP_F_CLEANUP) 926 wakeup(cap); 927 CRYPTO_DRIVER_UNLOCK(); 928 cap_rele(cap); 929 } 930 931 /* 932 * Create a new session. The crid argument specifies a crypto 933 * driver to use or constraints on a driver to select (hardware 934 * only, software only, either). Whatever driver is selected 935 * must be capable of the requested crypto algorithms. 936 */ 937 int 938 crypto_newsession(crypto_session_t *cses, 939 const struct crypto_session_params *csp, int crid) 940 { 941 crypto_session_t res; 942 struct cryptocap *cap; 943 int err; 944 945 if (!check_csp(csp)) 946 return (EINVAL); 947 948 res = NULL; 949 950 CRYPTO_DRIVER_LOCK(); 951 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) { 952 /* 953 * Use specified driver; verify it is capable. 954 */ 955 cap = crypto_checkdriver(crid); 956 if (cap != NULL && CRYPTODEV_PROBESESSION(cap->cc_dev, csp) > 0) 957 cap = NULL; 958 } else { 959 /* 960 * No requested driver; select based on crid flags. 961 */ 962 cap = crypto_select_driver(csp, crid); 963 } 964 if (cap == NULL) { 965 CRYPTO_DRIVER_UNLOCK(); 966 CRYPTDEB("no driver"); 967 return (EOPNOTSUPP); 968 } 969 cap_ref(cap); 970 cap->cc_sessions++; 971 CRYPTO_DRIVER_UNLOCK(); 972 973 res = uma_zalloc(cryptoses_zone, M_WAITOK | M_ZERO); 974 res->cap = cap; 975 res->softc = malloc(cap->cc_session_size, M_CRYPTO_DATA, M_WAITOK | 976 M_ZERO); 977 res->csp = *csp; 978 979 /* Call the driver initialization routine. */ 980 err = CRYPTODEV_NEWSESSION(cap->cc_dev, res, csp); 981 if (err != 0) { 982 CRYPTDEB("dev newsession failed: %d", err); 983 crypto_deletesession(res); 984 return (err); 985 } 986 987 *cses = res; 988 return (0); 989 } 990 991 /* 992 * Delete an existing session (or a reserved session on an unregistered 993 * driver). 994 */ 995 void 996 crypto_freesession(crypto_session_t cses) 997 { 998 struct cryptocap *cap; 999 1000 if (cses == NULL) 1001 return; 1002 1003 cap = cses->cap; 1004 1005 /* Call the driver cleanup routine, if available. */ 1006 CRYPTODEV_FREESESSION(cap->cc_dev, cses); 1007 1008 crypto_deletesession(cses); 1009 } 1010 1011 /* 1012 * Return a new driver id. Registers a driver with the system so that 1013 * it can be probed by subsequent sessions. 1014 */ 1015 int32_t 1016 crypto_get_driverid(device_t dev, size_t sessionsize, int flags) 1017 { 1018 struct cryptocap *cap, **newdrv; 1019 int i; 1020 1021 if ((flags & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) { 1022 device_printf(dev, 1023 "no flags specified when registering driver\n"); 1024 return -1; 1025 } 1026 1027 cap = malloc(sizeof(*cap), M_CRYPTO_DATA, M_WAITOK | M_ZERO); 1028 cap->cc_dev = dev; 1029 cap->cc_session_size = sessionsize; 1030 cap->cc_flags = flags; 1031 refcount_init(&cap->cc_refs, 1); 1032 1033 CRYPTO_DRIVER_LOCK(); 1034 for (;;) { 1035 for (i = 0; i < crypto_drivers_size; i++) { 1036 if (crypto_drivers[i] == NULL) 1037 break; 1038 } 1039 1040 if (i < crypto_drivers_size) 1041 break; 1042 1043 /* Out of entries, allocate some more. */ 1044 1045 if (2 * crypto_drivers_size <= crypto_drivers_size) { 1046 CRYPTO_DRIVER_UNLOCK(); 1047 printf("crypto: driver count wraparound!\n"); 1048 cap_rele(cap); 1049 return (-1); 1050 } 1051 CRYPTO_DRIVER_UNLOCK(); 1052 1053 newdrv = malloc(2 * crypto_drivers_size * 1054 sizeof(*crypto_drivers), M_CRYPTO_DATA, M_WAITOK | M_ZERO); 1055 1056 CRYPTO_DRIVER_LOCK(); 1057 memcpy(newdrv, crypto_drivers, 1058 crypto_drivers_size * sizeof(*crypto_drivers)); 1059 1060 crypto_drivers_size *= 2; 1061 1062 free(crypto_drivers, M_CRYPTO_DATA); 1063 crypto_drivers = newdrv; 1064 } 1065 1066 cap->cc_hid = i; 1067 crypto_drivers[i] = cap; 1068 CRYPTO_DRIVER_UNLOCK(); 1069 1070 if (bootverbose) 1071 printf("crypto: assign %s driver id %u, flags 0x%x\n", 1072 device_get_nameunit(dev), i, flags); 1073 1074 return i; 1075 } 1076 1077 /* 1078 * Lookup a driver by name. We match against the full device 1079 * name and unit, and against just the name. The latter gives 1080 * us a simple widlcarding by device name. On success return the 1081 * driver/hardware identifier; otherwise return -1. 1082 */ 1083 int 1084 crypto_find_driver(const char *match) 1085 { 1086 struct cryptocap *cap; 1087 int i, len = strlen(match); 1088 1089 CRYPTO_DRIVER_LOCK(); 1090 for (i = 0; i < crypto_drivers_size; i++) { 1091 if (crypto_drivers[i] == NULL) 1092 continue; 1093 cap = crypto_drivers[i]; 1094 if (strncmp(match, device_get_nameunit(cap->cc_dev), len) == 0 || 1095 strncmp(match, device_get_name(cap->cc_dev), len) == 0) { 1096 CRYPTO_DRIVER_UNLOCK(); 1097 return (i); 1098 } 1099 } 1100 CRYPTO_DRIVER_UNLOCK(); 1101 return (-1); 1102 } 1103 1104 /* 1105 * Return the device_t for the specified driver or NULL 1106 * if the driver identifier is invalid. 1107 */ 1108 device_t 1109 crypto_find_device_byhid(int hid) 1110 { 1111 struct cryptocap *cap; 1112 device_t dev; 1113 1114 dev = NULL; 1115 CRYPTO_DRIVER_LOCK(); 1116 cap = crypto_checkdriver(hid); 1117 if (cap != NULL) 1118 dev = cap->cc_dev; 1119 CRYPTO_DRIVER_UNLOCK(); 1120 return (dev); 1121 } 1122 1123 /* 1124 * Return the device/driver capabilities. 1125 */ 1126 int 1127 crypto_getcaps(int hid) 1128 { 1129 struct cryptocap *cap; 1130 int flags; 1131 1132 flags = 0; 1133 CRYPTO_DRIVER_LOCK(); 1134 cap = crypto_checkdriver(hid); 1135 if (cap != NULL) 1136 flags = cap->cc_flags; 1137 CRYPTO_DRIVER_UNLOCK(); 1138 return (flags); 1139 } 1140 1141 /* 1142 * Register support for a key-related algorithm. This routine 1143 * is called once for each algorithm supported a driver. 1144 */ 1145 int 1146 crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags) 1147 { 1148 struct cryptocap *cap; 1149 int err; 1150 1151 CRYPTO_DRIVER_LOCK(); 1152 1153 cap = crypto_checkdriver(driverid); 1154 if (cap != NULL && 1155 (CRK_ALGORITM_MIN <= kalg && kalg <= CRK_ALGORITHM_MAX)) { 1156 /* 1157 * XXX Do some performance testing to determine placing. 1158 * XXX We probably need an auxiliary data structure that 1159 * XXX describes relative performances. 1160 */ 1161 1162 cap->cc_kalg[kalg] = flags | CRYPTO_ALG_FLAG_SUPPORTED; 1163 if (bootverbose) 1164 printf("crypto: %s registers key alg %u flags %u\n" 1165 , device_get_nameunit(cap->cc_dev) 1166 , kalg 1167 , flags 1168 ); 1169 err = 0; 1170 } else 1171 err = EINVAL; 1172 1173 CRYPTO_DRIVER_UNLOCK(); 1174 return err; 1175 } 1176 1177 /* 1178 * Unregister all algorithms associated with a crypto driver. 1179 * If there are pending sessions using it, leave enough information 1180 * around so that subsequent calls using those sessions will 1181 * correctly detect the driver has been unregistered and reroute 1182 * requests. 1183 */ 1184 int 1185 crypto_unregister_all(u_int32_t driverid) 1186 { 1187 struct cryptocap *cap; 1188 1189 CRYPTO_DRIVER_LOCK(); 1190 cap = crypto_checkdriver(driverid); 1191 if (cap == NULL) { 1192 CRYPTO_DRIVER_UNLOCK(); 1193 return (EINVAL); 1194 } 1195 1196 cap->cc_flags |= CRYPTOCAP_F_CLEANUP; 1197 crypto_drivers[driverid] = NULL; 1198 1199 /* 1200 * XXX: This doesn't do anything to kick sessions that 1201 * have no pending operations. 1202 */ 1203 while (cap->cc_sessions != 0 || cap->cc_koperations != 0) 1204 mtx_sleep(cap, &crypto_drivers_mtx, 0, "cryunreg", 0); 1205 CRYPTO_DRIVER_UNLOCK(); 1206 cap_rele(cap); 1207 1208 return (0); 1209 } 1210 1211 /* 1212 * Clear blockage on a driver. The what parameter indicates whether 1213 * the driver is now ready for cryptop's and/or cryptokop's. 1214 */ 1215 int 1216 crypto_unblock(u_int32_t driverid, int what) 1217 { 1218 struct cryptocap *cap; 1219 int err; 1220 1221 CRYPTO_Q_LOCK(); 1222 cap = crypto_checkdriver(driverid); 1223 if (cap != NULL) { 1224 if (what & CRYPTO_SYMQ) 1225 cap->cc_qblocked = 0; 1226 if (what & CRYPTO_ASYMQ) 1227 cap->cc_kqblocked = 0; 1228 if (crp_sleep) 1229 wakeup_one(&crp_q); 1230 err = 0; 1231 } else 1232 err = EINVAL; 1233 CRYPTO_Q_UNLOCK(); 1234 1235 return err; 1236 } 1237 1238 #ifdef INVARIANTS 1239 /* Various sanity checks on crypto requests. */ 1240 static void 1241 crp_sanity(struct cryptop *crp) 1242 { 1243 struct crypto_session_params *csp; 1244 1245 KASSERT(crp->crp_session != NULL, ("incoming crp without a session")); 1246 KASSERT(crp->crp_ilen >= 0, ("incoming crp with -ve input length")); 1247 KASSERT(crp->crp_etype == 0, ("incoming crp with error")); 1248 KASSERT(!(crp->crp_flags & CRYPTO_F_DONE), 1249 ("incoming crp already done")); 1250 1251 csp = &crp->crp_session->csp; 1252 switch (csp->csp_mode) { 1253 case CSP_MODE_COMPRESS: 1254 KASSERT(crp->crp_op == CRYPTO_OP_COMPRESS || 1255 crp->crp_op == CRYPTO_OP_DECOMPRESS, 1256 ("invalid compression op %x", crp->crp_op)); 1257 break; 1258 case CSP_MODE_CIPHER: 1259 KASSERT(crp->crp_op == CRYPTO_OP_ENCRYPT || 1260 crp->crp_op == CRYPTO_OP_DECRYPT, 1261 ("invalid cipher op %x", crp->crp_op)); 1262 break; 1263 case CSP_MODE_DIGEST: 1264 KASSERT(crp->crp_op == CRYPTO_OP_COMPUTE_DIGEST || 1265 crp->crp_op == CRYPTO_OP_VERIFY_DIGEST, 1266 ("invalid digest op %x", crp->crp_op)); 1267 break; 1268 case CSP_MODE_AEAD: 1269 KASSERT(crp->crp_op == 1270 (CRYPTO_OP_ENCRYPT | CRYPTO_OP_COMPUTE_DIGEST) || 1271 crp->crp_op == 1272 (CRYPTO_OP_DECRYPT | CRYPTO_OP_VERIFY_DIGEST), 1273 ("invalid AEAD op %x", crp->crp_op)); 1274 if (csp->csp_cipher_alg == CRYPTO_AES_NIST_GCM_16) 1275 KASSERT(crp->crp_flags & CRYPTO_F_IV_SEPARATE, 1276 ("GCM without a separate IV")); 1277 if (csp->csp_cipher_alg == CRYPTO_AES_CCM_16) 1278 KASSERT(crp->crp_flags & CRYPTO_F_IV_SEPARATE, 1279 ("CCM without a separate IV")); 1280 break; 1281 case CSP_MODE_ETA: 1282 KASSERT(crp->crp_op == 1283 (CRYPTO_OP_ENCRYPT | CRYPTO_OP_COMPUTE_DIGEST) || 1284 crp->crp_op == 1285 (CRYPTO_OP_DECRYPT | CRYPTO_OP_VERIFY_DIGEST), 1286 ("invalid ETA op %x", crp->crp_op)); 1287 break; 1288 } 1289 KASSERT(crp->crp_buf_type >= CRYPTO_BUF_CONTIG && 1290 crp->crp_buf_type <= CRYPTO_BUF_MBUF, 1291 ("invalid crp buffer type %d", crp->crp_buf_type)); 1292 if (csp->csp_mode == CSP_MODE_AEAD || csp->csp_mode == CSP_MODE_ETA) { 1293 KASSERT(crp->crp_aad_start == 0 || 1294 crp->crp_aad_start < crp->crp_ilen, 1295 ("invalid AAD start")); 1296 KASSERT(crp->crp_aad_length != 0 || crp->crp_aad_start == 0, 1297 ("AAD with zero length and non-zero start")); 1298 KASSERT(crp->crp_aad_length == 0 || 1299 crp->crp_aad_start + crp->crp_aad_length <= crp->crp_ilen, 1300 ("AAD outside input length")); 1301 } else { 1302 KASSERT(crp->crp_aad_start == 0 && crp->crp_aad_length == 0, 1303 ("AAD region in request not supporting AAD")); 1304 } 1305 if (csp->csp_ivlen == 0) { 1306 KASSERT((crp->crp_flags & CRYPTO_F_IV_SEPARATE) == 0, 1307 ("IV_SEPARATE set when IV isn't used")); 1308 KASSERT(crp->crp_iv_start == 0, 1309 ("crp_iv_start set when IV isn't used")); 1310 } else if (crp->crp_flags & CRYPTO_F_IV_SEPARATE) { 1311 KASSERT(crp->crp_iv_start == 0, 1312 ("IV_SEPARATE used with non-zero IV start")); 1313 } else { 1314 KASSERT(crp->crp_iv_start < crp->crp_ilen, 1315 ("invalid IV start")); 1316 KASSERT(crp->crp_iv_start + csp->csp_ivlen <= crp->crp_ilen, 1317 ("IV outside input length")); 1318 } 1319 KASSERT(crp->crp_payload_start == 0 || 1320 crp->crp_payload_start < crp->crp_ilen, 1321 ("invalid payload start")); 1322 KASSERT(crp->crp_payload_start + crp->crp_payload_length <= 1323 crp->crp_ilen, ("payload outside input length")); 1324 if (csp->csp_mode == CSP_MODE_DIGEST || 1325 csp->csp_mode == CSP_MODE_AEAD || csp->csp_mode == CSP_MODE_ETA) { 1326 KASSERT(crp->crp_digest_start == 0 || 1327 crp->crp_digest_start < crp->crp_ilen, 1328 ("invalid digest start")); 1329 /* XXX: For the mlen == 0 case this check isn't perfect. */ 1330 KASSERT(crp->crp_digest_start + csp->csp_auth_mlen <= 1331 crp->crp_ilen, 1332 ("digest outside input length")); 1333 } else { 1334 KASSERT(crp->crp_digest_start == 0, 1335 ("non-zero digest start for request without a digest")); 1336 } 1337 if (csp->csp_cipher_klen != 0) 1338 KASSERT(csp->csp_cipher_key != NULL || 1339 crp->crp_cipher_key != NULL, 1340 ("cipher request without a key")); 1341 if (csp->csp_auth_klen != 0) 1342 KASSERT(csp->csp_auth_key != NULL || crp->crp_auth_key != NULL, 1343 ("auth request without a key")); 1344 KASSERT(crp->crp_callback != NULL, ("incoming crp without callback")); 1345 } 1346 #endif 1347 1348 /* 1349 * Add a crypto request to a queue, to be processed by the kernel thread. 1350 */ 1351 int 1352 crypto_dispatch(struct cryptop *crp) 1353 { 1354 struct cryptocap *cap; 1355 int result; 1356 1357 #ifdef INVARIANTS 1358 crp_sanity(crp); 1359 #endif 1360 1361 cryptostats.cs_ops++; 1362 1363 #ifdef CRYPTO_TIMING 1364 if (crypto_timing) 1365 binuptime(&crp->crp_tstamp); 1366 #endif 1367 1368 crp->crp_retw_id = ((uintptr_t)crp->crp_session) % crypto_workers_num; 1369 1370 if (CRYPTOP_ASYNC(crp)) { 1371 if (crp->crp_flags & CRYPTO_F_ASYNC_KEEPORDER) { 1372 struct crypto_ret_worker *ret_worker; 1373 1374 ret_worker = CRYPTO_RETW(crp->crp_retw_id); 1375 1376 CRYPTO_RETW_LOCK(ret_worker); 1377 crp->crp_seq = ret_worker->reorder_ops++; 1378 CRYPTO_RETW_UNLOCK(ret_worker); 1379 } 1380 1381 TASK_INIT(&crp->crp_task, 0, crypto_task_invoke, crp); 1382 taskqueue_enqueue(crypto_tq, &crp->crp_task); 1383 return (0); 1384 } 1385 1386 if ((crp->crp_flags & CRYPTO_F_BATCH) == 0) { 1387 /* 1388 * Caller marked the request to be processed 1389 * immediately; dispatch it directly to the 1390 * driver unless the driver is currently blocked. 1391 */ 1392 cap = crp->crp_session->cap; 1393 if (!cap->cc_qblocked) { 1394 result = crypto_invoke(cap, crp, 0); 1395 if (result != ERESTART) 1396 return (result); 1397 /* 1398 * The driver ran out of resources, put the request on 1399 * the queue. 1400 */ 1401 } 1402 } 1403 crypto_batch_enqueue(crp); 1404 return 0; 1405 } 1406 1407 void 1408 crypto_batch_enqueue(struct cryptop *crp) 1409 { 1410 1411 CRYPTO_Q_LOCK(); 1412 TAILQ_INSERT_TAIL(&crp_q, crp, crp_next); 1413 if (crp_sleep) 1414 wakeup_one(&crp_q); 1415 CRYPTO_Q_UNLOCK(); 1416 } 1417 1418 /* 1419 * Add an asymetric crypto request to a queue, 1420 * to be processed by the kernel thread. 1421 */ 1422 int 1423 crypto_kdispatch(struct cryptkop *krp) 1424 { 1425 int error; 1426 1427 cryptostats.cs_kops++; 1428 1429 krp->krp_cap = NULL; 1430 error = crypto_kinvoke(krp); 1431 if (error == ERESTART) { 1432 CRYPTO_Q_LOCK(); 1433 TAILQ_INSERT_TAIL(&crp_kq, krp, krp_next); 1434 if (crp_sleep) 1435 wakeup_one(&crp_q); 1436 CRYPTO_Q_UNLOCK(); 1437 error = 0; 1438 } 1439 return error; 1440 } 1441 1442 /* 1443 * Verify a driver is suitable for the specified operation. 1444 */ 1445 static __inline int 1446 kdriver_suitable(const struct cryptocap *cap, const struct cryptkop *krp) 1447 { 1448 return (cap->cc_kalg[krp->krp_op] & CRYPTO_ALG_FLAG_SUPPORTED) != 0; 1449 } 1450 1451 /* 1452 * Select a driver for an asym operation. The driver must 1453 * support the necessary algorithm. The caller can constrain 1454 * which device is selected with the flags parameter. The 1455 * algorithm we use here is pretty stupid; just use the first 1456 * driver that supports the algorithms we need. If there are 1457 * multiple suitable drivers we choose the driver with the 1458 * fewest active operations. We prefer hardware-backed 1459 * drivers to software ones when either may be used. 1460 */ 1461 static struct cryptocap * 1462 crypto_select_kdriver(const struct cryptkop *krp, int flags) 1463 { 1464 struct cryptocap *cap, *best; 1465 int match, hid; 1466 1467 CRYPTO_DRIVER_ASSERT(); 1468 1469 /* 1470 * Look first for hardware crypto devices if permitted. 1471 */ 1472 if (flags & CRYPTOCAP_F_HARDWARE) 1473 match = CRYPTOCAP_F_HARDWARE; 1474 else 1475 match = CRYPTOCAP_F_SOFTWARE; 1476 best = NULL; 1477 again: 1478 for (hid = 0; hid < crypto_drivers_size; hid++) { 1479 /* 1480 * If there is no driver for this slot, or the driver 1481 * is not appropriate (hardware or software based on 1482 * match), then skip. 1483 */ 1484 cap = crypto_drivers[hid]; 1485 if (cap->cc_dev == NULL || 1486 (cap->cc_flags & match) == 0) 1487 continue; 1488 1489 /* verify all the algorithms are supported. */ 1490 if (kdriver_suitable(cap, krp)) { 1491 if (best == NULL || 1492 cap->cc_koperations < best->cc_koperations) 1493 best = cap; 1494 } 1495 } 1496 if (best != NULL) 1497 return best; 1498 if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) { 1499 /* sort of an Algol 68-style for loop */ 1500 match = CRYPTOCAP_F_SOFTWARE; 1501 goto again; 1502 } 1503 return best; 1504 } 1505 1506 /* 1507 * Choose a driver for an asymmetric crypto request. 1508 */ 1509 static struct cryptocap * 1510 crypto_lookup_kdriver(struct cryptkop *krp) 1511 { 1512 struct cryptocap *cap; 1513 uint32_t crid; 1514 1515 /* If this request is requeued, it might already have a driver. */ 1516 cap = krp->krp_cap; 1517 if (cap != NULL) 1518 return (cap); 1519 1520 /* Use krp_crid to choose a driver. */ 1521 crid = krp->krp_crid; 1522 if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) { 1523 cap = crypto_checkdriver(crid); 1524 if (cap != NULL) { 1525 /* 1526 * Driver present, it must support the 1527 * necessary algorithm and, if s/w drivers are 1528 * excluded, it must be registered as 1529 * hardware-backed. 1530 */ 1531 if (!kdriver_suitable(cap, krp) || 1532 (!crypto_devallowsoft && 1533 (cap->cc_flags & CRYPTOCAP_F_HARDWARE) == 0)) 1534 cap = NULL; 1535 } 1536 } else { 1537 /* 1538 * No requested driver; select based on crid flags. 1539 */ 1540 if (!crypto_devallowsoft) /* NB: disallow s/w drivers */ 1541 crid &= ~CRYPTOCAP_F_SOFTWARE; 1542 cap = crypto_select_kdriver(krp, crid); 1543 } 1544 1545 if (cap != NULL) { 1546 krp->krp_cap = cap_ref(cap); 1547 krp->krp_hid = cap->cc_hid; 1548 } 1549 return (cap); 1550 } 1551 1552 /* 1553 * Dispatch an asymmetric crypto request. 1554 */ 1555 static int 1556 crypto_kinvoke(struct cryptkop *krp) 1557 { 1558 struct cryptocap *cap = NULL; 1559 int error; 1560 1561 KASSERT(krp != NULL, ("%s: krp == NULL", __func__)); 1562 KASSERT(krp->krp_callback != NULL, 1563 ("%s: krp->crp_callback == NULL", __func__)); 1564 1565 CRYPTO_DRIVER_LOCK(); 1566 cap = crypto_lookup_kdriver(krp); 1567 if (cap == NULL) { 1568 CRYPTO_DRIVER_UNLOCK(); 1569 krp->krp_status = ENODEV; 1570 crypto_kdone(krp); 1571 return (0); 1572 } 1573 1574 /* 1575 * If the device is blocked, return ERESTART to requeue it. 1576 */ 1577 if (cap->cc_kqblocked) { 1578 /* 1579 * XXX: Previously this set krp_status to ERESTART and 1580 * invoked crypto_kdone but the caller would still 1581 * requeue it. 1582 */ 1583 CRYPTO_DRIVER_UNLOCK(); 1584 return (ERESTART); 1585 } 1586 1587 cap->cc_koperations++; 1588 CRYPTO_DRIVER_UNLOCK(); 1589 error = CRYPTODEV_KPROCESS(cap->cc_dev, krp, 0); 1590 if (error == ERESTART) { 1591 CRYPTO_DRIVER_LOCK(); 1592 cap->cc_koperations--; 1593 CRYPTO_DRIVER_UNLOCK(); 1594 return (error); 1595 } 1596 1597 KASSERT(error == 0, ("error %d returned from crypto_kprocess", error)); 1598 return (0); 1599 } 1600 1601 #ifdef CRYPTO_TIMING 1602 static void 1603 crypto_tstat(struct cryptotstat *ts, struct bintime *bt) 1604 { 1605 struct bintime now, delta; 1606 struct timespec t; 1607 uint64_t u; 1608 1609 binuptime(&now); 1610 u = now.frac; 1611 delta.frac = now.frac - bt->frac; 1612 delta.sec = now.sec - bt->sec; 1613 if (u < delta.frac) 1614 delta.sec--; 1615 bintime2timespec(&delta, &t); 1616 timespecadd(&ts->acc, &t, &ts->acc); 1617 if (timespeccmp(&t, &ts->min, <)) 1618 ts->min = t; 1619 if (timespeccmp(&t, &ts->max, >)) 1620 ts->max = t; 1621 ts->count++; 1622 1623 *bt = now; 1624 } 1625 #endif 1626 1627 static void 1628 crypto_task_invoke(void *ctx, int pending) 1629 { 1630 struct cryptocap *cap; 1631 struct cryptop *crp; 1632 int result; 1633 1634 crp = (struct cryptop *)ctx; 1635 cap = crp->crp_session->cap; 1636 result = crypto_invoke(cap, crp, 0); 1637 if (result == ERESTART) 1638 crypto_batch_enqueue(crp); 1639 } 1640 1641 /* 1642 * Dispatch a crypto request to the appropriate crypto devices. 1643 */ 1644 static int 1645 crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint) 1646 { 1647 1648 KASSERT(crp != NULL, ("%s: crp == NULL", __func__)); 1649 KASSERT(crp->crp_callback != NULL, 1650 ("%s: crp->crp_callback == NULL", __func__)); 1651 KASSERT(crp->crp_session != NULL, 1652 ("%s: crp->crp_session == NULL", __func__)); 1653 1654 #ifdef CRYPTO_TIMING 1655 if (crypto_timing) 1656 crypto_tstat(&cryptostats.cs_invoke, &crp->crp_tstamp); 1657 #endif 1658 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) { 1659 struct crypto_session_params csp; 1660 crypto_session_t nses; 1661 1662 /* 1663 * Driver has unregistered; migrate the session and return 1664 * an error to the caller so they'll resubmit the op. 1665 * 1666 * XXX: What if there are more already queued requests for this 1667 * session? 1668 * 1669 * XXX: Real solution is to make sessions refcounted 1670 * and force callers to hold a reference when 1671 * assigning to crp_session. Could maybe change 1672 * crypto_getreq to accept a session pointer to make 1673 * that work. Alternatively, we could abandon the 1674 * notion of rewriting crp_session in requests forcing 1675 * the caller to deal with allocating a new session. 1676 * Perhaps provide a method to allow a crp's session to 1677 * be swapped that callers could use. 1678 */ 1679 csp = crp->crp_session->csp; 1680 crypto_freesession(crp->crp_session); 1681 1682 /* 1683 * XXX: Key pointers may no longer be valid. If we 1684 * really want to support this we need to define the 1685 * KPI such that 'csp' is required to be valid for the 1686 * duration of a session by the caller perhaps. 1687 * 1688 * XXX: If the keys have been changed this will reuse 1689 * the old keys. This probably suggests making 1690 * rekeying more explicit and updating the key 1691 * pointers in 'csp' when the keys change. 1692 */ 1693 if (crypto_newsession(&nses, &csp, 1694 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE) == 0) 1695 crp->crp_session = nses; 1696 1697 crp->crp_etype = EAGAIN; 1698 crypto_done(crp); 1699 return 0; 1700 } else { 1701 /* 1702 * Invoke the driver to process the request. 1703 */ 1704 return CRYPTODEV_PROCESS(cap->cc_dev, crp, hint); 1705 } 1706 } 1707 1708 void 1709 crypto_freereq(struct cryptop *crp) 1710 { 1711 1712 if (crp == NULL) 1713 return; 1714 1715 #ifdef DIAGNOSTIC 1716 { 1717 struct cryptop *crp2; 1718 struct crypto_ret_worker *ret_worker; 1719 1720 CRYPTO_Q_LOCK(); 1721 TAILQ_FOREACH(crp2, &crp_q, crp_next) { 1722 KASSERT(crp2 != crp, 1723 ("Freeing cryptop from the crypto queue (%p).", 1724 crp)); 1725 } 1726 CRYPTO_Q_UNLOCK(); 1727 1728 FOREACH_CRYPTO_RETW(ret_worker) { 1729 CRYPTO_RETW_LOCK(ret_worker); 1730 TAILQ_FOREACH(crp2, &ret_worker->crp_ret_q, crp_next) { 1731 KASSERT(crp2 != crp, 1732 ("Freeing cryptop from the return queue (%p).", 1733 crp)); 1734 } 1735 CRYPTO_RETW_UNLOCK(ret_worker); 1736 } 1737 } 1738 #endif 1739 1740 uma_zfree(cryptop_zone, crp); 1741 } 1742 1743 struct cryptop * 1744 crypto_getreq(crypto_session_t cses, int how) 1745 { 1746 struct cryptop *crp; 1747 1748 MPASS(how == M_WAITOK || how == M_NOWAIT); 1749 crp = uma_zalloc(cryptop_zone, how | M_ZERO); 1750 crp->crp_session = cses; 1751 return (crp); 1752 } 1753 1754 /* 1755 * Invoke the callback on behalf of the driver. 1756 */ 1757 void 1758 crypto_done(struct cryptop *crp) 1759 { 1760 KASSERT((crp->crp_flags & CRYPTO_F_DONE) == 0, 1761 ("crypto_done: op already done, flags 0x%x", crp->crp_flags)); 1762 crp->crp_flags |= CRYPTO_F_DONE; 1763 if (crp->crp_etype != 0) 1764 cryptostats.cs_errs++; 1765 #ifdef CRYPTO_TIMING 1766 if (crypto_timing) 1767 crypto_tstat(&cryptostats.cs_done, &crp->crp_tstamp); 1768 #endif 1769 /* 1770 * CBIMM means unconditionally do the callback immediately; 1771 * CBIFSYNC means do the callback immediately only if the 1772 * operation was done synchronously. Both are used to avoid 1773 * doing extraneous context switches; the latter is mostly 1774 * used with the software crypto driver. 1775 */ 1776 if (!CRYPTOP_ASYNC_KEEPORDER(crp) && 1777 ((crp->crp_flags & CRYPTO_F_CBIMM) || 1778 ((crp->crp_flags & CRYPTO_F_CBIFSYNC) && 1779 (crypto_ses2caps(crp->crp_session) & CRYPTOCAP_F_SYNC)))) { 1780 /* 1781 * Do the callback directly. This is ok when the 1782 * callback routine does very little (e.g. the 1783 * /dev/crypto callback method just does a wakeup). 1784 */ 1785 #ifdef CRYPTO_TIMING 1786 if (crypto_timing) { 1787 /* 1788 * NB: We must copy the timestamp before 1789 * doing the callback as the cryptop is 1790 * likely to be reclaimed. 1791 */ 1792 struct bintime t = crp->crp_tstamp; 1793 crypto_tstat(&cryptostats.cs_cb, &t); 1794 crp->crp_callback(crp); 1795 crypto_tstat(&cryptostats.cs_finis, &t); 1796 } else 1797 #endif 1798 crp->crp_callback(crp); 1799 } else { 1800 struct crypto_ret_worker *ret_worker; 1801 bool wake; 1802 1803 ret_worker = CRYPTO_RETW(crp->crp_retw_id); 1804 wake = false; 1805 1806 /* 1807 * Normal case; queue the callback for the thread. 1808 */ 1809 CRYPTO_RETW_LOCK(ret_worker); 1810 if (CRYPTOP_ASYNC_KEEPORDER(crp)) { 1811 struct cryptop *tmp; 1812 1813 TAILQ_FOREACH_REVERSE(tmp, &ret_worker->crp_ordered_ret_q, 1814 cryptop_q, crp_next) { 1815 if (CRYPTO_SEQ_GT(crp->crp_seq, tmp->crp_seq)) { 1816 TAILQ_INSERT_AFTER(&ret_worker->crp_ordered_ret_q, 1817 tmp, crp, crp_next); 1818 break; 1819 } 1820 } 1821 if (tmp == NULL) { 1822 TAILQ_INSERT_HEAD(&ret_worker->crp_ordered_ret_q, 1823 crp, crp_next); 1824 } 1825 1826 if (crp->crp_seq == ret_worker->reorder_cur_seq) 1827 wake = true; 1828 } 1829 else { 1830 if (CRYPTO_RETW_EMPTY(ret_worker)) 1831 wake = true; 1832 1833 TAILQ_INSERT_TAIL(&ret_worker->crp_ret_q, crp, crp_next); 1834 } 1835 1836 if (wake) 1837 wakeup_one(&ret_worker->crp_ret_q); /* shared wait channel */ 1838 CRYPTO_RETW_UNLOCK(ret_worker); 1839 } 1840 } 1841 1842 /* 1843 * Invoke the callback on behalf of the driver. 1844 */ 1845 void 1846 crypto_kdone(struct cryptkop *krp) 1847 { 1848 struct crypto_ret_worker *ret_worker; 1849 struct cryptocap *cap; 1850 1851 if (krp->krp_status != 0) 1852 cryptostats.cs_kerrs++; 1853 CRYPTO_DRIVER_LOCK(); 1854 cap = krp->krp_cap; 1855 KASSERT(cap->cc_koperations > 0, ("cc_koperations == 0")); 1856 cap->cc_koperations--; 1857 if (cap->cc_koperations == 0 && cap->cc_flags & CRYPTOCAP_F_CLEANUP) 1858 wakeup(cap); 1859 CRYPTO_DRIVER_UNLOCK(); 1860 krp->krp_cap = NULL; 1861 cap_rele(cap); 1862 1863 ret_worker = CRYPTO_RETW(0); 1864 1865 CRYPTO_RETW_LOCK(ret_worker); 1866 if (CRYPTO_RETW_EMPTY(ret_worker)) 1867 wakeup_one(&ret_worker->crp_ret_q); /* shared wait channel */ 1868 TAILQ_INSERT_TAIL(&ret_worker->crp_ret_kq, krp, krp_next); 1869 CRYPTO_RETW_UNLOCK(ret_worker); 1870 } 1871 1872 int 1873 crypto_getfeat(int *featp) 1874 { 1875 int hid, kalg, feat = 0; 1876 1877 CRYPTO_DRIVER_LOCK(); 1878 for (hid = 0; hid < crypto_drivers_size; hid++) { 1879 const struct cryptocap *cap = crypto_drivers[hid]; 1880 1881 if (cap == NULL || 1882 ((cap->cc_flags & CRYPTOCAP_F_SOFTWARE) && 1883 !crypto_devallowsoft)) { 1884 continue; 1885 } 1886 for (kalg = 0; kalg < CRK_ALGORITHM_MAX; kalg++) 1887 if (cap->cc_kalg[kalg] & CRYPTO_ALG_FLAG_SUPPORTED) 1888 feat |= 1 << kalg; 1889 } 1890 CRYPTO_DRIVER_UNLOCK(); 1891 *featp = feat; 1892 return (0); 1893 } 1894 1895 /* 1896 * Terminate a thread at module unload. The process that 1897 * initiated this is waiting for us to signal that we're gone; 1898 * wake it up and exit. We use the driver table lock to insure 1899 * we don't do the wakeup before they're waiting. There is no 1900 * race here because the waiter sleeps on the proc lock for the 1901 * thread so it gets notified at the right time because of an 1902 * extra wakeup that's done in exit1(). 1903 */ 1904 static void 1905 crypto_finis(void *chan) 1906 { 1907 CRYPTO_DRIVER_LOCK(); 1908 wakeup_one(chan); 1909 CRYPTO_DRIVER_UNLOCK(); 1910 kproc_exit(0); 1911 } 1912 1913 /* 1914 * Crypto thread, dispatches crypto requests. 1915 */ 1916 static void 1917 crypto_proc(void) 1918 { 1919 struct cryptop *crp, *submit; 1920 struct cryptkop *krp; 1921 struct cryptocap *cap; 1922 int result, hint; 1923 1924 #if defined(__i386__) || defined(__amd64__) || defined(__aarch64__) 1925 fpu_kern_thread(FPU_KERN_NORMAL); 1926 #endif 1927 1928 CRYPTO_Q_LOCK(); 1929 for (;;) { 1930 /* 1931 * Find the first element in the queue that can be 1932 * processed and look-ahead to see if multiple ops 1933 * are ready for the same driver. 1934 */ 1935 submit = NULL; 1936 hint = 0; 1937 TAILQ_FOREACH(crp, &crp_q, crp_next) { 1938 cap = crp->crp_session->cap; 1939 /* 1940 * Driver cannot disappeared when there is an active 1941 * session. 1942 */ 1943 KASSERT(cap != NULL, ("%s:%u Driver disappeared.", 1944 __func__, __LINE__)); 1945 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) { 1946 /* Op needs to be migrated, process it. */ 1947 if (submit == NULL) 1948 submit = crp; 1949 break; 1950 } 1951 if (!cap->cc_qblocked) { 1952 if (submit != NULL) { 1953 /* 1954 * We stop on finding another op, 1955 * regardless whether its for the same 1956 * driver or not. We could keep 1957 * searching the queue but it might be 1958 * better to just use a per-driver 1959 * queue instead. 1960 */ 1961 if (submit->crp_session->cap == cap) 1962 hint = CRYPTO_HINT_MORE; 1963 break; 1964 } else { 1965 submit = crp; 1966 if ((submit->crp_flags & CRYPTO_F_BATCH) == 0) 1967 break; 1968 /* keep scanning for more are q'd */ 1969 } 1970 } 1971 } 1972 if (submit != NULL) { 1973 TAILQ_REMOVE(&crp_q, submit, crp_next); 1974 cap = submit->crp_session->cap; 1975 KASSERT(cap != NULL, ("%s:%u Driver disappeared.", 1976 __func__, __LINE__)); 1977 CRYPTO_Q_UNLOCK(); 1978 result = crypto_invoke(cap, submit, hint); 1979 CRYPTO_Q_LOCK(); 1980 if (result == ERESTART) { 1981 /* 1982 * The driver ran out of resources, mark the 1983 * driver ``blocked'' for cryptop's and put 1984 * the request back in the queue. It would 1985 * best to put the request back where we got 1986 * it but that's hard so for now we put it 1987 * at the front. This should be ok; putting 1988 * it at the end does not work. 1989 */ 1990 cap->cc_qblocked = 1; 1991 TAILQ_INSERT_HEAD(&crp_q, submit, crp_next); 1992 cryptostats.cs_blocks++; 1993 } 1994 } 1995 1996 /* As above, but for key ops */ 1997 TAILQ_FOREACH(krp, &crp_kq, krp_next) { 1998 cap = krp->krp_cap; 1999 if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) { 2000 /* 2001 * Operation needs to be migrated, 2002 * clear krp_cap so a new driver is 2003 * selected. 2004 */ 2005 krp->krp_cap = NULL; 2006 cap_rele(cap); 2007 break; 2008 } 2009 if (!cap->cc_kqblocked) 2010 break; 2011 } 2012 if (krp != NULL) { 2013 TAILQ_REMOVE(&crp_kq, krp, krp_next); 2014 CRYPTO_Q_UNLOCK(); 2015 result = crypto_kinvoke(krp); 2016 CRYPTO_Q_LOCK(); 2017 if (result == ERESTART) { 2018 /* 2019 * The driver ran out of resources, mark the 2020 * driver ``blocked'' for cryptkop's and put 2021 * the request back in the queue. It would 2022 * best to put the request back where we got 2023 * it but that's hard so for now we put it 2024 * at the front. This should be ok; putting 2025 * it at the end does not work. 2026 */ 2027 krp->krp_cap->cc_kqblocked = 1; 2028 TAILQ_INSERT_HEAD(&crp_kq, krp, krp_next); 2029 cryptostats.cs_kblocks++; 2030 } 2031 } 2032 2033 if (submit == NULL && krp == NULL) { 2034 /* 2035 * Nothing more to be processed. Sleep until we're 2036 * woken because there are more ops to process. 2037 * This happens either by submission or by a driver 2038 * becoming unblocked and notifying us through 2039 * crypto_unblock. Note that when we wakeup we 2040 * start processing each queue again from the 2041 * front. It's not clear that it's important to 2042 * preserve this ordering since ops may finish 2043 * out of order if dispatched to different devices 2044 * and some become blocked while others do not. 2045 */ 2046 crp_sleep = 1; 2047 msleep(&crp_q, &crypto_q_mtx, PWAIT, "crypto_wait", 0); 2048 crp_sleep = 0; 2049 if (cryptoproc == NULL) 2050 break; 2051 cryptostats.cs_intrs++; 2052 } 2053 } 2054 CRYPTO_Q_UNLOCK(); 2055 2056 crypto_finis(&crp_q); 2057 } 2058 2059 /* 2060 * Crypto returns thread, does callbacks for processed crypto requests. 2061 * Callbacks are done here, rather than in the crypto drivers, because 2062 * callbacks typically are expensive and would slow interrupt handling. 2063 */ 2064 static void 2065 crypto_ret_proc(struct crypto_ret_worker *ret_worker) 2066 { 2067 struct cryptop *crpt; 2068 struct cryptkop *krpt; 2069 2070 CRYPTO_RETW_LOCK(ret_worker); 2071 for (;;) { 2072 /* Harvest return q's for completed ops */ 2073 crpt = TAILQ_FIRST(&ret_worker->crp_ordered_ret_q); 2074 if (crpt != NULL) { 2075 if (crpt->crp_seq == ret_worker->reorder_cur_seq) { 2076 TAILQ_REMOVE(&ret_worker->crp_ordered_ret_q, crpt, crp_next); 2077 ret_worker->reorder_cur_seq++; 2078 } else { 2079 crpt = NULL; 2080 } 2081 } 2082 2083 if (crpt == NULL) { 2084 crpt = TAILQ_FIRST(&ret_worker->crp_ret_q); 2085 if (crpt != NULL) 2086 TAILQ_REMOVE(&ret_worker->crp_ret_q, crpt, crp_next); 2087 } 2088 2089 krpt = TAILQ_FIRST(&ret_worker->crp_ret_kq); 2090 if (krpt != NULL) 2091 TAILQ_REMOVE(&ret_worker->crp_ret_kq, krpt, krp_next); 2092 2093 if (crpt != NULL || krpt != NULL) { 2094 CRYPTO_RETW_UNLOCK(ret_worker); 2095 /* 2096 * Run callbacks unlocked. 2097 */ 2098 if (crpt != NULL) { 2099 #ifdef CRYPTO_TIMING 2100 if (crypto_timing) { 2101 /* 2102 * NB: We must copy the timestamp before 2103 * doing the callback as the cryptop is 2104 * likely to be reclaimed. 2105 */ 2106 struct bintime t = crpt->crp_tstamp; 2107 crypto_tstat(&cryptostats.cs_cb, &t); 2108 crpt->crp_callback(crpt); 2109 crypto_tstat(&cryptostats.cs_finis, &t); 2110 } else 2111 #endif 2112 crpt->crp_callback(crpt); 2113 } 2114 if (krpt != NULL) 2115 krpt->krp_callback(krpt); 2116 CRYPTO_RETW_LOCK(ret_worker); 2117 } else { 2118 /* 2119 * Nothing more to be processed. Sleep until we're 2120 * woken because there are more returns to process. 2121 */ 2122 msleep(&ret_worker->crp_ret_q, &ret_worker->crypto_ret_mtx, PWAIT, 2123 "crypto_ret_wait", 0); 2124 if (ret_worker->cryptoretproc == NULL) 2125 break; 2126 cryptostats.cs_rets++; 2127 } 2128 } 2129 CRYPTO_RETW_UNLOCK(ret_worker); 2130 2131 crypto_finis(&ret_worker->crp_ret_q); 2132 } 2133 2134 #ifdef DDB 2135 static void 2136 db_show_drivers(void) 2137 { 2138 int hid; 2139 2140 db_printf("%12s %4s %4s %8s %2s %2s\n" 2141 , "Device" 2142 , "Ses" 2143 , "Kops" 2144 , "Flags" 2145 , "QB" 2146 , "KB" 2147 ); 2148 for (hid = 0; hid < crypto_drivers_size; hid++) { 2149 const struct cryptocap *cap = crypto_drivers[hid]; 2150 if (cap == NULL) 2151 continue; 2152 db_printf("%-12s %4u %4u %08x %2u %2u\n" 2153 , device_get_nameunit(cap->cc_dev) 2154 , cap->cc_sessions 2155 , cap->cc_koperations 2156 , cap->cc_flags 2157 , cap->cc_qblocked 2158 , cap->cc_kqblocked 2159 ); 2160 } 2161 } 2162 2163 DB_SHOW_COMMAND(crypto, db_show_crypto) 2164 { 2165 struct cryptop *crp; 2166 struct crypto_ret_worker *ret_worker; 2167 2168 db_show_drivers(); 2169 db_printf("\n"); 2170 2171 db_printf("%4s %8s %4s %4s %4s %4s %8s %8s\n", 2172 "HID", "Caps", "Ilen", "Olen", "Etype", "Flags", 2173 "Device", "Callback"); 2174 TAILQ_FOREACH(crp, &crp_q, crp_next) { 2175 db_printf("%4u %08x %4u %4u %4u %04x %8p %8p\n" 2176 , crp->crp_session->cap->cc_hid 2177 , (int) crypto_ses2caps(crp->crp_session) 2178 , crp->crp_ilen, crp->crp_olen 2179 , crp->crp_etype 2180 , crp->crp_flags 2181 , device_get_nameunit(crp->crp_session->cap->cc_dev) 2182 , crp->crp_callback 2183 ); 2184 } 2185 FOREACH_CRYPTO_RETW(ret_worker) { 2186 db_printf("\n%8s %4s %4s %4s %8s\n", 2187 "ret_worker", "HID", "Etype", "Flags", "Callback"); 2188 if (!TAILQ_EMPTY(&ret_worker->crp_ret_q)) { 2189 TAILQ_FOREACH(crp, &ret_worker->crp_ret_q, crp_next) { 2190 db_printf("%8td %4u %4u %04x %8p\n" 2191 , CRYPTO_RETW_ID(ret_worker) 2192 , crp->crp_session->cap->cc_hid 2193 , crp->crp_etype 2194 , crp->crp_flags 2195 , crp->crp_callback 2196 ); 2197 } 2198 } 2199 } 2200 } 2201 2202 DB_SHOW_COMMAND(kcrypto, db_show_kcrypto) 2203 { 2204 struct cryptkop *krp; 2205 struct crypto_ret_worker *ret_worker; 2206 2207 db_show_drivers(); 2208 db_printf("\n"); 2209 2210 db_printf("%4s %5s %4s %4s %8s %4s %8s\n", 2211 "Op", "Status", "#IP", "#OP", "CRID", "HID", "Callback"); 2212 TAILQ_FOREACH(krp, &crp_kq, krp_next) { 2213 db_printf("%4u %5u %4u %4u %08x %4u %8p\n" 2214 , krp->krp_op 2215 , krp->krp_status 2216 , krp->krp_iparams, krp->krp_oparams 2217 , krp->krp_crid, krp->krp_hid 2218 , krp->krp_callback 2219 ); 2220 } 2221 2222 ret_worker = CRYPTO_RETW(0); 2223 if (!TAILQ_EMPTY(&ret_worker->crp_ret_q)) { 2224 db_printf("%4s %5s %8s %4s %8s\n", 2225 "Op", "Status", "CRID", "HID", "Callback"); 2226 TAILQ_FOREACH(krp, &ret_worker->crp_ret_kq, krp_next) { 2227 db_printf("%4u %5u %08x %4u %8p\n" 2228 , krp->krp_op 2229 , krp->krp_status 2230 , krp->krp_crid, krp->krp_hid 2231 , krp->krp_callback 2232 ); 2233 } 2234 } 2235 } 2236 #endif 2237 2238 int crypto_modevent(module_t mod, int type, void *unused); 2239 2240 /* 2241 * Initialization code, both for static and dynamic loading. 2242 * Note this is not invoked with the usual MODULE_DECLARE 2243 * mechanism but instead is listed as a dependency by the 2244 * cryptosoft driver. This guarantees proper ordering of 2245 * calls on module load/unload. 2246 */ 2247 int 2248 crypto_modevent(module_t mod, int type, void *unused) 2249 { 2250 int error = EINVAL; 2251 2252 switch (type) { 2253 case MOD_LOAD: 2254 error = crypto_init(); 2255 if (error == 0 && bootverbose) 2256 printf("crypto: <crypto core>\n"); 2257 break; 2258 case MOD_UNLOAD: 2259 /*XXX disallow if active sessions */ 2260 error = 0; 2261 crypto_destroy(); 2262 return 0; 2263 } 2264 return error; 2265 } 2266 MODULE_VERSION(crypto, 1); 2267 MODULE_DEPEND(crypto, zlib, 1, 1, 1); 2268