用於產生TotpMultiFactorAssertion 的提供程序。
儲存共用金鑰和其他參數以產生基於時間的 OTP。實作檢索共用金鑰並產生 QR 碼 URL 的方法。
簽名:
export declare class TotpSecret
特性
財產 | 修飾符 | 類型 | 描述 |
---|---|---|---|
程式碼間隔秒數 | 數位 | OTP 代碼應更改的時間間隔(以秒為單位)。 | |
程式碼長度 | 數位 | 要產生的一次性密碼的長度。 | |
報名完成截止日期 | 細繩 | TOTP 註冊應完成的時間戳記(UTC 字串)。 | |
哈希演算法 | 細繩 | 使用的哈希演算法。 | |
金鑰 | 細繩 | 用於註冊 TOTP MFA 和產生 OTP 的共用金鑰/種子。 |
方法
方法 | 修飾符 | 描述 |
---|---|---|
generateQrCodeUrl(帳戶名稱, 發行人) | 傳回一個QR 碼URL,如https://github.com/google/google-authenticator/wiki/Key-Uri-Format 所述。這可以作為QR 碼顯示給用戶,以便掃描到TOTP 應用程式(如Google在Authenticator)中。如果未指定可選參數,則 accountName 為 |
TotpSecret.codeIntervalSeconds
OTP 代碼應更改的時間間隔(以秒為單位)。
簽名:
readonly codeIntervalSeconds: number;
ToppSecret.codeLength
要產生的一次性密碼的長度。
簽名:
readonly codeLength: number;
TotpSecret.enrollmentCompletionDeadline
TOTP 註冊應完成的時間戳記(UTC 字串)。
簽名:
readonly enrollmentCompletionDeadline: string;
ToppSecret.hashing演算法
使用的哈希演算法。
簽名:
readonly hashingAlgorithm: string;
ToppSecret.secretKey
用於註冊 TOTP MFA 和產生 OTP 的共用金鑰/種子。
簽名:
readonly secretKey: string;
TotpSecret.generateQrCodeUrl()
傳回一個QR 碼URL,如https://github.com/google/google-authenticator/wiki/Key-Uri-Format 所述。這可以作為QR 碼顯示給用戶,以便掃描到TOTP 應用程式(如Google在Authenticator)中。如果未指定可選參數,則 accountName 為
簽名:
generateQrCodeUrl(accountName?: string, issuer?: string): string;
參數
範圍 | 類型 | 描述 |
---|---|---|
帳戶名稱 | 細繩 | 帳戶/應用程式的名稱以及使用者識別碼。 |
發行人 | 細繩 | TOTP 的發行者(可能是應用程式名稱)。 |
返回:
細繩
二維碼 URL 字串。