Struct DryocBox 

pub struct DryocBox<EphemeralPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: ByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> { /* private fields */ }

A libsodium public-key authenticated encrypted box.

Refer to crate::dryocbox for sample usage.

Implementations

impl<EphemeralPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: NewByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: NewBytes + ResizableBytes + Zeroize> DryocBox<EphemeralPublicKey, Mac, Data>

pub fn encrypt<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, RecipientPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SenderSecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( message: &Message, nonce: &Nonce, recipient_public_key: &RecipientPublicKey, sender_secret_key: &SenderSecretKey, ) -> Result<Self, Error>

Encrypts a message using sender_secret_key for recipient_public_key, and returns a new DryocBox with ciphertext and tag.

Errors

Returns an error if the message is too long, recipient_public_key is an unacceptable low-order key, or the output storage does not resize to the message length.

pub fn precalc_encrypt<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, PrecalcSecretKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize>( message: &Message, nonce: &Nonce, precalc_secret_key: &PrecalcSecretKey, ) -> Result<Self, Error>

Encrypts a message using precalc_secret_key, and returns a new DryocBox with ciphertext and tag.

Errors

Returns an error if the message is too long or the output storage does not resize to the message length.

impl<EphemeralPublicKey: NewByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: NewByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: NewBytes + ResizableBytes + Zeroize> DryocBox<EphemeralPublicKey, Mac, Data>

pub fn seal<Message: Bytes + ?Sized, RecipientPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>>( message: &Message, recipient_public_key: &RecipientPublicKey, ) -> Result<Self, Error>

Encrypts a message for recipient_public_key, using an ephemeral secret key and nonce. Returns a new DryocBox with ciphertext, tag, and ephemeral public key.

Errors

Returns an error if the message is too long, recipient_public_key is an unacceptable low-order key, or the output storage does not resize to the message length.

Panics

Panics if the operating system’s random number generator fails while creating the ephemeral keypair.

impl<'a, EphemeralPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + TryFrom<&'a [u8]> + Zeroize, Mac: ByteArray<CRYPTO_BOX_MACBYTES> + TryFrom<&'a [u8]> + Zeroize, Data: Bytes + From<&'a [u8]> + Zeroize> DryocBox<EphemeralPublicKey, Mac, Data>

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

Initializes a DryocBox from a slice. Expects the first CRYPTO_BOX_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.

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

Initializes a sealed DryocBox from a slice. Expects the first CRYPTO_BOX_PUBLICKEYBYTES bytes to contain the ephemeral public key, the next CRYPTO_BOX_MACBYTES bytes to be the message authentication tag, with the remaining bytes containing the encrypted message.

Errors

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

impl<EphemeralPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: ByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> DryocBox<EphemeralPublicKey, Mac, Data>

pub fn from_parts( ephemeral_pk: Option<EphemeralPublicKey>, tag: Mac, data: Data, ) -> Self

Returns a new box from the (optional) ephemeral_pk, tag, and data, consuming each. The order matches the wire format of DryocBox::to_bytes.

pub fn ephemeral_pk(&self) -> Option<&EphemeralPublicKey>

Returns the ephemeral public key of a sealed box, or None for a regular box.

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) -> (Option<EphemeralPublicKey>, Mac, Data)

Moves the (optional) ephemeral public key, tag, and data out of this instance, returning them as a tuple in wire order.

pub fn decrypt<Output: ResizableBytes + NewBytes, Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, SenderPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, RecipientSecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( &self, nonce: &Nonce, sender_public_key: &SenderPublicKey, recipient_secret_key: &RecipientSecretKey, ) -> Result<Output, Error>

Decrypts this box using nonce, recipient_secret_key, and sender_public_key, returning the decrypted message upon success.

Errors

Returns an error if the ciphertext is too long, sender_public_key is an unacceptable low-order key, the output storage has the wrong length, or authentication fails. Authentication fails for a wrong key, nonce, tag, or ciphertext.

pub fn precalc_decrypt<Output: ResizableBytes + NewBytes, Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, PrecalcSecretKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize>( &self, nonce: &Nonce, precalc_secret_key: &PrecalcSecretKey, ) -> Result<Output, Error>

Decrypts this box using nonce and precalc_secret_key, returning the decrypted message upon success.

Errors

Returns an error if the ciphertext is too long, the output storage has the wrong length, or authentication fails because the precomputed key, nonce, tag, or ciphertext does not match.

pub fn open<Output: ResizableBytes + NewBytes + Zeroize, RecipientPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, RecipientSecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES> + Zeroize>( &self, recipient_keypair: &KeyPair<RecipientPublicKey, RecipientSecretKey>, ) -> Result<Output, Error>

Decrypts this sealed box using recipient_keypair.

Errors

Returns an error if the ciphertext is too long, the box has no ephemeral public key, that key is an unacceptable low-order key, the output storage has the wrong length, or authentication fails. Authentication fails for the wrong recipient key pair or modified box data.

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

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

impl DryocBox<PublicKey, Mac, Vec<u8>>

pub fn encrypt_to_vecbox<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, RecipientPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, SenderSecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( message: &Message, nonce: &Nonce, recipient_public_key: &RecipientPublicKey, sender_secret_key: &SenderSecretKey, ) -> Result<Self, Error>

Available on crate feature alloc only.

Encrypts a message using sender_secret_key for recipient_public_key, and returns a new DryocBox with ciphertext and tag.

Errors

Returns an error if the message is too long or recipient_public_key is an unacceptable low-order key.

pub fn precalc_encrypt_to_vecbox<Message: Bytes + ?Sized, Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, PrecalcSecretKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize>( message: &Message, nonce: &Nonce, precalc_secret_key: &PrecalcSecretKey, ) -> Result<Self, Error>

Available on crate feature alloc only.

Encrypts a message using precalc_secret_key, and returns a new DryocBox with ciphertext and tag.

Errors

Returns an error if the message is too long or the output storage cannot hold the ciphertext.

pub fn seal_to_vecbox<Message: Bytes + ?Sized, RecipientPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>>( message: &Message, recipient_public_key: &RecipientPublicKey, ) -> Result<Self, Error>

Available on crate feature alloc only.

Encrypts a message for recipient_public_key, using an ephemeral secret key and nonce, and returns a new DryocBox with the ciphertext, ephemeral public key, and tag.

Errors

Returns an error if the message is too long or recipient_public_key is an unacceptable low-order key.

Panics

Panics if the operating system’s random number generator fails while creating the ephemeral keypair.

pub fn decrypt_to_vec<Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, SenderPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES>, RecipientSecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES>>( &self, nonce: &Nonce, sender_public_key: &SenderPublicKey, recipient_secret_key: &RecipientSecretKey, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decrypts this box using nonce, recipient_secret_key and sender_public_key, returning the decrypted message upon success.

Errors

Returns an error if the ciphertext is too long, sender_public_key is an unacceptable low-order key, or authentication fails because a key, nonce, tag, or ciphertext is wrong.

pub fn precalc_decrypt_to_vec<Nonce: ByteArray<CRYPTO_BOX_NONCEBYTES>, PrecalcSecretKey: ByteArray<CRYPTO_BOX_BEFORENMBYTES> + Zeroize>( &self, nonce: &Nonce, precalc_secret_key: &PrecalcSecretKey, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decrypts this box using nonce and precalc_secret_key, returning the decrypted message upon success.

Errors

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

pub fn open_to_vec<RecipientPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, RecipientSecretKey: ByteArray<CRYPTO_BOX_SECRETKEYBYTES> + Zeroize>( &self, recipient_keypair: &KeyPair<RecipientPublicKey, RecipientSecretKey>, ) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Decrypts this sealed box using recipient_keypair.

Errors

Returns an error if the ciphertext is too long, the box has no ephemeral public key, that key is an unacceptable low-order key, or authentication fails because the recipient key pair or box data is wrong.

Trait Implementations

impl<EphemeralPublicKey: Clone + ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: Clone + ByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: Clone + Bytes + Zeroize> Clone for DryocBox<EphemeralPublicKey, 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<EphemeralPublicKey: Debug + ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: Debug + ByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: Debug + Bytes + Zeroize> Debug for DryocBox<EphemeralPublicKey, Mac, Data>

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

Formats the value using the given formatter.

impl<'de, EphemeralPublicKey, Mac, Data> Deserialize<'de> for DryocBox<EphemeralPublicKey, Mac, Data>

where EphemeralPublicKey: Deserialize<'de> + ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: Deserialize<'de> + ByteArray<CRYPTO_BOX_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<EphemeralPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: ByteArray<CRYPTO_BOX_MACBYTES> + Zeroize, Data: Bytes + Zeroize> PartialEq for DryocBox<EphemeralPublicKey, Mac, Data>

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

Equality operator ==.

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

Inequality operator !=.

impl<EphemeralPublicKey, Mac, Data> Serialize for DryocBox<EphemeralPublicKey, Mac, Data>

where EphemeralPublicKey: Serialize + ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac: Serialize + ByteArray<CRYPTO_BOX_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<EphemeralPublicKey: ByteArray<CRYPTO_BOX_PUBLICKEYBYTES> + Zeroize, Mac, Data> Zeroize for DryocBox<EphemeralPublicKey, Mac, Data>

where Mac: Zeroize + ByteArray<CRYPTO_BOX_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.