Resend プロバイダー

概要

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

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

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

仕組み

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

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

⚠️

Resend プロバイダーは、JSON Web トークンとデータベース管理セッションの両方で使用できますが、データベースを構成する必要があります。データベースを使用せずにメールサインインを有効にすることはできません。

設定

まず、Resend アカウントにドメインを追加する必要があります。これは Resend によって必須とされており、from プロバイダーオプションで使用するアドレスのドメインとなります。
次に、Resend ダッシュボードで API キーを生成する必要があります。この API キーは、AUTH_RESEND_KEY 環境変数として保存できます。

AUTH_RESEND_KEY=abc

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

./auth.ts

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

/src/routes/plugin@auth.ts

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

./src/auth.ts

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

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

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

カスタマイズ

メール本文

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

./auth.ts

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

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

./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.resend.com/emails", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${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("Resend 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 Resend from "next-auth/providers/resend"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    Resend({
      async generateVerificationToken() {
        return crypto.randomUUID()
      },
    }),
  ],
})

メールアドレスの正規化

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

./auth.ts

import NextAuth from "next-auth"
import Resend from "next-auth/providers/resend"
 
export const { handlers, auth, signIn, signOut } = NextAuth({
  providers: [
    Resend({
      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")
        // }
      },
    }),
  ],
})

⚠️

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

Reddit Sailpoint

Resend プロバイダー

概要

仕組み

設定

カスタマイズ

メール本文

認証トークン

メールアドレスの正規化

Auth.js について

ダウンロード

謝辞