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 6290C1FF2AD for ; Thu, 4 Jul 2024 14:53:10 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3EE0832B08; Thu, 4 Jul 2024 14:53:26 +0200 (CEST) MIME-Version: 1.0 In-Reply-To: <20240610084038.71643-3-l.wagner@proxmox.com> References: <20240610084038.71643-1-l.wagner@proxmox.com> <20240610084038.71643-3-l.wagner@proxmox.com> From: Fabian =?utf-8?q?Gr=C3=BCnbichler?= To: Proxmox VE development discussion Date: Thu, 04 Jul 2024 14:53:10 +0200 Message-ID: <172009759069.180658.6701916029718316579@yuna.proxmox.com> User-Agent: alot/0.10 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.050 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: Re: [pve-devel] [PATCH manager v7 02/19] api: jobs: vzdump: pass job 'job-id' parameter X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Quoting Lukas Wagner (2024-06-10 10:40:21) > This allows us to access us the backup job id in the send_notification > function, where we can set it as metadata for the notification. should we have some sort of safeguard against passing in a bogus/fake job-id? e.g., right now, I could call this API endpoint with arbitrary job-id values and (potentially) trigger notifications to other users.. some possible avenues would be: - limit the parameter to root (but that means only scheduled executions can set it, manual invocations can't) - limit to existing job-ids (doesn't provide much benefit) - .. > > Signed-off-by: Lukas Wagner > --- > PVE/API2/VZDump.pm | 8 ++++++++ > PVE/Jobs/VZDump.pm | 4 +++- > PVE/VZDump.pm | 6 +++--- > 3 files changed, 14 insertions(+), 4 deletions(-) > > diff --git a/PVE/API2/VZDump.pm b/PVE/API2/VZDump.pm > index 7f92e7ec..84dbc100 100644 > --- a/PVE/API2/VZDump.pm > +++ b/PVE/API2/VZDump.pm > @@ -53,6 +53,14 @@ __PACKAGE__->register_method ({ > parameters => { > additionalProperties => 0, > properties => PVE::VZDump::Common::json_config_properties({ > + 'job-id' => { > + description => "The ID of the backup job. If set, the 'backup-job' metadata field" > + . " of the backup notification will be set to this value.", > + type => 'string', > + format => 'pve-configid', > + maxLength => 256, > + optional => 1, > + }, > stdout => { > type => 'boolean', > description => "Write tar to stdout, not to a file.", > diff --git a/PVE/Jobs/VZDump.pm b/PVE/Jobs/VZDump.pm > index b8e57945..2dad3f55 100644 > --- a/PVE/Jobs/VZDump.pm > +++ b/PVE/Jobs/VZDump.pm > @@ -12,7 +12,7 @@ use PVE::API2::VZDump; > use base qw(PVE::VZDump::JobBase); > > sub run { > - my ($class, $conf) = @_; > + my ($class, $conf, $job_id) = @_; > > my $props = $class->properties(); > # remove all non vzdump related options > @@ -20,6 +20,8 @@ sub run { > delete $conf->{$opt} if !defined($props->{$opt}); > } > > + $conf->{'job-id'} = $job_id; > + > # Required as string parameters # FIXME why?! we could just check ref() > for my $key (keys $PVE::VZDump::Common::PROPERTY_STRINGS->%*) { > if ($conf->{$key} && ref($conf->{$key}) eq 'HASH') { > diff --git a/PVE/VZDump.pm b/PVE/VZDump.pm > index 5b7080f3..2167b289 100644 > --- a/PVE/VZDump.pm > +++ b/PVE/VZDump.pm > @@ -483,6 +483,7 @@ sub send_notification { > my ($self, $tasklist, $total_time, $err, $detail_pre, $detail_post) = @_; > > my $opts = $self->{opts}; > + my $job_id = $opts->{'job-id'}; > my $mailto = $opts->{mailto}; > my $cmdline = $self->{cmdline}; > my $policy = $opts->{mailnotification} // 'always'; > @@ -529,12 +530,11 @@ sub send_notification { > }; > > my $fields = { > - # TODO: There is no straight-forward way yet to get the > - # backup job id here... (I think pvescheduler would need > - # to pass that to the vzdump call?) > type => "vzdump", > hostname => $hostname, > }; > + # Add backup-job metadata field in case this is a backup job. > + $fields->{'job-id'} = $job_id if $job_id; > > my $severity = $failed ? "error" : "info"; > my $email_configured = $mailto && scalar(@$mailto); > -- > 2.39.2 > > > > _______________________________________________ > pve-devel mailing list > pve-devel@lists.proxmox.com > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel > > _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel