Skip to content

[Security] Add a normalization step for the user-identifier in firewalls #51744

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
fabpot merged 1 commit into from
Feb 7, 2025
Merged

[Security] Add a normalization step for the user-identifier in firewalls #51744

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
16 changes: 13 additions & 3 deletions src/Symfony/Component/Security/Http/Authenticator/Passport/Badge/UserBadge.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class UserBadge implements BadgeInterface
/** @var callable|null */
private $userLoader;
private UserInterface $user;
private ?\Closure $identifierNormalizer = null;

/**
* Initializes the user badge.
Expand All @@ -51,6 +52,7 @@ public function __construct(
private string $userIdentifier,
?callable $userLoader = null,
private ?array $attributes = null,
?\Closure $identifierNormalizer = null,
) {
if ('' === $userIdentifier) {
trigger_deprecation('symfony/security-http', '7.2', 'Using an empty string as user identifier is deprecated and will throw an exception in Symfony 8.0.');
Expand All @@ -60,12 +62,20 @@ public function __construct(
if (\strlen($userIdentifier) > self::MAX_USERNAME_LENGTH) {
throw new BadCredentialsException('Username too long.');
}
if ($identifierNormalizer) {
$this->identifierNormalizer = static fn () => $identifierNormalizer($userIdentifier);
}

$this->userLoader = $userLoader;
}

public function getUserIdentifier(): string
{
if (isset($this->identifierNormalizer)) {
$this->userIdentifier = ($this->identifierNormalizer)();
$this->identifierNormalizer = null;
}

return $this->userIdentifier;
}

Expand All @@ -88,15 +98,15 @@ public function getUser(): UserInterface
}

if (null === $this->getAttributes()) {
$user = ($this->userLoader)($this->userIdentifier);
$user = ($this->userLoader)($this->getUserIdentifier());
} else {
$user = ($this->userLoader)($this->userIdentifier, $this->getAttributes());
$user = ($this->userLoader)($this->getUserIdentifier(), $this->getAttributes());
}

// No user has been found via the $this->userLoader callback
if (null === $user) {
$exception = new UserNotFoundException();
$exception->setUserIdentifier($this->userIdentifier);
$exception->setUserIdentifier($this->getUserIdentifier());

throw $exception;
}
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Security/Http/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* Add encryption support to `OidcTokenHandler` (JWE)
* Replace `$hideAccountStatusExceptions` argument with `$exposeSecurityErrors` in `AuthenticatorManager` constructor
* Add argument `$identifierNormalizer` to `UserBadge::__construct()` to allow normalizing the identifier

7.2
---
Expand Down
33 changes: 33 additions & 0 deletions src/Symfony/Component/Security/Http/Tests/Authenticator/Passport/Badge/UserBadgeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
use Symfony\Bridge\PhpUnit\ExpectUserDeprecationMessageTrait;
use Symfony\Component\Security\Core\Exception\UserNotFoundException;
use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
use Symfony\Component\String\Slugger\AsciiSlugger;
use Symfony\Component\String\UnicodeString;

use function Symfony\Component\String\u;

class UserBadgeTest extends TestCase
{
Expand All @@ -36,4 +40,33 @@ public function testEmptyUserIdentifier()
// $this->expectException(BadCredentialsException::class)
new UserBadge('', fn () => null);
}

/**
* @dataProvider provideUserIdentifierNormalizationData
*/
public function testUserIdentifierNormalization(string $identifier, string $expectedNormalizedIdentifier, callable $normalizer)
{
$badge = new UserBadge($identifier, fn () => null, identifierNormalizer: $normalizer);

static::assertSame($expectedNormalizedIdentifier, $badge->getUserIdentifier());
}

public static function provideUserIdentifierNormalizationData(): iterable
{
$lowerAndNFKC = static fn (string $identifier) => u($identifier)->normalize(UnicodeString::NFKC)->lower()->toString();
yield 'Simple lower conversion' => ['SmiTh', 'smith', $lowerAndNFKC];
yield 'Normalize fi to fi. Other unicode characters are preserved (р, с, ѕ and а)' => ['рrinсeѕѕ.fionа', 'рrinсeѕѕ.fionа', $lowerAndNFKC];
yield 'Greek characters' => ['ΝιΚόΛΑος', 'νικόλαος', $lowerAndNFKC];

$slugger = new AsciiSlugger('en');
$asciiWithPrefix = static fn (string $identifier) => u($slugger->slug($identifier))->ascii()->lower()->prepend('USERID--')->toString();
yield 'Username with prefix' => ['John Doe 1', 'USERID--john-doe-1', $asciiWithPrefix];

if (!\extension_loaded('intl')) {
return;
}
$upperAndAscii = fn (string $identifier) => u($identifier)->ascii()->upper()->toString();
yield 'Greek to ASCII' => ['ΝιΚόΛΑος', 'NIKOLAOS', $upperAndAscii];
yield 'Katakana to ASCII' => ['たなかそういち', 'TANAKASOUICHI', $upperAndAscii];
}
}
Loading