mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-11-24 21:54:01 +00:00
test: Convert the vboot test to test/py
Now that we have a suitable test framework we should move all tests into it. The vboot test is a suitable candidate. Rewrite it in Python and move the data files into an appropriate directory. Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass
Tom Rini
parent
1152a05ee6
commit
8729d58259
10 changed files with 185 additions and 155 deletions
|
|
@ -58,7 +58,6 @@ There are several ad-hoc tests which run outside the pytest environment:
|
|||
test/image - FIT and lagacy image tests (shell script and Python)
|
||||
test/stdint - A test that stdint.h can be used in U-Boot (shell script)
|
||||
trace - Test for the tracing feature (shell script)
|
||||
vboot - Test for verified boot (shell script)
|
||||
|
||||
The above should be converted to run as part of the pytest suite.
|
||||
|
||||
|
|
|
|||
185
test/py/tests/test_vboot.py
Normal file
185
test/py/tests/test_vboot.py
Normal file
|
|
@ -0,0 +1,185 @@
|
|||
# Copyright (c) 2013, Google Inc.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-2.0+
|
||||
#
|
||||
# U-Boot Verified Boot Test
|
||||
|
||||
"""
|
||||
This tests verified boot in the following ways:
|
||||
|
||||
For image verification:
|
||||
- Create FIT (unsigned) with mkimage
|
||||
- Check that verification shows that no keys are verified
|
||||
- Sign image
|
||||
- Check that verification shows that a key is now verified
|
||||
|
||||
For configuration verification:
|
||||
- Corrupt signature and check for failure
|
||||
- Create FIT (with unsigned configuration) with mkimage
|
||||
- Check that image veriication works
|
||||
- Sign the FIT and mark the key as 'required' for verification
|
||||
- Check that image verification works
|
||||
- Corrupt the signature
|
||||
- Check that image verification no-longer works
|
||||
|
||||
Tests run with both SHA1 and SHA256 hashing.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
import sys
|
||||
import u_boot_utils as util
|
||||
|
||||
@pytest.mark.buildconfigspec('fit_signature')
|
||||
def test_vboot(u_boot_console):
|
||||
"""Test verified boot signing with mkimage and verification with 'bootm'.
|
||||
|
||||
This works using sandbox only as it needs to update the device tree used
|
||||
by U-Boot to hold public keys from the signing process.
|
||||
|
||||
The SHA1 and SHA256 tests are combined into a single test since the
|
||||
key-generation process is quite slow and we want to avoid doing it twice.
|
||||
"""
|
||||
def dtc(dts):
|
||||
"""Run the device-tree compiler to compile a .dts file
|
||||
|
||||
The output file will be the same as the input file but with a .dtb
|
||||
extension.
|
||||
|
||||
Args:
|
||||
dts: Device tree file to compile.
|
||||
"""
|
||||
dtb = dts.replace('.dts', '.dtb')
|
||||
util.cmd(cons, 'dtc %s %s%s -O dtb '
|
||||
'-o %s%s' % (dtc_args, datadir, dts, tmpdir, dtb))
|
||||
|
||||
def run_bootm(test_type, expect_string):
|
||||
"""Run a 'bootm' command U-Boot.
|
||||
|
||||
This always starts a fresh U-Boot instance since the device tree may
|
||||
contain a new public key.
|
||||
|
||||
Args:
|
||||
test_type: A string identifying the test type
|
||||
expect_string: A string which is expected in the output
|
||||
"""
|
||||
cons.cleanup_spawn()
|
||||
cons.ensure_spawned()
|
||||
cons.log.action('%s: Test Verified Boot Run: %s' % (algo, test_type))
|
||||
output = cons.run_command_list(
|
||||
['sb load hostfs - 100 %stest.fit' % tmpdir,
|
||||
'fdt addr 100',
|
||||
'bootm 100'])
|
||||
assert(expect_string in output)
|
||||
|
||||
def make_fit(its):
|
||||
"""Make a new FIT from the .its source file
|
||||
|
||||
This runs 'mkimage -f' to create a new FIT.
|
||||
|
||||
Args:
|
||||
its: Filename containing .its source
|
||||
"""
|
||||
util.run_and_log(cons, [mkimage, '-D', dtc_args, '-f',
|
||||
'%s%s' % (datadir, its), fit])
|
||||
|
||||
def sign_fit():
|
||||
"""Sign the FIT
|
||||
|
||||
Signs the FIT and writes the signature into it. It also writes the
|
||||
public key into the dtb.
|
||||
"""
|
||||
cons.log.action('%s: Sign images' % algo)
|
||||
util.run_and_log(cons, [mkimage, '-F', '-k', tmpdir, '-K', dtb,
|
||||
'-r', fit])
|
||||
|
||||
def test_with_algo(sha):
|
||||
"""Test verified boot with the given hash algorithm
|
||||
|
||||
This is the main part of the test code. The same procedure is followed
|
||||
for both hashing algorithms.
|
||||
|
||||
Args:
|
||||
sha: Either 'sha1' or 'sha256', to select the algorithm to use
|
||||
"""
|
||||
global algo
|
||||
|
||||
algo = sha
|
||||
|
||||
# Compile our device tree files for kernel and U-Boot
|
||||
dtc('sandbox-kernel.dts')
|
||||
dtc('sandbox-u-boot.dts')
|
||||
|
||||
# Build the FIT, but don't sign anything yet
|
||||
cons.log.action('%s: Test FIT with signed images' % algo)
|
||||
make_fit('sign-images-%s.its' % algo)
|
||||
run_bootm('unsigned images', 'dev-')
|
||||
|
||||
# Sign images with our dev keys
|
||||
sign_fit()
|
||||
run_bootm('signed images', 'dev+')
|
||||
|
||||
# Create a fresh .dtb without the public keys
|
||||
dtc('sandbox-u-boot.dts')
|
||||
|
||||
cons.log.action('%s: Test FIT with signed configuration' % algo)
|
||||
make_fit('sign-configs-%s.its' % algo)
|
||||
run_bootm('unsigned config', '%s+ OK' % algo)
|
||||
|
||||
# Sign images with our dev keys
|
||||
sign_fit()
|
||||
run_bootm('signed config', 'dev+')
|
||||
|
||||
cons.log.action('%s: Check signed config on the host' % algo)
|
||||
|
||||
util.run_and_log(cons, [fit_check_sign, '-f', fit, '-k', tmpdir,
|
||||
'-k', dtb])
|
||||
|
||||
# Increment the first byte of the signature, which should cause failure
|
||||
sig = util.cmd(cons, 'fdtget -t bx %s %s value' % (fit, sig_node))
|
||||
byte_list = sig.split()
|
||||
byte = int(byte_list[0], 16)
|
||||
byte_list = ['%x' % (byte + 1)] + byte_list[1:]
|
||||
sig = ' '.join(byte_list)
|
||||
util.cmd(cons, 'fdtput -t bx %s %s value %s' % (fit, sig_node, sig))
|
||||
|
||||
run_bootm('Signed config with bad hash', 'Bad Data Hash')
|
||||
|
||||
cons.log.action('%s: Check bad config on the host' % algo)
|
||||
util.run_and_log_expect_exception(cons, [fit_check_sign, '-f', fit,
|
||||
'-k', dtb], 1, 'Failed to verify required signature')
|
||||
|
||||
cons = u_boot_console
|
||||
tmpdir = cons.config.result_dir + '/'
|
||||
tmp = tmpdir + 'vboot.tmp'
|
||||
datadir = 'test/py/tests/vboot/'
|
||||
fit = '%stest.fit' % tmpdir
|
||||
mkimage = cons.config.build_dir + '/tools/mkimage'
|
||||
fit_check_sign = cons.config.build_dir + '/tools/fit_check_sign'
|
||||
dtc_args = '-I dts -O dtb -i %s' % tmpdir
|
||||
dtb = '%ssandbox-u-boot.dtb' % tmpdir
|
||||
sig_node = '/configurations/conf@1/signature@1'
|
||||
|
||||
# Create an RSA key pair
|
||||
public_exponent = 65537
|
||||
util.cmd(cons, 'openssl genpkey -algorithm RSA -out %sdev.key '
|
||||
'-pkeyopt rsa_keygen_bits:2048 '
|
||||
'-pkeyopt rsa_keygen_pubexp:%d '
|
||||
'2>/dev/null' % (tmpdir, public_exponent))
|
||||
|
||||
# Create a certificate containing the public key
|
||||
util.cmd(cons, 'openssl req -batch -new -x509 -key %sdev.key -out '
|
||||
'%sdev.crt' % (tmpdir, tmpdir))
|
||||
|
||||
# Create a number kernel image with zeroes
|
||||
with open('%stest-kernel.bin' % tmpdir, 'w') as fd:
|
||||
fd.write(5000 * chr(0))
|
||||
|
||||
try:
|
||||
# We need to use our own device tree file. Remember to restore it
|
||||
# afterwards.
|
||||
old_dtb = cons.config.dtb
|
||||
cons.config.dtb = dtb
|
||||
test_with_algo('sha1')
|
||||
test_with_algo('sha256')
|
||||
finally:
|
||||
cons.config.dtb = old_dtb
|
||||
3
test/vboot/.gitignore
vendored
3
test/vboot/.gitignore
vendored
|
|
@ -1,3 +0,0 @@
|
|||
/*.dtb
|
||||
/test.fit
|
||||
/dev-keys
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
#!/bin/bash
|
||||
#
|
||||
# Copyright (c) 2013, Google Inc.
|
||||
#
|
||||
# Simple Verified Boot Test Script
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-2.0+
|
||||
|
||||
set -e
|
||||
|
||||
# Run U-Boot and report the result
|
||||
# Args:
|
||||
# $1: Test message
|
||||
run_uboot() {
|
||||
echo -n "Test Verified Boot Run: $1: "
|
||||
${uboot} -d sandbox-u-boot.dtb >${tmp} -c '
|
||||
sb load hostfs - 100 test.fit;
|
||||
fdt addr 100;
|
||||
bootm 100;
|
||||
reset'
|
||||
if ! grep -q "$2" ${tmp}; then
|
||||
echo
|
||||
echo "Verified boot key check failed, output follows:"
|
||||
cat ${tmp}
|
||||
false
|
||||
else
|
||||
echo "OK"
|
||||
fi
|
||||
}
|
||||
|
||||
echo "Simple Verified Boot Test"
|
||||
echo "========================="
|
||||
echo
|
||||
echo "Please see doc/uImage.FIT/verified-boot.txt for more information"
|
||||
echo
|
||||
|
||||
err=0
|
||||
tmp=/tmp/vboot_test.$$
|
||||
|
||||
dir=$(dirname $0)
|
||||
|
||||
if [ -z ${O} ]; then
|
||||
O=.
|
||||
fi
|
||||
O=$(readlink -f ${O})
|
||||
|
||||
dtc="-I dts -O dtb -p 2000"
|
||||
uboot="${O}/u-boot"
|
||||
mkimage="${O}/tools/mkimage"
|
||||
fit_check_sign="${O}/tools/fit_check_sign"
|
||||
keys="${dir}/dev-keys"
|
||||
echo ${mkimage} -D "${dtc}"
|
||||
|
||||
echo "Build keys"
|
||||
mkdir -p ${keys}
|
||||
|
||||
PUBLIC_EXPONENT=${1}
|
||||
|
||||
if [ -z "${PUBLIC_EXPONENT}" ]; then
|
||||
PUBLIC_EXPONENT=65537
|
||||
fi
|
||||
|
||||
# Create an RSA key pair
|
||||
openssl genpkey -algorithm RSA -out ${keys}/dev.key \
|
||||
-pkeyopt rsa_keygen_bits:2048 \
|
||||
-pkeyopt rsa_keygen_pubexp:${PUBLIC_EXPONENT} 2>/dev/null
|
||||
|
||||
# Create a certificate containing the public key
|
||||
openssl req -batch -new -x509 -key ${keys}/dev.key -out ${keys}/dev.crt
|
||||
|
||||
pushd ${dir} >/dev/null
|
||||
|
||||
function do_test {
|
||||
echo do $sha test
|
||||
# Compile our device tree files for kernel and U-Boot
|
||||
dtc -p 0x1000 sandbox-kernel.dts -O dtb -o sandbox-kernel.dtb
|
||||
dtc -p 0x1000 sandbox-u-boot.dts -O dtb -o sandbox-u-boot.dtb
|
||||
|
||||
# Create a number kernel image with zeroes
|
||||
head -c 5000 /dev/zero >test-kernel.bin
|
||||
|
||||
# Build the FIT, but don't sign anything yet
|
||||
echo Build FIT with signed images
|
||||
${mkimage} -D "${dtc}" -f sign-images-$sha.its test.fit >${tmp}
|
||||
|
||||
run_uboot "unsigned signatures:" "dev-"
|
||||
|
||||
# Sign images with our dev keys
|
||||
echo Sign images
|
||||
${mkimage} -D "${dtc}" -F -k dev-keys -K sandbox-u-boot.dtb \
|
||||
-r test.fit >${tmp}
|
||||
|
||||
run_uboot "signed images" "dev+"
|
||||
|
||||
|
||||
# Create a fresh .dtb without the public keys
|
||||
dtc -p 0x1000 sandbox-u-boot.dts -O dtb -o sandbox-u-boot.dtb
|
||||
|
||||
echo Build FIT with signed configuration
|
||||
${mkimage} -D "${dtc}" -f sign-configs-$sha.its test.fit >${tmp}
|
||||
|
||||
run_uboot "unsigned config" $sha"+ OK"
|
||||
|
||||
# Sign images with our dev keys
|
||||
echo Sign images
|
||||
${mkimage} -D "${dtc}" -F -k dev-keys -K sandbox-u-boot.dtb \
|
||||
-r test.fit >${tmp}
|
||||
|
||||
run_uboot "signed config" "dev+"
|
||||
|
||||
echo check signed config on the host
|
||||
if ! ${fit_check_sign} -f test.fit -k sandbox-u-boot.dtb >${tmp}; then
|
||||
echo
|
||||
echo "Verified boot key check on host failed, output follows:"
|
||||
cat ${tmp}
|
||||
false
|
||||
else
|
||||
if ! grep -q "dev+" ${tmp}; then
|
||||
echo
|
||||
echo "Verified boot key check failed, output follows:"
|
||||
cat ${tmp}
|
||||
false
|
||||
else
|
||||
echo "OK"
|
||||
fi
|
||||
fi
|
||||
|
||||
run_uboot "signed config" "dev+"
|
||||
|
||||
# Increment the first byte of the signature, which should cause failure
|
||||
sig=$(fdtget -t bx test.fit /configurations/conf@1/signature@1 value)
|
||||
newbyte=$(printf %x $((0x${sig:0:2} + 1)))
|
||||
sig="${newbyte} ${sig:2}"
|
||||
fdtput -t bx test.fit /configurations/conf@1/signature@1 value ${sig}
|
||||
|
||||
run_uboot "signed config with bad hash" "Bad Data Hash"
|
||||
}
|
||||
|
||||
sha=sha1
|
||||
do_test
|
||||
sha=sha256
|
||||
do_test
|
||||
|
||||
popd >/dev/null
|
||||
|
||||
echo
|
||||
if ${ok}; then
|
||||
echo "Test passed"
|
||||
else
|
||||
echo "Test failed"
|
||||
fi
|
||||
Loading…
Reference in a new issue