Blame SOURCES/rear-bz1832394.patch

260680
diff --git a/doc/user-guide/06-layout-configuration.adoc b/doc/user-guide/06-layout-configuration.adoc
260680
index f59384db..88ba0420 100644
260680
--- a/doc/user-guide/06-layout-configuration.adoc
260680
+++ b/doc/user-guide/06-layout-configuration.adoc
260680
@@ -630,7 +630,7 @@ lvmvol <volume_group> <name> <size(bytes)> <layout> [key:value ...]
260680
 
260680
 === LUKS Devices ===
260680
 ----------------------------------
260680
-crypt /dev/mapper/<name> <device> [cipher=<cipher>] [key_size=<key size>] [hash=<hash function>] [uuid=<uuid>] [keyfile=<keyfile>] [password=<password>]
260680
+crypt /dev/mapper/<name> <device> [type=<type>] [cipher=<cipher>] [key_size=<key size>] [hash=<hash function>] [uuid=<uuid>] [keyfile=<keyfile>] [password=<password>]
260680
 ----------------------------------
260680
 
260680
 === DRBD ===
260680
diff --git a/usr/share/rear/layout/prepare/GNU/Linux/160_include_luks_code.sh b/usr/share/rear/layout/prepare/GNU/Linux/160_include_luks_code.sh
260680
index 05279bc8..0c662f67 100644
260680
--- a/usr/share/rear/layout/prepare/GNU/Linux/160_include_luks_code.sh
260680
+++ b/usr/share/rear/layout/prepare/GNU/Linux/160_include_luks_code.sh
260680
@@ -1,35 +1,75 @@
260680
+
260680
 # Code to recreate and/or open LUKS volumes.
260680
 
260680
 create_crypt() {
260680
+    # See the create_device() function in lib/layout-functions.sh what "device type" means:
260680
+    local device_type="$1"
260680
+    if ! grep -q "^crypt $device_type " "$LAYOUT_FILE" ; then
260680
+        LogPrintError "Skip recreating LUKS volume $device_type (no 'crypt $device_type' entry in $LAYOUT_FILE)"
260680
+        # FIXME: The return code is ignored in the create_device() function in lib/layout-functions.sh:
260680
+        return 1
260680
+    fi
260680
+    
260680
     local crypt target_device source_device options
260680
-    read crypt target_device source_device options < <(grep "^crypt $1 " "$LAYOUT_FILE")
260680
+    local mapping_name option key value
260680
+    local cryptsetup_options="" keyfile="" password=""
260680
 
260680
-    local target_name=${target_device#/dev/mapper/}
260680
+    read crypt target_device source_device options < <( grep "^crypt $device_type " "$LAYOUT_FILE" )
260680
+
260680
+    # Careful! One cannot 'test -b $source_device' here at the time when this code is run
260680
+    # because the source device is usually a disk partition block device like /dev/sda2
260680
+    # but disk partition block devices usually do not yet exist (in particular not on a new clean disk)
260680
+    # because partitions are actually created later when the diskrestore.sh script is run
260680
+    # but not here when this code is run which only generates the diskrestore.sh script:
260680
+    if ! test $source_device ; then
260680
+        LogPrintError "Skip recreating LUKS volume $device_type: No source device (see the 'crypt $device_type' entry in $LAYOUT_FILE)"
260680
+        # FIXME: The return code is ignored in the create_device() function in lib/layout-functions.sh:
260680
+        return 1
260680
+    fi
260680
+
260680
+    mapping_name=${target_device#/dev/mapper/}
260680
+    if ! test $mapping_name ; then
260680
+        LogPrintError "Skip recreating LUKS volume $device_type on $source_device: No /dev/mapper/... mapping name (see the 'crypt $device_type' entry in $LAYOUT_FILE)"
260680
+        # FIXME: The return code is ignored in the create_device() function in lib/layout-functions.sh:
260680
+        return 1
260680
+    fi
260680
 
260680
-    local cryptsetup_options="" keyfile="" password=""
260680
-    local option key value
260680
     for option in $options ; do
260680
-        key=${option%=*}
260680
+        # $option is of the form keyword=value and
260680
+        # we assume keyword has no '=' character but value could be anything that may have a '=' character
260680
+        # so we split keyword=value at the leftmost '=' character so that
260680
+        # e.g. keyword=foo=bar gets split into key="keyword" and value="foo=bar":
260680
+        key=${option%%=*}
260680
         value=${option#*=}
260680
-
260680
+        # The "cryptseup luksFormat" command does not require any of the type, cipher, key-size, hash, uuid option values
260680
+        # because if omitted a cryptseup default value is used so we treat those values as optional.
260680
+        # Using plain test to ensure the value is a single non empty and non blank word
260680
+        # without quoting because test " " would return zero exit code
260680
+        # cf. "Beware of the emptiness" in https://github.com/rear/rear/wiki/Coding-Style
260680
         case "$key" in
260680
-            cipher)
260680
-                cryptsetup_options+=" --cipher $value"
260680
+            (type)
260680
+                test $value && cryptsetup_options+=" --type $value"
260680
+                ;;
260680
+            (cipher)
260680
+                test $value && cryptsetup_options+=" --cipher $value"
260680
+                ;;
260680
+            (key_size)
260680
+                test $value && cryptsetup_options+=" --key-size $value"
260680
                 ;;
260680
-            key_size)
260680
-                cryptsetup_options+=" --key-size $value"
260680
+            (hash)
260680
+                test $value && cryptsetup_options+=" --hash $value"
260680
                 ;;
260680
-            hash)
260680
-                cryptsetup_options+=" --hash $value"
260680
+            (uuid)
260680
+                test $value && cryptsetup_options+=" --uuid $value"
260680
                 ;;
260680
-            uuid)
260680
-                cryptsetup_options+=" --uuid $value"
260680
+            (keyfile)
260680
+                test $value && keyfile=$value
260680
                 ;;
260680
-            keyfile)
260680
-                keyfile=$value
260680
+            (password)
260680
+                test $value && password=$value
260680
                 ;;
260680
-            password)
260680
-                password=$value
260680
+            (*)
260680
+                LogPrintError "Skipping unsupported LUKS cryptsetup option '$key' in 'crypt $target_device $source_device' entry in $LAYOUT_FILE"
260680
                 ;;
260680
         esac
260680
     done
260680
@@ -37,26 +77,25 @@ create_crypt() {
260680
     cryptsetup_options+=" $LUKS_CRYPTSETUP_OPTIONS"
260680
 
260680
     (
260680
-    echo "Log \"Creating LUKS device $target_name on $source_device\""
260680
+    echo "LogPrint \"Creating LUKS volume $mapping_name on $source_device\""
260680
     if [ -n "$keyfile" ] ; then
260680
         # Assign a temporary keyfile at this stage so that original keyfiles do not leak onto the rescue medium.
260680
         # The original keyfile will be restored from the backup and then re-assigned to the LUKS device in the
260680
         # 'finalize' stage.
260680
         # The scheme for generating a temporary keyfile path must be the same here and in the 'finalize' stage.
260680
-        keyfile="${TMPDIR:-/tmp}/LUKS-keyfile-$target_name"
260680
+        keyfile="$TMP_DIR/LUKS-keyfile-$mapping_name"
260680
         dd bs=512 count=4 if=/dev/urandom of="$keyfile"
260680
         chmod u=rw,go=- "$keyfile"
260680
-
260680
         echo "cryptsetup luksFormat --batch-mode $cryptsetup_options $source_device $keyfile"
260680
-        echo "cryptsetup luksOpen --key-file $keyfile $source_device $target_name"
260680
+        echo "cryptsetup luksOpen --key-file $keyfile $source_device $mapping_name"
260680
     elif [ -n "$password" ] ; then
260680
         echo "echo \"$password\" | cryptsetup luksFormat --batch-mode $cryptsetup_options $source_device"
260680
-        echo "echo \"$password\" | cryptsetup luksOpen $source_device $target_name"
260680
+        echo "echo \"$password\" | cryptsetup luksOpen $source_device $mapping_name"
260680
     else
260680
-        echo "LogPrint \"Please enter the password for LUKS device $target_name ($source_device):\""
260680
+        echo "LogUserOutput \"Set the password for LUKS volume $mapping_name (for 'cryptsetup luksFormat' on $source_device):\""
260680
         echo "cryptsetup luksFormat --batch-mode $cryptsetup_options $source_device"
260680
-        echo "LogPrint \"Please re-enter the password for LUKS device $target_name ($source_device):\""
260680
-        echo "cryptsetup luksOpen $source_device $target_name"
260680
+        echo "LogUserOutput \"Enter the password for LUKS volume $mapping_name (for 'cryptsetup luksOpen' on $source_device):\""
260680
+        echo "cryptsetup luksOpen $source_device $mapping_name"
260680
     fi
260680
     echo ""
260680
     ) >> "$LAYOUT_CODE"
260680
@@ -64,38 +103,61 @@ create_crypt() {
260680
 
260680
 # Function open_crypt() is meant to be used by the 'mountonly' workflow
260680
 open_crypt() {
260680
+    # See the do_mount_device() function in lib/layout-functions.sh what "device type" means:
260680
+    local device_type="$1"
260680
+    if ! grep -q "^crypt $device_type " "$LAYOUT_FILE" ; then
260680
+        LogPrintError "Skip opening LUKS volume $device_type (no 'crypt $device_type' entry in $LAYOUT_FILE)"
260680
+        # FIXME: The return code is ignored in the do_mount_device() function in lib/layout-functions.sh:
260680
+        return 1
260680
+    fi
260680
+
260680
     local crypt target_device source_device options
260680
-    read crypt target_device source_device options < <(grep "^crypt $1 " "$LAYOUT_FILE")
260680
+    local mapping_name option key value
260680
+    local cryptsetup_options="" keyfile="" password=""
260680
 
260680
-    local target_name=${target_device#/dev/mapper/}
260680
+    read crypt target_device source_device options < <( grep "^crypt $device_type " "$LAYOUT_FILE" )
260680
+
260680
+    if ! test -b "$source_device" ; then
260680
+        LogPrintError "Skip opening LUKS volume $device_type on device '$source_device' that is no block device (see the 'crypt $device_type' entry in $LAYOUT_FILE)"
260680
+        # FIXME: The return code is ignored in the do_mount_device() function in lib/layout-functions.sh:
260680
+        return 1
260680
+    fi
260680
+
260680
+    mapping_name=${target_device#/dev/mapper/}
260680
+    if ! test $mapping_name ; then
260680
+        LogPrintError "Skip opening LUKS volume $device_type on $source_device: No /dev/mapper/... mapping name (see the 'crypt $device_type' entry in $LAYOUT_FILE)"
260680
+        # FIXME: The return code is ignored in the do_mount_device() function in lib/layout-functions.sh:
260680
+        return 1
260680
+    fi
260680
 
260680
-    local cryptsetup_options="" keyfile="" password=""
260680
-    local option key value
260680
     for option in $options ; do
260680
-        key=${option%=*}
260680
+        # $option is of the form keyword=value and
260680
+        # we assume keyword has no '=' character but value could be anything that may have a '=' character
260680
+        # so we split keyword=value at the leftmost '=' character so that
260680
+        # e.g. keyword=foo=bar gets split into key="keyword" and value="foo=bar":
260680
+        key=${option%%=*}
260680
         value=${option#*=}
260680
-
260680
         case "$key" in
260680
-            keyfile)
260680
-                keyfile=$value
260680
+            (keyfile)
260680
+                test $value && keyfile=$value
260680
                 ;;
260680
-            password)
260680
-                password=$value
260680
+            (password)
260680
+                test $value && password=$value
260680
                 ;;
260680
         esac
260680
     done
260680
 
260680
     (
260680
-    echo "Log \"Opening LUKS device $target_name on $source_device\""
260680
+    echo "LogPrint \"Opening LUKS volume $mapping_name on $source_device\""
260680
     if [ -n "$keyfile" ] ; then
260680
         # During a 'mountonly' workflow, the original keyfile is supposed to be
260680
         # available at this point.
260680
-        echo "cryptsetup luksOpen --key-file $keyfile $source_device $target_name"
260680
+        echo "cryptsetup luksOpen --key-file $keyfile $source_device $mapping_name"
260680
     elif [ -n "$password" ] ; then
260680
-        echo "echo \"$password\" | cryptsetup luksOpen $source_device $target_name"
260680
+        echo "echo \"$password\" | cryptsetup luksOpen $source_device $mapping_name"
260680
     else
260680
-        echo "LogPrint \"Please enter the password for LUKS device $target_name ($source_device):\""
260680
-        echo "cryptsetup luksOpen $source_device $target_name"
260680
+        echo "LogUserOutput \"Enter the password for LUKS volume $mapping_name (for 'cryptsetup luksOpen' on $source_device):\""
260680
+        echo "cryptsetup luksOpen $source_device $mapping_name"
260680
     fi
260680
     echo ""
260680
     ) >> "$LAYOUT_CODE"
260680
diff --git a/usr/share/rear/layout/save/GNU/Linux/260_crypt_layout.sh b/usr/share/rear/layout/save/GNU/Linux/260_crypt_layout.sh
260680
index c1e1cfd5..afeabf6a 100644
260680
--- a/usr/share/rear/layout/save/GNU/Linux/260_crypt_layout.sh
260680
+++ b/usr/share/rear/layout/save/GNU/Linux/260_crypt_layout.sh
260680
@@ -9,6 +9,8 @@ Log "Saving Encrypted volumes."
260680
 REQUIRED_PROGS+=( cryptsetup dmsetup )
260680
 COPY_AS_IS+=( /usr/share/cracklib/\* /etc/security/pwquality.conf )
260680
 
260680
+local invalid_cryptsetup_option_value="no"
260680
+
260680
 while read target_name junk ; do
260680
     # find the target device we're mapping
260680
     if ! [ -e /dev/mapper/$target_name ] ; then
260680
@@ -30,29 +32,96 @@ while read target_name junk ; do
260680
         source_device="$(get_device_name ${slave##*/})"
260680
     done
260680
 
260680
-    if ! cryptsetup isLuks $source_device >/dev/null 2>&1; then
260680
+    if ! blkid -p -o export $source_device >$TMP_DIR/blkid.output ; then
260680
+        LogPrintError "Error: Cannot get attributes for $target_name ('blkid -p -o export $source_device' failed)"
260680
         continue
260680
     fi
260680
 
260680
-    # gather crypt information
260680
-    cipher=$(cryptsetup luksDump $source_device | grep "Cipher name" | sed -r 's/^.+:\s*(.+)$/\1/')
260680
-    mode=$(cryptsetup luksDump $source_device | grep "Cipher mode" | cut -d: -f2- | awk '{printf("%s",$1)};')
260680
-    key_size=$(cryptsetup luksDump $source_device | grep "MK bits" | sed -r 's/^.+:\s*(.+)$/\1/')
260680
-    hash=$(cryptsetup luksDump $source_device | grep "Hash spec" | sed -r 's/^.+:\s*(.+)$/\1/')
260680
-    uuid=$(cryptsetup luksDump $source_device | grep "UUID" | sed -r 's/^.+:\s*(.+)$/\1/')
260680
-    keyfile_option=$([ -f /etc/crypttab ] && awk '$1 == "'"$target_name"'" && $3 != "none" && $3 != "-" && $3 != "" { print "keyfile=" $3; }' /etc/crypttab)
260680
+    if ! grep -q "TYPE=crypto_LUKS" $TMP_DIR/blkid.output ; then
260680
+        Log "Skipping $target_name (no 'TYPE=crypto_LUKS' in 'blkid -p -o export $source_device' output)"
260680
+        continue
260680
+    fi
260680
 
260680
-    # LUKS version 2 is not yet suppported, see https://github.com/rear/rear/issues/2204
260680
-    # When LUKS version 2 is used the above code fails at least to determine the hash value
260680
-    # so we use an empty hash value as a simple test if gathering crypt information was successful:
260680
-    test "$hash" || Error "No hash value for LUKS device '$target_name' at '$source_device' (only LUKS version 1 is supported)"
260680
+    # Detect LUKS version:
260680
+    # Remove all non-digits in particular to avoid leading or trailing spaces in the version string
260680
+    # cf. "Beware of the emptiness" in https://github.com/rear/rear/wiki/Coding-Style
260680
+    # that could happen if the blkid output contains "VERSION = 2" so that 'cut -d= -f2' results " 2".
260680
+    version=$( grep "VERSION" $TMP_DIR/blkid.output | cut -d= -f2 | tr -c -d '[:digit:]' )
260680
+    if ! test "$version" = "1" -o "$version" = "2" ; then
260680
+        LogPrintError "Error: Unsupported LUKS version for $target_name ('blkid -p -o export $source_device' shows 'VERSION=$version')"
260680
+        continue
260680
+    fi
260680
+    luks_type=luks$version
260680
 
260680
-    echo "crypt /dev/mapper/$target_name $source_device cipher=$cipher-$mode key_size=$key_size hash=$hash uuid=$uuid $keyfile_option" >> $DISKLAYOUT_FILE
260680
-done < <( dmsetup ls --target crypt )
260680
+    # Gather crypt information:
260680
+    if ! cryptsetup luksDump $source_device >$TMP_DIR/cryptsetup.luksDump ; then
260680
+        LogPrintError "Error: Cannot get LUKS$version values for $target_name ('cryptsetup luksDump $source_device' failed)"
260680
+        continue
260680
+    fi
260680
+    uuid=$( grep "UUID" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+)$/\1/' )
260680
+    keyfile_option=$( [ -f /etc/crypttab ] && awk '$1 == "'"$target_name"'" && $3 != "none" && $3 != "-" && $3 != "" { print "keyfile=" $3; }' /etc/crypttab )
260680
+    if test $luks_type = "luks1" ; then
260680
+        cipher_name=$( grep "Cipher name" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+)$/\1/' )
260680
+        cipher_mode=$( grep "Cipher mode" $TMP_DIR/cryptsetup.luksDump | cut -d: -f2- | awk '{printf("%s",$1)};' )
260680
+        cipher=$cipher_name-$cipher_mode
260680
+        key_size=$( grep "MK bits" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+)$/\1/' )
260680
+        hash=$( grep "Hash spec" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+)$/\1/' )
260680
+    elif test $luks_type = "luks2" ; then
260680
+        cipher=$( grep "cipher:" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+)$/\1/' )
260680
+        # More than one keyslot may be defined - use key_size from the first slot.
260680
+        # Depending on the version the "cryptsetup luksDump" command outputs the key_size value
260680
+        # as a line like
260680
+        #         Key:        512 bits
260680
+        # and/or as a line like
260680
+        #         Cipher key: 512 bits
260680
+        # cf. https://github.com/rear/rear/pull/2504#issuecomment-718729198 and subsequent comments
260680
+        # so we grep for both lines but use only the first match from the first slot:
260680
+        key_size=$( egrep -m 1 "Key:|Cipher key:" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+) bits$/\1/' )
260680
+        hash=$( grep "Hash" $TMP_DIR/cryptsetup.luksDump | sed -r 's/^.+:\s*(.+)$/\1/' )
260680
+    fi
260680
 
260680
-# cryptsetup is required in the recovery system if disklayout.conf contains at least one 'crypt' entry
260680
-# see the create_crypt function in layout/prepare/GNU/Linux/160_include_luks_code.sh
260680
-# what program calls are written to diskrestore.sh
260680
-# cf. https://github.com/rear/rear/issues/1963
260680
-grep -q '^crypt ' $DISKLAYOUT_FILE && REQUIRED_PROGS+=( cryptsetup ) || true
260680
+    # Basic checks that the cipher key_size hash uuid values exist
260680
+    # cf. https://github.com/rear/rear/pull/2504#issuecomment-718729198
260680
+    # because some values are needed during "rear recover"
260680
+    # to set cryptsetup options in layout/prepare/GNU/Linux/160_include_luks_code.sh
260680
+    # and it seems cryptsetup fails when options with empty values are specified
260680
+    # cf. https://github.com/rear/rear/pull/2504#issuecomment-719479724
260680
+    # For example a LUKS1 crypt entry in disklayout.conf looks like
260680
+    # crypt /dev/mapper/luks1test /dev/sda7 type=luks1 cipher=aes-xts-plain64 key_size=256 hash=sha256 uuid=1b4198c9-d9b0-4c57-b9a3-3433e391e706 
260680
+    # and a LUKS1 crypt entry in disklayout.conf looks like
260680
+    # crypt /dev/mapper/luks2test /dev/sda8 type=luks2 cipher=aes-xts-plain64 key_size=256 hash=sha256 uuid=3e874a28-7415-4f8c-9757-b3f28a96c4d2 
260680
+    # Only the keyfile_option value is optional and the luks_type value is already tested above.
260680
+    # Using plain test to ensure a value is a single non empty and non blank word
260680
+    # without quoting because test " " would return zero exit code
260680
+    # cf. "Beware of the emptiness" in https://github.com/rear/rear/wiki/Coding-Style
260680
+    # Do not error out instantly here but only report errors here so the user can see all messages
260680
+    # and actually error out at the end of this script if there was one actually invalid value:
260680
+    if ! test $cipher ; then
260680
+        LogPrint "No 'cipher' value for LUKS$version volume $target_name in $source_device"
260680
+    fi
260680
+    if test $key_size ; then
260680
+        if ! is_positive_integer $key_size ; then
260680
+            LogPrintError "Error: 'key_size=$key_size' is no positive integer for LUKS$version volume $target_name in $source_device"
260680
+            invalid_cryptsetup_option_value="yes"
260680
+        fi
260680
+    else
260680
+        LogPrint "No 'key_size' value for LUKS$version volume $target_name in $source_device"
260680
+    fi
260680
+    if ! test $hash ; then
260680
+        LogPrint "No 'hash' value for LUKS$version volume $target_name in $source_device"
260680
+    fi
260680
+    if ! test $uuid ; then
260680
+        # Report a missig uuid value as an error to have the user informed
260680
+        # but do not error out here because things can be fixed manually during "rear recover"
260680
+        # cf. https://github.com/rear/rear/pull/2506#issuecomment-721757810
260680
+        # and https://github.com/rear/rear/pull/2506#issuecomment-722315498
260680
+        # and https://github.com/rear/rear/issues/2509
260680
+        LogPrintError "Error: No 'uuid' value for LUKS$version volume $target_name in $source_device (mounting it or booting the recreated system may fail)"
260680
+    fi
260680
+
260680
+    echo "crypt /dev/mapper/$target_name $source_device type=$luks_type cipher=$cipher key_size=$key_size hash=$hash uuid=$uuid $keyfile_option" >> $DISKLAYOUT_FILE
260680
+
260680
+done < <( dmsetup ls --target crypt )
260680
 
260680
+# Let this script return successfully when invalid_cryptsetup_option_value is not true:
260680
+is_true $invalid_cryptsetup_option_value && Error "Invalid or empty LUKS cryptsetup option value(s) in $DISKLAYOUT_FILE" || true