From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 442151FF185 for ; Mon, 21 Jul 2025 18:44:51 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 5752F1668B; Mon, 21 Jul 2025 18:45:47 +0200 (CEST) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Mon, 21 Jul 2025 18:44:23 +0200 Message-ID: <20250721164507.1045869-6-c.ebner@proxmox.com> X-Mailer: git-send-email 2.47.2 In-Reply-To: <20250721164507.1045869-1-c.ebner@proxmox.com> References: <20250721164507.1045869-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1753116304552 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.044 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v10 02/46] config: introduce s3 object store client configuration X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Adds the client configuration for s3 object store as dedicated configuration files, with secrets being stored separately from the regular configuration and excluded from api responses for security reasons. Signed-off-by: Christian Ebner --- changes since version 9: - no changes pbs-config/Cargo.toml | 1 + pbs-config/src/lib.rs | 1 + pbs-config/src/s3.rs | 89 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 91 insertions(+) create mode 100644 pbs-config/src/s3.rs diff --git a/pbs-config/Cargo.toml b/pbs-config/Cargo.toml index 284149658..74afb3c64 100644 --- a/pbs-config/Cargo.toml +++ b/pbs-config/Cargo.toml @@ -19,6 +19,7 @@ serde_json.workspace = true proxmox-notify.workspace = true proxmox-router = { workspace = true, default-features = false } +proxmox-s3-client.workspace = true proxmox-schema.workspace = true proxmox-section-config.workspace = true proxmox-shared-memory.workspace = true diff --git a/pbs-config/src/lib.rs b/pbs-config/src/lib.rs index 9c4d77c24..d03c079ab 100644 --- a/pbs-config/src/lib.rs +++ b/pbs-config/src/lib.rs @@ -10,6 +10,7 @@ pub mod network; pub mod notifications; pub mod prune; pub mod remote; +pub mod s3; pub mod sync; pub mod tape_job; pub mod token_shadow; diff --git a/pbs-config/src/s3.rs b/pbs-config/src/s3.rs new file mode 100644 index 000000000..7351cd184 --- /dev/null +++ b/pbs-config/src/s3.rs @@ -0,0 +1,89 @@ +use std::collections::HashMap; +use std::sync::LazyLock; + +use anyhow::Error; + +use proxmox_s3_client::{S3ClientConfig, S3ClientSecretsConfig}; +use proxmox_schema::*; +use proxmox_section_config::{SectionConfig, SectionConfigData, SectionConfigPlugin}; + +use pbs_api_types::JOB_ID_SCHEMA; + +use pbs_buildcfg::configdir; + +use crate::{open_backup_lockfile, replace_backup_config, BackupLockGuard}; + +pub static CONFIG: LazyLock = LazyLock::new(init); + +fn init() -> SectionConfig { + let obj_schema = S3ClientConfig::API_SCHEMA.unwrap_object_schema(); + let secrets_obj_schema = S3ClientSecretsConfig::API_SCHEMA.unwrap_object_schema(); + let plugin = + SectionConfigPlugin::new("s3client".to_string(), Some(String::from("id")), obj_schema); + let secrets_plugin = SectionConfigPlugin::new( + "s3secrets".to_string(), + Some(String::from("secrets-id")), + secrets_obj_schema, + ); + let mut config = SectionConfig::new(&JOB_ID_SCHEMA); + config.register_plugin(plugin); + config.register_plugin(secrets_plugin); + + config +} + +/// Configuration file location for S3 client. +pub const S3_CFG_FILENAME: &str = configdir!("/s3.cfg"); +/// Configuration file location for S3 client secret with limited access, only readable by `root`. +pub const S3_SECRETS_CFG_FILENAME: &str = configdir!("/s3-secrets.cfg"); +/// Configuration lock file used to prevent concurrent configuration update operations. +pub const S3_CFG_LOCKFILE: &str = configdir!("/.s3.lck"); + +/// Config type for s3 client config entries +pub const S3_CFG_TYPE_ID: &str = "s3client"; +/// Config type for s3 client secrets config entries +pub const S3_SECRETS_CFG_TYPE_ID: &str = "s3secrets"; + +/// Get exclusive lock for S3 client configuration update. +pub fn lock_config() -> Result { + open_backup_lockfile(S3_CFG_LOCKFILE, None, true) +} + +/// Load s3 client configuration from file. +pub fn config() -> Result<(SectionConfigData, [u8; 32]), Error> { + parse_config(S3_CFG_FILENAME) +} + +/// Load s3 client secrets configuration from file. +pub fn secrets_config() -> Result<(SectionConfigData, [u8; 32]), Error> { + parse_config(S3_SECRETS_CFG_FILENAME) +} + +/// Save given s3 client and secrets configuration to file. +pub fn save_config(config: &SectionConfigData, secrets: &SectionConfigData) -> Result<(), Error> { + let raw = CONFIG.write(S3_CFG_FILENAME, config)?; + replace_backup_config(S3_CFG_FILENAME, raw.as_bytes())?; + + let secrets_raw = CONFIG.write(S3_SECRETS_CFG_FILENAME, secrets)?; + // Secrets are stored with `backup` permissions to allow reading from + // not protected api endpoints as well. + replace_backup_config(S3_SECRETS_CFG_FILENAME, secrets_raw.as_bytes())?; + + Ok(()) +} + +/// Shell completion helper to complete s3 client id's as found in the config. +pub fn complete_s3_client_id(_arg: &str, _param: &HashMap) -> Vec { + match config() { + Ok((data, _digest)) => data.sections.keys().map(|id| id.to_string()).collect(), + Err(_) => Vec::new(), + } +} + +fn parse_config(path: &str) -> Result<(SectionConfigData, [u8; 32]), Error> { + let content = proxmox_sys::fs::file_read_optional_string(path)?; + let content = content.unwrap_or_default(); + let digest = openssl::sha::sha256(content.as_bytes()); + let data = CONFIG.parse(path, &content)?; + Ok((data, digest)) +} -- 2.47.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel