OXDEV-9078 Move settings to new settings interface

Sieg · Sieg · commit 5689118e14b0 · 2026-04-03T18:21:23.000+03:00
diff --git a/src/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactory.php b/src/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactory.php
@@ -10,13 +10,13 @@
 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;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
 
 class TwoFAServiceFactory implements TwoFAServiceFactoryInterface
 {
     public function __construct(
-        private ModuleSettingsServiceInterface $settings,
+        private TwoFASettingsInterface $settings,
         private array $implementations,
     ) {
     }
diff --git a/src/Authentication/TwoFactorAuth/Service/AuthorizeService.php b/src/Authentication/TwoFactorAuth/Service/AuthorizeService.php
@@ -11,13 +11,14 @@
 
 use OxidEsales\EshopCommunity\Internal\Framework\Session\SessionInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\UserRepositoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
 
 class AuthorizeService implements AuthorizeServiceInterface
 {
     public const USER_SESSION_KEY = 'pending_authorized_user';
 
     public function __construct(
-        private ModuleSettingsServiceInterface $moduleSettings,
+        private TwoFASettingsInterface $moduleSettings,
         private VerificationCollectorServiceInterface $verifyCollector,
         private NotifierCollectorInterface $notifierCollector,
         private ResendOTPServiceInterface $resendOTPService,
diff --git a/src/Authentication/TwoFactorAuth/Service/ModuleSettingsService.php b/src/Authentication/TwoFactorAuth/Service/ModuleSettingsService.php
diff --git a/src/Authentication/TwoFactorAuth/Service/ModuleSettingsServiceInterface.php b/src/Authentication/TwoFactorAuth/Service/ModuleSettingsServiceInterface.php
diff --git a/src/Authentication/TwoFactorAuth/Service/services.yaml b/src/Authentication/TwoFactorAuth/Service/services.yaml
@@ -8,10 +8,6 @@ services:
     bind:
       OxidEsales\Eshop\Core\Utils: '@=service("OxidEsales\\SecurityModule\\Core\\Registry").getUtils()'
 
-  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface:
-    class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsService
-    public: true
-
   OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\UserServiceInterface:
     class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\UserService
     public: true
diff --git a/src/Authentication/TwoFactorAuth/Settings/TwoFASettings.php b/src/Authentication/TwoFactorAuth/Settings/TwoFASettings.php
@@ -10,14 +10,33 @@
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings;
 
 use OxidEsales\Eshop\Core\Config;
+use OxidEsales\EshopCommunity\Internal\Framework\Module\Facade\ModuleSettingServiceInterface;
+use OxidEsales\SecurityModule\Core\Module;
 
 class TwoFASettings implements TwoFASettingsInterface
 {
+    public const ACTIVE = 'oeSecurityTwoFactorAuthEnabled';
+
+    public const TWO_FACTOR_TYPE = 'oeSecurityTwoFactorAuthType';
+
     public function __construct(
         private Config $config,
+        private ModuleSettingServiceInterface $moduleSettingService,
     ) {
     }
 
+    public function isTwoFactorAuthEnabled(): bool
+    {
+        return $this->moduleSettingService->getBoolean(self::ACTIVE, Module::MODULE_ID);
+    }
+
+    public function getTwoFactorAuthType(): string
+    {
+        return $this->moduleSettingService->getString(self::TWO_FACTOR_TYPE, Module::MODULE_ID)
+            ->trim()
+            ->toString();
+    }
+
     public function getVerificationUrl(): string
     {
         return $this->config->getShopHomeUrl() . 'cl=twofactorauth';
diff --git a/src/Authentication/TwoFactorAuth/Settings/TwoFASettingsInterface.php b/src/Authentication/TwoFactorAuth/Settings/TwoFASettingsInterface.php
@@ -11,5 +11,9 @@
 
 interface TwoFASettingsInterface
 {
+    public function isTwoFactorAuthEnabled(): bool;
+
+    public function getTwoFactorAuthType(): string;
+
     public function getVerificationUrl(): string;
 }
diff --git a/src/Authentication/TwoFactorAuth/Settings/services.yaml b/src/Authentication/TwoFactorAuth/Settings/services.yaml
@@ -5,3 +5,4 @@ services:
 
   OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface:
     class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettings
+    public: true
diff --git a/src/Shared/Model/User.php b/src/Shared/Model/User.php
@@ -13,12 +13,11 @@
 use OxidEsales\Eshop\Core\Exception\UserException;
 use OxidEsales\Eshop\Core\Registry;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAUserServiceInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
 use OxidEsales\SecurityModule\Captcha\Captcha\Image\Exception\CaptchaValidateException as ImageCaptchaException;
 use OxidEsales\SecurityModule\Captcha\Captcha\HoneyPot\Exception\CaptchaValidateException as HoneyPotCaptchaException;
 use OxidEsales\SecurityModule\Captcha\Service\CaptchaServiceInterface;
 use OxidEsales\SecurityModule\Captcha\Service\ModuleSettingsServiceInterface as CaptchaSettingsServiceInterface;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface
-    as TwoFASettingsServiceInterface;
 use OxidEsales\SecurityModule\Shared\Core\InputValidator;
 
 /**
@@ -91,7 +90,7 @@ protected function onLogin($userName, #[\SensitiveParameter] $password)
         parent::onLogin($userName, $password);
 
         $userId = $this->getId();
-        $settingsService = $this->getService(TwoFASettingsServiceInterface::class);
+        $settingsService = $this->getService(TwoFASettingsInterface::class);
         if ($userId && $settingsService->isTwoFactorAuthEnabled() && !$this->isAdmin()) {
             $twoFAUserService = $this->getService(TwoFAUserServiceInterface::class);
             if (!$twoFAUserService->isChallengeVerified($userId)) {
diff --git a/tests/Codeception/Acceptance/BaseCest.php b/tests/Codeception/Acceptance/BaseCest.php
@@ -11,11 +11,12 @@
 
 use Codeception\Util\Fixtures;
 use OxidEsales\EshopCommunity\Core\Di\ContainerFacade;
+use OxidEsales\EshopCommunity\Internal\Framework\Module\Facade\ModuleSettingServiceInterface;
 use OxidEsales\SecurityModule\Authentication\OAuth2\Service\ModuleSettingsServiceInterface
     as OAuthModuleSettingsServiceInterface;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface
-    as TwoFASettingsServiceInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettings;
 use OxidEsales\SecurityModule\Captcha\Service\ModuleSettingsServiceInterface as CaptchaSettingsServiceInterface;
+use OxidEsales\SecurityModule\Core\Module;
 use OxidEsales\SecurityModule\PasswordPolicy\Service\ModuleSettingsServiceInterface as PasswordSettingsServiceInterface;
 
 abstract class BaseCest
@@ -42,7 +43,11 @@ protected function setCaptchaState(bool $state)
 
     protected function setTwoFactorAuthState(bool $state)
     {
-        ContainerFacade::get(TwoFASettingsServiceInterface::class)->saveIsTwoFactorAuthEnabled($state);
+        ContainerFacade::get(ModuleSettingServiceInterface::class)->saveBoolean(
+            TwoFASettings::ACTIVE,
+            $state,
+            Module::MODULE_ID
+        );
     }
 
     protected function setProviderState(bool $state)
diff --git a/tests/Integration/Shared/Model/UserTest.php b/tests/Integration/Shared/Model/UserTest.php
@@ -20,7 +20,7 @@
 use DateTimeImmutable;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Infrastructure\Repository\OtpChallengeStateRepositoryInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\AuthorizeService;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsService;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettings;
 use OxidEsales\SecurityModule\Captcha\Service\ModuleSettingsServiceInterface as CaptchaSettingsServiceInterface;
 use OxidEsales\SecurityModule\Core\Module;
 use OxidEsales\SecurityModule\Tests\Integration\IntegrationTestCase;
@@ -212,9 +212,6 @@ public function testLoginWithOTPEnabledStoresUserIdInSession(): void
 
     public function testLoginWithVerifiedChallengeStateSkipsOTPRedirect(): void
     {
-        $this->disableCaptcha();
-        $this->enableTwoFactorAuth();
-
         $userId = $this->getOTPUserId();
 
         $stateRepo = $this->get(OtpChallengeStateRepositoryInterface::class);
@@ -260,12 +257,12 @@ private function enableTwoFactorAuth(): void
     {
         $moduleSettingService = ContainerFacade::get(ModuleSettingServiceInterface::class);
         $moduleSettingService->saveBoolean(
-            ModuleSettingsService::ACTIVE,
+            TwoFASettings::ACTIVE,
             true,
             Module::MODULE_ID
         );
         $moduleSettingService->saveString(
-            ModuleSettingsService::TWO_FACTOR_TYPE,
+            TwoFASettings::TWO_FACTOR_TYPE,
             'otp',
             Module::MODULE_ID
         );
@@ -275,7 +272,7 @@ private function disableTwoFactorAuth(): void
     {
         $moduleSettingService = ContainerFacade::get(ModuleSettingServiceInterface::class);
         $moduleSettingService->saveBoolean(
-            ModuleSettingsService::ACTIVE,
+            TwoFASettings::ACTIVE,
             false,
             Module::MODULE_ID
         );
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactoryTest.php b/tests/Unit/Authentication/TwoFactorAuth/Factory/TwoFAServiceFactoryTest.php
@@ -9,11 +9,11 @@
 
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Factory;
 
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AuthenticationTypeNotFoundException;
 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 OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
 use PHPUnit\Framework\TestCase;
 
 class TwoFAServiceFactoryTest extends TestCase
@@ -23,7 +23,7 @@ public function testCreateReturnsServiceMatchingConfiguredType(): void
         $otpServiceStub = $this->createStub(TwoFAServiceInterface::class);
         $totpServiceStub = $this->createStub(TwoFAServiceInterface::class);
 
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub->method('getTwoFactorAuthType')->willReturn('otp');
 
         $sut = $this->getSut(
@@ -36,7 +36,7 @@ public function testCreateReturnsServiceMatchingConfiguredType(): void
 
     public function testCreateThrowsForUnknownType(): void
     {
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub->method('getTwoFactorAuthType')->willReturn('unknown');
 
         $sut = $this->getSut(
@@ -48,11 +48,11 @@ public function testCreateThrowsForUnknownType(): void
     }
 
     private function getSut(
-        ModuleSettingsServiceInterface $settings = null,
+        TwoFASettingsInterface $settings = null,
         array $implementations = [],
     ): TwoFAServiceFactoryInterface {
         return new TwoFAServiceFactory(
-            settings: $settings ?? $this->createStub(ModuleSettingsServiceInterface::class),
+            settings: $settings ?? $this->createStub(TwoFASettingsInterface::class),
             implementations: $implementations,
         );
     }
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Service/AuthorizeServiceTest.php b/tests/Unit/Authentication/TwoFactorAuth/Service/AuthorizeServiceTest.php
@@ -16,8 +16,8 @@
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Provider\NotifierAdapterInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\UserRepositoryInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\AuthorizeService;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\NotifierCollectorInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ResendOTPServiceInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\VerificationCollectorServiceInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\Verificator\VerificatorAdapterInterface;
@@ -27,7 +27,7 @@ class AuthorizeServiceTest extends TestCase
 {
     public function testValidateThrowsWhenVerificatorNotFound(): void
     {
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub
             ->method('getTwoFactorAuthType')
             ->willReturn('unknown');
@@ -62,7 +62,7 @@ public function testValidateBubblesVerificatorException(): void
             ->method('validateCode')
             ->willThrowException($exception);
 
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub
             ->method('getTwoFactorAuthType')
             ->willReturn('otp');
@@ -99,7 +99,7 @@ public function testValidateWithValidCodeDoesNotThrow(): void
             ->method('validateCode')
             ->with($userId, $code);
 
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub
             ->method('getTwoFactorAuthType')
             ->willReturn('otp');
@@ -147,7 +147,7 @@ public function testGenerateNotifiesUser(): void
         $userRepositoryStub = $this->createStub(UserRepositoryInterface::class);
         $userRepositoryStub->method('getUserOTPData')->willReturn($userStub);
 
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub
             ->method('getTwoFactorAuthType')
             ->willReturn('otp');
@@ -194,7 +194,7 @@ public function testResendSendsOtpAndMarksAsSent(): void
         $userRepositoryStub = $this->createStub(UserRepositoryInterface::class);
         $userRepositoryStub->method('getUserOTPData')->willReturn($userStub);
 
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub->method('getTwoFactorAuthType')->willReturn('otp');
 
         $collectorStub = $this->createStub(VerificationCollectorServiceInterface::class);
@@ -256,7 +256,7 @@ public function testGetRemainingAttemptsReturnsValueFromVerificator(): void
             ->with($userId)
             ->willReturn($remainingAttempts);
 
-        $settingsStub = $this->createStub(ModuleSettingsServiceInterface::class);
+        $settingsStub = $this->createStub(TwoFASettingsInterface::class);
         $settingsStub
             ->method('getTwoFactorAuthType')
             ->willReturn('otp');
@@ -282,15 +282,15 @@ public function testGetRemainingAttemptsReturnsValueFromVerificator(): void
     }
 
     protected function getSut(
-        ModuleSettingsServiceInterface $moduleSettings = null,
+        TwoFASettingsInterface $moduleSettings = null,
         VerificationCollectorServiceInterface $verifyCollector = null,
         NotifierCollectorInterface $notifierCollector = null,
         ResendOTPServiceInterface $resendOTPService = null,
         UserRepositoryInterface $userRepository = null,
         SessionInterface $session = null
     ): AuthorizeService {
         return new AuthorizeService(
-            moduleSettings: $moduleSettings ?? $this->createStub(ModuleSettingsServiceInterface::class),
+            moduleSettings: $moduleSettings ?? $this->createStub(TwoFASettingsInterface::class),
             verifyCollector: $verifyCollector ?? $this->createStub(VerificationCollectorServiceInterface::class),
             notifierCollector: $notifierCollector ?? $this->createStub(NotifierCollectorInterface::class),
             resendOTPService: $resendOTPService ?? $this->createStub(ResendOTPServiceInterface::class),
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Service/ModuleSettingsServiceTest.php b/tests/Unit/Authentication/TwoFactorAuth/Service/ModuleSettingsServiceTest.php
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Service/ModuleSettingsTest.php b/tests/Unit/Authentication/TwoFactorAuth/Service/ModuleSettingsTest.php
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Settings/TwoFASettingsTest.php b/tests/Unit/Authentication/TwoFactorAuth/Settings/TwoFASettingsTest.php

Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@`
`10`	`10`	`namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Factory;`
`11`	`11`
`12`	`12`	`use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\AuthenticationTypeNotFoundException;`
`13`		`-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\ModuleSettingsServiceInterface;`
`14`	`13`	`use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface;`
	`14`	`+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;`
`15`	`15`
`16`	`16`	`class TwoFAServiceFactory implements TwoFAServiceFactoryInterface`
`17`	`17`	`{`
`18`	`18`	`public function __construct(`
`19`		`- private ModuleSettingsServiceInterface $settings,`
	`19`	`+ private TwoFASettingsInterface $settings,`
`20`	`20`	`private array $implementations,`
`21`	`21`	`) {`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,9 @@`
`11`	`11`
`12`	`12`	`interface TwoFASettingsInterface`
`13`	`13`	`{`
	`14`	`+ public function isTwoFactorAuthEnabled(): bool;`
	`15`	`+`
	`16`	`+ public function getTwoFactorAuthType(): string;`
	`17`	`+`
`14`	`18`	`public function getVerificationUrl(): string;`
`15`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,3 +5,4 @@ services:`
`5`	`5`
`6`	`6`	`OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface:`
`7`	`7`	`class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettings`
	`8`	`+ public: true`