aboutsummaryrefslogtreecommitdiffstats
path: root/resources/traffic_scripts/send_rs_check_ra.py
blob: 9ba1f55b5242c288a48a9bb3940ee871b5782128 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
#!/usr/bin/env python
# Copyright (c) 2016 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Router solicitation check script."""

import sys
import ipaddress

from scapy.layers.l2 import Ether
from scapy.layers.inet6 import IPv6, ICMPv6ND_RS

from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
from resources.libraries.python.TrafficScriptArg import TrafficScriptArg


def mac_to_ipv6_linklocal(mac):
    """Transfer MAC address into specific link-local IPv6 address.

    :param mac: MAC address to be transferred.
    :type mac: str
    :return: IPv6 link-local address.
    :rtype: str
    """
    # Remove the most common delimiters: dots, dashes, etc.
    mac_value = int(mac.translate(None, ' .:-'), 16)

    # Split out the bytes that slot into the IPv6 address
    # XOR the most significant byte with 0x02, inverting the
    # Universal / Local bit
    high2 = mac_value >> 32 & 0xffff ^ 0x0200
    high1 = mac_value >> 24 & 0xff
    low1 = mac_value >> 16 & 0xff
    low2 = mac_value & 0xffff

    return 'fe80::{:04x}:{:02x}ff:fe{:02x}:{:04x}'.format(
        high2, high1, low1, low2)


def main():
    """Send Router Solicitation packet, check if the received response\
     is a Router Advertisement packet and verify."""

    args = TrafficScriptArg(
        ['src_mac', 'dst_mac', 'src_ip']
    )

    router_mac = args.get_arg('dst_mac')
    src_mac = args.get_arg('src_mac')
    src_ip = args.get_arg('src_ip')
    if not src_ip:
        src_ip = mac_to_ipv6_linklocal(src_mac)
    tx_if = args.get_arg('tx_if')

    txq = TxQueue(tx_if)
    rxq = RxQueue(tx_if)

    pkt_raw = (Ether(src=src_mac, dst='33:33:00:00:00:02') /
               IPv6(src=src_ip, dst='ff02::2') /
               ICMPv6ND_RS())

    sent_packets = [pkt_raw]
    txq.send(pkt_raw)

    ether = rxq.recv(8, ignore=sent_packets)

    # Check whether received packet contains layer RA and check other values
    if ether is None:
        raise RuntimeError('ICMP echo Rx timeout')

    if ether.src != router_mac:
        raise RuntimeError(
            'Packet source MAC ({0}) does not match '
            'router MAC ({1}).'.format(ether.src, router_mac))
    if ether.dst != src_mac:
        raise RuntimeError(
            'Packet destination MAC ({0}) does not match '
            'RS source MAC ({1}).'.format(ether.dst, src_mac))

    if not ether.haslayer('ICMPv6ND_RA'):
        raise RuntimeError('Not an RA packet received {0}'
                           .format(ether.__repr__()))

    src_address = ipaddress.IPv6Address(unicode(ether['IPv6'].src))
    dst_address = ipaddress.IPv6Address(unicode(ether['IPv6'].dst))
    router_link_local = ipaddress.IPv6Address(unicode(
        mac_to_ipv6_linklocal(router_mac)))
    rs_src_address = ipaddress.IPv6Address(unicode(src_ip))

    if src_address != router_link_local:
        raise RuntimeError(
            'Packet source address ({0}) does not match '
            'link local address({1})'.format(src_address, router_link_local))

    if dst_address != rs_src_address:
        raise RuntimeError(
            'Packet destination address ({0}) does not match '
            'RS source address ({1}).'.format(dst_address, rs_src_address))

    if ether['IPv6'].hlim != 255:
        raise RuntimeError('Hop limit not correct: {0}!=255'.format(
            ether['IPv6'].hlim))

    ra_code = ether['ICMPv6 Neighbor Discovery - Router Advertisement'].code
    if ra_code != 0:
        raise RuntimeError('ICMP code: {0} not correct. '.format(ra_code))

    sys.exit(0)

if __name__ == "__main__":
    main()