Struct serde_encrypted_value::Key

pub struct Key<T> { /* private fields */ }

A key used to encrypt or decrypt values. It represents both an algorithm and a key.

Keys which have been deserialized from a string or file cannot encrypt new values; only freshly created keys have that ability. This is indicated by the type parameter T.

The canonical serialized representation of a Key is a string consisting of an algorithm identifier, followed by a :, followed by the base64 encoded bytes of the key. The Display and FromStr implementations serialize and deserialize in this format.

The only algorithm currently supported is AES 256 GCM, which uses the identifier AES.

Implementations

impl Key<ReadWrite>

pub fn random_aes() -> Result<Key<ReadWrite>>

Creates a random AES key.

pub fn encrypt(&mut self, value: &str) -> Result<String>

Encrypts a string with this key.

impl Key<ReadOnly>

pub fn from_file<P>(path: P) -> Result<Option<Key<ReadOnly>>>

where P: AsRef<Path>,

A convenience function which deserializes a Key from a file.

If the file does not exist, None is returned. Otherwise, the contents of the file are parsed via Key’s FromStr implementation.

impl<T> Key<T>

pub fn decrypt(&self, value: &str) -> Result<String>

Decrypts a string with this key.

Trait Implementations

impl<T> Display for Key<T>

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

Formats the value using the given formatter.

impl FromStr for Key<ReadOnly>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Key<ReadOnly>>

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