バックエンドのスタンダード：Laravel入門

■第５話：認証システムの構築

（最終更新日：2024.06.16）

「ログイン機能を実装しよう」

第5回では、Laravelを使用して認証システムを構築する方法について学ぶ。 認証システムは、ユーザー登録、ログイン機能、パスワードリセット、認証と認可のカスタマイズを含み、 アプリケーションのセキュリティとユーザー管理の基盤となる。 特に、Laravel Breezeを利用した基本的な設定から始め、ユーザーが自分のアカウントを管理できるようにするための機能を実装する。 これにより、アプリケーションの安全性とユーザーエクスペリエンスを向上させることができる。

１.認証の基本設定

Laravelは、認証システムの構築を簡単にするためのビルトイン機能を有する。 これを利用することで、ユーザー登録、ログイン、ログアウトなどの機能を短時間で実装できる。

１.１ 認証の導入
Laravelには認証機能が標準で組み込まれており、 Laravel JetstreamやLaravel Breezeといったパッケージを利用することで、非常に簡単に認証機能を追加できる。 ここでは、Laravel Breezeを使用した認証システムの設定方法を説明する。

Laravel Breezeのインストール
下記2つのコマンドを順に実行することで、認証機能に必要なファイルやルートが自動的に生成される。

フロントエンドのセットアップ
次に、フロントエンドの依存関係をインストールし、ビルドする。 これは下記２つのコマンドを順に実行する。

マイグレーションの実行
認証システムにはデータベーステーブルが必要だ。 「php artisan migrate」を実行して、マイグレーションを実行する。 これで準備が整った。

１.２ 認証ルートとコントローラー
Breezeのインストールにより、認証に関するルートとコントローラーが自動的に設定される。 各ルートの役割は以下の通りだ。これらのルーティングはroutes/web.phpで定義されている。

各ルートの役割

１.３ ビューとテンプレート
Breezeは、認証に必要なビューも生成する。 これらのビューは resources/views/auth ディレクトリに配置される。 そして、Bladeテンプレートエンジンを使用して構築される。

ビューに対応するページ

１.４ ユーザーモデル
Laravelのユーザーモデルは、デフォルトで App\Models\User クラスに定義されている。 このモデルは、認証機能をサポートするために必要な設定が既に含まれている。

１.５ ミドルウェア
認証システムには、ユーザーがログインしているかどうかを確認するためのミドルウェアが含まれている。 authミドルウェアは、ログインしていないユーザーをログインページにリダイレクトさせる。

これらの基本設定により、Laravelでの認証システムの構築がスムーズに行うことができる。

２.ユーザー登録とログイン

先にも説明したように、Laravelは認証システムの構築を簡単にするために、ビルトインの認証機能を提供している。 ここでは、Laravel Breezeを使用してユーザー登録とログイン機能を実装する方法を説明する。

２.１ ルーティング
Breezeのインストールにより、以下のような認証に関連するルートが自動的に設定される。 これらは routes/web.php に定義されている。

２.２ コントローラー
Breezeは、ユーザー登録(App\Http\Controllers\
Auth\RegisteredUserController)とログイン (App\Http\Controllers\Auth\
AuthenticatedSessionController)に必要なコントローラーも自動生成する。

２.３ ビュー
Breezeは認証用のビューも生成する。これらのビューは resources/views/authディレクトリに配置される。 ユーザー登録ビュー
(resources/views/auth/register.blade.php)と ログインビュー
(resources/views/auth/login.blade.php)が作られる。

第1項で説明したインストールコマンドを実行するだけで、Laravelはこのようなプログラムが自動的に作成、配置される。 これにより、あとは設定を行うだけで、Laravelでユーザー登録とログイン機能を簡単に構築することができる。

３.パスワードリセット機能

ユーザーがパスワードを忘れた場合に、パスワードをリセットできるようにするための機能について解説する。 Laravelは、パスワードリセット機能を簡単に実装できるように、、ビルトインのサポートを提供している。 まずは、１項で説明したようにLaravel Breezeをインストールし、セットアップする。

３.１ ルーティング
前項のログイン機能に加えて、パスワードリセットに必要なルーティングも作成される。 これは、routes/web.php に定義されている。

３.２ コントローラー
パスワードリセットに必要なコントローラーも自動生成される。
App\Http\Controllers\Auth\
PasswordResetLinkControllerがそれにあたる。

加えて、新しいパスワードを設定するためのコントローラーも生成される。
App\Http\Controllers\Auth\
NewPasswordControllerになる。

３.３ ビュー
パスワードリセットに必要なビューも生成する。 これらのビューは resources/views/auth ディレクトリに配置される。 下記はリセットをリクエストするViewになる。

下記はパスワードリセットを実行する際のViewになる。

３.４ メールテンプレート
パスワードリセットリンクを送信するためのメールテンプレートは、
resources/views/emails/
password-reset.blade.php に配置されている。

これらの設定を行うことで、Laravelでパスワードリセット機能を簡単に構築することができる。 ユーザーはパスワードを忘れた場合に、リセットリンクをメールで受け取り、新しいパスワードを設定できるようになる。

４.認証と認可のカスタマイズ

認証システムの構築の「認証と認可のカスタマイズ」では、Laravelのデフォルトの認証および認可機能をカスタマイズする方法を説明する。 これにより、アプリケーション固有の要件に合わせて認証と認可を調整できる。 Laravelでは、認証と認可を簡単にカスタマイズするためのフレームワークが提供されている。

４.１ 認証ガードのカスタマイズ
認証のカスタマイズには、認証ガード、ユーザーモデル、認証コントローラーのカスタマイズが含まれる。 Laravelでは、config/auth.php ファイルを使用して認証ガードを設定できる。 ガードは、ユーザーの認証方法を定義する。 この設定により、APIリクエストに対してトークン認証を使用するようにカスタマイズできる。 下記のhashをfalseにすることで、APIトークンをプレーンテキストのまま簡便に使う方法にしている。

４.２ ユーザーモデルのカスタマイズ
ユーザーモデル (App\Models\User) は、認証に関連する属性やメソッドを定義する場所だ。 カスタム属性やメソッドを追加することで、認証プロセスを拡張できる。 パスワードやトークンをAPIレスポンスに表示させることを防いだり、email_verified_atをdatetime型にしたりしている。

４.３ 認証コントローラーのカスタマイズ
認証プロセスの一部をカスタマイズするために、認証コントローラーを拡張できる。 例えば、ユーザーのログイン後に特定のアクションを実行したり、カスタムバリデーションを追加できる。

４.４ 認可のポリシーのカスタマイズ
認可のカスタマイズには、ポリシー、ゲート、ミドルウェアのカスタマイズが含まれる。 ポリシーは、特定のモデルに対する認可ロジックを定義するクラスだ。 コマンドでポリシーを生成し、それを編集することでカスタム認可ロジックを追加できる。

４.５ ゲートのカスタマイズ
ゲートは、シンプルな認可ロジックを定義するための方法だ。AuthServiceProvider にゲートを定義する。

４.６ ミドルウェアのカスタマイズ
認可ミドルウェアをカスタマイズすることで、特定の条件を満たすユーザーのみが特定のルートにアクセスできる。

このミドルウェアをルートに適用する。

これらの一連のカスタマイズにより、Laravelの認証と認可を柔軟に調整し、 アプリケーションの要件に合ったセキュリティを提供することができる。

５.まとめ

第5回では、Laravelを使用して認証システムを構築する方法を学んだ。 Laravel Breezeを用いてユーザー登録、ログイン、パスワードリセット機能を実装し、認証と認可をカスタマイズした。 具体的には、認証ガードの設定、ユーザーモデルのカスタマイズ、認証コントローラーの拡張、ポリシーやゲートの設定、 ミドルウェアの使用方法を詳しく解説する。これにより、アプリケーションのセキュリティとユーザー管理を強化することができる。

▼参考図書、サイト

 「改定2版 速習Laravel」　山田祥寛　WINGSプロジェクト
 「1週間で基礎から学ぶLaravel入門」　Minatomi