feat: enable storage service encrypted endpoint

app-config.json

@@ -688,9 +688,8 @@
                     "linkRegisterPath": "/api/resolver"
                   },
                   "storage": {
-                    "url": "http://localhost:3334/v1/documents",
+                    "url": "http://localhost:3334/v1/credentials",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -904,7 +903,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -1844,7 +1842,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -2022,7 +2019,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -2204,7 +2200,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -2386,7 +2381,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -2589,7 +2583,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -3091,7 +3084,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -3509,7 +3501,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -4173,7 +4164,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -4387,7 +4377,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -5061,7 +5050,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -5275,7 +5263,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -5949,7 +5936,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {
@@ -6163,7 +6149,6 @@
                   "storage": {
                     "url": "http://localhost:3334/v1/documents",
                     "params": {
-                      "resultPath": "/uri",
                       "bucket": "verifiable-credentials"
                     },
                     "options": {

documentation/docs/mock-apps/common/storage.md

@@ -18,7 +18,6 @@ The `Storage` object is responsible for managing the configuration of the [Stora
   "storage": {
     "url": "http://localhost:3334/v1/documents",
     "params": {
-      "resultPath": "/uri",
       "bucket": "verifiable-credentials"
     },
     "options": {
@@ -46,7 +45,6 @@ The `params` object contains specific parameters for the storage service.
 | Property   | Required | Description                                                          | Type   |
 | ---------- | -------- | -------------------------------------------------------------------- | ------ |
 | bucket     | Yes      | The name of the storage bucket                                       | String |
-| resultPath | Yes      | The path where the result (e.g., URI) will be stored in the response | String |
 
 ### options
 

documentation/docs/mock-apps/common/verify-link.md

@@ -31,15 +31,16 @@ The general structure of the verify link is as follows:
 
 ### Decoded (Human-readable) Example:
 ```
-http://localhost:3001/verify?q={payload:{uri:http://localhost:3001/conformity-credentials/steel-mill-1-emissions.json}}
+http://localhost:3001/verify?q={payload:{uri:'http://localhost:3001/conformity-credentials/steel-mill-1-emissions.json', key:'secret', hash:'595d8d20c586c6f55f8a758f294674fa85069db5c518a0f4cbbd3fd61f46522f'}}
 ```
 
 ### Encoded (URL-safe) Example:
 ```
 http://localhost:3001/verify?q%3D%7Bpayload%3A%7Buri%3Ahttp%3A%2F%2Flocalhost%3A3001%2Fconformity-credentials%2Fsteel-mill-1-emissions.json%7D%7D
+http://localhost:3001/verify?q%3D%7B%22payload%22%3A%7B%22uri%22%3A%22http%3A%2F%2Flocalhost%3A3001%2Fconformity-credentials%2Fsteel-mill-1-emissions.json%22%2C%22key%22%3A%22secret%22%2C%22hash%22%3A%22595d8d20c586c6f55f8a758f294674fa85069db5c518a0f4cbbd3fd61f46522f%22%7D%7D
 ```
 
 ### Production Example:
 ```
-https://www.example.com/verify?q=%7B%22payload%22%3A%7B%22uri%22%3A%22https%3A%2F%2Fstorage.googleapis.com%2Fverifiable-credentials%2Fconformity-credentials%2Ftop-line-steel-dcc.json%22%7D%7D
+https://www.example.com/verify?q=%7B%22payload%22%3A%7B%22uri%22%3A%22https%3A%2F%2Fstorage.googleapis.com%2Fverifiable-credentials%2Fconformity-credentials%2Ftop-line-steel-dcc.json%22%2C%22key%22%3A%22secret%22%2C%22hash%22%3A%22595d8d20c586c6f55f8a758f294674fa85069db5c518a0f4cbbd3fd61f46522f%22%7D%7D
 ```

documentation/docs/mock-apps/components/conformity-credential.md

@@ -55,7 +55,6 @@ The ConformityCredential component allows users to request and manage conformity
     "storedCredentialsConfig": {
       "url": "http://localhost:3334/v1/documents",
       "params": {
-        "resultPath": "/uri",
         "bucket": "verifiable-credentials"
       },
       "options": {

documentation/docs/mock-apps/configuration/service-config.md

@@ -65,7 +65,6 @@ graph TD
           "storage": {
             "url": "http://localhost:3334/v1/documents",
             "params": {
-              "resultPath": "/uri",
               "bucket": "verifiable-credentials"
             },
             "options": {

documentation/docs/mock-apps/conformity-credential.md

@@ -180,7 +180,6 @@ Example config snippet:
             "storedCredentialsConfig": {
               "url": "http://localhost:3334/v1/documents",
               "params": {
-                "resultPath": "/uri",
                 "bucket": "verifiable-credentials"
               },
               "options": {

documentation/docs/mock-apps/services/index.md

@@ -76,7 +76,6 @@ graph TD
           "storage": {
             "url": "http://localhost:3334/v1/documents",
             "params": {
-              "resultPath": "/uri",
               "bucket": "verifiable-credentials"
             },
             "options": {

documentation/docs/mock-apps/services/process-aggregation-event.md

@@ -62,7 +62,6 @@ P-->>C: Return VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-association-event.md

@@ -65,7 +65,6 @@ P-->>C: Return association event VC and resolver URL
         "url": "https://storage.example.com/upload",
         "params": {
           "bucket": "bucket-name",
-          "resultPath": "/url"
         }
       },
       "dlr": {

documentation/docs/mock-apps/services/process-digital-conformity-credential.md

@@ -65,7 +65,6 @@ P-->>C: Return digital conformity credential VC and resolver URL
         "url": "https://storage.example.com/upload",
         "params": {
           "bucket": "bucket-name",
-          "resultPath": "/url"
         }
       },
       "dlr": {

documentation/docs/mock-apps/services/process-digital-facility-record.md

@@ -62,7 +62,6 @@ P-->>C: Return digital facility record VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-digital-identity-anchor.md

@@ -62,7 +62,6 @@ P-->>C: Return digital identity anchor VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-dpp.md

@@ -85,7 +85,6 @@ P-->>C: Return VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-object-event.md

@@ -62,7 +62,6 @@ P-->>C: Return object event VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-traceability-event.md

@@ -56,7 +56,6 @@ P-->>C: Return event VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-transaction-event.md

@@ -64,7 +64,6 @@ P-->>C: Return VC and resolver URL
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/services/process-transformation-event-only.md

@@ -65,7 +65,6 @@ P-->>C: Return transformation event VC and resolver URL
         "url": "https://storage.example.com/upload",
         "params": {
           "bucket": "bucket-name",
-          "resultPath": "/url"
         }
       },
       "dlr": {

documentation/docs/mock-apps/services/process-transformation-event.md

@@ -75,7 +75,6 @@ P-->>C: Return EPCIS VC
       "storage": {
         "url": "http://localhost:3334/v1/documents",
         "params": {
-          "resultPath": "/uri",
           "bucket": "verifiable-credentials"
         },
         "options": {

documentation/docs/mock-apps/verify-app.md

@@ -43,3 +43,7 @@ To ensure the integrity of the credential, a hash value is included in the verif
 Upon retrieval of the credential, the application will compute its hash and compare it with the provided value in the URL. If the computed hash matches the provided hash, the credential is considered valid and unaltered.
 
 The hash is optional and can be omitted from the verification link. If the hash is not provided, the credential will not be validated against it.
+
+## Decryption (if required)
+
+If the credential is encrypted, the decryption key is included in the verification link. The application will use this key to decrypt the credential before proceeding with the verification process.

packages/components/src/__tests__/ConformityCredential.test.tsx

@@ -44,9 +44,7 @@ describe('ConformityCredential', () => {
 
     const storedCredentialsConfig = {
       url: 'https://example.com',
-      params: {
-        resultPath: '',
-      },
+      params: {},
     };
 
     render(
@@ -82,9 +80,7 @@ describe('ConformityCredential', () => {
 
     const storedCredentialsConfig = {
       url: 'https://example.com',
-      params: {
-        resultPath: '',
-      },
+      params: {},
     };
 
     it('should save credential as string when trigger onClickStorageCredential function', async () => {

packages/components/src/__tests__/ConformityUtils.test.tsx

@@ -4,9 +4,7 @@ describe('checkStoredCredentials', () => {
   it('should return the stored credentials if they are valid', () => {
     const storedCredentials = {
       url: 'https://example.com',
-      params: {
-        resultPath: '',
-      },
+      params: {},
     };
 
     const result = checkStoredCredentialsConfig(storedCredentials);
@@ -23,9 +21,7 @@ describe('checkStoredCredentials', () => {
   it('should throw an error if the stored credentials url is invalid', () => {
     const storedCredentials = {
       url: '',
-      params: {
-        resultPath: '',
-      },
+      params: {},
     };
 
     const result = checkStoredCredentialsConfig(storedCredentials);

packages/mock-app/src/__tests__/Verify.test.tsx

@@ -424,7 +424,49 @@ describe('Verify', () => {
     });
 
     await waitFor(() => {
-      expect(screen.getByText('Hash invalid')).toBeInTheDocument();
+      expect(screen.getByText('Failed to compare the hash in the verify URL with the VC hash.')).toBeInTheDocument();
+    });
+  });
+
+  it('should show error screen when the key is invalid', async () => {
+    const mockPayloadInvalidKey = {
+      payload: {
+        uri: 'http://localhost:3334/v1/verifiable-credentials/6c70251a-f2e7-48a0-a86c-e1027f0e7143.json',
+        hash: '595d8d20c586c6f55f8a758f294674fa85069db5c518a0f4cbbd3fd61f46522f',
+        key: 'invalid-key',
+      },
+    };
+    const mockEncryptedCredential = {
+      cipherText: '+qygK55Jq2S/VmhI8xxHr6JQZbZpM2UbwwPtXgYAh6Opn8Re0y+VStefzXgk3KVRYeaZd+/WZv/Nm3XXdxouGqk2toWHZtAnYAW',
+      iv: 'HMFLTHEabOowe0pj',
+      tag: '0B6Js19du2TJ0ADdYe2Ipw==',
+      type: 'aes-256-gcm'
+  };
+    // URL-encode the payload for use as a query parameter
+    const encodedPayload = `q=${encodeURIComponent(JSON.stringify(mockPayloadInvalidKey))}`;
+    (useLocation as any).mockImplementation(() => ({
+      search: encodedPayload,
+    }));
+
+    jest.spyOn(publicAPI, 'get').mockResolvedValueOnce(mockEncryptedCredential);
+
+    (computeHash as any).mockImplementation(() => mockPayloadInvalidKey.payload.hash);
+    (decryptCredential as any).mockImplementation(() => { throw new Error('Failed to decrypt credential') });
+
+    (verifyVC as jest.Mock).mockImplementation(() => ({
+      verified: true,
+    }));
+
+    await act(async () => {
+      render(
+        <RouterDom location={history.location} navigator={history}>
+          <Verify />
+        </RouterDom>,
+      );
+    });
+
+    await waitFor(() => {
+      expect(screen.getByText('Failed to decrypt credential.')).toBeInTheDocument();
     });
   });
 });