8000 [PasswordHasher] UserPasswordHasher only calls getSalt when method exists by dbrumann · Pull Request #41755 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[PasswordHasher] UserPasswordHasher only calls getSalt when method exists #41755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 21, 2021
Merged

[PasswordHasher] UserPasswordHasher only calls getSalt when method exists #41755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions src/Symfony/Component/PasswordHasher/Hasher/UserPasswordHasher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,16 @@ public function hashPassword($user, string $plainPassword): string
trigger_deprecation('symfony/password-hasher', '5.3', 'The "%s()" method expects a "%s" instance as first argument. Not implementing it in class "%s" is deprecated.', __METHOD__, PasswordAuthenticatedUserInterface::class, get_debug_type($user));
}

$salt = $user->getSalt();
if ($salt && !$user instanceof LegacyPasswordAuthenticatedUserInterface) {
trigger_deprecation('symfony/password-hasher', '5.3', 'Returning a string from "getSalt()" without implementing the "%s" interface is deprecated, the "%s" class should implement it.', LegacyPasswordAuthenticatedUserInterface::class, get_debug_type($user));
$salt = null;

if ($user instanceof LegacyPasswordAuthenticatedUserInterface) {
$salt = $user->getSalt();
} elseif ($user instanceof UserInterface) {
$salt = $user->getSalt();

if (null !== $salt) {
trigger_deprecation('symfony/password-hasher', '5.3', 'Returning a string from "getSalt()" without implementing the "%s" interface is deprecated, the "%s" class should implement it.', LegacyPasswordAuthenticatedUserInterface::class, get_debug_type($user));
}
}

$hasher = $this->hasherFactory->getPasswordHasher($user);
Expand All @@ -65,9 +72,16 @@ public function isPasswordValid($user, string $plainPassword): bool
trigger_deprecation('symfony/password-hasher', '5.3', 'The "%s()" method expects a "%s" instance as first argument. Not implementing it in class "%s" is deprecated.', __METHOD__, PasswordAuthenticatedUserInterface::class, get_debug_type($user));
}

$salt = $user->getSalt();
if ($salt && !$user instanceof LegacyPasswordAuthenticatedUserInterface) {
trigger_deprecation('symfony/password-hasher', '5.3', 'Returning a string from "getSalt()" without implementing the "%s" interface is deprecated, the "%s" class should implement it.', LegacyPasswordAuthenticatedUserInterface::class, get_debug_type($user));
$salt = null;

if ($user instanceof LegacyPasswordAuthenticatedUserInterface) {
$salt = $user->getSalt();
} elseif ($user instanceof UserInterface) {
$salt = $user->getSalt();

if (null !== $salt) {
trigger_deprecation('symfony/password-hasher', '5.3', 'Returning a string from "getSalt()" without implementing the "%s" interface is deprecated, the "%s" class should implement it.', LegacyPasswordAuthenticatedUserInterface::class, get_debug_type($user));
}
}

if (null === $user->getPassword()) {
Expand Down
53 changes: 53 additions & 0 deletions src/Symfony/Component/PasswordHasher/Tests/Fixtures/TestLegacyPasswordAuthenticatedUser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?php

namespace Symfony\Component\PasswordHasher\Tests\Fixtures;

use Symfony\Component\Security\Core\User\LegacyPasswordAuthenticatedUserInterface;
use Symfony\Component\Security\Core\User\UserInterface;

final class TestLegacyPasswordAuthenticatedUser implements LegacyPasswordAuthenticatedUserInterface, UserInterface
{
private $username;
private $password;
private $salt;
private $roles;

public function __construct(string $username, ?string $password = null, ?string $salt = null, array $roles = [])
{
$this->roles = $roles;
$this->salt = $salt;
$this->password = $password;
$this->username = $username;
}

public function getSalt(): ?string
{
return $this->salt;
}

public function getPassword(): ?string
{
return $this->password;
}

public function getRoles()
{
return $this->roles;
}

public function eraseCredentials()
{
// Do nothing
return;
}

public function getUsername()
{
return $this->username;
}

public function getUserIdentifier()
{
return $this->username;
}
}
20 changes: 20 additions & 0 deletions src/Symfony/Component/PasswordHasher/Tests/Fixtures/TestPasswordAuthenticatedUser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

namespace Symfony\Component\PasswordHasher\Tests\Fixtures;

use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;

final class TestPasswordAuthenticatedUser implements PasswordAuthenticatedUserInterface
{
private $password;

public function __construct(?string $password = null)
{
$this->password = $password;
}

public function getPassword(): ?string
{
return $this->password;
}
}
76 changes: 54 additions & 22 deletions src/Symfony/Component/PasswordHasher/Tests/Hasher/UserPasswordHasherTest.php
View file
Open in desktop
EDBE
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
use Symfony\Component\PasswordHasher\Hasher\PasswordHasherFactoryInterface;
use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasher;
use Symfony\Component\PasswordHasher\PasswordHasherInterface;
use Symfony\Component\PasswordHasher\Tests\Fixtures\TestLegacyPasswordAuthenticatedUser;
use Symfony\Component\PasswordHasher\Tests\Fixtures\TestPasswordAuthenticatedUser;
use Symfony\Component\Security\Core\User\InMemoryUser;
use Symfony\Component\Security\Core\User\LegacyPasswordAuthenticatedUserInterface;
use Symfony\Component\Security\Core\User\User;
use Symfony\Component\Security\Core\User\UserInterface;

class UserPasswordHasherTest extends TestCase
{
Expand Down Expand Up @@ -56,12 +56,9 @@ public function testHashWithNonPasswordAuthenticatedUser()
$this->assertEquals('hash', $encoded);
}

public function testHash()
public function testHashWithLegacyUser()
{
$userMock = $this->createMock(TestPasswordAuthenticatedUser::class);
$userMock->expects($this->any())
->method('getSalt')
->willReturn('userSalt');
$user = new TestLegacyPasswordAuthenticatedUser('name', null, 'userSalt');

$mockHasher = $this->createMock(PasswordHasherInterface::class);
$mockHasher->expects($this->any())
Expand All @@ -72,25 +69,42 @@ public function testHash()
$mockPasswordHasherFactory = $this->createMock(PasswordHasherFactoryInterface::class);
$mockPasswordHasherFactory->expects($this->any())
->method('getPasswordHasher')
->with($this->equalTo($userMock))
->with($user)
->willReturn($mockHasher);

$passwordHasher = new UserPasswordHasher($mockPasswordHasherFactory);

$encoded = $passwordHasher->hashPassword($userMock, 'plainPassword');
$encoded = $passwordHasher->hashPassword($user, 'plainPassword');
$this->assertEquals('hash', $encoded);
}

public function testVerify()
public function testHashWithPasswordAuthenticatedUser()
{
$userMock = $this->createMock(TestPasswordAuthenticatedUser::class);
$userMock->expects($this->any())
->method('getSalt')
->willReturn('userSalt');
$userMock->expects($this->any())
->method('getPassword')
$user = new TestPasswordAuthenticatedUser();

$mockHasher = $this->createMock(PasswordHasherInterface::class);
$mockHasher->expects($this->any())
->method('hash')
->with($this->equalTo('plainPassword'), $this->equalTo(null))
->willReturn('hash');

$mockPasswordHasherFactory = $this->createMock(PasswordHasherFactoryInterface::class);
$mockPasswordHasherFactory->expects($this->any())
->method('getPasswordHasher')
->with($user)
->willReturn($mockHasher);

$passwordHasher = new UserPasswordHasher($mockPasswordHasherFactory);

$hashedPassword = $passwordHasher->hashPassword($user, 'plainPassword');

$this->assertSame('hash', $hashedPassword);
}

public function testVerifyWithLegacyUser()
{
$user = new TestLegacyPasswordAuthenticatedUser('user', 'hash', 'userSalt');

$mockHasher = $this->createMock(PasswordHasherInterface::class);
$mockHasher->expects($this->any())
->method('verify')
Expand All @@ -100,12 +114,34 @@ public function testVerify()
$mockPasswordHasherFactory = $this->createMock(PasswordHasherFactoryInterface::class);
$mockPasswordHasherFactory->expects($this->any())
->method('getPasswordHasher')
->with($this->equalTo($userMock))
->with($user)
->willReturn($mockHasher);

$passwordHasher = new UserPasswordHasher($mockPasswordHasherFactory);

$isValid = $passwordHasher->isPasswordValid($user, 'plainPassword');
$this->assertTrue($isValid);
}

public function testVerify()
{
$user = new TestPasswordAuthenticatedUser('hash');

$mockHasher = $this->createMock(PasswordHasherInterface::class);
$mockHasher->expects($this->any())
->method('verify')
->with($this->equalTo('hash'), $this->equalTo('plainPassword'), $this->equalTo(null))
->willReturn(true);

$mockPasswordHasherFactory = $this->createMock(PasswordHasherFactoryInterface::class);
$mockPasswordHasherFactory->expects($this->any())
->method('getPasswordHasher')
->with($user)
->willReturn($mockHasher);

$passwordHasher = new UserPasswordHasher($mockPasswordHasherFactory);

$isValid = $passwordHasher->isPasswordValid($userMock, 'plainPassword');
$isValid = $passwordHasher->isPasswordValid($user, 'plainPassword');
$this->assertTrue($isValid);
}

Expand All @@ -128,7 +164,3 @@ public function testNeedsRehash()
$this->assertFalse($passwordHasher->needsRehash($user));
}
}

abstract class TestPasswordAuthenticatedUser implements LegacyPasswordAuthenticatedUserInterface, UserInterface
{
}
0