Personalized Tokens (#294)

* feat: add personalization to templates * refactor/fix: cleanup * feat: add personalization to tokens * feat: only string forIdentity * test: improve tests * fix: missing forIdentity * test: personalized token, non-pers template test * test: refactor comments * test: refactoring continued * chore: use speaking content instead of gibberish --------- Co-authored-by: Julian König <[email protected]>
nmshd · Nov 12, 2024 · de54d46 · de54d46
1 parent f01f59a
commit de54d46
Show file tree

Hide file tree

Showing 11 changed files with 86 additions and 13 deletions.
diff --git a/packages/sdk/src/types/files/requests/CreateTokenForFileRequest.ts b/packages/sdk/src/types/files/requests/CreateTokenForFileRequest.ts
@@ -1,4 +1,5 @@
 export interface CreateTokenForFileRequest {
     expiresAt?: string;
     ephemeral?: boolean;
+    forIdentity?: string;
 }
diff --git a/packages/sdk/src/types/files/requests/CreateTokenQrCodeForFileRequest.ts b/packages/sdk/src/types/files/requests/CreateTokenQrCodeForFileRequest.ts
@@ -1,3 +1,4 @@
 export interface CreateTokenQrCodeForFileRequest {
     expiresAt?: string;
+    forIdentity?: string;
 }
diff --git a/packages/sdk/src/types/tokens/requests/CreateOwnTokenRequest.ts b/packages/sdk/src/types/tokens/requests/CreateOwnTokenRequest.ts
@@ -2,4 +2,5 @@ export interface CreateOwnTokenRequest {
     expiresAt: string;
     content: unknown;
     ephemeral?: boolean;
+    forIdentity?: string;
 }
diff --git a/packages/sdk/src/types/tokens/requests/GetOwnTokensRequest.ts b/packages/sdk/src/types/tokens/requests/GetOwnTokensRequest.ts
@@ -2,4 +2,5 @@ export interface GetOwnTokensRequest {
     createdAt?: string | string[];
     createdByDevice?: string | string[];
     expiresAt?: string | string[];
+    forIdentity?: string | string[];
 }
diff --git a/packages/sdk/src/types/tokens/requests/GetPeerTokensRequest.ts b/packages/sdk/src/types/tokens/requests/GetPeerTokensRequest.ts
@@ -2,4 +2,5 @@ export interface GetPeerTokensRequest {
     createdAt?: string | string[];
     createdBy?: string | string[];
     expiresAt?: string | string[];
+    forIdentity?: string;
 }
diff --git a/src/modules/coreHttpApi/controllers/FilesController.ts b/src/modules/coreHttpApi/controllers/FilesController.ts
@@ -126,7 +126,8 @@ export class FilesController extends BaseController {
             case "image/png":
                 const qrCodeResult = await this.transportServices.files.createTokenQRCodeForFile({
                     fileId: id,
-                    expiresAt: request.expiresAt
+                    expiresAt: request.expiresAt,
+                    forIdentity: request.forIdentity
                 });
                 return this.file(
                     qrCodeResult,
@@ -140,7 +141,8 @@ export class FilesController extends BaseController {
                 const jsonResult = await this.transportServices.files.createTokenForFile({
                     fileId: id,
                     expiresAt: request.expiresAt,
-                    ephemeral: request.ephemeral
+                    ephemeral: request.ephemeral,
+                    forIdentity: request.forIdentity
                 });
                 return this.created(jsonResult);
         }

diff --git a/src/modules/coreHttpApi/openapi.yml b/src/modules/coreHttpApi/openapi.yml
@@ -2126,6 +2126,10 @@ paths:
                 ephemeral:
                   description: If set to true the token will will not be cached in the database of the connector. Note that you will not be able to fetch this token unless you remember the truncatedReference of the token. Defaults to true. Will be ignored if Accept is set to image/png.
                   type: boolean
+                forIdentity:
+                  $ref: "#/components/schemas/Address"
+                  nullable: true
+                  description: The only Identity that may load this Token.
       responses:
         201:
           description: Success
@@ -4119,6 +4123,10 @@ paths:
                   description: If set to true the token will will not be cached in the database of the connector. Note that you will not be able to fetch this token unless you remember the truncatedReference of the token. Defaults to false.
                   type: boolean
                   example: false
+                forIdentity:
+                  $ref: "#/components/schemas/Address"
+                  nullable: true
+                  description: The only Identity that may load this Token.
               required:
                 - content
                 - expiresAt
@@ -4167,6 +4175,10 @@ paths:
           name: expiresAt
           schema:
             $ref: "#/components/schemas/DateFilter"
+        - in: query
+          name: forIdentity
+          schema:
+            $ref: "#/components/schemas/IdFilter"
       responses:
         200:
           description: Success
@@ -4266,6 +4278,10 @@ paths:
           name: expiresAt
           schema:
             $ref: "#/components/schemas/DateFilter"
+        - in: query
+          name: forIdentity
+          schema:
+            $ref: "#/components/schemas/IdFilter"
       responses:
         200:
           description: Success

diff --git a/test/files.test.ts b/test/files.test.ts
@@ -211,6 +211,15 @@ describe("Load peer file with token reference", () => {
         expect(response.result).toContainEqual({ ...file, isOwn: false });
     });
 
+    test("token can be personalized", async () => {
+        const client2address = (await client2.account.getIdentityInfo()).result.address;
+        const token = (await client1.files.createTokenForFile(file.id, { forIdentity: client2address })).result;
+        expect(token.forIdentity).toBe(client2address);
+
+        const response = await client2.files.loadPeerFile({ reference: token.truncatedReference });
+        expect(response).toBeSuccessful(ValidationSchema.File);
+    });
+
     test("passing token id as truncated token reference causes an error", async () => {
         const file = await uploadFile(client1);
         const token = (await client1.files.createTokenForFile(file.id)).result;

diff --git a/test/lib/testUtils.ts b/test/lib/testUtils.ts
@@ -139,12 +139,11 @@ export async function syncUntilHasMessageWithResponse(client: ConnectorClientWit
     ).data.message;
 }
 
-export async function uploadOwnToken(client: ConnectorClient): Promise<ConnectorToken> {
+export async function uploadOwnToken(client: ConnectorClient, forIdentity?: string): Promise<ConnectorToken> {
     const response = await client.tokens.createOwnToken({
-        content: {
-            content: "Hello"
-        },
-        expiresAt: DateTime.utc().plus({ days: 1 }).toString()
+        content: { aKey: "aValue" },
+        expiresAt: DateTime.utc().plus({ days: 1 }).toString(),
+        forIdentity
     });
 
     expect(response).toBeSuccessful(ValidationSchema.Token);
@@ -233,8 +232,8 @@ export async function exchangeFile(clientCreator: ConnectorClient, clientRecpipi
     return response.result;
 }
 
-export async function exchangeToken(clientCreator: ConnectorClient, clientRecpipient: ConnectorClient): Promise<ConnectorToken> {
-    const token = await uploadOwnToken(clientCreator);
+export async function exchangeToken(clientCreator: ConnectorClient, clientRecpipient: ConnectorClient, forIdentity?: string): Promise<ConnectorToken> {
+    const token = await uploadOwnToken(clientCreator, forIdentity);
 
     const response = await clientRecpipient.tokens.loadPeerToken({ reference: token.truncatedReference });
     expect(response).toBeSuccessful(ValidationSchema.Token);

diff --git a/test/relationshipTemplates.test.ts b/test/relationshipTemplates.test.ts
@@ -105,6 +105,18 @@ describe("Template Tests", () => {
         expect(response).toBeSuccessful(ValidationSchema.RelationshipTemplate);
         expect(response.result.forIdentity).toBe(client2address);
     });
+
+    test("send and receive a non-personalized template via personalized token", async () => {
+        const client2address = (await client2.account.getIdentityInfo()).result.address;
+        const template = await createTemplate(client1, client2address);
+        const token = (await client1.relationshipTemplates.createTokenForOwnRelationshipTemplate(template.id, { forIdentity: client2address })).result;
+
+        const response = await client2.relationshipTemplates.loadPeerRelationshipTemplate({
+            reference: token.truncatedReference
+        });
+        expect(response).toBeSuccessful(ValidationSchema.RelationshipTemplate);
+        expect(response.result.forIdentity).toBe(client2address);
+    });
 });
 
 describe("Serialization Errors", () => {

diff --git a/test/tokens.test.ts b/test/tokens.test.ts
@@ -1,4 +1,5 @@
 import { ConnectorClient } from "@nmshd/connector-sdk";
+import { DateTime } from "luxon";
 import { Launcher } from "./lib/Launcher";
 import { QueryParamConditions } from "./lib/QueryParamConditions";
 import { getTimeout } from "./lib/setTimeout";
@@ -12,16 +13,45 @@ let client2: ConnectorClient;
 beforeAll(async () => ([client1, client2] = await launcher.launch(2)), getTimeout(30000));
 afterAll(() => launcher.stop());
 
+test("send a token", async () => {
+    const response = await client1.tokens.createOwnToken({
+        content: { aKey: "aValue" },
+        expiresAt: DateTime.utc().plus({ days: 1 }).toString()
+    });
+    expect(response).toBeSuccessful(ValidationSchema.Token);
+});
+
+test("load a token", async () => {
+    const template = await uploadOwnToken(client1);
+
+    const response = await client2.tokens.loadPeerToken({
+        reference: template.truncatedReference
+    });
+    expect(response).toBeSuccessful(ValidationSchema.Token);
+});
+
+test("send and receive a personalized token", async () => {
+    const client2address = (await client2.account.getIdentityInfo()).result.address;
+    const template = await uploadOwnToken(client1, client2address);
+    expect(template.forIdentity).toBe(client2address);
+
+    const response = await client2.tokens.loadPeerToken({
+        reference: template.truncatedReference
+    });
+    expect(response).toBeSuccessful(ValidationSchema.Token);
+    expect(response.result.forIdentity).toBe(client2address);
+});
+
 describe("Tokens query", () => {
     test("query own tokens", async () => {
-        const token = await uploadOwnToken(client1);
-        const conditions = new QueryParamConditions(token, client1).addDateSet("expiresAt").addDateSet("createdAt").addStringSet("createdByDevice");
+        const token = await uploadOwnToken(client1, (await client1.account.getIdentityInfo()).result.address);
+        const conditions = new QueryParamConditions(token, client1).addDateSet("expiresAt").addDateSet("createdAt").addStringSet("createdByDevice").addStringSet("forIdentity");
         await conditions.executeTests((c, q) => c.tokens.getOwnTokens(q), ValidationSchema.Tokens);
     });
 
     test("query peer tokens", async () => {
-        const token = await exchangeToken(client1, client2);
-        const conditions = new QueryParamConditions(token, client2).addDateSet("expiresAt").addDateSet("createdAt").addStringSet("createdBy");
+        const token = await exchangeToken(client1, client2, (await client2.account.getIdentityInfo()).result.address);
+        const conditions = new QueryParamConditions(token, client2).addDateSet("expiresAt").addDateSet("createdAt").addStringSet("createdBy").addStringSet("forIdentity");
         await conditions.executeTests((c, q) => c.tokens.getPeerTokens(q), ValidationSchema.Tokens);
     });
 });