Download the PHP package alegz/yii2-oauth2-server without Composer

yii2-oauth2-server

A wrapper for implementing an OAuth2 Server(https://github.com/bshaffer/oauth2-server-php)

Important

This is fork of original (https://github.com/Filsh/yii2-oauth2-server) repo was also submited as a separate package but code namespaces are saved.

Reason for that is no update on original repo for a long time. Me and my friends have applied some usefull patches with fixes and improvements. Fixed branches mess. Latest stable version is now in master. Please see closed pull requests for more information what changes were made to master (https://github.com/Alegzander/yii2-oauth2-server/pulls?q=is%3Apr+is%3Aclosed)

Installation

The preferred way to install this extension is through composer.

Either run

or add

to the require section of your composer.json.

To use this extension, simply add the following code in your application configuration as a new module:

If you want to get Json Web Token (JWT) instead of convetional token, you will need to set 'useJwtToken' => true in module and then define two more configurations: 'public_key' => 'app\storage\PublicKeyStorage' which is the class that implements PublickKeyInterface and 'access_token' => 'app\storage\JwtAccessToken' which implements JwtAccessTokenInterface.php

• user model implementing an interface , so the oauth2 credentials data stored in user table For Oauth2 base library provides the default access_token which works great except that it tries to save the token in the database. So I decided to inherit from it and override the part that tries to save (token size is too big and crashes with VARCHAR(40) in the database.

TL;DR, here are the sample classes access_token

and public_key

NOTE: You will need this PR applied or you can patch it yourself by checking changes in this diff. The other part of PR is only if you want to use firebase JWT library (which is not mandatory anyway).

Also, extend - user model - implementing the interface , so the oauth2 credentials data stored in user table. You should implement:

• findIdentityByAccessToken()
• checkUserCredentials()
• getUserDetails()

You can extend the model if you prefer it (please, remember to update the config files) :

Additional OAuth2 Flags:

• Flag that switch that state controller should allow to use "state" param in the "Authorization Code" Grant Type

• Flag that switch that controller should allow the "implicit" grant type

The next step your shold run migration

this migration create the oauth2 database scheme and insert test user credentials for

add url rule to urlManager

Usage

To use this extension, simply add the behaviors for your base controller:

Create action authorize in site controller for Authorization Code

https://api.mysite.com/authorize?response_type=code&client_id=TestClient&redirect_uri=https://fake/

see more

Also if you set you can use Implicit Grant Type - see more

Request example:

https://api.mysite.com/authorize?response_type=token&client_id=TestClient&redirect_uri=https://fake/cb

With redirect response:

https://fake/cb#access_token=2YotnFZFEjr1zCsicMWpAA&state=xyz&token_type=bearer&expires_in=3600

If you want to get Json Web Token (JWT) instead of convetional token, you will need to set 'useJwtToken' => true in module and then define two more configurations: 'public_key' => 'app\storage\PublicKeyStorage' which is the class that implements PublickKeyInterface and 'access_token' => 'app\storage\JwtAccessToken' which implements JwtAccessTokenInterface.php

For Oauth2 base library provides the default access_token which works great except that it tries to save the token in the database. So I decided to inherit from it and override the part that tries to save (token size is too big and crashes with VARCHAR(40) in the database.

TL;DR, here are the sample classes access_token

and public_key

To get access token (js example):

To get access token (js example):

For more, see https://github.com/bshaffer/oauth2-server-php