v1.0

Author: Asisyas

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Komar Stanislau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,86 @@
+
+# Micro Framework Oauth2 client plugin
+
+Micro Framework: OAuth2 client based on "league/oauth2-client"
+## Installation
+
+Install plugin with composer
+
+```bash
+$ composer require micro/plugin-oauth2-client
+```
+
+And install a specific provider(s).
+
+Available providers:
+[micro/plugin-oauth2-client-keycloak]()
+
+Аnd then add plugin to the list of plugins (etc/plugins.php)
+
+```php
+
+$pluginsCommon = [
+    //....OTHER PLUGINS ....
+    Micro\Plugin\OAuth2\Client\OAuth2ClientPlugin::class,
+    Micro\Plugin\OAuth2\Client\Keycloak\OAuth2KeycloakProviderPlugin::class,
+];
+
+```
+Configure your oauth2 providers
+
+The adapter configuration template usually looks like this `MICRO_OAUTH2_<PROVIDER_NAME>_<PROVIDER_SETTING>`
+
+Default  adapter name "default"
+
+
+```dotenv
+MICRO_OAUTH2_DEFAULT_TYPE=keycloak
+MICRO_OAUTH2_DEFAULT_CLIENT_ID=<my-client-id>
+MICRO_OAUTH2_DEFAULT_CLIENT_SECRET=<client-secret-key>
+MICRO_OAUTH2_DEFAULT_CLIENT_URL_AUTHORIZATION=<auth url>
+MICRO_OAUTH2_DEFAULT_CLIENT_URL_REDIRECT=<redirect url>
+```
+
+
+## Usage/Examples
+
+Index document
+
+```php
+
+use use Micro\Plugin\OAuth2\Client\Facade\Oauth2ClientFacadeInterface;
+
+/** Unauthorized user */ 
+$client = $container->get(Oauth2ClientFacadeInterface::class);
+$provider = $client->getProvider('default');
+
+$provider->getAuthorizationUrl(); This method will return the full path to the server for user authorization.
+
+
+/*** Response from the authorization server with a code */
+$accessToken    = $provider->getAccessToken('authorization_code', [
+    'code'  => $_GET['code'],
+]);
+
+$owner = $provider->getResourceOwner($accessToken);
+
+$id = $owner->getId();
+$ownerData = $owner->toArray(); //Associated data with the user.
+
+```
+
+
+## Support
+
+For support, email [email protected].
+
+
+## Authors
+
+- [@stanislau_komar](https://www.github.com/asisyas)
+
+
+## License
+
+[MIT](LICENSE)
+

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "micro/plugin-oauth2-client",
+    "description": "Micro Framework: OAuth2 client based on \"league/oauth2-client\"",
+    "type": "library",
+    "version": "1.0",
+    "require": {
+        "micro/plugin-locator": "^1",
+        "league/oauth2-client": "^2"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Micro\\Plugin\\OAuth2\\Client\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Stanislau Komar",
+            "email": "[email protected]"
+        }
+    ]
+}

src/Configuration/OAuth2ClientPluginConfigurationInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the Micro framework package.
+ *
+ * (c) Stanislau Komar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\OAuth2\Client\Configuration;
+
+use Micro\Plugin\OAuth2\Client\Configuration\Provider\OAuth2ClientProviderConfigurationInterface;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+interface OAuth2ClientPluginConfigurationInterface
+{
+    /**
+     * @param string $providerName
+     *
+     * @return OAuth2ClientProviderConfigurationInterface
+     */
+    public function getProviderConfiguration(string $providerName): OAuth2ClientProviderConfigurationInterface;
+}

src/Configuration/Provider/OAuth2ClientProviderConfiguration.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the Micro framework package.
+ *
+ * (c) Stanislau Komar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\OAuth2\Client\Configuration\Provider;
+
+use Micro\Framework\Kernel\Configuration\PluginRoutingKeyConfiguration;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+class OAuth2ClientProviderConfiguration extends PluginRoutingKeyConfiguration implements OAuth2ClientProviderConfigurationInterface
+{
+    const CFG_TYPE                  = 'MICRO_OAUTH2_%s_TYPE';
+    const CFG_CLIENT_ID             = 'MICRO_OAUTH2_%s_CLIENT_ID';
+    const CFG_CLIENT_SECRET         = 'MICRO_OAUTH2_%s_CLIENT_SECRET';
+    const CFG_URL_AUTHORIZATION     = 'MICRO_OAUTH2_%s_CLIENT_URL_AUTHORIZATION';
+    const CFG_URL_REDIRECT          = 'MICRO_OAUTH2_%s_CLIENT_URL_REDIRECT';
+    const CFG_URL_RESOURCE_OWNER    = 'MICRO_OAUTH2_%s_CLIENT_URL_RESOURCE_OWNER';
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function getType(): string
+    {
+        return $this->get(self::CFG_TYPE);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function getClientId(): string
+    {
+        return $this->get(self::CFG_CLIENT_ID);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function getClientSecret(): string
+    {
+        return $this->get(self::CFG_CLIENT_SECRET);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getUrlRedirect(): string
+    {
+        return rtrim($this->get(self::CFG_URL_REDIRECT), '/');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getUrlAuthorization(): string
+    {
+        return  rtrim($this->get(self::CFG_URL_AUTHORIZATION), '/');
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getUrlResourceOwnerDetails(): string
+    {
+        return rtrim($this->get(self::CFG_URL_RESOURCE_OWNER), '/');
+    }
+}

src/Configuration/Provider/OAuth2ClientProviderConfigurationInterface.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the Micro framework package.
+ *
+ * (c) Stanislau Komar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\OAuth2\Client\Configuration\Provider;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+interface OAuth2ClientProviderConfigurationInterface
+{
+    /**
+     * @return string
+     */
+    public function getType(): string;
+
+    /**
+     * @return string
+     */
+    public function getClientId(): string;
+
+    /**
+     * @return string
+     */
+    public function getClientSecret(): string;
+
+    /**
+     * @return string
+     */
+    public function getUrlRedirect(): string;
+
+    /**
+     * @return string
+     */
+    public function getUrlAuthorization(): string;
+
+    /**
+     * @return string
+     */
+    public function getUrlResourceOwnerDetails(): string;
+}

src/Exception/ProviderAdapterNotRegisteredException.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the Micro framework package.
+ *
+ * (c) Stanislau Komar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\OAuth2\Client\Exception;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+class ProviderAdapterNotRegisteredException extends \RuntimeException
+{
+    /**
+     * @param string $providerType
+     * @param int|null $code
+     * @param \Throwable|null $throwable
+     */
+    public function __construct(string $providerType, \Throwable $throwable = null)
+    {
+        parent::__construct(
+            sprintf('OAuth2 provider "%s" is not registered.', $providerType),
+            0,
+            $throwable,
+        );
+    }
+}

src/Facade/Oauth2ClientFacade.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of the Micro framework package.
+ *
+ * (c) Stanislau Komar <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\OAuth2\Client\Facade;
+
+use League\OAuth2\Client\Provider\AbstractProvider;
+use Micro\Plugin\OAuth2\Client\Configuration\OAuth2ClientPluginConfigurationInterface;
+use Micro\Plugin\OAuth2\Client\Provider\Locator\ProviderPluginLocatorFactoryInterface;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+class Oauth2ClientFacade implements Oauth2ClientFacadeInterface
+{
+    /**
+     * @var array<string, AbstractProvider>
+     */
+    private array $providers = [];
+
+    /**
+     * @param ProviderPluginLocatorFactoryInterface         $providerPluginLocatorFactory
+     * @param OAuth2ClientPluginConfigurationInterface      $pluginConfiguration
+     */
+    public function __construct(
+        private readonly ProviderPluginLocatorFactoryInterface    $providerPluginLocatorFactory,
+        private readonly OAuth2ClientPluginConfigurationInterface $pluginConfiguration
+    )
+    {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getProvider(string $providerName): AbstractProvider
+    {
+        if(array_key_exists($providerName, $this->providers)) {
+            return $this->providers[$providerName];
+        }
+
+        $providerConfig = $this->pluginConfiguration->getProviderConfiguration($providerName);
+        $provider = $this->providerPluginLocatorFactory
+            ->create()
+            ->lookup($providerConfig->getType())
+            ->createProvider($providerName);
+
+        $this->providers[$providerName] = $provider;
+
+        return $provider;
+    }
+}