Struct safe_crypto::SymmetricKey

pub struct SymmetricKey { /* fields omitted */ }

Secret key for authenticated symmetric encryption.

Methods

impl SymmetricKey

pub fn new() -> Self

Generates a new symmetric key.

pub fn encrypt<T: Serialize>(     &self,     plaintext: &T ) -> Result<Vec<u8>, EncryptionError>

Encrypts serialisable plaintext using authenticated symmetric encryption.

With authenticated encryption the recipient will be able to confirm that the message is untampered with. If you wish to encrypt bytestring plaintext, use encrypt_bytes.

Returns ciphertext in case of success. Can return an EncryptionError in case of a serialisation error.

pub fn encrypt_bytes(     &self,     plaintext: &[u8] ) -> Result<Vec<u8>, EncryptionError>

Encrypts bytestring plaintext using authenticated symmetric encryption.

With authenticated encryption the recipient will be able to confirm that the message is untampered with.

Returns ciphertext in case of success. Can return an EncryptionError in case of a serialisation error.

pub fn decrypt<T>(&self, ciphertext: &[u8]) -> Result<T, EncryptionError> where     T: DeserializeOwned + Serialize,

Decrypts serialised ciphertext encrypted using authenticated symmetric encryption.

With authenticated encryption we will be able to tell that the message hasn't been tampered with.

Returns deserialised type T in case of success. Can return EncryptionError in case of a deserialisation error, if the ciphertext is not valid, or if it can not be decrypted.

pub fn decrypt_bytes(     &self,     ciphertext: &[u8] ) -> Result<Vec<u8>, EncryptionError>

Decrypts bytestring ciphertext encrypted using authenticated symmetric encryption.

With authenticated encryption we will be able to tell that the message hasn't been tampered with.

Returns plaintext in case of success. Can return EncryptionError in case of a deserialisation error, if the ciphertext is not valid, or if it can not be decrypted.

Trait Implementations

impl Debug for SymmetricKey

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

Formats the value using the given formatter.

impl PartialEq for SymmetricKey

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

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

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

This method tests for !=.

impl Eq for SymmetricKey

impl Clone for SymmetricKey

fn clone(&self) -> SymmetricKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SymmetricKey

fn default() -> Self

Returns the "default value" for a type.