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