Merge pull request #38 from Staffbase/code-cleanup-pt2

refactor: Code cleanup Pt2

Author: Ninerian

.gitignore

@@ -40,4 +40,3 @@ phpcs.xml
 /vendor/*
 /wpcs/*
 
-!/.gitignore

.php-cs-fixer.dist.php

@@ -6,7 +6,6 @@
 
 return (new PhpCsFixer\Config())
     ->setRules([
-        '@PHP8x4Migration' => true,
         '@PER-CS' => true,
         'array_syntax' => ['syntax' => 'short'],
         'declare_strict_types' => true,

phpstan.neon.dist

@@ -1,5 +1,5 @@
 parameters:
-    level: 5
+    level: 7
     paths:
         - ./src
         - ./test

src/AbstractToken.php

@@ -25,6 +25,9 @@ abstract class AbstractToken
 
     private Configuration $config;
 
+    /**
+     * @var Constraint[]
+     */
     private array $constraints;
 
     /**
@@ -92,6 +95,9 @@ protected function validateToken(): void
      */
     protected function hasClaim(string $claim): bool
     {
+        if (empty($claim)) {
+            return false;
+        }
         return $this->token->claims()->has($claim);
     }
 
@@ -102,13 +108,25 @@ protected function hasClaim(string $claim): bool
      *
      * @return mixed
      */
-    protected function getClaim(string $claim)
+    /**
+     * Get a claim without checking for existence.
+     *
+     * @param string $claim name.
+     *
+     * @return mixed
+     */
+    protected function getClaim(string $claim): mixed
     {
+        if (empty($claim)) {
+            return null;
+        }
         return $this->token->claims()->get($claim);
     }
 
     /**
      * Get an array of all available claims and their values.
+     *
+     * @return array<string, mixed>
      */
     protected function getAllClaims(): array
     {
@@ -125,12 +143,19 @@ protected function getAllClaims(): array
      */
     public static function base64ToPEMPublicKey(string $data): string
     {
+        if (empty($data)) {
+            throw new SSOException('Empty base64 data provided for PEM conversion.');
+        }
 
         $data = strtr($data, [
             "\r" => "",
             "\n" => "",
         ]);
 
+        if (empty($data)) {
+            throw new SSOException('Base64 data is empty after cleanup.');
+        }
+
         return
             "-----BEGIN PUBLIC KEY-----\n"
             . chunk_split($data, 64)
@@ -179,12 +204,26 @@ public function getSignerKey(): Key
      */
     private function getKey(string $appSecret): Key
     {
+        // Ensure the app secret is not empty to satisfy strict non-empty-string requirements
+        if (!trim($appSecret)) {
+            throw new SSOException('Empty appSecret provided when creating signer key.');
+        }
+
         if (strpos($appSecret, '-----') === 0) {
+            if (empty($appSecret)) {
+                throw new SSOException('Empty PEM key provided.');
+            }
             $key = InMemory::plainText($appSecret);
         } elseif (strpos($appSecret, 'file://') === 0) {
+            if (empty($appSecret)) {
+                throw new SSOException('Empty file path provided.');
+            }
             $key = InMemory::file($appSecret);
         } else {
-            $key = InMemory::plainText(self::base64ToPEMPublicKey($appSecret));
+            $pem = self::base64ToPEMPublicKey($appSecret);
+            // After our validation in base64ToPEMPublicKey, we know $pem is non-empty
+            /** @var non-empty-string $pem */
+            $key = InMemory::plainText($pem);
         }
         return $key;
     }

src/RemoteCall/AbstractRemoteCallHandler.php

@@ -30,7 +30,7 @@ abstract class AbstractRemoteCallHandler implements RemoteCallInterface
      *
      * This will tell Staffbase that everything went OK.
      */
-    public function exitSuccess()
+    public function exitSuccess(): void
     {
         header("HTTP/1.1 200 OK");
         exit;
@@ -41,7 +41,7 @@ public function exitSuccess()
      *
      * This will tell Staffbase that it should try again later.
      */
-    public function exitFailure()
+    public function exitFailure(): void
     {
         header('HTTP/1.1 500 Internal Server Error');
         exit;

src/RemoteCall/RemoteCallInterface.php

@@ -29,12 +29,12 @@ interface RemoteCallInterface
      *
      * This will tell Staffbase that everything went OK.
      */
-    public function exitSuccess();
+    public function exitSuccess(): void;
 
     /**
      * Stop the execution by providing a non 2XX HTTP response
      *
      * This will tell Staffbase that it should try again later.
      */
-    public function exitFailure();
+    public function exitFailure(): void;
 }

src/SSOData/ClaimAccessTrait.php

@@ -40,7 +40,7 @@ abstract protected function getClaim(string $claim);
     /**
      * Get an array of all available claims and their values.
      *
-     * @return array
+     * @return array<string, mixed>
      */
     abstract protected function getAllClaims(): array;
 

src/SSOData/SSODataTrait.php

@@ -198,7 +198,7 @@ public function getLocale(): string
     /**
      * Get the user tags.
      *
-     * @return array|null
+     * @return array<mixed>|null
      */
     public function getTags(): ?array
     {

src/SSOData/SharedDataTrait.php

@@ -36,7 +36,7 @@ trait SharedDataTrait
      */
     public function getAudience(): ?string
     {
-        /** @var array|string|null $audience */
+        /** @var array<string>|string|null $audience */
         $audience = $this->getClaimSafe(SharedClaimsInterface::CLAIM_AUDIENCE);
 
         if (is_array($audience)) {
@@ -127,7 +127,7 @@ public function getRole(): ?string
     /**
      * Get all stored data.
      *
-     * @return array
+     * @return array<string,mixed>
      */
     public function getData(): array
     {

src/SSOToken.php

@@ -45,6 +45,10 @@ class SSOToken extends AbstractToken implements SharedClaimsInterface, SSODataCl
      */
     public function __construct(string $appSecret, string $tokenData, ?int $leeway = 0)
     {
+        if (empty($tokenData)) {
+            throw new SSOException('Parameter tokenData for SSOToken is empty.');
+        }
+
         $constrains = [
             new StrictValidAt(SystemClock::fromUTC(), $this->getLeewayInterval((int) $leeway)),
             new HasInstanceId(),