nl:: WeaveKey:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
Weave Key tanımlayıcısının tanımı.
Özet
Bu sınıfta anahtar türleri, anahtar işaretleri, anahtar kimliği alanları tanımı ve API işlevleri bulunur.
Herkese açık türler |
|
---|---|
@52{
|
enum Herkese açık Weave anahtar kimliği alanları, işaretleri ve türleri. |
Herkese açık statik işlevler |
|
---|---|
ConvertToCurrentAppKeyId(uint32_t keyId)
|
uint32_t
Uygulama grubu 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 *
Weave anahtar tanımlayıcısının açıklayıcı bir dizeyle kodunu çözme.
|
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ı türetmek 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 belirleyin.
|
IncorporatesEpochKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtarı kimliğinin epoch anahtarını 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 bir uygulama dönemi 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önüşümlü) 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ünden olup olmadığını belirleyin.
|
IsAppRotatingKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin uygulama döndürme 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ı belirleyin.
|
IsGeneralKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin genel bir türde olup olmadığını belirleyin.
|
IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)
|
bool
Belirli bir anahtar kimliğinin Weave mesaj ş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önüşümlü anahtarlar mı olduğunu tanımlamak için belirli bir dönemden bağımsız olarak aynı anahtar grubunu belirler.
|
IsSessionKey(uint32_t keyId)
|
bool
Belirtilen anahtar kimliğinin bir oturum türüne ait olup olmadığını belirleyin.
|
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ı 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ğ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 bilgileri vermek için 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 bilgiler için uygulamanın dönüşümlü anahtar kimliği oluşturun.
|
MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)
|
uint32_t
Bileşen anahtar kimlikleri verilen uygulama statik anahtar kimliğini oluşturun.
|
MakeEpochKeyId(uint8_t epochKeyNumber)
|
uint32_t
Epoch anahtar numarası verilen uygulama grubu kök anahtar kimliğini oluşturun.
|
MakeGeneralKeyId(uint16_t generalKeyNumber)
|
uint16_t
Genel anahtar numarası verilen genel anahtar kimliğini 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ı verilen oturum anahtarı kimliğini oluşturun.
|
UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)
|
uint32_t
Uygulama grubu anahtar kimliğini yeni dönem anahtar numarasıyla güncelleyin.
|
UsesCurrentEpochKey(uint32_t keyId)
|
bool
Belirtilen uygulama grubu anahtar kimliğinin "geçerli" dönem anahtarını kullanıp kullanmadığını belirleyin.
|
Herkese açık türler
@52
@52
Herkese açık Weave anahtar kimliği alanları, işaretleri ve türleri.
Özellikler | |
---|---|
kClientRootKey
|
İstemci kök anahtar kimliği. |
kFabricRootKey
|
Kumaş kök anahtarı kimliği. |
kFabricSecret
|
Örme kumaş gizli anahtar kimliği. |
kKeyNumber_Max
|
Anahtar kimliği alt alanları için maksimum değerler. |
kNone
|
Genel anahtar kimliklerini örün. Belirtilmemiş Weave anahtar kimliği. |
kServiceRootKey
|
Hizmet kök anahtar kimliği. |
kType_AppEpochKey
|
Uygulama grubu dönemi anahtar türü. |
kType_AppGroupMasterKey
|
Uygulama grubu ana anahtar türü. |
kType_AppIntermediateKey
|
Uygulama grubu ara anahtar türü. |
kType_AppRootKey
|
Dokuma anahtar türleri (Weave mesaj şifreleme türleri hariç). |
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 mesaj şifrelemesi için kullanılan ağ anahtar türleri. |
kType_Session
|
Oturum anahtarı türü. |
Herkese açık statik işlevler
MevcutUygulama Anahtar Kimliğine Dönüştür
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
Uygulama grubu anahtar kimliğini uygulama geçerli anahtar kimliğine dönüştürün.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulama geçerli anahtar kimliği.
|
ConvertToStaticAppAnahtar Kimliği
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.
|
Açıklayıcı Anahtar
const char * DescribeKey( uint32_t keyId )
Weave anahtar tanımlayıcısının açıklayıcı bir dizeyle kodunu çözme.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Belirtilen anahtar kimliğini açıklayan, NULL ile sonlandırılmış bir dizenin işaretçisi.
|
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ı türetmek için kullanılan uygulama grubu dönem anahtarı kimliğini alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
dönem 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 |
dönem 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ğidir.
|
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ıdır.
|
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ü.
|
Uygulama Grubu AnaAnahtarını Dahil Et
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 doğrudur.
|
EpochKey'i dahil et
bool IncorporatesEpochKey( uint32_t keyId )
Belirtilen uygulama grubu anahtarı kimliğinin epoch anahtarını içerip içermediğini belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId bu sırada anahtar anahtarı içeriyorsa doğru.
|
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 doğru.
|
IsAppEpochAnahtarı
bool IsAppEpochKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama dönemi anahtar türüne ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir uygulama dönem anahtarı türünün keyId değeri true ise.
|
UygulamaUygulama Anahtarı
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 |
anahtar kimliği rotasyonlu veya statik anahtar türündeyse true değerini girin.
|
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 değeri true ise.
|
IsAppRootAnahtarı
bool IsAppRootKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama kök anahtar türünden olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulama kök anahtar türünün keyId değeri true ise.
|
UygulamaRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
Belirtilen anahtar kimliğinin uygulama döndürme türünde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Bir uygulamanın keyId türü keyId değeri doğruysa.
|
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
Belirtilen anahtar kimliğinin bir uygulama statik türünde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir uygulama statik türündeki keyId değeri doğruysa.
|
Genel Anahtar
bool IsGeneralKey( uint32_t keyId )
Belirtilen anahtar kimliğinin genel bir türde olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId Genel türe sahipse doğru.
|
IsMessageEncryptionAnahtar Kimliği
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
Belirli bir anahtar kimliğinin Weave mesaj şifrelemesi için uygun bir anahtar tanımlayıp tanımlamadığını belirleyin.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
true Tanımlanan anahtarın Weave iletilerini şifrelemek için kullanılabilmesi hâlinde.
|
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
İki anahtar kimliğinin aynı anahtarı mı yoksa dönüşümlü anahtarlar mı olduğunu tanımlamak için belirli bir dönemden bağımsız olarak aynı anahtar grubunu 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üne ait olup olmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
bir oturum türünün keyId değeri true ise.
|
IsGeçerliAnahtar Kimliği
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 değerini alır.
|
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
Uygulama grubu yerel numarası verilen uygulama grubu ana anahtar kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
uygulama grubu ana anahtar kimliği.
|
MakeAppAra Anahtar Kimliği
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
Bileşen anahtar kimlikleri verilen uygulama ara anahtar kimliğini oluşturun.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
İadeler |
uygulama ara anahtar kimliği.
|
MakeAppKeyId (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 vermek için uygulama grubu anahtar kimliğini oluşturun.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||
İadeler |
uygulama grubu anahtarı kimliği:
|
MakeAppRotcingKeyId
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Bileşen anahtar kimlikleri ve diğer bilgiler için uygulamanın dönüşümlü anahtar kimliği oluşturun.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
İadeler |
uygulama anahtar anahtarı kimliğini döndürür.
|
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
Bileşen anahtar kimlikleri verilen uygulama statik anahtar kimliğini oluşturun.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
uygulama statik anahtar kimliği.
|
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
Epoch anahtar numarası verilen uygulama grubu kök anahtar kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
dönem anahtarı kimliği.
|
MakeGenelAnahtar Kimliği
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
Genel anahtar numarası verilen genel anahtar kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
genel anahtar kimliğidir.
|
MakeRootAnahtar Kimliği
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ğidir.
|
MakeSessionKeyId (Marka oturumu anahtar kimliği)
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
Oturum anahtar numarası verilen oturum anahtarı kimliğini oluşturun.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
oturum anahtarı kimliği.
|
GüncellemeEpochKeyId
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ğidir.
|
CurrentsEpochKey Kullanır
bool UsesCurrentEpochKey( uint32_t keyId )
Belirtilen uygulama grubu anahtar kimliğinin "geçerli" dönem anahtarını kullanıp kullanmadığını belirleyin.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
keyId geçerli epoch anahtarının kullanımını belirtiyorsa true.
|