Struct safe_crypto::SharedSecretKey

pub struct SharedSecretKey { /* fields omitted */ }

Precomputed shared secret key.

Can be created from a pair of our secret key and the recipient's public key. As a result, we'll get the same key as the recipient with their secret key and our public key.

Methods

impl SharedSecretKey

pub fn from_bytes(key: [u8; 32]) -> Self

Construct shared secret key from bytes. Useful when it was serialised before.

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

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

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

Encrypts bytestring plaintext using authenticated encryption.

With authenticated encryption the recipient will be able to verify the authenticity of the sender using a sender's public key. If you want to use anonymous encryption, use the functions provided by PublicKeys and SecretKeys.

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

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

Encrypts serialisable plaintext using authenticated encryption.

With authenticated encryption the recipient will be able to verify the authenticity of the sender using a sender's public key. If you wish to encrypt bytestring plaintext, use encrypt_bytes. If you want to use anonymous encryption, use the functions provided by PublicKeys and SecretKeys.

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

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

Decrypts bytestring encoded encrypted using authenticated encryption.

With authenticated encryption we will be able to verify the authenticity of the sender using a sender's public key.

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.

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

Decrypts serialised ciphertext encrypted using authenticated encryption.

With authenticated encryption we will be able to verify the authenticity of the sender using a sender's public key.

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.

Trait Implementations

impl Eq for SharedSecretKey

impl Clone for SharedSecretKey

fn clone(&self) -> SharedSecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<SharedSecretKey> for SharedSecretKey

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

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

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

This method tests for !=.

impl Debug for SharedSecretKey

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

Formats the value using the given formatter.

impl Serialize for SharedSecretKey

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 SharedSecretKey

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

Deserialize this value from the given Serde deserializer.