8000 [Security] Disallow passing a UserInterface to Passport · symfony/symfony@99cf2a3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 99cf2a3

Browse files
wouterjfabpot
wouterj
authored and
fabpot
committed
[Security] Disallow passing a UserInterface to Passport
This was deprecated in 5.2, with a warning that support would be dropped in 5.3 (due to the experimental state).
1 parent 49d23d4 commit 99cf2a3

File tree

5 files changed

+6
-36
lines changed

5 files changed

+6
-36
lines changed

‎UPGRADE-5.3.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ Security
9191
If you are using the `isAccountNonLocked()`, `isAccountNonExpired()` or `isCredentialsNonExpired()` method, consider re-implementing
9292
them in your own user class, as they are not part of the `InMemoryUser` API
9393
* Deprecate class `UserChecker`, use `InMemoryUserChecker` or your own implementation instead
94+
* [BC break] Remove support for passing a `UserInterface` implementation to `Passport`, use the `UserBadge` instead.
9495
* Deprecate `UserInterface::getPassword()`
9596
If your `getPassword()` method does not return `null` (i.e. you are using password-based authentication),
9697
you should implement `PasswordAuthenticatedUserInterface`.

‎src/Symfony/Component/Security/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ CHANGELOG
66

77
* Deprecate class `User`, use `InMemoryUser` instead
88
* Deprecate class `UserChecker`, use `InMemoryUserChecker` or your own implementation instead
9+
* [BC break] Remove support for passing a `UserInterface` implementation to `Passport`, use the `UserBadge` instead.
910
* Add `PasswordAuthenticatedUserInterface` for user classes that use passwords
1011
* Add `LegacyPasswordAuthenticatedUserInterface` for user classes that use user-provided salts in addition to passwords
1112
* Deprecate all classes in the `Core\Encoder\` sub-namespace, use the `PasswordHasher` component instead

‎src/Symfony/Component/Security/Http/Authenticator/Passport/Passport.php

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,13 @@ class Passport implements UserPassportInterface
3232
private $attributes = [];
3333

3434
/**
35-
* @param UserBadge $userBadge
3635
* @param CredentialsInterface $credentials the credentials to check for this authentication, use
3736
* SelfValidatingPassport if no credentials should be checked
3837
* @param BadgeInterface[] $badges
3938
*/
40-
public function __construct($userBadge, CredentialsInterface $credentials, array $badges = [])
39+
public function __construct(UserBadge $userBadge, CredentialsInterface $credentials, array $badges = [])
4140
{
42-
if ($userBadge instanceof UserInterface) {
43-
trigger_deprecation('symfony/security-http', '5.2', 'The 1st argument of "%s" must be an instance of "%s", support for "%s" will be removed in symfony/security-http 5.3.', __CLASS__, UserBadge::class, UserInterface::class);
44-
45-
$this->user = $userBadge;
46-
} elseif ($userBadge instanceof UserBadge) {
47-
$this->addBadge($userBadge);
48-
} else {
49-
throw new \TypeError(sprintf('Argument 1 of "%s" must be an instance of "%s", "%s" given.', __METHOD__, UserBadge::class, get_debug_type($userBadge)));
50-
}
51-
41+
$this->addBadge($userBadge);
5242
$this->addBadge($credentials);
5343
foreach ($badges as $badge) {
5444
$this->addBadge($badge);

‎src/Symfony/Component/Security/Http/Authenticator/Passport/SelfValidatingPassport.php

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,11 @@
2626
class SelfValidatingPassport extends Passport
2727
{
2828
/**
29-
* @param UserBadge $userBadge
3029
* @param BadgeInterface[] $badges
3130
*/
32-
public function __construct($userBadge, array $badges = [])
31+
public function __construct(UserBadge $userBadge, array $badges = [])
3332
{
34-
if ($userBadge instanceof UserInterface) {
35-
trigger_deprecation('symfony/security-http', '5.2', 'The 1st argument of "%s" must be an instance of "%s", support for "%s" will be removed in symfony/security-http 5.3.', __CLASS__, UserBadge::class, UserInterface::class);
36-
37-
$this->user = $userBadge;
38-
} elseif ($userBadge instanceof UserBadge) {
39-
$this->addBadge($userBadge);
40-
} else {
41-
throw new \TypeError(sprintf('Argument 1 of "%s" must be an instance of "%s", "%s" given.', __METHOD__, UserBadge::class, get_debug_type($userBadge)));
42-
}
43-
33+
$this->addBadge($userBadge);
4434
foreach ($badges as $badge) {
4535
$this->addBadge($badge);
4636
}

‎src/Symfony/Component/Security/Http/Tests/EventListener/UserProviderListenerTest.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,4 @@ public function provideCompletePassports()
6161
{
6262
yield [new SelfValidatingPassport(new UserBadge('wouter', function () {}))];
6363
}
64-
65-
/**
66-
* @group legacy
67-
*/
68-
public function testLegacyUserPassport()
69-
{
70-
$passport = new SelfValidatingPassport($user = $this->createMock(UserInterface::class));
71-
$this->listener->checkPassport(new CheckPassportEvent($this->createMock(AuthenticatorInterface::class), $passport));
72-
73-
$this->assertFalse($passport->hasBadge(UserBadge::class));
74-
$this->assertSame($user, $passport->getUser());
75-
}
7664
}

0 commit comments

Comments
 (0)
0