diff --git a/tests/scripts/thread-cert/border_router/MATN_04_MulticastListenerTimeout.py b/tests/scripts/thread-cert/border_router/MATN_04_MulticastListenerTimeout.py new file mode 100644 index 000000000..80c96315b --- /dev/null +++ b/tests/scripts/thread-cert/border_router/MATN_04_MulticastListenerTimeout.py @@ -0,0 +1,222 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2021, 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 logging +import unittest + +import pktverify +from pktverify import packet_verifier, packet_filter, consts +from pktverify.consts import MA1 +import config +import thread_cert + +# Test description: +# The purpose of this test case is to verify that a Primary BBR can remove an +# entry from a Multicast Listeners Table, when the entry expires. The test case +# also verifies that the Primary BBR accepts a new registration to the +# previously expired multicast group. +# +# Topology: +# ----------------(eth)------------------ +# | | | +# BR1 (Leader) ----- BR2 HOST +# | | +# | | +# Router_1------------+ +# + +BR_1 = 1 +BR_2 = 2 +ROUTER_1 = 3 +HOST = 4 + +REG_DELAY = 10 + + +class MATN_04_MulticastListenerTimeout(thread_cert.TestCase): + USE_MESSAGE_FACTORY = False + + TOPOLOGY = { + BR_1: { + 'name': 'BR_1', + 'is_otbr': True, + 'allowlist': [BR_2, ROUTER_1], + 'version': '1.2', + 'router_selection_jitter': 2, + }, + BR_2: { + 'name': 'BR_2', + 'allowlist': [BR_1, ROUTER_1], + 'is_otbr': True, + 'version': '1.2', + 'router_selection_jitter': 2, + }, + ROUTER_1: { + 'name': 'Router_1', + 'allowlist': [BR_1, BR_2], + 'version': '1.2', + 'router_selection_jitter': 2, + }, + HOST: { + 'name': 'Host', + 'is_host': True + }, + } + + def test(self): + br1 = self.nodes[BR_1] + br2 = self.nodes[BR_2] + router = self.nodes[ROUTER_1] + host = self.nodes[HOST] + + br1.set_backbone_router(reg_delay=REG_DELAY, mlr_timeout=consts.MLR_TIMEOUT_MIN) + br1.start() + self.simulator.go(5) + self.assertEqual('leader', br1.get_state()) + self.assertTrue(br1.is_primary_backbone_router) + + router.start() + self.simulator.go(5) + self.assertEqual('router', router.get_state()) + + br2.start() + self.simulator.go(5) + self.assertEqual('router', br2.get_state()) + self.assertFalse(br2.is_primary_backbone_router) + + host.start(start_radvd=False) + self.simulator.go(10) + + # Router_1 registers for multicast address, MA1, at BR_1. + router.add_ipmaddr(MA1) + self.simulator.go(5) + + # 1. Host sends a ping packet to the multicast address, MA1. + self.assertTrue( + host.ping(MA1, backbone=True, ttl=10, interface=host.get_ip6_address(config.ADDRESS_TYPE.ONLINK_ULA)[0])) + self.simulator.go(5) + + # 3a. By internal means, Router_1 stop listening to the multicast + # address, MA1. + router.del_ipmaddr(MA1) + + # 4. After (MLR_TIMEOUT_MIN+2) seconds + self.simulator.go(consts.MLR_TIMEOUT_MIN + 2) + + # 5. Host sends a ping packet to the multicast address, MA1. + self.assertFalse( + host.ping(MA1, backbone=True, ttl=10, interface=host.get_ip6_address(config.ADDRESS_TYPE.ONLINK_ULA)[0])) + self.simulator.go(5) + + # 6a. Router_1 registers for multicast address, MA1, at BR_1. + router.add_ipmaddr(MA1) + self.simulator.go(5) + + # 7. Host sends a ping packet to MA1. + self.assertTrue( + host.ping(MA1, backbone=True, ttl=10, interface=host.get_ip6_address(config.ADDRESS_TYPE.ONLINK_ULA)[0])) + + self.collect_ipaddrs() + self.collect_rloc16s() + self.collect_rlocs() + self.collect_leader_aloc(BR_1) + self.collect_extra_vars() + + def verify(self, pv: pktverify.packet_verifier.PacketVerifier): + pkts = pv.pkts + vars = pv.vars + pv.summary.show() + + # Ensure the topology is formed correctly + pv.verify_attached('Router_1', 'BR_1') + pv.verify_attached('BR_2') + + # 1. Host sends a ping packet to the multicast address, MA1. + _pkt = pkts.filter_eth_src(vars['Host_ETH']) \ + .filter_ipv6_dst(MA1) \ + .filter_ping_request() \ + .must_next() + + # 2. BR_1 forwards the ping packet with multicast address, MA1, to its + # Thread Network encapsulated in an MPL packet. + pkts.filter_wpan_src64(vars['BR_1']) \ + .filter_AMPLFMA(vars['BR_1_RLOC']) \ + .filter_ping_request(identifier=_pkt.icmpv6.echo.identifier) \ + .must_next() + + # 3. Router_1 receives the MPL packet containing an encapsulated ping + # packet to MA1, sent by Host, and unicasts a ping response packet back + # to Host. + pkts.filter_wpan_src64(vars['Router_1']) \ + .filter_ipv6_dst(_pkt.ipv6.src) \ + .filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier) \ + .must_next() + + # 4. After (MLR_TIMEOUT_MIN+2) seconds, BR_1 multicasts an MLDv2 message + # of type “Version 2 Multicast Listener Report” (see [RFC 3810] Section + # 5.2) + # TODO + + # 5. Host sends a ping packet to the multicast address, MA1. + _pkt = pkts.filter_eth_src(vars['Host_ETH']) \ + .filter_ipv6_dst(MA1) \ + .filter_ping_request() \ + .must_next() + + # 6. BR_1 does not forward the ping packet with multicast address, MA1, + # to its Thread Network. + pkts.filter_wpan_src64(vars['BR_1']) \ + .filter_AMPLFMA(vars['BR_1_RLOC']) \ + .filter_ping_request(identifier=_pkt.icmpv6.echo.identifier) \ + .must_not_next() + + # 7. Host sends a ping packet to the multicast address, MA1. + _pkt = pkts.filter_eth_src(vars['Host_ETH']) \ + .filter_ipv6_dst(MA1) \ + .filter_ping_request() \ + .must_next() + + # 8. BR_1 forwards the ping packet with multicast address, MA1, to its + # Thread Network encapsulated in an MPL packet. + pkts.filter_wpan_src64(vars['BR_1']) \ + .filter_AMPLFMA(vars['BR_1_RLOC']) \ + .filter_ping_request(identifier=_pkt.icmpv6.echo.identifier) \ + .must_next() + + # 9. Router_1 receives the MPL packet containing an encapsulated ping + # packet to MA1, sent by Host, and unicasts a ping response packet back + # to Host. + pkts.filter_wpan_src64(vars['Router_1']) \ + .filter_ipv6_dst(_pkt.ipv6.src) \ + .filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier) \ + .must_next() + + +if __name__ == '__main__': + unittest.main() diff --git a/tests/scripts/thread-cert/pktverify/consts.py b/tests/scripts/thread-cert/pktverify/consts.py index 114440a59..02e39721d 100644 --- a/tests/scripts/thread-cert/pktverify/consts.py +++ b/tests/scripts/thread-cert/pktverify/consts.py @@ -59,6 +59,9 @@ DEFAULT_MESH_LOCAL_PREFIX = Bytes("fd00:0db8:0000:0000") LEADER_ALOC_IID = Bytes("0000:00ff:fe00:fc00") LEADER_ALOC = Ipv6Addr(DEFAULT_MESH_LOCAL_PREFIX + LEADER_ALOC_IID) +# Minimum value of the MLR Timeout parameter in the BBR Dataset +MLR_TIMEOUT_MIN = 300 + # Max response delay MLE_MAX_RESPONSE_DELAY = 1