snapshot of https://github.com/espocrm/espocrm.git (master, 2026-09-18; blobs > 131072B omitted)

application/Espo/Tools/OAuthServer/League/Repositories/AccessTokenRepository.php

@@ -0,0 +1,124 @@
+<?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\Tools\OAuthServer\League\Repositories;
+
+use Espo\Core\Field\Link;
+use Espo\ORM\EntityManager;
+use Espo\Tools\OAuthServer\Entities\AccessToken;
+use Espo\Tools\OAuthServer\League\Entities\AccessTokenEntity;
+use Espo\Tools\OAuthServer\League\Entities\ClientEntity;
+use Espo\Tools\OAuthServer\Repository\AccessTokenRepository as Repository;
+use Espo\Tools\OAuthServer\Utils\IdentifierHasher;
+use InvalidArgumentException;
+use League\OAuth2\Server\Entities\AccessTokenEntityInterface;
+use League\OAuth2\Server\Entities\ClientEntityInterface;
+use League\OAuth2\Server\Entities\ScopeEntityInterface;
+use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
+use SensitiveParameter;
+
+class AccessTokenRepository implements AccessTokenRepositoryInterface
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private Repository $repository,
+        private IdentifierHasher $hasher,
+    ) {}
+
+    /**
+     * @param ScopeEntityInterface[] $scopes
+     */
+    public function getNewToken(
+        ClientEntityInterface $clientEntity,
+        array $scopes,
+        ?string $userIdentifier = null,
+    ): AccessTokenEntityInterface {
+
+        $entity = $this->entityManager->getRDBRepositoryByClass(AccessToken::class)->getNew();
+
+        /** @noinspection PhpConditionAlreadyCheckedInspection */
+        if (!$clientEntity instanceof ClientEntity) {
+            throw new InvalidArgumentException("Bad client.");
+        }
+
+        if (!$userIdentifier) {
+            throw new InvalidArgumentException('No user ID.');
+        }
+
+        $entity->setClient(Link::create($clientEntity->entityId));
+
+        $accessToken = new AccessTokenEntity($entity, $this->hasher);
+
+        foreach ($scopes as $scope) {
+            $accessToken->addScope($scope);
+        }
+
+        $accessToken->setUserIdentifier($userIdentifier);
+
+        return $accessToken;
+    }
+
+    public function persistNewAccessToken(AccessTokenEntityInterface $accessTokenEntity): void
+    {
+        /** @noinspection PhpConditionAlreadyCheckedInspection */
+        if (!$accessTokenEntity instanceof AccessTokenEntity) {
+            throw new InvalidArgumentException("Not supported access token entity.");
+        }
+
+        $this->entityManager->saveEntity($accessTokenEntity->getEntity());
+    }
+
+    public function revokeAccessToken(#[SensitiveParameter] string $tokenId): void
+    {
+        $entity = $this->repository->getActiveByIdentifier($tokenId);
+
+        if (!$entity || $entity->isRevoked()) {
+            return;
+        }
+
+        $entity->setRevoked();
+
+        $this->entityManager->saveEntity($entity);
+    }
+
+    /**
+     * Not existent or inactive token is treated as revoked intentionally.
+     */
+    public function isAccessTokenRevoked(#[SensitiveParameter] string $tokenId): bool
+    {
+        $entity = $this->repository->getActiveByIdentifier($tokenId);
+
+        if (!$entity) {
+            return true;
+        }
+
+        // Intentionally.
+        return !$entity->isActive();
+    }
+}

application/Espo/Tools/OAuthServer/League/Repositories/AuthCodeRepository.php

@@ -0,0 +1,119 @@
+<?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\Tools\OAuthServer\League\Repositories;
+
+use Espo\Core\Field\DateTime;
+use Espo\Core\Field\Link;
+use Espo\ORM\EntityManager;
+use Espo\Tools\OAuthServer\Entities\AuthorizationCode;
+use Espo\Tools\OAuthServer\League\Entities\AuthCodeEntity;
+use Espo\Tools\OAuthServer\Repository\AuthorizationCodeRepository;
+use Espo\Tools\OAuthServer\Repository\ClientRepository as ClientRepository;
+use Espo\Tools\OAuthServer\Utils\IdentifierHasher;
+use InvalidArgumentException;
+use League\OAuth2\Server\Entities\AuthCodeEntityInterface;
+use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;
+use RuntimeException;
+use SensitiveParameter;
+
+class AuthCodeRepository implements AuthCodeRepositoryInterface
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private AuthorizationCodeRepository $repository,
+        private ClientRepository $clientRepository,
+        private IdentifierHasher $hasher,
+    ) {}
+
+    public function getNewAuthCode(): AuthCodeEntity
+    {
+        return new AuthCodeEntity();
+    }
+
+    public function persistNewAuthCode(AuthCodeEntityInterface $authCodeEntity): void
+    {
+        $entity = $this->entityManager->getRDBRepositoryByClass(AuthorizationCode::class)->getNew();
+
+        $userId = $authCodeEntity->getUserIdentifier();
+
+        if (!is_string($userId)) {
+            throw new InvalidArgumentException("User ID must be string.");
+        }
+
+        $scopes = array_map(fn ($scope) => $scope->getIdentifier(), $authCodeEntity->getScopes());
+
+        $redirectUri = $authCodeEntity->getRedirectUri() ?? throw new InvalidArgumentException("No redirect URI");
+
+        $clientId = $authCodeEntity->getClient()->getIdentifier();
+
+        $client = $this->clientRepository->getActiveByIdentifier($clientId);
+
+        if (!$client) {
+            throw new RuntimeException("Client not found.");
+        }
+
+        $hash = $this->hasher->hash($authCodeEntity->getIdentifier());
+
+        $entity
+            ->setClient($client)
+            ->setHash($hash)
+            ->setUser(Link::create($userId))
+            ->setScopes($scopes)
+            ->setRedirectUri($redirectUri)
+            ->setExpiresAt(DateTime::fromDateTime($authCodeEntity->getExpiryDateTime()));
+
+        $this->entityManager->saveEntity($entity);
+    }
+
+    public function revokeAuthCode(#[SensitiveParameter] string $codeId): void
+    {
+        $code = $this->repository->getActiveByIdentifier($codeId);
+
+        if (!$code || $code->isRevoked()) {
+            return;
+        }
+
+        $code->setRevoked();
+
+        $this->entityManager->saveEntity($code);
+    }
+
+    public function isAuthCodeRevoked(#[SensitiveParameter] string $codeId): bool
+    {
+        $entity = $this->repository->getActiveByIdentifier($codeId);
+
+        if (!$entity) {
+            return true;
+        }
+
+        // Intentionally.
+        return !$entity->isActive();
+    }
+}

application/Espo/Tools/OAuthServer/League/Repositories/ClientRepository.php

@@ -0,0 +1,70 @@
+<?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\Tools\OAuthServer\League\Repositories;
+
+use Espo\Tools\OAuthServer\ClientValidator;
+use Espo\Tools\OAuthServer\League\Entities\ClientEntity;
+use Espo\Tools\OAuthServer\Repository\ClientRepository as Repository;
+use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
+use SensitiveParameter;
+
+class ClientRepository implements ClientRepositoryInterface
+{
+    public function __construct(
+        private Repository $repository,
+        private ClientValidator $clientValidator,
+    ) {}
+
+    public function getClientEntity(string $clientIdentifier): ?ClientEntity
+    {
+        $client = $this->repository->getActiveByIdentifier($clientIdentifier);
+
+        if (!$client) {
+            return null;
+        }
+
+        return ClientEntity::fromEntity($client);
+    }
+
+    public function validateClient(
+        string $clientIdentifier,
+        #[SensitiveParameter] ?string $clientSecret,
+        ?string $grantType,
+    ): bool {
+
+        $client = $this->repository->getActiveByIdentifier($clientIdentifier);
+
+        if (!$client) {
+            return false;
+        }
+
+        return $this->clientValidator->validate($client, $clientSecret);
+    }
+}

application/Espo/Tools/OAuthServer/League/Repositories/RefreshTokenRepository.php

@@ -0,0 +1,122 @@
+<?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\Tools\OAuthServer\League\Repositories;
+
+use Espo\Core\Field\DateTime;
+use Espo\Core\Field\Link;
+use Espo\ORM\EntityManager;
+use Espo\Tools\OAuthServer\Entities\RefreshToken;
+use Espo\Tools\OAuthServer\League\Entities\AccessTokenEntity;
+use Espo\Tools\OAuthServer\League\Entities\RefreshTokenEntity;
+use Espo\Tools\OAuthServer\Repository\ClientRepository as ClientRepositoryInternal;
+use Espo\Tools\OAuthServer\Repository\RefreshTokenRepository as RefreshTokenRepositoryInternal;
+use Espo\Tools\OAuthServer\Utils\IdentifierHasher;
+use InvalidArgumentException;
+use League\OAuth2\Server\Entities\RefreshTokenEntityInterface;
+use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
+use RuntimeException;
+use SensitiveParameter;
+
+class RefreshTokenRepository implements RefreshTokenRepositoryInterface
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private RefreshTokenRepositoryInternal $repository,
+        private ClientRepositoryInternal $clientRepository,
+        private IdentifierHasher $hasher,
+    ) {}
+
+    public function getNewRefreshToken(): RefreshTokenEntity
+    {
+        return new RefreshTokenEntity();
+    }
+
+    public function persistNewRefreshToken(RefreshTokenEntityInterface $refreshTokenEntity): void
+    {
+        $entity = $this->entityManager->getRDBRepositoryByClass(RefreshToken::class)->getNew();
+
+        $userId = $refreshTokenEntity->getAccessToken()->getUserIdentifier();
+
+        if (!is_string($userId)) {
+            throw new InvalidArgumentException("User ID must be string.");
+        }
+
+        $clientId = $refreshTokenEntity->getAccessToken()->getClient()->getIdentifier();
+
+        $client = $this->clientRepository->getActiveByIdentifier($clientId) ??
+            throw new RuntimeException("Client not found.");
+
+        $accessToken = $refreshTokenEntity->getAccessToken();
+
+        /** @noinspection PhpConditionAlreadyCheckedInspection */
+        if (!$accessToken instanceof AccessTokenEntity) {
+            throw new InvalidArgumentException("Not supported access token implementation.");
+        }
+
+        $hash = $this->hasher->hash($refreshTokenEntity->getIdentifier());
+
+        $entity
+            ->setClient($client)
+            ->setAccessToken($accessToken->getEntity())
+            ->setHash($hash)
+            ->setUser(Link::create($userId))
+            ->setExpiresAt(DateTime::fromDateTime($refreshTokenEntity->getExpiryDateTime()));
+
+        $this->entityManager->saveEntity($entity);
+    }
+
+    /**
+     * @todo Delay?
+     */
+    public function revokeRefreshToken(#[SensitiveParameter] string $tokenId): void
+    {
+        $token = $this->repository->getActiveByIdentifier($tokenId);
+
+        if (!$token || $token->isRevoked()) {
+            return;
+        }
+
+        $token->setRevoked();
+
+        $this->entityManager->saveEntity($token);
+    }
+
+    public function isRefreshTokenRevoked(#[SensitiveParameter] string $tokenId): bool
+    {
+        $entity = $this->repository->getActiveByIdentifier($tokenId);
+
+        if (!$entity) {
+            return true;
+        }
+
+        // Intentionally.
+        return !$entity->isActive();
+    }
+}

application/Espo/Tools/OAuthServer/League/Repositories/ScopeRepository.php

@@ -0,0 +1,82 @@
+<?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\Tools\OAuthServer\League\Repositories;
+
+use Espo\Tools\OAuthServer\League\Entities\ScopeEntity;
+use Espo\Tools\OAuthServer\Scope\UserAvailableScopesFilter;
+use Espo\Tools\OAuthServer\Scope\ScopeValidator;
+use League\OAuth2\Server\Entities\ClientEntityInterface;
+use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
+
+class ScopeRepository implements ScopeRepositoryInterface
+{
+    public function __construct(
+        private ScopeValidator $scopeValidator,
+        private UserAvailableScopesFilter $userAvailableScopesProvider,
+    ) {}
+
+    /**
+     * @param non-empty-string $identifier
+     */
+    public function getScopeEntityByIdentifier(string $identifier): ?ScopeEntity
+    {
+        if (!$this->scopeValidator->validate($identifier)) {
+            return null;
+        }
+
+        return new ScopeEntity($identifier);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function finalizeScopes(
+        array $scopes,
+        ?string $grantType,
+        ClientEntityInterface $clientEntity,
+        ?string $userIdentifier = null,
+        ?string $authCodeId = null,
+    ): array {
+
+        if (!$userIdentifier) {
+            return $scopes;
+        }
+
+        $ids = array_map(fn ($it) => $it->getIdentifier(), $scopes);
+
+        $availableIds = $this->userAvailableScopesProvider->filter($userIdentifier, $ids);
+
+        $scopes = array_filter($scopes, function ($scope) use ($availableIds) {
+            return in_array($scope->getIdentifier(), $availableIds);
+        });
+
+        return array_values($scopes);
+    }
+}