CoAP seguro
Este módulo inclui funções que controlam a comunicação CoAP Secure (CoAP sobre DTLS).
Resumo
As funções deste módulo estão disponíveis quando o recurso de API segura do CoAP (OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE
) está ativado.
Typedefs |
|
---|---|
otHandleCoapSecureClientConnect)(bool aConnected, void *aContext)
|
typedefvoid(*
Esse ponteiro de função é chamado quando o estado da conexão DTLS muda. |
Functions |
|
---|---|
otCoapSecureAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Essa função adiciona um recurso de bloqueio de blocos ao servidor CoAP Secure.
|
otCoapSecureAddResource(otInstance *aInstance, otCoapResource *aResource)
|
void
Essa função adiciona um recurso ao servidor CoAP Secure.
|
otCoapSecureConnect(otInstance *aInstance, const otSockAddr *aSockAddr, otHandleCoapSecureClientConnect aHandler, void *aContext)
|
Esse método inicializa a sessão do DTLS com um peering.
|
otCoapSecureDisconnect(otInstance *aInstance)
|
void
Esse método interrompe a conexão DTLS.
|
otCoapSecureGetPeerCertificateBase64(otInstance *aInstance, unsigned char *aPeerCert, size_t *aCertLength, size_t aCertBufferSize)
|
Esse método retorna o certificado x509 de peering base64 codificado.
|
otCoapSecureIsConnected(otInstance *aInstance)
|
bool
Esse método indica se a sessão DTLS está ou não conectada.
|
otCoapSecureIsConnectionActive(otInstance *aInstance)
|
bool
Esse método indica se a sessão DTLS está ativa ou não.
|
otCoapSecureRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Essa função remove um recurso de bloqueio do servidor do CoAP Secure.
|
otCoapSecureRemoveResource(otInstance *aInstance, otCoapResource *aResource)
|
void
Essa função remove um recurso do servidor CoAP Secure.
|
otCoapSecureSendRequest(otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext)
|
Esse método envia uma solicitação CoAP por conexão DTLS segura.
|
otCoapSecureSendRequestBlockWise(otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
|
Esse método envia uma solicitação CoAP em termos de bloco em uma conexão DTLS segura.
|
otCoapSecureSendResponse(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
Essa função envia uma resposta CoAP do servidor CoAP seguro.
|
otCoapSecureSendResponseBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
|
Essa função envia uma resposta CoAP em blocos do servidor CoAP seguro.
|
otCoapSecureSetCaCertificateChain(otInstance *aInstance, const uint8_t *aX509CaCertificateChain, uint32_t aX509CaCertChainLength)
|
void
Esse método define as CAs de nível superior confiáveis.
|
otCoapSecureSetCertificate(otInstance *aInstance, const uint8_t *aX509Cert, uint32_t aX509Length, const uint8_t *aPrivateKey, uint32_t aPrivateKeyLength)
|
void
Esse método define o certificado X509 do dispositivo local com a chave privada correspondente para a sessão DTLS com DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
|
otCoapSecureSetClientConnectedCallback(otInstance *aInstance, otHandleCoapSecureClientConnect aHandler, void *aContext)
|
void
Esse método define o callback conectado para indicar quando um cliente se conecta ao servidor CoAP Secure.
|
otCoapSecureSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
|
void
Essa função define o gerenciador padrão para solicitações CoAP Secure não processadas.
|
otCoapSecureSetPsk(otInstance *aInstance, const uint8_t *aPsk, uint16_t aPskLength, const uint8_t *aPskIdentity, uint16_t aPskIdLength)
|
void
Esse método define a chave pré-compartilhada (PSK) e o pacote de criptografia DTLS_PSK_WITH_AES_128_CCM_8.
|
otCoapSecureSetSslAuthMode(otInstance *aInstance, bool aVerifyPeerCertificate)
|
void
Esse método define o modo de autenticação para a conexão segura remota.
|
otCoapSecureStart(otInstance *aInstance, uint16_t aPort)
|
Essa função inicia o serviço CoAP Secure.
|
otCoapSecureStop(otInstance *aInstance)
|
void
Essa função interrompe o servidor CoAP Secure.
|
Typedefs
OtHandleCoapSecureClientConnect
void(* otHandleCoapSecureClientConnect)(bool aConnected, void *aContext)
Esse ponteiro de função é chamado quando o estado da conexão DTLS muda.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Functions
OtCoapSecureAddBlockWiseResource
void otCoapSecureAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Essa função adiciona um recurso de bloqueio de blocos ao servidor CoAP Secure.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureAddResource
void otCoapSecureAddResource( otInstance *aInstance, otCoapResource *aResource )
Essa função adiciona um recurso ao servidor CoAP Secure.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureConnect
otError otCoapSecureConnect( otInstance *aInstance, const otSockAddr *aSockAddr, otHandleCoapSecureClientConnect aHandler, void *aContext )
Esse método inicializa a sessão do DTLS com um peering.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCoapSecureDisconnect
void otCoapSecureDisconnect( otInstance *aInstance )
Esse método interrompe a conexão DTLS.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
OtCoapSecureGetPeerCertificateBase64
otError otCoapSecureGetPeerCertificateBase64( otInstance *aInstance, unsigned char *aPeerCert, size_t *aCertLength, size_t aCertBufferSize )
Esse método retorna o certificado x509 de peering base64 codificado.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCoapSecureIsConnected
bool otCoapSecureIsConnected( otInstance *aInstance )
Esse método indica se a sessão DTLS está ou não conectada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtCoapSecureIsConnectionActive
bool otCoapSecureIsConnectionActive( otInstance *aInstance )
Esse método indica se a sessão DTLS está ativa ou não.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtCoapSecureRemoveBlockWiseResource
void otCoapSecureRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Essa função remove um recurso de bloqueio do servidor do CoAP Secure.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureRemoveResource
void otCoapSecureRemoveResource( otInstance *aInstance, otCoapResource *aResource )
Essa função remove um recurso do servidor CoAP Secure.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureSendRequest
otError otCoapSecureSendRequest( otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext )
Esse método envia uma solicitação CoAP por conexão DTLS segura.
Se uma resposta a uma solicitação for esperada, forneça as respectivas informações de função e contexto. Se nenhuma resposta for esperada, esses argumentos precisam ser ponteiros NULL. Se o ID da mensagem não tiver sido definido no cabeçalho (igual a 0), essa função atribuirá um ID exclusivo à mensagem.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
OtCoapSecureSendRequestBlockWise
otError otCoapSecureSendRequestBlockWise( otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Esse método envia uma solicitação CoAP em termos de bloco em uma conexão DTLS segura.
Esta função fica disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está ativada.
Se uma resposta a uma solicitação for esperada, forneça as respectivas informações de função e contexto. Se nenhuma resposta for esperada, esses argumentos precisam ser ponteiros NULL. Se o ID da mensagem não tiver sido definido no cabeçalho (igual a 0), essa função atribuirá um ID exclusivo à mensagem.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
OtCoapSecureSendResponse
otError otCoapSecureSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Essa função envia uma resposta CoAP do servidor CoAP seguro.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
OtCoapSecureSendResponseBlockWise
otError otCoapSecureSendResponseBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Essa função envia uma resposta CoAP em blocos do servidor CoAP seguro.
Esta função fica disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está ativada.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
OtCoapSecureSetCaCertificateChain
void otCoapSecureSetCaCertificateChain( otInstance *aInstance, const uint8_t *aX509CaCertificateChain, uint32_t aX509CaCertChainLength )
Esse método define as CAs de nível superior confiáveis.
Ela é necessária para validar o certificado do terminal.
Modo DTLS "ECDHE ECDSA com AES 128 CCM 8" para CoAPS de aplicativos.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureSetCertificate
void otCoapSecureSetCertificate( otInstance *aInstance, const uint8_t *aX509Cert, uint32_t aX509Length, const uint8_t *aPrivateKey, uint32_t aPrivateKeyLength )
Esse método define o certificado X509 do dispositivo local com a chave privada correspondente para a sessão DTLS com DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureSetClientConnectedCallback
void otCoapSecureSetClientConnectedCallback( otInstance *aInstance, otHandleCoapSecureClientConnect aHandler, void *aContext )
Esse método define o callback conectado para indicar quando um cliente se conecta ao servidor CoAP Secure.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureSetDefaultHandler
void otCoapSecureSetDefaultHandler( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext )
Essa função define o gerenciador padrão para solicitações CoAP Secure não processadas.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureSetPsk
void otCoapSecureSetPsk( otInstance *aInstance, const uint8_t *aPsk, uint16_t aPskLength, const uint8_t *aPskIdentity, uint16_t aPskIdLength )
Esse método define a chave pré-compartilhada (PSK) e o pacote de criptografia DTLS_PSK_WITH_AES_128_CCM_8.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureSetSslAuthMode
void otCoapSecureSetSslAuthMode( otInstance *aInstance, bool aVerifyPeerCertificate )
Esse método define o modo de autenticação para a conexão segura remota.
Desativar ou ativar a verificação do certificado de peering. Precisa ser chamado antes do início.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
OtCoapSecureStart
otError otCoapSecureStart( otInstance *aInstance, uint16_t aPort )
Essa função inicia o serviço CoAP Secure.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
OtCoapSecureStop
void otCoapSecureStop( otInstance *aInstance )
Essa função interrompe o servidor CoAP Secure.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Macros
OT_PADRÃO_COPO_SECURE_OTIM
OT_DEFAULT_COAP_SECURE_PORT 5684
Porta segura CoAP padrão, conforme especificado no RFC 7252.
Recursos
Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para saber mais ou contribuir com nossa documentação, consulte Recursos.