Struct EncryptedFile 

pub struct EncryptedFile<S: SimplexSecretBox> { /* private fields */ }

Available on crate feature crypto only.

Async wrapper over a file with SimpleX-SecretBox encryption.

Security

• All bytes returned from read() are unauthenticated until the file is fully read. The caller must never act on streamed content until read() has returned Ok(0). If reading a file returns Err() all previously read data cannot be trusted and must be discarded.

• The caller is responsible to call Self::put_auth_tag manually. The AsyncWrite implementation does its best to write the authentication tag but it can silently fail leaving the file unauthenticated.

Implementations

impl<S: SimplexSecretBox> EncryptedFile<S>

pub async fn create<P: AsRef<Path>>(path: P) -> Result<Self>

pub async fn create_with_args<P: AsRef<Path>>( path: P, crypto_args: FileCryptoArgs, ) -> Result<Self>

pub async fn open<P: AsRef<Path>>( path: P, crypto_args: FileCryptoArgs, ) -> Result<Self>

Note: this call requires write permissions on the file system for Self::prepare_for_overwrite to work. Use Self::open_read_only when write access is not needed or not available.

pub async fn open_read_only<P: AsRef<Path>>( path: P, crypto_args: FileCryptoArgs, ) -> Result<Self>

Opens file in a read-only mode. Self::prepare_for_overwrite will return an IO error.

pub async fn prepare_for_overwrite(&mut self) -> Result<()>

pub fn crypto_args(&self) -> &FileCryptoArgs

pub fn optimal_buf_size(&self) -> usize

pub fn plaintext_size_hint(&self) -> usize

pub async fn put_auth_tag(self) -> Result<()>

Does nothing if auth tag was already written

Trait Implementations

impl<S: SimplexSecretBox> AsyncRead for EncryptedFile<S>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<S: SimplexSecretBox> AsyncWrite for EncryptedFile<S>

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<S: SimplexSecretBox> Drop for EncryptedFile<S>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.