Struct SecretKey

pub struct SecretKey(/* private fields */);

Implementations

impl SecretKey

pub fn new(details: PublicKey, secret_params: SecretParams) -> Self

pub fn from_slice(packet_version: Version, input: &[u8]) -> Result<Self>

Parses a SecretKey packet from the given slice.

pub fn secret_params(&self) -> &SecretParams

pub fn has_sha1_checksum(&self) -> bool

Checks if we should expect a SHA1 checksum in the encrypted part.

pub fn sign<R: CryptoRng + Rng, F>( &self, rng: R, key: &impl SecretKeyTrait, key_pw: F, ) -> Result<Signature>

where F: FnOnce() -> String,

impl SecretKey

pub fn remove_password<P>(&mut self, password: P) -> Result<()>

where P: FnOnce() -> String,

Remove the password protection of the private key material in this secret key packet. This permanently “unlocks” the secret key material.

If the Secret Key material in the packet is not locked, it is left unchanged.

The current locking password for this key must be provided in password.

pub fn set_password<R, P>(&mut self, rng: R, password: P) -> Result<()>

where R: Rng + CryptoRng, P: FnOnce() -> String,

Set a password that “locks” the private key material in this Secret Key packet.

This function uses the default S2K locking mechanism for the key version:

• for V6 keys: Aead with Argon2 derivation,
• for V4 keys: Cfb with iterated and salted derivation of the password.

To change the password on a locked Secret Key packet, it needs to be unlocked using Self::remove_password before calling this function.

pub fn set_password_with_s2k<P>( &mut self, password: P, s2k_params: S2kParams, ) -> Result<()>

where P: FnOnce() -> String,

Set a password that “locks” the private key material in this Secret Key packet using the mechanisms specified in s2k_params.

To change the password on a locked Secret Key packet, it needs to be unlocked using Self::remove_password before calling this function.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<SecretKey> for Packet

fn from(other: SecretKey) -> Packet

Converts to this type from the input type.

impl PacketTrait for SecretKey

fn packet_version(&self) -> Version

fn tag(&self) -> Tag

impl PartialEq for SecretKey

fn eq(&self, other: &SecretKey) -> 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 PublicKeyTrait for SecretKey

fn verify_signature( &self, hash: HashAlgorithm, hashed: &[u8], sig: &SignatureBytes, ) -> Result<()>

Verify a signed message. Data will be hashed using hash, before verifying.

fn encrypt<R: Rng + CryptoRng>( &self, rng: R, plain: &[u8], typ: EskType, ) -> Result<PkeskBytes>

Encrypt the given plain for this key.

fn serialize_for_hashing(&self, writer: &mut impl Write) -> Result<()>

This is the data used for hashing in a signature. Only uses the public portion of the key.

fn public_params(&self) -> &PublicParams

fn version(&self) -> KeyVersion

fn fingerprint(&self) -> Fingerprint

fn key_id(&self) -> KeyId

Returns the Key ID of the associated primary key.

fn algorithm(&self) -> PublicKeyAlgorithm

fn created_at(&self) -> &DateTime<Utc>

fn expiration(&self) -> Option<u16>

fn is_signing_key(&self) -> bool

fn is_encryption_key(&self) -> bool

impl SecretKeyTrait for SecretKey

type PublicKey = PublicKey

type Unlocked = SecretKeyRepr

The type representing the unlocked version of this.

fn unlock<F, G, T>(&self, pw: F, work: G) -> Result<T>

where F: FnOnce() -> String, G: FnOnce(&Self::Unlocked) -> Result<T>,

Unlock the raw data in the secret parameters.

fn create_signature<F>( &self, key_pw: F, hash: HashAlgorithm, data: &[u8], ) -> Result<SignatureBytes>

where F: FnOnce() -> String,

fn public_key(&self) -> PublicKey

fn hash_alg(&self) -> HashAlgorithm

The suggested hash algorithm to calculate the signature hash digest with, when using this key as a signer

impl Serialize for SecretKey

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

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

impl TryFrom<Packet> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for SecretKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for SecretKey

impl StructuralPartialEq for SecretKey