Struct abcrypt::Encryptor

source ·

pub struct Encryptor<'m> { /* private fields */ }

Expand description

Encryptor for the abcrypt encrypted data format.

Implementations§

source §

impl<'m> Encryptor<'m>

source

pub fn new( plaintext: &'m impl AsRef<[u8]>, passphrase: impl AsRef<[u8]> ) -> Result<Self>

Available on crate feature alloc only.

Creates a new Encryptor.

This uses the default Argon2 parameters created by Params::default.

Errors

Returns Err if the Argon2 context is invalid.

Examples

let data = b"Hello, world!\n";
let passphrase = "passphrase";

let cipher = Encryptor::new(data, passphrase).unwrap();

source

pub fn with_params( plaintext: &'m impl AsRef<[u8]>, passphrase: impl AsRef<[u8]>, params: Params ) -> Result<Self>

Creates a new Encryptor with the specified Params.

Errors

Returns Err if the Argon2 context is invalid.

Examples

let data = b"Hello, world!\n";
let passphrase = "passphrase";

let params = Params::new(32, 3, 4, None).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params).unwrap();

source

pub fn encrypt(&self, buf: impl AsMut<[u8]>)

Encrypts the plaintext into buf.

Panics

Panics if any of the following are true:

buf and the encrypted data have different lengths.
The buffer has insufficient capacity to store the resulting ciphertext.

Examples

let data = b"Hello, world!\n";
let passphrase = "passphrase";

let params = Params::new(32, 3, 4, None).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params).unwrap();
let mut buf = [u8::default(); 170];
cipher.encrypt(&mut buf);

source

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

Available on crate feature alloc only.

Encrypts the plaintext and into a newly allocated Vec.

Examples

let data = b"Hello, world!\n";
let passphrase = "passphrase";

let params = Params::new(32, 3, 4, None).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params).unwrap();
let ciphertext = cipher.encrypt_to_vec();

source

pub const fn out_len(&self) -> usize

Returns the number of output bytes of the encrypted data.

Examples

let data = b"Hello, world!\n";
let passphrase = "passphrase";

let params = Params::new(32, 3, 4, None).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params).unwrap();
assert_eq!(cipher.out_len(), 170);