2016-07-03 15:40:46 +00:00
|
|
|
# SPDX-License-Identifier: GPL-2.0+
|
2018-05-06 21:58:06 +00:00
|
|
|
# Copyright (c) 2016, Google Inc.
|
2016-07-03 15:40:46 +00:00
|
|
|
#
|
|
|
|
# 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
|
2016-07-31 23:35:04 +00:00
|
|
|
- Check that image verification works
|
2016-07-03 15:40:46 +00:00
|
|
|
- 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
|
|
|
|
|
2022-03-28 20:57:06 +00:00
|
|
|
For pre-load header verification:
|
|
|
|
- Create FIT image with a pre-load header
|
|
|
|
- Check that signature verification succeeds
|
|
|
|
- Corrupt the FIT image
|
|
|
|
- Check that signature verification fails
|
|
|
|
- Launch an FIT image without a pre-load header
|
|
|
|
- Check that image verification fails
|
|
|
|
|
2016-07-03 15:40:46 +00:00
|
|
|
Tests run with both SHA1 and SHA256 hashing.
|
2023-03-20 03:28:13 +00:00
|
|
|
|
|
|
|
This also tests fdt_add_pubkey utility in the simple way:
|
|
|
|
- Create DTB and FIT files
|
|
|
|
- Add keys with fdt_add_pubkey to DTB
|
|
|
|
- Sign FIT image
|
|
|
|
- Check with fit_check_sign that keys properly added to DTB file
|
2016-07-03 15:40:46 +00:00
|
|
|
"""
|
|
|
|
|
2021-09-19 21:14:48 +00:00
|
|
|
import os
|
2021-02-16 00:08:08 +00:00
|
|
|
import shutil
|
2018-06-09 15:38:05 +00:00
|
|
|
import struct
|
2020-03-18 17:44:05 +00:00
|
|
|
import pytest
|
2016-07-03 15:40:46 +00:00
|
|
|
import u_boot_utils as util
|
2020-03-18 17:43:59 +00:00
|
|
|
import vboot_forge
|
2021-02-16 00:08:08 +00:00
|
|
|
import vboot_evil
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2023-03-20 03:28:13 +00:00
|
|
|
# Common helper functions
|
|
|
|
def dtc(dts, cons, dtc_args, datadir, tmpdir, dtb):
|
|
|
|
"""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.
|
|
|
|
cons: U-Boot console.
|
|
|
|
dtc_args: DTC arguments.
|
|
|
|
datadir: Path to data directory.
|
|
|
|
tmpdir: Path to temp directory.
|
|
|
|
dtb: Resulting DTB file.
|
|
|
|
"""
|
|
|
|
dtb = dts.replace('.dts', '.dtb')
|
|
|
|
util.run_and_log(cons, 'dtc %s %s%s -O dtb '
|
|
|
|
'-o %s%s' % (dtc_args, datadir, dts, tmpdir, dtb))
|
|
|
|
|
|
|
|
def make_fit(its, cons, mkimage, dtc_args, datadir, fit):
|
|
|
|
"""Make a new FIT from the .its source file.
|
|
|
|
|
|
|
|
This runs 'mkimage -f' to create a new FIT.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
its: Filename containing .its source.
|
|
|
|
cons: U-Boot console.
|
|
|
|
mkimage: Path to mkimage utility.
|
|
|
|
dtc_args: DTC arguments.
|
|
|
|
datadir: Path to data directory.
|
|
|
|
fit: Resulting FIT file.
|
|
|
|
"""
|
|
|
|
util.run_and_log(cons, [mkimage, '-D', dtc_args, '-f',
|
|
|
|
'%s%s' % (datadir, its), fit])
|
|
|
|
|
2021-02-16 00:08:08 +00:00
|
|
|
# Only run the full suite on a few combinations, since it doesn't add any more
|
|
|
|
# test coverage.
|
2022-08-06 23:51:52 +00:00
|
|
|
TESTDATA_IN = [
|
2022-03-28 20:57:06 +00:00
|
|
|
['sha1-basic', 'sha1', '', None, False, True, False, False],
|
|
|
|
['sha1-pad', 'sha1', '', '-E -p 0x10000', False, False, False, False],
|
|
|
|
['sha1-pss', 'sha1', '-pss', None, False, False, False, False],
|
|
|
|
['sha1-pss-pad', 'sha1', '-pss', '-E -p 0x10000', False, False, False, False],
|
|
|
|
['sha256-basic', 'sha256', '', None, False, False, False, False],
|
|
|
|
['sha256-pad', 'sha256', '', '-E -p 0x10000', False, False, False, False],
|
|
|
|
['sha256-pss', 'sha256', '-pss', None, False, False, False, False],
|
|
|
|
['sha256-pss-pad', 'sha256', '-pss', '-E -p 0x10000', False, False, False, False],
|
|
|
|
['sha256-pss-required', 'sha256', '-pss', None, True, False, False, False],
|
|
|
|
['sha256-pss-pad-required', 'sha256', '-pss', '-E -p 0x10000', True, True, False, False],
|
|
|
|
['sha384-basic', 'sha384', '', None, False, False, False, False],
|
|
|
|
['sha384-pad', 'sha384', '', '-E -p 0x10000', False, False, False, False],
|
|
|
|
['algo-arg', 'algo-arg', '', '-o sha256,rsa2048', False, False, True, False],
|
|
|
|
['sha256-global-sign', 'sha256', '', '', False, False, False, True],
|
|
|
|
['sha256-global-sign-pss', 'sha256', '-pss', '', False, False, False, True],
|
2020-03-18 17:44:00 +00:00
|
|
|
]
|
|
|
|
|
2022-08-06 23:51:52 +00:00
|
|
|
# Mark all but the first test as slow, so they are not run with '-k not slow'
|
|
|
|
TESTDATA = [TESTDATA_IN[0]]
|
|
|
|
TESTDATA += [pytest.param(*v, marks=pytest.mark.slow) for v in TESTDATA_IN[1:]]
|
|
|
|
|
2016-07-18 06:49:08 +00:00
|
|
|
@pytest.mark.boardspec('sandbox')
|
2016-07-03 15:40:46 +00:00
|
|
|
@pytest.mark.buildconfigspec('fit_signature')
|
2017-09-18 17:11:49 +00:00
|
|
|
@pytest.mark.requiredtool('dtc')
|
|
|
|
@pytest.mark.requiredtool('fdtget')
|
|
|
|
@pytest.mark.requiredtool('fdtput')
|
|
|
|
@pytest.mark.requiredtool('openssl')
|
2022-03-28 20:57:06 +00:00
|
|
|
@pytest.mark.parametrize("name,sha_algo,padding,sign_options,required,full_test,algo_arg,global_sign",
|
2021-02-16 00:08:08 +00:00
|
|
|
TESTDATA)
|
2021-09-19 21:14:48 +00:00
|
|
|
def test_vboot(u_boot_console, name, sha_algo, padding, sign_options, required,
|
2022-03-28 20:57:06 +00:00
|
|
|
full_test, algo_arg, global_sign):
|
2016-07-03 15:40:46 +00:00
|
|
|
"""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.
|
|
|
|
"""
|
2022-03-28 20:57:06 +00:00
|
|
|
def dtc_options(dts, options):
|
|
|
|
"""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.
|
|
|
|
options: Options provided to the compiler.
|
|
|
|
"""
|
|
|
|
dtb = dts.replace('.dts', '.dtb')
|
|
|
|
util.run_and_log(cons, 'dtc %s %s%s -O dtb '
|
|
|
|
'-o %s%s %s' % (dtc_args, datadir, dts, tmpdir, dtb, options))
|
|
|
|
|
|
|
|
def run_binman(dtb):
|
|
|
|
"""Run binman to build an image
|
|
|
|
|
|
|
|
Args:
|
|
|
|
dtb: Device tree file used as input file.
|
|
|
|
"""
|
|
|
|
pythonpath = os.environ.get('PYTHONPATH', '')
|
|
|
|
os.environ['PYTHONPATH'] = pythonpath + ':' + '%s/../scripts/dtc/pylibfdt' % tmpdir
|
|
|
|
util.run_and_log(cons, [binman, 'build', '-d', "%s/%s" % (tmpdir,dtb),
|
|
|
|
'-a', "pre-load-key-path=%s" % tmpdir, '-O',
|
|
|
|
tmpdir, '-I', tmpdir])
|
|
|
|
os.environ['PYTHONPATH'] = pythonpath
|
|
|
|
|
2021-02-16 00:08:08 +00:00
|
|
|
def run_bootm(sha_algo, test_type, expect_string, boots, fit=None):
|
2016-07-03 15:40:46 +00:00
|
|
|
"""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:
|
2016-07-31 23:35:06 +00:00
|
|
|
test_type: A string identifying the test type.
|
|
|
|
expect_string: A string which is expected in the output.
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to
|
|
|
|
use.
|
2016-09-18 13:46:58 +00:00
|
|
|
boots: A boolean that is True if Linux should boot and False if
|
|
|
|
we are expected to not boot
|
2021-02-16 00:08:08 +00:00
|
|
|
fit: FIT filename to load and verify
|
2016-07-03 15:40:46 +00:00
|
|
|
"""
|
2021-02-16 00:08:08 +00:00
|
|
|
if not fit:
|
|
|
|
fit = '%stest.fit' % tmpdir
|
2016-07-31 23:35:08 +00:00
|
|
|
cons.restart_uboot()
|
2016-07-31 23:35:07 +00:00
|
|
|
with cons.log.section('Verified boot %s %s' % (sha_algo, test_type)):
|
|
|
|
output = cons.run_command_list(
|
2021-02-16 00:08:08 +00:00
|
|
|
['host load hostfs - 100 %s' % fit,
|
2020-03-18 17:44:05 +00:00
|
|
|
'fdt addr 100',
|
|
|
|
'bootm 100'])
|
|
|
|
assert expect_string in ''.join(output)
|
2016-09-18 13:46:58 +00:00
|
|
|
if boots:
|
2020-03-18 17:44:05 +00:00
|
|
|
assert 'sandbox: continuing, as we cannot run' in ''.join(output)
|
2019-09-18 14:04:53 +00:00
|
|
|
else:
|
2020-03-18 17:44:04 +00:00
|
|
|
assert('sandbox: continuing, as we cannot run'
|
|
|
|
not in ''.join(output))
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2020-04-29 13:26:16 +00:00
|
|
|
def sign_fit(sha_algo, options):
|
2016-07-03 15:40:46 +00:00
|
|
|
"""Sign the FIT
|
|
|
|
|
|
|
|
Signs the FIT and writes the signature into it. It also writes the
|
|
|
|
public key into the dtb.
|
2016-07-31 23:35:06 +00:00
|
|
|
|
|
|
|
Args:
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to
|
|
|
|
use.
|
2020-04-29 13:26:16 +00:00
|
|
|
options: Options to provide to mkimage.
|
2016-07-03 15:40:46 +00:00
|
|
|
"""
|
2020-04-29 13:26:16 +00:00
|
|
|
args = [mkimage, '-F', '-k', tmpdir, '-K', dtb, '-r', fit]
|
|
|
|
if options:
|
|
|
|
args += options.split(' ')
|
2016-07-31 23:35:06 +00:00
|
|
|
cons.log.action('%s: Sign images' % sha_algo)
|
2020-04-29 13:26:16 +00:00
|
|
|
util.run_and_log(cons, args)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2022-03-28 20:57:06 +00:00
|
|
|
def sign_fit_dtb(sha_algo, options, dtb):
|
|
|
|
"""Sign the FIT
|
|
|
|
|
|
|
|
Signs the FIT and writes the signature into it. It also writes the
|
|
|
|
public key into the dtb.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to
|
|
|
|
use.
|
|
|
|
options: Options to provide to mkimage.
|
|
|
|
"""
|
|
|
|
args = [mkimage, '-F', '-k', tmpdir, '-K', dtb, '-r', fit]
|
|
|
|
if options:
|
|
|
|
args += options.split(' ')
|
|
|
|
cons.log.action('%s: Sign images' % sha_algo)
|
|
|
|
util.run_and_log(cons, args)
|
|
|
|
|
2020-08-17 06:01:10 +00:00
|
|
|
def sign_fit_norequire(sha_algo, options):
|
|
|
|
"""Sign the FIT
|
|
|
|
|
|
|
|
Signs the FIT and writes the signature into it. It also writes the
|
|
|
|
public key into the dtb. It does not mark key as 'required' in dtb.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to
|
|
|
|
use.
|
|
|
|
options: Options to provide to mkimage.
|
|
|
|
"""
|
|
|
|
args = [mkimage, '-F', '-k', tmpdir, '-K', dtb, fit]
|
|
|
|
if options:
|
|
|
|
args += options.split(' ')
|
|
|
|
cons.log.action('%s: Sign images' % sha_algo)
|
|
|
|
util.run_and_log(cons, args)
|
|
|
|
|
2018-06-09 15:38:05 +00:00
|
|
|
def replace_fit_totalsize(size):
|
|
|
|
"""Replace FIT header's totalsize with something greater.
|
|
|
|
|
|
|
|
The totalsize must be less than or equal to FIT_SIGNATURE_MAX_SIZE.
|
|
|
|
If the size is greater, the signature verification should return false.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
size: The new totalsize of the header
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
prev_size: The previous totalsize read from the header
|
|
|
|
"""
|
|
|
|
total_size = 0
|
|
|
|
with open(fit, 'r+b') as handle:
|
|
|
|
handle.seek(4)
|
|
|
|
total_size = handle.read(4)
|
|
|
|
handle.seek(4)
|
|
|
|
handle.write(struct.pack(">I", size))
|
|
|
|
return struct.unpack(">I", total_size)[0]
|
|
|
|
|
2022-03-28 20:57:06 +00:00
|
|
|
def corrupt_file(fit, offset, value):
|
|
|
|
"""Corrupt a file
|
|
|
|
|
|
|
|
To corrupt a file, a value is written at the specified offset
|
|
|
|
|
|
|
|
Args:
|
|
|
|
fit: The file to corrupt
|
|
|
|
offset: Offset to write
|
|
|
|
value: Value written
|
|
|
|
"""
|
|
|
|
with open(fit, 'r+b') as handle:
|
|
|
|
handle.seek(offset)
|
|
|
|
handle.write(struct.pack(">I", value))
|
|
|
|
|
2020-03-18 17:44:07 +00:00
|
|
|
def create_rsa_pair(name):
|
|
|
|
"""Generate a new RSA key paid and certificate
|
|
|
|
|
|
|
|
Args:
|
|
|
|
name: Name of of the key (e.g. 'dev')
|
|
|
|
"""
|
|
|
|
public_exponent = 65537
|
2022-01-19 08:23:21 +00:00
|
|
|
|
|
|
|
if sha_algo == "sha384":
|
|
|
|
rsa_keygen_bits = 3072
|
|
|
|
else:
|
|
|
|
rsa_keygen_bits = 2048
|
|
|
|
|
2020-03-18 17:44:07 +00:00
|
|
|
util.run_and_log(cons, 'openssl genpkey -algorithm RSA -out %s%s.key '
|
2022-01-19 08:23:21 +00:00
|
|
|
'-pkeyopt rsa_keygen_bits:%d '
|
2020-03-18 17:44:07 +00:00
|
|
|
'-pkeyopt rsa_keygen_pubexp:%d' %
|
2022-01-19 08:23:21 +00:00
|
|
|
(tmpdir, name, rsa_keygen_bits, public_exponent))
|
2020-03-18 17:44:07 +00:00
|
|
|
|
|
|
|
# Create a certificate containing the public key
|
|
|
|
util.run_and_log(cons, 'openssl req -batch -new -x509 -key %s%s.key '
|
|
|
|
'-out %s%s.crt' % (tmpdir, name, tmpdir, name))
|
|
|
|
|
2020-04-29 13:26:16 +00:00
|
|
|
def test_with_algo(sha_algo, padding, sign_options):
|
2016-07-31 23:35:04 +00:00
|
|
|
"""Test verified boot with the given hash algorithm.
|
2016-07-03 15:40:46 +00:00
|
|
|
|
|
|
|
This is the main part of the test code. The same procedure is followed
|
|
|
|
for both hashing algorithms.
|
|
|
|
|
|
|
|
Args:
|
2016-07-31 23:35:06 +00:00
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to
|
|
|
|
use.
|
2020-04-29 13:26:16 +00:00
|
|
|
padding: Either '' or '-pss', to select the padding to use for the
|
|
|
|
rsa signature algorithm.
|
|
|
|
sign_options: Options to mkimage when signing a fit image.
|
2016-07-03 15:40:46 +00:00
|
|
|
"""
|
2016-07-31 23:35:02 +00:00
|
|
|
# Compile our device tree files for kernel and U-Boot. These are
|
|
|
|
# regenerated here since mkimage will modify them (by adding a
|
|
|
|
# public key) below.
|
2023-03-20 03:28:13 +00:00
|
|
|
dtc('sandbox-kernel.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
|
|
|
dtc('sandbox-u-boot.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
|
|
|
# Build the FIT, but don't sign anything yet
|
2016-07-31 23:35:06 +00:00
|
|
|
cons.log.action('%s: Test FIT with signed images' % sha_algo)
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('sign-images-%s%s.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
2022-02-03 20:43:50 +00:00
|
|
|
run_bootm(sha_algo, 'unsigned images', ' - OK' if algo_arg else 'dev-', True)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
|
|
|
# Sign images with our dev keys
|
2020-04-29 13:26:16 +00:00
|
|
|
sign_fit(sha_algo, sign_options)
|
2016-09-18 13:46:58 +00:00
|
|
|
run_bootm(sha_algo, 'signed images', 'dev+', True)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
|
|
|
# Create a fresh .dtb without the public keys
|
2023-03-20 03:28:13 +00:00
|
|
|
dtc('sandbox-u-boot.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2016-07-31 23:35:06 +00:00
|
|
|
cons.log.action('%s: Test FIT with signed configuration' % sha_algo)
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('sign-configs-%s%s.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
2022-02-03 20:43:50 +00:00
|
|
|
run_bootm(sha_algo, 'unsigned config', '%s+ OK' % ('sha256' if algo_arg else sha_algo), True)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
|
|
|
# Sign images with our dev keys
|
2020-04-29 13:26:16 +00:00
|
|
|
sign_fit(sha_algo, sign_options)
|
2016-09-18 13:46:58 +00:00
|
|
|
run_bootm(sha_algo, 'signed config', 'dev+', True)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2016-07-31 23:35:06 +00:00
|
|
|
cons.log.action('%s: Check signed config on the host' % sha_algo)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2020-03-18 17:43:58 +00:00
|
|
|
util.run_and_log(cons, [fit_check_sign, '-f', fit, '-k', dtb])
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2021-02-16 00:08:08 +00:00
|
|
|
if full_test:
|
2021-02-16 00:08:12 +00:00
|
|
|
# Make sure that U-Boot checks that the config is in the list of
|
|
|
|
# hashed nodes. If it isn't, a security bypass is possible.
|
2021-02-16 00:08:08 +00:00
|
|
|
ffit = '%stest.forged.fit' % tmpdir
|
|
|
|
shutil.copyfile(fit, ffit)
|
|
|
|
with open(ffit, 'rb') as fd:
|
|
|
|
root, strblock = vboot_forge.read_fdt(fd)
|
|
|
|
root, strblock = vboot_forge.manipulate(root, strblock)
|
|
|
|
with open(ffit, 'w+b') as fd:
|
|
|
|
vboot_forge.write_fdt(root, strblock, fd)
|
|
|
|
util.run_and_log_expect_exception(
|
|
|
|
cons, [fit_check_sign, '-f', ffit, '-k', dtb],
|
|
|
|
1, 'Failed to verify required signature')
|
|
|
|
|
|
|
|
run_bootm(sha_algo, 'forged config', 'Bad Data Hash', False, ffit)
|
|
|
|
|
|
|
|
# Try adding an evil root node. This should be detected.
|
|
|
|
efit = '%stest.evilf.fit' % tmpdir
|
|
|
|
shutil.copyfile(fit, efit)
|
|
|
|
vboot_evil.add_evil_node(fit, efit, evil_kernel, 'fakeroot')
|
|
|
|
|
|
|
|
util.run_and_log_expect_exception(
|
|
|
|
cons, [fit_check_sign, '-f', efit, '-k', dtb],
|
|
|
|
1, 'Failed to verify required signature')
|
2021-02-16 00:08:11 +00:00
|
|
|
run_bootm(sha_algo, 'evil fakeroot', 'Bad FIT kernel image format',
|
|
|
|
False, efit)
|
2021-02-16 00:08:08 +00:00
|
|
|
|
|
|
|
# Try adding an @ to the kernel node name. This should be detected.
|
|
|
|
efit = '%stest.evilk.fit' % tmpdir
|
|
|
|
shutil.copyfile(fit, efit)
|
|
|
|
vboot_evil.add_evil_node(fit, efit, evil_kernel, 'kernel@')
|
|
|
|
|
2021-02-16 00:08:12 +00:00
|
|
|
msg = 'Signature checking prevents use of unit addresses (@) in nodes'
|
2021-02-16 00:08:08 +00:00
|
|
|
util.run_and_log_expect_exception(
|
|
|
|
cons, [fit_check_sign, '-f', efit, '-k', dtb],
|
2021-02-16 00:08:12 +00:00
|
|
|
1, msg)
|
|
|
|
run_bootm(sha_algo, 'evil kernel@', msg, False, efit)
|
2020-03-18 17:43:59 +00:00
|
|
|
|
|
|
|
# Create a new properly signed fit and replace header bytes
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('sign-configs-%s%s.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
2020-04-29 13:26:16 +00:00
|
|
|
sign_fit(sha_algo, sign_options)
|
2018-06-09 15:38:05 +00:00
|
|
|
bcfg = u_boot_console.config.buildconfig
|
|
|
|
max_size = int(bcfg.get('config_fit_signature_max_size', 0x10000000), 0)
|
|
|
|
existing_size = replace_fit_totalsize(max_size + 1)
|
2020-03-18 17:44:04 +00:00
|
|
|
run_bootm(sha_algo, 'Signed config with bad hash', 'Bad Data Hash',
|
|
|
|
False)
|
2018-06-09 15:38:05 +00:00
|
|
|
cons.log.action('%s: Check overflowed FIT header totalsize' % sha_algo)
|
|
|
|
|
|
|
|
# Replace with existing header bytes
|
|
|
|
replace_fit_totalsize(existing_size)
|
|
|
|
run_bootm(sha_algo, 'signed config', 'dev+', True)
|
|
|
|
cons.log.action('%s: Check default FIT header totalsize' % sha_algo)
|
|
|
|
|
2016-07-03 15:40:46 +00:00
|
|
|
# Increment the first byte of the signature, which should cause failure
|
2016-07-31 23:35:05 +00:00
|
|
|
sig = util.run_and_log(cons, 'fdtget -t bx %s %s value' %
|
|
|
|
(fit, sig_node))
|
2016-07-03 15:40:46 +00:00
|
|
|
byte_list = sig.split()
|
|
|
|
byte = int(byte_list[0], 16)
|
2016-07-31 23:35:02 +00:00
|
|
|
byte_list[0] = '%x' % (byte + 1)
|
2016-07-03 15:40:46 +00:00
|
|
|
sig = ' '.join(byte_list)
|
2016-07-31 23:35:05 +00:00
|
|
|
util.run_and_log(cons, 'fdtput -t bx %s %s value %s' %
|
|
|
|
(fit, sig_node, sig))
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2020-03-18 17:44:04 +00:00
|
|
|
run_bootm(sha_algo, 'Signed config with bad hash', 'Bad Data Hash',
|
|
|
|
False)
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2016-07-31 23:35:06 +00:00
|
|
|
cons.log.action('%s: Check bad config on the host' % sha_algo)
|
2020-03-18 17:44:05 +00:00
|
|
|
util.run_and_log_expect_exception(
|
|
|
|
cons, [fit_check_sign, '-f', fit, '-k', dtb],
|
|
|
|
1, 'Failed to verify required signature')
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2020-04-29 13:26:16 +00:00
|
|
|
def test_required_key(sha_algo, padding, sign_options):
|
2019-09-18 14:04:53 +00:00
|
|
|
"""Test verified boot with the given hash algorithm.
|
|
|
|
|
2020-03-18 17:44:04 +00:00
|
|
|
This function tests if U-Boot rejects an image when a required key isn't
|
|
|
|
used to sign a FIT.
|
2019-09-18 14:04:53 +00:00
|
|
|
|
|
|
|
Args:
|
2020-03-18 17:44:04 +00:00
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to use
|
2020-04-29 13:26:16 +00:00
|
|
|
padding: Either '' or '-pss', to select the padding to use for the
|
|
|
|
rsa signature algorithm.
|
|
|
|
sign_options: Options to mkimage when signing a fit image.
|
2019-09-18 14:04:53 +00:00
|
|
|
"""
|
|
|
|
# Compile our device tree files for kernel and U-Boot. These are
|
|
|
|
# regenerated here since mkimage will modify them (by adding a
|
|
|
|
# public key) below.
|
2023-03-20 03:28:13 +00:00
|
|
|
dtc('sandbox-kernel.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
|
|
|
dtc('sandbox-u-boot.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
2019-09-18 14:04:53 +00:00
|
|
|
|
|
|
|
cons.log.action('%s: Test FIT with configs images' % sha_algo)
|
2020-03-18 17:44:04 +00:00
|
|
|
|
|
|
|
# Build the FIT with prod key (keys required) and sign it. This puts the
|
|
|
|
# signature into sandbox-u-boot.dtb, marked 'required'
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('sign-configs-%s%s-prod.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
2020-04-29 13:26:16 +00:00
|
|
|
sign_fit(sha_algo, sign_options)
|
2020-03-18 17:44:04 +00:00
|
|
|
|
|
|
|
# Build the FIT with dev key (keys NOT required). This adds the
|
|
|
|
# signature into sandbox-u-boot.dtb, NOT marked 'required'.
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('sign-configs-%s%s.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
2020-08-17 06:01:10 +00:00
|
|
|
sign_fit_norequire(sha_algo, sign_options)
|
2019-09-18 14:04:53 +00:00
|
|
|
|
2020-03-18 17:44:04 +00:00
|
|
|
# So now sandbox-u-boot.dtb two signatures, for the prod and dev keys.
|
|
|
|
# Only the prod key is set as 'required'. But FIT we just built has
|
2020-08-17 06:01:10 +00:00
|
|
|
# a dev signature only (sign_fit_norequire() overwrites the FIT).
|
2020-03-18 17:44:04 +00:00
|
|
|
# Try to boot the FIT with dev key. This FIT should not be accepted by
|
|
|
|
# U-Boot because the prod key is required.
|
|
|
|
run_bootm(sha_algo, 'required key', '', False)
|
2019-09-18 14:04:53 +00:00
|
|
|
|
2020-08-17 06:01:10 +00:00
|
|
|
# Build the FIT with dev key (keys required) and sign it. This puts the
|
|
|
|
# signature into sandbox-u-boot.dtb, marked 'required'.
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('sign-configs-%s%s.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
2020-08-17 06:01:10 +00:00
|
|
|
sign_fit(sha_algo, sign_options)
|
|
|
|
|
|
|
|
# Set the required-mode policy to "any".
|
|
|
|
# So now sandbox-u-boot.dtb two signatures, for the prod and dev keys.
|
|
|
|
# Both the dev and prod key are set as 'required'. But FIT we just built has
|
|
|
|
# a dev signature only (sign_fit() overwrites the FIT).
|
|
|
|
# Try to boot the FIT with dev key. This FIT should be accepted by
|
|
|
|
# U-Boot because the dev key is required and policy is "any" required key.
|
|
|
|
util.run_and_log(cons, 'fdtput -t s %s /signature required-mode any' %
|
|
|
|
(dtb))
|
|
|
|
run_bootm(sha_algo, 'multi required key', 'dev+', True)
|
|
|
|
|
|
|
|
# Set the required-mode policy to "all".
|
|
|
|
# So now sandbox-u-boot.dtb two signatures, for the prod and dev keys.
|
|
|
|
# Both the dev and prod key are set as 'required'. But FIT we just built has
|
|
|
|
# a dev signature only (sign_fit() overwrites the FIT).
|
|
|
|
# Try to boot the FIT with dev key. This FIT should not be accepted by
|
|
|
|
# U-Boot because the prod key is required and policy is "all" required key
|
|
|
|
util.run_and_log(cons, 'fdtput -t s %s /signature required-mode all' %
|
|
|
|
(dtb))
|
|
|
|
run_bootm(sha_algo, 'multi required key', '', False)
|
|
|
|
|
2022-03-28 20:57:06 +00:00
|
|
|
def test_global_sign(sha_algo, padding, sign_options):
|
|
|
|
"""Test global image signature with the given hash algorithm and padding.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to use
|
|
|
|
padding: Either '' or '-pss', to select the padding to use for the
|
|
|
|
rsa signature algorithm.
|
|
|
|
"""
|
|
|
|
|
|
|
|
dtb = '%ssandbox-u-boot-global%s.dtb' % (tmpdir, padding)
|
|
|
|
cons.config.dtb = dtb
|
|
|
|
|
|
|
|
# Compile our device tree files for kernel and U-Boot. These are
|
|
|
|
# regenerated here since mkimage will modify them (by adding a
|
|
|
|
# public key) below.
|
2023-03-20 03:28:13 +00:00
|
|
|
dtc('sandbox-kernel.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
2022-03-28 20:57:06 +00:00
|
|
|
dtc_options('sandbox-u-boot-global%s.dts' % padding, '-p 1024')
|
|
|
|
|
|
|
|
# Build the FIT with dev key (keys NOT required). This adds the
|
|
|
|
# signature into sandbox-u-boot.dtb, NOT marked 'required'.
|
2023-03-20 03:28:13 +00:00
|
|
|
make_fit('simple-images.its', cons, mkimage, dtc_args, datadir, fit)
|
2022-03-28 20:57:06 +00:00
|
|
|
sign_fit_dtb(sha_algo, '', dtb)
|
|
|
|
|
|
|
|
# Build the dtb for binman that define the pre-load header
|
|
|
|
# with the global sigature.
|
2023-03-20 03:28:13 +00:00
|
|
|
dtc('sandbox-binman%s.dts' % padding, cons, dtc_args, datadir, tmpdir, dtb)
|
2022-03-28 20:57:06 +00:00
|
|
|
|
|
|
|
# Run binman to create the final image with the not signed fit
|
|
|
|
# and the pre-load header that contains the global signature.
|
|
|
|
run_binman('sandbox-binman%s.dtb' % padding)
|
|
|
|
|
|
|
|
# Check that the signature is correctly verified by u-boot
|
|
|
|
run_bootm(sha_algo, 'global image signature',
|
|
|
|
'signature check has succeed', True, "%ssandbox.img" % tmpdir)
|
|
|
|
|
|
|
|
# Corrupt the image (just one byte after the pre-load header)
|
|
|
|
corrupt_file("%ssandbox.img" % tmpdir, 4096, 255);
|
|
|
|
|
|
|
|
# Check that the signature verification fails
|
|
|
|
run_bootm(sha_algo, 'global image signature',
|
|
|
|
'signature check has failed', False, "%ssandbox.img" % tmpdir)
|
|
|
|
|
|
|
|
# Check that the boot fails if the global signature is not provided
|
|
|
|
run_bootm(sha_algo, 'global image signature', 'signature is mandatory', False)
|
|
|
|
|
2016-07-03 15:40:46 +00:00
|
|
|
cons = u_boot_console
|
2021-09-19 21:14:48 +00:00
|
|
|
tmpdir = os.path.join(cons.config.result_dir, name) + '/'
|
|
|
|
if not os.path.exists(tmpdir):
|
|
|
|
os.mkdir(tmpdir)
|
2016-07-18 16:07:25 +00:00
|
|
|
datadir = cons.config.source_dir + '/test/py/tests/vboot/'
|
2016-07-03 15:40:46 +00:00
|
|
|
fit = '%stest.fit' % tmpdir
|
|
|
|
mkimage = cons.config.build_dir + '/tools/mkimage'
|
2022-03-28 20:57:06 +00:00
|
|
|
binman = cons.config.source_dir + '/tools/binman/binman'
|
2016-07-03 15:40:46 +00:00
|
|
|
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
|
2018-11-14 12:51:05 +00:00
|
|
|
sig_node = '/configurations/conf-1/signature'
|
2016-07-03 15:40:46 +00:00
|
|
|
|
2020-03-18 17:44:07 +00:00
|
|
|
create_rsa_pair('dev')
|
|
|
|
create_rsa_pair('prod')
|
2019-09-18 14:04:53 +00:00
|
|
|
|
2016-07-03 15:40:46 +00:00
|
|
|
# Create a number kernel image with zeroes
|
2021-02-16 00:08:08 +00:00
|
|
|
with open('%stest-kernel.bin' % tmpdir, 'wb') as fd:
|
|
|
|
fd.write(500 * b'\0')
|
|
|
|
|
|
|
|
# Create a second kernel image with ones
|
|
|
|
evil_kernel = '%stest-kernel1.bin' % tmpdir
|
|
|
|
with open(evil_kernel, 'wb') as fd:
|
|
|
|
fd.write(500 * b'\x01')
|
2016-07-03 15:40:46 +00:00
|
|
|
|
|
|
|
try:
|
|
|
|
# We need to use our own device tree file. Remember to restore it
|
|
|
|
# afterwards.
|
|
|
|
old_dtb = cons.config.dtb
|
|
|
|
cons.config.dtb = dtb
|
2022-03-28 20:57:06 +00:00
|
|
|
if global_sign:
|
|
|
|
test_global_sign(sha_algo, padding, sign_options)
|
|
|
|
elif required:
|
2020-04-29 13:26:16 +00:00
|
|
|
test_required_key(sha_algo, padding, sign_options)
|
2020-03-18 17:44:00 +00:00
|
|
|
else:
|
2020-04-29 13:26:16 +00:00
|
|
|
test_with_algo(sha_algo, padding, sign_options)
|
2016-07-03 15:40:46 +00:00
|
|
|
finally:
|
2016-07-31 23:35:08 +00:00
|
|
|
# Go back to the original U-Boot with the correct dtb.
|
2016-07-03 15:40:46 +00:00
|
|
|
cons.config.dtb = old_dtb
|
2016-07-31 23:35:08 +00:00
|
|
|
cons.restart_uboot()
|
2023-03-20 03:28:13 +00:00
|
|
|
|
|
|
|
|
|
|
|
TESTDATA_IN = [
|
|
|
|
['sha1-basic', 'sha1', '', None, False],
|
|
|
|
['sha1-pad', 'sha1', '', '-E -p 0x10000', False],
|
|
|
|
['sha1-pss', 'sha1', '-pss', None, False],
|
|
|
|
['sha1-pss-pad', 'sha1', '-pss', '-E -p 0x10000', False],
|
|
|
|
['sha256-basic', 'sha256', '', None, False],
|
|
|
|
['sha256-pad', 'sha256', '', '-E -p 0x10000', False],
|
|
|
|
['sha256-pss', 'sha256', '-pss', None, False],
|
|
|
|
['sha256-pss-pad', 'sha256', '-pss', '-E -p 0x10000', False],
|
|
|
|
['sha256-pss-required', 'sha256', '-pss', None, False],
|
|
|
|
['sha256-pss-pad-required', 'sha256', '-pss', '-E -p 0x10000', False],
|
|
|
|
['sha384-basic', 'sha384', '', None, False],
|
|
|
|
['sha384-pad', 'sha384', '', '-E -p 0x10000', False],
|
|
|
|
['algo-arg', 'algo-arg', '', '-o sha256,rsa2048', True],
|
|
|
|
['sha256-global-sign', 'sha256', '', '', False],
|
|
|
|
['sha256-global-sign-pss', 'sha256', '-pss', '', False],
|
|
|
|
]
|
|
|
|
|
|
|
|
# Mark all but the first test as slow, so they are not run with '-k not slow'
|
|
|
|
TESTDATA = [TESTDATA_IN[0]]
|
|
|
|
TESTDATA += [pytest.param(*v, marks=pytest.mark.slow) for v in TESTDATA_IN[1:]]
|
|
|
|
|
|
|
|
@pytest.mark.boardspec('sandbox')
|
|
|
|
@pytest.mark.buildconfigspec('fit_signature')
|
|
|
|
@pytest.mark.requiredtool('dtc')
|
|
|
|
@pytest.mark.requiredtool('openssl')
|
|
|
|
@pytest.mark.parametrize("name,sha_algo,padding,sign_options,algo_arg", TESTDATA)
|
|
|
|
def test_fdt_add_pubkey(u_boot_console, name, sha_algo, padding, sign_options, algo_arg):
|
|
|
|
"""Test fdt_add_pubkey utility with bunch of different algo options."""
|
|
|
|
|
|
|
|
def sign_fit(sha_algo, options):
|
|
|
|
"""Sign the FIT
|
|
|
|
|
|
|
|
Signs the FIT and writes the signature into it.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to
|
|
|
|
use.
|
|
|
|
options: Options to provide to mkimage.
|
|
|
|
"""
|
|
|
|
args = [mkimage, '-F', '-k', tmpdir, fit]
|
|
|
|
if options:
|
|
|
|
args += options.split(' ')
|
|
|
|
cons.log.action('%s: Sign images' % sha_algo)
|
|
|
|
util.run_and_log(cons, args)
|
|
|
|
|
|
|
|
def test_add_pubkey(sha_algo, padding, sign_options):
|
|
|
|
"""Test fdt_add_pubkey utility with given hash algorithm and padding.
|
|
|
|
|
|
|
|
This function tests if fdt_add_pubkey utility may add public keys into dtb.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
sha_algo: Either 'sha1' or 'sha256', to select the algorithm to use
|
|
|
|
padding: Either '' or '-pss', to select the padding to use for the
|
|
|
|
rsa signature algorithm.
|
|
|
|
sign_options: Options to mkimage when signing a fit image.
|
|
|
|
"""
|
|
|
|
|
|
|
|
# Create a fresh .dtb without the public keys
|
|
|
|
dtc('sandbox-u-boot.dts', cons, dtc_args, datadir, tmpdir, dtb)
|
|
|
|
|
|
|
|
cons.log.action('%s: Test fdt_add_pubkey with signed configuration' % sha_algo)
|
|
|
|
# Then add the dev key via the fdt_add_pubkey tool
|
|
|
|
util.run_and_log(cons, [fdt_add_pubkey, '-a', '%s,%s' % ('sha256' if algo_arg else sha_algo, \
|
|
|
|
'rsa3072' if sha_algo == 'sha384' else 'rsa2048'),
|
|
|
|
'-k', tmpdir, '-n', 'dev', '-r', 'conf', dtb])
|
|
|
|
|
|
|
|
make_fit('sign-configs-%s%s.its' % (sha_algo, padding), cons, mkimage, dtc_args, datadir, fit)
|
|
|
|
|
|
|
|
# Sign images with our dev keys
|
|
|
|
sign_fit(sha_algo, sign_options)
|
|
|
|
|
|
|
|
# Check with fit_check_sign that FIT is signed with key
|
|
|
|
util.run_and_log(cons, [fit_check_sign, '-f', fit, '-k', dtb])
|
|
|
|
|
|
|
|
cons = u_boot_console
|
|
|
|
tmpdir = os.path.join(cons.config.result_dir, name) + '/'
|
|
|
|
if not os.path.exists(tmpdir):
|
|
|
|
os.mkdir(tmpdir)
|
|
|
|
datadir = cons.config.source_dir + '/test/py/tests/vboot/'
|
|
|
|
fit = '%stest.fit' % tmpdir
|
|
|
|
mkimage = cons.config.build_dir + '/tools/mkimage'
|
|
|
|
binman = cons.config.source_dir + '/tools/binman/binman'
|
|
|
|
fit_check_sign = cons.config.build_dir + '/tools/fit_check_sign'
|
|
|
|
fdt_add_pubkey = cons.config.build_dir + '/tools/fdt_add_pubkey'
|
|
|
|
dtc_args = '-I dts -O dtb -i %s' % tmpdir
|
|
|
|
dtb = '%ssandbox-u-boot.dtb' % tmpdir
|
|
|
|
|
|
|
|
# keys created in test_vboot test
|
|
|
|
|
|
|
|
test_add_pubkey(sha_algo, padding, sign_options)
|