CryptoManana\Core\Traits\Containers\TokenSymmetricTransformationTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	extractAuthenticationToken()	0	3	1
A	generateAuthenticationToken()	0	22	2

<?php

/**
 * Trait implementation for the generation and the transformation of authentication tokens.
 */

namespace CryptoManana\Core\Traits\Containers;

use CryptoManana\Core\Abstractions\Randomness\AbstractGenerator as RandomnessSource;
use CryptoManana\Core\Abstractions\MessageEncryption\AbstractBlockCipherAlgorithm as SymmetricBlockCipher;
use CryptoManana\Core\Interfaces\MessageEncryption\DataEncryptionInterface as DataEncryption;
use CryptoManana\Core\Interfaces\Containers\TokenTransformationInterface as TokenTransformationSpecification;
use CryptoManana\DataStructures\AuthenticationToken as AuthenticationTokenStructure;

/**
 * Trait TokenSymmetricTransformationTrait - Reusable implementation of `TokenTransformationInterface`.
 *
 * @see \CryptoManana\Core\Interfaces\Containers\TokenTransformationInterface The abstract specification.
 *
 * @package CryptoManana\Core\Traits\Containers
 *
 * @property RandomnessSource $randomnessSource The randomness generator.
 * @property SymmetricBlockCipher|DataEncryption|null $symmetricCipherSource The message symmetric encryption service.
 *
 * @mixin TokenTransformationSpecification
 */
trait TokenSymmetricTransformationTrait
{
    /**
     * Generate a secure token and create an encrypt representation.
     *
     * @param int $length The desired output string length in bytes (default => 64).
     *
     * @return AuthenticationTokenStructure The authentication token data structure object.
     * @throws \Exception Validation errors.
     */
    public function generateAuthenticationToken($length = 64)
    {
        $length = filter_var(
            $length,
            FILTER_VALIDATE_INT,
            [
                "options" => [
                    "min_range" => 1,
                    "max_range" => PHP_INT_MAX,
                ],
            ]
        );

        if ($length === false) {
            throw new \LengthException(
                'The internal length of the desired secure token must me at least 1 character long.'
            );
        }

        $token = $this->randomnessSource->getAlphaNumeric($length, true);

        return new AuthenticationTokenStructure($token, $this->symmetricCipherSource->encryptData($token));
    }

    /**
     * Extracts the token from the cipher data via a predefined configuration.
     *
     * @param string $cipherToken The encrypted token string.
     *
     * @return string The decrypted authentication token.
     * @throws \Exception Validation errors.
     */
    public function extractAuthenticationToken($cipherToken)
    {
        return $this->symmetricCipherSource->decryptData($cipherToken);
    }
}