4ce70f9f78d9dc5259e2fa42109e8e37520ff0f9
[platform/upstream/cryptsetup.git] / tests / verity-compat-test
1 #!/bin/bash
2
3 [ -z "$CRYPTSETUP_PATH" ] && CRYPTSETUP_PATH=".."
4 VERITYSETUP=$CRYPTSETUP_PATH/veritysetup
5 VERITYSETUP_VALGRIND=../.libs/veritysetup
6 VERITYSETUP_LIB_VALGRIND=../.libs
7
8 DEV_NAME=verity3273
9 DEV_OUT="$DEV_NAME.out"
10 IMG=verity-data
11 IMG_HASH=verity-hash
12 IMG_TMP=tst-dev
13 FEC_DEV=tst_fec123
14 # If we need deterministic image creation
15 DEV_SALT=9e7457222290f1bac0d42ad2de2d602a87bb871c22ab70ca040bad450578a436
16 DEV_UUID=a60c98d2-ae9b-4865-bfcb-b4e3ace11033
17
18 function remove_mapping()
19 {
20         [ -b /dev/mapper/$DEV_NAME ] && dmsetup remove $DEV_NAME >/dev/null 2>&1
21         [ ! -z "$LOOPDEV1" ] && losetup -d $LOOPDEV1 >/dev/null 2>&1
22         rm -f $IMG $IMG_HASH $DEV_OUT $FEC_DEV $IMG_TMP  >/dev/null 2>&1
23         LOOPDEV1=""
24         LOOPDEV2=""
25 }
26
27 function fail()
28 {
29         [ -n "$1" ] && echo "$1"
30         echo "FAILED backtrace:"
31         while caller $frame; do ((frame++)); done
32         [ -f $DEV_OUT ] && cat $DEV_OUT
33         remove_mapping
34         exit 2
35 }
36
37 function skip()
38 {
39         [ -n "$1" ] && echo "$1"
40         exit 77
41 }
42
43 function prepare() # $1 dev1_siz [$2 dev2_size]
44 {
45         remove_mapping
46
47         dd if=/dev/zero of=$IMG bs=1k count=$1 >/dev/null 2>&1
48         LOOPDEV1=$(losetup -f 2>/dev/null)
49         [ -z "$LOOPDEV1" ] && fail "No free loop device"
50         losetup $LOOPDEV1 $IMG
51
52         [ -z "$2" ] && return
53         LOOPDEV2=$IMG_HASH
54 }
55
56 function wipe()
57 {
58         dd if=/dev/zero of=$LOOPDEV1 bs=256k >/dev/null 2>&1
59         rm -f $IMG_HASH $DEV_OUT >/dev/null 2>&1
60 }
61
62 function check_exists()
63 {
64         [ -b /dev/mapper/$DEV_NAME ] || fail
65 }
66
67 function check_version() # MAJ MIN
68 {
69         VER_STR=$(dmsetup targets | grep verity | cut -f 3 -dv)
70         [ -z "$VER_STR" ] && fail "Failed to parse dm-verity version."
71
72         VER_MAJ=$(echo $VER_STR | cut -f 1 -d.)
73         VER_MIN=$(echo $VER_STR | cut -f 2 -d.)
74
75         test $VER_MAJ -gt $1 && return 0
76         test $VER_MIN -ge $2 && return 0
77         return 1
78 }
79
80 function compare_out() # $1 what, $2 expected
81 {
82         OPT=$(grep -v "^#" $DEV_OUT | grep -i "$1" | sed -e s/.*\:\ // )
83         [ -z "$OPT" ] && fail
84         [ $OPT != $2 ] && fail "$1 differs ($2)"
85 }
86
87 function check_root_hash() # $1 size, $2 hash, $3 salt, $4 version, $5 hash, [$6 offset]
88 {
89         if [ -z "$LOOPDEV2" ] ; then
90                 BLOCKS=$(($6 / $1))
91                 DEV_PARAMS="$LOOPDEV1 $LOOPDEV1 \
92                            --hash-offset $6 \
93                            --data-blocks=$BLOCKS --debug"
94         else
95                 DEV_PARAMS="$LOOPDEV1 $LOOPDEV2"
96         fi
97
98         for sb in yes no; do
99         FORMAT_PARAMS="--format=$4 --data-block-size=$1 --hash-block-size=$1 --hash=$5 --salt=$3"
100         if [ $sb == yes ] ; then
101                 VERIFY_PARAMS=""
102         else
103                 FORMAT_PARAMS="$FORMAT_PARAMS --no-superblock"
104                 VERIFY_PARAMS=$FORMAT_PARAMS
105         fi
106
107         for fail in data hash; do
108         wipe
109         echo -n "V$4(sb=$sb) $5 block size $1: "
110         $VERITYSETUP format $DEV_PARAMS $FORMAT_PARAMS >$DEV_OUT || fail
111
112         echo -n "[root hash]"
113         compare_out "root hash" $2
114         compare_out "salt" "$3"
115
116         $VERITYSETUP verify $DEV_PARAMS $VERIFY_PARAMS $2 >>$DEV_OUT 2>&1 || fail
117         echo -n "[verify]"
118
119         $VERITYSETUP create $DEV_NAME $DEV_PARAMS $VERIFY_PARAMS $2  >>$DEV_OUT 2>&1 || fail
120         check_exists
121         echo -n "[activate]"
122
123         dd if=/dev/mapper/$DEV_NAME of=/dev/null bs=$1 2>/dev/null
124         dmsetup status $DEV_NAME | grep "verity V" >/dev/null || fail
125         echo -n "[in-kernel verify]"
126
127         $VERITYSETUP close $DEV_NAME >/dev/null 2>&1 || fail
128
129         case $fail in
130         data)
131                 dd if=/dev/urandom of=$LOOPDEV1 bs=1 seek=3456 count=8 conv=notrunc 2>/dev/null
132                 TXT="data_dev"
133                 ;;
134         hash)
135                 if [ -z "$LOOPDEV2" ] ; then
136                         dd if=/dev/urandom of=$LOOPDEV1 bs=1 seek=$((8193 + $4)) count=8 conv=notrunc 2>/dev/null
137                 else
138                         dd if=/dev/urandom of=$LOOPDEV2 bs=1 seek=8193 count=8 conv=notrunc 2>/dev/null
139                 fi
140                 TXT="hash_dev"
141                 ;;
142         esac
143
144         $VERITYSETUP verify $DEV_PARAMS $VERIFY_PARAMS $2 >>$DEV_OUT 2>&1 && \
145                 fail "userspace check for $TXT corruption"
146         $VERITYSETUP create $DEV_NAME $DEV_PARAMS $VERIFY_PARAMS $2 >>$DEV_OUT 2>&1 || \
147                 fail "activation"
148         dd if=/dev/mapper/$DEV_NAME of=/dev/null bs=$1 2>/dev/null
149         dmsetup status $DEV_NAME | grep "verity V" >/dev/null && \
150                 fail "in-kernel check for $TXT corruption"
151         $VERITYSETUP close $DEV_NAME >/dev/null 2>&1 || fail "deactivation"
152         echo "[$TXT corruption]"
153         done
154         done
155 }
156
157 function corrupt_device() # $1 device, $2 device_size(in bytes), $3 #{corrupted_bytes}
158 {
159         # Repeatable magic corruption :-)
160         CORRUPT=$3
161         RANDOM=43
162         while [ "$CORRUPT" -gt 0 ]; do
163                 SEEK=$RANDOM
164                 while [ $SEEK -ge $2 ] ; do SEEK=$RANDOM; done
165                 echo -n -e "\x55" | dd of=$1 bs=1 count=1 seek=$SEEK conv=notrunc > /dev/null 2>&1
166                 CORRUPT=$(($CORRUPT - 1))
167         done
168 }
169
170 # $1 data_device, $2 hash_device, $3 fec_device, $4 data/hash_block_size(in bytes),
171 # $5 data_size(in blocks), $6 device_size(in blocks), $7 hash_offset(in bytes),
172 # $8 fec_offset(in bytes), $9 fec_roots, ${10} corrupted_bytes, [${11} superblock(y/n), ${12} salt]
173 function check_fec()
174 {
175         INDEX=25
176         dd if=/dev/zero of=$1 bs=$4 count=$6 > /dev/null 2>&1
177
178         echo -n "Block_size: $4, Data_size: $(($4 * $5))B, FEC_roots: $9, Corrupted_bytes: ${10} "
179
180         PARAMS=" --data-block-size=$4 --hash-block-size=$4 "
181         if [ "$5" -ne "$6" ]; then
182                 PARAMS="$PARAMS --data-blocks=$5"
183         fi
184
185         if [ "$7" -ne 0 ]; then
186                 PARAMS="$PARAMS --hash-offset=$7"
187         fi
188
189         if [ "$8" -ne 0 ]; then
190                 PARAMS="$PARAMS --fec-offset=$8"
191         fi
192
193         if [ "${11}" == "n" ]; then
194                 INDEX=24
195                 echo -n "[no-superblock]"
196                 PARAMS="$PARAMS --no-superblock -s=${12}"
197         elif [ -n "${12}" ]; then
198                 PARAMS="$PARAMS -s=${12}"
199         fi
200
201         if [[ "$1" == "$2" && "$1" == "$3" ]]; then
202                 echo -n "[one_device_test]"
203                 dd if=/dev/zero of=$IMG_TMP bs=$4 count=$5  > /dev/null 2>&1
204                 ARR=(`sha256sum $IMG_TMP`)
205                 HASH_ORIG=${ARR[0]}
206         else
207                 ARR=(`sha256sum $1`)
208                 HASH_ORIG=${ARR[0]}
209         fi
210
211         ARR=(`$VERITYSETUP format $1 $2 --fec-device=$3 $PARAMS`)
212         SALT=${ARR[$INDEX]}
213         ROOT_HASH=${ARR[$(($INDEX+3))]}
214
215         corrupt_device $1 $(($5 * $4)) ${10}
216
217         $VERITYSETUP create $DEV_NAME $1 $2 $ROOT_HASH --fec-device=$3 $PARAMS > /dev/null 2>&1
218         if [ "$?" -ne "0" ] ; then
219                 echo "[N/A, test skipped]"
220                 return 3
221         fi
222
223         udevadm settle
224
225         dd if=/dev/mapper/$DEV_NAME of=$IMG_TMP > /dev/null 2>&1
226         ARR=(`sha256sum $IMG_TMP`)
227
228         HASH_REPAIRED=${ARR[0]}
229
230         $VERITYSETUP close $DEV_NAME
231         rm $1 $2 $3 $IMG_TMP > /dev/null 2>&1
232
233         if [ "$HASH_ORIG" != "$HASH_REPAIRED" ]; then
234                 echo -n "[correction failed]"
235                 return 1
236         fi
237
238         echo "[file was repaired][OK]"
239 }
240
241 function check_option() # $1 size, $2 hash, $3 salt, $4 version, $5 hash, $6 CLI option, $7 status option
242 {
243         DEV_PARAMS="$LOOPDEV1 $LOOPDEV2"
244         FORMAT_PARAMS="--format=$4 --data-block-size=$1 --hash-block-size=$1 --hash=$5 --salt=$3"
245
246         echo -n "Option $6 "
247         $VERITYSETUP format $DEV_PARAMS $FORMAT_PARAMS >/dev/null 2>&1 || fail
248         $VERITYSETUP create $DEV_NAME $DEV_PARAMS $2 $6 >/dev/null 2>&1 || fail
249         check_exists
250         $VERITYSETUP status $DEV_NAME 2>/dev/null | grep flags | grep -q $7 || fail
251         dmsetup table $DEV_NAME 2>/dev/null | grep -q $7 || fail
252         $VERITYSETUP close $DEV_NAME >/dev/null 2>&1 || fail
253         echo "[OK]"
254 }
255
256 function valgrind_setup()
257 {
258         which valgrind >/dev/null 2>&1 || fail "Cannot find valgrind."
259         [ ! -f $VERITYSETUP_VALGRIND ] && fail "Unable to get location of veritysetup executable."
260         export LD_LIBRARY_PATH="$VERITYSETUP_LIB_VALGRIND:$LD_LIBRARY_PATH"
261 }
262
263 function valgrind_run()
264 {
265         INFOSTRING="$(basename ${BASH_SOURCE[1]})-line-${BASH_LINENO[0]}" ./valg.sh ${VERITYSETUP_VALGRIND} "$@"
266 }
267
268 function checkOffsetBug() # $1 size, $2 hash-offset, $3 data-blocks
269 {
270         echo -n "Size :: $1 B | Hash-offset :: $2 blocks | Data-blocks :: $3 "
271         dd if=/dev/zero of=$IMG bs=1 count=0 seek=$1 >/dev/null 2>&1
272         $VERITYSETUP --data-blocks=$3 --hash-offset=$2 format $IMG $IMG >/dev/null 2>&1 || fail "Test [hash-offset greater than 2G] failed"
273         echo "[OK]"
274         remove_mapping
275 }
276
277 function checkOverlapBug() # $1 size, $2 hash-offset, $3 data-blocks, $4 block_size, $5 fec_offset
278 {
279         echo -n "Device-size :: $1 B | "
280         [ $# -ge 3 ] && echo -n "Data-blocks :: $3 blocks| "
281         [ $# -lt 3 ] && echo -n "Data-blocks :: whole device | "
282         [ $# -ge 4 ] && echo -n "Block-size :: $4 B | "
283         [ $# -lt 4 ] && echo -n "Block-size :: 4096 B | "
284         echo -n "Hash-offset :: $2 B | "
285
286         dd if=/dev/zero of=$IMG bs=1 count=0 seek=$1 >/dev/null 2>&1
287         if [ -z $3 ] ; then
288                 # veritysetup must fail
289                 $VERITYSETUP --hash-offset=$2 format $IMG $IMG >/dev/null 2>&1 && fail "Test [overlap with option \"--data-blocks\" not entered] failed"
290         else
291                 $VERITYSETUP --data-block-size=$4 --hash-block-size=$4 --data-blocks=$3 --hash-offset=$2 format $IMG $IMG >/dev/null 2>&1
292                 RET=$?
293                 [ "$3" -gt "$(($2 / $4))" ] && [ "$RET" -eq "0" ] && fail "Test [overlap - hash-offset in data area] failed"
294         fi
295
296         if [ $# -eq 5 ] ; then
297                 echo -n "FEC-offset :: $5 B | "
298                 PARAMS="--data-block-size=$4 --hash-block-size=$4 --data-blocks=$3 --fec-device=$IMG --fec-offset=$5"
299
300                 # test data-fec area overlap
301                 $VERITYSETUP format $IMG $IMG_HASH $PARAMS >/dev/null 2>&1
302                 RET=$?
303                 [ "$(($3*$4))" -gt "$5" ] && [ "$RET" -eq "0" ] && fail "Test [data/fec area overlap] failed"
304
305                 HASH_SIZE=$(stat --printf="%s" $IMG_HASH)
306
307                 # test hash-fec area overlap
308                 $VERITYSETUP format $IMG $IMG $PARAMS --hash-offset=$2 >/dev/null 2>&1
309                 RET=$?
310                 [ "$(($2 + $HASH_SIZE))" -gt "$5" ] && [ "$RET" -eq "0" ] && fail "Test [hash/fec area overlap] failed"
311         fi
312
313         echo "[OK]"
314         remove_mapping
315 }
316
317 # $1 size, $2 block size, $3 roots, $4 hash offset, $5 fec offset,
318 # $6 one dev(1 - one device, 2 - one device for data and hash, one device for fec data, 3 - three separate devices),
319 # $7 #{corrupted bytes}
320 function checkUserSpaceRepair()
321 {
322         BS=512
323         COUNT=50000
324         dd if=/dev/zero of=$IMG bs=$BS count=$COUNT >/dev/null 2>&1
325         PARAMS="--data-block-size=$2 --hash-block-size=$2 --fec-roots=$3"
326         [ "$1" -gt 0 ] && PARAMS="$PARAMS --data-blocks=$1" && BS=$2 && COUNT=$1
327
328         # different parameters for different number of devices
329         [ "$6" -eq 1 ] && HASH_DEV=$IMG && FEC=$IMG && PARAMS="$PARAMS --hash-offset=$4 --fec-offset=$5" && echo -n "[One device]"
330         [ "$6" -eq 2 ] && HASH_DEV=$IMG && FEC=$FEC_DEV && PARAMS="$PARAMS --hash-offset=$4" && echo -n "[Two separate data/hash and fec devices]"
331         [ "$6" -eq 3 ] && HASH_DEV=$IMG_HASH && FEC=$FEC_DEV && echo -n "[Three separate devices]"
332
333         echo -n "[nroots::$3]"
334
335         ARR=(`$VERITYSETUP format $IMG $HASH_DEV --fec-device $FEC $PARAMS --salt=$DEV_SALT --uuid=$DEV_UUID`)
336         ROOT_HASH=${ARR[28]}
337
338         echo -n "[Errors can be corrected]"
339         corrupt_device $IMG $(($BS*$COUNT)) $7
340         $VERITYSETUP verify $IMG $HASH_DEV $ROOT_HASH --fec-device=$FEC $PARAMS >/dev/null 2>&1
341         RET=$?
342         [ "$RET" -ne 0 ] && fail "Device can be corrected, but it wasn't."
343         echo -n "[OK]"
344
345         echo -n "[Errors cannot be corrected]"
346         dd if=/dev/urandom of=$IMG bs=$BS count=$COUNT conv=notrunc >/dev/null 2>&1
347         $VERITYSETUP verify $IMG $HASH_DEV $ROOT_HASH --fec-device=$FEC $PARAMS >/dev/null 2>&1
348         RET=$?
349         [ "$RET" -eq 0 ] && fail "Device cannot be correct, but it didn't fail."
350         echo "[OK]"
351 }
352
353 [ $(id -u) != 0 ] && skip "WARNING: You must be root to run this test, test skipped."
354 [ ! -x "$VERITYSETUP" ] && skip "Cannot find $VERITYSETUP, test skipped."
355
356 [ -n "$VALG" ] && valgrind_setup && VERITYSETUP=valgrind_run
357 modprobe dm-verity >/dev/null 2>&1
358 dmsetup targets | grep verity >/dev/null 2>&1 || skip "Cannot find dm-verity target, test skipped."
359
360 # VERITYSETUP tests
361
362 SALT=e48da609055204e89ae53b655ca2216dd983cf3cb829f34f63a297d106d53e2d
363
364 echo "Verity tests [separate devices]"
365 prepare 8192 1024
366 check_root_hash  512 9de18652fe74edfb9b805aaed72ae2aa48f94333f1ba5c452ac33b1c39325174 $SALT 1 sha256
367 check_root_hash 1024 54d92778750495d1f80832b486ebd007617d746271511bbf0e295e143da2b3df $SALT 1 sha256
368 check_root_hash 4096 e522df0f97da4febb882ac40f30b37dc0b444bf6df418929463fa25280f09d5c $SALT 1 sha256
369 # version 0
370 check_root_hash 4096 cbbf4ebd004ef65e29b935bb635a39cf754d677f3fa10b0126da725bbdf10f7d $SALT 0 sha256
371 # no salt
372 check_root_hash 4096 ef29c902d87350f1da4bfa536e16cebc162a909bf89abe448b81ec500d4fb9bf - 1 sha256
373 # sha1
374 check_root_hash 1024 d0e9163ca8844aaa2e88fe5265a8c5d9ee494a99 $SALT 1 sha1
375 check_root_hash 1024 73509e8e868be6b8ac939817a98a3d35121413b2 dadada 1 sha1
376
377 echo "Verity tests [one device offset]"
378 prepare $((8192 + 1024))
379 check_root_hash  512 9de18652fe74edfb9b805aaed72ae2aa48f94333f1ba5c452ac33b1c39325174 $SALT 1 sha256 8388608
380 check_root_hash 1024 54d92778750495d1f80832b486ebd007617d746271511bbf0e295e143da2b3df $SALT 1 sha256 8388608
381 check_root_hash 4096 e522df0f97da4febb882ac40f30b37dc0b444bf6df418929463fa25280f09d5c $SALT 1 sha256 8388608
382 # version 0
383 check_root_hash 4096 cbbf4ebd004ef65e29b935bb635a39cf754d677f3fa10b0126da725bbdf10f7d $SALT 0 sha256 8388608
384 # no salt
385 check_root_hash 4096 ef29c902d87350f1da4bfa536e16cebc162a909bf89abe448b81ec500d4fb9bf - 1 sha256 8388608
386 # sha1
387 check_root_hash 1024 d0e9163ca8844aaa2e88fe5265a8c5d9ee494a99 $SALT 1 sha1 8388608
388 check_root_hash 1024 73509e8e868be6b8ac939817a98a3d35121413b2 dadada 1 sha1 8388608
389
390 if check_version 1 3; then
391         echo "Verity data corruption options test."
392         SALT=e48da609055204e89ae53b655ca2216dd983cf3cb829f34f63a297d106d53e2d
393         HASH=9de18652fe74edfb9b805aaed72ae2aa48f94333f1ba5c452ac33b1c39325174
394         prepare 8192 1024
395         check_option 512 $HASH $SALT 1 sha256 "--ignore-corruption" "ignore_corruption"
396         check_option 512 $HASH $SALT 1 sha256 "--restart-on-corruption" "restart_on_corruption"
397         check_option 512 $HASH $SALT 1 sha256 "--ignore-zero-blocks" "ignore_zero_blocks"
398         check_option 512 $HASH $SALT 1 sha256 "--ignore-corruption --ignore-zero-blocks" "ignore_corruption"
399         if check_version 1 4; then
400                 check_option 512 $HASH $SALT 1 sha256 "--check-at-most-once" "check_at_most_once"
401         fi
402 fi
403
404 echo "Veritysetup [hash-offset bigger than 2G works] "
405 checkOffsetBug 3000000000 2499997696 256
406 checkOffsetBug 10000000000 8000000000 128
407
408 echo "Veritysetup [overlap-detection] "
409 checkOverlapBug 2097152 1433600
410 checkOverlapBug 2097152 1433600 350 4096
411 checkOverlapBug 2097152 1228800 350 4096 # data-hash overlap
412 checkOverlapBug 2097152 0 350 4096 1228800 # data-fec overlap
413 checkOverlapBug 10240000 256000 400 512 256512 # hash-fec overlap
414
415 if check_version 1 3; then
416         echo "Veritysetup [FEC tests]"
417         for INDEX in  {1..4}; do
418           # in the first iteration check if we can use FEC (it can be compiled-out)
419           (check_fec $IMG $IMG $IMG 4096 30 150 163840 409600 $(($RANDOM % 23 + 2)) $(($INDEX * 4)) )
420           RET=$?
421           [ "$RET" -eq "3" ] && break
422           [ "$RET" -eq "0" ] || fail "FEC repair failed"
423
424           (check_fec $IMG $IMG_HASH $FEC_DEV 4096 30 30 0 0 $(($RANDOM % 23 + 2)) $(($INDEX * 4)) 'n' $SALT) || fail "FEC repair failed"
425           (check_fec $IMG $IMG_HASH $FEC_DEV 4096 35 35 0 0 $(($RANDOM % 23 + 2)) $(($INDEX * 4))) || fail "FEC repair failed"
426           (check_fec $IMG $IMG_HASH $FEC_DEV 512 2000 2000 0 0 $(($RANDOM % 23 + 2)) $(($INDEX * 4))) || fail "FEC repair failed"
427           (check_fec $IMG $IMG_HASH $FEC_DEV 1024 2000 2000 0 0 $(($RANDOM % 23 + 2)) $(($INDEX * 4))) || fail "FEC repair failed"
428           # this test should fail
429           (check_fec $IMG $IMG_HASH $FEC_DEV 4096 30 30 0 0 $(($RANDOM % 23 + 2)) $(($RANDOM % 200 + 200))) && fail "FEC repair must fail"
430           echo "[OK]"
431         done
432 fi
433
434 echo "Correction in userspace: "
435 # checkUserSpaceRepair <#blocks> <block_size> <roots> <hash_offset> <fec_offset> <#devices> <#corrupted bytes>
436 checkUserSpaceRepair -1  512  2 0       0       3 100
437 checkUserSpaceRepair 400 512  2 256000  0       2 50
438 checkUserSpaceRepair 500 512  2 2457600  4915200  1 1
439 checkUserSpaceRepair -1  4096 2 0       0       3 10
440 checkUserSpaceRepair 400 4096 2 2048000 0       2 1
441 #checkUserSpaceRepair 500 4096 2 2457600 4915200 1 2 # FIXME
442
443 remove_mapping
444 exit 0