TotpMultiFactorGenerator class

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

ลายเซ็น:

export declare class TotpMultiFactorGenerator

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

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
FACTOR_ID static "totp" ตัวระบุของปัจจัยที่ 2 ของ TOTP: totp

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
assertionForRegistration(secret, oneTimePassword) static ระบุ TotpMultiFactorAssertion เพื่อยืนยันการเป็นเจ้าของปัจจัยที่ 2 ของ TOTP (รหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวตามเวลา) การยืนยันนี้ใช้เพื่อดำเนินการลงทะเบียนในปัจจัยที่สองของ TOTP ให้เสร็จสมบูรณ์
assertionForSignIn(enrollmentId, oneTimePassword) static ระบุ TotpMultiFactorAssertion เพื่อยืนยันการเป็นเจ้าของปัจจัยที่ 2 ของ TOTP การยืนยันนี้จะใช้ในการลงชื่อเข้าใช้โดยใช้ TOTP เป็นปัจจัยที่ 2
generateSecret(เซสชัน) static แสดงผลการสัญญาไปยัง TotpSecret ซึ่งมีคีย์ลับที่ใช้ร่วมกันของ TOTP และพารามิเตอร์อื่นๆ สร้างข้อมูลลับ TOTP เป็นส่วนหนึ่งของการลงทะเบียนปัจจัยที่สองของ TOTP ใช้สำหรับการสร้าง URL ของคิวอาร์โค้ดหรือป้อนข้อมูลลงในแอป TOTP เมธอดนี้ใช้อินสแตนซ์การตรวจสอบสิทธิ์ที่สอดคล้องกับผู้ใช้ใน multiFactorSession

TotpMultiFactorGeneratorFACTOR_ID

ตัวระบุของปัจจัยที่ 2 ของ TOTP: totp

ลายเซ็น:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

ระบุ TotpMultiFactorAssertion เพื่อยืนยันการเป็นเจ้าของปัจจัยที่ 2 ของ TOTP (รหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวตามเวลา) การยืนยันนี้ใช้เพื่อดำเนินการลงทะเบียนในปัจจัยที่สองของ TOTP ให้เสร็จสมบูรณ์

ลายเซ็น:

static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ข้อมูลลับ TotpSecret TotpSecret ที่มีคีย์ลับที่ใช้ร่วมกันและพารามิเตอร์ TOTP อื่นๆ
รหัสผ่านครั้งเดียว สตริง รหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวจากแอป TOTP

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

TotpMultiFactorAssertion

TotpMultiFactorAssertion ที่ใช้กับ MultiFactorUser.enroll()

TotpMultiFactorGenerator.assertionForSignIn()

ระบุ TotpMultiFactorAssertion เพื่อยืนยันการเป็นเจ้าของปัจจัยที่ 2 ของ TOTP การยืนยันนี้จะใช้ในการลงชื่อเข้าใช้โดยใช้ TOTP เป็นปัจจัยที่ 2

ลายเซ็น:

static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
รหัสการลงทะเบียน สตริง ระบุปัจจัยที่ 2 ของ TOTP ที่ลงทะเบียน
รหัสผ่านครั้งเดียว สตริง รหัสผ่านที่สามารถใช้งานได้เพียงครั้งเดียวจากแอป TOTP

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

TotpMultiFactorAssertion

TotpMultiFactorAssertion ที่ใช้กับ MultiFactorResolver.resolveSignIn() ได้

TotpMultiFactorGenerator.generateSecret()

แสดงผลการสัญญาไปยัง TotpSecret ซึ่งมีคีย์ลับที่ใช้ร่วมกันของ TOTP และพารามิเตอร์อื่นๆ สร้างข้อมูลลับ TOTP เป็นส่วนหนึ่งของการลงทะเบียนปัจจัยที่สองของ TOTP ใช้สำหรับการสร้าง URL ของคิวอาร์โค้ดหรือป้อนข้อมูลลงในแอป TOTP เมธอดนี้ใช้อินสแตนซ์การตรวจสอบสิทธิ์ที่สอดคล้องกับผู้ใช้ใน multiFactorSession

ลายเซ็น:

static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
เซสชัน MultiFactorSession MultiFactorSession ที่ผู้ใช้เป็นสมาชิก

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

สัญญาแล้ว<TotpSecret>

สัญญากับ TotpSecret