feat: PresentationDefinition API improvements: (#3547)

- CreateVP methods set VP IDs - Match supports merged submission map[string]interface{} and VP submission fields of PresentationSubmission type. Signed-off-by: Filip Burlacu <filip.burlacu@securekey.com>
hyperledger-archives · Mar 7, 2023 · 8771727 · 8771727
1 parent 06f7338
commit 8771727
Show file tree

Hide file tree

Showing 5 changed files with 131 additions and 42 deletions.
diff --git a/pkg/doc/presexch/api.go b/pkg/doc/presexch/api.go
@@ -66,6 +66,7 @@ type MatchOptions struct {
 	CredentialOptions       []verifiable.CredentialOpt
 	DisableSchemaValidation bool
 	MergedSubmission        *PresentationSubmission
+	MergedSubmissionMap     map[string]interface{}
 }
 
 // MatchOption is an option that sets an option for when matching.
@@ -96,6 +97,18 @@ func WithMergedSubmission(submission *PresentationSubmission) MatchOption {
 	}
 }
 
+// WithMergedSubmissionMap provides a presentation submission that's external to the Presentations being matched,
+// which contains the descriptor mapping for each Presentation. This submission is expected to be in the
+// map[string]interface{} format used by json.Unmarshal.
+//
+// If there are multiple Presentations, this merged submission should use the Presentation array as the JSON Path root
+// when referencing the contained Presentations and the Credentials within.
+func WithMergedSubmissionMap(submissionMap map[string]interface{}) MatchOption {
+	return func(m *MatchOptions) {
+		m.MergedSubmissionMap = submissionMap
+	}
+}
+
 // Match returns the credentials matched against the InputDescriptors ids.
 func (pd *PresentationDefinition) Match(vpList []*verifiable.Presentation,
 	contextLoader ld.DocumentLoader, options ...MatchOption) (map[string]MatchValue, error) {
@@ -128,12 +141,21 @@ func getMatchedCreds( //nolint:gocyclo,funlen
 
 	descriptorIDs := descriptorIDs(pd.InputDescriptors)
 
-	useMergedSubmission := opts.MergedSubmission != nil
+	useMergedSubmission := opts.MergedSubmission != nil || len(opts.MergedSubmissionMap) != 0
 
 	var mappingsByVPIndex map[int][]*InputDescriptorMapping
 
-	if useMergedSubmission {
+	if opts.MergedSubmission != nil {
 		mappingsByVPIndex = descriptorsByPresentationIndex(opts.MergedSubmission.DescriptorMap)
+	} else if len(opts.MergedSubmissionMap) != 0 {
+		useMergedSubmission = true
+
+		descs, err := getDescriptorMapping(opts.MergedSubmissionMap)
+		if err != nil {
+			return nil, fmt.Errorf("failed to parse descriptor map: %w", err)
+		}
+
+		mappingsByVPIndex = descriptorsByPresentationIndex(descs)
 	}
 
 	rawVPs := make([]interface{}, len(vpList))
@@ -295,11 +317,24 @@ func checkJSONLDContextType(vp *verifiable.Presentation) error {
 }
 
 func parseDescriptorMap(vp *verifiable.Presentation) ([]*InputDescriptorMapping, error) {
-	submission, ok := vp.CustomFields[submissionProperty].(map[string]interface{})
+	untypedSubmission, ok := vp.CustomFields[submissionProperty]
 	if !ok {
 		return nil, fmt.Errorf("missing '%s' on verifiable presentation", submissionProperty)
 	}
 
+	switch submission := untypedSubmission.(type) {
+	case map[string]interface{}:
+		return getDescriptorMapping(submission)
+	case *PresentationSubmission:
+		return submission.DescriptorMap, nil
+	case PresentationSubmission:
+		return submission.DescriptorMap, nil
+	default:
+		return nil, fmt.Errorf("missing '%s' on verifiable presentation", submissionProperty)
+	}
+}
+
+func getDescriptorMapping(submission map[string]interface{}) ([]*InputDescriptorMapping, error) {
 	descriptorMap, ok := submission[descriptorMapProperty].([]interface{})
 	if !ok {
 		return nil, fmt.Errorf("missing '%s' on verifiable presentation", descriptorMapProperty)

diff --git a/pkg/doc/presexch/api_test.go b/pkg/doc/presexch/api_test.go
@@ -117,22 +117,25 @@ func TestPresentationDefinition_Match(t *testing.T) {
 
 		docLoader := createTestDocumentLoader(t, uri, customType)
 
-		presList := []*verifiable.Presentation{
-			newVP(t,
-				&PresentationSubmission{
-					DescriptorMap: []*InputDescriptorMapping{
-						{
+		vpWithSubmissionType := newVP(t, nil, expected)
+
+		vpWithSubmissionType.CustomFields = map[string]interface{}{
+			"presentation_submission": &PresentationSubmission{
+				DescriptorMap: []*InputDescriptorMapping{
+					{
+						ID:   defs.InputDescriptors[0].ID,
+						Path: "$", // TODO: $[0]
+						PathNested: &InputDescriptorMapping{
 							ID:   defs.InputDescriptors[0].ID,
-							Path: "$", // TODO: $[0]
-							PathNested: &InputDescriptorMapping{
-								ID:   defs.InputDescriptors[0].ID,
-								Path: "$.verifiableCredential[0]",
-							},
+							Path: "$.verifiableCredential[0]",
 						},
 					},
 				},
-				expected,
-			),
+			},
+		}
+
+		presList := []*verifiable.Presentation{
+			vpWithSubmissionType,
 			newVP(t,
 				&PresentationSubmission{
 					DescriptorMap: []*InputDescriptorMapping{
@@ -209,28 +212,30 @@ func TestPresentationDefinition_Match(t *testing.T) {
 			newVP(t, nil, expectedTwo),
 		}
 
-		opt := []MatchOption{
-			WithCredentialOptions(verifiable.WithJSONLDDocumentLoader(docLoader)),
-			WithMergedSubmission(&PresentationSubmission{
-				DescriptorMap: []*InputDescriptorMapping{
-					{
+		submission := &PresentationSubmission{
+			DescriptorMap: []*InputDescriptorMapping{
+				{
+					ID:   defs.InputDescriptors[0].ID,
+					Path: "$[0]",
+					PathNested: &InputDescriptorMapping{
 						ID:   defs.InputDescriptors[0].ID,
-						Path: "$[0]",
-						PathNested: &InputDescriptorMapping{
-							ID:   defs.InputDescriptors[0].ID,
-							Path: "$.verifiableCredential[0]",
-						},
+						Path: "$.verifiableCredential[0]",
 					},
-					{
+				},
+				{
+					ID:   defs.InputDescriptors[1].ID,
+					Path: "$[1]",
+					PathNested: &InputDescriptorMapping{
 						ID:   defs.InputDescriptors[1].ID,
-						Path: "$[1]",
-						PathNested: &InputDescriptorMapping{
-							ID:   defs.InputDescriptors[1].ID,
-							Path: "$.verifiableCredential[0]",
-						},
+						Path: "$.verifiableCredential[0]",
 					},
 				},
-			}),
+			},
+		}
+
+		opt := []MatchOption{
+			WithCredentialOptions(verifiable.WithJSONLDDocumentLoader(docLoader)),
+			WithMergedSubmission(submission),
 		}
 
 		matched, err := defs.Match(presList, docLoader, opt...)
@@ -242,6 +247,30 @@ func TestPresentationDefinition_Match(t *testing.T) {
 		result, ok = matched[defs.InputDescriptors[1].ID]
 		require.True(t, ok)
 		require.Equal(t, expectedTwo.ID, result.Credential.ID)
+
+		// json-unmarshalled merged submission
+
+		submissionJSON := map[string]interface{}{}
+
+		submissionBytes, err := json.Marshal(submission)
+		require.NoError(t, err)
+
+		require.NoError(t, json.Unmarshal(submissionBytes, &submissionJSON))
+
+		opt = []MatchOption{
+			WithCredentialOptions(verifiable.WithJSONLDDocumentLoader(docLoader)),
+			WithMergedSubmissionMap(submissionJSON),
+		}
+
+		matched, err = defs.Match(presList, docLoader, opt...)
+		require.NoError(t, err)
+		require.Len(t, matched, 2)
+		result, ok = matched[defs.InputDescriptors[0].ID]
+		require.True(t, ok)
+		require.Equal(t, expected.ID, result.Credential.ID)
+		result, ok = matched[defs.InputDescriptors[1].ID]
+		require.True(t, ok)
+		require.Equal(t, expectedTwo.ID, result.Credential.ID)
 	})
 
 	t.Run("match one presentation, with merged submission", func(t *testing.T) {

diff --git a/pkg/doc/presexch/definition.go b/pkg/doc/presexch/definition.go
@@ -449,6 +449,7 @@ func presentation(credentials ...*verifiable.Credential) (*verifiable.Presentati
 
 	vp.Context = append(vp.Context, PresentationSubmissionJSONLDContextIRI)
 	vp.Type = append(vp.Type, PresentationSubmissionJSONLDType)
+	vp.ID = uuid.NewString()
 
 	return vp, nil
 }

diff --git a/pkg/doc/presexch/example_v1_test.go b/pkg/doc/presexch/example_v1_test.go
@@ -76,6 +76,7 @@ func ExamplePresentationDefinition_CreateVP_v1() {
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -90,6 +91,7 @@ func ExamplePresentationDefinition_CreateVP_v1() {
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",
@@ -184,6 +186,7 @@ func ExamplePresentationDefinition_CreateVP_v1_With_LDP_FormatAndProof() {
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -198,6 +201,7 @@ func ExamplePresentationDefinition_CreateVP_v1_With_LDP_FormatAndProof() {
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",
@@ -292,6 +296,7 @@ func ExamplePresentationDefinition_CreateVP_v1_With_LDPVC_FormatAndProof() {
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -306,6 +311,7 @@ func ExamplePresentationDefinition_CreateVP_v1_With_LDPVC_FormatAndProof() {
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",
@@ -424,6 +430,7 @@ func ExamplePresentationDefinition_CreateVP_multipleMatches() {
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -438,6 +445,7 @@ func ExamplePresentationDefinition_CreateVP_multipleMatches() {
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",
@@ -604,6 +612,7 @@ func ExamplePresentationDefinition_CreateVP_multipleMatchesDisclosure() {
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -618,6 +627,7 @@ func ExamplePresentationDefinition_CreateVP_multipleMatchesDisclosure() {
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",
@@ -848,6 +858,7 @@ func ExamplePresentationDefinition_CreateVP_submissionRequirementsLimitDisclosur
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -862,6 +873,7 @@ func ExamplePresentationDefinition_CreateVP_submissionRequirementsLimitDisclosur
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",
@@ -1090,6 +1102,7 @@ func ExamplePresentationDefinition_CreateVP_submissionRequirements() {
 		panic(err)
 	}
 
+	vp.ID = dummy
 	vp.CustomFields["presentation_submission"].(*PresentationSubmission).ID = dummy
 
 	vpBytes, err := json.MarshalIndent(vp, "", "\t")
@@ -1104,6 +1117,7 @@ func ExamplePresentationDefinition_CreateVP_submissionRequirements() {
 	//		"https://www.w3.org/2018/credentials/v1",
 	//		"https://identity.foundation/presentation-exchange/submission/v1"
 	//	],
+	//	"id": "DUMMY",
 	//	"presentation_submission": {
 	//		"id": "DUMMY",
 	//		"definition_id": "c1b88ce1-8460-4baf-8f16-4759a2f055fd",