Initial refactoring step

composer.json

@@ -26,15 +26,13 @@
     "autoload": {
         "psr-4": {
             "Fabiang\\Sasl\\": "src/"
-        },
-        "files": ["src/throwable.php"]
+        }
     },
     "autoload-dev": {
         "psr-4": {
             "Fabiang\\Sasl\\Behat\\": "tests/features/bootstrap",
             "Fabiang\\Sasl\\": "tests/src"
-        },
-        "files": ["tests/compat.php"]
+        }
     },
     "require": {
         "php": "^5.3.3 || ^7.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0"

src/Authentication/AbstractAuthentication.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -48,33 +50,23 @@ abstract class AbstractAuthentication
 {
     /**
      * Use random devices.
-     *
-     * @var bool
      */
-    public static $useDevRandom = true;
+    public static bool $useDevRandom = true;
 
     /**
      * Options object.
-     *
-     * @var Options
      */
-    protected $options;
+    protected Options $options;
 
-    /**
-     *
-     * @param Options $options
-     */
     public function __construct(Options $options)
     {
         $this->options = $options;
     }
 
     /**
      * Get options object.
-     *
-     * @return Options
      */
-    public function getOptions()
+    public function getOptions(): Options
     {
         return $this->options;
     }
@@ -84,7 +76,7 @@ public function getOptions()
      *
      * @return string The cnonce value
      */
-    protected function generateCnonce()
+    protected function generateCnonce(): string
     {
         foreach (array('/dev/urandom', '/dev/random') as $file) {
             if (true === static::$useDevRandom && is_readable($file)) {
@@ -102,10 +94,8 @@ protected function generateCnonce()
 
     /**
      * Generate downgrade protection string
-     *
-     * @return string
      */
-    protected function generateDowngradeProtectionVerification()
+    protected function generateDowngradeProtectionVerification(): string
     {
         $downgradeProtectionOptions = $this->options->getDowngradeProtection();
 
@@ -127,12 +117,9 @@ protected function generateDowngradeProtectionVerification()
     }
 
     /**
-     * @param string $a
-     * @param string $b
-     * @return int
      * @link https://datatracker.ietf.org/doc/html/rfc4790#page-22
      */
-    private function sortOctetCollation($a, $b)
+    private function sortOctetCollation(string $a, string $b): int
     {
         if ($a == $b) {
             return 0;

src/Authentication/Anonymous.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -55,10 +57,10 @@ class Anonymous extends AbstractAuthentication implements AuthenticationInterfac
      *
      * We could have some logic here for the second option, but this
      * would by no means create something interpretable.
-     * @param string $challenge
+     *
      * @return string The unaltered input token
      */
-    public function createResponse($challenge = null)
+    public function createResponse(?string $challenge = null): string|false
     {
         return $this->options->getAuthcid();
     }

src/Authentication/AuthenticationInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -48,7 +50,6 @@ interface AuthenticationInterface
      * Create response.
      *
      * @param string $challenge Response challenge. Not every authentication method requires this value.
-     * @return string|false
      */
-    public function createResponse($challenge = null);
+    public function createResponse(?string $challenge = null): string|false;
 }

src/Authentication/ChallengeAuthenticationInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *

src/Authentication/CramMD5.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -57,7 +59,7 @@ class CramMD5 extends AbstractAuthentication implements ChallengeAuthenticationI
      * @return string The string to pass back to the server, of the form
      *                "<user> <digest>". This is NOT base64_encoded.
      */
-    public function createResponse($challenge = null)
+    public function createResponse(?string $challenge = null): string|false
     {
         return $this->options->getAuthcid() . ' ' . hash_hmac('md5', $challenge, $this->options->getSecret());
     }

src/Authentication/DigestMD5.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -55,7 +57,7 @@ class DigestMD5 extends AbstractAuthentication implements ChallengeAuthenticatio
      * @param  string $challenge The digest challenge sent by the server
      * @return string            The digest response (NOT base64 encoded)
      */
-    public function createResponse($challenge = null)
+    public function createResponse(?string $challenge = null): string|false
     {
         $parsedChallenge = $this->parseChallenge($challenge);
         $authzidString = '';
@@ -110,9 +112,8 @@ public function createResponse($challenge = null)
      * @param  string $challenge The digest challenge
      * @return array             The parsed challenge as an assoc
      *                           array in the form "directive => value".
-     * @access private
      */
-    private function parseChallenge($challenge)
+    private function parseChallenge(string $challenge): array
     {
         /**
          * Defaults and required directives
@@ -144,12 +145,8 @@ private function parseChallenge($challenge)
 
     /**
      * Check found token.
-     *
-     * @param array  $tokens
-     * @param string $key
-     * @param string $value
      */
-    private function checkToken(array &$tokens, $key, $value)
+    private function checkToken(array &$tokens, string $key, string $value): void
     {
         // Ignore these as per rfc2831
         if ($key !== 'opaque' && $key !== 'domain') {
@@ -166,20 +163,15 @@ private function checkToken(array &$tokens, $key, $value)
 
                     // Any other multiple instance = failure
                 } else {
-                    return array();
+                    return;
                 }
             } else {
                 $tokens[$key] = $this->trim($value);
             }
         }
     }
 
-    /**
-     *
-     * @param string $string
-     * @return string
-     */
-    private function trim($string)
+    private function trim(string $string): string
     {
         return trim($string, '"');
     }
@@ -197,8 +189,15 @@ private function trim($string)
      * @return string             The response= part of the digest response
      * @access private
      */
-    private function getResponseValue($authcid, $pass, $realm, $nonce, $cnonce, $digest_uri, $authzid = '')
-    {
+    private function getResponseValue(
+        string $authcid,
+        string $pass,
+        string $realm,
+        string $nonce,
+        string $cnonce,
+        string $digest_uri,
+        string $authzid = ''
+    ): string {
         if ($authzid == '') {
             $A1 = sprintf('%s:%s:%s', pack('H32', md5(sprintf('%s:%s:%s', $authcid, $realm, $pass))), $nonce, $cnonce);
         } else {

src/Authentication/External.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -47,10 +49,9 @@ class External extends AbstractAuthentication implements AuthenticationInterface
     /**
      * Returns EXTERNAL response
      *
-     * @param string $challenge
      * @return string EXTERNAL Response
      */
-    public function createResponse($challenge = null)
+    public function createResponse(?string $challenge = null): string|false
     {
         return $this->options->getAuthcid();
     }

src/Authentication/Login.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -52,7 +54,7 @@ class Login extends AbstractAuthentication implements AuthenticationInterface
      *
      * @return string LOGIN string
      */
-    public function createResponse($challenge = null)
+    public function createResponse(?string $challenge = null): string|false
     {
         return sprintf('LOGIN %s %s', $this->options->getAuthcid(), $this->options->getSecret());
     }

src/Authentication/Plain.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * Sasl library.
  *
@@ -49,7 +51,7 @@ class Plain extends AbstractAuthentication implements AuthenticationInterface
 
      * @return string PLAIN Response
      */
-    public function createResponse($challenge = null)
+    public function createResponse(?string $challenge = null): string|false
     {
         return $this->options->getAuthzid() . chr(0)
             . $this->options->getAuthcid() . chr(0) . $this->options->getSecret();