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 TUNABLE_INT("kern.geom.eli.debug", &g_eli_debug);
67 SYSCTL_INT(_kern_geom_eli, OID_AUTO, debug, CTLFLAG_RW, &g_eli_debug, 0,
69 static u_int g_eli_tries = 3;
70 TUNABLE_INT("kern.geom.eli.tries", &g_eli_tries);
71 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, tries, CTLFLAG_RW, &g_eli_tries, 0,
72 "Number of tries for entering the passphrase");
73 static u_int g_eli_visible_passphrase = GETS_NOECHO;
74 TUNABLE_INT("kern.geom.eli.visible_passphrase", &g_eli_visible_passphrase);
75 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, visible_passphrase, CTLFLAG_RW,
76 &g_eli_visible_passphrase, 0,
77 "Visibility of passphrase prompt (0 = invisible, 1 = visible, 2 = asterisk)");
78 u_int g_eli_overwrites = G_ELI_OVERWRITES;
79 TUNABLE_INT("kern.geom.eli.overwrites", &g_eli_overwrites);
80 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, overwrites, CTLFLAG_RW, &g_eli_overwrites,
81 0, "Number of times on-disk keys should be overwritten when destroying them");
82 static u_int g_eli_threads = 0;
83 TUNABLE_INT("kern.geom.eli.threads", &g_eli_threads);
84 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, threads, CTLFLAG_RW, &g_eli_threads, 0,
85 "Number of threads doing crypto work");
86 u_int g_eli_batch = 0;
87 TUNABLE_INT("kern.geom.eli.batch", &g_eli_batch);
88 SYSCTL_UINT(_kern_geom_eli, OID_AUTO, batch, CTLFLAG_RW, &g_eli_batch, 0,
89 "Use crypto operations batching");
92 * Passphrase cached during boot, in order to be more user-friendly if
93 * there are multiple providers using the same passphrase.
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");
102 fetch_loader_passphrase(void * dummy)
104 char * env_passphrase;
106 KASSERT(dynamic_kenv, ("need dynamic kenv"));
108 if ((env_passphrase = 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);
114 /* Wipe the passphrase from the environment. */
115 unsetenv("kern.geom.eli.passphrase");
118 SYSINIT(geli_fetch_loader_passphrase, SI_SUB_KMEM + 1, SI_ORDER_ANY,
119 fetch_loader_passphrase, NULL);
121 zero_boot_passcache(void * dummy)
124 memset(cached_passphrase, 0, sizeof(cached_passphrase));
126 EVENTHANDLER_DEFINE(mountroot, zero_boot_passcache, NULL, 0);
128 static eventhandler_tag g_eli_pre_sync = NULL;
130 static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp,
132 static void g_eli_init(struct g_class *mp);
133 static void g_eli_fini(struct g_class *mp);
135 static g_taste_t g_eli_taste;
136 static g_dumpconf_t g_eli_dumpconf;
138 struct g_class g_eli_class = {
139 .name = G_ELI_CLASS_NAME,
140 .version = G_VERSION,
141 .ctlreq = g_eli_config,
142 .taste = g_eli_taste,
143 .destroy_geom = g_eli_destroy_geom,
152 * 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
154 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
159 * EAGAIN from crypto(9) means, that we were probably balanced to another crypto
160 * accelerator or something like this.
161 * The function updates the SID and rerun the operation.
164 g_eli_crypto_rerun(struct cryptop *crp)
166 struct g_eli_softc *sc;
167 struct g_eli_worker *wr;
171 bp = (struct bio *)crp->crp_opaque;
172 sc = bp->bio_to->geom->softc;
173 LIST_FOREACH(wr, &sc->sc_workers, w_next) {
174 if (wr->w_number == bp->bio_pflags)
177 KASSERT(wr != NULL, ("Invalid worker (%u).", bp->bio_pflags));
178 G_ELI_DEBUG(1, "Rerunning crypto %s request (sid: %ju -> %ju).",
179 bp->bio_cmd == BIO_READ ? "READ" : "WRITE", (uintmax_t)wr->w_sid,
180 (uintmax_t)crp->crp_sid);
181 wr->w_sid = crp->crp_sid;
183 error = crypto_dispatch(crp);
186 G_ELI_DEBUG(1, "%s: crypto_dispatch() returned %d.", __func__, error);
187 crp->crp_etype = error;
192 * The function is called afer reading encrypted data from the provider.
194 * 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
197 g_eli_read_done(struct bio *bp)
199 struct g_eli_softc *sc;
202 G_ELI_LOGREQ(2, bp, "Request done.");
203 pbp = bp->bio_parent;
204 if (pbp->bio_error == 0)
205 pbp->bio_error = bp->bio_error;
208 * Do we have all sectors already?
211 if (pbp->bio_inbed < pbp->bio_children)
213 sc = pbp->bio_to->geom->softc;
214 if (pbp->bio_error != 0) {
215 G_ELI_LOGREQ(0, pbp, "%s() failed", __func__);
216 pbp->bio_completed = 0;
217 if (pbp->bio_driver2 != NULL) {
218 free(pbp->bio_driver2, M_ELI);
219 pbp->bio_driver2 = NULL;
221 g_io_deliver(pbp, pbp->bio_error);
222 atomic_subtract_int(&sc->sc_inflight, 1);
225 mtx_lock(&sc->sc_queue_mtx);
226 bioq_insert_tail(&sc->sc_queue, pbp);
227 mtx_unlock(&sc->sc_queue_mtx);
232 * The function is called after we encrypt and write data.
234 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> G_ELI_WRITE_DONE -> g_io_deliver
237 g_eli_write_done(struct bio *bp)
239 struct g_eli_softc *sc;
242 G_ELI_LOGREQ(2, bp, "Request done.");
243 pbp = bp->bio_parent;
244 if (pbp->bio_error == 0) {
245 if (bp->bio_error != 0)
246 pbp->bio_error = bp->bio_error;
250 * Do we have all sectors already?
253 if (pbp->bio_inbed < pbp->bio_children)
255 free(pbp->bio_driver2, M_ELI);
256 pbp->bio_driver2 = NULL;
257 if (pbp->bio_error != 0) {
258 G_ELI_LOGREQ(0, pbp, "Crypto WRITE request failed (error=%d).",
260 pbp->bio_completed = 0;
263 * Write is finished, send it up.
265 pbp->bio_completed = pbp->bio_length;
266 sc = pbp->bio_to->geom->softc;
267 g_io_deliver(pbp, pbp->bio_error);
268 atomic_subtract_int(&sc->sc_inflight, 1);
272 * This function should never be called, but GEOM made as it set ->orphan()
273 * method for every geom.
276 g_eli_orphan_spoil_assert(struct g_consumer *cp)
279 panic("Function %s() called for %s.", __func__, cp->geom->name);
283 g_eli_orphan(struct g_consumer *cp)
285 struct g_eli_softc *sc;
288 sc = cp->geom->softc;
291 g_eli_destroy(sc, TRUE);
296 * 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
298 * G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
301 g_eli_start(struct bio *bp)
303 struct g_eli_softc *sc;
304 struct g_consumer *cp;
307 sc = bp->bio_to->geom->softc;
309 ("Provider's error should be set (error=%d)(device=%s).",
310 bp->bio_to->error, bp->bio_to->name));
311 G_ELI_LOGREQ(2, bp, "Request received.");
313 switch (bp->bio_cmd) {
321 * We could eventually support BIO_DELETE request.
322 * It could be done by overwritting requested sector with
323 * random data g_eli_overwrites number of times.
326 g_io_deliver(bp, EOPNOTSUPP);
329 cbp = g_clone_bio(bp);
331 g_io_deliver(bp, ENOMEM);
334 bp->bio_driver1 = cbp;
335 bp->bio_pflags = G_ELI_NEW_BIO;
336 switch (bp->bio_cmd) {
338 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) {
339 g_eli_crypto_read(sc, bp, 0);
344 mtx_lock(&sc->sc_queue_mtx);
345 bioq_insert_tail(&sc->sc_queue, bp);
346 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 * Here we generate IV. It is unique for every sector.
578 g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
583 if ((sc->sc_flags & G_ELI_FLAG_NATIVE_BYTE_ORDER) != 0)
584 bcopy(&offset, off, sizeof(off));
586 le64enc(off, (uint64_t)offset);
588 switch (sc->sc_ealgo) {
590 bcopy(off, iv, sizeof(off));
591 bzero(iv + sizeof(off), size - sizeof(off));
595 u_char hash[SHA256_DIGEST_LENGTH];
598 /* Copy precalculated SHA256 context for IV-Key. */
599 bcopy(&sc->sc_ivctx, &ctx, sizeof(ctx));
600 SHA256_Update(&ctx, off, sizeof(off));
601 SHA256_Final(hash, &ctx);
602 bcopy(hash, iv, MIN(sizeof(hash), size));
609 g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
610 struct g_eli_metadata *md)
613 struct g_consumer *cp;
619 gp = g_new_geomf(mp, "eli:taste");
620 gp->start = g_eli_start;
621 gp->access = g_std_access;
623 * g_eli_read_metadata() is always called from the event thread.
624 * Our geom is created and destroyed in the same event, so there
625 * could be no orphan nor spoil event in the meantime.
627 gp->orphan = g_eli_orphan_spoil_assert;
628 gp->spoiled = g_eli_orphan_spoil_assert;
629 cp = g_new_consumer(gp);
630 error = g_attach(cp, pp);
633 error = g_access(cp, 1, 0, 0);
637 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
642 eli_metadata_decode(buf, md);
646 if (cp->provider != NULL) {
648 g_access(cp, -1, 0, 0);
651 g_destroy_consumer(cp);
657 * The function is called when we had last close on provider and user requested
658 * to close it when this situation occur.
661 g_eli_last_close(void *arg, int flags __unused)
669 strlcpy(gpname, gp->name, sizeof(gpname));
670 error = g_eli_destroy(gp->softc, TRUE);
671 KASSERT(error == 0, ("Cannot detach %s on last close (error=%d).",
673 G_ELI_DEBUG(0, "Detached %s on last close.", gpname);
677 g_eli_access(struct g_provider *pp, int dr, int dw, int de)
679 struct g_eli_softc *sc;
686 if (sc->sc_flags & G_ELI_FLAG_RO) {
687 /* Deny write attempts. */
690 /* Someone is opening us for write, we need to remember that. */
691 sc->sc_flags |= G_ELI_FLAG_WOPEN;
694 /* Is this the last close? */
695 if (pp->acr + dr > 0 || pp->acw + dw > 0 || pp->ace + de > 0)
699 * Automatically detach on last close if requested.
701 if ((sc->sc_flags & G_ELI_FLAG_RW_DETACH) ||
702 (sc->sc_flags & G_ELI_FLAG_WOPEN)) {
703 g_post_event(g_eli_last_close, gp, M_WAITOK, NULL);
709 g_eli_cpu_is_disabled(int cpu)
712 return (CPU_ISSET(cpu, &hlt_cpus_mask));
719 g_eli_create(struct gctl_req *req, struct g_class *mp, struct g_provider *bpp,
720 const struct g_eli_metadata *md, const u_char *mkey, int nkey)
722 struct g_eli_softc *sc;
723 struct g_eli_worker *wr;
725 struct g_provider *pp;
726 struct g_consumer *cp;
730 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX);
732 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX);
733 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO);
734 gp->start = g_eli_start;
736 * Spoiling cannot happen actually, because we keep provider open for
737 * writing all the time or provider is read-only.
739 gp->spoiled = g_eli_orphan_spoil_assert;
740 gp->orphan = g_eli_orphan;
741 gp->dumpconf = g_eli_dumpconf;
743 * If detach-on-last-close feature is not enabled and we don't operate
744 * on read-only provider, we can simply use g_std_access().
746 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO))
747 gp->access = g_eli_access;
749 gp->access = g_std_access;
751 sc->sc_version = md->md_version;
753 sc->sc_crypto = G_ELI_CRYPTO_UNKNOWN;
754 sc->sc_flags = md->md_flags;
755 /* Backward compatibility. */
756 if (md->md_version < G_ELI_VERSION_04)
757 sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER;
758 if (md->md_version < G_ELI_VERSION_05)
759 sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY;
760 if (md->md_version < G_ELI_VERSION_06 &&
761 (sc->sc_flags & G_ELI_FLAG_AUTH) != 0) {
762 sc->sc_flags |= G_ELI_FLAG_FIRST_KEY;
764 if (md->md_version < G_ELI_VERSION_07)
765 sc->sc_flags |= G_ELI_FLAG_ENC_IVKEY;
766 sc->sc_ealgo = md->md_ealgo;
769 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
770 sc->sc_akeylen = sizeof(sc->sc_akey) * 8;
771 sc->sc_aalgo = md->md_aalgo;
772 sc->sc_alen = g_eli_hashlen(sc->sc_aalgo);
774 sc->sc_data_per_sector = bpp->sectorsize - sc->sc_alen;
776 * Some hash functions (like SHA1 and RIPEMD160) generates hash
777 * which length is not multiple of 128 bits, but we want data
778 * length to be multiple of 128, so we can encrypt without
779 * padding. The line below rounds down data length to multiple
782 sc->sc_data_per_sector -= sc->sc_data_per_sector % 16;
784 sc->sc_bytes_per_sector =
785 (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1;
786 sc->sc_bytes_per_sector *= bpp->sectorsize;
792 bioq_init(&sc->sc_queue);
793 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF);
794 mtx_init(&sc->sc_ekeys_lock, "geli:ekeys", NULL, MTX_DEF);
797 cp = g_new_consumer(gp);
798 error = g_attach(cp, bpp);
801 gctl_error(req, "Cannot attach to %s (error=%d).",
804 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).",
810 * Keep provider open all the time, so we can run critical tasks,
811 * like Master Keys deletion, without wondering if we can open
813 * We don't open provider for writing only when user requested read-only
816 if (sc->sc_flags & G_ELI_FLAG_RO)
817 error = g_access(cp, 1, 0, 1);
819 error = g_access(cp, 1, 1, 1);
822 gctl_error(req, "Cannot access %s (error=%d).",
825 G_ELI_DEBUG(1, "Cannot access %s (error=%d).",
831 sc->sc_sectorsize = md->md_sectorsize;
832 sc->sc_mediasize = bpp->mediasize;
833 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME))
834 sc->sc_mediasize -= bpp->sectorsize;
835 if (!(sc->sc_flags & G_ELI_FLAG_AUTH))
836 sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize);
838 sc->sc_mediasize /= sc->sc_bytes_per_sector;
839 sc->sc_mediasize *= sc->sc_sectorsize;
843 * Remember the keys in our softc structure.
845 g_eli_mkey_propagate(sc, mkey);
846 sc->sc_ekeylen = md->md_keylen;
848 LIST_INIT(&sc->sc_workers);
850 threads = g_eli_threads;
853 sc->sc_cpubind = (mp_ncpus > 1 && threads == mp_ncpus);
854 for (i = 0; i < threads; i++) {
855 if (g_eli_cpu_is_disabled(i)) {
856 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.",
860 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO);
865 error = g_eli_newsession(wr);
869 gctl_error(req, "Cannot set up crypto session "
870 "for %s (error=%d).", bpp->name, error);
872 G_ELI_DEBUG(1, "Cannot set up crypto session "
873 "for %s (error=%d).", bpp->name, error);
878 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0,
879 "g_eli[%u] %s", i, bpp->name);
881 g_eli_freesession(wr);
884 gctl_error(req, "Cannot create kernel thread "
885 "for %s (error=%d).", bpp->name, error);
887 G_ELI_DEBUG(1, "Cannot create kernel thread "
888 "for %s (error=%d).", bpp->name, error);
892 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next);
896 * Create decrypted provider.
898 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX);
899 pp->mediasize = sc->sc_mediasize;
900 pp->sectorsize = sc->sc_sectorsize;
902 g_error_provider(pp, 0);
904 G_ELI_DEBUG(0, "Device %s created.", pp->name);
905 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo),
907 if (sc->sc_flags & G_ELI_FLAG_AUTH)
908 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo));
909 G_ELI_DEBUG(0, " Crypto: %s",
910 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware");
913 mtx_lock(&sc->sc_queue_mtx);
914 sc->sc_flags |= G_ELI_FLAG_DESTROY;
917 * Wait for kernel threads self destruction.
919 while (!LIST_EMPTY(&sc->sc_workers)) {
920 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
923 mtx_destroy(&sc->sc_queue_mtx);
924 if (cp->provider != NULL) {
926 g_access(cp, -1, -1, -1);
929 g_destroy_consumer(cp);
931 g_eli_key_destroy(sc);
932 bzero(sc, sizeof(*sc));
938 g_eli_destroy(struct g_eli_softc *sc, boolean_t force)
941 struct g_provider *pp;
949 pp = LIST_FIRST(&gp->provider);
950 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
952 G_ELI_DEBUG(1, "Device %s is still open, so it "
953 "cannot be definitely removed.", pp->name);
954 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
955 gp->access = g_eli_access;
956 g_wither_provider(pp, ENXIO);
960 "Device %s is still open (r%dw%de%d).", pp->name,
961 pp->acr, pp->acw, pp->ace);
966 mtx_lock(&sc->sc_queue_mtx);
967 sc->sc_flags |= G_ELI_FLAG_DESTROY;
969 while (!LIST_EMPTY(&sc->sc_workers)) {
970 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
973 mtx_destroy(&sc->sc_queue_mtx);
975 g_eli_key_destroy(sc);
976 bzero(sc, sizeof(*sc));
979 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
980 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name);
981 g_wither_geom_close(gp, ENXIO);
987 g_eli_destroy_geom(struct gctl_req *req __unused,
988 struct g_class *mp __unused, struct g_geom *gp)
990 struct g_eli_softc *sc;
993 return (g_eli_destroy(sc, FALSE));
997 g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider)
999 u_char *keyfile, *data;
1000 char *file, name[64];
1004 for (i = 0; ; i++) {
1005 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
1006 keyfile = preload_search_by_type(name);
1007 if (keyfile == NULL)
1008 return (i); /* Return number of loaded keyfiles. */
1009 data = preload_fetch_addr(keyfile);
1011 G_ELI_DEBUG(0, "Cannot find key file data for %s.",
1015 size = preload_fetch_size(keyfile);
1017 G_ELI_DEBUG(0, "Cannot find key file size for %s.",
1021 file = preload_search_info(keyfile, MODINFO_NAME);
1023 G_ELI_DEBUG(0, "Cannot find key file name for %s.",
1027 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file,
1029 g_eli_crypto_hmac_update(ctx, data, size);
1034 g_eli_keyfiles_clear(const char *provider)
1036 u_char *keyfile, *data;
1041 for (i = 0; ; i++) {
1042 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
1043 keyfile = preload_search_by_type(name);
1044 if (keyfile == NULL)
1046 data = preload_fetch_addr(keyfile);
1047 size = preload_fetch_size(keyfile);
1048 if (data != NULL && size != 0)
1054 * Tasting is only made on boot.
1055 * We detect providers which should be attached before root is mounted.
1057 static struct g_geom *
1058 g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
1060 struct g_eli_metadata md;
1062 struct hmac_ctx ctx;
1063 char passphrase[256];
1064 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
1065 u_int i, nkey, nkeyfiles, tries;
1068 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
1069 g_topology_assert();
1071 if (root_mounted() || g_eli_tries == 0)
1074 G_ELI_DEBUG(3, "Tasting %s.", pp->name);
1076 error = g_eli_read_metadata(mp, pp, &md);
1081 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0)
1083 if (md.md_version > G_ELI_VERSION) {
1084 printf("geom_eli.ko module is too old to handle %s.\n",
1088 if (md.md_provsize != pp->mediasize)
1090 /* Should we attach it on boot? */
1091 if (!(md.md_flags & G_ELI_FLAG_BOOT))
1093 if (md.md_keys == 0x00) {
1094 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name);
1097 if (md.md_iterations == -1) {
1098 /* If there is no passphrase, we try only once. */
1101 /* Ask for the passphrase no more than g_eli_tries times. */
1102 tries = g_eli_tries;
1105 for (i = 0; i <= tries; i++) {
1106 g_eli_crypto_hmac_init(&ctx, NULL, 0);
1109 * Load all key files.
1111 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name);
1113 if (nkeyfiles == 0 && md.md_iterations == -1) {
1115 * No key files and no passphrase, something is
1116 * definitely wrong here.
1117 * geli(8) doesn't allow for such situation, so assume
1118 * that there was really no passphrase and in that case
1119 * key files are no properly defined in loader.conf.
1122 "Found no key files in loader.conf for %s.",
1127 /* Ask for the passphrase if defined. */
1128 if (md.md_iterations >= 0) {
1129 /* Try first with cached passphrase. */
1131 if (!g_eli_boot_passcache)
1133 memcpy(passphrase, cached_passphrase,
1134 sizeof(passphrase));
1136 printf("Enter passphrase for %s: ", pp->name);
1137 cngets(passphrase, sizeof(passphrase),
1138 g_eli_visible_passphrase);
1139 memcpy(cached_passphrase, passphrase,
1140 sizeof(passphrase));
1145 * Prepare Derived-Key from the user passphrase.
1147 if (md.md_iterations == 0) {
1148 g_eli_crypto_hmac_update(&ctx, md.md_salt,
1149 sizeof(md.md_salt));
1150 g_eli_crypto_hmac_update(&ctx, passphrase,
1151 strlen(passphrase));
1152 bzero(passphrase, sizeof(passphrase));
1153 } else if (md.md_iterations > 0) {
1154 u_char dkey[G_ELI_USERKEYLEN];
1156 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt,
1157 sizeof(md.md_salt), passphrase, md.md_iterations);
1158 bzero(passphrase, sizeof(passphrase));
1159 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey));
1160 bzero(dkey, sizeof(dkey));
1163 g_eli_crypto_hmac_final(&ctx, key, 0);
1166 * Decrypt Master-Key.
1168 error = g_eli_mkey_decrypt(&md, key, mkey, &nkey);
1169 bzero(key, sizeof(key));
1173 "Wrong key for %s. No tries left.",
1175 g_eli_keyfiles_clear(pp->name);
1180 "Wrong key for %s. Tries left: %u.",
1181 pp->name, tries - i);
1185 } else if (error > 0) {
1187 "Cannot decrypt Master Key for %s (error=%d).",
1189 g_eli_keyfiles_clear(pp->name);
1192 g_eli_keyfiles_clear(pp->name);
1193 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name);
1198 * We have correct key, let's attach provider.
1200 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey);
1201 bzero(mkey, sizeof(mkey));
1202 bzero(&md, sizeof(md));
1204 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name,
1212 g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1213 struct g_consumer *cp, struct g_provider *pp)
1215 struct g_eli_softc *sc;
1217 g_topology_assert();
1221 if (pp != NULL || cp != NULL)
1222 return; /* Nothing here. */
1224 sbuf_printf(sb, "%s<KeysTotal>%ju</KeysTotal>\n", indent,
1225 (uintmax_t)sc->sc_ekeys_total);
1226 sbuf_printf(sb, "%s<KeysAllocated>%ju</KeysAllocated>\n", indent,
1227 (uintmax_t)sc->sc_ekeys_allocated);
1228 sbuf_printf(sb, "%s<Flags>", indent);
1229 if (sc->sc_flags == 0)
1230 sbuf_printf(sb, "NONE");
1234 #define ADD_FLAG(flag, name) do { \
1235 if (sc->sc_flags & (flag)) { \
1237 sbuf_printf(sb, ", "); \
1240 sbuf_printf(sb, name); \
1243 ADD_FLAG(G_ELI_FLAG_SUSPEND, "SUSPEND");
1244 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY");
1245 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER");
1246 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME");
1247 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT");
1248 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH");
1249 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH");
1250 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH");
1251 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN");
1252 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY");
1253 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY");
1256 sbuf_printf(sb, "</Flags>\n");
1258 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) {
1259 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent,
1262 sbuf_printf(sb, "%s<Version>%u</Version>\n", indent, sc->sc_version);
1263 sbuf_printf(sb, "%s<Crypto>", indent);
1264 switch (sc->sc_crypto) {
1265 case G_ELI_CRYPTO_HW:
1266 sbuf_printf(sb, "hardware");
1268 case G_ELI_CRYPTO_SW:
1269 sbuf_printf(sb, "software");
1272 sbuf_printf(sb, "UNKNOWN");
1275 sbuf_printf(sb, "</Crypto>\n");
1276 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
1278 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n",
1279 indent, g_eli_algo2str(sc->sc_aalgo));
1281 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent,
1283 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n",
1284 indent, g_eli_algo2str(sc->sc_ealgo));
1285 sbuf_printf(sb, "%s<State>%s</State>\n", indent,
1286 (sc->sc_flags & G_ELI_FLAG_SUSPEND) ? "SUSPENDED" : "ACTIVE");
1290 g_eli_shutdown_pre_sync(void *arg, int howto)
1293 struct g_geom *gp, *gp2;
1294 struct g_provider *pp;
1295 struct g_eli_softc *sc;
1301 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
1305 pp = LIST_FIRST(&gp->provider);
1306 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name));
1307 if (pp->acr + pp->acw + pp->ace == 0)
1308 error = g_eli_destroy(sc, TRUE);
1310 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
1311 gp->access = g_eli_access;
1314 g_topology_unlock();
1319 g_eli_init(struct g_class *mp)
1322 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync,
1323 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST);
1324 if (g_eli_pre_sync == NULL)
1325 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event.");
1329 g_eli_fini(struct g_class *mp)
1332 if (g_eli_pre_sync != NULL)
1333 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync);
1336 DECLARE_GEOM_CLASS(g_eli_class, g_eli);
1337 MODULE_DEPEND(g_eli, crypto, 1, 1, 1);