Struct SecretKey 

pub struct SecretKey { /* private fields */ }

Implementations

impl SecretKey

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

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

Parses a SecretKey packet from the given buffer.

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 unlock<G, T>(&self, pw: &Password, work: G) -> Result<Result<T>>

where G: FnOnce(&PublicParams, &PlainSecretParams) -> Result<T>,

pub fn public_key(&self) -> &PublicKey

impl SecretKey

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

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>(&mut self, rng: R, password: &Password) -> Result<()>

where R: Rng + CryptoRng,

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( &mut self, password: &Password, s2k_params: S2kParams, ) -> Result<()>

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.

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

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 Imprint for SecretKey

fn imprint<D: KnownDigest>(&self) -> Result<GenericArray<u8, D::OutputSize>>

An imprint is a shorthand identifier for a key.

impl KeyDetails for SecretKey

fn version(&self) -> KeyVersion

fn fingerprint(&self) -> Fingerprint

fn key_id(&self) -> KeyId

fn algorithm(&self) -> PublicKeyAlgorithm

impl PacketTrait for SecretKey

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 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 SecretKeyTrait for SecretKey

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

fn hash_alg(&self) -> HashAlgorithm

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

impl Serialize for SecretKey

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

fn write_len(&self) -> usize

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 Eq for SecretKey

impl StructuralPartialEq for SecretKey