Merge pull request #8909 from MrPetovan/task/ex_auth

Refactor ExAuth for DICE
This commit is contained in:
Michael Vogel 2020-08-22 22:12:22 +02:00 committed by GitHub
commit fc2340d4af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 102 additions and 65 deletions

View File

@ -80,6 +80,7 @@ $dice = $dice->addRule(LoggerInterface::class,['constructParams' => ['auth_ejabb
$appMode = $dice->create(Mode::class); $appMode = $dice->create(Mode::class);
if ($appMode->isNormal()) { if ($appMode->isNormal()) {
$oAuth = new ExAuth(); /** @var ExAuth $oAuth */
$oAuth = $dice->create(ExAuth::class);
$oAuth->readStdin(); $oAuth->readStdin();
} }

View File

@ -21,7 +21,9 @@
namespace Friendica\Model; namespace Friendica\Model;
use DivineOmega\DOFileCachePSR6\CacheItemPool;
use DivineOmega\PasswordExposed; use DivineOmega\PasswordExposed;
use ErrorException;
use Exception; use Exception;
use Friendica\Content\Pager; use Friendica\Content\Pager;
use Friendica\Core\Hook; use Friendica\Core\Hook;
@ -33,7 +35,7 @@ use Friendica\Core\Worker;
use Friendica\Database\DBA; use Friendica\Database\DBA;
use Friendica\DI; use Friendica\DI;
use Friendica\Model\TwoFactor\AppSpecificPassword; use Friendica\Model\TwoFactor\AppSpecificPassword;
use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Network\HTTPException;
use Friendica\Object\Image; use Friendica\Object\Image;
use Friendica\Util\Crypto; use Friendica\Util\Crypto;
use Friendica\Util\DateTimeFormat; use Friendica\Util\DateTimeFormat;
@ -41,6 +43,7 @@ use Friendica\Util\Images;
use Friendica\Util\Network; use Friendica\Util\Network;
use Friendica\Util\Strings; use Friendica\Util\Strings;
use Friendica\Worker\Delivery; use Friendica\Worker\Delivery;
use ImagickException;
use LightOpenID; use LightOpenID;
/** /**
@ -401,11 +404,11 @@ class User
/** /**
* Returns the default group for a given user and network * Returns the default group for a given user and network
* *
* @param int $uid User id * @param int $uid User id
* @param string $network network name * @param string $network network name
* *
* @return int group id * @return int group id
* @throws InternalServerErrorException * @throws Exception
*/ */
public static function getDefaultGroup($uid, $network = '') public static function getDefaultGroup($uid, $network = '')
{ {
@ -457,7 +460,8 @@ class User
* @param string $password * @param string $password
* @param bool $third_party * @param bool $third_party
* @return int User Id if authentication is successful * @return int User Id if authentication is successful
* @throws Exception * @throws HTTPException\ForbiddenException
* @throws HTTPException\NotFoundException
*/ */
public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false) public static function getIdFromPasswordAuthentication($user_info, $password, $third_party = false)
{ {
@ -492,7 +496,7 @@ class User
return $user['uid']; return $user['uid'];
} }
throw new Exception(DI::l10n()->t('Login failed')); throw new HTTPException\ForbiddenException(DI::l10n()->t('Login failed'));
} }
/** /**
@ -506,7 +510,7 @@ class User
* *
* @param mixed $user_info * @param mixed $user_info
* @return array * @return array
* @throws Exception * @throws HTTPException\NotFoundException
*/ */
private static function getAuthenticationInfo($user_info) private static function getAuthenticationInfo($user_info)
{ {
@ -550,7 +554,7 @@ class User
} }
if (!DBA::isResult($user)) { if (!DBA::isResult($user)) {
throw new Exception(DI::l10n()->t('User not found')); throw new HTTPException\NotFoundException(DI::l10n()->t('User not found'));
} }
} }
@ -561,6 +565,7 @@ class User
* Generates a human-readable random password * Generates a human-readable random password
* *
* @return string * @return string
* @throws Exception
*/ */
public static function generateNewPassword() public static function generateNewPassword()
{ {
@ -576,7 +581,7 @@ class User
*/ */
public static function isPasswordExposed($password) public static function isPasswordExposed($password)
{ {
$cache = new \DivineOmega\DOFileCachePSR6\CacheItemPool(); $cache = new CacheItemPool();
$cache->changeConfig([ $cache->changeConfig([
'cacheDirectory' => get_temppath() . '/password-exposed-cache/', 'cacheDirectory' => get_temppath() . '/password-exposed-cache/',
]); ]);
@ -585,7 +590,7 @@ class User
$passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache); $passwordExposedChecker = new PasswordExposed\PasswordExposedChecker(null, $cache);
return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED; return $passwordExposedChecker->passwordExposed($password) === PasswordExposed\PasswordStatus::EXPOSED;
} catch (\Exception $e) { } catch (Exception $e) {
Logger::error('Password Exposed Exception: ' . $e->getMessage(), [ Logger::error('Password Exposed Exception: ' . $e->getMessage(), [
'code' => $e->getCode(), 'code' => $e->getCode(),
'file' => $e->getFile(), 'file' => $e->getFile(),
@ -682,7 +687,6 @@ class User
* *
* @param string $nickname The nickname that should be checked * @param string $nickname The nickname that should be checked
* @return boolean True is the nickname is blocked on the node * @return boolean True is the nickname is blocked on the node
* @throws InternalServerErrorException
*/ */
public static function isNicknameBlocked($nickname) public static function isNicknameBlocked($nickname)
{ {
@ -727,9 +731,9 @@ class User
* *
* @param array $data * @param array $data
* @return array * @return array
* @throws \ErrorException * @throws ErrorException
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws \ImagickException * @throws ImagickException
* @throws Exception * @throws Exception
*/ */
public static function create(array $data) public static function create(array $data)
@ -855,7 +859,7 @@ class User
$nickname = $data['nickname'] = strtolower($nickname); $nickname = $data['nickname'] = strtolower($nickname);
if (!preg_match('/^[a-z0-9][a-z0-9\_]*$/', $nickname)) { if (!preg_match('/^[a-z0-9][a-z0-9_]*$/', $nickname)) {
throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.')); throw new Exception(DI::l10n()->t('Your nickname can only contain a-z, 0-9 and _.'));
} }
@ -1044,7 +1048,7 @@ class User
* *
* @return bool True, if the allow was successful * @return bool True, if the allow was successful
* *
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws Exception * @throws Exception
*/ */
public static function allow(string $hash) public static function allow(string $hash)
@ -1118,16 +1122,16 @@ class User
* @param string $lang The user's language (default is english) * @param string $lang The user's language (default is english)
* *
* @return bool True, if the user was created successfully * @return bool True, if the user was created successfully
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
* @throws \ErrorException * @throws ErrorException
* @throws \ImagickException * @throws ImagickException
*/ */
public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT) public static function createMinimal(string $name, string $email, string $nick, string $lang = L10n::DEFAULT)
{ {
if (empty($name) || if (empty($name) ||
empty($email) || empty($email) ||
empty($nick)) { empty($nick)) {
throw new InternalServerErrorException('Invalid arguments.'); throw new HTTPException\InternalServerErrorException('Invalid arguments.');
} }
$result = self::create([ $result = self::create([
@ -1190,7 +1194,7 @@ class User
* @param string $siteurl * @param string $siteurl
* @param string $password Plaintext password * @param string $password Plaintext password
* @return NULL|boolean from notification() and email() inherited * @return NULL|boolean from notification() and email() inherited
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
*/ */
public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password) public static function sendRegisterPendingEmail($user, $sitename, $siteurl, $password)
{ {
@ -1226,16 +1230,16 @@ class User
* *
* It's here as a function because the mail is sent from different parts * It's here as a function because the mail is sent from different parts
* *
* @param \Friendica\Core\L10n $l10n The used language * @param L10n $l10n The used language
* @param array $user User record array * @param array $user User record array
* @param string $sitename * @param string $sitename
* @param string $siteurl * @param string $siteurl
* @param string $password Plaintext password * @param string $password Plaintext password
* *
* @return NULL|boolean from notification() and email() inherited * @return NULL|boolean from notification() and email() inherited
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
*/ */
public static function sendRegisterOpenEmail(\Friendica\Core\L10n $l10n, $user, $sitename, $siteurl, $password) public static function sendRegisterOpenEmail(L10n $l10n, $user, $sitename, $siteurl, $password)
{ {
$preamble = Strings::deindent($l10n->t( $preamble = Strings::deindent($l10n->t(
' '
@ -1292,7 +1296,7 @@ class User
/** /**
* @param int $uid user to remove * @param int $uid user to remove
* @return bool * @return bool
* @throws InternalServerErrorException * @throws HTTPException\InternalServerErrorException
*/ */
public static function remove(int $uid) public static function remove(int $uid)
{ {

View File

@ -34,9 +34,13 @@
namespace Friendica\Util; namespace Friendica\Util;
use Friendica\Database\DBA; use Exception;
use Friendica\DI; use Friendica\App;
use Friendica\Core\Config\IConfig;
use Friendica\Core\PConfig\IPConfig;
use Friendica\Database\Database;
use Friendica\Model\User; use Friendica\Model\User;
use Friendica\Network\HTTPException;
class ExAuth class ExAuth
{ {
@ -44,12 +48,43 @@ class ExAuth
private $host; private $host;
/** /**
* Create the class * @var App\Mode
*
*/ */
public function __construct() private $appMode;
/**
* @var IConfig
*/
private $config;
/**
* @var IPConfig
*/
private $pConfig;
/**
* @var Database
*/
private $dba;
/**
* @var App\BaseURL
*/
private $baseURL;
/**
* @param App\Mode $appMode
* @param IConfig $config
* @param IPConfig $pConfig
* @param Database $dba
* @param App\BaseURL $baseURL
* @throws Exception
*/
public function __construct(App\Mode $appMode, IConfig $config, IPConfig $pConfig, Database $dba, App\BaseURL $baseURL)
{ {
$this->bDebug = (int) DI::config()->get('jabber', 'debug'); $this->appMode = $appMode;
$this->config = $config;
$this->pConfig = $pConfig;
$this->dba = $dba;
$this->baseURL = $baseURL;
$this->bDebug = (int)$config->get('jabber', 'debug');
openlog('auth_ejabberd', LOG_PID, LOG_USER); openlog('auth_ejabberd', LOG_PID, LOG_USER);
@ -60,14 +95,18 @@ class ExAuth
* Standard input reading function, executes the auth with the provided * Standard input reading function, executes the auth with the provided
* parameters * parameters
* *
* @return null * @throws HTTPException\InternalServerErrorException
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
public function readStdin() public function readStdin()
{ {
if (!$this->appMode->isNormal()) {
$this->writeLog(LOG_ERR, 'The node isn\'t ready.');
return;
}
while (!feof(STDIN)) { while (!feof(STDIN)) {
// Quit if the database connection went down // Quit if the database connection went down
if (!DBA::connected()) { if (!$this->dba->isConnected()) {
$this->writeLog(LOG_ERR, 'the database connection went down'); $this->writeLog(LOG_ERR, 'the database connection went down');
return; return;
} }
@ -123,7 +162,7 @@ class ExAuth
* Check if the given username exists * Check if the given username exists
* *
* @param array $aCommand The command array * @param array $aCommand The command array
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws HTTPException\InternalServerErrorException
*/ */
private function isUser(array $aCommand) private function isUser(array $aCommand)
{ {
@ -142,9 +181,9 @@ class ExAuth
$sUser = str_replace(['%20', '(a)'], [' ', '@'], $aCommand[1]); $sUser = str_replace(['%20', '(a)'], [' ', '@'], $aCommand[1]);
// Does the hostname match? So we try directly // Does the hostname match? So we try directly
if (DI::baseUrl()->getHostname() == $aCommand[2]) { if ($this->baseURL->getHostname() == $aCommand[2]) {
$this->writeLog(LOG_INFO, 'internal user check for ' . $sUser . '@' . $aCommand[2]); $this->writeLog(LOG_INFO, 'internal user check for ' . $sUser . '@' . $aCommand[2]);
$found = DBA::exists('user', ['nickname' => $sUser]); $found = $this->dba->exists('user', ['nickname' => $sUser]);
} else { } else {
$found = false; $found = false;
} }
@ -173,7 +212,7 @@ class ExAuth
* @param boolean $ssl Should the check be done via SSL? * @param boolean $ssl Should the check be done via SSL?
* *
* @return boolean Was the user found? * @return boolean Was the user found?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws HTTPException\InternalServerErrorException
*/ */
private function checkUser($host, $user, $ssl) private function checkUser($host, $user, $ssl)
{ {
@ -203,7 +242,7 @@ class ExAuth
* Authenticate the given user and password * Authenticate the given user and password
* *
* @param array $aCommand The command array * @param array $aCommand The command array
* @throws \Friendica\Network\HTTPException\InternalServerErrorException * @throws Exception
*/ */
private function auth(array $aCommand) private function auth(array $aCommand)
{ {
@ -221,35 +260,29 @@ class ExAuth
// We now check if the password match // We now check if the password match
$sUser = str_replace(['%20', '(a)'], [' ', '@'], $aCommand[1]); $sUser = str_replace(['%20', '(a)'], [' ', '@'], $aCommand[1]);
$Error = false;
// Does the hostname match? So we try directly // Does the hostname match? So we try directly
if (DI::baseUrl()->getHostname() == $aCommand[2]) { if ($this->baseURL->getHostname() == $aCommand[2]) {
$this->writeLog(LOG_INFO, 'internal auth for ' . $sUser . '@' . $aCommand[2]); try {
$this->writeLog(LOG_INFO, 'internal auth for ' . $sUser . '@' . $aCommand[2]);
$aUser = DBA::selectFirst('user', ['uid', 'password', 'legacy_password'], ['nickname' => $sUser]); User::getIdFromPasswordAuthentication($sUser, $aCommand[3], true);
if (DBA::isResult($aUser)) { } catch (HTTPException\ForbiddenException $ex) {
$uid = $aUser['uid']; // User exists, authentication failed
$success = User::authenticate($aUser, $aCommand[3], true);
$Error = $success === false;
} else {
$this->writeLog(LOG_WARNING, 'user not found: ' . $sUser);
$Error = true;
$uid = -1;
}
if ($Error) {
$this->writeLog(LOG_INFO, 'check against alternate password for ' . $sUser . '@' . $aCommand[2]); $this->writeLog(LOG_INFO, 'check against alternate password for ' . $sUser . '@' . $aCommand[2]);
$sPassword = DI::pConfig()->get($uid, 'xmpp', 'password', null, true); $aUser = User::getByNickname($sUser, ['uid']);
$sPassword = $this->pConfig->get($aUser['uid'], 'xmpp', 'password', null, true);
$Error = ($aCommand[3] != $sPassword); $Error = ($aCommand[3] != $sPassword);
} catch (\Throwable $ex) {
// User doesn't exist and any other failure case
$this->writeLog(LOG_WARNING, $ex->getMessage() . ': ' . $sUser);
$Error = true;
} }
} else { } else {
$Error = true; $Error = true;
} }
// If the hostnames doesn't match or there is some failure, we try to check remotely // If the hostnames doesn't match or there is some failure, we try to check remotely
if ($Error) { if ($Error && !$this->checkCredentials($aCommand[2], $aCommand[1], $aCommand[3], true)) {
$Error = !$this->checkCredentials($aCommand[2], $aCommand[1], $aCommand[3], true);
}
if ($Error) {
$this->writeLog(LOG_WARNING, 'authentification failed for user ' . $sUser . '@' . $aCommand[2]); $this->writeLog(LOG_WARNING, 'authentification failed for user ' . $sUser . '@' . $aCommand[2]);
fwrite(STDOUT, pack('nn', 2, 0)); fwrite(STDOUT, pack('nn', 2, 0));
} else { } else {
@ -297,7 +330,6 @@ class ExAuth
* Set the hostname for this process * Set the hostname for this process
* *
* @param string $host The hostname * @param string $host The hostname
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/ */
private function setHost($host) private function setHost($host)
{ {
@ -309,7 +341,7 @@ class ExAuth
$this->host = $host; $this->host = $host;
$lockpath = DI::config()->get('jabber', 'lockpath'); $lockpath = $this->config->get('jabber', 'lockpath');
if (is_null($lockpath)) { if (is_null($lockpath)) {
$this->writeLog(LOG_INFO, 'No lockpath defined.'); $this->writeLog(LOG_INFO, 'No lockpath defined.');
return; return;