diecoding\flysystem\traits\EncrypterTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes	7
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	encrypt()	0	5	1
A	initEncrypter()	0	3	1
A	normalizePassphrase()	0	11	3
A	decrypt()	0	6	1

<?php

namespace diecoding\flysystem\traits;

use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\StringHelper;

/**
 * Trait EncrypterTrait for Model
 * 
 * @link      https://sugengsulistiyawan.my.id/
 * @author    Sugeng Sulistiyawan <sugeng.sulistiyawan@gmail.com>
 * @copyright Copyright (c) 2023
 */
trait EncrypterTrait
{
    /**
     * @var string
     */
    private $_passphrase;

    /**
     * Init Encrypter
     * 
     * @param string $passphrase
     * 
     * @return void
     * @throws InvalidConfigException
     */
    public function initEncrypter($passphrase)
    {
        $this->normalizePassphrase($passphrase);
    }

    /**
     * Encrypts a string.
     * 
     * @param string $string the string to encrypt
     * @return string the encrypted string
     */
    public function encrypt($string)
    {
        $encrypted = Yii::$app->getSecurity()->encryptByPassword($string, $this->_passphrase);

        return StringHelper::base64UrlEncode($encrypted);
    }

    /**
     * Decrypts a string. 
     * False is returned in case it was not possible to decrypt it.
     * 
     * @param string $string the string to decrypt
     * @return string|bool the decrypted string or false on authentication failure
     */
    public function decrypt($string)
    {
        $encrypted = StringHelper::base64UrlDecode($string);
        $decrypted = Yii::$app->getSecurity()->decryptByPassword($encrypted, $this->_passphrase);

        return $decrypted;
    }

    /**
     * @param string $passphrase
     * @param int $minPassphraseLength
     * 
     * @return void
     * @throws InvalidConfigException
     */
    private function normalizePassphrase($passphrase)
    {
        $this->_passphrase = $passphrase;
        if (empty($this->_passphrase)) {
            throw new InvalidConfigException('The "passphrase" property must be set.');
        }

        $minPassphraseLength = 32;
        $passphraseLength = strlen($this->_passphrase);
        if ($passphraseLength < $minPassphraseLength) {
            $this->_passphrase = str_repeat($this->_passphrase, (int) ceil($minPassphraseLength / $passphraseLength));
        }
    }
}