二段階認証でメール認証を使う


この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です

このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。

これまでの二段階認証は、認証アプリ(Google Authenticator などの TOTP)だけでした。Ver. 3.3 では、パスワードでログインした後に、登録しているメールアドレスへ確認コードを送る「メール」を、2 段目の手段として選べます。管理画面のログインと、会員のサインインの両方で使えます。

メール認証によるサインインとは別の機能です

メール認証による会員サインイン は、パスワードの代わりにメールでサインインする機能(1 段目)です。このページで説明するのは、パスワードでログインした後の 2 段目にメールを使う機能です。

テーマのテンプレートに組み込む方法は テーマに二段階認証(メール認証)の画面を組み込む を参照してください。

認証アプリ・パスキーとの関係

2 段目の手段は 3 つあり、利用者ごとに「有効」にする手段と、「メイン」(主に使う)手段を選びます。

手段

有効にする方法

備考

認証アプリ

認証アプリにシークレットキーを設定し、認証する(従来どおり)

リカバリーコードは、認証アプリを設定したときに発行します

メール

二段階認証の設定で「メール」を有効にする

確認コードは、利用者のメールアドレスに送ります。メールアドレスの無い利用者は選べません

パスキー

パスキーを登録する(登録すると有効になります)

パスキーのサイトの設定が必要です(パスキーを二段階認証と本人確認に使う)

  • ログインのときは、メインの手段を求めます。メインの手段が使えないとき(認証アプリの秘密鍵を復号できない、メールアドレスが無い、など)は、使えるほかの手段に自動で切り替わります。

  • 認証の画面では、有効にしているほかの手段に「〇〇で認証する」で切り替えられます。

  • 既存の利用者は、メールが無効・メインが認証アプリのままです。アップデートしただけでは、ログインの動きは変わりません。

  • 有効にした手段が 1 つも無い利用者には、2 段目を求めません。

サイトの設定

管理画面の「コンフィグ」で、サイトで使っているコンフィグセットの「ログイン設定」(URL は /bid/{ブログID}/admin/config_login/?setid={コンフィグセットのID})の「セキュリティ」で、「2段階認証」の「設定できるようにする」にチェックを付けます(既定で付いています)。続けて、同じコンフィグセットの「サービス設定」の「メール設定」で、「2段階認証(メール認証)」の From(差出人)を、サイトのドメインのアドレスに変えます(既定は info@example.com)。件名・本文のテンプレートは、変えない場合は既定のままにします。メールの送信の設定(SMTP サーバーなど)で、ほかのメールが届くことも確かめておきます。

「メール設定」の「2段階認証(メール認証)」
「メール設定」の「2段階認証(メール認証)」

メールを使うためだけの、サイト全体の設定はありません。メールを使うかどうかは、利用者ごとに選びます。

利用者の設定

管理ユーザー

自分のユーザー編集画面の「2段階認証」の画面(/bid/{ブログID}/uid/{ユーザーID}/admin/user_tfa/)で、表の「メール」の行の「有効」にチェックを付けて保存します。メールを主に使うなら、同じ行の「メイン」も選びます。

「2段階認証」の画面でメールを有効にする
「2段階認証」の画面でメールを有効にする
  • 「認証アプリ」の有効・無効は、これまでどおり「認証」「設定解除」のボタンで切り替えます(「有効・無効は下の「認証」「設定解除」で切り替えます」)。チェックボックスは状態の表示だけです。

  • 無効にした手段は、メインに指定できません(保存しても、メインは変わりません)。

会員

サインインして、マイページの「2段階認証設定」のページ(/mypage/update-tfa/。member テーマ)の「認証手段」の「メール」の行で、「メール」にチェックを付け、主に使うなら「主に使う」を選んで保存します。

ログインの流れ

  1. メールアドレス(またはユーザー ID)とパスワードでログインします。

  2. メインの手段がメールの利用者には、確認コードのメールを送り、確認コードの入力画面を表示します(「登録されているメールアドレスに確認コードをお送りしました。」)。

  3. メールに書かれた確認コードを入力し、「サインイン」(管理ログインは「認証する」)を押すと、ログインできます。

  • 確認コードは 6 文字の英数字(0〜9 と A〜F)です。大文字・小文字、空白は区別しません。

  • 有効な確認コードは、常に 1 つだけです。再送すると、前のコードは使えなくなります。

  • ログインし直したり、手段を切り替えたりしただけでは、有効なコードがあれば新しいメールを送りません。

  • 「確認コードを再送する」を、再送できる間隔(既定 60 秒)より前に押した場合は、新しいメールを送らず、「すでにお送りした確認コードが有効です。届いたメールのコードを入力してください。」と表示します。

  • メールにはログイン用の URL を書きません。コードを入力しないとログインできません。

  • 認証に成功すると、確認コードは使えなくなります。

確認コードの制限

次の値は、システムの設定ファイル(private/config.system.yaml)で変えられます(管理画面には出ません)。

設定キー

既定値

説明

tfa_email_code_lifetime

10

確認コードの有効時間(分)。1 より小さい値は 1 として扱います

tfa_email_resend_interval

60

確認コードを再送できるようになるまでの間隔(秒)。0 で間隔を制限しません

tfa_email_resend_number

5

この回数、確認コードの送信を要求するとアカウントをロックします(1 未満は 1)

tfa_email_trial_number

5

この回数、確認コードを間違えるとアカウントをロックします(1 未満は 1)

tfa_email_code_lifetime: 15
tfa_email_resend_interval: 60
tfa_email_resend_number: 5
tfa_email_trial_number: 5

回数を数える期間とロックする時間は、「ログイン設定」の「アカウントロック」(login_trial_time)と「アカウントロック時間」(login_lock_time)を使います。

  • 失敗は接続元ではなくアカウントごとに数えます。接続元を変えても、回数は戻りません。

  • これとは別に、二段階認証の 2 段目の失敗(すべての手段の合計)も、「アカウントロック」の回数(login_trial_number)でアカウントごとに数えます。

  • ロックしているあいだは、正しいコードでも通しません。確認コードも送りません。

メールの設定とテンプレート

管理画面の「コンフィグ」>「メール設定」の「2段階認証(メール認証)」で、差出人と、件名・本文のテンプレートを指定します。

項目(画面の名前)

設定キー

既定値

From

mail_tfa_email_from

info@example.com

件名テンプレート

mail_tfa_email_tpl_subject

mail/tfa-email/subject.txt

本文テンプレート(TEXT)

mail_tfa_email_tpl_body

mail/tfa-email/body.txt

本文テンプレート(HTML)

mail_tfa_email_tpl_body_html

mail/tfa-email/body.html

テンプレートは、テーマのディレクトリから探し、無ければ system テーマのものを使います。文面を変えるときは、themes/(テーマ)/mail/tfa-email/ に同じ名前のファイルを置きます。本文(HTML)のテンプレートを空にすると、テキストだけのメールになります。From・件名・本文(TEXT)のどれかが空だと、メールを送りません。

使える変数

変数

内容

{verifyCode}

確認コード(例 3FA09C)

{codeLifetime}

有効時間(分)。tfa_email_code_lifetime の値

%{BLOG_NAME} / %{ROOT_BLOG_NAME} など

グローバル変数。既定の件名で使っています

件名(mail/tfa-email/subject.txt)

2段階認証の確認コード [ <!-- BEGIN_IF [%{BLOG_NAME}/neq/%{ROOT_BLOG_NAME}] -->%{BLOG_NAME} | <!-- END_IF -->%{ROOT_BLOG_NAME} ]

本文・テキスト(mail/tfa-email/body.txt)

2段階認証の確認コードをお知らせします。

ログイン画面に以下のコードを入力してください。

{verifyCode}

このコードは {codeLifetime} 分間有効です。
有効期限が切れた場合は、ログイン画面から確認コードを再送信してください。

※このメールに心当たりがない場合、第三者があなたのパスワードを知っている可能性があります。
 コードは入力せず、パスワードの変更をおすすめします。

※本メールはシステムからの自動配信メールです。

本文・HTML(mail/tfa-email/body.html)

@extends("/_layouts/mail-system.html")

@section("body")
      <div class="content-body">
        <h1 class="title">2段階認証の確認コード</h1>

        <p>ログイン画面に以下のコードを入力してください。</p>

        <div class="code-wrap">
          <div class="code">{verifyCode}</div>
        </div>

        <p class="supplement">このコードは {codeLifetime} 分間有効です。<br>
        有効期限が切れた場合は、ログイン画面から確認コードを再送信してください。</p>

        <p class="supplement">※このメールに心当たりがない場合、第三者があなたのパスワードを知っている可能性があります。コードは入力せず、パスワードの変更をおすすめします。</p>

        <p class="supplement">※本メールはシステムからの自動配信メールです。</p>
    </div>
@endsection

HTML の本文は、system テーマのメール用のレイアウト(/_layouts/mail-system.html)を継承しています。

Bcc の設定はありません

ほかのメールには Bcc の設定がありますが、このメールにはありません。確認コードを第三者が受け取れると、パスワードを知っている人が二段階認証を通れてしまうためです。

よくある質問・つまずき

症状

原因と確かめ方

確認コードのメールが届かない

(1) 迷惑メールのフォルダを確かめます。(2) 「メール設定」の「2段階認証(メール認証)」の From・テンプレートが空でないか。(3) メールの送信の設定(SMTP サーバーなど)。(4) 利用者のメールアドレス。送れなかったときは「確認コードのメールを送信できませんでした。」と表示し、「監査ログ」に「2段階認証の確認コードメールの送信に失敗しました」を残します

「すでにお送りした確認コードが有効です。」と出る

有効なコードがあるため、新しいメールを送っていません。届いたメールのコードを入力するか、再送の間隔(既定 60 秒)がたってから「確認コードを再送する」を押します

「試行回数の上限を超えたため、しばらく認証できません。」と出る

確認コードの間違い・再送の要求が上限を超えました。「アカウントロック時間」がたってから試します

確認コードが通らない

メールのコードの有効時間(既定 10 分)が過ぎた、再送して前のコードが使えなくなった、などが考えられます。「確認コードを再送する」で新しいコードを受け取ります

スマートフォンで英字を入力できない

テーマの入力欄に inputmode="numeric" が付いています。確認コードには英字が入るため、外します

二段階認証の設定に「メール」が出ない

利用者にメールアドレスがありません。または、テーマの _member/update-tfa.html に preference ブロックがありません(公式テーマ site の、このアルファ版の時点の update-tfa.html には preference ブロックがありません。テーマに二段階認証(メール認証)の画面を組み込む の例を使ってください)

二段階認証の設定のページが 404 になる

「ログイン設定」の「2段階認証」が無効です

会員の設定を保存すると「不正な操作です」と出る

「ログイン設定」の「一般サインイン機能」が無効です

メールアドレスを消したら、ログインの方法が変わった

メールアドレスの無い利用者はメールを使えないため、有効なほかの手段に切り替わります。ほかに有効な手段が無ければ、2 段目を求めません