summaryrefslogtreecommitdiffstats
path: root/openpgp/src
diff options
context:
space:
mode:
authorNeal H. Walfield <neal@pep.foundation>2020-01-14 14:09:40 +0100
committerNeal H. Walfield <neal@pep.foundation>2020-01-14 14:09:40 +0100
commit514eef781821bf3c28b1c0fea4d21e7b236da15f (patch)
treec1e5f5d0a7e4e1479c502500be1276511e787517 /openpgp/src
parent347eb206889dd3f6473e39a426ffc0c6a677e006 (diff)
openpgp: Improve documentation for Verifier.
Diffstat (limited to 'openpgp/src')
-rw-r--r--openpgp/src/parse/stream.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/openpgp/src/parse/stream.rs b/openpgp/src/parse/stream.rs
index 629b05f9..87bac054 100644
--- a/openpgp/src/parse/stream.rs
+++ b/openpgp/src/parse/stream.rs
@@ -71,6 +71,14 @@ const BUFFER_SIZE: usize = 25 * 1024 * 1024;
/// is important to treat the data as unverified and untrustworthy
/// until you have seen a positive verification.
///
+/// For a signature to be considered valid: The signature must have a
+/// `Signature Creation Time` subpacket. The signature must be alive
+/// at the signature verification time (the time passed to
+/// `Verifier::from_reader`). The key used to verify the signature
+/// must be alive at the signature creation time, not have been soft
+/// revoked at the signature creation time, not have ever been hard
+/// revoked, and be signing capable at the signature creation time.
+///
/// # Example
///
/// ```