Struct StreamingDecryptingKey 

pub struct StreamingDecryptingKey { /* private fields */ }

A key for streaming decryption operations.

Implementations

impl StreamingDecryptingKey

pub fn update<'a>( &mut self, input: &[u8], output: &'a mut [u8], ) -> Result<BufferUpdate<'a>, Unspecified>

Updates the internal state of the key with the provided ciphertext input, potentially also writing bytes of plaintext to output. The number of bytes written to output can be up to input.len() plus the block length of the cipher algorithm (e.g., Algorithm::block_len) minus one.

Errors

• Returns an error if the output buffer is smaller than the length of the input plus the algorithm’s block length minus one.
• May return an error if the length of input plus the algorithm’s block length is larger than i32::MAX.

pub fn less_safe_update<'a>( &mut self, input: &[u8], output: &'a mut [u8], ) -> Result<BufferUpdate<'a>, Unspecified>

Updates the internal state of the key with the provided ciphertext input, potentially writing bytes of plaintext to output.

This function has looser output buffer size requirements than Self::update, calculating the minimum required size based on the total bytes of output generated and the cipher’s block length. This is considered “less safe” because it’s based on assumptions about the state of the underlying operations.

The minimum output buffer size is calculated based on how many bytes are needed to reach the next block boundary after processing the input. If next_total is the sum of bytes already generated plus input.len(), then the minimum size is: input.len() + ((block_len - (next_total % block_len)) % block_len)

Errors

Returns an error if the output buffer is smaller than the calculated minimum size, if the total output length overflows, or if the length of input is larger than i32::MAX.

Panics

Panics if the number of bytes written by the cipher operation exceeds the output buffer length.

pub fn finish(self, output: &mut [u8]) -> Result<BufferUpdate<'_>, Unspecified>

Finishes the decryption operation, writing the remaining plaintext to output. The number of bytes written to output can be up to the block length of the cipher algorithm (e.g., Algorithm::block_len).

Errors

• Returns an error if the output buffer is smaller than the algorithm’s block length.

pub fn mode(&self) -> OperatingMode

Returns the cipher operating mode.

pub fn algorithm(&self) -> &'static Algorithm

Returns the cipher algorithm

pub fn ctr( key: UnboundCipherKey, context: DecryptionContext, ) -> Result<Self, Unspecified>

Constructs a StreamingDecryptingKey for decrypting using the CTR cipher mode. The resulting plaintext will be the same length as the ciphertext.

Errors

Returns an error on an internal failure.

pub fn cbc_pkcs7( key: UnboundCipherKey, context: DecryptionContext, ) -> Result<Self, Unspecified>

Constructs a StreamingDecryptingKey for decrypting using the CBC cipher mode. The resulting plaintext will be shorter than the ciphertext.

Errors

Returns an error on an internal failure.

pub fn cfb128( key: UnboundCipherKey, context: DecryptionContext, ) -> Result<Self, Unspecified>

The resulting plaintext will be the same length as the ciphertext.

Errors

Returns an error on an internal failure.

pub fn ecb_pkcs7( key: UnboundCipherKey, context: DecryptionContext, ) -> Result<Self, Unspecified>

Constructs a StreamingDecryptingKey for decrypting using the ECB cipher mode. The resulting plaintext will be the same length as the ciphertext.

☠️ ️️️DANGER ☠️

Offered for computability purposes only. This is an extremely dangerous mode, and very likely not what you want to use.

Errors

Returns an error on an internal failure.

Trait Implementations

impl Send for StreamingDecryptingKey