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

【Rails×Nuxt.js】クロスオリジン通信でのCookie共有設定

このチャプターで達成すること

チャプター「フロントエンドのログイン認証」では、ログインページの「ログインする」ボタンをクリック後のアクションを完成させます。

nuxt auth

処理の流れは、

  1. 「ログインする」をクリック
  2. Railsの/api/v1//user_tokenにメールとパスワードを送信
  3. 認証に成功した場合、
    • Vuexにユーザーを保存
    • ローカルストレージに有効期限を保存
    • ログイン後ページにリダイレクト
  4. 認証に失敗した場合
    • 404エラーは、トースターを出力
    • その他のエラーはエラーページにリダイレクト

となります。

今回達成すること

今回は、

  • Nuxt.jsからRailsへログインリクエストを送る設定と、
  • クロス(異なる)オリジン通信でのCookie共有設定を行います。

nuxt auth1

オリジンとは?

ウェブコンテンツにアクセスするために使われる、

  • プロトコル(http)+ ドメイン(localhot)+ ポート番号(8080)

の3つを組み合わせたもの(http://localhost:8080)をオリジンと言います。

参考: Origin (オリジン) - MDN Web Docs 用語集

ブランチ切っとく

作業に入る前に「front」ディレクトリでブランチを切ります。

root $ cd front
front $ git checkout -b 20201002_login_authentication
front $ git branch

* 20201002_login_authentication
  master

front $ cd ..
root $

ログインページからRailsにリクエストする

Nuxt.jsのログインページである「pages」ディレクトリのlogin.vueから、Railsにリクエストを行います。

login()メソッド をまるっと書き換えてください。

front/pages/login.vue
...
export default {
  layout: 'beforeLogin',
  data () {
    return {
      isValid: false,
      loading: false,
      params: { auth: { email: '', password: '' } }
    }
  },
  methods: {
    // 書き換え
    async login () {
      this.loading = true
      if (this.isValid) {
        await this.$axios.$post('/api/v1/user_token', this.params)
          .then(response => this.authSuccessful(response))
          .catch(error => this.authFailure(error))
      }
      this.loading = false
    },
    // 追加
    // ログイン成功
    authSuccessful (response) {
      console.log(response)
    },
    // ログイン失敗
    authFailure ({ response }) {
      console.log(response)
    }
    // 削除
    // login () {
    //   this.loading = true
    //   setTimeout(() => {
    //     this.$store.dispatch('login')
    //     this.$router.replace('/')
    //     this.loading = false
    //   }, 1500)
    // }
  }
}

クリックしたと同時に、loadingフラグがtrueになり、バリデーションが通った場合のみRailsにリクエストを送ります。

Railsからのレスポンスを確認する

それではコンテナを起動して、レスポンスが返ってきているか確認しましょう。

root $ docker-compose up

有効なパラメーターを投げる

http://localhost:8080/login にアクセスして、有効なパラメーターを投げます。

ログインフォームにはデータベースに保存されている

  • ユーザーメールアドレス「user0@example.com」と
  • パスワード「password」を入力してください。

2020-10-04 14-17-41

コンソールを確認し、レスポンスが200、Railsからはexpuserが返ってこれば成功です。

2020-10-02 20-52-33

Cookieを確認する

RailsがCookieを保存しているかを確認するには、デベロッパーツールの「Application」タブを開きます。

「Storage」=>「Cookies」=>「http://localhost:8080」を確認します。

2020-10-02 20-57-31

「access_token」というキーとトークンが保存されていれば成功です。

うん、無い。失敗ですね。

クロスオリジン通信でのCookie共有設定

今回の仕様では、

  • Cookieを発行するドメイン「localhost:3000」
  • Cookieを保存するドメイン「localhost:8080」

となっており、異なるオリジン間でCookieを共有します。

このようなクロスオリジン通信でのCookie共有は、双方に設定が必要です。

Nuxt.jsからのリクエスト設定

Nuxt.js側では、nuxt.config.jsaxiosプロパティに、credentials: trueを追加します。

front/nuxt.config.js
export default {
  ...
  axios: {
    // 追加
    // クロスサイトリクエスト時にCookieを使用することを許可する
    // Doc: https://axios.nuxtjs.org/options/#credentials
    credentials: true
  },
	...
}

参考: Axios Module - Nuxt.js

  • credentials(クレデンシャル) … リクエストヘッダーのwithCredentials(ウィズ クレデンシャル)フラグをtrueにする。

    withCredentialsは、クロスオリジンのクライアント資格情報を使用して、リクエストを行うことを許容するか否かを設定するフラグです。(デフォルトはfalse

    trueにすることで、

    • クロスオリジンリクエストの際に、Cookieを送信することができ、
    • また、クロスオリジンレスポンスのCookieを受け取ることができます。

    参考: XMLHttpRequest.withCredentials - Web APIs | MDN

今回のアプリではリクエストの際に、ほぼほぼCookieを使用するのでaxios全体に設定を行いました。

個別にcredentialsの設定を行いたい場合は、リクエスト時にオプションを設定します。

axios参考コード
this.$axios.$post('/api/v1/user_token', this.params, { withCredentials: true })

参考: AxiosがリクエストでCookieを自動的に送信するようにする - StackOverflow

RailsのCookie受取り設定

Rails側で、クロスオリジンリクエストのCookieを使用するには、gem cors(コルス)の設定ファイル、cors.rbcredentialsフラグを追加します。

api/config/initializers/cors.rb
# Be sure to restart your server when you modify this file.

# Avoid CORS issues when API is called from the frontend app.
# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.

# Read more: https://github.com/cyu/rack-cors

Rails.application.config.middleware.insert_before 0, Rack::Cors do
  allow do
    origins ENV["API_DOMAIN"] || ""

    resource '*',
      headers: :any,
      methods: [:get, :post, :put, :patch, :delete, :options, :head],
      # 追加
      # クロスオリジンのCookieを使用するための設定
      credentials: true
  end
end

RailsのAPIモードではCookieを処理するミドルウェアがありません。

application.rb内で、ミドルウェアを追加する設定を行います。

api/config/application.rb
...
module App
  class Application < Rails::Application
    ...
    # 追加
    # Cookieを処理するmeddlewareを追加(APIモードにはデフォルトで入っていない)
    config.middleware.use ActionDispatch::Cookies

    config.api_only = true
  end
end

ここまでの変更ができたら、新しいターミナルを開き、apiサービスを再起動しましょう。

root $ 「Command」+「T」# 新規タブを開く
root $ docker-compose restart api

もう一度ログインする

再起動が確認できたら、もう一度http://localhost:8080/login にアクセスして、ログインします。

access_tokenがセットされました。

2020-10-02 21-47-19

  • Expires(有効期限)は2週間後
  • HttpOnlyにはチェックが入っていること

を確認してください。

Secure(https通信時のみCookieを使用する)フラグはチェックが入っていませんが、本番環境では有効になります。

Cookieの有効期限のタイムゾーン

Cookieの法定タイムゾーンはGMT(グリニッジ標準時)と決められており、expiresはGMTで保存されます。

また、有効期限を判断するために使用されるタイムゾーンもGMTです。

GMTは日本時間マイナス9時間で、UTC(世界標準時)と一致します。

参考: Cookie仕様 日本語訳

When will my cookie actually expire? - StackOverflow

Cookieを削除する

確認が取れたらaccess_tokenにカーソルを合わせ、「deleteキー」でCookieを削除してください。

axiosのグローバル設定ファイルを本番環境に対応

「plugins」ディレクトリにあるaxios.jsは、現在ログが出力するように設定されています。

このログを開発環境のみ出力するよう編集します。

開発環境の場合にtrueを返す、isDevプロパティを追加してください。

front/plugins/axios.js
// isDev追加
export default ({ $axios, isDev }) => {
  // リクエストログ
  $axios.onRequest((config) => {
    // if (isDev) 追加
    if (isDev) { console.log(config) }
  })
  // レスポンスログ
  $axios.onResponse((config) => {
    // if (isDev) 追加
    if (isDev) { console.log(config) }
  })
  // エラーログ
  $axios.onError((e) => {
		console.log(e.response)
  })
}

コミットする

今回はここまでにしておきましょう。

「api」「front」それぞれをコミットします。

root $ cd api
api $ git commit -am "add_credentials_to_cors" 
api $ git push

api $ cd ../front
front $ git commit -am "add_login_request_to_login.vue" && cd ..
root $ 

まとめ

今回は、Nuxt.jsからログインリクエストを送り、正しくCookieが保存できるよう、Nuxt.jsとRails双方にcredentialsの設定を行いました。

Railsは、このCookieのトークンを使ってNuxt.jsのリクエストが正しいかを判断します。

ただ、Nuxt.jsからはこのトークンにアクセスできないので、ログイン状態を他の値を使って判定する必要があります。

この辺りはもう少し先で実装します。

次回は?

Railsから返ってきた有効期限(exp)とユーザーをNuxt.jsに保存します。

  • 有効期限はローカルストレージに、
  • ユーザーはVuexに

それぞれ保存します。

それではまた次回お会いしましょう。

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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開発
ブログ構築
小ネタ集