Struct Signature 

pub struct Signature { /* private fields */ }

Signature Packet

Ref https://www.rfc-editor.org/rfc/rfc9580.html#name-signature-packet-type-id-2

OpenPGP Signatures are a very generic mechanism. They are always used by a signer to make a statement about some data payload, and the SignatureConfig metadata of the signature packet. The statement can be verified by anyone with access to the signer’s public key, the payload data, and the signature packet.

Signature packets are used in two very distinct contexts:

• As data signatures (either inline, in OpenPGP Messages, or as detached signatures over standalone data files).
• As certificate-forming signatures (e.g. to bind a subkey to a primary key).

For data signatures, the signer’s intended statement is usually either “I am the author of this payload” (e.g. for an email), or “I confirm that this payload has been handled appropriately” (e.g. to signal that a software package has been built by the infrastructure of a Linux distribution).

For certificate-forming signatures, typical statements of signature packets are “the primary key holder wants to associate this subkey with the primary”, or “the key holder wants to associate this identity (e.g. an email address) with their primary key”. Third-party signatures can be used by third parties to make statements, e.g. that they have verified that an identity is validly associated with a key (such as: “I have verified that this key belongs to Alice”).

The purpose of a signature packet is marked by its SignatureType.

Implementations

impl Signature

pub fn try_from_reader<B: BufRead>( packet_header: PacketHeader, i: B, ) -> Result<Self>

Parses a Signature packet from the given buffer

Ref: https://www.rfc-editor.org/rfc/rfc9580.html#name-signature-packet-type-id-2

impl Signature

pub fn v2( packet_header: PacketHeader, typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, created: Timestamp, issuer_key_id: KeyId, signed_hash_value: [u8; 2], signature: SignatureBytes, ) -> Self

Constructor for an OpenPGP v2 signature packet. Note: This is a historical packet version!

pub fn v3( packet_header: PacketHeader, typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, created: Timestamp, issuer_key_id: KeyId, signed_hash_value: [u8; 2], signature: SignatureBytes, ) -> Self

Constructor for an OpenPGP v3 signature packet. Note: This is a historical packet version!

pub fn v4( packet_header: PacketHeader, typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, signed_hash_value: [u8; 2], signature: SignatureBytes, hashed_subpackets: Vec<Subpacket>, unhashed_subpackets: Vec<Subpacket>, ) -> Self

Constructor for an OpenPGP v4 signature packet.

OpenPGP v4 signatures are typically used with OpenPGP v4 keys, as specified in RFC 9580 (and formerly in 4880 and 2440).

pub fn v6( packet_header: PacketHeader, typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, signed_hash_value: [u8; 2], signature: SignatureBytes, hashed_subpackets: Vec<Subpacket>, unhashed_subpackets: Vec<Subpacket>, salt: Vec<u8>, ) -> Self

Constructor for an OpenPGP v6 signature packet.

OpenPGP v6 signatures are specified in RFC 9580 and only used with OpenPGP v6 keys.

pub fn unknown( packet_header: PacketHeader, version: SignatureVersion, data: Bytes, ) -> Self

Create a signature of unknown version

pub fn from_config( config: SignatureConfig, signed_hash_value: [u8; 2], signature: SignatureBytes, ) -> Result<Self>

pub fn config(&self) -> Option<&SignatureConfig>

Returns the SignatureConfig if this is a known signature format.

pub fn unhashed_subpacket_push(&mut self, subpacket: Subpacket) -> Result<()>

Appends a subpacket at the back of the unhashed area

pub fn unhashed_subpacket_insert( &mut self, index: usize, subpacket: Subpacket, ) -> Result<()>

Insert a subpacket into the unhashed area at position index, shifting all subpackets after it to the right

pub fn unhashed_subpacket_remove(&mut self, index: usize) -> Result<Subpacket>

Removes and returns the unhashed subpacket at position index, shifting all other unhashed subpackets to the left

pub fn unhashed_subpackets_sort_by<F>(&mut self, compare: F)

where F: FnMut(&Subpacket, &Subpacket) -> Ordering,

Sorts the subpackets in the unhashed area with a comparison function, preserving initial order of equal elements.

pub fn version(&self) -> SignatureVersion

Returns the SignatureVersion.

pub fn typ(&self) -> Option<SignatureType>

Returns what kind of signature this is.

pub fn hash_alg(&self) -> Option<HashAlgorithm>

The used HashAlgorithm.

pub fn signature(&self) -> Option<&SignatureBytes>

Returns the actual byte level signature.

pub fn signed_hash_value(&self) -> Option<[u8; 2]>

pub fn verify<R>(&self, key: &impl VerifyingKey, data: R) -> Result<()>

where R: Read,

Verify this signature.

pub fn verify_certification<V>( &self, key: &V, tag: Tag, id: &impl Serialize, ) -> Result<()>

where V: VerifyingKey + Serialize,

Verifies a certification signature or certification revocation signature (for self-signatures).

Allowed signature types are:

• Generic Certification Signature (Type ID 0x10)
• Persona Certification Signature (Type ID 0x11)
• Casual Certification Signature (Type ID 0x12)
• Positive Certification Signature (Type ID 0x13)
• Certification Revocation Signature (Type ID 0x30)

pub fn verify_third_party_certification<V, K>( &self, signee: &K, signer: &V, tag: Tag, id: &impl Serialize, ) -> Result<()>

where V: VerifyingKey + Serialize, K: KeyDetails + Serialize,

Verifies a (possibly third-party) certification signature or certification revocation signature.

Allowed signature types are:

• Generic Certification Signature (Type ID 0x10)
• Persona Certification Signature (Type ID 0x11)
• Casual Certification Signature (Type ID 0x12)
• Positive Certification Signature (Type ID 0x13)
• Certification Revocation Signature (Type ID 0x30)

pub fn verify_subkey_binding<V, K>(&self, signer: &V, signee: &K) -> Result<()>

where V: VerifyingKey + Serialize, K: KeyDetails + Serialize,

Verifies a subkey binding (which binds a subkey to the primary key) or subkey revocation signature.

The primary key is expected as signer, the subkey as signee.

Allowed signature types are:

• Subkey Binding Signature (type ID 0x18)
• Subkey Revocation Signature (Type ID 0x28)

pub fn verify_primary_key_binding<V, K>( &self, signer: &V, signee: &K, ) -> Result<()>

where V: VerifyingKey + Serialize, K: KeyDetails + Serialize,

Verifies a primary key binding signature, or “back signature” (which links the primary to a signing subkey).

The subkey is expected as signer, the primary key as signee.

Allowed signature types are:

• Primary Key Binding Signature (type ID 0x19)

pub fn verify_key<V>(&self, key: &V) -> Result<()>

where V: VerifyingKey + Serialize,

Verifies a direct key signature or a revocation.

pub fn verify_key_third_party<V, K>(&self, signee: &K, signer: &V) -> Result<()>

where V: VerifyingKey + Serialize, K: KeyDetails + Serialize,

Verifies a (possibly third-party) direct key signature or a revocation.

Allowed signature types are:

• Direct Key Signature (Type ID 0x1F)
• Key Revocation Signature (Type ID 0x20)

pub fn is_certification(&self) -> bool

Returns if the signature is a certification or not.

pub fn key_expiration_time(&self) -> Option<Duration>

If the hashed area contains any KeyExpirationTime subpacket, then this returns Some(Duration) of the first KeyExpirationTime subpacket encountered.

If the hashed area contains no KeyExpirationTime subpacket, this returns None.

(Note that a return value of Some(Duration(0)) also means that no key expiration time applies to the target component. This corresponds to a different wire-format representation, but is semantically equivalent to None.)

pub fn signature_expiration_time(&self) -> Option<Duration>

pub fn created(&self) -> Option<Timestamp>

pub fn issuer_key_id(&self) -> Vec<&KeyId>

pub fn issuer_fingerprint(&self) -> Vec<&Fingerprint>

pub fn preferred_symmetric_algs(&self) -> &[SymmetricKeyAlgorithm]

pub fn preferred_aead_algs(&self) -> &[(SymmetricKeyAlgorithm, AeadAlgorithm)]

pub fn preferred_hash_algs(&self) -> &[HashAlgorithm]

pub fn preferred_compression_algs(&self) -> &[CompressionAlgorithm]

pub fn key_server_prefs(&self) -> &[u8]

pub fn key_flags(&self) -> KeyFlags

pub fn features(&self) -> Option<&Features>

pub fn revocation_reason_code(&self) -> Option<&RevocationCode>

pub fn revocation_reason_string(&self) -> Option<&Bytes>

pub fn is_primary(&self) -> bool

pub fn is_revocable(&self) -> bool

pub fn embedded_signature(&self) -> Option<&Signature>

pub fn preferred_key_server(&self) -> Option<&str>

pub fn notations(&self) -> Vec<&Notation>

pub fn revocation_key(&self) -> Option<&RevocationKey>

pub fn signers_userid(&self) -> Option<&Bytes>

Gets the user id of the signer

Note that the user id may not be valid utf-8, if it was created using a different encoding. But since the RFC describes every text as utf-8 it is up to the caller whether to error on non utf-8 data.

pub fn policy_uri(&self) -> Option<&str>

pub fn trust_signature(&self) -> Option<(u8, u8)>

pub fn regular_expression(&self) -> Option<&Bytes>

pub fn exportable_certification(&self) -> bool

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Signature

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Signature

impl From<Signature> for Packet

fn from(other: Signature) -> Packet

Converts to this type from the input type.

impl PacketTrait for Signature

fn packet_header(&self) -> &PacketHeader

fn packet_header_version(&self) -> PacketHeaderVersion

fn tag(&self) -> Tag

fn to_writer_with_header<W: Write>(&self, writer: &mut W) -> Result<()>

Write this packet including the packet header.

fn write_len_with_header(&self) -> usize

Length in bytes used when calling to_writer_with_header.

impl PartialEq for Signature

fn eq(&self, other: &Signature) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Signature

fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

fn write_len(&self) -> usize

fn to_bytes(&self) -> Result<Vec<u8>>

impl StructuralPartialEq for Signature

impl TryFrom<Packet> for Signature

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: Packet) -> Result<Signature, Self::Error>

Performs the conversion.