vendor/symfony/security-http/Authenticator/Passport/Badge/CsrfTokenBadge.php line 25

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\Badge;
  14. use Symfony\Component\Security\Http\EventListener\CsrfProtectionListener;
  16. /**
  17. * Adds automatic CSRF tokens checking capabilities to this authenticator.
  18. *
  19. * @see CsrfProtectionListener
  20. *
  21. * @author Wouter de Jong <wouter@wouterj.nl>
  22. *
  23. * @final
  24. */
  25. class CsrfTokenBadge implements BadgeInterface
  26. {
  27. private $resolved = false;
  28. private $csrfTokenId;
  29. private $csrfToken;
  31. /**
  32. * @param string $csrfTokenId An arbitrary string used to generate the value of the CSRF token.
  33. * Using a different string for each authenticator improves its security.
  34. * @param string|null $csrfToken The CSRF token presented in the request, if any
  35. */
  36. public function __construct(string $csrfTokenId, ?string $csrfToken)
  37. {
  38. $this->csrfTokenId = $csrfTokenId;
  39. $this->csrfToken = $csrfToken;
  40. }
  42. public function getCsrfTokenId(): string
  43. {
  44. return $this->csrfTokenId;
  45. }
  47. public function getCsrfToken(): ?string
  48. {
  49. return $this->csrfToken;
  50. }
  52. /**
  53. * @internal
  54. */
  55. public function markResolved(): void
  56. {
  57. $this->resolved = true;
  58. }
  60. public function isResolved(): bool
  61. {
  62. return $this->resolved;
  63. }
  64. }