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


関連記事

RubyのHanamiチュートリアルをやってみた

1 はじめに2 紹介2.1 Hanamiとは?2.2 Hanamiを選ぶ理由2.2.1 軽量2.2.2 アーキテクチャとして2.2.3 スレッドセーフ3 チュートリアルのための準備4 実践4.1 はじ ...

GraphQL

いまさら学ぶGraphQL〜概要編〜

1 はじめに2 GraphQLとは?2.1 なぜGraphQLは誕生した?2.1.1 過剰な取得2.1.2 過少な取得2.1.3 エンドポイントの管理3 GraphQLのメリットとデメリット3.1 G ...

laravel logo

Laravelのブラウザテスト「Dusk」をシンプルなCRUDで始めてみよう

1 はじめに2 Laravel Duskのセットアップ3 新規登録のテスト3.1 テスト対象となるコード3.2 Duskのテストコード3.3 テストの実行4 更新のテスト4.1 テスト対象となるコード ...

rails

Rails5で出力される「alias_method_chain is deprecated.」について

1 はじめに2 alias_method_chainとは3 Module#prependとは4 とりあえず、DEPRECATION WARNINGの出力をなくしたい5 さいごに はじめに 直近のプロジ ...

rails

deviseを使ってユーザ登録フォームを作る

1 はじめに1.1 前提条件2 deviseについて2.1 deviseとは2.2 deviseでできること3 登録処理の実装3.1 Gemのインストール3.2 deviseのインストール3.3 デフ ...

フォロー

blog-page_side_responsive

2020年10月
 123
45678910
11121314151617
18192021222324
25262728293031

アプリ情報

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