blob: 1241e899ca64bb9e46f5a5995bd0ea9eb55d605d [file] [log] [blame]
Wei Li73032c82023-03-15 18:31:38 +00001#!/bin/bash
2
3# Copyright (C) 2023 The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17set -uo pipefail
18
19# Integration test for verifying generated SBOM for cuttlefish device.
20
21if [ ! -e "build/make/core/Makefile" ]; then
22 echo "$0 must be run from the top of the Android source tree."
23 exit 1
24fi
25
Wei Licd9948f2023-06-22 17:52:31 -070026function setup {
27 tmp_dir="$(mktemp -d tmp.XXXXXX)"
28 trap 'cleanup "${tmp_dir}"' EXIT
29 echo "${tmp_dir}"
30}
31
Wei Li73032c82023-03-15 18:31:38 +000032function cleanup {
Wei Licd9948f2023-06-22 17:52:31 -070033 tmp_dir="$1"; shift
Wei Li73032c82023-03-15 18:31:38 +000034 rm -rf "${tmp_dir}"
35}
Wei Li8a8d5a92023-03-29 13:41:34 -070036
37function run_soong {
Wei Licd9948f2023-06-22 17:52:31 -070038 target_product="$1";shift
39 out_dir="$1"; shift
40 targets="$1"; shift
41 if [ "$#" -ge 1 ]; then
42 apps=$1; shift
43 TARGET_PRODUCT="${target_product}" TARGET_BUILD_VARIANT=userdebug OUT_DIR="${out_dir}" TARGET_BUILD_UNBUNDLED=true TARGET_BUILD_APPS=$apps build/soong/soong_ui.bash --make-mode ${targets}
44 else
45 TARGET_PRODUCT="${target_product}" TARGET_BUILD_VARIANT=userdebug OUT_DIR="${out_dir}" build/soong/soong_ui.bash --make-mode ${targets}
46 fi
Wei Li8a8d5a92023-03-29 13:41:34 -070047}
48
Wei Li7c1e7f02023-03-29 17:43:35 -070049function diff_files {
Wei Licd9948f2023-06-22 17:52:31 -070050 file_list_file="$1"; shift
51 files_in_spdx_file="$1"; shift
52 partition_name="$1"; shift
53 exclude=
54 if [ -v 'diff_excludes[$partition_name]' ]; then
55 exclude=${diff_excludes[$partition_name]}
Wei Li8a8d5a92023-03-29 13:41:34 -070056 fi
Wei Li8a8d5a92023-03-29 13:41:34 -070057
Wei Licd9948f2023-06-22 17:52:31 -070058 diff "$file_list_file" "$files_in_spdx_file" $exclude
59 if [ $? != "0" ]; then
60 echo Found diffs in $f and SBOM.
61 exit 1
62 else
63 echo No diffs.
64 fi
65}
Wei Li8a8d5a92023-03-29 13:41:34 -070066
Wei Licd9948f2023-06-22 17:52:31 -070067function test_sbom_aosp_cf_x86_64_phone {
68 # Setup
69 out_dir="$(setup)"
Wei Li8a8d5a92023-03-29 13:41:34 -070070
Wei Licd9948f2023-06-22 17:52:31 -070071 # Test
72 # m droid, build sbom later in case additional dependencies might be built and included in partition images.
73 run_soong "aosp_cf_x86_64_phone" "${out_dir}" "droid dump.erofs lz4"
Wei Li8a8d5a92023-03-29 13:41:34 -070074
Wei Licd9948f2023-06-22 17:52:31 -070075 product_out=$out_dir/target/product/vsoc_x86_64
76 sbom_test=$product_out/sbom_test
77 mkdir -p $sbom_test
78 cp $product_out/*.img $sbom_test
79
80 # m sbom
81 run_soong "aosp_cf_x86_64_phone" "${out_dir}" sbom
82
83 # Generate installed file list from .img files in PRODUCT_OUT
84 dump_erofs=$out_dir/host/linux-x86/bin/dump.erofs
85 lz4=$out_dir/host/linux-x86/bin/lz4
86
87 declare -A diff_excludes
88 diff_excludes[vendor]="-I /vendor/lib64/libkeystore2_crypto.so"
89 diff_excludes[system]="\
90 -I /bin \
91 -I /bugreports \
92 -I /cache \
93 -I /d \
94 -I /etc \
95 -I /init \
96 -I /odm/app \
97 -I /odm/bin \
98 -I /odm_dlkm/etc \
99 -I /odm/etc \
100 -I /odm/firmware \
101 -I /odm/framework \
102 -I /odm/lib \
103 -I /odm/lib64 \
104 -I /odm/overlay \
105 -I /odm/priv-app \
106 -I /odm/usr \
107 -I /sdcard \
108 -I /system/lib64/android.hardware.confirmationui@1.0.so \
109 -I /system/lib64/android.hardware.confirmationui-V1-ndk.so \
110 -I /system/lib64/android.hardware.keymaster@4.1.so \
111 -I /system/lib64/android.hardware.security.rkp-V3-ndk.so \
112 -I /system/lib64/android.hardware.security.sharedsecret-V1-ndk.so \
113 -I /system/lib64/android.security.compat-ndk.so \
Wei Li9a8df662023-07-13 10:29:55 -0700114 -I /system/lib64/libcuttlefish_allocd_utils.so \
115 -I /system/lib64/libcuttlefish_device_config_proto.so \
116 -I /system/lib64/libcuttlefish_device_config.so \
117 -I /system/lib64/libcuttlefish_fs.so \
118 -I /system/lib64/libcuttlefish_kernel_log_monitor_utils.so \
119 -I /system/lib64/libcuttlefish_utils.so \
120 -I /system/lib64/libfruit.so \
121 -I /system/lib64/libgflags.so \
Wei Licd9948f2023-06-22 17:52:31 -0700122 -I /system/lib64/libkeymaster4_1support.so \
123 -I /system/lib64/libkeymaster4support.so \
124 -I /system/lib64/libkeymint.so \
125 -I /system/lib64/libkeystore2_aaid.so \
126 -I /system/lib64/libkeystore2_apc_compat.so \
127 -I /system/lib64/libkeystore2_crypto.so \
128 -I /system/lib64/libkeystore-attestation-application-id.so \
129 -I /system/lib64/libkm_compat_service.so \
130 -I /system/lib64/libkm_compat.so \
131 -I /system/lib64/vndk-29 \
132 -I /system/lib64/vndk-sp-29 \
133 -I /system/lib/vndk-29 \
134 -I /system/lib/vndk-sp-29 \
135 -I /system/usr/icu \
136 -I /vendor_dlkm/etc"
137
138 # Example output of dump.erofs is as below, and the data used in the test start
139 # at line 11. Column 1 is inode id, column 2 is inode type and column 3 is name.
140 # Each line is captured in variable "entry", awk is used to get type and name.
141 # Output of dump.erofs:
142 # File : /
143 # Size: 160 On-disk size: 160 directory
144 # NID: 39 Links: 10 Layout: 2 Compression ratio: 100.00%
145 # Inode size: 64 Extent size: 0 Xattr size: 16
146 # Uid: 0 Gid: 0 Access: 0755/rwxr-xr-x
147 # Timestamp: 2023-02-14 01:15:54.000000000
148 #
149 # NID TYPE FILENAME
150 # 39 2 .
151 # 39 2 ..
152 # 47 2 app
153 # 1286748 2 bin
154 # 1286754 2 etc
155 # 5304814 2 lib
156 # 5309056 2 lib64
157 # 5309130 2 media
158 # 5388910 2 overlay
159 # 5479537 2 priv-app
160 EROFS_IMAGES="\
161 $sbom_test/product.img \
162 $sbom_test/system.img \
163 $sbom_test/system_ext.img \
164 $sbom_test/system_dlkm.img \
165 $sbom_test/system_other.img \
166 $sbom_test/odm.img \
167 $sbom_test/odm_dlkm.img \
168 $sbom_test/vendor.img \
169 $sbom_test/vendor_dlkm.img"
170 for f in $EROFS_IMAGES; do
171 partition_name=$(basename $f | cut -d. -f1)
172 file_list_file="${sbom_test}/sbom-${partition_name}-files.txt"
173 files_in_spdx_file="${sbom_test}/sbom-${partition_name}-files-in-spdx.txt"
174 rm "$file_list_file" > /dev/null 2>&1 || true
175 all_dirs="/"
176 while [ ! -z "$all_dirs" ]; do
177 dir=$(echo "$all_dirs" | cut -d ' ' -f1)
178 all_dirs=$(echo "$all_dirs" | cut -d ' ' -f1 --complement -s)
179 entries=$($dump_erofs --ls --path "$dir" $f | tail -n +11)
180 while read -r entry; do
181 inode_type=$(echo $entry | awk -F ' ' '{print $2}')
182 name=$(echo $entry | awk -F ' ' '{print $3}')
183 case $inode_type in
184 "2") # directory
185 all_dirs=$(echo "$all_dirs $dir/$name" | sed 's/^\s*//')
186 ;;
187 "1"|"7") # 1: file, 7: symlink
188 (
189 if [ "$partition_name" != "system" ]; then
190 # system partition is mounted to /, not to prepend partition name.
191 printf %s "/$partition_name"
192 fi
193 echo "$dir/$name" | sed 's#^//#/#'
194 ) >> "$file_list_file"
195 ;;
196 esac
197 done <<< "$entries"
198 done
199 sort -n -o "$file_list_file" "$file_list_file"
200
201 grep "FileName: /${partition_name}/" $product_out/sbom.spdx | sed 's/^FileName: //' > "$files_in_spdx_file"
202 if [ "$partition_name" = "system" ]; then
203 # system partition is mounted to /, so include FileName starts with /root/ too.
204 grep "FileName: /root/" $product_out/sbom.spdx | sed 's/^FileName: \/root//' >> "$files_in_spdx_file"
205 fi
206 sort -n -o "$files_in_spdx_file" "$files_in_spdx_file"
207
208 echo ============ Diffing files in $f and SBOM
209 diff_files "$file_list_file" "$files_in_spdx_file" "$partition_name"
210 done
211
212 RAMDISK_IMAGES="$product_out/ramdisk.img"
213 for f in $RAMDISK_IMAGES; do
214 partition_name=$(basename $f | cut -d. -f1)
215 file_list_file="${sbom_test}/sbom-${partition_name}-files.txt"
216 files_in_spdx_file="${sbom_test}/sbom-${partition_name}-files-in-spdx.txt"
217 # lz4 decompress $f to stdout
218 # cpio list all entries like ls -l
219 # grep filter normal files and symlinks
220 # awk get entry names
221 # sed remove partition name from entry names
222 $lz4 -c -d $f | cpio -tv 2>/dev/null | grep '^[-l]' | awk -F ' ' '{print $9}' | sed "s:^:/$partition_name/:" | sort -n > "$file_list_file"
223
224 grep "FileName: /${partition_name}/" $product_out/sbom.spdx | sed 's/^FileName: //' | sort -n > "$files_in_spdx_file"
225
226 echo ============ Diffing files in $f and SBOM
227 diff_files "$file_list_file" "$files_in_spdx_file" "$partition_name"
228 done
229
230 # Teardown
231 cleanup "${out_dir}"
232}
233
Wei Li59df0ee2023-07-10 15:50:38 -0700234function test_sbom_unbundled_apex {
235 # Setup
236 out_dir="$(setup)"
237
238 # run_soong to build com.android.adbd.apex
239 run_soong "module_arm64" "${out_dir}" "sbom deapexer" "com.android.adbd"
240
241 deapexer=${out_dir}/host/linux-x86/bin/deapexer
242 debugfs=${out_dir}/host/linux-x86/bin/debugfs_static
243 apex_file=${out_dir}/target/product/module_arm64/system/apex/com.android.adbd.apex
244 echo "============ Diffing files in $apex_file and SBOM"
245 set +e
246 # deapexer prints the list of all files and directories
247 # sed extracts the file/directory names
248 # grep removes directories
249 # sed removes leading ./ in file names
250 diff -I /system/apex/com.android.adbd.apex -I apex_manifest.pb \
251 <($deapexer --debugfs_path=$debugfs list --extents ${apex_file} | sed -E 's#(.*) \[.*\]$#\1#' | grep -v "/$" | sed -E 's#^\./(.*)#\1#' | sort -n) \
252 <(grep '"fileName": ' ${apex_file}.spdx.json | sed -E 's/.*"fileName": "(.*)",/\1/' | sort -n )
253
254 if [ $? != "0" ]; then
255 echo "Diffs found in $apex_file and SBOM"
256 exit 1
257 else
258 echo "No diffs."
259 fi
260 set -e
261
262 # Teardown
263 cleanup "${out_dir}"
264}
265
266function test_sbom_unbundled_apk {
267 # Setup
268 out_dir="$(setup)"
269
270 # run_soong to build Browser2.apk
271 run_soong "module_arm64" "${out_dir}" "sbom" "Browser2"
272
273 sbom_file=${out_dir}/target/product/module_arm64/system/product/app/Browser2/Browser2.apk.spdx.json
274 echo "============ Diffing files in Browser2.apk and SBOM"
275 set +e
276 # There is only one file in SBOM of APKs
277 diff \
278 <(echo "/system/product/app/Browser2/Browser2.apk" ) \
279 <(grep '"fileName": ' ${sbom_file} | sed -E 's/.*"fileName": "(.*)",/\1/' )
280
281 if [ $? != "0" ]; then
282 echo "Diffs found in $sbom_file"
283 exit 1
284 else
285 echo "No diffs."
286 fi
287 set -e
288
289 # Teardown
290 cleanup "${out_dir}"
291}
292
293test_sbom_aosp_cf_x86_64_phone
294test_sbom_unbundled_apex
295test_sbom_unbundled_apk