OXDEV-9078 Add TwoFactorAuthentication factory and register otp placeholder

Author: Sieg

src/Authentication/TwoFactorAuth/Exception/AuthenticationTypeNotFoundException.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception;
+
+class AuthenticationTypeNotFoundException extends \Exception
+{
+}

src/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AuthenticationTypeNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface;
+
+class TwoFAServiceFactory implements TwoFAServiceFactoryInterface
+{
+    public function __construct(
+        private ModuleSettingsServiceInterface $settings,
+        private array $implementations,
+    ) {
+    }
+
+    public function create(): TwoFAServiceInterface
+    {
+        $type = $this->settings->getTwoFactorAuthType();
+
+        return $this->implementations[$type] ?? throw new AuthenticationTypeNotFoundException();
+    }
+}

src/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactoryInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface;
+
+interface TwoFAServiceFactoryInterface
+{
+    public function create(): TwoFAServiceInterface;
+}

src/Authentication/TwoFactorAuth/Factory/services.yaml

@@ -0,0 +1,13 @@
+services:
+  _defaults:
+    autowire: true
+    public: false
+
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory\TwoFAServiceFactoryInterface:
+    class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory\TwoFAServiceFactory
+    arguments:
+      $implementations:
+        otp: '@OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\OTPService'
+
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface:
+    factory: ['@OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory\TwoFAServiceFactoryInterface', 'create']

src/Authentication/TwoFactorAuth/OTP/OTPService.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface;
+
+class OTPService implements TwoFAServiceInterface
+{
+    public function hasPendingChallenge(string $userId): bool
+    {
+    }
+
+    public function triggerChallenge(string $userId): void
+    {
+    }
+
+    public function clearChallenge(): void
+    {
+    }
+}

src/Authentication/TwoFactorAuth/OTP/services.yaml

@@ -0,0 +1,6 @@
+services:
+  _defaults:
+    autowire: true
+    public: false
+
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\OTPService: ~

src/Authentication/TwoFactorAuth/services.yaml

@@ -3,3 +3,5 @@ imports:
   - { resource: Service/services.yaml }
   - { resource: Transput/services.yaml }
   - { resource: Controller/services.yaml }
+  - { resource: Factory/services.yaml }
+  - { resource: OTP/services.yaml }

tests/Integration/ServiceAvailabilityTest.php

@@ -0,0 +1,46 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Integration;
+
+use OxidEsales\EshopCommunity\Internal\Container\ContainerBuilderFactory;
+use OxidEsales\EshopCommunity\Tests\Integration\IntegrationTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+final class ServiceAvailabilityTest extends IntegrationTestCase
+{
+    private static ContainerInterface $cachedContainer;
+
+    public static function setUpBeforeClass(): void
+    {
+        $containerBuilder = (new ContainerBuilderFactory())->create();
+        $container = $containerBuilder->getContainer();
+        foreach ($container->getDefinitions() as $definition) {
+            $definition->setPublic(true);
+        }
+        $container->compile(true);
+
+        self::$cachedContainer = $container;
+    }
+
+    #[DataProvider('serviceAvailabilityDataProvider')]
+    public function testServicesAvailable(string $serviceId): void
+    {
+        self::assertIsObject(self::$cachedContainer->get($serviceId));
+    }
+
+    public static function serviceAvailabilityDataProvider(): array
+    {
+        return [
+            [\OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory\TwoFAServiceFactoryInterface::class],
+            [\OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface::class],
+        ];
+    }
+}

tests/Unit/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactoryTest.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Factory;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory\TwoFAServiceFactory;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory\TwoFAServiceFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AuthenticationTypeNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface;
+use PHPUnit\Framework\TestCase;
+
+class TwoFAServiceFactoryTest extends TestCase
+{
+    public function testCreateReturnsServiceMatchingConfiguredType(): void
+    {
+        $otpServiceStub = $this->createStub(TwoFAServiceInterface::class);
+        $totpServiceStub = $this->createStub(TwoFAServiceInterface::class);
+
+        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub->method('getTwoFactorAuthType')->willReturn('otp');
+
+        $sut = $this->getSut(
+            settings: $settingsStub,
+            implementations: ['otp' => $otpServiceStub, 'totp' => $totpServiceStub],
+        );
+
+        $this->assertSame($otpServiceStub, $sut->create());
+    }
+
+    public function testCreateThrowsForUnknownType(): void
+    {
+        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub->method('getTwoFactorAuthType')->willReturn('unknown');
+
+        $sut = $this->getSut(
+            settings: $settingsStub,
+        );
+
+        $this->expectException(AuthenticationTypeNotFoundException::class);
+        $sut->create();
+    }
+
+    private function getSut(
+        ModuleSettingsServiceInterface $settings = null,
+        array $implementations = [],
+    ): TwoFAServiceFactoryInterface {
+        return new TwoFAServiceFactory(
+            settings: $settings ?? $this->createStub(ModuleSettingsServiceInterface::class),
+            implementations: $implementations,
+        );
+    }
+}