Struct crypto_secretbox::SecretBox

pub struct SecretBox<C> { /* private fields */ }

The NaCl crypto_secretbox authenticated symmetric encryption primitive, generic

Implementations

impl<C> SecretBox<C>

pub const KEY_SIZE: usize = 32usize

Size of an XSalsa20Poly1305 key in bytes

pub const NONCE_SIZE: usize = 24usize

Size of an XSalsa20Poly1305 nonce in bytes

pub const TAG_SIZE: usize = 16usize

Size of a Poly1305 tag in bytes

Trait Implementations

impl<C> AeadCore for SecretBox<C>

type NonceSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>, B0>

The length of a nonce.

type TagSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

The maximum length of the nonce.

type CiphertextOverhead = UTerm

The upper bound amount of additional space required to support a ciphertext vs. a plaintext.

fn generate_nonce( rng: impl CryptoRng + RngCore, ) -> GenericArray<u8, Self::NonceSize>

where GenericArray<u8, Self::NonceSize>: Default,

Generate a random nonce for this AEAD algorithm.

impl<C> AeadInPlace for SecretBox<C>

where C: Kdf + KeyIvInit + KeySizeUser<KeySize = U32> + IvSizeUser<IvSize = U8> + StreamCipher,

fn encrypt_in_place( &self, nonce: &Nonce, associated_data: &[u8], buffer: &mut dyn Buffer, ) -> Result<(), Error>

Encrypt the given buffer containing a plaintext message in-place.

fn encrypt_in_place_detached( &self, nonce: &Nonce, associated_data: &[u8], buffer: &mut [u8], ) -> Result<Tag, Error>

Encrypt the data in-place, returning the authentication tag

fn decrypt_in_place( &self, nonce: &Nonce, associated_data: &[u8], buffer: &mut dyn Buffer, ) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext.

fn decrypt_in_place_detached( &self, nonce: &Nonce, associated_data: &[u8], buffer: &mut [u8], tag: &Tag, ) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext (i.e. ciphertext is modified/unauthentic)

impl<C> Clone for SecretBox<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Drop for SecretBox<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C> Kdf for SecretBox<C>

where C: Kdf,

fn kdf(key: &Key, nonce: &GenericArray<u8, U16>) -> Key

Derive a new key from the provided input key and nonce.

impl<C> KeyInit for SecretBox<C>

fn new(key: &Key) -> Self

Create new value from fixed size key.

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidLength>

Create new value from variable size key.

fn generate_key( rng: impl CryptoRng + RngCore, ) -> GenericArray<u8, Self::KeySize>

Generate random key using the provided CryptoRng.

impl<C> KeySizeUser for SecretBox<C>

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.