From 7f837031ed3e9876537750db69cc615a55e19a13 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Thu, 12 Feb 2026 16:33:17 -0600 Subject: [PATCH] [tests] add nexus test 5.3.8 (MTD Child Address Set) (#12426) This commit adds a new Nexus test implementing test specification 5.3.8 (MTD Child Address Set). The test validates that the DUT MTD Child Address Set can hold at least 4 IPv6 non-link-local addresses and that the DUT does not send Address Query requests for target addresses that should be in its child address set. Changes: - Add tests/nexus/test_5_3_8.cpp to implement the test logic. - Add tests/nexus/verify_5_3_8.py to verify pcap output. - Update tests/nexus/CMakeLists.txt to include the new test. - Update tests/nexus/run_nexus_tests.sh to include 5.3.8 in the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_3_8.cpp | 296 +++++++++++++++++++++++++++++++++ tests/nexus/verify_5_3_8.py | 170 +++++++++++++++++++ 4 files changed, 468 insertions(+) create mode 100644 tests/nexus/test_5_3_8.cpp create mode 100644 tests/nexus/verify_5_3_8.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 202d83eda..530971fc6 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -144,6 +144,7 @@ ot_nexus_test(5_3_4 "cert;nexus") ot_nexus_test(5_3_5 "cert;nexus") ot_nexus_test(5_3_6 "cert;nexus") ot_nexus_test(5_3_7 "cert;nexus") +ot_nexus_test(5_3_8 "cert;nexus") # Misc tests ot_nexus_test(border_admitter "core;nexus") diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index d00c5f515..b7aece5ac 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -74,6 +74,7 @@ DEFAULT_TESTS=( "5_3_5" "5_3_6" "5_3_7" + "5_3_8" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_3_8.cpp b/tests/nexus/test_5_3_8.cpp new file mode 100644 index 000000000..9f7bb69e7 --- /dev/null +++ b/tests/nexus/test_5_3_8.cpp @@ -0,0 +1,296 @@ +/* + * 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. + */ + +#include + +#include "platform/nexus_core.hpp" +#include "platform/nexus_node.hpp" +#include "thread/network_data_local.hpp" +#include "thread/network_data_notifier.hpp" + +namespace ot { +namespace Nexus { + +/** + * Time to advance for a node to form a network and become leader, in milliseconds. + */ +static constexpr uint32_t kFormNetworkTime = 13 * 1000; + +/** + * Time to advance for a node to join as a child and upgrade to a router, in milliseconds. + */ +static constexpr uint32_t kAttachToRouterTime = 200 * 1000; + +/** + * Time to advance for the network to stabilize after nodes have attached. + */ +static constexpr uint32_t kStabilizationTime = 30 * 1000; + +/** + * Time to wait for ICMPv6 Echo response. + */ +static constexpr uint32_t kEchoResponseWaitTime = 5 * 1000; + +/** + * ICMPv6 Echo Request payload size, in bytes. + */ +static constexpr uint16_t kEchoPayloadSize = 0; + +/** + * ICMPv6 Echo Request Hop Limit. + */ +static constexpr uint8_t kEchoHopLimit = 64; + +/** + * Get a unicast address matching a prefix. + * + * @param[in] aNode The node to search. + * @param[in] aPrefixString The prefix to match. + * + * @returns The unicast address found. + */ +static Ip6::Address GetUnicastAddress(Node &aNode, const char *aPrefixString) +{ + Ip6::Prefix prefix; + Ip6::Address address; + bool found = false; + + SuccessOrQuit(prefix.FromString(aPrefixString)); + + for (const Ip6::Netif::UnicastAddress &addr : aNode.Get().GetUnicastAddresses()) + { + if (addr.GetAddress().MatchesPrefix(prefix)) + { + address = addr.GetAddress(); + found = true; + break; + } + } + + VerifyOrQuit(found, "did not get unicast address with prefix"); + + return address; +} + +/** + * Add an on-mesh prefix to a node. + * + * @param[in] aNode The node to add the prefix to. + * @param[in] aPrefixString The prefix to add. + * @param[in] aDhcp Whether the prefix is for DHCPv6. + */ +static void AddPrefix(Node &aNode, const char *aPrefixString, bool aDhcp) +{ + NetworkData::OnMeshPrefixConfig config; + + config.Clear(); + SuccessOrQuit(config.GetPrefix().FromString(aPrefixString)); + config.mOnMesh = true; + config.mStable = true; + config.mPreferred = true; + config.mDhcp = aDhcp; + config.mSlaac = !aDhcp; + + SuccessOrQuit(aNode.Get().AddOnMeshPrefix(config)); + aNode.Get().HandleServerDataUpdated(); +} + +void Test5_3_8(void) +{ + /** + * 5.3.8 MTD Child Address Set + * + * 5.3.8.1 Topology + * - Leader (DUT) + * - Border Router + * - MED_1 + * - MED_2 + * + * 5.3.8.2 Purpose & Description + * The purpose of this test case is to validate that the DUT MTD Child Address Set can hold at least 4 IPv6 + * non-link-local addresses. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * ----------------------|--------------|--------------- + * MTD Child Address Set | 5.4.1.2 | 5.4.1.2 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node &br = nexus.CreateNode(); + Node &med1 = nexus.CreateNode(); + Node &med2 = nexus.CreateNode(); + + leader.SetName("LEADER"); + br.SetName("BR"); + med1.SetName("MED_1"); + med2.SetName("MED_2"); + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + /** Use AllowList feature to restrict the topology. */ + leader.AllowList(br); + br.AllowList(leader); + + leader.AllowList(med1); + med1.AllowList(leader); + + leader.AllowList(med2); + med2.AllowList(leader); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: Border Router"); + + /** + * Step 1: Border Router + * - Description: Harness configures the device to be a DHCPv6 server for prefixes 2001:: & 2002:: & 2003::. + * - Pass Criteria: N/A + */ + + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + br.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(br.Get().IsRouter()); + + AddPrefix(br, "2001::/64", true); + AddPrefix(br, "2002::/64", true); + AddPrefix(br, "2003::/64", true); + + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: Leader (DUT)"); + + /** + * Step 2: Leader (DUT) + * - Description: Automatically transmits MLE advertisements. + * - Pass Criteria: + * - The DUT MUST send properly formatted MLE Advertisements. + * - MLE Advertisements MUST be sent with an IP Hop Limit of 255 to the Link-Local All Nodes multicast address + * (FF02::1). + * - The following TLVs MUST be present in the MLE Advertisements,: + * - Leader Data TLV + * - Route64 TLV + * - Source Address TLV + */ + + // This step is verified in the python script. + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: MED_1 and MED_2"); + + /** + * Step 3: MED_1 and MED_2 + * - Description: Harness attaches end devices. + * - Pass Criteria: N/A + */ + + med1.Join(leader, Node::kAsMed); + med2.Join(leader, Node::kAsMed); + + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(med1.Get().IsChild()); + VerifyOrQuit(med2.Get().IsChild()); + + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: MED_1"); + + /** + * Step 4: MED_1 + * - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 ML-EID. + * - Pass Criteria: + * - The DUT MUST NOT send an Address Query Request. + * - MED_2 MUST respond with an ICMPv6 Echo Reply. + */ + + nexus.SendAndVerifyEchoRequest(med1, med2.Get().GetMeshLocalEid(), kEchoPayloadSize, kEchoHopLimit, + kEchoResponseWaitTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 5: MED_1"); + + /** + * Step 5: MED_1 + * - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 2001:: GUA. + * - Pass Criteria: + * - The DUT MUST NOT send an Address Query Request. + * - MED_2 MUST respond with an ICMPv6 Echo Reply. + */ + + nexus.SendAndVerifyEchoRequest(med1, GetUnicastAddress(med2, "2001::/64"), kEchoPayloadSize, kEchoHopLimit, + kEchoResponseWaitTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 6: MED_1"); + + /** + * Step 6: MED_1 + * - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 2002:: GUA. + * - Pass Criteria: + * - The DUT MUST NOT send an Address Query Request. + * - MED_2 MUST respond with an ICMPv6 Echo Reply. + */ + + nexus.SendAndVerifyEchoRequest(med1, GetUnicastAddress(med2, "2002::/64"), kEchoPayloadSize, kEchoHopLimit, + kEchoResponseWaitTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 7: MED_1"); + + /** + * Step 7: MED_1 + * - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 2003:: GUA. + * - Pass Criteria: + * - The DUT MUST NOT send an Address Query Request. + * - MED_2 MUST respond with an ICMPv6 Echo Reply. + */ + + nexus.SendAndVerifyEchoRequest(med1, GetUnicastAddress(med2, "2003::/64"), kEchoPayloadSize, kEchoHopLimit, + kEchoResponseWaitTime); + + nexus.SaveTestInfo("test_5_3_8.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_3_8(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_3_8.py b/tests/nexus/verify_5_3_8.py new file mode 100644 index 000000000..011bf919d --- /dev/null +++ b/tests/nexus/verify_5_3_8.py @@ -0,0 +1,170 @@ +#!/usr/bin/env python3 +# +# 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. +# + +import sys +import os + +# Add the current directory to sys.path to find verify_utils +CUR_DIR = os.path.dirname(os.path.abspath(__file__)) +sys.path.append(CUR_DIR) + +import verify_utils +from pktverify import consts +from pktverify.addrs import Ipv6Addr + + +def verify(pv): + # 5.3.8 MTD Child Address Set + # + # 5.3.8.1 Topology + # - Leader (DUT) + # - Border Router + # - MED_1 + # - MED_2 + # + # 5.3.8.2 Purpose & Description + # The purpose of this test case is to validate that the DUT MTD Child Address Set can hold at least 4 IPv6 + # non-link-local addresses. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # ------------------------|--------------|--------------- + # MTD Child Address Set | 5.4.1.2 | 5.4.1.2 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + MED_1 = pv.vars['MED_1'] + MED_2 = pv.vars['MED_2'] + + # Find GUA addresses of MED_2 + def get_node_id_by_name(name): + for node_id, info in pv.test_info.topology.items(): + if info['name'] == name: + return node_id + return None + + MED_2_ID = get_node_id_by_name('MED_2') + med2_addrs = [str(Ipv6Addr(addr)) for addr in pv.test_info.ipaddrs[MED_2_ID]] + MED_2_GUA1 = next(addr for addr in med2_addrs if addr.startswith('2001:')) + MED_2_GUA2 = next(addr for addr in med2_addrs if addr.startswith('2002:')) + MED_2_GUA3 = next(addr for addr in med2_addrs if addr.startswith('2003:')) + + # Step 1: Border Router + # - Description: Harness configures the device to be a DHCPv6 server for prefixes 2001:: & 2002:: & 2003::. + # - Pass Criteria: N/A + print("Step 1: Border Router") + + # Step 2: Leader (DUT) + # - Description: Automatically transmits MLE advertisements. + # - Pass Criteria: + # - The DUT MUST send properly formatted MLE Advertisements. + # - MLE Advertisements MUST be sent with an IP Hop Limit of 255 to the Link-Local All Nodes multicast address + # (FF02::1). + # - The following TLVs MUST be present in the MLE Advertisements,: + # - Leader Data TLV + # - Route64 TLV + # - Source Address TLV + print("Step 2: Leader (DUT)") + pkts.filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter_LLANMA().\ + filter_wpan_src64(LEADER).\ + filter(lambda p: { + consts.LEADER_DATA_TLV, + consts.ROUTE64_TLV, + consts.SOURCE_ADDRESS_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255).\ + must_next() + + # Step 3: MED_1 and MED_2 + # - Description: Harness attaches end devices. + # - Pass Criteria: N/A + print("Step 3: MED_1 and MED_2") + + # Step 4: MED_1 + # - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 ML-EID. + # - Pass Criteria: + # - The DUT MUST NOT send an Address Query Request. + # - MED_2 MUST respond with an ICMPv6 Echo Reply. + print("Step 4: MED_1") + _verify_echo(pv, MED_1, MED_2, pv.vars['MED_2_MLEID']) + + # Step 5: MED_1 + # - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 2001:: GUA. + # - Pass Criteria: + # - The DUT MUST NOT send an Address Query Request. + # - MED_2 MUST respond with an ICMPv6 Echo Reply. + print("Step 5: MED_1") + _verify_echo(pv, MED_1, MED_2, MED_2_GUA1) + + # Step 6: MED_1 + # - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 2002:: GUA. + # - Pass Criteria: + # - The DUT MUST NOT send an Address Query Request. + # - MED_2 MUST respond with an ICMPv6 Echo Reply. + print("Step 6: MED_1") + _verify_echo(pv, MED_1, MED_2, MED_2_GUA2) + + # Step 7: MED_1 + # - Description: Harness instructs device to send an ICMPv6 Echo Request to the MED_2 2003:: GUA. + # - Pass Criteria: + # - The DUT MUST NOT send an Address Query Request. + # - MED_2 MUST respond with an ICMPv6 Echo Reply. + print("Step 7: MED_1") + _verify_echo(pv, MED_1, MED_2, MED_2_GUA3) + + +def _verify_echo(pv, src_ext, dst_ext, target_ip): + pkts = pv.pkts + DUT_RLOC = pv.vars['LEADER_RLOC'] + start_index = pkts.index + + # Find Echo Reply from MED_2 to MED_1 + # We use a suffix match for the IP address to be robust against potential 6LoWPAN decompression issues + # where the prefix might be lost but the IID is preserved. + target_ip_addr = Ipv6Addr(target_ip) + target_iid_bytes = target_ip_addr[8:] + pkts.filter_wpan_src64(dst_ext).\ + filter(lambda p: p.icmpv6.type == consts.ICMPV6_TYPE_ECHO_REPLY and\ + (p.ipv6.src == target_ip_addr or p.ipv6.src[8:] == target_iid_bytes)).\ + must_next() + end_index = pkts.index + + # Verify no Address Query from DUT (Leader) for the target IP in this range + pkts.range(start_index, end_index).filter_wpan_src64(pv.vars['LEADER']).\ + filter(lambda p: p.ipv6.src == DUT_RLOC).\ + filter_coap_request(consts.ADDR_QRY_URI).\ + filter(lambda p: Ipv6Addr(p.coap.tlv.target_eid) == target_ip_addr or\ + Ipv6Addr(p.coap.tlv.target_eid)[8:] == target_iid_bytes).\ + must_not_next() + + +if __name__ == '__main__': + verify_utils.run_main(verify)