Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thephpleague/oauth2-google

Google Provider for the OAuth 2.0 Client
https://github.com/thephpleague/oauth2-google

google oauth2 oauth2-provider php

Last synced: 2 months ago
JSON representation

Google Provider for the OAuth 2.0 Client

Awesome Lists containing this project

README 

        
# Google Provider for OAuth 2.0 Client



[![Build Status](https://img.shields.io/github/actions/workflow/status/thephpleague/oauth2-google/ci.yml?branch=main)](https://github.com/thephpleague/oauth2-google/actions/workflows/ci.yml)

[![Code Coverage](https://img.shields.io/codecov/c/gh/thephpleague/oauth2-google)](https://app.codecov.io/gh/thephpleague/oauth2-google)

[![License](https://img.shields.io/packagist/l/league/oauth2-google)](https://github.com/thephpleague/oauth2-google/blob/main/LICENSE)

[![Latest Stable Version](https://img.shields.io/packagist/v/league/oauth2-google)](https://packagist.org/packages/league/oauth2-google)



This package provides Google OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-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.



[PSR-1]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md

[PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

[PSR-4]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md



## 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][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][oauth-setup] to create the required credentials.



[openid-connect]: https://developers.google.com/identity/protocols/OpenIDConnect

[oauth-setup]: https://developers.google.com/identity/protocols/OpenIDConnect#registeringyourapp



## Installation



To install, use composer:



```sh

composer require league/oauth2-google

```



## Usage



### Authorization Code Flow



```php

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][auth-params]:



- `accessType` to use online or offline access

- `hostedDomain` to authenticate G Suite users

- `prompt` to modify the prompt that the user will see

- `scopes` to request access to additional user information



[auth-params]: https://developers.google.com/identity/protocols/OpenIDConnect#authenticationuriparameters



#### Accessing Token JWT



Google provides a [JSON Web Token][jwt] (JWT) with all access tokens. This token

[contains basic information][openid-jwt] about the authenticated user. The JWT

can be accessed from the `id_token` value of the access token:



```php

/** @var League\OAuth2\Client\Token\AccessToken $token */

$values = $token->getValues();



/** @var string */

$jwt = $values['id_token'];

```



Parsing the JWT will require a [JWT parser][jwt-parsers]. Refer to parser

documentation for instructions.



[jwt]: https://jwt.io/

[openid-jwt]: https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo

[jwt-parsers]: https://packagist.org/search/?q=jwt



### 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:



```php

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:



```php

$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:



```php

$authUrl = $provider->getAuthorizationUrl(['prompt' => 'consent', 'access_type' => 'offline']);

```



Now you have everything you need to refresh an access token using a refresh token:



```php

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][scopes] can be set by using the `scope` parameter when

generating the authorization URL:



```php

$authorizationUrl = $provider->getAuthorizationUrl([

    'scope' => [

        'scope-url-here'

    ],

]);

```



[scopes]: https://developers.google.com/identity/protocols/googlescopes



## Testing



Tests can be run with:



```sh

composer test

```



Style checks can be run with:



```sh

composer check

```



## Contributing



Please see [CONTRIBUTING](https://github.com/thephpleague/oauth2-google/blob/main/CONTRIBUTING.md) for details.



## Credits



- [Woody Gilk](https://github.com/shadowhand)

- [All Contributors](https://github.com/thephpleague/oauth2-google/contributors)



## License



The MIT License (MIT). Please see [License File](https://github.com/thephpleague/oauth2-google/blob/main/LICENSE) for more information.