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 D840165212 for ; Mon, 2 Nov 2020 19:46:06 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1FEA725523 for ; Mon, 2 Nov 2020 19:46:06 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (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 id 35727254C4 for ; Mon, 2 Nov 2020 19:46:02 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 01DC746010 for ; Mon, 2 Nov 2020 19:46:02 +0100 (CET) From: Stoiko Ivanov To: pmg-devel@lists.proxmox.com Date: Mon, 2 Nov 2020 19:45:30 +0100 Message-Id: <20201102184538.17127-4-s.ivanov@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20201102184538.17127-1-s.ivanov@proxmox.com> References: <20201102184538.17127-1-s.ivanov@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.275 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_SBL 0.644 Contains an URL's NS IP listed in the Spamhaus SBL blocklist [backup.pm] URIBL_SBL_A 0.1 Contains URL's A record listed in the Spamhaus SBL blocklist [backup.pm] Subject: [pmg-devel] [PATCH pmg-api v2 2/7] add initial SectionConfig for PBS X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 02 Nov 2020 18:46:06 -0000 add a SectionConfig definition to hold information about PBS-remotes used for backing up PMG. Mostly adapted from the PBSPlugin.pm in pve-storage. This commit needs a versioned dependency on pve-common Signed-off-by: Stoiko Ivanov --- debian/dirs | 1 + src/Makefile | 1 + src/PMG/PBSConfig.pm | 195 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 197 insertions(+) create mode 100644 src/PMG/PBSConfig.pm diff --git a/debian/dirs b/debian/dirs index f7ac2e7..f138bb4 100644 --- a/debian/dirs +++ b/debian/dirs @@ -1,4 +1,5 @@ /etc/pmg /etc/pmg/dkim +/etc/pmg/pbs /var/lib/pmg /var/lib/pmg/backup diff --git a/src/Makefile b/src/Makefile index 05d9598..daa9d46 100644 --- a/src/Makefile +++ b/src/Makefile @@ -66,6 +66,7 @@ LIBSOURCES = \ PMG/SMTP.pm \ PMG/Unpack.pm \ PMG/Backup.pm \ + PMG/PBSConfig.pm \ PMG/RuleCache.pm \ PMG/Statistic.pm \ PMG/UserConfig.pm \ diff --git a/src/PMG/PBSConfig.pm b/src/PMG/PBSConfig.pm new file mode 100644 index 0000000..36479ce --- /dev/null +++ b/src/PMG/PBSConfig.pm @@ -0,0 +1,195 @@ +package PMG::PBSConfig; + +# section config implementation for PBS integration in PMG + +use strict; +use warnings; + +use PVE::Tools qw(extract_param); +use PVE::SectionConfig; +use PVE::JSONSchema qw(get_standard_option); +use PVE::PBSClient; + +use base qw(PVE::SectionConfig); + +my $inotify_file_id = 'pmg-pbs.conf'; +my $secret_dir = '/etc/pmg/pbs'; +my $config_filename = "${secret_dir}/pbs.conf"; + + +my %prune_option = ( + optional => 1, + type => 'integer', minimum => '0', + format_description => 'N', +); + +my %prune_properties = ( + 'keep-last' => { + %prune_option, + description => 'Keep the last backups.', + }, + 'keep-hourly' => { + %prune_option, + description => 'Keep backups for the last different hours. If there is more' . + 'than one backup for a single hour, only the latest one is kept.' + }, + 'keep-daily' => { + %prune_option, + description => 'Keep backups for the last different days. If there is more' . + 'than one backup for a single day, only the latest one is kept.' + }, + 'keep-weekly' => { + %prune_option, + description => 'Keep backups for the last different weeks. If there is more' . + 'than one backup for a single week, only the latest one is kept.' + }, + 'keep-monthly' => { + %prune_option, + description => 'Keep backups for the last different months. If there is more' . + 'than one backup for a single month, only the latest one is kept.' + }, + 'keep-yearly' => { + %prune_option, + description => 'Keep backups for the last different years. If there is more' . + 'than one backup for a single year, only the latest one is kept.' + }, +); + +my $defaultData = { + propertyList => { + type => { description => "Section type." }, + remote => { + description => "Proxmox Backup Server ID.", + type => 'string', format => 'pve-configid', + }, + }, +}; + +sub properties { + return { + datastore => { + description => "Proxmox backup server datastore name.", + type => 'string', + }, + server => { + description => "Proxmox backup server address.", + type => 'string', format => 'address', + maxLength => 256, + }, + disable => { + description => "Flag to disable/deactivate the entry.", + type => 'boolean', + optional => 1, + }, + password => { + description => "Password for the user on the Proxmox backup server.", + type => 'string', + optional => 1, + }, + username => get_standard_option('pmg-email-address', { + description => "Username on the Proxmox backup server" + }), + fingerprint => get_standard_option('fingerprint-sha256'), + %prune_properties, + }; +} + +sub options { + return { + server => {}, + datastore => {}, + disable => { optional => 1 }, + username => { optional => 1 }, + password => { optional => 1 }, + fingerprint => { optional => 1 }, + 'keep-last' => { optional => 1 }, + 'keep-hourly' => { optional => 1 }, + 'keep-daily' => { optional => 1 }, + 'keep-weekly' => { optional => 1 }, + 'keep-monthly' => { optional => 1 }, + 'keep-yearly' => { optional => 1 }, + }; +} + +sub type { + return 'pbs'; +} + +sub private { + return $defaultData; +} + +sub prune_options { + my ($self, $remote) = @_; + + my $remote_cfg = $self->{ids}->{$remote}; + + my $res = {}; + + foreach my $keep_opt (keys %prune_properties) { + + if (defined($remote_cfg->{$keep_opt})) { + $res->{$keep_opt} = $remote_cfg->{$keep_opt}; + } + } + return $res; +} + +sub new { + my ($type) = @_; + + my $class = ref($type) || $type; + + my $cfg = PVE::INotify::read_file($inotify_file_id); + + $cfg->{secret_dir} = $secret_dir; + + return bless $cfg, $class; +} + +sub write { + my ($self) = @_; + + PVE::INotify::write_file($inotify_file_id, $self); +} + +my $lockfile = "/var/lock/pmgpbsconfig.lck"; + +sub lock_config { + my ($code, $errmsg) = @_; + + my $p = PVE::Tools::lock_file($lockfile, undef, $code); + if (my $err = $@) { + $errmsg ? die "$errmsg: $err" : die $err; + } +} + + +__PACKAGE__->register(); +__PACKAGE__->init(); + +sub read_pmg_pbs_conf { + my ($filename, $fh) = @_; + + local $/ = undef; # slurp mode + + my $raw = defined($fh) ? <$fh> : ''; + + return __PACKAGE__->parse_config($filename, $raw); +} + +sub write_pmg_pbs_conf { + my ($filename, $fh, $cfg) = @_; + + my $raw = __PACKAGE__->write_config($filename, $cfg); + + PVE::Tools::safe_print($filename, $fh, $raw); +} + +PVE::INotify::register_file($inotify_file_id, $config_filename, + \&read_pmg_pbs_conf, + \&write_pmg_pbs_conf, + undef, + always_call_parser => 1); + +1; -- 2.20.1