|
| 1 | +#!/bin/sh |
| 2 | + |
| 3 | +# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries. |
| 4 | +# SPDX-License-Identifier: BSD-3-Clause-Clear |
| 5 | +# Robustly find and source init_env |
| 6 | +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" |
| 7 | +INIT_ENV="" |
| 8 | +SEARCH="$SCRIPT_DIR" |
| 9 | +while [ "$SEARCH" != "/" ]; do |
| 10 | + if [ -f "$SEARCH/init_env" ]; then |
| 11 | + INIT_ENV="$SEARCH/init_env" |
| 12 | + break |
| 13 | + fi |
| 14 | + SEARCH=$(dirname "$SEARCH") |
| 15 | +done |
| 16 | + |
| 17 | +if [ -z "$INIT_ENV" ]; then |
| 18 | + echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2 |
| 19 | + exit 0 |
| 20 | +fi |
| 21 | + |
| 22 | +if [ -z "$__INIT_ENV_LOADED" ]; then |
| 23 | + # shellcheck disable=SC1090 |
| 24 | + . "$INIT_ENV" |
| 25 | +fi |
| 26 | + |
| 27 | +# shellcheck disable=SC1090,SC1091 |
| 28 | +. "$TOOLS/functestlib.sh" |
| 29 | + |
| 30 | +FSCRYPTCTL="${FSCRYPTCTL:-fscryptctl}" |
| 31 | +TESTNAME="UserDataEncryption" |
| 32 | +test_path=$(find_test_case_by_name "$TESTNAME") |
| 33 | + |
| 34 | +if [ -z "$test_path" ]; then |
| 35 | + log_fail "Path not found for $TESTNAME test. Falling back to SCRIPT_DIR: $SCRIPT_DIR" |
| 36 | + test_path="$SCRIPT_DIR" |
| 37 | +fi |
| 38 | + |
| 39 | +res_file="$test_path/$TESTNAME.res" |
| 40 | + |
| 41 | +# Ensure script runs as root |
| 42 | +if [ "$(id -u)" -ne 0 ]; then |
| 43 | + log_skip "This script must be run as root." |
| 44 | + echo "$TESTNAME SKIP" > "$res_file" |
| 45 | + exit 0 |
| 46 | +else |
| 47 | + log_info "Running as root. Continuing..." |
| 48 | +fi |
| 49 | + |
| 50 | +if ! cd "$test_path"; then |
| 51 | + log_fail "Failed to change directory to $test_path" |
| 52 | + echo "$TESTNAME FAIL" > "$res_file" |
| 53 | + exit 0 |
| 54 | +fi |
| 55 | + |
| 56 | +# Globals that cleanup will use |
| 57 | +MOUNT_DIR="" |
| 58 | +FS_PATH="" |
| 59 | +key_id="" |
| 60 | +KEY_FILE="" |
| 61 | + |
| 62 | +cleanup() { |
| 63 | + if [ -n "$MOUNT_DIR" ] && [ "$MOUNT_DIR" != "/" ]; then |
| 64 | + log_info "Cleaning up mount directory: $MOUNT_DIR" |
| 65 | + |
| 66 | + if rm -f "$MOUNT_DIR/file.txt" 2>/dev/null; then |
| 67 | + log_info "Deleted test file: $MOUNT_DIR/file.txt" |
| 68 | + else |
| 69 | + log_warn "Failed to delete test file: $MOUNT_DIR/file.txt" |
| 70 | + fi |
| 71 | + |
| 72 | + if rmdir "$MOUNT_DIR" 2>/dev/null; then |
| 73 | + log_info "Removed mount directory: $MOUNT_DIR" |
| 74 | + else |
| 75 | + log_warn "Failed to remove mount directory: $MOUNT_DIR" |
| 76 | + fi |
| 77 | + fi |
| 78 | + |
| 79 | + if [ -n "$key_id" ]; then |
| 80 | + "$FSCRYPTCTL" remove_key "$key_id" "$FS_PATH" >/dev/null 2>&1 || true |
| 81 | + fi |
| 82 | + |
| 83 | + |
| 84 | + if [ -n "$KEY_FILE" ]; then |
| 85 | + if ! rm -f "$KEY_FILE" 2>/dev/null; then |
| 86 | + log_warn "Failed to remove key file: $KEY_FILE" |
| 87 | + fi |
| 88 | + fi |
| 89 | +} |
| 90 | + |
| 91 | +# Run cleanup on normal exit, Ctrl-C, or SIGTERM |
| 92 | +trap cleanup EXIT INT TERM |
| 93 | + |
| 94 | +log_info "-----------------------------------------------------------------------------------------" |
| 95 | +log_info "-------------------Starting $TESTNAME Testcase----------------------------" |
| 96 | +log_info "=== Test Initialization ===" |
| 97 | + |
| 98 | + |
| 99 | +## kernel config check |
| 100 | +if [ -r /proc/config.gz ]; then |
| 101 | + if zcat /proc/config.gz | grep -q '^CONFIG_FS_ENCRYPTION=[ym]'; then |
| 102 | + log_info "Kernel supports fscrypt (CONFIG_FS_ENCRYPTION=y/m)." |
| 103 | + else |
| 104 | + log_skip "$TESTNAME : Kernel lacks CONFIG_FS_ENCRYPTION. Skipping." |
| 105 | + echo "$TESTNAME SKIP" > "$res_file" |
| 106 | + exit 0 |
| 107 | + fi |
| 108 | +else |
| 109 | + log_warn "/proc/config.gz not available; cannot verify kernel config. Proceeding" |
| 110 | +fi |
| 111 | + |
| 112 | +log_info "Checking if dependency binary is available" |
| 113 | +check_dependencies "$FSCRYPTCTL" |
| 114 | + |
| 115 | +# Create a secure temporary file for the key |
| 116 | +if KEY_FILE="$(mktemp)"; then |
| 117 | + log_info "Temporary key file created: $KEY_FILE" |
| 118 | + chmod 600 "$KEY_FILE" |
| 119 | +else |
| 120 | + log_fail "$TESTNAME : Failed to create temporary key file" |
| 121 | + echo "[ERROR] Failed to create temporary key file" >&2 |
| 122 | + exit 0 |
| 123 | +fi |
| 124 | + |
| 125 | +# Step 1: Generate a 64-byte key |
| 126 | +log_info "Generating 64-byte encryption key" |
| 127 | +if ! head -c 64 /dev/urandom > "$KEY_FILE"; then |
| 128 | + log_fail "$TESTNAME : Failed to generate encryption key" |
| 129 | + echo "$TESTNAME FAIL" > "$res_file" |
| 130 | + exit 0 |
| 131 | +fi |
| 132 | + |
| 133 | +# Step 2: Create mount folder (this will create an unique folder under mnt) |
| 134 | +log_info "Creating unique mount folder under /mnt" |
| 135 | +MOUNT_DIR=$(mktemp -d /mnt/testing.XXXXXX) |
| 136 | +if [ ! -d "$MOUNT_DIR" ]; then |
| 137 | + log_fail "$TESTNAME : Failed to create mount directory" |
| 138 | + echo "$TESTNAME FAIL" > "$res_file" |
| 139 | + exit 0 |
| 140 | +fi |
| 141 | +log_info "Created unique mount directory: $MOUNT_DIR" |
| 142 | + |
| 143 | + |
| 144 | +FS_PATH=$(df --output=target "$MOUNT_DIR" | tail -n 1) |
| 145 | +if [ -z "$FS_PATH" ]; then |
| 146 | + log_fail "$TESTNAME : Failed to determine filesystem mount point for $MOUNT_DIR" |
| 147 | + echo "$TESTNAME FAIL" > "$res_file" |
| 148 | + exit 0 |
| 149 | +fi |
| 150 | +log_info "Derived filesystem mount point: $FS_PATH" |
| 151 | + |
| 152 | + |
| 153 | +#file-system check |
| 154 | +if fs_type="$(df -Th "$FS_PATH" 2>/dev/null | awk 'NR==2{print $2}')"; then |
| 155 | + if [ -n "$fs_type" ]; then |
| 156 | + log_info "Filesystem at $FS_PATH: $fs_type" |
| 157 | + else |
| 158 | + log_warn "df -Th succeeded but could not parse filesystem type for $FS_PATH" |
| 159 | + fi |
| 160 | +else |
| 161 | + log_warn "df -Th failed for $FS_PATH" |
| 162 | +fi |
| 163 | + |
| 164 | +# Step 3: Add the key to the filesystem |
| 165 | +log_info "Adding encryption key to the filesystem" |
| 166 | +key_id=$("$FSCRYPTCTL" add_key "$FS_PATH" < "$KEY_FILE" 2>/dev/null) |
| 167 | +scan_dmesg_errors "$SCRIPT_DIR" "fscrypt" "" |
| 168 | + |
| 169 | +if [ -z "$key_id" ]; then |
| 170 | + log_fail "$TESTNAME : Failed to add encryption key" |
| 171 | + echo "$TESTNAME FAIL" > "$res_file" |
| 172 | + exit 0 |
| 173 | +fi |
| 174 | + |
| 175 | +log_info "Key ID: $key_id" |
| 176 | + |
| 177 | +# Step 4: Check key status |
| 178 | +log_info "Checking key status" |
| 179 | +status=$("$FSCRYPTCTL" key_status "$key_id" "$FS_PATH" 2>/dev/null) |
| 180 | +if [ -z "$status" ]; then |
| 181 | + log_fail "$TESTNAME : Failed to get key status" |
| 182 | + echo "$TESTNAME FAIL" > "$res_file" |
| 183 | + exit 0 |
| 184 | +fi |
| 185 | +log_info "Key Status: $status" |
| 186 | + |
| 187 | +if ! echo "$status" | grep -q "^Present"; then |
| 188 | + log_fail "$TESTNAME : Key is not usable (status: $status)" |
| 189 | + echo "$TESTNAME FAIL" > "$res_file" |
| 190 | + exit 0 |
| 191 | +fi |
| 192 | + |
| 193 | + |
| 194 | +# Step 5: Set encryption policy |
| 195 | +log_info "Setting encryption policy on $MOUNT_DIR" |
| 196 | + |
| 197 | +if ! "$FSCRYPTCTL" set_policy "$key_id" "$MOUNT_DIR"; then |
| 198 | + log_fail "$TESTNAME : Failed to set encryption policy" |
| 199 | + echo "$TESTNAME FAIL" > "$res_file" |
| 200 | + exit 0 |
| 201 | +fi |
| 202 | +scan_dmesg_errors "$SCRIPT_DIR" "fscrypt" "" |
| 203 | + |
| 204 | + |
| 205 | +# Step 6: Verify policy |
| 206 | +log_info "Verifying encryption policy" |
| 207 | +policy_output=$("$FSCRYPTCTL" get_policy "$MOUNT_DIR" 2>/dev/null) |
| 208 | +scan_dmesg_errors "$SCRIPT_DIR" "fscrypt" "" |
| 209 | + |
| 210 | + |
| 211 | +policy_key=$(echo "$policy_output" | awk -F': ' '/Master key identifier/ {print $2}' | tr -d '[:space:]') |
| 212 | + |
| 213 | +if [ "$policy_key" = "$key_id" ]; then |
| 214 | + log_info "Policy verification successful: Master key identifier matches key_id" |
| 215 | +else |
| 216 | + log_fail "$TESTNAME : Policy verification failed (expected $key_id, got $policy_key)" |
| 217 | + echo "$TESTNAME FAIL" > "$res_file" |
| 218 | + exit 0 |
| 219 | +fi |
| 220 | + |
| 221 | +# Step 7: Create and read a test file |
| 222 | +log_info "Creating test file in encrypted directory" |
| 223 | +echo "file" > "$MOUNT_DIR/file.txt" |
| 224 | + |
| 225 | +log_info "Reading test file" |
| 226 | +file_content=$(cat "$MOUNT_DIR/file.txt") |
| 227 | +if [ "$file_content" = "file" ]; then |
| 228 | + log_pass "$TESTNAME : Test Passed" |
| 229 | + echo "$TESTNAME PASS" > "$res_file" |
| 230 | +else |
| 231 | + log_fail "$TESTNAME : Test Failed" |
| 232 | + echo "$TESTNAME FAIL" > "$res_file" |
| 233 | + exit 0 |
| 234 | +fi |
| 235 | + |
| 236 | +log_info "-------------------Completed $TESTNAME Testcase----------------------------" |
0 commit comments