Creation of BackupCodeUsedEvent

scheb · Oct 6, 2024 · 49eb1f9 · 49eb1f9
1 parent 5d255b5
commit 49eb1f9
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 1 deletion.
diff --git a/doc/events.rst b/doc/events.rst
@@ -28,6 +28,13 @@ Constant: ``Scheb\TwoFactorBundle\Security\TwoFactor\Event\TwoFactorAuthenticati
 
 Is dispatched when two-factor authentication is attempted, right before checking the code.
 
+``scheb_two_factor.authentication.backup_code_used``
+-------------------------------------------
+
+Constant: ``Scheb\TwoFactorBundle\Security\TwoFactor\Event\TwoFactorAuthenticationEvents::BACKUP_CODE_USED``
+
+Is dispatched when two-factor authentication was successful with a backup-code.
+
 ``scheb_two_factor.authentication.success``
 -------------------------------------------
 

diff --git a/src/backup-code/Security/Http/EventListener/CheckBackupCodeListener.php b/src/backup-code/Security/Http/EventListener/CheckBackupCodeListener.php
@@ -4,9 +4,15 @@
 
 namespace Scheb\TwoFactorBundle\Security\Http\EventListener;
 
+use Scheb\TwoFactorBundle\Security\Authentication\Token\TwoFactorTokenInterface;
 use Scheb\TwoFactorBundle\Security\TwoFactor\Backup\BackupCodeManagerInterface;
+use Scheb\TwoFactorBundle\Security\TwoFactor\Event\TwoFactorAuthenticationEvent;
+use Scheb\TwoFactorBundle\Security\TwoFactor\Event\TwoFactorAuthenticationEvents;
 use Scheb\TwoFactorBundle\Security\TwoFactor\Provider\PreparationRecorderInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Http\Event\CheckPassportEvent;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * @final
@@ -20,6 +26,9 @@ class CheckBackupCodeListener extends AbstractCheckCodeListener
     public function __construct(
         PreparationRecorderInterface $preparationRecorder,
         private readonly BackupCodeManagerInterface $backupCodeManager,
+        private readonly TokenStorageInterface $tokenStorage,
+        private readonly RequestStack $requestStack,
+        private readonly EventDispatcherInterface $eventDispatcher,
     ) {
         parent::__construct($preparationRecorder);
     }
@@ -28,6 +37,16 @@ protected function isValidCode(string $providerName, object $user, string $code)
     {
         if ($this->backupCodeManager->isBackupCode($user, $code)) {
             $this->backupCodeManager->invalidateBackupCode($user, $code);
+            $token = $this->tokenStorage->getToken();
+            if (!($token instanceof TwoFactorTokenInterface)) {
+                return false;
+            }
+
+            $request = $this->requestStack->getCurrentRequest();
+            if ($request) {
+                $event = new TwoFactorAuthenticationEvent($request, $token);
+                $this->eventDispatcher->dispatch($event, TwoFactorAuthenticationEvents::BACKUP_CODE_USED);
+            }
 
             return true;
         }

diff --git a/src/bundle/Resources/config/backup_codes.php b/src/bundle/Resources/config/backup_codes.php
@@ -20,5 +20,8 @@
             ->args([
                 service('scheb_two_factor.provider_preparation_recorder'),
                 service('scheb_two_factor.backup_code_manager'),
+                service('security.token_storage'),
+                service('request_stack'),
+                service('event_dispatcher'),
             ]);
 };
diff --git a/src/bundle/Security/TwoFactor/Event/TwoFactorAuthenticationEvents.php b/src/bundle/Security/TwoFactor/Event/TwoFactorAuthenticationEvents.php
@@ -25,6 +25,11 @@ class TwoFactorAuthenticationEvents
      */
     public const ATTEMPT = 'scheb_two_factor.authentication.attempt';
 
+    /**
+     * When a backup-code is used.
+     */
+    public const BACKUP_CODE_USED = 'scheb_two_factor.authentication.backup_code_used';
+
     /**
      * When two-factor authentication was successful (code was valid) for a single provider.
      */

diff --git a/tests/Security/Http/EventListener/CheckBackupCodeListenerTest.php b/tests/Security/Http/EventListener/CheckBackupCodeListenerTest.php
@@ -7,20 +7,26 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use Scheb\TwoFactorBundle\Security\Http\EventListener\CheckBackupCodeListener;
 use Scheb\TwoFactorBundle\Security\TwoFactor\Backup\BackupCodeManagerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * @property CheckBackupCodeListener $listener
  */
 class CheckBackupCodeListenerTest extends AbstractCheckCodeListenerTestSetup
 {
     private MockObject|BackupCodeManagerInterface $backupCodeManager;
+    private MockObject|TokenStorageInterface $tokenStorage,
+    private MockObject|RequestStack $requestStack,
+    private MockObject|EventDispatcherInterface $eventDispatcher,
 
     protected function setUp(): void
     {
         parent::setUp();
 
         $this->backupCodeManager = $this->createMock(BackupCodeManagerInterface::class);
-        $this->listener = new CheckBackupCodeListener($this->preparationRecorder, $this->backupCodeManager);
+        $this->listener = new CheckBackupCodeListener($this->preparationRecorder, $this->backupCodeManager, $this->tokenStorage, $this->requestStack, $this->eventDispatecher);
     }
 
     protected function expectDoNothing(): void