チャプター15

認証の追加

前のチャプターでは、フォームバリデーションを追加してアクセシビリティを向上させることで、請求書ルートの構築を完了しました。このチャプターでは、ダッシュボードに認証機能を追加します。

このチャプターの内容...

ここで取り上げるトピックは次のとおりです。

認証とは何か。

NextAuth.jsを使用してアプリに認証を追加する方法。

Middlewareを使用してユーザーをリダイレクトし、ルートを保護する方法。

ReactのuseActionStateを使用して、ペンディング状態とフォームエラーを処理する方法。

認証とは？

認証は今日の多くのWebアプリケーションにとって重要な部分です。システムがユーザーが主張する本人であることを確認する方法です。

安全なウェブサイトでは、ユーザーの身元を確認するために複数の方法を使用することがよくあります。たとえば、ユーザー名とパスワードを入力した後、サイトはデバイスに確認コードを送信したり、Google Authenticatorのような外部アプリを使用したりすることがあります。この2要素認証（2FA）はセキュリティを高めるのに役立ちます。たとえ誰かがあなたのパスワードを知ったとしても、あなたの固有のトークンがなければアカウントにアクセスすることはできません。

認証 vs. 認可

Web開発において、認証と認可は異なる役割を果たします。

認証とは、ユーザーが主張する本人であることを確認することです。ユーザー名やパスワードなど、あなたが持っているもので本人であることを証明します。
認可は次のステップです。ユーザーの身元が確認された後、認可は、そのユーザーがアプリケーションのどの部分を使用することを許可されているかを決定します。

つまり、認証はあなたが誰であるかをチェックし、認可はアプリケーションで何ができるか、何にアクセスできるかを決定します。

まず、アプリケーションに/loginという新しいルートを作成し、以下のコードを貼り付けてください。

/app/login/page.tsx

import AcmeLogo from '@/app/ui/acme-logo';
import LoginForm from '@/app/ui/login-form';
import { Suspense } from 'react';
 
export default function LoginPage() {
  return (
    <main className="flex items-center justify-center md:h-screen">
      <div className="relative mx-auto flex w-full max-w-[400px] flex-col space-y-2.5 p-4 md:-mt-32">
        <div className="flex h-20 w-full items-end rounded-lg bg-blue-500 p-3 md:h-36">
          <div className="w-32 text-white md:w-36">
            <AcmeLogo />
          </div>
        </div>
        <Suspense>
          <LoginForm />
        </Suspense>
      </div>
    </main>
  );
}

このページが<LoginForm />をインポートしていることに気づくでしょう。これはこのチャプターの後半で更新します。このコンポーネントは、受信リクエスト（URL検索パラメータ）からの情報にアクセスするため、Reactの<Suspense>でラップされています。

NextAuth.js

アプリケーションに認証を追加するために、NextAuth.jsを使用します。NextAuth.jsは、セッション管理、サインイン/サインアウト、その他の認証の側面に関連する多くの複雑さを抽象化します。これらの機能を手動で実装することも可能ですが、そのプロセスは時間がかかり、エラーが発生しやすいものです。NextAuth.jsはプロセスを簡素化し、Next.jsアプリケーションにおける認証のための統一されたソリューションを提供します。

NextAuth.jsのセットアップ

ターミナルで以下のコマンドを実行してNextAuth.jsをインストールします。

ターミナル

pnpm i next-auth@beta

ここでは、Next.js 14+と互換性のあるNextAuth.jsのbetaバージョンをインストールしています。

次に、アプリケーションのシークレットキーを生成します。このキーはクッキーの暗号化に使用され、ユーザーセッションのセキュリティを確保します。これはターミナルで以下のコマンドを実行することで行えます。

ターミナル

# macOS
openssl rand -base64 32
# Windows can use https://generate-secret.vercel.app/32

次に、.envファイルに、生成したキーをAUTH_SECRET変数に追加します。

.env

AUTH_SECRET=your-secret-key

本番環境で認証を機能させるには、Vercelプロジェクトの環境変数も更新する必要があります。Vercelでの環境変数の追加方法については、このガイドを参照してください。

ページオプションの追加

プロジェクトのルートにauth.config.tsファイルを作成し、authConfigオブジェクトをエクスポートします。このオブジェクトにはNextAuth.jsの設定オプションが含まれます。今のところは、pagesオプションのみが含まれます。

/auth.config.ts

import type { NextAuthConfig } from 'next-auth';
 
export const authConfig = {
  pages: {
    signIn: '/login',
  },
} satisfies NextAuthConfig;

pagesオプションを使用して、カスタムサインイン、サインアウト、エラーページのルートを指定できます。これは必須ではありませんが、signIn: '/login'をpagesオプションに追加することで、ユーザーはNextAuth.jsのデフォルトページではなく、カスタムログインページにリダイレクトされます。

Next.js Middlewareでルートを保護する

次に、ルートを保護するためのロジックを追加します。これにより、ユーザーはログインしていない限りダッシュボードページにアクセスできなくなります。

/auth.config.ts

import type { NextAuthConfig } from 'next-auth';
 
export const authConfig = {
  pages: {
    signIn: '/login',
  },
  callbacks: {
    authorized({ auth, request: { nextUrl } }) {
      const isLoggedIn = !!auth?.user;
      const isOnDashboard = nextUrl.pathname.startsWith('/dashboard');
      if (isOnDashboard) {
        if (isLoggedIn) return true;
        return false; // Redirect unauthenticated users to login page
      } else if (isLoggedIn) {
        return Response.redirect(new URL('/dashboard', nextUrl));
      }
      return true;
    },
  },
  providers: [], // Add providers with an empty array for now
} satisfies NextAuthConfig;

authorizedコールバックは、Next.js Middlewareでページへのアクセスが認可されているかどうかを検証するために使用されます。これはリクエストが完了する前に呼び出され、authとrequestプロパティを持つオブジェクトを受け取ります。authプロパティにはユーザーのセッションが含まれ、requestプロパティには受信リクエストが含まれます。

providersオプションは、さまざまなログインオプションをリストする配列です。今のところ、NextAuthの設定を満たすために空の配列になっています。Credentialsプロバイダの追加セクションでこれについて詳しく学びます。

次に、authConfigオブジェクトをMiddlewareファイルにインポートする必要があります。プロジェクトのルートにmiddleware.tsというファイルを作成し、以下のコードを貼り付けます。

/middleware.ts

import NextAuth from 'next-auth';
import { authConfig } from './auth.config';
 
export default NextAuth(authConfig).auth;
 
export const config = {
  // https://nextjs.dokyumento.jp/docs/app/building-your-application/routing/middleware#matcher
  matcher: ['/((?!api|_next/static|_next/image|.*\\.png$).*)'],
};

ここでは、authConfigオブジェクトを使ってNextAuth.jsを初期化し、authプロパティをエクスポートしています。また、Middlewareのmatcherオプションを使用して、特定のパスで実行されるように指定しています。

このタスクにMiddlewareを使用する利点は、Middlewareが認証を検証するまで、保護されたルートがレンダリングを開始しないことです。これにより、アプリケーションのセキュリティとパフォーマンスの両方が向上します。

パスワードのハッシュ化

パスワードをデータベースに保存する前にハッシュ化することは良い習慣です。ハッシュ化はパスワードを固定長のランダムに見える文字列に変換し、ユーザーのデータが漏洩した場合でもセキュリティ層を提供します。

データベースにシードデータを入れる際、ユーザーのパスワードをデータベースに保存する前に、bcryptというパッケージを使ってハッシュ化しました。このチャプターの後半で、ユーザーが入力したパスワードがデータベース内のパスワードと一致するかどうかを比較するために、再度bcryptを使用します。ただし、bcryptパッケージ用に別のファイルを作成する必要があります。これは、bcryptがNext.js Middlewareでは利用できないNode.js APIに依存しているためです。

authConfigオブジェクトをスプレッドするauth.tsという新しいファイルを作成します。

/auth.ts

import NextAuth from 'next-auth';
import { authConfig } from './auth.config';
 
export const { auth, signIn, signOut } = NextAuth({
  ...authConfig,
});

Credentialsプロバイダの追加

次に、NextAuth.js用のprovidersオプションを追加する必要があります。providersは、GoogleやGitHubなどのさまざまなログインオプションをリストする配列です。このコースでは、Credentialsプロバイダのみを使用することに焦点を当てます。

Credentialsプロバイダは、ユーザーがユーザー名とパスワードでログインできるようにします。

/auth.ts

import NextAuth from 'next-auth';
import { authConfig } from './auth.config';
import Credentials from 'next-auth/providers/credentials';
 
export const { auth, signIn, signOut } = NextAuth({
  ...authConfig,
  providers: [Credentials({})],
});

知っておくと便利

OAuthやメールなど、他のプロバイダもあります。オプションの全リストはNextAuth.jsのドキュメントを参照してください。

認証ロジックを処理するためにauthorize関数を使用できます。Server Actionsと同様に、ユーザーがデータベースに存在するかどうかを確認する前に、zodを使用してメールとパスワードを検証できます。

/auth.ts

import NextAuth from 'next-auth';
import { authConfig } from './auth.config';
import Credentials from 'next-auth/providers/credentials';
import { z } from 'zod';
 
export const { auth, signIn, signOut } = NextAuth({
  ...authConfig,
  providers: [
    Credentials({
      async authorize(credentials) {
        const parsedCredentials = z
          .object({ email: z.string().email(), password: z.string().min(6) })
          .safeParse(credentials);
      },
    }),
  ],
});

認証情報を検証した後、データベースからユーザーをクエリする新しいgetUser関数を作成します。

/auth.ts

import NextAuth from 'next-auth';
import Credentials from 'next-auth/providers/credentials';
import { authConfig } from './auth.config';
import { z } from 'zod';
import type { User } from '@/app/lib/definitions';
import bcrypt from 'bcrypt';
import postgres from 'postgres';
 
const sql = postgres(process.env.POSTGRES_URL!, { ssl: 'require' });
 
async function getUser(email: string): Promise<User | undefined> {
  try {
    const user = await sql<User[]>`SELECT * FROM users WHERE email=${email}`;
    return user[0];
  } catch (error) {
    console.error('Failed to fetch user:', error);
    throw new Error('Failed to fetch user.');
  }
}
 
export const { auth, signIn, signOut } = NextAuth({
  ...authConfig,
  providers: [
    Credentials({
      async authorize(credentials) {
        const parsedCredentials = z
          .object({ email: z.string().email(), password: z.string().min(6) })
          .safeParse(credentials);
 
        if (parsedCredentials.success) {
          const { email, password } = parsedCredentials.data;
          const user = await getUser(email);
          if (!user) return null;
        }
 
        return null;
      },
    }),
  ],
});

次に、bcrypt.compareを呼び出してパスワードが一致するかどうかを確認します。

/auth.ts

import NextAuth from 'next-auth';
import Credentials from 'next-auth/providers/credentials';
import { authConfig } from './auth.config';
import { z } from 'zod';
import type { User } from '@/app/lib/definitions';
import bcrypt from 'bcrypt';
import postgres from 'postgres';
 
const sql = postgres(process.env.POSTGRES_URL!, { ssl: 'require' });
 
// ...
 
export const { auth, signIn, signOut } = NextAuth({
  ...authConfig,
  providers: [
    Credentials({
      async authorize(credentials) {
        // ...
 
        if (parsedCredentials.success) {
          const { email, password } = parsedCredentials.data;
          const user = await getUser(email);
          if (!user) return null;
          const passwordsMatch = await bcrypt.compare(password, user.password);
 
          if (passwordsMatch) return user;
        }
 
        console.log('Invalid credentials');
        return null;
      },
    }),
  ],
});

最後に、パスワードが一致した場合はユーザーを返しますが、一致しない場合はユーザーがログインできないようにnullを返します。

次に、認証ロジックをログインフォームに接続する必要があります。actions.tsファイルで、authenticateという新しいアクションを作成します。このアクションはauth.tsからsignIn関数をインポートする必要があります。

/app/lib/actions.ts

'use server';
 
import { signIn } from '@/auth';
import { AuthError } from 'next-auth';
 
// ...
 
export async function authenticate(
  prevState: string | undefined,
  formData: FormData,
) {
  try {
    await signIn('credentials', formData);
  } catch (error) {
    if (error instanceof AuthError) {
      switch (error.type) {
        case 'CredentialsSignin':
          return 'Invalid credentials.';
        default:
          return 'Something went wrong.';
      }
    }
    throw error;
  }
}

'CredentialsSignin'エラーが発生した場合は、適切なエラーメッセージを表示したいでしょう。ドキュメントでNextAuth.jsのエラーについて学ぶことができます。

最後に、login-form.tsxコンポーネントで、ReactのuseActionStateを使用して、サーバーアクションを呼び出し、フォームエラーを処理し、フォームのペンディング状態を表示できます。

app/ui/login-form.tsx

'use client';
 
import { lusitana } from '@/app/ui/fonts';
import {
  AtSymbolIcon,
  KeyIcon,
  ExclamationCircleIcon,
} from '@heroicons/react/24/outline';
import { ArrowRightIcon } from '@heroicons/react/20/solid';
import { Button } from '@/app/ui/button';
import { useActionState } from 'react';
import { authenticate } from '@/app/lib/actions';
import { useSearchParams } from 'next/navigation';
 
export default function LoginForm() {
  const searchParams = useSearchParams();
  const callbackUrl = searchParams.get('callbackUrl') || '/dashboard';
  const [errorMessage, formAction, isPending] = useActionState(
    authenticate,
    undefined,
  );
 
  return (
    <form action={formAction} className="space-y-3">
      <div className="flex-1 rounded-lg bg-gray-50 px-6 pb-4 pt-8">
        <h1 className={`${lusitana.className} mb-3 text-2xl`}>
          Please log in to continue.
        </h1>
        <div className="w-full">
          <div>
            <label
              className="mb-3 mt-5 block text-xs font-medium text-gray-900"
              htmlFor="email"
            >
              Email
            </label>
            <div className="relative">
              <input
                className="peer block w-full rounded-md border border-gray-200 py-[9px] pl-10 text-sm outline-2 placeholder:text-gray-500"
                id="email"
                type="email"
                name="email"
                placeholder="Enter your email address"
                required
              />
              <AtSymbolIcon className="pointer-events-none absolute left-3 top-1/2 h-[18px] w-[18px] -translate-y-1/2 text-gray-500 peer-focus:text-gray-900" />
            </div>
          </div>
          <div className="mt-4">
            <label
              className="mb-3 mt-5 block text-xs font-medium text-gray-900"
              htmlFor="password"
            >
              Password
            </label>
            <div className="relative">
              <input
                className="peer block w-full rounded-md border border-gray-200 py-[9px] pl-10 text-sm outline-2 placeholder:text-gray-500"
                id="password"
                type="password"
                name="password"
                placeholder="Enter password"
                required
                minLength={6}
              />
              <KeyIcon className="pointer-events-none absolute left-3 top-1/2 h-[18px] w-[18px] -translate-y-1/2 text-gray-500 peer-focus:text-gray-900" />
            </div>
          </div>
        </div>
        <input type="hidden" name="redirectTo" value={callbackUrl} />
        <Button className="mt-4 w-full" aria-disabled={isPending}>
          Log in <ArrowRightIcon className="ml-auto h-5 w-5 text-gray-50" />
        </Button>
        <div
          className="flex h-8 items-end space-x-1"
          aria-live="polite"
          aria-atomic="true"
        >
          {errorMessage && (
            <>
              <ExclamationCircleIcon className="h-5 w-5 text-red-500" />
              <p className="text-sm text-red-500">{errorMessage}</p>
            </>
          )}
        </div>
      </div>
    </form>
  );
}

ログアウト機能の追加

<SideNav />にログアウト機能を追加するには、<form>要素でauth.tsのsignOut関数を呼び出します。

/ui/dashboard/sidenav.tsx

import Link from 'next/link';
import NavLinks from '@/app/ui/dashboard/nav-links';
import AcmeLogo from '@/app/ui/acme-logo';
import { PowerIcon } from '@heroicons/react/24/outline';
import { signOut } from '@/auth';
 
export default function SideNav() {
  return (
    <div className="flex h-full flex-col px-3 py-4 md:px-2">
      // ...
      <div className="flex grow flex-row justify-between space-x-2 md:flex-col md:space-x-0 md:space-y-2">
        <NavLinks />
        <div className="hidden h-auto w-full grow rounded-md bg-gray-50 md:block"></div>
        <form
          action={async () => {
            'use server';
            await signOut({ redirectTo: '/' });
          }}
        >
          <button className="flex h-[48px] grow items-center justify-center gap-2 rounded-md bg-gray-50 p-3 text-sm font-medium hover:bg-sky-100 hover:text-blue-600 md:flex-none md:justify-start md:p-2 md:px-3">
            <PowerIcon className="w-6" />
            <div className="hidden md:block">Sign Out</div>
          </button>
        </form>
      </div>
    </div>
  );
}

試してみる

さあ、試してみましょう。以下の認証情報を使ってアプリケーションにログインおよびログアウトできるはずです。

メールアドレス: user@nextmail.com
パスワード: 123456

認証の追加

チャプター完了15