Migrate code to PHP 8.3

Author: tvdijen

src/Binding/HTTPArtifact.php

@@ -48,8 +48,6 @@ class HTTPArtifact extends Binding implements AsynchronousBindingInterface, Rela
 
 
     /**
-     * @psalm-suppress UndefinedDocblockClass
-     * @psalm-suppress UndefinedClass
      * @var \SimpleSAML\Configuration
      */
     private Configuration $spMetadata;
@@ -58,16 +56,15 @@ class HTTPArtifact extends Binding implements AsynchronousBindingInterface, Rela
     /**
      * Create the redirect URL for a message.
      *
-     * @param  \SimpleSAML\SAML2\XML\samlp\AbstractMessage $message The message.
+     * @param \SimpleSAML\SAML2\XML\samlp\AbstractMessage $message The message.
+     * @return string The URL the user should be redirected to in order to send a message.
+     *
      * @throws \Exception
-     * @return string        The URL the user should be redirected to in order to send a message.
      */
     public function getRedirectURL(AbstractMessage $message): string
     {
-        /** @psalm-suppress UndefinedClass */
         $config = Configuration::getInstance();
 
-        /** @psalm-suppress UndefinedClass */
         $store = StoreFactory::getInstance($config->getString('store.type'));
         if ($store === false) {
             throw new Exception('Unable to send artifact without a datastore configured.');
@@ -97,7 +94,6 @@ public function getRedirectURL(AbstractMessage $message): string
             $params['RelayState'] = $relayState;
         }
 
-        /** @psalm-suppress UndefinedClass */
         $httpUtils = new HTTP();
         return $httpUtils->addURLparameters($destination, $params);
     }
@@ -211,8 +207,6 @@ public function receive(ServerRequestInterface $request): AbstractMessage
 
     /**
      * @param \SimpleSAML\Configuration $sp
-     *
-     * @psalm-suppress UndefinedClass
      */
     public function setSPMetadata(Configuration $sp): void
     {
@@ -225,7 +219,6 @@ public function setSPMetadata(Configuration $sp): void
      *
      * @param \SimpleSAML\SAML2\XML\samlp\ArtifactResponse $message
      * @param \SimpleSAML\XMLSecurity\XMLSecurityKey $key
-     * @return bool
      */
     public static function validateSignature(ArtifactResponse $message, XMLSecurityKey $key): bool
     {

src/Binding/HTTPPost.php

@@ -82,6 +82,7 @@ public function send(AbstractMessage $message): ResponseInterface
      *
      * @param \Psr\Http\Message\ServerRequestInterface $request
      * @return \SimpleSAML\SAML2\XML\samlp\AbstractMessage The received message.
+     *
      * @throws \Exception
      */
     public function receive(ServerRequestInterface $request): AbstractMessage

src/Binding/HTTPRedirect.php

@@ -126,6 +126,7 @@ public function send(AbstractMessage $message): ResponseInterface
      *
      * @param \Psr\Http\Message\ServerRequestInterface $request
      * @return \SimpleSAML\SAML2\XML\samlp\AbstractMessage The received message.
+     *
      * @throws \Exception
      *
      * NPath is currently too high but solving that just moves code around.

src/Binding/RelayStateInterface.php

@@ -13,16 +13,12 @@ interface RelayStateInterface
 {
     /**
      * Set the RelayState associated with he message.
-     *
-     * @param string|null $relayState The RelayState.
      */
     public function setRelayState(?string $relayState = null): void;
 
 
     /**
      * Get the RelayState associated with the message.
-     *
-     * @return string|null The RelayState.
      */
     public function getRelayState(): ?string;
 }

src/Binding/RelayStateTrait.php

@@ -15,16 +15,12 @@ trait RelayStateTrait
 {
     /**
      * The relay state.
-     *
-     * @var string|null
      */
     protected ?string $relayState = null;
 
 
     /**
      * Set the RelayState associated with he message.
-     *
-     * @param string|null $relayState The RelayState.
      */
     public function setRelayState(?string $relayState = null): void
     {
@@ -35,8 +31,6 @@ public function setRelayState(?string $relayState = null): void
 
     /**
      * Get the RelayState associated with the message.
-     *
-     * @return string|null The RelayState.
      */
     public function getRelayState(): ?string
     {

src/Binding/SOAP.php

@@ -35,10 +35,11 @@ class SOAP extends Binding implements SynchronousBindingInterface
 {
     /**
      * @param \SimpleSAML\SAML2\XML\samlp\AbstractMessage $message
-     * @throws \Exception
      * @return string|false The XML or false on error
+     *
+     * @throws \Exception
      */
-    public function getOutputToSend(AbstractMessage $message)
+    public function getOutputToSend(AbstractMessage $message): string|false
     {
         $header = new Header();
 
@@ -113,7 +114,7 @@ public function receive(/** @scrutinizer ignore-unused */ServerRequestInterface
     /**
      * @return string|false
      */
-    protected function getInputStream()
+    protected function getInputStream(): string|false
     {
         return file_get_contents('php://input');
     }

src/Certificate/Key.php

@@ -19,9 +19,9 @@
 class Key implements ArrayAccess
 {
     // Possible key usages
-    public const USAGE_SIGNING = 'signing';
+    public const string USAGE_SIGNING = 'signing';
 
-    public const USAGE_ENCRYPTION = 'encryption';
+    public const string USAGE_ENCRYPTION = 'encryption';
 
 
     /** @var array */
@@ -43,8 +43,6 @@ public function __construct(array $keyData)
     /**
      * Whether or not the key is configured to be used for usage given
      *
-     * @param string $usage
-     * @return bool
      * @throws \SimpleSAML\SAML2\Exception\InvalidArgumentException
      */
     public function canBeUsedFor(string $usage): bool
@@ -62,8 +60,8 @@ public function canBeUsedFor(string $usage): bool
 
     /**
      * @param mixed $offset
+     *
      * @throws \SimpleSAML\SAML2\Exception\InvalidArgumentException
-     * @return bool
      */
     public function offsetExists(mixed $offset): bool
     {
@@ -75,9 +73,7 @@ public function offsetExists(mixed $offset): bool
 
 
     /**
-     * @param mixed $offset
      * @throws \SimpleSAML\SAML2\Exception\InvalidArgumentException
-     * @return mixed
      */
     public function offsetGet($offset): mixed
     {
@@ -89,8 +85,6 @@ public function offsetGet($offset): mixed
 
 
     /**
-     * @param mixed $offset
-     * @param mixed $value
      * @throws \SimpleSAML\SAML2\Exception\InvalidArgumentException
      */
     public function offsetSet(mixed $offset, mixed $value): void
@@ -103,7 +97,6 @@ public function offsetSet(mixed $offset, mixed $value): void
 
 
     /**
-     * @param mixed $offset
      * @throws \SimpleSAML\SAML2\Exception\InvalidArgumentException
      */
     public function offsetUnset(mixed $offset): void

src/Certificate/KeyCollection.php

@@ -16,14 +16,11 @@ class KeyCollection extends ArrayCollection
      * Add a key to the collection
      *
      * @param \SimpleSAML\SAML2\Certificate\Key $element
-     * @throws \SimpleSAML\Assert\AssertionFailedException if assertions are false
      *
-     * Type hint not possible due to upstream method signature
-     * @psalm-suppress MoreSpecificImplementedParamType
+     * @throws \SimpleSAML\Assert\AssertionFailedException if assertions are false
      */
     public function add($element): void
     {
-        /** @psalm-suppress RedundantConditionGivenDocblockType */
         Assert::isInstanceOf($element, Key::class);
         parent::add($element);
     }

src/Certificate/KeyLoader.php

@@ -10,6 +10,7 @@
 use SimpleSAML\SAML2\Configuration\CertificateProvider;
 use SimpleSAML\SAML2\Utilities\File;
 use SimpleSAML\XMLSecurity\Utils\Certificate;
+use Traversable;
 
 use function count;
 use function preg_match;
@@ -40,8 +41,6 @@ public function __construct()
      * Prioritisation order is keys > certData > certificate
      *
      * @param \SimpleSAML\SAML2\Configuration\CertificateProvider $config
-     * @param string|null $usage
-     * @param bool $required
      * @return \SimpleSAML\SAML2\Certificate\KeyCollection
      */
     public static function extractPublicKeys(
@@ -57,8 +56,6 @@ public static function extractPublicKeys(
 
     /**
      * @param \SimpleSAML\SAML2\Configuration\CertificateProvider $config
-     * @param null|string $usage
-     * @param bool $required
      * @return \SimpleSAML\SAML2\Certificate\KeyCollection
      */
     public function loadKeysFromConfiguration(
@@ -92,11 +89,8 @@ public function loadKeysFromConfiguration(
     /**
      * Loads the keys given, optionally excluding keys when a usage is given and they
      * are not configured to be used with the usage given
-     *
-     * @param array|\Traversable $configuredKeys
-     * @param string|null $usage
      */
-    public function loadKeys($configuredKeys, ?string $usage = null): void
+    public function loadKeys(array|Traversable $configuredKeys, ?string $usage = null): void
     {
         foreach ($configuredKeys as $keyData) {
             if (isset($keyData['X509Certificate'])) {
@@ -116,8 +110,6 @@ public function loadKeys($configuredKeys, ?string $usage = null): void
 
     /**
      * Attempts to load a key based on the given certificateData
-     *
-     * @param string $certificateData
      */
     public function loadCertificateData(string $certificateData): void
     {
@@ -156,7 +148,6 @@ public function getKeys(): KeyCollection
 
 
     /**
-     * @return bool
      */
     public function hasKeys(): bool
     {

src/Certificate/PrivateKeyLoader.php

@@ -30,8 +30,9 @@ public function loadPrivateKey(PrivateKeyConfiguration $key): PrivateKey
     /**
      * @param \SimpleSAML\SAML2\Configuration\DecryptionProvider $identityProvider
      * @param \SimpleSAML\SAML2\Configuration\DecryptionProvider $serviceProvider
-     * @throws \Exception
      * @return \SimpleSAML\SAML2\Utilities\ArrayCollection
+     *
+     * @throws \Exception
      */
     public function loadDecryptionKeys(
         DecryptionProvider $identityProvider,