BackEnd

【Laravel】認証を自作して学ぶguardとmiddleware

投稿日:

はじめに

Laravelでの独自の認証処理の実装を通して、認証関連のmiddlewareやguardについてまとめました。

認証処理の仕様

今回、実装する簡易な認証処理の仕様は、以下の通りです。APIでの使用を想定しています。

  • ヘッダーのAuthenticationに設定したBearerトークンの値が、予め決めた文字列と一致すること
  • ヘッダーのuuid設定した値が、予めDBに登録してあるユーザのUUIDと一致すること

独自の認証処理の実装

独自の認証処理では、以下の項目を実装します。順番に内容を見ていきます。

  • Model
  • UserProvider
  • Guard
  • Middleware
  • Handlerとその他の設定

Modelの実装

認証処理に使うモデルは Illuminate\Foundation\Auth\User を継承している必要があります。今回実装する認証処理の仕様では、 getAuthIdentifierName() のみ実装すれば十分です。

UserProviderの実装

UserProvider では、ユーザーの識別方法を実装します。今回実装する認証処理の仕様では、リクエストヘッダーに毎回 UUID を含めるので、 retrieveById($identifier) のみ使用します。

Guardの実装

Guard では、認証に直接関連する処理を実装します。今回実装する認証処理の仕様では、まず、 Bearerトークンが事前に決めた文字列と一致しているか確認し、一致していなければ、問答無用で認証エラーとしたいので、まずそれを確認します。その後、uuidヘッダーの値でユーザーを識別します。

checkAccessToken() の中で、 Bearerトークンの値と、 .env に設定した値が一致するか、確認しています。

ユーザーの識別は、 user() の中で行っており、uuid ヘッダーの値と一致するユーザーを、 UserProvider 経由で取得しています。

なお、 check()guest()user() などは Authファサードからアクセスできます。

Middlewareの実装

認証エラーになった場合、そのままではリダイレクトされてしまうので、JSONを返却できるように、 Middleware で制御します。

authenticate(array $guards) のループの中で guard を一つずつチェックし、認証でたら、 shouldUse($guard) で、その guard を AuthManager$defaultProvider にセットし、$userProvider にユーザーの解決方法をクロージャの形式でセットします。

Handlerの編集

認証エラーになった場合、そのままではリダイレクトされてしまうので、 JSON を返却するように修正します。

各種設定

auth.php に指定するために、AuthServiceProvider.php で、作成した guard を登録します。

作成した Middleware を kernel.php に定義します。

auth.php で、作成した認証処理を使用するように設定します。

作成した認証処理を使う

作成した認証処理を使うには、 api.php 内で以下のように記述します。

さいごに

APIの認証には、 jwt-auth など、すでに様々なライブラリが用意されているので、独自の認証処理を実装することは少ないかもしれません。ただ、今回のように簡易な認証で良い場合は、 Laravel では簡単に実装することができます。

おすすめ書籍

速習 Laravel 6 速習シリーズ確かな力が身につくPHP「超」入門 (Informatics & IDEA)

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

rails

RailsでAjax処理で画面を更新する

1 はじめに2 View(遷移元)の設定3 Controllerの実装4 View(遷移先)の実装5 参考6 さいごに はじめに RailsでAjax処理で画面を更新する方法を簡単に紹介します。 Vi ...

rails

Shrineを使って画像をアップロードする

1 はじめに2 Shrineとは2.1 簡単な説明2.2 作者2.3 特徴3 下準備3.1 Gemを追加3.2 初期設定3.3 テーブルを作成する4 実装4.1 Uploaderの実装4.2 Mode ...

laravel logo

Laravelの開発環境構築

1 はじめに2 開発環境構築2.1 Homestead2.2 Laradock3 Laradockで開発環境構築3.1 Laradockのダウンロード3.2 コンテナの設定ファイルを作成3.3 コンテ ...

laravel logo

コードでわかるLaravelのブラウザ認証

1 はじめに1.1 認証機能の概要2 Controller3 SessionGuard3.1 fireAttemptEvent3.2 retrieveByCredentials3.3 hasValid ...

rails

ShrineでS3に画像をアップロードする

1 はじめに1.1 前提条件1.2 関連記事2 AWS側の準備2.1 S3バケットを作成する2.2 CORSを設定する2.3 アクセス用のユーザを作成する3 Rails側の設定3.1 Initiali ...

フォロー

follow us in feedly

blog-page_side_responsive

2020年10月
 123
45678910
11121314151617
18192021222324
25262728293031

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。
Get it on App Store
Get it on Google Play