Documentation.

This commit is contained in:
Heiko Schaefer 2021-08-18 15:01:38 +02:00
parent 0b0e9c48fc
commit bf8ab84668
2 changed files with 26 additions and 4 deletions

View file

@ -9,13 +9,25 @@ This crate implements a client library for the
[OpenPGP card](https://gnupg.org/ftp/specs/OpenPGP-smart-card-application-3.4.1.pdf) [OpenPGP card](https://gnupg.org/ftp/specs/OpenPGP-smart-card-application-3.4.1.pdf)
specification, in Rust. specification, in Rust.
This library is OpenPGP implementation-agnostic. Its communication with This library provides low level, OpenPGP implementation-agnostic access to
the card is based on simple data structures, derived from the formats OpenPGP cards. Its communication with cards is based on simple data
defined in the OpenPGP card specification. structures that closely match the formats defined in the OpenPGP card
specification.
**Card access backends**
This crate doesn't contain code to talk to cards, The trait `CardClient`
needs to be implemented for access to cards.
The crates
[openpgp-card-pcsc](https://crates.io/crates/openpgp-card-pcsc)
and the experimental crate
[openpgp-card-scdc](https://gitlab.com/hkos/openpgp-card/-/tree/main/scdc)
provide implementations of `CardClient` for use with this crate.
**Sequoia PGP wrapper** **Sequoia PGP wrapper**
See the companion crate See the companion crate
[openpgp-card-sequoia](https://crates.io/crates/openpgp-card-sequoia) [openpgp-card-sequoia](https://crates.io/crates/openpgp-card-sequoia)
for a convenient wrapper to use this library with for a high level wrapper to use this library with
[Sequoia PGP](https://sequoia-pgp.org/). [Sequoia PGP](https://sequoia-pgp.org/).

10
pcsc/README.md Normal file
View file

@ -0,0 +1,10 @@
<!--
SPDX-FileCopyrightText: 2021 Heiko Schaefer <heiko@schaefer.name>
SPDX-License-Identifier: MIT OR Apache-2.0
-->
**pcsc client for the openpgp-card library**
This crate provides `PcscClient`, which is an implementation of the
`CardClient` trait that uses [pcsc](https://crates.io/crates/pcsc)
to access OpenPGP cards.