nl:: Weave:: Profiles:: Security:: CertProvisioning:: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
Implementa la lógica central del objeto de protocolo de aprovisionamiento de certificados de Weave.
Resumen
Constructores y destructores |
|
---|---|
WeaveCertProvEngine(void)
|
Tipos públicos |
|
---|---|
@246{
|
enum |
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
Esta función es la devolución de llamada de la aplicación que se invoca en los eventos de la API de Certificate Provisioning Engine. |
EventType{
|
enum |
State{
|
enum |
Atributos públicos |
|
---|---|
AppState
|
void *
Un puntero para datos específicos de la aplicación.
|
Funciones públicas |
|
---|---|
AbortCertificateProvisioning(void)
|
void
Detiene cualquier intercambio de GetCertificate en curso.
|
GenerateGetCertificateRequest(PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest)
|
Genera el mensaje GetCertificateRequest.
|
GetBinding(void) const
|
Binding *
Muestra un puntero al objeto Binding asociado con WeaveCertProvEngine.
|
GetEventCallback(void) const
|
Muestra un puntero a la función de devolución de llamada del evento de la API configurada actualmente en el objeto WeaveCertProvEngine.
|
GetMfrAttestDelegate(void) const
|
Muestra un puntero para el objeto delegado de certificación del fabricante configurado actualmente en el objeto WeaveCertProvEngine.
|
GetOpAuthDelegate(void) const
|
Muestra un puntero al objeto delegado de autenticación operativa configurado actualmente en el objeto WeaveCertProvEngine.
|
GetReqType(void) const
|
uint8_t
Recupera el tipo de solicitud actual.
|
GetState(void) const
|
Recupera el estado actual del objeto WeaveCertProvEngine.
|
Init(Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState)
|
Inicializa un objeto WeaveCertProvEngine a fin de prepararte para enviar un mensaje de solicitud de certificado.
|
ProcessGetCertificateResponse(PacketBuffer *msgBuf)
|
Se procesó el mensaje GetCertificateResponse.
|
SetBinding(Binding *binding)
|
void
Configura el objeto de vinculación en el objeto WeaveCertProvEngine.
|
SetEventCallback(EventCallback eventCallback)
|
void
Configura la función de devolución de llamada del evento de la API en el objeto WeaveCertProvEngine.
|
SetMfrAttestDelegate(WeaveNodeMfrAttestDelegate *mfrAttestDelegate)
|
void
Configura el objeto delegado de certificación del fabricante en el objeto WeaveCertProvEngine.
|
SetOpAuthDelegate(WeaveNodeOpAuthDelegate *opAuthDelegate)
|
void
Configura el objeto delegado de autenticación operativa en el objeto WeaveCertProvEngine.
|
Shutdown(void)
|
void
Cierra un objeto WeaveCertProvEngine inicializado con anterioridad.
|
StartCertificateProvisioning(uint8_t reqType, bool doMfrAttest)
|
Inicia el protocolo de aprovisionamiento de certificados.
|
Structs |
|
---|---|
nl:: |
Parámetros de entrada para el evento de la API de aprovisionamiento de certificados de Weave. |
nl:: |
Parámetros de salida para el evento de la API de aprovisionamiento de certificados de Weave. |
Tipos públicos
@246
@246
Propiedades | |
---|---|
kReqType_GetInitialOpDeviceCert
|
El tipo de solicitud Get Certificate es obtener el certificado operativo inicial. |
kReqType_RotateOpDeviceCert
|
El tipo de solicitud Obtener certificado es rotar el certificado operativo actual. |
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Esta función es la devolución de llamada de la aplicación que se invoca en los eventos de la API de Certificate Provisioning Engine.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
EventType
EventType
Propiedades | |
---|---|
kEvent_CommunicationError
|
Se produjo un error de comunicación mientras se enviaba un GetCertificateRequest o mientras se esperaba una respuesta. |
kEvent_PrepareAuthorizeInfo
|
Se solicita a la aplicación que prepare la carga útil para GetCertificateRequest. |
kEvent_ResponseReceived
|
Se recibió un mensaje GetCertificateResponse del par. |
Estado
State
Propiedades | |
---|---|
kState_Idle
|
El objeto del motor está inactivo. |
kState_NotInitialized
|
No se inicializó el objeto del motor. |
kState_PreparingBinding
|
El objeto del motor está esperando que la vinculación esté lista. |
kState_RequestInProgress
|
Se envió un mensaje GetCertificateRequest y el objeto del motor está esperando una respuesta. |
Atributos públicos
AppState
void * AppState
Un puntero para datos específicos de la aplicación.
Funciones públicas
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
Detiene cualquier intercambio de GetCertificate en curso.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
Genera el mensaje GetCertificateRequest.
Este método genera la estructura GetCertificateRequest de Weave codificada en el formato TLV de Weave.
Cuando se forma el mensaje GetCertificateRequest, el método envía una solicitud a la aplicación mediante las funciones WeaveNodeOpAuthDelegate y WeaveNodeMfrAttestDelegate y el evento de la API PrepareAuthorizeInfo, a fin de preparar la carga útil del mensaje.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores que se muestran |
|
GetBinding
Binding * GetBinding( void ) const
Muestra un puntero al objeto Binding asociado con WeaveCertProvEngine.
GetEventCallback
EventCallback GetEventCallback( void ) const
Muestra un puntero a la función de devolución de llamada del evento de la API configurada actualmente en el objeto WeaveCertProvEngine.
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
Muestra un puntero para el objeto delegado de certificación del fabricante configurado actualmente en el objeto WeaveCertProvEngine.
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
Muestra un puntero al objeto delegado de autenticación operativa configurado actualmente en el objeto WeaveCertProvEngine.
GetReqType
uint8_t GetReqType( void ) const
Recupera el tipo de solicitud actual.
Init
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
Inicializa un objeto WeaveCertProvEngine a fin de prepararte para enviar un mensaje de solicitud de certificado.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
Se procesó el mensaje GetCertificateResponse.
Este método procesa la estructura GetCertificateResponse de Weave codificada en el formato TLV de Weave.
Cuando el procesamiento del mensaje GetCertificateResponse se completa correctamente, el método realiza una llamada a la aplicación, a través del evento de la API ResponseReceived, para entregar el resultado.
Si falla el procesamiento del mensaje GetCertificateResponse, el método realiza una llamada a la aplicación mediante el evento de la API de CommunicationError para informar el error.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Valores que se muestran |
|
SetBinding
void SetBinding( Binding *binding )
Configura el objeto de vinculación en el objeto WeaveCertProvEngine.
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Configura la función de devolución de llamada del evento de la API en el objeto WeaveCertProvEngine.
SetMfrAttestDelegate
void SetMfrAttestDelegate( WeaveNodeMfrAttestDelegate *mfrAttestDelegate )
Configura el objeto delegado de certificación del fabricante en el objeto WeaveCertProvEngine.
SetOpAuthDelegate
void SetOpAuthDelegate( WeaveNodeOpAuthDelegate *opAuthDelegate )
Configura el objeto delegado de autenticación operativa en el objeto WeaveCertProvEngine.
Cierre
void Shutdown( void )
Cierra un objeto WeaveCertProvEngine inicializado con anterioridad.
Ten en cuenta que solo se puede llamar a este método si se llamó al método Init() anteriormente.
StartCertificateProvisioning
WEAVE_ERROR StartCertificateProvisioning( uint8_t reqType, bool doMfrAttest )
Inicia el protocolo de aprovisionamiento de certificados.
Este método inicia el proceso de enviar un mensaje GetCertificateRequest al servicio de CA. Si se recibe el mensaje GetCertificateResponse correspondiente, se enviará a la aplicación a través del evento de la API ResponseReceived.
Si el objeto Binding no está en estado Listo cuando se llama a este método, se realizará una solicitud al método Binding::RequestPrepare() para iniciar la preparación a pedido. La operación de solicitud estará esperando hasta que se complete este proceso. Se ignorarán todas las llamadas a StartCertificateProvisioning() que haya una solicitud previa en proceso.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores que se muestran |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )