Se usó la API de Cloud Translation para traducir esta página.

nl::Weave::WeaveKeyId

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

La definición del identificador de clave de Weave.

Resumen

Esta clase contiene tipos de clave, marcas de clave, definición de campos 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 }	enum Campos de ID de clave de Weave, marcas y tipos.

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
}

enum

Campos de ID de clave de Weave, marcas y tipos.

Funciones estáticas públicas
`ConvertToCurrentAppKeyId(uint32_t keyId)`	`uint32_t` Convierte 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` Convierte el ID de la clave de aplicación en el ID de clave estática de la aplicación.
`DescribeKey(uint32_t keyId)`	`const char *` Decodifica un identificador de clave de Weave con una string descriptiva.
`GetAppGroupLocalNumber(uint32_t keyId)`	`uint8_t` Obtén el número local de grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetAppGroupMasterKeyId(uint32_t keyId)`	`uint32_t` Obtén el ID de la clave maestra del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetEpochKeyId(uint32_t keyId)`	`uint32_t` Obtén el ID de clave de ciclo de vida del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetEpochKeyNumber(uint32_t keyId)`	`uint8_t` Obtén el número de clave de ciclo de vida del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetRootKeyId(uint32_t keyId)`	`uint32_t` Obtén el ID de clave raíz del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetRootKeyNumber(uint32_t keyId)`	`uint8_t` Obtén el número de clave raíz del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.
`GetType(uint32_t keyId)`	`uint32_t` Obtiene el tipo de clave de Weave del ID de clave especificado.
`IncorporatesAppGroupMasterKey(uint32_t keyId)`	`bool` Determina si el ID de clave de grupo de aplicaciones especificado incorpora la clave principal del grupo.
`IncorporatesEpochKey(uint32_t keyId)`	`bool` Determina si el ID de clave de grupo de aplicaciones especificado incorpora la clave de época.
`IncorporatesRootKey(uint32_t keyId)`	`bool` Determina si el ID de clave de grupo de aplicaciones especificado incorpora la clave raíz.
`IsAppEpochKey(uint32_t keyId)`	`bool` Determina si el ID de clave especificado es de un tipo de clave de ciclo de vida de la 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áticas o rotativas).
`IsAppGroupMasterKey(uint32_t keyId)`	`bool` Determina si el ID de clave especificado es de un tipo de clave maestra del grupo de aplicaciones.
`IsAppRootKey(uint32_t keyId)`	`bool` Determina si el ID de clave especificado es de un tipo de clave raíz de la aplicación.
`IsAppRotatingKey(uint32_t keyId)`	`bool` Determina si el ID de clave especificado es de un tipo de rotación de la aplicación.
`IsAppStaticKey(uint32_t keyId)`	`bool` Determina si el ID de clave especificado es de un tipo estático de aplicación.
`IsGeneralKey(uint32_t keyId)`	`bool` Determina si el ID de clave especificado es de un tipo general.
`IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)`	`bool` Determina si un ID de clave determinado identifica una clave adecuada para la encriptación 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 una época en particular.
`IsSessionKey(uint32_t keyId)`	`bool` Determina 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` Construye un ID de 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` Construye el ID de clave intermedia de la aplicación con los ID de clave constituyentes.
`MakeAppKeyId(uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)`	`uint32_t` Construye el ID de clave de grupo de aplicaciones con ID de clave constituyentes y otra información.
`MakeAppRotatingKeyId(uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)`	`uint32_t` Crea el ID de clave rotativa de la aplicación según los ID de clave constituyentes y otra información.
`MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)`	`uint32_t` Crear el ID de clave estática de la aplicación según los ID de clave constituyentes.
`MakeEpochKeyId(uint8_t epochKeyNumber)`	`uint32_t` Construye el ID de clave raíz del grupo de aplicaciones dado el número de clave de ciclo de entrenamiento.
`MakeGeneralKeyId(uint16_t generalKeyNumber)`	`uint16_t` Construye un ID de clave general dado un número de clave general.
`MakeRootKeyId(uint8_t rootKeyNumber)`	`uint32_t` Construye el ID de la clave raíz del grupo de aplicaciones dado el número de clave raíz.
`MakeSessionKeyId(uint16_t sessionKeyNumber)`	`uint16_t` Construye el ID de la clave de sesión con el número de clave de la sesión.
`UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)`	`uint32_t` Actualiza el ID de la clave del grupo de aplicaciones con un número de clave de ciclo de entrenamiento nuevo.
`UsesCurrentEpochKey(uint32_t keyId)`	`bool` Determina si el ID de clave de grupo de aplicaciones especificado usa la clave de época "current"

Tipos públicos

@52

@52

Campos de ID de clave de Weave, marcas y tipos.

Properties
`kClientRootKey`	ID de clave raíz del cliente.
`kFabricRootKey`	ID de la clave raíz de Fabric.
`kFabricSecret`	ID del secreto de tejido.
`kKeyNumber_Max`	Valores máximos para los subcampos de ID de clave.
`kNone`	Tejimos los ID de clave global. ID de clave de Weave sin especificar.
`kServiceRootKey`	ID de clave raíz del servicio
`kType_AppEpochKey`	Tipo de clave de ciclo de vida 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`	Entrelaza los tipos de claves (excepto los tipos de encriptación de mensajes de Weave). Nota: Los 16 bits (de 32) más significativos de estos tipos no pueden ser todos ceros, ya que estos valores están reservados solo para las claves de encriptación de mensajes de Weave. Tipos de clave de grupo constituyente del tipo de clave de grupo de aplicaciones.
`kType_AppRotatingKey`	Tipo de clave que rota la aplicación.
`kType_AppStaticKey`	Tipo de clave estática de la aplicación.
`kType_General`	Tipo de clave general.
`kType_None`	Tipos de clave de Weave utilizados para la encriptación de mensajes de Weave. Nota: Los 16 bits (de 32) del tipo de clave de encriptación de mensajes más importantes deberían ser cero porque solo 16 bits del ID menos significativos están codificados en el mensaje de Weave.Weave no están encriptados.
`kType_Session`	Tipo de clave de sesión.

Funciones estáticas públicas

ID de ConvertToCurrentAppKey

uint32_t ConvertToCurrentAppKeyId(
  uint32_t keyId
)

Convierte 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 clave de aplicación.

Qué muestra

ID de clave actual de la aplicación.

IDDeConvertToStaticAppKey

uint32_t ConvertToStaticAppKeyId(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

ID de clave de aplicación.

Qué muestra

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

Describir clave

const char * DescribeKey(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Une el ID de clave para decodificar y para el que se mostrará una string descriptiva.

Qué muestra

Un puntero para una string terminada en NULL que describe el ID de clave especificado.

NúmeroDeLocalDeLaApp

uint8_t GetAppGroupLocalNumber(
  uint32_t keyId
)

Obtén el número local de grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

número local del grupo de aplicaciones.

ID del grupo GetAppGroupMasterKey

uint32_t GetAppGroupMasterKeyId(
  uint32_t keyId
)

Obtén el ID de la clave maestra del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

ID de clave maestra del grupo de aplicaciones.

ID del método getEpochKey

uint32_t GetEpochKeyId(
  uint32_t keyId
)

Obtén el ID de clave de ciclo de vida del grupo de aplicaciones que se usó para derivar la clave de aplicación especificada.

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

ID de clave de época.

Número de clave getEpoch

uint8_t GetEpochKeyNumber(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

número de clave de ciclo de entrenamiento.

ID de GetRootKey

uint32_t GetRootKeyId(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

ID de la clave raíz.

ObtenerRootKeyNumber

uint8_t GetRootKeyNumber(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

número de clave raíz.

Obtener tipo

uint32_t GetType(
  uint32_t keyId
)

Obtiene el tipo de clave de Weave del ID de clave especificado.

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

el tipo de ID de clave.

IncorporaAppAppMasterKey

bool IncorporatesAppGroupMasterKey(
  uint32_t keyId
)

Determina si el ID de clave de grupo de aplicaciones especificado incorpora la clave principal del grupo.

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

Verdadero si el keyId incorpora la clave maestra del grupo

Incorporación de clave clave

bool IncorporatesEpochKey(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

Verdadero si el keyId incorpora la clave de época.

IncorporaRootRoot

bool IncorporatesRootKey(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

Es verdadero si el keyId incorpora clave raíz.

Clave de clave de la aplicación

bool IsAppEpochKey(
  uint32_t keyId
)

Determina si el ID de clave especificado es de un tipo de clave de ciclo de vida de la aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

Es verdadero si el keyId de un tipo de clave de ciclo de vida de la 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áticas o rotativas).

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

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

IsAppGroupMasterKey

bool IsAppGroupMasterKey(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

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

IsAppRootKey.

bool IsAppRootKey(
  uint32_t keyId
)

Determina si el ID de clave especificado es de un tipo de clave raíz de la aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

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

IsAppRotatingKey

bool IsAppRotatingKey(
  uint32_t keyId
)

Determina si el ID de clave especificado es de un tipo de rotación de la aplicación.

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

Es verdadero si el keyId de un tipo de rotación de la aplicación.

IsAppStaticKey;

bool IsAppStaticKey(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

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

Clave general

bool IsGeneralKey(
  uint32_t keyId
)

Determina si el ID de clave especificado es de un tipo general.

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

Es verdadero si el keyId tiene un tipo General.

ID del mensaje de encriptación de mensajes

bool IsMessageEncryptionKeyId(
  uint32_t keyId,
  bool allowLogicalKeys
)

Determina si un ID de clave determinado identifica una clave adecuada para la encriptación de mensajes de Weave.

Detalles

Parámetros

`[in] keyId`	ID de clave de Weave.
`[in] allowLogicalKeys`	Especifica si los ID de claves lógicas (como la clave de rotación actual) se deben considerar adecuados para la encriptación de mensajes.

Qué muestra

Verdadero si se puede usar la clave identificada para encriptar 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 una época en particular.

Detalles

Parámetros

`[in] keyId1`	El primer ID de clave que se probará.
`[in] keyId2`	El segundo ID de clave que se probará.

Qué muestra

Se asigna el valor true si los ID de claves representan la misma clave.

Clave de sesión

bool IsSessionKey(
  uint32_t keyId
)

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

Detalles

Parámetros

[in] keyId

Identificador de clave de Weave.

Qué muestra

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

ID de clave válida

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 Weave.

Qué muestra

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

ID de clave de grupo de aplicación

uint32_t MakeAppGroupMasterKeyId(
  uint8_t appGroupLocalNumber
)

Construye un ID de 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.

Qué muestra

ID de clave maestra del grupo de aplicaciones.

ID de la clave intermedia de la aplicación

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

Construye el ID de clave intermedia de la aplicación con los ID de clave constituyentes.

Detalles

Parámetros

`[in] rootKeyId`	ID de clave raíz que se usa para derivar la clave intermedia de la aplicación.
`[in] epochKeyId`	ID de la clave de época usada para derivar la clave intermedia de la aplicación.
`[in] useCurrentEpochKey`	Función experimental booleana que indica si se debe derivar la clave usando una clave de época "actual&quot.

Qué muestra

ID de clave intermedia de la aplicación.

ID de clave de la aplicación

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

Construye el ID de clave de grupo de aplicaciones con ID de clave constituyentes y otra información.

Detalles

Parámetros

`[in] keyType`	Tipo de clave de grupo derivado.
`[in] rootKeyId`	ID de clave raíz que se usa para derivar la clave de grupo de aplicaciones.
`[in] epochKeyId`	ID de la clave de época usada para derivar la clave del grupo de aplicaciones.
`[in] appGroupMasterKeyId`	ID de la clave maestra del grupo de aplicaciones que se usa para derivar la clave del grupo de aplicaciones.
`[in] useCurrentEpochKey`	Función experimental booleana que indica si se debe derivar la clave usando una clave de época "actual&quot.

Qué muestra

ID de clave de grupo de aplicaciones.

ID de clave de la aplicación de Make

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

Crea el ID de clave rotativa de la aplicación según los ID de clave constituyentes y otra información.

Detalles

Parámetros

`[in] rootKeyId`	ID de clave raíz que se usa para derivar la clave rotativa de la aplicación.
`[in] epochKeyId`	ID de la clave de época usada para derivar la clave rotativa de la aplicación.
`[in] appGroupMasterKeyId`	ID de la clave maestra del grupo de aplicaciones que se usa para derivar la clave rotativa de la aplicación.
`[in] useCurrentEpochKey`	Función experimental booleana que indica si se debe derivar la clave usando una clave de época "actual&quot.

Qué muestra

ID de clave rotativa de la aplicación.

ID de clave de la aplicación de Make

uint32_t MakeAppStaticKeyId(
  uint32_t rootKeyId,
  uint32_t appGroupMasterKeyId
)

Crear el ID de clave estática de la aplicación según los ID de clave constituyentes.

Detalles

Parámetros

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

Qué muestra

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

ID de clave de posépoca

uint32_t MakeEpochKeyId(
  uint8_t epochKeyNumber
)

Construye el ID de clave raíz del grupo de aplicaciones dado el número de clave de ciclo de entrenamiento.

Detalles

Parámetros

[in] epochKeyNumber

Número de clave de ciclo.

Qué muestra

ID de clave de época.

ID de clave general

uint16_t MakeGeneralKeyId(
  uint16_t generalKeyNumber
)

Construye un ID de clave general dado un número de clave general.

Detalles

Parámetros

[in] generalKeyNumber

Es el número de clave general.

Qué muestra

ID de clave general.

ID de clave de raíz

uint32_t MakeRootKeyId(
  uint8_t rootKeyNumber
)

Construye el ID de la 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.

Qué muestra

ID de la clave raíz.

ID de clave de sesión

uint16_t MakeSessionKeyId(
  uint16_t sessionKeyNumber
)

Construye el ID de la clave de sesión con el número de clave de la sesión.

Detalles

Parámetros

[in] sessionKeyNumber

Es el número de la clave de sesión.

Qué muestra

ID de clave de sesión.

ID de clave de actualización

uint32_t UpdateEpochKeyId(
  uint32_t keyId,
  uint32_t epochKeyId
)

Actualiza el ID de la clave del grupo de aplicaciones con un número de clave de ciclo de entrenamiento nuevo.

Detalles

Parámetros

`[in] keyId`	ID de clave de aplicación.
`[in] epochKeyId`	ID de clave de época, que se utilizará para construir el ID de clave de aplicación actualizado.

Qué muestra

ID de clave de aplicación.

UsaLa clave de momento actual

bool UsesCurrentEpochKey(
  uint32_t keyId
)

Determina si el ID de clave de grupo de aplicaciones especificado usa la clave de época "current"

Detalles

Parámetros

[in] keyId

Tejimos el identificador de clave de grupo de aplicaciones.

Qué muestra

Es verdadero si el ID de clave indica el uso de la clave de ciclo de entrenamiento actual.