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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\Login;
use Piwik\AuthResult;
use Piwik\Auth\Password;
use Piwik\Piwik;
use Piwik\Plugins\UsersManager\Model;
use Piwik\Plugins\UsersManager\UsersManager;
class Auth implements \Piwik\Auth
{
protected $login;
protected $token_auth;
protected $hashedPassword;
/**
* @var Model
*/
private $userModel;
/**
* @var Password
*/
private $passwordHelper;
public function __construct()
{
$this->userModel = new Model();
$this->passwordHelper = new Password();
}
/**
* Authentication module's name, e.g., "Login"
*
* @return string
*/
public function getName()
{
return 'Login';
}
/**
* Authenticates user
*
* @return AuthResult
*/
public function authenticate()
{
if (!empty($this->hashedPassword)) {
return $this->authenticateWithPassword($this->login, $this->getTokenAuthSecret());
} elseif (is_null($this->login)) {
return $this->authenticateWithToken($this->token_auth);
} elseif (!empty($this->login)) {
return $this->authenticateWithLoginAndToken($this->token_auth, $this->login);
}
return new AuthResult(AuthResult::FAILURE, $this->login, $this->token_auth);
}
private function authenticateWithPassword($login, $passwordHash)
{
$user = $this->userModel->getUser($login);
if (empty($user['login'])) {
return new AuthResult(AuthResult::FAILURE, $login, null);
}
if ($this->passwordHelper->verify($passwordHash, $user['password'])) {
if ($this->passwordHelper->needsRehash($user['password'])) {
$newPasswordHash = $this->passwordHelper->hash($passwordHash);
$this->userModel->updateUser($login, $newPasswordHash, $user['email'], $user['alias'], $user['token_auth']);
}
return $this->authenticationSuccess($user);
}
return new AuthResult(AuthResult::FAILURE, $login, null);
}
private function authenticateWithToken($token)
{
$user = $this->userModel->getUserByTokenAuth($token);
if (!empty($user['login'])) {
return $this->authenticationSuccess($user);
}
return new AuthResult(AuthResult::FAILURE, null, $token);
}
private function authenticateWithLoginAndToken($token, $login)
{
$user = $this->userModel->getUser($login);
if (!empty($user['token_auth'])
// authenticate either with the token or the "hash token"
&& ((SessionInitializer::getHashTokenAuth($login, $user['token_auth']) === $token)
|| $user['token_auth'] === $token)
) {
return $this->authenticationSuccess($user);
}
return new AuthResult(AuthResult::FAILURE, $login, $token);
}
private function authenticationSuccess(array $user)
{
$this->setTokenAuth($user['token_auth']);
$isSuperUser = (int) $user['superuser_access'];
$code = $isSuperUser ? AuthResult::SUCCESS_SUPERUSER_AUTH_CODE : AuthResult::SUCCESS;
return new AuthResult($code, $user['login'], $user['token_auth']);
}
/**
* Returns the login of the user being authenticated.
*
* @return string
*/
public function getLogin()
{
return $this->login;
}
/**
* Accessor to set login name
*
* @param string $login user login
*/
public function setLogin($login)
{
$this->login = $login;
}
/**
* Returns the secret used to calculate a user's token auth.
*
* @return string
*/
public function getTokenAuthSecret()
{
return $this->hashedPassword;
}
/**
* Accessor to set authentication token
*
* @param string $token_auth authentication token
*/
public function setTokenAuth($token_auth)
{
$this->token_auth = $token_auth;
}
/**
* Sets the password to authenticate with.
*
* @param string $password
*/
public function setPassword($password)
{
if (empty($password)) {
$this->hashedPassword = null;
} else {
$this->hashedPassword = UsersManager::getPasswordHash($password);
}
}
/**
* Sets the password hash to use when authentication.
*
* @param string $passwordHash The password hash.
*/
public function setPasswordHash($passwordHash)
{
if ($passwordHash === null) {
$this->hashedPassword = null;
return;
}
// check that the password hash is valid (sanity check)
UsersManager::checkPasswordHash($passwordHash, Piwik::translate('Login_ExceptionPasswordMD5HashExpected'));
$this->hashedPassword = $passwordHash;
}
// for tests
public function getTokenAuth()
{
return $this->token_auth;
}
}
|
