refactor: use struct types for claim related types (#283)

* oidc: add regression tests for token claim json

this helps to verify that the same JSON is produced,
after these types are refactored.

* refactor: use struct types for claim related types

BREAKING CHANGE:
The following types are changed from interface to struct type:

- AccessTokenClaims
- IDTokenClaims
- IntrospectionResponse
- UserInfo and related types.

The following methods of OPStorage now take a pointer to a struct type,
instead of an interface:

- SetUserinfoFromScopes
- SetUserinfoFromToken
- SetIntrospectionFromToken

The following functions are now generic, so that type-safe extension
of Claims is now possible:

- op.VerifyIDTokenHint
- op.VerifyAccessToken
- rp.VerifyTokens
- rp.VerifyIDToken

- Changed UserInfoAddress to pointer in UserInfo and
IntrospectionResponse.
This was needed to make omitempty work correctly.
- Copy or merge maps in IntrospectionResponse and SetUserInfo

* op: add example for VerifyAccessToken

* fix: rp: wrong assignment in WithIssuedAtMaxAge

WithIssuedAtMaxAge assigned its value to v.maxAge, which was wrong.
This change fixes that by assiging the duration to v.maxAgeIAT.

* rp: add VerifyTokens example

* oidc: add standard references to:

- IDTokenClaims
- IntrospectionResponse
- UserInfo

* only count coverage for `./pkg/...`

pkg/oidc/userinfo_test.go

@@ -7,21 +7,54 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func TestUserInfo_AppendClaims(t *testing.T) {
+	u := new(UserInfo)
+	u.AppendClaims("a", "b")
+	want := map[string]any{"a": "b"}
+	assert.Equal(t, want, u.Claims)
+
+	u.AppendClaims("d", "e")
+	want["d"] = "e"
+	assert.Equal(t, want, u.Claims)
+}
+
+func TestUserInfo_GetAddress(t *testing.T) {
+	// nil address
+	u := new(UserInfo)
+	assert.Equal(t, &UserInfoAddress{}, u.GetAddress())
+
+	u.Address = &UserInfoAddress{PostalCode: "1234"}
+	assert.Equal(t, u.Address, u.GetAddress())
+}
+
 func TestUserInfoMarshal(t *testing.T) {
-	userinfo := NewUserInfo()
-	userinfo.SetSubject("test")
-	userinfo.SetAddress(NewUserInfoAddress("Test 789\nPostfach 2", "", "", "", "", ""))
-	userinfo.SetEmail("test", true)
-	userinfo.SetPhone("0791234567", true)
-	userinfo.SetName("Test")
-	userinfo.AppendClaims("private_claim", "test")
+	userinfo := &UserInfo{
+		Subject: "test",
+		Address: &UserInfoAddress{
+			StreetAddress: "Test 789\nPostfach 2",
+		},
+		UserInfoEmail: UserInfoEmail{
+			Email:         "test",
+			EmailVerified: true,
+		},
+		UserInfoPhone: UserInfoPhone{
+			PhoneNumber:         "0791234567",
+			PhoneNumberVerified: true,
+		},
+		UserInfoProfile: UserInfoProfile{
+			Name: "Test",
+		},
+		Claims: map[string]any{"private_claim": "test"},
+	}
 
 	marshal, err := json.Marshal(userinfo)
-	out := NewUserInfo()
 	assert.NoError(t, err)
+
+	out := new(UserInfo)
 	assert.NoError(t, json.Unmarshal(marshal, out))
-	assert.Equal(t, userinfo.GetAddress(), out.GetAddress())
+	assert.Equal(t, userinfo, out)
 	expected, err := json.Marshal(out)
+
 	assert.NoError(t, err)
 	assert.Equal(t, expected, marshal)
 }
@@ -29,91 +62,55 @@ func TestUserInfoMarshal(t *testing.T) {
 func TestUserInfoEmailVerifiedUnmarshal(t *testing.T) {
 	t.Parallel()
 
-	t.Run("unmarsha email_verified from json bool true", func(t *testing.T) {
+	t.Run("unmarshal email_verified from json bool true", func(t *testing.T) {
 		jsonBool := []byte(`{"email": "my@email.com", "email_verified": true}`)
 
-		var uie userInfoEmail
+		var uie UserInfoEmail
 
 		err := json.Unmarshal(jsonBool, &uie)
 		assert.NoError(t, err)
-		assert.Equal(t, userInfoEmail{
+		assert.Equal(t, UserInfoEmail{
 			Email:         "my@email.com",
 			EmailVerified: true,
 		}, uie)
 	})
 
-	t.Run("unmarsha email_verified from json string true", func(t *testing.T) {
+	t.Run("unmarshal email_verified from json string true", func(t *testing.T) {
 		jsonBool := []byte(`{"email": "my@email.com", "email_verified": "true"}`)
 
-		var uie userInfoEmail
+		var uie UserInfoEmail
 
 		err := json.Unmarshal(jsonBool, &uie)
 		assert.NoError(t, err)
-		assert.Equal(t, userInfoEmail{
+		assert.Equal(t, UserInfoEmail{
 			Email:         "my@email.com",
 			EmailVerified: true,
 		}, uie)
 	})
 
-	t.Run("unmarsha email_verified from json bool false", func(t *testing.T) {
+	t.Run("unmarshal email_verified from json bool false", func(t *testing.T) {
 		jsonBool := []byte(`{"email": "my@email.com", "email_verified": false}`)
 
-		var uie userInfoEmail
+		var uie UserInfoEmail
 
 		err := json.Unmarshal(jsonBool, &uie)
 		assert.NoError(t, err)
-		assert.Equal(t, userInfoEmail{
+		assert.Equal(t, UserInfoEmail{
 			Email:         "my@email.com",
 			EmailVerified: false,
 		}, uie)
 	})
 
-	t.Run("unmarsha email_verified from json string false", func(t *testing.T) {
+	t.Run("unmarshal email_verified from json string false", func(t *testing.T) {
 		jsonBool := []byte(`{"email": "my@email.com", "email_verified": "false"}`)
 
-		var uie userInfoEmail
+		var uie UserInfoEmail
 
 		err := json.Unmarshal(jsonBool, &uie)
 		assert.NoError(t, err)
-		assert.Equal(t, userInfoEmail{
+		assert.Equal(t, UserInfoEmail{
 			Email:         "my@email.com",
 			EmailVerified: false,
 		}, uie)
 	})
 }
-
-// issue 203 test case.
-func Test_userinfo_GetAddress_issue_203(t *testing.T) {
-	tests := []struct {
-		name string
-		data string
-	}{
-		{
-			name: "with address",
-			data: `{"address":{"street_address":"Test 789\nPostfach 2"},"email":"test","email_verified":true,"name":"Test","phone_number":"0791234567","phone_number_verified":true,"private_claim":"test","sub":"test"}`,
-		},
-		{
-			name: "without address",
-			data: `{"email":"test","email_verified":true,"name":"Test","phone_number":"0791234567","phone_number_verified":true,"private_claim":"test","sub":"test"}`,
-		},
-		{
-			name: "null address",
-			data: `{"address":null,"email":"test","email_verified":true,"name":"Test","phone_number":"0791234567","phone_number_verified":true,"private_claim":"test","sub":"test"}`,
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			info := &userinfo{}
-			err := json.Unmarshal([]byte(tt.data), info)
-			assert.NoError(t, err)
-
-			info.GetAddress().GetCountry() //<- used to panic
-
-			// now shortly assure that a marshalling still produces the same as was parsed into the struct
-			marshal, err := json.Marshal(info)
-			assert.NoError(t, err)
-			assert.Equal(t, tt.data, string(marshal))
-		})
-	}
-}