From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup v2 12/27] api: config: allow encryption key manipulation for sync job
Date: Fri, 10 Apr 2026 18:54:39 +0200 [thread overview]
Message-ID: <20260410165454.1578501-13-c.ebner@proxmox.com> (raw)
In-Reply-To: <20260410165454.1578501-1-c.ebner@proxmox.com>
Since the SyncJobConfig got extended to include an optional active
encryption key, set the default to none.
Extend the api config update handler to also set, update or delete
the active encryption key based on the provided parameters.
Associated keys will also be updated accordingly, however it is
assured that the previously active key will remain associated, if
changed.
They encryption key will be used to encrypt unencrypted backup
snapshots during push sync. Any of the associated keys will be used
to decrypt snapshots with matching key fingerprint during pull sync.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
src/api2/config/sync.rs | 55 ++++++++++++++++++++++++++++++++++++++---
1 file changed, 52 insertions(+), 3 deletions(-)
diff --git a/src/api2/config/sync.rs b/src/api2/config/sync.rs
index 51be7e208..3b92958c6 100644
--- a/src/api2/config/sync.rs
+++ b/src/api2/config/sync.rs
@@ -324,6 +324,22 @@ pub fn read_sync_job(id: String, rpcenv: &mut dyn RpcEnvironment) -> Result<Sync
Ok(sync_job)
}
+fn keep_previous_key_as_associated(
+ current: &SyncJobConfig,
+ associated_keys: &mut Option<Vec<String>>,
+) {
+ if let Some(prev) = ¤t.active_encryption_key {
+ match associated_keys {
+ Some(ref mut keys) => {
+ if !keys.contains(prev) {
+ keys.push(prev.clone());
+ }
+ }
+ None => *associated_keys = Some(vec![prev.clone()]),
+ }
+ }
+}
+
#[api()]
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
@@ -367,6 +383,10 @@ pub enum DeletableProperty {
UnmountOnDone,
/// Delete the sync_direction property,
SyncDirection,
+ /// Delete the active encryption key property,
+ ActiveEncryptionKey,
+ /// Delete associated key property,
+ AssociatedKey,
}
#[api(
@@ -408,7 +428,7 @@ required sync job owned by user. Additionally, remove vanished requires RemoteDa
#[allow(clippy::too_many_arguments)]
pub fn update_sync_job(
id: String,
- update: SyncJobConfigUpdater,
+ mut update: SyncJobConfigUpdater,
delete: Option<Vec<DeletableProperty>>,
digest: Option<String>,
rpcenv: &mut dyn RpcEnvironment,
@@ -431,6 +451,7 @@ pub fn update_sync_job(
}
if let Some(delete) = delete {
+ let mut allow_remove_associated = true;
for delete_prop in delete {
match delete_prop {
DeletableProperty::Remote => {
@@ -490,6 +511,16 @@ pub fn update_sync_job(
DeletableProperty::SyncDirection => {
data.sync_direction = None;
}
+ DeletableProperty::ActiveEncryptionKey => {
+ allow_remove_associated = data.active_encryption_key.is_none();
+ keep_previous_key_as_associated(&data, &mut update.associated_key);
+ data.active_encryption_key = None;
+ }
+ DeletableProperty::AssociatedKey => {
+ if allow_remove_associated {
+ data.associated_key = None;
+ }
+ }
}
}
}
@@ -518,8 +549,8 @@ pub fn update_sync_job(
if let Some(remote_ns) = update.remote_ns {
data.remote_ns = Some(remote_ns);
}
- if let Some(owner) = update.owner {
- data.owner = Some(owner);
+ if let Some(owner) = &update.owner {
+ data.owner = Some(owner.clone());
}
if let Some(group_filter) = update.group_filter {
data.group_filter = Some(group_filter);
@@ -549,6 +580,22 @@ pub fn update_sync_job(
data.sync_direction = Some(sync_direction);
}
+ if let Some(active_encryption_key) = update.active_encryption_key {
+ let owner = update.owner.as_ref().unwrap_or_else(|| {
+ data.owner
+ .as_ref()
+ .unwrap_or_else(|| Authid::root_auth_id())
+ });
+ sync_user_can_access_optional_key(Some(&active_encryption_key), owner)?;
+
+ keep_previous_key_as_associated(&data, &mut update.associated_key);
+ data.active_encryption_key = Some(active_encryption_key);
+ }
+
+ if let Some(associated_key) = update.associated_key {
+ data.associated_key = Some(associated_key);
+ }
+
if update.limit.rate_in.is_some() {
data.limit.rate_in = update.limit.rate_in;
}
@@ -721,6 +768,8 @@ acl:1:/remote/remote1/remotestore1:write@pbs:RemoteSyncOperator
run_on_mount: None,
unmount_on_done: None,
sync_direction: None, // use default
+ active_encryption_key: None,
+ associated_key: None,
};
// should work without ACLs
--
2.47.3
next prev parent reply other threads:[~2026-04-10 16:55 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-04-10 16:54 [PATCH proxmox{,-backup} v2 00/27] fix #7251: implement server side encryption support for push sync jobs Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox v2 01/27] pbs-api-types: define en-/decryption key type and schema Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox v2 02/27] pbs-api-types: sync job: add optional cryptographic keys to config Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 03/27] datastore: blob: implement async reader for data blobs Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 04/27] datastore: manifest: add helper for change detection fingerprint Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 05/27] pbs-key-config: introduce store_with() for KeyConfig Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 06/27] pbs-config: implement encryption key config handling Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 07/27] pbs-config: acls: add 'encryption-keys' as valid 'system' subpath Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 08/27] ui: expose 'encryption-keys' as acl subpath for 'system' Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 09/27] sync: add helper to check encryption key acls and load key Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 10/27] api: config: add endpoints for encryption key manipulation Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 11/27] api: config: check sync owner has access to en-/decryption keys Christian Ebner
2026-04-10 16:54 ` Christian Ebner [this message]
2026-04-10 16:54 ` [PATCH proxmox-backup v2 13/27] sync: push: rewrite manifest instead of pushing pre-existing one Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 14/27] api: push sync: expose optional encryption key for push sync Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 15/27] sync: push: optionally encrypt data blob on upload Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 16/27] sync: push: optionally encrypt client log on upload if key is given Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 17/27] sync: push: add helper for loading known chunks from previous snapshot Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 18/27] fix #7251: api: push: encrypt snapshots using configured encryption key Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 19/27] ui: define and expose encryption key management menu item and windows Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 20/27] ui: expose assigning encryption key to sync jobs Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 21/27] sync: pull: load encryption key if given in job config Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 22/27] sync: expand source chunk reader trait by crypt config Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 23/27] sync: pull: introduce and use decrypt index writer if " Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 24/27] sync: pull: extend encountered chunk by optional decrypted digest Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 25/27] sync: pull: decrypt blob files on pull if encryption key is configured Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 26/27] sync: pull: decrypt chunks and rewrite index file for matching key Christian Ebner
2026-04-10 16:54 ` [PATCH proxmox-backup v2 27/27] sync: pull: decrypt snapshots with matching encryption key fingerprint 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=20260410165454.1578501-13-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox