RememberMeListener.php 3.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <?php
  2. namespace Symfony\Component\Security\Http\Firewall;
  3. use Symfony\Component\HttpKernel\Log\LoggerInterface;
  4. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  5. use Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface;
  6. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  7. use Symfony\Component\Security\Core\SecurityContextInterface;
  8. use Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface;
  9. use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
  10. use Symfony\Component\Security\Http\SecurityEvents;
  11. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  12. /*
  13. * This file is part of the Symfony framework.
  14. *
  15. * (c) Fabien Potencier <fabien@symfony.com>
  16. *
  17. * This source file is subject to the MIT license that is bundled
  18. * with this source code in the file LICENSE.
  19. */
  20. /**
  21. * RememberMeListener implements authentication capabilities via a cookie
  22. *
  23. * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  24. */
  25. class RememberMeListener implements ListenerInterface
  26. {
  27. private $securityContext;
  28. private $rememberMeServices;
  29. private $authenticationManager;
  30. private $logger;
  31. private $dispatcher;
  32. /**
  33. * Constructor
  34. *
  35. * @param SecurityContextInterface $securityContext
  36. * @param RememberMeServicesInterface $rememberMeServices
  37. * @param AuthenticationManagerInterface $authenticationManager
  38. * @param LoggerInterface $logger
  39. * @param EventDispatcherInterface $dispatcher
  40. */
  41. public function __construct(SecurityContextInterface $securityContext, RememberMeServicesInterface $rememberMeServices, AuthenticationManagerInterface $authenticationManager, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null)
  42. {
  43. $this->securityContext = $securityContext;
  44. $this->rememberMeServices = $rememberMeServices;
  45. $this->authenticationManager = $authenticationManager;
  46. $this->logger = $logger;
  47. $this->dispatcher = $dispatcher;
  48. }
  49. /**
  50. * Handles remember-me cookie based authentication.
  51. *
  52. * @param GetResponseEvent $event A GetResponseEvent instance
  53. */
  54. public function handle(GetResponseEvent $event)
  55. {
  56. if (null !== $this->securityContext->getToken()) {
  57. return;
  58. }
  59. $request = $event->getRequest();
  60. if (null === $token = $this->rememberMeServices->autoLogin($request)) {
  61. return;
  62. }
  63. try {
  64. $token = $this->authenticationManager->authenticate($token);
  65. $this->securityContext->setToken($token);
  66. if (null !== $this->dispatcher) {
  67. $loginEvent = new InteractiveLoginEvent($request, $token);
  68. $this->dispatcher->dispatch(SecurityEvents::INTERACTIVE_LOGIN, $loginEvent);
  69. }
  70. if (null !== $this->logger) {
  71. $this->logger->debug('SecurityContext populated with remember-me token.');
  72. }
  73. } catch (AuthenticationException $failed) {
  74. if (null !== $this->logger) {
  75. $this->logger->warn(
  76. 'SecurityContext not populated with remember-me token as the'
  77. .' AuthenticationManager rejected the AuthenticationToken returned'
  78. .' by the RememberMeServices: '.$failed->getMessage()
  79. );
  80. }
  81. $this->rememberMeServices->loginFail($request);
  82. }
  83. }
  84. }