|
|
|
@ -14,13 +14,15 @@
|
|
|
|
# You should have received a copy of the License along with this library.
|
|
|
|
# You should have received a copy of the License along with this library.
|
|
|
|
# If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
|
|
|
|
# If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
|
|
|
|
|
|
|
|
|
|
|
|
import struct
|
|
|
|
import typing as t
|
|
|
|
|
|
|
|
from copy import copy
|
|
|
|
|
|
|
|
from dataclasses import asdict
|
|
|
|
from enum import Enum
|
|
|
|
from enum import Enum
|
|
|
|
from hashlib import blake2s
|
|
|
|
|
|
|
|
from typing import Any, List, Optional
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
import click
|
|
|
|
import click
|
|
|
|
import construct as c
|
|
|
|
import construct as c
|
|
|
|
|
|
|
|
from construct_classes import Struct
|
|
|
|
|
|
|
|
from typing_extensions import Protocol, Self, runtime_checkable
|
|
|
|
|
|
|
|
|
|
|
|
from .. import cosi, firmware
|
|
|
|
from .. import cosi, firmware
|
|
|
|
|
|
|
|
|
|
|
|
@ -43,48 +45,25 @@ VHASH_DEVEL = bytes.fromhex(
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AnyFirmware = c.Struct(
|
|
|
|
|
|
|
|
"vendor_header" / c.Optional(firmware.VendorHeader),
|
|
|
|
|
|
|
|
"image" / c.Optional(firmware.FirmwareImage),
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class ImageType(Enum):
|
|
|
|
class ImageType(Enum):
|
|
|
|
VENDOR_HEADER = 0
|
|
|
|
VENDOR_HEADER = 0
|
|
|
|
BOOTLOADER = 1
|
|
|
|
BOOTLOADER = 1
|
|
|
|
FIRMWARE = 2
|
|
|
|
FIRMWARE = 2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _make_dev_keys(*key_bytes: bytes) -> List[bytes]:
|
|
|
|
def _make_dev_keys(*key_bytes: bytes) -> t.Sequence[bytes]:
|
|
|
|
return [k * 32 for k in key_bytes]
|
|
|
|
return [k * 32 for k in key_bytes]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def compute_vhash(vendor_header: c.Container) -> bytes:
|
|
|
|
|
|
|
|
m = vendor_header.sig_m
|
|
|
|
|
|
|
|
n = vendor_header.sig_n
|
|
|
|
|
|
|
|
pubkeys = vendor_header.pubkeys
|
|
|
|
|
|
|
|
h = blake2s()
|
|
|
|
|
|
|
|
h.update(struct.pack("<BB", m, n))
|
|
|
|
|
|
|
|
for i in range(8):
|
|
|
|
|
|
|
|
if i < n:
|
|
|
|
|
|
|
|
h.update(pubkeys[i])
|
|
|
|
|
|
|
|
else:
|
|
|
|
|
|
|
|
h.update(b"\x00" * 32)
|
|
|
|
|
|
|
|
return h.digest()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def all_zero(data: bytes) -> bool:
|
|
|
|
def all_zero(data: bytes) -> bool:
|
|
|
|
return all(b == 0 for b in data)
|
|
|
|
return all(b == 0 for b in data)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _check_signature_any(
|
|
|
|
def _check_signature_any(fw: "SignableImageProto", is_devel: bool) -> Status:
|
|
|
|
header: c.Container, m: int, pubkeys: List[bytes], is_devel: bool
|
|
|
|
if not fw.signature_present():
|
|
|
|
) -> Status:
|
|
|
|
|
|
|
|
if all_zero(header.signature) and header.sigmask == 0:
|
|
|
|
|
|
|
|
return Status.MISSING
|
|
|
|
return Status.MISSING
|
|
|
|
try:
|
|
|
|
try:
|
|
|
|
digest = firmware.header_digest(header)
|
|
|
|
fw.verify()
|
|
|
|
cosi.verify(header.signature, digest, m, pubkeys, header.sigmask)
|
|
|
|
|
|
|
|
return Status.VALID if not is_devel else Status.DEVEL
|
|
|
|
return Status.VALID if not is_devel else Status.DEVEL
|
|
|
|
except Exception:
|
|
|
|
except Exception:
|
|
|
|
return Status.INVALID
|
|
|
|
return Status.INVALID
|
|
|
|
@ -98,11 +77,11 @@ class LiteralStr(str):
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _format_container(
|
|
|
|
def _format_container(
|
|
|
|
pb: c.Container,
|
|
|
|
pb: t.Union[c.Container, Struct, dict],
|
|
|
|
indent: int = 0,
|
|
|
|
indent: int = 0,
|
|
|
|
sep: str = " " * 4,
|
|
|
|
sep: str = " " * 4,
|
|
|
|
truncate_after: Optional[int] = 64,
|
|
|
|
truncate_after: t.Optional[int] = 64,
|
|
|
|
truncate_to: Optional[int] = 32,
|
|
|
|
truncate_to: t.Optional[int] = 32,
|
|
|
|
) -> str:
|
|
|
|
) -> str:
|
|
|
|
def mostly_printable(bytes: bytes) -> bool:
|
|
|
|
def mostly_printable(bytes: bytes) -> bool:
|
|
|
|
if not bytes:
|
|
|
|
if not bytes:
|
|
|
|
@ -110,7 +89,7 @@ def _format_container(
|
|
|
|
printable = sum(1 for byte in bytes if 0x20 <= byte <= 0x7E)
|
|
|
|
printable = sum(1 for byte in bytes if 0x20 <= byte <= 0x7E)
|
|
|
|
return printable / len(bytes) > 0.8
|
|
|
|
return printable / len(bytes) > 0.8
|
|
|
|
|
|
|
|
|
|
|
|
def pformat(value: Any, indent: int) -> str:
|
|
|
|
def pformat(value: t.Any, indent: int) -> str:
|
|
|
|
level = sep * indent
|
|
|
|
level = sep * indent
|
|
|
|
leadin = sep * (indent + 1)
|
|
|
|
leadin = sep * (indent + 1)
|
|
|
|
|
|
|
|
|
|
|
|
@ -127,6 +106,9 @@ def _format_container(
|
|
|
|
lines[1:1] = [leadin + pformat(x, indent + 1) for x in value]
|
|
|
|
lines[1:1] = [leadin + pformat(x, indent + 1) for x in value]
|
|
|
|
return "\n".join(lines)
|
|
|
|
return "\n".join(lines)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if isinstance(value, Struct):
|
|
|
|
|
|
|
|
value = asdict(value)
|
|
|
|
|
|
|
|
|
|
|
|
if isinstance(value, dict):
|
|
|
|
if isinstance(value, dict):
|
|
|
|
lines = ["{"]
|
|
|
|
lines = ["{"]
|
|
|
|
for key, val in value.items():
|
|
|
|
for key, val in value.items():
|
|
|
|
@ -158,88 +140,140 @@ def _format_container(
|
|
|
|
return pformat(pb, indent)
|
|
|
|
return pformat(pb, indent)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _format_version(version: c.Container) -> str:
|
|
|
|
def _format_version(version: t.Tuple[int, ...]) -> str:
|
|
|
|
version_str = ".".join(
|
|
|
|
return ".".join(str(i) for i in version)
|
|
|
|
str(version[k]) for k in ("major", "minor", "patch") if k in version
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
if "build" in version:
|
|
|
|
def format_header(
|
|
|
|
version_str += f" build {version.build}"
|
|
|
|
header: firmware.core.FirmwareHeader,
|
|
|
|
return version_str
|
|
|
|
code_hashes: t.Sequence[bytes],
|
|
|
|
|
|
|
|
digest: bytes,
|
|
|
|
|
|
|
|
sig_status: Status,
|
|
|
|
|
|
|
|
) -> str:
|
|
|
|
|
|
|
|
header_dict = asdict(header)
|
|
|
|
|
|
|
|
header_out = header_dict.copy()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
for key, val in header_out.items():
|
|
|
|
|
|
|
|
if "version" in key:
|
|
|
|
|
|
|
|
header_out[key] = LiteralStr(_format_version(val))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
hashes_out = []
|
|
|
|
|
|
|
|
for expected, actual in zip(header.hashes, code_hashes):
|
|
|
|
|
|
|
|
status = SYM_OK if expected == actual else SYM_FAIL
|
|
|
|
|
|
|
|
hashes_out.append(LiteralStr(f"{status} {expected.hex()}"))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if all(all_zero(h) for h in header.hashes):
|
|
|
|
|
|
|
|
hash_status = Status.MISSING
|
|
|
|
|
|
|
|
elif header.hashes != code_hashes:
|
|
|
|
|
|
|
|
hash_status = Status.INVALID
|
|
|
|
|
|
|
|
else:
|
|
|
|
|
|
|
|
hash_status = Status.VALID
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
header_out["hashes"] = hashes_out
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
all_ok = SYM_OK if hash_status.is_ok() and sig_status.is_ok() else SYM_FAIL
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
output = [
|
|
|
|
|
|
|
|
"Firmware Header " + _format_container(header_out),
|
|
|
|
|
|
|
|
f"Fingerprint: {click.style(digest.hex(), bold=True)}",
|
|
|
|
|
|
|
|
f"{all_ok} Signature is {sig_status.value}, hashes are {hash_status.value}",
|
|
|
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
return "\n".join(output)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# =========================== functionality implementations ===============
|
|
|
|
# =========================== functionality implementations ===============
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class SignableImage:
|
|
|
|
class SignableImageProto(Protocol):
|
|
|
|
NAME = "Unrecognized image"
|
|
|
|
NAME: t.ClassVar[str]
|
|
|
|
BIP32_INDEX: Optional[int] = None
|
|
|
|
|
|
|
|
DEV_KEYS: List[bytes] = []
|
|
|
|
|
|
|
|
DEV_KEY_SIGMASK = 0b11
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def __init__(self, fw: c.Container) -> None:
|
|
|
|
@classmethod
|
|
|
|
self.fw = fw
|
|
|
|
def parse(cls, data: bytes) -> Self:
|
|
|
|
self.header: Any
|
|
|
|
...
|
|
|
|
self.public_keys: List[bytes]
|
|
|
|
|
|
|
|
self.sigs_required = firmware.V2_SIGS_REQUIRED
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def digest(self) -> bytes:
|
|
|
|
def digest(self) -> bytes:
|
|
|
|
return firmware.header_digest(self.header)
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
def check_signature(self) -> Status:
|
|
|
|
def verify(self) -> None:
|
|
|
|
raise NotImplementedError
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
def rehash(self) -> None:
|
|
|
|
def build(self) -> bytes:
|
|
|
|
pass
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def signature_present(self) -> bool:
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def public_keys(self) -> t.Sequence[bytes]:
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@runtime_checkable
|
|
|
|
|
|
|
|
class CosiSignedImage(SignableImageProto, Protocol):
|
|
|
|
|
|
|
|
DEV_KEYS: t.ClassVar[t.Sequence[bytes]] = []
|
|
|
|
|
|
|
|
|
|
|
|
def insert_signature(self, signature: bytes, sigmask: int) -> None:
|
|
|
|
def insert_signature(self, signature: bytes, sigmask: int) -> None:
|
|
|
|
self.header.signature = signature
|
|
|
|
...
|
|
|
|
self.header.sigmask = sigmask
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@runtime_checkable
|
|
|
|
|
|
|
|
class LegacySignedImage(SignableImageProto, Protocol):
|
|
|
|
|
|
|
|
def slots(self) -> t.Iterable[int]:
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
def dump(self) -> bytes:
|
|
|
|
def insert_signature(self, slot: int, key_index: int, signature: bytes) -> None:
|
|
|
|
return AnyFirmware.build(self.fw)
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
def format(self, verbose: bool) -> str:
|
|
|
|
|
|
|
|
return _format_container(self.fw)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class CosiSignatureHeaderProto(Protocol):
|
|
|
|
|
|
|
|
signature: bytes
|
|
|
|
|
|
|
|
sigmask: int
|
|
|
|
|
|
|
|
|
|
|
|
class VendorHeader(SignableImage):
|
|
|
|
|
|
|
|
|
|
|
|
class CosiSignedMixin:
|
|
|
|
|
|
|
|
def signature_present(self) -> bool:
|
|
|
|
|
|
|
|
header = self.get_header()
|
|
|
|
|
|
|
|
return not all_zero(header.signature) or header.sigmask != 0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def insert_signature(self, signature: bytes, sigmask: int) -> None:
|
|
|
|
|
|
|
|
self.get_header().signature = signature
|
|
|
|
|
|
|
|
self.get_header().sigmask = sigmask
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def get_header(self) -> CosiSignatureHeaderProto:
|
|
|
|
|
|
|
|
raise NotImplementedError
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class VendorHeader(firmware.VendorHeader, CosiSignedMixin):
|
|
|
|
NAME = "vendorheader"
|
|
|
|
NAME = "vendorheader"
|
|
|
|
BIP32_INDEX = 1
|
|
|
|
|
|
|
|
DEV_KEYS = _make_dev_keys(b"\x44", b"\x45")
|
|
|
|
DEV_KEYS = _make_dev_keys(b"\x44", b"\x45")
|
|
|
|
|
|
|
|
|
|
|
|
def __init__(self, fw: c.Container) -> None:
|
|
|
|
SUBCON = c.Struct(*firmware.VendorHeader.SUBCON.subcons, c.Terminated)
|
|
|
|
super().__init__(fw)
|
|
|
|
|
|
|
|
self.header = fw.vendor_header
|
|
|
|
|
|
|
|
self.public_keys = firmware.V2_BOOTLOADER_KEYS
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def check_signature(self) -> Status:
|
|
|
|
def get_header(self) -> CosiSignatureHeaderProto:
|
|
|
|
return _check_signature_any(
|
|
|
|
return self
|
|
|
|
self.header, self.sigs_required, self.public_keys, False
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def _format(self, terse: bool) -> str:
|
|
|
|
def _format(self, terse: bool) -> str:
|
|
|
|
vh = self.fw.vendor_header
|
|
|
|
|
|
|
|
if not terse:
|
|
|
|
if not terse:
|
|
|
|
vhash = compute_vhash(vh)
|
|
|
|
|
|
|
|
output = [
|
|
|
|
output = [
|
|
|
|
"Vendor Header " + _format_container(vh),
|
|
|
|
"Vendor Header " + _format_container(self),
|
|
|
|
f"Pubkey bundle hash: {vhash.hex()}",
|
|
|
|
f"Pubkey bundle hash: {self.vhash().hex()}",
|
|
|
|
]
|
|
|
|
]
|
|
|
|
else:
|
|
|
|
else:
|
|
|
|
output = [
|
|
|
|
output = [
|
|
|
|
"Vendor Header for {vendor} version {version} ({size} bytes)".format(
|
|
|
|
"Vendor Header for {vendor} version {version} ({size} bytes)".format(
|
|
|
|
vendor=click.style(vh.text, bold=True),
|
|
|
|
vendor=click.style(self.text, bold=True),
|
|
|
|
version=_format_version(vh.version),
|
|
|
|
version=_format_version(self.version),
|
|
|
|
size=vh.header_len,
|
|
|
|
size=self.header_len,
|
|
|
|
),
|
|
|
|
),
|
|
|
|
]
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
fingerprint = firmware.header_digest(vh)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if not terse:
|
|
|
|
if not terse:
|
|
|
|
output.append(f"Fingerprint: {click.style(fingerprint.hex(), bold=True)}")
|
|
|
|
output.append(f"Fingerprint: {click.style(self.digest().hex(), bold=True)}")
|
|
|
|
|
|
|
|
|
|
|
|
sig_status = self.check_signature()
|
|
|
|
sig_status = _check_signature_any(self, is_devel=False)
|
|
|
|
sym = SYM_OK if sig_status.is_ok() else SYM_FAIL
|
|
|
|
sym = SYM_OK if sig_status.is_ok() else SYM_FAIL
|
|
|
|
output.append(f"{sym} Signature is {sig_status.value}")
|
|
|
|
output.append(f"{sym} Signature is {sig_status.value}")
|
|
|
|
|
|
|
|
|
|
|
|
@ -248,138 +282,168 @@ class VendorHeader(SignableImage):
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
return self._format(terse=False)
|
|
|
|
return self._format(terse=False)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def public_keys(self) -> t.Sequence[bytes]:
|
|
|
|
|
|
|
|
return firmware.V2_BOOTLOADER_KEYS
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class VendorFirmware(firmware.VendorFirmware, CosiSignedMixin):
|
|
|
|
|
|
|
|
NAME = "firmware"
|
|
|
|
|
|
|
|
DEV_KEYS = _make_dev_keys(b"\x47", b"\x48")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def get_header(self) -> CosiSignatureHeaderProto:
|
|
|
|
|
|
|
|
return self.firmware.header
|
|
|
|
|
|
|
|
|
|
|
|
class BinImage(SignableImage):
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
def __init__(self, fw: c.Container) -> None:
|
|
|
|
vh = copy(self.vendor_header)
|
|
|
|
super().__init__(fw)
|
|
|
|
vh.__class__ = VendorHeader
|
|
|
|
self.header = self.fw.image.header
|
|
|
|
assert isinstance(vh, VendorHeader)
|
|
|
|
self.code_hashes = firmware.calculate_code_hashes(
|
|
|
|
|
|
|
|
self.fw.image.code, self.fw.image._code_offset
|
|
|
|
is_devel = self.vendor_header.vhash() == VHASH_DEVEL
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
return (
|
|
|
|
|
|
|
|
vh._format(terse=not verbose)
|
|
|
|
|
|
|
|
+ "\n"
|
|
|
|
|
|
|
|
+ format_header(
|
|
|
|
|
|
|
|
self.firmware.header,
|
|
|
|
|
|
|
|
self.firmware.code_hashes(),
|
|
|
|
|
|
|
|
self.digest(),
|
|
|
|
|
|
|
|
_check_signature_any(self, is_devel),
|
|
|
|
|
|
|
|
)
|
|
|
|
)
|
|
|
|
)
|
|
|
|
self.digest_header = self.header.copy()
|
|
|
|
|
|
|
|
self.digest_header.hashes = self.code_hashes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def insert_signature(self, signature: bytes, sigmask: int) -> None:
|
|
|
|
def public_keys(self) -> t.Sequence[bytes]:
|
|
|
|
super().insert_signature(signature, sigmask)
|
|
|
|
return self.vendor_header.pubkeys
|
|
|
|
self.digest_header.signature = signature
|
|
|
|
|
|
|
|
self.digest_header.sigmask = sigmask
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def digest(self) -> bytes:
|
|
|
|
|
|
|
|
return firmware.header_digest(self.digest_header)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def rehash(self) -> None:
|
|
|
|
class BootloaderImage(firmware.FirmwareImage, CosiSignedMixin):
|
|
|
|
self.header.hashes = self.code_hashes
|
|
|
|
NAME = "bootloader"
|
|
|
|
|
|
|
|
DEV_KEYS = _make_dev_keys(b"\x41", b"\x42")
|
|
|
|
|
|
|
|
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
def get_header(self) -> CosiSignatureHeaderProto:
|
|
|
|
header_out = self.header.copy()
|
|
|
|
return self.header
|
|
|
|
|
|
|
|
|
|
|
|
if not verbose:
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
for key in self.header:
|
|
|
|
return format_header(
|
|
|
|
if key.startswith("v1"):
|
|
|
|
self.header,
|
|
|
|
del header_out[key]
|
|
|
|
self.code_hashes(),
|
|
|
|
if "version" in key:
|
|
|
|
self.digest(),
|
|
|
|
header_out[key] = LiteralStr(_format_version(self.header[key]))
|
|
|
|
_check_signature_any(self, False),
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
all_ok = SYM_OK
|
|
|
|
def verify(self) -> None:
|
|
|
|
hash_status = Status.VALID
|
|
|
|
self.validate_code_hashes()
|
|
|
|
sig_status = Status.VALID
|
|
|
|
try:
|
|
|
|
|
|
|
|
cosi.verify(
|
|
|
|
|
|
|
|
self.header.signature,
|
|
|
|
|
|
|
|
self.digest(),
|
|
|
|
|
|
|
|
firmware.V2_SIGS_REQUIRED,
|
|
|
|
|
|
|
|
firmware.V2_BOARDLOADER_KEYS,
|
|
|
|
|
|
|
|
self.header.sigmask,
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
except Exception:
|
|
|
|
|
|
|
|
raise firmware.InvalidSignatureError("Invalid bootloader signature")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def public_keys(self) -> t.Sequence[bytes]:
|
|
|
|
|
|
|
|
return firmware.V2_BOARDLOADER_KEYS
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class LegacyFirmware(firmware.LegacyFirmware):
|
|
|
|
|
|
|
|
NAME = "legacy_firmware_v1"
|
|
|
|
|
|
|
|
BIP32_INDEX = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def signature_present(self) -> bool:
|
|
|
|
|
|
|
|
return any(i != 0 for i in self.key_indexes) or any(
|
|
|
|
|
|
|
|
not all_zero(sig) for sig in self.signatures
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
hashes_out = []
|
|
|
|
def insert_signature(self, slot: int, key_index: int, signature: bytes) -> None:
|
|
|
|
for expected, actual in zip(self.header.hashes, self.code_hashes):
|
|
|
|
if not 0 <= slot < firmware.V1_SIGNATURE_SLOTS:
|
|
|
|
status = SYM_OK if expected == actual else SYM_FAIL
|
|
|
|
raise ValueError("Invalid slot number")
|
|
|
|
hashes_out.append(LiteralStr(f"{status} {expected.hex()}"))
|
|
|
|
if not 0 <= key_index < len(firmware.V1_BOOTLOADER_KEYS):
|
|
|
|
|
|
|
|
raise ValueError("Invalid key index")
|
|
|
|
|
|
|
|
self.key_indexes[slot] = key_index
|
|
|
|
|
|
|
|
self.signatures[slot] = signature
|
|
|
|
|
|
|
|
|
|
|
|
if all(all_zero(h) for h in self.header.hashes):
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
hash_status = Status.MISSING
|
|
|
|
contents = asdict(self).copy()
|
|
|
|
elif self.header.hashes != self.code_hashes:
|
|
|
|
del contents["embedded_v2"]
|
|
|
|
hash_status = Status.INVALID
|
|
|
|
if self.embedded_v2:
|
|
|
|
|
|
|
|
em = copy(self.embedded_v2)
|
|
|
|
|
|
|
|
em.__class__ = LegacyV2Firmware
|
|
|
|
|
|
|
|
assert isinstance(em, LegacyV2Firmware)
|
|
|
|
|
|
|
|
embedded_content = "\nEmbedded V2 header: " + em.format(verbose=verbose)
|
|
|
|
else:
|
|
|
|
else:
|
|
|
|
hash_status = Status.VALID
|
|
|
|
embedded_content = ""
|
|
|
|
|
|
|
|
|
|
|
|
header_out["hashes"] = hashes_out
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
sig_status = self.check_signature()
|
|
|
|
return _format_container(contents) + embedded_content
|
|
|
|
all_ok = SYM_OK if hash_status.is_ok() and sig_status.is_ok() else SYM_FAIL
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
output = [
|
|
|
|
def public_keys(self) -> t.Sequence[bytes]:
|
|
|
|
"Firmware Header " + _format_container(header_out),
|
|
|
|
return firmware.V1_BOOTLOADER_KEYS
|
|
|
|
f"Fingerprint: {click.style(self.digest().hex(), bold=True)}",
|
|
|
|
|
|
|
|
f"{all_ok} Signature is {sig_status.value}, hashes are {hash_status.value}",
|
|
|
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
return "\n".join(output)
|
|
|
|
def slots(self) -> t.Iterable[int]:
|
|
|
|
|
|
|
|
return self.key_indexes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class FirmwareImage(BinImage):
|
|
|
|
class LegacyV2Firmware(firmware.LegacyV2Firmware):
|
|
|
|
NAME = "firmware"
|
|
|
|
NAME = "legacy_firmware_v2"
|
|
|
|
BIP32_INDEX = 2
|
|
|
|
BIP32_INDEX = 5
|
|
|
|
DEV_KEYS = _make_dev_keys(b"\x47", b"\x48")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def __init__(self, fw: c.Container) -> None:
|
|
|
|
def signature_present(self) -> bool:
|
|
|
|
super().__init__(fw)
|
|
|
|
return any(i != 0 for i in self.header.v1_key_indexes) or any(
|
|
|
|
self.public_keys = fw.vendor_header.pubkeys
|
|
|
|
not all_zero(sig) for sig in self.header.v1_signatures
|
|
|
|
self.sigs_required = fw.vendor_header.sig_m
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def check_signature(self) -> Status:
|
|
|
|
|
|
|
|
vhash = compute_vhash(self.fw.vendor_header)
|
|
|
|
|
|
|
|
return _check_signature_any(
|
|
|
|
|
|
|
|
self.digest_header,
|
|
|
|
|
|
|
|
self.sigs_required,
|
|
|
|
|
|
|
|
self.public_keys,
|
|
|
|
|
|
|
|
vhash == VHASH_DEVEL,
|
|
|
|
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def insert_signature(self, slot: int, key_index: int, signature: bytes) -> None:
|
|
|
|
|
|
|
|
if not 0 <= slot < firmware.V1_SIGNATURE_SLOTS:
|
|
|
|
|
|
|
|
raise ValueError("Invalid slot number")
|
|
|
|
|
|
|
|
if not 0 <= key_index < len(firmware.V1_BOOTLOADER_KEYS):
|
|
|
|
|
|
|
|
raise ValueError("Invalid key index")
|
|
|
|
|
|
|
|
if not isinstance(self.header.v1_key_indexes, list):
|
|
|
|
|
|
|
|
self.header.v1_key_indexes = list(self.header.v1_key_indexes)
|
|
|
|
|
|
|
|
if not isinstance(self.header.v1_signatures, list):
|
|
|
|
|
|
|
|
self.header.v1_signatures = list(self.header.v1_signatures)
|
|
|
|
|
|
|
|
self.header.v1_key_indexes[slot] = key_index
|
|
|
|
|
|
|
|
self.header.v1_signatures[slot] = signature
|
|
|
|
|
|
|
|
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
def format(self, verbose: bool = False) -> str:
|
|
|
|
return (
|
|
|
|
return format_header(
|
|
|
|
VendorHeader(self.fw)._format(terse=not verbose)
|
|
|
|
self.header,
|
|
|
|
+ "\n"
|
|
|
|
self.code_hashes(),
|
|
|
|
+ super().format(verbose)
|
|
|
|
self.digest(),
|
|
|
|
|
|
|
|
_check_signature_any(self, False),
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def public_keys(self) -> t.Sequence[bytes]:
|
|
|
|
|
|
|
|
return firmware.V1_BOOTLOADER_KEYS
|
|
|
|
|
|
|
|
|
|
|
|
class BootloaderImage(BinImage):
|
|
|
|
def slots(self) -> t.Iterable[int]:
|
|
|
|
NAME = "bootloader"
|
|
|
|
return self.header.v1_key_indexes
|
|
|
|
BIP32_INDEX = 0
|
|
|
|
|
|
|
|
DEV_KEYS = _make_dev_keys(b"\x41", b"\x42")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def __init__(self, fw: c.Container) -> None:
|
|
|
|
|
|
|
|
super().__init__(fw)
|
|
|
|
|
|
|
|
self._identify_dev_keys()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def insert_signature(self, signature: bytes, sigmask: int) -> None:
|
|
|
|
def parse_image(image: bytes) -> SignableImageProto:
|
|
|
|
super().insert_signature(signature, sigmask)
|
|
|
|
try:
|
|
|
|
self._identify_dev_keys()
|
|
|
|
return VendorFirmware.parse(image)
|
|
|
|
|
|
|
|
except c.ConstructError:
|
|
|
|
def _identify_dev_keys(self) -> None:
|
|
|
|
pass
|
|
|
|
# try checking signature with dev keys first
|
|
|
|
|
|
|
|
self.public_keys = firmware.V2_BOARDLOADER_DEV_KEYS
|
|
|
|
|
|
|
|
if not self.check_signature().is_ok():
|
|
|
|
|
|
|
|
# validation with dev keys failed, use production keys
|
|
|
|
|
|
|
|
self.public_keys = firmware.V2_BOARDLOADER_KEYS
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def check_signature(self) -> Status:
|
|
|
|
|
|
|
|
return _check_signature_any(
|
|
|
|
|
|
|
|
self.header,
|
|
|
|
|
|
|
|
self.sigs_required,
|
|
|
|
|
|
|
|
self.public_keys,
|
|
|
|
|
|
|
|
self.public_keys == firmware.V2_BOARDLOADER_DEV_KEYS,
|
|
|
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
|
|
|
return VendorHeader.parse(image)
|
|
|
|
|
|
|
|
except c.ConstructError:
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
|
|
|
firmware_img = firmware.core.FirmwareImage.parse(image)
|
|
|
|
|
|
|
|
if firmware_img.header.magic == firmware.core.HeaderType.BOOTLOADER:
|
|
|
|
|
|
|
|
return BootloaderImage.parse(image)
|
|
|
|
|
|
|
|
if firmware_img.header.magic == firmware.core.HeaderType.FIRMWARE:
|
|
|
|
|
|
|
|
return LegacyV2Firmware.parse(image)
|
|
|
|
|
|
|
|
raise ValueError("Unrecognized firmware header magic")
|
|
|
|
|
|
|
|
except c.ConstructError:
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
|
|
|
return LegacyFirmware.parse(image)
|
|
|
|
|
|
|
|
except c.ConstructError:
|
|
|
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
def parse_image(image: bytes) -> SignableImage:
|
|
|
|
raise ValueError("Unrecognized firmware type")
|
|
|
|
fw = AnyFirmware.parse(image)
|
|
|
|
|
|
|
|
if fw.vendor_header and not fw.image:
|
|
|
|
|
|
|
|
return VendorHeader(fw)
|
|
|
|
|
|
|
|
if (
|
|
|
|
|
|
|
|
not fw.vendor_header
|
|
|
|
|
|
|
|
and fw.image
|
|
|
|
|
|
|
|
and fw.image.header.magic == firmware.HeaderType.BOOTLOADER
|
|
|
|
|
|
|
|
):
|
|
|
|
|
|
|
|
return BootloaderImage(fw)
|
|
|
|
|
|
|
|
if (
|
|
|
|
|
|
|
|
fw.vendor_header
|
|
|
|
|
|
|
|
and fw.image
|
|
|
|
|
|
|
|
and fw.image.header.magic == firmware.HeaderType.FIRMWARE
|
|
|
|
|
|
|
|
):
|
|
|
|
|
|
|
|
return FirmwareImage(fw)
|
|
|
|
|
|
|
|
raise ValueError("Unrecognized image type")
|
|
|
|
|
|
|
|
|
matejcik
2 years ago
committed by