xref: /freebsd/tests/sys/common/divert.py (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
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# $FreeBSD$
29#
30
31
32import socket
33import scapy.all as sc
34import argparse
35
36
37IPPROTO_DIVERT = 258
38
39
40def parse_args():
41    parser = argparse.ArgumentParser(description='divert socket tester')
42    parser.add_argument('--dip', type=str, help='destination packet IP')
43    parser.add_argument('--divert_port', type=int, default=6668,
44                        help='divert port to use')
45    parser.add_argument('--test_name', type=str, required=True,
46                        help='test name to run')
47    return parser.parse_args()
48
49
50def ipdivert_ip_output_remote_success(args):
51    packet = sc.IP(dst=args.dip) / sc.ICMP(type='echo-request')
52    with socket.socket(socket.AF_INET, socket.SOCK_RAW, IPPROTO_DIVERT) as s:
53        s.bind(('0.0.0.0', args.divert_port))
54        s.sendto(bytes(packet), ('0.0.0.0', 0))
55
56
57def ipdivert_ip6_output_remote_success(args):
58    packet = sc.IPv6(dst=args.dip) / sc.ICMPv6EchoRequest()
59    with socket.socket(socket.AF_INET, socket.SOCK_RAW, IPPROTO_DIVERT) as s:
60        s.bind(('0.0.0.0', args.divert_port))
61        s.sendto(bytes(packet), ('0.0.0.0', 0))
62
63
64def ipdivert_ip_input_local_success(args):
65    """Sends IPv4 packet to OS stack as inbound local packet."""
66    packet = sc.IP(dst=args.dip) / sc.ICMP(type='echo-request')
67    with socket.socket(socket.AF_INET, socket.SOCK_RAW, IPPROTO_DIVERT) as s:
68        s.bind(('0.0.0.0', args.divert_port))
69        s.sendto(bytes(packet), (args.dip, 0))
70
71
72# XXX: IPv6 local divert is currently not supported
73# TODO: add IPv4 ifname output verification
74
75
76def main():
77    args = parse_args()
78    test_ptr = globals()[args.test_name]
79    test_ptr(args)
80
81
82if __name__ == '__main__':
83    main()
84