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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
#![doc = include_str!("../README.md")]
#![cfg_attr(not(ci_arti_stable), allow(renamed_and_removed_lints))]
#![cfg_attr(not(ci_arti_nightly), allow(unknown_lints))]
#![deny(missing_docs)]
#![warn(noop_method_call)]
#![deny(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)]
#![deny(clippy::missing_panics_doc)]
#![warn(clippy::needless_borrow)]
#![warn(clippy::needless_pass_by_value)]
#![warn(clippy::option_option)]
#![warn(clippy::rc_buffer)]
#![deny(clippy::ref_option_ref)]
#![warn(clippy::semicolon_if_nothing_returned)]
#![warn(clippy::trait_duplication_in_bounds)]
#![deny(clippy::unnecessary_wraps)]
#![warn(clippy::unseparated_literal_suffix)]
#![deny(clippy::unwrap_used)]
#![allow(clippy::let_unit_value)] #![allow(clippy::uninlined_format_args)]
#![allow(clippy::significant_drop_in_scrutinee)] #![allow(clippy::result_large_err)] #![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
pub mod cfg;
pub mod logging;
#[cfg(all(feature = "experimental-api", feature = "dns-proxy"))]
pub mod dns;
#[cfg(feature = "experimental-api")]
pub mod exit;
#[cfg(feature = "experimental-api")]
pub mod process;
#[cfg(feature = "experimental-api")]
pub mod reload_cfg;
#[cfg(feature = "experimental-api")]
pub mod socks;
#[cfg(all(not(feature = "experimental-api"), feature = "dns-proxy"))]
mod dns;
#[cfg(not(feature = "experimental-api"))]
mod exit;
#[cfg(not(feature = "experimental-api"))]
mod process;
#[cfg(not(feature = "experimental-api"))]
mod reload_cfg;
#[cfg(not(feature = "experimental-api"))]
mod socks;
use std::ffi::OsString;
use std::fmt::Write;
pub use cfg::{
ApplicationConfig, ApplicationConfigBuilder, ArtiCombinedConfig, ArtiConfig, ArtiConfigBuilder,
ProxyConfig, ProxyConfigBuilder, SystemConfig, SystemConfigBuilder, ARTI_EXAMPLE_CONFIG,
};
pub use logging::{LoggingConfig, LoggingConfigBuilder};
use arti_client::config::default_config_files;
use arti_client::{TorClient, TorClientConfig};
use safelog::with_safe_logging_suppressed;
use tor_config::ConfigurationSources;
use tor_rtcompat::{BlockOn, Runtime};
use anyhow::{Context, Error, Result};
use clap::{value_parser, Arg, ArgAction, Command};
#[allow(unused_imports)]
use tracing::{error, info, warn};
type PinnedFuture<T> = std::pin::Pin<Box<dyn futures::Future<Output = T>>>;
fn create_runtime() -> std::io::Result<impl Runtime> {
cfg_if::cfg_if! {
if #[cfg(all(feature="tokio", feature="native-tls"))] {
use tor_rtcompat::tokio::TokioNativeTlsRuntime as ChosenRuntime;
} else if #[cfg(all(feature="tokio", feature="rustls"))] {
use tor_rtcompat::tokio::TokioRustlsRuntime as ChosenRuntime;
} else if #[cfg(all(feature="async-std", feature="native-tls"))] {
use tor_rtcompat::async_std::AsyncStdNativeTlsRuntime as ChosenRuntime;
} else if #[cfg(all(feature="async-std", feature="rustls"))] {
use tor_rtcompat::async_std::AsyncStdRustlsRuntime as ChosenRuntime;
} else {
compile_error!("You must configure both an async runtime and a TLS stack. See doc/TROUBLESHOOTING.md for more.");
}
}
ChosenRuntime::create()
}
fn list_enabled_features() -> &'static [&'static str] {
&[
#[cfg(feature = "journald")]
"journald",
#[cfg(feature = "static-sqlite")]
"static-sqlite",
#[cfg(feature = "static-native-tls")]
"static-native-tls",
]
}
#[cfg_attr(feature = "experimental-api", visibility::make(pub))]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental-api")))]
async fn run<R: Runtime>(
runtime: R,
socks_port: u16,
dns_port: u16,
config_sources: ConfigurationSources,
arti_config: ArtiConfig,
client_config: TorClientConfig,
) -> Result<()> {
use arti_client::BootstrapBehavior::OnDemand;
use futures::FutureExt;
#[cfg(all(feature = "rpc", feature = "tokio"))]
let pipe_dir = {
let pipedir = tor_config::CfgPath::new("~/.arti-rpc-TESTING/".to_owned());
let path = pipedir.path()?;
client_config
.fs_mistrust()
.verifier()
.make_secure_dir(path)?
};
let client_builder = TorClient::with_runtime(runtime.clone())
.config(client_config)
.bootstrap_behavior(OnDemand);
let client = client_builder.create_unbootstrapped()?;
reload_cfg::watch_for_config_changes(config_sources, arti_config, client.clone())?;
let mut proxy: Vec<PinnedFuture<(Result<()>, &str)>> = Vec::new();
if socks_port != 0 {
let runtime = runtime.clone();
let client = client.isolated_client();
proxy.push(Box::pin(async move {
let res = socks::run_socks_proxy(runtime, client, socks_port).await;
(res, "SOCKS")
}));
}
#[cfg(feature = "dns-proxy")]
if dns_port != 0 {
let runtime = runtime.clone();
let client = client.isolated_client();
proxy.push(Box::pin(async move {
let res = dns::run_dns_resolver(runtime, client, dns_port).await;
(res, "DNS")
}));
}
#[cfg(not(feature = "dns-proxy"))]
if dns_port != 0 {
warn!("Tried to specify a DNS proxy port, but Arti was built without dns-proxy support.");
return Ok(());
}
if proxy.is_empty() {
warn!("No proxy port set; specify -p PORT (for `socks_port`) or -d PORT (for `dns_port`). Alternatively, use the `socks_port` or `dns_port` configuration option.");
return Ok(());
}
#[cfg(all(feature = "rpc", feature = "tokio"))]
{
use futures::task::SpawnExt;
let pipe_path = pipe_dir.join("PIPE")?;
if pipe_path.exists() {
std::fs::remove_file(&pipe_path)?;
}
runtime.spawn(arti_rpcserver::listen::accept_connections(pipe_path).map(|_| ()))?;
}
let proxy = futures::future::select_all(proxy).map(|(finished, _index, _others)| finished);
futures::select!(
r = exit::wait_for_ctrl_c().fuse()
=> r.context("waiting for termination signal"),
r = proxy.fuse()
=> r.0.context(format!("{} proxy failure", r.1)),
r = async {
client.bootstrap().await?;
info!("Sufficiently bootstrapped; system SOCKS now functional.");
futures::future::pending::<Result<()>>().await
}.fuse()
=> r.context("bootstrap"),
)
}
#[cfg_attr(feature = "experimental-api", visibility::make(pub))]
fn main_main<I, T>(cli_args: I) -> Result<()>
where
I: IntoIterator<Item = T>,
T: Into<std::ffi::OsString> + Clone,
{
let mut config_file_help = "Specify which config file(s) to read.".to_string();
if let Ok(default) = default_config_files() {
write!(config_file_help, " Defaults to {:?}", default).unwrap();
}
let runtime = create_runtime()?;
let features = list_enabled_features();
let long_version = format!(
"{}\nusing runtime: {:?}\noptional features: {}",
env!("CARGO_PKG_VERSION"),
runtime,
if features.is_empty() {
"<none>".into()
} else {
features.join(", ")
}
);
let clap_app =
Command::new("Arti")
.version(env!("CARGO_PKG_VERSION"))
.long_version(&long_version as &str)
.author("The Tor Project Developers")
.about("A Rust Tor implementation.")
.override_usage("arti <SUBCOMMAND> [OPTIONS]")
.arg(
Arg::new("config-files")
.short('c')
.long("config")
.action(ArgAction::Set)
.value_name("FILE")
.value_parser(value_parser!(OsString))
.action(ArgAction::Append)
.global(true)
.help(config_file_help.as_str()),
)
.arg(
Arg::new("option")
.short('o')
.action(ArgAction::Set)
.value_name("KEY=VALUE")
.action(ArgAction::Append)
.global(true)
.help("Override config file parameters, using TOML-like syntax."),
)
.arg(
Arg::new("loglevel")
.short('l')
.long("log-level")
.global(true)
.action(ArgAction::Set)
.value_name("LEVEL")
.help("Override the log level (usually one of 'trace', 'debug', 'info', 'warn', 'error')."),
)
.arg(
Arg::new("disable-fs-permission-checks")
.long("disable-fs-permission-checks")
.global(true)
.action(ArgAction::SetTrue)
.help("Don't check permissions on the files we use."),
)
.subcommand(
Command::new("proxy")
.about(
"Run Arti in SOCKS proxy mode, proxying connections through the Tor network.",
)
.arg(
Arg::new("socks-port")
.short('p')
.action(ArgAction::Set)
.value_name("PORT")
.help("Port to listen on for SOCKS connections (overrides the port in the config if specified).")
)
.arg(
Arg::new("dns-port")
.short('d')
.action(ArgAction::Set)
.value_name("PORT")
.help("Port to listen on for DNS request (overrides the port in the config if specified).")
)
)
.subcommand_required(true)
.arg_required_else_help(true);
let pre_config_logging_writer = || {
eprint!("arti:");
std::io::stderr()
};
let pre_config_logging = tracing_subscriber::fmt()
.without_time()
.with_writer(pre_config_logging_writer)
.finish();
let pre_config_logging = tracing::Dispatch::new(pre_config_logging);
let pre_config_logging_ret = tracing::dispatcher::with_default(&pre_config_logging, || {
let matches = clap_app.try_get_matches_from(cli_args)?;
let fs_mistrust_disabled = matches.get_flag("disable-fs-permission-checks");
let cfg_mistrust = if fs_mistrust_disabled {
fs_mistrust::Mistrust::new_dangerously_trust_everyone()
} else {
fs_mistrust::MistrustBuilder::default()
.controlled_by_env_var(arti_client::config::FS_PERMISSIONS_CHECKS_DISABLE_VAR)
.build()
.expect("Could not construct default fs-mistrust")
};
let mut override_options: Vec<String> = matches
.get_many::<String>("option")
.unwrap_or_default()
.cloned()
.collect();
if fs_mistrust_disabled {
override_options.push("storage.permissions.dangerously_trust_everyone=true".to_owned());
}
let cfg_sources = {
let mut cfg_sources = ConfigurationSources::from_cmdline(
default_config_files()?,
matches
.get_many::<OsString>("config-files")
.unwrap_or_default(),
override_options,
);
cfg_sources.set_mistrust(cfg_mistrust);
cfg_sources
};
let cfg = cfg_sources.load()?;
let (config, client_config) =
tor_config::resolve::<ArtiCombinedConfig>(cfg).context("read configuration")?;
let log_mistrust = client_config.fs_mistrust().clone();
Ok::<_, Error>((matches, cfg_sources, config, client_config, log_mistrust))
})?;
let (matches, cfg_sources, config, client_config, log_mistrust) = pre_config_logging_ret;
let _log_guards = logging::setup_logging(
config.logging(),
&log_mistrust,
matches.get_one::<String>("loglevel").map(|s| s.as_str()),
)?;
if !config.application().allow_running_as_root {
process::exit_if_root();
}
#[cfg(feature = "harden")]
if !config.application().permit_debugging {
if let Err(e) = process::enable_process_hardening() {
error!("Encountered a problem while enabling hardening. To disable this feature, set application.permit_debugging to true.");
return Err(e);
}
}
if let Some(proxy_matches) = matches.subcommand_matches("proxy") {
let socks_port = match (
proxy_matches.get_one::<String>("socks-port"),
config.proxy().socks_listen.localhost_port_legacy()?,
) {
(Some(p), _) => p.parse().expect("Invalid port specified"),
(None, Some(s)) => s,
(None, None) => 0,
};
let dns_port = match (
proxy_matches.get_one::<String>("dns-port"),
config.proxy().dns_listen.localhost_port_legacy()?,
) {
(Some(p), _) => p.parse().expect("Invalid port specified"),
(None, Some(s)) => s,
(None, None) => 0,
};
info!(
"Starting Arti {} in SOCKS proxy mode on port {}...",
env!("CARGO_PKG_VERSION"),
socks_port
);
process::use_max_file_limit(&config);
let rt_copy = runtime.clone();
rt_copy.block_on(run(
runtime,
socks_port,
dns_port,
cfg_sources,
config,
client_config,
))?;
Ok(())
} else {
panic!("Subcommand added to clap subcommand list, but not yet implemented")
}
}
pub fn main() {
match main_main(std::env::args_os()) {
Ok(()) => {}
Err(e) => {
if let Some(arti_err) = e.downcast_ref::<arti_client::Error>() {
if let Some(hint) = arti_err.hint() {
info!("{}", hint);
}
}
match e.downcast_ref::<clap::Error>() {
Some(clap_err) => clap_err.exit(),
None => with_safe_logging_suppressed(|| tor_error::report_and_exit(e)),
}
}
}
}