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
153
154
155
156
|
#![allow(clippy::unnecessary_wraps, clippy::extra_unused_type_parameters)]
//! A dummy key manager implementation.
//!
//! This key manager implementation is only used when the `keymgr` feature is disabled.
//!
//! The implementations from this module ignore their arguments. The unused arguments can't be
//! removed, because the dummy implementations must have the same API as their fully-featured
//! counterparts.
use crate::{BoxedKeystore, KeystoreError, KeystoreSelector, Result};
use tor_error::HasKind;
use fs_mistrust::Mistrust;
use std::any::Any;
use std::path::Path;
use std::sync::Arc;
/// A dummy key manager implementation.
///
/// This implementation has the same API as the key manager exposed when the `keymgr` feature is
/// enabled, except all its read operations return `None` and all its write operations will fail.
///
/// For operations that normally involve updating the state of the key manager and/or its
/// underlying storage, such as `insert` or `remove`, this `KeyMgr` always returns an error.
#[derive(derive_builder::Builder)]
#[builder(pattern = "owned")]
#[non_exhaustive]
pub struct KeyMgr {
/// The default key store.
primary_store: BoxedKeystore,
/// The secondary key stores.
#[builder(default, setter(custom))]
secondary_stores: Vec<BoxedKeystore>,
}
// TODO: auto-generate using define_list_builder_accessors/define_list_builder_helper
// when that becomes possible.
//
// See https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1760#note_2969841
impl KeyMgrBuilder {
/// Access the being-built list of secondary stores (resolving default)
///
/// If the field has not yet been set or accessed, the default list will be
/// constructed and a mutable reference to the now-defaulted list of builders
/// will be returned.
pub fn secondary_stores(&mut self) -> &mut Vec<BoxedKeystore> {
self.secondary_stores.get_or_insert(Default::default())
}
/// Set the whole list (overriding the default)
pub fn set_secondary_stores(mut self, list: Vec<BoxedKeystore>) -> Self {
self.secondary_stores = Some(list);
self
}
/// Inspect the being-built list (with default unresolved)
///
/// If the list has not yet been set, or accessed, `&None` is returned.
pub fn opt_secondary_stores(&self) -> &Option<Vec<BoxedKeystore>> {
&self.secondary_stores
}
/// Mutably access the being-built list (with default unresolved)
///
/// If the list has not yet been set, or accessed, `&mut None` is returned.
pub fn opt_secondary_stores_mut(&mut self) -> &mut Option<Vec<BoxedKeystore>> {
&mut self.secondary_stores
}
}
/// A dummy key store trait.
pub trait Keystore: Send + Sync + 'static {
// TODO(gabi): Add the missing functions and impls
}
/// A dummy `ArtiNativeKeystore`.
#[non_exhaustive]
pub struct ArtiNativeKeystore;
/// A dummy `KeyType`.
#[non_exhaustive]
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct KeyType;
impl KeyType {
/// The file extension for a key of this type.
//
// TODO: maybe this function should return an error instead
pub fn arti_extension(&self) -> &'static str {
"dummy_extension"
}
}
/// A dummy `Error` indicating that key manager support is disabled in cargo features.
#[non_exhaustive]
#[derive(Debug, Clone, thiserror::Error)]
#[error("Key manager support disabled in cargo features")]
struct Error;
impl KeystoreError for Error {}
impl HasKind for Error {
fn kind(&self) -> tor_error::ErrorKind {
tor_error::ErrorKind::Other
}
}
impl ArtiNativeKeystore {
/// Create a new [`ArtiNativeKeystore`].
#[allow(clippy::unnecessary_wraps)]
pub fn from_path_and_mistrust(_: impl AsRef<Path>, _: &Mistrust) -> Result<Self> {
Ok(Self)
}
}
impl Keystore for ArtiNativeKeystore {}
/// A dummy `ArtiEphemeralKeystore`.
#[non_exhaustive]
pub struct ArtiEphemeralKeystore;
impl Keystore for ArtiEphemeralKeystore {}
impl ArtiEphemeralKeystore {
/// Create a new [`ArtiEphemeralKeystore`]
#[allow(clippy::unnecessary_wraps)]
pub fn new(_: String) -> Self {
Self
}
}
impl KeyMgr {
/// A dummy `get` implementation that always behaves like the requested key is not found.
///
/// This function always returns `Ok(None)`.
pub fn get<K>(&self, _: &dyn Any) -> Result<Option<K>> {
Ok(None)
}
/// A dummy `insert` implementation that always fails.
///
/// This function always returns an error.
pub fn insert<K>(&self, _: K, _: &dyn Any, _: KeystoreSelector) -> Result<Option<K>> {
Err(crate::Error::Keystore(Arc::new(Error)))
}
/// A dummy `remove` implementation that always fails.
///
/// This function always returns an error.
pub fn remove<K>(&self, _: &dyn Any) -> Result<Option<K>> {
Err(crate::Error::Keystore(Arc::new(Error)))
}
}
inventory::collect!(&'static dyn crate::KeyPathInfoExtractor);
|
