All posts

Nuxt.js と Express のログインフォームに reCAPTCHA v3 を組み込む

Web サービスのログインフォームやアカウント作成フォームに、ロボットによる不正なアクセスへの対策を入れたいと考えています。

今回初めて reCAPTCHA を使うので、仕組みを調べながら、Nuxt.js の画面と Express のサーバーに組み込んでみました。

この記事は、当時の Nuxt 2 と @nuxtjs/recaptcha を使った実装を基にしています。同モジュールのリポジトリは現在アーカイブされており、新しい Nuxt のバージョンでは対応する実装を確認する必要があります。[モジュールの GitHub リポジトリ]

reCAPTCHA v3 の仕組み

reCAPTCHA v3 では、ユーザーに画像の選択などを求める代わりに、操作に対するスコアを取得できます。

処理の大まかな流れは次のとおりです。

  1. クライアント側で reCAPTCHA のトークンを取得する
  2. トークンをフォームのデータと一緒にサーバーへ送る
  3. サーバーから Google の API にトークンを送って検証する
  4. 検証結果やスコアを基に、サーバー側で処理を判断する

スコアは0〜1で返され、1に近いほど通常の操作である可能性が高いとされています。ただし、スコアだけで人間かロボットかを確定できるわけではありません。

Google は、まず 0.5 を目安にしつつ、実際のサイトの状況を見て調整する方法を案内しています。スコアが低い場合の対応として、ログインを直ちに拒否するほか、追加の認証を求める方法もあります。[Google の reCAPTCHA v3 ガイド]

サイトキーとシークレットキーを取得する

まず、reCAPTCHA の管理画面でサイトを登録し、サイトキーとシークレットキーを取得します。

reCAPTCHA 管理画面

サイトキーはクライアント側で使用します。シークレットキーはサーバー側で検証に使うため、公開される JavaScript や Git リポジトリには含めず、環境変数などで管理します。

クライアント側の設定

当時の Nuxt 2 の環境では、@nuxtjs/recaptcha を使用しました。

npm install @nuxtjs/recaptcha

nuxt.config.js にモジュールとサイトキーを設定します。

export default {
  modules: [
    '@nuxtjs/recaptcha',
  ],

  recaptcha: {
    siteKey: 'ここにサイトキーを設定',
    version: 3,
  },
}

元の実装ではバッジを非表示にしていましたが、Google は非表示にする場合、利用者の操作画面に reCAPTCHA の表示を含めるよう案内しています。ここでは、設定例を分かりやすくするためバッジを表示する形にしています。[Google の reCAPTCHA FAQ]

フォーム送信時にトークンを取得する

ページを表示したときにモジュールを初期化し、ログインボタンが押された際にトークンを取得します。

export default {
  async mounted() {
    try {
      await this.$recaptcha.init()
    } catch (error) {
      console.error('reCAPTCHA の初期化に失敗しました', error)
    }
  },

  beforeDestroy() {
    this.$recaptcha.destroy()
  },

  methods: {
    async onSubmit() {
      try {
        const token = await this.$recaptcha.execute('login')

        // token をログイン情報と一緒にサーバーへ送る
      } catch (error) {
        this.errorMsg = 'ログインに失敗しました。'
      }
    },
  },
}

execute() の引数には、操作を表す login を指定しています。サーバー側でも、返されたアクションが login であることを確認します。

トークンは2分間有効で、検証に使えるのは1回のみです。そのため、ページ表示時ではなく、フォームの送信時に取得します。[Google のトークン検証ガイド]

Express でトークンを検証する

サーバー側では、受け取ったトークンを Google の検証 API に送ります。

以下は、Node.js 18 以降の fetch を使った検証例です。RECAPTCHA_SECRET はサーバーの環境変数に設定し、allowedHostnames は実際に利用するドメインに合わせて変更します。

const allowedHostnames = new Set([
  'example.com',
  // 開発時に必要であれば、開発環境のホスト名を追加する
])

app.post('/auth/login', async (req, res, next) => {
  const token = req.body.recaptchaToken

  if (typeof token !== 'string' || !token) {
    return res.status(400).send('reCAPTCHA トークンが必要です。')
  }

  if (!process.env.RECAPTCHA_SECRET) {
    return next(new Error('reCAPTCHA のシークレットキーが設定されていません。'))
  }

  try {
    const response = await fetch(
      'https://www.google.com/recaptcha/api/siteverify',
      {
        method: 'POST',
        headers: {
          'Content-Type': 'application/x-www-form-urlencoded',
        },
        body: new URLSearchParams({
          secret: process.env.RECAPTCHA_SECRET,
          response: token,
        }),
      },
    )

    if (!response.ok) {
      throw new Error('reCAPTCHA API の呼び出しに失敗しました。')
    }

    const result = await response.json()

    if (
      result.success !== true ||
      result.action !== 'login' ||
      !allowedHostnames.has(result.hostname) ||
      typeof result.score !== 'number' ||
      !Number.isFinite(result.score) ||
      result.score < 0.5
    ) {
      return res.status(403).send('操作を確認できませんでした。')
    }

    // ここから既存のログイン処理を行う
  } catch (error) {
    next(error)
  }
})

この例では、スコアに加えて success、action、hostname を確認しています。API に接続できなかった場合や検証結果が不正な場合も、ログイン処理には進みません。アクションの確認は Google の公式ガイドでも案内されています。[Google の reCAPTCHA v3 ガイド]

閾値の 0.5 は、あくまで例です。実際の運用ではスコアの分布を確認し、誤って正規ユーザーを拒否しないよう、追加認証なども含めて対応を検討したいところです。

今回の実装では、トークンをクライアントで取得し、サーバーで検証する流れを組み込めました。ログイン以外にも、お問い合わせや新規アカウント登録など、それぞれの操作に合わせて利用できそうです。

Discussion