Skip to content

Commit

Permalink
Updated README to reflect maintenance status (google#660)
Browse files Browse the repository at this point in the history
* Updated README to reflect maintenance status

This PR is to be merged after the branches are reworked.

* FIDO -> CTAP

* Wording change to default branch
  • Loading branch information
kaczmarczyck authored Nov 9, 2023
1 parent c85a015 commit 7ab1b56
Showing 1 changed file with 5 additions and 37 deletions.
42 changes: 5 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# <img alt="OpenSK logo" src="docs/img/OpenSK.svg" width="200px">

![markdownlint](https://github.com/google/OpenSK/workflows/markdownlint/badge.svg?branch=stable)
![pylint](https://github.com/google/OpenSK/workflows/pylint/badge.svg?branch=stable)
![Cargo check](https://github.com/google/OpenSK/workflows/Cargo%20check/badge.svg?branch=stable)
![Cargo format](https://github.com/google/OpenSK/workflows/Cargo%20format/badge.svg?branch=stable)
[![Coverage Status](https://coveralls.io/repos/github/google/OpenSK/badge.svg?branch=stable)](https://coveralls.io/github/google/OpenSK?branch=stable)

*News:*

- 2023-08-24: [PQC paper reference](#Research)
This branch is unmaintained. It implements the CTAP 2.0 version of OpenSK.
Please check out the default branch for maintained code.
If you are a developer, go to the
[develop branch](https://github.com/google/OpenSK/tree/develop).

## OpenSK

Expand All @@ -24,16 +19,11 @@ You can see OpenSK in action in this

### FIDO2

The stable branch implements the
This branch implements the
[CTAP2.0 specification](https://fidoalliance.org/specs/fido-v2.0-ps-20190130/fido-client-to-authenticator-protocol-v2.0-ps-20190130.html)
and is FIDO certified. OpenSK supports U2F, and non-discoverable credentials
created with either protocol are compatible with the other.

If you want to use features of the newer FIDO 2.1, you can try our
[develop branch](https://github.com/google/OpenSK/tree/develop). This version is
NOT certified and less thoroughly tested though. If you plan to add features to
OpenSK, you should switch to develop.

### :warning: Disclaimer

This project is **proof-of-concept and a research platform**. It is **NOT**
Expand Down Expand Up @@ -76,28 +66,6 @@ Please check our [Troubleshooting and Debugging](docs/debugging.md) section if y
have problems with the installation process or during development. To find out what
else you can do with your OpenSK, see [Customization](docs/customization.md).

## Research

We implemented post-quantum cryptography on OpenSK. The code is released under
the [hybrid-pqc tag](https://github.com/google/OpenSK/releases/tag/hybrid-pqc).
Our [paper](https://eprint.iacr.org/2022/1225) was published in the ACNS
Secure Cryptographic Implementation workshop 2023 and won the best paper award.

<details>
<summary>Bibtex reference</summary>

```
@InProceedings{Ghinea2023hybrid,
author= {Diana Ghinea and Fabian Kaczmarczyck and Jennifer Pullman and Julien Cretin and Rafael Misoczki and Stefan Kölbl and Luca Invernizzi and Elie Bursztein and Jean-Michel Picod},
title= {{Hybrid Post-Quantum Signatures in Hardware Security Keys}},
booktitle= {{4th ACNS Workshop on Secure Cryptographic Implementation, Kyoto, Japan}},
month= {June},
year= {2023},
}
```

</details>

## Contributing

See [Contributing.md](docs/contributing.md).
Expand Down

0 comments on commit 7ab1b56

Please sign in to comment.