Struct AeadEnvelope 

pub struct AeadEnvelope<Algorithm: AeadAlgorithm, Nonce, Mac, Data> { /* private fields */ }

Authenticated encrypted data with its nonce stored alongside it.

The byte representation for the supported algorithms is nonce || ciphertext || tag.

Implementations

impl<'a, Nonce: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES> + TryFrom<&'a [u8]> + Zeroize, Mac: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES> + TryFrom<&'a [u8]> + Zeroize, Data: Bytes + From<&'a [u8]> + Zeroize> AeadEnvelope<XChaCha20Poly1305Ietf, Nonce, Mac, Data>

pub fn from_bytes(bytes: &'a [u8]) -> Result<Self, Error>

Initializes an AeadEnvelope from nonce || ciphertext || tag.

Errors

Returns an error if bytes is shorter than one nonce plus one authentication tag, or if either field cannot be converted to its target type.

impl<Nonce: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES>, Mac: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES>, Data: Bytes> AeadEnvelope<XChaCha20Poly1305Ietf, Nonce, Mac, Data>

pub fn open<Output: ResizableBytes + NewBytes, SecretKey: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES>>( &self, associated_data: Option<&[u8]>, key: &SecretKey, ) -> Result<Output, Error>

Decrypts this envelope using key and optional associated data.

Errors

Returns an error if the ciphertext exceeds the construction’s maximum length, the output storage has the wrong length, or authentication fails. Authentication fails when the key, associated data, stored nonce, ciphertext, or tag does not match the value used during encryption.

impl AeadEnvelope<XChaCha20Poly1305Ietf, StackByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES>, StackByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES>, Vec<u8>>

pub fn open_to_vec<SecretKey: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES>>( &self, associated_data: Option<&[u8]>, key: &SecretKey, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decrypts this envelope and returns the plaintext as a Vec.

Errors

Returns an error if the ciphertext exceeds the construction’s maximum length or authentication fails because the key, associated data, stored nonce, ciphertext, or tag does not match.

pub fn into_vec(self) -> Vec<u8>

Available on crate feature alloc only.

Consumes this envelope and returns it as nonce || ciphertext || tag.

impl<Nonce: NewByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES> + Zeroize, Mac: NewByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES> + Zeroize, Data: NewBytes + ResizableBytes + Zeroize> AeadEnvelope<XChaCha20Poly1305Ietf, Nonce, Mac, Data>

pub fn seal<Message: Bytes + ?Sized, SecretKey: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES>>( message: &Message, associated_data: Option<&[u8]>, key: &SecretKey, ) -> Result<Self, Error>

Encrypts a message with a generated nonce and stores that nonce with the ciphertext and tag.

Errors

Returns an error if the message exceeds the construction’s maximum length or the output storage does not resize to the message length.

Panics

Panics if the operating system’s random number generator fails.

impl AeadEnvelope<XChaCha20Poly1305Ietf, StackByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES>, StackByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES>, Vec<u8>>

pub fn seal_to_vecbox<Message: Bytes + ?Sized, SecretKey: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES>>( message: &Message, associated_data: Option<&[u8]>, key: &SecretKey, ) -> Result<Self, Error>

Available on crate feature alloc only.

Encrypts a message with a generated nonce and returns a VecEnvelope.

Errors

Returns an error if the message exceeds the construction’s maximum length.

Panics

Panics if the operating system’s random number generator fails.

impl<'a, Nonce: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES> + TryFrom<&'a [u8]> + Zeroize, Mac: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES> + TryFrom<&'a [u8]> + Zeroize, Data: Bytes + From<&'a [u8]> + Zeroize> AeadEnvelope<ChaCha20Poly1305Ietf, Nonce, Mac, Data>

pub fn from_bytes(bytes: &'a [u8]) -> Result<Self, Error>

Initializes an AeadEnvelope from nonce || ciphertext || tag.

Errors

Returns an error if bytes is shorter than one nonce plus one authentication tag, or if either field cannot be converted to its target type.

impl<Nonce: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES>, Mac: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES>, Data: Bytes> AeadEnvelope<ChaCha20Poly1305Ietf, Nonce, Mac, Data>

pub fn open<Output: ResizableBytes + NewBytes, SecretKey: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES>>( &self, associated_data: Option<&[u8]>, key: &SecretKey, ) -> Result<Output, Error>

Decrypts this envelope using key and optional associated data.

Errors

Returns an error if the ciphertext exceeds the construction’s maximum length, the output storage has the wrong length, or authentication fails. Authentication fails when the key, associated data, stored nonce, ciphertext, or tag does not match the value used during encryption.

impl AeadEnvelope<ChaCha20Poly1305Ietf, StackByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES>, StackByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES>, Vec<u8>>

pub fn open_to_vec<SecretKey: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES>>( &self, associated_data: Option<&[u8]>, key: &SecretKey, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decrypts this envelope and returns the plaintext as a Vec.

Errors

Returns an error if the ciphertext exceeds the construction’s maximum length or authentication fails because the key, associated data, stored nonce, ciphertext, or tag does not match.

pub fn into_vec(self) -> Vec<u8>

Available on crate feature alloc only.

Consumes this envelope and returns it as nonce || ciphertext || tag.

impl<Algorithm: AeadAlgorithm, Nonce, Mac, Data> AeadEnvelope<Algorithm, Nonce, Mac, Data>

pub fn from_parts(nonce: Nonce, tag: Mac, data: Data) -> Self

Returns a new AEAD envelope from nonce, tag, and ciphertext data.

pub fn nonce(&self) -> &Nonce

Returns the stored nonce.

pub fn tag(&self) -> &Mac

Returns the authentication tag.

pub fn data(&self) -> &Data

Returns the ciphertext.

pub fn into_parts(self) -> (Nonce, Mac, Data)

Moves the nonce, tag, and ciphertext out of this instance.

impl<Algorithm: AeadAlgorithm, Nonce: Bytes, Mac: Bytes, Data: Bytes> AeadEnvelope<Algorithm, Nonce, Mac, Data>

pub fn to_vec(&self) -> Vec<u8>

Available on crate feature alloc only.

Copies self into a new Vec.

pub fn to_bytes<Output: NewBytes + ResizableBytes>(&self) -> Output

Copies self into the target as nonce || ciphertext || tag, where the nonce and tag are the first nonce-size and tag-size bytes of Nonce and Mac.

Panics

Panics if the nonce or tag is shorter than the algorithm’s size.

Trait Implementations

impl<Algorithm: Clone + AeadAlgorithm, Nonce: Clone, Mac: Clone, Data: Clone> Clone for AeadEnvelope<Algorithm, Nonce, Mac, Data>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Algorithm: Debug + AeadAlgorithm, Nonce: Debug, Mac: Debug, Data: Debug> Debug for AeadEnvelope<Algorithm, Nonce, Mac, Data>

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

Formats the value using the given formatter.

impl<'de, Algorithm: AeadAlgorithm, Nonce, Mac, Data> Deserialize<'de> for AeadEnvelope<Algorithm, Nonce, Mac, Data>

where Nonce: Deserialize<'de>, Mac: Deserialize<'de>, Data: Deserialize<'de>,

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Algorithm: AeadAlgorithm, Nonce: Bytes, Mac: Bytes, Data: Bytes> PartialEq for AeadEnvelope<Algorithm, Nonce, Mac, Data>

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

Equality operator ==.

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

Inequality operator !=.

impl<Algorithm: AeadAlgorithm, Nonce, Mac, Data> Serialize for AeadEnvelope<Algorithm, Nonce, Mac, Data>

where Nonce: Serialize, Mac: Serialize, Data: Serialize,

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Algorithm: AeadAlgorithm, Nonce: Zeroize, Mac: Zeroize, Data: Zeroize> Zeroize for AeadEnvelope<Algorithm, Nonce, Mac, Data>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.