summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWiktor Kwapisiewicz <wiktor@metacode.biz>2020-10-26 10:24:12 +0100
committerWiktor Kwapisiewicz <wiktor@metacode.biz>2020-11-01 22:04:50 +0100
commit70d1d3825e698e2bdb6c96dc8ecfa7e50aa4bd05 (patch)
treec01293f65dc77f55ab6a131a101faac8a9e950fc
parentb846ce01c13191196738cb4bdb6040bb20c87a98 (diff)
openpgp: Update documentation w.r.t packets added to hashed area.
- Updates documentation to match the implementation changes introduced in commit 7e9561e9. - Fixes #583.
-rw-r--r--openpgp/src/packet/signature.rs20
-rw-r--r--openpgp/src/packet/signature/subpacket.rs8
2 files changed, 14 insertions, 14 deletions
diff --git a/openpgp/src/packet/signature.rs b/openpgp/src/packet/signature.rs
index 1961c452..e2dea86d 100644
--- a/openpgp/src/packet/signature.rs
+++ b/openpgp/src/packet/signature.rs
@@ -340,7 +340,7 @@ impl SignatureFields {
/// when converting a `Signature` to a `SigantureBuilder`. Since the
/// [`Signer`] passed to the finalization routine contains the
/// required information, we also automatically add appropriate
-/// `Issuer` and `Issuer Fingerprint` subpackets to the unhashed
+/// `Issuer` and `Issuer Fingerprint` subpackets to the hashed
/// subpacket area when the `SignatureBuilder` is finalized unless an
/// `Issuer` subpacket or an `IssuerFingerprint` subpacket has been
/// added to either of the subpacket areas (which can be done using
@@ -518,7 +518,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -629,7 +629,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -736,7 +736,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -869,7 +869,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -996,7 +996,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -1138,7 +1138,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -1269,7 +1269,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -1377,7 +1377,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
@@ -1446,7 +1446,7 @@ impl SignatureBuilder {
/// [`SignatureBuilder::set_issuer`], for instance) nor an
/// [`Issuer Fingerprint`] subpacket (set using
/// [`SignatureBuilder::set_issuer_fingerprint`], for instance) is
- /// set, they are both added to the new `Signature`'s unhashed
+ /// set, they are both added to the new `Signature`'s hashed
/// subpacket area and set to the `signer`'s `KeyID` and
/// `Fingerprint`, respectively.
///
diff --git a/openpgp/src/packet/signature/subpacket.rs b/openpgp/src/packet/signature/subpacket.rs
index 7c258010..eb0ce810 100644
--- a/openpgp/src/packet/signature/subpacket.rs
+++ b/openpgp/src/packet/signature/subpacket.rs
@@ -2817,7 +2817,7 @@ impl SubpacketAreas {
/// The [Issuer subpacket] is used when processing a signature to
/// identify which certificate created the signature. Since this
/// information is self-authenticating (the act of validating the
- /// signature authenticates the subpacket), it is stored in the
+ /// signature authenticates the subpacket), it may be stored in the
/// unhashed subpacket area.
///
/// [Issuer subpacket]: https://tools.ietf.org/html/rfc4880#section-5.2.3.5
@@ -5233,7 +5233,7 @@ impl signature::SignatureBuilder {
/// identify which certificate created the signature. Even though this
/// information is self-authenticating (the act of validating the
/// signature authenticates the subpacket), it is stored in the
- /// unhashed subpacket area. This has the advantage that the signer
+ /// hashed subpacket area. This has the advantage that the signer
/// authenticates the set of issuers. Furthermore, it makes
/// handling of the resulting signatures more robust: If there are
/// two two signatures that are equal modulo the contents of the
@@ -6393,7 +6393,7 @@ impl signature::SignatureBuilder {
/// signature to identify which certificate created the signature.
/// Even though this information is self-authenticating (the act of
/// validating the signature authenticates the subpacket), it is
- /// stored in the unhashed subpacket area. This has the advantage
+ /// stored in the hashed subpacket area. This has the advantage
/// that the signer authenticates the set of issuers.
/// Furthermore, it makes handling of the resulting signatures
/// more robust: If there are two two signatures that are equal
@@ -6485,7 +6485,7 @@ impl signature::SignatureBuilder {
/// signature to identify which certificate created the signature.
/// Even though this information is self-authenticating (the act of
/// validating the signature authenticates the subpacket), it is
- /// stored in the unhashed subpacket area. This has the advantage
+ /// stored in the hashed subpacket area. This has the advantage
/// that the signer authenticates the set of issuers.
/// Furthermore, it makes handling of the resulting signatures
/// more robust: If there are two two signatures that are equal