* Copyright 2008 Google Inc.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
if (!class_exists('UDP_Google_Client')) {
require_once dirname(__FILE__) . '/../autoload.php';
* Authentication class that deals with the OAuth 2 web-server authentication flow
class Google_Auth_OAuth2 extends Google_Auth_Abstract
const OAUTH2_REVOKE_URI = 'https://accounts.google.com/o/oauth2/revoke';
const OAUTH2_TOKEN_URI = 'https://accounts.google.com/o/oauth2/token';
const OAUTH2_AUTH_URL = 'https://accounts.google.com/o/oauth2/auth';
const CLOCK_SKEW_SECS = 300; // five minutes in seconds
const AUTH_TOKEN_LIFETIME_SECS = 300; // five minutes in seconds
const MAX_TOKEN_LIFETIME_SECS = 86400; // one day in seconds
const OAUTH2_ISSUER = 'accounts.google.com';
/** @var Google_Auth_AssertionCredentials $assertionCredentials */
private $assertionCredentials;
* @var string The state parameters for CSRF and other forgery protection.
* @var array The token bundle.
private $token = array();
* @var UDP_Google_Client the base client
* Instantiates the class, but does not initiate the login flow, leaving it
* to the discretion of the caller.
public function __construct(UDP_Google_Client $client)
* Perform an authenticated / signed apiHttpRequest.
* This function takes the apiHttpRequest, calls apiAuth->sign on it
* (which can modify the request in what ever way fits the auth mechanism)
* and then calls apiCurlIO::makeRequest on the signed request
* @param Google_Http_Request $request
* @return Google_Http_Request The resulting HTTP response including the
* responseHttpCode, responseHeaders and responseBody.
public function authenticatedRequest(UDP_Google_Http_Request $request)
$request = $this->sign($request);
return $this->client->getIo()->makeRequest($request);
* @throws Google_Auth_Exception
public function authenticate($code)
if (strlen($code) == 0) {
throw new Google_Auth_Exception("Invalid code");
// We got here from the redirect from a successful authorization grant,
// fetch the access token
$request = new UDP_Google_Http_Request(
'grant_type' => 'authorization_code',
'redirect_uri' => $this->client->getClassConfig($this, 'redirect_uri'),
'client_id' => $this->client->getClassConfig($this, 'client_id'),
'client_secret' => $this->client->getClassConfig($this, 'client_secret')
$response = $this->client->getIo()->makeRequest($request);
if ($response->getResponseHttpCode() == 200) {
$this->setAccessToken($response->getResponseBody());
$this->token['created'] = time();
return $this->getAccessToken();
$decodedResponse = json_decode($response->getResponseBody(), true);
if ($decodedResponse != null && $decodedResponse['error']) {
$errorText = $decodedResponse['error'];
if (isset($decodedResponse['error_description'])) {
$errorText .= ": " . $decodedResponse['error_description'];
throw new Google_Auth_Exception(
"Error fetching OAuth2 access token, message: '%s'",
$response->getResponseHttpCode()
* Create a URL to obtain user authorization.
* The authorization endpoint allows the user to first
* authenticate, and then grant/deny the access request.
* @param string $scope The scope is expressed as a list of space-delimited strings.
public function createAuthUrl($scope)
'response_type' => 'code',
'redirect_uri' => $this->client->getClassConfig($this, 'redirect_uri'),
'client_id' => $this->client->getClassConfig($this, 'client_id'),
'access_type' => $this->client->getClassConfig($this, 'access_type'),
// Prefer prompt to approval prompt.
if ($this->client->getClassConfig($this, 'prompt')) {
$params = $this->maybeAddParam($params, 'prompt');
$params = $this->maybeAddParam($params, 'approval_prompt');
$params = $this->maybeAddParam($params, 'login_hint');
$params = $this->maybeAddParam($params, 'hd');
$params = $this->maybeAddParam($params, 'openid.realm');
$params = $this->maybeAddParam($params, 'include_granted_scopes');
// If the list of scopes contains plus.login, add request_visible_actions
$rva = $this->client->getClassConfig($this, 'request_visible_actions');
if (strpos($scope, 'plus.login') && strlen($rva) > 0) {
$params['request_visible_actions'] = $rva;
if (isset($this->state)) {
$params['state'] = $this->state;
return self::OAUTH2_AUTH_URL . "?" . http_build_query($params, '', '&');
* @throws Google_Auth_Exception
public function setAccessToken($token)
$token = json_decode($token, true);
throw new Google_Auth_Exception('Could not json decode the token');
if (! isset($token['access_token'])) {
throw new Google_Auth_Exception("Invalid token format");
public function getAccessToken()
return json_encode($this->token);
public function getRefreshToken()
if (array_key_exists('refresh_token', $this->token)) {
return $this->token['refresh_token'];
public function setState($state)
public function setAssertionCredentials(Google_Auth_AssertionCredentials $creds)
$this->assertionCredentials = $creds;
* Include an accessToken in a given apiHttpRequest.
* @param Google_Http_Request $request
* @return Google_Http_Request
* @throws Google_Auth_Exception
public function sign(UDP_Google_Http_Request $request)
// add the developer key to the request before signing it
if ($this->client->getClassConfig($this, 'developer_key')) {
$request->setQueryParam('key', $this->client->getClassConfig($this, 'developer_key'));
// Cannot sign the request without an OAuth access token.
if (null == $this->token && null == $this->assertionCredentials) {
// Check if the token is set to expire in the next 30 seconds
// (or has already expired).
if ($this->isAccessTokenExpired()) {
if ($this->assertionCredentials) {
$this->refreshTokenWithAssertion();
$this->client->getLogger()->debug('OAuth2 access token expired');
if (! array_key_exists('refresh_token', $this->token)) {
$error = "The OAuth 2.0 access token has expired,"
." and a refresh token is not available. Refresh tokens"
." are not returned for responses that were auto-approved.";
$this->client->getLogger()->error($error);
throw new Google_Auth_Exception($error);
$this->refreshToken($this->token['refresh_token']);
$this->client->getLogger()->debug('OAuth2 authentication');
// Add the OAuth2 header to the request
$request->setRequestHeaders(
array('Authorization' => 'Bearer ' . $this->token['access_token'])
* Fetches a fresh access token with the given refresh token.
* @param string $refreshToken
public function refreshToken($refreshToken)
$this->refreshTokenRequest(
'client_id' => $this->client->getClassConfig($this, 'client_id'),
'client_secret' => $this->client->getClassConfig($this, 'client_secret'),
'refresh_token' => $refreshToken,
'grant_type' => 'refresh_token'
* Fetches a fresh access token with a given assertion token.
* @param Google_Auth_AssertionCredentials $assertionCredentials optional.
public function refreshTokenWithAssertion($assertionCredentials = null)
if (!$assertionCredentials) {
$assertionCredentials = $this->assertionCredentials;
$cacheKey = $assertionCredentials->getCacheKey();
// We can check whether we have a token available in the
// cache. If it is expired, we can retrieve a new one from
$token = $this->client->getCache()->get($cacheKey);
$this->setAccessToken($token);
if (!$this->isAccessTokenExpired()) {
$this->client->getLogger()->debug('OAuth2 access token expired');
$this->refreshTokenRequest(
'grant_type' => 'assertion',
'assertion_type' => $assertionCredentials->assertionType,
'assertion' => $assertionCredentials->generateAssertion(),
// Attempt to cache the token.
$this->client->getCache()->set(
private function refreshTokenRequest($params)
if (isset($params['assertion'])) {
$this->client->getLogger()->info(
'OAuth2 access token refresh with Signed JWT assertion grants.'
$this->client->getLogger()->info('OAuth2 access token refresh');
$http = new UDP_Google_Http_Request(
$request = $this->client->getIo()->makeRequest($http);
$code = $request->getResponseHttpCode();
$body = $request->getResponseBody();
$token = json_decode($body, true);
throw new Google_Auth_Exception("Could not json decode the access token");
if (! isset($token['access_token']) || ! isset($token['expires_in'])) {
throw new Google_Auth_Exception("Invalid token format");
if (isset($token['id_token'])) {
$this->token['id_token'] = $token['id_token'];
$this->token['access_token'] = $token['access_token'];
$this->token['expires_in'] = $token['expires_in'];
$this->token['created'] = time();
throw new Google_Auth_Exception("Error refreshing the OAuth2 token, message: '$body'", $code);
* Revoke an OAuth2 access token or refresh token. This method will revoke the current access
* token, if a token isn't provided.
* @throws Google_Auth_Exception
* @param string|null $token The token (access token or a refresh token) that should be revoked.
* @return boolean Returns True if the revocation was successful, otherwise False.
public function revokeToken($token = null)
// Not initialized, no token to actually revoke
} elseif (array_key_exists('refresh_token', $this->token)) {
$token = $this->token['refresh_token'];
$token = $this->token['access_token'];
$request = new UDP_Google_Http_Request(
$response = $this->client->getIo()->makeRequest($request);
$code = $response->getResponseHttpCode();
* Returns if the access_token is expired.
* @return bool Returns True if the access_token is expired.
public function isAccessTokenExpired()
if (!$this->token || !isset($this->token['created'])) {
// If the token is set to expire in the next 30 seconds.
$expired = ($this->token['created']
+ ($this->token['expires_in'] - 30)) < time();
// Gets federated sign-on certificates to use for verifying identity tokens.
// Returns certs as array structure, where keys are key ids, and values
// are PEM encoded certificates.
private function getFederatedSignOnCerts()
return $this->retrieveCertsFromLocation(
$this->client->getClassConfig($this, 'federated_signon_certs_url')
* Retrieve and cache a certificates file.
* @param $url string location
* @throws Google_Auth_Exception
* @return array certificates
public function retrieveCertsFromLocation($url)
// If we're retrieving a local file, just grab it.
if ("http" != substr($url, 0, 4)) {
$file = file_get_contents($url);
return json_decode($file, true);
throw new Google_Auth_Exception(
"Failed to retrieve verification certificates: '" .
// This relies on makeRequest caching certificate responses.
$request = $this->client->getIo()->makeRequest(
new UDP_Google_Http_Request(
if ($request->getResponseHttpCode() == 200) {
$certs = json_decode($request->getResponseBody(), true);
throw new Google_Auth_Exception(
"Failed to retrieve verification certificates: '" .
$request->getResponseBody() . "'.",
$request->getResponseHttpCode()
* Verifies an id token and returns the authenticated apiLoginTicket.
* Throws an exception if the id token is not valid.
* The audience parameter can be used to control which id tokens are
* accepted. By default, the id token must have been issued to this OAuth2 client.
* @return Google_Auth_LoginTicket
public function verifyIdToken($id_token = null, $audience = null)
$id_token = $this->token['id_token'];
$certs = $this->getFederatedSignonCerts();
$audience = $this->client->getClassConfig($this, 'client_id');
return $this->verifySignedJwtWithCerts($id_token, $certs, $audience, self::OAUTH2_ISSUER);
* Verifies the id token, returns the verified token contents.
* @param $jwt string the token
* @param $certs array of certificates
* @param $required_audience string the expected consumer of the token
* @param [$issuer] the expected issues, defaults to Google
* @param [$max_expiry] the max lifetime of a token, defaults to MAX_TOKEN_LIFETIME_SECS
* @throws Google_Auth_Exception
* @return mixed token information if valid, false if not
public function verifySignedJwtWithCerts(
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
