Current File : //backups/router/usr/local/opnsense/mvc/app/library/OPNsense/Backup/GDrive.php
<?php
/*
* Copyright (C) 2018 Deciso B.V.
* 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\Core\Config;
/**
* Class google drive backup
* @package OPNsense\Backup
*/
class Gdrive 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" => "GDriveEnabled",
"type" => "checkbox",
"label" => gettext("Enable"),
"value" => null
);
$fields[] = array(
"name" => "GDriveEmail",
"type" => "text",
"label" => gettext("Email Address"),
"help" => gettext("Client-ID in the Google cloud console"),
"value" => null
);
$fields[] = array(
"name" => "GDriveP12key",
"type" => "file",
"label" => gettext("P12 key"),
"help" => sprintf(
gettext('You need a private key in p12 format to use Google Drive, ' .
'instructions on how to acquire one can be found %shere%s.'),
'<a href="https://docs.opnsense.org/manual/how-tos/cloud_backup.html" target="_blank">',
'</a>'
),
"value" => null
);
$fields[] = array(
"name" => "GDriveFolderID",
"type" => "text",
"label" => gettext("Folder ID"),
"value" => null
);
$fields[] = array(
"name" => "GDrivePrefixHostname",
"type" => "checkbox",
"label" => gettext("Prefix hostname to backupfile"),
"help" => gettext("Normally the config xml will be written as config-stamp.xml, with this option set " .
"the filename will use the systems host and domain name."),
"value" => null
);
$fields[] = array(
"name" => "GDriveBackupCount",
"type" => "text",
"label" => gettext("Backup Count"),
"value" => 60
);
$fields[] = array(
"name" => "GDrivePassword",
"type" => "password",
"label" => gettext("Password"),
"value" => null
);
$fields[] = array(
"name" => "GDrivePasswordConfirm",
"type" => "password",
"label" => gettext("Confirm"),
"value" => null
);
$cnf = Config::getInstance();
if ($cnf->isValid()) {
$config = $cnf->object();
foreach ($fields as &$field) {
$fieldname = $field['name'];
if (isset($config->system->remotebackup->$fieldname)) {
$field['value'] = (string)$config->system->remotebackup->$fieldname;
} elseif (
$fieldname == "GDrivePasswordConfirm" &&
isset($config->system->remotebackup->GDrivePassword)
) {
$field['value'] = (string)$config->system->remotebackup->GDrivePassword;
}
}
}
return $fields;
}
/**
* backup provider name
* @return string user friendly name
*/
public function getName()
{
return gettext("Google Drive");
}
/**
* validate and set configuration
* @param array $conf configuration array
* @return array of validation errors when not saved
*/
public function setConfiguration($conf)
{
$input_errors = array();
if ($conf['GDrivePasswordConfirm'] != $conf['GDrivePassword']) {
$input_errors[] = gettext("The supplied 'Password' and 'Confirm' field values must match.");
}
if (count($input_errors) == 0) {
$config = Config::getInstance()->object();
if (!isset($config->system->remotebackup)) {
$config->system->addChild('remotebackup');
}
foreach ($this->getConfigurationFields() as $field) {
$fieldname = $field['name'];
if ($field['type'] == 'file') {
if (!empty($conf[$field['name']])) {
$config->system->remotebackup->$fieldname = base64_encode($conf[$field['name']]);
}
} elseif ($field['name'] == 'GDrivePasswordConfirm') {
/* skip password confirm field */
} elseif (!empty($conf[$field['name']])) {
$config->system->remotebackup->$fieldname = $conf[$field['name']];
} else {
unset($config->system->remotebackup->$fieldname);
}
}
// remove private key when disabled
if (
empty($config->system->remotebackup->GDriveEnabled) &&
isset($config->system->remotebackup->GDriveP12key)
) {
unset($config->system->remotebackup->GDriveP12key);
}
Config::getInstance()->save();
}
return $input_errors;
}
/**
* @return array filelist
*/
public function backup()
{
$cnf = Config::getInstance();
if ($cnf->isValid()) {
$config = $cnf->object();
if (
isset($config->system->remotebackup) && isset($config->system->remotebackup->GDriveEnabled)
&& !empty($config->system->remotebackup->GDriveEnabled)
) {
if (!empty($config->system->remotebackup->GDrivePrefixHostname)) {
$fileprefix = (string)$config->system->hostname . "." . (string)$config->system->domain . "-";
} else {
$fileprefix = "config-";
}
try {
$client = new \Google\API\Drive();
$client->login(
(string)$config->system->remotebackup->GDriveEmail,
(string)$config->system->remotebackup->GDriveP12key
);
} catch (\Error | \Exception $e) {
syslog(LOG_ERR, "error connecting to Google Drive");
return array();
}
// backup source data to local strings (plain/encrypted)
$confdata = file_get_contents('/conf/config.xml');
$confdata_enc = $this->encrypt($confdata, (string)$config->system->remotebackup->GDrivePassword);
// read filelist ({prefix}*.xml)
try {
$files = $client->listFiles((string)$config->system->remotebackup->GDriveFolderID);
} catch (\Error | \Exception $e) {
syslog(LOG_ERR, "error while fetching filelist from Google Drive");
return array();
}
$configfiles = array();
foreach ($files as $file) {
if (fnmatch("{$fileprefix}*.xml", $file['name'])) {
$configfiles[$file['name']] = $file;
}
}
krsort($configfiles);
// backup new file if changed (or if first in backup)
$target_filename = $fileprefix . time() . ".xml";
if (count($configfiles) > 1) {
// compare last backup with current, only save new
try {
$bck_data_enc = $client->download($configfiles[array_keys($configfiles)[0]]);
if (strpos(substr($bck_data_enc, 0, 100), '---') !== false) {
// base64 string is wrapped into tags
$start_at = strpos($bck_data_enc, "---\n") + 4;
$end_at = strpos($bck_data_enc, "\n---");
$bck_data_enc = substr($bck_data_enc, $start_at, ($end_at - $start_at));
}
$bck_data = $this->decrypt(
$bck_data_enc,
(string)$config->system->remotebackup->GDrivePassword
);
if ($bck_data == $confdata) {
$target_filename = null;
}
} catch (\Error | \Exception $e) {
syslog(LOG_ERR, "unable to download " .
$configfiles[array_keys($configfiles)[0]]->description . " from Google Drive (" . $e . ")");
}
}
if (!is_null($target_filename)) {
syslog(LOG_NOTICE, "backup configuration as " . $target_filename);
try {
$configfiles[$target_filename] = $client->upload(
(string)$config->system->remotebackup->GDriveFolderID,
$target_filename,
$confdata_enc
);
} catch (\Error | \Exception $e) {
syslog(LOG_ERR, "unable to upload " . $target_filename . " to Google Drive (" . $e . ")");
return array();
}
krsort($configfiles);
}
// cleanup old files
if (
isset($config->system->remotebackup->GDriveBackupCount)
&& is_numeric((string)$config->system->remotebackup->GDriveBackupCount)
) {
$fcount = 0;
foreach ($configfiles as $filename => $file) {
if ($fcount >= (string)$config->system->remotebackup->GDriveBackupCount) {
syslog(LOG_NOTICE, "remove " . $filename . " from Google Drive");
try {
$client->delete($file);
} catch (Google_Service_Exception $e) {
syslog(LOG_ERR, "unable to remove " . $filename . " from Google Drive");
}
}
$fcount++;
}
}
// return filelist
return array_keys($configfiles);
}
}
// not configured / issue, return empty list
return array();
}
/**
* Is this provider enabled
* @return boolean enabled status
*/
public function isEnabled()
{
$cnf = Config::getInstance();
if ($cnf->isValid()) {
$config = $cnf->object();
return isset($config->system->remotebackup) && isset($config->system->remotebackup->GDriveEnabled)
&& !empty($config->system->remotebackup->GDriveEnabled);
}
return false;
}
}
Mini Shell