Authentication.php

<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
 * Website: https://www.espocrm.com
 *
 * EspoCRM 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 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace Espo\Core\Authentication;

use Espo\Core\Exceptions\{
    Error,
    Forbidden,
    ServiceUnavailable,
};

use Espo\Entities\{
    Portal,
    User,
    AuthLogRecord,
    AuthToken,
};

use Espo\Core\Authentication\{
    Result,
    LoginFactory,
    TwoFactor\Factory as TwoFAFactory,
    AuthToken\AuthTokenManager,
    AuthToken\AuthTokenData,
};

use Espo\Core\{
    ApplicationUser,
    ApplicationState,
    Utils\Config,
    Utils\Metadata,
    ORM\EntityManagerProxy,
    Api\Request,
};

use StdClass;
use DateTime;

/**
 * Handles authentication. The entry point of the auth process.
 */
class Authentication
{
    const FAILED_ATTEMPTS_PERIOD = '60 seconds';

    const MAX_FAILED_ATTEMPT_NUMBER = 10;

    protected $allowAnyAccess;

    private $portal;

    protected $applicationUser;
    protected $applicationState;
    protected $config;
    protected $metadata;
    protected $entityManager;
    protected $authLoginFactory;
    protected $auth2FAFactory;

    public function __construct(
        ApplicationUser $applicationUser,
        ApplicationState $applicationState,
        Config $config,
        Metadata $metadata,
        EntityManagerProxy $entityManagerProxy,
        LoginFactory $authLoginFactory,
        TwoFAFactory $auth2FAFactory,
        AuthTokenManager $authTokenManager,
        bool $allowAnyAccess = false
    ) {
        $this->allowAnyAccess = $allowAnyAccess;

        $this->applicationUser = $applicationUser;
        $this->applicationState = $applicationState;
        $this->config = $config;
        $this->metadata = $metadata;
        $this->entityManager = $entityManagerProxy;
        $this->authLoginFactory = $authLoginFactory;
        $this->auth2FAFactory = $auth2FAFactory;
        $this->authTokenManager = $authTokenManager;
    }

    protected function getDefaultAuthenticationMethod()
    {
        return $this->config->get('authenticationMethod', 'Espo');
    }

    protected function setPortal(Portal $portal)
    {
        $this->portal = $portal;
    }

    protected function isPortal() : bool
    {
        return (bool) $this->portal || $this->applicationState->isPortal();
    }

    protected function getPortal() : Portal
    {
        if ($this->portal) {
            return $this->portal;
        }

        return $this->applicationState->getPortal();
    }

    /**
     * Process logging in.
     *
     * @return Result if success or second step required. NULL if failed.
     */
    public function login(
        ?string $username, ?string $password = null, Request $request, ?string $authenticationMethod = null
    ) : ?Result {
        $isByTokenOnly = false;

        if ($authenticationMethod) {
            if (!$this->metadata->get(['authenticationMethods', $authenticationMethod, 'api'])) {
                $GLOBALS['log']->warning(
                    "AUTH: Trying to use not allowed authentication method '{$authenticationMethod}'."
                );

                return null;
            }
        }

        if (!$authenticationMethod) {
            if ($request->getHeader('Espo-Authorization-By-Token') === 'true') {
                $isByTokenOnly = true;
            }
        }

        if (!$isByTokenOnly) {
            $this->checkFailedAttemptsLimit($request);
        }

        $authToken = null;
        $authTokenIsFound = false;

        if (!$authenticationMethod) {
            $authToken = $this->authTokenManager->get($password);

            if ($authToken && $authToken->getSecret()) {
                $sentSecret = $request->getCookieParam('auth-token-secret');

                if ($sentSecret !== $authToken->getSecret()) {
                    $authToken = null;
                }
            }
        }

        if ($authToken) {
            $authTokenIsFound = true;
        }

        if ($authToken && $authToken->isActive()) {
            if (!$this->allowAnyAccess) {
                if ($this->isPortal() && $authToken->getPortalId() !== $this->getPortal()->id) {
                    $GLOBALS['log']->info("AUTH: Trying to login to portal with a token not related to portal.");

                    return null;
                }

                if (!$this->isPortal() && $authToken->getPortalId()) {
                    $GLOBALS['log']->info("AUTH: Trying to login to crm with a token related to portal.");

                    return null;
                }
            }

            if ($this->allowAnyAccess) {
                if ($authToken->getPortalId() && !$this->isPortal()) {
                    $portal = $this->entityManager->getEntity('Portal', $authToken->getPortalId());

                    if ($portal) {
                        $this->setPortal($portal);
                    }
                }
            }
        } else {
            $authToken = null;
        }

        if ($isByTokenOnly && !$authToken) {
            if ($username) {
                $GLOBALS['log']->info("AUTH: Trying to login as user '{$username}' by token but token is not found.");
            }

            return null;
        }

        if (!$authenticationMethod) {
            $authenticationMethod = $this->getDefaultAuthenticationMethod();
        }

        $login = $this->authLoginFactory->create($authenticationMethod, $this->isPortal());

        $result = $login->login($username, $password, $authToken, $request);

        $user = $result->getUser();

        $authLogRecord = null;

        if (!$authTokenIsFound) {
            $authLogRecord = $this->createAuthLogRecord($username, $user, $request, $authenticationMethod);
        }

        if ($result->isFail() || !$user) {
            return null;
        }

        if (!$user->isAdmin() && $this->config->get('maintenanceMode')) {
            throw new ServiceUnavailable("Application is in maintenance mode.");
        }

        if (!$this->processUserCheck($user, $authLogRecord)) {
            return null;
        }

        if ($this->isPortal()) {
            $user->set('portalId', $this->getPortal()->id);
        }

        if (!$this->isPortal()) {
            $user->loadLinkMultipleField('teams');
        }

        $user->set('ipAddress', $request->getServerParam('REMOTE_ADDR') ?? null);

        $this->applicationUser->setUser($user);

        if (!$result->isSecondStepRequired() && !$authToken && $this->config->get('auth2FA')) {
            $result = $this->processTwoFactor($result, $request);

            if ($result->isFail()) {
                return null;
            }
        }

        if (!$result->isSecondStepRequired() && $request->getHeader('Espo-Authorization')) {
            if (!$authToken) {
                $authToken = $this->createAuthToken($user, $request);
            } else {
                $this->authTokenManager->renew($authToken);
            }

        	$user->set('token', $authToken->getToken());
            $user->set('authTokenId', $authToken->id ?? null);

            if ($authLogRecord) {
                $authLogRecord->set('authTokenId', $authToken->id ?? null);
            }
        }

        if ($authLogRecord) {
            $this->entityManager->saveEntity($authLogRecord);
        }

        if ($authToken && !$authLogRecord && isset($authToken->id)) {
            $authLogRecord = $this->entityManager
                ->getRepository('AuthLogRecord')
                ->select(['id'])
                ->where([
                    'authTokenId' => $authToken->id
                ])
                ->order('requestTime', true)
                ->findOne();
        }

        if ($authLogRecord) {
            $user->set('authLogRecordId', $authLogRecord->id);
        }

        return $result;
    }

    protected function processUserCheck(User $user, ?AuthLogRecord $authLogRecord) : bool
    {
        if (!$user->isActive()) {
            $GLOBALS['log']->info(
                "AUTH: Trying to login as user '".$user->get('userName')."' which is not active."
            );

            $this->logDenied($authLogRecord, 'INACTIVE_USER');

            return false;
        }

        if (!$user->isAdmin() && !$this->isPortal() && $user->isPortal()) {
            $GLOBALS['log']->info(
                "AUTH: Trying to login to crm as a portal user '".$user->get('userName')."'."
            );

            $this->logDenied($authLogRecord, 'IS_PORTAL_USER');

            return false;
        }

        if ($this->isPortal() && !$user->isPortal()) {
            $GLOBALS['log']->info(
                "AUTH: Trying to login to portal as user '".$user->get('userName')."' which is not portal user."
            );

            $this->logDenied($authLogRecord, 'IS_NOT_PORTAL_USER');

            return false;
        }

        if ($this->isPortal()) {
            $isPortalRelatedToUser = $this->entityManager
                ->getRepository('Portal')
                ->isRelated($this->getPortal(), 'users', $user);

            if (!$isPortalRelatedToUser) {
                $GLOBALS['log']->info(
                    "AUTH: Trying to login to portal as user '".$user->get('userName')."' ".
                    "which is portal user but does not belongs to portal."
                );

                $this->logDenied($authLogRecord, 'USER_IS_NOT_IN_PORTAL');

                return false;
            }
        }

        return true;
    }

    protected function processTwoFactor(Result $result, Request $request) : Result
    {
        $loggedUser = $result->getLoggedUser();

        $method = $this->getUser2FAMethod($loggedUser);

        if (!$method) {
            return $result;
        }

        $impl = $this->auth2FAFactory->create($method);

        $code = $request->getHeader('Espo-Authorization-Code');

        if ($code) {
            if (!$impl->verifyCode($loggedUser, $code)) {
                return Result::fail('Code not verified');
            }

            return $result;
        }

        return Result::secondStepRequired($result->getUser(), $impl->getLoginData($loggedUser));
    }

    protected function getUser2FAMethod(User $user) : ?string
    {
        $userData = $this->entityManager->getRepository('UserData')->getByUserId($user->id);

        if (!$userData) {
            return null;
        }

        if (!$userData->get('auth2FA')) {
            return null;
        }

        $method = $userData->get('auth2FAMethod');

        if (!$method) {
            return null;
        }

        if (
            !in_array(
                $method,
                $this->config->get('auth2FAMethodList', [])
            )
        ) {
            return null;
        }

        return $method;
    }

    protected function checkFailedAttemptsLimit(Request $request)
    {
        $failedAttemptsPeriod = $this->config->get('authFailedAttemptsPeriod', self::FAILED_ATTEMPTS_PERIOD);
        $maxFailedAttempts = $this->config->get('authMaxFailedAttemptNumber', self::MAX_FAILED_ATTEMPT_NUMBER);

        $requestTime = intval($request->getServerParam('REQUEST_TIME_FLOAT'));

        $requestTimeFrom = (new DateTime('@' . $requestTime))->modify('-' . $failedAttemptsPeriod);

        $failAttemptCount = 0;

        $ip = $request->getServerParam('REMOTE_ADDR');

        $where = [
            'requestTime>' => $requestTimeFrom->format('U'),
            'ipAddress' => $ip,
            'isDenied' => true,
        ];

        $wasFailed = (bool) $this->entityManager
            ->getRepository('AuthLogRecord')
            ->select(['id'])
            ->where($where)
            ->findOne();

        if ($wasFailed) {
            $failAttemptCount = $this->entityManager
                ->getRepository('AuthLogRecord')
                ->where($where)
                ->count();
        }

        if ($failAttemptCount > $maxFailedAttempts) {
            $GLOBALS['log']->warning(
                "AUTH: Max failed login attempts exceeded for IP '{$ip}'."
            );

            throw new Forbidden("Max failed login attempts exceeded.");
        }
    }

    protected function createAuthToken(User $user, Request $request) : AuthToken
    {
        $createSecret = $request->getHeader('Espo-Authorization-Create-Token-Secret') === 'true';

        if ($createSecret) {
            if ($this->config->get('authTokenSecretDisabled')) {
                $createSecret = false;
            }
        }

        $arrayData = [
            'hash' => $user->get('password'),
            'ipAddress' => $request->getServerParam('REMOTE_ADDR'),
            'userId' => $user->id,
            'portalId' => $this->isPortal() ? $this->getPortal()->id : null,
            'createSecret' => $createSecret,
        ];

        $authToken = $this->authTokenManager->create(
            AuthTokenData::create($arrayData)
        );

        if ($createSecret) {
            $this->setSecretInCookie($authToken->getSecret());
        }

        if ($this->config->get('authTokenPreventConcurrent')) {
            $concurrentAuthTokenList = $this->entityManager
                ->getRepository('AuthToken')
                ->select(['id'])
                ->where([
                    'userId' => $user->id,
                    'isActive' => true,
                ])
                ->find();

            foreach ($concurrentAuthTokenList as $concurrentAuthToken) {
                $concurrentAuthToken->set('isActive', false);

                $this->entityManager->saveEntity($concurrentAuthToken);
            }
        }

        return $authToken;
    }

    public function destroyAuthToken(string $token, Request $request)
    {
        $authToken = $this->authTokenManager->get($token);

        if (!$authToken) {
            return false;
        }

        $this->authTokenManager->inactivate($authToken);

        if ($authToken->getSecret()) {
            $sentSecret = $request->getCookieParam('auth-token-secret');

            if ($sentSecret === $authToken->getSecret()) {
                $this->setSecretInCookie(null);
            }
        }

        return true;
    }

    protected function createAuthLogRecord(
        ?string $username, ?User $user, Request $request, ?string $authenticationMethod = null
    ) : ?AuthLogRecord {
        if ($username === '**logout') {
            return null;
        }

        $authLogRecord = $this->entityManager->getEntity('AuthLogRecord');

        $requestUrl =
            $request->getUri()->getScheme() . '://' .
            $request->getUri()->getHost() .
            $request->getUri()->getPath();

        if (!$username && $user) {
            $username = $user->get('userName');
        }

        $authLogRecord->set([
            'username' => $username,
            'ipAddress' => $request->getServerParam('REMOTE_ADDR'),
            'requestTime' => $request->getServerParam('REQUEST_TIME_FLOAT'),
            'requestMethod' => $request->getMethod(),
            'requestUrl' => $requestUrl,
            'authenticationMethod' => $authenticationMethod,
        ]);

        if ($this->isPortal()) {
            $authLogRecord->set('portalId', $this->getPortal()->id);
        }

        if ($user) {
            $authLogRecord->set('userId', $user->id);
        } else {
            $authLogRecord->set('isDenied', true);
            $authLogRecord->set('denialReason', 'CREDENTIALS');

            $this->entityManager->saveEntity($authLogRecord);
        }

        return $authLogRecord;
    }

    protected function logDenied(?AuthLogRecord $authLogRecord, string $denialReason)
    {
        if (!$authLogRecord) {
            return;
        }

        $authLogRecord->set('denialReason', $denialReason);

        $this->entityManager->saveEntity($authLogRecord);
    }

    protected function setSecretInCookie(?string $secret)
    {
        if (!$secret) {
            $time = -1;
        } else {
            $time = strtotime('+1000 days');
        }

        if (version_compare(\PHP_VERSION, '7.3.0') < 0) {
            setcookie('auth-token-secret', $secret, $time, '/', '', false, true);

            return;
        }

        setcookie('auth-token-secret', $secret, [
            'expires' => $time,
            'path' => '/',
            'httponly' => true,
            'samesite' => 'Lax',
        ]);
    }
}