From 93dbeb3160262726d4c60b4811cf352c08dfc5b3 Mon Sep 17 00:00:00 2001 From: Justus Winter Date: Tue, 3 Mar 2020 14:38:51 +0100 Subject: openpgp: Add a dedicated README.md. --- openpgp/Cargo.toml | 2 +- openpgp/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 openpgp/README.md diff --git a/openpgp/Cargo.toml b/openpgp/Cargo.toml index d351d064..220217fd 100644 --- a/openpgp/Cargo.toml +++ b/openpgp/Cargo.toml @@ -11,7 +11,7 @@ build = "build.rs" documentation = "https://docs.sequoia-pgp.org/0.14.0/sequoia_openpgp" homepage = "https://sequoia-pgp.org/" repository = "https://gitlab.com/sequoia-pgp/sequoia" -readme = "../README.md" +readme = "README.md" keywords = ["cryptography", "openpgp", "pgp", "encryption", "signing"] categories = ["cryptography", "authentication", "email"] license = "GPL-2.0-or-later" diff --git a/openpgp/README.md b/openpgp/README.md new file mode 100644 index 00000000..d07c3192 --- /dev/null +++ b/openpgp/README.md @@ -0,0 +1,48 @@ +This crate aims to provide a complete implementation of OpenPGP as +defined by [RFC 4880] as well as some extensions (e.g., [RFC +6637], which describes ECC cryptography for OpenPGP. This +includes support for unbuffered message processing. + +A few features that the OpenPGP community considers to be +deprecated (e.g., version 3 compatibility) have been left out. We +have also updated some OpenPGP defaults to avoid foot guns (e.g., +we selected modern algorithm defaults). If some functionality is +missing, please file a bug report. + +A non-goal of this crate is support for any sort of high-level, +bolted-on functionality. For instance, [RFC 4880] does not define +trust models, such as the web of trust, direct trust, or TOFU. +Neither does this crate. [RFC 4880] does provide some mechanisms +for creating trust models (specifically, UserID certifications), +and this crate does expose those mechanisms. + +We also try hard to avoid dictating how OpenPGP should be used. +This doesn't mean that we don't have opinions about how OpenPGP +should be used in a number of common scenarios (for instance, +message validation). But, in this crate, we refrain from +expressing those opinions; we expose an opinionated, high-level +interface in the [sequoia-core] and related crates. In our +opinion, you should generally use those crates instead of this +one. + +[RFC 4880]: https://tools.ietf.org/html/rfc4880 +[RFC 6637]: https://tools.ietf.org/html/rfc6637 +[sequoia-core]: ../sequoia_core + +# Experimental Features + +This crate implements functionality from [RFC 4880bis], notable +AEAD encryption containers. As of this writing, this RFC is still +a draft and the syntax or semantic defined in it may change or go +away. Therefore, all related functionality may change and +artifacts created using this functionality may not be usable in +the future. Do not use it for things other than experiments. + +[RFC 4880bis]: https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-08 + +This crate aims to provide a complete implementation of OpenPGP as +defined by RFC 4880 as well as several extensions (e.g., RFC 6637, +which describes ECC cryptography for OpenPGP, and RFC 4880bis, the +draft of the next OpenPGP standard). This includes support for +unbuffered message processing. + -- cgit v1.2.3