Udemy 12. サーバーサイドのログイン認証 #04
2020年10月01日に公開

【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成

今回達成すること

JWT(以下、トークン)を検証し、正しければ発行主のユーザーを返すAuthenticatorモジュールを作成します。

モジュールで作成したメソッドは、Railsコントローラーのbefore_actionで読み込みます。

これにより、ログインユーザーしかアクセスできないコントローラーアクションを作成することができます。

モジュールファイルを作成する

モジュールファイルは、前回作成した「services/user_auth」ディレクトリ内に作成します。

authenticator.rbを作成しましょう。

root $ touch api/app/services/user_auth/authenticator.rb

UserAuthを継承したモジュールを作成する

Authenticatorモジュールを宣言します。

api/app/services/user_auth/authenticator.rb
module UserAuth
  module Authenticator
  end
end

これで、UserAuth::Authenticatorで呼び出すことができます。

トークンを取得するメソッドの作成

トークンを取得するメソッドを作成します。

トークンの取得は2パターンあって

  • リクエストのヘッダーから取得するパターンと
  • クッキーに保存したトークンを取得するパターンがあります。

リクエストヘッダーから取得するメソッド

リクエストのヘッダーから取得するメソッドは、主に一時的に発行したトークンを取得する際に使用します。

一時的に発行するトークンを使用する場面は、

  • 会員登録時のメールアドレス認証時
  • パスワードリセット時
  • メールアドレス変更時

などです。

Railsのrequestメソッドを使って、token_from_request_headersprivate内に作成します。

api/app/services/user_auth/authenticator.rb
module UserAuth
  module Authenticator

    # 以下、追加
    private

      # リクエストヘッダーからトークンを取得する
      def token_from_request_headers
        request.headers["Authorization"]&.split&.last
      end
  end
end

  • &(ぼっち演算子) … レシーバがnilの場合に、エラーを発生させずnilを返す。

    レシーバとは、メソッドの働きかけるオブジェクトのことで、ここではrequest.headers["Authorization"]を指します。

    参考 【Rails・Ruby】 オブジェクト指向 - Qiita

Nuxt.jsからのリクエストヘッダーにトークンを埋め込む場合は、axios(アクシオス)をこのように記述します。

(参考コード)plugins/axios.js
export default ({ $axios }) => {
  $axios.onRequest((config) => {
    config.headers.common.Authorization = `Bearer ${<accessToken>}`
  })
}

クッキーに保存したトークンを取得するメソッド

クッキーに保存したトークンはログイン判定に使用します。

Railsのcookiesメソッドを使ってtokenを作成します。

api/app/services/user_auth/authenticator.rb
      ...
      # リクエストヘッダーからトークンを取得する
      def token_from_request_headers
        request.headers["Authorization"]&.split&.last
      end

      # 以下、追加

      # クッキーのオブジェクトキー(config/initializers/user_auth.rb)
      def token_access_key
        UserAuth.token_access_key
      end

      # トークンの取得(リクエストヘッダー優先)
      def token
        token_from_request_headers || cookies[token_access_key]
      end
  end
end
  • token … メールアドレスの変更時は、

    • リクエストヘッダーのトークンと

    • クッキートークンの

      双方が存在することになるため、リクエストヘッダーを優先して取得するよう実装しています。

Rails APIモードでクッキーを扱う

RailsのAPIモードのデフォルトでは、クッキーを扱うことができません。

そこでクッキーを扱うモジュールを、application_controller.rbでインクルードします。

api/app/controllers/application_controller.rb
class ApplicationController < ActionController::API
  # 追加
  include ActionController::Cookies
end

これでcookiesメソッドが使用できるようになりました。

トークンからユーザーを取得するメソッド

トークンからユーザーを取得するfetch_entity_from_tokenメソッドを追加します。

ユーザーが存在しない場合や、無効なトークンのデコードエラーは全てnilを返すようにしています。

api/app/services/user_auth/authenticator.rb
      ...
      # トークンの取得(リクエストヘッダー優先)
      def token
        token_from_request_headers || cookies[token_access_key]
      end

      # 以下、追加

      # トークンからユーザーを取得する
      def fetch_entity_from_token
        AuthToken.new(token: token).entity_for_user
      rescue ActiveRecord::RecordNotFound, JWT::DecodeError, JWT::EncodeError
        nil
      end
  end
end

AuthTokenクラスにメソッドを追加する

auth_token.rbで宣言した、AuthTokenクラスにentity_for_userメソッドを追加します。

entity_for_userは、payloadのsubクレームからユーザーを検索します。

api/app/services/user_auth/auth_token.rb
        ...
        @token = JWT.encode(@payload, secret_key, algorithm, header_fields)
      end
    end

    # 追加
    # subjectからユーザーを検索する
    def entity_for_user
      User.find @payload["sub"]
    end

    private
    ...

現在のユーザーを返すメソッド

authenticator.rbに、現在のユーザーを返すcurrent_userメソッドを追加します。

api/app/services/user_auth/authenticator.rb
      ...
      # トークンからユーザーを取得する
      def fetch_entity_from_token
        AuthToken.new(token: token).entity_for_user
      rescue ActiveRecord::RecordNotFound, JWT::DecodeError, JWT::EncodeError
        nil
      end

     # 以下、追加

      # トークンのユーザーを返す
      def current_user
        return if token.blank?
        @_current_user ||= fetch_entity_from_token
      end
  end
end
  • @_ … インスタンス変数の書き方。

    メモとして記憶するためだけに使用するインスタンス変数の書き方です。

    必須のルールではありませんが、メモ用のインスタンス変数と言う意味を明示的にしています。

    参考 Use an Underscore When Memoizing in Ruby - Adarsh Pandit

  • ||= … 左の値が存在しない場合、右を代入する。

    インスタンス変数の値がある場合はその値を返し、無ければメソッドを実行します。

    この書き方はローカルキャッシュと言い、無駄なメソッドの実行を防ぎます。

    参考 Rubyの@_って何?? - Qiita

認証失敗時のメソッド

認証が失敗した時は、401エラーを返し、同時にクッキーを削除します。

クッキーを削除するメソッドは、後に作成するログインコントローラー内で使用するので、アクティブメソッドとします。

api/app/services/user_auth/authenticator.rb
module UserAuth
  module Authenticator

    # 追加
    # クッキーを削除する
    def delete_cookie
      return if cookies[token_access_key].blank?
      cookies.delete(token_access_key)
    end

    private
    ...

includeするとプライベートメソッドでもコントローラーから呼び出すことができますが、コントローラー内で使用するメソッドを明確にするために、アクティブメソッドとしています。

認証エラーを返すメソッドは、このモジュール内でしか使用しないのでプライベートメソッドで追加します。

api/app/services/user_auth/authenticator.rb
     ...
      # トークンのユーザーを返す
      def current_user
        return if token.blank?
        @_current_user ||= fetch_entity_from_token
      end

      # 以下、追加

      # 401エラーかつ、クッキーを削除する
      def unauthorized_user
        head(:unauthorized) && delete_cookie
      end
  end
end

current_userを返すメソッド

current_userが存在する場合はオブジェクトを返し、そうでない場合はエラーを返すauthenticate_userメソッドを作成します。

このメソッドは、各コントローラーのbfore_actionで使用します。

api/app/services/user_auth/authenticator.rb
module UserAuth
  module Authenticator

    # 先頭に追加

    # トークンからcurrent_userを検索し、存在しない場合は401を返す
    def authenticate_user
      current_user.presence || unauthorized_user
    end
    ...
  • presence(プレゼンス)precent?trueの場合に対象のオブジェクトを返す。

includeする

Authenticatorモジュールはこれで完成です。

このモジュールをコントローラーで使うためにapplication_controller.rbincludeします。

api/app/controllers/application_controller.rb
class ApplicationController < ActionController::API
  include ActionController::Cookies
  # 追加
  include UserAuth::Authenticator
end

コミットする

これで準備が整いました。

ここまでの変更をコミットしておきましょう。

root $ cd api
api $ git add -A && git commit -m "add_authenticator.rb"
api $ cd ..
root $

まとめ

今回はAuthenticatorモジュールを作成しました。

authenticate_userメソッドを各コントローラーのbefore_actionで読み込むことで、アクション直前にトークンを検証することができます。

さらに、トークンのユーザーを返すため、アクション内で現在のユーザー(current_user)を認識することがきます。

不正なトークンの場合は、401を返すため、非ログインユーザーの不正アクセスから守ることができるのです。

次回は?

さて、次回はユーザークラスでトークンの発行とデコードを簡単に行うために、新たなモジュールファイルを追加します。

どうぞお楽しみに!

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】アプリケーション仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. ログイン前のレイアウト構築 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. ログイン前のレイアウト構築 #02
Nuxt.js ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
10. ログイン前のレイアウト構築 #03
Nuxt.js ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
10. ログイン前のレイアウト構築 #04
Nuxt.js addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
10. ログイン前のレイアウト構築 #05
Nuxt.js ウェルカムページをレスポンシブデザインに対応させよう(4/4)
10. ログイン前のレイアウト構築 #06
Nuxt.js 会員登録ページのレイアウトファイルを作成しよう(1/4)
10. ログイン前のレイアウト構築 #07
Nuxt.js 名前、メール、パスワードのコンポーネントファイルを作成しよう(2/4)
10. ログイン前のレイアウト構築 #08
Nuxt.js 親子コンポーネント間の双方向データバインディングを実装する(3/4)
10. ログイン前のレイアウト構築 #09
Nuxt.js Vuetifyのv-text-fieldを使った会員登録フォームのバリデーション設定(4/4)
10. ログイン前のレイアウト構築 #10
Nuxt.js ログインページ実装とHerokuデプロイまで(router. replaceとpushの違いとは)
11. ログイン後のレイアウト構築 #01
Nuxt.js ログイン後のツールバーを作成しよう(inject解説)
11. ログイン後のレイアウト構築 #02
Nuxt.js アカウントメニューページ・ログアウト機能を実装しよう(nuxt-child解説)
11. ログイン後のレイアウト構築 #03
Nuxt.js ログイン後のトップページにプロジェクト一覧を表示しよう
11. ログイン後のレイアウト構築 #04
Nuxt.js プロジェクトページにVuetifyのナビゲーションドロワーを追加しよう
11. ログイン後のレイアウト構築 #05
Nuxt.js paramsIDからプロジェクトを検索してVuexに保存しよう
12. サーバーサイドのログイン認証 #01
JWTとは何か?(ruby-jwtのインストール)
新着
12. サーバーサイドのログイン認証 #02
【Rails×JWT】ログイン認証解説とJWT初期設定ファイルの作成
新着
12. サーバーサイドのログイン認証 #03
【Rails×JWT】トークン発行とデコードを行うAuthTokenクラスの作成
新着
12. サーバーサイドのログイン認証 #04
【Rails×JWT】 ログイン判定を行うAuthenticatorモジュールの作成
新着
12. サーバーサイドのログイン認証 #05
【Rails×JWT】UserクラスからJWTを扱うTokenizableモジュールの作成
新着
12. サーバーサイドのログイン認証 #06
【Rails×JWT】AuthTokenクラスとAuthenticatorモジュールをテストする
新着
12. サーバーサイドのログイン認証 #07
【Rails×JWT】JWTをCookieに保存するログインコントローラーの実装
新着
12. サーバーサイドのログイン認証 #08
【Rails×JWT】ログインコントローラーのテストとHerokuデプロイ
新着
SPA開発
ブログ構築
小ネタ集