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