qos_net 0.7.0

//! CLI for running a host proxy to provide remote connections.

use std::num::ParseIntError;

use qos_core::{
	io::{IOError, SocketAddress},
	parser::{GetParserForOptions, OptionsParser, Parser, Token},
};

use qos_core::io::StreamPool;

use crate::proxy::ProxyServer;

/// "cid"
pub const CID: &str = "cid";
/// "port"
pub const PORT: &str = "port";
/// "usock"
pub const USOCK: &str = "usock";
/// "pool-size"
pub const POOL_SIZE: &str = "pool-size";
/// "max-connections"
pub const MAX_CONNECTIONS: &str = "max-connections";

const DEFAULT_MAX_CONNECTIONS: &str = "256";

/// CLI options for starting up the proxy.
#[derive(Default, Clone, Debug, PartialEq)]
pub(crate) struct ProxyOpts {
	pub(crate) parsed: Parser,
}

impl ProxyOpts {
	/// Create a new instance of [`Self`] with some defaults.
	pub(crate) fn new(args: &mut Vec<String>) -> Self {
		let parsed = OptionsParser::<ProxyParser>::parse(args)
			.expect("Entered invalid CLI args");

		Self { parsed }
	}

	pub(crate) fn max_connections(&self) -> Result<usize, ParseIntError> {
		self.parsed
			.single(MAX_CONNECTIONS)
			.map_or(DEFAULT_MAX_CONNECTIONS, String::as_str)
			.parse()
	}

	/// Create a new `StreamPool` using the list of `SocketAddress` for the enclave server.
	pub(crate) fn async_pool(&self) -> Result<StreamPool, IOError> {
		let pool_size: u8 = self
			.parsed
			.single(POOL_SIZE)
			.expect("invalid pool options")
			.parse()
			.expect("invalid pool_size specified");
		match (
			self.parsed.single(CID),
			self.parsed.single(PORT),
			self.parsed.single(USOCK),
		) {
			#[cfg(feature = "vm")]
			(Some(c), Some(p), None) => {
				let c = c.parse::<u32>().unwrap();
				let p = p.parse::<u32>().unwrap();

				let address =
					SocketAddress::new_vsock(c, p, crate::io::VMADDR_NO_FLAGS);

				StreamPool::new(address, pool_size)
			}
			(None, None, Some(u)) => {
				let address = SocketAddress::new_unix(u);

				StreamPool::new(address, pool_size)
			}
			_ => panic!("Invalid socket opts"),
		}
	}
}

/// Proxy CLI.
pub struct CLI;

impl CLI {
	/// Execute the enclave proxy CLI with the environment args in an async way.
	pub async fn execute() {
		use qos_core::server::SocketServer;

		let mut args: Vec<String> = std::env::args().collect();
		let opts = ProxyOpts::new(&mut args);

		if opts.parsed.version() {
			println!("version: {}", env!("CARGO_PKG_VERSION"));
		} else if opts.parsed.help() {
			println!("{}", opts.parsed.info());
		} else {
			let _server = SocketServer::listen_proxy(
				opts.async_pool().expect("unable to create async socket pool"),
				opts.max_connections()
					.expect("unable to parse max connections argument"),
			)
			.await
			.expect("unable to get listen join handles");

			match tokio::signal::ctrl_c().await {
				Ok(()) => println!("handling ctrl+c the tokio way"),

				Err(err) => panic!("{err}"),
			}
		}
	}
}

/// Parser for proxy CLI
struct ProxyParser;
impl GetParserForOptions for ProxyParser {
	fn parser() -> Parser {
		Parser::new()
			.token(
				Token::new(CID, "cid of the VSOCK the proxy should listen on.")
					.takes_value(true)
					.forbids(vec![USOCK])
					.requires(PORT),
			)
			.token(
				Token::new(
					PORT,
					"port of the VSOCK the proxy should listen on.",
				)
				.takes_value(true)
				.forbids(vec![USOCK])
				.requires(CID),
			)
			.token(
				Token::new(USOCK, "unix socket (`.sock`) to listen on.")
					.takes_value(true)
					.forbids(vec!["port", "cid"]),
			)
			.token(
				Token::new(
					MAX_CONNECTIONS,
					"maximum concurrent connections allowed",
				)
				.takes_value(true)
				.default_value(DEFAULT_MAX_CONNECTIONS),
			)
			.token(
				Token::new(
					POOL_SIZE,
					"the pool size to use with all socket types.",
				)
				.takes_value(true)
				.forbids(vec!["port", "cid"])
				.default_value("1"),
			)
	}
}

#[cfg(test)]
mod test {
	use super::*;

	#[test]
	fn parse_cid_and_port() {
		let mut args: Vec<_> = vec!["binary", "--cid", "6", "--port", "3999"]
			.into_iter()
			.map(String::from)
			.collect();
		let opts: ProxyOpts = ProxyOpts::new(&mut args);

		assert_eq!(*opts.parsed.single(CID).unwrap(), "6".to_string());
		assert_eq!(*opts.parsed.single(PORT).unwrap(), "3999".to_string());
	}

	#[test]
	fn parse_usock() {
		let mut args: Vec<_> = vec!["binary", "--usock", "/tmp/usock"]
			.into_iter()
			.map(String::from)
			.collect();
		let opts = ProxyOpts::new(&mut args);

		assert_eq!(
			*opts.parsed.single(USOCK).unwrap(),
			"/tmp/usock".to_string()
		);
	}

	#[test]
	fn parse_pool_size() {
		let mut args: Vec<_> =
			vec!["binary", "--usock", "./test.sock", "--pool-size", "7"]
				.into_iter()
				.map(String::from)
				.collect();
		let opts = ProxyOpts::new(&mut args);

		let pool = opts.async_pool().unwrap();
		assert_eq!(pool.len(), 7);
	}

	#[test]
	fn builds_async_pool() {
		let mut args: Vec<_> =
			vec!["binary", "--usock", "./test.sock", "--pool-size", "3"]
				.into_iter()
				.map(String::from)
				.collect();
		let opts = ProxyOpts::new(&mut args);

		let pool = opts.async_pool().unwrap();
		assert_eq!(pool.len(), 3);
	}

	#[test]
	#[should_panic = "Entered invalid CLI args: MutuallyExclusiveInput(\"cid\", \"usock\")"]
	fn panic_on_too_many_opts() {
		let mut args: Vec<_> = vec![
			"binary", "--cid", "6", "--port", "3999", "--usock", "my.sock",
		]
		.into_iter()
		.map(String::from)
		.collect();
		let _opts = ProxyOpts::new(&mut args);
	}

	#[test]
	#[should_panic = "Entered invalid CLI args: MissingInput(\"port\")"]
	fn panic_on_not_enough_opts() {
		let mut args: Vec<_> = vec!["binary", "--cid", "6"]
			.into_iter()
			.map(String::from)
			.collect();
		let _opts = ProxyOpts::new(&mut args);
	}

	#[test]
	#[cfg(feature = "vm")]
	fn build_vsock() {
		let mut args: Vec<_> = vec!["binary", "--cid", "6", "--port", "3999"]
			.into_iter()
			.map(String::from)
			.collect();
		let opts = EnclaveOpts::new(&mut args);

		assert_eq!(
			opts.addr(),
			SocketAddress::new_vsock(6, 3999, crate::io::VMADDR_NO_FLAGS)
		);
	}

	#[test]
	#[should_panic = "Entered invalid CLI args: UnexpectedInput(\"--derp\")"]
	fn panic_when_mistyped_cid() {
		let mut args: Vec<_> =
			vec!["--derp"].into_iter().map(String::from).collect();
		let _opts = ProxyOpts::new(&mut args);
	}
}