Lines
25.81 %
Functions
8.33 %
Branches
100 %
//! Code to adjust process-related parameters.
use tracing::error;
use crate::ArtiConfig;
/// Set our current maximum-file limit to a large value, if we can.
///
/// Since we're going to be used as a proxy, we're likely to need a
/// _lot_ of simultaneous sockets.
/// # Limitations
/// This doesn't actually do anything on windows.
#[cfg_attr(feature = "experimental-api", visibility::make(pub))]
pub(crate) fn use_max_file_limit(config: &ArtiConfig) {
match rlimit::increase_nofile_limit(config.system.max_files) {
Ok(n) => tracing::debug!("Increased process file limit to {}", n),
Err(e) => tor_error::warn_report!(e, "Error while increasing file limit"),
}
/// Enable process hardening, to make it harder for low-privilege users to
/// extract information from Arti.
/// This function only has effect the first time it is called. If it returns an
/// error, the caller should probably exit the process.
/// See notes from the [`secmem_proc`] crate: this is a best-effort defense, and
/// only makes these attacks _harder_. It can interfere with debugging.
#[cfg(feature = "harden")]
pub(crate) fn enable_process_hardening() -> anyhow::Result<()> {
use anyhow::Context as _;
use std::sync::atomic::{AtomicBool, Ordering};
/// Have we called this method before?
static ENABLED: AtomicBool = AtomicBool::new(false);
if ENABLED.swap(true, Ordering::SeqCst) {
// Already enabled, or tried to enable.
return Ok(());
secmem_proc::harden_process().context("Problem while hardening process")?;
Ok(())
/// Check that we are not running as "root".
/// If we are, give an error message, and exit.
pub(crate) fn exit_if_root() {
if running_as_root() {
error!(
"You are running Arti as root. You don't need to, and \
you probably shouldn't. \
To run as root anyway, set application.allow_running_as_root."
);
std::process::exit(1);
/// Return true if we seem to be running as root.
fn running_as_root() -> bool {
#[cfg(target_family = "unix")]
unsafe {
libc::geteuid() == 0
#[cfg(not(target_family = "unix"))]
false
/// Return an async stream that reports an event whenever we get a `SIGHUP`
/// signal.
/// Note that the signal-handling backend can coalesce signals; this is normal.
pub(crate) fn sighup_stream() -> crate::Result<impl futures::Stream<Item = ()>> {
cfg_if::cfg_if! {
if #[cfg(feature="tokio")] {
use tokio_crate::signal::unix as s;
let mut signal = s::signal(s::SignalKind::hangup())?;
Ok(futures::stream::poll_fn(move |ctx| signal.poll_recv(ctx)))
} else if #[cfg(feature="async-std")] {
use async_signal::{Signal, Signals};
use futures::stream::StreamExt as _;
let signals = Signals::new(&[Signal::Hup])?;
Ok(signals.map(|_| ()))
} else {
// Not backend, so we won't ever get a SIGHUP.
Ok(futures::stream::pending())