テーマに二段階認証(メール認証)の画面を組み込む


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

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

二段階認証のメール認証を、会員向けのテーマに組み込むテンプレートの書き方です。サインイン画面の 2 段目(tfaEmail ブロック)と、二段階認証の設定のページ(_member/update-tfa.html)を追加します。例は member テーマのテンプレートから、説明のためのコメントだけを除いたものです。機能の説明は 二段階認証でメール認証を使う を参照してください。

組み込むもの

ページ

テンプレート

追加するもの

サインイン(/signin/)

_member/signin.html

tfaEmail ブロック(確認コードの入力)と、各ブロックの切り替えのボタン(tfaAlternative〇〇)

二段階認証の設定(/mypage/update-tfa/)

_member/update-tfa.html

preference ブロック(手段ごとのメイン・有効)と passkeyPreference ブロック

プロフィール変更(/mypage/update-profile/)

_member/update-profile.html

二段階認証の設定へのリンク(従来どおり)

ログイン画面を自作しているテーマは、ブロックを追加してください

対応するブロックが無いテンプレートでは、メール・パスキーの 2 段目の画面に何も表示されず、ログインを続けられません。system テーマ・member テーマには追加済みです。

サインイン画面の完全な例(パスワード+二段階認証)

パスワードでサインインし、2 段目に認証アプリかメールを使うサイト向けに、member テーマの _member/signin.html から、パスキー・メール認証のサインイン・SNS ログインの部分を除いた例です。themes/(テーマ)/_member/signin.html として置きます。パスキーも使う場合は、テーマにパスキーのログインを組み込む の完全な例を使ってください。

@extends("/_layouts/member.html")

@section("header")

@include("/include/global/header.html", {
  "user_name": "off"
})
@endsection

@section("page-title")
@include("/include/global/page-title.html", {"title": "サインイン", "add_class":"acms-text-center"})
@endsection

@section("main")
<!-- BEGIN_MODULE Member_Signin -->
<div class="acms-container">
  <form
    action=""
    method="post"
    class="acms-form"
    enctype="multipart/form-data"
  >
    <!-- BEGIN signin -->
    <div class="acms-entry entry-style entry-style-top">
      <div>
        <div class="acms-text-center">
          <p>
            ログインすると会員限定の情報を閲覧できるようになります。<br />
            <strong>初めての方は<a href="%{BLOG_URL}%{SIGNUP_SEGMENT}/">新規会員登録</a>へ。</strong>
          </p>
        </div>
      </div>
    </div>

    <div class="separate">
      <section class="separate-item">
        <h2 class="heading-md heading-margin-top-none acms-text-center">
          メールアドレスでサインイン
        </h2>

        <!-- BEGIN_IF [{mail:validator#restriction}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          お使いの端末(ブラウザ)からはログインが禁止されています。<br />管理者にお問い合わせ下さい。
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{pass:validator#auth}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          ユーザーIDまたはパスワードが違います
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{mail:validator#notFound}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          ユーザーが存在しません
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{mail:validator#send}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          認証メールの送信に失敗しました
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{mail:validator#lock}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          <!--$1-->{trialNumber}<!--/$1-->回ログインに失敗したため、アカウントがロックされました。
          <!--$1-->{lockTime}<!--/$1-->分後にもう一度試してください。
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{mailAuthSignin:validator#enable}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          メール認証によるサインイン機能は無効です
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{passwordSignin:validator#enable}/eq/0] -->
        <div role="alert" class="acms-alert acms-alert-danger">
          パスワードによるサインイン機能は無効です
        </div>
        <!-- END_IF -->
        <!-- BEGIN badRequest -->
        <div role="alert" class="acms-alert acms-alert-danger">
          不正なアクセスです。
        </div>
        <!-- END badRequest -->

        <!-- BEGIN expired -->
        <div role="alert" class="acms-alert acms-alert-danger">
          有効期限切れのURLです。再度お試しください。
        </div>
        <!-- END expired -->

        @include("/_member/parts/error.html")

        <ul class="form-group-list">
          <li class="form-group">
            <div class="form-label">
              <label class="acms-form-block acms-clear" for="input-text-mail"
                >メールアドレス</label
              >
            </div>
            <div class="form-control">
              <input
                type="text"
                name="mail"
                value="{mail}"
                class="acms-form-large acms-form-block acms-form-width-full js-ready-focus"
                id="input-text-mail"
                placeholder=""
                autocomplete="username"
                data-validator="mail"
              />
              <input type="hidden" name="login[]" value="mail" />
            </div>
          </li>
          <!-- BEGIN_IF [{email_auth_signin}/neq/on] -->
          <li class="form-group">
            <div class="form-label">
              <label class="acms-form-block acms-clear" for="input-password"
                >パスワード</label
              >
              <button
                type="button"
                id="js-toggle-password"
                class="form-toggle-password"
                data-target="#input-password"
                aria-label="パスワードをテキストで表示します。周りに人がいないことを確認して表示してください。"
              >
                パスワードを表示
              </button>
            </div>
            <div class="form-control">
              <input
                type="password"
                name="pass"
                value="{pass}"
                id="input-password"
                class="acms-form-large acms-form-block acms-form-width-full"
                autocomplete="current-password"
              />
              <input type="hidden" name="login[]" value="pass" />
              <input type="hidden" name="redirect" value="%{redirect}" />
              <input type="hidden" name="login[]" value="redirect" />
            </div>
          </li>
          <!-- END_IF -->
        </ul>
        <!-- BEGIN_IF [{email_auth_signin}/neq/on] -->
        <p class="acms-text-center">
          <a
            href="%{BLOG_URL}%{RESET_PASSWORD_SEGMENT}/"
            class="text-link is-color-text is-bold"
            >パスワードをお忘れの方はこちらから</a
          >
        </p>

        <div class="form-button-group">
          <button
            type="submit"
            name="ACMS_POST_Member_Signin"
            class="button is-lg is-width-lg form-button"
          >
            サインイン
          </button>
        </div>
        <!-- END_IF -->

      </section>
    </div>
    <!-- END signin -->

    <!-- BEGIN tfa -->
    <div>
      <!-- BEGIN_IF [{mail:validator#lock}/eq/0] -->
      <div role="alert" class="acms-alert acms-alert-danger">
        {trialNumber}回認証コードの入力に失敗したため、アカウントがロックされました。
        {lockTime}分後にもう一度試してください。
      </div>
      <!-- END_IF -->
      <p class="form-message">認証用アプリに表示されている、認証コードを入力してください。</p>

      <ul class="form-group-list is-narrow">
        <li class="form-group">
          <div class="form-label">
            <label for="input-text-code" class="acms-form-block acms-clear">確認コード</label>
          </div>
          <input
            type="text"
            name="code"
            value="{code}"
            id="input-text-code"
            class="acms-form-large acms-form-block acms-form-width-full"
            data-validator="code"
            placeholder=""
            autocomplete="one-time-code"
            inputmode="numeric"
            pattern="[0-9]*"
            maxlength="6"
          />
          <input type="hidden" name="login[]" value="code" />
          <input type="hidden" name="takeover" value="{signin:takeover}" />

          <div role="alert" class="validator-result-{code:validator#auth} form-error-text">
            <i class="acms-icon acms-icon-news"></i>
            <span>2段階認証コードが違います</span>
          </div>
          <div role="alert" class="validator-result-{code:validator#secretKey} form-error-text">
            <i class="acms-icon acms-icon-news"></i>
            <span>2段階認証の秘密鍵を復号できませんでした。リカバリーコードをお試しください。</span>
          </div>
        </li>
      </ul>
      <p class="acms-text-center">
        <a
          href="%{BLOG_URL}%{TFA_RECOVERY_SEGMENT}/"
          class="text-link is-color-text is-bold"
          >リカバリーコードを使って、2段階認証を無効にする</a
        >
      </p>
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_Auth" class="button is-lg is-width-lg form-button">サインイン</button>
      </div>
      <!-- BEGIN tfaAlternativeTotp -->
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativeTotpSwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativeTotpLabel}で認証する</button>
      </div>
      <!-- END tfaAlternativeTotp -->
      <!-- BEGIN tfaAlternativeEmail -->
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativeEmailSwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativeEmailLabel}で認証する</button>
      </div>
      <!-- END tfaAlternativeEmail -->
      <div class="form-button-group">
        <a href="%{BLOG_URL}%{SIGNIN_SEGMENT}/" class="button is-bordered is-lg is-width-lg form-button">サインイン画面に戻る</a>
      </div>
    </div>
    <!-- END tfa -->

    <!-- BEGIN tfaEmail -->
    <div>
      <p class="form-message">登録されているメールアドレスに確認コードをお送りしました。メールに記載されているコードを入力してください。</p>
      <p class="form-message">心当たりのないメールが届いた場合は、パスワードが第三者に知られている可能性があります。パスワードの変更をおすすめします。</p>

      <!-- BEGIN_IF [{tfaResendTooSoon}/eq/on] -->
      <p class="form-message">すでにお送りした確認コードが有効です。届いたメールのコードを入力してください。</p>
      <!-- END_IF -->

      <ul class="form-group-list is-narrow">
        <li class="form-group">
          <div class="form-label">
            <label for="input-text-code" class="acms-form-block acms-clear">確認コード</label>
          </div>
          <input
            type="text"
            name="code"
            value="{code}"
            id="input-text-code"
            class="acms-form-large acms-form-block acms-form-width-full"
            data-validator="code"
            placeholder=""
            autocomplete="one-time-code"
            maxlength="6"
          />
          <input type="hidden" name="login[]" value="code" />
          <input type="hidden" name="tfaMethod" value="{tfaMethod}" />
          <input type="hidden" name="login[]" value="tfaMethod" />
          <input type="hidden" name="takeover" value="{signin:takeover}" />

          <div role="alert" class="validator-result-{code:validator#auth} form-error-text">
            <i class="acms-icon acms-icon-news"></i>
            <span>確認コードが違います</span>
          </div>
          <div role="alert" class="validator-result-{code:validator#lock} form-error-text">
            <i class="acms-icon acms-icon-news"></i>
            <span>試行回数の上限を超えたため、しばらく認証できません。時間をおいてもう一度お試しください。</span>
          </div>
          <div role="alert" class="validator-result-{code:validator#send} form-error-text">
            <i class="acms-icon acms-icon-news"></i>
            <span>確認コードのメールを送信できませんでした。</span>
          </div>
        </li>
      </ul>
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_Auth" class="button is-lg is-width-lg form-button">サインイン</button>
      </div>
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_Resend" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>確認コードを再送する</button>
      </div>
      <!-- BEGIN tfaAlternativeTotp -->
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativeTotpSwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativeTotpLabel}で認証する</button>
      </div>
      <!-- END tfaAlternativeTotp -->
      <!-- BEGIN tfaAlternativeEmail -->
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativeEmailSwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativeEmailLabel}で認証する</button>
      </div>
      <!-- END tfaAlternativeEmail -->
      <div class="form-button-group">
        <a href="%{BLOG_URL}%{SIGNIN_SEGMENT}/" class="button is-bordered is-lg is-width-lg form-button">サインイン画面に戻る</a>
      </div>
    </div>
    <!-- END tfaEmail -->
  </form>
</div>
<!-- END_MODULE Member_Signin -->
@endsection

ログイン設定で「メール認証でのサインイン」を使わないサイトの例なので、{email_auth_signin} の分岐のうち、メール認証のサインインのボタンは除いています。

tfaEmail ブロックの変数とエラー

変数・ブロック

内容

{tfaResendTooSoon}

再送の間隔より前に再送を求めたとき、または有効なコードがあるため送らなかったときに on

{code}

入力された確認コード(エラーで戻ったとき)

{tfaMethod}

今の 2 段目の手段(email)。hidden で送り返します

{signin:takeover}

1 段目の結果を引き継ぐ値。hidden で送り返します

{code:validator#auth}

確認コードが違う

{code:validator#lock}

試行回数・再送回数の上限を超えてロックしている

{code:validator#send}

メールを送れなかった

{mail:validator#lock}

二段階認証の失敗が「アカウントロック」の回数を超えた({trialNumber}・{lockTime} を使えます)

ボタン

POST モジュール

サインイン(確認コードを送る)

ACMS_POST_Member_Tfa_Auth

確認コードを再送する

ACMS_POST_Member_Tfa_Resend(formnovalidate を付ける)

ほかの手段に切り替える

ACMS_POST_Member_Tfa_SwitchMethod(value に {tfaAlternative〇〇SwitchTo}、formnovalidate を付ける)

  • 確認コードには英字が入るため、入力欄に inputmode="numeric" や pattern="[0-9]*" を付けないでください。autocomplete="one-time-code" と maxlength="6" を付けます。

  • 画面には、心当たりのないメールが届いたときの注意(パスワードの変更のすすめ)を書いておくと親切です。

ほかの手段への切り替え

tfa・tfaEmail・tfaPasskey の各ブロックの中に、切り替えのボタンを置けます。いま表示している手段以外で、利用者が使える手段のブロックだけが表示されます。

ブロック

変数

tfaAlternativeTotp

{tfaAlternativeTotpSwitchTo}(totp)・{tfaAlternativeTotpLabel}(「認証アプリ」)

tfaAlternativeEmail

{tfaAlternativeEmailSwitchTo}(email)・{tfaAlternativeEmailLabel}(「メール」)

tfaAlternativePasskey

{tfaAlternativePasskeySwitchTo}(passkey)・{tfaAlternativePasskeyLabel}(「パスキー」)

tfaAlternativeHeading

切り替え先が 1 つ以上あるときに 1 回だけ表示します(「別の方法で認証する」などの見出し)

<!-- BEGIN tfaAlternativeHeading -->
<p class="form-message acms-text-center">別の方法で認証する</p>
<!-- END tfaAlternativeHeading -->
<!-- BEGIN tfaAlternativeTotp -->
<div class="form-button-group">
  <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativeTotpSwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativeTotpLabel}で認証する</button>
</div>
<!-- END tfaAlternativeTotp -->
<!-- BEGIN tfaAlternativeEmail -->
<div class="form-button-group">
  <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativeEmailSwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativeEmailLabel}で認証する</button>
</div>
<!-- END tfaAlternativeEmail -->
<!-- BEGIN tfaAlternativePasskey -->
<div class="form-button-group">
  <button type="submit" name="ACMS_POST_Member_Tfa_SwitchMethod" value="{tfaAlternativePasskeySwitchTo}" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>{tfaAlternativePasskeyLabel}で認証する</button>
</div>
<!-- END tfaAlternativePasskey -->

二段階認証の設定のページの完全な例

テンプレートは themes/(テーマ)/_member/update-tfa.html に置きます。Member_Update_Tfa モジュールを使います。従来の認証アプリの設定(step#unregistered / step#registered)に、手段ごとの「主に使う」と「有効」を選ぶ preference ブロックと passkeyPreference ブロックを足します。

@extends("/_layouts/member.html")

@section("page-title")

@include("/include/global/page-title.html", {"title": "2段階認証設定", "add_class":"acms-text-center"})
@endsection

@section(main)
<!-- BEGIN_MODULE Member_Update_Tfa -->
<div class="container-md">
  <section class="form-section">
    <p class="form-message">2段階認証設定の変更を行います。</p>

    <!-- BEGIN step#unregistered -->
    <div class="form-group-list is-narrow">
      <div class="form-group">
        <!-- BEGIN success -->
        <div class="acms-alert acms-alert-info">
          2段階認証を解除しました
        </div>
        <!-- END success -->
        <!-- BEGIN_IF [{code:validator#required}/eq/0] -->
        <div class="acms-alert acms-alert-danger">
          認証コードが入力されていません
        </div>
        <!-- ELSE_IF [{code:validator#disagreement}/eq/0] -->
        <div class="acms-alert acms-alert-danger">
          認証に失敗しました。
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{secret:validator#required}/eq/0] -->
        <div class="acms-alert acms-alert-danger">
          シークレットキーがありません。
        </div>
        <!-- END_IF -->
        <!-- BEGIN_IF [{tfa:validator#isOperable}/eq/0] -->
        <div class="acms-alert acms-alert-danger">
          不正な操作です
        </div>
        <!-- END_IF -->
      </div>
    </div>

    <form action="" method="post" class="form-account acms-form" enctype="multipart/form-data">
      <ul class="form-group-list is-narrow">
        <li class="form-group">
          <div class="form-label">
            <div class="acms-form-block acms-clear">認証コード生成用のアプリにシークレットキーを設定します</div>
          </div>
          <p class="form-helper-text">
            <a
              href="https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=ja"
            >Google Authenticator for Android</a>
          </p>
          <p class="form-helper-text">
            <a
              href="https://apps.apple.com/jp/app/google-authenticator/id388497605"
            >Google Authenticator for iOS</a>
          </p>
          <p class="form-helper-text">アプリで以下のQRコードを読み取るか、手動でシークレットキーを設定してください。</p>

          <div class="acms-text-center acms-margin-bottom-small">
            <img src="{qr-image}[allow_dangerous_scheme]" />
          </div>
          <div
            class="acms-form-input-group acms-form-width-large acms-margin-bottom-large"
          >
            <span class="acms-form-side"><i class="acms-icon-config_authorize"></i></span>
            <input
              type="text"
              class="acms-form-large acms-form-block acms-form-width-full"
              value="{secret-txt}"
              readonly
              style="margin-bottom: 0"
            />
          </div>
        </li>

        <li class="form-group">
          <div class="form-label">
            <label for="input-text-code" class="acms-form-block acms-clear">認証コード</label>
          </div>
          <input
            type="text"
            name="code"
            value=""
            id="input-text-code"
            class="acms-form-large acms-form-block acms-form-width-full"
            autocomplete="one-time-code"
            inputmode="numeric"
            pattern="[0-9]*"
            maxlength="6"
            data-validator="code"
          >
          <input type="hidden" name="tfa[]" value="code">
          <input type="hidden" name="secret" value="{secret}" />
          <input type="hidden" name="tfa[]" value="secret" />

          <p class="form-helper-text">認証コード生成アプリに表示されているコードを入力して、認証ボタンを押して認証します。</p>
          <p class="form-helper-text">認証コードは短い時間で変わりますので、すばやく入力してください。</p>
        </li>
      </ul>

      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_Register" class="button is-lg is-width-lg form-button">認証する</button>
      </div>
    </form>
    <!-- END step#unregistered-->

    <!-- BEGIN step#registered-->
    <div class="form-group-list is-narrow">
      <div class="form-group">
        <!-- BEGIN success -->
        <div class="acms-alert acms-alert-info">
          認証に成功しました。
        </div>
        <!-- END success -->
        <!-- BEGIN_IF [{tfa:validator#isOperable}/eq/0] -->
        <div class="acms-alert acms-alert-danger">
          不正な操作です
        </div>
        <!-- END_IF -->
      </div>
    </div>
    <form action="" method="post" class="form-account acms-form" enctype="multipart/form-data">
      <!-- BEGIN success -->
      <ul class="form-group-list is-narrow">
        <li class="form-group">
          <div class="form-label">
            <label for="input-text-recoveryCode" class="acms-form-block acms-clear">リカバリーコード</label>
          </div>
          <p class="form-helper-text">
            リカバリーコードは、一度しか表示されません。必ずここでメモして保管してください。
          </p>
          <p class="form-helper-text">
            認証コードを発行できなくなった場合に、最終手段として以下の「リカバリーコード」を使用して2段階認証を無効にします。
          </p>
          <div
            class="acms-form-input-group acms-form-width-large acms-margin-bottom-large"
          >
            <span class="acms-form-side"><i class="acms-icon-config_authorize"></i></span>
            <input
              type="text"
              class="acms-form-large acms-form-block acms-form-width-full"
              id="input-text-recoveryCode"
              value="{recoveryCode}"
              readonly
              style="margin-bottom: 0"
            />
          </div>
        </li>
      </ul>
      <!-- END success -->
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_Unregister" class="button is-lg is-width-lg is-danger form-button">2段階認証を解除</button>
      </div>
    </form>
    <!-- END step#registered-->

    <!-- BEGIN preference -->
    <form action="" method="post" enctype="multipart/form-data">
      <h2 class="form-message is-bold">認証手段</h2>

      <!-- BEGIN success -->
      <p class="form-message">2段階認証の設定を変更しました。</p>
      <!-- END success -->

      <p class="form-message">使う認証手段と、主に使う手段を選びます。主に使う手段が使えないときは、ログイン時に他の手段へ切り替えて認証できます。</p>

      <ul class="form-group-list is-narrow">

        <li class="form-group">
          <label>
            <input type="radio" name="primaryMethod" value="totp" {primaryTotpChecked} />
            主に使う
          </label>

          <label>
            <!-- BEGIN step#registered -->
            <input type="checkbox" checked disabled />
            <!-- END step#registered -->
            <!-- BEGIN step#unregistered -->
            <input type="checkbox" disabled />
            <!-- END step#unregistered -->
            認証アプリ
          </label>
          <p class="form-helper-text">有効・無効は上の「認証する」「2段階認証を解除」で切り替えます</p>
        </li>

        <li class="form-group">
          <label>
            <input type="radio" name="primaryMethod" value="email" {primaryEmailChecked} />
            主に使う
          </label>
          <label>
            <input type="checkbox" name="enabledMethod[]" value="email" {emailAuthChecked} />
            メール
          </label>
          <p class="form-helper-text">登録されているメールアドレスに確認コードを送って認証します</p>
        </li>
    <!-- END preference -->

        <!-- BEGIN passkeyPreference -->
        <li class="form-group">
          <label>
            <input type="radio" name="primaryMethod" value="passkey" {primaryPasskeyChecked} />
            主に使う
          </label>
          <label>
            <input type="checkbox" name="enabledMethod[]" value="passkey" {passkeyAuthChecked} />
            パスキー
          </label>
          <p class="form-helper-text">
            オフにしても登録済みのパスキーは残ります<br>
            鍵の登録・削除は<a href="%{BLOG_URL}%{PASSKEY_UPDATE_SEGMENT}/" class="text-link">パスキー設定</a>で行います
          </p>
        </li>
        <!-- END passkeyPreference -->

    <!-- BEGIN preference -->
      </ul>
      <input type="hidden" name="tfa[]" value="enabledMethod" />
      <input type="hidden" name="tfa[]" value="primaryMethod" />
      <div class="form-button-group">
        <button type="submit" name="ACMS_POST_Member_Tfa_UpdatePreference" class="button is-lg is-width-lg form-button">設定を保存</button>
      </div>
    </form>
    <!-- END preference -->

    <div class="form-button-group">
      <a href="%{BLOG_URL}%{PROFILE_UPDATE_SEGMENT}/" class="button is-bordered is-lg is-width-lg form-button">プロフィール変更に戻る</a>
    </div>
  </section>
</div>
<!-- END_MODULE Member_Update_Tfa -->
@endsection

ブロック・変数

表示する条件・内容

step#unregistered

認証アプリを設定していないとき。{qr-image}・{secret-txt}・{secret} で QR コードとシークレットキーを出します

step#registered

認証アプリを設定しているとき。設定した直後は success ブロックの中で {recoveryCode}(リカバリーコード)を出します

preference

設定できる手段が 1 つ以上あるとき。テンプレートの中で 2 回(<form> の始まりと終わり)書き、その間に passkeyPreference を置きます

success(preference の中)

設定を保存したとき

{primaryTotpChecked} / {primaryEmailChecked}

メインが認証アプリ / メールのとき checked

{emailAuthChecked}

メールが有効なとき checked

passkeyPreference

パスキーを登録しているときだけ表示します。preference ブロックの中に入れず、別に置きます

{primaryPasskeyChecked} / {passkeyAuthChecked}

メインがパスキーのとき / パスキーが有効なとき checked

  • 送る値は、primaryMethod(totp / email / passkey)と enabledMethod[](email / passkey)です。<input type="hidden" name="tfa[]" value="enabledMethod"> と <input type="hidden" name="tfa[]" value="primaryMethod"> を一緒に送ります。

  • 保存のボタンは name="ACMS_POST_Member_Tfa_UpdatePreference" です。

  • パスキーを登録している利用者のページに passkeyPreference の行が無いと、保存のたびに、パスキーを 2 段目に使わない設定で保存されます。

  • 認証アプリの有効・無効は、チェックボックスではなく「認証する」(ACMS_POST_Member_Tfa_Register)と「2段階認証を解除」(ACMS_POST_Member_Tfa_Unregister)で切り替えます。

管理ログイン画面

管理ログインの画面(system テーマの _member-admin/login.html)にも、tfaEmail ブロックがあります。管理ログインでは POST モジュールの名前に Admin が付きます(ACMS_POST_Member_Admin_Tfa_Auth・ACMS_POST_Member_Admin_Tfa_Resend・ACMS_POST_Member_Admin_Tfa_SwitchMethod)。切り替えのボタンは _member-admin/parts/login/tfa-alternatives.html にまとめています。管理ユーザーの二段階認証の設定は、管理画面の「2段階認証」の画面で行うため、テーマで作る必要はありません。

よくある質問・つまずき

症状

原因と確かめ方

パスワードを入力した後、画面に何も出ない

tfaEmail(メール)・tfaPasskey(パスキー)のブロックがテンプレートにありません

設定のページに「認証手段」の欄が出ない

preference ブロックがありません。または、設定できる手段がありません(メールアドレスが無く、パスキーも未登録で、認証アプリは別の欄)

「主に使う」を選んで保存しても変わらない

無効にした手段(チェックの付いていないメール・パスキー)は、メインに指定できません。チェックを付けてから保存します

公式テーマ site を使っている

site テーマの、このアルファ版の時点の _member/update-tfa.html には、preference ブロックがありません。メールを有効にするには、このページの例で update-tfa.html を置き換えます。サインイン画面は system テーマのもの(対応済み)を使います