feat(prism-agent): Integrate Verification Flow - ATL-2117

mercury/mercury-library/version.sbt

@@ -1 +1 @@
-ThisBuild / version := "0.7.0-SNAPSHOT"
+ThisBuild / version := "0.8.0-SNAPSHOT"

pollux/lib/core/src/main/scala/io/iohk/atala/pollux/core/model/PresentationRecord.scala

@@ -57,13 +57,15 @@ object PresentationRecord {
     // Prover has "accepted" a Presentation request received from a Verifier (Prover DB)
     case PresentationPending extends ProtocolState
     // Prover has generated (signed) the VC  and is now ready to send it to the Verifier (Prover DB)
-    case PresentationGenerated extends ProtocolState
-    // The Presentation has been sent to the Verifier (Prover DB)
+
+    //Prover has sent the Presentation (Prover DB)
     case PresentationSent extends ProtocolState
     // Verifier has received the presentation (Verifier DB)
     case PresentationReceived extends ProtocolState
     // Verifier has verified the presentation (proof) (Verifier DB)
     case PresentationVerified extends ProtocolState
+    // Verifier has accepted the verified presentation (proof) (Verifier DB)
+    case PresentationAccepted extends ProtocolState
     // Verifier has rejected the presentation (proof) (Verifier DB)
     case PresentationRejected extends ProtocolState // TODO send problem report
 

pollux/lib/core/src/main/scala/io/iohk/atala/pollux/core/service/PresentationService.scala

@@ -78,17 +78,14 @@ trait PresentationService {
 
   def markProposePresentationSent(recordId: UUID): IO[PresentationError, Option[PresentationRecord]]
 
-  def markPresentationGenerated(
-      recordId: UUID,
-      presentation: Presentation
-  ): IO[PresentationError, Option[PresentationRecord]]
-
   def markPresentationSent(recordId: UUID): IO[PresentationError, Option[PresentationRecord]]
 
   def markPresentationVerified(recordId: UUID): IO[PresentationError, Option[PresentationRecord]]
 
   def markPresentationRejected(recordId: UUID): IO[PresentationError, Option[PresentationRecord]]
 
+  def markPresentationAccepted(recordId: UUID): IO[PresentationError, Option[PresentationRecord]]
+
 }
 
 object PresentationServiceImpl {
@@ -237,7 +234,7 @@ private class PresentationServiceImpl(
   ): IO[PresentationError, Option[PresentationRecord]] = {
 
     for {
-      // crecentialsToUse
+
       maybeRecord <- presentationRepository
         .getPresentationRecord(recordId)
         .mapError(RepositoryError.apply)
@@ -255,7 +252,6 @@ private class PresentationServiceImpl(
         .mapError(RepositoryError.apply)
 
       issuedRawCredentials = issuedValidCredentials.map(_.issuedCredentialRaw.map(IssuedCredentialRaw(_))).flatten
-      x = List(1)
       issuedCredentials <- ZIO.fromEither(
         Either.cond(
           issuedRawCredentials.nonEmpty,
@@ -294,9 +290,8 @@ private class PresentationServiceImpl(
       presentationRequest <- ZIO
         .fromOption(record.presentationData)
         .mapError(_ => InvalidFlowStateError(s"No request found for this record: $recordId"))
-      _ <- ZIO.log(s"************presentationRequest*************$presentationRequest")
-      _ <- verifyPresentation(presentationRequest) // TODO
-      recordUpdated <- markPresentationVerified(record.id)
+
+      recordUpdated <- markPresentationAccepted(record.id)
 
     } yield recordUpdated
   }
@@ -381,26 +376,13 @@ private class PresentationServiceImpl(
       PresentationRecord.ProtocolState.PresentationVerified
     )
 
-  override def markPresentationGenerated(
-      recordId: UUID,
-      presentation: Presentation
-  ): IO[PresentationError, Option[PresentationRecord]] = {
-    for {
-      count <- presentationRepository
-        .updateWithPresentation(
-          recordId,
-          presentation,
-          PresentationRecord.ProtocolState.PresentationGenerated
-        )
-        .mapError(RepositoryError.apply)
-      _ <- count match
-        case 1 => ZIO.succeed(())
-        case n => ZIO.fail(RecordIdNotFound(recordId))
-      record <- presentationRepository
-        .getPresentationRecord(recordId)
-        .mapError(RepositoryError.apply)
-    } yield record
-  }
+   override def markPresentationAccepted(recordId: UUID): IO[PresentationError, Option[PresentationRecord]] =
+    updatePresentationRecordProtocolState(
+      recordId,
+      PresentationRecord.ProtocolState.PresentationVerified,
+      PresentationRecord.ProtocolState.PresentationAccepted
+    )
+
 
   override def markPresentationSent(recordId: UUID): IO[PresentationError, Option[PresentationRecord]] =
     updatePresentationRecordProtocolState(

prism-agent/service/.scalafmt.conf

@@ -1,4 +1,5 @@
 version = 3.5.9
 runner.dialect = scala3
 
-maxColumn = 120
+maxColumn = 120
+trailingCommas = preserve

prism-agent/service/README.md

@@ -31,7 +31,11 @@ Basic documentation on how to execute the Connect flow from command line can be
 Basic documentation on how to execute the Issue flow from the command line can be found [here](./issue.md).
 
 ---
-## DID lifecycle flow
-Basic documentation on how to execute the basic DID lifecycle from command line can be found [here](./did.md)
+## Presnt Proof flow
+Basic documentation on how to execute the Present Proof flow from the command line can be found [here](./present-proof.md).
+
+
+---
+## Known limitations
 
 ---

prism-agent/service/api/http/pollux/schemas.yaml

@@ -1,6 +1,6 @@
 components:
   schemas:
-# Common
+    # Common
     InternalServerError:
       required:
         - msg
@@ -28,8 +28,8 @@ components:
           type: array
           items:
             type: string
-    
-# Schema Registry
+
+    # Schema Registry
 
     Proof:
       required:
@@ -224,8 +224,8 @@ components:
           items:
             $ref: '#/components/schemas/VerificationPolicy'
 
-# Issue Credential Protocol
-    
+    # Issue Credential Protocol
+
     CreateIssueCredentialRecordRequest:
       description: A request to create a new "issue credential record"
       required:
@@ -304,7 +304,7 @@ components:
                 - Published
             jwtCredential:
               type: string
-    
+
     IssueCredentialRecordCollection:
       description: A collection of issue credential records
       required:
@@ -324,6 +324,126 @@ components:
         count:
           type: integer
 
+    #
+
+    W3CCredentialInput:
+      description: |-
+        Credential input object based on which the new instance of the verifiable credentials is created.
+        Object contains the minimal set of the fields required to create the credentials for the given subject.
+        All other required fields of the verifiable credential depend on the context of the cloud agent
+      required:
+        - subjectId
+        - claims
+      properties:
+        schemaId:
+          type: string
+          description: "Identity of the Verifiable Credentials Schema associated with this object"
+          example: "did:example:MDP8AsFhHzhwUvGNuYkX7T;id=06e126d1-fa44-4882-a243-1e326fbe21db;version=1.0"
+        subjectId:
+          type: string
+          description: "Subject DID of the verifiable credentials object"
+          example: "did:prism:subjectofverifiablecredentials"
+        validityPeriod:
+          type: number
+          description: "The validity period in seconds of the verifiable credential"
+          example: 3600
+        claims:
+          type: object
+          additionalProperties:
+            type: string
+          description: "Clams associated with given credentials object (for now it's just a key/value, later should be more complex"
+
+    W3CCredential:
+      description: "Verifiable Credential Object according to W3C specification"
+      required: ["id", "type", "issuer", "issuanceDate", "credentialSubject"]
+      properties:
+        id:
+          type: string
+          description: "Credential id or url that can be used to get the status of revoke the credential"
+          example: "http://example.edu/credentials/1872"
+        type:
+          type: string
+          description: "Credential type according to W3C specification. Must include VerifiableCredentials and type of concrete credentials"
+          example: '["VerifiableCredential", "AlumniCredential"]'
+        issuer:
+          type: string
+          description: "Issuer DID"
+          example: "did:prism:issuerdid"
+        issuanceDate:
+          type: string
+          description: "Datetime in ISO format that corresponds to the date of issuance"
+          example: "2010-01-01T19:23:24Z"
+        credentialSubject:
+          type: object
+          description: "Credentials subject DID and claims according to the schema object"
+          additionalProperties:
+            type: string
+          example:
+            id: "did:prism:subject12345"
+            alumni_of: "University"
+            degree: "master of openapi specification"
+        proof:
+          $ref: "#/components/schemas/W3CProof"
+
+    W3CCredentialsPaginated:
+      description: "Paginated response that contains an array of the credential objects"
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/W3CCredential"
+        offset:
+          type: integer
+        limit:
+          type: integer
+        count:
+          type: integer
+
+    W3CIssuanceBatch:
+      description: "An issuance batch object that is associated with thelist of verifiable credentials"
+      properties:
+        id:
+          type: string
+          description: "Issuance batch id"
+        count:
+          type: integer
+          description: "Count of the verifiable credentials object in the batch"
+        actions:
+          type: array
+          items:
+            $ref: "#/components/schemas/W3CIssuanceBatchAction"
+
+    W3CIssuanceBatchAction:
+      description: "Action performed on the list of credentials associated with the issuance batch"
+      properties:
+        action:
+          description: "Action name"
+          type: string
+          enum: ["sign", "issue", "send"]
+          example: "issue"
+        id:
+          description: "Action id for tracking"
+          type: string
+          example: "uid"
+        status:
+          description: "Action status"
+          type: string
+          enum: ["scheduled", "pending", "completed", "failed"]
+
+    W3CIssuanceBatchPaginated:
+      description: "Paginated response that contains an array of the issuance-batch objects"
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/W3CIssuanceBatch"
+        offset:
+          type: integer
+        limit:
+          type: integer
+        count:
+          type: integer
+
     W3CCredentialStatus:
       description: Verifiable Credential revocation status
       required:
@@ -382,17 +502,73 @@ components:
             - completed
             - failed
 
-    W3CPresentationInput:
-      description: Verifiable Presentation input
+    ProofRequestAux:
+      required: [schemaId, trustIssuers]
       properties:
-        schemas:
-          type: string # TODO: Define the schema for Presentation Input
+        schemaId:
+          description: Ex ID card or driving licence
+          type: string
+          example: "https://schema.org/Person"
+        trustIssuers:
+          description: Issuer that the verifier trust trust
+          example:
+            [
+              "did:web:atalaprism.io/users/testUser",
+              "did.prism:123",
+              "did:prism:...",
+            ]
+          type: array
+          items:
+            type: string
 
-    W3CPresentation:
-      description: Verifiable Presentation object
+    RequestPresentationInput:
+      description: Request Presentation Input
+      required: [connectionId, proofs]
+      properties:
+        connectionId:
+          type: string
+        proofs:
+          type: array
+          items:
+            $ref: "#/components/schemas/ProofRequestAux"
+    RequestPresentationOutput:
+      description: Request Presentation Output
+      required: [presentationId]
       properties:
-        schemas:
-          type: string # TODO: define the exactly schema for Presentation
+        presentationId:
+          description: Ref to the id on the presentation (db ref)
+          type: string
+    PresentationStatus:
+      description: Presentation Status
+      required: [presentationId, status, proofs]
+      properties:
+        presentationId:
+          type: string
+        status:
+          type: string
+        proofs:
+          type: array
+          items:
+            $ref: "#/components/schemas/ProofRequestAux"
+        connectionId:
+          type: string
+    RequestPresentationAction:
+      # RequestPresentationActionAccept:
+      description: Actions on presetations (to update)
+      required: [action]
+      properties:
+        action:
+          type: string
+          enum:
+            - request-accept
+            - request-reject
+            - presentation-accept
+            - presentation-reject
+        proofId:
+          description: This is to choose what VCs to use
+          type: array
+          items:
+            type: string
 
     W3CPresentationPaginated:
       description: "Paginated response that contains an array of the presentation objects"