✨ v4

Author: codemasher

.github/workflows/ci.yml

@@ -22,8 +22,6 @@ jobs:
       fail-fast: true
       matrix:
         php-version:
-          - "7.2"
-          - "7.3"
           - "7.4"
           - "8.0"
           - "8.1"
@@ -65,8 +63,6 @@ jobs:
           - ubuntu-latest
           - windows-latest
         php-version:
-          - "7.2"
-          - "7.3"
           - "7.4"
           - "8.0"
           - "8.1"
@@ -81,7 +77,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          coverage: xdebug
+          coverage: pcov
           extensions: curl, gmp, json, sodium
 
       - name: "Install dependencies with composer"

.phan/config.php

@@ -15,7 +15,7 @@
 	// that functions removed in php 7.0 exist.
 	// (See `backward_compatibility_checks` for additional options)
 	'target_php_version' => null,
-	'minimum_target_php_version' => '7.2',
+	'minimum_target_php_version' => '7.4',
 
 	// A list of directories that should be parsed for class and
 	// method information. After excluding the directories

README.md

@@ -18,7 +18,7 @@ A generator for counter based ([RFC 4226](https://tools.ietf.org/html/rfc4226))
 
 # Documentation
 ## Requirements
-- PHP 7.2+
+- PHP 7.4+
   - [`ext-curl`](https://www.php.net/manual/book.curl) for Battle.net and Steam Guard server time synchronization
   - [`ext-gmp`](https://www.php.net/manual/book.gmp) for Battle.net authenticator secret retrieval (RSA encryption)
   - [`ext-sodium`](https://www.php.net/manual/book.sodium) for constant time implementations of base64 encode/decode and hex2bin/bin2hex
@@ -29,11 +29,11 @@ A generator for counter based ([RFC 4226](https://tools.ietf.org/html/rfc4226))
 
 via terminal: `composer require chillerlan/php-authenticator`
 
-*composer.json* (note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^3.1` - see [releases](https://github.com/chillerlan/php-authenticator/releases) for valid versions)
+*composer.json* (note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^4.1` - see [releases](https://github.com/chillerlan/php-authenticator/releases) for valid versions)
 ```json
 {
 	"require": {
-		"php": "^7.2 || ^8.0",
+		"php": "^7.4 || ^8.0",
 		"chillerlan/php-authenticator": "dev-main"
 	}
 }

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "chillerlan/php-authenticator",
-	"description": "A generator for counter- and time based 2-factor authentication codes (Google Authenticator). PHP 7.2+",
+	"description": "A generator for counter- and time based 2-factor authentication codes (Google Authenticator). PHP 7.4+",
 	"homepage": "https://github.com/chillerlan/php-authenticator",
 	"license": "MIT",
 	"type": "library",
@@ -21,8 +21,8 @@
 	"minimum-stability": "stable",
 	"prefer-stable": true,
 	"require": {
-		"php": "^7.2 || ^8.0",
-		"chillerlan/php-settings-container": "^1.2.2 || ^2.1.4 || ^3.0",
+		"php": "^7.4 || ^8.0",
+		"chillerlan/php-settings-container": "^2.1.4 || ^3.0",
 		"paragonie/constant_time_encoding": "^2.6"
 	},
 	"require-dev": {
@@ -32,7 +32,7 @@
 		"ext-sodium": "*",
 		"phan/phan": "^5.4",
 		"phpmd/phpmd": "^2.13",
-		"phpunit/phpunit": "^8.5 || ^9.6",
+		"phpunit/phpunit": "^9.6",
 		"squizlabs/php_codesniffer": "^3.7"
 	},
 	"suggest": {
@@ -50,7 +50,7 @@
 	},
 	"scripts": {
 		"phpunit": "@php vendor/bin/phpunit",
-		"phan": "@php vendor/bin/phan --allow-polyfill-parser"
+		"phan": "@php vendor/bin/phan"
 	},
 	"config": {
 		"lock": false,

phpunit.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          cacheResultFile=".build/phpunit.result.cache"
          colors="true"
@@ -11,12 +11,13 @@
 			<directory suffix=".php">./tests</directory>
 		</testsuite>
 	</testsuites>
-	<filter>
-		<whitelist processUncoveredFilesFromWhitelist="true">
+	<coverage processUncoveredFiles="true">
+		<include>
 			<directory suffix=".php">./src</directory>
-		</whitelist>
-	</filter>
-	<logging>
-		<log type="coverage-clover" target=".build/coverage/clover.xml"/>
-	</logging>
+		</include>
+		<report>
+			<clover outputFile=".build/coverage/clover.xml"/>
+			<xml outputDirectory=".build/coverage/coverage-xml"/>
+		</report>
+	</coverage>
 </phpunit>

src/Authenticator.php

@@ -30,14 +30,10 @@
  */
 class Authenticator{
 
-	/** @var \chillerlan\Authenticator\Authenticators\AuthenticatorInterface */
-	protected $authenticator;
-
 	/** @var \chillerlan\Settings\SettingsContainerInterface|\chillerlan\Authenticator\AuthenticatorOptions */
-	protected $options;
-
-	/** @var string */
-	protected $mode = AuthenticatorInterface::TOTP;
+	protected SettingsContainerInterface $options;
+	protected AuthenticatorInterface     $authenticator;
+	protected string                     $mode = AuthenticatorInterface::TOTP;
 
 	/**
 	 * Authenticator constructor

src/AuthenticatorOptionsTrait.php

@@ -20,82 +20,64 @@ trait AuthenticatorOptionsTrait{
 
 	/**
 	 * Code length: either 6 or 8
-	 *
-	 * @var int
 	 */
-	protected $digits = 6;
+	protected int $digits = 6;
 
 	/**
 	 * Validation period (seconds): 15 - 60
-	 *
-	 * @var int
 	 */
-	protected $period = 30;
+	protected int $period = 30;
 
 	/**
 	 * Length of the secret phrase (bytes, unencoded binary)
 	 *
 	 * @see \random_bytes()
-	 *
-	 * @var int
 	 */
-	protected $secret_length = 20;
+	protected int $secret_length = 20;
 
 	/**
 	 * Hash algorithm:
 	 *
 	 *   - `AuthenticatorInterface::ALGO_SHA1`
 	 *   - `AuthenticatorInterface::ALGO_SHA256`
 	 *   - `AuthenticatorInterface::ALGO_SHA512`
-	 *
-	 * @var string
 	 */
-	protected $algorithm = AuthenticatorInterface::ALGO_SHA1;
+	protected string $algorithm = AuthenticatorInterface::ALGO_SHA1;
 
 	/**
 	 * Authenticator mode:
 	 *
 	 *   - `AuthenticatorInterface::HOTP`  = counter based
 	 *   - `AuthenticatorInterface::TOTP`  = time based
 	 *   - `AuthenticatorInterface::STEAM` = time based (Steam Guard)
-	 *
-	 * @var string
 	 */
-	protected $mode = AuthenticatorInterface::TOTP;
+	protected string $mode = AuthenticatorInterface::TOTP;
 
 	/**
 	 * Number of allowed adjacent codes
-	 *
-	 * @var int
 	 */
-	protected $adjacent = 1;
+	protected int $adjacent = 1;
 
 	/**
 	 * A fixed time offset that will be added to the current time value
 	 *
 	 * @see \chillerlan\Authenticator\Authenticators\AuthenticatorInterface::getCounter()
-	 *
-	 * @var int
 	 */
-	protected $time_offset = 0;
+	protected int $time_offset = 0;
 
 	/**
 	 * Whether to use local time or request server time from the API
 	 *
 	 * This can be useful when the device time sync is unreliable.
 	 *
 	 * note: API requests needs ext-curl installed
-	 *
-	 * @var bool
 	 */
-	protected $useLocalTime = true;
+	protected bool $useLocalTime = true;
 
 	/**
 	 * Whether to force refreshing server time on each call or use the time returned from the last request
-	 *
-	 * @var bool
 	 */
-	protected $forceTimeRefresh = false;
+	protected bool $forceTimeRefresh = false;
 
 	/**
 	 * Sets the code length to either 6 or 8

src/Authenticators/AuthenticatorAbstract.php

@@ -27,16 +27,10 @@ abstract class AuthenticatorAbstract implements AuthenticatorInterface{
 	protected const userAgent = 'chillerlanAuthenticator/5.0 +https://github.com/chillerlan/php-authenticator';
 
 	/** @var \chillerlan\Settings\SettingsContainerInterface|\chillerlan\Authenticator\AuthenticatorOptions */
-	protected $options;
-
-	/** @var string|null */
-	protected $secret = null;
-
-	/** @var int */
-	protected $serverTime = 0;
-
-	/** @var int */
-	protected $lastRequestTime = 0;
+	protected SettingsContainerInterface $options;
+	protected ?string                    $secret          = null;
+	protected int                        $serverTime      = 0;
+	protected int                        $lastRequestTime = 0;
 
 	/**
 	 * AuthenticatorInterface constructor
@@ -80,10 +74,7 @@ public function getSecret():string{
 	 * @inheritDoc
 	 */
 	public function createSecret(int $length = null):string{
-
-		if($length === null){
-			$length = $this->options->secret_length;
-		}
+		$length ??= $this->options->secret_length;
 
 		if($length < 16){
 			throw new InvalidArgumentException('Invalid secret length: '.$length);

src/Authenticators/BattleNet.php

@@ -101,8 +101,7 @@ final class BattleNet extends TOTP{
 #	                               '19a250fa4cc1278d12855b5b25818d162c6e6ee2ab4a350d401d78f6ddb99711'.
 #	                               'e72626b48bd8b5b0b7f3acf9ea3c9e0005fee59e19136cdb7c83f2ab8b0a2a99';
 
-	/** @var array */
-	private $curlInfo = [];
+	private array $curlInfo = [];
 
 	/**
 	 * @inheritDoc

src/Authenticators/TOTP.php

@@ -23,10 +23,7 @@ class TOTP extends HOTP{
 	 * @inheritDoc
 	 */
 	public function getCounter(int $data = null):int{
-
-		if($data === null){
-			$data = time();
-		}
+		$data ??= time();
 
 		if($this->options->useLocalTime === false){
 			$data = $this->getServerTime();