TotpSecret class

Dostawca służący do generowania TotpMultiFactorAssertion .

Przechowuje wspólny tajny klucz i inne parametry w celu generowania jednorazowych haseł jednorazowych. Implementuje metody pobierania udostępnionego tajnego klucza i generowania adresu URL kodu QR.

Podpis:

export declare class TotpSecret

Nieruchomości

Nieruchomość Modyfikatory Typ Opis
codeIntervalSekundy numer Interwał (w sekundach), kiedy kody OTP powinny się zmienić.
kodDługość numer Długość generowanych haseł jednorazowych.
Termin zakończenia rejestracji strunowy Znacznik czasu (ciąg UTC), według którego powinna zostać ukończona rejestracja TOTP.
algorytm mieszający strunowy Zastosowany algorytm mieszający.
sekretny klucz strunowy Wspólny tajny klucz/nasiono używane do rejestrowania się w TOTP MFA i generowania OTP.

Metody

metoda Modyfikatory Opis
generujQrCodeUrl(nazwa konta, wystawca) Zwraca adres URL kodu QR zgodnie z opisem w https://github.com/google/google-authenticator/wiki/Key-Uri-Format. Może zostać wyświetlony użytkownikowi jako kod QR do zeskanowania do aplikacji TOTP, takiej jak Google Authenticator . Jeśli parametry opcjonalne nie są określone, nazwa konta i emitent są używane.

TotpSecret.codeIntervalSeconds

Interwał (w sekundach), kiedy kody OTP powinny się zmienić.

Podpis:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

Długość generowanych haseł jednorazowych.

Podpis:

readonly codeLength: number;

Termin ukończenia TotpSecret.enrollment

Znacznik czasu (ciąg UTC), według którego powinna zostać ukończona rejestracja TOTP.

Podpis:

readonly enrollmentCompletionDeadline: string;

Algorytm TotpSecret.hashing

Zastosowany algorytm mieszający.

Podpis:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

Wspólny tajny klucz/nasiono używane do rejestrowania się w TOTP MFA i generowania OTP.

Podpis:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

Zwraca adres URL kodu QR zgodnie z opisem w https://github.com/google/google-authenticator/wiki/Key-Uri-Format. Może zostać wyświetlony użytkownikowi jako kod QR do zeskanowania do aplikacji TOTP, takiej jak Google Authenticator . Jeśli parametry opcjonalne nie są określone, nazwa konta i emitent są używane.

Podpis:

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

Parametry

Parametr Typ Opis
Nazwa konta strunowy nazwę konta/aplikacji wraz z identyfikatorem użytkownika.
emitent strunowy wydawca TOTP (prawdopodobnie nazwa aplikacji).

Zwroty:

strunowy

Ciąg URL kodu QR.