-
Notifications
You must be signed in to change notification settings - Fork 719
/
AuthFlags.class.php
398 lines (353 loc) · 10.7 KB
/
AuthFlags.class.php
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
<?php
# MantisBT - A PHP based bugtracking system
# MantisBT 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.
#
# MantisBT 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 MantisBT. If not, see <http://www.gnu.org/licenses/>.
/**
* Avatar class.
* @copyright Copyright 2014 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
* @package MantisBT
*/
/**
* Auth Flags class
*
* @package MantisBT
* @subpackage classes
*/
require_api( 'access_api.php' );
require_api( 'plugin_api.php' );
require_api( 'user_api.php' );
/**
* A class that that contains authentication flags.
*/
class AuthFlags {
/**
* Indicates whether user can use the native login via passwords in MantisBT database.
* @var bool|null
*/
private $can_use_native_login = null;
/**
* The message to display indicating that passwords are not managed by MantisBT native passwords.
* @var string|null
*/
private $password_managed_elsewhere_message = null;
/**
* The login page to use instead of the standard MantisBT login page. This can be
* a plugin page.
*
* @see $credentials_page
* @see $logout_page
* @var string|null
*/
private $login_page = null;
/**
* The page to use for providing credentials. This can be the default password page
* provided by MantisBT, an auth plugin provided page that asks for credentials or
* an auth plugin provided page that re-directs to an IDP.
*
* @see $login_page
* @see $logout_page
* @var string|null
*/
private $credentials_page = null;
/**
* The logout page to use instead of the standard MantisBT logout page. This can be
* a plugin page.
*
* @see $credentials_page
* @see $login_page
* @see $logout_redirect_page
* @var string|null
*/
private $logout_page = null;
/**
* The page to redirect to after successful logout. This can be a plugin page. Such
* page can display content directly to redirect to a MantisBT page to a remote page.
*
* @see $logout_page
* @var string|null
*/
private $logout_redirect_page = null;
/**
* The login session lifetime in seconds or 0 for browser session.
* @var int|null
*/
private $session_lifetime = null;
/**
* Indicates whether 'remember me' option is allowed.
* @see $perm_session_lifetime
* @var bool|null
*/
private $perm_session_enabled = null;
/**
* Indicates the lifetime for 'remember me' sessions. MantisBT default is 1 year.
* @see $perm_session_enabled
* @var int|null
*/
private $perm_session_lifetime = null;
/**
* Indicates if re-authentication for operations like administrative functions and updating
* user profile is enabled.
* @see $reauthentication_expiry;
* @var bool|null
*/
private $reauthentication_enabled = null;
/**
* Indicates the expiry time in seconds after which the user should be asked to reauthenticate
* for administrative functions and updating user profile.
* @see $reauthentication_enabled
* @var int|null
*/
private $reauthentication_expiry = null;
/**
* AuthFlags constructor.
*/
function __construct() {
}
/**
* Sets the message to display to user when they can't manage their password within MantisBT.
*
* @param string|null $p_message The message to display to user or null for default message.
* @return void
* @see getPasswordManagedExternallyMessage()
*/
function setPasswordManagedExternallyMessage( $p_message ) {
$this->password_managed_elsewhere_message = $p_message;
}
/**
* Gets the message to display to the user when they can't manage their password within MantisBT.
*
* @return string The message.
* @see setPasswordManagedExternallyMessage()
*/
function getPasswordManagedExternallyMessage() {
if( empty( $this->password_managed_elsewhere_message ) ) {
return lang_get( 'password_managed_elsewhere_message' );
}
}
/**
* Indicates whether user can use native MantisBT auth providers or not.
*
* @param bool $p_enabled true: can user standard login, false: otherwise.
* @return void
* @see getCanUseStandardLogin()
*/
function setCanUseStandardLogin( $p_enabled ) {
$this->can_use_native_login = $p_enabled;
}
/**
* Gets whether user can use standard MantisBT password providers.
*
* @return bool true: can use standard MantisBT login, false: otherwise.
* @see setCanUseStandardLogin()
*/
function getCanUseStandardLogin() {
return is_null( $this->can_use_native_login ) ? true : $this->can_use_native_login;
}
/**
* Sets login page to use instead of the default login page that asks for username or
* email address.
*
* @param string $p_page The relative url of the page name.
* @return void
* @see getLoginPage()
*/
function setLoginPage( $p_page ) {
$this->login_page = $p_page;
}
/**
* Gets the login page to use.
*
* @return string The relative login page name.
* @see setLoginPage()
*/
function getLoginPage() {
return is_null( $this->login_page ) ? AUTH_PAGE_USERNAME : $this->login_page;
}
/**
* Sets the page to ask for user credentials. By default MantisBT would ask for
* password on this page and options like remember me, etc.
*
* @param string $p_page The relative page name.
* @return void
* @see getCredentialsPage()
*/
function setCredentialsPage( $p_page ) {
$this->credentials_page = $p_page;
}
/**
* Gets the page to use to ask for user credentials. This should be a page that is
* provided by MantisBT core or one of the plugins. Such page can redirect as needed.
*
* @return string The relative url for the credential page.
* @see setCredentialsPage()
*/
function getCredentialsPage() {
return is_null( $this->credentials_page ) ? AUTH_PAGE_CREDENTIAL : $this->credentials_page;
}
/**
* Sets the relative page of the logout page to use. Such page can be provided by MantisBT core
* or a plugin, it can redirect as needed.
*
* @param string $p_page The page relative url.
* @return void
* @see getLogoutPage()
*/
function setLogoutPage( $p_page ) {
$this->logout_page = $p_page;
}
/**
* Gets the relative url of the logout page provided by MantisBT core or a plugin.
*
* @return string The relative url of the logout page.
* @see setLogoutPage()
*/
function getLogoutPage() {
return is_null( $this->logout_page ) ? 'logout_page.php' : $this->logout_page;
}
/**
* Sets the relative logout redirect page, this is used by the native MantisBT logout
* page. The page must be provided by MantisBT plugin, but it can redirect as necessary.
*
* @param string $p_page The relative page url.
* @return void
* @see getLogoutRedirectPage()
*/
function setLogoutRedirectPage( $p_page ) {
$this->logout_redirect_page = $p_page;
}
/**
* Gets the relative logout redirect page that the native MantisBT logout page would
* redirect to. It must be a page that is provided by MantisBT core or a plugin.
*
* @return string The relative redirect url.
* @see setLogoutRedirectPage()
*/
function getLogoutRedirectPage() {
if( is_null( $this->logout_redirect_page ) ) {
return config_get( 'logout_redirect_page' );
}
return $this->logout_redirect_page;
}
/**
* Sets the lifetime of a default login session.
*
* @param int $p_seconds The lifetime of the session in seconds or 0 for browser session.
* @return void
* @see getSessionLifetime()
*/
function setSessionLifetime( $p_seconds ) {
$this->session_lifetime = $p_seconds;
}
/**
* Gets the login session lifetime.
*
* @return int The lifetime of the session in seconds or 0 for browser session.
* @see setSessionLifetime()
*/
function getSessionLifetime() {
if( is_null( $this->session_lifetime ) ) {
return 0;
}
return $this->session_lifetime;
}
/**
* Sets whether the user can select the remember me option.
*
* @param bool $p_enabled true: enabled, false: otherwise.
* @return void
* @see getPermSessionEnabled()
*/
function setPermSessionEnabled( $p_enabled ) {
$this->perm_session_enabled = $p_enabled;
}
/**
* Checks whether user can use remember me option.
*
* @return bool true: enabled, false: otherwise.
* @see setPermSessionEnabled()
*/
function getPermSessionEnabled() {
if( is_null( $this->perm_session_enabled ) ) {
return config_get_global( 'allow_permanent_cookie' ) != OFF;
}
return $this->perm_session_enabled;
}
/**
* Sets the remember me session lifetime.
*
* @param int $p_seconds The lifetime of remember me session in seconds or 0 for browser session.
* @return void
* @see getPermSessionLifetime()
*/
function setPermSessionLifetime( $p_seconds ) {
$this->perm_session_lifetime = $p_seconds;
}
/**
* Gets the remember me session lifetime.
*
* @return int The session lifetime in seconds or 0 for a browser session.
* @see setPermSessionLifetime()
*/
function getPermSessionLifetime() {
if( is_null( $this->perm_session_lifetime ) ) {
return config_get_global( 'cookie_time_length' );
}
return $this->perm_session_lifetime;
}
/**
* Indicates whether user will be prompted for re-authentication after a timeout.
*
* @param bool $p_enabled true: enabled, false otherwise.
* @return void
* @see getReauthenticationEnabled()
*/
function setReauthenticationEnabled( $p_enabled ) {
$this->reauthentication_enabled = $p_enabled;
}
/**
* Gets whether user will be prompted for re-authentication after a timeout.
*
* @return bool true: enabled, false otherwise.
* @see setReauthenticationEnabled()
*/
function getReauthenticationEnabled() {
if( is_null( $this->reauthentication_enabled ) ) {
return config_get( 'reauthentication' );
}
return $this->reauthentication_enabled;
}
/**
* Sets the number of seconds to re-authenticate the user after.
*
* @param int $p_seconds The number of seconds to prompt for re-authentication after.
* @return void
* @see getReauthenticationEnabled()
*/
function setReauthenticationLifetime( $p_seconds ) {
$this->reauthentication_expiry = $p_seconds;
}
/**
* Gets the number of seconds to re-authenticate the user after.
*
* @param int $p_seconds The number of seconds to prompt for re-authentication after.
* @return int seconds after which the user should be re-authenticated.
* @see setReauthenticationLifetime()
*/
function getReauthenticationLifetime() {
if( is_null( $this->reauthentication_expiry ) ) {
return config_get( 'reauthentication_expiry' );
}
return $this->reauthentication_expiry;
}
}