SaltingCapabilitiesTrait::addSaltString() - Code Metrics - Inspection of "Fixed a few coding style issues found by Scrutiniz..." - TonyKaravasilev/CryptoManana - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7ff62b...207322 )

by Tony Karavasilev (Тони

created 2019-12-10 22:04 UTC

SaltingCapabilitiesTrait::addSaltString() A

↳ Parent: SaltingCapabilitiesTrait

Complexity

Conditions	5
Paths	5

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	9
c	1
b	0
f	0
dl	0
loc	15
ccs	10
cts	10
cp	1
rs	9.6111
cc	5
nc	5
nop	1
crap	5

<?php

/**
 * Trait implementation of the salting capabilities for digestion algorithms.
 */

namespace CryptoManana\Core\Traits\MessageDigestion;

use \CryptoManana\Core\Interfaces\MessageDigestion\SaltingCapabilitiesInterface as SaltingCapabilitiesSpecification;
use \CryptoManana\Core\StringBuilder as StringBuilder;

/**
 * Trait SaltingCapabilitiesTrait - Reusable implementation of `SaltingCapabilitiesInterface`.
 *
 * @see \CryptoManana\Core\Interfaces\MessageDigestion\SaltingCapabilitiesInterface The abstract specification.
 *
 * @package CryptoManana\Core\Traits\MessageDigestion
 *
 * @property string $salt The salt string property storage.
 * @property int $saltingMode The salting mode property storage.
 *
 * @mixin SaltingCapabilitiesSpecification
 */
trait SaltingCapabilitiesTrait
{
    /**
     * List of salting modes that add the salt at the front side of the input data.
     *
     * @var array Salting mode codes.
     */
    private $inFrontCases = [
        self::SALTING_MODE_PREPEND,
        self::SALTING_MODE_REVERSE_PREPEND,
        self::SALTING_MODE_DUPLICATE_PREFIX
    ];

    /**
     * List of salting modes that add the salt at the back side of the input data.
     *
     * @var array Salting mode codes.
     */
    private $inBackCases = [
        self::SALTING_MODE_APPEND,
        self::SALTING_MODE_REVERSE_APPEND,
        self::SALTING_MODE_DUPLICATE_SUFFIX
    ];

    /**
     * List of salting modes that use complex salt and input data manipulation procedures.
     *
     * @var array Salting mode codes.
     */
    private $inSpecialCases = [
        self::SALTING_MODE_INFIX_INPUT,
        self::SALTING_MODE_INFIX_SALT,
        self::SALTING_MODE_PALINDROME_MIRRORING
    ];

    /**
     * Internal method for grouping salting modes that add to the front of the input data.
     *
     * @param string $data The input data for hashing.
     *
     * @internal The parameter is passed via reference from the main logical method for performance reasons.
     */
    private function saltAtFront(&$data)
    {
        switch ($this->saltingMode) {
            case self::SALTING_MODE_PREPEND: // SALTpassword
                $data = $this->salt . $data;
                break;
            case self::SALTING_MODE_REVERSE_PREPEND: // TLASpassword
                $data = StringBuilder::stringReverse($this->salt) . $data;
                break;
            case self::SALTING_MODE_DUPLICATE_PREFIX: // SALTTLASpassword
                $data = $this->salt . StringBuilder::stringReverse($this->salt) . $data;
                break;
            default:
                break;
        }
    }

    /**
     * Internal method for grouping salting modes that add to the back of the input data.
     *
     * @param string $data The input data for hashing.
     *
     * @internal The parameter is passed via reference from the main logical method for performance reasons.
     */
    private function saltAtBack(&$data)
    {
        switch ($this->saltingMode) {
            case self::SALTING_MODE_APPEND: // passwordSALT
                $data .= $this->salt;
                break;
            case self::SALTING_MODE_REVERSE_APPEND: // passwordTLAS
                $data .= StringBuilder::stringReverse($this->salt);
                break;
            case self::SALTING_MODE_DUPLICATE_SUFFIX: // passwordSALTTLAS
                $data = $data . $this->salt . StringBuilder::stringReverse($this->salt);
                break;
            default:
                break;
        }
    }

    /**
     * Internal method for grouping salting modes that use complex manipulations of the salt and input data.
     *
     * @param string $data The input data for hashing.
     *
     * @internal The parameter is passed via reference from the main logical method for performance reasons.
     */
    private function saltAtSpecial(&$data)
    {
        switch ($this->saltingMode) {
            case self::SALTING_MODE_INFIX_INPUT: // SALTpasswordTLAS
                $data = $this->salt . $data . StringBuilder::stringReverse($this->salt);
                break;
            case self::SALTING_MODE_INFIX_SALT: // passwordSALTdrowssap
                $data = $data . $this->salt . StringBuilder::stringReverse($data);
                break;
            case self::SALTING_MODE_PALINDROME_MIRRORING: // SALTpassworddrowssapTLAS
                $data = $this->salt . $data . StringBuilder::stringReverse($data);
                $data .= StringBuilder::stringReverse($this->salt);
                break;
            default:
                break;
        }
    }

    /**
     * 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)
    {
        if ($this->saltingMode === self::SALTING_MODE_NONE) {

            return $data;
        }

        if (in_array($this->saltingMode, $this->inBackCases)) {
            $this->saltAtBack($data);
        } elseif (in_array($this->saltingMode, $this->inFrontCases)) {
            $this->saltAtFront($data);
        } elseif (in_array($this->saltingMode, $this->inSpecialCases)) {
            $this->saltAtSpecial($data);
        }

        return $data;
    }

    /**
     * Setter for the salt string property.
     *
     * @param string $salt The salt string.
     *
     * @return $this The hash algorithm object.
     * @throw \Exception Validation errors.
     */
    public function setSalt($salt)
    {
        if (!is_string($salt)) {
            throw new \InvalidArgumentException('Salt must be of type string.');
        }

        $this->salt = $salt;

        return $this;
    }

    /**
     * Getter for the salt string property.
     *
     * @return string The salt string.
     */
    public function getSalt()
    {
        return $this->salt;
    }

    /**
     * Setter for the salting mode code property.
     *
     * @param int $saltingMode The salting mode code.
     *
     * @return $this The hash algorithm object.
     * @throw \Exception Validation errors.
     */
    public function setSaltingMode($saltingMode)
    {
        $saltingMode = filter_var(
            $saltingMode,
            FILTER_VALIDATE_INT,
            [
                "options" => [
                    "min_range" => self::SALTING_MODE_NONE, // -1
                    "max_range" => self::SALTING_MODE_PALINDROME_MIRRORING, // 8
                ],
            ]
        );

        if ($saltingMode === false) {
            throw new \InvalidArgumentException('Salting mode must be an integer between -1 and 8.');
        }

        $this->saltingMode = $saltingMode;

        return $this;
    }

    /**
     * Getter for the salt mode code property.
     *
     * @return int The salt mode code.
     */
    public function getSaltingMode()
    {
        return $this->saltingMode;
    }
}


1		<?php
2
3		/**
4		* Trait implementation of the salting capabilities for digestion algorithms.
5		*/
6
7		namespace CryptoManana\Core\Traits\MessageDigestion;
8
9		use \CryptoManana\Core\Interfaces\MessageDigestion\SaltingCapabilitiesInterface as SaltingCapabilitiesSpecification;
10		use \CryptoManana\Core\StringBuilder as StringBuilder;
11
12		/**
13		* Trait SaltingCapabilitiesTrait - Reusable implementation of `SaltingCapabilitiesInterface`.
14		*
15		* @see \CryptoManana\Core\Interfaces\MessageDigestion\SaltingCapabilitiesInterface The abstract specification.
16		*
17		* @package CryptoManana\Core\Traits\MessageDigestion
18		*
19		* @property string $salt The salt string property storage.
20		* @property int $saltingMode The salting mode property storage.
21		*
22		* @mixin SaltingCapabilitiesSpecification
23		*/
24		trait SaltingCapabilitiesTrait
25		{
26		/**
27		* List of salting modes that add the salt at the front side of the input data.
28		*
29		* @var array Salting mode codes.
30		*/
31		private $inFrontCases = [
32		self::SALTING_MODE_PREPEND,
33		self::SALTING_MODE_REVERSE_PREPEND,
34		self::SALTING_MODE_DUPLICATE_PREFIX
35		];
36
37		/**
38		* List of salting modes that add the salt at the back side of the input data.
39		*
40		* @var array Salting mode codes.
41		*/
42		private $inBackCases = [
43		self::SALTING_MODE_APPEND,
44		self::SALTING_MODE_REVERSE_APPEND,
45		self::SALTING_MODE_DUPLICATE_SUFFIX
46		];
47
48		/**
49		* List of salting modes that use complex salt and input data manipulation procedures.
50		*
51		* @var array Salting mode codes.
52		*/
53		private $inSpecialCases = [
54		self::SALTING_MODE_INFIX_INPUT,
55		self::SALTING_MODE_INFIX_SALT,
56		self::SALTING_MODE_PALINDROME_MIRRORING
57		];
58
59		/**
60		* Internal method for grouping salting modes that add to the front of the input data.
61		*
62		* @param string $data The input data for hashing.
63		*
64		* @internal The parameter is passed via reference from the main logical method for performance reasons.
65		*/
66	44	private function saltAtFront(&$data)
67		{
68	44	switch ($this->saltingMode) {
69	44	case self::SALTING_MODE_PREPEND: // SALTpassword
70	44	$data = $this->salt . $data;
71	44	break;
72	22	case self::SALTING_MODE_REVERSE_PREPEND: // TLASpassword
73	22	$data = StringBuilder::stringReverse($this->salt) . $data;
74	22	break;
75	22	case self::SALTING_MODE_DUPLICATE_PREFIX: // SALTTLASpassword
76	22	$data = $this->salt . StringBuilder::stringReverse($this->salt) . $data;
77	22	break;
78		default:
79		break;
80		}
81	44	}
82
83		/**
84		* Internal method for grouping salting modes that add to the back of the input data.
85		*
86		* @param string $data The input data for hashing.
87		*
88		* @internal The parameter is passed via reference from the main logical method for performance reasons.
89		*/
90	154	private function saltAtBack(&$data)
91		{
92	154	switch ($this->saltingMode) {
93	154	case self::SALTING_MODE_APPEND: // passwordSALT
94	154	$data .= $this->salt;
95	154	break;
96	22	case self::SALTING_MODE_REVERSE_APPEND: // passwordTLAS
97	22	$data .= StringBuilder::stringReverse($this->salt);
98	22	break;
99	22	case self::SALTING_MODE_DUPLICATE_SUFFIX: // passwordSALTTLAS
100	22	$data = $data . $this->salt . StringBuilder::stringReverse($this->salt);
101	22	break;
102		default:
103		break;
104		}
105	154	}
106
107		/**
108		* Internal method for grouping salting modes that use complex manipulations of the salt and input data.
109		*
110		* @param string $data The input data for hashing.
111		*
112		* @internal The parameter is passed via reference from the main logical method for performance reasons.
113		*/
114	22	private function saltAtSpecial(&$data)
115		{
116	22	switch ($this->saltingMode) {
117	22	case self::SALTING_MODE_INFIX_INPUT: // SALTpasswordTLAS
118	22	$data = $this->salt . $data . StringBuilder::stringReverse($this->salt);
119	22	break;
120	22	case self::SALTING_MODE_INFIX_SALT: // passwordSALTdrowssap
121	22	$data = $data . $this->salt . StringBuilder::stringReverse($data);
122	22	break;
123	22	case self::SALTING_MODE_PALINDROME_MIRRORING: // SALTpassworddrowssapTLAS
124	22	$data = $this->salt . $data . StringBuilder::stringReverse($data);
125	22	$data .= StringBuilder::stringReverse($this->salt);
126	22	break;
127		default:
128		break;
129		}
130	22	}
131
132		/**
133		* Internal method for adding the salt string to the input data via the chosen salting mode.
134		*
135		* @param string $data The input data for hashing.
136		*
137		* @return string The input data with proper salting.
138		*/
139	176	protected function addSaltString($data)
140		{
141	176	if ($this->saltingMode === self::SALTING_MODE_NONE) {
		1 ignored issue – show Bug introduced 2019-12-10 21:28 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...rait::SALTING_MODE_NONE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
142	44	return $data;
143		}
144
145	176	if (in_array($this->saltingMode, $this->inBackCases)) {
146	154	$this->saltAtBack($data);
147	44	} elseif (in_array($this->saltingMode, $this->inFrontCases)) {
148	44	$this->saltAtFront($data);
149	22	} elseif (in_array($this->saltingMode, $this->inSpecialCases)) {
150	22	$this->saltAtSpecial($data);
151		}
152
153	176	return $data;
154		}
155
156		/**
157		* Setter for the salt string property.
158		*
159		* @param string $salt The salt string.
160		*
161		* @return $this The hash algorithm object.
162		* @throw \Exception Validation errors.
163		*/
164	88	public function setSalt($salt)
165		{
166	88	if (!is_string($salt)) {
167	22	throw new \InvalidArgumentException('Salt must be of type string.');
168		}
169
170	66	$this->salt = $salt;
171
172	66	return $this;
173		}
174
175		/**
176		* Getter for the salt string property.
177		*
178		* @return string The salt string.
179		*/
180	44	public function getSalt()
181		{
182	44	return $this->salt;
183		}
184
185		/**
186		* Setter for the salting mode code property.
187		*
188		* @param int $saltingMode The salting mode code.
189		*
190		* @return $this The hash algorithm object.
191		* @throw \Exception Validation errors.
192		*/
193	88	public function setSaltingMode($saltingMode)
194		{
195	88	$saltingMode = filter_var(
196	88	$saltingMode,
197	88	FILTER_VALIDATE_INT,
198		[
199		"options" => [
200	88	"min_range" => self::SALTING_MODE_NONE, // -1
201	88	"max_range" => self::SALTING_MODE_PALINDROME_MIRRORING, // 8
202		],
203		]
204		);
205
206	88	if ($saltingMode === false) {
207	22	throw new \InvalidArgumentException('Salting mode must be an integer between -1 and 8.');
208		}
209
210	66	$this->saltingMode = $saltingMode;
211
212	66	return $this;
213		}
214
215		/**
216		* Getter for the salt mode code property.
217		*
218		* @return int The salt mode code.
219		*/
220	44	public function getSaltingMode()
221		{
222	44	return $this->saltingMode;
223		}
224		}
225

TonyKaravasilev / CryptoManana

Push — master ( 7ff62b...207322 )

SaltingCapabilitiesTrait::addSaltString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like