2 * Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/linker.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
40 #include <sys/sysctl.h>
41 #include <sys/malloc.h>
42 #include <sys/eventhandler.h>
43 #include <sys/kthread.h>
45 #include <sys/sched.h>
48 #include <sys/vnode.h>
52 #include <geom/geom.h>
53 #include <geom/eli/g_eli.h>
54 #include <geom/eli/pkcs5v2.h>
56 FEATURE(geom_eli, "GEOM crypto module");
58 MALLOC_DEFINE(M_ELI, "eli data", "GEOM_ELI Data");
60 SYSCTL_DECL(_kern_geom);
61 SYSCTL_NODE(_kern_geom, OID_AUTO, eli, CTLFLAG_RW, 0, "GEOM_ELI stuff");
62 static int g_eli_version = G_ELI_VERSION;
63 SYSCTL_INT(_kern_geom_eli, OID_AUTO, version, CTLFLAG_RD, &g_eli_version, 0,
66 SYSCTL_INT(_kern_geom_eli, OID_AUTO, debug, CTLFLAG_RWTUN, &g_eli_debug, 0,
68 static u_int g_eli_tries = 3;
69 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, tries, CTLFLAG_RWTUN, &g_eli_tries, 0,
70 "Number of tries for entering the passphrase");
71 static u_int g_eli_visible_passphrase = GETS_NOECHO;
72 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, visible_passphrase, CTLFLAG_RWTUN,
73 &g_eli_visible_passphrase, 0,
74 "Visibility of passphrase prompt (0 = invisible, 1 = visible, 2 = asterisk)");
75 u_int g_eli_overwrites = G_ELI_OVERWRITES;
76 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, overwrites, CTLFLAG_RWTUN, &g_eli_overwrites,
77 0, "Number of times on-disk keys should be overwritten when destroying them");
78 static u_int g_eli_threads = 0;
79 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, threads, CTLFLAG_RWTUN, &g_eli_threads, 0,
80 "Number of threads doing crypto work");
81 u_int g_eli_batch = 0;
82 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, batch, CTLFLAG_RWTUN, &g_eli_batch, 0,
83 "Use crypto operations batching");
86 * Passphrase cached during boot, in order to be more user-friendly if
87 * there are multiple providers using the same passphrase.
89 static char cached_passphrase[256];
90 static u_int g_eli_boot_passcache = 1;
91 TUNABLE_INT("kern.geom.eli.boot_passcache", &g_eli_boot_passcache);
92 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, boot_passcache, CTLFLAG_RD,
93 &g_eli_boot_passcache, 0,
94 "Passphrases are cached during boot process for possible reuse");
96 fetch_loader_passphrase(void * dummy)
98 char * env_passphrase;
100 KASSERT(dynamic_kenv, ("need dynamic kenv"));
102 if ((env_passphrase = kern_getenv("kern.geom.eli.passphrase")) != NULL) {
103 /* Extract passphrase from the environment. */
104 strlcpy(cached_passphrase, env_passphrase,
105 sizeof(cached_passphrase));
106 freeenv(env_passphrase);
108 /* Wipe the passphrase from the environment. */
109 kern_unsetenv("kern.geom.eli.passphrase");
112 SYSINIT(geli_fetch_loader_passphrase, SI_SUB_KMEM + 1, SI_ORDER_ANY,
113 fetch_loader_passphrase, NULL);
115 zero_boot_passcache(void * dummy)
118 memset(cached_passphrase, 0, sizeof(cached_passphrase));
120 EVENTHANDLER_DEFINE(mountroot, zero_boot_passcache, NULL, 0);
122 static eventhandler_tag g_eli_pre_sync = NULL;
124 static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp,
126 static void g_eli_init(struct g_class *mp);
127 static void g_eli_fini(struct g_class *mp);
129 static g_taste_t g_eli_taste;
130 static g_dumpconf_t g_eli_dumpconf;
132 struct g_class g_eli_class = {
133 .name = G_ELI_CLASS_NAME,
134 .version = G_VERSION,
135 .ctlreq = g_eli_config,
136 .taste = g_eli_taste,
137 .destroy_geom = g_eli_destroy_geom,
146 * 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
148 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
153 * EAGAIN from crypto(9) means, that we were probably balanced to another crypto
154 * accelerator or something like this.
155 * The function updates the SID and rerun the operation.
158 g_eli_crypto_rerun(struct cryptop *crp)
160 struct g_eli_softc *sc;
161 struct g_eli_worker *wr;
165 bp = (struct bio *)crp->crp_opaque;
166 sc = bp->bio_to->geom->softc;
167 LIST_FOREACH(wr, &sc->sc_workers, w_next) {
168 if (wr->w_number == bp->bio_pflags)
171 KASSERT(wr != NULL, ("Invalid worker (%u).", bp->bio_pflags));
172 G_ELI_DEBUG(1, "Rerunning crypto %s request (sid: %ju -> %ju).",
173 bp->bio_cmd == BIO_READ ? "READ" : "WRITE", (uintmax_t)wr->w_sid,
174 (uintmax_t)crp->crp_sid);
175 wr->w_sid = crp->crp_sid;
177 error = crypto_dispatch(crp);
180 G_ELI_DEBUG(1, "%s: crypto_dispatch() returned %d.", __func__, error);
181 crp->crp_etype = error;
186 * The function is called afer reading encrypted data from the provider.
188 * 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
191 g_eli_read_done(struct bio *bp)
193 struct g_eli_softc *sc;
196 G_ELI_LOGREQ(2, bp, "Request done.");
197 pbp = bp->bio_parent;
198 if (pbp->bio_error == 0 && bp->bio_error != 0)
199 pbp->bio_error = bp->bio_error;
202 * Do we have all sectors already?
205 if (pbp->bio_inbed < pbp->bio_children)
207 sc = pbp->bio_to->geom->softc;
208 if (pbp->bio_error != 0) {
209 G_ELI_LOGREQ(0, pbp, "%s() failed (error=%d)", __func__,
211 pbp->bio_completed = 0;
212 if (pbp->bio_driver2 != NULL) {
213 free(pbp->bio_driver2, M_ELI);
214 pbp->bio_driver2 = NULL;
216 g_io_deliver(pbp, pbp->bio_error);
217 atomic_subtract_int(&sc->sc_inflight, 1);
220 mtx_lock(&sc->sc_queue_mtx);
221 bioq_insert_tail(&sc->sc_queue, pbp);
222 mtx_unlock(&sc->sc_queue_mtx);
227 * The function is called after we encrypt and write data.
229 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> G_ELI_WRITE_DONE -> g_io_deliver
232 g_eli_write_done(struct bio *bp)
234 struct g_eli_softc *sc;
237 G_ELI_LOGREQ(2, bp, "Request done.");
238 pbp = bp->bio_parent;
239 if (pbp->bio_error == 0 && bp->bio_error != 0)
240 pbp->bio_error = bp->bio_error;
243 * Do we have all sectors already?
246 if (pbp->bio_inbed < pbp->bio_children)
248 free(pbp->bio_driver2, M_ELI);
249 pbp->bio_driver2 = NULL;
250 if (pbp->bio_error != 0) {
251 G_ELI_LOGREQ(0, pbp, "%s() failed (error=%d)", __func__,
253 pbp->bio_completed = 0;
255 pbp->bio_completed = pbp->bio_length;
258 * Write is finished, send it up.
260 sc = pbp->bio_to->geom->softc;
261 g_io_deliver(pbp, pbp->bio_error);
262 atomic_subtract_int(&sc->sc_inflight, 1);
266 * This function should never be called, but GEOM made as it set ->orphan()
267 * method for every geom.
270 g_eli_orphan_spoil_assert(struct g_consumer *cp)
273 panic("Function %s() called for %s.", __func__, cp->geom->name);
277 g_eli_orphan(struct g_consumer *cp)
279 struct g_eli_softc *sc;
282 sc = cp->geom->softc;
285 g_eli_destroy(sc, TRUE);
290 * 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
292 * G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
295 g_eli_start(struct bio *bp)
297 struct g_eli_softc *sc;
298 struct g_consumer *cp;
301 sc = bp->bio_to->geom->softc;
303 ("Provider's error should be set (error=%d)(device=%s).",
304 bp->bio_to->error, bp->bio_to->name));
305 G_ELI_LOGREQ(2, bp, "Request received.");
307 switch (bp->bio_cmd) {
315 * If the user hasn't set the NODELETE flag, we just pass
316 * it down the stack and let the layers beneath us do (or
317 * not) whatever they do with it. If they have, we
318 * reject it. A possible extension would be an
319 * additional flag to take it as a hint to shred the data
320 * with [multiple?] overwrites.
322 if (!(sc->sc_flags & G_ELI_FLAG_NODELETE))
325 g_io_deliver(bp, EOPNOTSUPP);
328 cbp = g_clone_bio(bp);
330 g_io_deliver(bp, ENOMEM);
333 bp->bio_driver1 = cbp;
334 bp->bio_pflags = G_ELI_NEW_BIO;
335 switch (bp->bio_cmd) {
337 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) {
338 g_eli_crypto_read(sc, bp, 0);
343 mtx_lock(&sc->sc_queue_mtx);
344 bioq_insert_tail(&sc->sc_queue, bp);
345 mtx_unlock(&sc->sc_queue_mtx);
351 cbp->bio_done = g_std_done;
352 cp = LIST_FIRST(&sc->sc_geom->consumer);
353 cbp->bio_to = cp->provider;
354 G_ELI_LOGREQ(2, cbp, "Sending request.");
355 g_io_request(cbp, cp);
361 g_eli_newsession(struct g_eli_worker *wr)
363 struct g_eli_softc *sc;
364 struct cryptoini crie, cria;
369 bzero(&crie, sizeof(crie));
370 crie.cri_alg = sc->sc_ealgo;
371 crie.cri_klen = sc->sc_ekeylen;
372 if (sc->sc_ealgo == CRYPTO_AES_XTS)
374 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0) {
375 crie.cri_key = g_eli_key_hold(sc, 0,
376 LIST_FIRST(&sc->sc_geom->consumer)->provider->sectorsize);
378 crie.cri_key = sc->sc_ekey;
380 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
381 bzero(&cria, sizeof(cria));
382 cria.cri_alg = sc->sc_aalgo;
383 cria.cri_klen = sc->sc_akeylen;
384 cria.cri_key = sc->sc_akey;
385 crie.cri_next = &cria;
388 switch (sc->sc_crypto) {
389 case G_ELI_CRYPTO_SW:
390 error = crypto_newsession(&wr->w_sid, &crie,
391 CRYPTOCAP_F_SOFTWARE);
393 case G_ELI_CRYPTO_HW:
394 error = crypto_newsession(&wr->w_sid, &crie,
395 CRYPTOCAP_F_HARDWARE);
397 case G_ELI_CRYPTO_UNKNOWN:
398 error = crypto_newsession(&wr->w_sid, &crie,
399 CRYPTOCAP_F_HARDWARE);
401 mtx_lock(&sc->sc_queue_mtx);
402 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN)
403 sc->sc_crypto = G_ELI_CRYPTO_HW;
404 mtx_unlock(&sc->sc_queue_mtx);
406 error = crypto_newsession(&wr->w_sid, &crie,
407 CRYPTOCAP_F_SOFTWARE);
408 mtx_lock(&sc->sc_queue_mtx);
409 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN)
410 sc->sc_crypto = G_ELI_CRYPTO_SW;
411 mtx_unlock(&sc->sc_queue_mtx);
415 panic("%s: invalid condition", __func__);
418 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0)
419 g_eli_key_drop(sc, crie.cri_key);
425 g_eli_freesession(struct g_eli_worker *wr)
428 crypto_freesession(wr->w_sid);
432 g_eli_cancel(struct g_eli_softc *sc)
436 mtx_assert(&sc->sc_queue_mtx, MA_OWNED);
438 while ((bp = bioq_takefirst(&sc->sc_queue)) != NULL) {
439 KASSERT(bp->bio_pflags == G_ELI_NEW_BIO,
440 ("Not new bio when canceling (bp=%p).", bp));
441 g_io_deliver(bp, ENXIO);
446 g_eli_takefirst(struct g_eli_softc *sc)
450 mtx_assert(&sc->sc_queue_mtx, MA_OWNED);
452 if (!(sc->sc_flags & G_ELI_FLAG_SUSPEND))
453 return (bioq_takefirst(&sc->sc_queue));
455 * Device suspended, so we skip new I/O requests.
457 TAILQ_FOREACH(bp, &sc->sc_queue.queue, bio_queue) {
458 if (bp->bio_pflags != G_ELI_NEW_BIO)
462 bioq_remove(&sc->sc_queue, bp);
467 * This is the main function for kernel worker thread when we don't have
468 * hardware acceleration and we have to do cryptography in software.
469 * Dedicated thread is needed, so we don't slow down g_up/g_down GEOM
470 * threads with crypto work.
473 g_eli_worker(void *arg)
475 struct g_eli_softc *sc;
476 struct g_eli_worker *wr;
483 /* Before sched_bind() to a CPU, wait for all CPUs to go on-line. */
484 if (sc->sc_cpubind) {
486 tsleep(wr, 0, "geli:smp", hz / 4);
489 thread_lock(curthread);
490 sched_prio(curthread, PUSER);
492 sched_bind(curthread, wr->w_number % mp_ncpus);
493 thread_unlock(curthread);
495 G_ELI_DEBUG(1, "Thread %s started.", curthread->td_proc->p_comm);
498 mtx_lock(&sc->sc_queue_mtx);
500 bp = g_eli_takefirst(sc);
502 if (sc->sc_flags & G_ELI_FLAG_DESTROY) {
504 LIST_REMOVE(wr, w_next);
505 g_eli_freesession(wr);
507 G_ELI_DEBUG(1, "Thread %s exiting.",
508 curthread->td_proc->p_comm);
509 wakeup(&sc->sc_workers);
510 mtx_unlock(&sc->sc_queue_mtx);
513 while (sc->sc_flags & G_ELI_FLAG_SUSPEND) {
514 if (sc->sc_inflight > 0) {
515 G_ELI_DEBUG(0, "inflight=%d",
518 * We still have inflight BIOs, so
521 msleep(sc, &sc->sc_queue_mtx, PRIBIO,
526 * Suspend requested, mark the worker as
527 * suspended and go to sleep.
530 g_eli_freesession(wr);
531 wr->w_active = FALSE;
533 wakeup(&sc->sc_workers);
534 msleep(sc, &sc->sc_queue_mtx, PRIBIO,
537 !(sc->sc_flags & G_ELI_FLAG_SUSPEND)) {
538 error = g_eli_newsession(wr);
540 ("g_eli_newsession() failed on resume (error=%d)",
546 msleep(sc, &sc->sc_queue_mtx, PDROP, "geli:w", 0);
549 if (bp->bio_pflags == G_ELI_NEW_BIO)
550 atomic_add_int(&sc->sc_inflight, 1);
551 mtx_unlock(&sc->sc_queue_mtx);
552 if (bp->bio_pflags == G_ELI_NEW_BIO) {
554 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
555 if (bp->bio_cmd == BIO_READ)
556 g_eli_auth_read(sc, bp);
558 g_eli_auth_run(wr, bp);
560 if (bp->bio_cmd == BIO_READ)
561 g_eli_crypto_read(sc, bp, 1);
563 g_eli_crypto_run(wr, bp);
566 if (sc->sc_flags & G_ELI_FLAG_AUTH)
567 g_eli_auth_run(wr, bp);
569 g_eli_crypto_run(wr, bp);
575 g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
576 struct g_eli_metadata *md)
579 struct g_consumer *cp;
585 gp = g_new_geomf(mp, "eli:taste");
586 gp->start = g_eli_start;
587 gp->access = g_std_access;
589 * g_eli_read_metadata() is always called from the event thread.
590 * Our geom is created and destroyed in the same event, so there
591 * could be no orphan nor spoil event in the meantime.
593 gp->orphan = g_eli_orphan_spoil_assert;
594 gp->spoiled = g_eli_orphan_spoil_assert;
595 cp = g_new_consumer(gp);
596 error = g_attach(cp, pp);
599 error = g_access(cp, 1, 0, 0);
603 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
608 error = eli_metadata_decode(buf, md);
611 /* Metadata was read and decoded successfully. */
615 if (cp->provider != NULL) {
617 g_access(cp, -1, 0, 0);
620 g_destroy_consumer(cp);
626 * The function is called when we had last close on provider and user requested
627 * to close it when this situation occur.
630 g_eli_last_close(void *arg, int flags __unused)
638 strlcpy(gpname, gp->name, sizeof(gpname));
639 error = g_eli_destroy(gp->softc, TRUE);
640 KASSERT(error == 0, ("Cannot detach %s on last close (error=%d).",
642 G_ELI_DEBUG(0, "Detached %s on last close.", gpname);
646 g_eli_access(struct g_provider *pp, int dr, int dw, int de)
648 struct g_eli_softc *sc;
655 if (sc->sc_flags & G_ELI_FLAG_RO) {
656 /* Deny write attempts. */
659 /* Someone is opening us for write, we need to remember that. */
660 sc->sc_flags |= G_ELI_FLAG_WOPEN;
663 /* Is this the last close? */
664 if (pp->acr + dr > 0 || pp->acw + dw > 0 || pp->ace + de > 0)
668 * Automatically detach on last close if requested.
670 if ((sc->sc_flags & G_ELI_FLAG_RW_DETACH) ||
671 (sc->sc_flags & G_ELI_FLAG_WOPEN)) {
672 g_post_event(g_eli_last_close, gp, M_WAITOK, NULL);
678 g_eli_cpu_is_disabled(int cpu)
681 return (CPU_ISSET(cpu, &hlt_cpus_mask));
688 g_eli_create(struct gctl_req *req, struct g_class *mp, struct g_provider *bpp,
689 const struct g_eli_metadata *md, const u_char *mkey, int nkey)
691 struct g_eli_softc *sc;
692 struct g_eli_worker *wr;
694 struct g_provider *pp;
695 struct g_consumer *cp;
699 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX);
701 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX);
702 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO);
703 gp->start = g_eli_start;
705 * Spoiling can happen even though we have the provider open
706 * exclusively, e.g. through media change events.
708 gp->spoiled = g_eli_orphan;
709 gp->orphan = g_eli_orphan;
710 gp->dumpconf = g_eli_dumpconf;
712 * If detach-on-last-close feature is not enabled and we don't operate
713 * on read-only provider, we can simply use g_std_access().
715 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO))
716 gp->access = g_eli_access;
718 gp->access = g_std_access;
720 eli_metadata_softc(sc, md, bpp->sectorsize, bpp->mediasize);
726 bioq_init(&sc->sc_queue);
727 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF);
728 mtx_init(&sc->sc_ekeys_lock, "geli:ekeys", NULL, MTX_DEF);
731 cp = g_new_consumer(gp);
732 error = g_attach(cp, bpp);
735 gctl_error(req, "Cannot attach to %s (error=%d).",
738 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).",
744 * Keep provider open all the time, so we can run critical tasks,
745 * like Master Keys deletion, without wondering if we can open
747 * We don't open provider for writing only when user requested read-only
750 if (sc->sc_flags & G_ELI_FLAG_RO)
751 error = g_access(cp, 1, 0, 1);
753 error = g_access(cp, 1, 1, 1);
756 gctl_error(req, "Cannot access %s (error=%d).",
759 G_ELI_DEBUG(1, "Cannot access %s (error=%d).",
766 * Remember the keys in our softc structure.
768 g_eli_mkey_propagate(sc, mkey);
770 LIST_INIT(&sc->sc_workers);
772 threads = g_eli_threads;
775 sc->sc_cpubind = (mp_ncpus > 1 && threads == mp_ncpus);
776 for (i = 0; i < threads; i++) {
777 if (g_eli_cpu_is_disabled(i)) {
778 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.",
782 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO);
787 error = g_eli_newsession(wr);
791 gctl_error(req, "Cannot set up crypto session "
792 "for %s (error=%d).", bpp->name, error);
794 G_ELI_DEBUG(1, "Cannot set up crypto session "
795 "for %s (error=%d).", bpp->name, error);
800 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0,
801 "g_eli[%u] %s", i, bpp->name);
803 g_eli_freesession(wr);
806 gctl_error(req, "Cannot create kernel thread "
807 "for %s (error=%d).", bpp->name, error);
809 G_ELI_DEBUG(1, "Cannot create kernel thread "
810 "for %s (error=%d).", bpp->name, error);
814 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next);
818 * Create decrypted provider.
820 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX);
821 pp->mediasize = sc->sc_mediasize;
822 pp->sectorsize = sc->sc_sectorsize;
824 g_error_provider(pp, 0);
826 G_ELI_DEBUG(0, "Device %s created.", pp->name);
827 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo),
829 if (sc->sc_flags & G_ELI_FLAG_AUTH)
830 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo));
831 G_ELI_DEBUG(0, " Crypto: %s",
832 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware");
835 mtx_lock(&sc->sc_queue_mtx);
836 sc->sc_flags |= G_ELI_FLAG_DESTROY;
839 * Wait for kernel threads self destruction.
841 while (!LIST_EMPTY(&sc->sc_workers)) {
842 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
845 mtx_destroy(&sc->sc_queue_mtx);
846 if (cp->provider != NULL) {
848 g_access(cp, -1, -1, -1);
851 g_destroy_consumer(cp);
853 g_eli_key_destroy(sc);
854 bzero(sc, sizeof(*sc));
860 g_eli_destroy(struct g_eli_softc *sc, boolean_t force)
863 struct g_provider *pp;
871 pp = LIST_FIRST(&gp->provider);
872 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
874 G_ELI_DEBUG(1, "Device %s is still open, so it "
875 "cannot be definitely removed.", pp->name);
876 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
877 gp->access = g_eli_access;
878 g_wither_provider(pp, ENXIO);
882 "Device %s is still open (r%dw%de%d).", pp->name,
883 pp->acr, pp->acw, pp->ace);
888 mtx_lock(&sc->sc_queue_mtx);
889 sc->sc_flags |= G_ELI_FLAG_DESTROY;
891 while (!LIST_EMPTY(&sc->sc_workers)) {
892 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
895 mtx_destroy(&sc->sc_queue_mtx);
897 g_eli_key_destroy(sc);
898 bzero(sc, sizeof(*sc));
901 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
902 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name);
903 g_wither_geom_close(gp, ENXIO);
909 g_eli_destroy_geom(struct gctl_req *req __unused,
910 struct g_class *mp __unused, struct g_geom *gp)
912 struct g_eli_softc *sc;
915 return (g_eli_destroy(sc, FALSE));
919 g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider)
921 u_char *keyfile, *data;
922 char *file, name[64];
927 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
928 keyfile = preload_search_by_type(name);
929 if (keyfile == NULL && i == 0) {
931 * If there is only one keyfile, allow simpler name.
933 snprintf(name, sizeof(name), "%s:geli_keyfile", provider);
934 keyfile = preload_search_by_type(name);
937 return (i); /* Return number of loaded keyfiles. */
938 data = preload_fetch_addr(keyfile);
940 G_ELI_DEBUG(0, "Cannot find key file data for %s.",
944 size = preload_fetch_size(keyfile);
946 G_ELI_DEBUG(0, "Cannot find key file size for %s.",
950 file = preload_search_info(keyfile, MODINFO_NAME);
952 G_ELI_DEBUG(0, "Cannot find key file name for %s.",
956 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file,
958 g_eli_crypto_hmac_update(ctx, data, size);
963 g_eli_keyfiles_clear(const char *provider)
965 u_char *keyfile, *data;
971 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
972 keyfile = preload_search_by_type(name);
975 data = preload_fetch_addr(keyfile);
976 size = preload_fetch_size(keyfile);
977 if (data != NULL && size != 0)
983 * Tasting is only made on boot.
984 * We detect providers which should be attached before root is mounted.
986 static struct g_geom *
987 g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
989 struct g_eli_metadata md;
992 char passphrase[256];
993 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
994 u_int i, nkey, nkeyfiles, tries;
997 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
1000 if (root_mounted() || g_eli_tries == 0)
1003 G_ELI_DEBUG(3, "Tasting %s.", pp->name);
1005 error = g_eli_read_metadata(mp, pp, &md);
1010 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0)
1012 if (md.md_version > G_ELI_VERSION) {
1013 printf("geom_eli.ko module is too old to handle %s.\n",
1017 if (md.md_provsize != pp->mediasize)
1019 /* Should we attach it on boot? */
1020 if (!(md.md_flags & G_ELI_FLAG_BOOT))
1022 if (md.md_keys == 0x00) {
1023 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name);
1026 if (md.md_iterations == -1) {
1027 /* If there is no passphrase, we try only once. */
1030 /* Ask for the passphrase no more than g_eli_tries times. */
1031 tries = g_eli_tries;
1034 for (i = 0; i <= tries; i++) {
1035 g_eli_crypto_hmac_init(&ctx, NULL, 0);
1038 * Load all key files.
1040 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name);
1042 if (nkeyfiles == 0 && md.md_iterations == -1) {
1044 * No key files and no passphrase, something is
1045 * definitely wrong here.
1046 * geli(8) doesn't allow for such situation, so assume
1047 * that there was really no passphrase and in that case
1048 * key files are no properly defined in loader.conf.
1051 "Found no key files in loader.conf for %s.",
1056 /* Ask for the passphrase if defined. */
1057 if (md.md_iterations >= 0) {
1058 /* Try first with cached passphrase. */
1060 if (!g_eli_boot_passcache)
1062 memcpy(passphrase, cached_passphrase,
1063 sizeof(passphrase));
1065 printf("Enter passphrase for %s: ", pp->name);
1066 cngets(passphrase, sizeof(passphrase),
1067 g_eli_visible_passphrase);
1068 memcpy(cached_passphrase, passphrase,
1069 sizeof(passphrase));
1074 * Prepare Derived-Key from the user passphrase.
1076 if (md.md_iterations == 0) {
1077 g_eli_crypto_hmac_update(&ctx, md.md_salt,
1078 sizeof(md.md_salt));
1079 g_eli_crypto_hmac_update(&ctx, passphrase,
1080 strlen(passphrase));
1081 bzero(passphrase, sizeof(passphrase));
1082 } else if (md.md_iterations > 0) {
1083 u_char dkey[G_ELI_USERKEYLEN];
1085 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt,
1086 sizeof(md.md_salt), passphrase, md.md_iterations);
1087 bzero(passphrase, sizeof(passphrase));
1088 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey));
1089 bzero(dkey, sizeof(dkey));
1092 g_eli_crypto_hmac_final(&ctx, key, 0);
1095 * Decrypt Master-Key.
1097 error = g_eli_mkey_decrypt(&md, key, mkey, &nkey);
1098 bzero(key, sizeof(key));
1102 "Wrong key for %s. No tries left.",
1104 g_eli_keyfiles_clear(pp->name);
1109 "Wrong key for %s. Tries left: %u.",
1110 pp->name, tries - i);
1114 } else if (error > 0) {
1116 "Cannot decrypt Master Key for %s (error=%d).",
1118 g_eli_keyfiles_clear(pp->name);
1121 g_eli_keyfiles_clear(pp->name);
1122 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name);
1127 * We have correct key, let's attach provider.
1129 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey);
1130 bzero(mkey, sizeof(mkey));
1131 bzero(&md, sizeof(md));
1133 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name,
1141 g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1142 struct g_consumer *cp, struct g_provider *pp)
1144 struct g_eli_softc *sc;
1146 g_topology_assert();
1150 if (pp != NULL || cp != NULL)
1151 return; /* Nothing here. */
1153 sbuf_printf(sb, "%s<KeysTotal>%ju</KeysTotal>\n", indent,
1154 (uintmax_t)sc->sc_ekeys_total);
1155 sbuf_printf(sb, "%s<KeysAllocated>%ju</KeysAllocated>\n", indent,
1156 (uintmax_t)sc->sc_ekeys_allocated);
1157 sbuf_printf(sb, "%s<Flags>", indent);
1158 if (sc->sc_flags == 0)
1159 sbuf_printf(sb, "NONE");
1163 #define ADD_FLAG(flag, name) do { \
1164 if (sc->sc_flags & (flag)) { \
1166 sbuf_printf(sb, ", "); \
1169 sbuf_printf(sb, name); \
1172 ADD_FLAG(G_ELI_FLAG_SUSPEND, "SUSPEND");
1173 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY");
1174 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER");
1175 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME");
1176 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT");
1177 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH");
1178 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH");
1179 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH");
1180 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN");
1181 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY");
1182 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY");
1183 ADD_FLAG(G_ELI_FLAG_NODELETE, "NODELETE");
1184 ADD_FLAG(G_ELI_FLAG_GELIBOOT, "GELIBOOT");
1187 sbuf_printf(sb, "</Flags>\n");
1189 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) {
1190 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent,
1193 sbuf_printf(sb, "%s<Version>%u</Version>\n", indent, sc->sc_version);
1194 sbuf_printf(sb, "%s<Crypto>", indent);
1195 switch (sc->sc_crypto) {
1196 case G_ELI_CRYPTO_HW:
1197 sbuf_printf(sb, "hardware");
1199 case G_ELI_CRYPTO_SW:
1200 sbuf_printf(sb, "software");
1203 sbuf_printf(sb, "UNKNOWN");
1206 sbuf_printf(sb, "</Crypto>\n");
1207 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
1209 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n",
1210 indent, g_eli_algo2str(sc->sc_aalgo));
1212 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent,
1214 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n",
1215 indent, g_eli_algo2str(sc->sc_ealgo));
1216 sbuf_printf(sb, "%s<State>%s</State>\n", indent,
1217 (sc->sc_flags & G_ELI_FLAG_SUSPEND) ? "SUSPENDED" : "ACTIVE");
1221 g_eli_shutdown_pre_sync(void *arg, int howto)
1224 struct g_geom *gp, *gp2;
1225 struct g_provider *pp;
1226 struct g_eli_softc *sc;
1232 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
1236 pp = LIST_FIRST(&gp->provider);
1237 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name));
1238 if (pp->acr + pp->acw + pp->ace == 0)
1239 error = g_eli_destroy(sc, TRUE);
1241 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
1242 gp->access = g_eli_access;
1245 g_topology_unlock();
1250 g_eli_init(struct g_class *mp)
1253 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync,
1254 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST);
1255 if (g_eli_pre_sync == NULL)
1256 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event.");
1260 g_eli_fini(struct g_class *mp)
1263 if (g_eli_pre_sync != NULL)
1264 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync);
1267 DECLARE_GEOM_CLASS(g_eli_class, g_eli);
1268 MODULE_DEPEND(g_eli, crypto, 1, 1, 1);