nl::Weave::Profiles::Security::CASE::WeaveCASEAuthDelegate

Esta es una clase abstracta.

#include <src/lib/profiles/security/WeaveCASE.h>

Interfaz abstracta a la que se delegan las acciones de autenticación durante el establecimiento de la sesión CASE.

Resumen

Herencia

Subclases directamente conocidas: nl::Weave::DeviceManager::WeaveDeviceManager

Funciones públicas

BeginValidation(const BeginSessionContext & msgCtx, ValidationContext & validCtx, WeaveCertificateSet & certSet)=0
virtual WEAVE_ERROR
Se llama al inicio de la validación del certificado.
EncodeNodeCertInfo(const BeginSessionContext & msgCtx, TLVWriter & writer)=0
virtual WEAVE_ERROR
Codifica la información de certificado CASE para el nodo local.
EncodeNodePayload(const BeginSessionContext & msgCtx, uint8_t *payloadBuf, uint16_t payloadBufSize, uint16_t & payloadLen)
virtual WEAVE_ERROR
Codifica una carga útil específica de la aplicación para que se incluya en el mensaje CASE del par.
EndValidation(const BeginSessionContext & msgCtx, ValidationContext & validCtx, WeaveCertificateSet & certSet)=0
virtual void
Se llama al final de la validación del certificado.
GenerateNodeSignature(const BeginSessionContext & msgCtx, const uint8_t *msgHash, uint8_t msgHashLen, TLVWriter & writer, uint64_t tag)=0
virtual WEAVE_ERROR
Genera una firma con la clave privada del nodo local.
HandleValidationResult(const BeginSessionContext & msgCtx, ValidationContext & validCtx, WeaveCertificateSet & certSet, WEAVE_ERROR & validRes)=0
virtual WEAVE_ERROR
Se llama con el resultado de la validación del certificado.
OnPeerCertsLoaded(const BeginSessionContext & msgCtx, WeaveDN & subjectDN, CertificateKeyId & subjectKeyId, ValidationContext & validCtx, WeaveCertificateSet & certSet)
virtual WEAVE_ERROR
Se llama después de que se cargan los certificados del par.

Funciones públicas

BeginValidation

virtual WEAVE_ERROR BeginValidation(
  const BeginSessionContext & msgCtx,
  ValidationContext & validCtx,
  WeaveCertificateSet & certSet
)=0

Se llama al inicio de la validación del certificado.

Las implementaciones deben inicializar el objeto WeaveCertificateSet proporcionado con los recursos suficientes para controlar la próxima validación del certificado. En este momento, las implementaciones pueden cargar certificados raíz o de AC de confianza en el conjunto de certificados, o esperar hasta que se llame a OnPeerCertsLoaded().

A cada certificado cargado en el conjunto de certificados se le asignará un tipo de certificado predeterminado por la función de carga. Las implementaciones deben ajustar estos tipos según sea necesario para garantizar el tratamiento correcto del certificado durante la validación y la asignación correcta de WeaveAuthMode para las interacciones CASE.

El contexto de validación proporcionado se inicializará con un conjunto de criterios de validación predeterminados, los cuales la implementación puede modificar según sea necesario. La implementación debe establecer el campo EffectiveTime o establecer las marcas de validación adecuadas para suprimir la validación del ciclo de vida del certificado.

Si deseas obtener resultados de validación detallados, la implementación puede inicializar los campos CertValidationResults y CertValidationLen.

Las implementaciones deben mantener los recursos asignados durante BeginValidation() hasta que se llame a la función EndValidation() correspondiente. Las implementaciones garantizan que se llamará a EndValidation() exactamente una vez por cada llamada exitosa a BeginValidation().

EncodeNodeCertInfo

virtual WEAVE_ERROR EncodeNodeCertInfo(
  const BeginSessionContext & msgCtx,
  TLVWriter & writer
)=0

Codifica la información de certificado CASE para el nodo local.

Las implementaciones pueden usar esta llamada para anular la codificación predeterminada de la estructura CertificateInformation CASE del nodo local. Cuando se la llame, la implementación debería escribir una estructura CertificateInformation que contenga, como mínimo, el certificado de entidad del nodo local. De manera opcional, la implementación puede incluir un conjunto de anclas de confianza o certificados relacionados.

EncodeNodePayload

virtual WEAVE_ERROR EncodeNodePayload(
  const BeginSessionContext & msgCtx,
  uint8_t *payloadBuf,
  uint16_t payloadBufSize,
  uint16_t & payloadLen
)

Codifica una carga útil específica de la aplicación para que se incluya en el mensaje CASE del par.

Implementar este método es opcional. La implementación predeterminada muestra una carga útil de longitud cero.

EndValidation

virtual void EndValidation(
  const BeginSessionContext & msgCtx,
  ValidationContext & validCtx,
  WeaveCertificateSet & certSet
)=0

Se llama al final de la validación del certificado.

Las implementaciones pueden usar esta llamada para realizar la limpieza después de que se complete la validación de la certificación. Las implementaciones garantizan que se llamará a EndValidation() exactamente una vez por cada llamada exitosa a BeginValidation().

GenerateNodeSignature

virtual WEAVE_ERROR GenerateNodeSignature(
  const BeginSessionContext & msgCtx,
  const uint8_t *msgHash,
  uint8_t msgHashLen,
  TLVWriter & writer,
  uint64_t tag
)=0

Genera una firma con la clave privada del nodo local.

Cuando se invocan, las implementaciones deben procesar una firma en el valor de hash dado mediante la clave privada del nodo. La firma generada se debe escribir en la forma de una estructura ECDSASignature CASE en la escritura del TLV proporcionado con la etiqueta especificada.

En los casos en que la clave privada del nodo se guarda en un búfer local, la función de utilidad GenerateAndEncodeWeaveECDSASignature() puede ser útil para implementar este método.

HandleValidationResult

virtual WEAVE_ERROR HandleValidationResult(
  const BeginSessionContext & msgCtx,
  ValidationContext & validCtx,
  WeaveCertificateSet & certSet,
  WEAVE_ERROR & validRes
)=0

Se llama con el resultado de la validación del certificado.

Las implementaciones pueden usar esta llamada para inspeccionar y posiblemente modificar el resultado de la validación del certificado del par. Si la validación se realiza correctamente, validRes se establecerá en WEAVE_NO_ERROR. En este caso, el contexto de validación contendrá detalles sobre el resultado. En particular, el campo TrustAnchor se establecerá como el certificado de ancla de confianza.

Si la implementación inicializó los campos CertValidationResults y CertValidationLen dentro de la estructura ValidationContext durante la llamada a BeginValidation(), estos campos contendrán resultados de validación detallados para cada certificado del conjunto de certificados.

Las implementaciones pueden anular esto configurando validRes en un valor de error, lo que provoca que la validación falle.

Si la validación falla, validRes reflejará el motivo de la falla. Las implementaciones pueden anular el resultado con un valor de error diferente, pero NO DEBEN establecer el resultado en WEAVE_NO_ERROR.

OnPeerCertsLoaded

virtual WEAVE_ERROR OnPeerCertsLoaded(
  const BeginSessionContext & msgCtx,
  WeaveDN & subjectDN,
  CertificateKeyId & subjectKeyId,
  ValidationContext & validCtx,
  WeaveCertificateSet & certSet
)

Se llama después de que se cargan los certificados del par.

Las implementaciones pueden usar esta llamada para finalizar los certificados de entrada y los criterios de validación que se usarán para realizar la validación del certificado del par. En el momento de la llamada, los certificados que proporciona el par se cargarán en el conjunto de certificados (incluido su propio certificado, si está presente). Además, los argumentos subjectDN y subjectKeyId se inicializaron en valores que se usarán para resolver el certificado del par a partir del conjunto de certificados. Si el par proporcionó su propio certificado (en lugar de una referencia de certificado), el campo EntityCert dentro del argumento validCtx contendrá un puntero a ese certificado.

Durante esta llamada, las implementaciones pueden modificar el contenido del conjunto de certificados, incluida la adición de certificados nuevos. También pueden modificar los argumentos subjectDN, subjectKeyId o validCtx según sea necesario. Lo más importante es que las implementaciones deben ajustar los campos de tipo de certificado con el certificado establecido antes de regresar para garantizar el tratamiento correcto de los certificados durante la validación y las verificaciones de control de acceso posteriores.

NOTA: En el caso de que el par proporcione una referencia de certificado para sí mismo, en lugar de un certificado completo, el campo EntityCert en el contexto de validación contendrá un valor NULL. Si una implementación desea admitir referencias de certificados, debe agregar un certificado que coincida con el ID de clave y el DN de asunto del par con el conjunto de certificados antes de regresar.

Implementar este método es opcional. La implementación predeterminada no hace nada.