Struct ssb_crypto::secretbox::Key

#[repr(C)]pub struct Key(pub [u8; 32]);

A key used to seal and open an encrypted box.

The underlying memory is zeroed on drop.

Implementations

impl Key

pub const SIZE: usize

The size of a key, in bytes (32).

pub fn from_slice(s: &[u8]) -> Option<Self>

Deserialize a key from a byte slice.

Returns None if the slice length is not 32.

pub fn generate_with_rng<R>(r: &mut R) -> Key where
    R: CryptoRng + RngCore, 

Generate a new random key using the given cryptographically-secure random number generator.

pub fn generate() -> Key

Generate a new random key.

impl Key

pub fn seal(&self, msg: &mut [u8], n: &Nonce) -> Hmac

Encrypt a message in place, returning the authentication code.

#[must_use]pub fn open(&self, c: &mut [u8], hmac: &Hmac, n: &Nonce) -> bool

Decrypt an encrypted message in place.

#[must_use]pub fn open_attached_into(
    &self,
    input: &[u8],
    n: &Nonce,
    out: &mut [u8]
) -> bool

Decrypt an encrypted message with attached authentication code, writing the decrypted message into the provided buffer.

If the decryption fails, out will contain a copy of the encrypted message.

Panics

Panics if the output buffer length isn't big enough to hold the plaintext message. The output buffer length should be at least input.len() - Hmac::SIZE.

pub fn seal_attached_into(&self, msg: &[u8], nonce: &Nonce, out: &mut [u8])

Encrypt a message, writing the resulting Hmac and ciphertext into the given output buffer. The output buffer size must be at least msg.len() + Hmac::SIZE.

Trait Implementations

impl AsBytes for Key

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

fn as_bytes(&self) -> &[u8]

Get the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8] where
    Self: FromBytes, 

Get the bytes of this value mutably.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Key

fn drop(&mut self)

Executes the destructor for this type.

impl FromBytes for Key

fn only_derive_is_allowed_to_implement_this_trait() where
    Self: Sized, 

impl Zeroize for Key

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.