Carles Cufi | 37d052f | 2018-01-30 16:40:10 +0100 | [diff] [blame] | 1 | # Copyright 2018 Nordic Semiconductor ASA |
David Vincze | b2a1a48 | 2020-09-18 11:54:30 +0200 | [diff] [blame] | 2 | # Copyright 2017-2020 Linaro Limited |
Roland Mikhel | 3d92a6c | 2023-02-23 15:35:44 +0100 | [diff] [blame] | 3 | # Copyright 2019-2023 Arm Limited |
David Brown | 1314bf3 | 2017-12-20 11:10:55 -0700 | [diff] [blame] | 4 | # |
David Brown | 79c4fcf | 2021-01-26 15:04:05 -0700 | [diff] [blame] | 5 | # SPDX-License-Identifier: Apache-2.0 |
| 6 | # |
David Brown | 1314bf3 | 2017-12-20 11:10:55 -0700 | [diff] [blame] | 7 | # 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 Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 19 | """ |
| 20 | Image signing and management. |
| 21 | """ |
| 22 | |
| 23 | from . import version as versmod |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 24 | from .boot_record import create_sw_component_data |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 25 | import click |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 26 | from enum import Enum |
Carles Cufi | 37d052f | 2018-01-30 16:40:10 +0100 | [diff] [blame] | 27 | from intelhex import IntelHex |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 28 | import hashlib |
| 29 | import struct |
Carles Cufi | 37d052f | 2018-01-30 16:40:10 +0100 | [diff] [blame] | 30 | import os.path |
Fabio Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 31 | from .keys import rsa, ecdsa, x25519 |
Fabio Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 32 | from cryptography.hazmat.primitives.asymmetric import ec, padding |
Fabio Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 33 | from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PrivateKey |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 34 | from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes |
Fabio Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 35 | from cryptography.hazmat.primitives.kdf.hkdf import HKDF |
| 36 | from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 37 | from cryptography.hazmat.backends import default_backend |
Fabio Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 38 | from cryptography.hazmat.primitives import hashes, hmac |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 39 | from cryptography.exceptions import InvalidSignature |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 40 | |
David Brown | 72e7a51 | 2017-09-01 11:08:23 -0600 | [diff] [blame] | 41 | IMAGE_MAGIC = 0x96f3b83d |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 42 | IMAGE_HEADER_SIZE = 32 |
Carles Cufi | 37d052f | 2018-01-30 16:40:10 +0100 | [diff] [blame] | 43 | BIN_EXT = "bin" |
| 44 | INTEL_HEX_EXT = "hex" |
Fabio Utzig | 519285f | 2018-06-04 11:11:53 -0300 | [diff] [blame] | 45 | DEFAULT_MAX_SECTORS = 128 |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 46 | DEFAULT_MAX_ALIGN = 8 |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 47 | DEP_IMAGES_KEY = "images" |
| 48 | DEP_VERSIONS_KEY = "versions" |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 49 | MAX_SW_TYPE_LENGTH = 12 # Bytes |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 50 | |
| 51 | # Image header flags. |
| 52 | IMAGE_F = { |
| 53 | 'PIC': 0x0000001, |
Salome Thirot | 0f64197 | 2021-05-14 11:19:55 +0100 | [diff] [blame] | 54 | 'ENCRYPTED_AES128': 0x0000004, |
| 55 | 'ENCRYPTED_AES256': 0x0000008, |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 56 | 'NON_BOOTABLE': 0x0000010, |
David Vincze | 1e0c544 | 2020-04-07 14:12:33 +0200 | [diff] [blame] | 57 | 'RAM_LOAD': 0x0000020, |
Dominik Ermel | 50820b1 | 2020-12-14 13:16:46 +0000 | [diff] [blame] | 58 | 'ROM_FIXED': 0x0000100, |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 59 | } |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 60 | |
| 61 | TLV_VALUES = { |
David Brown | 43cda33 | 2017-09-01 09:53:23 -0600 | [diff] [blame] | 62 | 'KEYHASH': 0x01, |
David Vincze | dde178d | 2020-03-26 20:06:01 +0100 | [diff] [blame] | 63 | 'PUBKEY': 0x02, |
David Brown | 27648b8 | 2017-08-31 10:40:29 -0600 | [diff] [blame] | 64 | 'SHA256': 0x10, |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 65 | 'SHA384': 0x11, |
David Brown | 27648b8 | 2017-08-31 10:40:29 -0600 | [diff] [blame] | 66 | 'RSA2048': 0x20, |
David Vincze | 4395b80 | 2023-04-27 16:11:49 +0200 | [diff] [blame] | 67 | 'ECDSASIG': 0x22, |
Fabio Utzig | 19fd79a | 2019-05-08 18:20:39 -0300 | [diff] [blame] | 68 | 'RSA3072': 0x23, |
Fabio Utzig | 8101d1f | 2019-05-09 15:03:22 -0300 | [diff] [blame] | 69 | 'ED25519': 0x24, |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 70 | 'ENCRSA2048': 0x30, |
Salome Thirot | 0f64197 | 2021-05-14 11:19:55 +0100 | [diff] [blame] | 71 | 'ENCKW': 0x31, |
Fabio Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 72 | 'ENCEC256': 0x32, |
Fabio Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 73 | 'ENCX25519': 0x33, |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 74 | 'DEPENDENCY': 0x40, |
| 75 | 'SEC_CNT': 0x50, |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 76 | 'BOOT_RECORD': 0x60, |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 77 | } |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 78 | |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 79 | TLV_SIZE = 4 |
David Brown | f5b33d8 | 2017-09-01 10:58:27 -0600 | [diff] [blame] | 80 | TLV_INFO_SIZE = 4 |
| 81 | TLV_INFO_MAGIC = 0x6907 |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 82 | TLV_PROT_INFO_MAGIC = 0x6908 |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 83 | |
Piotr Dymacz | e026c36 | 2023-02-24 12:09:33 +0100 | [diff] [blame] | 84 | TLV_VENDOR_RES_MIN = 0x00a0 |
| 85 | TLV_VENDOR_RES_MAX = 0xfffe |
| 86 | |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 87 | STRUCT_ENDIAN_DICT = { |
| 88 | 'little': '<', |
| 89 | 'big': '>' |
| 90 | } |
| 91 | |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 92 | VerifyResult = Enum('VerifyResult', |
| 93 | """ |
| 94 | OK INVALID_MAGIC INVALID_TLV_INFO_MAGIC INVALID_HASH |
| 95 | INVALID_SIGNATURE |
| 96 | """) |
| 97 | |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 98 | |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 99 | def align_up(num, align): |
| 100 | assert (align & (align - 1) == 0) and align != 0 |
| 101 | return (num + (align - 1)) & ~(align - 1) |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 102 | |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 103 | |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 104 | class TLV(): |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 105 | def __init__(self, endian, magic=TLV_INFO_MAGIC): |
| 106 | self.magic = magic |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 107 | self.buf = bytearray() |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 108 | self.endian = endian |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 109 | |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 110 | def __len__(self): |
| 111 | return TLV_INFO_SIZE + len(self.buf) |
| 112 | |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 113 | def add(self, kind, payload): |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 114 | """ |
| 115 | Add a TLV record. Kind should be a string found in TLV_VALUES above. |
| 116 | """ |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 117 | e = STRUCT_ENDIAN_DICT[self.endian] |
Ihor Slabkyy | 24d9373 | 2020-03-10 15:33:57 +0200 | [diff] [blame] | 118 | if isinstance(kind, int): |
Piotr Dymacz | e026c36 | 2023-02-24 12:09:33 +0100 | [diff] [blame] | 119 | 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 Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 122 | kind, TLV_VENDOR_RES_MIN, TLV_VENDOR_RES_MAX) |
Piotr Dymacz | e026c36 | 2023-02-24 12:09:33 +0100 | [diff] [blame] | 123 | raise click.UsageError(msg) |
| 124 | buf = struct.pack(e + 'HH', kind, len(payload)) |
Ihor Slabkyy | 24d9373 | 2020-03-10 15:33:57 +0200 | [diff] [blame] | 125 | else: |
| 126 | buf = struct.pack(e + 'BBH', TLV_VALUES[kind], 0, len(payload)) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 127 | self.buf += buf |
| 128 | self.buf += payload |
| 129 | |
| 130 | def get(self): |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 131 | if len(self.buf) == 0: |
| 132 | return bytes() |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 133 | e = STRUCT_ENDIAN_DICT[self.endian] |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 134 | header = struct.pack(e + 'HH', self.magic, len(self)) |
David Brown | f5b33d8 | 2017-09-01 10:58:27 -0600 | [diff] [blame] | 135 | return header + bytes(self.buf) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 136 | |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 137 | |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 138 | class Image(): |
Carles Cufi | 37d052f | 2018-01-30 16:40:10 +0100 | [diff] [blame] | 139 | |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 140 | def __init__(self, version=None, header_size=IMAGE_HEADER_SIZE, |
Henrik Brix Andersen | 0ce958e | 2020-03-11 14:04:11 +0100 | [diff] [blame] | 141 | 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 Ermel | 50820b1 | 2020-12-14 13:16:46 +0000 | [diff] [blame] | 144 | rom_fixed=None, erased_val=None, save_enctlv=False, |
Piotr Mienkowski | b6d5cf3 | 2022-01-31 01:01:11 +0100 | [diff] [blame] | 145 | security_counter=None, max_align=None): |
Dominik Ermel | 50820b1 | 2020-12-14 13:16:46 +0000 | [diff] [blame] | 146 | |
| 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 Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 150 | self.version = version or versmod.decode_version("0") |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 151 | self.header_size = header_size |
| 152 | self.pad_header = pad_header |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 153 | self.pad = pad |
Henrik Brix Andersen | 0ce958e | 2020-03-11 14:04:11 +0100 | [diff] [blame] | 154 | self.confirm = confirm |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 155 | self.align = align |
| 156 | self.slot_size = slot_size |
| 157 | self.max_sectors = max_sectors |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 158 | self.overwrite_only = overwrite_only |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 159 | self.endian = endian |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 160 | self.base_addr = None |
Håkon Øye Amundsen | df8c891 | 2019-08-26 12:15:28 +0000 | [diff] [blame] | 161 | self.load_addr = 0 if load_addr is None else load_addr |
Dominik Ermel | 50820b1 | 2020-12-14 13:16:46 +0000 | [diff] [blame] | 162 | self.rom_fixed = rom_fixed |
Fabio Utzig | cb08073 | 2020-02-07 12:01:39 -0300 | [diff] [blame] | 163 | self.erased_val = 0xff if erased_val is None else int(erased_val, 0) |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 164 | self.payload = [] |
Fabio Utzig | 649d80f | 2019-09-12 10:26:23 -0300 | [diff] [blame] | 165 | self.enckey = None |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 166 | self.save_enctlv = save_enctlv |
| 167 | self.enctlv_len = 0 |
Piotr Mienkowski | b6d5cf3 | 2022-01-31 01:01:11 +0100 | [diff] [blame] | 168 | self.max_align = max(DEFAULT_MAX_ALIGN, align) if max_align is None else int(max_align) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 169 | |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 170 | 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 Dupont | 16f3de5 | 2023-03-16 09:02:11 +0100 | [diff] [blame] | 177 | 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 Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 184 | |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 185 | 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 Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 194 | def __repr__(self): |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 195 | 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 Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 199 | self.version, |
| 200 | self.header_size, |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 201 | self.security_counter, |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 202 | self.base_addr if self.base_addr is not None else "N/A", |
Håkon Øye Amundsen | df8c891 | 2019-08-26 12:15:28 +0000 | [diff] [blame] | 203 | self.load_addr, |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 204 | self.align, |
| 205 | self.slot_size, |
| 206 | self.max_sectors, |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 207 | self.overwrite_only, |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 208 | self.endian, |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 209 | self.__class__.__name__, |
| 210 | len(self.payload)) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 211 | |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 212 | def load(self, path): |
| 213 | """Load an image from a given file""" |
| 214 | ext = os.path.splitext(path)[1][1:].lower() |
Fabio Utzig | 1f50892 | 2020-01-15 11:37:51 -0300 | [diff] [blame] | 215 | 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 Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 225 | |
| 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 Utzig | 9117fde | 2019-10-17 11:11:46 -0300 | [diff] [blame] | 231 | self.payload = bytes([self.erased_val] * self.header_size) + \ |
| 232 | self.payload |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 233 | |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 234 | self.check_header() |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 235 | |
Fabio Utzig | edbabcf | 2019-10-11 13:03:37 -0300 | [diff] [blame] | 236 | def save(self, path, hex_addr=None): |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 237 | """Save an image from a given file""" |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 238 | 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 Utzig | edbabcf | 2019-10-11 13:03:37 -0300 | [diff] [blame] | 241 | if self.base_addr is None and hex_addr is None: |
Fabio Utzig | 1f50892 | 2020-01-15 11:37:51 -0300 | [diff] [blame] | 242 | raise click.UsageError("No address exists in input file " |
| 243 | "neither was it provided by user") |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 244 | h = IntelHex() |
Fabio Utzig | edbabcf | 2019-10-11 13:03:37 -0300 | [diff] [blame] | 245 | if hex_addr is not None: |
| 246 | self.base_addr = hex_addr |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 247 | h.frombytes(bytes=self.payload, offset=self.base_addr) |
Fabio Utzig | edbabcf | 2019-10-11 13:03:37 -0300 | [diff] [blame] | 248 | if self.pad: |
Fabio Utzig | 2269f47 | 2019-10-17 11:14:33 -0300 | [diff] [blame] | 249 | trailer_size = self._trailer_size(self.align, self.max_sectors, |
| 250 | self.overwrite_only, |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 251 | self.enckey, |
| 252 | self.save_enctlv, |
| 253 | self.enctlv_len) |
Fabio Utzig | 2269f47 | 2019-10-17 11:14:33 -0300 | [diff] [blame] | 254 | trailer_addr = (self.base_addr + self.slot_size) - trailer_size |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 255 | if self.confirm and not self.overwrite_only: |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 256 | magic_align_size = align_up(len(self.boot_magic), |
| 257 | self.max_align) |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 258 | image_ok_idx = -(magic_align_size + self.max_align) |
Alexander Mihajlovic | f4df58f | 2022-08-17 15:44:53 +0200 | [diff] [blame] | 259 | flag = bytearray([self.erased_val] * self.max_align) |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 260 | flag[0] = 0x01 # image_ok = 0x01 |
| 261 | h.puts(trailer_addr + trailer_size + image_ok_idx, |
| 262 | bytes(flag)) |
Wouter Cappelle | c028d45 | 2022-01-25 10:25:24 +0100 | [diff] [blame] | 263 | h.puts(trailer_addr + (trailer_size - len(self.boot_magic)), |
| 264 | bytes(self.boot_magic)) |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 265 | h.tofile(path, 'hex') |
| 266 | else: |
Fabio Utzig | edbabcf | 2019-10-11 13:03:37 -0300 | [diff] [blame] | 267 | if self.pad: |
| 268 | self.pad_to(self.slot_size) |
Fabio Utzig | 7c00acd | 2019-01-07 09:54:20 -0200 | [diff] [blame] | 269 | with open(path, 'wb') as f: |
| 270 | f.write(self.payload) |
| 271 | |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 272 | def check_header(self): |
Fabio Utzig | f5556c3 | 2019-10-23 11:00:27 -0300 | [diff] [blame] | 273 | if self.header_size > 0 and not self.pad_header: |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 274 | if any(v != 0 for v in self.payload[0:self.header_size]): |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 275 | raise click.UsageError("Header padding was not requested and " |
| 276 | "image does not start with zeros") |
| 277 | |
| 278 | def check_trailer(self): |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 279 | if self.slot_size > 0: |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 280 | tsize = self._trailer_size(self.align, self.max_sectors, |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 281 | self.overwrite_only, self.enckey, |
| 282 | self.save_enctlv, self.enctlv_len) |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 283 | padding = self.slot_size - (len(self.payload) + tsize) |
| 284 | if padding < 0: |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 285 | 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 Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 289 | |
Fabio Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 290 | 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 Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 297 | 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 Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 308 | 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 Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 316 | return cipherkey, ciphermac, pubk |
| 317 | |
David Vincze | dde178d | 2020-03-26 20:06:01 +0100 | [diff] [blame] | 318 | def create(self, key, public_key_format, enckey, dependencies=None, |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 319 | sw_type=None, custom_tlvs=None, encrypt_keylen=128, clear=False, |
David Vincze | 7f982b0 | 2023-04-27 16:12:17 +0200 | [diff] [blame] | 320 | fixed_sig=None, pub_key=None, vector_to_sign=None): |
Fabio Utzig | 649d80f | 2019-09-12 10:26:23 -0300 | [diff] [blame] | 321 | self.enckey = enckey |
| 322 | |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 323 | # Check what hashing algorithm should be used |
| 324 | if (key is not None and isinstance(key, ecdsa.ECDSA384P1) or |
| 325 | pub_key is not None and isinstance(pub_key, |
| 326 | ecdsa.ECDSA384P1Public)): |
| 327 | hash_algorithm = hashlib.sha384 |
| 328 | hash_tlv = "SHA384" |
| 329 | else: |
| 330 | hash_algorithm = hashlib.sha256 |
| 331 | hash_tlv = "SHA256" |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 332 | # Calculate the hash of the public key |
| 333 | if key is not None: |
| 334 | pub = key.get_public_bytes() |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 335 | sha = hash_algorithm() |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 336 | sha.update(pub) |
| 337 | pubbytes = sha.digest() |
Andrzej Puzdrowski | 160303c | 2022-03-15 15:41:14 +0100 | [diff] [blame] | 338 | elif pub_key is not None: |
Andrzej Puzdrowski | dfce0be | 2022-03-28 09:34:15 +0200 | [diff] [blame] | 339 | if hasattr(pub_key, 'sign'): |
Antonio de Angelis | 284b8fe | 2022-11-15 13:54:47 +0000 | [diff] [blame] | 340 | print(os.path.basename(__file__) + ": sign the payload") |
Andrzej Puzdrowski | 160303c | 2022-03-15 15:41:14 +0100 | [diff] [blame] | 341 | pub = pub_key.get_public_bytes() |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 342 | sha = hash_algorithm() |
Andrzej Puzdrowski | 160303c | 2022-03-15 15:41:14 +0100 | [diff] [blame] | 343 | sha.update(pub) |
| 344 | pubbytes = sha.digest() |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 345 | else: |
| 346 | pubbytes = bytes(hashlib.sha256().digest_size) |
| 347 | |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 348 | protected_tlv_size = 0 |
| 349 | |
| 350 | if self.security_counter is not None: |
| 351 | # Size of the security counter TLV: header ('HH') + payload ('I') |
| 352 | # = 4 + 4 = 8 Bytes |
| 353 | protected_tlv_size += TLV_SIZE + 4 |
| 354 | |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 355 | if sw_type is not None: |
| 356 | if len(sw_type) > MAX_SW_TYPE_LENGTH: |
| 357 | msg = "'{}' is too long ({} characters) for sw_type. Its " \ |
| 358 | "maximum allowed length is 12 characters.".format( |
| 359 | sw_type, len(sw_type)) |
| 360 | raise click.UsageError(msg) |
| 361 | |
| 362 | image_version = (str(self.version.major) + '.' |
| 363 | + str(self.version.minor) + '.' |
| 364 | + str(self.version.revision)) |
| 365 | |
| 366 | # The image hash is computed over the image header, the image |
| 367 | # itself and the protected TLV area. However, the boot record TLV |
| 368 | # (which is part of the protected area) should contain this hash |
| 369 | # before it is even calculated. For this reason the script fills |
| 370 | # this field with zeros and the bootloader will insert the right |
| 371 | # value later. |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 372 | digest = bytes(hash_algorithm().digest_size) |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 373 | |
| 374 | # Create CBOR encoded boot record |
| 375 | boot_record = create_sw_component_data(sw_type, image_version, |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 376 | hash_tlv, digest, |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 377 | pubbytes) |
| 378 | |
| 379 | protected_tlv_size += TLV_SIZE + len(boot_record) |
| 380 | |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 381 | if dependencies is not None: |
| 382 | # Size of a Dependency TLV = Header ('HH') + Payload('IBBHI') |
| 383 | # = 4 + 12 = 16 Bytes |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 384 | dependencies_num = len(dependencies[DEP_IMAGES_KEY]) |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 385 | protected_tlv_size += (dependencies_num * 16) |
| 386 | |
David Vincze | b2a1a48 | 2020-09-18 11:54:30 +0200 | [diff] [blame] | 387 | if custom_tlvs is not None: |
Ihor Slabkyy | 24d9373 | 2020-03-10 15:33:57 +0200 | [diff] [blame] | 388 | for value in custom_tlvs.values(): |
| 389 | protected_tlv_size += TLV_SIZE + len(value) |
| 390 | |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 391 | if protected_tlv_size != 0: |
| 392 | # Add the size of the TLV info header |
| 393 | protected_tlv_size += TLV_INFO_SIZE |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 394 | |
Ihor Slabkyy | 24d9373 | 2020-03-10 15:33:57 +0200 | [diff] [blame] | 395 | # At this point the image is already on the payload |
| 396 | # |
| 397 | # This adds the padding if image is not aligned to the 16 Bytes |
| 398 | # in encrypted mode |
| 399 | if self.enckey is not None: |
| 400 | pad_len = len(self.payload) % 16 |
| 401 | if pad_len > 0: |
Fabio Utzig | d62631a | 2021-02-04 19:45:27 -0300 | [diff] [blame] | 402 | pad = bytes(16 - pad_len) |
| 403 | if isinstance(self.payload, bytes): |
| 404 | self.payload += pad |
| 405 | else: |
| 406 | self.payload.extend(pad) |
Ihor Slabkyy | 24d9373 | 2020-03-10 15:33:57 +0200 | [diff] [blame] | 407 | |
| 408 | # This adds the header to the payload as well |
Salome Thirot | 0f64197 | 2021-05-14 11:19:55 +0100 | [diff] [blame] | 409 | if encrypt_keylen == 256: |
| 410 | self.add_header(enckey, protected_tlv_size, 256) |
| 411 | else: |
| 412 | self.add_header(enckey, protected_tlv_size) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 413 | |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 414 | prot_tlv = TLV(self.endian, TLV_PROT_INFO_MAGIC) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 415 | |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 416 | # Protected TLVs must be added first, because they are also included |
| 417 | # in the hash calculation |
| 418 | protected_tlv_off = None |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 419 | if protected_tlv_size != 0: |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 420 | |
| 421 | e = STRUCT_ENDIAN_DICT[self.endian] |
| 422 | |
| 423 | if self.security_counter is not None: |
| 424 | payload = struct.pack(e + 'I', self.security_counter) |
| 425 | prot_tlv.add('SEC_CNT', payload) |
| 426 | |
David Vincze | 71b8f98 | 2020-03-17 19:08:12 +0100 | [diff] [blame] | 427 | if sw_type is not None: |
| 428 | prot_tlv.add('BOOT_RECORD', boot_record) |
| 429 | |
David Vincze | 1a7a690 | 2020-02-18 15:05:16 +0100 | [diff] [blame] | 430 | if dependencies is not None: |
| 431 | for i in range(dependencies_num): |
| 432 | payload = struct.pack( |
| 433 | e + 'B3x'+'BBHI', |
| 434 | int(dependencies[DEP_IMAGES_KEY][i]), |
| 435 | dependencies[DEP_VERSIONS_KEY][i].major, |
| 436 | dependencies[DEP_VERSIONS_KEY][i].minor, |
| 437 | dependencies[DEP_VERSIONS_KEY][i].revision, |
| 438 | dependencies[DEP_VERSIONS_KEY][i].build |
| 439 | ) |
| 440 | prot_tlv.add('DEPENDENCY', payload) |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 441 | |
David Vincze | b2a1a48 | 2020-09-18 11:54:30 +0200 | [diff] [blame] | 442 | if custom_tlvs is not None: |
| 443 | for tag, value in custom_tlvs.items(): |
| 444 | prot_tlv.add(tag, value) |
Ihor Slabkyy | 24d9373 | 2020-03-10 15:33:57 +0200 | [diff] [blame] | 445 | |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 446 | protected_tlv_off = len(self.payload) |
| 447 | self.payload += prot_tlv.get() |
| 448 | |
| 449 | tlv = TLV(self.endian) |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 450 | |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 451 | # Note that ecdsa wants to do the hashing itself, which means |
| 452 | # we get to hash it twice. |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 453 | sha = hash_algorithm() |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 454 | sha.update(self.payload) |
| 455 | digest = sha.digest() |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 456 | tlv.add(hash_tlv, digest) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 457 | |
Fabio Utzig | 08a716d | 2022-11-18 10:54:07 -0300 | [diff] [blame] | 458 | if vector_to_sign == 'payload': |
| 459 | # Stop amending data to the image |
| 460 | # Just keep data vector which is expected to be signed |
| 461 | print(os.path.basename(__file__) + ': export payload') |
| 462 | return |
| 463 | elif vector_to_sign == 'digest': |
| 464 | self.payload = digest |
| 465 | print(os.path.basename(__file__) + ': export digest') |
| 466 | return |
| 467 | |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 468 | if key is not None or fixed_sig is not None: |
| 469 | if public_key_format == 'hash': |
| 470 | tlv.add('KEYHASH', pubbytes) |
Fabio Utzig | 8101d1f | 2019-05-09 15:03:22 -0300 | [diff] [blame] | 471 | else: |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 472 | tlv.add('PUBKEY', pub) |
| 473 | |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 474 | if key is not None and fixed_sig is None: |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 475 | # `sign` expects the full image payload (hashing done |
| 476 | # internally), while `sign_digest` expects only the digest |
| 477 | # of the payload |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 478 | |
| 479 | if hasattr(key, 'sign'): |
Antonio de Angelis | 284b8fe | 2022-11-15 13:54:47 +0000 | [diff] [blame] | 480 | print(os.path.basename(__file__) + ": sign the payload") |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 481 | sig = key.sign(bytes(self.payload)) |
| 482 | else: |
Antonio de Angelis | 284b8fe | 2022-11-15 13:54:47 +0000 | [diff] [blame] | 483 | print(os.path.basename(__file__) + ": sign the digest") |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 484 | sig = key.sign_digest(digest) |
David Vincze | 7f982b0 | 2023-04-27 16:12:17 +0200 | [diff] [blame] | 485 | tlv.add(key.sig_tlv(), sig) |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 486 | self.signature = sig |
| 487 | elif fixed_sig is not None and key is None: |
David Vincze | 7f982b0 | 2023-04-27 16:12:17 +0200 | [diff] [blame] | 488 | tlv.add(pub_key.sig_tlv(), fixed_sig['value']) |
Almir Okato | 3eb5026 | 2022-05-09 16:23:50 -0300 | [diff] [blame] | 489 | self.signature = fixed_sig['value'] |
| 490 | else: |
| 491 | raise click.UsageError("Can not sign using key and provide fixed-signature at the same time") |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 492 | |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 493 | # At this point the image was hashed + signed, we can remove the |
| 494 | # protected TLVs from the payload (will be re-added later) |
| 495 | if protected_tlv_off is not None: |
| 496 | self.payload = self.payload[:protected_tlv_off] |
| 497 | |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 498 | if enckey is not None: |
Salome Thirot | 0f64197 | 2021-05-14 11:19:55 +0100 | [diff] [blame] | 499 | if encrypt_keylen == 256: |
| 500 | plainkey = os.urandom(32) |
| 501 | else: |
| 502 | plainkey = os.urandom(16) |
Fabio Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 503 | |
| 504 | if isinstance(enckey, rsa.RSAPublic): |
| 505 | cipherkey = enckey._get_public().encrypt( |
| 506 | plainkey, padding.OAEP( |
| 507 | mgf=padding.MGF1(algorithm=hashes.SHA256()), |
| 508 | algorithm=hashes.SHA256(), |
| 509 | label=None)) |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 510 | self.enctlv_len = len(cipherkey) |
Fabio Utzig | 7a3b260 | 2019-10-22 09:56:44 -0300 | [diff] [blame] | 511 | tlv.add('ENCRSA2048', cipherkey) |
Fabio Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 512 | elif isinstance(enckey, (ecdsa.ECDSA256P1Public, |
| 513 | x25519.X25519Public)): |
| 514 | cipherkey, mac, pubk = self.ecies_hkdf(enckey, plainkey) |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 515 | enctlv = pubk + mac + cipherkey |
| 516 | self.enctlv_len = len(enctlv) |
Fabio Utzig | 960b4c5 | 2020-04-02 13:07:12 -0300 | [diff] [blame] | 517 | if isinstance(enckey, ecdsa.ECDSA256P1Public): |
| 518 | tlv.add('ENCEC256', enctlv) |
| 519 | else: |
| 520 | tlv.add('ENCX25519', enctlv) |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 521 | |
Michel Jaouen | d09aa6b | 2022-01-07 16:48:58 +0100 | [diff] [blame] | 522 | if not clear: |
| 523 | nonce = bytes([0] * 16) |
| 524 | cipher = Cipher(algorithms.AES(plainkey), modes.CTR(nonce), |
| 525 | backend=default_backend()) |
| 526 | encryptor = cipher.encryptor() |
| 527 | img = bytes(self.payload[self.header_size:]) |
| 528 | self.payload[self.header_size:] = \ |
| 529 | encryptor.update(img) + encryptor.finalize() |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 530 | |
Fabio Utzig | 510fddb | 2019-09-12 12:15:36 -0300 | [diff] [blame] | 531 | self.payload += prot_tlv.get() |
| 532 | self.payload += tlv.get() |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 533 | |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 534 | self.check_trailer() |
| 535 | |
Andrzej Puzdrowski | 160303c | 2022-03-15 15:41:14 +0100 | [diff] [blame] | 536 | def get_signature(self): |
| 537 | return self.signature |
| 538 | |
Salome Thirot | 0f64197 | 2021-05-14 11:19:55 +0100 | [diff] [blame] | 539 | def add_header(self, enckey, protected_tlv_size, aes_length=128): |
Fabio Utzig | cd28406 | 2018-11-30 11:05:45 -0200 | [diff] [blame] | 540 | """Install the image header.""" |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 541 | |
David Brown | 0f0c6a8 | 2017-06-08 09:26:24 -0600 | [diff] [blame] | 542 | flags = 0 |
Fabio Utzig | 06b77b8 | 2018-08-23 16:01:16 -0300 | [diff] [blame] | 543 | if enckey is not None: |
Salome Thirot | 0f64197 | 2021-05-14 11:19:55 +0100 | [diff] [blame] | 544 | if aes_length == 128: |
| 545 | flags |= IMAGE_F['ENCRYPTED_AES128'] |
| 546 | else: |
| 547 | flags |= IMAGE_F['ENCRYPTED_AES256'] |
David Vincze | 1e0c544 | 2020-04-07 14:12:33 +0200 | [diff] [blame] | 548 | if self.load_addr != 0: |
| 549 | # Indicates that this image should be loaded into RAM |
| 550 | # instead of run directly from flash. |
| 551 | flags |= IMAGE_F['RAM_LOAD'] |
Dominik Ermel | 50820b1 | 2020-12-14 13:16:46 +0000 | [diff] [blame] | 552 | if self.rom_fixed: |
| 553 | flags |= IMAGE_F['ROM_FIXED'] |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 554 | |
Mark Schulte | a66c687 | 2018-09-26 17:24:40 -0700 | [diff] [blame] | 555 | e = STRUCT_ENDIAN_DICT[self.endian] |
| 556 | fmt = (e + |
David Vincze | da8c919 | 2019-03-26 17:17:41 +0100 | [diff] [blame] | 557 | # type ImageHdr struct { |
| 558 | 'I' + # Magic uint32 |
| 559 | 'I' + # LoadAddr uint32 |
| 560 | 'H' + # HdrSz uint16 |
| 561 | 'H' + # PTLVSz uint16 |
| 562 | 'I' + # ImgSz uint32 |
| 563 | 'I' + # Flags uint32 |
| 564 | 'BBHI' + # Vers ImageVersion |
| 565 | 'I' # Pad1 uint32 |
| 566 | ) # } |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 567 | assert struct.calcsize(fmt) == IMAGE_HEADER_SIZE |
| 568 | header = struct.pack(fmt, |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 569 | IMAGE_MAGIC, |
| 570 | self.rom_fixed or self.load_addr, |
| 571 | self.header_size, |
| 572 | protected_tlv_size, # TLV Info header + |
| 573 | # Protected TLVs |
| 574 | len(self.payload) - self.header_size, # ImageSz |
| 575 | flags, |
| 576 | self.version.major, |
| 577 | self.version.minor or 0, |
| 578 | self.version.revision or 0, |
| 579 | self.version.build or 0, |
| 580 | 0) # Pad1 |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 581 | self.payload = bytearray(self.payload) |
| 582 | self.payload[:len(header)] = header |
| 583 | |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 584 | def _trailer_size(self, write_size, max_sectors, overwrite_only, enckey, |
| 585 | save_enctlv, enctlv_len): |
Fabio Utzig | 519285f | 2018-06-04 11:11:53 -0300 | [diff] [blame] | 586 | # NOTE: should already be checked by the argument parser |
Fabio Utzig | 649d80f | 2019-09-12 10:26:23 -0300 | [diff] [blame] | 587 | magic_size = 16 |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 588 | magic_align_size = align_up(magic_size, self.max_align) |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 589 | if overwrite_only: |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 590 | return self.max_align * 2 + magic_align_size |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 591 | else: |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 592 | if write_size not in set([1, 2, 4, 8, 16, 32]): |
Fabio Utzig | 1f50892 | 2020-01-15 11:37:51 -0300 | [diff] [blame] | 593 | raise click.BadParameter("Invalid alignment: {}".format( |
| 594 | write_size)) |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 595 | m = DEFAULT_MAX_SECTORS if max_sectors is None else max_sectors |
Fabio Utzig | 649d80f | 2019-09-12 10:26:23 -0300 | [diff] [blame] | 596 | trailer = m * 3 * write_size # status area |
| 597 | if enckey is not None: |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 598 | if save_enctlv: |
| 599 | # TLV saved by the bootloader is aligned |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 600 | keylen = align_up(enctlv_len, self.max_align) |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 601 | else: |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 602 | keylen = align_up(16, self.max_align) |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 603 | trailer += keylen * 2 # encryption keys |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 604 | trailer += self.max_align * 4 # image_ok/copy_done/swap_info/swap_size |
| 605 | trailer += magic_align_size |
Fabio Utzig | 649d80f | 2019-09-12 10:26:23 -0300 | [diff] [blame] | 606 | return trailer |
Fabio Utzig | 519285f | 2018-06-04 11:11:53 -0300 | [diff] [blame] | 607 | |
Fabio Utzig | 263d439 | 2018-06-05 10:37:35 -0300 | [diff] [blame] | 608 | def pad_to(self, size): |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 609 | """Pad the image to the given size, with the given flash alignment.""" |
Fabio Utzig | dcf0c9b | 2018-06-11 12:27:49 -0700 | [diff] [blame] | 610 | tsize = self._trailer_size(self.align, self.max_sectors, |
Fabio Utzig | 9a492d5 | 2020-01-15 11:31:52 -0300 | [diff] [blame] | 611 | self.overwrite_only, self.enckey, |
| 612 | self.save_enctlv, self.enctlv_len) |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 613 | padding = size - (len(self.payload) + tsize) |
Henrik Brix Andersen | 0ce958e | 2020-03-11 14:04:11 +0100 | [diff] [blame] | 614 | pbytes = bytearray([self.erased_val] * padding) |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 615 | pbytes += bytearray([self.erased_val] * (tsize - len(self.boot_magic))) |
| 616 | pbytes += self.boot_magic |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 617 | if self.confirm and not self.overwrite_only: |
| 618 | magic_size = 16 |
Gustavo Henrique Nihei | cf120ba | 2021-11-22 18:44:11 -0300 | [diff] [blame] | 619 | magic_align_size = align_up(magic_size, self.max_align) |
Kristine Jassmann | 73c38c6 | 2021-02-03 16:56:14 +0000 | [diff] [blame] | 620 | image_ok_idx = -(magic_align_size + self.max_align) |
| 621 | pbytes[image_ok_idx] = 0x01 # image_ok = 0x01 |
David Brown | 23f91ad | 2017-05-16 11:38:17 -0600 | [diff] [blame] | 622 | self.payload += pbytes |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 623 | |
| 624 | @staticmethod |
| 625 | def verify(imgfile, key): |
| 626 | with open(imgfile, "rb") as f: |
| 627 | b = f.read() |
| 628 | |
| 629 | magic, _, header_size, _, img_size = struct.unpack('IIHHI', b[:16]) |
Marek Pieta | e955510 | 2019-08-08 16:08:16 +0200 | [diff] [blame] | 630 | version = struct.unpack('BBHI', b[20:28]) |
| 631 | |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 632 | if magic != IMAGE_MAGIC: |
Casper Meijn | 2a01f3f | 2020-08-22 13:51:40 +0200 | [diff] [blame] | 633 | return VerifyResult.INVALID_MAGIC, None, None |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 634 | |
Fabio Utzig | d12a8da | 2021-01-21 08:44:59 -0300 | [diff] [blame] | 635 | tlv_off = header_size + img_size |
| 636 | tlv_info = b[tlv_off:tlv_off+TLV_INFO_SIZE] |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 637 | magic, tlv_tot = struct.unpack('HH', tlv_info) |
Fabio Utzig | d12a8da | 2021-01-21 08:44:59 -0300 | [diff] [blame] | 638 | if magic == TLV_PROT_INFO_MAGIC: |
| 639 | tlv_off += tlv_tot |
| 640 | tlv_info = b[tlv_off:tlv_off+TLV_INFO_SIZE] |
| 641 | magic, tlv_tot = struct.unpack('HH', tlv_info) |
| 642 | |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 643 | if magic != TLV_INFO_MAGIC: |
Casper Meijn | 2a01f3f | 2020-08-22 13:51:40 +0200 | [diff] [blame] | 644 | return VerifyResult.INVALID_TLV_INFO_MAGIC, None, None |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 645 | |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 646 | if isinstance(key, ecdsa.ECDSA384P1Public): |
| 647 | sha = hashlib.sha384() |
| 648 | hash_tlv = "SHA384" |
| 649 | else: |
| 650 | sha = hashlib.sha256() |
| 651 | hash_tlv = "SHA256" |
| 652 | |
Fabio Utzig | d12a8da | 2021-01-21 08:44:59 -0300 | [diff] [blame] | 653 | prot_tlv_size = tlv_off |
| 654 | sha.update(b[:prot_tlv_size]) |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 655 | digest = sha.digest() |
| 656 | |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 657 | tlv_end = tlv_off + tlv_tot |
| 658 | tlv_off += TLV_INFO_SIZE # skip tlv info |
| 659 | while tlv_off < tlv_end: |
| 660 | tlv = b[tlv_off:tlv_off+TLV_SIZE] |
| 661 | tlv_type, _, tlv_len = struct.unpack('BBH', tlv) |
Roland Mikhel | 5704174 | 2023-02-03 14:43:13 +0100 | [diff] [blame] | 662 | if tlv_type == TLV_VALUES[hash_tlv]: |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 663 | off = tlv_off + TLV_SIZE |
| 664 | if digest == b[off:off+tlv_len]: |
| 665 | if key is None: |
Casper Meijn | 2a01f3f | 2020-08-22 13:51:40 +0200 | [diff] [blame] | 666 | return VerifyResult.OK, version, digest |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 667 | else: |
Casper Meijn | 2a01f3f | 2020-08-22 13:51:40 +0200 | [diff] [blame] | 668 | return VerifyResult.INVALID_HASH, None, None |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 669 | elif key is not None and tlv_type == TLV_VALUES[key.sig_tlv()]: |
| 670 | off = tlv_off + TLV_SIZE |
| 671 | tlv_sig = b[off:off+tlv_len] |
Fabio Utzig | d12a8da | 2021-01-21 08:44:59 -0300 | [diff] [blame] | 672 | payload = b[:prot_tlv_size] |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 673 | try: |
Fabio Utzig | 8101d1f | 2019-05-09 15:03:22 -0300 | [diff] [blame] | 674 | if hasattr(key, 'verify'): |
| 675 | key.verify(tlv_sig, payload) |
| 676 | else: |
| 677 | key.verify_digest(tlv_sig, digest) |
Casper Meijn | 2a01f3f | 2020-08-22 13:51:40 +0200 | [diff] [blame] | 678 | return VerifyResult.OK, version, digest |
Fabio Utzig | 4a5477a | 2019-05-27 15:45:08 -0300 | [diff] [blame] | 679 | except InvalidSignature: |
| 680 | # continue to next TLV |
| 681 | pass |
| 682 | tlv_off += TLV_SIZE + tlv_len |
Casper Meijn | 2a01f3f | 2020-08-22 13:51:40 +0200 | [diff] [blame] | 683 | return VerifyResult.INVALID_SIGNATURE, None, None |