feat(prism-agent): move subjectId field from issuer to holder (#435)

* feat(prism-agent): move subjectId field from create credential offer (issuer) to accept credential offer (holder) * test: update e2e tests --------- Co-authored-by: Anton Baliasnikov <[email protected]>
hyperledger · Mar 10, 2023 · d7813ba · d7813ba
1 parent 4377d58
commit d7813ba
Show file tree

Hide file tree

Showing 13 changed files with 170 additions and 132 deletions.
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -12,7 +12,7 @@ on:
       - ".github/workflows/e2e-tests.yml"
       - "infrastructure/shared/docker-compose.yml"
       - "tests/e2e-tests/**"
-      - "prism-agent/service"
+      - "prism-agent/service/**"
   push:
     branches:
       - "main"
@@ -161,7 +161,6 @@ jobs:
         if: github.ref_name == 'main'
         uses: rtCamp/action-slack-notify@v2
         env:
-          SLACK_CHANNEL: atala-qa-results
           SLACK_COLOR: ${{ steps.analyze_test_results.outputs.conclusion }}
           SLACK_MESSAGE: |
             Total: ${{ steps.analyze_test_results.outputs.tests }}

diff --git a/docs/docusaurus/credentials/issue.md b/docs/docusaurus/credentials/issue.md
@@ -62,9 +62,8 @@ This section describes the Issuer role's available interactions with the PRISM A
 To start the process, the issuer needs to create a credential offer.
 To do this, make a `POST` request to the [`/issue-credentials/credential-offers`](/agent-api/#tag/Issue-Credentials-Protocol/operation/createCredentialOffer) endpoint with a JSON payload that includes the following information:
 
-1. `subjectId`: This field represents the unique identifier for the subject of the verifiable credential. It is a DID (Decentralized Identifier) string, such as `did:prism:subjectIdentifier`.
-2. `schemaId`: This is an identifier for a schema, which defines the structure and format of the data in a verifiable credential. The schema identifier must be unique and typically a URL or a URN.
-3. `claims`: The data stored in a verifiable credential. Claims get expressed in a key-value format and must conform to the structure and format defined in the schema. The claims contain the data that the issuer attests to, such as name, address, date of birth, and so on.
+1. `schemaId`: This is an identifier for a schema, which defines the structure and format of the data in a verifiable credential. The schema identifier must be unique and typically a URL or a URN.
+2. `claims`: The data stored in a verifiable credential. Claims get expressed in a key-value format and must conform to the structure and format defined in the schema. The claims contain the data that the issuer attests to, such as name, address, date of birth, and so on.
 
 Once the request initiates, a new credential record for the issuer gets created with a unique ID. The state of this record is now `OfferPending`.
 
@@ -147,11 +146,19 @@ curl "http://localhost:8090/prism-agent/issue-credentials/records" \
 
 ### Approving the VC Offer
 
-To accept the offer, the **Holder** can make a `POST` request to the [`/issue-credentials/records/{recordId}/accept-offer`](/agent-api/#tag/Issue-Credentials-Protocol/operation/acceptCredentialOffer) endpoint:
+To accept the offer, the **Holder** can make a `POST` request to the [`/issue-credentials/records/{recordId}/accept-offer`](/agent-api/#tag/Issue-Credentials-Protocol/operation/acceptCredentialOffer) endpoint with a JSON payload that includes the following information:
+
+1. `holder_record_id`: The unique identifier of the issue credential record known by the holder PRISM Agent.
+2. `subjectId`: This field represents the unique identifier for the subject of the verifiable credential. It is a short-form PRISM DID (Decentralized Identifier) string, such as `did:prism:subjectIdentifier`.
+
 ```shell
 # Holder POST request to accept the credential offer
 curl -X POST "http://localhost:8090/prism-agent/issue-credentials/records/$holder_record_id/accept-offer" \
-    -H "Content-Type: application/json"
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+          "subjectId": "did:prism:subjectIdentifier"
+     }'
 ```
 
 This request will change the state of the record to `RequestPending`.

diff --git a/prism-agent/service/api/http/pollux/schemas.yaml b/prism-agent/service/api/http/pollux/schemas.yaml
@@ -178,7 +178,6 @@ components:
 
     IssueCredentialRecordBase:
       required:
-        - subjectId
         - claims
       properties:
         schemaId:
@@ -222,6 +221,17 @@ components:
               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.
 
+    AcceptCredentialOfferRequest:
+      description: A request to accept a credential offer received from an issuer.
+      type: object
+      required:
+        - subjectId
+      properties:
+        subjectId:
+          type: string
+          description: The short-form subject Prism DID to which the verifiable credential should be issued.
+          example: did:prism:3bb0505d13fcb04d28a48234edb27b0d4e6d7e18a81e2c1abab58f3bbc21ce6f
+
     IssueCredentialRecord:
       description: An issue credential record that stores the state of the protocol execution.
       type: object
@@ -260,6 +270,7 @@ components:
                 - OfferSent
                 - OfferReceived
                 - RequestPending
+                - RequestGenerated
                 - RequestSent
                 - RequestReceived
                 - ProblemReportPending

diff --git a/prism-agent/service/api/http/prism-agent-openapi-spec.yaml b/prism-agent/service/api/http/prism-agent-openapi-spec.yaml
@@ -541,6 +541,13 @@ paths:
       description: Accepts a credential offer received from a VC issuer and sends back a credential request.
       parameters:
         - $ref: "./pollux/parameters.yaml#/components/parameters/issueCredentialRecordIdInPath"
+      requestBody:
+        description: The accept credential offer request object.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: ./pollux/schemas.yaml#/components/schemas/AcceptCredentialOfferRequest
       responses:
         "200":
           description: The issue credential offer was successfully accepted.

diff --git a/prism-agent/service/project/Dependencies.scala b/prism-agent/service/project/Dependencies.scala
@@ -10,7 +10,7 @@ object Dependencies {
     val akka = "2.6.20"
     val akkaHttp = "10.2.9"
     val castor = "0.8.1"
-    val pollux = "0.39.0"
+    val pollux = "0.40.0"
     val connect = "0.11.0"
     val bouncyCastle = "1.70"
     val logback = "1.4.5"

diff --git a/prism-agent/service/server/src/main/scala/io/iohk/atala/agent/server/Modules.scala b/prism-agent/service/server/src/main/scala/io/iohk/atala/agent/server/Modules.scala
@@ -449,7 +449,7 @@ object AppModule {
     (didOpValidatorLayer ++ didServiceLayer ++ secretStorageLayer ++ nonSecretStorageLayer) >>> ManagedDIDService.layer
   }
 
-  val credentialServiceLayer: RLayer[DidOps & DidAgent, CredentialService] =
+  val credentialServiceLayer: RLayer[DidOps & DidAgent & JwtDidResolver, CredentialService] =
     (GrpcModule.layers ++ RepoModule.credentialRepoLayer) >>> CredentialServiceImpl.layer
 
   def presentationServiceLayer =
@@ -508,8 +508,10 @@ object HttpModule {
     (apiServiceLayer ++ apiMarshallerLayer) >>> ZLayer.fromFunction(new DIDRegistrarApi(_, _))
   }
 
-  val issueCredentialsProtocolApiLayer
-      : RLayer[DidOps & DidAgent & ManagedDIDService & ConnectionService & AppConfig, IssueCredentialsProtocolApi] = {
+  val issueCredentialsProtocolApiLayer: RLayer[
+    DidOps & DidAgent & ManagedDIDService & ConnectionService & AppConfig & JwtDidResolver,
+    IssueCredentialsProtocolApi
+  ] = {
     val serviceLayer = AppModule.credentialServiceLayer
     val apiServiceLayer = serviceLayer >>> IssueCredentialsProtocolApiServiceImpl.layer
     val apiMarshallerLayer = IssueCredentialsProtocolApiMarshallerImpl.layer

diff --git a/...o/iohk/atala/agent/server/http/marshaller/IssueCredentialsProtocolApiMarshallerImpl.scala b/...o/iohk/atala/agent/server/http/marshaller/IssueCredentialsProtocolApiMarshallerImpl.scala
@@ -16,6 +16,10 @@ object IssueCredentialsProtocolApiMarshallerImpl extends JsonSupport {
           : FromEntityUnmarshaller[CreateIssueCredentialRecordRequest] =
         summon[RootJsonFormat[CreateIssueCredentialRecordRequest]]
 
+      implicit def fromEntityUnmarshallerAcceptCredentialOfferRequest
+          : FromEntityUnmarshaller[AcceptCredentialOfferRequest] =
+        summon[RootJsonFormat[AcceptCredentialOfferRequest]]
+
       implicit def toEntityMarshallerIssueCredentialRecord: ToEntityMarshaller[IssueCredentialRecord] =
         summon[RootJsonFormat[IssueCredentialRecord]]
 

diff --git a/...ervice/server/src/main/scala/io/iohk/atala/agent/server/http/marshaller/JsonSupport.scala b/...ervice/server/src/main/scala/io/iohk/atala/agent/server/http/marshaller/JsonSupport.scala
@@ -70,6 +70,7 @@ trait JsonSupport extends SprayJsonSupport with DefaultJsonProtocol {
   }
   // Issue
   given RootJsonFormat[CreateIssueCredentialRecordRequest] = jsonFormat7(CreateIssueCredentialRecordRequest.apply)
+  given RootJsonFormat[AcceptCredentialOfferRequest] = jsonFormat1(AcceptCredentialOfferRequest.apply)
   given RootJsonFormat[IssueCredentialRecord] = jsonFormat12(IssueCredentialRecord.apply)
   given RootJsonFormat[IssueCredentialRecordPage] = jsonFormat6(IssueCredentialRecordPage.apply)
 

diff --git a/...cala/io/iohk/atala/agent/server/http/service/IssueCredentialsProtocolApiServiceImpl.scala b/...cala/io/iohk/atala/agent/server/http/service/IssueCredentialsProtocolApiServiceImpl.scala
@@ -50,16 +50,11 @@ class IssueCredentialsProtocolApiServiceImpl(
         .fromEither(PrismDID.fromString(request.issuingDID))
         .mapError(HttpServiceError.InvalidPayload.apply)
         .mapError(_.toOAS)
-      subjectId <- ZIO
-        .fromEither(PrismDID.fromString(request.subjectId))
-        .mapError(HttpServiceError.InvalidPayload.apply)
-        .mapError(_.toOAS)
       outcome <- credentialService
         .createIssueCredentialRecord(
           pairwiseIssuerDID = didIdPair.myDID,
           pairwiseHolderDID = didIdPair.theirDid,
           thid = DidCommID(),
-          subjectId = subjectId.toString,
           schemaId = request.schemaId,
           claims = request.claims,
           validityPeriod = request.validityPeriod,
@@ -121,14 +116,15 @@ class IssueCredentialsProtocolApiServiceImpl(
     }
   }
 
-  override def acceptCredentialOffer(recordId: String)(implicit
+  override def acceptCredentialOffer(recordId: String, request: AcceptCredentialOfferRequest)(implicit
       toEntityMarshallerIssueCredentialRecord: ToEntityMarshaller[IssueCredentialRecord],
       toEntityMarshallerErrorResponse: ToEntityMarshaller[ErrorResponse]
   ): Route = {
     val result = for {
       id <- recordId.toDidCommID
+      prismDID <- ZIO.fromEither(PrismDID.fromString(request.subjectId)).mapError(HttpServiceError.InvalidPayload.apply)
       outcome <- credentialService
-        .acceptCredentialOffer(id)
+        .acceptCredentialOffer(id, request.subjectId)
         .mapError(HttpServiceError.DomainError[CredentialServiceError].apply)
     } yield outcome