fix(serializer): gate cache_key in JsonApi and Hal with isCacheKeySafe#8200
Open
soyuka wants to merge 1 commit into
Open
fix(serializer): gate cache_key in JsonApi and Hal with isCacheKeySafe#8200soyuka wants to merge 1 commit into
soyuka wants to merge 1 commit into
Conversation
`#[ApiProperty(security: ...)]` makes allowed attributes per-user, but the local `componentsCache` in JsonApi and Hal item normalizers is not user-aware: a cached component map can leak attributes across users. Move `isCacheKeySafe()` from `GraphQl/Serializer/ItemNormalizer` into `Serializer/AbstractItemNormalizer` so it is shared across all formats, and gate `$context['cache_key']` with it in JsonApi and Hal. Promote `CacheKeyTrait::getCacheKey()` from `private` to `protected` so subclasses can reuse the inherited trait method. Supersedes api-platform#7854.
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
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.
Summary
#[ApiProperty(security: ...)]makes the set of allowed attributes per-user, but the localcomponentsCachearrays in JsonApi and Hal item normalizers are not user-aware. Without gating, two users hitting the same resource can reuse a cached component map computed for the other user, leaking attributes across users.PR #7854 fixes the related Symfony
AbstractObjectNormalizer::$attributesCacheleak by movingisCacheKeySafe()toAbstractItemNormalizer. JsonApi and Hal, however, set$context['cache_key']themselves before delegating toparent::normalize()and use it for their owncomponentsCache. Since$contextis passed by value, the gating done insideAbstractItemNormalizer::normalize()does not propagate back to those subclasses, so the local cache is still written unconditionally.This PR:
isCacheKeySafe()fromGraphQl/Serializer/ItemNormalizerintoSerializer/AbstractItemNormalizer(supersedes fix: move isCacheKeySafe from GraphQL to AbstractItemNormalizer #7854) and makes itprotectedso subclasses can call it.$context['cache_key']inJsonApi/Serializer/ItemNormalizer::normalize()andHal/Serializer/ItemNormalizer::normalize()withisCacheKeySafe().CacheKeyTrait::getCacheKey()fromprivatetoprotectedso subclasses that inherit the trait viaAbstractItemNormalizercan call the trait method.Test plan
vendor/bin/phpunit src/Serializer/Tests/AbstractItemNormalizerTest.php— passes (4 new tests forisCacheKeySafe()).vendor/bin/phpunit src/JsonApi/Tests/Serializer/ItemNormalizerTest.php— passes (newtestCacheKeyIsFalseWhenAPropertyHasSecurity).vendor/bin/phpunit src/Hal/Tests/Serializer/ItemNormalizerTest.php— passes (newtestCacheKeyIsFalseWhenAPropertyHasSecurity).vendor/bin/phpunit src/GraphQl/Tests/Serializer/ItemNormalizerTest.php— passes (logic moved to parent, GraphQL still benefits via inheritance).vendor/bin/phpunit tests/Functional/JsonApiTest.php tests/Functional/JsonLdTest.php— passes.vendor/bin/phpunit tests/Functional/SecurityPropertyInputDtoTest.php tests/Functional/GraphQl tests/Functional/Uuid— passes.Relates to