nl:: Weave:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
ההגדרה של מזהה מפתח Weave.
סיכום
הסיווג הזה כולל סוגי מפתחות, דגלי מפתחות, הגדרות של שדות מזהה מפתח ופונקציות API.
סוגים ציבוריים |
|
|---|---|
@52{
|
טיפוסים בני מנייה (enum) שדות, דגלים וסוגים של מפתח 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
קובעים אם מזהה המפתח של קבוצת האפליקציות שצוין כולל מפתח של תקופה (epoch).
|
IncorporatesRootKey(uint32_t keyId)
|
bool
בודקים אם מזהה המפתח של קבוצת האפליקציות שצוין כולל את המפתח הבסיסי (root).
|
IsAppEpochKey(uint32_t keyId)
|
bool
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג מפתח מתקופת זמן של אפליקציה (epoch).
|
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
|
מזהה מפתח הרמה הבסיסית (root) של הלקוח. |
kFabricRootKey
|
מזהה מפתח הרמה הבסיסית של הבד. |
kFabricSecret
|
שזירה של מזהה סודי של בד. |
kKeyNumber_Max
|
הערכים המקסימליים לשדות משנה של מזהה מפתח. |
kNone
|
שזירה של מזהי מפתחות גלובליים. מזהה מפתח Weave לא צוין. |
kServiceRootKey
|
מזהה מפתח הבסיס של השירות. |
kType_AppEpochKey
|
סוג מפתח תקופה של קבוצת אפליקציות (epoch). |
kType_AppGroupMasterKey
|
סוג מפתח המאסטר של קבוצת האפליקציות. |
kType_AppIntermediateKey
|
סוג מפתח הביניים של קבוצת האפליקציות. |
kType_AppRootKey
|
שוו סוגי מפתחות (למעט סוגי הצפנה של הודעות ב-Weave). |
kType_AppRotatingKey
|
סוג מפתח מסתובב של אפליקציה. |
kType_AppStaticKey
|
סוג מפתח סטטי של אפליקציה. |
kType_General
|
סוג מפתח כללי. |
kType_None
|
סוגי מפתחות ארוגים המשמשים להצפנת הודעות ב-Weave. |
kType_Session
|
סוג המפתח לסשן. |
פונקציות סטטיות ציבוריות
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 של מזהה המפתח שצוין.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
הסוג של מזהה המפתח.
|
||
IncorporatesAppGroupMasterKey
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
קובעת אם במזהה המפתח של קבוצת האפליקציות שצוין משולב מפתח המאסטר של הקבוצה.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
True אם ה-keyId כולל מפתח מאסטר של קבוצה.
|
||
IncorporatesEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
קובעים אם מזהה המפתח של קבוצת האפליקציות שצוין כולל מפתח של תקופה (epoch).
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
True אם ה-keyId כולל מפתח של תקופה של זמן מערכת.
|
||
IncorporatesRootKey
bool IncorporatesRootKey( uint32_t keyId )
בודקים אם מזהה המפתח של קבוצת האפליקציות שצוין כולל את המפתח הבסיסי (root).
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
True אם ה-keyId כולל את מפתח השורש.
|
||
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג מפתח מתקופת זמן של אפליקציה (epoch).
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם ה-keyId של סוג מפתח תקופת זמן של אפליקציה הוא True.
|
||
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין שייך לאחד מסוגי המפתחות של קבוצות האפליקציות (סטטי או מסתובב).
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
True אם מזהה המפתח הוא מסוג מפתח מסתובב או סטטי.
|
||
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג מפתח מאסטר של קבוצת אפליקציות.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם ה-keyId של סוג מפתח מאסטר של קבוצת אפליקציות הוא True.
|
||
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג מפתח ברמה הבסיסית של האפליקציה.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם ה-keyId של סוג מפתח הרמה הבסיסי של האפליקציה הוא True.
|
||
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג של אפליקציה מסתובבת.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם מזהה המפתח של סוג משתנה של אפליקציה.
|
||
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג סטטי של אפליקציה.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם keyId של סוג סטטי של אפליקציה.
|
||
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג כללי.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם ל-keyId יש סוג כללי.
|
||
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
לקבוע אם מזהה מפתח נתון מזהה מפתח שמתאים להצפנת הודעות של Weave.
| פרטים | |||||
|---|---|---|---|---|---|
| פרמטרים |
|
||||
| החזרות |
true אם אפשר להשתמש במפתח שזוהה כדי להצפין הודעות של Weave.
|
||||
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
ההגדרה קובעת אם שני מזהי מפתחות מזהים את אותו מפתח, או במקרה של החלפה של מפתחות, אותה קבוצת מפתחות ללא תלות בתקופה מסוימת.
| פרטים | |||||
|---|---|---|---|---|---|
| פרמטרים |
|
||||
| החזרות |
הערך הוא True אם מזהי המפתחות מייצגים את אותו מפתח.
|
||||
IsSessionKey
bool IsSessionKey( uint32_t keyId )
צריך לקבוע אם מזהה המפתח שצוין הוא מסוג סשן.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
True אם מזהה המפתח של סוג סשן מסוים.
|
||
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
קובעים אם למזהה המפתח יש ערך תקין (חוקי).
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם ערך מזהה המפתח תקין.
|
||
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 )
קביעה אם מזהה המפתח של קבוצת האפליקציות שצוין משתמש בערך 'נוכחי' תקופה של זמן מערכת.
| פרטים | |||
|---|---|---|---|
| פרמטרים |
|
||
| החזרות |
true אם ה-keyId מציין שימוש במפתח של תקופת הזמן הנוכחית.
|
||