Struct EncryptedMessage

pub struct EncryptedMessage<P: Debug + DeserializeOwned + Serialize, C: Config> { /* private fields */ }

Used to safely handle & transport encrypted data within your application. It contains an encrypted payload, along with a nonce & tag that are used in the encryption & decryption processes.

Implementations

impl<P: Debug + DeserializeOwned + Serialize, C: Config> EncryptedMessage<P, C>

pub fn encrypt_with_config( payload: P, config: &C, ) -> Result<Self, EncryptionError>

Creates an EncryptedMessage from a payload, using the AES-256-GCM encryption cipher.

Errors

• Returns an EncryptionError::Serialization error if the payload cannot be serialized into a JSON string. See serde_json::to_vec for more information.

pub fn decrypt_with_config(&self, config: &C) -> Result<P, DecryptionError>

Decrypts the payload of the EncryptedMessage, trying all available keys in order until it finds one that works.

Errors

• Returns a DecryptionError::Base64Decoding error if the base64-decoding of the payload, nonce, or tag fails.
• Returns a DecryptionError::Decryption error if the payload cannot be decrypted with any of the available keys.
• Returns a DecryptionError::Deserialization error if the payload cannot be deserialized into the expected type. See serde_json::from_slice for more information.

impl<P: Debug + DeserializeOwned + Serialize, C: Config + Default> EncryptedMessage<P, C>

pub fn encrypt(payload: P) -> Result<Self, EncryptionError>

This method is a shorthand for EncryptedMessage::encrypt_with_config, passing &C::default() as the configuration.

pub fn decrypt(&self) -> Result<P, DecryptionError>

This method is a shorthand for EncryptedMessage::decrypt_with_config, passing &C::default() as the configuration.

Trait Implementations

impl<P: Debug + Debug + DeserializeOwned + Serialize, C: Debug + Config> Debug for EncryptedMessage<P, C>

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

Formats the value using the given formatter.

impl<'de, P: Debug + DeserializeOwned + Serialize, C: Config> Deserialize<'de> for EncryptedMessage<P, C>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: PartialEq + Debug + DeserializeOwned + Serialize, C: PartialEq + Config> PartialEq for EncryptedMessage<P, C>

fn eq(&self, other: &EncryptedMessage<P, C>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P: Debug + DeserializeOwned + Serialize, C: Config> Serialize for EncryptedMessage<P, C>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: Eq + Debug + DeserializeOwned + Serialize, C: Eq + Config> Eq for EncryptedMessage<P, C>

impl<P: Debug + DeserializeOwned + Serialize, C: Config> StructuralPartialEq for EncryptedMessage<P, C>