turnkey/openpgp-card
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Expand top-level README

Browse source
This commit is contained in:
Heiko Schaefer 2021-08-20 19:32:25 +02:00
parent d62f73e84c
commit 50499dc15d
1 changed files with 23 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -9,34 +9,35 @@ This project implements a client library for the
[OpenPGP card](https://gnupg.org/ftp/specs/OpenPGP-smart-card-application-3.4.1.pdf)
specification, in Rust.
The project consists of two crates:
The project consists of a number of crates:
- [openpgp-card](https://crates.io/crates/openpgp-card), which offers an
implementation-agnostic OpenPGP card client API. It can be used with any
PGP implementation.
implementation-agnostic, relatively low level OpenPGP card client API. It
can be used with any PGP implementation.
- [openpgp-card-sequoia](https://crates.io/crates/openpgp-card-sequoia),
adds functionality to conveniently use the openpgp-card library with
[Sequoia PGP](https://sequoia-pgp.org/).
adds a higher level API and functionality to conveniently use the
openpgp-card library with [Sequoia PGP](https://sequoia-pgp.org/).
- [openpgp-card-pcsc](https://crates.io/crates/openpgp-card-pcsc),
a backend to communicate with smartcards via pcsc.
- [openpgp-card-scdc](https://gitlab.com/hkos/openpgp-card/-/tree/main/scdc),
a backend to communicate with smartcards via an scdaemon instance.
- [openpgp-card-tests](https://gitlab.com/hkos/openpgp-card/-/tree/main/card-functionality),
a testsuite to run OpenPGP card operations on smartcards.
**Acknowledgements**
This library is based on the
This project is based on the
[OpenPGP Card spec](https://gnupg.org/ftp/specs/OpenPGP-smart-card-application-3.4.1.pdf),
version 3.4.1.
Other helpful resources included:
The free [Gnuk](https://git.gniibe.org/cgit/gnuk/gnuk.git/)
- The free [Gnuk](https://git.gniibe.org/cgit/gnuk/gnuk.git/)
OpenPGP card implementation by [gniibe](https://www.gniibe.org/).
The Rust/Sequoia-based OpenPGP card client code in
- The Rust/Sequoia-based OpenPGP card client code in
[kushaldas](https://kushaldas.in/)' project
[johnnycanencrypt](https://github.com/kushaldas/johnnycanencrypt/).
The [scdaemon](https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=tree;f=scd;hb=refs/heads/master)
- The [scdaemon](https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gnupg.git;a=tree;f=scd;hb=refs/heads/master)
client implementation by the [GnuPG](https://gnupg.org/) project.
The [open-keychain](https://github.com/open-keychain/open-keychain) project,
- The [open-keychain](https://github.com/open-keychain/open-keychain) project,
which implements an OpenPGP card client for Java/Android.
The Rust/Sequoia-based OpenPGP card client code by
- The Rust/Sequoia-based OpenPGP card client code by
[Robin Krahl](https://git.sr.ht/~ireas/sqsc).