nl:: Weave:: Profiles:: Security:: CertProvisioning:: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
Weave Sertifika Temel Hazırlık protokol nesnesinin temel mantığını uygular.
Özet
Oluşturucular ve Yıkıcılar |
|
---|---|
WeaveCertProvEngine(void)
|
Herkese açık türler |
|
---|---|
@246{
|
enum |
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
Bu işlev, Sertifika Temel Hazırlık Motoru API'sı etkinliklerinde çağrılan uygulama geri çağırmasıdır. |
EventType{
|
enum |
State{
|
enum |
Herkese açık özellikler |
|
---|---|
AppState
|
void *
Uygulamaya özel verilere işaret eden bir işaretçi.
|
Kamu işlevleri |
|
---|---|
AbortCertificateProvisioning(void)
|
void
Devam eden GetCertificate değişimlerini durdurur.
|
GenerateGetCertificateRequest(PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest)
|
GetCertificateRequest mesajı oluşturun.
|
GetBinding(void) const
|
Binding *
WeaveCertProvEngine ile ilişkilendirilmiş Binding nesnesine bir işaretçi döndürür.
|
GetEventCallback(void) const
|
Halihazırda WeaveCertProvEngine nesnesinde yapılandırılmış API etkinliği geri çağırma işlevine bir işaretçi döndürür.
|
GetMfrAttestDelegate(void) const
|
Hâlihazırda WeaveCertProvEngine nesnesinde yapılandırılmış olan üretici onayı yetki nesnesine bir işaretçi döndürür.
|
GetOpAuthDelegate(void) const
|
Halihazırda WeaveCertProvEngine nesnesinde yapılandırılmış olan operasyonel kimlik doğrulama yetki nesnesine bir işaretçi döndürür.
|
GetReqType(void) const
|
uint8_t
Geçerli istek türünü alın.
|
GetState(void) const
|
WeaveCertProvEngine nesnesinin geçerli durumunu alın.
|
Init(Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState)
|
Sertifika isteği mesajı göndermeye hazırlanmak için bir WeaveCertProvEngine nesnesini başlatın.
|
ProcessGetCertificateResponse(PacketBuffer *msgBuf)
|
GetCertificateResponse mesajını işleyin.
|
SetBinding(Binding *binding)
|
void
Bağlama nesnesini WeaveCertProvEngine nesnesinde ayarlar.
|
SetEventCallback(EventCallback eventCallback)
|
void
WeaveCertProvEngine nesnesinde API etkinliği geri çağırma işlevini ayarlar.
|
SetMfrAttestDelegate(WeaveNodeMfrAttestDelegate *mfrAttestDelegate)
|
void
WeaveCertProvEngine nesnesinde üretici onayı yetki nesnesini ayarlar.
|
SetOpAuthDelegate(WeaveNodeOpAuthDelegate *opAuthDelegate)
|
void
WeaveCertProvEngine nesnesinde operasyonel kimlik doğrulama yetki nesnesini ayarlar.
|
Shutdown(void)
|
void
Daha önce başlatılmış bir WeaveCertProvEngine nesnesini kapatın.
|
StartCertificateProvisioning(uint8_t reqType, bool doMfrAttest)
|
Sertifika Temel Hazırlık Protokolü'nü başlatın.
|
Yapılar |
|
---|---|
nl:: |
Weave Certificate Temel Hazırlık API'sı etkinliğine giriş parametreleri. |
nl:: |
Weave Certificate Temel Hazırlık API'sı etkinliğine çıkış parametreleri. |
Herkese açık türler
@246
@246
Özellikler | |
---|---|
kReqType_GetInitialOpDeviceCert
|
Sertifika Alma istek türü, ilk işlem sertifikası almaktır. |
kReqType_RotateOpDeviceCert
|
Sertifika Alma istek türü, mevcut işlem sertifikasına rotasyon uygulamaktır. |
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Bu işlev, Sertifika Temel Hazırlık Motoru API'sı etkinliklerinde çağrılan uygulama geri çağırmasıdır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
EventType
EventType
Özellikler | |
---|---|
kEvent_CommunicationError
|
GetCertificateRequest gönderilirken veya yanıt beklenirken iletişim hatası oluştu. |
kEvent_PrepareAuthorizeInfo
|
Uygulamadan, yükü GetCertificateRequest için hazırlaması istenir. |
kEvent_ResponseReceived
|
Eşten bir GetCertificateResponse mesajı alındı. |
Eyalet
State
Özellikler | |
---|---|
kState_Idle
|
Motor nesnesi boşta. |
kState_NotInitialized
|
Motor nesnesi başlatılmadı. |
kState_PreparingBinding
|
Motor nesnesi, bağlamanın hazır olmasını bekliyor. |
kState_RequestInProgress
|
Bir GetCertificateRequest iletisi gönderildi ve motor nesnesi bir yanıt bekliyor. |
Herkese açık özellikler
AppState
void * AppState
Uygulamaya özel verilere işaret eden bir işaretçi.
Kamu işlevleri
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
Devam eden GetCertificate değişimlerini durdurur.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
GetCertificateRequest mesajı oluşturun.
Bu yöntem, Weave TLV biçiminde kodlanmış Weave GetCertificateRequest yapısını oluşturur.
Yöntem, GetCertificateRequest mesajını oluştururken mesajın yükünü hazırlamak için WeaveNodeOpAuthDelegate, WeaveNodeMfrAttestDelegate işlevleri ve PrepareAuthorizeInfo API etkinliği aracılığıyla uygulamaya bir istek gönderir.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
GetBinding
Binding * GetBinding( void ) const
WeaveCertProvEngine ile ilişkilendirilmiş Binding nesnesine bir işaretçi döndürür.
GetEventCallback
EventCallback GetEventCallback( void ) const
Halihazırda WeaveCertProvEngine nesnesinde yapılandırılmış API etkinliği geri çağırma işlevine bir işaretçi döndürür.
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
Hâlihazırda WeaveCertProvEngine nesnesinde yapılandırılmış olan üretici onayı yetki nesnesine bir işaretçi döndürür.
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
Halihazırda WeaveCertProvEngine nesnesinde yapılandırılmış olan operasyonel kimlik doğrulama yetki nesnesine bir işaretçi döndürür.
GetReqType
uint8_t GetReqType( void ) const
Geçerli istek türünü alın.
Başlat
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
Sertifika isteği mesajı göndermeye hazırlanmak için bir WeaveCertProvEngine nesnesini başlatın.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
GetCertificateResponse mesajını işleyin.
Bu yöntem, Weave TLV biçiminde kodlanmış Weave GetCertificateResponse yapısını işler.
GetCertificateResponse mesajı başarıyla işlendiğinde, yöntem sonucu teslim etmek için ResponseReceived API etkinliği üzerinden uygulamaya bir çağrıda bulunur.
GetCertificateResponse mesajının işlenmesi başarısız olursa yöntem, hatayı bildirmek için CommunicationError API etkinliği aracılığıyla uygulamaya bir çağrı yapar.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
Döndürülen Değerler |
|
SetBinding
void SetBinding( Binding *binding )
Bağlama nesnesini WeaveCertProvEngine nesnesinde ayarlar.
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
WeaveCertProvEngine nesnesinde API etkinliği geri çağırma işlevini ayarlar.
SetMfrAttestDelegate
void SetMfrAttestDelegate( WeaveNodeMfrAttestDelegate *mfrAttestDelegate )
WeaveCertProvEngine nesnesinde üretici onayı yetki nesnesini ayarlar.
SetOpAuthDelegate
void SetOpAuthDelegate( WeaveNodeOpAuthDelegate *opAuthDelegate )
WeaveCertProvEngine nesnesinde operasyonel kimlik doğrulama yetki nesnesini ayarlar.
Kapat
void Shutdown( void )
Daha önce başlatılmış bir WeaveCertProvEngine nesnesini kapatın.
Bu yöntemin yalnızca Init() yöntemi daha önce çağrıldıysa çağrılabileceğini unutmayın.
StartCertificateProvisioning
WEAVE_ERROR StartCertificateProvisioning( uint8_t reqType, bool doMfrAttest )
Sertifika Temel Hazırlık Protokolü'nü başlatın.
Bu yöntem, CA hizmetine GetCertificateRequest mesajı gönderme işlemini başlatır. İlgili bir GetCertificateResponse mesajı alınırsa, bu mesaj ResponseReceived API etkinliği aracılığıyla uygulamaya teslim edilir.
Bu yöntem çağrıldığında Binding nesnesi Hazır durumda değilse isteğe bağlı hazırlığı başlatmak için Binding::RequestPrepare() yöntemine istek gönderilir. Bu durumda istek işlemi, işlemin tamamlanmasını bekler. İşlenmekte olan önceki bir istek varken yapılan tüm StartCertificateProvisioning() çağrıları yoksayılır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )