mcpField
L
laravel-permission

laravel-permission

github.com/fusengineセキュリティ3462 回インストール2 週間前に更新
リポジトリ

laravel-permission について

Spatie Laravel Permissionでロール・権限ベースのアクセス制御を実装するLaravel開発者向けのリファレンススキルです。チーム単位の認可、ルートや画面の制御、API連携、テストを扱います。

主な機能

  1. 01ロール・権限ベースのRBAC設定
  2. 02ミドルウェアとBladeによるアクセス制御
  3. 03チーム範囲とワイルドカード権限
  4. 04Policy、APIガード、Sanctumとの連携
  5. 05キャッシュ、クエリスコープ、イベント監査
  6. 06カスタムモデルとテストパターン

活用シーン

  1. 01Laravelのルートをロールや権限で制限
  2. 02テナントチームごとのロールと権限管理
  3. 03APIやPolicyに権限チェックを追加
  4. 04権限変更のテストとキャッシュ管理

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/fusengine/agents --skill laravel-permission

インストール後、Claude Code で/laravel-permissionを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
api-usage.md
artisan-commands.md
blade-directives.md
cache.md
custom-models.md
direct-permissions.md
events.md
middleware.md
performance.md
policies.md
query-scopes.md
spatie-permission.md
super-admin.md
teams.md
references/templates/
ApiExceptionHandler.php.md
ApiPermissionSetup.php.md
ApiUserResource.php.md
BladeExamples.blade.md
CacheConfig.php.md
ControllerMiddleware.php.md
CustomPermission.php.md
CustomRole.php.md
DeployScript.sh.md
PermissionAudit.php.md
PermissionEventListener.php.md
PermissionSeeder.php.md
PermissionTest.php.md
PostPolicy.php.md
RoleSeeder.php.md
routes-example.md

詳細

Spatie Laravel Permission によるロールベースのアクセス制御を扱います。ロールと権限、ルートミドルウェア、Blade の認可ディレクティブ、マルチテナントのチームスコープ、ワイルドカード/階層型の権限、スーパー管理者によるバイパス、キャッシュ管理、直接権限とロール権限の継承、クエリスコープ、イベントベースの監査ログ、Policy との統合、Sanctum/Passport の API 利用、カスタムモデル(UUID サポート)、テストパターンを取り上げます。

Laravel Permission(Spatie)

エージェントのワークフロー(必須)

実装を始める前に、必ず 3 つのエージェントを並行して起動してください。それぞれ name を指定して Agent を 1 回呼び出します。

  1. fuse-ai-pilot:explore-codebase - 既存の認証パターンを確認する
  2. fuse-ai-pilot:research-expert - Context7 経由で Spatie Permission のドキュメントを確認する
  3. mcp__context7__query-docs - Laravel の認可パターンを確認する

実装後、検証のために fuse-ai-pilot:sniper を実行してください。


概要

Spatie Laravel Permission は、Laravel アプリケーション向けにロールベースのアクセス制御(RBAC)を包括的に提供します。

コンポーネント目的
ロール権限のグループ(admin、writer)
権限個別の操作権限(記事の編集)
ミドルウェアルートの保護
Blade ディレクティブUI の認可
チームマルチテナントのスコープ設定
ワイルドカード階層型の権限
スーパー管理者すべてのチェックをバイパス
イベント監査ログ(v6.15.0+)
クエリスコープロール/権限によるユーザーの絞り込み
API サポートSanctum/Passport との統合
ポリシーリソースベースの認可

重要なルール

  1. DatabaseSeeder でロール/権限をシードする
  2. 変更後にキャッシュをリセットする:php artisan permission:cache-reset
  3. 名前にはケバブケースを使用する:edit-articles
  4. コントローラーにロールチェックをハードコードしない - ミドルウェアを使用する
  5. マルチテナントアプリでは、リクエストの早い段階でチームコンテキストを設定する
  6. API ではガードを指定する - permission:edit,api
  7. テストでキャッシュをクリアする - setUp()/beforeEach() でリセットする

リファレンスガイド

基本概念
トピックリファレンス参照するタイミング
セットアップspatie-permission.mdインストール、モデルのセットアップ、基本メソッド
ミドルウェアmiddleware.mdルート保護のパターン
Bladeblade-directives.mdUI の認可ディレクティブ
直接権限とロール権限direct-permissions.md権限の継承
高度な機能
トピックリファレンス参照するタイミング
チームteams.mdマルチテナントの権限
ワイルドカードwildcard-permissions.md階層型のパターン
スーパー管理者super-admin.mdすべての権限をバイパス
カスタムモデルcustom-models.mdUUID、モデルの拡張
統合
トピックリファレンス参照するタイミング
API の利用api-usage.mdSanctum、ガード、JSON レスポンス
ポリシーpolicies.mdLaravel Policy との統合
クエリスコープquery-scopes.mdUser::role()、User::permission()
イベントevents.md監査ログ、通知
運用と品質
トピックリファレンス参照するタイミング
キャッシュcache.mdパフォーマンス、デバッグ
CLIartisan-commands.mdArtisan コマンド
テストtesting.mdテスト、ファクトリー、セットアップ
パフォーマンスperformance.md最適化、N+1、キャッシュ

テンプレート(コード例)
セットアップとシーディング
テンプレート目的
UserModel.php.mdHasRoles トレイトを使用するユーザーモデル
RoleSeeder.php.md基本的なロールのシーディング
PermissionSeeder.php.md権限を作成するシーダー
WildcardSeeder.php.md階層型権限
ルートとミドルウェア
テンプレート目的
routes-example.md保護されたルートの例
ControllerMiddleware.php.mdコントローラー内のミドルウェア
BladeExamples.blade.mdBlade ディレクティブの例
チームとマルチテナント
テンプレート目的
TeamMiddleware.php.mdマルチテナント用ミドルウェア
TeamSeeder.php.mdチームスコープのロール用シーダー
TeamModel.php.mdboot を含むチームモデル
スーパー管理者とキャッシュ
テンプレート目的
SuperAdminSetup.php.mdGate::before によるバイパス
CacheConfig.php.mdキャッシュ設定
DeployScript.sh.mdCI/CD のキャッシュ管理
API 連携
テンプレート目的
ApiPermissionSetup.php.mdAPI ガードと Sanctum
ApiExceptionHandler.php.mdJSON エラーレスポンス
ApiUserResource.php.md権限を含むユーザーリソース
ポリシーとイベント
テンプレート目的
PostPolicy.php.mdSpatie 連携を含むポリシー
PermissionEventListener.php.md監査イベントリスナー
UserQueryExamples.php.mdクエリスコープの例
PermissionAudit.php.md監査サービス
テスト
テンプレート目的
PermissionTest.php.mdPest と PHPUnit のテスト
UserFactory.php.md権限の状態を含むファクトリー
カスタムモデル
テンプレート目的
CustomRole.php.md拡張された Role モデル
CustomPermission.php.md拡張された Permission モデル
UUIDMigration.php.mdUUID テーブルのマイグレーション
SetupPermissions.php.mdカスタム artisan コマンド

クイックリファレンス

ロールの割り当て
$user->assignRole('admin');
権限の確認
$user->can('edit articles');
ミドルウェア(Web)
Route::middleware(['role:admin'])->group(fn () => ...);
ミドルウェア(API)
Route::middleware(['auth:sanctum', 'permission:edit,api'])->group(fn () => ...);
Blade
@role('admin') ... @endrole
@can('edit articles') ... @endcan
クエリスコープ
User::role('admin')->get();
User::permission('edit articles')->get();
チーム
setPermissionsTeamId($team->id);
ワイルドカード
$role->givePermissionTo('articles.*');
スーパー管理者
Gate::before(fn ($user, $ability) =>
    $user->hasRole('Super-Admin') ? true : null
);
テスト
beforeEach(fn () => app(PermissionRegistrar::class)->forgetCachedPermissions());

機能マトリックス

機能状態参照
基本的な RBAC✅spatie-permission.md
ミドルウェア✅middleware.md
Blade ディレクティブ✅blade-directives.md
マルチガード(web/api)✅middleware.md, api-usage.md
チーム(マルチテナント)✅teams.md
ワイルドカード権限✅wildcard-permissions.md
スーパー管理者✅super-admin.md
キャッシュ管理✅cache.md
直接権限とロール権限✅direct-permissions.md
Artisan コマンド✅artisan-commands.md
UUID サポート✅custom-models.md
カスタムモデル✅custom-models.md
イベント(v6.15.0+)✅events.md
クエリスコープ✅query-scopes.md
ポリシー統合✅policies.md
API / Sanctum✅api-usage.md
テスト✅testing.md
パフォーマンス✅performance.md

Laravel 13 に関する注意事項

Spatie Permission 8.x(現在のバージョンは 8.3。PHP 8.3 以降と Laravel 12/13 が必要)は Laravel 13 に対応しています。L13 との統合:

  • v6 → v7 → v8 へのアップグレード:イベントクラスには Event が付加され(RoleAttachedEvent…)、コマンドには Command が付加されます。clearClassPermissions() は削除され、findByName() / findOrCreate() は BackedEnum|string を受け付けます(v8)。events.md を参照してください。
  • キャッシュ:permission.cache.key キーは config/permission.php 内で明示的に (spatie.permission.cache) 設定されます → L13 でハイフン区切りのプレフィックスに変更されても影響を受けません。
  • コントローラー属性:#[Authorize](ポリシー)と #[Middleware('role:admin')](RBAC)を組み合わせます。名前空間は Illuminate\Routing\Attributes\Controllers です。[[laravel-blade]] を参照してください。
  • PHP 8.3:カスタムの Role/Permission DTO には final readonly class を使用します。
#[Middleware(['auth', 'role:admin|editor'])]
#[Authorize('update', 'post')]
public function update(UpdatePostRequest $request, Post $post) { /* ... */ }

ベストプラクティス

推奨事項
  • 真実の単一の情報源を定義します。同じアクションに対して Policy または Permission のどちらか一方を使い、両方は使いません。
  • 明確さのために permission:create-post(動詞-名詞)を使用します。
  • マルチテナンシーが実際に必要な場合にのみ teams を有効にします。
  • ユーザーごとに権限をキャッシュします(Cache::remember('user.permissions.'.$id, ...))。
  • スーパー管理者には Gate::before() を使用します(* ワイルドカード権限は使用しません)。
避けるべきこと
  • 権限をセッションに保存しないでください(Spatie のキャッシュを使用します)。
  • 一貫したアーキテクチャなしに hasRole() と hasPermissionTo() を併用しないでください。
  • ロール名をコードにハードコードしないでください(RoleEnum 列挙型を使用します)。
  • シーダーで assignRole() を実行した後に、キャッシュをフラッシュするのを忘れないでください。
  • スーパー管理者に * を付与しないでください(対象を絞った Gate::before() を優先します)。

コメント