From b1ad454db8eac8c639569af157ca933948f89a5c Mon Sep 17 00:00:00 2001
From: Luciano Righetti <luciano.righetti@gmail.com>
Date: Tue, 18 Jan 2022 14:29:27 +0100
Subject: [PATCH] add: api tests for /encryptionkeys, extend openapi spec

---
 tests/Fixture/EncryptionKeysFixture.php       | 133 ++++++++++++++++++
 .../DeleteEncryptionKeyApiTest.php            |  54 +++++++
 .../IndexEncryptionKeysApiTest.php            |  40 ++++++
 webroot/docs/openapi.yaml                     | 128 ++++++++++++++++-
 4 files changed, 352 insertions(+), 3 deletions(-)
 create mode 100644 tests/Fixture/EncryptionKeysFixture.php
 create mode 100644 tests/TestCase/Api/EncryptionKeys/DeleteEncryptionKeyApiTest.php
 create mode 100644 tests/TestCase/Api/EncryptionKeys/IndexEncryptionKeysApiTest.php

diff --git a/tests/Fixture/EncryptionKeysFixture.php b/tests/Fixture/EncryptionKeysFixture.php
new file mode 100644
index 0000000..05b92f8
--- /dev/null
+++ b/tests/Fixture/EncryptionKeysFixture.php
@@ -0,0 +1,133 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Test\Fixture;
+
+use Cake\Http\Exception\NotImplementedException;
+use Cake\TestSuite\Fixture\TestFixture;
+
+class EncryptionKeysFixture extends TestFixture
+{
+    public $connection = 'test';
+
+    public const ENCRYPTION_KEY_ORG_A_ID = 1;
+    public const ENCRYPTION_KEY_ORG_B_ID = 2;
+
+    public const TYPE_PGP = 'pgp';
+    public const TYPE_SMIME = 'smime';
+
+    public const KEY_TYPE_EDCH = 'EDCH';
+    public const KEY_TYPE_RSA = 'RSA';
+    public const KEY_TYPE_SMIME = 'S/MIME';
+
+    public function init(): void
+    {
+        $faker = \Faker\Factory::create();
+
+        $this->records = [
+            [
+                'id' => self::ENCRYPTION_KEY_ORG_A_ID,
+                'uuid' => $faker->uuid(),
+                'type' => self::TYPE_PGP,
+                'encryption_key' => $this->getPublicKey(self::KEY_TYPE_EDCH),
+                'revoked' => false,
+                'expires' => null,
+                'owner_id' => OrganisationsFixture::ORGANISATION_A_ID,
+                'owner_model' => 'Organisation',
+                'created' => $faker->dateTime()->getTimestamp(),
+                'modified' => $faker->dateTime()->getTimestamp()
+            ],
+            [
+                'id' => self::ENCRYPTION_KEY_ORG_B_ID,
+                'uuid' => $faker->uuid(),
+                'type' => self::TYPE_PGP,
+                'encryption_key' => $this->getPublicKey(self::KEY_TYPE_EDCH),
+                'revoked' => false,
+                'expires' => null,
+                'owner_id' => OrganisationsFixture::ORGANISATION_A_ID,
+                'owner_model' => 'Organisation',
+                'created' => $faker->dateTime()->getTimestamp(),
+                'modified' => $faker->dateTime()->getTimestamp()
+            ],
+        ];
+        parent::init();
+    }
+
+    public function getPublicKey(string $type): string
+    {
+        switch ($type) {
+            case self::KEY_TYPE_EDCH:
+                return <<<EOD
+                -----BEGIN PGP PUBLIC KEY BLOCK-----
+                Version: OpenPGP v1.0.0
+
+                xm8EYeaEmhMFK4EEACIDAwTS1DNpEsyLo6ynsxJhe1J1k75OYGjkiYgj+4157e06
+                m8uNX9TRI3XKAKUs2ecG6Iv6beXpvLHcBu/GqwYnpLigpABkhLbUob5spIg+OqNA
+                l0U75pLyshmQ8DOWupjq2ZTNG2Zvb2JhciA8Zm9vYmFyQGV4YW1wbGUuY29tPsKP
+                BBMTCgAXBQJh5oSaAhsvAwsJBwMVCggCHgECF4AACgkQfYJ4NsWgZlqadgF6Apv0
+                S3JrJgmUejRVaMBoAlGlME6OibfAo/faYyOhO/tb0Kw8MYfrF27D+N3/TR8BAX0e
+                KhJvhcoHZlcb6E+xUvAT9zYyCpX6g1s2rU9qeLJEbWeEiz7/e1diYgQ2TuuJTr/O
+                UgRh5oSaEwgqhkjOPQMBBwIDBHTGkUJ9McCAGMB9/jhzJJ9arYLIdMUwHbxf68K3
+                yQaiQf2F0BUciz37I2pFPBV17CJzsHdoIG4rhrU4PI+srzvCwCcEGBMKAA8FAmHm
+                hJoFCQ8JnAACGy4AagkQfYJ4NsWgZlpfIAQZEwoABgUCYeaEmgAKCRC+TAWGbVzh
+                xvHIAP9C6iogC55FEE8XuQ2g6dPyIyou940sLQIYKdFpG2CTnwEAvosKiPEC+bwC
+                b75QibMSCGlYPOIO5WW9OqJyT4I59bwH4QF+KRv6b3wOoFz8/ptDyIbFpNSoBrDT
+                9D35Gk9oVSZg9FDeQunGRt2qkvfDxBMecPWXAYDlNTFtdBUWeXeMLJlEr5YyC3SA
+                RIbej4EnbpXmhdODjKLv1p5tAOw/lgEfQKzBEwbOUgRh5oSaEwgqhkjOPQMBBwID
+                BO9vsx/0+act9x1hNk0LHxE/PELjL2Abn/JBjAIvGgTmiZc5Vkb2XrUYAoOhKI4G
+                ab9UTnlGznER74SWWLELUt7CwCcEGBMKAA8FAmHmhJoFCQ8JnAACGy4AagkQfYJ4
+                NsWgZlpfIAQZEwoABgUCYeaEmgAKCRC5+NJ8Prn4UPSRAQCH7Ek29Z9ivuvIaj6n
+                2AYdgHZHBEYAg5uwSBchPRXBHwD/QxRRAyKnwdmTLJzaB7M82bHLRU5WXbEgqucv
+                9HuQpkiv6wGA2NVSulEz7VxxKIcaU8xQRrStIBXqMvNo/13kdlq2YWQ6EZnG7EU7
+                ExIU8Y2OkuFWAX9gLoJCjxfMuH5u27nNkztxL4SgORfCxWRg6VaVAFXX21dlQwIf
+                XUzE5dzw+nOspVE=
+                =WnCK
+                -----END PGP PUBLIC KEY BLOCK-----
+                EOD;
+            default:
+                throw new NotImplementedException('Unknown key type');
+        }
+    }
+
+    private function getPrivateKey(string $type): string
+    {
+        switch ($type) {
+            case self::KEY_TYPE_EDCH:
+                return <<<EOD
+                -----BEGIN PGP PRIVATE KEY BLOCK-----
+                Version: OpenPGP v1.0.0
+        
+                xcASBGHmhJoTBSuBBAAiAwME0tQzaRLMi6Osp7MSYXtSdZO+TmBo5ImII/uNee3t
+                OpvLjV/U0SN1ygClLNnnBuiL+m3l6byx3AbvxqsGJ6S4oKQAZIS21KG+bKSIPjqj
+                QJdFO+aS8rIZkPAzlrqY6tmU/gkDCCcuNcl1iEuoYIjwDlg5yqzxdXu9Q7V+WvBf
+                OflkWwIGYLjrqcDWNZqz9v4alO8/uKPZoRyYmQx3yBxjgrNs4bjibFxc43oTlHtD
+                JA7m+Ba4cWyMVFJ96TPXAvI5fAJszRtmb29iYXIgPGZvb2JhckBleGFtcGxlLmNv
+                bT7CjwQTEwoAFwUCYeaEmgIbLwMLCQcDFQoIAh4BAheAAAoJEH2CeDbFoGZamnYB
+                egKb9EtyayYJlHo0VWjAaAJRpTBOjom3wKP32mMjoTv7W9CsPDGH6xduw/jd/00f
+                AQF9HioSb4XKB2ZXG+hPsVLwE/c2MgqV+oNbNq1PaniyRG1nhIs+/3tXYmIENk7r
+                iU6/x6UEYeaEmhMIKoZIzj0DAQcCAwR0xpFCfTHAgBjAff44cySfWq2CyHTFMB28
+                X+vCt8kGokH9hdAVHIs9+yNqRTwVdewic7B3aCBuK4a1ODyPrK87/gkDCCiGr5A8
+                Yq+pYCpNvctmdVC3wwN+LNpiXHtkYWD37TdpwrdR0h8H/PSZFdHgkyK3tqmxPApC
+                S3+s+cBzza5mTPqaq/7Cc6ck40juXNBIC8rCwCcEGBMKAA8FAmHmhJoFCQ8JnAAC
+                Gy4AagkQfYJ4NsWgZlpfIAQZEwoABgUCYeaEmgAKCRC+TAWGbVzhxvHIAP9C6iog
+                C55FEE8XuQ2g6dPyIyou940sLQIYKdFpG2CTnwEAvosKiPEC+bwCb75QibMSCGlY
+                POIO5WW9OqJyT4I59bwH4QF+KRv6b3wOoFz8/ptDyIbFpNSoBrDT9D35Gk9oVSZg
+                9FDeQunGRt2qkvfDxBMecPWXAYDlNTFtdBUWeXeMLJlEr5YyC3SARIbej4EnbpXm
+                hdODjKLv1p5tAOw/lgEfQKzBEwbHpQRh5oSaEwgqhkjOPQMBBwIDBO9vsx/0+act
+                9x1hNk0LHxE/PELjL2Abn/JBjAIvGgTmiZc5Vkb2XrUYAoOhKI4Gab9UTnlGznER
+                74SWWLELUt7+CQMI0o+tsXn5S31gHyPTI5yRG0I7dZg4OrU+tCu11AYzC4y3aO0M
+                E2tixY7BDHIgtiWkeDWo8j4f8zYhBL9x/M3mpinZ6vQEhOdED+8shBmPNMLAJwQY
+                EwoADwUCYeaEmgUJDwmcAAIbLgBqCRB9gng2xaBmWl8gBBkTCgAGBQJh5oSaAAoJ
+                ELn40nw+ufhQ9JEBAIfsSTb1n2K+68hqPqfYBh2AdkcERgCDm7BIFyE9FcEfAP9D
+                FFEDIqfB2ZMsnNoHszzZsctFTlZdsSCq5y/0e5CmSK/rAYDY1VK6UTPtXHEohxpT
+                zFBGtK0gFeoy82j/XeR2WrZhZDoRmcbsRTsTEhTxjY6S4VYBf2AugkKPF8y4fm7b
+                uc2TO3EvhKA5F8LFZGDpVpUAVdfbV2VDAh9dTMTl3PD6c6ylUQ==
+                =96JC
+                -----END PGP PRIVATE KEY BLOCK-----
+                EOD;
+            default:
+                throw new NotImplementedException('Unknown key type');
+        }
+    }
+}
diff --git a/tests/TestCase/Api/EncryptionKeys/DeleteEncryptionKeyApiTest.php b/tests/TestCase/Api/EncryptionKeys/DeleteEncryptionKeyApiTest.php
new file mode 100644
index 0000000..934d3e7
--- /dev/null
+++ b/tests/TestCase/Api/EncryptionKeys/DeleteEncryptionKeyApiTest.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Test\TestCase\Api\Users;
+
+use Cake\TestSuite\IntegrationTestTrait;
+use Cake\TestSuite\TestCase;
+use App\Test\Fixture\AuthKeysFixture;
+use App\Test\Fixture\EncryptionKeysFixture;
+use App\Test\Helper\ApiTestTrait;
+
+class DeleteEncryptionKeyApiTest extends TestCase
+{
+    use IntegrationTestTrait;
+    use ApiTestTrait;
+
+    protected const ENDPOINT = '/api/v1/encryptionKeys/delete';
+
+    protected $fixtures = [
+        'app.Organisations',
+        'app.Individuals',
+        'app.Roles',
+        'app.Users',
+        'app.AuthKeys',
+        'app.EncryptionKeys'
+    ];
+
+    public function testDeleteEncryptionKey(): void
+    {
+        $this->setAuthToken(AuthKeysFixture::ADMIN_API_KEY);
+        $url = sprintf('%s/%d', self::ENDPOINT, EncryptionKeysFixture::ENCRYPTION_KEY_ORG_A_ID);
+        $this->delete($url);
+
+        $this->assertResponseOk();
+        $this->assertDbRecordNotExists('EncryptionKeys', ['id' => EncryptionKeysFixture::ENCRYPTION_KEY_ORG_A_ID]);
+        //TODO: $this->assertRequestMatchesOpenApiSpec();
+        $this->assertResponseMatchesOpenApiSpec($url, 'delete');
+        $this->addWarning('TODO: CRUDComponent::delete() sets some view variables, does not take into account `isRest()`, fix it.');
+    }
+
+    public function testDeleteEncryptionKeyNotAllowedAsRegularUser(): void
+    {
+        $this->setAuthToken(AuthKeysFixture::REGULAR_USER_API_KEY);
+        $url = sprintf('%s/%d', self::ENDPOINT, EncryptionKeysFixture::ENCRYPTION_KEY_ORG_B_ID);
+        $this->delete($url);
+
+        $this->assertResponseCode(405);
+        $this->assertDbRecordExists('EncryptionKeys', ['id' => EncryptionKeysFixture::ENCRYPTION_KEY_ORG_B_ID]);
+        //TODO: $this->assertRequestMatchesOpenApiSpec();
+        $this->assertResponseMatchesOpenApiSpec($url, 'delete');
+        $this->addWarning('TODO: CRUDComponent::delete() sets some view variables, does not take into account `isRest()`, fix it.');
+    }
+}
diff --git a/tests/TestCase/Api/EncryptionKeys/IndexEncryptionKeysApiTest.php b/tests/TestCase/Api/EncryptionKeys/IndexEncryptionKeysApiTest.php
new file mode 100644
index 0000000..0b7cb98
--- /dev/null
+++ b/tests/TestCase/Api/EncryptionKeys/IndexEncryptionKeysApiTest.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Test\TestCase\Api\Users;
+
+use Cake\TestSuite\IntegrationTestTrait;
+use Cake\TestSuite\TestCase;
+use App\Test\Fixture\AuthKeysFixture;
+use App\Test\Fixture\EncryptionKeysFixture;
+use App\Test\Helper\ApiTestTrait;
+
+class IndexEncryptionKeysApiTest extends TestCase
+{
+    use IntegrationTestTrait;
+    use ApiTestTrait;
+
+    protected const ENDPOINT = '/api/v1/encryptionKeys/index';
+
+    protected $fixtures = [
+        'app.Organisations',
+        'app.Individuals',
+        'app.Roles',
+        'app.Users',
+        'app.AuthKeys',
+        'app.EncryptionKeys'
+
+    ];
+
+    public function testIndexEncryptionKeys(): void
+    {
+        $this->setAuthToken(AuthKeysFixture::ADMIN_API_KEY);
+        $this->get(self::ENDPOINT);
+
+        $this->assertResponseOk();
+        $this->assertResponseContains(sprintf('"id": %d', EncryptionKeysFixture::ENCRYPTION_KEY_ORG_A_ID));
+        // TODO: $this->assertRequestMatchesOpenApiSpec();
+        $this->assertResponseMatchesOpenApiSpec(self::ENDPOINT);
+    }
+}
diff --git a/webroot/docs/openapi.yaml b/webroot/docs/openapi.yaml
index f9418b9..c4852eb 100644
--- a/webroot/docs/openapi.yaml
+++ b/webroot/docs/openapi.yaml
@@ -23,6 +23,8 @@ tags:
     description: "Sharing groups are distribution lists usable by tools that can exchange information with a list of trusted partners. Create recurring or ad hoc sharing groups and share them with the members of the sharing group."
   - name: Broods
     description: "Cerebrate can connect to other Cerebrate instances to exchange trust information and to instrument interconnectivity between connected local tools. Each such Cerebrate instance with its connected tools is considered to be a brood."
+  - name: EncryptionKeys
+    description: "Assign encryption keys to the user, used to securely communicate or validate messages coming from the user."
 
 paths:
   /api/v1/individuals/index:
@@ -575,7 +577,7 @@ paths:
         default:
           $ref: "#/components/responses/ApiErrorResponse"
 
-  /api/v1/broods/edit/{sharingGroupId}:
+  /api/v1/broods/edit/{broodId}:
     put:
       summary: "Edit brood"
       operationId: editBrood
@@ -631,6 +633,43 @@ paths:
         default:
           $ref: "#/components/responses/ApiErrorResponse"
 
+  # EncryptionKeys
+  /api/v1/encryptionKeys/index:
+    get:
+      summary: "Get encryption keys list"
+      operationId: getEncryptionKeys
+      tags:
+        - EncryptionKeys
+      parameters:
+        - $ref: "#/components/parameters/quickFilter"
+      responses:
+        "200":
+          $ref: "#/components/responses/EncryptionKeyListResponse"
+        "403":
+          $ref: "#/components/responses/UnauthorizedApiErrorResponse"
+        "405":
+          $ref: "#/components/responses/MethodNotAllowedApiErrorResponse"
+        default:
+          $ref: "#/components/responses/ApiErrorResponse"
+
+  /api/v1/encryptionKeys/delete/{encryptionKeyId}:
+    delete:
+      summary: "Delete encryption key by ID"
+      operationId: deleteEncryptionKeyById
+      tags:
+        - EncryptionKeys
+      parameters:
+        - $ref: "#/components/parameters/encryptionKeyId"
+      responses:
+        "200":
+          $ref: "#/components/responses/EncryptionKeyResponse"
+        "403":
+          $ref: "#/components/responses/UnauthorizedApiErrorResponse"
+        "405":
+          $ref: "#/components/responses/MethodNotAllowedApiErrorResponse"
+        default:
+          $ref: "#/components/responses/ApiErrorResponse"
+
 components:
   schemas:
     # General
@@ -658,6 +697,18 @@ components:
     AuthKey:
       type: string
 
+    ModelName:
+      type: string
+      enum:
+        - "Organisation"
+        - "User"
+        - "Individual"
+        - "EncryptionKey"
+        - "Role"
+        - "Tag"
+        - "SharingGroup"
+        - "Brood"
+
     # Individuals
     IndividualFirstName:
       type: string
@@ -1089,18 +1140,66 @@ components:
           type: boolean
         authkey:
           $ref: "#/components/schemas/AuthKey"
+        organisation:
+          $ref: "#/components/schemas/Organisation"
         created:
           $ref: "#/components/schemas/DateTime"
         modified:
           $ref: "#/components/schemas/DateTime"
-        organisation:
-          $ref: "#/components/schemas/Organisation"
 
     BroodList:
       type: array
       items:
         $ref: "#/components/schemas/Brood"
 
+    # EncryptionKeys
+    EncryptionKeyType:
+      type: string
+      enum:
+        - "pgp"
+        - "smime"
+
+    EncryptionKeyValue:
+      type: string
+      example: |
+        -----BEGIN PGP PUBLIC KEY BLOCK-----
+        ...
+        -----END PGP PUBLIC KEY BLOCK-----
+
+    EncryptionKeyExpiration:
+      type: integer
+      description: "Timestamp or null of there is no expiration"
+      nullable: true
+
+    EncryptionKey:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/ID"
+        uuid:
+          $ref: "#/components/schemas/UUID"
+        type:
+          $ref: "#/components/schemas/EncryptionKeyType"
+        encryption_key:
+          $ref: "#/components/schemas/EncryptionKeyValue"
+        revoked:
+          type: boolean
+        expires:
+          $ref: "#/components/schemas/EncryptionKeyExpiration"
+        owner_id:
+          $ref: "#/components/schemas/ID"
+        owner_model:
+          $ref: "#/components/schemas/ModelName"
+        created:
+          $ref: "#/components/schemas/DateTime"
+        modified:
+          $ref: "#/components/schemas/DateTime"
+
+    EncryptionKeyList:
+      type: array
+      items:
+        $ref: "#/components/schemas/EncryptionKey"
+
     # Errors
     ApiError:
       type: object
@@ -1210,6 +1309,14 @@ components:
       schema:
         $ref: "#/components/schemas/ID"
 
+    encryptionKeyId:
+      name: encryptionKeyId
+      in: path
+      description: "Numeric ID of the EncryptionKey"
+      required: true
+      schema:
+        $ref: "#/components/schemas/ID"
+
     quickFilter:
       name: quickFilter
       in: query
@@ -1659,6 +1766,21 @@ components:
                 type: number
                 format: float
 
+    # EncryptionKeys
+    EncryptionKeyResponse:
+      description: "Encryption key response"
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/EncryptionKey"
+
+    EncryptionKeyListResponse:
+      description: "Encryption key list response"
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/EncryptionKeyList"
+
     # Errors
     ApiErrorResponse:
       description: "Unexpected API error"