xref: /freebsd/tests/sys/common/divert.py (revision d0b2dbfa)
1#!/usr/bin/env python
2# -
3# SPDX-License-Identifier: BSD-2-Clause
4#
5# Copyright (c) 2020 Alexander V. Chernikov
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions
9# are met:
10# 1. Redistributions of source code must retain the above copyright
11#    notice, this list of conditions and the following disclaimer.
12# 2. Redistributions in binary form must reproduce the above copyright
13#    notice, this list of conditions and the following disclaimer in the
14#    documentation and/or other materials provided with the distribution.
15#
16# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26# SUCH DAMAGE.
27#
28#
29
30
31from socket import socket, PF_DIVERT, SOCK_RAW
32import logging
33logging.getLogger("scapy").setLevel(logging.CRITICAL)
34import scapy.all as sc
35import argparse
36
37
38def parse_args():
39    parser = argparse.ArgumentParser(description='divert socket tester')
40    parser.add_argument('--dip', type=str, help='destination packet IP')
41    parser.add_argument('--sip', type=str, help='source packet IP')
42    parser.add_argument('--divert_port', type=int, default=6668,
43                        help='divert port to use')
44    parser.add_argument('--test_name', type=str, required=True,
45                        help='test name to run')
46    return parser.parse_args()
47
48
49def ipdivert_ip_output_remote_success(args):
50    packet = sc.IP(dst=args.dip) / sc.ICMP(type='echo-request')
51    with socket(PF_DIVERT, SOCK_RAW, 0) as s:
52        s.bind(('0.0.0.0', args.divert_port))
53        s.sendto(bytes(packet), ('0.0.0.0', 0))
54
55
56def ipdivert_ip6_output_remote_success(args):
57    packet = sc.IPv6(dst=args.dip) / sc.ICMPv6EchoRequest()
58    with socket(PF_DIVERT, SOCK_RAW, 0) as s:
59        s.bind(('0.0.0.0', args.divert_port))
60        s.sendto(bytes(packet), ('0.0.0.0', 0))
61
62
63def ipdivert_ip_input_local_success(args):
64    """Sends IPv4 packet to OS stack as inbound local packet."""
65    packet = sc.IP(dst=args.dip,src=args.sip) / sc.ICMP(type='echo-request')
66    with socket(PF_DIVERT, SOCK_RAW, 0) as s:
67        s.bind(('0.0.0.0', args.divert_port))
68        s.sendto(bytes(packet), (args.dip, 0))
69
70
71# XXX: IPv6 local divert is currently not supported
72# TODO: add IPv4 ifname output verification
73
74
75def main():
76    args = parse_args()
77    test_ptr = globals()[args.test_name]
78    test_ptr(args)
79
80
81if __name__ == '__main__':
82    main()
83