nl ::織り::プロファイル::セキュリティ:: CertProvisioning :: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
Weave CertificateProvisioningプロトコルオブジェクトのコアロジックを実装します。
概要
コンストラクタとデストラクタ | |
---|---|
WeaveCertProvEngine (void) |
パブリックタイプ | |
---|---|
@246 { | 列挙型 |
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* この関数は、Certificate Provisioning EngineAPIイベントで呼び出されるアプリケーションコールバックです。 |
EventType { | 列挙型 |
State { | 列挙型 |
パブリック属性 | |
---|---|
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 | Weave Certificate ProvisioningAPIイベントにパラメーターを入力します。 |
NL ::織り::プロファイル::保障:: CertProvisioning :: WeaveCertProvEngine :: OutEventParam | 織り証明書プロビジョニングAPIイベントにパラメーターを出力します。 |
パブリックタイプ
@ 246
@246
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
この関数は、Certificate Provisioning EngineAPIイベントで呼び出されるアプリケーションコールバックです。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメーター |
|
イベントタイプ
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イベント。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメーター |
| ||||||
戻り値 |
|
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メッセージが受信されると、ResponseReceivedAPIイベントを介してアプリケーションに配信されます。
場合バインドオブジェクトがこのメソッドが呼び出されたときにレディ状態でない場合、要求はについて説明するバインディング:: RequestPrepare()オンデマンド準備を開始する方法。リクエスト操作は、このプロセスが完了するまで待機します。すべての呼び出しStartCertificateProvisioning()プロセスで前の要求がある間は無視されます。
詳細 | |||||
---|---|---|---|---|---|
パラメーター |
| ||||
戻り値 |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )