Merge branch 'nickez-agent/configure-stage1-embedding'
What changed, and why it matters
This commit is a build-system refactor for the BitBox02 hardware wallet firmware. It replaces a set of separate 'bootloader upgrade' firmware images with a configurable option to embed the same bootloader update data into the normal firmware image. There is no indication in the commit of a security vulnerability being fixed; it appears to be a change to how firmware variants are produced.
No security action required. Treat as a normal build-system change; review for correctness if integrating or backporting.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The merge removes dedicated firmware-blupgrade-* targets and the firmware-blupgrade.ld linker script, and instead adds an EMBED_STAGE1 CMake/Make option. When enabled, the normal firmware.elf/firmware-btc.elf links in the stage0 image object, stage1 payload object, and installer source files, placing them in a reserved bootloader_update memory region defined in firmware.ld. The change unifies the build pipeline and adds validation that stage1 embedding is only allowed for bitbox02/bitbox02nova and not bitbox03.
Changed components
BitBox02/BitBox02 Nova firmware build systemCMakeLists.txtMakefilefirmware linker script (firmware.ld)build configuration scripts (scripts/build_config.py, scripts/build_product.py)CI workflow (.github/workflows/ci-common.yml)Inspect captured patch +152 / −331
### .github/workflows/ci-common.yml
@@ -225,11 +225,11 @@ jobs:
- {target: bootloader-stage0, product: bitbox02nova, edition: multi, locked: 'yes', development: 'yes'}
- {target: bootloader-stage1, product: bitbox02, edition: multi, locked: 'yes', development: 'yes'}
- {target: bootloader-stage1, product: bitbox02nova, edition: multi, locked: 'yes', development: 'yes'}
- - {target: firmware-blupgrade-bitbox02-btconly, product: bitbox02, edition: multi}
- - {target: firmware-blupgrade-bitbox02-multi, product: bitbox02, edition: multi}
- - {target: firmware-blupgrade-bitbox02nova-btconly, product: bitbox02nova, edition: multi}
- - {target: firmware-blupgrade-bitbox02nova-multi, product: bitbox02nova, edition: multi}
- - {target: firmware-blupgrade-bitbox02-btconly-development, product: bitbox02, edition: multi}
+ - {target: firmware, product: bitbox02, edition: btc-only, embed-stage1: 'yes', locked: 'yes', development: 'no'}
+ - {target: firmware, product: bitbox02, edition: multi, embed-stage1: 'yes', locked: 'yes', development: 'no'}
+ - {target: firmware, product: bitbox02nova, edition: btc-only, embed-stage1: 'yes', locked: 'yes', development: 'no'}
+ - {target: firmware, product: bitbox02nova, edition: multi, embed-stage1: 'yes', locked: 'yes', development: 'no'}
+ - {target: firmware, product: bitbox02, edition: btc-only, embed-stage1: 'yes'}
- {target: factorysetup, product: bitbox02, edition: multi}
- {target: firmware, product: bitbox02, edition: multi, debug: 'yes'}
- {target: simulator, product: bitbox02, edition: multi}
@@ -259,7 +259,7 @@ jobs:
run: make bootstrap
- name: Configure product
- run: make config CONFIG_ARGS="--product ${{ matrix.product }} --edition ${{ matrix.edition }} --debug ${{ matrix.debug || 'no' }} --locked ${{ matrix.locked || 'no' }} --development ${{ matrix.development || 'yes' }}"
+ run: make config CONFIG_ARGS="--product ${{ matrix.product }} --edition ${{ matrix.edition }} --debug ${{ matrix.debug || 'no' }} --locked ${{ matrix.locked || 'no' }} --development ${{ matrix.development || 'yes' }} --embed-stage1 ${{ matrix.embed-stage1 || 'no' }}"
- name: Build ${{ matrix.target }}
run: make -j$(($(nproc)+1)) ${{ matrix.target }}
@@ -284,7 +284,7 @@ jobs:
if: github.event_name == 'push' && matrix.target != 'simulator-graphical' && !cancelled()
uses: actions/upload-artifact@v4
with:
- name: ${{matrix.product}}-${{matrix.edition}}-${{matrix.target}}${{ matrix.debug == 'yes' && '-debug' || '' }}-locked-${{ matrix.locked || 'no' }}-development-${{ matrix.development || 'yes' }}-${{github.sha}}.bin
+ name: ${{matrix.product}}-${{matrix.edition}}-${{matrix.target}}${{ matrix.debug == 'yes' && '-debug' || '' }}-locked-${{ matrix.locked || 'no' }}-development-${{ matrix.development || 'yes' }}-embed-stage1-${{ matrix.embed-stage1 || 'no' }}-${{github.sha}}.bin
path: |
build*/bin/*.bin
build*/bin/*.elf
### BUILD.md
@@ -188,9 +188,10 @@ Use `./scripts/dev_exec.sh make <target>` for host builds (or set `BITBOX_FW_EXE
the container toolchain).
`make config` remembers selections in the git-ignored `config.mk`. It prompts for product, board,
-edition (`multi` or `btc-only`), debug builds, locked hardware, development mode, probe software, and
-SWD speed in kHz, automatically selecting fields with one choice. `DEBUG` defaults to `no`; `SWD_SPEED` defaults to
-`4000` for all products and both probe backends. `LOCKED` defaults to `no` and `DEVELOPMENT` to `yes`.
+edition (`multi` or `btc-only`), debug builds, locked hardware, development mode, stage1 embedding,
+probe software, and SWD speed in kHz, automatically selecting fields with one choice. `DEBUG` defaults
+to `no`; `SWD_SPEED` defaults to `4000` for all products and both probe backends. `LOCKED` defaults to
+`no` and `DEVELOPMENT` to `yes`.
Probe hardware is fixed by the board:
| Product | Board | Probe | Software (default first) |
@@ -231,6 +232,22 @@ in `config.mk` and can be overridden per command, for example
`make bootloader-stage1 LOCKED=yes DEVELOPMENT=yes`. Use the same flags when flashing or running.
BitBox03 does not yet implement these bootloader modes and only accepts their defaults.
+For BitBox02/Nova firmware, `EMBED_STAGE1=yes` embeds the prebuilt stage1 update, stage0 image, and
+installer. This firmware runs the bootloader installer and reboots into the bootloader.
+The setting defaults to `no`, is saved by `make config` (`--embed-stage1 yes`), and can be overridden
+per build:
+
+```sh
+make firmware EMBED_STAGE1=yes
+make firmware PRODUCT=bitbox02nova EDITION=btc-only EMBED_STAGE1=yes LOCKED=yes DEVELOPMENT=no
+make firmware EMBED_STAGE1=no
+```
+
+The embedded assets match `PRODUCT`, `EDITION`, and `DEVELOPMENT`. Production updates require
+`LOCKED=yes DEVELOPMENT=no`; the default `DEVELOPMENT=yes` selects development updates.
+Both modes produce the usual `firmware.bin` or `firmware-btc.bin` in the product/profile directory,
+replacing the previous build there. BitBox03 does not yet support stage1 embedding.
+
Invalid input, EOF, or Ctrl-C preserves the previous file. Interactive product changes reset
incompatible saved choices. Run configuration separately from builds: `make config firmware` is
rejected because Make has already parsed the old settings. Configuration and compilation require
@@ -261,10 +278,10 @@ Use `bootloader-stage0` and `bootloader-stage1` with `LOCKED=yes DEVELOPMENT=no`
bootloaders, or `LOCKED=yes DEVELOPMENT=yes` for locked development devices. These targets build
only the configured product and edition. Development artifact names use `-development`, with
`-locked` appended for locked development devices. Production artifact names use `-production`
-and always enable locking. Upgrade-firmware and upgrade-assets aliases also use `-development`
-for development devices. Named product commands always use that product's directory.
+and always enable locking. Upgrade-assets aliases use `-development` for development devices.
+Named product commands always use that product's directory.
-The old `firmware-btc`, `factory-setup`, per-product stage build shortcuts, and
+The old `firmware-btc`, `firmware-blupgrade-*`, `factory-setup`, per-product stage build shortcuts, and
`bitbox03-*` build shortcuts are replaced by configuration plus the primary targets above.
Additional BitBox03 board/edition implementations are deferred.
### CMakeLists.txt
@@ -62,6 +62,13 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake/mod
option(SANITIZE_ADDRESS "Compile with asan." OFF)
option(SANITIZE_UNDEFINED "Compile with ubsan." OFF)
option(CMAKE_VERBOSE_MAKEFILE "Verbose build." OFF)
+option(EMBED_STAGE1 "Embed the stage1 bootloader update in firmware." OFF)
+option(DEVELOPMENT "Use development bootloader update assets." ON)
+set(PRODUCT "bitbox02" CACHE STRING "Firmware product.")
+set_property(CACHE PRODUCT PROPERTY STRINGS "bitbox02" "bitbox02nova")
+if(EMBED_STAGE1 AND NOT PRODUCT STREQUAL "bitbox02" AND NOT PRODUCT STREQUAL "bitbox02nova")
+ message(FATAL_ERROR "Embedding stage1 is only supported for bitbox02 and bitbox02nova")
+endif()
# Generate compile_command.json (for tidy and other tools)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
### Makefile
@@ -19,9 +19,10 @@ EDITION ?= multi
DEBUG ?= no
LOCKED ?= no
DEVELOPMENT ?= yes
+EMBED_STAGE1 ?= no
PROBE_SOFTWARE ?= $(if $(filter bitbox03,$(PRODUCT)),openocd,jlink)
SWD_SPEED ?= 4000
-CONFIG_OPTIONS = --product "$(PRODUCT)" --board "$(BOARD)" --edition "$(EDITION)" --debug "$(DEBUG)" --locked "$(LOCKED)" --development "$(DEVELOPMENT)" --probe-software "$(PROBE_SOFTWARE)" --swd-speed "$(SWD_SPEED)"
+CONFIG_OPTIONS = --product "$(PRODUCT)" --board "$(BOARD)" --edition "$(EDITION)" --debug "$(DEBUG)" --locked "$(LOCKED)" --development "$(DEVELOPMENT)" --embed-stage1 "$(EMBED_STAGE1)" --probe-software "$(PROBE_SOFTWARE)" --swd-speed "$(SWD_SPEED)"
config:
python3 scripts/build_config.py $(CONFIG_ARGS)
@@ -40,8 +41,6 @@ FLASH_IMAGES := $(filter-out factorysetup,$(FLASH_IMAGES))
endif
BUILD_TARGETS := $(IMAGES) \
bootloader-upgrade-assets bootloader-upgrade-assets-development docs rust-docs
-BUILD_TARGETS += $(foreach product,bitbox02 bitbox02nova,$(foreach edition,multi btconly,\
- firmware-blupgrade-$(product)-$(edition) firmware-blupgrade-$(product)-$(edition)-development))
$(BUILD_TARGETS):
+python3 scripts/build_product.py $(CONFIG_OPTIONS) $@
### firmware-blupgrade.ld
@@ -1,154 +0,0 @@
-OUTPUT_FORMAT("elf32-littlearm", "elf32-littlearm", "elf32-littlearm")
-OUTPUT_ARCH(arm)
-SEARCH_DIR(.)
-
-MEMORY
-{
- rom (rx) : ORIGIN = 0x00010000, LENGTH = 0x000CB000
- bootloader_update (rx) : ORIGIN = 0x000DB000, LENGTH = 0x0000C000
- ram (rwx) : ORIGIN = 0x20000200, LENGTH = 0x0003FE00
- bkupram (rwx) : ORIGIN = 0x47000000, LENGTH = 0x00002000
- qspi (rwx) : ORIGIN = 0x04000000, LENGTH = 0x01000000
-}
-
-ASSERT(ORIGIN(rom) + LENGTH(rom) <= ORIGIN(bootloader_update), "blupgrade code/data overlaps embedded stage1 payload")
-
-STACK_SIZE = DEFINED(STACK_SIZE) ? STACK_SIZE : DEFINED(__stack_size__) ? __stack_size__ : 0x10000;
-HEAP_SIZE = DEFINED(HEAP_SIZE) ? HEAP_SIZE : DEFINED(__heap_size__) ? __heap_size__ : 0x10000;
-
-SECTIONS
-{
- .text :
- {
- . = ALIGN(4);
- _sfixed = .;
- KEEP(*(.vectors .vectors.*))
- *(.text .text.* .gnu.linkonce.t.*)
- *(.glue_7t) *(.glue_7)
- *(.rodata .rodata* .gnu.linkonce.r.*)
- *(.ARM.extab* .gnu.linkonce.armextab.*)
-
- . = ALIGN(4);
- KEEP(*(.init))
- . = ALIGN(4);
- __preinit_array_start = .;
- KEEP (*(.preinit_array))
- __preinit_array_end = .;
-
- . = ALIGN(4);
- __init_array_start = .;
- KEEP (*(SORT(.init_array.*)))
- KEEP (*(.init_array))
- __init_array_end = .;
-
- . = ALIGN(4);
- KEEP (*crtbegin.o(.ctors))
- KEEP (*(EXCLUDE_FILE (*crtend.o) .ctors))
- KEEP (*(SORT(.ctors.*)))
- KEEP (*crtend.o(.ctors))
-
- . = ALIGN(4);
- KEEP(*(.fini))
-
- . = ALIGN(4);
- __fini_array_start = .;
- KEEP (*(.fini_array))
- KEEP (*(SORT(.fini_array.*)))
- __fini_array_end = .;
-
- KEEP (*crtbegin.o(.dtors))
- KEEP (*(EXCLUDE_FILE (*crtend.o) .dtors))
- KEEP (*(SORT(.dtors.*)))
- KEEP (*crtend.o(.dtors))
-
- . = ALIGN(4);
- _efixed = .;
- } > rom
-
- PROVIDE_HIDDEN (__exidx_start = .);
- .ARM.exidx :
- {
- *(.ARM.exidx* .gnu.linkonce.armexidx.*)
- } > rom
- PROVIDE_HIDDEN (__exidx_end = .);
-
- . = ALIGN(4);
- _etext = .;
-
- .rtt (NOLOAD) :
- {
- . = ALIGN(4);
- _srtt = .;
- *(.segger_rtt);
- *(.segger_rtt_buf);
- _ertt = .;
- } > ram
-
- .relocate :
- {
- . = ALIGN(4);
- _srelocate = .;
- *(.ramfunc .ramfunc.*);
- *(.data .data.*);
- . = ALIGN(4);
- _erelocate = .;
- } > ram AT> rom
-
- .bkupram (NOLOAD):
- {
- . = ALIGN(8);
- _sbkupram = .;
- *(.bkupram .bkupram.*);
- . = ALIGN(8);
- _ebkupram = .;
- } > bkupram
-
- .qspi (NOLOAD):
- {
- . = ALIGN(8);
- _sqspi = .;
- *(.qspi .qspi.*);
- . = ALIGN(8);
- _eqspi = .;
- } > qspi
-
- .bss (NOLOAD) :
- {
- . = ALIGN(4);
- _sbss = .;
- _szero = .;
- *(.bss .bss.*)
- *(COMMON)
- . = ALIGN(4);
- _ebss = .;
- _ezero = .;
- } > ram
-
- .stack (NOLOAD):
- {
- . = ALIGN(8);
- _sstack = .;
- . = . + STACK_SIZE;
- . = ALIGN(8);
- _estack = .;
- } > ram
-
- . = ALIGN(4);
- _end = .;
-
- .heap (NOLOAD):
- {
- . = ALIGN(8);
- _heap_start = .;
- . = . + HEAP_SIZE;
- . = ALIGN(8);
- _heap_end = .;
- } > ram
-
- .bootloader_update ORIGIN(bootloader_update) :
- {
- FILL(0xff)
- KEEP(*(.bootloader_update))
- . = ORIGIN(bootloader_update) + LENGTH(bootloader_update);
- } > bootloader_update =0xff
-}
### firmware.ld
@@ -35,11 +35,14 @@ SEARCH_DIR(.)
/* Memory Spaces Definitions */
MEMORY
{
- rom (rx) : ORIGIN = 0x00010000, LENGTH = 0x000D8000
+ rom (rx) : ORIGIN = 0x00010000, LENGTH = 0x000CB000
+ bootloader_update (rx) : ORIGIN = 0x000DB000, LENGTH = 0x0000C000
ram (rwx) : ORIGIN = 0x20000200, LENGTH = 0x0003FE00
bkupram (rwx) : ORIGIN = 0x47000000, LENGTH = 0x00002000
qspi (rwx) : ORIGIN = 0x04000000, LENGTH = 0x01000000
}
+
+ASSERT(ORIGIN(rom) + LENGTH(rom) <= ORIGIN(bootloader_update), "firmware code/data overlaps embedded stage1 payload")
/* The stack size used by the application. NOTE: Stack and heap sizes should be set in
* CMakeLists.txt */
@@ -183,4 +186,11 @@ SECTIONS
. = ALIGN(8);
_heap_end = .;
} > ram
+
+ .bootloader_update ORIGIN(bootloader_update) :
+ {
+ FILL(0xff)
+ KEEP(*(.bootloader_update))
+ . = ORIGIN(bootloader_update) + LENGTH(bootloader_update);
+ } > bootloader_update =0xff
}
### scripts/bootloader_update.py
@@ -282,7 +282,7 @@ def main() -> None:
update_parser = subparsers.add_parser(
"create-stage1-fw-embedding",
- help="create the stage1 update payload consumed by blupgrade firmware",
+ help="create the stage1 update payload embedded in firmware",
description=(
"Validate a stage1 image for the requested product and production "
"or development mode, then pad it with erased-flash bytes to the fixed "
@@ -298,7 +298,7 @@ def main() -> None:
embed_parser = subparsers.add_parser(
"create-stage0-fw-embedding",
- help="create the stage0 image blob consumed by blupgrade firmware",
+ help="create the stage0 image blob embedded in firmware",
description=(
"Validate a prebuilt stage0 image descriptor for the requested product "
"and production or development mode, then pad the image to the fixed "
### scripts/build_config.py
@@ -45,6 +45,7 @@ class Config:
debug: str = "no"
locked: str = "no"
development: str = "yes"
+ embed_stage1: str = "no"
@property
def profile(self) -> str:
@@ -79,6 +80,10 @@ def validate(self) -> Config:
raise ValueError(f"Invalid locked setting: {self.locked}")
if self.development not in ("no", "yes"):
raise ValueError(f"Invalid development setting: {self.development}")
+ if self.embed_stage1 not in ("no", "yes"):
+ raise ValueError(f"Invalid embed-stage1 setting: {self.embed_stage1}")
+ if self.product == "bitbox03" and self.embed_stage1 == "yes":
+ raise ValueError("Embedding stage1 is not implemented for BitBox03")
if self.product == "bitbox03" and (self.locked != "no" or self.development != "yes"):
raise ValueError("Locked and non-development builds are not implemented for BitBox03")
if self.development == "no" and self.locked == "no":
@@ -95,6 +100,7 @@ def describe(self) -> None:
print(f"Product: {self.product}; board: {self.board}; edition: {self.edition}")
print(f"Debug: {self.debug}; profile: {self.profile}")
print(f"Locked: {self.locked}; development: {self.development}")
+ print(f"Embed stage1: {self.embed_stage1}")
print(f"Probe hardware: {self.probe_hardware}; software: {self.probe_software}")
print(f"SWD speed: {self.swd_speed} kHz")
if self.product == "bitbox03":
@@ -121,6 +127,9 @@ def add_config_arguments(parser: argparse.ArgumentParser) -> None:
parser.add_argument("--debug", choices=("no", "yes"), help="Debug build (default: no)")
parser.add_argument("--locked", choices=("no", "yes"), help="Lock hardware (default: no)")
parser.add_argument("--development", choices=("no", "yes"), help="Development (default: yes)")
+ parser.add_argument(
+ "--embed-stage1", choices=("no", "yes"), help="Embed stage1 in firmware (default: no)"
+ )
parser.add_argument("--probe-software", choices=("jlink", "openocd"))
parser.add_argument("--swd-speed", type=int, help="SWD speed in kHz (default: 4000)")
@@ -136,6 +145,7 @@ def from_args(args: argparse.Namespace) -> Config:
args.debug or base.debug,
args.locked or base.locked,
args.development or base.development,
+ args.embed_stage1 or base.embed_stage1,
).validate()
@@ -152,6 +162,7 @@ def read_config(path: Path) -> dict[str, str]:
"DEBUG",
"LOCKED",
"DEVELOPMENT",
+ "EMBED_STAGE1",
"PROBE_SOFTWARE",
"SWD_SPEED",
):
@@ -192,6 +203,11 @@ def interactive(saved: dict[str, str]) -> Config:
("yes",) if locked == "no" else ("yes", "no"),
saved.get("DEVELOPMENT", base.development),
)
+ embed_stage1 = choose(
+ "Embed stage1",
+ ("no",) if product == "bitbox03" else ("no", "yes"),
+ saved.get("EMBED_STAGE1", base.embed_stage1),
+ )
config = Config(product, board, edition, base.probe_software)
print(f"Probe hardware: {config.probe_hardware} (derived from board)")
software = choose(
@@ -200,7 +216,7 @@ def interactive(saved: dict[str, str]) -> Config:
saved_speed = saved.get("SWD_SPEED", str(base.swd_speed))
speed = input(f"SWD speed in kHz [{saved_speed}]: ").strip() or saved_speed
return Config(
- product, board, edition, software, int(speed), debug, locked, development
+ product, board, edition, software, int(speed), debug, locked, development, embed_stage1
).validate()
@@ -221,6 +237,7 @@ def save_config(path: Path, config: Config) -> None:
"debug",
"locked",
"development",
+ "embed_stage1",
"probe_software",
"swd_speed",
):
### scripts/build_product.py
@@ -46,6 +46,9 @@ def cmake(config: Config, profile: str, targets: list[str]) -> None:
str(directory),
"-DCMAKE_TOOLCHAIN_FILE=arm.cmake",
f"-DCMAKE_BUILD_TYPE={profile.upper()}",
+ f"-DPRODUCT={config.product}",
+ f"-DDEVELOPMENT={'ON' if config.development == 'yes' else 'OFF'}",
+ f"-DEMBED_STAGE1={'ON' if config.embed_stage1 == 'yes' else 'OFF'}",
]
)
if first_build:
@@ -82,9 +85,6 @@ def build_image(config: Config, image: str) -> None:
def dispatch(config: Config, target: str) -> None:
if target in IMAGES:
build_image(config, target)
- elif target.startswith("firmware-blupgrade-"):
- product = target.split("-")[2]
- cmake(defaults(product), "relwithdebinfo", [target + ".elf"])
elif target in ("bootloader-upgrade-assets", "bootloader-upgrade-assets-development"):
suffix = "-development" if target.endswith("-development") else ""
for product in ("bitbox02", "bitbox02nova"):
### src/CMakeLists.txt
@@ -445,6 +445,7 @@ if(CMAKE_CROSSCOMPILING)
# needed to find version.h
target_include_directories(${elf} PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
target_link_libraries(${elf} PRIVATE "-Wl,-Map=\"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${firmware}.map\" -T\"${CMAKE_SOURCE_DIR}/firmware.ld\"")
+ set_property(TARGET ${elf} APPEND PROPERTY LINK_DEPENDS ${CMAKE_SOURCE_DIR}/firmware.ld)
target_link_libraries(${elf} PRIVATE -Wl,--defsym=STACK_SIZE=${STACK_SIZE} -Wl,-defsym=HEAP_SIZE=${HEAP_SIZE})
target_link_libraries(${elf} PRIVATE ${QTOUCHLIB_A} ${QTOUCHLIB_B} ${QTOUCHLIB_T})
@@ -464,11 +465,9 @@ if(CMAKE_CROSSCOMPILING)
target_sources(firmware.elf PRIVATE firmware.c)
target_compile_definitions(firmware.elf PRIVATE PRODUCT_BITBOX_MULTI "APP_U2F=1")
- target_sources(firmware.elf PRIVATE ${FIRMWARE-U2F-SOURCES} ${FIRMWARE-U2F-DRIVER-SOURCES} ${PLATFORM-BITBOX02-SOURCES})
target_sources(firmware-btc.elf PRIVATE firmware.c)
target_compile_definitions(firmware-btc.elf PRIVATE PRODUCT_BITBOX_BTCONLY "APP_U2F=0")
- target_sources(firmware-btc.elf PRIVATE ${PLATFORM-BITBOX02-SOURCES})
target_sources(factory-setup.elf PRIVATE factorysetup.c)
target_compile_definitions(factory-setup.elf PRIVATE PRODUCT_BITBOX02_FACTORYSETUP "APP_U2F=0")
@@ -492,18 +491,6 @@ if(CMAKE_CROSSCOMPILING)
set(BB02_BLUPD_STAGE1_BITBOX02NOVA_BTCONLY_DEVELOPMENT_BIN ${BB02_BLUPD_BIN_DIR}/bootloader-stage1-bitbox02nova-btconly-development.v1.2.3.signed.bin)
set(BB02_BLUPD_STAGE1_BITBOX02NOVA_MULTI_DEVELOPMENT_BIN ${BB02_BLUPD_BIN_DIR}/bootloader-stage1-bitbox02nova-multi-development.v1.2.3.signed.bin)
- set(BB02_BLUPD_FIRMWARE_TARGETS
- firmware-blupgrade-bitbox02-btconly
- firmware-blupgrade-bitbox02-multi
- firmware-blupgrade-bitbox02nova-btconly
- firmware-blupgrade-bitbox02nova-multi
- firmware-blupgrade-bitbox02-btconly-development
- firmware-blupgrade-bitbox02-multi-development
- firmware-blupgrade-bitbox02nova-btconly-development
- firmware-blupgrade-bitbox02nova-multi-development
- )
- set(BB02_BLUPD_FIRMWARE_TARGETS ${BB02_BLUPD_FIRMWARE_TARGETS} PARENT_SCOPE)
-
function(add_bb02_stage1_target target rustlib product product_id development locked is_plus)
set(header_dir ${CMAKE_CURRENT_BINARY_DIR}/bootloader/${target})
set(header_manifest ${header_dir}/image_header.json)
@@ -923,145 +910,50 @@ if(CMAKE_CROSSCOMPILING)
${BB02_BLUPD_BITBOX02NOVA_MULTI_DEVELOPMENT_ASSETS_TARGET}
)
- function(add_bb02_blupgrade_firmware target rustlib product app_u2f target_product_id stage0_image_obj payload_obj development)
- add_executable(${target}.elf
- ${FIRMWARE-SOURCES}
- ${CMAKE_SOURCE_DIR}/src/firmware.c
- ${CMAKE_SOURCE_DIR}/src/bootloader_upgrade/firmware_installer_check.c
- ${CMAKE_SOURCE_DIR}/src/bootloader_upgrade/firmware_installer.c
- ${stage0_image_obj}
- ${payload_obj}
- )
- target_compile_options(${target}.elf PRIVATE -flto -ffat-lto-objects)
- target_link_libraries(${target}.elf PRIVATE
- optiga
- embedded-swd
- cryptoauthlib
- c
- ${rustlib}
- samd51a-ds
- asf4-drivers-min
- asf4-drivers
- -Wl,-u,exception_table
- -flto
- "-Wl,-Map=\"${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${target}.map\" -T\"${CMAKE_SOURCE_DIR}/firmware-blupgrade.ld\""
- -Wl,--defsym=STACK_SIZE=${STACK_SIZE}
- -Wl,-defsym=HEAP_SIZE=${HEAP_SIZE}
- ${QTOUCHLIB_A}
- ${QTOUCHLIB_B}
- ${QTOUCHLIB_T}
- --specs=nano.specs
- --specs=nosys.specs
- -Wl,--print-memory-usage
- )
- target_compile_options(${target}.elf PRIVATE --specs=nano.specs --specs=nosys.specs)
- target_include_directories(${target}.elf PRIVATE ${INCLUDES})
- target_include_directories(${target}.elf PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
- set(blupgrade_compile_definitions BOOTLOADER_UPGRADE)
- if(development)
- list(APPEND blupgrade_compile_definitions BOOTLOADER_UPGRADE_DEVELOPMENT)
- endif()
- target_compile_definitions(${target}.elf PRIVATE
- ${product}
- "APP_U2F=${app_u2f}"
- BB02_STAGE1_TARGET_PRODUCT_ID=${target_product_id}
- ${blupgrade_compile_definitions}
- ${LVGL_DEFINITIONS}
- OPTIGA_LIB_EXTERNAL="optiga_config.h"
- )
- target_sources(${target}.elf PRIVATE ${PLATFORM-BITBOX02-SOURCES})
- if(${app_u2f} EQUAL 1)
- target_sources(${target}.elf PRIVATE ${FIRMWARE-U2F-SOURCES} ${FIRMWARE-U2F-DRIVER-SOURCES})
+ if(EMBED_STAGE1)
+ string(TOUPPER ${PRODUCT} product_upper)
+ set(product_id_prefix BB02_STAGE1_PRODUCT_ID_BITBOX)
+ if(PRODUCT STREQUAL "bitbox02nova")
+ set(product_id_prefix BB02_STAGE1_PRODUCT_ID_BITBOX_PLUS)
endif()
- if(NOT development)
- target_sources(${target}.elf PRIVATE
- ${CMAKE_SOURCE_DIR}/src/bootloader_upgrade/stage1_pubkeys.c
- ${CMAKE_SOURCE_DIR}/src/bootloader/stage0/stage1_sigcheck.c
- ${CMAKE_SOURCE_DIR}/src/pukcc/pukcc.c
- ${CMAKE_SOURCE_DIR}/src/pukcc/curve_p256.c
+ foreach(edition multi btconly)
+ set(target firmware.elf)
+ if(edition STREQUAL "btconly")
+ set(target firmware-btc.elf)
+ endif()
+ string(TOUPPER ${edition} edition_upper)
+ set(asset_prefix BB02_BLUPD_${product_upper}_${edition_upper})
+ if(DEVELOPMENT)
+ string(APPEND asset_prefix _DEVELOPMENT)
+ target_compile_definitions(${target} PRIVATE BOOTLOADER_UPGRADE_DEVELOPMENT)
+ endif()
+ target_sources(${target} PRIVATE
+ bootloader_upgrade/firmware_installer_check.c
+ bootloader_upgrade/firmware_installer.c
+ ${${asset_prefix}_STAGE0_IMAGE_OBJ}
+ ${${asset_prefix}_PAYLOAD_OBJ}
+ ${PLATFORM-BITBOX02-SOURCES}
)
- endif()
- add_custom_command(
- TARGET ${target}.elf POST_BUILD
- COMMAND ${CMAKE_SIZE} ${target}.elf
- COMMAND ${CMAKE_OBJCOPY} -O binary ${target}.elf ${target}.bin
- WORKING_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
- COMMENT "\nGenerating binary ${target}.bin"
- )
- endfunction()
-
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02-btconly
- firmware-btc_rust_c
- PRODUCT_BITBOX_BTCONLY
- 0
- BB02_STAGE1_PRODUCT_ID_BITBOX_BTCONLY
- ${BB02_BLUPD_BITBOX02_BTCONLY_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02_BTCONLY_PAYLOAD_OBJ}
- FALSE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02-multi
- firmware_rust_c
- PRODUCT_BITBOX_MULTI
- 1
- BB02_STAGE1_PRODUCT_ID_BITBOX_MULTI
- ${BB02_BLUPD_BITBOX02_MULTI_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02_MULTI_PAYLOAD_OBJ}
- FALSE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02nova-btconly
- firmware-btc_rust_c
- PRODUCT_BITBOX_BTCONLY
- 0
- BB02_STAGE1_PRODUCT_ID_BITBOX_PLUS_BTCONLY
- ${BB02_BLUPD_BITBOX02NOVA_BTCONLY_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02NOVA_BTCONLY_PAYLOAD_OBJ}
- FALSE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02nova-multi
- firmware_rust_c
- PRODUCT_BITBOX_MULTI
- 1
- BB02_STAGE1_PRODUCT_ID_BITBOX_PLUS_MULTI
- ${BB02_BLUPD_BITBOX02NOVA_MULTI_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02NOVA_MULTI_PAYLOAD_OBJ}
- FALSE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02-btconly-development
- firmware-btc_rust_c
- PRODUCT_BITBOX_BTCONLY
- 0
- BB02_STAGE1_PRODUCT_ID_BITBOX_BTCONLY
- ${BB02_BLUPD_BITBOX02_BTCONLY_DEVELOPMENT_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02_BTCONLY_DEVELOPMENT_PAYLOAD_OBJ}
- TRUE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02-multi-development
- firmware_rust_c
- PRODUCT_BITBOX_MULTI
- 1
- BB02_STAGE1_PRODUCT_ID_BITBOX_MULTI
- ${BB02_BLUPD_BITBOX02_MULTI_DEVELOPMENT_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02_MULTI_DEVELOPMENT_PAYLOAD_OBJ}
- TRUE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02nova-btconly-development
- firmware-btc_rust_c
- PRODUCT_BITBOX_BTCONLY
- 0
- BB02_STAGE1_PRODUCT_ID_BITBOX_PLUS_BTCONLY
- ${BB02_BLUPD_BITBOX02NOVA_BTCONLY_DEVELOPMENT_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02NOVA_BTCONLY_DEVELOPMENT_PAYLOAD_OBJ}
- TRUE)
- add_bb02_blupgrade_firmware(
- firmware-blupgrade-bitbox02nova-multi-development
- firmware_rust_c
- PRODUCT_BITBOX_MULTI
- 1
- BB02_STAGE1_PRODUCT_ID_BITBOX_PLUS_MULTI
- ${BB02_BLUPD_BITBOX02NOVA_MULTI_DEVELOPMENT_STAGE0_IMAGE_OBJ}
- ${BB02_BLUPD_BITBOX02NOVA_MULTI_DEVELOPMENT_PAYLOAD_OBJ}
- TRUE)
+ if(edition STREQUAL "multi")
+ target_sources(${target} PRIVATE ${FIRMWARE-U2F-SOURCES} ${FIRMWARE-U2F-DRIVER-SOURCES})
+ endif()
+ if(NOT DEVELOPMENT)
+ target_sources(${target} PRIVATE
+ bootloader_upgrade/stage1_pubkeys.c
+ bootloader/stage0/stage1_sigcheck.c
+ pukcc/pukcc.c
+ pukcc/curve_p256.c
+ )
+ endif()
+ target_compile_definitions(${target} PRIVATE
+ BOOTLOADER_UPGRADE
+ BB02_STAGE1_TARGET_PRODUCT_ID=${product_id_prefix}_${edition_upper}
+ )
+ endforeach()
+ else()
+ target_sources(firmware.elf PRIVATE ${FIRMWARE-U2F-SOURCES} ${FIRMWARE-U2F-DRIVER-SOURCES} ${PLATFORM-BITBOX02-SOURCES})
+ target_sources(firmware-btc.elf PRIVATE ${PLATFORM-BITBOX02-SOURCES})
+ endif()
# Copy the binary file to the output directory because the symbol names in
# the object file depend on the path to the binary file
### test/scripts/test_build_config.py
@@ -88,6 +88,34 @@ def test_unlocked_non_development_rejected(self) -> None:
with self.assertRaisesRegex(ValueError, "DEVELOPMENT=no requires LOCKED=yes"):
build_config.image_info(config, image)
+ def test_embed_stage1_config_roundtrip(self) -> None:
+ parser = argparse.ArgumentParser()
+ build_config.add_config_arguments(parser)
+ self.assertEqual(build_config.from_args(parser.parse_args([])).embed_stage1, "no")
+ for product in ("bitbox02", "bitbox02nova"):
+ for embed_stage1 in ("no", "yes"):
+ with self.subTest(product=product, embed_stage1=embed_stage1):
+ config = build_config.from_args(
+ parser.parse_args(["--product", product, "--embed-stage1", embed_stage1])
+ )
+ with tempfile.TemporaryDirectory() as directory:
+ path = Path(directory) / "config.mk"
+ build_config.save_config(path, config)
+ saved = build_config.read_config(path)
+ self.assertEqual(saved["EMBED_STAGE1"], embed_stage1)
+ with patch("builtins.input", return_value=""), contextlib.redirect_stdout(
+ io.StringIO()
+ ):
+ self.assertEqual(build_config.interactive(saved), config)
+ for edition in build_config.EDITIONS:
+ configured = replace(config, edition=edition)
+ self.assertEqual(
+ build_config.image_info(configured, "firmware"),
+ build_config.image_info(
+ replace(configured, embed_stage1="no"), "firmware"
+ ),
+ )
+
def test_invalid_flags_preserve_saved_config(self) -> None:
with tempfile.TemporaryDirectory() as directory:
path = Path(directory) / "config.mk"
@@ -97,6 +125,7 @@ def test_invalid_flags_preserve_saved_config(self) -> None:
replace(build_config.Config(), locked="invalid"),
replace(build_config.Config(), development="invalid"),
replace(build_config.Config(), development="no"),
+ replace(build_config.Config(), embed_stage1="invalid"),
):
with self.subTest(config=config), self.assertRaises(ValueError):
build_config.save_config(path, config)
@@ -105,20 +134,24 @@ def test_invalid_flags_preserve_saved_config(self) -> None:
def test_interactive_unlock_requires_development(self) -> None:
saved = {"LOCKED": "yes", "DEVELOPMENT": "no"}
with patch(
- "builtins.input", side_effect=["", "", "", "no", "", ""]
+ "builtins.input", side_effect=["", "", "", "no", "", "", ""]
), contextlib.redirect_stdout(io.StringIO()):
config = build_config.interactive(saved)
self.assertEqual((config.locked, config.development), ("no", "yes"))
def test_bitbox03_rejects_unimplemented_modes(self) -> None:
base = build_config.defaults("bitbox03")
base.validate()
- for config in (replace(base, locked="yes"), replace(base, development="no")):
+ for config in (
+ replace(base, locked="yes"),
+ replace(base, development="no"),
+ replace(base, embed_stage1="yes"),
+ ):
with self.assertRaisesRegex(ValueError, "not implemented for BitBox03"):
config.validate()
def test_interactive_product_change_resets_unsupported_modes(self) -> None:
- saved = {"LOCKED": "yes", "DEVELOPMENT": "no"}
+ saved = {"LOCKED": "yes", "DEVELOPMENT": "no", "EMBED_STAGE1": "yes"}
with patch(
"builtins.input", side_effect=["bitbox03", "", "", "", ""]
), contextlib.redirect_stdout(io.StringIO()):Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.