Mirrors/trezor-firmware
2
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2026-02-19 16:22:44 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
trezor-firmware/build-docker.sh
Roman Zeyde 3c3a9ee627 build(core): make sure uv.lock is up-to-date 
[no changelog]
2026-01-05 19:06:28 +01:00

511 lines
15 KiB
Bash
Executable File
Raw Permalink Blame History

#!/usr/bin/env bash
set -e -o pipefail
cd "$(dirname "${BASH_SOURCE[0]}")"
############## Select the right Alpine architecture ##############
if [ -z "$ALPINE_ARCH" ]; then
arch="$(uname -m)"
case "$arch" in
aarch64|arm64)
ALPINE_ARCH="aarch64"
;;
x86_64)
ALPINE_ARCH="x86_64"
;;
*)
echo "Unsupported arch"
exit
esac
fi
if [ -z "$ALPINE_CHECKSUM" ]; then
case "$ALPINE_ARCH" in
aarch64)
ALPINE_CHECKSUM="1be50ae27c8463d005c4de16558d239e11a88ac6b2f8721c47e660fbeead69bf"
;;
x86_64)
ALPINE_CHECKSUM="ec7ec80a96500f13c189a6125f2dbe8600ef593b87fc4670fe959dc02db727a2"
;;
*)
exit
esac
fi
DOCKER=${DOCKER:-docker}
CONTAINER_NAME=${CONTAINER_NAME:-trezor-firmware-env.nix}
ALPINE_CDN=${ALPINE_CDN:-https://dl-cdn.alpinelinux.org/alpine}
ALPINE_RELEASE=${ALPINE_RELEASE:-3.15}
ALPINE_VERSION=${ALPINE_VERSION:-3.15.0}
ALPINE_TARBALL=${ALPINE_FILE:-alpine-minirootfs-$ALPINE_VERSION-$ALPINE_ARCH.tar.gz}
NIX_VERSION=${NIX_VERSION:-2.4}
CONTAINER_FS_URL=${CONTAINER_FS_URL:-"$ALPINE_CDN/v$ALPINE_RELEASE/releases/$ALPINE_ARCH/$ALPINE_TARBALL"}
############## Options parsing ##############
function help_and_die() {
echo "Usage: $0 [options] tag"
echo "Options:"
echo " --skip-bitcoinonly - do not build bitcoin-only firmwares"
echo " --skip-normal - do not build regular firmwares"
echo " --repository path/to/repo - checkout the repository from the given path/url"
echo " --no-init - do not recreate docker environments"
echo " --models - comma-separated list of models. default: --models T1B1,T2B1,T2T1,T3T1,T3W1"
echo " --targets - comma-separated list of targets for core build. default: --targets boardloader,bootloader,secmon,firmware"
echo " --nrf - build nRF bootloader and firmware (for bluetooth devices, i.e. T3W1)"
echo " --help"
echo
echo "Option --prodtest is deprecated. Use "--targets prodtest" to build prodtest."
echo "Set PRODUCTION=0 to run non-production builds."
echo "Set VENDOR_HEADER=vendorheader_prodtest_unsigned.bin to use the specified vendor header for prodtest."
exit 0
}
OPT_BUILD_NORMAL=1
OPT_BUILD_BITCOINONLY=1
OPT_BUILD_NRF=0
INIT=1
MODELS=(T1B1 T2B1 T2T1 T3T1 T3W1)
CORE_TARGETS=(boardloader bootloader secmon firmware)
REPOSITORY="file:///local"
while true; do
case "$1" in
-h|--help)
help_and_die
;;
--skip-bitcoinonly)
OPT_BUILD_BITCOINONLY=0
shift
;;
--skip-normal)
OPT_BUILD_NORMAL=0
shift
;;
--repository)
REPOSITORY="$2"
shift 2
;;
--no-init)
INIT=0
shift
;;
--models)
# take comma-separated next argument and turn it into an array
IFS=',' read -r -a MODELS <<< "$2"
shift 2
;;
--targets)
# take comma-separated next argument and turn it into an array
IFS=',' read -r -a CORE_TARGETS <<< "$2"
shift 2
;;
--nrf)
OPT_BUILD_NRF=1
shift
;;
*)
break
;;
esac
done
if [ -z "$1" ]; then
help_and_die
fi
################## Variant selection ##################
variants=()
if [ "$OPT_BUILD_NORMAL" -eq 1 ]; then
variants+=(0)
fi
if [ "$OPT_BUILD_BITCOINONLY" -eq 1 ]; then
variants+=(1)
fi
VARIANTS=("${variants[@]}")
TAG="$1"
COMMIT_HASH="$(git rev-parse "$TAG")"
PRODUCTION=${PRODUCTION:-1}
if which wget > /dev/null ; then
wget --no-verbose --no-config -nc -P ci/ "$CONTAINER_FS_URL"
else
if ! [ -f "ci/$ALPINE_TARBALL" ]; then
curl --no-progress-meter -L -o "ci/$ALPINE_TARBALL" "$CONTAINER_FS_URL"
fi
fi
# check alpine checksum
if command -v shasum &> /dev/null ; then
echo "${ALPINE_CHECKSUM} ci/${ALPINE_TARBALL}" | shasum -a 256 -c
else
echo "${ALPINE_CHECKSUM} ci/${ALPINE_TARBALL}" | sha256sum -c
fi
tag_clean="${TAG//[^a-zA-Z0-9]/_}"
SNAPSHOT_NAME="${CONTAINER_NAME}__${tag_clean}"
mkdir -p build/core build/legacy
mkdir -p build/core-bitcoinonly build/legacy-bitcoinonly
# if not initializing, does the image exist?
if [ $INIT -eq 0 ] && ! $DOCKER image inspect $SNAPSHOT_NAME > /dev/null; then
echo "Image $SNAPSHOT_NAME does not exist."
exit 1
fi
GIT_CLEAN_REPO="git clean -dfx -e .venv"
SCRIPT_NAME="._setup_script"
if [ $INIT -eq 1 ]; then
SELECTED_CONTAINER="$CONTAINER_NAME"
echo
echo ">>> DOCKER BUILD ALPINE_VERSION=$ALPINE_VERSION ALPINE_ARCH=$ALPINE_ARCH NIX_VERSION=$NIX_VERSION -t $CONTAINER_NAME"
echo
# some Nix installations have problem with shell.nix -> ci/shell.nix symlink
# docker can't handle ci/shell.nix -> shell.nix
# let's copy the file and try to fix paths ...
sed "s|./ci/|./|" < shell.nix > ci/shell.nix
$DOCKER build \
--network=host \
--build-arg ALPINE_VERSION="$ALPINE_VERSION" \
--build-arg ALPINE_ARCH="$ALPINE_ARCH" \
--build-arg NIX_VERSION="$NIX_VERSION" \
-t "$CONTAINER_NAME" \
ci/
cat <<EOF > "$SCRIPT_NAME"
#!/bin/bash
set -e -o pipefail
mkdir -p /reproducible-build
cd /reproducible-build
# ignore ownership of the local repo
git config --global --add safe.directory /local/.git
git clone --branch="$TAG" --depth=1 "$REPOSITORY" trezor-firmware
cd trezor-firmware
EOF
else # init == 0
SELECTED_CONTAINER="$SNAPSHOT_NAME"
cat <<EOF > "$SCRIPT_NAME"
#!/bin/bash
set -e -o pipefail
cd /reproducible-build/trezor-firmware
EOF
fi # init
# append common part to script
cat <<EOF >> "$SCRIPT_NAME"
$GIT_CLEAN_REPO
git submodule update --init --recursive
uv sync --locked
cd core/embed/rust
cargo fetch
echo
echo ">>> AT COMMIT \$(git rev-parse HEAD)"
echo
EOF
echo
echo ">>> DOCKER REFRESH $SNAPSHOT_NAME"
echo
$DOCKER run \
--network=host \
-v "$PWD:/local" \
-v "$PWD/build:/build" \
--name "$SNAPSHOT_NAME" \
"$SELECTED_CONTAINER" \
/nix/var/nix/profiles/default/bin/nix-shell --run "bash /local/$SCRIPT_NAME" \
|| ($DOCKER rm "$SNAPSHOT_NAME"; exit 1)
rm $SCRIPT_NAME
echo
echo ">>> DOCKER COMMIT $SNAPSHOT_NAME"
echo
$DOCKER commit "$SNAPSHOT_NAME" "$SNAPSHOT_NAME"
$DOCKER rm "$SNAPSHOT_NAME"
# stat under macOS has slightly different cli interface
USER=$(stat -c "%u" . 2>/dev/null || stat -f "%u" .)
GROUP=$(stat -c "%g" . 2>/dev/null || stat -f "%g" .)
DIR=$(pwd)
# build core
for TREZOR_MODEL in ${MODELS[@]}; do
if [ "$TREZOR_MODEL" = "T1B1" ]; then
continue
fi
for BITCOIN_ONLY in ${VARIANTS[@]}; do
DIRSUFFIX=${BITCOIN_ONLY/1/-bitcoinonly}
DIRSUFFIX=${DIRSUFFIX/0/}
DIRSUFFIX="-${TREZOR_MODEL}${DIRSUFFIX}"
MAKE_TARGETS=""
for TARGET in ${CORE_TARGETS[@]}; do
MAKE_TARGETS="$MAKE_TARGETS build_$TARGET"
done
SCRIPT_NAME=".build_core_${TREZOR_MODEL}_${BITCOIN_ONLY}.sh"
cat <<EOF > "build/$SCRIPT_NAME"
# DO NOT MODIFY!
# this file was generated by ${BASH_SOURCE[0]}
# variant: core build BITCOIN_ONLY=$BITCOIN_ONLY TREZOR_MODEL=$TREZOR_MODEL
set -e -o pipefail
cd /reproducible-build/trezor-firmware/core
$GIT_CLEAN_REPO
rm -rf /build/*
uv run make clean vendor $MAKE_TARGETS QUIET_MODE=1
for item in bootloader secmon firmware prodtest; do
if [ -s build/\$item/\$item.bin ]; then
uv run ../python/tools/firmware-fingerprint.py \
-o build/\$item/\$item.bin.fingerprint \
build/\$item/\$item.bin
# copy only the artifacts to the build output directory
mkdir /build/\$item/
cp -v build/\$item/\$item* /build/\$item/
fi
done
chown -R $USER:$GROUP /build
EOF
echo
echo ">>> DOCKER RUN core BITCOIN_ONLY=$BITCOIN_ONLY TREZOR_MODEL=$TREZOR_MODEL PRODUCTION=$PRODUCTION"
echo " (targets: ${CORE_TARGETS[@]})"
echo
$DOCKER run \
--network=host \
--rm \
-v "$DIR:/local" \
-v "$DIR/build/core$DIRSUFFIX":/build:z \
--env BITCOIN_ONLY="$BITCOIN_ONLY" \
--env TREZOR_MODEL="$TREZOR_MODEL" \
--env PRODUCTION="$PRODUCTION" \
--env VENDOR_HEADER="$VENDOR_HEADER" \
--init \
"$SNAPSHOT_NAME" \
/nix/var/nix/profiles/default/bin/nix-shell --run "bash /local/build/$SCRIPT_NAME"
done
done
# build nRF bootloader and firmware
if [ "$OPT_BUILD_NRF" -eq 1 ]; then
SCRIPT_NAME=".build_nrf.sh"
cat <<EOF > "build/$SCRIPT_NAME"
# DO NOT MODIFY!
# this file was generated by ${BASH_SOURCE[0]}
# variant: nrf build
set -e -o pipefail
echo "=== Toolchain Debug Info ==="
echo "ZEPHYR_TOOLCHAIN_VARIANT: \$ZEPHYR_TOOLCHAIN_VARIANT"
echo "GNUARMEMB_TOOLCHAIN_PATH: \$GNUARMEMB_TOOLCHAIN_PATH"
echo "ARM GCC location: \$(which arm-none-eabi-gcc)"
echo "ARM GCC version: \$(arm-none-eabi-gcc --version | head -1)"
# Initialize west workspace
echo "=== cleaning git repo ==="
cd /reproducible-build/trezor-firmware/nordic/trezor
$GIT_CLEAN_REPO
echo "=== west initializing workspace ==="
cd /reproducible-build/trezor-firmware/nordic
uv run west init -l ./trezor || echo "West already initialized"
echo "=== west update ==="
uv run west update
# Build using the script
echo "=== running build_sign_flash ==="
cd /reproducible-build/trezor-firmware/nordic/trezor
if [ "$PRODUCTION" = "1" ]; then
uv run scripts/build_sign_flash.sh -b t3w1_revA_nrf52832 -p -c -s
else
uv run scripts/build_sign_flash.sh -b t3w1_revA_nrf52832 -d -c -s
fi
# Generate fingerprints
echo "=== Generating fingerprints for nrf binary files ==="
cd /reproducible-build/trezor-firmware/nordic/trezor
# Generate fingerprint for bootloader
if [ -f "build/mcuboot/zephyr/zephyr.bin" ]; then
echo "Generating fingerprint for: build/mcuboot/zephyr/zephyr.bin"
sha256sum "build/mcuboot/zephyr/zephyr.bin" | cut -d' ' -f1 > "build/mcuboot/zephyr/zephyr.bin.fingerprint"
echo "Created: build/mcuboot/zephyr/zephyr.bin.fingerprint"
else
echo "File not found: build/mcuboot/zephyr/zephyr.bin"
fi
# Generate fingerprint for firmware
if [ -f "build/trezor-ble/zephyr/zephyr.signed_trz.bin" ]; then
echo "Generating fingerprint for: build/trezor-ble/zephyr/zephyr.signed_trz.bin"
sha256sum "build/trezor-ble/zephyr/zephyr.signed_trz.bin" | cut -d' ' -f1 > "build/trezor-ble/zephyr/zephyr.signed_trz.bin.fingerprint"
echo "Created: build/trezor-ble/zephyr/zephyr.signed_trz.bin.fingerprint"
else
echo "File not found: build/trezor-ble/zephyr/zephyr.signed_trz.bin"
fi
# Create output directory structure and copy artifacts
echo "=== Copy built files back to host ==="
mkdir -p /build/bootloader /build/firmware
cd /reproducible-build/trezor-firmware/nordic/trezor
# Copy nRF bootloader (MCUboot)
if [ -f build/mcuboot/zephyr/zephyr.hex ]; then
cp build/mcuboot/zephyr/zephyr.hex /build/bootloader/nrf-bootloader.hex
cp build/mcuboot/zephyr/zephyr.bin /build/bootloader/nrf-bootloader.bin
cp build/mcuboot/zephyr/zephyr.bin.fingerprint /build/bootloader/nrf-bootloader.bin.fingerprint 2>/dev/null || true
fi
# Copy signed nRF application firmware
if [ -f build/trezor-ble/zephyr/zephyr.signed_trz.hex ]; then
cp build/trezor-ble/zephyr/zephyr.signed_trz.hex /build/firmware/nrf-firmware.hex
cp build/trezor-ble/zephyr/zephyr.signed_trz.bin /build/firmware/nrf-firmware.bin
cp build/trezor-ble/zephyr/zephyr.signed_trz.bin.fingerprint /build/firmware/nrf-firmware.bin.fingerprint 2>/dev/null || true
fi
# Copy nRF ELF file (from unsigned build)
if [ -f build/trezor-ble/zephyr/zephyr.elf ]; then
cp build/trezor-ble/zephyr/zephyr.elf /build/firmware/nrf-firmware.elf
fi
# Copy merged signed nRF firmware
if [ -f build/zephyr.merged.signed_trz.hex ]; then
cp build/zephyr.merged.signed_trz.hex /build/firmware/nrf-firmware.merged.hex
fi
echo "=== NRF repro build DONE ==="
chown -R $USER:$GROUP /build
EOF
echo
echo ">>> DOCKER RUN nrf PRODUCTION=$PRODUCTION"
echo
$DOCKER run \
--network=host \
--rm \
-v "$DIR:/local" \
-v "$DIR/build/nrf":/build:z \
--env PRODUCTION="$PRODUCTION" \
--env TREZOR_FIRMWARE_ACCEPT_JLINK_LICENSE="yes" \
--env ZEPHYR_TOOLCHAIN_VARIANT="gnuarmemb" \
--env GNUARMEMB_TOOLCHAIN_PATH="/nix/store/n6qhvpsx5ldqazhmx5lc9lyjdbmq8zj2-gcc-arm-embedded-13.3.rel1" \
--init \
"$SNAPSHOT_NAME" \
/nix/var/nix/profiles/default/bin/nix-shell --arg devTools true --run "bash /local/build/$SCRIPT_NAME"
fi
# build legacy
if echo "${MODELS[@]}" | grep -q T1B1 ; then
for BITCOIN_ONLY in ${VARIANTS[@]}; do
DIRSUFFIX=${BITCOIN_ONLY/1/-bitcoinonly}
DIRSUFFIX=${DIRSUFFIX/0/}
DIRSUFFIX="-T1B1${DIRSUFFIX}"
SCRIPT_NAME=".build_legacy_$BITCOIN_ONLY.sh"
cat <<EOF > "build/$SCRIPT_NAME"
# DO NOT MODIFY!
# this file was generated by ${BASH_SOURCE[0]}
# variant: legacy build BITCOIN_ONLY=$BITCOIN_ONLY
set -e -o pipefail
cd /reproducible-build/trezor-firmware/legacy
$GIT_CLEAN_REPO
ln -s /build build
uv run script/cibuild
mkdir -p build/bootloader build/firmware build/intermediate_fw
cp bootloader/bootloader.bin build/bootloader/bootloader.bin
cp intermediate_fw/trezor.bin build/intermediate_fw/inter.bin
cp firmware/trezor.bin build/firmware/firmware.bin
cp firmware/firmware*.bin build/firmware/ || true # ignore missing file as it will not be present in old tags
cp firmware/trezor.elf build/firmware/firmware.elf
uv run ../python/tools/firmware-fingerprint.py \
-o build/firmware/firmware.bin.fingerprint \
build/firmware/firmware.bin
chown -R $USER:$GROUP /build
EOF
echo
echo ">>> DOCKER RUN legacy BITCOIN_ONLY=$BITCOIN_ONLY PRODUCTION=$PRODUCTION"
echo
$DOCKER run \
--network=host \
--rm \
-v "$DIR:/local" \
-v "$DIR/build/legacy$DIRSUFFIX":/build:z \
--env BITCOIN_ONLY="$BITCOIN_ONLY" \
--env PRODUCTION="$PRODUCTION" \
--init \
"$SNAPSHOT_NAME" \
/nix/var/nix/profiles/default/bin/nix-shell --run "bash /local/build/$SCRIPT_NAME"
done
fi
echo
echo "Docker image retained as $SNAPSHOT_NAME"
echo "To remove it, run:"
echo " docker rmi $SNAPSHOT_NAME"
# all built, show fingerprints
echo
echo "Built from commit $COMMIT_HASH"
echo
echo "Fingerprints:"
# Display core and legacy fingerprints (if built)
for VARIANT in core legacy; do
for MODEL in ${MODELS[@]}; do
for DIRSUFFIX in "" "-bitcoinonly"; do
BUILD_DIR=build/${VARIANT}-${MODEL}${DIRSUFFIX}
for file in $BUILD_DIR/*/*.fingerprint; do
if [ -f "$file" ]; then
origfile="${file%.fingerprint}"
fingerprint=$(tr -d '\n' < $file)
echo "$fingerprint $origfile"
fi
done
done
done
done
# Display nRF fingerprints (if built)
if [ "$OPT_BUILD_NRF" -eq 1 ]; then
NRF_BUILD_DIR=build/nrf
if [ -d "$NRF_BUILD_DIR" ]; then
for file in $NRF_BUILD_DIR/firmware/*.fingerprint $NRF_BUILD_DIR/bootloader/*.fingerprint; do
if [ -f "$file" ]; then
origfile="${file%.fingerprint}"
fingerprint=$(tr -d '\n' < "$file")
echo "$fingerprint $origfile"
fi
done
fi
fi
Reference in New Issue View Git Blame Copy Permalink