Enum EncryptionError 

#[non_exhaustive]
pub enum EncryptionError {
    Operation {
        message: String,
        source: Option<Box<dyn Error + Sync + Send>>,
    },
    InvalidHeader(String),
    Io(Error),
}

Encryption provider — abstracts the encryption operations needed by EncryptedBlobStore.

This trait allows the blob store to work with any encryption backend that supports detached-header stream encryption.

For full documentation see the Encryption guide.

Example (custom provider)

use async_trait::async_trait;
use tokio::io::{AsyncRead, AsyncWrite, AsyncWriteExt, AsyncReadExt};
use xtax_encryption::{EncryptionProvider, EncryptionResult};

struct NoopEncryption;

#[async_trait]
impl EncryptionProvider for NoopEncryption {
    async fn encrypt_stream(
        &self,
        input: &mut (dyn AsyncRead + Send + Unpin),
        output: &mut (dyn AsyncWrite + Send + Unpin),
    ) -> EncryptionResult<Vec<u8>> {
        let mut buf = Vec::new();
        input.read_to_end(&mut buf).await.unwrap();
        output.write_all(&buf).await.unwrap();
        Ok(vec![])
    }

    async fn decrypt_stream(
        &self,
        input: &mut (dyn AsyncRead + Send + Unpin),
        output: &mut (dyn AsyncWrite + Send + Unpin),
        _header_bytes: &[u8],
    ) -> EncryptionResult<()> {
        let mut buf = Vec::new();
        input.read_to_end(&mut buf).await.unwrap();
        output.write_all(&buf).await.unwrap();
        Ok(())
    }

    async fn rekey_header(&self, _header_bytes: &[u8]) -> EncryptionResult<Option<Vec<u8>>> {
        Ok(None)
    }
}

An error returned by EncryptionProvider methods.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Operation

Encrypt or decrypt operation failed.

Fields

message: String

Human-readable description of the failure.

source: Option<Box<dyn Error + Sync + Send>>

Optional underlying cause.

InvalidHeader(String)

Invalid or corrupted header data.

Io(Error)

I/O error during encryption or decryption.

Trait Implementations

impl Debug for EncryptionError

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for EncryptionError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for EncryptionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<EncryptionError> for BlobStorageError

fn from(e: EncryptionError) -> Self

Converts to this type from the input type.

impl From<Error> for EncryptionError

fn from(source: Error) -> EncryptionError

Converts to this type from the input type.