Struct noise_protocol::CipherState

pub struct CipherState<C: Cipher> { /* private fields */ }

A CipherState can encrypt and decrypt data.

Mostly like CipherState in the spec, but must be created with a key.

Panics

Encryption and decryption methods will panic if nonce reaches maximum u64, i.e., 2 ^ 64 - 1.

Implementations

impl<C> CipherState<C>where
    C: Cipher,

pub fn name() -> &'static str

Name of cipher, e.g. “ChaChaPoly”.

pub fn new(key: &[u8], n: u64) -> Self

Create a new CipherState with a key and a nonce n.

pub fn rekey(&mut self)

Rekey. Set our key to REKEY(old key).

pub fn encrypt_ad(&mut self, authtext: &[u8], plaintext: &[u8], out: &mut [u8])

AEAD encryption.

pub fn decrypt_ad(
    &mut self,
    authtext: &[u8],
    ciphertext: &[u8],
    out: &mut [u8]
) -> Result<(), ()>

AEAD decryption.

pub fn encrypt(&mut self, plaintext: &[u8], out: &mut [u8])

Encryption.

pub fn encrypt_vec(&mut self, plaintext: &[u8]) -> Vec<u8>

Encryption, returns ciphertext as Vec<u8>.

pub fn decrypt(&mut self, ciphertext: &[u8], out: &mut [u8]) -> Result<(), ()>

Decryption.

pub fn decrypt_vec(&mut self, ciphertext: &[u8]) -> Result<Vec<u8>, ()>

Decryption, returns plaintext as Vec<u8>.

pub fn get_next_n(&self) -> u64

Get the next value of n. Could be used to decide on whether to re-key, etc.

pub fn extract(self) -> (C::Key, u64)

Get underlying cipher and nonce.

This is useful for e.g. WireGuard. Because packets may be lost or arrive out of order, they would likely want to deal with nonces themselves.

Trait Implementations

impl<C> Clone for CipherState<C>where
    C: Cipher,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.