310 lines
10 KiB
PHP
310 lines
10 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This file is part of the Symfony package.
|
||
|
|
*
|
||
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view the LICENSE
|
||
|
|
* file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Symfony\Component\Security\Http\RememberMe;
|
||
|
|
|
||
|
|
use Psr\Log\LoggerInterface;
|
||
|
|
use Symfony\Component\HttpFoundation\Cookie;
|
||
|
|
use Symfony\Component\HttpFoundation\Request;
|
||
|
|
use Symfony\Component\HttpFoundation\Response;
|
||
|
|
use Symfony\Component\Security\Core\Authentication\Token\RememberMeToken;
|
||
|
|
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
|
||
|
|
use Symfony\Component\Security\Core\Exception\AuthenticationException;
|
||
|
|
use Symfony\Component\Security\Core\Exception\CookieTheftException;
|
||
|
|
use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
|
||
|
|
use Symfony\Component\Security\Core\Exception\UserNotFoundException;
|
||
|
|
use Symfony\Component\Security\Core\User\UserInterface;
|
||
|
|
use Symfony\Component\Security\Core\User\UserProviderInterface;
|
||
|
|
use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
|
||
|
|
use Symfony\Component\Security\Http\ParameterBagUtils;
|
||
|
|
|
||
|
|
trigger_deprecation('symfony/security-http', '5.4', 'The "%s" class is deprecated, use "%s" instead.', AbstractRememberMeServices::class, AbstractRememberMeHandler::class);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Base class implementing the RememberMeServicesInterface.
|
||
|
|
*
|
||
|
|
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
|
||
|
|
*
|
||
|
|
* @deprecated since Symfony 5.4, use {@see AbstractRememberMeHandler} instead
|
||
|
|
*/
|
||
|
|
abstract class AbstractRememberMeServices implements RememberMeServicesInterface, LogoutHandlerInterface
|
||
|
|
{
|
||
|
|
public const COOKIE_DELIMITER = ':';
|
||
|
|
|
||
|
|
protected $logger;
|
||
|
|
protected $options = [
|
||
|
|
'secure' => false,
|
||
|
|
'httponly' => true,
|
||
|
|
'samesite' => null,
|
||
|
|
'path' => null,
|
||
|
|
'domain' => null,
|
||
|
|
];
|
||
|
|
private $firewallName;
|
||
|
|
private $secret;
|
||
|
|
private $userProviders;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
*/
|
||
|
|
public function __construct(iterable $userProviders, string $secret, string $firewallName, array $options = [], LoggerInterface $logger = null)
|
||
|
|
{
|
||
|
|
if (empty($secret)) {
|
||
|
|
throw new \InvalidArgumentException('$secret must not be empty.');
|
||
|
|
}
|
||
|
|
if ('' === $firewallName) {
|
||
|
|
throw new \InvalidArgumentException('$firewallName must not be empty.');
|
||
|
|
}
|
||
|
|
if (!\is_array($userProviders) && !$userProviders instanceof \Countable) {
|
||
|
|
$userProviders = iterator_to_array($userProviders, false);
|
||
|
|
}
|
||
|
|
if (0 === \count($userProviders)) {
|
||
|
|
throw new \InvalidArgumentException('You must provide at least one user provider.');
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->userProviders = $userProviders;
|
||
|
|
$this->secret = $secret;
|
||
|
|
$this->firewallName = $firewallName;
|
||
|
|
$this->options = array_merge($this->options, $options);
|
||
|
|
$this->logger = $logger;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the parameter that is used for checking whether remember-me
|
||
|
|
* services have been requested.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getRememberMeParameter()
|
||
|
|
{
|
||
|
|
return $this->options['remember_me_parameter'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getSecret()
|
||
|
|
{
|
||
|
|
return $this->secret;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implementation of RememberMeServicesInterface. Detects whether a remember-me
|
||
|
|
* cookie was set, decodes it, and hands it to subclasses for further processing.
|
||
|
|
*
|
||
|
|
* @throws CookieTheftException
|
||
|
|
* @throws \RuntimeException
|
||
|
|
*/
|
||
|
|
final public function autoLogin(Request $request): ?TokenInterface
|
||
|
|
{
|
||
|
|
if (($cookie = $request->attributes->get(self::COOKIE_ATTR_NAME)) && null === $cookie->getValue()) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (null === $cookie = $request->cookies->get($this->options['name'])) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->debug('Remember-me cookie detected.');
|
||
|
|
}
|
||
|
|
|
||
|
|
$cookieParts = $this->decodeCookie($cookie);
|
||
|
|
|
||
|
|
try {
|
||
|
|
$user = $this->processAutoLoginCookie($cookieParts, $request);
|
||
|
|
|
||
|
|
if (!$user instanceof UserInterface) {
|
||
|
|
throw new \RuntimeException('processAutoLoginCookie() must return a UserInterface implementation.');
|
||
|
|
}
|
||
|
|
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->info('Remember-me cookie accepted.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return new RememberMeToken($user, $this->firewallName, $this->secret);
|
||
|
|
} catch (CookieTheftException $e) {
|
||
|
|
$this->loginFail($request, $e);
|
||
|
|
|
||
|
|
throw $e;
|
||
|
|
} catch (UserNotFoundException $e) {
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->info('User for remember-me cookie not found.', ['exception' => $e]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->loginFail($request, $e);
|
||
|
|
} catch (UnsupportedUserException $e) {
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->warning('User class for remember-me cookie not supported.', ['exception' => $e]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->loginFail($request, $e);
|
||
|
|
} catch (AuthenticationException $e) {
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->debug('Remember-Me authentication failed.', ['exception' => $e]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->loginFail($request, $e);
|
||
|
|
} catch (\Exception $e) {
|
||
|
|
$this->loginFail($request, $e);
|
||
|
|
|
||
|
|
throw $e;
|
||
|
|
}
|
||
|
|
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implementation for LogoutHandlerInterface. Deletes the cookie.
|
||
|
|
*/
|
||
|
|
public function logout(Request $request, Response $response, TokenInterface $token)
|
||
|
|
{
|
||
|
|
$this->cancelCookie($request);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implementation for RememberMeServicesInterface. Deletes the cookie when
|
||
|
|
* an attempted authentication fails.
|
||
|
|
*/
|
||
|
|
final public function loginFail(Request $request, \Exception $exception = null)
|
||
|
|
{
|
||
|
|
$this->cancelCookie($request);
|
||
|
|
$this->onLoginFail($request, $exception);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implementation for RememberMeServicesInterface. This is called when an
|
||
|
|
* authentication is successful.
|
||
|
|
*/
|
||
|
|
final public function loginSuccess(Request $request, Response $response, TokenInterface $token)
|
||
|
|
{
|
||
|
|
// Make sure any old remember-me cookies are cancelled
|
||
|
|
$this->cancelCookie($request);
|
||
|
|
|
||
|
|
if (!$token->getUser() instanceof UserInterface) {
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->debug('Remember-me ignores token since it does not contain a UserInterface implementation.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$this->isRememberMeRequested($request)) {
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->debug('Remember-me was not requested.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->debug('Remember-me was requested; setting cookie.');
|
||
|
|
}
|
||
|
|
|
||
|
|
// Remove attribute from request that sets a NULL cookie.
|
||
|
|
// It was set by $this->cancelCookie()
|
||
|
|
// (cancelCookie does other things too for some RememberMeServices
|
||
|
|
// so we should still call it at the start of this method)
|
||
|
|
$request->attributes->remove(self::COOKIE_ATTR_NAME);
|
||
|
|
|
||
|
|
$this->onLoginSuccess($request, $response, $token);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Subclasses should validate the cookie and do any additional processing
|
||
|
|
* that is required. This is called from autoLogin().
|
||
|
|
*
|
||
|
|
* @return UserInterface
|
||
|
|
*/
|
||
|
|
abstract protected function processAutoLoginCookie(array $cookieParts, Request $request);
|
||
|
|
|
||
|
|
protected function onLoginFail(Request $request, \Exception $exception = null)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This is called after a user has been logged in successfully, and has
|
||
|
|
* requested remember-me capabilities. The implementation usually sets a
|
||
|
|
* cookie and possibly stores a persistent record of it.
|
||
|
|
*/
|
||
|
|
abstract protected function onLoginSuccess(Request $request, Response $response, TokenInterface $token);
|
||
|
|
|
||
|
|
final protected function getUserProvider(string $class): UserProviderInterface
|
||
|
|
{
|
||
|
|
foreach ($this->userProviders as $provider) {
|
||
|
|
if ($provider->supportsClass($class)) {
|
||
|
|
return $provider;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new UnsupportedUserException(sprintf('There is no user provider for user "%s". Shouldn\'t the "supportsClass()" method of your user provider return true for this classname?', $class));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Decodes the raw cookie value.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
protected function decodeCookie(string $rawCookie)
|
||
|
|
{
|
||
|
|
return explode(self::COOKIE_DELIMITER, base64_decode($rawCookie));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Encodes the cookie parts.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException When $cookieParts contain the cookie delimiter. Extending class should either remove or escape it.
|
||
|
|
*/
|
||
|
|
protected function encodeCookie(array $cookieParts)
|
||
|
|
{
|
||
|
|
foreach ($cookieParts as $cookiePart) {
|
||
|
|
if (str_contains($cookiePart, self::COOKIE_DELIMITER)) {
|
||
|
|
throw new \InvalidArgumentException(sprintf('$cookieParts should not contain the cookie delimiter "%s".', self::COOKIE_DELIMITER));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return base64_encode(implode(self::COOKIE_DELIMITER, $cookieParts));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Deletes the remember-me cookie.
|
||
|
|
*/
|
||
|
|
protected function cancelCookie(Request $request)
|
||
|
|
{
|
||
|
|
if (null !== $this->logger) {
|
||
|
|
$this->logger->debug('Clearing remember-me cookie.', ['name' => $this->options['name']]);
|
||
|
|
}
|
||
|
|
|
||
|
|
$request->attributes->set(self::COOKIE_ATTR_NAME, new Cookie($this->options['name'], null, 1, $this->options['path'], $this->options['domain'], $this->options['secure'] ?? $request->isSecure(), $this->options['httponly'], false, $this->options['samesite']));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether remember-me capabilities were requested.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
protected function isRememberMeRequested(Request $request)
|
||
|
|
{
|
||
|
|
if (true === $this->options['always_remember_me']) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
$parameter = ParameterBagUtils::getRequestParameterValue($request, $this->options['remember_me_parameter']);
|
||
|
|
|
||
|
|
if (null === $parameter && null !== $this->logger) {
|
||
|
|
$this->logger->debug('Did not send remember-me cookie.', ['parameter' => $this->options['remember_me_parameter']]);
|
||
|
|
}
|
||
|
|
|
||
|
|
return 'true' === $parameter || 'on' === $parameter || '1' === $parameter || 'yes' === $parameter || true === $parameter;
|
||
|
|
}
|
||
|
|
}
|