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 661E09591 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 6D534280E for ; Thu, 3 Aug 2023 14:17:40 +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:36 +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 8AD89425E3 for ; Thu, 3 Aug 2023 14:17:35 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 3 Aug 2023 14:16:58 +0200 Message-Id: <20230803121719.519207-10-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.051 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 09/30] api: notification: add api routes for sendmail 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 | 305 ++++++++++++++++++++++++++++++ 1 file changed, 305 insertions(+) diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm index 55dd650d..2d907c35 100644 --- a/PVE/API2/Cluster/Notifications.pm +++ b/PVE/API2/Cluster/Notifications.pm @@ -80,6 +80,7 @@ __PACKAGE__->register_method ({ }, code => sub { my $result = [ + { name => 'endpoints' }, { name => 'groups' }, ]; @@ -87,6 +88,33 @@ __PACKAGE__->register_method ({ } }); +__PACKAGE__->register_method ({ + name => 'endpoints_index', + path => 'endpoints', + method => 'GET', + description => 'Index for all available endpoint types.', + permissions => { user => 'all' }, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => {}, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $result = [ + { name => 'sendmail' }, + ]; + + return $result; + } +}); + my $group_properties = { name => { description => 'Name of the group.', @@ -331,4 +359,281 @@ __PACKAGE__->register_method ({ } }); +my $sendmail_properties = { + name => { + description => 'The name of the endpoint.', + type => 'string', + format => 'pve-configid', + }, + mailto => { + type => 'array', + items => { + type => 'string', + format => 'email-or-username', + }, + description => 'List of email recipients', + optional => 1, + }, + 'mailto-user' => { + type => 'array', + items => { + type => 'string', + format => 'pve-userid', + }, + description => 'List of users', + optional => 1, + }, + 'from-address' => { + description => '`From` address for the mail', + type => 'string', + optional => 1, + }, + author => { + description => 'Author of the mail', + type => 'string', + optional => 1, + }, + '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_sendmail_endpoints', + path => 'endpoints/sendmail', + method => 'GET', + description => 'Returns a list of all sendmail endpoints', + permissions => { + description => "Only lists entries where you have 'Mapping.Modify', 'Mapping.Use' or" + . " 'Mapping.Audit' permissions on '/mapping/notification/'.", + user => 'all', + }, + protected => 1, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => $sendmail_properties, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $config = PVE::Notify::read_config(); + my $rpcenv = PVE::RPCEnvironment::get(); + + my $entities = eval { + $config->get_sendmail_endpoints(); + }; + raise_api_error($@) if $@; + + return filter_entities_by_privs($rpcenv, $entities); + } +}); + +__PACKAGE__->register_method ({ + name => 'get_sendmail_endpoint', + path => 'endpoints/sendmail/{name}', + method => 'GET', + description => 'Return a specific sendmail endpoint', + permissions => { + check => ['or', + ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + ['perm', '/mapping/notification/{name}', ['Mapping.Audit']], + ], + }, + protected => 1, + parameters => { + additionalProperties => 0, + properties => { + name => { + type => 'string', + format => 'pve-configid', + }, + } + }, + returns => { + type => 'object', + properties => { + %$sendmail_properties, + 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_sendmail_endpoint($name) + }; + + raise_api_error($@) if $@; + $endpoint->{digest} = $config->digest(); + + return $endpoint; + } +}); + +__PACKAGE__->register_method ({ + name => 'create_sendmail_endpoint', + path => 'endpoints/sendmail', + protected => 1, + method => 'POST', + description => 'Create a new sendmail endpoint', + permissions => { + check => ['perm', '/mapping/notification', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => $sendmail_properties, + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + my $name = extract_param($param, 'name'); + my $mailto = extract_param($param, 'mailto'); + my $mailto_user = extract_param($param, 'mailto-user'); + my $from_address = extract_param($param, 'from-address'); + my $author = extract_param($param, 'author'); + 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_sendmail_endpoint( + $name, + $mailto, + $mailto_user, + $from_address, + $author, + $comment, + $filter + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if $@; + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'update_sendmail_endpoint', + path => 'endpoints/sendmail/{name}', + protected => 1, + method => 'PUT', + description => 'Update existing sendmail endpoint', + permissions => { + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + %{ make_properties_optional($sendmail_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 $mailto = extract_param($param, 'mailto'); + my $mailto_user = extract_param($param, 'mailto-user'); + my $from_address = extract_param($param, 'from-address'); + my $author = extract_param($param, 'author'); + 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_sendmail_endpoint( + $name, + $mailto, + $mailto_user, + $from_address, + $author, + $comment, + $filter, + $delete, + $digest, + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if $@; + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'delete_sendmail_endpoint', + protected => 1, + path => 'endpoints/sendmail/{name}', + method => 'DELETE', + description => 'Remove sendmail endpoint', + permissions => { + check => ['perm', '/mapping/notification', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + name => { + type => 'string', + format => 'pve-configid', + }, + } + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + eval { + PVE::Notify::lock_config(sub { + my $config = PVE::Notify::read_config(); + $config->delete_sendmail_endpoint($param->{name}); + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if ($@); + return; + } +}); + 1; -- 2.39.2