NLWeaveKeyExportClient

#include <src/device-manager/cocoa/NLWeaveKeyExportClient.h>

Wrapper สำหรับการใช้งาน C++ ในฟังก์ชันการส่งออกคีย์เพื่อรองรับการเข้ารหัส PIN

สรุป

การสืบทอด

รับค่าจาก: NSObject

ฟังก์ชันสาธารณะ
allowNestDevelopmentDevices()
virtual BOOL
เป็นจริงหากจะอนุญาตการตอบกลับการส่งออกคีย์จากอุปกรณ์การพัฒนา Nest
allowSHA1DeviceCertificates()
virtual BOOL
เป็นจริงหากจะอนุญาตการตอบกลับการส่งออกคีย์จากอุปกรณ์ที่มีใบรับรอง SHA1
generateKeyExportRequest:responderNodeId:accessToken:error:(UInt32 keyId, UInt64 responderNodeId, NSData *accessToken, NSError **errOut)
virtual nullable NSData *
สร้างคำขอส่งออกคีย์ที่ได้รับโทเค็นเพื่อการเข้าถึง
generateKeyExportRequest:responderNodeId:clientCert:clientKey:error:(UInt32 keyId, UInt64 responderNodeId, NSData *clientCert, NSData *clientKey, NSError **errOut)
virtual nullable NSData *
สร้างคำขอส่งออกคีย์ที่มีใบรับรองไคลเอ็นต์และคีย์ส่วนตัว
init()
virtual instancetype
เริ่มต้นออบเจ็กต์ NLWeaveKeyExportClient
processKeyExportReconfigure:error:(NSData *reconfig, NSError **errOut)
virtual BOOL
ประมวลผลข้อความที่กำหนดค่าใหม่ที่ได้รับในการตอบกลับคำขอส่งออกคีย์ที่สร้างขึ้นก่อนหน้านี้
processKeyExportResponse:exportResp:error:(UInt64 responderNodeId, NSData *exportResp, NSError **errOut)
virtual nullable NSData *
ประมวลผลการตอบสนองต่อคำขอส่งออกคีย์ที่สร้างขึ้นก่อนหน้านี้
reset()
virtual void
รีเซ็ตออบเจ็กต์ไคลเอ็นต์การส่งออกคีย์ โดยทิ้งสถานะที่เชื่อมโยงกับคำขอส่งออกคีย์ที่รอดำเนินการ
setAllowNestDevelopmentDevices:(BOOL nestDev)
virtual void
อนุญาตหรือไม่อนุญาตคำตอบสำหรับการส่งออกคีย์จากอุปกรณ์การพัฒนา Nest
setAllowSHA1DeviceCertificates:(BOOL nestDev)
virtual void
อนุญาตหรือไม่อนุญาตการตอบกลับการส่งออกคีย์จากอุปกรณ์ที่มีใบรับรอง SHA1

ฟังก์ชันสาธารณะ

allowNestDevelopmentDevices

virtual BOOL allowNestDevelopmentDevices()

เป็นจริงหากอนุญาตให้มีการส่งออกคีย์จากอุปกรณ์การพัฒนา Nest

allowSHA1DeviceCertificates

virtual BOOL allowSHA1DeviceCertificates()

เป็นจริงหากจะอนุญาตการตอบกลับการส่งออกคีย์จากอุปกรณ์ที่มีใบรับรอง SHA1

generateKeyExportRequest:responderNodeId:accessToken:error:

virtual nullable NSData * generateKeyExportRequest:responderNodeId:accessToken:error:(
  UInt32 keyId,
  UInt64 responderNodeId,
  NSData *accessToken,
  NSError **errOut
)

สร้างคำขอส่งออกคีย์ที่ได้รับโทเค็นเพื่อการเข้าถึง

รายละเอียด
พารามิเตอร์
[in] keyId
รหัสคีย์ Weave ของคีย์ที่จะส่งออก
[in] responderNodeId
รหัสโหนด Weave ของอุปกรณ์ที่จะส่งต่อคำขอไป หรือ 0 หากไม่ทราบรหัสอุปกรณ์
[in] accessToken
บัฟเฟอร์ที่มีโทเค็นเพื่อการเข้าถึงของ Weave ในรูปแบบ Weave TLV
[out] errOut
พารามิเตอร์ข้อผิดพลาดของเอาต์พุต ซึ่งตั้งไว้ในกรณีที่เกิดข้อผิดพลาด และข้อผิดพลาดไม่เป็น Null
การคืนสินค้า
บัฟเฟอร์ไบนารีที่มีคำขอการส่งออกคีย์ที่สร้างขึ้น ตั้งค่าเป็น "ค่าศูนย์" หากเกิดข้อผิดพลาด

generateKeyExportRequest:responderNodeId:clientCert:clientKey:error:

virtual nullable NSData * generateKeyExportRequest:responderNodeId:clientCert:clientKey:error:(
  UInt32 keyId,
  UInt64 responderNodeId,
  NSData *clientCert,
  NSData *clientKey,
  NSError **errOut
)

สร้างคำขอส่งออกคีย์ที่มีใบรับรองไคลเอ็นต์และคีย์ส่วนตัว

รายละเอียด
พารามิเตอร์
[in] keyId
รหัสคีย์ Weave ของคีย์ที่จะส่งออก
[in] responderNodeId
รหัสโหนด Weave ของอุปกรณ์ที่จะส่งต่อคำขอไป หรือ 0 หากไม่ทราบรหัสอุปกรณ์
[in] clientCert
บัฟเฟอร์ที่มีใบรับรอง Weave ที่ระบุไคลเอ็นต์ที่ส่งคำขอ ใบรับรองควรเข้ารหัสในรูปแบบ Weave TLV
[in] clientKey
บัฟเฟอร์ที่มีคีย์ส่วนตัวที่เชื่อมโยงกับใบรับรองไคลเอ็นต์ คีย์ส่วนตัวควรเข้ารหัสในรูปแบบ Weave TLV
[out] errOut
พารามิเตอร์ข้อผิดพลาดของเอาต์พุต ซึ่งตั้งไว้ในกรณีที่เกิดข้อผิดพลาด และข้อผิดพลาดไม่เป็น Null
การคืนสินค้า
บัฟเฟอร์ไบนารีที่มีคำขอการส่งออกคีย์ที่สร้างขึ้น ตั้งค่าเป็น "ค่าศูนย์" หากเกิดข้อผิดพลาด

Init

virtual instancetype init()

เริ่มต้นออบเจ็กต์ NLWeaveKeyExportClient

สร้างอินสแตนซ์และเริ่มต้นอินสแตนซ์ของออบเจ็กต์ C++ ภายในเพื่อดำเนินการฟังก์ชันการส่งออกคีย์

processKeyExportReconfigure:error:

virtual BOOL processKeyExportReconfigure:error:(
  NSData *reconfig,
  NSError **errOut
)

ประมวลผลข้อความที่กำหนดค่าใหม่ที่ได้รับในการตอบกลับคำขอส่งออกคีย์ที่สร้างขึ้นก่อนหน้านี้

รายละเอียด
พารามิเตอร์
[in] reconfig
บัฟเฟอร์ที่มีข้อความการกำหนดค่าการส่งออกคีย์ Weave อีกครั้ง ตามที่อุปกรณ์แสดงผล
[out] errOut
พารามิเตอร์ข้อผิดพลาดของเอาต์พุต ซึ่งตั้งไว้ในกรณีที่เกิดข้อผิดพลาด และข้อผิดพลาดไม่เป็น Null
การคืนสินค้า
เป็นจริงเกี่ยวกับความสำเร็จ เท็จหากล้มเหลว

processKeyExportResponse:exportResp:error:

virtual nullable NSData * processKeyExportResponse:exportResp:error:(
  UInt64 responderNodeId,
  NSData *exportResp,
  NSError **errOut
)

ประมวลผลการตอบกลับคำขอส่งออกคีย์ที่สร้างขึ้นก่อนหน้านี้

รายละเอียด
พารามิเตอร์
[in] responderNodeId
รหัสโหนด Weave ของอุปกรณ์ที่ส่งต่อคำขอไป หรือ 0 หากไม่ทราบรหัสอุปกรณ์
[in] exportResp
บัฟเฟอร์ที่มีการตอบสนองของการส่งออกคีย์ Weave ตามที่อุปกรณ์แสดงผล
[out] errOut
พารามิเตอร์ข้อผิดพลาดของเอาต์พุต ซึ่งตั้งไว้ในกรณีที่เกิดข้อผิดพลาด และข้อผิดพลาดไม่เป็น Null
การคืนสินค้า
บัฟเฟอร์ไบนารีที่มีคีย์ที่ส่งออก ตั้งค่าเป็น "ค่าศูนย์" หากเกิดข้อผิดพลาด

รีเซ็ต

virtual void reset()

รีเซ็ตออบเจ็กต์ไคลเอ็นต์การส่งออกคีย์ โดยทิ้งสถานะที่เชื่อมโยงกับคำขอส่งออกคีย์ที่รอดำเนินการ

setAllowNestDevelopmentDevices:

virtual void setAllowNestDevelopmentDevices:(
  BOOL nestDev
)

อนุญาตหรือไม่อนุญาตคำตอบสำหรับการส่งออกคีย์จากอุปกรณ์การพัฒนา Nest

setAllowSHA1DeviceCertificates:

virtual void setAllowSHA1DeviceCertificates:(
  BOOL nestDev
)

อนุญาตหรือไม่อนุญาตการตอบกลับการส่งออกคีย์จากอุปกรณ์ที่มีใบรับรอง SHA1