WebOTP API を使用してクロスオリジンの iframe 内で OTP フォームに入力する

WebOTP API で iframe 内から OTP を受信できるようになりました。

SMS OTP(ワンタイム パスワード)は、認証の 2 番目のステップやウェブでの支払いの確認など、電話番号の確認によく使用されます。しかし、ブラウザと SMS アプリを切り替えて OTP をコピーして貼り付けるか、手動で入力すると、ミスが発生しやすく、ユーザー エクスペリエンスに摩擦が生じます。

WebOTP API を使用すると、ウェブサイトは SMS メッセージからワンタイム パスワードをプログラムで取得し、アプリを切り替えることなく、ワンタップでユーザーのフォームに自動的に入力できます。SMS は特別にフォーマットされ、オリジンにバインドされているため、フィッシング ウェブサイトが OTP を盗む可能性も軽減されます。

WebOTP でまだサポートされていないユースケースの 1 つは、iframe 内のオリジンをターゲットにすることでした。これは通常、特に 3D セキュアでの支払い確認に使用されます。クロスオリジン iframe をサポートする共通フォーマットが用意されたことで、Chrome 91 以降、WebOTP API はネストされたオリジンにバインドされた OTP を配信するようになりました。

WebOTP API の仕組み

WebOTP API 自体は非常にシンプルです。

…
  const otp = await navigator.credentials.get({
    otp: { transport:['sms'] }
  });
…

SMS メッセージは、オリジンバウンド ワンタイム コードでフォーマットされている必要があります。

Your OTP is: 123456.

@web-otp.example.com #12345

最後の行には、バインドされるオリジン(先頭に @)と、それに続く OTP(先頭に #)が含まれています。

テキスト メッセージが届くと、情報バーがポップアップ表示され、ユーザーに電話番号の確認を求めます。ユーザーが Verify ボタンをクリックすると、ブラウザは自動的に OTP をサイトに転送し、navigator.credentials.get() を解決します。ウェブサイトは OTP を抽出して、確認プロセスを完了できます。

WebOTP の基本的な使用方法については、WebOTP API を使用してウェブで電話番号を確認するをご覧ください。

クロスオリジン iframe のユースケース

クロスオリジンの iframe 内のフォームに OTP を入力することは、支払いシナリオでよくあります。一部のクレジット カード発行会社では、支払人の真正性を確認するために追加の確認手順が必要です。これは 3D セキュアと呼ばれ、フォームは通常、支払いフローの一部であるかのように、同じページの iframe 内に表示されます。

次に例を示します。

  • ユーザーが shop.example にアクセスし、クレジット カードで靴を購入します。
  • クレジット カード番号を入力すると、統合された決済機関が iframe 内に bank.example のフォームを表示し、ユーザーに電話番号の確認を求めて、高速な決済を可能にします。
  • bank.example は、OTP を含む SMS をユーザーに送信し、ユーザーが OTP を入力して本人確認を行えるようにします。

クロスオリジン iframe から WebOTP API を使用する方法

クロスオリジンの iframe 内から WebOTP API を使用するには、次の 2 つのことを行う必要があります。

  • SMS テキスト メッセージに、トップフレームのオリジンと iframe のオリジンの両方をアノテーションします。
  • クロスオリジン iframe がユーザーから直接 OTP を受信できるように権限ポリシーを構成します。
iframe 内で動作する WebOTP API。

デモは https://web-otp-iframe-demo.stackblitz.io でお試しいただけます。

SMS テキスト メッセージにバインドされたオリジンをアノテーションとして追加する

WebOTP API が iframe 内から呼び出される場合、SMS テキスト メッセージには、@ の後にトップフレームのオリジン、# の後に OTP、@ の後に iframe のオリジンを含める必要があります。

@shop.example #123456 @bank.exmple

権限ポリシーを構成する

クロスオリジンの iframe で WebOTP を使用するには、埋め込み元が otp-credentials 権限ポリシーを介してこの API へのアクセスを許可し、意図しない動作を回避する必要があります。一般に、この目標を達成するには次の 2 つの方法があります。

  • HTTP ヘッダー経由:
Permissions-Policy: otp-credentials=(self "https://bank.example")
  • iframe の allow 属性を使用する。
<iframe src="https://bank.example/…" allow="otp-credentials"></iframe>

権限ポリシーを指定する方法のその他の例をご覧ください。

注意点

ネストレベル

現時点では、Chrome は、祖先チェーンに 1 つ以下の一意のオリジンを持つクロスオリジン iframe からの WebOTP API 呼び出しのみをサポートしています。次のシナリオでは、

  • a.com -> b.com
  • a.com -> b.com -> b.com
  • a.com -> a.com -> b.com
  • a.com -> b.com -> c.com

b.com での WebOTP の使用はサポートされていますが、c.com での使用はサポートされていません。

なお、以下のシナリオも、需要が少なく、UX が複雑になるため、サポートされていません。

  • a.com -> b.com -> a.com(WebOTP API を呼び出す)

相互運用性

Chromium 以外のブラウザ エンジンには WebOTP API が実装されていませんが、Safari は input[autocomplete="one-time-code"] のサポートで同じ SMS 形式を共有しています。Safari では、オリジンバウンド ワンタイム コード形式を含む SMS が一致するオリジンとともに到着すると、キーボードが入力フィールドに OTP を入力することを提案します。

2021 年 4 月の時点で、Safari は % を使用した一意の SMS 形式の iframe をサポートしています。しかし、仕様に関する議論の結果、代わりに @ を使用することになったため、サポートされている SMS 形式の実装が収束することを期待しています。

フィードバック

WebOTP API を改善するうえで、皆様からのフィードバックは非常に貴重です。ぜひお試しいただき、ご意見をお寄せください。

リソース