Struct Envelope 

pub struct Envelope { /* private fields */ }

The envelope structure that holds the encrypted data along with the necessary metadata.

Implementations

impl Envelope

pub fn new<B: AsRef<[u8]>>( recipients: &[PublicKey], data: B, data_encryption_key: Option<[u8; 32]>, ) -> Result<Self>

Create a new envelope for the given recipients with the specified data.

Optionally, an already existing data encryption key can be provided. However, if it is not provided, a new one will be created.

pub fn recipients(&self) -> &[Recipient]

Return the list of recipients that can decrypt the data

pub fn ciphertext(&self) -> &[u8]

Return the encrypted data

pub fn decrypt_by_recipient_secret_key( &self, recipient_secret_key: &SecretKey, ) -> Result<Vec<u8>>

Decrypt the envelope using the recipient’s secret key

This method will attempt to decrypt the envelope using each recipient’s capsule until one succeeds. If none succeed, an error is returned.

pub fn decrypt_by_recipient_index( &self, index: usize, recipient_secret_key: &SecretKey, ) -> Result<Vec<u8>>

Decrypt the envelope using the recipient’s index and secret key

This method will attempt to decrypt the envelope using the recipient at the specified index. If the index is out of bounds or the decryption fails, an error is returned

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Envelope

fn deserialize<D>(d: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Envelope

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

Formats the value using the given formatter.

impl Serialize for Envelope

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.