Download the PHP package filsh/yii2-oauth2-server without Composer
On this page you can find all versions of the php package filsh/yii2-oauth2-server. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package yii2-oauth2-server
yii2-oauth2-server
A wrapper for implementing an OAuth2 Server(https://github.com/bshaffer/oauth2-server-php)
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:
- user model implementing an interface , so the oauth2 credentials data stored in user table
The next step you should run migration
this migration creates the oauth2 database scheme and insert test user credentials for
add url rule to urlManager
Configuration
You can pass additional OAuth2 Server options by setting options
property on the module. These options configure as the underlying OAuth2 Server also as various parts/components of bshaffer/oauth2-server-php.
As an example, you can configure authorization code lifetime in a response by setting auth_code_lifetime
option.
Some of them are implemented as standalone properties on the module: tokenParamName
=> use_jwt_access_tokens
, tokenAccessLifetime
=> token_param_name
, useJwtToken
=> access_lifetime
.
Full list of options are supported by the underlying OAuth2 Server main component - source code. Options for various components spread across bshaffer/oauth2-server-php source code.
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/
Also, if you set in the property of the module, 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
JWT Tokens
If you want to get Json Web Token (JWT) instead of conventional 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' => 'OAuth2\Storage\JwtAccessToken'
which implements JwtAccessTokenInterface.php
For Oauth2 base library provides the default access_token which works great except. Just use it and everything will be fine.
and public_key
For more, see https://github.com/bshaffer/oauth2-server-php
Authors & Contributors
The original author of this package Igor Maliy . At the time the project maintainer is Vardan Pogosian.