Struct AeadBox 

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

Authenticated encrypted data for a concrete AEAD algorithm.

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

Implementations

impl<Mac: NewByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES> + Zeroize, Data: NewBytes + ResizableBytes + Zeroize> AeadBox<XChaCha20Poly1305Ietf, Mac, Data>

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

Encrypts a message using key, nonce, and optional associated data.

Errors

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

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

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

Initializes an AeadBox from ciphertext || tag.

Errors

Returns an error if bytes is shorter than one authentication tag or the tag cannot be converted to Mac.

impl<Mac: ByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES>, Data: Bytes> AeadBox<XChaCha20Poly1305Ietf, Mac, Data>

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

Decrypts this box using key, nonce, 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, nonce, associated data, ciphertext, or tag does not match the value used during encryption.

impl AeadBox<XChaCha20Poly1305Ietf, StackByteArray<CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES>, Vec<u8>>

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

Available on crate feature alloc only.

Encrypts a message and returns a VecBox.

Errors

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

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

Available on crate feature alloc only.

Decrypts this box 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, nonce, associated data, ciphertext, or tag does not match.

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

Available on crate feature alloc only.

Consumes this box and returns it as ciphertext || tag.

impl<Mac: NewByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES> + Zeroize, Data: NewBytes + ResizableBytes + Zeroize> AeadBox<ChaCha20Poly1305Ietf, Mac, Data>

pub fn encrypt<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES>, SecretKey: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES>>( message: &Message, associated_data: Option<&[u8]>, nonce: &Nonce, key: &SecretKey, ) -> Result<Self, Error>

Encrypts a message using key, nonce, and optional associated data.

Errors

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

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

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

Initializes an AeadBox from ciphertext || tag.

Errors

Returns an error if bytes is shorter than one authentication tag or the tag cannot be converted to Mac.

impl<Mac: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES>, Data: Bytes> AeadBox<ChaCha20Poly1305Ietf, Mac, Data>

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

Decrypts this box using key, nonce, 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, nonce, associated data, ciphertext, or tag does not match the value used during encryption.

impl AeadBox<ChaCha20Poly1305Ietf, StackByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES>, Vec<u8>>

pub fn encrypt_to_vecbox<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES>, SecretKey: ByteArray<CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES>>( message: &Message, associated_data: Option<&[u8]>, nonce: &Nonce, key: &SecretKey, ) -> Result<Self, Error>

Available on crate feature alloc only.

Encrypts a message and returns a VecBox.

Errors

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

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

Available on crate feature alloc only.

Decrypts this box 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, nonce, associated data, ciphertext, or tag does not match.

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

Available on crate feature alloc only.

Consumes this box and returns it as ciphertext || tag.

impl<Algorithm: AeadAlgorithm, Mac, Data> AeadBox<Algorithm, Mac, Data>

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

Returns a new AEAD box from tag and ciphertext data.

pub fn tag(&self) -> &Mac

Returns the authentication tag.

pub fn data(&self) -> &Data

Returns the ciphertext.

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

Moves the tag and ciphertext out of this instance.

impl<Algorithm: AeadAlgorithm, Mac: Bytes, Data: Bytes> AeadBox<Algorithm, 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 ciphertext || tag, where the tag is the first tag-size bytes of Mac.

Panics

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

Trait Implementations

impl<Algorithm: Clone + AeadAlgorithm, Mac: Clone, Data: Clone> Clone for AeadBox<Algorithm, 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, Mac: Debug, Data: Debug> Debug for AeadBox<Algorithm, Mac, Data>

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

Formats the value using the given formatter.

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

where 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, Mac: Bytes, Data: Bytes> PartialEq for AeadBox<Algorithm, Mac, Data>

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

Equality operator ==.

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

Inequality operator !=.

impl<Algorithm: AeadAlgorithm, Mac, Data> Serialize for AeadBox<Algorithm, Mac, Data>

where 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, Mac: Zeroize, Data: Zeroize> Zeroize for AeadBox<Algorithm, 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.