From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup 25/28] datastore/config: parse and enforce maximum retention timespan
Date: Thu, 13 Aug 2026 19:09:59 +0200 [thread overview]
Message-ID: <20260813171002.809441-26-c.ebner@proxmox.com> (raw)
In-Reply-To: <20260813171002.809441-1-c.ebner@proxmox.com>
Allows to limit the maximum retention timespan which can be set on
snapshots, so users cannot block contents for unintended extended
periods of time.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
pbs-datastore/src/datastore.rs | 10 +++++++++-
src/api2/backup/mod.rs | 9 +++++++++
src/api2/config/datastore.rs | 9 +++++++++
src/server/pull.rs | 13 +++++++++++--
4 files changed, 38 insertions(+), 3 deletions(-)
diff --git a/pbs-datastore/src/datastore.rs b/pbs-datastore/src/datastore.rs
index c3db52269..cf68efe9a 100644
--- a/pbs-datastore/src/datastore.rs
+++ b/pbs-datastore/src/datastore.rs
@@ -34,7 +34,7 @@ use pbs_api_types::{
ArchiveType, Authid, BackupGroupDeleteStats, BackupNamespace, BackupType, ChunkOrder,
DataStoreConfig, DatastoreBackendConfig, DatastoreBackendType, GarbageCollectionCacheStats,
GarbageCollectionStatus, MAX_NAMESPACE_DEPTH, MaintenanceMode, MaintenanceType, Operation,
- S3Statistics, UPID,
+ RetentionTimespan, S3Statistics, UPID,
};
use pbs_config::s3::S3_CFG_TYPE_ID;
use pbs_config::{BackupLockGuard, ConfigVersionCache};
@@ -212,6 +212,7 @@ pub struct DataStoreImpl {
config_generation: Option<usize>,
request_counters: Option<Arc<SharedRequestCounters>>,
thresholds_exceeded_callback: Option<ThresholdsExceededCallback>,
+ max_retention_timespan: Option<RetentionTimespan>,
}
impl DataStoreImpl {
@@ -230,6 +231,7 @@ impl DataStoreImpl {
config_generation: None,
request_counters: None,
thresholds_exceeded_callback: None,
+ max_retention_timespan: None,
})
}
}
@@ -804,6 +806,7 @@ impl DataStore {
config_generation: generation,
request_counters,
thresholds_exceeded_callback,
+ max_retention_timespan: config.max_retention_timespan,
})
}
@@ -849,6 +852,11 @@ impl DataStore {
Ok(())
}
+ /// Return the configured maximum retenition timespan
+ pub fn max_retention_timespan(&self) -> Option<&RetentionTimespan> {
+ self.inner.max_retention_timespan.as_ref()
+ }
+
// Requires obtaining a shared chunk store lock beforehand
pub fn create_fixed_writer<P: AsRef<Path>>(
&self,
diff --git a/src/api2/backup/mod.rs b/src/api2/backup/mod.rs
index cfce13943..a6c06f8ff 100644
--- a/src/api2/backup/mod.rs
+++ b/src/api2/backup/mod.rs
@@ -156,6 +156,15 @@ fn upgrade_to_backup_protocol(
"backup"
};
+ if let Some(retain_until) = &retain_until {
+ if let Some(max_timespan) = datastore.max_retention_timespan() {
+ let max_timestamp = max_timespan.to_timestamp_from_systemtime()?;
+ if *retain_until > max_timestamp {
+ bail!("requested retention timestamp exceeds datastore limit")
+ }
+ }
+ }
+
// lock backup group to only allow one backup per group at a time
let (owner, group_guard) = datastore.create_locked_backup_group(
backup_group.backup_ns(),
diff --git a/src/api2/config/datastore.rs b/src/api2/config/datastore.rs
index e7028480c..347d0b9b6 100644
--- a/src/api2/config/datastore.rs
+++ b/src/api2/config/datastore.rs
@@ -440,6 +440,8 @@ pub enum DeletableProperty {
NotificationThresholds,
/// Delete the counter reset schedule.
CounterResetSchedule,
+ /// Delete the max-retention-timespan
+ MaxRetentionTimespan,
}
#[api(
@@ -545,6 +547,9 @@ pub fn update_datastore(
DeletableProperty::CounterResetSchedule => {
data.counter_reset_schedule = None;
}
+ DeletableProperty::MaxRetentionTimespan => {
+ data.max_retention_timespan = None;
+ }
}
}
}
@@ -646,6 +651,10 @@ pub fn update_datastore(
data.counter_reset_schedule = update.counter_reset_schedule;
}
+ if update.max_retention_timespan.is_some() {
+ data.max_retention_timespan = update.max_retention_timespan;
+ }
+
config.set_data(&name, "datastore", &data)?;
pbs_config::datastore::save_config(&config)?;
diff --git a/src/server/pull.rs b/src/server/pull.rs
index 893b642d4..bafb1fe21 100644
--- a/src/server/pull.rs
+++ b/src/server/pull.rs
@@ -140,14 +140,23 @@ impl PullParameters {
let lookup = crate::tools::lookup_with(store, Operation::Write);
let store = DataStore::lookup_datastore(lookup)?;
let backend = store.backend()?;
- let target = PullTarget { store, ns, backend };
let group_filter = group_filter.unwrap_or_default();
let retain_until = retention_timespan
- .map(|timespan| timespan.to_timestamp_from_systemtime())
+ .map(|timespan| {
+ if let Some(max_timespan) = (*store).max_retention_timespan() {
+ // sub-second precision not permitted by api type, fine to ignore
+ if timespan.as_timespan().as_secs() > max_timespan.as_timespan().as_secs() {
+ bail!("provided timespan '{timespan}' exceeds datastore limit of '{max_timespan}'");
+ }
+ }
+ timespan.to_timestamp_from_systemtime()
+ })
.transpose()?;
+ let target = PullTarget { store, ns, backend };
+
let crypt_configs = if let Some(key_ids) = &decryption_keys {
let mut crypt_configs = Vec::with_capacity(key_ids.len());
for key_id in key_ids {
--
2.47.3
next prev parent reply other threads:[~2026-08-13 17:11 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-13 17:09 [PATCH proxmox{,-backup} 00/28] append-only sync jobs and snapshot retention timespan Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox 01/28] pbs-api-types: add append only permission and role Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox 02/28] pbs-api-types: add remote datastore append privs " Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox 03/28] pbs-api-types: extend snapshot list items by retention timestamp Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox 04/28] pbs-api-types: extend sync job config by retention-timespan parameter Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox 05/28] pbs-api-types: add maximum retention timespan property to datastore Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 06/28] api: config: extend sync job config by new retention-timespan Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 07/28] api: admin: improve code style for status endpoint Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 08/28] client: avoid error in status if user lacks permissions Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 09/28] server: allow iterating contents for Datastore.Append permissions Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 10/28] api: backup: fix possible information leak in multi-tenant datastores Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 11/28] api: backup: allow backup for user/token with append permission Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 12/28] api: allow namespace creation on append permissions Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 13/28] api: sync: allow pull to target for user/token with append permission Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 14/28] sync: pull: allow pulling " Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 15/28] sync: push: allow push and ns creation on Remote.DatastoreAppend Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 16/28] datastore: conditionally treat missing manifest as error or bening Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 17/28] api: backup: provide retain-until timestamp for extended prune protection Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 18/28] tools: include retain-until timestamp in snapshot list items Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 19/28] client: backup writer: allow to send retain-until timestamp on backup Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 20/28] sync: push: allow to set retention timestamp for synced snapshots Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 21/28] sync: pull: " Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 22/28] sync: pull: protect retained snapshot from being overwritten Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 23/28] api: config: allow to set or delete reteniton timespan for sync jobs Christian Ebner
2026-08-13 17:09 ` [PATCH proxmox-backup 24/28] ui: add retention timespan form and use it for sync job edit window Christian Ebner
2026-08-13 17:09 ` Christian Ebner [this message]
2026-08-13 17:10 ` [PATCH proxmox-backup 26/28] ui: allow datastore wide max retention timespan configuration Christian Ebner
2026-08-13 17:10 ` [PATCH proxmox-backup 27/28] api: admin: allow to update snapshot retention for root user Christian Ebner
2026-08-13 17:10 ` [PATCH proxmox-backup 28/28] ui: show retention in datastore contents 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=20260813171002.809441-26-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