オープンソース

  1. サーバ構築のデージーネットTOP
  2. OSS情報
  3. デージーネットのOSS
  4. KC-MailAuth
一覧へ

3. KC-MailAuth運用方法

3.1. 運用中の設定内容を変更する

KC-MailAuthの運用中、ワンタイムコードの長さや文字種などを変更したくなった場合は、環境設定ファイルの内容を編集します。
設定変更できる項目については、設定ファイルを配置・編集する を参照してください。

設定変更した場合でも、Keycloakの再ビルド・再起動は不要です。
設定変更した内容は、次回の認証時に有効になります。

3.2. 認証に失敗した場合の対処法

KC-MailAuthでは、システムエラーが発生した場合は、以下の画面が表示されます。
_images/syserr.png

ワンタイムコードによる認証に失敗した場合は、ワンタイムコード入力画面内に「One-time code is invalid.」というエラーメッセージが表示されます。
ワンタイムコードの不一致・ワンタイムコードの期限切れ・認証の試行回数上限超過など、いずれの場合でも表示されるエラーメッセージは同じです。
_images/otp_invalid.png

また、システムエラーが発生した場合や、認証の試行回数上限を超えたユーザがいた場合、Keycloak標準のログにエラーメッセージが出力されます。（どこに出力されるかはKeycloakのロギング設定によります）
KC-MailAuthが正常に動かない・利用者から問い合わせがあった場合は、原因がログに出力されている可能性があるので確認をしてください。

例として、環境設定ファイルの記載内容に不正があった場合、以下のようなメッセージがログに出力されます。
KC-MailAuth: 'otp.length' is invalid.

認証の試行回数上限を超えたユーザがいた場合、以下のようなメッセージがログに出力されます。
KC-MailAuth: Exceeded authentication limit. [ユーザやIPアドレスなどの接続元情報]
一覧へ