Conor Patrick
e1f040d30f
- Add AGENTS.md with build, flash, and test guidance - Extract PC runner platform types into library for test reuse - Add fido2 integration tests: GetInfo, MakeCredential, GetAssertion, Reset, reboot persistence, and user presence (approve/deny) - Table-driven test architecture with per-module organization - Feature-gated user presence control (test-up-control): - PC runner: shared atomic read by check_user_presence() - LPC55: probe-rs-writable static at known address (UP_CONTROL) - Unified UP control module: same API for both backends, selected by UP_BACKEND env var - USB HID CTAPHID client for device transport - Transport abstraction: in-process or USB HID - Vendored fido-authenticator with fast-button-timeout feature (5s vs 30s) - Makefile: `make test` (PC), `make test-lpcxpresso55` (device) All 31 tests pass against both PC runner and LPC55S69 hardware.
🐝 SoloKeys Solo 2 monorepo.
This repository contains the "runner" for the firmware on Solo 2 devices.
Please note that many components have been contributed to the Trussed GitHub Organization:
- Framework: https://github.com/trussed-dev/trussed
- FIDO Authenticator: https://github.com/trussed-dev/fido-authenticator
- PIV Authenticator: https://github.com/trussed-dev/piv-authenticator
Such code is co-maintained with Nitrokey, who have contributed extensions and other improvements.
We plan to release a new version of the firmware, incorporating these changes.
Support
For support with purchased devices, please reach out to hello@solokeys.com.
To repeat: Please do not open issues/PRs that are not technical issues / firmware bugs.
Getting Started
Prerequisites
-
Install Rust and Cargo for your system.
-
Install dependencies such as clang, llvm, probe-rs, flip-link
-
Get and prepare hardware
-
Run
make build-dev.
For more information: https://hackmd.io/@solokeys/solo2-getting-started. Please do not send PRs to expand on getting started generalities, just edit the linked HackMD directly.
Boards
Head to runnners/lpc55/board for an overview on the possible embedded platforms the firmware currently supports.
Compiling
Head to runners/lpc55 to get started, and try make build-dev, which compiles
the entire firmware bundle using features convenient for getting started.
With make run-dev, it will try to connect to a GDB server to flash and run the firmware.
One way to run a GDB server is JLinkGDBServer -strict -device LPC55S69 -if SWD -vd
To enable logs, you can change the feature flags on each crate. Then logs will be output via semihosting to your SWD debugger.
# Enable logs on the root crate and a few of the local crate dependencies.
cargo run --release --features board-lpcxpresso55,log-all,fido-authenticator/log-all,ctaphid-dispatch/log-info,ctap-types/log-all
License
Solo is fully open source.
All software, unless otherwise noted, is dual licensed under Apache 2.0 and MIT. You may use Solo software under the terms of either the Apache 2.0 license or MIT license.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
All hardware, unless otherwise noted, is licensed under CERN-OHL-S. You may use Solo hardware under the terms of the CERN-OHL-S license.
All documentation, unless otherwise noted, is licensed under CC-BY-SA. You may use Solo documentation under the terms of the CC-BY-SA 4.0 license.