Struct Encryptor

Source

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

Expand description

Encryptor for the scrypt encrypted data format.

Implementations§

Source §

impl<'m> Encryptor<'m>

Source

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

Creates a new Encryptor.

This uses the recommended scrypt parameters according to the OWASP Password Storage Cheat Sheet created by Params::default.

§Examples

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

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

Source

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

Creates a new Encryptor with the specified Params.

§Examples

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

let params = Params::new(10, 8, 1, Params::RECOMMENDED_LEN).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params);

Source

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

Encrypts the plaintext into buf.

§Panics

Panics if any of the following are true:

buf and the encrypted data have different lengths.
The end of the keystream will be reached with the given data length.

§Examples

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

let params = Params::new(10, 8, 1, Params::RECOMMENDED_LEN).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params);
let mut buf = [u8::default(); 142];
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(10, 8, 1, Params::RECOMMENDED_LEN).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params);
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(10, 8, 1, Params::RECOMMENDED_LEN).unwrap();
let cipher = Encryptor::with_params(data, passphrase, params);
assert_eq!(cipher.out_len(), 142);