CoAP Secure#

otHandleCoapSecureClientConnect#

typedef void(* otHandleCoapSecureClientConnect) (bool aConnected, void *aContext) )(bool aConnected, void *aContext)

This function pointer is called when the DTLS connection state changes.

otCoapSecureStart#

otError otCoapSecureStart (otInstance *aInstance, uint16_t aPort)

This function starts the CoAP Secure service.

otCoapSecureStop#

void otCoapSecureStop (otInstance *aInstance)

This function stops the CoAP Secure server.

otCoapSecureSetPsk#

void otCoapSecureSetPsk (otInstance *aInstance, const uint8_t *aPsk, uint16_t aPskLength, const uint8_t *aPskIdentity, uint16_t aPskIdLength)

This method sets the Pre-Shared Key (PSK) and cipher suite DTLS_PSK_WITH_AES_128_CCM_8.

Note

• This function requires the build-time feature MBEDTLS_KEY_EXCHANGE_PSK_ENABLED to be enabled.

otCoapSecureGetPeerCertificateBase64#

otError otCoapSecureGetPeerCertificateBase64 (otInstance *aInstance, unsigned char *aPeerCert, size_t *aCertLength, size_t aCertBufferSize)

This method returns the peer x509 certificate base64 encoded.

Note

• This function requires the build-time features MBEDTLS_BASE64_C and MBEDTLS_SSL_KEEP_PEER_CERTIFICATE to be enabled.

otCoapSecureSetSslAuthMode#

void otCoapSecureSetSslAuthMode (otInstance *aInstance, bool aVerifyPeerCertificate)

This method sets the authentication mode for the coap secure connection.

Disable or enable the verification of peer certificate. Must be called before start.

otCoapSecureSetCertificate#

void otCoapSecureSetCertificate (otInstance *aInstance, const uint8_t *aX509Cert, uint32_t aX509Length, const uint8_t *aPrivateKey, uint32_t aPrivateKeyLength)

This method sets the local device's X509 certificate with corresponding private key for DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.

Note

• This function requires MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED=1.

otCoapSecureSetCaCertificateChain#

void otCoapSecureSetCaCertificateChain (otInstance *aInstance, const uint8_t *aX509CaCertificateChain, uint32_t aX509CaCertChainLength)

This method sets the trusted top level CAs.

It is needed for validating the certificate of the peer.

DTLS mode "ECDHE ECDSA with AES 128 CCM 8" for Application CoAPS.

Note

• This function requires MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED=1.

otCoapSecureConnect#

otError otCoapSecureConnect (otInstance *aInstance, const otSockAddr *aSockAddr, otHandleCoapSecureClientConnect aHandler, void *aContext)

This method initializes DTLS session with a peer.

otCoapSecureDisconnect#

void otCoapSecureDisconnect (otInstance *aInstance)

This method stops the DTLS connection.

otCoapSecureIsConnected#

bool otCoapSecureIsConnected (otInstance *aInstance)

This method indicates whether or not the DTLS session is connected.

otCoapSecureIsConnectionActive#

bool otCoapSecureIsConnectionActive (otInstance *aInstance)

This method indicates whether or not the DTLS session is active.

otCoapSecureSendRequestBlockWise#

otError otCoapSecureSendRequestBlockWise (otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)

This method sends a CoAP request block-wise over secure DTLS connection.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

If a response for a request is expected, respective function and context information should be provided. If no response is expected, these arguments should be NULL pointers. If Message Id was not set in the header (equal to 0), this function will assign unique Message Id to the message.

otCoapSecureSendRequest#

otError otCoapSecureSendRequest (otInstance *aInstance, otMessage *aMessage, otCoapResponseHandler aHandler, void *aContext)

This method sends a CoAP request over secure DTLS connection.

If a response for a request is expected, respective function and context information should be provided. If no response is expected, these arguments should be NULL pointers. If Message Id was not set in the header (equal to 0), this function will assign unique Message Id to the message.

otCoapSecureAddResource#

void otCoapSecureAddResource (otInstance *aInstance, otCoapResource *aResource)

This function adds a resource to the CoAP Secure server.

otCoapSecureRemoveResource#

void otCoapSecureRemoveResource (otInstance *aInstance, otCoapResource *aResource)

This function removes a resource from the CoAP Secure server.

otCoapSecureAddBlockWiseResource#

void otCoapSecureAddBlockWiseResource (otInstance *aInstance, otCoapBlockwiseResource *aResource)

This function adds a block-wise resource to the CoAP Secure server.

otCoapSecureRemoveBlockWiseResource#

void otCoapSecureRemoveBlockWiseResource (otInstance *aInstance, otCoapBlockwiseResource *aResource)

This function removes a block-wise resource from the CoAP Secure server.

otCoapSecureSetDefaultHandler#

void otCoapSecureSetDefaultHandler (otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)

This function sets the default handler for unhandled CoAP Secure requests.

otCoapSecureSetClientConnectedCallback#

void otCoapSecureSetClientConnectedCallback (otInstance *aInstance, otHandleCoapSecureClientConnect aHandler, void *aContext)

This method sets the connected callback to indicate, when a Client connect to the CoAP Secure server.

otCoapSecureSendResponseBlockWise#

otError otCoapSecureSendResponseBlockWise (otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)

This function sends a CoAP response block-wise from the CoAP Secure server.

This function is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration is enabled.

otCoapSecureSendResponse#

otError otCoapSecureSendResponse (otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)

This function sends a CoAP response from the CoAP Secure server.

OT_DEFAULT_COAP_SECURE_PORT#

#define OT_DEFAULT_COAP_SECURE_PORT

5684

Default CoAP Secure port, as specified in RFC 7252.