Laravel Jetstream 1.0 認証

イントロダクション

Laravel Jetstreamはログイン、2要素認証ログイン、ユーザー登録、パスワードリセット、メール確認ビューをプロジェクトへ自動的にスカフォールドします。簡単にするために、スタックの選択にかかわらずこれらのテンプレートはBladeで書かれており、JavaScriptフレームワークは使用していません。

Screenshot of Authentication

Laravel Fortify

内部的にJetstreamの認証部分は、認証バックエンドにとらわれないLaravelのフロントエンドであるLaravel Fortifyにより動作しています。

Jetstreamをインストールすると、同時にアプリケーションへconfig/fortify.phpファイルが用意されます。この認証ファイルの中で、使用する認証ガードや認証後にユーザーをどこへリダイレクトするかなど、Fortifyの動作の様々な側面をカスタマイズできます。

さらにプロフィール情報やパスワードの更新など、Fortifyの機能はすべて無効にできます。

ビュー

アプリケーションに選んだスタックにかかわらず、認証関連のビューはBladeテンプレートとしてresources/views/authディレクトリへ保存されます。アプリケーションの必要に合わせこれらのスタイルを自由にカスタマイズできます。

ビューレンダリングのカスタマイズ

どのように特定の認証ビューをレンダーするかをカスタマイズしたい場合もあります。全認証ビューのレンダーロジックはLaravel\Fortify\Fortifyクラスの適切なメソッドを修正することで可能です。通常、このメソッドはJetstreamServiceProviderbootメソッドで呼び出します。

use Laravel\Fortify\Fortify;

Fortify::loginView(function () {
    return view('auth.login');
});

Fortify::registerView(function () {
    return view('auth.register');
});

アクション

Jetstreamの典型的な機能として、登録/認証リクエストを満たすために実行するロジックはアプリケーションのアクションクラスに見ることができます。

具体的には、アプリケーションでユーザーが登録を更新すると、App\Actions\Fortify\CreateNewUserクラスが実行されます。このアクションは、入力の検証とユーザーの作成の責務を負います。

そのため、ロジックをカスタマイズしたければ、このクラスを変更します。アクションは受信リクエストの全入力を含む$input配列を引数に受け取ります。

パスワードバリデーションルール

App\Actions\Fortify\CreateNewUserApp\Actions\Fortify\ResetUserPasswordApp\Actions\Fortify\UpdateUserPasswordアクションは全部、App\Actions\Fortify\PasswordValidationRulesトレイトを使用しています。

お気づきになるでしょうが、App\Actions\Fortify\PasswordValidationRulesトレイトはLaravel\Fortify\Rules\Passwordバリデーションルールオブジェクトを使用しています。このオブジェクトによりアプリケーションに要求するパスワード要件を簡単にカスタマイズできます。デフォルトでは、最低8文字列長のパスワードを要求します。このパスワード要件をカスタマイズするため、以降のメソッドが使用できます。

(new Password)->length(10)

// 最低1文字の大文字が必要
(new Password)->requireUppercase()

// 最低一文字の数字が必要
(new Password)->requireNumeric()

// 最低一文字の特殊文字が必要
(new Password)->requireSpecialCharacter()

認証プロセスのカスタマイズ

User認証のカスタマイズ

場合により、ログイン情報をどのように認証するかとかユーザーの取得方法などの全般にわたりカスタマイズしたいこともあるでしょう。Fortify::authenticateUsingメソッドを使い簡単にできます。

このメソッドはクロージャを引数に取り、そのクロージャは受信HTTPリクエストを引数に取ります。クロージャはリクエスト中のログイン情報の検証と、該当するユーザーインスタンスを返す責務を担当します。認証情報が検証に失敗したり、該当ユーザーが見つからない場合は、クロージャからnullfalseを返します。通常、このメソッドはJetstreamServiceProviderbootメソッドで呼び出します。

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Laravel\Fortify\Fortify;

Fortify::authenticateUsing(function (Request $request) {
    $user = User::where('email', $request->email)->first();

    if ($user &&
        Hash::check($request->password, $user->password)) {
        return $user;
    }
})

認証パイプラインのカスタマイズ

Jetstreamは(Fortifyにより)、invokableなクラスのパイプラインを通してログインリクエストを認証します。必要であれば、ログインリクエストをパイプにより通す必要のあるクラスのカスタムパイプラインを定義できます。各クラスはミドルウェアのように、受信Illuminate\Http\Requestインスタンスと$next変数を引数に取る__invokeメソッドを持つ必要があります。

カスタムパイプラインを定義するには、Fortify::authenticateThroughメソッドを使用します。このメソッドはクロージャを受け取り、そのクロージャはログインリクエストをパイプで通すクラスの配列を返す必要があります。通常、このメソッドは、JetstreamServiceProviderbootメソッドで呼び出します。

use Laravel\Fortify\Actions\AttemptToAuthenticate;
use Laravel\Fortify\Actions\EnsureLoginIsNotThrottled;
use Laravel\Fortify\Actions\PrepareAuthenticatedSession;
use Laravel\Fortify\Actions\RedirectIfTwoFactorAuthenticatable;
use Laravel\Fortify\Fortify;
use Illuminate\Http\Request;

Fortify::authenticateThrough(function (Request $request) {
    return array_filter([
            config('fortify.limiters.login') ? null : EnsureLoginIsNotThrottled::class,
            RedirectIfTwoFactorAuthenticatable::class,
            AttemptToAuthenticate::class,
            PrepareAuthenticatedSession::class,
    ]);
});

メール確認

Laravel Jetstreamは新しく登録したユーザーのメールアドレスを確認したい要件をサポートしています。しかし、この機能のサポートはデフォルトで無効にしています。有効にするには、config/fortify.php設定ファイルのfeaturesアイテムのコメントを外してください。

'features' => [
    Features::registration(),
    Features::resetPasswords(),
    Features::emailVerification(),
    Features::updateProfileInformation(),
    Features::updatePasswords(),
    Features::twoFactorAuthentication(),
],

次に、App\Models\Userクラスが、MustVerifyEmailインターフェイスを実装していることを確認します。このインターフェイスはこのモデルに取り込んであります。

この2ステップを行えば、新しい登録ユーザーはメールアドレスの所有者であると証明することをすすめるメールを受け取るようになります。

ドキュメント章別ページ

スタック

ヘッダー項目移動

注目:アイコン:ページ内リンク設置(リンクがないヘッダーへの移動では、リンクがある以前のヘッダーのハッシュをURLへ付加します。

移動

クリックで即時移動します。

バージョン

設定

適用ボタンクリック後に、全項目まとめて適用されます。

カラーテーマ
和文指定 Pagination
和文指定 Scaffold
Largeスクリーン表示幅
インデント
本文フォント
コードフォント
フォント適用確認

フォントの指定フィールドから、フォーカスが外れると、当ブロックの内容に反映されます。EnglishのDisplayもPreviewしてください。

フォント設定時、表示に不具合が出た場合、当サイトのクッキーを削除してください。

バックスラッシュを含むインライン\Code\Blockの例です。

以下はコードブロックの例です。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * ユーザに関連する電話レコードを取得
     */
    public function phone()
    {
        return $this->hasOne('App\Phone');
    }
}

設定を保存する前に、表示が乱れないか必ず確認してください。CSSによるフォントファミリー指定の知識がない場合は、フォントを変更しないほうが良いでしょう。

キーボード・ショートカット

オープン操作

PDC

ページ(章)移動の左オフキャンバスオープン

HA

ヘッダー移動モーダルオープン

MS

移動/設定の右オフキャンバスオープン

ヘッダー移動

T

最初のヘッダーへ移動

E

最後のヘッダーへ移動

NJ

次ヘッダー(H2〜H4)へ移動

BK

前ヘッダー(H2〜H4)へ移動

その他

?

このヘルプページ表示
閉じる