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{
  kReqType_GetInitialOpDeviceCert = 0,
  kReqType_RotateOpDeviceCert = 1
} 		enum
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
Essa função é o callback do aplicativo invocado nos eventos da API Certificate Provisioning Engine.
EventType{
  kEvent_PrepareAuthorizeInfo = 1,
  kEvent_ResponseReceived = 2,
  kEvent_CommunicationError = 3
} 		enum
State{
  kState_NotInitialized = 0,
  kState_Idle = 1,
  kState_PreparingBinding = 2,
  kState_RequestInProgress = 3
} 		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)
Gera a mensagem GetCertificateRequest.
GetBinding(void) const
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 de delegação de atestado do fabricante configurado 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)
Processa 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 callback de evento da API no objeto WeaveCertProvEngine.
SetMfrAttestDelegate(WeaveNodeMfrAttestDelegate *mfrAttestDelegate)
void
Define o objeto de delegação 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
Desligue um objeto WeaveCertProvEngine previamente inicializado.
StartCertificateProvisioning(uint8_t reqType, bool doMfrAttest)
Iniciar protocolo de provisionamento de certificado.

Estruturas
nl::Weave::Profiles::Security::CertProvisioning::WeaveCertProvEngine::InEventParam

Parâmetros de entrada para o evento da API Weave Certificate Provisioning.

nl::Weave::Profiles::Security::CertProvisioning::WeaveCertProvEngine::OutEventParam

Enviar parâmetros para o evento da API Weave Certificate Provisioning.

Tipos públicos

@246

 @246
Propriedades
kReqType_GetInitialOpDeviceCert

O tipo de solicitação "Get Certificate" é para receber o certificado operacional inicial.

kReqType_RotateOpDeviceCert

O tipo de solicitação "Get Certificate" é 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 que é invocado nos eventos da API Certificate Provisioning Engine.

Detalhes
Parâmetros
[in] appState
Um ponteiro para informações de estado definidas pelo aplicativo associadas ao objeto do mecanismo.
[in] eventType
ID do evento transmitido pelo callback do evento.
[in] inParam
Referência dos parâmetros do evento de entrada transmitidos pelo callback do evento.
[in] outParam
Referência dos parâmetros do evento de saída transmitidos pelo callback do evento.

EventType

 EventType
Propriedades
kEvent_CommunicationError

Ocorreu um erro de comunicação ao enviar uma GetCertificateRequest ou ao 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á ocioso.

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 de GetCertificate em andamento.

GenerateGetCertificateRequest

WEAVE_ERROR GenerateGetCertificateRequest(
  PacketBuffer *msgBuf,
  uint8_t reqType,
  bool doMfrAttest
)

Gera a mensagem GetCertificateRequest.

Esse método gera a estrutura Weave GetCertificateRequest 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
[in] msgBuf
Um ponteiro para o objeto PackageBuffer que contém a mensagem GetCertificateRequest.
[in] reqType
Receber o tipo de solicitação de certificado.
[in] doMfrAttest
Uma sinalização booleana que indica se a solicitação precisa incluir dados de atestado do fabricante.
Valores de retorno
WEAVE_NO_ERROR
Se a GetCertificateRequest foi gerada.

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 de evento da API atualmente configurada no objeto WeaveCertProvEngine.

GetMfrAttestDelegate

WeaveNodeMfrAttestDelegate * GetMfrAttestDelegate(
  void
) const

Retorna um ponteiro para o objeto de delegação de atestado do fabricante configurado no objeto WeaveCertProvEngine.

GetOpAuthDelegate

WeaveNodeOpAuthDelegate * GetOpAuthDelegate(
  void
) const

Retorna um ponteiro para o objeto de delegação de autenticação operacional atualmente configurado no objeto WeaveCertProvEngine.

GetReqType

uint8_t GetReqType(
  void
) const

Recupera o tipo de solicitação atual.

GetState

State GetState(
  void
) const

Extraia o estado atual do objeto WeaveCertProvEngine.

Init

WEAVE_ERROR Init(
  Binding *binding,
  WeaveNodeOpAuthDelegate *opAuthDelegate,
  WeaveNodeMfrAttestDelegate *mfrAttestDelegate,
  EventCallback eventCallback,
  void *appState
)

Inicialize um objeto WeaveCertProvEngine para preparar o envio da mensagem de solicitação de certificado.

Detalhes
Parâmetros
[in] binding
Um objeto Binding que será usado para estabelecer a comunicação com o nó peer.
[in] opAuthDelegate
Um ponteiro para um objeto delegado de autenticação operacional que será usado para construir e assinar usando as credenciais operacionais do nó.
[in] mfrAttestDelegate
Um ponteiro para um objeto delegado de atestado do fabricante que será usado para criar e assinar a solicitação usando as credenciais provisionadas do fabricante do nó.
[in] eventCallback
Um ponteiro para uma função que será chamada pelo objeto WeaveCertProvEngine para enviar eventos da API ao aplicativo.
[in] appState
Um ponteiro para um objeto definido pelo aplicativo, que será transmitido de volta ao aplicativo sempre que um evento da API ocorrer.

ProcessGetCertificateResponse

WEAVE_ERROR ProcessGetCertificateResponse(
  PacketBuffer *msgBuf
)

Processa 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, o método faz uma chamada para o aplicativo pelo evento ResponseReceived da API para entregar o resultado.

Se o processamento da mensagem GetCertificateResponse falhar, o método fará uma chamada para o aplicativo pelo evento da API CommunicationError para informar o erro.

Detalhes
Parâmetros
[in] msgBuf
Um ponteiro para o objeto PacketBuffer que contém a mensagem GetCertificateResponse.
Valores de retorno
WEAVE_NO_ERROR
Se a mensagem GetCertificateResponse foi processada.

SetBinding

void SetBinding(
  Binding *binding
)

Define o objeto de vinculação no objeto WeaveCertProvEngine.

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

Define a função de callback de evento da API no objeto WeaveCertProvEngine.

SetMfrAttestDelegate

void SetMfrAttestDelegate(
  WeaveNodeMfrAttestDelegate *mfrAttestDelegate
)

Define o objeto de delegação de atestado do fabricante no objeto WeaveCertProvEngine.

SetOpAuthDelegate

void SetOpAuthDelegate(
  WeaveNodeOpAuthDelegate *opAuthDelegate
)

Define o objeto de delegação de autenticação operacional no objeto WeaveCertProvEngine.

Encerramento

void Shutdown(
  void
)

Desligue um objeto WeaveCertProvEngine previamente inicializado.

Esse método só pode ser chamado se o método Init() tiver sido chamado anteriormente.

StartCertificateProvisioning

WEAVE_ERROR StartCertificateProvisioning(
  uint8_t reqType,
  bool doMfrAttest
)

Iniciar o 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á enviada ao aplicativo pelo evento ResponseReceived da API.

Se o objeto Binding não estiver no estado "Pronto" quando esse método for chamado, uma solicitação será feita para o método Binding::RequestPrepare() para iniciar a preparação sob demanda. A operação de solicitação vai aguardar até que esse processo seja concluído. Qualquer chamada para StartCertificateProvisioning() enquanto houver uma solicitação anterior em andamento será ignorada.

Detalhes
Parâmetros
[in] reqType
Receber o tipo de solicitação de certificado.
[in] doMfrAttest
Uma flag booleana que indica se o protocolo precisa incluir dados de atestado do fabricante.
Valores de retorno
WEAVE_NO_ERROR
Se StartCertificateProvisioning() foi processado.

WeaveCertProvEngine

 WeaveCertProvEngine(
  void
)