N°8771 - Add Symfony form component to iTop core (#760)

- Add Symfony Form Component
- Add Symfony CSRF security component
- Add iTop default form template
- Add Twig debug extension to Twig Environment
- Add iTop abstract controller facility to get form builder
- Add Twig filter to make trans an alias of dict_s filter

lib/symfony/security-csrf/TokenStorage/ClearableTokenStorageInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Csrf\TokenStorage;
+
+/**
+ * @author Christian Flothmann <christian.flothmann@sensiolabs.de>
+ */
+interface ClearableTokenStorageInterface extends TokenStorageInterface
+{
+    /**
+     * Removes all CSRF tokens.
+     *
+     * @return void
+     */
+    public function clear();
+}

lib/symfony/security-csrf/TokenStorage/NativeSessionTokenStorage.php

@@ -0,0 +1,112 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Csrf\TokenStorage;
+
+use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;
+
+/**
+ * Token storage that uses PHP's native session handling.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+class NativeSessionTokenStorage implements ClearableTokenStorageInterface
+{
+    /**
+     * The namespace used to store values in the session.
+     */
+    public const SESSION_NAMESPACE = '_csrf';
+
+    private bool $sessionStarted = false;
+    private string $namespace;
+
+    /**
+     * Initializes the storage with a session namespace.
+     *
+     * @param string $namespace The namespace under which the token is stored in the session
+     */
+    public function __construct(string $namespace = self::SESSION_NAMESPACE)
+    {
+        $this->namespace = $namespace;
+    }
+
+    public function getToken(string $tokenId): string
+    {
+        if (!$this->sessionStarted) {
+            $this->startSession();
+        }
+
+        if (!isset($_SESSION[$this->namespace][$tokenId])) {
+            throw new TokenNotFoundException('The CSRF token with ID '.$tokenId.' does not exist.');
+        }
+
+        return (string) $_SESSION[$this->namespace][$tokenId];
+    }
+
+    /**
+     * @return void
+     */
+    public function setToken(string $tokenId, #[\SensitiveParameter] string $token)
+    {
+        if (!$this->sessionStarted) {
+            $this->startSession();
+        }
+
+        $_SESSION[$this->namespace][$tokenId] = $token;
+    }
+
+    public function hasToken(string $tokenId): bool
+    {
+        if (!$this->sessionStarted) {
+            $this->startSession();
+        }
+
+        return isset($_SESSION[$this->namespace][$tokenId]);
+    }
+
+    public function removeToken(string $tokenId): ?string
+    {
+        if (!$this->sessionStarted) {
+            $this->startSession();
+        }
+
+        if (!isset($_SESSION[$this->namespace][$tokenId])) {
+            return null;
+        }
+
+        $token = (string) $_SESSION[$this->namespace][$tokenId];
+
+        unset($_SESSION[$this->namespace][$tokenId]);
+
+        if (!$_SESSION[$this->namespace]) {
+            unset($_SESSION[$this->namespace]);
+        }
+
+        return $token;
+    }
+
+    /**
+     * @return void
+     */
+    public function clear()
+    {
+        unset($_SESSION[$this->namespace]);
+    }
+
+    private function startSession(): void
+    {
+        if (\PHP_SESSION_NONE === session_status()) {
+            session_start();
+        }
+
+        $this->sessionStarted = true;
+    }
+}

lib/symfony/security-csrf/TokenStorage/SessionTokenStorage.php

@@ -0,0 +1,112 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Csrf\TokenStorage;
+
+use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
+use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;
+
+/**
+ * Token storage that uses a Symfony Session object.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+class SessionTokenStorage implements ClearableTokenStorageInterface
+{
+    /**
+     * The namespace used to store values in the session.
+     */
+    public const SESSION_NAMESPACE = '_csrf';
+
+    private RequestStack $requestStack;
+    private string $namespace;
+
+    /**
+     * Initializes the storage with a RequestStack object and a session namespace.
+     *
+     * @param string $namespace The namespace under which the token is stored in the requestStack
+     */
+    public function __construct(RequestStack $requestStack, string $namespace = self::SESSION_NAMESPACE)
+    {
+        $this->requestStack = $requestStack;
+        $this->namespace = $namespace;
+    }
+
+    public function getToken(string $tokenId): string
+    {
+        $session = $this->getSession();
+        if (!$session->isStarted()) {
+            $session->start();
+        }
+
+        if (!$session->has($this->namespace.'/'.$tokenId)) {
+            throw new TokenNotFoundException('The CSRF token with ID '.$tokenId.' does not exist.');
+        }
+
+        return (string) $session->get($this->namespace.'/'.$tokenId);
+    }
+
+    /**
+     * @return void
+     */
+    public function setToken(string $tokenId, #[\SensitiveParameter] string $token)
+    {
+        $session = $this->getSession();
+        if (!$session->isStarted()) {
+            $session->start();
+        }
+
+        $session->set($this->namespace.'/'.$tokenId, $token);
+    }
+
+    public function hasToken(string $tokenId): bool
+    {
+        $session = $this->getSession();
+        if (!$session->isStarted()) {
+            $session->start();
+        }
+
+        return $session->has($this->namespace.'/'.$tokenId);
+    }
+
+    public function removeToken(string $tokenId): ?string
+    {
+        $session = $this->getSession();
+        if (!$session->isStarted()) {
+            $session->start();
+        }
+
+        return $session->remove($this->namespace.'/'.$tokenId);
+    }
+
+    /**
+     * @return void
+     */
+    public function clear()
+    {
+        $session = $this->getSession();
+        foreach (array_keys($session->all()) as $key) {
+            if (str_starts_with($key, $this->namespace.'/')) {
+                $session->remove($key);
+            }
+        }
+    }
+
+    /**
+     * @throws SessionNotFoundException
+     */
+    private function getSession(): SessionInterface
+    {
+        return $this->requestStack->getSession();
+    }
+}

lib/symfony/security-csrf/TokenStorage/TokenStorageInterface.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Csrf\TokenStorage;
+
+/**
+ * Stores CSRF tokens.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+interface TokenStorageInterface
+{
+    /**
+     * Reads a stored CSRF token.
+     *
+     * @throws \Symfony\Component\Security\Csrf\Exception\TokenNotFoundException If the token ID does not exist
+     */
+    public function getToken(string $tokenId): string;
+
+    /**
+     * Stores a CSRF token.
+     *
+     * @return void
+     */
+    public function setToken(string $tokenId, #[\SensitiveParameter] string $token);
+
+    /**
+     * Removes a CSRF token.
+     *
+     * @return string|null Returns the removed token if one existed, NULL
+     *                     otherwise
+     */
+    public function removeToken(string $tokenId): ?string;
+
+    /**
+     * Checks whether a token with the given token ID exists.
+     */
+    public function hasToken(string $tokenId): bool;
+}