1/*-
2 * Copyright (c) 2005-2006 Pawel Jakub Dawidek <pjd@FreeBSD.org>
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: head/sys/geom/eli/g_eli.c 213067 2010-09-23 11:49:47Z pjd $");
29
30#include <sys/param.h>
31#include <sys/systm.h>
32#include <sys/kernel.h>
33#include <sys/linker.h>
34#include <sys/module.h>
35#include <sys/lock.h>
36#include <sys/mutex.h>
37#include <sys/bio.h>
38#include <sys/sysctl.h>
39#include <sys/malloc.h>
40#include <sys/eventhandler.h>
41#include <sys/kthread.h>
42#include <sys/proc.h>
43#include <sys/sched.h>
44#include <sys/smp.h>
45#include <sys/uio.h>
46#include <sys/vnode.h>
47
48#include <vm/uma.h>
49
50#include <geom/geom.h>
51#include <geom/eli/g_eli.h>
52#include <geom/eli/pkcs5v2.h>
53
54
55MALLOC_DEFINE(M_ELI, "eli data", "GEOM_ELI Data");
56
57SYSCTL_DECL(_kern_geom);
58SYSCTL_NODE(_kern_geom, OID_AUTO, eli, CTLFLAG_RW, 0, "GEOM_ELI stuff");
59u_int g_eli_debug = 0;
60TUNABLE_INT("kern.geom.eli.debug", &g_eli_debug);
61SYSCTL_UINT(_kern_geom_eli, OID_AUTO, debug, CTLFLAG_RW, &g_eli_debug, 0,
62 "Debug level");
63static u_int g_eli_tries = 3;
64TUNABLE_INT("kern.geom.eli.tries", &g_eli_tries);
65SYSCTL_UINT(_kern_geom_eli, OID_AUTO, tries, CTLFLAG_RW, &g_eli_tries, 0,
66 "Number of tries for entering the passphrase");
67static u_int g_eli_visible_passphrase = 0;
68TUNABLE_INT("kern.geom.eli.visible_passphrase", &g_eli_visible_passphrase);
69SYSCTL_UINT(_kern_geom_eli, OID_AUTO, visible_passphrase, CTLFLAG_RW,
70 &g_eli_visible_passphrase, 0,
71 "Turn on echo when entering the passphrase (for debug purposes only!!)");
72u_int g_eli_overwrites = G_ELI_OVERWRITES;
73TUNABLE_INT("kern.geom.eli.overwrites", &g_eli_overwrites);
74SYSCTL_UINT(_kern_geom_eli, OID_AUTO, overwrites, CTLFLAG_RW, &g_eli_overwrites,
75 0, "Number of times on-disk keys should be overwritten when destroying them");
76static u_int g_eli_threads = 0;
77TUNABLE_INT("kern.geom.eli.threads", &g_eli_threads);
78SYSCTL_UINT(_kern_geom_eli, OID_AUTO, threads, CTLFLAG_RW, &g_eli_threads, 0,
79 "Number of threads doing crypto work");
80u_int g_eli_batch = 0;
81TUNABLE_INT("kern.geom.eli.batch", &g_eli_batch);
82SYSCTL_UINT(_kern_geom_eli, OID_AUTO, batch, CTLFLAG_RW, &g_eli_batch, 0,
83 "Use crypto operations batching");
84
85static eventhandler_tag g_eli_pre_sync = NULL;
86
87static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp,
88 struct g_geom *gp);
89static void g_eli_init(struct g_class *mp);
90static void g_eli_fini(struct g_class *mp);
91
92static g_taste_t g_eli_taste;
93static g_dumpconf_t g_eli_dumpconf;
94
95struct g_class g_eli_class = {
96 .name = G_ELI_CLASS_NAME,
97 .version = G_VERSION,
98 .ctlreq = g_eli_config,
99 .taste = g_eli_taste,
100 .destroy_geom = g_eli_destroy_geom,
101 .init = g_eli_init,
102 .fini = g_eli_fini
103};
104
105
106/*
107 * Code paths:
108 * BIO_READ:
109 * g_eli_start -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
110 * BIO_WRITE:
111 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
112 */
113
114
115/*
116 * EAGAIN from crypto(9) means, that we were probably balanced to another crypto
117 * accelerator or something like this.
118 * The function updates the SID and rerun the operation.
119 */
120int
121g_eli_crypto_rerun(struct cryptop *crp)
122{
123 struct g_eli_softc *sc;
124 struct g_eli_worker *wr;
125 struct bio *bp;
126 int error;
127
128 bp = (struct bio *)crp->crp_opaque;
129 sc = bp->bio_to->geom->softc;
130 LIST_FOREACH(wr, &sc->sc_workers, w_next) {
131 if (wr->w_number == bp->bio_pflags)
132 break;
133 }
134 KASSERT(wr != NULL, ("Invalid worker (%u).", bp->bio_pflags));
135 G_ELI_DEBUG(1, "Rerunning crypto %s request (sid: %ju -> %ju).",
136 bp->bio_cmd == BIO_READ ? "READ" : "WRITE", (uintmax_t)wr->w_sid,
137 (uintmax_t)crp->crp_sid);
138 wr->w_sid = crp->crp_sid;
139 crp->crp_etype = 0;
140 error = crypto_dispatch(crp);
141 if (error == 0)
142 return (0);
143 G_ELI_DEBUG(1, "%s: crypto_dispatch() returned %d.", __func__, error);
144 crp->crp_etype = error;
145 return (error);
146}
147
148/*
149 * The function is called afer reading encrypted data from the provider.
150 *
151 * g_eli_start -> g_io_request -> G_ELI_READ_DONE -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
152 */
153void
154g_eli_read_done(struct bio *bp)
155{
156 struct g_eli_softc *sc;
157 struct bio *pbp;
158
159 G_ELI_LOGREQ(2, bp, "Request done.");
160 pbp = bp->bio_parent;
161 if (pbp->bio_error == 0)
162 pbp->bio_error = bp->bio_error;
163 /*
164 * Do we have all sectors already?
165 */
166 pbp->bio_inbed++;
167 if (pbp->bio_inbed < pbp->bio_children)
168 return;
169 g_destroy_bio(bp);
170 if (pbp->bio_error != 0) {
171 G_ELI_LOGREQ(0, pbp, "%s() failed", __func__);
172 pbp->bio_completed = 0;
173 if (pbp->bio_driver2 != NULL) {
174 free(pbp->bio_driver2, M_ELI);
175 pbp->bio_driver2 = NULL;
176 }
177 g_io_deliver(pbp, pbp->bio_error);
178 return;
179 }
180 sc = pbp->bio_to->geom->softc;
181 mtx_lock(&sc->sc_queue_mtx);
182 bioq_insert_tail(&sc->sc_queue, pbp);
183 mtx_unlock(&sc->sc_queue_mtx);
184 wakeup(sc);
185}
186
187/*
188 * The function is called after we encrypt and write data.
189 *
190 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> G_ELI_WRITE_DONE -> g_io_deliver
191 */
192void
193g_eli_write_done(struct bio *bp)
194{
195 struct bio *pbp;
196
197 G_ELI_LOGREQ(2, bp, "Request done.");
198 pbp = bp->bio_parent;
199 if (pbp->bio_error == 0) {
200 if (bp->bio_error != 0)
201 pbp->bio_error = bp->bio_error;
202 }
203 /*
204 * Do we have all sectors already?
205 */
206 pbp->bio_inbed++;
207 if (pbp->bio_inbed < pbp->bio_children)
208 return;
209 free(pbp->bio_driver2, M_ELI);
210 pbp->bio_driver2 = NULL;
211 if (pbp->bio_error != 0) {
212 G_ELI_LOGREQ(0, pbp, "Crypto WRITE request failed (error=%d).",
213 pbp->bio_error);
214 pbp->bio_completed = 0;
215 }
216 g_destroy_bio(bp);
217 /*
218 * Write is finished, send it up.
219 */
220 pbp->bio_completed = pbp->bio_length;
221 g_io_deliver(pbp, pbp->bio_error);
222}
223
224/*
225 * This function should never be called, but GEOM made as it set ->orphan()
226 * method for every geom.
227 */
228static void
229g_eli_orphan_spoil_assert(struct g_consumer *cp)
230{
231
232 panic("Function %s() called for %s.", __func__, cp->geom->name);
233}
234
235static void
236g_eli_orphan(struct g_consumer *cp)
237{
238 struct g_eli_softc *sc;
239
240 g_topology_assert();
241 sc = cp->geom->softc;
242 if (sc == NULL)
243 return;
244 g_eli_destroy(sc, 1);
245}
246
247/*
248 * BIO_READ : G_ELI_START -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
249 * BIO_WRITE: G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
250 */
251static void
252g_eli_start(struct bio *bp)
253{
254 struct g_eli_softc *sc;
255 struct g_consumer *cp;
256 struct bio *cbp;
257
258 sc = bp->bio_to->geom->softc;
259 KASSERT(sc != NULL,
260 ("Provider's error should be set (error=%d)(device=%s).",
261 bp->bio_to->error, bp->bio_to->name));
262 G_ELI_LOGREQ(2, bp, "Request received.");
263
264 switch (bp->bio_cmd) {
265 case BIO_READ:
266 case BIO_WRITE:
267 case BIO_GETATTR:
268 case BIO_FLUSH:
269 break;
270 case BIO_DELETE:
271 /*
272 * We could eventually support BIO_DELETE request.
273 * It could be done by overwritting requested sector with
274 * random data g_eli_overwrites number of times.
275 */
276 default:
277 g_io_deliver(bp, EOPNOTSUPP);
278 return;
279 }
280 cbp = g_clone_bio(bp);
281 if (cbp == NULL) {
282 g_io_deliver(bp, ENOMEM);
283 return;
284 }
285 switch (bp->bio_cmd) {
286 case BIO_READ:
287 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) {
288 bp->bio_driver2 = NULL;
289 cbp->bio_done = g_eli_read_done;
290 cp = LIST_FIRST(&sc->sc_geom->consumer);
291 cbp->bio_to = cp->provider;
292 G_ELI_LOGREQ(2, cbp, "Sending request.");
293 /*
294 * Read encrypted data from provider.
295 */
296 g_io_request(cbp, cp);
297 break;
298 }
299 bp->bio_pflags = 255;
300 /* FALLTHROUGH */
301 case BIO_WRITE:
302 bp->bio_driver1 = cbp;
303 mtx_lock(&sc->sc_queue_mtx);
304 bioq_insert_tail(&sc->sc_queue, bp);
305 mtx_unlock(&sc->sc_queue_mtx);
306 wakeup(sc);
307 break;
308 case BIO_GETATTR:
309 case BIO_FLUSH:
310 cbp->bio_done = g_std_done;
311 cp = LIST_FIRST(&sc->sc_geom->consumer);
312 cbp->bio_to = cp->provider;
313 G_ELI_LOGREQ(2, cbp, "Sending request.");
314 g_io_request(cbp, cp);
315 break;
316 }
317}
318
319/*
320 * This is the main function for kernel worker thread when we don't have
321 * hardware acceleration and we have to do cryptography in software.
322 * Dedicated thread is needed, so we don't slow down g_up/g_down GEOM
323 * threads with crypto work.
324 */
325static void
326g_eli_worker(void *arg)
327{
328 struct g_eli_softc *sc;
329 struct g_eli_worker *wr;
330 struct bio *bp;
331
332 wr = arg;
333 sc = wr->w_softc;
334#ifdef SMP
335 /* Before sched_bind() to a CPU, wait for all CPUs to go on-line. */
336 if (mp_ncpus > 1 && sc->sc_crypto == G_ELI_CRYPTO_SW &&
337 g_eli_threads == 0) {
338 while (!smp_started)
339 tsleep(wr, 0, "geli:smp", hz / 4);
340 }
341#endif
342 thread_lock(curthread);
343 sched_prio(curthread, PUSER);
344 if (sc->sc_crypto == G_ELI_CRYPTO_SW && g_eli_threads == 0)
345 sched_bind(curthread, wr->w_number);
346 thread_unlock(curthread);
347
348 G_ELI_DEBUG(1, "Thread %s started.", curthread->td_proc->p_comm);
349
350 for (;;) {
351 mtx_lock(&sc->sc_queue_mtx);
352 bp = bioq_takefirst(&sc->sc_queue);
353 if (bp == NULL) {
354 if (sc->sc_flags & G_ELI_FLAG_DESTROY) {
355 LIST_REMOVE(wr, w_next);
356 crypto_freesession(wr->w_sid);
357 free(wr, M_ELI);
358 G_ELI_DEBUG(1, "Thread %s exiting.",
359 curthread->td_proc->p_comm);
360 wakeup(&sc->sc_workers);
361 mtx_unlock(&sc->sc_queue_mtx);
362 kproc_exit(0);
363 }
364 msleep(sc, &sc->sc_queue_mtx, PDROP, "geli:w", 0);
365 continue;
366 }
367 mtx_unlock(&sc->sc_queue_mtx);
368 if (bp->bio_cmd == BIO_READ && bp->bio_pflags == 255)
369 g_eli_auth_read(sc, bp);
370 else if (sc->sc_flags & G_ELI_FLAG_AUTH)
371 g_eli_auth_run(wr, bp);
372 else
373 g_eli_crypto_run(wr, bp);
374 }
375}
376
377/*
378 * Select encryption key. If G_ELI_FLAG_SINGLE_KEY is present we only have one
379 * key available for all the data. If the flag is not present select the key
380 * based on data offset.
381 */
382uint8_t *
383g_eli_crypto_key(struct g_eli_softc *sc, off_t offset, size_t blocksize)
384{
385 u_int nkey;
386
387 if (sc->sc_nekeys == 1)
388 return (sc->sc_ekeys[0]);
389
390 KASSERT(sc->sc_nekeys > 1, ("%s: sc_nekeys=%u", __func__,
391 sc->sc_nekeys));
392 KASSERT((sc->sc_flags & G_ELI_FLAG_SINGLE_KEY) == 0,
393 ("%s: SINGLE_KEY flag set, but sc_nekeys=%u", __func__,
394 sc->sc_nekeys));
395
396 /* We switch key every 2^G_ELI_KEY_SHIFT blocks. */
397 nkey = (offset >> G_ELI_KEY_SHIFT) / blocksize;
398
399 KASSERT(nkey < sc->sc_nekeys, ("%s: nkey=%u >= sc_nekeys=%u", __func__,
400 nkey, sc->sc_nekeys));
401
402 return (sc->sc_ekeys[nkey]);
403}
404
405/*
406 * Here we generate IV. It is unique for every sector.
407 */
408void
409g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
410 size_t size)
411{
412 u_char off[8], hash[SHA256_DIGEST_LENGTH];
413 SHA256_CTX ctx;
414
415 if ((sc->sc_flags & G_ELI_FLAG_NATIVE_BYTE_ORDER) != 0)
416 bcopy(&offset, off, sizeof(off));
417 else
418 le64enc(off, (uint64_t)offset);
419 /* Copy precalculated SHA256 context for IV-Key. */
420 bcopy(&sc->sc_ivctx, &ctx, sizeof(ctx));
421 SHA256_Update(&ctx, off, sizeof(off));
422 SHA256_Final(hash, &ctx);
423 bcopy(hash, iv, size);
424}
425
426int
427g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
428 struct g_eli_metadata *md)
429{
430 struct g_geom *gp;
431 struct g_consumer *cp;
432 u_char *buf = NULL;
433 int error;
434
435 g_topology_assert();
436
437 gp = g_new_geomf(mp, "eli:taste");
438 gp->start = g_eli_start;
439 gp->access = g_std_access;
440 /*
441 * g_eli_read_metadata() is always called from the event thread.
442 * Our geom is created and destroyed in the same event, so there
443 * could be no orphan nor spoil event in the meantime.
444 */
445 gp->orphan = g_eli_orphan_spoil_assert;
446 gp->spoiled = g_eli_orphan_spoil_assert;
447 cp = g_new_consumer(gp);
448 error = g_attach(cp, pp);
449 if (error != 0)
450 goto end;
451 error = g_access(cp, 1, 0, 0);
452 if (error != 0)
453 goto end;
454 g_topology_unlock();
455 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
456 &error);
457 g_topology_lock();
458 if (buf == NULL)
459 goto end;
460 eli_metadata_decode(buf, md);
461end:
462 if (buf != NULL)
463 g_free(buf);
464 if (cp->provider != NULL) {
465 if (cp->acr == 1)
466 g_access(cp, -1, 0, 0);
467 g_detach(cp);
468 }
469 g_destroy_consumer(cp);
470 g_destroy_geom(gp);
471 return (error);
472}
473
474/*
475 * The function is called when we had last close on provider and user requested
476 * to close it when this situation occur.
477 */
478static void
479g_eli_last_close(struct g_eli_softc *sc)
480{
481 struct g_geom *gp;
482 struct g_provider *pp;
483 char ppname[64];
484 int error;
485
486 g_topology_assert();
487 gp = sc->sc_geom;
488 pp = LIST_FIRST(&gp->provider);
489 strlcpy(ppname, pp->name, sizeof(ppname));
490 error = g_eli_destroy(sc, 1);
491 KASSERT(error == 0, ("Cannot detach %s on last close (error=%d).",
492 ppname, error));
493 G_ELI_DEBUG(0, "Detached %s on last close.", ppname);
494}
495
496int
497g_eli_access(struct g_provider *pp, int dr, int dw, int de)
498{
499 struct g_eli_softc *sc;
500 struct g_geom *gp;
501
502 gp = pp->geom;
503 sc = gp->softc;
504
505 if (dw > 0) {
506 if (sc->sc_flags & G_ELI_FLAG_RO) {
507 /* Deny write attempts. */
508 return (EROFS);
509 }
510 /* Someone is opening us for write, we need to remember that. */
511 sc->sc_flags |= G_ELI_FLAG_WOPEN;
512 return (0);
513 }
514 /* Is this the last close? */
515 if (pp->acr + dr > 0 || pp->acw + dw > 0 || pp->ace + de > 0)
516 return (0);
517
518 /*
519 * Automatically detach on last close if requested.
520 */
521 if ((sc->sc_flags & G_ELI_FLAG_RW_DETACH) ||
522 (sc->sc_flags & G_ELI_FLAG_WOPEN)) {
523 g_eli_last_close(sc);
524 }
525 return (0);
526}
527
528static int
529g_eli_cpu_is_disabled(int cpu)
530{
531#ifdef SMP
532 return ((hlt_cpus_mask & (1 << cpu)) != 0);
533#else
534 return (0);
535#endif
536}
537
538struct g_geom *
539g_eli_create(struct gctl_req *req, struct g_class *mp, struct g_provider *bpp,
540 const struct g_eli_metadata *md, const u_char *mkey, int nkey)
541{
542 struct g_eli_softc *sc;
543 struct g_eli_worker *wr;
544 struct g_geom *gp;
545 struct g_provider *pp;
546 struct g_consumer *cp;
547 struct cryptoini crie, cria;
548 u_int i, threads;
549 int error;
550
551 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX);
552
553 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX);
554 gp->softc = NULL; /* for a moment */
555
556 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO);
557 gp->start = g_eli_start;
558 /*
559 * Spoiling cannot happen actually, because we keep provider open for
560 * writing all the time or provider is read-only.
561 */
562 gp->spoiled = g_eli_orphan_spoil_assert;
563 gp->orphan = g_eli_orphan;
564 gp->dumpconf = g_eli_dumpconf;
565 /*
566 * If detach-on-last-close feature is not enabled and we don't operate
567 * on read-only provider, we can simply use g_std_access().
568 */
569 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO))
570 gp->access = g_eli_access;
571 else
572 gp->access = g_std_access;
573
574 sc->sc_crypto = G_ELI_CRYPTO_SW;
575 sc->sc_flags = md->md_flags;
576 /* Backward compatibility. */
577 if (md->md_version < 4)
578 sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER;
579 if (md->md_version < 5)
580 sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY;
581 sc->sc_ealgo = md->md_ealgo;
582 sc->sc_nkey = nkey;
583
584 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
585 sc->sc_akeylen = sizeof(sc->sc_akey) * 8;
586 sc->sc_aalgo = md->md_aalgo;
587 sc->sc_alen = g_eli_hashlen(sc->sc_aalgo);
588
589 sc->sc_data_per_sector = bpp->sectorsize - sc->sc_alen;
590 /*
591 * Some hash functions (like SHA1 and RIPEMD160) generates hash
592 * which length is not multiple of 128 bits, but we want data
593 * length to be multiple of 128, so we can encrypt without
594 * padding. The line below rounds down data length to multiple
595 * of 128 bits.
596 */
597 sc->sc_data_per_sector -= sc->sc_data_per_sector % 16;
598
599 sc->sc_bytes_per_sector =
600 (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1;
601 sc->sc_bytes_per_sector *= bpp->sectorsize;
602 /*
603 * Precalculate SHA256 for HMAC key generation.
604 * This is expensive operation and we can do it only once now or
605 * for every access to sector, so now will be much better.
606 */
607 SHA256_Init(&sc->sc_akeyctx);
608 SHA256_Update(&sc->sc_akeyctx, sc->sc_akey,
609 sizeof(sc->sc_akey));
610 }
611
612 gp->softc = sc;
613 sc->sc_geom = gp;
614
615 bioq_init(&sc->sc_queue);
616 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF);
617
618 pp = NULL;
619 cp = g_new_consumer(gp);
620 error = g_attach(cp, bpp);
621 if (error != 0) {
622 if (req != NULL) {
623 gctl_error(req, "Cannot attach to %s (error=%d).",
624 bpp->name, error);
625 } else {
626 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).",
627 bpp->name, error);
628 }
629 goto failed;
630 }
631 /*
632 * Keep provider open all the time, so we can run critical tasks,
633 * like Master Keys deletion, without wondering if we can open
634 * provider or not.
635 * We don't open provider for writing only when user requested read-only
636 * access.
637 */
638 if (sc->sc_flags & G_ELI_FLAG_RO)
639 error = g_access(cp, 1, 0, 1);
640 else
641 error = g_access(cp, 1, 1, 1);
642 if (error != 0) {
643 if (req != NULL) {
644 gctl_error(req, "Cannot access %s (error=%d).",
645 bpp->name, error);
646 } else {
647 G_ELI_DEBUG(1, "Cannot access %s (error=%d).",
648 bpp->name, error);
649 }
650 goto failed;
651 }
652
653 sc->sc_sectorsize = md->md_sectorsize;
654 sc->sc_mediasize = bpp->mediasize;
655 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME))
656 sc->sc_mediasize -= bpp->sectorsize;
657 if (!(sc->sc_flags & G_ELI_FLAG_AUTH))
658 sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize);
659 else {
660 sc->sc_mediasize /= sc->sc_bytes_per_sector;
661 sc->sc_mediasize *= sc->sc_sectorsize;
662 }
663
664 /*
665 * Remember the keys in our softc structure.
666 */
667 g_eli_mkey_propagate(sc, mkey);
668 sc->sc_ekeylen = md->md_keylen;
669
670 /*
671 * Precalculate SHA256 for IV generation.
672 * This is expensive operation and we can do it only once now or for
673 * every access to sector, so now will be much better.
674 */
675 SHA256_Init(&sc->sc_ivctx);
676 SHA256_Update(&sc->sc_ivctx, sc->sc_ivkey, sizeof(sc->sc_ivkey));
677
678 LIST_INIT(&sc->sc_workers);
679
680 bzero(&crie, sizeof(crie));
681 crie.cri_alg = sc->sc_ealgo;
682 crie.cri_klen = sc->sc_ekeylen;
683 crie.cri_key = sc->sc_ekeys[0];
684 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
685 bzero(&cria, sizeof(cria));
686 cria.cri_alg = sc->sc_aalgo;
687 cria.cri_klen = sc->sc_akeylen;
688 cria.cri_key = sc->sc_akey;
689 crie.cri_next = &cria;
690 }
691
692 threads = g_eli_threads;
693 if (threads == 0)
694 threads = mp_ncpus;
695 else if (threads > mp_ncpus) {
696 /* There is really no need for too many worker threads. */
697 threads = mp_ncpus;
698 G_ELI_DEBUG(0, "Reducing number of threads to %u.", threads);
699 }
700 for (i = 0; i < threads; i++) {
701 if (g_eli_cpu_is_disabled(i)) {
702 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.",
703 bpp->name, i);
704 continue;
705 }
706 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO);
707 wr->w_softc = sc;
708 wr->w_number = i;
709
710 /*
711 * If this is the first pass, try to get hardware support.
712 * Use software cryptography, if we cannot get it.
713 */
714 if (LIST_EMPTY(&sc->sc_workers)) {
715 error = crypto_newsession(&wr->w_sid, &crie,
716 CRYPTOCAP_F_HARDWARE);
717 if (error == 0)
718 sc->sc_crypto = G_ELI_CRYPTO_HW;
719 }
720 if (sc->sc_crypto == G_ELI_CRYPTO_SW) {
721 error = crypto_newsession(&wr->w_sid, &crie,
722 CRYPTOCAP_F_SOFTWARE);
723 }
724 if (error != 0) {
725 free(wr, M_ELI);
726 if (req != NULL) {
727 gctl_error(req, "Cannot set up crypto session "
728 "for %s (error=%d).", bpp->name, error);
729 } else {
730 G_ELI_DEBUG(1, "Cannot set up crypto session "
731 "for %s (error=%d).", bpp->name, error);
732 }
733 goto failed;
734 }
735
736 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0,
737 "g_eli[%u] %s", i, bpp->name);
738 if (error != 0) {
739 crypto_freesession(wr->w_sid);
740 free(wr, M_ELI);
741 if (req != NULL) {
742 gctl_error(req, "Cannot create kernel thread "
743 "for %s (error=%d).", bpp->name, error);
744 } else {
745 G_ELI_DEBUG(1, "Cannot create kernel thread "
746 "for %s (error=%d).", bpp->name, error);
747 }
748 goto failed;
749 }
750 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next);
751 /* If we have hardware support, one thread is enough. */
752 if (sc->sc_crypto == G_ELI_CRYPTO_HW)
753 break;
754 }
755
756 /*
757 * Create decrypted provider.
758 */
759 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX);
760 pp->mediasize = sc->sc_mediasize;
761 pp->sectorsize = sc->sc_sectorsize;
762
763 g_error_provider(pp, 0);
764
765 G_ELI_DEBUG(0, "Device %s created.", pp->name);
766 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo),
767 sc->sc_ekeylen);
768 if (sc->sc_flags & G_ELI_FLAG_AUTH)
769 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo));
770 G_ELI_DEBUG(0, " Crypto: %s",
771 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware");
772 return (gp);
773failed:
774 mtx_lock(&sc->sc_queue_mtx);
775 sc->sc_flags |= G_ELI_FLAG_DESTROY;
776 wakeup(sc);
777 /*
778 * Wait for kernel threads self destruction.
779 */
780 while (!LIST_EMPTY(&sc->sc_workers)) {
781 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
782 "geli:destroy", 0);
783 }
784 mtx_destroy(&sc->sc_queue_mtx);
785 if (cp->provider != NULL) {
786 if (cp->acr == 1)
787 g_access(cp, -1, -1, -1);
788 g_detach(cp);
789 }
790 g_destroy_consumer(cp);
791 g_destroy_geom(gp);
792 if (sc->sc_ekeys != NULL) {
793 bzero(sc->sc_ekeys,
794 sc->sc_nekeys * (sizeof(uint8_t *) + G_ELI_DATAKEYLEN));
795 free(sc->sc_ekeys, M_ELI);
796 }
797 bzero(sc, sizeof(*sc));
798 free(sc, M_ELI);
799 return (NULL);
800}
801
802int
803g_eli_destroy(struct g_eli_softc *sc, boolean_t force)
804{
805 struct g_geom *gp;
806 struct g_provider *pp;
807
808 g_topology_assert();
809
810 if (sc == NULL)
811 return (ENXIO);
812
813 gp = sc->sc_geom;
814 pp = LIST_FIRST(&gp->provider);
815 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
816 if (force) {
817 G_ELI_DEBUG(1, "Device %s is still open, so it "
818 "cannot be definitely removed.", pp->name);
819 } else {
820 G_ELI_DEBUG(1,
821 "Device %s is still open (r%dw%de%d).", pp->name,
822 pp->acr, pp->acw, pp->ace);
823 return (EBUSY);
824 }
825 }
826
827 mtx_lock(&sc->sc_queue_mtx);
828 sc->sc_flags |= G_ELI_FLAG_DESTROY;
829 wakeup(sc);
830 while (!LIST_EMPTY(&sc->sc_workers)) {
831 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
832 "geli:destroy", 0);
833 }
834 mtx_destroy(&sc->sc_queue_mtx);
835 gp->softc = NULL;
836 bzero(sc->sc_ekeys,
837 sc->sc_nekeys * (sizeof(uint8_t *) + G_ELI_DATAKEYLEN));
838 free(sc->sc_ekeys, M_ELI);
839 bzero(sc, sizeof(*sc));
840 free(sc, M_ELI);
841
842 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
843 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name);
844 g_wither_geom_close(gp, ENXIO);
845
846 return (0);
847}
848
849static int
850g_eli_destroy_geom(struct gctl_req *req __unused,
851 struct g_class *mp __unused, struct g_geom *gp)
852{
853 struct g_eli_softc *sc;
854
855 sc = gp->softc;
856 return (g_eli_destroy(sc, 0));
857}
858
859static int
860g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider)
861{
862 u_char *keyfile, *data, *size;
863 char *file, name[64];
864 int i;
865
866 for (i = 0; ; i++) {
867 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
868 keyfile = preload_search_by_type(name);
869 if (keyfile == NULL)
870 return (i); /* Return number of loaded keyfiles. */
871 data = preload_search_info(keyfile, MODINFO_ADDR);
872 if (data == NULL) {
873 G_ELI_DEBUG(0, "Cannot find key file data for %s.",
874 name);
875 return (0);
876 }
877 data = *(void **)data;
878 size = preload_search_info(keyfile, MODINFO_SIZE);
879 if (size == NULL) {
880 G_ELI_DEBUG(0, "Cannot find key file size for %s.",
881 name);
882 return (0);
883 }
884 file = preload_search_info(keyfile, MODINFO_NAME);
885 if (file == NULL) {
886 G_ELI_DEBUG(0, "Cannot find key file name for %s.",
887 name);
888 return (0);
889 }
890 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file,
891 provider, name);
892 g_eli_crypto_hmac_update(ctx, data, *(size_t *)size);
893 }
894}
895
896static void
897g_eli_keyfiles_clear(const char *provider)
898{
899 u_char *keyfile, *data, *size;
900 char name[64];
901 int i;
902
903 for (i = 0; ; i++) {
904 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
905 keyfile = preload_search_by_type(name);
906 if (keyfile == NULL)
907 return;
908 data = preload_search_info(keyfile, MODINFO_ADDR);
909 size = preload_search_info(keyfile, MODINFO_SIZE);
910 if (data == NULL || size == NULL)
911 continue;
912 data = *(void **)data;
913 bzero(data, *(size_t *)size);
914 }
915}
916
917/*
918 * Tasting is only made on boot.
919 * We detect providers which should be attached before root is mounted.
920 */
921static struct g_geom *
922g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
923{
924 struct g_eli_metadata md;
925 struct g_geom *gp;
926 struct hmac_ctx ctx;
927 char passphrase[256];
928 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
929 u_int i, nkey, nkeyfiles, tries;
930 int error;
931
932 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
933 g_topology_assert();
934
935 if (root_mounted() || g_eli_tries == 0)
936 return (NULL);
937
938 G_ELI_DEBUG(3, "Tasting %s.", pp->name);
939
940 error = g_eli_read_metadata(mp, pp, &md);
941 if (error != 0)
942 return (NULL);
943 gp = NULL;
944
945 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0)
946 return (NULL);
947 if (md.md_version > G_ELI_VERSION) {
948 printf("geom_eli.ko module is too old to handle %s.\n",
949 pp->name);
950 return (NULL);
951 }
952 if (md.md_provsize != pp->mediasize)
953 return (NULL);
954 /* Should we attach it on boot? */
955 if (!(md.md_flags & G_ELI_FLAG_BOOT))
956 return (NULL);
957 if (md.md_keys == 0x00) {
958 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name);
959 return (NULL);
960 }
961 if (md.md_iterations == -1) {
962 /* If there is no passphrase, we try only once. */
963 tries = 1;
964 } else {
965 /* Ask for the passphrase no more than g_eli_tries times. */
966 tries = g_eli_tries;
967 }
968
969 for (i = 0; i < tries; i++) {
970 g_eli_crypto_hmac_init(&ctx, NULL, 0);
971
972 /*
973 * Load all key files.
974 */
975 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name);
976
977 if (nkeyfiles == 0 && md.md_iterations == -1) {
978 /*
979 * No key files and no passphrase, something is
980 * definitely wrong here.
981 * geli(8) doesn't allow for such situation, so assume
982 * that there was really no passphrase and in that case
983 * key files are no properly defined in loader.conf.
984 */
985 G_ELI_DEBUG(0,
986 "Found no key files in loader.conf for %s.",
987 pp->name);
988 return (NULL);
989 }
990
991 /* Ask for the passphrase if defined. */
992 if (md.md_iterations >= 0) {
993 printf("Enter passphrase for %s: ", pp->name);
994 gets(passphrase, sizeof(passphrase),
995 g_eli_visible_passphrase);
996 }
997
998 /*
999 * Prepare Derived-Key from the user passphrase.
1000 */
1001 if (md.md_iterations == 0) {
1002 g_eli_crypto_hmac_update(&ctx, md.md_salt,
1003 sizeof(md.md_salt));
1004 g_eli_crypto_hmac_update(&ctx, passphrase,
1005 strlen(passphrase));
1006 bzero(passphrase, sizeof(passphrase));
1007 } else if (md.md_iterations > 0) {
1008 u_char dkey[G_ELI_USERKEYLEN];
1009
1010 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt,
1011 sizeof(md.md_salt), passphrase, md.md_iterations);
1012 bzero(passphrase, sizeof(passphrase));
1013 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey));
1014 bzero(dkey, sizeof(dkey));
1015 }
1016
1017 g_eli_crypto_hmac_final(&ctx, key, 0);
1018
1019 /*
1020 * Decrypt Master-Key.
1021 */
1022 error = g_eli_mkey_decrypt(&md, key, mkey, &nkey);
1023 bzero(key, sizeof(key));
1024 if (error == -1) {
1025 if (i == tries - 1) {
1026 G_ELI_DEBUG(0,
1027 "Wrong key for %s. No tries left.",
1028 pp->name);
1029 g_eli_keyfiles_clear(pp->name);
1030 return (NULL);
1031 }
1032 G_ELI_DEBUG(0, "Wrong key for %s. Tries left: %u.",
1033 pp->name, tries - i - 1);
1034 /* Try again. */
1035 continue;
1036 } else if (error > 0) {
1037 G_ELI_DEBUG(0, "Cannot decrypt Master Key for %s (error=%d).",
1038 pp->name, error);
1039 g_eli_keyfiles_clear(pp->name);
1040 return (NULL);
1041 }
1042 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name);
1043 break;
1044 }
1045
1046 /*
1047 * We have correct key, let's attach provider.
1048 */
1049 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey);
1050 bzero(mkey, sizeof(mkey));
1051 bzero(&md, sizeof(md));
1052 if (gp == NULL) {
1053 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name,
1054 G_ELI_SUFFIX);
1055 return (NULL);
1056 }
1057 return (gp);
1058}
1059
1060static void
1061g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1062 struct g_consumer *cp, struct g_provider *pp)
1063{
1064 struct g_eli_softc *sc;
1065
1066 g_topology_assert();
1067 sc = gp->softc;
1068 if (sc == NULL)
1069 return;
1070 if (pp != NULL || cp != NULL)
1071 return; /* Nothing here. */
1072 sbuf_printf(sb, "%s<Flags>", indent);
1073 if (sc->sc_flags == 0)
1074 sbuf_printf(sb, "NONE");
1075 else {
1076 int first = 1;
1077
1078#define ADD_FLAG(flag, name) do { \
1079 if (sc->sc_flags & (flag)) { \
1080 if (!first) \
1081 sbuf_printf(sb, ", "); \
1082 else \
1083 first = 0; \
1084 sbuf_printf(sb, name); \
1085 } \
1086} while (0)
1087 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY");
1088 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER");
1089 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME");
1090 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT");
1091 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH");
1092 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH");
1093 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH");
1094 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN");
1095 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY");
1096 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY");
1097#undef ADD_FLAG
1098 }
1099 sbuf_printf(sb, "</Flags>\n");
1100
1101 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) {
1102 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent,
1103 sc->sc_nkey);
1104 }
1105 sbuf_printf(sb, "%s<Crypto>", indent);
1106 switch (sc->sc_crypto) {
1107 case G_ELI_CRYPTO_HW:
1108 sbuf_printf(sb, "hardware");
1109 break;
1110 case G_ELI_CRYPTO_SW:
1111 sbuf_printf(sb, "software");
1112 break;
1113 default:
1114 sbuf_printf(sb, "UNKNOWN");
1115 break;
1116 }
1117 sbuf_printf(sb, "</Crypto>\n");
1118 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
1119 sbuf_printf(sb,
1120 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n",
1121 indent, g_eli_algo2str(sc->sc_aalgo));
1122 }
1123 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent,
1124 sc->sc_ekeylen);
1125 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n", indent,
1126 g_eli_algo2str(sc->sc_ealgo));
1127}
1128
1129static void
1130g_eli_shutdown_pre_sync(void *arg, int howto)
1131{
1132 struct g_class *mp;
1133 struct g_geom *gp, *gp2;
1134 struct g_provider *pp;
1135 struct g_eli_softc *sc;
1136 int error;
1137
1138 mp = arg;
1139 DROP_GIANT();
1140 g_topology_lock();
1141 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
1142 sc = gp->softc;
1143 if (sc == NULL)
1144 continue;
1145 pp = LIST_FIRST(&gp->provider);
1146 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name));
1147 if (pp->acr + pp->acw + pp->ace == 0)
1148 error = g_eli_destroy(sc, 1);
1149 else {
1150 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
1151 gp->access = g_eli_access;
1152 }
1153 }
1154 g_topology_unlock();
1155 PICKUP_GIANT();
1156}
1157
1158static void
1159g_eli_init(struct g_class *mp)
1160{
1161
1162 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync,
1163 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST);
1164 if (g_eli_pre_sync == NULL)
1165 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event.");
1166}
1167
1168static void
1169g_eli_fini(struct g_class *mp)
1170{
1171
1172 if (g_eli_pre_sync != NULL)
1173 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync);
1174}
1175
1176DECLARE_GEOM_CLASS(g_eli_class, g_eli);
1177MODULE_DEPEND(g_eli, crypto, 1, 1, 1);
2 * Copyright (c) 2005-2006 Pawel Jakub Dawidek <pjd@FreeBSD.org>
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: head/sys/geom/eli/g_eli.c 213067 2010-09-23 11:49:47Z pjd $");
29
30#include <sys/param.h>
31#include <sys/systm.h>
32#include <sys/kernel.h>
33#include <sys/linker.h>
34#include <sys/module.h>
35#include <sys/lock.h>
36#include <sys/mutex.h>
37#include <sys/bio.h>
38#include <sys/sysctl.h>
39#include <sys/malloc.h>
40#include <sys/eventhandler.h>
41#include <sys/kthread.h>
42#include <sys/proc.h>
43#include <sys/sched.h>
44#include <sys/smp.h>
45#include <sys/uio.h>
46#include <sys/vnode.h>
47
48#include <vm/uma.h>
49
50#include <geom/geom.h>
51#include <geom/eli/g_eli.h>
52#include <geom/eli/pkcs5v2.h>
53
54
55MALLOC_DEFINE(M_ELI, "eli data", "GEOM_ELI Data");
56
57SYSCTL_DECL(_kern_geom);
58SYSCTL_NODE(_kern_geom, OID_AUTO, eli, CTLFLAG_RW, 0, "GEOM_ELI stuff");
59u_int g_eli_debug = 0;
60TUNABLE_INT("kern.geom.eli.debug", &g_eli_debug);
61SYSCTL_UINT(_kern_geom_eli, OID_AUTO, debug, CTLFLAG_RW, &g_eli_debug, 0,
62 "Debug level");
63static u_int g_eli_tries = 3;
64TUNABLE_INT("kern.geom.eli.tries", &g_eli_tries);
65SYSCTL_UINT(_kern_geom_eli, OID_AUTO, tries, CTLFLAG_RW, &g_eli_tries, 0,
66 "Number of tries for entering the passphrase");
67static u_int g_eli_visible_passphrase = 0;
68TUNABLE_INT("kern.geom.eli.visible_passphrase", &g_eli_visible_passphrase);
69SYSCTL_UINT(_kern_geom_eli, OID_AUTO, visible_passphrase, CTLFLAG_RW,
70 &g_eli_visible_passphrase, 0,
71 "Turn on echo when entering the passphrase (for debug purposes only!!)");
72u_int g_eli_overwrites = G_ELI_OVERWRITES;
73TUNABLE_INT("kern.geom.eli.overwrites", &g_eli_overwrites);
74SYSCTL_UINT(_kern_geom_eli, OID_AUTO, overwrites, CTLFLAG_RW, &g_eli_overwrites,
75 0, "Number of times on-disk keys should be overwritten when destroying them");
76static u_int g_eli_threads = 0;
77TUNABLE_INT("kern.geom.eli.threads", &g_eli_threads);
78SYSCTL_UINT(_kern_geom_eli, OID_AUTO, threads, CTLFLAG_RW, &g_eli_threads, 0,
79 "Number of threads doing crypto work");
80u_int g_eli_batch = 0;
81TUNABLE_INT("kern.geom.eli.batch", &g_eli_batch);
82SYSCTL_UINT(_kern_geom_eli, OID_AUTO, batch, CTLFLAG_RW, &g_eli_batch, 0,
83 "Use crypto operations batching");
84
85static eventhandler_tag g_eli_pre_sync = NULL;
86
87static int g_eli_destroy_geom(struct gctl_req *req, struct g_class *mp,
88 struct g_geom *gp);
89static void g_eli_init(struct g_class *mp);
90static void g_eli_fini(struct g_class *mp);
91
92static g_taste_t g_eli_taste;
93static g_dumpconf_t g_eli_dumpconf;
94
95struct g_class g_eli_class = {
96 .name = G_ELI_CLASS_NAME,
97 .version = G_VERSION,
98 .ctlreq = g_eli_config,
99 .taste = g_eli_taste,
100 .destroy_geom = g_eli_destroy_geom,
101 .init = g_eli_init,
102 .fini = g_eli_fini
103};
104
105
106/*
107 * Code paths:
108 * BIO_READ:
109 * g_eli_start -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
110 * BIO_WRITE:
111 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
112 */
113
114
115/*
116 * EAGAIN from crypto(9) means, that we were probably balanced to another crypto
117 * accelerator or something like this.
118 * The function updates the SID and rerun the operation.
119 */
120int
121g_eli_crypto_rerun(struct cryptop *crp)
122{
123 struct g_eli_softc *sc;
124 struct g_eli_worker *wr;
125 struct bio *bp;
126 int error;
127
128 bp = (struct bio *)crp->crp_opaque;
129 sc = bp->bio_to->geom->softc;
130 LIST_FOREACH(wr, &sc->sc_workers, w_next) {
131 if (wr->w_number == bp->bio_pflags)
132 break;
133 }
134 KASSERT(wr != NULL, ("Invalid worker (%u).", bp->bio_pflags));
135 G_ELI_DEBUG(1, "Rerunning crypto %s request (sid: %ju -> %ju).",
136 bp->bio_cmd == BIO_READ ? "READ" : "WRITE", (uintmax_t)wr->w_sid,
137 (uintmax_t)crp->crp_sid);
138 wr->w_sid = crp->crp_sid;
139 crp->crp_etype = 0;
140 error = crypto_dispatch(crp);
141 if (error == 0)
142 return (0);
143 G_ELI_DEBUG(1, "%s: crypto_dispatch() returned %d.", __func__, error);
144 crp->crp_etype = error;
145 return (error);
146}
147
148/*
149 * The function is called afer reading encrypted data from the provider.
150 *
151 * g_eli_start -> g_io_request -> G_ELI_READ_DONE -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
152 */
153void
154g_eli_read_done(struct bio *bp)
155{
156 struct g_eli_softc *sc;
157 struct bio *pbp;
158
159 G_ELI_LOGREQ(2, bp, "Request done.");
160 pbp = bp->bio_parent;
161 if (pbp->bio_error == 0)
162 pbp->bio_error = bp->bio_error;
163 /*
164 * Do we have all sectors already?
165 */
166 pbp->bio_inbed++;
167 if (pbp->bio_inbed < pbp->bio_children)
168 return;
169 g_destroy_bio(bp);
170 if (pbp->bio_error != 0) {
171 G_ELI_LOGREQ(0, pbp, "%s() failed", __func__);
172 pbp->bio_completed = 0;
173 if (pbp->bio_driver2 != NULL) {
174 free(pbp->bio_driver2, M_ELI);
175 pbp->bio_driver2 = NULL;
176 }
177 g_io_deliver(pbp, pbp->bio_error);
178 return;
179 }
180 sc = pbp->bio_to->geom->softc;
181 mtx_lock(&sc->sc_queue_mtx);
182 bioq_insert_tail(&sc->sc_queue, pbp);
183 mtx_unlock(&sc->sc_queue_mtx);
184 wakeup(sc);
185}
186
187/*
188 * The function is called after we encrypt and write data.
189 *
190 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> G_ELI_WRITE_DONE -> g_io_deliver
191 */
192void
193g_eli_write_done(struct bio *bp)
194{
195 struct bio *pbp;
196
197 G_ELI_LOGREQ(2, bp, "Request done.");
198 pbp = bp->bio_parent;
199 if (pbp->bio_error == 0) {
200 if (bp->bio_error != 0)
201 pbp->bio_error = bp->bio_error;
202 }
203 /*
204 * Do we have all sectors already?
205 */
206 pbp->bio_inbed++;
207 if (pbp->bio_inbed < pbp->bio_children)
208 return;
209 free(pbp->bio_driver2, M_ELI);
210 pbp->bio_driver2 = NULL;
211 if (pbp->bio_error != 0) {
212 G_ELI_LOGREQ(0, pbp, "Crypto WRITE request failed (error=%d).",
213 pbp->bio_error);
214 pbp->bio_completed = 0;
215 }
216 g_destroy_bio(bp);
217 /*
218 * Write is finished, send it up.
219 */
220 pbp->bio_completed = pbp->bio_length;
221 g_io_deliver(pbp, pbp->bio_error);
222}
223
224/*
225 * This function should never be called, but GEOM made as it set ->orphan()
226 * method for every geom.
227 */
228static void
229g_eli_orphan_spoil_assert(struct g_consumer *cp)
230{
231
232 panic("Function %s() called for %s.", __func__, cp->geom->name);
233}
234
235static void
236g_eli_orphan(struct g_consumer *cp)
237{
238 struct g_eli_softc *sc;
239
240 g_topology_assert();
241 sc = cp->geom->softc;
242 if (sc == NULL)
243 return;
244 g_eli_destroy(sc, 1);
245}
246
247/*
248 * BIO_READ : G_ELI_START -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
249 * BIO_WRITE: G_ELI_START -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
250 */
251static void
252g_eli_start(struct bio *bp)
253{
254 struct g_eli_softc *sc;
255 struct g_consumer *cp;
256 struct bio *cbp;
257
258 sc = bp->bio_to->geom->softc;
259 KASSERT(sc != NULL,
260 ("Provider's error should be set (error=%d)(device=%s).",
261 bp->bio_to->error, bp->bio_to->name));
262 G_ELI_LOGREQ(2, bp, "Request received.");
263
264 switch (bp->bio_cmd) {
265 case BIO_READ:
266 case BIO_WRITE:
267 case BIO_GETATTR:
268 case BIO_FLUSH:
269 break;
270 case BIO_DELETE:
271 /*
272 * We could eventually support BIO_DELETE request.
273 * It could be done by overwritting requested sector with
274 * random data g_eli_overwrites number of times.
275 */
276 default:
277 g_io_deliver(bp, EOPNOTSUPP);
278 return;
279 }
280 cbp = g_clone_bio(bp);
281 if (cbp == NULL) {
282 g_io_deliver(bp, ENOMEM);
283 return;
284 }
285 switch (bp->bio_cmd) {
286 case BIO_READ:
287 if (!(sc->sc_flags & G_ELI_FLAG_AUTH)) {
288 bp->bio_driver2 = NULL;
289 cbp->bio_done = g_eli_read_done;
290 cp = LIST_FIRST(&sc->sc_geom->consumer);
291 cbp->bio_to = cp->provider;
292 G_ELI_LOGREQ(2, cbp, "Sending request.");
293 /*
294 * Read encrypted data from provider.
295 */
296 g_io_request(cbp, cp);
297 break;
298 }
299 bp->bio_pflags = 255;
300 /* FALLTHROUGH */
301 case BIO_WRITE:
302 bp->bio_driver1 = cbp;
303 mtx_lock(&sc->sc_queue_mtx);
304 bioq_insert_tail(&sc->sc_queue, bp);
305 mtx_unlock(&sc->sc_queue_mtx);
306 wakeup(sc);
307 break;
308 case BIO_GETATTR:
309 case BIO_FLUSH:
310 cbp->bio_done = g_std_done;
311 cp = LIST_FIRST(&sc->sc_geom->consumer);
312 cbp->bio_to = cp->provider;
313 G_ELI_LOGREQ(2, cbp, "Sending request.");
314 g_io_request(cbp, cp);
315 break;
316 }
317}
318
319/*
320 * This is the main function for kernel worker thread when we don't have
321 * hardware acceleration and we have to do cryptography in software.
322 * Dedicated thread is needed, so we don't slow down g_up/g_down GEOM
323 * threads with crypto work.
324 */
325static void
326g_eli_worker(void *arg)
327{
328 struct g_eli_softc *sc;
329 struct g_eli_worker *wr;
330 struct bio *bp;
331
332 wr = arg;
333 sc = wr->w_softc;
334#ifdef SMP
335 /* Before sched_bind() to a CPU, wait for all CPUs to go on-line. */
336 if (mp_ncpus > 1 && sc->sc_crypto == G_ELI_CRYPTO_SW &&
337 g_eli_threads == 0) {
338 while (!smp_started)
339 tsleep(wr, 0, "geli:smp", hz / 4);
340 }
341#endif
342 thread_lock(curthread);
343 sched_prio(curthread, PUSER);
344 if (sc->sc_crypto == G_ELI_CRYPTO_SW && g_eli_threads == 0)
345 sched_bind(curthread, wr->w_number);
346 thread_unlock(curthread);
347
348 G_ELI_DEBUG(1, "Thread %s started.", curthread->td_proc->p_comm);
349
350 for (;;) {
351 mtx_lock(&sc->sc_queue_mtx);
352 bp = bioq_takefirst(&sc->sc_queue);
353 if (bp == NULL) {
354 if (sc->sc_flags & G_ELI_FLAG_DESTROY) {
355 LIST_REMOVE(wr, w_next);
356 crypto_freesession(wr->w_sid);
357 free(wr, M_ELI);
358 G_ELI_DEBUG(1, "Thread %s exiting.",
359 curthread->td_proc->p_comm);
360 wakeup(&sc->sc_workers);
361 mtx_unlock(&sc->sc_queue_mtx);
362 kproc_exit(0);
363 }
364 msleep(sc, &sc->sc_queue_mtx, PDROP, "geli:w", 0);
365 continue;
366 }
367 mtx_unlock(&sc->sc_queue_mtx);
368 if (bp->bio_cmd == BIO_READ && bp->bio_pflags == 255)
369 g_eli_auth_read(sc, bp);
370 else if (sc->sc_flags & G_ELI_FLAG_AUTH)
371 g_eli_auth_run(wr, bp);
372 else
373 g_eli_crypto_run(wr, bp);
374 }
375}
376
377/*
378 * Select encryption key. If G_ELI_FLAG_SINGLE_KEY is present we only have one
379 * key available for all the data. If the flag is not present select the key
380 * based on data offset.
381 */
382uint8_t *
383g_eli_crypto_key(struct g_eli_softc *sc, off_t offset, size_t blocksize)
384{
385 u_int nkey;
386
387 if (sc->sc_nekeys == 1)
388 return (sc->sc_ekeys[0]);
389
390 KASSERT(sc->sc_nekeys > 1, ("%s: sc_nekeys=%u", __func__,
391 sc->sc_nekeys));
392 KASSERT((sc->sc_flags & G_ELI_FLAG_SINGLE_KEY) == 0,
393 ("%s: SINGLE_KEY flag set, but sc_nekeys=%u", __func__,
394 sc->sc_nekeys));
395
396 /* We switch key every 2^G_ELI_KEY_SHIFT blocks. */
397 nkey = (offset >> G_ELI_KEY_SHIFT) / blocksize;
398
399 KASSERT(nkey < sc->sc_nekeys, ("%s: nkey=%u >= sc_nekeys=%u", __func__,
400 nkey, sc->sc_nekeys));
401
402 return (sc->sc_ekeys[nkey]);
403}
404
405/*
406 * Here we generate IV. It is unique for every sector.
407 */
408void
409g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
410 size_t size)
411{
412 u_char off[8], hash[SHA256_DIGEST_LENGTH];
413 SHA256_CTX ctx;
414
415 if ((sc->sc_flags & G_ELI_FLAG_NATIVE_BYTE_ORDER) != 0)
416 bcopy(&offset, off, sizeof(off));
417 else
418 le64enc(off, (uint64_t)offset);
419 /* Copy precalculated SHA256 context for IV-Key. */
420 bcopy(&sc->sc_ivctx, &ctx, sizeof(ctx));
421 SHA256_Update(&ctx, off, sizeof(off));
422 SHA256_Final(hash, &ctx);
423 bcopy(hash, iv, size);
424}
425
426int
427g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
428 struct g_eli_metadata *md)
429{
430 struct g_geom *gp;
431 struct g_consumer *cp;
432 u_char *buf = NULL;
433 int error;
434
435 g_topology_assert();
436
437 gp = g_new_geomf(mp, "eli:taste");
438 gp->start = g_eli_start;
439 gp->access = g_std_access;
440 /*
441 * g_eli_read_metadata() is always called from the event thread.
442 * Our geom is created and destroyed in the same event, so there
443 * could be no orphan nor spoil event in the meantime.
444 */
445 gp->orphan = g_eli_orphan_spoil_assert;
446 gp->spoiled = g_eli_orphan_spoil_assert;
447 cp = g_new_consumer(gp);
448 error = g_attach(cp, pp);
449 if (error != 0)
450 goto end;
451 error = g_access(cp, 1, 0, 0);
452 if (error != 0)
453 goto end;
454 g_topology_unlock();
455 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
456 &error);
457 g_topology_lock();
458 if (buf == NULL)
459 goto end;
460 eli_metadata_decode(buf, md);
461end:
462 if (buf != NULL)
463 g_free(buf);
464 if (cp->provider != NULL) {
465 if (cp->acr == 1)
466 g_access(cp, -1, 0, 0);
467 g_detach(cp);
468 }
469 g_destroy_consumer(cp);
470 g_destroy_geom(gp);
471 return (error);
472}
473
474/*
475 * The function is called when we had last close on provider and user requested
476 * to close it when this situation occur.
477 */
478static void
479g_eli_last_close(struct g_eli_softc *sc)
480{
481 struct g_geom *gp;
482 struct g_provider *pp;
483 char ppname[64];
484 int error;
485
486 g_topology_assert();
487 gp = sc->sc_geom;
488 pp = LIST_FIRST(&gp->provider);
489 strlcpy(ppname, pp->name, sizeof(ppname));
490 error = g_eli_destroy(sc, 1);
491 KASSERT(error == 0, ("Cannot detach %s on last close (error=%d).",
492 ppname, error));
493 G_ELI_DEBUG(0, "Detached %s on last close.", ppname);
494}
495
496int
497g_eli_access(struct g_provider *pp, int dr, int dw, int de)
498{
499 struct g_eli_softc *sc;
500 struct g_geom *gp;
501
502 gp = pp->geom;
503 sc = gp->softc;
504
505 if (dw > 0) {
506 if (sc->sc_flags & G_ELI_FLAG_RO) {
507 /* Deny write attempts. */
508 return (EROFS);
509 }
510 /* Someone is opening us for write, we need to remember that. */
511 sc->sc_flags |= G_ELI_FLAG_WOPEN;
512 return (0);
513 }
514 /* Is this the last close? */
515 if (pp->acr + dr > 0 || pp->acw + dw > 0 || pp->ace + de > 0)
516 return (0);
517
518 /*
519 * Automatically detach on last close if requested.
520 */
521 if ((sc->sc_flags & G_ELI_FLAG_RW_DETACH) ||
522 (sc->sc_flags & G_ELI_FLAG_WOPEN)) {
523 g_eli_last_close(sc);
524 }
525 return (0);
526}
527
528static int
529g_eli_cpu_is_disabled(int cpu)
530{
531#ifdef SMP
532 return ((hlt_cpus_mask & (1 << cpu)) != 0);
533#else
534 return (0);
535#endif
536}
537
538struct g_geom *
539g_eli_create(struct gctl_req *req, struct g_class *mp, struct g_provider *bpp,
540 const struct g_eli_metadata *md, const u_char *mkey, int nkey)
541{
542 struct g_eli_softc *sc;
543 struct g_eli_worker *wr;
544 struct g_geom *gp;
545 struct g_provider *pp;
546 struct g_consumer *cp;
547 struct cryptoini crie, cria;
548 u_int i, threads;
549 int error;
550
551 G_ELI_DEBUG(1, "Creating device %s%s.", bpp->name, G_ELI_SUFFIX);
552
553 gp = g_new_geomf(mp, "%s%s", bpp->name, G_ELI_SUFFIX);
554 gp->softc = NULL; /* for a moment */
555
556 sc = malloc(sizeof(*sc), M_ELI, M_WAITOK | M_ZERO);
557 gp->start = g_eli_start;
558 /*
559 * Spoiling cannot happen actually, because we keep provider open for
560 * writing all the time or provider is read-only.
561 */
562 gp->spoiled = g_eli_orphan_spoil_assert;
563 gp->orphan = g_eli_orphan;
564 gp->dumpconf = g_eli_dumpconf;
565 /*
566 * If detach-on-last-close feature is not enabled and we don't operate
567 * on read-only provider, we can simply use g_std_access().
568 */
569 if (md->md_flags & (G_ELI_FLAG_WO_DETACH | G_ELI_FLAG_RO))
570 gp->access = g_eli_access;
571 else
572 gp->access = g_std_access;
573
574 sc->sc_crypto = G_ELI_CRYPTO_SW;
575 sc->sc_flags = md->md_flags;
576 /* Backward compatibility. */
577 if (md->md_version < 4)
578 sc->sc_flags |= G_ELI_FLAG_NATIVE_BYTE_ORDER;
579 if (md->md_version < 5)
580 sc->sc_flags |= G_ELI_FLAG_SINGLE_KEY;
581 sc->sc_ealgo = md->md_ealgo;
582 sc->sc_nkey = nkey;
583
584 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
585 sc->sc_akeylen = sizeof(sc->sc_akey) * 8;
586 sc->sc_aalgo = md->md_aalgo;
587 sc->sc_alen = g_eli_hashlen(sc->sc_aalgo);
588
589 sc->sc_data_per_sector = bpp->sectorsize - sc->sc_alen;
590 /*
591 * Some hash functions (like SHA1 and RIPEMD160) generates hash
592 * which length is not multiple of 128 bits, but we want data
593 * length to be multiple of 128, so we can encrypt without
594 * padding. The line below rounds down data length to multiple
595 * of 128 bits.
596 */
597 sc->sc_data_per_sector -= sc->sc_data_per_sector % 16;
598
599 sc->sc_bytes_per_sector =
600 (md->md_sectorsize - 1) / sc->sc_data_per_sector + 1;
601 sc->sc_bytes_per_sector *= bpp->sectorsize;
602 /*
603 * Precalculate SHA256 for HMAC key generation.
604 * This is expensive operation and we can do it only once now or
605 * for every access to sector, so now will be much better.
606 */
607 SHA256_Init(&sc->sc_akeyctx);
608 SHA256_Update(&sc->sc_akeyctx, sc->sc_akey,
609 sizeof(sc->sc_akey));
610 }
611
612 gp->softc = sc;
613 sc->sc_geom = gp;
614
615 bioq_init(&sc->sc_queue);
616 mtx_init(&sc->sc_queue_mtx, "geli:queue", NULL, MTX_DEF);
617
618 pp = NULL;
619 cp = g_new_consumer(gp);
620 error = g_attach(cp, bpp);
621 if (error != 0) {
622 if (req != NULL) {
623 gctl_error(req, "Cannot attach to %s (error=%d).",
624 bpp->name, error);
625 } else {
626 G_ELI_DEBUG(1, "Cannot attach to %s (error=%d).",
627 bpp->name, error);
628 }
629 goto failed;
630 }
631 /*
632 * Keep provider open all the time, so we can run critical tasks,
633 * like Master Keys deletion, without wondering if we can open
634 * provider or not.
635 * We don't open provider for writing only when user requested read-only
636 * access.
637 */
638 if (sc->sc_flags & G_ELI_FLAG_RO)
639 error = g_access(cp, 1, 0, 1);
640 else
641 error = g_access(cp, 1, 1, 1);
642 if (error != 0) {
643 if (req != NULL) {
644 gctl_error(req, "Cannot access %s (error=%d).",
645 bpp->name, error);
646 } else {
647 G_ELI_DEBUG(1, "Cannot access %s (error=%d).",
648 bpp->name, error);
649 }
650 goto failed;
651 }
652
653 sc->sc_sectorsize = md->md_sectorsize;
654 sc->sc_mediasize = bpp->mediasize;
655 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME))
656 sc->sc_mediasize -= bpp->sectorsize;
657 if (!(sc->sc_flags & G_ELI_FLAG_AUTH))
658 sc->sc_mediasize -= (sc->sc_mediasize % sc->sc_sectorsize);
659 else {
660 sc->sc_mediasize /= sc->sc_bytes_per_sector;
661 sc->sc_mediasize *= sc->sc_sectorsize;
662 }
663
664 /*
665 * Remember the keys in our softc structure.
666 */
667 g_eli_mkey_propagate(sc, mkey);
668 sc->sc_ekeylen = md->md_keylen;
669
670 /*
671 * Precalculate SHA256 for IV generation.
672 * This is expensive operation and we can do it only once now or for
673 * every access to sector, so now will be much better.
674 */
675 SHA256_Init(&sc->sc_ivctx);
676 SHA256_Update(&sc->sc_ivctx, sc->sc_ivkey, sizeof(sc->sc_ivkey));
677
678 LIST_INIT(&sc->sc_workers);
679
680 bzero(&crie, sizeof(crie));
681 crie.cri_alg = sc->sc_ealgo;
682 crie.cri_klen = sc->sc_ekeylen;
683 crie.cri_key = sc->sc_ekeys[0];
684 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
685 bzero(&cria, sizeof(cria));
686 cria.cri_alg = sc->sc_aalgo;
687 cria.cri_klen = sc->sc_akeylen;
688 cria.cri_key = sc->sc_akey;
689 crie.cri_next = &cria;
690 }
691
692 threads = g_eli_threads;
693 if (threads == 0)
694 threads = mp_ncpus;
695 else if (threads > mp_ncpus) {
696 /* There is really no need for too many worker threads. */
697 threads = mp_ncpus;
698 G_ELI_DEBUG(0, "Reducing number of threads to %u.", threads);
699 }
700 for (i = 0; i < threads; i++) {
701 if (g_eli_cpu_is_disabled(i)) {
702 G_ELI_DEBUG(1, "%s: CPU %u disabled, skipping.",
703 bpp->name, i);
704 continue;
705 }
706 wr = malloc(sizeof(*wr), M_ELI, M_WAITOK | M_ZERO);
707 wr->w_softc = sc;
708 wr->w_number = i;
709
710 /*
711 * If this is the first pass, try to get hardware support.
712 * Use software cryptography, if we cannot get it.
713 */
714 if (LIST_EMPTY(&sc->sc_workers)) {
715 error = crypto_newsession(&wr->w_sid, &crie,
716 CRYPTOCAP_F_HARDWARE);
717 if (error == 0)
718 sc->sc_crypto = G_ELI_CRYPTO_HW;
719 }
720 if (sc->sc_crypto == G_ELI_CRYPTO_SW) {
721 error = crypto_newsession(&wr->w_sid, &crie,
722 CRYPTOCAP_F_SOFTWARE);
723 }
724 if (error != 0) {
725 free(wr, M_ELI);
726 if (req != NULL) {
727 gctl_error(req, "Cannot set up crypto session "
728 "for %s (error=%d).", bpp->name, error);
729 } else {
730 G_ELI_DEBUG(1, "Cannot set up crypto session "
731 "for %s (error=%d).", bpp->name, error);
732 }
733 goto failed;
734 }
735
736 error = kproc_create(g_eli_worker, wr, &wr->w_proc, 0, 0,
737 "g_eli[%u] %s", i, bpp->name);
738 if (error != 0) {
739 crypto_freesession(wr->w_sid);
740 free(wr, M_ELI);
741 if (req != NULL) {
742 gctl_error(req, "Cannot create kernel thread "
743 "for %s (error=%d).", bpp->name, error);
744 } else {
745 G_ELI_DEBUG(1, "Cannot create kernel thread "
746 "for %s (error=%d).", bpp->name, error);
747 }
748 goto failed;
749 }
750 LIST_INSERT_HEAD(&sc->sc_workers, wr, w_next);
751 /* If we have hardware support, one thread is enough. */
752 if (sc->sc_crypto == G_ELI_CRYPTO_HW)
753 break;
754 }
755
756 /*
757 * Create decrypted provider.
758 */
759 pp = g_new_providerf(gp, "%s%s", bpp->name, G_ELI_SUFFIX);
760 pp->mediasize = sc->sc_mediasize;
761 pp->sectorsize = sc->sc_sectorsize;
762
763 g_error_provider(pp, 0);
764
765 G_ELI_DEBUG(0, "Device %s created.", pp->name);
766 G_ELI_DEBUG(0, "Encryption: %s %u", g_eli_algo2str(sc->sc_ealgo),
767 sc->sc_ekeylen);
768 if (sc->sc_flags & G_ELI_FLAG_AUTH)
769 G_ELI_DEBUG(0, " Integrity: %s", g_eli_algo2str(sc->sc_aalgo));
770 G_ELI_DEBUG(0, " Crypto: %s",
771 sc->sc_crypto == G_ELI_CRYPTO_SW ? "software" : "hardware");
772 return (gp);
773failed:
774 mtx_lock(&sc->sc_queue_mtx);
775 sc->sc_flags |= G_ELI_FLAG_DESTROY;
776 wakeup(sc);
777 /*
778 * Wait for kernel threads self destruction.
779 */
780 while (!LIST_EMPTY(&sc->sc_workers)) {
781 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
782 "geli:destroy", 0);
783 }
784 mtx_destroy(&sc->sc_queue_mtx);
785 if (cp->provider != NULL) {
786 if (cp->acr == 1)
787 g_access(cp, -1, -1, -1);
788 g_detach(cp);
789 }
790 g_destroy_consumer(cp);
791 g_destroy_geom(gp);
792 if (sc->sc_ekeys != NULL) {
793 bzero(sc->sc_ekeys,
794 sc->sc_nekeys * (sizeof(uint8_t *) + G_ELI_DATAKEYLEN));
795 free(sc->sc_ekeys, M_ELI);
796 }
797 bzero(sc, sizeof(*sc));
798 free(sc, M_ELI);
799 return (NULL);
800}
801
802int
803g_eli_destroy(struct g_eli_softc *sc, boolean_t force)
804{
805 struct g_geom *gp;
806 struct g_provider *pp;
807
808 g_topology_assert();
809
810 if (sc == NULL)
811 return (ENXIO);
812
813 gp = sc->sc_geom;
814 pp = LIST_FIRST(&gp->provider);
815 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
816 if (force) {
817 G_ELI_DEBUG(1, "Device %s is still open, so it "
818 "cannot be definitely removed.", pp->name);
819 } else {
820 G_ELI_DEBUG(1,
821 "Device %s is still open (r%dw%de%d).", pp->name,
822 pp->acr, pp->acw, pp->ace);
823 return (EBUSY);
824 }
825 }
826
827 mtx_lock(&sc->sc_queue_mtx);
828 sc->sc_flags |= G_ELI_FLAG_DESTROY;
829 wakeup(sc);
830 while (!LIST_EMPTY(&sc->sc_workers)) {
831 msleep(&sc->sc_workers, &sc->sc_queue_mtx, PRIBIO,
832 "geli:destroy", 0);
833 }
834 mtx_destroy(&sc->sc_queue_mtx);
835 gp->softc = NULL;
836 bzero(sc->sc_ekeys,
837 sc->sc_nekeys * (sizeof(uint8_t *) + G_ELI_DATAKEYLEN));
838 free(sc->sc_ekeys, M_ELI);
839 bzero(sc, sizeof(*sc));
840 free(sc, M_ELI);
841
842 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
843 G_ELI_DEBUG(0, "Device %s destroyed.", gp->name);
844 g_wither_geom_close(gp, ENXIO);
845
846 return (0);
847}
848
849static int
850g_eli_destroy_geom(struct gctl_req *req __unused,
851 struct g_class *mp __unused, struct g_geom *gp)
852{
853 struct g_eli_softc *sc;
854
855 sc = gp->softc;
856 return (g_eli_destroy(sc, 0));
857}
858
859static int
860g_eli_keyfiles_load(struct hmac_ctx *ctx, const char *provider)
861{
862 u_char *keyfile, *data, *size;
863 char *file, name[64];
864 int i;
865
866 for (i = 0; ; i++) {
867 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
868 keyfile = preload_search_by_type(name);
869 if (keyfile == NULL)
870 return (i); /* Return number of loaded keyfiles. */
871 data = preload_search_info(keyfile, MODINFO_ADDR);
872 if (data == NULL) {
873 G_ELI_DEBUG(0, "Cannot find key file data for %s.",
874 name);
875 return (0);
876 }
877 data = *(void **)data;
878 size = preload_search_info(keyfile, MODINFO_SIZE);
879 if (size == NULL) {
880 G_ELI_DEBUG(0, "Cannot find key file size for %s.",
881 name);
882 return (0);
883 }
884 file = preload_search_info(keyfile, MODINFO_NAME);
885 if (file == NULL) {
886 G_ELI_DEBUG(0, "Cannot find key file name for %s.",
887 name);
888 return (0);
889 }
890 G_ELI_DEBUG(1, "Loaded keyfile %s for %s (type: %s).", file,
891 provider, name);
892 g_eli_crypto_hmac_update(ctx, data, *(size_t *)size);
893 }
894}
895
896static void
897g_eli_keyfiles_clear(const char *provider)
898{
899 u_char *keyfile, *data, *size;
900 char name[64];
901 int i;
902
903 for (i = 0; ; i++) {
904 snprintf(name, sizeof(name), "%s:geli_keyfile%d", provider, i);
905 keyfile = preload_search_by_type(name);
906 if (keyfile == NULL)
907 return;
908 data = preload_search_info(keyfile, MODINFO_ADDR);
909 size = preload_search_info(keyfile, MODINFO_SIZE);
910 if (data == NULL || size == NULL)
911 continue;
912 data = *(void **)data;
913 bzero(data, *(size_t *)size);
914 }
915}
916
917/*
918 * Tasting is only made on boot.
919 * We detect providers which should be attached before root is mounted.
920 */
921static struct g_geom *
922g_eli_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
923{
924 struct g_eli_metadata md;
925 struct g_geom *gp;
926 struct hmac_ctx ctx;
927 char passphrase[256];
928 u_char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
929 u_int i, nkey, nkeyfiles, tries;
930 int error;
931
932 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
933 g_topology_assert();
934
935 if (root_mounted() || g_eli_tries == 0)
936 return (NULL);
937
938 G_ELI_DEBUG(3, "Tasting %s.", pp->name);
939
940 error = g_eli_read_metadata(mp, pp, &md);
941 if (error != 0)
942 return (NULL);
943 gp = NULL;
944
945 if (strcmp(md.md_magic, G_ELI_MAGIC) != 0)
946 return (NULL);
947 if (md.md_version > G_ELI_VERSION) {
948 printf("geom_eli.ko module is too old to handle %s.\n",
949 pp->name);
950 return (NULL);
951 }
952 if (md.md_provsize != pp->mediasize)
953 return (NULL);
954 /* Should we attach it on boot? */
955 if (!(md.md_flags & G_ELI_FLAG_BOOT))
956 return (NULL);
957 if (md.md_keys == 0x00) {
958 G_ELI_DEBUG(0, "No valid keys on %s.", pp->name);
959 return (NULL);
960 }
961 if (md.md_iterations == -1) {
962 /* If there is no passphrase, we try only once. */
963 tries = 1;
964 } else {
965 /* Ask for the passphrase no more than g_eli_tries times. */
966 tries = g_eli_tries;
967 }
968
969 for (i = 0; i < tries; i++) {
970 g_eli_crypto_hmac_init(&ctx, NULL, 0);
971
972 /*
973 * Load all key files.
974 */
975 nkeyfiles = g_eli_keyfiles_load(&ctx, pp->name);
976
977 if (nkeyfiles == 0 && md.md_iterations == -1) {
978 /*
979 * No key files and no passphrase, something is
980 * definitely wrong here.
981 * geli(8) doesn't allow for such situation, so assume
982 * that there was really no passphrase and in that case
983 * key files are no properly defined in loader.conf.
984 */
985 G_ELI_DEBUG(0,
986 "Found no key files in loader.conf for %s.",
987 pp->name);
988 return (NULL);
989 }
990
991 /* Ask for the passphrase if defined. */
992 if (md.md_iterations >= 0) {
993 printf("Enter passphrase for %s: ", pp->name);
994 gets(passphrase, sizeof(passphrase),
995 g_eli_visible_passphrase);
996 }
997
998 /*
999 * Prepare Derived-Key from the user passphrase.
1000 */
1001 if (md.md_iterations == 0) {
1002 g_eli_crypto_hmac_update(&ctx, md.md_salt,
1003 sizeof(md.md_salt));
1004 g_eli_crypto_hmac_update(&ctx, passphrase,
1005 strlen(passphrase));
1006 bzero(passphrase, sizeof(passphrase));
1007 } else if (md.md_iterations > 0) {
1008 u_char dkey[G_ELI_USERKEYLEN];
1009
1010 pkcs5v2_genkey(dkey, sizeof(dkey), md.md_salt,
1011 sizeof(md.md_salt), passphrase, md.md_iterations);
1012 bzero(passphrase, sizeof(passphrase));
1013 g_eli_crypto_hmac_update(&ctx, dkey, sizeof(dkey));
1014 bzero(dkey, sizeof(dkey));
1015 }
1016
1017 g_eli_crypto_hmac_final(&ctx, key, 0);
1018
1019 /*
1020 * Decrypt Master-Key.
1021 */
1022 error = g_eli_mkey_decrypt(&md, key, mkey, &nkey);
1023 bzero(key, sizeof(key));
1024 if (error == -1) {
1025 if (i == tries - 1) {
1026 G_ELI_DEBUG(0,
1027 "Wrong key for %s. No tries left.",
1028 pp->name);
1029 g_eli_keyfiles_clear(pp->name);
1030 return (NULL);
1031 }
1032 G_ELI_DEBUG(0, "Wrong key for %s. Tries left: %u.",
1033 pp->name, tries - i - 1);
1034 /* Try again. */
1035 continue;
1036 } else if (error > 0) {
1037 G_ELI_DEBUG(0, "Cannot decrypt Master Key for %s (error=%d).",
1038 pp->name, error);
1039 g_eli_keyfiles_clear(pp->name);
1040 return (NULL);
1041 }
1042 G_ELI_DEBUG(1, "Using Master Key %u for %s.", nkey, pp->name);
1043 break;
1044 }
1045
1046 /*
1047 * We have correct key, let's attach provider.
1048 */
1049 gp = g_eli_create(NULL, mp, pp, &md, mkey, nkey);
1050 bzero(mkey, sizeof(mkey));
1051 bzero(&md, sizeof(md));
1052 if (gp == NULL) {
1053 G_ELI_DEBUG(0, "Cannot create device %s%s.", pp->name,
1054 G_ELI_SUFFIX);
1055 return (NULL);
1056 }
1057 return (gp);
1058}
1059
1060static void
1061g_eli_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1062 struct g_consumer *cp, struct g_provider *pp)
1063{
1064 struct g_eli_softc *sc;
1065
1066 g_topology_assert();
1067 sc = gp->softc;
1068 if (sc == NULL)
1069 return;
1070 if (pp != NULL || cp != NULL)
1071 return; /* Nothing here. */
1072 sbuf_printf(sb, "%s<Flags>", indent);
1073 if (sc->sc_flags == 0)
1074 sbuf_printf(sb, "NONE");
1075 else {
1076 int first = 1;
1077
1078#define ADD_FLAG(flag, name) do { \
1079 if (sc->sc_flags & (flag)) { \
1080 if (!first) \
1081 sbuf_printf(sb, ", "); \
1082 else \
1083 first = 0; \
1084 sbuf_printf(sb, name); \
1085 } \
1086} while (0)
1087 ADD_FLAG(G_ELI_FLAG_SINGLE_KEY, "SINGLE-KEY");
1088 ADD_FLAG(G_ELI_FLAG_NATIVE_BYTE_ORDER, "NATIVE-BYTE-ORDER");
1089 ADD_FLAG(G_ELI_FLAG_ONETIME, "ONETIME");
1090 ADD_FLAG(G_ELI_FLAG_BOOT, "BOOT");
1091 ADD_FLAG(G_ELI_FLAG_WO_DETACH, "W-DETACH");
1092 ADD_FLAG(G_ELI_FLAG_RW_DETACH, "RW-DETACH");
1093 ADD_FLAG(G_ELI_FLAG_AUTH, "AUTH");
1094 ADD_FLAG(G_ELI_FLAG_WOPEN, "W-OPEN");
1095 ADD_FLAG(G_ELI_FLAG_DESTROY, "DESTROY");
1096 ADD_FLAG(G_ELI_FLAG_RO, "READ-ONLY");
1097#undef ADD_FLAG
1098 }
1099 sbuf_printf(sb, "</Flags>\n");
1100
1101 if (!(sc->sc_flags & G_ELI_FLAG_ONETIME)) {
1102 sbuf_printf(sb, "%s<UsedKey>%u</UsedKey>\n", indent,
1103 sc->sc_nkey);
1104 }
1105 sbuf_printf(sb, "%s<Crypto>", indent);
1106 switch (sc->sc_crypto) {
1107 case G_ELI_CRYPTO_HW:
1108 sbuf_printf(sb, "hardware");
1109 break;
1110 case G_ELI_CRYPTO_SW:
1111 sbuf_printf(sb, "software");
1112 break;
1113 default:
1114 sbuf_printf(sb, "UNKNOWN");
1115 break;
1116 }
1117 sbuf_printf(sb, "</Crypto>\n");
1118 if (sc->sc_flags & G_ELI_FLAG_AUTH) {
1119 sbuf_printf(sb,
1120 "%s<AuthenticationAlgorithm>%s</AuthenticationAlgorithm>\n",
1121 indent, g_eli_algo2str(sc->sc_aalgo));
1122 }
1123 sbuf_printf(sb, "%s<KeyLength>%u</KeyLength>\n", indent,
1124 sc->sc_ekeylen);
1125 sbuf_printf(sb, "%s<EncryptionAlgorithm>%s</EncryptionAlgorithm>\n", indent,
1126 g_eli_algo2str(sc->sc_ealgo));
1127}
1128
1129static void
1130g_eli_shutdown_pre_sync(void *arg, int howto)
1131{
1132 struct g_class *mp;
1133 struct g_geom *gp, *gp2;
1134 struct g_provider *pp;
1135 struct g_eli_softc *sc;
1136 int error;
1137
1138 mp = arg;
1139 DROP_GIANT();
1140 g_topology_lock();
1141 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
1142 sc = gp->softc;
1143 if (sc == NULL)
1144 continue;
1145 pp = LIST_FIRST(&gp->provider);
1146 KASSERT(pp != NULL, ("No provider? gp=%p (%s)", gp, gp->name));
1147 if (pp->acr + pp->acw + pp->ace == 0)
1148 error = g_eli_destroy(sc, 1);
1149 else {
1150 sc->sc_flags |= G_ELI_FLAG_RW_DETACH;
1151 gp->access = g_eli_access;
1152 }
1153 }
1154 g_topology_unlock();
1155 PICKUP_GIANT();
1156}
1157
1158static void
1159g_eli_init(struct g_class *mp)
1160{
1161
1162 g_eli_pre_sync = EVENTHANDLER_REGISTER(shutdown_pre_sync,
1163 g_eli_shutdown_pre_sync, mp, SHUTDOWN_PRI_FIRST);
1164 if (g_eli_pre_sync == NULL)
1165 G_ELI_DEBUG(0, "Warning! Cannot register shutdown event.");
1166}
1167
1168static void
1169g_eli_fini(struct g_class *mp)
1170{
1171
1172 if (g_eli_pre_sync != NULL)
1173 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, g_eli_pre_sync);
1174}
1175
1176DECLARE_GEOM_CLASS(g_eli_class, g_eli);
1177MODULE_DEPEND(g_eli, crypto, 1, 1, 1);