nl :: Dệt :: Hồ sơ :: Bảo vệ:: CertProvisrating :: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
Triển khai logic cốt lõi của đối tượng giao thức cung cấp chứng chỉ Weave.
Tóm lược
Người xây dựng và Người phá hủy | |
---|---|
WeaveCertProvEngine (void) |
Các loại công khai | |
---|---|
@246 { | enum |
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* Hàm này là lệnh gọi lại của ứng dụng được gọi trên các sự kiện API của Công cụ cấp phép chứng chỉ. |
EventType { | enum |
State { | enum |
Thuộc tính công cộng | |
---|---|
AppState | void * Một con trỏ đến dữ liệu dành riêng cho ứng dụng. |
Chức năng công cộng | |
---|---|
AbortCertificateProvisioning (void) | void Dừng mọi trao đổi GetCertificate đang diễn ra. |
GenerateGetCertificateRequest ( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest) | Tạo thông báo GetCertificateRequest. |
GetBinding (void) const | Binding * Trả về một con trỏ đến đối tượng Binding được liên kết với WeaveCertProvEngine . |
GetEventCallback (void) const | Trả về một con trỏ đến hàm gọi lại sự kiện API hiện được định cấu hình trên đối tượng WeaveCertProvEngine . |
GetMfrAttestDelegate (void) const | Trả về một con trỏ đến đối tượng ủy quyền chứng thực nhà sản xuất hiện được định cấu hình trên đối tượng WeaveCertProvEngine . |
GetOpAuthDelegate (void) const | Trả về một con trỏ đến đối tượng ủy quyền xác thực hoạt động hiện được định cấu hình trên đối tượng WeaveCertProvEngine . |
GetReqType (void) const | uint8_t Truy xuất loại yêu cầu hiện tại. |
GetState (void) const | Truy xuất trạng thái hiện tại của đối tượng WeaveCertProvEngine . |
Init ( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState) | Khởi tạo đối tượng WeaveCertProvEngine để chuẩn bị gửi thông báo yêu cầu chứng chỉ. |
ProcessGetCertificateResponse ( PacketBuffer *msgBuf) | Xử lý thông báo GetCertificateResponse. |
SetBinding ( Binding *binding) | void Đặt đối tượng liên kết trên đối tượng WeaveCertProvEngine . |
SetEventCallback ( EventCallback eventCallback) | void Đặt hàm gọi lại sự kiện API trên đối tượng WeaveCertProvEngine . |
SetMfrAttestDelegate ( WeaveNodeMfrAttestDelegate *mfrAttestDelegate) | void Đặt đối tượng ủy quyền chứng thực nhà sản xuất trên đối tượng WeaveCertProvEngine . |
SetOpAuthDelegate ( WeaveNodeOpAuthDelegate *opAuthDelegate) | void Đặt đối tượng ủy quyền xác thực hoạt động trên đối tượng WeaveCertProvEngine . |
Shutdown (void) | void Tắt đối tượng WeaveCertProvEngine đã khởi tạo trước đó. |
StartCertificateProvisioning (uint8_t reqType, bool doMfrAttest) | Bắt đầu giao thức cấp phép chứng chỉ. |
Cấu trúc | |
---|---|
nl :: Weave :: Profiles :: Security :: CertProvisinstall :: WeaveCertProvEngine :: InEventParam | Nhập thông số cho sự kiện API cấp phép chứng chỉ Weave. |
nl :: Weave :: Profiles :: Security :: CertProvisinstall :: WeaveCertProvEngine :: OutEventParam | Xuất thông số cho sự kiện API cấp phép chứng chỉ Weave. |
Các loại công khai
@ 246
@246
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Hàm này là lệnh gọi lại ứng dụng được gọi trên các sự kiện API Công cụ cấp phép chứng chỉ.
Chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Thông số |
|
Loại sự kiện
EventType
Tiểu bang
State
Thuộc tính công cộng
AppState
void * AppState
Một con trỏ đến dữ liệu dành riêng cho ứng dụng.
Chức năng công cộng
AbortCertificateProvisrating
void AbortCertificateProvisioning( void )
Dừng mọi trao đổi GetCertificate đang diễn ra.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
Tạo thông báo GetCertificateRequest.
Phương pháp này tạo cấu trúc Weave GetCertificateRequest được mã hóa ở định dạng Weave TLV .
Khi tạo thông báo GetCertificateRequest, phương thức này sẽ đưa ra một yêu cầu tới ứng dụng, thông qua các hàm WeaveNodeOpAuthDelegate và WeaveNodeMfrAttestDelegate và sự kiện API chuẩn bị sẵn sàng để chuẩn bị tải thông báo.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
GetBinding
Binding * GetBinding( void ) const
Trả về một con trỏ đến đối tượng Binding được liên kết với WeaveCertProvEngine .
GetEventCallback
EventCallback GetEventCallback( void ) const
Trả về một con trỏ đến hàm gọi lại sự kiện API hiện được định cấu hình trên đối tượng WeaveCertProvEngine .
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
Trả về một con trỏ đến đối tượng ủy quyền chứng thực nhà sản xuất hiện được định cấu hình trên đối tượng WeaveCertProvEngine .
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
Trả về một con trỏ đến đối tượng ủy quyền xác thực hoạt động hiện được định cấu hình trên đối tượng WeaveCertProvEngine .
GetReqType
uint8_t GetReqType( void ) const
Truy xuất loại yêu cầu hiện tại.
GetState
State GetState( void ) const
Truy xuất trạng thái hiện tại của đối tượng WeaveCertProvEngine .
Trong đó
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
Khởi tạo đối tượng WeaveCertProvEngine để chuẩn bị gửi thông báo yêu cầu chứng chỉ.
Chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Thông số |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
Xử lý thông báo GetCertificateResponse.
Phương pháp này xử lý cấu trúc Weave GetCertificateResponse được mã hóa ở định dạng Weave TLV .
Khi quá trình xử lý thông báo GetCertificateResponse hoàn tất thành công, phương thức sẽ gọi ứng dụng, thông qua sự kiện API ResponseReceive, để cung cấp kết quả.
Nếu quá trình xử lý thông báo GetCertificateResponse không thành công, phương thức sẽ thực hiện cuộc gọi đến ứng dụng, thông qua sự kiện API CommunicationError, để báo cáo lỗi.
Chi tiết | |||
---|---|---|---|
Thông số |
| ||
Giá trị trả lại |
|
SetBinding
void SetBinding( Binding *binding )
Đặt đối tượng liên kết trên đối tượng WeaveCertProvEngine .
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Đặt hàm gọi lại sự kiện API trên đối tượng WeaveCertProvEngine .
SetMfrAttestDelegate
void SetMfrAttestDelegate( WeaveNodeMfrAttestDelegate *mfrAttestDelegate )
Đặt đối tượng ủy quyền chứng thực nhà sản xuất trên đối tượng WeaveCertProvEngine .
SetOpAuthDelegate
void SetOpAuthDelegate( WeaveNodeOpAuthDelegate *opAuthDelegate )
Đặt đối tượng ủy quyền xác thực hoạt động trên đối tượng WeaveCertProvEngine .
Tắt
void Shutdown( void )
Tắt đối tượng WeaveCertProvEngine đã khởi tạo trước đó.
Lưu ý rằng phương thức này chỉ có thể được gọi nếu phương thức Init () đã được gọi trước đó.
StartCertificateProvisrating
WEAVE_ERROR StartCertificateProvisioning( uint8_t reqType, bool doMfrAttest )
Bắt đầu giao thức cấp phép chứng chỉ.
Phương thức này bắt đầu quá trình gửi thông báo GetCertificateRequest đến dịch vụ CA. Nếu và khi nhận được thông báo GetCertificateResponse tương ứng, nó sẽ được gửi đến ứng dụng thông qua sự kiện API ResponseReceive.
Nếu đối tượng Binding không ở trạng thái Ready khi phương thức này được gọi, một yêu cầu sẽ được gửi đến phương thức Binding :: RequestPrepare () để bắt đầu chuẩn bị theo yêu cầu. Thao tác yêu cầu sau đó sẽ đợi cho đến khi quá trình này hoàn tất. Mọi lệnh gọi đến StartCertificateProvisrating () trong khi có một yêu cầu trước đó trong quá trình sẽ bị bỏ qua.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Giá trị trả lại |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )