Imported Upstream version 2.3.3
[platform/upstream/cryptsetup.git] / lib / utils_dm.h
index cd8b653..1501eb5 100644 (file)
@@ -1,10 +1,10 @@
 /*
  * libdevmapper - device-mapper backend for cryptsetup
  *
- * Copyright (C) 2004, Jana Saout <jana@saout.de>
- * Copyright (C) 2004-2007, Clemens Fruhwirth <clemens@endorphin.org>
- * Copyright (C) 2009-2015, Red Hat, Inc. All rights reserved.
- * Copyright (C) 2009-2015, Milan Broz
+ * Copyright (C) 2004 Jana Saout <jana@saout.de>
+ * Copyright (C) 2004-2007 Clemens Fruhwirth <clemens@endorphin.org>
+ * Copyright (C) 2009-2020 Red Hat, Inc. All rights reserved.
+ * Copyright (C) 2009-2020 Milan Broz
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -31,6 +31,18 @@ struct crypt_device;
 struct volume_key;
 struct crypt_params_verity;
 struct device;
+struct crypt_params_integrity;
+
+/* Device mapper internal flags */
+#define DM_RESUME_PRIVATE      (1 << 4) /* CRYPT_ACTIVATE_PRIVATE */
+#define DM_SUSPEND_SKIP_LOCKFS (1 << 5)
+#define DM_SUSPEND_WIPE_KEY    (1 << 6)
+#define DM_SUSPEND_NOFLUSH     (1 << 7)
+
+static inline uint32_t act2dmflags(uint32_t act_flags)
+{
+       return (act_flags & DM_RESUME_PRIVATE);
+}
 
 /* Device mapper backend - kernel support flags */
 #define DM_KEY_WIPE_SUPPORTED (1 << 0) /* key wipe message */
@@ -42,71 +54,178 @@ struct device;
 #define DM_TCW_SUPPORTED      (1 << 6) /* tcw (TCRYPT CBC with whitening) */
 #define DM_SAME_CPU_CRYPT_SUPPORTED (1 << 7) /* same_cpu_crypt */
 #define DM_SUBMIT_FROM_CRYPT_CPUS_SUPPORTED (1 << 8) /* submit_from_crypt_cpus */
-
-uint32_t dm_flags(void);
+#define DM_VERITY_ON_CORRUPTION_SUPPORTED (1 << 9) /* ignore/restart_on_corruption, ignore_zero_block */
+#define DM_VERITY_FEC_SUPPORTED (1 << 10) /* Forward Error Correction (FEC) */
+#define DM_KERNEL_KEYRING_SUPPORTED (1 << 11) /* dm-crypt allows loading kernel keyring keys */
+#define DM_INTEGRITY_SUPPORTED (1 << 12) /* dm-integrity target supported */
+#define DM_SECTOR_SIZE_SUPPORTED (1 << 13) /* support for sector size setting in dm-crypt/dm-integrity */
+#define DM_CAPI_STRING_SUPPORTED (1 << 14) /* support for cryptoapi format cipher definition */
+#define DM_DEFERRED_SUPPORTED (1 << 15) /* deferred removal of device */
+#define DM_INTEGRITY_RECALC_SUPPORTED (1 << 16) /* dm-integrity automatic recalculation supported */
+#define DM_INTEGRITY_BITMAP_SUPPORTED (1 << 17) /* dm-integrity bitmap mode supported */
+#define DM_GET_TARGET_VERSION_SUPPORTED (1 << 18) /* dm DM_GET_TARGET version ioctl supported */
+#define DM_INTEGRITY_FIX_PADDING_SUPPORTED (1 << 19) /* supports the parameter fix_padding that fixes a bug that caused excessive padding */
+#define DM_BITLK_EBOIV_SUPPORTED (1 << 20) /* EBOIV for BITLK supported */
+#define DM_BITLK_ELEPHANT_SUPPORTED (1 << 21) /* Elephant diffuser for BITLK supported */
+#define DM_VERITY_SIGNATURE_SUPPORTED (1 << 22) /* Verity option root_hash_sig_key_desc supported */
+#define DM_INTEGRITY_DISCARDS_SUPPORTED (1 << 23) /* dm-integrity discards/TRIM option is supported */
+
+typedef enum { DM_CRYPT = 0, DM_VERITY, DM_INTEGRITY, DM_LINEAR, DM_ERROR, DM_ZERO, DM_UNKNOWN } dm_target_type;
+enum tdirection { TARGET_SET = 1, TARGET_QUERY };
+
+int dm_flags(struct crypt_device *cd, dm_target_type target, uint32_t *flags);
 
 #define DM_ACTIVE_DEVICE       (1 << 0)
 #define DM_ACTIVE_UUID         (1 << 1)
+#define DM_ACTIVE_HOLDERS      (1 << 2)
 
-#define DM_ACTIVE_CRYPT_CIPHER (1 << 2)
-#define DM_ACTIVE_CRYPT_KEYSIZE        (1 << 3)
-#define DM_ACTIVE_CRYPT_KEY    (1 << 4)
+#define DM_ACTIVE_CRYPT_CIPHER (1 << 3)
+#define DM_ACTIVE_CRYPT_KEYSIZE        (1 << 4)
+#define DM_ACTIVE_CRYPT_KEY    (1 << 5)
 
-#define DM_ACTIVE_VERITY_ROOT_HASH     (1 << 5)
-#define DM_ACTIVE_VERITY_HASH_DEVICE   (1 << 6)
-#define DM_ACTIVE_VERITY_PARAMS                (1 << 7)
+#define DM_ACTIVE_VERITY_ROOT_HASH     (1 << 6)
+#define DM_ACTIVE_VERITY_HASH_DEVICE   (1 << 7)
+#define DM_ACTIVE_VERITY_PARAMS                (1 << 8)
 
-struct crypt_dm_active_device {
-       enum { DM_CRYPT = 0, DM_VERITY } target;
-       uint64_t size;          /* active device size */
-       uint32_t flags;         /* activation flags */
-       const char *uuid;
+#define DM_ACTIVE_INTEGRITY_PARAMS     (1 << 9)
+
+struct dm_target {
+       dm_target_type type;
+       enum tdirection direction;
+       uint64_t offset;
+       uint64_t size;
        struct device *data_device;
        union {
        struct {
                const char *cipher;
+               const char *integrity;
 
                /* Active key for device */
                struct volume_key *vk;
 
                /* struct crypt_active_device */
                uint64_t offset;        /* offset in sectors */
-               uint64_t iv_offset;     /* IV initilisation sector */
+               uint64_t iv_offset;     /* IV initialisation sector */
+               uint32_t tag_size;      /* additional on-disk tag size */
+               uint32_t sector_size;   /* encryption sector size */
        } crypt;
        struct {
                struct device *hash_device;
+               struct device *fec_device;
 
                const char *root_hash;
                uint32_t root_hash_size;
+               const char *root_hash_sig_key_desc;
 
                uint64_t hash_offset;   /* hash offset in blocks (not header) */
+               uint64_t hash_blocks;   /* size of hash device (in hash blocks) */
+               uint64_t fec_offset;    /* FEC offset in blocks (not header) */
+               uint64_t fec_blocks;    /* size of FEC device (in hash blocks) */
                struct crypt_params_verity *vp;
        } verity;
+       struct {
+               uint64_t journal_size;
+               uint32_t journal_watermark;
+               uint32_t journal_commit_time;
+               uint32_t interleave_sectors;
+               uint32_t tag_size;
+               uint64_t offset;        /* offset in sectors */
+               uint32_t sector_size;   /* integrity sector size */
+               uint32_t buffer_sectors;
+
+               const char *integrity;
+               /* Active key for device */
+               struct volume_key *vk;
+
+               const char *journal_integrity;
+               struct volume_key *journal_integrity_key;
+
+               const char *journal_crypt;
+               struct volume_key *journal_crypt_key;
+
+               struct device *meta_device;
+
+               bool fix_padding;
+       } integrity;
+       struct {
+               uint64_t offset;
+       } linear;
+       struct {
+       } zero;
        } u;
+
+       char *params;
+       struct dm_target *next;
 };
 
-void dm_backend_init(void);
-void dm_backend_exit(void);
+struct crypt_dm_active_device {
+       uint64_t size;          /* active device size */
+       uint32_t flags;         /* activation flags */
+       const char *uuid;
+
+       unsigned holders:1;     /* device holders detected (on query only) */
 
-int dm_remove_device(struct crypt_device *cd, const char *name,
-                    int force, uint64_t size);
+       struct dm_target segment;
+};
+
+static inline bool single_segment(const struct crypt_dm_active_device *dmd)
+{
+       return dmd && !dmd->segment.next;
+}
+
+void dm_backend_init(struct crypt_device *cd);
+void dm_backend_exit(struct crypt_device *cd);
+
+int dm_targets_allocate(struct dm_target *first, unsigned count);
+void dm_targets_free(struct crypt_device *cd, struct crypt_dm_active_device *dmd);
+
+int dm_crypt_target_set(struct dm_target *tgt, uint64_t seg_offset, uint64_t seg_size,
+       struct device *data_device, struct volume_key *vk, const char *cipher,
+       uint64_t iv_offset, uint64_t data_offset, const char *integrity,
+       uint32_t tag_size, uint32_t sector_size);
+int dm_verity_target_set(struct dm_target *tgt, uint64_t seg_offset, uint64_t seg_size,
+       struct device *data_device, struct device *hash_device, struct device *fec_device,
+       const char *root_hash, uint32_t root_hash_size, const char *root_hash_sig_key_desc,
+       uint64_t hash_offset_block, uint64_t hash_blocks, struct crypt_params_verity *vp);
+int dm_integrity_target_set(struct crypt_device *cd,
+       struct dm_target *tgt, uint64_t seg_offset, uint64_t seg_size,
+       struct device *meta_device,
+       struct device *data_device, uint64_t tag_size, uint64_t offset, uint32_t sector_size,
+       struct volume_key *vk,
+       struct volume_key *journal_crypt_key, struct volume_key *journal_mac_key,
+       const struct crypt_params_integrity *ip);
+int dm_linear_target_set(struct dm_target *tgt, uint64_t seg_offset, uint64_t seg_size,
+       struct device *data_device, uint64_t data_offset);
+int dm_zero_target_set(struct dm_target *tgt, uint64_t seg_offset, uint64_t seg_size);
+
+int dm_remove_device(struct crypt_device *cd, const char *name, uint32_t flags);
 int dm_status_device(struct crypt_device *cd, const char *name);
 int dm_status_suspended(struct crypt_device *cd, const char *name);
 int dm_status_verity_ok(struct crypt_device *cd, const char *name);
+int dm_status_integrity_failures(struct crypt_device *cd, const char *name, uint64_t *count);
 int dm_query_device(struct crypt_device *cd, const char *name,
                    uint32_t get_flags, struct crypt_dm_active_device *dmd);
+int dm_device_deps(struct crypt_device *cd, const char *name, const char *prefix,
+                  char **names, size_t names_length);
 int dm_create_device(struct crypt_device *cd, const char *name,
-                    const char *type, struct crypt_dm_active_device *dmd,
-                    int reload);
-int dm_suspend_and_wipe_key(struct crypt_device *cd, const char *name);
+                    const char *type, struct crypt_dm_active_device *dmd);
+int dm_reload_device(struct crypt_device *cd, const char *name,
+                    struct crypt_dm_active_device *dmd, uint32_t dmflags, unsigned resume);
+int dm_suspend_device(struct crypt_device *cd, const char *name, uint32_t dmflags);
+int dm_resume_device(struct crypt_device *cd, const char *name, uint32_t dmflags);
 int dm_resume_and_reinstate_key(struct crypt_device *cd, const char *name,
-                               size_t key_size, const char *key);
+                               const struct volume_key *vk);
+int dm_error_device(struct crypt_device *cd, const char *name);
+int dm_clear_device(struct crypt_device *cd, const char *name);
 
 const char *dm_get_dir(void);
 
+int lookup_dm_dev_by_uuid(struct crypt_device *cd, const char *uuid, const char *type);
+
 /* These are DM helpers used only by utils_devpath file */
-int dm_is_dm_device(int major, int minor);
+int dm_is_dm_device(int major);
 int dm_is_dm_kernel_name(const char *name);
 char *dm_device_path(const char *prefix, int major, int minor);
+char *dm_device_name(const char *path);
 
 #endif /* _UTILS_DM_H */