nl :: Tejido:: WeaveKeyId

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

La definición del identificador Weave Key.

Resumen

Esta clase contiene tipos de clave, indicadores de clave, definición de campos de ID de clave y funciones 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 }	enumeración Campos, banderas y tipos de ID de clave de tejido 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
 }

enumeración

Campos, banderas y tipos de ID de clave de tejido público.

Funciones estáticas públicas
`ConvertToCurrentAppKeyId (uint32_t keyId)`	`uint32_t` Convierta el ID de la clave del grupo de aplicaciones en el ID de la clave actual de la aplicación.
`ConvertToStaticAppKeyId (uint32_t keyId)`	`uint32_t` Convierta el ID de la clave de la aplicación en el ID de la clave estática de la aplicación.
`DescribeKey (uint32_t keyId)`	`const char *` Decodifica un identificador de clave de Weave con una cadena descriptiva.
`GetAppGroupLocalNumber (uint32_t keyId)`	`uint8_t` Obtenga el número local del grupo de aplicaciones que se utilizó para derivar la clave de aplicación especificada.
`GetAppGroupMasterKeyId (uint32_t keyId)`	`uint32_t` Obtener el ID de la clave maestra del grupo de aplicaciones que se utilizó para derivar la clave de la aplicación especificada.
`GetEpochKeyId (uint32_t keyId)`	`uint32_t` Obtener el ID de clave de época del grupo de aplicaciones que se utilizó para derivar la clave de aplicación especificada.
`GetEpochKeyNumber (uint32_t keyId)`	`uint8_t` Obtener el número de clave de época del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetRootKeyId (uint32_t keyId)`	`uint32_t` Obtener el ID de la clave raíz del grupo de aplicaciones que se utilizó para derivar la clave de la aplicación especificada.
`GetRootKeyNumber (uint32_t keyId)`	`uint8_t` Obtiene el número de clave raíz del grupo de aplicaciones que se utilizó para derivar la clave de la aplicación especificada.
`GetType (uint32_t keyId)`	`uint32_t` Obtenga el tipo de clave de tejido del ID de clave especificado.
`IncorporatesAppGroupMasterKey (uint32_t keyId)`	`bool` Determine si el ID de clave del grupo de aplicaciones especificado incorpora la clave maestra del grupo.
`IncorporatesEpochKey (uint32_t keyId)`	`bool` Determine si el ID de clave de grupo de aplicaciones especificado incorpora la clave de época.
`IncorporatesRootKey (uint32_t keyId)`	`bool` Determine si el ID de clave del grupo de aplicaciones especificado incorpora la clave raíz.
`IsAppEpochKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es de un tipo de clave de época de aplicación.
`IsAppGroupKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado pertenece a uno de los tipos de clave del grupo de aplicaciones (estático o rotativo).
`IsAppGroupMasterKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es de un tipo de clave maestra de grupo de aplicaciones.
`IsAppRootKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es del tipo de clave raíz de una aplicación.
`IsAppRotatingKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es de un tipo rotativo de aplicación.
`IsAppStaticKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es de un tipo estático de aplicación.
`IsGeneralKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es de tipo general.
`IsMessageEncryptionKeyId (uint32_t keyId, bool allowLogicalKeys)`	`bool` Determine si un ID de clave determinado identifica una clave que sea adecuada para el cifrado de mensajes de Weave.
`IsSameKeyOrGroup (uint32_t keyId1, uint32_t keyId2)`	`bool` Determina si dos ID de clave identifican la misma clave o, en el caso de claves rotativas, el mismo grupo de claves independientemente de cualquier época en particular.
`IsSessionKey (uint32_t keyId)`	`bool` Determine si el ID de clave especificado es de un tipo de sesión.
`IsValidKeyId (uint32_t keyId)`	`bool` Determine si el identificador de clave tiene un valor válido (legal).
`MakeAppGroupMasterKeyId (uint8_t appGroupLocalNumber)`	`uint32_t` Construya el ID de la clave maestra del grupo de aplicaciones dado el número local del grupo de aplicaciones.
`MakeAppIntermediateKeyId (uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)`	`uint32_t` Construya el ID de clave intermedia de la aplicación dados los ID de clave constituyente.
`MakeAppKeyId (uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)`	`uint32_t` Construya el ID de la clave del grupo de aplicaciones dados los ID de las claves constituyentes y otra información.
`MakeAppRotatingKeyId (uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)`	`uint32_t` Construya el ID de clave rotatoria de la aplicación dados los ID de clave constituyente y otra información.
`MakeAppStaticKeyId (uint32_t rootKeyId, uint32_t appGroupMasterKeyId)`	`uint32_t` Construya el ID de clave estática de la aplicación dados los ID de clave constituyente.
`MakeEpochKeyId (uint8_t epochKeyNumber)`	`uint32_t` Construya el ID de clave raíz del grupo de aplicaciones dado el número de clave de época.
`MakeGeneralKeyId (uint16_t generalKeyNumber)`	`uint16_t` Construya el ID de clave general dado el número de clave general.
`MakeRootKeyId (uint8_t rootKeyNumber)`	`uint32_t` Construya el ID de clave raíz del grupo de aplicaciones dado el número de clave raíz.
`MakeSessionKeyId (uint16_t sessionKeyNumber)`	`uint16_t` Construya el ID de clave de sesión dado el número de clave de sesión.
`UpdateEpochKeyId (uint32_t keyId, uint32_t epochKeyId)`	`uint32_t` Actualice el ID de la clave del grupo de aplicaciones con un nuevo número de clave de época.
`UsesCurrentEpochKey (uint32_t keyId)`	`bool` Determine si el ID de clave de grupo de aplicaciones especificado utiliza la clave de época "actual".

Tipos públicos

@ 52

@52

Campos, banderas y tipos de ID de clave de tejido público.

Propiedades
`kClientRootKey`	ID de clave raíz del cliente.
`kFabricRootKey`	ID de clave de raíz de la tela.
`kFabricSecret`	ID secreto de tejido de tejido.
`kKeyNumber_Max`	Valores máximos para subcampos de ID de clave.
`kNone`	Teje ID de clave global. ID de clave de tejido no especificado.
`kServiceRootKey`	ID de clave raíz del servicio.
`kType_AppEpochKey`	Tipo de clave de época del grupo de aplicaciones.
`kType_AppGroupMasterKey`	Tipo de clave maestra del grupo de aplicaciones.
`kType_AppIntermediateKey`	Tipo de clave intermedia del grupo de aplicaciones.
`kType_AppRootKey`	Tipos de clave de tejido (distintos de los tipos de cifrado de mensajes de tejido). Nota: 16 (de 32) los bits más significativos de estos tipos no pueden ser todos ceros, porque estos valores están reservados solo para las claves de cifrado de mensajes de Weave. Tipos de clave de grupo constituyente Tipo de clave raíz del grupo de aplicación.
`kType_AppRotatingKey`	Aplicación tipo llave giratoria.
`kType_AppStaticKey`	Tipo de clave estática de la aplicación.
`kType_General`	Tipo de clave general.
`kType_None`	Tipos de claves de tejido utilizados para el cifrado de mensajes de tejido. Nota: 16 (de 32) los bits más significativos del tipo de clave de cifrado del mensaje deben ser cero porque solo los 16 bits menos significativos del ID están codificados en el mensaje Weave. El mensaje Weave no está cifrado.
`kType_Session`	Tipo de clave de sesión.

Funciones estáticas públicas

ConvertToCurrentAppKeyId

uint32_t ConvertToCurrentAppKeyId(
  uint32_t keyId
)

Convierta el ID de la clave del grupo de aplicaciones en el ID de la clave actual de la aplicación.

Detalles

Parámetros

[in] keyId

ID de la clave de la aplicación.

Devoluciones

ID de clave actual de la aplicación.

ConvertToStaticAppKeyId

uint32_t ConvertToStaticAppKeyId(
  uint32_t keyId
)

Convierta el ID de la clave de la aplicación en el ID de la clave estática de la aplicación.

Detalles

Parámetros

[in] keyId

ID de la clave de la aplicación.

Devoluciones

ID de clave estática de la aplicación.

DescribeKey

const char * DescribeKey(
  uint32_t keyId
)

Decodifica un identificador de clave de Weave con una cadena descriptiva.

Detalles

Parámetros

[in] keyId

Teje el ID de la clave para decodificar y para el que devolver una cadena descriptiva.

Devoluciones

Un puntero a una cadena terminada en NULL que describe el ID de clave especificado.

GetAppGroupLocalNumber

uint8_t GetAppGroupLocalNumber(
  uint32_t keyId
)

Obtenga el número local del grupo de aplicaciones que se utilizó para derivar la clave de aplicación especificada.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

número local del grupo de aplicaciones.

GetAppGroupMasterKeyId

uint32_t GetAppGroupMasterKeyId(
  uint32_t keyId
)

Obtener el ID de la clave maestra del grupo de aplicaciones que se utilizó para derivar la clave de la aplicación especificada.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

ID de clave maestra del grupo de aplicaciones.

GetEpochKeyId

uint32_t GetEpochKeyId(
  uint32_t keyId
)

Obtener el ID de clave de época del grupo de aplicaciones que se utilizó para derivar la clave de aplicación especificada.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

ID de clave de época.

GetEpochKeyNumber

uint8_t GetEpochKeyNumber(
  uint32_t keyId
)

Obtener el número de clave de época del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

número de clave de época.

GetRootKeyId

uint32_t GetRootKeyId(
  uint32_t keyId
)

Obtener el ID de la clave raíz del grupo de aplicaciones que se utilizó para derivar la clave de la aplicación especificada.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

ID de clave raíz.

GetRootKeyNumber

uint8_t GetRootKeyNumber(
  uint32_t keyId
)

Obtiene el número de clave raíz del grupo de aplicaciones que se utilizó para derivar la clave de la aplicación especificada.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

número de clave raíz.

GetType

uint32_t GetType(
  uint32_t keyId
)

Obtenga el tipo de clave de tejido del ID de clave especificado.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

tipo de ID de clave.

IncorporaAppGroupMasterKey

bool IncorporatesAppGroupMasterKey(
  uint32_t keyId
)

Determine si el ID de clave del grupo de aplicaciones especificado incorpora la clave maestra del grupo.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

Es true si keyId incorpora una clave maestra de grupo.

Incorpora EpochKey

bool IncorporatesEpochKey(
  uint32_t keyId
)

Determine si el ID de clave de grupo de aplicaciones especificado incorpora la clave de época.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

Es true si keyId incorpora la clave de época.

IncorporaRootKey

bool IncorporatesRootKey(
  uint32_t keyId
)

Determine si el ID de clave del grupo de aplicaciones especificado incorpora la clave raíz.

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

Es verdadero si el keyId incorpora la clave raíz.

IsAppEpochKey

bool IsAppEpochKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es de un tipo de clave de época de aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es verdadero si el keyId de un tipo de clave de época de aplicación.

IsAppGroupKey

bool IsAppGroupKey(
  uint32_t keyId
)

Determine si el ID de clave especificado pertenece a uno de los tipos de clave del grupo de aplicaciones (estático o rotativo).

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es true si el keyId es de tipo de clave rotativa o estática.

IsAppGroupMasterKey

bool IsAppGroupMasterKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es de un tipo de clave maestra de grupo de aplicaciones.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es true si el keyId de un tipo de clave maestra de grupo de aplicaciones.

IsAppRootKey

bool IsAppRootKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es del tipo de clave raíz de una aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es verdadero si el keyId de un tipo de clave raíz de la aplicación.

IsAppRotatingKey

bool IsAppRotatingKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es de un tipo rotativo de aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es true si el keyId de una aplicación de tipo rotatorio.

IsAppStaticKey

bool IsAppStaticKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es de un tipo estático de aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es verdadero si el keyId de una aplicación de tipo estático.

IsGeneralKey

bool IsGeneralKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es de tipo general.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es true si el keyId tiene el tipo General.

IsMessageEncryptionKeyId

bool IsMessageEncryptionKeyId(
  uint32_t keyId,
  bool allowLogicalKeys
)

Determine si un ID de clave determinado identifica una clave que sea adecuada para el cifrado de mensajes de Weave.

Detalles

Parámetros

`[in] keyId`	ID de clave de tejido.
`[in] allowLogicalKeys`	Especifica si las ID de claves lógicas (como la clave rotativa "actual") deben considerarse adecuadas para el cifrado de mensajes.

Devoluciones

true Si la clave identificada se puede utilizar para cifrar los mensajes de Weave.

IsSameKeyOrGroup

bool IsSameKeyOrGroup(
  uint32_t keyId1,
  uint32_t keyId2
)

Determina si dos ID de clave identifican la misma clave o, en el caso de claves rotativas, el mismo grupo de claves independientemente de cualquier época en particular.

Detalles

Parámetros

`[in] keyId1`	La primera identificación de clave para probar.
`[in] keyId2`	La segunda identificación de clave para probar.

Devoluciones

Verdadero si los ID de las claves representan la misma clave.

IsSessionKey

bool IsSessionKey(
  uint32_t keyId
)

Determine si el ID de clave especificado es de un tipo de sesión.

Detalles

Parámetros

[in] keyId

Identificador de clave de tejido.

Devoluciones

Es verdadero si el keyId de un tipo de sesión.

IsValidKeyId

bool IsValidKeyId(
  uint32_t keyId
)

Determine si el identificador de clave tiene un valor válido (legal).

Detalles

Parámetros

[in] keyId

ID de clave de tejido.

Devoluciones

Es verdadero si el valor de ID de clave es válido.

MakeAppGroupMasterKeyId

uint32_t MakeAppGroupMasterKeyId(
  uint8_t appGroupLocalNumber
)

Construya el ID de la clave maestra del grupo de aplicaciones dado el número local del grupo de aplicaciones.

Detalles

Parámetros

[in] appGroupLocalNumber

Número local del grupo de aplicaciones.

Devoluciones

ID de clave maestra del grupo de aplicaciones.

MakeAppIntermediateKeyId

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

Construya el ID de clave intermedia de la aplicación dados los ID de clave constituyente.

Detalles

Parámetros

`[in] rootKeyId`	ID de clave raíz que se utiliza para derivar la clave intermedia de la aplicación.
`[in] epochKeyId`	ID de clave de época utilizada para derivar la clave intermedia de la aplicación.
`[in] useCurrentEpochKey`	Una bandera booleana que indica si la clave debe derivarse utilizando la clave de época "actual".

Devoluciones

ID de clave intermedia de la aplicación.

MakeAppKeyId

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

Construya el ID de la clave del grupo de aplicaciones dados los ID de las claves constituyentes y otra información.

Detalles

Parámetros

`[in] keyType`	Tipo de clave de grupo de aplicaciones derivadas.
`[in] rootKeyId`	ID de clave raíz que se utiliza para derivar la clave del grupo de aplicaciones.
`[in] epochKeyId`	ID de clave de época utilizada para derivar la clave del grupo de aplicaciones.
`[in] appGroupMasterKeyId`	ID de clave maestra del grupo de aplicaciones utilizado para derivar la clave del grupo de aplicaciones.
`[in] useCurrentEpochKey`	Una bandera booleana que indica si la clave debe derivarse utilizando la clave de época "actual".

Devoluciones

ID de clave de grupo de aplicaciones.

MakeAppRotatingKeyId

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

Construya el ID de clave rotatoria de la aplicación dados los ID de clave constituyente y otra información.

Detalles

Parámetros

`[in] rootKeyId`	ID de clave raíz utilizada para derivar la clave giratoria de la aplicación.
`[in] epochKeyId`	ID de clave de época utilizada para derivar la clave giratoria de la aplicación.
`[in] appGroupMasterKeyId`	ID de clave maestra del grupo de aplicaciones que se utiliza para derivar la clave giratoria de la aplicación.
`[in] useCurrentEpochKey`	Una bandera booleana que indica si la clave debe derivarse utilizando la clave de época "actual".

Devoluciones

ID de clave giratoria de la aplicación.

MakeAppStaticKeyId

uint32_t MakeAppStaticKeyId(
  uint32_t rootKeyId,
  uint32_t appGroupMasterKeyId
)

Construya el ID de clave estática de la aplicación dados los ID de clave constituyente.

Detalles

Parámetros

`[in] rootKeyId`	ID de clave raíz que se utiliza para derivar la clave estática de la aplicación.
`[in] appGroupMasterKeyId`	ID de clave maestra del grupo de aplicaciones utilizado para derivar la clave estática de la aplicación.

Devoluciones

ID de clave estática de la aplicación.

MakeEpochKeyId

uint32_t MakeEpochKeyId(
  uint8_t epochKeyNumber
)

Construya el ID de clave raíz del grupo de aplicaciones dado el número de clave de época.

Detalles

Parámetros

[in] epochKeyNumber

Número de clave de época.

Devoluciones

ID de clave de época.

MakeGeneralKeyId

uint16_t MakeGeneralKeyId(
  uint16_t generalKeyNumber
)

Construya el ID de clave general dado el número de clave general.

Detalles

Parámetros

[in] generalKeyNumber

Número de clave general.

Devoluciones

ID de clave general.

MakeRootKeyId

uint32_t MakeRootKeyId(
  uint8_t rootKeyNumber
)

Construya el ID de clave raíz del grupo de aplicaciones dado el número de clave raíz.

Detalles

Parámetros

[in] rootKeyNumber

Número de clave raíz.

Devoluciones

ID de clave raíz.

MakeSessionKeyId

uint16_t MakeSessionKeyId(
  uint16_t sessionKeyNumber
)

Construya el ID de clave de sesión dado el número de clave de sesión.

Detalles

Parámetros

[in] sessionKeyNumber

Número de clave de sesión.

Devoluciones

ID de clave de sesión.

UpdateEpochKeyId

uint32_t UpdateEpochKeyId(
  uint32_t keyId,
  uint32_t epochKeyId
)

Actualice el ID de la clave del grupo de aplicaciones con el nuevo número de clave de época.

Detalles

Parámetros

`[in] keyId`	ID de la clave de la aplicación.
`[in] epochKeyId`	ID de clave de época, que se utilizará en la construcción del ID de clave de aplicación actualizado.

Devoluciones

ID de clave de la aplicación.

UsosCurrentEpochKey

bool UsesCurrentEpochKey(
  uint32_t keyId
)

Determine si el ID de clave de grupo de aplicaciones especificado utiliza la clave de época "actual".

Detalles

Parámetros

[in] keyId

Identificador de clave de grupo de aplicaciones de tejido.

Devoluciones

Es true si keyId indica el uso de la clave de época actual.