sysutils/mail-backup: add backup mailer (#788)

(cherry picked from commit 83c250f548) (cherry picked from commit 886524fd5e) (cherry picked from commit 105cf47397) (cherry picked from commit 88a251a375) (cherry picked from commit 0be5359db9)
2026-05-28 04:34:15 -04:00 · 2018-11-13 18:58:17 +00:00 · 2018-11-13 18:58:17 +00:00 · 56ba7b8a20
commit 56ba7b8a20
parent e2129bf177
6 changed files with 377 additions and 0 deletions
--- a/1
+++ b/1
@ -14,6 +14,7 @@ Copyright (c) 2017 Giuseppe De Marco <giuseppe.demarco@unical.it>
 Copyright (c) 2016 IT-assistans Sverige AB
 Copyright (c) 2010 Jim Pingle <jimp@pfsense.org>
 Copyright (c) 2015 Jos Schellevis
+Copyright (c) 2018 João Vilaça <machadovilaca@gmail.com>
 Copyright (c) 2003-2006 Manuel Kasper <mk@neon1.net>
 Copyright (c) 2017-2018 Michael Muenz <m.muenz@gmail.com>
 Copyright (c) 2004-2012 Scott Ullrich <sullrich@gmail.com>
--- a/README.md
+++ b/README.md
@ -80,6 +80,7 @@ security/tor -- The Onion Router
 sysutils/api-backup -- Provide the functionality to download the config.xml
 sysutils/boot-delay -- Apply a persistent 10 second boot delay
 sysutils/lcdproc-sdeclcd -- LCDProc for SDEC LCD devices
+sysutils/mail-backup -- Send configuration file backup by e-mail
 sysutils/node_exporter -- Prometheus exporter for machine metrics
 sysutils/nut -- Network UPS Tools
 sysutils/smart -- SMART tools
--- a/sysutils/mail-backup/Makefile
+++ b/sysutils/mail-backup/Makefile
@ -0,0 +1,8 @@
+PLUGIN_NAME=		mail-backup
+PLUGIN_VERSION=		0.1
+PLUGIN_COMMENT=		Send configuration file backup by e-mail
+PLUGIN_DEPENDS=		gnupg phpmailer
+PLUGIN_MAINTAINER=	machadovilaca@gmail.com
+PLUGIN_DEVEL=		yes
+
+.include "../../Mk/plugins.mk"
--- a/sysutils/mail-backup/src/opnsense/mvc/app/library/OPNsense/Backup/Mailer.php
+++ b/sysutils/mail-backup/src/opnsense/mvc/app/library/OPNsense/Backup/Mailer.php
@ -0,0 +1,282 @@
+<?php
+
+/*
+ * Copyright (C) 2018 João Vilaça <machadovilaca@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace OPNsense\Backup;
+
+require_once('phpmailer/PHPMailerAutoload.php');
+
+use OPNsense\Core\Config;
+use OPNsense\Backup\MailerSettings;
+
+/**
+ * Class mail backup
+ * @package OPNsense\Backup
+ */
+class Mailer extends Base implements IBackupProvider
+{
+    /**
+     * get required (user interface) fields for backup connector
+     * @return array configuration fields, types and description
+     */
+    public function getConfigurationFields()
+    {
+        $fields = array();
+
+        $fields[] = array(
+            "name" => "Enabled",
+            "type" => "checkbox",
+            "label" => gettext("Enable"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "Receiver",
+            "type" => "text",
+            "label" => gettext("Receiver Email Address"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "SmtpHost",
+            "type" => "text",
+            "label" => gettext("SMTP Host"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "SmtpPort",
+            "type" => "text",
+            "label" => gettext("SMTP Port"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "SmtpTLS",
+            "type" => "checkbox",
+            "label" => gettext("Use TLS"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "SelfSigned",
+            "type" => "checkbox",
+            "label" => gettext("Allow self signed"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "SmtpUsername",
+            "type" => "text",
+            "label" => gettext("SMTP Username (Optional)"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "SmtpPassword",
+            "type" => "password",
+            "label" => gettext("SMTP Password (Optional)"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "GpgEmail",
+            "type" => "text",
+            "label" => gettext("GPG Email (Optional)"),
+            "value" => null
+        );
+        $fields[] = array(
+            "name" => "GpgPublicKey",
+            "type" => "textarea",
+            "label" => gettext("GPG Public Key (Optional)"),
+            "value" => null
+        );
+        $mailer = new MailerSettings();
+        foreach ($fields as &$field) {
+            $field['value'] = (string)$mailer->getNodeByReference($field['name']);
+        }
+        return $fields;
+    }
+
+    /**
+     * backup provider name
+     * @return string user friendly name
+     */
+    public function getName()
+    {
+        return gettext("Mailer");
+    }
+
+    /**
+     * validate and set configuration
+     * @param array $conf configuration array
+     * @return array of validation errors when not saved
+     */
+    public function setConfiguration($conf)
+    {
+        $mailer = new MailerSettings();
+        $this->setModelProperties($mailer, $conf);
+        $validation_messages = $this->validateModel($mailer);
+        if (empty($validation_messages)) {
+            $mailer->serializeToConfig();
+            Config::getInstance()->save();
+        }
+        return $validation_messages;
+    }
+
+    /**
+     * @return array filelist
+     */
+    public function backup()
+    {
+        $cnf = Config::getInstance();
+        $mailer = new MailerSettings();
+        if ($cnf->isValid() && !empty((string)$mailer->Enabled)) {
+            $confdata = file_get_contents('/conf/config.xml');
+            $result = self::sendEmail($mailer, $confdata);
+        }
+
+        return array($result);
+    }
+
+    /**
+     * Is this provider enabled
+     * @return boolean enabled status
+     */
+    public function isEnabled()
+    {
+        $mailer = new MailerSettings();
+        return (string)$mailer->Enabled === "1";
+    }
+
+    public function sendEmail($config, $confdata)
+    {
+        $smtpUsername = (string)$config->SmtpUsername;
+        $smtpPassword = (string)$config->SmtpPassword;
+        $gpgPublicKey = (string)$config->GpgPublicKey;
+        $gpgEmail     = (string)$config->GpgEmail;
+        $email        = (string)$config->Receiver;
+
+        $date     = date('Y-m-d');
+        $hostname = gethostname();
+
+        PHPMailerAutoload(PHPMailer);
+        $mail = new \PHPMailer(true);
+        $mail->IsHTML(false);
+        $mail->IsSMTP();
+        $mail->SetFrom($email);
+        $mail->AddAddress($email);
+        $mail->Host    = (string)$config->SmtpHost;
+        $mail->Port    = (string)$config->SmtpPort;
+        $mail->Subject = $hostname . ' OPNsense config backup ' . $date;
+        $mail->Body    = $hostname . ' config backup file';
+
+        if ((string)$config->SelfSigned === "1") {
+            $selfSigned = true;
+        } else {
+            $selfSigned = false;
+        }
+
+        if ((string)$config->SmtpTLS === "1") {
+            $mail->SMTPSecure = 'tls';
+        } else {
+            $mail->SMTPOptions = array(
+                'ssl' => array(
+                    'verify_peer' => true,
+                    'verify_peer_name' => false,
+                    'allow_self_signed' => $selfSigned,
+                ),
+            );
+        }
+
+        if ($smtpUsername != "" && $smtpPassword != "") {
+            $mail->SMTPAuth = true;
+            $mail->Username = $smtpUsername;
+            $mail->Password = $smtpPassword;
+        }
+
+        if ($gpgPublicKey != "") {
+            self::import_key($gpgPublicKey);
+        }
+
+        if ($gpgEmail != "") {
+            self::encrypt_data($confdata, $gpgEmail);
+        } else {
+            file_put_contents("backup", $confdata);
+        }
+
+        $attachmentName = 'config_' . $hostname . '_' . $date . '.xml.asc';
+        $mail->AddAttachment('backup', $attachmentName);
+
+        $mail->Send();
+
+        return $attachmentName;
+    }
+
+    function import_key($gpgPublicKey)
+    {
+        $descriptorspec = array(
+            0 => array("pipe", "r"),
+            1 => array("pipe", "w"),
+            2 => array("file", "/tmp/import_key_error.txt", "w")
+        );
+
+        $process = proc_open('gpg --import', $descriptorspec, $pipes);
+
+        if (is_resource($process)) {
+            fwrite($pipes[0], $gpgPublicKey);
+            fclose($pipes[0]);
+            fclose($pipes[1]);
+
+            proc_close($process);
+        }
+    }
+
+    function encrypt_data($confdata, $gpgEmail)
+    {
+        $descriptorspec = array(
+            0 => array("pipe", "r"),
+            1 => array("pipe", "w"),
+            2 => array("file", "/tmp/encrypt_data_error.txt", "w")
+        );
+
+        $process = proc_open(
+            'gpg --trust-model always --batch --yes --encrypt --output - --recipient ' . escapeshellarg($gpgEmail),
+            $descriptorspec,
+            $pipes
+        );
+
+        if (is_resource($process)) {
+            fwrite($pipes[0], $confdata);
+            fclose($pipes[0]);
+
+            do {
+                $string = fread($pipes[1], 8192);
+                if (strlen($string) == 0) {
+                    break;
+                }
+                $config .= $string;
+            } while (true);
+            fclose($pipes[1]);
+            file_put_contents("backup", $config);
+
+            proc_close($process);
+        }
+    }
+}
--- a/sysutils/mail-backup/src/opnsense/mvc/app/models/OPNsense/Backup/MailerSettings.php
+++ b/sysutils/mail-backup/src/opnsense/mvc/app/models/OPNsense/Backup/MailerSettings.php
@ -0,0 +1,39 @@
+<?php
+
+/*
+ * Copyright (C) 2018 João Vilaça <machadovilaca@gmail.com>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+ * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace OPNsense\Backup;
+
+use OPNsense\Base\BaseModel;
+
+/**
+ * Class MailerSettings
+ * @package Backup
+ */
+class MailerSettings extends BaseModel
+{
+}
--- a/sysutils/mail-backup/src/opnsense/mvc/app/models/OPNsense/Backup/MailerSettings.xml
+++ b/sysutils/mail-backup/src/opnsense/mvc/app/models/OPNsense/Backup/MailerSettings.xml
@ -0,0 +1,46 @@
+<model>
+    <mount>//system/backup/mailer</mount>
+    <version>1.0.1</version>
+    <description>OPNsense Mailer Backup Settings</description>
+    <items>
+        <Enabled type="BooleanField">
+            <default>0</default>
+            <Required>Y</Required>
+        </Enabled>
+        <Receiver type="EmailField">
+            <Constraints>
+                <check001>
+                    <ValidationMessage>Please provide an e-mail address.</ValidationMessage>
+                    <type>DependConstraint</type>
+                    <addFields>
+                        <field1>Enabled</field1>
+                    </addFields>
+                </check001>
+            </Constraints>
+        </Receiver>
+        <SmtpHost type="HostnameField">
+            <Constraints>
+                <check001>
+                    <ValidationMessage>Please provide an e-mail server.</ValidationMessage>
+                    <type>DependConstraint</type>
+                    <addFields>
+                        <field1>Enabled</field1>
+                    </addFields>
+                </check001>
+            </Constraints>
+        </SmtpHost>
+        <SmtpPort type="PortField">
+            <default>25</default>
+            <Required>Y</Required>
+        </SmtpPort>
+        <SmtpTLS type="BooleanField">
+            <default>1</default>
+            <Required>Y</Required>
+        </SmtpTLS>
+        <SelfSigned type="BooleanField"/>
+        <SmtpUsername type="TextField"/>
+        <SmtpPassword type="TextField"/>
+        <GpgEmail type="EmailField"/>
+        <GpgPublicKey type="TextField"/>
+    </items>
+</model>