[Security] Add types to private properties

derrabus · derrabus · commit f721c776b64f · 2021-11-02T21:30:51.000+01:00
Signed-off-by: Alexander M. Turek &lt;me@derrabus.de&gt;
diff --git a/Authentication/RememberMe/CacheTokenVerifier.php b/Authentication/RememberMe/CacheTokenVerifier.php
@@ -18,9 +18,9 @@
  */
 class CacheTokenVerifier implements TokenVerifierInterface
 {
-    private $cache;
-    private $outdatedTokenTtl;
-    private $cacheKeyPrefix;
+    private CacheItemPoolInterface $cache;
+    private int $outdatedTokenTtl;
+    private string $cacheKeyPrefix;
 
     /**
      * @param int $outdatedTokenTtl How long the outdated token should still be considered valid. Defaults
diff --git a/Authentication/RememberMe/InMemoryTokenProvider.php b/Authentication/RememberMe/InMemoryTokenProvider.php
@@ -20,7 +20,7 @@
  */
 class InMemoryTokenProvider implements TokenProviderInterface
 {
-    private $tokens = [];
+    private array $tokens = [];
 
     /**
      * {@inheritdoc}
diff --git a/Authentication/RememberMe/PersistentToken.php b/Authentication/RememberMe/PersistentToken.php
@@ -18,11 +18,11 @@
  */
 final class PersistentToken implements PersistentTokenInterface
 {
-    private $class;
-    private $userIdentifier;
-    private $series;
-    private $tokenValue;
-    private $lastUsed;
+    private string $class;
+    private string $userIdentifier;
+    private string $series;
+    private string $tokenValue;
+    private \DateTime $lastUsed;
 
     public function __construct(string $class, string $userIdentifier, string $series, string $tokenValue, \DateTime $lastUsed)
     {
diff --git a/Authentication/Token/AbstractToken.php b/Authentication/Token/AbstractToken.php
@@ -21,9 +21,9 @@
  */
 abstract class AbstractToken implements TokenInterface, \Serializable
 {
-    private $user;
-    private $roleNames = [];
-    private $attributes = [];
+    private ?UserInterface $user = null;
+    private array $roleNames = [];
+    private array $attributes = [];
 
     /**
      * @param string[] $roles An array of roles
diff --git a/Authentication/Token/PreAuthenticatedToken.php b/Authentication/Token/PreAuthenticatedToken.php
@@ -20,7 +20,7 @@
  */
 class PreAuthenticatedToken extends AbstractToken
 {
-    private $firewallName;
+    private string $firewallName;
 
     /**
      * @param string[] $roles
diff --git a/Authentication/Token/RememberMeToken.php b/Authentication/Token/RememberMeToken.php
@@ -20,8 +20,8 @@
  */
 class RememberMeToken extends AbstractToken
 {
-    private $secret;
-    private $firewallName;
+    private string $secret;
+    private string $firewallName;
 
     /**
      * @param string $secret A secret used to make sure the token is created by the app and not by a malicious client
diff --git a/Authentication/Token/Storage/TokenStorage.php b/Authentication/Token/Storage/TokenStorage.php
@@ -24,8 +24,8 @@
  */
 class TokenStorage implements TokenStorageInterface, ResetInterface
 {
-    private $token;
-    private $initializer;
+    private ?TokenInterface $token = null;
+    private ?\Closure $initializer = null;
 
     /**
      * {@inheritdoc}
@@ -56,7 +56,7 @@ public function setToken(TokenInterface $token = null)
 
     public function setInitializer(?callable $initializer): void
     {
-        $this->initializer = $initializer;
+        $this->initializer = null === $initializer || $initializer instanceof \Closure ? $initializer : \Closure::fromCallable($initializer);
     }
 
     public function reset()
diff --git a/Authentication/Token/Storage/UsageTrackingTokenStorage.php b/Authentication/Token/Storage/UsageTrackingTokenStorage.php
@@ -24,9 +24,9 @@
  */
 final class UsageTrackingTokenStorage implements TokenStorageInterface, ServiceSubscriberInterface
 {
-    private $storage;
-    private $container;
-    private $enableUsageTracking = false;
+    private TokenStorageInterface $storage;
+    private ContainerInterface $container;
+    private bool $enableUsageTracking = false;
 
     public function __construct(TokenStorageInterface $storage, ContainerInterface $container)
     {
diff --git a/Authentication/Token/SwitchUserToken.php b/Authentication/Token/SwitchUserToken.php
@@ -20,8 +20,8 @@
  */
 class SwitchUserToken extends UsernamePasswordToken
 {
-    private $originalToken;
-    private $originatedFromUri;
+    private TokenInterface $originalToken;
+    private ?string $originatedFromUri = null;
 
     /**
      * @param $user              The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method
diff --git a/Authentication/Token/UsernamePasswordToken.php b/Authentication/Token/UsernamePasswordToken.php
@@ -20,7 +20,7 @@
  */
 class UsernamePasswordToken extends AbstractToken
 {
-    private $firewallName;
+    private string $firewallName;
 
     public function __construct(UserInterface $user, string $firewallName, array $roles = [])
     {
diff --git a/Authorization/AuthorizationChecker.php b/Authorization/AuthorizationChecker.php
@@ -25,9 +25,8 @@
  */
 class AuthorizationChecker implements AuthorizationCheckerInterface
 {
-    private $tokenStorage;
-    private $accessDecisionManager;
-    private $exceptionOnNoToken;
+    private TokenStorageInterface $tokenStorage;
+    private AccessDecisionManagerInterface $accessDecisionManager;
 
     public function __construct(TokenStorageInterface $tokenStorage, AccessDecisionManagerInterface $accessDecisionManager, bool $exceptionOnNoToken = false)
     {
@@ -37,7 +36,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AccessDecisionM
 
         $this->tokenStorage = $tokenStorage;
         $this->accessDecisionManager = $accessDecisionManager;
-        $this->exceptionOnNoToken = $exceptionOnNoToken;
     }
 
     /**
diff --git a/Authorization/TraceableAccessDecisionManager.php b/Authorization/TraceableAccessDecisionManager.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Core\Authorization;
 
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Authorization\Strategy\AccessDecisionStrategyInterface;
 use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
 
 /**
@@ -24,11 +25,11 @@
  */
 class TraceableAccessDecisionManager implements AccessDecisionManagerInterface
 {
-    private $manager;
-    private $strategy;
-    private $voters = [];
-    private $decisionLog = []; // All decision logs
-    private $currentLog = [];  // Logs being filled in
+    private AccessDecisionManagerInterface $manager;
+    private AccessDecisionStrategyInterface $strategy;
+    private iterable $voters = [];
+    private array $decisionLog = []; // All decision logs
+    private array $currentLog = [];  // Logs being filled in
 
     public function __construct(AccessDecisionManagerInterface $manager)
     {
diff --git a/Authorization/Voter/AuthenticatedVoter.php b/Authorization/Voter/AuthenticatedVoter.php
@@ -33,7 +33,7 @@ class AuthenticatedVoter implements CacheableVoterInterface
     public const IS_REMEMBERED = 'IS_REMEMBERED';
     public const PUBLIC_ACCESS = 'PUBLIC_ACCESS';
 
-    private $authenticationTrustResolver;
+    private AuthenticationTrustResolverInterface $authenticationTrustResolver;
 
     public function __construct(AuthenticationTrustResolverInterface $authenticationTrustResolver)
     {
diff --git a/Authorization/Voter/ExpressionVoter.php b/Authorization/Voter/ExpressionVoter.php
@@ -26,10 +26,10 @@
  */
 class ExpressionVoter implements VoterInterface
 {
-    private $expressionLanguage;
-    private $trustResolver;
-    private $authChecker;
-    private $roleHierarchy;
+    private ExpressionLanguage $expressionLanguage;
+    private AuthenticationTrustResolverInterface $trustResolver;
+    private AuthorizationCheckerInterface $authChecker;
+    private ?RoleHierarchyInterface $roleHierarchy;
 
     public function __construct(ExpressionLanguage $expressionLanguage, AuthenticationTrustResolverInterface $trustResolver, AuthorizationCheckerInterface $authChecker, RoleHierarchyInterface $roleHierarchy = null)
     {
diff --git a/Authorization/Voter/RoleHierarchyVoter.php b/Authorization/Voter/RoleHierarchyVoter.php
@@ -22,7 +22,7 @@
  */
 class RoleHierarchyVoter extends RoleVoter
 {
-    private $roleHierarchy;
+    private RoleHierarchyInterface $roleHierarchy;
 
     public function __construct(RoleHierarchyInterface $roleHierarchy, string $prefix = 'ROLE_')
     {
diff --git a/Authorization/Voter/RoleVoter.php b/Authorization/Voter/RoleVoter.php
@@ -20,7 +20,7 @@
  */
 class RoleVoter implements CacheableVoterInterface
 {
-    private $prefix;
+    private string $prefix;
 
     public function __construct(string $prefix = 'ROLE_')
     {
diff --git a/Authorization/Voter/TraceableVoter.php b/Authorization/Voter/TraceableVoter.php
@@ -24,8 +24,8 @@
  */
 class TraceableVoter implements CacheableVoterInterface
 {
-    private $voter;
-    private $eventDispatcher;
+    private VoterInterface $voter;
+    private EventDispatcherInterface $eventDispatcher;
 
     public function __construct(VoterInterface $voter, EventDispatcherInterface $eventDispatcher)
     {
diff --git a/Event/AuthenticationEvent.php b/Event/AuthenticationEvent.php
@@ -21,7 +21,7 @@
  */
 class AuthenticationEvent extends Event
 {
-    private $authenticationToken;
+    private TokenInterface $authenticationToken;
 
     public function __construct(TokenInterface $token)
     {
diff --git a/Event/VoteEvent.php b/Event/VoteEvent.php
@@ -23,10 +23,10 @@
  */
 final class VoteEvent extends Event
 {
-    private $voter;
-    private $subject;
-    private $attributes;
-    private $vote;
+    private VoterInterface $voter;
+    private mixed $subject;
+    private array $attributes;
+    private int $vote;
 
     public function __construct(VoterInterface $voter, mixed $subject, array $attributes, int $vote)
     {
diff --git a/Exception/AccessDeniedException.php b/Exception/AccessDeniedException.php
@@ -18,8 +18,8 @@
  */
 class AccessDeniedException extends RuntimeException
 {
-    private $attributes = [];
-    private $subject;
+    private array $attributes = [];
+    private mixed $subject = null;
 
     public function __construct(string $message = 'Access Denied.', \Throwable $previous = null)
     {
diff --git a/Exception/AccountStatusException.php b/Exception/AccountStatusException.php
@@ -22,7 +22,7 @@
  */
 abstract class AccountStatusException extends AuthenticationException
 {
-    private $user;
+    private UserInterface $user;
 
     /**
      * Get the user.
diff --git a/Exception/AuthenticationException.php b/Exception/AuthenticationException.php
@@ -21,7 +21,7 @@
  */
 class AuthenticationException extends RuntimeException
 {
-    private $token;
+    private ?TokenInterface $token = null;
 
     public function getToken(): ?TokenInterface
     {
diff --git a/Exception/CustomUserMessageAccountStatusException.php b/Exception/CustomUserMessageAccountStatusException.php
@@ -23,9 +23,8 @@
  */
 class CustomUserMessageAccountStatusException extends AccountStatusException
 {
-    private $messageKey;
-
-    private $messageData = [];
+    private string $messageKey;
+    private array $messageData = [];
 
     public function __construct(string $message = '', array $messageData = [], int $code = 0, \Throwable $previous = null)
     {
diff --git a/Exception/CustomUserMessageAuthenticationException.php b/Exception/CustomUserMessageAuthenticationException.php
@@ -22,9 +22,8 @@
  */
 class CustomUserMessageAuthenticationException extends AuthenticationException
 {
-    private $messageKey;
-
-    private $messageData = [];
+    private string $messageKey;
+    private array $messageData = [];
 
     public function __construct(string $message = '', array $messageData = [], int $code = 0, \Throwable $previous = null)
     {
diff --git a/Exception/LazyResponseException.php b/Exception/LazyResponseException.php
@@ -20,7 +20,7 @@
  */
 class LazyResponseException extends \Exception implements ExceptionInterface
 {
-    private $response;
+    private Response $response;
 
     public function __construct(Response $response)
     {
diff --git a/Exception/TooManyLoginAttemptsAuthenticationException.php b/Exception/TooManyLoginAttemptsAuthenticationException.php
@@ -19,7 +19,7 @@
  */
 class TooManyLoginAttemptsAuthenticationException extends AuthenticationException
 {
-    private $threshold;
+    private ?int $threshold;
 
     public function __construct(int $threshold = null)
     {
diff --git a/Exception/UserNotFoundException.php b/Exception/UserNotFoundException.php
@@ -19,7 +19,7 @@
  */
 class UserNotFoundException extends AuthenticationException
 {
-    private $identifier;
+    private ?string $identifier = null;
 
     /**
      * {@inheritdoc}
diff --git a/Role/RoleHierarchy.php b/Role/RoleHierarchy.php
@@ -18,12 +18,9 @@
  */
 class RoleHierarchy implements RoleHierarchyInterface
 {
-    private $hierarchy;
+    private array $hierarchy;
     protected $map;
 
-    /**
-     * @param array $hierarchy An array defining the hierarchy
-     */
     public function __construct(array $hierarchy)
     {
         $this->hierarchy = $hierarchy;
diff --git a/Security.php b/Security.php
@@ -28,7 +28,7 @@ class Security implements AuthorizationCheckerInterface
     public const LAST_USERNAME = '_security.last_username';
     public const MAX_USERNAME_LENGTH = 4096;
 
-    private $container;
+    private ContainerInterface $container;
 
     public function __construct(ContainerInterface $container)
     {
diff --git a/Signature/ExpiredSignatureStorage.php b/Signature/ExpiredSignatureStorage.php
@@ -20,8 +20,8 @@
  */
 final class ExpiredSignatureStorage
 {
-    private $cache;
-    private $lifetime;
+    private CacheItemPoolInterface $cache;
+    private int $lifetime;
 
     public function __construct(CacheItemPoolInterface $cache, int $lifetime)
     {
diff --git a/Signature/SignatureHasher.php b/Signature/SignatureHasher.php
@@ -24,11 +24,11 @@
  */
 class SignatureHasher
 {
-    private $propertyAccessor;
-    private $signatureProperties;
-    private $secret;
-    private $expiredSignaturesStorage;
-    private $maxUses;
+    private PropertyAccessorInterface $propertyAccessor;
+    private array $signatureProperties;
+    private string $secret;
+    private ?ExpiredSignatureStorage $expiredSignaturesStorage;
+    private ?int $maxUses;
 
     /**
      * @param array                        $signatureProperties      properties of the User; the hash is invalidated if these properties change
diff --git a/User/ChainUserProvider.php b/User/ChainUserProvider.php
@@ -24,10 +24,10 @@
  */
 class ChainUserProvider implements UserProviderInterface, PasswordUpgraderInterface
 {
-    private $providers;
+    private iterable $providers;
 
     /**
-     * @param iterable|UserProviderInterface[] $providers
+     * @param iterable<array-key, UserProviderInterface> $providers
      */
     public function __construct(iterable $providers)
     {
diff --git a/User/InMemoryUser.php b/User/InMemoryUser.php
diff --git a/User/InMemoryUserProvider.php b/User/InMemoryUserProvider.php
diff --git a/Validator/Constraints/UserPasswordValidator.php b/Validator/Constraints/UserPasswordValidator.php

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class InMemoryTokenProvider implements TokenProviderInterface`
`22`	`22`	`{`
`23`		`- private $tokens = [];`
	`23`	`+ private array $tokens = [];`
`24`	`24`
`25`	`25`	`/**`
`26`	`26`	`* {@inheritdoc}`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@`
`24`	`24`	`*/`
`25`	`25`	`class TokenStorage implements TokenStorageInterface, ResetInterface`
`26`	`26`	`{`
`27`		`- private $token;`
`28`		`- private $initializer;`
	`27`	`+ private ?TokenInterface $token = null;`
	`28`	`+ private ?\Closure $initializer = null;`
`29`	`29`
`30`	`30`	`/**`
`31`	`31`	`* {@inheritdoc}`
`@@ -56,7 +56,7 @@ public function setToken(TokenInterface $token = null)`
`56`	`56`
`57`	`57`	`public function setInitializer(?callable $initializer): void`
`58`	`58`	`{`
`59`		`- $this->initializer = $initializer;`
	`59`	`+ $this->initializer = null === $initializer \|\| $initializer instanceof \Closure ? $initializer : \Closure::fromCallable($initializer);`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`public function reset()`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@`
`24`	`24`	`*/`
`25`	`25`	`final class UsageTrackingTokenStorage implements TokenStorageInterface, ServiceSubscriberInterface`
`26`	`26`	`{`
`27`		`- private $storage;`
`28`		`- private $container;`
`29`		`- private $enableUsageTracking = false;`
	`27`	`+ private TokenStorageInterface $storage;`
	`28`	`+ private ContainerInterface $container;`
	`29`	`+ private bool $enableUsageTracking = false;`
`30`	`30`
`31`	`31`	`public function __construct(TokenStorageInterface $storage, ContainerInterface $container)`
`32`	`32`	`{`