Struct snapper_box::crypto::key::EncryptedRootKey

pub struct EncryptedRootKey { /* fields omitted */ }

A RootKey that has been encrypted with an argon2 derivation of a users password

See the RootKey docs for a description of the method used for encryption

Implementations

impl EncryptedRootKey

pub fn decrypt(&self, password: &[u8]) -> Result<RootKey, Error>

Attempts to decrypt the key with the provided password, and provide it as a RootKey

Errors

Will return:

• Error::Argon2Failure if the argon2 key derivation fails
• Error::BadHmac if the hmac verification failed, either due to incorrect password or corruption
• Error::KeyDeserialization if the key fails to deserialize, which really shouldn’t happen

Trait Implementations

impl Clone for EncryptedRootKey

fn clone(&self) -> EncryptedRootKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedRootKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncryptedRootKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for EncryptedRootKey

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 Serialize for EncryptedRootKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.