TotpSecret class

TotpMultiFactorAssertion を生成するためのプロバイダ。

共有秘密鍵とその他のパラメータを保存して、時間ベースの OTP を生成します。共有秘密鍵を取得し、QR コード URL を生成するメソッドを実装します。

署名:

export declare class TotpSecret 

プロパティ

プロパティ	修飾キー	タイプ	説明
codeIntervalSeconds		数値	OTP コードを変更する間隔（秒単位）。
codeLength		数値	生成されるワンタイム パスワードの長さ。
enrollmentCompleteDeadline		文字列	TOTP 登録の完了期限のタイムスタンプ（UTC 文字列）。
hashingAlgorithm		文字列	使用されているハッシュ化アルゴリズム。
secretKey		文字列	TOTP MFA への登録と OTP の生成に使用される共有秘密鍵/シード。

メソッド

メソッド	修飾キー	説明
generateQrCodeUrl(accountName, Issuer)		https://github.com/google/google-authenticator/wiki/Key-Uri-Format で説明されている QR コードの URL を返します。これは、Google 認証システムなどの TOTP アプリにスキャンされる QR コードとしてユーザーに表示できます。省略可能なパラメータが指定されていない場合は、accountName と発行者 が使用されます。

TotpSecret.codeIntervalSeconds

OTP コードを変更する間隔（秒単位）。

署名:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

生成されるワンタイム パスワードの長さ。

署名:

readonly codeLength: number;

TotpSecret.enrollmentcompletionDeadline

TOTP 登録の完了期限のタイムスタンプ（UTC 文字列）。

署名:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithm

使用されているハッシュ化アルゴリズム。

署名:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

TOTP MFA への登録と OTP の生成に使用される共有秘密鍵/シード。

署名:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

https://github.com/google/google-authenticator/wiki/Key-Uri-Format で説明されている QR コードの URL を返します。これは、Google 認証システムなどの TOTP アプリにスキャンされる QR コードとしてユーザーに表示できます。省略可能なパラメータが指定されていない場合は、accountName と発行者 が使用されます。

署名:

generateQrCodeUrl(accountName?: string, issuer?: string): string;

パラメータ

パラメータ	型	説明
アカウント名	文字列	アカウント/アプリの名前とユーザー ID。
issuer	文字列	TOTP の発行者（通常はアプリ名）。

戻り値:

文字列

QR コードの URL 文字列。