Skip to content

EspoCRM – Open Source CRM Application

3.4 KB
Raw Blame
<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM – Open Source CRM application.
 * Copyright (C) 2014-2026 EspoCRM, Inc.
 * Website: https://www.espocrm.com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://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 Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace Espo\Core\Authentication\Helper;

use Espo\Core\Authentication\Logins\ApiKey;
use Espo\Core\Authentication\Logins\Hmac;
use Espo\ORM\EntityManager;
use Espo\Entities\User;
use Espo\ORM\Name\Attribute;

/**
 * @internal
 */
class UserFinder
{
    /** @var string[] */
    private const array FORBIDDEN_USER_TYPE_LIST = [
        User::TYPE_API,
        User::TYPE_SYSTEM,
    ];

    public function __construct(private EntityManager $entityManager)
    {}

    public function find(string $username): ?User
    {
        return $this->entityManager
            ->getRDBRepositoryByClass(User::class)
            ->where([
                User::FIELD_USER_NAME => $username,
                User::FIELD_TYPE . '!=' => self::FORBIDDEN_USER_TYPE_LIST,
            ])
            ->findOne();
    }

    public function findByAuthTokenData(string $username, string $id, ?int $passwordVersion): ?User
    {
        $where = [
            User::FIELD_USER_NAME => $username,
            Attribute::ID => $id,
            User::FIELD_TYPE . '!=' => self::FORBIDDEN_USER_TYPE_LIST,
        ];

        if ($passwordVersion !== null) {
            $where[User::FIELD_PASSWORD_VERSION] = $passwordVersion;
        }

        return $this->entityManager
            ->getRDBRepositoryByClass(User::class)
            ->where($where)
            ->findOne();
    }

    public function findApiHmac(string $apiKey): ?User
    {
        return $this->entityManager
            ->getRDBRepositoryByClass(User::class)
            ->where([
                User::FIELD_TYPE => User::TYPE_API,
                User::FIELD_API_KEY => $apiKey,
                User::FIELD_AUTH_METHOD => Hmac::NAME,
            ])
            ->findOne();
    }

    public function findApiApiKey(string $apiKey): ?User
    {
        return $this->entityManager
            ->getRDBRepositoryByClass(User::class)
            ->where([
                User::FIELD_TYPE => User::TYPE_API,
                User::FIELD_API_KEY => $apiKey,
                User::FIELD_AUTH_METHOD => ApiKey::NAME,
            ])
            ->findOne();
    }
}