added setRawSecret() and getRawSecret() methods

Author: codemasher

src/Authenticator.php

@@ -74,7 +74,7 @@ public function setOptions(SettingsContainerInterface|AuthenticatorOptions|itera
 	}
 
 	/**
-	 * Sets a secret phrase from a Base32 representation
+	 * Sets a secret phrase from an encoded representation
 	 *
 	 * @codeCoverageIgnore
 	 */
@@ -85,14 +85,34 @@ public function setSecret(#[SensitiveParameter] string $encodedSecret):static{
 	}
 
 	/**
-	 * Returns a Base32 representation of the current secret phrase
+	 * Sets a secret phrase from a a raw binary representation
+	 *
+	 * @codeCoverageIgnore
+	 */
+	public function setRawSecret(#[SensitiveParameter] string $rawSecret):static{
+		$this->authenticator->setRawSecret($rawSecret);
+
+		return $this;
+	}
+
+	/**
+	 * Returns an encoded representation of the current secret phrase
 	 *
 	 * @codeCoverageIgnore
 	 */
 	public function getSecret():string{
 		return $this->authenticator->getSecret();
 	}
 
+	/**
+	 * Returns the raw representation of the current secret phrase
+	 *
+	 * @codeCoverageIgnore
+	 */
+	public function getRawSecret():string{
+		return $this->authenticator->getRawSecret();
+	}
+
 	/**
 	 * Generates a new (secure random) secret phrase
 	 *

src/Authenticators/AuthenticatorAbstract.php

@@ -59,6 +59,17 @@ public function setSecret(#[SensitiveParameter] string $encodedSecret):static{
 		return $this;
 	}
 
+	public function setRawSecret(#[SensitiveParameter] string $rawSecret):static{
+
+		if($rawSecret === ''){
+			throw new InvalidArgumentException('The given secret string is empty');
+		}
+
+		$this->secret = $rawSecret;
+
+		return $this;
+	}
+
 	public function getSecret():string{
 
 		if($this->secret === null){
@@ -68,6 +79,16 @@ public function getSecret():string{
 		return Base32::encode($this->secret);
 	}
 
+	public function getRawSecret():string{
+
+		if($this->secret === null){
+			throw new RuntimeException('No secret set');
+		}
+
+		return $this->secret;
+	}
+
+
 	public function createSecret(int|null $length = null):string{
 		$length ??= $this->options->secret_length;
 

src/Authenticators/AuthenticatorInterface.php

@@ -55,13 +55,27 @@ public function setOptions(SettingsContainerInterface $options):static;
 	 */
 	public function setSecret(#[SensitiveParameter] string $encodedSecret):static;
 
+	/**
+	 * Sets a secret phrase from a a raw binary representation
+	 *
+	 * @throws \RuntimeException
+	 */
+	public function setRawSecret(#[SensitiveParameter] string $rawSecret):static;
+
 	/**
 	 * Returns an encoded representation of the current secret phrase
 	 *
 	 * @throws \RuntimeException
 	 */
 	public function getSecret():string;
 
+	/**
+	 * Returns the raw representation of the current secret phrase
+	 *
+	 * @throws \RuntimeException
+	 */
+	public function getRawSecret():string;
+
 	/**
 	 * Generates a new (secure random) secret phrase
 	 *

tests/Authenticators/AuthenticatorInterfaceTestAbstract.php

@@ -47,6 +47,16 @@ public function setGetSecret():void{
 		$this::assertSame($this::rawsecret, Base32::decode($secret));
 	}
 
+	#[Test]
+	public function setGetRawSecret():void{
+		$this->authenticatorInterface->setRawSecret($this::rawsecret);
+
+		$secret = $this->authenticatorInterface->getRawSecret();
+
+		$this::assertSame($this::secret, Base32::encode($secret));
+		$this::assertSame($this::rawsecret, $secret);
+	}
+
 	#[Test]
 	public function setEmptySecretException():void{
 		$this->expectException(InvalidArgumentException::class);
@@ -55,6 +65,14 @@ public function setEmptySecretException():void{
 		$this->authenticatorInterface->setSecret('');
 	}
 
+	#[Test]
+	public function setEmptyRawSecretException():void{
+		$this->expectException(InvalidArgumentException::class);
+		$this->expectExceptionMessage('The given secret string is empty');
+
+		$this->authenticatorInterface->setRawSecret('');
+	}
+
 	#[Test]
 	public function setInvalidSecretException():void{
 		$this->expectException(InvalidArgumentException::class);
@@ -70,6 +88,14 @@ public function getSecretException():void{
 		$this->authenticatorInterface->getSecret();
 	}
 
+	#[Test]
+	public function getRawSecretException():void{
+		$this->expectException(RuntimeException::class);
+		$this->expectExceptionMessage('No secret set');
+
+		$this->authenticatorInterface->getRawSecret();
+	}
+
 	#[Test]
 	public function createSecretDefaultLength():void{
 		$this::assertSame(

tests/Authenticators/SteamGuardTest.php

@@ -26,8 +26,12 @@ class SteamGuardTest extends AuthenticatorInterfaceTestAbstract{
 
 	protected const secret  = 'MTIzNDU2Nzg5MDEyMzQ1Njc4OTA=';
 
+	/**
+	 * Timestamps and -slices from the RFC6238 page, codes from a verified implementation
+	 *
+	 * @see https://tools.ietf.org/html/rfc6238#page-14
+	 */
 	protected const SteamGuardVectors = [
-		// timestamps and time slices from RFC 6238, see https://tools.ietf.org/html/rfc6238#page-14
 		[         59,        '1', 'PV9M4'],
 		[ 1111111109,  '23523ec', 'PY4YB'],
 		[ 1111111111,  '23523ed', '5PP3V'],
@@ -51,6 +55,16 @@ public function setGetSecret():void{
 		$this::assertSame($this::rawsecret, Base64::decode($secret));
 	}
 
+	#[Test]
+	public function setGetRawSecret():void{
+		$this->authenticatorInterface->setRawSecret($this::rawsecret);
+
+		$secret = $this->authenticatorInterface->getRawSecret();
+
+		$this::assertSame($this::secret, Base64::encode($secret));
+		$this::assertSame($this::rawsecret, $secret);
+	}
+
 	#[Test]
 	public function createSecretDefaultLength():void{
 		$this::assertSame(
@@ -77,11 +91,6 @@ public function createSecretCheckCharacterSet():void{
 		$this::assertMatchesRegularExpression('#^['.Base64::CHARSET.']+$#', $secret);
 	}
 
-	/**
-	 * Timestamps and -slices from the RFC6238 page, codes from a verified implementation
-	 *
-	 * @see https://tools.ietf.org/html/rfc6238#page-14
-	 */
 	public static function steamGuardVectors():Generator{
 		foreach(self::SteamGuardVectors as [$timestamp, $timeslice, $totp]){
 			// skip 64bit numbers on 32bit PHP