Struct PasswordProtectedKeyEnvelope 

pub struct PasswordProtectedKeyEnvelope { /* private fields */ }

A password-protected key envelope can seal a symmetric key, and protect it with a password. It does so by using a Key Derivation Function (KDF), to increase the difficulty of brute-forcing the password.

The KDF parameters such as iterations and salt are stored in the envelope and do not have to be provided.

Internally, Argon2 is used as the KDF and XChaCha20-Poly1305 is used to encrypt the key.

Implementations

impl PasswordProtectedKeyEnvelope

pub fn seal<Ids: KeySlotIds>( key_to_seal: Ids::Symmetric, password: &str, namespace: PasswordProtectedKeyEnvelopeNamespace, ctx: &KeyStoreContext<'_, Ids>, ) -> Result<Self, PasswordProtectedKeyEnvelopeError>

Seals a symmetric key with a password, using the current default KDF parameters and a random salt.

This should never fail, except for memory allocation error, when running the KDF.

pub fn unseal<Ids: KeySlotIds>( &self, password: &str, namespace: PasswordProtectedKeyEnvelopeNamespace, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<Ids::Symmetric, PasswordProtectedKeyEnvelopeError>

Unseals a symmetric key from the password-protected envelope, and stores it in the key store context.

pub fn reseal( &self, password: &str, new_password: &str, namespace: PasswordProtectedKeyEnvelopeNamespace, ) -> Result<Self, PasswordProtectedKeyEnvelopeError>

Re-seals the key with new KDF parameters (updated settings, salt), and a new password

pub fn contained_key_id( &self, ) -> Result<Option<KeyId>, PasswordProtectedKeyEnvelopeError>

Get the key ID of the contained key, if the key ID is stored on the envelope headers. Only COSE keys have a key ID, legacy keys do not.

Trait Implementations

impl Clone for PasswordProtectedKeyEnvelope

fn clone(&self) -> PasswordProtectedKeyEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordProtectedKeyEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PasswordProtectedKeyEnvelope

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PasswordProtectedKeyEnvelope> for Vec<u8>

fn from(val: &PasswordProtectedKeyEnvelope) -> Self

Converts to this type from the input type.

impl From<PasswordProtectedKeyEnvelope> for String

fn from(val: PasswordProtectedKeyEnvelope) -> Self

Converts to this type from the input type.

impl FromStr for PasswordProtectedKeyEnvelope

type Err = PasswordProtectedKeyEnvelopeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for PasswordProtectedKeyEnvelope

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Vec<u8>> for PasswordProtectedKeyEnvelope

type Error = CoseError

The type returned in the event of a conversion error.

fn try_from(value: &Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.