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 C0F9DC9E2 for ; Mon, 18 Sep 2023 13:14:55 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id A82AF1EC51 for ; Mon, 18 Sep 2023 13:14:55 +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 ; Mon, 18 Sep 2023 13:14:54 +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 4319847E5C for ; Mon, 18 Sep 2023 13:14:54 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Mon, 18 Sep 2023 13:14:41 +0200 Message-Id: <20230918111443.465970-6-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230918111443.465970-1-l.wagner@proxmox.com> References: <20230918111443.465970-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.032 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: [pve-devel] [PATCH v3 pve-manager 5/7] notify: add API routes for smtp 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: Mon, 18 Sep 2023 11:14:55 -0000 The Perl part of the API methods primarily defines the API schema, checks for any needed privileges 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 --- PVE/API2/Cluster/Notifications.pm | 337 ++++++++++++++++++++++++++++++ 1 file changed, 337 insertions(+) diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm index ec666903..0f9d6432 100644 --- a/PVE/API2/Cluster/Notifications.pm +++ b/PVE/API2/Cluster/Notifications.pm @@ -221,6 +221,14 @@ __PACKAGE__->register_method ({ }; } + for my $target (@{$config->get_smtp_endpoints()}) { + push @$result, { + name => $target->{name}, + comment => $target->{comment}, + type => 'smtp', + }; + } + for my $target (@{$config->get_groups()}) { push @$result, { name => $target->{name}, @@ -1076,6 +1084,335 @@ __PACKAGE__->register_method ({ } }); +my $smtp_properties= { + name => { + description => 'The name of the endpoint.', + type => 'string', + format => 'pve-configid', + }, + server => { + description => 'The address of the SMTP server.', + type => 'string', + }, + port => { + description => 'The port to be used. Defaults to 465 for TLS based connections,' + . ' 587 for STARTTLS based connections and port 25 for insecure plain-text' + . ' connections.', + type => 'integer', + optional => 1, + }, + mode => { + description => 'Determine which encryption method shall be used for the connection.', + type => 'string', + enum => [ qw(insecure starttls tls) ], + default => 'tls', + optional => 1, + }, + username => { + description => 'Username for SMTP authentication', + type => 'string', + optional => 1, + }, + password => { + description => 'Password for SMTP authentication', + type => 'string', + optional => 1, + }, + 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', + }, + author => { + description => 'Author of the mail. Defaults to \'Proxmox VE\'.', + 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_smtp_endpoints', + path => 'endpoints/smtp', + method => 'GET', + description => 'Returns a list of all smtp 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 => $smtp_properties, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $config = PVE::Notify::read_config(); + my $rpcenv = PVE::RPCEnvironment::get(); + + my $entities = eval { + $config->get_smtp_endpoints(); + }; + raise_api_error($@) if $@; + + return filter_entities_by_privs($rpcenv, $entities); + } +}); + +__PACKAGE__->register_method ({ + name => 'get_smtp_endpoint', + path => 'endpoints/smtp/{name}', + method => 'GET', + description => 'Return a specific smtp 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 => { + %{ remove_protected_properties($smtp_properties, ['password']) }, + 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_smtp_endpoint($name) + }; + + raise_api_error($@) if $@; + $endpoint->{digest} = $config->digest(); + + return $endpoint; + } +}); + +__PACKAGE__->register_method ({ + name => 'create_smtp_endpoint', + path => 'endpoints/smtp', + protected => 1, + method => 'POST', + description => 'Create a new smtp endpoint', + permissions => { + check => ['perm', '/mapping/notification', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => $smtp_properties, + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + my $name = extract_param($param, 'name'); + my $server = extract_param($param, 'server'); + my $port = extract_param($param, 'port'); + my $mode = extract_param($param, 'mode'); + my $username = extract_param($param, 'username'); + my $password = extract_param($param, 'password'); + 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_smtp_endpoint( + $name, + $server, + $port, + $mode, + $username, + $password, + $mailto, + $mailto_user, + $from_address, + $author, + $comment, + $filter + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if $@; + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'update_smtp_endpoint', + path => 'endpoints/smtp/{name}', + protected => 1, + method => 'PUT', + description => 'Update existing smtp endpoint', + permissions => { + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + %{ make_properties_optional($smtp_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 $port = extract_param($param, 'port'); + my $mode = extract_param($param, 'mode'); + my $username = extract_param($param, 'username'); + my $password = extract_param($param, 'password'); + 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_smtp_endpoint( + $name, + $server, + $port, + $mode, + $username, + $password, + $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_smtp_endpoint', + protected => 1, + path => 'endpoints/smtp/{name}', + method => 'DELETE', + description => 'Remove smtp 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) = @_; + my $name = extract_param($param, 'name'); + + my $used_by = target_used_by($name); + if ($used_by) { + raise_param_exc({'name' => "Cannot remove $name, used by: $used_by"}); + } + + eval { + PVE::Notify::lock_config(sub { + my $config = PVE::Notify::read_config(); + $config->delete_smtp_endpoint($name); + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if ($@); + return; + } +}); my $filter_properties = { name => { description => 'Name of the endpoint.', -- 2.39.2