vendor/symfony/security-http/Authenticator/Passport/Credentials/CustomCredentials.php line 24

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\Authenticator\Passport\Credentials;
  14. use Symfony\Component\Security\Core\Exception\BadCredentialsException;
  15. use Symfony\Component\Security\Core\User\UserInterface;
  17. /**
  18.  * Implements credentials checking using a custom checker function.
  19.  *
  20.  * @author Wouter de Jong <[email protected]>
  21.  *
  22.  * @final
  23.  */
  24. class CustomCredentials implements CredentialsInterface
  25. {
  26.     private \Closure $customCredentialsChecker;
  27.     private mixed $credentials;
  28.     private bool $resolved = false;
  30.     /**
  31.      * @param callable $customCredentialsChecker the check function. If this function does not return `true`, a
  32.      *                                           BadCredentialsException is thrown. You may also throw a more
  33.      *                                           specific exception in the function.
  34.      */
  35.     public function __construct(callable $customCredentialsChecker, mixed $credentials)
  36.     {
  37.         $this->customCredentialsChecker = $customCredentialsChecker instanceof \Closure ? $customCredentialsChecker : \Closure::fromCallable($customCredentialsChecker);
  38.         $this->credentials = $credentials;
  39.     }
  41.     public function executeCustomChecker(UserInterface $user): void
  42.     {
  43.         $checker = $this->customCredentialsChecker;
  45.         if (true !== $checker($this->credentials, $user)) {
  46.             throw new BadCredentialsException('Credentials check failed as the callable passed to CustomCredentials did not return "true".');
  47.         }
  49.         $this->resolved = true;
  50.     }
  52.     public function isResolved(): bool
  53.     {
  54.         return $this->resolved;
  55.     }
  56. }