all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Fabian Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v4 manager 1/6] vzdump: verify parameters: properly verify notes-template
Date: Mon,  9 May 2022 12:34:08 +0200	[thread overview]
Message-ID: <20220509103413.68248-2-f.ebner@proxmox.com> (raw)
In-Reply-To: <20220509103413.68248-1-f.ebner@proxmox.com>

instead of just checking for a newline, do a full check already.

Also do the check at the beginning of generate_notes() for consistency
and remove the check after expansion to avoid failing late for things
like '{{cl{{node}}er}}' (which can even expand to a valid variable
making the error even more confusing).

Co-developed-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
---

Re-sent v3.

Changes from v2:
    * Check early rather than injecting error into notes.

 PVE/VZDump.pm | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/PVE/VZDump.pm b/PVE/VZDump.pm
index edcab696..0dbf8928 100644
--- a/PVE/VZDump.pm
+++ b/PVE/VZDump.pm
@@ -70,9 +70,32 @@ sub run_command {
     PVE::Tools::run_command($cmdstr, %param, logfunc => $logfunc);
 }
 
+my $verify_notes_template = sub {
+    my ($template) = @_;
+
+    die "contains a line feed\n" if $template =~ /\n/;
+
+    my @problematic = ();
+    while ($template =~ /\\(.)/g) {
+	my $char = $1;
+	push @problematic, "escape sequence '\\$char' at char " . (pos($template) - 2)
+	    if $char !~ /^[n\\]$/;
+    }
+
+    while ($template =~ /\{\{([^\s{}]+)\}\}/g) {
+	my $var = $1;
+	push @problematic, "variable '$var' at char " . (pos($template) - length($var))
+	    if $var !~ /^(cluster|guestname|node|vmid)$/;
+    }
+
+    die "found unknown: " . join(', ', @problematic) . "\n" if scalar(@problematic);
+};
+
 my $generate_notes = sub {
     my ($notes_template, $task) = @_;
 
+    $verify_notes_template->($notes_template);
+
     my $info = {
 	cluster => PVE::Cluster::get_clinfo()->{cluster}->{name},
 	guestname => $task->{hostname},
@@ -92,8 +115,6 @@ my $generate_notes = sub {
     my $vars = join('|', keys $info->%*);
     $notes_template =~ s/\{\{($vars)\}\}/$info->{$1}/g;
 
-    die "unexpected variable name '$1'\n" if $notes_template =~ m/\{\{([^\s}]+)\}\}/;
-
     return $notes_template;
 };
 
@@ -1325,8 +1346,10 @@ sub verify_vzdump_parameters {
 
     $parse_prune_backups_maxfiles->($param, 'CLI parameters');
 
-    raise_param_exc({'notes-template' => "contains a line feed"})
-	if $param->{'notes-template'} && $param->{'notes-template'} =~ m/\n/;
+    if (my $template = $param->{'notes-template'}) {
+	eval { $verify_notes_template->($template); };
+	raise_param_exc({'notes-template' => $@}) if $@;
+    }
 
     $param->{all} = 1 if (defined($param->{exclude}) && !$param->{pool});
 
-- 
2.30.2





  reply	other threads:[~2022-05-09 10:35 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-09 10:34 [pve-devel] [PATCH-SERIES v2 manager] notes-template followups Fabian Ebner
2022-05-09 10:34 ` Fabian Ebner [this message]
2022-05-09 10:34 ` [pve-devel] [PATCH v2 manager 2/6] vzdump: generate notes: initialize potentially undef values Fabian Ebner
2022-05-09 10:34 ` [pve-devel] [PATCH v2 manager 3/6] ui: manual backup: list possible template variables directly Fabian Ebner
2022-05-09 10:34 ` [pve-devel] [PATCH v2 manager 4/6] vzdump: avoid 'requires' constraint when parsing defaults Fabian Ebner
2022-05-09 10:34 ` [pve-devel] [PATCH v2 manager 5/6] ui: manual backup: also set notes-template default Fabian Ebner
2022-05-09 10:34 ` [pve-devel] [PATCH v2 manager 6/6] configs: vzdump: add " Fabian Ebner
2022-05-12 15:20 ` [pve-devel] applied: [PATCH-SERIES v2 manager] notes-template followups Thomas Lamprecht

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=20220509103413.68248-2-f.ebner@proxmox.com \
    --to=f.ebner@proxmox.com \
    --cc=pve-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