nl:: Weave:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
Örgü Anahtar tanımlayıcısının tanımı.
Özet
Bu sınıfta anahtar türleri, anahtar işaretleri, anahtar kimlik alanları tanımı ve API işlevleri bulunur.
Herkese açık türler |
|
---|---|
@52{
|
enum Ortak Örgü anahtar kimlik alanları, işaretleri ve türleri. |
Herkese açık statik işlevler |
|
---|---|
ConvertToCurrentAppKeyId(uint32_t keyId)
|
uint32_t
Uygulama grup anahtarı kimliğini uygulama 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ı elde etmek 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 dönem anahtarı kimliğini alın.
|
GetEpochKeyNumber(uint32_t keyId)
|
uint8_t
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu dönem anahtarı numarasını alın.
|
GetRootKeyId(uint32_t keyId)
|
uint32_t
Belirtilen uygulama anahtarını türetmek için kullanılan uygulama grubu kök anahtarı kimliğini alın.
|
GetRootKeyNumber(uint32_t keyId)
|
uint8_t
Belirtilen uygulama anahtarını türetmek 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 belirler.
|
IncorporatesEpochKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin, dönem anahtarını içerip içermediğini belirler.
|
IncorporatesRootKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin kök anahtar içerip içermediğini belirler.
|
IsAppEpochKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir uygulama dönem anahtarı türünde olup olmadığını belirler.
|
IsAppGroupKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin, uygulama grubu anahtar türlerinden birine (statik veya dönüşümlü) ait olup olmadığını belirleyin.
|
IsAppGroupMasterKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir uygulama grubu ana anahtar türünde olup olmadığını belirler.
|
IsAppRootKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir uygulama kök anahtarı türünde olup olmadığını belirler.
|
IsAppRotatingKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin uygulama rotasyon türünde olup olmadığını belirleyin.
|
IsAppStaticKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir uygulama statik türünde olup olmadığını belirler.
|
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 şifrelemesi için 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 dönen anahtarlar söz konusu olduğunda belirli bir dönemden bağımsız olarak aynı anahtar grubunu mu tanımlayacaklarını belirler.
|
IsSessionKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir oturum türünde olup olmadığını belirler.
|
IsValidKeyId(uint32_t keyId)
|
bool
Anahtar tanımlayıcısının geçerli (yasal) değere sahip olup olmadığını belirleyin.
|
MakeAppGroupMasterKeyId(uint8_t appGroupLocalNumber)
|
uint32_t
Uygulama grubu yerel numarasıyla verilen uygulama grubu ana anahtar kimliğini oluşturun.
|
MakeAppIntermediateKeyId(uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)
|
uint32_t
Bileşen anahtar kimlikleri verilen uygulama ara anahtar kimliği 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 bilgileri sağlayarak 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 bilgileri sağlayarak uygulama rotasyonlu anahtar kimliği oluşturun.
|
MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)
|
uint32_t
Bileşen anahtar kimlikleri ile uygulama statik anahtar kimliği oluşturun.
|
MakeEpochKeyId(uint8_t epochKeyNumber)
|
uint32_t
Dönem anahtar numarasıyla verilen uygulama grubu kök anahtarı kimliğini oluşturun.
|
MakeGeneralKeyId(uint16_t generalKeyNumber)
|
uint16_t
Genel anahtar numarasına göre genel anahtar kimliği oluşturma.
|
MakeRootKeyId(uint8_t rootKeyNumber)
|
uint32_t
Kök anahtar numarasıyla verilen uygulama grubu kök anahtar kimliğini oluşturma.
|
MakeSessionKeyId(uint16_t sessionKeyNumber)
|
uint16_t
Oturum anahtarı numarasına göre oturum anahtarı kimliği oluşturun.
|
UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)
|
uint32_t
Uygulama grup anahtarı kimliğini yeni dönem anahtarı numarasıyla güncelleyin.
|
UsesCurrentEpochKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin "geçerli" değerini kullanıp kullanmadığını belirler epoch anahtarı.
|
Herkese açık türler
@52
@52
Ortak Örgü anahtar kimlik alanları, işaretleri ve türleri.
Özellikler | |
---|---|
kClientRootKey
|
İstemci kök anahtarı kimliği. |
kFabricRootKey
|
Yapısal kök anahtar kimliği. |
kFabricSecret
|
Örgü kumaş gizli kimliği. |
kKeyNumber_Max
|
Anahtar kimliği alt alanları için maksimum değer sayısı. |
kNone
|
Örgü genel anahtar kimlikleri. Belirtilmemiş Weave anahtarı kimliği. |
kServiceRootKey
|
Hizmet kök anahtarı kimliği. |
kType_AppEpochKey
|
Uygulama grubu dönem anahtarı türü. |
kType_AppGroupMasterKey
|
Uygulama grubu ana anahtar türü. |
kType_AppIntermediateKey
|
Uygulama grubu ara anahtar türü. |
kType_AppRootKey
|
Örgü anahtar türleri (Weave ileti şifreleme türleri hariç). ziyaret edin. |
kType_AppRotatingKey
|
Uygulama döndürme 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 örgü anahtar türleri. |
kType_Session
|
Oturum anahtarı türü. |
Herkese açık statik işlevler
ConvertToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
Uygulama grup anahtarı kimliğini uygulama geçerli anahtar kimliğine dönüştürün.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulamanın geçerli anahtar kimliğini belirtir.
|
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 sonlandırılmış bir dizeye yönlendiren bir 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 grubunun yerel numarası.
|
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek 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 dönem anahtarı kimliğini alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
epoch anahtar kimliği.
|
GetEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
Belirtilen uygulama anahtarını elde etmek için kullanılan uygulama grubu dönem anahtarı numarasını alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
epoch anahtar numarası.
|
GetRootKeyId
uint32_t GetRootKeyId( uint32_t keyId )
Belirtilen uygulama anahtarını türetmek 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ı türetmek 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ünü belirtin.
|
IncorporatesAppGroupMasterKey
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin, grup ana anahtarını içerip içermediğini belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId, grup ana anahtarını içeriyorsa true.
|
IncorporatesEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin, dönem anahtarını içerip içermediğini belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId, dönem anahtarını içeriyorsa true.
|
IncorporatesRootKey
bool IncorporatesRootKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin kök anahtar içerip içermediğini belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId, kök anahtar içeriyorsa true.
|
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama dönem anahtarı türünde olup olmadığını belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId değeri bir uygulama dönem anahtarı türündeyse true.
|
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
Belirtilen anahtar kimliğinin, uygulama grubu anahtar türlerinden birine (statik veya dönüşümlü) ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId dönen veya statik anahtar türündeyse true.
|
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama grubu ana anahtar türünde olup olmadığını belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId değeri bir uygulama grubu ana anahtar türündeyse true.
|
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama kök anahtarı türünde olup olmadığını belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId bir uygulama kök anahtarı türündeyse true.
|
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
Belirtilen anahtar kimliğinin uygulama rotasyonu türünde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir uygulama döndürme türünün keyId değeri için true (doğru) değerini döndürür.
|
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama statik türünde olup olmadığını belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
true (doğru) değerine sahiptir.
|
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
Belirtilen anahtar kimliğinin genel türde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId değeri Genel türdeyse true.
|
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
Belirli bir anahtar kimliğinin Weave ileti şifrelemesi için 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 dönen anahtarlar söz konusu olduğunda belirli bir dönemden bağımsız olarak aynı anahtar grubunu mu tanımlayacaklarını belirler.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
Tuş kimlikleri aynı anahtarı temsil ediyorsa doğru değerini döndürür.
|
IsSessionKey
bool IsSessionKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir oturum türünde olup olmadığını belirler.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir oturum türünün keyId değeri için true (doğru) değerini alır.
|
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
Anahtar tanımlayıcısının geçerli (yasal) değere sahip olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
anahtar kimliği değeri geçerliyse true.
|
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
Uygulama grubu yerel numarasıyla verilen 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 kimlikleri verilen uygulama ara anahtar kimliği 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 bilgileri sağlayarak 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 bilgileri sağlayarak uygulama rotasyonlu anahtar kimliği oluşturun.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
İadeler |
uygulama döndürme anahtar kimliği.
|
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
Bileşen anahtar kimlikleri ile uygulama statik anahtar kimliği oluşturun.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
uygulama statik anahtar kimliği.
|
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
Dönem anahtar numarasıyla verilen uygulama grubu kök anahtarı kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
epoch anahtar kimliği.
|
MakeGeneralKeyId
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
Genel anahtar numarasına göre genel anahtar kimliği oluşturma.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
genel anahtar kimliği.
|
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
Kök anahtar numarasıyla verilen uygulama grubu kök anahtar kimliğini oluşturma.
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ği 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 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" değerini kullanıp kullanmadığını belirler epoch anahtarı.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId, geçerli dönem anahtarının kullanımını belirtiyorsa true.
|