What the developer wrote
Authored by ww3512687
update verify doc
What changed, and why it matters
This commit only updates a documentation file (docs/verify.md) that explains how users can build and verify the firmware. It adds instructions for a new 'Cypherpunk' firmware variant and corrects the filename used in verification steps from 'mh1903.bin' to 'mh1903_full.bin'. There are no code changes and no security fix or vulnerability introduced.
No security action required. Review the documentation changes for accuracy if desired.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is limited to Markdown documentation. It adds a build command for the cypherpunk firmware target and updates references to the firmware artifact produced by the build from ‘mh1903.bin’ to ‘mh1903_full.bin’ in the verification workflow. No source code, build scripts, cryptographic logic, or device firmware is modified.
Changed components
docs/verify.mdInspect captured patch +9 / −3
diff --git a/docs/verify.md b/docs/verify.md
index df8cf4b..4a8984e 100644
--- a/docs/verify.md
+++ b/docs/verify.md
@@ -76,7 +76,13 @@ docker run -v $(pwd):/keystone3-firmware keystonehq/keystone3_baker:1.0.2 python
docker run -v $(pwd):/keystone3-firmware keystonehq/keystone3_baker:1.0.2 python3 build.py -e production -t btc_only
```
-**Note:** This step compiles the source into the `mh1903.bin` file.
+**For Cypherpunk Firmware**:
+
+```bash
+docker run -v $(pwd):/keystone3-firmware keystonehq/keystone3_baker:1.0.2 python3 build.py -e production -t cypherpunk
+```
+
+**Note:** This step compiles the source into the `mh1903.bin`(firmware) and `mh1903_full.bin`(padded image with update metadata).
### 5. Verify the Firmware Checksum
@@ -91,14 +97,14 @@ sha256sum mh1903.bin
**Further Steps:** Compare the generated hash with the display on your device. For detailed instructions, refer [here](https://guide.keyst.one/docs/verify-checksum). To understand the checksum calculation on the device, see the code [here](https://github.com/KeystoneHQ/keystone3-firmware/blob/ce9e8e7e9bc33b46d420f9cfea4329b73426a7cd/src/ui/gui_model/gui_model.c#L1261).
## Optional: In-Depth Verification with Release Page
-Before delving into this section, it's important to understand some context. The firmware file available on our release page, named `keystone3.bin`, is derived from the `mh1903.bin` file. This transformation involves compressing the original file and adding our official signature for enhanced security and authenticity.
+Before delving into this section, it's important to understand some context. The firmware file available on our release page, named `keystone3.bin`, is derived from the `mh1903_full.bin` file. This transformation involves compressing the original file and adding our official signature for enhanced security and authenticity.
**Verification Steps:**
1. **Use the Firmware Maker:**
- Access the `firmware-maker` tool under `<ProjectRoot>/tools/code/firmware-maker`.
- Build it using `cargo build`.
- - Run `./fmm --source mh1903.bin --destination keystone3-unsigned.bin` to generate `keystone3-unsigned.bin`.
+ - Run `./fmm --source mh1903_full.bin --destination keystone3-unsigned.bin` to generate `keystone3-unsigned.bin`.
**Note**: The checksum of `keystone3-unsigned.bin` will differ from the official release due to the absence of our signature.
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.