Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/googleapis/google-auth-library-php

Google Auth Library for PHP
https://github.com/googleapis/google-auth-library-php

Last synced: 3 days ago
JSON representation

Google Auth Library for PHP

Awesome Lists containing this project

README 

        
# Google Auth Library for PHP





  
Homepage


http://www.github.com/google/google-auth-library-php


  
Reference Docs


https://googleapis.github.io/google-auth-library-php/main/


  
Authors


    
Tim Emiola


    
Stanley Cheung


    
Brent Shaffer


  
Copyright


Copyright © 2015 Google, Inc.


  
License


Apache 2.0





## Description



This is Google's officially supported PHP client library for using OAuth 2.0

authorization and authentication with Google APIs.



### Installing via Composer



The recommended way to install the google auth library is through

[Composer](http://getcomposer.org).



```bash

# Install Composer

curl -sS https://getcomposer.org/installer | php

```



Next, run the Composer command to install the latest stable version:



```bash

composer.phar require google/auth

```



## Application Default Credentials



This library provides an implementation of

[Application Default Credentials (ADC)][application default credentials] for PHP.



Application Default Credentials provides a simple way to get authorization

credentials for use in calling Google APIs, and is

the recommended approach to authorize calls to Cloud APIs.



### Set up ADC



To use ADC, you must set it up by providing credentials.

How you set up ADC depends on the environment where your code is running,

and whether you are running code in a test or production environment.



For more information, see [Set up Application Default Credentials][set-up-adc].



### Enable the API you want to use



Before making your API call, you must be sure the API you're calling has been

enabled. Go to **APIs & Auth** > **APIs** in the

[Google Developers Console][developer console] and enable the APIs you'd like to

call. For the example below, you must enable the `Drive API`.



### Call the APIs



As long as you update the environment variable below to point to *your* JSON

credentials file, the following code should output a list of your Drive files.



```php

use Google\Auth\ApplicationDefaultCredentials;

use GuzzleHttp\Client;

use GuzzleHttp\HandlerStack;



// specify the path to your application credentials

putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/credentials.json');



// define the scopes for your API call

$scopes = ['https://www.googleapis.com/auth/drive.readonly'];



// create middleware

$middleware = ApplicationDefaultCredentials::getMiddleware($scopes);

$stack = HandlerStack::create();

$stack->push($middleware);



// create the HTTP client

$client = new Client([

  'handler' => $stack,

  'base_uri' => 'https://www.googleapis.com',

  'auth' => 'google_auth'  // authorize all requests

]);



// make the request

$response = $client->get('drive/v2/files');



// show the result!

print_r((string) $response->getBody());

```



##### Guzzle 5 Compatibility



If you are using [Guzzle 5][Guzzle 5], replace the `create middleware` and

`create the HTTP Client` steps with the following:



```php

// create the HTTP client

$client = new Client([

  'base_url' => 'https://www.googleapis.com',

  'auth' => 'google_auth'  // authorize all requests

]);



// create subscriber

$subscriber = ApplicationDefaultCredentials::getSubscriber($scopes);

$client->getEmitter()->attach($subscriber);

```



#### Call using an ID Token

If your application is running behind Cloud Run, or using Cloud Identity-Aware

Proxy (IAP), you will need to fetch an ID token to access your application. For

this, use the static method `getIdTokenMiddleware` on

`ApplicationDefaultCredentials`.



```php

use Google\Auth\ApplicationDefaultCredentials;

use GuzzleHttp\Client;

use GuzzleHttp\HandlerStack;



// specify the path to your application credentials

putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/credentials.json');



// Provide the ID token audience. This can be a Client ID associated with an IAP application,

// Or the URL associated with a CloudRun App

//    $targetAudience = 'IAP_CLIENT_ID.apps.googleusercontent.com';

//    $targetAudience = 'https://service-1234-uc.a.run.app';

$targetAudience = 'YOUR_ID_TOKEN_AUDIENCE';



// create middleware

$middleware = ApplicationDefaultCredentials::getIdTokenMiddleware($targetAudience);

$stack = HandlerStack::create();

$stack->push($middleware);



// create the HTTP client

$client = new Client([

  'handler' => $stack,

  'auth' => 'google_auth',

  // Cloud Run, IAP, or custom resource URL

  'base_uri' => 'https://YOUR_PROTECTED_RESOURCE',

]);



// make the request

$response = $client->get('/');



// show the result!

print_r((string) $response->getBody());

```



For invoking Cloud Run services, your service account will need the

[`Cloud Run Invoker`](https://cloud.google.com/run/docs/authenticating/service-to-service)

IAM permission.



For invoking Cloud Identity-Aware Proxy, you will need to pass the Client ID

used when you set up your protected resource as the target audience. See how to

[secure your IAP app with signed headers](https://cloud.google.com/iap/docs/signed-headers-howto).



#### Call using a specific JSON key

If you want to use a specific JSON key instead of using `GOOGLE_APPLICATION_CREDENTIALS` environment variable, you can

 do this:



```php

use Google\Auth\CredentialsLoader;

use Google\Auth\Middleware\AuthTokenMiddleware;

use GuzzleHttp\Client;

use GuzzleHttp\HandlerStack;



// Define the Google Application Credentials array

$jsonKey = ['key' => 'value'];



// define the scopes for your API call

$scopes = ['https://www.googleapis.com/auth/drive.readonly'];



// Load credentials

$creds = CredentialsLoader::makeCredentials($scopes, $jsonKey);



// optional caching

// $creds = new FetchAuthTokenCache($creds, $cacheConfig, $cache);



// create middleware

$middleware = new AuthTokenMiddleware($creds);

$stack = HandlerStack::create();

$stack->push($middleware);



// create the HTTP client

$client = new Client([

  'handler' => $stack,

  'base_uri' => 'https://www.googleapis.com',

  'auth' => 'google_auth'  // authorize all requests

]);



// make the request

$response = $client->get('drive/v2/files');



// show the result!

print_r((string) $response->getBody());



```



#### Call using Proxy-Authorization Header

If your application is behind a proxy such as [Google Cloud IAP][iap-proxy-header],

and your application occupies the `Authorization` request header,

you can include the ID token in a `Proxy-Authorization: Bearer`

header instead. If a valid ID token is found in a `Proxy-Authorization` header,

IAP authorizes the request with it. After authorizing the request, IAP passes

the Authorization header to your application without processing the content.

For this, use the static method `getProxyIdTokenMiddleware` on

`ApplicationDefaultCredentials`.



```php

use Google\Auth\ApplicationDefaultCredentials;

use GuzzleHttp\Client;

use GuzzleHttp\HandlerStack;



// specify the path to your application credentials

putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/my/credentials.json');



// Provide the ID token audience. This can be a Client ID associated with an IAP application

//    $targetAudience = 'IAP_CLIENT_ID.apps.googleusercontent.com';

$targetAudience = 'YOUR_ID_TOKEN_AUDIENCE';



// create middleware

$middleware = ApplicationDefaultCredentials::getProxyIdTokenMiddleware($targetAudience);

$stack = HandlerStack::create();

$stack->push($middleware);



// create the HTTP client

$client = new Client([

  'handler' => $stack,

  'auth' => ['username', 'pass'], // auth option handled by your application

  'proxy_auth' => 'google_auth',

]);



// make the request

$response = $client->get('/');



// show the result!

print_r((string) $response->getBody());

```



[iap-proxy-header]: https://cloud.google.com/iap/docs/authentication-howto#authenticating_from_proxy-authorization_header



#### External credentials (Workload identity federation)



Using workload identity federation, your application can access Google Cloud resources from Amazon Web Services (AWS),

Microsoft Azure or any identity provider that supports OpenID Connect (OIDC).



Traditionally, applications running outside Google Cloud have used service account keys to access Google Cloud

resources. Using identity federation, you can allow your workload to impersonate a service account. This lets you access

Google Cloud resources directly, eliminating the maintenance and security burden associated with service account keys.



Follow the detailed instructions on how to

[Configure Workload Identity Federation](https://cloud.google.com/iam/docs/workload-identity-federation-with-other-clouds).



#### Verifying JWTs



If you are [using Google ID tokens to authenticate users][google-id-tokens], use

the `Google\Auth\AccessToken` class to verify the ID token:



```php

use Google\Auth\AccessToken;



$auth = new AccessToken();

$auth->verify($idToken);

```



If your app is running behind [Google Identity-Aware Proxy][iap-id-tokens]

(IAP), you can verify the ID token coming from the IAP server by pointing to the

appropriate certificate URL for IAP. This is because IAP signs the ID

tokens with a different key than the Google Identity service:



```php

use Google\Auth\AccessToken;



$auth = new AccessToken();

$auth->verify($idToken, [

  'certsLocation' => AccessToken::IAP_CERT_URL

]);

```



[google-id-tokens]: https://developers.google.com/identity/sign-in/web/backend-auth

[iap-id-tokens]: https://cloud.google.com/iap/docs/signed-headers-howto



## Caching

Caching is enabled by passing a PSR-6 `CacheItemPoolInterface`

instance to the constructor when instantiating the credentials.



We offer some caching classes out of the box under the `Google\Auth\Cache` namespace.



```php

use Google\Auth\ApplicationDefaultCredentials;

use Google\Auth\Cache\MemoryCacheItemPool;



// Cache Instance

$memoryCache = new MemoryCacheItemPool;



// Get the credentials

// From here, the credentials will cache the access token

$middleware = ApplicationDefaultCredentials::getCredentials($scope, cache: $memoryCache);

```



### FileSystemCacheItemPool Cache

The `FileSystemCacheItemPool` class is a `PSR-6` compliant cache that stores its

serialized objects on disk, caching data between processes and making it possible 

to use data between different requests.



```php

use Google\Auth\Cache\FileSystemCacheItemPool;

use Google\Auth\ApplicationDefaultCredentials;



// Create a Cache pool instance

$cache = new FileSystemCacheItemPool(__DIR__ . '/cache');



// Pass your Cache to the Auth Library

$credentials = ApplicationDefaultCredentials::getCredentials($scope, cache: $cache);



// This token will be cached and be able to be used for the next request

$token = $credentials->fetchAuthToken();

```



### Integrating with a third party cache

You can use a third party that follows the `PSR-6` interface of your choice.



```php

// run "composer require symfony/cache"

use Google\Auth\ApplicationDefaultCredentials;

use Symfony\Component\Cache\Adapter\FilesystemAdapter;



// Create the cache instance

$filesystemCache = new FilesystemAdapter();



// Create Get the credentials

$credentials = ApplicationDefaultCredentials::getCredentials($targetAudience, cache: $filesystemCache);

```



## License



This library is licensed under Apache 2.0. Full license text is

available in [COPYING][copying].



## Contributing



See [CONTRIBUTING][contributing].



## Support



Please

[report bugs at the project on Github](https://github.com/google/google-auth-library-php/issues). Don't

hesitate to

[ask questions](http://stackoverflow.com/questions/tagged/google-auth-library-php)

about the client or APIs on [StackOverflow](http://stackoverflow.com).



[google-apis-php-client]: https://github.com/google/google-api-php-client

[application default credentials]: https://cloud.google.com/docs/authentication/application-default-credentials

[contributing]: https://github.com/google/google-auth-library-php/tree/main/.github/CONTRIBUTING.md

[copying]: https://github.com/google/google-auth-library-php/tree/main/COPYING

[Guzzle]: https://github.com/guzzle/guzzle

[Guzzle 5]: http://docs.guzzlephp.org/en/5.3

[developer console]: https://console.developers.google.com

[set-up-adc]: https://cloud.google.com/docs/authentication/provide-credentials-adc