nl:: Weave:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
Weave Key tanımlayıcısının tanımı.
Özet
Bu sınıf; anahtar türleri, anahtar işaretleri, anahtar kimliği alanlarının tanımı ve API işlevlerini içerir.
Herkese açık türler |
|
---|---|
@52{
|
enum Ortak Örgü anahtarı kimlik alanları, işaretler ve türleri. |
Herkese açık statik işlevler |
|
---|---|
ConvertToCurrentAppKeyId(uint32_t keyId)
|
uint32_t
Uygulama grubu anahtarı kimliğini uygulamanın geçerli anahtar kimliğine dönüştürün.
|
ConvertToStaticAppKeyId(uint32_t keyId)
|
uint32_t
Uygulama anahtarı kimliğini uygulama statik anahtar kimliğine dönüştürün.
|
DescribeKey(uint32_t keyId)
|
const char *
Açıklayıcı bir dizeyle Weave anahtar tanımlayıcısının kodunu çözün.
|
GetAppGroupLocalNumber(uint32_t keyId)
|
uint8_t
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu yerel numarasını alın.
|
GetAppGroupMasterKeyId(uint32_t keyId)
|
uint32_t
Belirtilen uygulama anahtarını türetmek için kullanılan uygulama grubu ana anahtar kimliğini alın.
|
GetEpochKeyId(uint32_t keyId)
|
uint32_t
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu sıfır zaman anahtarı kimliğini alın.
|
GetEpochKeyNumber(uint32_t keyId)
|
uint8_t
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu sıfır zaman anahtarı numarasını alın.
|
GetRootKeyId(uint32_t keyId)
|
uint32_t
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu kök anahtarı kimliğini alın.
|
GetRootKeyNumber(uint32_t keyId)
|
uint8_t
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu kök anahtarı numarasını alın.
|
GetType(uint32_t keyId)
|
uint32_t
Belirtilen anahtar kimliğinin Weave anahtar türünü alın.
|
IncorporatesAppGroupMasterKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin grup ana anahtarını içerip içermediğini belirleyin.
|
IncorporatesEpochKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin sıfır anahtar içerip içermediğini belirleyin.
|
IncorporatesRootKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin kök anahtarı içerip içermediğini belirleyin.
|
IsAppEpochKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin uygulama sıfır dönem anahtar türüne ait olup olmadığını belirleyin.
|
IsAppGroupKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin, uygulama grubu anahtarı türlerinden birine (statik veya dönen) ait olup olmadığını belirleyin.
|
IsAppGroupMasterKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir uygulama grubu ana anahtar türüne ait olup olmadığını belirleyin.
|
IsAppRootKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir uygulama kök anahtarı türüne ait olup olmadığını belirleyin.
|
IsAppRotatingKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin uygulama rotasyonlu bir türde olup olmadığını belirleyin.
|
IsAppStaticKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin uygulamanın statik türünde olup olmadığını belirleyin.
|
IsGeneralKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin genel türde olup olmadığını belirleyin.
|
IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)
|
bool
Belirli bir anahtar kimliğinin Weave ileti şifrelemesine uygun bir anahtar tanımlayıp tanımlamadığını belirleyin.
|
IsSameKeyOrGroup(uint32_t keyId1, uint32_t keyId2)
|
bool
İki anahtar kimliğinin aynı anahtarı mı yoksa rotasyon anahtarlar durumunda mı belirli bir dönemden bağımsız olarak aynı anahtar grubunu tanımlayıp tanımlamadığını belirler.
|
IsSessionKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir oturum türünde olup olmadığını belirleyin.
|
IsValidKeyId(uint32_t keyId)
|
bool
Anahtar tanımlayıcısının geçerli (yasal) bir değere sahip olup olmadığını belirleyin.
|
MakeAppGroupMasterKeyId(uint8_t appGroupLocalNumber)
|
uint32_t
Uygulama grubu yerel numarasıyla uygulama grubu ana anahtar kimliğini oluşturun.
|
MakeAppIntermediateKeyId(uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)
|
uint32_t
Bileşen anahtar kimliklerine sahip uygulama ara anahtar kimliğini oluşturun.
|
MakeAppKeyId(uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Bileşen anahtar kimlikleri ve diğer bilgilerle uygulama grubu anahtarı kimliğini oluşturun.
|
MakeAppRotatingKeyId(uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Bileşen anahtar kimlikleri ve diğer bilgilerle uygulama rotasyon anahtarı kimliğini oluşturun.
|
MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)
|
uint32_t
Bileşen anahtar kimliklerine sahip uygulama statik anahtar kimliğini oluşturun.
|
MakeEpochKeyId(uint8_t epochKeyNumber)
|
uint32_t
Dönem anahtar numarasıyla belirtilen uygulama grubu kök anahtarı kimliğini oluşturun.
|
MakeGeneralKeyId(uint16_t generalKeyNumber)
|
uint16_t
Genel anahtar numarasıyla genel anahtar kimliği oluşturun.
|
MakeRootKeyId(uint8_t rootKeyNumber)
|
uint32_t
Kök anahtar numarası verilen uygulama grubu kök anahtar kimliğini oluşturun.
|
MakeSessionKeyId(uint16_t sessionKeyNumber)
|
uint16_t
Oturum anahtarı numarasına göre oturum anahtarı kimliğini oluşturun.
|
UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)
|
uint32_t
Uygulama grubu anahtarı kimliğini yeni sıfır dönem anahtarı numarasıyla güncelleyin.
|
UsesCurrentEpochKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin "geçerli" sıfır anahtarı kullanıp kullanmadığını belirleyin.
|
Herkese açık türler
@52
@52
Ortak Örgü anahtarı kimlik alanları, işaretler ve türleri.
Özellikler | |
---|---|
kClientRootKey
|
İstemci kök anahtar kimliği. |
kFabricRootKey
|
Fabric kök anahtar kimliği. |
kFabricSecret
|
Dokuma gizli kimliği. |
kKeyNumber_Max
|
Anahtar kimliği alt alanları için maksimum değerler. |
kNone
|
Genel anahtar kimliklerini doku. Belirtilmemiş Weave anahtarı kimliği. |
kServiceRootKey
|
Hizmet kök anahtar kimliği. |
kType_AppEpochKey
|
Uygulama grubu sıfır anahtar türü. |
kType_AppGroupMasterKey
|
Uygulama grubu ana anahtarı türü. |
kType_AppIntermediateKey
|
Uygulama grubu ara anahtar türü. |
kType_AppRootKey
|
Weave anahtar türleri (Weave ileti şifreleme türleri hariç). |
kType_AppRotatingKey
|
Uygulama dönen anahtar türü. |
kType_AppStaticKey
|
Uygulama statik anahtarı türü. |
kType_General
|
Genel anahtar türü. |
kType_None
|
Weave ileti şifrelemesi için kullanılan Weave anahtar türleri. |
kType_Session
|
Oturum anahtarı türü. |
Herkese açık statik işlevler
ConvertToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
Uygulama grubu anahtarı kimliğini uygulamanın geçerli anahtar kimliğine dönüştürün.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulamanın geçerli anahtar kimliği.
|
ConvertToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
Uygulama anahtarı kimliğini uygulama statik anahtar kimliğine dönüştürün.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Uygulama statik anahtar kimliği.
|
DescribeKey
const char * DescribeKey( uint32_t keyId )
Açıklayıcı bir dizeyle Weave anahtar tanımlayıcısının kodunu çözün.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Belirtilen anahtar kimliğini açıklayan NULL sona ermiş bir dizeye yönelik işaretçi.
|
GetAppGroupLocalNumber
uint8_t GetAppGroupLocalNumber( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu yerel numarasını alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulama grubu yerel numarası.
|
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
Belirtilen uygulama anahtarını türetmek için kullanılan uygulama grubu ana anahtar kimliğini alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulama grubu ana anahtar kimliği.
|
GetEpochKeyId
uint32_t GetEpochKeyId( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu sıfır zaman anahtarı kimliğini alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
sıfır anahtar kimliği.
|
GetEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu sıfır zaman anahtarı numarasını alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
sıfır anahtar numarası.
|
GetRootKeyId
uint32_t GetRootKeyId( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu kök anahtarı kimliğini alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
kök anahtar kimliği.
|
GetRootKeyNumber
uint8_t GetRootKeyNumber( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu kök anahtarı numarasını alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
kök anahtar numarası.
|
GetType
uint32_t GetType( uint32_t keyId )
Belirtilen anahtar kimliğinin Weave anahtar türünü alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
anahtar kimliğinin türü.
|
IncorporatesAppGroupMasterKey
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin grup ana anahtarını içerip içermediğini belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId grup ana anahtarını içeriyorsa true değerini alır.
|
IncorporatesEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin sıfır anahtar içerip içermediğini belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId sıfır anahtar içeriyorsa true (doğru) değerine sahiptir.
|
IncorporatesRootKey
bool IncorporatesRootKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin kök anahtarı içerip içermediğini belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId kök anahtarı içeriyorsa true (doğru) değerine sahiptir.
|
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
Belirtilen anahtar kimliğinin uygulama sıfır dönem anahtar türüne ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Bir uygulama sıfır dönem anahtar türünün keyId'si ise true değerini alır.
|
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
Belirtilen anahtar kimliğinin, uygulama grubu anahtarı türlerinden birine (statik veya dönen) ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId dönen veya statik anahtar türündeyse true değerini alır.
|
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama grubu ana anahtar türüne ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Bir uygulama grubu ana anahtar türünün keyId'si ise true değerini alır.
|
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama kök anahtarı türüne ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir uygulama kök anahtar türünün keyId'si ise true olarak ayarlanır.
|
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
Belirtilen anahtar kimliğinin uygulama rotasyonlu bir türde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Bir uygulama rotasyon türünün keyId'si ise true olarak ayarlanır.
|
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
Belirtilen anahtar kimliğinin uygulamanın statik türünde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Bir uygulamanın statik türünün keyId'si ise true olarak ayarlanır.
|
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
Belirtilen anahtar kimliğinin genel türde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId genel türdeyse true (doğru) değerine sahiptir.
|
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
Belirli bir anahtar kimliğinin Weave ileti şifrelemesine uygun bir anahtar tanımlayıp tanımlamadığını belirleyin.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
true: Tanımlanan anahtar, Weave mesajlarını şifrelemek için kullanılabiliyorsa.
|
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
İki anahtar kimliğinin aynı anahtarı mı yoksa rotasyon anahtarlar durumunda mı belirli bir dönemden bağımsız olarak aynı anahtar grubunu tanımlayıp tanımlamadığını belirler.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
Anahtar kimlikleri aynı anahtarı temsil ediyorsa doğru değerini alır.
|
IsSessionKey
bool IsSessionKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir oturum türünde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir oturum türünün keyId'si ise true olarak ayarlanır.
|
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
Anahtar tanımlayıcısının geçerli (yasal) bir değere sahip olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Anahtar kimliği değeri geçerliyse true değerini alır.
|
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
Uygulama grubu yerel numarasıyla uygulama grubu ana anahtar kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulama grubu ana anahtar kimliği.
|
MakeAppIntermediateKeyId
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
Bileşen anahtar kimliklerine sahip uygulama ara anahtar kimliğini oluşturun.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
İadeler |
uygulama ara anahtar kimliği.
|
MakeAppKeyId
uint32_t MakeAppKeyId( uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Bileşen anahtar kimlikleri ve diğer bilgilerle uygulama grubu anahtarı kimliğini oluşturun.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||
İadeler |
uygulama grubu anahtarı kimliği.
|
MakeAppRotatingKeyId
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Bileşen anahtar kimlikleri ve diğer bilgilerle uygulama rotasyon anahtarı kimliğini oluşturun.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
İadeler |
uygulama rotasyon anahtarı kimliği.
|
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
Bileşen anahtar kimliklerine sahip uygulama statik anahtar kimliğini oluşturun.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
Uygulama statik anahtar kimliği.
|
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
Dönem anahtar numarasıyla belirtilen uygulama grubu kök anahtarı kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
sıfır anahtar kimliği.
|
MakeGeneralKeyId
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
Genel anahtar numarasıyla genel anahtar kimliği oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
genel anahtar kimliğidir.
|
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
Kök anahtar numarası verilen uygulama grubu kök anahtar kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
kök anahtar kimliği.
|
MakeSessionKeyId
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
Oturum anahtarı numarasına göre oturum anahtarı kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
oturum anahtarı kimliği.
|
UpdateEpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
Uygulama grubu anahtarı kimliğini yeni sıfır dönem anahtarı numarasıyla güncelleyin.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
uygulama anahtarı kimliği.
|
UsesCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin "geçerli" sıfır anahtarı kullanıp kullanmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId geçerli sıfır zaman anahtarının kullanımını gösteriyorsa true değerini alır.
|