nl:: Weave:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
تمثّل هذه الخاصية تعريف معرّف مفتاح Weave.
الملخّص
تتضمن هذه الفئة أنواع المفاتيح والعلامات الرئيسية وتعريف حقول معرّف المفتاح ودوال واجهة برمجة التطبيقات.
الأنواع المتاحة للجميع |
|
---|---|
@52{
|
تعداد حقول معرّفات مفتاح 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
حدِّد ما إذا كان معرّف مفتاح مجموعة التطبيق المحدّد يستخدم "؛current" مفتاح الحقبة.
|
الأنواع المتاحة للجميع
@52
@52
حقول معرّفات مفتاح Weave العامة والعلامات والأنواع.
أماكن إقامة | |
---|---|
kClientRootKey
|
رقم تعريف مفتاح جذر العميل. |
kFabricRootKey
|
معرّف مفتاح جذر الأقمشة |
kFabricSecret
|
معرّف نسيج حياكة. |
kKeyNumber_Max
|
الحد الأقصى من القيم للحقول الفرعية لرقم التعريف الأساسي |
kNone
|
يتم إدراج معرّفات المفاتيح العامة. معرّف مفتاح Weave غير محدد. |
kServiceRootKey
|
رقم تعريف المفتاح الجذر للخدمة. |
kType_AppEpochKey
|
نوع مفتاح حقبة مجموعة التطبيقات |
kType_AppGroupMasterKey
|
نوع المفتاح الرئيسي لمجموعة التطبيقات. |
kType_AppIntermediateKey
|
نوع المفتاح المتوسط لمجموعة التطبيقات. |
kType_AppRootKey
|
أنواع مفاتيح Weave (بخلاف أنواع تشفير رسائل Weave). |
kType_AppRotatingKey
|
نوع مفتاح تدوير التطبيقات. |
kType_AppStaticKey
|
نوع المفتاح الثابت للتطبيق. |
kType_General
|
نوع المفتاح العام. |
kType_None
|
أنواع مفاتيح Weave المستخدمة لتشفير رسائل Weave. |
kType_Session
|
نوع مفتاح الجلسة. |
الدوال الثابتة العامة
تحويل إلى رقم تعريف التطبيق الحالي
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
تحويل رقم تعريف مفتاح مجموعة التطبيقات إلى رقم تعريف المفتاح الحالي للتطبيق.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
رقم تعريف المفتاح الحالي للتطبيق.
|
ConvertToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
حوِّل رقم تعريف مفتاح التطبيق إلى رقم تعريف مفتاح التطبيق الثابت.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
رقم تعريف المفتاح الثابت للتطبيق.
|
وصف المفتاح
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 لرقم تعريف المفتاح المحدّد.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
معرّف المفتاح.
|
IncorporatesAppGroupMasterKey
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
حدِّد ما إذا كان معرّف مفتاح مجموعة التطبيقات المحدّد يتضمّن المفتاح الرئيسي للمجموعة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId يتضمن مفتاح المجموعة الرئيسي.
|
قناة IncorporatesEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
حدِّد ما إذا كان معرّف مفتاح مجموعة التطبيقات المحدّد يتضمّن مفتاح الحقبة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId يتضمن مفتاح الحقبة.
|
مفتاح IncorporatesRoot
bool IncorporatesRootKey( uint32_t keyId )
حدِّد ما إذا كان معرِّف مفتاح مجموعة التطبيقات المحدّد يتضمن مفتاح الجذر.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId يتضمن مفتاح الجذر.
|
مفتاح AppAppEpoch
bool IsAppEpochKey( uint32_t keyId )
حدِّد ما إذا كان رقم تعريف المفتاح المحدّد هو من نوع المفتاح لفترة التطبيق.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
true إذا كان keyId لنوع مفتاح حقبة التطبيق.
|
مفتاح AppAppGroup
bool IsAppGroupKey( uint32_t keyId )
حدِّد ما إذا كان رقم تعريف المفتاح المحدّد ينتمي إلى أحد أنواع مفاتيح مجموعة التطبيقات (ثابتة أو بالتناوب).
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId يتم تدويره أو نوع المفتاح الثابت.
|
مفتاح AppAppGroupMaster
bool IsAppGroupMasterKey( uint32_t keyId )
حدِّد ما إذا كان رقم تعريف المفتاح المحدّد هو نوع المفتاح الرئيسي لمجموعة التطبيقات.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
true إذا كان keyId لنوع المفتاح الرئيسي لمجموعة التطبيقات.
|
مفتاح AppAppRoot
bool IsAppRootKey( uint32_t keyId )
حدِّد ما إذا كان رقم تعريف المفتاح المحدّد هو من نوع المفتاح الجذر للتطبيق.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId لنوع مفتاح جذر التطبيق.
|
مفتاح AppAppRotating
bool IsAppRotatingKey( uint32_t keyId )
حدِّد ما إذا كان معرّف المفتاح المحدّد من نوع تدوير التطبيقات.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId لنوع تدوير التطبيق.
|
مفتاح AppAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
حدِّد ما إذا كان رقم تعريف المفتاح المحدّد نوعًا ثابتًا للتطبيق.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId من نوع ثابت للتطبيق.
|
مفتاح عام
bool IsGeneralKey( uint32_t keyId )
تحديد ما إذا كان رقم تعريف المفتاح المحدد من نوع عام.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId يتضمن النوع "عام".
|
الرقم التعريفي لـ isMessageEncryptionKey
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
حدِّد ما إذا كان معرّف المفتاح قد تعرّف على مفتاح مناسب لتشفير رسائل Weave.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
المرتجعات |
true إذا كان من الممكن استخدام المفتاح الذي تم تحديده لتشفير رسائل Weave.
|
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
تُحدِّد هذه السياسة ما إذا كان معرّفا المفتاح قد تعرّفا على المفتاح نفسه، أو في حال تغيير المفاتيح، تكون مجموعة المفاتيح نفسها مستقلة عن أي حقبة معيّنة.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
المرتجعات |
صحيح إذا كانت أرقام تعريف المفاتيح تمثل المفتاح نفسه.
|
مفتاح الجلسة
bool IsSessionKey( uint32_t keyId )
حدِّد ما إذا كان رقم تعريف المفتاح المحدّد من نوع الجلسة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId لنوع الجلسة.
|
معرف صالح
bool IsValidKeyId( uint32_t keyId )
حدِّد ما إذا كان معرِّف المفتاح يتضمّن قيمة صالحة (قانونية).
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كانت قيمة رقم تعريف المفتاح صالحة.
|
MakeAppGroupMasterKeyId
uint32_t 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 )
إنشاء رقم تعريف مفتاح مجموعة التطبيقات بالاستناد إلى أرقام التعريف الأساسية للمكوّنات والمعلومات الأخرى
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
المرتجعات |
رقم تعريف مفتاح مجموعة التطبيقات.
|
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 )
إنشاء رقم تعريف مفتاح جذر مجموعة التطبيقات وفقًا لرقم مفتاح الحقبة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
معرّف مفتاح الحقبة
|
معرّف المفتاح العام
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
إنشاء رقم تعريف مفتاح عام بالاستناد إلى رقم المفتاح العام
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
معرّف المفتاح العام.
|
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
إنشاء رقم تعريف مفتاح جذر مجموعة التطبيقات وفقًا لرقم المفتاح الجذري
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
رقم تعريف المفتاح الجذر.
|
MakeSessionKeyId
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
يمكنك إنشاء رقم تعريف مفتاح الجلسة حسب رقم مفتاح الجلسة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
رقم تعريف مفتاح الجلسة.
|
الرقم التعريفي لـ EpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
تعديل معرّف مفتاح مجموعة التطبيقات برقم مفتاح جديد
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
المرتجعات |
رقم تعريف مفتاح التطبيق.
|
استخدامsCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
حدِّد ما إذا كان معرّف مفتاح مجموعة التطبيق المحدّد يستخدم "؛current" مفتاح الحقبة.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
صحيح إذا كان keyId يشير إلى استخدام مفتاح الحقبة الحالية.
|