Struct hacl::aead::Aead

pub struct Aead { /* private fields */ }

The Aead struct allows to re-use a key without having to initialize it every time.

Implementations

impl Aead

pub fn new(alg: Algorithm, k: &[u8]) -> Result<Self, Error>

Create a new Aead cipher with the given Algorithm alg and key k. If the algorithm is not supported or the state generation fails, this function returns an Error.

To get an Aead instance without setting a key immediately see init.

pub fn init(mode: Algorithm) -> Result<Self, Error>

Initialize a new Aead object without a key. Use set_key to do so later.

pub fn set_key(self, k: &[u8]) -> Result<Self, Error>

Set the key for this instance. This consumes the Aead and returns a new instance with the key.

pub fn set_random_key(&mut self) -> Result<(), Error>

Generate a new random key for this instance. This consumes the Aead and returns a new instance with the key.

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

Generate a random key.

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

Generate a nonce.

pub const fn nonce_size(&self) -> usize

Get the nonce size of this Aead in bytes.

pub const fn key_size(&self) -> usize

Get the key size of this Aead in bytes.

pub const fn tag_size(&self) -> usize

Get the tag size of this Aead in bytes.

pub fn encrypt( &self, msg: &[u8], iv: &[u8], aad: &Aad, ) -> Result<(Ciphertext, Vec<u8>), Error>

Encrypt with the algorithm and key of this Aead. Returns (ctxt, tag) or an Error.

pub fn encrypt_combined( &self, msg: &[u8], iv: &[u8], aad: &Aad, ) -> Result<Ciphertext, Error>

Encrypt with the algorithm and key of this Aead. Returns (ctxt || tag) or an Error. This is more efficient if the tag needs to be appended to the cipher text.

pub fn encrypt_in_place( &self, payload: &mut [u8], iv: &[u8], aad: &Aad, ) -> Result<Vec<u8>, Error>

Encrypt with the algorithm and key of this Aead. Returns the cipher text in the payload and a tag or an Error.

pub fn decrypt( &self, ctxt: &[u8], tag: &[u8], iv: &[u8], aad: &Aad, ) -> Result<Vec<u8>, Error>

Decrypt with the algorithm and key of this Aead. Returns msg or an Error.

pub fn decrypt_combined( &self, ctxt: &[u8], iv: &[u8], aad: &Aad, ) -> Result<Vec<u8>, Error>

Decrypt with the algorithm and key of this Aead. Returns msg or an Error. This takes the combined ctxt || tag as input and might be more efficient than decrypt.

pub fn decrypt_in_place( &self, payload: &mut [u8], tag: &[u8], iv: &[u8], aad: &Aad, ) -> Result<(), Error>

Decrypt with the algorithm and key of this Aead.

Returns an Error if decryption failed. The decrypted payload is written into payload.

Trait Implementations

impl Drop for Aead

fn drop(&mut self)

Executes the destructor for this type.