summaryrefslogtreecommitdiffstats
path: root/net
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2021-01-21 14:25:06 +0100
committerJustus Winter <justus@sequoia-pgp.org>2021-01-21 14:25:06 +0100
commit3406e0f4ee06c545b83a8e9379d1ae6359546e98 (patch)
tree86bc470dcc08bd5baa5c7a5ee4bcb5bcf52ff5ce /net
parentb4c3a26d096d67004234f8f8e738b0f02569227b (diff)
net: Release 0.23.0.net/v0.23.0
Diffstat (limited to 'net')
-rw-r--r--net/Cargo.toml16
-rw-r--r--net/README.md7
-rw-r--r--net/src/lib.rs22
-rw-r--r--net/src/wkd.rs2
4 files changed, 30 insertions, 17 deletions
diff --git a/net/Cargo.toml b/net/Cargo.toml
index cff91a70..fa2819b6 100644
--- a/net/Cargo.toml
+++ b/net/Cargo.toml
@@ -1,16 +1,16 @@
[package]
name = "sequoia-net"
description = "Network services for OpenPGP"
-version = "0.22.0"
+version = "0.23.0"
authors = [
"Justus Winter <justus@sequoia-pgp.org>",
"Kai Michaelis <kai@sequoia-pgp.org>",
"Neal H. Walfield <neal@sequoia-pgp.org>",
]
-documentation = "https://docs.sequoia-pgp.org/0.21.0/sequoia_net"
+documentation = "https://docs.rs/sequoia-net"
homepage = "https://sequoia-pgp.org/"
repository = "https://gitlab.com/sequoia-pgp/sequoia"
-readme = "../README.md"
+readme = "README.md"
keywords = ["cryptography", "openpgp", "pgp", "hkp", "keyserver"]
categories = ["cryptography", "authentication", "email"]
license = "GPL-2.0-or-later"
@@ -21,7 +21,7 @@ gitlab = { repository = "sequoia-pgp/sequoia" }
maintenance = { status = "actively-developed" }
[dependencies]
-sequoia-openpgp = { path = "../openpgp", version = "1.0.0", default-features = false }
+sequoia-openpgp = { path = "../openpgp", version = "1", default-features = false }
anyhow = "1.0.18"
futures-util = "0.3.5"
@@ -41,10 +41,10 @@ rand = { version = "0.7", default-features = false }
tokio = { version = "0.2.19", features = ["full"] }
[features]
-default = ["compression"]
-
-# The compression algorithms.
-compression = ["compression-deflate", "compression-bzip2"]
+default = ["sequoia-openpgp/default"]
+crypto-nettle = ["sequoia-openpgp/crypto-nettle"]
+crypto-cng = ["sequoia-openpgp/crypto-cng"]
+compression = ["sequoia-openpgp/compression"]
compression-deflate = ["sequoia-openpgp/compression-deflate"]
compression-bzip2 = ["sequoia-openpgp/compression-bzip2"]
diff --git a/net/README.md b/net/README.md
new file mode 100644
index 00000000..fddee80d
--- /dev/null
+++ b/net/README.md
@@ -0,0 +1,7 @@
+Discovering and publishing OpenPGP certificates over the network.
+
+This crate provides access to keyservers using the [HKP] protocol,
+and searching and publishing [Web Key Directories].
+
+ [HKP]: https://tools.ietf.org/html/draft-shaw-openpgp-hkp-00
+ [Web Key Directories]: https://datatracker.ietf.org/doc/html/draft-koch-openpgp-webkey-service
diff --git a/net/src/lib.rs b/net/src/lib.rs
index 6055f5ad..8410de37 100644
--- a/net/src/lib.rs
+++ b/net/src/lib.rs
@@ -1,17 +1,15 @@
-//! For accessing keys over the network.
+//! Discovering and publishing OpenPGP certificates over the network.
//!
-//! Currently, this module provides access to keyservers providing the [HKP] protocol.
+//! This crate provides access to keyservers using the [HKP] protocol,
+//! and searching and publishing [Web Key Directories].
//!
//! [HKP]: https://tools.ietf.org/html/draft-shaw-openpgp-hkp-00
+//! [Web Key Directories]: https://datatracker.ietf.org/doc/html/draft-koch-openpgp-webkey-service
//!
//! # Examples
//!
-//! We provide a very reasonable default key server backed by
-//! `hkps.pool.sks-keyservers.net`, the subset of the [SKS keyserver]
-//! network that uses https to protect integrity and confidentiality
-//! of the communication with the client:
-//!
-//! [SKS keyserver]: https://www.sks-keyservers.net/overview-of-pools.php#pool_hkps
+//! This example demonstrates how to fetch a certificate from the
+//! default key server:
//!
//! ```no_run
//! # use sequoia_openpgp::KeyID;
@@ -23,6 +21,14 @@
//! # Ok(())
//! # }
//! ```
+//!
+//! This example demonstrates how to fetch a certificate using WKD:
+//!
+//! ```no_run
+//! # async fn f() -> sequoia_net::Result<()> {
+//! let certs = sequoia_net::wkd::get("juliett@example.org").await?;
+//! # Ok(()) }
+//! ```
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
diff --git a/net/src/wkd.rs b/net/src/wkd.rs
index 7c29926b..66f89049 100644
--- a/net/src/wkd.rs
+++ b/net/src/wkd.rs
@@ -7,7 +7,7 @@
//!
//! See the [get example].
//!
-//! [draft-koch]: https://datatracker.ietf.org/doc/html/draft-koch-openpgp-webkey-service/#section-3.1
+//! [draft-koch]: https://datatracker.ietf.org/doc/html/draft-koch-openpgp-webkey-service
//! [get example]: fn.get.html#example
//!