172f52268SSimon Glass# Copyright (c) 2016, Google Inc. 28729d582SSimon Glass# 38729d582SSimon Glass# SPDX-License-Identifier: GPL-2.0+ 48729d582SSimon Glass# 58729d582SSimon Glass# U-Boot Verified Boot Test 68729d582SSimon Glass 78729d582SSimon Glass""" 88729d582SSimon GlassThis tests verified boot in the following ways: 98729d582SSimon Glass 108729d582SSimon GlassFor image verification: 118729d582SSimon Glass- Create FIT (unsigned) with mkimage 128729d582SSimon Glass- Check that verification shows that no keys are verified 138729d582SSimon Glass- Sign image 148729d582SSimon Glass- Check that verification shows that a key is now verified 158729d582SSimon Glass 168729d582SSimon GlassFor configuration verification: 178729d582SSimon Glass- Corrupt signature and check for failure 188729d582SSimon Glass- Create FIT (with unsigned configuration) with mkimage 1972f52268SSimon Glass- Check that image verification works 208729d582SSimon Glass- Sign the FIT and mark the key as 'required' for verification 218729d582SSimon Glass- Check that image verification works 228729d582SSimon Glass- Corrupt the signature 238729d582SSimon Glass- Check that image verification no-longer works 248729d582SSimon Glass 258729d582SSimon GlassTests run with both SHA1 and SHA256 hashing. 268729d582SSimon Glass""" 278729d582SSimon Glass 288729d582SSimon Glassimport pytest 298729d582SSimon Glassimport sys 308729d582SSimon Glassimport u_boot_utils as util 318729d582SSimon Glass 3204a4786cSMichal Simek@pytest.mark.boardspec('sandbox') 338729d582SSimon Glass@pytest.mark.buildconfigspec('fit_signature') 348729d582SSimon Glassdef test_vboot(u_boot_console): 358729d582SSimon Glass """Test verified boot signing with mkimage and verification with 'bootm'. 368729d582SSimon Glass 378729d582SSimon Glass This works using sandbox only as it needs to update the device tree used 388729d582SSimon Glass by U-Boot to hold public keys from the signing process. 398729d582SSimon Glass 408729d582SSimon Glass The SHA1 and SHA256 tests are combined into a single test since the 418729d582SSimon Glass key-generation process is quite slow and we want to avoid doing it twice. 428729d582SSimon Glass """ 438729d582SSimon Glass def dtc(dts): 4472f52268SSimon Glass """Run the device tree compiler to compile a .dts file 458729d582SSimon Glass 468729d582SSimon Glass The output file will be the same as the input file but with a .dtb 478729d582SSimon Glass extension. 488729d582SSimon Glass 498729d582SSimon Glass Args: 508729d582SSimon Glass dts: Device tree file to compile. 518729d582SSimon Glass """ 528729d582SSimon Glass dtb = dts.replace('.dts', '.dtb') 53ec70f8a9SSimon Glass util.run_and_log(cons, 'dtc %s %s%s -O dtb ' 548729d582SSimon Glass '-o %s%s' % (dtc_args, datadir, dts, tmpdir, dtb)) 558729d582SSimon Glass 56ac9a23cfSSimon Glass def run_bootm(sha_algo, test_type, expect_string): 578729d582SSimon Glass """Run a 'bootm' command U-Boot. 588729d582SSimon Glass 598729d582SSimon Glass This always starts a fresh U-Boot instance since the device tree may 608729d582SSimon Glass contain a new public key. 618729d582SSimon Glass 628729d582SSimon Glass Args: 63ac9a23cfSSimon Glass test_type: A string identifying the test type. 64ac9a23cfSSimon Glass expect_string: A string which is expected in the output. 65ac9a23cfSSimon Glass sha_algo: Either 'sha1' or 'sha256', to select the algorithm to 66ac9a23cfSSimon Glass use. 678729d582SSimon Glass """ 688729d582SSimon Glass cons.cleanup_spawn() 698729d582SSimon Glass cons.ensure_spawned() 70*851271a7SSimon Glass with cons.log.section('Verified boot %s %s' % (sha_algo, test_type)): 718729d582SSimon Glass output = cons.run_command_list( 728729d582SSimon Glass ['sb load hostfs - 100 %stest.fit' % tmpdir, 738729d582SSimon Glass 'fdt addr 100', 748729d582SSimon Glass 'bootm 100']) 758729d582SSimon Glass assert(expect_string in output) 768729d582SSimon Glass 778729d582SSimon Glass def make_fit(its): 7872f52268SSimon Glass """Make a new FIT from the .its source file. 798729d582SSimon Glass 808729d582SSimon Glass This runs 'mkimage -f' to create a new FIT. 818729d582SSimon Glass 828729d582SSimon Glass Args: 8372f52268SSimon Glass its: Filename containing .its source. 848729d582SSimon Glass """ 858729d582SSimon Glass util.run_and_log(cons, [mkimage, '-D', dtc_args, '-f', 868729d582SSimon Glass '%s%s' % (datadir, its), fit]) 878729d582SSimon Glass 88ac9a23cfSSimon Glass def sign_fit(sha_algo): 898729d582SSimon Glass """Sign the FIT 908729d582SSimon Glass 918729d582SSimon Glass Signs the FIT and writes the signature into it. It also writes the 928729d582SSimon Glass public key into the dtb. 93ac9a23cfSSimon Glass 94ac9a23cfSSimon Glass Args: 95ac9a23cfSSimon Glass sha_algo: Either 'sha1' or 'sha256', to select the algorithm to 96ac9a23cfSSimon Glass use. 978729d582SSimon Glass """ 98ac9a23cfSSimon Glass cons.log.action('%s: Sign images' % sha_algo) 998729d582SSimon Glass util.run_and_log(cons, [mkimage, '-F', '-k', tmpdir, '-K', dtb, 1008729d582SSimon Glass '-r', fit]) 1018729d582SSimon Glass 102ac9a23cfSSimon Glass def test_with_algo(sha_algo): 10372f52268SSimon Glass """Test verified boot with the given hash algorithm. 1048729d582SSimon Glass 1058729d582SSimon Glass This is the main part of the test code. The same procedure is followed 1068729d582SSimon Glass for both hashing algorithms. 1078729d582SSimon Glass 1088729d582SSimon Glass Args: 109ac9a23cfSSimon Glass sha_algo: Either 'sha1' or 'sha256', to select the algorithm to 110ac9a23cfSSimon Glass use. 1118729d582SSimon Glass """ 112bcbd0c8fSSimon Glass # Compile our device tree files for kernel and U-Boot. These are 113bcbd0c8fSSimon Glass # regenerated here since mkimage will modify them (by adding a 114bcbd0c8fSSimon Glass # public key) below. 1158729d582SSimon Glass dtc('sandbox-kernel.dts') 1168729d582SSimon Glass dtc('sandbox-u-boot.dts') 1178729d582SSimon Glass 1188729d582SSimon Glass # Build the FIT, but don't sign anything yet 119ac9a23cfSSimon Glass cons.log.action('%s: Test FIT with signed images' % sha_algo) 120ac9a23cfSSimon Glass make_fit('sign-images-%s.its' % sha_algo) 121ac9a23cfSSimon Glass run_bootm(sha_algo, 'unsigned images', 'dev-') 1228729d582SSimon Glass 1238729d582SSimon Glass # Sign images with our dev keys 124ac9a23cfSSimon Glass sign_fit(sha_algo) 125ac9a23cfSSimon Glass run_bootm(sha_algo, 'signed images', 'dev+') 1268729d582SSimon Glass 1278729d582SSimon Glass # Create a fresh .dtb without the public keys 1288729d582SSimon Glass dtc('sandbox-u-boot.dts') 1298729d582SSimon Glass 130ac9a23cfSSimon Glass cons.log.action('%s: Test FIT with signed configuration' % sha_algo) 131ac9a23cfSSimon Glass make_fit('sign-configs-%s.its' % sha_algo) 132ac9a23cfSSimon Glass run_bootm(sha_algo, 'unsigned config', '%s+ OK' % sha_algo) 1338729d582SSimon Glass 1348729d582SSimon Glass # Sign images with our dev keys 135ac9a23cfSSimon Glass sign_fit(sha_algo) 136ac9a23cfSSimon Glass run_bootm(sha_algo, 'signed config', 'dev+') 1378729d582SSimon Glass 138ac9a23cfSSimon Glass cons.log.action('%s: Check signed config on the host' % sha_algo) 1398729d582SSimon Glass 1408729d582SSimon Glass util.run_and_log(cons, [fit_check_sign, '-f', fit, '-k', tmpdir, 1418729d582SSimon Glass '-k', dtb]) 1428729d582SSimon Glass 1438729d582SSimon Glass # Increment the first byte of the signature, which should cause failure 144ec70f8a9SSimon Glass sig = util.run_and_log(cons, 'fdtget -t bx %s %s value' % 145ec70f8a9SSimon Glass (fit, sig_node)) 1468729d582SSimon Glass byte_list = sig.split() 1478729d582SSimon Glass byte = int(byte_list[0], 16) 148bcbd0c8fSSimon Glass byte_list[0] = '%x' % (byte + 1) 1498729d582SSimon Glass sig = ' '.join(byte_list) 150ec70f8a9SSimon Glass util.run_and_log(cons, 'fdtput -t bx %s %s value %s' % 151ec70f8a9SSimon Glass (fit, sig_node, sig)) 1528729d582SSimon Glass 153ac9a23cfSSimon Glass run_bootm(sha_algo, 'Signed config with bad hash', 'Bad Data Hash') 1548729d582SSimon Glass 155ac9a23cfSSimon Glass cons.log.action('%s: Check bad config on the host' % sha_algo) 1568729d582SSimon Glass util.run_and_log_expect_exception(cons, [fit_check_sign, '-f', fit, 1578729d582SSimon Glass '-k', dtb], 1, 'Failed to verify required signature') 1588729d582SSimon Glass 1598729d582SSimon Glass cons = u_boot_console 1608729d582SSimon Glass tmpdir = cons.config.result_dir + '/' 1618729d582SSimon Glass tmp = tmpdir + 'vboot.tmp' 162c9ba60c4SStephen Warren datadir = cons.config.source_dir + '/test/py/tests/vboot/' 1638729d582SSimon Glass fit = '%stest.fit' % tmpdir 1648729d582SSimon Glass mkimage = cons.config.build_dir + '/tools/mkimage' 1658729d582SSimon Glass fit_check_sign = cons.config.build_dir + '/tools/fit_check_sign' 1668729d582SSimon Glass dtc_args = '-I dts -O dtb -i %s' % tmpdir 1678729d582SSimon Glass dtb = '%ssandbox-u-boot.dtb' % tmpdir 1688729d582SSimon Glass sig_node = '/configurations/conf@1/signature@1' 1698729d582SSimon Glass 1708729d582SSimon Glass # Create an RSA key pair 1718729d582SSimon Glass public_exponent = 65537 172ec70f8a9SSimon Glass util.run_and_log(cons, 'openssl genpkey -algorithm RSA -out %sdev.key ' 1738729d582SSimon Glass '-pkeyopt rsa_keygen_bits:2048 ' 1748729d582SSimon Glass '-pkeyopt rsa_keygen_pubexp:%d ' 1758729d582SSimon Glass '2>/dev/null' % (tmpdir, public_exponent)) 1768729d582SSimon Glass 1778729d582SSimon Glass # Create a certificate containing the public key 178ec70f8a9SSimon Glass util.run_and_log(cons, 'openssl req -batch -new -x509 -key %sdev.key -out ' 1798729d582SSimon Glass '%sdev.crt' % (tmpdir, tmpdir)) 1808729d582SSimon Glass 1818729d582SSimon Glass # Create a number kernel image with zeroes 1828729d582SSimon Glass with open('%stest-kernel.bin' % tmpdir, 'w') as fd: 1838729d582SSimon Glass fd.write(5000 * chr(0)) 1848729d582SSimon Glass 1858729d582SSimon Glass try: 1868729d582SSimon Glass # We need to use our own device tree file. Remember to restore it 1878729d582SSimon Glass # afterwards. 1888729d582SSimon Glass old_dtb = cons.config.dtb 1898729d582SSimon Glass cons.config.dtb = dtb 1908729d582SSimon Glass test_with_algo('sha1') 1918729d582SSimon Glass test_with_algo('sha256') 1928729d582SSimon Glass finally: 1938729d582SSimon Glass cons.config.dtb = old_dtb 194