Struct sequoia_openpgp::packet::key::Encrypted

source ·
pub struct Encrypted { /* private fields */ }
Expand description

Secret key material encrypted with a password.

This data structure is used by the SecretKeyMaterial enum.

Implementations§

source§

impl Encrypted

source

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

Creates a new encrypted key object.

source

pub fn s2k(&self) -> &S2K

Returns the key derivation mechanism.

source

pub fn algo(&self) -> SymmetricAlgorithm

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

source

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

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

source

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.

source

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§

source§

impl Clone for Encrypted

source§

fn clone(&self) -> Encrypted

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Encrypted

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Encrypted> for SecretKeyMaterial

source§

fn from(key: Encrypted) -> Self

Converts to this type from the input type.
source§

impl Hash for Encrypted

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Encrypted

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Encrypted

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.