Skip to content

[Enhancement] Add EmailVerified field for Apple's ID token #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
techknowlogick merged 4 commits into from
May 21, 2024
Merged

[Enhancement] Add EmailVerified field for Apple's ID token #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16133e9
[Enhancement] Add EmailVerified field for Apple's ID token
althenlimzixuan May 17, 2024
2d2e55c
[Fix] Include "email_verified" field in Apple's unit test case.
althenlimzixuan May 17, 2024
854aa25
[Fix] Add missing BooleanString validation in TestIDTokenClaimsUnmars…
althenlimzixuan May 21, 2024
33fdaf9
[Fix] Fill up test payload
althenlimzixuan May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions providers/apple/session.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ type ID struct {
Sub string `json:"sub"`
Email string `json:"email"`
IsPrivateEmail bool `json:"is_private_email"`
EmailVerified bool `json:"email_verified"`
}

type Session struct {
Expand Down Expand Up @@ -52,6 +53,7 @@ type IDTokenClaims struct {
AuthTime int `json:"auth_time"`
Email string `json:"email"`
IsPrivateEmail BoolString `json:"is_private_email"`
EmailVerified BoolString `json:"email_verified,omitempty"`
}

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error) {
Expand Down Expand Up @@ -124,6 +126,7 @@ func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string,
Sub: idToken.Claims.(*IDTokenClaims).Subject,
Email: idToken.Claims.(*IDTokenClaims).Email,
IsPrivateEmail: idToken.Claims.(*IDTokenClaims).IsPrivateEmail.Value(),
EmailVerified: idToken.Claims.(*IDTokenClaims).EmailVerified.Value(),
}
}

Expand Down
13 changes: 10 additions & 3 deletions providers/apple/session_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func Test_ToJSON(t *testing.T) {
s := &Session{}

data := s.Marshal()
a.Equal(data, `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z","sub":"","email":"","is_private_email":false}`)
a.Equal(data, `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z","sub":"","email":"","is_private_email":false,"email_verified":false}`)
}

func Test_String(t *testing.T) {
Expand All @@ -59,23 +59,30 @@ func TestIDTokenClaimsUnmarshal(t *testing.T) {
}{
{
name: "'is_private_email' claim is a string",
idToken: `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z","sub":"","email":"[email protected]","is_private_email":"true"}`,
idToken: `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z","sub":"","email":"[email protected]","is_private_email":"true", "email_verified":"true"}`,
expectedClaims: IDTokenClaims{
Email: "[email protected]",
IsPrivateEmail: BoolString{
StringValue: "true",
},
EmailVerified: BoolString{
StringValue: "true",
},
},
},
{
name: "'is_private_email' claim is a boolean",
idToken: `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z","sub":"","email":"[email protected]","is_private_email":true}`,
idToken: `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z","sub":"","email":"[email protected]","is_private_email":true,"email_verified":true}`,
expectedClaims: IDTokenClaims{
Email: "[email protected]",
IsPrivateEmail: BoolString{
BoolValue: true,
IsValidBool: true,
},
EmailVerified: BoolString{
BoolValue: true,
IsValidBool: true,
},
},
},
}
Expand Down