development keys module setup

2026-05-18 06:29:06 +00:00 · 2024-07-10 07:16:45 +00:00 · 2024-07-10 07:16:45 +00:00 · c21402733f
commit c21402733f
parent c8ee399cb7
6 changed files with 320 additions and 0 deletions
--- a/app/controllers/api/projects.php
+++ b/app/controllers/api/projects.php
@ -1383,6 +1383,207 @@ App::delete('/v1/projects/:projectId/keys/:keyId')
        $response->noContent();
    });

+
+// Development keys
+
+App::post('/v1/projects/:projectId/development-keys')
+    ->desc('Create key')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.write')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'projects')
+    ->label('sdk.method', 'createKey')
+    ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_KEY)
+    ->param('projectId', '', new UID(), 'Project unique ID.')
+    ->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
+    ->param('expire', null, new DatetimeValidator(), 'Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.', true)
+    ->inject('response')
+    ->inject('dbForConsole')
+    ->action(function (string $projectId, string $name, array $scopes, ?string $expire, Response $response, Database $dbForConsole) {
+
+        $project = $dbForConsole->getDocument('projects', $projectId);
+
+        if ($project->isEmpty()) {
+            throw new Exception(Exception::PROJECT_NOT_FOUND);
+        }
+
+        $key = new Document([
+            '$id' => ID::unique(),
+            '$permissions' => [
+                Permission::read(Role::any()),
+                Permission::update(Role::any()),
+                Permission::delete(Role::any()),
+            ],
+            'projectInternalId' => $project->getInternalId(),
+            'projectId' => $project->getId(),
+            'name' => $name,
+            'scopes' => $scopes,
+            'expire' => $expire,
+            'sdks' => [],
+            'accessedAt' => null,
+            'secret' => API_KEY_STANDARD . '_' . \bin2hex(\random_bytes(128)),
+        ]);
+
+        $key = $dbForConsole->createDocument('keys', $key);
+
+        $dbForConsole->purgeCachedDocument('projects', $project->getId());
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_CREATED)
+            ->dynamic($key, Response::MODEL_KEY);
+    });
+
+App::get('/v1/projects/:projectId/keys')
+    ->desc('List keys')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'projects')
+    ->label('sdk.method', 'listKeys')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_KEY_LIST)
+    ->param('projectId', '', new UID(), 'Project unique ID.')
+    ->inject('response')
+    ->inject('dbForConsole')
+    ->action(function (string $projectId, Response $response, Database $dbForConsole) {
+
+        $project = $dbForConsole->getDocument('projects', $projectId);
+
+        if ($project->isEmpty()) {
+            throw new Exception(Exception::PROJECT_NOT_FOUND);
+        }
+
+        $keys = $dbForConsole->find('keys', [
+            Query::equal('projectInternalId', [$project->getInternalId()]),
+            Query::limit(5000),
+        ]);
+
+        $response->dynamic(new Document([
+            'keys' => $keys,
+            'total' => count($keys),
+        ]), Response::MODEL_KEY_LIST);
+    });
+
+App::get('/v1/projects/:projectId/keys/:keyId')
+    ->desc('Get key')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.read')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'projects')
+    ->label('sdk.method', 'getKey')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_KEY)
+    ->param('projectId', '', new UID(), 'Project unique ID.')
+    ->param('keyId', '', new UID(), 'Key unique ID.')
+    ->inject('response')
+    ->inject('dbForConsole')
+    ->action(function (string $projectId, string $keyId, Response $response, Database $dbForConsole) {
+
+        $project = $dbForConsole->getDocument('projects', $projectId);
+
+        if ($project->isEmpty()) {
+            throw new Exception(Exception::PROJECT_NOT_FOUND);
+        }
+
+        $key = $dbForConsole->findOne('keys', [
+            Query::equal('$id', [$keyId]),
+            Query::equal('projectInternalId', [$project->getInternalId()]),
+        ]);
+
+        if ($key === false || $key->isEmpty()) {
+            throw new Exception(Exception::KEY_NOT_FOUND);
+        }
+
+        $response->dynamic($key, Response::MODEL_KEY);
+    });
+
+App::put('/v1/projects/:projectId/keys/:keyId')
+    ->desc('Update key')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.write')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'projects')
+    ->label('sdk.method', 'updateKey')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_KEY)
+    ->param('projectId', '', new UID(), 'Project unique ID.')
+    ->param('keyId', '', new UID(), 'Key unique ID.')
+    ->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
+    ->param('scopes', null, new ArrayList(new WhiteList(array_keys(Config::getParam('scopes')), true), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Key scopes list. Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' events are allowed.')
+    ->param('expire', null, new DatetimeValidator(), 'Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.', true)
+    ->inject('response')
+    ->inject('dbForConsole')
+    ->action(function (string $projectId, string $keyId, string $name, array $scopes, ?string $expire, Response $response, Database $dbForConsole) {
+
+        $project = $dbForConsole->getDocument('projects', $projectId);
+
+        if ($project->isEmpty()) {
+            throw new Exception(Exception::PROJECT_NOT_FOUND);
+        }
+
+        $key = $dbForConsole->findOne('keys', [
+            Query::equal('$id', [$keyId]),
+            Query::equal('projectInternalId', [$project->getInternalId()]),
+        ]);
+
+        if ($key === false || $key->isEmpty()) {
+            throw new Exception(Exception::KEY_NOT_FOUND);
+        }
+
+        $key
+            ->setAttribute('name', $name)
+            ->setAttribute('scopes', $scopes)
+            ->setAttribute('expire', $expire);
+
+        $dbForConsole->updateDocument('keys', $key->getId(), $key);
+
+        $dbForConsole->purgeCachedDocument('projects', $project->getId());
+
+        $response->dynamic($key, Response::MODEL_KEY);
+    });
+
+App::delete('/v1/projects/:projectId/keys/:keyId')
+    ->desc('Delete key')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.write')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'projects')
+    ->label('sdk.method', 'deleteKey')
+    ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
+    ->label('sdk.response.model', Response::MODEL_NONE)
+    ->param('projectId', '', new UID(), 'Project unique ID.')
+    ->param('keyId', '', new UID(), 'Key unique ID.')
+    ->inject('response')
+    ->inject('dbForConsole')
+    ->action(function (string $projectId, string $keyId, Response $response, Database $dbForConsole) {
+
+        $project = $dbForConsole->getDocument('projects', $projectId);
+
+        if ($project->isEmpty()) {
+            throw new Exception(Exception::PROJECT_NOT_FOUND);
+        }
+
+        $key = $dbForConsole->findOne('keys', [
+            Query::equal('$id', [$keyId]),
+            Query::equal('projectInternalId', [$project->getInternalId()]),
+        ]);
+
+        if ($key === false || $key->isEmpty()) {
+            throw new Exception(Exception::KEY_NOT_FOUND);
+        }
+
+        $dbForConsole->deleteDocument('keys', $key->getId());
+
+        $dbForConsole->purgeCachedDocument('projects', $project->getId());
+
+        $response->noContent();
+    });
+
 // JWT Keys

 App::post('/v1/projects/:projectId/jwts')
--- a/app/controllers/general.php
+++ b/app/controllers/general.php
@ -8,6 +8,7 @@ use Appwrite\Event\Event;
 use Appwrite\Event\Usage;
 use Appwrite\Extend\Exception as AppwriteException;
 use Appwrite\Network\Validator\Origin;
+use Appwrite\Platform\Appwrite;
 use Appwrite\Utopia\Request;
 use Appwrite\Utopia\Request\Filters\V16 as RequestV16;
 use Appwrite\Utopia\Request\Filters\V17 as RequestV17;
@ -32,6 +33,7 @@ use Utopia\Locale\Locale;
 use Utopia\Logger\Log;
 use Utopia\Logger\Log\User;
 use Utopia\Logger\Logger;
+use Utopia\Platform\Service;
 use Utopia\System\System;
 use Utopia\Validator\Hostname;
 use Utopia\Validator\Text;
@ -992,3 +994,9 @@ App::wildcard()
 foreach (Config::getParam('services', []) as $service) {
    include_once $service['controller'];
 }
+
+
+// Modules
+
+$platform = new Appwrite();
+$platform->init(Service::TYPE_HTTP);
--- a/src/Appwrite/Platform/Appwrite.php
+++ b/src/Appwrite/Platform/Appwrite.php
@ -3,6 +3,7 @@
 namespace Appwrite\Platform;

 use Appwrite\Platform\Modules\Core;
+use Appwrite\Platform\Modules\DevelopmentKeys;
 use Utopia\Platform\Platform;

 class Appwrite extends Platform
@ -10,5 +11,6 @@ class Appwrite extends Platform
    public function __construct()
    {
        parent::__construct(new Core());
+        $this->addModule(new DevelopmentKeys());
    }
 }
--- a/src/Appwrite/Platform/Modules/DevelopmentKeys.php
+++ b/src/Appwrite/Platform/Modules/DevelopmentKeys.php
@ -0,0 +1,14 @@
+<?php
+
+namespace Appwrite\Platform\Modules;
+
+use Appwrite\Platform\Modules\DevelopmentKeys\Services\Http;
+use Utopia\Platform\Module;
+
+class DevelopmentKeys extends Module
+{
+    public function __construct()
+    {
+        $this->addService('http', new Http());
+    }
+}
--- a/src/Appwrite/Platform/Modules/DevelopmentKeys/Http/Create.php
+++ b/src/Appwrite/Platform/Modules/DevelopmentKeys/Http/Create.php
@ -0,0 +1,80 @@
+<?php
+
+namespace Appwrite\Platform\Modules\DevelopmentKeys\Http;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Helpers\ID;
+use Utopia\Database\Helpers\Permission;
+use Utopia\Database\Helpers\Role;
+use Utopia\Database\Validator\Datetime as DatetimeValidator;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Validator\Text;
+
+class Create extends Action
+{
+    use HTTP;
+    public static function getName()
+    {
+        return 'create';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_POST)
+            ->setHttpPath('/v1/projects/:projectId/development-keys')
+            ->desc('Create key')
+    ->groups(['api', 'projects'])
+    ->label('scope', 'projects.write')
+    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
+    ->label('sdk.namespace', 'projects')
+    ->label('sdk.method', 'createKey')
+    ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+    ->label('sdk.response.model', Response::MODEL_KEY)
+    ->param('projectId', '', new UID(), 'Project unique ID.')
+    ->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
+    ->param('expire', null, new DatetimeValidator(), 'Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.', true)
+    ->inject('response')
+    ->inject('dbForConsole')
+    ->callback(fn ($projectId, $name, $expire, $response, $dbForConsole) => $this->action($projectId, $name, $expire, $response, $dbForConsole));
+    }
+
+    public function action(string $projectId, string $name, ?string $expire, Response $response, Database $dbForConsole)
+    {
+        $project = $dbForConsole->getDocument('projects', $projectId);
+
+        if ($project->isEmpty()) {
+            throw new Exception(Exception::PROJECT_NOT_FOUND);
+        }
+
+        $key = new Document([
+            '$id' => ID::unique(),
+            '$permissions' => [
+                Permission::read(Role::any()),
+                Permission::update(Role::any()),
+                Permission::delete(Role::any()),
+            ],
+            'projectInternalId' => $project->getInternalId(),
+            'projectId' => $project->getId(),
+            'name' => $name,
+            'expire' => $expire,
+            'sdks' => [],
+            'accessedAt' => null,
+            'secret' => API_KEY_STANDARD . '_' . \bin2hex(\random_bytes(128)),
+        ]);
+
+        $key = $dbForConsole->createDocument('development_keys', $key);
+
+        $dbForConsole->purgeCachedDocument('projects', $project->getId());
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_CREATED)
+            ->dynamic($key, Response::MODEL_KEY);
+    }
+}
--- a/src/Appwrite/Platform/Modules/DevelopmentKeys/Services/Http.php
+++ b/src/Appwrite/Platform/Modules/DevelopmentKeys/Services/Http.php
@ -0,0 +1,15 @@
+<?php
+
+namespace Appwrite\Platform\Modules\DevelopmentKeys\Services;
+
+use Appwrite\Platform\Modules\DevelopmentKeys\Http\Create;
+use Utopia\Platform\Service;
+
+class Http extends Service
+{
+    public function __construct()
+    {
+        $this->type = Service::TYPE_HTTP;
+        $this->addAction(Create::getName(), new Create());
+    }
+}