Skip to content

Latest commit

 

History

History
 
 

.docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

Contributte OAuth2Client

Setup

Install package

composer require contributte/oauth2-client

Supported flows

Take a look at integration for usage

Google

google:
	clientId: '...'
	clientSecret: '...'
	options:
		# optionally additional options passed to GoogleProvider

extensions:
	google: Contributte\OAuth2Client\DI\GoogleAuthExtension

Facebook

facebook:
	clientId: '...'
	clientSecret: '...'
	graphApiVersion: 'v14.0'
	options:
		 # optionally additional options passed to FacebookProvider

extensions:
	facebook: Contributte\OAuth2Client\DI\FacebookAuthExtension

Others

You could implement other providers which support auth code authentication by extending Contributte\OAuth2Client\Flow\AuthCodeFlow. Other authentication methods are currently not supported (PR is welcome).

List of all providers is here

Integration

This example uses Google as provider with integration through league/oauth2-google

Install package

composer require league/oauth2-google

Get your oauth2 credentials (clientId and clientSecret) from Google website

Register flow

google:
	clientId: '...'
	clientSecret: '...'
	options:
		# optionally additional options passed to GoogleProvider

extensions:
	google: Contributte\OAuth2Client\DI\GoogleAuthExtension

Create a control which can handle authentication and authorization

use Contributte\OAuth2Client\Flow\Google\GoogleAuthCodeFlow;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Provider\GoogleUser;
use Nette\Application\UI\Control;

class GoogleButton extends Control
{

	/** @var GoogleAuthCodeFlow */
	private $flow;

	public function __construct(GoogleAuthCodeFlow $flow)
	{
		parent::__construct();
		$this->flow = $flow;
	}

	public function authenticate(): void
	{
		$this->flow->getProvider()->setRedirectUri(
			$this->presenter->link('//:Sign:googleAuthorize')
		);
		$this->presenter->redirectUrl($this->flow->getAuthorizationUrl());
	}

	public function authorize(array $parameters): void
	{
		// Setup propel redirect URL
		$this->flow->getProvider()->setRedirectUri(
			$this->presenter->link('//:Sign:googleAuthorize')
		);

		try {
			$accessToken = $this->flow->getAccessToken($parameters);
		} catch (IdentityProviderException $e) {
			// TODO - Identity provider failure, cannot get information about user
		}

		/** @var GoogleUser $owner */
		$owner = $this->flow->getProvider()->getResourceOwner($accessToken);

		// TODO - try sign in user with it's email ($owner->getEmail())
	}

}

Add control to sign presenter

use Nette\Application\UI\Presenter;

class SignPresenter extends Presenter
{

	public function actionGoogleAuthenticate(): void
	{
		$this['googleButton']->authenticate();
	}

	public function actionGoogleAuthorize(): void
	{
		$this['googleButton']->authorize($this->getHttpRequest()->getQuery());
	}

	protected function createComponentGoogleButton(): GoogleButton
	{
		// TODO - create and return GoogleButton control
	}

}

Create link to authentication action

<a href="{plink :Front:Sign:googleAuthenticate}">Sign in with Google</a>

That's all!