move URI generation to the respective authenticator classes

Author: codemasher

src/Authenticator.php

@@ -13,13 +13,7 @@
 
 use chillerlan\Authenticator\Authenticators\AuthenticatorInterface;
 use chillerlan\Settings\SettingsContainerInterface;
-use InvalidArgumentException;
 use SensitiveParameter;
-use function http_build_query;
-use function rawurlencode;
-use function sprintf;
-use function trim;
-use const PHP_QUERY_RFC3986;
 
 /**
  * Yet another Google authenticator implementation!
@@ -133,46 +127,16 @@ public function verify(#[SensitiveParameter] string $otp, int|null $data = null)
 	 * @deprecated 5.3.0 The parameter `$omitSettings` will be removed in favor of `AuthenticatorOptions::$omitUriSettings`
 	 *                   in the next major version (6.x)
 	 * @see \chillerlan\Authenticator\AuthenticatorOptionsTrait::$omitUriSettings
-	 * @throws \InvalidArgumentException
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function getUri(string $label, string $issuer, int|null $hotpCounter = null, bool|null $omitSettings = null):string{
-		$label  = trim($label);
-		$issuer = trim($issuer);
-
-		if(empty($label) || empty($issuer)){
-			throw new InvalidArgumentException('$label and $issuer cannot be empty');
-		}
-
-		$values = [
-			'secret' => $this->authenticator->getSecret(),
-			'issuer' => $issuer,
-		];
-
-		if($this->authenticator::MODE === AuthenticatorInterface::HOTP){
-
-			if($hotpCounter === null || $hotpCounter < 0){
-				throw new InvalidArgumentException('initial counter value must be set and greater or equal to 0');
-			}
-
-			$values['counter'] = $hotpCounter;
-		}
-
-		if(($omitSettings ?? $this->options->omitUriSettings) !== true){
-			$values['digits']    = $this->options->digits;
-			$values['algorithm'] = $this->options->algorithm;
-
-			if($this->authenticator::MODE === AuthenticatorInterface::TOTP){
-				$values['period'] = $this->options->period;
-			}
-
+		// a little reckless but good enough until the deprecated parameter is removed
+		if($omitSettings !== null){
+			$this->options->omitUriSettings = $omitSettings;
 		}
 
-		return sprintf(
-			'otpauth://%s/%s?%s',
-			$this->authenticator::MODE,
-			rawurlencode($label),
-			http_build_query($values, '', '&', PHP_QUERY_RFC3986),
-		);
+		return $this->authenticator->getUri($label, $issuer, $hotpCounter);
 	}
 
 }

src/Authenticators/AuthenticatorAbstract.php

@@ -17,9 +17,13 @@
 use InvalidArgumentException;
 use RuntimeException;
 use SensitiveParameter;
+use function http_build_query;
 use function random_bytes;
+use function rawurlencode;
+use function sprintf;
 use function time;
 use function trim;
+use const PHP_QUERY_RFC3986;
 
 /**
  *
@@ -116,4 +120,28 @@ protected function checkEncodedSecret(string $encodedSecret):string{
 		return $encodedSecret;
 	}
 
+	/**
+	 * Returns an array with settings for a mobile authenticator URI for the current authenticator mode/instance
+	 */
+	abstract protected function getUriParams(string $issuer, int|null $counter = null):array;
+
+	/**
+	 * @inheritDoc
+	 */
+	public function getUri(string $label, string $issuer, int|null $counter = null):string{
+		$label  = trim($label);
+		$issuer = trim($issuer);
+
+		if($label === '' || $issuer === ''){
+			throw new InvalidArgumentException('$label and $issuer cannot be empty');
+		}
+
+		return sprintf(
+			'otpauth://%s/%s?%s',
+			$this::MODE,
+			rawurlencode($label),
+			http_build_query($this->getUriParams($issuer, $counter), '', '&', PHP_QUERY_RFC3986),
+		);
+	}
+
 }

src/Authenticators/AuthenticatorInterface.php

@@ -123,4 +123,13 @@ public function code(int|null $data = null):string;
 	 */
 	public function verify(#[SensitiveParameter] string $otp, int|null $data = null):bool;
 
+	/**
+	 * Creates a URI string for a mobile authenticator (otpauth://...)
+	 *
+	 * The parameter `$counter` only has effect in HOTP mode
+	 *
+	 * @link https://github.com/google/google-authenticator/wiki/Key-Uri-Format#parameters
+	 */
+	public function getUri(string $label, string $issuer, int|null $counter = null):string;
+
 }

src/Authenticators/HOTP.php

@@ -13,6 +13,7 @@
 
 use RuntimeException;
 use SensitiveParameter;
+use function array_merge;
 use function hash_equals;
 use function hash_hmac;
 use function pack;
@@ -94,4 +95,25 @@ public function verify(#[SensitiveParameter] string $otp, int|null $data = null)
 		return hash_equals($this->code($data), $otp);
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	protected function getUriParams(string $issuer, int|null $counter = null):array{
+
+		$params = [
+			'secret'  => $this->getSecret(),
+			'issuer'  => $issuer,
+			'counter' => $this->getCounter($counter),
+		];
+
+		if(!$this->options->omitUriSettings){
+			$params = array_merge($params, [
+				'digits'    => $this->options->digits,
+				'algorithm' => $this->options->algorithm,
+			]);
+		}
+
+		return $params;
+	}
+
 }

src/Authenticators/SteamGuard.php

@@ -102,6 +102,10 @@ public function getOTP(#[SensitiveParameter] int $code):string{
 		return $str;
 	}
 
+	public function getUri(string $label, string $issuer, int|null $counter = null):string{
+		throw new RuntimeException('Not supported');
+	}
+
 	/**
 	 * @inheritDoc
 	 * @throws \RuntimeException

src/Authenticators/TOTP.php

@@ -12,6 +12,7 @@
 namespace chillerlan\Authenticator\Authenticators;
 
 use SensitiveParameter;
+use function array_merge;
 use function floor;
 use function hash_equals;
 use function time;
@@ -60,4 +61,25 @@ public function verify(#[SensitiveParameter] string $otp, int|null $data = null)
 		return false;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	protected function getUriParams(string $issuer, int|null $counter = null):array{
+
+		$params = [
+			'secret'  => $this->getSecret(),
+			'issuer'  => $issuer,
+		];
+
+		if(!$this->options->omitUriSettings){
+			$params = array_merge($params, [
+				'digits'    => $this->options->digits,
+				'algorithm' => $this->options->algorithm,
+				'period'    => $this->options->period,
+			]);
+		}
+
+		return $params;
+	}
+
 }