league / oauth2-google
Google OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Installs: 14 203 830
Dependents: 103
Suggesters: 26
Security: 0
Stars: 396
Watchers: 16
Forks: 74
Open Issues: 6
Requires
- php: ^7.3 || ^8.0
- league/oauth2-client: ^2.0
Requires (Dev)
- eloquent/phony-phpunit: ^6.0 || ^7.1
- phpunit/phpunit: ^8.0 || ^9.0
- squizlabs/php_codesniffer: ^3.0
README
This package provides Google OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request.
Requirements
The following versions of PHP are supported.
- PHP 7.3
- PHP 7.4
- PHP 8.0
- PHP 8.1
- PHP 8.2
- PHP 8.3
This package uses OpenID Connect to authenticate users with Google accounts.
To use this package, it will be necessary to have a Google client ID and client
secret. These are referred to as {google-client-id}
and {google-client-secret}
in the documentation.
Please follow the Google instructions to create the required credentials.
Installation
To install, use composer:
composer require league/oauth2-google
Usage
Authorization Code Flow
require __DIR__ . '/vendor/autoload.php'; use League\OAuth2\Client\Provider\Google; session_start(); // Remove if session.auto_start=1 in php.ini $provider = new Google([ 'clientId' => '{google-client-id}', 'clientSecret' => '{google-client-secret}', 'redirectUri' => 'https://example.com/callback-url', 'hostedDomain' => 'example.com', // optional; used to restrict access to users on your G Suite/Google Apps for Business accounts ]); if (!empty($_GET['error'])) { // Got an error, probably user denied access exit('Got error: ' . htmlspecialchars($_GET['error'], ENT_QUOTES, 'UTF-8')); } elseif (empty($_GET['code'])) { // If we don't have an authorization code then get one $authUrl = $provider->getAuthorizationUrl(); $_SESSION['oauth2state'] = $provider->getState(); header('Location: ' . $authUrl); exit; } elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) { // State is invalid, possible CSRF attack in progress unset($_SESSION['oauth2state']); exit('Invalid state'); } else { // Try to get an access token (using the authorization code grant) $token = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]); // Optional: Now you have a token you can look up a users profile data try { // We got an access token, let's now get the owner details $ownerDetails = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $ownerDetails->getFirstName()); } catch (Exception $e) { // Failed to get user details exit('Something went wrong: ' . $e->getMessage()); } // Use this to interact with an API on the users behalf echo $token->getToken(); // Use this to get a new access token if the old one expires echo $token->getRefreshToken(); // Unix timestamp at which the access token expires echo $token->getExpires(); }
Available Options
The Google
provider has the following options:
accessType
to use online or offline accesshostedDomain
to authenticate G Suite usersprompt
to modify the prompt that the user will seescopes
to request access to additional user information
Accessing Token JWT
Google provides a JSON Web Token (JWT) with all access tokens. This token
contains basic information about the authenticated user. The JWT
can be accessed from the id_token
value of the access token:
/** @var League\OAuth2\Client\Token\AccessToken $token */ $values = $token->getValues(); /** @var string */ $jwt = $values['id_token'];
Parsing the JWT will require a JWT parser. Refer to parser documentation for instructions.
Refreshing a Token
Refresh tokens are only provided to applications which request offline access. You can specify offline access by setting the accessType
option in your provider:
use League\OAuth2\Client\Provider\Google; $provider = new Google([ 'clientId' => '{google-client-id}', 'clientSecret' => '{google-client-secret}', 'redirectUri' => 'https://example.com/callback-url', 'accessType' => 'offline', ]);
It is important to note that the refresh token is only returned on the first request after this it will be null
. You should securely store the refresh token when it is returned:
$token = $provider->getAccessToken('authorization_code', [ 'code' => $code ]); // persist the token in a database $refreshToken = $token->getRefreshToken();
If you ever need to get a new refresh token you can request one by forcing the consent prompt:
$authUrl = $provider->getAuthorizationUrl(['prompt' => 'consent', 'access_type' => 'offline']);
Now you have everything you need to refresh an access token using a refresh token:
use League\OAuth2\Client\Provider\Google; use League\OAuth2\Client\Grant\RefreshToken; $provider = new Google([ 'clientId' => '{google-client-id}', 'clientSecret' => '{google-client-secret}', 'redirectUri' => 'https://example.com/callback-url', ]); $grant = new RefreshToken(); $token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);
Scopes
Additional scopes can be set by using the scope
parameter when
generating the authorization URL:
$authorizationUrl = $provider->getAuthorizationUrl([ 'scope' => [ 'scope-url-here' ], ]);
Testing
Tests can be run with:
composer test
Style checks can be run with:
composer check
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.