🔱

cognitoの各種認証画面を独自実装する

2023/02/28に公開

はじめに

本記事では、Cognitoの各種認証画面を独自に実装していきます。
HostedUIやAmplifyUIは便利ですが、サービスのイメージに合わなかったりするためです。

UIフレームワークのMUIを使ってサインイン画面やパスワード変更画面などを実装していきます。
画面はMUIで作られていますが、認証まわりの処理は単一のファイルとして切り出しています。
そのためReactNext.jsを利用する場合なら、コピー&ペーストで利用できます。

主に参考にしたのは以下の記事になっています。

https://mseeeen.msen.jp/react-auth-with-ready-made-cognito/

この記事の中でも述べられていますが、aws-amplifyの中のAuthモジュールを利用して認証まわりの処理を組んでいきます。
これは、Amplifyは単純に認証モジュールとして便利なためです。

ログインの見た目はMUIを使っているので、以下のページのを参考にしました。

https://qiita.com/shunnami/items/98a341d2ac20775241ad

利用時のイメージ・この記事の対象読者

利用時のイメージは次のようになっています。
最初の画面はサービスのトップページを想定しています。


サインイン前の状態

画面右上のアカウントボタンを押下すると、サインイン画面に遷移します。
ユーザーの情報を入力して認証が成功すると、トップページに遷移します。


サインイン画面

認証済みの場合は、認証後の画面を用意する想定です。
(今回は認証済みの場合「サインイン後」という文言になります)。


サインイン後の状態

サイン画面の他に、本記事では以下の画面を作成しています。

  • 初回サインイン完了画面
  • パスワード変更画面
  • パスワード忘れ画面
  • パスワードリセット画面

この記事の対象読者

  • ReactNext.jsを利用する方
  • cognitoの認証を利用する方
  • Amplifyを利用せずに、CloudFrontやその他の方法で独自にサイトをホスティングする方

サインアップ画面はなく、AWSコンソールのcognitoの画面でユーザーを作成した後に、この認証画面を利用してもらう想定になっています。
そのため、どちらかというとプライベートなサービスの場合を想定しています。
(サインアップ画面を作れば誰でも登録・利用開始できるサービスにも利用可能です)。

デプロイ環境

利用したフロントエンドの主なライブラリは以下の通りです。

  • react: 18.2.0
  • Next.js: 13.2.1
  • MUI: 5.10.12
  • react-hook-form: 7.43.2
  • aws-amplify: 5.0.15

コード

今回のコードはこのリポジトリに載せてありますので適宜参考にしてください。
これから簡単に内容を紹介していきます。

ディレクトリ構成

ディレクトリ構成は以下のようになっています。
👈がついている部分が主に追加・修正したファイルになっています。

frontend/
├── components
│  ├── model
│  │  └── Header
│  │     ├── Header.tsx 👈 見た目を少しよくするために用意したヘッダー(特に関係はないです)
│  │     └── index.ts
│  └── page
│     ├── Auth
│     │  ├── AuthBasePage.tsx 👈 認証まわりの画面のガワ
│     │  ├── PasswordChange.form.tsx 👈 「パスワード変更」のフォーム
│     │  ├── PasswordForget.form.tsx 👈 「パスワード忘れ」のフォーム
│     │  ├── PasswordReset.form.tsx 👈 「パスワード再設定」のフォーム
│     │  ├── SignIn.form.tsx 👈 「サインイン」のフォーム
│     │  └── SignInComplete.form.tsx 👈 「初回サインイン完了」のフォーム
│     └── index.ts
├── lib
│  └── cognito-auth.tsx 👈 認証まわりの処理をまとめたファイル
├── next.config.js
├── package-lock.json
├── package.json
├── pages
│  ├── _app.tsx
│  ├── _document.tsx
│  ├── index.tsx
│  ├── password-change
│  │  └── index.tsx 👈 「パスワード変更」を表示
│  ├── password-forget
│  │  └── index.tsx 👈 「パスワード忘れ」と「パスワード再設定」を表示
│  └── signin
│     └── index.tsx 👈 「サインイン」と「初回サインイン完了」を表示
└── tsconfig.json

cognitoの設定

ユーザープールがない場合は、ユーザープールを新規作成した上で、
アプリケーションクライアントを作成してください。
cognitoのアプリケーションクライアントの設定は以下のようになっています。

  • パブリッククライアント(クライアントシークレットを発行しないクライアント)
  • 認証フローはALLOW_REFRESH_TOKEN_AUTHALLOW_USER_SRP_AUTHのみ

認証用フックの準備

今回の大事なコードの1つであるcognito-auth.tsxについて説明します。
このファイルでは認証の各種関数や状態を管理するようになっています。
このファイルは、参考記事の内容にいくつかの関数を追加しています。

ファイルは長いので、見たい場合はアコーディオンを開いてください。

認証用フックの詳細。
cognito-auth.tsx
import {Auth, Amplify} from 'aws-amplify';
import React, {createContext, useContext, useEffect, useState} from 'react';

const AwsConfigAuth = {
  region: process.env.NEXT_PUBLIC_COGNITO_REGION,
  userPoolId: process.env.NEXT_PUBLIC_COGNITO_USER_POOL_ID,
  userPoolWebClientId: process.env.NEXT_PUBLIC_COGNITO_WEB_CLIENT_ID,
  authenticationFlowType: 'USER_SRP_AUTH',
}

Amplify.configure({Auth: AwsConfigAuth});

interface UseAuth {
  isLoading: boolean;
  isAuthenticated: boolean;
  username: string;
  currentAuthenticatedUser: () => Promise<any>;
  signUp: (username: string, password: string) => Promise<Result>;
  confirmSignUp: (verificationCode: string) => Promise<Result>;
  signIn: (username: string, password: string) => Promise<Result>;
  signInComplete: (username: string, oldPassword: string, newPassword: string) => Promise<Result>;
  signOut: () => void;
  changePassword: (user: any, oldPassword: string, newPassword: string, newPasswordConfirm: string) => Promise<Result>;
  forgetPassword: (email: string) => Promise<Result>;
  resetPassword: (username: string, code: string, newPassword: string, newPasswordConfirm: string) => Promise<Result>;
}

interface Result {
  success: boolean
  message: string
  hasChallenge?: boolean
  challengeName?: string
}

const authContext = createContext({} as UseAuth);

export const ProvideAuth: React.FC<{ children: React.ReactNode }> = ({children}) => {
  const auth = useProvideAuth();
  return <authContext.Provider value={auth}> {children} </authContext.Provider>;
};

export const useAuth = () => {
  return useContext(authContext);
};

const useProvideAuth = (): UseAuth => {
  const [isLoading, setIsLoading] = useState(true);
  const [isAuthenticated, setIsAuthenticated] = useState(false);
  const [username, setUsername] = useState('');
  const [password, setPassword] = useState('');

  useEffect(() => {
    Auth.currentAuthenticatedUser()
      .then((result) => {
        setUsername(result.username);
        setIsAuthenticated(true);
        setIsLoading(false);
      })
      .catch(() => {
        setUsername('');
        setIsAuthenticated(false);
        setIsLoading(false);
      });
  }, []);

  const signUp = async (username: string, password: string) => {
    try {
      await Auth.signUp({username, password});
      setUsername(username);
      setPassword(password);
      return {success: true, message: ''};
    } catch (error) {
      return {
        success: false,
        message: '認証に失敗しました。',
      };
    }
  };

  const confirmSignUp = async (verificationCode: string) => {
    try {
      await Auth.confirmSignUp(username, verificationCode);
      const result = await signIn(username, password);
      setPassword('');
      return result;
    } catch (error) {
      return {
        success: false,
        message: '認証に失敗しました。',
      };
    }
  };

  const signIn = async (username: string, password: string): Promise<Result> => {
    try {
      const result = await Auth.signIn(username, password);
      const hasChallenge = Object.prototype.hasOwnProperty.call(result, 'challengeName')
      setUsername(result.username);
      setIsAuthenticated(true);
      if (hasChallenge) {
        const challengeName = result.challengeName
        return {success: true, message: '', hasChallenge: true, challengeName};
      }
      return {success: true, message: '', hasChallenge: false}
    } catch (error) {
      return {
        success: false,
        message: '認証に失敗しました。',
      };
    }
  };

  const signInComplete = async (username: string, oldPassword: string, newPassword: string) => {
    try {
      const user = await Auth.signIn(username, oldPassword)
      await Auth.completeNewPassword(user, newPassword, user.challengeParam.requiredAttributes)
      return {
        success: true,
        message: ""
      }
    } catch (error) {
      if (error instanceof Error) {
        if (error.name === "InvalidParameterException" || error.name === "InvalidPasswordException") {
          return {
            success: false,
            message: 'パスワードは英字/数字組み合わせの8桁以上で入力してください。',
          };

        } else if (error.name === "NotAuthorizedException") {
          return {
            success: false,
            message: 'パスワードが間違っています。',
          };

        } else if (error.name === "ExpiredCodeException") {
          return {
            success: false,
            message: '仮パスワードの有効期限が切れています。カスタマーサポートへご連絡ください。',
          };

        } else if (error.name === "AuthError") {
          return {
            success: false,
            message: 'メールアドレスとパスワードを入力してください。',
          };

        } else if (error.name === "UserNotFoundException") {
          return {
            success: false,
            message: 'メールアドレスまたはパスワードが正しくありません。',
          };

        }
      }
      return {
        success: false,
        message: '予期せぬエラーが発生しました。',
      };
    }
  }

  const signOut = async () => {
    try {
      await Auth.signOut();
      setUsername('');
      setIsAuthenticated(false);
      return {success: true, message: ''};
    } catch (error) {
      return {
        success: false,
        message: 'ログアウトに失敗しました。',
      };
    }
  };

  const changePassword = async (user: any, oldPassword: string, newPassword: string, newPasswordConfirm: string) => {
    try {
      if (newPassword === newPasswordConfirm) {
        await Auth.changePassword(user, oldPassword, newPassword);
        return {
          success: true,
          message: '',
        };
      } else {
        return {
          success: false,
          message: '入力した新規パスワードが一致しません。もう一度入力してください。',
        };
      }
    } catch (error) {
      if (error instanceof Error) {
        if (error.name === "NotAuthorizedException") {
          return {
            success: false,
            message: '現在のパスワードが間違っています。',
          };
        } else if (error.name === "LimitExceededException") {
          return {
            success: false,
            message: 'しばらく時間を置いて再度試してください。',
          };
        } else if (error.name === "InvalidPasswordException") {
          return {
            success: false,
            message: 'パスワードは英字(小文字必須)/数字組み合わせの8桁以上で入力してください。',
          };
        } else if (error.name === "InvalidParameterException") {
          return {
            success: false,
            message: 'パスワードを入力してください。',
          };
        }
      }
      return {
        success: false,
        message: 'パスワードを入力してください。',
      };
    }
  }

  const forgetPassword = async (email: string) => {
    const regex = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
    if (regex.test(email)) {

      try {
        await Auth.forgotPassword(email)
        return {
          success: true,
          message: '',
        }

      } catch (error) {
        return {
          success: false,
          message: '予期せぬエラーが発生しました',
        }

      }
    } else {
      return {
        success: false,
        message: 'メールアドレスの形式で入力してください',
      };
    }
  }

  const resetPassword = async (username: string, code: string, newPassword: string, newPasswordConfirm: string) => {
    if (newPassword !== newPasswordConfirm) {
      return {
        success: false,
        message: '入力した新規パスワードが一致しません。もう一度入力してください。'
      }
    }
    try {
      await Auth.forgotPasswordSubmit(username, code, newPassword);
      return {
        success: true,
        message: ""
      }

    } catch (error) {
      if (error instanceof Error) {
        if (error.name === "InvalidParameterException" || error.name === "InvalidPasswordException") {
          return {
            success: false,
            message: 'パスワードは英字(小文字必須)/数字組み合わせの8桁以上で入力してください。',
          };
        } else if (error.name === "AuthError" || error.name === "ExpiredCodeException" || error.name === "LimitExceededException") {
          if (error.message === "Confirmation code cannot be empty") {
            return {
              success: false,
              message: 'コードを入力してください。',
            };
          } else {
            return {
              success: false,
              message: 'コードの有効期限が切れています。再度プロフィール画面から「編集」をクリックしてください。',
            };
          }
        } else if (error.name === "CodeMismatchException") {
          return {
            success: false,
            message: 'コードが間違っています。',
          };
        }
      }
      return {
        success: false,
        message: "予期せぬエラーが発生しました"
      }
    }
  }

  return {
    isLoading,
    isAuthenticated,
    username,
    currentAuthenticatedUser: () => Auth.currentAuthenticatedUser(),
    signUp,
    confirmSignUp,
    signIn,
    signInComplete,
    signOut,
    changePassword,
    forgetPassword,
    resetPassword
  };
};

変更点は、以下の通りです。

  • signInComplete, changePassword, forgetPassword, resetPasswordの関数の追加
    • これによって、必要な処理を実装する
  • currentAuthenticatedUserの追加
    • changePasswordの実行時に必要なuserを取得する

各種認証画面の作成

各種画面は、AuthBasePage.tsxと各種*.form.tsxをそれぞれ組み合わせて作成します。

AuthBasePage.tsxだけでは、以下の内容を表示するようになっており、
各種*.form.tsxがそれぞれの入力フォームになっています。


AuthBasePage.tsxのみで表示される内容

上の画面は以下のコードで実装されています。
(ほとんどこの参考記事の内容がベースになっています)。

AuthBasePage.tsx
import React, {createContext, useContext, useState} from 'react';
import {Alert, Avatar, Grid, Paper, Snackbar, Typography} from "@mui/material";
import {teal} from "@mui/material/colors";
import LockOutlinedIcon from "@mui/icons-material/LockOutlined";

interface UseAuthPage {
  setIsError: (state: boolean) => void
  setErrorMessage: (state: string) => void
}

const authPageContext = createContext({} as UseAuthPage);

export const useAuthPage = () => {
  return useContext(authPageContext);
};

export const AuthBasePage: React.FC<{ title: string, children: React.ReactNode }> = ({title, children}) => {
  const [isError, setIsError] = useState(false);
  const [errorMessage, setErrorMessage] = useState('');

  const value = {
    setIsError,
    setErrorMessage
  }

  return (
    <>
      <Grid>
        <Paper
          elevation={3}
          sx={{
            p: 4,
            height: "70vh",
            width: "280px",
            m: "20px auto"
          }}
        >
          <Grid
            container
            direction="column"
            justifyContent="flex-start" //多分、デフォルトflex-startなので省略できる。
            alignItems="center"
          >
            <Avatar sx={{bgcolor: teal[400]}}>
              <LockOutlinedIcon/>
            </Avatar>
            <Typography variant={"h6"} sx={{m: "30px"}}>
              {title}
            </Typography>
          </Grid>
          <authPageContext.Provider value={value}>
            {children}
          </authPageContext.Provider>

        </Paper>
      </Grid>
      {/*メッセージ*/}
      <Snackbar open={isError} autoHideDuration={null}>
        <Alert onClose={() => setIsError(false)} severity="error" sx={{width: '100%'}}>
          {errorMessage}
        </Alert>
      </Snackbar>
    </>
  )
}

認証まわりの画面に共通感を持たせるために、ガワだけのコンポーネントとして作成しています。
そして、その中にchildrenとして各種フォームコンポーネントを組み込める形にしています。

useContextは子コンポーネントで生じたフォームエラーのメッセージを、このコンポーネントに伝播させています。
どのように画面に表示させるか次第ですが、react-hook-formのエラー機能を利用したら、不要かもしれないです。
本サンプルでは、画面左下に表示されます。


エラーメッセージの表示例(サインイン画面)

サインイン画面の作成

一例としてサインイン画面の構成について見ていきます。
利用するのは、SignIn.form.tsxです。
このtsxファイルでは、フォームのみを管理しています。


サインイン画面(再掲)

SignIn.form.tsx
import React, {useState} from 'react';
import {useAuth} from '@/lib/cognito-auth';
import {useRouter} from 'next/router';
import {
  Box,
  Button,
  Link,
  TextField,
  Typography,
} from "@mui/material";
import {useForm, Controller} from "react-hook-form";
import {useAuthPage} from './AuthBasePage';

export const SignInForm: React.FC<{setSignInCompleteRequired: (state: boolean) => void}> = ({setSignInCompleteRequired}) => {
  const auth = useAuth();
  const authPage = useAuthPage()
  const router = useRouter();
  const [buttonDisabled, setButtonDisabled] = useState(false)
  const {control, handleSubmit, getValues} = useForm({
    defaultValues: {
      username: "",
      password: ""
    }
  });

  const executeSignIn = async () => {
    const username = getValues("username")
    const password = getValues("password")
    const result = await auth.signIn(username, password);
    if (result.hasChallenge) {
      if (result.challengeName === "NEW_PASSWORD_REQUIRED") {
        setSignInCompleteRequired(true)
      }
    } else if (result.success) {
      await router.push({
        pathname: '/'
      });
    } else {
      setButtonDisabled(false)
      authPage.setIsError(true)
      authPage.setErrorMessage(result.message)
    }
  };

  const onSubmit = async () => {
    setButtonDisabled(true)
    authPage.setIsError(false)
    await executeSignIn();
  };
  return (
    <>
      <form onSubmit={handleSubmit(onSubmit)}>
        <Controller
          name="username"
          control={control}
          render={({field}) => <TextField
            {...field}
            label="Username"
            variant="standard"
            fullWidth
            required
          />}
        />
        <Controller
          name="password"
          control={control}
          render={({field}) => <TextField
            {...field}
            type="password"
            label="Password"
            variant="standard"
            fullWidth
            required
          />}
        />
        <Box mt={3}>
          <Button
            type="submit"
            color="primary"
            variant="contained"
            fullWidth
            disabled={buttonDisabled}
          >
            サインイン
          </Button>
        </Box>
      </form>
      <Box mt={3}>
        <Typography variant="caption">
          <Link href="/password-forget">パスワードを忘れましたか?</Link>
        </Typography>
      </Box>
    </>
  )
}

SignIn.form.tsxができたら、AuthBasePage.tsxと組み合わせます。
そうすることで、上のような画面になります。
また、サインイン画面はSignInComplete.form.tsxの内容も組み合わせて、
初回ログイン時のパスワード変更要求にも応えられるようにしています。

pages/signin/index.tsx
import type {NextPage} from 'next'
import React, {useState} from 'react';
import {SignInForm, AuthBasePage, SignInCompleteForm} from '@/page';

const Home: NextPage = () => {
  const [signInCompleteRequired, setSignInCompleteRequired] = useState(false)
  return (
    <>
      <AuthBasePage title={"サインイン"}>
        {
          signInCompleteRequired
            ? <SignInCompleteForm/>
            : <SignInForm setSignInCompleteRequired={setSignInCompleteRequired}/>
        }

      </AuthBasePage>
    </>
  )
}

export default Home

その他の画面について

構成としては、サインイン画面と同じなので詳細は省きます。
詳しくはリポジトリの方を参照するようにお願いいたします。
以下に作成できる画面を乗せておきます。

AuthBasePage.tsxPasswordForget.form.tsxを組み合わせた画面。
/password-forgetに遷移すると表示されます。


パスワード忘れ画面

AuthBasePage.tsxPasswordReset.form.tsxを組み合わせた画面。
/password-forgetに遷移後、メールアドレスを入力してボタンを押下すると遷移します)。


パスワード再設定画面

AuthBasePage.tsxPasswordChange.form.tsxを組み合わせた画面。
/password-changeに遷移すると表示されます。


パスワード変更画面

CloudFrontにデプロイする

作成したサービスは、以下の記事を参考にしてもらうとCloudFrontなどにデプロイできます。
セキュリティ的にも比較的高くデプロイできるのでおすすめです!

https://zenn.dev/gsy0911/articles/69017f1ed7c3cc

おわりに

サインイン画面やそのほかの認証まわりに必要な処理と画面について紹介しました。
誰かの助けになれば嬉しいです!

また、参考に載せてある記事も大変有用なので、是非合わせてご覧ください!

参考

GitHubで編集を提案

Discussion

ログインするとコメントできます