b811958ed2
Differential Revision: https://phabricator.services.mozilla.com/D96 --HG-- extra : amend_source : 7f7bd7003aa4f9f2dea4c00b67b5a1aaa7c8bd4f |
||
|---|---|---|
| .. | ||
| examples | ||
| fuzz | ||
| src | ||
| .gitignore | ||
| .travis.yml | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| rustfmt.toml | ||
README.md
A Rust HID library for interacting with U2F Security Keys
This is a cross-platform library for interacting with U2F Security Key-type devices via Rust.
- Supported Platforms: Windows, Linux, and Mac OS X.
- Supported HID Transports: USB.
- Supported Protocols: FIDO U2F over USB.
This library currently focuses on U2F security keys, but is expected to be extended to support additional protocols and transports.
Usage
There's only a simple example function that tries to register and sign right now. It uses
env_logger for logging, which you
configure with the RUST_LOG environment variable:
cargo build
RUST_LOG=debug cargo run --example main
Proper usage should be to call into this library from something else - e.g., Firefox. There are some C headers exposed for the purpose.
Tests
There are some tests of the cross-platform runloop logic and the protocol decoder:
cargo test
Fuzzing
There are fuzzers for the USB protocol reader, basically fuzzing inputs from the HID layer. There are not (yet) fuzzers for the C API used by callers (such as Gecko).
To fuzz, you will need cargo-fuzz (the latest version from GitHub) as well as Rust Nightly.
rustup install nightly
cargo install --git https://github.com/rust-fuzz/cargo-fuzz/
rustup run nightly cargo fuzz run u2f_read -- -max_len=512
rustup run nightly cargo fuzz run u2f_read_write -- -max_len=512