espocrm/application/Espo/Core/Api/Auth.php

<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2020 Yuri Kuznetsov, Taras Machyshyn, Oleksiy 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\Api;

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

use Espo\Core\Authentication\{
    Authentication,
    Result,
};

use Espo\Core\{
    Api\Request,
    Api\Response,
};

use StdClass;
use Exception;

/**
 * Determines which auth method to use. Fetches a username and password from headers and server parameters.
 * Then tries to log in.
 */
class Auth
{
    protected $authentication;

    protected $authRequired;

    protected $isEntryPoint = false;

    private $isResolved = false;

    private $isResolvedUseNoAuth = false;

    public function __construct(Authentication $authentication, bool $authRequired = true)
    {
        $this->authentication = $authentication;
        $this->authRequired = $authRequired;
    }

    public static function createForEntryPoint(Authentication $authentication, bool $authRequired = true)
    {
        $instance = new Auth($authentication, $authRequired);
        $instance->isEntryPoint = true;
        return $instance;
    }

    public static function getBuilder() : AuthBuilder
    {
        return new AuthBuilder();
    }

    protected function resolve()
    {
        $this->isResolved = true;
    }

    protected function resolveUseNoAuth()
    {
        $this->resolve();
        $this->isResolvedUseNoAuth = true;
    }

    /**
     * Logged in succesfully.
     */
    public function isResolved() : bool
    {
        return $this->isResolved;
    }

    /**
     * No need to log in.
     */
    public function isResolvedUseNoAuth() : bool
    {
        return $this->isResolvedUseNoAuth;
    }

    public function process(Request $request, Response $response)
    {
        $httpMethod = $request->getMethod();

        $username = null;
        $password = null;

        $showDialog = $this->isEntryPoint;

        $authenticationMethod = null;

        if ($request->hasHeader('Espo-Authorization')) {
            list($username, $password) = $this->decodeAuthorizationString($request->getHeader('Espo-Authorization'));
        } else if ($request->hasHeader('X-Hmac-Authorization')) {
            $authenticationMethod = 'Hmac';
        } else if ($request->hasHeader('X-Api-Key')) {
            $authenticationMethod = 'ApiKey';
        } else if ($request->hasHeader('X-Auth-Method')) {
            $authenticationMethod = $request->getHeader('X-Auth-Method');
        }

        if (!$authenticationMethod) {
            if (!$username) {
                if ($request->getServerParam('PHP_AUTH_USER') && $request->getServerParam('PHP_AUTH_PW')) {
                    $username = $request->getServerParam('PHP_AUTH_USER');
                    $password = $request->getServerParam('PHP_AUTH_PW');
                }
            }

            if (!$username) {
                if ($request->getCookieParam('auth-username') && $request->getCookieParam('auth-token')) {
                    $username = $request->getCookieParam('auth-username');
                    $password = $request->getCookieParam('auth-token');
                }
            }

            if (!$username) {
                $cgiAuthString = $request->getHeader('Http-Espo-Cgi-Auth') ?? $request->getHeader('Redirect-Http-Espo-Cgi-Auth');
                if ($cgiAuthString) {
                    list($username, $password) = $this->decodeAuthorizationString(substr($cgiAuthString, 6));
                }
            }
        }

        $hasAuthData = $username || $authenticationMethod;

        if (!$this->authRequired) {
            if (!$this->isEntryPoint && $hasAuthData) {
                try {
                    $isAuthenticated = (bool) $this->authentication->login($username, $password, $request, $authenticationMethod);
                }
                catch (Exception $e) {
                    $this->processException($response, $e);

                    return;
                }

                if ($isAuthenticated) {
                    $this->resolve();

                    return;
                }
            }
            $this->resolveUseNoAuth();

            return;
        }

        if ($hasAuthData) {
            try {
                $authResult = $this->authentication->login($username, $password, $request, $authenticationMethod);
            }
            catch (Exception $e) {
                $this->processException($response, $e);
            }

            if ($authResult && ($authResult->isSuccess() || $authResult->isSecondStepRequired())) {
                $this->handleAuthResult($response, $authResult);
            } else {
                $this->processUnauthorized($response, $showDialog);
            }
        } else {
            if (!$this->isXMLHttpRequest($request)) {
                $showDialog = true;
            }

            $this->processUnauthorized($response, $showDialog);
        }
    }

    protected function decodeAuthorizationString(string $string) : array
    {
        $string = base64_decode($string);

        if (strpos($string, ':') === false) {
            throw new BadRequest("Auth: Bad authorization string provided.");
        }

        return explode(':', $string, 2);
    }

    protected function handleAuthResult(Response $response, Result $authResult)
    {
        $status = $authResult->getStatus();

        if ($authResult->isSuccess()) {
            $this->resolve();

            return;
        }

        if ($authResult->isSecondStepRequired()) {
            $response->setStatus(401);
            $response->setHeader('X-Status-Reason', 'second-step-required');

            $bodyData = [
                'status' => $authResult->getStatus(),
                'message' => $authResult->getMessage(),
                'view' => $authResult->getView(),
                'token' => $authResult->getToken(),
            ];

            $response->writeBody(json_encode($bodyData));
        }
    }

    protected function processException(Response $response, Exception $e)
    {
        if (
            $e instanceof BadRequest ||
            $e instanceof ServiceUnavailable ||
            $e instanceof BadRequest
        ) {
            $reason = $e->getMessage();

            if ($reason) {
                $response->setHeader('X-Status-Reason', $e->getMessage());
            }

            $response->setStatus($e->getCode());

            $GLOBALS['log']->notice("Auth: " . $e->getMessage());

            return;
        }

        $response->setStatus(500);

        $GLOBALS['log']->error("Auth: " . $e->getMessage());
    }

    protected function processUnauthorized(Response $response, bool $showDialog)
    {
        if ($showDialog) {
            $response->setHeader('WWW-Authenticate', 'Basic realm=""');
        }

        $response->setStatus(401);
    }

    protected function isXMLHttpRequest(Request $request)
    {
        if (strtolower($request->getHeader('X-Requested-With') ?? '') == 'xmlhttprequest') {
            return true;
        }

        return false;
    }
}