matrix_sdk_crypto_ffi/
error.rs

1#![allow(missing_docs)]
2
3use matrix_sdk_crypto::{
4    store::{CryptoStoreError as InnerStoreError, DehydrationError as InnerDehydrationError},
5    KeyExportError, MegolmError, OlmError, SecretImportError as RustSecretImportError,
6    SignatureError as InnerSignatureError,
7};
8use matrix_sdk_sqlite::OpenStoreError;
9use ruma::{IdParseError, OwnedUserId};
10
11#[derive(Debug, thiserror::Error, uniffi::Error)]
12#[uniffi(flat_error)]
13pub enum KeyImportError {
14    #[error(transparent)]
15    Export(#[from] KeyExportError),
16    #[error(transparent)]
17    CryptoStore(#[from] InnerStoreError),
18    #[error(transparent)]
19    Json(#[from] serde_json::Error),
20}
21
22#[derive(Debug, thiserror::Error, uniffi::Error)]
23#[uniffi(flat_error)]
24pub enum SecretImportError {
25    #[error(transparent)]
26    CryptoStore(#[from] InnerStoreError),
27    #[error(transparent)]
28    Import(#[from] RustSecretImportError),
29}
30
31#[derive(Debug, thiserror::Error, uniffi::Error)]
32#[uniffi(flat_error)]
33pub enum SignatureError {
34    #[error(transparent)]
35    Signature(#[from] InnerSignatureError),
36    #[error(transparent)]
37    Identifier(#[from] IdParseError),
38    #[error(transparent)]
39    CryptoStore(#[from] InnerStoreError),
40    #[error("Unknown device {0} {1}")]
41    UnknownDevice(OwnedUserId, String),
42    #[error("Unknown user identity {0}")]
43    UnknownUserIdentity(String),
44}
45
46#[derive(Debug, thiserror::Error, uniffi::Error)]
47#[uniffi(flat_error)]
48pub enum CryptoStoreError {
49    #[error("Failed to open the store")]
50    OpenStore(#[from] OpenStoreError),
51    #[error(transparent)]
52    CryptoStore(#[from] InnerStoreError),
53    #[error(transparent)]
54    OlmError(#[from] OlmError),
55    #[error(transparent)]
56    Serialization(#[from] serde_json::Error),
57    #[error("The given string is not a valid user ID: source {0}, error {1}")]
58    InvalidUserId(String, IdParseError),
59    #[error(transparent)]
60    Identifier(#[from] IdParseError),
61    #[error(transparent)]
62    DehydrationError(#[from] InnerDehydrationError),
63}
64
65#[derive(Debug, thiserror::Error, uniffi::Error)]
66pub enum DecryptionError {
67    #[error("serialization error: {error}")]
68    Serialization { error: String },
69    #[error("identifier parsing error: {error}")]
70    Identifier { error: String },
71    #[error("megolm error: {error}")]
72    Megolm { error: String },
73    #[error("missing room key: {error}")]
74    MissingRoomKey { error: String, withheld_code: Option<String> },
75    #[error("store error: {error}")]
76    Store { error: String },
77}
78
79impl From<MegolmError> for DecryptionError {
80    fn from(value: MegolmError) -> Self {
81        match value {
82            MegolmError::MissingRoomKey(withheld_code) => Self::MissingRoomKey {
83                error: "Withheld Inbound group session".to_owned(),
84                withheld_code: withheld_code.map(|w| w.as_str().to_owned()),
85            },
86            _ => Self::Megolm { error: value.to_string() },
87        }
88    }
89}
90
91impl From<serde_json::Error> for DecryptionError {
92    fn from(err: serde_json::Error) -> Self {
93        Self::Serialization { error: err.to_string() }
94    }
95}
96
97impl From<IdParseError> for DecryptionError {
98    fn from(err: IdParseError) -> Self {
99        Self::Identifier { error: err.to_string() }
100    }
101}
102
103impl From<InnerStoreError> for DecryptionError {
104    fn from(err: InnerStoreError) -> Self {
105        Self::Store { error: err.to_string() }
106    }
107}
108
109#[cfg(test)]
110mod tests {
111    use assert_matches2::assert_let;
112    use matrix_sdk_crypto::MegolmError;
113
114    use super::DecryptionError;
115
116    #[test]
117    fn test_withheld_error_mapping() {
118        use matrix_sdk_common::deserialized_responses::WithheldCode;
119
120        let inner_error = MegolmError::MissingRoomKey(Some(WithheldCode::Unverified));
121
122        let binding_error: DecryptionError = inner_error.into();
123
124        assert_let!(
125            DecryptionError::MissingRoomKey { error: _, withheld_code: Some(code) } = binding_error
126        );
127        assert_eq!("m.unverified", code)
128    }
129}
matrix_sdk_crypto_ffi/error.rs

matrix_sdk_crypto_ffi/
error.rs
