|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace AsyncAws\Core\Credentials; |
| 6 | + |
| 7 | +use AsyncAws\Core\EnvVar; |
| 8 | +use AsyncAws\SsoOidc\SsoOidcClient; |
| 9 | +use Psr\Log\LoggerInterface; |
| 10 | +use Psr\Log\NullLogger; |
| 11 | +use Symfony\Contracts\HttpClient\HttpClientInterface; |
| 12 | + |
| 13 | +/** |
| 14 | + * Load and refresh AWS SSO tokens. |
| 15 | + * |
| 16 | + * @internal |
| 17 | + */ |
| 18 | +final class SsoTokenProvider |
| 19 | +{ |
| 20 | + public const KEY_CLIENT_ID = 'clientId'; |
| 21 | + public const KEY_CLIENT_SECRET = 'clientSecret'; |
| 22 | + public const KEY_REFRESH_TOKEN = 'refreshToken'; |
| 23 | + public const KEY_ACCESS_TOKEN = 'accessToken'; |
| 24 | + public const KEY_EXPIRES_AT = 'expiresAt'; |
| 25 | + |
| 26 | + private const REFRESH_WINDOW = 300; |
| 27 | + |
| 28 | + /** |
| 29 | + * @var LoggerInterface |
| 30 | + */ |
| 31 | + private $logger; |
| 32 | + /** |
| 33 | + * @var HttpClientInterface |
| 34 | + */ |
| 35 | + private $httpClient; |
| 36 | + |
| 37 | + public function __construct(HttpClientInterface $httpClient, ?LoggerInterface $logger = null) |
| 38 | + { |
| 39 | + $this->httpClient = $httpClient; |
| 40 | + $this->logger = $logger ?? new NullLogger(); |
| 41 | + } |
| 42 | + |
| 43 | + /** |
| 44 | + * @param array<string, string> $sessionData |
| 45 | + */ |
| 46 | + public function getToken(string $sessionName, array $sessionData): ?string |
| 47 | + { |
| 48 | + $tokenData = $this->loadSsoToken($sessionName); |
| 49 | + if (null === $tokenData) { |
| 50 | + return null; |
| 51 | + } |
| 52 | + |
| 53 | + $tokenData = $this->refreshTokenIfNeeded($sessionName, $sessionData, $tokenData); |
| 54 | + if (!isset($tokenData[self::KEY_ACCESS_TOKEN])) { |
| 55 | + $this->logger->warning('The token for SSO session "{session}" does not contains accessToken.', ['session' => $sessionName]); |
| 56 | + |
| 57 | + return null; |
| 58 | + } |
| 59 | + |
| 60 | + return $tokenData[self::KEY_ACCESS_TOKEN]; |
| 61 | + } |
| 62 | + |
| 63 | + /** |
| 64 | + * @param array<string, string> $sessionData |
| 65 | + */ |
| 66 | + private function refreshTokenIfNeeded(string $sessionName, array $sessionData, array $tokenData): array |
| 67 | + { |
| 68 | + if (!isset($tokenData[self::KEY_EXPIRES_AT])) { |
| 69 | + $this->logger->warning('The token for SSO session "{session}" does not contains expiration date.', ['session' => $sessionName]); |
| 70 | + |
| 71 | + return $tokenData; |
| 72 | + } |
| 73 | + |
| 74 | + $tokenExpiresAt = new \DateTimeImmutable($tokenData[self::KEY_EXPIRES_AT]); |
| 75 | + $tokenRefreshAt = $tokenExpiresAt->sub(new \DateInterval(\sprintf('PT%dS', self::REFRESH_WINDOW))); |
| 76 | + |
| 77 | + // If token expiration is in the 5 minutes window |
| 78 | + if ($tokenRefreshAt > new \DateTimeImmutable()) { |
| 79 | + return $tokenData; |
| 80 | + } |
| 81 | + |
| 82 | + if (!isset( |
| 83 | + $tokenData[self::KEY_CLIENT_ID], |
| 84 | + $tokenData[self::KEY_CLIENT_SECRET], |
| 85 | + $tokenData[self::KEY_REFRESH_TOKEN] |
| 86 | + )) { |
| 87 | + $this->logger->warning('The token for SSO session "{session}" does not contains required properties and cannot be refreshed.', ['session' => $sessionName]); |
| 88 | + |
| 89 | + return $tokenData; |
| 90 | + } |
| 91 | + |
| 92 | + $ssoOidcClient = new SsoOidcClient( |
| 93 | + ['region' => $sessionData[IniFileLoader::KEY_SSO_REGION]], |
| 94 | + new NullProvider(), |
| 95 | + // no credentials required as we provide an access token via the role credentials request |
| 96 | + $this->httpClient |
| 97 | + ); |
| 98 | + |
| 99 | + $result = $ssoOidcClient->createToken([ |
| 100 | + 'clientId' => $tokenData[self::KEY_CLIENT_ID], |
| 101 | + 'clientSecret' => $tokenData[self::KEY_CLIENT_SECRET], |
| 102 | + 'grantType' => 'refresh_token', // REQUIRED |
| 103 | + 'refreshToken' => $tokenData[self::KEY_REFRESH_TOKEN], |
| 104 | + ]); |
| 105 | + |
| 106 | + $tokenData = [ |
| 107 | + self::KEY_ACCESS_TOKEN => $result->getAccessToken(), |
| 108 | + self::KEY_EXPIRES_AT => (new \DateTimeImmutable())->add(new \DateInterval(\sprintf('PT%dS', $result->getExpiresIn())))->format(\DateTime::ATOM), |
| 109 | + self::KEY_REFRESH_TOKEN => $result->getRefreshToken(), |
| 110 | + ] + $tokenData; |
| 111 | + |
| 112 | + $this->dumpSsoToken($sessionName, $tokenData); |
| 113 | + return $tokenData; |
| 114 | + } |
| 115 | + |
| 116 | + private function dumpSsoToken(string $sessionName, array $tokenData): void |
| 117 | + { |
| 118 | + $filepath = \sprintf('%s/.aws/sso/cache/%s.json', $this->getHomeDir(), sha1($sessionName)); |
| 119 | + |
| 120 | + file_put_contents($filepath, json_encode(array_filter($tokenData))); |
| 121 | + } |
| 122 | + |
| 123 | + /** |
| 124 | + * @return null|array<string, string> |
| 125 | + */ |
| 126 | + private function loadSsoToken(string $sessionName): ?array |
| 127 | + { |
| 128 | + $filepath = \sprintf('%s/.aws/sso/cache/%s.json', $this->getHomeDir(), sha1($sessionName)); |
| 129 | + if (!is_readable($filepath)) { |
| 130 | + $this->logger->warning('The sso cache file {path} is not readable.', ['path' => $filepath]); |
| 131 | + |
| 132 | + return null; |
| 133 | + } |
| 134 | + |
| 135 | + if (false === ($content = @file_get_contents($filepath))) { |
| 136 | + $this->logger->warning('The sso cache file {path} is not readable.', ['path' => $filepath]); |
| 137 | + |
| 138 | + return null; |
| 139 | + } |
| 140 | + |
| 141 | + try { |
| 142 | + return json_decode( |
| 143 | + $content, |
| 144 | + true, |
| 145 | + 512, |
| 146 | + \JSON_BIGINT_AS_STRING | (\PHP_VERSION_ID >= 70300 ? \JSON_THROW_ON_ERROR : 0) |
| 147 | + ); |
| 148 | + } catch (\JsonException $e) { |
| 149 | + $this->logger->warning( |
| 150 | + 'The sso cache file {path} contains invalide JSON.', |
| 151 | + ['path' => $filepath, 'ecxeption' => $e] |
| 152 | + ); |
| 153 | + |
| 154 | + return null; |
| 155 | + } |
| 156 | + } |
| 157 | + |
| 158 | + private function getHomeDir(): string |
| 159 | + { |
| 160 | + // On Linux/Unix-like systems, use the HOME environment variable |
| 161 | + if (null !== $homeDir = EnvVar::get('HOME')) { |
| 162 | + return $homeDir; |
| 163 | + } |
| 164 | + |
| 165 | + // Get the HOMEDRIVE and HOMEPATH values for Windows hosts |
| 166 | + $homeDrive = EnvVar::get('HOMEDRIVE'); |
| 167 | + $homePath = EnvVar::get('HOMEPATH'); |
| 168 | + |
| 169 | + return ($homeDrive && $homePath) ? $homeDrive.$homePath : '/'; |
| 170 | + } |
| 171 | +} |
0 commit comments