[Security] Deprecate PassportInterface

chalasr · chalasr · commit 0652225a86af · 2021-07-19T21:13:50.000+02:00
diff --git a/src/Symfony/Component/Ldap/Security/LdapAuthenticator.php b/src/Symfony/Component/Ldap/Security/LdapAuthenticator.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
 use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
 
 /**
@@ -53,7 +54,7 @@ public function supports(Request $request): ?bool
         return $this->authenticator->supports($request);
     }
 
-    public function authenticate(Request $request): PassportInterface
+    public function authenticate(Request $request): Passport
     {
         $passport = $this->authenticator->authenticate($request);
         $passport->addBadge(new LdapBadge($this->ldapServiceId, $this->dnString, $this->searchDn, $this->searchPassword, $this->queryString));
diff --git a/src/Symfony/Component/Security/Http/Authenticator/AuthenticatorInterface.php b/src/Symfony/Component/Security/Http/Authenticator/AuthenticatorInterface.php
@@ -15,6 +15,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
 use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
 
 /**
@@ -47,8 +48,10 @@ public function supports(Request $request): ?bool;
      * a UserNotFoundException when the user cannot be found).
      *
      * @throws AuthenticationException
+     *
+     * @return Passport
      */
-    public function authenticate(Request $request): PassportInterface;
+    public function authenticate(Request $request); /*: Passport;*/
 
     /**
      * Create an authenticated token for the given user.
@@ -59,7 +62,7 @@ public function authenticate(Request $request): PassportInterface;
      *
      * @see AbstractAuthenticator
      *
-     * @param PassportInterface $passport The passport returned from authenticate()
+     * @param Passport $passport The passport returned from authenticate()
      */
     public function createAuthenticatedToken(PassportInterface $passport, string $firewallName): TokenInterface;
 
diff --git a/src/Symfony/Component/Security/Http/Authenticator/FormLoginAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/FormLoginAuthenticator.php
@@ -77,7 +77,7 @@ public function supports(Request $request): bool
             && $this->httpUtils->checkRequestPath($request, $this->options['check_path']);
     }
 
-    public function authenticate(Request $request): PassportInterface
+    public function authenticate(Request $request): Passport
     {
         $credentials = $this->getCredentials($request);
 
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Passport/PassportInterface.php b/src/Symfony/Component/Security/Http/Authenticator/Passport/PassportInterface.php
@@ -21,6 +21,8 @@
  * passport.
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
+ *
+ * @deprecated since Symfony 5.4, use {@link Passport} instead
  */
 interface PassportInterface
 {
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Passport/UserPassportInterface.php b/src/Symfony/Component/Security/Http/Authenticator/Passport/UserPassportInterface.php
@@ -18,6 +18,8 @@
  * Represents a passport for a Security User.
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
+ *
+ * @deprecated since Symfony 5.4, use {@link Passport} instead
  */
 interface UserPassportInterface extends PassportInterface
 {
diff --git a/src/Symfony/Component/Security/Http/CHANGELOG.md b/src/Symfony/Component/Security/Http/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Deprecate not setting the 5th argument (`$exceptionOnNoToken`) of `AccessListener` to `false`
  * Deprecate `DeauthenticatedEvent`, use `TokenDeauthenticatedEvent` instead
+ * Deprecate `PassportInterface`, use `Passport` instead
 
 5.3
 ---

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;`
`17`	`17`	`use Symfony\Component\Security\Core\Exception\AuthenticationException;`
`18`	`18`	`use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;`
	`19`	`+use Symfony\Component\Security\Http\Authenticator\Passport\Passport;`
`19`	`20`	`use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;`
`20`	`21`
`21`	`22`	`/**`
`@@ -53,7 +54,7 @@ public function supports(Request $request): ?bool`
`53`	`54`	`return $this->authenticator->supports($request);`
`54`	`55`	`}`
`55`	`56`
`56`		`- public function authenticate(Request $request): PassportInterface`
	`57`	`+ public function authenticate(Request $request): Passport`
`57`	`58`	`{`
`58`	`59`	`$passport = $this->authenticator->authenticate($request);`
`59`	`60`	`$passport->addBadge(new LdapBadge($this->ldapServiceId, $this->dnString, $this->searchDn, $this->searchPassword, $this->queryString));`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function supports(Request $request): bool`
`77`	`77`	`&& $this->httpUtils->checkRequestPath($request, $this->options['check_path']);`
`78`	`78`	`}`
`79`	`79`
`80`		`- public function authenticate(Request $request): PassportInterface`
	`80`	`+ public function authenticate(Request $request): Passport`
`81`	`81`	`{`
`82`	`82`	`$credentials = $this->getCredentials($request);`
`83`	`83`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`	`* passport.`
`22`	`22`	`*`
`23`	`23`	`* @author Wouter de Jong <wouter@wouterj.nl>`
	`24`	`+ *`
	`25`	`+ * @deprecated since Symfony 5.4, use {@link Passport} instead`
`24`	`26`	`*/`
`25`	`27`	`interface PassportInterface`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@`
`18`	`18`	`* Represents a passport for a Security User.`
`19`	`19`	`*`
`20`	`20`	`* @author Wouter de Jong <wouter@wouterj.nl>`
	`21`	`+ *`
	`22`	`+ * @deprecated since Symfony 5.4, use {@link Passport} instead`
`21`	`23`	`*/`
`22`	`24`	`interface UserPassportInterface extends PassportInterface`
`23`	`25`	`{`