• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_PARENT_REQUEST, MLE_CHILD_ID_RESPONSE, MLE_CHILD_ID_REQUEST, MGMT_ACTIVE_SET_URI, MGMT_ACTIVE_GET_URI, RESPONSE_TLV, LINK_LAYER_FRAME_COUNTER_TLV, MODE_TLV, TIMEOUT_TLV, VERSION_TLV, TLV_REQUEST_TLV, CHALLENGE_TLV, SCAN_MASK_TLV, ADDRESS_REGISTRATION_TLV
35from pktverify.packet_verifier import PacketVerifier
36
37CHANNEL_INIT = 19
38PANID_INIT = 0xface
39
40NETWORK_NAME_FINAL = 'threadCert'
41PANID_FINAL = 0xabcd
42
43COMMISSIONER = 1
44LEADER = 2
45ROUTER1 = 3
46ROUTER2 = 4
47
48
49class Cert_9_2_16_ActivePendingPartition(thread_cert.TestCase):
50    SUPPORT_NCP = False
51
52    TOPOLOGY = {
53        COMMISSIONER: {
54            'name': 'COMMISSIONER',
55            'active_dataset': {
56                'timestamp': 1,
57                'panid': PANID_INIT,
58                'channel': CHANNEL_INIT
59            },
60            'mode': 'rdn',
61            'allowlist': [LEADER]
62        },
63        LEADER: {
64            'name': 'LEADER',
65            'active_dataset': {
66                'timestamp': 1,
67                'panid': PANID_INIT,
68                'channel': CHANNEL_INIT
69            },
70            'mode': 'rdn',
71            'partition_id': 0xffffffff,
72            'allowlist': [COMMISSIONER, ROUTER1]
73        },
74        ROUTER1: {
75            'name': 'ROUTER_1',
76            'active_dataset': {
77                'timestamp': 1,
78                'panid': PANID_INIT,
79                'channel': CHANNEL_INIT
80            },
81            'mode': 'rdn',
82            'allowlist': [LEADER, ROUTER2]
83        },
84        ROUTER2: {
85            'name': 'ROUTER_2',
86            'active_dataset': {
87                'timestamp': 1,
88                'panid': PANID_INIT,
89                'channel': CHANNEL_INIT
90            },
91            'mode': 'rdn',
92            'allowlist': [ROUTER1]
93        },
94    }
95
96    def _setUpRouter2(self):
97        self.nodes[ROUTER2].add_allowlist(self.nodes[ROUTER1].get_addr64())
98        self.nodes[ROUTER2].enable_allowlist()
99        self.nodes[ROUTER2].set_router_selection_jitter(1)
100
101    def test(self):
102        self.nodes[LEADER].start()
103        self.simulator.go(config.LEADER_STARTUP_DELAY)
104        self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
105
106        self.nodes[COMMISSIONER].start()
107        self.simulator.go(config.ROUTER_STARTUP_DELAY)
108        self.assertEqual(self.nodes[COMMISSIONER].get_state(), 'router')
109        self.nodes[COMMISSIONER].commissioner_start()
110        self.simulator.go(3)
111
112        self.nodes[ROUTER1].start()
113        self.simulator.go(config.ROUTER_STARTUP_DELAY)
114        self.assertEqual(self.nodes[ROUTER1].get_state(), 'router')
115
116        self.nodes[COMMISSIONER].send_mgmt_pending_set(
117            pending_timestamp=10,
118            active_timestamp=10,
119            delay_timer=600000,
120            mesh_local='fd00:0db9::',
121        )
122        self.simulator.go(5)
123
124        self.nodes[ROUTER2].start()
125        self.simulator.go(config.ROUTER_STARTUP_DELAY)
126        self.assertEqual(self.nodes[ROUTER2].get_state(), 'router')
127
128        self.nodes[ROUTER2].reset()
129        self._setUpRouter2()
130        self.simulator.go(100)
131
132        self.nodes[COMMISSIONER].send_mgmt_pending_set(
133            pending_timestamp=20,
134            active_timestamp=20,
135            delay_timer=200000,
136            mesh_local='fd00:0db7::',
137            panid=PANID_FINAL,
138        )
139        self.simulator.go(5)
140
141        self.nodes[COMMISSIONER].send_mgmt_active_set(active_timestamp=15, network_name='threadCert')
142        self.simulator.go(100)
143
144        self.nodes[ROUTER2].start()
145        self.simulator.go(config.ROUTER_RESET_DELAY)
146        self.assertEqual(self.nodes[ROUTER2].get_state(), 'router')
147
148        self.assertEqual(self.nodes[COMMISSIONER].get_network_name(), NETWORK_NAME_FINAL)
149        self.assertEqual(self.nodes[LEADER].get_network_name(), NETWORK_NAME_FINAL)
150        self.assertEqual(self.nodes[ROUTER1].get_network_name(), NETWORK_NAME_FINAL)
151        self.assertEqual(self.nodes[ROUTER2].get_network_name(), NETWORK_NAME_FINAL)
152
153        self.simulator.go(100)
154
155        self.assertEqual(self.nodes[COMMISSIONER].get_panid(), PANID_FINAL)
156        self.assertEqual(self.nodes[LEADER].get_panid(), PANID_FINAL)
157        self.assertEqual(self.nodes[ROUTER1].get_panid(), PANID_FINAL)
158        self.assertEqual(self.nodes[ROUTER2].get_panid(), PANID_FINAL)
159
160        ipaddrs = self.nodes[ROUTER2].get_addrs()
161        for ipaddr in ipaddrs:
162            if ipaddr[0:4] != 'fe80':
163                break
164        self.assertTrue(self.nodes[LEADER].ping(ipaddr))
165
166    def verify(self, pv):
167        pkts = pv.pkts
168        pv.summary.show()
169
170        LEADER = pv.vars['LEADER']
171        COMMISSIONER = pv.vars['COMMISSIONER']
172        ROUTER_1 = pv.vars['ROUTER_1']
173        ROUTER_2 = pv.vars['ROUTER_2']
174        _router2_pkts = pkts.filter_wpan_src64(ROUTER_2)
175
176        # Step 1: Ensure the topology is formed correctly
177        # Verify Commissioner, Leader and Router_1 are sending MLE advertisements
178        pkts.copy().filter_wpan_src64(LEADER).filter_mle_cmd(MLE_ADVERTISEMENT).must_next()
179        pkts.filter_wpan_dst64(COMMISSIONER).filter_mle_cmd(MLE_CHILD_ID_RESPONSE).must_next()
180        pkts.copy().filter_wpan_src64(COMMISSIONER).filter_mle_cmd(MLE_ADVERTISEMENT).must_next()
181        pkts.filter_wpan_dst64(ROUTER_1).filter_mle_cmd(MLE_CHILD_ID_RESPONSE).must_next()
182        pkts.copy().filter_wpan_src64(ROUTER_1).filter_mle_cmd(MLE_ADVERTISEMENT).must_next()
183
184        # Step 5: Router_2 begins attach process by sending a multicast MLE Parent Request
185        # The first MLE Parent Request sent MUST NOT be sent to all routers and REEDS
186        _router2_pkts.range(pkts.index).filter_mle_cmd(MLE_PARENT_REQUEST).must_next().must_verify(
187            lambda p: {MODE_TLV, CHALLENGE_TLV, SCAN_MASK_TLV, VERSION_TLV} <= set(
188                p.mle.tlv.type) and p.mle.tlv.scan_mask.r == 1 and p.mle.tlv.scan_mask.e == 0)
189
190        # Step 7: Router_2  MUST send a MLE Child ID Request to Router_1
191        _router2_pkts.filter_mle_cmd(MLE_CHILD_ID_REQUEST).must_next().must_verify(lambda p: {
192            RESPONSE_TLV, LINK_LAYER_FRAME_COUNTER_TLV, MODE_TLV, TIMEOUT_TLV, VERSION_TLV, TLV_REQUEST_TLV
193        } <= set(p.mle.tlv.type) and ADDRESS_REGISTRATION_TLV not in p.mle.tlv.type)
194
195        # Step 14: Router_2 begins attach process by sending a multicast MLE Parent Request
196        # The first MLE Parent Request sent MUST NOT be sent to all routers and REEDS
197        _router2_pkts.filter_mle_cmd(MLE_PARENT_REQUEST).must_next().must_verify(
198            lambda p: {MODE_TLV, CHALLENGE_TLV, SCAN_MASK_TLV, VERSION_TLV} <= set(
199                p.mle.tlv.type) and p.mle.tlv.scan_mask.r == 1 and p.mle.tlv.scan_mask.e == 0)
200
201        # Step 16: Router_2 MUST send a MLE Child ID Request to Router_1
202        _router2_pkts.filter_mle_cmd(MLE_CHILD_ID_REQUEST).must_next().must_verify(lambda p: {
203            RESPONSE_TLV, LINK_LAYER_FRAME_COUNTER_TLV, MODE_TLV, TIMEOUT_TLV, VERSION_TLV, TLV_REQUEST_TLV
204        } <= set(p.mle.tlv.type) and ADDRESS_REGISTRATION_TLV not in p.mle.tlv.type)
205
206
207if __name__ == '__main__':
208    unittest.main()
209