章15

認証の追加

前の章では、フォームの検証を追加し、アクセシビリティを改善することで、請求書ルートの構築を完了しました。この章では、ダッシュボードに認証を追加します。

この章の内容...

ここでは、取り上げるトピックを紹介します。

認証とは。

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

ミドルウェアを使用してユーザーをリダイレクトし、ルートを保護する方法。

ReactのuseActionStateを使用して、保留中の状態とフォームエラーを処理する方法。

認証とは？

認証は、今日の多くのWebアプリケーションの重要な部分です。システムが、ユーザーが本人であるかどうかを確認する方法です。

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

認証と認可

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

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

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

まず、/loginという名前の新しいルートをアプリケーションに作成し、次のコードを貼り付けます。

/app/login/page.tsx

import AcmeLogo from '@/app/ui/acme-logo';
import LoginForm from '@/app/ui/login-form';
 
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>
        <LoginForm />
      </div>
    </main>
  );
}

このページが<LoginForm />をインポートしていることがわかります。これは、この章で後ほど更新します。

NextAuth.js

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

NextAuth.jsの設定

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

ターミナル

pnpm i next-auth@beta

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

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

ターミナル

openssl rand -base64 32

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

.env

AUTH_SECRET=your-secret-key

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

pagesオプションの追加

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

Next.jsミドルウェアによるルートの保護

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

/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ミドルウェアを介してページにアクセスする権限があるかどうかを確認するために使用されます。リクエストが完了する前に呼び出され、authプロパティとrequestプロパティを持つオブジェクトを受け取ります。authプロパティにはユーザーのセッションが含まれ、requestプロパティには受信リクエストが含まれます。

providersオプションは、さまざまなログインオプションをリストする配列です。今のところ、NextAuthの構成を満たすための空の配列です。詳細については、資格情報プロバイダーの追加セクションで説明します。

次に、authConfigオブジェクトをミドルウェアファイルにインポートする必要があります。プロジェクトのルートに、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プロパティをエクスポートしています。また、ミドルウェアのmatcherオプションを使用して、特定のパスで実行する必要があることを指定しています。

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

パスワードハッシュ化

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

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

auth.tsという新しいファイルを作成し、authConfigオブジェクトを展開してください。

/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({})],
});

知っておくと良いこと

Credentialsプロバイダーを使用していますが、一般的にはOAuthまたはemailプロバイダーなどの代替プロバイダーを使用することが推奨されます。オプションの完全なリストについては、NextAuth.jsのドキュメントを参照してください。

authorize関数を使用して、認証ロジックを処理できます。サーバーアクションと同様に、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 { sql } from '@vercel/postgres';
import type { User } from '@/app/lib/definitions';
import bcrypt from 'bcrypt';
 
async function getUser(email: string): Promise<User | undefined> {
  try {
    const user = await sql<User>`SELECT * FROM users WHERE email=${email}`;
    return user.rows[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 { sql } from '@vercel/postgres';
import { z } from 'zod';
import type { User } from '@/app/lib/definitions';
import bcrypt from 'bcrypt';
 
// ...
 
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';
 
export default function LoginForm() {
  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>
        <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();
          }}
        >
          <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