README

此仓库是从 (https://github.com/Filsh/yii2-oauth2-server) 的 v2.0 分支检查出来的

yii2-oauth2-server 的说明

OAuth2 服务器的一个封装（https://github.com/bshaffer/oauth2-server-php）

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一

php composer.phar require --prefer-dist filsh/yii2-oauth2-server "*"

或者

"filsh/yii2-oauth2-server": "*"

将其添加到你的 composer.json 文件的 require 部分。

要使用此扩展，只需在应用程序配置中添加以下代码

'oauth2' => [
    'class' => 'cncap\yii2\oauth2server\Module',
    'options' => [
        'token_param_name' => 'accessToken',
        'access_lifetime' => 3600 * 24
    ],
    'storageMap' => [
        'user_credentials' => 'common\models\User'
    ],
    '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
        ]
    ],
]

common\models\User - 实现接口 \OAuth2\Storage\UserCredentialsInterface 的用户模型，因此 OAuth2 凭证数据存储在用户表中

下一步，你需要运行迁移

yii migrate --migrationPath=@vendor/filsh/yii2-oauth2-server/migrations

此迁移创建 OAuth2 数据库模式和插入测试用户凭证 testclient:testpass 为 http://fake/

向 urlManager 添加 URL 规则

'urlManager' => [
    'rules' => [
        'POST oauth2/<action:\w+>' => 'oauth2/default/<action>',
        ...
    ]
]

用法

要使用此扩展，只需为你的基本控制器添加行为

use yii\helpers\ArrayHelper;
use yii\filters\auth\HttpBearerAuth;
use yii\filters\auth\QueryParamAuth;
use cncap\yii2\oauth2server\filters\ErrorToExceptionFilter;
use cncap\yii2\oauth2server\filters\auth\CompositeAuth;

class Controller extends \yii\rest\Controller
{
    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return ArrayHelper::merge(parent::behaviors(), [
            'authenticator' => [
                'class' => CompositeAuth::className(),
                'authMethods' => [
                    ['class' => HttpBearerAuth::className()],
                    ['class' => QueryParamAuth::className(), 'tokenParam' => 'accessToken'],
                ]
            ],
            'exceptionFilter' => [
                'class' => ErrorToExceptionFilter::className()
            ],
        ]);
    }
}

更多信息请见 https://github.com/bshaffer/oauth2-server-php