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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?php
/**
* 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
* @ingroup Auth
*/
namespace MediaWiki\Auth;
use Password;
use PasswordFactory;
use Status;
/**
* Basic framework for a primary authentication provider that uses passwords
* @ingroup Auth
* @since 1.27
*/
abstract class AbstractPasswordPrimaryAuthenticationProvider
extends AbstractPrimaryAuthenticationProvider
{
/** @var bool Whether this provider should ABSTAIN (false) or FAIL (true) on password failure */
protected $authoritative;
private $passwordFactory = null;
/**
* @param array $params Settings
* - authoritative: Whether this provider should ABSTAIN (false) or FAIL
* (true) on password failure
*/
public function __construct( array $params = [] ) {
$this->authoritative = !isset( $params['authoritative'] ) || (bool)$params['authoritative'];
}
/**
* Get the PasswordFactory
* @return PasswordFactory
*/
protected function getPasswordFactory() {
if ( $this->passwordFactory === null ) {
$this->passwordFactory = new PasswordFactory();
$this->passwordFactory->init( $this->config );
}
return $this->passwordFactory;
}
/**
* Get a Password object from the hash
* @param string $hash
* @return Password
*/
protected function getPassword( $hash ) {
$passwordFactory = $this->getPasswordFactory();
try {
return $passwordFactory->newFromCiphertext( $hash );
} catch ( \PasswordError $e ) {
$class = static::class;
$this->logger->debug( "Invalid password hash in {$class}::getPassword()" );
return $passwordFactory->newFromCiphertext( null );
}
}
/**
* Return the appropriate response for failure
* @param PasswordAuthenticationRequest $req
* @return AuthenticationResponse
*/
protected function failResponse( PasswordAuthenticationRequest $req ) {
if ( $this->authoritative ) {
return AuthenticationResponse::newFail(
wfMessage( $req->password === '' ? 'wrongpasswordempty' : 'wrongpassword' )
);
} else {
return AuthenticationResponse::newAbstain();
}
}
/**
* Check that the password is valid
*
* This should be called *before* validating the password. If the result is
* not ok, login should fail immediately.
*
* @param string $username
* @param string $password
* @return Status
*/
protected function checkPasswordValidity( $username, $password ) {
return \User::newFromName( $username )->checkPasswordValidity( $password );
}
/**
* Check if the password should be reset
*
* This should be called after a successful login. It sets 'reset-pass'
* authentication data if necessary, see
* ResetPassSecondaryAuthenticationProvider.
*
* @param string $username
* @param Status $status From $this->checkPasswordValidity()
* @param mixed $data Passed through to $this->getPasswordResetData()
*/
protected function setPasswordResetFlag( $username, Status $status, $data = null ) {
$reset = $this->getPasswordResetData( $username, $data );
if ( !$reset && $this->config->get( 'InvalidPasswordReset' ) && !$status->isGood() ) {
$reset = (object)[
'msg' => $status->getMessage( 'resetpass-validity-soft' ),
'hard' => false,
];
}
if ( $reset ) {
$this->manager->setAuthenticationSessionData( 'reset-pass', $reset );
}
}
/**
* Get password reset data, if any
*
* @param string $username
* @param mixed $data
* @return object|null { 'hard' => bool, 'msg' => Message }
*/
protected function getPasswordResetData( $username, $data ) {
return null;
}
/**
* Get expiration date for a new password, if any
*
* @param string $username
* @return string|null
*/
protected function getNewPasswordExpiry( $username ) {
$days = $this->config->get( 'PasswordExpirationDays' );
$expires = $days ? wfTimestamp( TS_MW, time() + $days * 86400 ) : null;
// Give extensions a chance to force an expiration
\Hooks::run( 'ResetPasswordExpiration', [ \User::newFromName( $username ), &$expires ] );
return $expires;
}
public function getAuthenticationRequests( $action, array $options ) {
switch ( $action ) {
case AuthManager::ACTION_LOGIN:
case AuthManager::ACTION_REMOVE:
case AuthManager::ACTION_CREATE:
case AuthManager::ACTION_CHANGE:
return [ new PasswordAuthenticationRequest() ];
default:
return [];
}
}
}
|
