Udemy 13. フロントエンドのログイン認証 #04
2020年11月03日に公開

【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装

今回達成すること

今回は、ログイン済みのユーザーをログインしたままにする処理を行います。

その他、

  • ログイン後のレイアウト切り替え と
  • ログアウトを実装します。

ログインフラグを作成する

Nuxt.js側でのログイン判定は、

  • 有効期限内である、かつ
  • Vuexのユーザーが存在する場合に

ログインしていると判定します。

このフラグは、

  • レイアウトの切り替え判定や
  • ログインユーザーだけがリクエストできるAPI実行の判定

に使用します。

auth.jsに認証フラグを追加する

「plugins」ディレクトリのauth.jsに、ログインフラグを追加します。

front/plugins/auth.js
isAuthenticated...
class Authentication {
  ...
  isAuthenticated () {
    ...
  }

	// 追加
  // Vuexのユーザーを返す
  get user () {
    return this.store.state.current.user || {}
  }

  // ユーザーオブジェクトがある場合にtrueを返す
  isUserPresent () {
    return ('id' in this.user)
  }

  // 有効期限内、かつユーザーが存在する場合にtrueを返す
  get loggedIn () {
    return this.isAuthenticated() && this.isUserPresent()
  }
  // ここまで

  // ログイン業務
  login ({ exp, user }) {
   ...
  }
}
...
  • get user () … クラスオブジェクトに、userというプロパティを追加する。

    $auth.userで呼び出しができます。

    このuserプロパティが呼び出された時に、関数の中で計算した値が返されます。

    参考: getter - JavaScript | MDN

ゲッターを使用し、HTML内で使用頻度が高いuserloggedInを、$authのプロパティとして登録しています。

ログインフラグを切り替える

index.vueのレイアウトを変更するフラグを、作成した$auth.loggedInに変更します。

front/pages/index.vue
...
export default {
	// $authを追加
  layout ({ $auth }) {
    // 追加
    return $auth.loggedIn ? 'loggedIn' : 'welcome'
    // 削除
    // return store.state.loggedIn ? 'loggedIn' : 'welcome'
  },
  ...
}

コンテナを起動して、有効なユーザーでログインします。

まだ、リダイレクト処理を行っていないので、手動でトップページに遷移します。

2020-10-10 13-33-25

OK!レイアウトが切り替わりました。

既存のログインフラグを削除する

index.jsに用意しているログインフラグは今後使用しません。削除しましょう。

front/store/index.js
export const state = () => ({
  // 削除
  // loggedIn: false,
  ...
})

export const getters = {}

export const mutations = {
  // 削除
  // setLoggedIn (state, payload) {
  //   state.loggedIn = payload
  // },
  ...
}

export const actions = {
  // 削除
  // login ({ commit }) {
  //   commit('setLoggedIn', true)
  // },
  // logout ({ commit }) {
  //   commit('setLoggedIn', false)
  // },
  ...
}

(コラム)ログイン判定を偽造された場合

上記の実装だと、有効期限とVuexのユーザーオブジェクトを偽造された場合、フロントエンドはログイン状態となります。

しかし、ユーザーが持つDBの値をRailsにリクエストする際に、正しいアクセストークンが無いとエラーになります。

例えば、今のプロジェクト一覧はVuexに直接作成していますが、本来このデータはログイン直後にRailsへリクエストを行い、取得するものです。

その際に、正しいトークンがなければ認証エラーを返し、強制ログアウトが実行されます。

結局、トークンが盗まれない限り、不正なユーザーがログイン状態を維持する事はできません。

フロントエンドのログイン判定はすぐ破られるものだと想定し、それ以後の対応をどうするかが大切です。


実務では、ログイン前とログイン後を完全に切り分けて実装を行うことがセオリーのようです。(筆者はまだやったことがない)

例えば、ブログやECサイトの商品などを管理するcontentfulでは、

として、ログイン前とログイン後を切り分けて実装しています。

ログイン前のユーザーは「app.contentful.com」に紐づくHTMLやCookie、ローカルストレージには一切アクセスできません。

この実装を行うには、

が考えられます。

その他に切り分ける方法として、

があるようです。

個人的にはドメインを分けたアプリを2つ用意したほうが、後のブログやドキュメントの追加が容易になる為、良いかなと思っています。

もちろん、絶対に「ログイン前とログイン後を完全に切り分ける必要がある」訳でもないですし、アプリの内容によっては今回の実装でも十分に対応できます。

まずは、作りたいアプリの参考サイトを探して、その実装がどうなっているかCookieやストレージを調べてみると良いですね。ご参考までに。

(コラム終わり)

ログインしたままの処理の設計

現状の問題点

現状、ページをリロードすると、Vuexの値は初期化されます。

このままだと、ログイン中でもリロード毎にユーザーが存在しなくなり、ログアウトしてしまいます。

front/store/index.js
export const state = () => ({
  current: {
    user: null // Vuexの値はリロードすると初期化される
  }
})

解決策

そこで、Nuxt.jsが初期化された(リロードされた)直後に

  • 有効期限内であれば、
    • Cookieのトークンを使ってRailsにリクエストを行い
    • ユーザーが返ってきたら => Vuexに保存
    • ユーザーが返ってこなかったら => 有効期限を削除し、ログイン前の状態に戻す
  • 有効期限外であれば、
    • 何もしない

プラグインファイルを作成します。

nuxt auth5

ログイン継続処理を行うプラグインを作成する

「plugins」ディレクトリ内に、ログインしたままの処理を実行するnuxtClientInit.jsを作成します。

root $ touch front/plugins/nuxtClientInit.js

nuxt.config.jsに登録する

プラグインファイルをnuxt.config.jsに登録します。

全てのプラグインが準備できた後に読み込む為、4番目に追加します。

front/nuxt.config.js
export default {
  ...
  plugins: [
    'plugins/auth',
    'plugins/axios',
    'plugins/myInject',
    // 4番目に追加
    'plugins/nuxtClientInit'
  ],
  ...
}

Railsにリクエストを送る

有効期限内であれば、Railsにリクエストを送りユーザーを取得します。

front/plugins/nuxtClientInit.js
// client初期設定ファイル
export default async ({ $auth, $axios, store }) => {
  if ($auth.isAuthenticated()) {
    await $axios.$get('/api/v1/users/current_user')
      .then(tokenUser => store.dispatch('getCurrentUser', tokenUser))
      // Cookieはサーバーで削除済み
      .catch(() => $auth.removeStorage())
  }
}
  • .catch(() => $auth.removeStorage()) … トークンが不正な場合など、ユーザーが取得できない時はcatch()に処理がうつされます。

    Rails側でCookieは削除されるので、Nuxt.js側ではストレージを削除します。

    この時の状態は、

    • Vuexのユーザーはnullで、
    • Cookieのトークンは削除され、
    • ストレージの有効期限も削除されます。

    不正なアクセストークンがリクエストされた場合、完全なログアウト状態を返します。

確認してみよう

index.vueに、ユーザーの状態を確認するテストコードを追加します。

front/pages/index.vue
<template>
  <div id="logged-in-home">
    <!-- 追加 -->
    {{ $auth.user }}
    ...
</template>
..,

確認1)ユーザーが維持できているか?

ログイン状態でページをリロードしてみましょう。

ユーザーが維持できていますね。

これは、リロード時にnuxtClientInit.jsが実行され、アクセストークンを使ってRailsにリクエストを行なっているためです。

2020-10-10 20-12-45

確認2)有効期限が無い場合はログアウトしてるか?

ローカルストレージのexpの値を削除して、リロードしてみましょう。

2020-10-10 20-01-40

ログイン前の画面に戻りましたね。

Cookieのトークンは残りますが、次回ログイン時には上書きされます。

確認3)不正なトークンはログアウトしてるか?

もう一度ログインし、Cookieのトークンを改ざんしてリロードしてみましょう。

2020-10-10 20-19-51

これも、ログイン前の画面に戻りました。

不正なアクセストークンが送られてきたので

  • Cookieのトークン
  • ローカルストレージの有効期限

双方とも削除されています。

テストコードを削除する

ここまでの確認が取れたらindex.vueのテストコードは削除します。

front/pages/index.vue
<template>
  <div id="logged-in-home">
    <!-- {{ $auth.user }} 削除 -->
    ...
</template>

ユーザー名を追加する

ユーザーが維持できるようになったので、アカウントメニューにユーザー名を追加します。

「components」ディレクトリ内のloggedInAppBar.vueを編集します。

front/components/loggedIn/header/loggedInAppBar.vue
<template>
  <v-app-bar
    app
    dense
    elevation="1"
    clipped-left
    color="white"
  >
      ...
      <v-list dense>
        <v-subheader>
          ログイン中のユーザー
        </v-subheader>

        <v-list-item>
          <v-list-item-content>
            <v-list-item-subtitle>
              <!-- 追加 -->
              {{ $auth.user.name }}
              <!-- ユーザー名が表示されます 削除 -->
            </v-list-item-subtitle>
          </v-list-item-content>
        </v-list-item>

        <v-divider />

        <v-subheader>
          アカウント
        </v-subheader>
        ...
  </v-app-bar>
</template>
...

ログイン状態でユーザー名が表示されるようになりました。

2020-10-13 16-12-26

ログアウトを実装する

ログアウト時には、auth.jsで作成したlogout()メソッドを呼び出します。

これにより、

  • Cookieトークン
  • ローカルストレージの有効期限
  • Vuexのユーザー

が削除されます。

logout.vueにメソッドを追加する

logout.vuedeforeCreate()に追記します。

コードを簡潔にするために、middlewareの処理は削除しました。

front/pages/logout.vue
<template>
  <div />
</template>

<script>
// 追加
export default {
  layout: 'logout',
  async beforeCreate () {
    await this.$auth.logout()
    this.$router.replace('/')
  }
}

// 削除
// export default {
//   async middleware ({ store, redirect, from }) {
//     await store.dispatch('logout')
//     if (from.name !== 'index') { return redirect('/') }
//   },
//   layout: 'logout',
//   beforeCreate () {
//     this.$router.replace('/')
//   }
// }
</script>

ログアウトを確認しよう

「layouts」ディレクトリのwelcome.vueにテストコードを追加します。

<template>
  <v-app>
    <!-- 追加 -->
    {{ $auth.isUserPresent() ? $auth.user : 'ユーザーはおらん' }}
    <wel-app-bar

ログイン後、アカウントのログアウトメニューをクリックします。

2020-10-10 21-31-53

Vuexのユーザーは削除されました。

2020-10-13 14-53-24

その他にも

  • Cookieのアクセストークンと
  • ローカルストレージの有効期限が

削除できていることを確認してください。

確認が取れたらテストコードは削除しましょう。

front/layouts/welcome.vue
<template>
  <v-app>
    <!-- {{ $auth.isUserPresent() ? $auth.user : 'ユーザーはおらん' }} 削除 -->

コミットしとく

以上で実装を終わります。コミットしましょう。

root $ cd front
front $ git add -A && git commit -m "add_nuxtClientInit_plugins" && cd ..
root $

まとめ

今回は、Nuxtにログインフラグを作成し、

  • ログインを維持する処理と
  • ログアウト処理を実装しました。

ただ、今のままだとログインしなくても、ログイン後のページに自由に行き来できますね。

この辺りの処理を次回以降固めていきます。

次回は?

次回はミドルウェアを使ったログイン前後のリダイレクト処理を行います。

またここでお会いしましょう〜!

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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デプロイ
13. フロントエンドのログイン認証 #01
【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定
13. フロントエンドのログイン認証 #02
【Nuxt.js】Railsからのログイン成功レスポンスをVuexに保存する
13. フロントエンドのログイン認証 #03
【Nuxt.js】ローカルストレージの有効期限を暗号化する(crypto-js解説)
13. フロントエンドのログイン認証 #04
【Nuxt.js】JWT有効期限内のユーザーをログインしたままにする実装
13. フロントエンドのログイン認証 #05
【Nuxt.js】ログイン前後のリダイレクト処理をミドルウェアで実装する
13. フロントエンドのログイン認証 #06
【Nuxt.js】ログイン失敗時のトースターをグローバルイベントとして作成する
13. フロントエンドのログイン認証 #07
【Nuxt.js】エラーページを作成する
13. フロントエンドのログイン認証 #08
【Rails×Nuxt.js】デモプロジェクトの作成とHerokuデプロイ(ログイン認証完)
14. 本番環境への対応 #01
【Rails×Nuxt.js】SafariのクロスサイトCookie保存拒否に対応する
SPA開発
ブログ構築
小ネタ集