TotpSecret class

ผู้ให้บริการสำหรับการสร้าง TotpMultiFactorAssertion

จัดเก็บคีย์ลับที่ใช้ร่วมกันและพารามิเตอร์อื่นๆ เพื่อสร้าง OTP ตามเวลา ใช้วิธีการเรียกข้อมูลคีย์ลับที่ใช้ร่วมกันและสร้าง URL ของคิวอาร์โค้ด

ลายเซ็น:

export declare class TotpSecret

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
codeIntervalSeconds ตัวเลข ช่วงเวลา (เป็นวินาที) ที่ควรเปลี่ยนรหัส OTP
codeLength ตัวเลข ความยาวของรหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวที่สร้าง
การลงทะเบียนเสร็จสมบูรณ์ สตริง การประทับเวลา (สตริง UTC) ที่ควรลงทะเบียน TOTP เสร็จสมบูรณ์
hashingAlgorithm สตริง ใช้อัลกอริทึมการแฮช
secretKey สตริง คีย์ลับ/ซีดที่ใช้ร่วมกัน ใช้สำหรับลงทะเบียนใน TOTP MFA และสร้าง OTP

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
generateQrCodeUrl(accountName, ผู้ออกบัตร) แสดง URL ของคิวอาร์โค้ดตามที่อธิบายไว้ใน https://github.com/google/google-authenticator/wiki/Key-Uri-Format โค้ดนี้สามารถแสดงต่อผู้ใช้เป็นคิวอาร์โค้ดเพื่อนำไปสแกนในแอป TOTP เช่น Google Authenticator หากไม่ได้ระบุพารามิเตอร์ที่ไม่บังคับ ระบบจะใช้ accountName ของ และผู้ออก

TotpSecret.codeIntervalSeconds

ช่วงเวลา (เป็นวินาที) ที่ควรเปลี่ยนรหัส OTP

ลายเซ็น:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

ความยาวของรหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวที่สร้าง

ลายเซ็น:

readonly codeLength: number;

TotpSecret.enrollmentภายในวันที่ทำ

การประทับเวลา (สตริง UTC) ที่ควรลงทะเบียน TOTP เสร็จสมบูรณ์

ลายเซ็น:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithm

ใช้อัลกอริทึมการแฮช

ลายเซ็น:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

คีย์ลับ/ซีดที่ใช้ร่วมกัน ใช้สำหรับลงทะเบียนใน TOTP MFA และสร้าง OTP

ลายเซ็น:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

แสดง URL ของคิวอาร์โค้ดตามที่อธิบายไว้ใน https://github.com/google/google-authenticator/wiki/Key-Uri-Format โค้ดนี้สามารถแสดงต่อผู้ใช้เป็นคิวอาร์โค้ดเพื่อนำไปสแกนในแอป TOTP เช่น Google Authenticator หากไม่ได้ระบุพารามิเตอร์ที่ไม่บังคับ ระบบจะใช้ accountName ของ และผู้ออก

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ชื่อบัญชี สตริง ชื่อบัญชี/แอปและตัวระบุผู้ใช้
ผู้ออกบัตร สตริง ผู้ออก TOTP (น่าจะเป็นชื่อแอป)

การคืนสินค้า:

สตริง

สตริง URL ของคิวอาร์โค้ด