From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [45.144.208.40]) by lore.proxmox.com (Postfix) with ESMTPS id DFE061FF0BC for ; Mon, 16 Nov 2026 15:58:04 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id B16D6216DF; Mon, 16 Nov 2026 15:58:04 +0100 (CET) Message-ID: <60ed22a6-5074-4de2-8109-efd6afe45ced@proxmox.com> Date: Mon, 16 Nov 2026 15:57:55 +0100 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird From: Christian Ebner Subject: Re: [RFC PATCH proxmox-backup 04/12] fix #7452: api: datastore: add endpoints for snapshot attributes To: Jakob-Tobias Winter , pbs-devel@lists.proxmox.com References: <20261113085637.57360-3-tobias@stuttgart.de> <20261113085637.57360-7-tobias@stuttgart.de> Content-Language: en-US, de-DE In-Reply-To: <20261113085637.57360-7-tobias@stuttgart.de> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1794841075393 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.225 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: AHLVJFKFO5MT24PWUEOFWJMR6MAI7VHL X-Message-ID-Hash: AHLVJFKFO5MT24PWUEOFWJMR6MAI7VHL X-MailFrom: c.ebner@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: On 11/13/26 10:06 AM, Jakob-Tobias Winter wrote: > The attributes of a snapshot can be read and set next to its notes > and its protection flag, with the privileges required for the notes. > A client which may set the notes of its backups can therefore set > the attributes after a backup without further permissions. I think it would be better if the client cannot modify attributes of a snapshot, and modification can only be done by a highly privileged user on the PBS side (e.g. root@pam only) It would be better if the client provides the list of attributes it wants to set for the to-be backed up snapshot as optional params during the backup session initialization, during the protocol upgrade in [0]. These should then be checked against the ones which a client may upload as part of the manifest, and reject if they do not match. The latter must be checked in [1]. This is especially of interest since attributes might be used for other jobs as well, e.g. pruning, where we do not want a client to overwrite the state again. [0] https://git.proxmox.com/?p=proxmox-backup.git;a=blob;f=src/api2/backup/mod.rs;h=a9b1ca5c268016978d292ebc03aaa1a7d3afcaaa;hb=HEAD#l74 [1] https://git.proxmox.com/?p=proxmox-backup.git;a=blob;f=src/api2/backup/environment.rs;h=be70d74f828e33b0020d4b7b5825cf98af77901d;hb=HEAD#l798 > > Attributes are passed as a list of 'KEY=VALUE' entries, with one > entry for each value of a key. Setting them replaces all attributes > of the snapshot. An empty list is stored as well, so that a snapshot > without attributes can be told from one whose client never set any. > > Signed-off-by: Jakob-Tobias Winter > --- > src/api2/admin/datastore.rs | 128 +++++++++++++++++++++++++++++++++++- > 1 file changed, 126 insertions(+), 2 deletions(-) > > diff --git a/src/api2/admin/datastore.rs b/src/api2/admin/datastore.rs > index 3ba25934f..6b907da32 100644 > --- a/src/api2/admin/datastore.rs > +++ b/src/api2/admin/datastore.rs > @@ -43,8 +43,9 @@ use pbs_api_types::{ > IGNORE_VERIFIED_BACKUPS_SCHEMA, JobScheduleStatus, KeepOptions, MAX_NAMESPACE_DEPTH, > MaintenanceMode, MaintenanceType, NS_MAX_DEPTH_SCHEMA, Operation, PRIV_DATASTORE_AUDIT, > PRIV_DATASTORE_BACKUP, PRIV_DATASTORE_MODIFY, PRIV_DATASTORE_PRUNE, PRIV_DATASTORE_READ, > - PRIV_DATASTORE_VERIFY, PRIV_SYS_MODIFY, PruneJobOptions, SnapshotListItem, SyncJobConfig, UPID, > - UPID_SCHEMA, VERIFICATION_OUTDATED_AFTER_SCHEMA, VERIFY_JOB_READ_THREADS_SCHEMA, > + PRIV_DATASTORE_VERIFY, PRIV_SYS_MODIFY, PruneJobOptions, SNAPSHOT_ATTRIBUTE_LIST_SCHEMA, > + SnapshotAttributes, SnapshotListItem, SyncJobConfig, UPID, UPID_SCHEMA, > + VERIFICATION_OUTDATED_AFTER_SCHEMA, VERIFY_JOB_READ_THREADS_SCHEMA, > VERIFY_JOB_VERIFY_THREADS_SCHEMA, print_ns_and_snapshot, print_store_and_ns, > }; > use pbs_client::pxar::{create_tar, create_zip}; > @@ -2223,6 +2224,123 @@ pub fn set_notes( > Ok(()) > } > > +#[api( > + input: { > + properties: { > + store: { schema: DATASTORE_SCHEMA }, > + ns: { > + type: BackupNamespace, > + optional: true, > + }, > + backup_dir: { > + type: pbs_api_types::BackupDir, > + flatten: true, > + }, > + }, > + }, > + returns: { > + schema: SNAPSHOT_ATTRIBUTE_LIST_SCHEMA, > + }, > + access: { > + permission: &Permission::Anybody, > + description: "Requires on /datastore/{store}[/{namespace}] either DATASTORE_AUDIT for any \ > + or DATASTORE_BACKUP and being the owner of the group", > + }, > +)] > +/// Get the attributes of a specific backup > +pub fn get_attributes( > + store: String, > + ns: Option, > + backup_dir: pbs_api_types::BackupDir, > + rpcenv: &mut dyn RpcEnvironment, > +) -> Result, Error> { > + let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; > + let ns = ns.unwrap_or_default(); > + > + let datastore = check_privs_and_load_store( > + &store, > + &ns, > + &auth_id, > + PRIV_DATASTORE_AUDIT, > + PRIV_DATASTORE_BACKUP, > + Operation::Read, > + &backup_dir.group, > + )?; > + > + let backup_dir = datastore.backup_dir(ns, backup_dir)?; > + > + let (manifest, _) = backup_dir.load_manifest()?; > + > + let attributes = manifest.attributes().unwrap_or_default(); > + > + Ok(attributes > + .iter() > + .flat_map(|(key, values)| values.iter().map(move |value| format!("{key}={value}"))) comment: The formatting here is better defined as helper on the api type, that is an implementation detail. Further, given that the result here is a Vec, it would make sense to define the AttributeItem as dedicated API type instead? This introduces basically a second type of serialization next to the json one. > + .collect()) > +} > + > +#[api( > + input: { > + properties: { > + store: { schema: DATASTORE_SCHEMA }, > + ns: { > + type: BackupNamespace, > + optional: true, > + }, > + backup_dir: { > + type: pbs_api_types::BackupDir, > + flatten: true, > + }, > + attributes: { > + schema: SNAPSHOT_ATTRIBUTE_LIST_SCHEMA, > + optional: true, > + }, > + }, > + }, > + access: { > + permission: &Permission::Anybody, > + description: "Requires on /datastore/{store}[/{namespace}] either DATASTORE_MODIFY for any \ > + or DATASTORE_BACKUP and being the owner of the group", > + }, > +)] > +/// Set the attributes of a specific backup, replacing the existing ones > +pub fn set_attributes( > + store: String, > + ns: Option, > + backup_dir: pbs_api_types::BackupDir, > + attributes: Option>, same as for others, this would be better defined as dedicated type, which also holds the deserialization logic ... > + rpcenv: &mut dyn RpcEnvironment, > +) -> Result<(), Error> { > + let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; > + let ns = ns.unwrap_or_default(); > + > + let datastore = check_privs_and_load_store( > + &store, > + &ns, > + &auth_id, > + PRIV_DATASTORE_MODIFY, > + PRIV_DATASTORE_BACKUP, > + Operation::Write, > + &backup_dir.group, > + )?; > + > + let mut attribute_map = SnapshotAttributes::new(); > + for attribute in attributes.unwrap_or_default() { > + // the format is ensured by the schema > + if let Some((key, value)) = attribute.split_once('=') { > + attribute_map > + .entry(key.to_string()) > + .or_default() > + .insert(value.to_string()); ... so this would live on the type in pbs-api-types instead, as this is an implementation detail thereof. > + } > + } > + > + let backup_dir = datastore.backup_dir(ns, backup_dir)?; > + datastore.set_attributes(attribute_map, backup_dir)?; > + > + Ok(()) > +} > + > #[api( > input: { > properties: { > @@ -2930,6 +3048,12 @@ const DATASTORE_INFO_SUBDIRS: SubdirMap = &[ > "active-operations", > &Router::new().get(&API_METHOD_GET_ACTIVE_OPERATIONS), > ), > + ( > + "attributes", > + &Router::new() > + .get(&API_METHOD_GET_ATTRIBUTES) > + .put(&API_METHOD_SET_ATTRIBUTES), > + ), > ("catalog", &Router::new().get(&API_METHOD_CATALOG)), > ( > "change-owner",