uptake latest spec changes for json schema (#448)

* uptake latest spec changes * lint
TBD54566975 · Aug 18, 2023 · 6e10433 · 6e10433
1 parent 0c788e2
commit 6e10433
Show file tree

Hide file tree

Showing 13 changed files with 78 additions and 63 deletions.
diff --git a/credential/builder.go b/credential/builder.go
@@ -15,6 +15,8 @@ const (
 	VerifiableCredentialsLinkedDataContext string = "https://www.w3.org/2018/credentials/v1"
 	VerifiableCredentialType               string = "VerifiableCredential"
 	VerifiableCredentialIDProperty         string = "id"
+	// VerifiableCredentialJSONSchemaProperty as defined by https://www.w3.org/TR/vc-json-schema/#jsonschemacredential
+	VerifiableCredentialJSONSchemaProperty string = "jsonSchema"
 	VerifiablePresentationType             string = "VerifiablePresentation"
 
 	BuilderEmptyError string = "builder cannot be empty"

diff --git a/credential/model.go b/credential/model.go
@@ -56,6 +56,14 @@ func (cs CredentialSubject) GetID() string {
 	return id
 }
 
+func (cs CredentialSubject) GetJSONSchema() map[string]any {
+	var schema map[string]any
+	if gotSchema, ok := cs[VerifiableCredentialJSONSchemaProperty]; ok {
+		schema = gotSchema.(map[string]any)
+	}
+	return schema
+}
+
 type CredentialSchema struct {
 	ID   string `json:"id" validate:"required"`
 	Type string `json:"type" validate:"required"`

diff --git a/credential/schema/access.go b/credential/schema/access.go
@@ -54,7 +54,7 @@ func (ra *RemoteAccess) GetVCJSONSchema(ctx context.Context, t VCJSONSchemaType,
 	}
 
 	switch t {
-	case CredentialSchema2023Type:
+	case JSONSchemaCredentialType:
 		// either a jwt or credential json
 		var schemaCred any
 		if err = json.NewDecoder(resp.Body).Decode(&schemaCred); err != nil {
@@ -64,16 +64,17 @@ func (ra *RemoteAccess) GetVCJSONSchema(ctx context.Context, t VCJSONSchemaType,
 		if err != nil {
 			return nil, errors.Wrap(err, "error decoding schema from credential")
 		}
-		credSubjectBytes, err := json.Marshal(cred.CredentialSubject)
+		jsonSchemaValue := cred.CredentialSubject.GetJSONSchema()
+		credSubjectBytes, err := json.Marshal(jsonSchemaValue)
 		if err != nil {
-			return nil, errors.Wrap(err, "error marshalling credential subject")
+			return nil, errors.Wrap(err, "error marshalling jsonSchema property in the credential subject")
 		}
 		var schema JSONSchema
 		if err = json.Unmarshal(credSubjectBytes, &schema); err != nil {
 			return nil, errors.Wrap(err, "error unmarshalling credential subject to schema")
 		}
 		return schema, nil
-	case JSONSchema2023Type:
+	case JSONSchemaType:
 		var schema JSONSchema
 		if err = json.NewDecoder(resp.Body).Decode(&schema); err != nil {
 			return nil, errors.Wrap(err, "error decoding schema")

diff --git a/credential/schema/access_test.go b/credential/schema/access_test.go
@@ -13,10 +13,10 @@ import (
 
 func TestRemoteAccess(t *testing.T) {
 	remoteAccess := NewRemoteAccess(nil)
-	schema, err := getTestVector(jsonSchema2023Schema1)
+	schema, err := getTestVector(jsonSchemaSchema1)
 	require.NoError(t, err)
 
-	schemaCred, err := getTestVector(credentialSchema2023Schema1)
+	schemaCred, err := getTestVector(jsonSchemaCredentialSchema1)
 	require.NoError(t, err)
 
 	t.Run("access JsonSchema2023", func(t *testing.T) {
@@ -25,7 +25,7 @@ func TestRemoteAccess(t *testing.T) {
 			Reply(200).BodyString(schema)
 		defer gock.Off()
 
-		jsonSchema, err := remoteAccess.GetVCJSONSchema(context.Background(), JSONSchema2023Type, "https://example.com/schemas/email.json")
+		jsonSchema, err := remoteAccess.GetVCJSONSchema(context.Background(), JSONSchemaType, "https://example.com/schemas/email.json")
 		assert.NoError(t, err)
 		assert.JSONEq(t, schema, jsonSchema.String())
 	})
@@ -36,7 +36,7 @@ func TestRemoteAccess(t *testing.T) {
 			Reply(200).BodyString(schema)
 		defer gock.Off()
 
-		cred, err := getTestVector(jsonSchema2023Credential1)
+		cred, err := getTestVector(jsonSchemaCredential1)
 		assert.NoError(t, err)
 
 		var vc credential.VerifiableCredential
@@ -53,7 +53,7 @@ func TestRemoteAccess(t *testing.T) {
 			Reply(200).BodyString(schemaCred)
 		defer gock.Off()
 
-		jsonSchema, err := remoteAccess.GetVCJSONSchema(context.Background(), JSONSchema2023Type, "https://example.com/credentials/3734")
+		jsonSchema, err := remoteAccess.GetVCJSONSchema(context.Background(), JSONSchemaType, "https://example.com/credentials/3734")
 		assert.NoError(t, err)
 		assert.JSONEq(t, schemaCred, jsonSchema.String())
 	})
@@ -64,7 +64,7 @@ func TestRemoteAccess(t *testing.T) {
 			Reply(200).BodyString(schemaCred)
 		defer gock.Off()
 
-		cred, err := getTestVector(credentialSchema2023Credential1)
+		cred, err := getTestVector(jsonSchemaCredentialCredential1)
 		assert.NoError(t, err)
 
 		var vc credential.VerifiableCredential

diff --git a/credential/schema/model.go b/credential/schema/model.go
@@ -7,10 +7,10 @@ import (
 )
 
 const (
-	// CredentialSchema2023Type https://www.w3.org/TR/vc-json-schema/#credentialschema2023
-	CredentialSchema2023Type VCJSONSchemaType = "CredentialSchema2023"
-	// JSONSchema2023Type https://www.w3.org/TR/vc-json-schema/#jsonschema2023
-	JSONSchema2023Type VCJSONSchemaType = "JsonSchema2023"
+	// JSONSchemaCredentialType https://www.w3.org/TR/vc-json-schema/#jsonschemacredential
+	JSONSchemaCredentialType VCJSONSchemaType = "JsonSchemaCredential"
+	// JSONSchemaType https://www.w3.org/TR/vc-json-schema/#jsonschema
+	JSONSchemaType VCJSONSchemaType = "JsonSchema"
 
 	Draft202012 JSONSchemaVersion = "https://json-schema.org/draft/2020-12/schema"
 	Draft201909 JSONSchemaVersion = "https://json-schema.org/draft/2019-09/schema"
@@ -114,5 +114,5 @@ func IsSupportedVCJSONSchemaType(t string) bool {
 
 // GetSupportedVCJSONSchemaTypes returns the supported VC JSON Schema types
 func GetSupportedVCJSONSchemaTypes() []VCJSONSchemaType {
-	return []VCJSONSchemaType{CredentialSchema2023Type, JSONSchema2023Type}
+	return []VCJSONSchemaType{JSONSchemaCredentialType, JSONSchemaType}
 }
diff --git a/credential/schema/testdata/credentialschema2023-schema-1.json b/credential/schema/testdata/credentialschema2023-schema-1.json
diff --git a/...testdata/jsonschema2023-credential-1.json → ...ema/testdata/jsonschema-credential-1.json b/...testdata/jsonschema2023-credential-1.json → ...ema/testdata/jsonschema-credential-1.json
@@ -13,6 +13,6 @@
   },
   "credentialSchema": {
     "id": "https://example.com/schemas/email.json",
-    "type": "JsonSchema2023"
+    "type": "JsonSchema"
   }
 }
diff --git a/...ema/testdata/jsonschema2023-schema-1.json → .../schema/testdata/jsonschema-schema-1.json b/...ema/testdata/jsonschema2023-schema-1.json → .../schema/testdata/jsonschema-schema-1.json
@@ -2,7 +2,7 @@
   "$id": "https://example.com/schemas/email.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "name": "EmailCredential",
-  "description": "EmailCredential using JsonSchema2023",
+  "description": "EmailCredential using JsonSchema",
   "type": "object",
   "properties": {
     "credentialSubject": {

diff --git a/...ta/credentialschema2023-credential-1.json → ...ta/jsonschemacredential-credential-1.json b/...ta/credentialschema2023-credential-1.json → ...ta/jsonschemacredential-credential-1.json
@@ -4,7 +4,7 @@
     "https://www.w3.org/ns/credentials/examples/v2"
   ],
   "id": "https://example.com/credentials/3733",
-  "type": ["VerifiableCredential", "EmailCredential"],
+  "type": ["VerifiableCredential", "ExampleEmailCredential"],
   "issuer": "https://example.com/issuers/14",
   "issuanceDate": "2010-01-01T19:23:24Z",
   "credentialSubject": {
@@ -13,6 +13,6 @@
   },
   "credentialSchema": {
     "id": "https://example.com/credentials/3734",
-    "type": "CredentialSchema2023"
+    "type": "JsonSchemaCredential"
   }
 }
diff --git a/credential/schema/testdata/jsonschemacredential-schema-1.json b/credential/schema/testdata/jsonschemacredential-schema-1.json
@@ -0,0 +1,33 @@
+{
+  "@context": [
+    "https://www.w3.org/ns/credentials/v2",
+    "https://www.w3.org/ns/credentials/examples/v2"
+  ],
+  "id": "https://example.com/credentials/3734",
+  "type": ["VerifiableCredential", "JsonSchemaCredential"],
+  "issuer": "https://example.com/issuers/14",
+  "issuanceDate": "2010-01-01T19:23:24Z",
+  "credentialSubject": {
+    "id": "https://example.com/schemas/email-credential-schema.json",
+    "type": "JsonSchema",
+    "jsonSchema": {
+      "$id": "https://example.com/schemas/email-credential-schema.json",
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "name": "EmailCredential",
+      "description": "EmailCredential using JsonSchemaCredential",
+      "type": "object",
+      "properties": {
+        "credentialSubject": {
+          "type": "object",
+          "properties": {
+            "emailAddress": {
+              "type": "string",
+              "format": "email"
+            }
+          },
+          "required": ["emailAddress"]
+        }
+      }
+    }
+  }
+}
diff --git a/credential/schema/vcjsonschema_test.go b/credential/schema/vcjsonschema_test.go
@@ -12,10 +12,10 @@ import (
 )
 
 const (
-	jsonSchema2023Credential1       string = "jsonschema2023-credential-1.json"
-	jsonSchema2023Schema1           string = "jsonschema2023-schema-1.json"
-	credentialSchema2023Credential1 string = "credentialschema2023-credential-1.json"
-	credentialSchema2023Schema1     string = "credentialschema2023-schema-1.json"
+	jsonSchemaCredential1           string = "jsonschema-credential-1.json"
+	jsonSchemaSchema1               string = "jsonschema-schema-1.json"
+	jsonSchemaCredentialCredential1 string = "jsonschemacredential-credential-1.json"
+	jsonSchemaCredentialSchema1     string = "jsonschemacredential-schema-1.json"
 )
 
 var (
@@ -24,8 +24,8 @@ var (
 )
 
 func TestValidateCredentialAgainstSchema(t *testing.T) {
-	t.Run("validate credential against JsonSchema2023", func(t *testing.T) {
-		cred, err := getTestVector(jsonSchema2023Credential1)
+	t.Run("validate credential against JsonSchema", func(t *testing.T) {
+		cred, err := getTestVector(jsonSchemaCredential1)
 		assert.NoError(t, err)
 
 		var vc credential.VerifiableCredential
@@ -36,8 +36,8 @@ func TestValidateCredentialAgainstSchema(t *testing.T) {
 		assert.NoError(t, err)
 	})
 
-	t.Run("validate credential against CredentialSchema2023", func(t *testing.T) {
-		cred, err := getTestVector(credentialSchema2023Credential1)
+	t.Run("validate credential against JsonSchemaCredential", func(t *testing.T) {
+		cred, err := getTestVector(jsonSchemaCredentialCredential1)
 		assert.NoError(t, err)
 
 		var vc credential.VerifiableCredential
@@ -57,24 +57,24 @@ func (localAccess) GetVCJSONSchema(_ context.Context, _ VCJSONSchemaType, id str
 	var err error
 	switch id {
 	case "https://example.com/schemas/email.json":
-		schema, err = getTestVector(jsonSchema2023Schema1)
+		schema, err = getTestVector(jsonSchemaSchema1)
 		if err != nil {
 			return nil, err
 		}
 	case "https://example.com/credentials/3734":
-		schemaCred, err := getTestVector(credentialSchema2023Schema1)
+		schemaCred, err := getTestVector(jsonSchemaCredentialSchema1)
 		if err != nil {
 			return nil, err
 		}
 		var cred credential.VerifiableCredential
 		if err = json.Unmarshal([]byte(schemaCred), &cred); err != nil {
 			return nil, err
 		}
-		credSubjectBytes, err := json.Marshal(cred.CredentialSubject)
+		jsonSchemaBytes, err := json.Marshal(cred.CredentialSubject.GetJSONSchema())
 		if err != nil {
 			return nil, errors.Wrap(err, "error marshalling credential subject")
 		}
-		schema = string(credSubjectBytes)
+		schema = string(jsonSchemaBytes)
 	}
 	if err = json.Unmarshal([]byte(schema), &s); err != nil {
 		return nil, err

diff --git a/credential/validation/validation_test.go b/credential/validation/validation_test.go
@@ -77,7 +77,7 @@ func TestValidator(t *testing.T) {
 		// validate cred with schema, no schema passed in
 		sampleCredential.CredentialSchema = &credential.CredentialSchema{
 			ID:   "did:example:MDP8AsFhHzhwUvGNuYkX7T;id=06e126d1-fa44-4882-a243-1e326fbe21db;version=1.0",
-			Type: credschema.JSONSchema2023Type.String(),
+			Type: credschema.JSONSchemaType.String(),
 		}
 		err = validator.ValidateCredential(sampleCredential)
 		assert.Error(tt, err)

diff --git a/example/manifest/manifest.go b/example/manifest/manifest.go
@@ -189,7 +189,7 @@ func issueApplicationCredential(id key.DIDKey, s schema.JSONSchema) (*credential
 
 	if err := builder.SetCredentialSchema(credential.CredentialSchema{
 		ID:   s.ID(),
-		Type: schema.JSONSchema2023Type.String(),
+		Type: schema.JSONSchemaType.String(),
 	}); err != nil {
 		return nil, err
 	}
@@ -280,7 +280,7 @@ func issueDriversLicenseCredential(issuerDID key.DIDKey, subjectDID string, s sc
 
 	if err := builder.SetCredentialSchema(credential.CredentialSchema{
 		ID:   s.ID(),
-		Type: schema.JSONSchema2023Type.String(),
+		Type: schema.JSONSchemaType.String(),
 	}); err != nil {
 		return nil, err
 	}