tor_hsservice/
internal_prelude.rs

1//! Imports used internally within this crate
2//!
3//! This file contains most of the imports we wish to use, throughout this crate.
4//!
5//! Every module does `use crate::internal_prelude::*;`
6//!
7//! Exceptions:
8//!
9//!  * Names that are private to a module and its submodules (eg, `publish`)
10//!    are imported to the sub-modules via `use super::*`.
11//!    (Thus, the sub-module inherits the prelude from its parent.)
12//!
13//!  * Broad names from specific contexts, that are unsuitable for wide imports.
14//!    For example, individual cell and message names from `tor-cell`,
15//!    and the types from `tor_proto::client::stream` other than the high-level `DataStream`.
16
17//---------- std ----------
18
19pub(crate) use {
20    std::any::Any,
21    std::borrow::Cow,
22    std::cmp::Ordering,
23    std::cmp::max,
24    std::collections::{BinaryHeap, HashMap, HashSet, VecDeque},
25    std::error::Error as StdError,
26    std::ffi::OsStr,
27    std::fmt::{self, Debug, Display},
28    std::fs,
29    std::fs::{File, OpenOptions},
30    std::future::Future,
31    std::hash::Hash,
32    std::io,
33    std::io::{BufReader, BufWriter, Read, Seek, SeekFrom, Write},
34    std::iter,
35    std::marker::PhantomData,
36    std::panic::AssertUnwindSafe,
37    std::path::{Path, PathBuf},
38    std::str::FromStr,
39    std::sync::{Arc, Mutex, MutexGuard},
40};
41
42//---------- upstreams ----------
43
44pub(crate) use {
45    async_trait::async_trait,
46    derive_builder::Builder,
47    derive_deftly::{Deftly, define_derive_deftly},
48    derive_more::{Constructor, Deref, DerefMut, Into},
49    educe::Educe,
50    futures::channel::mpsc,
51    futures::future::{self, Either},
52    futures::select_biased,
53    futures::stream::BoxStream,
54    futures::task::SpawnError,
55    futures::{AsyncRead, AsyncWrite, Stream},
56    futures::{FutureExt as _, SinkExt as _, StreamExt as _, TryStreamExt as _},
57    itertools::{Itertools as _, chain},
58    postage::{broadcast, watch},
59    rand_core::CryptoRng,
60    serde::{Deserialize, Deserializer, Serialize, Serializer},
61    thiserror::Error,
62    tor_rtcompat::SpawnExt as _,
63    tracing::{debug, error, info, trace, warn},
64    void::{ResultVoidErrExt as _, Void},
65};
66
67//---------- tor-* crates ----------
68
69pub(crate) use {
70    oneshot_fused_workaround as oneshot,
71    retry_error::RetryError,
72    safelog::{DisplayRedacted as _, Redactable as _},
73    tor_async_utils::mpsc_channel_no_memquota,
74    tor_async_utils::{DropNotifyWatchSender, PostageWatchSenderExt as _},
75    tor_basic_utils::{PathExt as _, RngExt as _, impl_debug_hex, retry::RetryDelay},
76    tor_cell::relaycell::{RelayMsg as _, msg::AnyRelayMsg},
77    tor_circmgr::hspool::HsCircPool,
78    tor_config::{ConfigBuildError, Reconfigure, ReconfigureError},
79    tor_dirclient::request::HsDescUploadRequest,
80    tor_dirclient::{Error as DirClientError, RequestFailedError, send_request},
81    tor_error::define_asref_dyn_std_error,
82    tor_error::{Bug, ErrorKind, ErrorReport as _, HasKind},
83    tor_error::{bad_api_usage, internal, into_bad_api_usage, into_internal},
84    tor_error::{debug_report, error_report, info_report, warn_report},
85    tor_hscrypto::RevisionCounter,
86    tor_hscrypto::ope::AesOpeKey,
87    tor_hscrypto::pk::{
88        HsBlindId, HsBlindIdKey, HsBlindIdKeypair, HsClientDescEncKey, HsDescSigningKeypair,
89        HsIdKey, HsIdKeypair, HsIntroPtSessionIdKey, HsIntroPtSessionIdKeypair, HsSvcNtorKeypair,
90    },
91    tor_hscrypto::time::TimePeriod,
92    tor_keymgr::{
93        KeyMgr, KeySpecifier, KeySpecifierComponentViaDisplayFromStr, KeySpecifierPattern as _,
94        KeystoreSelector, derive_deftly_template_KeySpecifier,
95        {ArtiPathRange, KeySpecifierComponent},
96    },
97    tor_linkspec::{CircTarget, HasRelayIds as _, OwnedCircTarget, RelayIds},
98    tor_llcrypto::pk::{curve25519, ed25519},
99    tor_log_ratelim::log_ratelim,
100    tor_netdir::{HsDirParams, NetDirProvider, Relay, Timeliness},
101    tor_netdoc::NetdocBuilder,
102    tor_netdoc::doc::hsdesc::{HsDescBuilder, create_desc_sign_key_cert},
103    tor_persist::slug::Slug,
104    tor_persist::state_dir::{
105        ContainsInstanceStateGuard as _, InstanceRawSubdir, LockFileGuard, StateDirectory,
106    },
107    tor_proto::MetaCellDisposition,
108    tor_proto::client::stream::DataStream,
109    tor_rtcompat::SleepProvider,
110    tor_rtcompat::{Runtime, SleepProviderExt as _},
111    web_time_compat::{Duration, Instant, SystemTime},
112};
113
114//---------- names from this crate ----------
115
116pub(crate) use {
117    crate::OnionServiceConfig,
118    crate::StartupError,
119    crate::StreamRequest,
120    crate::err::IptStoreError,
121    crate::err::StateExpiryError,
122    crate::ipt_lid::{InvalidIptLocalId, IptLocalId},
123    crate::ipt_mgr::IptManager,
124    crate::ipt_set::IptSet,
125    crate::ipt_set::IptsManagerView,
126    crate::ipt_set::IptsPublisherUploadView,
127    crate::ipt_set::IptsPublisherView,
128    crate::ipt_set::{self, PublishIptSet},
129    crate::keys::expire_publisher_keys,
130    crate::keys::{IptKeyRole, IptKeySpecifier, IptKeySpecifierPattern},
131    crate::publish::Publisher,
132    crate::replay::IptReplayLog,
133    crate::replay::ReplayError,
134    crate::status::PublisherStatusSender,
135    crate::status::State,
136    crate::status::{IptMgrStatusSender, State as IptMgrState},
137    crate::status::{OnionServiceStatus, OnionServiceStatusStream, StatusSender},
138    crate::time_store,
139    crate::timeout_track::{TrackingInstantOffsetNow, TrackingNow, Update as _},
140    crate::{
141        BlindIdKeypairSpecifier, DescSigningKeypairSpecifier, HsIdKeypairSpecifier,
142        HsIdPublicKeySpecifier,
143    },
144    crate::{
145        ClientError,
146        keys::BlindIdKeypairSpecifierPattern,
147        rend_handshake::{self, RendCircConnector},
148    },
149    crate::{DescUploadError, IptError},
150    crate::{FatalError, RendRequest},
151    crate::{HsNickname, LinkSpecs, NtorPublicKey, req::RendRequestContext},
152    crate::{ShutdownStatus, ipt_establish},
153    ipt_establish::{IptEstablisher, IptParameters, IptStatus, IptStatusStatus, IptWantsToRetire},
154};
tor_hsservice/internal_prelude.rs

tor_hsservice/
internal_prelude.rs
