ไม่มี:: สาน:: โปรไฟล์:: ความปลอดภัย:: การจัดสรรใบรับรอง:: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
ใช้ตรรกะหลักของอ็อบเจ็กต์โปรโตคอลการจัดเตรียมใบรับรองการทอ
สรุป
ตัวสร้างและตัวทำลาย | |
---|---|
WeaveCertProvEngine (void) |
ประเภทสาธารณะ | |
---|---|
@246 { | enum |
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* ฟังก์ชันนี้เป็นการเรียกกลับของแอปพลิเคชันที่เรียกใช้ในเหตุการณ์ API การจัดเตรียมใบรับรองของเครื่องมือ |
EventType { | enum |
State { | enum |
คุณลักษณะสาธารณะ | |
---|---|
AppState | void * ตัวชี้ไปยังข้อมูลเฉพาะแอปพลิเคชัน |
งานสาธารณะ | |
---|---|
AbortCertificateProvisioning (void) | void หยุดการแลกเปลี่ยน GetCertificate ที่กำลังดำเนินการอยู่ |
GenerateGetCertificateRequest ( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest) | สร้างข้อความ GetCertificateRequest |
GetBinding (void) const | Binding * กลับชี้ไปที่ การผูก วัตถุที่เกี่ยวข้องกับ WeaveCertProvEngine |
GetEventCallback (void) const | ส่งกลับชี้ไปยัง API ฟังก์ชั่นการเรียกกลับเหตุการณ์กำหนดค่าในปัจจุบันใน WeaveCertProvEngine วัตถุ |
GetMfrAttestDelegate (void) const | ส่งกลับไปยังผู้ผลิตตัวชี้พยานวัตถุตัวแทนกำหนดค่าในปัจจุบันใน WeaveCertProvEngine วัตถุ |
GetOpAuthDelegate (void) const | ส่งกลับชี้ไปยังวัตถุการตรวจสอบการดำเนินงานของผู้ร่วมประชุมกำหนดค่าในปัจจุบันใน WeaveCertProvEngine วัตถุ |
GetReqType (void) const | uint8_t ดึงข้อมูลประเภทคำขอปัจจุบัน |
GetState (void) const | ดึงสถานะปัจจุบันของ WeaveCertProvEngine วัตถุ |
Init ( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState) | เริ่มต้น WeaveCertProvEngine วัตถุในการเตรียมการสำหรับการส่งได้รับข้อความร้องขอใบรับรอง |
ProcessGetCertificateResponse ( PacketBuffer *msgBuf) | ประมวลผลข้อความ GetCertificateResponse |
SetBinding ( Binding *binding) | void ชุดวัตถุผลผูกพันกับ WeaveCertProvEngine วัตถุ |
SetEventCallback ( EventCallback eventCallback) | void การตั้งค่าฟังก์ชั่นการเรียกกลับเหตุการณ์ API บน WeaveCertProvEngine วัตถุ |
SetMfrAttestDelegate ( WeaveNodeMfrAttestDelegate *mfrAttestDelegate) | void ชุดวัตถุผู้รับมอบสิทธิ์ผู้ผลิตรับรองบน WeaveCertProvEngine วัตถุ |
SetOpAuthDelegate ( WeaveNodeOpAuthDelegate *opAuthDelegate) | void ชุดตรวจสอบวัตถุผู้รับมอบสิทธิ์ในการดำเนินงานใน WeaveCertProvEngine วัตถุ |
Shutdown (void) | void ปิดเริ่มต้นก่อนหน้านี้ WeaveCertProvEngine วัตถุ |
StartCertificateProvisioning (uint8_t reqType, bool doMfrAttest) | เริ่มโปรโตคอลการจัดเตรียมใบรับรอง |
โครงสร้าง | |
---|---|
NL :: สาน :: โปรไฟล์ :: การรักษาความปลอดภัย :: CertProvisioning :: WeaveCertProvEngine :: InEventParam | ป้อนพารามิเตอร์ไปยังเหตุการณ์ API การจัดเตรียมใบรับรองสาน |
NL :: สาน :: โปรไฟล์ :: การรักษาความปลอดภัย :: CertProvisioning :: WeaveCertProvEngine :: OutEventParam | พารามิเตอร์เอาต์พุตไปยังเหตุการณ์ API การจัดเตรียมใบรับรอง Weave |
ประเภทสาธารณะ
@246
@246
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
ฟังก์ชันนี้เป็นการเรียกกลับของแอปพลิเคชันที่เรียกใช้ในเหตุการณ์ API ของ Certificate Provisioning Engine
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
ประเภทเหตุการณ์
EventType
สถานะ
State
คุณลักษณะสาธารณะ
AppState
void * AppState
ตัวชี้ไปยังข้อมูลเฉพาะแอปพลิเคชัน
งานสาธารณะ
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
หยุดการแลกเปลี่ยน GetCertificate ที่กำลังดำเนินการอยู่
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
สร้างข้อความ GetCertificateRequest
วิธีการนี้สร้างโครงสร้างสาน GetCertificateRequest เข้ารหัสในสาน TLV รูปแบบ
เมื่อขึ้นรูปข้อความ GetCertificateRequest วิธีการที่ทำให้การร้องขอไปยังโปรแกรมประยุกต์ที่ผ่าน WeaveNodeOpAuthDelegate และ WeaveNodeMfrAttestDelegate ฟังก์ชั่นและเหตุการณ์ PrepareAuthorizeInfo API เพื่อเตรียมความพร้อมน้ำหนักบรรทุกของข้อความ
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||
ส่งกลับค่า |
|
รับผูก
Binding * GetBinding( void ) const
กลับชี้ไปที่ การผูก วัตถุที่เกี่ยวข้องกับ WeaveCertProvEngine
GetEventCallback
EventCallback GetEventCallback( void ) const
ส่งกลับชี้ไปยัง API ฟังก์ชั่นการเรียกกลับเหตุการณ์กำหนดค่าในปัจจุบันใน WeaveCertProvEngine วัตถุ
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
ส่งกลับไปยังผู้ผลิตตัวชี้พยานวัตถุตัวแทนกำหนดค่าในปัจจุบันใน WeaveCertProvEngine วัตถุ
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
ส่งกลับชี้ไปยังวัตถุการตรวจสอบการดำเนินงานของผู้ร่วมประชุมกำหนดค่าในปัจจุบันใน WeaveCertProvEngine วัตถุ
GetReqType
uint8_t GetReqType( void ) const
ดึงข้อมูลประเภทคำขอปัจจุบัน
ในนั้น
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
เริ่มต้น WeaveCertProvEngine วัตถุในการเตรียมการสำหรับการส่งได้รับข้อความร้องขอใบรับรอง
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
ประมวลผลข้อความ GetCertificateResponse
กระบวนการวิธีการโครงสร้างสาน GetCertificateResponse นี้เข้ารหัสในสาน TLV รูปแบบ
เมื่อประมวลผลข้อความ GetCertificateResponse สำเร็จ เมธอดจะเรียกแอปพลิเคชันผ่านเหตุการณ์ ResponseReceived API เพื่อส่งมอบผลลัพธ์
หากการประมวลผลข้อความ GetCertificateResponse ล้มเหลว เมธอดจะเรียกแอปพลิเคชันผ่านเหตุการณ์ CommunicationError API เพื่อรายงานข้อผิดพลาด
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
| ||
ส่งกลับค่า |
|
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
การตั้งค่าฟังก์ชั่นการเรียกกลับเหตุการณ์ API บน WeaveCertProvEngine วัตถุ
SetMfrAttestDelegate
void SetMfrAttestDelegate( WeaveNodeMfrAttestDelegate *mfrAttestDelegate )
ชุดวัตถุผู้รับมอบสิทธิ์ผู้ผลิตรับรองบน WeaveCertProvEngine วัตถุ
SetOpAuthDelegate
void SetOpAuthDelegate( WeaveNodeOpAuthDelegate *opAuthDelegate )
ชุดตรวจสอบวัตถุผู้รับมอบสิทธิ์ในการดำเนินงานใน WeaveCertProvEngine วัตถุ
ปิดตัวลง
void Shutdown( void )
ปิดเริ่มต้นก่อนหน้านี้ WeaveCertProvEngine วัตถุ
โปรดทราบว่าวิธีการนี้เท่านั้นที่สามารถเรียกว่าถ้า Init () วิธีการได้รับการเรียกว่าก่อนหน้านี้
StartCertificateProvisioning
WEAVE_ERROR StartCertificateProvisioning( uint8_t reqType, bool doMfrAttest )
เริ่มโปรโตคอลการจัดเตรียมใบรับรอง
เมธอดนี้เริ่มต้นกระบวนการส่งข้อความ GetCertificateRequest ไปยังบริการ CA หากและเมื่อได้รับข้อความ GetCertificateResponse ที่สอดคล้องกัน ข้อความจะถูกส่งไปยังแอปพลิเคชันผ่านเหตุการณ์ ResponseReceived API
ถ้า ผูก วัตถุไม่ได้อยู่ในสถานะพร้อมเมื่อวิธีการนี้เรียกว่าการร้องขอจะทำเพื่อ ผูก :: RequestPrepare () วิธีการที่จะเริ่มต้นการเตรียมความพร้อมตามความต้องการ การดำเนินการขอจะรอจนกว่ากระบวนการนี้จะเสร็จสมบูรณ์ โทรไป StartCertificateProvisioning () ในขณะที่มีการร้องขอก่อนหน้านี้ในกระบวนการจะถูกละเว้น
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
| ||||
ส่งกลับค่า |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )