nl:: बुनें:: प्रोफाइल:: सुरक्षा:: प्रमाणपत्र प्रावधान:: WeaveCertProvEngine

#include <src/lib/profiles/security/WeaveCertProvisioning.h>

वीव सर्टिफिकेट प्रोविजनिंग प्रोटोकॉल ऑब्जेक्ट के मुख्य तर्क को लागू करता है।

सारांश

निर्माता और विनाशक

WeaveCertProvEngine (void)

सार्वजनिक प्रकार

@246 {
kReqType_GetInitialOpDeviceCert = 0,
kReqType_RotateOpDeviceCert = 1
}
एन्यूम
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) टाइपडीफ
void(*
यह फ़ंक्शन एप्लिकेशन कॉलबैक है जिसे प्रमाणपत्र प्रावधान इंजन API ईवेंट पर लागू किया जाता है।
EventType {
kEvent_PrepareAuthorizeInfo = 1,
kEvent_ResponseReceived = 2,
kEvent_CommunicationError = 3
}
एन्यूम
State {
kState_NotInitialized = 0,
kState_Idle = 1,
kState_PreparingBinding = 2,
kState_RequestInProgress = 3
}
एन्यूम

सार्वजनिक गुण

AppState
void *
एप्लिकेशन-विशिष्ट डेटा के लिए एक सूचक।

सार्वजनिक समारोह

AbortCertificateProvisioning (void)
void
किसी भी GetCertificate एक्सचेंज को प्रगति पर रोक देता है।
GenerateGetCertificateRequest ( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest)
GetCertificateRequest संदेश जनरेट करें।
GetBinding (void) const
करने के लिए एक सूचक रिटर्न बाध्यकारी के साथ जुड़े वस्तु WeaveCertProvEngine
GetEventCallback (void) const
वर्तमान में पर कॉन्फ़िगर एपीआई घटना कॉलबैक फ़ंक्शन पर एक सूचक रिटर्न 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
पर एपीआई घटना कॉलबैक फ़ंक्शन सेट WeaveCertProvEngine वस्तु।
SetMfrAttestDelegate ( WeaveNodeMfrAttestDelegate *mfrAttestDelegate)
void
पर निर्माता सत्यापन प्रतिनिधि वस्तु सेट WeaveCertProvEngine वस्तु।
SetOpAuthDelegate ( WeaveNodeOpAuthDelegate *opAuthDelegate)
void
पर परिचालन प्रमाणीकरण प्रतिनिधि वस्तु सेट WeaveCertProvEngine वस्तु।
Shutdown (void)
void
शटडाउन एक पहले से प्रारंभ WeaveCertProvEngine वस्तु।
StartCertificateProvisioning (uint8_t reqType, bool doMfrAttest)
प्रमाणपत्र प्रावधान प्रोटोकॉल प्रारंभ करें।

स्ट्रक्चर्स

nl :: Weave :: प्रोफाइल :: सुरक्षा :: CertProvisioning :: WeaveCertProvEngine :: InEventParam

वीव सर्टिफिकेट प्रोविजनिंग एपीआई इवेंट के लिए इनपुट पैरामीटर।

nl :: Weave :: प्रोफाइल :: सुरक्षा :: CertProvisioning :: WeaveCertProvEngine :: OutEventParam

वीव सर्टिफिकेट प्रोविजनिंग एपीआई इवेंट के आउटपुट पैरामीटर।

सार्वजनिक प्रकार

@ 246

 @246
गुण
kReqType_GetInitialOpDeviceCert

प्रमाणपत्र प्राप्त करें अनुरोध प्रकार प्रारंभिक परिचालन प्रमाणपत्र प्राप्त करना है।

kReqType_RotateOpDeviceCert

प्रमाणपत्र प्राप्त करें अनुरोध प्रकार वर्तमान परिचालन प्रमाणपत्र को घुमाने के लिए है।

इवेंट कॉलबैक

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

यह फ़ंक्शन एप्लिकेशन कॉलबैक है जिसे प्रमाणपत्र प्रावधान इंजन API ईवेंट पर लागू किया जाता है।

विवरण
मापदंडों
[in] appState
इंजन ऑब्जेक्ट से जुड़ी एप्लिकेशन-परिभाषित स्थिति की जानकारी के लिए एक सूचक।
[in] eventType
इवेंट आईडी को इवेंट कॉलबैक द्वारा पास किया गया।
[in] inParam
ईवेंट कॉलबैक द्वारा पारित इनपुट ईवेंट पैरामीटर का संदर्भ।
[in] outParam
इवेंट कॉलबैक द्वारा पारित आउटपुट इवेंट पैरामीटर का संदर्भ।

घटना प्रकार

 EventType
गुण
kEvent_CommunicationError

GetCertificateRequest भेजते समय या प्रतिक्रिया की प्रतीक्षा करते समय एक संचार त्रुटि उत्पन्न हुई।

kEvent_PrepareAuthorizeInfo

आवेदन से अनुरोध है कि GetCertificateRequest के लिए पेलोड तैयार करें।

kEvent_ResponseReceived

सहकर्मी से एक GetCertificateResponse संदेश प्राप्त हुआ था।

राज्य

 State
गुण
kState_Idle

इंजन ऑब्जेक्ट निष्क्रिय है।

kState_NotInitialized

इंजन ऑब्जेक्ट प्रारंभ नहीं किया गया है।

kState_PreparingBinding

इंजन ऑब्जेक्ट बाइंडिंग के तैयार होने की प्रतीक्षा कर रहा है।

kState_RequestInProgress

एक GetCertificateRequest संदेश भेजा गया है और इंजन ऑब्जेक्ट प्रतिक्रिया की प्रतीक्षा कर रहा है।

सार्वजनिक गुण

ऐपस्टेट

void * AppState

एप्लिकेशन-विशिष्ट डेटा के लिए एक सूचक।

सार्वजनिक समारोह

निरस्त प्रमाणपत्र प्रावधान

void AbortCertificateProvisioning(
  void
)

किसी भी GetCertificate एक्सचेंज को प्रगति पर रोकता है।

सर्टिफ़िकेट रिक्वेस्ट जेनरेट करें

WEAVE_ERROR GenerateGetCertificateRequest(
  PacketBuffer *msgBuf,
  uint8_t reqType,
  bool doMfrAttest
)

GetCertificateRequest संदेश जनरेट करें।

इस विधि Weave GetCertificateRequest संरचना बुनाई में इनकोडिंग उत्पन्न TLV प्रारूप।

जब GetCertificateRequest संदेश गठन, विधि आवेदन के लिए एक अनुरोध करता है, के माध्यम से WeaveNodeOpAuthDelegate और WeaveNodeMfrAttestDelegate , संदेश का पेलोड तैयार करने के लिए कार्य करता है और PrepareAuthorizeInfo एपीआई घटना।

विवरण
मापदंडों
[in] msgBuf
GetCertificateRequest संदेश धारण करने वाले PacketBuffer ऑब्जेक्ट के लिए एक सूचक।
[in] reqType
प्रमाणपत्र अनुरोध प्रकार प्राप्त करें।
[in] doMfrAttest
एक बूलियन ध्वज जो इंगित करता है कि अनुरोध में निर्माता सत्यापन डेटा शामिल होना चाहिए या नहीं।
वापसी मूल्य
WEAVE_NO_ERROR
यदि GetCertificateRequest सफलतापूर्वक जनरेट किया गया था।

गेट बाइंडिंग

Binding * GetBinding(
  void
) const 

करने के लिए एक सूचक रिटर्न बाध्यकारी के साथ जुड़े वस्तु WeaveCertProvEngine

गेटइवेंट कॉलबैक

EventCallback GetEventCallback(
  void
) const 

वर्तमान में पर कॉन्फ़िगर एपीआई घटना कॉलबैक फ़ंक्शन पर एक सूचक रिटर्न WeaveCertProvEngine वस्तु।

GetMfrAttestDelegate

WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate(
  void
) const 

वर्तमान में पर कॉन्फ़िगर निर्माता सत्यापन प्रतिनिधि वस्तु के लिए एक सूचक रिटर्न WeaveCertProvEngine वस्तु।

GetOpAuthDelegate

WeaveNodeOpAuthDelegate * GetOpAuthDelegate(
  void
) const 

वर्तमान में पर कॉन्फ़िगर परिचालन प्रमाणीकरण प्रतिनिधि वस्तु के लिए एक सूचक रिटर्न WeaveCertProvEngine वस्तु।

GetReqटाइप

uint8_t GetReqType(
  void
) const 

वर्तमान अनुरोध प्रकार पुनर्प्राप्त करें।

गेटस्टेट

State GetState(
  void
) const 

की वर्तमान स्थिति को पुनः प्राप्त WeaveCertProvEngine वस्तु।

में इस

WEAVE_ERROR Init(
  Binding *binding,
  WeaveNodeOpAuthDelegate *opAuthDelegate,
  WeaveNodeMfrAttestDelegate *mfrAttestDelegate,
  EventCallback eventCallback,
  void *appState
)

एक प्रारंभ WeaveCertProvEngine प्राप्त प्रमाणपत्र अनुरोध संदेश भेजने के लिए तैयारी में वस्तु।

विवरण
मापदंडों
[in] binding
एक बाध्यकारी उद्देश्य यह है कि सहकर्मी नोड के साथ संचार स्थापित करने के लिए इस्तेमाल किया जाएगा।
[in] opAuthDelegate
ऑपरेशनल ऑथेंटिकेशन डेलिगेट ऑब्जेक्ट के लिए एक पॉइंटर जिसका उपयोग नोड के ऑपरेशनल क्रेडेंशियल्स का उपयोग करके निर्माण और हस्ताक्षर करने के लिए किया जाएगा।
[in] mfrAttestDelegate
एक निर्माता सत्यापन प्रतिनिधि वस्तु के लिए एक सूचक जिसका उपयोग नोड के निर्माता प्रावधान क्रेडेंशियल्स का उपयोग करके अनुरोध बनाने और हस्ताक्षर करने के लिए किया जाएगा।
[in] eventCallback
एक समारोह है कि द्वारा बुलाया जाएगा करने के लिए एक सूचक WeaveCertProvEngine वस्तु आवेदन करने के लिए एपीआई घटनाओं वितरित करने के लिए।
[in] appState
एप्लिकेशन-परिभाषित ऑब्जेक्ट के लिए एक पॉइंटर जो कि जब भी कोई एपीआई इवेंट होता है, तो एप्लिकेशन को वापस भेज दिया जाएगा।

प्रक्रिया GetCertificateResponse

WEAVE_ERROR ProcessGetCertificateResponse(
  PacketBuffer *msgBuf
)

प्रक्रिया GetCertificateResponse संदेश।

इस विधि Weave GetCertificateResponse संरचना बुनाई में इनकोडिंग प्रक्रियाओं TLV प्रारूप।

जब GetCertificateResponse संदेश का प्रसंस्करण सफलतापूर्वक पूरा हो जाता है, तो विधि ResponseReceived API ईवेंट के माध्यम से परिणाम देने के लिए एप्लिकेशन को कॉल करती है।

यदि GetCertificateResponse संदेश की प्रोसेसिंग विफल हो जाती है, तो त्रुटि की रिपोर्ट करने के लिए, विधि CommunicationError API ईवेंट के माध्यम से एप्लिकेशन को कॉल करती है।

विवरण
मापदंडों
[in] msgBuf
GetCertificateResponse संदेश धारण करने वाले PacketBuffer ऑब्जेक्ट के लिए एक सूचक।
वापसी मूल्य
WEAVE_NO_ERROR
यदि GetCertificateResponse संदेश सफलतापूर्वक संसाधित किया गया था।

सेट बाइंडिंग

void SetBinding(
  Binding *binding
)

पर बाध्यकारी वस्तु सेट WeaveCertProvEngine वस्तु।

सेटइवेंट कॉलबैक

void SetEventCallback(
  EventCallback eventCallback
)

पर एपीआई घटना कॉलबैक फ़ंक्शन सेट WeaveCertProvEngine वस्तु।

सेटMfrAttestDelegate

void SetMfrAttestDelegate(
  WeaveNodeMfrAttestDelegate *mfrAttestDelegate
)

पर निर्माता सत्यापन प्रतिनिधि वस्तु सेट WeaveCertProvEngine वस्तु।

SetOpAuthDelegate

void SetOpAuthDelegate(
  WeaveNodeOpAuthDelegate *opAuthDelegate
)

पर परिचालन प्रमाणीकरण प्रतिनिधि वस्तु सेट WeaveCertProvEngine वस्तु।

शट डाउन

void Shutdown(
  void
)

शटडाउन एक पहले से प्रारंभ WeaveCertProvEngine वस्तु।

ध्यान दें कि यह विधि केवल तभी कहा जा सकता है Init () विधि पहले से बुलाया गया है।

प्रारंभ प्रमाणपत्र प्रावधान

WEAVE_ERROR StartCertificateProvisioning(
  uint8_t reqType,
  bool doMfrAttest
)

प्रमाणपत्र प्रावधान प्रोटोकॉल प्रारंभ करें।

यह विधि CA सेवा को GetCertificateRequest संदेश भेजने की प्रक्रिया आरंभ करती है। यदि और जब कोई संबंधित GetCertificateResponse संदेश प्राप्त होता है, तो इसे ResponseReceived API ईवेंट के माध्यम से एप्लिकेशन को डिलीवर किया जाएगा।

यदि बाध्यकारी वस्तु तैयार राज्य जब इस विधि कहा जाता है में नहीं है, एक अनुरोध के प्रयास किए जाएंगे बाइंडिंग :: RequestPrepare () पर मांग तैयारी शुरू करने के लिए विधि। इस प्रक्रिया के पूरा होने तक अनुरोध कार्रवाई तब तक प्रतीक्षारत रहेगी। करने के लिए किसी भी कॉल StartCertificateProvisioning () की प्रक्रिया में पिछले एक अनुरोध अनदेखा कर दिया जाएगा नहीं है, जबकि।

विवरण
मापदंडों
[in] reqType
प्रमाणपत्र अनुरोध प्रकार प्राप्त करें।
[in] doMfrAttest
एक बूलियन ध्वज जो इंगित करता है कि प्रोटोकॉल में निर्माता सत्यापन डेटा शामिल होना चाहिए या नहीं।
वापसी मूल्य
WEAVE_NO_ERROR
यदि StartCertificateProvisioning () सफलतापूर्वक पूरा हुआ।

WeaveCertProvEngine

 WeaveCertProvEngine(
  void
)