[Laravel] Custom guard and auth provider

前言

如果要客製自己的 auth gard 用來處理驗證與登入
首先可以從官網的 Authentication 中找到!
但是寫的有一點點不全面，在這邊重新整理一下。
如果是要用 jwt 登入這種，則可以直接參考官網即可！

大致需要
  1. 自己定義的 Auth Guard
  2. 自己定義的 User Provider (後面解釋)
  3. 用來驗證的 model

建立用來驗證的 model

<?php

namespace App\Models\Member;

use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Foundation\Auth\User as Authenticatable;

class Member extends Authenticatable
{
    use SoftDeletes;

    protected $table = 'members';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
        'cell_phone', 'verified', 'status',
        'facebook_id', 'line_id',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password',
    ];

    protected $dates = [
        'deleted_at',
    ];
}

在這邊我主要是先建立一個 Member.php 的 model
這裡有些地方要注意，Member 這個 model 必須繼承 Authenticatable
才可以符合 Laravel 的規則，因為後面會使用注入 Authenticatable 的方式。

建立 UserProvier

什麼時候會需要自己建立 UserProvider 呢?
假設今天使用的是 mongo db, 已經不是一般常用的 Relational DB
這時候就會需要建立一個客製化的 UserProvider
<?php

namespace App\Providers;

use App\Repositories\Member\MemberRepository;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Support\Facades\Hash;

class MemberServiceProvider implements UserProvider
{
    protected $memberRepo;

    public function __construct(MemberRepository $memberRepo)
    {
        $this->memberRepo = $memberRepo;
    }

    /**
     * Retrieve a user by their unique identifier.
     *
     * @param  mixed $identifier
     *
     * @return null|Authenticatable
     */
    public function retrieveById($identifier)
    {
        return $this->memberRepo->getById($identifier);
    }

    /**
     * Retrieve a user by by their unique identifier and "remember me" token.
     *
     * @param  mixed $identifier
     * @param  string $token
     *
     * @return null|Authenticatable
     */
    public function retrieveByToken($identifier, $token)
    {
        return null;
    }

    /**
     * Update the "remember me" token for the given user in storage.
     *
     * @param  string $token
     */
    public function updateRememberToken(Authenticatable $member, $token)
    {
    }

    /**
     * Retrieve a user by the given credentials.
     *
     * @param  array $credentials array for auth
     *
     * @return null|Authenticatable
     */
    public function retrieveByCredentials(array $credentials)
    {
        if (!empty($credentials['cell_phone'])) {
            $member = $this->memberRepo->getByCellPhone($credentials['cell_phone']);
        }
        if (!empty($credentials['email'])) {
            $member = $this->memberRepo->getByEmail($credentials['email']);
        }

        if (!$member) {
            return null;
        }

        return Hash::check(
            $credentials['password'],
            $member->password
        ) ? $member : null;
    }

    public function validateCredentials(Authenticatable $user, array $credentials)
    {
        // 驗證 email 與 password
        if (isset($credentials['email'], $credentials['password'])) {
            return strtolower($user->email) === strtolower($credentials['email'])
            && Hash::check($credentials['password'], $user->password);
        }

        // 驗證手機與 password
        if (isset($credentials['cell_phone'], $credentials['password'])) {
            return $user->cell_phone === trim($credentials['cell_phone'])
            && Hash::check($credentials['password'], $user->password);
        }

        return false;
    }
}
UserProvider 有點像是用來取得用戶身份的一個媒介
所以像我上面的範例，MemberServiceProvider 必須實作 UserProvider 這個 interface
我這裡是利用客製化的 Auth Guard (此處我命名為 MemberAuthGuard) 去呼叫 MemberServiceProvider，
來驗證前端傳遞過來的資訊是否正確，從而驗證用戶。
(MemberService - 呼叫 -> MemberAuthGuard - 呼叫 -> MemberServiceProvider)

建立 Auth Guard

<?php

namespace App\Services\Auth;

use App\Providers\MemberServiceProvider;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Guard;

class MemberAuthGuard implements Guard
{
    /**
     * Undocumented variable.
     *
     * @var Illuminate\Contracts\Auth\UserProvider
     */
    protected $provider;

    /**
     * member物件.
     *
     * @var Authenticatable
     */
    protected $member;

    public function __construct(MemberServiceProvider $provider)
    {
        $this->provider = $provider;
        $this->member = null;
    }

    /**
     * Determine if the current user is authenticated.
     *
     * @return bool
     */
    public function check()
    {
        return isset($this->member);
    }

    /**
     * Determine if the current user is a guest.
     *
     * @return bool
     */
    public function guest()
    {
        return !$this->check();
    }

    /**
     * Get the currently authenticated user.
     *
     * @return null|\Illuminate\Contracts\Auth\Authenticatable
     */
    public function user()
    {
        return $this->member;
    }

    /**
     * Get the ID for the currently authenticated user.
     *
     * @return null|int|string
     */
    public function id()
    {
        return $this->member ? $this->member->id : null;
    }

    /**
     * Validate a user's credentials.
     *
     * @return bool
     */
    public function validate(array $credentials = [])
    {
        $member = $this->provider->retrieveByCredentials($credentials);
        if (!$member) {
            return false;
        }

        $this->setUser($member);

        return true;
    }

    /**
     * Set the current user.
     */
    public function setUser(Authenticatable $member)
    {
        $this->member = $member;
    }
}
因為必須實作 Guard ，就大概上面的 function 要實作而已。


AuthServiceProvider 註冊自定義的 Provider 與 Auth Guard


<?php

namespace App\Providers;

use App\Repositories\Member\MemberRepository;
use App\Services\Auth\MemberAuthGuard;
use Illuminate\Auth\AuthManager;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Auth;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        // 'App\Model' => 'App\Policies\ModelPolicy',
    ];

    /**
     * Register any authentication / authorization services.
     */
    public function boot()
    {
        $this->registerPolicies();

        $memberRepo = $this->app->make(MemberRepository::class);
        // 自訂前端使用的驗證方式
        Auth::provider('frontend-auth-provider', function ($app, array $config) use ($memberRepo) {
            // Return an instance of Illuminate\Contracts\Auth\UserProvider...

            return new MemberServiceProvider($memberRepo);
        });

        // 定義 driver 的部分
        Auth::extend('frontend-auth', function ($app, $name, array $config) {

            return new MemberAuthGuard(Auth::createUserProvider($config['provider']));
        });

        $this->app->terminating(function () {
            $this->app->singleton('auth', function ($app) {
                $app['auth.loaded'] = true;

                return new AuthManager($app);
            });
        });
    }
}

在 Auth::provider('frontend-auth-provider') 這邊主要是註冊一個自定義的 User Provider


在 Auth::extend('frontend-auth') 是註冊 config/auth.php 裡面的 driver



接下來如果要使用自己定義的 auth guard，可以先去 config/auth.php 裡面

這樣就可以使用自己自定義的 Auth Guard 囉！

參考:
https://codershandbook.com/implementing-custom-auth-guard-in-laravel
https://laravel.com/docs/8.x/authentication#adding-custom-guards

留言

張貼留言

這個網誌中的熱門文章

[MySQL] schema 與資料類型優化

圖片
選擇優化的資料類型 原則: 越小越好 因為會佔用最小的磁碟、記憶體與CPU快取。 越簡單越好 操作整數比操作字串代價低，因為字串排序規則 ex: 儲存ip應該用 unsigned int - 4 bytes, 用 varchar 會用到 15 bytes 儲存時間應該用 mysql 內建的時間類型 DATETIME, TIMESTAMP可以儲存相同資料：時間日期，精確到秒 TIMESTAMP 只用 DATETIME 一半的儲存空間，根據時區自動變化 TIMESTAMP 允許的時間範圍比 DATETIME 小很多 避免 NULL 在 innodb 上有單獨的 bit 儲存 null 值，但在 myisam，但還是盡量避免 整數類型 tinyint - 8 bits smallint - 16 bits mediumint - 24 bits int - 32 bits bigint - 64 bits 如果是有正負數的，會因為 1 bits 會用來記錄正負，故範圍為 -2^(n-1) ~ 2^(n-1) unsigned 的範圍則是 -2^n ~ 2^n MySQL 可以為整數指定寬度，例如 INT(11)，其實沒什麼意義，11只是表示與 MySQL 相關工具(client 端的 cli) 用來顯示的長度，對於儲存與計算來說，INT(1)與INT(20)是一樣的。 實數類型 decimal(M,N) - M: 最大位數, N: 小數點後有幾位 ex: decimal(18, 9) => 9位數字.9位數字，總共使用 9 個 bytes float => 4 bytes double => 8 bytes decimal的計算雖然比較精確，但需要額外，但需要額外的空間與計算開銷，資料量較大時，可以用 bigint 代替 decimal，假設需要精準到萬分之一，則可以將數字*1百萬，將結果存在 bigint 內，可以同時避免福點數計算不精準與 decimal 計算代價太高。 字串類型 VARCHAR row_format=fix，這樣就都會固定長度，沒意義 varchar會需要額外1~2 bytes記錄長度, 假設用 latin1 charset, varchar(10) => 11 bytes, varchar(1000) => 1002...
閱讀完整內容

[Nginx] 使用轉址做負載平衡

Ref: http://blog.51cto.com/smileyouth/1623766 https://serverfault.com/questions/597671/load-balancing-in-nginx-with-redirect-rather-than-proxy https://stackoverflow.com/questions/46515842/nginx-proxy-pass-same-protocol-http-https 有個需求是這樣的 現在前端使用某一個 url, 假設是 http://example.com/test 然後希望前端載入這個網址的時候, 可以讓這個 url 隨機導向N個不同的網域, 假設是 a.example.com, b.example.com, c.example.com 但是後面路徑要是一樣的 也就是 http://example.com/test?t=1 -> http://c.example.com/test?t=1 這樣該怎麼做呢? 先假設 nginx 路徑是安裝在 /usr/local/nginx 先建立一個 /usr/local/nginx_module的目錄 安裝這個 module 要先下載另一個 ngx_devel_kit 先到  https://github.com/simplresty/ngx_devel_kit/tags 找個版本下載 cd ~ && wget https://github.com/simplresty/ngx_devel_kit/archive/v0.3.1rc1.tar.gz tar zxfv v0.3.1rc1.tar.gz #把解壓縮出來的目錄去掉版本號 mv ngx_devel_kit-0.3.1rc1 ngx_devel_kit && mv ngx_devel_kit /usr/local/nginx_module/ 然後接著下載  set-misc  這個 module 先到  https://github.com/openresty/set-misc-nginx-module/tags 找個版本下載 c...
閱讀完整內容