Struct sequoia_openpgp::packet::key::Encrypted

pub struct Encrypted { /* fields omitted */ }

Secret key material encrypted with a password.

This data structure is used by the SecretKeyMaterial enum.

Implementations

impl Encrypted

pub fn new(
    s2k: S2K,
    algo: SymmetricAlgorithm,
    checksum: Option<SecretKeyChecksum>,
    ciphertext: Box<[u8]>
) -> Self

Creates a new encrypted key object.

pub fn s2k(&self) -> &S2K

Returns the key derivation mechanism.

pub fn algo(&self) -> SymmetricAlgorithm

Returns the symmetric algorithm used to encrypt the secret key material.

pub fn checksum(&self) -> Option<SecretKeyChecksum>

Returns the checksum method used to protect the encrypted secret key material, if any.

pub fn ciphertext(&self) -> Result<&[u8]>

Returns the encrypted secret key material.

If the S2K mechanism is not supported by Sequoia, this function will fail. Note that the information is not lost, but stored in the packet. If the packet is serialized again, it is written out.

pub fn decrypt(
    &self,
    pk_algo: PublicKeyAlgorithm,
    password: &Password
) -> Result<Unencrypted>

Decrypts the secret key material using password.

The Encrypted key does not know what kind of key it is, so the public key algorithm is needed to parse the correct number of MPIs.

Trait Implementations

impl Clone for Encrypted

fn clone(&self) -> Encrypted

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Encrypted

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

Formats the value using the given formatter.

impl From<Encrypted> for SecretKeyMaterial

fn from(key: Encrypted) -> Self

Performs the conversion.

impl Hash for Encrypted

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Encrypted> for Encrypted

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Eq for Encrypted