src/Platform/SecurityBundle/Service/OAuth/OAuthServiceFactory.php line 64

Open in your IDE?
  1. <?php
  3. namespace Platform\SecurityBundle\Service\OAuth;
  5. use Cms\CoreBundle\Service\ContextManager;
  6. use OAuth\Common\Consumer\Credentials;
  7. use OAuth\Common\Http\Client\CurlClient;
  8. use OAuth\Common\Service\ServiceInterface;
  9. use OAuth\Common\Storage\SymfonySession;
  10. use OAuth\ServiceFactory;
  11. use Platform\SecurityBundle\Model\OAuth\OAuthOptions;
  12. use Platform\SecurityBundle\Service\OAuth\Providers\AbstractOAuthProvider;
  13. use Platform\SecurityBundle\Service\OAuth\Providers as OAuthProviders;
  14. use Platform\SecurityBundle\Util\OAuth\ServiceFactory as ServiceFactories;
  15. use Symfony\Component\HttpFoundation\RequestStack;
  16. use OAuth\Common\Exception\Exception as OAuthException;
  18. /**
  19.  * Manages the OAuth core services that pertain to logins.
  20.  *
  21.  * Class OAuthServiceFactory
  22.  * @package Platform\SecurityBundle\Service\OAuth
  23.  */
  24. final class OAuthServiceFactory extends ServiceFactory
  25. {
  26.     /**
  27.      * Defines the set of services that this system will support.
  28.      * Keys are the IDs of the OAuth providers in the system.
  29.      * Values are the classnames of the service factory tied to that provider.
  30.      */
  31.     private const SERVICES = [
  32.         OAuthProviders\ClassLinkOAuthProvider::ID => ServiceFactories\ClassLinkOAuth2ServiceFactory::class,
  33.         OAuthProviders\CleverOAuthProvider::ID => ServiceFactories\CleverOAuth2ServiceFactory::class,
  34.         OAuthProviders\GlobalGridOAuthProvider::ID => ServiceFactories\GlobalGridOAuth2ServiceFactory::class,
  35.         OAuthProviders\GoogleOAuthProvider::ID => ServiceFactories\GoogleOAuth2ServiceFactory::class,
  36.         OAuthProviders\MicrosoftOAuthProvider::ID => ServiceFactories\MicrosoftOAuth2ServiceFactory::class,
  37.     ];
  39.     /**
  40.      * @var RequestStack
  41.      */
  42.     private RequestStack $requestStack;
  44.     /**
  45.      * @var ContextManager
  46.      */
  47.     private ContextManager $cm;
  49.     /**
  50.      * @param RequestStack $requestStack
  51.      * @param ContextManager $cm
  52.      * @throws OAuthException
  53.      */
  54.     public function __construct(RequestStack $requestStack, ContextManager $cm)
  55.     {
  56.         $this->requestStack = $requestStack;
  57.         $this->cm = $cm;
  59.         // we need to set up the client that handles the http api calls
  60.         $this->setHttpClient(new CurlClient());
  62.         // go ahead and register each service
  63.         foreach (self::SERVICES as $name => $class) {
  64.             $this->registerService($name, $class);
  65.         }
  66.     }
  68.     /**
  69.      * Gets the core OAuth service.
  70.      * Services are loosely tied to the providers, so a provider is required to be passed in order to obtain one.
  71.      * An optional callback can be set for when configuring the "credentials" for the service.
  72.      * This is useful for when handling things like Clever "Instant Login" requests as the OAuth callback differs.
  73.      *
  74.      * @param AbstractOAuthProvider $provider
  75.      * @param OAuthOptions $options
  76.      * @return ServiceInterface
  77.      */
  78.     public function getService(AbstractOAuthProvider $provider, OAuthOptions $options): ServiceInterface
  79.     {
  80.         return $this->createService(
  81.             $provider->getId(),
  82.             new Credentials(
  83.                 $provider->getClient(),
  84.                 $provider->getSecret(),
  85.                 $options->getCallback() ?? $this->getDefaultCallbackUrl()
  86.             ),
  87.             new SymfonySession($this->requestStack->getSession()),
  88.             array_merge($options->getScopes(), $provider->getScopes())
  89.         );
  90.     }
  92.     /**
  93.      * Gets a default value to use for the OAuth callbacks.
  94.      *
  95.      * TODO: this should use the router to properly generate the url
  96.      *
  97.      * @return string
  98.      */
  99.     private function getDefaultCallbackUrl(): string
  100.     {
  101.         return sprintf(
  102.             'https://%s/_oauth',
  103.             $this->cm->getGlobalContext()->getDashboard(true)
  104.         );
  105.     }
  106. }