The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/geom/eli/g_eli.c

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: d35a7ea9968890d5e1a4e9cac961face


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.