Struct DryocSecretBox 

pub struct DryocSecretBox<Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> { /* private fields */ }

An authenticated secret-key encrypted box, compatible with a libsodium box. Use with either VecBox or protected::LockedBox type aliases.

Refer to crate::dryocsecretbox for sample usage.

Implementations

impl<Mac: NewByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: NewBytes + ResizableBytes + Zeroize> DryocSecretBox<Mac, Data>

pub fn encrypt<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_SECRETBOX_NONCEBYTES>, SecretKey: ByteArray<CRYPTO_SECRETBOX_KEYBYTES>>( message: &Message, nonce: &Nonce, secret_key: &SecretKey, ) -> Result<Self, Error>

Encrypts a message using secret_key and returns a new DryocSecretBox with ciphertext and tag.

Errors

Returns Error::InvalidLength with ErrorContext::Message if message is longer than CRYPTO_SECRETBOX_MESSAGEBYTES_MAX, or with ErrorContext::Ciphertext if Data’s ResizableBytes::resize leaves it shorter than message (storage that cannot grow to the message length).

Panics

Panics if allocation or resizing panics.

impl<'a, Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES> + TryFrom<&'a [u8]> + Zeroize, Data: Bytes + From<&'a [u8]> + Zeroize> DryocSecretBox<Mac, Data>

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

Initializes a DryocSecretBox from a slice. Expects the first CRYPTO_SECRETBOX_MACBYTES bytes to contain the message authentication tag, with the remaining bytes containing the encrypted message.

Errors

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

impl<Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> DryocSecretBox<Mac, Data>

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

Returns a new box with tag and data, consuming both.

pub fn tag(&self) -> &Mac

Returns the authentication tag.

pub fn data(&self) -> &Data

Returns the ciphertext.

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

Available on crate feature alloc only.

Copies self into a new Vec.

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

Moves the tag and data out of this instance, returning them as a tuple.

impl<Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> DryocSecretBox<Mac, Data>

pub fn decrypt<Output: ResizableBytes + NewBytes, Nonce: ByteArray<CRYPTO_SECRETBOX_NONCEBYTES>, SecretKey: ByteArray<CRYPTO_SECRETBOX_KEYBYTES>>( &self, nonce: &Nonce, secret_key: &SecretKey, ) -> Result<Output, Error>

Decrypts this box using secret_key.

Errors

Returns an error if the output storage is shorter than the ciphertext or authentication fails. Authentication fails when the key, nonce, tag, or ciphertext does not match the value used during encryption.

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

Copies self into the target. Can be used with protected memory.

impl DryocSecretBox<Mac, Vec<u8>>

pub fn encrypt_to_vecbox<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_SECRETBOX_NONCEBYTES>, SecretKey: ByteArray<CRYPTO_SECRETBOX_KEYBYTES>>( message: &Message, nonce: &Nonce, secret_key: &SecretKey, ) -> Result<Self, Error>

Available on crate feature alloc only.

Encrypts a message using secret_key and returns a new DryocSecretBox with ciphertext and tag.

Errors

Returns Error::InvalidLength with ErrorContext::Message if message is longer than CRYPTO_SECRETBOX_MESSAGEBYTES_MAX. The Vec storage always resizes, so this is the only error.

pub fn decrypt_to_vec<Nonce: ByteArray<CRYPTO_SECRETBOX_NONCEBYTES>, SecretKey: ByteArray<CRYPTO_SECRETBOX_KEYBYTES>>( &self, nonce: &Nonce, secret_key: &SecretKey, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decrypts this box using secret_key and returns the plaintext.

Errors

Returns an error if authentication fails because the key, nonce, tag, or ciphertext does not match.

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

Available on crate feature alloc only.

Consumes this box and returns tag || ciphertext as a Vec.

Trait Implementations

impl<Mac: Clone + ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Clone + Bytes + Zeroize> Clone for DryocSecretBox<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<Mac: Debug + ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Debug + Bytes + Zeroize> Debug for DryocSecretBox<Mac, Data>

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

Formats the value using the given formatter.

impl<'de, Mac, Data> Deserialize<'de> for DryocSecretBox<Mac, Data>

where Mac: Deserialize<'de> + ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Deserialize<'de> + Bytes + Zeroize,

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<Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> PartialEq for DryocSecretBox<Mac, Data>

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

Equality operator ==.

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

Inequality operator !=.

impl<Mac, Data> Serialize for DryocSecretBox<Mac, Data>

where Mac: Serialize + ByteArray<CRYPTO_SECRETBOX_MACBYTES> + Zeroize, Data: Serialize + Bytes + Zeroize,

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<Mac, Data> Zeroize for DryocSecretBox<Mac, Data>

where Mac: Zeroize + ByteArray<CRYPTO_SECRETBOX_MACBYTES>, Data: Zeroize + Bytes,

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.