genode/repos/gems/run/vfs_tresor.sh
Martin Stein aeb65d6b1b file_vault: version 23.05
* ARM support and detaching from Ada/SPARK

  * Remove all CBE-related code - especially the Ada/SPARK-based CBE library.

    * We have no means or motivation of further maintaining big projects in
      Ada/SPARK (the core Genode team is native to C++).

    * The Genode Ada/SPARK toolchain and runtime don't support ARM so far - an
      important architecture for Genode. This would mean extra commitment in
      Ada/SPARK.

    * We realize that block encryption more and more becomes a fundamental
      feature of Genode systems.

  * Implement a new block encryption library named Tresor that is inspired by
    the design and feature set of the former CBE library and that is entirely
    C++ and part of the Genode gems repository.

    * The Tresor block encryption is backwards-compatible with the on-disk
      data layout of the former CBE block encryption.

    * Except from the snapshot management and the "dump" tool, the Tresor
      block encryption provides the same feature set as the former CBE block
      encryption and accepts the same user requests at the level of the
      Tresor library API.

    * So far, the Tresor block encryption does not support the creation of
      user-defined snapshots.

    * In contrast to the former CBE, the Tresor ecosystem has
      no "dump" tool beause with the CBE library it turned out to be rarely of
      use.

    * In contrast to the Block back-end of the CBE "init" tool, the Tresor
      "init" tool uses a File System back-end.

    * The former CBE VFS-plugin is replaced with a new Tresor VFS-Plugin.

      * The Tresor-VFS plugin in general is similar to the former CBE VFS but
        has a slightly different API when it comes to re-keying and re-sizing.
        Each of these operations now is controlled via two files. The first
        file is named <operation> and the user writes the start command to it.
        The user must then read this file once in order to drive the operation.
        The read returns the result of the operation, once it is finished.
        The second file is named <operation>_progress and can be watched and
        read for obtaining the progress of the operation as percentage.

    * The file vault is adapted to use the new Tresor ecosystem
      instead of the former CBE ecosystem and thereby also gains ARM support.

    * The former CBE tester and CBE VFS-tests are replaced by equivalent
      Tresor variants and are now run on ARM as well (testing with a persistent
      storage back-end is supported only when running on Linux).

    * So far, the new Tresor block encryption has no internal cache for meta
      data blocks like the former CBE.

* Add config/report user interface

  * Add a second option for the administration front end to the file vault
    named "config and report". With this front end the File Vault communicates
    with the user via XML strings. A ROM session is requested for user input
    and a Report session for user output. The front end type must be set at
    startup via the component config and is a static setting. The graphical
    front end that was used up to now is named "menu view" and remains the
    default.

  * The File Vault can now reflect its internal state and user input ("config
    and report" mode only) at the LOG session via two new static config
    attributes "verbose_state" and "verbose_ui_config" (both defaulting to
    "no").

  * The Shutdown button in "menu view" mode is replaced with a Lock button. The
    new button doesn't terminate the File Vault but merely lock the encrypted
    container and return to a cleared passphrase input. The same transition is
    also provided in "config and report" mode.

  * The file_vault.run script is replaced with file_vault_menu_view.run and
    file_vault_cfg_report.run that address the two front end modes. In contrast
    to the former script, which is interactive, the latter script is suitable
    for automatic testing.

  * There is a new recipe/pkg/test-file_vault_cfg_report that essentially does
    the same as file_vault_cfg_report.run but uses the File Vault package and
    can be executed with the Depot Autopilot. The new test package is added to
    the default test list of depot_autopilot.run

  * The File Vault README is updated to the new version of the component and
    has gained a chapter "functional description".

  * Fixes a regression with the cbe_init_trust_anchor component that prevented
    reacting to a failed unlock attempt in the File Vault.

* The new Tresor software Trust Anchor has an optional deterministic mode in
  which it replaces the normally randomized symmetric keys with 0. This mode
  comes in handy for debugging. However, it should never be activated in
  productive systems. When activated, the user is warned extensively on the
  LOG that this system mode is insecure.

Ref #4819
2023-05-30 12:03:32 +02:00

307 lines
6.7 KiB
Bash

#!/bin/bash
echo "--- Automated Tresor testing ---"
produce_pattern() {
local pattern="$1"
local size="$2"
[ "$pattern" = "" ] && exit 1
local tmp_file="/tmp/pattern.tmp"
local N=1041
# prints numbers until N and uses pattern as delimiter and
# generates about 4 KiB of data with a 1 byte pattern
seq -s "$pattern" $N > $tmp_file
dd if=$tmp_file count=1 bs=$size 2>/dev/null
}
test_write_1() {
local data_file="$1"
local offset=$2
local pattern_file="/tmp/pattern"
dd bs=4096 count=1 if=$pattern_file of=$data_file seek=$offset 2>/dev/null || exit 1
}
test_read_seq_unaligned_512() {
local data_file="$1"
local length="$2"
dd bs=512 count=$((length / 512)) if=$data_file of=/dev/null
}
test_read_compare_1() {
local data_file="$1"
local offset=$2
local pattern_file="/tmp/pattern"
rm $pattern_file.out 2>/dev/null
dd bs=4096 count=1 if=$data_file of=$pattern_file.out skip=$offset 2>/dev/null || exit 1
local sha1=$(sha1sum $pattern_file)
local sha1_sum=${sha1:0:40}
local sha1out=$(sha1sum $pattern_file.out)
local sha1out_sum=${sha1out:0:40}
if [ "$sha1_sum" != "$sha1out_sum" ]; then
echo "mismatch for block $offset:"
echo " expected: $sha1_sum"
echo -n " "
dd if=$pattern_file bs=32 count=1 2>/dev/null; echo
echo " got: $sha1out_sum"
echo -n " "
dd if=$pattern_file.out bs=32 count=1 2>/dev/null; echo
return 1
fi
}
test_create_snapshot() {
local tresor_dir="$1"
echo "Create snapshot"
echo true > $tresor_dir/control/create_snapshot
}
test_list_snapshots() {
local tresor_dir="$1"
echo "List content of '$tresor_dir'"
ls -l $tresor_dir/snapshots
}
test_discard_snapshot() {
local tresor_dir="$1"
local snap_id=$2
echo "Discard snapshot with id: $snap_id"
echo $snap_id > $tresor_dir/control/discard_snapshot
}
test_rekey_start() {
local tresor_dir="$1"
echo "Start rekeying"
echo on > $tresor_dir/control/rekey
echo "Reykeying started"
}
test_vbd_extension() {
local tresor_dir="$1"
local nr_of_phys_blocks="$2"
echo "Start extending VBD"
echo tree=vbd, blocks=$nr_of_phys_blocks > $tresor_dir/control/extend
echo "VBD extension started"
}
test_ft_extension() {
local tresor_dir="$1"
local nr_of_phys_blocks="$2"
echo "Start extending FT"
echo tree=ft, blocks=$nr_of_phys_blocks > $tresor_dir/control/extend
echo "FT extension started"
}
test_rekey_state() {
local tresor_dir="$1"
local state="$(< $tresor_dir/control/rekey)"
local progress="$(< $tresor_dir/control/rekey_progress)"
local result="unknown"
case "$progress" in
*at*)
result="$progress"
;;
*idle*)
result="done"
;;
esac
echo "Rekeying state: $state progress: $result"
}
test_rekey() {
local tresor_dir="$1"
test_rekey_start "$tresor_dir"
wait_for_rekeying "$tresor_dir" "yes"
}
wait_for_rekeying() {
local tresor_dir="$1"
local verbose="$2"
local result="unknown"
echo "Wait for rekeying to finish..."
while : ; do
local done=0
local file_content="$(< $tresor_dir/control/rekey_progress)"
# XXX remove later
echo "file_content: ${file_content}"
case "$file_content" in
*at*)
if [ "$verbose" = "yes" ]; then
echo "Rekeying: $file_content"
fi
;;
*idle*)
done=1;
;;
esac
if [ $done -gt 0 ]; then
break
fi
done
echo "Rekeying done"
}
wait_for_vbd_extension() {
local tresor_dir="$1"
echo "Wait for VBD extension to finish..."
while : ; do
local done=0
local file_content="$(< $tresor_dir/control/extend_progress)"
# XXX remove later
echo "file_content: ${file_content}"
case "$file_content" in
*at*)
if [ "$verbose" = "yes" ]; then
echo "Extending VBD: $file_content"
fi
;;
*idle*)
done=1;
;;
esac
if [ $done -gt 0 ]; then
break
fi
done
echo "VBD extension done"
}
wait_for_ft_extension() {
local tresor_dir="$1"
echo "Wait for FT extension to finish..."
while : ; do
local done=0
local file_content="$(< $tresor_dir/control/extend_progress)"
# XXX remove later
echo "file_content: ${file_content}"
case "$file_content" in
*at*)
if [ "$verbose" = "yes" ]; then
echo "Extending FT: $file_content"
fi
;;
*idle*)
done=1;
;;
esac
if [ $done -gt 0 ]; then
break
fi
done
echo "FT extension done"
}
main() {
local tresor_dir="/dev/tresor"
local data_file="$tresor_dir/current/data"
ls -l $tresor_dir
for i in $(seq 3); do
echo "--> Run $i:"
test_read_seq_unaligned_512 "$data_file" "1048576"
local pattern_file="/tmp/pattern"
produce_pattern "$i" "4096" > $pattern_file
test_write_1 "$data_file" "419"
test_write_1 "$data_file" "63"
test_write_1 "$data_file" "333"
test_vbd_extension "$tresor_dir" "1000"
test_read_compare_1 "$data_file" "63"
test_write_1 "$data_file" "175"
test_read_compare_1 "$data_file" "419"
test_write_1 "$data_file" "91"
test_read_compare_1 "$data_file" "175"
test_read_compare_1 "$data_file" "91"
test_read_compare_1 "$data_file" "333"
wait_for_vbd_extension "$tresor_dir"
test_write_1 "$data_file" "32"
test_write_1 "$data_file" "77"
test_write_1 "$data_file" "199"
#test_ft_extension "$tresor_dir" "1000"
test_read_compare_1 "$data_file" "32"
test_write_1 "$data_file" "211"
test_read_compare_1 "$data_file" "77"
test_write_1 "$data_file" "278"
test_read_compare_1 "$data_file" "199"
test_read_compare_1 "$data_file" "278"
test_read_compare_1 "$data_file" "211"
#wait_for_ft_extension "$tresor_dir"
test_write_1 "$data_file" "0"
test_write_1 "$data_file" "8"
test_write_1 "$data_file" "16"
test_write_1 "$data_file" "490"
test_write_1 "$data_file" "468"
test_read_compare_1 "$data_file" "0"
test_read_compare_1 "$data_file" "8"
test_read_compare_1 "$data_file" "16"
test_read_compare_1 "$data_file" "490"
#test_rekey "$tresor_dir"
test_rekey_start "$tresor_dir"
test_write_1 "$data_file" "0"
test_rekey_state "$tresor_dir"
test_read_compare_1 "$data_file" "490"
test_rekey_state "$tresor_dir"
test_write_1 "$data_file" "16"
test_rekey_state "$tresor_dir"
test_read_compare_1 "$data_file" "468"
test_rekey_state "$tresor_dir"
test_read_compare_1 "$data_file" "8"
test_rekey_state "$tresor_dir"
test_read_compare_1 "$data_file" "16"
test_rekey_state "$tresor_dir"
test_read_compare_1 "$data_file" "0"
test_write_1 "$data_file" "300"
test_write_1 "$data_file" "240"
test_write_1 "$data_file" "201"
test_write_1 "$data_file" "328"
wait_for_rekeying "$tresor_dir" "yes"
echo "--> Run $i done"
done
echo "--> Read/Compare test"
test_read_compare_1 "$data_file" "0"
test_read_compare_1 "$data_file" "490"
test_read_compare_1 "$data_file" "468"
test_read_compare_1 "$data_file" "8"
test_read_compare_1 "$data_file" "16"
echo "--> Read/Compare test done"
echo "--- Automated Tresor testing finished, shell is yours ---"
}
main "$@"
# just drop into shell
# exit 0