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));
575 eli_init_key_hmac_ctx(struct gctl_req *req, struct hmac_ctx *ctx, bool new)
581 gctl_get_int(req, new ? "nonewpassphrase" : "nopassphrase");
583 g_eli_crypto_hmac_init(ctx, NULL, 0);
584 nfiles = eli_genkey_files(req, new, "keyfile", ctx, NULL, 0);
587 } else if (nfiles == 0 && nopassphrase) {
588 gctl_error(req, "No key components given.");
595 static unsigned char *
596 eli_genkey(struct gctl_req *req, const struct hmac_ctx *ctxtemplate,
597 struct g_eli_metadata *md, unsigned char *key, bool new)
601 memcpy(&ctx, ctxtemplate, sizeof(ctx));
603 if (eli_genkey_passphrase(req, md, new, &ctx) == -1)
606 g_eli_crypto_hmac_final(&ctx, key, 0);
611 static unsigned char *
612 eli_genkey_single(struct gctl_req *req, struct g_eli_metadata *md,
613 unsigned char *key, bool new)
618 if (!eli_init_key_hmac_ctx(req, &ctx, new)) {
621 rkey = eli_genkey(req, &ctx, md, key, new);
622 explicit_bzero(&ctx, sizeof(ctx));
628 eli_metadata_read(struct gctl_req *req, const char *prov,
629 struct g_eli_metadata *md)
631 unsigned char sector[sizeof(struct g_eli_metadata)];
634 if (g_get_sectorsize(prov) == 0) {
637 /* This is a file probably. */
638 fd = open(prov, O_RDONLY);
640 gctl_error(req, "Cannot open %s: %s.", prov,
644 if (read(fd, sector, sizeof(sector)) != sizeof(sector)) {
645 gctl_error(req, "Cannot read metadata from %s: %s.",
646 prov, strerror(errno));
652 /* This is a GEOM provider. */
653 error = g_metadata_read(prov, sector, sizeof(sector),
656 gctl_error(req, "Cannot read metadata from %s: %s.",
657 prov, strerror(error));
661 error = eli_metadata_decode(sector, md);
667 "Provider's %s metadata version %u is too new.\n"
668 "geli: The highest supported version is %u.",
669 prov, (unsigned int)md->md_version, G_ELI_VERSION);
672 gctl_error(req, "Inconsistent provider's %s metadata.", prov);
676 "Unexpected error while decoding provider's %s metadata: %s.",
677 prov, strerror(error));
684 eli_metadata_store(struct gctl_req *req, const char *prov,
685 struct g_eli_metadata *md)
687 unsigned char sector[sizeof(struct g_eli_metadata)];
690 eli_metadata_encode(md, sector);
691 if (g_get_sectorsize(prov) == 0) {
694 /* This is a file probably. */
695 fd = open(prov, O_WRONLY | O_TRUNC);
697 gctl_error(req, "Cannot open %s: %s.", prov,
699 explicit_bzero(sector, sizeof(sector));
702 if (write(fd, sector, sizeof(sector)) != sizeof(sector)) {
703 gctl_error(req, "Cannot write metadata to %s: %s.",
704 prov, strerror(errno));
705 explicit_bzero(sector, sizeof(sector));
711 /* This is a GEOM provider. */
712 error = g_metadata_store(prov, sector, sizeof(sector));
714 gctl_error(req, "Cannot write metadata to %s: %s.",
715 prov, strerror(errno));
716 explicit_bzero(sector, sizeof(sector));
720 explicit_bzero(sector, sizeof(sector));
725 eli_init(struct gctl_req *req)
727 struct g_eli_metadata md;
729 unsigned char sector[sizeof(struct g_eli_metadata)] __aligned(4);
730 unsigned char key[G_ELI_USERKEYLEN];
731 char backfile[MAXPATHLEN];
732 const char *str, *prov;
733 unsigned int secsize, eli_version;
736 int error, i, nargs, nparams, param;
738 struct hmac_ctx ctxtemplate;
740 nargs = gctl_get_int(req, "nargs");
742 gctl_error(req, "Too few arguments.");
746 /* Start generating metadata for provider(s) being initialized. */
747 explicit_bzero(&md, sizeof(md));
748 strlcpy(md.md_magic, G_ELI_MAGIC, sizeof(md.md_magic));
749 val = gctl_get_intmax(req, "mdversion");
751 eli_version = G_ELI_VERSION;
752 } else if (val < 0 || val > G_ELI_VERSION) {
754 "Invalid version specified should be between %u and %u.",
755 G_ELI_VERSION_00, G_ELI_VERSION);
760 md.md_version = eli_version;
761 md.md_flags = G_ELI_FLAG_AUTORESIZE;
762 if (gctl_get_int(req, "boot"))
763 md.md_flags |= G_ELI_FLAG_BOOT;
764 if (gctl_get_int(req, "geliboot"))
765 md.md_flags |= G_ELI_FLAG_GELIBOOT;
766 if (gctl_get_int(req, "displaypass"))
767 md.md_flags |= G_ELI_FLAG_GELIDISPLAYPASS;
768 if (gctl_get_int(req, "notrim"))
769 md.md_flags |= G_ELI_FLAG_NODELETE;
770 if (gctl_get_int(req, "noautoresize"))
771 md.md_flags &= ~G_ELI_FLAG_AUTORESIZE;
772 md.md_ealgo = CRYPTO_ALGORITHM_MIN - 1;
773 str = gctl_get_ascii(req, "aalgo");
775 if (eli_version < G_ELI_VERSION_01) {
777 "Data authentication is supported starting from version %u.",
781 md.md_aalgo = g_eli_str2aalgo(str);
782 if (md.md_aalgo >= CRYPTO_ALGORITHM_MIN &&
783 md.md_aalgo <= CRYPTO_ALGORITHM_MAX) {
784 md.md_flags |= G_ELI_FLAG_AUTH;
787 * For backward compatibility, check if the -a option
788 * was used to provide encryption algorithm.
790 md.md_ealgo = g_eli_str2ealgo(str);
791 if (md.md_ealgo < CRYPTO_ALGORITHM_MIN ||
792 md.md_ealgo > CRYPTO_ALGORITHM_MAX) {
794 "Invalid authentication algorithm.");
797 fprintf(stderr, "warning: The -e option, not "
798 "the -a option is now used to specify "
799 "encryption algorithm to use.\n");
803 if (md.md_ealgo < CRYPTO_ALGORITHM_MIN ||
804 md.md_ealgo > CRYPTO_ALGORITHM_MAX) {
805 str = gctl_get_ascii(req, "ealgo");
807 if (eli_version < G_ELI_VERSION_05)
812 md.md_ealgo = g_eli_str2ealgo(str);
813 if (md.md_ealgo < CRYPTO_ALGORITHM_MIN ||
814 md.md_ealgo > CRYPTO_ALGORITHM_MAX) {
815 gctl_error(req, "Invalid encryption algorithm.");
818 if (md.md_ealgo == CRYPTO_CAMELLIA_CBC &&
819 eli_version < G_ELI_VERSION_04) {
821 "Camellia-CBC algorithm is supported starting from version %u.",
825 if (md.md_ealgo == CRYPTO_AES_XTS &&
826 eli_version < G_ELI_VERSION_05) {
828 "AES-XTS algorithm is supported starting from version %u.",
833 val = gctl_get_intmax(req, "keylen");
835 md.md_keylen = g_eli_keylen(md.md_ealgo, md.md_keylen);
836 if (md.md_keylen == 0) {
837 gctl_error(req, "Invalid key length.");
841 val = gctl_get_intmax(req, "iterations");
846 * Don't allow to set iterations when there will be no
849 nonewpassphrase = gctl_get_int(req, "nonewpassphrase");
850 if (nonewpassphrase) {
852 "Options -i and -P are mutually exclusive.");
856 md.md_iterations = val;
858 val = gctl_get_intmax(req, "sectorsize");
859 if (val > sysconf(_SC_PAGE_SIZE)) {
861 "warning: Using sectorsize bigger than the page size!\n");
867 * Determine number of parameters in the parent geom request before the
868 * nargs parameter and list of providers.
870 nparams = req->narg - nargs - 1;
872 /* Generate HMAC context template. */
873 if (!eli_init_key_hmac_ctx(req, &ctxtemplate, true))
876 /* Create new child request for each provider and issue to kernel */
877 for (i = 0; i < nargs; i++) {
878 r = gctl_get_handle();
880 /* Copy each parameter from the parent request to the child */
881 for (param = 0; param < nparams; param++) {
882 gctl_ro_param(r, req->arg[param].name,
883 req->arg[param].len, req->arg[param].value);
886 /* Add a single provider to the parameter list of the child */
887 gctl_ro_param(r, "nargs", sizeof(one), &one);
888 prov = gctl_get_ascii(req, "arg%d", i);
889 gctl_ro_param(r, "arg0", -1, prov);
891 mediasize = g_get_mediasize(prov);
892 secsize = g_get_sectorsize(prov);
893 if (mediasize == 0 || secsize == 0) {
894 gctl_error(r, "Cannot get information about %s: %s.",
895 prov, strerror(errno));
899 md.md_provsize = mediasize;
901 val = gctl_get_intmax(r, "sectorsize");
903 md.md_sectorsize = secsize;
905 if (val < 0 || (val % secsize) != 0 || !powerof2(val)) {
906 gctl_error(r, "Invalid sector size.");
909 md.md_sectorsize = val;
912 /* Use different salt and Master Key for each provider. */
913 arc4random_buf(md.md_salt, sizeof(md.md_salt));
914 arc4random_buf(md.md_mkeys, sizeof(md.md_mkeys));
916 /* Generate user key. */
917 if (eli_genkey(r, &ctxtemplate, &md, key, true) == NULL) {
919 * Error generating key - details added to geom request
925 /* Encrypt the first and the only Master Key. */
926 error = g_eli_mkey_encrypt(md.md_ealgo, key, md.md_keylen,
929 gctl_error(r, "Cannot encrypt Master Key: %s.",
934 /* Convert metadata to on-disk format. */
935 eli_metadata_encode(&md, sector);
937 /* Store metadata to disk. */
938 error = g_metadata_store(prov, sector, sizeof(sector));
940 gctl_error(r, "Cannot store metadata on %s: %s.", prov,
945 printf("Metadata value stored on %s.\n", prov);
947 /* Backup metadata to a file. */
948 const char *p = prov;
952 * Check if provider string includes the devfs mountpoint
955 if (strncmp(p, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0) {
956 /* Skip forward to the device filename only. */
957 p += sizeof(_PATH_DEV) - 1;
960 str = gctl_get_ascii(r, "backupfile");
961 if (str[0] != '\0') {
962 /* Backupfile given by the user, just copy it. */
963 strlcpy(backfile, str, sizeof(backfile));
965 /* If multiple providers have been initialized in one
966 * command, and the backup filename has been specified
967 * as anything other than "none", make the backup
968 * filename unique for each provider. */
969 if (nargs > 1 && strcmp(backfile, "none") != 0) {
971 * Replace first occurrence of "PROV" with
974 str = strnstr(backfile, "PROV",
977 char suffix[MAXPATHLEN];
979 strlcpy(suffix, &backfile[j+4],
982 strlcat(backfile, p, sizeof(backfile));
983 strlcat(backfile, suffix,
987 * "PROV" not found in backfile, append
990 strlcat(backfile, "-",
992 strlcat(backfile, p, sizeof(backfile));
996 /* Generate filename automatically. */
997 snprintf(backfile, sizeof(backfile), "%s%s.eli",
999 /* Replace all / with _. */
1000 for (j = strlen(GELI_BACKUP_DIR); backfile[j] != '\0';
1002 if (backfile[j] == '/')
1006 if (strcmp(backfile, "none") != 0 &&
1007 eli_backup_create(r, prov, backfile) == 0) {
1008 printf("\nMetadata backup for provider %s can be found "
1009 "in %s\n", prov, backfile);
1010 printf("and can be restored with the following "
1012 printf("\n\t# geli restore %s %s\n\n", backfile, prov);
1017 * Print error for this request, and set parent request error
1020 if (r->error != NULL && r->error[0] != '\0') {
1021 warnx("%s", r->error);
1022 gctl_error(req, "There was an error with at least one "
1029 * Erase sensitive and provider specific data from memory.
1031 explicit_bzero(key, sizeof(key));
1032 explicit_bzero(sector, sizeof(sector));
1033 explicit_bzero(&md.md_provsize, sizeof(md.md_provsize));
1034 explicit_bzero(&md.md_sectorsize, sizeof(md.md_sectorsize));
1035 explicit_bzero(&md.md_salt, sizeof(md.md_salt));
1036 explicit_bzero(&md.md_mkeys, sizeof(md.md_mkeys));
1039 /* Clear the cached metadata, including keys. */
1040 explicit_bzero(&md, sizeof(md));
1041 explicit_bzero(&ctxtemplate, sizeof(ctxtemplate));
1045 eli_attach(struct gctl_req *req)
1047 struct g_eli_metadata md;
1051 int i, nargs, nparams, param;
1053 struct hmac_ctx ctxtemplate;
1055 nargs = gctl_get_int(req, "nargs");
1057 gctl_error(req, "Too few arguments.");
1061 unsigned char key[G_ELI_USERKEYLEN];
1064 * Determine number of parameters in the parent geom request before the
1065 * nargs parameter and list of providers.
1067 nparams = req->narg - nargs - 1;
1069 /* Generate HMAC context template. */
1070 if (!eli_init_key_hmac_ctx(req, &ctxtemplate, false))
1073 /* Create new child request for each provider and issue to kernel */
1074 for (i = 0; i < nargs; i++) {
1075 r = gctl_get_handle();
1077 /* Copy each parameter from the parent request to the child */
1078 for (param = 0; param < nparams; param++) {
1079 gctl_ro_param(r, req->arg[param].name,
1080 req->arg[param].len, req->arg[param].value);
1083 /* Add a single provider to the parameter list of the child */
1084 gctl_ro_param(r, "nargs", sizeof(one), &one);
1085 prov = gctl_get_ascii(req, "arg%d", i);
1086 gctl_ro_param(r, "arg0", -1, prov);
1088 if (eli_metadata_read(r, prov, &md) == -1) {
1090 * Error reading metadata - details added to geom
1091 * request by eli_metadata_read().
1096 mediasize = g_get_mediasize(prov);
1097 if (md.md_provsize != (uint64_t)mediasize) {
1098 gctl_error(r, "Provider size mismatch.");
1102 if (eli_genkey(r, &ctxtemplate, &md, key, false) == NULL) {
1104 * Error generating key - details added to geom request
1110 gctl_ro_param(r, "key", sizeof(key), key);
1112 if (gctl_issue(r) == NULL) {
1114 printf("Attached to %s.\n", prov);
1119 * Print error for this request, and set parent request error
1122 if (r->error != NULL && r->error[0] != '\0') {
1123 warnx("%s", r->error);
1124 gctl_error(req, "There was an error with at least one "
1130 /* Clear sensitive data from memory. */
1131 explicit_bzero(key, sizeof(key));
1134 /* Clear sensitive data from memory. */
1135 explicit_bzero(cached_passphrase, sizeof(cached_passphrase));
1136 explicit_bzero(&ctxtemplate, sizeof(ctxtemplate));
1140 eli_configure_detached(struct gctl_req *req, const char *prov, int boot,
1141 int geliboot, int displaypass, int trim, int autoresize)
1143 struct g_eli_metadata md;
1146 if (eli_metadata_read(req, prov, &md) == -1)
1149 if (boot == 1 && (md.md_flags & G_ELI_FLAG_BOOT)) {
1151 printf("BOOT flag already configured for %s.\n", prov);
1152 } else if (boot == 0 && !(md.md_flags & G_ELI_FLAG_BOOT)) {
1154 printf("BOOT flag not configured for %s.\n", prov);
1155 } else if (boot >= 0) {
1157 md.md_flags |= G_ELI_FLAG_BOOT;
1159 md.md_flags &= ~G_ELI_FLAG_BOOT;
1163 if (geliboot == 1 && (md.md_flags & G_ELI_FLAG_GELIBOOT)) {
1165 printf("GELIBOOT flag already configured for %s.\n", prov);
1166 } else if (geliboot == 0 && !(md.md_flags & G_ELI_FLAG_GELIBOOT)) {
1168 printf("GELIBOOT flag not configured for %s.\n", prov);
1169 } else if (geliboot >= 0) {
1171 md.md_flags |= G_ELI_FLAG_GELIBOOT;
1173 md.md_flags &= ~G_ELI_FLAG_GELIBOOT;
1177 if (displaypass == 1 && (md.md_flags & G_ELI_FLAG_GELIDISPLAYPASS)) {
1179 printf("GELIDISPLAYPASS flag already configured for %s.\n", prov);
1180 } else if (displaypass == 0 &&
1181 !(md.md_flags & G_ELI_FLAG_GELIDISPLAYPASS)) {
1183 printf("GELIDISPLAYPASS flag not configured for %s.\n", prov);
1184 } else if (displaypass >= 0) {
1186 md.md_flags |= G_ELI_FLAG_GELIDISPLAYPASS;
1188 md.md_flags &= ~G_ELI_FLAG_GELIDISPLAYPASS;
1192 if (trim == 0 && (md.md_flags & G_ELI_FLAG_NODELETE)) {
1194 printf("TRIM disable flag already configured for %s.\n", prov);
1195 } else if (trim == 1 && !(md.md_flags & G_ELI_FLAG_NODELETE)) {
1197 printf("TRIM disable flag not configured for %s.\n", prov);
1198 } else if (trim >= 0) {
1200 md.md_flags &= ~G_ELI_FLAG_NODELETE;
1202 md.md_flags |= G_ELI_FLAG_NODELETE;
1206 if (autoresize == 1 && (md.md_flags & G_ELI_FLAG_AUTORESIZE)) {
1208 printf("AUTORESIZE flag already configured for %s.\n", prov);
1209 } else if (autoresize == 0 && !(md.md_flags & G_ELI_FLAG_AUTORESIZE)) {
1211 printf("AUTORESIZE flag not configured for %s.\n", prov);
1212 } else if (autoresize >= 0) {
1214 md.md_flags |= G_ELI_FLAG_AUTORESIZE;
1216 md.md_flags &= ~G_ELI_FLAG_AUTORESIZE;
1221 eli_metadata_store(req, prov, &md);
1222 explicit_bzero(&md, sizeof(md));
1226 eli_configure(struct gctl_req *req)
1229 bool boot, noboot, geliboot, nogeliboot, displaypass, nodisplaypass;
1230 bool autoresize, noautoresize, trim, notrim;
1231 int doboot, dogeliboot, dodisplaypass, dotrim, doautoresize;
1234 nargs = gctl_get_int(req, "nargs");
1236 gctl_error(req, "Too few arguments.");
1240 boot = gctl_get_int(req, "boot");
1241 noboot = gctl_get_int(req, "noboot");
1242 geliboot = gctl_get_int(req, "geliboot");
1243 nogeliboot = gctl_get_int(req, "nogeliboot");
1244 displaypass = gctl_get_int(req, "displaypass");
1245 nodisplaypass = gctl_get_int(req, "nodisplaypass");
1246 trim = gctl_get_int(req, "trim");
1247 notrim = gctl_get_int(req, "notrim");
1248 autoresize = gctl_get_int(req, "autoresize");
1249 noautoresize = gctl_get_int(req, "noautoresize");
1252 if (boot && noboot) {
1253 gctl_error(req, "Options -b and -B are mutually exclusive.");
1262 if (geliboot && nogeliboot) {
1263 gctl_error(req, "Options -g and -G are mutually exclusive.");
1268 else if (nogeliboot)
1272 if (displaypass && nodisplaypass) {
1273 gctl_error(req, "Options -d and -D are mutually exclusive.");
1278 else if (nodisplaypass)
1282 if (trim && notrim) {
1283 gctl_error(req, "Options -t and -T are mutually exclusive.");
1292 if (autoresize && noautoresize) {
1293 gctl_error(req, "Options -r and -R are mutually exclusive.");
1298 else if (noautoresize)
1301 if (doboot == -1 && dogeliboot == -1 && dodisplaypass == -1 &&
1302 dotrim == -1 && doautoresize == -1) {
1303 gctl_error(req, "No option given.");
1307 /* First attached providers. */
1310 for (i = 0; i < nargs; i++) {
1311 prov = gctl_get_ascii(req, "arg%d", i);
1312 if (!eli_is_attached(prov)) {
1313 eli_configure_detached(req, prov, doboot, dogeliboot,
1314 dodisplaypass, dotrim, doautoresize);
1320 eli_setkey_attached(struct gctl_req *req, struct g_eli_metadata *md)
1322 unsigned char key[G_ELI_USERKEYLEN];
1323 intmax_t val, old = 0;
1326 val = gctl_get_intmax(req, "iterations");
1327 /* Check if iterations number should be changed. */
1329 md->md_iterations = val;
1331 old = md->md_iterations;
1333 /* Generate key for Master Key encryption. */
1334 if (eli_genkey_single(req, md, key, true) == NULL) {
1335 explicit_bzero(key, sizeof(key));
1339 * If number of iterations has changed, but wasn't given as a
1340 * command-line argument, update the request.
1342 if (val == -1 && md->md_iterations != old) {
1343 error = gctl_change_param(req, "iterations", sizeof(intmax_t),
1344 &md->md_iterations);
1348 gctl_ro_param(req, "key", sizeof(key), key);
1350 explicit_bzero(key, sizeof(key));
1354 eli_setkey_detached(struct gctl_req *req, const char *prov,
1355 struct g_eli_metadata *md)
1357 unsigned char key[G_ELI_USERKEYLEN], mkey[G_ELI_DATAIVKEYLEN];
1358 unsigned char *mkeydst;
1363 if (md->md_keys == 0) {
1364 gctl_error(req, "No valid keys on %s.", prov);
1368 /* Generate key for Master Key decryption. */
1369 if (eli_genkey_single(req, md, key, false) == NULL) {
1370 explicit_bzero(key, sizeof(key));
1374 /* Decrypt Master Key. */
1375 error = g_eli_mkey_decrypt_any(md, key, mkey, &nkey);
1376 explicit_bzero(key, sizeof(key));
1378 explicit_bzero(md, sizeof(*md));
1380 gctl_error(req, "Wrong key for %s.", prov);
1381 else /* if (error > 0) */ {
1382 gctl_error(req, "Cannot decrypt Master Key: %s.",
1388 printf("Decrypted Master Key %u.\n", nkey);
1390 val = gctl_get_intmax(req, "keyno");
1395 ; /* Use the key number which was found during decryption. */
1397 if (nkey >= G_ELI_MAXMKEYS) {
1398 gctl_error(req, "Invalid '%s' argument.", "keyno");
1402 val = gctl_get_intmax(req, "iterations");
1403 /* Check if iterations number should and can be changed. */
1404 if (val != -1 && md->md_iterations == -1) {
1405 md->md_iterations = val;
1406 } else if (val != -1 && val != md->md_iterations) {
1407 if (bitcount32(md->md_keys) != 1) {
1408 gctl_error(req, "To be able to use '-i' option, only "
1409 "one key can be defined.");
1412 if (md->md_keys != (1 << nkey)) {
1413 gctl_error(req, "Only already defined key can be "
1414 "changed when '-i' option is used.");
1417 md->md_iterations = val;
1420 mkeydst = md->md_mkeys + nkey * G_ELI_MKEYLEN;
1421 md->md_keys |= (1 << nkey);
1423 bcopy(mkey, mkeydst, sizeof(mkey));
1424 explicit_bzero(mkey, sizeof(mkey));
1426 /* Generate key for Master Key encryption. */
1427 if (eli_genkey_single(req, md, key, true) == NULL) {
1428 explicit_bzero(key, sizeof(key));
1429 explicit_bzero(md, sizeof(*md));
1433 /* Encrypt the Master-Key with the new key. */
1434 error = g_eli_mkey_encrypt(md->md_ealgo, key, md->md_keylen, mkeydst);
1435 explicit_bzero(key, sizeof(key));
1437 explicit_bzero(md, sizeof(*md));
1438 gctl_error(req, "Cannot encrypt Master Key: %s.",
1443 /* Store metadata with fresh key. */
1444 eli_metadata_store(req, prov, md);
1445 explicit_bzero(md, sizeof(*md));
1449 eli_setkey(struct gctl_req *req)
1451 struct g_eli_metadata md;
1455 nargs = gctl_get_int(req, "nargs");
1457 gctl_error(req, "Invalid number of arguments.");
1460 prov = gctl_get_ascii(req, "arg0");
1462 if (eli_metadata_read(req, prov, &md) == -1)
1465 if (eli_is_attached(prov))
1466 eli_setkey_attached(req, &md);
1468 eli_setkey_detached(req, prov, &md);
1470 if (req->error == NULL || req->error[0] == '\0') {
1471 printf("Note, that the master key encrypted with old keys "
1472 "and/or passphrase may still exists in a metadata backup "
1478 eli_delkey_attached(struct gctl_req *req, const char *prov __unused)
1485 eli_delkey_detached(struct gctl_req *req, const char *prov)
1487 struct g_eli_metadata md;
1488 unsigned char *mkeydst;
1493 if (eli_metadata_read(req, prov, &md) == -1)
1496 all = gctl_get_int(req, "all");
1498 arc4random_buf(md.md_mkeys, sizeof(md.md_mkeys));
1500 force = gctl_get_int(req, "force");
1501 val = gctl_get_intmax(req, "keyno");
1503 gctl_error(req, "Key number has to be specified.");
1507 if (nkey >= G_ELI_MAXMKEYS) {
1508 gctl_error(req, "Invalid '%s' argument.", "keyno");
1511 if (!(md.md_keys & (1 << nkey)) && !force) {
1512 gctl_error(req, "Master Key %u is not set.", nkey);
1515 md.md_keys &= ~(1 << nkey);
1516 if (md.md_keys == 0 && !force) {
1517 gctl_error(req, "This is the last Master Key. Use '-f' "
1518 "option if you really want to remove it.");
1521 mkeydst = md.md_mkeys + nkey * G_ELI_MKEYLEN;
1522 arc4random_buf(mkeydst, G_ELI_MKEYLEN);
1525 eli_metadata_store(req, prov, &md);
1526 explicit_bzero(&md, sizeof(md));
1530 eli_delkey(struct gctl_req *req)
1535 nargs = gctl_get_int(req, "nargs");
1537 gctl_error(req, "Invalid number of arguments.");
1540 prov = gctl_get_ascii(req, "arg0");
1542 if (eli_is_attached(prov))
1543 eli_delkey_attached(req, prov);
1545 eli_delkey_detached(req, prov);
1549 eli_resume(struct gctl_req *req)
1551 struct g_eli_metadata md;
1552 unsigned char key[G_ELI_USERKEYLEN];
1557 nargs = gctl_get_int(req, "nargs");
1559 gctl_error(req, "Invalid number of arguments.");
1562 prov = gctl_get_ascii(req, "arg0");
1564 if (eli_metadata_read(req, prov, &md) == -1)
1567 mediasize = g_get_mediasize(prov);
1568 if (md.md_provsize != (uint64_t)mediasize) {
1569 gctl_error(req, "Provider size mismatch.");
1573 if (eli_genkey_single(req, &md, key, false) == NULL) {
1574 explicit_bzero(key, sizeof(key));
1578 gctl_ro_param(req, "key", sizeof(key), key);
1579 if (gctl_issue(req) == NULL) {
1581 printf("Resumed %s.\n", prov);
1583 explicit_bzero(key, sizeof(key));
1587 eli_trash_metadata(struct gctl_req *req, const char *prov, int fd, off_t offset)
1589 unsigned int overwrites;
1590 unsigned char *sector;
1594 size = sizeof(overwrites);
1595 if (sysctlbyname("kern.geom.eli.overwrites", &overwrites, &size,
1596 NULL, 0) == -1 || overwrites == 0) {
1597 overwrites = G_ELI_OVERWRITES;
1600 size = g_sectorsize(fd);
1602 gctl_error(req, "Cannot obtain provider sector size %s: %s.",
1603 prov, strerror(errno));
1606 sector = malloc(size);
1607 if (sector == NULL) {
1608 gctl_error(req, "Cannot allocate %zd bytes of memory.", size);
1614 arc4random_buf(sector, size);
1615 if (pwrite(fd, sector, size, offset) != size) {
1620 } while (--overwrites > 0);
1623 gctl_error(req, "Cannot trash metadata on provider %s: %s.",
1624 prov, strerror(error));
1631 eli_kill_detached(struct gctl_req *req, const char *prov)
1637 * NOTE: Maybe we should verify if this is geli provider first,
1638 * but 'kill' command is quite critical so better don't waste
1642 error = g_metadata_read(prov, (unsigned char *)&md, sizeof(md),
1645 gctl_error(req, "Cannot read metadata from %s: %s.", prov,
1651 fd = g_open(prov, 1);
1653 gctl_error(req, "Cannot open provider %s: %s.", prov,
1657 offset = g_mediasize(fd) - g_sectorsize(fd);
1660 "Cannot obtain media size or sector size for provider %s: %s.",
1661 prov, strerror(errno));
1665 (void)eli_trash_metadata(req, prov, fd, offset);
1670 eli_kill(struct gctl_req *req)
1675 nargs = gctl_get_int(req, "nargs");
1676 all = gctl_get_int(req, "all");
1677 if (!all && nargs == 0) {
1678 gctl_error(req, "Too few arguments.");
1682 * How '-a' option combine with a list of providers:
1683 * Delete Master Keys from all attached providers:
1685 * Delete Master Keys from all attached providers and from
1686 * detached da0 and da1:
1687 * geli kill -a da0 da1
1688 * Delete Master Keys from (attached or detached) da0 and da1:
1692 /* First detached providers. */
1693 for (i = 0; i < nargs; i++) {
1694 prov = gctl_get_ascii(req, "arg%d", i);
1695 if (!eli_is_attached(prov))
1696 eli_kill_detached(req, prov);
1698 /* Now attached providers. */
1703 eli_backup_create(struct gctl_req *req, const char *prov, const char *file)
1705 unsigned char *sector;
1707 int error, filefd, ret;
1714 secsize = g_get_sectorsize(prov);
1716 gctl_error(req, "Cannot get informations about %s: %s.", prov,
1720 sector = malloc(secsize);
1721 if (sector == NULL) {
1722 gctl_error(req, "Cannot allocate memory.");
1725 /* Read metadata from the provider. */
1726 error = g_metadata_read(prov, sector, secsize, G_ELI_MAGIC);
1728 gctl_error(req, "Unable to read metadata from %s: %s.", prov,
1733 filefd = open(file, O_WRONLY | O_TRUNC | O_CREAT, 0600);
1735 gctl_error(req, "Unable to open %s: %s.", file,
1739 /* Write metadata to the destination file. */
1740 if (write(filefd, sector, secsize) != secsize) {
1741 gctl_error(req, "Unable to write to %s: %s.", file,
1743 (void)close(filefd);
1747 (void)fsync(filefd);
1748 (void)close(filefd);
1752 if (sector != NULL) {
1753 explicit_bzero(sector, secsize);
1760 eli_backup(struct gctl_req *req)
1762 const char *file, *prov;
1765 nargs = gctl_get_int(req, "nargs");
1767 gctl_error(req, "Invalid number of arguments.");
1770 prov = gctl_get_ascii(req, "arg0");
1771 file = gctl_get_ascii(req, "arg1");
1773 eli_backup_create(req, prov, file);
1777 eli_restore(struct gctl_req *req)
1779 struct g_eli_metadata md;
1780 const char *file, *prov;
1784 nargs = gctl_get_int(req, "nargs");
1786 gctl_error(req, "Invalid number of arguments.");
1789 file = gctl_get_ascii(req, "arg0");
1790 prov = gctl_get_ascii(req, "arg1");
1792 /* Read metadata from the backup file. */
1793 if (eli_metadata_read(req, file, &md) == -1)
1795 /* Obtain provider's mediasize. */
1796 mediasize = g_get_mediasize(prov);
1797 if (mediasize == 0) {
1798 gctl_error(req, "Cannot get informations about %s: %s.", prov,
1802 /* Check if the provider size has changed since we did the backup. */
1803 if (md.md_provsize != (uint64_t)mediasize) {
1804 if (gctl_get_int(req, "force")) {
1805 md.md_provsize = mediasize;
1807 gctl_error(req, "Provider size mismatch: "
1808 "wrong backup file?");
1812 /* Write metadata to the provider. */
1813 (void)eli_metadata_store(req, prov, &md);
1817 eli_resize(struct gctl_req *req)
1819 struct g_eli_metadata md;
1821 unsigned char *sector;
1823 off_t mediasize, oldsize;
1824 int error, nargs, provfd;
1826 nargs = gctl_get_int(req, "nargs");
1828 gctl_error(req, "Invalid number of arguments.");
1831 prov = gctl_get_ascii(req, "arg0");
1837 provfd = g_open(prov, 1);
1839 gctl_error(req, "Cannot open %s: %s.", prov, strerror(errno));
1843 mediasize = g_mediasize(provfd);
1844 secsize = g_sectorsize(provfd);
1845 if (mediasize == -1 || secsize == -1) {
1846 gctl_error(req, "Cannot get information about %s: %s.", prov,
1851 sector = malloc(secsize);
1852 if (sector == NULL) {
1853 gctl_error(req, "Cannot allocate memory.");
1857 oldsize = gctl_get_intmax(req, "oldsize");
1858 if (oldsize < 0 || oldsize > mediasize) {
1859 gctl_error(req, "Invalid oldsize: Out of range.");
1863 /* Read metadata from the 'oldsize' offset. */
1864 if (pread(provfd, sector, secsize, oldsize - secsize) != secsize) {
1865 gctl_error(req, "Cannot read old metadata: %s.",
1870 /* Check if this sector contains geli metadata. */
1871 error = eli_metadata_decode(sector, &md);
1877 "Provider's %s metadata version %u is too new.\n"
1878 "geli: The highest supported version is %u.",
1879 prov, (unsigned int)md.md_version, G_ELI_VERSION);
1882 gctl_error(req, "Inconsistent provider's %s metadata.", prov);
1886 "Unexpected error while decoding provider's %s metadata: %s.",
1887 prov, strerror(error));
1892 * If the old metadata doesn't have a correct provider size, refuse
1895 if (md.md_provsize != (uint64_t)oldsize) {
1896 gctl_error(req, "Provider size mismatch at oldsize.");
1900 /* The metadata is valid and nothing has changed. Just exit. */
1901 if (oldsize == mediasize)
1905 * Update the old metadata with the current provider size and write
1906 * it back to the correct place on the provider.
1908 md.md_provsize = mediasize;
1909 /* Write metadata to the provider. */
1910 (void)eli_metadata_store(req, prov, &md);
1911 /* Now trash the old metadata. */
1912 (void)eli_trash_metadata(req, prov, provfd, oldsize - secsize);
1915 (void)g_close(provfd);
1916 if (sector != NULL) {
1917 explicit_bzero(sector, secsize);
1923 eli_version(struct gctl_req *req)
1925 struct g_eli_metadata md;
1927 unsigned int eli_version;
1928 int error, i, nargs;
1930 nargs = gctl_get_int(req, "nargs");
1933 unsigned int kernver;
1936 size = sizeof(kernver);
1937 if (sysctlbyname("kern.geom.eli.version", &kernver, &size,
1939 warn("Unable to obtain GELI kernel version");
1941 printf("kernel: %u\n", kernver);
1943 printf("userland: %u\n", G_ELI_VERSION);
1947 for (i = 0; i < nargs; i++) {
1948 name = gctl_get_ascii(req, "arg%d", i);
1949 error = g_metadata_read(name, (unsigned char *)&md,
1950 sizeof(md), G_ELI_MAGIC);
1952 warn("%s: Unable to read metadata: %s.", name,
1954 gctl_error(req, "Not fully done.");
1957 eli_version = le32dec(&md.md_version);
1958 printf("%s: %u\n", name, eli_version);
1963 eli_clear(struct gctl_req *req)
1966 int error, i, nargs;
1968 nargs = gctl_get_int(req, "nargs");
1970 gctl_error(req, "Too few arguments.");
1974 for (i = 0; i < nargs; i++) {
1975 name = gctl_get_ascii(req, "arg%d", i);
1976 error = g_metadata_clear(name, G_ELI_MAGIC);
1978 fprintf(stderr, "Cannot clear metadata on %s: %s.\n",
1979 name, strerror(error));
1980 gctl_error(req, "Not fully done.");
1984 printf("Metadata cleared on %s.\n", name);
1989 eli_dump(struct gctl_req *req)
1991 struct g_eli_metadata md;
1995 nargs = gctl_get_int(req, "nargs");
1997 gctl_error(req, "Too few arguments.");
2001 for (i = 0; i < nargs; i++) {
2002 name = gctl_get_ascii(req, "arg%d", i);
2003 if (eli_metadata_read(NULL, name, &md) == -1) {
2004 gctl_error(req, "Not fully done.");
2007 printf("Metadata on %s:\n", name);
2008 eli_metadata_dump(&md);