kmwebnet/OpenSK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Corrects the README for the 2.1 branch. (#664)

Browse Source
This commit is contained in:
kaczmarczyck
2023-11-09 17:32:14 +01:00
committed by GitHub
parent c160b034ef
commit 5bfd198278
1 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,10 +1,7 @@
# <img alt="OpenSK logo" src="docs/img/OpenSK.svg" width="200px"> # <img alt="OpenSK logo" src="docs/img/OpenSK.svg" width="200px">
![markdownlint](https://github.com/google/OpenSK/workflows/markdownlint/badge.svg?branch=develop) ![markdownlint](https://github.com/google/OpenSK/workflows/markdownlint/badge.svg?branch=2.1)
![pylint](https://github.com/google/OpenSK/workflows/pylint/badge.svg?branch=develop) [![Coverage Status](https://coveralls.io/repos/github/google/OpenSK/badge.svg?branch=2.1)](https://coveralls.io/github/google/OpenSK?branch=2.1)
![Cargo check](https://github.com/google/OpenSK/workflows/Cargo%20check/badge.svg?branch=develop)
![Cargo format](https://github.com/google/OpenSK/workflows/Cargo%20format/badge.svg?branch=develop)
[![Coverage Status](https://coveralls.io/repos/github/google/OpenSK/badge.svg?branch=develop)](https://coveralls.io/github/google/OpenSK?branch=develop)
*News:* *News:*
@@ -27,15 +24,16 @@ enclosure!
You can run OpenSK as a [Tock OS](https://tockos.org) application, or use the You can run OpenSK as a [Tock OS](https://tockos.org) application, or use the
library to bring OpenSK to your own hardware. library to bring OpenSK to your own hardware.
You are viewing the branch for developers. New features are developed here. You are viewing the CTAP 2.1 version. This branch fixes bugs, but doesn't
Go to the default branch for a more stable version of OpenSK. implement new features. If you want to contribute, go to the
[develop branch](https://github.com/google/OpenSK/tree/develop).
### FIDO2 ### FIDO2
OpenSK's version that implemented CTAP 2.0 was certified by the FIDO Alliance. OpenSK's version that implemented CTAP 2.0 was certified by the FIDO Alliance.
The develop branch tracks the latest release version of the This branch implements version 2.1 of the
[CTAP specification](https://fidoalliance.org/specs/fido-v2.2-rd-20230321/fido-client-to-authenticator-protocol-v2.2-rd-20230321.html). [CTAP specification](https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html).
This branch is not FIDO certified. This branch is not FIDO certified.
OpenSK supports U2F, and non-discoverable credentials created with either OpenSK supports U2F, and non-discoverable credentials created with either
protocol are compatible with the other. protocol are compatible with the other.