123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131 |
- <?php
- /*
- * Copyright 2015 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.
- */
-
- namespace Google\Auth\Credentials;
-
- use Google\Auth\CredentialsLoader;
- use Google\Auth\OAuth2;
-
- /**
- * Authenticates requests using Google's Service Account credentials via
- * JWT Access.
- *
- * This class allows authorizing requests for service accounts directly
- * from credentials from a json key file downloaded from the developer
- * console (via 'Generate new Json Key'). It is not part of any OAuth2
- * flow, rather it creates a JWT and sends that as a credential.
- */
- class ServiceAccountJwtAccessCredentials extends CredentialsLoader
- {
- /**
- * The OAuth2 instance used to conduct authorization.
- *
- * @var OAuth2
- */
- protected $auth;
-
- /**
- * Create a new ServiceAccountJwtAccessCredentials.
- *
- * @param string|array $jsonKey JSON credential file path or JSON credentials
- * as an associative array
- */
- public function __construct($jsonKey)
- {
- if (is_string($jsonKey)) {
- if (!file_exists($jsonKey)) {
- throw new \InvalidArgumentException('file does not exist');
- }
- $jsonKeyStream = file_get_contents($jsonKey);
- if (!$jsonKey = json_decode($jsonKeyStream, true)) {
- throw new \LogicException('invalid json for auth config');
- }
- }
- if (!array_key_exists('client_email', $jsonKey)) {
- throw new \InvalidArgumentException(
- 'json key is missing the client_email field');
- }
- if (!array_key_exists('private_key', $jsonKey)) {
- throw new \InvalidArgumentException(
- 'json key is missing the private_key field');
- }
- $this->auth = new OAuth2([
- 'issuer' => $jsonKey['client_email'],
- 'sub' => $jsonKey['client_email'],
- 'signingAlgorithm' => 'RS256',
- 'signingKey' => $jsonKey['private_key'],
- ]);
- }
-
- /**
- * Updates metadata with the authorization token.
- *
- * @param array $metadata metadata hashmap
- * @param string $authUri optional auth uri
- * @param callable $httpHandler callback which delivers psr7 request
- *
- * @return array updated metadata hashmap
- */
- public function updateMetadata(
- $metadata,
- $authUri = null,
- callable $httpHandler = null
- ) {
- if (empty($authUri)) {
- return $metadata;
- }
-
- $this->auth->setAudience($authUri);
-
- return parent::updateMetadata($metadata, $authUri, $httpHandler);
- }
-
- /**
- * Implements FetchAuthTokenInterface#fetchAuthToken.
- *
- * @param callable $httpHandler
- *
- * @return array|void
- */
- public function fetchAuthToken(callable $httpHandler = null)
- {
- $audience = $this->auth->getAudience();
- if (empty($audience)) {
- return null;
- }
-
- $access_token = $this->auth->toJwt();
-
- return array('access_token' => $access_token);
- }
-
- /**
- * @return string
- */
- public function getCacheKey()
- {
- return $this->auth->getCacheKey();
- }
-
- /**
- * @return array
- */
- public function getLastReceivedToken()
- {
- return $this->auth->getLastReceivedToken();
- }
- }
|