Skip to main content

StreamOpener

Struct StreamOpener 

Source
pub struct StreamOpener { /* private fields */ }
Expand description

Decrypts a stream produced by StreamSealer, one chunk at a time.

You must call finish after the last chunk. Per-chunk authentication catches reordering, duplication, and corruption, but truncation — an attacker dropping the trailing chunks, including the final one — is only detected by finish, which fails with Error::StreamTruncated if it never saw a chunk marked last. A consumer that just loops open_chunk until its input is exhausted and skips finish will silently accept a truncated stream.

Implementations§

Source§

impl StreamOpener

Source

pub fn new(keypair: &KeyPair, header_bytes: &[u8]) -> Result<Self>

Begin decrypting from the stream header bytes.

§Errors

Error::InvalidEnvelope if the header is malformed; version/suite errors for other formats.

Source

pub fn open_chunk(&mut self, frame: &[u8]) -> Result<(Vec<u8>, bool)>

Decrypt one chunk frame. Returns (plaintext, was_last).

§Errors

Error::DecryptionFailed on any authentication failure (including a reordered, duplicated, or spliced chunk); Error::StreamFinished if called after the last chunk.

Source

pub fn finish(self) -> Result<()>

Confirm the stream ended with a final chunk.

§Errors

Error::StreamTruncated if no last chunk was ever seen.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.