SaltingCapabilitiesTrait::getSalt() - Code Metrics - Inspection of "Added a vast of unkeyed hash algorithm objects for..." - TonyKaravasilev/CryptoManana - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bfe7fb...e70e28 )

by Tony Karavasilev (Тони

created 2019-12-10 18:17 UTC

SaltingCapabilitiesTrait::getSalt() A

↳ Parent: SaltingCapabilitiesTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	0
cts	3
cp	0
rs	10
cc	1
nc	1
nop	0
crap	2

<?php

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

namespace CryptoManana\Core\Traits\MessageDigestion;

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

/**
 * 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
{
    /**
     * 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->getSaltingMode()) {
            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;
    }

    /**
     * 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
11			/**
12			* Trait SaltingCapabilitiesTrait - Reusable implementation of `SaltingCapabilitiesInterface`.
13			*
14			* @see \CryptoManana\Core\Interfaces\MessageDigestion\SaltingCapabilitiesInterface The abstract specification.
15			*
16			* @package CryptoManana\Core\Traits\MessageDigestion
17			*
18			* @property string $salt The salt string property storage.
19			* @property int $saltingMode The salting mode property storage.
20			*
21			* @mixin SaltingCapabilitiesSpecification
22			*/
23			trait SaltingCapabilitiesTrait
24			{
25			/**
26			* Internal method for adding the salt string to the input data via the chosen salting mode.
27			*
28			* @param string $data The input data for hashing.
29			*
30			* @return string The input data with proper salting.
31			*/
32			protected function addSaltString($data)
33			{
34			switch ($this->getSaltingMode()) {
35			case self::SALTING_MODE_APPEND: // passwordSALT
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...it::SALTING_MODE_APPEND` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
36			$data .= $this->salt;
37			break;
38			case self::SALTING_MODE_PREPEND: // SALTpassword
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...t::SALTING_MODE_PREPEND` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
39			$data = $this->salt . $data;
40			break;
41			case self::SALTING_MODE_INFIX_INPUT: // SALTpasswordTLAS
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...ALTING_MODE_INFIX_INPUT` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
42			$data = $this->salt . $data . strrev($this->salt);
43			break;
44			case self::SALTING_MODE_INFIX_SALT: // passwordSALTdrowssap
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...SALTING_MODE_INFIX_SALT` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
45			$data = $data . $this->salt . strrev($data);
46			break;
47			case self::SALTING_MODE_REVERSE_APPEND: // passwordTLAS
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...ING_MODE_REVERSE_APPEND` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
48			$data .= strrev($this->salt);
49			break;
50			case self::SALTING_MODE_REVERSE_PREPEND: // TLASpassword
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...NG_MODE_REVERSE_PREPEND` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
51			$data = strrev($this->salt) . $data;
52			break;
53			case self::SALTING_MODE_DUPLICATE_SUFFIX: // passwordSALTTLAS
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...G_MODE_DUPLICATE_SUFFIX` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
54			$data = $data . $this->salt . strrev($this->salt);
55			break;
56			case self::SALTING_MODE_DUPLICATE_PREFIX: // SALTTLASpassword
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...G_MODE_DUPLICATE_PREFIX` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
57			$data = $this->salt . strrev($this->salt) . $data;
58			break;
59			case self::SALTING_MODE_PALINDROME_MIRRORING: // SALTpassworddrowssapTLAS
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...DE_PALINDROME_MIRRORING` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
60			$data = $this->salt . $data . strrev($data) . strrev($this->salt);
61			break;
62			default: // case self::SALTING_MODE_NONE:
63			break;
64			}
65
66			return $data;
67			}
68
69			/**
70			* Setter for the salt string property.
71			*
72			* @param string $salt The salt string.
73			*
74			* @return $this The hash algorithm object.
75			* @throw \Exception Validation errors.
76			*/
77			public function setSalt($salt)
78			{
79			if (!is_string($salt)) {
			1 ignored issue – show introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The condition `is_string($salt)` is always `true`. Loading history...
80			throw new \InvalidArgumentException('Salt must be of type string.');
81			}
82
83			$this->salt = $salt;
84
85			return $this;
86			}
87
88			/**
89			* Getter for the salt string property.
90			*
91			* @return string The salt string.
92			*/
93			public function getSalt()
94			{
95			return $this->salt;
96			}
97
98			/**
99			* Setter for the salting mode code property.
100			*
101			* @param int $saltingMode The salting mode code.
102			*
103			* @return $this The hash algorithm object.
104			* @throw \Exception Validation errors.
105			*/
106			public function setSaltingMode($saltingMode)
107			{
108			$saltingMode = filter_var(
109			$saltingMode,
110			FILTER_VALIDATE_INT,
111			[
112			"options" => [
113			"min_range" => self::SALTING_MODE_NONE, // -1
			1 ignored issue – show Bug introduced 2019-12-10 18:23 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...
114			"max_range" => self::SALTING_MODE_PALINDROME_MIRRORING, // 8
			1 ignored issue – show Bug introduced 2019-12-10 18:23 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...DE_PALINDROME_MIRRORING` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
115			],
116			]
117			);
118
119			if ($saltingMode === false) {
120			throw new \InvalidArgumentException('Salting mode must be an integer between -1 and 8.');
121			}
122
123			$this->saltingMode = $saltingMode;
124
125			return $this;
126			}
127
128			/**
129			* Getter for the salt mode code property.
130			*
131			* @return int The salt mode code.
132			*/
133			public function getSaltingMode()
134			{
135			return $this->saltingMode;
136			}
137			}
138

TonyKaravasilev / CryptoManana

Push — master ( bfe7fb...e70e28 )

SaltingCapabilitiesTrait::getSalt() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like