README update for CTAP2 branch

This commit is contained in:
J.C. Jones 2019-05-03 10:55:26 -07:00
Родитель 819dd7f839
Коммит 9bbf34fa68
1 изменённых файлов: 6 добавлений и 6 удалений

Просмотреть файл

@ -1,19 +1,19 @@
# A Rust library for interacting with CTAP1/CTAP2 Security Keys
[![Build Status](https://travis-ci.org/jcjones/authenticator-rs.svg?branch=master)](https://travis-ci.org/jcjones/authenticator-rs)
![Maturity Level](https://img.shields.io/badge/maturity-release-green.svg)
[![Build Status](https://travis-ci.org/mozilla/authenticator-rs.svg?branch=ctap2)](https://travis-ci.org/mozilla/authenticator-rs)
![Maturity Level](https://img.shields.io/badge/maturity-alpha-red.svg)
This is a cross-platform library for interacting with Security Key-type devices via Rust.
* **Supported Platforms**: Windows, Linux, FreeBSD, and macOS.
** This is the CTAP2 branch, it is UNSTABLE. The [main branch is stable](https://github.com/mozilla/authenticator-rs/tree/master). **
* **Supported Platforms**: Linux.
* **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 `ctap2` branch.
* **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 being developed on this branch.
This library currently focuses on USB security keys, but is expected to be extended to
support additional transports.
**NOTE**: This library will be moving to the Mozilla github account in the near future.
## Usage
There's only a simple example function that tries to register and sign right now. It uses