tor_keymgr/
lib.rs

1#![cfg_attr(docsrs, feature(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_time_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#![allow(mismatched_lifetime_syntaxes)] // temporary workaround for arti#2060
45//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
46
47// TODO #1645 (either remove this, or decide to have it everywhere)
48#![cfg_attr(not(all(feature = "full", feature = "experimental")), allow(unused))]
49
50// TODO: write more comprehensive documentation when the API is a bit more
51// stable
52
53mod arti_path;
54pub mod config;
55mod err;
56mod key_specifier;
57pub(crate) mod raw;
58#[cfg(any(test, feature = "testing"))]
59pub mod test_utils;
60
61#[cfg(feature = "keymgr")]
62mod keystore;
63#[cfg(feature = "keymgr")]
64mod mgr;
65
66#[cfg(not(feature = "keymgr"))]
67mod dummy;
68
69pub use arti_path::{ArtiPath, DENOTATOR_SEP};
70pub use err::{
71    ArtiPathSyntaxError, Error, KeystoreCorruptionError, KeystoreError, UnknownKeyTypeError,
72    UnrecognizedEntry, UnrecognizedEntryError,
73};
74pub use key_specifier::{
75    ArtiPathError, ArtiPathRange, ArtiPathUnavailableError, CTorKeySpecifier, CTorPath,
76    CTorPathError, InvalidKeyPathComponentValue, KeyCertificateSpecifier, KeyPath, KeyPathError,
77    KeyPathInfo, KeyPathInfoBuilder, KeyPathInfoExtractor, KeyPathPattern, KeySpecifier,
78    KeySpecifierComponent, KeySpecifierComponentViaDisplayFromStr, KeySpecifierPattern,
79};
80#[cfg(feature = "onion-service-cli-extra")]
81pub use raw::{RawEntryId, RawKeystoreEntry};
82
83#[cfg(feature = "keymgr")]
84pub use {
85    keystore::arti::ArtiNativeKeystore,
86    keystore::{Keystore, KeystoreEntryResult},
87    mgr::{KeyMgr, KeyMgrBuilder, KeyMgrBuilderError, KeystoreEntry},
88    ssh_key,
89};
90
91#[cfg(all(feature = "keymgr", feature = "ephemeral-keystore"))]
92pub use keystore::ephemeral::ArtiEphemeralKeystore;
93
94#[cfg(all(feature = "keymgr", feature = "ctor-keystore"))]
95pub use keystore::ctor::{CTorClientKeystore, CTorServiceKeystore};
96
97#[doc(hidden)]
98pub use key_specifier::derive as key_specifier_derive;
99
100pub use tor_key_forge::{
101    EncodableItem, ErasedKey, KeyType, Keygen, KeygenRng, SshKeyAlgorithm, SshKeyData,
102    ToEncodableKey,
103};
104
105derive_deftly::template_export_semver_check! { "0.12.1" }
106
107#[cfg(not(feature = "keymgr"))]
108pub use dummy::*;
109
110/// A boxed [`Keystore`].
111pub(crate) type BoxedKeystore = Box<dyn Keystore>;
112
113#[doc(hidden)]
114pub use {derive_deftly, inventory};
115
116use derive_more::{AsRef, Display, From};
117use serde::{Deserialize, Serialize};
118use std::str::FromStr;
119
120/// A Result type for this crate.
121pub type Result<T> = std::result::Result<T, Error>;
122
123/// An identifier for a particular [`Keystore`] instance.
124//
125// TODO (#1193): restrict the charset of this ID
126#[derive(
127    Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, Display, AsRef,
128)]
129#[serde(transparent)]
130#[non_exhaustive]
131pub struct KeystoreId(String);
132
133impl FromStr for KeystoreId {
134    type Err = Error;
135
136    fn from_str(s: &str) -> Result<Self> {
137        Ok(Self(s.into()))
138    }
139}
140
141/// Specifies which keystores a [`KeyMgr`] operation should apply to.
142#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash, From)]
143#[non_exhaustive]
144pub enum KeystoreSelector<'a> {
145    /// Try to use the keystore with the specified ID.
146    Id(&'a KeystoreId),
147    /// Use the primary key store.
148    #[default]
149    Primary,
150}
tor_keymgr/lib.rs

tor_keymgr/
lib.rs
