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
202
203
204
205
206
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Login;
use Exception;
use Piwik\Auth as AuthInterface;
use Piwik\AuthResult;
use Piwik\Config;
use Piwik\Cookie;
use Piwik\Piwik;
use Piwik\Plugins\UsersManager\API as UsersManagerAPI;
use Piwik\ProxyHttp;
use Piwik\Session;
/**
*/
class SessionInitializer
{
/**
* The UsersManager API instance.
*
* @var UsersManagerAPI
*/
private $usersManagerAPI;
/**
* The authenticated session cookie's name. Defaults to the value of the `[General] login_cookie_name`
* INI config option.
*
* @var string
*/
private $authCookieName;
/**
* The time in seconds before the authenticated session cookie expires. Only used if `$rememberMe`
* is true in the {@link initSession()} call.
*
* Defaults to the value of the `[General] login_cookie_expire` INI config option.
*
* @var string
*/
private $authCookieValidTime;
/**
* The path for the authenticated session cookie. Defaults to the value of the `[General] login_cookie_path`
* INI config option.
*
* @var string
*/
private $authCookiePath;
/**
* Constructor.
*
* @param UsersManagerAPI|null $usersManagerAPI
* @param string|null $authCookieName
* @param int|null $authCookieValidTime
* @param string|null $authCookiePath
*/
public function __construct(
$usersManagerAPI = null,
$authCookieName = null,
$authCookieValidTime = null,
$authCookiePath = null
) {
if (empty($usersManagerAPI)) {
$usersManagerAPI = UsersManagerAPI::getInstance();
}
$this->usersManagerAPI = $usersManagerAPI;
if (empty($authCookieName)) {
$authCookieName = Config::getInstance()->General['login_cookie_name'];
}
$this->authCookieName = $authCookieName;
if (empty($authCookieValidTime)) {
$authCookieValidTime = Config::getInstance()->General['login_cookie_expire'];
}
$this->authCookieValidTime = $authCookieValidTime;
if (empty($authCookiePath)) {
$authCookiePath = Config::getInstance()->General['login_cookie_path'];
}
$this->authCookiePath = $authCookiePath;
}
/**
* Authenticates the user and, if successful, initializes an authenticated session.
*
* @param \Piwik\Auth $auth The Auth implementation to use.
* @param bool $rememberMe Whether the authenticated session should be remembered after
* the browser is closed or not.
* @throws Exception If authentication fails or the user is not allowed to login for some reason.
*/
public function initSession(AuthInterface $auth, $rememberMe)
{
$this->regenerateSessionId();
$authResult = $this->doAuthenticateSession($auth);
if (!$authResult->wasAuthenticationSuccessful()) {
Piwik::postEvent('Login.authenticate.failed', array($auth->getLogin()));
$this->processFailedSession($rememberMe);
} else {
Piwik::postEvent('Login.authenticate.successful', array($auth->getLogin()));
$this->processSuccessfulSession($authResult, $rememberMe);
}
}
/**
* Authenticates the user.
*
* Derived classes can override this method to customize authentication logic or impose
* extra requirements on the user trying to login.
*
* @param AuthInterface $auth The Auth implementation to use when authenticating.
* @return AuthResult
*/
protected function doAuthenticateSession(AuthInterface $auth)
{
Piwik::postEvent(
'Login.authenticate',
array(
$auth->getLogin(),
)
);
return $auth->authenticate();
}
/**
* Returns a Cookie instance that manages the browser cookie used to store session
* information.
*
* @param bool $rememberMe Whether the authenticated session should be remembered after
* the browser is closed or not.
* @return Cookie
*/
protected function getAuthCookie($rememberMe)
{
$authCookieExpiry = $rememberMe ? time() + $this->authCookieValidTime : 0;
$cookie = new Cookie($this->authCookieName, $authCookieExpiry, $this->authCookiePath);
return $cookie;
}
/**
* Executed when the session could not authenticate.
*
* @param bool $rememberMe Whether the authenticated session should be remembered after
* the browser is closed or not.
* @throws Exception always.
*/
protected function processFailedSession($rememberMe)
{
$cookie = $this->getAuthCookie($rememberMe);
$cookie->delete();
throw new Exception(Piwik::translate('Login_LoginPasswordNotCorrect'));
}
/**
* Executed when the session was successfully authenticated.
*
* @param AuthResult $authResult The successful authentication result.
* @param bool $rememberMe Whether the authenticated session should be remembered after
* the browser is closed or not.
*/
protected function processSuccessfulSession(AuthResult $authResult, $rememberMe)
{
$cookie = $this->getAuthCookie($rememberMe);
$cookie->setSecure(ProxyHttp::isHttps());
$cookie->setHttpOnly(true);
$cookie->save();
return $cookie;
}
protected function regenerateSessionId()
{
Session::regenerateId();
}
/**
* Accessor to compute the hashed authentication token.
*
* @param string $login user login
* @param string $token_auth authentication token
* @return string hashed authentication token
*/
public static function getHashTokenAuth(
$login,
#[\SensitiveParameter]
$token_auth
) {
return md5($login . $token_auth);
}
}
|
