Added automatically CSRF protected authenticators

wouterj · wouterj · commit 6ba8ec647b26 · 2020-03-01T11:22:25.000+01:00
diff --git a/src/Symfony/Bundle/SecurityBundle/Resources/config/security_authenticators.xml b/src/Symfony/Bundle/SecurityBundle/Resources/config/security_authenticators.xml
@@ -64,6 +64,11 @@
             <argument /> <!-- stateless firewall keys -->
         </service>
 
+        <service id="Symfony\Component\Security\Http\EventListener\CsrfProtectionListener">
+            <tag name="kernel.event_subscriber" />
+            <argument type="service" id="security.csrf.token_manager" />
+        </service>
+
         <service id="security.listener.remember_me"
                  class="Symfony\Component\Security\Http\EventListener\RememberMeListener"
                  abstract="true">
diff --git a/src/Symfony/Component/Security/Http/Authenticator/CsrfProtectedAuthenticatorInterface.php b/src/Symfony/Component/Security/Http/Authenticator/CsrfProtectedAuthenticatorInterface.php
@@ -0,0 +1,34 @@
+<?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\Http\Authenticator;
+
+/**
+ * This interface can be implemented to automatically add CSF
+ * protection to the authenticator.
+ *
+ * @author Wouter de Jong <wouter@wouterj.nl>
+ */
+interface CsrfProtectedAuthenticatorInterface
+{
+    /**
+     * An arbitrary string used to generate the value of the CSRF token.
+     * Using a different string for each authenticator improves its security.
+     */
+    public function getCsrfTokenId(): string;
+
+    /**
+     * Returns the CSRF token contained in credentials if any.
+     *
+     * @param mixed $credentials The credentials returned by getCredentials()
+     */
+    public function getCsrfToken($credentials): ?string;
+}
diff --git a/src/Symfony/Component/Security/Http/Authenticator/FormLoginAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/FormLoginAuthenticator.php
@@ -32,7 +32,7 @@
  * @final
  * @experimental in 5.1
  */
-class FormLoginAuthenticator extends AbstractFormLoginAuthenticator implements PasswordAuthenticatedInterface
+class FormLoginAuthenticator extends AbstractFormLoginAuthenticator implements PasswordAuthenticatedInterface, CsrfProtectedAuthenticatorInterface
 {
     use TargetPathTrait;
 
@@ -113,17 +113,15 @@ public function getUser($credentials): ?UserInterface
         return $this->userProvider->loadUserByUsername($credentials['username']);
     }
 
-    /* @todo How to do CSRF protection?
-    public function checkCredentials($credentials, UserInterface $user): bool
+    public function getCsrfTokenId(): string
     {
-        if (null !== $this->csrfTokenManager) {
-            if (false === $this->csrfTokenManager->isTokenValid(new CsrfToken($this->options['csrf_token_id'], $credentials['csrf_token']))) {
-                throw new InvalidCsrfTokenException('Invalid CSRF token.');
-            }
-        }
+        return $this->options['csrf_token_id'];
+    }
 
-        return $this->checkPassword($credentials, $user);
-    }*/
+    public function getCsrfToken($credentials): ?string
+    {
+        return $credentials['csrf_token'];
+    }
 
     public function createAuthenticatedToken(UserInterface $user, $providerKey): TokenInterface
     {
diff --git a/src/Symfony/Component/Security/Http/EventListener/CsrfProtectionListener.php b/src/Symfony/Component/Security/Http/EventListener/CsrfProtectionListener.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\Http\EventListener;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;
+use Symfony\Component\Security\Csrf\CsrfToken;
+use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
+use Symfony\Component\Security\Http\Authenticator\CsrfProtectedAuthenticatorInterface;
+use Symfony\Component\Security\Http\Event\VerifyAuthenticatorCredentialsEvent;
+
+class CsrfProtectionListener implements EventSubscriberInterface
+{
+    private $csrfTokenManager;
+
+    public function __construct(CsrfTokenManagerInterface $csrfTokenManager)
+    {
+        $this->csrfTokenManager = $csrfTokenManager;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [VerifyAuthenticatorCredentialsEvent::class => ['verifyCredentials', 256]];
+    }
+
+    public function verifyCredentials(VerifyAuthenticatorCredentialsEvent $event): void
+    {
+        $authenticator = $event->getAuthenticator();
+        if (!$authenticator instanceof CsrfProtectedAuthenticatorInterface) {
+            return;
+        }
+
+        $csrfToken = new CsrfToken($authenticator->getCsrfTokenId(), $authenticator->getCsrfToken($event->getPreAuthenticatedToken()->getCredentials()));
+        if (false === $this->csrfTokenManager->isTokenValid($csrfToken)) {
+            throw new InvalidCsrfTokenException('Invalid CSRF token.');
+        }
+    }
+}
