Skip to content

Latest commit

 

History

History
363 lines (262 loc) · 14.8 KB

authorization.md

File metadata and controls

363 lines (262 loc) · 14.8 KB
Raw

授權

介紹

除了內建提供的認證服務外，Laravel 也提供了簡單的方式來組織認證邏輯和控制資源的存取。像是認證一般，Laravel 授權功能是採用簡單的兩種主要方式來授權行為：Gates 與 Policy

Gates 和 Policy 的關係像是路由和控制器。Gates 提供簡單且採用閉包的方式去授權，而 Policy 像是控制器，使用程式邏輯去區分它們特定的模型或資源。我們先來看看 Gates，然後再看看 Policy 。

在應用程式中，你不需要在 Gates 與 Policy 之間做選擇。大多應用程式極有可能同時使用 Gates 和 Policy，且這麼做還蠻推薦的！Gates 大部分應用在模型和資源無關的地方，比如瀏覽後台儀表板。相反的，Policy 的應用必須使用到特定的模型與資源。

Gates

撰寫 Gates

Gates 是用來確認是否受權指定的行為給使用者，通常在 App\Providers\AuthServiceProvider 的類別中使用 Gate facade 定義內容。Gates 的第一個參數主要接受使用者實例，並且可以接受額外的參數，像是 Eloquent 模型關聯：

/**
 * 註冊任何認證或授權的服務。
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Gate::define('update-post', function ($user, $post) {
        return $user->id == $post->user_id;
    });
}

Gates 也可以定義一個用 Class@method 風格的回呼字串，像是使用控制器那樣：

/**
 * 註冊任何認證或授權的服務。
 *
 * @return void
 */
public function boot()
{
    $this->registerPolicies();

    Gate::define('update-post', 'PostPolicy@update');
}

Gates 的 resource 方法

你也可以使用 resource 方法來一次定義多個 Gate 功能：

Gate::resource('posts', 'PostPolicy');

這個定義與下面手動去刻的定義相同：

Gate::define('posts.view', 'PostPolicy@view');
Gate::define('posts.create', 'PostPolicy@create');
Gate::define('posts.update', 'PostPolicy@update');
Gate::define('posts.delete', 'PostPolicy@delete');

預設會定義 view、create、update 和 delete 這些功能。你可以透過陣列作為第三個參數傳送到 resource 方法來複寫或增加預設功能。陣列的鍵定義功能名稱，而值定義方法名稱。例如，下列的程式碼將建立兩個新的 Gate 定義——posts.image 和 posts.photo：

Gate::resource('posts', 'PostPolicy', [
    'image' => 'updateImage',
    'photo' => 'updatePhoto',
]);

授權行為

使用 Gates 來授權行為，你應當使用 allows 或 denies 方法。請注意！你不需要再傳遞當前認證通過的使用者這些方法。Laravel 會自己注意通過 Gate 閉包的使用者：

if (Gate::allows('update-post', $post)) {
    // 目前使用者可以更新文章...
}

if (Gate::denies('update-post', $post)) {
    // 目前使用者不可以更新文章...
}

如果你需要確定是否有授權行為給使用者，你可以使用 Gate facade 的 forUser 方法：

if (Gate::forUser($user)->allows('update-post', $post)) {
    // 目前使用者可以更新文章...
}

if (Gate::forUser($user)->denies('update-post', $post)) {
    // 目前使用者不可以更新文章...
}

建立 Policy

產生 Policy

Policy 是組織特定模型或是資源的授權邏輯類別。舉例來說，如果你的應用程式是部落格，你可能會有一個 Post 模型和一個相對應的 PostPolicy 來授權使用者行為，像是建立新文章或是更新文章。

你可以使用 artisan 指令列的 make:policy 來產生一個 Policy。這個產生的 Policy 將會在 app/Policies 這個目錄。如果這個目錄不存在，Laravel 會幫你建立：

php artisan make:policy PostPolicy

make:policy 這個指令將會產生一個空的 Policy 類別。如果你需要產生一個具有基本「CRUD」的 Policy 方法在類別裡面，你可以在執行指令時，後面加入 --model 這個選項以及參數。

php artisan make:policy PostPolicy --model=Post

{tip} 全部的 Policy 都會透過 Laravel 服務容器來解析，可以讓你在建構子對任何需要的依賴使用型別提示，他們會被自動注入。

註冊 Policy

一旦 Policy 存在，它就需要被註冊。新的 Laravel 應用程式已內建一個 AuthServiceProvider提供者，且包含一個 policies 屬性，會映射你的 Eloquent 模型去比對它們的 Policy。註冊 Policy 將會告訴 Laravel 在授權行為存取特定模型的過程中應該使用哪一個 Policy：

<?php

namespace App\Providers;

use App\Post;
use App\Policies\PostPolicy;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        Post::class => PostPolicy::class,
    ];

    /**
     * 註冊任何認證或授權的服務。
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        //
    }
}

撰寫 Policy

Policy 方法

一旦 Policy 被註冊，你就可以為授權的每個動作新增方法。例如，讓我們在 PostPolicy 定義一個 update 方法，它會判斷給定的 User 是否可以更新一筆 Post。

update 方法會接收 User 和 Post 的實例作為參數，並應該回傳 true 或是 false 來表示使用者是否被授權更新給定的 Post。所以，在這個範例讓我們驗證使用者的 id 是否與 Post 的 user_id 匹配：

<?php

namespace App\Policies;

use App\User;
use App\Post;

class PostPolicy
{
    /**
     * 確認使用者是否有被授權可以更新這篇貼文。
     *
     * @param  \App\User  $user
     * @param  \App\Post  $post
     * @return bool
     */
    public function update(User $user, Post $post)
    {
        return $user->id === $post->user_id;
    }
}

你可以接著此 Policy 定義額外的方法，作為各種行為需要的授權。舉例來說，你可以定義 view 或 delete 方法來授權 Post 的其他行為。但請記得，你可以任意地給 Policy 方法取自己想要的名字。

{tip} 如果當你使用 Artisan 終端指令產生你的 Policy 時使用 --model 選項時，它會包含 view、create、update 和 delete 這些方法。

沒有模型的方法

一些 Policy 方法只有接收當前驗證的使用者，而不再接收他們授權的模型實例。這個情況很常發生在授權 create 行為的時候。例如，如果你正在建立一個部落格，你可能希望檢查是否有授權可以建立任何文章的權限給使用者。

當定義一個不需要接收模型實例的 Policy 方法時，比如 create 方法，它不用接收模型實例。相反的，你應該將該方法定義為只要認證的使用者就好：

/**
 * 確定給定的使用者是否可以建立文章。
 *
 * @param  \App\User  $user
 * @return bool
 */
public function create(User $user)
{
    //
}

Policy 篩選器

對於特定使用者，你可能希望授權 Policy 上的全部行為。要做到這一點，請在 Policy 上定義 before 方法。before 方法會優先執行於 Policy 上的其他方法，在 Policy 上的其他方法執行之前，讓你有辦法授權一些特定的權限。這個功能最常用在授權給後台管理員執行任何操作：

public function before($user, $ability)
{
    if ($user->isSuperAdmin()) {
        return true;
    }
}

如果你想拒絕使用者的所有授權，你應當再 before 方法回傳 false。如果回傳 null，則由 Policy 的其他方法判斷使用者授權情況。

{note} 如果類別不包含一個名稱與檢查功能名稱相匹配的方法，那麼就不會呼叫授權類別的 before 方法。

使用 Policy 的授權行為

透過使用者模型

Laravel 內建的 User 模型有包含兩個輔助方法來授權行為：can 和 cant。can 方法專門接收你想要授權的行為和模型關聯。例如：讓我們確定使用者使否有被授權更新給定的 Post 模型：

if ($user->can('update', $post)) {
    //
}

如果給定的模型的 Policy 已被註冊，can 方法將會自動呼叫適合的 Policy 並回傳布林值結果。如果沒有為模型註冊任何 Policy，can 方法將會嘗試呼叫基於閉包的 Gate 來匹配給定行為的名稱。

不需指定模型的操作

請記得，有些像是 create 的行為不需要指定模型實例。在這些情況下，你可以傳遞一個類別名稱給 can 方法。這個類別名稱將會用來確定授權時該用哪個 Policy：

use App\Post;

if ($user->can('create', Post::class)) {
    // 在相關 Policy 上執行 `create` 方法...
}

透過中介層

Laravel 包含一個可以在傳入請求到你的路由或控制器前就授權行為的中介層。預設的情況下，Illuminate\Auth\Middleware\Authorize 這個中介層被指定到 App\Http\Kernel 類別的 can 鍵上。讓我們來看一下使用 can 中介層來授權使用者更新部落格文章的例子：

use App\Post;

Route::put('/post/{post}', function (Post $post) {
    // 當前使用者可以更新貼文...
})->middleware('can:update,post');

在這個例子中，我們傳遞兩個參數給 can 中介層。第一個是我們希望授權的行為名稱，第二個是我們希望傳遞這個 Policy 方法的路由參數。在這個情況下，因為我們使用了隱式模型綁定，一個 Post 模型將會被傳遞給 Policy 方法。如果使用者沒有被授權給定的行為，這個中介層將回應 HTTP 403 的狀態碼。

不需指定模型的操作

再次提醒，有些像是 create 的行為不需要指定模型實例。在這些情況下，你可以傳遞一個類別名稱到中介層。這個類別名稱將會用來確定授權行為時應該用哪個 Policy。

Route::post('/post', function () {
    // 當前使用者可以建立新文章...
})->middleware('can:create,App\Post');

透過控制器的輔助函式

除了在 User 模型提供輔助方法外，Laravel 為所有繼承 App\Http\Controllers\Controller 的控制器提供了一個 authorize 輔助方法。像是 can 方法，這個方法接受你需要授權的行為名稱和模型關聯。如果這個行為沒被授權，authorize 方法會拋出 Illuminate\Auth\Access\AuthorizationException，Laravel 預設會使用例外處理器回應 HTTP 403 狀態碼：

<?php

namespace App\Http\Controllers;

use App\Post;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class PostController extends Controller
{
    /**
     * 更新給定的部落格文章。
     *
     * @param  Request  $request
     * @param  Post  $post
     * @return Response
     */
    public function update(Request $request, Post $post)
    {
        $this->authorize('update', $post);

        // 目前使用者可以更新部落格文章...
    }
}

不需要指定模型的操作

如前所述，有些像是 create 的行為不需要指定模型實例。在這種情況下，你可以傳遞類別名稱到 authorize 方法。這個類別名稱將會用來確定授權行為時應該用哪個 Policy：

/**
 * 建立一個新的部落格文。
 *
 * @param  Request  $request
 * @return Response
 */
public function create(Request $request)
{
    $this->authorize('create', Post::class);

    // 目前使用者可以建立部落格文章...
}

透過 Blade 模板

當在撰寫 Blade 模板時，你可能希望頁面的一部分只顯示給又被授權給定行為的使用者。舉例來說，你可能希望只讓權限的使用者可以看到部落格貼文的「編輯」按鈕。在這個情況，你可以使用 @can 和 @cannot 的模板指令：

@can('update', $post)
    <!-- 目前使用者可以更新這篇文章 -->
@elsecan('create', App\Post::class)
    <!-- 目前使用者可以建立新文章 -->
@endcan

@cannot('update', $post)
    <!-- 目前使用者不可以更新部落格文章 -->
@elsecannot('create', App\Post::class)
    <!-- 目前使用者不可以建立部落格新文章 -->
@endcannot

這些指令在撰寫 @if 和 @unless 語句的方便快捷方式。上面的 @can 和 @cannot 語句將分別轉換為以下語句：

@if (Auth::user()->can('update', $post))
    <!-- 目前使用者不可以更新文章 -->
@endif

@unless (Auth::user()->can('update', $post))
    <!-- 目前使用者不可以更新部落格文章 -->
@endunless

不需要指定模型的操作

像其他授權一樣，如果這個行為不能請求一個模型實例，你可以傳遞一個類別名稱到 @can 和 @cannot 指令：

@can('create', App\Post::class)
    <!-- 目前使用者可以建立新文章 -->
@endcan

@cannot('create', App\Post::class)
    <!-- 目前使用者不可以建立部落格新文章 -->
@endcannot