人事系统开发
48092cab42
Docker image / push (push) Canceled after 0s
包含：登录失败锁定、90天密码有效期、30分钟会话超时、 强制改密、登录审计日志、屏幕水印、企业背景图、 备案信息固定底部、favicon、登录页JS修复等全部改动
294 lines
9.2 KiB
PHP
294 lines
9.2 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
namespace MRBS\Session;
|
|
|
|
use MRBS\Form\ElementA;
|
|
use MRBS\Form\ElementFieldset;
|
|
use MRBS\Form\ElementP;
|
|
use MRBS\Form\FieldDiv;
|
|
use MRBS\Form\FieldInputPassword;
|
|
use MRBS\Form\FieldInputSubmit;
|
|
use MRBS\Form\FieldInputText;
|
|
use MRBS\Form\Form;
|
|
use function MRBS\auth;
|
|
use function MRBS\get_form_var;
|
|
use function MRBS\get_vocab;
|
|
use function MRBS\location_header;
|
|
use function MRBS\multisite;
|
|
use function MRBS\print_footer;
|
|
use function MRBS\print_header;
|
|
use function MRBS\this_page;
|
|
|
|
/**
|
|
* An abstract class for those session schemes that implement a login form.
|
|
*/
|
|
abstract class SessionWithLogin extends Session
|
|
{
|
|
protected $form = array();
|
|
|
|
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
// Get the non-standard form variables
|
|
$vars = [
|
|
'action' => 'string',
|
|
'username' => 'string',
|
|
'password' => 'string',
|
|
'returl' => 'url_local'
|
|
];
|
|
|
|
foreach ($vars as $var => $type)
|
|
{
|
|
$this->form[$var] = get_form_var($var, $type, null, INPUT_POST);
|
|
}
|
|
|
|
// Allow the target_url to be a GET or POST value to help password managers (the target_url can
|
|
// be stored as a query string parameter in the password manager).
|
|
$this->form['target_url'] = get_form_var('target_url', 'url_local');
|
|
|
|
if (isset($this->form['username']))
|
|
{
|
|
// It's easy for extra spaces to appear, especially on a mobile device
|
|
$this->form['username'] = trim($this->form['username']);
|
|
}
|
|
}
|
|
|
|
|
|
// Gets the username and password. Returns: Nothing
|
|
//
|
|
// $target_url The URL to go to after successful login
|
|
// $returl The URL to return to eventually
|
|
public function authGet(?string $target_url=null, ?string $returl=null, ?string $error=null, bool $raw=false) : void
|
|
{
|
|
if (!isset($target_url))
|
|
{
|
|
$target_url = $this->form['target_url'] ?? this_page(true);
|
|
}
|
|
|
|
// Omit the Login link in the header when we're on the login page itself
|
|
print_header(null, false, true);
|
|
$action = multisite(this_page());
|
|
$this->printLoginForm($action, $target_url, $returl, $error, $raw);
|
|
exit;
|
|
}
|
|
|
|
|
|
// Returns the parameters ('method', 'action' and 'hidden_inputs') for a
|
|
// Logon form. Returns an array.
|
|
public function getLogonFormParams() : ?array
|
|
{
|
|
return array(
|
|
'action' => multisite('admin.php'),
|
|
'method' => Form::METHOD_POST,
|
|
'hidden_inputs' => array('target_url' => this_page(true),
|
|
'action' => 'QueryName')
|
|
);
|
|
}
|
|
|
|
|
|
// Returns the parameters ('method', 'action' and 'hidden_inputs') for a
|
|
// logoff form. Returns an array of parameters, or null if no form is to be
|
|
// shown.
|
|
public function getLogoffFormParams() : ?array
|
|
{
|
|
return array(
|
|
'action' => multisite('admin.php'),
|
|
'method' => Form::METHOD_POST,
|
|
'hidden_inputs' => array('target_url' => this_page(true),
|
|
'action' => 'SetName',
|
|
'username' => '',
|
|
'password' => '')
|
|
);
|
|
}
|
|
|
|
|
|
public function processForm() : void
|
|
{
|
|
if (isset($this->form['action']))
|
|
{
|
|
// Target of the form with sets the URL argument "action=QueryName".
|
|
// Will eventually return to URL argument "target_url=whatever".
|
|
if ($this->form['action'] == 'QueryName')
|
|
{
|
|
$this->authGet($this->form['target_url']);
|
|
exit(); // unnecessary because authGet() exits, but just included for clarity
|
|
}
|
|
|
|
// Target of the form with sets the URL argument "action=SetName".
|
|
// Will eventually return to URL argument "target_url=whatever".
|
|
if ($this->form['action'] == 'SetName')
|
|
{
|
|
// First make sure the password is valid
|
|
if (!isset($this->form['username']) || ($this->form['username'] == ''))
|
|
{
|
|
$this->logoffUser();
|
|
}
|
|
else
|
|
{
|
|
// If we're going to do something then check the CSRF token first.
|
|
// (Don't check the token before logging off the user because if the session has
|
|
// expired due to inactivity, the token will be invalid, but that won't matter because
|
|
// the result will be the same anyway - logging off the user - and we avoid
|
|
// generating an unnecessary CSRF error message.)
|
|
Form::checkToken();
|
|
|
|
// Get a valid user
|
|
$valid_username = $this->getValidUser($this->form['username'], $this->form['password']);
|
|
|
|
// Successful login. You can't get out of getValidUser() without a valid username and password
|
|
$this->logonUser($valid_username);
|
|
|
|
if (!empty($this->form['returl']))
|
|
{
|
|
// check to see whether there's a query string already
|
|
$this->form['target_url'] .= (mb_strpos($this->form['target_url'], '?') === false) ? '?' : '&';
|
|
$this->form['target_url'] .= 'returl=' . urlencode($this->form['returl']);
|
|
}
|
|
}
|
|
|
|
location_header($this->form['target_url']); // Redirect browser to initial page
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Can only return a valid username. If the username and password are not valid it will ask for new ones.
|
|
protected function getValidUser(
|
|
#[\SensitiveParameter]
|
|
?string $username,
|
|
#[\SensitiveParameter]
|
|
?string $password) : string
|
|
{
|
|
if (!isset($this->form['password']) ||
|
|
(($valid_username = auth()->validateUser($this->form['username'], $this->form['password'])) === false))
|
|
{
|
|
$this->authGet($this->form['target_url'], $this->form['returl'], get_vocab('unknown_user'));
|
|
exit(); // unnecessary because authGet() exits, but just included for clarity
|
|
}
|
|
|
|
return $valid_username;
|
|
}
|
|
|
|
|
|
protected function logonUser(string $username) : void
|
|
{
|
|
}
|
|
|
|
|
|
public function logoffUser() : void
|
|
{
|
|
}
|
|
|
|
|
|
// Displays the login form.
|
|
// Will eventually return to $target_url with query string returl=$returl
|
|
// If $error is set then an $error is printed.
|
|
// If $raw is true then the message is not HTML escaped
|
|
private function printLoginForm(string $action, ?string $target_url, ?string $returl, ?string $error=null, bool $raw=false) : void
|
|
{
|
|
$form = new Form(Form::METHOD_POST);
|
|
$form->setAttributes(array('class' => 'standard',
|
|
'id' => 'logon',
|
|
'action' => $action));
|
|
|
|
// Hidden inputs
|
|
$hidden_inputs = array('returl' => $returl,
|
|
'target_url' => $target_url,
|
|
'action' => 'SetName');
|
|
$form->addHiddenInputs($hidden_inputs);
|
|
|
|
// Now for the visible fields
|
|
if (isset($error))
|
|
{
|
|
$p = new ElementP();
|
|
$p->setText($error, false, $raw);
|
|
$form->addElement($p);
|
|
}
|
|
|
|
$fieldset = new ElementFieldset();
|
|
$fieldset->addLegend(get_vocab('please_login'));
|
|
|
|
// The username field
|
|
if (auth()->canValidateByEmail() && auth()->canValidateByUsername())
|
|
{
|
|
$tag = 'username_or_email';
|
|
}
|
|
elseif (auth()->canValidateByUsername())
|
|
{
|
|
$tag = 'users.name';
|
|
}
|
|
else
|
|
{
|
|
$tag = 'users.email';
|
|
}
|
|
|
|
$placeholder = get_vocab($tag);
|
|
|
|
$field = new FieldInputText();
|
|
$field->setLabel(get_vocab('user'))
|
|
->setLabelAttributes(array('title' => $placeholder))
|
|
->setControlAttributes(array('id' => 'username',
|
|
'name' => 'username',
|
|
'placeholder' => $placeholder,
|
|
'required' => true,
|
|
'autofocus' => true,
|
|
'autocomplete' => 'username'));
|
|
$fieldset->addElement($field);
|
|
|
|
// The password field
|
|
$field = new FieldInputPassword();
|
|
$field->setLabel(get_vocab('users.password'))
|
|
->setControlAttributes(array('id' => 'password',
|
|
'name' => 'password',
|
|
'autocomplete' => 'current-password'));
|
|
$fieldset->addElement($field);
|
|
|
|
$form->addElement($fieldset);
|
|
|
|
// The submit button
|
|
$fieldset = new ElementFieldset();
|
|
$field = new FieldInputSubmit();
|
|
$field->setControlAttributes(array('value' => get_vocab('login')));
|
|
$fieldset->addElement($field);
|
|
|
|
$form->addElement($fieldset);
|
|
|
|
if (auth()->canResetPassword())
|
|
{
|
|
$fieldset = new ElementFieldset();
|
|
$field = new FieldDiv();
|
|
$a = new ElementA();
|
|
$a->setAttribute('href', multisite('reset_password.php'))
|
|
->setText(get_vocab('lost_password'));
|
|
$field->addControl($a);
|
|
$fieldset->addElement($field);
|
|
$form->addElement($fieldset);
|
|
}
|
|
|
|
$form->render();
|
|
|
|
|
|
|
|
// Print footer and exit
|
|
print_footer(true);
|
|
}
|
|
|
|
|
|
// Check we've got the right authentication type for the session scheme.
|
|
// To be called for those session schemes which require the same
|
|
// authentication type
|
|
protected function checkTypeMatchesSession() : void
|
|
{
|
|
global $auth;
|
|
|
|
if ($auth['type'] !== $auth['session'])
|
|
{
|
|
$class = get_called_class();
|
|
$message = "MRBS configuration error: $class needs \$auth['type'] set to '" . $auth['session'] . "'";
|
|
die($message);
|
|
}
|
|
}
|
|
}
|