Symbols

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::MeshCoP::BorderAgent

ot::MeshCoP::BorderAgent class

Syntax

Show:

Summary

Declaration

from border_agent.hpp:59

class BorderAgent : public InstanceLocator, private NonCopyable { friend class ot::Notifier; friend class Tmf::Agent; friend class Tmf::SecureAgent; public: static constexpr uint16_t kMinEphemeralKeyLength = OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH; static constexpr uint16_t kMaxEphemeralKeyLength = OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH; static constexpr uint32_t kDefaultEphemeralKeyTimeout = OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT; static constexpr uint32_t kMaxEphemeralKeyTimeout = OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT; typedef otBorderAgentId Id; enum State : uint8_t { kStateStopped, kStateStarted, kStateConnected, kStateAccepted, }; explicit BorderAgent(Instance &aInstance); #if OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE Error GetId(Id &aId); Error SetId(const Id &aId); #endif uint16_t GetUdpPort(void) const; void Start(void) { IgnoreError(Start(kUdpPort)); } void Stop(void); State GetState(void) const { return mState; } void Disconnect(void); #if OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE Error SetEphemeralKey(const char *aKeyString, uint32_t aTimeout, uint16_t aUdpPort); void ClearEphemeralKey(void); bool IsEphemeralKeyActive(void) const { return mUsingEphemeralKey; } typedef otBorderAgentEphemeralKeyCallback EphemeralKeyCallback; void SetEphemeralKeyCallback(EphemeralKeyCallback aCallback, void *aContext) { mEphemeralKeyCallback.Set(aCallback, aContext); } #endif const otBorderAgentCounters *GetCounters(void) { return &mCounters; } uint16_t GetUdpProxyPort(void) const { return mUdpProxyPort; } private: static_assert(kMaxEphemeralKeyLength <= SecureTransport::kPskMaxLength, "Max ephemeral key length is larger than max PSK len"); static constexpr uint16_t kUdpPort = OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT; static constexpr uint32_t kKeepAliveTimeout = 50 * 1000; #if OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE static constexpr uint16_t kMaxEphemeralKeyConnectionAttempts = 10; #endif class ForwardContext : public InstanceLocatorInit, public Heap::Allocatable<ForwardContext> { public: Error Init(Instance &aInstance, const Coap::Message &aMessage, bool aPetition, bool aSeparate); bool IsPetition(void) const { return mPetition; } uint16_t GetMessageId(void) const { return mMessageId; } Error ToHeader(Coap::Message &aMessage, uint8_t aCode) const; private: uint16_t mMessageId; bool mPetition : 1; bool mSeparate : 1; uint8_t mTokenLength : 4; uint8_t mType : 2; uint8_t mToken[Coap::Message::kMaxTokenLength]; }; Error Start(uint16_t aUdpPort); Error Start(uint16_t aUdpPort, const uint8_t *aPsk, uint8_t aPskLength); void HandleNotifierEvents(Events aEvents); Coap::Message::Code CoapCodeFromError(Error aError); Error SendMessage(Coap::Message &aMessage); void SendErrorMessage(const ForwardContext &aForwardContext, Error aError); void SendErrorMessage(const Coap::Message &aRequest, bool aSeparate, Error aError); static void HandleConnected(SecureTransport::ConnectEvent aEvent, void *aContext); void HandleConnected(SecureTransport::ConnectEvent aEvent); template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo); void HandleTmfDatasetGet(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, Uri aUri); void HandleTimeout(void); #if OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE void RestartAfterRemovingEphemeralKey(void); void HandleEphemeralKeyTimeout(void); void InvokeEphemeralKeyCallback(void); static void HandleSecureAgentStopped(void *aContext); void HandleSecureAgentStopped(void); #endif static void HandleCoapResponse(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, Error aResult); void HandleCoapResponse(const ForwardContext &aForwardContext, const Coap::Message *aResponse, Error aResult); Error ForwardToLeader(const Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo, Uri aUri); Error ForwardToCommissioner(Coap::Message &aForwardMessage, const Message &aMessage); static bool HandleUdpReceive(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo); bool HandleUdpReceive(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo); using TimeoutTimer = TimerMilliIn<BorderAgent, &BorderAgent::HandleTimeout>; #if OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE using EphemeralKeyTimer = TimerMilliIn<BorderAgent, &BorderAgent::HandleEphemeralKeyTimeout>; using EphemeralKeyTask = TaskletIn<BorderAgent, &BorderAgent::InvokeEphemeralKeyCallback>; #endif State mState; uint16_t mUdpProxyPort; Ip6::Udp::Receiver mUdpReceiver; Ip6::Netif::UnicastAddress mCommissionerAloc; TimeoutTimer mTimer; #if OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE Id mId; bool mIdInitialized; #endif #if OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE bool mUsingEphemeralKey; uint16_t mOldUdpPort; EphemeralKeyTimer mEphemeralKeyTimer; EphemeralKeyTask mEphemeralKeyTask; Callback<EphemeralKeyCallback> mEphemeralKeyCallback; #endif otBorderAgentCounters mCounters; };

Fields

Field

Description

Declared as

ot::MeshCoP::BorderAgent::kMinEphemeralKeyLength

Minimum length of the ephemeral key string.

ot::MeshCoP::BorderAgent::kMaxEphemeralKeyLength

Maximum length of the ephemeral key string.

ot::MeshCoP::BorderAgent::kDefaultEphemeralKeyTimeout

Default ephemeral key timeout interval in milliseconds.

ot::MeshCoP::BorderAgent::kMaxEphemeralKeyTimeout

Maximum ephemeral key timeout interval in milliseconds.

ot::MeshCoP::BorderAgent::kUdpPort

ot::MeshCoP::BorderAgent::kKeepAliveTimeout

ot::MeshCoP::BorderAgent::kMaxEphemeralKeyConnectionAttempts

ot::MeshCoP::BorderAgent::mState

State

ot::MeshCoP::BorderAgent::mUdpProxyPort

uint16_t

ot::MeshCoP::BorderAgent::mUdpReceiver

Ip6::Udp::Receiver

ot::MeshCoP::BorderAgent::mCommissionerAloc

Ip6::Netif::UnicastAddress

ot::MeshCoP::BorderAgent::mTimer

TimeoutTimer

ot::MeshCoP::BorderAgent::mId

ot::MeshCoP::BorderAgent::mIdInitialized

bool

ot::MeshCoP::BorderAgent::mUsingEphemeralKey

bool

ot::MeshCoP::BorderAgent::mOldUdpPort

uint16_t

ot::MeshCoP::BorderAgent::mEphemeralKeyTimer

EphemeralKeyTimer

ot::MeshCoP::BorderAgent::mEphemeralKeyTask

EphemeralKeyTask

ot::MeshCoP::BorderAgent::mEphemeralKeyCallback

Callback<EphemeralKeyCallback>

ot::MeshCoP::BorderAgent::mCounters

otBorderAgentCounters

Methods

GetId()

Gets the randomly generated Border Agent ID. The ID is saved in persistent storage and survives reboots. The typical use case of the ID is to be published in the MeshCoP mDNS service as the `id` TXT value for the client to identify this Border Router/Agent device.

SetId()

Sets the Border Agent ID. The Border Agent ID will be saved in persistent storage and survive reboots. It's required to set the ID only once after factory reset. If the ID has never been set by calling this method, a random ID will be generated and returned when `GetId()` is called.

GetUdpPort() const

Gets the UDP port of this service.

Start()

Stop()

Stops the Border Agent service.

GetState() const

Gets the state of the Border Agent service.

Disconnect()

Disconnects the Border Agent from any active secure sessions. If Border Agent is connected to a commissioner candidate with ephemeral key, calling this API will cause the ephemeral key to be cleared after the session is disconnected. The Border Agent state may not change immediately upon calling this method, the state will be updated when the connection update is notified by `HandleConnected()`.

SetEphemeralKey()

Sets the ephemeral key for a given timeout duration. The ephemeral key can be set when the Border Agent is already running and is not currently connected to any external commissioner (i.e., it is in `kStateStarted` state). To terminate active commissioner sessions, use the `Disconnect()` function. The given @p aKeyString is directly used as the ephemeral PSK (excluding the trailing null `\0` character). Its length must be between `kMinEphemeralKeyLength` and `kMaxEphemeralKeyLength`, inclusive. Setting the ephemeral key again before a previously set one is timed out will replace the previous one and will reset the timeout. During the timeout interval, the ephemeral key can be used only once by an external commissioner to establish a connection. After the commissioner disconnects, the ephemeral key is cleared, and the Border Agent reverts to using PSKc. If the timeout expires while a commissioner is still connected, the session will be terminated, and the Border Agent will cease using the ephemeral key and revert to PSKc.

ClearEphemeralKey()

Cancels the ephemeral key in use if any. Can be used to cancel a previously set ephemeral key before it times out. If the Border Agent is not running or there is no ephemeral key in use, calling this function has no effect. If a commissioner is connected using the ephemeral key and is currently active, calling this method does not change its state. In this case the `IsEphemeralKeyActive()` will continue to return `true` until the commissioner disconnects, or the ephemeral key timeout expires. To terminate active commissioner sessions, use the `Disconnect()` function.