OXDEV-9078 Add a challenge state dto

Author: Sieg

src/Authentication/TwoFactorAuth/OTP/DTO/OtpChallengeState.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\DTO;
+
+use DateTimeImmutable;
+
+class OtpChallengeState implements OtpChallengeStateInterface
+{
+    public function __construct(
+        private string $userId,
+        private string $codeHash,
+        private int $attempts,
+        private ?DateTimeImmutable $lastSentAt,
+        private DateTimeImmutable $expiresAt,
+        private ?DateTimeImmutable $verifiedAt,
+    ) {
+    }
+
+    public function getUserId(): string
+    {
+        return $this->userId;
+    }
+
+    public function getCodeHash(): string
+    {
+        return $this->codeHash;
+    }
+
+    public function getAttempts(): int
+    {
+        return $this->attempts;
+    }
+
+    public function getLastSentAt(): ?DateTimeImmutable
+    {
+        return $this->lastSentAt;
+    }
+
+    public function getExpiresAt(): DateTimeImmutable
+    {
+        return $this->expiresAt;
+    }
+
+    public function getVerifiedAt(): ?DateTimeImmutable
+    {
+        return $this->verifiedAt;
+    }
+}

src/Authentication/TwoFactorAuth/OTP/DTO/OtpChallengeStateInterface.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\DTO;
+
+use DateTimeImmutable;
+
+interface OtpChallengeStateInterface
+{
+    public function getUserId(): string;
+
+    public function getCodeHash(): string;
+
+    public function getAttempts(): int;
+
+    public function getLastSentAt(): ?DateTimeImmutable;
+
+    public function getExpiresAt(): DateTimeImmutable;
+
+    public function getVerifiedAt(): ?DateTimeImmutable;
+}

tests/Unit/Authentication/TwoFactorAuth/OTP/DTO/OtpChallengeStateTest.php

@@ -0,0 +1,52 @@
+<?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\DTO;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\DTO\OtpChallengeState;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\DTO\OtpChallengeStateInterface;
+use PHPUnit\Framework\TestCase;
+
+class OtpChallengeStateTest extends TestCase
+{
+    public function testInitializeAndReadProperties(): void
+    {
+        $sut = new OtpChallengeState(
+            userId: $userId = uniqid(),
+            codeHash: $codeHash = uniqid(),
+            attempts: $attempts = rand(),
+            lastSentAt: $lastSentAt = new \DateTimeImmutable(),
+            expiresAt: $expiresAt = new \DateTimeImmutable(),
+            verifiedAt: $verifiedAt = new \DateTimeImmutable(),
+        );
+
+        $this->assertInstanceOf(OtpChallengeStateInterface::class, $sut);
+        $this->assertSame($userId, $sut->getUserId());
+        $this->assertSame($codeHash, $sut->getCodeHash());
+        $this->assertSame($attempts, $sut->getAttempts());
+        $this->assertSame($lastSentAt, $sut->getLastSentAt());
+        $this->assertSame($expiresAt, $sut->getExpiresAt());
+        $this->assertSame($verifiedAt, $sut->getVerifiedAt());
+    }
+
+    public function testLastSentAtAndVerifiedAtAreNullable(): void
+    {
+        $sut = new OtpChallengeState(
+            userId: uniqid(),
+            codeHash: uniqid(),
+            attempts: 0,
+            lastSentAt: null,
+            expiresAt: new \DateTimeImmutable(),
+            verifiedAt: null,
+        );
+
+        $this->assertNull($sut->getLastSentAt());
+        $this->assertNull($sut->getVerifiedAt());
+    }
+}