https://github.com/nitrokey/nitrokey-3-firmware
Nitrokey 3 firmware
https://github.com/nitrokey/nitrokey-3-firmware
Last synced: about 1 year ago
JSON representation
Nitrokey 3 firmware
- Host: GitHub
- URL: https://github.com/nitrokey/nitrokey-3-firmware
- Owner: Nitrokey
- License: apache-2.0
- Created: 2021-05-11T14:29:40.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T10:31:33.000Z (over 1 year ago)
- Last Synced: 2025-03-28T05:39:59.357Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 5.17 MB
- Stars: 275
- Watchers: 16
- Forks: 27
- Open Issues: 82
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Nitrokey 3 Firmware
This repository contains the firmware of Nitrokey 3 USB keys.
## About
The Nitrokey 3 firmware is written in [Rust][]. It uses the [Trussed][] firmware framework and is developed in collaboration with [SoloKeys][] (see the [solo2][] repository).
[Rust]: https://rust-lang.org
[Trussed]: https://trussed.dev/
[SoloKeys]: https://solokeys.com/
[solo2]: https://github.com/solokeys/solo2
## Documentation
Documentation for users is available in the [Nitrokey 3 section on docs.nitrokey.com][docs.nitrokey.com]. For developer documentation, see the [`docs`](./docs/index.md) directory.
[docs.nitrokey.com]: https://docs.nitrokey.com/nitrokey3/index.html
## Dependencies
To build the firmware from source, you need these dependencies:
- Rust (current stable release for the `thumbv8m.main-none-eabi` target with the `llvm-tools-preview` component)
- clang with development headers
- [`flip-link`][]
- [`cargo-binutils`][]
[`flip-link`]: https://github.com/knurling-rs/flip-link
[`cargo-binutils`]: https://github.com/rust-embedded/cargo-binutils
To flash the firmware to the device, you need [`mboot`][] or [`lpc55`][].
[`mboot`]: https://github.com/molejar/pyMBoot
[`lpc55`]: https://github.com/lpc55/lpc55-host
## License
This software is fully open source.
All software, unless otherwise noted, is dual licensed under [Apache 2.0](LICENSE-APACHE) and [MIT](LICENSE-MIT).
You may use the 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.
## Funding
[
](https://nlnet.nl/)
[
](https://nlnet.nl/NGI0/)
This project was funded through the [NGI0 PET](https://nlnet.nl/PET) Fund, a fund established by [NLnet](https://nlnet.nl/) with financial support from the European Commission's [Next Generation Internet programme](https://ngi.eu/), under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825310.