1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
//! A relay binary use to join the Tor network to relay anonymous communication.
//!
//! NOTE: This binary is still highly experimental as in in active development, not stable and
//! without any type of guarantee of running or even working.
// @@ begin lint list maintained by maint/add_warning @@
#![allow(renamed_and_removed_lints)] // @@REMOVE_WHEN(ci_arti_stable)
#![allow(unknown_lints)] // @@REMOVE_WHEN(ci_arti_nightly)
#![warn(missing_docs)]
#![warn(noop_method_call)]
#![warn(unreachable_pub)]
#![warn(clippy::all)]
#![deny(clippy::await_holding_lock)]
#![deny(clippy::cargo_common_metadata)]
#![deny(clippy::cast_lossless)]
#![deny(clippy::checked_conversions)]
#![warn(clippy::cognitive_complexity)]
#![deny(clippy::debug_assert_with_mut_call)]
#![deny(clippy::exhaustive_enums)]
#![deny(clippy::exhaustive_structs)]
#![deny(clippy::expl_impl_clone_on_copy)]
#![deny(clippy::fallible_impl_from)]
#![deny(clippy::implicit_clone)]
#![deny(clippy::large_stack_arrays)]
#![warn(clippy::manual_ok_or)]
#![deny(clippy::missing_docs_in_private_items)]
#![warn(clippy::needless_borrow)]
#![warn(clippy::needless_pass_by_value)]
#![warn(clippy::option_option)]
#![deny(clippy::print_stderr)]
#![deny(clippy::print_stdout)]
#![warn(clippy::rc_buffer)]
#![deny(clippy::ref_option_ref)]
#![warn(clippy::semicolon_if_nothing_returned)]
#![warn(clippy::trait_duplication_in_bounds)]
#![deny(clippy::unchecked_duration_subtraction)]
#![deny(clippy::unnecessary_wraps)]
#![warn(clippy::unseparated_literal_suffix)]
#![deny(clippy::unwrap_used)]
#![deny(clippy::mod_module_files)]
#![allow(clippy::let_unit_value)] // This can reasonably be done for explicitness
#![allow(clippy::uninlined_format_args)]
#![allow(clippy::significant_drop_in_scrutinee)] // arti/-/merge_requests/588/#note_2812945
#![allow(clippy::result_large_err)] // temporary workaround for arti#587
#![allow(clippy::needless_raw_string_hashes)] // complained-about code is fine, often best
#![allow(clippy::needless_lifetimes)] // See arti#1765
#![allow(mismatched_lifetime_syntaxes)] // temporary workaround for arti#2060
//! <!-- @@ end lint list maintained by maint/add_warning @@ -->
mod cli;
mod config;
mod err;
mod relay;
use std::io::IsTerminal as _;
use anyhow::Context;
use clap::Parser;
use safelog::with_safe_logging_suppressed;
use tor_rtcompat::{PreferredRuntime, Runtime};
use tracing_subscriber::filter::EnvFilter;
use tracing_subscriber::util::SubscriberInitExt;
use tracing_subscriber::FmtSubscriber;
use crate::config::{base_resolver, TorRelayConfig, DEFAULT_LOG_LEVEL};
use crate::relay::TorRelay;
fn main() {
// Will exit if '--help' used or there's a parse error.
let cli = cli::Cli::parse();
if let Err(e) = main_main(cli) {
// TODO: Use arti_client's `HintableError` here (see `arti::main`)?
// TODO: Why do we suppress safe logging, and squash the anyhow result into a single line?
// TODO: Do we want to log the error?
with_safe_logging_suppressed(|| tor_error::report_and_exit::<_, ()>(e));
}
}
/// The real main without the error formatting.
fn main_main(cli: cli::Cli) -> anyhow::Result<()> {
// Register a basic stderr logger until we have enough info to configure the main logger.
// Unlike arti, we enable timestamps for this pre-config logger.
// TODO: Consider using timestamps with reduced-granularity (see `LogPrecision`).
let level: tracing::metadata::Level = cli
.global
.log_level
.map(Into::into)
.unwrap_or(DEFAULT_LOG_LEVEL);
let filter = EnvFilter::builder()
.with_default_directive(level.into())
.parse("")
.expect("empty filter directive should be trivially parsable");
#[allow(clippy::print_stderr)]
FmtSubscriber::builder()
.with_env_filter(filter)
.with_ansi(std::io::stderr().is_terminal())
.with_writer(|| {
eprint!("arti-relay: ");
std::io::stderr()
})
.finish()
.init();
match cli.command {
#[allow(clippy::print_stdout)]
cli::Commands::BuildInfo => {
println!("Version: {}", env!("CARGO_PKG_VERSION"));
// these are set by our build script
println!("Features: {}", env!("BUILD_FEATURES"));
println!("Profile: {}", env!("BUILD_PROFILE"));
println!("Debug: {}", env!("BUILD_DEBUG"));
println!("Optimization level: {}", env!("BUILD_OPT_LEVEL"));
println!("Rust version: {}", env!("BUILD_RUSTC_VERSION"));
println!("Target triple: {}", env!("BUILD_TARGET"));
println!("Host triple: {}", env!("BUILD_HOST"));
}
cli::Commands::Run(args) => start_relay(args, cli.global)?,
}
Ok(())
}
/// Initialize and start the relay.
// Pass by value so that we don't need to clone fields, which keeps the code simpler.
#[allow(clippy::needless_pass_by_value)]
fn start_relay(_args: cli::RunArgs, global_args: cli::GlobalArgs) -> anyhow::Result<()> {
let runtime = init_runtime().context("Failed to initialize the runtime")?;
let mut cfg_sources = global_args
.config()
.context("Failed to get configuration sources")?;
// A Mistrust object to use for loading our configuration.
// Elsewhere, we use the value _from_ the configuration.
let cfg_mistrust = if global_args.disable_fs_permission_checks {
fs_mistrust::Mistrust::new_dangerously_trust_everyone()
} else {
fs_mistrust::MistrustBuilder::default()
// By default, a `Mistrust` checks an environment variable.
// We do not (at the moment) want this behaviour for relays:
// https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/2699#note_3147502
.ignore_environment()
.build()
.expect("default fs-mistrust should be buildable")
};
cfg_sources.set_mistrust(cfg_mistrust);
let cfg = cfg_sources
.load()
.context("Failed to load configuration sources")?;
let config =
tor_config::resolve::<TorRelayConfig>(cfg).context("Failed to resolve configuration")?;
// TODO: Configure a proper logger, not just a simple stderr logger.
// TODO: We may want this to be the global logger, but if we use arti's `setup_logging` in the
// future, it returns a `LogGuards` which we'd have no way of holding on to until the
// application exits (see https://gitlab.torproject.org/tpo/core/arti/-/issues/1791).
let filter = EnvFilter::builder()
.parse(&config.logging.console)
.with_context(|| {
format!(
"Failed to parse console logging directive {:?}",
config.logging.console,
)
})?;
#[allow(clippy::print_stderr)]
let logger = tracing_subscriber::FmtSubscriber::builder()
.with_env_filter(filter)
.with_ansi(std::io::stderr().is_terminal())
.with_writer(|| {
eprint!("arti-relay: ");
std::io::stderr()
})
.finish();
let logger = tracing::Dispatch::new(logger);
tracing::dispatcher::with_default(&logger, || {
let path_resolver = base_resolver();
let relay =
TorRelay::new(runtime, &config, path_resolver).context("Failed to initialize relay")?;
run_relay(relay)
})?;
Ok(())
}
/// Run the relay.
#[allow(clippy::unnecessary_wraps)] // TODO: not implemented yet; remove me
fn run_relay<R: Runtime>(_relay: TorRelay<R>) -> anyhow::Result<()> {
Ok(())
}
/// Initialize a runtime.
///
/// Any commands that need a runtime should call this so that we use a consistent runtime.
fn init_runtime() -> std::io::Result<impl Runtime> {
// Use the tokio runtime from tor_rtcompat unless we later find a reason to use tokio directly;
// see https://gitlab.torproject.org/tpo/core/arti/-/work_items/1744
PreferredRuntime::create()
}
|
