1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<?php
/**
* Implements the EncryptedPassword class for the MediaWiki software.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
declare( strict_types = 1 );
namespace MediaWiki\Password;
/**
* Helper class for passwords that use another password hash underneath it
* and encrypts that hash with a configured secret.
*
* @since 1.24
*/
class EncryptedPassword extends ParameterizedPassword {
protected function getDelimiter(): string {
return ':';
}
protected function getDefaultParams(): array {
return [
'cipher' => $this->config['cipher'],
'secret' => (string)( count( $this->config['secrets'] ) - 1 )
];
}
public function crypt( string $password ): void {
$secret = $this->config['secrets'][(int)$this->params['secret']];
// Clear error string
while ( openssl_error_string() !== false );
if ( $this->hash ) {
$decrypted = openssl_decrypt(
$this->hash, $this->params['cipher'],
$secret, 0, base64_decode( $this->args[0] ) );
if ( $decrypted === false ) {
throw new PasswordError( 'Error decrypting password: ' . openssl_error_string() );
}
$underlyingPassword = $this->factory->newFromCiphertext( $decrypted );
} else {
$underlyingPassword = $this->factory->newFromType( $this->config['underlying'] );
}
$underlyingPassword->crypt( $password );
if ( count( $this->args ) ) {
$iv = base64_decode( $this->args[0] );
} else {
$iv = random_bytes( openssl_cipher_iv_length( $this->params['cipher'] ) );
}
$this->hash = openssl_encrypt(
$underlyingPassword->toString(), $this->params['cipher'], $secret, 0, $iv );
if ( $this->hash === false ) {
throw new PasswordError( 'Error encrypting password: ' . openssl_error_string() );
}
$this->args = [ base64_encode( $iv ) ];
}
/**
* Updates the underlying hash by encrypting it with the newest secret.
*
* @throws PasswordError If the configuration is not valid
* @return bool True if the password was updated
*/
public function update(): bool {
if ( count( $this->args ) != 1 || $this->params == $this->getDefaultParams() ) {
// Hash does not need updating
return false;
}
// Clear error string
while ( openssl_error_string() !== false );
// Decrypt the underlying hash
$underlyingHash = openssl_decrypt(
$this->hash,
$this->params['cipher'],
$this->config['secrets'][(int)$this->params['secret']],
0,
base64_decode( $this->args[0] )
);
if ( $underlyingHash === false ) {
throw new PasswordError( 'Error decrypting password: ' . openssl_error_string() );
}
// Reset the params
$this->params = $this->getDefaultParams();
// Check the key size with the new params
$iv = random_bytes( openssl_cipher_iv_length( $this->params['cipher'] ) );
$this->hash = openssl_encrypt(
$underlyingHash,
$this->params['cipher'],
$this->config['secrets'][(int)$this->params['secret']],
0,
$iv
);
if ( $this->hash === false ) {
throw new PasswordError( 'Error encrypting password: ' . openssl_error_string() );
}
$this->args = [ base64_encode( $iv ) ];
return true;
}
/**
* @inheritDoc
*/
public function verify( string $password ): bool {
// Clear error string
while ( openssl_error_string() !== false );
// Decrypt the underlying hash
$underlyingHash = openssl_decrypt(
$this->hash,
$this->params['cipher'],
$this->config['secrets'][(int)$this->params['secret']],
0,
base64_decode( $this->args[0] )
);
if ( $underlyingHash === false ) {
throw new PasswordError( 'Error decrypting password: ' . openssl_error_string() );
}
$storedPassword = $this->factory->newFromCiphertext( $underlyingHash );
return $storedPassword->verify( $password );
}
}
/** @deprecated since 1.43 use MediaWiki\\Password\\EncryptedPassword */
class_alias( EncryptedPassword::class, 'EncryptedPassword' );
|
