https://github.com/mozilla/authenticator-rs

Rust library to interact with Security Keys, used by Firefox
https://github.com/mozilla/authenticator-rs

hid rust u2f

Last synced: 8 days ago
JSON representation

Rust library to interact with Security Keys, used by Firefox

• Host: GitHub
• URL: https://github.com/mozilla/authenticator-rs
• Owner: mozilla
• License: mpl-2.0
• Created: 2017-03-31T21:03:21.000Z (over 7 years ago)
• Default Branch: ctap2-2021
• Last Pushed: 2024-09-25T22:51:50.000Z (about 1 month ago)
• Last Synced: 2024-10-29T11:39:09.533Z (10 days ago)
• Topics: hid, rust, u2f
• Language: Rust
• Homepage: https://crates.io/crates/authenticator
• Size: 1.24 MB
• Stars: 275
• Watchers: 14
• Forks: 72
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A Rust library for interacting with CTAP1/CTAP2 Security Keys

[![Build Status](https://travis-ci.org/mozilla/authenticator-rs.svg?branch=master)](https://travis-ci.org/mozilla/authenticator-rs)

![Maturity Level](https://img.shields.io/badge/maturity-release-green.svg)

This is a cross-platform library for interacting with Security Key-type devices via Rust.

* **Supported Platforms**: Windows, Linux, FreeBSD, NetBSD, OpenBSD, and macOS.

* **Supported Transports**: USB HID.

* **Supported Protocols**: [FIDO U2F over USB](https://fidoalliance.org/specs/fido-u2f-v1.1-id-20160915/fido-u2f-raw-message-formats-v1.1-id-20160915.html). [CTAP2 support](https://fidoalliance.org/specs/fido-v2.0-ps-20190130/fido-client-to-authenticator-protocol-v2.0-ps-20190130.html) is forthcoming, with work being done in the **unstable** [`ctap2` branch](https://github.com/mozilla/authenticator-rs/tree/ctap2).

This library currently focuses on USB security keys, but is expected to be extended to

support additional transports.

## Usage

There's only a simple example function that tries to register and sign right now. It uses

[env_logger](http://rust-lang-nursery.github.io/log/env_logger/) for logging, which you

configure with the `RUST_LOG` environment variable:

```

cargo build --example main

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](./src/u2fhid-capi.h).

## 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 cargo-fuzz

cargo +nightly fuzz run u2f_read -- -max_len=512

cargo +nightly fuzz run u2f_read_write -- -max_len=512

```