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");
91 static eventhandler_tag g_eli_pre_sync = NULL;
93 static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp,
95 static void g_eli_init(struct g_class *mp);
96 static void g_eli_fini(struct g_class *mp);
98 static g_taste_t g_eli_taste;
99 static g_dumpconf_t g_eli_dumpconf;
101 struct g_class g_eli_class = {
102 .name = G_ELI_CLASS_NAME,
103 .version = G_VERSION,
104 .ctlreq = g_eli_config,
105 .taste = g_eli_taste,
106 .destroy_geom = g_eli_destroy_geom,
115 * 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
117 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
122 * EAGAIN from crypto(9) means, that we were probably balanced to another crypto
123 * accelerator or something like this.
124 * The function updates the SID and rerun the operation.
127 g_eli_crypto_rerun(struct cryptop *crp)
129 struct g_eli_softc *sc;
130 struct g_eli_worker *wr;
134 bp = (struct bio *)crp->crp_opaque;
135 sc = bp->bio_to->geom->softc;
136 LIST_FOREACH(wr, &sc->sc_workers, w_next) {
137 if (wr->w_number == bp->bio_pflags)
140 KASSERT(wr != NULL, ("Invalid worker (%u).", bp->bio_pflags));
141 G_ELI_DEBUG(1, "Rerunning crypto %s request (sid: %ju -> %ju).",
142 bp->bio_cmd == BIO_READ ? "READ" : "WRITE", (uintmax_t)wr->w_sid,
143 (uintmax_t)crp->crp_sid);
144 wr->w_sid = crp->crp_sid;
146 error = crypto_dispatch(crp);
149 G_ELI_DEBUG(1, "%s: crypto_dispatch() returned %d.", __func__, error);
150 crp->crp_etype = error;
155 * The function is called afer reading encrypted data from the provider.
157 * 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
160 g_eli_read_done(struct bio *bp)
162 struct g_eli_softc *sc;
165 G_ELI_LOGREQ(2, bp, "Request done.");
166 pbp = bp->bio_parent;
167 if (pbp->bio_error == 0)
168 pbp->bio_error = bp->bio_error;
171 * Do we have all sectors already?
174 if (pbp->bio_inbed < pbp->bio_children)
176 sc = pbp->bio_to->geom->softc;
177 if (pbp->bio_error != 0) {
178 G_ELI_LOGREQ(0, pbp, "%s() failed", __func__);
179 pbp->bio_completed = 0;
180 if (pbp->bio_driver2 != NULL) {
181 free(pbp->bio_driver2, M_ELI);
182 pbp->bio_driver2 = NULL;
184 g_io_deliver(pbp, pbp->bio_error);
185 atomic_subtract_int(&sc->sc_inflight, 1);
188 mtx_lock(&sc->sc_queue_mtx);
189 bioq_insert_tail(&sc->sc_queue, pbp);
190 mtx_unlock(&sc->sc_queue_mtx);
195 * The function is called after we encrypt and write data.
197 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> G_ELI_WRITE_DONE -> g_io_deliver
200 g_eli_write_done(struct bio *bp)
202 struct g_eli_softc *sc;
205 G_ELI_LOGREQ(2, bp, "Request done.");
206 pbp = bp->bio_parent;
207 if (pbp->bio_error == 0) {
208 if (bp->bio_error != 0)
209 pbp->bio_error = bp->bio_error;
213 * Do we have all sectors already?
216 if (pbp->bio_inbed < pbp->bio_children)
218 free(pbp->bio_driver2, M_ELI);
219 pbp->bio_driver2 = NULL;
220 if (pbp->bio_error != 0) {
221 G_ELI_LOGREQ(0, pbp, "Crypto WRITE request failed (error=%d).",
223 pbp->bio_completed = 0;
226 * Write is finished, send it up.
228 pbp->bio_completed = pbp->bio_length;
229 sc = pbp->bio_to->geom->softc;
230 g_io_deliver(pbp, pbp->bio_error);
231 atomic_subtract_int(&sc->sc_inflight, 1);
235 * This function should never be called, but GEOM made as it set ->orphan()
236 * method for every geom.
239 g_eli_orphan_spoil_assert(struct g_consumer *cp)
242 panic("Function %s() called for %s.", __func__, cp->geom->name);
246 g_eli_orphan(struct g_consumer *cp)
248 struct g_eli_softc *sc;
251 sc = cp->geom->softc;
254 g_eli_destroy(sc, TRUE);
259 * 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
261 * G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
264 g_eli_start(struct bio *bp)
266 struct g_eli_softc *sc;
267 struct g_consumer *cp;
270 sc = bp->bio_to->geom->softc;
272 ("Provider's error should be set (error=%d)(device=%s).",
273 bp->bio_to->error, bp->bio_to->name));
274 G_ELI_LOGREQ(2, bp, "Request received.");
276 switch (bp->bio_cmd) {
284 * We could eventually support BIO_DELETE request.
285 * It could be done by overwritting requested sector with
286 * random data g_eli_overwrites number of times.
289 g_io_deliver(bp, EOPNOTSUPP);
292 cbp = g_clone_bio(bp);
294 g_io_deliver(bp, ENOMEM);
297 bp->bio_driver1 = cbp;
298 bp->bio_pflags = G_ELI_NEW_BIO;
299 switch (bp->bio_cmd) {
301 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) {
302 g_eli_crypto_read(sc, bp, 0);
307 mtx_lock(&sc->sc_queue_mtx);
308 bioq_insert_tail(&sc->sc_queue, bp);
309 mtx_unlock(&sc->sc_queue_mtx);
314 cbp->bio_done = g_std_done;
315 cp = LIST_FIRST(&sc->sc_geom->consumer);
316 cbp->bio_to = cp->provider;
317 G_ELI_LOGREQ(2, cbp, "Sending request.");
318 g_io_request(cbp, cp);
324 g_eli_newsession(struct g_eli_worker *wr)
326 struct g_eli_softc *sc;
327 struct cryptoini crie, cria;
332 bzero(&crie, sizeof(crie));
333 crie.cri_alg = sc->sc_ealgo;
334 crie.cri_klen = sc->sc_ekeylen;
335 if (sc->sc_ealgo == CRYPTO_AES_XTS)
337 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0) {
338 crie.cri_key = g_eli_key_hold(sc, 0,
339 LIST_FIRST(&sc->sc_geom->consumer)->provider->sectorsize);
341 crie.cri_key = sc->sc_ekey;
343 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
344 bzero(&cria, sizeof(cria));
345 cria.cri_alg = sc->sc_aalgo;
346 cria.cri_klen = sc->sc_akeylen;
347 cria.cri_key = sc->sc_akey;
348 crie.cri_next = &cria;
351 switch (sc->sc_crypto) {
352 case G_ELI_CRYPTO_SW:
353 error = crypto_newsession(&wr->w_sid, &crie,
354 CRYPTOCAP_F_SOFTWARE);
356 case G_ELI_CRYPTO_HW:
357 error = crypto_newsession(&wr->w_sid, &crie,
358 CRYPTOCAP_F_HARDWARE);
360 case G_ELI_CRYPTO_UNKNOWN:
361 error = crypto_newsession(&wr->w_sid, &crie,
362 CRYPTOCAP_F_HARDWARE);
364 mtx_lock(&sc->sc_queue_mtx);
365 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN)
366 sc->sc_crypto = G_ELI_CRYPTO_HW;
367 mtx_unlock(&sc->sc_queue_mtx);
369 error = crypto_newsession(&wr->w_sid, &crie,
370 CRYPTOCAP_F_SOFTWARE);
371 mtx_lock(&sc->sc_queue_mtx);
372 if (sc->sc_crypto == G_ELI_CRYPTO_UNKNOWN)
373 sc->sc_crypto = G_ELI_CRYPTO_SW;
374 mtx_unlock(&sc->sc_queue_mtx);
378 panic("%s: invalid condition", __func__);
381 if ((sc->sc_flags & G_ELI_FLAG_FIRST_KEY) != 0)
382 g_eli_key_drop(sc, crie.cri_key);
388 g_eli_freesession(struct g_eli_worker *wr)
391 crypto_freesession(wr->w_sid);
395 g_eli_cancel(struct g_eli_softc *sc)
399 mtx_assert(&sc->sc_queue_mtx, MA_OWNED);
401 while ((bp = bioq_takefirst(&sc->sc_queue)) != NULL) {
402 KASSERT(bp->bio_pflags == G_ELI_NEW_BIO,
403 ("Not new bio when canceling (bp=%p).", bp));
404 g_io_deliver(bp, ENXIO);
409 g_eli_takefirst(struct g_eli_softc *sc)
413 mtx_assert(&sc->sc_queue_mtx, MA_OWNED);
415 if (!(sc->sc_flags & G_ELI_FLAG_SUSPEND))
416 return (bioq_takefirst(&sc->sc_queue));
418 * Device suspended, so we skip new I/O requests.
420 TAILQ_FOREACH(bp, &sc->sc_queue.queue, bio_queue) {
421 if (bp->bio_pflags != G_ELI_NEW_BIO)
425 bioq_remove(&sc->sc_queue, bp);
430 * This is the main function for kernel worker thread when we don't have
431 * hardware acceleration and we have to do cryptography in software.
432 * Dedicated thread is needed, so we don't slow down g_up/g_down GEOM
433 * threads with crypto work.
436 g_eli_worker(void *arg)
438 struct g_eli_softc *sc;
439 struct g_eli_worker *wr;
446 /* Before sched_bind() to a CPU, wait for all CPUs to go on-line. */
447 if (sc->sc_cpubind) {
449 tsleep(wr, 0, "geli:smp", hz / 4);
452 thread_lock(curthread);
453 sched_prio(curthread, PUSER);
455 sched_bind(curthread, wr->w_number % mp_ncpus);
456 thread_unlock(curthread);
458 G_ELI_DEBUG(1, "Thread %s started.", curthread->td_proc->p_comm);
461 mtx_lock(&sc->sc_queue_mtx);
463 bp = g_eli_takefirst(sc);
465 if (sc->sc_flags & G_ELI_FLAG_DESTROY) {
467 LIST_REMOVE(wr, w_next);
468 g_eli_freesession(wr);
470 G_ELI_DEBUG(1, "Thread %s exiting.",
471 curthread->td_proc->p_comm);
472 wakeup(&sc->sc_workers);
473 mtx_unlock(&sc->sc_queue_mtx);
476 while (sc->sc_flags & G_ELI_FLAG_SUSPEND) {
477 if (sc->sc_inflight > 0) {
478 G_ELI_DEBUG(0, "inflight=%d",
481 * We still have inflight BIOs, so
484 msleep(sc, &sc->sc_queue_mtx, PRIBIO,
489 * Suspend requested, mark the worker as
490 * suspended and go to sleep.
493 g_eli_freesession(wr);
494 wr->w_active = FALSE;
496 wakeup(&sc->sc_workers);
497 msleep(sc, &sc->sc_queue_mtx, PRIBIO,
500 !(sc->sc_flags & G_ELI_FLAG_SUSPEND)) {
501 error = g_eli_newsession(wr);
503 ("g_eli_newsession() failed on resume (error=%d)",
509 msleep(sc, &sc->sc_queue_mtx, PDROP, "geli:w", 0);
512 if (bp->bio_pflags == G_ELI_NEW_BIO)
513 atomic_add_int(&sc->sc_inflight, 1);
514 mtx_unlock(&sc->sc_queue_mtx);
515 if (bp->bio_pflags == G_ELI_NEW_BIO) {
517 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
518 if (bp->bio_cmd == BIO_READ)
519 g_eli_auth_read(sc, bp);
521 g_eli_auth_run(wr, bp);
523 if (bp->bio_cmd == BIO_READ)
524 g_eli_crypto_read(sc, bp, 1);
526 g_eli_crypto_run(wr, bp);
529 if (sc->sc_flags & G_ELI_FLAG_AUTH)
530 g_eli_auth_run(wr, bp);
532 g_eli_crypto_run(wr, bp);
538 * Here we generate IV. It is unique for every sector.
541 g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
546 if ((sc->sc_flags & G_ELI_FLAG_NATIVE_BYTE_ORDER) != 0)
547 bcopy(&offset, off, sizeof(off));
549 le64enc(off, (uint64_t)offset);
551 switch (sc->sc_ealgo) {
553 bcopy(off, iv, sizeof(off));
554 bzero(iv + sizeof(off), size - sizeof(off));
558 u_char hash[SHA256_DIGEST_LENGTH];
561 /* Copy precalculated SHA256 context for IV-Key. */
562 bcopy(&sc->sc_ivctx, &ctx, sizeof(ctx));
563 SHA256_Update(&ctx, off, sizeof(off));
564 SHA256_Final(hash, &ctx);
565 bcopy(hash, iv, MIN(sizeof(hash), size));
572 g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
573 struct g_eli_metadata *md)
576 struct g_consumer *cp;
582 gp = g_new_geomf(mp, "eli:taste");
583 gp->start = g_eli_start;
584 gp->access = g_std_access;
586 * g_eli_read_metadata() is always called from the event thread.
587 * Our geom is created and destroyed in the same event, so there
588 * could be no orphan nor spoil event in the meantime.
590 gp->orphan = g_eli_orphan_spoil_assert;
591 gp->spoiled = g_eli_orphan_spoil_assert;
592 cp = g_new_consumer(gp);
593 error = g_attach(cp, pp);
596 error = g_access(cp, 1, 0, 0);
600 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
605 eli_metadata_decode(buf, md);
609 if (cp->provider != NULL) {
611 g_access(cp, -1, 0, 0);
614 g_destroy_consumer(cp);
620 * The function is called when we had last close on provider and user requested
621 * to close it when this situation occur.
624 g_eli_last_close(void *arg, int flags __unused)
632 strlcpy(gpname, gp->name, sizeof(gpname));
633 error = g_eli_destroy(gp->softc, TRUE);
634 KASSERT(error == 0, ("Cannot detach %s on last close (error=%d).",
636 G_ELI_DEBUG(0, "Detached %s on last close.", gpname);
640 g_eli_access(struct g_provider *pp, int dr, int dw, int de)
642 struct g_eli_softc *sc;
649 if (sc->sc_flags & G_ELI_FLAG_RO) {
650 /* Deny write attempts. */
653 /* Someone is opening us for write, we need to remember that. */
654 sc->sc_flags |= G_ELI_FLAG_WOPEN;
657 /* Is this the last close? */
658 if (pp->acr + dr > 0 || pp->acw + dw > 0 || pp->ace + de > 0)
662 * Automatically detach on last close if requested.
664 if ((sc->sc_flags & G_ELI_FLAG_RW_DETACH) ||
665 (sc->sc_flags & G_ELI_FLAG_WOPEN)) {
666 g_post_event(g_eli_last_close, gp, M_WAITOK, NULL);
672 g_eli_cpu_is_disabled(int cpu)
675 return (CPU_ISSET(cpu, &hlt_cpus_mask));
682 g_eli_create(struct gctl_req *req, struct g_class *mp, struct g_provider *bpp,
683 const struct g_eli_metadata *md, const u_char *mkey, int nkey)
685 struct g_eli_softc *sc;
686 struct g_eli_worker *wr;
688 struct g_provider *pp;
689 struct g_consumer *cp;
693 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX);
695 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX);
696 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO);
697 gp->start = g_eli_start;
699 * Spoiling cannot happen actually, because we keep provider open for
700 * writing all the time or provider is read-only.
702 gp->spoiled = g_eli_orphan_spoil_assert;
703 gp->orphan = g_eli_orphan;
704 gp->dumpconf = g_eli_dumpconf;
706 * If detach-on-last-close feature is not enabled and we don't operate
707 * on read-only provider, we can simply use g_std_access().
709 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO))
710 gp->access = g_eli_access;
712 gp->access = g_std_access;
714 sc->sc_version = md->md_version;
716 sc->sc_crypto = G_ELI_CRYPTO_UNKNOWN;
717 sc->sc_flags = md->md_flags;
718 /* Backward compatibility. */
719 if (md->md_version < G_ELI_VERSION_04)
720 sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER;
721 if (md->md_version < G_ELI_VERSION_05)
722 sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY;
723 if (md->md_version < G_ELI_VERSION_06 &&
724 (sc->sc_flags & G_ELI_FLAG_AUTH) != 0) {
725 sc->sc_flags |= G_ELI_FLAG_FIRST_KEY;
727 if (md->md_version < G_ELI_VERSION_07)
728 sc->sc_flags |= G_ELI_FLAG_ENC_IVKEY;
729 sc->sc_ealgo = md->md_ealgo;
732 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
733 sc->sc_akeylen = sizeof(sc->sc_akey) * 8;
734 sc->sc_aalgo = md->md_aalgo;
735 sc->sc_alen = g_eli_hashlen(sc->sc_aalgo);
737 sc->sc_data_per_sector = bpp->sectorsize - sc->sc_alen;
739 * Some hash functions (like SHA1 and RIPEMD160) generates hash
740 * which length is not multiple of 128 bits, but we want data
741 * length to be multiple of 128, so we can encrypt without
742 * padding. The line below rounds down data length to multiple
745 sc->sc_data_per_sector -= sc->sc_data_per_sector % 16;
747 sc->sc_bytes_per_sector =
748 (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1;
749 sc->sc_bytes_per_sector *= bpp->sectorsize;
755 bioq_init(&sc->sc_queue);
756 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF);
757 mtx_init(&sc->sc_ekeys_lock, "geli:ekeys", NULL, MTX_DEF);
760 cp = g_new_consumer(gp);
761 error = g_attach(cp, bpp);
764 gctl_error(req, "Cannot attach to %s (error=%d).",
767 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).",
773 * Keep provider open all the time, so we can run critical tasks,
774 * like Master Keys deletion, without wondering if we can open
776 * We don't open provider for writing only when user requested read-only
779 if (sc->sc_flags & G_ELI_FLAG_RO)
780 error = g_access(cp, 1, 0, 1);
782 error = g_access(cp, 1, 1, 1);
785 gctl_error(req, "Cannot access %s (error=%d).",
788 G_ELI_DEBUG(1, "Cannot access %s (error=%d).",
794 sc->sc_sectorsize = md->md_sectorsize;
795 sc->sc_mediasize = bpp->mediasize;
796 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME))
797 sc->sc_mediasize -= bpp->sectorsize;
798 if (!(sc->sc_flags & G_ELI_FLAG_AUTH))
799 sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize);
801 sc->sc_mediasize /= sc->sc_bytes_per_sector;
802 sc->sc_mediasize *= sc->sc_sectorsize;
806 * Remember the keys in our softc structure.
808 g_eli_mkey_propagate(sc, mkey);
809 sc->sc_ekeylen = md->md_keylen;
811 LIST_INIT(&sc->sc_workers);
813 threads = g_eli_threads;
816 sc->sc_cpubind = (mp_ncpus > 1 && threads == mp_ncpus);
817 for (i = 0; i < threads; i++) {
818 if (g_eli_cpu_is_disabled(i)) {
819 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.",
823 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO);
828 error = g_eli_newsession(wr);
832 gctl_error(req, "Cannot set up crypto session "
833 "for %s (error=%d).", bpp->name, error);
835 G_ELI_DEBUG(1, "Cannot set up crypto session "
836 "for %s (error=%d).", bpp->name, error);
841 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0,
842 "g_eli[%u] %s", i, bpp->name);
844 g_eli_freesession(wr);
847 gctl_error(req, "Cannot create kernel thread "
848 "for %s (error=%d).", bpp->name, error);
850 G_ELI_DEBUG(1, "Cannot create kernel thread "
851 "for %s (error=%d).", bpp->name, error);
855 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next);
859 * Create decrypted provider.
861 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX);
862 pp->mediasize = sc->sc_mediasize;
863 pp->sectorsize = sc->sc_sectorsize;
865 g_error_provider(pp, 0);
867 G_ELI_DEBUG(0, "Device %s created.", pp->name);
868 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo),
870 if (sc->sc_flags & G_ELI_FLAG_AUTH)
871 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo));
872 G_ELI_DEBUG(0, " Crypto: %s",
873 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware");
876 mtx_lock(&sc->sc_queue_mtx);
877 sc->sc_flags |= G_ELI_FLAG_DESTROY;
880 * Wait for kernel threads self destruction.
882 while (!LIST_EMPTY(&sc->sc_workers)) {
883 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
886 mtx_destroy(&sc->sc_queue_mtx);
887 if (cp->provider != NULL) {
889 g_access(cp, -1, -1, -1);
892 g_destroy_consumer(cp);
894 g_eli_key_destroy(sc);
895 bzero(sc, sizeof(*sc));
901 g_eli_destroy(struct g_eli_softc *sc, boolean_t force)
904 struct g_provider *pp;
912 pp = LIST_FIRST(&gp->provider);
913 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
915 G_ELI_DEBUG(1, "Device %s is still open, so it "
916 "cannot be definitely removed.", pp->name);
917 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
918 gp->access = g_eli_access;
919 g_wither_provider(pp, ENXIO);
923 "Device %s is still open (r%dw%de%d).", pp->name,
924 pp->acr, pp->acw, pp->ace);
929 mtx_lock(&sc->sc_queue_mtx);
930 sc->sc_flags |= G_ELI_FLAG_DESTROY;
932 while (!LIST_EMPTY(&sc->sc_workers)) {
933 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
936 mtx_destroy(&sc->sc_queue_mtx);
938 g_eli_key_destroy(sc);
939 bzero(sc, sizeof(*sc));
942 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
943 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name);
944 g_wither_geom_close(gp, ENXIO);
950 g_eli_destroy_geom(struct gctl_req *req __unused,
951 struct g_class *mp __unused, struct g_geom *gp)
953 struct g_eli_softc *sc;
956 return (g_eli_destroy(sc, FALSE));
960 g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider)
962 u_char *keyfile, *data;
963 char *file, name[64];
968 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
969 keyfile = preload_search_by_type(name);
971 return (i); /* Return number of loaded keyfiles. */
972 data = preload_fetch_addr(keyfile);
974 G_ELI_DEBUG(0, "Cannot find key file data for %s.",
978 size = preload_fetch_size(keyfile);
980 G_ELI_DEBUG(0, "Cannot find key file size for %s.",
984 file = preload_search_info(keyfile, MODINFO_NAME);
986 G_ELI_DEBUG(0, "Cannot find key file name for %s.",
990 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file,
992 g_eli_crypto_hmac_update(ctx, data, size);
997 g_eli_keyfiles_clear(const char *provider)
999 u_char *keyfile, *data;
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)
1009 data = preload_fetch_addr(keyfile);
1010 size = preload_fetch_size(keyfile);
1011 if (data != NULL && size != 0)
1017 * Tasting is only made on boot.
1018 * We detect providers which should be attached before root is mounted.
1020 static struct g_geom *
1021 g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
1023 struct g_eli_metadata md;
1025 struct hmac_ctx ctx;
1026 char passphrase[256];
1027 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
1028 u_int i, nkey, nkeyfiles, tries;
1031 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
1032 g_topology_assert();
1034 if (root_mounted() || g_eli_tries == 0)
1037 G_ELI_DEBUG(3, "Tasting %s.", pp->name);
1039 error = g_eli_read_metadata(mp, pp, &md);
1044 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0)
1046 if (md.md_version > G_ELI_VERSION) {
1047 printf("geom_eli.ko module is too old to handle %s.\n",
1051 if (md.md_provsize != pp->mediasize)
1053 /* Should we attach it on boot? */
1054 if (!(md.md_flags & G_ELI_FLAG_BOOT))
1056 if (md.md_keys == 0x00) {
1057 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name);
1060 if (md.md_iterations == -1) {
1061 /* If there is no passphrase, we try only once. */
1064 /* Ask for the passphrase no more than g_eli_tries times. */
1065 tries = g_eli_tries;
1068 for (i = 0; i < tries; i++) {
1069 g_eli_crypto_hmac_init(&ctx, NULL, 0);
1072 * Load all key files.
1074 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name);
1076 if (nkeyfiles == 0 && md.md_iterations == -1) {
1078 * No key files and no passphrase, something is
1079 * definitely wrong here.
1080 * geli(8) doesn't allow for such situation, so assume
1081 * that there was really no passphrase and in that case
1082 * key files are no properly defined in loader.conf.
1085 "Found no key files in loader.conf for %s.",
1090 /* Ask for the passphrase if defined. */
1091 if (md.md_iterations >= 0) {
1092 printf("Enter passphrase for %s: ", pp->name);
1093 cngets(passphrase, sizeof(passphrase),
1094 g_eli_visible_passphrase);
1098 * Prepare Derived-Key from the user passphrase.
1100 if (md.md_iterations == 0) {
1101 g_eli_crypto_hmac_update(&ctx, md.md_salt,
1102 sizeof(md.md_salt));
1103 g_eli_crypto_hmac_update(&ctx, passphrase,
1104 strlen(passphrase));
1105 bzero(passphrase, sizeof(passphrase));
1106 } else if (md.md_iterations > 0) {
1107 u_char dkey[G_ELI_USERKEYLEN];
1109 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt,
1110 sizeof(md.md_salt), passphrase, md.md_iterations);
1111 bzero(passphrase, sizeof(passphrase));
1112 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey));
1113 bzero(dkey, sizeof(dkey));
1116 g_eli_crypto_hmac_final(&ctx, key, 0);
1119 * Decrypt Master-Key.
1121 error = g_eli_mkey_decrypt(&md, key, mkey, &nkey);
1122 bzero(key, sizeof(key));
1124 if (i == tries - 1) {
1126 "Wrong key for %s. No tries left.",
1128 g_eli_keyfiles_clear(pp->name);
1131 G_ELI_DEBUG(0, "Wrong key for %s. Tries left: %u.",
1132 pp->name, tries - i - 1);
1135 } else if (error > 0) {
1137 "Cannot decrypt Master Key for %s (error=%d).",
1139 g_eli_keyfiles_clear(pp->name);
1142 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name);
1147 * We have correct key, let's attach provider.
1149 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey);
1150 bzero(mkey, sizeof(mkey));
1151 bzero(&md, sizeof(md));
1153 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name,
1161 g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1162 struct g_consumer *cp, struct g_provider *pp)
1164 struct g_eli_softc *sc;
1166 g_topology_assert();
1170 if (pp != NULL || cp != NULL)
1171 return; /* Nothing here. */
1173 sbuf_printf(sb, "%s<KeysTotal>%ju</KeysTotal>", indent,
1174 (uintmax_t)sc->sc_ekeys_total);
1175 sbuf_printf(sb, "%s<KeysAllocated>%ju</KeysAllocated>", indent,
1176 (uintmax_t)sc->sc_ekeys_allocated);
1177 sbuf_printf(sb, "%s<Flags>", indent);
1178 if (sc->sc_flags == 0)
1179 sbuf_printf(sb, "NONE");
1183 #define ADD_FLAG(flag, name) do { \
1184 if (sc->sc_flags & (flag)) { \
1186 sbuf_printf(sb, ", "); \
1189 sbuf_printf(sb, name); \
1192 ADD_FLAG(G_ELI_FLAG_SUSPEND, "SUSPEND");
1193 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY");
1194 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER");
1195 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME");
1196 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT");
1197 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH");
1198 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH");
1199 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH");
1200 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN");
1201 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY");
1202 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY");
1205 sbuf_printf(sb, "</Flags>\n");
1207 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) {
1208 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent,
1211 sbuf_printf(sb, "%s<Version>%u</Version>\n", indent, sc->sc_version);
1212 sbuf_printf(sb, "%s<Crypto>", indent);
1213 switch (sc->sc_crypto) {
1214 case G_ELI_CRYPTO_HW:
1215 sbuf_printf(sb, "hardware");
1217 case G_ELI_CRYPTO_SW:
1218 sbuf_printf(sb, "software");
1221 sbuf_printf(sb, "UNKNOWN");
1224 sbuf_printf(sb, "</Crypto>\n");
1225 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
1227 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n",
1228 indent, g_eli_algo2str(sc->sc_aalgo));
1230 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent,
1232 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n",
1233 indent, g_eli_algo2str(sc->sc_ealgo));
1234 sbuf_printf(sb, "%s<State>%s</State>\n", indent,
1235 (sc->sc_flags & G_ELI_FLAG_SUSPEND) ? "SUSPENDED" : "ACTIVE");
1239 g_eli_shutdown_pre_sync(void *arg, int howto)
1242 struct g_geom *gp, *gp2;
1243 struct g_provider *pp;
1244 struct g_eli_softc *sc;
1250 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
1254 pp = LIST_FIRST(&gp->provider);
1255 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name));
1256 if (pp->acr + pp->acw + pp->ace == 0)
1257 error = g_eli_destroy(sc, TRUE);
1259 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
1260 gp->access = g_eli_access;
1263 g_topology_unlock();
1268 g_eli_init(struct g_class *mp)
1271 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync,
1272 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST);
1273 if (g_eli_pre_sync == NULL)
1274 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event.");
1278 g_eli_fini(struct g_class *mp)
1281 if (g_eli_pre_sync != NULL)
1282 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync);
1285 DECLARE_GEOM_CLASS(g_eli_class, g_eli);
1286 MODULE_DEPEND(g_eli, crypto, 1, 1, 1);