Blame SOURCES/0002-Add-support-for-creating-and-activating-integrity-de.patch

30e489
From 77e6a109043e87f88d2bd2b47d1cefce0eb9f5a9 Mon Sep 17 00:00:00 2001
3b3b27
From: Vojtech Trefny <vtrefny@redhat.com>
3b3b27
Date: Mon, 20 Sep 2021 16:38:16 +0200
3b3b27
Subject: [PATCH 1/3] Add support for creating and activating integrity devices
3b3b27
3b3b27
This adds support for create, open and close actions for standalone
3b3b27
integrity devices using cryptsetup.
3b3b27
---
30e489
 configure.ac                        |   2 +-
3b3b27
 src/lib/plugin_apis/crypto.api      | 157 +++++++++++++++++
3b3b27
 src/plugins/crypto.c                | 261 +++++++++++++++++++++++++++-
3b3b27
 src/plugins/crypto.h                |  41 +++++
3b3b27
 src/python/gi/overrides/BlockDev.py |  24 +++
30e489
 tests/crypto_test.py                |  96 +++++++++-
30e489
 6 files changed, 573 insertions(+), 8 deletions(-)
3b3b27
3b3b27
diff --git a/configure.ac b/configure.ac
30e489
index 79bd97d8..79bf8045 100644
3b3b27
--- a/configure.ac
3b3b27
+++ b/configure.ac
30e489
@@ -210,7 +210,7 @@ AS_IF([test "x$with_crypto" != "xno"],
3b3b27
       AS_IF([$PKG_CONFIG --atleast-version=2.0.3 libcryptsetup],
3b3b27
             [AC_DEFINE([LIBCRYPTSETUP_2])], [])
3b3b27
       AS_IF([$PKG_CONFIG --atleast-version=2.3.0 libcryptsetup],
3b3b27
-            [AC_DEFINE([LIBCRYPTSETUP_BITLK])], [])
3b3b27
+            [AC_DEFINE([LIBCRYPTSETUP_23])], [])
30e489
       AS_IF([$PKG_CONFIG --atleast-version=2.4.0 libcryptsetup],
30e489
             [AC_DEFINE([LIBCRYPTSETUP_24])], [])
3b3b27
       AS_IF([test "x$with_escrow" != "xno"],
3b3b27
diff --git a/src/lib/plugin_apis/crypto.api b/src/lib/plugin_apis/crypto.api
30e489
index ef0217fe..40e32c89 100644
3b3b27
--- a/src/lib/plugin_apis/crypto.api
3b3b27
+++ b/src/lib/plugin_apis/crypto.api
3b3b27
@@ -1,5 +1,6 @@
3b3b27
 #include <glib.h>
3b3b27
 #include <blockdev/utils.h>
3b3b27
+#include <libcryptsetup.h>
3b3b27
 
3b3b27
 #define BD_CRYPTO_LUKS_METADATA_SIZE G_GUINT64_CONSTANT (2097152ULL) // 2 MiB
3b3b27
 
3b3b27
@@ -245,6 +246,115 @@ GType bd_crypto_luks_extra_get_type () {
3b3b27
     return type;
3b3b27
 }
3b3b27
 
3b3b27
+#define BD_CRYPTO_TYPE_INTEGRITY_EXTRA (bd_crypto_integrity_extra_get_type ())
3b3b27
+GType bd_crypto_integrity_extra_get_type();
3b3b27
+
3b3b27
+/**
3b3b27
+ * BDCryptoIntegrityExtra:
3b3b27
+ * @sector_size: integrity sector size
3b3b27
+ * @journal_size: size of journal in bytes
3b3b27
+ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit
3b3b27
+ * @journal_commit_time: journal commit time (or bitmap flush time) in ms
3b3b27
+ * @interleave_sectors: number of interleave sectors (power of two)
3b3b27
+ * @tag_size: tag size per-sector in bytes
3b3b27
+ * @buffer_sectors: number of sectors in one buffer
3b3b27
+ */
3b3b27
+typedef struct BDCryptoIntegrityExtra {
3b3b27
+    guint32 sector_size;
3b3b27
+    guint64 journal_size;
3b3b27
+    guint journal_watermark;
3b3b27
+    guint journal_commit_time;
3b3b27
+    guint32 interleave_sectors;
3b3b27
+    guint32 tag_size;
3b3b27
+    guint32 buffer_sectors;
3b3b27
+} BDCryptoIntegrityExtra;
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_extra_copy: (skip)
3b3b27
+ * @extra: (allow-none): %BDCryptoIntegrityExtra to copy
3b3b27
+ *
3b3b27
+ * Creates a new copy of @extra.
3b3b27
+ */
3b3b27
+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra) {
3b3b27
+    if (extra == NULL)
3b3b27
+        return NULL;
3b3b27
+
3b3b27
+    BDCryptoIntegrityExtra *new_extra = g_new0 (BDCryptoIntegrityExtra, 1);
3b3b27
+
3b3b27
+    new_extra->sector_size = extra->sector_size;
3b3b27
+    new_extra->journal_size = extra->journal_size;
3b3b27
+    new_extra->journal_watermark = extra->journal_watermark;
3b3b27
+    new_extra->journal_commit_time = extra->journal_commit_time;
3b3b27
+    new_extra->interleave_sectors = extra->interleave_sectors;
3b3b27
+    new_extra->tag_size = extra->tag_size;
3b3b27
+    new_extra->buffer_sectors = extra->buffer_sectors;
3b3b27
+
3b3b27
+    return new_extra;
3b3b27
+}
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_extra_free: (skip)
3b3b27
+ * @extra: (allow-none): %BDCryptoIntegrityExtra to free
3b3b27
+ *
3b3b27
+ * Frees @extra.
3b3b27
+ */
3b3b27
+void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra) {
3b3b27
+    if (extra == NULL)
3b3b27
+        return;
3b3b27
+
3b3b27
+    g_free (extra);
3b3b27
+}
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_extra_new: (constructor)
3b3b27
+ * @sector_size: integrity sector size, 0 for default (512)
3b3b27
+ * @journal_size: size of journal in bytes
3b3b27
+ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit
3b3b27
+ * @journal_commit_time: journal commit time (or bitmap flush time) in ms
3b3b27
+ * @interleave_sectors: number of interleave sectors (power of two)
3b3b27
+ * @tag_size: tag size per-sector in bytes
3b3b27
+ * @buffer_sectors: number of sectors in one buffer
3b3b27
+ *
3b3b27
+ * Returns: (transfer full): a new Integrity extra argument
3b3b27
+ */
3b3b27
+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors) {
3b3b27
+    BDCryptoIntegrityExtra *ret = g_new0 (BDCryptoIntegrityExtra, 1);
3b3b27
+    ret->sector_size = sector_size;
3b3b27
+    ret->journal_size = journal_size;
3b3b27
+    ret->journal_watermark = journal_watermark;
3b3b27
+    ret->journal_commit_time = journal_commit_time;
3b3b27
+    ret->interleave_sectors = interleave_sectors;
3b3b27
+    ret->tag_size = tag_size;
3b3b27
+    ret->buffer_sectors = buffer_sectors;
3b3b27
+
3b3b27
+    return ret;
3b3b27
+}
3b3b27
+
3b3b27
+GType bd_crypto_integrity_extra_get_type () {
3b3b27
+    static GType type = 0;
3b3b27
+
3b3b27
+    if (G_UNLIKELY(type == 0)) {
3b3b27
+        type = g_boxed_type_register_static("BDCryptoIntegrityExtra",
3b3b27
+                                            (GBoxedCopyFunc) bd_crypto_integrity_extra_copy,
3b3b27
+                                            (GBoxedFreeFunc) bd_crypto_integrity_extra_free);
3b3b27
+    }
3b3b27
+
3b3b27
+    return type;
3b3b27
+}
3b3b27
+
3b3b27
+typedef enum {
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL         = CRYPT_ACTIVATE_NO_JOURNAL,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECOVERY           = CRYPT_ACTIVATE_RECOVERY,
3b3b27
+#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP  = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP,
3b3b27
+#endif
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE        = CRYPT_ACTIVATE_RECALCULATE,
3b3b27
+#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET  = CRYPT_ACTIVATE_RECALCULATE_RESET,
3b3b27
+#endif
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS     = CRYPT_ACTIVATE_ALLOW_DISCARDS,
3b3b27
+} BDCryptoIntegrityOpenFlags;
3b3b27
+
3b3b27
 #define BD_CRYPTO_TYPE_LUKS_INFO (bd_crypto_luks_info_get_type ())
3b3b27
 GType bd_crypto_luks_info_get_type();
3b3b27
 
3b3b27
@@ -857,6 +967,53 @@ BDCryptoLUKSInfo* bd_crypto_luks_info (const gchar *luks_device, GError **error)
3b3b27
  */
3b3b27
 BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **error);
3b3b27
 
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_format:
3b3b27
+ * @device: a device to format as integrity
3b3b27
+ * @algorithm: integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default
3b3b27
+ * @wipe: whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums
3b3b27
+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed
3b3b27
+ * @key_size: size the integrity key and @key_data
3b3b27
+ * @extra: (allow-none): extra arguments for integrity format creation
3b3b27
+ * @error: (out): place to store error (if any)
3b3b27
+ *
3b3b27
+ * Formats the given @device as integrity according to the other parameters given.
3b3b27
+ *
3b3b27
+ * Returns: whether the given @device was successfully formatted as integrity or not
3b3b27
+ * (the @error) contains the error in such cases)
3b3b27
+ *
3b3b27
+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_CREATE
3b3b27
+ */
3b3b27
+gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error);
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_open:
3b3b27
+ * @device: integrity device to open
3b3b27
+ * @name: name for the opened @device
3b3b27
+ * @algorithm: (allow-none): integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default
3b3b27
+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed
3b3b27
+ * @key_size: size the integrity key and @key_data
3b3b27
+ * @flags: flags for the integrity device activation
3b3b27
+ * @extra: (allow-none): extra arguments for integrity open
3b3b27
+ * @error: (out): place to store error (if any)
3b3b27
+ *
3b3b27
+ * Returns: whether the @device was successfully opened or not
3b3b27
+ *
3b3b27
+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE
3b3b27
+ */
3b3b27
+gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error);
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_close:
3b3b27
+ * @integrity_device: integrity device to close
3b3b27
+ * @error: (out): place to store error (if any)
3b3b27
+ *
3b3b27
+ * Returns: whether the given @integrity_device was successfully closed or not
3b3b27
+ *
3b3b27
+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE
3b3b27
+ */
3b3b27
+gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error);
3b3b27
+
3b3b27
 /**
3b3b27
  * bd_crypto_device_seems_encrypted:
3b3b27
  * @device: the queried device
3b3b27
diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c
30e489
index 51908140..8549cf23 100644
3b3b27
--- a/src/plugins/crypto.c
3b3b27
+++ b/src/plugins/crypto.c
3b3b27
@@ -50,6 +50,18 @@
3b3b27
 
3b3b27
 #define SECTOR_SIZE 512
3b3b27
 
3b3b27
+#define DEFAULT_LUKS_KEYSIZE_BITS 256
3b3b27
+#define DEFAULT_LUKS_CIPHER "aes-xts-plain64"
3b3b27
+
3b3b27
+#ifdef LIBCRYPTSETUP_23
3b3b27
+/* 0 for autodetect since 2.3.0 */
3b3b27
+#define DEFAULT_INTEGRITY_TAG_SIZE 0
3b3b27
+#else
3b3b27
+/* we need some sane default for older versions, users should specify tag size when using
3b3b27
+   other algorithms than the default crc32c */
3b3b27
+#define DEFAULT_INTEGRITY_TAG_SIZE 4
3b3b27
+#endif
3b3b27
+
3b3b27
 #define UNUSED __attribute__((unused))
3b3b27
 
3b3b27
 /**
3b3b27
@@ -146,6 +158,43 @@ BDCryptoLUKSExtra* bd_crypto_luks_extra_new (guint64 data_alignment, const gchar
3b3b27
     return ret;
3b3b27
 }
3b3b27
 
3b3b27
+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors) {
3b3b27
+    BDCryptoIntegrityExtra *ret = g_new0 (BDCryptoIntegrityExtra, 1);
3b3b27
+    ret->sector_size = sector_size;
3b3b27
+    ret->journal_size = journal_size;
3b3b27
+    ret->journal_watermark = journal_watermark;
3b3b27
+    ret->journal_commit_time = journal_commit_time;
3b3b27
+    ret->interleave_sectors = interleave_sectors;
3b3b27
+    ret->tag_size = tag_size;
3b3b27
+    ret->buffer_sectors = buffer_sectors;
3b3b27
+
3b3b27
+    return ret;
3b3b27
+}
3b3b27
+
3b3b27
+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra) {
3b3b27
+    if (extra == NULL)
3b3b27
+        return NULL;
3b3b27
+
3b3b27
+    BDCryptoIntegrityExtra *new_extra = g_new0 (BDCryptoIntegrityExtra, 1);
3b3b27
+
3b3b27
+    new_extra->sector_size = extra->sector_size;
3b3b27
+    new_extra->journal_size = extra->journal_size;
3b3b27
+    new_extra->journal_watermark = extra->journal_watermark;
3b3b27
+    new_extra->journal_commit_time = extra->journal_commit_time;
3b3b27
+    new_extra->interleave_sectors = extra->interleave_sectors;
3b3b27
+    new_extra->tag_size = extra->tag_size;
3b3b27
+    new_extra->buffer_sectors = extra->buffer_sectors;
3b3b27
+
3b3b27
+    return new_extra;
3b3b27
+}
3b3b27
+
3b3b27
+void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra) {
3b3b27
+    if (extra == NULL)
3b3b27
+        return;
3b3b27
+
3b3b27
+    g_free (extra);
3b3b27
+}
3b3b27
+
3b3b27
 void bd_crypto_luks_info_free (BDCryptoLUKSInfo *info) {
3b3b27
     if (info == NULL)
3b3b27
         return;
3b3b27
@@ -346,15 +395,15 @@ gboolean bd_crypto_is_tech_avail (BDCryptoTech tech, guint64 mode, GError **erro
3b3b27
                          "Integrity technology requires libcryptsetup >= 2.0");
3b3b27
             return FALSE;
3b3b27
 #endif
3b3b27
-            ret = mode & (BD_CRYPTO_TECH_MODE_QUERY);
3b3b27
+            ret = mode & (BD_CRYPTO_TECH_MODE_CREATE|BD_CRYPTO_TECH_MODE_OPEN_CLOSE|BD_CRYPTO_TECH_MODE_QUERY);
3b3b27
             if (ret != mode) {
3b3b27
                 g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL,
3b3b27
-                             "Only 'query' supported for Integrity");
3b3b27
+                             "Only 'create', 'open' and 'query' supported for Integrity");
3b3b27
                 return FALSE;
3b3b27
             } else
3b3b27
                 return TRUE;
3b3b27
         case BD_CRYPTO_TECH_BITLK:
3b3b27
-#ifndef LIBCRYPTSETUP_BITLK
3b3b27
+#ifndef LIBCRYPTSETUP_23
3b3b27
             g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL,
3b3b27
                          "BITLK technology requires libcryptsetup >= 2.3.0");
3b3b27
             return FALSE;
3b3b27
@@ -2035,6 +2084,208 @@ BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **e
3b3b27
 }
3b3b27
 #endif
3b3b27
 
3b3b27
+static int _wipe_progress (guint64 size, guint64 offset, void *usrptr) {
3b3b27
+    /* "convert" the progress from 0-100 to 50-100 because wipe starts at 50 in bd_crypto_integrity_format */
3b3b27
+    gdouble progress = 50 + (((gdouble) offset / size) * 100) / 2;
3b3b27
+    bd_utils_report_progress (*(guint64 *) usrptr, progress, "Integrity device wipe in progress");
3b3b27
+
3b3b27
+    return 0;
3b3b27
+}
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_format:
3b3b27
+ * @device: a device to format as integrity
3b3b27
+ * @algorithm: integrity algorithm specification (e.g. "crc32c" or "sha256")
3b3b27
+ * @wipe: whether to wipe the device after format; a device that is not initially wiped will contain invalid checksums
3b3b27
+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed
3b3b27
+ * @key_size: size the integrity key and @key_data
3b3b27
+ * @extra: (allow-none): extra arguments for integrity format creation
3b3b27
+ * @error: (out): place to store error (if any)
3b3b27
+ *
3b3b27
+ * Formats the given @device as integrity according to the other parameters given.
3b3b27
+ *
3b3b27
+ * Returns: whether the given @device was successfully formatted as integrity or not
3b3b27
+ * (the @error) contains the error in such cases)
3b3b27
+ *
3b3b27
+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_CREATE
3b3b27
+ */
3b3b27
+gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error) {
3b3b27
+    struct crypt_device *cd = NULL;
3b3b27
+    gint ret;
3b3b27
+    guint64 progress_id = 0;
3b3b27
+    gchar *msg = NULL;
3b3b27
+    struct crypt_params_integrity params = ZERO_INIT;
3b3b27
+    g_autofree gchar *tmp_name = NULL;
3b3b27
+    g_autofree gchar *tmp_path = NULL;
3b3b27
+    g_autofree gchar *dev_name = NULL;
3b3b27
+
3b3b27
+    msg = g_strdup_printf ("Started formatting '%s' as integrity device", device);
3b3b27
+    progress_id = bd_utils_report_started (msg);
3b3b27
+    g_free (msg);
3b3b27
+
3b3b27
+    ret = crypt_init (&cd, device);
3b3b27
+    if (ret != 0) {
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
+                     "Failed to initialize device: %s", strerror_l (-ret, c_locale));
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+    }
3b3b27
+
3b3b27
+    if (extra) {
3b3b27
+        params.sector_size = extra->sector_size;
3b3b27
+        params.journal_size = extra->journal_size;
3b3b27
+        params.journal_watermark = extra->journal_watermark;
3b3b27
+        params.journal_commit_time = extra->journal_commit_time;
3b3b27
+        params.interleave_sectors = extra->interleave_sectors;
3b3b27
+        params.tag_size = extra->tag_size;
3b3b27
+        params.buffer_sectors = extra->buffer_sectors;
3b3b27
+    }
3b3b27
+
3b3b27
+    params.integrity_key_size = key_size;
3b3b27
+    params.integrity = algorithm;
3b3b27
+    params.tag_size = params.tag_size ? params.tag_size : DEFAULT_INTEGRITY_TAG_SIZE;
3b3b27
+
3b3b27
+    ret = crypt_format (cd, CRYPT_INTEGRITY, NULL, NULL, NULL, NULL, 0, &params);
3b3b27
+    if (ret != 0) {
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_FORMAT_FAILED,
3b3b27
+                     "Failed to format device: %s", strerror_l (-ret, c_locale));
3b3b27
+        crypt_free (cd);
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+    }
3b3b27
+
3b3b27
+    if (wipe) {
3b3b27
+        bd_utils_report_progress (progress_id, 50, "Format created");
3b3b27
+
3b3b27
+        dev_name = g_path_get_basename (device);
3b3b27
+        tmp_name = g_strdup_printf ("bd-temp-integrity-%s-%d", dev_name, g_random_int ());
3b3b27
+        tmp_path = g_strdup_printf ("%s/%s", crypt_get_dir (), tmp_name);
3b3b27
+
3b3b27
+        ret = crypt_activate_by_volume_key (cd, tmp_name, (const char *) key_data, key_size,
3b3b27
+                                            CRYPT_ACTIVATE_PRIVATE | CRYPT_ACTIVATE_NO_JOURNAL);
3b3b27
+        if (ret != 0) {
3b3b27
+            g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
+                         "Failed to activate the newly created integrity device for wiping: %s",
3b3b27
+                         strerror_l (-ret, c_locale));
3b3b27
+            crypt_free (cd);
3b3b27
+            bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+            return FALSE;
3b3b27
+        }
3b3b27
+
3b3b27
+        bd_utils_report_progress (progress_id, 50, "Starting to wipe the newly created integrity device");
3b3b27
+        ret = crypt_wipe (cd, tmp_path, CRYPT_WIPE_ZERO, 0, 0, 1048576,
3b3b27
+                          0, &_wipe_progress, &progress_id);
3b3b27
+        bd_utils_report_progress (progress_id, 100, "Wipe finished");
3b3b27
+        if (ret != 0) {
3b3b27
+            g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
+                         "Failed to wipe the newly created integrity device: %s",
3b3b27
+                         strerror_l (-ret, c_locale));
3b3b27
+
3b3b27
+            ret = crypt_deactivate (cd, tmp_name);
3b3b27
+            if (ret != 0)
3b3b27
+                g_warning ("Failed to deactivate temporary device %s", tmp_name);
3b3b27
+
3b3b27
+            crypt_free (cd);
3b3b27
+            bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+            return FALSE;
3b3b27
+        }
3b3b27
+
3b3b27
+        ret = crypt_deactivate (cd, tmp_name);
3b3b27
+        if (ret != 0)
3b3b27
+            g_warning ("Failed to deactivate temporary device %s", tmp_name);
3b3b27
+
3b3b27
+    } else
3b3b27
+        bd_utils_report_finished (progress_id, "Completed");
3b3b27
+
3b3b27
+    crypt_free (cd);
3b3b27
+
3b3b27
+    return TRUE;
3b3b27
+}
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_open:
3b3b27
+ * @device: integrity device to open
3b3b27
+ * @name: name for the opened @device
3b3b27
+ * @algorithm: (allow-none): integrity algorithm specification (e.g. "crc32c" or "sha256") or %NULL to use the default
3b3b27
+ * @key_data: (allow-none) (array length=key_size): integrity key or %NULL if not needed
3b3b27
+ * @key_size: size the integrity key and @key_data
3b3b27
+ * @flags: flags for the integrity device activation
3b3b27
+ * @extra: (allow-none): extra arguments for integrity open
3b3b27
+ * @error: (out): place to store error (if any)
3b3b27
+ *
3b3b27
+ * Returns: whether the @device was successfully opened or not
3b3b27
+ *
3b3b27
+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE
3b3b27
+ */
3b3b27
+gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error) {
3b3b27
+    struct crypt_device *cd = NULL;
3b3b27
+    gint ret = 0;
3b3b27
+    guint64 progress_id = 0;
3b3b27
+    gchar *msg = NULL;
3b3b27
+    struct crypt_params_integrity params = ZERO_INIT;
3b3b27
+
3b3b27
+    params.integrity = algorithm;
3b3b27
+    params.integrity_key_size = key_size;
3b3b27
+
3b3b27
+    if (extra) {
3b3b27
+        params.sector_size = extra->sector_size;
3b3b27
+        params.journal_size = extra->journal_size;
3b3b27
+        params.journal_watermark = extra->journal_watermark;
3b3b27
+        params.journal_commit_time = extra->journal_commit_time;
3b3b27
+        params.interleave_sectors = extra->interleave_sectors;
3b3b27
+        params.tag_size = extra->tag_size;
3b3b27
+        params.buffer_sectors = extra->buffer_sectors;
3b3b27
+    }
3b3b27
+
3b3b27
+    msg = g_strdup_printf ("Started opening '%s' integrity device", device);
3b3b27
+    progress_id = bd_utils_report_started (msg);
3b3b27
+    g_free (msg);
3b3b27
+
3b3b27
+    ret = crypt_init (&cd, device);
3b3b27
+    if (ret != 0) {
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
+                     "Failed to initialize device: %s", strerror_l (-ret, c_locale));
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+    }
3b3b27
+
3b3b27
+    ret = crypt_load (cd, CRYPT_INTEGRITY, &params);
3b3b27
+    if (ret != 0) {
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
+                     "Failed to load device's parameters: %s", strerror_l (-ret, c_locale));
3b3b27
+        crypt_free (cd);
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+    }
3b3b27
+
3b3b27
+    ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, flags);
3b3b27
+    if (ret < 0) {
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
+                     "Failed to activate device: %s", strerror_l (-ret, c_locale));
3b3b27
+
3b3b27
+        crypt_free (cd);
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+    }
3b3b27
+
3b3b27
+    crypt_free (cd);
3b3b27
+    bd_utils_report_finished (progress_id, "Completed");
3b3b27
+    return TRUE;
3b3b27
+}
3b3b27
+
3b3b27
+/**
3b3b27
+ * bd_crypto_integrity_close:
3b3b27
+ * @integrity_device: integrity device to close
3b3b27
+ * @error: (out): place to store error (if any)
3b3b27
+ *
3b3b27
+ * Returns: whether the given @integrity_device was successfully closed or not
3b3b27
+ *
3b3b27
+ * Tech category: %BD_CRYPTO_TECH_INTEGRITY-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE
3b3b27
+ */
3b3b27
+gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error) {
3b3b27
+    return _crypto_close (integrity_device, "integrity", error);
3b3b27
+}
3b3b27
+
3b3b27
 /**
3b3b27
  * bd_crypto_device_seems_encrypted:
3b3b27
  * @device: the queried device
30e489
@@ -2471,7 +2722,7 @@ gboolean bd_crypto_escrow_device (const gchar *device, const gchar *passphrase,
3b3b27
  *
3b3b27
  * Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE
3b3b27
  */
3b3b27
-#ifndef LIBCRYPTSETUP_BITLK
3b3b27
+#ifndef LIBCRYPTSETUP_23
3b3b27
 gboolean bd_crypto_bitlk_open (const gchar *device UNUSED, const gchar *name UNUSED, const guint8* pass_data UNUSED, gsize data_len UNUSED, gboolean read_only UNUSED, GError **error) {
3b3b27
     /* this will return FALSE and set error, because BITLK technology is not available */
3b3b27
     return bd_crypto_is_tech_avail (BD_CRYPTO_TECH_BITLK, BD_CRYPTO_TECH_MODE_OPEN_CLOSE, error);
30e489
@@ -2541,7 +2792,7 @@ gboolean bd_crypto_bitlk_open (const gchar *device, const gchar *name, const gui
3b3b27
  *
3b3b27
  * Tech category: %BD_CRYPTO_TECH_BITLK-%BD_CRYPTO_TECH_MODE_OPEN_CLOSE
3b3b27
  */
3b3b27
-#ifndef LIBCRYPTSETUP_BITLK
3b3b27
+#ifndef LIBCRYPTSETUP_23
3b3b27
 gboolean bd_crypto_bitlk_close (const gchar *bitlk_device UNUSED, GError **error) {
3b3b27
     /* this will return FALSE and set error, because BITLK technology is not available */
3b3b27
     return bd_crypto_is_tech_avail (BD_CRYPTO_TECH_BITLK, BD_CRYPTO_TECH_MODE_OPEN_CLOSE, error);
3b3b27
diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h
30e489
index 1c8f47ea..6c1d40dd 100644
3b3b27
--- a/src/plugins/crypto.h
3b3b27
+++ b/src/plugins/crypto.h
30e489
@@ -122,6 +122,43 @@ void bd_crypto_luks_extra_free (BDCryptoLUKSExtra *extra);
3b3b27
 BDCryptoLUKSExtra* bd_crypto_luks_extra_copy (BDCryptoLUKSExtra *extra);
3b3b27
 BDCryptoLUKSExtra* bd_crypto_luks_extra_new (guint64 data_alignment, const gchar *data_device, const gchar *integrity, guint64 sector_size, const gchar *label, const gchar *subsystem, BDCryptoLUKSPBKDF *pbkdf);
3b3b27
 
3b3b27
+/**
3b3b27
+ * BDCryptoIntegrityExtra:
3b3b27
+ * @sector_size: integrity sector size
3b3b27
+ * @journal_size: size of journal in bytes
3b3b27
+ * @journal_watermark: journal flush watermark in percents; in bitmap mode sectors-per-bit
3b3b27
+ * @journal_commit_time: journal commit time (or bitmap flush time) in ms
3b3b27
+ * @interleave_sectors: number of interleave sectors (power of two)
3b3b27
+ * @tag_size: tag size per-sector in bytes
3b3b27
+ * @buffer_sectors: number of sectors in one buffer
3b3b27
+ */
3b3b27
+typedef struct BDCryptoIntegrityExtra {
3b3b27
+    guint32 sector_size;
3b3b27
+    guint64 journal_size;
3b3b27
+    guint journal_watermark;
3b3b27
+    guint journal_commit_time;
3b3b27
+    guint32 interleave_sectors;
3b3b27
+    guint32 tag_size;
3b3b27
+    guint32 buffer_sectors;
3b3b27
+} BDCryptoIntegrityExtra;
3b3b27
+
3b3b27
+void bd_crypto_integrity_extra_free (BDCryptoIntegrityExtra *extra);
3b3b27
+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *extra);
3b3b27
+BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors);
3b3b27
+
3b3b27
+typedef enum {
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL         = CRYPT_ACTIVATE_NO_JOURNAL,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECOVERY           = CRYPT_ACTIVATE_RECOVERY,
3b3b27
+#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP  = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP,
3b3b27
+#endif
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE        = CRYPT_ACTIVATE_RECALCULATE,
3b3b27
+#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET  = CRYPT_ACTIVATE_RECALCULATE_RESET,
3b3b27
+#endif
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS     = CRYPT_ACTIVATE_ALLOW_DISCARDS,
3b3b27
+} BDCryptoIntegrityOpenFlags;
3b3b27
+
3b3b27
 /**
3b3b27
  * BDCryptoLUKSInfo:
3b3b27
  * @version: LUKS version
30e489
@@ -215,6 +252,10 @@ gboolean bd_crypto_luks_header_restore (const gchar *device, const gchar *backup
3b3b27
 BDCryptoLUKSInfo* bd_crypto_luks_info (const gchar *luks_device, GError **error);
3b3b27
 BDCryptoIntegrityInfo* bd_crypto_integrity_info (const gchar *device, GError **error);
3b3b27
 
3b3b27
+gboolean bd_crypto_integrity_format (const gchar *device, const gchar *algorithm, gboolean wipe, const guint8* key_data, gsize key_size, BDCryptoIntegrityExtra *extra, GError **error);
3b3b27
+gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const gchar *algorithm, const guint8* key_data, gsize key_size, BDCryptoIntegrityOpenFlags flags, BDCryptoIntegrityExtra *extra, GError **error);
3b3b27
+gboolean bd_crypto_integrity_close (const gchar *integrity_device, GError **error);
3b3b27
+
3b3b27
 gboolean bd_crypto_device_seems_encrypted (const gchar *device, GError **error);
3b3b27
 gboolean bd_crypto_tc_open (const gchar *device, const gchar *name, const guint8* pass_data, gsize data_len, gboolean read_only, GError **error);
3b3b27
 gboolean bd_crypto_tc_open_full (const gchar *device, const gchar *name, const guint8* pass_data, gsize data_len, const gchar **keyfiles, gboolean hidden, gboolean system, gboolean veracrypt, guint32 veracrypt_pim, gboolean read_only, GError **error);
3b3b27
diff --git a/src/python/gi/overrides/BlockDev.py b/src/python/gi/overrides/BlockDev.py
30e489
index 8574ab04..8bd03cf8 100644
3b3b27
--- a/src/python/gi/overrides/BlockDev.py
3b3b27
+++ b/src/python/gi/overrides/BlockDev.py
3b3b27
@@ -276,6 +276,30 @@ def crypto_bitlk_open(device, name, passphrase, read_only=False):
3b3b27
 __all__.append("crypto_bitlk_open")
3b3b27
 
3b3b27
 
3b3b27
+class CryptoIntegrityExtra(BlockDev.CryptoIntegrityExtra):
3b3b27
+    def __new__(cls, sector_size=0, journal_size=0, journal_watermark=0, journal_commit_time=0, interleave_sectors=0, tag_size=0, buffer_sectors=0):
3b3b27
+        ret = BlockDev.CryptoIntegrityExtra.new(sector_size, journal_size, journal_watermark, journal_commit_time, interleave_sectors, tag_size, buffer_sectors)
3b3b27
+        ret.__class__ = cls
3b3b27
+        return ret
3b3b27
+    def __init__(self, *args, **kwargs):   # pylint: disable=unused-argument
3b3b27
+        super(CryptoIntegrityExtra, self).__init__()  #pylint: disable=bad-super-call
3b3b27
+CryptoIntegrityExtra = override(CryptoIntegrityExtra)
3b3b27
+__all__.append("CryptoIntegrityExtra")
3b3b27
+
3b3b27
+
3b3b27
+_crypto_integrity_format = BlockDev.crypto_integrity_format
3b3b27
+@override(BlockDev.crypto_integrity_format)
3b3b27
+def crypto_integrity_format(device, algorithm=None, wipe=True, key_data=None, extra=None):
3b3b27
+    return _crypto_integrity_format(device, algorithm, wipe, key_data, extra)
3b3b27
+__all__.append("crypto_integrity_format")
3b3b27
+
3b3b27
+_crypto_integrity_open = BlockDev.crypto_integrity_open
3b3b27
+@override(BlockDev.crypto_integrity_open)
3b3b27
+def crypto_integrity_open(device, name, algorithm, key_data=None, flags=0, extra=None):
3b3b27
+    return _crypto_integrity_open(device, name, algorithm, key_data, flags, extra)
3b3b27
+__all__.append("crypto_integrity_open")
3b3b27
+
3b3b27
+
3b3b27
 _dm_create_linear = BlockDev.dm_create_linear
3b3b27
 @override(BlockDev.dm_create_linear)
3b3b27
 def dm_create_linear(map_name, device, length, uuid=None):
3b3b27
diff --git a/tests/crypto_test.py b/tests/crypto_test.py
30e489
index 5e02c00d..a8fc8579 100644
3b3b27
--- a/tests/crypto_test.py
3b3b27
+++ b/tests/crypto_test.py
3b3b27
@@ -2,6 +2,7 @@ import unittest
3b3b27
 import os
3b3b27
 import tempfile
3b3b27
 import overrides_hack
3b3b27
+import secrets
3b3b27
 import shutil
3b3b27
 import subprocess
3b3b27
 import six
30e489
@@ -34,6 +35,8 @@ class CryptoTestCase(unittest.TestCase):
3b3b27
 
3b3b27
     requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "loop"))
3b3b27
 
3b3b27
+    _dm_name = "libblockdevTestLUKS"
3b3b27
+
3b3b27
     @classmethod
3b3b27
     def setUpClass(cls):
3b3b27
         unittest.TestCase.setUpClass()
30e489
@@ -64,7 +67,7 @@ class CryptoTestCase(unittest.TestCase):
3b3b27
 
3b3b27
     def _clean_up(self):
3b3b27
         try:
3b3b27
-            BlockDev.crypto_luks_close("libblockdevTestLUKS")
3b3b27
+            BlockDev.crypto_luks_close(self._dm_name)
3b3b27
         except:
3b3b27
             pass
3b3b27
 
30e489
@@ -1029,7 +1032,7 @@ class CryptoTestLuksSectorSize(CryptoTestCase):
3b3b27
         self.assertTrue(succ)
3b3b27
 
30e489
 
3b3b27
-class CryptoTestIntegrity(CryptoTestCase):
3b3b27
+class CryptoTestLUKS2Integrity(CryptoTestCase):
3b3b27
     @tag_test(TestTags.SLOW)
3b3b27
     @unittest.skipUnless(HAVE_LUKS2, "LUKS 2 not supported")
3b3b27
     def test_luks2_integrity(self):
30e489
@@ -1216,3 +1219,92 @@ class CryptoTestBitlk(CryptoTestCase):
3b3b27
         succ = BlockDev.crypto_bitlk_close("libblockdevTestBitlk")
3b3b27
         self.assertTrue(succ)
3b3b27
         self.assertFalse(os.path.exists("/dev/mapper/libblockdevTestBitlk"))
3b3b27
+
3b3b27
+
3b3b27
+class CryptoTestIntegrity(CryptoTestCase):
3b3b27
+
3b3b27
+    _dm_name = "libblockdevTestIntegrity"
3b3b27
+
3b3b27
+    @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported")
3b3b27
+    def test_integrity(self):
3b3b27
+        # basic format+open+close test
3b3b27
+        succ = BlockDev.crypto_integrity_format(self.loop_dev, "sha256", False)
3b3b27
+        self.assertTrue(succ)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "sha256")
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        info = BlockDev.crypto_integrity_info(self._dm_name)
3b3b27
+        self.assertEqual(info.algorithm, "sha256")
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_close(self._dm_name)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        # same now with a keyed algorithm
3b3b27
+        key = list(secrets.token_bytes(64))
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_format(self.loop_dev, "hmac(sha256)", False, key)
3b3b27
+        self.assertTrue(succ)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "hmac(sha256)", key)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        info = BlockDev.crypto_integrity_info(self._dm_name)
3b3b27
+        self.assertEqual(info.algorithm, "hmac(sha256)")
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_close(self._dm_name)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        # same with some custom parameters
3b3b27
+        extra = BlockDev.CryptoIntegrityExtra(sector_size=4096, interleave_sectors=65536)
3b3b27
+        succ = BlockDev.crypto_integrity_format(self.loop_dev, "crc32c", wipe=False, extra=extra)
3b3b27
+        self.assertTrue(succ)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "crc32c")
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        info = BlockDev.crypto_integrity_info(self._dm_name)
3b3b27
+        self.assertEqual(info.algorithm, "crc32c")
3b3b27
+        self.assertEqual(info.sector_size, 4096)
3b3b27
+        self.assertEqual(info.interleave_sectors, 65536)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_close(self._dm_name)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+    @tag_test(TestTags.SLOW)
3b3b27
+    @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported")
3b3b27
+    def test_integrity_wipe(self):
3b3b27
+        # also check that wipe progress reporting works
3b3b27
+        progress_log = []
3b3b27
+
3b3b27
+        def _my_progress_func(_task, _status, completion, msg):
3b3b27
+            progress_log.append((completion, msg))
3b3b27
+
3b3b27
+        succ = BlockDev.utils_init_prog_reporting(_my_progress_func)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.addCleanup(BlockDev.utils_init_prog_reporting, None)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_format(self.loop_dev, "sha256", True)
3b3b27
+        self.assertTrue(succ)
3b3b27
+
3b3b27
+        # at least one message "Integrity device wipe in progress" should be logged
3b3b27
+        self.assertTrue(any(prog[1] == "Integrity device wipe in progress" for prog in progress_log))
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "sha256")
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        # check the devices was wiped and the checksums recalculated
3b3b27
+        # (mkfs reads some blocks first so without checksums it would fail)
3b3b27
+        ret, _out, err = run_command("mkfs.ext2 /dev/mapper/%s " % self._dm_name)
3b3b27
+        self.assertEqual(ret, 0, msg="Failed to create ext2 filesystem on integrity: %s" % err)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_close(self._dm_name)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
-- 
30e489
2.37.3
3b3b27
3b3b27
30e489
From ad4ac36520ec96af2a7b043189bbdf18cc3cffb9 Mon Sep 17 00:00:00 2001
3b3b27
From: Vojtech Trefny <vtrefny@redhat.com>
3b3b27
Date: Thu, 30 Sep 2021 16:01:40 +0200
3b3b27
Subject: [PATCH 2/3] Create smaller test images for integrity tests
3b3b27
3b3b27
We are going to overwrite the entire device in test_integrity_wipe
3b3b27
so we need to make sure the sparse actually fits to /tmp which
3b3b27
can be smaller than 1 GiB.
3b3b27
---
3b3b27
 tests/crypto_test.py | 6 ++++--
3b3b27
 1 file changed, 4 insertions(+), 2 deletions(-)
3b3b27
3b3b27
diff --git a/tests/crypto_test.py b/tests/crypto_test.py
30e489
index a8fc8579..9758bf81 100644
3b3b27
--- a/tests/crypto_test.py
3b3b27
+++ b/tests/crypto_test.py
30e489
@@ -36,6 +36,7 @@ class CryptoTestCase(unittest.TestCase):
3b3b27
     requested_plugins = BlockDev.plugin_specs_from_names(("crypto", "loop"))
3b3b27
 
3b3b27
     _dm_name = "libblockdevTestLUKS"
3b3b27
+    _sparse_size = 1024**3
3b3b27
 
3b3b27
     @classmethod
3b3b27
     def setUpClass(cls):
30e489
@@ -49,8 +50,8 @@ class CryptoTestCase(unittest.TestCase):
3b3b27
 
3b3b27
     def setUp(self):
3b3b27
         self.addCleanup(self._clean_up)
3b3b27
-        self.dev_file = create_sparse_tempfile("crypto_test", 1024**3)
3b3b27
-        self.dev_file2 = create_sparse_tempfile("crypto_test2", 1024**3)
3b3b27
+        self.dev_file = create_sparse_tempfile("crypto_test", self._sparse_size)
3b3b27
+        self.dev_file2 = create_sparse_tempfile("crypto_test2", self._sparse_size)
3b3b27
         try:
3b3b27
             self.loop_dev = create_lio_device(self.dev_file)
3b3b27
         except RuntimeError as e:
30e489
@@ -1224,6 +1225,7 @@ class CryptoTestBitlk(CryptoTestCase):
3b3b27
 class CryptoTestIntegrity(CryptoTestCase):
3b3b27
 
3b3b27
     _dm_name = "libblockdevTestIntegrity"
3b3b27
+    _sparse_size = 100 * 1024**2
3b3b27
 
3b3b27
     @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported")
3b3b27
     def test_integrity(self):
3b3b27
-- 
30e489
2.37.3
3b3b27
3b3b27
30e489
From 048a803be5186b30c0f0a7e67020486990ba6b81 Mon Sep 17 00:00:00 2001
3b3b27
From: Vojtech Trefny <vtrefny@redhat.com>
3b3b27
Date: Wed, 20 Oct 2021 10:27:41 +0200
3b3b27
Subject: [PATCH 3/3] crypto: Do not use libcryptsetup flags directly in
3b3b27
 crypto.h
3b3b27
3b3b27
We can "translate" our flags in the implementation instead to
3b3b27
avoid including libcryptsetup.h in our header and API files.
3b3b27
---
3b3b27
 src/lib/plugin_apis/crypto.api | 17 ++++++-----------
3b3b27
 src/plugins/crypto.c           | 34 +++++++++++++++++++++++++++++++++-
3b3b27
 src/plugins/crypto.h           | 16 ++++++----------
3b3b27
 tests/crypto_test.py           | 14 ++++++++++++++
3b3b27
 4 files changed, 59 insertions(+), 22 deletions(-)
3b3b27
3b3b27
diff --git a/src/lib/plugin_apis/crypto.api b/src/lib/plugin_apis/crypto.api
30e489
index 40e32c89..cf87979d 100644
3b3b27
--- a/src/lib/plugin_apis/crypto.api
3b3b27
+++ b/src/lib/plugin_apis/crypto.api
3b3b27
@@ -1,6 +1,5 @@
3b3b27
 #include <glib.h>
3b3b27
 #include <blockdev/utils.h>
3b3b27
-#include <libcryptsetup.h>
3b3b27
 
3b3b27
 #define BD_CRYPTO_LUKS_METADATA_SIZE G_GUINT64_CONSTANT (2097152ULL) // 2 MiB
3b3b27
 
3b3b27
@@ -343,16 +342,12 @@ GType bd_crypto_integrity_extra_get_type () {
3b3b27
 }
3b3b27
 
3b3b27
 typedef enum {
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL         = CRYPT_ACTIVATE_NO_JOURNAL,
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_RECOVERY           = CRYPT_ACTIVATE_RECOVERY,
3b3b27
-#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP  = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP,
3b3b27
-#endif
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE        = CRYPT_ACTIVATE_RECALCULATE,
3b3b27
-#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET  = CRYPT_ACTIVATE_RECALCULATE_RESET,
3b3b27
-#endif
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS     = CRYPT_ACTIVATE_ALLOW_DISCARDS,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL         = 1 << 0,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECOVERY           = 1 << 1,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP  = 1 << 2,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE        = 1 << 3,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET  = 1 << 4,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS     = 1 << 5,
3b3b27
 } BDCryptoIntegrityOpenFlags;
3b3b27
 
3b3b27
 #define BD_CRYPTO_TYPE_LUKS_INFO (bd_crypto_luks_info_get_type ())
3b3b27
diff --git a/src/plugins/crypto.c b/src/plugins/crypto.c
30e489
index 8549cf23..35c38410 100644
3b3b27
--- a/src/plugins/crypto.c
3b3b27
+++ b/src/plugins/crypto.c
3b3b27
@@ -2223,6 +2223,7 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const
3b3b27
     guint64 progress_id = 0;
3b3b27
     gchar *msg = NULL;
3b3b27
     struct crypt_params_integrity params = ZERO_INIT;
3b3b27
+    guint32 activate_flags = 0;
3b3b27
 
3b3b27
     params.integrity = algorithm;
3b3b27
     params.integrity_key_size = key_size;
3b3b27
@@ -2237,6 +2238,37 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const
3b3b27
         params.buffer_sectors = extra->buffer_sectors;
3b3b27
     }
3b3b27
 
3b3b27
+
3b3b27
+    if (flags & BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL)
3b3b27
+        activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL;
3b3b27
+    if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECOVERY)
3b3b27
+        activate_flags |= CRYPT_ACTIVATE_RECOVERY;
3b3b27
+    if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE)
3b3b27
+        activate_flags |= CRYPT_ACTIVATE_RECALCULATE;
3b3b27
+    if (flags & BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS)
3b3b27
+        activate_flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS;
3b3b27
+    if (flags & BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP) {
3b3b27
+#ifndef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL,
3b3b27
+                     "Cannot activate %s with bitmap, installed version of cryptsetup doesn't support this option.", device);
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+#else
3b3b27
+        activate_flags |= CRYPT_ACTIVATE_NO_JOURNAL_BITMAP;
3b3b27
+#endif
3b3b27
+    }
3b3b27
+
3b3b27
+    if (flags & BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET) {
3b3b27
+#ifndef CRYPT_ACTIVATE_RECALCULATE_RESET
3b3b27
+        g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_TECH_UNAVAIL,
3b3b27
+                     "Cannot reset integrity recalculation while activating %s, installed version of cryptsetup doesn't support this option.", device);
3b3b27
+        bd_utils_report_finished (progress_id, (*error)->message);
3b3b27
+        return FALSE;
3b3b27
+#else
3b3b27
+        activate_flags |= CRYPT_ACTIVATE_RECALCULATE_RESET;
3b3b27
+#endif
3b3b27
+    }
3b3b27
+
3b3b27
     msg = g_strdup_printf ("Started opening '%s' integrity device", device);
3b3b27
     progress_id = bd_utils_report_started (msg);
3b3b27
     g_free (msg);
3b3b27
@@ -2258,7 +2290,7 @@ gboolean bd_crypto_integrity_open (const gchar *device, const gchar *name, const
3b3b27
         return FALSE;
3b3b27
     }
3b3b27
 
3b3b27
-    ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, flags);
3b3b27
+    ret = crypt_activate_by_volume_key (cd, name, (const char *) key_data, key_size, activate_flags);
3b3b27
     if (ret < 0) {
3b3b27
         g_set_error (error, BD_CRYPTO_ERROR, BD_CRYPTO_ERROR_DEVICE,
3b3b27
                      "Failed to activate device: %s", strerror_l (-ret, c_locale));
3b3b27
diff --git a/src/plugins/crypto.h b/src/plugins/crypto.h
30e489
index 6c1d40dd..536accf9 100644
3b3b27
--- a/src/plugins/crypto.h
3b3b27
+++ b/src/plugins/crypto.h
30e489
@@ -147,16 +147,12 @@ BDCryptoIntegrityExtra* bd_crypto_integrity_extra_copy (BDCryptoIntegrityExtra *
3b3b27
 BDCryptoIntegrityExtra* bd_crypto_integrity_extra_new (guint64 sector_size, guint64 journal_size, guint journal_watermark, guint journal_commit_time, guint64 interleave_sectors, guint64 tag_size, guint64 buffer_sectors);
3b3b27
 
3b3b27
 typedef enum {
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL         = CRYPT_ACTIVATE_NO_JOURNAL,
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_RECOVERY           = CRYPT_ACTIVATE_RECOVERY,
3b3b27
-#ifdef CRYPT_ACTIVATE_NO_JOURNAL_BITMAP
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP  = CRYPT_ACTIVATE_NO_JOURNAL_BITMAP,
3b3b27
-#endif
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE        = CRYPT_ACTIVATE_RECALCULATE,
3b3b27
-#ifdef CRYPT_ACTIVATE_RECALCULATE_RESET
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET  = CRYPT_ACTIVATE_RECALCULATE_RESET,
3b3b27
-#endif
3b3b27
-    BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS     = CRYPT_ACTIVATE_ALLOW_DISCARDS,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL         = 1 << 0,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECOVERY           = 1 << 1,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_NO_JOURNAL_BITMAP  = 1 << 2,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE        = 1 << 3,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_RECALCULATE_RESET  = 1 << 4,
3b3b27
+    BD_CRYPTO_INTEGRITY_OPEN_ALLOW_DISCARDS     = 1 << 5,
3b3b27
 } BDCryptoIntegrityOpenFlags;
3b3b27
 
3b3b27
 /**
3b3b27
diff --git a/tests/crypto_test.py b/tests/crypto_test.py
30e489
index 9758bf81..94b89131 100644
3b3b27
--- a/tests/crypto_test.py
3b3b27
+++ b/tests/crypto_test.py
30e489
@@ -1279,6 +1279,20 @@ class CryptoTestIntegrity(CryptoTestCase):
3b3b27
         self.assertTrue(succ)
3b3b27
         self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
 
3b3b27
+        # open with flags
3b3b27
+        succ = BlockDev.crypto_integrity_open(self.loop_dev, self._dm_name, "crc32c",
3b3b27
+                                              flags=BlockDev.CryptoIntegrityOpenFlags.ALLOW_DISCARDS)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertTrue(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
+        # check that discard is enabled for the mapped device
3b3b27
+        _ret, out, _err = run_command("dmsetup table %s" % self._dm_name)
3b3b27
+        self.assertIn("allow_discards", out)
3b3b27
+
3b3b27
+        succ = BlockDev.crypto_integrity_close(self._dm_name)
3b3b27
+        self.assertTrue(succ)
3b3b27
+        self.assertFalse(os.path.exists("/dev/mapper/%s" % self._dm_name))
3b3b27
+
3b3b27
     @tag_test(TestTags.SLOW)
3b3b27
     @unittest.skipUnless(HAVE_LUKS2, "Integrity not supported")
3b3b27
     def test_integrity_wipe(self):
3b3b27
-- 
30e489
2.37.3
3b3b27