[pbs-devel] [PATCH proxmox-backup 3/5] api2/nodes: add termproxy and vncwebsocket api calls
Dominik Csapak
d.csapak at proxmox.com
Tue Jul 21 11:10:38 CEST 2020
Even though it has nothing to do with vnc, we keep the name of the api
call for compatibility with our xtermjs client.
termproxy:
verifies that the user is allowed to open a console and starts
termproxy with the correct parameters
starts a TcpListener on "localhost:0" so that the kernel decides the
port (instead of trying to rerserving like in pve). Then it
leaves the fd open for termproxy and gives the number as port
and tells it via '--port-as-fd' that it should interpret this
as an open fd
the vncwebsocket api call checks the 'vncticket' (name for compatibility)
and connects the remote side (after an Upgrade) with a local TcpStream
connecting to the port given via WebSocket from the proxmox crate
to make sure that only the client can connect that called termproxy and
no one can connect to an arbitrary port on the host we have to include
the port in the ticket data
Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
Cargo.toml | 6 +-
src/api2/node.rs | 276 +++++++++++++++++++++++++++++++++++++++++++++-
src/config/acl.rs | 2 +
3 files changed, 275 insertions(+), 9 deletions(-)
diff --git a/Cargo.toml b/Cargo.toml
index 355217e..a077a6c 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -38,9 +38,9 @@ pam-sys = "0.5"
percent-encoding = "2.1"
pin-utils = "0.1.0"
pathpatterns = "0.1.2"
-proxmox = { version = "0.2.0", features = [ "sortable-macro", "api-macro" ] }
+proxmox = { version = "0.2.0", features = [ "sortable-macro", "api-macro", "websocket" ] }
#proxmox = { git = "ssh://gitolite3@proxdev.maurer-it.com/rust/proxmox", version = "0.1.2", features = [ "sortable-macro", "api-macro" ] }
-#proxmox = { path = "../proxmox/proxmox", features = [ "sortable-macro", "api-macro" ] }
+#proxmox = { path = "../proxmox/proxmox", features = [ "sortable-macro", "api-macro", "websocket" ] }
proxmox-fuse = "0.1.0"
pxar = { version = "0.2.1", features = [ "tokio-io", "futures-io" ] }
#pxar = { path = "../pxar", features = [ "tokio-io", "futures-io" ] }
@@ -50,7 +50,7 @@ serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
siphasher = "0.3"
syslog = "4.0"
-tokio = { version = "0.2.9", features = [ "blocking", "fs", "io-util", "macros", "rt-threaded", "signal", "stream", "tcp", "time", "uds" ] }
+tokio = { version = "0.2.9", features = [ "blocking", "fs", "dns", "io-util", "macros", "process", "rt-threaded", "signal", "stream", "tcp", "time", "uds" ] }
tokio-openssl = "0.4.0"
tokio-util = { version = "0.3", features = [ "codec" ] }
tower-service = "0.3.0"
diff --git a/src/api2/node.rs b/src/api2/node.rs
index 13ff282..a688694 100644
--- a/src/api2/node.rs
+++ b/src/api2/node.rs
@@ -1,16 +1,275 @@
+use std::net::TcpListener;
+use std::os::unix::io::AsRawFd;
+
+use anyhow::{bail, format_err, Error};
+use futures::{
+ future::{FutureExt, TryFutureExt},
+ try_join,
+};
+use hyper::body::Body;
+use hyper::http::request::Parts;
+use hyper::upgrade::Upgraded;
+use nix::fcntl::{fcntl, FcntlArg, FdFlag};
+use serde_json::{json, Value};
+use tokio::io::{AsyncBufReadExt, BufReader};
+
use proxmox::api::router::{Router, SubdirMap};
+use proxmox::api::{
+ api, schema::*, ApiHandler, ApiMethod, ApiResponseFuture, Permission, RpcEnvironment,
+};
use proxmox::list_subdirs_api_method;
+use proxmox::tools::websocket::WebSocket;
+use proxmox::{identity, sortable};
-pub mod tasks;
-mod time;
-pub mod network;
+use crate::api2::types::*;
+use crate::config::acl::PRIV_SYS_CONSOLE;
+use crate::server::WorkerTask;
+use crate::tools;
+
+pub mod disks;
pub mod dns;
-mod syslog;
mod journal;
+pub mod network;
+pub(crate) mod rrd;
mod services;
mod status;
-pub(crate) mod rrd;
-pub mod disks;
+mod syslog;
+pub mod tasks;
+mod time;
+
+pub const SHELL_CMD_SCHEMA: Schema = StringSchema::new("The command to run.")
+ .format(&ApiStringFormat::Enum(&[
+ EnumEntry::new("login", "Login"),
+ EnumEntry::new("upgrade", "Upgrade"),
+ ]))
+ .schema();
+
+#[api(
+ protected: true,
+ input: {
+ properties: {
+ node: {
+ schema: NODE_SCHEMA,
+ },
+ cmd: {
+ schema: SHELL_CMD_SCHEMA,
+ optional: true,
+ },
+ },
+ },
+ returns: {
+ type: Object,
+ description: "Object with the user, ticket, port and upid",
+ properties: {
+ user: {
+ description: "",
+ type: String,
+ },
+ ticket: {
+ description: "",
+ type: String,
+ },
+ port: {
+ description: "",
+ type: String,
+ },
+ upid: {
+ description: "",
+ type: String,
+ },
+ }
+ },
+ access: {
+ description: "Restricted to users on realm 'pam'",
+ permission: &Permission::Privilege(&["nodes","{node}"], PRIV_SYS_CONSOLE, false),
+ }
+)]
+/// Call termproxy and return shell ticket
+async fn termproxy(
+ node: String,
+ cmd: Option<String>,
+ _param: Value,
+ rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Value, Error> {
+ let userid = rpcenv
+ .get_user()
+ .ok_or_else(|| format_err!("unknown user"))?;
+ let (username, realm) = crate::auth::parse_userid(&userid)?;
+
+ if realm != "pam" {
+ bail!("only pam users can use the console");
+ }
+
+ let path = format!("/nodes/{}", node);
+
+ // use port 0 and let the kernel decide which port is free
+ let listener = TcpListener::bind("localhost:0")?;
+ let port = listener.local_addr()?.port();
+
+ let ticket = tools::ticket::assemble_term_ticket(
+ crate::auth_helpers::private_auth_key(),
+ &userid,
+ &path,
+ port,
+ )?;
+
+ let mut command = Vec::new();
+ match cmd.as_ref().map(|x| x.as_str()) {
+ Some("login") | None => {
+ command.push("login");
+ if userid == "root at pam" {
+ command.push("-f");
+ command.push("root");
+ }
+ }
+ Some("upgrade") => {
+ bail!("upgrade is not supported yet");
+ }
+ _ => bail!("invalid command"),
+ };
+
+ let upid = WorkerTask::spawn(
+ "termproxy",
+ None,
+ &username,
+ false,
+ move |worker| async move {
+ // move inside the worker so that it survives and does not close the port
+ // remove CLOEXEC from listenere so that we can reuse it in termproxy
+ let fd = listener.as_raw_fd();
+ let mut flags = match fcntl(fd, FcntlArg::F_GETFD) {
+ Ok(bits) => FdFlag::from_bits_truncate(bits),
+ Err(err) => bail!("could not get fd: {}", err),
+ };
+ flags.remove(FdFlag::FD_CLOEXEC);
+ if let Err(err) = fcntl(fd, FcntlArg::F_SETFD(flags)) {
+ bail!("could not set fd: {}", err);
+ }
+
+ let mut arguments: Vec<&str> = Vec::new();
+ let fd_string = fd.to_string();
+ arguments.push(&fd_string);
+ arguments.extend_from_slice(&[
+ "--path",
+ &path,
+ "--perm",
+ "Sys.Console",
+ "--authport",
+ "82",
+ "--port-as-fd",
+ "--",
+ ]);
+ arguments.extend_from_slice(&command);
+
+ let mut cmd = tokio::process::Command::new("/usr/bin/termproxy");
+
+ cmd.args(&arguments);
+ cmd.stdout(std::process::Stdio::piped());
+ cmd.stderr(std::process::Stdio::piped());
+
+ let mut child = cmd.spawn().expect("error executing termproxy");
+
+ let stdout = child.stdout.take().expect("no child stdout handle");
+ let stderr = child.stderr.take().expect("no child stderr handle");
+
+ let worker_stdout = worker.clone();
+ let stdout_fut = async move {
+ let mut reader = BufReader::new(stdout).lines();
+ while let Some(line) = reader.next_line().await? {
+ worker_stdout.log(line);
+ }
+ Ok(())
+ };
+
+ let worker_stderr = worker.clone();
+ let stderr_fut = async move {
+ let mut reader = BufReader::new(stderr).lines();
+ while let Some(line) = reader.next_line().await? {
+ worker_stderr.warn(line);
+ }
+ Ok(())
+ };
+
+ let (exit_code, _, _) = try_join!(child, stdout_fut, stderr_fut)?;
+ if !exit_code.success() {
+ match exit_code.code() {
+ Some(code) => bail!("termproxy exited with {}", code),
+ None => bail!("termproxy exited by signal"),
+ }
+ }
+
+ Ok(())
+ },
+ )?;
+
+ Ok(json!({
+ "user": username,
+ "ticket": ticket,
+ "port": port,
+ "upid": upid,
+ }))
+}
+
+#[sortable]
+pub const API_METHOD_WEBSOCKET: ApiMethod = ApiMethod::new(
+ &ApiHandler::AsyncHttp(&upgrade_to_websocket),
+ &ObjectSchema::new(
+ "Upgraded to websocket",
+ &sorted!([
+ ("node", false, &NODE_SCHEMA),
+ (
+ "vncticket",
+ false,
+ &StringSchema::new("Terminal ticket").schema()
+ ),
+ ("port", false, &IntegerSchema::new("Terminal port").schema()),
+ ]),
+ ),
+)
+.access(
+ Some("The user needs Sys.Console on /nodes/{node}."),
+ &Permission::Privilege(&["nodes", "{node}"], PRIV_SYS_CONSOLE, false),
+);
+
+fn upgrade_to_websocket(
+ parts: Parts,
+ req_body: Body,
+ param: Value,
+ _info: &ApiMethod,
+ rpcenv: Box<dyn RpcEnvironment>,
+) -> ApiResponseFuture {
+ async move {
+ let username = rpcenv.get_user().unwrap();
+ let node = tools::required_string_param(¶m, "node")?.to_owned();
+ let path = format!("/nodes/{}", node);
+ let ticket = tools::required_string_param(¶m, "vncticket")?.to_owned();
+ let port: u16 = tools::required_integer_param(¶m, "port")? as u16;
+
+ // will be checked again by termproxy
+ tools::ticket::verify_term_ticket(
+ crate::auth_helpers::public_auth_key(),
+ &username,
+ &path,
+ port,
+ &ticket,
+ )?;
+
+ let (ws, response) = WebSocket::new(parts.headers)?;
+
+ tokio::spawn(async move {
+ let conn: Upgraded = match req_body.on_upgrade().map_err(Error::from).await {
+ Ok(upgraded) => upgraded,
+ _ => bail!("error"),
+ };
+
+ let local = tokio::net::TcpStream::connect(format!("localhost:{}", port)).await?;
+ ws.serve_connection(conn, local).await
+ });
+
+ Ok(response)
+ }
+ .boxed()
+}
pub const SUBDIRS: SubdirMap = &[
("disks", &disks::ROUTER),
@@ -22,7 +281,12 @@ pub const SUBDIRS: SubdirMap = &[
("status", &status::ROUTER),
("syslog", &syslog::ROUTER),
("tasks", &tasks::ROUTER),
+ ("termproxy", &Router::new().post(&API_METHOD_TERMPROXY)),
("time", &time::ROUTER),
+ (
+ "vncwebsocket",
+ &Router::new().upgrade(&API_METHOD_WEBSOCKET),
+ ),
];
pub const ROUTER: Router = Router::new()
diff --git a/src/config/acl.rs b/src/config/acl.rs
index e44b016..d5d9c0a 100644
--- a/src/config/acl.rs
+++ b/src/config/acl.rs
@@ -39,6 +39,8 @@ constnamemap! {
PRIV_REMOTE_MODIFY("Remote.Modify") = 1 << 10;
PRIV_REMOTE_READ("Remote.Read") = 1 << 11;
PRIV_REMOTE_PRUNE("Remote.Prune") = 1 << 12;
+
+ PRIV_SYS_CONSOLE("Sys.Console") = 1 << 13;
}
}
--
2.20.1
More information about the pbs-devel
mailing list