Struct secretbox::SecretBox

pub struct SecretBox { /* fields omitted */ }

Methods

impl SecretBox

pub fn new<R>(key: R, cipher: CipherType) -> Option<Self> where
    R: AsRef<[u8]>, 

Creates a new SecretBox instance

Returns None if the passed key is shorter than 32 bytes

pub fn from_random_key<R>(rng: &mut R, cipher: CipherType) -> (Self, [u8; 32]) where
    R: Rng + CryptoRng, 

Creates a new SecretBox instance with a generated key

pub fn seal(&self, message: &[u8], nonce: [u8; 24]) -> Vec<u8>

This function returns an encrypted and authenticated copy of the message. The key and nonce pair must be unique for every message.

pub fn easy_seal(&self, message: &[u8]) -> Vec<u8>

This function works like the above, except that it automatically generates a unique nonce.

pub fn easy_unseal(&self, data: &[u8]) -> Option<Vec<u8>>

This function works like unseal, except that it finds the nonce automatically.

pub fn unseal(&self, data: &[u8], nonce: [u8; 24]) -> Option<Vec<u8>>

This function tries to authenticate and decrypt a box

Trait Implementations

impl Eq for SecretBox

impl Clone for SecretBox

fn clone(&self) -> SecretBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<SecretBox> for SecretBox

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

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

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

This method tests for !=.

impl Copy for SecretBox

impl Debug for SecretBox

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

Formats the value using the given formatter.