Struct dryoc::dryocsecretbox::DryocSecretBox

pub struct DryocSecretBox<Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES>, Data: Bytes> { /* 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>, Data: NewBytes + ResizableBytes> 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
) -> Self

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

impl<'a, Mac: ByteArray<CRYPTO_SECRETBOX_MACBYTES> + TryFrom<&'a [u8]>, Data: Bytes + From<&'a [u8]>> 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.

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

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

Returns a new box with tag and data, consuming both

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

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>, Data: Bytes> 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 ciphertext using secret_key, returning a new DryocSecretBox with decrypted message

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
) -> Self

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

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>

Decrypts ciphertext using secret_key, returning a new DryocSecretBox with decrypted message

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

Consumes this box and returns it as a Vec

impl<'a, Mac: NewByteArray<CRYPTO_SECRETBOX_MACBYTES>, Data: NewBytes + ResizableBytes + From<&'a [u8]>> DryocSecretBox<Mac, Data>

pub fn with_data(input: &'a [u8]) -> Self

Returns a box with data copied from slice input.

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

pub fn with_data_and_mac(tag: Mac, input: &'a [u8]) -> Self

Returns a new box with data and tag, with data copied from input and tag consumed.

Trait Implementations

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

fn clone(&self) -> DryocSecretBox<Mac, Data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Mac: Debug + ByteArray<CRYPTO_SECRETBOX_MACBYTES>, Data: Debug + Bytes> 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>,
    Data: Deserialize<'de> + Bytes,

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<Mac, Data> Serialize for DryocSecretBox<Mac, Data>where
    Mac: Serialize + ByteArray<CRYPTO_SECRETBOX_MACBYTES>,
    Data: Serialize + Bytes,

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.