chore(release): cut atala prism 1.17.0 release

# [1.17.0](prism-agent-v1.16.4...prism-agent-v1.17.0) (2023-10-14) ### Bug Fixes * change repository and name for rest api clients ([#745](#745)) ([0f84e28](0f84e28)) * improve performance for background jobs in multitenancy mode ([#749](#749)) ([17def3f](17def3f)) * **prism-agent:** agent should read DIDComm port from config ([#757](#757)) ([cda908c](cda908c)) * **prism-agent:** configure APISIX to return CORS headers from Prism Agent endpoints ([#746](#746)) ([a579aa9](a579aa9)) * **prism-agent:** fix docker env variables interpolation issue ([#751](#751)) ([110eb2d](110eb2d)) * **prism-agent:** return relevant errors on offer creation ([#754](#754)) ([d36533f](d36533f)) * prohibit tenants to use equal or revoked api keys ([#742](#742)) ([4b10c3a](4b10c3a)) * upgrade vault and quill versions ([#739](#739)) ([c140857](c140857)) ### Features * **prism-agent:** check issuing DID validity when creating a VC offer + return 'metaRetries' ([#740](#740)) ([f2e2fd3](f2e2fd3)) * **prism-agent:** implement AnonCreds issuance flow ([#693](#693)) ([9165a6f](9165a6f)) Signed-off-by: Anton Baliasnikov <anton.baliasnikov@iohk.io>
hyperledger · Oct 14, 2023 · 9a8e216 · 9a8e216
1 parent 8c426ea
commit 9a8e216
Show file tree

Hide file tree

Showing 9 changed files with 319 additions and 164 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,23 @@
+# [1.17.0](https://github.com/hyperledger-labs/open-enterprise-agent/compare/prism-agent-v1.16.4...prism-agent-v1.17.0) (2023-10-14)
+
+
+### Bug Fixes
+
+* change repository and name for rest api clients ([#745](https://github.com/hyperledger-labs/open-enterprise-agent/issues/745)) ([0f84e28](https://github.com/hyperledger-labs/open-enterprise-agent/commit/0f84e28c3f2800c1d73353e40620a840fbb6b93a))
+* improve performance for background jobs in multitenancy mode ([#749](https://github.com/hyperledger-labs/open-enterprise-agent/issues/749)) ([17def3f](https://github.com/hyperledger-labs/open-enterprise-agent/commit/17def3f67c1eb687560aee844aba6ff2a0bd4137))
+* **prism-agent:** agent should read DIDComm port from config ([#757](https://github.com/hyperledger-labs/open-enterprise-agent/issues/757)) ([cda908c](https://github.com/hyperledger-labs/open-enterprise-agent/commit/cda908c87cee562e6c044aa405aa82bd510cc74e))
+* **prism-agent:** configure APISIX to return CORS headers from Prism Agent endpoints ([#746](https://github.com/hyperledger-labs/open-enterprise-agent/issues/746)) ([a579aa9](https://github.com/hyperledger-labs/open-enterprise-agent/commit/a579aa95ea5c0c4950cb64b8b9adb1f56bb87eb2))
+* **prism-agent:** fix docker env variables interpolation issue ([#751](https://github.com/hyperledger-labs/open-enterprise-agent/issues/751)) ([110eb2d](https://github.com/hyperledger-labs/open-enterprise-agent/commit/110eb2df9590412b35997152d526c599edb8e7af))
+* **prism-agent:** return relevant errors on offer creation ([#754](https://github.com/hyperledger-labs/open-enterprise-agent/issues/754)) ([d36533f](https://github.com/hyperledger-labs/open-enterprise-agent/commit/d36533fe538812c9e3647bcc2383700173e4b1b7))
+* prohibit tenants to use equal or revoked api keys ([#742](https://github.com/hyperledger-labs/open-enterprise-agent/issues/742)) ([4b10c3a](https://github.com/hyperledger-labs/open-enterprise-agent/commit/4b10c3af931722a683bf55062297c3dfa1e38046))
+* upgrade vault and quill versions ([#739](https://github.com/hyperledger-labs/open-enterprise-agent/issues/739)) ([c140857](https://github.com/hyperledger-labs/open-enterprise-agent/commit/c140857df97d56ab750ec186962e5fe2bb6a6717))
+
+
+### Features
+
+* **prism-agent:** check issuing DID validity when creating a VC offer + return 'metaRetries' ([#740](https://github.com/hyperledger-labs/open-enterprise-agent/issues/740)) ([f2e2fd3](https://github.com/hyperledger-labs/open-enterprise-agent/commit/f2e2fd3d0397422be40b11644f8b84ddd3c6985f))
+* **prism-agent:** implement AnonCreds issuance flow ([#693](https://github.com/hyperledger-labs/open-enterprise-agent/issues/693)) ([9165a6f](https://github.com/hyperledger-labs/open-enterprise-agent/commit/9165a6f8fc0a11bd6c19b0bfd4dd4217ea3194d9))
+
 ## [1.16.4](https://github.com/hyperledger-labs/open-enterprise-agent/compare/prism-agent-v1.16.3...prism-agent-v1.16.4) (2023-09-29)
 
 

diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md
diff --git a/infrastructure/charts/agent/Chart.yaml b/infrastructure/charts/agent/Chart.yaml
@@ -13,12 +13,12 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.16.4
+version: 1.17.0
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: 1.16.4
+appVersion: 1.17.0
 dependencies:
   - name: vault
     version: 0.24.1

diff --git a/infrastructure/charts/index.yaml b/infrastructure/charts/index.yaml
@@ -1,9 +1,23 @@
 apiVersion: v1
 entries:
   prism-agent:
+    - apiVersion: v2
+      appVersion: 1.17.0
+      created: "2023-10-14T17:17:05.1408815Z"
+      dependencies:
+        - name: vault
+          repository: https://helm.releases.hashicorp.com
+          version: 0.24.1
+      description: A Helm chart for deploying prism-agent
+      digest: a53050003aedfd0a7d78014dfe9e819c6e2a1db442eeaac6971cff354cf0d3d4
+      name: prism-agent
+      type: application
+      urls:
+        - https://raw.githubusercontent.com/hyperledger-labs/open-enterprise-agent/main/infrastructure/charts/prism-agent-1.17.0.tgz
+      version: 1.17.0
     - apiVersion: v2
       appVersion: 1.16.4
-      created: "2023-09-29T12:46:29.206210511Z"
+      created: "2023-10-14T17:17:05.135639936Z"
       dependencies:
         - name: vault
           repository: https://helm.releases.hashicorp.com
@@ -17,7 +31,7 @@ entries:
       version: 1.16.4
     - apiVersion: v2
       appVersion: 1.16.3
-      created: "2023-09-29T12:46:29.201123089Z"
+      created: "2023-10-14T17:17:05.131265084Z"
       dependencies:
         - name: vault
           repository: https://helm.releases.hashicorp.com
@@ -31,7 +45,7 @@ entries:
       version: 1.16.3
     - apiVersion: v2
       appVersion: 1.16.2
-      created: "2023-09-29T12:46:29.196926371Z"
+      created: "2023-10-14T17:17:05.126243223Z"
       dependencies:
         - name: vault
           repository: https://helm.releases.hashicorp.com
@@ -43,4 +57,4 @@ entries:
       urls:
         - https://raw.githubusercontent.com/hyperledger-labs/open-enterprise-agent/main/infrastructure/charts/prism-agent-1.16.2.tgz
       version: 1.16.2
-generated: "2023-09-29T12:46:29.190669044Z"
+generated: "2023-10-14T17:17:05.120712157Z"
diff --git a/infrastructure/charts/prism-agent-1.17.0.tgz b/infrastructure/charts/prism-agent-1.17.0.tgz
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "atala-prism-building-blocks",
-  "version": "1.16.4",
+  "version": "1.17.0",
   "engines": {
     "node": ">=16.13.0"
   },

diff --git a/prism-agent/service/api/http/prism-agent-openapi-spec.yaml b/prism-agent/service/api/http/prism-agent-openapi-spec.yaml
@@ -1,12 +1,12 @@
-openapi: 3.0.3
+openapi: 3.1.0
 info:
   title: Prism Agent
-  version: 1.16.4
+  version: 1.17.0
 paths:
   /credential-definition-registry/definitions:
     get:
       tags:
-      - Credential Definitions Registry
+      - Credential Definition Registry
       summary: Lookup credential definitions by indexed fields
       description: 'Lookup credential definitions by `author`, `name`, `tag` parameters
         and control the pagination by `offset` and `limit` parameters '
@@ -171,6 +171,46 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+  /credential-definition-registry/definitions/{guid}/definition:
+    get:
+      tags:
+      - Credential Definition Registry
+      summary: Fetch the inner definition field of the credential definition from
+        the registry by `guid`
+      description: Fetch the inner definition fields of the credential definition
+        by the unique identifier
+      operationId: getCredentialDefinitionInnerDefinitionById
+      parameters:
+      - name: guid
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+      responses:
+        '200':
+          description: CredentialDefinition found by `guid`
+          content:
+            application/json:
+              schema: {}
+        '400':
+          description: Invalid request parameters
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Resource could not be found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
   /schema-registry/schemas:
     get:
       tags:
@@ -1427,6 +1467,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Resource could not be found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '500':
           description: Internal server error
           content:
@@ -1753,6 +1799,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          description: Resource could not be found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '500':
           description: Internal server error
           content:
@@ -2628,14 +2680,12 @@ components:
           description: The base64-encoded raw invitation.
           example: eyJAaWQiOiIzZmE4NWY2NC01NzE3LTQ1NjItYjNmYy0yYzk2M2Y2NmFmYTYiLCJAdHlwZSI6Imh0dHBzOi8vZGlkY29tbS5vcmcvbXktZmFtaWx5LzEuMC9teS1tZXNzYWdlLXR5cGUiLCJkaWQiOiJXZ1d4cXp0ck5vb0c5MlJYdnhTVFd2IiwiaW1hZ2VVcmwiOiJodHRwOi8vMTkyLjE2OC41Ni4xMDEvaW1nL2xvZ28uanBnIiwibGFiZWwiOiJCb2IiLCJyZWNpcGllbnRLZXlzIjpbIkgzQzJBVnZMTXY2Z21NTmFtM3VWQWpacGZrY0pDd0R3blpuNnozd1htcVBWIl0sInJvdXRpbmdLZXlzIjpbIkgzQzJBVnZMTXY2Z21NTmFtM3VWQWpacGZrY0pDd0R3blpuNnozd1htcVBWIl0sInNlcnZpY2VFbmRwb2ludCI6Imh0dHA6Ly8xOTIuMTY4LjU2LjEwMTo4MDIwIn0=
     AcceptCredentialOfferRequest:
-      required:
-      - subjectId
       type: object
       properties:
         subjectId:
           type: string
-          description: The short-form subject Prism DID to which the verifiable credential
-            should be issued.
+          description: The short-form subject Prism DID to which the JWT verifiable
+            credential will be issued.This parameter is used for JWT credentials only.
           example: did:prism:3bb0505d13fcb04d28a48234edb27b0d4e6d7e18a81e2c1abab58f3bbc21ce6f
     ActionType:
       type: string
@@ -2661,7 +2711,8 @@ components:
           type: string
           description: The `apikey` of the entity to be updated
           example: dkflks3DflkFmkllnDfde
-          minLength: 1
+          minLength: 16
+          maxLength: 128
     Arr:
       type: object
       properties:
@@ -2683,6 +2734,7 @@ components:
       - state
       - invitation
       - createdAt
+      - metaRetries
       - self
       - kind
       type: object
@@ -2747,6 +2799,12 @@ components:
           description: The date and time the connection record was last updated.
           format: date-time
           example: 2022-03-10T12:00Z
+        metaRetries:
+          type: integer
+          description: The maximum background processing attempts remaining for this
+            record
+          format: int32
+          example: 5
         self:
           type: string
           description: The reference to the connection resource.
@@ -2853,7 +2911,6 @@ components:
     CreateIssueCredentialRecordRequest:
       required:
       - claims
-      - issuingDID
       - connectionId
       type: object
       properties:
@@ -2868,6 +2925,16 @@ components:
           description: The unique identifier of the schema used for this credential
             offer.
           example: https://agent-host.com/prism-agent/schema-registry/schemas/d9569cec-c81e-4779-aa86-0d5994d82676
+        credentialDefinitionId:
+          type: string
+          description: The unique identifier of the credential definition used for
+            this credential offer (AnonCreds only)
+          format: uuid
+          example: d9569cec-c81e-4779-aa86-0d5994d82676
+        credentialFormat:
+          type: string
+          description: The format used for this credential offer (default to 'JWT')
+          example: JWT
         claims:
           description: The claims that will be associated with the issued verifiable
             credential.
@@ -2881,13 +2948,16 @@ components:
           example: true
         issuingDID:
           type: string
-          description: The issuer DID of the verifiable credential object.
+          description: The issuer DID of the verifiable credential (JWT credentials
+            only)
           example: did:prism:issuerofverifiablecredentials
         connectionId:
           type: string
           description: The unique identifier of a DIDComm connection that already
             exists between the issuer and the holder, and that will be used to execute
             the issue credential protocol.
+          format: uuid
+          example: d9569cec-c81e-4779-aa86-0d5994d82676
     CreateManagedDIDResponse:
       required:
       - longFormDid
@@ -3654,10 +3724,12 @@ components:
       required:
       - recordId
       - thid
+      - credentialFormat
       - claims
       - createdAt
       - role
       - protocolState
+      - metaRetries
       type: object
       properties:
         recordId:
@@ -3670,6 +3742,13 @@ components:
             belongs to. The value will identical on both sides of the issue flow (issuer
             and holder)
           example: 0527aea1-d131-3948-a34d-03af39aba8b4
+        credentialFormat:
+          type: string
+          description: The format used for this credential offer (default to 'JWT')
+          example: JWT
+          enum:
+          - JWT
+          - AnonCreds
         subjectId:
           type: string
           description: The identifier (e.g DID) of the subject to which the verifiable
@@ -3696,7 +3775,7 @@ components:
           type: string
           description: The date and time when the issue credential record was created.
           format: date-time
-          example: '2023-09-29T12:30:36.502837Z'
+          example: '2023-10-14T17:00:01.188137Z'
         updatedAt:
           type: string
           description: The date and time when the issue credential record was last
@@ -3729,14 +3808,20 @@ components:
           - ProblemReportPending
           - ProblemReportSent
           - ProblemReportReceived
-        jwtCredential:
+        credential:
           type: string
-          description: The base64-encoded JWT verifiable credential that has been
-            sent by the issuer.
+          description: The base64-encoded verifiable credential, in JWT or AnonCreds
+            format, that has been sent by the issuer.
         issuingDID:
           type: string
           description: Issuer DID of the verifiable credential object.
           example: did:prism:issuerofverifiablecredentials
+        metaRetries:
+          type: integer
+          description: The maximum background processing attempts remaining for this
+            record
+          format: int32
+          example: 5
     IssueCredentialRecordPage:
       required:
       - self
@@ -3886,6 +3971,7 @@ components:
       - thid
       - role
       - status
+      - metaRetries
       type: object
       properties:
         presentationId:
@@ -3943,6 +4029,12 @@ components:
           description: The unique identifier of an established connection between
             the verifier and the prover.
           example: bc528dc8-69f1-4c5a-a508-5f8019047900
+        metaRetries:
+          type: integer
+          description: The maximum background processing attempts remaining for this
+            record
+          format: int32
+          example: 5
     PresentationStatusPage:
       required:
       - self
@@ -4173,6 +4265,7 @@ components:
           type: string
           description: The unique identifier of an established connection between
             the verifier and the prover.
+          format: uuid
           example: bc528dc8-69f1-4c5a-a508-5f8019047900
         options:
           $ref: '#/components/schemas/Options'
@@ -4183,6 +4276,10 @@ components:
           description: The type of proofs requested in the context of this proof presentation
             request (e.g., VC schema, trusted issuers, etc.)
           example: []
+        credentialFormat:
+          type: string
+          description: The credential format (default to 'JWT')
+          example: JWT
     Service:
       required:
       - id

diff --git a/version.sbt b/version.sbt
@@ -1 +1 @@
-ThisBuild / version := "1.16.4-SNAPSHOT"
+ThisBuild / version := "1.17.0-SNAPSHOT"
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		ThisBuild / version := "1.16.4-SNAPSHOT"
		ThisBuild / version := "1.17.0-SNAPSHOT"