CredentialStore.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\DataGenerator\Handlers;

use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
use Magento\FunctionalTestingFramework\Console\BuildProjectCommand;
use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;

class CredentialStore
{
    const ENCRYPTION_ALGO = "AES-256-CBC";

    private static $INSTANCE = null;

    private $iv = null;

    private $encodedKey = null;

    private $credentials = [];

    public static function getInstance()
    {
        if (self::$INSTANCE == null) {
            self::$INSTANCE = new CredentialStore();
        }

        return self::$INSTANCE;
    }

    private function __construct()
    {
        $this->encodedKey = base64_encode(openssl_random_pseudo_bytes(16));
        $this->iv = substr(hash('sha256', $this->encodedKey), 0, 16);
        $creds = $this->readInCredentialsFile();
        $this->credentials = $this->encryptCredFileContents($creds);
    }

    public function getSecret($key)
    {
        if (!array_key_exists($key, $this->credentials)) {
            throw new TestFrameworkException(
                "{$key} not defined in .credentials, please provide a value in order to use this secret in a test."
            );
        }

        // log here for verbose config
        if (MftfApplicationConfig::getConfig()->verboseEnabled()) {
            LoggingUtil::getInstance()->getLogger(CredentialStore::class)->debug(
                "retrieving secret for key name {$key}"
            );
        }

        return $this->credentials[$key] ?? null;
    }

    private function readInCredentialsFile()
    {
        $credsFilePath = str_replace(
            '.credentials.example',
            '.credentials',
            BuildProjectCommand::CREDENTIALS_FILE_PATH
        );

        if (!file_exists($credsFilePath)) {
            throw new TestFrameworkException(
                "Cannot find .credentials file, please create in "
                . TESTS_BP . " in order to reference sensitive information"
            );
        }

        return file($credsFilePath, FILE_IGNORE_NEW_LINES);
    }

    private function encryptCredFileContents($credContents)
    {
        $encryptedCreds = [];
        foreach ($credContents as $credValue) {
            if (substr($credValue, 0, 1) === '#' || empty($credValue)) {
                continue;
            }

            list($key, $value) = explode("=", $credValue);
            if (!empty($value)) {
                $encryptedCreds[$key] = openssl_encrypt(
                    $value,
                    self::ENCRYPTION_ALGO,
                    $this->encodedKey,
                    0,
                    $this->iv
                );
            }
        }

        return $encryptedCreds;
    }

    public function decryptSecretValue($value)
    {
        return openssl_decrypt($value, self::ENCRYPTION_ALGO, $this->encodedKey, 0, $this->iv);
    }
}