mirror of
https://github.com/crmeb/CRMEB.git
synced 2026-10-28 21:40:50 +00:00
202 lines
7.4 KiB
PHP
202 lines
7.4 KiB
PHP
<?php
|
|
namespace Aws\Credentials;
|
|
|
|
use Aws\Exception\AwsException;
|
|
use Aws\Exception\CredentialsException;
|
|
use Aws\Result;
|
|
use Aws\Sts\StsClient;
|
|
use GuzzleHttp\Promise;
|
|
|
|
/**
|
|
* Credential provider that provides credentials via assuming a role with a web identity
|
|
* More Information, see: https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#assumerolewithwebidentity
|
|
*/
|
|
class AssumeRoleWithWebIdentityCredentialProvider
|
|
{
|
|
const ERROR_MSG = "Missing required 'AssumeRoleWithWebIdentityCredentialProvider' configuration option: ";
|
|
const ENV_RETRIES = 'AWS_METADATA_SERVICE_NUM_ATTEMPTS';
|
|
|
|
/** @var string */
|
|
private $tokenFile;
|
|
|
|
/** @var string */
|
|
private $arn;
|
|
|
|
/** @var string */
|
|
private $session;
|
|
|
|
/** @var StsClient */
|
|
private $client;
|
|
|
|
/** @var integer */
|
|
private $retries;
|
|
|
|
/** @var integer */
|
|
private $authenticationAttempts;
|
|
|
|
/** @var integer */
|
|
private $tokenFileReadAttempts;
|
|
|
|
/** @var string */
|
|
private $source;
|
|
|
|
/**
|
|
* The constructor attempts to load config from environment variables.
|
|
* If not set, the following config options are used:
|
|
* - WebIdentityTokenFile: full path of token filename
|
|
* - RoleArn: arn of role to be assumed
|
|
* - SessionName: (optional) set by SDK if not provided
|
|
* - source: To identify if the provider was sourced by a profile or
|
|
* from environment definition. Default will be `sts_web_id_token`.
|
|
*
|
|
* @param array $config Configuration options
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function __construct(array $config = [])
|
|
{
|
|
if (!isset($config['RoleArn'])) {
|
|
throw new \InvalidArgumentException(self::ERROR_MSG . "'RoleArn'.");
|
|
}
|
|
$this->arn = $config['RoleArn'];
|
|
|
|
if (!isset($config['WebIdentityTokenFile'])) {
|
|
throw new \InvalidArgumentException(self::ERROR_MSG . "'WebIdentityTokenFile'.");
|
|
}
|
|
$this->tokenFile = $config['WebIdentityTokenFile'];
|
|
|
|
if (!preg_match("/^\w\:|^\/|^\\\/", $this->tokenFile)) {
|
|
throw new \InvalidArgumentException("'WebIdentityTokenFile' must be an absolute path.");
|
|
}
|
|
|
|
$this->retries = (int) getenv(self::ENV_RETRIES) ?: (isset($config['retries']) ? $config['retries'] : 3);
|
|
$this->authenticationAttempts = 0;
|
|
$this->tokenFileReadAttempts = 0;
|
|
$this->session = $config['SessionName']
|
|
?? 'aws-sdk-php-' . round(microtime(true) * 1000);
|
|
|
|
if (isset($config['client'])) {
|
|
$this->client = $config['client'];
|
|
} else {
|
|
$region = $config['region']
|
|
?? getEnv(CredentialProvider::ENV_REGION)
|
|
?: null;
|
|
|
|
$this->client = $this->createDefaultStsClient($region);
|
|
}
|
|
|
|
$this->source = $config['source']
|
|
?? CredentialSources::STS_WEB_ID_TOKEN;
|
|
}
|
|
|
|
/**
|
|
* Loads assume role with web identity credentials.
|
|
*
|
|
* @return Promise\PromiseInterface
|
|
*/
|
|
public function __invoke()
|
|
{
|
|
return Promise\Coroutine::of(function () {
|
|
$client = $this->client;
|
|
$result = null;
|
|
while ($result == null) {
|
|
try {
|
|
$token = @file_get_contents($this->tokenFile);
|
|
if (false === $token) {
|
|
clearstatcache(true, dirname($this->tokenFile) . "/" . readlink($this->tokenFile));
|
|
clearstatcache(true, dirname($this->tokenFile) . "/" . dirname(readlink($this->tokenFile)));
|
|
clearstatcache(true, $this->tokenFile);
|
|
if (!@is_readable($this->tokenFile)) {
|
|
throw new CredentialsException(
|
|
"Unreadable tokenfile at location {$this->tokenFile}"
|
|
);
|
|
}
|
|
|
|
$token = @file_get_contents($this->tokenFile);
|
|
}
|
|
if (empty($token)) {
|
|
if ($this->tokenFileReadAttempts < $this->retries) {
|
|
sleep((int) pow(1.2, $this->tokenFileReadAttempts));
|
|
$this->tokenFileReadAttempts++;
|
|
continue;
|
|
}
|
|
throw new CredentialsException("InvalidIdentityToken from file: {$this->tokenFile}");
|
|
}
|
|
} catch (\Exception $exception) {
|
|
throw new CredentialsException(
|
|
"Error reading WebIdentityTokenFile from " . $this->tokenFile,
|
|
0,
|
|
$exception
|
|
);
|
|
}
|
|
|
|
$assumeParams = [
|
|
'RoleArn' => $this->arn,
|
|
'RoleSessionName' => $this->session,
|
|
'WebIdentityToken' => $token
|
|
];
|
|
|
|
try {
|
|
$result = $client->assumeRoleWithWebIdentity($assumeParams);
|
|
} catch (AwsException $e) {
|
|
if ($e->getAwsErrorCode() == 'InvalidIdentityToken') {
|
|
if ($this->authenticationAttempts < $this->retries) {
|
|
sleep((int) pow(1.2, $this->authenticationAttempts));
|
|
} else {
|
|
throw new CredentialsException(
|
|
"InvalidIdentityToken, retries exhausted"
|
|
);
|
|
}
|
|
} else {
|
|
throw new CredentialsException(
|
|
"Error assuming role from web identity credentials",
|
|
0,
|
|
$e
|
|
);
|
|
}
|
|
} catch (\Exception $e) {
|
|
throw new CredentialsException(
|
|
"Error retrieving web identity credentials: " . $e->getMessage()
|
|
. " (" . $e->getCode() . ")"
|
|
);
|
|
}
|
|
$this->authenticationAttempts++;
|
|
}
|
|
|
|
yield $this->client->createCredentials(
|
|
$result,
|
|
$this->source
|
|
);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @param string|null $region
|
|
*
|
|
* @return StsClient
|
|
*/
|
|
private function createDefaultStsClient(
|
|
?string $region
|
|
): StsClient
|
|
{
|
|
if (empty($region)) {
|
|
$region = CredentialProvider::FALLBACK_REGION;
|
|
trigger_error(
|
|
'NOTICE: STS client created without explicit `region` configuration.' . PHP_EOL
|
|
. "Defaulting to {$region}. This fallback behavior may be removed." . PHP_EOL
|
|
. 'To avoid potential disruptions, configure a region using one of the following methods:' . PHP_EOL
|
|
. '(1) Pass `region` in the `$config` array when calling the provider,' . PHP_EOL
|
|
. '(2) Set the `AWS_REGION` environment variable.' . PHP_EOL
|
|
. 'OR provide an STS client in the `$config` array when creating the provider as `client`.' . PHP_EOL
|
|
. 'See: https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/assume-role-with-web-identity-provider.html'
|
|
. PHP_EOL,
|
|
E_USER_NOTICE
|
|
);
|
|
}
|
|
|
|
return new StsClient([
|
|
'credentials' => false,
|
|
'region' => $region
|
|
]);
|
|
}
|
|
}
|