nl:: بافت:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
تعریف شناسه کلید بافت.
خلاصه
این کلاس شامل انواع کلید، پرچم های کلید، تعریف فیلدهای شناسه کلید و توابع API است.
انواع عمومی | |
---|---|
@52 { | شمارش فیلدها، پرچمها و انواع شناسه کلید بافت عمومی. |
توابع استاتیک عمومی | |
---|---|
ConvertToCurrentAppKeyId (uint32_t keyId) | uint32_t شناسه کلید گروه برنامه را به شناسه کلید فعلی برنامه تبدیل کنید. |
ConvertToStaticAppKeyId (uint32_t keyId) | uint32_t شناسه کلید برنامه را به شناسه کلید استاتیک برنامه تبدیل کنید. |
DescribeKey (uint32_t keyId) | const char * یک شناسه کلید Weave را با یک رشته توصیفی رمزگشایی کنید. |
GetAppGroupLocalNumber (uint32_t keyId) | uint8_t شماره محلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است. |
GetAppGroupMasterKeyId (uint32_t keyId) | uint32_t شناسه کلید اصلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است. |
GetEpochKeyId (uint32_t keyId) | uint32_t شناسه کلید عصر گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید. |
GetEpochKeyNumber (uint32_t keyId) | uint8_t شماره کلید دوره گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید. |
GetRootKeyId (uint32_t keyId) | uint32_t شناسه اصلی کلید گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است. |
GetRootKeyNumber (uint32_t keyId) | uint8_t شماره کلید اصلی گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید. |
GetType (uint32_t keyId) | uint32_t نوع کلید Weave را از شناسه کلید مشخص شده دریافت کنید. |
IncorporatesAppGroupMasterKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید اصلی گروه است یا خیر. |
IncorporatesEpochKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید دوره است یا خیر. |
IncorporatesRootKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید ریشه است یا خیر. |
IsAppEpochKey (uint32_t keyId) | bool تعیین کنید که شناسه کلید مشخص شده از نوع کلید دوره کاربردی است یا خیر. |
IsAppGroupKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده متعلق به یکی از انواع کلیدهای گروه برنامه (ایستا یا چرخان) است. |
IsAppGroupMasterKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع کلید اصلی گروه برنامه کاربردی است یا خیر. |
IsAppRootKey (uint32_t keyId) | bool تعیین کنید که شناسه کلید مشخص شده از نوع کلید اصلی برنامه است یا خیر. |
IsAppRotatingKey (uint32_t keyId) | bool تعیین کنید که شناسه کلید مشخص شده از نوع چرخشی برنامه است یا خیر. |
IsAppStaticKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع استاتیک برنامه است یا خیر. |
IsGeneralKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع عمومی است یا خیر. |
IsMessageEncryptionKeyId (uint32_t keyId, bool allowLogicalKeys) | bool تعیین کنید که آیا شناسه کلید داده شده، کلیدی را شناسایی می کند که برای رمزگذاری پیام Weave مناسب است یا خیر. |
IsSameKeyOrGroup (uint32_t keyId1, uint32_t keyId2) | bool تعیین میکند که آیا دو شناسه کلید یک کلید را شناسایی میکنند یا در مورد کلیدهای چرخان، گروهی از کلیدها مستقل از هر دوره خاص. |
IsSessionKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع جلسه است یا خیر. |
IsValidKeyId (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید دارای ارزش معتبر (قانونی) است یا خیر. |
MakeAppGroupMasterKeyId (uint8_t appGroupLocalNumber) | uint32_t شناسه کلید اصلی گروه برنامه را با شماره محلی گروه برنامه بسازید. |
MakeAppIntermediateKeyId (uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey) | uint32_t شناسه کلید میانی برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید. |
MakeAppKeyId (uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey) | uint32_t شناسه کلید گروه برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید. |
MakeAppRotatingKeyId (uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey) | uint32_t شناسه کلید چرخان برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید. |
MakeAppStaticKeyId (uint32_t rootKeyId, uint32_t appGroupMasterKeyId) | uint32_t شناسه کلید استاتیک برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید. |
MakeEpochKeyId (uint8_t epochKeyNumber) | uint32_t شناسه کلید اصلی گروه برنامه را با شماره کلید دوره ای بسازید. |
MakeGeneralKeyId (uint16_t generalKeyNumber) | uint16_t شناسه کلید عمومی را با شماره کلید عمومی بسازید. |
MakeRootKeyId (uint8_t rootKeyNumber) | uint32_t شناسه کلید اصلی گروه برنامه را با شماره کلید اصلی بسازید. |
MakeSessionKeyId (uint16_t sessionKeyNumber) | uint16_t شناسه کلید جلسه را با شماره کلید جلسه ایجاد کنید. |
UpdateEpochKeyId (uint32_t keyId, uint32_t epochKeyId) | uint32_t شناسه کلید گروه برنامه را با شماره کلید دوره جدید به روز کنید. |
UsesCurrentEpochKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده از کلید دوره "جاری" استفاده می کند یا خیر. |
انواع عمومی
@52
@52
فیلدها، پرچمها و انواع شناسه کلید بافت عمومی.
توابع استاتیک عمومی
ConvertToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
شناسه کلید گروه برنامه را به شناسه کلید فعلی برنامه تبدیل کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید فعلی برنامه |
ConvertToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
شناسه کلید برنامه را به شناسه کلید استاتیک برنامه تبدیل کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید استاتیک برنامه |
DescribeKey
const char * DescribeKey( uint32_t keyId )
یک شناسه کلید Weave را با یک رشته توصیفی رمزگشایی کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | یک اشاره گر به یک رشته با پایان NULL که شناسه کلید مشخص شده را توصیف می کند. |
GetAppGroupLocalNumber
uint8_t GetAppGroupLocalNumber( uint32_t keyId )
شماره محلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شماره محلی گروه برنامه |
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
شناسه کلید اصلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه اصلی کلید گروه برنامه |
GetEpochKeyId
uint32_t GetEpochKeyId( uint32_t keyId )
شناسه کلید عصر گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید دوره |
GetEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
شماره کلید دوره گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شماره کلید دوره |
GetRootKeyId
uint32_t GetRootKeyId( uint32_t keyId )
شناسه اصلی کلید گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید ریشه |
GetRootKeyNumber
uint8_t GetRootKeyNumber( uint32_t keyId )
شماره کلید اصلی گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شماره کلید ریشه |
GetType
uint32_t GetType( uint32_t keyId )
نوع کلید Weave را از شناسه کلید مشخص شده دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | نوع شناسه کلید |
AppGroupMasterKey را در بر می گیرد
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید اصلی گروه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای کلید اصلی گروه باشد. |
EpochKey را شامل می شود
bool IncorporatesEpochKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید دوره است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای کلید دوره باشد. |
RootKey را شامل می شود
bool IncorporatesRootKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید ریشه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای کلید ریشه باشد. |
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
تعیین کنید که شناسه کلید مشخص شده از نوع کلید دوره کاربردی است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک کلید دوره کاربردی نوع کاربردی باشد. |
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده متعلق به یکی از انواع کلیدهای گروه برنامه (ایستا یا چرخان) است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اگر keyId از نوع کلید چرخان یا ایستا باشد درست است. |
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع کلید اصلی گروه برنامه کاربردی است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک گروه برنامه کاربردی کلید اصلی را تایپ کند. |
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
تعیین کنید که شناسه کلید مشخص شده از نوع کلید اصلی برنامه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک کلید اصلی برنامه کاربردی باشد. |
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
تعیین کنید که شناسه کلید مشخص شده از نوع چرخشی برنامه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر شناسه کلید یک برنامه در حال چرخش باشد. |
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع استاتیک برنامه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId از نوع استاتیک برنامه باشد. |
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع عمومی است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای نوع General باشد. |
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
تعیین کنید که آیا شناسه کلید داده شده، کلیدی را شناسایی می کند که برای رمزگذاری پیام Weave مناسب است یا خیر.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | درست است اگر از کلید شناسایی شده برای رمزگذاری پیام های Weave استفاده شود. |
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
تعیین میکند که آیا دو شناسه کلید یک کلید را شناسایی میکنند یا در مورد کلیدهای چرخان، گروهی از کلیدها مستقل از هر دوره خاص.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | اگر شناسه کلیدها همان کلید را نشان دهند درست است. |
IsSessionKey
bool IsSessionKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع جلسه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک نوع جلسه باشد. |
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
تعیین کنید که آیا شناسه کلید دارای ارزش معتبر (قانونی) است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اگر مقدار شناسه کلید معتبر باشد درست است. |
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
شناسه کلید اصلی گروه برنامه را با شماره محلی گروه برنامه بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه اصلی کلید گروه برنامه |
MakeAppIntermediateKeyId
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
شناسه کلید میانی برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
برمی گرداند | شناسه کلید میانی برنامه |
MakeAppKeyId
uint32_t MakeAppKeyId( uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
شناسه کلید گروه برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.
جزئیات | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||
برمی گرداند | شناسه کلید گروه برنامه |
MakeAppRotatingKeyId
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
شناسه کلید چرخان برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
برمی گرداند | شناسه کلید چرخان برنامه |
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
شناسه کلید استاتیک برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | شناسه کلید استاتیک برنامه |
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
شناسه کلید اصلی گروه برنامه را با شماره کلید دوره ای بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید دوره |
MakeGeneralKeyId
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
شناسه کلید عمومی را با شماره کلید عمومی بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید عمومی |
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
شناسه کلید اصلی گروه برنامه را با شماره کلید اصلی بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید ریشه |
MakeSessionKeyId
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
شناسه کلید جلسه را با شماره کلید جلسه ایجاد کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید جلسه |
UpdateEpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
شناسه کلید گروه برنامه را با شماره کلید دوره جدید به روز کنید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | شناسه کلید برنامه |
UsesCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده از کلید دوره "جاری" استفاده می کند یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId استفاده از کلید دوره فعلی را نشان دهد. |
nl:: بافت:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
تعریف شناسه کلید بافت.
خلاصه
این کلاس شامل انواع کلید، پرچم های کلید، تعریف فیلدهای شناسه کلید و توابع API است.
انواع عمومی | |
---|---|
@52 { | شمارش فیلدها، پرچمها و انواع شناسه کلید بافت عمومی. |
توابع استاتیک عمومی | |
---|---|
ConvertToCurrentAppKeyId (uint32_t keyId) | uint32_t شناسه کلید گروه برنامه را به شناسه کلید فعلی برنامه تبدیل کنید. |
ConvertToStaticAppKeyId (uint32_t keyId) | uint32_t شناسه کلید برنامه را به شناسه کلید استاتیک برنامه تبدیل کنید. |
DescribeKey (uint32_t keyId) | const char * یک شناسه کلید Weave را با یک رشته توصیفی رمزگشایی کنید. |
GetAppGroupLocalNumber (uint32_t keyId) | uint8_t شماره محلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است. |
GetAppGroupMasterKeyId (uint32_t keyId) | uint32_t شناسه کلید اصلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است. |
GetEpochKeyId (uint32_t keyId) | uint32_t شناسه کلید عصر گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید. |
GetEpochKeyNumber (uint32_t keyId) | uint8_t شماره کلید دوره گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید. |
GetRootKeyId (uint32_t keyId) | uint32_t شناسه اصلی کلید گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است. |
GetRootKeyNumber (uint32_t keyId) | uint8_t شماره کلید اصلی گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید. |
GetType (uint32_t keyId) | uint32_t نوع کلید Weave را از شناسه کلید مشخص شده دریافت کنید. |
IncorporatesAppGroupMasterKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید اصلی گروه است یا خیر. |
IncorporatesEpochKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید دوره است یا خیر. |
IncorporatesRootKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید ریشه است یا خیر. |
IsAppEpochKey (uint32_t keyId) | bool تعیین کنید که شناسه کلید مشخص شده از نوع کلید دوره کاربردی است یا خیر. |
IsAppGroupKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده متعلق به یکی از انواع کلیدهای گروه برنامه (ایستا یا چرخان) است. |
IsAppGroupMasterKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع کلید اصلی گروه برنامه کاربردی است یا خیر. |
IsAppRootKey (uint32_t keyId) | bool تعیین کنید که شناسه کلید مشخص شده از نوع کلید اصلی برنامه است یا خیر. |
IsAppRotatingKey (uint32_t keyId) | bool تعیین کنید که شناسه کلید مشخص شده از نوع چرخشی برنامه است یا خیر. |
IsAppStaticKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع استاتیک برنامه است یا خیر. |
IsGeneralKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع عمومی است یا خیر. |
IsMessageEncryptionKeyId (uint32_t keyId, bool allowLogicalKeys) | bool تعیین کنید که آیا شناسه کلید داده شده، کلیدی را شناسایی می کند که برای رمزگذاری پیام Weave مناسب است یا خیر. |
IsSameKeyOrGroup (uint32_t keyId1, uint32_t keyId2) | bool تعیین میکند که آیا دو شناسه کلید یک کلید را شناسایی میکنند یا در مورد کلیدهای چرخان، گروهی از کلیدها مستقل از هر دوره خاص. |
IsSessionKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید مشخص شده از نوع جلسه است یا خیر. |
IsValidKeyId (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید دارای ارزش معتبر (قانونی) است یا خیر. |
MakeAppGroupMasterKeyId (uint8_t appGroupLocalNumber) | uint32_t شناسه کلید اصلی گروه برنامه را با شماره محلی گروه برنامه بسازید. |
MakeAppIntermediateKeyId (uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey) | uint32_t شناسه کلید میانی برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید. |
MakeAppKeyId (uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey) | uint32_t شناسه کلید گروه برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید. |
MakeAppRotatingKeyId (uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey) | uint32_t شناسه کلید چرخان برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید. |
MakeAppStaticKeyId (uint32_t rootKeyId, uint32_t appGroupMasterKeyId) | uint32_t شناسه کلید استاتیک برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید. |
MakeEpochKeyId (uint8_t epochKeyNumber) | uint32_t شناسه کلید اصلی گروه برنامه را با شماره کلید دوره ای بسازید. |
MakeGeneralKeyId (uint16_t generalKeyNumber) | uint16_t شناسه کلید عمومی را با شماره کلید عمومی بسازید. |
MakeRootKeyId (uint8_t rootKeyNumber) | uint32_t شناسه کلید اصلی گروه برنامه را با شماره کلید اصلی بسازید. |
MakeSessionKeyId (uint16_t sessionKeyNumber) | uint16_t شناسه کلید جلسه را با شماره کلید جلسه ایجاد کنید. |
UpdateEpochKeyId (uint32_t keyId, uint32_t epochKeyId) | uint32_t شناسه کلید گروه برنامه را با شماره کلید دوره جدید به روز کنید. |
UsesCurrentEpochKey (uint32_t keyId) | bool تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده از کلید دوره "جاری" استفاده می کند یا خیر. |
انواع عمومی
@52
@52
فیلدها، پرچمها و انواع شناسه کلید بافت عمومی.
توابع استاتیک عمومی
ConvertToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
شناسه کلید گروه برنامه را به شناسه کلید فعلی برنامه تبدیل کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید فعلی برنامه |
ConvertToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
شناسه کلید برنامه را به شناسه کلید استاتیک برنامه تبدیل کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید استاتیک برنامه |
DescribeKey
const char * DescribeKey( uint32_t keyId )
یک شناسه کلید Weave را با یک رشته توصیفی رمزگشایی کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | یک اشاره گر به یک رشته با پایان NULL که شناسه کلید مشخص شده را توصیف می کند. |
GetAppGroupLocalNumber
uint8_t GetAppGroupLocalNumber( uint32_t keyId )
شماره محلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شماره محلی گروه برنامه |
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
شناسه کلید اصلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه اصلی کلید گروه برنامه |
GetEpochKeyId
uint32_t GetEpochKeyId( uint32_t keyId )
شناسه کلید عصر گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید دوره |
GetEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
شماره کلید دوره گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شماره کلید دوره |
GetRootKeyId
uint32_t GetRootKeyId( uint32_t keyId )
شناسه اصلی کلید گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید ریشه |
GetRootKeyNumber
uint8_t GetRootKeyNumber( uint32_t keyId )
شماره کلید اصلی گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شماره کلید ریشه |
GetType
uint32_t GetType( uint32_t keyId )
نوع کلید Weave را از شناسه کلید مشخص شده دریافت کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | نوع شناسه کلید |
AppGroupMasterKey را در بر می گیرد
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید اصلی گروه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای کلید اصلی گروه باشد. |
EpochKey را شامل می شود
bool IncorporatesEpochKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید دوره است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای کلید دوره باشد. |
RootKey را شامل می شود
bool IncorporatesRootKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید ریشه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای کلید ریشه باشد. |
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
تعیین کنید که شناسه کلید مشخص شده از نوع کلید دوره کاربردی است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک کلید دوره کاربردی نوع کاربردی باشد. |
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده متعلق به یکی از انواع کلیدهای گروه برنامه (ایستا یا چرخان) است.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اگر keyId از نوع کلید چرخان یا ایستا باشد درست است. |
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع کلید اصلی گروه برنامه کاربردی است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک گروه برنامه کاربردی کلید اصلی را تایپ کند. |
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
تعیین کنید که شناسه کلید مشخص شده از نوع کلید اصلی برنامه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک کلید اصلی برنامه کاربردی باشد. |
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
تعیین کنید که شناسه کلید مشخص شده از نوع چرخشی برنامه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر شناسه کلید یک برنامه در حال چرخش باشد. |
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع استاتیک برنامه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId از نوع استاتیک برنامه باشد. |
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع عمومی است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId دارای نوع General باشد. |
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
تعیین کنید که آیا شناسه کلید داده شده، کلیدی را شناسایی می کند که برای رمزگذاری پیام Weave مناسب است یا خیر.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | درست است اگر از کلید شناسایی شده برای رمزگذاری پیام های Weave استفاده شود. |
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
تعیین میکند که آیا دو شناسه کلید یک کلید را شناسایی میکنند یا در مورد کلیدهای چرخان، گروهی از کلیدها مستقل از هر دوره خاص.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | اگر شناسه کلیدها همان کلید را نشان دهند درست است. |
IsSessionKey
bool IsSessionKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید مشخص شده از نوع جلسه است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId یک نوع جلسه باشد. |
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
تعیین کنید که آیا شناسه کلید دارای ارزش معتبر (قانونی) است یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اگر مقدار شناسه کلید معتبر باشد درست است. |
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
شناسه کلید اصلی گروه برنامه را با شماره محلی گروه برنامه بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه اصلی کلید گروه برنامه |
MakeAppIntermediateKeyId
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
شناسه کلید میانی برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
برمی گرداند | شناسه کلید میانی برنامه |
MakeAppKeyId
uint32_t MakeAppKeyId( uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
شناسه کلید گروه برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.
جزئیات | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||
برمی گرداند | شناسه کلید گروه برنامه |
MakeAppRotatingKeyId
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
شناسه کلید چرخان برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
برمی گرداند | شناسه کلید چرخان برنامه |
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
شناسه کلید استاتیک برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | شناسه کلید استاتیک برنامه |
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
شناسه کلید اصلی گروه برنامه را با شماره کلید دوره ای بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید دوره |
MakeGeneralKeyId
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
شناسه کلید عمومی را با شماره کلید عمومی بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید عمومی |
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
شناسه کلید اصلی گروه برنامه را با شماره کلید اصلی بسازید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید ریشه |
MakeSessionKeyId
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
شناسه کلید جلسه را با شماره کلید جلسه ایجاد کنید.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کلید جلسه |
UpdateEpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
شناسه کلید گروه برنامه را با شماره کلید دوره جدید به روز کنید.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
برمی گرداند | شناسه کلید برنامه |
UsesCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده از کلید دوره "جاری" استفاده می کند یا خیر.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | درست است اگر keyId استفاده از کلید دوره فعلی را نشان دهد. |