2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2004-2019 Pawel Jakub Dawidek <pawel@dawidek.net>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/sysctl.h>
35 #include <sys/resource.h>
36 #include <opencrypto/cryptodev.h>
44 #include <readpassphrase.h>
53 #include <geom/eli/g_eli.h>
54 #include <geom/eli/pkcs5v2.h>
56 #include "core/geom.h"
57 #include "misc/subr.h"
60 uint32_t lib_version = G_LIB_VERSION;
61 uint32_t version = G_ELI_VERSION;
63 #define GELI_BACKUP_DIR "/var/backups/"
64 #define GELI_ENC_ALGO "aes"
68 * Passphrase cached when attaching multiple providers, in order to be more
69 * user-friendly if they are using the same passphrase.
71 static char cached_passphrase[BUFSIZE] = "";
73 static void eli_main(struct gctl_req *req, unsigned flags);
74 static void eli_init(struct gctl_req *req);
75 static void eli_attach(struct gctl_req *req);
76 static void eli_configure(struct gctl_req *req);
77 static void eli_setkey(struct gctl_req *req);
78 static void eli_delkey(struct gctl_req *req);
79 static void eli_resume(struct gctl_req *req);
80 static void eli_kill(struct gctl_req *req);
81 static void eli_backup(struct gctl_req *req);
82 static void eli_restore(struct gctl_req *req);
83 static void eli_resize(struct gctl_req *req);
84 static void eli_version(struct gctl_req *req);
85 static void eli_clear(struct gctl_req *req);
86 static void eli_dump(struct gctl_req *req);
88 static int eli_backup_create(struct gctl_req *req, const char *prov,
94 * init [-bdgPRTv] [-a aalgo] [-B backupfile] [-e ealgo] [-i iterations] [-l keylen] [-J newpassfile] [-K newkeyfile] [-s sectorsize] [-V version] prov ...
95 * label - alias for 'init'
96 * attach [-Cdprv] [-n keyno] [-j passfile] [-k keyfile] prov ...
97 * detach [-fl] prov ...
98 * stop - alias for 'detach'
99 * onetime [-dRT] [-a aalgo] [-e ealgo] [-l keylen] prov
100 * configure [-bBgGrRtT] prov ...
101 * setkey [-pPv] [-n keyno] [-j passfile] [-J newpassfile] [-k keyfile] [-K newkeyfile] prov
102 * delkey [-afv] [-n keyno] prov
103 * suspend [-v] -a | prov ...
104 * resume [-pv] [-j passfile] [-k keyfile] prov
105 * kill [-av] [prov ...]
106 * backup [-v] prov file
107 * restore [-fv] file prov
108 * resize [-v] -s oldsize prov
110 * clear [-v] prov ...
113 struct g_command class_commands[] = {
114 { "init", G_FLAG_VERBOSE, eli_main,
116 { 'a', "aalgo", "", G_TYPE_STRING },
117 { 'b', "boot", NULL, G_TYPE_BOOL },
118 { 'B', "backupfile", "", G_TYPE_STRING },
119 { 'd', "displaypass", NULL, G_TYPE_BOOL },
120 { 'e', "ealgo", "", G_TYPE_STRING },
121 { 'g', "geliboot", NULL, G_TYPE_BOOL },
122 { 'i', "iterations", "-1", G_TYPE_NUMBER },
123 { 'J', "newpassfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
124 { 'K', "newkeyfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
125 { 'l', "keylen", "0", G_TYPE_NUMBER },
126 { 'P', "nonewpassphrase", NULL, G_TYPE_BOOL },
127 { 'R', "noautoresize", NULL, G_TYPE_BOOL },
128 { 's', "sectorsize", "0", G_TYPE_NUMBER },
129 { 'T', "notrim", NULL, G_TYPE_BOOL },
130 { 'V', "mdversion", "-1", G_TYPE_NUMBER },
133 "[-bdgPRTv] [-a aalgo] [-B backupfile] [-e ealgo] [-i iterations] [-l keylen] [-J newpassfile] [-K newkeyfile] [-s sectorsize] [-V version] prov ..."
135 { "label", G_FLAG_VERBOSE, eli_main,
137 { 'a', "aalgo", "", G_TYPE_STRING },
138 { 'b', "boot", NULL, G_TYPE_BOOL },
139 { 'B', "backupfile", "", G_TYPE_STRING },
140 { 'd', "displaypass", NULL, G_TYPE_BOOL },
141 { 'e', "ealgo", "", G_TYPE_STRING },
142 { 'g', "geliboot", NULL, G_TYPE_BOOL },
143 { 'i', "iterations", "-1", G_TYPE_NUMBER },
144 { 'J', "newpassfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
145 { 'K', "newkeyfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
146 { 'l', "keylen", "0", G_TYPE_NUMBER },
147 { 'P', "nonewpassphrase", NULL, G_TYPE_BOOL },
148 { 'R', "noautoresize", NULL, G_TYPE_BOOL },
149 { 's', "sectorsize", "0", G_TYPE_NUMBER },
150 { 'T', "notrim", NULL, G_TYPE_BOOL },
151 { 'V', "mdversion", "-1", G_TYPE_NUMBER },
154 "- an alias for 'init'"
156 { "attach", G_FLAG_VERBOSE | G_FLAG_LOADKLD, eli_main,
158 { 'C', "dryrun", NULL, G_TYPE_BOOL },
159 { 'd', "detach", NULL, G_TYPE_BOOL },
160 { 'j', "passfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
161 { 'k', "keyfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
162 { 'n', "keyno", "-1", G_TYPE_NUMBER },
163 { 'p', "nopassphrase", NULL, G_TYPE_BOOL },
164 { 'r', "readonly", NULL, G_TYPE_BOOL },
167 "[-Cdprv] [-n keyno] [-j passfile] [-k keyfile] prov ..."
171 { 'f', "force", NULL, G_TYPE_BOOL },
172 { 'l', "last", NULL, G_TYPE_BOOL },
179 { 'f', "force", NULL, G_TYPE_BOOL },
180 { 'l', "last", NULL, G_TYPE_BOOL },
183 "- an alias for 'detach'"
185 { "onetime", G_FLAG_VERBOSE | G_FLAG_LOADKLD, NULL,
187 { 'a', "aalgo", "", G_TYPE_STRING },
188 { 'd', "detach", NULL, G_TYPE_BOOL },
189 { 'e', "ealgo", GELI_ENC_ALGO, G_TYPE_STRING },
190 { 'l', "keylen", "0", G_TYPE_NUMBER },
191 { 'R', "noautoresize", NULL, G_TYPE_BOOL },
192 { 's', "sectorsize", "0", G_TYPE_NUMBER },
193 { 'T', "notrim", NULL, G_TYPE_BOOL },
196 "[-dRT] [-a aalgo] [-e ealgo] [-l keylen] [-s sectorsize] prov"
198 { "configure", G_FLAG_VERBOSE, eli_main,
200 { 'b', "boot", NULL, G_TYPE_BOOL },
201 { 'B', "noboot", NULL, G_TYPE_BOOL },
202 { 'd', "displaypass", NULL, G_TYPE_BOOL },
203 { 'D', "nodisplaypass", NULL, G_TYPE_BOOL },
204 { 'g', "geliboot", NULL, G_TYPE_BOOL },
205 { 'G', "nogeliboot", NULL, G_TYPE_BOOL },
206 { 'r', "autoresize", NULL, G_TYPE_BOOL },
207 { 'R', "noautoresize", NULL, G_TYPE_BOOL },
208 { 't', "trim", NULL, G_TYPE_BOOL },
209 { 'T', "notrim", NULL, G_TYPE_BOOL },
212 "[-bBdDgGrRtT] prov ..."
214 { "setkey", G_FLAG_VERBOSE, eli_main,
216 { 'i', "iterations", "-1", G_TYPE_NUMBER },
217 { 'j', "passfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
218 { 'J', "newpassfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
219 { 'k', "keyfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
220 { 'K', "newkeyfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
221 { 'n', "keyno", "-1", G_TYPE_NUMBER },
222 { 'p', "nopassphrase", NULL, G_TYPE_BOOL },
223 { 'P', "nonewpassphrase", NULL, G_TYPE_BOOL },
226 "[-pPv] [-n keyno] [-i iterations] [-j passfile] [-J newpassfile] [-k keyfile] [-K newkeyfile] prov"
228 { "delkey", G_FLAG_VERBOSE, eli_main,
230 { 'a', "all", NULL, G_TYPE_BOOL },
231 { 'f', "force", NULL, G_TYPE_BOOL },
232 { 'n', "keyno", "-1", G_TYPE_NUMBER },
235 "[-afv] [-n keyno] prov"
237 { "suspend", G_FLAG_VERBOSE, NULL,
239 { 'a', "all", NULL, G_TYPE_BOOL },
244 { "resume", G_FLAG_VERBOSE, eli_main,
246 { 'j', "passfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
247 { 'k', "keyfile", G_VAL_OPTIONAL, G_TYPE_STRING | G_TYPE_MULTI },
248 { 'p', "nopassphrase", NULL, G_TYPE_BOOL },
251 "[-pv] [-j passfile] [-k keyfile] prov"
253 { "kill", G_FLAG_VERBOSE, eli_main,
255 { 'a', "all", NULL, G_TYPE_BOOL },
260 { "backup", G_FLAG_VERBOSE, eli_main, G_NULL_OPTS,
263 { "restore", G_FLAG_VERBOSE, eli_main,
265 { 'f', "force", NULL, G_TYPE_BOOL },
270 { "resize", G_FLAG_VERBOSE, eli_main,
272 { 's', "oldsize", NULL, G_TYPE_NUMBER },
275 "[-v] -s oldsize prov"
277 { "version", G_FLAG_LOADKLD, eli_main, G_NULL_OPTS,
280 { "clear", G_FLAG_VERBOSE, eli_main, G_NULL_OPTS,
283 { "dump", G_FLAG_VERBOSE, eli_main, G_NULL_OPTS,
289 static int verbose = 0;
292 eli_protect(struct gctl_req *req)
296 /* Disable core dumps. */
299 if (setrlimit(RLIMIT_CORE, &rl) == -1) {
300 gctl_error(req, "Cannot disable core dumps: %s.",
304 /* Disable swapping. */
305 if (mlockall(MCL_FUTURE) == -1) {
306 gctl_error(req, "Cannot lock memory: %s.", strerror(errno));
313 eli_main(struct gctl_req *req, unsigned int flags)
317 if (eli_protect(req) == -1)
320 if ((flags & G_FLAG_VERBOSE) != 0)
323 name = gctl_get_ascii(req, "verb");
325 gctl_error(req, "No '%s' argument.", "verb");
328 if (strcmp(name, "init") == 0 || strcmp(name, "label") == 0)
330 else if (strcmp(name, "attach") == 0)
332 else if (strcmp(name, "configure") == 0)
334 else if (strcmp(name, "setkey") == 0)
336 else if (strcmp(name, "delkey") == 0)
338 else if (strcmp(name, "resume") == 0)
340 else if (strcmp(name, "kill") == 0)
342 else if (strcmp(name, "backup") == 0)
344 else if (strcmp(name, "restore") == 0)
346 else if (strcmp(name, "resize") == 0)
348 else if (strcmp(name, "version") == 0)
350 else if (strcmp(name, "dump") == 0)
352 else if (strcmp(name, "clear") == 0)
355 gctl_error(req, "Unknown command: %s.", name);
359 eli_is_attached(const char *prov)
361 char name[MAXPATHLEN];
364 * Not the best way to do it, but the easiest.
365 * We try to open provider and check if it is a GEOM provider
366 * by asking about its sectorsize.
368 snprintf(name, sizeof(name), "%s%s", prov, G_ELI_SUFFIX);
369 return (g_get_sectorsize(name) > 0);
373 eli_genkey_files(struct gctl_req *req, bool new, const char *type,
374 struct hmac_ctx *ctxp, char *passbuf, size_t passbufsize)
376 char *p, buf[BUFSIZE], argname[16];
381 assert((strcmp(type, "keyfile") == 0 && ctxp != NULL &&
382 passbuf == NULL && passbufsize == 0) ||
383 (strcmp(type, "passfile") == 0 && ctxp == NULL &&
384 passbuf != NULL && passbufsize > 0));
385 assert(strcmp(type, "keyfile") == 0 || passbuf[0] == '\0');
388 snprintf(argname, sizeof(argname), "%s%s%d",
389 new ? "new" : "", type, i);
391 /* No more {key,pass}files? */
392 if (!gctl_has_param(req, argname))
395 file = gctl_get_ascii(req, "%s", argname);
396 assert(file != NULL);
398 if (strcmp(file, "-") == 0)
401 fd = open(file, O_RDONLY);
403 gctl_error(req, "Cannot open %s %s: %s.",
404 type, file, strerror(errno));
408 if (strcmp(type, "keyfile") == 0) {
409 while ((done = read(fd, buf, sizeof(buf))) > 0)
410 g_eli_crypto_hmac_update(ctxp, buf, done);
411 } else /* if (strcmp(type, "passfile") == 0) */ {
412 assert(strcmp(type, "passfile") == 0);
414 while ((done = read(fd, buf, sizeof(buf) - 1)) > 0) {
416 p = strchr(buf, '\n');
421 if (strlcat(passbuf, buf, passbufsize) >=
424 "Passphrase in %s too long.", file);
425 explicit_bzero(buf, sizeof(buf));
433 if (strcmp(file, "-") != 0)
435 explicit_bzero(buf, sizeof(buf));
437 gctl_error(req, "Cannot read %s %s: %s.",
438 type, file, strerror(error));
446 eli_genkey_passphrase_prompt(struct gctl_req *req, bool new, char *passbuf,
453 new ? "Enter new passphrase: " : "Enter passphrase: ",
454 passbuf, passbufsize, RPP_ECHO_OFF | RPP_REQUIRE_TTY);
456 explicit_bzero(passbuf, passbufsize);
457 gctl_error(req, "Cannot read passphrase: %s.",
463 char tmpbuf[BUFSIZE];
465 p = readpassphrase("Reenter new passphrase: ",
466 tmpbuf, sizeof(tmpbuf),
467 RPP_ECHO_OFF | RPP_REQUIRE_TTY);
469 explicit_bzero(passbuf, passbufsize);
471 "Cannot read passphrase: %s.",
476 if (strcmp(passbuf, tmpbuf) != 0) {
477 explicit_bzero(passbuf, passbufsize);
478 fprintf(stderr, "They didn't match.\n");
481 explicit_bzero(tmpbuf, sizeof(tmpbuf));
489 eli_genkey_passphrase(struct gctl_req *req, struct g_eli_metadata *md, bool new,
490 struct hmac_ctx *ctxp)
492 char passbuf[BUFSIZE];
497 * Return error if the 'do not use passphrase' flag was given but a
498 * passfile was provided.
501 gctl_get_int(req, new ? "nonewpassphrase" : "nopassphrase");
503 if (gctl_has_param(req, new ? "newpassfile0" : "passfile0")) {
505 "Options -%c and -%c are mutually exclusive.",
506 new ? 'J' : 'j', new ? 'P' : 'p');
513 * Return error if using a provider which does not require a passphrase
514 * but the 'do not use passphrase' flag was not given.
516 if (!new && md->md_iterations == -1) {
517 gctl_error(req, "Missing -p flag.");
522 /* Use cached passphrase if defined. */
523 if (strlen(cached_passphrase) > 0) {
524 strlcpy(passbuf, cached_passphrase, sizeof(passbuf));
526 nfiles = eli_genkey_files(req, new, "passfile", NULL, passbuf,
530 } else if (nfiles == 0) {
531 if (eli_genkey_passphrase_prompt(req, new, passbuf,
532 sizeof(passbuf)) == -1) {
536 /* Cache the passphrase for other providers. */
537 strlcpy(cached_passphrase, passbuf, sizeof(cached_passphrase));
540 * Field md_iterations equal to -1 means "choose some sane
543 if (md->md_iterations == -1) {
546 printf("Calculating number of iterations...\n");
547 md->md_iterations = pkcs5v2_calculate(2000000);
548 assert(md->md_iterations > 0);
550 printf("Done, using %d iterations.\n",
555 * If md_iterations is equal to 0, user doesn't want PKCS#5v2.
557 if (md->md_iterations == 0) {
558 g_eli_crypto_hmac_update(ctxp, md->md_salt,
559 sizeof(md->md_salt));
560 g_eli_crypto_hmac_update(ctxp, passbuf, strlen(passbuf));
561 } else /* if (md->md_iterations > 0) */ {
562 unsigned char dkey[G_ELI_USERKEYLEN];
564 pkcs5v2_genkey(dkey, sizeof(dkey), md->md_salt,
565 sizeof(md->md_salt), passbuf, md->md_iterations);
566 g_eli_crypto_hmac_update(ctxp, dkey, sizeof(dkey));
567 explicit_bzero(dkey, sizeof(dkey));
569 explicit_bzero(passbuf, sizeof(passbuf));
574 static unsigned char *
575 eli_genkey(struct gctl_req *req, struct g_eli_metadata *md, unsigned char *key,
583 gctl_get_int(req, new ? "nonewpassphrase" : "nopassphrase");
585 g_eli_crypto_hmac_init(&ctx, NULL, 0);
587 nfiles = eli_genkey_files(req, new, "keyfile", &ctx, NULL, 0);
590 else if (nfiles == 0 && nopassphrase) {
591 gctl_error(req, "No key components given.");
595 if (eli_genkey_passphrase(req, md, new, &ctx) == -1)
598 g_eli_crypto_hmac_final(&ctx, key, 0);
604 eli_metadata_read(struct gctl_req *req, const char *prov,
605 struct g_eli_metadata *md)
607 unsigned char sector[sizeof(struct g_eli_metadata)];
610 if (g_get_sectorsize(prov) == 0) {
613 /* This is a file probably. */
614 fd = open(prov, O_RDONLY);
616 gctl_error(req, "Cannot open %s: %s.", prov,
620 if (read(fd, sector, sizeof(sector)) != sizeof(sector)) {
621 gctl_error(req, "Cannot read metadata from %s: %s.",
622 prov, strerror(errno));
628 /* This is a GEOM provider. */
629 error = g_metadata_read(prov, sector, sizeof(sector),
632 gctl_error(req, "Cannot read metadata from %s: %s.",
633 prov, strerror(error));
637 error = eli_metadata_decode(sector, md);
643 "Provider's %s metadata version %u is too new.\n"
644 "geli: The highest supported version is %u.",
645 prov, (unsigned int)md->md_version, G_ELI_VERSION);
648 gctl_error(req, "Inconsistent provider's %s metadata.", prov);
652 "Unexpected error while decoding provider's %s metadata: %s.",
653 prov, strerror(error));
660 eli_metadata_store(struct gctl_req *req, const char *prov,
661 struct g_eli_metadata *md)
663 unsigned char sector[sizeof(struct g_eli_metadata)];
666 eli_metadata_encode(md, sector);
667 if (g_get_sectorsize(prov) == 0) {
670 /* This is a file probably. */
671 fd = open(prov, O_WRONLY | O_TRUNC);
673 gctl_error(req, "Cannot open %s: %s.", prov,
675 explicit_bzero(sector, sizeof(sector));
678 if (write(fd, sector, sizeof(sector)) != sizeof(sector)) {
679 gctl_error(req, "Cannot write metadata to %s: %s.",
680 prov, strerror(errno));
681 explicit_bzero(sector, sizeof(sector));
687 /* This is a GEOM provider. */
688 error = g_metadata_store(prov, sector, sizeof(sector));
690 gctl_error(req, "Cannot write metadata to %s: %s.",
691 prov, strerror(errno));
692 explicit_bzero(sector, sizeof(sector));
696 explicit_bzero(sector, sizeof(sector));
701 eli_init(struct gctl_req *req)
703 struct g_eli_metadata md;
705 unsigned char sector[sizeof(struct g_eli_metadata)] __aligned(4);
706 unsigned char key[G_ELI_USERKEYLEN];
707 char backfile[MAXPATHLEN];
708 const char *str, *prov;
709 unsigned int secsize, eli_version;
712 int error, i, nargs, nparams, param;
715 nargs = gctl_get_int(req, "nargs");
717 gctl_error(req, "Too few arguments.");
721 /* Start generating metadata for provider(s) being initialized. */
722 explicit_bzero(&md, sizeof(md));
723 strlcpy(md.md_magic, G_ELI_MAGIC, sizeof(md.md_magic));
724 val = gctl_get_intmax(req, "mdversion");
726 eli_version = G_ELI_VERSION;
727 } else if (val < 0 || val > G_ELI_VERSION) {
729 "Invalid version specified should be between %u and %u.",
730 G_ELI_VERSION_00, G_ELI_VERSION);
735 md.md_version = eli_version;
736 md.md_flags = G_ELI_FLAG_AUTORESIZE;
737 if (gctl_get_int(req, "boot"))
738 md.md_flags |= G_ELI_FLAG_BOOT;
739 if (gctl_get_int(req, "geliboot"))
740 md.md_flags |= G_ELI_FLAG_GELIBOOT;
741 if (gctl_get_int(req, "displaypass"))
742 md.md_flags |= G_ELI_FLAG_GELIDISPLAYPASS;
743 if (gctl_get_int(req, "notrim"))
744 md.md_flags |= G_ELI_FLAG_NODELETE;
745 if (gctl_get_int(req, "noautoresize"))
746 md.md_flags &= ~G_ELI_FLAG_AUTORESIZE;
747 md.md_ealgo = CRYPTO_ALGORITHM_MIN - 1;
748 str = gctl_get_ascii(req, "aalgo");
750 if (eli_version < G_ELI_VERSION_01) {
752 "Data authentication is supported starting from version %u.",
756 md.md_aalgo = g_eli_str2aalgo(str);
757 if (md.md_aalgo >= CRYPTO_ALGORITHM_MIN &&
758 md.md_aalgo <= CRYPTO_ALGORITHM_MAX) {
759 md.md_flags |= G_ELI_FLAG_AUTH;
762 * For backward compatibility, check if the -a option
763 * was used to provide encryption algorithm.
765 md.md_ealgo = g_eli_str2ealgo(str);
766 if (md.md_ealgo < CRYPTO_ALGORITHM_MIN ||
767 md.md_ealgo > CRYPTO_ALGORITHM_MAX) {
769 "Invalid authentication algorithm.");
772 fprintf(stderr, "warning: The -e option, not "
773 "the -a option is now used to specify "
774 "encryption algorithm to use.\n");
778 if (md.md_ealgo < CRYPTO_ALGORITHM_MIN ||
779 md.md_ealgo > CRYPTO_ALGORITHM_MAX) {
780 str = gctl_get_ascii(req, "ealgo");
782 if (eli_version < G_ELI_VERSION_05)
787 md.md_ealgo = g_eli_str2ealgo(str);
788 if (md.md_ealgo < CRYPTO_ALGORITHM_MIN ||
789 md.md_ealgo > CRYPTO_ALGORITHM_MAX) {
790 gctl_error(req, "Invalid encryption algorithm.");
793 if (md.md_ealgo == CRYPTO_CAMELLIA_CBC &&
794 eli_version < G_ELI_VERSION_04) {
796 "Camellia-CBC algorithm is supported starting from version %u.",
800 if (md.md_ealgo == CRYPTO_AES_XTS &&
801 eli_version < G_ELI_VERSION_05) {
803 "AES-XTS algorithm is supported starting from version %u.",
808 val = gctl_get_intmax(req, "keylen");
810 md.md_keylen = g_eli_keylen(md.md_ealgo, md.md_keylen);
811 if (md.md_keylen == 0) {
812 gctl_error(req, "Invalid key length.");
816 val = gctl_get_intmax(req, "iterations");
821 * Don't allow to set iterations when there will be no
824 nonewpassphrase = gctl_get_int(req, "nonewpassphrase");
825 if (nonewpassphrase) {
827 "Options -i and -P are mutually exclusive.");
831 md.md_iterations = val;
833 val = gctl_get_intmax(req, "sectorsize");
834 if (val > sysconf(_SC_PAGE_SIZE)) {
836 "warning: Using sectorsize bigger than the page size!\n");
842 * Determine number of parameters in the parent geom request before the
843 * nargs parameter and list of providers.
845 nparams = req->narg - nargs - 1;
847 /* Create new child request for each provider and issue to kernel */
848 for (i = 0; i < nargs; i++) {
849 r = gctl_get_handle();
851 /* Copy each parameter from the parent request to the child */
852 for (param = 0; param < nparams; param++) {
853 gctl_ro_param(r, req->arg[param].name,
854 req->arg[param].len, req->arg[param].value);
857 /* Add a single provider to the parameter list of the child */
858 gctl_ro_param(r, "nargs", sizeof(one), &one);
859 prov = gctl_get_ascii(req, "arg%d", i);
860 gctl_ro_param(r, "arg0", -1, prov);
862 mediasize = g_get_mediasize(prov);
863 secsize = g_get_sectorsize(prov);
864 if (mediasize == 0 || secsize == 0) {
865 gctl_error(r, "Cannot get information about %s: %s.",
866 prov, strerror(errno));
870 md.md_provsize = mediasize;
872 val = gctl_get_intmax(r, "sectorsize");
874 md.md_sectorsize = secsize;
876 if (val < 0 || (val % secsize) != 0 || !powerof2(val)) {
877 gctl_error(r, "Invalid sector size.");
880 md.md_sectorsize = val;
883 /* Use different salt and Master Key for each provider. */
884 arc4random_buf(md.md_salt, sizeof(md.md_salt));
885 arc4random_buf(md.md_mkeys, sizeof(md.md_mkeys));
887 /* Generate user key. */
888 if (eli_genkey(r, &md, key, true) == NULL) {
890 * Error generating key - details added to geom request
896 /* Encrypt the first and the only Master Key. */
897 error = g_eli_mkey_encrypt(md.md_ealgo, key, md.md_keylen,
900 gctl_error(r, "Cannot encrypt Master Key: %s.",
905 /* Convert metadata to on-disk format. */
906 eli_metadata_encode(&md, sector);
908 /* Store metadata to disk. */
909 error = g_metadata_store(prov, sector, sizeof(sector));
911 gctl_error(r, "Cannot store metadata on %s: %s.", prov,
916 printf("Metadata value stored on %s.\n", prov);
918 /* Backup metadata to a file. */
919 const char *p = prov;
923 * Check if provider string includes the devfs mountpoint
926 if (strncmp(p, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0) {
927 /* Skip forward to the device filename only. */
928 p += sizeof(_PATH_DEV) - 1;
931 str = gctl_get_ascii(r, "backupfile");
932 if (str[0] != '\0') {
933 /* Backupfile given by the user, just copy it. */
934 strlcpy(backfile, str, sizeof(backfile));
936 /* If multiple providers have been initialized in one
937 * command, and the backup filename has been specified
938 * as anything other than "none", make the backup
939 * filename unique for each provider. */
940 if (nargs > 1 && strcmp(backfile, "none") != 0) {
942 * Replace first occurrence of "PROV" with
945 str = strnstr(backfile, "PROV",
948 char suffix[MAXPATHLEN];
950 strlcpy(suffix, &backfile[j+4],
953 strlcat(backfile, p, sizeof(backfile));
954 strlcat(backfile, suffix,
958 * "PROV" not found in backfile, append
961 strlcat(backfile, "-",
963 strlcat(backfile, p, sizeof(backfile));
967 /* Generate filename automatically. */
968 snprintf(backfile, sizeof(backfile), "%s%s.eli",
970 /* Replace all / with _. */
971 for (j = strlen(GELI_BACKUP_DIR); backfile[j] != '\0';
973 if (backfile[j] == '/')
977 if (strcmp(backfile, "none") != 0 &&
978 eli_backup_create(r, prov, backfile) == 0) {
979 printf("\nMetadata backup for provider %s can be found "
980 "in %s\n", prov, backfile);
981 printf("and can be restored with the following "
983 printf("\n\t# geli restore %s %s\n\n", backfile, prov);
988 * Print error for this request, and set parent request error
991 if (r->error != NULL && r->error[0] != '\0') {
992 warnx("%s", r->error);
993 gctl_error(req, "There was an error with at least one "
1000 * Erase sensitive and provider specific data from memory.
1002 explicit_bzero(key, sizeof(key));
1003 explicit_bzero(sector, sizeof(sector));
1004 explicit_bzero(&md.md_provsize, sizeof(md.md_provsize));
1005 explicit_bzero(&md.md_sectorsize, sizeof(md.md_sectorsize));
1006 explicit_bzero(&md.md_salt, sizeof(md.md_salt));
1007 explicit_bzero(&md.md_mkeys, sizeof(md.md_mkeys));
1010 /* Clear the cached metadata, including keys. */
1011 explicit_bzero(&md, sizeof(md));
1015 eli_attach(struct gctl_req *req)
1017 struct g_eli_metadata md;
1021 int i, nargs, nparams, param;
1024 nargs = gctl_get_int(req, "nargs");
1026 gctl_error(req, "Too few arguments.");
1030 unsigned char key[G_ELI_USERKEYLEN];
1033 * Determine number of parameters in the parent geom request before the
1034 * nargs parameter and list of providers.
1036 nparams = req->narg - nargs - 1;
1038 /* Create new child request for each provider and issue to kernel */
1039 for (i = 0; i < nargs; i++) {
1040 r = gctl_get_handle();
1042 /* Copy each parameter from the parent request to the child */
1043 for (param = 0; param < nparams; param++) {
1044 gctl_ro_param(r, req->arg[param].name,
1045 req->arg[param].len, req->arg[param].value);
1048 /* Add a single provider to the parameter list of the child */
1049 gctl_ro_param(r, "nargs", sizeof(one), &one);
1050 prov = gctl_get_ascii(req, "arg%d", i);
1051 gctl_ro_param(r, "arg0", -1, prov);
1053 if (eli_metadata_read(r, prov, &md) == -1) {
1055 * Error reading metadata - details added to geom
1056 * request by eli_metadata_read().
1061 mediasize = g_get_mediasize(prov);
1062 if (md.md_provsize != (uint64_t)mediasize) {
1063 gctl_error(r, "Provider size mismatch.");
1067 if (eli_genkey(r, &md, key, false) == NULL) {
1069 * Error generating key - details added to geom request
1075 gctl_ro_param(r, "key", sizeof(key), key);
1077 if (gctl_issue(r) == NULL) {
1079 printf("Attached to %s.\n", prov);
1084 * Print error for this request, and set parent request error
1087 if (r->error != NULL && r->error[0] != '\0') {
1088 warnx("%s", r->error);
1089 gctl_error(req, "There was an error with at least one "
1095 /* Clear sensitive data from memory. */
1096 explicit_bzero(key, sizeof(key));
1099 /* Clear sensitive data from memory. */
1100 explicit_bzero(cached_passphrase, sizeof(cached_passphrase));
1104 eli_configure_detached(struct gctl_req *req, const char *prov, int boot,
1105 int geliboot, int displaypass, int trim, int autoresize)
1107 struct g_eli_metadata md;
1110 if (eli_metadata_read(req, prov, &md) == -1)
1113 if (boot == 1 && (md.md_flags & G_ELI_FLAG_BOOT)) {
1115 printf("BOOT flag already configured for %s.\n", prov);
1116 } else if (boot == 0 && !(md.md_flags & G_ELI_FLAG_BOOT)) {
1118 printf("BOOT flag not configured for %s.\n", prov);
1119 } else if (boot >= 0) {
1121 md.md_flags |= G_ELI_FLAG_BOOT;
1123 md.md_flags &= ~G_ELI_FLAG_BOOT;
1127 if (geliboot == 1 && (md.md_flags & G_ELI_FLAG_GELIBOOT)) {
1129 printf("GELIBOOT flag already configured for %s.\n", prov);
1130 } else if (geliboot == 0 && !(md.md_flags & G_ELI_FLAG_GELIBOOT)) {
1132 printf("GELIBOOT flag not configured for %s.\n", prov);
1133 } else if (geliboot >= 0) {
1135 md.md_flags |= G_ELI_FLAG_GELIBOOT;
1137 md.md_flags &= ~G_ELI_FLAG_GELIBOOT;
1141 if (displaypass == 1 && (md.md_flags & G_ELI_FLAG_GELIDISPLAYPASS)) {
1143 printf("GELIDISPLAYPASS flag already configured for %s.\n", prov);
1144 } else if (displaypass == 0 &&
1145 !(md.md_flags & G_ELI_FLAG_GELIDISPLAYPASS)) {
1147 printf("GELIDISPLAYPASS flag not configured for %s.\n", prov);
1148 } else if (displaypass >= 0) {
1150 md.md_flags |= G_ELI_FLAG_GELIDISPLAYPASS;
1152 md.md_flags &= ~G_ELI_FLAG_GELIDISPLAYPASS;
1156 if (trim == 0 && (md.md_flags & G_ELI_FLAG_NODELETE)) {
1158 printf("TRIM disable flag already configured for %s.\n", prov);
1159 } else if (trim == 1 && !(md.md_flags & G_ELI_FLAG_NODELETE)) {
1161 printf("TRIM disable flag not configured for %s.\n", prov);
1162 } else if (trim >= 0) {
1164 md.md_flags &= ~G_ELI_FLAG_NODELETE;
1166 md.md_flags |= G_ELI_FLAG_NODELETE;
1170 if (autoresize == 1 && (md.md_flags & G_ELI_FLAG_AUTORESIZE)) {
1172 printf("AUTORESIZE flag already configured for %s.\n", prov);
1173 } else if (autoresize == 0 && !(md.md_flags & G_ELI_FLAG_AUTORESIZE)) {
1175 printf("AUTORESIZE flag not configured for %s.\n", prov);
1176 } else if (autoresize >= 0) {
1178 md.md_flags |= G_ELI_FLAG_AUTORESIZE;
1180 md.md_flags &= ~G_ELI_FLAG_AUTORESIZE;
1185 eli_metadata_store(req, prov, &md);
1186 explicit_bzero(&md, sizeof(md));
1190 eli_configure(struct gctl_req *req)
1193 bool boot, noboot, geliboot, nogeliboot, displaypass, nodisplaypass;
1194 bool autoresize, noautoresize, trim, notrim;
1195 int doboot, dogeliboot, dodisplaypass, dotrim, doautoresize;
1198 nargs = gctl_get_int(req, "nargs");
1200 gctl_error(req, "Too few arguments.");
1204 boot = gctl_get_int(req, "boot");
1205 noboot = gctl_get_int(req, "noboot");
1206 geliboot = gctl_get_int(req, "geliboot");
1207 nogeliboot = gctl_get_int(req, "nogeliboot");
1208 displaypass = gctl_get_int(req, "displaypass");
1209 nodisplaypass = gctl_get_int(req, "nodisplaypass");
1210 trim = gctl_get_int(req, "trim");
1211 notrim = gctl_get_int(req, "notrim");
1212 autoresize = gctl_get_int(req, "autoresize");
1213 noautoresize = gctl_get_int(req, "noautoresize");
1216 if (boot && noboot) {
1217 gctl_error(req, "Options -b and -B are mutually exclusive.");
1226 if (geliboot && nogeliboot) {
1227 gctl_error(req, "Options -g and -G are mutually exclusive.");
1232 else if (nogeliboot)
1236 if (displaypass && nodisplaypass) {
1237 gctl_error(req, "Options -d and -D are mutually exclusive.");
1242 else if (nodisplaypass)
1246 if (trim && notrim) {
1247 gctl_error(req, "Options -t and -T are mutually exclusive.");
1256 if (autoresize && noautoresize) {
1257 gctl_error(req, "Options -r and -R are mutually exclusive.");
1262 else if (noautoresize)
1265 if (doboot == -1 && dogeliboot == -1 && dodisplaypass == -1 &&
1266 dotrim == -1 && doautoresize == -1) {
1267 gctl_error(req, "No option given.");
1271 /* First attached providers. */
1274 for (i = 0; i < nargs; i++) {
1275 prov = gctl_get_ascii(req, "arg%d", i);
1276 if (!eli_is_attached(prov)) {
1277 eli_configure_detached(req, prov, doboot, dogeliboot,
1278 dodisplaypass, dotrim, doautoresize);
1284 eli_setkey_attached(struct gctl_req *req, struct g_eli_metadata *md)
1286 unsigned char key[G_ELI_USERKEYLEN];
1287 intmax_t val, old = 0;
1290 val = gctl_get_intmax(req, "iterations");
1291 /* Check if iterations number should be changed. */
1293 md->md_iterations = val;
1295 old = md->md_iterations;
1297 /* Generate key for Master Key encryption. */
1298 if (eli_genkey(req, md, key, true) == NULL) {
1299 explicit_bzero(key, sizeof(key));
1303 * If number of iterations has changed, but wasn't given as a
1304 * command-line argument, update the request.
1306 if (val == -1 && md->md_iterations != old) {
1307 error = gctl_change_param(req, "iterations", sizeof(intmax_t),
1308 &md->md_iterations);
1312 gctl_ro_param(req, "key", sizeof(key), key);
1314 explicit_bzero(key, sizeof(key));
1318 eli_setkey_detached(struct gctl_req *req, const char *prov,
1319 struct g_eli_metadata *md)
1321 unsigned char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
1322 unsigned char *mkeydst;
1327 if (md->md_keys == 0) {
1328 gctl_error(req, "No valid keys on %s.", prov);
1332 /* Generate key for Master Key decryption. */
1333 if (eli_genkey(req, md, key, false) == NULL) {
1334 explicit_bzero(key, sizeof(key));
1338 /* Decrypt Master Key. */
1339 error = g_eli_mkey_decrypt_any(md, key, mkey, &nkey);
1340 explicit_bzero(key, sizeof(key));
1342 explicit_bzero(md, sizeof(*md));
1344 gctl_error(req, "Wrong key for %s.", prov);
1345 else /* if (error > 0) */ {
1346 gctl_error(req, "Cannot decrypt Master Key: %s.",
1352 printf("Decrypted Master Key %u.\n", nkey);
1354 val = gctl_get_intmax(req, "keyno");
1359 ; /* Use the key number which was found during decryption. */
1361 if (nkey >= G_ELI_MAXMKEYS) {
1362 gctl_error(req, "Invalid '%s' argument.", "keyno");
1366 val = gctl_get_intmax(req, "iterations");
1367 /* Check if iterations number should and can be changed. */
1368 if (val != -1 && md->md_iterations == -1) {
1369 md->md_iterations = val;
1370 } else if (val != -1 && val != md->md_iterations) {
1371 if (bitcount32(md->md_keys) != 1) {
1372 gctl_error(req, "To be able to use '-i' option, only "
1373 "one key can be defined.");
1376 if (md->md_keys != (1 << nkey)) {
1377 gctl_error(req, "Only already defined key can be "
1378 "changed when '-i' option is used.");
1381 md->md_iterations = val;
1384 mkeydst = md->md_mkeys + nkey * G_ELI_MKEYLEN;
1385 md->md_keys |= (1 << nkey);
1387 bcopy(mkey, mkeydst, sizeof(mkey));
1388 explicit_bzero(mkey, sizeof(mkey));
1390 /* Generate key for Master Key encryption. */
1391 if (eli_genkey(req, md, key, true) == NULL) {
1392 explicit_bzero(key, sizeof(key));
1393 explicit_bzero(md, sizeof(*md));
1397 /* Encrypt the Master-Key with the new key. */
1398 error = g_eli_mkey_encrypt(md->md_ealgo, key, md->md_keylen, mkeydst);
1399 explicit_bzero(key, sizeof(key));
1401 explicit_bzero(md, sizeof(*md));
1402 gctl_error(req, "Cannot encrypt Master Key: %s.",
1407 /* Store metadata with fresh key. */
1408 eli_metadata_store(req, prov, md);
1409 explicit_bzero(md, sizeof(*md));
1413 eli_setkey(struct gctl_req *req)
1415 struct g_eli_metadata md;
1419 nargs = gctl_get_int(req, "nargs");
1421 gctl_error(req, "Invalid number of arguments.");
1424 prov = gctl_get_ascii(req, "arg0");
1426 if (eli_metadata_read(req, prov, &md) == -1)
1429 if (eli_is_attached(prov))
1430 eli_setkey_attached(req, &md);
1432 eli_setkey_detached(req, prov, &md);
1434 if (req->error == NULL || req->error[0] == '\0') {
1435 printf("Note, that the master key encrypted with old keys "
1436 "and/or passphrase may still exists in a metadata backup "
1442 eli_delkey_attached(struct gctl_req *req, const char *prov __unused)
1449 eli_delkey_detached(struct gctl_req *req, const char *prov)
1451 struct g_eli_metadata md;
1452 unsigned char *mkeydst;
1457 if (eli_metadata_read(req, prov, &md) == -1)
1460 all = gctl_get_int(req, "all");
1462 arc4random_buf(md.md_mkeys, sizeof(md.md_mkeys));
1464 force = gctl_get_int(req, "force");
1465 val = gctl_get_intmax(req, "keyno");
1467 gctl_error(req, "Key number has to be specified.");
1471 if (nkey >= G_ELI_MAXMKEYS) {
1472 gctl_error(req, "Invalid '%s' argument.", "keyno");
1475 if (!(md.md_keys & (1 << nkey)) && !force) {
1476 gctl_error(req, "Master Key %u is not set.", nkey);
1479 md.md_keys &= ~(1 << nkey);
1480 if (md.md_keys == 0 && !force) {
1481 gctl_error(req, "This is the last Master Key. Use '-f' "
1482 "option if you really want to remove it.");
1485 mkeydst = md.md_mkeys + nkey * G_ELI_MKEYLEN;
1486 arc4random_buf(mkeydst, G_ELI_MKEYLEN);
1489 eli_metadata_store(req, prov, &md);
1490 explicit_bzero(&md, sizeof(md));
1494 eli_delkey(struct gctl_req *req)
1499 nargs = gctl_get_int(req, "nargs");
1501 gctl_error(req, "Invalid number of arguments.");
1504 prov = gctl_get_ascii(req, "arg0");
1506 if (eli_is_attached(prov))
1507 eli_delkey_attached(req, prov);
1509 eli_delkey_detached(req, prov);
1513 eli_resume(struct gctl_req *req)
1515 struct g_eli_metadata md;
1516 unsigned char key[G_ELI_USERKEYLEN];
1521 nargs = gctl_get_int(req, "nargs");
1523 gctl_error(req, "Invalid number of arguments.");
1526 prov = gctl_get_ascii(req, "arg0");
1528 if (eli_metadata_read(req, prov, &md) == -1)
1531 mediasize = g_get_mediasize(prov);
1532 if (md.md_provsize != (uint64_t)mediasize) {
1533 gctl_error(req, "Provider size mismatch.");
1537 if (eli_genkey(req, &md, key, false) == NULL) {
1538 explicit_bzero(key, sizeof(key));
1542 gctl_ro_param(req, "key", sizeof(key), key);
1543 if (gctl_issue(req) == NULL) {
1545 printf("Resumed %s.\n", prov);
1547 explicit_bzero(key, sizeof(key));
1551 eli_trash_metadata(struct gctl_req *req, const char *prov, int fd, off_t offset)
1553 unsigned int overwrites;
1554 unsigned char *sector;
1558 size = sizeof(overwrites);
1559 if (sysctlbyname("kern.geom.eli.overwrites", &overwrites, &size,
1560 NULL, 0) == -1 || overwrites == 0) {
1561 overwrites = G_ELI_OVERWRITES;
1564 size = g_sectorsize(fd);
1566 gctl_error(req, "Cannot obtain provider sector size %s: %s.",
1567 prov, strerror(errno));
1570 sector = malloc(size);
1571 if (sector == NULL) {
1572 gctl_error(req, "Cannot allocate %zd bytes of memory.", size);
1578 arc4random_buf(sector, size);
1579 if (pwrite(fd, sector, size, offset) != size) {
1584 } while (--overwrites > 0);
1587 gctl_error(req, "Cannot trash metadata on provider %s: %s.",
1588 prov, strerror(error));
1595 eli_kill_detached(struct gctl_req *req, const char *prov)
1601 * NOTE: Maybe we should verify if this is geli provider first,
1602 * but 'kill' command is quite critical so better don't waste
1606 error = g_metadata_read(prov, (unsigned char *)&md, sizeof(md),
1609 gctl_error(req, "Cannot read metadata from %s: %s.", prov,
1615 fd = g_open(prov, 1);
1617 gctl_error(req, "Cannot open provider %s: %s.", prov,
1621 offset = g_mediasize(fd) - g_sectorsize(fd);
1624 "Cannot obtain media size or sector size for provider %s: %s.",
1625 prov, strerror(errno));
1629 (void)eli_trash_metadata(req, prov, fd, offset);
1634 eli_kill(struct gctl_req *req)
1639 nargs = gctl_get_int(req, "nargs");
1640 all = gctl_get_int(req, "all");
1641 if (!all && nargs == 0) {
1642 gctl_error(req, "Too few arguments.");
1646 * How '-a' option combine with a list of providers:
1647 * Delete Master Keys from all attached providers:
1649 * Delete Master Keys from all attached providers and from
1650 * detached da0 and da1:
1651 * geli kill -a da0 da1
1652 * Delete Master Keys from (attached or detached) da0 and da1:
1656 /* First detached providers. */
1657 for (i = 0; i < nargs; i++) {
1658 prov = gctl_get_ascii(req, "arg%d", i);
1659 if (!eli_is_attached(prov))
1660 eli_kill_detached(req, prov);
1662 /* Now attached providers. */
1667 eli_backup_create(struct gctl_req *req, const char *prov, const char *file)
1669 unsigned char *sector;
1671 int error, filefd, ret;
1678 secsize = g_get_sectorsize(prov);
1680 gctl_error(req, "Cannot get informations about %s: %s.", prov,
1684 sector = malloc(secsize);
1685 if (sector == NULL) {
1686 gctl_error(req, "Cannot allocate memory.");
1689 /* Read metadata from the provider. */
1690 error = g_metadata_read(prov, sector, secsize, G_ELI_MAGIC);
1692 gctl_error(req, "Unable to read metadata from %s: %s.", prov,
1697 filefd = open(file, O_WRONLY | O_TRUNC | O_CREAT, 0600);
1699 gctl_error(req, "Unable to open %s: %s.", file,
1703 /* Write metadata to the destination file. */
1704 if (write(filefd, sector, secsize) != secsize) {
1705 gctl_error(req, "Unable to write to %s: %s.", file,
1707 (void)close(filefd);
1711 (void)fsync(filefd);
1712 (void)close(filefd);
1716 if (sector != NULL) {
1717 explicit_bzero(sector, secsize);
1724 eli_backup(struct gctl_req *req)
1726 const char *file, *prov;
1729 nargs = gctl_get_int(req, "nargs");
1731 gctl_error(req, "Invalid number of arguments.");
1734 prov = gctl_get_ascii(req, "arg0");
1735 file = gctl_get_ascii(req, "arg1");
1737 eli_backup_create(req, prov, file);
1741 eli_restore(struct gctl_req *req)
1743 struct g_eli_metadata md;
1744 const char *file, *prov;
1748 nargs = gctl_get_int(req, "nargs");
1750 gctl_error(req, "Invalid number of arguments.");
1753 file = gctl_get_ascii(req, "arg0");
1754 prov = gctl_get_ascii(req, "arg1");
1756 /* Read metadata from the backup file. */
1757 if (eli_metadata_read(req, file, &md) == -1)
1759 /* Obtain provider's mediasize. */
1760 mediasize = g_get_mediasize(prov);
1761 if (mediasize == 0) {
1762 gctl_error(req, "Cannot get informations about %s: %s.", prov,
1766 /* Check if the provider size has changed since we did the backup. */
1767 if (md.md_provsize != (uint64_t)mediasize) {
1768 if (gctl_get_int(req, "force")) {
1769 md.md_provsize = mediasize;
1771 gctl_error(req, "Provider size mismatch: "
1772 "wrong backup file?");
1776 /* Write metadata to the provider. */
1777 (void)eli_metadata_store(req, prov, &md);
1781 eli_resize(struct gctl_req *req)
1783 struct g_eli_metadata md;
1785 unsigned char *sector;
1787 off_t mediasize, oldsize;
1788 int error, nargs, provfd;
1790 nargs = gctl_get_int(req, "nargs");
1792 gctl_error(req, "Invalid number of arguments.");
1795 prov = gctl_get_ascii(req, "arg0");
1801 provfd = g_open(prov, 1);
1803 gctl_error(req, "Cannot open %s: %s.", prov, strerror(errno));
1807 mediasize = g_mediasize(provfd);
1808 secsize = g_sectorsize(provfd);
1809 if (mediasize == -1 || secsize == -1) {
1810 gctl_error(req, "Cannot get information about %s: %s.", prov,
1815 sector = malloc(secsize);
1816 if (sector == NULL) {
1817 gctl_error(req, "Cannot allocate memory.");
1821 oldsize = gctl_get_intmax(req, "oldsize");
1822 if (oldsize < 0 || oldsize > mediasize) {
1823 gctl_error(req, "Invalid oldsize: Out of range.");
1826 if (oldsize == mediasize) {
1827 gctl_error(req, "Size hasn't changed.");
1831 /* Read metadata from the 'oldsize' offset. */
1832 if (pread(provfd, sector, secsize, oldsize - secsize) != secsize) {
1833 gctl_error(req, "Cannot read old metadata: %s.",
1838 /* Check if this sector contains geli metadata. */
1839 error = eli_metadata_decode(sector, &md);
1845 "Provider's %s metadata version %u is too new.\n"
1846 "geli: The highest supported version is %u.",
1847 prov, (unsigned int)md.md_version, G_ELI_VERSION);
1850 gctl_error(req, "Inconsistent provider's %s metadata.", prov);
1854 "Unexpected error while decoding provider's %s metadata: %s.",
1855 prov, strerror(error));
1860 * If the old metadata doesn't have a correct provider size, refuse
1863 if (md.md_provsize != (uint64_t)oldsize) {
1864 gctl_error(req, "Provider size mismatch at oldsize.");
1869 * Update the old metadata with the current provider size and write
1870 * it back to the correct place on the provider.
1872 md.md_provsize = mediasize;
1873 /* Write metadata to the provider. */
1874 (void)eli_metadata_store(req, prov, &md);
1875 /* Now trash the old metadata. */
1876 (void)eli_trash_metadata(req, prov, provfd, oldsize - secsize);
1879 (void)g_close(provfd);
1880 if (sector != NULL) {
1881 explicit_bzero(sector, secsize);
1887 eli_version(struct gctl_req *req)
1889 struct g_eli_metadata md;
1891 unsigned int eli_version;
1892 int error, i, nargs;
1894 nargs = gctl_get_int(req, "nargs");
1897 unsigned int kernver;
1900 size = sizeof(kernver);
1901 if (sysctlbyname("kern.geom.eli.version", &kernver, &size,
1903 warn("Unable to obtain GELI kernel version");
1905 printf("kernel: %u\n", kernver);
1907 printf("userland: %u\n", G_ELI_VERSION);
1911 for (i = 0; i < nargs; i++) {
1912 name = gctl_get_ascii(req, "arg%d", i);
1913 error = g_metadata_read(name, (unsigned char *)&md,
1914 sizeof(md), G_ELI_MAGIC);
1916 warn("%s: Unable to read metadata: %s.", name,
1918 gctl_error(req, "Not fully done.");
1921 eli_version = le32dec(&md.md_version);
1922 printf("%s: %u\n", name, eli_version);
1927 eli_clear(struct gctl_req *req)
1930 int error, i, nargs;
1932 nargs = gctl_get_int(req, "nargs");
1934 gctl_error(req, "Too few arguments.");
1938 for (i = 0; i < nargs; i++) {
1939 name = gctl_get_ascii(req, "arg%d", i);
1940 error = g_metadata_clear(name, G_ELI_MAGIC);
1942 fprintf(stderr, "Cannot clear metadata on %s: %s.\n",
1943 name, strerror(error));
1944 gctl_error(req, "Not fully done.");
1948 printf("Metadata cleared on %s.\n", name);
1953 eli_dump(struct gctl_req *req)
1955 struct g_eli_metadata md;
1959 nargs = gctl_get_int(req, "nargs");
1961 gctl_error(req, "Too few arguments.");
1965 for (i = 0; i < nargs; i++) {
1966 name = gctl_get_ascii(req, "arg%d", i);
1967 if (eli_metadata_read(NULL, name, &md) == -1) {
1968 gctl_error(req, "Not fully done.");
1971 printf("Metadata on %s:\n", name);
1972 eli_metadata_dump(&md);