ot::Coap::CoapSecure class

Syntax

Show:

Summary

Declaration

from coap_secure.hpp:52

class CoapSecure : public CoapBase { public: typedef otHandleCoapSecureClientConnect ConnectEventCallback; typedef otCoapSecureAutoStopCallback AutoStopCallback; explicit CoapSecure(Instance &aInstance, bool aLayerTwoSecurity = false); Error Start(uint16_t aPort); Error Start(uint16_t aPort, uint16_t aMaxAttempts, AutoStopCallback aCallback, void *aContext); Error Start(MeshCoP::SecureTransport::TransportCallback aCallback, void *aContext); void SetConnectEventCallback(ConnectEventCallback aCallback, void *aContext) { mConnectEventCallback.Set(aCallback, aContext); } void Stop(void); Error Connect(const Ip6::SockAddr &aSockAddr, ConnectEventCallback aCallback, void *aContext); bool IsConnectionActive(void) const { return mDtls.IsConnectionActive(); } bool IsConnected(void) const { return mDtls.IsConnected(); } bool IsClosed(void) const { return mDtls.IsClosed(); } void Disconnect(void) { mDtls.Disconnect(); } MeshCoP::SecureTransport &GetDtls(void) { return mDtls; } uint16_t GetUdpPort(void) const { return mDtls.GetUdpPort(); } Error SetPsk(const uint8_t *aPsk, uint8_t aPskLength) { return mDtls.SetPsk(aPsk, aPskLength); } void SetPsk(const MeshCoP::JoinerPskd &aPskd); #if OPENTHREAD_CONFIG_COAP_SECURE_API_ENABLE #ifdef MBEDTLS_KEY_EXCHANGE_PSK_ENABLED void SetPreSharedKey(const uint8_t *aPsk, uint16_t aPskLength, const uint8_t *aPskIdentity, uint16_t aPskIdLength) { mDtls.SetPreSharedKey(aPsk, aPskLength, aPskIdentity, aPskIdLength); } #endif #ifdef MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED void SetCertificate(const uint8_t *aX509Cert, uint32_t aX509Length, const uint8_t *aPrivateKey, uint32_t aPrivateKeyLength) { mDtls.SetCertificate(aX509Cert, aX509Length, aPrivateKey, aPrivateKeyLength); } void SetCaCertificateChain(const uint8_t *aX509CaCertificateChain, uint32_t aX509CaCertChainLength) { mDtls.SetCaCertificateChain(aX509CaCertificateChain, aX509CaCertChainLength); } #endif #if defined(MBEDTLS_BASE64_C) && defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE) Error GetPeerCertificateBase64(unsigned char *aPeerCert, size_t *aCertLength, size_t aCertBufferSize) { return mDtls.GetPeerCertificateBase64(aPeerCert, aCertLength, aCertBufferSize); } #endif void SetSslAuthMode(bool aVerifyPeerCertificate) { mDtls.SetSslAuthMode(aVerifyPeerCertificate); } #endif #if OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE Error SendMessage(Message &aMessage, ResponseHandler aHandler = nullptr, void *aContext = nullptr, otCoapBlockwiseTransmitHook aTransmitHook = nullptr, otCoapBlockwiseReceiveHook aReceiveHook = nullptr); Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, ResponseHandler aHandler = nullptr, void *aContext = nullptr, otCoapBlockwiseTransmitHook aTransmitHook = nullptr, otCoapBlockwiseReceiveHook aReceiveHook = nullptr); #else Error SendMessage(Message &aMessage, ResponseHandler aHandler = nullptr, void *aContext = nullptr); Error SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo, ResponseHandler aHandler = nullptr, void *aContext = nullptr); #endif void HandleUdpReceive(ot::Message &aMessage, const Ip6::MessageInfo &aMessageInfo) { return mDtls.HandleReceive(aMessage, aMessageInfo); } const Ip6::MessageInfo &GetMessageInfo(void) const { return mDtls.GetMessageInfo(); } private: Error Open(uint16_t aMaxAttempts, AutoStopCallback aCallback, void *aContext); static Error Send(CoapBase &aCoapBase, ot::Message &aMessage, const Ip6::MessageInfo &aMessageInfo) { return static_cast<CoapSecure &>(aCoapBase).Send(aMessage, aMessageInfo); } Error Send(ot::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); static void HandleDtlsConnectEvent(MeshCoP::SecureTransport::ConnectEvent aEvent, void *aContext); void HandleDtlsConnectEvent(MeshCoP::SecureTransport::ConnectEvent aEvent); static void HandleDtlsAutoClose(void *aContext); void HandleDtlsAutoClose(void); static void HandleDtlsReceive(void *aContext, uint8_t *aBuf, uint16_t aLength); void HandleDtlsReceive(uint8_t *aBuf, uint16_t aLength); static void HandleTransmit(Tasklet &aTasklet); void HandleTransmit(void); MeshCoP::SecureTransport mDtls; Callback<ConnectEventCallback> mConnectEventCallback; Callback<AutoStopCallback> mAutoStopCallback; ot::MessageQueue mTransmitQueue; TaskletContext mTransmitTask; };

Fields

Field

Declared as

ot::Coap::CoapSecure::mDtls

MeshCoP::SecureTransport

ot::Coap::CoapSecure::mConnectEventCallback

Callback<ConnectEventCallback>

ot::Coap::CoapSecure::mAutoStopCallback

Callback<AutoStopCallback>

ot::Coap::CoapSecure::mTransmitQueue

ot::MessageQueue

ot::Coap::CoapSecure::mTransmitTask

TaskletContext

Methods

Start()

Starts the secure CoAP agent.

Start()

Starts the secure CoAP agent.

Start()

Starts the secure CoAP agent.

SetConnectEventCallback()

Sets connected callback of this secure CoAP agent.

Stop()

Stops the secure CoAP agent.

Connect()

Initializes DTLS session with a peer.

IsConnectionActive() const

Indicates whether or not the DTLS session is active.

IsConnected() const

Indicates whether or not the DTLS session is connected.

IsClosed() const

Indicates whether or not the DTLS session is closed.

Disconnect()

Stops the DTLS connection.

GetDtls()

Returns a reference to the DTLS object.

GetUdpPort() const

Gets the UDP port of this agent.

SetPsk()

Sets the PSK.

SetPsk()

Sets the PSK.

SendMessage()

Sends a CoAP message 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 nullptr pointers. If Message Id was not set in the header (equal to 0), this function will assign unique Message Id to the message.