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 <fabien@symfony.com>
  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 <wouter@wouterj.nl>
  21. *
  22. * @final
  23. */
  24. class CustomCredentials implements CredentialsInterface
  25. {
  26. private $customCredentialsChecker;
  27. private $credentials;
  28. private $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. * @param mixed $credentials
  35. */
  36. public function __construct(callable $customCredentialsChecker, $credentials)
  37. {
  38. $this->customCredentialsChecker = $customCredentialsChecker;
  39. $this->credentials = $credentials;
  40. }
  42. public function executeCustomChecker(UserInterface $user): void
  43. {
  44. $checker = $this->customCredentialsChecker;
  46. if (true !== $checker($this->credentials, $user)) {
  47. throw new BadCredentialsException('Credentials check failed as the callable passed to CustomCredentials did not return "true".');
  48. }
  50. $this->resolved = true;
  51. }
  53. public function isResolved(): bool
  54. {
  55. return $this->resolved;
  56. }
  57. }