ผู้ให้บริการสำหรับการสร้าง TopMultiFactorAssertion .
ลายเซ็น:
export declare class TotpMultiFactorGenerator
คุณสมบัติ
| คุณสมบัติ | ตัวดัดแปลง | พิมพ์ | คำอธิบาย |
|---|---|---|---|
| แฟกเตอร์_ID | static | 'ทีโอพี' | ตัวระบุของปัจจัยที่สอง TOTP: totp |
วิธีการ
| วิธี | ตัวดัดแปลง | คำอธิบาย |
|---|---|---|
| การยืนยันสำหรับการลงทะเบียน (ความลับ oneTimePassword) | static | ให้ TopMultiFactorAssertion เพื่อยืนยันความเป็นเจ้าของปัจจัยที่สอง TOTP (รหัสผ่านแบบใช้ครั้งเดียวตามเวลา) คำยืนยันนี้ใช้เพื่อลงทะเบียนใน TOTP ปัจจัยที่สองให้เสร็จสมบูรณ์ |
| การยืนยันForSignIn (รหัสการลงทะเบียน, รหัสผ่านครั้งเดียว) | static | ให้ TopMultiFactorAssertion เพื่อยืนยันความเป็นเจ้าของปัจจัยที่สองของ TOTP การยืนยันนี้ใช้เพื่อดำเนินการลงชื่อเข้าใช้ให้เสร็จสิ้นโดยให้ TOTP เป็นปัจจัยที่สอง |
| GenerateSecret (เซสชัน) | static | ส่งกลับสัญญาไปยัง TotpSecret ซึ่งมีคีย์ลับที่ใช้ร่วมกันของ TOTP และพารามิเตอร์อื่นๆ สร้างข้อมูลลับ TOTP โดยเป็นส่วนหนึ่งของการลงทะเบียนปัจจัยที่สองของ TOTP ใช้สำหรับสร้าง URL โค้ด QR หรือป้อนข้อมูลลงในแอป TOTP วิธีการนี้ใช้อินสแตนซ์การตรวจสอบสิทธิ์ที่สอดคล้องกับผู้ใช้ใน multiFactorSession |
TotpMultiFactorGenerator.FACTOR_ID
ตัวระบุของปัจจัยที่สอง TOTP: totp .
ลายเซ็น:
static FACTOR_ID: 'totp';
TotpMultiFactorGenerator.assertionForEnrollment()
ให้ TopMultiFactorAssertion เพื่อยืนยันความเป็นเจ้าของปัจจัยที่สอง TOTP (รหัสผ่านแบบใช้ครั้งเดียวตามเวลา) คำยืนยันนี้ใช้เพื่อลงทะเบียนใน TOTP ปัจจัยที่สองให้เสร็จสมบูรณ์
ลายเซ็น:
static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ความลับ | ท็อปซีเคร็ท | TotpSecret ที่มีคีย์ลับที่ใช้ร่วมกันและพารามิเตอร์ TOTP อื่นๆ |
| รหัสผ่านครั้งเดียว | เชือก | รหัสผ่านแบบใช้ครั้งเดียวจากแอป TOTP |
ผลตอบแทน:
TotpMultiFactorAssertion ซึ่งสามารถใช้ได้กับ MultiFactorUser.enroll() .
TotpMultiFactorGenerator.assertionForSignIn()
ให้ TopMultiFactorAssertion เพื่อยืนยันความเป็นเจ้าของปัจจัยที่สองของ TOTP การยืนยันนี้ใช้เพื่อดำเนินการลงชื่อเข้าใช้ให้เสร็จสิ้นโดยให้ TOTP เป็นปัจจัยที่สอง
ลายเซ็น:
static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| รหัสการลงทะเบียน | เชือก | ระบุปัจจัยที่สองของ TOTP ที่ลงทะเบียนไว้ |
| รหัสผ่านครั้งเดียว | เชือก | รหัสผ่านแบบใช้ครั้งเดียวจากแอป TOTP |
ผลตอบแทน:
TotpMultiFactorAssertion ซึ่งสามารถใช้ได้กับ MultiFactorResolver.resolveSignIn() .
TotpMultiFactorGenerator.generateSecret()
ส่งกลับสัญญาไปยัง TotpSecret ซึ่งมีคีย์ลับที่ใช้ร่วมกันของ TOTP และพารามิเตอร์อื่นๆ สร้างข้อมูลลับ TOTP โดยเป็นส่วนหนึ่งของการลงทะเบียนปัจจัยที่สองของ TOTP ใช้สำหรับสร้าง URL โค้ด QR หรือป้อนข้อมูลลงในแอป TOTP วิธีการนี้ใช้อินสแตนซ์การตรวจสอบสิทธิ์ที่สอดคล้องกับผู้ใช้ใน multiFactorSession
ลายเซ็น:
static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| การประชุม | MultiFactorSession | MultiFactorSession ที่ผู้ใช้เป็นส่วนหนึ่ง |
ผลตอบแทน:
สัญญา< TotpSecret >
คำมั่นสัญญากับ TotpSecret .