Esta página foi traduzida pela API Cloud Translation.

nl::Weave::WeaveKeyId

#include <src/lib/core/WeaveKeyIds.h>

É a definição do identificador da chave do Weave.

Resumo

Essa classe contém tipos de chave, sinalizações de chave, definição de campos de ID de chave e funções de API.

Tipos públicos
@52{ kType_None = 0x00000000, kType_General = 0x00001000, kType_Session = 0x00002000, kType_AppStaticKey = 0x00004000, kType_AppRotatingKey = kType_AppStaticKey \| kTypeModifier_IncorporatesEpochKey, kType_AppRootKey = 0x00010000, kType_AppEpochKey = 0x00020000 \| kTypeModifier_IncorporatesEpochKey, kType_AppGroupMasterKey = 0x00030000, kType_AppIntermediateKey = kType_AppRootKey \| kTypeModifier_IncorporatesEpochKey, kNone = kType_None \| 0x0000, kFabricSecret = kType_General \| 0x0001, kFabricRootKey = kType_AppRootKey \| (0 << kShift_RootKeyNumber), kClientRootKey = kType_AppRootKey \| (1 << kShift_RootKeyNumber), kServiceRootKey = kType_AppRootKey \| (2 << kShift_RootKeyNumber), kKeyNumber_Max = kMask_KeyNumber }	tipo enumerado Campos, sinalizações e tipos de ID de chave do Weave público.

Tipos públicos

@52{
  kType_None = 0x00000000,
  kType_General = 0x00001000,
  kType_Session = 0x00002000,
  kType_AppStaticKey = 0x00004000,
  kType_AppRotatingKey = kType_AppStaticKey | kTypeModifier_IncorporatesEpochKey,
  kType_AppRootKey = 0x00010000,
  kType_AppEpochKey = 0x00020000 | kTypeModifier_IncorporatesEpochKey,
  kType_AppGroupMasterKey = 0x00030000,
  kType_AppIntermediateKey = kType_AppRootKey | kTypeModifier_IncorporatesEpochKey,
  kNone = kType_None | 0x0000,
  kFabricSecret = kType_General | 0x0001,
  kFabricRootKey = kType_AppRootKey | (0 << kShift_RootKeyNumber),
  kClientRootKey = kType_AppRootKey | (1 << kShift_RootKeyNumber),
  kServiceRootKey = kType_AppRootKey | (2 << kShift_RootKeyNumber),
  kKeyNumber_Max = kMask_KeyNumber
}

tipo enumerado

Campos, sinalizações e tipos de ID de chave do Weave público.

Funções estáticas públicas
`ConvertToCurrentAppKeyId(uint32_t keyId)`	`uint32_t` Converta o ID da chave do grupo de apps para o ID da chave atual do app.
`ConvertToStaticAppKeyId(uint32_t keyId)`	`uint32_t` Converta o ID da chave do aplicativo em um ID da chave estática do aplicativo.
`DescribeKey(uint32_t keyId)`	`const char *` Decodifique um identificador de chave do Weave com uma string descritiva.
`GetAppGroupLocalNumber(uint32_t keyId)`	`uint8_t` Recebe o número local do grupo de aplicativos usado para derivar a chave de aplicativo especificada.
`GetAppGroupMasterKeyId(uint32_t keyId)`	`uint32_t` Mostra o ID da chave mestra do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.
`GetEpochKeyId(uint32_t keyId)`	`uint32_t` Recebe o código da chave de época do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.
`GetEpochKeyNumber(uint32_t keyId)`	`uint8_t` Recebe o número da chave de época do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.
`GetRootKeyId(uint32_t keyId)`	`uint32_t` Recebe o ID da chave raiz do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.
`GetRootKeyNumber(uint32_t keyId)`	`uint8_t` Recebe o número da chave raiz do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.
`GetType(uint32_t keyId)`	`uint32_t` Receber tipo de chave Weave do ID de chave especificado.
`IncorporatesAppGroupMasterKey(uint32_t keyId)`	`bool` Determine se o código da chave do grupo de aplicativos especificado incorpora a chave mestra do grupo.
`IncorporatesEpochKey(uint32_t keyId)`	`bool` Determine se o código de chave do grupo de aplicativos especificado incorpora a chave de época.
`IncorporatesRootKey(uint32_t keyId)`	`bool` Determine se o código da chave do grupo de aplicativos especificado incorpora a chave raiz.
`IsAppEpochKey(uint32_t keyId)`	`bool` Determine se o código da chave especificado é de um tipo de chave de época de aplicativo.
`IsAppGroupKey(uint32_t keyId)`	`bool` Determine se o ID de chave especificado pertence a um dos tipos de chave de grupo de aplicativos (estático ou rotativo).
`IsAppGroupMasterKey(uint32_t keyId)`	`bool` Determine se o ID da chave especificado é de um tipo de chave mestra do grupo de aplicativos.
`IsAppRootKey(uint32_t keyId)`	`bool` Determine se o ID da chave especificado é de um tipo de chave raiz de aplicativo.
`IsAppRotatingKey(uint32_t keyId)`	`bool` Determine se o ID da chave especificado é de um tipo de rotação de app.
`IsAppStaticKey(uint32_t keyId)`	`bool` Determine se o código da chave especificado é de um tipo estático do aplicativo.
`IsGeneralKey(uint32_t keyId)`	`bool` Determine se o código da chave especificado é de um tipo geral.
`IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)`	`bool` Determinar se um código de chave identifica uma chave adequada para a criptografia de mensagens do Weave.
`IsSameKeyOrGroup(uint32_t keyId1, uint32_t keyId2)`	`bool` Determina se duas chaves identificam a mesma chave ou, no caso de chaves rotativas, o mesmo grupo de chaves independente de qualquer época específica.
`IsSessionKey(uint32_t keyId)`	`bool` Determine se o código da chave especificado é de um tipo de sessão.
`IsValidKeyId(uint32_t keyId)`	`bool` Determine se o identificador de chave tem valor válido (legal).
`MakeAppGroupMasterKeyId(uint8_t appGroupLocalNumber)`	`uint32_t` Cria o código da chave mestra do grupo de aplicativos conforme o número local do grupo de aplicativos.
`MakeAppIntermediateKeyId(uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)`	`uint32_t` Cria o ID intermediário da chave do aplicativo, considerando os códigos de chave constituintes.
`MakeAppKeyId(uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)`	`uint32_t` Crie o ID da chave do grupo de aplicativos com base nos IDs de chave constituintes e outras informações.
`MakeAppRotatingKeyId(uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)`	`uint32_t` Cria o código de chave rotativo do aplicativo, considerando os códigos de chave constituintes e outras informações;
`MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)`	`uint32_t` Cria o código da chave estática do aplicativo com base nos códigos da chave constituinte.
`MakeEpochKeyId(uint8_t epochKeyNumber)`	`uint32_t` Cria o código da chave raiz do grupo de aplicativos com o número da chave de época.
`MakeGeneralKeyId(uint16_t generalKeyNumber)`	`uint16_t` Crie o ID geral da chave considerando o número dela.
`MakeRootKeyId(uint8_t rootKeyNumber)`	`uint32_t` Cria o ID da chave raiz do grupo de aplicativos conforme o número da chave raiz.
`MakeSessionKeyId(uint16_t sessionKeyNumber)`	`uint16_t` ID da chave de sessão de criação com base no número de chave de sessão.
`UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)`	`uint32_t` Atualize o ID da chave do grupo de aplicativos com um novo número de chave de época.
`UsesCurrentEpochKey(uint32_t keyId)`	`bool` Determine se o código de chave do grupo de aplicativos especificado usa a chave de época "current".

Tipos públicos

55

@52

Campos, sinalizações e tipos de ID de chave do Weave público.

Propriedades
`kClientRootKey`	ID da chave raiz do cliente.
`kFabricRootKey`	ID da chave raiz do Fabric.
`kFabricSecret`	ID do secret de tecido do Weave.
`kKeyNumber_Max`	Valores máximos para subcampos de ID da chave.
`kNone`	Crie IDs de chave globais. ID da chave Weave não especificado.
`kServiceRootKey`	ID da chave raiz do serviço.
`kType_AppEpochKey`	Tipo de chave de época do grupo de aplicativos.
`kType_AppGroupMasterKey`	Tipo de chave mestra do grupo de aplicativos.
`kType_AppIntermediateKey`	Tipo de chave intermediário do grupo de aplicativos.
`kType_AppRootKey`	Tipos de chave do Weave (exceto os tipos de criptografia de mensagem do Weave). Observação: 16 dos 32 bits mais importantes desses tipos não podem ser todos zero, porque esses valores são reservados apenas para as chaves de criptografia de mensagens do Weave. Tipos de chave constituinte do grupo.Tipo de chave raiz do grupo de aplicativos.
`kType_AppRotatingKey`	Tipo de chave rotativa do aplicativo.
`kType_AppStaticKey`	Tipo de chave estática do aplicativo.
`kType_General`	Tipo geral de chave.
`kType_None`	Tipos de chave do Weave usados para criptografia de mensagens do Weave. Observação:16 dos 32 bits mais importantes do tipo de chave de criptografia de mensagem precisam ser zero porque apenas 16 bits do ID menos significativos são codificados na mensagem do Weave.A mensagem do Weave não é criptografada.
`kType_Session`	Tipo de chave de sessão.

Funções estáticas públicas

ConvertToCurrentAppKeyId

uint32_t ConvertToCurrentAppKeyId(
  uint32_t keyId
)

Converta o ID da chave do grupo de apps para o ID da chave atual do app.

Detalhes

Parâmetros

[in] keyId

ID da chave do app.

Retorna

ID da chave atual do app.

ConvertToStaticAppKeyId

uint32_t ConvertToStaticAppKeyId(
  uint32_t keyId
)

Converta o ID da chave do aplicativo em um ID da chave estática do aplicativo.

Detalhes

Parâmetros

[in] keyId

ID da chave do app.

Retorna

ID da chave estática do aplicativo.

DescreverChave

const char * DescribeKey(
  uint32_t keyId
)

Decodifique um identificador de chave do Weave com uma string descritiva.

Detalhes

Parâmetros

[in] keyId

Crie um ID de chave para decodificar e para o qual retornar uma string descritiva.

Retorna

Um ponteiro para uma string terminada em NULL que descreve o ID da chave especificado.

GetAppGroupLocalNumber

uint8_t GetAppGroupLocalNumber(
  uint32_t keyId
)

Recebe o número local do grupo de aplicativos usado para derivar a chave de aplicativo especificada.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

número local do grupo de aplicativos.

GetAppGroupMasterKeyId

uint32_t GetAppGroupMasterKeyId(
  uint32_t keyId
)

Mostra o ID da chave mestra do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

ID da chave mestra do grupo de aplicativos.

GetEpochKeyId

uint32_t GetEpochKeyId(
  uint32_t keyId
)

Recebe o código da chave de época do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

ID da chave de época.

GetEpochKeyNumber

uint8_t GetEpochKeyNumber(
  uint32_t keyId
)

Recebe o número da chave de época do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

Número da chave de época.

GetRootKeyId

uint32_t GetRootKeyId(
  uint32_t keyId
)

Recebe o ID da chave raiz do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

ID da chave raiz.

GetRootKeyNumber

uint8_t GetRootKeyNumber(
  uint32_t keyId
)

Recebe o número da chave raiz do grupo de aplicativos que foi usado para derivar a chave de aplicativo especificada.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

número da chave raiz

GetType

uint32_t GetType(
  uint32_t keyId
)

Receber tipo de chave Weave do ID de chave especificado.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

tipo de ID da chave.

IncorporaçõesAppGroupMasterKey

bool IncorporatesAppGroupMasterKey(
  uint32_t keyId
)

Determine se o código da chave do grupo de aplicativos especificado incorpora a chave mestra do grupo.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

verdadeiro se o keyId incorporar a chave mestra do grupo.

IncorporasEpochKey

bool IncorporatesEpochKey(
  uint32_t keyId
)

Determine se o código de chave do grupo de aplicativos especificado incorpora a chave de época.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

Verdadeiro se o keyId incorporar a chave de época.

IncorporasKeyKey

bool IncorporatesRootKey(
  uint32_t keyId
)

Determine se o código da chave do grupo de aplicativos especificado incorpora a chave raiz.

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

"true" se o keyId incorporar a chave raiz.

IsAppEpochKey

bool IsAppEpochKey(
  uint32_t keyId
)

Determine se o código da chave especificado é de um tipo de chave de época de aplicativo.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

verdadeiro se o keyId de um tipo de chave de época de aplicativo.

ChaveDoGrupoDoApp

bool IsAppGroupKey(
  uint32_t keyId
)

Determine se o ID de chave especificado pertence a um dos tipos de chave de grupo de aplicativos (estático ou rotativo).

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

Verdadeiro se o keyId for do tipo rotativo ou estático.

IsAppGroupMasterKey

bool IsAppGroupMasterKey(
  uint32_t keyId
)

Determine se o ID da chave especificado é de um tipo de chave mestra do grupo de aplicativos.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

true se o keyId de um tipo de chave mestra do grupo de aplicativos.

IsAppRootKey

bool IsAppRootKey(
  uint32_t keyId
)

Determine se o ID da chave especificado é de um tipo de chave raiz de aplicativo.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

true se o keyId de um tipo de chave raiz do aplicativo.

IsAppRotatingKey

bool IsAppRotatingKey(
  uint32_t keyId
)

Determine se o ID da chave especificado é de um tipo de rotação de app.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

"true" se o keyId de um tipo de rotação do aplicativo.

Chave estáticaApp

bool IsAppStaticKey(
  uint32_t keyId
)

Determine se o código da chave especificado é de um tipo estático do aplicativo.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

"true" se o keyId de um tipo estático do aplicativo.

ChaveGeralGeral

bool IsGeneralKey(
  uint32_t keyId
)

Determine se o código da chave especificado é de um tipo geral.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

"true" se o keyId tiver o tipo "General".

Código da criptografia de mensagem

bool IsMessageEncryptionKeyId(
  uint32_t keyId,
  bool allowLogicalKeys
)

Determinar se um código de chave identifica uma chave adequada para a criptografia de mensagens do Weave.

Detalhes

Parâmetros

`[in] keyId`	ID da chave do Weave.
`[in] allowLogicalKeys`	Especifica se os IDs de chave lógica (como a chave rotativa "atual") devem ser considerados adequados para a criptografia de mensagens.

Retorna

"True" se a chave identificada puder ser usada para criptografar mensagens do Weave.

IsSameKeyOrGroup

bool IsSameKeyOrGroup(
  uint32_t keyId1,
  uint32_t keyId2
)

Determina se duas chaves identificam a mesma chave ou, no caso de chaves rotativas, o mesmo grupo de chaves independente de qualquer época específica.

Detalhes

Parâmetros

`[in] keyId1`	O primeiro ID da chave a ser testado.
`[in] keyId2`	O segundo ID da chave a ser testado.

Retorna

Verdadeiro se os IDs de chave representarem a mesma chave.

Chave de sessão

bool IsSessionKey(
  uint32_t keyId
)

Determine se o código da chave especificado é de um tipo de sessão.

Detalhes

Parâmetros

[in] keyId

Identificador de chave de tecido.

Retorna

"true" se o keyId de um tipo de sessão.

CódigoDisValidKeyId

bool IsValidKeyId(
  uint32_t keyId
)

Determine se o identificador de chave tem valor válido (legal).

Detalhes

Parâmetros

[in] keyId

ID da chave do Weave.

Retorna

"true" se o valor do ID da chave for válido.

MakeAppGroupMasterKeyId

uint32_t MakeAppGroupMasterKeyId(
  uint8_t appGroupLocalNumber
)

Cria o código da chave mestra do grupo de aplicativos conforme o número local do grupo de aplicativos.

Detalhes

Parâmetros

[in] appGroupLocalNumber

Número local do grupo de aplicativos.

Retorna

ID da chave mestra do grupo de aplicativos.

MakeAppIntermediateKeyId

uint32_t MakeAppIntermediateKeyId(
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  bool useCurrentEpochKey
)

Cria o ID intermediário da chave do aplicativo, considerando os códigos de chave constituintes.

Detalhes

Parâmetros

`[in] rootKeyId`	ID da chave raiz usado para derivar a chave intermediária do aplicativo.
`[in] epochKeyId`	ID da chave de época usado para derivar a chave intermediária do aplicativo.
`[in] useCurrentEpochKey`	Uma sinalização booleana que indica se a chave deve ser derivada usando a chave de época "current".

Retorna

ID da chave intermediária do aplicativo.

MakeAppKeyId

uint32_t MakeAppKeyId(
  uint32_t keyType,
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  uint32_t appGroupMasterKeyId,
  bool useCurrentEpochKey
)

Crie o ID da chave do grupo de aplicativos com base nos IDs de chave constituintes e outras informações.

Detalhes

Parâmetros

`[in] keyType`	Tipo de chave do grupo de aplicativos derivado.
`[in] rootKeyId`	ID da chave raiz usado para derivar a chave de grupo de aplicativos.
`[in] epochKeyId`	ID da chave de época usado para derivar a chave do grupo de aplicativos.
`[in] appGroupMasterKeyId`	ID da chave mestra do grupo de aplicativos, usada para derivar a chave do grupo de aplicativos.
`[in] useCurrentEpochKey`	Uma sinalização booleana que indica se a chave deve ser derivada usando a chave de época "current".

Retorna

ID da chave do grupo de aplicativos.

MakeAppRotatingKeyId

uint32_t MakeAppRotatingKeyId(
  uint32_t rootKeyId,
  uint32_t epochKeyId,
  uint32_t appGroupMasterKeyId,
  bool useCurrentEpochKey
)

Cria o código de chave rotativo do aplicativo, considerando os códigos de chave constituintes e outras informações;

Detalhes

Parâmetros

`[in] rootKeyId`	ID da chave raiz usado para derivar a chave de rotação do aplicativo.
`[in] epochKeyId`	ID da chave de época usado para derivar a chave rotativa do aplicativo.
`[in] appGroupMasterKeyId`	ID da chave mestra do grupo de aplicativos usado para derivar a chave rotativa do aplicativo.
`[in] useCurrentEpochKey`	Uma sinalização booleana que indica se a chave deve ser derivada usando a chave de época "current".

Retorna

ID da chave rotativa do aplicativo.

MakeAppStaticKeyId

uint32_t MakeAppStaticKeyId(
  uint32_t rootKeyId,
  uint32_t appGroupMasterKeyId
)

Cria o código da chave estática do aplicativo com base nos códigos da chave constituinte.

Detalhes

Parâmetros

`[in] rootKeyId`	ID da chave raiz usado para derivar a chave estática do aplicativo.
`[in] appGroupMasterKeyId`	ID da chave mestra do grupo de aplicativos usado para derivar a chave estática do aplicativo.

Retorna

ID da chave estática do aplicativo.

MakeEpochKeyId

uint32_t MakeEpochKeyId(
  uint8_t epochKeyNumber
)

Cria o código da chave raiz do grupo de aplicativos com o número da chave de época.

Detalhes

Parâmetros

[in] epochKeyNumber

É o número da chave de época.

Retorna

ID da chave de época.

MakeGeralKeyId

uint16_t MakeGeneralKeyId(
  uint16_t generalKeyNumber
)

Crie o ID geral da chave considerando o número dela.

Detalhes

Parâmetros

[in] generalKeyNumber

Número geral da chave.

Retorna

ID da chave geral

MakeRootKeyId

uint32_t MakeRootKeyId(
  uint8_t rootKeyNumber
)

Cria o ID da chave raiz do grupo de aplicativos conforme o número da chave raiz.

Detalhes

Parâmetros

[in] rootKeyNumber

Número da chave raiz.

Retorna

ID da chave raiz.

MakeSessionKeyId

uint16_t MakeSessionKeyId(
  uint16_t sessionKeyNumber
)

ID da chave de sessão de criação com base no número de chave de sessão.

Detalhes

Parâmetros

[in] sessionKeyNumber

Número da chave de sessão.

Retorna

ID da chave de sessão.

UpdateEpochKeyId

uint32_t UpdateEpochKeyId(
  uint32_t keyId,
  uint32_t epochKeyId
)

Atualize o ID da chave do grupo de aplicativos com um novo número de chave de época.

Detalhes

Parâmetros

`[in] keyId`	ID da chave do app.
`[in] epochKeyId`	ID da chave de época, que será usado na construção do ID atualizado da chave do aplicativo.

Retorna

ID da chave do app.

UsesCurrentEpochKey

bool UsesCurrentEpochKey(
  uint32_t keyId
)

Determine se o código de chave do grupo de aplicativos especificado usa a chave de época "current".

Detalhes

Parâmetros

[in] keyId

Identificador de chave do grupo de aplicativos do Weave.

Retorna

Verdadeiro se o keyId indicar o uso da chave de época atual.