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

application/Espo/Tools/OAuthServer/Utils/Crypt.php

@@ -0,0 +1,54 @@
+<?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\Utils;
+
+use Defuse\Crypto\Crypto;
+use Defuse\Crypto\Exception\EnvironmentIsBrokenException;
+use Defuse\Crypto\Exception\WrongKeyOrModifiedCiphertextException;
+use RuntimeException;
+use SensitiveParameter;
+
+class Crypt
+{
+    public function __construct(
+        private CryptKeyProvider $keyProvider,
+    ) {}
+
+    public function decrypt(#[SensitiveParameter] string $value): string
+    {
+        $key = $this->keyProvider->getCryptKey();
+
+        try {
+            return Crypto::decryptWithPassword($value, $key);
+        } catch (EnvironmentIsBrokenException|WrongKeyOrModifiedCiphertextException $e) {
+            throw new RuntimeException(previous: $e);
+        }
+    }
+}

application/Espo/Tools/OAuthServer/Utils/CryptKeyProvider.php

@@ -0,0 +1,65 @@
+<?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\Utils;
+
+use Espo\Core\Utils\Config;
+use Random\RandomException;
+use RuntimeException;
+
+class CryptKeyProvider
+{
+    private const string PARAM_CRYPT_KEY = 'oAuthServerCryptKey';
+
+    public function __construct(
+        private Config $config,
+        private Config\ConfigWriter $configWriter,
+    ) {}
+
+    public function getCryptKey(): string
+    {
+        if (!$this->config->has(self::PARAM_CRYPT_KEY)) {
+            $this->configWriter->set(self::PARAM_CRYPT_KEY, $this->generateKey());
+            $this->configWriter->save();
+        }
+
+        return $this->config->get(self::PARAM_CRYPT_KEY) ?? throw new RuntimeException("No crypt key.");
+    }
+
+    private function generateKey(): string
+    {
+        try {
+            $key = bin2hex(random_bytes(32));
+        } catch (RandomException $e) {
+            throw new RuntimeException(previous: $e);
+        }
+
+        return $key;
+    }
+}

application/Espo/Tools/OAuthServer/Utils/ErrorResponseComposer.php

@@ -0,0 +1,61 @@
+<?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\Utils;
+
+use Espo\Core\Api\Response;
+use Espo\Core\Api\ResponseComposer;
+
+class ErrorResponseComposer
+{
+    /**
+     * @param ?int<400, 499> $statusCode
+     */
+    public static function compose(
+        string $error,
+        string $errorDescription,
+        ?int $statusCode = null,
+    ): Response {
+
+        $header = "Bearer error=\"$error\", error_description=\"$errorDescription\"";
+
+        $response = ResponseComposer::json([
+            'error' => $error,
+            'error_description' => $errorDescription,
+        ]);
+
+        if ($statusCode) {
+            $response->setStatus($statusCode);
+        }
+
+        $response->setHeader('WWW-Authenticate', $header);
+
+        return $response;
+    }
+}

application/Espo/Tools/OAuthServer/Utils/IdentifierHasher.php

@@ -0,0 +1,40 @@
+<?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\Utils;
+
+use SensitiveParameter;
+
+class IdentifierHasher
+{
+    public function hash(#[SensitiveParameter] string $value): string
+    {
+        return hash('sha256', $value);
+    }
+}

application/Espo/Tools/OAuthServer/Utils/RefreshTokenDataExtractor.php

@@ -0,0 +1,66 @@
+<?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\Utils;
+
+use Espo\Core\Utils\Json;
+use Exception;
+use InvalidArgumentException;
+use JsonException;
+use SensitiveParameter;
+
+class RefreshTokenDataExtractor
+{
+    public function __construct(
+        private Crypt $crypt,
+    ) {}
+
+    public function extractIdentifier(#[SensitiveParameter] string $token): string
+    {
+        try {
+            $decrypted = $this->crypt->decrypt($token);
+        } catch (Exception) {
+            throw new InvalidArgumentException("Could not decrypt.");
+        }
+
+        try {
+            $tokenData = Json::decode($decrypted, true);
+        } catch (JsonException) {
+            throw new InvalidArgumentException("Could not JSON decode.");
+        }
+
+        $identifier = $tokenData['refresh_token_id'] ?? null;
+
+        if (!is_string($identifier)) {
+            throw new InvalidArgumentException("No identifier.");
+        }
+
+        return $identifier;
+    }
+}

application/Espo/Tools/OAuthServer/Utils/UriUtil.php

@@ -0,0 +1,43 @@
+<?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\Utils;
+
+/**
+ * @internal
+ */
+class UriUtil
+{
+    public static function makeRedirectUri(string $uri, string $state): string
+    {
+        $uri .= !str_contains($uri, '?') ? '?' : '&';
+
+        return $uri . http_build_query(['state' => $state]);
+    }
+}