TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:09 +02:00
commit af8cc155b5
6818 changed files with 642608 additions and 0 deletions
@@ -0,0 +1,164 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Core\Http;
+
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\Cookie;
+use TYPO3\CMS\Core\Log\LogManager;
+use TYPO3\CMS\Core\Session\UserSession;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+/**
+ * Class that is used to apply a SetCookie to a response,
+ * based on the current (authenticated or stateful) session,
+ * in order to use the same session across multiple HTTP requests.
+ */
+class SetCookieService
+{
+    use CookieHeaderTrait;
+    use CookieScopeTrait;
+
+    protected readonly LoggerInterface $logger;
+
+    public static function create(string $name, string $type): self
+    {
+        $lifetime = (int)($GLOBALS['TYPO3_CONF_VARS'][$type]['lifetime'] ?? 0);
+        return new self($name, $type, $lifetime);
+    }
+
+    private function __construct(
+        protected readonly string $name,
+        protected readonly string $loginType,
+        /**
+         * Lifetime for the session-cookie (on the client)
+         *
+         * If >0: permanent cookie with given lifetime
+         * If 0: session-cookie
+         * Session-cookie means the browser will remove it when the browser is closed.
+         */
+        protected readonly int $lifetime
+    ) {
+        $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
+    }
+
+    /**
+     * Sets the session cookie for the current disposal.
+     */
+    public function setSessionCookie(UserSession $userSession, NormalizedParams $normalizedParams): ?Cookie
+    {
+        $setCookie = null;
+        $isRefreshTimeBasedCookie = $this->isRefreshTimeBasedCookie($userSession);
+        if ($this->isSetSessionCookie($userSession) || $isRefreshTimeBasedCookie) {
+            // Get the domain to be used for the cookie (if any):
+            $cookieScope = $this->getCookieScope($normalizedParams);
+            // If the cookie lifetime is set, use it:
+            $cookieExpire = $isRefreshTimeBasedCookie ? $GLOBALS['EXEC_TIME'] + $this->lifetime : 0;
+            // Valid options are "strict", "lax" or "none", whereas "none" only works in HTTPS requests (default & fallback is "strict")
+            $cookieSameSite = $this->sanitizeSameSiteCookieValue(
+                strtolower($GLOBALS['TYPO3_CONF_VARS'][$this->loginType]['cookieSameSite'] ?? Cookie::SAMESITE_STRICT)
+            );
+            // Use the secure option when the current request is served by a secure connection:
+            // SameSite "none" needs the secure option (only allowed on HTTPS)
+            $isSecure = $cookieSameSite === Cookie::SAMESITE_NONE || $normalizedParams->isHttps();
+            $sessionId = $userSession->getIdentifier();
+            $cookieValue = $userSession->getJwt($cookieScope);
+            $setCookie = new Cookie(
+                $this->name,
+                $cookieValue,
+                $cookieExpire,
+                $cookieScope->path,
+                // Host-Only cookies need to be provided without an explicit domain,
+                // see https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.2.3
+                // and https://datatracker.ietf.org/doc/html/rfc6265#section-5.3
+                // | * If the value of the Domain attribute is "example.com", the user agent will include the cookie
+                // |   in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com
+                // | * If the server omits the Domain attribute, the user agent will return the cookie only to the origin server.
+                $cookieScope->hostOnly ? null : $cookieScope->domain,
+                $isSecure,
+                true,
+                false,
+                $cookieSameSite
+            );
+            $message = $isRefreshTimeBasedCookie ? 'Updated Cookie: {session}, {domain}' : 'Set Cookie: {session}, {domain}';
+            $this->logger->debug($message, [
+                'session' => sha1($sessionId),
+                'domain' => $cookieScope->domain,
+            ]);
+        }
+        return $setCookie;
+    }
+
+    /**
+     * Determine whether a session cookie needs to be set (lifetime=0)
+     */
+    public function isSetSessionCookie(UserSession $userSession, bool $forceSetCookie = false): bool
+    {
+        if ($this->loginType === 'FE') {
+            return ($userSession->isNew() || $forceSetCookie)
+                && ($this->lifetime === 0 || !$userSession->isPermanent());
+        }
+        return $userSession->isNew() && $this->lifetime === 0;
+    }
+
+    /**
+     * Determine whether a non-session cookie needs to be set (lifetime>0)
+     *
+     * @internal
+     */
+    public function isRefreshTimeBasedCookie(UserSession $userSession): bool
+    {
+        if ($this->loginType === 'FE') {
+            return $this->lifetime > 0 && $userSession->isPermanent();
+        }
+        return $this->lifetime > 0;
+    }
+
+    /**
+     * Returns whether this request is going to set a cookie
+     * or a cookie was already found in the system
+     *
+     * @return bool Returns TRUE if a cookie is set
+     */
+    public function isCookieSet(?ServerRequestInterface $request, ?UserSession $userSession): bool
+    {
+        $isRefreshTimeBasedCookie = $userSession && $this->isRefreshTimeBasedCookie($userSession);
+        if ($isRefreshTimeBasedCookie || $this->isSetSessionCookie($userSession)) {
+            return true;
+        }
+        if ($request && isset($request->getCookieParams()[$this->name])) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Empty / unset the cookie
+     */
+    public function removeCookie(NormalizedParams $normalizedParams): Cookie
+    {
+        $scope = $this->getCookieScope($normalizedParams);
+        return new Cookie(
+            $this->name,
+            '',
+            -1,
+            $scope->path,
+            $scope->domain
+        );
+    }
+}