tor_keymgr/
lib.rs
1#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
2#![doc = include_str!("../README.md")]
3#![allow(renamed_and_removed_lints)] #![allow(unknown_lints)] #![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)] #![allow(clippy::uninlined_format_args)]
40#![allow(clippy::significant_drop_in_scrutinee)] #![allow(clippy::result_large_err)] #![allow(clippy::needless_raw_string_hashes)] #![allow(clippy::needless_lifetimes)] #![allow(mismatched_lifetime_syntaxes)] #![cfg_attr(not(all(feature = "full", feature = "experimental")), allow(unused))]
49
50mod 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 ArtiPathRange, ArtiPathUnavailableError, CTorPath, CTorServicePath,
76 InvalidKeyPathComponentValue, KeyCertificateSpecifier, KeyPath, KeyPathError, KeyPathInfo,
77 KeyPathInfoBuilder, KeyPathInfoExtractor, KeyPathPattern, KeySpecifier, KeySpecifierComponent,
78 KeySpecifierComponentViaDisplayFromStr, KeySpecifierPattern,
79};
80#[cfg(feature = "onion-service-cli-extra")]
81#[cfg_attr(docsrs, doc(cfg(feature = "onion-service-cli-extra")))]
82pub use raw::{RawEntryId, RawKeystoreEntry};
83
84#[cfg(feature = "keymgr")]
85#[cfg_attr(docsrs, doc(cfg(feature = "keymgr")))]
86pub use {
87 keystore::arti::ArtiNativeKeystore,
88 keystore::{Keystore, KeystoreEntryResult},
89 mgr::{KeyMgr, KeyMgrBuilder, KeyMgrBuilderError, KeystoreEntry},
90 ssh_key,
91};
92
93#[cfg(all(feature = "keymgr", feature = "ephemeral-keystore"))]
94#[cfg_attr(
95 docsrs,
96 doc(cfg(all(feature = "keymgr", feature = "ephemeral-keystore")))
97)]
98pub use keystore::ephemeral::ArtiEphemeralKeystore;
99
100#[cfg(all(feature = "keymgr", feature = "ctor-keystore"))]
101#[cfg_attr(docsrs, doc(cfg(all(feature = "keymgr", feature = "ctor-keystore"))))]
102pub use keystore::ctor::{CTorClientKeystore, CTorServiceKeystore};
103
104#[doc(hidden)]
105pub use key_specifier::derive as key_specifier_derive;
106
107pub use tor_key_forge::{
108 EncodableItem, ErasedKey, KeyType, Keygen, KeygenRng, SshKeyAlgorithm, SshKeyData,
109 ToEncodableKey,
110};
111
112derive_deftly::template_export_semver_check! { "0.12.1" }
113
114#[cfg(not(feature = "keymgr"))]
115#[cfg_attr(docsrs, doc(cfg(not(feature = "keymgr"))))]
116pub use dummy::*;
117
118pub(crate) type BoxedKeystore = Box<dyn Keystore>;
120
121#[doc(hidden)]
122pub use {derive_deftly, inventory};
123
124use derive_more::{AsRef, Display, From};
125use serde::{Deserialize, Serialize};
126use std::str::FromStr;
127
128pub type Result<T> = std::result::Result<T, Error>;
130
131#[derive(
135 Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize, Display, AsRef,
136)]
137#[serde(transparent)]
138#[non_exhaustive]
139pub struct KeystoreId(String);
140
141impl FromStr for KeystoreId {
142 type Err = Error;
143
144 fn from_str(s: &str) -> Result<Self> {
145 Ok(Self(s.into()))
146 }
147}
148
149#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash, From)]
151#[non_exhaustive]
152pub enum KeystoreSelector<'a> {
153 Id(&'a KeystoreId),
155 #[default]
157 Primary,
158}