Current File : /home/lightco1/upgrade.lightco.com.au/administrator/components/com_akeeba/Helper/SecretWord.php
<?php
/**
* @package AkeebaBackup
* @copyright Copyright (c)2006-2017 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license GNU General Public License version 3, or later
*/
namespace Akeeba\Backup\Admin\Helper;
// Protect from unauthorized access
defined('_JEXEC') or die();
use Akeeba\Engine\Factory;
use FOF30\Container\Container;
use FOF30\Params\Params;
/**
* A helper to handle potentially encrypted Secret Word settings
*
* @since 5.5.2
*/
abstract class SecretWord
{
/**
* Enforce (reversible) encryption for the component setting $settingsKey
*
* @param Params $params The component's parameters object
* @param string $settingsKey The key for the setting containing the secret word
*
* @return void
*
* @since 5.5.2
*/
public static function enforceEncryption(Params $params, $settingsKey)
{
// If encryption is not enabled in the Engine we can't encrypt the Secret Word
if ($params->get('useencryption', -1) == 0)
{
return;
}
// If encryption is not supported on this server we can't encrypt the Secret Word
if (!Factory::getSecureSettings()->supportsEncryption())
{
return;
}
// Get the raw version of frontend_secret_word and check if it has a valid encryption signature
$raw = $params->get($settingsKey, '');
$signature = substr($raw, 0, 12);
$validSignatures = array('###AES128###', '###CTR128###');
// If the setting is already encrypted I have nothing to do here
if (in_array($signature, $validSignatures))
{
return;
}
// The setting was NOT encrypted. I need to encrypt it.
$secureSettings = Factory::getSecureSettings();
$encrypted = $secureSettings->encryptSettings($raw);
// Finally, I need to save it back to the database
$params->set($settingsKey, $encrypted);
$params->save();
}
/**
* Forcibly store the Secret Word settings $settingsKey unencrypted in the database. This is meant to be called when
* the user disables settings encryption. Since the encryption key will be deleted we need to decrypt the Secret
* Word at the same time as the Engine settings. Otherwise we will never be able to access it again.
*
* @param Params $params The component parameters object
* @param string $settingsKey The key of the Secret Word parameter
* @param string|null $encryptionKey (Optional) The AES key with which to decrypt the parameter
*
* @return void
*
* @since 5.5.2
*/
public static function enforceDecrypted(Params $params, $settingsKey, $encryptionKey = null)
{
// Get the raw version of frontend_secret_word and check if it has a valid encryption signature
$raw = $params->get($settingsKey, '');
$signature = substr($raw, 0, 12);
$validSignatures = array('###AES128###', '###CTR128###');
// If the setting is not already encrypted I have nothing to decrypt
if (!in_array($signature, $validSignatures))
{
return;
}
// The setting was encrypted. I need to decrypt it.
$secureSettings = Factory::getSecureSettings();
$encrypted = $secureSettings->decryptSettings($raw, $encryptionKey);
// Finally, I need to save it back to the database
$params->set($settingsKey, $encrypted);
$params->save();
}
}
Mini Shell