Completed
Push — master ( 7d322b...0aebb5 )
by Henry
09:26
created

Hash::getAlgorithm()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 3

Importance

Changes 0
Metric Value
dl 0
loc 12
ccs 2
cts 2
cp 1
rs 9.8666
c 0
b 0
f 0
cc 3
nc 3
nop 0
crap 3
1
<?php
2
namespace Redaxscript;
3
4
use function constant;
5
use function defined;
6
use function is_numeric;
7
use function is_string;
8
use function password_hash;
9
use function password_verify;
10
11
/**
12
 * parent class to create a salted hash
13
 *
14
 * @since 2.6.0
15
 *
16
 * @package Redaxscript
17
 * @category Hash
18
 * @author Henry Ruhs
19
 */
20
21
class Hash
22
{
23
	/**
24
	 * plain raw
25
	 *
26
	 * @var string|int
27
	 */
28
29
	protected $_raw;
30
31
	/**
32
	 * salted hash
33
	 *
34
	 * @var string
35
	 */
36
37
	protected $_hash;
38
39
	/**
40
	 * init the class
41
	 *
42
	 * @since 2.6.0
43
	 *
44
	 * @param string|int $raw plain raw
45
	 */
46
47 8
	public function init($raw = null) : void
48
	{
49 8
		if (is_numeric($raw) || is_string($raw))
50
		{
51 4
			$this->_raw = $raw;
0 ignored issues
show
Documentation Bug introduced by redaxmedia
It seems like $raw can also be of type double. However, the property $_raw is declared as type string|integer. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
52
		}
53 8
		$this->_create();
54 8
	}
55
56
	/**
57
	 * get the algorithm
58
	 *
59
	 * @since 4.3.0
60
	 *
61
	 * @return string|null
62
	 */
63
64 4
	public function getAlgorithm() : ?string
65
	{
66 4
		if (defined('PASSWORD_ARGON2ID'))
67
		{
68
			return constant('PASSWORD_ARGON2ID');
69
		}
70
		if (defined('PASSWORD_ARGON2I'))
71
		{
72
			return constant('PASSWORD_ARGON2I');
73
		}
74
		return constant('PASSWORD_DEFAULT');
75
	}
76
77 4
	/**
78
	 * get the raw
79 4
	 *
80
	 * @since 2.6.0
81
	 *
82
	 * @return string|int
83
	 */
84
85
	public function getRaw()
86
	{
87
		return $this->_raw;
88
	}
89
90
	/**
91
	 * get the hash
92
	 *
93 2
	 * @since 2.6.0
94
	 *
95 2
	 * @return string
96
	 */
97
98
	public function getHash() : string
99
	{
100
		return $this->_hash;
101
	}
102
103
	/**
104 8
	 * validate raw again hash
105
	 *
106 8
	 * @since 2.6.0
107 8
	 *
108
	 * @param string|int $raw plain raw
109
	 * @param string $hash salted hash
110
	 *
111
	 * @return bool
112
	 */
113
114
	public function validate($raw = null, string $hash = null) : bool
115
	{
116
		return password_verify($raw, $hash);
117
	}
118
119
	/**
120
	 * create a salted hash
121
	 *
122
	 * @since 4.0.0
123
	 */
124
125
	protected function _create() : void
126
	{
127
		$this->_hash = password_hash($this->_raw, $this->getAlgorithm());
128
	}
129
}
130