k.watanabe技術者ブログ

k.watanabe

管理画面の作成とマルチ認証について

はじめに

記事を登録するための管理画面を作成しました。マルチ認証についての内容もまとめてみました。


参考記事：Laravel9でマルチ認証（一般ユーザーと管理者で別々のログイン機能）を実装する

マルチ認証とは

例えばECサイトでは商品や顧客情報などを管理する管理画面の他に、ユーザーでも認証機能が備わっているケースがあります。

この場合は管理画面のログインとユーザーのログインで二つの認証機能が備わっていることになります。その仕組みを実現しようとすると、ユーザーはusersテーブル、管理者はadminsテーブルに登録して管理する方法が考えられます。

このように、テーブルをそれぞれに分けてログイン機能を複数設けることがマルチ認証です。

手順１：　管理画面を作るのに必要なファイルを作成

このコマンドだけでModelとControllerとmigrationファイルを一度に作成出来ます。


  1. php artisan make:model Admin -mcr

手順2：　マイグレーションファイルを編集する

管理者を登録するAdminテーブルを作成するためにマイグレーションファイルを以下のように編集します。もちろん必要に応じてカラムを追加します。


database/migrations/2023_07_18_165316_create_admins_table.php

  1. <?php
  3. use Illuminate\Database\Migrations\Migration;
  4. use Illuminate\Database\Schema\Blueprint;
  5. use Illuminate\Support\Facades\Schema;
  7. return new class extends Migration
  8. {
  9.     /**
  10.      * Run the migrations.
  11.      */
  12.     public function up(): void
  13.     {
  14.         Schema::create('admins', function (Blueprint $table) {
  15.             $table->id();
  16.             $table->string('email')->unique();
  17.             $table->string('password');
  18.             $table->rememberToken();
  19.             $table->timestamps();
  20.         });
  21.     }
  23.     /**
  24.      * Reverse the migrations.
  25.      */
  26.     public function down(): void
  27.     {
  28.         Schema::dropIfExists('admins');
  29.     }
  30. };

手順３　モデルクラスの作成

マイグレーションを実行し、Adminモデルクラスを作成する


  1. $ php artisan migrate

ちなみにローカル環境ならロールバッグした上でマイグレーションしたい場合はこのコマンドで出来ます。

  1. php artisan migrate:refresh --seed

手順４　モデルクラスを認証用に編集する

認証するためにAuthenticatableクラスを継承する。デフォルトではクラス名のextendsの箇所がModelとなっているので、ModelをAuthenticatableに変える。useすることも忘れずに。


app/Models/Admin.php

  1. <?php
  3. namespace App\Models;
  5. use Illuminate\Database\Eloquent\Factories\HasFactory;
  6. use Illuminate\Database\Eloquent\Model;
  7. use Illuminate\Foundation\Auth\User as Authenticatable;
  8. use Laravel\Sanctum\HasApiTokens;
  9. use Illuminate\Notifications\Notifiable;
  11. class Admin extends Authenticatable
  12. {
  13.     use HasApiTokens, HasFactory, Notifiable;
  14.     
  15.     protected $fillable = [
  16.         'email',
  17.         'password',
  18.         'url'
  19.       ];
  21.     protected $hidden = [
  22.     'password',
  23.     'remember_token',
  24.     ];
  26.     protected $casts = [
  27.         'email_verified_at' => 'datetime',
  28.       ];
  29.       
  30. }

この一文を追加する。

  1. use Illuminate\Foundation\Auth\User as Authenticatable;

編集前：　デフォルトの状態

  1. class Admin extends Model
  2. {

編集後　ModelをAuthenticatableに変更

  1. class Admin extends Authenticatable
  2. {

手順５　ログインページの作成

マルチ認証を実装するために管理者用とユーザー用の二つのログインページを用意します。簡素なので、後でAdminLTEやBreezeなどでデザインも工夫しようと思います。

管理画面ログイン ユーザーログイン

ルーティングはこのように管理者はadmin、ユーザーはauthでファイルを分けています。

route/admin.php

  1. Route::prefix('admin')->group(function () {
  2.     Route::get('login', [LoginController::class, 'index'])->name('admin.login.index');
  3.     Route::post('login', [LoginController::class, 'login'])->name('admin.login.login');

route/auth.php

  1. Route::middleware('guest')->group(function () {
  3.     Route::get('login', [AuthenticatedSessionController::class, 'create'])
  4.                 ->name('login');
  6.     Route::post('login', [AuthenticatedSessionController::class, 'store']);

手順６　コンフィグファイルの「ガード」と「プロバイダ」の設定

マルチ認証するために、コンフィグでガードを設定します。ここがマルチ認証で重要な部分になります。


config/auth.php

  1. 'providers' => [
  2.         'users' => [
  3.             'driver' => 'eloquent',
  4.             'model' => App\Models\User::class,
  5.         ],
  6.         'admins' => [
  7.             'driver' => 'eloquent',
  8.             'model' => App\Models\Admin::class,
  9.         ],
  11.         'members' => [
  12.             'driver' => 'eloquent',
  13.             'model' => App\Models\User::class,
  14.         ],
  15.     ],

adminsのkeyの場合は、Adminモデルを使って認証し、membersの場合はUserモデルを使って認証させるようにしています。

  1. 'guards' => [
  2.         'web' => [
  3.             'driver' => 'session',
  4.             'provider' => 'users',
  5.         ],
  6.         'members' => [
  7.             'driver' => 'session',
  8.             'provider' => 'users',
  9.         ],
  10.         'admins' => [
  11.             'driver' => 'session',
  12.             'provider' => 'admins',
  13.         ],
  14.     ],

guardsは後述しますが、認証するために使うkeyとなります。ここでproviderがadminの場合は上述したadminモデルを使って認証するという意味です。

手順７　コントローラー側で認証を制御する

コントローラー側で管理者とユーザーでそれぞれ認証をチェックする処理を記述します。


Controllers/Admin/LoginController.php

  1. //ログイン処理
  2.   public function login(Request $request)
  3.   {
  4.     $credentials = $request->only(['email', 'password']);
  5.    
  6.     //ユーザー情報が見つかったらログイン
  7.     if (Auth::guard('admins')->attempt($credentials)) {
  8.       //ログイン後に表示するページにリダイレクト
  9.       return redirect()->route('admin.dashboard')->with([
  10.         'login_msg' => 'ログインしました。',
  11.       ]);
  12.     }
  14.     //ログインできなかったときに元のページに戻る
  15.     return back()->withErrors([
  16.       'login' => ['ログインに失敗しました'],
  17.     ]);
  18.   }

7行目のguardの記述でログインページで入力したメールアドレスとパスワードがAdminモデルを介してテーブルに登録されているかどうかをチェックしています。

ユーザーの場合も先ほどconfigに定義したmembersをguardで指定すれば、Userモデルに対して認証のチェックを行えます。

Controllers/Auth/AuthenticatedSessionController.php

  1.  public function index(Request $request)
  2.     {
  3.         if (Auth::guard('members')->attempt($request->only(['email', 'password']))) {
  4.             return redirect()->route('user.dashboard')->with([
  5.                 'login_msg' => 'ログインしました。',
  6.             ]);
  7.         }
  8.         //ログインできなかったときに元のページに戻る
  9.         return back()->withErrors([
  10.             'login' => ['ログインに失敗しました'],
  11.         ]);
  12.     }

ユーザーの場合はmembers、管理者の認証の場合はadminsを指定するだけですね。このやり方を応用すれば他のモデルクラスでも認証チェックが出来るようになります。そういった使い方がマルチ認証です。

  1. if (Auth::guard('members')->attempt($credentials)) {
  1. if (Auth::guard('admins')->attempt($credentials)) {
 記事一覧に戻る

プロフィールに戻る