Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add ImpersonatedServiceAccountCredentials (#421)
- Loading branch information
1 parent
d3726fe
commit de766e9
Showing
7 changed files
with
318 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
src/Credentials/ImpersonatedServiceAccountCredentials.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * Copyright 2022 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\IamSignerTrait; | ||
| use Google\Auth\SignBlobInterface; | ||
|
|
||
| class ImpersonatedServiceAccountCredentials extends CredentialsLoader implements SignBlobInterface | ||
| { | ||
| use IamSignerTrait; | ||
|
|
||
| /** | ||
| * @var string | ||
| */ | ||
| protected $impersonatedServiceAccountName; | ||
|
|
||
| /** | ||
| * @var UserRefreshCredentials | ||
| */ | ||
| protected $sourceCredentials; | ||
|
|
||
| /** | ||
| * Instantiate an instance of ImpersonatedServiceAccountCredentials from a credentials file that has be created with | ||
| * the --impersonated-service-account flag. | ||
| * | ||
| * @param string|string[] $scope the scope of the access request, expressed | ||
| * either as an Array or as a space-delimited String. | ||
| * @param string|array<mixed> $jsonKey JSON credential file path or JSON credentials | ||
| * as an associative array | ||
| */ | ||
| public function __construct( | ||
| $scope, | ||
| $jsonKey | ||
| ) { | ||
| if (is_string($jsonKey)) { | ||
| if (!file_exists($jsonKey)) { | ||
| throw new \InvalidArgumentException('file does not exist'); | ||
| } | ||
| $json = file_get_contents($jsonKey); | ||
| if (!$jsonKey = json_decode((string) $json, true)) { | ||
| throw new \LogicException('invalid json for auth config'); | ||
| } | ||
| } | ||
| if (!array_key_exists('service_account_impersonation_url', $jsonKey)) { | ||
| throw new \LogicException('json key is missing the service_account_impersonation_url field'); | ||
| } | ||
| if (!array_key_exists('source_credentials', $jsonKey)) { | ||
| throw new \LogicException('json key is missing the source_credentials field'); | ||
| } | ||
|
|
||
| $this->impersonatedServiceAccountName = $this->getImpersonatedServiceAccountNameFromUrl($jsonKey['service_account_impersonation_url']); | ||
|
|
||
| $this->sourceCredentials = new UserRefreshCredentials($scope, $jsonKey['source_credentials']); | ||
| } | ||
|
|
||
| /** | ||
| * Helper function for extracting the Server Account Name from the URL saved in the account credentials file | ||
| * @param $serviceAccountImpersonationUrl string URL from the 'service_account_impersonation_url' field | ||
| * @return string Service account email or ID. | ||
| */ | ||
| private function getImpersonatedServiceAccountNameFromUrl(string $serviceAccountImpersonationUrl) | ||
| { | ||
| $fields = explode('/', $serviceAccountImpersonationUrl); | ||
| $lastField = end($fields); | ||
| $splitter = explode(':', $lastField); | ||
| return $splitter[0]; | ||
| } | ||
|
|
||
| /** | ||
| * Get the client name from the keyfile | ||
| * | ||
| * In this implementation, it will return the issuers email from the oauth token. | ||
| * | ||
| * @param callable|null $unusedHttpHandler not used by this credentials type. | ||
| * @return string Token issuer email | ||
| */ | ||
| public function getClientName(callable $unusedHttpHandler = null) | ||
| { | ||
| return $this->impersonatedServiceAccountName; | ||
| } | ||
|
|
||
| /** | ||
| * @param callable $httpHandler | ||
| * | ||
| * @return array<mixed> { | ||
| * A set of auth related metadata, containing the following | ||
| * | ||
| * @type string $access_token | ||
| * @type int $expires_in | ||
| * @type string $scope | ||
| * @type string $token_type | ||
| * @type string $id_token | ||
| * } | ||
| */ | ||
| public function fetchAuthToken(callable $httpHandler = null) | ||
| { | ||
| return $this->sourceCredentials->fetchAuthToken($httpHandler); | ||
| } | ||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| public function getCacheKey() | ||
| { | ||
| return $this->sourceCredentials->getCacheKey(); | ||
| } | ||
|
|
||
| /** | ||
| * @return array<mixed> | ||
| */ | ||
| public function getLastReceivedToken() | ||
| { | ||
| return $this->sourceCredentials->getLastReceivedToken(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * Copyright 2022 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; | ||
|
|
||
| use Exception; | ||
| use Google\Auth\HttpHandler\HttpClientCache; | ||
| use Google\Auth\HttpHandler\HttpHandlerFactory; | ||
|
|
||
| trait IamSignerTrait | ||
| { | ||
| /** | ||
| * @var Iam|null | ||
| */ | ||
| private $iam; | ||
|
|
||
| /** | ||
| * Sign a string using the default service account private key. | ||
| * | ||
| * This implementation uses IAM's signBlob API. | ||
| * | ||
| * @see https://cloud.google.com/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob SignBlob | ||
| * | ||
| * @param string $stringToSign The string to sign. | ||
| * @param bool $forceOpenSsl [optional] Does not apply to this credentials | ||
| * type. | ||
| * @param string $accessToken The access token to use to sign the blob. If | ||
| * provided, saves a call to the metadata server for a new access | ||
| * token. **Defaults to** `null`. | ||
| * @return string | ||
| * @throws Exception | ||
| */ | ||
| public function signBlob($stringToSign, $forceOpenSsl = false, $accessToken = null) | ||
| { | ||
| $httpHandler = HttpHandlerFactory::build(HttpClientCache::getHttpClient()); | ||
|
|
||
| // Providing a signer is useful for testing, but it's undocumented | ||
| // because it's not something a user would generally need to do. | ||
| $signer = $this->iam ?: new Iam($httpHandler); | ||
|
|
||
| $email = $this->getClientName($httpHandler); | ||
|
|
||
| if (is_null($accessToken)) { | ||
| $previousToken = $this->getLastReceivedToken(); | ||
| $accessToken = $previousToken | ||
| ? $previousToken['access_token'] | ||
| : $this->fetchAuthToken($httpHandler)['access_token']; | ||
| } | ||
|
|
||
| return $signer->signBlob($email, $accessToken, $stringToSign); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.