تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

nl::Weave::WeaveKeyId

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

تعريف معرِّف Weave Key.

ملخّص

تحتوي هذه الفئة على أنواع المفاتيح وعلامات المفاتيح وتعريف حقول أرقام التعريف الرئيسية ووظائف واجهة برمجة التطبيقات.

الأنواع العلنية
@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 }	تعداد حقول رقم تعريف مفتاح Weave العام وأعلامه وأنواعه.

الأنواع العلنية

@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
}

تعداد

حقول رقم تعريف مفتاح Weave العام وأعلامه وأنواعه.

الدوال الثابتة العامة
`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

حقول رقم تعريف مفتاح Weave العام وأعلامه وأنواعه.

أماكن إقامة
`kClientRootKey`	رقم تعريف مفتاح جذر العميل.
`kFabricRootKey`	رقم تعريف مفتاح جذر القماش
`kFabricSecret`	المعرّف السري لنسيج النسيج.
`kKeyNumber_Max`	القيم القصوى للحقول الفرعية لرقم تعريف المفتاح.
`kNone`	يمكنك دمج معرّفات المفاتيح العامة. رقم تعريف مفتاح Weave غير محدَّد.
`kServiceRootKey`	رقم تعريف مفتاح جذر الخدمة.
`kType_AppEpochKey`	نوع مفتاح حقبة مجموعة التطبيقات.
`kType_AppGroupMasterKey`	نوع المفتاح الرئيسي لمجموعة التطبيقات.
`kType_AppIntermediateKey`	نوع المفتاح المتوسط لمجموعة التطبيقات.
`kType_AppRootKey`	أنواع مفاتيح Weave (بخلاف أنواع تشفير رسائل Weave) ملاحظة: لا يمكن أن تكون أهم 16 وحدة بت من هذه الأنواع (من 32) أصفارًا، لأنّ هذه القيم محجوزة لمفاتيح تشفير رسائل Weave فقط. نوع مفتاح المجموعة المكونة.نوع المفتاح الأساسي لمجموعة التطبيقات.
`kType_AppRotatingKey`	نوع مفتاح التطبيق بالتناوب
`kType_AppStaticKey`	نوع المفتاح الثابت للتطبيق.
`kType_General`	نوع المفتاح العام.
`kType_None`	أنواع مفاتيح Weave المستخدمة لتشفير رسائل Weave. ملاحظة: يجب أن يكون 16 بت (من بين 32) أهم وحدة بت من نوع مفتاح تشفير الرسالة صفرًا لأن رسالة Weave لا يتم تشفيرها سوى 16 وحدة بت أقل أهمية من المعرّف.
`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

معرِّف مفتاح Weave

المرتجعات

نوع معرف المفتاح.

IncorporatesAppGroupMasterKey

bool IncorporatesAppGroupMasterKey(
  uint32_t keyId
)

حدِّد ما إذا كان رقم تعريف مفتاح مجموعة التطبيقات المحدَّد يشتمل على مفتاح المجموعة الرئيسي.

التفاصيل

المَعلمات

[in] keyId

نسج معرّف مفتاح مجموعة التطبيقات.

المرتجعات

صحيح إذا كان keyId يشتمل على مفتاح مجموعة رئيسي.

IncorporatesEpochKey

bool IncorporatesEpochKey(
  uint32_t keyId
)

حدِّد ما إذا كان رقم تعريف مفتاح مجموعة التطبيقات المحدَّد يتضمّن مفتاح الحقبة.

التفاصيل

المَعلمات

[in] keyId

نسج معرّف مفتاح مجموعة التطبيقات.

المرتجعات

true إذا كان keyId يشتمل على مفتاح Epoch.

IncorporatesRootKey

bool IncorporatesRootKey(
  uint32_t keyId
)

حدِّد ما إذا كان رقم تعريف مفتاح مجموعة التطبيقات المحدَّد يتضمّن المفتاح الجذر أم لا.

التفاصيل

المَعلمات

[in] keyId

نسج معرّف مفتاح مجموعة التطبيقات.

المرتجعات

true إذا كان معرف المفتاح يتضمن مفتاح الجذر.

IsAppEpochKey

bool IsAppEpochKey(
  uint32_t keyId
)

حدِّد ما إذا كان رقم تعريف المفتاح المحدَّد من نوع مفتاح حقبة التطبيق.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان معرِّف المفتاح لنوع مفتاح حقبة التطبيق.

IsAppGroupKey

bool IsAppGroupKey(
  uint32_t keyId
)

حدِّد ما إذا كان معرِّف المفتاح المحدَّد ينتمي إلى أحد أنواع مفاتيح مجموعة التطبيقات (ثابت أو مستدير).

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان keyId من نوع مفتاح دوّار أو ثابت.

IsAppGroupMasterKey

bool IsAppGroupMasterKey(
  uint32_t keyId
)

حدِّد ما إذا كان معرِّف المفتاح المحدَّد من نوع مفتاح رئيسي لمجموعة التطبيقات.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان رقم تعريف المفتاح لنوع مفتاح رئيسي لمجموعة التطبيقات.

IsAppRootKey

bool IsAppRootKey(
  uint32_t keyId
)

حدِّد ما إذا كان معرِّف المفتاح المحدَّد من نوع مفتاح التطبيق الجذر.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان رقم تعريف المفتاح لنوع مفتاح جذر التطبيق.

IsAppRotatingKey

bool IsAppRotatingKey(
  uint32_t keyId
)

حدِّد ما إذا كان رقم تعريف المفتاح المحدَّد من نوع التغيير الذي يتم إجراؤه على التطبيق.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان معرِّف المفتاح الخاص بنوع تطبيق يتم تدويره.

IsAppStaticKey

bool IsAppStaticKey(
  uint32_t keyId
)

حدِّد ما إذا كان معرِّف المفتاح المحدَّد من نوع ثابت في التطبيق.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان المفتاح الرئيسي لنوع ثابت للتطبيق.

IsGeneralKey

bool IsGeneralKey(
  uint32_t keyId
)

حدد ما إذا كان معرّف المفتاح المحدد من النوع العام أم لا.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان معرف المفتاح لديه نوع عام.

IsMessageEncryptionKeyId

bool IsMessageEncryptionKeyId(
  uint32_t keyId,
  bool allowLogicalKeys
)

يمكنك تحديد ما إذا كان معرِّف مفتاح معيّن يحدّد مفتاحًا مناسبًا لتشفير رسائل Weave.

التفاصيل

المَعلمات

`[in] keyId`	معرّف مفتاح Weave
`[in] allowLogicalKeys`	يحدِّد هذا الإعداد ما إذا كان يجب اعتبار أرقام تعريف المفاتيح المنطقية (مثل المفتاح المتناوب "الحالي") مناسبة لتشفير الرسائل.

المرتجعات

true إذا كان من الممكن استخدام المفتاح الذي تم تحديده لتشفير رسائل Weave.

IsSameKeyOrGroup

bool IsSameKeyOrGroup(
  uint32_t keyId1,
  uint32_t keyId2
)

يحدد ما إذا كان معرّفا مفتاحَين يمكنان التعرّف على المفتاح نفسه، أم أنّ مجموعة المفاتيح نفسها في حالة المفاتيح الدوّارة تكون مستقلّة عن أي حقبة معيّنة.

التفاصيل

المَعلمات

`[in] keyId1`	رقم تعريف المفتاح الأول المطلوب اختباره.
`[in] keyId2`	رقم تعريف المفتاح الثاني المطلوب اختباره.

المرتجعات

True إذا كانت معرفات المفاتيح تمثل نفس المفتاح.

IsSessionKey

bool IsSessionKey(
  uint32_t keyId
)

حدد ما إذا كان معرّف المفتاح المحدد من نوع جلسة أم لا.

التفاصيل

المَعلمات

[in] keyId

معرِّف مفتاح Weave

المرتجعات

true إذا كان معرف المفتاح لنوع الجلسة.

IsValidKeyId

bool IsValidKeyId(
  uint32_t keyId
)

حدِّد ما إذا كان معرِّف المفتاح يتضمّن قيمة (قانونية) صالحة.

التفاصيل

المَعلمات

[in] keyId

معرّف مفتاح Weave

المرتجعات

true إذا كانت قيمة معرّف المفتاح صالحة.

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`	رقم تعريف مفتاح Epoch المستخدَم للحصول على المفتاح المتوسط للتطبيق
`[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`	رقم تعريف مفتاح Epoch المستخدَم للحصول على مفتاح مجموعة التطبيقات
`[in] appGroupMasterKeyId`	معرّف المفتاح الرئيسي لمجموعة التطبيقات المُستخدَم للحصول على مفتاح مجموعة التطبيقات
`[in] useCurrentEpochKey`	علامة منطقية تشير إلى ما إذا كان يجب اشتقاق المفتاح باستخدام مفتاح الحقبة "الحالي".

المرتجعات

رقم تعريف مفتاح مجموعة التطبيقات.

MakeAppRotatingKeyId

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

إنشاء رقم تعريف مفتاح متناوب للتطبيق بالاستناد إلى أرقام تعريف المفاتيح الأساسية ومعلومات أخرى

التفاصيل

المَعلمات

`[in] rootKeyId`	رقم تعريف مفتاح الجذر المُستخدَم للحصول على المفتاح المتناوب للتطبيق
`[in] epochKeyId`	يتم استخدام رقم تعريف مفتاح Epoch للحصول على المفتاح المتناوب للتطبيق.
`[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`	رقم تعريف مفتاح Epoch الذي سيتم استخدامه في إنشاء رقم تعريف مفتاح التطبيق المعدَّل.

المرتجعات

رقم تعريف مفتاح التطبيق.

UsesCurrentEpochKey

bool UsesCurrentEpochKey(
  uint32_t keyId
)

حدِّد ما إذا كان رقم تعريف مفتاح مجموعة التطبيقات المحدَّد يستخدم مفتاح الحقبة "الحالي".

التفاصيل

المَعلمات

[in] keyId

نسج معرّف مفتاح مجموعة التطبيقات.

المرتجعات

true إذا كان keyId يشير إلى استخدام مفتاح الحقبة الحالية.