[Security] Deprecate the old authentication mechanisms

chalasr · chalasr · commit b7471d5aadcd · 2021-05-19T01:56:41.000+02:00
diff --git a/Firewall/AbstractAuthenticationListener.php b/Firewall/AbstractAuthenticationListener.php
@@ -31,6 +31,8 @@
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', AbstractAuthenticationListener::class);
+
 /**
  * The AbstractAuthenticationListener is the preferred base class for all
  * browser-/HTTP-based authentication requests.
@@ -47,6 +49,8 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 abstract class AbstractAuthenticationListener extends AbstractListener
 {
diff --git a/Firewall/AbstractPreAuthenticatedListener.php b/Firewall/AbstractPreAuthenticatedListener.php
@@ -25,6 +25,8 @@
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', AbstractPreAuthenticatedListener::class);
+
 /**
  * AbstractPreAuthenticatedListener is the base class for all listener that
  * authenticates users based on a pre-authenticated request (like a certificate
@@ -33,6 +35,8 @@
  * @author Fabien Potencier <fabien@symfony.com>
  *
  * @internal
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 abstract class AbstractPreAuthenticatedListener extends AbstractListener
 {
diff --git a/Firewall/AnonymousAuthenticationListener.php b/Firewall/AnonymousAuthenticationListener.php
@@ -19,6 +19,8 @@
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', AnonymousAuthenticationListener::class);
+
 // Help opcache.preload discover always-needed symbols
 class_exists(AnonymousToken::class);
 
@@ -28,7 +30,7 @@ class_exists(AnonymousToken::class);
  *
  * @author Fabien Potencier <fabien@symfony.com>
  *
- * @final
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class AnonymousAuthenticationListener extends AbstractListener
 {
diff --git a/Firewall/BasicAuthenticationListener.php b/Firewall/BasicAuthenticationListener.php
@@ -22,12 +22,16 @@
 use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', AnonymousAuthenticationListener::class);
+
 /**
  * BasicAuthenticationListener implements Basic HTTP authentication.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  *
  * @final
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class BasicAuthenticationListener extends AbstractListener
 {
diff --git a/Firewall/RememberMeListener.php b/Firewall/RememberMeListener.php
@@ -24,12 +24,16 @@
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', RememberMeListener::class);
+
 /**
  * RememberMeListener implements authentication capabilities via a cookie.
  *
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  *
  * @final
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class RememberMeListener extends AbstractListener
 {
diff --git a/Firewall/RemoteUserAuthenticationListener.php b/Firewall/RemoteUserAuthenticationListener.php
@@ -18,11 +18,15 @@
 use Symfony\Component\Security\Core\Exception\BadCredentialsException;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', RemoteUserAuthenticationListener::class);
+
 /**
  * REMOTE_USER authentication listener.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Maxime Douailin <maxime.douailin@gmail.com>
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class RemoteUserAuthenticationListener extends AbstractPreAuthenticatedListener
 {
diff --git a/Firewall/UsernamePasswordFormAuthenticationListener.php b/Firewall/UsernamePasswordFormAuthenticationListener.php
@@ -29,11 +29,15 @@
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', UsernamePasswordFormAuthenticationListener::class);
+
 /**
  * UsernamePasswordFormAuthenticationListener is the default implementation of
  * an authentication via a simple form composed of a username and a password.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class UsernamePasswordFormAuthenticationListener extends AbstractAuthenticationListener
 {
diff --git a/Firewall/UsernamePasswordJsonAuthenticationListener.php b/Firewall/UsernamePasswordJsonAuthenticationListener.php
@@ -36,13 +36,15 @@
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', UsernamePasswordJsonAuthenticationListener::class);
+
 /**
  * UsernamePasswordJsonAuthenticationListener is a stateless implementation of
  * an authentication via a JSON document composed of a username and a password.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  *
- * @final
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class UsernamePasswordJsonAuthenticationListener extends AbstractListener
 {
diff --git a/Firewall/X509AuthenticationListener.php b/Firewall/X509AuthenticationListener.php
@@ -18,10 +18,14 @@
 use Symfony\Component\Security\Core\Exception\BadCredentialsException;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', X509AuthenticationListener::class);
+
 /**
  * X509 authentication listener.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 5.3, use the new authenticator system instead
  */
 class X509AuthenticationListener extends AbstractPreAuthenticatedListener
 {
diff --git a/Tests/Firewall/AbstractPreAuthenticatedListenerTest.php b/Tests/Firewall/AbstractPreAuthenticatedListenerTest.php
@@ -22,6 +22,9 @@
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Http\Firewall\AbstractPreAuthenticatedListener;
 
+/**
+ * @group legacy
+ */
 class AbstractPreAuthenticatedListenerTest extends TestCase
 {
     public function testHandleWithValidValues()
diff --git a/Tests/Firewall/AnonymousAuthenticationListenerTest.php b/Tests/Firewall/AnonymousAuthenticationListenerTest.php
@@ -22,6 +22,9 @@
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Http\Firewall\AnonymousAuthenticationListener;
 
+/**
+ * @group legacy
+ */
 class AnonymousAuthenticationListenerTest extends TestCase
 {
     public function testHandleWithTokenStorageHavingAToken()
diff --git a/Tests/Firewall/BasicAuthenticationListenerTest.php b/Tests/Firewall/BasicAuthenticationListenerTest.php
@@ -26,6 +26,9 @@
 use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
 use Symfony\Component\Security\Http\Firewall\BasicAuthenticationListener;
 
+/**
+ * @group legacy
+ */
 class BasicAuthenticationListenerTest extends TestCase
 {
     public function testHandleWithValidUsernameAndPasswordServerParameters()
diff --git a/Tests/Firewall/RememberMeListenerTest.php b/Tests/Firewall/RememberMeListenerTest.php
@@ -29,6 +29,9 @@
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+/**
+ * @group legacy
+ */
 class RememberMeListenerTest extends TestCase
 {
     public function testOnCoreSecurityDoesNotTryToPopulateNonEmptyTokenStorage()
diff --git a/Tests/Firewall/RemoteUserAuthenticationListenerTest.php b/Tests/Firewall/RemoteUserAuthenticationListenerTest.php
@@ -18,6 +18,9 @@
 use Symfony\Component\Security\Core\Exception\BadCredentialsException;
 use Symfony\Component\Security\Http\Firewall\RemoteUserAuthenticationListener;
 
+/**
+ * @group legacy
+ */
 class RemoteUserAuthenticationListenerTest extends TestCase
 {
     public function testGetPreAuthenticatedData()
diff --git a/Tests/Firewall/SwitchUserListenerTest.php b/Tests/Firewall/SwitchUserListenerTest.php
@@ -30,6 +30,9 @@
 use Symfony\Component\Security\Http\SecurityEvents;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+/**
+ * @group legacy
+ */
 class SwitchUserListenerTest extends TestCase
 {
     private $tokenStorage;
diff --git a/Tests/Firewall/UsernamePasswordFormAuthenticationListenerTest.php b/Tests/Firewall/UsernamePasswordFormAuthenticationListenerTest.php
@@ -32,6 +32,9 @@
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategy;
 use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
 
+/**
+ * @group legacy
+ */
 class UsernamePasswordFormAuthenticationListenerTest extends TestCase
 {
     /**
diff --git a/Tests/Firewall/UsernamePasswordJsonAuthenticationListenerTest.php b/Tests/Firewall/UsernamePasswordJsonAuthenticationListenerTest.php
@@ -33,6 +33,8 @@
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @group legacy
  */
 class UsernamePasswordJsonAuthenticationListenerTest extends TestCase
 {
diff --git a/Tests/Firewall/X509AuthenticationListenerTest.php b/Tests/Firewall/X509AuthenticationListenerTest.php
@@ -18,6 +18,9 @@
 use Symfony\Component\Security\Core\Exception\BadCredentialsException;
 use Symfony\Component\Security\Http\Firewall\X509AuthenticationListener;
 
+/**
+ * @group legacy
+ */
 class X509AuthenticationListenerTest extends TestCase
 {
     /**

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;`
`20`	`20`	`use Symfony\Component\Security\Core\Exception\AuthenticationException;`
`21`	`21`
	`22`	`+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', AnonymousAuthenticationListener::class);`
	`23`	`+`
`22`	`24`	`// Help opcache.preload discover always-needed symbols`
`23`	`25`	`class_exists(AnonymousToken::class);`
`24`	`26`
`@@ -28,7 +30,7 @@ class_exists(AnonymousToken::class);`
`28`	`30`	`*`
`29`	`31`	`* @author Fabien Potencier <[email protected]>`
`30`	`32`	`*`
`31`		`- * @final`
	`33`	`+ * @deprecated since Symfony 5.3, use the new authenticator system instead`
`32`	`34`	`*/`
`33`	`35`	`class AnonymousAuthenticationListener extends AbstractListener`
`34`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,16 @@`
`22`	`22`	`use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;`
`23`	`23`	`use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;`
`24`	`24`
	`25`	`+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', AnonymousAuthenticationListener::class);`
	`26`	`+`
`25`	`27`	`/**`
`26`	`28`	`* BasicAuthenticationListener implements Basic HTTP authentication.`
`27`	`29`	`*`
`28`	`30`	`* @author Fabien Potencier <[email protected]>`
`29`	`31`	`*`
`30`	`32`	`* @final`
	`33`	`+ *`
	`34`	`+ * @deprecated since Symfony 5.3, use the new authenticator system instead`
`31`	`35`	`*/`
`32`	`36`	`class BasicAuthenticationListener extends AbstractListener`
`33`	`37`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,16 @@`
`24`	`24`	`use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;`
`25`	`25`	`use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;`
`26`	`26`
	`27`	`+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', RememberMeListener::class);`
	`28`	`+`
`27`	`29`	`/**`
`28`	`30`	`* RememberMeListener implements authentication capabilities via a cookie.`
`29`	`31`	`*`
`30`	`32`	`* @author Johannes M. Schmitt <[email protected]>`
`31`	`33`	`*`
`32`	`34`	`* @final`
	`35`	`+ *`
	`36`	`+ * @deprecated since Symfony 5.3, use the new authenticator system instead`
`33`	`37`	`*/`
`34`	`38`	`class RememberMeListener extends AbstractListener`
`35`	`39`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,13 +36,15 @@`
`36`	`36`	`use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;`
`37`	`37`	`use Symfony\Contracts\Translation\TranslatorInterface;`
`38`	`38`
	`39`	`+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', UsernamePasswordJsonAuthenticationListener::class);`
	`40`	`+`
`39`	`41`	`/**`
`40`	`42`	`* UsernamePasswordJsonAuthenticationListener is a stateless implementation of`
`41`	`43`	`* an authentication via a JSON document composed of a username and a password.`
`42`	`44`	`*`
`43`	`45`	`* @author Kévin Dunglas <[email protected]>`
`44`	`46`	`*`
`45`		`- * @final`
	`47`	`+ * @deprecated since Symfony 5.3, use the new authenticator system instead`
`46`	`48`	`*/`
`47`	`49`	`class UsernamePasswordJsonAuthenticationListener extends AbstractListener`
`48`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,14 @@`
`18`	`18`	`use Symfony\Component\Security\Core\Exception\BadCredentialsException;`
`19`	`19`	`use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;`
`20`	`20`
	`21`	`+trigger_deprecation('symfony/security-http', '5.3', 'The "%s" class is deprecated, use the new authenticator system instead.', X509AuthenticationListener::class);`
	`22`	`+`
`21`	`23`	`/**`
`22`	`24`	`* X509 authentication listener.`
`23`	`25`	`*`
`24`	`26`	`* @author Fabien Potencier <[email protected]>`
	`27`	`+ *`
	`28`	`+ * @deprecated since Symfony 5.3, use the new authenticator system instead`
`25`	`29`	`*/`
`26`	`30`	`class X509AuthenticationListener extends AbstractPreAuthenticatedListener`
`27`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`	`use Symfony\Component\Security\Core\Exception\AuthenticationException;`
`23`	`23`	`use Symfony\Component\Security\Http\Firewall\AbstractPreAuthenticatedListener;`
`24`	`24`
	`25`	`+/**`
	`26`	`+ * @group legacy`
	`27`	`+ */`
`25`	`28`	`class AbstractPreAuthenticatedListenerTest extends TestCase`
`26`	`29`	`{`
`27`	`30`	`public function testHandleWithValidValues()`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@`
`26`	`26`	`use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;`
`27`	`27`	`use Symfony\Component\Security\Http\Firewall\BasicAuthenticationListener;`
`28`	`28`
	`29`	`+/**`
	`30`	`+ * @group legacy`
	`31`	`+ */`
`29`	`32`	`class BasicAuthenticationListenerTest extends TestCase`
`30`	`33`	`{`
`31`	`34`	`public function testHandleWithValidUsernameAndPasswordServerParameters()`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@`
`29`	`29`	`use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;`
`30`	`30`	`use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;`
`31`	`31`
	`32`	`+/**`
	`33`	`+ * @group legacy`
	`34`	`+ */`
`32`	`35`	`class RememberMeListenerTest extends TestCase`
`33`	`36`	`{`
`34`	`37`	`public function testOnCoreSecurityDoesNotTryToPopulateNonEmptyTokenStorage()`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@`
`18`	`18`	`use Symfony\Component\Security\Core\Exception\BadCredentialsException;`
`19`	`19`	`use Symfony\Component\Security\Http\Firewall\RemoteUserAuthenticationListener;`
`20`	`20`
	`21`	`+/**`
	`22`	`+ * @group legacy`
	`23`	`+ */`
`21`	`24`	`class RemoteUserAuthenticationListenerTest extends TestCase`
`22`	`25`	`{`
`23`	`26`	`public function testGetPreAuthenticatedData()`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,9 @@`
`30`	`30`	`use Symfony\Component\Security\Http\SecurityEvents;`
`31`	`31`	`use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;`
`32`	`32`
	`33`	`+/**`
	`34`	`+ * @group legacy`
	`35`	`+ */`
`33`	`36`	`class SwitchUserListenerTest extends TestCase`
`34`	`37`	`{`
`35`	`38`	`private $tokenStorage;`