nl :: Tejido:: Perfiles: Seguridad:: Aprovisionamiento de certificados :: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
Implementa la lógica central del objeto de protocolo Weave Certificate Provisioning.
Resumen
Constructores y Destructores | |
---|---|
WeaveCertProvEngine (void) |
Tipos públicos | |
---|---|
@246 { | enumeración |
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 del motor de aprovisionamiento de certificados. |
EventType { | enumeración |
State { | enumeración |
Atributos públicos | |
---|---|
AppState | void * Un puntero a datos específicos de la aplicación. |
Funciones publicas | |
---|---|
AbortCertificateProvisioning (void) | void Detiene cualquier intercambio de GetCertificate en curso. |
GenerateGetCertificateRequest ( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest) | Genere el mensaje GetCertificateRequest. |
GetBinding (void) const | Binding * Devuelve un puntero al objeto Binding asociado con WeaveCertProvEngine . |
GetEventCallback (void) const | Devuelve un puntero a la función de devolución de llamada de eventos de API configurada actualmente en el objeto WeaveCertProvEngine . |
GetMfrAttestDelegate (void) const | Devuelve un puntero al objeto delegado de certificación del fabricante configurado actualmente en el objeto WeaveCertProvEngine . |
GetOpAuthDelegate (void) const | Devuelve 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 | Recupere el estado actual del objeto WeaveCertProvEngine . |
Init ( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState) | Inicialice un objeto WeaveCertProvEngine en preparación para enviar un mensaje de solicitud de obtención de certificado. |
ProcessGetCertificateResponse ( PacketBuffer *msgBuf) | Procesar el mensaje GetCertificateResponse. |
SetBinding ( Binding *binding) | void Establece el objeto de enlace en el objeto WeaveCertProvEngine . |
SetEventCallback ( EventCallback eventCallback) | void Establece la función de devolución de llamada de eventos de API en el objeto WeaveCertProvEngine . |
SetMfrAttestDelegate ( WeaveNodeMfrAttestDelegate *mfrAttestDelegate) | void Establece el objeto delegado de certificación del fabricante en el objeto WeaveCertProvEngine . |
SetOpAuthDelegate ( WeaveNodeOpAuthDelegate *opAuthDelegate) | void Establece el objeto delegado de autenticación operativa en el objeto WeaveCertProvEngine . |
Shutdown (void) | void Apague un objeto WeaveCertProvEngine previamente inicializado. |
StartCertificateProvisioning (uint8_t reqType, bool doMfrAttest) | Inicie el Protocolo de aprovisionamiento de certificados. |
Estructuras | |
---|---|
nl :: Weave :: Perfiles :: Seguridad :: CertProvisioning :: WeaveCertProvEngine :: InEventParam | Introduzca parámetros para el evento de la API de aprovisionamiento de certificados de Weave. |
nl :: Weave :: Perfiles :: Seguridad :: Aprovisionamiento de certificados :: WeaveCertProvEngine :: OutEventParam | Parámetros de salida para el evento de la API de aprovisionamiento de certificados de Weave. |
Tipos públicos
@ 246
@246
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 del motor de aprovisionamiento de certificados.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
Tipo de evento
EventType
Expresar
State
Atributos públicos
AppState
void * AppState
Un puntero a datos específicos de la aplicación.
Funciones publicas
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
Detiene cualquier intercambio de GetCertificate en curso.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
Genere el mensaje GetCertificateRequest.
Este método genera la estructura Weave GetCertificateRequest codificada en el formato Weave TLV .
Al formar el mensaje GetCertificateRequest, el método realiza una solicitud a la aplicación, a través de las funciones WeaveNodeOpAuthDelegate y WeaveNodeMfrAttestDelegate y el evento API PrepareAuthorizeInfo, para preparar la carga útil del mensaje.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
GetBinding
Binding * GetBinding( void ) const
Devuelve un puntero al objeto Binding asociado con WeaveCertProvEngine .
GetEventCallback
EventCallback GetEventCallback( void ) const
Devuelve un puntero a la función de devolución de llamada de eventos de API configurada actualmente en el objeto WeaveCertProvEngine .
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
Devuelve un puntero al objeto delegado de certificación del fabricante configurado actualmente en el objeto WeaveCertProvEngine .
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
Devuelve 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.
En eso
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
Inicialice un objeto WeaveCertProvEngine en preparación para enviar un mensaje de solicitud de obtención de certificado.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
Procesar el mensaje GetCertificateResponse.
Este método procesa la estructura Weave GetCertificateResponse codificada en el formato Weave TLV .
Cuando el procesamiento del mensaje GetCertificateResponse se completa con éxito, el método realiza una llamada a la aplicación, a través del evento de API ResponseReceived, para entregar el resultado.
Si el procesamiento del mensaje GetCertificateResponse falla, el método realiza una llamada a la aplicación, a través del evento de API CommunicationError, para informar el error.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Valores devueltos |
|
SetBinding
void SetBinding( Binding *binding )
Establece el objeto de enlace en el objeto WeaveCertProvEngine .
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Establece la función de devolución de llamada de eventos de API en el objeto WeaveCertProvEngine .
SetMfrAttestDelegate
void SetMfrAttestDelegate( WeaveNodeMfrAttestDelegate *mfrAttestDelegate )
Establece el objeto delegado de certificación del fabricante en el objeto WeaveCertProvEngine .
SetOpAuthDelegate
void SetOpAuthDelegate( WeaveNodeOpAuthDelegate *opAuthDelegate )
Establece el objeto delegado de autenticación operativa en el objeto WeaveCertProvEngine .
Cerrar
void Shutdown( void )
Apague un objeto WeaveCertProvEngine previamente inicializado.
Tenga en cuenta que este método solo se puede llamar si se ha llamado previamente al método Init () .
StartCertificateProvisioning
WEAVE_ERROR StartCertificateProvisioning( uint8_t reqType, bool doMfrAttest )
Inicie el Protocolo de aprovisionamiento de certificados.
Este método inicia el proceso de envío de un mensaje GetCertificateRequest al servicio de CA. Si se recibe un mensaje GetCertificateResponse correspondiente, se enviará a la aplicación a través del evento de API ResponseReceived.
Si el objeto Binding no está en el estado Listo cuando se llama a este método, se realizará una solicitud al método Binding :: RequestPrepare () para iniciar la preparación bajo demanda. La operación de solicitud estará esperando hasta que se complete este proceso. Se ignorará cualquier llamada a StartCertificateProvisioning () mientras haya una solicitud anterior en proceso.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )