Fix previous commit to properly check udev flag definition.
[platform/upstream/cryptsetup.git] / lib / libdevmapper.c
index 7d72a2f..3d3c1a4 100644 (file)
@@ -1,23 +1,52 @@
 #include <sys/ioctl.h>
+#include <sys/stat.h>
+#include <stdio.h>
 #include <dirent.h>
 #include <errno.h>
 #include <libdevmapper.h>
 #include <fcntl.h>
 #include <linux/fs.h>
+#include <uuid/uuid.h>
 
 #include "internal.h"
 #include "luks.h"
 
 #define DEVICE_DIR             "/dev"
+#define DM_UUID_LEN            129
 #define DM_UUID_PREFIX         "CRYPT-"
 #define DM_UUID_PREFIX_LEN     6
-#define DM_UUID_LEN            UUID_STRING_L
 #define DM_CRYPT_TARGET                "crypt"
 #define RETRY_COUNT            5
 
+/* Set if dm-crypt version was probed */
+static int _dm_crypt_checked = 0;
+static int _dm_crypt_wipe_key_supported = 0;
+
 static int _dm_use_count = 0;
 static struct crypt_device *_context = NULL;
 
+/* Compatibility for old device-mapper without udev support */
+#if HAVE_DECL_DM_UDEV_DISABLE_DISK_RULES_FLAG
+#define CRYPT_TEMP_UDEV_FLAGS  DM_UDEV_DISABLE_SUBSYSTEM_RULES_FLAG | \
+                               DM_UDEV_DISABLE_DISK_RULES_FLAG | \
+                               DM_UDEV_DISABLE_OTHER_RULES_FLAG
+#define _dm_task_set_cookie    dm_task_set_cookie
+#define _dm_udev_wait          dm_udev_wait
+#else
+#define CRYPT_TEMP_UDEV_FLAGS  0
+static int _dm_task_set_cookie(struct dm_task *dmt, uint32_t *cookie, uint16_t flags) { return 0; }
+static int _dm_udev_wait(uint32_t cookie) { return 0; };
+#endif
+
+static int _dm_use_udev()
+{
+#ifdef USE_UDEV /* cannot be enabled if devmapper is too old */
+       return dm_udev_get_sync_support();
+#else
+       return 0;
+#endif
+}
+
 static void set_dm_error(int level, const char *file, int line,
                         const char *f, ...)
 {
@@ -36,19 +65,68 @@ static void set_dm_error(int level, const char *file, int line,
        va_end(va);
 }
 
-static int _dm_simple(int task, const char *name);
+static int _dm_simple(int task, const char *name, int udev_wait);
+
+static void _dm_set_crypt_compat(int maj, int min, int patch)
+{
+       log_dbg("Detected dm-crypt target of version %i.%i.%i.", maj, min, patch);
+
+       if (maj >= 1 && min >=2)
+               _dm_crypt_wipe_key_supported = 1;
+       else
+               log_dbg("Suspend and resume disabled, no wipe key support.");
+
+       _dm_crypt_checked = 1;
+}
+
+static int _dm_check_versions(void)
+{
+       struct dm_task *dmt;
+       struct dm_versions *target, *last_target;
+
+       if (_dm_crypt_checked)
+               return 1;
+
+       if (!(dmt = dm_task_create(DM_DEVICE_LIST_VERSIONS)))
+               return 0;
+
+       if (!dm_task_run(dmt)) {
+               dm_task_destroy(dmt);
+               return 0;
+       }
+
+       target = dm_task_get_versions(dmt);
+       do {
+               last_target = target;
+               if (!strcmp(DM_CRYPT_TARGET, target->name)) {
+                       _dm_set_crypt_compat((int)target->version[0],
+                                            (int)target->version[1],
+                                            (int)target->version[2]);
+               }
+               target = (void *) target + target->next;
+       } while (last_target != target);
+
+       dm_task_destroy(dmt);
+       return 1;
+}
 
 int dm_init(struct crypt_device *context, int check_kernel)
 {
        if (!_dm_use_count++) {
-               log_dbg("Initialising device-mapper backend%s.",
-                       check_kernel ? "" : " (NO kernel check requested)");
-               if (check_kernel && !_dm_simple(DM_DEVICE_LIST_VERSIONS, NULL))
+               log_dbg("Initialising device-mapper backend%s, UDEV is %sabled.",
+                       check_kernel ? "" : " (NO kernel check requested)",
+                       _dm_use_udev() ? "en" : "dis");
+               if (check_kernel && !_dm_check_versions()) {
+                       log_err(context, _("Cannot initialize device-mapper. Is dm_mod kernel module loaded?\n"));
                        return -1;
+               }
+               if (getuid() || geteuid())
+                       log_dbg(("WARNING: Running as a non-root user. Functionality may be unavailable."));
                dm_log_init(set_dm_error);
                dm_log_init_verbose(10);
        }
 
+       // FIXME: global context is not safe
        if (context)
                _context = context;
 
@@ -66,7 +144,7 @@ void dm_exit(void)
        }
 }
 
-static char *__lookup_dev(char *path, dev_t dev)
+static char *__lookup_dev(char *path, dev_t dev, int dir_level, const int max_level)
 {
        struct dirent *entry;
        struct stat st;
@@ -75,6 +153,10 @@ static char *__lookup_dev(char *path, dev_t dev)
        DIR *dir;
        int space;
 
+       /* Ignore strange nested directories */
+       if (dir_level > max_level)
+               return NULL;
+
        path[PATH_MAX - 1] = '\0';
        ptr = path + strlen(path);
        *ptr++ = '/';
@@ -86,20 +168,22 @@ static char *__lookup_dev(char *path, dev_t dev)
                return NULL;
 
        while((entry = readdir(dir))) {
-               if (entry->d_name[0] == '.' &&
-                   (entry->d_name[1] == '\0' || (entry->d_name[1] == '.' &&
-                                                 entry->d_name[2] == '\0')))
+               if (entry->d_name[0] == '.' ||
+                   !strncmp(entry->d_name, "..", 2))
                        continue;
 
                strncpy(ptr, entry->d_name, space);
-               if (lstat(path, &st) < 0)
+               if (stat(path, &st) < 0)
                        continue;
 
                if (S_ISDIR(st.st_mode)) {
-                       result = __lookup_dev(path, dev);
+                       result = __lookup_dev(path, dev, dir_level + 1, max_level);
                        if (result)
                                break;
                } else if (S_ISBLK(st.st_mode)) {
+                       /* workaround: ignore dm-X devices, these are internal kernel names */
+                       if (dir_level == 0 && !strncmp(entry->d_name, "dm-", 3))
+                               continue;
                        if (st.st_rdev == dev) {
                                result = strdup(path);
                                break;
@@ -108,22 +192,38 @@ static char *__lookup_dev(char *path, dev_t dev)
        }
 
        closedir(dir);
-
        return result;
 }
 
-static char *lookup_dev(const char *dev)
+static char *lookup_dev(const char *dev_id)
 {
        uint32_t major, minor;
-       char buf[PATH_MAX + 1];
+       dev_t dev;
+       char *result = NULL, buf[PATH_MAX + 1];
 
-       if (sscanf(dev, "%" PRIu32 ":%" PRIu32, &major, &minor) != 2)
+       if (sscanf(dev_id, "%" PRIu32 ":%" PRIu32, &major, &minor) != 2)
                return NULL;
 
+       dev = makedev(major, minor);
        strncpy(buf, DEVICE_DIR, PATH_MAX);
        buf[PATH_MAX] = '\0';
 
-       return __lookup_dev(buf, makedev(major, minor));
+       /* First try low level device */
+       if ((result = __lookup_dev(buf, dev, 0, 0)))
+               return result;
+
+       /* If it is dm, try DM dir  */
+       if (dm_is_dm_major(major)) {
+               strncpy(buf, dm_dir(), PATH_MAX);
+               if ((result = __lookup_dev(buf, dev, 0, 0)))
+                       return result;
+       }
+
+       strncpy(buf, DEVICE_DIR, PATH_MAX);
+       result = __lookup_dev(buf, dev, 0, 4);
+
+       /* If not found, return NULL */
+       return result;
 }
 
 static int _dev_read_ahead(const char *dev, uint32_t *read_ahead)
@@ -143,19 +243,25 @@ static int _dev_read_ahead(const char *dev, uint32_t *read_ahead)
        return r;
 }
 
+static void hex_key(char *hexkey, size_t key_size, const char *key)
+{
+       int i;
+
+       for(i = 0; i < key_size; i++)
+               sprintf(&hexkey[i * 2], "%02x", (unsigned char)key[i]);
+}
+
 static char *get_params(const char *device, uint64_t skip, uint64_t offset,
                        const char *cipher, size_t key_size, const char *key)
 {
        char *params;
        char *hexkey;
-       int i;
 
        hexkey = safe_alloc(key_size * 2 + 1);
        if (!hexkey)
                return NULL;
 
-       for(i = 0; i < key_size; i++)
-               sprintf(&hexkey[i * 2], "%02x", (unsigned char)key[i]);
+       hex_key(hexkey, key_size, key);
 
        params = safe_alloc(strlen(hexkey) + strlen(cipher) + strlen(device) + 64);
        if (!params)
@@ -170,10 +276,14 @@ out:
 }
 
 /* DM helpers */
-static int _dm_simple(int task, const char *name)
+static int _dm_simple(int task, const char *name, int udev_wait)
 {
        int r = 0;
        struct dm_task *dmt;
+       uint32_t cookie = 0;
+
+       if (!_dm_use_udev())
+               udev_wait = 0;
 
        if (!(dmt = dm_task_create(task)))
                return 0;
@@ -181,8 +291,14 @@ static int _dm_simple(int task, const char *name)
        if (name && !dm_task_set_name(dmt, name))
                goto out;
 
+       if (udev_wait && !_dm_task_set_cookie(dmt, &cookie, 0))
+               goto out;
+
        r = dm_task_run(dmt);
 
+       if (udev_wait)
+               (void)_dm_udev_wait(cookie);
+
       out:
        dm_task_destroy(dmt);
        return r;
@@ -211,8 +327,8 @@ static int _error_device(const char *name, size_t size)
        if (!dm_task_run(dmt))
                goto error;
 
-       if (!_dm_simple(DM_DEVICE_RESUME, name)) {
-               _dm_simple(DM_DEVICE_CLEAR, name);
+       if (!_dm_simple(DM_DEVICE_RESUME, name, 1)) {
+               _dm_simple(DM_DEVICE_CLEAR, name, 0);
                goto error;
        }
 
@@ -227,29 +343,31 @@ int dm_remove_device(const char *name, int force, uint64_t size)
 {
        int r = -EINVAL;
        int retries = force ? RETRY_COUNT : 1;
+       int error_target = 0;
 
        if (!name || (force && !size))
                return -EINVAL;
 
-       /* If force flag is set, replace device with error, read-only target.
-        * it should stop processes from reading it and also removed underlying
-        * device from mapping, so it is usable again.
-        * Force flag should be used only for temporary devices, which are
-        * intended to work inside cryptsetup only!
-        * Anyway, if some process try to read temporary cryptsetup device,
-        * it is bug - no other process should try touch it (e.g. udev).
-        */
-       if (force) {
-                _error_device(name, size);
-               retries = RETRY_COUNT;
-       }
-
        do {
-               r = _dm_simple(DM_DEVICE_REMOVE, name) ? 0 : -EINVAL;
+               r = _dm_simple(DM_DEVICE_REMOVE, name, 1) ? 0 : -EINVAL;
                if (--retries && r) {
                        log_dbg("WARNING: other process locked internal device %s, %s.",
                                name, retries ? "retrying remove" : "giving up");
+                       if (force && (crypt_get_debug_level() == CRYPT_LOG_DEBUG))
+                               debug_processes_using_device(name);
                        sleep(1);
+                       if (force && !error_target) {
+                               /* If force flag is set, replace device with error, read-only target.
+                                * it should stop processes from reading it and also removed underlying
+                                * device from mapping, so it is usable again.
+                                * Force flag should be used only for temporary devices, which are
+                                * intended to work inside cryptsetup only!
+                                * Anyway, if some process try to read temporary cryptsetup device,
+                                * it is bug - no other process should try touch it (e.g. udev).
+                                */
+                               _error_device(name, size);
+                               error_target = 1;
+                       }
                }
        } while (r == -EINVAL && retries);
 
@@ -258,9 +376,42 @@ int dm_remove_device(const char *name, int force, uint64_t size)
        return r;
 }
 
+#define UUID_LEN 37 /* 36 + \0, libuuid ... */
+/*
+ * UUID has format: CRYPT-<devicetype>-[<uuid>-]<device name>
+ * CRYPT-PLAIN-name
+ * CRYPT-LUKS1-00000000000000000000000000000000-name
+ * CRYPT-TEMP-name
+ */
+static void dm_prepare_uuid(const char *name, const char *type, const char *uuid, char *buf, size_t buflen)
+{
+       char *ptr, uuid2[UUID_LEN] = {0};
+       uuid_t uu;
+       int i = 0;
+
+       /* Remove '-' chars */
+       if (uuid && !uuid_parse(uuid, uu)) {
+               for (ptr = uuid2, i = 0; i < UUID_LEN; i++)
+                       if (uuid[i] != '-') {
+                               *ptr = uuid[i];
+                               ptr++;
+                       }
+       }
+
+       i = snprintf(buf, buflen, DM_UUID_PREFIX "%s%s%s%s%s",
+               type ?: "", type ? "-" : "",
+               uuid2[0] ? uuid2 : "", uuid2[0] ? "-" : "",
+               name);
+
+       log_dbg("DM-UUID is %s", buf);
+       if (i >= buflen)
+               log_err(NULL, _("DM-UUID for device %s was truncated.\n"), name);
+}
+
 int dm_create_device(const char *name,
                     const char *device,
                     const char *cipher,
+                    const char *type,
                     const char *uuid,
                     uint64_t size,
                     uint64_t skip,
@@ -271,29 +422,45 @@ int dm_create_device(const char *name,
                     int reload)
 {
        struct dm_task *dmt = NULL;
-       struct dm_task *dmt_query = NULL;
        struct dm_info dmi;
        char *params = NULL;
        char *error = NULL;
-       char dev_uuid[DM_UUID_PREFIX_LEN + DM_UUID_LEN + 1] = {0};
+       char dev_uuid[DM_UUID_LEN] = {0};
        int r = -EINVAL;
        uint32_t read_ahead = 0;
+       uint32_t cookie = 0;
+       uint16_t udev_flags = 0;
 
        params = get_params(device, skip, offset, cipher, key_size, key);
        if (!params)
                goto out_no_removal;
-       if (uuid) {
-               strncpy(dev_uuid, DM_UUID_PREFIX, DM_UUID_PREFIX_LEN);
-               strncpy(dev_uuid + DM_UUID_PREFIX_LEN, uuid, DM_UUID_LEN);
-               dev_uuid[DM_UUID_PREFIX_LEN + DM_UUID_LEN] = '\0';
+
+       if (type && !strncmp(type, "TEMP", 4))
+               udev_flags = CRYPT_TEMP_UDEV_FLAGS;
+
+       /* All devices must have DM_UUID, only resize on old device is exception */
+       if (reload) {
+               if (!(dmt = dm_task_create(DM_DEVICE_RELOAD)))
+                       goto out_no_removal;
+
+               if (!dm_task_set_name(dmt, name))
+                       goto out_no_removal;
+       } else {
+               dm_prepare_uuid(name, type, uuid, dev_uuid, sizeof(dev_uuid));
+
+               if (!(dmt = dm_task_create(DM_DEVICE_CREATE)))
+                       goto out_no_removal;
+
+               if (!dm_task_set_name(dmt, name))
+                       goto out_no_removal;
+
+               if (!dm_task_set_uuid(dmt, dev_uuid))
+                       goto out_no_removal;
+
+               if (_dm_use_udev() && !_dm_task_set_cookie(dmt, &cookie, udev_flags))
+                       goto out_no_removal;
        }
 
-       if (!(dmt = dm_task_create(reload ? DM_DEVICE_RELOAD
-                                         : DM_DEVICE_CREATE)))
-               goto out_no_removal;
-       if (!dm_task_set_name(dmt, name))
-               goto out_no_removal;
        if (read_only && !dm_task_set_ro(dmt))
                goto out_no_removal;
        if (!dm_task_add_target(dmt, 0, size, DM_CRYPT_TARGET, params))
@@ -305,9 +472,6 @@ int dm_create_device(const char *name,
                goto out_no_removal;
 #endif
 
-       if (uuid && !dm_task_set_uuid(dmt, dev_uuid))
-               goto out_no_removal;
-
        if (!dm_task_run(dmt))
                goto out_no_removal;
 
@@ -319,6 +483,8 @@ int dm_create_device(const char *name,
                        goto out;
                if (uuid && !dm_task_set_uuid(dmt, dev_uuid))
                        goto out;
+               if (_dm_use_udev() && !_dm_task_set_cookie(dmt, &cookie, udev_flags))
+                       goto out;
                if (!dm_task_run(dmt))
                        goto out;
        }
@@ -328,6 +494,11 @@ int dm_create_device(const char *name,
 
        r = 0;
 out:
+       if (_dm_use_udev()) {
+               (void)_dm_udev_wait(cookie);
+               cookie = 0;
+       }
+
        if (r < 0 && !reload) {
                if (get_error())
                        error = strdup(get_error());
@@ -341,12 +512,14 @@ out:
        }
 
 out_no_removal:
+       if (cookie && _dm_use_udev())
+               (void)_dm_udev_wait(cookie);
+
        if (params)
                safe_free(params);
        if (dmt)
                dm_task_destroy(dmt);
-       if(dmt_query)
-               dm_task_destroy(dmt_query);
+
        dm_task_update_nodes();
        return r;
 }
@@ -369,7 +542,7 @@ int dm_status_device(const char *name)
        }
 
        if (!dm_task_run(dmt)) {
-               r = -ENODEV;
+               r = -EINVAL;
                goto out;
        }
 
@@ -405,12 +578,14 @@ int dm_query_device(const char *name,
                    char **cipher,
                    int *key_size,
                    char **key,
-                   int *read_only)
+                   int *read_only,
+                   int *suspended,
+                   char **uuid)
 {
        struct dm_task *dmt;
        struct dm_info dmi;
        uint64_t start, length, val64;
-       char *target_type, *params, *rcipher, *key_, *rdevice, *endp, buffer[3];
+       char *target_type, *params, *rcipher, *key_, *rdevice, *endp, buffer[3], *tmp_uuid;
        void *next = NULL;
        int i, r = -EINVAL;
 
@@ -495,10 +670,16 @@ int dm_query_device(const char *name,
        }
        memset(key_, 0, strlen(key_));
 
-       /* read_only */
        if (read_only)
                *read_only = dmi.read_only;
 
+       if (suspended)
+               *suspended = dmi.suspended;
+
+       if (uuid && (tmp_uuid = (char*)dm_task_get_uuid(dmt)) &&
+           !strncmp(tmp_uuid, DM_UUID_PREFIX, DM_UUID_PREFIX_LEN))
+               *uuid = strdup(tmp_uuid + DM_UUID_PREFIX_LEN);
+
        r = (dmi.open_count > 0);
 out:
        if (dmt)
@@ -507,6 +688,79 @@ out:
        return r;
 }
 
+static int _dm_message(const char *name, const char *msg)
+{
+       int r = 0;
+       struct dm_task *dmt;
+
+       if (!(dmt = dm_task_create(DM_DEVICE_TARGET_MSG)))
+               return 0;
+
+       if (name && !dm_task_set_name(dmt, name))
+               goto out;
+
+       if (!dm_task_set_sector(dmt, (uint64_t) 0))
+               goto out;
+
+       if (!dm_task_set_message(dmt, msg))
+               goto out;
+
+       r = dm_task_run(dmt);
+
+      out:
+       dm_task_destroy(dmt);
+       return r;
+}
+
+int dm_suspend_and_wipe_key(const char *name)
+{
+       if (!_dm_check_versions())
+               return -ENOTSUP;
+
+       if (!_dm_crypt_wipe_key_supported)
+               return -ENOTSUP;
+
+       if (!_dm_simple(DM_DEVICE_SUSPEND, name, 0))
+               return -EINVAL;
+
+       if (!_dm_message(name, "key wipe")) {
+               _dm_simple(DM_DEVICE_RESUME, name, 1);
+               return -EINVAL;
+       }
+
+       return 0;
+}
+
+int dm_resume_and_reinstate_key(const char *name,
+                               size_t key_size,
+                               const char *key)
+{
+       int msg_size = key_size * 2 + 10; // key set <key>
+       char *msg;
+       int r = 0;
+
+       if (!_dm_check_versions())
+               return -ENOTSUP;
+
+       if (!_dm_crypt_wipe_key_supported)
+               return -ENOTSUP;
+
+       msg = safe_alloc(msg_size);
+       if (!msg)
+               return -ENOMEM;
+
+       memset(msg, 0, msg_size);
+       strcpy(msg, "key set ");
+       hex_key(&msg[8], key_size, key);
+
+       if (!_dm_message(name, msg) ||
+           !_dm_simple(DM_DEVICE_RESUME, name, 1))
+               r = -EINVAL;
+
+       safe_free(msg);
+       return r;
+}
+
 const char *dm_get_dir(void)
 {
        return dm_dir();