mirror of
https://github.com/espressif/openthread.git
synced 2026-09-26 02:47:36 +00:00
[coap] mark request acknowledged before dispatching observe responses (#13408)
In the observe paths of `CoapBase::ProcessReceivedResponse()`, update the tracked request's metadata (`MarkAsAcknowledged()`) before invoking the response handler. The handler may cancel the observation (same-token GET with Observe=1, `otCoapStop()`, or abort APIs), which finalizes and frees the tracked request message, so the metadata must be written while the message is still owned by the pending-requests list. A nexus test exercising in-handler cancellation on both response paths is included. Co-authored-by: aussinfosec <[email protected]>
This commit is contained in:
Griffin Francis
co-authored by
aussinfosec
aussinfosec
parent
c7a3a19f5a
commit
002c8fbeb4
@@ -618,9 +618,9 @@ void CoapBase::ProcessReceivedResponse(Msg &aRxMsg)
|
||||
if (shouldObserve)
|
||||
{
|
||||
// This is a RFC7641 notification. The request is *not* done!
|
||||
mPendingRequests.DispatchResponse(request, kErrorNone, &aRxMsg);
|
||||
|
||||
request.MarkAsAcknowledged();
|
||||
|
||||
mPendingRequests.DispatchResponse(request, kErrorNone, &aRxMsg);
|
||||
ExitNow();
|
||||
}
|
||||
#endif
|
||||
@@ -648,8 +648,6 @@ void CoapBase::ProcessReceivedResponse(Msg &aRxMsg)
|
||||
#if OPENTHREAD_CONFIG_COAP_OBSERVE_API_ENABLE
|
||||
if (shouldObserve)
|
||||
{
|
||||
mPendingRequests.DispatchResponse(request, kErrorNone, &aRxMsg);
|
||||
|
||||
// When any Observe response is seen, consider a NON observe
|
||||
// request "acknowledged" at this point. This will keep the
|
||||
// Observe request active indefinitely until it is
|
||||
@@ -660,6 +658,8 @@ void CoapBase::ProcessReceivedResponse(Msg &aRxMsg)
|
||||
request.MarkAsAcknowledged();
|
||||
}
|
||||
|
||||
mPendingRequests.DispatchResponse(request, kErrorNone, &aRxMsg);
|
||||
|
||||
ExitNow();
|
||||
}
|
||||
#endif
|
||||
|
||||
@@ -405,6 +405,7 @@ ot_nexus_test(border_agent_tracker "core;nexus")
|
||||
ot_nexus_test(child_supervision "core;nexus")
|
||||
ot_nexus_test(coap_block "core;nexus")
|
||||
ot_nexus_test(coap_observe "core;nexus")
|
||||
ot_nexus_test(coap_observe_cancel "core;nexus")
|
||||
ot_nexus_test(coaps "core;nexus")
|
||||
ot_nexus_test(compact_route_tlv "core;nexus")
|
||||
ot_nexus_test(dataset_updater "core;nexus")
|
||||
|
||||
@@ -0,0 +1,213 @@
|
||||
/*
|
||||
* Copyright (c) 2026, The OpenThread Authors.
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in the
|
||||
* documentation and/or other materials provided with the distribution.
|
||||
* 3. Neither the name of the copyright holder nor the
|
||||
* names of its contributors may be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
* POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Verifies in-handler cancellation of a CoAP observation.
|
||||
*
|
||||
* Node A observes a resource on node B (GET + Observe=0). Inside A's response handler (the
|
||||
* documented RFC7641 cancellation pattern) A sends a GET with Observe=1 and the SAME token,
|
||||
* which makes the CoAP core finalize and free the tracked observe request message. The
|
||||
* request metadata update for the notification must therefore happen before the handler is
|
||||
* dispatched; this test exercises that ordering (message lifetime issues surface under
|
||||
* sanitizer builds).
|
||||
*
|
||||
* Both modified response paths are covered:
|
||||
*
|
||||
* - Piggybacked case: A sends a confirmable GET; B answers with a piggybacked ACK carrying
|
||||
* an Observe option (the acknowledged-response path).
|
||||
*
|
||||
* - Separate case: A sends a non-confirmable GET; B answers with a separate non-confirmable
|
||||
* response carrying the request token and an Observe option (the separate / NON response
|
||||
* path, where a NON observe request is marked acknowledged on the first notification).
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
|
||||
#include <openthread/coap.h>
|
||||
|
||||
#include "platform/nexus_core.hpp"
|
||||
#include "platform/nexus_node.hpp"
|
||||
|
||||
namespace ot {
|
||||
namespace Nexus {
|
||||
|
||||
static constexpr uint32_t kFormNetworkTime = 13 * 1000;
|
||||
static constexpr uint32_t kJoinTime = 30 * 1000;
|
||||
static constexpr uint16_t kCoapPort = OT_DEFAULT_COAP_PORT;
|
||||
|
||||
static Node *sNodeA;
|
||||
static Node *sNodeB;
|
||||
static otIp6Address sNodeBAddr;
|
||||
static bool sNotificationSeen;
|
||||
static bool sCancelSent;
|
||||
static bool sUseSeparateResponse;
|
||||
|
||||
static void HandleSecondResponse(void *, otMessage *, const otMessageInfo *, otError) {}
|
||||
|
||||
static void HandleObserveResponse(void *aContext,
|
||||
otMessage *aMessage,
|
||||
const otMessageInfo *aMessageInfo,
|
||||
otError aError)
|
||||
{
|
||||
OT_UNUSED_VARIABLE(aContext);
|
||||
OT_UNUSED_VARIABLE(aMessageInfo);
|
||||
|
||||
Log("A: observe response handler invoked (error=%d, msg=%s)", aError, (aMessage != nullptr) ? "yes" : "null");
|
||||
|
||||
// The in-handler cancellation reentrantly finalizes this same request (handler invoked
|
||||
// again with a null message); only act on the first, genuine notification.
|
||||
if (sCancelSent || (aMessage == nullptr) || (aError != OT_ERROR_NONE))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
sNotificationSeen = true;
|
||||
|
||||
// RFC7641 cancellation from inside the notification callback: GET with Observe=1 and
|
||||
// the SAME token to the same server.
|
||||
{
|
||||
otMessage *req = otCoapNewMessage(&sNodeA->GetInstance(), nullptr);
|
||||
otMessageInfo msgInfo;
|
||||
|
||||
VerifyOrQuit(req != nullptr);
|
||||
SuccessOrQuit(otCoapMessageInit(req, OT_COAP_TYPE_CONFIRMABLE, OT_COAP_CODE_GET));
|
||||
SuccessOrQuit(
|
||||
otCoapMessageSetToken(req, otCoapMessageGetToken(aMessage), otCoapMessageGetTokenLength(aMessage)));
|
||||
SuccessOrQuit(otCoapMessageAppendObserveOption(req, 1));
|
||||
SuccessOrQuit(otCoapMessageAppendUriPathOptions(req, "obs"));
|
||||
|
||||
memset(&msgInfo, 0, sizeof(msgInfo));
|
||||
msgInfo.mPeerAddr = sNodeBAddr;
|
||||
msgInfo.mPeerPort = kCoapPort;
|
||||
|
||||
SuccessOrQuit(otCoapSendRequest(&sNodeA->GetInstance(), req, &msgInfo, HandleSecondResponse, nullptr));
|
||||
sCancelSent = true;
|
||||
Log("A: cancellation GET (Observe=1, same token) sent from inside the handler");
|
||||
}
|
||||
}
|
||||
|
||||
static void HandleResource(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
||||
{
|
||||
OT_UNUSED_VARIABLE(aContext);
|
||||
|
||||
otMessage *rsp = otCoapNewMessage(&sNodeB->GetInstance(), nullptr);
|
||||
|
||||
VerifyOrQuit(rsp != nullptr);
|
||||
|
||||
if (sUseSeparateResponse)
|
||||
{
|
||||
Log("B: resource request received; sending separate non-confirmable response with Observe option");
|
||||
SuccessOrQuit(otCoapMessageInit(rsp, OT_COAP_TYPE_NON_CONFIRMABLE, OT_COAP_CODE_CONTENT));
|
||||
SuccessOrQuit(
|
||||
otCoapMessageSetToken(rsp, otCoapMessageGetToken(aMessage), otCoapMessageGetTokenLength(aMessage)));
|
||||
}
|
||||
else
|
||||
{
|
||||
Log("B: resource request received; sending piggybacked ACK with Observe option");
|
||||
SuccessOrQuit(otCoapMessageInitResponse(rsp, aMessage, OT_COAP_TYPE_ACKNOWLEDGMENT, OT_COAP_CODE_CONTENT));
|
||||
}
|
||||
|
||||
SuccessOrQuit(otCoapMessageAppendObserveOption(rsp, 1));
|
||||
SuccessOrQuit(otCoapMessageSetPayloadMarker(rsp));
|
||||
SuccessOrQuit(otMessageAppend(rsp, "x", 1));
|
||||
SuccessOrQuit(otCoapSendResponse(&sNodeB->GetInstance(), rsp, aMessageInfo));
|
||||
}
|
||||
|
||||
static otCoapResource sResource;
|
||||
|
||||
void TestCoapObserveCancelInHandler(bool aUseSeparateResponse)
|
||||
{
|
||||
Core nexus;
|
||||
Node &nodeA = nexus.CreateNode();
|
||||
Node &nodeB = nexus.CreateNode();
|
||||
|
||||
sNodeA = &nodeA;
|
||||
sNodeB = &nodeB;
|
||||
|
||||
sNotificationSeen = false;
|
||||
sCancelSent = false;
|
||||
sUseSeparateResponse = aUseSeparateResponse;
|
||||
|
||||
Log("TestCoapObserveCancelInHandler(%s response)", aUseSeparateResponse ? "separate" : "piggybacked");
|
||||
|
||||
nodeA.Form();
|
||||
nexus.AdvanceTime(kFormNetworkTime);
|
||||
VerifyOrQuit(nodeA.Get<Mle::Mle>().IsLeader());
|
||||
|
||||
nodeB.Join(nodeA);
|
||||
nexus.AdvanceTime(kJoinTime);
|
||||
VerifyOrQuit(nodeB.Get<Mle::Mle>().IsAttached());
|
||||
|
||||
sNodeBAddr = nodeB.Get<Mle::Mle>().GetMeshLocalEid();
|
||||
|
||||
SuccessOrQuit(otCoapStart(&nodeA.GetInstance(), kCoapPort));
|
||||
SuccessOrQuit(otCoapStart(&nodeB.GetInstance(), kCoapPort));
|
||||
|
||||
memset(&sResource, 0, sizeof(sResource));
|
||||
sResource.mUriPath = "obs";
|
||||
sResource.mHandler = HandleResource;
|
||||
otCoapAddResource(&nodeB.GetInstance(), &sResource);
|
||||
|
||||
Log("A: sending %s observe GET (Observe=0) to B /obs", aUseSeparateResponse ? "non-confirmable" : "confirmable");
|
||||
{
|
||||
otMessage *req = otCoapNewMessage(&nodeA.GetInstance(), nullptr);
|
||||
otMessageInfo msgInfo;
|
||||
|
||||
VerifyOrQuit(req != nullptr);
|
||||
SuccessOrQuit(otCoapMessageInit(
|
||||
req, aUseSeparateResponse ? OT_COAP_TYPE_NON_CONFIRMABLE : OT_COAP_TYPE_CONFIRMABLE, OT_COAP_CODE_GET));
|
||||
otCoapMessageGenerateToken(req, 8);
|
||||
SuccessOrQuit(otCoapMessageAppendObserveOption(req, 0));
|
||||
SuccessOrQuit(otCoapMessageAppendUriPathOptions(req, "obs"));
|
||||
|
||||
memset(&msgInfo, 0, sizeof(msgInfo));
|
||||
msgInfo.mPeerAddr = sNodeBAddr;
|
||||
msgInfo.mPeerPort = kCoapPort;
|
||||
|
||||
SuccessOrQuit(otCoapSendRequest(&nodeA.GetInstance(), req, &msgInfo, HandleObserveResponse, nullptr));
|
||||
}
|
||||
|
||||
nexus.AdvanceTime(10 * 1000);
|
||||
|
||||
Log("notification seen: %s, cancel sent: %s", sNotificationSeen ? "YES" : "NO", sCancelSent ? "YES" : "NO");
|
||||
VerifyOrQuit(sNotificationSeen && sCancelSent);
|
||||
|
||||
Log("TestCoapObserveCancelInHandler(%s response) completed", aUseSeparateResponse ? "separate" : "piggybacked");
|
||||
}
|
||||
|
||||
} // namespace Nexus
|
||||
} // namespace ot
|
||||
|
||||
int main(void)
|
||||
{
|
||||
ot::Nexus::TestCoapObserveCancelInHandler(/* aUseSeparateResponse */ false);
|
||||
ot::Nexus::TestCoapObserveCancelInHandler(/* aUseSeparateResponse */ true);
|
||||
printf("All tests passed\n");
|
||||
return 0;
|
||||
}
|
||||
Reference in New Issue
Block a user