Fix sniffer-issues

Author: tvdijen

src/Cas/AttributeExtractor.php

@@ -16,29 +16,23 @@
  */
 class AttributeExtractor
 {
-    /** @var Configuration */
-    private Configuration $casconfig;
-
-    /** @var ProcessingChainFactory  */
-    private ProcessingChainFactory $processingChainFactory;
-
-    /** @var State */
+    /** @var \SimpleSAML\Auth\State */
     private State $authState;
 
     /**
      * ID of the Authentication Source used during authn.
      */
     private ?string $authSourceId = null;
 
+
     public function __construct(
-        Configuration $casconfig,
-        ProcessingChainFactory $processingChainFactory,
+        protected Configuration $casconfig,
+        protected ProcessingChainFactory $processingChainFactory,
     ) {
-        $this->casconfig = $casconfig;
-        $this->processingChainFactory = $processingChainFactory;
         $this->authState = new State();
     }
 
+
     /**
      * Determine the user and any CAS attributes based on the attributes from the
      * authsource and the CAS configuration.
@@ -97,6 +91,7 @@ public function extractUserAndAttributes(?array $state): array
         ];
     }
 
+
     /**
      * Run authproc filters with the processing chain
      * Creating the ProcessingChain require metadata.
@@ -129,14 +124,15 @@ protected function runAuthProcs(array &$state): void
         $this->processingChainFactory->build($state)->processState($state);
     }
 
+
     /**
      * This is a wrapper around Auth/State::loadState that facilitates testing by
      * hiding the static method
      *
      * @param   string  $stateId
      *
      * @return array|null
-     * @throws NoState
+     * @throws \SimpleSAML\Error\NoState
      */
     public function manageState(string $stateId): ?array
     {
@@ -154,6 +150,7 @@ public function manageState(string $stateId): ?array
         return $state;
     }
 
+
     /**
      * @param   string  $id
      * @param   string  $stage

src/Cas/CasException.php

@@ -12,20 +12,20 @@
  */
 class CasException extends Exception
 {
-    /** @var string */
-    private string $casCode;
-
     /**
      * CasException constructor.
+     *
      * @param string $casCode
      * @param string $message
      */
-    public function __construct(string $casCode, string $message)
-    {
+    public function __construct(
+        protected string $casCode,
+        string $message,
+    ) {
         parent::__construct($message);
-        $this->casCode = $casCode;
     }
 
+
     /**
      * @return string
      */

src/Cas/Factories/ProcessingChainFactory.php

@@ -16,15 +16,12 @@
 
 class ProcessingChainFactory
 {
-    /** @var Configuration */
-    private Configuration $casconfig;
-
     public function __construct(
-        Configuration $casconfig,
+        protected Configuration $casconfig,
     ) {
-        $this->casconfig = $casconfig;
     }
 
+
     /**
      * @codeCoverageIgnore
      * @throws \Exception

src/Cas/Protocol/Cas20.php

@@ -52,7 +52,6 @@
 
 use function base64_encode;
 use function count;
-use function filter_var;
 use function is_null;
 use function is_string;
 use function str_replace;

src/Cas/ServiceValidator.php

@@ -4,6 +4,7 @@
 
 namespace SimpleSAML\Module\casserver\Cas;
 
+use ErrorException;
 use SimpleSAML\Configuration;
 use SimpleSAML\Logger;
 use SimpleSAML\Module\casserver\Codebooks\OverrideConfigPropertiesEnum;
@@ -14,26 +15,23 @@
  */
 class ServiceValidator
 {
-    /**
-     * @var \SimpleSAML\Configuration
-     */
-    private Configuration $mainConfig;
-
     /**
      * ServiceValidator constructor.
-     * @param Configuration $mainConfig
+     * @param \SimpleSAML\Configuration $mainConfig
      */
-    public function __construct(Configuration $mainConfig)
-    {
-        $this->mainConfig = $mainConfig;
+    public function __construct(
+        protected Configuration $mainConfig,
+    ) {
     }
 
+
     /**
      * Check that the $service is allowed, and if so return the configuration to use.
      *
      * @param   string  $service  The service url. Assume to already be url decoded
      *
-     * @return Configuration|null Return the configuration to use for this service, or null if service is not allowed
+     * @return \SimpleSAML\Configuration|null Return the configuration to use for this service,
+     *   or null if service is not allowed
      * @throws \ErrorException
      */
     public function checkServiceURL(string $service): ?Configuration
@@ -82,6 +80,7 @@ public function checkServiceURL(string $service): ?Configuration
         return Configuration::loadFromArray($serviceConfig);
     }
 
+
     /**
      * @param string $legalUrl The string or regex to use for comparison
      * @param string $service  The service to compare
@@ -96,14 +95,14 @@ protected function validateServiceIsLegal(string $legalUrl, string $service): bo
             // Since "If the regex pattern passed does not compile to a valid regex, an E_WARNING is emitted. "
             // we will throw an exception if the warning is emitted and use try-catch to handle it
             set_error_handler(static function ($severity, $message, $file, $line) {
-                throw new \ErrorException($message, $severity, $severity, $file, $line);
+                throw new ErrorException($message, $severity, $severity, $file, $line);
             }, E_WARNING);
 
             try {
                 if (preg_match($legalUrl, $service) === 1) {
                     $isValid = true;
                 }
-            } catch (\ErrorException $e) {
+            } catch (ErrorException $e) {
                 // do nothing
                 Logger::warning("Invalid CAS legal service url '$legalUrl'. Error " . preg_last_error_msg());
             } finally {

src/Cas/Ticket/DelegatingTicketStore.php

@@ -69,6 +69,7 @@ public function __construct(Configuration $casConfig)
         }
     }
 
+
     /**
      * Get the ticket, searching one or all of the delegates
      * @param string $ticketId The ticket to find
@@ -103,6 +104,7 @@ public function getTicket(string $ticketId): ?array
         }
     }
 
+
     /**
      * @param array $ticket Ticket to add
      * @throws \Exception from any delegate stores ONLY if no delegates worked

src/Cas/Ticket/SQLTicketStore.php

@@ -325,7 +325,7 @@ private function get(string $key): ?array
      * @param   array     $value
      * @param   int|null  $expire
      *
-     * @throws Exception
+     * @throws \Exception
      */
     private function set(string $key, array $value, ?int $expire = null): void
     {

src/Controller/Cas10Controller.php

@@ -24,6 +24,7 @@ class Cas10Controller
 {
     use UrlTrait;
 
+
     /** @var \SimpleSAML\Logger */
     protected Logger $logger;
 
@@ -39,6 +40,7 @@ class Cas10Controller
     /** @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore */
     protected TicketStore $ticketStore;
 
+
     /**
      * @param \SimpleSAML\Configuration $sspConfig
      * @param \SimpleSAML\Configuration|null $casConfig
@@ -68,6 +70,7 @@ public function __construct(
         $this->ticketStore = $ticketStore ?? new $ticketStoreClass($this->casConfig);
     }
 
+
     /**
      * @param \Symfony\Component\HttpFoundation\Request $request
      * @param bool $renew          [OPTIONAL] - if this parameter is set, ticket validation will only succeed if the
@@ -76,7 +79,7 @@ public function __construct(
      * @param string|null $ticket  [REQUIRED] - the service ticket issued by /login.
      * @param string|null $service [REQUIRED] - the identifier of the service for which the ticket was issued
      *
-     * @return Response
+     * @return \Symfony\Component\HttpFoundation\Response
      */
     public function validate(
         Request $request,
@@ -162,6 +165,7 @@ public function validate(
         );
     }
 
+
     /**
      * Used by the unit tests
      *

src/Controller/Cas20Controller.php

@@ -26,6 +26,7 @@ class Cas20Controller
     use UrlTrait;
     use TicketValidatorTrait;
 
+
     /** @var \SimpleSAML\Logger */
     protected Logger $logger;
 
@@ -44,6 +45,7 @@ class Cas20Controller
     /** @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore */
     protected TicketStore $ticketStore;
 
+
     /**
      * @param \SimpleSAML\Configuration $sspConfig
      * @param \SimpleSAML\Configuration|null $casConfig
@@ -78,6 +80,7 @@ public function __construct(
         $this->httpUtils = $httpUtils ?? new Utils\HTTP();
     }
 
+
     /**
      * @param \Symfony\Component\HttpFoundation\Request $request
      * @param string|null $TARGET   Query parameter name for "service" used by older CAS clients'
@@ -109,6 +112,7 @@ public function serviceValidate(
         );
     }
 
+
     /**
      * /proxy provides proxy tickets to services that have
      * acquired proxy-granting tickets and will be proxying authentication to back-end services.
@@ -199,6 +203,7 @@ public function proxy(
         );
     }
 
+
     /**
      * @param \Symfony\Component\HttpFoundation\Request      $request
      * @param string|null $TARGET   Query parameter name for "service" used by older CAS clients'
@@ -230,6 +235,7 @@ public function proxyValidate(
         );
     }
 
+
     /**
      * Used by the unit tests
      *

src/Controller/Cas30Controller.php

@@ -29,6 +29,7 @@ class Cas30Controller
 {
     use UrlTrait;
 
+
     /** @var \SimpleSAML\Logger */
     protected Logger $logger;
 
@@ -44,6 +45,7 @@ class Cas30Controller
     /** @var \SimpleSAML\Module\casserver\Cas\Protocol\SamlValidateResponder */
     protected SamlValidateResponder $validateResponder;
 
+
     /**
      * @param \SimpleSAML\Configuration $sspConfig
      * @param \SimpleSAML\Configuration|null $casConfig