Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zacksleo/yii2-oauth2
yii2 oauth2 module
https://github.com/zacksleo/yii2-oauth2
oauth2-server yii2 yii2-extension yii2-oauth2 yii2-oauth2-server
Last synced: 9 days ago
JSON representation
yii2 oauth2 module
- Host: GitHub
- URL: https://github.com/zacksleo/yii2-oauth2
- Owner: zacksleo
- License: mit
- Created: 2018-01-18T08:15:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-28T10:33:50.000Z (about 6 years ago)
- Last Synced: 2024-11-13T14:55:09.463Z (about 1 month ago)
- Topics: oauth2-server, yii2, yii2-extension, yii2-oauth2, yii2-oauth2-server
- Language: PHP
- Size: 67.4 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# yii2-oauth2
yii2 oauth2 module based on [yii2-oauth2-server](https://github.com/Filsh/yii2-oauth2-server)
[](https://packagist.org/packages/zacksleo/yii2-oauth2)
[](https://packagist.org/packages/zacksleo/yii2-oauth2)
[](https://packagist.org/packages/zacksleo/yii2-oauth2)
[](https://styleci.io/repos/117953253)
[]()
[](https://travis-ci.org/zacksleo/yii2-oauth2)
[](https://scrutinizer-ci.com/zacksleo/yii2-oauth2/?branch=master)
[](https://scrutinizer-ci.com/g/zacksleo/yii2-oauth2/?branch=master)
[](https://scrutinizer-ci.com/g/zacksleo/yii2-oauth2/build-status/master)
## Install
```
composer install zacksleo/yii2-oauth2
```
## Migration Database
```
./yii migrate --migrationPath=@vendor/zacksleo/yii2-oauth2/migrations
```
## Config module
### for API or frontend
```php
'modules' => [
'oauth2' => [
'class' => 'filsh\yii2\oauth2server\Module',
/* Fix Yii2 2.0.13+ Incompatible Issue
* @see https://github.com/Filsh/yii2-oauth2-server/issues/132
*/
'components' => [
'request' => function () {
return \filsh\yii2\oauth2server\Request::createFromGlobals();
},
'response' => [
'class' => \filsh\yii2\oauth2server\Response::class,
],
],
'tokenParamName' => 'access_token',
'tokenAccessLifetime' => 3600 * 24 * 7,
'storageMap' => [
'user_credentials' => 'common\models\User',
'access_token' => 'zacksleo\yii2\oauth2\common\models\storage\AccessToken',
],
'grantTypes' => [
'client_credentials' => [
'class' => 'OAuth2\GrantType\ClientCredentials',
'allow_public_clients' => false
],
'user_credentials' => [
'class' => 'OAuth2\GrantType\UserCredentials',
],
'refresh_token' => [
'class' => 'OAuth2\GrantType\RefreshToken',
'always_issue_new_refresh_token' => true,
],
'authorization_code' => [
'class' => 'OAuth2\GrantType\AuthorizationCode',
'require_exact_redirect_uri' => false,
]
]
]
]
```
### for backend
```php
'modules' => [
'oauth2' => [
'class' => 'zacksleo\yii2\oauth2\backend\Module',
]
]
```
## Token Controller
```php
getClient()->getToken($token);
if (empty($oauthAccessToken)) {
throw new yii\web\UnauthorizedHttpException('Unauthorized');
}
$model = static::findOne(['union_id' => $oauthAccessToken['union_id']]);
return $model;
}
/**
* Implemented for Oauth2 Interface
* @param $username
* @param $password
* @return bool
* @throws HttpException
*/
public function checkUserCredentials($username, $password)
{
}
/**
* Implemented for Oauth2 Interface
* @param $username
* @return array
*/
public function getUserDetails($username)
{
}
/**
* @inheritdoc
*/
public function getId()
{
return $this->getPrimaryKey();
}
public function getUnionId()
{
return $this->union_id;
}
}
```