From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 4E8EB1FF191 for ; Mon, 16 Jun 2025 16:22:00 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id A16FE9FF6; Mon, 16 Jun 2025 16:22:21 +0200 (CEST) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Mon, 16 Jun 2025 16:21:22 +0200 Message-Id: <20250616142156.413652-10-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250616142156.413652-1-c.ebner@proxmox.com> References: <20250616142156.413652-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.034 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 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 v3 07/41] s3 client: add dedicated type for s3 object keys 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" S3 objects are uniquely identified within a bucket by their object key [0]. Implements conversion and utility traits to easily convert and encode a string or a chunk digest as corresponding object key for the S3 storage backend. Adds type checking for s3 client operations requiring an object key. [0] https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html Signed-off-by: Christian Ebner --- pbs-s3-client/Cargo.toml | 1 + pbs-s3-client/src/lib.rs | 4 +- pbs-s3-client/src/object_key.rs | 102 ++++++++++++++++++++++++++++++++ 3 files changed, 106 insertions(+), 1 deletion(-) create mode 100644 pbs-s3-client/src/object_key.rs diff --git a/pbs-s3-client/Cargo.toml b/pbs-s3-client/Cargo.toml index f068d9246..9402257bd 100644 --- a/pbs-s3-client/Cargo.toml +++ b/pbs-s3-client/Cargo.toml @@ -11,6 +11,7 @@ anyhow.workspace = true hex = { workspace = true, features = [ "serde" ] } hyper.workspace = true openssl.workspace = true +serde.workspace = true tracing.workspace = true url.workspace = true diff --git a/pbs-s3-client/src/lib.rs b/pbs-s3-client/src/lib.rs index 5a60b92ec..8b2be9721 100644 --- a/pbs-s3-client/src/lib.rs +++ b/pbs-s3-client/src/lib.rs @@ -1,3 +1,5 @@ mod aws_sign_v4; mod client; -pub use client::{S3Client, S3ClientOptions}; +pub use client::{S3Client, S3ClientOptions, S3PathPrefix}; +mod object_key; +pub use object_key::{S3ObjectKey, S3_CONTENT_PREFIX}; diff --git a/pbs-s3-client/src/object_key.rs b/pbs-s3-client/src/object_key.rs new file mode 100644 index 000000000..0afe275b4 --- /dev/null +++ b/pbs-s3-client/src/object_key.rs @@ -0,0 +1,102 @@ +use anyhow::Error; + +use crate::aws_sign_v4::aws_sign_v4_uri_encode; + +pub const S3_CONTENT_PREFIX: &str = ".cnt"; + +#[derive(Clone, Debug)] +pub struct S3ObjectKey { + object_key: String, +} + +#[derive(Clone, Debug)] +pub struct RelS3ObjectKey { + rel_object_key: String, +} + +// All regular keys (non-digests) get prefixed by a `/.cnt`, so that +// content listing without all the chunks can be done by that prefix. +impl core::convert::From<&str> for RelS3ObjectKey { + fn from(s: &str) -> Self { + let s = s.strip_prefix("/").unwrap_or(s); + let rel_object_key = format!( + "{S3_CONTENT_PREFIX}/{encoded_key}", + encoded_key = aws_sign_v4_uri_encode(s, true), + ); + + Self { rel_object_key } + } +} + +impl core::convert::From<&[u8; 32]> for RelS3ObjectKey { + fn from(digest: &[u8; 32]) -> Self { + // Use the same layout as on regular PBS datastores, including the 4 hex digit digest prefix + let object_key = hex::encode(digest); + let digest_prefix = &object_key[..4]; + Self { + rel_object_key: format!(".chunks/{digest_prefix}/{object_key}"), + } + } +} + +impl core::convert::From<[u8; 32]> for RelS3ObjectKey { + fn from(digest: [u8; 32]) -> Self { + Self::from(&digest) + } +} + +impl RelS3ObjectKey { + pub fn to_full_key(&self, prefix: &str) -> S3ObjectKey { + S3ObjectKey { + object_key: format!("{prefix}/{}", self.rel_object_key), + } + } +} + +impl std::ops::Deref for S3ObjectKey { + type Target = str; + + fn deref(&self) -> &Self::Target { + &self.object_key + } +} + +impl std::fmt::Display for S3ObjectKey { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.object_key) + } +} + +impl std::str::FromStr for S3ObjectKey { + type Err = Error; + + fn from_str(s: &str) -> Result { + Ok(Self { + object_key: s.to_string(), + }) + } +} + +proxmox_serde::forward_serialize_to_display!(S3ObjectKey); + +// Do not mangle with prefixes when de-serializing +impl<'de> serde::Deserialize<'de> for S3ObjectKey { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + let object_key = std::borrow::Cow::<'de, str>::deserialize(deserializer)?.to_string(); + Ok(Self { object_key }) + } +} + +impl S3ObjectKey { + /// Generate source key for copy object operations given the source bucket. + pub fn to_copy_source_key(&self, source_bucket: &str) -> Self { + Self { + // object key already contains the required separator slash in-between source bucket + // and source object key. + object_key: format!("{source_bucket}{}", self.object_key), + } + } +} -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel