Forward Email プロバイダー

概要

Forward Email プロバイダーは、検証トークンを含む URL を含む「マジックリンク」を送信するためにメールを使用します。

1つ以上のOAuthサービスに加えてメールによるサインインのサポートを追加することで、OAuthアカウントへのアクセスを失った場合（ロックまたは削除された場合など）にユーザーがサインインできる方法が提供されます。

Forward Email プロバイダーは、1つ以上のOAuthプロバイダーと組み合わせて（または代わりに）使用できます。

動作原理

最初のサインイン時に、**検証トークン**が指定されたメールアドレスに送信されます。デフォルトでは、このトークンは24時間有効です。その時間内に検証トークンが使用された場合（つまり、メール内のリンクをクリックした場合）、ユーザーのアカウントが作成され、サインインされます。

サインイン時に既存アカウントのメールアドレスが提供された場合、メールが送信され、メール内のリンクに従うと、そのメールアドレスに関連付けられたアカウントにサインインされます。

⚠️

Forward Email プロバイダーは、BasicAuthとデータベース管理セッションの両方で使用できますが、**データベースを設定する必要があります**。データベースを使用せずにメールサインインを有効にすることはできません。

設定

まず、ドメインをForward Emailアカウントに追加する必要があります。これはForward Emailによって必要とされ、fromプロバイダーオプションで使用されるアドレスのドメインです。
次に、マイアカウント → セキュリティでAPIキーを生成する必要があります。このAPIキーをAUTH_FORWARDEMAIL_KEY環境変数として保存できます。

AUTH_FORWARDEMAIL_KEY=abc

環境変数をAUTH_FORWARDEMAIL_KEYと名付けた場合、プロバイダーは自動的にそれを取得し、Auth.js設定オブジェクトをよりシンプルにすることができます。ただし、別の名前に変更する場合は、Auth.js設定でプロバイダーに手動で渡す必要があります。

./auth.ts

import NextAuth from "next-auth"
import ForwardEmail from "next-auth/providers/forwardemail"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  adapter: ...,
  providers: [
    ForwardEmail({
      // If your environment variable is named differently than default
      apiKey: AUTH_FORWARDEMAIL_KEY,
      from: "no-reply@company.com"
    }),
  ],
})

/src/routes/plugin@auth.ts

import { QwikAuth$ } from "@auth/qwik"
import ForwardEmail from "@auth/qwik/providers/forwardemail"
 
export const { onRequest, useSession, useSignIn, useSignOut } = QwikAuth$(
  () => ({
    providers: [
      ForwardEmail({
        // If your environment variable is named differently than default
        apiKey: import.meta.env.AUTH_FORWARDEMAIL_KEY,
        from: "no-reply@company.com",
      }),
    ],
  })
)

./src/auth.ts

import { SvelteKitAuth } from "@auth/sveltekit"
import ForwardEmail from "@auth/sveltekit/providers/forwardemail"
import { env } from "$env/dynamic/prviate"
 
export const { handle, signIn, signOut } = SvelteKitAuth({
  adapter: ...,
  providers: [
    ForwardEmail({
      // If your environment variable is named differently than default
      apiKey: env.AUTH_FORWARDEMAIL_KEY,
      from: "no-reply@company.com",
    }),
  ],
})

メール検証トークンを保存するためのデータベースアダプターの1つを設定することを忘れないでください。
/api/auth/signinでメールアドレスを使用してサインインプロセスを開始できます。

ユーザーアカウント（つまり、Usersテーブルのエントリ）は、ユーザーが初めてメールアドレスを検証するまで作成されません。メールアドレスが既にアカウントに関連付けられている場合、ユーザーはマジックリンクメール内のリンクをクリックして検証トークンを使用すると、そのアカウントにサインインされます。

カスタマイズ

メール本文

ForwardEmail()にカスタム関数としてsendVerificationRequestオプションを渡すことで、送信されるサインインメールを完全にカスタマイズできます。

./auth.ts

import NextAuth from "next-auth"
import ForwardEmail from "next-auth/providers/forwardemail"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    ForwardEmail({
      server: process.env.EMAIL_SERVER,
      from: process.env.EMAIL_FROM,
      sendVerificationRequest({
        identifier: email,
        url,
        provider: { server, from },
      }) {
        // your function
      },
    }),
  ],
})

例として、以下は組み込みのsendVerificationRequest()メソッドのソースを示しています。HTML（html()）をレンダリングし、ネットワーク呼び出し（fetch()）をForward Emailに行って実際に送信していることに注意してください。

./lib/authSendRequest.ts

export async function sendVerificationRequest(params) {
  const { identifier: to, provider, url, theme } = params
  const { host } = new URL(url)
  const res = await fetch("https://api.forwardemail.net/v1/emails", {
    method: "POST",
    headers: {
      Authorization: `Basic ${btoa(provider.apiKey + ":")}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      from: provider.from,
      to,
      subject: `Sign in to ${host}`,
      html: html({ url, host, theme }),
      text: text({ url, host }),
    }),
  })
 
  if (!res.ok)
    throw new Error("Forward Email error: " + JSON.stringify(await res.json()))
}
 
function html(params: { url: string; host: string; theme: Theme }) {
  const { url, host, theme } = params
 
  const escapedHost = host.replace(/\./g, "&#8203;.")
 
  const brandColor = theme.brandColor || "#346df1"
  const color = {
    background: "#f9f9f9",
    text: "#444",
    mainBackground: "#fff",
    buttonBackground: brandColor,
    buttonBorder: brandColor,
    buttonText: theme.buttonText || "#fff",
  }
 
  return `
<body style="background: ${color.background};">
  <table width="100%" border="0" cellspacing="20" cellpadding="0"
    style="background: ${color.mainBackground}; max-width: 600px; margin: auto; border-radius: 10px;">
    <tr>
      <td align="center"
        style="padding: 10px 0px; font-size: 22px; font-family: Helvetica, Arial, sans-serif; color: ${color.text};">
        Sign in to <strong>${escapedHost}</strong>
      </td>
    </tr>
    <tr>
      <td align="center" style="padding: 20px 0;">
        <table border="0" cellspacing="0" cellpadding="0">
          <tr>
            <td align="center" style="border-radius: 5px;" bgcolor="${color.buttonBackground}"><a href="${url}"
                target="_blank"
                style="font-size: 18px; font-family: Helvetica, Arial, sans-serif; color: ${color.buttonText}; text-decoration: none; border-radius: 5px; padding: 10px 20px; border: 1px solid ${color.buttonBorder}; display: inline-block; font-weight: bold;">Sign
                in</a></td>
          </tr>
        </table>
      </td>
    </tr>
    <tr>
      <td align="center"
        style="padding: 0px 0px 10px 0px; font-size: 16px; line-height: 22px; font-family: Helvetica, Arial, sans-serif; color: ${color.text};">
        If you did not request this email you can safely ignore it.
      </td>
    </tr>
  </table>
</body>
`
}
 
// Email Text body (fallback for email clients that don't render HTML, e.g. feature phones)
function text({ url, host }: { url: string; host: string }) {
  return `Sign in to ${host}\n${url}\n\n`
}

多くのメールクライアントと互換性のあるReactで優れた外観のメールを生成したい場合は、mjmlまたはreact-emailを確認してください。

検証トークン

デフォルトでは、ランダムな検証トークンを生成しています。上書きする場合は、プロバイダーオプションにgenerateVerificationTokenメソッドを定義できます。

./auth.ts

import NextAuth from "next-auth"
import ForwardEmail from "next-auth/providers/forwardemail"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    ForwardEmail({
      async generateVerificationToken() {
        return crypto.randomUUID()
      },
    }),
  ],
})

メールアドレスの正規化

デフォルトで、Auth.jsはメールアドレスを正規化します。アドレスを大文字と小文字を区別しないものとして扱い（技術的にはRFC 2821仕様に準拠していませんが、実際には、データベースからメールでユーザーを検索する場合など、解決するよりも多くの問題を引き起こします）、コンマ区切りのリストとして渡された可能性のあるセカンダリメールアドレスも削除します。ForwardEmailプロバイダーのnormalizeIdentifierメソッドを使用して独自の正規化を適用できます。次の例はデフォルトの動作を示しています。

./auth.ts

import NextAuth from "next-auth"
import ForwardEmail from "next-auth/providers/forwardemail"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    ForwardEmail({
      normalizeIdentifier(identifier: string): string {
        // Get the first two elements only,
        // separated by `@` from user input.
        let [local, domain] = identifier.toLowerCase().trim().split("@")
        // The part before "@" can contain a ","
        // but we remove it on the domain part
        domain = domain.split(",")[0]
        return `${local}@${domain}`
 
        // You can also throw an error, which will redirect the user
        // to the sign-in page with error=EmailSignin in the URL
        // if (identifier.split("@").length > 2) {
        //   throw new Error("Only one email allowed")
        // }
      },
    }),
  ],
})

⚠️

複数のメールアドレスが渡された場合でも、常に1つのメールアドレスを返すようにしてください。

Faceit Foursquare

Forward Email プロバイダー

概要

動作原理

設定

カスタマイズ

メール本文

検証トークン

メールアドレスの正規化

Auth.jsについて

ダウンロード

謝辞