xref: /freebsd/tests/sys/netpfil/pf/mld.py (revision 24e4dcf4ba5e9dedcf89efd358ea3e1fe5867020)
1#
2# SPDX-License-Identifier: BSD-2-Clause
3#
4# Copyright (c) 2025 Rubicon Communications, LLC (Netgate)
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions
8# are met:
9# 1. Redistributions of source code must retain the above copyright
10#    notice, this list of conditions and the following disclaimer.
11# 2. Redistributions in binary form must reproduce the above copyright
12#    notice, this list of conditions and the following disclaimer in the
13#    documentation and/or other materials provided with the distribution.
14#
15# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25# SUCH DAMAGE.
26
27import pytest
28from utils import DelayedSend
29from atf_python.sys.net.tools import ToolsHelper
30from atf_python.sys.net.vnet import VnetTestTemplate
31
32class TestMLD(VnetTestTemplate):
33    REQUIRED_MODULES = [ "pf" ]
34    TOPOLOGY = {
35        "vnet1": {"ifaces": ["if1"]},
36        "vnet2": {"ifaces": ["if1"]},
37        "if1": {"prefixes6": [("2001:db8::2/64", "2001:db8::1/64")]},
38    }
39
40    def vnet2_handler(self, vnet):
41        ifname = vnet.iface_alias_map["if1"].name
42        #ToolsHelper.print_output("/sbin/pfctl -e")
43        ToolsHelper.pf_rules([
44            "pass",
45            ])
46        ToolsHelper.print_output("/sbin/pfctl -x loud")
47        #ToolsHelper.print_output("echo \"j 230.0.0.1 %s\ns 3600\nq\" | /usr/sbin/mtest" % ifname)
48
49    def find_mld_reply(self, pkt, ifname):
50        pkt.show()
51        s = DelayedSend(pkt)
52
53        found = False
54        packets = self.sp.sniff(iface=ifname, timeout=5)
55        for r in packets:
56            r.show()
57            mld = r.getlayer(self.sp.ICMPv6MLReport2)
58            if not mld:
59                continue
60            mld.show()
61            found = True
62        return found
63
64    @pytest.mark.require_user("root")
65    @pytest.mark.require_progs(["scapy"])
66    def test_router_alert(self):
67        """Verify that we allow MLD packets with router alert extension header"""
68        ifname = self.vnet.iface_alias_map["if1"].name
69        #ToolsHelper.print_output("/sbin/ifconfig %s inet6 -ifdisable" % ifname)
70        ToolsHelper.print_output("/sbin/ifconfig")
71
72        # Import in the correct vnet, so at to not confuse Scapy
73        import scapy.all as sp
74        import scapy.contrib as sc
75        import scapy.contrib.igmp
76        self.sp = sp
77        self.sc = sc
78
79        # A correct MLD query gets a reply
80        pkt = sp.IPv6(src="fe80::1%%%s" % ifname, dst="ff02::1", hlim=1) \
81            / sp.RouterAlert(value=0) \
82            / sp.ICMPv6MLQuery2()
83        assert self.find_mld_reply(pkt, ifname)
84
85        # The wrong extension header does not
86        pkt = sp.IPv6(src="fe80::1%%%s" % ifname, dst="ff02::1", hlim=1) \
87            / sp.IPv6ExtHdrRouting() \
88            / sp.ICMPv6MLQuery2()
89        assert not self.find_mld_reply(pkt, ifname)
90
91        # Neither does an incorrect hop limit
92        pkt = sp.IPv6(src="fe80::1%%%s" % ifname, dst="ff02::1", hlim=2) \
93            / sp.RouterAlert(value=0) \
94            / sp.ICMPv6MLQuery2()
95        assert not self.find_mld_reply(pkt, ifname)
96