CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

2019/04/14

CakePHP3 CakeDC/Usersで所有レコードのみ閲覧、更新、削除する権限設定方法

CakePHP3のユーザ管理プラグイン「CakeDC/Users」を使用して権限管理をする際の前提条件

　
この記事では、下記を実装するための解説です。

CakePHP3で、ユーザ管理プラグイン「CakeDC/Users」を使用してユーザ管理をするシステムを構築している。
その中で、ユーザAが登録した情報は、ユーザAが所有者として登録され、その登録情報はユーザAのみが見ることができ、更新、削除も所有者 Aのみが行える。

という機能を実装することを想定しています。
　
まず、CakePHP3にユーザ管理プラグイン「CakeDC/Users」を導入する方法については、下記の記事を参考にしてください。
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
　
また、「/config/users.php」「/config/permissions.php」ファイルを作成し、ログイン認証に関連する設定を記述していく方法については、下記の記事を参考にしてください。
CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説
　
　
これを踏まえた上で、「/config/permissions.php」ファイルに、権限を設定していく方法を解説していきます。
　
　

「/config/permissions.php」ファイルのサンプル

　
「/config/permissions.php」ファイルに記述する権限設定のサンプルは以下のようになります。
　

<?php
use Cake\ORM\TableRegistry;
use   CakeDC\Auth\Rbac\Rules\Owner;

return [
    'Users.SimpleRbac.permissions' => [

        [
            'role' => ['user'],
            'plugin' => 'CakeDC/Users',
            'controller' => 'Users',
            'action' => ["profile","logout"],
        ],

        [
            'role' => ['user'],
            'controller' => ['Blogs'],
            'action' => ["edit","delete"],
            'allowed' => new Owner([
                'ownerForeignKey' => 'user_id',
            ]),
        ],
    ]
];

<?php

use Cake\ORM\TableRegistry;

use CakeDC\Auth\Rbac\Rules\Owner;

return [

'Users.SimpleRbac.permissions' => [

[

'role' => ['user'],

'plugin' => 'CakeDC/Users',

'controller' => 'Users',

'action' => ["profile","logout"],

[

'role' => ['user'],

'controller' => ['Blogs'],

'action' => ["edit","delete"],

'allowed' => new Owner([

'ownerForeignKey' => 'user_id',

]),

]

];

　
上記の前半は、ユーザ権限が「user」の場合、プラグインが「CakeDC/Users」で、コントローラーが「Users」の処理のうち、アクションが「profile」もしくは「logout」である場合はアクセスを許可する、という設定になっています。
　
指定する処理が複数ある場合は、「'action' => ["profile","logout"],」の様に配列で指定します。
「'role' => ['user'],」のように、指定するものが 1つしかない場合でも配列で指定することもできますので、全部配列で指定する、と覚えておいても問題はないでしょう。
　
　

ログアウトのアクションは必ず登録する

　
ちなみに、この権限設定をする場合は、何はともあれ下記のログアウトの処理だけは記述しておくようにしておきましょう。
これがないとログアウトできなくなります。
　

        [
            'role' => ['user'],
            'plugin' => 'CakeDC/Users',
            'controller' => 'Users',
            'action' => "logout",
        ],

[

'role' => ['user'],

'plugin' => 'CakeDC/Users',

'controller' => 'Users',

'action' => "logout",

「*」を使ってすべての処理を許可対象にすることもできる

　
また、下記のように、具体的な処理を指定するのではなく、「*」を指定することで、すべての処理を許可する、という指定方法もあります。
　

        [
            'role' => 'user',
            'prefix' => 'member',
            'extension' => '*',
            'plugin' => '*',
            'controller' => '*',
            'action' => "*",
        ],

[

'role' => 'user',

'prefix' => 'member',

'extension' => '*',

'plugin' => '*',

'controller' => '*',

'action' => "*",

　
上記は、会員用のコンテンツ「http://example.com/member/」をすべて利用を許可する、という指定になります。
　
　

「superuser」は設定しなくてもすべての機能にアクセスできる

　
下記の設定は、「『superuser』はすべての機能にアクセスできる」という設定ですが、これはわざわざ設定しなくても、『superuser』はすべての機能にアクセスできます。
　

        [
            'role' => 'superuser',
            'prefix' => '*',
            'extension' => '*',
            'plugin' => '*',
            'controller' => '*',
            'action' => "*",
        ],

[

'role' => 'superuser',

'prefix' => '*',

'extension' => '*',

'plugin' => '*',

'controller' => '*',

'action' => "*",

所有権限があるレコードのみ更新、削除ができる設定

　
最初のサンプルの後半部分の下記は、コントローラー「Blogs」で管理されるブログ記事を、アクション「edit（更新）」や「delete（削除）」できるのは、ログインしているユーザの「user_id」が、テーブル「blogs」にある「user_id」の値と同じ時のみ処理を許可する、という設定になります。
　

        [
            'role' => ['user'],
            'controller' => ['Blogs'],
            'action' => ["edit","delete"],
            'allowed' => new Owner([
                'ownerForeignKey' => 'user_id',
            ]),
        ],

[

'role' => ['user'],

'controller' => ['Blogs'],

'action' => ["edit","delete"],

'allowed' => new Owner([

'ownerForeignKey' => 'user_id',

]),

　
ちなみに、この設定を行っても、「superuser」権限があるユーザは、他のユーザのレコードも更新、削除することができます。
（「superuser」のユーザが更新しても、テーブル「blogs」にある「user_id」の情報は更新されません。）
　
　

所有権限があるレコードのみ更新、削除ができる設定・別テーブルに IDを持っている場合

　
上記は、レコードの所有者の情報が保存されているカラム「user_id」が、更新するレコードと同じテーブル内にある場合の設定ですが、所有者情報を管理しているテーブルが別のテーブル「BlogsUsers」にある場合は、以下のように設定します。
　

        [
            'role' => ['user'],
            'controller' => ['Blogs'],
            'action' => ["edit","delete"],
            'allowed' => new Owner([
                'table'           => 'BlogsUsers',
                'id'              => 'post_id',
                'ownerForeignKey' => 'user_id',
            ]),
        ],

[

'role' => ['user'],

'controller' => ['Blogs'],

'action' => ["edit","delete"],

'allowed' => new Owner([

'table' => 'BlogsUsers',

'id' => 'post_id',

'ownerForeignKey' => 'user_id',

]),

- CakePHP 3.x 4.x 5.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP 2.3　連携先のテーブルの項目で条件抽出する場合

アソシエーション（連携）している先のテーブルの項目で条件抽出する際の考え方と注意点をサンプルソースを用いて説明しています。

: CakePHP4のCakeDC/Usersのログイン時のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製UsersプラグインのCakePHP4版の紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因

Bakeして自動生成した入力フォーム処理を元に少し処理を追加したら、入力エラーがあってもエラーメッセージが表示されなくなった。原因はリダイレクトの処理にあった。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。