Struct Decrypter 

pub struct Decrypter<In>
where
    In: Read,
{ /* private fields */ }

Available on crate feature stream only.

A streaming AES-GCM-SIV 256-bits decrypter.

Implements the Read trait to provide streaming, while internally keeping a buffer of the chunk to decrypt as a single message.

Note: The size of the chunk used must match the chunk size used by the Encrypter. The decryption will fail if there is a mismatch.

Examples

use std::io::BufRead;

let key = get_key();
let decrypter = crypter::stream::Decrypter::new(&key, stdin())
   .expect("Failed to read from stdin");
let reader = std::io::BufReader::new(decrypter);

for line in reader.lines() {
    let line = line.expect("Failed to read from stdin");
    println!("{line}");
}

Implementations

impl<In> Decrypter<In>

where In: Read,

pub fn new<'k, Key>(key: Key, input: In) -> Result<Self>

where Key: Into<&'k Key<Aes256GcmSiv>>,

Creates a new Decrypter using the reader input and a default size DEFAULT_CHUNK decrypted with the cryptographic key key.

Errors

When initializing, the Decrypter will read the first few bytes of input. If any error happens at that stage, this function will fail.

pub fn new_with_password<Password>( password: Password, input: In, ) -> Result<Self>

where Password: AsRef<[u8]>,

Available on crate feature argon only.

Creates a new Decrypter using the reader input and a default size DEFAULT_CHUNK decrypted with the cryptographic key derived from password using Argon2.

Errors

• If the key derivation fails, an InvalidData is returned;
• When initializing, the Decrypter will read the first few bytes of input. If any error happens at that stage, this function will fail.

pub fn with_chunk<'k, Key>(key: Key, input: In, chunk: usize) -> Result<Self>

where Key: Into<&'k Key<Aes256GcmSiv>>,

Creates a new Decrypter using the reader input and a chunk size chunk decrypted with the cryptographic key key.

Errors

• If the value of chunk is less than 32, an InvalidInput is returned.
• When initializing, the Decrypter will read the first few bytes of input. If any error happens at that stage, this function will fail.

pub fn with_chunk_with_password<Password>( password: Password, input: In, chunk: usize, ) -> Result<Self>

where Password: AsRef<[u8]>,

Available on crate feature argon only.

Creates a new Decrypter using the reader input and a chunk size chunk decrypted with the cryptographic key derived from password using Argon2.

Errors

• If the value of chunk is less than 32, an InvalidInput is returned.
• If the key derivation fails, an InvalidData is returned;
• When initializing, the Decrypter will read the first few bytes of input. If any error happens at that stage, this function will fail.

Trait Implementations

impl<In> Read for Decrypter<In>

where In: Read,

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact( &mut self, cursor: BorrowedCursor<'_, u8>, ) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in big-endian order.