Documentation

GCECredentials extends CredentialsLoader

in package

• Application

implements SignBlobInterface, ProjectIdProviderInterface, GetQuotaProjectInterface

GCECredentials supports authorization on Google Compute Engine.

Table of Contents

Interfaces

SignBlobInterface

Describes a class which supports signing arbitrary strings.

ProjectIdProviderInterface

Describes a Credentials object which supports fetching the project ID.

GetQuotaProjectInterface

An interface implemented by objects that can get quota projects.

Constants

cacheKey  = 'GOOGLE_AUTH_PHP_GCE'

CLIENT_ID_URI_PATH  = 'v1/instance/service-accounts/default/email'

The metadata path of the client ID.

COMPUTE_PING_CONNECTION_TIMEOUT_S  = 0.5

ENV_VAR  = 'GOOGLE_APPLICATION_CREDENTIALS'

FLAVOR_HEADER  = 'Metadata-Flavor'

The header whose presence indicates GCE presence.

ID_TOKEN_URI_PATH  = 'v1/instance/service-accounts/default/identity'

The metadata path of the default id token.

MAX_COMPUTE_PING_TRIES  = 3

Note: the explicit `timeout` and `tries` below is a workaround. The underlying issue is that resolving an unknown host on some networks will take 20-30 seconds; making this timeout short fixes the issue, but could lead to false negatives in the event that we are on GCE, but the metadata resolution was particularly slow. The latter case is "unlikely" since the expected 4-nines time is about 0.5 seconds.

METADATA_IP  = '169.254.169.254'

The metadata IP address on appengine instances.

NON_WINDOWS_WELL_KNOWN_PATH_BASE  = '.config'

PROJECT_ID_URI_PATH  = 'v1/project/project-id'

The metadata path of the project ID.

TOKEN_CREDENTIAL_URI  = 'https://oauth2.googleapis.com/token'

TOKEN_URI_PATH  = 'v1/instance/service-accounts/default/token'

The metadata path of the default token.

WELL_KNOWN_PATH  = 'gcloud/application_default_credentials.json'

Properties

$lastReceivedToken  : mixed

Result of fetchAuthToken.

$clientName  : string|null

$hasCheckedOnGce  : bool

Flag used to ensure that the onGCE test is only done once;.

$iam  : Iam|null

$isOnGce  : bool

Flag that stores the value of the onGCE check.

$projectId  : string|null

$quotaProject  : string|null

$serviceAccountIdentity  : string|null

$targetAudience  : string

$tokenUri  : string

Methods

__construct()  : mixed

fetchAuthToken()  : array<string|int, mixed>

Implements FetchAuthTokenInterface#fetchAuthToken.

fromEnv()  : array<string|int, mixed>|null

Load a JSON key from the path specified in the environment.

fromWellKnownFile()  : array<string|int, mixed>|null

Load a JSON key from a well known path.

getCacheKey()  : string

Obtains a key that can used to cache the results of #fetchAuthToken.

getClientName()  : string

Get the client name from GCE metadata.

getClientNameUri()  : string

The full uri for accessing the default service account.

getLastReceivedToken()  : array<string|int, mixed>|null

Returns an associative array with the token and expiration time.

getProjectId()  : string|null

Fetch the default Project ID from compute engine.

getQuotaProject()  : string|null

Get the quota project used for this API request

getTokenUri()  : string

The full uri for accessing the default token.

getUpdateMetadataFunc()  : array<string|int, mixed>

export a callback function which updates runtime metadata.

makeCredentials()  : ServiceAccountCredentials|UserRefreshCredentials

Create a new Credentials instance.

makeHttpClient()  : Client

Create an authorized HTTP Client from an instance of FetchAuthTokenInterface.

makeInsecureCredentials()  : InsecureCredentials

Create a new instance of InsecureCredentials.

onAppEngineFlexible()  : bool

Determines if this an App Engine Flexible instance, by accessing the GAE_INSTANCE environment variable.

onGce()  : bool

Determines if this a GCE instance, by accessing the expected metadata host.

signBlob()  : string

Sign a string using the default service account private key.

updateMetadata()  : array<string|int, mixed>

Updates metadata with the authorization token.

getFromMetadata()  : string

Fetch the value of a GCE metadata server URI.

getGuzzleMajorVersion()  : int

Returns the currently available major Guzzle version.

getIdTokenUri()  : string

The full uri for accesesing the default identity token.

getProjectIdUri()  : string

The full uri for accessing the default project ID.

isOnWindows()  : bool

unableToReadEnv()  : string