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