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
|
//! An error type for the `tor-keymgr` crate.
use tor_error::HasKind;
use dyn_clone::DynClone;
use std::error::Error as StdError;
use std::fmt;
use std::sync::Arc;
/// An Error type for this crate.
#[derive(thiserror::Error, Debug, Clone)]
#[non_exhaustive]
pub enum Error {
/// Detected keustore corruption.
#[error("{0}")]
Corruption(#[from] KeystoreCorruptionError),
/// An opaque error returned by a [`Keystore`](crate::Keystore).
#[error("{0}")]
Keystore(#[from] Arc<dyn KeystoreError>),
/// An internal error.
#[error("Internal error")]
Bug(#[from] tor_error::Bug),
}
/// An error returned by a [`Keystore`](crate::Keystore).
pub trait KeystoreError:
HasKind + StdError + DynClone + fmt::Debug + fmt::Display + Send + Sync + 'static
{
}
impl HasKind for Error {
fn kind(&self) -> tor_error::ErrorKind {
use tor_error::ErrorKind as EK;
use Error as E;
match self {
E::Keystore(e) => e.kind(),
E::Corruption(_) => EK::KeystoreCorrupted,
E::Bug(e) => e.kind(),
}
}
}
/// An error caused by an invalid [`ArtiPath`](crate::ArtiPath).
#[derive(thiserror::Error, Debug, Copy, Clone)]
#[error("Invalid ArtiPath")]
#[non_exhaustive]
pub enum ArtiPathError {
/// Found an empty path component.
#[error("Empty path component")]
EmptyPathComponent,
/// The path contains a disallowed char.
#[error("Found disallowed char {0}")]
DisallowedChar(char),
/// The path contains the `..` pattern.
#[error("Found `..` pattern")]
PathTraversal,
/// The path starts with a disallowed char.
#[error("Path starts or ends with disallowed char {0}")]
BadOuterChar(char),
/// The path contains an invalid key denotator.
///
/// See the [`ArtiPath`](crate::ArtiPath) docs for more information.
InvalidDenotator,
}
/// An error caused by keystore corruption.
#[derive(thiserror::Error, Debug, Copy, Clone)]
#[error("Keystore corruption")]
#[non_exhaustive]
pub enum KeystoreCorruptionError {
/// A keystore contains a key that has an invalid [`ArtiPath`](crate::ArtiPath).
#[error("{0}")]
ArtiPath(#[from] ArtiPathError),
}
#[cfg(test)]
mod tests {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_duration_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
use super::*;
use tor_error::ErrorKind;
#[derive(Debug, Copy, Clone, PartialEq, thiserror::Error)]
#[error("The source of a test error")]
struct TestErrorSource;
#[derive(Debug, Clone, thiserror::Error)]
#[error("A test error")]
struct TestError(#[from] TestErrorSource);
impl KeystoreError for TestError {}
impl HasKind for TestError {
fn kind(&self) -> ErrorKind {
ErrorKind::Other
}
}
#[test]
fn error_source() {
let e: Error = (Arc::new(TestError(TestErrorSource)) as Arc<dyn KeystoreError>).into();
assert_eq!(
e.source().unwrap().to_string(),
TestError(TestErrorSource).to_string()
);
}
}
|
