all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox v6 2/9] s3 client: implement AWS signature v4 request authentication
Date: Tue,  8 Jul 2025 19:00:30 +0200	[thread overview]
Message-ID: <20250708170114.1556057-3-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250708170114.1556057-1-c.ebner@proxmox.com>

The S3 API authenticates client requests by checking the
authentication signature provided by the requests `Authorization`
header. The latest AWS signature v4 signature is required for the
newest AWS regions [0] and most widely adapted [1-4], so rely soly on
that, not implementing older versions.

Adds helper methods to sign client requests, this includes encoding
and normalization of the headers, digest calculation of the request body
(if any) and signature generation.

[0] https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
[1] https://docs.ceph.com/en/reef/radosgw/s3/authentication/#aws-signature-v4
[2] https://cloud.google.com/storage/docs/interoperability
[3] https://docs.wasabi.com/v1/docs/how-do-i-use-aws-signature-version-4-with-wasabi
[4] https://min.io/product/s3-compatibility

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 proxmox-s3-client/Cargo.toml         |   3 +
 proxmox-s3-client/debian/control     |  12 +-
 proxmox-s3-client/src/aws_sign_v4.rs | 174 +++++++++++++++++++++++++++
 proxmox-s3-client/src/lib.rs         |   4 +
 4 files changed, 191 insertions(+), 2 deletions(-)
 create mode 100644 proxmox-s3-client/src/aws_sign_v4.rs

diff --git a/proxmox-s3-client/Cargo.toml b/proxmox-s3-client/Cargo.toml
index f62fc190..31deca59 100644
--- a/proxmox-s3-client/Cargo.toml
+++ b/proxmox-s3-client/Cargo.toml
@@ -22,10 +22,13 @@ openssl.workspace = true
 regex.workspace = true
 serde.workspace = true
 tracing.workspace = true
+url.workspace = true
 
 proxmox-base64.workspace = true
 proxmox-http = { workspace = true, features = [ "body", "client", "client-trait", "rate-limiter" ] }
 proxmox-schema = { workspace = true, features = [ "api-macro", "api-types" ] }
+proxmox-serde.workspace = true
+proxmox-time.workspace = true
 
 [features]
 default = []
diff --git a/proxmox-s3-client/debian/control b/proxmox-s3-client/debian/control
index 36b94143..0efb54db 100644
--- a/proxmox-s3-client/debian/control
+++ b/proxmox-s3-client/debian/control
@@ -26,9 +26,13 @@ Build-Depends-Arch: cargo:native <!nocheck>,
  librust-proxmox-schema-4+api-macro-dev (>= 4.1.0-~~) <!nocheck>,
  librust-proxmox-schema-4+api-types-dev (>= 4.1.0-~~) <!nocheck>,
  librust-proxmox-schema-4+default-dev (>= 4.1.0-~~) <!nocheck>,
+ librust-proxmox-serde-1+default-dev <!nocheck>,
+ librust-proxmox-serde-1+serde-json-dev <!nocheck>,
+ librust-proxmox-time-2+default-dev (>= 2.1.0-~~) <!nocheck>,
  librust-regex-1+default-dev (>= 1.5-~~) <!nocheck>,
  librust-serde-1+default-dev <!nocheck>,
- librust-tracing-0.1+default-dev <!nocheck>
+ librust-tracing-0.1+default-dev <!nocheck>,
+ librust-url-2+default-dev (>= 2.2-~~) <!nocheck>
 Maintainer: Proxmox Support Team <support@proxmox.com>
 Standards-Version: 4.7.0
 Vcs-Git: git://git.proxmox.com/git/proxmox.git
@@ -62,9 +66,13 @@ Depends:
  librust-proxmox-schema-4+api-macro-dev (>= 4.1.0-~~),
  librust-proxmox-schema-4+api-types-dev (>= 4.1.0-~~),
  librust-proxmox-schema-4+default-dev (>= 4.1.0-~~),
+ librust-proxmox-serde-1+default-dev,
+ librust-proxmox-serde-1+serde-json-dev,
+ librust-proxmox-time-2+default-dev (>= 2.1.0-~~),
  librust-regex-1+default-dev (>= 1.5-~~),
  librust-serde-1+default-dev,
- librust-tracing-0.1+default-dev
+ librust-tracing-0.1+default-dev,
+ librust-url-2+default-dev (>= 2.2-~~)
 Provides:
  librust-proxmox-s3-client+default-dev (= ${binary:Version}),
  librust-proxmox-s3-client+impl-dev (= ${binary:Version}),
diff --git a/proxmox-s3-client/src/aws_sign_v4.rs b/proxmox-s3-client/src/aws_sign_v4.rs
new file mode 100644
index 00000000..3b9a1fbe
--- /dev/null
+++ b/proxmox-s3-client/src/aws_sign_v4.rs
@@ -0,0 +1,174 @@
+//! Helpers for request authentication using AWS signature version 4
+
+use anyhow::{bail, Error};
+use hyper::Request;
+use openssl::hash::MessageDigest;
+use openssl::pkey::{PKey, Private};
+use openssl::sha::sha256;
+use openssl::sign::Signer;
+use url::Url;
+
+use proxmox_http::Body;
+
+use super::client::S3ClientOptions;
+
+pub(crate) const AWS_SIGN_V4_DATETIME_FORMAT: &str = "%Y%m%dT%H%M%SZ";
+
+const AWS_SIGN_V4_DATE_FORMAT: &str = "%Y%m%d";
+const AWS_SIGN_V4_SERVICE_S3: &str = "s3";
+const AWS_SIGN_V4_REQUEST_POSTFIX: &str = "aws4_request";
+
+/// Generate signature for S3 request authentication using AWS signature version 4.
+/// See: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
+pub(crate) fn aws_sign_v4_signature(
+    request: &Request<Body>,
+    options: &S3ClientOptions,
+    epoch: i64,
+    payload_digest: &str,
+) -> Result<String, Error> {
+    // Include all headers in signature calculation since the reference docs note:
+    // "For the purpose of calculating an authorization signature, only the 'host' and any 'x-amz-*'
+    // headers are required. however, in order to prevent data tampering, you should consider
+    // including all the headers in the signature calculation."
+    // See https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html
+    let mut canonical_headers = Vec::new();
+    let mut signed_headers = Vec::new();
+    for (key, value) in request.headers() {
+        canonical_headers.push(format!(
+            "{}:{}",
+            // Header name has to be lower case, key.as_str() does guarantee that, see
+            // https://docs.rs/http/0.2.0/http/header/struct.HeaderName.html
+            key.as_str(),
+            // No need to trim since `HeaderValue` only allows visible UTF8 chars, see
+            // https://docs.rs/http/0.2.0/http/header/struct.HeaderValue.html
+            value.to_str()?,
+        ));
+        signed_headers.push(key.as_str());
+    }
+    canonical_headers.sort();
+    signed_headers.sort();
+    let signed_headers_string = signed_headers.join(";");
+
+    let mut canonical_queries = Url::parse(&request.uri().to_string())?
+        .query_pairs()
+        .map(|(key, value)| {
+            format!(
+                "{}={}",
+                aws_sign_v4_uri_encode(&key, false),
+                aws_sign_v4_uri_encode(&value, false),
+            )
+        })
+        .collect::<Vec<String>>();
+    canonical_queries.sort();
+
+    let canonical_request = format!(
+        "{}\n{}\n{}\n{}\n\n{}\n{}",
+        request.method().as_str(),
+        request.uri().path(),
+        canonical_queries.join("&"),
+        canonical_headers.join("\n"),
+        signed_headers_string,
+        payload_digest,
+    );
+
+    let date = proxmox_time::strftime_utc(AWS_SIGN_V4_DATE_FORMAT, epoch)?;
+    let datetime = proxmox_time::strftime_utc(AWS_SIGN_V4_DATETIME_FORMAT, epoch)?;
+
+    let credential_scope = format!(
+        "{date}/{}/{AWS_SIGN_V4_SERVICE_S3}/{AWS_SIGN_V4_REQUEST_POSTFIX}",
+        options.region,
+    );
+    let canonical_request_hash = hex::encode(sha256(canonical_request.as_bytes()));
+    let string_to_sign =
+        format!("AWS4-HMAC-SHA256\n{datetime}\n{credential_scope}\n{canonical_request_hash}");
+
+    let date_sign_key = PKey::hmac(format!("AWS4{}", options.secret_key).as_bytes())?;
+    let date_tag = hmac_sha256(&date_sign_key, date.as_bytes())?;
+
+    let region_sign_key = PKey::hmac(&date_tag)?;
+    let region_tag = hmac_sha256(&region_sign_key, options.region.as_bytes())?;
+
+    let service_sign_key = PKey::hmac(&region_tag)?;
+    let service_tag = hmac_sha256(&service_sign_key, AWS_SIGN_V4_SERVICE_S3.as_bytes())?;
+
+    let signing_key = PKey::hmac(&service_tag)?;
+    let signing_tag = hmac_sha256(&signing_key, AWS_SIGN_V4_REQUEST_POSTFIX.as_bytes())?;
+
+    let signature_key = PKey::hmac(&signing_tag)?;
+    let signature = hmac_sha256(&signature_key, string_to_sign.as_bytes())?;
+    let signature = hex::encode(&signature);
+
+    Ok(format!(
+        "AWS4-HMAC-SHA256 Credential={}/{credential_scope},SignedHeaders={signed_headers_string},Signature={signature}",
+        options.access_key,
+    ))
+}
+// Custom `uri_encode` implementation as recommended by AWS docs, since possible implementation
+// incompatibility with uri encoding libraries.
+// See: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
+pub(crate) fn aws_sign_v4_uri_encode(input: &str, is_object_key_name: bool) -> String {
+    // Assume up to  2 bytes per char max in output
+    let mut accumulator = String::with_capacity(2 * input.len());
+
+    input.chars().for_each(|char| {
+        match char {
+            // Unreserved characters, do not uri encode these bytes
+            'A'..='Z' | 'a'..='z' | '0'..='9' | '-' | '.' | '_' | '~' => accumulator.push(char),
+            // Space character is reserved, must be encoded as '%20', not '+'
+            ' ' => accumulator.push_str("%20"),
+            // Encode the forward slash character, '/', everywhere except in the object key name
+            '/' if !is_object_key_name => accumulator.push_str("%2F"),
+            '/' if is_object_key_name => accumulator.push(char),
+            // URI encoded byte is formed by a '%' and the two-digit hexadecimal value of the byte
+            // Letters in the hexadecimal value must be uppercase
+            _ => {
+                for byte in char.to_string().as_bytes() {
+                    accumulator.push_str(&format!("%{byte:02X}"));
+                }
+            }
+        }
+    });
+
+    accumulator
+}
+
+// Helper for hmac sha256 calculation
+fn hmac_sha256(key: &PKey<Private>, data: &[u8]) -> Result<Vec<u8>, Error> {
+    let mut signer = Signer::new(MessageDigest::sha256(), key)?;
+    signer.update(data)?;
+    let hmac = signer.sign_to_vec()?;
+    Ok(hmac)
+}
+
+/// Custom `uri_decode` implementation
+pub fn uri_decode(input: &str) -> Result<String, Error> {
+    // Require full capacity if no characters are encoded, less otherwise
+    let mut accumulator = String::with_capacity(input.len());
+    let mut subslices_iter = input.split('%');
+    // First item present also when empty, nevertheless fallback to empty default
+    accumulator.push_str(subslices_iter.next().unwrap_or(""));
+
+    for subslice in subslices_iter {
+        if let Some((hex_digits, utf8_rest)) = subslice.as_bytes().split_at_checked(2) {
+            let mut ascii_code = 0u8;
+            for (pos, digit) in hex_digits.iter().enumerate().take(2) {
+                let val = match digit {
+                    b'0'..=b'9' => digit - b'0',
+                    b'A'..=b'F' => digit - b'A' + 10,
+                    b'a'..=b'f' => digit - b'a' + 10,
+                    _ => bail!("unexpected hex digit at %{subslice}"),
+                };
+                // Shift first diigts value to be upper byte half
+                ascii_code += val << (4 * ((pos + 1) % 2));
+            }
+            accumulator.push(ascii_code as char);
+            // Started from valid utf-8 without modification
+            let rest = unsafe { std::str::from_utf8_unchecked(utf8_rest) };
+            accumulator.push_str(rest);
+        } else {
+            bail!("failed to decode string at subslice %{subslice}");
+        }
+    }
+
+    Ok(accumulator)
+}
diff --git a/proxmox-s3-client/src/lib.rs b/proxmox-s3-client/src/lib.rs
index e579ffbb..f65d123f 100644
--- a/proxmox-s3-client/src/lib.rs
+++ b/proxmox-s3-client/src/lib.rs
@@ -6,6 +6,10 @@
 mod api_types;
 pub use api_types::*;
 
+#[cfg(feature = "impl")]
+mod aws_sign_v4;
+#[cfg(feature = "impl")]
+pub use aws_sign_v4::uri_decode;
 #[cfg(feature = "impl")]
 mod client;
 #[cfg(feature = "impl")]
-- 
2.47.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2025-07-08 17:01 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-08 17:00 [pbs-devel] [PATCH proxmox{, -backup} v6 00/46] fix #2943: S3 storage backend for datastores Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 1/9] s3 client: add crate for AWS s3 compatible object store client Christian Ebner
2025-07-08 17:00 ` Christian Ebner [this message]
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 3/9] s3 client: add dedicated type for s3 object keys Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 4/9] s3 client: add type for last modified timestamp in responses Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 5/9] s3 client: add helper to parse http date headers Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 6/9] s3 client: implement methods to operate on s3 objects in bucket Christian Ebner
2025-07-09 10:04   ` Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 7/9] s3 client: add example usage for basic operations Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 8/9] pbs-api-types: extend datastore config by backend config enum Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 9/9] pbs-api-types: maintenance: add new maintenance mode S3 refresh Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 01/37] datastore: add helpers for path/digest to s3 object key conversion Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 02/37] config: introduce s3 object store client configuration Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 03/37] api: config: implement endpoints to manipulate and list s3 configs Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 04/37] api: datastore: check s3 backend bucket access on datastore create Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 05/37] api/cli: add endpoint and command to check s3 client connection Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 06/37] datastore: allow to get the backend for a datastore Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 07/37] api: backup: store datastore backend in runtime environment Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 08/37] api: backup: conditionally upload chunks to s3 object store backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 09/37] api: backup: conditionally upload blobs " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 10/37] api: backup: conditionally upload indices " Christian Ebner
2025-07-09  7:55   ` Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 11/37] api: backup: conditionally upload manifest " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 12/37] sync: pull: conditionally upload content to s3 backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 13/37] api: reader: fetch chunks based on datastore backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 14/37] datastore: local chunk reader: read chunks based on backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 15/37] verify worker: add datastore backed to verify worker Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 16/37] verify: implement chunk verification for stores with s3 backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 17/37] datastore: create namespace marker in " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 18/37] datastore: create/delete protected marker file on s3 storage backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 19/37] datastore: prune groups/snapshots from s3 object store backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 20/37] datastore: get and set owner for s3 " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 21/37] datastore: implement garbage collection for s3 backend Christian Ebner
2025-07-10  6:59   ` Thomas Lamprecht
2025-07-10  7:36     ` Christian Ebner
2025-07-10  9:47     ` Christian Ebner
2025-07-10 11:15       ` Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 22/37] ui: add datastore type selector and reorganize component layout Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 23/37] ui: add s3 client edit window for configuration create/edit Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 24/37] ui: add s3 client view for configuration Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 25/37] ui: expose the s3 client view in the navigation tree Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 26/37] ui: add s3 client selector and bucket field for s3 backend setup Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 27/37] tools: lru cache: add removed callback for evicted cache nodes Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 28/37] tools: async lru cache: implement insert, remove and contains methods Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 29/37] datastore: add local datastore cache for network attached storages Christian Ebner
2025-07-10 10:05   ` Thomas Lamprecht
2025-07-10 10:30     ` Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 30/37] api: backup: use local datastore cache on s3 backend chunk upload Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 31/37] api: reader: use local datastore cache on s3 backend chunk fetching Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 32/37] datastore: local chunk reader: get cached chunk from local cache store Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 33/37] api: backup: add no-cache flag to bypass local datastore cache Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 34/37] api/datastore: implement refresh endpoint for stores with s3 backend Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 35/37] cli: add dedicated subcommand for datastore s3 refresh Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 36/37] ui: render s3 refresh as valid maintenance type and task description Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 37/37] ui: expose s3 refresh button for datastores backed by object store Christian Ebner
2025-07-10 17:09 ` [pbs-devel] superseded: [PATCH proxmox{, -backup} v6 00/46] fix #2943: S3 storage backend for datastores Christian Ebner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250708170114.1556057-3-c.ebner@proxmox.com \
    --to=c.ebner@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal