comman-group/comman_id_oauth2

COMMAN ID OAuth 2.0 Client Provider for The PHP League OAuth2-Client

v0.9.6 2022-04-18 15:27 UTC

Requires

• php: ^7.3 || ^8
• league/oauth2-client: ^2.6

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Naum Soloveychik

• authorization
• client
• oauth
• oauth2
• comman

README

This package provides COMMAN integration for OAuth2 Client by the League.

Installation

Configure repository in composer.json

"repositories": [{
    "type": "git",
    "url": "https://github.com/comman-group/comman_id_oauth2"
    }
]

Just execute:

composer require knpuniversity/oauth2-client-bundle
composer require comman-group/comman_id_oauth2

Usage

$provider = new \Comman\OAuth2\Client\Provider\CommanProvider([
    'clientId' => 'client_id',
    'clientSecret' => 'secret',
    'redirectUri' => 'https://example.org/oauth/endpoint',
]);

Example of knpu_oauth2_client.yaml

knpu_oauth2_client:
    clients:
        comman_oauth_client:
            type: generic
            provider_class: Comman\OAuth2\Client\Provider\CommanProvider
            client_id: '%env(OAUTH_COMMAN_ID)%'
            client_secret: '%env(OAUTH_COMMAN_SECRET)%'
            redirect_route: auth_comman_endpoint
            redirect_params: {}

Example of symfony controller

<?php

namespace App\Controller;

use KnpU\OAuth2ClientBundle\Client\ClientRegistry;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Core\Security;
use Symfony\Component\Security\Http\Util\TargetPathTrait;

/**
 * Авторизатор COMMAN ID
 *
 */
class SecurityCommanController extends AbstractController
{
    use TargetPathTrait;

    /**
     * Инициализация авторизации
     *
     * @Route("/auth/comman/login", name= "auth_comman_login")
     * @param ClientRegistry $clientRegistry
     * @return RedirectResponse
     */
    public function login(Request $request, ClientRegistry $clientRegistry)
    {
        $request->getSession()->remove(Security::AUTHENTICATION_ERROR);

        // if ($request->headers->get('referer')) {
        //     $referer = Request::create($request->headers->get('referer'));
        //     $this->saveTargetPath($request->getSession(), 'main', $referer->getRequestUri()); // Удаляем домен для пути возврата (в целях безопасности)
        // }

        return $clientRegistry
            ->getClient('comman_oauth_client') // Key from config/packages/knpu_oauth2_client.yaml
            ->redirect(
                [],  // Scopes (default: Provider::getDefaultScopes())
                []   // Extra options to pass to the "Provider" class
            )
        ;
    }

    /**
     * Вывод ошибки авторизации
     *
     * @Route("/auth/comman/error",  name= "auth_comman_error")
     */
    public function error(Request $request): Response
    {
        $error = $request->getSession()->get(Security::AUTHENTICATION_ERROR);

        if (!$error) {
            return $this->redirectToRoute('home');
        }

        return $this->render('bundles/TwigBundle/Exception/error403.html.twig', [
            'status_code' => 403,
            'status_text' => 'Авторизация отклонена! (' . $request->getSession()->get('_security.last_error')->getMessage() . ')' 
        ], new Response('', 403));
    }

    /**
     * After going to COMMAN ID, you're redirected back here
     * because this is the "redirect_route" you configured
     * in config/packages/knpu_oauth2_client.yaml
     * 
     * При правильной настройке мы не должны сюда попадать
     *
     * @Route("/auth/comman/endpoint", name="auth_comman_endpoint")
     */
    public function connectCheckAction(Request $request, ClientRegistry $clientRegistry)
    {
        $client = $clientRegistry->getClient('comman_oauth_client');


        try {
            // the exact class depends on which provider you're using
            $user = $client->fetchUser();

            // do something with all this new power!
	        // e.g. $name = $user->getFirstName();
            dd($user);
            // ...
        } catch (IdentityProviderException $e) {
            // something went wrong!
            // probably you should return the reason to the user
            var_dump($e->getMessage()); die;
        }
    }
}