[pbs-devel] [PATCH proxmox-backup 1/4] api: add consent api handler and config

Gabriel Goller g.goller at proxmox.com
Thu May 16 18:24:58 CEST 2024


Add config function to retrieve consent from file and api handler to
serve it via the http.

Signed-off-by: Gabriel Goller <g.goller at proxmox.com>
---
 src/api2/access/consent.rs | 25 +++++++++++++++++++++++++
 src/api2/access/mod.rs     |  2 ++
 src/config/consent.rs      | 11 +++++++++++
 src/config/mod.rs          |  1 +
 4 files changed, 39 insertions(+)
 create mode 100644 src/api2/access/consent.rs
 create mode 100644 src/config/consent.rs

diff --git a/src/api2/access/consent.rs b/src/api2/access/consent.rs
new file mode 100644
index 00000000..c8cb89c3
--- /dev/null
+++ b/src/api2/access/consent.rs
@@ -0,0 +1,25 @@
+use anyhow::Error;
+use proxmox_router::http_bail;
+use proxmox_router::{Permission, Router};
+use proxmox_schema::api;
+
+pub(crate) const ROUTER: Router = Router::new().get(&API_METHOD_GET_CONSENT);
+
+#[api(
+    returns: {
+        type: String,
+        description: "Consent banner text.",
+    },
+    access: {
+        description: "Anyone can access this, because we need to display the consent box before the user is logged in.",
+        permission: &Permission::World,
+    }
+)]
+/// Get consent banner text.
+pub fn get_consent() -> Result<String, Error> {
+    let consent = crate::config::consent::config()?;
+    if consent.trim().is_empty() {
+        http_bail!(NO_CONTENT, "No consent banner exists.")
+    }
+    Ok(consent)
+}
diff --git a/src/api2/access/mod.rs b/src/api2/access/mod.rs
index 15509fd9..44e67602 100644
--- a/src/api2/access/mod.rs
+++ b/src/api2/access/mod.rs
@@ -20,6 +20,7 @@ use pbs_config::acl::AclTreeNode;
 use pbs_config::CachedUserInfo;
 
 pub mod acl;
+pub mod consent;
 pub mod domain;
 pub mod openid;
 pub mod role;
@@ -275,6 +276,7 @@ const SUBDIRS: SubdirMap = &sorted!([
     ("roles", &role::ROUTER),
     ("users", &user::ROUTER),
     ("tfa", &tfa::ROUTER),
+    ("consent", &consent::ROUTER),
 ]);
 
 pub const ROUTER: Router = Router::new()
diff --git a/src/config/consent.rs b/src/config/consent.rs
new file mode 100644
index 00000000..55ef201c
--- /dev/null
+++ b/src/config/consent.rs
@@ -0,0 +1,11 @@
+use anyhow::Error;
+
+use pbs_buildcfg::configdir;
+
+const CONF_FILE: &str = configdir!("/consent.txt");
+
+/// Read the Consent config.
+pub fn config() -> Result<String, Error> {
+    let content = proxmox_sys::fs::file_read_optional_string(CONF_FILE)?.unwrap_or_default();
+    Ok(content)
+}
diff --git a/src/config/mod.rs b/src/config/mod.rs
index 324fabca..81caf0d5 100644
--- a/src/config/mod.rs
+++ b/src/config/mod.rs
@@ -15,6 +15,7 @@ use proxmox_lang::try_block;
 use pbs_buildcfg::{self, configdir};
 
 pub mod acme;
+pub mod consent;
 pub mod node;
 pub mod tfa;
 
-- 
2.43.0





More information about the pbs-devel mailing list