Spaces:
No application file
No application file
File size: 6,396 Bytes
d2897cd |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
<?php
declare(strict_types=1);
namespace Mautic\IntegrationsBundle\Auth\Provider\Oauth2ThreeLegged;
use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\HandlerStack;
use kamermans\OAuth2\GrantType\AuthorizationCode;
use kamermans\OAuth2\GrantType\RefreshToken;
use kamermans\OAuth2\OAuth2Middleware;
use Mautic\IntegrationsBundle\Auth\Provider\AuthConfigInterface;
use Mautic\IntegrationsBundle\Auth\Provider\AuthCredentialsInterface;
use Mautic\IntegrationsBundle\Auth\Provider\AuthProviderInterface;
use Mautic\IntegrationsBundle\Auth\Provider\Oauth2ThreeLegged\Credentials\CodeInterface;
use Mautic\IntegrationsBundle\Auth\Provider\Oauth2ThreeLegged\Credentials\CredentialsInterface;
use Mautic\IntegrationsBundle\Auth\Provider\Oauth2ThreeLegged\Credentials\RedirectUriInterface;
use Mautic\IntegrationsBundle\Auth\Provider\Oauth2ThreeLegged\Credentials\ScopeInterface;
use Mautic\IntegrationsBundle\Auth\Support\Oauth2\ConfigAccess\ConfigCredentialsSignerInterface;
use Mautic\IntegrationsBundle\Auth\Support\Oauth2\ConfigAccess\ConfigTokenFactoryInterface;
use Mautic\IntegrationsBundle\Auth\Support\Oauth2\ConfigAccess\ConfigTokenPersistenceInterface;
use Mautic\IntegrationsBundle\Auth\Support\Oauth2\ConfigAccess\ConfigTokenSignerInterface;
use Mautic\IntegrationsBundle\Exception\PluginNotConfiguredException;
/**
* Factory for building HTTP clients that will sign the requests with Oauth2 headers.
* Based on Guzzle OAuth 2.0 Subscriber - kamermans/guzzle-oauth2-subscriber package.
*
* @see https://github.com/kamermans/guzzle-oauth2-subscriber
*/
class HttpFactory implements AuthProviderInterface
{
public const NAME = 'oauth2_three_legged';
private ?AuthCredentialsInterface $credentials = null;
private ConfigCredentialsSignerInterface|ConfigTokenPersistenceInterface|ConfigTokenSignerInterface|AuthConfigInterface|null $config = null;
private ?Client $reAuthClient = null;
/**
* Cache of initialized clients.
*
* @var Client[]
*/
private array $initializedClients = [];
public function getAuthType(): string
{
return self::NAME;
}
/**
* @param AuthCredentialsInterface|CredentialsInterface $credentials
* @param ConfigCredentialsSignerInterface|ConfigTokenPersistenceInterface|ConfigTokenSignerInterface|AuthConfigInterface $config
*
* @throws PluginNotConfiguredException
*/
public function getClient(AuthCredentialsInterface $credentials, ?AuthConfigInterface $config = null): ClientInterface
{
if (!$this->credentialsAreConfigured($credentials)) {
throw new PluginNotConfiguredException('Missing credentials');
}
// Return cached initialized client if there is one.
if (isset($this->initializedClients[$credentials->getClientId()])) {
return $this->initializedClients[$credentials->getClientId()];
}
$this->credentials = $credentials;
$this->config = $config;
$options = [
'handler' => $this->getStackHandler(),
'auth' => 'oauth',
];
// Set up base URI if it's configured.
if (method_exists($credentials, 'getBaseUri') && ($baseUri = $credentials->getBaseUri()) !== null) {
$options['base_uri'] = $baseUri;
}
$this->initializedClients[$credentials->getClientId()] = new Client($options);
return $this->initializedClients[$credentials->getClientId()];
}
protected function credentialsAreConfigured(CredentialsInterface $credentials): bool
{
if (empty($credentials->getAuthorizationUrl())) {
return false;
}
if (empty($credentials->getTokenUrl())) {
return false;
}
if (empty($credentials->getClientId())) {
return false;
}
if (empty($credentials->getClientSecret())) {
return false;
}
return true;
}
private function getStackHandler(): HandlerStack
{
$reAuthConfig = $this->getReAuthConfig();
$grantType = new AuthorizationCode($this->getReAuthClient(), $reAuthConfig);
$refreshTokenGrantType = new RefreshToken($this->getReAuthClient(), $reAuthConfig);
$middleware = new OAuth2Middleware($grantType, $refreshTokenGrantType);
$this->configureMiddleware($middleware);
$stack = HandlerStack::create();
$stack->push($middleware);
return $stack;
}
private function getReAuthClient(): ClientInterface
{
if ($this->reAuthClient) {
return $this->reAuthClient;
}
$this->reAuthClient = new Client([
'base_uri' => $this->credentials->getTokenUrl(),
]);
return $this->reAuthClient;
}
private function getReAuthConfig(): array
{
$config = [
'client_id' => $this->credentials->getClientId(),
'client_secret' => $this->credentials->getClientSecret(),
'code' => '',
];
if ($this->credentials instanceof ScopeInterface) {
$config['scope'] = $this->credentials->getScope();
}
if ($this->credentials instanceof RedirectUriInterface) {
$config['redirect_uri'] = $this->credentials->getRedirectUri();
}
if ($this->credentials instanceof CodeInterface) {
$config['code'] = $this->credentials->getCode();
}
return $config;
}
private function configureMiddleware(OAuth2Middleware $oauth): void
{
if (!$this->config) {
return;
}
if ($this->config instanceof ConfigCredentialsSignerInterface) {
$oauth->setClientCredentialsSigner($this->config->getCredentialsSigner());
}
if ($this->config instanceof ConfigTokenPersistenceInterface) {
$oauth->setTokenPersistence($this->config->getTokenPersistence());
}
if ($this->config instanceof ConfigTokenSignerInterface) {
$oauth->setAccessTokenSigner($this->config->getTokenSigner());
}
if ($this->config instanceof ConfigTokenFactoryInterface) {
$oauth->setTokenFactory($this->config->getTokenFactory());
}
}
}
|