Skip to content

Commit f844e01

Browse files
committed
Add: Qualcomm User Data Encryption test script & Document
- Checks for fscryptctl binary presence - Creates a random sw encryption key - Applies and verifies encryption policy - Confirms functionality with a test file Signed-off-by: Bharani Bhuvanagiri <[email protected]>
1 parent 2ef8a98 commit f844e01

File tree

2 files changed

+256
-0
lines changed

2 files changed

+256
-0
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
2+
SPDX-License-Identifier: BSD-3-Clause-Clear
3+
4+
# Qualcomm UserDataEncryption Functionality Test Script
5+
## Overview
6+
7+
The `UserDataEncryption` test script verifies basic filesystem encryption functionality. It generates a 64-byte key, adds it to the system, applies an encryption policy to a mount directory, and confirms the setup by creating and reading a test file. This ensures that key management and encryption policies work as expected.
8+
9+
## Features
10+
11+
- **Dependency Check**: Verifies the presence of the `fscryptctl` binary.
12+
- **Key Management**: Generates a 64-byte key and adds it to the filesystem.
13+
- **Encryption Policy**: Applies and verifies encryption policy on a mount directory.
14+
- **Functional Validation**: Creates and reads a test file to confirm encryption functionality.
15+
- **Automated Result Logging**: Outputs test results to a `.res` file for automated result collection.
16+
17+
## Prerequisites
18+
19+
Ensure the following components are present on the target device:
20+
21+
- `fscryptctl` binary available in `/data/`
22+
- Sufficient permissions to create and mount directories
23+
24+
## Directory Structure
25+
```
26+
Runner/
27+
├── suites/
28+
│ ├── Kernel/
29+
│ │ │ ├── baseport/
30+
│ │ │ │ ├── UserDataEncryption/
31+
│ │ │ │ │ ├── run.sh
32+
```
33+
## Usage
34+
35+
1. Copy repo to Target Device: Use scp to transfer the scripts from the host to the target device. The scripts should be copied to the ```/<user-defined-location>``` directory on the target device.
36+
37+
2. Verify Transfer: Ensure that the repo have been successfully copied to the ```/<user-defined-location>``` directory on the target device.
38+
39+
3. Run Scripts: Navigate to the ```/<user-defined-location>``` directory on the target device and execute the scripts as needed.
40+
41+
---
42+
Quick Example
43+
```
44+
git clone <this-repo>
45+
cd <this-repo>
46+
scp -r common Runner user@target_device_ip:/<user-defined-location>
47+
ssh user@target_device_ip
48+
cd /<user-defined-location>/Runner && ./run-test.sh UserDataEncryption
49+
50+
Sample output:
51+
sh-5.2# ./run-test.sh UserDataEncryption
52+
[Executing test case: UserDataEncryption] 2025-05-31 17:13:10 -
53+
[INFO] Running as root. Continuing...
54+
[INFO] 2025-05-31 17:13:10 - -----------------------------------------------------------------------------------------
55+
[INFO] 2025-05-31 17:13:10 - -------------------Starting UserDataEncryption Testcase----------------------------
56+
[INFO] 2025-05-31 17:13:10 - === Test Initialization ===
57+
[INFO] 2025-05-31 17:13:10 - Checking if dependency binary is available
58+
[INFO] Temporary key file created: /tmp/tmp.S5bQAGLiuN
59+
[INFO] 2025-05-31 17:13:10 - Generating 64-byte encryption key
60+
[INFO] 2025-05-31 17:13:10 - Creating mount folder at /mnt/testing
61+
[INFO] 2025-05-31 17:13:10 - Adding encryption key to the filesystem
62+
[INFO] 2025-05-31 17:13:10 - Key ID: 73edbca4024c81360bd0b1bf6b771738
63+
[INFO] 2025-05-31 17:13:10 - Checking key status
64+
[INFO] 2025-05-31 17:13:10 - Key Status: Present (user_count=1, added_by_self)
65+
[INFO] 2025-05-31 17:13:10 - Setting encryption policy on /mnt/testing
66+
[INFO] 2025-05-31 17:13:10 - Verifying encryption policy
67+
[INFO] 2025-05-31 17:13:10 - Policy verification successful
68+
[INFO] 2025-05-31 17:13:10 - Creating test file in encrypted directory
69+
[INFO] 2025-05-31 17:13:10 - Reading test file
70+
[PASS] 2025-05-31 17:13:10 - UserDataEncryption : Test Passed
71+
[INFO] 2025-05-31 17:13:11 - -------------------Completed UserDataEncryption Testcase----------------------------
72+
[PASS] 2025-05-31 17:13:11 - UserDataEncryption passed
73+
74+
[INFO] 2025-05-31 17:13:11 - ========== Test Summary ==========
75+
PASSED:
76+
UserDataEncryption
77+
78+
FAILED:
79+
None
80+
81+
SKIPPED:
82+
None
83+
[INFO] 2025-05-31 17:13:11 - ==================================
84+
[INFO] Done.
85+
```
86+
4. Results will be available in the `/<user-defined-location>/Runner/suites/Kernel/baseport/UserDataEncryption/` directory.
87+
88+
## Notes
89+
90+
- The script uses /data/UserDataEncryption for all operations.
91+
- Temporary files such as the encryption key are cleaned up after the test.
92+
- If any test fails, the script logs the error and exits with a failure code.
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
#!/bin/sh
2+
3+
# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
4+
# SPDX-License-Identifier: BSD-3-Clause-Clear
5+
6+
# Ensure script runs as root
7+
if [ "$(id -u)" -ne 0 ]; then
8+
echo "[ERROR] This script must be run as root." >&2
9+
exit 1
10+
else
11+
echo "[INFO] Running as root. Continuing..."
12+
fi
13+
14+
# Robustly find and source init_env
15+
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
16+
INIT_ENV=""
17+
SEARCH="$SCRIPT_DIR"
18+
while [ "$SEARCH" != "/" ]; do
19+
if [ -f "$SEARCH/init_env" ]; then
20+
INIT_ENV="$SEARCH/init_env"
21+
break
22+
fi
23+
SEARCH=$(dirname "$SEARCH")
24+
done
25+
26+
if [ -z "$INIT_ENV" ]; then
27+
echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2
28+
exit 1
29+
fi
30+
31+
if [ -z "$__INIT_ENV_LOADED" ]; then
32+
# shellcheck disable=SC1090
33+
. "$INIT_ENV"
34+
fi
35+
36+
# shellcheck disable=SC1090,SC1091
37+
. "$TOOLS/functestlib.sh"
38+
39+
FSCRYPTCTL="${FSCRYPTCTL:-fscryptctl}"
40+
TESTNAME="UserDataEncryption"
41+
test_path=$(find_test_case_by_name "$TESTNAME")
42+
cd "$test_path" || exit 1
43+
res_file="./$TESTNAME.res"
44+
FS_PATH="/mnt"
45+
46+
# Globals that cleanup will use
47+
key_id=""
48+
KEY_FILE=""
49+
50+
cleanup() {
51+
if [ -n "$key_id" ]; then
52+
"$FSCRYPTCTL" remove_key "$key_id" "$FS_PATH" >/dev/null 2>&1 || true
53+
fi
54+
[ -n "$KEY_FILE" ] && rm -f "$KEY_FILE" 2>/dev/null || true
55+
rm -f "$MOUNT_DIR/file.txt" 2>/dev/null || true
56+
rmdir "$MOUNT_DIR" 2>/dev/null || true
57+
}
58+
59+
# Run cleanup on normal exit, Ctrl-C, or SIGTERM
60+
trap cleanup EXIT INT TERM
61+
62+
log_info "-----------------------------------------------------------------------------------------"
63+
log_info "-------------------Starting $TESTNAME Testcase----------------------------"
64+
log_info "=== Test Initialization ==="
65+
66+
log_info "Checking if dependency binary is available"
67+
check_dependencies "$FSCRYPTCTL"
68+
69+
# Create a secure temporary file for the key
70+
if KEY_FILE="$(mktemp)"; then
71+
echo "[INFO] Temporary key file created: $KEY_FILE"
72+
chmod 600 "$KEY_FILE"
73+
else
74+
echo "[ERROR] Failed to create temporary key file" >&2
75+
exit 1
76+
fi
77+
78+
MOUNT_DIR="/mnt/testing"
79+
80+
# Step 1: Generate a 64-byte key
81+
log_info "Generating 64-byte encryption key"
82+
if ! head -c 64 /dev/urandom > "$KEY_FILE"; then
83+
log_fail "$TESTNAME : Failed to generate encryption key"
84+
echo "$TESTNAME FAIL" > "$res_file"
85+
exit 1
86+
fi
87+
88+
# Step 2: Create mount folder
89+
log_info "Creating mount folder at $MOUNT_DIR"
90+
if [ -d "$MOUNT_DIR" ]; then
91+
log_info "$MOUNT_DIR already exists. Deleting it first."
92+
if ! rm -rf "$MOUNT_DIR"; then
93+
log_fail "$TESTNAME : Failed to delete existing mount directory"
94+
echo "$TESTNAME FAIL" > "$res_file"
95+
exit 1
96+
fi
97+
fi
98+
99+
if ! mkdir -p "$MOUNT_DIR"; then
100+
log_fail "$TESTNAME : Failed to create mount directory"
101+
echo "$TESTNAME FAIL" > "$res_file"
102+
exit 1
103+
fi
104+
105+
# Step 3: Add the key to the filesystem
106+
log_info "Adding encryption key to the filesystem"
107+
key_id=$("$FSCRYPTCTL" add_key "$FS_PATH" < "$KEY_FILE" 2>/dev/null)
108+
if [ -z "$key_id" ]; then
109+
log_fail "$TESTNAME : Failed to add encryption key"
110+
echo "$TESTNAME FAIL" > "$res_file"
111+
exit 1
112+
fi
113+
114+
log_info "Key ID: $key_id"
115+
116+
# Step 4: Check key status
117+
log_info "Checking key status"
118+
status=$("$FSCRYPTCTL" key_status "$key_id" "$FS_PATH" 2>/dev/null)
119+
if [ -z "$status" ]; then
120+
log_fail "$TESTNAME : Failed to get key status"
121+
echo "$TESTNAME FAIL" > "$res_file"
122+
exit 1
123+
fi
124+
log_info "Key Status: $status"
125+
126+
# Step 5: Set encryption policy
127+
log_info "Setting encryption policy on $MOUNT_DIR"
128+
if ! "$FSCRYPTCTL" set_policy "$key_id" "$MOUNT_DIR"; then
129+
log_fail "$TESTNAME : Failed to set encryption policy"
130+
echo "$TESTNAME FAIL" > "$res_file"
131+
exit 1
132+
fi
133+
134+
# Step 6: Verify policy
135+
log_info "Verifying encryption policy"
136+
policy_output=$("$FSCRYPTCTL" get_policy "$MOUNT_DIR" 2>/dev/null)
137+
if echo "$policy_output" | grep -q "$key_id"; then
138+
log_info "Policy verification successful"
139+
else
140+
log_fail "$TESTNAME : Policy verification failed"
141+
echo "$TESTNAME FAIL" > "$res_file"
142+
exit 1
143+
fi
144+
145+
# Step 7: Create and read a test file
146+
log_info "Creating test file in encrypted directory"
147+
echo "file" > "$MOUNT_DIR/file.txt"
148+
149+
log_info "Reading test file"
150+
file_content=$(cat "$MOUNT_DIR/file.txt")
151+
if [ "$file_content" = "file" ]; then
152+
log_pass "$TESTNAME : Test Passed"
153+
echo "$TESTNAME PASS" > "$res_file"
154+
else
155+
log_fail "$TESTNAME : Test Failed"
156+
echo "$TESTNAME FAIL" > "$res_file"
157+
exit 1
158+
fi
159+
160+
# Cleanup
161+
rm -f "$MOUNT_DIR/file.txt"
162+
rmdir "$MOUNT_DIR"
163+
164+
log_info "-------------------Completed $TESTNAME Testcase----------------------------"

0 commit comments

Comments
 (0)