オープンソース

一覧へ

1. 概要

1.1. 本ドキュメントについて

このドキュメントは、KC-MailAuthの管理者向けマニュアルです。
  • 本マニュアルは、株式会社デージーネットにより作成されました。

1.2. 本ドキュメントの対象となるソフトウェア

本ドキュメントは、次のバージョンのソフトウェアの動作をもとに執筆されています。
  • KC-MailAuth 1.0
  • OpenJDK(Java) 21
  • Keycloak 26.3.2

KC-MailAuthの動作対象OSは次の通りです。
  • Red Hat Enterprise Linux 9
  • AlmaLinux 9

1.3. KC-MailAuthについて

KC-MailAuthは、Keycloakの認証プロバイダです。
サービスへアクセスする際の認証フローに組み込むことで、ユーザへのメール通知を用いたワンタイムコード認証を実現することができます。
以下のようなワンタイムコード入力画面と、ワンタイムコード通知メールを利用した認証方法となります。

[ワンタイムコード入力画面]

_images/otp_input.png

[ワンタイムコード通知メール]

_images/otp_mail.png

KC-MailAuthによる認証の流れは次の通りです。
_images/kc-mailauth_image.png
  1. Keycloakのユーザ認証画面にて認証を行う
  2. 認証成功後、ワンタイムコード入力画面が表示され、ログインIDに紐づいたメールアドレス宛にワンタイムコード通知メールが送付される
  3. ワンタイムコード通知メールに記載されたワンタイムコードを、ワンタイムコード入力画面に入力し認証を行う
  4. 認証成功後、対象サービスにアクセスできる
一覧へ