1#!/usr/bin/env python3
2#
3#  Copyright (c) 2016, The OpenThread Authors.
4#  All rights reserved.
5#
6#  Redistribution and use in source and binary forms, with or without
7#  modification, are permitted provided that the following conditions are met:
8#  1. Redistributions of source code must retain the above copyright
9#     notice, this list of conditions and the following disclaimer.
10#  2. Redistributions in binary form must reproduce the above copyright
11#     notice, this list of conditions and the following disclaimer in the
12#     documentation and/or other materials provided with the distribution.
13#  3. Neither the name of the copyright holder nor the
14#     names of its contributors may be used to endorse or promote products
15#     derived from this software without specific prior written permission.
16#
17#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27#  POSSIBILITY OF SUCH DAMAGE.
28#
29
30import unittest
31
32import config
33import thread_cert
34from pktverify.consts import MLE_ADVERTISEMENT, MLE_DATA_RESPONSE, MLE_CHILD_ID_RESPONSE, MLE_CHILD_UPDATE_REQUEST, ADDR_SOL_URI, MLE_CHILD_UPDATE_RESPONSE, MODE_TLV, LEADER_DATA_TLV, ROUTE64_TLV, SOURCE_ADDRESS_TLV, ACTIVE_TIMESTAMP_TLV, ADDRESS16_TLV, NETWORK_DATA_TLV, ADDRESS_REGISTRATION_TLV, LINK_LOCAL_ALL_NODES_MULTICAST_ADDRESS
35from pktverify.packet_verifier import PacketVerifier
36from pktverify.addrs import Ipv6Addr
37
38LEADER = 1
39ROUTER = 2
40ED1 = 3
41SED1 = 4
42
43MTDS = [ED1, SED1]
44
45
46class Cert_5_6_3_NetworkDataRegisterAfterAttachLeader(thread_cert.TestCase):
47    TOPOLOGY = {
48        LEADER: {
49            'name': 'LEADER',
50            'mode': 'rdn',
51            'allowlist': [ROUTER]
52        },
53        ROUTER: {
54            'name': 'ROUTER',
55            'mode': 'rdn',
56            'allowlist': [LEADER, ED1, SED1]
57        },
58        ED1: {
59            'name': 'MED',
60            'is_mtd': True,
61            'mode': 'rn',
62            'allowlist': [ROUTER]
63        },
64        SED1: {
65            'name': 'SED',
66            'is_mtd': True,
67            'mode': '-',
68            'timeout': config.DEFAULT_CHILD_TIMEOUT,
69            'allowlist': [ROUTER]
70        },
71    }
72
73    def test(self):
74        self.nodes[LEADER].start()
75        self.simulator.go(config.LEADER_STARTUP_DELAY)
76        self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
77
78        self.nodes[ROUTER].start()
79        self.simulator.go(config.ROUTER_STARTUP_DELAY)
80        self.assertEqual(self.nodes[ROUTER].get_state(), 'router')
81
82        self.nodes[ED1].start()
83        self.simulator.go(5)
84        self.assertEqual(self.nodes[ED1].get_state(), 'child')
85
86        self.nodes[SED1].start()
87        self.simulator.go(5)
88        self.assertEqual(self.nodes[SED1].get_state(), 'child')
89
90        self.nodes[LEADER].add_prefix('2001:2:0:1::/64', 'paros')
91        self.nodes[LEADER].add_prefix('2001:2:0:2::/64', 'paro')
92        self.nodes[LEADER].register_netdata()
93
94        # Set lowpan context of sniffer
95        self.simulator.set_lowpan_context(1, '2001:2:0:1::/64')
96        self.simulator.set_lowpan_context(2, '2001:2:0:2::/64')
97
98        self.simulator.go(10)
99
100        addrs = self.nodes[ED1].get_addrs()
101        self.assertTrue(any('2001:2:0:1' in addr[0:10] for addr in addrs))
102        self.assertTrue(any('2001:2:0:2' in addr[0:10] for addr in addrs))
103        for addr in addrs:
104            if addr[0:10] == '2001:2:0:1' or addr[0:10] == '2001:2:0:2':
105                self.assertTrue(self.nodes[LEADER].ping(addr))
106
107        addrs = self.nodes[SED1].get_addrs()
108        self.assertTrue(any('2001:2:0:1' in addr[0:10] for addr in addrs))
109        self.assertFalse(any('2001:2:0:2' in addr[0:10] for addr in addrs))
110        for addr in addrs:
111            if addr[0:10] == '2001:2:0:1' or addr[0:10] == '2001:2:0:2':
112                self.assertTrue(self.nodes[LEADER].ping(addr))
113
114    def verify(self, pv):
115        pkts = pv.pkts
116        pv.summary.show()
117
118        ROUTER = pv.vars['ROUTER']
119        MED = pv.vars['MED']
120        SED = pv.vars['SED']
121        _rpkts = pkts.filter_wpan_src64(ROUTER)
122
123        _rpkts_med = _rpkts.copy()
124        _rpkts_sed = _rpkts.copy()
125
126        # Step 3: The DUT MUST multicast a MLE Data Response for each
127        # prefix sent by the Leader (Prefix 1 and Prefix 2)
128        _rpkts.filter_mle_cmd(MLE_DATA_RESPONSE).filter_ipv6_dst(LINK_LOCAL_ALL_NODES_MULTICAST_ADDRESS).must_next(
129        ).must_verify(lambda p: {Ipv6Addr('2001:2:0:1::'), Ipv6Addr('2001:2:0:2::')} == set(p.thread_nwd.tlv.prefix)
130                      and p.thread_nwd.tlv.border_router.flag.p == [1, 1] and p.thread_nwd.tlv.border_router.flag.s ==
131                      [1, 1] and p.thread_nwd.tlv.border_router.flag.r == [1, 1] and p.thread_nwd.tlv.border_router.
132                      flag.o == [1, 1] and p.thread_nwd.tlv.stable == [0, 1, 1, 1, 0, 0, 0])
133
134        # Step 5: The DUT MUST send a unicast MLE Child Update
135        # Response to MED_1
136        _rpkts_med.filter_mle_cmd(MLE_CHILD_UPDATE_RESPONSE).filter_wpan_dst64(MED).must_next().must_verify(
137            lambda p: {SOURCE_ADDRESS_TLV, MODE_TLV, LEADER_DATA_TLV, ADDRESS_REGISTRATION_TLV} <= set(p.mle.tlv.type))
138
139        # Step 6: The DUT MUST send a unicast MLE Child Update
140        # Request to SED_1
141        _rpkts_sed.filter_mle_cmd(MLE_CHILD_UPDATE_REQUEST).filter_wpan_dst64(SED).must_next().must_verify(
142            lambda p: {SOURCE_ADDRESS_TLV, LEADER_DATA_TLV, NETWORK_DATA_TLV, ACTIVE_TIMESTAMP_TLV} <= set(
143                p.mle.tlv.type) and {Ipv6Addr('2001:2:0:1::')} == set(p.thread_nwd.tlv.prefix) and p.thread_nwd.tlv.
144            border_router.flag.p == [1] and p.thread_nwd.tlv.border_router.flag.s == [1] and p.thread_nwd.tlv.
145            border_router.flag.r == [1] and p.thread_nwd.tlv.border_router.flag.o == [1] and p.thread_nwd.tlv.stable ==
146            [1, 1, 1] and p.thread_nwd.tlv.border_router_16 == [0xFFFE])
147
148        # Step 8: The DUT MUST send a unicast MLE Child Update
149        # Response to SED_1
150        _rpkts_sed.filter_mle_cmd(MLE_CHILD_UPDATE_RESPONSE).filter_wpan_dst64(SED).must_next().must_verify(
151            lambda p: {SOURCE_ADDRESS_TLV, MODE_TLV, LEADER_DATA_TLV, ADDRESS_REGISTRATION_TLV} <= set(p.mle.tlv.type))
152
153
154if __name__ == '__main__':
155    unittest.main()
156