1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2005-2019 Pawel Jakub Dawidek <pawel@dawidek.net> 5 * All rights reserved. 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 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/systm.h> 34 #include <sys/cons.h> 35 #include <sys/kernel.h> 36 #include <sys/linker.h> 37 #include <sys/module.h> 38 #include <sys/lock.h> 39 #include <sys/mutex.h> 40 #include <sys/bio.h> 41 #include <sys/sbuf.h> 42 #include <sys/sysctl.h> 43 #include <sys/malloc.h> 44 #include <sys/eventhandler.h> 45 #include <sys/kthread.h> 46 #include <sys/proc.h> 47 #include <sys/sched.h> 48 #include <sys/smp.h> 49 #include <sys/uio.h> 50 #include <sys/vnode.h> 51 52 #include <machine/vmparam.h> 53 54 #include <vm/uma.h> 55 56 #include <geom/geom.h> 57 #include <geom/geom_dbg.h> 58 #include <geom/eli/g_eli.h> 59 #include <geom/eli/pkcs5v2.h> 60 61 #include <crypto/intake.h> 62 63 FEATURE(geom_eli, "GEOM crypto module"); 64 65 MALLOC_DEFINE(M_ELI, "eli data", "GEOM_ELI Data"); 66 67 SYSCTL_DECL(_kern_geom); 68 SYSCTL_NODE(_kern_geom, OID_AUTO, eli, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 69 "GEOM_ELI stuff"); 70 static int g_eli_version = G_ELI_VERSION; 71 SYSCTL_INT(_kern_geom_eli, OID_AUTO, version, CTLFLAG_RD, &g_eli_version, 0, 72 "GELI version"); 73 int g_eli_debug = 0; 74 SYSCTL_INT(_kern_geom_eli, OID_AUTO, debug, CTLFLAG_RWTUN, &g_eli_debug, 0, 75 "Debug level"); 76 static u_int g_eli_tries = 3; 77 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, tries, CTLFLAG_RWTUN, &g_eli_tries, 0, 78 "Number of tries for entering the passphrase"); 79 static u_int g_eli_visible_passphrase = GETS_NOECHO; 80 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, visible_passphrase, CTLFLAG_RWTUN, 81 &g_eli_visible_passphrase, 0, 82 "Visibility of passphrase prompt (0 = invisible, 1 = visible, 2 = asterisk)"); 83 u_int g_eli_overwrites = G_ELI_OVERWRITES; 84 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, overwrites, CTLFLAG_RWTUN, &g_eli_overwrites, 85 0, "Number of times on-disk keys should be overwritten when destroying them"); 86 static u_int g_eli_threads = 0; 87 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, threads, CTLFLAG_RWTUN, &g_eli_threads, 0, 88 "Number of threads doing crypto work"); 89 u_int g_eli_batch = 0; 90 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, batch, CTLFLAG_RWTUN, &g_eli_batch, 0, 91 "Use crypto operations batching"); 92 93 /* 94 * Passphrase cached during boot, in order to be more user-friendly if 95 * there are multiple providers using the same passphrase. 96 */ 97 static char cached_passphrase[256]; 98 static u_int g_eli_boot_passcache = 1; 99 TUNABLE_INT("kern.geom.eli.boot_passcache", &g_eli_boot_passcache); 100 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, boot_passcache, CTLFLAG_RD, 101 &g_eli_boot_passcache, 0, 102 "Passphrases are cached during boot process for possible reuse"); 103 static void 104 fetch_loader_passphrase(void * dummy) 105 { 106 char * env_passphrase; 107 108 KASSERT(dynamic_kenv, ("need dynamic kenv")); 109 110 if ((env_passphrase = kern_getenv("kern.geom.eli.passphrase")) != NULL) { 111 /* Extract passphrase from the environment. */ 112 strlcpy(cached_passphrase, env_passphrase, 113 sizeof(cached_passphrase)); 114 freeenv(env_passphrase); 115 116 /* Wipe the passphrase from the environment. */ 117 kern_unsetenv("kern.geom.eli.passphrase"); 118 } 119 } 120 SYSINIT(geli_fetch_loader_passphrase, SI_SUB_KMEM + 1, SI_ORDER_ANY, 121 fetch_loader_passphrase, NULL); 122 123 static void 124 zero_boot_passcache(void) 125 { 126 127 explicit_bzero(cached_passphrase, sizeof(cached_passphrase)); 128 } 129 130 static void 131 zero_geli_intake_keys(void) 132 { 133 struct keybuf *keybuf; 134 int i; 135 136 if ((keybuf = get_keybuf()) != NULL) { 137 /* Scan the key buffer, clear all GELI keys. */ 138 for (i = 0; i < keybuf->kb_nents; i++) { 139 if (keybuf->kb_ents[i].ke_type == KEYBUF_TYPE_GELI) { 140 explicit_bzero(keybuf->kb_ents[i].ke_data, 141 sizeof(keybuf->kb_ents[i].ke_data)); 142 keybuf->kb_ents[i].ke_type = KEYBUF_TYPE_NONE; 143 } 144 } 145 } 146 } 147 148 static void 149 zero_intake_passcache(void *dummy) 150 { 151 zero_boot_passcache(); 152 zero_geli_intake_keys(); 153 } 154 EVENTHANDLER_DEFINE(mountroot, zero_intake_passcache, NULL, 0); 155 156 static eventhandler_tag g_eli_pre_sync = NULL; 157 158 static int g_eli_read_metadata_offset(struct g_class *mp, struct g_provider *pp, 159 off_t offset, struct g_eli_metadata *md); 160 161 static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp, 162 struct g_geom *gp); 163 static void g_eli_init(struct g_class *mp); 164 static void g_eli_fini(struct g_class *mp); 165 166 static g_taste_t g_eli_taste; 167 static g_dumpconf_t g_eli_dumpconf; 168 169 struct g_class g_eli_class = { 170 .name = G_ELI_CLASS_NAME, 171 .version = G_VERSION, 172 .ctlreq = g_eli_config, 173 .taste = g_eli_taste, 174 .destroy_geom = g_eli_destroy_geom, 175 .init = g_eli_init, 176 .fini = g_eli_fini 177 }; 178 179 /* 180 * Code paths: 181 * BIO_READ: 182 * g_eli_start -> g_eli_crypto_read -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver 183 * BIO_WRITE: 184 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver 185 */ 186 187 /* 188 * EAGAIN from crypto(9) means, that we were probably balanced to another crypto 189 * accelerator or something like this. 190 * The function updates the SID and rerun the operation. 191 */ 192 int 193 g_eli_crypto_rerun(struct cryptop *crp) 194 { 195 struct g_eli_softc *sc; 196 struct g_eli_worker *wr; 197 struct bio *bp; 198 int error; 199 200 bp = (struct bio *)crp->crp_opaque; 201 sc = bp->bio_to->geom->softc; 202 LIST_FOREACH(wr, &sc->sc_workers, w_next) { 203 if (wr->w_number == bp->bio_pflags) 204 break; 205 } 206 KASSERT(wr != NULL, ("Invalid worker (%u).", bp->bio_pflags)); 207 G_ELI_DEBUG(1, "Rerunning crypto %s request (sid: %p -> %p).", 208 bp->bio_cmd == BIO_READ ? "READ" : "WRITE", wr->w_sid, 209 crp->crp_session); 210 wr->w_sid = crp->crp_session; 211 crp->crp_etype = 0; 212 error = crypto_dispatch(crp); 213 if (error == 0) 214 return (0); 215 G_ELI_DEBUG(1, "%s: crypto_dispatch() returned %d.", __func__, error); 216 crp->crp_etype = error; 217 return (error); 218 } 219 220 static void 221 g_eli_getattr_done(struct bio *bp) 222 { 223 if (bp->bio_error == 0 && 224 !strcmp(bp->bio_attribute, "GEOM::physpath")) { 225 strlcat(bp->bio_data, "/eli", bp->bio_length); 226 } 227 g_std_done(bp); 228 } 229 230 /* 231 * The function is called afer reading encrypted data from the provider. 232 * 233 * g_eli_start -> g_eli_crypto_read -> g_io_request -> G_ELI_READ_DONE -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver 234 */ 235 void 236 g_eli_read_done(struct bio *bp) 237 { 238 struct g_eli_softc *sc; 239 struct bio *pbp; 240 241 G_ELI_LOGREQ(2, bp, "Request done."); 242 pbp = bp->bio_parent; 243 if (pbp->bio_error == 0 && bp->bio_error != 0) 244 pbp->bio_error = bp->bio_error; 245 g_destroy_bio(bp); 246 /* 247 * Do we have all sectors already? 248 */ 249 pbp->bio_inbed++; 250 if (pbp->bio_inbed < pbp->bio_children) 251 return; 252 sc = pbp->bio_to->geom->softc; 253 if (pbp->bio_error != 0) { 254 G_ELI_LOGREQ(0, pbp, "%s() failed (error=%d)", __func__, 255 pbp->bio_error); 256 pbp->bio_completed = 0; 257 if (pbp->bio_driver2 != NULL) { 258 free(pbp->bio_driver2, M_ELI); 259 pbp->bio_driver2 = NULL; 260 } 261 g_io_deliver(pbp, pbp->bio_error); 262 if (sc != NULL) 263 atomic_subtract_int(&sc->sc_inflight, 1); 264 return; 265 } 266 mtx_lock(&sc->sc_queue_mtx); 267 bioq_insert_tail(&sc->sc_queue, pbp); 268 mtx_unlock(&sc->sc_queue_mtx); 269 wakeup(sc); 270 } 271 272 /* 273 * The function is called after we encrypt and write data. 274 * 275 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> G_ELI_WRITE_DONE -> g_io_deliver 276 */ 277 void 278 g_eli_write_done(struct bio *bp) 279 { 280 struct g_eli_softc *sc; 281 struct bio *pbp; 282 283 G_ELI_LOGREQ(2, bp, "Request done."); 284 pbp = bp->bio_parent; 285 if (pbp->bio_error == 0 && bp->bio_error != 0) 286 pbp->bio_error = bp->bio_error; 287 g_destroy_bio(bp); 288 /* 289 * Do we have all sectors already? 290 */ 291 pbp->bio_inbed++; 292 if (pbp->bio_inbed < pbp->bio_children) 293 return; 294 free(pbp->bio_driver2, M_ELI); 295 pbp->bio_driver2 = NULL; 296 if (pbp->bio_error != 0) { 297 G_ELI_LOGREQ(0, pbp, "%s() failed (error=%d)", __func__, 298 pbp->bio_error); 299 pbp->bio_completed = 0; 300 } else 301 pbp->bio_completed = pbp->bio_length; 302 303 /* 304 * Write is finished, send it up. 305 */ 306 sc = pbp->bio_to->geom->softc; 307 g_io_deliver(pbp, pbp->bio_error); 308 if (sc != NULL) 309 atomic_subtract_int(&sc->sc_inflight, 1); 310 } 311 312 /* 313 * This function should never be called, but GEOM made as it set ->orphan() 314 * method for every geom. 315 */ 316 static void 317 g_eli_orphan_spoil_assert(struct g_consumer *cp) 318 { 319 320 panic("Function %s() called for %s.", __func__, cp->geom->name); 321 } 322 323 static void 324 g_eli_orphan(struct g_consumer *cp) 325 { 326 struct g_eli_softc *sc; 327 328 g_topology_assert(); 329 sc = cp->geom->softc; 330 if (sc == NULL) 331 return; 332 g_eli_destroy(sc, TRUE); 333 } 334 335 static void 336 g_eli_resize(struct g_consumer *cp) 337 { 338 struct g_eli_softc *sc; 339 struct g_provider *epp, *pp; 340 off_t oldsize; 341 342 g_topology_assert(); 343 sc = cp->geom->softc; 344 if (sc == NULL) 345 return; 346 347 if ((sc->sc_flags & G_ELI_FLAG_AUTORESIZE) == 0) { 348 G_ELI_DEBUG(0, "Autoresize is turned off, old size: %jd.", 349 (intmax_t)sc->sc_provsize); 350 return; 351 } 352 353 pp = cp->provider; 354 355 if ((sc->sc_flags & G_ELI_FLAG_ONETIME) == 0) { 356 struct g_eli_metadata md; 357 u_char *sector; 358 int error; 359 360 sector = NULL; 361 362 error = g_eli_read_metadata_offset(cp->geom->class, pp, 363 sc->sc_provsize - pp->sectorsize, &md); 364 if (error != 0) { 365 G_ELI_DEBUG(0, "Cannot read metadata from %s (error=%d).", 366 pp->name, error); 367 goto iofail; 368 } 369 370 md.md_provsize = pp->mediasize; 371 372 sector = malloc(pp->sectorsize, M_ELI, M_WAITOK | M_ZERO); 373 eli_metadata_encode(&md, sector); 374 error = g_write_data(cp, pp->mediasize - pp->sectorsize, sector, 375 pp->sectorsize); 376 if (error != 0) { 377 G_ELI_DEBUG(0, "Cannot store metadata on %s (error=%d).", 378 pp->name, error); 379 goto iofail; 380 } 381 explicit_bzero(sector, pp->sectorsize); 382 error = g_write_data(cp, sc->sc_provsize - pp->sectorsize, 383 sector, pp->sectorsize); 384 if (error != 0) { 385 G_ELI_DEBUG(0, "Cannot clear old metadata from %s (error=%d).", 386 pp->name, error); 387 goto iofail; 388 } 389 iofail: 390 explicit_bzero(&md, sizeof(md)); 391 zfree(sector, M_ELI); 392 } 393 394 oldsize = sc->sc_mediasize; 395 sc->sc_mediasize = eli_mediasize(sc, pp->mediasize, pp->sectorsize); 396 g_eli_key_resize(sc); 397 sc->sc_provsize = pp->mediasize; 398 399 epp = LIST_FIRST(&sc->sc_geom->provider); 400 g_resize_provider(epp, sc->sc_mediasize); 401 G_ELI_DEBUG(0, "Device %s size changed from %jd to %jd.", epp->name, 402 (intmax_t)oldsize, (intmax_t)sc->sc_mediasize); 403 } 404 405 /* 406 * BIO_READ: 407 * G_ELI_START -> g_eli_crypto_read -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver 408 * BIO_WRITE: 409 * G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver 410 */ 411 static void 412 g_eli_start(struct bio *bp) 413 { 414 struct g_eli_softc *sc; 415 struct g_consumer *cp; 416 struct bio *cbp; 417 418 sc = bp->bio_to->geom->softc; 419 KASSERT(sc != NULL, 420 ("Provider's error should be set (error=%d)(device=%s).", 421 bp->bio_to->error, bp->bio_to->name)); 422 G_ELI_LOGREQ(2, bp, "Request received."); 423 424 switch (bp->bio_cmd) { 425 case BIO_READ: 426 case BIO_WRITE: 427 case BIO_GETATTR: 428 case BIO_FLUSH: 429 case BIO_ZONE: 430 case BIO_SPEEDUP: 431 break; 432 case BIO_DELETE: 433 /* 434 * If the user hasn't set the NODELETE flag, we just pass 435 * it down the stack and let the layers beneath us do (or 436 * not) whatever they do with it. If they have, we 437 * reject it. A possible extension would be an 438 * additional flag to take it as a hint to shred the data 439 * with [multiple?] overwrites. 440 */ 441 if (!(sc->sc_flags & G_ELI_FLAG_NODELETE)) 442 break; 443 default: 444 g_io_deliver(bp, EOPNOTSUPP); 445 return; 446 } 447 cbp = g_clone_bio(bp); 448 if (cbp == NULL) { 449 g_io_deliver(bp, ENOMEM); 450 return; 451 } 452 bp->bio_driver1 = cbp; 453 bp->bio_pflags = G_ELI_NEW_BIO; 454 switch (bp->bio_cmd) { 455 case BIO_READ: 456 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) { 457 g_eli_crypto_read(sc, bp, 0); 458 break; 459 } 460 /* FALLTHROUGH */ 461 case BIO_WRITE: 462 mtx_lock(&sc->sc_queue_mtx); 463 bioq_insert_tail(&sc->sc_queue, bp); 464 mtx_unlock(&sc->sc_queue_mtx); 465 wakeup(sc); 466 break; 467 case BIO_GETATTR: 468 case BIO_FLUSH: 469 case BIO_DELETE: 470 case BIO_SPEEDUP: 471 case BIO_ZONE: 472 if (bp->bio_cmd == BIO_GETATTR) 473 cbp->bio_done = g_eli_getattr_done; 474 else 475 cbp->bio_done = g_std_done; 476 cp = LIST_FIRST(&sc->sc_geom->consumer); 477 cbp->bio_to = cp->provider; 478 G_ELI_LOGREQ(2, cbp, "Sending request."); 479 g_io_request(cbp, cp); 480 break; 481 } 482 } 483 484 static int 485 g_eli_newsession(struct g_eli_worker *wr) 486 { 487 struct g_eli_softc *sc; 488 struct crypto_session_params csp; 489 uint32_t caps; 490 int error, new_crypto; 491 void *key; 492 493 sc = wr->w_softc; 494 495 memset(&csp, 0, sizeof(csp)); 496 csp.csp_mode = CSP_MODE_CIPHER; 497 csp.csp_cipher_alg = sc->sc_ealgo; 498 csp.csp_ivlen = g_eli_ivlen(sc->sc_ealgo); 499 csp.csp_cipher_klen = sc->sc_ekeylen / 8; 500 if (sc->sc_ealgo == CRYPTO_AES_XTS) 501 csp.csp_cipher_klen <<= 1; 502 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0) { 503 key = g_eli_key_hold(sc, 0, 504 LIST_FIRST(&sc->sc_geom->consumer)->provider->sectorsize); 505 csp.csp_cipher_key = key; 506 } else { 507 key = NULL; 508 csp.csp_cipher_key = sc->sc_ekey; 509 } 510 if (sc->sc_flags & G_ELI_FLAG_AUTH) { 511 csp.csp_mode = CSP_MODE_ETA; 512 csp.csp_auth_alg = sc->sc_aalgo; 513 csp.csp_auth_klen = G_ELI_AUTH_SECKEYLEN; 514 } 515 516 switch (sc->sc_crypto) { 517 case G_ELI_CRYPTO_SW_ACCEL: 518 case G_ELI_CRYPTO_SW: 519 error = crypto_newsession(&wr->w_sid, &csp, 520 CRYPTOCAP_F_SOFTWARE); 521 break; 522 case G_ELI_CRYPTO_HW: 523 error = crypto_newsession(&wr->w_sid, &csp, 524 CRYPTOCAP_F_HARDWARE); 525 break; 526 case G_ELI_CRYPTO_UNKNOWN: 527 error = crypto_newsession(&wr->w_sid, &csp, 528 CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE); 529 if (error == 0) { 530 caps = crypto_ses2caps(wr->w_sid); 531 if (caps & CRYPTOCAP_F_HARDWARE) 532 new_crypto = G_ELI_CRYPTO_HW; 533 else if (caps & CRYPTOCAP_F_ACCEL_SOFTWARE) 534 new_crypto = G_ELI_CRYPTO_SW_ACCEL; 535 else 536 new_crypto = G_ELI_CRYPTO_SW; 537 mtx_lock(&sc->sc_queue_mtx); 538 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN) 539 sc->sc_crypto = new_crypto; 540 mtx_unlock(&sc->sc_queue_mtx); 541 } 542 break; 543 default: 544 panic("%s: invalid condition", __func__); 545 } 546 547 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0) { 548 if (error) 549 g_eli_key_drop(sc, key); 550 else 551 wr->w_first_key = key; 552 } 553 554 return (error); 555 } 556 557 static void 558 g_eli_freesession(struct g_eli_worker *wr) 559 { 560 struct g_eli_softc *sc; 561 562 crypto_freesession(wr->w_sid); 563 if (wr->w_first_key != NULL) { 564 sc = wr->w_softc; 565 g_eli_key_drop(sc, wr->w_first_key); 566 wr->w_first_key = NULL; 567 } 568 } 569 570 static void 571 g_eli_cancel(struct g_eli_softc *sc) 572 { 573 struct bio *bp; 574 575 mtx_assert(&sc->sc_queue_mtx, MA_OWNED); 576 577 while ((bp = bioq_takefirst(&sc->sc_queue)) != NULL) { 578 KASSERT(bp->bio_pflags == G_ELI_NEW_BIO, 579 ("Not new bio when canceling (bp=%p).", bp)); 580 g_io_deliver(bp, ENXIO); 581 } 582 } 583 584 static struct bio * 585 g_eli_takefirst(struct g_eli_softc *sc) 586 { 587 struct bio *bp; 588 589 mtx_assert(&sc->sc_queue_mtx, MA_OWNED); 590 591 if (!(sc->sc_flags & G_ELI_FLAG_SUSPEND)) 592 return (bioq_takefirst(&sc->sc_queue)); 593 /* 594 * Device suspended, so we skip new I/O requests. 595 */ 596 TAILQ_FOREACH(bp, &sc->sc_queue.queue, bio_queue) { 597 if (bp->bio_pflags != G_ELI_NEW_BIO) 598 break; 599 } 600 if (bp != NULL) 601 bioq_remove(&sc->sc_queue, bp); 602 return (bp); 603 } 604 605 /* 606 * This is the main function for kernel worker thread when we don't have 607 * hardware acceleration and we have to do cryptography in software. 608 * Dedicated thread is needed, so we don't slow down g_up/g_down GEOM 609 * threads with crypto work. 610 */ 611 static void 612 g_eli_worker(void *arg) 613 { 614 struct g_eli_softc *sc; 615 struct g_eli_worker *wr; 616 struct bio *bp; 617 int error; 618 619 wr = arg; 620 sc = wr->w_softc; 621 #ifdef EARLY_AP_STARTUP 622 MPASS(!sc->sc_cpubind || smp_started); 623 #elif defined(SMP) 624 /* Before sched_bind() to a CPU, wait for all CPUs to go on-line. */ 625 if (sc->sc_cpubind) { 626 while (!smp_started) 627 tsleep(wr, 0, "geli:smp", hz / 4); 628 } 629 #endif 630 thread_lock(curthread); 631 sched_prio(curthread, PUSER); 632 if (sc->sc_cpubind) 633 sched_bind(curthread, wr->w_number % mp_ncpus); 634 thread_unlock(curthread); 635 636 G_ELI_DEBUG(1, "Thread %s started.", curthread->td_proc->p_comm); 637 638 for (;;) { 639 mtx_lock(&sc->sc_queue_mtx); 640 again: 641 bp = g_eli_takefirst(sc); 642 if (bp == NULL) { 643 if (sc->sc_flags & G_ELI_FLAG_DESTROY) { 644 g_eli_cancel(sc); 645 LIST_REMOVE(wr, w_next); 646 g_eli_freesession(wr); 647 free(wr, M_ELI); 648 G_ELI_DEBUG(1, "Thread %s exiting.", 649 curthread->td_proc->p_comm); 650 wakeup(&sc->sc_workers); 651 mtx_unlock(&sc->sc_queue_mtx); 652 kproc_exit(0); 653 } 654 while (sc->sc_flags & G_ELI_FLAG_SUSPEND) { 655 if (sc->sc_inflight > 0) { 656 G_ELI_DEBUG(0, "inflight=%d", 657 sc->sc_inflight); 658 /* 659 * We still have inflight BIOs, so 660 * sleep and retry. 661 */ 662 msleep(sc, &sc->sc_queue_mtx, PRIBIO, 663 "geli:inf", hz / 5); 664 goto again; 665 } 666 /* 667 * Suspend requested, mark the worker as 668 * suspended and go to sleep. 669 */ 670 if (wr->w_active) { 671 g_eli_freesession(wr); 672 wr->w_active = FALSE; 673 } 674 wakeup(&sc->sc_workers); 675 msleep(sc, &sc->sc_queue_mtx, PRIBIO, 676 "geli:suspend", 0); 677 if (!wr->w_active && 678 !(sc->sc_flags & G_ELI_FLAG_SUSPEND)) { 679 error = g_eli_newsession(wr); 680 KASSERT(error == 0, 681 ("g_eli_newsession() failed on resume (error=%d)", 682 error)); 683 wr->w_active = TRUE; 684 } 685 goto again; 686 } 687 msleep(sc, &sc->sc_queue_mtx, PDROP, "geli:w", 0); 688 continue; 689 } 690 if (bp->bio_pflags == G_ELI_NEW_BIO) 691 atomic_add_int(&sc->sc_inflight, 1); 692 mtx_unlock(&sc->sc_queue_mtx); 693 if (bp->bio_pflags == G_ELI_NEW_BIO) { 694 bp->bio_pflags = 0; 695 if (sc->sc_flags & G_ELI_FLAG_AUTH) { 696 if (bp->bio_cmd == BIO_READ) 697 g_eli_auth_read(sc, bp); 698 else 699 g_eli_auth_run(wr, bp); 700 } else { 701 if (bp->bio_cmd == BIO_READ) 702 g_eli_crypto_read(sc, bp, 1); 703 else 704 g_eli_crypto_run(wr, bp); 705 } 706 } else { 707 if (sc->sc_flags & G_ELI_FLAG_AUTH) 708 g_eli_auth_run(wr, bp); 709 else 710 g_eli_crypto_run(wr, bp); 711 } 712 } 713 } 714 715 static int 716 g_eli_read_metadata_offset(struct g_class *mp, struct g_provider *pp, 717 off_t offset, struct g_eli_metadata *md) 718 { 719 struct g_geom *gp; 720 struct g_consumer *cp; 721 u_char *buf = NULL; 722 int error; 723 724 g_topology_assert(); 725 726 gp = g_new_geomf(mp, "eli:taste"); 727 gp->start = g_eli_start; 728 gp->access = g_std_access; 729 /* 730 * g_eli_read_metadata() is always called from the event thread. 731 * Our geom is created and destroyed in the same event, so there 732 * could be no orphan nor spoil event in the meantime. 733 */ 734 gp->orphan = g_eli_orphan_spoil_assert; 735 gp->spoiled = g_eli_orphan_spoil_assert; 736 cp = g_new_consumer(gp); 737 cp->flags |= G_CF_DIRECT_SEND | G_CF_DIRECT_RECEIVE; 738 error = g_attach(cp, pp); 739 if (error != 0) 740 goto end; 741 error = g_access(cp, 1, 0, 0); 742 if (error != 0) 743 goto end; 744 g_topology_unlock(); 745 buf = g_read_data(cp, offset, pp->sectorsize, &error); 746 g_topology_lock(); 747 if (buf == NULL) 748 goto end; 749 error = eli_metadata_decode(buf, md); 750 if (error != 0) 751 goto end; 752 /* Metadata was read and decoded successfully. */ 753 end: 754 if (buf != NULL) 755 g_free(buf); 756 if (cp->provider != NULL) { 757 if (cp->acr == 1) 758 g_access(cp, -1, 0, 0); 759 g_detach(cp); 760 } 761 g_destroy_consumer(cp); 762 g_destroy_geom(gp); 763 return (error); 764 } 765 766 int 767 g_eli_read_metadata(struct g_class *mp, struct g_provider *pp, 768 struct g_eli_metadata *md) 769 { 770 771 return (g_eli_read_metadata_offset(mp, pp, 772 pp->mediasize - pp->sectorsize, md)); 773 } 774 775 /* 776 * The function is called when we had last close on provider and user requested 777 * to close it when this situation occur. 778 */ 779 static void 780 g_eli_last_close(void *arg, int flags __unused) 781 { 782 struct g_geom *gp; 783 char gpname[64]; 784 int error; 785 786 g_topology_assert(); 787 gp = arg; 788 strlcpy(gpname, gp->name, sizeof(gpname)); 789 error = g_eli_destroy(gp->softc, TRUE); 790 KASSERT(error == 0, ("Cannot detach %s on last close (error=%d).", 791 gpname, error)); 792 G_ELI_DEBUG(0, "Detached %s on last close.", gpname); 793 } 794 795 int 796 g_eli_access(struct g_provider *pp, int dr, int dw, int de) 797 { 798 struct g_eli_softc *sc; 799 struct g_geom *gp; 800 801 gp = pp->geom; 802 sc = gp->softc; 803 804 if (dw > 0) { 805 if (sc->sc_flags & G_ELI_FLAG_RO) { 806 /* Deny write attempts. */ 807 return (EROFS); 808 } 809 /* Someone is opening us for write, we need to remember that. */ 810 sc->sc_flags |= G_ELI_FLAG_WOPEN; 811 return (0); 812 } 813 /* Is this the last close? */ 814 if (pp->acr + dr > 0 || pp->acw + dw > 0 || pp->ace + de > 0) 815 return (0); 816 817 /* 818 * Automatically detach on last close if requested. 819 */ 820 if ((sc->sc_flags & G_ELI_FLAG_RW_DETACH) || 821 (sc->sc_flags & G_ELI_FLAG_WOPEN)) { 822 g_post_event(g_eli_last_close, gp, M_WAITOK, NULL); 823 } 824 return (0); 825 } 826 827 static int 828 g_eli_cpu_is_disabled(int cpu) 829 { 830 #ifdef SMP 831 return (CPU_ISSET(cpu, &hlt_cpus_mask)); 832 #else 833 return (0); 834 #endif 835 } 836 837 struct g_geom * 838 g_eli_create(struct gctl_req *req, struct g_class *mp, struct g_provider *bpp, 839 const struct g_eli_metadata *md, const u_char *mkey, int nkey) 840 { 841 struct g_eli_softc *sc; 842 struct g_eli_worker *wr; 843 struct g_geom *gp; 844 struct g_provider *pp; 845 struct g_consumer *cp; 846 struct g_geom_alias *gap; 847 u_int i, threads; 848 int dcw, error; 849 850 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX); 851 KASSERT(eli_metadata_crypto_supported(md), 852 ("%s: unsupported crypto for %s", __func__, bpp->name)); 853 854 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX); 855 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO); 856 gp->start = g_eli_start; 857 /* 858 * Spoiling can happen even though we have the provider open 859 * exclusively, e.g. through media change events. 860 */ 861 gp->spoiled = g_eli_orphan; 862 gp->orphan = g_eli_orphan; 863 gp->resize = g_eli_resize; 864 gp->dumpconf = g_eli_dumpconf; 865 /* 866 * If detach-on-last-close feature is not enabled and we don't operate 867 * on read-only provider, we can simply use g_std_access(). 868 */ 869 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO)) 870 gp->access = g_eli_access; 871 else 872 gp->access = g_std_access; 873 874 eli_metadata_softc(sc, md, bpp->sectorsize, bpp->mediasize); 875 sc->sc_nkey = nkey; 876 877 gp->softc = sc; 878 sc->sc_geom = gp; 879 880 bioq_init(&sc->sc_queue); 881 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF); 882 mtx_init(&sc->sc_ekeys_lock, "geli:ekeys", NULL, MTX_DEF); 883 884 pp = NULL; 885 cp = g_new_consumer(gp); 886 cp->flags |= G_CF_DIRECT_SEND | G_CF_DIRECT_RECEIVE; 887 error = g_attach(cp, bpp); 888 if (error != 0) { 889 if (req != NULL) { 890 gctl_error(req, "Cannot attach to %s (error=%d).", 891 bpp->name, error); 892 } else { 893 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).", 894 bpp->name, error); 895 } 896 goto failed; 897 } 898 /* 899 * Keep provider open all the time, so we can run critical tasks, 900 * like Master Keys deletion, without wondering if we can open 901 * provider or not. 902 * We don't open provider for writing only when user requested read-only 903 * access. 904 */ 905 dcw = (sc->sc_flags & G_ELI_FLAG_RO) ? 0 : 1; 906 error = g_access(cp, 1, dcw, 1); 907 if (error != 0) { 908 if (req != NULL) { 909 gctl_error(req, "Cannot access %s (error=%d).", 910 bpp->name, error); 911 } else { 912 G_ELI_DEBUG(1, "Cannot access %s (error=%d).", 913 bpp->name, error); 914 } 915 goto failed; 916 } 917 918 /* 919 * Remember the keys in our softc structure. 920 */ 921 g_eli_mkey_propagate(sc, mkey); 922 923 LIST_INIT(&sc->sc_workers); 924 925 threads = g_eli_threads; 926 if (threads == 0) 927 threads = mp_ncpus; 928 sc->sc_cpubind = (mp_ncpus > 1 && threads == mp_ncpus); 929 for (i = 0; i < threads; i++) { 930 if (g_eli_cpu_is_disabled(i)) { 931 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.", 932 bpp->name, i); 933 continue; 934 } 935 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO); 936 wr->w_softc = sc; 937 wr->w_number = i; 938 wr->w_active = TRUE; 939 940 error = g_eli_newsession(wr); 941 if (error != 0) { 942 free(wr, M_ELI); 943 if (req != NULL) { 944 gctl_error(req, "Cannot set up crypto session " 945 "for %s (error=%d).", bpp->name, error); 946 } else { 947 G_ELI_DEBUG(1, "Cannot set up crypto session " 948 "for %s (error=%d).", bpp->name, error); 949 } 950 goto failed; 951 } 952 953 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0, 954 "g_eli[%u] %s", i, bpp->name); 955 if (error != 0) { 956 g_eli_freesession(wr); 957 free(wr, M_ELI); 958 if (req != NULL) { 959 gctl_error(req, "Cannot create kernel thread " 960 "for %s (error=%d).", bpp->name, error); 961 } else { 962 G_ELI_DEBUG(1, "Cannot create kernel thread " 963 "for %s (error=%d).", bpp->name, error); 964 } 965 goto failed; 966 } 967 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next); 968 } 969 970 /* 971 * Create decrypted provider. 972 */ 973 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX); 974 pp->flags |= G_PF_DIRECT_SEND | G_PF_DIRECT_RECEIVE; 975 if (CRYPTO_HAS_VMPAGE) { 976 /* 977 * On DMAP architectures we can use unmapped I/O. But don't 978 * use it with data integrity verification. That code hasn't 979 * been written yet. 980 */ 981 if ((sc->sc_flags & G_ELI_FLAG_AUTH) == 0) 982 pp->flags |= G_PF_ACCEPT_UNMAPPED; 983 } 984 pp->mediasize = sc->sc_mediasize; 985 pp->sectorsize = sc->sc_sectorsize; 986 LIST_FOREACH(gap, &bpp->aliases, ga_next) 987 g_provider_add_alias(pp, "%s%s", gap->ga_alias, G_ELI_SUFFIX); 988 989 g_error_provider(pp, 0); 990 991 G_ELI_DEBUG(0, "Device %s created.", pp->name); 992 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo), 993 sc->sc_ekeylen); 994 if (sc->sc_flags & G_ELI_FLAG_AUTH) 995 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo)); 996 G_ELI_DEBUG(0, " Crypto: %s", 997 sc->sc_crypto == G_ELI_CRYPTO_SW_ACCEL ? "accelerated software" : 998 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware"); 999 return (gp); 1000 failed: 1001 mtx_lock(&sc->sc_queue_mtx); 1002 sc->sc_flags |= G_ELI_FLAG_DESTROY; 1003 wakeup(sc); 1004 /* 1005 * Wait for kernel threads self destruction. 1006 */ 1007 while (!LIST_EMPTY(&sc->sc_workers)) { 1008 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO, 1009 "geli:destroy", 0); 1010 } 1011 mtx_destroy(&sc->sc_queue_mtx); 1012 if (cp->provider != NULL) { 1013 if (cp->acr == 1) 1014 g_access(cp, -1, -dcw, -1); 1015 g_detach(cp); 1016 } 1017 g_destroy_consumer(cp); 1018 g_destroy_geom(gp); 1019 g_eli_key_destroy(sc); 1020 zfree(sc, M_ELI); 1021 return (NULL); 1022 } 1023 1024 int 1025 g_eli_destroy(struct g_eli_softc *sc, boolean_t force) 1026 { 1027 struct g_geom *gp; 1028 struct g_provider *pp; 1029 1030 g_topology_assert(); 1031 1032 if (sc == NULL) 1033 return (ENXIO); 1034 1035 gp = sc->sc_geom; 1036 pp = LIST_FIRST(&gp->provider); 1037 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) { 1038 if (force) { 1039 G_ELI_DEBUG(1, "Device %s is still open, so it " 1040 "cannot be definitely removed.", pp->name); 1041 sc->sc_flags |= G_ELI_FLAG_RW_DETACH; 1042 gp->access = g_eli_access; 1043 g_wither_provider(pp, ENXIO); 1044 return (EBUSY); 1045 } else { 1046 G_ELI_DEBUG(1, 1047 "Device %s is still open (r%dw%de%d).", pp->name, 1048 pp->acr, pp->acw, pp->ace); 1049 return (EBUSY); 1050 } 1051 } 1052 1053 mtx_lock(&sc->sc_queue_mtx); 1054 sc->sc_flags |= G_ELI_FLAG_DESTROY; 1055 wakeup(sc); 1056 while (!LIST_EMPTY(&sc->sc_workers)) { 1057 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO, 1058 "geli:destroy", 0); 1059 } 1060 mtx_destroy(&sc->sc_queue_mtx); 1061 gp->softc = NULL; 1062 g_eli_key_destroy(sc); 1063 zfree(sc, M_ELI); 1064 1065 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name); 1066 g_wither_geom_close(gp, ENXIO); 1067 1068 return (0); 1069 } 1070 1071 static int 1072 g_eli_destroy_geom(struct gctl_req *req __unused, 1073 struct g_class *mp __unused, struct g_geom *gp) 1074 { 1075 struct g_eli_softc *sc; 1076 1077 sc = gp->softc; 1078 return (g_eli_destroy(sc, FALSE)); 1079 } 1080 1081 static int 1082 g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider) 1083 { 1084 u_char *keyfile, *data; 1085 char *file, name[64]; 1086 size_t size; 1087 int i; 1088 1089 for (i = 0; ; i++) { 1090 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i); 1091 keyfile = preload_search_by_type(name); 1092 if (keyfile == NULL && i == 0) { 1093 /* 1094 * If there is only one keyfile, allow simpler name. 1095 */ 1096 snprintf(name, sizeof(name), "%s:geli_keyfile", provider); 1097 keyfile = preload_search_by_type(name); 1098 } 1099 if (keyfile == NULL) 1100 return (i); /* Return number of loaded keyfiles. */ 1101 data = preload_fetch_addr(keyfile); 1102 if (data == NULL) { 1103 G_ELI_DEBUG(0, "Cannot find key file data for %s.", 1104 name); 1105 return (0); 1106 } 1107 size = preload_fetch_size(keyfile); 1108 if (size == 0) { 1109 G_ELI_DEBUG(0, "Cannot find key file size for %s.", 1110 name); 1111 return (0); 1112 } 1113 file = preload_search_info(keyfile, MODINFO_NAME); 1114 if (file == NULL) { 1115 G_ELI_DEBUG(0, "Cannot find key file name for %s.", 1116 name); 1117 return (0); 1118 } 1119 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file, 1120 provider, name); 1121 g_eli_crypto_hmac_update(ctx, data, size); 1122 } 1123 } 1124 1125 static void 1126 g_eli_keyfiles_clear(const char *provider) 1127 { 1128 u_char *keyfile, *data; 1129 char name[64]; 1130 size_t size; 1131 int i; 1132 1133 for (i = 0; ; i++) { 1134 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i); 1135 keyfile = preload_search_by_type(name); 1136 if (keyfile == NULL) 1137 return; 1138 data = preload_fetch_addr(keyfile); 1139 size = preload_fetch_size(keyfile); 1140 if (data != NULL && size != 0) 1141 explicit_bzero(data, size); 1142 } 1143 } 1144 1145 /* 1146 * Tasting is only made on boot. 1147 * We detect providers which should be attached before root is mounted. 1148 */ 1149 static struct g_geom * 1150 g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused) 1151 { 1152 struct g_eli_metadata md; 1153 struct g_geom *gp; 1154 struct hmac_ctx ctx; 1155 char passphrase[256]; 1156 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN]; 1157 u_int i, nkey, nkeyfiles, tries, showpass; 1158 int error; 1159 struct keybuf *keybuf; 1160 1161 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name); 1162 g_topology_assert(); 1163 1164 if (root_mounted() || g_eli_tries == 0) 1165 return (NULL); 1166 1167 G_ELI_DEBUG(3, "Tasting %s.", pp->name); 1168 1169 error = g_eli_read_metadata(mp, pp, &md); 1170 if (error != 0) 1171 return (NULL); 1172 gp = NULL; 1173 1174 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0) 1175 return (NULL); 1176 if (md.md_version > G_ELI_VERSION) { 1177 printf("geom_eli.ko module is too old to handle %s.\n", 1178 pp->name); 1179 return (NULL); 1180 } 1181 if (md.md_provsize != pp->mediasize) 1182 return (NULL); 1183 /* Should we attach it on boot? */ 1184 if (!(md.md_flags & G_ELI_FLAG_BOOT) && 1185 !(md.md_flags & G_ELI_FLAG_GELIBOOT)) 1186 return (NULL); 1187 if (md.md_keys == 0x00) { 1188 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name); 1189 return (NULL); 1190 } 1191 if (!eli_metadata_crypto_supported(&md)) { 1192 G_ELI_DEBUG(0, "%s uses invalid or unsupported algorithms\n", 1193 pp->name); 1194 return (NULL); 1195 } 1196 if (md.md_iterations == -1) { 1197 /* If there is no passphrase, we try only once. */ 1198 tries = 1; 1199 } else { 1200 /* Ask for the passphrase no more than g_eli_tries times. */ 1201 tries = g_eli_tries; 1202 } 1203 1204 if ((keybuf = get_keybuf()) != NULL) { 1205 /* Scan the key buffer, try all GELI keys. */ 1206 for (i = 0; i < keybuf->kb_nents; i++) { 1207 if (keybuf->kb_ents[i].ke_type == KEYBUF_TYPE_GELI) { 1208 memcpy(key, keybuf->kb_ents[i].ke_data, 1209 sizeof(key)); 1210 1211 if (g_eli_mkey_decrypt_any(&md, key, 1212 mkey, &nkey) == 0 ) { 1213 explicit_bzero(key, sizeof(key)); 1214 goto have_key; 1215 } 1216 } 1217 } 1218 } 1219 1220 for (i = 0; i <= tries; i++) { 1221 g_eli_crypto_hmac_init(&ctx, NULL, 0); 1222 1223 /* 1224 * Load all key files. 1225 */ 1226 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name); 1227 1228 if (nkeyfiles == 0 && md.md_iterations == -1) { 1229 /* 1230 * No key files and no passphrase, something is 1231 * definitely wrong here. 1232 * geli(8) doesn't allow for such situation, so assume 1233 * that there was really no passphrase and in that case 1234 * key files are no properly defined in loader.conf. 1235 */ 1236 G_ELI_DEBUG(0, 1237 "Found no key files in loader.conf for %s.", 1238 pp->name); 1239 return (NULL); 1240 } 1241 1242 /* Ask for the passphrase if defined. */ 1243 if (md.md_iterations >= 0) { 1244 /* Try first with cached passphrase. */ 1245 if (i == 0) { 1246 if (!g_eli_boot_passcache) 1247 continue; 1248 memcpy(passphrase, cached_passphrase, 1249 sizeof(passphrase)); 1250 } else { 1251 printf("Enter passphrase for %s: ", pp->name); 1252 showpass = g_eli_visible_passphrase; 1253 if ((md.md_flags & G_ELI_FLAG_GELIDISPLAYPASS) != 0) 1254 showpass = GETS_ECHOPASS; 1255 cngets(passphrase, sizeof(passphrase), 1256 showpass); 1257 memcpy(cached_passphrase, passphrase, 1258 sizeof(passphrase)); 1259 } 1260 } 1261 1262 /* 1263 * Prepare Derived-Key from the user passphrase. 1264 */ 1265 if (md.md_iterations == 0) { 1266 g_eli_crypto_hmac_update(&ctx, md.md_salt, 1267 sizeof(md.md_salt)); 1268 g_eli_crypto_hmac_update(&ctx, passphrase, 1269 strlen(passphrase)); 1270 explicit_bzero(passphrase, sizeof(passphrase)); 1271 } else if (md.md_iterations > 0) { 1272 u_char dkey[G_ELI_USERKEYLEN]; 1273 1274 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt, 1275 sizeof(md.md_salt), passphrase, md.md_iterations); 1276 explicit_bzero(passphrase, sizeof(passphrase)); 1277 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey)); 1278 explicit_bzero(dkey, sizeof(dkey)); 1279 } 1280 1281 g_eli_crypto_hmac_final(&ctx, key, 0); 1282 1283 /* 1284 * Decrypt Master-Key. 1285 */ 1286 error = g_eli_mkey_decrypt_any(&md, key, mkey, &nkey); 1287 explicit_bzero(key, sizeof(key)); 1288 if (error == -1) { 1289 if (i == tries) { 1290 G_ELI_DEBUG(0, 1291 "Wrong key for %s. No tries left.", 1292 pp->name); 1293 g_eli_keyfiles_clear(pp->name); 1294 return (NULL); 1295 } 1296 if (i > 0) { 1297 G_ELI_DEBUG(0, 1298 "Wrong key for %s. Tries left: %u.", 1299 pp->name, tries - i); 1300 } 1301 /* Try again. */ 1302 continue; 1303 } else if (error > 0) { 1304 G_ELI_DEBUG(0, 1305 "Cannot decrypt Master Key for %s (error=%d).", 1306 pp->name, error); 1307 g_eli_keyfiles_clear(pp->name); 1308 return (NULL); 1309 } 1310 g_eli_keyfiles_clear(pp->name); 1311 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name); 1312 break; 1313 } 1314 have_key: 1315 1316 /* 1317 * We have correct key, let's attach provider. 1318 */ 1319 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey); 1320 explicit_bzero(mkey, sizeof(mkey)); 1321 explicit_bzero(&md, sizeof(md)); 1322 if (gp == NULL) { 1323 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name, 1324 G_ELI_SUFFIX); 1325 return (NULL); 1326 } 1327 return (gp); 1328 } 1329 1330 static void 1331 g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, 1332 struct g_consumer *cp, struct g_provider *pp) 1333 { 1334 struct g_eli_softc *sc; 1335 1336 g_topology_assert(); 1337 sc = gp->softc; 1338 if (sc == NULL) 1339 return; 1340 if (pp != NULL || cp != NULL) 1341 return; /* Nothing here. */ 1342 1343 sbuf_printf(sb, "%s<KeysTotal>%ju</KeysTotal>\n", indent, 1344 (uintmax_t)sc->sc_ekeys_total); 1345 sbuf_printf(sb, "%s<KeysAllocated>%ju</KeysAllocated>\n", indent, 1346 (uintmax_t)sc->sc_ekeys_allocated); 1347 sbuf_printf(sb, "%s<Flags>", indent); 1348 if (sc->sc_flags == 0) 1349 sbuf_cat(sb, "NONE"); 1350 else { 1351 int first = 1; 1352 1353 #define ADD_FLAG(flag, name) do { \ 1354 if (sc->sc_flags & (flag)) { \ 1355 if (!first) \ 1356 sbuf_cat(sb, ", "); \ 1357 else \ 1358 first = 0; \ 1359 sbuf_cat(sb, name); \ 1360 } \ 1361 } while (0) 1362 ADD_FLAG(G_ELI_FLAG_SUSPEND, "SUSPEND"); 1363 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY"); 1364 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER"); 1365 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME"); 1366 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT"); 1367 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH"); 1368 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH"); 1369 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH"); 1370 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN"); 1371 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY"); 1372 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY"); 1373 ADD_FLAG(G_ELI_FLAG_NODELETE, "NODELETE"); 1374 ADD_FLAG(G_ELI_FLAG_GELIBOOT, "GELIBOOT"); 1375 ADD_FLAG(G_ELI_FLAG_GELIDISPLAYPASS, "GELIDISPLAYPASS"); 1376 ADD_FLAG(G_ELI_FLAG_AUTORESIZE, "AUTORESIZE"); 1377 #undef ADD_FLAG 1378 } 1379 sbuf_cat(sb, "</Flags>\n"); 1380 1381 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) { 1382 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent, 1383 sc->sc_nkey); 1384 } 1385 sbuf_printf(sb, "%s<Version>%u</Version>\n", indent, sc->sc_version); 1386 sbuf_printf(sb, "%s<Crypto>", indent); 1387 switch (sc->sc_crypto) { 1388 case G_ELI_CRYPTO_HW: 1389 sbuf_cat(sb, "hardware"); 1390 break; 1391 case G_ELI_CRYPTO_SW: 1392 sbuf_cat(sb, "software"); 1393 break; 1394 case G_ELI_CRYPTO_SW_ACCEL: 1395 sbuf_cat(sb, "accelerated software"); 1396 break; 1397 default: 1398 sbuf_cat(sb, "UNKNOWN"); 1399 break; 1400 } 1401 sbuf_cat(sb, "</Crypto>\n"); 1402 if (sc->sc_flags & G_ELI_FLAG_AUTH) { 1403 sbuf_printf(sb, 1404 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n", 1405 indent, g_eli_algo2str(sc->sc_aalgo)); 1406 } 1407 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent, 1408 sc->sc_ekeylen); 1409 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n", 1410 indent, g_eli_algo2str(sc->sc_ealgo)); 1411 sbuf_printf(sb, "%s<State>%s</State>\n", indent, 1412 (sc->sc_flags & G_ELI_FLAG_SUSPEND) ? "SUSPENDED" : "ACTIVE"); 1413 } 1414 1415 static void 1416 g_eli_shutdown_pre_sync(void *arg, int howto) 1417 { 1418 struct g_class *mp; 1419 struct g_geom *gp, *gp2; 1420 struct g_provider *pp; 1421 struct g_eli_softc *sc; 1422 int error; 1423 1424 mp = arg; 1425 g_topology_lock(); 1426 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) { 1427 sc = gp->softc; 1428 if (sc == NULL) 1429 continue; 1430 pp = LIST_FIRST(&gp->provider); 1431 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name)); 1432 if (pp->acr != 0 || pp->acw != 0 || pp->ace != 0 || 1433 SCHEDULER_STOPPED()) 1434 { 1435 sc->sc_flags |= G_ELI_FLAG_RW_DETACH; 1436 gp->access = g_eli_access; 1437 } else { 1438 error = g_eli_destroy(sc, TRUE); 1439 } 1440 } 1441 g_topology_unlock(); 1442 } 1443 1444 static void 1445 g_eli_init(struct g_class *mp) 1446 { 1447 1448 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync, 1449 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST); 1450 if (g_eli_pre_sync == NULL) 1451 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event."); 1452 } 1453 1454 static void 1455 g_eli_fini(struct g_class *mp) 1456 { 1457 1458 if (g_eli_pre_sync != NULL) 1459 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync); 1460 } 1461 1462 DECLARE_GEOM_CLASS(g_eli_class, g_eli); 1463 MODULE_DEPEND(g_eli, crypto, 1, 1, 1); 1464 MODULE_VERSION(geom_eli, 0); 1465