Google is committed to advancing racial equity for Black communities. See how.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

nl:: بافت:: WeaveKeyId

#include <src/lib/core/WeaveKeyIds.h>

تعریف شناسه کلید بافت.

خلاصه

این کلاس شامل انواع کلید، پرچم های کلید، تعریف فیلدهای شناسه کلید و توابع API است.

انواع عمومی
@52 { kType_None = 0x00000000, kType_General = 0x00001000, kType_Session = 0x00002000, kType_AppStaticKey = 0x00004000, kType_AppRotatingKey = kType_AppStaticKey \| kTypeModifier_IncorporatesEpochKey, kType_AppRootKey = 0x00010000, kType_AppEpochKey = 0x00020000 \| kTypeModifier_IncorporatesEpochKey, kType_AppGroupMasterKey = 0x00030000, kType_AppIntermediateKey = kType_AppRootKey \| kTypeModifier_IncorporatesEpochKey, kNone = kType_None \| 0x0000, kFabricSecret = kType_General \| 0x0001, kFabricRootKey = kType_AppRootKey \| (0 << kShift_RootKeyNumber), kClientRootKey = kType_AppRootKey \| (1 << kShift_RootKeyNumber), kServiceRootKey = kType_AppRootKey \| (2 << kShift_RootKeyNumber), kKeyNumber_Max = kMask_KeyNumber }	شمارش فیلدها، پرچم‌ها و انواع شناسه کلید بافت عمومی.

انواع عمومی

@52 {
 kType_None = 0x00000000,
 kType_General = 0x00001000,
 kType_Session = 0x00002000,
 kType_AppStaticKey = 0x00004000,
 kType_AppRotatingKey = kType_AppStaticKey | kTypeModifier_IncorporatesEpochKey,
 kType_AppRootKey = 0x00010000,
 kType_AppEpochKey = 0x00020000 | kTypeModifier_IncorporatesEpochKey,
 kType_AppGroupMasterKey = 0x00030000,
 kType_AppIntermediateKey = kType_AppRootKey | kTypeModifier_IncorporatesEpochKey,
 kNone = kType_None | 0x0000,
 kFabricSecret = kType_General | 0x0001,
 kFabricRootKey = kType_AppRootKey | (0 << kShift_RootKeyNumber),
 kClientRootKey = kType_AppRootKey | (1 << kShift_RootKeyNumber),
 kServiceRootKey = kType_AppRootKey | (2 << kShift_RootKeyNumber),
 kKeyNumber_Max = kMask_KeyNumber
 }

شمارش

فیلدها، پرچم‌ها و انواع شناسه کلید بافت عمومی.

توابع استاتیک عمومی
`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

فیلدها، پرچم‌ها و انواع شناسه کلید بافت عمومی.

خواص
`kClientRootKey`	شناسه کلید ریشه کلاینت.
`kFabricRootKey`	شناسه کلید ریشه فابریک.
`kFabricSecret`	شناسه مخفی بافت.
`kKeyNumber_Max`	حداکثر مقادیر برای زیرفیلدهای شناسه کلید.
`kNone`	شناسه های کلید جهانی ببافید. شناسه کلید Weave نامشخص.
`kServiceRootKey`	شناسه کلید ریشه سرویس.
`kType_AppEpochKey`	نوع کلید عصر گروه برنامه.
`kType_AppGroupMasterKey`	نوع کلید اصلی گروه برنامه
`kType_AppIntermediateKey`	نوع کلید میانی گروه برنامه.
`kType_AppRootKey`	انواع کلید بافت (به غیر از انواع رمزگذاری پیام Weave). توجه: 16 بیت (از 32) مهم ترین بیت از این نوع نمی توانند همه صفر باشند، زیرا این مقادیر فقط برای کلیدهای رمزگذاری پیام Weave محفوظ هستند. انواع کلید گروه سازنده. نوع کلید اصلی گروه برنامه.
`kType_AppRotatingKey`	نوع کلید چرخشی برنامه
`kType_AppStaticKey`	نوع کلید استاتیک برنامه
`kType_General`	نوع کلید عمومی
`kType_None`	انواع کلید بافت که برای رمزگذاری پیام Weave استفاده می شود. توجه: 16 بیت (از 32) مهم ترین بیت از نوع کلید رمزگذاری پیام باید صفر باشد زیرا فقط 16 بیت کم اهمیت از شناسه در پیام Weave رمزگذاری شده است. پیام Weave رمزگذاری نشده است.
`kType_Session`	نوع کلید جلسه

توابع استاتیک عمومی

ConvertToCurrentAppKeyId

uint32_t ConvertToCurrentAppKeyId(
  uint32_t keyId
)

شناسه کلید گروه برنامه را به شناسه کلید فعلی برنامه تبدیل کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید برنامه

برمی گرداند

شناسه کلید فعلی برنامه

ConvertToStaticAppKeyId

uint32_t ConvertToStaticAppKeyId(
  uint32_t keyId
)

شناسه کلید برنامه را به شناسه کلید استاتیک برنامه تبدیل کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید برنامه

برمی گرداند

شناسه کلید استاتیک برنامه

DescribeKey

const char * DescribeKey(
  uint32_t keyId
)

یک شناسه کلید Weave را با یک رشته توصیفی رمزگشایی کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید را برای رمزگشایی ببافید و رشته توصیفی را برای آن بازگردانید.

برمی گرداند

یک اشاره گر به یک رشته با پایان NULL که شناسه کلید مشخص شده را توصیف می کند.

GetAppGroupLocalNumber

uint8_t GetAppGroupLocalNumber(
  uint32_t keyId
)

شماره محلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شماره محلی گروه برنامه

GetAppGroupMasterKeyId

uint32_t GetAppGroupMasterKeyId(
  uint32_t keyId
)

شناسه کلید اصلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شناسه اصلی کلید گروه برنامه

GetEpochKeyId

uint32_t GetEpochKeyId(
  uint32_t keyId
)

شناسه کلید عصر گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شناسه کلید دوره

GetEpochKeyNumber

uint8_t GetEpochKeyNumber(
  uint32_t keyId
)

شماره کلید دوره گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شماره کلید دوره

GetRootKeyId

uint32_t GetRootKeyId(
  uint32_t keyId
)

شناسه اصلی کلید گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شناسه کلید ریشه

GetRootKeyNumber

uint8_t GetRootKeyNumber(
  uint32_t keyId
)

شماره کلید اصلی گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شماره کلید ریشه

GetType

uint32_t GetType(
  uint32_t keyId
)

نوع کلید Weave را از شناسه کلید مشخص شده دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

نوع شناسه کلید

AppGroupMasterKey را در بر می گیرد

bool IncorporatesAppGroupMasterKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید اصلی گروه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId دارای کلید اصلی گروه باشد.

EpochKey را شامل می شود

bool IncorporatesEpochKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید دوره است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId دارای کلید دوره باشد.

RootKey را شامل می شود

bool IncorporatesRootKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید ریشه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId دارای کلید ریشه باشد.

IsAppEpochKey

bool IsAppEpochKey(
  uint32_t keyId
)

تعیین کنید که شناسه کلید مشخص شده از نوع کلید دوره کاربردی است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک کلید دوره کاربردی نوع کاربردی باشد.

IsAppGroupKey

bool IsAppGroupKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده متعلق به یکی از انواع کلیدهای گروه برنامه (ایستا یا چرخان) است.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

اگر keyId از نوع کلید چرخان یا ایستا باشد درست است.

IsAppGroupMasterKey

bool IsAppGroupMasterKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع کلید اصلی گروه برنامه کاربردی است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک گروه برنامه کاربردی کلید اصلی را تایپ کند.

IsAppRootKey

bool IsAppRootKey(
  uint32_t keyId
)

تعیین کنید که شناسه کلید مشخص شده از نوع کلید اصلی برنامه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک کلید اصلی برنامه کاربردی باشد.

IsAppRotatingKey

bool IsAppRotatingKey(
  uint32_t keyId
)

تعیین کنید که شناسه کلید مشخص شده از نوع چرخشی برنامه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر شناسه کلید یک برنامه در حال چرخش باشد.

IsAppStaticKey

bool IsAppStaticKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع استاتیک برنامه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId از نوع استاتیک برنامه باشد.

IsGeneralKey

bool IsGeneralKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع عمومی است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId دارای نوع General باشد.

IsMessageEncryptionKeyId

bool IsMessageEncryptionKeyId(
  uint32_t keyId,
  bool allowLogicalKeys
)

تعیین کنید که آیا شناسه کلید داده شده، کلیدی را شناسایی می کند که برای رمزگذاری پیام Weave مناسب است یا خیر.

جزئیات

مولفه های

`[in] keyId`	شناسه کلید ببافید.
`[in] allowLogicalKeys`	مشخص می‌کند که آیا شناسه‌های کلیدهای منطقی (مانند کلید چرخان «جاری») باید برای رمزگذاری پیام مناسب در نظر گرفته شوند.

برمی گرداند

درست است اگر از کلید شناسایی شده برای رمزگذاری پیام های Weave استفاده شود.

IsSameKeyOrGroup

bool IsSameKeyOrGroup(
  uint32_t keyId1,
  uint32_t keyId2
)

تعیین می‌کند که آیا دو شناسه کلید یک کلید را شناسایی می‌کنند یا در مورد کلیدهای چرخان، گروهی از کلیدها مستقل از هر دوره خاص.

جزئیات

مولفه های

`[in] keyId1`	اولین شناسه کلید برای تست.
`[in] keyId2`	شناسه کلید دوم برای تست.

برمی گرداند

اگر شناسه کلیدها همان کلید را نشان دهند درست است.

IsSessionKey

bool IsSessionKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع جلسه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک نوع جلسه باشد.

IsValidKeyId

bool IsValidKeyId(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید دارای ارزش معتبر (قانونی) است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

اگر مقدار شناسه کلید معتبر باشد درست است.

MakeAppGroupMasterKeyId

uint32_t MakeAppGroupMasterKeyId(
  uint8_t appGroupLocalNumber
)

شناسه کلید اصلی گروه برنامه را با شماره محلی گروه برنامه بسازید.

جزئیات

مولفه های

[in] appGroupLocalNumber

شماره محلی گروه برنامه

برمی گرداند

شناسه اصلی کلید گروه برنامه

MakeAppIntermediateKeyId

uint32_t MakeAppIntermediateKeyId(
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  bool useCurrentEpochKey
)

شناسه کلید میانی برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.

جزئیات

مولفه های

`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید میانی برنامه استفاده می شود.
`[in] epochKeyId`	شناسه کلید دوره ای که برای استخراج کلید میانی برنامه استفاده می شود.
`[in] useCurrentEpochKey`	یک پرچم بولی که نشان می‌دهد آیا کلید باید با استفاده از کلید دوره «جاری» مشتق شود.

برمی گرداند

شناسه کلید میانی برنامه

MakeAppKeyId

uint32_t MakeAppKeyId(
  uint32_t keyType,
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  uint32_t appGroupMasterKeyId,
  bool useCurrentEpochKey
)

شناسه کلید گروه برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.

جزئیات

مولفه های

`[in] keyType`	نوع کلید گروه برنامه مشتق شده.
`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید گروه برنامه استفاده می شود.
`[in] epochKeyId`	شناسه کلید دوره ای که برای استخراج کلید گروه برنامه استفاده می شود.
`[in] appGroupMasterKeyId`	شناسه اصلی کلید گروه برنامه که برای استخراج کلید گروه برنامه استفاده می شود.
`[in] useCurrentEpochKey`	یک پرچم بولی که نشان می‌دهد آیا کلید باید با استفاده از کلید دوره «جاری» مشتق شود.

برمی گرداند

شناسه کلید گروه برنامه

MakeAppRotatingKeyId

uint32_t MakeAppRotatingKeyId(
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  uint32_t appGroupMasterKeyId,
  bool useCurrentEpochKey
)

شناسه کلید چرخان برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.

جزئیات

مولفه های

`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید چرخان برنامه استفاده می شود.
`[in] epochKeyId`	شناسه کلید دوره ای که برای استخراج کلید چرخان برنامه استفاده می شود.
`[in] appGroupMasterKeyId`	شناسه کلید اصلی گروه برنامه که برای استخراج کلید چرخان برنامه استفاده می شود.
`[in] useCurrentEpochKey`	یک پرچم بولی که نشان می‌دهد آیا کلید باید با استفاده از کلید دوره «جاری» مشتق شود.

برمی گرداند

شناسه کلید چرخان برنامه

MakeAppStaticKeyId

uint32_t MakeAppStaticKeyId(
  uint32_t rootKeyId,
  uint32_t appGroupMasterKeyId
)

شناسه کلید استاتیک برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.

جزئیات

مولفه های

`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید استاتیک برنامه استفاده می شود.
`[in] appGroupMasterKeyId`	شناسه کلید اصلی گروه برنامه که برای استخراج کلید استاتیک برنامه استفاده می شود.

برمی گرداند

شناسه کلید استاتیک برنامه

MakeEpochKeyId

uint32_t MakeEpochKeyId(
  uint8_t epochKeyNumber
)

شناسه کلید اصلی گروه برنامه را با شماره کلید دوره ای بسازید.

جزئیات

مولفه های

[in] epochKeyNumber

شماره کلید دوره

برمی گرداند

شناسه کلید دوره

MakeGeneralKeyId

uint16_t MakeGeneralKeyId(
  uint16_t generalKeyNumber
)

شناسه کلید عمومی را با شماره کلید عمومی بسازید.

جزئیات

مولفه های

[in] generalKeyNumber

شماره کلید عمومی

برمی گرداند

شناسه کلید عمومی

MakeRootKeyId

uint32_t MakeRootKeyId(
  uint8_t rootKeyNumber
)

شناسه کلید اصلی گروه برنامه را با شماره کلید اصلی بسازید.

جزئیات

مولفه های

[in] rootKeyNumber

شماره کلید ریشه

برمی گرداند

شناسه کلید ریشه

MakeSessionKeyId

uint16_t MakeSessionKeyId(
  uint16_t sessionKeyNumber
)

شناسه کلید جلسه را با شماره کلید جلسه ایجاد کنید.

جزئیات

مولفه های

[in] sessionKeyNumber

شماره کلید جلسه

برمی گرداند

شناسه کلید جلسه

UpdateEpochKeyId

uint32_t UpdateEpochKeyId(
  uint32_t keyId,
  uint32_t epochKeyId
)

شناسه کلید گروه برنامه را با شماره کلید دوره جدید به روز کنید.

جزئیات

مولفه های

`[in] keyId`	شناسه کلید برنامه
`[in] epochKeyId`	شناسه کلید دوره ای، که در ساخت شناسه کلید برنامه کاربردی به روز شده استفاده می شود.

برمی گرداند

شناسه کلید برنامه

UsesCurrentEpochKey

bool UsesCurrentEpochKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده از کلید دوره "جاری" استفاده می کند یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId استفاده از کلید دوره فعلی را نشان دهد.

nl:: بافت:: WeaveKeyId

#include <src/lib/core/WeaveKeyIds.h>

تعریف شناسه کلید بافت.

خلاصه

این کلاس شامل انواع کلید، پرچم های کلید، تعریف فیلدهای شناسه کلید و توابع API است.

انواع عمومی

@52 {
 kType_None = 0x00000000,
 kType_General = 0x00001000,
 kType_Session = 0x00002000,
 kType_AppStaticKey = 0x00004000,
 kType_AppRotatingKey = kType_AppStaticKey | kTypeModifier_IncorporatesEpochKey,
 kType_AppRootKey = 0x00010000,
 kType_AppEpochKey = 0x00020000 | kTypeModifier_IncorporatesEpochKey,
 kType_AppGroupMasterKey = 0x00030000,
 kType_AppIntermediateKey = kType_AppRootKey | kTypeModifier_IncorporatesEpochKey,
 kNone = kType_None | 0x0000,
 kFabricSecret = kType_General | 0x0001,
 kFabricRootKey = kType_AppRootKey | (0 << kShift_RootKeyNumber),
 kClientRootKey = kType_AppRootKey | (1 << kShift_RootKeyNumber),
 kServiceRootKey = kType_AppRootKey | (2 << kShift_RootKeyNumber),
 kKeyNumber_Max = kMask_KeyNumber
 }

شمارش

فیلدها، پرچم‌ها و انواع شناسه کلید بافت عمومی.

توابع استاتیک عمومی
`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

فیلدها، پرچم‌ها و انواع شناسه کلید بافت عمومی.

خواص
`kClientRootKey`	شناسه کلید ریشه کلاینت.
`kFabricRootKey`	شناسه کلید ریشه فابریک.
`kFabricSecret`	شناسه مخفی بافت.
`kKeyNumber_Max`	حداکثر مقادیر برای زیرفیلدهای شناسه کلید.
`kNone`	شناسه های کلید جهانی ببافید. شناسه کلید Weave نامشخص.
`kServiceRootKey`	شناسه کلید ریشه سرویس.
`kType_AppEpochKey`	نوع کلید عصر گروه برنامه.
`kType_AppGroupMasterKey`	نوع کلید اصلی گروه برنامه
`kType_AppIntermediateKey`	نوع کلید میانی گروه برنامه.
`kType_AppRootKey`	انواع کلید بافت (به غیر از انواع رمزگذاری پیام Weave). توجه: 16 بیت (از 32) مهم ترین بیت از این نوع نمی توانند همه صفر باشند، زیرا این مقادیر فقط برای کلیدهای رمزگذاری پیام Weave محفوظ هستند. انواع کلید گروه سازنده. نوع کلید اصلی گروه برنامه.
`kType_AppRotatingKey`	نوع کلید چرخشی برنامه
`kType_AppStaticKey`	نوع کلید استاتیک برنامه
`kType_General`	نوع کلید عمومی
`kType_None`	انواع کلید بافت که برای رمزگذاری پیام Weave استفاده می شود. توجه: 16 بیت (از 32) مهم ترین بیت از نوع کلید رمزگذاری پیام باید صفر باشد زیرا فقط 16 بیت کم اهمیت از شناسه در پیام Weave رمزگذاری شده است. پیام Weave رمزگذاری نشده است.
`kType_Session`	نوع کلید جلسه

توابع استاتیک عمومی

ConvertToCurrentAppKeyId

uint32_t ConvertToCurrentAppKeyId(
  uint32_t keyId
)

شناسه کلید گروه برنامه را به شناسه کلید فعلی برنامه تبدیل کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید برنامه

برمی گرداند

شناسه کلید فعلی برنامه

ConvertToStaticAppKeyId

uint32_t ConvertToStaticAppKeyId(
  uint32_t keyId
)

شناسه کلید برنامه را به شناسه کلید استاتیک برنامه تبدیل کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید برنامه

برمی گرداند

شناسه کلید استاتیک برنامه

DescribeKey

const char * DescribeKey(
  uint32_t keyId
)

یک شناسه کلید Weave را با یک رشته توصیفی رمزگشایی کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید را برای رمزگشایی ببافید و رشته توصیفی را برای آن بازگردانید.

برمی گرداند

یک اشاره گر به یک رشته با پایان NULL که شناسه کلید مشخص شده را توصیف می کند.

GetAppGroupLocalNumber

uint8_t GetAppGroupLocalNumber(
  uint32_t keyId
)

شماره محلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شماره محلی گروه برنامه

GetAppGroupMasterKeyId

uint32_t GetAppGroupMasterKeyId(
  uint32_t keyId
)

شناسه کلید اصلی گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شناسه اصلی کلید گروه برنامه

GetEpochKeyId

uint32_t GetEpochKeyId(
  uint32_t keyId
)

شناسه کلید عصر گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شناسه کلید دوره

GetEpochKeyNumber

uint8_t GetEpochKeyNumber(
  uint32_t keyId
)

شماره کلید دوره گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شماره کلید دوره

GetRootKeyId

uint32_t GetRootKeyId(
  uint32_t keyId
)

شناسه اصلی کلید گروه برنامه را دریافت کنید که برای استخراج کلید برنامه مشخص شده استفاده شده است.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شناسه کلید ریشه

GetRootKeyNumber

uint8_t GetRootKeyNumber(
  uint32_t keyId
)

شماره کلید اصلی گروه برنامه را که برای استخراج کلید برنامه مشخص شده استفاده شده است، دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

شماره کلید ریشه

GetType

uint32_t GetType(
  uint32_t keyId
)

نوع کلید Weave را از شناسه کلید مشخص شده دریافت کنید.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

نوع شناسه کلید

AppGroupMasterKey را در بر می گیرد

bool IncorporatesAppGroupMasterKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید اصلی گروه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId دارای کلید اصلی گروه باشد.

EpochKey را شامل می شود

bool IncorporatesEpochKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید دوره است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId دارای کلید دوره باشد.

RootKey را شامل می شود

bool IncorporatesRootKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده دارای کلید ریشه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId دارای کلید ریشه باشد.

IsAppEpochKey

bool IsAppEpochKey(
  uint32_t keyId
)

تعیین کنید که شناسه کلید مشخص شده از نوع کلید دوره کاربردی است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک کلید دوره کاربردی نوع کاربردی باشد.

IsAppGroupKey

bool IsAppGroupKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده متعلق به یکی از انواع کلیدهای گروه برنامه (ایستا یا چرخان) است.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

اگر keyId از نوع کلید چرخان یا ایستا باشد درست است.

IsAppGroupMasterKey

bool IsAppGroupMasterKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع کلید اصلی گروه برنامه کاربردی است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک گروه برنامه کاربردی کلید اصلی را تایپ کند.

IsAppRootKey

bool IsAppRootKey(
  uint32_t keyId
)

تعیین کنید که شناسه کلید مشخص شده از نوع کلید اصلی برنامه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک کلید اصلی برنامه کاربردی باشد.

IsAppRotatingKey

bool IsAppRotatingKey(
  uint32_t keyId
)

تعیین کنید که شناسه کلید مشخص شده از نوع چرخشی برنامه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر شناسه کلید یک برنامه در حال چرخش باشد.

IsAppStaticKey

bool IsAppStaticKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع استاتیک برنامه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId از نوع استاتیک برنامه باشد.

IsGeneralKey

bool IsGeneralKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع عمومی است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId دارای نوع General باشد.

IsMessageEncryptionKeyId

bool IsMessageEncryptionKeyId(
  uint32_t keyId,
  bool allowLogicalKeys
)

تعیین کنید که آیا شناسه کلید داده شده، کلیدی را شناسایی می کند که برای رمزگذاری پیام Weave مناسب است یا خیر.

جزئیات

مولفه های

`[in] keyId`	شناسه کلید ببافید.
`[in] allowLogicalKeys`	مشخص می‌کند که آیا شناسه‌های کلیدهای منطقی (مانند کلید چرخان «جاری») باید برای رمزگذاری پیام مناسب در نظر گرفته شوند.

برمی گرداند

درست است اگر از کلید شناسایی شده برای رمزگذاری پیام های Weave استفاده شود.

IsSameKeyOrGroup

bool IsSameKeyOrGroup(
  uint32_t keyId1,
  uint32_t keyId2
)

جزئیات

مولفه های

`[in] keyId1`	اولین شناسه کلید برای تست.
`[in] keyId2`	شناسه کلید دوم برای تست.

برمی گرداند

اگر شناسه کلیدها همان کلید را نشان دهند درست است.

IsSessionKey

bool IsSessionKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید مشخص شده از نوع جلسه است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

درست است اگر keyId یک نوع جلسه باشد.

IsValidKeyId

bool IsValidKeyId(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید دارای ارزش معتبر (قانونی) است یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید ببافید.

برمی گرداند

اگر مقدار شناسه کلید معتبر باشد درست است.

MakeAppGroupMasterKeyId

uint32_t MakeAppGroupMasterKeyId(
  uint8_t appGroupLocalNumber
)

شناسه کلید اصلی گروه برنامه را با شماره محلی گروه برنامه بسازید.

جزئیات

مولفه های

[in] appGroupLocalNumber

شماره محلی گروه برنامه

برمی گرداند

شناسه اصلی کلید گروه برنامه

MakeAppIntermediateKeyId

uint32_t MakeAppIntermediateKeyId(
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  bool useCurrentEpochKey
)

شناسه کلید میانی برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.

جزئیات

مولفه های

`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید میانی برنامه استفاده می شود.
`[in] epochKeyId`	شناسه کلید دوره ای که برای استخراج کلید میانی برنامه استفاده می شود.
`[in] useCurrentEpochKey`	یک پرچم بولی که نشان می‌دهد آیا کلید باید با استفاده از کلید دوره «جاری» مشتق شود.

برمی گرداند

شناسه کلید میانی برنامه

MakeAppKeyId

uint32_t MakeAppKeyId(
  uint32_t keyType,
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  uint32_t appGroupMasterKeyId,
  bool useCurrentEpochKey
)

شناسه کلید گروه برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.

جزئیات

مولفه های

`[in] keyType`	نوع کلید گروه برنامه مشتق شده.
`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید گروه برنامه استفاده می شود.
`[in] epochKeyId`	شناسه کلید دوره ای که برای استخراج کلید گروه برنامه استفاده می شود.
`[in] appGroupMasterKeyId`	شناسه اصلی کلید گروه برنامه که برای استخراج کلید گروه برنامه استفاده می شود.
`[in] useCurrentEpochKey`	یک پرچم بولی که نشان می‌دهد آیا کلید باید با استفاده از کلید دوره «جاری» مشتق شود.

برمی گرداند

شناسه کلید گروه برنامه

MakeAppRotatingKeyId

uint32_t MakeAppRotatingKeyId(
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  uint32_t appGroupMasterKeyId,
  bool useCurrentEpochKey
)

شناسه کلید چرخان برنامه را با توجه به شناسه های کلید تشکیل دهنده و سایر اطلاعات بسازید.

جزئیات

مولفه های

`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید چرخان برنامه استفاده می شود.
`[in] epochKeyId`	شناسه کلید دوره ای که برای استخراج کلید چرخان برنامه استفاده می شود.
`[in] appGroupMasterKeyId`	شناسه کلید اصلی گروه برنامه که برای استخراج کلید چرخان برنامه استفاده می شود.
`[in] useCurrentEpochKey`	یک پرچم بولی که نشان می‌دهد آیا کلید باید با استفاده از کلید دوره «جاری» مشتق شود.

برمی گرداند

شناسه کلید چرخان برنامه

MakeAppStaticKeyId

uint32_t MakeAppStaticKeyId(
  uint32_t rootKeyId,
  uint32_t appGroupMasterKeyId
)

شناسه کلید استاتیک برنامه را با توجه به شناسه های کلید تشکیل دهنده بسازید.

جزئیات

مولفه های

`[in] rootKeyId`	شناسه کلید ریشه برای استخراج کلید استاتیک برنامه استفاده می شود.
`[in] appGroupMasterKeyId`	شناسه کلید اصلی گروه برنامه که برای استخراج کلید استاتیک برنامه استفاده می شود.

برمی گرداند

شناسه کلید استاتیک برنامه

MakeEpochKeyId

uint32_t MakeEpochKeyId(
  uint8_t epochKeyNumber
)

شناسه کلید اصلی گروه برنامه را با شماره کلید دوره ای بسازید.

جزئیات

مولفه های

[in] epochKeyNumber

شماره کلید دوره

برمی گرداند

شناسه کلید دوره

MakeGeneralKeyId

uint16_t MakeGeneralKeyId(
  uint16_t generalKeyNumber
)

شناسه کلید عمومی را با شماره کلید عمومی بسازید.

جزئیات

مولفه های

[in] generalKeyNumber

شماره کلید عمومی

برمی گرداند

شناسه کلید عمومی

MakeRootKeyId

uint32_t MakeRootKeyId(
  uint8_t rootKeyNumber
)

شناسه کلید اصلی گروه برنامه را با شماره کلید اصلی بسازید.

جزئیات

مولفه های

[in] rootKeyNumber

شماره کلید ریشه

برمی گرداند

شناسه کلید ریشه

MakeSessionKeyId

uint16_t MakeSessionKeyId(
  uint16_t sessionKeyNumber
)

شناسه کلید جلسه را با شماره کلید جلسه ایجاد کنید.

جزئیات

مولفه های

[in] sessionKeyNumber

شماره کلید جلسه

برمی گرداند

شناسه کلید جلسه

UpdateEpochKeyId

uint32_t UpdateEpochKeyId(
  uint32_t keyId,
  uint32_t epochKeyId
)

شناسه کلید گروه برنامه را با شماره کلید دوره جدید به روز کنید.

جزئیات

مولفه های

`[in] keyId`	شناسه کلید برنامه
`[in] epochKeyId`	شناسه کلید دوره ای، که در ساخت شناسه کلید برنامه کاربردی به روز شده استفاده می شود.

برمی گرداند

شناسه کلید برنامه

UsesCurrentEpochKey

bool UsesCurrentEpochKey(
  uint32_t keyId
)

تعیین کنید که آیا شناسه کلید گروه برنامه مشخص شده از کلید دوره "جاری" استفاده می کند یا خیر.

جزئیات

مولفه های

[in] keyId

شناسه کلید گروه برنامه را ببافید.

برمی گرداند

درست است اگر keyId استفاده از کلید دوره فعلی را نشان دهد.