cipherstash-dynamodb 0.8.3

CipherStash SDK for searchable, in-use encryption for DynamoDB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use aws_sdk_dynamodb::{error::SdkError, operation};
use miette::Diagnostic;
use thiserror::Error;

use crate::traits::PrimaryKeyError;
pub use crate::{
    crypto::{CryptoError, SealError},
    traits::{ReadConversionError, WriteConversionError},
};

pub use cipherstash_client::{
    config::errors::ConfigError, encryption::EncryptionError, zerokms::Error as ZeroKmsError,
};

pub use aws_sdk_dynamodb::error::BuildError;

/// Error returned by `EncryptedTable::put` when indexing, encrypting and inserting records into DynamoDB
#[derive(Error, Debug, Diagnostic)]
pub enum PutError {
    #[error("PrimaryKeyError: {0}")]
    PrimaryKeyError(#[from] PrimaryKeyError),
    // TODO: Get rid of this, too?
    #[error("AwsBuildError: {0}")]
    AwsBuildError(#[from] BuildError),
    #[error("Write Conversion Error: {0}")]
    WriteConversion(#[from] WriteConversionError),
    #[error("SealError: {0}")]
    Seal(#[from] SealError),
    #[error("CryptoError: {0}")]
    Crypto(#[from] CryptoError),
    #[error("Encryption Error: {0}")]
    Encryption(#[from] EncryptionError),

    #[error(transparent)]
    DynamoError(#[from] SdkError<operation::transact_write_items::TransactWriteItemsError>),
}

/// Error returned by `EncryptedTable::get` when retrieving and decrypting records from DynamoDB
#[derive(Error, Debug, Diagnostic)]
pub enum GetError {
    #[error(transparent)]
    PrimaryKeyError(#[from] PrimaryKeyError),
    #[error(transparent)]
    DecryptError(#[from] DecryptError),
    #[error(transparent)]
    Encryption(#[from] EncryptionError),
    #[error("AwsError: {0}")]
    Aws(String),
}

/// Error returned by `EncryptedTable::delete` when indexing and deleting records in DynamoDB
#[derive(Error, Debug, Diagnostic)]
pub enum DeleteError {
    #[error("PrimaryKeyError: {0}")]
    PrimaryKeyError(#[from] PrimaryKeyError),
    #[error("Encryption Error: {0}")]
    Encryption(#[from] EncryptionError),
    #[error("AwsBuildError: {0}")]
    AwsBuildError(#[from] BuildError),
    #[error("AwsError: {0}")]
    Aws(String),
}

/// Error returned by `EncryptedTable::query` when indexing, retrieving and decrypting records from DynamoDB
#[derive(Error, Debug, Diagnostic)]
pub enum DecryptError {
    #[error("ReadConversionError: {0}")]
    ReadConversionError(#[from] ReadConversionError),
    #[error("SealError: {0}")]
    SealError(#[from] SealError),
}

/// Error returned by [`crate::EncryptedTable::query`] when indexing, retrieving and decrypting records from DynamoDB
#[derive(Error, Debug, Diagnostic)]
pub enum QueryError {
    #[error("PrimaryKeyError: {0}")]
    PrimaryKeyError(#[from] PrimaryKeyError),
    #[error("InvaldQuery: {0}")]
    InvalidQuery(String),
    #[error("CryptoError: {0}")]
    CryptoError(#[from] CryptoError),
    #[error("EncryptionError: {0}")]
    EncryptionError(#[from] EncryptionError),
    #[error("Decrypt Error: {0}")]
    DecryptError(#[from] DecryptError),
    #[error("{0}")]
    Other(String),

    #[error(transparent)]
    DynamoError(#[from] SdkError<operation::query::QueryError>),
}

pub trait DynamoError: std::error::Error + Sized {}

/// Error returned by `EncryptedTable::init` when connecting to CipherStash services
#[derive(Error, Debug, Diagnostic)]
pub enum InitError {
    #[error("ConfigError: {0}")]
    Config(#[from] ConfigError),
    #[error(transparent)]
    ZeroKmsError(#[from] ZeroKmsError),
}

/// The [`enum@Error`] type abstracts all errors returned by `cipherstash-dynamodb` for easy use with the `?` operator.
#[derive(Error, Debug, Diagnostic)]
pub enum Error {
    #[error("InitError: {0}")]
    InitError(#[from] InitError),
    #[error("PutError: {0}")]
    PutError(#[from] PutError),
    #[error("GetError: {0}")]
    GetError(#[from] GetError),
    #[error("DeleteError: {0}")]
    DeleteError(#[from] DeleteError),
    #[error(transparent)]
    QueryError(#[from] QueryError),
}