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 <vm/uma.h> 53 54 #include <geom/geom.h> 55 #include <geom/geom_dbg.h> 56 #include <geom/eli/g_eli.h> 57 #include <geom/eli/pkcs5v2.h> 58 59 #include <crypto/intake.h> 60 61 FEATURE(geom_eli, "GEOM crypto module"); 62 63 MALLOC_DEFINE(M_ELI, "eli data", "GEOM_ELI Data"); 64 65 SYSCTL_DECL(_kern_geom); 66 SYSCTL_NODE(_kern_geom, OID_AUTO, eli, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 67 "GEOM_ELI stuff"); 68 static int g_eli_version = G_ELI_VERSION; 69 SYSCTL_INT(_kern_geom_eli, OID_AUTO, version, CTLFLAG_RD, &g_eli_version, 0, 70 "GELI version"); 71 int g_eli_debug = 0; 72 SYSCTL_INT(_kern_geom_eli, OID_AUTO, debug, CTLFLAG_RWTUN, &g_eli_debug, 0, 73 "Debug level"); 74 static u_int g_eli_tries = 3; 75 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, tries, CTLFLAG_RWTUN, &g_eli_tries, 0, 76 "Number of tries for entering the passphrase"); 77 static u_int g_eli_visible_passphrase = GETS_NOECHO; 78 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, visible_passphrase, CTLFLAG_RWTUN, 79 &g_eli_visible_passphrase, 0, 80 "Visibility of passphrase prompt (0 = invisible, 1 = visible, 2 = asterisk)"); 81 u_int g_eli_overwrites = G_ELI_OVERWRITES; 82 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, overwrites, CTLFLAG_RWTUN, &g_eli_overwrites, 83 0, "Number of times on-disk keys should be overwritten when destroying them"); 84 static u_int g_eli_threads = 0; 85 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, threads, CTLFLAG_RWTUN, &g_eli_threads, 0, 86 "Number of threads doing crypto work"); 87 u_int g_eli_batch = 0; 88 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, batch, CTLFLAG_RWTUN, &g_eli_batch, 0, 89 "Use crypto operations batching"); 90 91 /* 92 * Passphrase cached during boot, in order to be more user-friendly if 93 * there are multiple providers using the same passphrase. 94 */ 95 static char cached_passphrase[256]; 96 static u_int g_eli_boot_passcache = 1; 97 TUNABLE_INT("kern.geom.eli.boot_passcache", &g_eli_boot_passcache); 98 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, boot_passcache, CTLFLAG_RD, 99 &g_eli_boot_passcache, 0, 100 "Passphrases are cached during boot process for possible reuse"); 101 static void 102 fetch_loader_passphrase(void * dummy) 103 { 104 char * env_passphrase; 105 106 KASSERT(dynamic_kenv, ("need dynamic kenv")); 107 108 if ((env_passphrase = kern_getenv("kern.geom.eli.passphrase")) != NULL) { 109 /* Extract passphrase from the environment. */ 110 strlcpy(cached_passphrase, env_passphrase, 111 sizeof(cached_passphrase)); 112 freeenv(env_passphrase); 113 114 /* Wipe the passphrase from the environment. */ 115 kern_unsetenv("kern.geom.eli.passphrase"); 116 } 117 } 118 SYSINIT(geli_fetch_loader_passphrase, SI_SUB_KMEM + 1, SI_ORDER_ANY, 119 fetch_loader_passphrase, NULL); 120 121 static void 122 zero_boot_passcache(void) 123 { 124 125 explicit_bzero(cached_passphrase, sizeof(cached_passphrase)); 126 } 127 128 static void 129 zero_geli_intake_keys(void) 130 { 131 struct keybuf *keybuf; 132 int i; 133 134 if ((keybuf = get_keybuf()) != NULL) { 135 /* Scan the key buffer, clear all GELI keys. */ 136 for (i = 0; i < keybuf->kb_nents; i++) { 137 if (keybuf->kb_ents[i].ke_type == KEYBUF_TYPE_GELI) { 138 explicit_bzero(keybuf->kb_ents[i].ke_data, 139 sizeof(keybuf->kb_ents[i].ke_data)); 140 keybuf->kb_ents[i].ke_type = KEYBUF_TYPE_NONE; 141 } 142 } 143 } 144 } 145 146 static void 147 zero_intake_passcache(void *dummy) 148 { 149 zero_boot_passcache(); 150 zero_geli_intake_keys(); 151 } 152 EVENTHANDLER_DEFINE(mountroot, zero_intake_passcache, NULL, 0); 153 154 static eventhandler_tag g_eli_pre_sync = NULL; 155 156 static int g_eli_read_metadata_offset(struct g_class *mp, struct g_provider *pp, 157 off_t offset, struct g_eli_metadata *md); 158 159 static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp, 160 struct g_geom *gp); 161 static void g_eli_init(struct g_class *mp); 162 static void g_eli_fini(struct g_class *mp); 163 164 static g_taste_t g_eli_taste; 165 static g_dumpconf_t g_eli_dumpconf; 166 167 struct g_class g_eli_class = { 168 .name = G_ELI_CLASS_NAME, 169 .version = G_VERSION, 170 .ctlreq = g_eli_config, 171 .taste = g_eli_taste, 172 .destroy_geom = g_eli_destroy_geom, 173 .init = g_eli_init, 174 .fini = g_eli_fini 175 }; 176 177 178 /* 179 * Code paths: 180 * BIO_READ: 181 * 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 182 * BIO_WRITE: 183 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver 184 */ 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 if (sector != NULL) { 392 explicit_bzero(sector, pp->sectorsize); 393 free(sector, M_ELI); 394 } 395 } 396 397 oldsize = sc->sc_mediasize; 398 sc->sc_mediasize = eli_mediasize(sc, pp->mediasize, pp->sectorsize); 399 g_eli_key_resize(sc); 400 sc->sc_provsize = pp->mediasize; 401 402 epp = LIST_FIRST(&sc->sc_geom->provider); 403 g_resize_provider(epp, sc->sc_mediasize); 404 G_ELI_DEBUG(0, "Device %s size changed from %jd to %jd.", epp->name, 405 (intmax_t)oldsize, (intmax_t)sc->sc_mediasize); 406 } 407 408 /* 409 * BIO_READ: 410 * 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 411 * BIO_WRITE: 412 * G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver 413 */ 414 static void 415 g_eli_start(struct bio *bp) 416 { 417 struct g_eli_softc *sc; 418 struct g_consumer *cp; 419 struct bio *cbp; 420 421 sc = bp->bio_to->geom->softc; 422 KASSERT(sc != NULL, 423 ("Provider's error should be set (error=%d)(device=%s).", 424 bp->bio_to->error, bp->bio_to->name)); 425 G_ELI_LOGREQ(2, bp, "Request received."); 426 427 switch (bp->bio_cmd) { 428 case BIO_READ: 429 case BIO_WRITE: 430 case BIO_GETATTR: 431 case BIO_FLUSH: 432 case BIO_ZONE: 433 case BIO_SPEEDUP: 434 break; 435 case BIO_DELETE: 436 /* 437 * If the user hasn't set the NODELETE flag, we just pass 438 * it down the stack and let the layers beneath us do (or 439 * not) whatever they do with it. If they have, we 440 * reject it. A possible extension would be an 441 * additional flag to take it as a hint to shred the data 442 * with [multiple?] overwrites. 443 */ 444 if (!(sc->sc_flags & G_ELI_FLAG_NODELETE)) 445 break; 446 default: 447 g_io_deliver(bp, EOPNOTSUPP); 448 return; 449 } 450 cbp = g_clone_bio(bp); 451 if (cbp == NULL) { 452 g_io_deliver(bp, ENOMEM); 453 return; 454 } 455 bp->bio_driver1 = cbp; 456 bp->bio_pflags = G_ELI_NEW_BIO; 457 switch (bp->bio_cmd) { 458 case BIO_READ: 459 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) { 460 g_eli_crypto_read(sc, bp, 0); 461 break; 462 } 463 /* FALLTHROUGH */ 464 case BIO_WRITE: 465 mtx_lock(&sc->sc_queue_mtx); 466 bioq_insert_tail(&sc->sc_queue, bp); 467 mtx_unlock(&sc->sc_queue_mtx); 468 wakeup(sc); 469 break; 470 case BIO_GETATTR: 471 case BIO_FLUSH: 472 case BIO_DELETE: 473 case BIO_SPEEDUP: 474 case BIO_ZONE: 475 if (bp->bio_cmd == BIO_GETATTR) 476 cbp->bio_done = g_eli_getattr_done; 477 else 478 cbp->bio_done = g_std_done; 479 cp = LIST_FIRST(&sc->sc_geom->consumer); 480 cbp->bio_to = cp->provider; 481 G_ELI_LOGREQ(2, cbp, "Sending request."); 482 g_io_request(cbp, cp); 483 break; 484 } 485 } 486 487 static int 488 g_eli_newsession(struct g_eli_worker *wr) 489 { 490 struct g_eli_softc *sc; 491 struct crypto_session_params csp; 492 int error; 493 void *key; 494 495 sc = wr->w_softc; 496 497 memset(&csp, 0, sizeof(csp)); 498 csp.csp_mode = CSP_MODE_CIPHER; 499 csp.csp_cipher_alg = sc->sc_ealgo; 500 csp.csp_ivlen = g_eli_ivlen(sc->sc_ealgo); 501 csp.csp_cipher_klen = sc->sc_ekeylen / 8; 502 if (sc->sc_ealgo == CRYPTO_AES_XTS) 503 csp.csp_cipher_klen <<= 1; 504 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0) { 505 key = g_eli_key_hold(sc, 0, 506 LIST_FIRST(&sc->sc_geom->consumer)->provider->sectorsize); 507 csp.csp_cipher_key = key; 508 } else { 509 key = NULL; 510 csp.csp_cipher_key = sc->sc_ekey; 511 } 512 if (sc->sc_flags & G_ELI_FLAG_AUTH) { 513 csp.csp_mode = CSP_MODE_ETA; 514 csp.csp_auth_alg = sc->sc_aalgo; 515 csp.csp_auth_klen = G_ELI_AUTH_SECKEYLEN; 516 } 517 518 switch (sc->sc_crypto) { 519 case G_ELI_CRYPTO_SW: 520 error = crypto_newsession(&wr->w_sid, &csp, 521 CRYPTOCAP_F_SOFTWARE); 522 break; 523 case G_ELI_CRYPTO_HW: 524 error = crypto_newsession(&wr->w_sid, &csp, 525 CRYPTOCAP_F_HARDWARE); 526 break; 527 case G_ELI_CRYPTO_UNKNOWN: 528 error = crypto_newsession(&wr->w_sid, &csp, 529 CRYPTOCAP_F_HARDWARE); 530 if (error == 0) { 531 mtx_lock(&sc->sc_queue_mtx); 532 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN) 533 sc->sc_crypto = G_ELI_CRYPTO_HW; 534 mtx_unlock(&sc->sc_queue_mtx); 535 } else { 536 error = crypto_newsession(&wr->w_sid, &csp, 537 CRYPTOCAP_F_SOFTWARE); 538 mtx_lock(&sc->sc_queue_mtx); 539 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN) 540 sc->sc_crypto = G_ELI_CRYPTO_SW; 541 mtx_unlock(&sc->sc_queue_mtx); 542 } 543 break; 544 default: 545 panic("%s: invalid condition", __func__); 546 } 547 548 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0) { 549 if (error) 550 g_eli_key_drop(sc, key); 551 else 552 wr->w_first_key = key; 553 } 554 555 return (error); 556 } 557 558 static void 559 g_eli_freesession(struct g_eli_worker *wr) 560 { 561 struct g_eli_softc *sc; 562 563 crypto_freesession(wr->w_sid); 564 if (wr->w_first_key != NULL) { 565 sc = wr->w_softc; 566 g_eli_key_drop(sc, wr->w_first_key); 567 wr->w_first_key = NULL; 568 } 569 } 570 571 static void 572 g_eli_cancel(struct g_eli_softc *sc) 573 { 574 struct bio *bp; 575 576 mtx_assert(&sc->sc_queue_mtx, MA_OWNED); 577 578 while ((bp = bioq_takefirst(&sc->sc_queue)) != NULL) { 579 KASSERT(bp->bio_pflags == G_ELI_NEW_BIO, 580 ("Not new bio when canceling (bp=%p).", bp)); 581 g_io_deliver(bp, ENXIO); 582 } 583 } 584 585 static struct bio * 586 g_eli_takefirst(struct g_eli_softc *sc) 587 { 588 struct bio *bp; 589 590 mtx_assert(&sc->sc_queue_mtx, MA_OWNED); 591 592 if (!(sc->sc_flags & G_ELI_FLAG_SUSPEND)) 593 return (bioq_takefirst(&sc->sc_queue)); 594 /* 595 * Device suspended, so we skip new I/O requests. 596 */ 597 TAILQ_FOREACH(bp, &sc->sc_queue.queue, bio_queue) { 598 if (bp->bio_pflags != G_ELI_NEW_BIO) 599 break; 600 } 601 if (bp != NULL) 602 bioq_remove(&sc->sc_queue, bp); 603 return (bp); 604 } 605 606 /* 607 * This is the main function for kernel worker thread when we don't have 608 * hardware acceleration and we have to do cryptography in software. 609 * Dedicated thread is needed, so we don't slow down g_up/g_down GEOM 610 * threads with crypto work. 611 */ 612 static void 613 g_eli_worker(void *arg) 614 { 615 struct g_eli_softc *sc; 616 struct g_eli_worker *wr; 617 struct bio *bp; 618 int error; 619 620 wr = arg; 621 sc = wr->w_softc; 622 #ifdef EARLY_AP_STARTUP 623 MPASS(!sc->sc_cpubind || smp_started); 624 #elif defined(SMP) 625 /* Before sched_bind() to a CPU, wait for all CPUs to go on-line. */ 626 if (sc->sc_cpubind) { 627 while (!smp_started) 628 tsleep(wr, 0, "geli:smp", hz / 4); 629 } 630 #endif 631 thread_lock(curthread); 632 sched_prio(curthread, PUSER); 633 if (sc->sc_cpubind) 634 sched_bind(curthread, wr->w_number % mp_ncpus); 635 thread_unlock(curthread); 636 637 G_ELI_DEBUG(1, "Thread %s started.", curthread->td_proc->p_comm); 638 639 for (;;) { 640 mtx_lock(&sc->sc_queue_mtx); 641 again: 642 bp = g_eli_takefirst(sc); 643 if (bp == NULL) { 644 if (sc->sc_flags & G_ELI_FLAG_DESTROY) { 645 g_eli_cancel(sc); 646 LIST_REMOVE(wr, w_next); 647 g_eli_freesession(wr); 648 free(wr, M_ELI); 649 G_ELI_DEBUG(1, "Thread %s exiting.", 650 curthread->td_proc->p_comm); 651 wakeup(&sc->sc_workers); 652 mtx_unlock(&sc->sc_queue_mtx); 653 kproc_exit(0); 654 } 655 while (sc->sc_flags & G_ELI_FLAG_SUSPEND) { 656 if (sc->sc_inflight > 0) { 657 G_ELI_DEBUG(0, "inflight=%d", 658 sc->sc_inflight); 659 /* 660 * We still have inflight BIOs, so 661 * sleep and retry. 662 */ 663 msleep(sc, &sc->sc_queue_mtx, PRIBIO, 664 "geli:inf", hz / 5); 665 goto again; 666 } 667 /* 668 * Suspend requested, mark the worker as 669 * suspended and go to sleep. 670 */ 671 if (wr->w_active) { 672 g_eli_freesession(wr); 673 wr->w_active = FALSE; 674 } 675 wakeup(&sc->sc_workers); 676 msleep(sc, &sc->sc_queue_mtx, PRIBIO, 677 "geli:suspend", 0); 678 if (!wr->w_active && 679 !(sc->sc_flags & G_ELI_FLAG_SUSPEND)) { 680 error = g_eli_newsession(wr); 681 KASSERT(error == 0, 682 ("g_eli_newsession() failed on resume (error=%d)", 683 error)); 684 wr->w_active = TRUE; 685 } 686 goto again; 687 } 688 msleep(sc, &sc->sc_queue_mtx, PDROP, "geli:w", 0); 689 continue; 690 } 691 if (bp->bio_pflags == G_ELI_NEW_BIO) 692 atomic_add_int(&sc->sc_inflight, 1); 693 mtx_unlock(&sc->sc_queue_mtx); 694 if (bp->bio_pflags == G_ELI_NEW_BIO) { 695 bp->bio_pflags = 0; 696 if (sc->sc_flags & G_ELI_FLAG_AUTH) { 697 if (bp->bio_cmd == BIO_READ) 698 g_eli_auth_read(sc, bp); 699 else 700 g_eli_auth_run(wr, bp); 701 } else { 702 if (bp->bio_cmd == BIO_READ) 703 g_eli_crypto_read(sc, bp, 1); 704 else 705 g_eli_crypto_run(wr, bp); 706 } 707 } else { 708 if (sc->sc_flags & G_ELI_FLAG_AUTH) 709 g_eli_auth_run(wr, bp); 710 else 711 g_eli_crypto_run(wr, bp); 712 } 713 } 714 } 715 716 static int 717 g_eli_read_metadata_offset(struct g_class *mp, struct g_provider *pp, 718 off_t offset, struct g_eli_metadata *md) 719 { 720 struct g_geom *gp; 721 struct g_consumer *cp; 722 u_char *buf = NULL; 723 int error; 724 725 g_topology_assert(); 726 727 gp = g_new_geomf(mp, "eli:taste"); 728 gp->start = g_eli_start; 729 gp->access = g_std_access; 730 /* 731 * g_eli_read_metadata() is always called from the event thread. 732 * Our geom is created and destroyed in the same event, so there 733 * could be no orphan nor spoil event in the meantime. 734 */ 735 gp->orphan = g_eli_orphan_spoil_assert; 736 gp->spoiled = g_eli_orphan_spoil_assert; 737 cp = g_new_consumer(gp); 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 u_int i, threads; 847 int dcw, error; 848 849 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX); 850 KASSERT(eli_metadata_crypto_supported(md), 851 ("%s: unsupported crypto for %s", __func__, bpp->name)); 852 853 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX); 854 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO); 855 gp->start = g_eli_start; 856 /* 857 * Spoiling can happen even though we have the provider open 858 * exclusively, e.g. through media change events. 859 */ 860 gp->spoiled = g_eli_orphan; 861 gp->orphan = g_eli_orphan; 862 gp->resize = g_eli_resize; 863 gp->dumpconf = g_eli_dumpconf; 864 /* 865 * If detach-on-last-close feature is not enabled and we don't operate 866 * on read-only provider, we can simply use g_std_access(). 867 */ 868 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO)) 869 gp->access = g_eli_access; 870 else 871 gp->access = g_std_access; 872 873 eli_metadata_softc(sc, md, bpp->sectorsize, bpp->mediasize); 874 sc->sc_nkey = nkey; 875 876 gp->softc = sc; 877 sc->sc_geom = gp; 878 879 bioq_init(&sc->sc_queue); 880 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF); 881 mtx_init(&sc->sc_ekeys_lock, "geli:ekeys", NULL, MTX_DEF); 882 883 pp = NULL; 884 cp = g_new_consumer(gp); 885 error = g_attach(cp, bpp); 886 if (error != 0) { 887 if (req != NULL) { 888 gctl_error(req, "Cannot attach to %s (error=%d).", 889 bpp->name, error); 890 } else { 891 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).", 892 bpp->name, error); 893 } 894 goto failed; 895 } 896 /* 897 * Keep provider open all the time, so we can run critical tasks, 898 * like Master Keys deletion, without wondering if we can open 899 * provider or not. 900 * We don't open provider for writing only when user requested read-only 901 * access. 902 */ 903 dcw = (sc->sc_flags & G_ELI_FLAG_RO) ? 0 : 1; 904 error = g_access(cp, 1, dcw, 1); 905 if (error != 0) { 906 if (req != NULL) { 907 gctl_error(req, "Cannot access %s (error=%d).", 908 bpp->name, error); 909 } else { 910 G_ELI_DEBUG(1, "Cannot access %s (error=%d).", 911 bpp->name, error); 912 } 913 goto failed; 914 } 915 916 /* 917 * Remember the keys in our softc structure. 918 */ 919 g_eli_mkey_propagate(sc, mkey); 920 921 LIST_INIT(&sc->sc_workers); 922 923 threads = g_eli_threads; 924 if (threads == 0) 925 threads = mp_ncpus; 926 sc->sc_cpubind = (mp_ncpus > 1 && threads == mp_ncpus); 927 for (i = 0; i < threads; i++) { 928 if (g_eli_cpu_is_disabled(i)) { 929 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.", 930 bpp->name, i); 931 continue; 932 } 933 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO); 934 wr->w_softc = sc; 935 wr->w_number = i; 936 wr->w_active = TRUE; 937 938 error = g_eli_newsession(wr); 939 if (error != 0) { 940 free(wr, M_ELI); 941 if (req != NULL) { 942 gctl_error(req, "Cannot set up crypto session " 943 "for %s (error=%d).", bpp->name, error); 944 } else { 945 G_ELI_DEBUG(1, "Cannot set up crypto session " 946 "for %s (error=%d).", bpp->name, error); 947 } 948 goto failed; 949 } 950 951 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0, 952 "g_eli[%u] %s", i, bpp->name); 953 if (error != 0) { 954 g_eli_freesession(wr); 955 free(wr, M_ELI); 956 if (req != NULL) { 957 gctl_error(req, "Cannot create kernel thread " 958 "for %s (error=%d).", bpp->name, error); 959 } else { 960 G_ELI_DEBUG(1, "Cannot create kernel thread " 961 "for %s (error=%d).", bpp->name, error); 962 } 963 goto failed; 964 } 965 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next); 966 } 967 968 /* 969 * Create decrypted provider. 970 */ 971 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX); 972 pp->mediasize = sc->sc_mediasize; 973 pp->sectorsize = sc->sc_sectorsize; 974 975 g_error_provider(pp, 0); 976 977 G_ELI_DEBUG(0, "Device %s created.", pp->name); 978 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo), 979 sc->sc_ekeylen); 980 if (sc->sc_flags & G_ELI_FLAG_AUTH) 981 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo)); 982 G_ELI_DEBUG(0, " Crypto: %s", 983 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware"); 984 return (gp); 985 failed: 986 mtx_lock(&sc->sc_queue_mtx); 987 sc->sc_flags |= G_ELI_FLAG_DESTROY; 988 wakeup(sc); 989 /* 990 * Wait for kernel threads self destruction. 991 */ 992 while (!LIST_EMPTY(&sc->sc_workers)) { 993 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO, 994 "geli:destroy", 0); 995 } 996 mtx_destroy(&sc->sc_queue_mtx); 997 if (cp->provider != NULL) { 998 if (cp->acr == 1) 999 g_access(cp, -1, -dcw, -1); 1000 g_detach(cp); 1001 } 1002 g_destroy_consumer(cp); 1003 g_destroy_geom(gp); 1004 g_eli_key_destroy(sc); 1005 bzero(sc, sizeof(*sc)); 1006 free(sc, M_ELI); 1007 return (NULL); 1008 } 1009 1010 int 1011 g_eli_destroy(struct g_eli_softc *sc, boolean_t force) 1012 { 1013 struct g_geom *gp; 1014 struct g_provider *pp; 1015 1016 g_topology_assert(); 1017 1018 if (sc == NULL) 1019 return (ENXIO); 1020 1021 gp = sc->sc_geom; 1022 pp = LIST_FIRST(&gp->provider); 1023 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) { 1024 if (force) { 1025 G_ELI_DEBUG(1, "Device %s is still open, so it " 1026 "cannot be definitely removed.", pp->name); 1027 sc->sc_flags |= G_ELI_FLAG_RW_DETACH; 1028 gp->access = g_eli_access; 1029 g_wither_provider(pp, ENXIO); 1030 return (EBUSY); 1031 } else { 1032 G_ELI_DEBUG(1, 1033 "Device %s is still open (r%dw%de%d).", pp->name, 1034 pp->acr, pp->acw, pp->ace); 1035 return (EBUSY); 1036 } 1037 } 1038 1039 mtx_lock(&sc->sc_queue_mtx); 1040 sc->sc_flags |= G_ELI_FLAG_DESTROY; 1041 wakeup(sc); 1042 while (!LIST_EMPTY(&sc->sc_workers)) { 1043 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO, 1044 "geli:destroy", 0); 1045 } 1046 mtx_destroy(&sc->sc_queue_mtx); 1047 gp->softc = NULL; 1048 g_eli_key_destroy(sc); 1049 bzero(sc, sizeof(*sc)); 1050 free(sc, M_ELI); 1051 1052 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name); 1053 g_wither_geom_close(gp, ENXIO); 1054 1055 return (0); 1056 } 1057 1058 static int 1059 g_eli_destroy_geom(struct gctl_req *req __unused, 1060 struct g_class *mp __unused, struct g_geom *gp) 1061 { 1062 struct g_eli_softc *sc; 1063 1064 sc = gp->softc; 1065 return (g_eli_destroy(sc, FALSE)); 1066 } 1067 1068 static int 1069 g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider) 1070 { 1071 u_char *keyfile, *data; 1072 char *file, name[64]; 1073 size_t size; 1074 int i; 1075 1076 for (i = 0; ; i++) { 1077 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i); 1078 keyfile = preload_search_by_type(name); 1079 if (keyfile == NULL && i == 0) { 1080 /* 1081 * If there is only one keyfile, allow simpler name. 1082 */ 1083 snprintf(name, sizeof(name), "%s:geli_keyfile", provider); 1084 keyfile = preload_search_by_type(name); 1085 } 1086 if (keyfile == NULL) 1087 return (i); /* Return number of loaded keyfiles. */ 1088 data = preload_fetch_addr(keyfile); 1089 if (data == NULL) { 1090 G_ELI_DEBUG(0, "Cannot find key file data for %s.", 1091 name); 1092 return (0); 1093 } 1094 size = preload_fetch_size(keyfile); 1095 if (size == 0) { 1096 G_ELI_DEBUG(0, "Cannot find key file size for %s.", 1097 name); 1098 return (0); 1099 } 1100 file = preload_search_info(keyfile, MODINFO_NAME); 1101 if (file == NULL) { 1102 G_ELI_DEBUG(0, "Cannot find key file name for %s.", 1103 name); 1104 return (0); 1105 } 1106 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file, 1107 provider, name); 1108 g_eli_crypto_hmac_update(ctx, data, size); 1109 } 1110 } 1111 1112 static void 1113 g_eli_keyfiles_clear(const char *provider) 1114 { 1115 u_char *keyfile, *data; 1116 char name[64]; 1117 size_t size; 1118 int i; 1119 1120 for (i = 0; ; i++) { 1121 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i); 1122 keyfile = preload_search_by_type(name); 1123 if (keyfile == NULL) 1124 return; 1125 data = preload_fetch_addr(keyfile); 1126 size = preload_fetch_size(keyfile); 1127 if (data != NULL && size != 0) 1128 bzero(data, size); 1129 } 1130 } 1131 1132 /* 1133 * Tasting is only made on boot. 1134 * We detect providers which should be attached before root is mounted. 1135 */ 1136 static struct g_geom * 1137 g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused) 1138 { 1139 struct g_eli_metadata md; 1140 struct g_geom *gp; 1141 struct hmac_ctx ctx; 1142 char passphrase[256]; 1143 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN]; 1144 u_int i, nkey, nkeyfiles, tries, showpass; 1145 int error; 1146 struct keybuf *keybuf; 1147 1148 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name); 1149 g_topology_assert(); 1150 1151 if (root_mounted() || g_eli_tries == 0) 1152 return (NULL); 1153 1154 G_ELI_DEBUG(3, "Tasting %s.", pp->name); 1155 1156 error = g_eli_read_metadata(mp, pp, &md); 1157 if (error != 0) 1158 return (NULL); 1159 gp = NULL; 1160 1161 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0) 1162 return (NULL); 1163 if (md.md_version > G_ELI_VERSION) { 1164 printf("geom_eli.ko module is too old to handle %s.\n", 1165 pp->name); 1166 return (NULL); 1167 } 1168 if (md.md_provsize != pp->mediasize) 1169 return (NULL); 1170 /* Should we attach it on boot? */ 1171 if (!(md.md_flags & G_ELI_FLAG_BOOT) && 1172 !(md.md_flags & G_ELI_FLAG_GELIBOOT)) 1173 return (NULL); 1174 if (md.md_keys == 0x00) { 1175 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name); 1176 return (NULL); 1177 } 1178 if (!eli_metadata_crypto_supported(&md)) { 1179 G_ELI_DEBUG(0, "%s uses invalid or unsupported algorithms\n", 1180 pp->name); 1181 return (NULL); 1182 } 1183 if (md.md_iterations == -1) { 1184 /* If there is no passphrase, we try only once. */ 1185 tries = 1; 1186 } else { 1187 /* Ask for the passphrase no more than g_eli_tries times. */ 1188 tries = g_eli_tries; 1189 } 1190 1191 if ((keybuf = get_keybuf()) != NULL) { 1192 /* Scan the key buffer, try all GELI keys. */ 1193 for (i = 0; i < keybuf->kb_nents; i++) { 1194 if (keybuf->kb_ents[i].ke_type == KEYBUF_TYPE_GELI) { 1195 memcpy(key, keybuf->kb_ents[i].ke_data, 1196 sizeof(key)); 1197 1198 if (g_eli_mkey_decrypt_any(&md, key, 1199 mkey, &nkey) == 0 ) { 1200 explicit_bzero(key, sizeof(key)); 1201 goto have_key; 1202 } 1203 } 1204 } 1205 } 1206 1207 for (i = 0; i <= tries; i++) { 1208 g_eli_crypto_hmac_init(&ctx, NULL, 0); 1209 1210 /* 1211 * Load all key files. 1212 */ 1213 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name); 1214 1215 if (nkeyfiles == 0 && md.md_iterations == -1) { 1216 /* 1217 * No key files and no passphrase, something is 1218 * definitely wrong here. 1219 * geli(8) doesn't allow for such situation, so assume 1220 * that there was really no passphrase and in that case 1221 * key files are no properly defined in loader.conf. 1222 */ 1223 G_ELI_DEBUG(0, 1224 "Found no key files in loader.conf for %s.", 1225 pp->name); 1226 return (NULL); 1227 } 1228 1229 /* Ask for the passphrase if defined. */ 1230 if (md.md_iterations >= 0) { 1231 /* Try first with cached passphrase. */ 1232 if (i == 0) { 1233 if (!g_eli_boot_passcache) 1234 continue; 1235 memcpy(passphrase, cached_passphrase, 1236 sizeof(passphrase)); 1237 } else { 1238 printf("Enter passphrase for %s: ", pp->name); 1239 showpass = g_eli_visible_passphrase; 1240 if ((md.md_flags & G_ELI_FLAG_GELIDISPLAYPASS) != 0) 1241 showpass = GETS_ECHOPASS; 1242 cngets(passphrase, sizeof(passphrase), 1243 showpass); 1244 memcpy(cached_passphrase, passphrase, 1245 sizeof(passphrase)); 1246 } 1247 } 1248 1249 /* 1250 * Prepare Derived-Key from the user passphrase. 1251 */ 1252 if (md.md_iterations == 0) { 1253 g_eli_crypto_hmac_update(&ctx, md.md_salt, 1254 sizeof(md.md_salt)); 1255 g_eli_crypto_hmac_update(&ctx, passphrase, 1256 strlen(passphrase)); 1257 explicit_bzero(passphrase, sizeof(passphrase)); 1258 } else if (md.md_iterations > 0) { 1259 u_char dkey[G_ELI_USERKEYLEN]; 1260 1261 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt, 1262 sizeof(md.md_salt), passphrase, md.md_iterations); 1263 bzero(passphrase, sizeof(passphrase)); 1264 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey)); 1265 explicit_bzero(dkey, sizeof(dkey)); 1266 } 1267 1268 g_eli_crypto_hmac_final(&ctx, key, 0); 1269 1270 /* 1271 * Decrypt Master-Key. 1272 */ 1273 error = g_eli_mkey_decrypt_any(&md, key, mkey, &nkey); 1274 bzero(key, sizeof(key)); 1275 if (error == -1) { 1276 if (i == tries) { 1277 G_ELI_DEBUG(0, 1278 "Wrong key for %s. No tries left.", 1279 pp->name); 1280 g_eli_keyfiles_clear(pp->name); 1281 return (NULL); 1282 } 1283 if (i > 0) { 1284 G_ELI_DEBUG(0, 1285 "Wrong key for %s. Tries left: %u.", 1286 pp->name, tries - i); 1287 } 1288 /* Try again. */ 1289 continue; 1290 } else if (error > 0) { 1291 G_ELI_DEBUG(0, 1292 "Cannot decrypt Master Key for %s (error=%d).", 1293 pp->name, error); 1294 g_eli_keyfiles_clear(pp->name); 1295 return (NULL); 1296 } 1297 g_eli_keyfiles_clear(pp->name); 1298 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name); 1299 break; 1300 } 1301 have_key: 1302 1303 /* 1304 * We have correct key, let's attach provider. 1305 */ 1306 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey); 1307 bzero(mkey, sizeof(mkey)); 1308 bzero(&md, sizeof(md)); 1309 if (gp == NULL) { 1310 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name, 1311 G_ELI_SUFFIX); 1312 return (NULL); 1313 } 1314 return (gp); 1315 } 1316 1317 static void 1318 g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, 1319 struct g_consumer *cp, struct g_provider *pp) 1320 { 1321 struct g_eli_softc *sc; 1322 1323 g_topology_assert(); 1324 sc = gp->softc; 1325 if (sc == NULL) 1326 return; 1327 if (pp != NULL || cp != NULL) 1328 return; /* Nothing here. */ 1329 1330 sbuf_printf(sb, "%s<KeysTotal>%ju</KeysTotal>\n", indent, 1331 (uintmax_t)sc->sc_ekeys_total); 1332 sbuf_printf(sb, "%s<KeysAllocated>%ju</KeysAllocated>\n", indent, 1333 (uintmax_t)sc->sc_ekeys_allocated); 1334 sbuf_printf(sb, "%s<Flags>", indent); 1335 if (sc->sc_flags == 0) 1336 sbuf_cat(sb, "NONE"); 1337 else { 1338 int first = 1; 1339 1340 #define ADD_FLAG(flag, name) do { \ 1341 if (sc->sc_flags & (flag)) { \ 1342 if (!first) \ 1343 sbuf_cat(sb, ", "); \ 1344 else \ 1345 first = 0; \ 1346 sbuf_cat(sb, name); \ 1347 } \ 1348 } while (0) 1349 ADD_FLAG(G_ELI_FLAG_SUSPEND, "SUSPEND"); 1350 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY"); 1351 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER"); 1352 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME"); 1353 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT"); 1354 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH"); 1355 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH"); 1356 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH"); 1357 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN"); 1358 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY"); 1359 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY"); 1360 ADD_FLAG(G_ELI_FLAG_NODELETE, "NODELETE"); 1361 ADD_FLAG(G_ELI_FLAG_GELIBOOT, "GELIBOOT"); 1362 ADD_FLAG(G_ELI_FLAG_GELIDISPLAYPASS, "GELIDISPLAYPASS"); 1363 ADD_FLAG(G_ELI_FLAG_AUTORESIZE, "AUTORESIZE"); 1364 #undef ADD_FLAG 1365 } 1366 sbuf_cat(sb, "</Flags>\n"); 1367 1368 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) { 1369 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent, 1370 sc->sc_nkey); 1371 } 1372 sbuf_printf(sb, "%s<Version>%u</Version>\n", indent, sc->sc_version); 1373 sbuf_printf(sb, "%s<Crypto>", indent); 1374 switch (sc->sc_crypto) { 1375 case G_ELI_CRYPTO_HW: 1376 sbuf_cat(sb, "hardware"); 1377 break; 1378 case G_ELI_CRYPTO_SW: 1379 sbuf_cat(sb, "software"); 1380 break; 1381 default: 1382 sbuf_cat(sb, "UNKNOWN"); 1383 break; 1384 } 1385 sbuf_cat(sb, "</Crypto>\n"); 1386 if (sc->sc_flags & G_ELI_FLAG_AUTH) { 1387 sbuf_printf(sb, 1388 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n", 1389 indent, g_eli_algo2str(sc->sc_aalgo)); 1390 } 1391 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent, 1392 sc->sc_ekeylen); 1393 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n", 1394 indent, g_eli_algo2str(sc->sc_ealgo)); 1395 sbuf_printf(sb, "%s<State>%s</State>\n", indent, 1396 (sc->sc_flags & G_ELI_FLAG_SUSPEND) ? "SUSPENDED" : "ACTIVE"); 1397 } 1398 1399 static void 1400 g_eli_shutdown_pre_sync(void *arg, int howto) 1401 { 1402 struct g_class *mp; 1403 struct g_geom *gp, *gp2; 1404 struct g_provider *pp; 1405 struct g_eli_softc *sc; 1406 int error; 1407 1408 mp = arg; 1409 g_topology_lock(); 1410 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) { 1411 sc = gp->softc; 1412 if (sc == NULL) 1413 continue; 1414 pp = LIST_FIRST(&gp->provider); 1415 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name)); 1416 if (pp->acr + pp->acw + pp->ace == 0) 1417 error = g_eli_destroy(sc, TRUE); 1418 else { 1419 sc->sc_flags |= G_ELI_FLAG_RW_DETACH; 1420 gp->access = g_eli_access; 1421 } 1422 } 1423 g_topology_unlock(); 1424 } 1425 1426 static void 1427 g_eli_init(struct g_class *mp) 1428 { 1429 1430 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync, 1431 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST); 1432 if (g_eli_pre_sync == NULL) 1433 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event."); 1434 } 1435 1436 static void 1437 g_eli_fini(struct g_class *mp) 1438 { 1439 1440 if (g_eli_pre_sync != NULL) 1441 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync); 1442 } 1443 1444 DECLARE_GEOM_CLASS(g_eli_class, g_eli); 1445 MODULE_DEPEND(g_eli, crypto, 1, 1, 1); 1446 MODULE_VERSION(geom_eli, 0); 1447