Initial commit

application/Espo/Tools/Api/Cors/DefaultHelper.php

@@ -0,0 +1,88 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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\Api\Cors;
+
+use Espo\Core\Utils\Config;
+use Psr\Http\Message\RequestInterface as Request;
+
+class DefaultHelper implements Helper
+{
+    public function __construct(private Config $config) {}
+
+    public function isCredentialsAllowed(Request $request): bool
+    {
+        return true;
+    }
+
+    public function getAllowedOrigin(Request $request): ?string
+    {
+        $origin = $request->getHeaderLine('Origin');
+
+        if (!$origin) {
+            return null;
+        }
+
+        return in_array($origin, $this->getAllowedOrigins()) ?
+            $origin :
+            null;
+    }
+
+    public function getAllowedMethods(Request $request): array
+    {
+        return $this->config->get('apiCorsAllowedMethodList') ?? [];
+    }
+
+    public function getAllowedHeaders(Request $request): array
+    {
+        if (!$request->hasHeader('Access-Control-Request-Headers')) {
+            return [];
+        }
+
+        return $this->config->get('apiCorsAllowedHeaderList') ?? [];
+    }
+
+    public function getSuccessStatus(): ?int
+    {
+        return null;
+    }
+
+    public function getMaxAge(): ?int
+    {
+        return $this->config->get('apiCorsMaxAge');
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getAllowedOrigins(): array
+    {
+        return $this->config->get('apiCorsAllowedOriginList') ?? [];
+    }
+}

application/Espo/Tools/Api/Cors/Helper.php

@@ -0,0 +1,53 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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\Api\Cors;
+
+use Psr\Http\Message\RequestInterface as Request;
+
+interface Helper
+{
+    public function isCredentialsAllowed(Request $request): bool;
+
+    public function getAllowedOrigin(Request $request): ?string;
+
+    /**
+     * @return string[]
+     */
+    public function getAllowedMethods(Request $request): array;
+
+    /**
+     * @return string[]
+     */
+    public function getAllowedHeaders(Request $request): array;
+
+    public function getSuccessStatus(): ?int;
+
+    public function getMaxAge(): ?int;
+}

application/Espo/Tools/Api/Cors/Middleware.php

@@ -0,0 +1,89 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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\Api\Cors;
+
+use Fig\Http\Message\RequestMethodInterface as RequestMethod;
+use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as ServerRequest;
+use Psr\Http\Server\MiddlewareInterface;
+use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
+use Slim\Psr7\Factory\ResponseFactory;
+
+class Middleware implements MiddlewareInterface
+{
+    private const DEFAULT_SUCCESS_STATUS = 204;
+    private const DEFAULT_MAX_AGE = 86400;
+
+    public function __construct(private Helper $helper)
+    {}
+
+    public function process(ServerRequest $request, RequestHandler $handler): Response
+    {
+        $isPreFlight = $request->getMethod() === RequestMethod::METHOD_OPTIONS;
+
+        $response = $isPreFlight ?
+            (new ResponseFactory)->createResponse() :
+            $handler->handle($request);
+
+        $allowedOrigin = $this->helper->getAllowedOrigin($request);
+
+        if (!$allowedOrigin) {
+            return $response;
+        }
+
+        $status = $this->helper->getSuccessStatus() ?? self::DEFAULT_SUCCESS_STATUS;
+        $allowedMethods = $this->helper->getAllowedMethods($request);
+        $allowedHeaders = $this->helper->getAllowedHeaders($request);
+        $maxAge = $this->helper->getMaxAge() ?? self::DEFAULT_MAX_AGE;
+        $credentialsAllowed = $this->helper->isCredentialsAllowed($request);
+
+        $response = $response
+            ->withHeader('Access-Control-Allow-Origin', $allowedOrigin)
+            ->withHeader('Access-Control-Max-Age', (string) $maxAge);
+
+        if ($credentialsAllowed) {
+            $response = $response->withHeader('Access-Control-Allow-Credentials', 'true');
+        }
+
+        if (!$isPreFlight) {
+            return $response;
+        }
+
+        if ($allowedMethods !== []) {
+            $response = $response->withHeader('Access-Control-Allow-Methods', implode(', ', $allowedMethods));
+        }
+
+        if ($allowedHeaders !== []) {
+            $response = $response->withHeader('Access-Control-Allow-Headers', implode(', ', $allowedHeaders));
+        }
+
+        return $response->withStatus($status);
+    }
+}