Struct SignatureConfig

Source

pub struct SignatureConfig {
    pub typ: SignatureType,
    pub pub_alg: PublicKeyAlgorithm,
    pub hash_alg: HashAlgorithm,
    pub unhashed_subpackets: Vec<Subpacket>,
    pub hashed_subpackets: Vec<Subpacket>,
    pub version_specific: SignatureVersionSpecific,
}

Fields§

§typ: SignatureType§pub_alg: PublicKeyAlgorithm§hash_alg: HashAlgorithm§unhashed_subpackets: Vec<Subpacket>§hashed_subpackets: Vec<Subpacket>§version_specific: SignatureVersionSpecific

Implementations§

Source §

impl SignatureConfig

Source

pub fn v2( typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, created: DateTime<Utc>, issuer: KeyId, ) -> Self

Constructor for a v2 SignatureConfig (which represents the data of a v2 OpenPGP signature packet)

OpenPGP v2 Signatures are historical and not used anymore.

Source

pub fn v3( typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, created: DateTime<Utc>, issuer: KeyId, ) -> Self

Constructor for a v3 SignatureConfig (which represents the data of a v3 OpenPGP signature packet)

OpenPGP v3 Signatures are historical and not used anymore.

Source

pub fn v4( typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, ) -> Self

Constructor for a v4 SignatureConfig (which represents the data of a v4 OpenPGP signature packet)

OpenPGP v4 signatures were first specified in RFC 2440, and are commonly produced by OpenPGP v4 keys.

Source

pub fn v6<R: CryptoRng + Rng>( rng: R, typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, ) -> Result<Self>

Constructor for a v6 SignatureConfig (which represents the data of a v6 OpenPGP signature packet). Generates a new salt via rng.

OpenPGP v6 signatures are specified in RFC 9580, they are produced by OpenPGP v6 keys.

Source

pub fn v6_with_salt( typ: SignatureType, pub_alg: PublicKeyAlgorithm, hash_alg: HashAlgorithm, salt: Vec<u8>, ) -> Self

Constructor for a v6 SignatureConfig (which represents the data of a v6 OpenPGP signature packet).

OpenPGP v6 signatures are specified in RFC 9580, they are produced by OpenPGP v6 keys.

Source

pub fn version(&self) -> SignatureVersion

Source

pub fn sign<F, R>( self, key: &impl SecretKeyTrait, key_pw: F, data: R, ) -> Result<Signature>
where F: FnOnce() -> String, R: Read,

Sign the given data.

Source

pub fn sign_certification<F>( self, key: &impl SecretKeyTrait, key_pw: F, tag: Tag, id: &impl Serialize, ) -> Result<Signature>
where F: FnOnce() -> String,

Create a certification self-signature.

Source

pub fn sign_certification_third_party<F>( self, signer: &impl SecretKeyTrait, signer_pw: F, signee: &impl PublicKeyTrait, tag: Tag, id: &impl Serialize, ) -> Result<Signature>
where F: FnOnce() -> String,

Create a certification third-party signature.

Source

pub fn sign_key_binding<F>( self, signing_key: &impl SecretKeyTrait, key_pw: F, key: &impl PublicKeyTrait, ) -> Result<Signature>
where F: FnOnce() -> String,

Sign a key binding.

Source

pub fn sign_key<F>( self, signing_key: &impl SecretKeyTrait, key_pw: F, key: &impl PublicKeyTrait, ) -> Result<Signature>
where F: FnOnce() -> String,

Signs a direct key signature or a revocation.

Source

pub fn typ(&self) -> SignatureType

Returns what kind of signature this is.

Source

pub fn hash_signature_data(&self, hasher: &mut dyn Write) -> Result<usize>

Calculate the serialized version of this packet, but only the part relevant for hashing.

Source

pub fn hash_data_to_sign<R>( &self, hasher: &mut dyn Hasher, data: R, ) -> Result<usize>
where R: Read,

Source

pub fn trailer(&self, len: usize) -> Result<Vec<u8>>

Source

pub fn subpackets(&self) -> impl Iterator<Item = &Subpacket>

👎Deprecated: Usually only hashed_subpackets should be used. unhashed_subpackets are only safe and useful to access in rare circumstances. When they are needed, unhashed_subpackets should be explicitly called.

Returns an iterator of all subpackets in the signature: all subpackets in the hashed area followed by all subpackets in the unhashed area.

Source