Download the PHP package dmstr/yii2-oauth-module without Composer
On this page you can find all versions of the php package dmstr/yii2-oauth-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dmstr/yii2-oauth-module
More information about dmstr/yii2-oauth-module
Files in dmstr/yii2-oauth-module
Package yii2-oauth-module
Short Description Yii2 OAuth2 Module
License BSD-3-Clause
Homepage https://www.dmstr.io/
Informations about the package yii2-oauth-module
Yii OAuth Module
The package provides a module for Yii 2.0 that allows you to use OAuth 2.0 authentication. It is based on the league/oauth2-client package.
Features
- [x] Client credentials grant
- [x] Admin module to manage clients
- [x] User id attribute for clients
- [x] Access token encryption
- [x] Access token issuer
- [x] Access token in JWT format
Installation
The preferred way to install this extension is through composer.
Setup
Add the module to your web application configuration:
And this to your console application configuration:
or run
General usage
First you need to generate a public and private key pair. You can use the following command to generate a key pair:
If you want to provide a passphrase for your private key run this command instead:
When you have installed the module,
Then you need to create a client. You can reach the admin client crud via <your-base-url>/oauth/admin/client/index
.
You have the option to add a user id to the client. This will allow you to use the client to log in as this user after authentication. If you don't
add a user id, the client will be able to access the api, but not log in. The user id is added to the access token in the sub
claim.
To get a new access token, you can send a post request the following endpoint:
This will return all required information to authenticate your requests.
You can now use the access token to authenticate your requests.
Example usage with Yii 2.0 REST API
This example shows how to use the access token to authenticate your requests in a Yii 2.0 REST API. It uses the bizley/yii2-jwt package to authenticate the requests.
All versions of yii2-oauth-module with dependencies
dmstr/yii2-bootstrap Version ^0.2.2
dmstr/yii2-web Version ^1.1
guzzlehttp/psr7 Version ^2.7
league/oauth2-server Version ^8.4
yiisoft/yii2 Version ^2.0