Merge branch 'master' of github.com:mevdschee/php-crud-api

Author: mevdschee

README.md

@@ -616,7 +616,7 @@ You can tune the middleware behavior using middleware specific configuration par
 - "jwtAuth.header": Name of the header containing the JWT token ("X-Authorization")
 - "jwtAuth.leeway": The acceptable number of seconds of clock skew ("5")
 - "jwtAuth.ttl": The number of seconds the token is valid ("30")
-- "jwtAuth.secret": The shared secret used to sign the JWT token with ("")
+- "jwtAuth.secrets": The shared secret(s) used to sign the JWT token with ("")
 - "jwtAuth.algorithms": The algorithms that are allowed, empty means 'all' ("")
 - "jwtAuth.audiences": The audiences that are allowed, empty means 'all' ("")
 - "jwtAuth.issuers": The issuers that are allowed, empty means 'all' ("")
@@ -731,7 +731,7 @@ Once logged in, you have to create an application (its type does not matter). Co
 and `Client ID` and keep them for a later use. Then, create an API: give it a name and fill the
 `identifier` field with your API endpoint's URL.
 
-Then you have to configure the `jwtAuth.secret` configuration in your `api.php` file.
+Then you have to configure the `jwtAuth.secrets` configuration in your `api.php` file.
 Don't fill it with the `secret` you will find in your Auth0 application settings but with **a
 public certificate**. To find it, go to the settings of your application, then in "Extra settings".
 You will now find a "Certificates" tab where you will find your Public Key in the Signing
@@ -755,11 +755,11 @@ You can also change the `url` variable, used to test the API with authentication
 First you need to create a Firebase project on the [Firebase console](https://console.firebase.google.com/).
 Add a web application to this project and grab the code snippet for later use.
 
-Then you have to configure the `jwtAuth.secret` configuration in your `api.php` file.
+Then you have to configure the `jwtAuth.secrets` configuration in your `api.php` file.
 Grab the public key via this [URL](https://www.googleapis.com/robot/v1/metadata/x509/[email protected]).
 There may be several certificates, just grab the one corresponding to your `kid` (if you don't
 know what it is, just test them all until you will be logged in).
-Now, just fill `jwtAuth.secret` with your public key.F
+Now, just fill `jwtAuth.secrets` with your public key.
 
 To test your integration, you can copy the [firebase/vanilla.html](examples/clients/firebase/vanilla.html)
 file and the [firebase/vanilla-success.html](examples/clients/firebase/vanilla-success.html) file,

api.php

@@ -121,7 +121,7 @@ public function __construct(Config $config)
                     new CacheController($router, $responder, $cache);
                     break;
                 case 'openapi':
-                    $openApi = new OpenApiService($reflection, $config->getOpenApiBase());
+                    $openApi = new OpenApiService($reflection, $config->getOpenApiBase(), $config->getControllers(), $config->getCustomOpenApiBuilders());
                     new OpenApiController($router, $responder, $openApi);
                     break;
                 case 'geojson':
@@ -131,6 +131,12 @@ public function __construct(Config $config)
                     break;
             }
         }
+        foreach ($config->getCustomControllers() as $className) {
+            if (class_exists($className)) {
+                $records = new RecordService($db, $reflection);
+                new $className($router, $responder, $records);
+            }
+        }
         $this->router = $router;
         $this->responder = $responder;
         $this->debug = $config->getDebug();

src/Tqdev/PhpCrudApi/Api.php

@@ -13,6 +13,8 @@ class Config
         'database' => null,
         'middlewares' => 'cors',
         'controllers' => 'records,geojson,openapi',
+        'customControllers' => '',
+        'customOpenApiBuilders' => '',
         'cacheType' => 'TempFile',
         'cachePath' => '',
         'cacheTime' => 10,
@@ -32,18 +34,24 @@ private function getDefaultDriver(array $values): string
     private function getDefaultPort(string $driver): int
     {
         switch ($driver) {
-            case 'mysql':return 3306;
-            case 'pgsql':return 5432;
-            case 'sqlsrv':return 1433;
+            case 'mysql':
+                return 3306;
+            case 'pgsql':
+                return 5432;
+            case 'sqlsrv':
+                return 1433;
         }
     }
 
     private function getDefaultAddress(string $driver): string
     {
         switch ($driver) {
-            case 'mysql':return 'localhost';
-            case 'pgsql':return 'localhost';
-            case 'sqlsrv':return 'localhost';
+            case 'mysql':
+                return 'localhost';
+            case 'pgsql':
+                return 'localhost';
+            case 'sqlsrv':
+                return 'localhost';
         }
     }
 
@@ -131,7 +139,17 @@ public function getMiddlewares(): array
 
     public function getControllers(): array
     {
-        return array_map('trim', explode(',', $this->values['controllers']));
+        return array_filter(array_map('trim', explode(',', $this->values['controllers'])));
+    }
+
+    public function getCustomControllers(): array
+    {
+        return array_filter(array_map('trim', explode(',', $this->values['customControllers'])));
+    }
+
+    public function getCustomOpenApiBuilders(): array
+    {
+        return array_filter(array_map('trim', explode(',', $this->values['customOpenApiBuilders'])));
     }
 
     public function getCacheType(): string

src/Tqdev/PhpCrudApi/Config.php

@@ -63,6 +63,7 @@ public function __construct(string $driver)
             'datetime' => 'timestamp',
             'year' => 'integer',
             'enum' => 'varchar',
+            'set' => 'varchar',
             'json' => 'clob',
         ],
         'pgsql' => [
@@ -102,7 +103,7 @@ public function __construct(string $driver)
         ],
         // source: https://docs.microsoft.com/en-us/sql/connect/jdbc/using-basic-data-types?view=sql-server-2017
         'sqlsrv' => [
-            'varbinary(0)' => 'blob',
+            'varbinary()' => 'blob',
             'bit' => 'boolean',
             'datetime' => 'timestamp',
             'datetime2' => 'timestamp',

src/Tqdev/PhpCrudApi/Database/TypeConverter.php

@@ -24,6 +24,21 @@ protected function getArrayProperty(string $key, string $default): array
         return array_filter(array_map('trim', explode(',', $this->getProperty($key, $default))));
     }
 
+    protected function getMapProperty(string $key, string $default): array
+    {
+        $pairs = $this->getArrayProperty($key, $default);
+        $result = array();
+        foreach ($pairs as $pair) {
+            if (strpos($pair, ':')) {
+                list($k, $v) = explode(':', $pair, 2);
+                $result[trim($k)] = trim($v);
+            } else {
+                $result[] = trim($pair);
+            }
+        }
+        return $result;
+    }
+
     protected function getProperty(string $key, $default)
     {
         return isset($this->properties[$key]) ? $this->properties[$key] : $default;

src/Tqdev/PhpCrudApi/Middleware/Base/Middleware.php

@@ -5,14 +5,13 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\RequestHandlerInterface;
-use Tqdev\PhpCrudApi\Controller\Responder;
 use Tqdev\PhpCrudApi\Middleware\Base\Middleware;
 use Tqdev\PhpCrudApi\Record\ErrorCode;
 use Tqdev\PhpCrudApi\RequestUtils;
 
 class JwtAuthMiddleware extends Middleware
 {
-    private function getVerifiedClaims(string $token, int $time, int $leeway, int $ttl, string $secret, array $requirements): array
+    private function getVerifiedClaims(string $token, int $time, int $leeway, int $ttl, array $secrets, array $requirements): array
     {
         $algorithms = array(
             'HS256' => 'sha256',
@@ -27,9 +26,14 @@ private function getVerifiedClaims(string $token, int $time, int $leeway, int $t
             return array();
         }
         $header = json_decode(base64_decode(strtr($token[0], '-_', '+/')), true);
-        if (!$secret) {
+        $kid = 0;
+        if (isset($header['kid'])) {
+            $kid = $header['kid'];
+        }
+        if (!isset($secrets[$kid])) {
             return array();
         }
+        $secret = $secrets[$kid];
         if ($header['typ'] != 'JWT') {
             return array();
         }
@@ -93,16 +97,16 @@ private function getClaims(string $token): array
         $time = (int) $this->getProperty('time', time());
         $leeway = (int) $this->getProperty('leeway', '5');
         $ttl = (int) $this->getProperty('ttl', '30');
-        $secret = $this->getProperty('secret', '');
+        $secrets = $this->getMapProperty('secrets', '');
+        if (!$secrets) {
+            $secrets = [$this->getProperty('secret', '')];
+        }
         $requirements = array(
             'alg' => $this->getArrayProperty('algorithms', ''),
             'aud' => $this->getArrayProperty('audiences', ''),
             'iss' => $this->getArrayProperty('issuers', ''),
         );
-        if (!$secret) {
-            return array();
-        }
-        return $this->getVerifiedClaims($token, $time, $leeway, $ttl, $secret, $requirements);
+        return $this->getVerifiedClaims($token, $time, $leeway, $ttl, $secrets, $requirements);
     }
 
     private function getAuthorizationToken(ServerRequestInterface $request): string

src/Tqdev/PhpCrudApi/Middleware/JwtAuthMiddleware.php

@@ -10,12 +10,17 @@ class OpenApiBuilder
     private $openapi;
     private $records;
     private $columns;
+    private $builders;
 
-    public function __construct(ReflectionService $reflection, $base)
+    public function __construct(ReflectionService $reflection, array $base, array $controllers, array $builders)
     {
         $this->openapi = new OpenApiDefinition($base);
-        $this->records = new OpenApiRecordsBuilder($this->openapi, $reflection);
-        $this->columns = new OpenApiColumnsBuilder($this->openapi, $reflection);
+        $this->records = in_array('records', $controllers) ? new OpenApiRecordsBuilder($this->openapi, $reflection) : null;
+        $this->columns = in_array('columns', $controllers) ? new OpenApiColumnsBuilder($this->openapi) : null;
+        $this->builders = array();
+        foreach ($builders as $className) {
+            $this->builders[] = new $className($this->openapi, $reflection);
+        }
     }
 
     private function getServerUrl(): string
@@ -34,7 +39,15 @@ public function build(): OpenApiDefinition
         if (!$this->openapi->has("servers") && isset($_SERVER['REQUEST_URI'])) {
             $this->openapi->set("servers|0|url", $this->getServerUrl());
         }
-        $this->records->build();
+        if ($this->records) {
+            $this->records->build();
+        }
+        if ($this->columns) {
+            $this->columns->build();
+        }
+        foreach ($this->builders as $builder) {
+            $builder->build();
+        }
         return $this->openapi;
     }
 }