nl:: Weave:: Profiles:: Security:: CertProvisioning:: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
वीव सर्टिफ़िकेट प्रॉविज़निंग प्रोटोकॉल ऑब्जेक्ट के मुख्य लॉजिक को लागू करता है.
खास जानकारी
कंस्ट्रक्टर और डिस्ट्रक्टर |
|
---|---|
WeaveCertProvEngine(void)
|
सार्वजनिक प्रकार |
|
---|---|
@246{
|
enum |
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
टाइपडिफ़void(*
यह फ़ंक्शन एक ऐप्लिकेशन कॉलबैक है, जिसे सर्टिफ़िकेट प्रॉविज़निंग इंजन एपीआई इवेंट पर शुरू किया जाता है. |
EventType{
|
enum |
State{
|
enum |
सार्वजनिक विशेषताएं |
|
---|---|
AppState
|
void *
ऐप्लिकेशन के लिए खास डेटा का पॉइंटर.
|
सार्वजनिक फ़ंक्शन |
|
---|---|
AbortCertificateProvisioning(void)
|
void
यह पहले से चल रहे किसी भी Getसर्टिफ़िकेट एक्सचेंज को रोकता है.
|
GenerateGetCertificateRequest(PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest)
|
GetCertificateRequest मैसेज जनरेट करें.
|
GetBinding(void) const
|
Binding *
WeaveCertProvEngine से जुड़े Binding ऑब्जेक्ट पर पॉइंटर दिखाता है.
|
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 Certificate Provisioning API इवेंट में पैरामीटर इनपुट करें. |
nl:: |
Weave Certificate Provisioning API इवेंट के लिए आउटपुट पैरामीटर. |
सार्वजनिक प्रकार
@246
@246
प्रॉपर्टी | |
---|---|
kReqType_GetInitialOpDeviceCert
|
'सर्टिफ़िकेट पाएं' अनुरोध का टाइप, शुरुआती ऑपरेशनल सर्टिफ़िकेट पाने के लिए होता है. |
kReqType_RotateOpDeviceCert
|
'सर्टिफ़िकेट पाएं' अनुरोध का टाइप, मौजूदा ऑपरेशनल सर्टिफ़िकेट को बदलना है. |
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
यह फ़ंक्शन एक ऐप्लिकेशन कॉलबैक है, जिसे सर्टिफ़िकेट प्रॉविज़निंग इंजन एपीआई इवेंट पर शुरू किया जाता है.
जानकारी | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
|
EventType
EventType
प्रॉपर्टी | |
---|---|
kEvent_CommunicationError
|
GetCertificateRequest भेजते समय या किसी जवाब का इंतज़ार करते समय, कम्यूनिकेशन से जुड़ी कोई गड़बड़ी हुई. |
kEvent_PrepareAuthorizeInfo
|
ऐप्लिकेशन से GetCertificateRequest के लिए पेलोड तैयार करने का अनुरोध किया जाता है. |
kEvent_ResponseReceived
|
मिलते-जुलते ऐप्लिकेशन से एक GetCertificateResponse मैसेज मिला. |
स्थिति
State
प्रॉपर्टी | |
---|---|
kState_Idle
|
इंजन ऑब्जेक्ट कुछ समय से इस्तेमाल में नहीं है. |
kState_NotInitialized
|
इंजन ऑब्जेक्ट शुरू नहीं किया गया है. |
kState_PreparingBinding
|
इंजन ऑब्जेक्ट, बाइंडिंग के तैयार होने का इंतज़ार कर रहा है. |
kState_RequestInProgress
|
GetCertificateRequest मैसेज भेज दिया गया है और इंजन ऑब्जेक्ट जवाब का इंतज़ार कर रहा है. |
सार्वजनिक विशेषताएं
AppState
void * AppState
ऐप्लिकेशन के लिए खास डेटा का पॉइंटर.
सार्वजनिक फ़ंक्शन
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
यह पहले से चल रहे किसी भी Getसर्टिफ़िकेट एक्सचेंज को रोकता है.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
GetCertificateRequest मैसेज जनरेट करें.
यह तरीका, Weave TLV फ़ॉर्मैट में एन्कोड किए गए Weave GetCertificateRequest स्ट्रक्चर को जनरेट करता है.
GetCertificateRequest मैसेज बनाते समय, यह तरीका WeaveNodeOpAuthDelegate और WeaveNodeMfrAttestDelegate फ़ंक्शन और AvailableAuthorizeInfo API इवेंट के ज़रिए ऐप्लिकेशन को अनुरोध करता है, ताकि मैसेज का पेलोड तैयार किया जा सके.
जानकारी | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
|
||||||
रिटर्न वैल्यू |
|
GetBinding
Binding * GetBinding( void ) const
WeaveCertProvEngine से जुड़े Binding ऑब्जेक्ट पर पॉइंटर दिखाता है.
GetEventCallback
EventCallback GetEventCallback( void ) const
एपीआई इवेंट कॉलबैक फ़ंक्शन का पॉइंटर दिखाता है, जो अभी WeaveCertProvEngine ऑब्जेक्ट पर कॉन्फ़िगर किया गया है.
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
मैन्युफ़ैक्चरर की पुष्टि करने वाले डेलिगेट ऑब्जेक्ट का पॉइंटर दिखाता है, जिसे फ़िलहाल WeaveCertProvEngine ऑब्जेक्ट पर कॉन्फ़िगर किया गया है.
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
ऑपरेशनल ऑथेंटिकेशन डेलिगेट ऑब्जेक्ट का पॉइंटर दिखाता है, जिसे फ़िलहाल WeaveCertProvEngine ऑब्जेक्ट पर कॉन्फ़िगर किया गया है.
GetReqType
uint8_t GetReqType( void ) const
मौजूदा अनुरोध टाइप को वापस पाएं.
Init
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
सर्टिफ़िकेट पाने के लिए अनुरोध वाला मैसेज भेजने की तैयारी करते समय, WeaveCertProvEngine ऑब्जेक्ट शुरू करें.
जानकारी | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
GetCertificateResponse मैसेज प्रोसेस करें.
यह तरीका, Weave TLV फ़ॉर्मैट में एन्कोड किए गए Weave GetCertificateResponse स्ट्रक्चर को प्रोसेस करता है.
GetCertificateResponse मैसेज की प्रोसेसिंग पूरी हो जाने पर, यह तरीका नतीजा देने के लिए, ResponseReceived API इवेंट के ज़रिए ऐप्लिकेशन को कॉल करता है.
अगर GetCertificateResponse मैसेज की प्रोसेसिंग पूरी नहीं हो पाती, तो यह तरीका गड़बड़ी की रिपोर्ट करने के लिए, CommunicationError API इवेंट के ज़रिए ऐप्लिकेशन को कॉल करता है.
जानकारी | |||
---|---|---|---|
पैरामीटर |
|
||
रिटर्न वैल्यू |
|
SetBinding
void SetBinding( Binding *binding )
बाइंडिंग ऑब्जेक्ट को WeaveCertProvEngine ऑब्जेक्ट पर सेट करता है.
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
यह 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 )
सर्टिफ़िकेट उपलब्ध कराने वाला प्रोटोकॉल चालू करें.
यह तरीका, CA सेवा को GetCertificateRequest मैसेज भेजने की प्रोसेस शुरू करता है. अगर और जब कोई इससे जुड़ा GetCertificateResponse मैसेज मिलता है, तो उसे ResponseReceived API इवेंट के ज़रिए ऐप्लिकेशन में डिलीवर कर दिया जाएगा.
इस तरीके को कॉल करते समय, अगर बाइंडिंग ऑब्जेक्ट, 'तैयार है' की स्थिति में नहीं है, तो मांग पर तैयार की जाने वाली तैयारी शुरू करने के लिए, Binding::RequestPrepare() तरीके से अनुरोध किया जाएगा. अनुरोध पर कार्रवाई तब तक नहीं की जा सकती, जब तक यह प्रोसेस पूरी नहीं हो जाती. किसी पिछले अनुरोध की प्रोसेस जारी होने के दौरान, StartCertificateProvisioning() को किए जाने वाले किसी भी कॉल को अनदेखा कर दिया जाएगा.
जानकारी | |||||
---|---|---|---|---|---|
पैरामीटर |
|
||||
रिटर्न वैल्यू |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )