Struct sequoia_openpgp::packet::key::Unencrypted

pub struct Unencrypted { /* fields omitted */ }

Unencrypted secret key material.

This data structure is used by the SecretKeyMaterial enum.

Unlike an Encrypted key, this key an be used as-is.

The secret key is encrypted in memory and only decrypted on demand. This helps protect against heartbleed-style attacks where a buffer over-read allows an attacker to read from the process's address space. This protection is less important for Rust programs, which are memory safe. However, it is essential when Sequoia is used via its FFI.

See crypto::mem::Encrypted for details.

Implementations

impl Unencrypted

pub fn map<F, T>(&self, fun: F) -> T where
    F: FnMut(&SecretKeyMaterial) -> T, 

Maps the given function over the secret.

pub fn encrypt(&self, password: &Password) -> Result<Encrypted>

Encrypts the secret key material using password.

This encrypts the secret key material using an AES 256 key derived from the password using the default S2K scheme.

Trait Implementations

impl Clone for Unencrypted

fn clone(&self) -> Unencrypted

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unencrypted

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

Formats the value using the given formatter.

impl Eq for Unencrypted

impl From<SecretKeyMaterial> for Unencrypted

fn from(mpis: SecretKeyMaterial) -> Self

Performs the conversion.

impl From<Unencrypted> for SecretKeyMaterial

fn from(key: Unencrypted) -> Self

Performs the conversion.

impl Hash for Unencrypted

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<Unencrypted> for Unencrypted

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

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

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

This method tests for !=.

impl StructuralEq for Unencrypted

impl StructuralPartialEq for Unencrypted