<?php
namespace Shaarli\Security;
+use Exception;
use Shaarli\Config\ConfigManager;
/**
*/
class LoginManager
{
- /** @var string Name of the cookie set after logging in **/
- public static $STAY_SIGNED_IN_COOKIE = 'shaarli_staySignedIn';
-
/** @var array A reference to the $_GLOBALS array */
protected $globals = [];
/** @var SessionManager Session Manager instance **/
protected $sessionManager = null;
- /** @var string Path to the file containing IP bans */
- protected $banFile = '';
+ /** @var BanManager Ban Manager instance **/
+ protected $banManager;
/** @var bool Whether the user is logged in **/
protected $isLoggedIn = false;
/** @var string User sign-in token depending on remote IP and credentials */
protected $staySignedInToken = '';
+ /** @var CookieManager */
+ protected $cookieManager;
/**
* Constructor
*
- * @param array $globals The $GLOBALS array (reference)
* @param ConfigManager $configManager Configuration Manager instance
* @param SessionManager $sessionManager SessionManager instance
+ * @param CookieManager $cookieManager CookieManager instance
*/
- public function __construct(& $globals, $configManager, $sessionManager)
+ public function __construct($configManager, $sessionManager, $cookieManager)
{
- $this->globals = &$globals;
$this->configManager = $configManager;
$this->sessionManager = $sessionManager;
- $this->banFile = $this->configManager->get('resource.ban_file', 'data/ipbans.php');
- $this->readBanFile();
+ $this->cookieManager = $cookieManager;
+ $this->banManager = new BanManager(
+ $this->configManager->get('security.trusted_proxies', []),
+ $this->configManager->get('security.ban_after'),
+ $this->configManager->get('security.ban_duration'),
+ $this->configManager->get('resource.ban_file', 'data/ipbans.php'),
+ $this->configManager->get('resource.log')
+ );
+
if ($this->configManager->get('security.open_shaarli') === true) {
$this->openShaarli = true;
}
*/
public function generateStaySignedInToken($clientIpAddress)
{
+ if ($this->configManager->get('security.session_protection_disabled') === true) {
+ $clientIpAddress = '';
+ }
$this->staySignedInToken = sha1(
$this->configManager->get('credentials.hash')
. $clientIpAddress
/**
* Check user session state and validity (expiration)
*
- * @param array $cookie The $_COOKIE array
* @param string $clientIpId Client IP address identifier
*/
- public function checkLoginState($cookie, $clientIpId)
+ public function checkLoginState($clientIpId)
{
if (! $this->configManager->exists('credentials.login')) {
// Shaarli is not configured yet
return;
}
- if (isset($cookie[self::$STAY_SIGNED_IN_COOKIE])
- && $cookie[self::$STAY_SIGNED_IN_COOKIE] === $this->staySignedInToken
- ) {
+ if ($this->staySignedInToken === $this->cookieManager->getCookieParameter(CookieManager::STAY_SIGNED_IN)) {
// The user client has a valid stay-signed-in cookie
// Session information is updated with the current client information
$this->sessionManager->storeLoginInfo($clientIpId);
-
} elseif ($this->sessionManager->hasSessionExpired()
|| $this->sessionManager->hasClientIpChanged($clientIpId)
) {
*/
public function checkCredentials($remoteIp, $clientIpId, $login, $password)
{
- $hash = sha1($password . $login . $this->configManager->get('credentials.salt'));
+ // Check login matches config
+ if ($login !== $this->configManager->get('credentials.login')) {
+ return false;
+ }
- if ($login != $this->configManager->get('credentials.login')
- || $hash != $this->configManager->get('credentials.hash')
- ) {
+ // Check credentials
+ try {
+ $useLdapLogin = !empty($this->configManager->get('ldap.host'));
+ if ((false === $useLdapLogin && $this->checkCredentialsFromLocalConfig($login, $password))
+ || (true === $useLdapLogin && $this->checkCredentialsFromLdap($login, $password))
+ ) {
+ $this->sessionManager->storeLoginInfo($clientIpId);
+ logm(
+ $this->configManager->get('resource.log'),
+ $remoteIp,
+ 'Login successful'
+ );
+ return true;
+ }
+ }
+ catch(Exception $exception) {
logm(
$this->configManager->get('resource.log'),
$remoteIp,
- 'Login failed for user ' . $login
+ 'Exception while checking credentials: ' . $exception
);
- return false;
}
- $this->sessionManager->storeLoginInfo($clientIpId);
logm(
$this->configManager->get('resource.log'),
$remoteIp,
- 'Login successful'
+ 'Login failed for user ' . $login
);
- return true;
+ return false;
}
+
/**
- * Read a file containing banned IPs
+ * Check user credentials from local config
+ *
+ * @param string $login Username
+ * @param string $password Password
+ *
+ * @return bool true if the provided credentials are valid, false otherwise
*/
- protected function readBanFile()
- {
- if (! file_exists($this->banFile)) {
- return;
- }
- include $this->banFile;
+ public function checkCredentialsFromLocalConfig($login, $password) {
+ $hash = sha1($password . $login . $this->configManager->get('credentials.salt'));
+
+ return $login == $this->configManager->get('credentials.login')
+ && $hash == $this->configManager->get('credentials.hash');
}
/**
- * Write the banned IPs to a file
+ * Check user credentials are valid through LDAP bind
+ *
+ * @param string $remoteIp Remote client IP address
+ * @param string $clientIpId Client IP address identifier
+ * @param string $login Username
+ * @param string $password Password
+ *
+ * @return bool true if the provided credentials are valid, false otherwise
*/
- protected function writeBanFile()
+ public function checkCredentialsFromLdap($login, $password, $connect = null, $bind = null)
{
- if (! array_key_exists('IPBANS', $this->globals)) {
- return;
- }
- file_put_contents(
- $this->banFile,
- "<?php\n\$GLOBALS['IPBANS']=" . var_export($this->globals['IPBANS'], true) . ";\n?>"
+ $connect = $connect ?? function($host) {
+ $resource = ldap_connect($host);
+
+ ldap_set_option($resource, LDAP_OPT_PROTOCOL_VERSION, 3);
+
+ return $resource;
+ };
+ $bind = $bind ?? function($handle, $dn, $password) {
+ return ldap_bind($handle, $dn, $password);
+ };
+
+ return $bind(
+ $connect($this->configManager->get('ldap.host')),
+ sprintf($this->configManager->get('ldap.dn'), $login),
+ $password
);
}
*/
public function handleFailedLogin($server)
{
- $ip = $server['REMOTE_ADDR'];
- $trusted = $this->configManager->get('security.trusted_proxies', []);
-
- if (in_array($ip, $trusted)) {
- $ip = getIpAddressFromProxy($server, $trusted);
- if (! $ip) {
- // the IP is behind a trusted forward proxy, but is not forwarded
- // in the HTTP headers, so we do nothing
- return;
- }
- }
-
- // increment the fail count for this IP
- if (isset($this->globals['IPBANS']['FAILURES'][$ip])) {
- $this->globals['IPBANS']['FAILURES'][$ip]++;
- } else {
- $this->globals['IPBANS']['FAILURES'][$ip] = 1;
- }
-
- if ($this->globals['IPBANS']['FAILURES'][$ip] >= $this->configManager->get('security.ban_after')) {
- $this->globals['IPBANS']['BANS'][$ip] = time() + $this->configManager->get('security.ban_duration', 1800);
- logm(
- $this->configManager->get('resource.log'),
- $server['REMOTE_ADDR'],
- 'IP address banned from login'
- );
- }
- $this->writeBanFile();
+ $this->banManager->handleFailedAttempt($server);
}
/**
*/
public function handleSuccessfulLogin($server)
{
- $ip = $server['REMOTE_ADDR'];
- // FIXME unban when behind a trusted proxy?
-
- unset($this->globals['IPBANS']['FAILURES'][$ip]);
- unset($this->globals['IPBANS']['BANS'][$ip]);
-
- $this->writeBanFile();
+ $this->banManager->clearFailures($server);
}
/**
*/
public function canLogin($server)
{
- $ip = $server['REMOTE_ADDR'];
-
- if (! isset($this->globals['IPBANS']['BANS'][$ip])) {
- // the user is not banned
- return true;
- }
-
- if ($this->globals['IPBANS']['BANS'][$ip] > time()) {
- // the user is still banned
- return false;
- }
-
- // the ban has expired, the user can attempt to log in again
- logm($this->configManager->get('resource.log'), $server['REMOTE_ADDR'], 'Ban lifted.');
- unset($this->globals['IPBANS']['FAILURES'][$ip]);
- unset($this->globals['IPBANS']['BANS'][$ip]);
-
- $this->writeBanFile();
- return true;
+ return ! $this->banManager->isBanned($server);
}
}
projects / github / shaarli / Shaarli.git / blobdiff