Add models for Credential Issuer Metadata #304

andresuribe87 · 2023-03-15T15:27:48Z

This is based in the spec section https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-issuer-metadata

I believe the SDK is the best home for this. My expectation is that other folks will need to support this kind of models, and providing a library to do so easily will be beneficial to the community.

I thought about separating it into it's own module, but given that we're packaging all functionality into the SDK, I believe this is the best place for this to live.

nitro-neal

👍

nitro-neal · 2023-03-15T15:36:59Z

oidc/issuance/metadata.go

+const (
+	JWKFormat CryptographicBindingMethodSupported = "jwk"
+	COSEKey                                       = "cose_key"
+	AllDIDs                                       = "did"


did you mean to make this all_dids?

I didn't. This is part of what's specified in the spec. You made me realize that this approach was sub-par. So I added more documentation, and a new method to get all the Binding DID Methods from the CredentialSupported struct

oidc/issuance/metadata_test.go

decentralgabe · 2023-03-15T16:10:50Z

oidc/issuance/metadata.go

+)
+
+type Logo struct {
+	Url     *util.URL `json:"url,omitempty"`


Suggested change

Url *util.URL `json:"url,omitempty"`

URL *util.URL `json:"url,omitempty"`

decentralgabe · 2023-03-15T16:11:09Z

oidc/issuance/metadata.go

+
+const (
+	JwtVcJson   Format = "jwt_vc_json"
+	JwtVcJsonLd        = "jwt_vc_json-ld"


Suggested change

JwtVcJsonLd = "jwt_vc_json-ld"

JWTVCJSONLD = "jwt_vc_json-ld"

decentralgabe · 2023-03-15T16:11:20Z

oidc/issuance/metadata.go

+const (
+	JwtVcJson   Format = "jwt_vc_json"
+	JwtVcJsonLd        = "jwt_vc_json-ld"
+	LdpVc              = "ldp_vc"


Suggested change

LdpVc = "ldp_vc"

LDPVC = "ldp_vc"

This reads so bad :(

Done

yeah it sucks

decentralgabe · 2023-03-15T16:11:37Z

oidc/issuance/metadata.go

+type CredentialSupported struct {
+	Format Format `json:"format" validate:"required"`
+
+	Id *string `json:"id,omitempty"`


Suggested change

Id *string `json:"id,omitempty"`

ID *string `json:"id,omitempty"`

is a string ptr needed over a string?

Done.

ID is an optional field, so wanted to make that clear.

decentralgabe · 2023-03-15T16:12:15Z

oidc/issuance/metadata.go

+	err := json.Unmarshal(data, &cJSON)
+	if err != nil {
+		return errors.Wrap(err, "unmarshalling")
+	}


Suggested change

err := json.Unmarshal(data, &cJSON)

if err != nil {

return errors.Wrap(err, "unmarshalling")

}

if err := json.Unmarshal(data, &cJSON); err != nil {

return errors.Wrap(err, "unmarshalling")

}

decentralgabe · 2023-03-15T16:13:29Z

util/url.go

+	url.URL
+}
+
+func (u URL) MarshalJSON() ([]byte, error) {


I believe you should be able to just call this Marshal and it will implement the json marshal interface

If I'm understanding your suggestion correctly, I don't believe it works. See below:

For the following test code

func TestMarshalURL(t *testing.T) { u, _ := url.Parse("https://localhost") data, err := json.Marshal(u) require.NoError(t, err) assert.Equal(t, `"https://localhost"`, string(data)) }

The result is

=== RUN TestMarshalURL metadata_test.go:63: Error Trace: /Users/auribe/code/ssi-sdk/oidc/issuance/metadata_test.go:63 Error: Not equal: expected: "\"https://localhost\"" actual : "{\"Scheme\":\"https\",\"Opaque\":\"\",\"User\":null,\"Host\":\"localhost\",\"Path\":\"\",\"RawPath\":\"\",\"OmitHost\":false,\"ForceQuery\":false,\"RawQuery\":\"\",\"Fragment\":\"\",\"RawFragment\":\"\"}" Diff: --- Expected +++ Actual @@ -1 +1 @@ -"https://localhost" +{"Scheme":"https","Opaque":"","User":null,"Host":"localhost","Path":"","RawPath":"","OmitHost":false,"ForceQuery":false,"RawQuery":"","Fragment":"","RawFragment":""} Test: TestMarshalURL --- FAIL: TestMarshalURL (0.00s)

looks like you had it right my bad http://choly.ca/post/go-json-marshalling/

decentralgabe · 2023-03-15T16:13:44Z

util/url.go

+	err := json.Unmarshal(data, &dataStr)
+	if err != nil {
+		return errors.Wrap(err, "unmarshalling")
+	}


Suggested change

err := json.Unmarshal(data, &dataStr)

if err != nil {

return errors.Wrap(err, "unmarshalling")

}

if err := json.Unmarshal(data, &dataStr); err != nil {

return errors.Wrap(err, "unmarshalling")

}

codecov-commenter · 2023-03-15T20:14:52Z

Codecov Report

Merging #304 (36e6c34) into main (e010720) will increase coverage by 0.39%.
The diff coverage is 79.38%.

@@            Coverage Diff             @@
##             main     #304      +/-   ##
==========================================
+ Coverage   60.54%   60.93%   +0.39%     
==========================================
  Files          41       42       +1     
  Lines        4554     4651      +97     
==========================================
+ Hits         2757     2834      +77     
- Misses       1352     1367      +15     
- Partials      445      450       +5

Impacted Files	Coverage Δ
oidc/issuance/metadata.go	`79.38% <79.38%> (ø)`

* Add simple URL for parsing strings. * Add credential issuer metadata for oidc. * Make the linter happy * PR feedback * Finish comment * More PR comments * Even More PR comments * Enforce unique CredentialsSupported.ID ion models long form did and initial request

* Add models for Credential Issuer Metadata (#304) * Add simple URL for parsing strings. * Add credential issuer metadata for oidc. * Make the linter happy * PR feedback * Finish comment * More PR comments * Even More PR comments * Enforce unique CredentialsSupported.ID ion models long form did and initial request * Added style and best practices (#298) * Added style and best practices * nits deactivate request update request recover lint test not passing fix test fix reveal value; update test temp * update to jwx v2 * jwx 2 * bug fix * works * lint * update err messages * consistent spelling * pr errs --------- Co-authored-by: Andres Uribe <auribe@tbd.email>

* origin/main: Bump github.com/multiformats/go-multibase from 0.1.1 to 0.2.0 (#313) Bump github.com/go-playground/validator/v10 from 10.11.2 to 10.12.0 (#311) Bump github.com/goccy/go-json from 0.10.0 to 0.10.2 (#310) Bump golang.org/x/term from 0.5.0 to 0.6.0 (#299) Update JWX lib to use v2 (#308) Added style and best practices (#298) Add models for Credential Issuer Metadata (#304) Upgrade go version to 1.20.2 (#305) add missing param (#297) interface to any (#296) # Conflicts: # cryptosuite/cryptosuite.go # cryptosuite/jsonwebkey2020.go # cryptosuite/jwssignaturesuite.go # cryptosuite/jwssignaturesuite_test.go # go.mod # go.sum # util/helpers.go # wasm/static/main.wasm

andresuribe87 added 2 commits March 15, 2023 11:23

Add simple URL for parsing strings.

4fdad7a

Add credential issuer metadata for oidc.

846a1aa

andresuribe87 requested review from decentralgabe and nitro-neal as code owners March 15, 2023 15:27

nitro-neal approved these changes Mar 15, 2023

View reviewed changes

Make the linter happy

7ff12c4

decentralgabe reviewed Mar 15, 2023

View reviewed changes

andresuribe87 and others added 6 commits March 15, 2023 13:18

PR feedback

15dbc02

Finish comment

3f0e81a

More PR comments

3f4b909

Even More PR comments

1d85932

Enforce unique CredentialsSupported.ID

6811889

Merge branch 'main' into OSE-443

36e6c34

decentralgabe approved these changes Mar 15, 2023

View reviewed changes

andresuribe87 merged commit e0ac99a into TBD54566975:main Mar 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add models for Credential Issuer Metadata #304

Add models for Credential Issuer Metadata #304

andresuribe87 commented Mar 15, 2023

nitro-neal left a comment

nitro-neal Mar 15, 2023

andresuribe87 Mar 15, 2023

decentralgabe Mar 15, 2023

decentralgabe Mar 15, 2023

andresuribe87 Mar 15, 2023

decentralgabe Mar 15, 2023

andresuribe87 Mar 15, 2023

decentralgabe Mar 15, 2023

decentralgabe Mar 15, 2023

andresuribe87 Mar 15, 2023

decentralgabe Mar 15, 2023

andresuribe87 Mar 15, 2023

decentralgabe Mar 15, 2023

andresuribe87 Mar 15, 2023

decentralgabe Mar 15, 2023

decentralgabe Mar 15, 2023

andresuribe87 Mar 15, 2023

codecov-commenter commented Mar 15, 2023

	Url *util.URL `json:"url,omitempty"`
	URL *util.URL `json:"url,omitempty"`

	JwtVcJsonLd = "jwt_vc_json-ld"
	JWTVCJSONLD = "jwt_vc_json-ld"

	Id *string `json:"id,omitempty"`
	ID *string `json:"id,omitempty"`

Add models for Credential Issuer Metadata #304

Add models for Credential Issuer Metadata #304

Conversation

andresuribe87 commented Mar 15, 2023

nitro-neal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Mar 15, 2023

Codecov Report