nl:: بافت:: پروفایل ها:: امنیت:: CertProvisioning:: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
منطق اصلی شیء پروتکل Weave Certificate Provisioning را پیاده سازی می کند.
خلاصه
سازندگان و تخریب کنندگان | |
---|---|
WeaveCertProvEngine (void) |
انواع عمومی | |
---|---|
@246 { | شمارش |
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* این تابع، فراخوانی برنامه است که در رویدادهای API موتور تامین گواهی فراخوانی می شود. |
EventType { | شمارش |
State { | شمارش |
صفات عمومی | |
---|---|
AppState | void * اشاره گر به داده های خاص برنامه. |
توابع عمومی | |
---|---|
AbortCertificateProvisioning (void) | void هرگونه تبادل GetCertificate در حال انجام را متوقف می کند. |
GenerateGetCertificateRequest ( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest) | پیام GetCertificateRequest را ایجاد کنید. |
GetBinding (void) const | Binding * یک اشاره گر به شی 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 شی binding را روی شی 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:: Weave:: پروفایل ها:: امنیت:: CertProvisioning:: WeaveCertProvine:: InEventParam | پارامترهای ورودی به رویداد API Weave Certificate Provisioning. |
nl:: Weave:: پروفایل ها:: امنیت:: CertProvisioning:: WeaveCertProvine:: OutEventParam | پارامترهای خروجی به Weave Certificate Provisioning API رویداد. |
انواع عمومی
@246
@246
رویداد Callback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
این تابع، فراخوانی برنامه است که در رویدادهای API موتور تامین گواهی فراخوانی می شود.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
|
نوع رویداد
EventType
دولت
State
صفات عمومی
AppState
void * AppState
اشاره گر به داده های خاص برنامه.
توابع عمومی
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
هرگونه تبادل GetCertificate در حال انجام را متوقف می کند.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
پیام GetCertificateRequest را ایجاد کنید.
این روش ساختار Weave GetCertificateRequest را با فرمت Weave TLV کدگذاری می کند.
هنگام تشکیل پیام GetCertificateRequest، این روش از طریق توابع WeaveNodeOpAuthDelegate و WeaveNodeMfrAttestDelegate و رویداد PrepareAuthorizeInfo API، درخواستی را برای برنامه کاربردی ارسال می کند تا بار پیام را آماده کند.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
GetBinding
Binding * GetBinding( void ) const
یک اشاره گر به شی Binding مرتبط با WeaveCertProvEngine برمی گرداند .
GetEventCallback
EventCallback GetEventCallback( void ) const
اشاره گر را به تابع تماس رویداد API که در حال حاضر روی شی WeaveCertProvEngine پیکربندی شده است، برمی گرداند.
GetMfrAttest Delegate
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 را پردازش کنید.
این روش ساختار Weave GetCertificateResponse را که در قالب Weave TLV کدگذاری شده است پردازش می کند.
هنگامی که پردازش پیام GetCertificateResponse با موفقیت کامل شد، این روش از طریق رویداد ResponseReceived API با برنامه تماس می گیرد تا نتیجه را ارائه دهد.
اگر پردازش پیام GetCertificateResponse با شکست مواجه شود، این روش از طریق رویداد CommunicationError API با برنامه تماس می گیرد تا خطا را گزارش کند.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
ارزش های بازگشتی |
|
SetBinding
void SetBinding( Binding *binding )
شی binding را روی شی WeaveCertProvEngine تنظیم می کند.
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 مربوطه دریافت شود، از طریق رویداد ResponseReceived API به برنامه تحویل داده می شود.
اگر شی Binding هنگام فراخوانی این متد در حالت Ready نباشد، درخواستی به متد Binding::RequestPrepare () برای شروع آماده سازی بر اساس تقاضا ارسال می شود. سپس عملیات درخواست منتظر می ماند تا این فرآیند کامل شود. هر گونه فراخوانی به StartCertificateProvisioning() در حالی که درخواست قبلی در حال انجام است نادیده گرفته می شود.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
ارزش های بازگشتی |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )
جز در مواردی که غیر از این ذکر شده باشد، محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است و نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است. Thread علامت تجاری ثبتشده Thread Group, Inc است.
تاریخ آخرین بهروزرسانی 2022-08-30 بهوقت ساعت هماهنگ جهانی.