nl:: Weave:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
Die Definition der Weave-Schlüsselkennung.
Zusammenfassung
Diese Klasse enthält Schlüsseltypen, Schlüssel-Flags, die Definition von Schlüssel-ID-Feldern und API-Funktionen.
Öffentliche Typen |
|
---|---|
@52{
|
enum Felder, Flags und Typen von Public Weave-Schlüssel-IDs. |
Öffentliche statische Funktionen |
|
---|---|
ConvertToCurrentAppKeyId(uint32_t keyId)
|
uint32_t
Konvertieren Sie die Anwendungsgruppenschlüssel-ID in die aktuelle Schlüssel-ID der Anwendung.
|
ConvertToStaticAppKeyId(uint32_t keyId)
|
uint32_t
Anwendungsschlüssel-ID in statische Anwendungsschlüssel-ID konvertieren
|
DescribeKey(uint32_t keyId)
|
const char *
Decodieren Sie eine Weave-Schlüsselkennung mit einem beschreibenden String.
|
GetAppGroupLocalNumber(uint32_t keyId)
|
uint8_t
Lokale Nummer der Anwendungsgruppe abrufen, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
|
GetAppGroupMasterKeyId(uint32_t keyId)
|
uint32_t
Ruft die Masterschlüssel-ID der Anwendungsgruppe ab, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
|
GetEpochKeyId(uint32_t keyId)
|
uint32_t
Epochenschlüssel-ID der Anwendungsgruppe abrufen, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
|
GetEpochKeyNumber(uint32_t keyId)
|
uint8_t
Ruft die Epochenschlüsselnummer der Anwendungsgruppe ab, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
|
GetRootKeyId(uint32_t keyId)
|
uint32_t
Stammschlüssel-ID der Anwendungsgruppe abrufen, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
|
GetRootKeyNumber(uint32_t keyId)
|
uint8_t
Ruft die Stammschlüsselnummer der Anwendungsgruppe ab, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
|
GetType(uint32_t keyId)
|
uint32_t
Weave-Schlüsseltyp der angegebenen Schlüssel-ID abrufen.
|
IncorporatesAppGroupMasterKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID der Anwendungsgruppe einen Gruppenmasterschlüssel enthält.
|
IncorporatesEpochKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID der Anwendungsgruppe einen Epochenschlüssel enthält.
|
IncorporatesRootKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID der Anwendungsgruppe den Stammschlüssel enthält.
|
IsAppEpochKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Schlüsseltyp der Epoche der Anwendung gehört.
|
IsAppGroupKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem der Schlüsseltypen der Anwendungsgruppe (statisch oder rotierend) gehört.
|
IsAppGroupMasterKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Hauptschlüsseltyp der Anwendungsgruppe gehört.
|
IsAppRootKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Anwendungsstammschlüsseltyp gehört.
|
IsAppRotatingKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einer rotierenden Anwendung gehört.
|
IsAppStaticKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem statischen Anwendungstyp gehört.
|
IsGeneralKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID einen allgemeinen Typ hat.
|
IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)
|
bool
Bestimmen Sie, ob eine bestimmte Schlüssel-ID einen Schlüssel identifiziert, der für die Weave-Nachrichtenverschlüsselung geeignet ist.
|
IsSameKeyOrGroup(uint32_t keyId1, uint32_t keyId2)
|
bool
Bestimmt, ob zwei Schlüssel-IDs denselben Schlüssel oder im Fall von rotierenden Schlüsseln dieselbe Gruppe von Schlüsseln identifizieren, unabhängig von einer bestimmten Epoche.
|
IsSessionKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Sitzungstyp gehört.
|
IsValidKeyId(uint32_t keyId)
|
bool
Ermitteln Sie, ob die Schlüsselkennung einen gültigen (zulässigen) Wert hat.
|
MakeAppGroupMasterKeyId(uint8_t appGroupLocalNumber)
|
uint32_t
Erstellt die Masterschlüssel-ID der Anwendungsgruppe anhand der lokalen Nummer der Anwendungsgruppe.
|
MakeAppIntermediateKeyId(uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)
|
uint32_t
Erstellt die Zwischenschlüssel-ID der Anwendung anhand der zugehörigen Schlüssel-IDs.
|
MakeAppKeyId(uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Erstellen Sie die Anwendungsgruppenschlüssel-ID anhand der einzelnen Schlüssel-IDs und anderer Informationen.
|
MakeAppRotatingKeyId(uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Erstellen Sie anhand der einzelnen Schlüssel-IDs und anderer Informationen eine rotierende Schlüssel-ID für die Anwendung.
|
MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)
|
uint32_t
Erstellt einen statischen Anwendungsschlüssel anhand der einzelnen Schlüssel-IDs.
|
MakeEpochKeyId(uint8_t epochKeyNumber)
|
uint32_t
Erstellt die Stammschlüssel-ID der Anwendungsgruppe anhand der Epochenschlüsselnummer.
|
MakeGeneralKeyId(uint16_t generalKeyNumber)
|
uint16_t
Erstellt eine allgemeine Schlüssel-ID anhand der allgemeinen Schlüsselnummer.
|
MakeRootKeyId(uint8_t rootKeyNumber)
|
uint32_t
Konstruiert die Stammschlüssel-ID der Anwendungsgruppe anhand der Stammschlüsselnummer.
|
MakeSessionKeyId(uint16_t sessionKeyNumber)
|
uint16_t
Erstellt eine Sitzungsschlüssel-ID anhand der Sitzungsschlüsselnummer.
|
UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)
|
uint32_t
Aktualisieren Sie die Schlüssel-ID der Anwendungsgruppe mit der neuen Epochenschlüsselnummer.
|
UsesCurrentEpochKey(uint32_t keyId)
|
bool
Ermitteln Sie, ob für die angegebene Schlüssel-ID der Anwendungsgruppe der "aktuelle" Epochenschlüssel verwendet wird.
|
Öffentliche Typen
@52
@52
Felder, Flags und Typen von Public Weave-Schlüssel-IDs.
Attribute | |
---|---|
kClientRootKey
|
Stammschlüssel-ID des Clients. |
kFabricRootKey
|
ID des Fabric-Root-Schlüssels. |
kFabricSecret
|
Geheime ID für Weave-Stoffe. |
kKeyNumber_Max
|
Höchstwerte für untergeordnete Schlüssel-ID-Felder. |
kNone
|
Globale Schlüssel-IDs weben Nicht angegebene Weave-Schlüssel-ID. |
kServiceRootKey
|
ID des Stammschlüssels des Dienstes. |
kType_AppEpochKey
|
Epochenschlüsseltyp der Anwendungsgruppe. |
kType_AppGroupMasterKey
|
Masterschlüsseltyp der Anwendungsgruppe. |
kType_AppIntermediateKey
|
Zwischenschlüsseltyp der Anwendungsgruppe. |
kType_AppRootKey
|
Weave-Schlüsseltypen (außer Weave-Nachrichtenverschlüsselungstypen). |
kType_AppRotatingKey
|
Rotierender Schlüsseltyp der Anwendung. |
kType_AppStaticKey
|
Statischer Anwendungsschlüsseltyp. |
kType_General
|
Allgemeiner Schlüsseltyp. |
kType_None
|
Für die Weave-Nachrichtenverschlüsselung verwendete Weave-Schlüsseltypen. |
kType_Session
|
Sitzungsschlüsseltyp. |
Öffentliche statische Funktionen
ConvertToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
Konvertieren Sie die Anwendungsgruppenschlüssel-ID in die aktuelle Schlüssel-ID der Anwendung.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
aktuelle Schlüssel-ID der Anwendung.
|
ConvertToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
Anwendungsschlüssel-ID in statische Anwendungsschlüssel-ID konvertieren
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
ID des statischen Anwendungsschlüssels.
|
DescribeKey
const char * DescribeKey( uint32_t keyId )
Decodieren Sie eine Weave-Schlüsselkennung mit einem beschreibenden String.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf einen NULL-terminierten String, der die angegebene Schlüssel-ID beschreibt.
|
GetAppGroupLocalNumber
uint8_t GetAppGroupLocalNumber( uint32_t keyId )
Lokale Nummer der Anwendungsgruppe abrufen, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Lokale Nummer der Anwendungsgruppe.
|
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
Ruft die Masterschlüssel-ID der Anwendungsgruppe ab, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Masterschlüssel-ID der Anwendungsgruppe.
|
GetEpochKeyId
uint32_t GetEpochKeyId( uint32_t keyId )
Epochenschlüssel-ID der Anwendungsgruppe abrufen, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Epochenschlüssel-ID.
|
GetEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
Ruft die Epochenschlüsselnummer der Anwendungsgruppe ab, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Epochenschlüsselnummer.
|
GetRootKeyId
uint32_t GetRootKeyId( uint32_t keyId )
Stammschlüssel-ID der Anwendungsgruppe abrufen, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Stammschlüssel-ID.
|
GetRootKeyNumber
uint8_t GetRootKeyNumber( uint32_t keyId )
Ruft die Stammschlüsselnummer der Anwendungsgruppe ab, die zum Ableiten des angegebenen Anwendungsschlüssels verwendet wurde.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Stammschlüsselnummer.
|
GetType
uint32_t GetType( uint32_t keyId )
Weave-Schlüsseltyp der angegebenen Schlüssel-ID abrufen.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Typ der Schlüssel-ID.
|
IncorporatesAppGroupMasterKey
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID der Anwendungsgruppe einen Gruppenmasterschlüssel enthält.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
TRUE, wenn die keyId den Hauptschlüssel der Gruppe enthält.
|
IncorporatesEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID der Anwendungsgruppe einen Epochenschlüssel enthält.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
TRUE, wenn die keyId einen Epochenschlüssel enthält.
|
IncorporatesRootKey
bool IncorporatesRootKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID der Anwendungsgruppe den Stammschlüssel enthält.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
TRUE, wenn die keyId den Stammschlüssel enthält.
|
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Schlüsseltyp der Epoche der Anwendung gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
"true", wenn die "keyId" eines Schlüsseltyps für die Epoche einer Anwendungsphase ist.
|
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem der Schlüsseltypen der Anwendungsgruppe (statisch oder rotierend) gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
true, wenn die keyId einen rotierenden oder statischen Schlüssel hat.
|
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Hauptschlüsseltyp der Anwendungsgruppe gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
"true", wenn die keyId des Masterschlüsseltyps einer Anwendungsgruppe ist.
|
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Anwendungsstammschlüsseltyp gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
"true", wenn die "keyId" des Stammschlüsseltyps der Anwendung
|
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einer rotierenden Anwendung gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
"true", wenn die "keyId" eines rotierenden Anwendungstyps ist.
|
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem statischen Anwendungstyp gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
"true", wenn die "keyId" eines statischen Anwendungstyps lautet.
|
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID einen allgemeinen Typ hat.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
true, wenn die keyId den Typ "General" hat.
|
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
Bestimmen Sie, ob eine bestimmte Schlüssel-ID einen Schlüssel identifiziert, der für die Weave-Nachrichtenverschlüsselung geeignet ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
true, wenn der identifizierte Schlüssel zum Verschlüsseln von Weave-Nachrichten verwendet werden kann.
|
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
Bestimmt, ob zwei Schlüssel-IDs denselben Schlüssel oder im Fall von rotierenden Schlüsseln dieselbe Gruppe von Schlüsseln identifizieren, unabhängig von einer bestimmten Epoche.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
„True“, wenn die Schlüssel-IDs denselben Schlüssel darstellen.
|
IsSessionKey
bool IsSessionKey( uint32_t keyId )
Ermitteln Sie, ob die angegebene Schlüssel-ID zu einem Sitzungstyp gehört.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
true, wenn die keyId eines Sitzungstyps ist.
|
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
Ermitteln Sie, ob die Schlüsselkennung einen gültigen (zulässigen) Wert hat.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
true, wenn der Schlüssel-ID-Wert gültig ist.
|
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
Erstellt die Masterschlüssel-ID der Anwendungsgruppe anhand der lokalen Nummer der Anwendungsgruppe.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Masterschlüssel-ID der Anwendungsgruppe.
|
MakeAppIntermediateKeyId
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
Erstellt die Zwischenschlüssel-ID der Anwendung anhand der zugehörigen Schlüssel-IDs.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabe |
Zwischenschlüssel-ID der Anwendung.
|
MakeAppKeyId
uint32_t MakeAppKeyId( uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Erstellen Sie die Anwendungsgruppenschlüssel-ID anhand der einzelnen Schlüssel-IDs und anderer Informationen.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Rückgabe |
Schlüssel-ID der Anwendungsgruppe.
|
MakeAppRotatingKeyId
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Erstellen Sie anhand der einzelnen Schlüssel-IDs und anderer Informationen eine rotierende Schlüssel-ID für die Anwendung.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabe |
ID des rotierenden Anwendungsschlüssels.
|
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
Erstellt einen statischen Anwendungsschlüssel anhand der einzelnen Schlüssel-IDs.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
ID des statischen Anwendungsschlüssels.
|
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
Erstellt die Stammschlüssel-ID der Anwendungsgruppe anhand der Epochenschlüsselnummer.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Epochenschlüssel-ID.
|
MakeGeneralKeyId
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
Erstellt eine allgemeine Schlüssel-ID anhand der allgemeinen Schlüsselnummer.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
allgemeine Schlüssel-ID.
|
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
Konstruiert die Stammschlüssel-ID der Anwendungsgruppe anhand der Stammschlüsselnummer.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Stammschlüssel-ID.
|
MakeSessionKeyId
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
Erstellt eine Sitzungsschlüssel-ID anhand der Sitzungsschlüsselnummer.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Sitzungsschlüssel-ID.
|
UpdateEpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
Aktualisieren Sie die Schlüssel-ID der Anwendungsgruppe mit der neuen Epochenschlüsselnummer.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Anwendungsschlüssel-ID.
|
UsesCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
Ermitteln Sie, ob für die angegebene Schlüssel-ID der Anwendungsgruppe der "aktuelle" Epochenschlüssel verwendet wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
TRUE, wenn die keyId auf die Verwendung des aktuellen Epochenschlüssels hinweist.
|