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 { kReqType_GetInitialOpDeviceCert = 0, kReqType_RotateOpDeviceCert = 1 }`	enum
`EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)`	typedef `void(*` 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 { kEvent_PrepareAuthorizeInfo = 1, kEvent_ResponseReceived = 2, kEvent_CommunicationError = 3 }`	enum
`State { kState_NotInitialized = 0, kState_Idle = 1, kState_PreparingBinding = 2, kState_RequestInProgress = 3 }`	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)`	`WEAVE_ERROR` 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`	`EventCallback` 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`	`WeaveNodeMfrAttestDelegate *` 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`	`WeaveNodeOpAuthDelegate *` 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`	`State` 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)`	`WEAVE_ERROR` 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)`	`WEAVE_ERROR` 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)`	`WEAVE_ERROR` 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

Tính chất
`kReqType_GetInitialOpDeviceCert`	Loại yêu cầu Nhận chứng chỉ là để lấy chứng chỉ hoạt động ban đầu.
`kReqType_RotateOpDeviceCert`	Loại yêu cầu Nhận chứng chỉ là để luân phiên chứng nhận hoạt động hiện tại.

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ố

`[in] appState`	Một con trỏ đến thông tin trạng thái do ứng dụng xác định được liên kết với đối tượng engine.
`[in] eventType`	ID sự kiện được chuyển bởi lệnh gọi lại sự kiện.
`[in] inParam`	Tham chiếu các tham số sự kiện đầu vào được chuyển bởi lệnh gọi lại sự kiện.
`[in] outParam`	Tham chiếu các tham số sự kiện đầu ra được truyền bởi lệnh gọi lại sự kiện.

Loại sự kiện

 EventType

Tính chất
`kEvent_CommunicationError`	Đã xảy ra lỗi giao tiếp khi gửi GetCertificateRequest hoặc đang chờ phản hồi.
`kEvent_PrepareAuthorizeInfo`	Ứng dụng được yêu cầu chuẩn bị tải trọng cho GetCertificateRequest.
`kEvent_ResponseReceived`	Một thông báo GetCertificateResponse đã được nhận từ đồng nghiệp.

Tiểu bang

 State

Tính chất
`kState_Idle`	Đối tượng động cơ không hoạt động.
`kState_NotInitialized`	Đối tượng động cơ không được khởi tạo.
`kState_PreparingBinding`	Đối tượng động cơ đang chờ ràng buộc sẵn sàng.
`kState_RequestInProgress`	Thông báo GetCertificateRequest đã được gửi và đối tượng công cụ đang chờ phản hồi.

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ố

`[in] msgBuf`	Một con trỏ đến đối tượng PacketBuffer đang giữ thông báo GetCertificateRequest.
`[in] reqType`	Nhận loại yêu cầu chứng chỉ.
`[in] doMfrAttest`	Cờ boolean cho biết liệu yêu cầu có nên bao gồm dữ liệu chứng thực của nhà sản xuất hay không.

Giá trị trả lại

WEAVE_NO_ERROR

Nếu GetCertificateRequest được tạo thành công.

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ố

`[in] binding`	Một đối tượng Binding sẽ được sử dụng để thiết lập giao tiếp với nút ngang hàng.
`[in] opAuthDelegate`	Một con trỏ đến đối tượng ủy quyền xác thực hoạt động sẽ được sử dụng để xây dựng và ký bằng thông tin xác thực hoạt động của nút.
`[in] mfrAttestDelegate`	Một con trỏ đến đối tượng ủy quyền chứng thực nhà sản xuất sẽ được sử dụng để xây dựng và ký yêu cầu bằng cách sử dụng thông tin xác thực do nhà sản xuất cung cấp.
`[in] eventCallback`	Một con trỏ tới một hàm sẽ được gọi bởi đối tượng WeaveCertProvEngine để cung cấp các sự kiện API cho ứng dụng.
`[in] appState`	Một con trỏ đến một đối tượng do ứng dụng xác định sẽ được chuyển trở lại ứng dụng bất cứ khi nào một sự kiện API xảy ra.

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ố

[in] msgBuf

Một con trỏ đến đối tượng PacketBuffer đang giữ thông báo GetCertificateResponse.

Giá trị trả lại

WEAVE_NO_ERROR

Nếu thông báo GetCertificateResponse được xử lý thành công.

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ố

`[in] reqType`	Nhận loại yêu cầu chứng chỉ.
`[in] doMfrAttest`	Cờ boolean cho biết liệu giao thức có nên bao gồm dữ liệu chứng thực của nhà sản xuất hay không.

Giá trị trả lại

WEAVE_NO_ERROR

Nếu StartCertificateProvisrating () được xử lý thành công.

WeaveCertProvEngine

 WeaveCertProvEngine(
  void
)

nl :: Dệt :: Hồ sơ :: Bảo vệ:: CertProvisrating :: WeaveCertProvEngine

Tóm lược

Người xây dựng và Người phá hủy

Các loại công khai

Thuộc tính công cộng

Chức năng công cộng

Cấu trúc

Các loại công khai

@ 246

EventCallback

Loại sự kiện

Tiểu bang

Thuộc tính công cộng

AppState

Chức năng công cộng

AbortCertificateProvisrating

GenerateGetCertificateRequest

GetBinding

GetEventCallback

GetMfrAttestDelegate

GetOpAuthDelegate

GetReqType

GetState

Trong đó

ProcessGetCertificateResponse

SetBinding

SetEventCallback

SetMfrAttestDelegate

SetOpAuthDelegate

Tắt

StartCertificateProvisrating

WeaveCertProvEngine