#!/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.null_field import nullField


def verify(pv):
    pkts = pv.pkts
    pv.summary.show()

    LEADER = pv.vars['LEADER']
    REED = pv.vars['REED_1']
    DUT = pv.vars['DUT']

    # Step 1: All
    # - Description: Begin wireless sniffer and ensure the Leader is sending MLE Advertisements and is connected to
    #    REED_1.
    # - Pass Criteria: N/A
    print("Step 1: All")

    # Step 2: ED_1 / SED_1 (DUT)
    # - Description: Automatically begins attach process by sending multicast MLE Parent Requests.
    # - Pass Criteria:
    #    - The DUT MUST send a MLE Parent Request to the Link-Local All-Routers multicast address (FF02::2) with an IP
    #      Hop Limit of 255.
    #    - The following TLVs MUST be present in the Parent Request:
    #      - Challenge TLV
    #      - Mode TLV
    #      - Scan Mask TLV (Value = 0x80 [active Routers])
    #      - Version TLV
    #    - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header MUST be set
    #      to ‘0x02’.
    print("Step 2: ED_1 / SED_1 (DUT)")
    pkts.filter_wpan_src64(DUT).\
      filter_LLARMA().\
      filter_mle_cmd(consts.MLE_PARENT_REQUEST).\
      filter(lambda p: p.mle.tlv.scan_mask.r == 1).\
      filter(lambda p: p.mle.tlv.scan_mask.e == 0).\
      filter(lambda p: {
        consts.CHALLENGE_TLV,
        consts.MODE_TLV,
        consts.SCAN_MASK_TLV,
        consts.VERSION_TLV
      } <= set(p.mle.tlv.type)).\
      filter(lambda p: p.ipv6.hlim == 255).\
      filter(lambda p: p.wpan.aux_sec.key_id_mode == 0x02).\
      must_next()

    # Step 3: REED_1
    # - Description: Does not respond to Parent Request.
    # - Pass Criteria: N/A
    print("Step 3: REED_1")

    # Step 4: ED_1 / SED_1 (DUT)
    # - Description: Automatically sends MLE Parent Request with Scan Mask TLV set to Routers and REEDs.
    # - Pass Criteria:
    #    - The DUT MUST send a MLE Parent Request to the Link-Local All-Routers multicast address (FF02::2) with an IP
    #      Hop Limit of 255.
    #    - The following TLVs MUST be present in the Parent Request:
    #      - Challenge TLV
    #      - Mode TLV
    #      - Scan Mask TLV (Value = 0xC0 [Routers and REEDs])
    #      - Version TLV
    #    - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header MUST be set
    #      to ‘0x02’.
    print("Step 4: ED_1 / SED_1 (DUT)")
    pkts.filter_wpan_src64(DUT).\
      filter_LLARMA().\
      filter_mle_cmd(consts.MLE_PARENT_REQUEST).\
      filter(lambda p: p.mle.tlv.scan_mask.r == 1).\
      filter(lambda p: p.mle.tlv.scan_mask.e == 1).\
      filter(lambda p: {
        consts.CHALLENGE_TLV,
        consts.MODE_TLV,
        consts.SCAN_MASK_TLV,
        consts.VERSION_TLV
      } <= set(p.mle.tlv.type)).\
      filter(lambda p: p.ipv6.hlim == 255).\
      filter(lambda p: p.wpan.aux_sec.key_id_mode == 0x02).\
      must_next()

    # Step 5: REED_1
    # - Description: Automatically responds with MLE Parent Response.
    # - Pass Criteria: N/A
    print("Step 5: REED_1")

    # Step 6: ED_1 / SED_1 (DUT)
    # - Description: Automatically sends MLE Child ID Request in response.
    # - Pass Criteria:
    #    - The DUT MUST send an MLE Child ID Request containing the following TLVs:
    #      - Address Registration TLV
    #      - Link-layer Frame Counter TLV
    #      - Mode TLV
    #      - Response TLV
    #      - Timeout TLV
    #      - Version TLV
    #      - TLV Request TLV (Address16 TLV, Network Data TLV, Route64 TLV [optional])
    #      - MLE Frame Counter TLV (optional)
    #    - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header MUST be set
    #      to ‘0x02’.
    print("Step 6: ED_1 / SED_1 (DUT)")
    pkts.filter_wpan_src64(DUT).\
      filter_wpan_dst64(REED).\
      filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\
      filter(lambda p: {
        consts.ADDRESS_REGISTRATION_TLV,
        consts.LINK_LAYER_FRAME_COUNTER_TLV,
        consts.MODE_TLV,
        consts.RESPONSE_TLV,
        consts.TIMEOUT_TLV,
        consts.VERSION_TLV,
        consts.TLV_REQUEST_TLV,
        consts.ADDRESS16_TLV,
        consts.NETWORK_DATA_TLV
      } <= set(p.mle.tlv.type) and \
      p.mle.tlv.addr16 is nullField and \
      p.thread_nwd.tlv.type is nullField).\
      filter(lambda p: p.wpan.aux_sec.key_id_mode == 0x02).\
      must_next()

    # Step 7: REED_1
    # - Description: Automatically sends an Address Solicit Request to the Leader. Leader automatically responds with
    #    an Address Solicit Response and REED_1 becomes an active router. REED_1 automatically sends a MLE Child ID
    #    Response with DUT’s new 16-bit Address.
    # - Pass Criteria: N/A
    print("Step 7: REED_1")

    # Step 8: ED_1 (DUT)
    # Step 10: SED_1 (DUT)
    # We check for either Child Update Request (ED) or Data Request (SED)
    print("Step 8/10: Keep-alive")
    pkts.filter(lambda p: (hasattr(p, 'mle') and p.mle.cmd == consts.MLE_CHILD_UPDATE_REQUEST) or
                          (hasattr(p, 'wpan') and p.wpan.cmd == consts.WPAN_DATA_REQUEST)).\
      filter_wpan_src64(DUT).\
      must_next()

    # Step 11: REED_1
    # - Description: Harness verifies connectivity by instructing the device to send an ICMPv6 Echo Request to the DUT
    #    link-local address.
    # - Pass Criteria:
    #    - The DUT MUST respond with ICMPv6 Echo Reply.
    print("Step 11: REED_1")
    _pkt = pkts.filter_ping_request().\
      filter_wpan_src64(REED).\
      filter_wpan_dst64(DUT).\
      must_next()
    pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
      filter_wpan_src64(DUT).\
      filter_wpan_dst64(REED).\
      must_next()


if __name__ == '__main__':
    verify_utils.run_main(verify)
