cipherstash-client 0.12.5

The official CipherStash SDK
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use hex::FromHexError;
use miette::Diagnostic;
use recipher::errors::RecipherError;
use static_assertions::assert_impl_all;
use thiserror::Error;
use zerokms_protocol::ViturRequestError;

#[derive(Diagnostic, Error, Debug)]
pub enum CreateDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum GrantDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum RevokeDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum ListDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum EnableDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum DisableDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum ModifyDatasetError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum CreateClientError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum ListClientError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum RevokeClientError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum RetrieveKeyError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
    #[error("Received an invalid number of keys from request. Expected {expected} but received {received}")]
    InvalidNumberOfKeys { expected: usize, received: usize },
}

#[derive(Diagnostic, Error, Debug)]
pub enum GenerateKeyError {
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
    #[error("Failed to generate IV: {0}")]
    GenerateIv(RecipherError),
    #[error("Received an invalid number of keys from request. Expected {expected} but received {received}")]
    InvalidNumberOfKeys { expected: usize, received: usize },
}

#[derive(Diagnostic, Error, Debug)]
pub enum EncryptError {
    #[error("Failed to generate key: {0}")]
    GenerateKey(#[from] GenerateKeyError),
    #[error("Failed to encrypt: {0}")]
    FailedToEncrypt(aes_gcm_siv::Error),
}

#[derive(Diagnostic, Error, Debug)]
pub enum DecryptError {
    #[error("Failed to retrieve key: {0}")]
    RetrieveKey(#[from] RetrieveKeyError),
    #[error("Failed to decrypt: {0}")]
    FailedToDecrypt(aes_gcm_siv::Error),
    #[error("Invalid ciphertext: {0}")]
    InvalidCiphertext(String),
    #[error("Internal error: {0}")]
    Internal(String),
    #[error("Format error: {0}")]
    FormatError(#[from] serde_cbor::Error),
    #[error("Failed to decode hex: {0}")]
    DecodingError(#[from] FromHexError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum SaveConfigError {
    #[error("Failed to generate new root key: {0}")]
    CreateRootKey(RecipherError),
    #[error("Failed to encrypt root key: {0}")]
    EncryptRootKey(EncryptError),
    #[error("Failed to decrypt root key: {0}")]
    DecryptRootKey(DecryptError),
    #[error("Failed to serialize encrypted root key: {0}")]
    SerializeEncryptedRootKey(DecryptError),
    #[error("Failed to deserialize encrypted root key: {0}")]
    DeserializeEncryptedRootKey(DecryptError),
    #[error("Invalid index root key length: {0}")]
    InvalidIndexRootKeySize(usize),
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

#[derive(Diagnostic, Error, Debug)]
pub enum LoadConfigError {
    #[error("Failed to decrypt root key: {0}")]
    DecryptRootKey(#[from] DecryptError),
    #[error("Failed to deserialize encrypted root key: {0}")]
    DeserializeEncryptedRootKey(DecryptError),
    #[error("Invalid index root key length: {0}")]
    InvalidIndexRootKeySize(usize),
    #[error("Failed to send request: {0}")]
    RequestFailed(#[from] ViturRequestError),
}

assert_impl_all!(CreateDatasetError: Send, Sync);
assert_impl_all!(GrantDatasetError: Send, Sync);
assert_impl_all!(RevokeDatasetError: Send, Sync);
assert_impl_all!(ListDatasetError: Send, Sync);
assert_impl_all!(CreateClientError: Send, Sync);
assert_impl_all!(ListClientError: Send, Sync);
assert_impl_all!(RevokeClientError: Send, Sync);
assert_impl_all!(RetrieveKeyError: Send, Sync);
assert_impl_all!(GenerateKeyError: Send, Sync);
assert_impl_all!(EncryptError: Send, Sync);
assert_impl_all!(DecryptError: Send, Sync);
assert_impl_all!(SaveConfigError: Send, Sync);
assert_impl_all!(LoadConfigError: Send, Sync);