nl:: Weave:: Profiles:: Security:: CertProvisioning:: WeaveCertProvEngine
#include <src/lib/profiles/security/WeaveCertProvisioning.h>
Implementa a lógica principal do objeto de protocolo de provisionamento de certificado do Weave.
Resumo
Construtores e destruidores |
|
---|---|
WeaveCertProvEngine(void)
|
Tipos públicos |
|
---|---|
@246{
|
enum |
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
Essa função é o callback do aplicativo invocado nos eventos da API Certificate Provisioning Engine. |
EventType{
|
enum |
State{
|
enum |
Atributos públicos |
|
---|---|
AppState
|
void *
Um ponteiro para dados específicos do aplicativo.
|
Funções públicas |
|
---|---|
AbortCertificateProvisioning(void)
|
void
Interrompe qualquer troca GetCertificate em andamento.
|
GenerateGetCertificateRequest(PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest)
|
Gerar uma mensagem GetCertificateRequest.
|
GetBinding(void) const
|
Binding *
Retorna um ponteiro para o objeto Binding associado ao WeaveCertProvEngine.
|
GetEventCallback(void) const
|
Retorna um ponteiro para a função de callback do evento da API atualmente configurada no objeto WeaveCertProvEngine.
|
GetMfrAttestDelegate(void) const
|
Retorna um ponteiro para o objeto delegado de atestado do fabricante configurado atualmente no objeto WeaveCertProvEngine.
|
GetOpAuthDelegate(void) const
|
Retorna um ponteiro para o objeto delegado de autenticação operacional atualmente configurado no objeto WeaveCertProvEngine.
|
GetReqType(void) const
|
uint8_t
Recupera o tipo de solicitação atual.
|
GetState(void) const
|
Recupere o estado atual do objeto WeaveCertProvEngine.
|
Init(Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState)
|
Inicialize um objeto WeaveCertProvEngine em preparação para o envio da mensagem de solicitação de recebimento de certificado.
|
ProcessGetCertificateResponse(PacketBuffer *msgBuf)
|
Processar a mensagem GetCertificateResponse.
|
SetBinding(Binding *binding)
|
void
Define o objeto de vinculação no objeto WeaveCertProvEngine.
|
SetEventCallback(EventCallback eventCallback)
|
void
Define a função de retorno de chamada do evento da API no objeto WeaveCertProvEngine.
|
SetMfrAttestDelegate(WeaveNodeMfrAttestDelegate *mfrAttestDelegate)
|
void
Define o objeto delegado de atestado do fabricante no objeto WeaveCertProvEngine.
|
SetOpAuthDelegate(WeaveNodeOpAuthDelegate *opAuthDelegate)
|
void
Define o objeto delegado da autenticação operacional no objeto WeaveCertProvEngine.
|
Shutdown(void)
|
void
Encerra um objeto WeaveCertProvEngine inicializado anteriormente.
|
StartCertificateProvisioning(uint8_t reqType, bool doMfrAttest)
|
Iniciar protocolo de provisionamento de certificado.
|
Estruturas |
|
---|---|
nl:: |
Parâmetros de entrada para o evento da API Weave Certificate Provisioning. |
nl:: |
Parâmetros de saída para o evento da API Weave Certificate Provisioning. |
Tipos públicos
@246
@246
Propriedades | |
---|---|
kReqType_GetInitialOpDeviceCert
|
O tipo de solicitação "Receber certificado" serve para obter o certificado operacional inicial. |
kReqType_RotateOpDeviceCert
|
O tipo de solicitação "Receber certificado" é para alternar o certificado operacional atual. |
EventCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Essa função é o callback do aplicativo invocado nos eventos da API Certificate Provisioning Engine.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
EventType
EventType
Propriedades | |
---|---|
kEvent_CommunicationError
|
Ocorreu um erro de comunicação ao enviar um GetCertificateRequest ou aguardar uma resposta. |
kEvent_PrepareAuthorizeInfo
|
O aplicativo é solicitado a preparar o payload para GetCertificateRequest. |
kEvent_ResponseReceived
|
Uma mensagem GetCertificateResponse foi recebida do terminal. |
Estado
State
Propriedades | |
---|---|
kState_Idle
|
O objeto do mecanismo está inativo. |
kState_NotInitialized
|
O objeto do mecanismo não foi inicializado. |
kState_PreparingBinding
|
O objeto do mecanismo está aguardando a vinculação ficar pronta. |
kState_RequestInProgress
|
Uma mensagem GetCertificateRequest foi enviada e o objeto do mecanismo está aguardando uma resposta. |
Atributos públicos
AppState
void * AppState
Um ponteiro para dados específicos do aplicativo.
Funções públicas
AbortCertificateProvisioning
void AbortCertificateProvisioning( void )
Interrompe qualquer troca GetCertificate em andamento.
GenerateGetCertificateRequest
WEAVE_ERROR GenerateGetCertificateRequest( PacketBuffer *msgBuf, uint8_t reqType, bool doMfrAttest )
Gerar uma mensagem GetCertificateRequest.
Esse método gera a estrutura GetCertificateRequest do Weave codificada no formato TLV do Weave.
Ao formar a mensagem GetCertificateRequest, o método faz uma solicitação ao aplicativo usando as funções WeaveNodeOpAuthDelegate e WeaveNodeMfrAttestDelegate e o evento da API PrepareAuthorizeInfo para preparar o payload da mensagem.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
GetBinding
Binding * GetBinding( void ) const
Retorna um ponteiro para o objeto Binding associado ao WeaveCertProvEngine.
GetEventCallback
EventCallback GetEventCallback( void ) const
Retorna um ponteiro para a função de callback do evento da API atualmente configurada no objeto WeaveCertProvEngine.
GetMfrAttestDelegate
WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate( void ) const
Retorna um ponteiro para o objeto delegado de atestado do fabricante configurado atualmente no objeto WeaveCertProvEngine.
GetOpAuthDelegate
WeaveNodeOpAuthDelegate * GetOpAuthDelegate( void ) const
Retorna um ponteiro para o objeto delegado de autenticação operacional atualmente configurado no objeto WeaveCertProvEngine.
GetReqType
uint8_t GetReqType( void ) const
Recupera o tipo de solicitação atual.
Init
WEAVE_ERROR Init( Binding *binding, WeaveNodeOpAuthDelegate *opAuthDelegate, WeaveNodeMfrAttestDelegate *mfrAttestDelegate, EventCallback eventCallback, void *appState )
Inicialize um objeto WeaveCertProvEngine em preparação para o envio da mensagem de solicitação de recebimento de certificado.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
ProcessGetCertificateResponse
WEAVE_ERROR ProcessGetCertificateResponse( PacketBuffer *msgBuf )
Processar a mensagem GetCertificateResponse.
Esse método processa a estrutura Weave GetCertificateResponse codificada no formato TLV do Weave.
Quando o processamento da mensagem GetCertificateResponse é concluído com êxito, o método faz uma chamada para o aplicativo, por meio do evento da API ResponseReceived, para entregar o resultado.
Se o processamento da mensagem GetCertificateResponse falhar, o método fará uma chamada ao aplicativo, por meio do evento da API CommunicationError, para relatar o erro.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Valores de retorno |
|
SetBinding
void SetBinding( Binding *binding )
Define o objeto de vinculação no objeto WeaveCertProvEngine.
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
Define a função de retorno de chamada do evento da API no objeto WeaveCertProvEngine.
SetMfrAttestDelegate
void SetMfrAttestDelegate( WeaveNodeMfrAttestDelegate *mfrAttestDelegate )
Define o objeto delegado de atestado do fabricante no objeto WeaveCertProvEngine.
SetOpAuthDelegate
void SetOpAuthDelegate( WeaveNodeOpAuthDelegate *opAuthDelegate )
Define o objeto delegado da autenticação operacional no objeto WeaveCertProvEngine.
Encerramento
void Shutdown( void )
Encerra um objeto WeaveCertProvEngine inicializado anteriormente.
Observe que esse método só poderá ser chamado se o método Init() já tiver sido chamado anteriormente.
StartCertificateProvisioning
WEAVE_ERROR StartCertificateProvisioning( uint8_t reqType, bool doMfrAttest )
Iniciar protocolo de provisionamento de certificado.
Esse método inicia o processo de envio de uma mensagem GetCertificateRequest ao serviço da CA. Se e quando uma mensagem GetCertificateResponse correspondente for recebida, ela será entregue ao aplicativo por meio do evento da API ResponseReceived.
Se o objeto Binding não estiver no estado Ready quando esse método for chamado, uma solicitação será feita ao método Binding::RequestPrepare() para iniciar a preparação sob demanda. A operação de solicitação ficará aguardando até que o processo seja concluído. Qualquer chamada para StartCertificateProvisioning() enquanto houver uma solicitação anterior em andamento será ignorada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
WeaveCertProvEngine
WeaveCertProvEngine( void )