1b70b558c6
Some checks failed
Checks on the Python tests / Call Ledger Python linters (push) Has been cancelled
Build and run functional tests using ragger through reusable workflow / Build application using the reusable workflow (push) Has been cancelled
Run coding style check / Check linting using the reusable workflow (push) Has been cancelled
Ensure compliance with Ledger guidelines / Call Ledger guidelines_enforcer (push) Has been cancelled
Misspellings checks / Check misspellings (push) Has been cancelled
Build and run functional tests using ragger through reusable workflow / Run standalone ragger tests using the reusable workflow (push) Has been cancelled
Hardware-wallet app for Handshake (HNS). Derives Handshake addresses and signs
Handshake transactions, including name-auction covenants, on Ledger Stax, Flex,
Nano S+, Nano X and Apex+.
The design premise is that the host computer is untrusted: every APDU byte is
attacker-controlled, and the device's job is to be correct when the host lies.
Two failures outrank all others, and the code is shaped around them.
Signing something other than what the user approved. Any field the signature
commits to and the host can vary has to appear on the review screen, and
anything the screen cannot represent honestly is refused rather than shown under
a label that does not describe it. So the device signs SIGHASH_ALL only,
checked per input rather than once for the session; it displays a TRANSFER
covenant's destination, which decides who ends up owning the name and appears
nowhere else in the output; it shows a covenant's name hash when the plaintext
name cannot be verified against it; and it refuses covenant kinds it cannot
name, outputs whose values exceed their inputs, and declared input totals that
would overflow the fee arithmetic.
Misusing key material. Derivation paths are constrained to
m/44'/{5353..5356}'/account'[/change/index] in the app itself, not only by the
install manifest, because BOLOS terminates the app on an out-of-whitelist path
instead of returning an error. One coin type per signing session, since the
review renders every address under a single HRP.
Panics count too: set_panic!(exiting_panic) means a panic kills the app and
strands the session, so nothing unwraps on host-derived data and the session
ceilings are sized to the configured heap.
Consensus follows shd, the Swift Handshake node, which is the reference for the
sighash preimage, covenant item layouts and address encoding.
SIGN_TX is a PSBT-style state machine driven by P1 (BEGIN / ADD_INPUT /
ADD_OUTPUT / REVIEW / SIGN_INPUT): the host streams the transaction as
structured records, the device accumulates its own view of the values, shows one
review, then signs each input on demand.
Tests run under speculos in a container (./scripts/test), 66 of them, green on
all five devices. test_sign_tx_policy.py covers each refusal above and needs no
golden snapshots because every case is rejected before anything is drawn; the
snapshots that do exist are the record of what the user sees before approving.
tests/application_client/handshake_sighash.py is a deliberately independent
reimplementation of the sighash, used to verify real signatures.
Status: v0.1, pre-audit. Not for mainnet keys. Signing has not yet been
exercised on physical hardware.
Forked from LedgerHQ/app-boilerplate-rust (Apache-2.0).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
71 lines
3.0 KiB
Bash
Executable File
71 lines
3.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Build the Handshake Ledger app for a given device, with all the macOS
|
|
# native-toolchain env wrangling that cargo-ledger and the secure SDK assume.
|
|
#
|
|
# Usage: ./scripts/build [stax|flex|nanox|nanosplus] (default: stax)
|
|
#
|
|
# Prerequisites (one-time setup):
|
|
# brew install --cask gcc-arm-embedded # ARM bare-metal toolchain
|
|
# brew install llvm # llvm-objcopy, llvm-nm
|
|
# cargo install --git https://github.com/LedgerHQ/cargo-ledger cargo-ledger
|
|
# cargo ledger setup # installs target.json files
|
|
# git clone --depth=1 --branch API_LEVEL_25 \
|
|
# https://github.com/LedgerHQ/ledger-secure-sdk ~/.ledger-sdk/secure-sdk-25
|
|
# # API level must match the device firmware:
|
|
# # Stax SE 1.9.1 → API_LEVEL_25.
|
|
# # If install fails with status 0x511f, you're probably on the wrong level:
|
|
# # re-clone the SDK at the matching API_LEVEL_NN branch and override
|
|
# # LEDGER_SDK_PATH for the build.
|
|
# python3 -m pip install --user --break-system-packages Pillow
|
|
# # Patch the rustup-installed link_wrap.sh to be macOS-portable:
|
|
# sed -i '' 's|stat -c %s|wc -c <|' \
|
|
# ~/.rustup/toolchains/$(rustup show active-toolchain | cut -d' ' -f1)/lib/rustlib/$(rustc -vV | sed -n 's/host: //p')/bin/link_wrap.sh
|
|
|
|
set -euo pipefail
|
|
|
|
DEVICE="${1:-stax}"
|
|
ARM_BIN="/Applications/ArmGNUToolchain/15.2.rel1/arm-none-eabi/bin"
|
|
LLVM_BIN="/opt/homebrew/opt/llvm/bin"
|
|
SDK="${LEDGER_SDK_PATH:-$HOME/.ledger-sdk/secure-sdk-25}"
|
|
|
|
if [[ ! -x "$ARM_BIN/arm-none-eabi-gcc" ]]; then
|
|
echo "ARM toolchain not found at $ARM_BIN: install with: brew install --cask gcc-arm-embedded"
|
|
exit 1
|
|
fi
|
|
if [[ ! -x "$LLVM_BIN/llvm-objcopy" ]]; then
|
|
echo "llvm-objcopy not found at $LLVM_BIN: install with: brew install llvm"
|
|
exit 1
|
|
fi
|
|
if [[ ! -f "$SDK/install_params.py" ]]; then
|
|
echo "BOLOS Secure SDK not found at $SDK: see prerequisites in this script"
|
|
exit 1
|
|
fi
|
|
|
|
# The Nano NBGL sources use `uint`, a BSD spelling that arm-none-eabi-gcc
|
|
# accepts and the clang this script drives does not, so nanosplus and nanox
|
|
# fail to compile out of the box. `uint32_t` is the right width for the two
|
|
# loop counters that use it (lib_nbgl/src/nbgl_use_case_nanos.c:373,1581).
|
|
EXTRA_CFLAGS=""
|
|
if [[ "$DEVICE" == "nanosplus" || "$DEVICE" == "nanox" ]]; then
|
|
EXTRA_CFLAGS="-Duint=uint32_t"
|
|
fi
|
|
|
|
PATH="$ARM_BIN:$LLVM_BIN:$PATH" \
|
|
LEDGER_SDK_PATH="$SDK" \
|
|
CFLAGS="${CFLAGS:-} $EXTRA_CFLAGS" \
|
|
cargo ledger build "$DEVICE" "${@:2}"
|
|
|
|
# cargo-ledger's post-build expects an Intel HEX next to the manifest but
|
|
# silently produces nothing on macOS: generate it from the ELF.
|
|
ELF="target/$DEVICE/release/app-handshake"
|
|
HEX="$ELF.hex"
|
|
if [[ -f "$ELF" && ( ! -f "$HEX" || "$ELF" -nt "$HEX" ) ]]; then
|
|
"$LLVM_BIN/llvm-objcopy" -O ihex "$ELF" "$HEX"
|
|
echo "wrote $HEX"
|
|
fi
|
|
|
|
# cargo-ledger also fails to write the ledgerctl manifest on macOS. Generate it
|
|
# from the ELF, so `dataSize` can never drift from the binary being installed:
|
|
# an undersized dataSize installs cleanly and then refuses to launch.
|
|
"$(dirname "$0")/gen-manifest" "$DEVICE"
|