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 from_bytes(key: [u8; 32]) -> Self

Create a symmetric key from bytes. Useful when it has been serialised.

pub fn into_bytes(self) -> [u8; 32]

Convert the SharedSecretKey into the raw underlying bytes. For anyone who wants to store the symmetric key

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

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 Error in case of a serialisation error.

pub fn encrypt_with_nonce<T: Serialize>(
    &self,
    plaintext: &T,
    nonce: &Nonce
) -> Result<Vec<u8>, Error>

Encrypts serialisable plaintext using authenticated symmetric encryption, with a nonce.

See encrypt.

pub fn encrypt_bytes_with_nonce(
    &self,
    plaintext: &[u8],
    nonce: &Nonce
) -> Result<Vec<u8>, Error>

Encrypts bytestring plaintext using authenticated symmetric encryption, with a nonce.

See encrypt_bytes.

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

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 Error in case of a serialisation error.

pub fn decrypt<T>(&self, ciphertext: &[u8]) -> Result<T, Error> 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 Error 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>, Error>

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 Error in case of a deserialisation error, if the ciphertext is not valid, or if it can not be decrypted.

Trait Implementations

impl Eq for SymmetricKey

impl Default for SymmetricKey

fn default() -> Self

Returns the "default value" for a type.

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 PartialEq<SymmetricKey> 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 Debug for SymmetricKey

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

Formats the value using the given formatter.

impl Serialize for SymmetricKey

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SymmetricKey

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

Deserialize this value from the given Serde deserializer.