OXDEV-9078 Add code generator and hasher

Author: Sieg

src/Authentication/TwoFactorAuth/OTP/Service/OtpCodeGeneratorService.php

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service;
+
+class OtpCodeGeneratorService implements OtpCodeGeneratorServiceInterface
+{
+    public function generateCode(): string
+    {
+        // todo-low: length from settings
+        $length = 6;
+
+        return str_pad((string) random_int(0, 999999), $length, '0', STR_PAD_LEFT);
+    }
+}

src/Authentication/TwoFactorAuth/OTP/Service/OtpCodeGeneratorServiceInterface.php

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

src/Authentication/TwoFactorAuth/OTP/Service/OtpCodeHasherService.php

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service;
+
+class OtpCodeHasherService implements OtpCodeHasherServiceInterface
+{
+    public function hash(#[\SensitiveParameter] string $code): string
+    {
+        return hash('sha256', $code);
+    }
+}

src/Authentication/TwoFactorAuth/OTP/Service/OtpCodeHasherServiceInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service;
+
+interface OtpCodeHasherServiceInterface
+{
+    public function hash(#[\SensitiveParameter] string $code): string;
+}

tests/Unit/Authentication/TwoFactorAuth/OTP/Service/OtpCodeGeneratorServiceTest.php

@@ -0,0 +1,53 @@
+<?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\OTP\Service;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service\OtpCodeGeneratorService;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service\OtpCodeGeneratorServiceInterface;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class OtpCodeGeneratorServiceTest extends TestCase
+{
+    #[Test]
+    public function generateReturnsNumericString(): void
+    {
+        $sut = $this->getSut();
+
+        $result = $sut->generateCode();
+
+        $this->assertMatchesRegularExpression('/^\d+$/', $result);
+    }
+
+    #[Test]
+    public function generateReturnsSpecificLengthCode(): void
+    {
+        $expectedLength = 6;
+
+        $sut = $this->getSut();
+
+        $result = $sut->generateCode();
+
+        $this->assertSame($expectedLength, strlen($result));
+    }
+
+    #[Test]
+    public function generateReturnsDifferentCodesOnSubsequentCalls(): void
+    {
+        $sut = $this->getSut();
+
+        $this->assertNotSame($sut->generateCode(), $sut->generateCode());
+    }
+
+    private function getSut(): OtpCodeGeneratorServiceInterface
+    {
+        return new OtpCodeGeneratorService();
+    }
+}

tests/Unit/Authentication/TwoFactorAuth/OTP/Service/OtpCodeHasherServiceTest.php

@@ -0,0 +1,50 @@
+<?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\OTP\Service;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service\OtpCodeHasherService;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Service\OtpCodeHasherServiceInterface;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class OtpCodeHasherServiceTest extends TestCase
+{
+    #[Test]
+    public function hashReturnsDifferentValueThanInput(): void
+    {
+        $sut = $this->getSut();
+
+        $result = $sut->hash(code: $code = uniqid());
+
+        $this->assertNotSame($code, $result);
+    }
+
+    #[Test]
+    public function hashReturnsSameResultForSameInput(): void
+    {
+        $sut = $this->getSut();
+        $code = uniqid();
+
+        $this->assertSame($sut->hash(code: $code), $sut->hash(code: $code));
+    }
+
+    #[Test]
+    public function hashReturnsDifferentResultForDifferentInput(): void
+    {
+        $sut = $this->getSut();
+
+        $this->assertNotSame($sut->hash(code: uniqid()), $sut->hash(code: uniqid()));
+    }
+
+    private function getSut(): OtpCodeHasherServiceInterface
+    {
+        return new OtpCodeHasherService();
+    }
+}