feat(laravel): parameter validator + security

Author: soyuka

src/Laravel/ApiPlatformProvider.php

@@ -107,6 +107,7 @@
 use ApiPlatform\Laravel\Routing\SkolemIriConverter;
 use ApiPlatform\Laravel\Security\ResourceAccessChecker;
 use ApiPlatform\Laravel\State\AccessCheckerProvider;
+use ApiPlatform\Laravel\State\ParameterValidatorProvider;
 use ApiPlatform\Laravel\State\SwaggerUiProcessor;
 use ApiPlatform\Laravel\State\SwaggerUiProvider;
 use ApiPlatform\Laravel\State\ValidateProvider;
@@ -175,6 +176,7 @@
 use ApiPlatform\State\Provider\DeserializeProvider;
 use ApiPlatform\State\Provider\ParameterProvider;
 use ApiPlatform\State\Provider\ReadProvider;
+use ApiPlatform\State\Provider\SecurityParameterProvider;
 use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\State\SerializerContextBuilderInterface;
 use Illuminate\Config\Repository as ConfigRepository;
@@ -463,7 +465,15 @@ public function register(): void
         $this->app->singleton(ParameterProvider::class, function (Application $app) {
             $tagged = iterator_to_array($app->tagged(ParameterProviderInterface::class));
 
-            return new ParameterProvider($app->make(DeserializeProvider::class), new ServiceLocator($tagged));
+            return new ParameterProvider(
+                new ParameterValidatorProvider(
+                    new SecurityParameterProvider(
+                        $app->make(DeserializeProvider::class),
+                        $app->make(ResourceAccessCheckerInterface::class)
+                    ),
+                ),
+                new ServiceLocator($tagged)
+            );
         });
 
         $this->app->singleton(AccessCheckerProvider::class, function (Application $app) {

src/Laravel/State/ParameterValidatorProvider.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Laravel\State;
+
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ParameterNotFound;
+use ApiPlatform\State\ProviderInterface;
+use ApiPlatform\State\Util\ParameterParserTrait;
+use Illuminate\Support\Facades\Validator;
+use Illuminate\Validation\ValidationException;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Validates parameters using the Symfony validator.
+ *
+ * @experimental
+ */
+final class ParameterValidatorProvider implements ProviderInterface
+{
+    use ParameterParserTrait;
+    use ValidationErrorTrait;
+
+    public function __construct(
+        private readonly ?ProviderInterface $decorated = null,
+    ) {
+    }
+
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
+    {
+        if (!($request = $context['request']) instanceof Request) {
+            return $this->decorated->provide($operation, $uriVariables, $context);
+        }
+
+        $operation = $request->attributes->get('_api_operation') ?? $operation;
+        if (!($operation->getQueryParameterValidationEnabled() ?? true)) {
+            return $this->decorated->provide($operation, $uriVariables, $context);
+        }
+
+        $allConstraints = [];
+        foreach ($operation->getParameters() ?? [] as $parameter) {
+            if (!$constraints = $parameter->getConstraints()) {
+                continue;
+            }
+
+            $key = $parameter->getKey();
+            $value = $parameter->getValue();
+            if ($value instanceof ParameterNotFound) {
+                $value = null;
+            }
+
+            foreach ($constraints as $c) {
+                $allConstraints[] = $c;
+            }
+        }
+
+        $validator = Validator::make($request->query(), $allConstraints);
+        if ($validator->fails()) {
+            throw $this->getValidationError($validator, new ValidationException($validator));
+        }
+
+        return $this->decorated->provide($operation, $uriVariables, $context);
+    }
+}

src/Laravel/State/ValidateProvider.php

@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Laravel\State;
 
-use ApiPlatform\Laravel\ApiResource\ValidationError;
 use ApiPlatform\Metadata\Error;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProviderInterface;
@@ -27,6 +26,8 @@
  */
 final class ValidateProvider implements ProviderInterface
 {
+    use ValidationErrorTrait;
+
     /**
      * @param ProviderInterface<object> $inner
      */
@@ -65,21 +66,11 @@ public function provide(Operation $operation, array $uriVariables = [], array $c
             return $body;
         }
 
-        $validator = Validator::make($request->all(), $rules);
+        $validator = Validator::make($request->body(), $rules);
         if ($validator->fails()) {
-            throw $this->getValidationError(new ValidationException($validator));
+            throw $this->getValidationError($validator, new ValidationException($validator));
         }
 
         return $body;
     }
-
-    private function getValidationError(ValidationException $e): ValidationError
-    {
-        $violations = [];
-        foreach ($e->validator->errors()->messages() as $prop => $message) {
-            $violations[] = ['propertyPath' => $prop, 'message' => implode(\PHP_EOL, $message)];
-        }
-
-        return new ValidationError($e->getMessage(), spl_object_hash($e), $e, $violations);
-    }
 }

src/Laravel/State/ValidationErrorTrait.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Laravel\State;
+
+use ApiPlatform\Laravel\ApiResource\ValidationError;
+use Illuminate\Contracts\Validation\Validator;
+use Illuminate\Validation\ValidationException;
+
+trait ValidationErrorTrait
+{
+    private function getValidationError(Validator $validator, ValidationException $e): ValidationError
+    {
+        $errors = $validator->errors();
+        $violations = [];
+        $id = hash('xxh3', implode(',', $errors->keys()));
+        foreach ($errors->messages() as $prop => $message) {
+            $violations[] = ['propertyPath' => $prop, 'message' => implode(\PHP_EOL, $message)];
+        }
+
+        return new ValidationError($e->getMessage(), $id, $e, $violations);
+    }
+}