From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 5B4FE958F for ; Thu, 3 Aug 2023 14:18:02 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 6706C280A for ; Thu, 3 Aug 2023 14:17:39 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Thu, 3 Aug 2023 14:17:35 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id F2F464266D for ; Thu, 3 Aug 2023 14:17:34 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 3 Aug 2023 14:16:59 +0200 Message-Id: <20230803121719.519207-11-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230803121719.519207-1-l.wagner@proxmox.com> References: <20230803121719.519207-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.052 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 T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v6 pve-manager 10/30] api: notification: add api routes for gotify endpoints 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: , X-List-Received-Date: Thu, 03 Aug 2023 12:18:02 -0000 The Perl part of the API methods primarily defines the API schema, checks for any needed priviledges and then calls the actual Rust implementation exposed via perlmod. Any errors returned by the Rust code are translated into PVE::Exception, so that the API call fails with the correct HTTP error code. Signed-off-by: Lukas Wagner --- Notes: Changes since v4: - Explain the changes a bit more in the commit message - Factor out permission checks into a common helper - Minor code style improvements PVE/API2/Cluster/Notifications.pm | 262 ++++++++++++++++++++++++++++++ 1 file changed, 262 insertions(+) diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm index 2d907c35..b65c6957 100644 --- a/PVE/API2/Cluster/Notifications.pm +++ b/PVE/API2/Cluster/Notifications.pm @@ -24,6 +24,19 @@ sub make_properties_optional { return $properties; } +sub remove_protected_properties { + my ($properties, $to_remove) = @_; + $properties = dclone($properties); + + for my $key (keys %$properties) { + if (grep /^$key$/, @$to_remove) { + delete $properties->{$key}; + } + } + + return $properties; +} + sub raise_api_error { my ($api_error) = @_; @@ -108,6 +121,7 @@ __PACKAGE__->register_method ({ }, code => sub { my $result = [ + { name => 'gotify' }, { name => 'sendmail' }, ]; @@ -636,4 +650,252 @@ __PACKAGE__->register_method ({ } }); +my $gotify_properties = { + name => { + description => 'The name of the endpoint.', + type => 'string', + format => 'pve-configid', + }, + 'server' => { + description => 'Server URL', + type => 'string', + }, + 'token' => { + description => 'Secret token', + type => 'string', + }, + 'comment' => { + description => 'Comment', + type => 'string', + optional => 1, + }, + 'filter' => { + description => 'Name of the filter that should be applied.', + type => 'string', + format => 'pve-configid', + optional => 1, + } +}; + +__PACKAGE__->register_method ({ + name => 'get_gotify_endpoints', + path => 'endpoints/gotify', + method => 'GET', + description => 'Returns a list of all gotify endpoints', + protected => 1, + permissions => { + description => "Only lists entries where you have 'Mapping.Modify', 'Mapping.Use' or" + . " 'Mapping.Audit' permissions on '/mapping/notification/'.", + user => 'all', + }, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => remove_protected_properties($gotify_properties, ['token']), + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $config = PVE::Notify::read_config(); + my $rpcenv = PVE::RPCEnvironment::get(); + + my $entities = eval { + $config->get_gotify_endpoints(); + }; + raise_api_error($@) if $@; + + return filter_entities_by_privs($rpcenv, $entities); + } +}); + +__PACKAGE__->register_method ({ + name => 'get_gotify_endpoint', + path => 'endpoints/gotify/{name}', + method => 'GET', + description => 'Return a specific gotify endpoint', + protected => 1, + permissions => { + check => ['or', + ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + ['perm', '/mapping/notification/{name}', ['Mapping.Audit']], + ], + }, + parameters => { + additionalProperties => 0, + properties => { + name => { + type => 'string', + format => 'pve-configid', + description => 'Name of the endpoint.' + }, + } + }, + returns => { + type => 'object', + properties => { + %{ remove_protected_properties($gotify_properties, ['token']) }, + digest => get_standard_option('pve-config-digest'), + } + }, + code => sub { + my ($param) = @_; + my $name = extract_param($param, 'name'); + + my $config = PVE::Notify::read_config(); + my $endpoint = eval { + $config->get_gotify_endpoint($name) + }; + + raise_api_error($@) if $@; + $endpoint->{digest} = $config->digest(); + + return $endpoint; + } +}); + +__PACKAGE__->register_method ({ + name => 'create_gotify_endpoint', + path => 'endpoints/gotify', + protected => 1, + method => 'POST', + description => 'Create a new gotify endpoint', + permissions => { + check => ['perm', '/mapping/notification', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => $gotify_properties, + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + my $name = extract_param($param, 'name'); + my $server = extract_param($param, 'server'); + my $token = extract_param($param, 'token'); + my $comment = extract_param($param, 'comment'); + my $filter = extract_param($param, 'filter'); + + eval { + PVE::Notify::lock_config(sub { + my $config = PVE::Notify::read_config(); + + $config->add_gotify_endpoint( + $name, + $server, + $token, + $comment, + $filter + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if $@; + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'update_gotify_endpoint', + path => 'endpoints/gotify/{name}', + protected => 1, + method => 'PUT', + description => 'Update existing gotify endpoint', + permissions => { + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + %{ make_properties_optional($gotify_properties) }, + delete => { + type => 'array', + items => { + type => 'string', + format => 'pve-configid', + }, + optional => 1, + description => 'A list of settings you want to delete.', + }, + digest => get_standard_option('pve-config-digest'), + } + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + my $name = extract_param($param, 'name'); + my $server = extract_param($param, 'server'); + my $token = extract_param($param, 'token'); + my $comment = extract_param($param, 'comment'); + my $filter = extract_param($param, 'filter'); + + my $delete = extract_param($param, 'delete'); + my $digest = extract_param($param, 'digest'); + + eval { + PVE::Notify::lock_config(sub { + my $config = PVE::Notify::read_config(); + + $config->update_gotify_endpoint( + $name, + $server, + $token, + $comment, + $filter, + $delete, + $digest, + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if $@; + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'delete_gotify_endpoint', + protected => 1, + path => 'endpoints/gotify/{name}', + method => 'DELETE', + description => 'Remove gotify endpoint', + permissions => { + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + name => { + type => 'string', + format => 'pve-configid', + }, + } + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + my $name = extract_param($param, 'name'); + + eval { + PVE::Notify::lock_config(sub { + my $config = PVE::Notify::read_config(); + $config->delete_gotify_endpoint($name); + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if $@; + return; + } +}); 1; -- 2.39.2