tor_keymgr/
lib.rs

1#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
2#![doc = include_str!("../README.md")]
3// @@ begin lint list maintained by maint/add_warning @@
4#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)
5#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)
6#![warn(missing_docs)]
7#![warn(noop_method_call)]
8#![warn(unreachable_pub)]
9#![warn(clippy::all)]
10#![deny(clippy::await_holding_lock)]
11#![deny(clippy::cargo_common_metadata)]
12#![deny(clippy::cast_lossless)]
13#![deny(clippy::checked_conversions)]
14#![warn(clippy::cognitive_complexity)]
15#![deny(clippy::debug_assert_with_mut_call)]
16#![deny(clippy::exhaustive_enums)]
17#![deny(clippy::exhaustive_structs)]
18#![deny(clippy::expl_impl_clone_on_copy)]
19#![deny(clippy::fallible_impl_from)]
20#![deny(clippy::implicit_clone)]
21#![deny(clippy::large_stack_arrays)]
22#![warn(clippy::manual_ok_or)]
23#![deny(clippy::missing_docs_in_private_items)]
24#![warn(clippy::needless_borrow)]
25#![warn(clippy::needless_pass_by_value)]
26#![warn(clippy::option_option)]
27#![deny(clippy::print_stderr)]
28#![deny(clippy::print_stdout)]
29#![warn(clippy::rc_buffer)]
30#![deny(clippy::ref_option_ref)]
31#![warn(clippy::semicolon_if_nothing_returned)]
32#![warn(clippy::trait_duplication_in_bounds)]
33#![deny(clippy::unchecked_duration_subtraction)]
34#![deny(clippy::unnecessary_wraps)]
35#![warn(clippy::unseparated_literal_suffix)]
36#![deny(clippy::unwrap_used)]
37#![deny(clippy::mod_module_files)]
38#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
39#![allow(clippy::uninlined_format_args)]
40#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
41#![allow(clippy::result_large_err)] // temporary workaround for arti#587
42#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
43#![allow(clippy::needless_lifetimes)] // See arti#1765
44//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
45
46// TODO: write more comprehensive documentation when the API is a bit more
47// stable
48
49mod arti_path;
50pub mod config;
51mod err;
52mod key_specifier;
53#[cfg(any(test, feature = "testing"))]
54pub mod test_utils;
55
56#[cfg(feature = "keymgr")]
57mod keystore;
58#[cfg(feature = "keymgr")]
59mod mgr;
60
61#[cfg(not(feature = "keymgr"))]
62mod dummy;
63
64pub use arti_path::{ArtiPath, DENOTATOR_SEP};
65pub use err::{
66    ArtiPathSyntaxError, Error, KeystoreCorruptionError, KeystoreError, UnknownKeyTypeError,
67};
68pub use key_specifier::{
69    ArtiPathRange, ArtiPathUnavailableError, CTorPath, CTorServicePath,
70    InvalidKeyPathComponentValue, KeyCertificateSpecifier, KeyPath, KeyPathError, KeyPathInfo,
71    KeyPathInfoBuilder, KeyPathInfoExtractor, KeyPathPattern, KeySpecifier, KeySpecifierComponent,
72    KeySpecifierComponentViaDisplayFromStr, KeySpecifierPattern,
73};
74
75#[cfg(feature = "keymgr")]
76#[cfg_attr(docsrs, doc(cfg(feature = "keymgr")))]
77pub use {
78    keystore::arti::ArtiNativeKeystore,
79    keystore::Keystore,
80    mgr::{KeyMgr, KeyMgrBuilder, KeyMgrBuilderError, KeystoreEntry},
81    ssh_key,
82};
83
84#[cfg(all(feature = "keymgr", feature = "ephemeral-keystore"))]
85#[cfg_attr(
86    docsrs,
87    doc(cfg(all(feature = "keymgr", feature = "ephemeral-keystore")))
88)]
89pub use keystore::ephemeral::ArtiEphemeralKeystore;
90
91#[cfg(all(feature = "keymgr", feature = "ctor-keystore"))]
92#[cfg_attr(docsrs, doc(cfg(all(feature = "keymgr", feature = "ctor-keystore"))))]
93pub use keystore::ctor::{CTorClientKeystore, CTorServiceKeystore};
94
95#[doc(hidden)]
96pub use key_specifier::derive as key_specifier_derive;
97
98pub use tor_key_forge::{
99    EncodableItem, ErasedKey, KeyType, Keygen, KeygenRng, SshKeyAlgorithm, SshKeyData,
100    ToEncodableKey,
101};
102
103derive_deftly::template_export_semver_check! { "0.12.1" }
104
105#[cfg(not(feature = "keymgr"))]
106#[cfg_attr(docsrs, doc(cfg(not(feature = "keymgr"))))]
107pub use dummy::*;
108
109/// A boxed [`Keystore`].
110pub(crate) type BoxedKeystore = Box<dyn Keystore>;
111
112#[doc(hidden)]
113pub use {derive_deftly, inventory};
114
115use derive_more::{AsRef, Display, From};
116use serde::{Deserialize, Serialize};
117use std::str::FromStr;
118
119/// A Result type for this crate.
120pub type Result<T> = std::result::Result<T, Error>;
121
122/// An identifier for a particular [`Keystore`] instance.
123//
124// TODO (#1193): restrict the charset of this ID
125#[derive(
126    Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, Display, AsRef,
127)]
128#[serde(transparent)]
129#[non_exhaustive]
130pub struct KeystoreId(String);
131
132impl FromStr for KeystoreId {
133    type Err = Error;
134
135    fn from_str(s: &str) -> Result<Self> {
136        Ok(Self(s.into()))
137    }
138}
139
140/// Specifies which keystores a [`KeyMgr`] operation should apply to.
141#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash, From)]
142#[non_exhaustive]
143pub enum KeystoreSelector<'a> {
144    /// Try to use the keystore with the specified ID.
145    Id(&'a KeystoreId),
146    /// Use the primary key store.
147    #[default]
148    Primary,
149}
tor_keymgr/lib.rs

tor_keymgr/
lib.rs
