[Security] Do not make PasswordUpgraderInterface a generic #51283
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicolas-grekas
approved these changes
Aug 5, 2023
chalasr
approved these changes
Aug 5, 2023
fabpot
approved these changes
Aug 5, 2023
|
Thank you @wouterj. |
This was referenced Mar 19, 2025
nicolas-grekas
added a commit
that referenced
this pull request
Mar 20, 2025
This PR was squashed before being merged into the 7.3 branch. Discussion ---------- Improve documentation of PasswordUpgraderInterface | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | n/a | License | MIT Implementations of PasswordUpgraderInterface can be called with a user instance that they don't support and are expected to handle it gracefully. Handling it gracefully can be done either by being silent or by throwing an UnsupportedUserException. This is a follow-up of #51283 to document that throwing UnsupportedUserException is actually fine for implementations as the way to handle unsupported users, as shown by the implementation of the ChainUserProvider: https://github.com/symfony/symfony/blob/07e020abdd1ab820ca3c2ead8dfda75ea6e84eae/src/Symfony/Component/Security/Core/User/ChainUserProvider.php#L107-L113 Commits ------- 0784f98 Improve documentation of PasswordUpgraderInterface
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Making
PasswordUpgraderInterfacea generic in 6.3 (#48750) was a mistake. Nothing guarantees that the calling side will only passTUserinto theupgradePassword()method, as there is no way to check which users are supported. Passing a potentially unsupported user is expected behavior and we document in the PHPdoc that the method should silently fail in such cases. The referenced GitHub discussion contains some more details.Removing the generic from the interface creates a static analysis failure in both Psalm and PHPstan. For this reason, I selected the 6.4 branch although this is a bug fix for 6.3. I'm fine with merging this in 6.3 as well, if this feels better.