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

tor_keymgr/
lib.rs
