[Security] Add missing void PHPdoc return types

Author: mbuliard

Authentication/RememberMe/TokenProviderInterface.php

@@ -31,18 +31,24 @@ public function loadTokenBySeries(string $series);
 
     /**
      * Deletes all tokens belonging to series.
+     *
+     * @return void
      */
     public function deleteTokenBySeries(string $series);
 
     /**
      * Updates the token according to this data.
      *
+     * @return void
+     *
      * @throws TokenNotFoundException if the token is not found
      */
     public function updateToken(string $series, #[\SensitiveParameter] string $tokenValue, \DateTime $lastUsed);
 
     /**
      * Creates a new token.
+     *
+     * @return void
      */
     public function createNewToken(PersistentTokenInterface $token);
 }

Authentication/Token/NullToken.php

@@ -33,6 +33,9 @@ public function getUser(): ?UserInterface
         return null;
     }
 
+    /**
+     * @return never
+     */
     public function setUser(UserInterface $user)
     {
         throw new \BadMethodCallException('Cannot set user on a NullToken.');
@@ -55,6 +58,9 @@ public function getAttributes(): array
         return [];
     }
 
+    /**
+     * @return never
+     */
     public function setAttributes(array $attributes)
     {
         throw new \BadMethodCallException('Cannot set attributes of NullToken.');
@@ -70,6 +76,9 @@ public function getAttribute(string $name): mixed
         return null;
     }
 
+    /**
+     * @return never
+     */
     public function setAttribute(string $name, mixed $value)
     {
         throw new \BadMethodCallException('Cannot add attribute to NullToken.');

Authentication/Token/Storage/TokenStorageInterface.php

@@ -29,6 +29,8 @@ public function getToken(): ?TokenInterface;
      * Sets the authentication token.
      *
      * @param TokenInterface|null $token A TokenInterface token, or null if no further authentication information should be stored
+     *
+     * @return void
      */
     public function setToken(?TokenInterface $token);
 }

Authentication/Token/TokenInterface.php

@@ -50,19 +50,25 @@ public function getUser(): ?UserInterface;
     /**
      * Sets the authenticated user in the token.
      *
+     * @return void
+     *
      * @throws \InvalidArgumentException
      */
     public function setUser(UserInterface $user);
 
     /**
      * Removes sensitive information from the token.
+     *
+     * @return void
      */
     public function eraseCredentials();
 
     public function getAttributes(): array;
 
     /**
      * @param array $attributes The token attributes
+     *
+     * @return void
      */
     public function setAttributes(array $attributes);
 
@@ -73,6 +79,9 @@ public function hasAttribute(string $name): bool;
      */
     public function getAttribute(string $name): mixed;
 
+    /**
+     * @return void
+     */
     public function setAttribute(string $name, mixed $value);
 
     /**

Tests/Authentication/AuthenticationTrustResolverTest.php

@@ -111,7 +111,7 @@ public function getUser(): UserInterface
         return new InMemoryUser('wouter', '', ['ROLE_USER']);
     }
 
-    public function setUser($user)
+    public function setUser($user): void
     {
     }
 
@@ -123,15 +123,15 @@ public function getUserIdentifier(): string
     {
     }
 
-    public function eraseCredentials()
+    public function eraseCredentials(): void
     {
     }
 
     public function getAttributes(): array
     {
     }
 
-    public function setAttributes(array $attributes)
+    public function setAttributes(array $attributes): void
     {
     }
 
@@ -143,7 +143,7 @@ public function getAttribute(string $name): mixed
     {
     }
 
-    public function setAttribute(string $name, $value)
+    public function setAttribute(string $name, $value): void
     {
     }
 }

User/UserCheckerInterface.php

@@ -26,13 +26,17 @@ interface UserCheckerInterface
     /**
      * Checks the user account before authentication.
      *
+     * @return void
+     *
      * @throws AccountStatusException
      */
     public function checkPreAuth(UserInterface $user);
 
     /**
      * Checks the user account after authentication.
      *
+     * @return void
+     *
      * @throws AccountStatusException
      */
     public function checkPostAuth(UserInterface $user);

User/UserInterface.php

@@ -51,6 +51,8 @@ public function getRoles(): array;
      *
      * This is important if, at any given point, sensitive information like
      * the plain-text password is stored on this object.
+     *
+     * @return void
      */
     public function eraseCredentials();