テーマにパスキーの設定ページと本人確認ページを作る
この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です
このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。
会員がパスキーを登録・削除するための「パスキー設定」のページと、その前に求める「本人確認」のページのテンプレートです。どちらも member テーマのテンプレートから、説明のためのコメントだけを除いたものです。サインイン画面は テーマにパスキーのログインを組み込む を参照してください。
プロフィール変更のページからリンクする
member テーマでは、_member/update-profile.html の「パスワード」の下に、二段階認証とパスキーの欄を置いています。パスキーの欄は、二段階認証を使わないサイトでもパスキーだけを使うことがあるため、Member_Tfa_Check モジュールの外に置きます。
<!-- BEGIN_MODULE Member_Tfa_Check -->
<li class="form-group">
<div class="form-label">2段階認証</div>
<div class="form-control">
<!-- BEGIN_IF [{step}/eq/unregistered] -->
<p class="form-private"><span class="acms-icon acms-icon-lock"></span>設定していません</p>
<a href="%{BLOG_URL}%{TFA_UPDATE_SEGMENT}" class="button is-bordered is-rounded is-sm">設定する</a>
<!-- END_IF -->
<!-- BEGIN_IF [{step}/eq/registered] -->
<p class="form-private"><span class="acms-icon acms-icon-lock"></span>設定済み</p>
<a href="%{BLOG_URL}%{TFA_UPDATE_SEGMENT}" class="button is-bordered is-rounded is-sm">編集する</a>
<!-- END_IF -->
</div>
</li>
<!-- END_MODULE Member_Tfa_Check -->
<li class="form-group">
<div class="form-label">パスキー</div>
<div class="form-control">
<a href="%{BLOG_URL}%{PASSKEY_UPDATE_SEGMENT}" class="button is-bordered is-rounded is-sm">設定する</a>
</div>
</li>member テーマでは、この部分を Touch_UpdatePassword モジュールの中(パスワードを変更できる利用者にだけ出す範囲)に置いています。
パスキー設定のページの完全な例
テンプレートは themes/(テーマ)/_member/update-passkey.html に置きます。Member_Update_Passkey モジュールを使います。
@extends("/_layouts/member.html")
@section("page-title")
@include("/include/global/page-title.html", {"title": "パスキー設定", "add_class":"acms-text-center"})
@endsection
@section(main)
<!-- BEGIN_MODULE Member_Update_Passkey -->
<div class="container-md">
<section class="form-section">
<p class="form-message">パスキーを使うと、パスワードの代わりに指紋・顔・PIN などでログインできます。</p>
<!-- BEGIN passkeyInsecure -->
<div role="alert" class="acms-alert acms-alert-warning">パスキーは https でのみ利用できます。</div>
<!-- END passkeyInsecure -->
<!-- BEGIN passkeyDisabled -->
<div role="alert" class="acms-alert acms-alert-warning">パスキーは現在利用できません。サイト管理者にお問い合わせください。</div>
<!-- END passkeyDisabled -->
<!-- BEGIN passkey -->
<div class="acms-form js-acms-passkey" data-passkey-context="member">
<ul class="form-group-list is-narrow">
<li class="form-group">
<!-- BEGIN singleCredentialNotice -->
<div role="alert" class="acms-alert acms-alert-warning">
パスキーが1つだけ登録されています。端末を紛失したときに備えて、別の端末にも登録することをおすすめします。
</div>
<!-- END singleCredentialNotice -->
<div role="alert" aria-live="polite" class="js-acms-passkey-message"></div>
<!-- BEGIN verified -->
<div class="acms-alert acms-alert-info">本人確認が完了しました。もう一度操作してください。</div>
<!-- END verified -->
<div class="form-label">パスキー</div>
<div class="form-control">
<!-- BEGIN passkeyRegistered -->
<p class="form-private"><span class="acms-icon acms-icon-lock"></span>設定済み</p>
<!-- END passkeyRegistered -->
<!-- BEGIN passkeyUnregistered -->
<p class="form-private"><span class="acms-icon acms-icon-lock"></span>設定していません</p>
<!-- END passkeyUnregistered -->
<!-- BEGIN passkeyRegister -->
<div class="js-acms-passkey-register" hidden>
<button type="button" class="button is-lg is-width-lg form-button js-acms-passkey-add">パスキーを登録</button>
</div>
<!-- END passkeyRegister -->
</div>
</li>
<li class="form-group">
<div class="form-label">登録済みのパスキー</div>
<!-- BEGIN credential:loop -->
<div class="form-control js-acms-passkey-item">
<button
type="button"
class="button is-bordered is-rounded is-sm js-acms-passkey-rename"
data-credential-id="{credentialId}"
title="クリックして名前を変更"
>{label}</button>
<p class="form-helper-text">
登録: {created}
<!-- BEGIN_IF [{lastUsed}/nem] -->
/ 最終利用: {lastUsed}
<!-- END_IF -->
</p>
<button type="button" class="button is-danger is-sm js-acms-passkey-delete" data-credential-id="{credentialId}">削除</button>
</div>
<!-- END credential:loop -->
<!-- BEGIN noCredential -->
<p class="form-helper-text">登録済みのパスキーはありません。</p>
<!-- END noCredential -->
</li>
</ul>
</div>
<!-- END passkey -->
<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_Passkey -->
@endsectionブロック・変数 | 表示する条件・内容 |
|---|---|
| サイトの設定は有効だが、https でアクセスしていないとき |
| サイトの設定でパスキーを無効にしているとき |
| 登録できるとき、または登録済みのパスキーがあるとき |
| 登録できるとき(サイトの設定が有効で、https でアクセスしている)。中のボタンは JavaScript がブラウザの対応を確かめてから表示します |
| 本人確認のページから戻ってきたとき(本人確認が有効なあいだ) |
| 登録できて、パスキーが 1 つだけのとき |
| パスキーを登録しているか |
| 登録済みのパスキー。 |
| 登録済みのパスキーが無いとき |
名前のボタン(
.js-acms-passkey-rename)を押すと、名前を入力する欄が出て、その場で変えられます。削除のボタン(
.js-acms-passkey-delete)を押すと、「このパスキーを削除しますか?」と確認します。会員と管理ユーザーのどちらとして扱うかは、利用者の権限で決まります。管理画面にログインできる利用者がこのページを開いた場合は、「パスキーでの管理ログイン」の設定に従います。
本人確認のページの完全な例
テンプレートは themes/(テーマ)/_member/verify.html に置きます。Member_Verify モジュールを使います。手段ごとにブロックと POST モジュールが分かれています。
@extends("/_layouts/member.html")
@section("page-title")
@include("/include/global/page-title.html", {"title": "本人確認", "add_class":"acms-text-center"})
@endsection
@section(main)
<!-- BEGIN_MODULE Member_Verify -->
<div class="container-md">
<section class="form-section">
<!-- BEGIN verified -->
<p class="form-message">本人確認は完了しています。元のページに戻って操作を続けてください。</p>
<!-- BEGIN_IF [{redirectUrl}/nem] -->
<div class="form-button-group">
<a href="{redirectUrl}" class="button is-lg is-width-lg form-button">元のページに戻る</a>
</div>
<!-- END_IF -->
<!-- END verified -->
<!-- BEGIN selectMethod -->
<p class="form-message">続けるには、本人確認の方法を選んでください。</p>
<!-- END selectMethod -->
<!-- BEGIN secondFactor -->
<p class="form-message">2段階認証を設定しているため、もう1つの方法でも確認します。</p>
<!-- END secondFactor -->
<form action="" method="post" enctype="multipart/form-data" class="acms-form">
<div class="form-group-list is-narrow">
<div class="form-group">
@include("/_member/parts/error.html")
<!-- BEGIN_IF [{method:validator#available}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">この方法では本人確認できません。別の方法を選んでください。</div>
<!-- END_IF -->
<!-- BEGIN_IF [{code:validator#secretKey}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">2段階認証の秘密鍵を復号できなかったため、認証アプリでは本人確認できません。サインアウトしてから、リカバリーコードで2段階認証を解除してください。リカバリーコードがない場合は、管理者にお問い合わせください。</div>
<!-- END_IF -->
<!-- BEGIN_IF [{code:validator#resendTooSoon}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">確認コードは送信済みです。しばらくしてから再送信してください。</div>
<!-- END_IF -->
<!-- BEGIN_IF [{code:validator#sendFailed}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">確認コードを送信できませんでした。</div>
<!-- END_IF -->
<!-- BEGIN_IF [{verify:validator#lock}/eq/0] -->
<div role="alert" class="acms-alert acms-alert-danger">本人確認に続けて失敗したため、一時的に操作できません。時間をおいてもう一度お試しください。</div>
<!-- END_IF -->
<!-- BEGIN codeSent -->
<div class="acms-alert acms-alert-info">登録しているメールアドレスに確認コードを送信しました。</div>
<!-- END codeSent -->
<!-- BEGIN noMethod -->
<p class="form-helper-text">本人確認に使える方法がありません。管理者にお問い合わせください。</p>
<!-- END noMethod -->
<!-- BEGIN switched -->
<p class="form-helper-text">ユーザーを切り替えている間は、本人確認ができません。元のユーザーに戻してから操作してください。</p>
<!-- END switched -->
</div>
</div>
<!-- BEGIN method:loop -->
<div class="form-button-group">
<a href="{url}" class="button is-bordered is-lg is-width-lg form-button">
<!-- BEGIN passkey -->パスキーを使う<!-- END passkey -->
<!-- BEGIN password -->パスワードを使う<!-- END password -->
<!-- BEGIN email -->メールを使う<!-- END email -->
</a>
</div>
<!-- END method:loop -->
<!-- BEGIN verifyPassword -->
<ul class="form-group-list is-narrow">
<li class="form-group">
<div class="form-label">
<label class="acms-form-block acms-clear" for="input-password-verify">パスワード</label>
</div>
<div class="form-control">
<input type="password" name="password" value="" id="input-password-verify" class="acms-form-large acms-form-block acms-form-width-full" autocomplete="current-password" required>
<input type="hidden" name="verify[]" value="password">
<p class="form-helper-text">続けるには、ログインパスワードを入力してください。</p>
<div role="alert" class="validator-result-{password:validator#auth} form-error-text">
<i class="acms-icon acms-icon-news"></i>
<span>パスワードが正しくありません。</span>
</div>
</div>
</li>
</ul>
<div class="form-button-group">
<button type="submit" name="ACMS_POST_Member_Verify_Password" class="button is-lg is-width-lg form-button">確認する</button>
</div>
<!-- END verifyPassword -->
<!-- BEGIN verifyTotp -->
<ul class="form-group-list is-narrow">
<li class="form-group">
<div class="form-label">
<label class="acms-form-block acms-clear" for="input-text-verify-totp">認証アプリのコード</label>
</div>
<div class="form-control">
<input type="text" name="code" value="" id="input-text-verify-totp" class="acms-form-large acms-form-block acms-form-width-full" inputmode="numeric" autocomplete="one-time-code" required>
<input type="hidden" name="verify[]" value="code">
<p class="form-helper-text">続けるには、認証アプリに表示されているコードを入力してください。</p>
<div role="alert" class="validator-result-{code:validator#auth} form-error-text">
<i class="acms-icon acms-icon-news"></i>
<span>コードが正しくありません。</span>
</div>
</div>
</li>
</ul>
<div class="form-button-group">
<button type="submit" name="ACMS_POST_Member_Verify_Totp" class="button is-lg is-width-lg form-button">確認する</button>
</div>
<!-- END verifyTotp -->
<!-- BEGIN verifyEmailSend -->
<p class="form-message">続けるには、登録しているメールアドレスに確認コードを送り、本人確認をします。</p>
<div class="form-button-group">
<button type="submit" name="ACMS_POST_Member_Verify_EmailSend" class="button is-lg is-width-lg form-button" formnovalidate>確認コードを送信</button>
</div>
<!-- END verifyEmailSend -->
<!-- BEGIN verifyEmailCode -->
<ul class="form-group-list is-narrow">
<li class="form-group">
<div class="form-label">
<label class="acms-form-block acms-clear" for="input-text-verify-code">確認コード</label>
</div>
<div class="form-control">
<input type="text" name="code" value="" id="input-text-verify-code" class="acms-form-large acms-form-block acms-form-width-full" autocomplete="one-time-code" autocapitalize="characters" spellcheck="false" required>
<input type="hidden" name="verify[]" value="code">
<p class="form-helper-text">メールに記載された確認コードを入力してください。</p>
<div role="alert" class="validator-result-{code:validator#auth} form-error-text">
<i class="acms-icon acms-icon-news"></i>
<span>確認コードが正しくありません。</span>
</div>
</div>
</li>
</ul>
<div class="form-button-group">
<button type="submit" name="ACMS_POST_Member_Verify_Email" class="button is-lg is-width-lg form-button">確認する</button>
<button type="submit" name="ACMS_POST_Member_Verify_EmailSend" class="button is-bordered is-lg is-width-lg form-button" formnovalidate>確認コードを再送する</button>
</div>
<!-- END verifyEmailCode -->
<!-- BEGIN verifyPasskey -->
<p class="form-message">続けるには、登録済みのパスキーで本人確認をします。指紋・顔・PIN などで確認してください。</p>
<div class="js-acms-passkey-tfa" data-passkey-context="member" data-challenge-id="{challengeId}" data-options="{options}">
<div role="alert" aria-live="polite" class="js-acms-passkey-tfa-message"></div>
<div role="alert" class="validator-result-{passkey:validator#auth} 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="verify[]" value="code">
<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_Verify_Passkey">パスキーで確認する</button>
</div>
<p class="form-helper-text js-acms-passkey-tfa-unsupported" hidden>このブラウザではパスキーを利用できません。別の方法を選んでください。</p>
</div>
<!-- END verifyPasskey -->
<!-- BEGIN verifyTfaPasskey -->
<p class="form-message">登録済みのパスキーで、2段目の確認をします。指紋・顔・PIN などで確認してください。</p>
<div class="js-acms-passkey-tfa" data-passkey-context="member" data-challenge-id="{challengeId}" data-options="{options}">
<div role="alert" aria-live="polite" class="js-acms-passkey-tfa-message"></div>
<div role="alert" class="validator-result-{passkey:validator#auth} 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="verify[]" value="code">
<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_Verify_TfaPasskey">パスキーで確認する</button>
</div>
<p class="form-helper-text js-acms-passkey-tfa-unsupported" hidden>このブラウザではパスキーを利用できません。別の方法を選んでください。</p>
</div>
<!-- END verifyTfaPasskey -->
</form>
<!-- BEGIN selectOther -->
<div class="form-button-group">
<a href="{url}" class="button is-bordered is-lg is-width-lg form-button">別の方法を選ぶ</a>
</div>
<!-- END selectOther -->
<!-- BEGIN alternative:loop -->
<div class="form-button-group">
<a href="{url}" class="button is-bordered is-lg is-width-lg form-button">
<!-- BEGIN passkey -->パスキーを使う<!-- END passkey -->
<!-- BEGIN totp -->認証アプリを使う<!-- END totp -->
<!-- BEGIN email -->メールを使う<!-- END email -->
</a>
</div>
<!-- END alternative:loop -->
<!-- BEGIN restart -->
<div class="form-button-group">
<a href="{url}" class="button is-bordered is-lg is-width-lg form-button">最初からやり直す</a>
</div>
<!-- END restart -->
</section>
</div>
<!-- END_MODULE Member_Verify -->
@endsectionブロックと POST モジュール
ブロック | 表示する条件・内容 | ボタンの POST モジュール |
|---|---|---|
| 本人確認が済んでいるとき。 | — |
| 1 段目の確認方法を選ぶとき。 | — |
| パスワードで確認する |
|
| メールで確認コードを送る |
|
| 送った確認コードを入力する |
|
| パスキーで確認する。 |
|
| 2 段目の確認をするとき(案内の文言) | — |
| 2 段目に認証アプリで確認する |
|
| 2 段目にパスキーで確認する |
|
| 2 段目のほかの手段へのリンク( | — |
| 「別の方法を選ぶ」「最初からやり直す」のリンク( | — |
| 確認コードを送ったとき | — |
| 使える方法が無いとき | — |
| ユーザーを切り替えているとき | — |
エラーの表示
変数 | 意味 |
|---|---|
| 選んだ方法では本人確認できない |
| パスワードが違う |
| コード(認証アプリ・確認コード)が違う |
| 認証アプリの秘密鍵を復号できない |
| 確認コードの再送の間隔が短い |
| 確認コードを送れなかった |
| パスキーで確認できなかった |
| 失敗が続いたためロックしている |
動作の流れ
会員が「パスキー設定」のページで「パスキーを登録」を押します。
本人確認が済んでいなければ、JavaScript が本人確認のページ(
/mypage/verify/)へ移動します。会員が確認方法を選び(
?method=passwordなどの URL に移ります)、確認します。確認が済むと元のページへ戻り、
verifiedブロックの「本人確認が完了しました。もう一度操作してください。」を表示します。会員がもう一度「パスキーを登録」を押すと、ブラウザの登録の画面が開きます。
よくある質問・つまずき
症状 | 原因と確かめ方 |
|---|---|
「パスキーを登録」のボタンが出ない |
|
本人確認から戻らない |
|
本人確認のページで、パスキーのボタンが動かない |
|
プロフィール変更のページにパスキーの欄が出ない | リンクを |