TotpSecret class

產生 TotpMultiFactorAssertion 的提供者。

儲存共用密鑰和其他參數,以產生基於時間的動態密碼。實作擷取共用密鑰及產生 QR code 網址的方法。

簽名:

export declare class TotpSecret 

屬性

屬性 修飾符 類型 說明
codeIntervalSeconds 數字 動態密碼應變更的間隔時間 (以秒為單位)。
codeLength 數字 要產生的動態密碼長度。
enrollmentcompleteDeadline 字串 應完成 TOTP 註冊作業的時間戳記 (世界標準時間字串)。
hashingAlgorithm 字串 使用的雜湊演算法。
secretKey 字串 用於註冊 TOTP MFA 及產生動態密碼的共用密鑰/種子。

方法

方法 修飾符 說明
generateQrCodeUrl(accountName, 核發機構) 傳回 https://github.com/google/google-authenticator/wiki/Key-Uri-Format 中所述的 QR code 網址。您可以向使用者顯示為 QR code,以便在 Google Authenticator 等 TOTP 應用程式中掃描。如果未指定選用參數,則會使用 的 accountName 和 的核發者

TotpSecret.codeIntervalSeconds

動態密碼應變更的間隔時間 (以秒為單位)。

簽名:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

要產生的動態密碼長度。

簽名:

readonly codeLength: number;

TotpSecret.enrollment 完成期限

應完成 TOTP 註冊作業的時間戳記 (世界標準時間字串)。

簽名:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithm

使用的雜湊演算法。

簽名:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

用於註冊 TOTP MFA 及產生動態密碼的共用密鑰/種子。

簽名:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

傳回 https://github.com/google/google-authenticator/wiki/Key-Uri-Format 中所述的 QR code 網址。您可以向使用者顯示為 QR code,以便在 Google Authenticator 等 TOTP 應用程式中掃描。如果未指定選用參數,則會使用 的 accountName 和 的核發者

簽名:

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

參數

參數 類型 說明
帳戶名稱 字串 帳戶/應用程式名稱以及使用者 ID。
核發者 字串 TOTP 的核發者 (例如應用程式名稱)。

傳回:

字串

QR code 網址字串。