Skip to content

fix(symfony): validate the classes of the default parameters #8715

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

Open
Maxcastel wants to merge 1 commit into
base: 5.0
Choose a base branch
from
Open

fix(symfony): validate the classes of the default parameters #8715

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
12 changes: 12 additions & 0 deletions src/Symfony/Bundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,18 @@ private function addDefaultsSection(ArrayNodeDefinition $rootNode): void
->arrayNode('parameters')
->info('Global parameters applied to all resources and operations.')
->useAttributeAsKey('parameter_class')
->validate()
->always(static function (array $parameters): array {
foreach ($parameters as $name => $parameter) {
$class = $parameter['class'] ?? $name;
if ((isset($parameter['class']) || str_contains((string) $name, '\\')) && !is_subclass_of($class, Parameter::class)) {
throw new InvalidConfigurationException(\sprintf('The default parameter "%s" must reference a class extending "%s", "%s" given.', $name, Parameter::class, $class));
}
}

return $parameters;
})
->end()
->prototype('array')
->ignoreExtraKeys(false)
->children()
Expand Down
40 changes: 40 additions & 0 deletions tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace ApiPlatform\Tests\Symfony\Bundle\DependencyInjection;

use ApiPlatform\Metadata\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\HeaderParameter;
use ApiPlatform\Symfony\Bundle\DependencyInjection\Configuration;
use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use Doctrine\ORM\OptimisticLockException;
Expand Down Expand Up @@ -540,4 +541,43 @@ public function testOauthScopeNaming(): void

$this->assertEquals(['resource:read-write' => 'Read and write resource data'], $config['oauth']['scopes']);
}

public function testDefaultParameters(): void
{
$config = $this->processor->processConfiguration($this->configuration, [
'api_platform' => [
'defaults' => [
'parameters' => [
HeaderParameter::class => ['key' => 'API-Token'],
'request_id' => ['class' => HeaderParameter::class, 'key' => 'Request-ID'],
'api_version' => ['key' => 'api_version'],
],
],
],
]);

$this->assertCount(3, $config['defaults']['parameters']);
}

public static function invalidDefaultParameterProvider(): iterable
{
yield 'unknown class option' => ['api_token', ['class' => 'ApiPlatform\Metadata\HeaderParamter'], 'ApiPlatform\Metadata\HeaderParamter'];
yield 'unknown class as key' => ['ApiPlatform\Metadata\HeaderParamter', ['key' => 'API-Token'], 'ApiPlatform\Metadata\HeaderParamter'];
yield 'not a parameter' => ['api_token', ['class' => \stdClass::class], \stdClass::class];
}

#[DataProvider('invalidDefaultParameterProvider')]
public function testDefaultParametersWithInvalidClass(string $name, array $parameter, string $class): void
{
$this->expectException(InvalidConfigurationException::class);
$this->expectExceptionMessage(\sprintf('The default parameter "%s" must reference a class extending "ApiPlatform\Metadata\Parameter", "%s" given.', $name, $class));

$this->processor->processConfiguration($this->configuration, [
'api_platform' => [
'defaults' => [
'parameters' => [$name => $parameter],
],
],
]);
}
}
Loading