Skip to content

feat: added getEmailVerified() and isEmailTrustworthy() #132

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
shadowhand merged 1 commit into from
Dec 15, 2025
Merged

feat: added getEmailVerified() and isEmailTrustworthy() #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions src/Provider/GoogleUser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,36 @@ public function getEmail(): ?string
return $this->getResponseValue('email');
}

/**
* Get email_verified attribute.
*
* @return bool|null
*/
public function getEmailVerified(): ?bool
{
return $this->getResponseValue('email_verified');
}

/**
* Returns whether the email is trustable enough to be used for authentication purpose.
*
* @see https://developers.google.com/identity/gsi/web/guides/verify-google-id-token
*/
public function isEmailTrustworthy(): bool
{
$email = $this->getEmail();
if (! $email) {
return false;
}
if ('@gmail.com' === substr($email, -10)) {
return true;
}
if ($this->getHostedDomain() && $this->getEmailVerified()) {
return true;
}
return false;
}

/**
* Get hosted domain.
*
Expand Down
72 changes: 72 additions & 0 deletions test/src/Provider/GoogleUserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ public function testUserDefaults(): void
$user = new GoogleUser([
'sub' => '12345',
'email' => 'mock.name@example.com',
'email_verified' => true,
'name' => 'mock name',
'given_name' => 'mock',
'family_name' => 'name',
Expand All @@ -29,6 +30,8 @@ public function testUserDefaults(): void
self::assertEquals('mock.name@example.com', $user->getEmail());
self::assertEquals('example.com', $user->getHostedDomain());
self::assertEquals('mock_image_url', $user->getAvatar());
self::assertTrue($user->getEmailVerified());
self::assertTrue($user->isEmailTrustworthy());
}

public function testUserPartialData(): void
Expand All @@ -44,6 +47,8 @@ public function testUserPartialData(): void
self::assertEquals(null, $user->getHostedDomain());
self::assertEquals(null, $user->getAvatar());
self::assertEquals(null, $user->getLocale());
self::assertNull($user->getEmailVerified());
self::assertFalse($user->isEmailTrustworthy());
}

public function testUserMinimalData(): void
Expand All @@ -59,5 +64,72 @@ public function testUserMinimalData(): void
self::assertEquals(null, $user->getLocale());
self::assertEquals(null, $user->getFirstName());
self::assertEquals(null, $user->getLastName());
self::assertNull($user->getEmailVerified());
self::assertFalse($user->isEmailTrustworthy());
}

public function testGmailTrustworthy(): void
{
$user = new GoogleUser([
'sub' => '12345',
'name' => 'mock name',
'email' => 'mock.email@gmail.com',
]);

self::assertNull($user->getEmailVerified());
self::assertTrue($user->isEmailTrustworthy());
}

public function testAlmostGmailNotTrustworthy(): void
{
$user = new GoogleUser([
'sub' => '12345',
'name' => 'mock name',
'email' => 'mock.email@agmail.com',
]);

self::assertNull($user->getEmailVerified());
self::assertFalse($user->isEmailTrustworthy());
}

public function testNonGmailWithHostedDomainTrustworthy(): void
{
$user = new GoogleUser([
'sub' => '12345',
'name' => 'mock name',
'email' => 'mock.email@example.com',
'email_verified' => true,
'hd' => 'example.com',
]);

self::assertTrue($user->getEmailVerified());
self::assertTrue($user->isEmailTrustworthy());
}

public function testNonGmailNonVerifiedWithHostedDomainNotTrustworthy(): void
{
$user = new GoogleUser([
'sub' => '12345',
'name' => 'mock name',
'email' => 'mock.email@example.com',
'email_verified' => false,
'hd' => 'example.com',
]);

self::assertFalse($user->getEmailVerified());
self::assertFalse($user->isEmailTrustworthy());
}

public function testNonGmailVerifiedWithoutHostedDomainNotTrustworthy(): void
{
$user = new GoogleUser([
'sub' => '12345',
'name' => 'mock name',
'email' => 'mock.email@example.com',
'email_verified' => true,
]);

self::assertTrue($user->getEmailVerified());
self::assertFalse($user->isEmailTrustworthy());
}
}