README

用于实现OAuth2服务器（https://github.com/bshaffer/oauth2-server-php）的包装器

安装

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

运行以下命令之一

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

或

"dixonsatit/yii2-oauth2-server": "~2.0"

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

要使用最新功能（如JWT令牌），您需要使用 2.0.1 分支。编辑您的 compose.json 并添加

"dixonsatit/yii2-oauth2-server": "2.0.1.x-dev"

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

'bootstrap' => ['oauth2'],
'modules' => [
    'oauth2' => [
        'class' => 'dixonsatit\yii2\oauth2server\Module',
        'tokenParamName' => 'accessToken',
        'tokenAccessLifetime' => 3600 * 24,
        'storageMap' => [
            'user_credentials' => 'common\models\User',
        ],
        'grantTypes' => [
            'user_credentials' => [
                'class' => 'OAuth2\GrantType\UserCredentials',
            ],
            'refresh_token' => [
                'class' => 'OAuth2\GrantType\RefreshToken',
                'always_issue_new_refresh_token' => true
            ]
        ]
    ],

如果您想要获取Json Web Token (JWT) 而不是传统令牌，您需要在模块中设置 'useJwtToken' => true，然后定义两个更多配置：'public_key' => 'app\storage\PublicKeyStorage'，这是实现 PublickKeyInterface 的类，以及 'access_token' => 'app\storage\JwtAccessToken'，这是实现 JwtAccessTokenInterface.php 的类

OAuth2基本库提供的默认 access_token 工作得很好，除了它试图将令牌保存在数据库中。所以我决定从它继承并覆盖尝试保存的部分（令牌大小太大，在数据库中的 VARCHAR(40) 上崩溃。

TL;DR，以下是示例类 access_token

<?php

namespace app\storage;

/**
 *
 * @author Stefano Mtangoo <mwinjilisti at gmail dot com>
 */
class JwtAccessToken extends \OAuth2\Storage\JwtAccessToken
{  
    public function setAccessToken($oauth_token, $client_id, $user_id, $expires, $scope = null)
    {

    }

    public function unsetAccessToken($access_token)
    {

    }
}

和 public_key

<?php
namespace app\storage;

class PublicKeyStorage implements \OAuth2\Storage\PublicKeyInterface{


    private $pbk =  null;
    private $pvk =  null;

    public function __construct()
    {
        //files should be in same directory as this file
        //keys can be generated using OpenSSL tool with command:
        /*
          private key:
          openssl genrsa -out privkey.pem 2048

          public key:
          openssl rsa -in privkey.pem -pubout -out pubkey.pem
        */
        $this->pbk =  file_get_contents('privkey.pem', true);
        $this->pvk =  file_get_contents('pubkey.pem', true);
    }

    public function getPublicKey($client_id = null){
        return  $this->pbk;
    }

    public function getPrivateKey($client_id = null){
        return  $this->pvk;
    }

    public function getEncryptionAlgorithm($client_id = null){
        return 'HS256';
    }

}

注意：您需要应用 此 PR 或通过检查 此差异 来自行修补它。PR的其余部分仅适用于您想使用Firebase JWT库的情况（但这不是强制性的）。

此外，扩展 common\models\User - 用户模型 - 实现接口 \OAuth2\Storage\UserCredentialsInterface，以便将oauth2凭证数据存储在用户表中。您应该实现

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

如果您愿意，可以扩展模型（请记住更新配置文件）

use Yii;

class User extends common\models\User implements \OAuth2\Storage\UserCredentialsInterface
{

    /**
     * Implemented for Oauth2 Interface
     */
    public static function findIdentityByAccessToken($token, $type = null)
    {
        /** @var \filsh\yii2\oauth2server\Module $module */
        $module = Yii::$app->getModule('oauth2');
        $token = $module->getServer()->getResourceController()->getToken();
        return !empty($token['user_id'])
                    ? static::findIdentity($token['user_id'])
                    : null;
    }

    /**
     * Implemented for Oauth2 Interface
     */
    public function checkUserCredentials($username, $password)
    {
        $user = static::findByUsername($username);
        if (empty($user)) {
            return false;
        }
        return $user->validatePassword($password);
    }

    /**
     * Implemented for Oauth2 Interface
     */
    public function getUserDetails($username)
    {
        $user = static::findByUsername($username);
        return ['user_id' => $user->getId()];
    }
}

额外的OAuth2标志

enforceState - 开关标志，使状态控制器允许在 "Authorization Code" 授权类型中使用 "state" 参数

allowImplicit - 开关标志，使控制器允许使用 "implicit" 授权类型

下一步，您应该运行迁移

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

此迁移创建oauth2数据库模式并插入测试用户凭证 testclient:testpass，用于 http://fake/

添加到urlManager的url规则

'urlManager' => [
    'enablePrettyUrl' => true, //only if you want to use petty URLs
    'rules' => [
        'POST oauth2/<action:\w+>' => 'oauth2/rest/<action>',
        ...
    ]
]

用法

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

use yii\helpers\ArrayHelper;
use yii\filters\auth\HttpBearerAuth;
use yii\filters\auth\QueryParamAuth;
use dixonsatit\yii2\oauth2server\filters\ErrorToExceptionFilter;
use dixonsatit\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()
            ],
        ]);
    }
}

在站点控制器中创建用于授权代码的action authorize

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

更多内容

/**
 * SiteController
 */
class SiteController extends Controller
{
    /**
     * @return mixed
     */
    public function actionAuthorize()
    {
        if (Yii::$app->getUser()->getIsGuest())
            return $this->redirect('login');

        /** @var $module \dixonsatit\yii2\oauth2server\Module */
        $module = Yii::$app->getModule('oauth2');
        $response = $module->handleAuthorizeRequest(!Yii::$app->getUser()->getIsGuest(), Yii::$app->getUser()->getId());

        /** @var object $response \OAuth2\Response */
        Yii::$app->getResponse()->format = \yii\web\Response::FORMAT_JSON;

        return $response->getParameters();
    }
}

如果您设置 allowImplicit => true，则可以使用隐式授权类型 - 更多内容

请求示例

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

带有重定向响应

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

JWT令牌（仅2.0.1分支使用）

如果您想使用Json Web Token (JWT) 而不是传统的令牌，您需要在模块中设置 'useJwtToken' => true，然后定义另外两个配置：'public_key' => 'app\storage\PublicKeyStorage'，这是一个实现 PublicKeyInterface 接口的类，以及 'access_token' => 'OAuth2\Storage\JwtAccessToken'，这是一个实现 JwtAccessTokenInterface.php 接口的类。

OAuth2基础库提供了默认的 access_token，它工作得非常好。只需使用它，一切都会顺利。

和 public_key

<?php
namespace app\storage;

class PublicKeyStorage implements \OAuth2\Storage\PublicKeyInterface{


    private $pbk =  null;
    private $pvk =  null;

    public function __construct()
    {
        $this->pvk =  file_get_contents('privkey.pem', true);
        $this->pbk =  file_get_contents('pubkey.pem', true);
    }

    public function getPublicKey($client_id = null){
        return  $this->pbk;
    }

    public function getPrivateKey($client_id = null){
        return  $this->pvk;
    }

    public function getEncryptionAlgorithm($client_id = null){
        return 'RS256';
    }

}

更多详情请查看 https://github.com/bshaffer/oauth2-server-php