CryptoManana\Core\Abstractions\MessageDigestion\AbstractHashAlgorithm

Complexity

Total Complexity

10

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	addSaltString()	0	35	10

<?php

/**
 * The hash algorithm abstraction specification.
 */

namespace CryptoManana\Core\Abstractions\MessageDigestion;

use \CryptoManana\Core\Interfaces\MessageDigestion\SaltingCapabilitiesInterface as DataSalting;
use \CryptoManana\Core\Interfaces\MessageDigestion\DigestionFormatsInterface as DigestFormatting;
use \CryptoManana\Core\Traits\MessageDigestion\SaltingCapabilitiesTrait as SaltingCapabilities;
use \CryptoManana\Core\Traits\MessageDigestion\DigestionFormatsTrait as DigestOutputFormats;

/**
 * Class AbstractHashAlgorithm - The hash algorithm abstraction representation.
 *
 * @package CryptoManana\Core\Abstractions\MessageDigestion
 *
 * @mixin SaltingCapabilities
 * @mixin DigestOutputFormats
 */
abstract class AbstractHashAlgorithm implements DataSalting, DigestFormatting
{
    /**
     * Data salting capabilities.
     *
     * {@internal Reusable implementation of `SaltingCapabilitiesInterface`. }}
     */
    use SaltingCapabilities;

    /**
     * Digest outputting formats.
     *
     * {@internal Reusable implementation of `DigestionFormatsInterface`. }}
     */
    use DigestOutputFormats;

    /**
     * The salt string property storage.
     *
     * @var string The salting string value.
     */
    protected $salt = '';

    /**
     * The salting mode property storage.
     *
     * @var int The salting mode integer code value.
     */
    protected $saltingMode = self::SALTING_MODE_APPEND;

    /**
     * The digest output format property storage.
     *
     * @var int The output format integer code value.
     */
    protected $digestFormat = self::DIGEST_OUTPUT_HEX_UPPER;

    /**
     * Internal method for adding the salt string to the input data via the chosen salting mode.
     *
     * @param string $data The input data for hashing.
     *
     * @return string The input data with proper salting.
     */
    protected function addSaltString($data)
    {
        switch ($this->saltingMode) {
            case self::SALTING_MODE_APPEND: // passwordSALT
                $data .= $this->salt;
                break;
            case self::SALTING_MODE_PREPEND: // SALTpassword
                $data = $this->salt . $data;
                break;
            case self::SALTING_MODE_INFIX_INPUT: // SALTpasswordTLAS
                $data = $this->salt . $data . strrev($this->salt);
                break;
            case self::SALTING_MODE_INFIX_SALT: // passwordSALTdrowssap
                $data = $data . $this->salt . strrev($data);
                break;
            case self::SALTING_MODE_REVERSE_APPEND: // passwordTLAS
                $data .= strrev($this->salt);
                break;
            case self::SALTING_MODE_REVERSE_PREPEND: // TLASpassword
                $data = strrev($this->salt) . $data;
                break;
            case self::SALTING_MODE_DUPLICATE_SUFFIX: // passwordSALTTLAS
                $data = $data . $this->salt . strrev($this->salt);
                break;
            case self::SALTING_MODE_DUPLICATE_PREFIX: // SALTTLASpassword
                $data = $this->salt . strrev($this->salt) . $data;
                break;
            case self::SALTING_MODE_PALINDROME_MIRRORING: // SALTpassworddrowssapTLAS
                $data = $this->salt . $data . strrev($data) . strrev($this->salt);
                break;
            default: // case self::SALTING_MODE_NONE:
                break;
        }

        return $data;
    }

    /**
     * Hash algorithm constructor.
     */
    abstract public function __construct();

    /**
     * Calculates a hash value for the given data.
     *
     * @param string $data The input string.
     *
     * @return string The digest.
     * @throws \Exception Validation errors.
     */
    abstract public function hashData($data);
}