テーマにパスキーのログインを組み込む
この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です
このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。
system テーマと公式テーマ member には、パスキーに対応したテンプレートが入っています。会員向けのページを自分のテーマで作っている場合は、このページを参考に、サインイン画面にパスキーのボタンと二段階認証の画面を追加してください。マイページの設定ページと本人確認ページは テーマにパスキーの設定ページと本人確認ページを作る を参照してください。
公式テーマのテンプレートを写すのが確実です
このページの完全な例は、member テーマ(themes/member/_member/)のテンプレートから、説明のためのコメントだけを除いたものです。member テーマのレイアウト(/_layouts/member.html)と部品(/include/global/header.html など)を使っています。ほかのテーマに組み込むときは、@extends と @include をそのテーマのものに置き換えてください。
組み込むページとテンプレート
ページ | URL | テンプレート(設定キー) | URL の定数 |
|---|---|---|---|
サインイン |
|
|
|
パスキー設定 |
|
|
|
本人確認 |
|
|
|
二段階認証の設定 |
|
|
|
管理ログイン |
|
|
|
管理ユーザーの本人確認 |
|
|
|
テーマにテンプレートが無い場合は、system テーマのものを使います。
二段階認証の設定のテンプレートの設定キーは、
tpl_update-fta(fta)です。URL の定数は
config.server.phpで変えられます(既定は表の URL)。テンプレートでは%{PASSKEY_UPDATE_SEGMENT}のように使えます。これらのページは、コンフィグの設定に関係なくページキャッシュを使いません。
パスキーの操作(ブラウザでの認証・登録と、サーバーとの通信)は、公開側の
acms.jsが行います。テーマでacms.jsを読み込んでいることを確かめてください。
JavaScript が使うクラスと属性
次のクラスを持つ要素がページにあると、acms.js が必要な処理を読み込んで動きます。見た目のためのクラスは自由に足せますが、次のクラスと属性は残してください。
用途 | 起点の要素 | 中に置く要素 |
|---|---|---|
ログインのボタン |
|
|
二段階認証・本人確認 |
|
|
パスキー設定 |
|
|
data-passkey-contextは、会員向けのページではmember、管理画面ではadminにします。メッセージを出す要素(
-message)のclassは、JavaScript が書き換えます(acms-alertなどのクラスが付きます)。見た目を変えるときは、外側の要素に指定してください。ボタンは
type="button"にします。押すと JavaScript が今のページの URL へ送信するため、フォームの送信に乗せません。パスキーに対応していないブラウザでは、ログイン・登録のボタンを出しません(
hiddenのまま)。
サインイン画面の完全な例
member テーマの _member/signin.html です。パスワードでのサインイン(signin)、メール認証のサインイン(verifyCode)、二段階認証の各画面(tfa・tfaPasskey・tfaEmail)を 1 つのテンプレートに書きます。パスキーのボタンは @include("/_member/parts/signin/passkey.html") で読み込みます。
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 -->
<!-- BEGIN_IF [{email_auth_signin}/eq/on] -->
<p class="form-button-group">
<button
type="submit"
name="ACMS_POST_Member_SigninWithEmail"
class="button is-lg is-width-lg form-button"
>
確認メールを送信
</button>
</p>
<!-- END_IF -->
@include("/_member/parts/signin/passkey.html")
</section>
@include("/_member/parts/signin/sns.html")
</div>
<!-- END signin -->
<!-- BEGIN verifyCode -->
<div>
<!-- BEGIN successSent -->
<p class="form-message">本人確認のため、確認メールをお送りしました。<br>メールに記載されている確認リンクをクリックするか、下記に確認コードを入力してください。</p>
<!-- END successSent -->
<div class="form-group-list is-narrow">
<div class="form-group">
<!-- BEGIN_IF [{mail:validator#lock}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">
{trialNumber}回ログインに失敗したため、アカウントがロックされました。
{lockTime}分後にもう一度試してください。
</div>
<!-- END_IF -->
<!-- BEGIN_IF [{code:validator#auth}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">
確認コードが違います
</div>
<!-- END_IF -->
<!-- BEGIN_IF [{code:validator#request}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">
不正なアクセスです
</div>
<!-- END_IF -->
<!-- BEGIN_IF [{code:validator#expired}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">
確認コードの有効期限が切れています
</div>
<!-- END_IF -->
</div>
</div>
<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"
placeholder=""
data-validator="code"
autocomplete="one-time-code"
maxlength="6"
>
<input type="hidden" name="login[]" value="code" />
<input type="hidden" name="takeover" value="{signin:takeover}" />
</li>
</ul>
<div class="form-button-group">
<button
type="submit"
name="ACMS_POST_Member_SigninWithVerifyCode"
class="button is-lg is-width-lg form-button"
>
サインイン
</button>
</div>
<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 verifyCode -->
<!-- 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 -->
<!-- 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 -->
<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 tfaPasskey -->
<div>
<p class="form-message">登録済みのパスキーで認証します。指紋・顔・PIN などで確認してください。</p>
<div
class="js-acms-passkey-tfa"
data-passkey-context="member"
data-challenge-id="{tfaPasskeyChallengeId}"
data-options="{tfaPasskeyOptions}"
>
<div role="alert" aria-live="polite" class="js-acms-passkey-tfa-message"></div>
<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>
<input type="hidden" name="code" value="" class="js-acms-passkey-tfa-code" />
<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 class="form-button-group">
<button
type="button"
class="button is-lg is-width-lg form-button js-acms-passkey-tfa-button"
data-submit-name="ACMS_POST_Member_Tfa_Auth"
>
パスキーで認証する
</button>
</div>
<p class="form-message js-acms-passkey-tfa-unsupported" hidden>このブラウザではパスキーを利用できません。別の認証手段をお使いください。</p>
</div>
<!-- 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 -->
<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 tfaPasskey -->
<!-- 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 -->
<!-- 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 -->
<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 -->
@endsectionthemes/(テーマ)/_member/parts/signin/passkey.html
<!-- BEGIN passkey -->
<div class="js-acms-passkey-login" data-passkey-context="member" hidden>
<div role="alert" aria-live="polite" class="js-acms-passkey-login-message"></div>
<div class="form-button-group">
<button type="button" class="button is-bordered is-lg is-width-lg form-button js-acms-passkey-login-button">
パスキーでサインイン
</button>
</div>
<p class="form-message acms-text-center"><small>指紋・顔・PIN などで認証します</small></p>
</div>
<!-- END passkey -->ブロックと変数
ブロック・変数 | 表示する条件・内容 |
|---|---|
| ID・パスワードの入力画面 |
|
|
| メール認証のサインインで、確認コードを入力する画面 |
| 二段階認証で、2 段目が認証アプリのとき |
| 二段階認証で、2 段目がパスキーのとき。 |
| 二段階認証で、2 段目がメールのとき(テーマに二段階認証(メール認証)の画面を組み込む) |
| 切り替え先の手段が 1 つ以上あるとき(「別の方法で認証する」の見出し) |
| 切り替え先の手段ごとのボタン。 |
| 今の 2 段目の手段( |
| 2 段目の画面で、1 段目の結果を引き継ぐ値。hidden で送り返します |
パスキーのボタンは、サインインのフォーム(
<form>)の中に置きます。フォームのredirectの値(閲覧制限のあるページからサインインに来たときの戻り先)が、パスキーでのサインインにも引き継がれます。tfaPasskeyのボタンを押すと、JavaScript が認証の結果を hidden のcodeに入れ、data-submit-nameの POST モジュール(ACMS_POST_Member_Tfa_Auth)でフォームを送信します。tfa・tfaPasskey・tfaEmailのブロックが無いテンプレートでは、その手段の 2 段目の画面に何も表示されず、ログインを続けられません。
管理ログイン画面
管理ログインの画面は、system テーマの _member-admin/login.html です。パスキーのボタンは _member-admin/parts/login/passkey.html、2 段目の切り替えのボタンは _member-admin/parts/login/tfa-alternatives.html を @include で読み込んでいます。テーマで差し替える場合は、system テーマのファイルを写して見た目だけを変えてください。会員のサインイン画面との違いは次のとおりです。
会員のサインイン | 管理ログイン | |
|---|---|---|
テンプレートのモジュール |
|
|
パスキーのボタンの |
|
|
パスキーのボタンを出す設定 | 「パスキーでのサインイン」 | 「パスキーでの管理ログイン」 |
2 段目の認証 |
|
|
確認コードの再送 |
|
|
手段の切り替え |
|
|
themes/system/_member-admin/parts/login/passkey.html
<!-- BEGIN passkey -->
<div class="js-acms-passkey-login" data-passkey-context="admin" hidden>
<p class="acms-admin-login-border-text-outer">
<span class="acms-admin-login-border-text"><!--T-->もしくは<!--/T--></span>
</p>
<div role="alert" aria-live="polite" class="js-acms-passkey-login-message"></div>
<p class="acms-admin-login-action">
<button
type="button"
class="acms-admin-btn-admin acms-admin-btn-block acms-admin-btn-large js-acms-passkey-login-button"
>
<!--T-->パスキーでログイン<!--/T-->
</button>
</p>
<p class="acms-admin-text-center acms-admin-m-0">
<small class="acms-admin-text-helper">
<!--T-->指紋・顔・PIN などで認証します<!--/T-->
</small>
</p>
</div>
<!-- END passkey -->よくある質問・つまずき
症状 | 原因と確かめ方 |
|---|---|
ボタンが表示されない |
|
ボタンを押しても何も起きない | ブラウザの開発者ツールのコンソールに、エラーが出ていないかを確かめます。サインイン画面以外のページにボタンを置いた場合は動きません(今のページの URL へ送信するため) |
2 段目の画面が真っ白になる |
|
公式テーマ site を使っている | site テーマにはサインイン画面のテンプレートが無く、system テーマのもの(パスキー対応済み)を使います |