Fix build for non-standard gcrypt library location.
[platform/upstream/cryptsetup.git] / src / cryptsetup.c
index 12c7e5f..5cc2723 100644 (file)
@@ -2,6 +2,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdint.h>
+#include <stdarg.h>
 #include <inttypes.h>
 #include <errno.h>
 #include <unistd.h>
@@ -22,6 +23,7 @@ static char *opt_hash = NULL;
 static int opt_verify_passphrase = 0;
 static char *opt_key_file = NULL;
 static char *opt_master_key_file = NULL;
+static char *opt_header_backup_file = NULL;
 static unsigned int opt_key_size = 0;
 static int opt_key_slot = CRYPT_ANY_SLOT;
 static uint64_t opt_size = 0;
@@ -52,36 +54,66 @@ static int action_luksRemoveKey(int arg);
 static int action_isLuks(int arg);
 static int action_luksUUID(int arg);
 static int action_luksDump(int arg);
+static int action_luksSuspend(int arg);
+static int action_luksResume(int arg);
+static int action_luksBackup(int arg);
+static int action_luksRestore(int arg);
 
 static struct action_type {
        const char *type;
        int (*handler)(int);
        int arg;
        int required_action_argc;
-       int required_dm_backend;
        int required_memlock;
-       int show_status;
        const char *arg_desc;
        const char *desc;
 } action_types[] = {
-       { "create",     action_create,          0, 2, 1, 1, 1, N_("<name> <device>"),N_("create device") },
-       { "remove",     action_remove,          0, 1, 1, 0, 1, N_("<name>"), N_("remove device") },
-       { "resize",     action_resize,          0, 1, 1, 1, 1, N_("<name>"), N_("resize active device") },
-       { "status",     action_status,          0, 1, 1, 0, 1, N_("<name>"), N_("show device status") },
-       { "luksFormat", action_luksFormat,      0, 1, 1, 1, 1, N_("<device> [<new key file>]"), N_("formats a LUKS device") },
-       { "luksOpen",   action_luksOpen,        0, 2, 1, 1, 1, N_("<device> <name> "), N_("open LUKS device as mapping <name>") },
-       { "luksAddKey", action_luksAddKey,      0, 1, 1, 1, 1, N_("<device> [<new key file>]"), N_("add key to LUKS device") },
-       { "luksRemoveKey",action_luksRemoveKey, 0, 1, 1, 1, 1, N_("<device> [<key file>]"), N_("removes supplied key or key file from LUKS device") },
-       { "luksKillSlot",  action_luksKillSlot, 0, 2, 1, 1, 1, N_("<device> <key slot>"), N_("wipes key with number <key slot> from LUKS device") },
-       { "luksUUID",   action_luksUUID,        0, 1, 0, 0, 1, N_("<device>"), N_("print UUID of LUKS device") },
-       { "isLuks",     action_isLuks,          0, 1, 0, 0, 0, N_("<device>"), N_("tests <device> for LUKS partition header") },
-       { "luksClose",  action_remove,          0, 1, 1, 0, 1, N_("<name>"), N_("remove LUKS mapping") },
-       { "luksDump",   action_luksDump,        0, 1, 0, 0, 1, N_("<device>"), N_("dump LUKS partition information") },
-       { "luksDelKey", action_luksDelKey,      0, 2, 1, 1, 1, N_("<device> <key slot>"), N_("identical to luksKillSlot - DEPRECATED - see man page") },
-       { "reload",     action_create,          1, 2, 1, 1, 1, N_("<name> <device>"), N_("modify active device - DEPRECATED - see man page") },
-       { NULL, NULL, 0, 0, 0, 0, 0, NULL, NULL }
+       { "create",     action_create,          0, 2, 1, N_("<name> <device>"),N_("create device") },
+       { "remove",     action_remove,          0, 1, 1, N_("<name>"), N_("remove device") },
+       { "resize",     action_resize,          0, 1, 1, N_("<name>"), N_("resize active device") },
+       { "status",     action_status,          0, 1, 0, N_("<name>"), N_("show device status") },
+       { "luksFormat", action_luksFormat,      0, 1, 1, N_("<device> [<new key file>]"), N_("formats a LUKS device") },
+       { "luksOpen",   action_luksOpen,        0, 2, 1, N_("<device> <name> "), N_("open LUKS device as mapping <name>") },
+       { "luksAddKey", action_luksAddKey,      0, 1, 1, N_("<device> [<new key file>]"), N_("add key to LUKS device") },
+       { "luksRemoveKey",action_luksRemoveKey, 0, 1, 1, N_("<device> [<key file>]"), N_("removes supplied key or key file from LUKS device") },
+       { "luksKillSlot",  action_luksKillSlot, 0, 2, 1, N_("<device> <key slot>"), N_("wipes key with number <key slot> from LUKS device") },
+       { "luksUUID",   action_luksUUID,        0, 1, 0, N_("<device>"), N_("print UUID of LUKS device") },
+       { "isLuks",     action_isLuks,          0, 1, 0, N_("<device>"), N_("tests <device> for LUKS partition header") },
+       { "luksClose",  action_remove,          0, 1, 1, N_("<name>"), N_("remove LUKS mapping") },
+       { "luksDump",   action_luksDump,        0, 1, 0, N_("<device>"), N_("dump LUKS partition information") },
+       { "luksSuspend",action_luksSuspend,     0, 1, 1, N_("<device>"), N_("Suspend LUKS device and wipe key (all IOs are frozen).") },
+       { "luksResume", action_luksResume,      0, 1, 1, N_("<device>"), N_("Resume suspended LUKS device.") },
+       { "luksHeaderBackup",action_luksBackup, 0, 1, 1, N_("<device>"), N_("Backup LUKS device header and keyslots") },
+       { "luksHeaderRestore",action_luksRestore,0,1, 1, N_("<device>"), N_("Restore LUKS device header and keyslots") },
+       { "luksDelKey", action_luksDelKey,      0, 2, 1, N_("<device> <key slot>"), N_("identical to luksKillSlot - DEPRECATED - see man page") },
+       { "reload",     action_create,          1, 2, 1, N_("<name> <device>"), N_("modify active device - DEPRECATED - see man page") },
+       { NULL, NULL, 0, 0, 0, NULL, NULL }
 };
 
+static void clogger(struct crypt_device *cd, int class, const char *file,
+                  int line, const char *format, ...)
+{
+       va_list argp;
+       char *target = NULL;
+
+       va_start(argp, format);
+
+       if (vasprintf(&target, format, argp) > 0) {
+               if (class >= 0) {
+                       crypt_log(cd, class, target);
+#ifdef CRYPT_DEBUG
+               } else if (opt_debug)
+                       printf("# %s:%d %s\n", file ?: "?", line, target);
+#else
+               } else if (opt_debug)
+                       printf("# %s\n", target);
+#endif
+       }
+
+       va_end(argp);
+       free(target);
+}
+
 /* Interface Callbacks */
 static int yesDialog(char *msg)
 {
@@ -125,33 +157,45 @@ static struct interface_callbacks cmd_icb = {
         .log = cmdLineLog,
 };
 
+static void _log(int class, const char *msg, void *usrptr)
+{
+       cmdLineLog(class, (char *)msg);
+}
+
+static int _yesDialog(const char *msg, void *usrptr)
+{
+       return yesDialog((char*)msg);
+}
+
 /* End ICBs */
 
 static void show_status(int errcode)
 {
-       char error[256];
+       char error[256], *error_;
+
+       if(!opt_verbose)
+               return;
 
-       if(!errcode && opt_verbose) {
+       if(!errcode) {
                log_std(_("Command successful.\n"));
                return;
        }
 
        crypt_get_error(error, sizeof(error));
 
-       if (!opt_verbose) {
-               char *error_ = strerror_r(errcode, error, sizeof(error));
+       if (!error[0]) {
+               error_ = strerror_r(-errcode, error, sizeof(error));
                if (error_ != error) {
                        strncpy(error, error_, sizeof(error));
-                       error[sizeof error - 1] = '\0';
+                       error[sizeof(error) - 1] = '\0';
                }
        }
 
-       log_err(_("Command failed"));
+       log_err(_("Command failed with code %i"), -errcode);
        if (*error)
                log_err(": %s\n", error);
        else
                log_err(".\n");
-       return;
 }
 
 static int action_create(int reload)
@@ -159,10 +203,10 @@ static int action_create(int reload)
        struct crypt_options options = {
                .name = action_argv[0],
                .device = action_argv[1],
-               .cipher = opt_cipher?opt_cipher:DEFAULT_CIPHER,
-               .hash = opt_hash ?: DEFAULT_HASH,
+               .cipher = opt_cipher ? opt_cipher : DEFAULT_CIPHER(PLAIN),
+               .hash = opt_hash ?: DEFAULT_PLAIN_HASH,
                .key_file = opt_key_file,
-               .key_size = ((opt_key_size)?opt_key_size:DEFAULT_KEY_SIZE)/8,
+               .key_size = (opt_key_size ?: DEFAULT_PLAIN_KEYBITS) / 8,
                .key_slot = opt_key_slot,
                .flags = 0,
                .size = opt_size,
@@ -250,11 +294,11 @@ static int action_status(int arg)
 static int _action_luksFormat_generateMK()
 {
        struct crypt_options options = {
-               .key_size = (opt_key_size ?: DEFAULT_LUKS_KEY_SIZE) / 8,
+               .key_size = (opt_key_size ?: DEFAULT_LUKS1_KEYBITS) / 8,
                .key_slot = opt_key_slot,
                .device = action_argv[0],
-               .cipher = opt_cipher ?: DEFAULT_LUKS_CIPHER,
-               .hash = opt_hash ?: DEFAULT_LUKS_HASH,
+               .cipher = opt_cipher ?: DEFAULT_CIPHER(LUKS1),
+               .hash = opt_hash ?: DEFAULT_LUKS1_HASH,
                .new_key_file = action_argc > 1 ? action_argv[1] : NULL,
                .flags = opt_verify_passphrase ? CRYPT_FLAG_VERIFY : (!opt_batch_mode?CRYPT_FLAG_VERIFY_IF_POSSIBLE :  0),
                .iteration_time = opt_iteration_time,
@@ -296,16 +340,18 @@ static int _action_luksFormat_useMK()
        char *key = NULL, cipher [MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
        struct crypt_device *cd = NULL;
        struct crypt_params_luks1 params = {
-               .hash = opt_hash ?: DEFAULT_LUKS_HASH,
+               .hash = opt_hash ?: DEFAULT_LUKS1_HASH,
                .data_alignment = opt_align_payload,
        };
 
-       if (parse_into_name_and_mode(opt_cipher ?: DEFAULT_LUKS_CIPHER, cipher, cipher_mode)) {
+       if (sscanf(opt_cipher ?: DEFAULT_CIPHER(LUKS1),
+                  "%" MAX_CIPHER_LEN_STR "[^-]-%" MAX_CIPHER_LEN_STR "s",
+                  cipher, cipher_mode) != 2) {
                log_err("No known cipher specification pattern detected.\n");
                return -EINVAL;
        }
 
-       keysize = (opt_key_size ?: DEFAULT_LUKS_KEY_SIZE) / 8;
+       keysize = (opt_key_size ?: DEFAULT_LUKS1_KEYBITS) / 8;
        if (_read_mk(opt_master_key_file, &key, keysize) < 0)
                return -EINVAL;
 
@@ -372,7 +418,8 @@ static int action_luksOpen(int arg)
        if (opt_readonly)
                options.flags |= CRYPT_FLAG_READONLY;
        if (opt_non_exclusive)
-               options.flags |= CRYPT_FLAG_NON_EXCLUSIVE_ACCESS;
+               log_err(_("Obsolete option --non-exclusive is ignored.\n"));
+
        return crypt_luksOpen(&options);
 }
 
@@ -490,6 +537,84 @@ static int action_luksDump(int arg)
        return crypt_luksDump(&options);
 }
 
+static int action_luksSuspend(int arg)
+{
+       struct crypt_device *cd = NULL;
+       int r;
+
+       r = crypt_init_by_name(&cd, action_argv[0]);
+       if (!r)
+               r = crypt_suspend(cd, action_argv[0]);
+
+       crypt_free(cd);
+       return r;
+}
+
+static int action_luksResume(int arg)
+{
+       struct crypt_device *cd = NULL;
+       int r;
+
+       if ((r = crypt_init_by_name(&cd, action_argv[0])))
+               goto out;
+
+       if ((r = crypt_load(cd, CRYPT_LUKS1, NULL)))
+               goto out;
+
+       if (opt_key_file)
+               r = crypt_resume_by_keyfile(cd, action_argv[0], CRYPT_ANY_SLOT,
+                                           opt_key_file, opt_key_size / 8);
+       else
+               r = crypt_resume_by_passphrase(cd, action_argv[0], CRYPT_ANY_SLOT,
+                                              NULL, 0);
+out:
+       crypt_free(cd);
+       return r;
+}
+
+static int action_luksBackup(int arg)
+{
+       struct crypt_device *cd = NULL;
+       int r;
+
+       if (!opt_header_backup_file) {
+               log_err(_("Option --header-backup-file is required.\n"));
+               return -EINVAL;
+       }
+
+       if ((r = crypt_init(&cd, action_argv[0])))
+               goto out;
+
+       crypt_set_log_callback(cd, _log, NULL);
+       crypt_set_confirm_callback(cd, _yesDialog, NULL);
+
+       r = crypt_header_backup(cd, CRYPT_LUKS1, opt_header_backup_file);
+out:
+       crypt_free(cd);
+       return r;
+}
+
+static int action_luksRestore(int arg)
+{
+       struct crypt_device *cd = NULL;
+       int r = 0;
+
+       if (!opt_header_backup_file) {
+               log_err(_("Option --header-backup-file is required.\n"));
+               return -EINVAL;
+       }
+
+       if ((r = crypt_init(&cd, action_argv[0])))
+               goto out;
+
+       crypt_set_log_callback(cd, _log, NULL);
+       crypt_set_confirm_callback(cd, _yesDialog, NULL);
+       r = crypt_header_restore(cd, CRYPT_LUKS1, opt_header_backup_file);
+out:
+       crypt_free(cd);
+       return r;
+}
+
 static void usage(poptContext popt_context, int exitcode,
                   const char *error, const char *more)
 {
@@ -521,6 +646,12 @@ static void help(poptContext popt_context, enum poptCallbackReason reason,
                         "<key slot> is the LUKS key slot number to modify\n"
                         "<key file> optional key file for the new key for luksAddKey action\n"),
                        crypt_get_dir());
+
+               log_std(_("\nDefault compiled-in device cipher parameters:\n"
+                        "\tplain: %s, Key: %d bits, Password hashing: %s\n"
+                        "\tLUKS1: %s, Key: %d bits, LUKS header hashing: %s\n"),
+                        DEFAULT_CIPHER(PLAIN), DEFAULT_PLAIN_KEYBITS, DEFAULT_PLAIN_HASH,
+                        DEFAULT_CIPHER(LUKS1), DEFAULT_LUKS1_KEYBITS, DEFAULT_LUKS1_HASH);
                exit(0);
        } else
                usage(popt_context, 0, NULL, NULL);
@@ -545,11 +676,6 @@ static int run_action(struct action_type *action)
 {
        int r;
 
-       if (dm_init(NULL, action->required_dm_backend) < 1) {
-               log_err("Cannot communicate with device-mapper. Is dm_mod kernel module loaded?\n");
-               return -ENOSYS;
-       }
-
        if (action->required_memlock)
                crypt_memory_lock(NULL, 1);
 
@@ -558,11 +684,7 @@ static int run_action(struct action_type *action)
        if (action->required_memlock)
                crypt_memory_lock(NULL, 0);
 
-       if (action->required_dm_backend)
-               dm_exit();
-
-       if (r < 0 && (opt_verbose || action->show_status))
-               show_status(-r);
+       show_status(r);
 
        return r;
 }
@@ -579,7 +701,7 @@ int main(int argc, char **argv)
        static struct poptOption popt_options[] = {
                { NULL,                '\0', POPT_ARG_INCLUDE_TABLE,                      popt_help_options,      0, N_("Help options:"),                                                   NULL },
                { "verbose",           'v',  POPT_ARG_NONE,                               &opt_verbose,           0, N_("Shows more detailed error messages"),                              NULL },
-               { "debug",             '\0', POPT_ARG_NONE,                               &opt_debug,             0, N_("Show debug messsgages"),                                           NULL },
+               { "debug",             '\0', POPT_ARG_NONE,                               &opt_debug,             0, N_("Show debug messages"),                                             NULL },
                { "cipher",            'c',  POPT_ARG_STRING | POPT_ARGFLAG_SHOW_DEFAULT, &opt_cipher,            0, N_("The cipher used to encrypt the disk (see /proc/crypto)"),          NULL },
                { "hash",              'h',  POPT_ARG_STRING | POPT_ARGFLAG_SHOW_DEFAULT, &opt_hash,              0, N_("The hash used to create the encryption key from the passphrase"),  NULL },
                { "verify-passphrase", 'y',  POPT_ARG_NONE,                               &opt_verify_passphrase, 0, N_("Verifies the passphrase by asking for it twice"),                  NULL },
@@ -592,13 +714,14 @@ int main(int argc, char **argv)
                { "skip",              'p',  POPT_ARG_STRING,                             &popt_tmp,              3, N_("How many sectors of the encrypted data to skip at the beginning"), N_("SECTORS") },
                { "readonly",          'r',  POPT_ARG_NONE,                               &opt_readonly,          0, N_("Create a readonly mapping"),                                       NULL },
                { "iter-time",         'i',  POPT_ARG_INT,                                &opt_iteration_time,    0, N_("PBKDF2 iteration time for LUKS (in ms)"),
-                 N_("msecs") },
+               N_("msecs") },
                { "batch-mode",        'q',  POPT_ARG_NONE,                               &opt_batch_mode,        0, N_("Do not ask for confirmation"),                                     NULL },
-               { "version",        '\0',  POPT_ARG_NONE,                                 &opt_version_mode,        0, N_("Print package version"),                                     NULL },
+               { "version",           '\0',  POPT_ARG_NONE,                              &opt_version_mode,      0, N_("Print package version"),                                     NULL },
                { "timeout",           't',  POPT_ARG_INT,                                &opt_timeout,           0, N_("Timeout for interactive passphrase prompt (in seconds)"),          N_("secs") },
-               { "tries",             'T',  POPT_ARG_INT,                                &opt_tries,             0, N_("How often the input of the passphrase canbe retried"),            NULL },
+               { "tries",             'T',  POPT_ARG_INT,                                &opt_tries,             0, N_("How often the input of the passphrase can be retried"),            NULL },
                { "align-payload",     '\0',  POPT_ARG_INT,                               &opt_align_payload,     0, N_("Align payload at <n> sector boundaries - for luksFormat"),         N_("SECTORS") },
-               { "non-exclusive",     '\0',  POPT_ARG_NONE,                              &opt_non_exclusive,     0, N_("Allows non-exclusive access for luksOpen, WARNING see manpage."),        NULL },
+               { "non-exclusive",     '\0',  POPT_ARG_NONE,                              &opt_non_exclusive,     0, N_("(Obsoleted, see man page.)"),        NULL },
+               { "header-backup-file",'\0',  POPT_ARG_STRING,                            &opt_header_backup_file,0, N_("File with LUKS header and keyslots backup."),        NULL },
                POPT_TABLEEND
        };
        poptContext popt_context;
@@ -607,7 +730,7 @@ int main(int argc, char **argv)
        int r;
        const char *null_action_argv[] = {NULL};
 
-       set_default_log(cmdLineLog);
+       crypt_set_log_callback(NULL, _log, NULL);
 
        setlocale(LC_ALL, "");
        bindtextdomain(PACKAGE, LOCALEDIR);