1#![cfg_attr(docsrs, feature(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#![allow(clippy::cognitive_complexity)] #![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#![warn(clippy::or_fun_call)]
28#![deny(clippy::print_stderr)]
29#![deny(clippy::print_stdout)]
30#![warn(clippy::rc_buffer)]
31#![deny(clippy::ref_option_ref)]
32#![warn(clippy::semicolon_if_nothing_returned)]
33#![warn(clippy::trait_duplication_in_bounds)]
34#![deny(clippy::unchecked_time_subtraction)]
35#![deny(clippy::unnecessary_wraps)]
36#![warn(clippy::unseparated_literal_suffix)]
37#![deny(clippy::unwrap_used)]
38#![deny(clippy::mod_module_files)]
39#![allow(clippy::let_unit_value)] #![allow(clippy::uninlined_format_args)]
41#![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)] #![allow(clippy::collapsible_if)] #![deny(clippy::unused_async)]
48#![deny(clippy::string_slice)] #![allow(recursion_depth_exceeding_limit)] #![allow(clippy::redundant_field_names)] mod caps;
55mod connect;
56mod err;
57mod isol_map;
58mod keys;
59mod pow;
60mod proto_oneshot;
61mod relay_info;
62mod state;
63
64use std::future::Future;
65use std::sync::{Arc, Mutex, MutexGuard};
66
67use futures::StreamExt as _;
68use futures::stream::BoxStream;
69use tor_rtcompat::SpawnExt as _;
70
71use educe::Educe;
72use tracing::{debug, instrument};
73
74use tor_circmgr::ClientOnionServiceDataTunnel;
75use tor_circmgr::hspool::HsCircPool;
76use tor_circmgr::isolation::StreamIsolation;
77use tor_error::{Bug, internal};
78use tor_hscrypto::pk::HsId;
79use tor_netdir::NetDir;
80use tor_rtcompat::Runtime;
81
82pub use err::FailedAttemptError;
83pub use err::{ConnError, DescriptorError, DescriptorErrorDetail, StartupError};
84pub use keys::{HsClientDescEncKeypairSpecifier, HsClientSecretKeys, HsClientSecretKeysBuilder};
85pub use relay_info::InvalidTarget;
86pub use state::HsClientConnectorConfig;
87
88use err::{IntroPtIndex, rend_pt_identity_for_error};
89use state::{Config, MockableConnectorData, Services};
90
91#[derive(Educe)]
103#[educe(Clone)]
104pub struct HsClientConnector<R: Runtime, D: state::MockableConnectorData = connect::Data> {
105 runtime: R,
107 circpool: Arc<HsCircPool<R>>,
110 services: Arc<Mutex<state::Services<D>>>,
112 mock_for_state: D::MockGlobalState,
114}
115
116impl<R: Runtime> HsClientConnector<R, connect::Data> {
117 pub fn new(
130 runtime: R,
131 circpool: Arc<HsCircPool<R>>,
132 config: &impl HsClientConnectorConfig,
133 housekeeping_prompt: BoxStream<'static, ()>,
134 ) -> Result<Self, StartupError> {
135 let config = Config {
136 retry: config.as_ref().clone(),
137 };
138 let connector = HsClientConnector {
139 runtime,
140 circpool,
141 services: Arc::new(Mutex::new(Services::new(config))),
142 mock_for_state: (),
143 };
144 connector.spawn_housekeeping_task(housekeeping_prompt)?;
145 Ok(connector)
146 }
147
148 #[instrument(skip_all, level = "trace")]
169 pub fn get_or_launch_tunnel<'r>(
170 &'r self,
171 netdir: &'r Arc<NetDir>,
172 hs_id: HsId,
173 secret_keys: HsClientSecretKeys,
174 isolation: StreamIsolation,
175 ) -> impl Future<Output = Result<Arc<ClientOnionServiceDataTunnel>, ConnError>> + Send + Sync + 'r
176 {
177 let isolation = Box::new(isolation);
182 Services::get_or_launch_connection(self, netdir, hs_id, isolation, secret_keys)
183 }
184}
185
186impl<R: Runtime, D: MockableConnectorData> HsClientConnector<R, D> {
187 fn services(&self) -> Result<MutexGuard<Services<D>>, Bug> {
191 self.services
192 .lock()
193 .map_err(|_| internal!("HS connector poisoned"))
194 }
195
196 fn spawn_housekeeping_task(
198 &self,
199 mut prompt: BoxStream<'static, ()>,
200 ) -> Result<(), StartupError> {
201 self.runtime
202 .spawn({
203 let connector = self.clone();
204 let runtime = self.runtime.clone();
205 async move {
206 while let Some(()) = prompt.next().await {
207 let Ok(mut services) = connector.services() else {
208 break;
209 };
210
211 services.run_housekeeping(runtime.now());
213 }
214 debug!("HS connector housekeeping task exiting (EOF on prompt stream)");
215 }
216 })
217 .map_err(|cause| StartupError::Spawn {
218 spawning: "housekeeping task",
219 cause: cause.into(),
220 })
221 }
222}
223
224pub fn supported_hsclient_protocols() -> tor_protover::Protocols {
227 use tor_protover::named::*;
228 [
231 HSINTRO_V3,
232 HSINTRO_RATELIM,
235 HSREND_V3,
236 HSDIR_V3,
237 ]
238 .into_iter()
239 .collect()
240}
241
242#[cfg(test)]
243mod test {
244 #![allow(clippy::bool_assert_comparison)]
246 #![allow(clippy::clone_on_copy)]
247 #![allow(clippy::dbg_macro)]
248 #![allow(clippy::mixed_attributes_style)]
249 #![allow(clippy::print_stderr)]
250 #![allow(clippy::print_stdout)]
251 #![allow(clippy::single_char_pattern)]
252 #![allow(clippy::unwrap_used)]
253 #![allow(clippy::unchecked_time_subtraction)]
254 #![allow(clippy::useless_vec)]
255 #![allow(clippy::needless_pass_by_value)]
256 #![allow(clippy::string_slice)] use super::*;
260
261 #[test]
262 fn protocols() {
263 let pr = supported_hsclient_protocols();
264 let expected = "HSIntro=4-5 HSRend=2 HSDir=2".parse().unwrap();
265 assert_eq!(pr, expected);
266 }
267}