blob: d722efdeb5ed6d6adf849566fd90e15103755da6 [file] [log] [blame]
Carles Cufi37d052f2018-01-30 16:40:10 +01001# Copyright 2018 Nordic Semiconductor ASA
David Vinczeb2a1a482020-09-18 11:54:30 +02002# Copyright 2017-2020 Linaro Limited
Roland Mikhel3d92a6c2023-02-23 15:35:44 +01003# Copyright 2019-2023 Arm Limited
David Brown1314bf32017-12-20 11:10:55 -07004#
David Brown79c4fcf2021-01-26 15:04:05 -07005# SPDX-License-Identifier: Apache-2.0
6#
David Brown1314bf32017-12-20 11:10:55 -07007# Licensed under the Apache License, Version 2.0 (the "License");
8# you may not use this file except in compliance with the License.
9# You may obtain a copy of the License at
10#
11# http://www.apache.org/licenses/LICENSE-2.0
12#
13# Unless required by applicable law or agreed to in writing, software
14# distributed under the License is distributed on an "AS IS" BASIS,
15# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16# See the License for the specific language governing permissions and
17# limitations under the License.
18
David Brown23f91ad2017-05-16 11:38:17 -060019"""
20Image signing and management.
21"""
22
23from . import version as versmod
David Vincze71b8f982020-03-17 19:08:12 +010024from .boot_record import create_sw_component_data
Fabio Utzig9a492d52020-01-15 11:31:52 -030025import click
Fabio Utzig4a5477a2019-05-27 15:45:08 -030026from enum import Enum
Carles Cufi37d052f2018-01-30 16:40:10 +010027from intelhex import IntelHex
David Brown23f91ad2017-05-16 11:38:17 -060028import hashlib
29import struct
Carles Cufi37d052f2018-01-30 16:40:10 +010030import os.path
Fabio Utzig960b4c52020-04-02 13:07:12 -030031from .keys import rsa, ecdsa, x25519
Fabio Utzig7a3b2602019-10-22 09:56:44 -030032from cryptography.hazmat.primitives.asymmetric import ec, padding
Fabio Utzig960b4c52020-04-02 13:07:12 -030033from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PrivateKey
Fabio Utzig06b77b82018-08-23 16:01:16 -030034from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
Fabio Utzig7a3b2602019-10-22 09:56:44 -030035from cryptography.hazmat.primitives.kdf.hkdf import HKDF
36from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat
Fabio Utzig06b77b82018-08-23 16:01:16 -030037from cryptography.hazmat.backends import default_backend
Fabio Utzig7a3b2602019-10-22 09:56:44 -030038from cryptography.hazmat.primitives import hashes, hmac
Fabio Utzig4a5477a2019-05-27 15:45:08 -030039from cryptography.exceptions import InvalidSignature
David Brown23f91ad2017-05-16 11:38:17 -060040
David Brown72e7a512017-09-01 11:08:23 -060041IMAGE_MAGIC = 0x96f3b83d
David Brown23f91ad2017-05-16 11:38:17 -060042IMAGE_HEADER_SIZE = 32
Carles Cufi37d052f2018-01-30 16:40:10 +010043BIN_EXT = "bin"
44INTEL_HEX_EXT = "hex"
Fabio Utzig519285f2018-06-04 11:11:53 -030045DEFAULT_MAX_SECTORS = 128
Kristine Jassmann73c38c62021-02-03 16:56:14 +000046DEFAULT_MAX_ALIGN = 8
David Vinczeda8c9192019-03-26 17:17:41 +010047DEP_IMAGES_KEY = "images"
48DEP_VERSIONS_KEY = "versions"
David Vincze71b8f982020-03-17 19:08:12 +010049MAX_SW_TYPE_LENGTH = 12 # Bytes
David Brown23f91ad2017-05-16 11:38:17 -060050
51# Image header flags.
52IMAGE_F = {
53 'PIC': 0x0000001,
Salome Thirot0f641972021-05-14 11:19:55 +010054 'ENCRYPTED_AES128': 0x0000004,
55 'ENCRYPTED_AES256': 0x0000008,
Fabio Utzig06b77b82018-08-23 16:01:16 -030056 'NON_BOOTABLE': 0x0000010,
David Vincze1e0c5442020-04-07 14:12:33 +020057 'RAM_LOAD': 0x0000020,
Dominik Ermel50820b12020-12-14 13:16:46 +000058 'ROM_FIXED': 0x0000100,
Fabio Utzig06b77b82018-08-23 16:01:16 -030059}
David Brown23f91ad2017-05-16 11:38:17 -060060
61TLV_VALUES = {
David Brown43cda332017-09-01 09:53:23 -060062 'KEYHASH': 0x01,
David Vinczedde178d2020-03-26 20:06:01 +010063 'PUBKEY': 0x02,
David Brown27648b82017-08-31 10:40:29 -060064 'SHA256': 0x10,
Roland Mikhel57041742023-02-03 14:43:13 +010065 'SHA384': 0x11,
David Brown27648b82017-08-31 10:40:29 -060066 'RSA2048': 0x20,
David Vincze4395b802023-04-27 16:11:49 +020067 'ECDSASIG': 0x22,
Fabio Utzig19fd79a2019-05-08 18:20:39 -030068 'RSA3072': 0x23,
Fabio Utzig8101d1f2019-05-09 15:03:22 -030069 'ED25519': 0x24,
Fabio Utzig06b77b82018-08-23 16:01:16 -030070 'ENCRSA2048': 0x30,
Salome Thirot0f641972021-05-14 11:19:55 +010071 'ENCKW': 0x31,
Fabio Utzig7a3b2602019-10-22 09:56:44 -030072 'ENCEC256': 0x32,
Fabio Utzig960b4c52020-04-02 13:07:12 -030073 'ENCX25519': 0x33,
David Vincze1a7a6902020-02-18 15:05:16 +010074 'DEPENDENCY': 0x40,
75 'SEC_CNT': 0x50,
David Vincze71b8f982020-03-17 19:08:12 +010076 'BOOT_RECORD': 0x60,
Fabio Utzig06b77b82018-08-23 16:01:16 -030077}
David Brown23f91ad2017-05-16 11:38:17 -060078
Fabio Utzig4a5477a2019-05-27 15:45:08 -030079TLV_SIZE = 4
David Brownf5b33d82017-09-01 10:58:27 -060080TLV_INFO_SIZE = 4
81TLV_INFO_MAGIC = 0x6907
Fabio Utzig510fddb2019-09-12 12:15:36 -030082TLV_PROT_INFO_MAGIC = 0x6908
David Brown23f91ad2017-05-16 11:38:17 -060083
Piotr Dymacze026c362023-02-24 12:09:33 +010084TLV_VENDOR_RES_MIN = 0x00a0
85TLV_VENDOR_RES_MAX = 0xfffe
86
Mark Schultea66c6872018-09-26 17:24:40 -070087STRUCT_ENDIAN_DICT = {
88 'little': '<',
89 'big': '>'
90}
91
Fabio Utzig4a5477a2019-05-27 15:45:08 -030092VerifyResult = Enum('VerifyResult',
93 """
94 OK INVALID_MAGIC INVALID_TLV_INFO_MAGIC INVALID_HASH
95 INVALID_SIGNATURE
96 """)
97
Roland Mikhel57041742023-02-03 14:43:13 +010098
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -030099def align_up(num, align):
100 assert (align & (align - 1) == 0) and align != 0
101 return (num + (align - 1)) & ~(align - 1)
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300102
Roland Mikhel57041742023-02-03 14:43:13 +0100103
David Brown23f91ad2017-05-16 11:38:17 -0600104class TLV():
Fabio Utzig510fddb2019-09-12 12:15:36 -0300105 def __init__(self, endian, magic=TLV_INFO_MAGIC):
106 self.magic = magic
David Brown23f91ad2017-05-16 11:38:17 -0600107 self.buf = bytearray()
Mark Schultea66c6872018-09-26 17:24:40 -0700108 self.endian = endian
David Brown23f91ad2017-05-16 11:38:17 -0600109
Fabio Utzig510fddb2019-09-12 12:15:36 -0300110 def __len__(self):
111 return TLV_INFO_SIZE + len(self.buf)
112
David Brown23f91ad2017-05-16 11:38:17 -0600113 def add(self, kind, payload):
Fabio Utzig510fddb2019-09-12 12:15:36 -0300114 """
115 Add a TLV record. Kind should be a string found in TLV_VALUES above.
116 """
Mark Schultea66c6872018-09-26 17:24:40 -0700117 e = STRUCT_ENDIAN_DICT[self.endian]
Ihor Slabkyy24d93732020-03-10 15:33:57 +0200118 if isinstance(kind, int):
Piotr Dymacze026c362023-02-24 12:09:33 +0100119 if not TLV_VENDOR_RES_MIN <= kind <= TLV_VENDOR_RES_MAX:
120 msg = "Invalid custom TLV type value '0x{:04x}', allowed " \
121 "value should be between 0x{:04x} and 0x{:04x}".format(
Roland Mikhel57041742023-02-03 14:43:13 +0100122 kind, TLV_VENDOR_RES_MIN, TLV_VENDOR_RES_MAX)
Piotr Dymacze026c362023-02-24 12:09:33 +0100123 raise click.UsageError(msg)
124 buf = struct.pack(e + 'HH', kind, len(payload))
Ihor Slabkyy24d93732020-03-10 15:33:57 +0200125 else:
126 buf = struct.pack(e + 'BBH', TLV_VALUES[kind], 0, len(payload))
David Brown23f91ad2017-05-16 11:38:17 -0600127 self.buf += buf
128 self.buf += payload
129
130 def get(self):
Fabio Utzig510fddb2019-09-12 12:15:36 -0300131 if len(self.buf) == 0:
132 return bytes()
Mark Schultea66c6872018-09-26 17:24:40 -0700133 e = STRUCT_ENDIAN_DICT[self.endian]
Fabio Utzig510fddb2019-09-12 12:15:36 -0300134 header = struct.pack(e + 'HH', self.magic, len(self))
David Brownf5b33d82017-09-01 10:58:27 -0600135 return header + bytes(self.buf)
David Brown23f91ad2017-05-16 11:38:17 -0600136
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200137
David Brown23f91ad2017-05-16 11:38:17 -0600138class Image():
Carles Cufi37d052f2018-01-30 16:40:10 +0100139
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200140 def __init__(self, version=None, header_size=IMAGE_HEADER_SIZE,
Henrik Brix Andersen0ce958e2020-03-11 14:04:11 +0100141 pad_header=False, pad=False, confirm=False, align=1,
142 slot_size=0, max_sectors=DEFAULT_MAX_SECTORS,
143 overwrite_only=False, endian="little", load_addr=0,
Dominik Ermel50820b12020-12-14 13:16:46 +0000144 rom_fixed=None, erased_val=None, save_enctlv=False,
Piotr Mienkowskib6d5cf32022-01-31 01:01:11 +0100145 security_counter=None, max_align=None):
Dominik Ermel50820b12020-12-14 13:16:46 +0000146
147 if load_addr and rom_fixed:
148 raise click.UsageError("Can not set rom_fixed and load_addr at the same time")
149
David Brown23f91ad2017-05-16 11:38:17 -0600150 self.version = version or versmod.decode_version("0")
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200151 self.header_size = header_size
152 self.pad_header = pad_header
David Brown23f91ad2017-05-16 11:38:17 -0600153 self.pad = pad
Henrik Brix Andersen0ce958e2020-03-11 14:04:11 +0100154 self.confirm = confirm
Fabio Utzig263d4392018-06-05 10:37:35 -0300155 self.align = align
156 self.slot_size = slot_size
157 self.max_sectors = max_sectors
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700158 self.overwrite_only = overwrite_only
Mark Schultea66c6872018-09-26 17:24:40 -0700159 self.endian = endian
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200160 self.base_addr = None
Håkon Øye Amundsendf8c8912019-08-26 12:15:28 +0000161 self.load_addr = 0 if load_addr is None else load_addr
Dominik Ermel50820b12020-12-14 13:16:46 +0000162 self.rom_fixed = rom_fixed
Fabio Utzigcb080732020-02-07 12:01:39 -0300163 self.erased_val = 0xff if erased_val is None else int(erased_val, 0)
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200164 self.payload = []
Fabio Utzig649d80f2019-09-12 10:26:23 -0300165 self.enckey = None
Fabio Utzig9a492d52020-01-15 11:31:52 -0300166 self.save_enctlv = save_enctlv
167 self.enctlv_len = 0
Piotr Mienkowskib6d5cf32022-01-31 01:01:11 +0100168 self.max_align = max(DEFAULT_MAX_ALIGN, align) if max_align is None else int(max_align)
David Brown23f91ad2017-05-16 11:38:17 -0600169
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300170 if self.max_align == DEFAULT_MAX_ALIGN:
171 self.boot_magic = bytes([
172 0x77, 0xc2, 0x95, 0xf3,
173 0x60, 0xd2, 0xef, 0x7f,
174 0x35, 0x52, 0x50, 0x0f,
175 0x2c, 0xb6, 0x79, 0x80, ])
176 else:
Raphael Dupont16f3de52023-03-16 09:02:11 +0100177 lsb = self.max_align & 0x00ff
178 msb = (self.max_align & 0xff00) >> 8
179 align = bytes([msb, lsb]) if self.endian == "big" else bytes([lsb, msb])
180 self.boot_magic = align + bytes([0x2d, 0xe1,
181 0x5d, 0x29, 0x41, 0x0b,
182 0x8d, 0x77, 0x67, 0x9c,
183 0x11, 0x0f, 0x1f, 0x8a, ])
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300184
David Vincze1a7a6902020-02-18 15:05:16 +0100185 if security_counter == 'auto':
186 # Security counter has not been explicitly provided,
187 # generate it from the version number
188 self.security_counter = ((self.version.major << 24)
189 + (self.version.minor << 16)
190 + self.version.revision)
191 else:
192 self.security_counter = security_counter
193
David Brown23f91ad2017-05-16 11:38:17 -0600194 def __repr__(self):
David Vincze1a7a6902020-02-18 15:05:16 +0100195 return "<Image version={}, header_size={}, security_counter={}, \
196 base_addr={}, load_addr={}, align={}, slot_size={}, \
197 max_sectors={}, overwrite_only={}, endian={} format={}, \
198 payloadlen=0x{:x}>".format(
Fabio Utzig263d4392018-06-05 10:37:35 -0300199 self.version,
200 self.header_size,
David Vincze1a7a6902020-02-18 15:05:16 +0100201 self.security_counter,
Fabio Utzig263d4392018-06-05 10:37:35 -0300202 self.base_addr if self.base_addr is not None else "N/A",
Håkon Øye Amundsendf8c8912019-08-26 12:15:28 +0000203 self.load_addr,
Fabio Utzig263d4392018-06-05 10:37:35 -0300204 self.align,
205 self.slot_size,
206 self.max_sectors,
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700207 self.overwrite_only,
Mark Schultea66c6872018-09-26 17:24:40 -0700208 self.endian,
Fabio Utzig263d4392018-06-05 10:37:35 -0300209 self.__class__.__name__,
210 len(self.payload))
David Brown23f91ad2017-05-16 11:38:17 -0600211
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200212 def load(self, path):
213 """Load an image from a given file"""
214 ext = os.path.splitext(path)[1][1:].lower()
Fabio Utzig1f508922020-01-15 11:37:51 -0300215 try:
216 if ext == INTEL_HEX_EXT:
217 ih = IntelHex(path)
218 self.payload = ih.tobinarray()
219 self.base_addr = ih.minaddr()
220 else:
221 with open(path, 'rb') as f:
222 self.payload = f.read()
223 except FileNotFoundError:
224 raise click.UsageError("Input file not found")
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200225
226 # Add the image header if needed.
227 if self.pad_header and self.header_size > 0:
228 if self.base_addr:
229 # Adjust base_addr for new header
230 self.base_addr -= self.header_size
Fabio Utzig9117fde2019-10-17 11:11:46 -0300231 self.payload = bytes([self.erased_val] * self.header_size) + \
232 self.payload
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200233
Fabio Utzig9a492d52020-01-15 11:31:52 -0300234 self.check_header()
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200235
Fabio Utzigedbabcf2019-10-11 13:03:37 -0300236 def save(self, path, hex_addr=None):
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200237 """Save an image from a given file"""
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200238 ext = os.path.splitext(path)[1][1:].lower()
239 if ext == INTEL_HEX_EXT:
240 # input was in binary format, but HEX needs to know the base addr
Fabio Utzigedbabcf2019-10-11 13:03:37 -0300241 if self.base_addr is None and hex_addr is None:
Fabio Utzig1f508922020-01-15 11:37:51 -0300242 raise click.UsageError("No address exists in input file "
243 "neither was it provided by user")
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200244 h = IntelHex()
Fabio Utzigedbabcf2019-10-11 13:03:37 -0300245 if hex_addr is not None:
246 self.base_addr = hex_addr
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200247 h.frombytes(bytes=self.payload, offset=self.base_addr)
Fabio Utzigedbabcf2019-10-11 13:03:37 -0300248 if self.pad:
Fabio Utzig2269f472019-10-17 11:14:33 -0300249 trailer_size = self._trailer_size(self.align, self.max_sectors,
250 self.overwrite_only,
Fabio Utzig9a492d52020-01-15 11:31:52 -0300251 self.enckey,
252 self.save_enctlv,
253 self.enctlv_len)
Fabio Utzig2269f472019-10-17 11:14:33 -0300254 trailer_addr = (self.base_addr + self.slot_size) - trailer_size
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000255 if self.confirm and not self.overwrite_only:
Roland Mikhel57041742023-02-03 14:43:13 +0100256 magic_align_size = align_up(len(self.boot_magic),
257 self.max_align)
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000258 image_ok_idx = -(magic_align_size + self.max_align)
Alexander Mihajlovicf4df58f2022-08-17 15:44:53 +0200259 flag = bytearray([self.erased_val] * self.max_align)
Roland Mikhel57041742023-02-03 14:43:13 +0100260 flag[0] = 0x01 # image_ok = 0x01
261 h.puts(trailer_addr + trailer_size + image_ok_idx,
262 bytes(flag))
Wouter Cappellec028d452022-01-25 10:25:24 +0100263 h.puts(trailer_addr + (trailer_size - len(self.boot_magic)),
264 bytes(self.boot_magic))
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200265 h.tofile(path, 'hex')
266 else:
Fabio Utzigedbabcf2019-10-11 13:03:37 -0300267 if self.pad:
268 self.pad_to(self.slot_size)
Fabio Utzig7c00acd2019-01-07 09:54:20 -0200269 with open(path, 'wb') as f:
270 f.write(self.payload)
271
Fabio Utzig9a492d52020-01-15 11:31:52 -0300272 def check_header(self):
Fabio Utzigf5556c32019-10-23 11:00:27 -0300273 if self.header_size > 0 and not self.pad_header:
David Brown23f91ad2017-05-16 11:38:17 -0600274 if any(v != 0 for v in self.payload[0:self.header_size]):
Fabio Utzig9a492d52020-01-15 11:31:52 -0300275 raise click.UsageError("Header padding was not requested and "
276 "image does not start with zeros")
277
278 def check_trailer(self):
Fabio Utzig263d4392018-06-05 10:37:35 -0300279 if self.slot_size > 0:
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700280 tsize = self._trailer_size(self.align, self.max_sectors,
Fabio Utzig9a492d52020-01-15 11:31:52 -0300281 self.overwrite_only, self.enckey,
282 self.save_enctlv, self.enctlv_len)
Fabio Utzig263d4392018-06-05 10:37:35 -0300283 padding = self.slot_size - (len(self.payload) + tsize)
284 if padding < 0:
Fabio Utzig9a492d52020-01-15 11:31:52 -0300285 msg = "Image size (0x{:x}) + trailer (0x{:x}) exceeds " \
286 "requested size 0x{:x}".format(
287 len(self.payload), tsize, self.slot_size)
288 raise click.UsageError(msg)
David Brown23f91ad2017-05-16 11:38:17 -0600289
Fabio Utzig960b4c52020-04-02 13:07:12 -0300290 def ecies_hkdf(self, enckey, plainkey):
291 if isinstance(enckey, ecdsa.ECDSA256P1Public):
292 newpk = ec.generate_private_key(ec.SECP256R1(), default_backend())
293 shared = newpk.exchange(ec.ECDH(), enckey._get_public())
294 else:
295 newpk = X25519PrivateKey.generate()
296 shared = newpk.exchange(enckey._get_public())
Fabio Utzig7a3b2602019-10-22 09:56:44 -0300297 derived_key = HKDF(
298 algorithm=hashes.SHA256(), length=48, salt=None,
299 info=b'MCUBoot_ECIES_v1', backend=default_backend()).derive(shared)
300 encryptor = Cipher(algorithms.AES(derived_key[:16]),
301 modes.CTR(bytes([0] * 16)),
302 backend=default_backend()).encryptor()
303 cipherkey = encryptor.update(plainkey) + encryptor.finalize()
304 mac = hmac.HMAC(derived_key[16:], hashes.SHA256(),
305 backend=default_backend())
306 mac.update(cipherkey)
307 ciphermac = mac.finalize()
Fabio Utzig960b4c52020-04-02 13:07:12 -0300308 if isinstance(enckey, ecdsa.ECDSA256P1Public):
309 pubk = newpk.public_key().public_bytes(
310 encoding=Encoding.X962,
311 format=PublicFormat.UncompressedPoint)
312 else:
313 pubk = newpk.public_key().public_bytes(
314 encoding=Encoding.Raw,
315 format=PublicFormat.Raw)
Fabio Utzig7a3b2602019-10-22 09:56:44 -0300316 return cipherkey, ciphermac, pubk
317
David Vinczedde178d2020-03-26 20:06:01 +0100318 def create(self, key, public_key_format, enckey, dependencies=None,
Roland Mikhel57041742023-02-03 14:43:13 +0100319 sw_type=None, custom_tlvs=None, encrypt_keylen=128, clear=False,
320 fixed_sig=None, pub_key=None, vector_to_sign=None,
321 use_legacy_tlv=False):
Fabio Utzig649d80f2019-09-12 10:26:23 -0300322 self.enckey = enckey
323
Roland Mikhel57041742023-02-03 14:43:13 +0100324 # Check what hashing algorithm should be used
325 if (key is not None and isinstance(key, ecdsa.ECDSA384P1) or
326 pub_key is not None and isinstance(pub_key,
327 ecdsa.ECDSA384P1Public)):
328 hash_algorithm = hashlib.sha384
329 hash_tlv = "SHA384"
330 else:
331 hash_algorithm = hashlib.sha256
332 hash_tlv = "SHA256"
David Vincze71b8f982020-03-17 19:08:12 +0100333 # Calculate the hash of the public key
334 if key is not None:
335 pub = key.get_public_bytes()
Roland Mikhel57041742023-02-03 14:43:13 +0100336 sha = hash_algorithm()
David Vincze71b8f982020-03-17 19:08:12 +0100337 sha.update(pub)
338 pubbytes = sha.digest()
Andrzej Puzdrowski160303c2022-03-15 15:41:14 +0100339 elif pub_key is not None:
Andrzej Puzdrowskidfce0be2022-03-28 09:34:15 +0200340 if hasattr(pub_key, 'sign'):
Antonio de Angelis284b8fe2022-11-15 13:54:47 +0000341 print(os.path.basename(__file__) + ": sign the payload")
Andrzej Puzdrowski160303c2022-03-15 15:41:14 +0100342 pub = pub_key.get_public_bytes()
Roland Mikhel57041742023-02-03 14:43:13 +0100343 sha = hash_algorithm()
Andrzej Puzdrowski160303c2022-03-15 15:41:14 +0100344 sha.update(pub)
345 pubbytes = sha.digest()
David Vincze71b8f982020-03-17 19:08:12 +0100346 else:
347 pubbytes = bytes(hashlib.sha256().digest_size)
348
David Vincze1a7a6902020-02-18 15:05:16 +0100349 protected_tlv_size = 0
350
351 if self.security_counter is not None:
352 # Size of the security counter TLV: header ('HH') + payload ('I')
353 # = 4 + 4 = 8 Bytes
354 protected_tlv_size += TLV_SIZE + 4
355
David Vincze71b8f982020-03-17 19:08:12 +0100356 if sw_type is not None:
357 if len(sw_type) > MAX_SW_TYPE_LENGTH:
358 msg = "'{}' is too long ({} characters) for sw_type. Its " \
359 "maximum allowed length is 12 characters.".format(
360 sw_type, len(sw_type))
361 raise click.UsageError(msg)
362
363 image_version = (str(self.version.major) + '.'
364 + str(self.version.minor) + '.'
365 + str(self.version.revision))
366
367 # The image hash is computed over the image header, the image
368 # itself and the protected TLV area. However, the boot record TLV
369 # (which is part of the protected area) should contain this hash
370 # before it is even calculated. For this reason the script fills
371 # this field with zeros and the bootloader will insert the right
372 # value later.
Roland Mikhel57041742023-02-03 14:43:13 +0100373 digest = bytes(hash_algorithm().digest_size)
David Vincze71b8f982020-03-17 19:08:12 +0100374
375 # Create CBOR encoded boot record
376 boot_record = create_sw_component_data(sw_type, image_version,
Roland Mikhel57041742023-02-03 14:43:13 +0100377 hash_tlv, digest,
David Vincze71b8f982020-03-17 19:08:12 +0100378 pubbytes)
379
380 protected_tlv_size += TLV_SIZE + len(boot_record)
381
David Vincze1a7a6902020-02-18 15:05:16 +0100382 if dependencies is not None:
383 # Size of a Dependency TLV = Header ('HH') + Payload('IBBHI')
384 # = 4 + 12 = 16 Bytes
David Vinczeda8c9192019-03-26 17:17:41 +0100385 dependencies_num = len(dependencies[DEP_IMAGES_KEY])
David Vincze1a7a6902020-02-18 15:05:16 +0100386 protected_tlv_size += (dependencies_num * 16)
387
David Vinczeb2a1a482020-09-18 11:54:30 +0200388 if custom_tlvs is not None:
Ihor Slabkyy24d93732020-03-10 15:33:57 +0200389 for value in custom_tlvs.values():
390 protected_tlv_size += TLV_SIZE + len(value)
391
David Vincze1a7a6902020-02-18 15:05:16 +0100392 if protected_tlv_size != 0:
393 # Add the size of the TLV info header
394 protected_tlv_size += TLV_INFO_SIZE
David Vinczeda8c9192019-03-26 17:17:41 +0100395
Ihor Slabkyy24d93732020-03-10 15:33:57 +0200396 # At this point the image is already on the payload
397 #
398 # This adds the padding if image is not aligned to the 16 Bytes
399 # in encrypted mode
400 if self.enckey is not None:
401 pad_len = len(self.payload) % 16
402 if pad_len > 0:
Fabio Utzigd62631a2021-02-04 19:45:27 -0300403 pad = bytes(16 - pad_len)
404 if isinstance(self.payload, bytes):
405 self.payload += pad
406 else:
407 self.payload.extend(pad)
Ihor Slabkyy24d93732020-03-10 15:33:57 +0200408
409 # This adds the header to the payload as well
Salome Thirot0f641972021-05-14 11:19:55 +0100410 if encrypt_keylen == 256:
411 self.add_header(enckey, protected_tlv_size, 256)
412 else:
413 self.add_header(enckey, protected_tlv_size)
David Brown23f91ad2017-05-16 11:38:17 -0600414
Fabio Utzig510fddb2019-09-12 12:15:36 -0300415 prot_tlv = TLV(self.endian, TLV_PROT_INFO_MAGIC)
David Brown23f91ad2017-05-16 11:38:17 -0600416
Fabio Utzig510fddb2019-09-12 12:15:36 -0300417 # Protected TLVs must be added first, because they are also included
418 # in the hash calculation
419 protected_tlv_off = None
David Vinczeda8c9192019-03-26 17:17:41 +0100420 if protected_tlv_size != 0:
David Vincze1a7a6902020-02-18 15:05:16 +0100421
422 e = STRUCT_ENDIAN_DICT[self.endian]
423
424 if self.security_counter is not None:
425 payload = struct.pack(e + 'I', self.security_counter)
426 prot_tlv.add('SEC_CNT', payload)
427
David Vincze71b8f982020-03-17 19:08:12 +0100428 if sw_type is not None:
429 prot_tlv.add('BOOT_RECORD', boot_record)
430
David Vincze1a7a6902020-02-18 15:05:16 +0100431 if dependencies is not None:
432 for i in range(dependencies_num):
433 payload = struct.pack(
434 e + 'B3x'+'BBHI',
435 int(dependencies[DEP_IMAGES_KEY][i]),
436 dependencies[DEP_VERSIONS_KEY][i].major,
437 dependencies[DEP_VERSIONS_KEY][i].minor,
438 dependencies[DEP_VERSIONS_KEY][i].revision,
439 dependencies[DEP_VERSIONS_KEY][i].build
440 )
441 prot_tlv.add('DEPENDENCY', payload)
David Vinczeda8c9192019-03-26 17:17:41 +0100442
David Vinczeb2a1a482020-09-18 11:54:30 +0200443 if custom_tlvs is not None:
444 for tag, value in custom_tlvs.items():
445 prot_tlv.add(tag, value)
Ihor Slabkyy24d93732020-03-10 15:33:57 +0200446
Fabio Utzig510fddb2019-09-12 12:15:36 -0300447 protected_tlv_off = len(self.payload)
448 self.payload += prot_tlv.get()
449
450 tlv = TLV(self.endian)
David Vinczeda8c9192019-03-26 17:17:41 +0100451
David Brown23f91ad2017-05-16 11:38:17 -0600452 # Note that ecdsa wants to do the hashing itself, which means
453 # we get to hash it twice.
Roland Mikhel57041742023-02-03 14:43:13 +0100454 sha = hash_algorithm()
David Brown23f91ad2017-05-16 11:38:17 -0600455 sha.update(self.payload)
456 digest = sha.digest()
Roland Mikhel57041742023-02-03 14:43:13 +0100457 tlv.add(hash_tlv, digest)
David Brown23f91ad2017-05-16 11:38:17 -0600458
Fabio Utzig08a716d2022-11-18 10:54:07 -0300459 if vector_to_sign == 'payload':
460 # Stop amending data to the image
461 # Just keep data vector which is expected to be signed
462 print(os.path.basename(__file__) + ': export payload')
463 return
464 elif vector_to_sign == 'digest':
465 self.payload = digest
466 print(os.path.basename(__file__) + ': export digest')
467 return
468
Almir Okato3eb50262022-05-09 16:23:50 -0300469 if key is not None or fixed_sig is not None:
470 if public_key_format == 'hash':
471 tlv.add('KEYHASH', pubbytes)
Fabio Utzig8101d1f2019-05-09 15:03:22 -0300472 else:
Almir Okato3eb50262022-05-09 16:23:50 -0300473 tlv.add('PUBKEY', pub)
474
Almir Okato3eb50262022-05-09 16:23:50 -0300475 if key is not None and fixed_sig is None:
Roland Mikhel57041742023-02-03 14:43:13 +0100476 # `sign` expects the full image payload (hashing done
477 # internally), while `sign_digest` expects only the digest
478 # of the payload
Almir Okato3eb50262022-05-09 16:23:50 -0300479
480 if hasattr(key, 'sign'):
Antonio de Angelis284b8fe2022-11-15 13:54:47 +0000481 print(os.path.basename(__file__) + ": sign the payload")
Almir Okato3eb50262022-05-09 16:23:50 -0300482 sig = key.sign(bytes(self.payload))
483 else:
Antonio de Angelis284b8fe2022-11-15 13:54:47 +0000484 print(os.path.basename(__file__) + ": sign the digest")
Almir Okato3eb50262022-05-09 16:23:50 -0300485 sig = key.sign_digest(digest)
Roland Mikhel78135ee2023-02-07 14:11:02 +0100486 # only ecdsa256 has legacy tlv type
487 if use_legacy_tlv and isinstance(key, ecdsa.ECDSA256P1):
488 tlv.add(key.legacy_sig_tlv(), sig)
489 else:
490 tlv.add(key.sig_tlv(), sig)
Almir Okato3eb50262022-05-09 16:23:50 -0300491 self.signature = sig
492 elif fixed_sig is not None and key is None:
Roland Mikhel78135ee2023-02-07 14:11:02 +0100493 if use_legacy_tlv and isinstance(pub_key,
494 ecdsa.ECDSA256P1Public):
495 tlv.add(pub_key.legacy_sig_tlv(), fixed_sig['value'])
496 else:
497 tlv.add(pub_key.sig_tlv(), fixed_sig['value'])
Almir Okato3eb50262022-05-09 16:23:50 -0300498 self.signature = fixed_sig['value']
499 else:
500 raise click.UsageError("Can not sign using key and provide fixed-signature at the same time")
David Brown23f91ad2017-05-16 11:38:17 -0600501
Fabio Utzig510fddb2019-09-12 12:15:36 -0300502 # At this point the image was hashed + signed, we can remove the
503 # protected TLVs from the payload (will be re-added later)
504 if protected_tlv_off is not None:
505 self.payload = self.payload[:protected_tlv_off]
506
Fabio Utzig06b77b82018-08-23 16:01:16 -0300507 if enckey is not None:
Salome Thirot0f641972021-05-14 11:19:55 +0100508 if encrypt_keylen == 256:
509 plainkey = os.urandom(32)
510 else:
511 plainkey = os.urandom(16)
Fabio Utzig7a3b2602019-10-22 09:56:44 -0300512
513 if isinstance(enckey, rsa.RSAPublic):
514 cipherkey = enckey._get_public().encrypt(
515 plainkey, padding.OAEP(
516 mgf=padding.MGF1(algorithm=hashes.SHA256()),
517 algorithm=hashes.SHA256(),
518 label=None))
Fabio Utzig9a492d52020-01-15 11:31:52 -0300519 self.enctlv_len = len(cipherkey)
Fabio Utzig7a3b2602019-10-22 09:56:44 -0300520 tlv.add('ENCRSA2048', cipherkey)
Fabio Utzig960b4c52020-04-02 13:07:12 -0300521 elif isinstance(enckey, (ecdsa.ECDSA256P1Public,
522 x25519.X25519Public)):
523 cipherkey, mac, pubk = self.ecies_hkdf(enckey, plainkey)
Fabio Utzig9a492d52020-01-15 11:31:52 -0300524 enctlv = pubk + mac + cipherkey
525 self.enctlv_len = len(enctlv)
Fabio Utzig960b4c52020-04-02 13:07:12 -0300526 if isinstance(enckey, ecdsa.ECDSA256P1Public):
527 tlv.add('ENCEC256', enctlv)
528 else:
529 tlv.add('ENCX25519', enctlv)
Fabio Utzig06b77b82018-08-23 16:01:16 -0300530
Michel Jaouend09aa6b2022-01-07 16:48:58 +0100531 if not clear:
532 nonce = bytes([0] * 16)
533 cipher = Cipher(algorithms.AES(plainkey), modes.CTR(nonce),
534 backend=default_backend())
535 encryptor = cipher.encryptor()
536 img = bytes(self.payload[self.header_size:])
537 self.payload[self.header_size:] = \
538 encryptor.update(img) + encryptor.finalize()
Fabio Utzig06b77b82018-08-23 16:01:16 -0300539
Fabio Utzig510fddb2019-09-12 12:15:36 -0300540 self.payload += prot_tlv.get()
541 self.payload += tlv.get()
David Brown23f91ad2017-05-16 11:38:17 -0600542
Fabio Utzig9a492d52020-01-15 11:31:52 -0300543 self.check_trailer()
544
Andrzej Puzdrowski160303c2022-03-15 15:41:14 +0100545 def get_signature(self):
546 return self.signature
547
Salome Thirot0f641972021-05-14 11:19:55 +0100548 def add_header(self, enckey, protected_tlv_size, aes_length=128):
Fabio Utzigcd284062018-11-30 11:05:45 -0200549 """Install the image header."""
David Brown23f91ad2017-05-16 11:38:17 -0600550
David Brown0f0c6a82017-06-08 09:26:24 -0600551 flags = 0
Fabio Utzig06b77b82018-08-23 16:01:16 -0300552 if enckey is not None:
Salome Thirot0f641972021-05-14 11:19:55 +0100553 if aes_length == 128:
554 flags |= IMAGE_F['ENCRYPTED_AES128']
555 else:
556 flags |= IMAGE_F['ENCRYPTED_AES256']
David Vincze1e0c5442020-04-07 14:12:33 +0200557 if self.load_addr != 0:
558 # Indicates that this image should be loaded into RAM
559 # instead of run directly from flash.
560 flags |= IMAGE_F['RAM_LOAD']
Dominik Ermel50820b12020-12-14 13:16:46 +0000561 if self.rom_fixed:
562 flags |= IMAGE_F['ROM_FIXED']
David Brown23f91ad2017-05-16 11:38:17 -0600563
Mark Schultea66c6872018-09-26 17:24:40 -0700564 e = STRUCT_ENDIAN_DICT[self.endian]
565 fmt = (e +
David Vinczeda8c9192019-03-26 17:17:41 +0100566 # type ImageHdr struct {
567 'I' + # Magic uint32
568 'I' + # LoadAddr uint32
569 'H' + # HdrSz uint16
570 'H' + # PTLVSz uint16
571 'I' + # ImgSz uint32
572 'I' + # Flags uint32
573 'BBHI' + # Vers ImageVersion
574 'I' # Pad1 uint32
575 ) # }
David Brown23f91ad2017-05-16 11:38:17 -0600576 assert struct.calcsize(fmt) == IMAGE_HEADER_SIZE
577 header = struct.pack(fmt,
Roland Mikhel57041742023-02-03 14:43:13 +0100578 IMAGE_MAGIC,
579 self.rom_fixed or self.load_addr,
580 self.header_size,
581 protected_tlv_size, # TLV Info header +
582 # Protected TLVs
583 len(self.payload) - self.header_size, # ImageSz
584 flags,
585 self.version.major,
586 self.version.minor or 0,
587 self.version.revision or 0,
588 self.version.build or 0,
589 0) # Pad1
David Brown23f91ad2017-05-16 11:38:17 -0600590 self.payload = bytearray(self.payload)
591 self.payload[:len(header)] = header
592
Fabio Utzig9a492d52020-01-15 11:31:52 -0300593 def _trailer_size(self, write_size, max_sectors, overwrite_only, enckey,
594 save_enctlv, enctlv_len):
Fabio Utzig519285f2018-06-04 11:11:53 -0300595 # NOTE: should already be checked by the argument parser
Fabio Utzig649d80f2019-09-12 10:26:23 -0300596 magic_size = 16
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300597 magic_align_size = align_up(magic_size, self.max_align)
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700598 if overwrite_only:
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000599 return self.max_align * 2 + magic_align_size
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700600 else:
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000601 if write_size not in set([1, 2, 4, 8, 16, 32]):
Fabio Utzig1f508922020-01-15 11:37:51 -0300602 raise click.BadParameter("Invalid alignment: {}".format(
603 write_size))
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700604 m = DEFAULT_MAX_SECTORS if max_sectors is None else max_sectors
Fabio Utzig649d80f2019-09-12 10:26:23 -0300605 trailer = m * 3 * write_size # status area
606 if enckey is not None:
Fabio Utzig9a492d52020-01-15 11:31:52 -0300607 if save_enctlv:
608 # TLV saved by the bootloader is aligned
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300609 keylen = align_up(enctlv_len, self.max_align)
Fabio Utzig9a492d52020-01-15 11:31:52 -0300610 else:
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300611 keylen = align_up(16, self.max_align)
Fabio Utzig9a492d52020-01-15 11:31:52 -0300612 trailer += keylen * 2 # encryption keys
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000613 trailer += self.max_align * 4 # image_ok/copy_done/swap_info/swap_size
614 trailer += magic_align_size
Fabio Utzig649d80f2019-09-12 10:26:23 -0300615 return trailer
Fabio Utzig519285f2018-06-04 11:11:53 -0300616
Fabio Utzig263d4392018-06-05 10:37:35 -0300617 def pad_to(self, size):
David Brown23f91ad2017-05-16 11:38:17 -0600618 """Pad the image to the given size, with the given flash alignment."""
Fabio Utzigdcf0c9b2018-06-11 12:27:49 -0700619 tsize = self._trailer_size(self.align, self.max_sectors,
Fabio Utzig9a492d52020-01-15 11:31:52 -0300620 self.overwrite_only, self.enckey,
621 self.save_enctlv, self.enctlv_len)
David Brown23f91ad2017-05-16 11:38:17 -0600622 padding = size - (len(self.payload) + tsize)
Henrik Brix Andersen0ce958e2020-03-11 14:04:11 +0100623 pbytes = bytearray([self.erased_val] * padding)
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300624 pbytes += bytearray([self.erased_val] * (tsize - len(self.boot_magic)))
625 pbytes += self.boot_magic
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000626 if self.confirm and not self.overwrite_only:
627 magic_size = 16
Gustavo Henrique Niheicf120ba2021-11-22 18:44:11 -0300628 magic_align_size = align_up(magic_size, self.max_align)
Kristine Jassmann73c38c62021-02-03 16:56:14 +0000629 image_ok_idx = -(magic_align_size + self.max_align)
630 pbytes[image_ok_idx] = 0x01 # image_ok = 0x01
David Brown23f91ad2017-05-16 11:38:17 -0600631 self.payload += pbytes
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300632
633 @staticmethod
634 def verify(imgfile, key):
635 with open(imgfile, "rb") as f:
636 b = f.read()
637
638 magic, _, header_size, _, img_size = struct.unpack('IIHHI', b[:16])
Marek Pietae9555102019-08-08 16:08:16 +0200639 version = struct.unpack('BBHI', b[20:28])
640
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300641 if magic != IMAGE_MAGIC:
Casper Meijn2a01f3f2020-08-22 13:51:40 +0200642 return VerifyResult.INVALID_MAGIC, None, None
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300643
Fabio Utzigd12a8da2021-01-21 08:44:59 -0300644 tlv_off = header_size + img_size
645 tlv_info = b[tlv_off:tlv_off+TLV_INFO_SIZE]
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300646 magic, tlv_tot = struct.unpack('HH', tlv_info)
Fabio Utzigd12a8da2021-01-21 08:44:59 -0300647 if magic == TLV_PROT_INFO_MAGIC:
648 tlv_off += tlv_tot
649 tlv_info = b[tlv_off:tlv_off+TLV_INFO_SIZE]
650 magic, tlv_tot = struct.unpack('HH', tlv_info)
651
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300652 if magic != TLV_INFO_MAGIC:
Casper Meijn2a01f3f2020-08-22 13:51:40 +0200653 return VerifyResult.INVALID_TLV_INFO_MAGIC, None, None
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300654
Roland Mikhel57041742023-02-03 14:43:13 +0100655 if isinstance(key, ecdsa.ECDSA384P1Public):
656 sha = hashlib.sha384()
657 hash_tlv = "SHA384"
658 else:
659 sha = hashlib.sha256()
660 hash_tlv = "SHA256"
661
Fabio Utzigd12a8da2021-01-21 08:44:59 -0300662 prot_tlv_size = tlv_off
663 sha.update(b[:prot_tlv_size])
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300664 digest = sha.digest()
665
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300666 tlv_end = tlv_off + tlv_tot
667 tlv_off += TLV_INFO_SIZE # skip tlv info
668 while tlv_off < tlv_end:
669 tlv = b[tlv_off:tlv_off+TLV_SIZE]
670 tlv_type, _, tlv_len = struct.unpack('BBH', tlv)
Roland Mikhel57041742023-02-03 14:43:13 +0100671 if tlv_type == TLV_VALUES[hash_tlv]:
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300672 off = tlv_off + TLV_SIZE
673 if digest == b[off:off+tlv_len]:
674 if key is None:
Casper Meijn2a01f3f2020-08-22 13:51:40 +0200675 return VerifyResult.OK, version, digest
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300676 else:
Casper Meijn2a01f3f2020-08-22 13:51:40 +0200677 return VerifyResult.INVALID_HASH, None, None
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300678 elif key is not None and tlv_type == TLV_VALUES[key.sig_tlv()]:
679 off = tlv_off + TLV_SIZE
680 tlv_sig = b[off:off+tlv_len]
Fabio Utzigd12a8da2021-01-21 08:44:59 -0300681 payload = b[:prot_tlv_size]
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300682 try:
Fabio Utzig8101d1f2019-05-09 15:03:22 -0300683 if hasattr(key, 'verify'):
684 key.verify(tlv_sig, payload)
685 else:
686 key.verify_digest(tlv_sig, digest)
Casper Meijn2a01f3f2020-08-22 13:51:40 +0200687 return VerifyResult.OK, version, digest
Fabio Utzig4a5477a2019-05-27 15:45:08 -0300688 except InvalidSignature:
689 # continue to next TLV
690 pass
691 tlv_off += TLV_SIZE + tlv_len
Casper Meijn2a01f3f2020-08-22 13:51:40 +0200692 return VerifyResult.INVALID_SIGNATURE, None, None