クイックスタート

インストール

CakePHP プロジェクトのルートディレクトリで Composer を使ってプラグインを追加します。

php composer.phar require "cakephp/authorization:^3.0"

Authorization 3.x は CakePHP 5 に対応しています。

src/Application.php でプラグインを読み込みます。

$this->addPlugin('Authorization');

はじめに

Authorization プラグインはミドルウェアとして組み込まれ、必要に応じて コンポーネントとしても利用できます。

use Authorization\AuthorizationService;
use Authorization\AuthorizationServiceInterface;
use Authorization\AuthorizationServiceProviderInterface;
use Authorization\Middleware\AuthorizationMiddleware;
use Authorization\Policy\OrmResolver;
use Psr\Http\Message\ServerRequestInterface;

Application に AuthorizationServiceProviderInterface を追加します。

class Application extends BaseApplication implements AuthorizationServiceProviderInterface

middleware() に Authorization を追加します。

public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
{
    $middlewareQueue->add(new ErrorHandlerMiddleware(Configure::read('Error')))
        ->add(new AssetMiddleware())
        ->add(new RoutingMiddleware($this))
        ->add(new BodyParserMiddleware())
        ->add(new AuthenticationMiddleware($this))
        ->add(new AuthorizationMiddleware($this));

    return $middlewareQueue;
}

AuthorizationMiddleware は AuthenticationMiddleware の後に置く必要が あります。

public function getAuthorizationService(ServerRequestInterface $request): AuthorizationServiceInterface
{
    $resolver = new OrmResolver();

    return new AuthorizationService($resolver);
}

これは ポリシーリゾルバー を構成するための基本設定です。

AppController で component を読み込みます。

public function initialize(): void
{
    parent::initialize();
    $this->loadComponent('Authorization.Authorization');
}

public function edit($id = null)
{
    $article = $this->Articles->get($id);
    $this->Authorization->authorize($article, 'update');
}

authorize() を使うことで、Policies によるアクセス制御を 適用できます。

より詳しく

• Policies
• ポリシーリゾルバー
• 認可ミドルウェア
• AuthorizationComponent
• 認可の確認
• リクエスト認証ミドルウェア