[proxmox-backup.git] / src / bin / proxmox-restore-daemon.rs

///! Daemon binary to run inside a micro-VM for secure single file restore of disk images
use std::fs::File;
use std::io::prelude::*;
use std::os::unix::{
    io::{FromRawFd, RawFd},
    net,
};
use std::path::Path;
use std::sync::{Arc, Mutex};

use anyhow::{bail, format_err, Error};
use lazy_static::lazy_static;
use log::{error, info};
use tokio::sync::mpsc;
use tokio_stream::wrappers::ReceiverStream;
use http::request::Parts;
use http::Response;
use hyper::{Body, StatusCode};
use hyper::header;

use proxmox::api::RpcEnvironmentType;

use pbs_client::DEFAULT_VSOCK_PORT;
use proxmox_rest_server::{ApiConfig, RestServer};

mod proxmox_restore_daemon;
use proxmox_restore_daemon::*;

/// Maximum amount of pending requests. If saturated, virtio-vsock returns ETIMEDOUT immediately.
/// We should never have more than a few requests in queue, so use a low number.
pub const MAX_PENDING: usize = 32;

/// Will be present in base initramfs
pub const VM_DETECT_FILE: &str = "/restore-vm-marker";

lazy_static! {
    /// The current disks state. Use for accessing data on the attached snapshots.
    pub static ref DISK_STATE: Arc<Mutex<DiskState>> = {
        Arc::new(Mutex::new(DiskState::scan().unwrap()))
    };
}

/// This is expected to be run by 'proxmox-file-restore' within a mini-VM
fn main() -> Result<(), Error> {
    if !Path::new(VM_DETECT_FILE).exists() {
        bail!(
            "This binary is not supposed to be run manually, use 'proxmox-file-restore' instead."
        );
    }

    // don't have a real syslog (and no persistance), so use env_logger to print to a log file (via
    // stdout to a serial terminal attached by QEMU)
    env_logger::from_env(env_logger::Env::default().default_filter_or("info"))
        .write_style(env_logger::WriteStyle::Never)
        .format_timestamp_millis()
        .init();

    info!("setup basic system environment...");
    setup_system_env().map_err(|err| format_err!("system environment setup failed: {}", err))?;

    // scan all attached disks now, before starting the API
    // this will panic and stop the VM if anything goes wrong
    info!("scanning all disks...");
    {
        let _disk_state = DISK_STATE.lock().unwrap();
    }

    info!("disk scan complete, starting main runtime...");

    pbs_runtime::main(run())
}

/// ensure we have our /run dirs, system users and stuff like that setup
fn setup_system_env() -> Result<(), Error> {
    // the API may save some stuff there, e.g., the memcon tracking file
    // we do not care much, but it's way less headache to just create it
    std::fs::create_dir_all("/run/proxmox-backup")?;

    // we now ensure that all lock files are owned by the backup user, and as we reuse the
    // specialized REST module from pbs api/daemon we have some checks there for user/acl stuff
    // that gets locked, and thus needs the backup system user to work.
    std::fs::create_dir_all("/etc")?;
    let mut passwd = File::create("/etc/passwd")?;
    writeln!(passwd, "root:x:0:0:root:/root:/bin/sh")?;
    writeln!(passwd, "backup:x:34:34:backup:/var/backups:/usr/sbin/nologin")?;

    let mut group = File::create("/etc/group")?;
    writeln!(group, "root:x:0:")?;
    writeln!(group, "backup:x:34:")?;

    Ok(())
}

fn get_index(
    _auth_id: Option<String>,
    _language: Option<String>,
    _api: &ApiConfig,
    _parts: Parts,
) -> Response<Body> {

    let index = "<center><h1>Proxmox Backup Restore Daemon/h1></center>";

    Response::builder()
        .status(StatusCode::OK)
        .header(header::CONTENT_TYPE, "text/html")
        .body(index.into())
        .unwrap()
}

async fn run() -> Result<(), Error> {
    watchdog_init();

    let auth_config = Arc::new(
        auth::ticket_auth().map_err(|err| format_err!("reading ticket file failed: {}", err))?,
    );
    let config = ApiConfig::new("", &ROUTER, RpcEnvironmentType::PUBLIC, auth_config, get_index)?;
    let rest_server = RestServer::new(config);

    let vsock_fd = get_vsock_fd()?;
    let connections = accept_vsock_connections(vsock_fd);
    let receiver_stream = ReceiverStream::new(connections);
    let acceptor = hyper::server::accept::from_stream(receiver_stream);

    hyper::Server::builder(acceptor).serve(rest_server).await?;

    bail!("hyper server exited");
}

fn accept_vsock_connections(
    vsock_fd: RawFd,
) -> mpsc::Receiver<Result<tokio::net::UnixStream, Error>> {
    use nix::sys::socket::*;
    let (sender, receiver) = mpsc::channel(MAX_PENDING);

    tokio::spawn(async move {
        loop {
            let stream: Result<tokio::net::UnixStream, Error> = tokio::task::block_in_place(|| {
                // we need to accept manually, as UnixListener aborts if socket type != AF_UNIX ...
                let client_fd = accept(vsock_fd)?;
                let stream = unsafe { net::UnixStream::from_raw_fd(client_fd) };
                stream.set_nonblocking(true)?;
                tokio::net::UnixStream::from_std(stream).map_err(|err| err.into())
            });

            match stream {
                Ok(stream) => {
                    if sender.send(Ok(stream)).await.is_err() {
                        error!("connection accept channel was closed");
                    }
                }
                Err(err) => {
                    error!("error accepting vsock connetion: {}", err);
                }
            }
        }
    });

    receiver
}

fn get_vsock_fd() -> Result<RawFd, Error> {
    use nix::sys::socket::*;
    let sock_fd = socket(
        AddressFamily::Vsock,
        SockType::Stream,
        SockFlag::empty(),
        None,
    )?;
    let sock_addr = VsockAddr::new(libc::VMADDR_CID_ANY, DEFAULT_VSOCK_PORT as u32);
    bind(sock_fd, &SockAddr::Vsock(sock_addr))?;
    listen(sock_fd, MAX_PENDING)?;
    Ok(sock_fd)
}
Commit	Line	Data
dd9cef56	1	///! Daemon binary to run inside a micro-VM for secure single file restore of disk images
4c1b7761 WB	2	use std::fs::File;
4c1b7761 WB	3	use std::io::prelude::*;
dd9cef56 SR	4	use std::os::unix::{
	5	io::{FromRawFd, RawFd},
	6	net,
	7	};
	8	use std::path::Path;
d32a8652	9	use std::sync::{Arc, Mutex};
dd9cef56	10
4c1b7761 WB	11	use anyhow::{bail, format_err, Error};
	12	use lazy_static::lazy_static;
	13	use log::{error, info};
dd9cef56 SR	14	use tokio::sync::mpsc;
dd9cef56 SR	15	use tokio_stream::wrappers::ReceiverStream;
7fa9a37c DM	16	use http::request::Parts;
	17	use http::Response;
	18	use hyper::{Body, StatusCode};
	19	use hyper::header;
dd9cef56 SR	20
dd9cef56 SR	21	use proxmox::api::RpcEnvironmentType;
dd9cef56	22
4c1b7761	23	use pbs_client::DEFAULT_VSOCK_PORT;
6fbf0acc	24	use proxmox_rest_server::{ApiConfig, RestServer};
9edf96e6	25
dd9cef56 SR	26	mod proxmox_restore_daemon;
	27	use proxmox_restore_daemon::*;
	28
	29	/// Maximum amount of pending requests. If saturated, virtio-vsock returns ETIMEDOUT immediately.
	30	/// We should never have more than a few requests in queue, so use a low number.
	31	pub const MAX_PENDING: usize = 32;
	32
	33	/// Will be present in base initramfs
	34	pub const VM_DETECT_FILE: &str = "/restore-vm-marker";
	35
d32a8652 SR	36	lazy_static! {
	37	/// The current disks state. Use for accessing data on the attached snapshots.
	38	pub static ref DISK_STATE: Arc<Mutex<DiskState>> = {
	39	Arc::new(Mutex::new(DiskState::scan().unwrap()))
	40	};
	41	}
	42
dd9cef56 SR	43	/// This is expected to be run by 'proxmox-file-restore' within a mini-VM
	44	fn main() -> Result<(), Error> {
	45	if !Path::new(VM_DETECT_FILE).exists() {
309e14eb TL	46	bail!(
	47	"This binary is not supposed to be run manually, use 'proxmox-file-restore' instead."
	48	);
dd9cef56 SR	49	}
	50
	51	// don't have a real syslog (and no persistance), so use env_logger to print to a log file (via
	52	// stdout to a serial terminal attached by QEMU)
	53	env_logger::from_env(env_logger::Env::default().default_filter_or("info"))
	54	.write_style(env_logger::WriteStyle::Never)
ecd66eca	55	.format_timestamp_millis()
dd9cef56 SR	56	.init();
dd9cef56 SR	57
3f780ddf TL	58	info!("setup basic system environment...");
3f780ddf TL	59	setup_system_env().map_err(\|err\| format_err!("system environment setup failed: {}", err))?;
33d7292f	60
d32a8652 SR	61	// scan all attached disks now, before starting the API
d32a8652 SR	62	// this will panic and stop the VM if anything goes wrong
9a06eb16	63	info!("scanning all disks...");
d32a8652 SR	64	{
	65	let _disk_state = DISK_STATE.lock().unwrap();
	66	}
	67
9a06eb16 TL	68	info!("disk scan complete, starting main runtime...");
9a06eb16 TL	69
d420962f	70	pbs_runtime::main(run())
dd9cef56 SR	71	}
dd9cef56 SR	72
73e1ba65 TL	73	/// ensure we have our /run dirs, system users and stuff like that setup
	74	fn setup_system_env() -> Result<(), Error> {
	75	// the API may save some stuff there, e.g., the memcon tracking file
	76	// we do not care much, but it's way less headache to just create it
	77	std::fs::create_dir_all("/run/proxmox-backup")?;
	78
9edf96e6 TL	79	// we now ensure that all lock files are owned by the backup user, and as we reuse the
	80	// specialized REST module from pbs api/daemon we have some checks there for user/acl stuff
	81	// that gets locked, and thus needs the backup system user to work.
	82	std::fs::create_dir_all("/etc")?;
	83	let mut passwd = File::create("/etc/passwd")?;
	84	writeln!(passwd, "root:x:0:0:root:/root:/bin/sh")?;
	85	writeln!(passwd, "backup:x:34:34:backup:/var/backups:/usr/sbin/nologin")?;
	86
	87	let mut group = File::create("/etc/group")?;
	88	writeln!(group, "root:x:0:")?;
	89	writeln!(group, "backup:x:34:")?;
	90
73e1ba65 TL	91	Ok(())
	92	}
	93
7fa9a37c DM	94	fn get_index(
	95	_auth_id: Option<String>,
	96	_language: Option<String>,
	97	_api: &ApiConfig,
	98	_parts: Parts,
	99	) -> Response<Body> {
	100
	101	let index = "<center><h1>Proxmox Backup Restore Daemon/h1></center>";
	102
	103	Response::builder()
	104	.status(StatusCode::OK)
	105	.header(header::CONTENT_TYPE, "text/html")
	106	.body(index.into())
	107	.unwrap()
	108	}
	109
dd9cef56	110	async fn run() -> Result<(), Error> {
a26ebad5 SR	111	watchdog_init();
a26ebad5 SR	112
dd9cef56 SR	113	let auth_config = Arc::new(
	114	auth::ticket_auth().map_err(\|err\| format_err!("reading ticket file failed: {}", err))?,
	115	);
7fa9a37c	116	let config = ApiConfig::new("", &ROUTER, RpcEnvironmentType::PUBLIC, auth_config, get_index)?;
dd9cef56 SR	117	let rest_server = RestServer::new(config);
	118
	119	let vsock_fd = get_vsock_fd()?;
	120	let connections = accept_vsock_connections(vsock_fd);
	121	let receiver_stream = ReceiverStream::new(connections);
	122	let acceptor = hyper::server::accept::from_stream(receiver_stream);
	123
	124	hyper::Server::builder(acceptor).serve(rest_server).await?;
	125
	126	bail!("hyper server exited");
	127	}
	128
	129	fn accept_vsock_connections(
	130	vsock_fd: RawFd,
	131	) -> mpsc::Receiver<Result<tokio::net::UnixStream, Error>> {
	132	use nix::sys::socket::*;
	133	let (sender, receiver) = mpsc::channel(MAX_PENDING);
	134
	135	tokio::spawn(async move {
	136	loop {
	137	let stream: Result<tokio::net::UnixStream, Error> = tokio::task::block_in_place(\|\| {
	138	// we need to accept manually, as UnixListener aborts if socket type != AF_UNIX ...
	139	let client_fd = accept(vsock_fd)?;
	140	let stream = unsafe { net::UnixStream::from_raw_fd(client_fd) };
	141	stream.set_nonblocking(true)?;
	142	tokio::net::UnixStream::from_std(stream).map_err(\|err\| err.into())
	143	});
	144
	145	match stream {
	146	Ok(stream) => {
	147	if sender.send(Ok(stream)).await.is_err() {
	148	error!("connection accept channel was closed");
	149	}
	150	}
	151	Err(err) => {
	152	error!("error accepting vsock connetion: {}", err);
	153	}
	154	}
	155	}
	156	});
	157
	158	receiver
	159	}
	160
	161	fn get_vsock_fd() -> Result<RawFd, Error> {
	162	use nix::sys::socket::*;
	163	let sock_fd = socket(
	164	AddressFamily::Vsock,
	165	SockType::Stream,
	166	SockFlag::empty(),
	167	None,
	168	)?;
	169	let sock_addr = VsockAddr::new(libc::VMADDR_CID_ANY, DEFAULT_VSOCK_PORT as u32);
	170	bind(sock_fd, &SockAddr::Vsock(sock_addr))?;
	171	listen(sock_fd, MAX_PENDING)?;
	172	Ok(sock_fd)
	173	}