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_CHILD_ID_REQUEST
35from pktverify.packet_verifier import PacketVerifier
36
37LEADER = 1
38ED = 2
39
40
41class Cert_6_6_2_KeyIncrement1(thread_cert.TestCase):
42    TOPOLOGY = {
43        LEADER: {
44            'name': 'LEADER',
45            'key_sequence_counter': 127,
46            'key_switch_guardtime': 0,
47            'mode': 'rdn',
48            'allowlist': [ED]
49        },
50        ED: {
51            'name': 'ED',
52            'is_mtd': True,
53            'key_switch_guardtime': 0,
54            'mode': 'rn',
55            'allowlist': [LEADER]
56        },
57    }
58
59    def test(self):
60        self.nodes[LEADER].start()
61        self.simulator.go(config.LEADER_STARTUP_DELAY)
62        self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
63
64        self.nodes[ED].start()
65        self.simulator.go(5)
66        self.assertEqual(self.nodes[ED].get_state(), 'child')
67
68        self.collect_rloc16s()
69        addrs = self.nodes[ED].get_addrs()
70        for addr in addrs:
71            self.assertTrue(self.nodes[LEADER].ping(addr))
72
73        key_sequence_counter = self.nodes[LEADER].get_key_sequence_counter()
74        self.nodes[LEADER].set_key_sequence_counter(key_sequence_counter + 1)
75
76        addrs = self.nodes[ED].get_addrs()
77        for addr in addrs:
78            self.assertTrue(self.nodes[LEADER].ping(addr))
79
80    def verify(self, pv):
81        pkts = pv.pkts
82        pv.summary.show()
83
84        LEADER = pv.vars['LEADER']
85        ED = pv.vars['ED']
86        _leader_pkts = pkts.filter_wpan_src64(LEADER)
87        _ed_pkts = pkts.filter_wpan_src64(ED)
88
89        # Step 1: The DUT must start the network using
90        # thrKeySequenceCounter = 127
91        _leader_pkts.filter_mle_cmd(MLE_ADVERTISEMENT).must_next().must_verify(
92            lambda p: p.wpan.aux_sec.key_source == 127)
93
94        # Step 2: Verify that the topology described above is created.
95        # MLE Auxiliary security header shall contain Key Source = 127,
96        # KeyIndex = 128, KeyID Mode = 2
97        _ed_pkts.filter_mle_cmd(
98            MLE_CHILD_ID_REQUEST).must_next().must_verify(lambda p: p.wpan.aux_sec.key_index == 128 and p.wpan.aux_sec.
99                                                          key_id_mode == 2 and p.wpan.aux_sec.key_source == 127)
100
101        # Step 3: Leader send an ICMPv6 Echo Request to DUT.
102        # The MAC Auxiliary security header must contain
103        # KeyIndex = 128, KeyID Mode = 1
104        lp = _leader_pkts.filter_ping_request().filter(
105            lambda p: p.wpan.aux_sec.key_index == 128 and p.wpan.aux_sec.key_id_mode == 1 and p.wpan.dst16 == pv.vars[
106                'ED_RLOC16']).must_next()
107
108        # Step 4: DUT send an ICMPv6 Echo Reply to Leader.
109        # The MAC Auxiliary security header must contain
110        # KeyIndex = 128, KeyID Mode = 1
111        _ed_pkts.filter_ping_reply(identifier=lp.icmpv6.echo.identifier).must_next().must_verify(
112            lambda p: p.wpan.aux_sec.key_index == 128 and p.wpan.aux_sec.key_id_mode == 1)
113
114        # Step 5: Leader increment thrKeySequenceCounter by 1 to force a key switch.
115        # Step 6: Leader Send an ICMPv6 Echo Request to DUT.
116        # The MAC Auxiliary security header must contain
117        # KeyIndex = 1, KeyID Mode = 1
118        lp = _leader_pkts.filter_ping_request().filter(
119            lambda p: p.wpan.aux_sec.key_index == 1 and p.wpan.aux_sec.key_id_mode == 1 and p.wpan.dst16 == pv.vars[
120                'ED_RLOC16']).must_next()
121
122        # Step 7: DUT send an ICMPv6 Echo Reply to Leader.
123        # The MAC Auxiliary security header must contain
124        # KeyIndex = 1, KeyID Mode = 1
125        _ed_pkts.filter_ping_reply(identifier=lp.icmpv6.echo.identifier).must_next().must_verify(
126            lambda p: p.wpan.aux_sec.key_index == 1 and p.wpan.aux_sec.key_id_mode == 1)
127
128
129if __name__ == '__main__':
130    unittest.main()
131